drivers/usb/core/hcd.c

   1 /*
   2  * (C) Copyright Linus Torvalds 1999
   3  * (C) Copyright Johannes Erdfelt 1999-2001
   4  * (C) Copyright Andreas Gal 1999
   5  * (C) Copyright Gregory P. Smith 1999
   6  * (C) Copyright Deti Fliegl 1999
   7  * (C) Copyright Randy Dunlap 2000
   8  * (C) Copyright David Brownell 2000-2002
   9  *
  10  * This program is free software; you can redistribute it and/or modify it
  11  * under the terms of the GNU General Public License as published by the
  12  * Free Software Foundation; either version 2 of the License, or (at your
  13  * option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful, but
  16  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  17  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  18  * for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software Foundation,
  22  * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  23  */
  24
  25 #include <linux/module.h>
  26 #include <linux/version.h>
  27 #include <linux/kernel.h>
  28 #include <linux/slab.h>
  29 #include <linux/completion.h>
  30 #include <linux/utsname.h>
  31 #include <linux/mm.h>
  32 #include <asm/io.h>
  33 #include <asm/scatterlist.h>
  34 #include <linux/device.h>
  35 #include <linux/dma-mapping.h>
  36 #include <linux/mutex.h>
  37 #include <asm/irq.h>
  38 #include <asm/byteorder.h>
  39 #include <linux/platform_device.h>
  40
  41 #include <linux/usb.h>
  42
  43 #include "usb.h"
  44 #include "hcd.h"
  45 #include "hub.h"
  46
  47
  48 /*-------------------------------------------------------------------------*/
  49
  50 /*
  51  * USB Host Controller Driver framework
  52  *
  53  * Plugs into usbcore (usb_bus) and lets HCDs share code, minimizing
  54  * HCD-specific behaviors/bugs.
  55  *
  56  * This does error checks, tracks devices and urbs, and delegates to a
  57  * "hc_driver" only for code (and data) that really needs to know about
  58  * hardware differences.  That includes root hub registers, i/o queues,
  59  * and so on ... but as little else as possible.
  60  *
  61  * Shared code includes most of the "root hub" code (these are emulated,
  62  * though each HC's hardware works differently) and PCI glue, plus request
  63  * tracking overhead.  The HCD code should only block on spinlocks or on
  64  * hardware handshaking; blocking on software events (such as other kernel
  65  * threads releasing resources, or completing actions) is all generic.
  66  *
  67  * Happens the USB 2.0 spec says this would be invisible inside the "USBD",
  68  * and includes mostly a "HCDI" (HCD Interface) along with some APIs used
  69  * only by the hub driver ... and that neither should be seen or used by
  70  * usb client device drivers.
  71  *
  72  * Contributors of ideas or unattributed patches include: David Brownell,
  73  * Roman Weissgaerber, Rory Bolt, Greg Kroah-Hartman, ...
  74  *
  75  * HISTORY:
  76  * 2002-02-21   Pull in most of the usb_bus support from usb.c; some
  77  *              associated cleanup.  "usb_hcd" still != "usb_bus".
  78  * 2001-12-12   Initial patch version for Linux 2.5.1 kernel.
  79  */
  80
  81 /*-------------------------------------------------------------------------*/
  82
  83 /* host controllers we manage */
  84 LIST_HEAD (usb_bus_list);
  85 EXPORT_SYMBOL_GPL (usb_bus_list);
  86
  87 /* used when allocating bus numbers */
  88 #define USB_MAXBUS              64
  89 struct usb_busmap {
  90         unsigned long busmap [USB_MAXBUS / (8*sizeof (unsigned long))];
  91 };
  92 static struct usb_busmap busmap;
  93
  94 /* used when updating list of hcds */
  95 DEFINE_MUTEX(usb_bus_list_lock);        /* exported only for usbfs */
  96 EXPORT_SYMBOL_GPL (usb_bus_list_lock);
  97
  98 /* used for controlling access to virtual root hubs */
  99 static DEFINE_SPINLOCK(hcd_root_hub_lock);
 100
 101 /* used when updating hcd data */
 102 static DEFINE_SPINLOCK(hcd_data_lock);
 103
 104 /* wait queue for synchronous unlinks */
 105 DECLARE_WAIT_QUEUE_HEAD(usb_kill_urb_queue);
 106
 107 /*-------------------------------------------------------------------------*/
 108
 109 /*
 110  * Sharable chunks of root hub code.
 111  */
 112
 113 /*-------------------------------------------------------------------------*/
 114
 115 #define KERNEL_REL      ((LINUX_VERSION_CODE >> 16) & 0x0ff)
 116 #define KERNEL_VER      ((LINUX_VERSION_CODE >> 8) & 0x0ff)
 117
 118 /* usb 2.0 root hub device descriptor */
 119 static const u8 usb2_rh_dev_descriptor [18] = {
 120         0x12,       /*  __u8  bLength; */
 121         0x01,       /*  __u8  bDescriptorType; Device */
 122         0x00, 0x02, /*  __le16 bcdUSB; v2.0 */
 123
 124         0x09,       /*  __u8  bDeviceClass; HUB_CLASSCODE */
 125         0x00,       /*  __u8  bDeviceSubClass; */
 126         0x01,       /*  __u8  bDeviceProtocol; [ usb 2.0 single TT ]*/
 127         0x40,       /*  __u8  bMaxPacketSize0; 64 Bytes */
 128
 129         0x00, 0x00, /*  __le16 idVendor; */
 130         0x00, 0x00, /*  __le16 idProduct; */
 131         KERNEL_VER, KERNEL_REL, /*  __le16 bcdDevice */
 132
 133         0x03,       /*  __u8  iManufacturer; */
 134         0x02,       /*  __u8  iProduct; */
 135         0x01,       /*  __u8  iSerialNumber; */
 136         0x01        /*  __u8  bNumConfigurations; */
 137 };
 138
 139 /* no usb 2.0 root hub "device qualifier" descriptor: one speed only */
 140
 141 /* usb 1.1 root hub device descriptor */
 142 static const u8 usb11_rh_dev_descriptor [18] = {
 143         0x12,       /*  __u8  bLength; */
 144         0x01,       /*  __u8  bDescriptorType; Device */
 145         0x10, 0x01, /*  __le16 bcdUSB; v1.1 */
 146
 147         0x09,       /*  __u8  bDeviceClass; HUB_CLASSCODE */
 148         0x00,       /*  __u8  bDeviceSubClass; */
 149         0x00,       /*  __u8  bDeviceProtocol; [ low/full speeds only ] */
 150         0x40,       /*  __u8  bMaxPacketSize0; 64 Bytes */
 151
 152         0x00, 0x00, /*  __le16 idVendor; */
 153         0x00, 0x00, /*  __le16 idProduct; */
 154         KERNEL_VER, KERNEL_REL, /*  __le16 bcdDevice */
 155
 156         0x03,       /*  __u8  iManufacturer; */
 157         0x02,       /*  __u8  iProduct; */
 158         0x01,       /*  __u8  iSerialNumber; */
 159         0x01        /*  __u8  bNumConfigurations; */
 160 };
 161
 162
 163 /*-------------------------------------------------------------------------*/
 164
 165 /* Configuration descriptors for our root hubs */
 166
 167 static const u8 fs_rh_config_descriptor [] = {
 168
 169         /* one configuration */
 170         0x09,       /*  __u8  bLength; */
 171         0x02,       /*  __u8  bDescriptorType; Configuration */
 172         0x19, 0x00, /*  __le16 wTotalLength; */
 173         0x01,       /*  __u8  bNumInterfaces; (1) */
 174         0x01,       /*  __u8  bConfigurationValue; */
 175         0x00,       /*  __u8  iConfiguration; */
 176         0xc0,       /*  __u8  bmAttributes;
 177                                  Bit 7: must be set,
 178                                      6: Self-powered,
 179                                      5: Remote wakeup,
 180                                      4..0: resvd */
 181         0x00,       /*  __u8  MaxPower; */
 182
 183         /* USB 1.1:
 184          * USB 2.0, single TT organization (mandatory):
 185          *      one interface, protocol 0
 186          *
 187          * USB 2.0, multiple TT organization (optional):
 188          *      two interfaces, protocols 1 (like single TT)
 189          *      and 2 (multiple TT mode) ... config is
 190          *      sometimes settable
 191          *      NOT IMPLEMENTED
 192          */
 193
 194         /* one interface */
 195         0x09,       /*  __u8  if_bLength; */
 196         0x04,       /*  __u8  if_bDescriptorType; Interface */
 197         0x00,       /*  __u8  if_bInterfaceNumber; */
 198         0x00,       /*  __u8  if_bAlternateSetting; */
 199         0x01,       /*  __u8  if_bNumEndpoints; */
 200         0x09,       /*  __u8  if_bInterfaceClass; HUB_CLASSCODE */
 201         0x00,       /*  __u8  if_bInterfaceSubClass; */
 202         0x00,       /*  __u8  if_bInterfaceProtocol; [usb1.1 or single tt] */
 203         0x00,       /*  __u8  if_iInterface; */
 204
 205         /* one endpoint (status change endpoint) */
 206         0x07,       /*  __u8  ep_bLength; */
 207         0x05,       /*  __u8  ep_bDescriptorType; Endpoint */
 208         0x81,       /*  __u8  ep_bEndpointAddress; IN Endpoint 1 */
 209         0x03,       /*  __u8  ep_bmAttributes; Interrupt */
 210         0x02, 0x00, /*  __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8) */
 211         0xff        /*  __u8  ep_bInterval; (255ms -- usb 2.0 spec) */
 212 };
 213
 214 static const u8 hs_rh_config_descriptor [] = {
 215
 216         /* one configuration */
 217         0x09,       /*  __u8  bLength; */
 218         0x02,       /*  __u8  bDescriptorType; Configuration */
 219         0x19, 0x00, /*  __le16 wTotalLength; */
 220         0x01,       /*  __u8  bNumInterfaces; (1) */
 221         0x01,       /*  __u8  bConfigurationValue; */
 222         0x00,       /*  __u8  iConfiguration; */
 223         0xc0,       /*  __u8  bmAttributes;
 224                                  Bit 7: must be set,
 225                                      6: Self-powered,
 226                                      5: Remote wakeup,
 227                                      4..0: resvd */
 228         0x00,       /*  __u8  MaxPower; */
 229
 230         /* USB 1.1:
 231          * USB 2.0, single TT organization (mandatory):
 232          *      one interface, protocol 0
 233          *
 234          * USB 2.0, multiple TT organization (optional):
 235          *      two interfaces, protocols 1 (like single TT)
 236          *      and 2 (multiple TT mode) ... config is
 237          *      sometimes settable
 238          *      NOT IMPLEMENTED
 239          */
 240
 241         /* one interface */
 242         0x09,       /*  __u8  if_bLength; */
 243         0x04,       /*  __u8  if_bDescriptorType; Interface */
 244         0x00,       /*  __u8  if_bInterfaceNumber; */
 245         0x00,       /*  __u8  if_bAlternateSetting; */
 246         0x01,       /*  __u8  if_bNumEndpoints; */
 247         0x09,       /*  __u8  if_bInterfaceClass; HUB_CLASSCODE */
 248         0x00,       /*  __u8  if_bInterfaceSubClass; */
 249         0x00,       /*  __u8  if_bInterfaceProtocol; [usb1.1 or single tt] */
 250         0x00,       /*  __u8  if_iInterface; */
 251
 252         /* one endpoint (status change endpoint) */
 253         0x07,       /*  __u8  ep_bLength; */
 254         0x05,       /*  __u8  ep_bDescriptorType; Endpoint */
 255         0x81,       /*  __u8  ep_bEndpointAddress; IN Endpoint 1 */
 256         0x03,       /*  __u8  ep_bmAttributes; Interrupt */
 257                     /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8)
 258                      * see hub.c:hub_configure() for details. */
 259         (USB_MAXCHILDREN + 1 + 7) / 8, 0x00,
 260         0x0c        /*  __u8  ep_bInterval; (256ms -- usb 2.0 spec) */
 261 };
 262
 263 /*-------------------------------------------------------------------------*/
 264
 265 /*
 266  * helper routine for returning string descriptors in UTF-16LE
 267  * input can actually be ISO-8859-1; ASCII is its 7-bit subset
 268  */
 269 static int ascii2utf (char *s, u8 *utf, int utfmax)
 270 {
 271         int retval;
 272
 273         for (retval = 0; *s && utfmax > 1; utfmax -= 2, retval += 2) {
 274                 *utf++ = *s++;
 275                 *utf++ = 0;
 276         }
 277         if (utfmax > 0) {
 278                 *utf = *s;
 279                 ++retval;
 280         }
 281         return retval;
 282 }
 283
 284 /*
 285  * rh_string - provides manufacturer, product and serial strings for root hub
 286  * @id: the string ID number (1: serial number, 2: product, 3: vendor)
 287  * @hcd: the host controller for this root hub
 288  * @type: string describing our driver
 289  * @data: return packet in UTF-16 LE
 290  * @len: length of the return packet
 291  *
 292  * Produces either a manufacturer, product or serial number string for the
 293  * virtual root hub device.
 294  */
 295 static int rh_string (
 296         int             id,
 297         struct usb_hcd  *hcd,
 298         u8              *data,
 299         int             len
 300 ) {
 301         char buf [100];
 302
 303         // language ids
 304         if (id == 0) {
 305                 buf[0] = 4;    buf[1] = 3;      /* 4 bytes string data */
 306                 buf[2] = 0x09; buf[3] = 0x04;   /* MSFT-speak for "en-us" */
 307                 len = min (len, 4);
 308                 memcpy (data, buf, len);
 309                 return len;
 310
 311         // serial number
 312         } else if (id == 1) {
 313                 strlcpy (buf, hcd->self.bus_name, sizeof buf);
 314
 315         // product description
 316         } else if (id == 2) {
 317                 strlcpy (buf, hcd->product_desc, sizeof buf);
 318
 319         // id 3 == vendor description
 320         } else if (id == 3) {
 321                 snprintf (buf, sizeof buf, "%s %s %s", init_utsname()->sysname,
 322                         init_utsname()->release, hcd->driver->description);
 323
 324         // unsupported IDs --> "protocol stall"
 325         } else
 326                 return -EPIPE;
 327
 328         switch (len) {          /* All cases fall through */
 329         default:
 330                 len = 2 + ascii2utf (buf, data + 2, len - 2);
 331         case 2:
 332                 data [1] = 3;   /* type == string */
 333         case 1:
 334                 data [0] = 2 * (strlen (buf) + 1);
 335         case 0:
 336                 ;               /* Compiler wants a statement here */
 337         }
 338         return len;
 339 }
 340
 341
 342 /* Root hub control transfers execute synchronously */
 343 static int rh_call_control (struct usb_hcd *hcd, struct urb *urb)
 344 {
 345         struct usb_ctrlrequest *cmd;
 346         u16             typeReq, wValue, wIndex, wLength;
 347         u8              *ubuf = urb->transfer_buffer;
 348         u8              tbuf [sizeof (struct usb_hub_descriptor)]
 349                 __attribute__((aligned(4)));
 350         const u8        *bufp = tbuf;
 351         int             len = 0;
 352         int             patch_wakeup = 0;
 353         unsigned long   flags;
 354         int             status = 0;
 355         int             n;
 356
 357         cmd = (struct usb_ctrlrequest *) urb->setup_packet;
 358         typeReq  = (cmd->bRequestType << 8) | cmd->bRequest;
 359         wValue   = le16_to_cpu (cmd->wValue);
 360         wIndex   = le16_to_cpu (cmd->wIndex);
 361         wLength  = le16_to_cpu (cmd->wLength);
 362
 363         if (wLength > urb->transfer_buffer_length)
 364                 goto error;
 365
 366         urb->actual_length = 0;
 367         switch (typeReq) {
 368
 369         /* DEVICE REQUESTS */
 370
 371         /* The root hub's remote wakeup enable bit is implemented using
 372          * driver model wakeup flags.  If this system supports wakeup
 373          * through USB, userspace may change the default "allow wakeup"
 374          * policy through sysfs or these calls.
 375          *
 376          * Most root hubs support wakeup from downstream devices, for
 377          * runtime power management (disabling USB clocks and reducing
 378          * VBUS power usage).  However, not all of them do so; silicon,
 379          * board, and BIOS bugs here are not uncommon, so these can't
 380          * be treated quite like external hubs.
 381          *
 382          * Likewise, not all root hubs will pass wakeup events upstream,
 383          * to wake up the whole system.  So don't assume root hub and
 384          * controller capabilities are identical.
 385          */
 386
 387         case DeviceRequest | USB_REQ_GET_STATUS:
 388                 tbuf [0] = (device_may_wakeup(&hcd->self.root_hub->dev)
 389                                         << USB_DEVICE_REMOTE_WAKEUP)
 390                                 | (1 << USB_DEVICE_SELF_POWERED);
 391                 tbuf [1] = 0;
 392                 len = 2;
 393                 break;
 394         case DeviceOutRequest | USB_REQ_CLEAR_FEATURE:
 395                 if (wValue == USB_DEVICE_REMOTE_WAKEUP)
 396                         device_set_wakeup_enable(&hcd->self.root_hub->dev, 0);
 397                 else
 398                         goto error;
 399                 break;
 400         case DeviceOutRequest | USB_REQ_SET_FEATURE:
 401                 if (device_can_wakeup(&hcd->self.root_hub->dev)
 402                                 && wValue == USB_DEVICE_REMOTE_WAKEUP)
 403                         device_set_wakeup_enable(&hcd->self.root_hub->dev, 1);
 404                 else
 405                         goto error;
 406                 break;
 407         case DeviceRequest | USB_REQ_GET_CONFIGURATION:
 408                 tbuf [0] = 1;
 409                 len = 1;
 410                         /* FALLTHROUGH */
 411         case DeviceOutRequest | USB_REQ_SET_CONFIGURATION:
 412                 break;
 413         case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
 414                 switch (wValue & 0xff00) {
 415                 case USB_DT_DEVICE << 8:
 416                         if (hcd->driver->flags & HCD_USB2)
 417                                 bufp = usb2_rh_dev_descriptor;
 418                         else if (hcd->driver->flags & HCD_USB11)
 419                                 bufp = usb11_rh_dev_descriptor;
 420                         else
 421                                 goto error;
 422                         len = 18;
 423                         break;
 424                 case USB_DT_CONFIG << 8:
 425                         if (hcd->driver->flags & HCD_USB2) {
 426                                 bufp = hs_rh_config_descriptor;
 427                                 len = sizeof hs_rh_config_descriptor;
 428                         } else {
 429                                 bufp = fs_rh_config_descriptor;
 430                                 len = sizeof fs_rh_config_descriptor;
 431                         }
 432                         if (device_can_wakeup(&hcd->self.root_hub->dev))
 433                                 patch_wakeup = 1;
 434                         break;
 435                 case USB_DT_STRING << 8:
 436                         n = rh_string (wValue & 0xff, hcd, ubuf, wLength);
 437                         if (n < 0)
 438                                 goto error;
 439                         urb->actual_length = n;
 440                         break;
 441                 default:
 442                         goto error;
 443                 }
 444                 break;
 445         case DeviceRequest | USB_REQ_GET_INTERFACE:
 446                 tbuf [0] = 0;
 447                 len = 1;
 448                         /* FALLTHROUGH */
 449         case DeviceOutRequest | USB_REQ_SET_INTERFACE:
 450                 break;
 451         case DeviceOutRequest | USB_REQ_SET_ADDRESS:
 452                 // wValue == urb->dev->devaddr
 453                 dev_dbg (hcd->self.controller, "root hub device address %d\n",
 454                         wValue);
 455                 break;
 456
 457         /* INTERFACE REQUESTS (no defined feature/status flags) */
 458
 459         /* ENDPOINT REQUESTS */
 460
 461         case EndpointRequest | USB_REQ_GET_STATUS:
 462                 // ENDPOINT_HALT flag
 463                 tbuf [0] = 0;
 464                 tbuf [1] = 0;
 465                 len = 2;
 466                         /* FALLTHROUGH */
 467         case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
 468         case EndpointOutRequest | USB_REQ_SET_FEATURE:
 469                 dev_dbg (hcd->self.controller, "no endpoint features yet\n");
 470                 break;
 471
 472         /* CLASS REQUESTS (and errors) */
 473
 474         default:
 475                 /* non-generic request */
 476                 switch (typeReq) {
 477                 case GetHubStatus:
 478                 case GetPortStatus:
 479                         len = 4;
 480                         break;
 481                 case GetHubDescriptor:
 482                         len = sizeof (struct usb_hub_descriptor);
 483                         break;
 484                 }
 485                 status = hcd->driver->hub_control (hcd,
 486                         typeReq, wValue, wIndex,
 487                         tbuf, wLength);
 488                 break;
 489 error:
 490                 /* "protocol stall" on error */
 491                 status = -EPIPE;
 492         }
 493
 494         if (status) {
 495                 len = 0;
 496                 if (status != -EPIPE) {
 497                         dev_dbg (hcd->self.controller,
 498                                 "CTRL: TypeReq=0x%x val=0x%x "
 499                                 "idx=0x%x len=%d ==> %d\n",
 500                                 typeReq, wValue, wIndex,
 501                                 wLength, status);
 502                 }
 503         }
 504         if (len) {
 505                 if (urb->transfer_buffer_length < len)
 506                         len = urb->transfer_buffer_length;
 507                 urb->actual_length = len;
 508                 // always USB_DIR_IN, toward host
 509                 memcpy (ubuf, bufp, len);
 510
 511                 /* report whether RH hardware supports remote wakeup */
 512                 if (patch_wakeup &&
 513                                 len > offsetof (struct usb_config_descriptor,
 514                                                 bmAttributes))
 515                         ((struct usb_config_descriptor *)ubuf)->bmAttributes
 516                                 |= USB_CONFIG_ATT_WAKEUP;
 517         }
 518
 519         /* any errors get returned through the urb completion */
 520         local_irq_save (flags);
 521         spin_lock (&urb->lock);
 522         if (urb->status == -EINPROGRESS)
 523                 urb->status = status;
 524         spin_unlock (&urb->lock);
 525         usb_hcd_giveback_urb (hcd, urb);
 526         local_irq_restore (flags);
 527         return 0;
 528 }
 529
 530 /*-------------------------------------------------------------------------*/
 531
 532 /*
 533  * Root Hub interrupt transfers are polled using a timer if the
 534  * driver requests it; otherwise the driver is responsible for
 535  * calling usb_hcd_poll_rh_status() when an event occurs.
 536  *
 537  * Completions are called in_interrupt(), but they may or may not
 538  * be in_irq().
 539  */
 540 void usb_hcd_poll_rh_status(struct usb_hcd *hcd)
 541 {
 542         struct urb      *urb;
 543         int             length;
 544         unsigned long   flags;
 545         char            buffer[4];      /* Any root hubs with > 31 ports? */
 546
 547         if (!hcd->uses_new_polling && !hcd->status_urb)
 548                 return;
 549
 550         length = hcd->driver->hub_status_data(hcd, buffer);
 551         if (length > 0) {
 552
 553                 /* try to complete the status urb */
 554                 local_irq_save (flags);
 555                 spin_lock(&hcd_root_hub_lock);
 556                 urb = hcd->status_urb;
 557                 if (urb) {
 558                         spin_lock(&urb->lock);
 559                         if (urb->status == -EINPROGRESS) {
 560                                 hcd->poll_pending = 0;
 561                                 hcd->status_urb = NULL;
 562                                 urb->status = 0;
 563                                 urb->hcpriv = NULL;
 564                                 urb->actual_length = length;
 565                                 memcpy(urb->transfer_buffer, buffer, length);
 566                         } else          /* urb has been unlinked */
 567                                 length = 0;
 568                         spin_unlock(&urb->lock);
 569                 } else
 570                         length = 0;
 571                 spin_unlock(&hcd_root_hub_lock);
 572
 573                 /* local irqs are always blocked in completions */
 574                 if (length > 0)
 575                         usb_hcd_giveback_urb (hcd, urb);
 576                 else
 577                         hcd->poll_pending = 1;
 578                 local_irq_restore (flags);
 579         }
 580
 581         /* The USB 2.0 spec says 256 ms.  This is close enough and won't
 582          * exceed that limit if HZ is 100. */
 583         if (hcd->uses_new_polling ? hcd->poll_rh :
 584                         (length == 0 && hcd->status_urb != NULL))
 585                 mod_timer (&hcd->rh_timer, jiffies + msecs_to_jiffies(250));
 586 }
 587 EXPORT_SYMBOL_GPL(usb_hcd_poll_rh_status);
 588
 589 /* timer callback */
 590 static void rh_timer_func (unsigned long _hcd)
 591 {
 592         usb_hcd_poll_rh_status((struct usb_hcd *) _hcd);
 593 }
 594
 595 /*-------------------------------------------------------------------------*/
 596
 597 static int rh_queue_status (struct usb_hcd *hcd, struct urb *urb)
 598 {
 599         int             retval;
 600         unsigned long   flags;
 601         int             len = 1 + (urb->dev->maxchild / 8);
 602
 603         spin_lock_irqsave (&hcd_root_hub_lock, flags);
 604         if (urb->status != -EINPROGRESS)        /* already unlinked */
 605                 retval = urb->status;
 606         else if (hcd->status_urb || urb->transfer_buffer_length < len) {
 607                 dev_dbg (hcd->self.controller, "not queuing rh status urb\n");
 608                 retval = -EINVAL;
 609         } else {
 610                 hcd->status_urb = urb;
 611                 urb->hcpriv = hcd;      /* indicate it's queued */
 612
 613                 if (!hcd->uses_new_polling)
 614                         mod_timer (&hcd->rh_timer, jiffies +
 615                                         msecs_to_jiffies(250));
 616
 617                 /* If a status change has already occurred, report it ASAP */
 618                 else if (hcd->poll_pending)
 619                         mod_timer (&hcd->rh_timer, jiffies);
 620                 retval = 0;
 621         }
 622         spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
 623         return retval;
 624 }
 625
 626 static int rh_urb_enqueue (struct usb_hcd *hcd, struct urb *urb)
 627 {
 628         if (usb_pipeint (urb->pipe))
 629                 return rh_queue_status (hcd, urb);
 630         if (usb_pipecontrol (urb->pipe))
 631                 return rh_call_control (hcd, urb);
 632         return -EINVAL;
 633 }
 634
 635 /*-------------------------------------------------------------------------*/
 636
 637 /* Unlinks of root-hub control URBs are legal, but they don't do anything
 638  * since these URBs always execute synchronously.
 639  */
 640 static int usb_rh_urb_dequeue (struct usb_hcd *hcd, struct urb *urb)
 641 {
 642         unsigned long   flags;
 643
 644         if (usb_pipeendpoint(urb->pipe) == 0) { /* Control URB */
 645                 ;       /* Do nothing */
 646
 647         } else {                                /* Status URB */
 648                 if (!hcd->uses_new_polling)
 649                         del_timer (&hcd->rh_timer);
 650                 local_irq_save (flags);
 651                 spin_lock (&hcd_root_hub_lock);
 652                 if (urb == hcd->status_urb) {
 653                         hcd->status_urb = NULL;
 654                         urb->hcpriv = NULL;
 655                 } else
 656                         urb = NULL;             /* wasn't fully queued */
 657                 spin_unlock (&hcd_root_hub_lock);
 658                 if (urb)
 659                         usb_hcd_giveback_urb (hcd, urb);
 660                 local_irq_restore (flags);
 661         }
 662
 663         return 0;
 664 }
 665
 666 /*-------------------------------------------------------------------------*/
 667
 668 static struct class *usb_host_class;
 669
 670 int usb_host_init(void)
 671 {
 672         int retval = 0;
 673
 674         usb_host_class = class_create(THIS_MODULE, "usb_host");
 675         if (IS_ERR(usb_host_class))
 676                 retval = PTR_ERR(usb_host_class);
 677         return retval;
 678 }
 679
 680 void usb_host_cleanup(void)
 681 {
 682         class_destroy(usb_host_class);
 683 }
 684
 685 /**
 686  * usb_bus_init - shared initialization code
 687  * @bus: the bus structure being initialized
 688  *
 689  * This code is used to initialize a usb_bus structure, memory for which is
 690  * separately managed.
 691  */
 692 static void usb_bus_init (struct usb_bus *bus)
 693 {
 694         memset (&bus->devmap, 0, sizeof(struct usb_devmap));
 695
 696         bus->devnum_next = 1;
 697
 698         bus->root_hub = NULL;
 699         bus->busnum = -1;
 700         bus->bandwidth_allocated = 0;
 701         bus->bandwidth_int_reqs  = 0;
 702         bus->bandwidth_isoc_reqs = 0;
 703
 704         INIT_LIST_HEAD (&bus->bus_list);
 705 }
 706
 707 /*-------------------------------------------------------------------------*/
 708
 709 /**
 710  * usb_register_bus - registers the USB host controller with the usb core
 711  * @bus: pointer to the bus to register
 712  * Context: !in_interrupt()
 713  *
 714  * Assigns a bus number, and links the controller into usbcore data
 715  * structures so that it can be seen by scanning the bus list.
 716  */
 717 static int usb_register_bus(struct usb_bus *bus)
 718 {
 719         int busnum;
 720
 721         mutex_lock(&usb_bus_list_lock);
 722         busnum = find_next_zero_bit (busmap.busmap, USB_MAXBUS, 1);
 723         if (busnum < USB_MAXBUS) {
 724                 set_bit (busnum, busmap.busmap);
 725                 bus->busnum = busnum;
 726         } else {
 727                 printk (KERN_ERR "%s: too many buses\n", usbcore_name);
 728                 mutex_unlock(&usb_bus_list_lock);
 729                 return -E2BIG;
 730         }
 731
 732         bus->class_dev = class_device_create(usb_host_class, NULL, MKDEV(0,0),
 733                                              bus->controller, "usb_host%d", busnum);
 734         if (IS_ERR(bus->class_dev)) {
 735                 clear_bit(busnum, busmap.busmap);
 736                 mutex_unlock(&usb_bus_list_lock);
 737                 return PTR_ERR(bus->class_dev);
 738         }
 739
 740         class_set_devdata(bus->class_dev, bus);
 741
 742         /* Add it to the local list of buses */
 743         list_add (&bus->bus_list, &usb_bus_list);
 744         mutex_unlock(&usb_bus_list_lock);
 745
 746         usb_notify_add_bus(bus);
 747
 748         dev_info (bus->controller, "new USB bus registered, assigned bus number %d\n", bus->busnum);
 749         return 0;
 750 }
 751
 752 /**
 753  * usb_deregister_bus - deregisters the USB host controller
 754  * @bus: pointer to the bus to deregister
 755  * Context: !in_interrupt()
 756  *
 757  * Recycles the bus number, and unlinks the controller from usbcore data
 758  * structures so that it won't be seen by scanning the bus list.
 759  */
 760 static void usb_deregister_bus (struct usb_bus *bus)
 761 {
 762         dev_info (bus->controller, "USB bus %d deregistered\n", bus->busnum);
 763
 764         /*
 765          * NOTE: make sure that all the devices are removed by the
 766          * controller code, as well as having it call this when cleaning
 767          * itself up
 768          */
 769         mutex_lock(&usb_bus_list_lock);
 770         list_del (&bus->bus_list);
 771         mutex_unlock(&usb_bus_list_lock);
 772
 773         usb_notify_remove_bus(bus);
 774
 775         clear_bit (bus->busnum, busmap.busmap);
 776
 777         class_device_unregister(bus->class_dev);
 778 }
 779
 780 /**
 781  * register_root_hub - called by usb_add_hcd() to register a root hub
 782  * @hcd: host controller for this root hub
 783  *
 784  * This function registers the root hub with the USB subsystem.  It sets up
 785  * the device properly in the device tree and then calls usb_new_device()
 786  * to register the usb device.  It also assigns the root hub's USB address
 787  * (always 1).
 788  */
 789 static int register_root_hub(struct usb_hcd *hcd)
 790 {
 791         struct device *parent_dev = hcd->self.controller;
 792         struct usb_device *usb_dev = hcd->self.root_hub;
 793         const int devnum = 1;
 794         int retval;
 795
 796         usb_dev->devnum = devnum;
 797         usb_dev->bus->devnum_next = devnum + 1;
 798         memset (&usb_dev->bus->devmap.devicemap, 0,
 799                         sizeof usb_dev->bus->devmap.devicemap);
 800         set_bit (devnum, usb_dev->bus->devmap.devicemap);
 801         usb_set_device_state(usb_dev, USB_STATE_ADDRESS);
 802
 803         mutex_lock(&usb_bus_list_lock);
 804
 805         usb_dev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
 806         retval = usb_get_device_descriptor(usb_dev, USB_DT_DEVICE_SIZE);
 807         if (retval != sizeof usb_dev->descriptor) {
 808                 mutex_unlock(&usb_bus_list_lock);
 809                 dev_dbg (parent_dev, "can't read %s device descriptor %d\n",
 810                                 usb_dev->dev.bus_id, retval);
 811                 return (retval < 0) ? retval : -EMSGSIZE;
 812         }
 813
 814         retval = usb_new_device (usb_dev);
 815         if (retval) {
 816                 dev_err (parent_dev, "can't register root hub for %s, %d\n",
 817                                 usb_dev->dev.bus_id, retval);
 818         }
 819         mutex_unlock(&usb_bus_list_lock);
 820
 821         if (retval == 0) {
 822                 spin_lock_irq (&hcd_root_hub_lock);
 823                 hcd->rh_registered = 1;
 824                 spin_unlock_irq (&hcd_root_hub_lock);
 825
 826                 /* Did the HC die before the root hub was registered? */
 827                 if (hcd->state == HC_STATE_HALT)
 828                         usb_hc_died (hcd);      /* This time clean up */
 829         }
 830
 831         return retval;
 832 }
 833
 834 void usb_enable_root_hub_irq (struct usb_bus *bus)
 835 {
 836         struct usb_hcd *hcd;
 837
 838         hcd = container_of (bus, struct usb_hcd, self);
 839         if (hcd->driver->hub_irq_enable && hcd->state != HC_STATE_HALT)
 840                 hcd->driver->hub_irq_enable (hcd);
 841 }
 842
 843
 844 /*-------------------------------------------------------------------------*/
 845
 846 /**
 847  * usb_calc_bus_time - approximate periodic transaction time in nanoseconds
 848  * @speed: from dev->speed; USB_SPEED_{LOW,FULL,HIGH}
 849  * @is_input: true iff the transaction sends data to the host
 850  * @isoc: true for isochronous transactions, false for interrupt ones
 851  * @bytecount: how many bytes in the transaction.
 852  *
 853  * Returns approximate bus time in nanoseconds for a periodic transaction.
 854  * See USB 2.0 spec section 5.11.3; only periodic transfers need to be
 855  * scheduled in software, this function is only used for such scheduling.
 856  */
 857 long usb_calc_bus_time (int speed, int is_input, int isoc, int bytecount)
 858 {
 859         unsigned long   tmp;
 860
 861         switch (speed) {
 862         case USB_SPEED_LOW:     /* INTR only */
 863                 if (is_input) {
 864                         tmp = (67667L * (31L + 10L * BitTime (bytecount))) / 1000L;
 865                         return (64060L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp);
 866                 } else {
 867                         tmp = (66700L * (31L + 10L * BitTime (bytecount))) / 1000L;
 868                         return (64107L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp);
 869                 }
 870         case USB_SPEED_FULL:    /* ISOC or INTR */
 871                 if (isoc) {
 872                         tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
 873                         return (((is_input) ? 7268L : 6265L) + BW_HOST_DELAY + tmp);
 874                 } else {
 875                         tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
 876                         return (9107L + BW_HOST_DELAY + tmp);
 877                 }
 878         case USB_SPEED_HIGH:    /* ISOC or INTR */
 879                 // FIXME adjust for input vs output
 880                 if (isoc)
 881                         tmp = HS_NSECS_ISO (bytecount);
 882                 else
 883                         tmp = HS_NSECS (bytecount);
 884                 return tmp;
 885         default:
 886                 pr_debug ("%s: bogus device speed!\n", usbcore_name);
 887                 return -1;
 888         }
 889 }
 890 EXPORT_SYMBOL (usb_calc_bus_time);
 891
 892
 893 /*-------------------------------------------------------------------------*/
 894
 895 /*
 896  * Generic HC operations.
 897  */
 898
 899 /*-------------------------------------------------------------------------*/
 900
 901 static void urb_unlink (struct urb *urb)
 902 {
 903         unsigned long           flags;
 904
 905         /* clear all state linking urb to this dev (and hcd) */
 906
 907         spin_lock_irqsave (&hcd_data_lock, flags);
 908         list_del_init (&urb->urb_list);
 909         spin_unlock_irqrestore (&hcd_data_lock, flags);
 910 }
 911
 912
 913 /* may be called in any context with a valid urb->dev usecount
 914  * caller surrenders "ownership" of urb
 915  * expects usb_submit_urb() to have sanity checked and conditioned all
 916  * inputs in the urb
 917  */
 918 int usb_hcd_submit_urb (struct urb *urb, gfp_t mem_flags)
 919 {
 920         int                     status;
 921         struct usb_hcd          *hcd = bus_to_hcd(urb->dev->bus);
 922         struct usb_host_endpoint *ep;
 923         unsigned long           flags;
 924
 925         if (!hcd)
 926                 return -ENODEV;
 927
 928         usbmon_urb_submit(&hcd->self, urb);
 929
 930         /*
 931          * Atomically queue the urb,  first to our records, then to the HCD.
 932          * Access to urb->status is controlled by urb->lock ... changes on
 933          * i/o completion (normal or fault) or unlinking.
 934          */
 935
 936         // FIXME:  verify that quiescing hc works right (RH cleans up)
 937
 938         spin_lock_irqsave (&hcd_data_lock, flags);
 939         ep = (usb_pipein(urb->pipe) ? urb->dev->ep_in : urb->dev->ep_out)
 940                         [usb_pipeendpoint(urb->pipe)];
 941         if (unlikely (!ep))
 942                 status = -ENOENT;
 943         else if (unlikely (urb->reject))
 944                 status = -EPERM;
 945         else switch (hcd->state) {
 946         case HC_STATE_RUNNING:
 947         case HC_STATE_RESUMING:
 948 doit:
 949                 list_add_tail (&urb->urb_list, &ep->urb_list);
 950                 status = 0;
 951                 break;
 952         case HC_STATE_SUSPENDED:
 953                 /* HC upstream links (register access, wakeup signaling) can work
 954                  * even when the downstream links (and DMA etc) are quiesced; let
 955                  * usbcore talk to the root hub.
 956                  */
 957                 if (hcd->self.controller->power.power_state.event == PM_EVENT_ON
 958                                 && urb->dev->parent == NULL)
 959                         goto doit;
 960                 /* FALL THROUGH */
 961         default:
 962                 status = -ESHUTDOWN;
 963                 break;
 964         }
 965         spin_unlock_irqrestore (&hcd_data_lock, flags);
 966         if (status) {
 967                 INIT_LIST_HEAD (&urb->urb_list);
 968                 usbmon_urb_submit_error(&hcd->self, urb, status);
 969                 return status;
 970         }
 971
 972         /* increment urb's reference count as part of giving it to the HCD
 973          * (which now controls it).  HCD guarantees that it either returns
 974          * an error or calls giveback(), but not both.
 975          */
 976         urb = usb_get_urb (urb);
 977         atomic_inc (&urb->use_count);
 978
 979         if (urb->dev == hcd->self.root_hub) {
 980                 /* NOTE:  requirement on hub callers (usbfs and the hub
 981                  * driver, for now) that URBs' urb->transfer_buffer be
 982                  * valid and usb_buffer_{sync,unmap}() not be needed, since
 983                  * they could clobber root hub response data.
 984                  */
 985                 status = rh_urb_enqueue (hcd, urb);
 986                 goto done;
 987         }
 988
 989         /* lower level hcd code should use *_dma exclusively,
 990          * unless it uses pio or talks to another transport.
 991          */
 992         if (hcd->self.uses_dma) {
 993                 if (usb_pipecontrol (urb->pipe)
 994                         && !(urb->transfer_flags & URB_NO_SETUP_DMA_MAP))
 995                         urb->setup_dma = dma_map_single (
 996                                         hcd->self.controller,
 997                                         urb->setup_packet,
 998                                         sizeof (struct usb_ctrlrequest),
 999                                         DMA_TO_DEVICE);
1000                 if (urb->transfer_buffer_length != 0
1001                         && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP))
1002                         urb->transfer_dma = dma_map_single (
1003                                         hcd->self.controller,
1004                                         urb->transfer_buffer,
1005                                         urb->transfer_buffer_length,
1006                                         usb_pipein (urb->pipe)
1007                                             ? DMA_FROM_DEVICE
1008                                             : DMA_TO_DEVICE);
1009         }
1010
1011         status = hcd->driver->urb_enqueue (hcd, ep, urb, mem_flags);
1012 done:
1013         if (unlikely (status)) {
1014                 urb_unlink (urb);
1015                 atomic_dec (&urb->use_count);
1016                 if (urb->reject)
1017                         wake_up (&usb_kill_urb_queue);
1018                 usb_put_urb (urb);
1019                 usbmon_urb_submit_error(&hcd->self, urb, status);
1020         }
1021         return status;
1022 }
1023
1024 /*-------------------------------------------------------------------------*/
1025
1026 /* called in any context */
1027 int usb_hcd_get_frame_number (struct usb_device *udev)
1028 {
1029         struct usb_hcd  *hcd = bus_to_hcd(udev->bus);
1030
1031         if (!HC_IS_RUNNING (hcd->state))
1032                 return -ESHUTDOWN;
1033         return hcd->driver->get_frame_number (hcd);
1034 }
1035
1036 /*-------------------------------------------------------------------------*/
1037
1038 /* this makes the hcd giveback() the urb more quickly, by kicking it
1039  * off hardware queues (which may take a while) and returning it as
1040  * soon as practical.  we've already set up the urb's return status,
1041  * but we can't know if the callback completed already.
1042  */
1043 static int
1044 unlink1 (struct usb_hcd *hcd, struct urb *urb)
1045 {
1046         int             value;
1047
1048         if (urb->dev == hcd->self.root_hub)
1049                 value = usb_rh_urb_dequeue (hcd, urb);
1050         else {
1051
1052                 /* The only reason an HCD might fail this call is if
1053                  * it has not yet fully queued the urb to begin with.
1054                  * Such failures should be harmless. */
1055                 value = hcd->driver->urb_dequeue (hcd, urb);
1056         }
1057
1058         if (value != 0)
1059                 dev_dbg (hcd->self.controller, "dequeue %p --> %d\n",
1060                                 urb, value);
1061         return value;
1062 }
1063
1064 /*
1065  * called in any context
1066  *
1067  * caller guarantees urb won't be recycled till both unlink()
1068  * and the urb's completion function return
1069  */
1070 int usb_hcd_unlink_urb (struct urb *urb, int status)
1071 {
1072         struct usb_host_endpoint        *ep;
1073         struct usb_hcd                  *hcd = NULL;
1074         struct device                   *sys = NULL;
1075         unsigned long                   flags;
1076         struct list_head                *tmp;
1077         int                             retval;
1078
1079         if (!urb)
1080                 return -EINVAL;
1081         if (!urb->dev || !urb->dev->bus)
1082                 return -ENODEV;
1083         ep = (usb_pipein(urb->pipe) ? urb->dev->ep_in : urb->dev->ep_out)
1084                         [usb_pipeendpoint(urb->pipe)];
1085         if (!ep)
1086                 return -ENODEV;
1087
1088         /*
1089          * we contend for urb->status with the hcd core,
1090          * which changes it while returning the urb.
1091          *
1092          * Caller guaranteed that the urb pointer hasn't been freed, and
1093          * that it was submitted.  But as a rule it can't know whether or
1094          * not it's already been unlinked ... so we respect the reversed
1095          * lock sequence needed for the usb_hcd_giveback_urb() code paths
1096          * (urb lock, then hcd_data_lock) in case some other CPU is now
1097          * unlinking it.
1098          */
1099         spin_lock_irqsave (&urb->lock, flags);
1100         spin_lock (&hcd_data_lock);
1101
1102         sys = &urb->dev->dev;
1103         hcd = bus_to_hcd(urb->dev->bus);
1104         if (hcd == NULL) {
1105                 retval = -ENODEV;
1106                 goto done;
1107         }
1108
1109         /* insist the urb is still queued */
1110         list_for_each(tmp, &ep->urb_list) {
1111                 if (tmp == &urb->urb_list)
1112                         break;
1113         }
1114         if (tmp != &urb->urb_list) {
1115                 retval = -EIDRM;
1116                 goto done;
1117         }
1118
1119         /* Any status except -EINPROGRESS means something already started to
1120          * unlink this URB from the hardware.  So there's no more work to do.
1121          */
1122         if (urb->status != -EINPROGRESS) {
1123                 retval = -EBUSY;
1124                 goto done;
1125         }
1126
1127         /* IRQ setup can easily be broken so that USB controllers
1128          * never get completion IRQs ... maybe even the ones we need to
1129          * finish unlinking the initial failed usb_set_address()
1130          * or device descriptor fetch.
1131          */
1132         if (!test_bit(HCD_FLAG_SAW_IRQ, &hcd->flags)
1133             && hcd->self.root_hub != urb->dev) {
1134                 dev_warn (hcd->self.controller, "Unlink after no-IRQ?  "
1135                         "Controller is probably using the wrong IRQ."
1136                         "\n");
1137                 set_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
1138         }
1139
1140         urb->status = status;
1141
1142         spin_unlock (&hcd_data_lock);
1143         spin_unlock_irqrestore (&urb->lock, flags);
1144
1145         retval = unlink1 (hcd, urb);
1146         if (retval == 0)
1147                 retval = -EINPROGRESS;
1148         return retval;
1149
1150 done:
1151         spin_unlock (&hcd_data_lock);
1152         spin_unlock_irqrestore (&urb->lock, flags);
1153         if (retval != -EIDRM && sys && sys->driver)
1154                 dev_dbg (sys, "hcd_unlink_urb %p fail %d\n", urb, retval);
1155         return retval;
1156 }
1157
1158 /*-------------------------------------------------------------------------*/
1159
1160 /* disables the endpoint: cancels any pending urbs, then synchronizes with
1161  * the hcd to make sure all endpoint state is gone from hardware, and then
1162  * waits until the endpoint's queue is completely drained. use for
1163  * set_configuration, set_interface, driver removal, physical disconnect.
1164  *
1165  * example:  a qh stored in ep->hcpriv, holding state related to endpoint
1166  * type, maxpacket size, toggle, halt status, and scheduling.
1167  */
1168 void usb_hcd_endpoint_disable (struct usb_device *udev,
1169                 struct usb_host_endpoint *ep)
1170 {
1171         struct usb_hcd          *hcd;
1172         struct urb              *urb;
1173
1174         hcd = bus_to_hcd(udev->bus);
1175
1176         WARN_ON (!HC_IS_RUNNING (hcd->state) && hcd->state != HC_STATE_HALT &&
1177                         udev->state != USB_STATE_NOTATTACHED);
1178
1179         local_irq_disable ();
1180
1181         /* ep is already gone from udev->ep_{in,out}[]; no more submits */
1182 rescan:
1183         spin_lock (&hcd_data_lock);
1184         list_for_each_entry (urb, &ep->urb_list, urb_list) {
1185                 int     tmp;
1186
1187                 /* the urb may already have been unlinked */
1188                 if (urb->status != -EINPROGRESS)
1189                         continue;
1190                 usb_get_urb (urb);
1191                 spin_unlock (&hcd_data_lock);
1192
1193                 spin_lock (&urb->lock);
1194                 tmp = urb->status;
1195                 if (tmp == -EINPROGRESS)
1196                         urb->status = -ESHUTDOWN;
1197                 spin_unlock (&urb->lock);
1198
1199                 /* kick hcd unless it's already returning this */
1200                 if (tmp == -EINPROGRESS) {
1201                         tmp = urb->pipe;
1202                         unlink1 (hcd, urb);
1203                         dev_dbg (hcd->self.controller,
1204                                 "shutdown urb %p pipe %08x ep%d%s%s\n",
1205                                 urb, tmp, usb_pipeendpoint (tmp),
1206                                 (tmp & USB_DIR_IN) ? "in" : "out",
1207                                 ({ char *s; \
1208                                  switch (usb_pipetype (tmp)) { \
1209                                  case PIPE_CONTROL:     s = ""; break; \
1210                                  case PIPE_BULK:        s = "-bulk"; break; \
1211                                  case PIPE_INTERRUPT:   s = "-intr"; break; \
1212                                  default:               s = "-iso"; break; \
1213                                 }; s;}));
1214                 }
1215                 usb_put_urb (urb);
1216
1217                 /* list contents may have changed */
1218                 goto rescan;
1219         }
1220         spin_unlock (&hcd_data_lock);
1221         local_irq_enable ();
1222
1223         /* synchronize with the hardware, so old configuration state
1224          * clears out immediately (and will be freed).
1225          */
1226         might_sleep ();
1227         if (hcd->driver->endpoint_disable)
1228                 hcd->driver->endpoint_disable (hcd, ep);
1229
1230         /* Wait until the endpoint queue is completely empty.  Most HCDs
1231          * will have done this already in their endpoint_disable method,
1232          * but some might not.  And there could be root-hub control URBs
1233          * still pending since they aren't affected by the HCDs'
1234          * endpoint_disable methods.
1235          */
1236         while (!list_empty (&ep->urb_list)) {
1237                 spin_lock_irq (&hcd_data_lock);
1238
1239                 /* The list may have changed while we acquired the spinlock */
1240                 urb = NULL;
1241                 if (!list_empty (&ep->urb_list)) {
1242                         urb = list_entry (ep->urb_list.prev, struct urb,
1243                                         urb_list);
1244                         usb_get_urb (urb);
1245                 }
1246                 spin_unlock_irq (&hcd_data_lock);
1247
1248                 if (urb) {
1249                         usb_kill_urb (urb);
1250                         usb_put_urb (urb);
1251                 }
1252         }
1253 }
1254
1255 /*-------------------------------------------------------------------------*/
1256
1257 #ifdef  CONFIG_PM
1258
1259 int hcd_bus_suspend (struct usb_bus *bus)
1260 {
1261         struct usb_hcd          *hcd;
1262         int                     status;
1263
1264         hcd = container_of (bus, struct usb_hcd, self);
1265         if (!hcd->driver->bus_suspend)
1266                 return -ENOENT;
1267         hcd->state = HC_STATE_QUIESCING;
1268         status = hcd->driver->bus_suspend (hcd);
1269         if (status == 0)
1270                 hcd->state = HC_STATE_SUSPENDED;
1271         else
1272                 dev_dbg(&bus->root_hub->dev, "%s fail, err %d\n",
1273                                 "suspend", status);
1274         return status;
1275 }
1276
1277 int hcd_bus_resume (struct usb_bus *bus)
1278 {
1279         struct usb_hcd          *hcd;
1280         int                     status;
1281
1282         hcd = container_of (bus, struct usb_hcd, self);
1283         if (!hcd->driver->bus_resume)
1284                 return -ENOENT;
1285         if (hcd->state == HC_STATE_RUNNING)
1286                 return 0;
1287         hcd->state = HC_STATE_RESUMING;
1288         status = hcd->driver->bus_resume (hcd);
1289         if (status == 0)
1290                 hcd->state = HC_STATE_RUNNING;
1291         else {
1292                 dev_dbg(&bus->root_hub->dev, "%s fail, err %d\n",
1293                                 "resume", status);
1294                 usb_hc_died(hcd);
1295         }
1296         return status;
1297 }
1298
1299 /**
1300  * usb_hcd_resume_root_hub - called by HCD to resume its root hub
1301  * @hcd: host controller for this root hub
1302  *
1303  * The USB host controller calls this function when its root hub is
1304  * suspended (with the remote wakeup feature enabled) and a remote
1305  * wakeup request is received.  It queues a request for khubd to
1306  * resume the root hub (that is, manage its downstream ports again).
1307  */
1308 void usb_hcd_resume_root_hub (struct usb_hcd *hcd)
1309 {
1310         unsigned long flags;
1311
1312         spin_lock_irqsave (&hcd_root_hub_lock, flags);
1313         if (hcd->rh_registered)
1314                 usb_resume_root_hub (hcd->self.root_hub);
1315         spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
1316 }
1317 EXPORT_SYMBOL_GPL(usb_hcd_resume_root_hub);
1318
1319 #endif
1320
1321 /*-------------------------------------------------------------------------*/
1322
1323 #ifdef  CONFIG_USB_OTG
1324
1325 /**
1326  * usb_bus_start_enum - start immediate enumeration (for OTG)
1327  * @bus: the bus (must use hcd framework)
1328  * @port_num: 1-based number of port; usually bus->otg_port
1329  * Context: in_interrupt()
1330  *
1331  * Starts enumeration, with an immediate reset followed later by
1332  * khubd identifying and possibly configuring the device.
1333  * This is needed by OTG controller drivers, where it helps meet
1334  * HNP protocol timing requirements for starting a port reset.
1335  */
1336 int usb_bus_start_enum(struct usb_bus *bus, unsigned port_num)
1337 {
1338         struct usb_hcd          *hcd;
1339         int                     status = -EOPNOTSUPP;
1340
1341         /* NOTE: since HNP can't start by grabbing the bus's address0_sem,
1342          * boards with root hubs hooked up to internal devices (instead of
1343          * just the OTG port) may need more attention to resetting...
1344          */
1345         hcd = container_of (bus, struct usb_hcd, self);
1346         if (port_num && hcd->driver->start_port_reset)
1347                 status = hcd->driver->start_port_reset(hcd, port_num);
1348
1349         /* run khubd shortly after (first) root port reset finishes;
1350          * it may issue others, until at least 50 msecs have passed.
1351          */
1352         if (status == 0)
1353                 mod_timer(&hcd->rh_timer, jiffies + msecs_to_jiffies(10));
1354         return status;
1355 }
1356 EXPORT_SYMBOL (usb_bus_start_enum);
1357
1358 #endif
1359
1360 /*-------------------------------------------------------------------------*/
1361
1362 /**
1363  * usb_hcd_giveback_urb - return URB from HCD to device driver
1364  * @hcd: host controller returning the URB
1365  * @urb: urb being returned to the USB device driver.
1366  * Context: in_interrupt()
1367  *
1368  * This hands the URB from HCD to its USB device driver, using its
1369  * completion function.  The HCD has freed all per-urb resources
1370  * (and is done using urb->hcpriv).  It also released all HCD locks;
1371  * the device driver won't cause problems if it frees, modifies,
1372  * or resubmits this URB.
1373  */
1374 void usb_hcd_giveback_urb (struct usb_hcd *hcd, struct urb *urb)
1375 {
1376         int at_root_hub;
1377
1378         at_root_hub = (urb->dev == hcd->self.root_hub);
1379         urb_unlink (urb);
1380
1381         /* lower level hcd code should use *_dma exclusively if the
1382          * host controller does DMA */
1383         if (hcd->self.uses_dma && !at_root_hub) {
1384                 if (usb_pipecontrol (urb->pipe)
1385                         && !(urb->transfer_flags & URB_NO_SETUP_DMA_MAP))
1386                         dma_unmap_single (hcd->self.controller, urb->setup_dma,
1387                                         sizeof (struct usb_ctrlrequest),
1388                                         DMA_TO_DEVICE);
1389                 if (urb->transfer_buffer_length != 0
1390                         && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP))
1391                         dma_unmap_single (hcd->self.controller,
1392                                         urb->transfer_dma,
1393                                         urb->transfer_buffer_length,
1394                                         usb_pipein (urb->pipe)
1395                                             ? DMA_FROM_DEVICE
1396                                             : DMA_TO_DEVICE);
1397         }
1398
1399         usbmon_urb_complete (&hcd->self, urb);
1400         /* pass ownership to the completion handler */
1401         urb->complete (urb);
1402         atomic_dec (&urb->use_count);
1403         if (unlikely (urb->reject))
1404                 wake_up (&usb_kill_urb_queue);
1405         usb_put_urb (urb);
1406 }
1407 EXPORT_SYMBOL (usb_hcd_giveback_urb);
1408
1409 /*-------------------------------------------------------------------------*/
1410
1411 /**
1412  * usb_hcd_irq - hook IRQs to HCD framework (bus glue)
1413  * @irq: the IRQ being raised
1414  * @__hcd: pointer to the HCD whose IRQ is being signaled
1415  * @r: saved hardware registers
1416  *
1417  * If the controller isn't HALTed, calls the driver's irq handler.
1418  * Checks whether the controller is now dead.
1419  */
1420 irqreturn_t usb_hcd_irq (int irq, void *__hcd)
1421 {
1422         struct usb_hcd          *hcd = __hcd;
1423         int                     start = hcd->state;
1424
1425         if (unlikely(start == HC_STATE_HALT ||
1426             !test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags)))
1427                 return IRQ_NONE;
1428         if (hcd->driver->irq (hcd) == IRQ_NONE)
1429                 return IRQ_NONE;
1430
1431         set_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
1432
1433         if (unlikely(hcd->state == HC_STATE_HALT))
1434                 usb_hc_died (hcd);
1435         return IRQ_HANDLED;
1436 }
1437
1438 /*-------------------------------------------------------------------------*/
1439
1440 /**
1441  * usb_hc_died - report abnormal shutdown of a host controller (bus glue)
1442  * @hcd: pointer to the HCD representing the controller
1443  *
1444  * This is called by bus glue to report a USB host controller that died
1445  * while operations may still have been pending.  It's called automatically
1446  * by the PCI glue, so only glue for non-PCI busses should need to call it.
1447  */
1448 void usb_hc_died (struct usb_hcd *hcd)
1449 {
1450         unsigned long flags;
1451
1452         dev_err (hcd->self.controller, "HC died; cleaning up\n");
1453
1454         spin_lock_irqsave (&hcd_root_hub_lock, flags);
1455         if (hcd->rh_registered) {
1456                 hcd->poll_rh = 0;
1457
1458                 /* make khubd clean up old urbs and devices */
1459                 usb_set_device_state (hcd->self.root_hub,
1460                                 USB_STATE_NOTATTACHED);
1461                 usb_kick_khubd (hcd->self.root_hub);
1462         }
1463         spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
1464 }
1465 EXPORT_SYMBOL_GPL (usb_hc_died);
1466
1467 /*-------------------------------------------------------------------------*/
1468
1469 /**
1470  * usb_create_hcd - create and initialize an HCD structure
1471  * @driver: HC driver that will use this hcd
1472  * @dev: device for this HC, stored in hcd->self.controller
1473  * @bus_name: value to store in hcd->self.bus_name
1474  * Context: !in_interrupt()
1475  *
1476  * Allocate a struct usb_hcd, with extra space at the end for the
1477  * HC driver's private data.  Initialize the generic members of the
1478  * hcd structure.
1479  *
1480  * If memory is unavailable, returns NULL.
1481  */
1482 struct usb_hcd *usb_create_hcd (const struct hc_driver *driver,
1483                 struct device *dev, char *bus_name)
1484 {
1485         struct usb_hcd *hcd;
1486
1487         hcd = kzalloc(sizeof(*hcd) + driver->hcd_priv_size, GFP_KERNEL);
1488         if (!hcd) {
1489                 dev_dbg (dev, "hcd alloc failed\n");
1490                 return NULL;
1491         }
1492         dev_set_drvdata(dev, hcd);
1493         kref_init(&hcd->kref);
1494
1495         usb_bus_init(&hcd->self);
1496         hcd->self.controller = dev;
1497         hcd->self.bus_name = bus_name;
1498         hcd->self.uses_dma = (dev->dma_mask != NULL);
1499
1500         init_timer(&hcd->rh_timer);
1501         hcd->rh_timer.function = rh_timer_func;
1502         hcd->rh_timer.data = (unsigned long) hcd;
1503
1504         hcd->driver = driver;
1505         hcd->product_desc = (driver->product_desc) ? driver->product_desc :
1506                         "USB Host Controller";
1507
1508         return hcd;
1509 }
1510 EXPORT_SYMBOL (usb_create_hcd);
1511
1512 static void hcd_release (struct kref *kref)
1513 {
1514         struct usb_hcd *hcd = container_of (kref, struct usb_hcd, kref);
1515
1516         kfree(hcd);
1517 }
1518
1519 struct usb_hcd *usb_get_hcd (struct usb_hcd *hcd)
1520 {
1521         if (hcd)
1522                 kref_get (&hcd->kref);
1523         return hcd;
1524 }
1525 EXPORT_SYMBOL (usb_get_hcd);
1526
1527 void usb_put_hcd (struct usb_hcd *hcd)
1528 {
1529         if (hcd)
1530                 kref_put (&hcd->kref, hcd_release);
1531 }
1532 EXPORT_SYMBOL (usb_put_hcd);
1533
1534 /**
1535  * usb_add_hcd - finish generic HCD structure initialization and register
1536  * @hcd: the usb_hcd structure to initialize
1537  * @irqnum: Interrupt line to allocate
1538  * @irqflags: Interrupt type flags
1539  *
1540  * Finish the remaining parts of generic HCD initialization: allocate the
1541  * buffers of consistent memory, register the bus, request the IRQ line,
1542  * and call the driver's reset() and start() routines.
1543  */
1544 int usb_add_hcd(struct usb_hcd *hcd,
1545                 unsigned int irqnum, unsigned long irqflags)
1546 {
1547         int retval;
1548         struct usb_device *rhdev;
1549
1550         dev_info(hcd->self.controller, "%s\n", hcd->product_desc);
1551
1552         set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1553
1554         /* HC is in reset state, but accessible.  Now do the one-time init,
1555          * bottom up so that hcds can customize the root hubs before khubd
1556          * starts talking to them.  (Note, bus id is assigned early too.)
1557          */
1558         if ((retval = hcd_buffer_create(hcd)) != 0) {
1559                 dev_dbg(hcd->self.controller, "pool alloc failed\n");
1560                 return retval;
1561         }
1562
1563         if ((retval = usb_register_bus(&hcd->self)) < 0)
1564                 goto err_register_bus;
1565
1566         if ((rhdev = usb_alloc_dev(NULL, &hcd->self, 0)) == NULL) {
1567                 dev_err(hcd->self.controller, "unable to allocate root hub\n");
1568                 retval = -ENOMEM;
1569                 goto err_allocate_root_hub;
1570         }
1571         rhdev->speed = (hcd->driver->flags & HCD_USB2) ? USB_SPEED_HIGH :
1572                         USB_SPEED_FULL;
1573         hcd->self.root_hub = rhdev;
1574
1575         /* wakeup flag init defaults to "everything works" for root hubs,
1576          * but drivers can override it in reset() if needed, along with
1577          * recording the overall controller's system wakeup capability.
1578          */
1579         device_init_wakeup(&rhdev->dev, 1);
1580
1581         /* "reset" is misnamed; its role is now one-time init. the controller
1582          * should already have been reset (and boot firmware kicked off etc).
1583          */
1584         if (hcd->driver->reset && (retval = hcd->driver->reset(hcd)) < 0) {
1585                 dev_err(hcd->self.controller, "can't setup\n");
1586                 goto err_hcd_driver_setup;
1587         }
1588
1589         /* NOTE: root hub and controller capabilities may not be the same */
1590         if (device_can_wakeup(hcd->self.controller)
1591                         && device_can_wakeup(&hcd->self.root_hub->dev))
1592                 dev_dbg(hcd->self.controller, "supports USB remote wakeup\n");
1593
1594         /* enable irqs just before we start the controller */
1595         if (hcd->driver->irq) {
1596                 snprintf(hcd->irq_descr, sizeof(hcd->irq_descr), "%s:usb%d",
1597                                 hcd->driver->description, hcd->self.busnum);
1598                 if ((retval = request_irq(irqnum, &usb_hcd_irq, irqflags,
1599                                 hcd->irq_descr, hcd)) != 0) {
1600                         dev_err(hcd->self.controller,
1601                                         "request interrupt %d failed\n", irqnum);
1602                         goto err_request_irq;
1603                 }
1604                 hcd->irq = irqnum;
1605                 dev_info(hcd->self.controller, "irq %d, %s 0x%08llx\n", irqnum,
1606                                 (hcd->driver->flags & HCD_MEMORY) ?
1607                                         "io mem" : "io base",
1608                                         (unsigned long long)hcd->rsrc_start);
1609         } else {
1610                 hcd->irq = -1;
1611                 if (hcd->rsrc_start)
1612                         dev_info(hcd->self.controller, "%s 0x%08llx\n",
1613                                         (hcd->driver->flags & HCD_MEMORY) ?
1614                                         "io mem" : "io base",
1615                                         (unsigned long long)hcd->rsrc_start);
1616         }
1617
1618         if ((retval = hcd->driver->start(hcd)) < 0) {
1619                 dev_err(hcd->self.controller, "startup error %d\n", retval);
1620                 goto err_hcd_driver_start;
1621         }
1622
1623         /* starting here, usbcore will pay attention to this root hub */
1624         rhdev->bus_mA = min(500u, hcd->power_budget);
1625         if ((retval = register_root_hub(hcd)) != 0)
1626                 goto err_register_root_hub;
1627
1628         if (hcd->uses_new_polling && hcd->poll_rh)
1629                 usb_hcd_poll_rh_status(hcd);
1630         return retval;
1631
1632 err_register_root_hub:
1633         hcd->driver->stop(hcd);
1634 err_hcd_driver_start:
1635         if (hcd->irq >= 0)
1636                 free_irq(irqnum, hcd);
1637 err_request_irq:
1638 err_hcd_driver_setup:
1639         hcd->self.root_hub = NULL;
1640         usb_put_dev(rhdev);
1641 err_allocate_root_hub:
1642         usb_deregister_bus(&hcd->self);
1643 err_register_bus:
1644         hcd_buffer_destroy(hcd);
1645         return retval;
1646 }
1647 EXPORT_SYMBOL (usb_add_hcd);
1648
1649 /**
1650  * usb_remove_hcd - shutdown processing for generic HCDs
1651  * @hcd: the usb_hcd structure to remove
1652  * Context: !in_interrupt()
1653  *
1654  * Disconnects the root hub, then reverses the effects of usb_add_hcd(),
1655  * invoking the HCD's stop() method.
1656  */
1657 void usb_remove_hcd(struct usb_hcd *hcd)
1658 {
1659         dev_info(hcd->self.controller, "remove, state %x\n", hcd->state);
1660
1661         if (HC_IS_RUNNING (hcd->state))
1662                 hcd->state = HC_STATE_QUIESCING;
1663
1664         dev_dbg(hcd->self.controller, "roothub graceful disconnect\n");
1665         spin_lock_irq (&hcd_root_hub_lock);
1666         hcd->rh_registered = 0;
1667         spin_unlock_irq (&hcd_root_hub_lock);
1668
1669         mutex_lock(&usb_bus_list_lock);
1670         usb_disconnect(&hcd->self.root_hub);
1671         mutex_unlock(&usb_bus_list_lock);
1672
1673         hcd->poll_rh = 0;
1674         del_timer_sync(&hcd->rh_timer);
1675
1676         hcd->driver->stop(hcd);
1677         hcd->state = HC_STATE_HALT;
1678
1679         if (hcd->irq >= 0)
1680                 free_irq(hcd->irq, hcd);
1681         usb_deregister_bus(&hcd->self);
1682         hcd_buffer_destroy(hcd);
1683 }
1684 EXPORT_SYMBOL (usb_remove_hcd);
1685
1686 void
1687 usb_hcd_platform_shutdown(struct platform_device* dev)
1688 {
1689         struct usb_hcd *hcd = platform_get_drvdata(dev);
1690
1691         if (hcd->driver->shutdown)
1692                 hcd->driver->shutdown(hcd);
1693 }
1694 EXPORT_SYMBOL (usb_hcd_platform_shutdown);
1695
1696 /*-------------------------------------------------------------------------*/
1697
1698 #if defined(CONFIG_USB_MON)
1699
1700 struct usb_mon_operations *mon_ops;
1701
1702 /*
1703  * The registration is unlocked.
1704  * We do it this way because we do not want to lock in hot paths.
1705  *
1706  * Notice that the code is minimally error-proof. Because usbmon needs
1707  * symbols from usbcore, usbcore gets referenced and cannot be unloaded first.
1708  */
1709
1710 int usb_mon_register (struct usb_mon_operations *ops)
1711 {
1712
1713         if (mon_ops)
1714                 return -EBUSY;
1715
1716         mon_ops = ops;
1717         mb();
1718         return 0;
1719 }
1720 EXPORT_SYMBOL_GPL (usb_mon_register);
1721
1722 void usb_mon_deregister (void)
1723 {
1724
1725         if (mon_ops == NULL) {
1726                 printk(KERN_ERR "USB: monitor was not registered\n");
1727                 return;
1728         }
1729         mon_ops = NULL;
1730         mb();
1731 }
1732 EXPORT_SYMBOL_GPL (usb_mon_deregister);
1733
1734 #endif /* CONFIG_USB_MON */