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