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";
211 * usb_hub_port_reset() - reset a port given its usb_device pointer
213 * Reset a hub port and see if a device is present on that port, providing
214 * sufficient time for it to show itself. The port status is returned.
216 * @dev: USB device to reset
217 * @port: Port number to reset (note ports are numbered from 0 here)
218 * @portstat: Returns port status
220 static int usb_hub_port_reset(struct usb_device *dev, int port,
221 unsigned short *portstat)
224 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
225 unsigned short portstatus, portchange;
226 int delay = HUB_SHORT_RESET_TIME; /* start with short reset delay */
229 debug("%s: resetting '%s' port %d...\n", __func__, dev->dev->name,
232 debug("%s: resetting port %d...\n", __func__, port + 1);
234 for (tries = 0; tries < MAX_TRIES; tries++) {
235 err = usb_set_port_feature(dev, port + 1, USB_PORT_FEAT_RESET);
241 if (usb_get_port_status(dev, port + 1, portsts) < 0) {
242 debug("get_port_status failed status %lX\n",
246 portstatus = le16_to_cpu(portsts->wPortStatus);
247 portchange = le16_to_cpu(portsts->wPortChange);
249 debug("portstatus %x, change %x, %s\n", portstatus, portchange,
250 portspeed(portstatus));
252 debug("STAT_C_CONNECTION = %d STAT_CONNECTION = %d" \
253 " USB_PORT_STAT_ENABLE %d\n",
254 (portchange & USB_PORT_STAT_C_CONNECTION) ? 1 : 0,
255 (portstatus & USB_PORT_STAT_CONNECTION) ? 1 : 0,
256 (portstatus & USB_PORT_STAT_ENABLE) ? 1 : 0);
259 * Perhaps we should check for the following here:
260 * - C_CONNECTION hasn't been set.
261 * - CONNECTION is still set.
263 * Doing so would ensure that the device is still connected
264 * to the bus, and hasn't been unplugged or replaced while the
265 * USB bus reset was going on.
267 * However, if we do that, then (at least) a San Disk Ultra
268 * USB 3.0 16GB device fails to reset on (at least) an NVIDIA
269 * Tegra Jetson TK1 board. For some reason, the device appears
270 * to briefly drop off the bus when this second bus reset is
271 * executed, yet if we retry this loop, it'll eventually come
272 * back after another reset or two.
275 if (portstatus & USB_PORT_STAT_ENABLE)
278 /* Switch to long reset delay for the next round */
279 delay = HUB_LONG_RESET_TIME;
282 if (tries == MAX_TRIES) {
283 debug("Cannot enable port %i after %i retries, " \
284 "disabling port.\n", port + 1, MAX_TRIES);
285 debug("Maybe the USB cable is bad?\n");
289 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_RESET);
290 *portstat = portstatus;
294 int usb_hub_port_connect_change(struct usb_device *dev, int port)
296 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
297 unsigned short portstatus;
301 ret = usb_get_port_status(dev, port + 1, portsts);
303 debug("get_port_status failed\n");
307 portstatus = le16_to_cpu(portsts->wPortStatus);
308 debug("portstatus %x, change %x, %s\n",
310 le16_to_cpu(portsts->wPortChange),
311 portspeed(portstatus));
313 /* Clear the connection change status */
314 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_CONNECTION);
316 /* Disconnect any existing devices under this port */
317 if (((!(portstatus & USB_PORT_STAT_CONNECTION)) &&
318 (!(portstatus & USB_PORT_STAT_ENABLE))) ||
319 usb_device_has_child_on_port(dev, port)) {
320 debug("usb_disconnect(&hub->children[port]);\n");
321 /* Return now if nothing is connected */
322 if (!(portstatus & USB_PORT_STAT_CONNECTION))
327 ret = usb_hub_port_reset(dev, port, &portstatus);
330 printf("cannot reset port %i!?\n", port + 1);
334 switch (portstatus & USB_PORT_STAT_SPEED_MASK) {
335 case USB_PORT_STAT_SUPER_SPEED:
336 speed = USB_SPEED_SUPER;
338 case USB_PORT_STAT_HIGH_SPEED:
339 speed = USB_SPEED_HIGH;
341 case USB_PORT_STAT_LOW_SPEED:
342 speed = USB_SPEED_LOW;
345 speed = USB_SPEED_FULL;
350 struct udevice *child;
352 ret = usb_scan_device(dev->dev, port + 1, speed, &child);
354 struct usb_device *usb;
356 ret = usb_alloc_new_device(dev->controller, &usb);
358 printf("cannot create new device: ret=%d", ret);
362 dev->children[port] = usb;
365 usb->portnr = port + 1;
366 /* Run it through the hoops (find a driver, etc) */
367 ret = usb_new_device(usb);
369 /* Woops, disable the port */
370 usb_free_device(dev->controller);
371 dev->children[port] = NULL;
375 debug("hub: disabling port %d\n", port + 1);
376 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_ENABLE);
382 static int usb_scan_port(struct usb_device_scan *usb_scan)
384 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
385 unsigned short portstatus;
386 unsigned short portchange;
387 struct usb_device *dev;
388 struct usb_hub_device *hub;
397 * Don't talk to the device before the query delay is expired.
398 * This is needed for voltages to stabalize.
400 if (get_timer(0) < hub->query_delay)
403 ret = usb_get_port_status(dev, i + 1, portsts);
405 debug("get_port_status failed\n");
406 if (get_timer(0) >= hub->connect_timeout) {
407 debug("devnum=%d port=%d: timeout\n",
409 /* Remove this device from scanning list */
410 list_del(&usb_scan->list);
417 portstatus = le16_to_cpu(portsts->wPortStatus);
418 portchange = le16_to_cpu(portsts->wPortChange);
419 debug("Port %d Status %X Change %X\n", i + 1, portstatus, portchange);
422 * No connection change happened, wait a bit more.
424 * For some situation, the hub reports no connection change but a
425 * device is connected to the port (eg: CCS bit is set but CSC is not
426 * in the PORTSC register of a root hub), ignore such case.
428 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
429 !(portstatus & USB_PORT_STAT_CONNECTION)) {
430 if (get_timer(0) >= hub->connect_timeout) {
431 debug("devnum=%d port=%d: timeout\n",
433 /* Remove this device from scanning list */
434 list_del(&usb_scan->list);
441 /* A new USB device is ready at this point */
442 debug("devnum=%d port=%d: USB dev found\n", dev->devnum, i + 1);
444 usb_hub_port_connect_change(dev, i);
446 if (portchange & USB_PORT_STAT_C_ENABLE) {
447 debug("port %d enable change, status %x\n", i + 1, portstatus);
448 usb_clear_port_feature(dev, i + 1, USB_PORT_FEAT_C_ENABLE);
450 * The following hack causes a ghost device problem
453 #ifndef CONFIG_USB_EHCI_FARADAY
455 * EM interference sometimes causes bad shielded USB
456 * devices to be shutdown by the hub, this hack enables
457 * them again. Works at least with mouse driver
459 if (!(portstatus & USB_PORT_STAT_ENABLE) &&
460 (portstatus & USB_PORT_STAT_CONNECTION) &&
461 usb_device_has_child_on_port(dev, i)) {
462 debug("already running port %i disabled by hub (EMI?), re-enabling...\n",
464 usb_hub_port_connect_change(dev, i);
469 if (portstatus & USB_PORT_STAT_SUSPEND) {
470 debug("port %d suspend change\n", i + 1);
471 usb_clear_port_feature(dev, i + 1, USB_PORT_FEAT_SUSPEND);
474 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
475 debug("port %d over-current change\n", i + 1);
476 usb_clear_port_feature(dev, i + 1,
477 USB_PORT_FEAT_C_OVER_CURRENT);
478 /* Only power-on this one port */
479 usb_set_port_feature(dev, i + 1, USB_PORT_FEAT_POWER);
480 hub->overcurrent_count[i]++;
483 * If the max-scan-count is not reached, return without removing
484 * the device from scan-list. This will re-issue a new scan.
486 if (hub->overcurrent_count[i] <=
487 PORT_OVERCURRENT_MAX_SCAN_COUNT)
490 /* Otherwise the device will get removed */
491 printf("Port %d over-current occurred %d times\n", i + 1,
492 hub->overcurrent_count[i]);
495 if (portchange & USB_PORT_STAT_C_RESET) {
496 debug("port %d reset change\n", i + 1);
497 usb_clear_port_feature(dev, i + 1, USB_PORT_FEAT_C_RESET);
501 * We're done with this device, so let's remove this device from
504 list_del(&usb_scan->list);
510 static int usb_device_list_scan(void)
512 struct usb_device_scan *usb_scan;
513 struct usb_device_scan *tmp;
517 /* Only run this loop once for each controller */
524 /* We're done, once the list is empty again */
525 if (list_empty(&usb_scan_list))
528 list_for_each_entry_safe(usb_scan, tmp, &usb_scan_list, list) {
532 ret = usb_scan_port(usb_scan);
540 * This USB controller has finished scanning all its connected
541 * USB devices. Set "running" back to 0, so that other USB controllers
542 * will scan their devices too.
549 static struct usb_hub_device *usb_get_hub_device(struct usb_device *dev)
551 struct usb_hub_device *hub;
553 #ifndef CONFIG_DM_USB
554 /* "allocate" Hub device */
555 hub = usb_hub_allocate();
557 hub = dev_get_uclass_priv(dev->dev);
563 static int usb_hub_configure(struct usb_device *dev)
566 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, buffer, USB_BUFSIZ);
567 unsigned char *bitmap;
568 short hubCharacteristics;
569 struct usb_hub_descriptor *descriptor;
570 struct usb_hub_device *hub;
571 __maybe_unused struct usb_hub_status *hubsts;
574 hub = usb_get_hub_device(dev);
579 /* Get the the hub descriptor */
580 ret = usb_get_hub_descriptor(dev, buffer, 4);
582 debug("usb_hub_configure: failed to get hub " \
583 "descriptor, giving up %lX\n", dev->status);
586 descriptor = (struct usb_hub_descriptor *)buffer;
588 length = min_t(int, descriptor->bLength,
589 sizeof(struct usb_hub_descriptor));
591 ret = usb_get_hub_descriptor(dev, buffer, length);
593 debug("usb_hub_configure: failed to get hub " \
594 "descriptor 2nd giving up %lX\n", dev->status);
597 memcpy((unsigned char *)&hub->desc, buffer, length);
598 /* adjust 16bit values */
599 put_unaligned(le16_to_cpu(get_unaligned(
600 &descriptor->wHubCharacteristics)),
601 &hub->desc.wHubCharacteristics);
603 bitmap = (unsigned char *)&hub->desc.u.hs.DeviceRemovable[0];
604 /* devices not removable by default */
605 memset(bitmap, 0xff, (USB_MAXCHILDREN+1+7)/8);
606 bitmap = (unsigned char *)&hub->desc.u.hs.PortPowerCtrlMask[0];
607 memset(bitmap, 0xff, (USB_MAXCHILDREN+1+7)/8); /* PowerMask = 1B */
609 for (i = 0; i < ((hub->desc.bNbrPorts + 1 + 7)/8); i++)
610 hub->desc.u.hs.DeviceRemovable[i] =
611 descriptor->u.hs.DeviceRemovable[i];
613 for (i = 0; i < ((hub->desc.bNbrPorts + 1 + 7)/8); i++)
614 hub->desc.u.hs.PortPowerCtrlMask[i] =
615 descriptor->u.hs.PortPowerCtrlMask[i];
617 dev->maxchild = descriptor->bNbrPorts;
618 debug("%d ports detected\n", dev->maxchild);
620 hubCharacteristics = get_unaligned(&hub->desc.wHubCharacteristics);
621 switch (hubCharacteristics & HUB_CHAR_LPSM) {
623 debug("ganged power switching\n");
626 debug("individual port power switching\n");
630 debug("unknown reserved power switching mode\n");
634 if (hubCharacteristics & HUB_CHAR_COMPOUND)
635 debug("part of a compound device\n");
637 debug("standalone hub\n");
639 switch (hubCharacteristics & HUB_CHAR_OCPM) {
641 debug("global over-current protection\n");
644 debug("individual port over-current protection\n");
648 debug("no over-current protection\n");
652 debug("power on to power good time: %dms\n",
653 descriptor->bPwrOn2PwrGood * 2);
654 debug("hub controller current requirement: %dmA\n",
655 descriptor->bHubContrCurrent);
657 for (i = 0; i < dev->maxchild; i++)
658 debug("port %d is%s removable\n", i + 1,
659 hub->desc.u.hs.DeviceRemovable[(i + 1) / 8] & \
660 (1 << ((i + 1) % 8)) ? " not" : "");
662 if (sizeof(struct usb_hub_status) > USB_BUFSIZ) {
663 debug("usb_hub_configure: failed to get Status - " \
664 "too long: %d\n", descriptor->bLength);
668 ret = usb_get_hub_status(dev, buffer);
670 debug("usb_hub_configure: failed to get Status %lX\n",
676 hubsts = (struct usb_hub_status *)buffer;
679 debug("get_hub_status returned status %X, change %X\n",
680 le16_to_cpu(hubsts->wHubStatus),
681 le16_to_cpu(hubsts->wHubChange));
682 debug("local power source is %s\n",
683 (le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_LOCAL_POWER) ? \
684 "lost (inactive)" : "good");
685 debug("%sover-current condition exists\n",
686 (le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_OVERCURRENT) ? \
688 usb_hub_power_on(hub);
691 * Reset any devices that may be in a bad state when applying
692 * the power. This is a __weak function. Resetting of the devices
693 * should occur in the board file of the device.
695 for (i = 0; i < dev->maxchild; i++)
696 usb_hub_reset_devices(i + 1);
699 * Only add the connected USB devices, including potential hubs,
700 * to a scanning list. This list will get scanned and devices that
701 * are detected (either via port connected or via port timeout)
702 * will get removed from this list. Scanning of the devices on this
703 * list will continue until all devices are removed.
705 for (i = 0; i < dev->maxchild; i++) {
706 struct usb_device_scan *usb_scan;
708 usb_scan = calloc(1, sizeof(*usb_scan));
710 printf("Can't allocate memory for USB device!\n");
716 list_add_tail(&usb_scan->list, &usb_scan_list);
720 * And now call the scanning code which loops over the generated list
722 ret = usb_device_list_scan();
727 static int usb_hub_check(struct usb_device *dev, int ifnum)
729 struct usb_interface *iface;
730 struct usb_endpoint_descriptor *ep = NULL;
732 iface = &dev->config.if_desc[ifnum];
734 if (iface->desc.bInterfaceClass != USB_CLASS_HUB)
736 /* Some hubs have a subclass of 1, which AFAICT according to the */
737 /* specs is not defined, but it works */
738 if ((iface->desc.bInterfaceSubClass != 0) &&
739 (iface->desc.bInterfaceSubClass != 1))
741 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
742 if (iface->desc.bNumEndpoints != 1)
744 ep = &iface->ep_desc[0];
745 /* Output endpoint? Curiousier and curiousier.. */
746 if (!(ep->bEndpointAddress & USB_DIR_IN))
748 /* If it's not an interrupt endpoint, we'd better punt! */
749 if ((ep->bmAttributes & 3) != 3)
752 debug("USB hub found\n");
756 debug("USB hub not found: bInterfaceClass=%d, bInterfaceSubClass=%d, bNumEndpoints=%d\n",
757 iface->desc.bInterfaceClass, iface->desc.bInterfaceSubClass,
758 iface->desc.bNumEndpoints);
760 debug(" bEndpointAddress=%#x, bmAttributes=%d",
761 ep->bEndpointAddress, ep->bmAttributes);
767 int usb_hub_probe(struct usb_device *dev, int ifnum)
771 ret = usb_hub_check(dev, ifnum);
774 ret = usb_hub_configure(dev);
779 int usb_hub_scan(struct udevice *hub)
781 struct usb_device *udev = dev_get_parent_priv(hub);
783 return usb_hub_configure(udev);
786 static int usb_hub_post_probe(struct udevice *dev)
788 debug("%s\n", __func__);
789 return usb_hub_scan(dev);
792 static const struct udevice_id usb_hub_ids[] = {
793 { .compatible = "usb-hub" },
797 U_BOOT_DRIVER(usb_generic_hub) = {
799 .id = UCLASS_USB_HUB,
800 .of_match = usb_hub_ids,
801 .flags = DM_FLAG_ALLOC_PRIV_DMA,
804 UCLASS_DRIVER(usb_hub) = {
805 .id = UCLASS_USB_HUB,
807 .post_bind = dm_scan_fdt_dev,
808 .post_probe = usb_hub_post_probe,
809 .child_pre_probe = usb_child_pre_probe,
810 .per_child_auto_alloc_size = sizeof(struct usb_device),
811 .per_child_platdata_auto_alloc_size = sizeof(struct usb_dev_platdata),
812 .per_device_auto_alloc_size = sizeof(struct usb_hub_device),
815 static const struct usb_device_id hub_id_table[] = {
817 .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
818 .bDeviceClass = USB_CLASS_HUB
820 { } /* Terminating entry */
823 U_BOOT_USB_DEVICE(usb_generic_hub, hub_id_table);