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