common/usb_hub.c

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