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
28 #include <asm/processor.h>
29 #include <asm/unaligned.h>
30 #include <linux/ctype.h>
31 #include <asm/byteorder.h>
32 #include <asm/unaligned.h>
36 #include <asm/4xx_pci.h>
39 #define USB_BUFSIZ 512
41 static struct usb_hub_device hub_dev
[USB_MAX_HUB
];
42 static int usb_hub_index
;
44 __weak
void usb_hub_reset_devices(int port
)
49 static int usb_get_hub_descriptor(struct usb_device
*dev
, void *data
, int size
)
51 return usb_control_msg(dev
, usb_rcvctrlpipe(dev
, 0),
52 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
| USB_RT_HUB
,
53 USB_DT_HUB
<< 8, 0, data
, size
, USB_CNTL_TIMEOUT
);
56 static int usb_clear_port_feature(struct usb_device
*dev
, int port
, int feature
)
58 return usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
59 USB_REQ_CLEAR_FEATURE
, USB_RT_PORT
, feature
,
60 port
, NULL
, 0, USB_CNTL_TIMEOUT
);
63 static int usb_set_port_feature(struct usb_device
*dev
, int port
, int feature
)
65 return usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
66 USB_REQ_SET_FEATURE
, USB_RT_PORT
, feature
,
67 port
, NULL
, 0, USB_CNTL_TIMEOUT
);
70 static int usb_get_hub_status(struct usb_device
*dev
, void *data
)
72 return usb_control_msg(dev
, usb_rcvctrlpipe(dev
, 0),
73 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_HUB
, 0, 0,
74 data
, sizeof(struct usb_hub_status
), USB_CNTL_TIMEOUT
);
77 static int usb_get_port_status(struct usb_device
*dev
, int port
, void *data
)
79 return usb_control_msg(dev
, usb_rcvctrlpipe(dev
, 0),
80 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_PORT
, 0, port
,
81 data
, sizeof(struct usb_hub_status
), USB_CNTL_TIMEOUT
);
85 static void usb_hub_power_on(struct usb_hub_device
*hub
)
88 struct usb_device
*dev
;
89 unsigned pgood_delay
= hub
->desc
.bPwrOn2PwrGood
* 2;
94 debug("enabling power on all ports\n");
95 for (i
= 0; i
< dev
->maxchild
; i
++) {
96 usb_set_port_feature(dev
, i
+ 1, USB_PORT_FEAT_POWER
);
97 debug("port %d returns %lX\n", i
+ 1, dev
->status
);
101 * Wait for power to become stable,
102 * plus spec-defined max time for device to connect
103 * but allow this time to be increased via env variable as some
104 * devices break the spec and require longer warm-up times
106 env
= getenv("usb_pgood_delay");
108 pgood_delay
= max(pgood_delay
,
109 (unsigned)simple_strtol(env
, NULL
, 0));
110 debug("pgood_delay=%dms\n", pgood_delay
);
111 mdelay(pgood_delay
+ 1000);
114 void usb_hub_reset(void)
119 static struct usb_hub_device
*usb_hub_allocate(void)
121 if (usb_hub_index
< USB_MAX_HUB
)
122 return &hub_dev
[usb_hub_index
++];
124 printf("ERROR: USB_MAX_HUB (%d) reached\n", USB_MAX_HUB
);
130 static inline char *portspeed(int portstatus
)
134 switch (portstatus
& USB_PORT_STAT_SPEED_MASK
) {
135 case USB_PORT_STAT_SUPER_SPEED
:
136 speed_str
= "5 Gb/s";
138 case USB_PORT_STAT_HIGH_SPEED
:
139 speed_str
= "480 Mb/s";
141 case USB_PORT_STAT_LOW_SPEED
:
142 speed_str
= "1.5 Mb/s";
145 speed_str
= "12 Mb/s";
152 int legacy_hub_port_reset(struct usb_device
*dev
, int port
,
153 unsigned short *portstat
)
156 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status
, portsts
, 1);
157 unsigned short portstatus
, portchange
;
159 debug("hub_port_reset: resetting port %d...\n", port
);
160 for (tries
= 0; tries
< MAX_TRIES
; tries
++) {
162 usb_set_port_feature(dev
, port
+ 1, USB_PORT_FEAT_RESET
);
165 if (usb_get_port_status(dev
, port
+ 1, portsts
) < 0) {
166 debug("get_port_status failed status %lX\n",
170 portstatus
= le16_to_cpu(portsts
->wPortStatus
);
171 portchange
= le16_to_cpu(portsts
->wPortChange
);
173 debug("portstatus %x, change %x, %s\n", portstatus
, portchange
,
174 portspeed(portstatus
));
176 debug("STAT_C_CONNECTION = %d STAT_CONNECTION = %d" \
177 " USB_PORT_STAT_ENABLE %d\n",
178 (portchange
& USB_PORT_STAT_C_CONNECTION
) ? 1 : 0,
179 (portstatus
& USB_PORT_STAT_CONNECTION
) ? 1 : 0,
180 (portstatus
& USB_PORT_STAT_ENABLE
) ? 1 : 0);
183 * Perhaps we should check for the following here:
184 * - C_CONNECTION hasn't been set.
185 * - CONNECTION is still set.
187 * Doing so would ensure that the device is still connected
188 * to the bus, and hasn't been unplugged or replaced while the
189 * USB bus reset was going on.
191 * However, if we do that, then (at least) a San Disk Ultra
192 * USB 3.0 16GB device fails to reset on (at least) an NVIDIA
193 * Tegra Jetson TK1 board. For some reason, the device appears
194 * to briefly drop off the bus when this second bus reset is
195 * executed, yet if we retry this loop, it'll eventually come
196 * back after another reset or two.
199 if (portstatus
& USB_PORT_STAT_ENABLE
)
205 if (tries
== MAX_TRIES
) {
206 debug("Cannot enable port %i after %i retries, " \
207 "disabling port.\n", port
+ 1, MAX_TRIES
);
208 debug("Maybe the USB cable is bad?\n");
212 usb_clear_port_feature(dev
, port
+ 1, USB_PORT_FEAT_C_RESET
);
213 *portstat
= portstatus
;
218 int usb_hub_port_connect_change(struct usb_device
*dev
, int port
)
220 struct usb_device
*usb
;
221 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status
, portsts
, 1);
222 unsigned short portstatus
;
226 ret
= usb_get_port_status(dev
, port
+ 1, portsts
);
228 debug("get_port_status failed\n");
232 portstatus
= le16_to_cpu(portsts
->wPortStatus
);
233 debug("portstatus %x, change %x, %s\n",
235 le16_to_cpu(portsts
->wPortChange
),
236 portspeed(portstatus
));
238 /* Clear the connection change status */
239 usb_clear_port_feature(dev
, port
+ 1, USB_PORT_FEAT_C_CONNECTION
);
241 /* Disconnect any existing devices under this port */
242 if (((!(portstatus
& USB_PORT_STAT_CONNECTION
)) &&
243 (!(portstatus
& USB_PORT_STAT_ENABLE
))) || (dev
->children
[port
])) {
244 debug("usb_disconnect(&hub->children[port]);\n");
245 /* Return now if nothing is connected */
246 if (!(portstatus
& USB_PORT_STAT_CONNECTION
))
252 ret
= legacy_hub_port_reset(dev
, port
, &portstatus
);
254 printf("cannot reset port %i!?\n", port
+ 1);
260 switch (portstatus
& USB_PORT_STAT_SPEED_MASK
) {
261 case USB_PORT_STAT_SUPER_SPEED
:
262 speed
= USB_SPEED_SUPER
;
264 case USB_PORT_STAT_HIGH_SPEED
:
265 speed
= USB_SPEED_HIGH
;
267 case USB_PORT_STAT_LOW_SPEED
:
268 speed
= USB_SPEED_LOW
;
271 speed
= USB_SPEED_FULL
;
275 ret
= usb_alloc_new_device(dev
->controller
, &usb
);
277 printf("cannot create new device: ret=%d", ret
);
281 dev
->children
[port
] = usb
;
284 usb
->portnr
= port
+ 1;
285 /* Run it through the hoops (find a driver, etc) */
286 ret
= usb_new_device(usb
);
288 /* Woops, disable the port */
289 usb_free_device(dev
->controller
);
290 dev
->children
[port
] = NULL
;
291 debug("hub: disabling port %d\n", port
+ 1);
292 usb_clear_port_feature(dev
, port
+ 1, USB_PORT_FEAT_ENABLE
);
299 static int usb_hub_configure(struct usb_device
*dev
)
302 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, buffer
, USB_BUFSIZ
);
303 unsigned char *bitmap
;
304 short hubCharacteristics
;
305 struct usb_hub_descriptor
*descriptor
;
306 struct usb_hub_device
*hub
;
307 __maybe_unused
struct usb_hub_status
*hubsts
;
309 /* "allocate" Hub device */
310 hub
= usb_hub_allocate();
314 /* Get the the hub descriptor */
315 if (usb_get_hub_descriptor(dev
, buffer
, 4) < 0) {
316 debug("usb_hub_configure: failed to get hub " \
317 "descriptor, giving up %lX\n", dev
->status
);
320 descriptor
= (struct usb_hub_descriptor
*)buffer
;
322 length
= min_t(int, descriptor
->bLength
,
323 sizeof(struct usb_hub_descriptor
));
325 if (usb_get_hub_descriptor(dev
, buffer
, length
) < 0) {
326 debug("usb_hub_configure: failed to get hub " \
327 "descriptor 2nd giving up %lX\n", dev
->status
);
330 memcpy((unsigned char *)&hub
->desc
, buffer
, length
);
331 /* adjust 16bit values */
332 put_unaligned(le16_to_cpu(get_unaligned(
333 &descriptor
->wHubCharacteristics
)),
334 &hub
->desc
.wHubCharacteristics
);
336 bitmap
= (unsigned char *)&hub
->desc
.DeviceRemovable
[0];
337 /* devices not removable by default */
338 memset(bitmap
, 0xff, (USB_MAXCHILDREN
+1+7)/8);
339 bitmap
= (unsigned char *)&hub
->desc
.PortPowerCtrlMask
[0];
340 memset(bitmap
, 0xff, (USB_MAXCHILDREN
+1+7)/8); /* PowerMask = 1B */
342 for (i
= 0; i
< ((hub
->desc
.bNbrPorts
+ 1 + 7)/8); i
++)
343 hub
->desc
.DeviceRemovable
[i
] = descriptor
->DeviceRemovable
[i
];
345 for (i
= 0; i
< ((hub
->desc
.bNbrPorts
+ 1 + 7)/8); i
++)
346 hub
->desc
.PortPowerCtrlMask
[i
] = descriptor
->PortPowerCtrlMask
[i
];
348 dev
->maxchild
= descriptor
->bNbrPorts
;
349 debug("%d ports detected\n", dev
->maxchild
);
351 hubCharacteristics
= get_unaligned(&hub
->desc
.wHubCharacteristics
);
352 switch (hubCharacteristics
& HUB_CHAR_LPSM
) {
354 debug("ganged power switching\n");
357 debug("individual port power switching\n");
361 debug("unknown reserved power switching mode\n");
365 if (hubCharacteristics
& HUB_CHAR_COMPOUND
)
366 debug("part of a compound device\n");
368 debug("standalone hub\n");
370 switch (hubCharacteristics
& HUB_CHAR_OCPM
) {
372 debug("global over-current protection\n");
375 debug("individual port over-current protection\n");
379 debug("no over-current protection\n");
383 debug("power on to power good time: %dms\n",
384 descriptor
->bPwrOn2PwrGood
* 2);
385 debug("hub controller current requirement: %dmA\n",
386 descriptor
->bHubContrCurrent
);
388 for (i
= 0; i
< dev
->maxchild
; i
++)
389 debug("port %d is%s removable\n", i
+ 1,
390 hub
->desc
.DeviceRemovable
[(i
+ 1) / 8] & \
391 (1 << ((i
+ 1) % 8)) ? " not" : "");
393 if (sizeof(struct usb_hub_status
) > USB_BUFSIZ
) {
394 debug("usb_hub_configure: failed to get Status - " \
395 "too long: %d\n", descriptor
->bLength
);
399 if (usb_get_hub_status(dev
, buffer
) < 0) {
400 debug("usb_hub_configure: failed to get Status %lX\n",
406 hubsts
= (struct usb_hub_status
*)buffer
;
409 debug("get_hub_status returned status %X, change %X\n",
410 le16_to_cpu(hubsts
->wHubStatus
),
411 le16_to_cpu(hubsts
->wHubChange
));
412 debug("local power source is %s\n",
413 (le16_to_cpu(hubsts
->wHubStatus
) & HUB_STATUS_LOCAL_POWER
) ? \
414 "lost (inactive)" : "good");
415 debug("%sover-current condition exists\n",
416 (le16_to_cpu(hubsts
->wHubStatus
) & HUB_STATUS_OVERCURRENT
) ? \
418 usb_hub_power_on(hub
);
421 * Reset any devices that may be in a bad state when applying
422 * the power. This is a __weak function. Resetting of the devices
423 * should occur in the board file of the device.
425 for (i
= 0; i
< dev
->maxchild
; i
++)
426 usb_hub_reset_devices(i
+ 1);
428 for (i
= 0; i
< dev
->maxchild
; i
++) {
429 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status
, portsts
, 1);
430 unsigned short portstatus
, portchange
;
432 ulong start
= get_timer(0);
435 * Wait for (whichever finishes first)
436 * - A maximum of 10 seconds
437 * This is a purely observational value driven by connecting
438 * a few broken pen drives and taking the max * 1.5 approach
439 * - connection_change and connection state to report same
443 ret
= usb_get_port_status(dev
, i
+ 1, portsts
);
445 debug("get_port_status failed\n");
449 portstatus
= le16_to_cpu(portsts
->wPortStatus
);
450 portchange
= le16_to_cpu(portsts
->wPortChange
);
452 if ((portchange
& USB_PORT_STAT_C_CONNECTION
) ==
453 (portstatus
& USB_PORT_STAT_CONNECTION
))
456 } while (get_timer(start
) < CONFIG_SYS_HZ
* 10);
461 debug("Port %d Status %X Change %X\n",
462 i
+ 1, portstatus
, portchange
);
464 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
465 debug("port %d connection change\n", i
+ 1);
466 usb_hub_port_connect_change(dev
, i
);
468 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
469 debug("port %d enable change, status %x\n",
471 usb_clear_port_feature(dev
, i
+ 1,
472 USB_PORT_FEAT_C_ENABLE
);
474 * The following hack causes a ghost device problem
477 #ifndef CONFIG_USB_EHCI_FARADAY
478 /* EM interference sometimes causes bad shielded USB
479 * devices to be shutdown by the hub, this hack enables
480 * them again. Works at least with mouse driver */
481 if (!(portstatus
& USB_PORT_STAT_ENABLE
) &&
482 (portstatus
& USB_PORT_STAT_CONNECTION
) &&
483 ((dev
->children
[i
]))) {
484 debug("already running port %i " \
485 "disabled by hub (EMI?), " \
486 "re-enabling...\n", i
+ 1);
487 usb_hub_port_connect_change(dev
, i
);
491 if (portstatus
& USB_PORT_STAT_SUSPEND
) {
492 debug("port %d suspend change\n", i
+ 1);
493 usb_clear_port_feature(dev
, i
+ 1,
494 USB_PORT_FEAT_SUSPEND
);
497 if (portchange
& USB_PORT_STAT_C_OVERCURRENT
) {
498 debug("port %d over-current change\n", i
+ 1);
499 usb_clear_port_feature(dev
, i
+ 1,
500 USB_PORT_FEAT_C_OVER_CURRENT
);
501 usb_hub_power_on(hub
);
504 if (portchange
& USB_PORT_STAT_C_RESET
) {
505 debug("port %d reset change\n", i
+ 1);
506 usb_clear_port_feature(dev
, i
+ 1,
507 USB_PORT_FEAT_C_RESET
);
509 } /* end for i all ports */
514 int usb_hub_probe(struct usb_device
*dev
, int ifnum
)
516 struct usb_interface
*iface
;
517 struct usb_endpoint_descriptor
*ep
;
520 iface
= &dev
->config
.if_desc
[ifnum
];
522 if (iface
->desc
.bInterfaceClass
!= USB_CLASS_HUB
)
524 /* Some hubs have a subclass of 1, which AFAICT according to the */
525 /* specs is not defined, but it works */
526 if ((iface
->desc
.bInterfaceSubClass
!= 0) &&
527 (iface
->desc
.bInterfaceSubClass
!= 1))
529 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
530 if (iface
->desc
.bNumEndpoints
!= 1)
532 ep
= &iface
->ep_desc
[0];
533 /* Output endpoint? Curiousier and curiousier.. */
534 if (!(ep
->bEndpointAddress
& USB_DIR_IN
))
536 /* If it's not an interrupt endpoint, we'd better punt! */
537 if ((ep
->bmAttributes
& 3) != 3)
540 debug("USB hub found\n");
541 ret
= usb_hub_configure(dev
);