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 <linux/device.h>
  34 #include <linux/dma-mapping.h>
  35 #include <linux/mutex.h>
  36 #include <asm/irq.h>
  37 #include <asm/byteorder.h>
  38 #include <asm/unaligned.h>
  39 #include <linux/platform_device.h>
  40 #include <linux/workqueue.h>
  41
  42 #include <linux/usb.h>
  43 #include <linux/usb/hcd.h>
  44
  45 #include "usb.h"
  46
  47
  48 /*-------------------------------------------------------------------------*/
  49
  50 /*
  51  * USB Host Controller Driver framework
  52  *
  53  * Plugs into usbcore (usb_bus) and lets HCDs share code, minimizing
  54  * HCD-specific behaviors/bugs.
  55  *
  56  * This does error checks, tracks devices and urbs, and delegates to a
  57  * "hc_driver" only for code (and data) that really needs to know about
  58  * hardware differences.  That includes root hub registers, i/o queues,
  59  * and so on ... but as little else as possible.
  60  *
  61  * Shared code includes most of the "root hub" code (these are emulated,
  62  * though each HC's hardware works differently) and PCI glue, plus request
  63  * tracking overhead.  The HCD code should only block on spinlocks or on
  64  * hardware handshaking; blocking on software events (such as other kernel
  65  * threads releasing resources, or completing actions) is all generic.
  66  *
  67  * Happens the USB 2.0 spec says this would be invisible inside the "USBD",
  68  * and includes mostly a "HCDI" (HCD Interface) along with some APIs used
  69  * only by the hub driver ... and that neither should be seen or used by
  70  * usb client device drivers.
  71  *
  72  * Contributors of ideas or unattributed patches include: David Brownell,
  73  * Roman Weissgaerber, Rory Bolt, Greg Kroah-Hartman, ...
  74  *
  75  * HISTORY:
  76  * 2002-02-21   Pull in most of the usb_bus support from usb.c; some
  77  *              associated cleanup.  "usb_hcd" still != "usb_bus".
  78  * 2001-12-12   Initial patch version for Linux 2.5.1 kernel.
  79  */
  80
  81 /*-------------------------------------------------------------------------*/
  82
  83 /* Keep track of which host controller drivers are loaded */
  84 unsigned long usb_hcds_loaded;
  85 EXPORT_SYMBOL_GPL(usb_hcds_loaded);
  86
  87 /* host controllers we manage */
  88 LIST_HEAD (usb_bus_list);
  89 EXPORT_SYMBOL_GPL (usb_bus_list);
  90
  91 /* used when allocating bus numbers */
  92 #define USB_MAXBUS              64
  93 struct usb_busmap {
  94         unsigned long busmap [USB_MAXBUS / (8*sizeof (unsigned long))];
  95 };
  96 static struct usb_busmap busmap;
  97
  98 /* used when updating list of hcds */
  99 DEFINE_MUTEX(usb_bus_list_lock);        /* exported only for usbfs */
 100 EXPORT_SYMBOL_GPL (usb_bus_list_lock);
 101
 102 /* used for controlling access to virtual root hubs */
 103 static DEFINE_SPINLOCK(hcd_root_hub_lock);
 104
 105 /* used when updating an endpoint's URB list */
 106 static DEFINE_SPINLOCK(hcd_urb_list_lock);
 107
 108 /* used to protect against unlinking URBs after the device is gone */
 109 static DEFINE_SPINLOCK(hcd_urb_unlink_lock);
 110
 111 /* wait queue for synchronous unlinks */
 112 DECLARE_WAIT_QUEUE_HEAD(usb_kill_urb_queue);
 113
 114 static inline int is_root_hub(struct usb_device *udev)
 115 {
 116         return (udev->parent == NULL);
 117 }
 118
 119 /*-------------------------------------------------------------------------*/
 120
 121 /*
 122  * Sharable chunks of root hub code.
 123  */
 124
 125 /*-------------------------------------------------------------------------*/
 126
 127 #define KERNEL_REL      ((LINUX_VERSION_CODE >> 16) & 0x0ff)
 128 #define KERNEL_VER      ((LINUX_VERSION_CODE >> 8) & 0x0ff)
 129
 130 /* usb 3.0 root hub device descriptor */
 131 static const u8 usb3_rh_dev_descriptor[18] = {
 132         0x12,       /*  __u8  bLength; */
 133         0x01,       /*  __u8  bDescriptorType; Device */
 134         0x00, 0x03, /*  __le16 bcdUSB; v3.0 */
 135
 136         0x09,       /*  __u8  bDeviceClass; HUB_CLASSCODE */
 137         0x00,       /*  __u8  bDeviceSubClass; */
 138         0x03,       /*  __u8  bDeviceProtocol; USB 3.0 hub */
 139         0x09,       /*  __u8  bMaxPacketSize0; 2^9 = 512 Bytes */
 140
 141         0x6b, 0x1d, /*  __le16 idVendor; Linux Foundation */
 142         0x03, 0x00, /*  __le16 idProduct; device 0x0003 */
 143         KERNEL_VER, KERNEL_REL, /*  __le16 bcdDevice */
 144
 145         0x03,       /*  __u8  iManufacturer; */
 146         0x02,       /*  __u8  iProduct; */
 147         0x01,       /*  __u8  iSerialNumber; */
 148         0x01        /*  __u8  bNumConfigurations; */
 149 };
 150
 151 /* usb 2.0 root hub device descriptor */
 152 static const u8 usb2_rh_dev_descriptor [18] = {
 153         0x12,       /*  __u8  bLength; */
 154         0x01,       /*  __u8  bDescriptorType; Device */
 155         0x00, 0x02, /*  __le16 bcdUSB; v2.0 */
 156
 157         0x09,       /*  __u8  bDeviceClass; HUB_CLASSCODE */
 158         0x00,       /*  __u8  bDeviceSubClass; */
 159         0x00,       /*  __u8  bDeviceProtocol; [ usb 2.0 no TT ] */
 160         0x40,       /*  __u8  bMaxPacketSize0; 64 Bytes */
 161
 162         0x6b, 0x1d, /*  __le16 idVendor; Linux Foundation */
 163         0x02, 0x00, /*  __le16 idProduct; device 0x0002 */
 164         KERNEL_VER, KERNEL_REL, /*  __le16 bcdDevice */
 165
 166         0x03,       /*  __u8  iManufacturer; */
 167         0x02,       /*  __u8  iProduct; */
 168         0x01,       /*  __u8  iSerialNumber; */
 169         0x01        /*  __u8  bNumConfigurations; */
 170 };
 171
 172 /* no usb 2.0 root hub "device qualifier" descriptor: one speed only */
 173
 174 /* usb 1.1 root hub device descriptor */
 175 static const u8 usb11_rh_dev_descriptor [18] = {
 176         0x12,       /*  __u8  bLength; */
 177         0x01,       /*  __u8  bDescriptorType; Device */
 178         0x10, 0x01, /*  __le16 bcdUSB; v1.1 */
 179
 180         0x09,       /*  __u8  bDeviceClass; HUB_CLASSCODE */
 181         0x00,       /*  __u8  bDeviceSubClass; */
 182         0x00,       /*  __u8  bDeviceProtocol; [ low/full speeds only ] */
 183         0x40,       /*  __u8  bMaxPacketSize0; 64 Bytes */
 184
 185         0x6b, 0x1d, /*  __le16 idVendor; Linux Foundation */
 186         0x01, 0x00, /*  __le16 idProduct; device 0x0001 */
 187         KERNEL_VER, KERNEL_REL, /*  __le16 bcdDevice */
 188
 189         0x03,       /*  __u8  iManufacturer; */
 190         0x02,       /*  __u8  iProduct; */
 191         0x01,       /*  __u8  iSerialNumber; */
 192         0x01        /*  __u8  bNumConfigurations; */
 193 };
 194
 195
 196 /*-------------------------------------------------------------------------*/
 197
 198 /* Configuration descriptors for our root hubs */
 199
 200 static const u8 fs_rh_config_descriptor [] = {
 201
 202         /* one configuration */
 203         0x09,       /*  __u8  bLength; */
 204         0x02,       /*  __u8  bDescriptorType; Configuration */
 205         0x19, 0x00, /*  __le16 wTotalLength; */
 206         0x01,       /*  __u8  bNumInterfaces; (1) */
 207         0x01,       /*  __u8  bConfigurationValue; */
 208         0x00,       /*  __u8  iConfiguration; */
 209         0xc0,       /*  __u8  bmAttributes;
 210                                  Bit 7: must be set,
 211                                      6: Self-powered,
 212                                      5: Remote wakeup,
 213                                      4..0: resvd */
 214         0x00,       /*  __u8  MaxPower; */
 215
 216         /* USB 1.1:
 217          * USB 2.0, single TT organization (mandatory):
 218          *      one interface, protocol 0
 219          *
 220          * USB 2.0, multiple TT organization (optional):
 221          *      two interfaces, protocols 1 (like single TT)
 222          *      and 2 (multiple TT mode) ... config is
 223          *      sometimes settable
 224          *      NOT IMPLEMENTED
 225          */
 226
 227         /* one interface */
 228         0x09,       /*  __u8  if_bLength; */
 229         0x04,       /*  __u8  if_bDescriptorType; Interface */
 230         0x00,       /*  __u8  if_bInterfaceNumber; */
 231         0x00,       /*  __u8  if_bAlternateSetting; */
 232         0x01,       /*  __u8  if_bNumEndpoints; */
 233         0x09,       /*  __u8  if_bInterfaceClass; HUB_CLASSCODE */
 234         0x00,       /*  __u8  if_bInterfaceSubClass; */
 235         0x00,       /*  __u8  if_bInterfaceProtocol; [usb1.1 or single tt] */
 236         0x00,       /*  __u8  if_iInterface; */
 237
 238         /* one endpoint (status change endpoint) */
 239         0x07,       /*  __u8  ep_bLength; */
 240         0x05,       /*  __u8  ep_bDescriptorType; Endpoint */
 241         0x81,       /*  __u8  ep_bEndpointAddress; IN Endpoint 1 */
 242         0x03,       /*  __u8  ep_bmAttributes; Interrupt */
 243         0x02, 0x00, /*  __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8) */
 244         0xff        /*  __u8  ep_bInterval; (255ms -- usb 2.0 spec) */
 245 };
 246
 247 static const u8 hs_rh_config_descriptor [] = {
 248
 249         /* one configuration */
 250         0x09,       /*  __u8  bLength; */
 251         0x02,       /*  __u8  bDescriptorType; Configuration */
 252         0x19, 0x00, /*  __le16 wTotalLength; */
 253         0x01,       /*  __u8  bNumInterfaces; (1) */
 254         0x01,       /*  __u8  bConfigurationValue; */
 255         0x00,       /*  __u8  iConfiguration; */
 256         0xc0,       /*  __u8  bmAttributes;
 257                                  Bit 7: must be set,
 258                                      6: Self-powered,
 259                                      5: Remote wakeup,
 260                                      4..0: resvd */
 261         0x00,       /*  __u8  MaxPower; */
 262
 263         /* USB 1.1:
 264          * USB 2.0, single TT organization (mandatory):
 265          *      one interface, protocol 0
 266          *
 267          * USB 2.0, multiple TT organization (optional):
 268          *      two interfaces, protocols 1 (like single TT)
 269          *      and 2 (multiple TT mode) ... config is
 270          *      sometimes settable
 271          *      NOT IMPLEMENTED
 272          */
 273
 274         /* one interface */
 275         0x09,       /*  __u8  if_bLength; */
 276         0x04,       /*  __u8  if_bDescriptorType; Interface */
 277         0x00,       /*  __u8  if_bInterfaceNumber; */
 278         0x00,       /*  __u8  if_bAlternateSetting; */
 279         0x01,       /*  __u8  if_bNumEndpoints; */
 280         0x09,       /*  __u8  if_bInterfaceClass; HUB_CLASSCODE */
 281         0x00,       /*  __u8  if_bInterfaceSubClass; */
 282         0x00,       /*  __u8  if_bInterfaceProtocol; [usb1.1 or single tt] */
 283         0x00,       /*  __u8  if_iInterface; */
 284
 285         /* one endpoint (status change endpoint) */
 286         0x07,       /*  __u8  ep_bLength; */
 287         0x05,       /*  __u8  ep_bDescriptorType; Endpoint */
 288         0x81,       /*  __u8  ep_bEndpointAddress; IN Endpoint 1 */
 289         0x03,       /*  __u8  ep_bmAttributes; Interrupt */
 290                     /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8)
 291                      * see hub.c:hub_configure() for details. */
 292         (USB_MAXCHILDREN + 1 + 7) / 8, 0x00,
 293         0x0c        /*  __u8  ep_bInterval; (256ms -- usb 2.0 spec) */
 294 };
 295
 296 static const u8 ss_rh_config_descriptor[] = {
 297         /* one configuration */
 298         0x09,       /*  __u8  bLength; */
 299         0x02,       /*  __u8  bDescriptorType; Configuration */
 300         0x1f, 0x00, /*  __le16 wTotalLength; */
 301         0x01,       /*  __u8  bNumInterfaces; (1) */
 302         0x01,       /*  __u8  bConfigurationValue; */
 303         0x00,       /*  __u8  iConfiguration; */
 304         0xc0,       /*  __u8  bmAttributes;
 305                                  Bit 7: must be set,
 306                                      6: Self-powered,
 307                                      5: Remote wakeup,
 308                                      4..0: resvd */
 309         0x00,       /*  __u8  MaxPower; */
 310
 311         /* one interface */
 312         0x09,       /*  __u8  if_bLength; */
 313         0x04,       /*  __u8  if_bDescriptorType; Interface */
 314         0x00,       /*  __u8  if_bInterfaceNumber; */
 315         0x00,       /*  __u8  if_bAlternateSetting; */
 316         0x01,       /*  __u8  if_bNumEndpoints; */
 317         0x09,       /*  __u8  if_bInterfaceClass; HUB_CLASSCODE */
 318         0x00,       /*  __u8  if_bInterfaceSubClass; */
 319         0x00,       /*  __u8  if_bInterfaceProtocol; */
 320         0x00,       /*  __u8  if_iInterface; */
 321
 322         /* one endpoint (status change endpoint) */
 323         0x07,       /*  __u8  ep_bLength; */
 324         0x05,       /*  __u8  ep_bDescriptorType; Endpoint */
 325         0x81,       /*  __u8  ep_bEndpointAddress; IN Endpoint 1 */
 326         0x03,       /*  __u8  ep_bmAttributes; Interrupt */
 327                     /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8)
 328                      * see hub.c:hub_configure() for details. */
 329         (USB_MAXCHILDREN + 1 + 7) / 8, 0x00,
 330         0x0c,       /*  __u8  ep_bInterval; (256ms -- usb 2.0 spec) */
 331
 332         /* one SuperSpeed endpoint companion descriptor */
 333         0x06,        /* __u8 ss_bLength */
 334         0x30,        /* __u8 ss_bDescriptorType; SuperSpeed EP Companion */
 335         0x00,        /* __u8 ss_bMaxBurst; allows 1 TX between ACKs */
 336         0x00,        /* __u8 ss_bmAttributes; 1 packet per service interval */
 337         0x02, 0x00   /* __le16 ss_wBytesPerInterval; 15 bits for max 15 ports */
 338 };
 339
 340 /*-------------------------------------------------------------------------*/
 341
 342 /**
 343  * ascii2desc() - Helper routine for producing UTF-16LE string descriptors
 344  * @s: Null-terminated ASCII (actually ISO-8859-1) string
 345  * @buf: Buffer for USB string descriptor (header + UTF-16LE)
 346  * @len: Length (in bytes; may be odd) of descriptor buffer.
 347  *
 348  * The return value is the number of bytes filled in: 2 + 2*strlen(s) or
 349  * buflen, whichever is less.
 350  *
 351  * USB String descriptors can contain at most 126 characters; input
 352  * strings longer than that are truncated.
 353  */
 354 static unsigned
 355 ascii2desc(char const *s, u8 *buf, unsigned len)
 356 {
 357         unsigned n, t = 2 + 2*strlen(s);
 358
 359         if (t > 254)
 360                 t = 254;        /* Longest possible UTF string descriptor */
 361         if (len > t)
 362                 len = t;
 363
 364         t += USB_DT_STRING << 8;        /* Now t is first 16 bits to store */
 365
 366         n = len;
 367         while (n--) {
 368                 *buf++ = t;
 369                 if (!n--)
 370                         break;
 371                 *buf++ = t >> 8;
 372                 t = (unsigned char)*s++;
 373         }
 374         return len;
 375 }
 376
 377 /**
 378  * rh_string() - provides string descriptors for root hub
 379  * @id: the string ID number (0: langids, 1: serial #, 2: product, 3: vendor)
 380  * @hcd: the host controller for this root hub
 381  * @data: buffer for output packet
 382  * @len: length of the provided buffer
 383  *
 384  * Produces either a manufacturer, product or serial number string for the
 385  * virtual root hub device.
 386  * Returns the number of bytes filled in: the length of the descriptor or
 387  * of the provided buffer, whichever is less.
 388  */
 389 static unsigned
 390 rh_string(int id, struct usb_hcd const *hcd, u8 *data, unsigned len)
 391 {
 392         char buf[100];
 393         char const *s;
 394         static char const langids[4] = {4, USB_DT_STRING, 0x09, 0x04};
 395
 396         // language ids
 397         switch (id) {
 398         case 0:
 399                 /* Array of LANGID codes (0x0409 is MSFT-speak for "en-us") */
 400                 /* See http://www.usb.org/developers/docs/USB_LANGIDs.pdf */
 401                 if (len > 4)
 402                         len = 4;
 403                 memcpy(data, langids, len);
 404                 return len;
 405         case 1:
 406                 /* Serial number */
 407                 s = hcd->self.bus_name;
 408                 break;
 409         case 2:
 410                 /* Product name */
 411                 s = hcd->product_desc;
 412                 break;
 413         case 3:
 414                 /* Manufacturer */
 415                 snprintf (buf, sizeof buf, "%s %s %s", init_utsname()->sysname,
 416                         init_utsname()->release, hcd->driver->description);
 417                 s = buf;
 418                 break;
 419         default:
 420                 /* Can't happen; caller guarantees it */
 421                 return 0;
 422         }
 423
 424         return ascii2desc(s, data, len);
 425 }
 426
 427
 428 /* Root hub control transfers execute synchronously */
 429 static int rh_call_control (struct usb_hcd *hcd, struct urb *urb)
 430 {
 431         struct usb_ctrlrequest *cmd;
 432         u16             typeReq, wValue, wIndex, wLength;
 433         u8              *ubuf = urb->transfer_buffer;
 434         u8              tbuf [sizeof (struct usb_hub_descriptor)]
 435                 __attribute__((aligned(4)));
 436         const u8        *bufp = tbuf;
 437         unsigned        len = 0;
 438         int             status;
 439         u8              patch_wakeup = 0;
 440         u8              patch_protocol = 0;
 441
 442         might_sleep();
 443
 444         spin_lock_irq(&hcd_root_hub_lock);
 445         status = usb_hcd_link_urb_to_ep(hcd, urb);
 446         spin_unlock_irq(&hcd_root_hub_lock);
 447         if (status)
 448                 return status;
 449         urb->hcpriv = hcd;      /* Indicate it's queued */
 450
 451         cmd = (struct usb_ctrlrequest *) urb->setup_packet;
 452         typeReq  = (cmd->bRequestType << 8) | cmd->bRequest;
 453         wValue   = le16_to_cpu (cmd->wValue);
 454         wIndex   = le16_to_cpu (cmd->wIndex);
 455         wLength  = le16_to_cpu (cmd->wLength);
 456
 457         if (wLength > urb->transfer_buffer_length)
 458                 goto error;
 459
 460         urb->actual_length = 0;
 461         switch (typeReq) {
 462
 463         /* DEVICE REQUESTS */
 464
 465         /* The root hub's remote wakeup enable bit is implemented using
 466          * driver model wakeup flags.  If this system supports wakeup
 467          * through USB, userspace may change the default "allow wakeup"
 468          * policy through sysfs or these calls.
 469          *
 470          * Most root hubs support wakeup from downstream devices, for
 471          * runtime power management (disabling USB clocks and reducing
 472          * VBUS power usage).  However, not all of them do so; silicon,
 473          * board, and BIOS bugs here are not uncommon, so these can't
 474          * be treated quite like external hubs.
 475          *
 476          * Likewise, not all root hubs will pass wakeup events upstream,
 477          * to wake up the whole system.  So don't assume root hub and
 478          * controller capabilities are identical.
 479          */
 480
 481         case DeviceRequest | USB_REQ_GET_STATUS:
 482                 tbuf [0] = (device_may_wakeup(&hcd->self.root_hub->dev)
 483                                         << USB_DEVICE_REMOTE_WAKEUP)
 484                                 | (1 << USB_DEVICE_SELF_POWERED);
 485                 tbuf [1] = 0;
 486                 len = 2;
 487                 break;
 488         case DeviceOutRequest | USB_REQ_CLEAR_FEATURE:
 489                 if (wValue == USB_DEVICE_REMOTE_WAKEUP)
 490                         device_set_wakeup_enable(&hcd->self.root_hub->dev, 0);
 491                 else
 492                         goto error;
 493                 break;
 494         case DeviceOutRequest | USB_REQ_SET_FEATURE:
 495                 if (device_can_wakeup(&hcd->self.root_hub->dev)
 496                                 && wValue == USB_DEVICE_REMOTE_WAKEUP)
 497                         device_set_wakeup_enable(&hcd->self.root_hub->dev, 1);
 498                 else
 499                         goto error;
 500                 break;
 501         case DeviceRequest | USB_REQ_GET_CONFIGURATION:
 502                 tbuf [0] = 1;
 503                 len = 1;
 504                         /* FALLTHROUGH */
 505         case DeviceOutRequest | USB_REQ_SET_CONFIGURATION:
 506                 break;
 507         case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
 508                 switch (wValue & 0xff00) {
 509                 case USB_DT_DEVICE << 8:
 510                         switch (hcd->driver->flags & HCD_MASK) {
 511                         case HCD_USB3:
 512                                 bufp = usb3_rh_dev_descriptor;
 513                                 break;
 514                         case HCD_USB2:
 515                                 bufp = usb2_rh_dev_descriptor;
 516                                 break;
 517                         case HCD_USB11:
 518                                 bufp = usb11_rh_dev_descriptor;
 519                                 break;
 520                         default:
 521                                 goto error;
 522                         }
 523                         len = 18;
 524                         if (hcd->has_tt)
 525                                 patch_protocol = 1;
 526                         break;
 527                 case USB_DT_CONFIG << 8:
 528                         switch (hcd->driver->flags & HCD_MASK) {
 529                         case HCD_USB3:
 530                                 bufp = ss_rh_config_descriptor;
 531                                 len = sizeof ss_rh_config_descriptor;
 532                                 break;
 533                         case HCD_USB2:
 534                                 bufp = hs_rh_config_descriptor;
 535                                 len = sizeof hs_rh_config_descriptor;
 536                                 break;
 537                         case HCD_USB11:
 538                                 bufp = fs_rh_config_descriptor;
 539                                 len = sizeof fs_rh_config_descriptor;
 540                                 break;
 541                         default:
 542                                 goto error;
 543                         }
 544                         if (device_can_wakeup(&hcd->self.root_hub->dev))
 545                                 patch_wakeup = 1;
 546                         break;
 547                 case USB_DT_STRING << 8:
 548                         if ((wValue & 0xff) < 4)
 549                                 urb->actual_length = rh_string(wValue & 0xff,
 550                                                 hcd, ubuf, wLength);
 551                         else /* unsupported IDs --> "protocol stall" */
 552                                 goto error;
 553                         break;
 554                 default:
 555                         goto error;
 556                 }
 557                 break;
 558         case DeviceRequest | USB_REQ_GET_INTERFACE:
 559                 tbuf [0] = 0;
 560                 len = 1;
 561                         /* FALLTHROUGH */
 562         case DeviceOutRequest | USB_REQ_SET_INTERFACE:
 563                 break;
 564         case DeviceOutRequest | USB_REQ_SET_ADDRESS:
 565                 // wValue == urb->dev->devaddr
 566                 dev_dbg (hcd->self.controller, "root hub device address %d\n",
 567                         wValue);
 568                 break;
 569
 570         /* INTERFACE REQUESTS (no defined feature/status flags) */
 571
 572         /* ENDPOINT REQUESTS */
 573
 574         case EndpointRequest | USB_REQ_GET_STATUS:
 575                 // ENDPOINT_HALT flag
 576                 tbuf [0] = 0;
 577                 tbuf [1] = 0;
 578                 len = 2;
 579                         /* FALLTHROUGH */
 580         case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
 581         case EndpointOutRequest | USB_REQ_SET_FEATURE:
 582                 dev_dbg (hcd->self.controller, "no endpoint features yet\n");
 583                 break;
 584
 585         /* CLASS REQUESTS (and errors) */
 586
 587         default:
 588                 /* non-generic request */
 589                 switch (typeReq) {
 590                 case GetHubStatus:
 591                 case GetPortStatus:
 592                         len = 4;
 593                         break;
 594                 case GetHubDescriptor:
 595                         len = sizeof (struct usb_hub_descriptor);
 596                         break;
 597                 }
 598                 status = hcd->driver->hub_control (hcd,
 599                         typeReq, wValue, wIndex,
 600                         tbuf, wLength);
 601                 break;
 602 error:
 603                 /* "protocol stall" on error */
 604                 status = -EPIPE;
 605         }
 606
 607         if (status) {
 608                 len = 0;
 609                 if (status != -EPIPE) {
 610                         dev_dbg (hcd->self.controller,
 611                                 "CTRL: TypeReq=0x%x val=0x%x "
 612                                 "idx=0x%x len=%d ==> %d\n",
 613                                 typeReq, wValue, wIndex,
 614                                 wLength, status);
 615                 }
 616         }
 617         if (len) {
 618                 if (urb->transfer_buffer_length < len)
 619                         len = urb->transfer_buffer_length;
 620                 urb->actual_length = len;
 621                 // always USB_DIR_IN, toward host
 622                 memcpy (ubuf, bufp, len);
 623
 624                 /* report whether RH hardware supports remote wakeup */
 625                 if (patch_wakeup &&
 626                                 len > offsetof (struct usb_config_descriptor,
 627                                                 bmAttributes))
 628                         ((struct usb_config_descriptor *)ubuf)->bmAttributes
 629                                 |= USB_CONFIG_ATT_WAKEUP;
 630
 631                 /* report whether RH hardware has an integrated TT */
 632                 if (patch_protocol &&
 633                                 len > offsetof(struct usb_device_descriptor,
 634                                                 bDeviceProtocol))
 635                         ((struct usb_device_descriptor *) ubuf)->
 636                                         bDeviceProtocol = 1;
 637         }
 638
 639         /* any errors get returned through the urb completion */
 640         spin_lock_irq(&hcd_root_hub_lock);
 641         usb_hcd_unlink_urb_from_ep(hcd, urb);
 642
 643         /* This peculiar use of spinlocks echoes what real HC drivers do.
 644          * Avoiding calls to local_irq_disable/enable makes the code
 645          * RT-friendly.
 646          */
 647         spin_unlock(&hcd_root_hub_lock);
 648         usb_hcd_giveback_urb(hcd, urb, status);
 649         spin_lock(&hcd_root_hub_lock);
 650
 651         spin_unlock_irq(&hcd_root_hub_lock);
 652         return 0;
 653 }
 654
 655 /*-------------------------------------------------------------------------*/
 656
 657 /*
 658  * Root Hub interrupt transfers are polled using a timer if the
 659  * driver requests it; otherwise the driver is responsible for
 660  * calling usb_hcd_poll_rh_status() when an event occurs.
 661  *
 662  * Completions are called in_interrupt(), but they may or may not
 663  * be in_irq().
 664  */
 665 void usb_hcd_poll_rh_status(struct usb_hcd *hcd)
 666 {
 667         struct urb      *urb;
 668         int             length;
 669         unsigned long   flags;
 670         char            buffer[6];      /* Any root hubs with > 31 ports? */
 671
 672         if (unlikely(!hcd->rh_pollable))
 673                 return;
 674         if (!hcd->uses_new_polling && !hcd->status_urb)
 675                 return;
 676
 677         length = hcd->driver->hub_status_data(hcd, buffer);
 678         if (length > 0) {
 679
 680                 /* try to complete the status urb */
 681                 spin_lock_irqsave(&hcd_root_hub_lock, flags);
 682                 urb = hcd->status_urb;
 683                 if (urb) {
 684                         clear_bit(HCD_FLAG_POLL_PENDING, &hcd->flags);
 685                         hcd->status_urb = NULL;
 686                         urb->actual_length = length;
 687                         memcpy(urb->transfer_buffer, buffer, length);
 688
 689                         usb_hcd_unlink_urb_from_ep(hcd, urb);
 690                         spin_unlock(&hcd_root_hub_lock);
 691                         usb_hcd_giveback_urb(hcd, urb, 0);
 692                         spin_lock(&hcd_root_hub_lock);
 693                 } else {
 694                         length = 0;
 695                         set_bit(HCD_FLAG_POLL_PENDING, &hcd->flags);
 696                 }
 697                 spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
 698         }
 699
 700         /* The USB 2.0 spec says 256 ms.  This is close enough and won't
 701          * exceed that limit if HZ is 100. The math is more clunky than
 702          * maybe expected, this is to make sure that all timers for USB devices
 703          * fire at the same time to give the CPU a break inbetween */
 704         if (hcd->uses_new_polling ? HCD_POLL_RH(hcd) :
 705                         (length == 0 && hcd->status_urb != NULL))
 706                 mod_timer (&hcd->rh_timer, (jiffies/(HZ/4) + 1) * (HZ/4));
 707 }
 708 EXPORT_SYMBOL_GPL(usb_hcd_poll_rh_status);
 709
 710 /* timer callback */
 711 static void rh_timer_func (unsigned long _hcd)
 712 {
 713         usb_hcd_poll_rh_status((struct usb_hcd *) _hcd);
 714 }
 715
 716 /*-------------------------------------------------------------------------*/
 717
 718 static int rh_queue_status (struct usb_hcd *hcd, struct urb *urb)
 719 {
 720         int             retval;
 721         unsigned long   flags;
 722         unsigned        len = 1 + (urb->dev->maxchild / 8);
 723
 724         spin_lock_irqsave (&hcd_root_hub_lock, flags);
 725         if (hcd->status_urb || urb->transfer_buffer_length < len) {
 726                 dev_dbg (hcd->self.controller, "not queuing rh status urb\n");
 727                 retval = -EINVAL;
 728                 goto done;
 729         }
 730
 731         retval = usb_hcd_link_urb_to_ep(hcd, urb);
 732         if (retval)
 733                 goto done;
 734
 735         hcd->status_urb = urb;
 736         urb->hcpriv = hcd;      /* indicate it's queued */
 737         if (!hcd->uses_new_polling)
 738                 mod_timer(&hcd->rh_timer, (jiffies/(HZ/4) + 1) * (HZ/4));
 739
 740         /* If a status change has already occurred, report it ASAP */
 741         else if (HCD_POLL_PENDING(hcd))
 742                 mod_timer(&hcd->rh_timer, jiffies);
 743         retval = 0;
 744  done:
 745         spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
 746         return retval;
 747 }
 748
 749 static int rh_urb_enqueue (struct usb_hcd *hcd, struct urb *urb)
 750 {
 751         if (usb_endpoint_xfer_int(&urb->ep->desc))
 752                 return rh_queue_status (hcd, urb);
 753         if (usb_endpoint_xfer_control(&urb->ep->desc))
 754                 return rh_call_control (hcd, urb);
 755         return -EINVAL;
 756 }
 757
 758 /*-------------------------------------------------------------------------*/
 759
 760 /* Unlinks of root-hub control URBs are legal, but they don't do anything
 761  * since these URBs always execute synchronously.
 762  */
 763 static int usb_rh_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
 764 {
 765         unsigned long   flags;
 766         int             rc;
 767
 768         spin_lock_irqsave(&hcd_root_hub_lock, flags);
 769         rc = usb_hcd_check_unlink_urb(hcd, urb, status);
 770         if (rc)
 771                 goto done;
 772
 773         if (usb_endpoint_num(&urb->ep->desc) == 0) {    /* Control URB */
 774                 ;       /* Do nothing */
 775
 776         } else {                                /* Status URB */
 777                 if (!hcd->uses_new_polling)
 778                         del_timer (&hcd->rh_timer);
 779                 if (urb == hcd->status_urb) {
 780                         hcd->status_urb = NULL;
 781                         usb_hcd_unlink_urb_from_ep(hcd, urb);
 782
 783                         spin_unlock(&hcd_root_hub_lock);
 784                         usb_hcd_giveback_urb(hcd, urb, status);
 785                         spin_lock(&hcd_root_hub_lock);
 786                 }
 787         }
 788  done:
 789         spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
 790         return rc;
 791 }
 792
 793
 794
 795 /*
 796  * Show & store the current value of authorized_default
 797  */
 798 static ssize_t usb_host_authorized_default_show(struct device *dev,
 799                                                 struct device_attribute *attr,
 800                                                 char *buf)
 801 {
 802         struct usb_device *rh_usb_dev = to_usb_device(dev);
 803         struct usb_bus *usb_bus = rh_usb_dev->bus;
 804         struct usb_hcd *usb_hcd;
 805
 806         if (usb_bus == NULL)    /* FIXME: not sure if this case is possible */
 807                 return -ENODEV;
 808         usb_hcd = bus_to_hcd(usb_bus);
 809         return snprintf(buf, PAGE_SIZE, "%u\n", usb_hcd->authorized_default);
 810 }
 811
 812 static ssize_t usb_host_authorized_default_store(struct device *dev,
 813                                                  struct device_attribute *attr,
 814                                                  const char *buf, size_t size)
 815 {
 816         ssize_t result;
 817         unsigned val;
 818         struct usb_device *rh_usb_dev = to_usb_device(dev);
 819         struct usb_bus *usb_bus = rh_usb_dev->bus;
 820         struct usb_hcd *usb_hcd;
 821
 822         if (usb_bus == NULL)    /* FIXME: not sure if this case is possible */
 823                 return -ENODEV;
 824         usb_hcd = bus_to_hcd(usb_bus);
 825         result = sscanf(buf, "%u\n", &val);
 826         if (result == 1) {
 827                 usb_hcd->authorized_default = val? 1 : 0;
 828                 result = size;
 829         }
 830         else
 831                 result = -EINVAL;
 832         return result;
 833 }
 834
 835 static DEVICE_ATTR(authorized_default, 0644,
 836             usb_host_authorized_default_show,
 837             usb_host_authorized_default_store);
 838
 839
 840 /* Group all the USB bus attributes */
 841 static struct attribute *usb_bus_attrs[] = {
 842                 &dev_attr_authorized_default.attr,
 843                 NULL,
 844 };
 845
 846 static struct attribute_group usb_bus_attr_group = {
 847         .name = NULL,   /* we want them in the same directory */
 848         .attrs = usb_bus_attrs,
 849 };
 850
 851
 852
 853 /*-------------------------------------------------------------------------*/
 854
 855 /**
 856  * usb_bus_init - shared initialization code
 857  * @bus: the bus structure being initialized
 858  *
 859  * This code is used to initialize a usb_bus structure, memory for which is
 860  * separately managed.
 861  */
 862 static void usb_bus_init (struct usb_bus *bus)
 863 {
 864         memset (&bus->devmap, 0, sizeof(struct usb_devmap));
 865
 866         bus->devnum_next = 1;
 867
 868         bus->root_hub = NULL;
 869         bus->busnum = -1;
 870         bus->bandwidth_allocated = 0;
 871         bus->bandwidth_int_reqs  = 0;
 872         bus->bandwidth_isoc_reqs = 0;
 873
 874         INIT_LIST_HEAD (&bus->bus_list);
 875 }
 876
 877 /*-------------------------------------------------------------------------*/
 878
 879 /**
 880  * usb_register_bus - registers the USB host controller with the usb core
 881  * @bus: pointer to the bus to register
 882  * Context: !in_interrupt()
 883  *
 884  * Assigns a bus number, and links the controller into usbcore data
 885  * structures so that it can be seen by scanning the bus list.
 886  */
 887 static int usb_register_bus(struct usb_bus *bus)
 888 {
 889         int result = -E2BIG;
 890         int busnum;
 891
 892         mutex_lock(&usb_bus_list_lock);
 893         busnum = find_next_zero_bit (busmap.busmap, USB_MAXBUS, 1);
 894         if (busnum >= USB_MAXBUS) {
 895                 printk (KERN_ERR "%s: too many buses\n", usbcore_name);
 896                 goto error_find_busnum;
 897         }
 898         set_bit (busnum, busmap.busmap);
 899         bus->busnum = busnum;
 900
 901         /* Add it to the local list of buses */
 902         list_add (&bus->bus_list, &usb_bus_list);
 903         mutex_unlock(&usb_bus_list_lock);
 904
 905         usb_notify_add_bus(bus);
 906
 907         dev_info (bus->controller, "new USB bus registered, assigned bus "
 908                   "number %d\n", bus->busnum);
 909         return 0;
 910
 911 error_find_busnum:
 912         mutex_unlock(&usb_bus_list_lock);
 913         return result;
 914 }
 915
 916 /**
 917  * usb_deregister_bus - deregisters the USB host controller
 918  * @bus: pointer to the bus to deregister
 919  * Context: !in_interrupt()
 920  *
 921  * Recycles the bus number, and unlinks the controller from usbcore data
 922  * structures so that it won't be seen by scanning the bus list.
 923  */
 924 static void usb_deregister_bus (struct usb_bus *bus)
 925 {
 926         dev_info (bus->controller, "USB bus %d deregistered\n", bus->busnum);
 927
 928         /*
 929          * NOTE: make sure that all the devices are removed by the
 930          * controller code, as well as having it call this when cleaning
 931          * itself up
 932          */
 933         mutex_lock(&usb_bus_list_lock);
 934         list_del (&bus->bus_list);
 935         mutex_unlock(&usb_bus_list_lock);
 936
 937         usb_notify_remove_bus(bus);
 938
 939         clear_bit (bus->busnum, busmap.busmap);
 940 }
 941
 942 /**
 943  * register_root_hub - called by usb_add_hcd() to register a root hub
 944  * @hcd: host controller for this root hub
 945  *
 946  * This function registers the root hub with the USB subsystem.  It sets up
 947  * the device properly in the device tree and then calls usb_new_device()
 948  * to register the usb device.  It also assigns the root hub's USB address
 949  * (always 1).
 950  */
 951 static int register_root_hub(struct usb_hcd *hcd)
 952 {
 953         struct device *parent_dev = hcd->self.controller;
 954         struct usb_device *usb_dev = hcd->self.root_hub;
 955         const int devnum = 1;
 956         int retval;
 957
 958         usb_dev->devnum = devnum;
 959         usb_dev->bus->devnum_next = devnum + 1;
 960         memset (&usb_dev->bus->devmap.devicemap, 0,
 961                         sizeof usb_dev->bus->devmap.devicemap);
 962         set_bit (devnum, usb_dev->bus->devmap.devicemap);
 963         usb_set_device_state(usb_dev, USB_STATE_ADDRESS);
 964
 965         mutex_lock(&usb_bus_list_lock);
 966
 967         usb_dev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
 968         retval = usb_get_device_descriptor(usb_dev, USB_DT_DEVICE_SIZE);
 969         if (retval != sizeof usb_dev->descriptor) {
 970                 mutex_unlock(&usb_bus_list_lock);
 971                 dev_dbg (parent_dev, "can't read %s device descriptor %d\n",
 972                                 dev_name(&usb_dev->dev), retval);
 973                 return (retval < 0) ? retval : -EMSGSIZE;
 974         }
 975
 976         retval = usb_new_device (usb_dev);
 977         if (retval) {
 978                 dev_err (parent_dev, "can't register root hub for %s, %d\n",
 979                                 dev_name(&usb_dev->dev), retval);
 980         }
 981         mutex_unlock(&usb_bus_list_lock);
 982
 983         if (retval == 0) {
 984                 spin_lock_irq (&hcd_root_hub_lock);
 985                 hcd->rh_registered = 1;
 986                 spin_unlock_irq (&hcd_root_hub_lock);
 987
 988                 /* Did the HC die before the root hub was registered? */
 989                 if (HCD_DEAD(hcd) || hcd->state == HC_STATE_HALT)
 990                         usb_hc_died (hcd);      /* This time clean up */
 991         }
 992
 993         return retval;
 994 }
 995
 996
 997 /*-------------------------------------------------------------------------*/
 998
 999 /**
1000  * usb_calc_bus_time - approximate periodic transaction time in nanoseconds
1001  * @speed: from dev->speed; USB_SPEED_{LOW,FULL,HIGH}
1002  * @is_input: true iff the transaction sends data to the host
1003  * @isoc: true for isochronous transactions, false for interrupt ones
1004  * @bytecount: how many bytes in the transaction.
1005  *
1006  * Returns approximate bus time in nanoseconds for a periodic transaction.
1007  * See USB 2.0 spec section 5.11.3; only periodic transfers need to be
1008  * scheduled in software, this function is only used for such scheduling.
1009  */
1010 long usb_calc_bus_time (int speed, int is_input, int isoc, int bytecount)
1011 {
1012         unsigned long   tmp;
1013
1014         switch (speed) {
1015         case USB_SPEED_LOW:     /* INTR only */
1016                 if (is_input) {
1017                         tmp = (67667L * (31L + 10L * BitTime (bytecount))) / 1000L;
1018                         return (64060L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp);
1019                 } else {
1020                         tmp = (66700L * (31L + 10L * BitTime (bytecount))) / 1000L;
1021                         return (64107L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp);
1022                 }
1023         case USB_SPEED_FULL:    /* ISOC or INTR */
1024                 if (isoc) {
1025                         tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
1026                         return (((is_input) ? 7268L : 6265L) + BW_HOST_DELAY + tmp);
1027                 } else {
1028                         tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
1029                         return (9107L + BW_HOST_DELAY + tmp);
1030                 }
1031         case USB_SPEED_HIGH:    /* ISOC or INTR */
1032                 // FIXME adjust for input vs output
1033                 if (isoc)
1034                         tmp = HS_NSECS_ISO (bytecount);
1035                 else
1036                         tmp = HS_NSECS (bytecount);
1037                 return tmp;
1038         default:
1039                 pr_debug ("%s: bogus device speed!\n", usbcore_name);
1040                 return -1;
1041         }
1042 }
1043 EXPORT_SYMBOL_GPL(usb_calc_bus_time);
1044
1045
1046 /*-------------------------------------------------------------------------*/
1047
1048 /*
1049  * Generic HC operations.
1050  */
1051
1052 /*-------------------------------------------------------------------------*/
1053
1054 /**
1055  * usb_hcd_link_urb_to_ep - add an URB to its endpoint queue
1056  * @hcd: host controller to which @urb was submitted
1057  * @urb: URB being submitted
1058  *
1059  * Host controller drivers should call this routine in their enqueue()
1060  * method.  The HCD's private spinlock must be held and interrupts must
1061  * be disabled.  The actions carried out here are required for URB
1062  * submission, as well as for endpoint shutdown and for usb_kill_urb.
1063  *
1064  * Returns 0 for no error, otherwise a negative error code (in which case
1065  * the enqueue() method must fail).  If no error occurs but enqueue() fails
1066  * anyway, it must call usb_hcd_unlink_urb_from_ep() before releasing
1067  * the private spinlock and returning.
1068  */
1069 int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb)
1070 {
1071         int             rc = 0;
1072
1073         spin_lock(&hcd_urb_list_lock);
1074
1075         /* Check that the URB isn't being killed */
1076         if (unlikely(atomic_read(&urb->reject))) {
1077                 rc = -EPERM;
1078                 goto done;
1079         }
1080
1081         if (unlikely(!urb->ep->enabled)) {
1082                 rc = -ENOENT;
1083                 goto done;
1084         }
1085
1086         if (unlikely(!urb->dev->can_submit)) {
1087                 rc = -EHOSTUNREACH;
1088                 goto done;
1089         }
1090
1091         /*
1092          * Check the host controller's state and add the URB to the
1093          * endpoint's queue.
1094          */
1095         if (HCD_RH_RUNNING(hcd)) {
1096                 urb->unlinked = 0;
1097                 list_add_tail(&urb->urb_list, &urb->ep->urb_list);
1098         } else {
1099                 rc = -ESHUTDOWN;
1100                 goto done;
1101         }
1102  done:
1103         spin_unlock(&hcd_urb_list_lock);
1104         return rc;
1105 }
1106 EXPORT_SYMBOL_GPL(usb_hcd_link_urb_to_ep);
1107
1108 /**
1109  * usb_hcd_check_unlink_urb - check whether an URB may be unlinked
1110  * @hcd: host controller to which @urb was submitted
1111  * @urb: URB being checked for unlinkability
1112  * @status: error code to store in @urb if the unlink succeeds
1113  *
1114  * Host controller drivers should call this routine in their dequeue()
1115  * method.  The HCD's private spinlock must be held and interrupts must
1116  * be disabled.  The actions carried out here are required for making
1117  * sure than an unlink is valid.
1118  *
1119  * Returns 0 for no error, otherwise a negative error code (in which case
1120  * the dequeue() method must fail).  The possible error codes are:
1121  *
1122  *      -EIDRM: @urb was not submitted or has already completed.
1123  *              The completion function may not have been called yet.
1124  *
1125  *      -EBUSY: @urb has already been unlinked.
1126  */
1127 int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb,
1128                 int status)
1129 {
1130         struct list_head        *tmp;
1131
1132         /* insist the urb is still queued */
1133         list_for_each(tmp, &urb->ep->urb_list) {
1134                 if (tmp == &urb->urb_list)
1135                         break;
1136         }
1137         if (tmp != &urb->urb_list)
1138                 return -EIDRM;
1139
1140         /* Any status except -EINPROGRESS means something already started to
1141          * unlink this URB from the hardware.  So there's no more work to do.
1142          */
1143         if (urb->unlinked)
1144                 return -EBUSY;
1145         urb->unlinked = status;
1146
1147         /* IRQ setup can easily be broken so that USB controllers
1148          * never get completion IRQs ... maybe even the ones we need to
1149          * finish unlinking the initial failed usb_set_address()
1150          * or device descriptor fetch.
1151          */
1152         if (!HCD_SAW_IRQ(hcd) && !is_root_hub(urb->dev)) {
1153                 dev_warn(hcd->self.controller, "Unlink after no-IRQ?  "
1154                         "Controller is probably using the wrong IRQ.\n");
1155                 set_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
1156         }
1157
1158         return 0;
1159 }
1160 EXPORT_SYMBOL_GPL(usb_hcd_check_unlink_urb);
1161
1162 /**
1163  * usb_hcd_unlink_urb_from_ep - remove an URB from its endpoint queue
1164  * @hcd: host controller to which @urb was submitted
1165  * @urb: URB being unlinked
1166  *
1167  * Host controller drivers should call this routine before calling
1168  * usb_hcd_giveback_urb().  The HCD's private spinlock must be held and
1169  * interrupts must be disabled.  The actions carried out here are required
1170  * for URB completion.
1171  */
1172 void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb)
1173 {
1174         /* clear all state linking urb to this dev (and hcd) */
1175         spin_lock(&hcd_urb_list_lock);
1176         list_del_init(&urb->urb_list);
1177         spin_unlock(&hcd_urb_list_lock);
1178 }
1179 EXPORT_SYMBOL_GPL(usb_hcd_unlink_urb_from_ep);
1180
1181 /*
1182  * Some usb host controllers can only perform dma using a small SRAM area.
1183  * The usb core itself is however optimized for host controllers that can dma
1184  * using regular system memory - like pci devices doing bus mastering.
1185  *
1186  * To support host controllers with limited dma capabilites we provide dma
1187  * bounce buffers. This feature can be enabled using the HCD_LOCAL_MEM flag.
1188  * For this to work properly the host controller code must first use the
1189  * function dma_declare_coherent_memory() to point out which memory area
1190  * that should be used for dma allocations.
1191  *
1192  * The HCD_LOCAL_MEM flag then tells the usb code to allocate all data for
1193  * dma using dma_alloc_coherent() which in turn allocates from the memory
1194  * area pointed out with dma_declare_coherent_memory().
1195  *
1196  * So, to summarize...
1197  *
1198  * - We need "local" memory, canonical example being
1199  *   a small SRAM on a discrete controller being the
1200  *   only memory that the controller can read ...
1201  *   (a) "normal" kernel memory is no good, and
1202  *   (b) there's not enough to share
1203  *
1204  * - The only *portable* hook for such stuff in the
1205  *   DMA framework is dma_declare_coherent_memory()
1206  *
1207  * - So we use that, even though the primary requirement
1208  *   is that the memory be "local" (hence addressible
1209  *   by that device), not "coherent".
1210  *
1211  */
1212
1213 static int hcd_alloc_coherent(struct usb_bus *bus,
1214                               gfp_t mem_flags, dma_addr_t *dma_handle,
1215                               void **vaddr_handle, size_t size,
1216                               enum dma_data_direction dir)
1217 {
1218         unsigned char *vaddr;
1219
1220         if (*vaddr_handle == NULL) {
1221                 WARN_ON_ONCE(1);
1222                 return -EFAULT;
1223         }
1224
1225         vaddr = hcd_buffer_alloc(bus, size + sizeof(vaddr),
1226                                  mem_flags, dma_handle);
1227         if (!vaddr)
1228                 return -ENOMEM;
1229
1230         /*
1231          * Store the virtual address of the buffer at the end
1232          * of the allocated dma buffer. The size of the buffer
1233          * may be uneven so use unaligned functions instead
1234          * of just rounding up. It makes sense to optimize for
1235          * memory footprint over access speed since the amount
1236          * of memory available for dma may be limited.
1237          */
1238         put_unaligned((unsigned long)*vaddr_handle,
1239                       (unsigned long *)(vaddr + size));
1240
1241         if (dir == DMA_TO_DEVICE)
1242                 memcpy(vaddr, *vaddr_handle, size);
1243
1244         *vaddr_handle = vaddr;
1245         return 0;
1246 }
1247
1248 static void hcd_free_coherent(struct usb_bus *bus, dma_addr_t *dma_handle,
1249                               void **vaddr_handle, size_t size,
1250                               enum dma_data_direction dir)
1251 {
1252         unsigned char *vaddr = *vaddr_handle;
1253
1254         vaddr = (void *)get_unaligned((unsigned long *)(vaddr + size));
1255
1256         if (dir == DMA_FROM_DEVICE)
1257                 memcpy(vaddr, *vaddr_handle, size);
1258
1259         hcd_buffer_free(bus, size + sizeof(vaddr), *vaddr_handle, *dma_handle);
1260
1261         *vaddr_handle = vaddr;
1262         *dma_handle = 0;
1263 }
1264
1265 void usb_hcd_unmap_urb_setup_for_dma(struct usb_hcd *hcd, struct urb *urb)
1266 {
1267         if (urb->transfer_flags & URB_SETUP_MAP_SINGLE)
1268                 dma_unmap_single(hcd->self.controller,
1269                                 urb->setup_dma,
1270                                 sizeof(struct usb_ctrlrequest),
1271                                 DMA_TO_DEVICE);
1272         else if (urb->transfer_flags & URB_SETUP_MAP_LOCAL)
1273                 hcd_free_coherent(urb->dev->bus,
1274                                 &urb->setup_dma,
1275                                 (void **) &urb->setup_packet,
1276                                 sizeof(struct usb_ctrlrequest),
1277                                 DMA_TO_DEVICE);
1278
1279         /* Make it safe to call this routine more than once */
1280         urb->transfer_flags &= ~(URB_SETUP_MAP_SINGLE | URB_SETUP_MAP_LOCAL);
1281 }
1282 EXPORT_SYMBOL_GPL(usb_hcd_unmap_urb_setup_for_dma);
1283
1284 static void unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
1285 {
1286         if (hcd->driver->unmap_urb_for_dma)
1287                 hcd->driver->unmap_urb_for_dma(hcd, urb);
1288         else
1289                 usb_hcd_unmap_urb_for_dma(hcd, urb);
1290 }
1291
1292 void usb_hcd_unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
1293 {
1294         enum dma_data_direction dir;
1295
1296         usb_hcd_unmap_urb_setup_for_dma(hcd, urb);
1297
1298         dir = usb_urb_dir_in(urb) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
1299         if (urb->transfer_flags & URB_DMA_MAP_SG)
1300                 dma_unmap_sg(hcd->self.controller,
1301                                 urb->sg,
1302                                 urb->num_sgs,
1303                                 dir);
1304         else if (urb->transfer_flags & URB_DMA_MAP_PAGE)
1305                 dma_unmap_page(hcd->self.controller,
1306                                 urb->transfer_dma,
1307                                 urb->transfer_buffer_length,
1308                                 dir);
1309         else if (urb->transfer_flags & URB_DMA_MAP_SINGLE)
1310                 dma_unmap_single(hcd->self.controller,
1311                                 urb->transfer_dma,
1312                                 urb->transfer_buffer_length,
1313                                 dir);
1314         else if (urb->transfer_flags & URB_MAP_LOCAL)
1315                 hcd_free_coherent(urb->dev->bus,
1316                                 &urb->transfer_dma,
1317                                 &urb->transfer_buffer,
1318                                 urb->transfer_buffer_length,
1319                                 dir);
1320
1321         /* Make it safe to call this routine more than once */
1322         urb->transfer_flags &= ~(URB_DMA_MAP_SG | URB_DMA_MAP_PAGE |
1323                         URB_DMA_MAP_SINGLE | URB_MAP_LOCAL);
1324 }
1325 EXPORT_SYMBOL_GPL(usb_hcd_unmap_urb_for_dma);
1326
1327 static int map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
1328                            gfp_t mem_flags)
1329 {
1330         if (hcd->driver->map_urb_for_dma)
1331                 return hcd->driver->map_urb_for_dma(hcd, urb, mem_flags);
1332         else
1333                 return usb_hcd_map_urb_for_dma(hcd, urb, mem_flags);
1334 }
1335
1336 int usb_hcd_map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
1337                             gfp_t mem_flags)
1338 {
1339         enum dma_data_direction dir;
1340         int ret = 0;
1341
1342         /* Map the URB's buffers for DMA access.
1343          * Lower level HCD code should use *_dma exclusively,
1344          * unless it uses pio or talks to another transport,
1345          * or uses the provided scatter gather list for bulk.
1346          */
1347
1348         if (usb_endpoint_xfer_control(&urb->ep->desc)) {
1349                 if (hcd->self.uses_pio_for_control)
1350                         return ret;
1351                 if (hcd->self.uses_dma) {
1352                         urb->setup_dma = dma_map_single(
1353                                         hcd->self.controller,
1354                                         urb->setup_packet,
1355                                         sizeof(struct usb_ctrlrequest),
1356                                         DMA_TO_DEVICE);
1357                         if (dma_mapping_error(hcd->self.controller,
1358                                                 urb->setup_dma))
1359                                 return -EAGAIN;
1360                         urb->transfer_flags |= URB_SETUP_MAP_SINGLE;
1361                 } else if (hcd->driver->flags & HCD_LOCAL_MEM) {
1362                         ret = hcd_alloc_coherent(
1363                                         urb->dev->bus, mem_flags,
1364                                         &urb->setup_dma,
1365                                         (void **)&urb->setup_packet,
1366                                         sizeof(struct usb_ctrlrequest),
1367                                         DMA_TO_DEVICE);
1368                         if (ret)
1369                                 return ret;
1370                         urb->transfer_flags |= URB_SETUP_MAP_LOCAL;
1371                 }
1372         }
1373
1374         dir = usb_urb_dir_in(urb) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
1375         if (urb->transfer_buffer_length != 0
1376             && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP)) {
1377                 if (hcd->self.uses_dma) {
1378                         if (urb->num_sgs) {
1379                                 int n = dma_map_sg(
1380                                                 hcd->self.controller,
1381                                                 urb->sg,
1382                                                 urb->num_sgs,
1383                                                 dir);
1384                                 if (n <= 0)
1385                                         ret = -EAGAIN;
1386                                 else
1387                                         urb->transfer_flags |= URB_DMA_MAP_SG;
1388                                 if (n != urb->num_sgs) {
1389                                         urb->num_sgs = n;
1390                                         urb->transfer_flags |=
1391                                                         URB_DMA_SG_COMBINED;
1392                                 }
1393                         } else if (urb->sg) {
1394                                 struct scatterlist *sg = urb->sg;
1395                                 urb->transfer_dma = dma_map_page(
1396                                                 hcd->self.controller,
1397                                                 sg_page(sg),
1398                                                 sg->offset,
1399                                                 urb->transfer_buffer_length,
1400                                                 dir);
1401                                 if (dma_mapping_error(hcd->self.controller,
1402                                                 urb->transfer_dma))
1403                                         ret = -EAGAIN;
1404                                 else
1405                                         urb->transfer_flags |= URB_DMA_MAP_PAGE;
1406                         } else {
1407                                 urb->transfer_dma = dma_map_single(
1408                                                 hcd->self.controller,
1409                                                 urb->transfer_buffer,
1410                                                 urb->transfer_buffer_length,
1411                                                 dir);
1412                                 if (dma_mapping_error(hcd->self.controller,
1413                                                 urb->transfer_dma))
1414                                         ret = -EAGAIN;
1415                                 else
1416                                         urb->transfer_flags |= URB_DMA_MAP_SINGLE;
1417                         }
1418                 } else if (hcd->driver->flags & HCD_LOCAL_MEM) {
1419                         ret = hcd_alloc_coherent(
1420                                         urb->dev->bus, mem_flags,
1421                                         &urb->transfer_dma,
1422                                         &urb->transfer_buffer,
1423                                         urb->transfer_buffer_length,
1424                                         dir);
1425                         if (ret == 0)
1426                                 urb->transfer_flags |= URB_MAP_LOCAL;
1427                 }
1428                 if (ret && (urb->transfer_flags & (URB_SETUP_MAP_SINGLE |
1429                                 URB_SETUP_MAP_LOCAL)))
1430                         usb_hcd_unmap_urb_for_dma(hcd, urb);
1431         }
1432         return ret;
1433 }
1434 EXPORT_SYMBOL_GPL(usb_hcd_map_urb_for_dma);
1435
1436 /*-------------------------------------------------------------------------*/
1437
1438 /* may be called in any context with a valid urb->dev usecount
1439  * caller surrenders "ownership" of urb
1440  * expects usb_submit_urb() to have sanity checked and conditioned all
1441  * inputs in the urb
1442  */
1443 int usb_hcd_submit_urb (struct urb *urb, gfp_t mem_flags)
1444 {
1445         int                     status;
1446         struct usb_hcd          *hcd = bus_to_hcd(urb->dev->bus);
1447
1448         /* increment urb's reference count as part of giving it to the HCD
1449          * (which will control it).  HCD guarantees that it either returns
1450          * an error or calls giveback(), but not both.
1451          */
1452         usb_get_urb(urb);
1453         atomic_inc(&urb->use_count);
1454         atomic_inc(&urb->dev->urbnum);
1455         usbmon_urb_submit(&hcd->self, urb);
1456
1457         /* NOTE requirements on root-hub callers (usbfs and the hub
1458          * driver, for now):  URBs' urb->transfer_buffer must be
1459          * valid and usb_buffer_{sync,unmap}() not be needed, since
1460          * they could clobber root hub response data.  Also, control
1461          * URBs must be submitted in process context with interrupts
1462          * enabled.
1463          */
1464
1465         if (is_root_hub(urb->dev)) {
1466                 status = rh_urb_enqueue(hcd, urb);
1467         } else {
1468                 status = map_urb_for_dma(hcd, urb, mem_flags);
1469                 if (likely(status == 0)) {
1470                         status = hcd->driver->urb_enqueue(hcd, urb, mem_flags);
1471                         if (unlikely(status))
1472                                 unmap_urb_for_dma(hcd, urb);
1473                 }
1474         }
1475
1476         if (unlikely(status)) {
1477                 usbmon_urb_submit_error(&hcd->self, urb, status);
1478                 urb->hcpriv = NULL;
1479                 INIT_LIST_HEAD(&urb->urb_list);
1480                 atomic_dec(&urb->use_count);
1481                 atomic_dec(&urb->dev->urbnum);
1482                 if (atomic_read(&urb->reject))
1483                         wake_up(&usb_kill_urb_queue);
1484                 usb_put_urb(urb);
1485         }
1486         return status;
1487 }
1488
1489 /*-------------------------------------------------------------------------*/
1490
1491 /* this makes the hcd giveback() the urb more quickly, by kicking it
1492  * off hardware queues (which may take a while) and returning it as
1493  * soon as practical.  we've already set up the urb's return status,
1494  * but we can't know if the callback completed already.
1495  */
1496 static int unlink1(struct usb_hcd *hcd, struct urb *urb, int status)
1497 {
1498         int             value;
1499
1500         if (is_root_hub(urb->dev))
1501                 value = usb_rh_urb_dequeue(hcd, urb, status);
1502         else {
1503
1504                 /* The only reason an HCD might fail this call is if
1505                  * it has not yet fully queued the urb to begin with.
1506                  * Such failures should be harmless. */
1507                 value = hcd->driver->urb_dequeue(hcd, urb, status);
1508         }
1509         return value;
1510 }
1511
1512 /*
1513  * called in any context
1514  *
1515  * caller guarantees urb won't be recycled till both unlink()
1516  * and the urb's completion function return
1517  */
1518 int usb_hcd_unlink_urb (struct urb *urb, int status)
1519 {
1520         struct usb_hcd          *hcd;
1521         int                     retval = -EIDRM;
1522         unsigned long           flags;
1523
1524         /* Prevent the device and bus from going away while
1525          * the unlink is carried out.  If they are already gone
1526          * then urb->use_count must be 0, since disconnected
1527          * devices can't have any active URBs.
1528          */
1529         spin_lock_irqsave(&hcd_urb_unlink_lock, flags);
1530         if (atomic_read(&urb->use_count) > 0) {
1531                 retval = 0;
1532                 usb_get_dev(urb->dev);
1533         }
1534         spin_unlock_irqrestore(&hcd_urb_unlink_lock, flags);
1535         if (retval == 0) {
1536                 hcd = bus_to_hcd(urb->dev->bus);
1537                 retval = unlink1(hcd, urb, status);
1538                 usb_put_dev(urb->dev);
1539         }
1540
1541         if (retval == 0)
1542                 retval = -EINPROGRESS;
1543         else if (retval != -EIDRM && retval != -EBUSY)
1544                 dev_dbg(&urb->dev->dev, "hcd_unlink_urb %p fail %d\n",
1545                                 urb, retval);
1546         return retval;
1547 }
1548
1549 /*-------------------------------------------------------------------------*/
1550
1551 /**
1552  * usb_hcd_giveback_urb - return URB from HCD to device driver
1553  * @hcd: host controller returning the URB
1554  * @urb: urb being returned to the USB device driver.
1555  * @status: completion status code for the URB.
1556  * Context: in_interrupt()
1557  *
1558  * This hands the URB from HCD to its USB device driver, using its
1559  * completion function.  The HCD has freed all per-urb resources
1560  * (and is done using urb->hcpriv).  It also released all HCD locks;
1561  * the device driver won't cause problems if it frees, modifies,
1562  * or resubmits this URB.
1563  *
1564  * If @urb was unlinked, the value of @status will be overridden by
1565  * @urb->unlinked.  Erroneous short transfers are detected in case
1566  * the HCD hasn't checked for them.
1567  */
1568 void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb, int status)
1569 {
1570         urb->hcpriv = NULL;
1571         if (unlikely(urb->unlinked))
1572                 status = urb->unlinked;
1573         else if (unlikely((urb->transfer_flags & URB_SHORT_NOT_OK) &&
1574                         urb->actual_length < urb->transfer_buffer_length &&
1575                         !status))
1576                 status = -EREMOTEIO;
1577
1578         unmap_urb_for_dma(hcd, urb);
1579         usbmon_urb_complete(&hcd->self, urb, status);
1580         usb_unanchor_urb(urb);
1581
1582         /* pass ownership to the completion handler */
1583         urb->status = status;
1584         urb->complete (urb);
1585         atomic_dec (&urb->use_count);
1586         if (unlikely(atomic_read(&urb->reject)))
1587                 wake_up (&usb_kill_urb_queue);
1588         usb_put_urb (urb);
1589 }
1590 EXPORT_SYMBOL_GPL(usb_hcd_giveback_urb);
1591
1592 /*-------------------------------------------------------------------------*/
1593
1594 /* Cancel all URBs pending on this endpoint and wait for the endpoint's
1595  * queue to drain completely.  The caller must first insure that no more
1596  * URBs can be submitted for this endpoint.
1597  */
1598 void usb_hcd_flush_endpoint(struct usb_device *udev,
1599                 struct usb_host_endpoint *ep)
1600 {
1601         struct usb_hcd          *hcd;
1602         struct urb              *urb;
1603
1604         if (!ep)
1605                 return;
1606         might_sleep();
1607         hcd = bus_to_hcd(udev->bus);
1608
1609         /* No more submits can occur */
1610         spin_lock_irq(&hcd_urb_list_lock);
1611 rescan:
1612         list_for_each_entry (urb, &ep->urb_list, urb_list) {
1613                 int     is_in;
1614
1615                 if (urb->unlinked)
1616                         continue;
1617                 usb_get_urb (urb);
1618                 is_in = usb_urb_dir_in(urb);
1619                 spin_unlock(&hcd_urb_list_lock);
1620
1621                 /* kick hcd */
1622                 unlink1(hcd, urb, -ESHUTDOWN);
1623                 dev_dbg (hcd->self.controller,
1624                         "shutdown urb %p ep%d%s%s\n",
1625                         urb, usb_endpoint_num(&ep->desc),
1626                         is_in ? "in" : "out",
1627                         ({      char *s;
1628
1629                                  switch (usb_endpoint_type(&ep->desc)) {
1630                                  case USB_ENDPOINT_XFER_CONTROL:
1631                                         s = ""; break;
1632                                  case USB_ENDPOINT_XFER_BULK:
1633                                         s = "-bulk"; break;
1634                                  case USB_ENDPOINT_XFER_INT:
1635                                         s = "-intr"; break;
1636                                  default:
1637                                         s = "-iso"; break;
1638                                 };
1639                                 s;
1640                         }));
1641                 usb_put_urb (urb);
1642
1643                 /* list contents may have changed */
1644                 spin_lock(&hcd_urb_list_lock);
1645                 goto rescan;
1646         }
1647         spin_unlock_irq(&hcd_urb_list_lock);
1648
1649         /* Wait until the endpoint queue is completely empty */
1650         while (!list_empty (&ep->urb_list)) {
1651                 spin_lock_irq(&hcd_urb_list_lock);
1652
1653                 /* The list may have changed while we acquired the spinlock */
1654                 urb = NULL;
1655                 if (!list_empty (&ep->urb_list)) {
1656                         urb = list_entry (ep->urb_list.prev, struct urb,
1657                                         urb_list);
1658                         usb_get_urb (urb);
1659                 }
1660                 spin_unlock_irq(&hcd_urb_list_lock);
1661
1662                 if (urb) {
1663                         usb_kill_urb (urb);
1664                         usb_put_urb (urb);
1665                 }
1666         }
1667 }
1668
1669 /**
1670  * usb_hcd_alloc_bandwidth - check whether a new bandwidth setting exceeds
1671  *                              the bus bandwidth
1672  * @udev: target &usb_device
1673  * @new_config: new configuration to install
1674  * @cur_alt: the current alternate interface setting
1675  * @new_alt: alternate interface setting that is being installed
1676  *
1677  * To change configurations, pass in the new configuration in new_config,
1678  * and pass NULL for cur_alt and new_alt.
1679  *
1680  * To reset a device's configuration (put the device in the ADDRESSED state),
1681  * pass in NULL for new_config, cur_alt, and new_alt.
1682  *
1683  * To change alternate interface settings, pass in NULL for new_config,
1684  * pass in the current alternate interface setting in cur_alt,
1685  * and pass in the new alternate interface setting in new_alt.
1686  *
1687  * Returns an error if the requested bandwidth change exceeds the
1688  * bus bandwidth or host controller internal resources.
1689  */
1690 int usb_hcd_alloc_bandwidth(struct usb_device *udev,
1691                 struct usb_host_config *new_config,
1692                 struct usb_host_interface *cur_alt,
1693                 struct usb_host_interface *new_alt)
1694 {
1695         int num_intfs, i, j;
1696         struct usb_host_interface *alt = NULL;
1697         int ret = 0;
1698         struct usb_hcd *hcd;
1699         struct usb_host_endpoint *ep;
1700
1701         hcd = bus_to_hcd(udev->bus);
1702         if (!hcd->driver->check_bandwidth)
1703                 return 0;
1704
1705         /* Configuration is being removed - set configuration 0 */
1706         if (!new_config && !cur_alt) {
1707                 for (i = 1; i < 16; ++i) {
1708                         ep = udev->ep_out[i];
1709                         if (ep)
1710                                 hcd->driver->drop_endpoint(hcd, udev, ep);
1711                         ep = udev->ep_in[i];
1712                         if (ep)
1713                                 hcd->driver->drop_endpoint(hcd, udev, ep);
1714                 }
1715                 hcd->driver->check_bandwidth(hcd, udev);
1716                 return 0;
1717         }
1718         /* Check if the HCD says there's enough bandwidth.  Enable all endpoints
1719          * each interface's alt setting 0 and ask the HCD to check the bandwidth
1720          * of the bus.  There will always be bandwidth for endpoint 0, so it's
1721          * ok to exclude it.
1722          */
1723         if (new_config) {
1724                 num_intfs = new_config->desc.bNumInterfaces;
1725                 /* Remove endpoints (except endpoint 0, which is always on the
1726                  * schedule) from the old config from the schedule
1727                  */
1728                 for (i = 1; i < 16; ++i) {
1729                         ep = udev->ep_out[i];
1730                         if (ep) {
1731                                 ret = hcd->driver->drop_endpoint(hcd, udev, ep);
1732                                 if (ret < 0)
1733                                         goto reset;
1734                         }
1735                         ep = udev->ep_in[i];
1736                         if (ep) {
1737                                 ret = hcd->driver->drop_endpoint(hcd, udev, ep);
1738                                 if (ret < 0)
1739                                         goto reset;
1740                         }
1741                 }
1742                 for (i = 0; i < num_intfs; ++i) {
1743                         struct usb_host_interface *first_alt;
1744                         int iface_num;
1745
1746                         first_alt = &new_config->intf_cache[i]->altsetting[0];
1747                         iface_num = first_alt->desc.bInterfaceNumber;
1748                         /* Set up endpoints for alternate interface setting 0 */
1749                         alt = usb_find_alt_setting(new_config, iface_num, 0);
1750                         if (!alt)
1751                                 /* No alt setting 0? Pick the first setting. */
1752                                 alt = first_alt;
1753
1754                         for (j = 0; j < alt->desc.bNumEndpoints; j++) {
1755                                 ret = hcd->driver->add_endpoint(hcd, udev, &alt->endpoint[j]);
1756                                 if (ret < 0)
1757                                         goto reset;
1758                         }
1759                 }
1760         }
1761         if (cur_alt && new_alt) {
1762                 struct usb_interface *iface = usb_ifnum_to_if(udev,
1763                                 cur_alt->desc.bInterfaceNumber);
1764
1765                 if (iface->resetting_device) {
1766                         /*
1767                          * The USB core just reset the device, so the xHCI host
1768                          * and the device will think alt setting 0 is installed.
1769                          * However, the USB core will pass in the alternate
1770                          * setting installed before the reset as cur_alt.  Dig
1771                          * out the alternate setting 0 structure, or the first
1772                          * alternate setting if a broken device doesn't have alt
1773                          * setting 0.
1774                          */
1775                         cur_alt = usb_altnum_to_altsetting(iface, 0);
1776                         if (!cur_alt)
1777                                 cur_alt = &iface->altsetting[0];
1778                 }
1779
1780                 /* Drop all the endpoints in the current alt setting */
1781                 for (i = 0; i < cur_alt->desc.bNumEndpoints; i++) {
1782                         ret = hcd->driver->drop_endpoint(hcd, udev,
1783                                         &cur_alt->endpoint[i]);
1784                         if (ret < 0)
1785                                 goto reset;
1786                 }
1787                 /* Add all the endpoints in the new alt setting */
1788                 for (i = 0; i < new_alt->desc.bNumEndpoints; i++) {
1789                         ret = hcd->driver->add_endpoint(hcd, udev,
1790                                         &new_alt->endpoint[i]);
1791                         if (ret < 0)
1792                                 goto reset;
1793                 }
1794         }
1795         ret = hcd->driver->check_bandwidth(hcd, udev);
1796 reset:
1797         if (ret < 0)
1798                 hcd->driver->reset_bandwidth(hcd, udev);
1799         return ret;
1800 }
1801
1802 /* Disables the endpoint: synchronizes with the hcd to make sure all
1803  * endpoint state is gone from hardware.  usb_hcd_flush_endpoint() must
1804  * have been called previously.  Use for set_configuration, set_interface,
1805  * driver removal, physical disconnect.
1806  *
1807  * example:  a qh stored in ep->hcpriv, holding state related to endpoint
1808  * type, maxpacket size, toggle, halt status, and scheduling.
1809  */
1810 void usb_hcd_disable_endpoint(struct usb_device *udev,
1811                 struct usb_host_endpoint *ep)
1812 {
1813         struct usb_hcd          *hcd;
1814
1815         might_sleep();
1816         hcd = bus_to_hcd(udev->bus);
1817         if (hcd->driver->endpoint_disable)
1818                 hcd->driver->endpoint_disable(hcd, ep);
1819 }
1820
1821 /**
1822  * usb_hcd_reset_endpoint - reset host endpoint state
1823  * @udev: USB device.
1824  * @ep:   the endpoint to reset.
1825  *
1826  * Resets any host endpoint state such as the toggle bit, sequence
1827  * number and current window.
1828  */
1829 void usb_hcd_reset_endpoint(struct usb_device *udev,
1830                             struct usb_host_endpoint *ep)
1831 {
1832         struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1833
1834         if (hcd->driver->endpoint_reset)
1835                 hcd->driver->endpoint_reset(hcd, ep);
1836         else {
1837                 int epnum = usb_endpoint_num(&ep->desc);
1838                 int is_out = usb_endpoint_dir_out(&ep->desc);
1839                 int is_control = usb_endpoint_xfer_control(&ep->desc);
1840
1841                 usb_settoggle(udev, epnum, is_out, 0);
1842                 if (is_control)
1843                         usb_settoggle(udev, epnum, !is_out, 0);
1844         }
1845 }
1846
1847 /**
1848  * usb_alloc_streams - allocate bulk endpoint stream IDs.
1849  * @interface:          alternate setting that includes all endpoints.
1850  * @eps:                array of endpoints that need streams.
1851  * @num_eps:            number of endpoints in the array.
1852  * @num_streams:        number of streams to allocate.
1853  * @mem_flags:          flags hcd should use to allocate memory.
1854  *
1855  * Sets up a group of bulk endpoints to have num_streams stream IDs available.
1856  * Drivers may queue multiple transfers to different stream IDs, which may
1857  * complete in a different order than they were queued.
1858  */
1859 int usb_alloc_streams(struct usb_interface *interface,
1860                 struct usb_host_endpoint **eps, unsigned int num_eps,
1861                 unsigned int num_streams, gfp_t mem_flags)
1862 {
1863         struct usb_hcd *hcd;
1864         struct usb_device *dev;
1865         int i;
1866
1867         dev = interface_to_usbdev(interface);
1868         hcd = bus_to_hcd(dev->bus);
1869         if (!hcd->driver->alloc_streams || !hcd->driver->free_streams)
1870                 return -EINVAL;
1871         if (dev->speed != USB_SPEED_SUPER)
1872                 return -EINVAL;
1873
1874         /* Streams only apply to bulk endpoints. */
1875         for (i = 0; i < num_eps; i++)
1876                 if (!usb_endpoint_xfer_bulk(&eps[i]->desc))
1877                         return -EINVAL;
1878
1879         return hcd->driver->alloc_streams(hcd, dev, eps, num_eps,
1880                         num_streams, mem_flags);
1881 }
1882 EXPORT_SYMBOL_GPL(usb_alloc_streams);
1883
1884 /**
1885  * usb_free_streams - free bulk endpoint stream IDs.
1886  * @interface:  alternate setting that includes all endpoints.
1887  * @eps:        array of endpoints to remove streams from.
1888  * @num_eps:    number of endpoints in the array.
1889  * @mem_flags:  flags hcd should use to allocate memory.
1890  *
1891  * Reverts a group of bulk endpoints back to not using stream IDs.
1892  * Can fail if we are given bad arguments, or HCD is broken.
1893  */
1894 void usb_free_streams(struct usb_interface *interface,
1895                 struct usb_host_endpoint **eps, unsigned int num_eps,
1896                 gfp_t mem_flags)
1897 {
1898         struct usb_hcd *hcd;
1899         struct usb_device *dev;
1900         int i;
1901
1902         dev = interface_to_usbdev(interface);
1903         hcd = bus_to_hcd(dev->bus);
1904         if (dev->speed != USB_SPEED_SUPER)
1905                 return;
1906
1907         /* Streams only apply to bulk endpoints. */
1908         for (i = 0; i < num_eps; i++)
1909                 if (!usb_endpoint_xfer_bulk(&eps[i]->desc))
1910                         return;
1911
1912         hcd->driver->free_streams(hcd, dev, eps, num_eps, mem_flags);
1913 }
1914 EXPORT_SYMBOL_GPL(usb_free_streams);
1915
1916 /* Protect against drivers that try to unlink URBs after the device
1917  * is gone, by waiting until all unlinks for @udev are finished.
1918  * Since we don't currently track URBs by device, simply wait until
1919  * nothing is running in the locked region of usb_hcd_unlink_urb().
1920  */
1921 void usb_hcd_synchronize_unlinks(struct usb_device *udev)
1922 {
1923         spin_lock_irq(&hcd_urb_unlink_lock);
1924         spin_unlock_irq(&hcd_urb_unlink_lock);
1925 }
1926
1927 /*-------------------------------------------------------------------------*/
1928
1929 /* called in any context */
1930 int usb_hcd_get_frame_number (struct usb_device *udev)
1931 {
1932         struct usb_hcd  *hcd = bus_to_hcd(udev->bus);
1933
1934         if (!HCD_RH_RUNNING(hcd))
1935                 return -ESHUTDOWN;
1936         return hcd->driver->get_frame_number (hcd);
1937 }
1938
1939 /*-------------------------------------------------------------------------*/
1940
1941 #ifdef  CONFIG_PM
1942
1943 int hcd_bus_suspend(struct usb_device *rhdev, pm_message_t msg)
1944 {
1945         struct usb_hcd  *hcd = container_of(rhdev->bus, struct usb_hcd, self);
1946         int             status;
1947         int             old_state = hcd->state;
1948
1949         dev_dbg(&rhdev->dev, "bus %s%s\n",
1950                         (msg.event & PM_EVENT_AUTO ? "auto-" : ""), "suspend");
1951         if (HCD_DEAD(hcd)) {
1952                 dev_dbg(&rhdev->dev, "skipped %s of dead bus\n", "suspend");
1953                 return 0;
1954         }
1955
1956         if (!hcd->driver->bus_suspend) {
1957                 status = -ENOENT;
1958         } else {
1959                 clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
1960                 hcd->state = HC_STATE_QUIESCING;
1961                 status = hcd->driver->bus_suspend(hcd);
1962         }
1963         if (status == 0) {
1964                 usb_set_device_state(rhdev, USB_STATE_SUSPENDED);
1965                 hcd->state = HC_STATE_SUSPENDED;
1966         } else {
1967                 spin_lock_irq(&hcd_root_hub_lock);
1968                 if (!HCD_DEAD(hcd)) {
1969                         set_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
1970                         hcd->state = old_state;
1971                 }
1972                 spin_unlock_irq(&hcd_root_hub_lock);
1973                 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
1974                                 "suspend", status);
1975         }
1976         return status;
1977 }
1978
1979 int hcd_bus_resume(struct usb_device *rhdev, pm_message_t msg)
1980 {
1981         struct usb_hcd  *hcd = container_of(rhdev->bus, struct usb_hcd, self);
1982         int             status;
1983         int             old_state = hcd->state;
1984
1985         dev_dbg(&rhdev->dev, "usb %s%s\n",
1986                         (msg.event & PM_EVENT_AUTO ? "auto-" : ""), "resume");
1987         if (HCD_DEAD(hcd)) {
1988                 dev_dbg(&rhdev->dev, "skipped %s of dead bus\n", "resume");
1989                 return 0;
1990         }
1991         if (!hcd->driver->bus_resume)
1992                 return -ENOENT;
1993         if (HCD_RH_RUNNING(hcd))
1994                 return 0;
1995
1996         hcd->state = HC_STATE_RESUMING;
1997         status = hcd->driver->bus_resume(hcd);
1998         clear_bit(HCD_FLAG_WAKEUP_PENDING, &hcd->flags);
1999         if (status == 0) {
2000                 /* TRSMRCY = 10 msec */
2001                 msleep(10);
2002                 spin_lock_irq(&hcd_root_hub_lock);
2003                 if (!HCD_DEAD(hcd)) {
2004                         usb_set_device_state(rhdev, rhdev->actconfig
2005                                         ? USB_STATE_CONFIGURED
2006                                         : USB_STATE_ADDRESS);
2007                         set_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2008                         hcd->state = HC_STATE_RUNNING;
2009                 }
2010                 spin_unlock_irq(&hcd_root_hub_lock);
2011         } else {
2012                 hcd->state = old_state;
2013                 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
2014                                 "resume", status);
2015                 if (status != -ESHUTDOWN)
2016                         usb_hc_died(hcd);
2017         }
2018         return status;
2019 }
2020
2021 #endif  /* CONFIG_PM */
2022
2023 #ifdef  CONFIG_USB_SUSPEND
2024
2025 /* Workqueue routine for root-hub remote wakeup */
2026 static void hcd_resume_work(struct work_struct *work)
2027 {
2028         struct usb_hcd *hcd = container_of(work, struct usb_hcd, wakeup_work);
2029         struct usb_device *udev = hcd->self.root_hub;
2030
2031         usb_lock_device(udev);
2032         usb_remote_wakeup(udev);
2033         usb_unlock_device(udev);
2034 }
2035
2036 /**
2037  * usb_hcd_resume_root_hub - called by HCD to resume its root hub
2038  * @hcd: host controller for this root hub
2039  *
2040  * The USB host controller calls this function when its root hub is
2041  * suspended (with the remote wakeup feature enabled) and a remote
2042  * wakeup request is received.  The routine submits a workqueue request
2043  * to resume the root hub (that is, manage its downstream ports again).
2044  */
2045 void usb_hcd_resume_root_hub (struct usb_hcd *hcd)
2046 {
2047         unsigned long flags;
2048
2049         spin_lock_irqsave (&hcd_root_hub_lock, flags);
2050         if (hcd->rh_registered) {
2051                 set_bit(HCD_FLAG_WAKEUP_PENDING, &hcd->flags);
2052                 queue_work(pm_wq, &hcd->wakeup_work);
2053         }
2054         spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
2055 }
2056 EXPORT_SYMBOL_GPL(usb_hcd_resume_root_hub);
2057
2058 #endif  /* CONFIG_USB_SUSPEND */
2059
2060 /*-------------------------------------------------------------------------*/
2061
2062 #ifdef  CONFIG_USB_OTG
2063
2064 /**
2065  * usb_bus_start_enum - start immediate enumeration (for OTG)
2066  * @bus: the bus (must use hcd framework)
2067  * @port_num: 1-based number of port; usually bus->otg_port
2068  * Context: in_interrupt()
2069  *
2070  * Starts enumeration, with an immediate reset followed later by
2071  * khubd identifying and possibly configuring the device.
2072  * This is needed by OTG controller drivers, where it helps meet
2073  * HNP protocol timing requirements for starting a port reset.
2074  */
2075 int usb_bus_start_enum(struct usb_bus *bus, unsigned port_num)
2076 {
2077         struct usb_hcd          *hcd;
2078         int                     status = -EOPNOTSUPP;
2079
2080         /* NOTE: since HNP can't start by grabbing the bus's address0_sem,
2081          * boards with root hubs hooked up to internal devices (instead of
2082          * just the OTG port) may need more attention to resetting...
2083          */
2084         hcd = container_of (bus, struct usb_hcd, self);
2085         if (port_num && hcd->driver->start_port_reset)
2086                 status = hcd->driver->start_port_reset(hcd, port_num);
2087
2088         /* run khubd shortly after (first) root port reset finishes;
2089          * it may issue others, until at least 50 msecs have passed.
2090          */
2091         if (status == 0)
2092                 mod_timer(&hcd->rh_timer, jiffies + msecs_to_jiffies(10));
2093         return status;
2094 }
2095 EXPORT_SYMBOL_GPL(usb_bus_start_enum);
2096
2097 #endif
2098
2099 /*-------------------------------------------------------------------------*/
2100
2101 /**
2102  * usb_hcd_irq - hook IRQs to HCD framework (bus glue)
2103  * @irq: the IRQ being raised
2104  * @__hcd: pointer to the HCD whose IRQ is being signaled
2105  *
2106  * If the controller isn't HALTed, calls the driver's irq handler.
2107  * Checks whether the controller is now dead.
2108  */
2109 irqreturn_t usb_hcd_irq (int irq, void *__hcd)
2110 {
2111         struct usb_hcd          *hcd = __hcd;
2112         unsigned long           flags;
2113         irqreturn_t             rc;
2114
2115         /* IRQF_DISABLED doesn't work correctly with shared IRQs
2116          * when the first handler doesn't use it.  So let's just
2117          * assume it's never used.
2118          */
2119         local_irq_save(flags);
2120
2121         if (unlikely(HCD_DEAD(hcd) || !HCD_HW_ACCESSIBLE(hcd))) {
2122                 rc = IRQ_NONE;
2123         } else if (hcd->driver->irq(hcd) == IRQ_NONE) {
2124                 rc = IRQ_NONE;
2125         } else {
2126                 set_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
2127
2128                 if (unlikely(hcd->state == HC_STATE_HALT))
2129                         usb_hc_died(hcd);
2130                 rc = IRQ_HANDLED;
2131         }
2132
2133         local_irq_restore(flags);
2134         return rc;
2135 }
2136 EXPORT_SYMBOL_GPL(usb_hcd_irq);
2137
2138 /*-------------------------------------------------------------------------*/
2139
2140 /**
2141  * usb_hc_died - report abnormal shutdown of a host controller (bus glue)
2142  * @hcd: pointer to the HCD representing the controller
2143  *
2144  * This is called by bus glue to report a USB host controller that died
2145  * while operations may still have been pending.  It's called automatically
2146  * by the PCI glue, so only glue for non-PCI busses should need to call it.
2147  */
2148 void usb_hc_died (struct usb_hcd *hcd)
2149 {
2150         unsigned long flags;
2151
2152         dev_err (hcd->self.controller, "HC died; cleaning up\n");
2153
2154         spin_lock_irqsave (&hcd_root_hub_lock, flags);
2155         clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2156         set_bit(HCD_FLAG_DEAD, &hcd->flags);
2157         if (hcd->rh_registered) {
2158                 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2159
2160                 /* make khubd clean up old urbs and devices */
2161                 usb_set_device_state (hcd->self.root_hub,
2162                                 USB_STATE_NOTATTACHED);
2163                 usb_kick_khubd (hcd->self.root_hub);
2164         }
2165         spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
2166 }
2167 EXPORT_SYMBOL_GPL (usb_hc_died);
2168
2169 /*-------------------------------------------------------------------------*/
2170
2171 /**
2172  * usb_create_hcd - create and initialize an HCD structure
2173  * @driver: HC driver that will use this hcd
2174  * @dev: device for this HC, stored in hcd->self.controller
2175  * @bus_name: value to store in hcd->self.bus_name
2176  * Context: !in_interrupt()
2177  *
2178  * Allocate a struct usb_hcd, with extra space at the end for the
2179  * HC driver's private data.  Initialize the generic members of the
2180  * hcd structure.
2181  *
2182  * If memory is unavailable, returns NULL.
2183  */
2184 struct usb_hcd *usb_create_hcd (const struct hc_driver *driver,
2185                 struct device *dev, const char *bus_name)
2186 {
2187         struct usb_hcd *hcd;
2188
2189         hcd = kzalloc(sizeof(*hcd) + driver->hcd_priv_size, GFP_KERNEL);
2190         if (!hcd) {
2191                 dev_dbg (dev, "hcd alloc failed\n");
2192                 return NULL;
2193         }
2194         dev_set_drvdata(dev, hcd);
2195         kref_init(&hcd->kref);
2196
2197         usb_bus_init(&hcd->self);
2198         hcd->self.controller = dev;
2199         hcd->self.bus_name = bus_name;
2200         hcd->self.uses_dma = (dev->dma_mask != NULL);
2201
2202         init_timer(&hcd->rh_timer);
2203         hcd->rh_timer.function = rh_timer_func;
2204         hcd->rh_timer.data = (unsigned long) hcd;
2205 #ifdef CONFIG_USB_SUSPEND
2206         INIT_WORK(&hcd->wakeup_work, hcd_resume_work);
2207 #endif
2208         mutex_init(&hcd->bandwidth_mutex);
2209
2210         hcd->driver = driver;
2211         hcd->product_desc = (driver->product_desc) ? driver->product_desc :
2212                         "USB Host Controller";
2213         return hcd;
2214 }
2215 EXPORT_SYMBOL_GPL(usb_create_hcd);
2216
2217 static void hcd_release (struct kref *kref)
2218 {
2219         struct usb_hcd *hcd = container_of (kref, struct usb_hcd, kref);
2220
2221         kfree(hcd);
2222 }
2223
2224 struct usb_hcd *usb_get_hcd (struct usb_hcd *hcd)
2225 {
2226         if (hcd)
2227                 kref_get (&hcd->kref);
2228         return hcd;
2229 }
2230 EXPORT_SYMBOL_GPL(usb_get_hcd);
2231
2232 void usb_put_hcd (struct usb_hcd *hcd)
2233 {
2234         if (hcd)
2235                 kref_put (&hcd->kref, hcd_release);
2236 }
2237 EXPORT_SYMBOL_GPL(usb_put_hcd);
2238
2239 static int usb_hcd_request_irqs(struct usb_hcd *hcd,
2240                 unsigned int irqnum, unsigned long irqflags)
2241 {
2242         int retval;
2243
2244         if (hcd->driver->irq) {
2245
2246                 /* IRQF_DISABLED doesn't work as advertised when used together
2247                  * with IRQF_SHARED. As usb_hcd_irq() will always disable
2248                  * interrupts we can remove it here.
2249                  */
2250                 if (irqflags & IRQF_SHARED)
2251                         irqflags &= ~IRQF_DISABLED;
2252
2253                 snprintf(hcd->irq_descr, sizeof(hcd->irq_descr), "%s:usb%d",
2254                                 hcd->driver->description, hcd->self.busnum);
2255                 retval = request_irq(irqnum, &usb_hcd_irq, irqflags,
2256                                 hcd->irq_descr, hcd);
2257                 if (retval != 0) {
2258                         dev_err(hcd->self.controller,
2259                                         "request interrupt %d failed\n",
2260                                         irqnum);
2261                         return retval;
2262                 }
2263                 hcd->irq = irqnum;
2264                 dev_info(hcd->self.controller, "irq %d, %s 0x%08llx\n", irqnum,
2265                                 (hcd->driver->flags & HCD_MEMORY) ?
2266                                         "io mem" : "io base",
2267                                         (unsigned long long)hcd->rsrc_start);
2268         } else {
2269                 hcd->irq = -1;
2270                 if (hcd->rsrc_start)
2271                         dev_info(hcd->self.controller, "%s 0x%08llx\n",
2272                                         (hcd->driver->flags & HCD_MEMORY) ?
2273                                         "io mem" : "io base",
2274                                         (unsigned long long)hcd->rsrc_start);
2275         }
2276         return 0;
2277 }
2278
2279 /**
2280  * usb_add_hcd - finish generic HCD structure initialization and register
2281  * @hcd: the usb_hcd structure to initialize
2282  * @irqnum: Interrupt line to allocate
2283  * @irqflags: Interrupt type flags
2284  *
2285  * Finish the remaining parts of generic HCD initialization: allocate the
2286  * buffers of consistent memory, register the bus, request the IRQ line,
2287  * and call the driver's reset() and start() routines.
2288  */
2289 int usb_add_hcd(struct usb_hcd *hcd,
2290                 unsigned int irqnum, unsigned long irqflags)
2291 {
2292         int retval;
2293         struct usb_device *rhdev;
2294
2295         dev_info(hcd->self.controller, "%s\n", hcd->product_desc);
2296
2297         hcd->authorized_default = hcd->wireless? 0 : 1;
2298         set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
2299
2300         /* HC is in reset state, but accessible.  Now do the one-time init,
2301          * bottom up so that hcds can customize the root hubs before khubd
2302          * starts talking to them.  (Note, bus id is assigned early too.)
2303          */
2304         if ((retval = hcd_buffer_create(hcd)) != 0) {
2305                 dev_dbg(hcd->self.controller, "pool alloc failed\n");
2306                 return retval;
2307         }
2308
2309         if ((retval = usb_register_bus(&hcd->self)) < 0)
2310                 goto err_register_bus;
2311
2312         if ((rhdev = usb_alloc_dev(NULL, &hcd->self, 0)) == NULL) {
2313                 dev_err(hcd->self.controller, "unable to allocate root hub\n");
2314                 retval = -ENOMEM;
2315                 goto err_allocate_root_hub;
2316         }
2317         hcd->self.root_hub = rhdev;
2318
2319         switch (hcd->driver->flags & HCD_MASK) {
2320         case HCD_USB11:
2321                 rhdev->speed = USB_SPEED_FULL;
2322                 break;
2323         case HCD_USB2:
2324                 rhdev->speed = USB_SPEED_HIGH;
2325                 break;
2326         case HCD_USB3:
2327                 rhdev->speed = USB_SPEED_SUPER;
2328                 break;
2329         default:
2330                 goto err_set_rh_speed;
2331         }
2332
2333         /* wakeup flag init defaults to "everything works" for root hubs,
2334          * but drivers can override it in reset() if needed, along with
2335          * recording the overall controller's system wakeup capability.
2336          */
2337         device_init_wakeup(&rhdev->dev, 1);
2338
2339         /* HCD_FLAG_RH_RUNNING doesn't matter until the root hub is
2340          * registered.  But since the controller can die at any time,
2341          * let's initialize the flag before touching the hardware.
2342          */
2343         set_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2344
2345         /* "reset" is misnamed; its role is now one-time init. the controller
2346          * should already have been reset (and boot firmware kicked off etc).
2347          */
2348         if (hcd->driver->reset && (retval = hcd->driver->reset(hcd)) < 0) {
2349                 dev_err(hcd->self.controller, "can't setup\n");
2350                 goto err_hcd_driver_setup;
2351         }
2352         hcd->rh_pollable = 1;
2353
2354         /* NOTE: root hub and controller capabilities may not be the same */
2355         if (device_can_wakeup(hcd->self.controller)
2356                         && device_can_wakeup(&hcd->self.root_hub->dev))
2357                 dev_dbg(hcd->self.controller, "supports USB remote wakeup\n");
2358
2359         /* enable irqs just before we start the controller */
2360         retval = usb_hcd_request_irqs(hcd, irqnum, irqflags);
2361         if (retval)
2362                 goto err_request_irq;
2363
2364         hcd->state = HC_STATE_RUNNING;
2365         retval = hcd->driver->start(hcd);
2366         if (retval < 0) {
2367                 dev_err(hcd->self.controller, "startup error %d\n", retval);
2368                 goto err_hcd_driver_start;
2369         }
2370
2371         /* starting here, usbcore will pay attention to this root hub */
2372         rhdev->bus_mA = min(500u, hcd->power_budget);
2373         if ((retval = register_root_hub(hcd)) != 0)
2374                 goto err_register_root_hub;
2375
2376         retval = sysfs_create_group(&rhdev->dev.kobj, &usb_bus_attr_group);
2377         if (retval < 0) {
2378                 printk(KERN_ERR "Cannot register USB bus sysfs attributes: %d\n",
2379                        retval);
2380                 goto error_create_attr_group;
2381         }
2382         if (hcd->uses_new_polling && HCD_POLL_RH(hcd))
2383                 usb_hcd_poll_rh_status(hcd);
2384         return retval;
2385
2386 error_create_attr_group:
2387         clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2388         if (HC_IS_RUNNING(hcd->state))
2389                 hcd->state = HC_STATE_QUIESCING;
2390         spin_lock_irq(&hcd_root_hub_lock);
2391         hcd->rh_registered = 0;
2392         spin_unlock_irq(&hcd_root_hub_lock);
2393
2394 #ifdef CONFIG_USB_SUSPEND
2395         cancel_work_sync(&hcd->wakeup_work);
2396 #endif
2397         mutex_lock(&usb_bus_list_lock);
2398         usb_disconnect(&rhdev);         /* Sets rhdev to NULL */
2399         mutex_unlock(&usb_bus_list_lock);
2400 err_register_root_hub:
2401         hcd->rh_pollable = 0;
2402         clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2403         del_timer_sync(&hcd->rh_timer);
2404         hcd->driver->stop(hcd);
2405         hcd->state = HC_STATE_HALT;
2406         clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2407         del_timer_sync(&hcd->rh_timer);
2408 err_hcd_driver_start:
2409         if (hcd->irq >= 0)
2410                 free_irq(irqnum, hcd);
2411 err_request_irq:
2412 err_hcd_driver_setup:
2413 err_set_rh_speed:
2414         usb_put_dev(hcd->self.root_hub);
2415 err_allocate_root_hub:
2416         usb_deregister_bus(&hcd->self);
2417 err_register_bus:
2418         hcd_buffer_destroy(hcd);
2419         return retval;
2420 }
2421 EXPORT_SYMBOL_GPL(usb_add_hcd);
2422
2423 /**
2424  * usb_remove_hcd - shutdown processing for generic HCDs
2425  * @hcd: the usb_hcd structure to remove
2426  * Context: !in_interrupt()
2427  *
2428  * Disconnects the root hub, then reverses the effects of usb_add_hcd(),
2429  * invoking the HCD's stop() method.
2430  */
2431 void usb_remove_hcd(struct usb_hcd *hcd)
2432 {
2433         struct usb_device *rhdev = hcd->self.root_hub;
2434
2435         dev_info(hcd->self.controller, "remove, state %x\n", hcd->state);
2436
2437         usb_get_dev(rhdev);
2438         sysfs_remove_group(&rhdev->dev.kobj, &usb_bus_attr_group);
2439
2440         clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2441         if (HC_IS_RUNNING (hcd->state))
2442                 hcd->state = HC_STATE_QUIESCING;
2443
2444         dev_dbg(hcd->self.controller, "roothub graceful disconnect\n");
2445         spin_lock_irq (&hcd_root_hub_lock);
2446         hcd->rh_registered = 0;
2447         spin_unlock_irq (&hcd_root_hub_lock);
2448
2449 #ifdef CONFIG_USB_SUSPEND
2450         cancel_work_sync(&hcd->wakeup_work);
2451 #endif
2452
2453         mutex_lock(&usb_bus_list_lock);
2454         usb_disconnect(&rhdev);         /* Sets rhdev to NULL */
2455         mutex_unlock(&usb_bus_list_lock);
2456
2457         /* Prevent any more root-hub status calls from the timer.
2458          * The HCD might still restart the timer (if a port status change
2459          * interrupt occurs), but usb_hcd_poll_rh_status() won't invoke
2460          * the hub_status_data() callback.
2461          */
2462         hcd->rh_pollable = 0;
2463         clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2464         del_timer_sync(&hcd->rh_timer);
2465
2466         hcd->driver->stop(hcd);
2467         hcd->state = HC_STATE_HALT;
2468
2469         /* In case the HCD restarted the timer, stop it again. */
2470         clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2471         del_timer_sync(&hcd->rh_timer);
2472
2473         if (hcd->irq >= 0)
2474                 free_irq(hcd->irq, hcd);
2475
2476         usb_put_dev(hcd->self.root_hub);
2477         usb_deregister_bus(&hcd->self);
2478         hcd_buffer_destroy(hcd);
2479 }
2480 EXPORT_SYMBOL_GPL(usb_remove_hcd);
2481
2482 void
2483 usb_hcd_platform_shutdown(struct platform_device* dev)
2484 {
2485         struct usb_hcd *hcd = platform_get_drvdata(dev);
2486
2487         if (hcd->driver->shutdown)
2488                 hcd->driver->shutdown(hcd);
2489 }
2490 EXPORT_SYMBOL_GPL(usb_hcd_platform_shutdown);
2491
2492 /*-------------------------------------------------------------------------*/
2493
2494 #if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
2495
2496 struct usb_mon_operations *mon_ops;
2497
2498 /*
2499  * The registration is unlocked.
2500  * We do it this way because we do not want to lock in hot paths.
2501  *
2502  * Notice that the code is minimally error-proof. Because usbmon needs
2503  * symbols from usbcore, usbcore gets referenced and cannot be unloaded first.
2504  */
2505
2506 int usb_mon_register (struct usb_mon_operations *ops)
2507 {
2508
2509         if (mon_ops)
2510                 return -EBUSY;
2511
2512         mon_ops = ops;
2513         mb();
2514         return 0;
2515 }
2516 EXPORT_SYMBOL_GPL (usb_mon_register);
2517
2518 void usb_mon_deregister (void)
2519 {
2520
2521         if (mon_ops == NULL) {
2522                 printk(KERN_ERR "USB: monitor was not registered\n");
2523                 return;
2524         }
2525         mon_ops = NULL;
2526         mb();
2527 }
2528 EXPORT_SYMBOL_GPL (usb_mon_deregister);
2529
2530 #endif /* CONFIG_USB_MON || CONFIG_USB_MON_MODULE */