2 * Most of this source has been derived from the Linux USB
4 * (C) Copyright Linus Torvalds 1999
5 * (C) Copyright Johannes Erdfelt 1999-2001
6 * (C) Copyright Andreas Gal 1999
7 * (C) Copyright Gregory P. Smith 1999
8 * (C) Copyright Deti Fliegl 1999 (new USB architecture)
9 * (C) Copyright Randy Dunlap 2000
10 * (C) Copyright David Brownell 2000 (kernel hotplug, usb_device_id)
11 * (C) Copyright Yggdrasil Computing, Inc. 2000
12 * (usb_device_id matching changes by Adam J. Richter)
15 * (C) Copyright 2001 Denis Peter, MPL AG Switzerland
17 * SPDX-License-Identifier: GPL-2.0+
20 /****************************************************************************
22 * Probes device for being a hub and configurate it
27 #include <asm/processor.h>
28 #include <asm/unaligned.h>
29 #include <linux/ctype.h>
30 #include <asm/byteorder.h>
31 #include <asm/unaligned.h>
35 #include <asm/4xx_pci.h>
38 #define USB_BUFSIZ 512
40 static struct usb_hub_device hub_dev
[USB_MAX_HUB
];
41 static int usb_hub_index
;
43 __weak
void usb_hub_reset_devices(int port
)
48 static int usb_get_hub_descriptor(struct usb_device
*dev
, void *data
, int size
)
50 return usb_control_msg(dev
, usb_rcvctrlpipe(dev
, 0),
51 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
| USB_RT_HUB
,
52 USB_DT_HUB
<< 8, 0, data
, size
, USB_CNTL_TIMEOUT
);
55 static int usb_clear_port_feature(struct usb_device
*dev
, int port
, int feature
)
57 return usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
58 USB_REQ_CLEAR_FEATURE
, USB_RT_PORT
, feature
,
59 port
, NULL
, 0, USB_CNTL_TIMEOUT
);
62 static int usb_set_port_feature(struct usb_device
*dev
, int port
, int feature
)
64 return usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
65 USB_REQ_SET_FEATURE
, USB_RT_PORT
, feature
,
66 port
, NULL
, 0, USB_CNTL_TIMEOUT
);
69 static int usb_get_hub_status(struct usb_device
*dev
, void *data
)
71 return usb_control_msg(dev
, usb_rcvctrlpipe(dev
, 0),
72 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_HUB
, 0, 0,
73 data
, sizeof(struct usb_hub_status
), USB_CNTL_TIMEOUT
);
76 static int usb_get_port_status(struct usb_device
*dev
, int port
, void *data
)
78 return usb_control_msg(dev
, usb_rcvctrlpipe(dev
, 0),
79 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_PORT
, 0, port
,
80 data
, sizeof(struct usb_hub_status
), USB_CNTL_TIMEOUT
);
84 static void usb_hub_power_on(struct usb_hub_device
*hub
)
87 struct usb_device
*dev
;
88 unsigned pgood_delay
= hub
->desc
.bPwrOn2PwrGood
* 2;
92 debug("enabling power on all ports\n");
93 for (i
= 0; i
< dev
->maxchild
; i
++) {
94 usb_set_port_feature(dev
, i
+ 1, USB_PORT_FEAT_POWER
);
95 debug("port %d returns %lX\n", i
+ 1, dev
->status
);
99 * Wait for power to become stable,
100 * plus spec-defined max time for device to connect
102 mdelay(pgood_delay
+ 1000);
105 void usb_hub_reset(void)
110 static struct usb_hub_device
*usb_hub_allocate(void)
112 if (usb_hub_index
< USB_MAX_HUB
)
113 return &hub_dev
[usb_hub_index
++];
115 printf("ERROR: USB_MAX_HUB (%d) reached\n", USB_MAX_HUB
);
121 static inline char *portspeed(int portstatus
)
125 switch (portstatus
& USB_PORT_STAT_SPEED_MASK
) {
126 case USB_PORT_STAT_SUPER_SPEED
:
127 speed_str
= "5 Gb/s";
129 case USB_PORT_STAT_HIGH_SPEED
:
130 speed_str
= "480 Mb/s";
132 case USB_PORT_STAT_LOW_SPEED
:
133 speed_str
= "1.5 Mb/s";
136 speed_str
= "12 Mb/s";
143 int hub_port_reset(struct usb_device
*dev
, int port
,
144 unsigned short *portstat
)
147 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status
, portsts
, 1);
148 unsigned short portstatus
, portchange
;
150 debug("hub_port_reset: resetting port %d...\n", port
);
151 for (tries
= 0; tries
< MAX_TRIES
; tries
++) {
153 usb_set_port_feature(dev
, port
+ 1, USB_PORT_FEAT_RESET
);
156 if (usb_get_port_status(dev
, port
+ 1, portsts
) < 0) {
157 debug("get_port_status failed status %lX\n",
161 portstatus
= le16_to_cpu(portsts
->wPortStatus
);
162 portchange
= le16_to_cpu(portsts
->wPortChange
);
164 debug("portstatus %x, change %x, %s\n", portstatus
, portchange
,
165 portspeed(portstatus
));
167 debug("STAT_C_CONNECTION = %d STAT_CONNECTION = %d" \
168 " USB_PORT_STAT_ENABLE %d\n",
169 (portchange
& USB_PORT_STAT_C_CONNECTION
) ? 1 : 0,
170 (portstatus
& USB_PORT_STAT_CONNECTION
) ? 1 : 0,
171 (portstatus
& USB_PORT_STAT_ENABLE
) ? 1 : 0);
174 * Perhaps we should check for the following here:
175 * - C_CONNECTION hasn't been set.
176 * - CONNECTION is still set.
178 * Doing so would ensure that the device is still connected
179 * to the bus, and hasn't been unplugged or replaced while the
180 * USB bus reset was going on.
182 * However, if we do that, then (at least) a San Disk Ultra
183 * USB 3.0 16GB device fails to reset on (at least) an NVIDIA
184 * Tegra Jetson TK1 board. For some reason, the device appears
185 * to briefly drop off the bus when this second bus reset is
186 * executed, yet if we retry this loop, it'll eventually come
187 * back after another reset or two.
190 if (portstatus
& USB_PORT_STAT_ENABLE
)
196 if (tries
== MAX_TRIES
) {
197 debug("Cannot enable port %i after %i retries, " \
198 "disabling port.\n", port
+ 1, MAX_TRIES
);
199 debug("Maybe the USB cable is bad?\n");
203 usb_clear_port_feature(dev
, port
+ 1, USB_PORT_FEAT_C_RESET
);
204 *portstat
= portstatus
;
209 void usb_hub_port_connect_change(struct usb_device
*dev
, int port
)
211 struct usb_device
*usb
;
212 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status
, portsts
, 1);
213 unsigned short portstatus
;
216 if (usb_get_port_status(dev
, port
+ 1, portsts
) < 0) {
217 debug("get_port_status failed\n");
221 portstatus
= le16_to_cpu(portsts
->wPortStatus
);
222 debug("portstatus %x, change %x, %s\n",
224 le16_to_cpu(portsts
->wPortChange
),
225 portspeed(portstatus
));
227 /* Clear the connection change status */
228 usb_clear_port_feature(dev
, port
+ 1, USB_PORT_FEAT_C_CONNECTION
);
230 /* Disconnect any existing devices under this port */
231 if (((!(portstatus
& USB_PORT_STAT_CONNECTION
)) &&
232 (!(portstatus
& USB_PORT_STAT_ENABLE
))) || (dev
->children
[port
])) {
233 debug("usb_disconnect(&hub->children[port]);\n");
234 /* Return now if nothing is connected */
235 if (!(portstatus
& USB_PORT_STAT_CONNECTION
))
241 if (hub_port_reset(dev
, port
, &portstatus
) < 0) {
242 printf("cannot reset port %i!?\n", port
+ 1);
248 /* Allocate a new device struct for it */
249 usb
= usb_alloc_new_device(dev
->controller
);
251 switch (portstatus
& USB_PORT_STAT_SPEED_MASK
) {
252 case USB_PORT_STAT_SUPER_SPEED
:
253 usb
->speed
= USB_SPEED_SUPER
;
255 case USB_PORT_STAT_HIGH_SPEED
:
256 usb
->speed
= USB_SPEED_HIGH
;
258 case USB_PORT_STAT_LOW_SPEED
:
259 usb
->speed
= USB_SPEED_LOW
;
262 usb
->speed
= USB_SPEED_FULL
;
266 dev
->children
[port
] = usb
;
268 usb
->portnr
= port
+ 1;
269 /* Run it through the hoops (find a driver, etc) */
270 if (usb_new_device(usb
)) {
271 /* Woops, disable the port */
273 dev
->children
[port
] = NULL
;
274 debug("hub: disabling port %d\n", port
+ 1);
275 usb_clear_port_feature(dev
, port
+ 1, USB_PORT_FEAT_ENABLE
);
280 static int usb_hub_configure(struct usb_device
*dev
)
283 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, buffer
, USB_BUFSIZ
);
284 unsigned char *bitmap
;
285 short hubCharacteristics
;
286 struct usb_hub_descriptor
*descriptor
;
287 struct usb_hub_device
*hub
;
288 __maybe_unused
struct usb_hub_status
*hubsts
;
290 /* "allocate" Hub device */
291 hub
= usb_hub_allocate();
295 /* Get the the hub descriptor */
296 if (usb_get_hub_descriptor(dev
, buffer
, 4) < 0) {
297 debug("usb_hub_configure: failed to get hub " \
298 "descriptor, giving up %lX\n", dev
->status
);
301 descriptor
= (struct usb_hub_descriptor
*)buffer
;
303 length
= min(descriptor
->bLength
, sizeof(struct usb_hub_descriptor
));
305 if (usb_get_hub_descriptor(dev
, buffer
, length
) < 0) {
306 debug("usb_hub_configure: failed to get hub " \
307 "descriptor 2nd giving up %lX\n", dev
->status
);
310 memcpy((unsigned char *)&hub
->desc
, buffer
, length
);
311 /* adjust 16bit values */
312 put_unaligned(le16_to_cpu(get_unaligned(
313 &descriptor
->wHubCharacteristics
)),
314 &hub
->desc
.wHubCharacteristics
);
316 bitmap
= (unsigned char *)&hub
->desc
.DeviceRemovable
[0];
317 /* devices not removable by default */
318 memset(bitmap
, 0xff, (USB_MAXCHILDREN
+1+7)/8);
319 bitmap
= (unsigned char *)&hub
->desc
.PortPowerCtrlMask
[0];
320 memset(bitmap
, 0xff, (USB_MAXCHILDREN
+1+7)/8); /* PowerMask = 1B */
322 for (i
= 0; i
< ((hub
->desc
.bNbrPorts
+ 1 + 7)/8); i
++)
323 hub
->desc
.DeviceRemovable
[i
] = descriptor
->DeviceRemovable
[i
];
325 for (i
= 0; i
< ((hub
->desc
.bNbrPorts
+ 1 + 7)/8); i
++)
326 hub
->desc
.PortPowerCtrlMask
[i
] = descriptor
->PortPowerCtrlMask
[i
];
328 dev
->maxchild
= descriptor
->bNbrPorts
;
329 debug("%d ports detected\n", dev
->maxchild
);
331 hubCharacteristics
= get_unaligned(&hub
->desc
.wHubCharacteristics
);
332 switch (hubCharacteristics
& HUB_CHAR_LPSM
) {
334 debug("ganged power switching\n");
337 debug("individual port power switching\n");
341 debug("unknown reserved power switching mode\n");
345 if (hubCharacteristics
& HUB_CHAR_COMPOUND
)
346 debug("part of a compound device\n");
348 debug("standalone hub\n");
350 switch (hubCharacteristics
& HUB_CHAR_OCPM
) {
352 debug("global over-current protection\n");
355 debug("individual port over-current protection\n");
359 debug("no over-current protection\n");
363 debug("power on to power good time: %dms\n",
364 descriptor
->bPwrOn2PwrGood
* 2);
365 debug("hub controller current requirement: %dmA\n",
366 descriptor
->bHubContrCurrent
);
368 for (i
= 0; i
< dev
->maxchild
; i
++)
369 debug("port %d is%s removable\n", i
+ 1,
370 hub
->desc
.DeviceRemovable
[(i
+ 1) / 8] & \
371 (1 << ((i
+ 1) % 8)) ? " not" : "");
373 if (sizeof(struct usb_hub_status
) > USB_BUFSIZ
) {
374 debug("usb_hub_configure: failed to get Status - " \
375 "too long: %d\n", descriptor
->bLength
);
379 if (usb_get_hub_status(dev
, buffer
) < 0) {
380 debug("usb_hub_configure: failed to get Status %lX\n",
386 hubsts
= (struct usb_hub_status
*)buffer
;
389 debug("get_hub_status returned status %X, change %X\n",
390 le16_to_cpu(hubsts
->wHubStatus
),
391 le16_to_cpu(hubsts
->wHubChange
));
392 debug("local power source is %s\n",
393 (le16_to_cpu(hubsts
->wHubStatus
) & HUB_STATUS_LOCAL_POWER
) ? \
394 "lost (inactive)" : "good");
395 debug("%sover-current condition exists\n",
396 (le16_to_cpu(hubsts
->wHubStatus
) & HUB_STATUS_OVERCURRENT
) ? \
398 usb_hub_power_on(hub
);
401 * Reset any devices that may be in a bad state when applying
402 * the power. This is a __weak function. Resetting of the devices
403 * should occur in the board file of the device.
405 for (i
= 0; i
< dev
->maxchild
; i
++)
406 usb_hub_reset_devices(i
+ 1);
408 for (i
= 0; i
< dev
->maxchild
; i
++) {
409 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status
, portsts
, 1);
410 unsigned short portstatus
, portchange
;
412 ulong start
= get_timer(0);
415 * Wait for (whichever finishes first)
416 * - A maximum of 10 seconds
417 * This is a purely observational value driven by connecting
418 * a few broken pen drives and taking the max * 1.5 approach
419 * - connection_change and connection state to report same
423 ret
= usb_get_port_status(dev
, i
+ 1, portsts
);
425 debug("get_port_status failed\n");
429 portstatus
= le16_to_cpu(portsts
->wPortStatus
);
430 portchange
= le16_to_cpu(portsts
->wPortChange
);
432 if ((portchange
& USB_PORT_STAT_C_CONNECTION
) ==
433 (portstatus
& USB_PORT_STAT_CONNECTION
))
436 } while (get_timer(start
) < CONFIG_SYS_HZ
* 10);
441 debug("Port %d Status %X Change %X\n",
442 i
+ 1, portstatus
, portchange
);
444 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
445 debug("port %d connection change\n", i
+ 1);
446 usb_hub_port_connect_change(dev
, i
);
448 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
449 debug("port %d enable change, status %x\n",
451 usb_clear_port_feature(dev
, i
+ 1,
452 USB_PORT_FEAT_C_ENABLE
);
454 * The following hack causes a ghost device problem
457 #ifndef CONFIG_USB_EHCI_FARADAY
458 /* EM interference sometimes causes bad shielded USB
459 * devices to be shutdown by the hub, this hack enables
460 * them again. Works at least with mouse driver */
461 if (!(portstatus
& USB_PORT_STAT_ENABLE
) &&
462 (portstatus
& USB_PORT_STAT_CONNECTION
) &&
463 ((dev
->children
[i
]))) {
464 debug("already running port %i " \
465 "disabled by hub (EMI?), " \
466 "re-enabling...\n", i
+ 1);
467 usb_hub_port_connect_change(dev
, i
);
471 if (portstatus
& USB_PORT_STAT_SUSPEND
) {
472 debug("port %d suspend change\n", i
+ 1);
473 usb_clear_port_feature(dev
, i
+ 1,
474 USB_PORT_FEAT_SUSPEND
);
477 if (portchange
& USB_PORT_STAT_C_OVERCURRENT
) {
478 debug("port %d over-current change\n", i
+ 1);
479 usb_clear_port_feature(dev
, i
+ 1,
480 USB_PORT_FEAT_C_OVER_CURRENT
);
481 usb_hub_power_on(hub
);
484 if (portchange
& USB_PORT_STAT_C_RESET
) {
485 debug("port %d reset change\n", i
+ 1);
486 usb_clear_port_feature(dev
, i
+ 1,
487 USB_PORT_FEAT_C_RESET
);
489 } /* end for i all ports */
494 int usb_hub_probe(struct usb_device
*dev
, int ifnum
)
496 struct usb_interface
*iface
;
497 struct usb_endpoint_descriptor
*ep
;
500 iface
= &dev
->config
.if_desc
[ifnum
];
502 if (iface
->desc
.bInterfaceClass
!= USB_CLASS_HUB
)
504 /* Some hubs have a subclass of 1, which AFAICT according to the */
505 /* specs is not defined, but it works */
506 if ((iface
->desc
.bInterfaceSubClass
!= 0) &&
507 (iface
->desc
.bInterfaceSubClass
!= 1))
509 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
510 if (iface
->desc
.bNumEndpoints
!= 1)
512 ep
= &iface
->ep_desc
[0];
513 /* Output endpoint? Curiousier and curiousier.. */
514 if (!(ep
->bEndpointAddress
& USB_DIR_IN
))
516 /* If it's not an interrupt endpoint, we'd better punt! */
517 if ((ep
->bmAttributes
& 3) != 3)
520 debug("USB hub found\n");
521 ret
= usb_hub_configure(dev
);