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