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