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