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