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