drivers/usb/core/hcd.c

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