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