drivers/usb/core/hcd.c

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