Print this page
10229 Some man pages have incorrect cross-references
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/man/man9f/usba_hubdi_bind_root_hub.9f
+++ new/usr/src/man/man9f/usba_hubdi_bind_root_hub.9f
1 1 .\"
2 2 .\" This file and its contents are supplied under the terms of the
3 3 .\" Common Development and Distribution License ("CDDL"), version 1.0.
4 4 .\" You may only use this file in accordance with the terms of version
5 5 .\" 1.0 of the CDDL.
6 6 .\"
7 7 .\" A full copy of the text of the CDDL should have accompanied this
8 8 .\" source. A copy of the CDDL is also available via the Internet at
9 9 .\" http://www.illumos.org/license/CDDL.
10 10 .\"
11 11 .\"
12 12 .\" Copyright 2016 Joyent, Inc.
13 13 .\"
14 14 .Dd Sep 16, 2016
15 15 .Dt USBA_HCDI_BIND_ROOT_HUB 9F
16 16 .Os
17 17 .Sh NAME
18 18 .Nm usba_hubdi_bind_root_hub ,
19 19 .Nm usba_hubdi_unbind_root_hub
20 20 .Nd bind and unbind the root USB hub
21 21 .Sh SYNOPSIS
22 22 .In sys/usb/usba/hubdi.h
23 23 .Ft int
24 24 .Fo usba_hubdi_bind_root_hub
25 25 .Fa "dev_info_t *dip"
26 26 .Fa "uchar_t *hub_descr"
27 27 .Fa "size_t descr_len"
28 28 .Fa "usb_dev_descr_t *dev_descr"
29 29 .Fc
30 30 .Ft int
31 31 .Fo usba_hubdi_unbind_root_hub
32 32 .Fa "dev_info_t *dip"
33 33 .Fc
34 34 .Sh INTERFACE LEVEL
35 35 .Sy Volatile -
36 36 illumos USB HCD private function
37 37 .Pp
38 38 This is a private function that is not part of the stable DDI.
39 39 It may be removed or changed at any time.
40 40 .Sh PARAMETERS
41 41 .Bl -tag -width Fa
42 42 .It Fa dip
43 43 Pointer to the device's
44 44 .Sy dev_info
45 45 structure.
46 46 .It Fa hub_descr
47 47 Pointer to a byte array that contains the standard descriptors for a USB
48 48 Hub device.
49 49 .It Fa descr_len
50 50 The length in bytes of the
51 51 .Fa hub_descr
52 52 byte array.
53 53 .It Fa dev_descr
54 54 A filled in standard USB device descriptor.
55 55 .El
56 56 .Sh DESCRIPTION
57 57 The
58 58 .Fn usba_hubdi_bind_root_hub
59 59 and
60 60 .Fn usba_hubdi_unbind_root_hub
61 61 functions are used to bind and unbind the root USB hub that is a part of
62 62 every HCD driver.
63 63 See
64 64 .Xr usba_hcdi 9E
65 65 for more information on this relationship.
66 66 .Pp
67 67 The
68 68 .Fn usba_hubdi_root_bind_driver
69 69 is used after calling the
70 70 .Xr usba_hcdi_register 9F
71 71 function during a device's
72 72 .Xr attach 9E
73 73 entry point.
74 74 .Pp
75 75 Because the root hub is generally a virtual hub, the HCD driver is
76 76 responsible for making it appear to the system as a normal USB hub.
77 77 .Pp
78 78 The contents of the
79 79 .Fa hub_descr
80 80 should be the standard USB Hub class-specific descriptor.
81 81 This hub descriptor should match a hub of a similar class of speed.
82 82 For example, with the xhci controller, a USB 3.x Hub class-specific descriptor
83 83 is used, where as for the ehci controller, a USB 2.x Hub class-specific
84 84 descriptor is used.
85 85 For more information, see the USB 3.1 specification, section 10.15.2
86 86 .Em Class-specific Descriptors .
87 87 .Pp
88 88 Similarly, the contents of the
89 89 .Fa dev_descr
90 90 need to be a filled in USB device descriptor that indicates that the
91 91 root hub corresponds to the appropriate USB generation.
92 92 For more information on the contents, see
93 93 .Xr usb_dev_descr 9S
94 94 and the USB 3.1 specification, section 10.15.1
95 95 .Em Standard Descriptors for Hub Class .
96 96 .Pp
97 97 The
98 98 .Fn usba_hubdi_unbind_root_hub
99 99 function is used to detach the root hub associated with the HCD driver.
100 100 This should be called during a device's
101 101 .Xr detach 9E
102 102 routine before calling
103 103 .Xr usba_hcdi_unregister 9F .
104 104 .Pp
105 105 If a call to the
106 106 .Fn usba_hubdi_unbind_root_hub
107 107 function fails during a device's
108 108 .Xr detach 9E
109 109 function, then it should fail the call to
110 110 .Xr detach 9E .
111 111 .Sh CONTEXT
112 112 The
113 113 .Fn usba_hubdi_bind_root_hub
114 114 function should only be called during a device's
115 115 .Xr attach 9E
116 116 entry point.
117 117 .Pp
118 118 The
119 119 .Fn usba_hubdi_unbind_root_hub
120 120 function should only be called during a device's
121 121 .Xr detach 9E entry point.
122 122 .Sh RETURN VALUES
123 123 Upon successful completion, the
124 124 .Fn usba_hubdi_bind_root_hub
125 125 and
126 126 .Fn usba_hubdi_unbind_root_hub
127 127 functions return
|
↓ open down ↓ |
127 lines elided |
↑ open up ↑ |
128 128 .Sy USB_SUCCESS .
129 129 Otherwise, they return
130 130 .Sy USB_FAILURE
131 131 to indicate that they could not proceed.
132 132 .Sh SEE ALSO
133 133 .Xr attach 9E ,
134 134 .Xr detach 9E ,
135 135 .Xr usba_hcdi 9E ,
136 136 .Xr usba_hcdi_register 9F ,
137 137 .Xr usba_hcdi_unregister 9F ,
138 -.Xr usb_dev_Descr 9S
138 +.Xr usb_dev_descr 9S
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX