err.no Git - linux-2.6/blob - 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         int             status = 0;
 360         int             n;
 361
 362         might_sleep();
 363
 364         cmd = (struct usb_ctrlrequest *) urb->setup_packet;
 365         typeReq  = (cmd->bRequestType << 8) | cmd->bRequest;
 366         wValue   = le16_to_cpu (cmd->wValue);
 367         wIndex   = le16_to_cpu (cmd->wIndex);
 368         wLength  = le16_to_cpu (cmd->wLength);
 369
 370         if (wLength > urb->transfer_buffer_length)
 371                 goto error;
 372
 373         urb->actual_length = 0;
 374         switch (typeReq) {
 375
 376         /* DEVICE REQUESTS */
 377
 378         /* The root hub's remote wakeup enable bit is implemented using
 379          * driver model wakeup flags.  If this system supports wakeup
 380          * through USB, userspace may change the default "allow wakeup"
 381          * policy through sysfs or these calls.
 382          *
 383          * Most root hubs support wakeup from downstream devices, for
 384          * runtime power management (disabling USB clocks and reducing
 385          * VBUS power usage).  However, not all of them do so; silicon,
 386          * board, and BIOS bugs here are not uncommon, so these can't
 387          * be treated quite like external hubs.
 388          *
 389          * Likewise, not all root hubs will pass wakeup events upstream,
 390          * to wake up the whole system.  So don't assume root hub and
 391          * controller capabilities are identical.
 392          */
 393
 394         case DeviceRequest | USB_REQ_GET_STATUS:
 395                 tbuf [0] = (device_may_wakeup(&hcd->self.root_hub->dev)
 396                                         << USB_DEVICE_REMOTE_WAKEUP)
 397                                 | (1 << USB_DEVICE_SELF_POWERED);
 398                 tbuf [1] = 0;
 399                 len = 2;
 400                 break;
 401         case DeviceOutRequest | USB_REQ_CLEAR_FEATURE:
 402                 if (wValue == USB_DEVICE_REMOTE_WAKEUP)
 403                         device_set_wakeup_enable(&hcd->self.root_hub->dev, 0);
 404                 else
 405                         goto error;
 406                 break;
 407         case DeviceOutRequest | USB_REQ_SET_FEATURE:
 408                 if (device_can_wakeup(&hcd->self.root_hub->dev)
 409                                 && wValue == USB_DEVICE_REMOTE_WAKEUP)
 410                         device_set_wakeup_enable(&hcd->self.root_hub->dev, 1);
 411                 else
 412                         goto error;
 413                 break;
 414         case DeviceRequest | USB_REQ_GET_CONFIGURATION:
 415                 tbuf [0] = 1;
 416                 len = 1;
 417                         /* FALLTHROUGH */
 418         case DeviceOutRequest | USB_REQ_SET_CONFIGURATION:
 419                 break;
 420         case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
 421                 switch (wValue & 0xff00) {
 422                 case USB_DT_DEVICE << 8:
 423                         if (hcd->driver->flags & HCD_USB2)
 424                                 bufp = usb2_rh_dev_descriptor;
 425                         else if (hcd->driver->flags & HCD_USB11)
 426                                 bufp = usb11_rh_dev_descriptor;
 427                         else
 428                                 goto error;
 429                         len = 18;
 430                         break;
 431                 case USB_DT_CONFIG << 8:
 432                         if (hcd->driver->flags & HCD_USB2) {
 433                                 bufp = hs_rh_config_descriptor;
 434                                 len = sizeof hs_rh_config_descriptor;
 435                         } else {
 436                                 bufp = fs_rh_config_descriptor;
 437                                 len = sizeof fs_rh_config_descriptor;
 438                         }
 439                         if (device_can_wakeup(&hcd->self.root_hub->dev))
 440                                 patch_wakeup = 1;
 441                         break;
 442                 case USB_DT_STRING << 8:
 443                         n = rh_string (wValue & 0xff, hcd, ubuf, wLength);
 444                         if (n < 0)
 445                                 goto error;
 446                         urb->actual_length = n;
 447                         break;
 448                 default:
 449                         goto error;
 450                 }
 451                 break;
 452         case DeviceRequest | USB_REQ_GET_INTERFACE:
 453                 tbuf [0] = 0;
 454                 len = 1;
 455                         /* FALLTHROUGH */
 456         case DeviceOutRequest | USB_REQ_SET_INTERFACE:
 457                 break;
 458         case DeviceOutRequest | USB_REQ_SET_ADDRESS:
 459                 // wValue == urb->dev->devaddr
 460                 dev_dbg (hcd->self.controller, "root hub device address %d\n",
 461                         wValue);
 462                 break;
 463
 464         /* INTERFACE REQUESTS (no defined feature/status flags) */
 465
 466         /* ENDPOINT REQUESTS */
 467
 468         case EndpointRequest | USB_REQ_GET_STATUS:
 469                 // ENDPOINT_HALT flag
 470                 tbuf [0] = 0;
 471                 tbuf [1] = 0;
 472                 len = 2;
 473                         /* FALLTHROUGH */
 474         case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
 475         case EndpointOutRequest | USB_REQ_SET_FEATURE:
 476                 dev_dbg (hcd->self.controller, "no endpoint features yet\n");
 477                 break;
 478
 479         /* CLASS REQUESTS (and errors) */
 480
 481         default:
 482                 /* non-generic request */
 483                 switch (typeReq) {
 484                 case GetHubStatus:
 485                 case GetPortStatus:
 486                         len = 4;
 487                         break;
 488                 case GetHubDescriptor:
 489                         len = sizeof (struct usb_hub_descriptor);
 490                         break;
 491                 }
 492                 status = hcd->driver->hub_control (hcd,
 493                         typeReq, wValue, wIndex,
 494                         tbuf, wLength);
 495                 break;
 496 error:
 497                 /* "protocol stall" on error */
 498                 status = -EPIPE;
 499         }
 500
 501         if (status) {
 502                 len = 0;
 503                 if (status != -EPIPE) {
 504                         dev_dbg (hcd->self.controller,
 505                                 "CTRL: TypeReq=0x%x val=0x%x "
 506                                 "idx=0x%x len=%d ==> %d\n",
 507                                 typeReq, wValue, wIndex,
 508                                 wLength, status);
 509                 }
 510         }
 511         if (len) {
 512                 if (urb->transfer_buffer_length < len)
 513                         len = urb->transfer_buffer_length;
 514                 urb->actual_length = len;
 515                 // always USB_DIR_IN, toward host
 516                 memcpy (ubuf, bufp, len);
 517
 518                 /* report whether RH hardware supports remote wakeup */
 519                 if (patch_wakeup &&
 520                                 len > offsetof (struct usb_config_descriptor,
 521                                                 bmAttributes))
 522                         ((struct usb_config_descriptor *)ubuf)->bmAttributes
 523                                 |= USB_CONFIG_ATT_WAKEUP;
 524         }
 525
 526         /* any errors get returned through the urb completion */
 527         spin_lock_irq(&hcd_root_hub_lock);
 528         spin_lock(&urb->lock);
 529         if (urb->status == -EINPROGRESS)
 530                 urb->status = status;
 531         spin_unlock(&urb->lock);
 532
 533         /* This peculiar use of spinlocks echoes what real HC drivers do.
 534          * Avoiding calls to local_irq_disable/enable makes the code
 535          * RT-friendly.
 536          */
 537         spin_unlock(&hcd_root_hub_lock);
 538         usb_hcd_giveback_urb(hcd, urb);
 539         spin_lock(&hcd_root_hub_lock);
 540
 541         spin_unlock_irq(&hcd_root_hub_lock);
 542         return 0;
 543 }
 544
 545 /*-------------------------------------------------------------------------*/
 546
 547 /*
 548  * Root Hub interrupt transfers are polled using a timer if the
 549  * driver requests it; otherwise the driver is responsible for
 550  * calling usb_hcd_poll_rh_status() when an event occurs.
 551  *
 552  * Completions are called in_interrupt(), but they may or may not
 553  * be in_irq().
 554  */
 555 void usb_hcd_poll_rh_status(struct usb_hcd *hcd)
 556 {
 557         struct urb      *urb;
 558         int             length;
 559         unsigned long   flags;
 560         char            buffer[4];      /* Any root hubs with > 31 ports? */
 561
 562         if (unlikely(!hcd->rh_registered))
 563                 return;
 564         if (!hcd->uses_new_polling && !hcd->status_urb)
 565                 return;
 566
 567         length = hcd->driver->hub_status_data(hcd, buffer);
 568         if (length > 0) {
 569
 570                 /* try to complete the status urb */
 571                 spin_lock_irqsave(&hcd_root_hub_lock, flags);
 572                 urb = hcd->status_urb;
 573                 if (urb) {
 574                         spin_lock(&urb->lock);
 575                         if (urb->status == -EINPROGRESS) {
 576                                 hcd->poll_pending = 0;
 577                                 hcd->status_urb = NULL;
 578                                 urb->status = 0;
 579                                 urb->hcpriv = NULL;
 580                                 urb->actual_length = length;
 581                                 memcpy(urb->transfer_buffer, buffer, length);
 582                         } else          /* urb has been unlinked */
 583                                 length = 0;
 584                         spin_unlock(&urb->lock);
 585
 586                         spin_unlock(&hcd_root_hub_lock);
 587                         usb_hcd_giveback_urb(hcd, urb);
 588                         spin_lock(&hcd_root_hub_lock);
 589                 } else
 590                         length = 0;
 591
 592                 if (length <= 0)
 593                         hcd->poll_pending = 1;
 594                 spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
 595         }
 596
 597         /* The USB 2.0 spec says 256 ms.  This is close enough and won't
 598          * exceed that limit if HZ is 100. The math is more clunky than
 599          * maybe expected, this is to make sure that all timers for USB devices
 600          * fire at the same time to give the CPU a break inbetween */
 601         if (hcd->uses_new_polling ? hcd->poll_rh :
 602                         (length == 0 && hcd->status_urb != NULL))
 603                 mod_timer (&hcd->rh_timer, (jiffies/(HZ/4) + 1) * (HZ/4));
 604 }
 605 EXPORT_SYMBOL_GPL(usb_hcd_poll_rh_status);
 606
 607 /* timer callback */
 608 static void rh_timer_func (unsigned long _hcd)
 609 {
 610         usb_hcd_poll_rh_status((struct usb_hcd *) _hcd);
 611 }
 612
 613 /*-------------------------------------------------------------------------*/
 614
 615 static int rh_queue_status (struct usb_hcd *hcd, struct urb *urb)
 616 {
 617         int             retval;
 618         unsigned long   flags;
 619         int             len = 1 + (urb->dev->maxchild / 8);
 620
 621         spin_lock_irqsave (&hcd_root_hub_lock, flags);
 622         if (urb->status != -EINPROGRESS)        /* already unlinked */
 623                 retval = urb->status;
 624         else if (hcd->status_urb || urb->transfer_buffer_length < len) {
 625                 dev_dbg (hcd->self.controller, "not queuing rh status urb\n");
 626                 retval = -EINVAL;
 627         } else {
 628                 hcd->status_urb = urb;
 629                 urb->hcpriv = hcd;      /* indicate it's queued */
 630
 631                 if (!hcd->uses_new_polling)
 632                         mod_timer (&hcd->rh_timer,
 633                                 (jiffies/(HZ/4) + 1) * (HZ/4));
 634
 635                 /* If a status change has already occurred, report it ASAP */
 636                 else if (hcd->poll_pending)
 637                         mod_timer (&hcd->rh_timer, jiffies);
 638                 retval = 0;
 639         }
 640         spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
 641         return retval;
 642 }
 643
 644 static int rh_urb_enqueue (struct usb_hcd *hcd, struct urb *urb)
 645 {
 646         if (usb_endpoint_xfer_int(&urb->ep->desc))
 647                 return rh_queue_status (hcd, urb);
 648         if (usb_endpoint_xfer_control(&urb->ep->desc))
 649                 return rh_call_control (hcd, urb);
 650         return -EINVAL;
 651 }
 652
 653 /*-------------------------------------------------------------------------*/
 654
 655 /* Unlinks of root-hub control URBs are legal, but they don't do anything
 656  * since these URBs always execute synchronously.
 657  */
 658 static int usb_rh_urb_dequeue (struct usb_hcd *hcd, struct urb *urb)
 659 {
 660         unsigned long   flags;
 661
 662         spin_lock_irqsave(&hcd_root_hub_lock, flags);
 663         if (usb_endpoint_num(&urb->ep->desc) == 0) {    /* Control URB */
 664                 ;       /* Do nothing */
 665
 666         } else {                                /* Status URB */
 667                 if (!hcd->uses_new_polling)
 668                         del_timer (&hcd->rh_timer);
 669                 if (urb == hcd->status_urb) {
 670                         hcd->status_urb = NULL;
 671                         urb->hcpriv = NULL;
 672
 673                         spin_unlock(&hcd_root_hub_lock);
 674                         usb_hcd_giveback_urb(hcd, urb);
 675                         spin_lock(&hcd_root_hub_lock);
 676                 }
 677         }
 678         spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
 679         return 0;
 680 }
 681
 682 /*-------------------------------------------------------------------------*/
 683
 684 static struct class *usb_host_class;
 685
 686 int usb_host_init(void)
 687 {
 688         int retval = 0;
 689
 690         usb_host_class = class_create(THIS_MODULE, "usb_host");
 691         if (IS_ERR(usb_host_class))
 692                 retval = PTR_ERR(usb_host_class);
 693         return retval;
 694 }
 695
 696 void usb_host_cleanup(void)
 697 {
 698         class_destroy(usb_host_class);
 699 }
 700
 701 /**
 702  * usb_bus_init - shared initialization code
 703  * @bus: the bus structure being initialized
 704  *
 705  * This code is used to initialize a usb_bus structure, memory for which is
 706  * separately managed.
 707  */
 708 static void usb_bus_init (struct usb_bus *bus)
 709 {
 710         memset (&bus->devmap, 0, sizeof(struct usb_devmap));
 711
 712         bus->devnum_next = 1;
 713
 714         bus->root_hub = NULL;
 715         bus->busnum = -1;
 716         bus->bandwidth_allocated = 0;
 717         bus->bandwidth_int_reqs  = 0;
 718         bus->bandwidth_isoc_reqs = 0;
 719
 720         INIT_LIST_HEAD (&bus->bus_list);
 721 }
 722
 723 /*-------------------------------------------------------------------------*/
 724
 725 /**
 726  * usb_register_bus - registers the USB host controller with the usb core
 727  * @bus: pointer to the bus to register
 728  * Context: !in_interrupt()
 729  *
 730  * Assigns a bus number, and links the controller into usbcore data
 731  * structures so that it can be seen by scanning the bus list.
 732  */
 733 static int usb_register_bus(struct usb_bus *bus)
 734 {
 735         int busnum;
 736
 737         mutex_lock(&usb_bus_list_lock);
 738         busnum = find_next_zero_bit (busmap.busmap, USB_MAXBUS, 1);
 739         if (busnum < USB_MAXBUS) {
 740                 set_bit (busnum, busmap.busmap);
 741                 bus->busnum = busnum;
 742         } else {
 743                 printk (KERN_ERR "%s: too many buses\n", usbcore_name);
 744                 mutex_unlock(&usb_bus_list_lock);
 745                 return -E2BIG;
 746         }
 747
 748         bus->class_dev = class_device_create(usb_host_class, NULL, MKDEV(0,0),
 749                                              bus->controller, "usb_host%d", busnum);
 750         if (IS_ERR(bus->class_dev)) {
 751                 clear_bit(busnum, busmap.busmap);
 752                 mutex_unlock(&usb_bus_list_lock);
 753                 return PTR_ERR(bus->class_dev);
 754         }
 755
 756         class_set_devdata(bus->class_dev, bus);
 757
 758         /* Add it to the local list of buses */
 759         list_add (&bus->bus_list, &usb_bus_list);
 760         mutex_unlock(&usb_bus_list_lock);
 761
 762         usb_notify_add_bus(bus);
 763
 764         dev_info (bus->controller, "new USB bus registered, assigned bus number %d\n", bus->busnum);
 765         return 0;
 766 }
 767
 768 /**
 769  * usb_deregister_bus - deregisters the USB host controller
 770  * @bus: pointer to the bus to deregister
 771  * Context: !in_interrupt()
 772  *
 773  * Recycles the bus number, and unlinks the controller from usbcore data
 774  * structures so that it won't be seen by scanning the bus list.
 775  */
 776 static void usb_deregister_bus (struct usb_bus *bus)
 777 {
 778         dev_info (bus->controller, "USB bus %d deregistered\n", bus->busnum);
 779
 780         /*
 781          * NOTE: make sure that all the devices are removed by the
 782          * controller code, as well as having it call this when cleaning
 783          * itself up
 784          */
 785         mutex_lock(&usb_bus_list_lock);
 786         list_del (&bus->bus_list);
 787         mutex_unlock(&usb_bus_list_lock);
 788
 789         usb_notify_remove_bus(bus);
 790
 791         clear_bit (bus->busnum, busmap.busmap);
 792
 793         class_device_unregister(bus->class_dev);
 794 }
 795
 796 /**
 797  * register_root_hub - called by usb_add_hcd() to register a root hub
 798  * @hcd: host controller for this root hub
 799  *
 800  * This function registers the root hub with the USB subsystem.  It sets up
 801  * the device properly in the device tree and then calls usb_new_device()
 802  * to register the usb device.  It also assigns the root hub's USB address
 803  * (always 1).
 804  */
 805 static int register_root_hub(struct usb_hcd *hcd)
 806 {
 807         struct device *parent_dev = hcd->self.controller;
 808         struct usb_device *usb_dev = hcd->self.root_hub;
 809         const int devnum = 1;
 810         int retval;
 811
 812         usb_dev->devnum = devnum;
 813         usb_dev->bus->devnum_next = devnum + 1;
 814         memset (&usb_dev->bus->devmap.devicemap, 0,
 815                         sizeof usb_dev->bus->devmap.devicemap);
 816         set_bit (devnum, usb_dev->bus->devmap.devicemap);
 817         usb_set_device_state(usb_dev, USB_STATE_ADDRESS);
 818
 819         mutex_lock(&usb_bus_list_lock);
 820
 821         usb_dev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
 822         retval = usb_get_device_descriptor(usb_dev, USB_DT_DEVICE_SIZE);
 823         if (retval != sizeof usb_dev->descriptor) {
 824                 mutex_unlock(&usb_bus_list_lock);
 825                 dev_dbg (parent_dev, "can't read %s device descriptor %d\n",
 826                                 usb_dev->dev.bus_id, retval);
 827                 return (retval < 0) ? retval : -EMSGSIZE;
 828         }
 829
 830         retval = usb_new_device (usb_dev);
 831         if (retval) {
 832                 dev_err (parent_dev, "can't register root hub for %s, %d\n",
 833                                 usb_dev->dev.bus_id, retval);
 834         }
 835         mutex_unlock(&usb_bus_list_lock);
 836
 837         if (retval == 0) {
 838                 spin_lock_irq (&hcd_root_hub_lock);
 839                 hcd->rh_registered = 1;
 840                 spin_unlock_irq (&hcd_root_hub_lock);
 841
 842                 /* Did the HC die before the root hub was registered? */
 843                 if (hcd->state == HC_STATE_HALT)
 844                         usb_hc_died (hcd);      /* This time clean up */
 845         }
 846
 847         return retval;
 848 }
 849
 850 void usb_enable_root_hub_irq (struct usb_bus *bus)
 851 {
 852         struct usb_hcd *hcd;
 853
 854         hcd = container_of (bus, struct usb_hcd, self);
 855         if (hcd->driver->hub_irq_enable && hcd->state != HC_STATE_HALT)
 856                 hcd->driver->hub_irq_enable (hcd);
 857 }
 858
 859
 860 /*-------------------------------------------------------------------------*/
 861
 862 /**
 863  * usb_calc_bus_time - approximate periodic transaction time in nanoseconds
 864  * @speed: from dev->speed; USB_SPEED_{LOW,FULL,HIGH}
 865  * @is_input: true iff the transaction sends data to the host
 866  * @isoc: true for isochronous transactions, false for interrupt ones
 867  * @bytecount: how many bytes in the transaction.
 868  *
 869  * Returns approximate bus time in nanoseconds for a periodic transaction.
 870  * See USB 2.0 spec section 5.11.3; only periodic transfers need to be
 871  * scheduled in software, this function is only used for such scheduling.
 872  */
 873 long usb_calc_bus_time (int speed, int is_input, int isoc, int bytecount)
 874 {
 875         unsigned long   tmp;
 876
 877         switch (speed) {
 878         case USB_SPEED_LOW:     /* INTR only */
 879                 if (is_input) {
 880                         tmp = (67667L * (31L + 10L * BitTime (bytecount))) / 1000L;
 881                         return (64060L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp);
 882                 } else {
 883                         tmp = (66700L * (31L + 10L * BitTime (bytecount))) / 1000L;
 884                         return (64107L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp);
 885                 }
 886         case USB_SPEED_FULL:    /* ISOC or INTR */
 887                 if (isoc) {
 888                         tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
 889                         return (((is_input) ? 7268L : 6265L) + BW_HOST_DELAY + tmp);
 890                 } else {
 891                         tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
 892                         return (9107L + BW_HOST_DELAY + tmp);
 893                 }
 894         case USB_SPEED_HIGH:    /* ISOC or INTR */
 895                 // FIXME adjust for input vs output
 896                 if (isoc)
 897                         tmp = HS_NSECS_ISO (bytecount);
 898                 else
 899                         tmp = HS_NSECS (bytecount);
 900                 return tmp;
 901         default:
 902                 pr_debug ("%s: bogus device speed!\n", usbcore_name);
 903                 return -1;
 904         }
 905 }
 906 EXPORT_SYMBOL (usb_calc_bus_time);
 907
 908
 909 /*-------------------------------------------------------------------------*/
 910
 911 /*
 912  * Generic HC operations.
 913  */
 914
 915 /*-------------------------------------------------------------------------*/
 916
 917 static int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb)
 918 {
 919         unsigned long   flags;
 920         int             rc = 0;
 921
 922         spin_lock_irqsave(&hcd_urb_list_lock, flags);
 923
 924         /* Check that the URB isn't being killed */
 925         if (unlikely(urb->reject)) {
 926                 rc = -EPERM;
 927                 goto done;
 928         }
 929
 930         if (unlikely(!urb->ep->enabled)) {
 931                 rc = -ENOENT;
 932                 goto done;
 933         }
 934
 935         /*
 936          * Check the host controller's state and add the URB to the
 937          * endpoint's queue.
 938          */
 939         switch (hcd->state) {
 940         case HC_STATE_RUNNING:
 941         case HC_STATE_RESUMING:
 942                 list_add_tail(&urb->urb_list, &urb->ep->urb_list);
 943                 break;
 944         default:
 945                 rc = -ESHUTDOWN;
 946                 goto done;
 947         }
 948  done:
 949         spin_unlock_irqrestore(&hcd_urb_list_lock, flags);
 950         return rc;
 951 }
 952
 953 static int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb,
 954                 int status)
 955 {
 956         unsigned long           flags;
 957         struct list_head        *tmp;
 958         int                     rc = 0;
 959
 960         /*
 961          * we contend for urb->status with the hcd core,
 962          * which changes it while returning the urb.
 963          *
 964          * Caller guaranteed that the urb pointer hasn't been freed, and
 965          * that it was submitted.  But as a rule it can't know whether or
 966          * not it's already been unlinked ... so we respect the reversed
 967          * lock sequence needed for the usb_hcd_giveback_urb() code paths
 968          * (urb lock, then hcd_urb_list_lock) in case some other CPU is now
 969          * unlinking it.
 970          */
 971         spin_lock_irqsave(&urb->lock, flags);
 972         spin_lock(&hcd_urb_list_lock);
 973
 974         /* insist the urb is still queued */
 975         list_for_each(tmp, &urb->ep->urb_list) {
 976                 if (tmp == &urb->urb_list)
 977                         break;
 978         }
 979         if (tmp != &urb->urb_list) {
 980                 rc = -EIDRM;
 981                 goto done;
 982         }
 983
 984         /* Any status except -EINPROGRESS means something already started to
 985          * unlink this URB from the hardware.  So there's no more work to do.
 986          */
 987         if (urb->status != -EINPROGRESS) {
 988                 rc = -EBUSY;
 989                 goto done;
 990         }
 991         urb->status = status;
 992
 993         /* IRQ setup can easily be broken so that USB controllers
 994          * never get completion IRQs ... maybe even the ones we need to
 995          * finish unlinking the initial failed usb_set_address()
 996          * or device descriptor fetch.
 997          */
 998         if (!test_bit(HCD_FLAG_SAW_IRQ, &hcd->flags) &&
 999                         !is_root_hub(urb->dev)) {
1000                 dev_warn(hcd->self.controller, "Unlink after no-IRQ?  "
1001                         "Controller is probably using the wrong IRQ.\n");
1002                 set_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
1003         }
1004
1005  done:
1006         spin_unlock(&hcd_urb_list_lock);
1007         spin_unlock_irqrestore (&urb->lock, flags);
1008         return rc;
1009 }
1010
1011 static void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb)
1012 {
1013         unsigned long           flags;
1014
1015         /* clear all state linking urb to this dev (and hcd) */
1016         spin_lock_irqsave(&hcd_urb_list_lock, flags);
1017         list_del_init(&urb->urb_list);
1018         spin_unlock_irqrestore(&hcd_urb_list_lock, flags);
1019 }
1020
1021 static void map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
1022 {
1023         /* Map the URB's buffers for DMA access.
1024          * Lower level HCD code should use *_dma exclusively,
1025          * unless it uses pio or talks to another transport.
1026          */
1027         if (hcd->self.uses_dma && !is_root_hub(urb->dev)) {
1028                 if (usb_endpoint_xfer_control(&urb->ep->desc)
1029                         && !(urb->transfer_flags & URB_NO_SETUP_DMA_MAP))
1030                         urb->setup_dma = dma_map_single (
1031                                         hcd->self.controller,
1032                                         urb->setup_packet,
1033                                         sizeof (struct usb_ctrlrequest),
1034                                         DMA_TO_DEVICE);
1035                 if (urb->transfer_buffer_length != 0
1036                         && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP))
1037                         urb->transfer_dma = dma_map_single (
1038                                         hcd->self.controller,
1039                                         urb->transfer_buffer,
1040                                         urb->transfer_buffer_length,
1041                                         usb_urb_dir_in(urb)
1042                                             ? DMA_FROM_DEVICE
1043                                             : DMA_TO_DEVICE);
1044         }
1045 }
1046
1047 static void unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
1048 {
1049         if (hcd->self.uses_dma && !is_root_hub(urb->dev)) {
1050                 if (usb_endpoint_xfer_control(&urb->ep->desc)
1051                         && !(urb->transfer_flags & URB_NO_SETUP_DMA_MAP))
1052                         dma_unmap_single(hcd->self.controller, urb->setup_dma,
1053                                         sizeof(struct usb_ctrlrequest),
1054                                         DMA_TO_DEVICE);
1055                 if (urb->transfer_buffer_length != 0
1056                         && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP))
1057                         dma_unmap_single(hcd->self.controller,
1058                                         urb->transfer_dma,
1059                                         urb->transfer_buffer_length,
1060                                         usb_urb_dir_in(urb)
1061                                             ? DMA_FROM_DEVICE
1062                                             : DMA_TO_DEVICE);
1063         }
1064 }
1065
1066 /*-------------------------------------------------------------------------*/
1067
1068 /* may be called in any context with a valid urb->dev usecount
1069  * caller surrenders "ownership" of urb
1070  * expects usb_submit_urb() to have sanity checked and conditioned all
1071  * inputs in the urb
1072  */
1073 int usb_hcd_submit_urb (struct urb *urb, gfp_t mem_flags)
1074 {
1075         int                     status;
1076         struct usb_hcd          *hcd = bus_to_hcd(urb->dev->bus);
1077
1078         /* increment urb's reference count as part of giving it to the HCD
1079          * (which will control it).  HCD guarantees that it either returns
1080          * an error or calls giveback(), but not both.
1081          */
1082         usb_get_urb(urb);
1083         atomic_inc(&urb->use_count);
1084         usbmon_urb_submit(&hcd->self, urb);
1085
1086         /* NOTE requirements on root-hub callers (usbfs and the hub
1087          * driver, for now):  URBs' urb->transfer_buffer must be
1088          * valid and usb_buffer_{sync,unmap}() not be needed, since
1089          * they could clobber root hub response data.  Also, control
1090          * URBs must be submitted in process context with interrupts
1091          * enabled.
1092          */
1093         status = usb_hcd_link_urb_to_ep(hcd, urb);
1094         if (!status) {
1095                 map_urb_for_dma(hcd, urb);
1096                 if (is_root_hub(urb->dev))
1097                         status = rh_urb_enqueue(hcd, urb);
1098                 else
1099                         status = hcd->driver->urb_enqueue(hcd, urb->ep, urb,
1100                                         mem_flags);
1101         }
1102
1103         if (unlikely(status)) {
1104                 usbmon_urb_submit_error(&hcd->self, urb, status);
1105                 unmap_urb_for_dma(hcd, urb);
1106                 usb_hcd_unlink_urb_from_ep(hcd, urb);
1107                 INIT_LIST_HEAD(&urb->urb_list);
1108                 atomic_dec(&urb->use_count);
1109                 if (urb->reject)
1110                         wake_up(&usb_kill_urb_queue);
1111                 usb_put_urb(urb);
1112         }
1113         return status;
1114 }
1115
1116 /*-------------------------------------------------------------------------*/
1117
1118 /* this makes the hcd giveback() the urb more quickly, by kicking it
1119  * off hardware queues (which may take a while) and returning it as
1120  * soon as practical.  we've already set up the urb's return status,
1121  * but we can't know if the callback completed already.
1122  */
1123 static int
1124 unlink1 (struct usb_hcd *hcd, struct urb *urb)
1125 {
1126         int             value;
1127
1128         if (is_root_hub(urb->dev))
1129                 value = usb_rh_urb_dequeue (hcd, urb);
1130         else {
1131
1132                 /* The only reason an HCD might fail this call is if
1133                  * it has not yet fully queued the urb to begin with.
1134                  * Such failures should be harmless. */
1135                 value = hcd->driver->urb_dequeue (hcd, urb);
1136         }
1137
1138         if (value != 0)
1139                 dev_dbg (hcd->self.controller, "dequeue %p --> %d\n",
1140                                 urb, value);
1141         return value;
1142 }
1143
1144 /*
1145  * called in any context
1146  *
1147  * caller guarantees urb won't be recycled till both unlink()
1148  * and the urb's completion function return
1149  */
1150 int usb_hcd_unlink_urb (struct urb *urb, int status)
1151 {
1152         struct usb_hcd          *hcd;
1153         int                     retval;
1154
1155         hcd = bus_to_hcd(urb->dev->bus);
1156
1157         retval = usb_hcd_check_unlink_urb(hcd, urb, status);
1158         if (!retval)
1159                 retval = unlink1(hcd, urb);
1160
1161         if (retval == 0)
1162                 retval = -EINPROGRESS;
1163         else if (retval != -EIDRM)
1164                 dev_dbg(&urb->dev->dev, "hcd_unlink_urb %p fail %d\n",
1165                                 urb, retval);
1166         return retval;
1167 }
1168
1169 /*-------------------------------------------------------------------------*/
1170
1171 /**
1172  * usb_hcd_giveback_urb - return URB from HCD to device driver
1173  * @hcd: host controller returning the URB
1174  * @urb: urb being returned to the USB device driver.
1175  * Context: in_interrupt()
1176  *
1177  * This hands the URB from HCD to its USB device driver, using its
1178  * completion function.  The HCD has freed all per-urb resources
1179  * (and is done using urb->hcpriv).  It also released all HCD locks;
1180  * the device driver won't cause problems if it frees, modifies,
1181  * or resubmits this URB.
1182  */
1183 void usb_hcd_giveback_urb (struct usb_hcd *hcd, struct urb *urb)
1184 {
1185         usb_hcd_unlink_urb_from_ep(hcd, urb);
1186         unmap_urb_for_dma(hcd, urb);
1187         usbmon_urb_complete (&hcd->self, urb);
1188         usb_unanchor_urb(urb);
1189
1190         /* pass ownership to the completion handler */
1191         urb->complete (urb);
1192         atomic_dec (&urb->use_count);
1193         if (unlikely (urb->reject))
1194                 wake_up (&usb_kill_urb_queue);
1195         usb_put_urb (urb);
1196 }
1197 EXPORT_SYMBOL (usb_hcd_giveback_urb);
1198
1199 /*-------------------------------------------------------------------------*/
1200
1201 /* disables the endpoint: cancels any pending urbs, then synchronizes with
1202  * the hcd to make sure all endpoint state is gone from hardware, and then
1203  * waits until the endpoint's queue is completely drained. use for
1204  * set_configuration, set_interface, driver removal, physical disconnect.
1205  *
1206  * example:  a qh stored in ep->hcpriv, holding state related to endpoint
1207  * type, maxpacket size, toggle, halt status, and scheduling.
1208  */
1209 void usb_hcd_endpoint_disable (struct usb_device *udev,
1210                 struct usb_host_endpoint *ep)
1211 {
1212         struct usb_hcd          *hcd;
1213         struct urb              *urb;
1214
1215         might_sleep();
1216         hcd = bus_to_hcd(udev->bus);
1217
1218         /* ep is already gone from udev->ep_{in,out}[]; no more submits */
1219 rescan:
1220         spin_lock_irq(&hcd_urb_list_lock);
1221         list_for_each_entry (urb, &ep->urb_list, urb_list) {
1222                 int     tmp;
1223                 int     is_in;
1224
1225                 /* the urb may already have been unlinked */
1226                 if (urb->status != -EINPROGRESS)
1227                         continue;
1228                 usb_get_urb (urb);
1229                 is_in = usb_urb_dir_in(urb);
1230                 spin_unlock(&hcd_urb_list_lock);
1231
1232                 spin_lock (&urb->lock);
1233                 tmp = urb->status;
1234                 if (tmp == -EINPROGRESS)
1235                         urb->status = -ESHUTDOWN;
1236                 spin_unlock (&urb->lock);
1237
1238                 /* kick hcd unless it's already returning this */
1239                 if (tmp == -EINPROGRESS) {
1240                         unlink1 (hcd, urb);
1241                         dev_dbg (hcd->self.controller,
1242                                 "shutdown urb %p ep%d%s%s\n",
1243                                 urb, usb_endpoint_num(&ep->desc),
1244                                 is_in ? "in" : "out",
1245                                 ({      char *s;
1246
1247                                         switch (usb_endpoint_type(&ep->desc)) {
1248                                         case USB_ENDPOINT_XFER_CONTROL:
1249                                                 s = ""; break;
1250                                         case USB_ENDPOINT_XFER_BULK:
1251                                                 s = "-bulk"; break;
1252                                         case USB_ENDPOINT_XFER_INT:
1253                                                 s = "-intr"; break;
1254                                         default:
1255                                                 s = "-iso"; break;
1256                                         };
1257                                         s;
1258                                 }));
1259                 }
1260                 usb_put_urb (urb);
1261
1262                 /* list contents may have changed */
1263                 goto rescan;
1264         }
1265         spin_unlock_irq(&hcd_urb_list_lock);
1266
1267         /* synchronize with the hardware, so old configuration state
1268          * clears out immediately (and will be freed).
1269          */
1270         if (hcd->driver->endpoint_disable)
1271                 hcd->driver->endpoint_disable (hcd, ep);
1272
1273         /* Wait until the endpoint queue is completely empty.  Most HCDs
1274          * will have done this already in their endpoint_disable method,
1275          * but some might not.  And there could be root-hub control URBs
1276          * still pending since they aren't affected by the HCDs'
1277          * endpoint_disable methods.
1278          */
1279         while (!list_empty (&ep->urb_list)) {
1280                 spin_lock_irq(&hcd_urb_list_lock);
1281
1282                 /* The list may have changed while we acquired the spinlock */
1283                 urb = NULL;
1284                 if (!list_empty (&ep->urb_list)) {
1285                         urb = list_entry (ep->urb_list.prev, struct urb,
1286                                         urb_list);
1287                         usb_get_urb (urb);
1288                 }
1289                 spin_unlock_irq(&hcd_urb_list_lock);
1290
1291                 if (urb) {
1292                         usb_kill_urb (urb);
1293                         usb_put_urb (urb);
1294                 }
1295         }
1296 }
1297
1298 /*-------------------------------------------------------------------------*/
1299
1300 /* called in any context */
1301 int usb_hcd_get_frame_number (struct usb_device *udev)
1302 {
1303         struct usb_hcd  *hcd = bus_to_hcd(udev->bus);
1304
1305         if (!HC_IS_RUNNING (hcd->state))
1306                 return -ESHUTDOWN;
1307         return hcd->driver->get_frame_number (hcd);
1308 }
1309
1310 /*-------------------------------------------------------------------------*/
1311
1312 #ifdef  CONFIG_PM
1313
1314 int hcd_bus_suspend(struct usb_device *rhdev)
1315 {
1316         struct usb_hcd  *hcd = container_of(rhdev->bus, struct usb_hcd, self);
1317         int             status;
1318         int             old_state = hcd->state;
1319
1320         dev_dbg(&rhdev->dev, "bus %s%s\n",
1321                         rhdev->auto_pm ? "auto-" : "", "suspend");
1322         if (!hcd->driver->bus_suspend) {
1323                 status = -ENOENT;
1324         } else {
1325                 hcd->state = HC_STATE_QUIESCING;
1326                 status = hcd->driver->bus_suspend(hcd);
1327         }
1328         if (status == 0) {
1329                 usb_set_device_state(rhdev, USB_STATE_SUSPENDED);
1330                 hcd->state = HC_STATE_SUSPENDED;
1331         } else {
1332                 hcd->state = old_state;
1333                 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
1334                                 "suspend", status);
1335         }
1336         return status;
1337 }
1338
1339 int hcd_bus_resume(struct usb_device *rhdev)
1340 {
1341         struct usb_hcd  *hcd = container_of(rhdev->bus, struct usb_hcd, self);
1342         int             status;
1343         int             old_state = hcd->state;
1344
1345         dev_dbg(&rhdev->dev, "usb %s%s\n",
1346                         rhdev->auto_pm ? "auto-" : "", "resume");
1347         if (!hcd->driver->bus_resume)
1348                 return -ENOENT;
1349         if (hcd->state == HC_STATE_RUNNING)
1350                 return 0;
1351
1352         hcd->state = HC_STATE_RESUMING;
1353         status = hcd->driver->bus_resume(hcd);
1354         if (status == 0) {
1355                 /* TRSMRCY = 10 msec */
1356                 msleep(10);
1357                 usb_set_device_state(rhdev, rhdev->actconfig
1358                                 ? USB_STATE_CONFIGURED
1359                                 : USB_STATE_ADDRESS);
1360                 hcd->state = HC_STATE_RUNNING;
1361         } else {
1362                 hcd->state = old_state;
1363                 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
1364                                 "resume", status);
1365                 if (status != -ESHUTDOWN)
1366                         usb_hc_died(hcd);
1367         }
1368         return status;
1369 }
1370
1371 /* Workqueue routine for root-hub remote wakeup */
1372 static void hcd_resume_work(struct work_struct *work)
1373 {
1374         struct usb_hcd *hcd = container_of(work, struct usb_hcd, wakeup_work);
1375         struct usb_device *udev = hcd->self.root_hub;
1376
1377         usb_lock_device(udev);
1378         usb_mark_last_busy(udev);
1379         usb_external_resume_device(udev);
1380         usb_unlock_device(udev);
1381 }
1382
1383 /**
1384  * usb_hcd_resume_root_hub - called by HCD to resume its root hub
1385  * @hcd: host controller for this root hub
1386  *
1387  * The USB host controller calls this function when its root hub is
1388  * suspended (with the remote wakeup feature enabled) and a remote
1389  * wakeup request is received.  The routine submits a workqueue request
1390  * to resume the root hub (that is, manage its downstream ports again).
1391  */
1392 void usb_hcd_resume_root_hub (struct usb_hcd *hcd)
1393 {
1394         unsigned long flags;
1395
1396         spin_lock_irqsave (&hcd_root_hub_lock, flags);
1397         if (hcd->rh_registered)
1398                 queue_work(ksuspend_usb_wq, &hcd->wakeup_work);
1399         spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
1400 }
1401 EXPORT_SYMBOL_GPL(usb_hcd_resume_root_hub);
1402
1403 #endif
1404
1405 /*-------------------------------------------------------------------------*/
1406
1407 #ifdef  CONFIG_USB_OTG
1408
1409 /**
1410  * usb_bus_start_enum - start immediate enumeration (for OTG)
1411  * @bus: the bus (must use hcd framework)
1412  * @port_num: 1-based number of port; usually bus->otg_port
1413  * Context: in_interrupt()
1414  *
1415  * Starts enumeration, with an immediate reset followed later by
1416  * khubd identifying and possibly configuring the device.
1417  * This is needed by OTG controller drivers, where it helps meet
1418  * HNP protocol timing requirements for starting a port reset.
1419  */
1420 int usb_bus_start_enum(struct usb_bus *bus, unsigned port_num)
1421 {
1422         struct usb_hcd          *hcd;
1423         int                     status = -EOPNOTSUPP;
1424
1425         /* NOTE: since HNP can't start by grabbing the bus's address0_sem,
1426          * boards with root hubs hooked up to internal devices (instead of
1427          * just the OTG port) may need more attention to resetting...
1428          */
1429         hcd = container_of (bus, struct usb_hcd, self);
1430         if (port_num && hcd->driver->start_port_reset)
1431                 status = hcd->driver->start_port_reset(hcd, port_num);
1432
1433         /* run khubd shortly after (first) root port reset finishes;
1434          * it may issue others, until at least 50 msecs have passed.
1435          */
1436         if (status == 0)
1437                 mod_timer(&hcd->rh_timer, jiffies + msecs_to_jiffies(10));
1438         return status;
1439 }
1440 EXPORT_SYMBOL (usb_bus_start_enum);
1441
1442 #endif
1443
1444 /*-------------------------------------------------------------------------*/
1445
1446 /**
1447  * usb_hcd_irq - hook IRQs to HCD framework (bus glue)
1448  * @irq: the IRQ being raised
1449  * @__hcd: pointer to the HCD whose IRQ is being signaled
1450  * @r: saved hardware registers
1451  *
1452  * If the controller isn't HALTed, calls the driver's irq handler.
1453  * Checks whether the controller is now dead.
1454  */
1455 irqreturn_t usb_hcd_irq (int irq, void *__hcd)
1456 {
1457         struct usb_hcd          *hcd = __hcd;
1458         int                     start = hcd->state;
1459
1460         if (unlikely(start == HC_STATE_HALT ||
1461             !test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags)))
1462                 return IRQ_NONE;
1463         if (hcd->driver->irq (hcd) == IRQ_NONE)
1464                 return IRQ_NONE;
1465
1466         set_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
1467
1468         if (unlikely(hcd->state == HC_STATE_HALT))
1469                 usb_hc_died (hcd);
1470         return IRQ_HANDLED;
1471 }
1472
1473 /*-------------------------------------------------------------------------*/
1474
1475 /**
1476  * usb_hc_died - report abnormal shutdown of a host controller (bus glue)
1477  * @hcd: pointer to the HCD representing the controller
1478  *
1479  * This is called by bus glue to report a USB host controller that died
1480  * while operations may still have been pending.  It's called automatically
1481  * by the PCI glue, so only glue for non-PCI busses should need to call it.
1482  */
1483 void usb_hc_died (struct usb_hcd *hcd)
1484 {
1485         unsigned long flags;
1486
1487         dev_err (hcd->self.controller, "HC died; cleaning up\n");
1488
1489         spin_lock_irqsave (&hcd_root_hub_lock, flags);
1490         if (hcd->rh_registered) {
1491                 hcd->poll_rh = 0;
1492
1493                 /* make khubd clean up old urbs and devices */
1494                 usb_set_device_state (hcd->self.root_hub,
1495                                 USB_STATE_NOTATTACHED);
1496                 usb_kick_khubd (hcd->self.root_hub);
1497         }
1498         spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
1499 }
1500 EXPORT_SYMBOL_GPL (usb_hc_died);
1501
1502 /*-------------------------------------------------------------------------*/
1503
1504 /**
1505  * usb_create_hcd - create and initialize an HCD structure
1506  * @driver: HC driver that will use this hcd
1507  * @dev: device for this HC, stored in hcd->self.controller
1508  * @bus_name: value to store in hcd->self.bus_name
1509  * Context: !in_interrupt()
1510  *
1511  * Allocate a struct usb_hcd, with extra space at the end for the
1512  * HC driver's private data.  Initialize the generic members of the
1513  * hcd structure.
1514  *
1515  * If memory is unavailable, returns NULL.
1516  */
1517 struct usb_hcd *usb_create_hcd (const struct hc_driver *driver,
1518                 struct device *dev, char *bus_name)
1519 {
1520         struct usb_hcd *hcd;
1521
1522         hcd = kzalloc(sizeof(*hcd) + driver->hcd_priv_size, GFP_KERNEL);
1523         if (!hcd) {
1524                 dev_dbg (dev, "hcd alloc failed\n");
1525                 return NULL;
1526         }
1527         dev_set_drvdata(dev, hcd);
1528         kref_init(&hcd->kref);
1529
1530         usb_bus_init(&hcd->self);
1531         hcd->self.controller = dev;
1532         hcd->self.bus_name = bus_name;
1533         hcd->self.uses_dma = (dev->dma_mask != NULL);
1534
1535         init_timer(&hcd->rh_timer);
1536         hcd->rh_timer.function = rh_timer_func;
1537         hcd->rh_timer.data = (unsigned long) hcd;
1538 #ifdef CONFIG_PM
1539         INIT_WORK(&hcd->wakeup_work, hcd_resume_work);
1540 #endif
1541
1542         hcd->driver = driver;
1543         hcd->product_desc = (driver->product_desc) ? driver->product_desc :
1544                         "USB Host Controller";
1545
1546         return hcd;
1547 }
1548 EXPORT_SYMBOL (usb_create_hcd);
1549
1550 static void hcd_release (struct kref *kref)
1551 {
1552         struct usb_hcd *hcd = container_of (kref, struct usb_hcd, kref);
1553
1554         kfree(hcd);
1555 }
1556
1557 struct usb_hcd *usb_get_hcd (struct usb_hcd *hcd)
1558 {
1559         if (hcd)
1560                 kref_get (&hcd->kref);
1561         return hcd;
1562 }
1563 EXPORT_SYMBOL (usb_get_hcd);
1564
1565 void usb_put_hcd (struct usb_hcd *hcd)
1566 {
1567         if (hcd)
1568                 kref_put (&hcd->kref, hcd_release);
1569 }
1570 EXPORT_SYMBOL (usb_put_hcd);
1571
1572 /**
1573  * usb_add_hcd - finish generic HCD structure initialization and register
1574  * @hcd: the usb_hcd structure to initialize
1575  * @irqnum: Interrupt line to allocate
1576  * @irqflags: Interrupt type flags
1577  *
1578  * Finish the remaining parts of generic HCD initialization: allocate the
1579  * buffers of consistent memory, register the bus, request the IRQ line,
1580  * and call the driver's reset() and start() routines.
1581  */
1582 int usb_add_hcd(struct usb_hcd *hcd,
1583                 unsigned int irqnum, unsigned long irqflags)
1584 {
1585         int retval;
1586         struct usb_device *rhdev;
1587
1588         dev_info(hcd->self.controller, "%s\n", hcd->product_desc);
1589
1590         set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1591
1592         /* HC is in reset state, but accessible.  Now do the one-time init,
1593          * bottom up so that hcds can customize the root hubs before khubd
1594          * starts talking to them.  (Note, bus id is assigned early too.)
1595          */
1596         if ((retval = hcd_buffer_create(hcd)) != 0) {
1597                 dev_dbg(hcd->self.controller, "pool alloc failed\n");
1598                 return retval;
1599         }
1600
1601         if ((retval = usb_register_bus(&hcd->self)) < 0)
1602                 goto err_register_bus;
1603
1604         if ((rhdev = usb_alloc_dev(NULL, &hcd->self, 0)) == NULL) {
1605                 dev_err(hcd->self.controller, "unable to allocate root hub\n");
1606                 retval = -ENOMEM;
1607                 goto err_allocate_root_hub;
1608         }
1609         rhdev->speed = (hcd->driver->flags & HCD_USB2) ? USB_SPEED_HIGH :
1610                         USB_SPEED_FULL;
1611         hcd->self.root_hub = rhdev;
1612
1613         /* wakeup flag init defaults to "everything works" for root hubs,
1614          * but drivers can override it in reset() if needed, along with
1615          * recording the overall controller's system wakeup capability.
1616          */
1617         device_init_wakeup(&rhdev->dev, 1);
1618
1619         /* "reset" is misnamed; its role is now one-time init. the controller
1620          * should already have been reset (and boot firmware kicked off etc).
1621          */
1622         if (hcd->driver->reset && (retval = hcd->driver->reset(hcd)) < 0) {
1623                 dev_err(hcd->self.controller, "can't setup\n");
1624                 goto err_hcd_driver_setup;
1625         }
1626
1627         /* NOTE: root hub and controller capabilities may not be the same */
1628         if (device_can_wakeup(hcd->self.controller)
1629                         && device_can_wakeup(&hcd->self.root_hub->dev))
1630                 dev_dbg(hcd->self.controller, "supports USB remote wakeup\n");
1631
1632         /* enable irqs just before we start the controller */
1633         if (hcd->driver->irq) {
1634                 snprintf(hcd->irq_descr, sizeof(hcd->irq_descr), "%s:usb%d",
1635                                 hcd->driver->description, hcd->self.busnum);
1636                 if ((retval = request_irq(irqnum, &usb_hcd_irq, irqflags,
1637                                 hcd->irq_descr, hcd)) != 0) {
1638                         dev_err(hcd->self.controller,
1639                                         "request interrupt %d failed\n", irqnum);
1640                         goto err_request_irq;
1641                 }
1642                 hcd->irq = irqnum;
1643                 dev_info(hcd->self.controller, "irq %d, %s 0x%08llx\n", irqnum,
1644                                 (hcd->driver->flags & HCD_MEMORY) ?
1645                                         "io mem" : "io base",
1646                                         (unsigned long long)hcd->rsrc_start);
1647         } else {
1648                 hcd->irq = -1;
1649                 if (hcd->rsrc_start)
1650                         dev_info(hcd->self.controller, "%s 0x%08llx\n",
1651                                         (hcd->driver->flags & HCD_MEMORY) ?
1652                                         "io mem" : "io base",
1653                                         (unsigned long long)hcd->rsrc_start);
1654         }
1655
1656         if ((retval = hcd->driver->start(hcd)) < 0) {
1657                 dev_err(hcd->self.controller, "startup error %d\n", retval);
1658                 goto err_hcd_driver_start;
1659         }
1660
1661         /* starting here, usbcore will pay attention to this root hub */
1662         rhdev->bus_mA = min(500u, hcd->power_budget);
1663         if ((retval = register_root_hub(hcd)) != 0)
1664                 goto err_register_root_hub;
1665
1666         if (hcd->uses_new_polling && hcd->poll_rh)
1667                 usb_hcd_poll_rh_status(hcd);
1668         return retval;
1669
1670 err_register_root_hub:
1671         hcd->driver->stop(hcd);
1672 err_hcd_driver_start:
1673         if (hcd->irq >= 0)
1674                 free_irq(irqnum, hcd);
1675 err_request_irq:
1676 err_hcd_driver_setup:
1677         hcd->self.root_hub = NULL;
1678         usb_put_dev(rhdev);
1679 err_allocate_root_hub:
1680         usb_deregister_bus(&hcd->self);
1681 err_register_bus:
1682         hcd_buffer_destroy(hcd);
1683         return retval;
1684 }
1685 EXPORT_SYMBOL (usb_add_hcd);
1686
1687 /**
1688  * usb_remove_hcd - shutdown processing for generic HCDs
1689  * @hcd: the usb_hcd structure to remove
1690  * Context: !in_interrupt()
1691  *
1692  * Disconnects the root hub, then reverses the effects of usb_add_hcd(),
1693  * invoking the HCD's stop() method.
1694  */
1695 void usb_remove_hcd(struct usb_hcd *hcd)
1696 {
1697         dev_info(hcd->self.controller, "remove, state %x\n", hcd->state);
1698
1699         if (HC_IS_RUNNING (hcd->state))
1700                 hcd->state = HC_STATE_QUIESCING;
1701
1702         dev_dbg(hcd->self.controller, "roothub graceful disconnect\n");
1703         spin_lock_irq (&hcd_root_hub_lock);
1704         hcd->rh_registered = 0;
1705         spin_unlock_irq (&hcd_root_hub_lock);
1706
1707 #ifdef CONFIG_PM
1708         cancel_work_sync(&hcd->wakeup_work);
1709 #endif
1710
1711         mutex_lock(&usb_bus_list_lock);
1712         usb_disconnect(&hcd->self.root_hub);
1713         mutex_unlock(&usb_bus_list_lock);
1714
1715         hcd->driver->stop(hcd);
1716         hcd->state = HC_STATE_HALT;
1717
1718         hcd->poll_rh = 0;
1719         del_timer_sync(&hcd->rh_timer);
1720
1721         if (hcd->irq >= 0)
1722                 free_irq(hcd->irq, hcd);
1723         usb_deregister_bus(&hcd->self);
1724         hcd_buffer_destroy(hcd);
1725 }
1726 EXPORT_SYMBOL (usb_remove_hcd);
1727
1728 void
1729 usb_hcd_platform_shutdown(struct platform_device* dev)
1730 {
1731         struct usb_hcd *hcd = platform_get_drvdata(dev);
1732
1733         if (hcd->driver->shutdown)
1734                 hcd->driver->shutdown(hcd);
1735 }
1736 EXPORT_SYMBOL (usb_hcd_platform_shutdown);
1737
1738 /*-------------------------------------------------------------------------*/
1739
1740 #if defined(CONFIG_USB_MON)
1741
1742 struct usb_mon_operations *mon_ops;
1743
1744 /*
1745  * The registration is unlocked.
1746  * We do it this way because we do not want to lock in hot paths.
1747  *
1748  * Notice that the code is minimally error-proof. Because usbmon needs
1749  * symbols from usbcore, usbcore gets referenced and cannot be unloaded first.
1750  */
1751
1752 int usb_mon_register (struct usb_mon_operations *ops)
1753 {
1754
1755         if (mon_ops)
1756                 return -EBUSY;
1757
1758         mon_ops = ops;
1759         mb();
1760         return 0;
1761 }
1762 EXPORT_SYMBOL_GPL (usb_mon_register);
1763
1764 void usb_mon_deregister (void)
1765 {
1766
1767         if (mon_ops == NULL) {
1768                 printk(KERN_ERR "USB: monitor was not registered\n");
1769                 return;
1770         }
1771         mon_ops = NULL;
1772         mb();
1773 }
1774 EXPORT_SYMBOL_GPL (usb_mon_deregister);
1775
1776 #endif /* CONFIG_USB_MON */