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>
40 DECLARE_GLOBAL_DATA_PTR;
44 #define USB_BUFSIZ 512
46 #define HUB_SHORT_RESET_TIME 20
47 #define HUB_LONG_RESET_TIME 200
49 #define PORT_OVERCURRENT_MAX_SCAN_COUNT 3
51 struct usb_device_scan {
52 struct usb_device *dev; /* USB hub device to scan */
53 struct usb_hub_device *hub; /* USB hub struct */
54 int port; /* USB port to scan */
55 struct list_head list;
58 static LIST_HEAD(usb_scan_list);
60 __weak void usb_hub_reset_devices(int port)
65 static inline bool usb_hub_is_superspeed(struct usb_device *hdev)
67 return hdev->descriptor.bDeviceProtocol == 3;
70 static int usb_get_hub_descriptor(struct usb_device *dev, void *data, int size)
72 unsigned short dtype = USB_DT_HUB;
74 if (usb_hub_is_superspeed(dev))
75 dtype = USB_DT_SS_HUB;
77 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
78 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
79 dtype << 8, 0, data, size, USB_CNTL_TIMEOUT);
82 static int usb_clear_port_feature(struct usb_device *dev, int port, int feature)
84 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
85 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature,
86 port, NULL, 0, USB_CNTL_TIMEOUT);
89 static int usb_set_port_feature(struct usb_device *dev, int port, int feature)
91 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
92 USB_REQ_SET_FEATURE, USB_RT_PORT, feature,
93 port, NULL, 0, USB_CNTL_TIMEOUT);
96 static int usb_get_hub_status(struct usb_device *dev, void *data)
98 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
99 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
100 data, sizeof(struct usb_hub_status), USB_CNTL_TIMEOUT);
103 int usb_get_port_status(struct usb_device *dev, int port, void *data)
105 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
106 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port,
107 data, sizeof(struct usb_port_status), USB_CNTL_TIMEOUT);
111 static void usb_hub_power_on(struct usb_hub_device *hub)
114 struct usb_device *dev;
115 unsigned pgood_delay = hub->desc.bPwrOn2PwrGood * 2;
120 debug("enabling power on all ports\n");
121 for (i = 0; i < dev->maxchild; i++) {
122 usb_set_port_feature(dev, i + 1, USB_PORT_FEAT_POWER);
123 debug("port %d returns %lX\n", i + 1, dev->status);
126 #ifdef CONFIG_SANDBOX
128 * Don't set timeout / delay values here. This results
129 * in these values still being reset to 0.
131 if (state_get_skip_delays())
136 * Wait for power to become stable,
137 * plus spec-defined max time for device to connect
138 * but allow this time to be increased via env variable as some
139 * devices break the spec and require longer warm-up times
141 env = getenv("usb_pgood_delay");
143 pgood_delay = max(pgood_delay,
144 (unsigned)simple_strtol(env, NULL, 0));
145 debug("pgood_delay=%dms\n", pgood_delay);
148 * Do a minimum delay of the larger value of 100ms or pgood_delay
149 * so that the power can stablize before the devices are queried
151 hub->query_delay = get_timer(0) + max(100, (int)pgood_delay);
154 * Record the power-on timeout here. The max. delay (timeout)
155 * will be done based on this value in the USB port loop in
156 * usb_hub_configure() later.
158 hub->connect_timeout = hub->query_delay + 1000;
159 debug("devnum=%d poweron: query_delay=%d connect_timeout=%d\n",
160 dev->devnum, max(100, (int)pgood_delay),
161 max(100, (int)pgood_delay) + 1000);
164 #ifndef CONFIG_DM_USB
165 static struct usb_hub_device hub_dev[USB_MAX_HUB];
166 static int usb_hub_index;
168 void usb_hub_reset(void)
172 /* Zero out global hub_dev in case its re-used again */
173 memset(hub_dev, 0, sizeof(hub_dev));
176 static struct usb_hub_device *usb_hub_allocate(void)
178 if (usb_hub_index < USB_MAX_HUB)
179 return &hub_dev[usb_hub_index++];
181 printf("ERROR: USB_MAX_HUB (%d) reached\n", USB_MAX_HUB);
188 static inline char *portspeed(int portstatus)
192 switch (portstatus & USB_PORT_STAT_SPEED_MASK) {
193 case USB_PORT_STAT_SUPER_SPEED:
194 speed_str = "5 Gb/s";
196 case USB_PORT_STAT_HIGH_SPEED:
197 speed_str = "480 Mb/s";
199 case USB_PORT_STAT_LOW_SPEED:
200 speed_str = "1.5 Mb/s";
203 speed_str = "12 Mb/s";
210 int legacy_hub_port_reset(struct usb_device *dev, int port,
211 unsigned short *portstat)
214 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
215 unsigned short portstatus, portchange;
216 int delay = HUB_SHORT_RESET_TIME; /* start with short reset delay */
219 debug("%s: resetting '%s' port %d...\n", __func__, dev->dev->name,
222 debug("%s: resetting port %d...\n", __func__, port + 1);
224 for (tries = 0; tries < MAX_TRIES; tries++) {
225 err = usb_set_port_feature(dev, port + 1, USB_PORT_FEAT_RESET);
231 if (usb_get_port_status(dev, port + 1, portsts) < 0) {
232 debug("get_port_status failed status %lX\n",
236 portstatus = le16_to_cpu(portsts->wPortStatus);
237 portchange = le16_to_cpu(portsts->wPortChange);
239 debug("portstatus %x, change %x, %s\n", portstatus, portchange,
240 portspeed(portstatus));
242 debug("STAT_C_CONNECTION = %d STAT_CONNECTION = %d" \
243 " USB_PORT_STAT_ENABLE %d\n",
244 (portchange & USB_PORT_STAT_C_CONNECTION) ? 1 : 0,
245 (portstatus & USB_PORT_STAT_CONNECTION) ? 1 : 0,
246 (portstatus & USB_PORT_STAT_ENABLE) ? 1 : 0);
249 * Perhaps we should check for the following here:
250 * - C_CONNECTION hasn't been set.
251 * - CONNECTION is still set.
253 * Doing so would ensure that the device is still connected
254 * to the bus, and hasn't been unplugged or replaced while the
255 * USB bus reset was going on.
257 * However, if we do that, then (at least) a San Disk Ultra
258 * USB 3.0 16GB device fails to reset on (at least) an NVIDIA
259 * Tegra Jetson TK1 board. For some reason, the device appears
260 * to briefly drop off the bus when this second bus reset is
261 * executed, yet if we retry this loop, it'll eventually come
262 * back after another reset or two.
265 if (portstatus & USB_PORT_STAT_ENABLE)
268 /* Switch to long reset delay for the next round */
269 delay = HUB_LONG_RESET_TIME;
272 if (tries == MAX_TRIES) {
273 debug("Cannot enable port %i after %i retries, " \
274 "disabling port.\n", port + 1, MAX_TRIES);
275 debug("Maybe the USB cable is bad?\n");
279 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_RESET);
280 *portstat = portstatus;
285 int hub_port_reset(struct udevice *dev, int port, unsigned short *portstat)
287 struct usb_device *udev = dev_get_parent_priv(dev);
289 return legacy_hub_port_reset(udev, port, portstat);
293 int usb_hub_port_connect_change(struct usb_device *dev, int port)
295 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
296 unsigned short portstatus;
300 ret = usb_get_port_status(dev, port + 1, portsts);
302 debug("get_port_status failed\n");
306 portstatus = le16_to_cpu(portsts->wPortStatus);
307 debug("portstatus %x, change %x, %s\n",
309 le16_to_cpu(portsts->wPortChange),
310 portspeed(portstatus));
312 /* Clear the connection change status */
313 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_CONNECTION);
315 /* Disconnect any existing devices under this port */
316 if (((!(portstatus & USB_PORT_STAT_CONNECTION)) &&
317 (!(portstatus & USB_PORT_STAT_ENABLE))) ||
318 usb_device_has_child_on_port(dev, port)) {
319 debug("usb_disconnect(&hub->children[port]);\n");
320 /* Return now if nothing is connected */
321 if (!(portstatus & USB_PORT_STAT_CONNECTION))
326 ret = legacy_hub_port_reset(dev, port, &portstatus);
329 printf("cannot reset port %i!?\n", port + 1);
333 switch (portstatus & USB_PORT_STAT_SPEED_MASK) {
334 case USB_PORT_STAT_SUPER_SPEED:
335 speed = USB_SPEED_SUPER;
337 case USB_PORT_STAT_HIGH_SPEED:
338 speed = USB_SPEED_HIGH;
340 case USB_PORT_STAT_LOW_SPEED:
341 speed = USB_SPEED_LOW;
344 speed = USB_SPEED_FULL;
349 struct udevice *child;
351 ret = usb_scan_device(dev->dev, port + 1, speed, &child);
353 struct usb_device *usb;
355 ret = usb_alloc_new_device(dev->controller, &usb);
357 printf("cannot create new device: ret=%d", ret);
361 dev->children[port] = usb;
364 usb->portnr = port + 1;
365 /* Run it through the hoops (find a driver, etc) */
366 ret = usb_new_device(usb);
368 /* Woops, disable the port */
369 usb_free_device(dev->controller);
370 dev->children[port] = NULL;
374 debug("hub: disabling port %d\n", port + 1);
375 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_ENABLE);
381 static int usb_scan_port(struct usb_device_scan *usb_scan)
383 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
384 unsigned short portstatus;
385 unsigned short portchange;
386 struct usb_device *dev;
387 struct usb_hub_device *hub;
396 * Don't talk to the device before the query delay is expired.
397 * This is needed for voltages to stabalize.
399 if (get_timer(0) < hub->query_delay)
402 ret = usb_get_port_status(dev, i + 1, portsts);
404 debug("get_port_status failed\n");
405 if (get_timer(0) >= hub->connect_timeout) {
406 debug("devnum=%d port=%d: timeout\n",
408 /* Remove this device from scanning list */
409 list_del(&usb_scan->list);
416 portstatus = le16_to_cpu(portsts->wPortStatus);
417 portchange = le16_to_cpu(portsts->wPortChange);
418 debug("Port %d Status %X Change %X\n", i + 1, portstatus, portchange);
421 * No connection change happened, wait a bit more.
423 * For some situation, the hub reports no connection change but a
424 * device is connected to the port (eg: CCS bit is set but CSC is not
425 * in the PORTSC register of a root hub), ignore such case.
427 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
428 !(portstatus & USB_PORT_STAT_CONNECTION)) {
429 if (get_timer(0) >= hub->connect_timeout) {
430 debug("devnum=%d port=%d: timeout\n",
432 /* Remove this device from scanning list */
433 list_del(&usb_scan->list);
440 /* A new USB device is ready at this point */
441 debug("devnum=%d port=%d: USB dev found\n", dev->devnum, i + 1);
443 usb_hub_port_connect_change(dev, i);
445 if (portchange & USB_PORT_STAT_C_ENABLE) {
446 debug("port %d enable change, status %x\n", i + 1, portstatus);
447 usb_clear_port_feature(dev, i + 1, USB_PORT_FEAT_C_ENABLE);
449 * The following hack causes a ghost device problem
452 #ifndef CONFIG_USB_EHCI_FARADAY
454 * EM interference sometimes causes bad shielded USB
455 * devices to be shutdown by the hub, this hack enables
456 * them again. Works at least with mouse driver
458 if (!(portstatus & USB_PORT_STAT_ENABLE) &&
459 (portstatus & USB_PORT_STAT_CONNECTION) &&
460 usb_device_has_child_on_port(dev, i)) {
461 debug("already running port %i disabled by hub (EMI?), re-enabling...\n",
463 usb_hub_port_connect_change(dev, i);
468 if (portstatus & USB_PORT_STAT_SUSPEND) {
469 debug("port %d suspend change\n", i + 1);
470 usb_clear_port_feature(dev, i + 1, USB_PORT_FEAT_SUSPEND);
473 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
474 debug("port %d over-current change\n", i + 1);
475 usb_clear_port_feature(dev, i + 1,
476 USB_PORT_FEAT_C_OVER_CURRENT);
477 /* Only power-on this one port */
478 usb_set_port_feature(dev, i + 1, USB_PORT_FEAT_POWER);
479 hub->overcurrent_count[i]++;
482 * If the max-scan-count is not reached, return without removing
483 * the device from scan-list. This will re-issue a new scan.
485 if (hub->overcurrent_count[i] <=
486 PORT_OVERCURRENT_MAX_SCAN_COUNT)
489 /* Otherwise the device will get removed */
490 printf("Port %d over-current occurred %d times\n", i + 1,
491 hub->overcurrent_count[i]);
494 if (portchange & USB_PORT_STAT_C_RESET) {
495 debug("port %d reset change\n", i + 1);
496 usb_clear_port_feature(dev, i + 1, USB_PORT_FEAT_C_RESET);
500 * We're done with this device, so let's remove this device from
503 list_del(&usb_scan->list);
509 static int usb_device_list_scan(void)
511 struct usb_device_scan *usb_scan;
512 struct usb_device_scan *tmp;
516 /* Only run this loop once for each controller */
523 /* We're done, once the list is empty again */
524 if (list_empty(&usb_scan_list))
527 list_for_each_entry_safe(usb_scan, tmp, &usb_scan_list, list) {
531 ret = usb_scan_port(usb_scan);
539 * This USB controller has finished scanning all its connected
540 * USB devices. Set "running" back to 0, so that other USB controllers
541 * will scan their devices too.
548 static struct usb_hub_device *usb_get_hub_device(struct usb_device *dev)
550 struct usb_hub_device *hub;
552 #ifndef CONFIG_DM_USB
553 /* "allocate" Hub device */
554 hub = usb_hub_allocate();
556 hub = dev_get_uclass_priv(dev->dev);
562 static int usb_hub_configure(struct usb_device *dev)
565 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, buffer, USB_BUFSIZ);
566 unsigned char *bitmap;
567 short hubCharacteristics;
568 struct usb_hub_descriptor *descriptor;
569 struct usb_hub_device *hub;
570 __maybe_unused struct usb_hub_status *hubsts;
573 hub = usb_get_hub_device(dev);
578 /* Get the the hub descriptor */
579 ret = usb_get_hub_descriptor(dev, buffer, 4);
581 debug("usb_hub_configure: failed to get hub " \
582 "descriptor, giving up %lX\n", dev->status);
585 descriptor = (struct usb_hub_descriptor *)buffer;
587 length = min_t(int, descriptor->bLength,
588 sizeof(struct usb_hub_descriptor));
590 ret = usb_get_hub_descriptor(dev, buffer, length);
592 debug("usb_hub_configure: failed to get hub " \
593 "descriptor 2nd giving up %lX\n", dev->status);
596 memcpy((unsigned char *)&hub->desc, buffer, length);
597 /* adjust 16bit values */
598 put_unaligned(le16_to_cpu(get_unaligned(
599 &descriptor->wHubCharacteristics)),
600 &hub->desc.wHubCharacteristics);
602 bitmap = (unsigned char *)&hub->desc.u.hs.DeviceRemovable[0];
603 /* devices not removable by default */
604 memset(bitmap, 0xff, (USB_MAXCHILDREN+1+7)/8);
605 bitmap = (unsigned char *)&hub->desc.u.hs.PortPowerCtrlMask[0];
606 memset(bitmap, 0xff, (USB_MAXCHILDREN+1+7)/8); /* PowerMask = 1B */
608 for (i = 0; i < ((hub->desc.bNbrPorts + 1 + 7)/8); i++)
609 hub->desc.u.hs.DeviceRemovable[i] =
610 descriptor->u.hs.DeviceRemovable[i];
612 for (i = 0; i < ((hub->desc.bNbrPorts + 1 + 7)/8); i++)
613 hub->desc.u.hs.PortPowerCtrlMask[i] =
614 descriptor->u.hs.PortPowerCtrlMask[i];
616 dev->maxchild = descriptor->bNbrPorts;
617 debug("%d ports detected\n", dev->maxchild);
619 hubCharacteristics = get_unaligned(&hub->desc.wHubCharacteristics);
620 switch (hubCharacteristics & HUB_CHAR_LPSM) {
622 debug("ganged power switching\n");
625 debug("individual port power switching\n");
629 debug("unknown reserved power switching mode\n");
633 if (hubCharacteristics & HUB_CHAR_COMPOUND)
634 debug("part of a compound device\n");
636 debug("standalone hub\n");
638 switch (hubCharacteristics & HUB_CHAR_OCPM) {
640 debug("global over-current protection\n");
643 debug("individual port over-current protection\n");
647 debug("no over-current protection\n");
651 debug("power on to power good time: %dms\n",
652 descriptor->bPwrOn2PwrGood * 2);
653 debug("hub controller current requirement: %dmA\n",
654 descriptor->bHubContrCurrent);
656 for (i = 0; i < dev->maxchild; i++)
657 debug("port %d is%s removable\n", i + 1,
658 hub->desc.u.hs.DeviceRemovable[(i + 1) / 8] & \
659 (1 << ((i + 1) % 8)) ? " not" : "");
661 if (sizeof(struct usb_hub_status) > USB_BUFSIZ) {
662 debug("usb_hub_configure: failed to get Status - " \
663 "too long: %d\n", descriptor->bLength);
667 ret = usb_get_hub_status(dev, buffer);
669 debug("usb_hub_configure: failed to get Status %lX\n",
675 hubsts = (struct usb_hub_status *)buffer;
678 debug("get_hub_status returned status %X, change %X\n",
679 le16_to_cpu(hubsts->wHubStatus),
680 le16_to_cpu(hubsts->wHubChange));
681 debug("local power source is %s\n",
682 (le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_LOCAL_POWER) ? \
683 "lost (inactive)" : "good");
684 debug("%sover-current condition exists\n",
685 (le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_OVERCURRENT) ? \
687 usb_hub_power_on(hub);
690 * Reset any devices that may be in a bad state when applying
691 * the power. This is a __weak function. Resetting of the devices
692 * should occur in the board file of the device.
694 for (i = 0; i < dev->maxchild; i++)
695 usb_hub_reset_devices(i + 1);
698 * Only add the connected USB devices, including potential hubs,
699 * to a scanning list. This list will get scanned and devices that
700 * are detected (either via port connected or via port timeout)
701 * will get removed from this list. Scanning of the devices on this
702 * list will continue until all devices are removed.
704 for (i = 0; i < dev->maxchild; i++) {
705 struct usb_device_scan *usb_scan;
707 usb_scan = calloc(1, sizeof(*usb_scan));
709 printf("Can't allocate memory for USB device!\n");
715 list_add_tail(&usb_scan->list, &usb_scan_list);
719 * And now call the scanning code which loops over the generated list
721 ret = usb_device_list_scan();
726 static int usb_hub_check(struct usb_device *dev, int ifnum)
728 struct usb_interface *iface;
729 struct usb_endpoint_descriptor *ep = NULL;
731 iface = &dev->config.if_desc[ifnum];
733 if (iface->desc.bInterfaceClass != USB_CLASS_HUB)
735 /* Some hubs have a subclass of 1, which AFAICT according to the */
736 /* specs is not defined, but it works */
737 if ((iface->desc.bInterfaceSubClass != 0) &&
738 (iface->desc.bInterfaceSubClass != 1))
740 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
741 if (iface->desc.bNumEndpoints != 1)
743 ep = &iface->ep_desc[0];
744 /* Output endpoint? Curiousier and curiousier.. */
745 if (!(ep->bEndpointAddress & USB_DIR_IN))
747 /* If it's not an interrupt endpoint, we'd better punt! */
748 if ((ep->bmAttributes & 3) != 3)
751 debug("USB hub found\n");
755 debug("USB hub not found: bInterfaceClass=%d, bInterfaceSubClass=%d, bNumEndpoints=%d\n",
756 iface->desc.bInterfaceClass, iface->desc.bInterfaceSubClass,
757 iface->desc.bNumEndpoints);
759 debug(" bEndpointAddress=%#x, bmAttributes=%d",
760 ep->bEndpointAddress, ep->bmAttributes);
766 int usb_hub_probe(struct usb_device *dev, int ifnum)
770 ret = usb_hub_check(dev, ifnum);
773 ret = usb_hub_configure(dev);
778 int usb_hub_scan(struct udevice *hub)
780 struct usb_device *udev = dev_get_parent_priv(hub);
782 return usb_hub_configure(udev);
785 static int usb_hub_post_probe(struct udevice *dev)
787 debug("%s\n", __func__);
788 return usb_hub_scan(dev);
791 static const struct udevice_id usb_hub_ids[] = {
792 { .compatible = "usb-hub" },
796 U_BOOT_DRIVER(usb_generic_hub) = {
798 .id = UCLASS_USB_HUB,
799 .of_match = usb_hub_ids,
800 .flags = DM_FLAG_ALLOC_PRIV_DMA,
803 UCLASS_DRIVER(usb_hub) = {
804 .id = UCLASS_USB_HUB,
806 .post_bind = dm_scan_fdt_dev,
807 .post_probe = usb_hub_post_probe,
808 .child_pre_probe = usb_child_pre_probe,
809 .per_child_auto_alloc_size = sizeof(struct usb_device),
810 .per_child_platdata_auto_alloc_size = sizeof(struct usb_dev_platdata),
811 .per_device_auto_alloc_size = sizeof(struct usb_hub_device),
814 static const struct usb_device_id hub_id_table[] = {
816 .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
817 .bDeviceClass = USB_CLASS_HUB
819 { } /* Terminating entry */
822 U_BOOT_USB_DEVICE(usb_generic_hub, hub_id_table);