common/usb_hub.c

   1 /*
   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  * See file CREDITS for list of people who contributed to this
  19  * project.
  20  *
  21  * This program is free software; you can redistribute it and/or
  22  * modify it under the terms of the GNU General Public License as
  23  * published by the Free Software Foundation; either version 2 of
  24  * the License, or (at your option) any later version.
  25  *
  26  * This program is distributed in the hope that it will be useful,
  27  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  28  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  29  * GNU General Public License for more details.
  30  *
  31  * You should have received a copy of the GNU General Public License
  32  * along with this program; if not, write to the Free Software
  33  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  34  * MA 02111-1307 USA
  35  *
  36  */
  37
  38 /****************************************************************************
  39  * HUB "Driver"
  40  * Probes device for being a hub and configurate it
  41  */
  42
  43 #include <common.h>
  44 #include <command.h>
  45 #include <asm/processor.h>
  46 #include <asm/unaligned.h>
  47 #include <linux/ctype.h>
  48 #include <asm/byteorder.h>
  49 #include <asm/unaligned.h>
  50
  51 #include <usb.h>
  52 #ifdef CONFIG_4xx
  53 #include <asm/4xx_pci.h>
  54 #endif
  55
  56 #ifndef CONFIG_USB_HUB_MIN_POWER_ON_DELAY
  57 #define CONFIG_USB_HUB_MIN_POWER_ON_DELAY       100
  58 #endif
  59
  60 #define USB_BUFSIZ      512
  61
  62 static struct usb_hub_device hub_dev[USB_MAX_HUB];
  63 static int usb_hub_index;
  64
  65
  66 static int usb_get_hub_descriptor(struct usb_device *dev, void *data, int size)
  67 {
  68         return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
  69                 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
  70                 USB_DT_HUB << 8, 0, data, size, USB_CNTL_TIMEOUT);
  71 }
  72
  73 static int usb_clear_port_feature(struct usb_device *dev, int port, int feature)
  74 {
  75         return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
  76                                 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature,
  77                                 port, NULL, 0, USB_CNTL_TIMEOUT);
  78 }
  79
  80 static int usb_set_port_feature(struct usb_device *dev, int port, int feature)
  81 {
  82         return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
  83                                 USB_REQ_SET_FEATURE, USB_RT_PORT, feature,
  84                                 port, NULL, 0, USB_CNTL_TIMEOUT);
  85 }
  86
  87 static int usb_get_hub_status(struct usb_device *dev, void *data)
  88 {
  89         return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
  90                         USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
  91                         data, sizeof(struct usb_hub_status), USB_CNTL_TIMEOUT);
  92 }
  93
  94 static int usb_get_port_status(struct usb_device *dev, int port, void *data)
  95 {
  96         return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
  97                         USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port,
  98                         data, sizeof(struct usb_hub_status), USB_CNTL_TIMEOUT);
  99 }
 100
 101
 102 static void usb_hub_power_on(struct usb_hub_device *hub)
 103 {
 104         int i;
 105         struct usb_device *dev;
 106         unsigned pgood_delay = hub->desc.bPwrOn2PwrGood * 2;
 107         ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
 108         unsigned short portstatus;
 109         int ret;
 110
 111         dev = hub->pusb_dev;
 112
 113         /*
 114          * Enable power to the ports:
 115          * Here we Power-cycle the ports: aka,
 116          * turning them off and turning on again.
 117          */
 118         debug("enabling power on all ports\n");
 119         for (i = 0; i < dev->maxchild; i++) {
 120                 usb_clear_port_feature(dev, i + 1, USB_PORT_FEAT_POWER);
 121                 debug("port %d returns %lX\n", i + 1, dev->status);
 122         }
 123
 124         /* Wait at least 2*bPwrOn2PwrGood for PP to change */
 125         mdelay(pgood_delay);
 126
 127         for (i = 0; i < dev->maxchild; i++) {
 128                 ret = usb_get_port_status(dev, i + 1, portsts);
 129                 if (ret < 0) {
 130                         debug("port %d: get_port_status failed\n", i + 1);
 131                         return;
 132                 }
 133
 134                 /*
 135                  * Check to confirm the state of Port Power:
 136                  * xHCI says "After modifying PP, s/w shall read
 137                  * PP and confirm that it has reached the desired state
 138                  * before modifying it again, undefined behavior may occur
 139                  * if this procedure is not followed".
 140                  * EHCI doesn't say anything like this, but no harm in keeping
 141                  * this.
 142                  */
 143                 portstatus = le16_to_cpu(portsts->wPortStatus);
 144                 if (portstatus & (USB_PORT_STAT_POWER << 1)) {
 145                         debug("port %d: Port power change failed\n", i + 1);
 146                         return;
 147                 }
 148         }
 149
 150         for (i = 0; i < dev->maxchild; i++) {
 151                 usb_set_port_feature(dev, i + 1, USB_PORT_FEAT_POWER);
 152                 debug("port %d returns %lX\n", i + 1, dev->status);
 153         }
 154
 155         /* Wait for power to become stable */
 156         mdelay(max(pgood_delay, CONFIG_USB_HUB_MIN_POWER_ON_DELAY));
 157 }
 158
 159 void usb_hub_reset(void)
 160 {
 161         usb_hub_index = 0;
 162 }
 163
 164 static struct usb_hub_device *usb_hub_allocate(void)
 165 {
 166         if (usb_hub_index < USB_MAX_HUB)
 167                 return &hub_dev[usb_hub_index++];
 168
 169         printf("ERROR: USB_MAX_HUB (%d) reached\n", USB_MAX_HUB);
 170         return NULL;
 171 }
 172
 173 #define MAX_TRIES 5
 174
 175 static inline char *portspeed(int portstatus)
 176 {
 177         char *speed_str;
 178
 179         switch (portstatus & USB_PORT_STAT_SPEED_MASK) {
 180         case USB_PORT_STAT_SUPER_SPEED:
 181                 speed_str = "5 Gb/s";
 182                 break;
 183         case USB_PORT_STAT_HIGH_SPEED:
 184                 speed_str = "480 Mb/s";
 185                 break;
 186         case USB_PORT_STAT_LOW_SPEED:
 187                 speed_str = "1.5 Mb/s";
 188                 break;
 189         default:
 190                 speed_str = "12 Mb/s";
 191                 break;
 192         }
 193
 194         return speed_str;
 195 }
 196
 197 int hub_port_reset(struct usb_device *dev, int port,
 198                         unsigned short *portstat)
 199 {
 200         int tries;
 201         ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
 202         unsigned short portstatus, portchange;
 203
 204         debug("hub_port_reset: resetting port %d...\n", port);
 205         for (tries = 0; tries < MAX_TRIES; tries++) {
 206
 207                 usb_set_port_feature(dev, port + 1, USB_PORT_FEAT_RESET);
 208                 mdelay(200);
 209
 210                 if (usb_get_port_status(dev, port + 1, portsts) < 0) {
 211                         debug("get_port_status failed status %lX\n",
 212                               dev->status);
 213                         return -1;
 214                 }
 215                 portstatus = le16_to_cpu(portsts->wPortStatus);
 216                 portchange = le16_to_cpu(portsts->wPortChange);
 217
 218                 debug("portstatus %x, change %x, %s\n", portstatus, portchange,
 219                                                         portspeed(portstatus));
 220
 221                 debug("STAT_C_CONNECTION = %d STAT_CONNECTION = %d" \
 222                       "  USB_PORT_STAT_ENABLE %d\n",
 223                       (portchange & USB_PORT_STAT_C_CONNECTION) ? 1 : 0,
 224                       (portstatus & USB_PORT_STAT_CONNECTION) ? 1 : 0,
 225                       (portstatus & USB_PORT_STAT_ENABLE) ? 1 : 0);
 226
 227                 if ((portchange & USB_PORT_STAT_C_CONNECTION) ||
 228                     !(portstatus & USB_PORT_STAT_CONNECTION))
 229                         return -1;
 230
 231                 if (portstatus & USB_PORT_STAT_ENABLE)
 232                         break;
 233
 234                 mdelay(200);
 235         }
 236
 237         if (tries == MAX_TRIES) {
 238                 debug("Cannot enable port %i after %i retries, " \
 239                       "disabling port.\n", port + 1, MAX_TRIES);
 240                 debug("Maybe the USB cable is bad?\n");
 241                 return -1;
 242         }
 243
 244         usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_RESET);
 245         *portstat = portstatus;
 246         return 0;
 247 }
 248
 249
 250 void usb_hub_port_connect_change(struct usb_device *dev, int port)
 251 {
 252         struct usb_device *usb;
 253         ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
 254         unsigned short portstatus;
 255
 256         /* Check status */
 257         if (usb_get_port_status(dev, port + 1, portsts) < 0) {
 258                 debug("get_port_status failed\n");
 259                 return;
 260         }
 261
 262         portstatus = le16_to_cpu(portsts->wPortStatus);
 263         debug("portstatus %x, change %x, %s\n",
 264               portstatus,
 265               le16_to_cpu(portsts->wPortChange),
 266               portspeed(portstatus));
 267
 268         /* Clear the connection change status */
 269         usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_CONNECTION);
 270
 271         /* Disconnect any existing devices under this port */
 272         if (((!(portstatus & USB_PORT_STAT_CONNECTION)) &&
 273              (!(portstatus & USB_PORT_STAT_ENABLE))) || (dev->children[port])) {
 274                 debug("usb_disconnect(&hub->children[port]);\n");
 275                 /* Return now if nothing is connected */
 276                 if (!(portstatus & USB_PORT_STAT_CONNECTION))
 277                         return;
 278         }
 279         mdelay(200);
 280
 281         /* Reset the port */
 282         if (hub_port_reset(dev, port, &portstatus) < 0) {
 283                 printf("cannot reset port %i!?\n", port + 1);
 284                 return;
 285         }
 286
 287         mdelay(200);
 288
 289         /* Allocate a new device struct for it */
 290         usb = usb_alloc_new_device(dev->controller);
 291
 292         switch (portstatus & USB_PORT_STAT_SPEED_MASK) {
 293         case USB_PORT_STAT_SUPER_SPEED:
 294                 usb->speed = USB_SPEED_SUPER;
 295                 break;
 296         case USB_PORT_STAT_HIGH_SPEED:
 297                 usb->speed = USB_SPEED_HIGH;
 298                 break;
 299         case USB_PORT_STAT_LOW_SPEED:
 300                 usb->speed = USB_SPEED_LOW;
 301                 break;
 302         default:
 303                 usb->speed = USB_SPEED_FULL;
 304                 break;
 305         }
 306
 307         dev->children[port] = usb;
 308         usb->parent = dev;
 309         usb->portnr = port + 1;
 310         /* Run it through the hoops (find a driver, etc) */
 311         if (usb_new_device(usb)) {
 312                 /* Woops, disable the port */
 313                 usb_free_device();
 314                 dev->children[port] = NULL;
 315                 debug("hub: disabling port %d\n", port + 1);
 316                 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_ENABLE);
 317         }
 318 }
 319
 320
 321 static int usb_hub_configure(struct usb_device *dev)
 322 {
 323         int i;
 324         ALLOC_CACHE_ALIGN_BUFFER(unsigned char, buffer, USB_BUFSIZ);
 325         unsigned char *bitmap;
 326         short hubCharacteristics;
 327         struct usb_hub_descriptor *descriptor;
 328         struct usb_hub_device *hub;
 329         __maybe_unused struct usb_hub_status *hubsts;
 330
 331         /* "allocate" Hub device */
 332         hub = usb_hub_allocate();
 333         if (hub == NULL)
 334                 return -1;
 335         hub->pusb_dev = dev;
 336         /* Get the the hub descriptor */
 337         if (usb_get_hub_descriptor(dev, buffer, 4) < 0) {
 338                 debug("usb_hub_configure: failed to get hub " \
 339                       "descriptor, giving up %lX\n", dev->status);
 340                 return -1;
 341         }
 342         descriptor = (struct usb_hub_descriptor *)buffer;
 343
 344         /* silence compiler warning if USB_BUFSIZ is > 256 [= sizeof(char)] */
 345         i = descriptor->bLength;
 346         if (i > USB_BUFSIZ) {
 347                 debug("usb_hub_configure: failed to get hub " \
 348                       "descriptor - too long: %d\n", descriptor->bLength);
 349                 return -1;
 350         }
 351
 352         if (usb_get_hub_descriptor(dev, buffer, descriptor->bLength) < 0) {
 353                 debug("usb_hub_configure: failed to get hub " \
 354                       "descriptor 2nd giving up %lX\n", dev->status);
 355                 return -1;
 356         }
 357         memcpy((unsigned char *)&hub->desc, buffer, descriptor->bLength);
 358         /* adjust 16bit values */
 359         put_unaligned(le16_to_cpu(get_unaligned(
 360                         &descriptor->wHubCharacteristics)),
 361                         &hub->desc.wHubCharacteristics);
 362         /* set the bitmap */
 363         bitmap = (unsigned char *)&hub->desc.DeviceRemovable[0];
 364         /* devices not removable by default */
 365         memset(bitmap, 0xff, (USB_MAXCHILDREN+1+7)/8);
 366         bitmap = (unsigned char *)&hub->desc.PortPowerCtrlMask[0];
 367         memset(bitmap, 0xff, (USB_MAXCHILDREN+1+7)/8); /* PowerMask = 1B */
 368
 369         for (i = 0; i < ((hub->desc.bNbrPorts + 1 + 7)/8); i++)
 370                 hub->desc.DeviceRemovable[i] = descriptor->DeviceRemovable[i];
 371
 372         for (i = 0; i < ((hub->desc.bNbrPorts + 1 + 7)/8); i++)
 373                 hub->desc.PortPowerCtrlMask[i] = descriptor->PortPowerCtrlMask[i];
 374
 375         dev->maxchild = descriptor->bNbrPorts;
 376         debug("%d ports detected\n", dev->maxchild);
 377
 378         hubCharacteristics = get_unaligned(&hub->desc.wHubCharacteristics);
 379         switch (hubCharacteristics & HUB_CHAR_LPSM) {
 380         case 0x00:
 381                 debug("ganged power switching\n");
 382                 break;
 383         case 0x01:
 384                 debug("individual port power switching\n");
 385                 break;
 386         case 0x02:
 387         case 0x03:
 388                 debug("unknown reserved power switching mode\n");
 389                 break;
 390         }
 391
 392         if (hubCharacteristics & HUB_CHAR_COMPOUND)
 393                 debug("part of a compound device\n");
 394         else
 395                 debug("standalone hub\n");
 396
 397         switch (hubCharacteristics & HUB_CHAR_OCPM) {
 398         case 0x00:
 399                 debug("global over-current protection\n");
 400                 break;
 401         case 0x08:
 402                 debug("individual port over-current protection\n");
 403                 break;
 404         case 0x10:
 405         case 0x18:
 406                 debug("no over-current protection\n");
 407                 break;
 408         }
 409
 410         debug("power on to power good time: %dms\n",
 411               descriptor->bPwrOn2PwrGood * 2);
 412         debug("hub controller current requirement: %dmA\n",
 413               descriptor->bHubContrCurrent);
 414
 415         for (i = 0; i < dev->maxchild; i++)
 416                 debug("port %d is%s removable\n", i + 1,
 417                       hub->desc.DeviceRemovable[(i + 1) / 8] & \
 418                       (1 << ((i + 1) % 8)) ? " not" : "");
 419
 420         if (sizeof(struct usb_hub_status) > USB_BUFSIZ) {
 421                 debug("usb_hub_configure: failed to get Status - " \
 422                       "too long: %d\n", descriptor->bLength);
 423                 return -1;
 424         }
 425
 426         if (usb_get_hub_status(dev, buffer) < 0) {
 427                 debug("usb_hub_configure: failed to get Status %lX\n",
 428                       dev->status);
 429                 return -1;
 430         }
 431
 432 #ifdef DEBUG
 433         hubsts = (struct usb_hub_status *)buffer;
 434 #endif
 435
 436         debug("get_hub_status returned status %X, change %X\n",
 437               le16_to_cpu(hubsts->wHubStatus),
 438               le16_to_cpu(hubsts->wHubChange));
 439         debug("local power source is %s\n",
 440               (le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_LOCAL_POWER) ? \
 441               "lost (inactive)" : "good");
 442         debug("%sover-current condition exists\n",
 443               (le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_OVERCURRENT) ? \
 444               "" : "no ");
 445         usb_hub_power_on(hub);
 446
 447         for (i = 0; i < dev->maxchild; i++) {
 448                 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
 449                 unsigned short portstatus, portchange;
 450                 int ret;
 451                 ulong start = get_timer(0);
 452
 453                 /*
 454                  * Wait for (whichever finishes first)
 455                  *  - A maximum of 10 seconds
 456                  *    This is a purely observational value driven by connecting
 457                  *    a few broken pen drives and taking the max * 1.5 approach
 458                  *  - connection_change and connection state to report same
 459                  *    state
 460                  */
 461                 do {
 462                         ret = usb_get_port_status(dev, i + 1, portsts);
 463                         if (ret < 0) {
 464                                 debug("get_port_status failed\n");
 465                                 break;
 466                         }
 467
 468                         portstatus = le16_to_cpu(portsts->wPortStatus);
 469                         portchange = le16_to_cpu(portsts->wPortChange);
 470
 471                         if ((portchange & USB_PORT_STAT_C_CONNECTION) ==
 472                                 (portstatus & USB_PORT_STAT_CONNECTION))
 473                                 break;
 474
 475                 } while (get_timer(start) < CONFIG_SYS_HZ * 10);
 476
 477                 if (ret < 0)
 478                         continue;
 479
 480                 debug("Port %d Status %X Change %X\n",
 481                       i + 1, portstatus, portchange);
 482
 483                 if (portchange & USB_PORT_STAT_C_CONNECTION) {
 484                         debug("port %d connection change\n", i + 1);
 485                         usb_hub_port_connect_change(dev, i);
 486                 }
 487                 if (portchange & USB_PORT_STAT_C_ENABLE) {
 488                         debug("port %d enable change, status %x\n",
 489                               i + 1, portstatus);
 490                         usb_clear_port_feature(dev, i + 1,
 491                                                 USB_PORT_FEAT_C_ENABLE);
 492                         /*
 493                          * The following hack causes a ghost device problem
 494                          * to Faraday EHCI
 495                          */
 496 #ifndef CONFIG_USB_EHCI_FARADAY
 497                         /* EM interference sometimes causes bad shielded USB
 498                          * devices to be shutdown by the hub, this hack enables
 499                          * them again. Works at least with mouse driver */
 500                         if (!(portstatus & USB_PORT_STAT_ENABLE) &&
 501                              (portstatus & USB_PORT_STAT_CONNECTION) &&
 502                              ((dev->children[i]))) {
 503                                 debug("already running port %i "  \
 504                                       "disabled by hub (EMI?), " \
 505                                       "re-enabling...\n", i + 1);
 506                                       usb_hub_port_connect_change(dev, i);
 507                         }
 508 #endif
 509                 }
 510                 if (portstatus & USB_PORT_STAT_SUSPEND) {
 511                         debug("port %d suspend change\n", i + 1);
 512                         usb_clear_port_feature(dev, i + 1,
 513                                                 USB_PORT_FEAT_SUSPEND);
 514                 }
 515
 516                 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
 517                         debug("port %d over-current change\n", i + 1);
 518                         usb_clear_port_feature(dev, i + 1,
 519                                                 USB_PORT_FEAT_C_OVER_CURRENT);
 520                         usb_hub_power_on(hub);
 521                 }
 522
 523                 if (portchange & USB_PORT_STAT_C_RESET) {
 524                         debug("port %d reset change\n", i + 1);
 525                         usb_clear_port_feature(dev, i + 1,
 526                                                 USB_PORT_FEAT_C_RESET);
 527                 }
 528         } /* end for i all ports */
 529
 530         return 0;
 531 }
 532
 533 int usb_hub_probe(struct usb_device *dev, int ifnum)
 534 {
 535         struct usb_interface *iface;
 536         struct usb_endpoint_descriptor *ep;
 537         int ret;
 538
 539         iface = &dev->config.if_desc[ifnum];
 540         /* Is it a hub? */
 541         if (iface->desc.bInterfaceClass != USB_CLASS_HUB)
 542                 return 0;
 543         /* Some hubs have a subclass of 1, which AFAICT according to the */
 544         /*  specs is not defined, but it works */
 545         if ((iface->desc.bInterfaceSubClass != 0) &&
 546             (iface->desc.bInterfaceSubClass != 1))
 547                 return 0;
 548         /* Multiple endpoints? What kind of mutant ninja-hub is this? */
 549         if (iface->desc.bNumEndpoints != 1)
 550                 return 0;
 551         ep = &iface->ep_desc[0];
 552         /* Output endpoint? Curiousier and curiousier.. */
 553         if (!(ep->bEndpointAddress & USB_DIR_IN))
 554                 return 0;
 555         /* If it's not an interrupt endpoint, we'd better punt! */
 556         if ((ep->bmAttributes & 3) != 3)
 557                 return 0;
 558         /* We found a hub */
 559         debug("USB hub found\n");
 560         ret = usb_hub_configure(dev);
 561         return ret;
 562 }