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
30 #include <asm/processor.h>
31 #include <asm/unaligned.h>
32 #include <linux/ctype.h>
33 #include <linux/list.h>
34 #include <asm/byteorder.h>
36 #include <asm/state.h>
38 #include <asm/unaligned.h>
42 #define USB_BUFSIZ 512
44 #define HUB_SHORT_RESET_TIME 20
45 #define HUB_LONG_RESET_TIME 200
47 #define PORT_OVERCURRENT_MAX_SCAN_COUNT 3
49 struct usb_device_scan
{
50 struct usb_device
*dev
; /* USB hub device to scan */
51 struct usb_hub_device
*hub
; /* USB hub struct */
52 int port
; /* USB port to scan */
53 struct list_head list
;
56 static LIST_HEAD(usb_scan_list
);
58 __weak
void usb_hub_reset_devices(struct usb_hub_device
*hub
, int port
)
63 static inline bool usb_hub_is_superspeed(struct usb_device
*hdev
)
65 return hdev
->descriptor
.bDeviceProtocol
== 3;
69 bool usb_hub_is_root_hub(struct udevice
*hub
)
71 if (device_get_uclass_id(hub
->parent
) != UCLASS_USB_HUB
)
77 static int usb_set_hub_depth(struct usb_device
*dev
, int depth
)
79 if (depth
< 0 || depth
> 4)
82 return usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
83 USB_REQ_SET_HUB_DEPTH
, USB_DIR_OUT
| USB_RT_HUB
,
84 depth
, 0, NULL
, 0, USB_CNTL_TIMEOUT
);
88 static int usb_get_hub_descriptor(struct usb_device
*dev
, void *data
, int size
)
90 unsigned short dtype
= USB_DT_HUB
;
92 if (usb_hub_is_superspeed(dev
))
93 dtype
= USB_DT_SS_HUB
;
95 return usb_control_msg(dev
, usb_rcvctrlpipe(dev
, 0),
96 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
| USB_RT_HUB
,
97 dtype
<< 8, 0, data
, size
, USB_CNTL_TIMEOUT
);
100 static int usb_clear_port_feature(struct usb_device
*dev
, int port
, int feature
)
102 return usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
103 USB_REQ_CLEAR_FEATURE
, USB_RT_PORT
, feature
,
104 port
, NULL
, 0, USB_CNTL_TIMEOUT
);
107 static int usb_set_port_feature(struct usb_device
*dev
, int port
, int feature
)
109 return usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
110 USB_REQ_SET_FEATURE
, USB_RT_PORT
, feature
,
111 port
, NULL
, 0, USB_CNTL_TIMEOUT
);
114 static int usb_get_hub_status(struct usb_device
*dev
, void *data
)
116 return usb_control_msg(dev
, usb_rcvctrlpipe(dev
, 0),
117 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_HUB
, 0, 0,
118 data
, sizeof(struct usb_hub_status
), USB_CNTL_TIMEOUT
);
121 int usb_get_port_status(struct usb_device
*dev
, int port
, void *data
)
125 ret
= usb_control_msg(dev
, usb_rcvctrlpipe(dev
, 0),
126 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_PORT
, 0, port
,
127 data
, sizeof(struct usb_port_status
), USB_CNTL_TIMEOUT
);
134 * Translate the USB 3.0 hub port status field into the old version
135 * that U-Boot understands. Do this only when the hub is not root hub.
136 * For root hub, the port status field has already been translated
137 * in the host controller driver (see xhci_submit_root() in xhci.c).
139 * Note: this only supports driver model.
142 if (!usb_hub_is_root_hub(dev
->dev
) && usb_hub_is_superspeed(dev
)) {
143 struct usb_port_status
*status
= (struct usb_port_status
*)data
;
144 u16 tmp
= (status
->wPortStatus
) & USB_SS_PORT_STAT_MASK
;
146 if (status
->wPortStatus
& USB_SS_PORT_STAT_POWER
)
147 tmp
|= USB_PORT_STAT_POWER
;
148 if ((status
->wPortStatus
& USB_SS_PORT_STAT_SPEED
) ==
149 USB_SS_PORT_STAT_SPEED_5GBPS
)
150 tmp
|= USB_PORT_STAT_SUPER_SPEED
;
152 status
->wPortStatus
= tmp
;
160 static void usb_hub_power_on(struct usb_hub_device
*hub
)
163 struct usb_device
*dev
;
164 unsigned pgood_delay
= hub
->desc
.bPwrOn2PwrGood
* 2;
169 debug("enabling power on all ports\n");
170 for (i
= 0; i
< dev
->maxchild
; i
++) {
171 usb_set_port_feature(dev
, i
+ 1, USB_PORT_FEAT_POWER
);
172 debug("port %d returns %lX\n", i
+ 1, dev
->status
);
175 #ifdef CONFIG_SANDBOX
177 * Don't set timeout / delay values here. This results
178 * in these values still being reset to 0.
180 if (state_get_skip_delays())
185 * Wait for power to become stable,
186 * plus spec-defined max time for device to connect
187 * but allow this time to be increased via env variable as some
188 * devices break the spec and require longer warm-up times
190 env
= env_get("usb_pgood_delay");
192 pgood_delay
= max(pgood_delay
,
193 (unsigned)simple_strtol(env
, NULL
, 0));
194 debug("pgood_delay=%dms\n", pgood_delay
);
197 * Do a minimum delay of the larger value of 100ms or pgood_delay
198 * so that the power can stablize before the devices are queried
200 hub
->query_delay
= get_timer(0) + max(100, (int)pgood_delay
);
203 * Record the power-on timeout here. The max. delay (timeout)
204 * will be done based on this value in the USB port loop in
205 * usb_hub_configure() later.
207 hub
->connect_timeout
= hub
->query_delay
+ 1000;
208 debug("devnum=%d poweron: query_delay=%d connect_timeout=%d\n",
209 dev
->devnum
, max(100, (int)pgood_delay
),
210 max(100, (int)pgood_delay
) + 1000);
213 #ifndef CONFIG_DM_USB
214 static struct usb_hub_device hub_dev
[USB_MAX_HUB
];
215 static int usb_hub_index
;
217 void usb_hub_reset(void)
221 /* Zero out global hub_dev in case its re-used again */
222 memset(hub_dev
, 0, sizeof(hub_dev
));
225 static struct usb_hub_device
*usb_hub_allocate(void)
227 if (usb_hub_index
< USB_MAX_HUB
)
228 return &hub_dev
[usb_hub_index
++];
230 printf("ERROR: USB_MAX_HUB (%d) reached\n", USB_MAX_HUB
);
237 static inline char *portspeed(int portstatus
)
241 switch (portstatus
& USB_PORT_STAT_SPEED_MASK
) {
242 case USB_PORT_STAT_SUPER_SPEED
:
243 speed_str
= "5 Gb/s";
245 case USB_PORT_STAT_HIGH_SPEED
:
246 speed_str
= "480 Mb/s";
248 case USB_PORT_STAT_LOW_SPEED
:
249 speed_str
= "1.5 Mb/s";
252 speed_str
= "12 Mb/s";
260 * usb_hub_port_reset() - reset a port given its usb_device pointer
262 * Reset a hub port and see if a device is present on that port, providing
263 * sufficient time for it to show itself. The port status is returned.
265 * @dev: USB device to reset
266 * @port: Port number to reset (note ports are numbered from 0 here)
267 * @portstat: Returns port status
269 static int usb_hub_port_reset(struct usb_device
*dev
, int port
,
270 unsigned short *portstat
)
273 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status
, portsts
, 1);
274 unsigned short portstatus
, portchange
;
275 int delay
= HUB_SHORT_RESET_TIME
; /* start with short reset delay */
278 debug("%s: resetting '%s' port %d...\n", __func__
, dev
->dev
->name
,
281 debug("%s: resetting port %d...\n", __func__
, port
+ 1);
283 for (tries
= 0; tries
< MAX_TRIES
; tries
++) {
284 err
= usb_set_port_feature(dev
, port
+ 1, USB_PORT_FEAT_RESET
);
290 if (usb_get_port_status(dev
, port
+ 1, portsts
) < 0) {
291 debug("get_port_status failed status %lX\n",
295 portstatus
= le16_to_cpu(portsts
->wPortStatus
);
296 portchange
= le16_to_cpu(portsts
->wPortChange
);
298 debug("portstatus %x, change %x, %s\n", portstatus
, portchange
,
299 portspeed(portstatus
));
301 debug("STAT_C_CONNECTION = %d STAT_CONNECTION = %d" \
302 " USB_PORT_STAT_ENABLE %d\n",
303 (portchange
& USB_PORT_STAT_C_CONNECTION
) ? 1 : 0,
304 (portstatus
& USB_PORT_STAT_CONNECTION
) ? 1 : 0,
305 (portstatus
& USB_PORT_STAT_ENABLE
) ? 1 : 0);
308 * Perhaps we should check for the following here:
309 * - C_CONNECTION hasn't been set.
310 * - CONNECTION is still set.
312 * Doing so would ensure that the device is still connected
313 * to the bus, and hasn't been unplugged or replaced while the
314 * USB bus reset was going on.
316 * However, if we do that, then (at least) a San Disk Ultra
317 * USB 3.0 16GB device fails to reset on (at least) an NVIDIA
318 * Tegra Jetson TK1 board. For some reason, the device appears
319 * to briefly drop off the bus when this second bus reset is
320 * executed, yet if we retry this loop, it'll eventually come
321 * back after another reset or two.
324 if (portstatus
& USB_PORT_STAT_ENABLE
)
327 /* Switch to long reset delay for the next round */
328 delay
= HUB_LONG_RESET_TIME
;
331 if (tries
== MAX_TRIES
) {
332 debug("Cannot enable port %i after %i retries, " \
333 "disabling port.\n", port
+ 1, MAX_TRIES
);
334 debug("Maybe the USB cable is bad?\n");
338 usb_clear_port_feature(dev
, port
+ 1, USB_PORT_FEAT_C_RESET
);
339 *portstat
= portstatus
;
343 int usb_hub_port_connect_change(struct usb_device
*dev
, int port
)
345 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status
, portsts
, 1);
346 unsigned short portstatus
;
350 ret
= usb_get_port_status(dev
, port
+ 1, portsts
);
352 debug("get_port_status failed\n");
356 portstatus
= le16_to_cpu(portsts
->wPortStatus
);
357 debug("portstatus %x, change %x, %s\n",
359 le16_to_cpu(portsts
->wPortChange
),
360 portspeed(portstatus
));
362 /* Clear the connection change status */
363 usb_clear_port_feature(dev
, port
+ 1, USB_PORT_FEAT_C_CONNECTION
);
365 /* Disconnect any existing devices under this port */
366 if (((!(portstatus
& USB_PORT_STAT_CONNECTION
)) &&
367 (!(portstatus
& USB_PORT_STAT_ENABLE
))) ||
368 usb_device_has_child_on_port(dev
, port
)) {
369 debug("usb_disconnect(&hub->children[port]);\n");
370 /* Return now if nothing is connected */
371 if (!(portstatus
& USB_PORT_STAT_CONNECTION
))
376 ret
= usb_hub_port_reset(dev
, port
, &portstatus
);
379 printf("cannot reset port %i!?\n", port
+ 1);
383 switch (portstatus
& USB_PORT_STAT_SPEED_MASK
) {
384 case USB_PORT_STAT_SUPER_SPEED
:
385 speed
= USB_SPEED_SUPER
;
387 case USB_PORT_STAT_HIGH_SPEED
:
388 speed
= USB_SPEED_HIGH
;
390 case USB_PORT_STAT_LOW_SPEED
:
391 speed
= USB_SPEED_LOW
;
394 speed
= USB_SPEED_FULL
;
399 struct udevice
*child
;
401 ret
= usb_scan_device(dev
->dev
, port
+ 1, speed
, &child
);
403 struct usb_device
*usb
;
405 ret
= usb_alloc_new_device(dev
->controller
, &usb
);
407 printf("cannot create new device: ret=%d", ret
);
411 dev
->children
[port
] = usb
;
414 usb
->portnr
= port
+ 1;
415 /* Run it through the hoops (find a driver, etc) */
416 ret
= usb_new_device(usb
);
418 /* Woops, disable the port */
419 usb_free_device(dev
->controller
);
420 dev
->children
[port
] = NULL
;
424 debug("hub: disabling port %d\n", port
+ 1);
425 usb_clear_port_feature(dev
, port
+ 1, USB_PORT_FEAT_ENABLE
);
431 static int usb_scan_port(struct usb_device_scan
*usb_scan
)
433 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status
, portsts
, 1);
434 unsigned short portstatus
;
435 unsigned short portchange
;
436 struct usb_device
*dev
;
437 struct usb_hub_device
*hub
;
446 * Don't talk to the device before the query delay is expired.
447 * This is needed for voltages to stabalize.
449 if (get_timer(0) < hub
->query_delay
)
452 ret
= usb_get_port_status(dev
, i
+ 1, portsts
);
454 debug("get_port_status failed\n");
455 if (get_timer(0) >= hub
->connect_timeout
) {
456 debug("devnum=%d port=%d: timeout\n",
458 /* Remove this device from scanning list */
459 list_del(&usb_scan
->list
);
466 portstatus
= le16_to_cpu(portsts
->wPortStatus
);
467 portchange
= le16_to_cpu(portsts
->wPortChange
);
468 debug("Port %d Status %X Change %X\n", i
+ 1, portstatus
, portchange
);
471 * No connection change happened, wait a bit more.
473 * For some situation, the hub reports no connection change but a
474 * device is connected to the port (eg: CCS bit is set but CSC is not
475 * in the PORTSC register of a root hub), ignore such case.
477 if (!(portchange
& USB_PORT_STAT_C_CONNECTION
) &&
478 !(portstatus
& USB_PORT_STAT_CONNECTION
)) {
479 if (get_timer(0) >= hub
->connect_timeout
) {
480 debug("devnum=%d port=%d: timeout\n",
482 /* Remove this device from scanning list */
483 list_del(&usb_scan
->list
);
490 if (portchange
& USB_PORT_STAT_C_RESET
) {
491 debug("port %d reset change\n", i
+ 1);
492 usb_clear_port_feature(dev
, i
+ 1, USB_PORT_FEAT_C_RESET
);
495 if ((portchange
& USB_SS_PORT_STAT_C_BH_RESET
) &&
496 usb_hub_is_superspeed(dev
)) {
497 debug("port %d BH reset change\n", i
+ 1);
498 usb_clear_port_feature(dev
, i
+ 1, USB_SS_PORT_FEAT_C_BH_RESET
);
501 /* A new USB device is ready at this point */
502 debug("devnum=%d port=%d: USB dev found\n", dev
->devnum
, i
+ 1);
504 usb_hub_port_connect_change(dev
, i
);
506 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
507 debug("port %d enable change, status %x\n", i
+ 1, portstatus
);
508 usb_clear_port_feature(dev
, i
+ 1, USB_PORT_FEAT_C_ENABLE
);
510 * The following hack causes a ghost device problem
513 #ifndef CONFIG_USB_EHCI_FARADAY
515 * EM interference sometimes causes bad shielded USB
516 * devices to be shutdown by the hub, this hack enables
517 * them again. Works at least with mouse driver
519 if (!(portstatus
& USB_PORT_STAT_ENABLE
) &&
520 (portstatus
& USB_PORT_STAT_CONNECTION
) &&
521 usb_device_has_child_on_port(dev
, i
)) {
522 debug("already running port %i disabled by hub (EMI?), re-enabling...\n",
524 usb_hub_port_connect_change(dev
, i
);
529 if (portstatus
& USB_PORT_STAT_SUSPEND
) {
530 debug("port %d suspend change\n", i
+ 1);
531 usb_clear_port_feature(dev
, i
+ 1, USB_PORT_FEAT_SUSPEND
);
534 if (portchange
& USB_PORT_STAT_C_OVERCURRENT
) {
535 debug("port %d over-current change\n", i
+ 1);
536 usb_clear_port_feature(dev
, i
+ 1,
537 USB_PORT_FEAT_C_OVER_CURRENT
);
538 /* Only power-on this one port */
539 usb_set_port_feature(dev
, i
+ 1, USB_PORT_FEAT_POWER
);
540 hub
->overcurrent_count
[i
]++;
543 * If the max-scan-count is not reached, return without removing
544 * the device from scan-list. This will re-issue a new scan.
546 if (hub
->overcurrent_count
[i
] <=
547 PORT_OVERCURRENT_MAX_SCAN_COUNT
)
550 /* Otherwise the device will get removed */
551 printf("Port %d over-current occurred %d times\n", i
+ 1,
552 hub
->overcurrent_count
[i
]);
556 * We're done with this device, so let's remove this device from
559 list_del(&usb_scan
->list
);
565 static int usb_device_list_scan(void)
567 struct usb_device_scan
*usb_scan
;
568 struct usb_device_scan
*tmp
;
572 /* Only run this loop once for each controller */
579 /* We're done, once the list is empty again */
580 if (list_empty(&usb_scan_list
))
583 list_for_each_entry_safe(usb_scan
, tmp
, &usb_scan_list
, list
) {
587 ret
= usb_scan_port(usb_scan
);
595 * This USB controller has finished scanning all its connected
596 * USB devices. Set "running" back to 0, so that other USB controllers
597 * will scan their devices too.
604 static struct usb_hub_device
*usb_get_hub_device(struct usb_device
*dev
)
606 struct usb_hub_device
*hub
;
608 #ifndef CONFIG_DM_USB
609 /* "allocate" Hub device */
610 hub
= usb_hub_allocate();
612 hub
= dev_get_uclass_priv(dev
->dev
);
618 static int usb_hub_configure(struct usb_device
*dev
)
621 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, buffer
, USB_BUFSIZ
);
622 unsigned char *bitmap
;
623 short hubCharacteristics
;
624 struct usb_hub_descriptor
*descriptor
;
625 struct usb_hub_device
*hub
;
626 struct usb_hub_status
*hubsts
;
629 hub
= usb_get_hub_device(dev
);
634 /* Get the the hub descriptor */
635 ret
= usb_get_hub_descriptor(dev
, buffer
, 4);
637 debug("usb_hub_configure: failed to get hub " \
638 "descriptor, giving up %lX\n", dev
->status
);
641 descriptor
= (struct usb_hub_descriptor
*)buffer
;
643 length
= min_t(int, descriptor
->bLength
,
644 sizeof(struct usb_hub_descriptor
));
646 ret
= usb_get_hub_descriptor(dev
, buffer
, length
);
648 debug("usb_hub_configure: failed to get hub " \
649 "descriptor 2nd giving up %lX\n", dev
->status
);
652 memcpy((unsigned char *)&hub
->desc
, buffer
, length
);
653 /* adjust 16bit values */
654 put_unaligned(le16_to_cpu(get_unaligned(
655 &descriptor
->wHubCharacteristics
)),
656 &hub
->desc
.wHubCharacteristics
);
658 bitmap
= (unsigned char *)&hub
->desc
.u
.hs
.DeviceRemovable
[0];
659 /* devices not removable by default */
660 memset(bitmap
, 0xff, (USB_MAXCHILDREN
+1+7)/8);
661 bitmap
= (unsigned char *)&hub
->desc
.u
.hs
.PortPowerCtrlMask
[0];
662 memset(bitmap
, 0xff, (USB_MAXCHILDREN
+1+7)/8); /* PowerMask = 1B */
664 for (i
= 0; i
< ((hub
->desc
.bNbrPorts
+ 1 + 7)/8); i
++)
665 hub
->desc
.u
.hs
.DeviceRemovable
[i
] =
666 descriptor
->u
.hs
.DeviceRemovable
[i
];
668 for (i
= 0; i
< ((hub
->desc
.bNbrPorts
+ 1 + 7)/8); i
++)
669 hub
->desc
.u
.hs
.PortPowerCtrlMask
[i
] =
670 descriptor
->u
.hs
.PortPowerCtrlMask
[i
];
672 dev
->maxchild
= descriptor
->bNbrPorts
;
673 debug("%d ports detected\n", dev
->maxchild
);
675 hubCharacteristics
= get_unaligned(&hub
->desc
.wHubCharacteristics
);
676 switch (hubCharacteristics
& HUB_CHAR_LPSM
) {
678 debug("ganged power switching\n");
681 debug("individual port power switching\n");
685 debug("unknown reserved power switching mode\n");
689 if (hubCharacteristics
& HUB_CHAR_COMPOUND
)
690 debug("part of a compound device\n");
692 debug("standalone hub\n");
694 switch (hubCharacteristics
& HUB_CHAR_OCPM
) {
696 debug("global over-current protection\n");
699 debug("individual port over-current protection\n");
703 debug("no over-current protection\n");
707 switch (dev
->descriptor
.bDeviceProtocol
) {
710 case USB_HUB_PR_HS_SINGLE_TT
:
711 debug("Single TT\n");
713 case USB_HUB_PR_HS_MULTI_TT
:
714 ret
= usb_set_interface(dev
, 0, 1);
716 debug("TT per port\n");
717 hub
->tt
.multi
= true;
719 debug("Using single TT (err %d)\n", ret
);
723 /* USB 3.0 hubs don't have a TT */
726 debug("Unrecognized hub protocol %d\n",
727 dev
->descriptor
.bDeviceProtocol
);
731 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
732 switch (hubCharacteristics
& HUB_CHAR_TTTT
) {
733 case HUB_TTTT_8_BITS
:
734 if (dev
->descriptor
.bDeviceProtocol
!= 0) {
735 hub
->tt
.think_time
= 666;
736 debug("TT requires at most %d FS bit times (%d ns)\n",
737 8, hub
->tt
.think_time
);
740 case HUB_TTTT_16_BITS
:
741 hub
->tt
.think_time
= 666 * 2;
742 debug("TT requires at most %d FS bit times (%d ns)\n",
743 16, hub
->tt
.think_time
);
745 case HUB_TTTT_24_BITS
:
746 hub
->tt
.think_time
= 666 * 3;
747 debug("TT requires at most %d FS bit times (%d ns)\n",
748 24, hub
->tt
.think_time
);
750 case HUB_TTTT_32_BITS
:
751 hub
->tt
.think_time
= 666 * 4;
752 debug("TT requires at most %d FS bit times (%d ns)\n",
753 32, hub
->tt
.think_time
);
757 debug("power on to power good time: %dms\n",
758 descriptor
->bPwrOn2PwrGood
* 2);
759 debug("hub controller current requirement: %dmA\n",
760 descriptor
->bHubContrCurrent
);
762 for (i
= 0; i
< dev
->maxchild
; i
++)
763 debug("port %d is%s removable\n", i
+ 1,
764 hub
->desc
.u
.hs
.DeviceRemovable
[(i
+ 1) / 8] & \
765 (1 << ((i
+ 1) % 8)) ? " not" : "");
767 if (sizeof(struct usb_hub_status
) > USB_BUFSIZ
) {
768 debug("usb_hub_configure: failed to get Status - " \
769 "too long: %d\n", descriptor
->bLength
);
773 ret
= usb_get_hub_status(dev
, buffer
);
775 debug("usb_hub_configure: failed to get Status %lX\n",
780 hubsts
= (struct usb_hub_status
*)buffer
;
782 debug("get_hub_status returned status %X, change %X\n",
783 le16_to_cpu(hubsts
->wHubStatus
),
784 le16_to_cpu(hubsts
->wHubChange
));
785 debug("local power source is %s\n",
786 (le16_to_cpu(hubsts
->wHubStatus
) & HUB_STATUS_LOCAL_POWER
) ? \
787 "lost (inactive)" : "good");
788 debug("%sover-current condition exists\n",
789 (le16_to_cpu(hubsts
->wHubStatus
) & HUB_STATUS_OVERCURRENT
) ? \
794 * Update USB host controller's internal representation of this hub
795 * after the hub descriptor is fetched.
797 ret
= usb_update_hub_device(dev
);
798 if (ret
< 0 && ret
!= -ENOSYS
) {
799 debug("%s: failed to update hub device for HCD (%x)\n",
805 * A maximum of seven tiers are allowed in a USB topology, and the
806 * root hub occupies the first tier. The last tier ends with a normal
807 * USB device. USB 3.0 hubs use a 20-bit field called 'route string'
808 * to route packets to the designated downstream port. The hub uses a
809 * hub depth value multiplied by four as an offset into the 'route
810 * string' to locate the bits it uses to determine the downstream
813 if (usb_hub_is_root_hub(dev
->dev
)) {
816 struct udevice
*hdev
;
819 hdev
= dev
->dev
->parent
;
820 while (!usb_hub_is_root_hub(hdev
)) {
825 hub
->hub_depth
= depth
;
827 if (usb_hub_is_superspeed(dev
)) {
828 debug("set hub (%p) depth to %d\n", dev
, depth
);
830 * This request sets the value that the hub uses to
831 * determine the index into the 'route string index'
834 ret
= usb_set_hub_depth(dev
, depth
);
836 debug("%s: failed to set hub depth (%lX)\n",
837 __func__
, dev
->status
);
844 usb_hub_power_on(hub
);
847 * Reset any devices that may be in a bad state when applying
848 * the power. This is a __weak function. Resetting of the devices
849 * should occur in the board file of the device.
851 for (i
= 0; i
< dev
->maxchild
; i
++)
852 usb_hub_reset_devices(hub
, i
+ 1);
855 * Only add the connected USB devices, including potential hubs,
856 * to a scanning list. This list will get scanned and devices that
857 * are detected (either via port connected or via port timeout)
858 * will get removed from this list. Scanning of the devices on this
859 * list will continue until all devices are removed.
861 for (i
= 0; i
< dev
->maxchild
; i
++) {
862 struct usb_device_scan
*usb_scan
;
864 usb_scan
= calloc(1, sizeof(*usb_scan
));
866 printf("Can't allocate memory for USB device!\n");
872 list_add_tail(&usb_scan
->list
, &usb_scan_list
);
876 * And now call the scanning code which loops over the generated list
878 ret
= usb_device_list_scan();
883 static int usb_hub_check(struct usb_device
*dev
, int ifnum
)
885 struct usb_interface
*iface
;
886 struct usb_endpoint_descriptor
*ep
= NULL
;
888 iface
= &dev
->config
.if_desc
[ifnum
];
890 if (iface
->desc
.bInterfaceClass
!= USB_CLASS_HUB
)
892 /* Some hubs have a subclass of 1, which AFAICT according to the */
893 /* specs is not defined, but it works */
894 if ((iface
->desc
.bInterfaceSubClass
!= 0) &&
895 (iface
->desc
.bInterfaceSubClass
!= 1))
897 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
898 if (iface
->desc
.bNumEndpoints
!= 1)
900 ep
= &iface
->ep_desc
[0];
901 /* Output endpoint? Curiousier and curiousier.. */
902 if (!(ep
->bEndpointAddress
& USB_DIR_IN
))
904 /* If it's not an interrupt endpoint, we'd better punt! */
905 if ((ep
->bmAttributes
& 3) != 3)
908 debug("USB hub found\n");
912 debug("USB hub not found: bInterfaceClass=%d, bInterfaceSubClass=%d, bNumEndpoints=%d\n",
913 iface
->desc
.bInterfaceClass
, iface
->desc
.bInterfaceSubClass
,
914 iface
->desc
.bNumEndpoints
);
916 debug(" bEndpointAddress=%#x, bmAttributes=%d",
917 ep
->bEndpointAddress
, ep
->bmAttributes
);
923 int usb_hub_probe(struct usb_device
*dev
, int ifnum
)
927 ret
= usb_hub_check(dev
, ifnum
);
930 ret
= usb_hub_configure(dev
);
935 int usb_hub_scan(struct udevice
*hub
)
937 struct usb_device
*udev
= dev_get_parent_priv(hub
);
939 return usb_hub_configure(udev
);
942 static int usb_hub_post_probe(struct udevice
*dev
)
944 debug("%s\n", __func__
);
945 return usb_hub_scan(dev
);
948 static const struct udevice_id usb_hub_ids
[] = {
949 { .compatible
= "usb-hub" },
953 U_BOOT_DRIVER(usb_generic_hub
) = {
955 .id
= UCLASS_USB_HUB
,
956 .of_match
= usb_hub_ids
,
957 .flags
= DM_FLAG_ALLOC_PRIV_DMA
,
960 UCLASS_DRIVER(usb_hub
) = {
961 .id
= UCLASS_USB_HUB
,
963 .post_bind
= dm_scan_fdt_dev
,
964 .post_probe
= usb_hub_post_probe
,
965 .child_pre_probe
= usb_child_pre_probe
,
966 .per_child_auto_alloc_size
= sizeof(struct usb_device
),
967 .per_child_platdata_auto_alloc_size
= sizeof(struct usb_dev_platdata
),
968 .per_device_auto_alloc_size
= sizeof(struct usb_hub_device
),
971 static const struct usb_device_id hub_id_table
[] = {
973 .match_flags
= USB_DEVICE_ID_MATCH_DEV_CLASS
,
974 .bDeviceClass
= USB_CLASS_HUB
976 { } /* Terminating entry */
979 U_BOOT_USB_DEVICE(usb_generic_hub
, hub_id_table
);