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