Print this page
12309 errors in section 9e of the manual
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/man/man9e/probe.9e
+++ new/usr/src/man/man9e/probe.9e
1 1 '\" te
2 2 .\" Copyright (c) 2000, Sun Microsystems, Inc.
3 3 .\" All Rights Reserved
4 4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
5 5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
6 6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
7 -.TH PROBE 9E "Nov 18, 1992"
7 +.TH PROBE 9E "February 15, 2020"
8 8 .SH NAME
9 9 probe \- determine if a non-self-identifying device is present
10 10 .SH SYNOPSIS
11 -.LP
12 11 .nf
13 12 #include <sys/conf.h>
14 13 #include <sys/ddi.h>
15 14 #include <sys/sunddi.h>
16 15
17 16
18 17
19 -\fBstatic intprefix\fR\fBprobe\fR(\fBdev_info_t *\fR\fIdip\fR);
18 +\fBstatic int prefix\fR\fBprobe\fR(\fBdev_info_t *\fR\fIdip\fR);
20 19 .fi
21 20
22 21 .SH INTERFACE LEVEL
23 -.sp
24 -.LP
25 22 Solaris DDI specific (Solaris DDI). This entry point is required for
26 23 non-self-identifying devices. You must write it for such devices. For
27 -self-identifying devices, \fBnulldev\fR(9F) should be specified in the
24 +self-identifying devices, \fBnulldev\fR(9F) should be specified in the
28 25 \fBdev_ops\fR(9S) structure if a probe routine is not necessary.
29 26 .SH ARGUMENTS
30 -.sp
31 27 .ne 2
32 28 .na
33 29 \fB\fIdip\fR \fR
34 30 .ad
35 31 .RS 8n
36 -Pointer to the device's \fBdev_info\fR structure.
32 +Pointer to the device's \fBdev_info\fR structure.
37 33 .RE
38 34
39 35 .SH DESCRIPTION
40 -.sp
41 -.LP
42 36 \fBprobe()\fR determines whether the device corresponding to \fIdip\fR actually
43 37 exists and is a valid device for this driver. \fBprobe()\fR is called after
44 38 \fBidentify\fR(9E) and before \fBattach\fR(9E) for a given \fIdip\fR. For
45 39 example, the \fBprobe()\fR routine can map the device registers using
46 40 \fBddi_map_regs\fR(9F) then attempt to access the hardware using
47 41 \fBddi_peek\fR(9F) or \fBddi_poke\fR(9F) and determine if the device exists.
48 42 Then the device registers should be unmapped using \fBddi_unmap_regs\fR(9F).
49 43 .sp
50 44 .LP
51 45 To probe a device that was left powered off after the last \fBdetach()\fR, it
52 46 might be necessary to power it up. If so, the driver must power up the device
53 47 by accessing device registers directly. \fBpm_raise_power\fR(9F) will be not be
54 48 available until \fBattach\fR(9E). The framework ensures that the ancestors of
55 49 the node being probed and all relevant platform-specific power management
56 50 hardware is at full power at the time that \fBprobe()\fR is called.
|
↓ open down ↓ |
5 lines elided |
↑ open up ↑ |
57 51 .sp
58 52 .LP
59 53 \fBprobe()\fR should only probe the device. It should not change any software
60 54 state and should not create any software state. Device initialization should be
61 55 done in \fBattach\fR(9E).
62 56 .sp
63 57 .LP
64 58 For a self-identifying device, this entry point is not necessary. However, if a
65 59 device exists in both self-identifying and non-self-identifying forms, a
66 60 \fBprobe()\fR routine can be provided to simplify the driver.
67 -\fBddi_dev_is_sid\fR(9F) can then be used to determine whether \fBprobe()\fR
61 +\fBddi_dev_is_sid\fR(9F) can then be used to determine whether \fBprobe()\fR
68 62 needs to do any work. See \fBddi_dev_is_sid\fR(9F) for an example.
69 63 .SH RETURN VALUES
70 -.sp
71 64 .ne 2
72 65 .na
73 66 \fB\fBDDI_PROBE_SUCCESS\fR \fR
74 67 .ad
75 68 .RS 23n
76 69 If the probe was successful.
77 70 .RE
78 71
79 72 .sp
80 73 .ne 2
81 74 .na
82 75 \fB\fBDDI_PROBE_FAILURE\fR \fR
83 76 .ad
84 77 .RS 23n
85 78 If the probe failed.
86 79 .RE
87 80
88 81 .sp
89 82 .ne 2
90 83 .na
91 84 \fB\fBDDI_PROBE_DONTCARE\fR \fR
92 85 .ad
93 86 .RS 23n
94 87 If the probe was unsuccessful, yet \fBattach\fR(9E) should still be called.
95 88 .RE
96 89
|
↓ open down ↓ |
16 lines elided |
↑ open up ↑ |
97 90 .sp
98 91 .ne 2
99 92 .na
100 93 \fB\fBDDI_PROBE_PARTIAL\fR \fR
101 94 .ad
102 95 .RS 23n
103 96 If the instance is not present now, but may be present in the future.
104 97 .RE
105 98
106 99 .SH SEE ALSO
107 -.sp
108 -.LP
109 100 \fBattach\fR(9E), \fBidentify\fR(9E), \fBddi_dev_is_sid\fR(9F),
110 101 \fBddi_map_regs\fR(9F), \fBddi_peek\fR(9F), \fBddi_poke\fR(9F),
111 102 \fBnulldev\fR(9F), \fBdev_ops\fR(9S)
112 103 .sp
113 104 .LP
114 105 \fIWriting Device Drivers\fR
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX