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