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
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.
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
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.
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>
33 #include <linux/device.h>
34 #include <linux/dma-mapping.h>
35 #include <linux/mutex.h>
37 #include <asm/byteorder.h>
38 #include <asm/unaligned.h>
39 #include <linux/platform_device.h>
40 #include <linux/workqueue.h>
42 #include <linux/usb.h>
49 /*-------------------------------------------------------------------------*/
52 * USB Host Controller Driver framework
54 * Plugs into usbcore (usb_bus) and lets HCDs share code, minimizing
55 * HCD-specific behaviors/bugs.
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.
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.
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.
73 * Contributors of ideas or unattributed patches include: David Brownell,
74 * Roman Weissgaerber, Rory Bolt, Greg Kroah-Hartman, ...
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.
82 /*-------------------------------------------------------------------------*/
84 /* Keep track of which host controller drivers are loaded */
85 unsigned long usb_hcds_loaded;
86 EXPORT_SYMBOL_GPL(usb_hcds_loaded);
88 /* host controllers we manage */
89 LIST_HEAD (usb_bus_list);
90 EXPORT_SYMBOL_GPL (usb_bus_list);
92 /* used when allocating bus numbers */
95 unsigned long busmap [USB_MAXBUS / (8*sizeof (unsigned long))];
97 static struct usb_busmap busmap;
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);
103 /* used for controlling access to virtual root hubs */
104 static DEFINE_SPINLOCK(hcd_root_hub_lock);
106 /* used when updating an endpoint's URB list */
107 static DEFINE_SPINLOCK(hcd_urb_list_lock);
109 /* used to protect against unlinking URBs after the device is gone */
110 static DEFINE_SPINLOCK(hcd_urb_unlink_lock);
112 /* wait queue for synchronous unlinks */
113 DECLARE_WAIT_QUEUE_HEAD(usb_kill_urb_queue);
115 static inline int is_root_hub(struct usb_device *udev)
117 return (udev->parent == NULL);
120 /*-------------------------------------------------------------------------*/
123 * Sharable chunks of root hub code.
126 /*-------------------------------------------------------------------------*/
128 #define KERNEL_REL ((LINUX_VERSION_CODE >> 16) & 0x0ff)
129 #define KERNEL_VER ((LINUX_VERSION_CODE >> 8) & 0x0ff)
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 */
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 */
142 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation */
143 0x02, 0x00, /* __le16 idProduct; device 0x0002 */
144 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
146 0x03, /* __u8 iManufacturer; */
147 0x02, /* __u8 iProduct; */
148 0x01, /* __u8 iSerialNumber; */
149 0x01 /* __u8 bNumConfigurations; */
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 */
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 */
163 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation */
164 0x02, 0x00, /* __le16 idProduct; device 0x0002 */
165 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
167 0x03, /* __u8 iManufacturer; */
168 0x02, /* __u8 iProduct; */
169 0x01, /* __u8 iSerialNumber; */
170 0x01 /* __u8 bNumConfigurations; */
173 /* no usb 2.0 root hub "device qualifier" descriptor: one speed only */
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 */
181 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
182 0x00, /* __u8 bDeviceSubClass; */
183 0x00, /* __u8 bDeviceProtocol; [ low/full speeds only ] */
184 0x40, /* __u8 bMaxPacketSize0; 64 Bytes */
186 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation */
187 0x01, 0x00, /* __le16 idProduct; device 0x0001 */
188 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
190 0x03, /* __u8 iManufacturer; */
191 0x02, /* __u8 iProduct; */
192 0x01, /* __u8 iSerialNumber; */
193 0x01 /* __u8 bNumConfigurations; */
197 /*-------------------------------------------------------------------------*/
199 /* Configuration descriptors for our root hubs */
201 static const u8 fs_rh_config_descriptor [] = {
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;
215 0x00, /* __u8 MaxPower; */
218 * USB 2.0, single TT organization (mandatory):
219 * one interface, protocol 0
221 * USB 2.0, multiple TT organization (optional):
222 * two interfaces, protocols 1 (like single TT)
223 * and 2 (multiple TT mode) ... config is
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; */
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) */
248 static const u8 hs_rh_config_descriptor [] = {
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;
262 0x00, /* __u8 MaxPower; */
265 * USB 2.0, single TT organization (mandatory):
266 * one interface, protocol 0
268 * USB 2.0, multiple TT organization (optional):
269 * two interfaces, protocols 1 (like single TT)
270 * and 2 (multiple TT mode) ... config is
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; */
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) */
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;
310 0x00, /* __u8 MaxPower; */
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; */
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) */
333 * All 3.0 hubs should have an endpoint companion descriptor,
334 * but we're ignoring that for now. FIXME?
338 /*-------------------------------------------------------------------------*/
341 * helper routine for returning string descriptors in UTF-16LE
342 * input can actually be ISO-8859-1; ASCII is its 7-bit subset
344 static unsigned ascii2utf(char *s, u8 *utf, int utfmax)
348 for (retval = 0; *s && utfmax > 1; utfmax -= 2, retval += 2) {
360 * rh_string - provides manufacturer, product and serial strings for root hub
361 * @id: the string ID number (1: serial number, 2: product, 3: vendor)
362 * @hcd: the host controller for this root hub
363 * @data: return packet in UTF-16 LE
364 * @len: length of the return packet
366 * Produces either a manufacturer, product or serial number string for the
367 * virtual root hub device.
369 static unsigned rh_string(int id, struct usb_hcd *hcd, u8 *data, unsigned len)
375 buf[0] = 4; buf[1] = 3; /* 4 bytes string data */
376 buf[2] = 0x09; buf[3] = 0x04; /* MSFT-speak for "en-us" */
377 len = min_t(unsigned, len, 4);
378 memcpy (data, buf, len);
382 } else if (id == 1) {
383 strlcpy (buf, hcd->self.bus_name, sizeof buf);
385 // product description
386 } else if (id == 2) {
387 strlcpy (buf, hcd->product_desc, sizeof buf);
389 // id 3 == vendor description
390 } else if (id == 3) {
391 snprintf (buf, sizeof buf, "%s %s %s", init_utsname()->sysname,
392 init_utsname()->release, hcd->driver->description);
395 switch (len) { /* All cases fall through */
397 len = 2 + ascii2utf (buf, data + 2, len - 2);
399 data [1] = 3; /* type == string */
401 data [0] = 2 * (strlen (buf) + 1);
403 ; /* Compiler wants a statement here */
409 /* Root hub control transfers execute synchronously */
410 static int rh_call_control (struct usb_hcd *hcd, struct urb *urb)
412 struct usb_ctrlrequest *cmd;
413 u16 typeReq, wValue, wIndex, wLength;
414 u8 *ubuf = urb->transfer_buffer;
415 u8 tbuf [sizeof (struct usb_hub_descriptor)]
416 __attribute__((aligned(4)));
417 const u8 *bufp = tbuf;
421 u8 patch_protocol = 0;
425 spin_lock_irq(&hcd_root_hub_lock);
426 status = usb_hcd_link_urb_to_ep(hcd, urb);
427 spin_unlock_irq(&hcd_root_hub_lock);
430 urb->hcpriv = hcd; /* Indicate it's queued */
432 cmd = (struct usb_ctrlrequest *) urb->setup_packet;
433 typeReq = (cmd->bRequestType << 8) | cmd->bRequest;
434 wValue = le16_to_cpu (cmd->wValue);
435 wIndex = le16_to_cpu (cmd->wIndex);
436 wLength = le16_to_cpu (cmd->wLength);
438 if (wLength > urb->transfer_buffer_length)
441 urb->actual_length = 0;
444 /* DEVICE REQUESTS */
446 /* The root hub's remote wakeup enable bit is implemented using
447 * driver model wakeup flags. If this system supports wakeup
448 * through USB, userspace may change the default "allow wakeup"
449 * policy through sysfs or these calls.
451 * Most root hubs support wakeup from downstream devices, for
452 * runtime power management (disabling USB clocks and reducing
453 * VBUS power usage). However, not all of them do so; silicon,
454 * board, and BIOS bugs here are not uncommon, so these can't
455 * be treated quite like external hubs.
457 * Likewise, not all root hubs will pass wakeup events upstream,
458 * to wake up the whole system. So don't assume root hub and
459 * controller capabilities are identical.
462 case DeviceRequest | USB_REQ_GET_STATUS:
463 tbuf [0] = (device_may_wakeup(&hcd->self.root_hub->dev)
464 << USB_DEVICE_REMOTE_WAKEUP)
465 | (1 << USB_DEVICE_SELF_POWERED);
469 case DeviceOutRequest | USB_REQ_CLEAR_FEATURE:
470 if (wValue == USB_DEVICE_REMOTE_WAKEUP)
471 device_set_wakeup_enable(&hcd->self.root_hub->dev, 0);
475 case DeviceOutRequest | USB_REQ_SET_FEATURE:
476 if (device_can_wakeup(&hcd->self.root_hub->dev)
477 && wValue == USB_DEVICE_REMOTE_WAKEUP)
478 device_set_wakeup_enable(&hcd->self.root_hub->dev, 1);
482 case DeviceRequest | USB_REQ_GET_CONFIGURATION:
486 case DeviceOutRequest | USB_REQ_SET_CONFIGURATION:
488 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
489 switch (wValue & 0xff00) {
490 case USB_DT_DEVICE << 8:
491 if (hcd->driver->flags & HCD_USB3)
492 bufp = usb3_rh_dev_descriptor;
493 else if (hcd->driver->flags & HCD_USB2)
494 bufp = usb2_rh_dev_descriptor;
495 else if (hcd->driver->flags & HCD_USB11)
496 bufp = usb11_rh_dev_descriptor;
503 case USB_DT_CONFIG << 8:
504 if (hcd->driver->flags & HCD_USB3) {
505 bufp = ss_rh_config_descriptor;
506 len = sizeof ss_rh_config_descriptor;
507 } else if (hcd->driver->flags & HCD_USB2) {
508 bufp = hs_rh_config_descriptor;
509 len = sizeof hs_rh_config_descriptor;
511 bufp = fs_rh_config_descriptor;
512 len = sizeof fs_rh_config_descriptor;
514 if (device_can_wakeup(&hcd->self.root_hub->dev))
517 case USB_DT_STRING << 8:
518 if ((wValue & 0xff) < 4)
519 urb->actual_length = rh_string(wValue & 0xff,
521 else /* unsupported IDs --> "protocol stall" */
528 case DeviceRequest | USB_REQ_GET_INTERFACE:
532 case DeviceOutRequest | USB_REQ_SET_INTERFACE:
534 case DeviceOutRequest | USB_REQ_SET_ADDRESS:
535 // wValue == urb->dev->devaddr
536 dev_dbg (hcd->self.controller, "root hub device address %d\n",
540 /* INTERFACE REQUESTS (no defined feature/status flags) */
542 /* ENDPOINT REQUESTS */
544 case EndpointRequest | USB_REQ_GET_STATUS:
545 // ENDPOINT_HALT flag
550 case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
551 case EndpointOutRequest | USB_REQ_SET_FEATURE:
552 dev_dbg (hcd->self.controller, "no endpoint features yet\n");
555 /* CLASS REQUESTS (and errors) */
558 /* non-generic request */
564 case GetHubDescriptor:
565 len = sizeof (struct usb_hub_descriptor);
568 status = hcd->driver->hub_control (hcd,
569 typeReq, wValue, wIndex,
573 /* "protocol stall" on error */
579 if (status != -EPIPE) {
580 dev_dbg (hcd->self.controller,
581 "CTRL: TypeReq=0x%x val=0x%x "
582 "idx=0x%x len=%d ==> %d\n",
583 typeReq, wValue, wIndex,
588 if (urb->transfer_buffer_length < len)
589 len = urb->transfer_buffer_length;
590 urb->actual_length = len;
591 // always USB_DIR_IN, toward host
592 memcpy (ubuf, bufp, len);
594 /* report whether RH hardware supports remote wakeup */
596 len > offsetof (struct usb_config_descriptor,
598 ((struct usb_config_descriptor *)ubuf)->bmAttributes
599 |= USB_CONFIG_ATT_WAKEUP;
601 /* report whether RH hardware has an integrated TT */
602 if (patch_protocol &&
603 len > offsetof(struct usb_device_descriptor,
605 ((struct usb_device_descriptor *) ubuf)->
609 /* any errors get returned through the urb completion */
610 spin_lock_irq(&hcd_root_hub_lock);
611 usb_hcd_unlink_urb_from_ep(hcd, urb);
613 /* This peculiar use of spinlocks echoes what real HC drivers do.
614 * Avoiding calls to local_irq_disable/enable makes the code
617 spin_unlock(&hcd_root_hub_lock);
618 usb_hcd_giveback_urb(hcd, urb, status);
619 spin_lock(&hcd_root_hub_lock);
621 spin_unlock_irq(&hcd_root_hub_lock);
625 /*-------------------------------------------------------------------------*/
628 * Root Hub interrupt transfers are polled using a timer if the
629 * driver requests it; otherwise the driver is responsible for
630 * calling usb_hcd_poll_rh_status() when an event occurs.
632 * Completions are called in_interrupt(), but they may or may not
635 void usb_hcd_poll_rh_status(struct usb_hcd *hcd)
640 char buffer[4]; /* Any root hubs with > 31 ports? */
642 if (unlikely(!hcd->rh_registered))
644 if (!hcd->uses_new_polling && !hcd->status_urb)
647 length = hcd->driver->hub_status_data(hcd, buffer);
650 /* try to complete the status urb */
651 spin_lock_irqsave(&hcd_root_hub_lock, flags);
652 urb = hcd->status_urb;
654 hcd->poll_pending = 0;
655 hcd->status_urb = NULL;
656 urb->actual_length = length;
657 memcpy(urb->transfer_buffer, buffer, length);
659 usb_hcd_unlink_urb_from_ep(hcd, urb);
660 spin_unlock(&hcd_root_hub_lock);
661 usb_hcd_giveback_urb(hcd, urb, 0);
662 spin_lock(&hcd_root_hub_lock);
665 hcd->poll_pending = 1;
667 spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
670 /* The USB 2.0 spec says 256 ms. This is close enough and won't
671 * exceed that limit if HZ is 100. The math is more clunky than
672 * maybe expected, this is to make sure that all timers for USB devices
673 * fire at the same time to give the CPU a break inbetween */
674 if (hcd->uses_new_polling ? hcd->poll_rh :
675 (length == 0 && hcd->status_urb != NULL))
676 mod_timer (&hcd->rh_timer, (jiffies/(HZ/4) + 1) * (HZ/4));
678 EXPORT_SYMBOL_GPL(usb_hcd_poll_rh_status);
681 static void rh_timer_func (unsigned long _hcd)
683 usb_hcd_poll_rh_status((struct usb_hcd *) _hcd);
686 /*-------------------------------------------------------------------------*/
688 static int rh_queue_status (struct usb_hcd *hcd, struct urb *urb)
692 unsigned len = 1 + (urb->dev->maxchild / 8);
694 spin_lock_irqsave (&hcd_root_hub_lock, flags);
695 if (hcd->status_urb || urb->transfer_buffer_length < len) {
696 dev_dbg (hcd->self.controller, "not queuing rh status urb\n");
701 retval = usb_hcd_link_urb_to_ep(hcd, urb);
705 hcd->status_urb = urb;
706 urb->hcpriv = hcd; /* indicate it's queued */
707 if (!hcd->uses_new_polling)
708 mod_timer(&hcd->rh_timer, (jiffies/(HZ/4) + 1) * (HZ/4));
710 /* If a status change has already occurred, report it ASAP */
711 else if (hcd->poll_pending)
712 mod_timer(&hcd->rh_timer, jiffies);
715 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
719 static int rh_urb_enqueue (struct usb_hcd *hcd, struct urb *urb)
721 if (usb_endpoint_xfer_int(&urb->ep->desc))
722 return rh_queue_status (hcd, urb);
723 if (usb_endpoint_xfer_control(&urb->ep->desc))
724 return rh_call_control (hcd, urb);
728 /*-------------------------------------------------------------------------*/
730 /* Unlinks of root-hub control URBs are legal, but they don't do anything
731 * since these URBs always execute synchronously.
733 static int usb_rh_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
738 spin_lock_irqsave(&hcd_root_hub_lock, flags);
739 rc = usb_hcd_check_unlink_urb(hcd, urb, status);
743 if (usb_endpoint_num(&urb->ep->desc) == 0) { /* Control URB */
746 } else { /* Status URB */
747 if (!hcd->uses_new_polling)
748 del_timer (&hcd->rh_timer);
749 if (urb == hcd->status_urb) {
750 hcd->status_urb = NULL;
751 usb_hcd_unlink_urb_from_ep(hcd, urb);
753 spin_unlock(&hcd_root_hub_lock);
754 usb_hcd_giveback_urb(hcd, urb, status);
755 spin_lock(&hcd_root_hub_lock);
759 spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
766 * Show & store the current value of authorized_default
768 static ssize_t usb_host_authorized_default_show(struct device *dev,
769 struct device_attribute *attr,
772 struct usb_device *rh_usb_dev = to_usb_device(dev);
773 struct usb_bus *usb_bus = rh_usb_dev->bus;
774 struct usb_hcd *usb_hcd;
776 if (usb_bus == NULL) /* FIXME: not sure if this case is possible */
778 usb_hcd = bus_to_hcd(usb_bus);
779 return snprintf(buf, PAGE_SIZE, "%u\n", usb_hcd->authorized_default);
782 static ssize_t usb_host_authorized_default_store(struct device *dev,
783 struct device_attribute *attr,
784 const char *buf, size_t size)
788 struct usb_device *rh_usb_dev = to_usb_device(dev);
789 struct usb_bus *usb_bus = rh_usb_dev->bus;
790 struct usb_hcd *usb_hcd;
792 if (usb_bus == NULL) /* FIXME: not sure if this case is possible */
794 usb_hcd = bus_to_hcd(usb_bus);
795 result = sscanf(buf, "%u\n", &val);
797 usb_hcd->authorized_default = val? 1 : 0;
805 static DEVICE_ATTR(authorized_default, 0644,
806 usb_host_authorized_default_show,
807 usb_host_authorized_default_store);
810 /* Group all the USB bus attributes */
811 static struct attribute *usb_bus_attrs[] = {
812 &dev_attr_authorized_default.attr,
816 static struct attribute_group usb_bus_attr_group = {
817 .name = NULL, /* we want them in the same directory */
818 .attrs = usb_bus_attrs,
823 /*-------------------------------------------------------------------------*/
826 * usb_bus_init - shared initialization code
827 * @bus: the bus structure being initialized
829 * This code is used to initialize a usb_bus structure, memory for which is
830 * separately managed.
832 static void usb_bus_init (struct usb_bus *bus)
834 memset (&bus->devmap, 0, sizeof(struct usb_devmap));
836 bus->devnum_next = 1;
838 bus->root_hub = NULL;
840 bus->bandwidth_allocated = 0;
841 bus->bandwidth_int_reqs = 0;
842 bus->bandwidth_isoc_reqs = 0;
844 INIT_LIST_HEAD (&bus->bus_list);
847 /*-------------------------------------------------------------------------*/
850 * usb_register_bus - registers the USB host controller with the usb core
851 * @bus: pointer to the bus to register
852 * Context: !in_interrupt()
854 * Assigns a bus number, and links the controller into usbcore data
855 * structures so that it can be seen by scanning the bus list.
857 static int usb_register_bus(struct usb_bus *bus)
862 mutex_lock(&usb_bus_list_lock);
863 busnum = find_next_zero_bit (busmap.busmap, USB_MAXBUS, 1);
864 if (busnum >= USB_MAXBUS) {
865 printk (KERN_ERR "%s: too many buses\n", usbcore_name);
866 goto error_find_busnum;
868 set_bit (busnum, busmap.busmap);
869 bus->busnum = busnum;
871 /* Add it to the local list of buses */
872 list_add (&bus->bus_list, &usb_bus_list);
873 mutex_unlock(&usb_bus_list_lock);
875 usb_notify_add_bus(bus);
877 dev_info (bus->controller, "new USB bus registered, assigned bus "
878 "number %d\n", bus->busnum);
882 mutex_unlock(&usb_bus_list_lock);
887 * usb_deregister_bus - deregisters the USB host controller
888 * @bus: pointer to the bus to deregister
889 * Context: !in_interrupt()
891 * Recycles the bus number, and unlinks the controller from usbcore data
892 * structures so that it won't be seen by scanning the bus list.
894 static void usb_deregister_bus (struct usb_bus *bus)
896 dev_info (bus->controller, "USB bus %d deregistered\n", bus->busnum);
899 * NOTE: make sure that all the devices are removed by the
900 * controller code, as well as having it call this when cleaning
903 mutex_lock(&usb_bus_list_lock);
904 list_del (&bus->bus_list);
905 mutex_unlock(&usb_bus_list_lock);
907 usb_notify_remove_bus(bus);
909 clear_bit (bus->busnum, busmap.busmap);
913 * register_root_hub - called by usb_add_hcd() to register a root hub
914 * @hcd: host controller for this root hub
916 * This function registers the root hub with the USB subsystem. It sets up
917 * the device properly in the device tree and then calls usb_new_device()
918 * to register the usb device. It also assigns the root hub's USB address
921 static int register_root_hub(struct usb_hcd *hcd)
923 struct device *parent_dev = hcd->self.controller;
924 struct usb_device *usb_dev = hcd->self.root_hub;
925 const int devnum = 1;
928 usb_dev->devnum = devnum;
929 usb_dev->bus->devnum_next = devnum + 1;
930 memset (&usb_dev->bus->devmap.devicemap, 0,
931 sizeof usb_dev->bus->devmap.devicemap);
932 set_bit (devnum, usb_dev->bus->devmap.devicemap);
933 usb_set_device_state(usb_dev, USB_STATE_ADDRESS);
935 mutex_lock(&usb_bus_list_lock);
937 usb_dev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
938 retval = usb_get_device_descriptor(usb_dev, USB_DT_DEVICE_SIZE);
939 if (retval != sizeof usb_dev->descriptor) {
940 mutex_unlock(&usb_bus_list_lock);
941 dev_dbg (parent_dev, "can't read %s device descriptor %d\n",
942 dev_name(&usb_dev->dev), retval);
943 return (retval < 0) ? retval : -EMSGSIZE;
946 retval = usb_new_device (usb_dev);
948 dev_err (parent_dev, "can't register root hub for %s, %d\n",
949 dev_name(&usb_dev->dev), retval);
951 mutex_unlock(&usb_bus_list_lock);
954 spin_lock_irq (&hcd_root_hub_lock);
955 hcd->rh_registered = 1;
956 spin_unlock_irq (&hcd_root_hub_lock);
958 /* Did the HC die before the root hub was registered? */
959 if (hcd->state == HC_STATE_HALT)
960 usb_hc_died (hcd); /* This time clean up */
967 /*-------------------------------------------------------------------------*/
970 * usb_calc_bus_time - approximate periodic transaction time in nanoseconds
971 * @speed: from dev->speed; USB_SPEED_{LOW,FULL,HIGH}
972 * @is_input: true iff the transaction sends data to the host
973 * @isoc: true for isochronous transactions, false for interrupt ones
974 * @bytecount: how many bytes in the transaction.
976 * Returns approximate bus time in nanoseconds for a periodic transaction.
977 * See USB 2.0 spec section 5.11.3; only periodic transfers need to be
978 * scheduled in software, this function is only used for such scheduling.
980 long usb_calc_bus_time (int speed, int is_input, int isoc, int bytecount)
985 case USB_SPEED_LOW: /* INTR only */
987 tmp = (67667L * (31L + 10L * BitTime (bytecount))) / 1000L;
988 return (64060L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp);
990 tmp = (66700L * (31L + 10L * BitTime (bytecount))) / 1000L;
991 return (64107L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp);
993 case USB_SPEED_FULL: /* ISOC or INTR */
995 tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
996 return (((is_input) ? 7268L : 6265L) + BW_HOST_DELAY + tmp);
998 tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
999 return (9107L + BW_HOST_DELAY + tmp);
1001 case USB_SPEED_HIGH: /* ISOC or INTR */
1002 // FIXME adjust for input vs output
1004 tmp = HS_NSECS_ISO (bytecount);
1006 tmp = HS_NSECS (bytecount);
1009 pr_debug ("%s: bogus device speed!\n", usbcore_name);
1013 EXPORT_SYMBOL_GPL(usb_calc_bus_time);
1016 /*-------------------------------------------------------------------------*/
1019 * Generic HC operations.
1022 /*-------------------------------------------------------------------------*/
1025 * usb_hcd_link_urb_to_ep - add an URB to its endpoint queue
1026 * @hcd: host controller to which @urb was submitted
1027 * @urb: URB being submitted
1029 * Host controller drivers should call this routine in their enqueue()
1030 * method. The HCD's private spinlock must be held and interrupts must
1031 * be disabled. The actions carried out here are required for URB
1032 * submission, as well as for endpoint shutdown and for usb_kill_urb.
1034 * Returns 0 for no error, otherwise a negative error code (in which case
1035 * the enqueue() method must fail). If no error occurs but enqueue() fails
1036 * anyway, it must call usb_hcd_unlink_urb_from_ep() before releasing
1037 * the private spinlock and returning.
1039 int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb)
1043 spin_lock(&hcd_urb_list_lock);
1045 /* Check that the URB isn't being killed */
1046 if (unlikely(atomic_read(&urb->reject))) {
1051 if (unlikely(!urb->ep->enabled)) {
1056 if (unlikely(!urb->dev->can_submit)) {
1062 * Check the host controller's state and add the URB to the
1065 switch (hcd->state) {
1066 case HC_STATE_RUNNING:
1067 case HC_STATE_RESUMING:
1069 list_add_tail(&urb->urb_list, &urb->ep->urb_list);
1076 spin_unlock(&hcd_urb_list_lock);
1079 EXPORT_SYMBOL_GPL(usb_hcd_link_urb_to_ep);
1082 * usb_hcd_check_unlink_urb - check whether an URB may be unlinked
1083 * @hcd: host controller to which @urb was submitted
1084 * @urb: URB being checked for unlinkability
1085 * @status: error code to store in @urb if the unlink succeeds
1087 * Host controller drivers should call this routine in their dequeue()
1088 * method. The HCD's private spinlock must be held and interrupts must
1089 * be disabled. The actions carried out here are required for making
1090 * sure than an unlink is valid.
1092 * Returns 0 for no error, otherwise a negative error code (in which case
1093 * the dequeue() method must fail). The possible error codes are:
1095 * -EIDRM: @urb was not submitted or has already completed.
1096 * The completion function may not have been called yet.
1098 * -EBUSY: @urb has already been unlinked.
1100 int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb,
1103 struct list_head *tmp;
1105 /* insist the urb is still queued */
1106 list_for_each(tmp, &urb->ep->urb_list) {
1107 if (tmp == &urb->urb_list)
1110 if (tmp != &urb->urb_list)
1113 /* Any status except -EINPROGRESS means something already started to
1114 * unlink this URB from the hardware. So there's no more work to do.
1118 urb->unlinked = status;
1120 /* IRQ setup can easily be broken so that USB controllers
1121 * never get completion IRQs ... maybe even the ones we need to
1122 * finish unlinking the initial failed usb_set_address()
1123 * or device descriptor fetch.
1125 if (!test_bit(HCD_FLAG_SAW_IRQ, &hcd->flags) &&
1126 !is_root_hub(urb->dev)) {
1127 dev_warn(hcd->self.controller, "Unlink after no-IRQ? "
1128 "Controller is probably using the wrong IRQ.\n");
1129 set_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
1134 EXPORT_SYMBOL_GPL(usb_hcd_check_unlink_urb);
1137 * usb_hcd_unlink_urb_from_ep - remove an URB from its endpoint queue
1138 * @hcd: host controller to which @urb was submitted
1139 * @urb: URB being unlinked
1141 * Host controller drivers should call this routine before calling
1142 * usb_hcd_giveback_urb(). The HCD's private spinlock must be held and
1143 * interrupts must be disabled. The actions carried out here are required
1144 * for URB completion.
1146 void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb)
1148 /* clear all state linking urb to this dev (and hcd) */
1149 spin_lock(&hcd_urb_list_lock);
1150 list_del_init(&urb->urb_list);
1151 spin_unlock(&hcd_urb_list_lock);
1153 EXPORT_SYMBOL_GPL(usb_hcd_unlink_urb_from_ep);
1156 * Some usb host controllers can only perform dma using a small SRAM area.
1157 * The usb core itself is however optimized for host controllers that can dma
1158 * using regular system memory - like pci devices doing bus mastering.
1160 * To support host controllers with limited dma capabilites we provide dma
1161 * bounce buffers. This feature can be enabled using the HCD_LOCAL_MEM flag.
1162 * For this to work properly the host controller code must first use the
1163 * function dma_declare_coherent_memory() to point out which memory area
1164 * that should be used for dma allocations.
1166 * The HCD_LOCAL_MEM flag then tells the usb code to allocate all data for
1167 * dma using dma_alloc_coherent() which in turn allocates from the memory
1168 * area pointed out with dma_declare_coherent_memory().
1170 * So, to summarize...
1172 * - We need "local" memory, canonical example being
1173 * a small SRAM on a discrete controller being the
1174 * only memory that the controller can read ...
1175 * (a) "normal" kernel memory is no good, and
1176 * (b) there's not enough to share
1178 * - The only *portable* hook for such stuff in the
1179 * DMA framework is dma_declare_coherent_memory()
1181 * - So we use that, even though the primary requirement
1182 * is that the memory be "local" (hence addressible
1183 * by that device), not "coherent".
1187 static int hcd_alloc_coherent(struct usb_bus *bus,
1188 gfp_t mem_flags, dma_addr_t *dma_handle,
1189 void **vaddr_handle, size_t size,
1190 enum dma_data_direction dir)
1192 unsigned char *vaddr;
1194 vaddr = hcd_buffer_alloc(bus, size + sizeof(vaddr),
1195 mem_flags, dma_handle);
1200 * Store the virtual address of the buffer at the end
1201 * of the allocated dma buffer. The size of the buffer
1202 * may be uneven so use unaligned functions instead
1203 * of just rounding up. It makes sense to optimize for
1204 * memory footprint over access speed since the amount
1205 * of memory available for dma may be limited.
1207 put_unaligned((unsigned long)*vaddr_handle,
1208 (unsigned long *)(vaddr + size));
1210 if (dir == DMA_TO_DEVICE)
1211 memcpy(vaddr, *vaddr_handle, size);
1213 *vaddr_handle = vaddr;
1217 static void hcd_free_coherent(struct usb_bus *bus, dma_addr_t *dma_handle,
1218 void **vaddr_handle, size_t size,
1219 enum dma_data_direction dir)
1221 unsigned char *vaddr = *vaddr_handle;
1223 vaddr = (void *)get_unaligned((unsigned long *)(vaddr + size));
1225 if (dir == DMA_FROM_DEVICE)
1226 memcpy(vaddr, *vaddr_handle, size);
1228 hcd_buffer_free(bus, size + sizeof(vaddr), *vaddr_handle, *dma_handle);
1230 *vaddr_handle = vaddr;
1234 static int map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
1237 enum dma_data_direction dir;
1240 /* Map the URB's buffers for DMA access.
1241 * Lower level HCD code should use *_dma exclusively,
1242 * unless it uses pio or talks to another transport.
1244 if (is_root_hub(urb->dev))
1247 if (usb_endpoint_xfer_control(&urb->ep->desc)
1248 && !(urb->transfer_flags & URB_NO_SETUP_DMA_MAP)) {
1249 if (hcd->self.uses_dma)
1250 urb->setup_dma = dma_map_single(
1251 hcd->self.controller,
1253 sizeof(struct usb_ctrlrequest),
1255 else if (hcd->driver->flags & HCD_LOCAL_MEM)
1256 ret = hcd_alloc_coherent(
1257 urb->dev->bus, mem_flags,
1259 (void **)&urb->setup_packet,
1260 sizeof(struct usb_ctrlrequest),
1264 dir = usb_urb_dir_in(urb) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
1265 if (ret == 0 && urb->transfer_buffer_length != 0
1266 && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP)) {
1267 if (hcd->self.uses_dma)
1268 urb->transfer_dma = dma_map_single (
1269 hcd->self.controller,
1270 urb->transfer_buffer,
1271 urb->transfer_buffer_length,
1273 else if (hcd->driver->flags & HCD_LOCAL_MEM) {
1274 ret = hcd_alloc_coherent(
1275 urb->dev->bus, mem_flags,
1277 &urb->transfer_buffer,
1278 urb->transfer_buffer_length,
1281 if (ret && usb_endpoint_xfer_control(&urb->ep->desc)
1282 && !(urb->transfer_flags & URB_NO_SETUP_DMA_MAP))
1283 hcd_free_coherent(urb->dev->bus,
1285 (void **)&urb->setup_packet,
1286 sizeof(struct usb_ctrlrequest),
1293 static void unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
1295 enum dma_data_direction dir;
1297 if (is_root_hub(urb->dev))
1300 if (usb_endpoint_xfer_control(&urb->ep->desc)
1301 && !(urb->transfer_flags & URB_NO_SETUP_DMA_MAP)) {
1302 if (hcd->self.uses_dma)
1303 dma_unmap_single(hcd->self.controller, urb->setup_dma,
1304 sizeof(struct usb_ctrlrequest),
1306 else if (hcd->driver->flags & HCD_LOCAL_MEM)
1307 hcd_free_coherent(urb->dev->bus, &urb->setup_dma,
1308 (void **)&urb->setup_packet,
1309 sizeof(struct usb_ctrlrequest),
1313 dir = usb_urb_dir_in(urb) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
1314 if (urb->transfer_buffer_length != 0
1315 && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP)) {
1316 if (hcd->self.uses_dma)
1317 dma_unmap_single(hcd->self.controller,
1319 urb->transfer_buffer_length,
1321 else if (hcd->driver->flags & HCD_LOCAL_MEM)
1322 hcd_free_coherent(urb->dev->bus, &urb->transfer_dma,
1323 &urb->transfer_buffer,
1324 urb->transfer_buffer_length,
1329 /*-------------------------------------------------------------------------*/
1331 /* may be called in any context with a valid urb->dev usecount
1332 * caller surrenders "ownership" of urb
1333 * expects usb_submit_urb() to have sanity checked and conditioned all
1336 int usb_hcd_submit_urb (struct urb *urb, gfp_t mem_flags)
1339 struct usb_hcd *hcd = bus_to_hcd(urb->dev->bus);
1341 /* increment urb's reference count as part of giving it to the HCD
1342 * (which will control it). HCD guarantees that it either returns
1343 * an error or calls giveback(), but not both.
1346 atomic_inc(&urb->use_count);
1347 atomic_inc(&urb->dev->urbnum);
1348 usbmon_urb_submit(&hcd->self, urb);
1350 /* NOTE requirements on root-hub callers (usbfs and the hub
1351 * driver, for now): URBs' urb->transfer_buffer must be
1352 * valid and usb_buffer_{sync,unmap}() not be needed, since
1353 * they could clobber root hub response data. Also, control
1354 * URBs must be submitted in process context with interrupts
1357 status = map_urb_for_dma(hcd, urb, mem_flags);
1358 if (unlikely(status)) {
1359 usbmon_urb_submit_error(&hcd->self, urb, status);
1363 if (is_root_hub(urb->dev))
1364 status = rh_urb_enqueue(hcd, urb);
1366 status = hcd->driver->urb_enqueue(hcd, urb, mem_flags);
1368 if (unlikely(status)) {
1369 usbmon_urb_submit_error(&hcd->self, urb, status);
1370 unmap_urb_for_dma(hcd, urb);
1373 INIT_LIST_HEAD(&urb->urb_list);
1374 atomic_dec(&urb->use_count);
1375 atomic_dec(&urb->dev->urbnum);
1376 if (atomic_read(&urb->reject))
1377 wake_up(&usb_kill_urb_queue);
1383 /*-------------------------------------------------------------------------*/
1385 /* this makes the hcd giveback() the urb more quickly, by kicking it
1386 * off hardware queues (which may take a while) and returning it as
1387 * soon as practical. we've already set up the urb's return status,
1388 * but we can't know if the callback completed already.
1390 static int unlink1(struct usb_hcd *hcd, struct urb *urb, int status)
1394 if (is_root_hub(urb->dev))
1395 value = usb_rh_urb_dequeue(hcd, urb, status);
1398 /* The only reason an HCD might fail this call is if
1399 * it has not yet fully queued the urb to begin with.
1400 * Such failures should be harmless. */
1401 value = hcd->driver->urb_dequeue(hcd, urb, status);
1407 * called in any context
1409 * caller guarantees urb won't be recycled till both unlink()
1410 * and the urb's completion function return
1412 int usb_hcd_unlink_urb (struct urb *urb, int status)
1414 struct usb_hcd *hcd;
1415 int retval = -EIDRM;
1416 unsigned long flags;
1418 /* Prevent the device and bus from going away while
1419 * the unlink is carried out. If they are already gone
1420 * then urb->use_count must be 0, since disconnected
1421 * devices can't have any active URBs.
1423 spin_lock_irqsave(&hcd_urb_unlink_lock, flags);
1424 if (atomic_read(&urb->use_count) > 0) {
1426 usb_get_dev(urb->dev);
1428 spin_unlock_irqrestore(&hcd_urb_unlink_lock, flags);
1430 hcd = bus_to_hcd(urb->dev->bus);
1431 retval = unlink1(hcd, urb, status);
1432 usb_put_dev(urb->dev);
1436 retval = -EINPROGRESS;
1437 else if (retval != -EIDRM && retval != -EBUSY)
1438 dev_dbg(&urb->dev->dev, "hcd_unlink_urb %p fail %d\n",
1443 /*-------------------------------------------------------------------------*/
1446 * usb_hcd_giveback_urb - return URB from HCD to device driver
1447 * @hcd: host controller returning the URB
1448 * @urb: urb being returned to the USB device driver.
1449 * @status: completion status code for the URB.
1450 * Context: in_interrupt()
1452 * This hands the URB from HCD to its USB device driver, using its
1453 * completion function. The HCD has freed all per-urb resources
1454 * (and is done using urb->hcpriv). It also released all HCD locks;
1455 * the device driver won't cause problems if it frees, modifies,
1456 * or resubmits this URB.
1458 * If @urb was unlinked, the value of @status will be overridden by
1459 * @urb->unlinked. Erroneous short transfers are detected in case
1460 * the HCD hasn't checked for them.
1462 void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb, int status)
1465 if (unlikely(urb->unlinked))
1466 status = urb->unlinked;
1467 else if (unlikely((urb->transfer_flags & URB_SHORT_NOT_OK) &&
1468 urb->actual_length < urb->transfer_buffer_length &&
1470 status = -EREMOTEIO;
1472 unmap_urb_for_dma(hcd, urb);
1473 usbmon_urb_complete(&hcd->self, urb, status);
1474 usb_unanchor_urb(urb);
1476 /* pass ownership to the completion handler */
1477 urb->status = status;
1478 urb->complete (urb);
1479 atomic_dec (&urb->use_count);
1480 if (unlikely(atomic_read(&urb->reject)))
1481 wake_up (&usb_kill_urb_queue);
1484 EXPORT_SYMBOL_GPL(usb_hcd_giveback_urb);
1486 /*-------------------------------------------------------------------------*/
1488 /* Cancel all URBs pending on this endpoint and wait for the endpoint's
1489 * queue to drain completely. The caller must first insure that no more
1490 * URBs can be submitted for this endpoint.
1492 void usb_hcd_flush_endpoint(struct usb_device *udev,
1493 struct usb_host_endpoint *ep)
1495 struct usb_hcd *hcd;
1501 hcd = bus_to_hcd(udev->bus);
1503 /* No more submits can occur */
1504 spin_lock_irq(&hcd_urb_list_lock);
1506 list_for_each_entry (urb, &ep->urb_list, urb_list) {
1512 is_in = usb_urb_dir_in(urb);
1513 spin_unlock(&hcd_urb_list_lock);
1516 unlink1(hcd, urb, -ESHUTDOWN);
1517 dev_dbg (hcd->self.controller,
1518 "shutdown urb %p ep%d%s%s\n",
1519 urb, usb_endpoint_num(&ep->desc),
1520 is_in ? "in" : "out",
1523 switch (usb_endpoint_type(&ep->desc)) {
1524 case USB_ENDPOINT_XFER_CONTROL:
1526 case USB_ENDPOINT_XFER_BULK:
1528 case USB_ENDPOINT_XFER_INT:
1537 /* list contents may have changed */
1538 spin_lock(&hcd_urb_list_lock);
1541 spin_unlock_irq(&hcd_urb_list_lock);
1543 /* Wait until the endpoint queue is completely empty */
1544 while (!list_empty (&ep->urb_list)) {
1545 spin_lock_irq(&hcd_urb_list_lock);
1547 /* The list may have changed while we acquired the spinlock */
1549 if (!list_empty (&ep->urb_list)) {
1550 urb = list_entry (ep->urb_list.prev, struct urb,
1554 spin_unlock_irq(&hcd_urb_list_lock);
1563 /* Disables the endpoint: synchronizes with the hcd to make sure all
1564 * endpoint state is gone from hardware. usb_hcd_flush_endpoint() must
1565 * have been called previously. Use for set_configuration, set_interface,
1566 * driver removal, physical disconnect.
1568 * example: a qh stored in ep->hcpriv, holding state related to endpoint
1569 * type, maxpacket size, toggle, halt status, and scheduling.
1571 void usb_hcd_disable_endpoint(struct usb_device *udev,
1572 struct usb_host_endpoint *ep)
1574 struct usb_hcd *hcd;
1577 hcd = bus_to_hcd(udev->bus);
1578 if (hcd->driver->endpoint_disable)
1579 hcd->driver->endpoint_disable(hcd, ep);
1583 * usb_hcd_reset_endpoint - reset host endpoint state
1584 * @udev: USB device.
1585 * @ep: the endpoint to reset.
1587 * Resets any host endpoint state such as the toggle bit, sequence
1588 * number and current window.
1590 void usb_hcd_reset_endpoint(struct usb_device *udev,
1591 struct usb_host_endpoint *ep)
1593 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1595 if (hcd->driver->endpoint_reset)
1596 hcd->driver->endpoint_reset(hcd, ep);
1598 int epnum = usb_endpoint_num(&ep->desc);
1599 int is_out = usb_endpoint_dir_out(&ep->desc);
1600 int is_control = usb_endpoint_xfer_control(&ep->desc);
1602 usb_settoggle(udev, epnum, is_out, 0);
1604 usb_settoggle(udev, epnum, !is_out, 0);
1608 /* Protect against drivers that try to unlink URBs after the device
1609 * is gone, by waiting until all unlinks for @udev are finished.
1610 * Since we don't currently track URBs by device, simply wait until
1611 * nothing is running in the locked region of usb_hcd_unlink_urb().
1613 void usb_hcd_synchronize_unlinks(struct usb_device *udev)
1615 spin_lock_irq(&hcd_urb_unlink_lock);
1616 spin_unlock_irq(&hcd_urb_unlink_lock);
1619 /*-------------------------------------------------------------------------*/
1621 /* called in any context */
1622 int usb_hcd_get_frame_number (struct usb_device *udev)
1624 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1626 if (!HC_IS_RUNNING (hcd->state))
1628 return hcd->driver->get_frame_number (hcd);
1631 /*-------------------------------------------------------------------------*/
1635 int hcd_bus_suspend(struct usb_device *rhdev, pm_message_t msg)
1637 struct usb_hcd *hcd = container_of(rhdev->bus, struct usb_hcd, self);
1639 int old_state = hcd->state;
1641 dev_dbg(&rhdev->dev, "bus %s%s\n",
1642 (msg.event & PM_EVENT_AUTO ? "auto-" : ""), "suspend");
1643 if (!hcd->driver->bus_suspend) {
1646 hcd->state = HC_STATE_QUIESCING;
1647 status = hcd->driver->bus_suspend(hcd);
1650 usb_set_device_state(rhdev, USB_STATE_SUSPENDED);
1651 hcd->state = HC_STATE_SUSPENDED;
1653 hcd->state = old_state;
1654 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
1660 int hcd_bus_resume(struct usb_device *rhdev, pm_message_t msg)
1662 struct usb_hcd *hcd = container_of(rhdev->bus, struct usb_hcd, self);
1664 int old_state = hcd->state;
1666 dev_dbg(&rhdev->dev, "usb %s%s\n",
1667 (msg.event & PM_EVENT_AUTO ? "auto-" : ""), "resume");
1668 if (!hcd->driver->bus_resume)
1670 if (hcd->state == HC_STATE_RUNNING)
1673 hcd->state = HC_STATE_RESUMING;
1674 status = hcd->driver->bus_resume(hcd);
1676 /* TRSMRCY = 10 msec */
1678 usb_set_device_state(rhdev, rhdev->actconfig
1679 ? USB_STATE_CONFIGURED
1680 : USB_STATE_ADDRESS);
1681 hcd->state = HC_STATE_RUNNING;
1683 hcd->state = old_state;
1684 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
1686 if (status != -ESHUTDOWN)
1692 /* Workqueue routine for root-hub remote wakeup */
1693 static void hcd_resume_work(struct work_struct *work)
1695 struct usb_hcd *hcd = container_of(work, struct usb_hcd, wakeup_work);
1696 struct usb_device *udev = hcd->self.root_hub;
1698 usb_lock_device(udev);
1699 usb_mark_last_busy(udev);
1700 usb_external_resume_device(udev, PMSG_REMOTE_RESUME);
1701 usb_unlock_device(udev);
1705 * usb_hcd_resume_root_hub - called by HCD to resume its root hub
1706 * @hcd: host controller for this root hub
1708 * The USB host controller calls this function when its root hub is
1709 * suspended (with the remote wakeup feature enabled) and a remote
1710 * wakeup request is received. The routine submits a workqueue request
1711 * to resume the root hub (that is, manage its downstream ports again).
1713 void usb_hcd_resume_root_hub (struct usb_hcd *hcd)
1715 unsigned long flags;
1717 spin_lock_irqsave (&hcd_root_hub_lock, flags);
1718 if (hcd->rh_registered)
1719 queue_work(ksuspend_usb_wq, &hcd->wakeup_work);
1720 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
1722 EXPORT_SYMBOL_GPL(usb_hcd_resume_root_hub);
1726 /*-------------------------------------------------------------------------*/
1728 #ifdef CONFIG_USB_OTG
1731 * usb_bus_start_enum - start immediate enumeration (for OTG)
1732 * @bus: the bus (must use hcd framework)
1733 * @port_num: 1-based number of port; usually bus->otg_port
1734 * Context: in_interrupt()
1736 * Starts enumeration, with an immediate reset followed later by
1737 * khubd identifying and possibly configuring the device.
1738 * This is needed by OTG controller drivers, where it helps meet
1739 * HNP protocol timing requirements for starting a port reset.
1741 int usb_bus_start_enum(struct usb_bus *bus, unsigned port_num)
1743 struct usb_hcd *hcd;
1744 int status = -EOPNOTSUPP;
1746 /* NOTE: since HNP can't start by grabbing the bus's address0_sem,
1747 * boards with root hubs hooked up to internal devices (instead of
1748 * just the OTG port) may need more attention to resetting...
1750 hcd = container_of (bus, struct usb_hcd, self);
1751 if (port_num && hcd->driver->start_port_reset)
1752 status = hcd->driver->start_port_reset(hcd, port_num);
1754 /* run khubd shortly after (first) root port reset finishes;
1755 * it may issue others, until at least 50 msecs have passed.
1758 mod_timer(&hcd->rh_timer, jiffies + msecs_to_jiffies(10));
1761 EXPORT_SYMBOL_GPL(usb_bus_start_enum);
1765 /*-------------------------------------------------------------------------*/
1768 * usb_hcd_irq - hook IRQs to HCD framework (bus glue)
1769 * @irq: the IRQ being raised
1770 * @__hcd: pointer to the HCD whose IRQ is being signaled
1772 * If the controller isn't HALTed, calls the driver's irq handler.
1773 * Checks whether the controller is now dead.
1775 irqreturn_t usb_hcd_irq (int irq, void *__hcd)
1777 struct usb_hcd *hcd = __hcd;
1778 unsigned long flags;
1781 /* IRQF_DISABLED doesn't work correctly with shared IRQs
1782 * when the first handler doesn't use it. So let's just
1783 * assume it's never used.
1785 local_irq_save(flags);
1787 if (unlikely(hcd->state == HC_STATE_HALT ||
1788 !test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags))) {
1790 } else if (hcd->driver->irq(hcd) == IRQ_NONE) {
1793 set_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
1795 if (unlikely(hcd->state == HC_STATE_HALT))
1800 local_irq_restore(flags);
1804 /*-------------------------------------------------------------------------*/
1807 * usb_hc_died - report abnormal shutdown of a host controller (bus glue)
1808 * @hcd: pointer to the HCD representing the controller
1810 * This is called by bus glue to report a USB host controller that died
1811 * while operations may still have been pending. It's called automatically
1812 * by the PCI glue, so only glue for non-PCI busses should need to call it.
1814 void usb_hc_died (struct usb_hcd *hcd)
1816 unsigned long flags;
1818 dev_err (hcd->self.controller, "HC died; cleaning up\n");
1820 spin_lock_irqsave (&hcd_root_hub_lock, flags);
1821 if (hcd->rh_registered) {
1824 /* make khubd clean up old urbs and devices */
1825 usb_set_device_state (hcd->self.root_hub,
1826 USB_STATE_NOTATTACHED);
1827 usb_kick_khubd (hcd->self.root_hub);
1829 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
1831 EXPORT_SYMBOL_GPL (usb_hc_died);
1833 /*-------------------------------------------------------------------------*/
1836 * usb_create_hcd - create and initialize an HCD structure
1837 * @driver: HC driver that will use this hcd
1838 * @dev: device for this HC, stored in hcd->self.controller
1839 * @bus_name: value to store in hcd->self.bus_name
1840 * Context: !in_interrupt()
1842 * Allocate a struct usb_hcd, with extra space at the end for the
1843 * HC driver's private data. Initialize the generic members of the
1846 * If memory is unavailable, returns NULL.
1848 struct usb_hcd *usb_create_hcd (const struct hc_driver *driver,
1849 struct device *dev, const char *bus_name)
1851 struct usb_hcd *hcd;
1853 hcd = kzalloc(sizeof(*hcd) + driver->hcd_priv_size, GFP_KERNEL);
1855 dev_dbg (dev, "hcd alloc failed\n");
1858 dev_set_drvdata(dev, hcd);
1859 kref_init(&hcd->kref);
1861 usb_bus_init(&hcd->self);
1862 hcd->self.controller = dev;
1863 hcd->self.bus_name = bus_name;
1864 hcd->self.uses_dma = (dev->dma_mask != NULL);
1866 init_timer(&hcd->rh_timer);
1867 hcd->rh_timer.function = rh_timer_func;
1868 hcd->rh_timer.data = (unsigned long) hcd;
1870 INIT_WORK(&hcd->wakeup_work, hcd_resume_work);
1873 hcd->driver = driver;
1874 hcd->product_desc = (driver->product_desc) ? driver->product_desc :
1875 "USB Host Controller";
1878 EXPORT_SYMBOL_GPL(usb_create_hcd);
1880 static void hcd_release (struct kref *kref)
1882 struct usb_hcd *hcd = container_of (kref, struct usb_hcd, kref);
1887 struct usb_hcd *usb_get_hcd (struct usb_hcd *hcd)
1890 kref_get (&hcd->kref);
1893 EXPORT_SYMBOL_GPL(usb_get_hcd);
1895 void usb_put_hcd (struct usb_hcd *hcd)
1898 kref_put (&hcd->kref, hcd_release);
1900 EXPORT_SYMBOL_GPL(usb_put_hcd);
1903 * usb_add_hcd - finish generic HCD structure initialization and register
1904 * @hcd: the usb_hcd structure to initialize
1905 * @irqnum: Interrupt line to allocate
1906 * @irqflags: Interrupt type flags
1908 * Finish the remaining parts of generic HCD initialization: allocate the
1909 * buffers of consistent memory, register the bus, request the IRQ line,
1910 * and call the driver's reset() and start() routines.
1912 int usb_add_hcd(struct usb_hcd *hcd,
1913 unsigned int irqnum, unsigned long irqflags)
1916 struct usb_device *rhdev;
1918 dev_info(hcd->self.controller, "%s\n", hcd->product_desc);
1920 hcd->authorized_default = hcd->wireless? 0 : 1;
1921 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1923 /* HC is in reset state, but accessible. Now do the one-time init,
1924 * bottom up so that hcds can customize the root hubs before khubd
1925 * starts talking to them. (Note, bus id is assigned early too.)
1927 if ((retval = hcd_buffer_create(hcd)) != 0) {
1928 dev_dbg(hcd->self.controller, "pool alloc failed\n");
1932 if ((retval = usb_register_bus(&hcd->self)) < 0)
1933 goto err_register_bus;
1935 if ((rhdev = usb_alloc_dev(NULL, &hcd->self, 0)) == NULL) {
1936 dev_err(hcd->self.controller, "unable to allocate root hub\n");
1938 goto err_allocate_root_hub;
1941 switch (hcd->driver->flags & HCD_MASK) {
1943 rhdev->speed = USB_SPEED_FULL;
1946 rhdev->speed = USB_SPEED_HIGH;
1949 rhdev->speed = USB_SPEED_SUPER;
1952 goto err_allocate_root_hub;
1954 hcd->self.root_hub = rhdev;
1956 /* wakeup flag init defaults to "everything works" for root hubs,
1957 * but drivers can override it in reset() if needed, along with
1958 * recording the overall controller's system wakeup capability.
1960 device_init_wakeup(&rhdev->dev, 1);
1962 /* "reset" is misnamed; its role is now one-time init. the controller
1963 * should already have been reset (and boot firmware kicked off etc).
1965 if (hcd->driver->reset && (retval = hcd->driver->reset(hcd)) < 0) {
1966 dev_err(hcd->self.controller, "can't setup\n");
1967 goto err_hcd_driver_setup;
1970 /* NOTE: root hub and controller capabilities may not be the same */
1971 if (device_can_wakeup(hcd->self.controller)
1972 && device_can_wakeup(&hcd->self.root_hub->dev))
1973 dev_dbg(hcd->self.controller, "supports USB remote wakeup\n");
1975 /* enable irqs just before we start the controller */
1976 if (hcd->driver->irq) {
1978 /* IRQF_DISABLED doesn't work as advertised when used together
1979 * with IRQF_SHARED. As usb_hcd_irq() will always disable
1980 * interrupts we can remove it here.
1982 if (irqflags & IRQF_SHARED)
1983 irqflags &= ~IRQF_DISABLED;
1985 snprintf(hcd->irq_descr, sizeof(hcd->irq_descr), "%s:usb%d",
1986 hcd->driver->description, hcd->self.busnum);
1987 if ((retval = request_irq(irqnum, &usb_hcd_irq, irqflags,
1988 hcd->irq_descr, hcd)) != 0) {
1989 dev_err(hcd->self.controller,
1990 "request interrupt %d failed\n", irqnum);
1991 goto err_request_irq;
1994 dev_info(hcd->self.controller, "irq %d, %s 0x%08llx\n", irqnum,
1995 (hcd->driver->flags & HCD_MEMORY) ?
1996 "io mem" : "io base",
1997 (unsigned long long)hcd->rsrc_start);
2000 if (hcd->rsrc_start)
2001 dev_info(hcd->self.controller, "%s 0x%08llx\n",
2002 (hcd->driver->flags & HCD_MEMORY) ?
2003 "io mem" : "io base",
2004 (unsigned long long)hcd->rsrc_start);
2007 if ((retval = hcd->driver->start(hcd)) < 0) {
2008 dev_err(hcd->self.controller, "startup error %d\n", retval);
2009 goto err_hcd_driver_start;
2012 /* starting here, usbcore will pay attention to this root hub */
2013 rhdev->bus_mA = min(500u, hcd->power_budget);
2014 if ((retval = register_root_hub(hcd)) != 0)
2015 goto err_register_root_hub;
2017 retval = sysfs_create_group(&rhdev->dev.kobj, &usb_bus_attr_group);
2019 printk(KERN_ERR "Cannot register USB bus sysfs attributes: %d\n",
2021 goto error_create_attr_group;
2023 if (hcd->uses_new_polling && hcd->poll_rh)
2024 usb_hcd_poll_rh_status(hcd);
2027 error_create_attr_group:
2028 mutex_lock(&usb_bus_list_lock);
2029 usb_disconnect(&hcd->self.root_hub);
2030 mutex_unlock(&usb_bus_list_lock);
2031 err_register_root_hub:
2032 hcd->driver->stop(hcd);
2033 err_hcd_driver_start:
2035 free_irq(irqnum, hcd);
2037 err_hcd_driver_setup:
2038 hcd->self.root_hub = NULL;
2040 err_allocate_root_hub:
2041 usb_deregister_bus(&hcd->self);
2043 hcd_buffer_destroy(hcd);
2046 EXPORT_SYMBOL_GPL(usb_add_hcd);
2049 * usb_remove_hcd - shutdown processing for generic HCDs
2050 * @hcd: the usb_hcd structure to remove
2051 * Context: !in_interrupt()
2053 * Disconnects the root hub, then reverses the effects of usb_add_hcd(),
2054 * invoking the HCD's stop() method.
2056 void usb_remove_hcd(struct usb_hcd *hcd)
2058 dev_info(hcd->self.controller, "remove, state %x\n", hcd->state);
2060 if (HC_IS_RUNNING (hcd->state))
2061 hcd->state = HC_STATE_QUIESCING;
2063 dev_dbg(hcd->self.controller, "roothub graceful disconnect\n");
2064 spin_lock_irq (&hcd_root_hub_lock);
2065 hcd->rh_registered = 0;
2066 spin_unlock_irq (&hcd_root_hub_lock);
2069 cancel_work_sync(&hcd->wakeup_work);
2072 sysfs_remove_group(&hcd->self.root_hub->dev.kobj, &usb_bus_attr_group);
2073 mutex_lock(&usb_bus_list_lock);
2074 usb_disconnect(&hcd->self.root_hub);
2075 mutex_unlock(&usb_bus_list_lock);
2077 hcd->driver->stop(hcd);
2078 hcd->state = HC_STATE_HALT;
2081 del_timer_sync(&hcd->rh_timer);
2084 free_irq(hcd->irq, hcd);
2085 usb_deregister_bus(&hcd->self);
2086 hcd_buffer_destroy(hcd);
2088 EXPORT_SYMBOL_GPL(usb_remove_hcd);
2091 usb_hcd_platform_shutdown(struct platform_device* dev)
2093 struct usb_hcd *hcd = platform_get_drvdata(dev);
2095 if (hcd->driver->shutdown)
2096 hcd->driver->shutdown(hcd);
2098 EXPORT_SYMBOL_GPL(usb_hcd_platform_shutdown);
2100 /*-------------------------------------------------------------------------*/
2102 #if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
2104 struct usb_mon_operations *mon_ops;
2107 * The registration is unlocked.
2108 * We do it this way because we do not want to lock in hot paths.
2110 * Notice that the code is minimally error-proof. Because usbmon needs
2111 * symbols from usbcore, usbcore gets referenced and cannot be unloaded first.
2114 int usb_mon_register (struct usb_mon_operations *ops)
2124 EXPORT_SYMBOL_GPL (usb_mon_register);
2126 void usb_mon_deregister (void)
2129 if (mon_ops == NULL) {
2130 printk(KERN_ERR "USB: monitor was not registered\n");
2136 EXPORT_SYMBOL_GPL (usb_mon_deregister);
2138 #endif /* CONFIG_USB_MON || CONFIG_USB_MON_MODULE */