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