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