| blob | cabb1f938ebd9d116a07363e82d4c41a9ee88c16 |
1 '\" te
2 .\" Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved
3 .\" 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.
4 .\" 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.
5 .\" 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]
6 .TH HUBD 7D "Oct 4, 2016"
7 .SH NAME
8 hubd \- USB hub driver
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fBhub@unit-address\fR
13 .fi
15 .SH DESCRIPTION
16 .LP
17 The \fBhubd\fR is a USBA (illumos USB Architecture) compliant client driver
18 that supports USB hubs conforming to the \fIUniversal Serial Bus Specification
19 3.0\fR. The \fBhubd\fR driver supports bus-powered and self-powered hubs. The
20 driver supports hubs with individual port power, ganged power and no power
21 switching.
22 .sp
23 .LP
24 When a device is attached to a hub port, the \fBhubd\fR driver enumerates the
25 device by determining its type and assigning an address to it. For
26 multi-configuration devices, \fBhubd\fR sets the preferred configuration (refer
27 to \fBcfgadm_usb\fR(1M) to select a configuration). The \fBhubd\fR driver
28 attaches a driver to the device if one is available for the default or selected
29 configuration. When the device is disconnected from the hub port, the
30 \fBhubd\fR driver offlines any driver instance attached to the device.
31 .SH FILES
32 .ne 2
33 .na
34 \fB\fB/kernel/drv/hubd\fR\fR
35 .ad
36 .RS 28n
37 32- bit x86 ELF kernel module
38 .RE
40 .sp
41 .ne 2
42 .na
43 \fB\fB/kernel/drv/amd64/hubd\fR\fR
44 .ad
45 .RS 28n
46 64- bit x86 ELF kernel module
47 .RE
49 .sp
50 .ne 2
51 .na
52 \fB\fB/kernel/drv/sparcv9/hubd\fR\fR
53 .ad
54 .RS 28n
55 64-bit SPARC ELF kernel module
56 .RE
58 .SH ATTRIBUTES
59 .LP
60 See \fBattributes\fR(5) for a description of the following attributes:
61 .sp
63 .sp
64 .TS
65 box;
66 c | c
67 l | l .
68 ATTRIBUTE TYPE ATTRIBUTE VALUE
69 _
70 Architecture SPARC, x86, PCI-based systems
71 .TE
73 .SH SEE ALSO
74 .LP
75 \fBcfgadm_usb\fR(1M), \fBattributes\fR(5), \fBusba\fR(7D)
76 .sp
77 .LP
78 \fIWriting Device Drivers\fR
79 .sp
80 .LP
81 \fIUniversal Serial Bus Specification 2.0\fR
82 .sp
83 .LP
84 \fISystem Administration Guide: Basic Administration\fR
85 .sp
86 .LP
87 http://\fIwww.sun.com/io\fR
88 .SH DIAGNOSTICS
89 .LP
90 In addition to being logged, the following messages may also appear on the
91 system console. Messages are formatted in the following manner:
92 .sp
93 .in +2
94 .nf
95 WARNING: <device path> <hubd<instance number>): Message...
96 .fi
97 .in -2
98 .sp
100 .sp
101 .LP
102 where \fB<instance number>\fR is the instance number of \fBhubd\fR and
103 \fB<device path>\fR is the physical path to the device in \fB/devices\fR
104 directory. Messages from the root hub are displayed with a \fBusb<instance
105 number>\fR prefix instead of \fBhub<instance number>\fR as the root hub is an
106 integrated part of the host controller.
107 .sp
108 .ne 2
109 .na
110 \fBConnecting device on port \fI<number>\fR failed.\fR
111 .ad
112 .sp .6
113 .RS 4n
114 The driver failed to enumerate the device connected on port \fI<number>\fR of
115 hub. If enumeration fails, disconnect and re-connect.
116 .RE
118 .sp
119 .ne 2
120 .na
121 \fBUse of a USB 1.0 hub behind a high speed port may cause unexpected
122 failures.\fR
123 .ad
124 .sp .6
125 .RS 4n
126 Devices connected to a USB 1.0 hub which are in turn connected to an external
127 USB 2.0 hub, may misbehave unexpectedly or suddenly go offline. This is due to
128 a documented incompatibility between USB 1.0 hubs and USB 2.0 hub Transaction
129 Translators. Please use only USB 2.0 or USB 1.1 hubs behind high-speed ports.
130 .RE
132 .sp
133 .ne 2
134 .na
135 \fBConnecting a high speed device to a non-high speed hub (port x) will result
136 in a loss of performance. Please connect the device to a high speed port to get
137 the maximum performance.\fR
138 .ad
139 .sp .6
140 .RS 4n
141 USB 2.0 devices connected to USB 1.0 or 1.1 hubs cannot run at their highest
142 speed, even when the hub is in turn connected to a high-speed port. For best
143 performance, reconnect without going through a USB 1.0 or 1.1 hub.
144 .RE
146 .sp
147 .ne 2
148 .na
149 \fBCannot access <device>. Please reconnect.\fR
150 .ad
151 .sp .6
152 .RS 4n
153 This hub has been disconnected because a device other than the original one has
154 been inserted. The driver informs you of this fact by displaying the name of
155 the original device.
156 .RE
158 .sp
159 .ne 2
160 .na
161 \fBPort <n> overcurrent. \fR
162 .ad
163 .sp .6
164 .RS 4n
165 An overcurrent condition was detected. Please remove the device on this port.
166 .RE
168 .sp
169 .ne 2
170 .na
171 \fBDevices not identical to the previous one on this port. Please disconnect
172 and reconnect.\fR
173 .ad
174 .sp .6
175 .RS 4n
176 Same condition as described above; however in this case, the driver is unable
177 to identify the original device with a name string.
178 .RE
180 .sp
181 .ne 2
182 .na
183 \fBHub driver supports max of \fI<n>\fR ports on hub. Hence, using the first
184 \fI<number of physical ports>\fR of \fI<n>\fR ports available.\fR
185 .ad
186 .sp .6
187 .RS 4n
188 The current hub driver supports hubs that have \fI<n>\fR ports or less. A hub
189 with more than \fI<n>\fR ports has been plugged in. Only the first \fI<n>\fR
190 out of the total \fI<number of physical ports>\fR ports are usable.
191 .RE
193 .sp
194 .ne 2
195 .na
196 \fBHub global over current condition, please disconnect the devices connected
197 to the hub to clear the condition. You may need to re-connect the hub if the
198 ports do not work.\fR
199 .ad
200 .sp .6
201 .RS 4n
202 An overcurrent condition was detected on the hub. This means that the
203 aggregate current being drawn by the devices on the downstream ports exceeds a
204 preset value. Refer to section 7.2.1.2 and 11.13 of the \fIUniversal Serial Bus
205 Specification 2.0\fR. If this message continues to display, you may need to
206 remove downstream devices to eliminate the problem. If any port does not work
207 after the overcurrent condition is cleared, re-connect the hub to re-enable the
208 ports.
209 .RE
211 .sp
212 .ne 2
213 .na
214 \fBRoot hub over current condition, please check your system to clear the
215 condition as soon as possible. You may need to reboot the system if the root
216 hub does not recover automatically.\fR
217 .ad
218 .sp .6
219 .RS 4n
220 An overcurrent condition was detected on the root hub, indicating that
221 malfunctioning devices on the downstream ports are drawing too much current.
222 Please disconnect the problematic downstream devices to eliminate the problem.
223 If the root hub doesn't work after the overcurrent condition is cleared, you
224 may need to reboot the system.
225 .RE
227 .sp
228 .LP
229 The following messages may be logged into the system log. They are formatted in
230 the following manner:
231 .sp
232 .in +2
233 .nf
234 <device path><hubd<instance number>): message...
235 .fi
236 .in -2
237 .sp
239 .sp
240 .ne 2
241 .na
242 \fBLocal power has been lost, please disconnect hub.\fR
243 .ad
244 .sp .6
245 .RS 4n
246 A USB self-powered hub has lost external power. All USB devices connected
247 down-stream from this hub will cease to function. Disconnect the hub, plug in
248 the external power-supply and then plug in the hub again.
249 .RE
251 .sp
252 .ne 2
253 .na
254 \fBLocal power has been lost, the hub could draw <x> mA power from the USB
255 bus.\fR
256 .ad
257 .sp .6
258 .RS 4n
259 A USB self/bus-powered hub has lost external power. Some USB devices connected
260 down-stream from this hub may cease to function. Disconnect the
261 external power-supply and then plug in the hub again.
262 .RE
264 .sp
265 .ne 2
266 .na
267 \fBTwo bus-powered hubs cannot be concatenated.\fR
268 .ad
269 .sp .6
270 .RS 4n
271 A bus-powered hub was connected to a bus powered hub port. Please remove this
272 bus-powered hub and connect it to a self-powered hub or a root hub port.
273 .RE
275 .sp
276 .ne 2
277 .na
278 \fBConfiguration <n> for device <device> at port <m> exceeds power available
279 for this port. Please re-insert your device into another hub port which has
280 enough power.\fR
281 .ad
282 .sp .6
283 .RS 4n
284 The device requires more power than is available on this port.
285 .RE
287 .sp
288 .ne 2
289 .na
290 \fBPort <\fIn\fR\fB> in over current condition, please check the attached device
291 to clear the condition. The system will try to recover the port, but if not
292 successful, you need to re-connect the hub or reboot the system to bring the
293 port back to work.\fR
294 .ad
295 .sp .6
296 .RS 4n
297 An overcurrent condition was detected on port <\fIn\fR>. This means the device
298 connected to the port is drawing more current than the hub can supply. If this
299 message continues to display, please disconnect the device to eliminate the
300 problem. If the port doesn't work after the overcurrent condition is cleared,
301 please re-connect the hub or reboot the system to enable the port again.
302 .RE
304 .sp
305 .ne 2
306 .na
307 \fBUnable to attach USB 3.x hub <vendor> <device>. A maximum of 5 hubs
308 may be cascaded.\fR
309 .ad
310 .sp .6
311 .RS 4n
312 USB 3.0 has an upper bound on the number of hubs that may be chained
313 together. If this limit is exceeded, a hub may not be detected or
314 attached. The hub will be functional if plugged into a different part of
315 the USB topology. To determine the depth of the hub, count the number of
316 devices between it and the host controller.
317 .RE