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
29 #include <asm/processor.h>
30 #include <asm/unaligned.h>
31 #include <linux/ctype.h>
32 #include <asm/byteorder.h>
33 #include <asm/unaligned.h>
36 DECLARE_GLOBAL_DATA_PTR;
40 #include <asm/4xx_pci.h>
43 #define USB_BUFSIZ 512
45 /* TODO(sjg@chromium.org): Remove this when CONFIG_DM_USB is defined */
46 static struct usb_hub_device hub_dev[USB_MAX_HUB];
47 static int usb_hub_index;
49 __weak void usb_hub_reset_devices(int port)
54 static int usb_get_hub_descriptor(struct usb_device *dev, void *data, int size)
56 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
57 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
58 USB_DT_HUB << 8, 0, data, size, USB_CNTL_TIMEOUT);
61 static int usb_clear_port_feature(struct usb_device *dev, int port, int feature)
63 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
64 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature,
65 port, NULL, 0, USB_CNTL_TIMEOUT);
68 static int usb_set_port_feature(struct usb_device *dev, int port, int feature)
70 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
71 USB_REQ_SET_FEATURE, USB_RT_PORT, feature,
72 port, NULL, 0, USB_CNTL_TIMEOUT);
75 static int usb_get_hub_status(struct usb_device *dev, void *data)
77 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
78 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
79 data, sizeof(struct usb_hub_status), USB_CNTL_TIMEOUT);
82 static int usb_get_port_status(struct usb_device *dev, int port, void *data)
84 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
85 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port,
86 data, sizeof(struct usb_hub_status), USB_CNTL_TIMEOUT);
90 static void usb_hub_power_on(struct usb_hub_device *hub)
93 struct usb_device *dev;
94 unsigned pgood_delay = hub->desc.bPwrOn2PwrGood * 2;
99 debug("enabling power on all ports\n");
100 for (i = 0; i < dev->maxchild; i++) {
101 usb_set_port_feature(dev, i + 1, USB_PORT_FEAT_POWER);
102 debug("port %d returns %lX\n", i + 1, dev->status);
106 * Wait for power to become stable,
107 * plus spec-defined max time for device to connect
108 * but allow this time to be increased via env variable as some
109 * devices break the spec and require longer warm-up times
111 env = getenv("usb_pgood_delay");
113 pgood_delay = max(pgood_delay,
114 (unsigned)simple_strtol(env, NULL, 0));
115 debug("pgood_delay=%dms\n", pgood_delay);
116 mdelay(pgood_delay + 1000);
119 void usb_hub_reset(void)
124 static struct usb_hub_device *usb_hub_allocate(void)
126 if (usb_hub_index < USB_MAX_HUB)
127 return &hub_dev[usb_hub_index++];
129 printf("ERROR: USB_MAX_HUB (%d) reached\n", USB_MAX_HUB);
135 static inline char *portspeed(int portstatus)
139 switch (portstatus & USB_PORT_STAT_SPEED_MASK) {
140 case USB_PORT_STAT_SUPER_SPEED:
141 speed_str = "5 Gb/s";
143 case USB_PORT_STAT_HIGH_SPEED:
144 speed_str = "480 Mb/s";
146 case USB_PORT_STAT_LOW_SPEED:
147 speed_str = "1.5 Mb/s";
150 speed_str = "12 Mb/s";
157 int legacy_hub_port_reset(struct usb_device *dev, int port,
158 unsigned short *portstat)
161 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
162 unsigned short portstatus, portchange;
165 debug("%s: resetting '%s' port %d...\n", __func__, dev->dev->name,
168 debug("%s: resetting port %d...\n", __func__, port + 1);
170 for (tries = 0; tries < MAX_TRIES; tries++) {
172 usb_set_port_feature(dev, port + 1, USB_PORT_FEAT_RESET);
175 if (usb_get_port_status(dev, port + 1, portsts) < 0) {
176 debug("get_port_status failed status %lX\n",
180 portstatus = le16_to_cpu(portsts->wPortStatus);
181 portchange = le16_to_cpu(portsts->wPortChange);
183 debug("portstatus %x, change %x, %s\n", portstatus, portchange,
184 portspeed(portstatus));
186 debug("STAT_C_CONNECTION = %d STAT_CONNECTION = %d" \
187 " USB_PORT_STAT_ENABLE %d\n",
188 (portchange & USB_PORT_STAT_C_CONNECTION) ? 1 : 0,
189 (portstatus & USB_PORT_STAT_CONNECTION) ? 1 : 0,
190 (portstatus & USB_PORT_STAT_ENABLE) ? 1 : 0);
193 * Perhaps we should check for the following here:
194 * - C_CONNECTION hasn't been set.
195 * - CONNECTION is still set.
197 * Doing so would ensure that the device is still connected
198 * to the bus, and hasn't been unplugged or replaced while the
199 * USB bus reset was going on.
201 * However, if we do that, then (at least) a San Disk Ultra
202 * USB 3.0 16GB device fails to reset on (at least) an NVIDIA
203 * Tegra Jetson TK1 board. For some reason, the device appears
204 * to briefly drop off the bus when this second bus reset is
205 * executed, yet if we retry this loop, it'll eventually come
206 * back after another reset or two.
209 if (portstatus & USB_PORT_STAT_ENABLE)
215 if (tries == MAX_TRIES) {
216 debug("Cannot enable port %i after %i retries, " \
217 "disabling port.\n", port + 1, MAX_TRIES);
218 debug("Maybe the USB cable is bad?\n");
222 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_RESET);
223 *portstat = portstatus;
228 int hub_port_reset(struct udevice *dev, int port, unsigned short *portstat)
230 struct usb_device *udev = dev_get_parentdata(dev);
232 return legacy_hub_port_reset(udev, port, portstat);
236 int usb_hub_port_connect_change(struct usb_device *dev, int port)
238 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
239 unsigned short portstatus;
243 ret = usb_get_port_status(dev, port + 1, portsts);
245 debug("get_port_status failed\n");
249 portstatus = le16_to_cpu(portsts->wPortStatus);
250 debug("portstatus %x, change %x, %s\n",
252 le16_to_cpu(portsts->wPortChange),
253 portspeed(portstatus));
255 /* Clear the connection change status */
256 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_CONNECTION);
258 /* Disconnect any existing devices under this port */
259 if (((!(portstatus & USB_PORT_STAT_CONNECTION)) &&
260 (!(portstatus & USB_PORT_STAT_ENABLE))) ||
261 usb_device_has_child_on_port(dev, port)) {
262 debug("usb_disconnect(&hub->children[port]);\n");
263 /* Return now if nothing is connected */
264 if (!(portstatus & USB_PORT_STAT_CONNECTION))
270 ret = legacy_hub_port_reset(dev, port, &portstatus);
272 printf("cannot reset port %i!?\n", port + 1);
278 switch (portstatus & USB_PORT_STAT_SPEED_MASK) {
279 case USB_PORT_STAT_SUPER_SPEED:
280 speed = USB_SPEED_SUPER;
282 case USB_PORT_STAT_HIGH_SPEED:
283 speed = USB_SPEED_HIGH;
285 case USB_PORT_STAT_LOW_SPEED:
286 speed = USB_SPEED_LOW;
289 speed = USB_SPEED_FULL;
294 struct udevice *child;
296 ret = usb_scan_device(dev->dev, port + 1, speed, &child);
298 struct usb_device *usb;
300 ret = usb_alloc_new_device(dev->controller, &usb);
302 printf("cannot create new device: ret=%d", ret);
306 dev->children[port] = usb;
309 usb->portnr = port + 1;
310 /* Run it through the hoops (find a driver, etc) */
311 ret = usb_new_device(usb);
313 /* Woops, disable the port */
314 usb_free_device(dev->controller);
315 dev->children[port] = NULL;
319 debug("hub: disabling port %d\n", port + 1);
320 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_ENABLE);
327 static int usb_hub_configure(struct usb_device *dev)
330 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, buffer, USB_BUFSIZ);
331 unsigned char *bitmap;
332 short hubCharacteristics;
333 struct usb_hub_descriptor *descriptor;
334 struct usb_hub_device *hub;
335 __maybe_unused struct usb_hub_status *hubsts;
338 /* "allocate" Hub device */
339 hub = usb_hub_allocate();
343 /* Get the the hub descriptor */
344 ret = usb_get_hub_descriptor(dev, buffer, 4);
346 debug("usb_hub_configure: failed to get hub " \
347 "descriptor, giving up %lX\n", dev->status);
350 descriptor = (struct usb_hub_descriptor *)buffer;
352 length = min_t(int, descriptor->bLength,
353 sizeof(struct usb_hub_descriptor));
355 ret = usb_get_hub_descriptor(dev, buffer, length);
357 debug("usb_hub_configure: failed to get hub " \
358 "descriptor 2nd giving up %lX\n", dev->status);
361 memcpy((unsigned char *)&hub->desc, buffer, length);
362 /* adjust 16bit values */
363 put_unaligned(le16_to_cpu(get_unaligned(
364 &descriptor->wHubCharacteristics)),
365 &hub->desc.wHubCharacteristics);
367 bitmap = (unsigned char *)&hub->desc.DeviceRemovable[0];
368 /* devices not removable by default */
369 memset(bitmap, 0xff, (USB_MAXCHILDREN+1+7)/8);
370 bitmap = (unsigned char *)&hub->desc.PortPowerCtrlMask[0];
371 memset(bitmap, 0xff, (USB_MAXCHILDREN+1+7)/8); /* PowerMask = 1B */
373 for (i = 0; i < ((hub->desc.bNbrPorts + 1 + 7)/8); i++)
374 hub->desc.DeviceRemovable[i] = descriptor->DeviceRemovable[i];
376 for (i = 0; i < ((hub->desc.bNbrPorts + 1 + 7)/8); i++)
377 hub->desc.PortPowerCtrlMask[i] = descriptor->PortPowerCtrlMask[i];
379 dev->maxchild = descriptor->bNbrPorts;
380 debug("%d ports detected\n", dev->maxchild);
382 hubCharacteristics = get_unaligned(&hub->desc.wHubCharacteristics);
383 switch (hubCharacteristics & HUB_CHAR_LPSM) {
385 debug("ganged power switching\n");
388 debug("individual port power switching\n");
392 debug("unknown reserved power switching mode\n");
396 if (hubCharacteristics & HUB_CHAR_COMPOUND)
397 debug("part of a compound device\n");
399 debug("standalone hub\n");
401 switch (hubCharacteristics & HUB_CHAR_OCPM) {
403 debug("global over-current protection\n");
406 debug("individual port over-current protection\n");
410 debug("no over-current protection\n");
414 debug("power on to power good time: %dms\n",
415 descriptor->bPwrOn2PwrGood * 2);
416 debug("hub controller current requirement: %dmA\n",
417 descriptor->bHubContrCurrent);
419 for (i = 0; i < dev->maxchild; i++)
420 debug("port %d is%s removable\n", i + 1,
421 hub->desc.DeviceRemovable[(i + 1) / 8] & \
422 (1 << ((i + 1) % 8)) ? " not" : "");
424 if (sizeof(struct usb_hub_status) > USB_BUFSIZ) {
425 debug("usb_hub_configure: failed to get Status - " \
426 "too long: %d\n", descriptor->bLength);
430 ret = usb_get_hub_status(dev, buffer);
432 debug("usb_hub_configure: failed to get Status %lX\n",
438 hubsts = (struct usb_hub_status *)buffer;
441 debug("get_hub_status returned status %X, change %X\n",
442 le16_to_cpu(hubsts->wHubStatus),
443 le16_to_cpu(hubsts->wHubChange));
444 debug("local power source is %s\n",
445 (le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_LOCAL_POWER) ? \
446 "lost (inactive)" : "good");
447 debug("%sover-current condition exists\n",
448 (le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_OVERCURRENT) ? \
450 usb_hub_power_on(hub);
453 * Reset any devices that may be in a bad state when applying
454 * the power. This is a __weak function. Resetting of the devices
455 * should occur in the board file of the device.
457 for (i = 0; i < dev->maxchild; i++)
458 usb_hub_reset_devices(i + 1);
460 for (i = 0; i < dev->maxchild; i++) {
461 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
462 unsigned short portstatus, portchange;
464 ulong start = get_timer(0);
467 debug("\n\nScanning '%s' port %d\n", dev->dev->name, i + 1);
469 debug("\n\nScanning port %d\n", i + 1);
472 * Wait for (whichever finishes first)
473 * - A maximum of 10 seconds
474 * This is a purely observational value driven by connecting
475 * a few broken pen drives and taking the max * 1.5 approach
476 * - connection_change and connection state to report same
480 ret = usb_get_port_status(dev, i + 1, portsts);
482 debug("get_port_status failed\n");
486 portstatus = le16_to_cpu(portsts->wPortStatus);
487 portchange = le16_to_cpu(portsts->wPortChange);
489 if ((portchange & USB_PORT_STAT_C_CONNECTION) ==
490 (portstatus & USB_PORT_STAT_CONNECTION))
493 } while (get_timer(start) < CONFIG_SYS_HZ * 10);
498 debug("Port %d Status %X Change %X\n",
499 i + 1, portstatus, portchange);
501 if (portchange & USB_PORT_STAT_C_CONNECTION) {
502 debug("port %d connection change\n", i + 1);
503 usb_hub_port_connect_change(dev, i);
505 if (portchange & USB_PORT_STAT_C_ENABLE) {
506 debug("port %d enable change, status %x\n",
508 usb_clear_port_feature(dev, i + 1,
509 USB_PORT_FEAT_C_ENABLE);
511 * The following hack causes a ghost device problem
514 #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 */
518 if (!(portstatus & USB_PORT_STAT_ENABLE) &&
519 (portstatus & USB_PORT_STAT_CONNECTION) &&
520 usb_device_has_child_on_port(dev, i)) {
521 debug("already running port %i " \
522 "disabled by hub (EMI?), " \
523 "re-enabling...\n", i + 1);
524 usb_hub_port_connect_change(dev, i);
528 if (portstatus & USB_PORT_STAT_SUSPEND) {
529 debug("port %d suspend change\n", i + 1);
530 usb_clear_port_feature(dev, i + 1,
531 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 usb_hub_power_on(hub);
541 if (portchange & USB_PORT_STAT_C_RESET) {
542 debug("port %d reset change\n", i + 1);
543 usb_clear_port_feature(dev, i + 1,
544 USB_PORT_FEAT_C_RESET);
546 } /* end for i all ports */
551 static int usb_hub_check(struct usb_device *dev, int ifnum)
553 struct usb_interface *iface;
554 struct usb_endpoint_descriptor *ep = NULL;
556 iface = &dev->config.if_desc[ifnum];
558 if (iface->desc.bInterfaceClass != USB_CLASS_HUB)
560 /* Some hubs have a subclass of 1, which AFAICT according to the */
561 /* specs is not defined, but it works */
562 if ((iface->desc.bInterfaceSubClass != 0) &&
563 (iface->desc.bInterfaceSubClass != 1))
565 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
566 if (iface->desc.bNumEndpoints != 1)
568 ep = &iface->ep_desc[0];
569 /* Output endpoint? Curiousier and curiousier.. */
570 if (!(ep->bEndpointAddress & USB_DIR_IN))
572 /* If it's not an interrupt endpoint, we'd better punt! */
573 if ((ep->bmAttributes & 3) != 3)
576 debug("USB hub found\n");
580 debug("USB hub not found: bInterfaceClass=%d, bInterfaceSubClass=%d, bNumEndpoints=%d\n",
581 iface->desc.bInterfaceClass, iface->desc.bInterfaceSubClass,
582 iface->desc.bNumEndpoints);
584 debug(" bEndpointAddress=%#x, bmAttributes=%d",
585 ep->bEndpointAddress, ep->bmAttributes);
591 int usb_hub_probe(struct usb_device *dev, int ifnum)
595 ret = usb_hub_check(dev, ifnum);
598 ret = usb_hub_configure(dev);
603 int usb_hub_scan(struct udevice *hub)
605 struct usb_device *udev = dev_get_parentdata(hub);
607 return usb_hub_configure(udev);
610 static int usb_hub_post_bind(struct udevice *dev)
612 /* Scan the bus for devices */
613 return dm_scan_fdt_node(dev, gd->fdt_blob, dev->of_offset, false);
616 static int usb_hub_post_probe(struct udevice *dev)
618 debug("%s\n", __func__);
619 return usb_hub_scan(dev);
622 static const struct udevice_id usb_hub_ids[] = {
623 { .compatible = "usb-hub" },
627 U_BOOT_DRIVER(usb_generic_hub) = {
629 .id = UCLASS_USB_HUB,
630 .of_match = usb_hub_ids,
631 .flags = DM_FLAG_ALLOC_PRIV_DMA,
634 UCLASS_DRIVER(usb_hub) = {
635 .id = UCLASS_USB_HUB,
637 .post_bind = usb_hub_post_bind,
638 .post_probe = usb_hub_post_probe,
639 .child_pre_probe = usb_child_pre_probe,
640 .per_child_auto_alloc_size = sizeof(struct usb_device),
641 .per_child_platdata_auto_alloc_size = sizeof(struct usb_dev_platdata),
644 static const struct usb_device_id hub_id_table[] = {
646 .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
647 .bDeviceClass = USB_CLASS_HUB
649 { } /* Terminating entry */
652 USB_DEVICE(usb_generic_hub, hub_id_table);