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