common/usb_hub.c

   1 /*
   2  * Most of this source has been derived from the Linux USB
   3  * project:
   4  * (C) Copyright Linus Torvalds 1999
   5  * (C) Copyright Johannes Erdfelt 1999-2001
   6  * (C) Copyright Andreas Gal 1999
   7  * (C) Copyright Gregory P. Smith 1999
   8  * (C) Copyright Deti Fliegl 1999 (new USB architecture)
   9  * (C) Copyright Randy Dunlap 2000
  10  * (C) Copyright David Brownell 2000 (kernel hotplug, usb_device_id)
  11  * (C) Copyright Yggdrasil Computing, Inc. 2000
  12  *     (usb_device_id matching changes by Adam J. Richter)
  13  *
  14  * Adapted for U-Boot:
  15  * (C) Copyright 2001 Denis Peter, MPL AG Switzerland
  16  *
  17  * SPDX-License-Identifier:     GPL-2.0+
  18  */
  19
  20 /****************************************************************************
  21  * HUB "Driver"
  22  * Probes device for being a hub and configurate it
  23  */
  24
  25 #include <common.h>
  26 #include <command.h>
  27 #include <asm/processor.h>
  28 #include <asm/unaligned.h>
  29 #include <linux/ctype.h>
  30 #include <asm/byteorder.h>
  31 #include <asm/unaligned.h>
  32
  33 #include <usb.h>
  34 #ifdef CONFIG_4xx
  35 #include <asm/4xx_pci.h>
  36 #endif
  37
  38 #define USB_BUFSIZ      512
  39
  40 static struct usb_hub_device hub_dev[USB_MAX_HUB];
  41 static int usb_hub_index;
  42
  43 __weak void usb_hub_reset_devices(int port)
  44 {
  45         return;
  46 }
  47
  48 static int usb_get_hub_descriptor(struct usb_device *dev, void *data, int size)
  49 {
  50         return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
  51                 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
  52                 USB_DT_HUB << 8, 0, data, size, USB_CNTL_TIMEOUT);
  53 }
  54
  55 static int usb_clear_port_feature(struct usb_device *dev, int port, int feature)
  56 {
  57         return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
  58                                 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature,
  59                                 port, NULL, 0, USB_CNTL_TIMEOUT);
  60 }
  61
  62 static int usb_set_port_feature(struct usb_device *dev, int port, int feature)
  63 {
  64         return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
  65                                 USB_REQ_SET_FEATURE, USB_RT_PORT, feature,
  66                                 port, NULL, 0, USB_CNTL_TIMEOUT);
  67 }
  68
  69 static int usb_get_hub_status(struct usb_device *dev, void *data)
  70 {
  71         return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
  72                         USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
  73                         data, sizeof(struct usb_hub_status), USB_CNTL_TIMEOUT);
  74 }
  75
  76 static int usb_get_port_status(struct usb_device *dev, int port, void *data)
  77 {
  78         return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
  79                         USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port,
  80                         data, sizeof(struct usb_hub_status), USB_CNTL_TIMEOUT);
  81 }
  82
  83
  84 static void usb_hub_power_on(struct usb_hub_device *hub)
  85 {
  86         int i;
  87         struct usb_device *dev;
  88         unsigned pgood_delay = hub->desc.bPwrOn2PwrGood * 2;
  89
  90         dev = hub->pusb_dev;
  91
  92         debug("enabling power on all ports\n");
  93         for (i = 0; i < dev->maxchild; i++) {
  94                 usb_set_port_feature(dev, i + 1, USB_PORT_FEAT_POWER);
  95                 debug("port %d returns %lX\n", i + 1, dev->status);
  96         }
  97
  98         /*
  99          * Wait for power to become stable,
 100          * plus spec-defined max time for device to connect
 101          */
 102         mdelay(pgood_delay + 1000);
 103 }
 104
 105 void usb_hub_reset(void)
 106 {
 107         usb_hub_index = 0;
 108 }
 109
 110 static struct usb_hub_device *usb_hub_allocate(void)
 111 {
 112         if (usb_hub_index < USB_MAX_HUB)
 113                 return &hub_dev[usb_hub_index++];
 114
 115         printf("ERROR: USB_MAX_HUB (%d) reached\n", USB_MAX_HUB);
 116         return NULL;
 117 }
 118
 119 #define MAX_TRIES 5
 120
 121 static inline char *portspeed(int portstatus)
 122 {
 123         char *speed_str;
 124
 125         switch (portstatus & USB_PORT_STAT_SPEED_MASK) {
 126         case USB_PORT_STAT_SUPER_SPEED:
 127                 speed_str = "5 Gb/s";
 128                 break;
 129         case USB_PORT_STAT_HIGH_SPEED:
 130                 speed_str = "480 Mb/s";
 131                 break;
 132         case USB_PORT_STAT_LOW_SPEED:
 133                 speed_str = "1.5 Mb/s";
 134                 break;
 135         default:
 136                 speed_str = "12 Mb/s";
 137                 break;
 138         }
 139
 140         return speed_str;
 141 }
 142
 143 int hub_port_reset(struct usb_device *dev, int port,
 144                         unsigned short *portstat)
 145 {
 146         int tries;
 147         ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
 148         unsigned short portstatus, portchange;
 149
 150         debug("hub_port_reset: resetting port %d...\n", port);
 151         for (tries = 0; tries < MAX_TRIES; tries++) {
 152
 153                 usb_set_port_feature(dev, port + 1, USB_PORT_FEAT_RESET);
 154                 mdelay(200);
 155
 156                 if (usb_get_port_status(dev, port + 1, portsts) < 0) {
 157                         debug("get_port_status failed status %lX\n",
 158                               dev->status);
 159                         return -1;
 160                 }
 161                 portstatus = le16_to_cpu(portsts->wPortStatus);
 162                 portchange = le16_to_cpu(portsts->wPortChange);
 163
 164                 debug("portstatus %x, change %x, %s\n", portstatus, portchange,
 165                                                         portspeed(portstatus));
 166
 167                 debug("STAT_C_CONNECTION = %d STAT_CONNECTION = %d" \
 168                       "  USB_PORT_STAT_ENABLE %d\n",
 169                       (portchange & USB_PORT_STAT_C_CONNECTION) ? 1 : 0,
 170                       (portstatus & USB_PORT_STAT_CONNECTION) ? 1 : 0,
 171                       (portstatus & USB_PORT_STAT_ENABLE) ? 1 : 0);
 172
 173                 /*
 174                  * Perhaps we should check for the following here:
 175                  * - C_CONNECTION hasn't been set.
 176                  * - CONNECTION is still set.
 177                  *
 178                  * Doing so would ensure that the device is still connected
 179                  * to the bus, and hasn't been unplugged or replaced while the
 180                  * USB bus reset was going on.
 181                  *
 182                  * However, if we do that, then (at least) a San Disk Ultra
 183                  * USB 3.0 16GB device fails to reset on (at least) an NVIDIA
 184                  * Tegra Jetson TK1 board. For some reason, the device appears
 185                  * to briefly drop off the bus when this second bus reset is
 186                  * executed, yet if we retry this loop, it'll eventually come
 187                  * back after another reset or two.
 188                  */
 189
 190                 if (portstatus & USB_PORT_STAT_ENABLE)
 191                         break;
 192
 193                 mdelay(200);
 194         }
 195
 196         if (tries == MAX_TRIES) {
 197                 debug("Cannot enable port %i after %i retries, " \
 198                       "disabling port.\n", port + 1, MAX_TRIES);
 199                 debug("Maybe the USB cable is bad?\n");
 200                 return -1;
 201         }
 202
 203         usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_RESET);
 204         *portstat = portstatus;
 205         return 0;
 206 }
 207
 208
 209 void usb_hub_port_connect_change(struct usb_device *dev, int port)
 210 {
 211         struct usb_device *usb;
 212         ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
 213         unsigned short portstatus;
 214
 215         /* Check status */
 216         if (usb_get_port_status(dev, port + 1, portsts) < 0) {
 217                 debug("get_port_status failed\n");
 218                 return;
 219         }
 220
 221         portstatus = le16_to_cpu(portsts->wPortStatus);
 222         debug("portstatus %x, change %x, %s\n",
 223               portstatus,
 224               le16_to_cpu(portsts->wPortChange),
 225               portspeed(portstatus));
 226
 227         /* Clear the connection change status */
 228         usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_CONNECTION);
 229
 230         /* Disconnect any existing devices under this port */
 231         if (((!(portstatus & USB_PORT_STAT_CONNECTION)) &&
 232              (!(portstatus & USB_PORT_STAT_ENABLE))) || (dev->children[port])) {
 233                 debug("usb_disconnect(&hub->children[port]);\n");
 234                 /* Return now if nothing is connected */
 235                 if (!(portstatus & USB_PORT_STAT_CONNECTION))
 236                         return;
 237         }
 238         mdelay(200);
 239
 240         /* Reset the port */
 241         if (hub_port_reset(dev, port, &portstatus) < 0) {
 242                 printf("cannot reset port %i!?\n", port + 1);
 243                 return;
 244         }
 245
 246         mdelay(200);
 247
 248         /* Allocate a new device struct for it */
 249         usb = usb_alloc_new_device(dev->controller);
 250
 251         switch (portstatus & USB_PORT_STAT_SPEED_MASK) {
 252         case USB_PORT_STAT_SUPER_SPEED:
 253                 usb->speed = USB_SPEED_SUPER;
 254                 break;
 255         case USB_PORT_STAT_HIGH_SPEED:
 256                 usb->speed = USB_SPEED_HIGH;
 257                 break;
 258         case USB_PORT_STAT_LOW_SPEED:
 259                 usb->speed = USB_SPEED_LOW;
 260                 break;
 261         default:
 262                 usb->speed = USB_SPEED_FULL;
 263                 break;
 264         }
 265
 266         dev->children[port] = usb;
 267         usb->parent = dev;
 268         usb->portnr = port + 1;
 269         /* Run it through the hoops (find a driver, etc) */
 270         if (usb_new_device(usb)) {
 271                 /* Woops, disable the port */
 272                 usb_free_device();
 273                 dev->children[port] = NULL;
 274                 debug("hub: disabling port %d\n", port + 1);
 275                 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_ENABLE);
 276         }
 277 }
 278
 279
 280 static int usb_hub_configure(struct usb_device *dev)
 281 {
 282         int i, length;
 283         ALLOC_CACHE_ALIGN_BUFFER(unsigned char, buffer, USB_BUFSIZ);
 284         unsigned char *bitmap;
 285         short hubCharacteristics;
 286         struct usb_hub_descriptor *descriptor;
 287         struct usb_hub_device *hub;
 288         __maybe_unused struct usb_hub_status *hubsts;
 289
 290         /* "allocate" Hub device */
 291         hub = usb_hub_allocate();
 292         if (hub == NULL)
 293                 return -1;
 294         hub->pusb_dev = dev;
 295         /* Get the the hub descriptor */
 296         if (usb_get_hub_descriptor(dev, buffer, 4) < 0) {
 297                 debug("usb_hub_configure: failed to get hub " \
 298                       "descriptor, giving up %lX\n", dev->status);
 299                 return -1;
 300         }
 301         descriptor = (struct usb_hub_descriptor *)buffer;
 302
 303         length = min_t(int, descriptor->bLength,
 304                        sizeof(struct usb_hub_descriptor));
 305
 306         if (usb_get_hub_descriptor(dev, buffer, length) < 0) {
 307                 debug("usb_hub_configure: failed to get hub " \
 308                       "descriptor 2nd giving up %lX\n", dev->status);
 309                 return -1;
 310         }
 311         memcpy((unsigned char *)&hub->desc, buffer, length);
 312         /* adjust 16bit values */
 313         put_unaligned(le16_to_cpu(get_unaligned(
 314                         &descriptor->wHubCharacteristics)),
 315                         &hub->desc.wHubCharacteristics);
 316         /* set the bitmap */
 317         bitmap = (unsigned char *)&hub->desc.DeviceRemovable[0];
 318         /* devices not removable by default */
 319         memset(bitmap, 0xff, (USB_MAXCHILDREN+1+7)/8);
 320         bitmap = (unsigned char *)&hub->desc.PortPowerCtrlMask[0];
 321         memset(bitmap, 0xff, (USB_MAXCHILDREN+1+7)/8); /* PowerMask = 1B */
 322
 323         for (i = 0; i < ((hub->desc.bNbrPorts + 1 + 7)/8); i++)
 324                 hub->desc.DeviceRemovable[i] = descriptor->DeviceRemovable[i];
 325
 326         for (i = 0; i < ((hub->desc.bNbrPorts + 1 + 7)/8); i++)
 327                 hub->desc.PortPowerCtrlMask[i] = descriptor->PortPowerCtrlMask[i];
 328
 329         dev->maxchild = descriptor->bNbrPorts;
 330         debug("%d ports detected\n", dev->maxchild);
 331
 332         hubCharacteristics = get_unaligned(&hub->desc.wHubCharacteristics);
 333         switch (hubCharacteristics & HUB_CHAR_LPSM) {
 334         case 0x00:
 335                 debug("ganged power switching\n");
 336                 break;
 337         case 0x01:
 338                 debug("individual port power switching\n");
 339                 break;
 340         case 0x02:
 341         case 0x03:
 342                 debug("unknown reserved power switching mode\n");
 343                 break;
 344         }
 345
 346         if (hubCharacteristics & HUB_CHAR_COMPOUND)
 347                 debug("part of a compound device\n");
 348         else
 349                 debug("standalone hub\n");
 350
 351         switch (hubCharacteristics & HUB_CHAR_OCPM) {
 352         case 0x00:
 353                 debug("global over-current protection\n");
 354                 break;
 355         case 0x08:
 356                 debug("individual port over-current protection\n");
 357                 break;
 358         case 0x10:
 359         case 0x18:
 360                 debug("no over-current protection\n");
 361                 break;
 362         }
 363
 364         debug("power on to power good time: %dms\n",
 365               descriptor->bPwrOn2PwrGood * 2);
 366         debug("hub controller current requirement: %dmA\n",
 367               descriptor->bHubContrCurrent);
 368
 369         for (i = 0; i < dev->maxchild; i++)
 370                 debug("port %d is%s removable\n", i + 1,
 371                       hub->desc.DeviceRemovable[(i + 1) / 8] & \
 372                       (1 << ((i + 1) % 8)) ? " not" : "");
 373
 374         if (sizeof(struct usb_hub_status) > USB_BUFSIZ) {
 375                 debug("usb_hub_configure: failed to get Status - " \
 376                       "too long: %d\n", descriptor->bLength);
 377                 return -1;
 378         }
 379
 380         if (usb_get_hub_status(dev, buffer) < 0) {
 381                 debug("usb_hub_configure: failed to get Status %lX\n",
 382                       dev->status);
 383                 return -1;
 384         }
 385
 386 #ifdef DEBUG
 387         hubsts = (struct usb_hub_status *)buffer;
 388 #endif
 389
 390         debug("get_hub_status returned status %X, change %X\n",
 391               le16_to_cpu(hubsts->wHubStatus),
 392               le16_to_cpu(hubsts->wHubChange));
 393         debug("local power source is %s\n",
 394               (le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_LOCAL_POWER) ? \
 395               "lost (inactive)" : "good");
 396         debug("%sover-current condition exists\n",
 397               (le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_OVERCURRENT) ? \
 398               "" : "no ");
 399         usb_hub_power_on(hub);
 400
 401         /*
 402          * Reset any devices that may be in a bad state when applying
 403          * the power.  This is a __weak function.  Resetting of the devices
 404          * should occur in the board file of the device.
 405          */
 406         for (i = 0; i < dev->maxchild; i++)
 407                 usb_hub_reset_devices(i + 1);
 408
 409         for (i = 0; i < dev->maxchild; i++) {
 410                 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
 411                 unsigned short portstatus, portchange;
 412                 int ret;
 413                 ulong start = get_timer(0);
 414
 415                 /*
 416                  * Wait for (whichever finishes first)
 417                  *  - A maximum of 10 seconds
 418                  *    This is a purely observational value driven by connecting
 419                  *    a few broken pen drives and taking the max * 1.5 approach
 420                  *  - connection_change and connection state to report same
 421                  *    state
 422                  */
 423                 do {
 424                         ret = usb_get_port_status(dev, i + 1, portsts);
 425                         if (ret < 0) {
 426                                 debug("get_port_status failed\n");
 427                                 break;
 428                         }
 429
 430                         portstatus = le16_to_cpu(portsts->wPortStatus);
 431                         portchange = le16_to_cpu(portsts->wPortChange);
 432
 433                         if ((portchange & USB_PORT_STAT_C_CONNECTION) ==
 434                                 (portstatus & USB_PORT_STAT_CONNECTION))
 435                                 break;
 436
 437                 } while (get_timer(start) < CONFIG_SYS_HZ * 10);
 438
 439                 if (ret < 0)
 440                         continue;
 441
 442                 debug("Port %d Status %X Change %X\n",
 443                       i + 1, portstatus, portchange);
 444
 445                 if (portchange & USB_PORT_STAT_C_CONNECTION) {
 446                         debug("port %d connection change\n", i + 1);
 447                         usb_hub_port_connect_change(dev, i);
 448                 }
 449                 if (portchange & USB_PORT_STAT_C_ENABLE) {
 450                         debug("port %d enable change, status %x\n",
 451                               i + 1, portstatus);
 452                         usb_clear_port_feature(dev, i + 1,
 453                                                 USB_PORT_FEAT_C_ENABLE);
 454                         /*
 455                          * The following hack causes a ghost device problem
 456                          * to Faraday EHCI
 457                          */
 458 #ifndef CONFIG_USB_EHCI_FARADAY
 459                         /* EM interference sometimes causes bad shielded USB
 460                          * devices to be shutdown by the hub, this hack enables
 461                          * them again. Works at least with mouse driver */
 462                         if (!(portstatus & USB_PORT_STAT_ENABLE) &&
 463                              (portstatus & USB_PORT_STAT_CONNECTION) &&
 464                              ((dev->children[i]))) {
 465                                 debug("already running port %i "  \
 466                                       "disabled by hub (EMI?), " \
 467                                       "re-enabling...\n", i + 1);
 468                                       usb_hub_port_connect_change(dev, i);
 469                         }
 470 #endif
 471                 }
 472                 if (portstatus & USB_PORT_STAT_SUSPEND) {
 473                         debug("port %d suspend change\n", i + 1);
 474                         usb_clear_port_feature(dev, i + 1,
 475                                                 USB_PORT_FEAT_SUSPEND);
 476                 }
 477
 478                 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
 479                         debug("port %d over-current change\n", i + 1);
 480                         usb_clear_port_feature(dev, i + 1,
 481                                                 USB_PORT_FEAT_C_OVER_CURRENT);
 482                         usb_hub_power_on(hub);
 483                 }
 484
 485                 if (portchange & USB_PORT_STAT_C_RESET) {
 486                         debug("port %d reset change\n", i + 1);
 487                         usb_clear_port_feature(dev, i + 1,
 488                                                 USB_PORT_FEAT_C_RESET);
 489                 }
 490         } /* end for i all ports */
 491
 492         return 0;
 493 }
 494
 495 int usb_hub_probe(struct usb_device *dev, int ifnum)
 496 {
 497         struct usb_interface *iface;
 498         struct usb_endpoint_descriptor *ep;
 499         int ret;
 500
 501         iface = &dev->config.if_desc[ifnum];
 502         /* Is it a hub? */
 503         if (iface->desc.bInterfaceClass != USB_CLASS_HUB)
 504                 return 0;
 505         /* Some hubs have a subclass of 1, which AFAICT according to the */
 506         /*  specs is not defined, but it works */
 507         if ((iface->desc.bInterfaceSubClass != 0) &&
 508             (iface->desc.bInterfaceSubClass != 1))
 509                 return 0;
 510         /* Multiple endpoints? What kind of mutant ninja-hub is this? */
 511         if (iface->desc.bNumEndpoints != 1)
 512                 return 0;
 513         ep = &iface->ep_desc[0];
 514         /* Output endpoint? Curiousier and curiousier.. */
 515         if (!(ep->bEndpointAddress & USB_DIR_IN))
 516                 return 0;
 517         /* If it's not an interrupt endpoint, we'd better punt! */
 518         if ((ep->bmAttributes & 3) != 3)
 519                 return 0;
 520         /* We found a hub */
 521         debug("USB hub found\n");
 522         ret = usb_hub_configure(dev);
 523         return ret;
 524 }