1 // SPDX-License-Identifier: GPL-2.0+
3 * Most of this source has been derived from the Linux USB
5 * (C) Copyright Linus Torvalds 1999
6 * (C) Copyright Johannes Erdfelt 1999-2001
7 * (C) Copyright Andreas Gal 1999
8 * (C) Copyright Gregory P. Smith 1999
9 * (C) Copyright Deti Fliegl 1999 (new USB architecture)
10 * (C) Copyright Randy Dunlap 2000
11 * (C) Copyright David Brownell 2000 (kernel hotplug, usb_device_id)
12 * (C) Copyright Yggdrasil Computing, Inc. 2000
13 * (usb_device_id matching changes by Adam J. Richter)
16 * (C) Copyright 2001 Denis Peter, MPL AG Switzerland
19 /****************************************************************************
21 * Probes device for being a hub and configurate it
29 #include <asm/processor.h>
30 #include <asm/unaligned.h>
31 #include <linux/ctype.h>
32 #include <linux/list.h>
33 #include <asm/byteorder.h>
35 #include <asm/state.h>
37 #include <asm/unaligned.h>
41 #define USB_BUFSIZ 512
43 #define HUB_SHORT_RESET_TIME 20
44 #define HUB_LONG_RESET_TIME 200
46 #define PORT_OVERCURRENT_MAX_SCAN_COUNT 3
48 struct usb_device_scan
{
49 struct usb_device
*dev
; /* USB hub device to scan */
50 struct usb_hub_device
*hub
; /* USB hub struct */
51 int port
; /* USB port to scan */
52 struct list_head list
;
55 static LIST_HEAD(usb_scan_list
);
57 __weak
void usb_hub_reset_devices(struct usb_hub_device
*hub
, int port
)
62 static inline bool usb_hub_is_superspeed(struct usb_device
*hdev
)
64 return hdev
->descriptor
.bDeviceProtocol
== 3;
67 #if CONFIG_IS_ENABLED(DM_USB)
68 bool usb_hub_is_root_hub(struct udevice
*hub
)
70 if (device_get_uclass_id(hub
->parent
) != UCLASS_USB_HUB
)
76 static int usb_set_hub_depth(struct usb_device
*dev
, int depth
)
78 if (depth
< 0 || depth
> 4)
81 return usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
82 USB_REQ_SET_HUB_DEPTH
, USB_DIR_OUT
| USB_RT_HUB
,
83 depth
, 0, NULL
, 0, USB_CNTL_TIMEOUT
);
87 static int usb_get_hub_descriptor(struct usb_device
*dev
, void *data
, int size
)
89 unsigned short dtype
= USB_DT_HUB
;
91 if (usb_hub_is_superspeed(dev
))
92 dtype
= USB_DT_SS_HUB
;
94 return usb_control_msg(dev
, usb_rcvctrlpipe(dev
, 0),
95 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
| USB_RT_HUB
,
96 dtype
<< 8, 0, data
, size
, USB_CNTL_TIMEOUT
);
99 static int usb_clear_port_feature(struct usb_device
*dev
, int port
, int feature
)
101 return usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
102 USB_REQ_CLEAR_FEATURE
, USB_RT_PORT
, feature
,
103 port
, NULL
, 0, USB_CNTL_TIMEOUT
);
106 static int usb_set_port_feature(struct usb_device
*dev
, int port
, int feature
)
108 return usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
109 USB_REQ_SET_FEATURE
, USB_RT_PORT
, feature
,
110 port
, NULL
, 0, USB_CNTL_TIMEOUT
);
113 static int usb_get_hub_status(struct usb_device
*dev
, void *data
)
115 return usb_control_msg(dev
, usb_rcvctrlpipe(dev
, 0),
116 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_HUB
, 0, 0,
117 data
, sizeof(struct usb_hub_status
), USB_CNTL_TIMEOUT
);
120 int usb_get_port_status(struct usb_device
*dev
, int port
, void *data
)
124 ret
= usb_control_msg(dev
, usb_rcvctrlpipe(dev
, 0),
125 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_PORT
, 0, port
,
126 data
, sizeof(struct usb_port_status
), USB_CNTL_TIMEOUT
);
128 #if CONFIG_IS_ENABLED(DM_USB)
133 * Translate the USB 3.0 hub port status field into the old version
134 * that U-Boot understands. Do this only when the hub is not root hub.
135 * For root hub, the port status field has already been translated
136 * in the host controller driver (see xhci_submit_root() in xhci.c).
138 * Note: this only supports driver model.
141 if (!usb_hub_is_root_hub(dev
->dev
) && usb_hub_is_superspeed(dev
)) {
142 struct usb_port_status
*status
= (struct usb_port_status
*)data
;
143 u16 tmp
= (status
->wPortStatus
) & USB_SS_PORT_STAT_MASK
;
145 if (status
->wPortStatus
& USB_SS_PORT_STAT_POWER
)
146 tmp
|= USB_PORT_STAT_POWER
;
147 if ((status
->wPortStatus
& USB_SS_PORT_STAT_SPEED
) ==
148 USB_SS_PORT_STAT_SPEED_5GBPS
)
149 tmp
|= USB_PORT_STAT_SUPER_SPEED
;
151 status
->wPortStatus
= tmp
;
159 static void usb_hub_power_on(struct usb_hub_device
*hub
)
162 struct usb_device
*dev
;
163 unsigned pgood_delay
= hub
->desc
.bPwrOn2PwrGood
* 2;
168 debug("enabling power on all ports\n");
169 for (i
= 0; i
< dev
->maxchild
; i
++) {
170 usb_set_port_feature(dev
, i
+ 1, USB_PORT_FEAT_POWER
);
171 debug("port %d returns %lX\n", i
+ 1, dev
->status
);
174 #ifdef CONFIG_SANDBOX
176 * Don't set timeout / delay values here. This results
177 * in these values still being reset to 0.
179 if (state_get_skip_delays())
184 * Wait for power to become stable,
185 * plus spec-defined max time for device to connect
186 * but allow this time to be increased via env variable as some
187 * devices break the spec and require longer warm-up times
189 env
= env_get("usb_pgood_delay");
191 pgood_delay
= max(pgood_delay
,
192 (unsigned)simple_strtol(env
, NULL
, 0));
193 debug("pgood_delay=%dms\n", pgood_delay
);
196 * Do a minimum delay of the larger value of 100ms or pgood_delay
197 * so that the power can stablize before the devices are queried
199 hub
->query_delay
= get_timer(0) + max(100, (int)pgood_delay
);
202 * Record the power-on timeout here. The max. delay (timeout)
203 * will be done based on this value in the USB port loop in
204 * usb_hub_configure() later.
206 hub
->connect_timeout
= hub
->query_delay
+ 1000;
207 debug("devnum=%d poweron: query_delay=%d connect_timeout=%d\n",
208 dev
->devnum
, max(100, (int)pgood_delay
),
209 max(100, (int)pgood_delay
) + 1000);
212 #if !CONFIG_IS_ENABLED(DM_USB)
213 static struct usb_hub_device hub_dev
[USB_MAX_HUB
];
214 static int usb_hub_index
;
216 void usb_hub_reset(void)
220 /* Zero out global hub_dev in case its re-used again */
221 memset(hub_dev
, 0, sizeof(hub_dev
));
224 static struct usb_hub_device
*usb_hub_allocate(void)
226 if (usb_hub_index
< USB_MAX_HUB
)
227 return &hub_dev
[usb_hub_index
++];
229 printf("ERROR: USB_MAX_HUB (%d) reached\n", USB_MAX_HUB
);
236 static inline const char *portspeed(int portstatus
)
238 switch (portstatus
& USB_PORT_STAT_SPEED_MASK
) {
239 case USB_PORT_STAT_SUPER_SPEED
:
241 case USB_PORT_STAT_HIGH_SPEED
:
243 case USB_PORT_STAT_LOW_SPEED
:
251 * usb_hub_port_reset() - reset a port given its usb_device pointer
253 * Reset a hub port and see if a device is present on that port, providing
254 * sufficient time for it to show itself. The port status is returned.
256 * @dev: USB device to reset
257 * @port: Port number to reset (note ports are numbered from 0 here)
258 * @portstat: Returns port status
260 static int usb_hub_port_reset(struct usb_device
*dev
, int port
,
261 unsigned short *portstat
)
264 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status
, portsts
, 1);
265 unsigned short portstatus
, portchange
;
266 int delay
= HUB_SHORT_RESET_TIME
; /* start with short reset delay */
268 #if CONFIG_IS_ENABLED(DM_USB)
269 debug("%s: resetting '%s' port %d...\n", __func__
, dev
->dev
->name
,
272 debug("%s: resetting port %d...\n", __func__
, port
+ 1);
274 for (tries
= 0; tries
< MAX_TRIES
; tries
++) {
275 err
= usb_set_port_feature(dev
, port
+ 1, USB_PORT_FEAT_RESET
);
281 if (usb_get_port_status(dev
, port
+ 1, portsts
) < 0) {
282 debug("get_port_status failed status %lX\n",
286 portstatus
= le16_to_cpu(portsts
->wPortStatus
);
287 portchange
= le16_to_cpu(portsts
->wPortChange
);
289 debug("portstatus %x, change %x, %s\n", portstatus
, portchange
,
290 portspeed(portstatus
));
292 debug("STAT_C_CONNECTION = %d STAT_CONNECTION = %d" \
293 " USB_PORT_STAT_ENABLE %d\n",
294 (portchange
& USB_PORT_STAT_C_CONNECTION
) ? 1 : 0,
295 (portstatus
& USB_PORT_STAT_CONNECTION
) ? 1 : 0,
296 (portstatus
& USB_PORT_STAT_ENABLE
) ? 1 : 0);
299 * Perhaps we should check for the following here:
300 * - C_CONNECTION hasn't been set.
301 * - CONNECTION is still set.
303 * Doing so would ensure that the device is still connected
304 * to the bus, and hasn't been unplugged or replaced while the
305 * USB bus reset was going on.
307 * However, if we do that, then (at least) a San Disk Ultra
308 * USB 3.0 16GB device fails to reset on (at least) an NVIDIA
309 * Tegra Jetson TK1 board. For some reason, the device appears
310 * to briefly drop off the bus when this second bus reset is
311 * executed, yet if we retry this loop, it'll eventually come
312 * back after another reset or two.
315 if (portstatus
& USB_PORT_STAT_ENABLE
)
318 /* Switch to long reset delay for the next round */
319 delay
= HUB_LONG_RESET_TIME
;
322 if (tries
== MAX_TRIES
) {
323 debug("Cannot enable port %i after %i retries, " \
324 "disabling port.\n", port
+ 1, MAX_TRIES
);
325 debug("Maybe the USB cable is bad?\n");
329 usb_clear_port_feature(dev
, port
+ 1, USB_PORT_FEAT_C_RESET
);
330 *portstat
= portstatus
;
334 int usb_hub_port_connect_change(struct usb_device
*dev
, int port
)
336 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status
, portsts
, 1);
337 unsigned short portstatus
;
341 ret
= usb_get_port_status(dev
, port
+ 1, portsts
);
343 debug("get_port_status failed\n");
347 portstatus
= le16_to_cpu(portsts
->wPortStatus
);
348 debug("portstatus %x, change %x, %s\n",
350 le16_to_cpu(portsts
->wPortChange
),
351 portspeed(portstatus
));
353 /* Clear the connection change status */
354 usb_clear_port_feature(dev
, port
+ 1, USB_PORT_FEAT_C_CONNECTION
);
356 /* Disconnect any existing devices under this port */
357 if (((!(portstatus
& USB_PORT_STAT_CONNECTION
)) &&
358 (!(portstatus
& USB_PORT_STAT_ENABLE
))) ||
359 usb_device_has_child_on_port(dev
, port
)) {
360 debug("usb_disconnect(&hub->children[port]);\n");
361 /* Return now if nothing is connected */
362 if (!(portstatus
& USB_PORT_STAT_CONNECTION
))
367 ret
= usb_hub_port_reset(dev
, port
, &portstatus
);
370 printf("cannot reset port %i!?\n", port
+ 1);
374 switch (portstatus
& USB_PORT_STAT_SPEED_MASK
) {
375 case USB_PORT_STAT_SUPER_SPEED
:
376 speed
= USB_SPEED_SUPER
;
378 case USB_PORT_STAT_HIGH_SPEED
:
379 speed
= USB_SPEED_HIGH
;
381 case USB_PORT_STAT_LOW_SPEED
:
382 speed
= USB_SPEED_LOW
;
385 speed
= USB_SPEED_FULL
;
389 #if CONFIG_IS_ENABLED(DM_USB)
390 struct udevice
*child
;
392 ret
= usb_scan_device(dev
->dev
, port
+ 1, speed
, &child
);
394 struct usb_device
*usb
;
396 ret
= usb_alloc_new_device(dev
->controller
, &usb
);
398 printf("cannot create new device: ret=%d", ret
);
402 dev
->children
[port
] = usb
;
405 usb
->portnr
= port
+ 1;
406 /* Run it through the hoops (find a driver, etc) */
407 ret
= usb_new_device(usb
);
409 /* Woops, disable the port */
410 usb_free_device(dev
->controller
);
411 dev
->children
[port
] = NULL
;
415 debug("hub: disabling port %d\n", port
+ 1);
416 usb_clear_port_feature(dev
, port
+ 1, USB_PORT_FEAT_ENABLE
);
422 static int usb_scan_port(struct usb_device_scan
*usb_scan
)
424 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status
, portsts
, 1);
425 unsigned short portstatus
;
426 unsigned short portchange
;
427 struct usb_device
*dev
;
428 struct usb_hub_device
*hub
;
437 * Don't talk to the device before the query delay is expired.
438 * This is needed for voltages to stabalize.
440 if (get_timer(0) < hub
->query_delay
)
443 ret
= usb_get_port_status(dev
, i
+ 1, portsts
);
445 debug("get_port_status failed\n");
446 if (get_timer(0) >= hub
->connect_timeout
) {
447 debug("devnum=%d port=%d: timeout\n",
449 /* Remove this device from scanning list */
450 list_del(&usb_scan
->list
);
457 portstatus
= le16_to_cpu(portsts
->wPortStatus
);
458 portchange
= le16_to_cpu(portsts
->wPortChange
);
459 debug("Port %d Status %X Change %X\n", i
+ 1, portstatus
, portchange
);
462 * No connection change happened, wait a bit more.
464 * For some situation, the hub reports no connection change but a
465 * device is connected to the port (eg: CCS bit is set but CSC is not
466 * in the PORTSC register of a root hub), ignore such case.
468 if (!(portchange
& USB_PORT_STAT_C_CONNECTION
) &&
469 !(portstatus
& USB_PORT_STAT_CONNECTION
)) {
470 if (get_timer(0) >= hub
->connect_timeout
) {
471 debug("devnum=%d port=%d: timeout\n",
473 /* Remove this device from scanning list */
474 list_del(&usb_scan
->list
);
481 if (portchange
& USB_PORT_STAT_C_RESET
) {
482 debug("port %d reset change\n", i
+ 1);
483 usb_clear_port_feature(dev
, i
+ 1, USB_PORT_FEAT_C_RESET
);
486 if ((portchange
& USB_SS_PORT_STAT_C_BH_RESET
) &&
487 usb_hub_is_superspeed(dev
)) {
488 debug("port %d BH reset change\n", i
+ 1);
489 usb_clear_port_feature(dev
, i
+ 1, USB_SS_PORT_FEAT_C_BH_RESET
);
492 /* A new USB device is ready at this point */
493 debug("devnum=%d port=%d: USB dev found\n", dev
->devnum
, i
+ 1);
495 usb_hub_port_connect_change(dev
, i
);
497 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
498 debug("port %d enable change, status %x\n", i
+ 1, portstatus
);
499 usb_clear_port_feature(dev
, i
+ 1, USB_PORT_FEAT_C_ENABLE
);
501 * The following hack causes a ghost device problem
504 #ifndef CONFIG_USB_EHCI_FARADAY
506 * EM interference sometimes causes bad shielded USB
507 * devices to be shutdown by the hub, this hack enables
508 * them again. Works at least with mouse driver
510 if (!(portstatus
& USB_PORT_STAT_ENABLE
) &&
511 (portstatus
& USB_PORT_STAT_CONNECTION
) &&
512 usb_device_has_child_on_port(dev
, i
)) {
513 debug("already running port %i disabled by hub (EMI?), re-enabling...\n",
515 usb_hub_port_connect_change(dev
, i
);
520 if (portstatus
& USB_PORT_STAT_SUSPEND
) {
521 debug("port %d suspend change\n", i
+ 1);
522 usb_clear_port_feature(dev
, i
+ 1, USB_PORT_FEAT_SUSPEND
);
525 if (portchange
& USB_PORT_STAT_C_OVERCURRENT
) {
526 debug("port %d over-current change\n", i
+ 1);
527 usb_clear_port_feature(dev
, i
+ 1,
528 USB_PORT_FEAT_C_OVER_CURRENT
);
529 /* Only power-on this one port */
530 usb_set_port_feature(dev
, i
+ 1, USB_PORT_FEAT_POWER
);
531 hub
->overcurrent_count
[i
]++;
534 * If the max-scan-count is not reached, return without removing
535 * the device from scan-list. This will re-issue a new scan.
537 if (hub
->overcurrent_count
[i
] <=
538 PORT_OVERCURRENT_MAX_SCAN_COUNT
)
541 /* Otherwise the device will get removed */
542 printf("Port %d over-current occurred %d times\n", i
+ 1,
543 hub
->overcurrent_count
[i
]);
547 * We're done with this device, so let's remove this device from
550 list_del(&usb_scan
->list
);
556 static int usb_device_list_scan(void)
558 struct usb_device_scan
*usb_scan
;
559 struct usb_device_scan
*tmp
;
563 /* Only run this loop once for each controller */
570 /* We're done, once the list is empty again */
571 if (list_empty(&usb_scan_list
))
574 list_for_each_entry_safe(usb_scan
, tmp
, &usb_scan_list
, list
) {
578 ret
= usb_scan_port(usb_scan
);
586 * This USB controller has finished scanning all its connected
587 * USB devices. Set "running" back to 0, so that other USB controllers
588 * will scan their devices too.
595 static struct usb_hub_device
*usb_get_hub_device(struct usb_device
*dev
)
597 struct usb_hub_device
*hub
;
599 #if !CONFIG_IS_ENABLED(DM_USB)
600 /* "allocate" Hub device */
601 hub
= usb_hub_allocate();
603 hub
= dev_get_uclass_priv(dev
->dev
);
609 static int usb_hub_configure(struct usb_device
*dev
)
612 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, buffer
, USB_BUFSIZ
);
613 unsigned char *bitmap
;
614 short hubCharacteristics
;
615 struct usb_hub_descriptor
*descriptor
;
616 struct usb_hub_device
*hub
;
617 struct usb_hub_status
*hubsts
;
620 hub
= usb_get_hub_device(dev
);
625 /* Get the the hub descriptor */
626 ret
= usb_get_hub_descriptor(dev
, buffer
, 4);
628 debug("usb_hub_configure: failed to get hub " \
629 "descriptor, giving up %lX\n", dev
->status
);
632 descriptor
= (struct usb_hub_descriptor
*)buffer
;
634 length
= min_t(int, descriptor
->bLength
,
635 sizeof(struct usb_hub_descriptor
));
637 ret
= usb_get_hub_descriptor(dev
, buffer
, length
);
639 debug("usb_hub_configure: failed to get hub " \
640 "descriptor 2nd giving up %lX\n", dev
->status
);
643 memcpy((unsigned char *)&hub
->desc
, buffer
, length
);
644 /* adjust 16bit values */
645 put_unaligned(le16_to_cpu(get_unaligned(
646 &descriptor
->wHubCharacteristics
)),
647 &hub
->desc
.wHubCharacteristics
);
649 bitmap
= (unsigned char *)&hub
->desc
.u
.hs
.DeviceRemovable
[0];
650 /* devices not removable by default */
651 memset(bitmap
, 0xff, (USB_MAXCHILDREN
+1+7)/8);
652 bitmap
= (unsigned char *)&hub
->desc
.u
.hs
.PortPowerCtrlMask
[0];
653 memset(bitmap
, 0xff, (USB_MAXCHILDREN
+1+7)/8); /* PowerMask = 1B */
655 for (i
= 0; i
< ((hub
->desc
.bNbrPorts
+ 1 + 7)/8); i
++)
656 hub
->desc
.u
.hs
.DeviceRemovable
[i
] =
657 descriptor
->u
.hs
.DeviceRemovable
[i
];
659 for (i
= 0; i
< ((hub
->desc
.bNbrPorts
+ 1 + 7)/8); i
++)
660 hub
->desc
.u
.hs
.PortPowerCtrlMask
[i
] =
661 descriptor
->u
.hs
.PortPowerCtrlMask
[i
];
663 dev
->maxchild
= descriptor
->bNbrPorts
;
664 debug("%d ports detected\n", dev
->maxchild
);
666 hubCharacteristics
= get_unaligned(&hub
->desc
.wHubCharacteristics
);
667 switch (hubCharacteristics
& HUB_CHAR_LPSM
) {
669 debug("ganged power switching\n");
672 debug("individual port power switching\n");
676 debug("unknown reserved power switching mode\n");
680 if (hubCharacteristics
& HUB_CHAR_COMPOUND
)
681 debug("part of a compound device\n");
683 debug("standalone hub\n");
685 switch (hubCharacteristics
& HUB_CHAR_OCPM
) {
687 debug("global over-current protection\n");
690 debug("individual port over-current protection\n");
694 debug("no over-current protection\n");
698 switch (dev
->descriptor
.bDeviceProtocol
) {
701 case USB_HUB_PR_HS_SINGLE_TT
:
702 debug("Single TT\n");
704 case USB_HUB_PR_HS_MULTI_TT
:
705 ret
= usb_set_interface(dev
, 0, 1);
707 debug("TT per port\n");
708 hub
->tt
.multi
= true;
710 debug("Using single TT (err %d)\n", ret
);
714 /* USB 3.0 hubs don't have a TT */
717 debug("Unrecognized hub protocol %d\n",
718 dev
->descriptor
.bDeviceProtocol
);
722 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
723 switch (hubCharacteristics
& HUB_CHAR_TTTT
) {
724 case HUB_TTTT_8_BITS
:
725 if (dev
->descriptor
.bDeviceProtocol
!= 0) {
726 hub
->tt
.think_time
= 666;
727 debug("TT requires at most %d FS bit times (%d ns)\n",
728 8, hub
->tt
.think_time
);
731 case HUB_TTTT_16_BITS
:
732 hub
->tt
.think_time
= 666 * 2;
733 debug("TT requires at most %d FS bit times (%d ns)\n",
734 16, hub
->tt
.think_time
);
736 case HUB_TTTT_24_BITS
:
737 hub
->tt
.think_time
= 666 * 3;
738 debug("TT requires at most %d FS bit times (%d ns)\n",
739 24, hub
->tt
.think_time
);
741 case HUB_TTTT_32_BITS
:
742 hub
->tt
.think_time
= 666 * 4;
743 debug("TT requires at most %d FS bit times (%d ns)\n",
744 32, hub
->tt
.think_time
);
748 debug("power on to power good time: %dms\n",
749 descriptor
->bPwrOn2PwrGood
* 2);
750 debug("hub controller current requirement: %dmA\n",
751 descriptor
->bHubContrCurrent
);
753 for (i
= 0; i
< dev
->maxchild
; i
++)
754 debug("port %d is%s removable\n", i
+ 1,
755 hub
->desc
.u
.hs
.DeviceRemovable
[(i
+ 1) / 8] & \
756 (1 << ((i
+ 1) % 8)) ? " not" : "");
758 if (sizeof(struct usb_hub_status
) > USB_BUFSIZ
) {
759 debug("usb_hub_configure: failed to get Status - " \
760 "too long: %d\n", descriptor
->bLength
);
764 ret
= usb_get_hub_status(dev
, buffer
);
766 debug("usb_hub_configure: failed to get Status %lX\n",
771 hubsts
= (struct usb_hub_status
*)buffer
;
773 debug("get_hub_status returned status %X, change %X\n",
774 le16_to_cpu(hubsts
->wHubStatus
),
775 le16_to_cpu(hubsts
->wHubChange
));
776 debug("local power source is %s\n",
777 (le16_to_cpu(hubsts
->wHubStatus
) & HUB_STATUS_LOCAL_POWER
) ? \
778 "lost (inactive)" : "good");
779 debug("%sover-current condition exists\n",
780 (le16_to_cpu(hubsts
->wHubStatus
) & HUB_STATUS_OVERCURRENT
) ? \
783 #if CONFIG_IS_ENABLED(DM_USB)
785 * Update USB host controller's internal representation of this hub
786 * after the hub descriptor is fetched.
788 ret
= usb_update_hub_device(dev
);
789 if (ret
< 0 && ret
!= -ENOSYS
) {
790 debug("%s: failed to update hub device for HCD (%x)\n",
796 * A maximum of seven tiers are allowed in a USB topology, and the
797 * root hub occupies the first tier. The last tier ends with a normal
798 * USB device. USB 3.0 hubs use a 20-bit field called 'route string'
799 * to route packets to the designated downstream port. The hub uses a
800 * hub depth value multiplied by four as an offset into the 'route
801 * string' to locate the bits it uses to determine the downstream
804 if (usb_hub_is_root_hub(dev
->dev
)) {
807 struct udevice
*hdev
;
810 hdev
= dev
->dev
->parent
;
811 while (!usb_hub_is_root_hub(hdev
)) {
816 hub
->hub_depth
= depth
;
818 if (usb_hub_is_superspeed(dev
)) {
819 debug("set hub (%p) depth to %d\n", dev
, depth
);
821 * This request sets the value that the hub uses to
822 * determine the index into the 'route string index'
825 ret
= usb_set_hub_depth(dev
, depth
);
827 debug("%s: failed to set hub depth (%lX)\n",
828 __func__
, dev
->status
);
835 usb_hub_power_on(hub
);
838 * Reset any devices that may be in a bad state when applying
839 * the power. This is a __weak function. Resetting of the devices
840 * should occur in the board file of the device.
842 for (i
= 0; i
< dev
->maxchild
; i
++)
843 usb_hub_reset_devices(hub
, i
+ 1);
846 * Only add the connected USB devices, including potential hubs,
847 * to a scanning list. This list will get scanned and devices that
848 * are detected (either via port connected or via port timeout)
849 * will get removed from this list. Scanning of the devices on this
850 * list will continue until all devices are removed.
852 for (i
= 0; i
< dev
->maxchild
; i
++) {
853 struct usb_device_scan
*usb_scan
;
855 usb_scan
= calloc(1, sizeof(*usb_scan
));
857 printf("Can't allocate memory for USB device!\n");
863 list_add_tail(&usb_scan
->list
, &usb_scan_list
);
867 * And now call the scanning code which loops over the generated list
869 ret
= usb_device_list_scan();
874 static int usb_hub_check(struct usb_device
*dev
, int ifnum
)
876 struct usb_interface
*iface
;
877 struct usb_endpoint_descriptor
*ep
= NULL
;
879 iface
= &dev
->config
.if_desc
[ifnum
];
881 if (iface
->desc
.bInterfaceClass
!= USB_CLASS_HUB
)
883 /* Some hubs have a subclass of 1, which AFAICT according to the */
884 /* specs is not defined, but it works */
885 if ((iface
->desc
.bInterfaceSubClass
!= 0) &&
886 (iface
->desc
.bInterfaceSubClass
!= 1))
888 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
889 if (iface
->desc
.bNumEndpoints
!= 1)
891 ep
= &iface
->ep_desc
[0];
892 /* Output endpoint? Curiousier and curiousier.. */
893 if (!(ep
->bEndpointAddress
& USB_DIR_IN
))
895 /* If it's not an interrupt endpoint, we'd better punt! */
896 if ((ep
->bmAttributes
& 3) != 3)
899 debug("USB hub found\n");
903 debug("USB hub not found: bInterfaceClass=%d, bInterfaceSubClass=%d, bNumEndpoints=%d\n",
904 iface
->desc
.bInterfaceClass
, iface
->desc
.bInterfaceSubClass
,
905 iface
->desc
.bNumEndpoints
);
907 debug(" bEndpointAddress=%#x, bmAttributes=%d",
908 ep
->bEndpointAddress
, ep
->bmAttributes
);
914 int usb_hub_probe(struct usb_device
*dev
, int ifnum
)
918 ret
= usb_hub_check(dev
, ifnum
);
921 ret
= usb_hub_configure(dev
);
925 #if CONFIG_IS_ENABLED(DM_USB)
926 int usb_hub_scan(struct udevice
*hub
)
928 struct usb_device
*udev
= dev_get_parent_priv(hub
);
930 return usb_hub_configure(udev
);
933 static int usb_hub_post_probe(struct udevice
*dev
)
935 debug("%s\n", __func__
);
936 return usb_hub_scan(dev
);
939 static const struct udevice_id usb_hub_ids
[] = {
940 { .compatible
= "usb-hub" },
944 U_BOOT_DRIVER(usb_generic_hub
) = {
946 .id
= UCLASS_USB_HUB
,
947 .of_match
= usb_hub_ids
,
948 .flags
= DM_FLAG_ALLOC_PRIV_DMA
,
951 UCLASS_DRIVER(usb_hub
) = {
952 .id
= UCLASS_USB_HUB
,
954 .post_bind
= dm_scan_fdt_dev
,
955 .post_probe
= usb_hub_post_probe
,
956 .child_pre_probe
= usb_child_pre_probe
,
957 .per_child_auto_alloc_size
= sizeof(struct usb_device
),
958 .per_child_platdata_auto_alloc_size
= sizeof(struct usb_dev_platdata
),
959 .per_device_auto_alloc_size
= sizeof(struct usb_hub_device
),
962 static const struct usb_device_id hub_id_table
[] = {
964 .match_flags
= USB_DEVICE_ID_MATCH_DEV_CLASS
,
965 .bDeviceClass
= USB_CLASS_HUB
967 { } /* Terminating entry */
970 U_BOOT_USB_DEVICE(usb_generic_hub
, hub_id_table
);