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