common/usb_hub.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Most of this source has been derived from the Linux USB
   4  * project:
   5  * (C) Copyright Linus Torvalds 1999
   6  * (C) Copyright Johannes Erdfelt 1999-2001
   7  * (C) Copyright Andreas Gal 1999
   8  * (C) Copyright Gregory P. Smith 1999
   9  * (C) Copyright Deti Fliegl 1999 (new USB architecture)
  10  * (C) Copyright Randy Dunlap 2000
  11  * (C) Copyright David Brownell 2000 (kernel hotplug, usb_device_id)
  12  * (C) Copyright Yggdrasil Computing, Inc. 2000
  13  *     (usb_device_id matching changes by Adam J. Richter)
  14  *
  15  * Adapted for U-Boot:
  16  * (C) Copyright 2001 Denis Peter, MPL AG Switzerland
  17  */
  18
  19 /****************************************************************************
  20  * HUB "Driver"
  21  * Probes device for being a hub and configurate it
  22  */
  23
  24 #include <common.h>
  25 #include <command.h>
  26 #include <dm.h>
  27 #include <env.h>
  28 #include <errno.h>
  29 #include <log.h>
  30 #include <malloc.h>
  31 #include <memalign.h>
  32 #include <asm/processor.h>
  33 #include <asm/unaligned.h>
  34 #include <linux/ctype.h>
  35 #include <linux/delay.h>
  36 #include <linux/list.h>
  37 #include <asm/byteorder.h>
  38 #ifdef CONFIG_SANDBOX
  39 #include <asm/state.h>
  40 #endif
  41 #include <asm/unaligned.h>
  42
  43 #include <usb.h>
  44
  45 #define USB_BUFSIZ      512
  46
  47 #define HUB_SHORT_RESET_TIME    20
  48 #define HUB_LONG_RESET_TIME     200
  49
  50 #define PORT_OVERCURRENT_MAX_SCAN_COUNT         3
  51
  52 struct usb_device_scan {
  53         struct usb_device *dev;         /* USB hub device to scan */
  54         struct usb_hub_device *hub;     /* USB hub struct */
  55         int port;                       /* USB port to scan */
  56         struct list_head list;
  57 };
  58
  59 static LIST_HEAD(usb_scan_list);
  60
  61 __weak void usb_hub_reset_devices(struct usb_hub_device *hub, int port)
  62 {
  63         return;
  64 }
  65
  66 static inline bool usb_hub_is_superspeed(struct usb_device *hdev)
  67 {
  68         return hdev->descriptor.bDeviceProtocol == 3;
  69 }
  70
  71 #if CONFIG_IS_ENABLED(DM_USB)
  72 bool usb_hub_is_root_hub(struct udevice *hub)
  73 {
  74         if (device_get_uclass_id(hub->parent) != UCLASS_USB_HUB)
  75                 return true;
  76
  77         return false;
  78 }
  79
  80 static int usb_set_hub_depth(struct usb_device *dev, int depth)
  81 {
  82         if (depth < 0 || depth > 4)
  83                 return -EINVAL;
  84
  85         return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
  86                 USB_REQ_SET_HUB_DEPTH, USB_DIR_OUT | USB_RT_HUB,
  87                 depth, 0, NULL, 0, USB_CNTL_TIMEOUT);
  88 }
  89 #endif
  90
  91 static int usb_get_hub_descriptor(struct usb_device *dev, void *data, int size)
  92 {
  93         unsigned short dtype = USB_DT_HUB;
  94
  95         if (usb_hub_is_superspeed(dev))
  96                 dtype = USB_DT_SS_HUB;
  97
  98         return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
  99                 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
 100                 dtype << 8, 0, data, size, USB_CNTL_TIMEOUT);
 101 }
 102
 103 static int usb_clear_port_feature(struct usb_device *dev, int port, int feature)
 104 {
 105         return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 106                                 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature,
 107                                 port, NULL, 0, USB_CNTL_TIMEOUT);
 108 }
 109
 110 static int usb_set_port_feature(struct usb_device *dev, int port, int feature)
 111 {
 112         return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 113                                 USB_REQ_SET_FEATURE, USB_RT_PORT, feature,
 114                                 port, NULL, 0, USB_CNTL_TIMEOUT);
 115 }
 116
 117 static int usb_get_hub_status(struct usb_device *dev, void *data)
 118 {
 119         return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
 120                         USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
 121                         data, sizeof(struct usb_hub_status), USB_CNTL_TIMEOUT);
 122 }
 123
 124 int usb_get_port_status(struct usb_device *dev, int port, void *data)
 125 {
 126         int ret;
 127
 128         ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
 129                         USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port,
 130                         data, sizeof(struct usb_port_status), USB_CNTL_TIMEOUT);
 131
 132 #if CONFIG_IS_ENABLED(DM_USB)
 133         if (ret < 0)
 134                 return ret;
 135
 136         /*
 137          * Translate the USB 3.0 hub port status field into the old version
 138          * that U-Boot understands. Do this only when the hub is not root hub.
 139          * For root hub, the port status field has already been translated
 140          * in the host controller driver (see xhci_submit_root() in xhci.c).
 141          *
 142          * Note: this only supports driver model.
 143          */
 144
 145         if (!usb_hub_is_root_hub(dev->dev) && usb_hub_is_superspeed(dev)) {
 146                 struct usb_port_status *status = (struct usb_port_status *)data;
 147                 u16 tmp = (status->wPortStatus) & USB_SS_PORT_STAT_MASK;
 148
 149                 if (status->wPortStatus & USB_SS_PORT_STAT_POWER)
 150                         tmp |= USB_PORT_STAT_POWER;
 151                 if ((status->wPortStatus & USB_SS_PORT_STAT_SPEED) ==
 152                     USB_SS_PORT_STAT_SPEED_5GBPS)
 153                         tmp |= USB_PORT_STAT_SUPER_SPEED;
 154
 155                 status->wPortStatus = tmp;
 156         }
 157 #endif
 158
 159         return ret;
 160 }
 161
 162
 163 static void usb_hub_power_on(struct usb_hub_device *hub)
 164 {
 165         int i;
 166         struct usb_device *dev;
 167         unsigned pgood_delay = hub->desc.bPwrOn2PwrGood * 2;
 168         const char *env;
 169
 170         dev = hub->pusb_dev;
 171
 172         debug("enabling power on all ports\n");
 173         for (i = 0; i < dev->maxchild; i++) {
 174                 usb_set_port_feature(dev, i + 1, USB_PORT_FEAT_POWER);
 175                 debug("port %d returns %lX\n", i + 1, dev->status);
 176         }
 177
 178 #ifdef CONFIG_SANDBOX
 179         /*
 180          * Don't set timeout / delay values here. This results
 181          * in these values still being reset to 0.
 182          */
 183         if (state_get_skip_delays())
 184                 return;
 185 #endif
 186
 187         /*
 188          * Wait for power to become stable,
 189          * plus spec-defined max time for device to connect
 190          * but allow this time to be increased via env variable as some
 191          * devices break the spec and require longer warm-up times
 192          */
 193         env = env_get("usb_pgood_delay");
 194         if (env)
 195                 pgood_delay = max(pgood_delay,
 196                                   (unsigned)simple_strtol(env, NULL, 0));
 197         debug("pgood_delay=%dms\n", pgood_delay);
 198
 199         /*
 200          * Do a minimum delay of the larger value of 100ms or pgood_delay
 201          * so that the power can stablize before the devices are queried
 202          */
 203         hub->query_delay = get_timer(0) + max(100, (int)pgood_delay);
 204
 205         /*
 206          * Record the power-on timeout here. The max. delay (timeout)
 207          * will be done based on this value in the USB port loop in
 208          * usb_hub_configure() later.
 209          */
 210         hub->connect_timeout = hub->query_delay + 1000;
 211         debug("devnum=%d poweron: query_delay=%d connect_timeout=%d\n",
 212               dev->devnum, max(100, (int)pgood_delay),
 213               max(100, (int)pgood_delay) + 1000);
 214 }
 215
 216 #if !CONFIG_IS_ENABLED(DM_USB)
 217 static struct usb_hub_device hub_dev[USB_MAX_HUB];
 218 static int usb_hub_index;
 219
 220 void usb_hub_reset(void)
 221 {
 222         usb_hub_index = 0;
 223
 224         /* Zero out global hub_dev in case its re-used again */
 225         memset(hub_dev, 0, sizeof(hub_dev));
 226 }
 227
 228 static struct usb_hub_device *usb_hub_allocate(void)
 229 {
 230         if (usb_hub_index < USB_MAX_HUB)
 231                 return &hub_dev[usb_hub_index++];
 232
 233         printf("ERROR: USB_MAX_HUB (%d) reached\n", USB_MAX_HUB);
 234         return NULL;
 235 }
 236 #endif
 237
 238 #define MAX_TRIES 5
 239
 240 static inline const char *portspeed(int portstatus)
 241 {
 242         switch (portstatus & USB_PORT_STAT_SPEED_MASK) {
 243         case USB_PORT_STAT_SUPER_SPEED:
 244                 return "5 Gb/s";
 245         case USB_PORT_STAT_HIGH_SPEED:
 246                 return "480 Mb/s";
 247         case USB_PORT_STAT_LOW_SPEED:
 248                 return "1.5 Mb/s";
 249         default:
 250                 return "12 Mb/s";
 251         }
 252 }
 253
 254 /**
 255  * usb_hub_port_reset() - reset a port given its usb_device pointer
 256  *
 257  * Reset a hub port and see if a device is present on that port, providing
 258  * sufficient time for it to show itself. The port status is returned.
 259  *
 260  * @dev:        USB device to reset
 261  * @port:       Port number to reset (note ports are numbered from 0 here)
 262  * @portstat:   Returns port status
 263  */
 264 static int usb_hub_port_reset(struct usb_device *dev, int port,
 265                               unsigned short *portstat)
 266 {
 267         int err, tries;
 268         ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
 269         unsigned short portstatus, portchange;
 270         int delay = HUB_SHORT_RESET_TIME; /* start with short reset delay */
 271
 272 #if CONFIG_IS_ENABLED(DM_USB)
 273         debug("%s: resetting '%s' port %d...\n", __func__, dev->dev->name,
 274               port + 1);
 275 #else
 276         debug("%s: resetting port %d...\n", __func__, port + 1);
 277 #endif
 278         for (tries = 0; tries < MAX_TRIES; tries++) {
 279                 err = usb_set_port_feature(dev, port + 1, USB_PORT_FEAT_RESET);
 280                 if (err < 0)
 281                         return err;
 282
 283                 mdelay(delay);
 284
 285                 if (usb_get_port_status(dev, port + 1, portsts) < 0) {
 286                         debug("get_port_status failed status %lX\n",
 287                               dev->status);
 288                         return -1;
 289                 }
 290                 portstatus = le16_to_cpu(portsts->wPortStatus);
 291                 portchange = le16_to_cpu(portsts->wPortChange);
 292
 293                 debug("portstatus %x, change %x, %s\n", portstatus, portchange,
 294                                                         portspeed(portstatus));
 295
 296                 debug("STAT_C_CONNECTION = %d STAT_CONNECTION = %d" \
 297                       "  USB_PORT_STAT_ENABLE %d\n",
 298                       (portchange & USB_PORT_STAT_C_CONNECTION) ? 1 : 0,
 299                       (portstatus & USB_PORT_STAT_CONNECTION) ? 1 : 0,
 300                       (portstatus & USB_PORT_STAT_ENABLE) ? 1 : 0);
 301
 302                 /*
 303                  * Perhaps we should check for the following here:
 304                  * - C_CONNECTION hasn't been set.
 305                  * - CONNECTION is still set.
 306                  *
 307                  * Doing so would ensure that the device is still connected
 308                  * to the bus, and hasn't been unplugged or replaced while the
 309                  * USB bus reset was going on.
 310                  *
 311                  * However, if we do that, then (at least) a San Disk Ultra
 312                  * USB 3.0 16GB device fails to reset on (at least) an NVIDIA
 313                  * Tegra Jetson TK1 board. For some reason, the device appears
 314                  * to briefly drop off the bus when this second bus reset is
 315                  * executed, yet if we retry this loop, it'll eventually come
 316                  * back after another reset or two.
 317                  */
 318
 319                 if (portstatus & USB_PORT_STAT_ENABLE)
 320                         break;
 321
 322                 /* Switch to long reset delay for the next round */
 323                 delay = HUB_LONG_RESET_TIME;
 324         }
 325
 326         if (tries == MAX_TRIES) {
 327                 debug("Cannot enable port %i after %i retries, " \
 328                       "disabling port.\n", port + 1, MAX_TRIES);
 329                 debug("Maybe the USB cable is bad?\n");
 330                 return -1;
 331         }
 332
 333         usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_RESET);
 334         *portstat = portstatus;
 335         return 0;
 336 }
 337
 338 int usb_hub_port_connect_change(struct usb_device *dev, int port)
 339 {
 340         ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
 341         unsigned short portstatus;
 342         int ret, speed;
 343
 344         /* Check status */
 345         ret = usb_get_port_status(dev, port + 1, portsts);
 346         if (ret < 0) {
 347                 debug("get_port_status failed\n");
 348                 return ret;
 349         }
 350
 351         portstatus = le16_to_cpu(portsts->wPortStatus);
 352         debug("portstatus %x, change %x, %s\n",
 353               portstatus,
 354               le16_to_cpu(portsts->wPortChange),
 355               portspeed(portstatus));
 356
 357         /* Clear the connection change status */
 358         usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_CONNECTION);
 359
 360         /* Disconnect any existing devices under this port */
 361         if (((!(portstatus & USB_PORT_STAT_CONNECTION)) &&
 362              (!(portstatus & USB_PORT_STAT_ENABLE))) ||
 363             usb_device_has_child_on_port(dev, port)) {
 364                 debug("usb_disconnect(&hub->children[port]);\n");
 365                 /* Return now if nothing is connected */
 366                 if (!(portstatus & USB_PORT_STAT_CONNECTION))
 367                         return -ENOTCONN;
 368         }
 369
 370         /* Reset the port */
 371         ret = usb_hub_port_reset(dev, port, &portstatus);
 372         if (ret < 0) {
 373                 if (ret != -ENXIO)
 374                         printf("cannot reset port %i!?\n", port + 1);
 375                 return ret;
 376         }
 377
 378         switch (portstatus & USB_PORT_STAT_SPEED_MASK) {
 379         case USB_PORT_STAT_SUPER_SPEED:
 380                 speed = USB_SPEED_SUPER;
 381                 break;
 382         case USB_PORT_STAT_HIGH_SPEED:
 383                 speed = USB_SPEED_HIGH;
 384                 break;
 385         case USB_PORT_STAT_LOW_SPEED:
 386                 speed = USB_SPEED_LOW;
 387                 break;
 388         default:
 389                 speed = USB_SPEED_FULL;
 390                 break;
 391         }
 392
 393 #if CONFIG_IS_ENABLED(DM_USB)
 394         struct udevice *child;
 395
 396         ret = usb_scan_device(dev->dev, port + 1, speed, &child);
 397 #else
 398         struct usb_device *usb;
 399
 400         ret = usb_alloc_new_device(dev->controller, &usb);
 401         if (ret) {
 402                 printf("cannot create new device: ret=%d", ret);
 403                 return ret;
 404         }
 405
 406         dev->children[port] = usb;
 407         usb->speed = speed;
 408         usb->parent = dev;
 409         usb->portnr = port + 1;
 410         /* Run it through the hoops (find a driver, etc) */
 411         ret = usb_new_device(usb);
 412         if (ret < 0) {
 413                 /* Woops, disable the port */
 414                 usb_free_device(dev->controller);
 415                 dev->children[port] = NULL;
 416         }
 417 #endif
 418         if (ret < 0) {
 419                 debug("hub: disabling port %d\n", port + 1);
 420                 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_ENABLE);
 421         }
 422
 423         return ret;
 424 }
 425
 426 static int usb_scan_port(struct usb_device_scan *usb_scan)
 427 {
 428         ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
 429         unsigned short portstatus;
 430         unsigned short portchange;
 431         struct usb_device *dev;
 432         struct usb_hub_device *hub;
 433         int ret = 0;
 434         int i;
 435
 436         dev = usb_scan->dev;
 437         hub = usb_scan->hub;
 438         i = usb_scan->port;
 439
 440         /*
 441          * Don't talk to the device before the query delay is expired.
 442          * This is needed for voltages to stabalize.
 443          */
 444         if (get_timer(0) < hub->query_delay)
 445                 return 0;
 446
 447         ret = usb_get_port_status(dev, i + 1, portsts);
 448         if (ret < 0) {
 449                 debug("get_port_status failed\n");
 450                 if (get_timer(0) >= hub->connect_timeout) {
 451                         debug("devnum=%d port=%d: timeout\n",
 452                               dev->devnum, i + 1);
 453                         /* Remove this device from scanning list */
 454                         list_del(&usb_scan->list);
 455                         free(usb_scan);
 456                         return 0;
 457                 }
 458                 return 0;
 459         }
 460
 461         portstatus = le16_to_cpu(portsts->wPortStatus);
 462         portchange = le16_to_cpu(portsts->wPortChange);
 463         debug("Port %d Status %X Change %X\n", i + 1, portstatus, portchange);
 464
 465         /*
 466          * No connection change happened, wait a bit more.
 467          *
 468          * For some situation, the hub reports no connection change but a
 469          * device is connected to the port (eg: CCS bit is set but CSC is not
 470          * in the PORTSC register of a root hub), ignore such case.
 471          */
 472         if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
 473             !(portstatus & USB_PORT_STAT_CONNECTION)) {
 474                 if (get_timer(0) >= hub->connect_timeout) {
 475                         debug("devnum=%d port=%d: timeout\n",
 476                               dev->devnum, i + 1);
 477                         /* Remove this device from scanning list */
 478                         list_del(&usb_scan->list);
 479                         free(usb_scan);
 480                         return 0;
 481                 }
 482                 return 0;
 483         }
 484
 485         if (portchange & USB_PORT_STAT_C_RESET) {
 486                 debug("port %d reset change\n", i + 1);
 487                 usb_clear_port_feature(dev, i + 1, USB_PORT_FEAT_C_RESET);
 488         }
 489
 490         if ((portchange & USB_SS_PORT_STAT_C_BH_RESET) &&
 491             usb_hub_is_superspeed(dev)) {
 492                 debug("port %d BH reset change\n", i + 1);
 493                 usb_clear_port_feature(dev, i + 1, USB_SS_PORT_FEAT_C_BH_RESET);
 494         }
 495
 496         /* A new USB device is ready at this point */
 497         debug("devnum=%d port=%d: USB dev found\n", dev->devnum, i + 1);
 498
 499         usb_hub_port_connect_change(dev, i);
 500
 501         if (portchange & USB_PORT_STAT_C_ENABLE) {
 502                 debug("port %d enable change, status %x\n", i + 1, portstatus);
 503                 usb_clear_port_feature(dev, i + 1, USB_PORT_FEAT_C_ENABLE);
 504                 /*
 505                  * The following hack causes a ghost device problem
 506                  * to Faraday EHCI
 507                  */
 508 #ifndef CONFIG_USB_EHCI_FARADAY
 509                 /*
 510                  * EM interference sometimes causes bad shielded USB
 511                  * devices to be shutdown by the hub, this hack enables
 512                  * them again. Works at least with mouse driver
 513                  */
 514                 if (!(portstatus & USB_PORT_STAT_ENABLE) &&
 515                     (portstatus & USB_PORT_STAT_CONNECTION) &&
 516                     usb_device_has_child_on_port(dev, i)) {
 517                         debug("already running port %i disabled by hub (EMI?), re-enabling...\n",
 518                               i + 1);
 519                         usb_hub_port_connect_change(dev, i);
 520                 }
 521 #endif
 522         }
 523
 524         if (portstatus & USB_PORT_STAT_SUSPEND) {
 525                 debug("port %d suspend change\n", i + 1);
 526                 usb_clear_port_feature(dev, i + 1, USB_PORT_FEAT_SUSPEND);
 527         }
 528
 529         if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
 530                 debug("port %d over-current change\n", i + 1);
 531                 usb_clear_port_feature(dev, i + 1,
 532                                        USB_PORT_FEAT_C_OVER_CURRENT);
 533                 /* Only power-on this one port */
 534                 usb_set_port_feature(dev, i + 1, USB_PORT_FEAT_POWER);
 535                 hub->overcurrent_count[i]++;
 536
 537                 /*
 538                  * If the max-scan-count is not reached, return without removing
 539                  * the device from scan-list. This will re-issue a new scan.
 540                  */
 541                 if (hub->overcurrent_count[i] <=
 542                     PORT_OVERCURRENT_MAX_SCAN_COUNT)
 543                         return 0;
 544
 545                 /* Otherwise the device will get removed */
 546                 printf("Port %d over-current occurred %d times\n", i + 1,
 547                        hub->overcurrent_count[i]);
 548         }
 549
 550         /*
 551          * We're done with this device, so let's remove this device from
 552          * scanning list
 553          */
 554         list_del(&usb_scan->list);
 555         free(usb_scan);
 556
 557         return 0;
 558 }
 559
 560 static int usb_device_list_scan(void)
 561 {
 562         struct usb_device_scan *usb_scan;
 563         struct usb_device_scan *tmp;
 564         static int running;
 565         int ret = 0;
 566
 567         /* Only run this loop once for each controller */
 568         if (running)
 569                 return 0;
 570
 571         running = 1;
 572
 573         while (1) {
 574                 /* We're done, once the list is empty again */
 575                 if (list_empty(&usb_scan_list))
 576                         goto out;
 577
 578                 list_for_each_entry_safe(usb_scan, tmp, &usb_scan_list, list) {
 579                         int ret;
 580
 581                         /* Scan this port */
 582                         ret = usb_scan_port(usb_scan);
 583                         if (ret)
 584                                 goto out;
 585                 }
 586         }
 587
 588 out:
 589         /*
 590          * This USB controller has finished scanning all its connected
 591          * USB devices. Set "running" back to 0, so that other USB controllers
 592          * will scan their devices too.
 593          */
 594         running = 0;
 595
 596         return ret;
 597 }
 598
 599 static struct usb_hub_device *usb_get_hub_device(struct usb_device *dev)
 600 {
 601         struct usb_hub_device *hub;
 602
 603 #if !CONFIG_IS_ENABLED(DM_USB)
 604         /* "allocate" Hub device */
 605         hub = usb_hub_allocate();
 606 #else
 607         hub = dev_get_uclass_priv(dev->dev);
 608 #endif
 609
 610         return hub;
 611 }
 612
 613 static int usb_hub_configure(struct usb_device *dev)
 614 {
 615         int i, length;
 616         ALLOC_CACHE_ALIGN_BUFFER(unsigned char, buffer, USB_BUFSIZ);
 617         unsigned char *bitmap;
 618         short hubCharacteristics;
 619         struct usb_hub_descriptor *descriptor;
 620         struct usb_hub_device *hub;
 621         struct usb_hub_status *hubsts;
 622         int ret;
 623
 624         hub = usb_get_hub_device(dev);
 625         if (hub == NULL)
 626                 return -ENOMEM;
 627         hub->pusb_dev = dev;
 628
 629         /* Get the the hub descriptor */
 630         ret = usb_get_hub_descriptor(dev, buffer, 4);
 631         if (ret < 0) {
 632                 debug("usb_hub_configure: failed to get hub " \
 633                       "descriptor, giving up %lX\n", dev->status);
 634                 return ret;
 635         }
 636         descriptor = (struct usb_hub_descriptor *)buffer;
 637
 638         length = min_t(int, descriptor->bLength,
 639                        sizeof(struct usb_hub_descriptor));
 640
 641         ret = usb_get_hub_descriptor(dev, buffer, length);
 642         if (ret < 0) {
 643                 debug("usb_hub_configure: failed to get hub " \
 644                       "descriptor 2nd giving up %lX\n", dev->status);
 645                 return ret;
 646         }
 647         memcpy((unsigned char *)&hub->desc, buffer, length);
 648         /* adjust 16bit values */
 649         put_unaligned(le16_to_cpu(get_unaligned(
 650                         &descriptor->wHubCharacteristics)),
 651                         &hub->desc.wHubCharacteristics);
 652         /* set the bitmap */
 653         bitmap = (unsigned char *)&hub->desc.u.hs.DeviceRemovable[0];
 654         /* devices not removable by default */
 655         memset(bitmap, 0xff, (USB_MAXCHILDREN+1+7)/8);
 656         bitmap = (unsigned char *)&hub->desc.u.hs.PortPowerCtrlMask[0];
 657         memset(bitmap, 0xff, (USB_MAXCHILDREN+1+7)/8); /* PowerMask = 1B */
 658
 659         for (i = 0; i < ((hub->desc.bNbrPorts + 1 + 7)/8); i++)
 660                 hub->desc.u.hs.DeviceRemovable[i] =
 661                         descriptor->u.hs.DeviceRemovable[i];
 662
 663         for (i = 0; i < ((hub->desc.bNbrPorts + 1 + 7)/8); i++)
 664                 hub->desc.u.hs.PortPowerCtrlMask[i] =
 665                         descriptor->u.hs.PortPowerCtrlMask[i];
 666
 667         dev->maxchild = descriptor->bNbrPorts;
 668         debug("%d ports detected\n", dev->maxchild);
 669
 670         hubCharacteristics = get_unaligned(&hub->desc.wHubCharacteristics);
 671         switch (hubCharacteristics & HUB_CHAR_LPSM) {
 672         case 0x00:
 673                 debug("ganged power switching\n");
 674                 break;
 675         case 0x01:
 676                 debug("individual port power switching\n");
 677                 break;
 678         case 0x02:
 679         case 0x03:
 680                 debug("unknown reserved power switching mode\n");
 681                 break;
 682         }
 683
 684         if (hubCharacteristics & HUB_CHAR_COMPOUND)
 685                 debug("part of a compound device\n");
 686         else
 687                 debug("standalone hub\n");
 688
 689         switch (hubCharacteristics & HUB_CHAR_OCPM) {
 690         case 0x00:
 691                 debug("global over-current protection\n");
 692                 break;
 693         case 0x08:
 694                 debug("individual port over-current protection\n");
 695                 break;
 696         case 0x10:
 697         case 0x18:
 698                 debug("no over-current protection\n");
 699                 break;
 700         }
 701
 702         switch (dev->descriptor.bDeviceProtocol) {
 703         case USB_HUB_PR_FS:
 704                 break;
 705         case USB_HUB_PR_HS_SINGLE_TT:
 706                 debug("Single TT\n");
 707                 break;
 708         case USB_HUB_PR_HS_MULTI_TT:
 709                 ret = usb_set_interface(dev, 0, 1);
 710                 if (ret == 0) {
 711                         debug("TT per port\n");
 712                         hub->tt.multi = true;
 713                 } else {
 714                         debug("Using single TT (err %d)\n", ret);
 715                 }
 716                 break;
 717         case USB_HUB_PR_SS:
 718                 /* USB 3.0 hubs don't have a TT */
 719                 break;
 720         default:
 721                 debug("Unrecognized hub protocol %d\n",
 722                       dev->descriptor.bDeviceProtocol);
 723                 break;
 724         }
 725
 726         /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
 727         switch (hubCharacteristics & HUB_CHAR_TTTT) {
 728         case HUB_TTTT_8_BITS:
 729                 if (dev->descriptor.bDeviceProtocol != 0) {
 730                         hub->tt.think_time = 666;
 731                         debug("TT requires at most %d FS bit times (%d ns)\n",
 732                               8, hub->tt.think_time);
 733                 }
 734                 break;
 735         case HUB_TTTT_16_BITS:
 736                 hub->tt.think_time = 666 * 2;
 737                 debug("TT requires at most %d FS bit times (%d ns)\n",
 738                       16, hub->tt.think_time);
 739                 break;
 740         case HUB_TTTT_24_BITS:
 741                 hub->tt.think_time = 666 * 3;
 742                 debug("TT requires at most %d FS bit times (%d ns)\n",
 743                       24, hub->tt.think_time);
 744                 break;
 745         case HUB_TTTT_32_BITS:
 746                 hub->tt.think_time = 666 * 4;
 747                 debug("TT requires at most %d FS bit times (%d ns)\n",
 748                       32, hub->tt.think_time);
 749                 break;
 750         }
 751
 752         debug("power on to power good time: %dms\n",
 753               descriptor->bPwrOn2PwrGood * 2);
 754         debug("hub controller current requirement: %dmA\n",
 755               descriptor->bHubContrCurrent);
 756
 757         for (i = 0; i < dev->maxchild; i++)
 758                 debug("port %d is%s removable\n", i + 1,
 759                       hub->desc.u.hs.DeviceRemovable[(i + 1) / 8] & \
 760                       (1 << ((i + 1) % 8)) ? " not" : "");
 761
 762         if (sizeof(struct usb_hub_status) > USB_BUFSIZ) {
 763                 debug("usb_hub_configure: failed to get Status - " \
 764                       "too long: %d\n", descriptor->bLength);
 765                 return -EFBIG;
 766         }
 767
 768         ret = usb_get_hub_status(dev, buffer);
 769         if (ret < 0) {
 770                 debug("usb_hub_configure: failed to get Status %lX\n",
 771                       dev->status);
 772                 return ret;
 773         }
 774
 775         hubsts = (struct usb_hub_status *)buffer;
 776
 777         debug("get_hub_status returned status %X, change %X\n",
 778               le16_to_cpu(hubsts->wHubStatus),
 779               le16_to_cpu(hubsts->wHubChange));
 780         debug("local power source is %s\n",
 781               (le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_LOCAL_POWER) ? \
 782               "lost (inactive)" : "good");
 783         debug("%sover-current condition exists\n",
 784               (le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_OVERCURRENT) ? \
 785               "" : "no ");
 786
 787 #if CONFIG_IS_ENABLED(DM_USB)
 788         /*
 789          * Update USB host controller's internal representation of this hub
 790          * after the hub descriptor is fetched.
 791          */
 792         ret = usb_update_hub_device(dev);
 793         if (ret < 0 && ret != -ENOSYS) {
 794                 debug("%s: failed to update hub device for HCD (%x)\n",
 795                       __func__, ret);
 796                 return ret;
 797         }
 798
 799         /*
 800          * A maximum of seven tiers are allowed in a USB topology, and the
 801          * root hub occupies the first tier. The last tier ends with a normal
 802          * USB device. USB 3.0 hubs use a 20-bit field called 'route string'
 803          * to route packets to the designated downstream port. The hub uses a
 804          * hub depth value multiplied by four as an offset into the 'route
 805          * string' to locate the bits it uses to determine the downstream
 806          * port number.
 807          */
 808         if (usb_hub_is_root_hub(dev->dev)) {
 809                 hub->hub_depth = -1;
 810         } else {
 811                 struct udevice *hdev;
 812                 int depth = 0;
 813
 814                 hdev = dev->dev->parent;
 815                 while (!usb_hub_is_root_hub(hdev)) {
 816                         depth++;
 817                         hdev = hdev->parent;
 818                 }
 819
 820                 hub->hub_depth = depth;
 821
 822                 if (usb_hub_is_superspeed(dev)) {
 823                         debug("set hub (%p) depth to %d\n", dev, depth);
 824                         /*
 825                          * This request sets the value that the hub uses to
 826                          * determine the index into the 'route string index'
 827                          * for this hub.
 828                          */
 829                         ret = usb_set_hub_depth(dev, depth);
 830                         if (ret < 0) {
 831                                 debug("%s: failed to set hub depth (%lX)\n",
 832                                       __func__, dev->status);
 833                                 return ret;
 834                         }
 835                 }
 836         }
 837 #endif
 838
 839         usb_hub_power_on(hub);
 840
 841         /*
 842          * Reset any devices that may be in a bad state when applying
 843          * the power.  This is a __weak function.  Resetting of the devices
 844          * should occur in the board file of the device.
 845          */
 846         for (i = 0; i < dev->maxchild; i++)
 847                 usb_hub_reset_devices(hub, i + 1);
 848
 849         /*
 850          * Only add the connected USB devices, including potential hubs,
 851          * to a scanning list. This list will get scanned and devices that
 852          * are detected (either via port connected or via port timeout)
 853          * will get removed from this list. Scanning of the devices on this
 854          * list will continue until all devices are removed.
 855          */
 856         for (i = 0; i < dev->maxchild; i++) {
 857                 struct usb_device_scan *usb_scan;
 858
 859                 usb_scan = calloc(1, sizeof(*usb_scan));
 860                 if (!usb_scan) {
 861                         printf("Can't allocate memory for USB device!\n");
 862                         return -ENOMEM;
 863                 }
 864                 usb_scan->dev = dev;
 865                 usb_scan->hub = hub;
 866                 usb_scan->port = i;
 867                 list_add_tail(&usb_scan->list, &usb_scan_list);
 868         }
 869
 870         /*
 871          * And now call the scanning code which loops over the generated list
 872          */
 873         ret = usb_device_list_scan();
 874
 875         return ret;
 876 }
 877
 878 static int usb_hub_check(struct usb_device *dev, int ifnum)
 879 {
 880         struct usb_interface *iface;
 881         struct usb_endpoint_descriptor *ep = NULL;
 882
 883         iface = &dev->config.if_desc[ifnum];
 884         /* Is it a hub? */
 885         if (iface->desc.bInterfaceClass != USB_CLASS_HUB)
 886                 goto err;
 887         /* Some hubs have a subclass of 1, which AFAICT according to the */
 888         /*  specs is not defined, but it works */
 889         if ((iface->desc.bInterfaceSubClass != 0) &&
 890             (iface->desc.bInterfaceSubClass != 1))
 891                 goto err;
 892         /* Multiple endpoints? What kind of mutant ninja-hub is this? */
 893         if (iface->desc.bNumEndpoints != 1)
 894                 goto err;
 895         ep = &iface->ep_desc[0];
 896         /* Output endpoint? Curiousier and curiousier.. */
 897         if (!(ep->bEndpointAddress & USB_DIR_IN))
 898                 goto err;
 899         /* If it's not an interrupt endpoint, we'd better punt! */
 900         if ((ep->bmAttributes & 3) != 3)
 901                 goto err;
 902         /* We found a hub */
 903         debug("USB hub found\n");
 904         return 0;
 905
 906 err:
 907         debug("USB hub not found: bInterfaceClass=%d, bInterfaceSubClass=%d, bNumEndpoints=%d\n",
 908               iface->desc.bInterfaceClass, iface->desc.bInterfaceSubClass,
 909               iface->desc.bNumEndpoints);
 910         if (ep) {
 911                 debug("   bEndpointAddress=%#x, bmAttributes=%d",
 912                       ep->bEndpointAddress, ep->bmAttributes);
 913         }
 914
 915         return -ENOENT;
 916 }
 917
 918 int usb_hub_probe(struct usb_device *dev, int ifnum)
 919 {
 920         int ret;
 921
 922         ret = usb_hub_check(dev, ifnum);
 923         if (ret)
 924                 return 0;
 925         ret = usb_hub_configure(dev);
 926         return ret;
 927 }
 928
 929 #if CONFIG_IS_ENABLED(DM_USB)
 930 int usb_hub_scan(struct udevice *hub)
 931 {
 932         struct usb_device *udev = dev_get_parent_priv(hub);
 933
 934         return usb_hub_configure(udev);
 935 }
 936
 937 static int usb_hub_post_probe(struct udevice *dev)
 938 {
 939         debug("%s\n", __func__);
 940         return usb_hub_scan(dev);
 941 }
 942
 943 static const struct udevice_id usb_hub_ids[] = {
 944         { .compatible = "usb-hub" },
 945         { }
 946 };
 947
 948 U_BOOT_DRIVER(usb_generic_hub) = {
 949         .name   = "usb_hub",
 950         .id     = UCLASS_USB_HUB,
 951         .of_match = usb_hub_ids,
 952         .flags  = DM_FLAG_ALLOC_PRIV_DMA,
 953 };
 954
 955 UCLASS_DRIVER(usb_hub) = {
 956         .id             = UCLASS_USB_HUB,
 957         .name           = "usb_hub",
 958         .post_bind      = dm_scan_fdt_dev,
 959         .post_probe     = usb_hub_post_probe,
 960         .child_pre_probe        = usb_child_pre_probe,
 961         .per_child_auto = sizeof(struct usb_device),
 962         .per_child_plat_auto    = sizeof(struct usb_dev_plat),
 963         .per_device_auto        = sizeof(struct usb_hub_device),
 964 };
 965
 966 static const struct usb_device_id hub_id_table[] = {
 967         {
 968                 .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
 969                 .bDeviceClass = USB_CLASS_HUB
 970         },
 971         { }     /* Terminating entry */
 972 };
 973
 974 U_BOOT_USB_DEVICE(usb_generic_hub, hub_id_table);
 975
 976 #endif