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 <asm/byteorder.h>
35 #include <asm/state.h>
37 #include <asm/unaligned.h>
40 DECLARE_GLOBAL_DATA_PTR;
44 #include <asm/4xx_pci.h>
47 #define USB_BUFSIZ 512
49 /* TODO(sjg@chromium.org): Remove this when CONFIG_DM_USB is defined */
50 static struct usb_hub_device hub_dev[USB_MAX_HUB];
51 static int usb_hub_index;
53 __weak void usb_hub_reset_devices(int port)
58 static int usb_get_hub_descriptor(struct usb_device *dev, void *data, int size)
60 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
61 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
62 USB_DT_HUB << 8, 0, data, size, USB_CNTL_TIMEOUT);
65 static int usb_clear_port_feature(struct usb_device *dev, int port, int feature)
67 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
68 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature,
69 port, NULL, 0, USB_CNTL_TIMEOUT);
72 static int usb_set_port_feature(struct usb_device *dev, int port, int feature)
74 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
75 USB_REQ_SET_FEATURE, USB_RT_PORT, feature,
76 port, NULL, 0, USB_CNTL_TIMEOUT);
79 static int usb_get_hub_status(struct usb_device *dev, void *data)
81 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
82 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
83 data, sizeof(struct usb_hub_status), USB_CNTL_TIMEOUT);
86 int usb_get_port_status(struct usb_device *dev, int port, void *data)
88 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
89 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port,
90 data, sizeof(struct usb_hub_status), USB_CNTL_TIMEOUT);
94 static void usb_hub_power_on(struct usb_hub_device *hub)
97 struct usb_device *dev;
98 unsigned pgood_delay = hub->desc.bPwrOn2PwrGood * 2;
103 debug("enabling power on all ports\n");
104 for (i = 0; i < dev->maxchild; i++) {
105 usb_set_port_feature(dev, i + 1, USB_PORT_FEAT_POWER);
106 debug("port %d returns %lX\n", i + 1, dev->status);
110 * Wait for power to become stable,
111 * plus spec-defined max time for device to connect
112 * but allow this time to be increased via env variable as some
113 * devices break the spec and require longer warm-up times
115 env = getenv("usb_pgood_delay");
117 pgood_delay = max(pgood_delay,
118 (unsigned)simple_strtol(env, NULL, 0));
119 debug("pgood_delay=%dms\n", pgood_delay);
120 mdelay(pgood_delay + 1000);
123 void usb_hub_reset(void)
128 static struct usb_hub_device *usb_hub_allocate(void)
130 if (usb_hub_index < USB_MAX_HUB)
131 return &hub_dev[usb_hub_index++];
133 printf("ERROR: USB_MAX_HUB (%d) reached\n", USB_MAX_HUB);
139 static inline char *portspeed(int portstatus)
143 switch (portstatus & USB_PORT_STAT_SPEED_MASK) {
144 case USB_PORT_STAT_SUPER_SPEED:
145 speed_str = "5 Gb/s";
147 case USB_PORT_STAT_HIGH_SPEED:
148 speed_str = "480 Mb/s";
150 case USB_PORT_STAT_LOW_SPEED:
151 speed_str = "1.5 Mb/s";
154 speed_str = "12 Mb/s";
161 int legacy_hub_port_reset(struct usb_device *dev, int port,
162 unsigned short *portstat)
165 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
166 unsigned short portstatus, portchange;
169 debug("%s: resetting '%s' port %d...\n", __func__, dev->dev->name,
172 debug("%s: resetting port %d...\n", __func__, port + 1);
174 for (tries = 0; tries < MAX_TRIES; tries++) {
175 err = usb_set_port_feature(dev, port + 1, USB_PORT_FEAT_RESET);
181 if (usb_get_port_status(dev, port + 1, portsts) < 0) {
182 debug("get_port_status failed status %lX\n",
186 portstatus = le16_to_cpu(portsts->wPortStatus);
187 portchange = le16_to_cpu(portsts->wPortChange);
189 debug("portstatus %x, change %x, %s\n", portstatus, portchange,
190 portspeed(portstatus));
192 debug("STAT_C_CONNECTION = %d STAT_CONNECTION = %d" \
193 " USB_PORT_STAT_ENABLE %d\n",
194 (portchange & USB_PORT_STAT_C_CONNECTION) ? 1 : 0,
195 (portstatus & USB_PORT_STAT_CONNECTION) ? 1 : 0,
196 (portstatus & USB_PORT_STAT_ENABLE) ? 1 : 0);
199 * Perhaps we should check for the following here:
200 * - C_CONNECTION hasn't been set.
201 * - CONNECTION is still set.
203 * Doing so would ensure that the device is still connected
204 * to the bus, and hasn't been unplugged or replaced while the
205 * USB bus reset was going on.
207 * However, if we do that, then (at least) a San Disk Ultra
208 * USB 3.0 16GB device fails to reset on (at least) an NVIDIA
209 * Tegra Jetson TK1 board. For some reason, the device appears
210 * to briefly drop off the bus when this second bus reset is
211 * executed, yet if we retry this loop, it'll eventually come
212 * back after another reset or two.
215 if (portstatus & USB_PORT_STAT_ENABLE)
221 if (tries == MAX_TRIES) {
222 debug("Cannot enable port %i after %i retries, " \
223 "disabling port.\n", port + 1, MAX_TRIES);
224 debug("Maybe the USB cable is bad?\n");
228 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_RESET);
229 *portstat = portstatus;
234 int hub_port_reset(struct udevice *dev, int port, unsigned short *portstat)
236 struct usb_device *udev = dev_get_parent_priv(dev);
238 return legacy_hub_port_reset(udev, port, portstat);
242 int usb_hub_port_connect_change(struct usb_device *dev, int port)
244 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
245 unsigned short portstatus;
249 ret = usb_get_port_status(dev, port + 1, portsts);
251 debug("get_port_status failed\n");
255 portstatus = le16_to_cpu(portsts->wPortStatus);
256 debug("portstatus %x, change %x, %s\n",
258 le16_to_cpu(portsts->wPortChange),
259 portspeed(portstatus));
261 /* Clear the connection change status */
262 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_CONNECTION);
264 /* Disconnect any existing devices under this port */
265 if (((!(portstatus & USB_PORT_STAT_CONNECTION)) &&
266 (!(portstatus & USB_PORT_STAT_ENABLE))) ||
267 usb_device_has_child_on_port(dev, port)) {
268 debug("usb_disconnect(&hub->children[port]);\n");
269 /* Return now if nothing is connected */
270 if (!(portstatus & USB_PORT_STAT_CONNECTION))
276 ret = legacy_hub_port_reset(dev, port, &portstatus);
279 printf("cannot reset port %i!?\n", port + 1);
285 switch (portstatus & USB_PORT_STAT_SPEED_MASK) {
286 case USB_PORT_STAT_SUPER_SPEED:
287 speed = USB_SPEED_SUPER;
289 case USB_PORT_STAT_HIGH_SPEED:
290 speed = USB_SPEED_HIGH;
292 case USB_PORT_STAT_LOW_SPEED:
293 speed = USB_SPEED_LOW;
296 speed = USB_SPEED_FULL;
301 struct udevice *child;
303 ret = usb_scan_device(dev->dev, port + 1, speed, &child);
305 struct usb_device *usb;
307 ret = usb_alloc_new_device(dev->controller, &usb);
309 printf("cannot create new device: ret=%d", ret);
313 dev->children[port] = usb;
316 usb->portnr = port + 1;
317 /* Run it through the hoops (find a driver, etc) */
318 ret = usb_new_device(usb);
320 /* Woops, disable the port */
321 usb_free_device(dev->controller);
322 dev->children[port] = NULL;
326 debug("hub: disabling port %d\n", port + 1);
327 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_ENABLE);
334 static int usb_hub_configure(struct usb_device *dev)
337 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, buffer, USB_BUFSIZ);
338 unsigned char *bitmap;
339 short hubCharacteristics;
340 struct usb_hub_descriptor *descriptor;
341 struct usb_hub_device *hub;
342 __maybe_unused struct usb_hub_status *hubsts;
345 /* "allocate" Hub device */
346 hub = usb_hub_allocate();
350 /* Get the the hub descriptor */
351 ret = usb_get_hub_descriptor(dev, buffer, 4);
353 debug("usb_hub_configure: failed to get hub " \
354 "descriptor, giving up %lX\n", dev->status);
357 descriptor = (struct usb_hub_descriptor *)buffer;
359 length = min_t(int, descriptor->bLength,
360 sizeof(struct usb_hub_descriptor));
362 ret = usb_get_hub_descriptor(dev, buffer, length);
364 debug("usb_hub_configure: failed to get hub " \
365 "descriptor 2nd giving up %lX\n", dev->status);
368 memcpy((unsigned char *)&hub->desc, buffer, length);
369 /* adjust 16bit values */
370 put_unaligned(le16_to_cpu(get_unaligned(
371 &descriptor->wHubCharacteristics)),
372 &hub->desc.wHubCharacteristics);
374 bitmap = (unsigned char *)&hub->desc.DeviceRemovable[0];
375 /* devices not removable by default */
376 memset(bitmap, 0xff, (USB_MAXCHILDREN+1+7)/8);
377 bitmap = (unsigned char *)&hub->desc.PortPowerCtrlMask[0];
378 memset(bitmap, 0xff, (USB_MAXCHILDREN+1+7)/8); /* PowerMask = 1B */
380 for (i = 0; i < ((hub->desc.bNbrPorts + 1 + 7)/8); i++)
381 hub->desc.DeviceRemovable[i] = descriptor->DeviceRemovable[i];
383 for (i = 0; i < ((hub->desc.bNbrPorts + 1 + 7)/8); i++)
384 hub->desc.PortPowerCtrlMask[i] = descriptor->PortPowerCtrlMask[i];
386 dev->maxchild = descriptor->bNbrPorts;
387 debug("%d ports detected\n", dev->maxchild);
389 hubCharacteristics = get_unaligned(&hub->desc.wHubCharacteristics);
390 switch (hubCharacteristics & HUB_CHAR_LPSM) {
392 debug("ganged power switching\n");
395 debug("individual port power switching\n");
399 debug("unknown reserved power switching mode\n");
403 if (hubCharacteristics & HUB_CHAR_COMPOUND)
404 debug("part of a compound device\n");
406 debug("standalone hub\n");
408 switch (hubCharacteristics & HUB_CHAR_OCPM) {
410 debug("global over-current protection\n");
413 debug("individual port over-current protection\n");
417 debug("no over-current protection\n");
421 debug("power on to power good time: %dms\n",
422 descriptor->bPwrOn2PwrGood * 2);
423 debug("hub controller current requirement: %dmA\n",
424 descriptor->bHubContrCurrent);
426 for (i = 0; i < dev->maxchild; i++)
427 debug("port %d is%s removable\n", i + 1,
428 hub->desc.DeviceRemovable[(i + 1) / 8] & \
429 (1 << ((i + 1) % 8)) ? " not" : "");
431 if (sizeof(struct usb_hub_status) > USB_BUFSIZ) {
432 debug("usb_hub_configure: failed to get Status - " \
433 "too long: %d\n", descriptor->bLength);
437 ret = usb_get_hub_status(dev, buffer);
439 debug("usb_hub_configure: failed to get Status %lX\n",
445 hubsts = (struct usb_hub_status *)buffer;
448 debug("get_hub_status returned status %X, change %X\n",
449 le16_to_cpu(hubsts->wHubStatus),
450 le16_to_cpu(hubsts->wHubChange));
451 debug("local power source is %s\n",
452 (le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_LOCAL_POWER) ? \
453 "lost (inactive)" : "good");
454 debug("%sover-current condition exists\n",
455 (le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_OVERCURRENT) ? \
457 usb_hub_power_on(hub);
460 * Reset any devices that may be in a bad state when applying
461 * the power. This is a __weak function. Resetting of the devices
462 * should occur in the board file of the device.
464 for (i = 0; i < dev->maxchild; i++)
465 usb_hub_reset_devices(i + 1);
467 for (i = 0; i < dev->maxchild; i++) {
468 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
469 unsigned short portstatus, portchange;
471 ulong start = get_timer(0);
472 uint delay = CONFIG_SYS_HZ;
474 #ifdef CONFIG_SANDBOX
475 if (state_get_skip_delays())
479 debug("\n\nScanning '%s' port %d\n", dev->dev->name, i + 1);
481 debug("\n\nScanning port %d\n", i + 1);
484 * Wait for (whichever finishes first)
485 * - A maximum of 10 seconds
486 * This is a purely observational value driven by connecting
487 * a few broken pen drives and taking the max * 1.5 approach
488 * - connection_change and connection state to report same
492 ret = usb_get_port_status(dev, i + 1, portsts);
494 debug("get_port_status failed\n");
498 portstatus = le16_to_cpu(portsts->wPortStatus);
499 portchange = le16_to_cpu(portsts->wPortChange);
501 /* No connection change happened, wait a bit more. */
502 if (!(portchange & USB_PORT_STAT_C_CONNECTION))
505 /* Test if the connection came up, and if so, exit. */
506 if (portstatus & USB_PORT_STAT_CONNECTION)
509 } while (get_timer(start) < delay);
514 debug("Port %d Status %X Change %X\n",
515 i + 1, portstatus, portchange);
517 if (portchange & USB_PORT_STAT_C_CONNECTION) {
518 debug("port %d connection change\n", i + 1);
519 usb_hub_port_connect_change(dev, i);
521 if (portchange & USB_PORT_STAT_C_ENABLE) {
522 debug("port %d enable change, status %x\n",
524 usb_clear_port_feature(dev, i + 1,
525 USB_PORT_FEAT_C_ENABLE);
527 * The following hack causes a ghost device problem
530 #ifndef CONFIG_USB_EHCI_FARADAY
531 /* EM interference sometimes causes bad shielded USB
532 * devices to be shutdown by the hub, this hack enables
533 * them again. Works at least with mouse driver */
534 if (!(portstatus & USB_PORT_STAT_ENABLE) &&
535 (portstatus & USB_PORT_STAT_CONNECTION) &&
536 usb_device_has_child_on_port(dev, i)) {
537 debug("already running port %i " \
538 "disabled by hub (EMI?), " \
539 "re-enabling...\n", i + 1);
540 usb_hub_port_connect_change(dev, i);
544 if (portstatus & USB_PORT_STAT_SUSPEND) {
545 debug("port %d suspend change\n", i + 1);
546 usb_clear_port_feature(dev, i + 1,
547 USB_PORT_FEAT_SUSPEND);
550 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
551 debug("port %d over-current change\n", i + 1);
552 usb_clear_port_feature(dev, i + 1,
553 USB_PORT_FEAT_C_OVER_CURRENT);
554 usb_hub_power_on(hub);
557 if (portchange & USB_PORT_STAT_C_RESET) {
558 debug("port %d reset change\n", i + 1);
559 usb_clear_port_feature(dev, i + 1,
560 USB_PORT_FEAT_C_RESET);
562 } /* end for i all ports */
567 static int usb_hub_check(struct usb_device *dev, int ifnum)
569 struct usb_interface *iface;
570 struct usb_endpoint_descriptor *ep = NULL;
572 iface = &dev->config.if_desc[ifnum];
574 if (iface->desc.bInterfaceClass != USB_CLASS_HUB)
576 /* Some hubs have a subclass of 1, which AFAICT according to the */
577 /* specs is not defined, but it works */
578 if ((iface->desc.bInterfaceSubClass != 0) &&
579 (iface->desc.bInterfaceSubClass != 1))
581 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
582 if (iface->desc.bNumEndpoints != 1)
584 ep = &iface->ep_desc[0];
585 /* Output endpoint? Curiousier and curiousier.. */
586 if (!(ep->bEndpointAddress & USB_DIR_IN))
588 /* If it's not an interrupt endpoint, we'd better punt! */
589 if ((ep->bmAttributes & 3) != 3)
592 debug("USB hub found\n");
596 debug("USB hub not found: bInterfaceClass=%d, bInterfaceSubClass=%d, bNumEndpoints=%d\n",
597 iface->desc.bInterfaceClass, iface->desc.bInterfaceSubClass,
598 iface->desc.bNumEndpoints);
600 debug(" bEndpointAddress=%#x, bmAttributes=%d",
601 ep->bEndpointAddress, ep->bmAttributes);
607 int usb_hub_probe(struct usb_device *dev, int ifnum)
611 ret = usb_hub_check(dev, ifnum);
614 ret = usb_hub_configure(dev);
619 int usb_hub_scan(struct udevice *hub)
621 struct usb_device *udev = dev_get_parent_priv(hub);
623 return usb_hub_configure(udev);
626 static int usb_hub_post_bind(struct udevice *dev)
628 /* Scan the bus for devices */
629 return dm_scan_fdt_node(dev, gd->fdt_blob, dev->of_offset, false);
632 static int usb_hub_post_probe(struct udevice *dev)
634 debug("%s\n", __func__);
635 return usb_hub_scan(dev);
638 static const struct udevice_id usb_hub_ids[] = {
639 { .compatible = "usb-hub" },
643 U_BOOT_DRIVER(usb_generic_hub) = {
645 .id = UCLASS_USB_HUB,
646 .of_match = usb_hub_ids,
647 .flags = DM_FLAG_ALLOC_PRIV_DMA,
650 UCLASS_DRIVER(usb_hub) = {
651 .id = UCLASS_USB_HUB,
653 .post_bind = usb_hub_post_bind,
654 .post_probe = usb_hub_post_probe,
655 .child_pre_probe = usb_child_pre_probe,
656 .per_child_auto_alloc_size = sizeof(struct usb_device),
657 .per_child_platdata_auto_alloc_size = sizeof(struct usb_dev_platdata),
660 static const struct usb_device_id hub_id_table[] = {
662 .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
663 .bDeviceClass = USB_CLASS_HUB
665 { } /* Terminating entry */
668 U_BOOT_USB_DEVICE(usb_generic_hub, hub_id_table);