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/bcd.h>
26 #include <linux/module.h>
27 #include <linux/version.h>
28 #include <linux/kernel.h>
29 #include <linux/slab.h>
30 #include <linux/completion.h>
31 #include <linux/utsname.h>
34 #include <linux/device.h>
35 #include <linux/dma-mapping.h>
36 #include <linux/mutex.h>
38 #include <asm/byteorder.h>
39 #include <asm/unaligned.h>
40 #include <linux/platform_device.h>
41 #include <linux/workqueue.h>
42 #include <linux/pm_runtime.h>
44 #include <linux/usb.h>
45 #include <linux/usb/hcd.h>
50 /*-------------------------------------------------------------------------*/
53 * USB Host Controller Driver framework
55 * Plugs into usbcore (usb_bus) and lets HCDs share code, minimizing
56 * HCD-specific behaviors/bugs.
58 * This does error checks, tracks devices and urbs, and delegates to a
59 * "hc_driver" only for code (and data) that really needs to know about
60 * hardware differences. That includes root hub registers, i/o queues,
61 * and so on ... but as little else as possible.
63 * Shared code includes most of the "root hub" code (these are emulated,
64 * though each HC's hardware works differently) and PCI glue, plus request
65 * tracking overhead. The HCD code should only block on spinlocks or on
66 * hardware handshaking; blocking on software events (such as other kernel
67 * threads releasing resources, or completing actions) is all generic.
69 * Happens the USB 2.0 spec says this would be invisible inside the "USBD",
70 * and includes mostly a "HCDI" (HCD Interface) along with some APIs used
71 * only by the hub driver ... and that neither should be seen or used by
72 * usb client device drivers.
74 * Contributors of ideas or unattributed patches include: David Brownell,
75 * Roman Weissgaerber, Rory Bolt, Greg Kroah-Hartman, ...
78 * 2002-02-21 Pull in most of the usb_bus support from usb.c; some
79 * associated cleanup. "usb_hcd" still != "usb_bus".
80 * 2001-12-12 Initial patch version for Linux 2.5.1 kernel.
83 /*-------------------------------------------------------------------------*/
85 /* Keep track of which host controller drivers are loaded */
86 unsigned long usb_hcds_loaded;
87 EXPORT_SYMBOL_GPL(usb_hcds_loaded);
89 /* host controllers we manage */
90 LIST_HEAD (usb_bus_list);
91 EXPORT_SYMBOL_GPL (usb_bus_list);
93 /* used when allocating bus numbers */
96 unsigned long busmap [USB_MAXBUS / (8*sizeof (unsigned long))];
98 static struct usb_busmap busmap;
100 /* used when updating list of hcds */
101 DEFINE_MUTEX(usb_bus_list_lock); /* exported only for usbfs */
102 EXPORT_SYMBOL_GPL (usb_bus_list_lock);
104 /* used for controlling access to virtual root hubs */
105 static DEFINE_SPINLOCK(hcd_root_hub_lock);
107 /* used when updating an endpoint's URB list */
108 static DEFINE_SPINLOCK(hcd_urb_list_lock);
110 /* used to protect against unlinking URBs after the device is gone */
111 static DEFINE_SPINLOCK(hcd_urb_unlink_lock);
113 /* wait queue for synchronous unlinks */
114 DECLARE_WAIT_QUEUE_HEAD(usb_kill_urb_queue);
116 static inline int is_root_hub(struct usb_device *udev)
118 return (udev->parent == NULL);
121 /*-------------------------------------------------------------------------*/
124 * Sharable chunks of root hub code.
127 /*-------------------------------------------------------------------------*/
128 #define KERNEL_REL bin2bcd(((LINUX_VERSION_CODE >> 16) & 0x0ff))
129 #define KERNEL_VER bin2bcd(((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 0x1d6b */
143 0x03, 0x00, /* __le16 idProduct; device 0x0003 */
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 0x1d6b */
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 0x1d6b */
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 0x1f, 0x00, /* __le16 wTotalLength; */
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 /* one SuperSpeed endpoint companion descriptor */
334 0x06, /* __u8 ss_bLength */
335 0x30, /* __u8 ss_bDescriptorType; SuperSpeed EP Companion */
336 0x00, /* __u8 ss_bMaxBurst; allows 1 TX between ACKs */
337 0x00, /* __u8 ss_bmAttributes; 1 packet per service interval */
338 0x02, 0x00 /* __le16 ss_wBytesPerInterval; 15 bits for max 15 ports */
341 /* authorized_default behaviour:
342 * -1 is authorized for all devices except wireless (old behaviour)
343 * 0 is unauthorized for all devices
344 * 1 is authorized for all devices
346 static int authorized_default = -1;
347 module_param(authorized_default, int, S_IRUGO|S_IWUSR);
348 MODULE_PARM_DESC(authorized_default,
349 "Default USB device authorization: 0 is not authorized, 1 is "
350 "authorized, -1 is authorized except for wireless USB (default, "
352 /*-------------------------------------------------------------------------*/
355 * ascii2desc() - Helper routine for producing UTF-16LE string descriptors
356 * @s: Null-terminated ASCII (actually ISO-8859-1) string
357 * @buf: Buffer for USB string descriptor (header + UTF-16LE)
358 * @len: Length (in bytes; may be odd) of descriptor buffer.
360 * The return value is the number of bytes filled in: 2 + 2*strlen(s) or
361 * buflen, whichever is less.
363 * USB String descriptors can contain at most 126 characters; input
364 * strings longer than that are truncated.
367 ascii2desc(char const *s, u8 *buf, unsigned len)
369 unsigned n, t = 2 + 2*strlen(s);
372 t = 254; /* Longest possible UTF string descriptor */
376 t += USB_DT_STRING << 8; /* Now t is first 16 bits to store */
384 t = (unsigned char)*s++;
390 * rh_string() - provides string descriptors for root hub
391 * @id: the string ID number (0: langids, 1: serial #, 2: product, 3: vendor)
392 * @hcd: the host controller for this root hub
393 * @data: buffer for output packet
394 * @len: length of the provided buffer
396 * Produces either a manufacturer, product or serial number string for the
397 * virtual root hub device.
398 * Returns the number of bytes filled in: the length of the descriptor or
399 * of the provided buffer, whichever is less.
402 rh_string(int id, struct usb_hcd const *hcd, u8 *data, unsigned len)
406 static char const langids[4] = {4, USB_DT_STRING, 0x09, 0x04};
411 /* Array of LANGID codes (0x0409 is MSFT-speak for "en-us") */
412 /* See http://www.usb.org/developers/docs/USB_LANGIDs.pdf */
415 memcpy(data, langids, len);
419 s = hcd->self.bus_name;
423 s = hcd->product_desc;
427 snprintf (buf, sizeof buf, "%s %s %s", init_utsname()->sysname,
428 init_utsname()->release, hcd->driver->description);
432 /* Can't happen; caller guarantees it */
436 return ascii2desc(s, data, len);
440 /* Root hub control transfers execute synchronously */
441 static int rh_call_control (struct usb_hcd *hcd, struct urb *urb)
443 struct usb_ctrlrequest *cmd;
444 u16 typeReq, wValue, wIndex, wLength;
445 u8 *ubuf = urb->transfer_buffer;
447 * tbuf should be as big as the BOS descriptor and
448 * the USB hub descriptor.
450 u8 tbuf[USB_DT_BOS_SIZE + USB_DT_USB_SS_CAP_SIZE]
451 __attribute__((aligned(4)));
452 const u8 *bufp = tbuf;
456 u8 patch_protocol = 0;
460 spin_lock_irq(&hcd_root_hub_lock);
461 status = usb_hcd_link_urb_to_ep(hcd, urb);
462 spin_unlock_irq(&hcd_root_hub_lock);
465 urb->hcpriv = hcd; /* Indicate it's queued */
467 cmd = (struct usb_ctrlrequest *) urb->setup_packet;
468 typeReq = (cmd->bRequestType << 8) | cmd->bRequest;
469 wValue = le16_to_cpu (cmd->wValue);
470 wIndex = le16_to_cpu (cmd->wIndex);
471 wLength = le16_to_cpu (cmd->wLength);
473 if (wLength > urb->transfer_buffer_length)
476 urb->actual_length = 0;
479 /* DEVICE REQUESTS */
481 /* The root hub's remote wakeup enable bit is implemented using
482 * driver model wakeup flags. If this system supports wakeup
483 * through USB, userspace may change the default "allow wakeup"
484 * policy through sysfs or these calls.
486 * Most root hubs support wakeup from downstream devices, for
487 * runtime power management (disabling USB clocks and reducing
488 * VBUS power usage). However, not all of them do so; silicon,
489 * board, and BIOS bugs here are not uncommon, so these can't
490 * be treated quite like external hubs.
492 * Likewise, not all root hubs will pass wakeup events upstream,
493 * to wake up the whole system. So don't assume root hub and
494 * controller capabilities are identical.
497 case DeviceRequest | USB_REQ_GET_STATUS:
498 tbuf [0] = (device_may_wakeup(&hcd->self.root_hub->dev)
499 << USB_DEVICE_REMOTE_WAKEUP)
500 | (1 << USB_DEVICE_SELF_POWERED);
504 case DeviceOutRequest | USB_REQ_CLEAR_FEATURE:
505 if (wValue == USB_DEVICE_REMOTE_WAKEUP)
506 device_set_wakeup_enable(&hcd->self.root_hub->dev, 0);
510 case DeviceOutRequest | USB_REQ_SET_FEATURE:
511 if (device_can_wakeup(&hcd->self.root_hub->dev)
512 && wValue == USB_DEVICE_REMOTE_WAKEUP)
513 device_set_wakeup_enable(&hcd->self.root_hub->dev, 1);
517 case DeviceRequest | USB_REQ_GET_CONFIGURATION:
521 case DeviceOutRequest | USB_REQ_SET_CONFIGURATION:
523 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
524 switch (wValue & 0xff00) {
525 case USB_DT_DEVICE << 8:
526 switch (hcd->speed) {
528 bufp = usb3_rh_dev_descriptor;
531 bufp = usb2_rh_dev_descriptor;
534 bufp = usb11_rh_dev_descriptor;
543 case USB_DT_CONFIG << 8:
544 switch (hcd->speed) {
546 bufp = ss_rh_config_descriptor;
547 len = sizeof ss_rh_config_descriptor;
550 bufp = hs_rh_config_descriptor;
551 len = sizeof hs_rh_config_descriptor;
554 bufp = fs_rh_config_descriptor;
555 len = sizeof fs_rh_config_descriptor;
560 if (device_can_wakeup(&hcd->self.root_hub->dev))
563 case USB_DT_STRING << 8:
564 if ((wValue & 0xff) < 4)
565 urb->actual_length = rh_string(wValue & 0xff,
567 else /* unsupported IDs --> "protocol stall" */
570 case USB_DT_BOS << 8:
576 case DeviceRequest | USB_REQ_GET_INTERFACE:
580 case DeviceOutRequest | USB_REQ_SET_INTERFACE:
582 case DeviceOutRequest | USB_REQ_SET_ADDRESS:
583 // wValue == urb->dev->devaddr
584 dev_dbg (hcd->self.controller, "root hub device address %d\n",
588 /* INTERFACE REQUESTS (no defined feature/status flags) */
590 /* ENDPOINT REQUESTS */
592 case EndpointRequest | USB_REQ_GET_STATUS:
593 // ENDPOINT_HALT flag
598 case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
599 case EndpointOutRequest | USB_REQ_SET_FEATURE:
600 dev_dbg (hcd->self.controller, "no endpoint features yet\n");
603 /* CLASS REQUESTS (and errors) */
607 /* non-generic request */
613 case GetHubDescriptor:
614 len = sizeof (struct usb_hub_descriptor);
616 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
617 /* len is returned by hub_control */
620 status = hcd->driver->hub_control (hcd,
621 typeReq, wValue, wIndex,
625 /* "protocol stall" on error */
631 if (status != -EPIPE) {
632 dev_dbg (hcd->self.controller,
633 "CTRL: TypeReq=0x%x val=0x%x "
634 "idx=0x%x len=%d ==> %d\n",
635 typeReq, wValue, wIndex,
638 } else if (status > 0) {
639 /* hub_control may return the length of data copied. */
644 if (urb->transfer_buffer_length < len)
645 len = urb->transfer_buffer_length;
646 urb->actual_length = len;
647 // always USB_DIR_IN, toward host
648 memcpy (ubuf, bufp, len);
650 /* report whether RH hardware supports remote wakeup */
652 len > offsetof (struct usb_config_descriptor,
654 ((struct usb_config_descriptor *)ubuf)->bmAttributes
655 |= USB_CONFIG_ATT_WAKEUP;
657 /* report whether RH hardware has an integrated TT */
658 if (patch_protocol &&
659 len > offsetof(struct usb_device_descriptor,
661 ((struct usb_device_descriptor *) ubuf)->
662 bDeviceProtocol = USB_HUB_PR_HS_SINGLE_TT;
665 /* any errors get returned through the urb completion */
666 spin_lock_irq(&hcd_root_hub_lock);
667 usb_hcd_unlink_urb_from_ep(hcd, urb);
669 /* This peculiar use of spinlocks echoes what real HC drivers do.
670 * Avoiding calls to local_irq_disable/enable makes the code
673 spin_unlock(&hcd_root_hub_lock);
674 usb_hcd_giveback_urb(hcd, urb, status);
675 spin_lock(&hcd_root_hub_lock);
677 spin_unlock_irq(&hcd_root_hub_lock);
681 /*-------------------------------------------------------------------------*/
684 * Root Hub interrupt transfers are polled using a timer if the
685 * driver requests it; otherwise the driver is responsible for
686 * calling usb_hcd_poll_rh_status() when an event occurs.
688 * Completions are called in_interrupt(), but they may or may not
691 void usb_hcd_poll_rh_status(struct usb_hcd *hcd)
696 char buffer[6]; /* Any root hubs with > 31 ports? */
698 if (unlikely(!hcd->rh_pollable))
700 if (!hcd->uses_new_polling && !hcd->status_urb)
703 length = hcd->driver->hub_status_data(hcd, buffer);
706 /* try to complete the status urb */
707 spin_lock_irqsave(&hcd_root_hub_lock, flags);
708 urb = hcd->status_urb;
710 clear_bit(HCD_FLAG_POLL_PENDING, &hcd->flags);
711 hcd->status_urb = NULL;
712 urb->actual_length = length;
713 memcpy(urb->transfer_buffer, buffer, length);
715 usb_hcd_unlink_urb_from_ep(hcd, urb);
716 spin_unlock(&hcd_root_hub_lock);
717 usb_hcd_giveback_urb(hcd, urb, 0);
718 spin_lock(&hcd_root_hub_lock);
721 set_bit(HCD_FLAG_POLL_PENDING, &hcd->flags);
723 spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
726 /* The USB 2.0 spec says 256 ms. This is close enough and won't
727 * exceed that limit if HZ is 100. The math is more clunky than
728 * maybe expected, this is to make sure that all timers for USB devices
729 * fire at the same time to give the CPU a break in between */
730 if (hcd->uses_new_polling ? HCD_POLL_RH(hcd) :
731 (length == 0 && hcd->status_urb != NULL))
732 mod_timer (&hcd->rh_timer, (jiffies/(HZ/4) + 1) * (HZ/4));
734 EXPORT_SYMBOL_GPL(usb_hcd_poll_rh_status);
737 static void rh_timer_func (unsigned long _hcd)
739 usb_hcd_poll_rh_status((struct usb_hcd *) _hcd);
742 /*-------------------------------------------------------------------------*/
744 static int rh_queue_status (struct usb_hcd *hcd, struct urb *urb)
748 unsigned len = 1 + (urb->dev->maxchild / 8);
750 spin_lock_irqsave (&hcd_root_hub_lock, flags);
751 if (hcd->status_urb || urb->transfer_buffer_length < len) {
752 dev_dbg (hcd->self.controller, "not queuing rh status urb\n");
757 retval = usb_hcd_link_urb_to_ep(hcd, urb);
761 hcd->status_urb = urb;
762 urb->hcpriv = hcd; /* indicate it's queued */
763 if (!hcd->uses_new_polling)
764 mod_timer(&hcd->rh_timer, (jiffies/(HZ/4) + 1) * (HZ/4));
766 /* If a status change has already occurred, report it ASAP */
767 else if (HCD_POLL_PENDING(hcd))
768 mod_timer(&hcd->rh_timer, jiffies);
771 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
775 static int rh_urb_enqueue (struct usb_hcd *hcd, struct urb *urb)
777 if (usb_endpoint_xfer_int(&urb->ep->desc))
778 return rh_queue_status (hcd, urb);
779 if (usb_endpoint_xfer_control(&urb->ep->desc))
780 return rh_call_control (hcd, urb);
784 /*-------------------------------------------------------------------------*/
786 /* Unlinks of root-hub control URBs are legal, but they don't do anything
787 * since these URBs always execute synchronously.
789 static int usb_rh_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
794 spin_lock_irqsave(&hcd_root_hub_lock, flags);
795 rc = usb_hcd_check_unlink_urb(hcd, urb, status);
799 if (usb_endpoint_num(&urb->ep->desc) == 0) { /* Control URB */
802 } else { /* Status URB */
803 if (!hcd->uses_new_polling)
804 del_timer (&hcd->rh_timer);
805 if (urb == hcd->status_urb) {
806 hcd->status_urb = NULL;
807 usb_hcd_unlink_urb_from_ep(hcd, urb);
809 spin_unlock(&hcd_root_hub_lock);
810 usb_hcd_giveback_urb(hcd, urb, status);
811 spin_lock(&hcd_root_hub_lock);
815 spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
822 * Show & store the current value of authorized_default
824 static ssize_t usb_host_authorized_default_show(struct device *dev,
825 struct device_attribute *attr,
828 struct usb_device *rh_usb_dev = to_usb_device(dev);
829 struct usb_bus *usb_bus = rh_usb_dev->bus;
830 struct usb_hcd *usb_hcd;
832 if (usb_bus == NULL) /* FIXME: not sure if this case is possible */
834 usb_hcd = bus_to_hcd(usb_bus);
835 return snprintf(buf, PAGE_SIZE, "%u\n", usb_hcd->authorized_default);
838 static ssize_t usb_host_authorized_default_store(struct device *dev,
839 struct device_attribute *attr,
840 const char *buf, size_t size)
844 struct usb_device *rh_usb_dev = to_usb_device(dev);
845 struct usb_bus *usb_bus = rh_usb_dev->bus;
846 struct usb_hcd *usb_hcd;
848 if (usb_bus == NULL) /* FIXME: not sure if this case is possible */
850 usb_hcd = bus_to_hcd(usb_bus);
851 result = sscanf(buf, "%u\n", &val);
853 usb_hcd->authorized_default = val? 1 : 0;
861 static DEVICE_ATTR(authorized_default, 0644,
862 usb_host_authorized_default_show,
863 usb_host_authorized_default_store);
866 /* Group all the USB bus attributes */
867 static struct attribute *usb_bus_attrs[] = {
868 &dev_attr_authorized_default.attr,
872 static struct attribute_group usb_bus_attr_group = {
873 .name = NULL, /* we want them in the same directory */
874 .attrs = usb_bus_attrs,
879 /*-------------------------------------------------------------------------*/
882 * usb_bus_init - shared initialization code
883 * @bus: the bus structure being initialized
885 * This code is used to initialize a usb_bus structure, memory for which is
886 * separately managed.
888 static void usb_bus_init (struct usb_bus *bus)
890 memset (&bus->devmap, 0, sizeof(struct usb_devmap));
892 bus->devnum_next = 1;
894 bus->root_hub = NULL;
896 bus->bandwidth_allocated = 0;
897 bus->bandwidth_int_reqs = 0;
898 bus->bandwidth_isoc_reqs = 0;
900 INIT_LIST_HEAD (&bus->bus_list);
903 /*-------------------------------------------------------------------------*/
906 * usb_register_bus - registers the USB host controller with the usb core
907 * @bus: pointer to the bus to register
908 * Context: !in_interrupt()
910 * Assigns a bus number, and links the controller into usbcore data
911 * structures so that it can be seen by scanning the bus list.
913 static int usb_register_bus(struct usb_bus *bus)
918 mutex_lock(&usb_bus_list_lock);
919 busnum = find_next_zero_bit (busmap.busmap, USB_MAXBUS, 1);
920 if (busnum >= USB_MAXBUS) {
921 printk (KERN_ERR "%s: too many buses\n", usbcore_name);
922 goto error_find_busnum;
924 set_bit (busnum, busmap.busmap);
925 bus->busnum = busnum;
927 /* Add it to the local list of buses */
928 list_add (&bus->bus_list, &usb_bus_list);
929 mutex_unlock(&usb_bus_list_lock);
931 usb_notify_add_bus(bus);
933 dev_info (bus->controller, "new USB bus registered, assigned bus "
934 "number %d\n", bus->busnum);
938 mutex_unlock(&usb_bus_list_lock);
943 * usb_deregister_bus - deregisters the USB host controller
944 * @bus: pointer to the bus to deregister
945 * Context: !in_interrupt()
947 * Recycles the bus number, and unlinks the controller from usbcore data
948 * structures so that it won't be seen by scanning the bus list.
950 static void usb_deregister_bus (struct usb_bus *bus)
952 dev_info (bus->controller, "USB bus %d deregistered\n", bus->busnum);
955 * NOTE: make sure that all the devices are removed by the
956 * controller code, as well as having it call this when cleaning
959 mutex_lock(&usb_bus_list_lock);
960 list_del (&bus->bus_list);
961 mutex_unlock(&usb_bus_list_lock);
963 usb_notify_remove_bus(bus);
965 clear_bit (bus->busnum, busmap.busmap);
969 * register_root_hub - called by usb_add_hcd() to register a root hub
970 * @hcd: host controller for this root hub
972 * This function registers the root hub with the USB subsystem. It sets up
973 * the device properly in the device tree and then calls usb_new_device()
974 * to register the usb device. It also assigns the root hub's USB address
977 static int register_root_hub(struct usb_hcd *hcd)
979 struct device *parent_dev = hcd->self.controller;
980 struct usb_device *usb_dev = hcd->self.root_hub;
981 const int devnum = 1;
984 usb_dev->devnum = devnum;
985 usb_dev->bus->devnum_next = devnum + 1;
986 memset (&usb_dev->bus->devmap.devicemap, 0,
987 sizeof usb_dev->bus->devmap.devicemap);
988 set_bit (devnum, usb_dev->bus->devmap.devicemap);
989 usb_set_device_state(usb_dev, USB_STATE_ADDRESS);
991 mutex_lock(&usb_bus_list_lock);
993 usb_dev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
994 retval = usb_get_device_descriptor(usb_dev, USB_DT_DEVICE_SIZE);
995 if (retval != sizeof usb_dev->descriptor) {
996 mutex_unlock(&usb_bus_list_lock);
997 dev_dbg (parent_dev, "can't read %s device descriptor %d\n",
998 dev_name(&usb_dev->dev), retval);
999 return (retval < 0) ? retval : -EMSGSIZE;
1001 if (usb_dev->speed == USB_SPEED_SUPER) {
1002 retval = usb_get_bos_descriptor(usb_dev);
1004 mutex_unlock(&usb_bus_list_lock);
1005 dev_dbg(parent_dev, "can't read %s bos descriptor %d\n",
1006 dev_name(&usb_dev->dev), retval);
1011 retval = usb_new_device (usb_dev);
1013 dev_err (parent_dev, "can't register root hub for %s, %d\n",
1014 dev_name(&usb_dev->dev), retval);
1016 spin_lock_irq (&hcd_root_hub_lock);
1017 hcd->rh_registered = 1;
1018 spin_unlock_irq (&hcd_root_hub_lock);
1020 /* Did the HC die before the root hub was registered? */
1022 usb_hc_died (hcd); /* This time clean up */
1024 mutex_unlock(&usb_bus_list_lock);
1030 * usb_hcd_start_port_resume - a root-hub port is sending a resume signal
1031 * @bus: the bus which the root hub belongs to
1032 * @portnum: the port which is being resumed
1034 * HCDs should call this function when they know that a resume signal is
1035 * being sent to a root-hub port. The root hub will be prevented from
1036 * going into autosuspend until usb_hcd_end_port_resume() is called.
1038 * The bus's private lock must be held by the caller.
1040 void usb_hcd_start_port_resume(struct usb_bus *bus, int portnum)
1042 unsigned bit = 1 << portnum;
1044 if (!(bus->resuming_ports & bit)) {
1045 bus->resuming_ports |= bit;
1046 pm_runtime_get_noresume(&bus->root_hub->dev);
1049 EXPORT_SYMBOL_GPL(usb_hcd_start_port_resume);
1052 * usb_hcd_end_port_resume - a root-hub port has stopped sending a resume signal
1053 * @bus: the bus which the root hub belongs to
1054 * @portnum: the port which is being resumed
1056 * HCDs should call this function when they know that a resume signal has
1057 * stopped being sent to a root-hub port. The root hub will be allowed to
1058 * autosuspend again.
1060 * The bus's private lock must be held by the caller.
1062 void usb_hcd_end_port_resume(struct usb_bus *bus, int portnum)
1064 unsigned bit = 1 << portnum;
1066 if (bus->resuming_ports & bit) {
1067 bus->resuming_ports &= ~bit;
1068 pm_runtime_put_noidle(&bus->root_hub->dev);
1071 EXPORT_SYMBOL_GPL(usb_hcd_end_port_resume);
1073 /*-------------------------------------------------------------------------*/
1076 * usb_calc_bus_time - approximate periodic transaction time in nanoseconds
1077 * @speed: from dev->speed; USB_SPEED_{LOW,FULL,HIGH}
1078 * @is_input: true iff the transaction sends data to the host
1079 * @isoc: true for isochronous transactions, false for interrupt ones
1080 * @bytecount: how many bytes in the transaction.
1082 * Returns approximate bus time in nanoseconds for a periodic transaction.
1083 * See USB 2.0 spec section 5.11.3; only periodic transfers need to be
1084 * scheduled in software, this function is only used for such scheduling.
1086 long usb_calc_bus_time (int speed, int is_input, int isoc, int bytecount)
1091 case USB_SPEED_LOW: /* INTR only */
1093 tmp = (67667L * (31L + 10L * BitTime (bytecount))) / 1000L;
1094 return (64060L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp);
1096 tmp = (66700L * (31L + 10L * BitTime (bytecount))) / 1000L;
1097 return (64107L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp);
1099 case USB_SPEED_FULL: /* ISOC or INTR */
1101 tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
1102 return (((is_input) ? 7268L : 6265L) + BW_HOST_DELAY + tmp);
1104 tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
1105 return (9107L + BW_HOST_DELAY + tmp);
1107 case USB_SPEED_HIGH: /* ISOC or INTR */
1108 // FIXME adjust for input vs output
1110 tmp = HS_NSECS_ISO (bytecount);
1112 tmp = HS_NSECS (bytecount);
1115 pr_debug ("%s: bogus device speed!\n", usbcore_name);
1119 EXPORT_SYMBOL_GPL(usb_calc_bus_time);
1122 /*-------------------------------------------------------------------------*/
1125 * Generic HC operations.
1128 /*-------------------------------------------------------------------------*/
1131 * usb_hcd_link_urb_to_ep - add an URB to its endpoint queue
1132 * @hcd: host controller to which @urb was submitted
1133 * @urb: URB being submitted
1135 * Host controller drivers should call this routine in their enqueue()
1136 * method. The HCD's private spinlock must be held and interrupts must
1137 * be disabled. The actions carried out here are required for URB
1138 * submission, as well as for endpoint shutdown and for usb_kill_urb.
1140 * Returns 0 for no error, otherwise a negative error code (in which case
1141 * the enqueue() method must fail). If no error occurs but enqueue() fails
1142 * anyway, it must call usb_hcd_unlink_urb_from_ep() before releasing
1143 * the private spinlock and returning.
1145 int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb)
1149 spin_lock(&hcd_urb_list_lock);
1151 /* Check that the URB isn't being killed */
1152 if (unlikely(atomic_read(&urb->reject))) {
1157 if (unlikely(!urb->ep->enabled)) {
1162 if (unlikely(!urb->dev->can_submit)) {
1168 * Check the host controller's state and add the URB to the
1171 if (HCD_RH_RUNNING(hcd)) {
1173 list_add_tail(&urb->urb_list, &urb->ep->urb_list);
1179 spin_unlock(&hcd_urb_list_lock);
1182 EXPORT_SYMBOL_GPL(usb_hcd_link_urb_to_ep);
1185 * usb_hcd_check_unlink_urb - check whether an URB may be unlinked
1186 * @hcd: host controller to which @urb was submitted
1187 * @urb: URB being checked for unlinkability
1188 * @status: error code to store in @urb if the unlink succeeds
1190 * Host controller drivers should call this routine in their dequeue()
1191 * method. The HCD's private spinlock must be held and interrupts must
1192 * be disabled. The actions carried out here are required for making
1193 * sure than an unlink is valid.
1195 * Returns 0 for no error, otherwise a negative error code (in which case
1196 * the dequeue() method must fail). The possible error codes are:
1198 * -EIDRM: @urb was not submitted or has already completed.
1199 * The completion function may not have been called yet.
1201 * -EBUSY: @urb has already been unlinked.
1203 int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb,
1206 struct list_head *tmp;
1208 /* insist the urb is still queued */
1209 list_for_each(tmp, &urb->ep->urb_list) {
1210 if (tmp == &urb->urb_list)
1213 if (tmp != &urb->urb_list)
1216 /* Any status except -EINPROGRESS means something already started to
1217 * unlink this URB from the hardware. So there's no more work to do.
1221 urb->unlinked = status;
1224 EXPORT_SYMBOL_GPL(usb_hcd_check_unlink_urb);
1227 * usb_hcd_unlink_urb_from_ep - remove an URB from its endpoint queue
1228 * @hcd: host controller to which @urb was submitted
1229 * @urb: URB being unlinked
1231 * Host controller drivers should call this routine before calling
1232 * usb_hcd_giveback_urb(). The HCD's private spinlock must be held and
1233 * interrupts must be disabled. The actions carried out here are required
1234 * for URB completion.
1236 void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb)
1238 /* clear all state linking urb to this dev (and hcd) */
1239 spin_lock(&hcd_urb_list_lock);
1240 list_del_init(&urb->urb_list);
1241 spin_unlock(&hcd_urb_list_lock);
1243 EXPORT_SYMBOL_GPL(usb_hcd_unlink_urb_from_ep);
1246 * Some usb host controllers can only perform dma using a small SRAM area.
1247 * The usb core itself is however optimized for host controllers that can dma
1248 * using regular system memory - like pci devices doing bus mastering.
1250 * To support host controllers with limited dma capabilites we provide dma
1251 * bounce buffers. This feature can be enabled using the HCD_LOCAL_MEM flag.
1252 * For this to work properly the host controller code must first use the
1253 * function dma_declare_coherent_memory() to point out which memory area
1254 * that should be used for dma allocations.
1256 * The HCD_LOCAL_MEM flag then tells the usb code to allocate all data for
1257 * dma using dma_alloc_coherent() which in turn allocates from the memory
1258 * area pointed out with dma_declare_coherent_memory().
1260 * So, to summarize...
1262 * - We need "local" memory, canonical example being
1263 * a small SRAM on a discrete controller being the
1264 * only memory that the controller can read ...
1265 * (a) "normal" kernel memory is no good, and
1266 * (b) there's not enough to share
1268 * - The only *portable* hook for such stuff in the
1269 * DMA framework is dma_declare_coherent_memory()
1271 * - So we use that, even though the primary requirement
1272 * is that the memory be "local" (hence addressible
1273 * by that device), not "coherent".
1277 static int hcd_alloc_coherent(struct usb_bus *bus,
1278 gfp_t mem_flags, dma_addr_t *dma_handle,
1279 void **vaddr_handle, size_t size,
1280 enum dma_data_direction dir)
1282 unsigned char *vaddr;
1284 if (*vaddr_handle == NULL) {
1289 vaddr = hcd_buffer_alloc(bus, size + sizeof(vaddr),
1290 mem_flags, dma_handle);
1295 * Store the virtual address of the buffer at the end
1296 * of the allocated dma buffer. The size of the buffer
1297 * may be uneven so use unaligned functions instead
1298 * of just rounding up. It makes sense to optimize for
1299 * memory footprint over access speed since the amount
1300 * of memory available for dma may be limited.
1302 put_unaligned((unsigned long)*vaddr_handle,
1303 (unsigned long *)(vaddr + size));
1305 if (dir == DMA_TO_DEVICE)
1306 memcpy(vaddr, *vaddr_handle, size);
1308 *vaddr_handle = vaddr;
1312 static void hcd_free_coherent(struct usb_bus *bus, dma_addr_t *dma_handle,
1313 void **vaddr_handle, size_t size,
1314 enum dma_data_direction dir)
1316 unsigned char *vaddr = *vaddr_handle;
1318 vaddr = (void *)get_unaligned((unsigned long *)(vaddr + size));
1320 if (dir == DMA_FROM_DEVICE)
1321 memcpy(vaddr, *vaddr_handle, size);
1323 hcd_buffer_free(bus, size + sizeof(vaddr), *vaddr_handle, *dma_handle);
1325 *vaddr_handle = vaddr;
1329 void usb_hcd_unmap_urb_setup_for_dma(struct usb_hcd *hcd, struct urb *urb)
1331 if (urb->transfer_flags & URB_SETUP_MAP_SINGLE)
1332 dma_unmap_single(hcd->self.controller,
1334 sizeof(struct usb_ctrlrequest),
1336 else if (urb->transfer_flags & URB_SETUP_MAP_LOCAL)
1337 hcd_free_coherent(urb->dev->bus,
1339 (void **) &urb->setup_packet,
1340 sizeof(struct usb_ctrlrequest),
1343 /* Make it safe to call this routine more than once */
1344 urb->transfer_flags &= ~(URB_SETUP_MAP_SINGLE | URB_SETUP_MAP_LOCAL);
1346 EXPORT_SYMBOL_GPL(usb_hcd_unmap_urb_setup_for_dma);
1348 static void unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
1350 if (hcd->driver->unmap_urb_for_dma)
1351 hcd->driver->unmap_urb_for_dma(hcd, urb);
1353 usb_hcd_unmap_urb_for_dma(hcd, urb);
1356 void usb_hcd_unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
1358 enum dma_data_direction dir;
1360 usb_hcd_unmap_urb_setup_for_dma(hcd, urb);
1362 dir = usb_urb_dir_in(urb) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
1363 if (urb->transfer_flags & URB_DMA_MAP_SG)
1364 dma_unmap_sg(hcd->self.controller,
1368 else if (urb->transfer_flags & URB_DMA_MAP_PAGE)
1369 dma_unmap_page(hcd->self.controller,
1371 urb->transfer_buffer_length,
1373 else if (urb->transfer_flags & URB_DMA_MAP_SINGLE)
1374 dma_unmap_single(hcd->self.controller,
1376 urb->transfer_buffer_length,
1378 else if (urb->transfer_flags & URB_MAP_LOCAL)
1379 hcd_free_coherent(urb->dev->bus,
1381 &urb->transfer_buffer,
1382 urb->transfer_buffer_length,
1385 /* Make it safe to call this routine more than once */
1386 urb->transfer_flags &= ~(URB_DMA_MAP_SG | URB_DMA_MAP_PAGE |
1387 URB_DMA_MAP_SINGLE | URB_MAP_LOCAL);
1389 EXPORT_SYMBOL_GPL(usb_hcd_unmap_urb_for_dma);
1391 static int map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
1394 if (hcd->driver->map_urb_for_dma)
1395 return hcd->driver->map_urb_for_dma(hcd, urb, mem_flags);
1397 return usb_hcd_map_urb_for_dma(hcd, urb, mem_flags);
1400 int usb_hcd_map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
1403 enum dma_data_direction dir;
1406 /* Map the URB's buffers for DMA access.
1407 * Lower level HCD code should use *_dma exclusively,
1408 * unless it uses pio or talks to another transport,
1409 * or uses the provided scatter gather list for bulk.
1412 if (usb_endpoint_xfer_control(&urb->ep->desc)) {
1413 if (hcd->self.uses_pio_for_control)
1415 if (hcd->self.uses_dma) {
1416 urb->setup_dma = dma_map_single(
1417 hcd->self.controller,
1419 sizeof(struct usb_ctrlrequest),
1421 if (dma_mapping_error(hcd->self.controller,
1424 urb->transfer_flags |= URB_SETUP_MAP_SINGLE;
1425 } else if (hcd->driver->flags & HCD_LOCAL_MEM) {
1426 ret = hcd_alloc_coherent(
1427 urb->dev->bus, mem_flags,
1429 (void **)&urb->setup_packet,
1430 sizeof(struct usb_ctrlrequest),
1434 urb->transfer_flags |= URB_SETUP_MAP_LOCAL;
1438 dir = usb_urb_dir_in(urb) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
1439 if (urb->transfer_buffer_length != 0
1440 && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP)) {
1441 if (hcd->self.uses_dma) {
1445 /* We don't support sg for isoc transfers ! */
1446 if (usb_endpoint_xfer_isoc(&urb->ep->desc)) {
1452 hcd->self.controller,
1459 urb->transfer_flags |= URB_DMA_MAP_SG;
1460 urb->num_mapped_sgs = n;
1461 if (n != urb->num_sgs)
1462 urb->transfer_flags |=
1463 URB_DMA_SG_COMBINED;
1464 } else if (urb->sg) {
1465 struct scatterlist *sg = urb->sg;
1466 urb->transfer_dma = dma_map_page(
1467 hcd->self.controller,
1470 urb->transfer_buffer_length,
1472 if (dma_mapping_error(hcd->self.controller,
1476 urb->transfer_flags |= URB_DMA_MAP_PAGE;
1478 urb->transfer_dma = dma_map_single(
1479 hcd->self.controller,
1480 urb->transfer_buffer,
1481 urb->transfer_buffer_length,
1483 if (dma_mapping_error(hcd->self.controller,
1487 urb->transfer_flags |= URB_DMA_MAP_SINGLE;
1489 } else if (hcd->driver->flags & HCD_LOCAL_MEM) {
1490 ret = hcd_alloc_coherent(
1491 urb->dev->bus, mem_flags,
1493 &urb->transfer_buffer,
1494 urb->transfer_buffer_length,
1497 urb->transfer_flags |= URB_MAP_LOCAL;
1499 if (ret && (urb->transfer_flags & (URB_SETUP_MAP_SINGLE |
1500 URB_SETUP_MAP_LOCAL)))
1501 usb_hcd_unmap_urb_for_dma(hcd, urb);
1505 EXPORT_SYMBOL_GPL(usb_hcd_map_urb_for_dma);
1507 /*-------------------------------------------------------------------------*/
1509 /* may be called in any context with a valid urb->dev usecount
1510 * caller surrenders "ownership" of urb
1511 * expects usb_submit_urb() to have sanity checked and conditioned all
1514 int usb_hcd_submit_urb (struct urb *urb, gfp_t mem_flags)
1517 struct usb_hcd *hcd = bus_to_hcd(urb->dev->bus);
1519 /* increment urb's reference count as part of giving it to the HCD
1520 * (which will control it). HCD guarantees that it either returns
1521 * an error or calls giveback(), but not both.
1524 atomic_inc(&urb->use_count);
1525 atomic_inc(&urb->dev->urbnum);
1526 usbmon_urb_submit(&hcd->self, urb);
1528 /* NOTE requirements on root-hub callers (usbfs and the hub
1529 * driver, for now): URBs' urb->transfer_buffer must be
1530 * valid and usb_buffer_{sync,unmap}() not be needed, since
1531 * they could clobber root hub response data. Also, control
1532 * URBs must be submitted in process context with interrupts
1536 if (is_root_hub(urb->dev)) {
1537 status = rh_urb_enqueue(hcd, urb);
1539 status = map_urb_for_dma(hcd, urb, mem_flags);
1540 if (likely(status == 0)) {
1541 status = hcd->driver->urb_enqueue(hcd, urb, mem_flags);
1542 if (unlikely(status))
1543 unmap_urb_for_dma(hcd, urb);
1547 if (unlikely(status)) {
1548 usbmon_urb_submit_error(&hcd->self, urb, status);
1550 INIT_LIST_HEAD(&urb->urb_list);
1551 atomic_dec(&urb->use_count);
1552 atomic_dec(&urb->dev->urbnum);
1553 if (atomic_read(&urb->reject))
1554 wake_up(&usb_kill_urb_queue);
1560 /*-------------------------------------------------------------------------*/
1562 /* this makes the hcd giveback() the urb more quickly, by kicking it
1563 * off hardware queues (which may take a while) and returning it as
1564 * soon as practical. we've already set up the urb's return status,
1565 * but we can't know if the callback completed already.
1567 static int unlink1(struct usb_hcd *hcd, struct urb *urb, int status)
1571 if (is_root_hub(urb->dev))
1572 value = usb_rh_urb_dequeue(hcd, urb, status);
1575 /* The only reason an HCD might fail this call is if
1576 * it has not yet fully queued the urb to begin with.
1577 * Such failures should be harmless. */
1578 value = hcd->driver->urb_dequeue(hcd, urb, status);
1584 * called in any context
1586 * caller guarantees urb won't be recycled till both unlink()
1587 * and the urb's completion function return
1589 int usb_hcd_unlink_urb (struct urb *urb, int status)
1591 struct usb_hcd *hcd;
1592 int retval = -EIDRM;
1593 unsigned long flags;
1595 /* Prevent the device and bus from going away while
1596 * the unlink is carried out. If they are already gone
1597 * then urb->use_count must be 0, since disconnected
1598 * devices can't have any active URBs.
1600 spin_lock_irqsave(&hcd_urb_unlink_lock, flags);
1601 if (atomic_read(&urb->use_count) > 0) {
1603 usb_get_dev(urb->dev);
1605 spin_unlock_irqrestore(&hcd_urb_unlink_lock, flags);
1607 hcd = bus_to_hcd(urb->dev->bus);
1608 retval = unlink1(hcd, urb, status);
1609 usb_put_dev(urb->dev);
1613 retval = -EINPROGRESS;
1614 else if (retval != -EIDRM && retval != -EBUSY)
1615 dev_dbg(&urb->dev->dev, "hcd_unlink_urb %p fail %d\n",
1620 /*-------------------------------------------------------------------------*/
1623 * usb_hcd_giveback_urb - return URB from HCD to device driver
1624 * @hcd: host controller returning the URB
1625 * @urb: urb being returned to the USB device driver.
1626 * @status: completion status code for the URB.
1627 * Context: in_interrupt()
1629 * This hands the URB from HCD to its USB device driver, using its
1630 * completion function. The HCD has freed all per-urb resources
1631 * (and is done using urb->hcpriv). It also released all HCD locks;
1632 * the device driver won't cause problems if it frees, modifies,
1633 * or resubmits this URB.
1635 * If @urb was unlinked, the value of @status will be overridden by
1636 * @urb->unlinked. Erroneous short transfers are detected in case
1637 * the HCD hasn't checked for them.
1639 void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb, int status)
1642 if (unlikely(urb->unlinked))
1643 status = urb->unlinked;
1644 else if (unlikely((urb->transfer_flags & URB_SHORT_NOT_OK) &&
1645 urb->actual_length < urb->transfer_buffer_length &&
1647 status = -EREMOTEIO;
1649 unmap_urb_for_dma(hcd, urb);
1650 usbmon_urb_complete(&hcd->self, urb, status);
1651 usb_unanchor_urb(urb);
1653 /* pass ownership to the completion handler */
1654 urb->status = status;
1655 urb->complete (urb);
1656 atomic_dec (&urb->use_count);
1657 if (unlikely(atomic_read(&urb->reject)))
1658 wake_up (&usb_kill_urb_queue);
1661 EXPORT_SYMBOL_GPL(usb_hcd_giveback_urb);
1663 /*-------------------------------------------------------------------------*/
1665 /* Cancel all URBs pending on this endpoint and wait for the endpoint's
1666 * queue to drain completely. The caller must first insure that no more
1667 * URBs can be submitted for this endpoint.
1669 void usb_hcd_flush_endpoint(struct usb_device *udev,
1670 struct usb_host_endpoint *ep)
1672 struct usb_hcd *hcd;
1678 hcd = bus_to_hcd(udev->bus);
1680 /* No more submits can occur */
1681 spin_lock_irq(&hcd_urb_list_lock);
1683 list_for_each_entry (urb, &ep->urb_list, urb_list) {
1689 is_in = usb_urb_dir_in(urb);
1690 spin_unlock(&hcd_urb_list_lock);
1693 unlink1(hcd, urb, -ESHUTDOWN);
1694 dev_dbg (hcd->self.controller,
1695 "shutdown urb %p ep%d%s%s\n",
1696 urb, usb_endpoint_num(&ep->desc),
1697 is_in ? "in" : "out",
1700 switch (usb_endpoint_type(&ep->desc)) {
1701 case USB_ENDPOINT_XFER_CONTROL:
1703 case USB_ENDPOINT_XFER_BULK:
1705 case USB_ENDPOINT_XFER_INT:
1714 /* list contents may have changed */
1715 spin_lock(&hcd_urb_list_lock);
1718 spin_unlock_irq(&hcd_urb_list_lock);
1720 /* Wait until the endpoint queue is completely empty */
1721 while (!list_empty (&ep->urb_list)) {
1722 spin_lock_irq(&hcd_urb_list_lock);
1724 /* The list may have changed while we acquired the spinlock */
1726 if (!list_empty (&ep->urb_list)) {
1727 urb = list_entry (ep->urb_list.prev, struct urb,
1731 spin_unlock_irq(&hcd_urb_list_lock);
1741 * usb_hcd_alloc_bandwidth - check whether a new bandwidth setting exceeds
1743 * @udev: target &usb_device
1744 * @new_config: new configuration to install
1745 * @cur_alt: the current alternate interface setting
1746 * @new_alt: alternate interface setting that is being installed
1748 * To change configurations, pass in the new configuration in new_config,
1749 * and pass NULL for cur_alt and new_alt.
1751 * To reset a device's configuration (put the device in the ADDRESSED state),
1752 * pass in NULL for new_config, cur_alt, and new_alt.
1754 * To change alternate interface settings, pass in NULL for new_config,
1755 * pass in the current alternate interface setting in cur_alt,
1756 * and pass in the new alternate interface setting in new_alt.
1758 * Returns an error if the requested bandwidth change exceeds the
1759 * bus bandwidth or host controller internal resources.
1761 int usb_hcd_alloc_bandwidth(struct usb_device *udev,
1762 struct usb_host_config *new_config,
1763 struct usb_host_interface *cur_alt,
1764 struct usb_host_interface *new_alt)
1766 int num_intfs, i, j;
1767 struct usb_host_interface *alt = NULL;
1769 struct usb_hcd *hcd;
1770 struct usb_host_endpoint *ep;
1772 hcd = bus_to_hcd(udev->bus);
1773 if (!hcd->driver->check_bandwidth)
1776 /* Configuration is being removed - set configuration 0 */
1777 if (!new_config && !cur_alt) {
1778 for (i = 1; i < 16; ++i) {
1779 ep = udev->ep_out[i];
1781 hcd->driver->drop_endpoint(hcd, udev, ep);
1782 ep = udev->ep_in[i];
1784 hcd->driver->drop_endpoint(hcd, udev, ep);
1786 hcd->driver->check_bandwidth(hcd, udev);
1789 /* Check if the HCD says there's enough bandwidth. Enable all endpoints
1790 * each interface's alt setting 0 and ask the HCD to check the bandwidth
1791 * of the bus. There will always be bandwidth for endpoint 0, so it's
1795 num_intfs = new_config->desc.bNumInterfaces;
1796 /* Remove endpoints (except endpoint 0, which is always on the
1797 * schedule) from the old config from the schedule
1799 for (i = 1; i < 16; ++i) {
1800 ep = udev->ep_out[i];
1802 ret = hcd->driver->drop_endpoint(hcd, udev, ep);
1806 ep = udev->ep_in[i];
1808 ret = hcd->driver->drop_endpoint(hcd, udev, ep);
1813 for (i = 0; i < num_intfs; ++i) {
1814 struct usb_host_interface *first_alt;
1817 first_alt = &new_config->intf_cache[i]->altsetting[0];
1818 iface_num = first_alt->desc.bInterfaceNumber;
1819 /* Set up endpoints for alternate interface setting 0 */
1820 alt = usb_find_alt_setting(new_config, iface_num, 0);
1822 /* No alt setting 0? Pick the first setting. */
1825 for (j = 0; j < alt->desc.bNumEndpoints; j++) {
1826 ret = hcd->driver->add_endpoint(hcd, udev, &alt->endpoint[j]);
1832 if (cur_alt && new_alt) {
1833 struct usb_interface *iface = usb_ifnum_to_if(udev,
1834 cur_alt->desc.bInterfaceNumber);
1838 if (iface->resetting_device) {
1840 * The USB core just reset the device, so the xHCI host
1841 * and the device will think alt setting 0 is installed.
1842 * However, the USB core will pass in the alternate
1843 * setting installed before the reset as cur_alt. Dig
1844 * out the alternate setting 0 structure, or the first
1845 * alternate setting if a broken device doesn't have alt
1848 cur_alt = usb_altnum_to_altsetting(iface, 0);
1850 cur_alt = &iface->altsetting[0];
1853 /* Drop all the endpoints in the current alt setting */
1854 for (i = 0; i < cur_alt->desc.bNumEndpoints; i++) {
1855 ret = hcd->driver->drop_endpoint(hcd, udev,
1856 &cur_alt->endpoint[i]);
1860 /* Add all the endpoints in the new alt setting */
1861 for (i = 0; i < new_alt->desc.bNumEndpoints; i++) {
1862 ret = hcd->driver->add_endpoint(hcd, udev,
1863 &new_alt->endpoint[i]);
1868 ret = hcd->driver->check_bandwidth(hcd, udev);
1871 hcd->driver->reset_bandwidth(hcd, udev);
1875 /* Disables the endpoint: synchronizes with the hcd to make sure all
1876 * endpoint state is gone from hardware. usb_hcd_flush_endpoint() must
1877 * have been called previously. Use for set_configuration, set_interface,
1878 * driver removal, physical disconnect.
1880 * example: a qh stored in ep->hcpriv, holding state related to endpoint
1881 * type, maxpacket size, toggle, halt status, and scheduling.
1883 void usb_hcd_disable_endpoint(struct usb_device *udev,
1884 struct usb_host_endpoint *ep)
1886 struct usb_hcd *hcd;
1889 hcd = bus_to_hcd(udev->bus);
1890 if (hcd->driver->endpoint_disable)
1891 hcd->driver->endpoint_disable(hcd, ep);
1895 * usb_hcd_reset_endpoint - reset host endpoint state
1896 * @udev: USB device.
1897 * @ep: the endpoint to reset.
1899 * Resets any host endpoint state such as the toggle bit, sequence
1900 * number and current window.
1902 void usb_hcd_reset_endpoint(struct usb_device *udev,
1903 struct usb_host_endpoint *ep)
1905 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1907 if (hcd->driver->endpoint_reset)
1908 hcd->driver->endpoint_reset(hcd, ep);
1910 int epnum = usb_endpoint_num(&ep->desc);
1911 int is_out = usb_endpoint_dir_out(&ep->desc);
1912 int is_control = usb_endpoint_xfer_control(&ep->desc);
1914 usb_settoggle(udev, epnum, is_out, 0);
1916 usb_settoggle(udev, epnum, !is_out, 0);
1921 * usb_alloc_streams - allocate bulk endpoint stream IDs.
1922 * @interface: alternate setting that includes all endpoints.
1923 * @eps: array of endpoints that need streams.
1924 * @num_eps: number of endpoints in the array.
1925 * @num_streams: number of streams to allocate.
1926 * @mem_flags: flags hcd should use to allocate memory.
1928 * Sets up a group of bulk endpoints to have num_streams stream IDs available.
1929 * Drivers may queue multiple transfers to different stream IDs, which may
1930 * complete in a different order than they were queued.
1932 int usb_alloc_streams(struct usb_interface *interface,
1933 struct usb_host_endpoint **eps, unsigned int num_eps,
1934 unsigned int num_streams, gfp_t mem_flags)
1936 struct usb_hcd *hcd;
1937 struct usb_device *dev;
1940 dev = interface_to_usbdev(interface);
1941 hcd = bus_to_hcd(dev->bus);
1942 if (!hcd->driver->alloc_streams || !hcd->driver->free_streams)
1944 if (dev->speed != USB_SPEED_SUPER)
1947 /* Streams only apply to bulk endpoints. */
1948 for (i = 0; i < num_eps; i++)
1949 if (!usb_endpoint_xfer_bulk(&eps[i]->desc))
1952 return hcd->driver->alloc_streams(hcd, dev, eps, num_eps,
1953 num_streams, mem_flags);
1955 EXPORT_SYMBOL_GPL(usb_alloc_streams);
1958 * usb_free_streams - free bulk endpoint stream IDs.
1959 * @interface: alternate setting that includes all endpoints.
1960 * @eps: array of endpoints to remove streams from.
1961 * @num_eps: number of endpoints in the array.
1962 * @mem_flags: flags hcd should use to allocate memory.
1964 * Reverts a group of bulk endpoints back to not using stream IDs.
1965 * Can fail if we are given bad arguments, or HCD is broken.
1967 void usb_free_streams(struct usb_interface *interface,
1968 struct usb_host_endpoint **eps, unsigned int num_eps,
1971 struct usb_hcd *hcd;
1972 struct usb_device *dev;
1975 dev = interface_to_usbdev(interface);
1976 hcd = bus_to_hcd(dev->bus);
1977 if (dev->speed != USB_SPEED_SUPER)
1980 /* Streams only apply to bulk endpoints. */
1981 for (i = 0; i < num_eps; i++)
1982 if (!eps[i] || !usb_endpoint_xfer_bulk(&eps[i]->desc))
1985 hcd->driver->free_streams(hcd, dev, eps, num_eps, mem_flags);
1987 EXPORT_SYMBOL_GPL(usb_free_streams);
1989 /* Protect against drivers that try to unlink URBs after the device
1990 * is gone, by waiting until all unlinks for @udev are finished.
1991 * Since we don't currently track URBs by device, simply wait until
1992 * nothing is running in the locked region of usb_hcd_unlink_urb().
1994 void usb_hcd_synchronize_unlinks(struct usb_device *udev)
1996 spin_lock_irq(&hcd_urb_unlink_lock);
1997 spin_unlock_irq(&hcd_urb_unlink_lock);
2000 /*-------------------------------------------------------------------------*/
2002 /* called in any context */
2003 int usb_hcd_get_frame_number (struct usb_device *udev)
2005 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2007 if (!HCD_RH_RUNNING(hcd))
2009 return hcd->driver->get_frame_number (hcd);
2012 /*-------------------------------------------------------------------------*/
2016 int hcd_bus_suspend(struct usb_device *rhdev, pm_message_t msg)
2018 struct usb_hcd *hcd = container_of(rhdev->bus, struct usb_hcd, self);
2020 int old_state = hcd->state;
2022 dev_dbg(&rhdev->dev, "bus %ssuspend, wakeup %d\n",
2023 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
2024 rhdev->do_remote_wakeup);
2025 if (HCD_DEAD(hcd)) {
2026 dev_dbg(&rhdev->dev, "skipped %s of dead bus\n", "suspend");
2030 if (!hcd->driver->bus_suspend) {
2033 clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2034 hcd->state = HC_STATE_QUIESCING;
2035 status = hcd->driver->bus_suspend(hcd);
2038 usb_set_device_state(rhdev, USB_STATE_SUSPENDED);
2039 hcd->state = HC_STATE_SUSPENDED;
2041 /* Did we race with a root-hub wakeup event? */
2042 if (rhdev->do_remote_wakeup) {
2045 status = hcd->driver->hub_status_data(hcd, buffer);
2047 dev_dbg(&rhdev->dev, "suspend raced with wakeup event\n");
2048 hcd_bus_resume(rhdev, PMSG_AUTO_RESUME);
2053 spin_lock_irq(&hcd_root_hub_lock);
2054 if (!HCD_DEAD(hcd)) {
2055 set_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2056 hcd->state = old_state;
2058 spin_unlock_irq(&hcd_root_hub_lock);
2059 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
2065 int hcd_bus_resume(struct usb_device *rhdev, pm_message_t msg)
2067 struct usb_hcd *hcd = container_of(rhdev->bus, struct usb_hcd, self);
2069 int old_state = hcd->state;
2071 dev_dbg(&rhdev->dev, "usb %sresume\n",
2072 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
2073 if (HCD_DEAD(hcd)) {
2074 dev_dbg(&rhdev->dev, "skipped %s of dead bus\n", "resume");
2077 if (!hcd->driver->bus_resume)
2079 if (HCD_RH_RUNNING(hcd))
2082 hcd->state = HC_STATE_RESUMING;
2083 status = hcd->driver->bus_resume(hcd);
2084 clear_bit(HCD_FLAG_WAKEUP_PENDING, &hcd->flags);
2086 struct usb_device *udev;
2089 spin_lock_irq(&hcd_root_hub_lock);
2090 if (!HCD_DEAD(hcd)) {
2091 usb_set_device_state(rhdev, rhdev->actconfig
2092 ? USB_STATE_CONFIGURED
2093 : USB_STATE_ADDRESS);
2094 set_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2095 hcd->state = HC_STATE_RUNNING;
2097 spin_unlock_irq(&hcd_root_hub_lock);
2100 * Check whether any of the enabled ports on the root hub are
2101 * unsuspended. If they are then a TRSMRCY delay is needed
2102 * (this is what the USB-2 spec calls a "global resume").
2103 * Otherwise we can skip the delay.
2105 usb_hub_for_each_child(rhdev, port1, udev) {
2106 if (udev->state != USB_STATE_NOTATTACHED &&
2107 !udev->port_is_suspended) {
2108 usleep_range(10000, 11000); /* TRSMRCY */
2113 hcd->state = old_state;
2114 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
2116 if (status != -ESHUTDOWN)
2122 #endif /* CONFIG_PM */
2124 #ifdef CONFIG_USB_SUSPEND
2126 /* Workqueue routine for root-hub remote wakeup */
2127 static void hcd_resume_work(struct work_struct *work)
2129 struct usb_hcd *hcd = container_of(work, struct usb_hcd, wakeup_work);
2130 struct usb_device *udev = hcd->self.root_hub;
2132 usb_lock_device(udev);
2133 usb_remote_wakeup(udev);
2134 usb_unlock_device(udev);
2138 * usb_hcd_resume_root_hub - called by HCD to resume its root hub
2139 * @hcd: host controller for this root hub
2141 * The USB host controller calls this function when its root hub is
2142 * suspended (with the remote wakeup feature enabled) and a remote
2143 * wakeup request is received. The routine submits a workqueue request
2144 * to resume the root hub (that is, manage its downstream ports again).
2146 void usb_hcd_resume_root_hub (struct usb_hcd *hcd)
2148 unsigned long flags;
2150 spin_lock_irqsave (&hcd_root_hub_lock, flags);
2151 if (hcd->rh_registered) {
2152 set_bit(HCD_FLAG_WAKEUP_PENDING, &hcd->flags);
2153 queue_work(pm_wq, &hcd->wakeup_work);
2155 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
2157 EXPORT_SYMBOL_GPL(usb_hcd_resume_root_hub);
2159 #endif /* CONFIG_USB_SUSPEND */
2161 /*-------------------------------------------------------------------------*/
2163 #ifdef CONFIG_USB_OTG
2166 * usb_bus_start_enum - start immediate enumeration (for OTG)
2167 * @bus: the bus (must use hcd framework)
2168 * @port_num: 1-based number of port; usually bus->otg_port
2169 * Context: in_interrupt()
2171 * Starts enumeration, with an immediate reset followed later by
2172 * khubd identifying and possibly configuring the device.
2173 * This is needed by OTG controller drivers, where it helps meet
2174 * HNP protocol timing requirements for starting a port reset.
2176 int usb_bus_start_enum(struct usb_bus *bus, unsigned port_num)
2178 struct usb_hcd *hcd;
2179 int status = -EOPNOTSUPP;
2181 /* NOTE: since HNP can't start by grabbing the bus's address0_sem,
2182 * boards with root hubs hooked up to internal devices (instead of
2183 * just the OTG port) may need more attention to resetting...
2185 hcd = container_of (bus, struct usb_hcd, self);
2186 if (port_num && hcd->driver->start_port_reset)
2187 status = hcd->driver->start_port_reset(hcd, port_num);
2189 /* run khubd shortly after (first) root port reset finishes;
2190 * it may issue others, until at least 50 msecs have passed.
2193 mod_timer(&hcd->rh_timer, jiffies + msecs_to_jiffies(10));
2196 EXPORT_SYMBOL_GPL(usb_bus_start_enum);
2200 /*-------------------------------------------------------------------------*/
2203 * usb_hcd_irq - hook IRQs to HCD framework (bus glue)
2204 * @irq: the IRQ being raised
2205 * @__hcd: pointer to the HCD whose IRQ is being signaled
2207 * If the controller isn't HALTed, calls the driver's irq handler.
2208 * Checks whether the controller is now dead.
2210 irqreturn_t usb_hcd_irq (int irq, void *__hcd)
2212 struct usb_hcd *hcd = __hcd;
2213 unsigned long flags;
2216 /* IRQF_DISABLED doesn't work correctly with shared IRQs
2217 * when the first handler doesn't use it. So let's just
2218 * assume it's never used.
2220 local_irq_save(flags);
2222 if (unlikely(HCD_DEAD(hcd) || !HCD_HW_ACCESSIBLE(hcd)))
2224 else if (hcd->driver->irq(hcd) == IRQ_NONE)
2229 local_irq_restore(flags);
2232 EXPORT_SYMBOL_GPL(usb_hcd_irq);
2234 /*-------------------------------------------------------------------------*/
2237 * usb_hc_died - report abnormal shutdown of a host controller (bus glue)
2238 * @hcd: pointer to the HCD representing the controller
2240 * This is called by bus glue to report a USB host controller that died
2241 * while operations may still have been pending. It's called automatically
2242 * by the PCI glue, so only glue for non-PCI busses should need to call it.
2244 * Only call this function with the primary HCD.
2246 void usb_hc_died (struct usb_hcd *hcd)
2248 unsigned long flags;
2250 dev_err (hcd->self.controller, "HC died; cleaning up\n");
2252 spin_lock_irqsave (&hcd_root_hub_lock, flags);
2253 clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2254 set_bit(HCD_FLAG_DEAD, &hcd->flags);
2255 if (hcd->rh_registered) {
2256 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2258 /* make khubd clean up old urbs and devices */
2259 usb_set_device_state (hcd->self.root_hub,
2260 USB_STATE_NOTATTACHED);
2261 usb_kick_khubd (hcd->self.root_hub);
2263 if (usb_hcd_is_primary_hcd(hcd) && hcd->shared_hcd) {
2264 hcd = hcd->shared_hcd;
2265 if (hcd->rh_registered) {
2266 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2268 /* make khubd clean up old urbs and devices */
2269 usb_set_device_state(hcd->self.root_hub,
2270 USB_STATE_NOTATTACHED);
2271 usb_kick_khubd(hcd->self.root_hub);
2274 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
2275 /* Make sure that the other roothub is also deallocated. */
2277 EXPORT_SYMBOL_GPL (usb_hc_died);
2279 /*-------------------------------------------------------------------------*/
2282 * usb_create_shared_hcd - create and initialize an HCD structure
2283 * @driver: HC driver that will use this hcd
2284 * @dev: device for this HC, stored in hcd->self.controller
2285 * @bus_name: value to store in hcd->self.bus_name
2286 * @primary_hcd: a pointer to the usb_hcd structure that is sharing the
2287 * PCI device. Only allocate certain resources for the primary HCD
2288 * Context: !in_interrupt()
2290 * Allocate a struct usb_hcd, with extra space at the end for the
2291 * HC driver's private data. Initialize the generic members of the
2294 * If memory is unavailable, returns NULL.
2296 struct usb_hcd *usb_create_shared_hcd(const struct hc_driver *driver,
2297 struct device *dev, const char *bus_name,
2298 struct usb_hcd *primary_hcd)
2300 struct usb_hcd *hcd;
2302 hcd = kzalloc(sizeof(*hcd) + driver->hcd_priv_size, GFP_KERNEL);
2304 dev_dbg (dev, "hcd alloc failed\n");
2307 if (primary_hcd == NULL) {
2308 hcd->bandwidth_mutex = kmalloc(sizeof(*hcd->bandwidth_mutex),
2310 if (!hcd->bandwidth_mutex) {
2312 dev_dbg(dev, "hcd bandwidth mutex alloc failed\n");
2315 mutex_init(hcd->bandwidth_mutex);
2316 dev_set_drvdata(dev, hcd);
2318 hcd->bandwidth_mutex = primary_hcd->bandwidth_mutex;
2319 hcd->primary_hcd = primary_hcd;
2320 primary_hcd->primary_hcd = primary_hcd;
2321 hcd->shared_hcd = primary_hcd;
2322 primary_hcd->shared_hcd = hcd;
2325 kref_init(&hcd->kref);
2327 usb_bus_init(&hcd->self);
2328 hcd->self.controller = dev;
2329 hcd->self.bus_name = bus_name;
2330 hcd->self.uses_dma = (dev->dma_mask != NULL);
2332 init_timer(&hcd->rh_timer);
2333 hcd->rh_timer.function = rh_timer_func;
2334 hcd->rh_timer.data = (unsigned long) hcd;
2335 #ifdef CONFIG_USB_SUSPEND
2336 INIT_WORK(&hcd->wakeup_work, hcd_resume_work);
2339 hcd->driver = driver;
2340 hcd->speed = driver->flags & HCD_MASK;
2341 hcd->product_desc = (driver->product_desc) ? driver->product_desc :
2342 "USB Host Controller";
2345 EXPORT_SYMBOL_GPL(usb_create_shared_hcd);
2348 * usb_create_hcd - create and initialize an HCD structure
2349 * @driver: HC driver that will use this hcd
2350 * @dev: device for this HC, stored in hcd->self.controller
2351 * @bus_name: value to store in hcd->self.bus_name
2352 * Context: !in_interrupt()
2354 * Allocate a struct usb_hcd, with extra space at the end for the
2355 * HC driver's private data. Initialize the generic members of the
2358 * If memory is unavailable, returns NULL.
2360 struct usb_hcd *usb_create_hcd(const struct hc_driver *driver,
2361 struct device *dev, const char *bus_name)
2363 return usb_create_shared_hcd(driver, dev, bus_name, NULL);
2365 EXPORT_SYMBOL_GPL(usb_create_hcd);
2368 * Roothubs that share one PCI device must also share the bandwidth mutex.
2369 * Don't deallocate the bandwidth_mutex until the last shared usb_hcd is
2372 * Make sure to only deallocate the bandwidth_mutex when the primary HCD is
2373 * freed. When hcd_release() is called for the non-primary HCD, set the
2374 * primary_hcd's shared_hcd pointer to null (since the non-primary HCD will be
2377 static void hcd_release (struct kref *kref)
2379 struct usb_hcd *hcd = container_of (kref, struct usb_hcd, kref);
2381 if (usb_hcd_is_primary_hcd(hcd))
2382 kfree(hcd->bandwidth_mutex);
2384 hcd->shared_hcd->shared_hcd = NULL;
2388 struct usb_hcd *usb_get_hcd (struct usb_hcd *hcd)
2391 kref_get (&hcd->kref);
2394 EXPORT_SYMBOL_GPL(usb_get_hcd);
2396 void usb_put_hcd (struct usb_hcd *hcd)
2399 kref_put (&hcd->kref, hcd_release);
2401 EXPORT_SYMBOL_GPL(usb_put_hcd);
2403 int usb_hcd_is_primary_hcd(struct usb_hcd *hcd)
2405 if (!hcd->primary_hcd)
2407 return hcd == hcd->primary_hcd;
2409 EXPORT_SYMBOL_GPL(usb_hcd_is_primary_hcd);
2411 static int usb_hcd_request_irqs(struct usb_hcd *hcd,
2412 unsigned int irqnum, unsigned long irqflags)
2416 if (hcd->driver->irq) {
2418 /* IRQF_DISABLED doesn't work as advertised when used together
2419 * with IRQF_SHARED. As usb_hcd_irq() will always disable
2420 * interrupts we can remove it here.
2422 if (irqflags & IRQF_SHARED)
2423 irqflags &= ~IRQF_DISABLED;
2425 snprintf(hcd->irq_descr, sizeof(hcd->irq_descr), "%s:usb%d",
2426 hcd->driver->description, hcd->self.busnum);
2427 retval = request_irq(irqnum, &usb_hcd_irq, irqflags,
2428 hcd->irq_descr, hcd);
2430 dev_err(hcd->self.controller,
2431 "request interrupt %d failed\n",
2436 dev_info(hcd->self.controller, "irq %d, %s 0x%08llx\n", irqnum,
2437 (hcd->driver->flags & HCD_MEMORY) ?
2438 "io mem" : "io base",
2439 (unsigned long long)hcd->rsrc_start);
2442 if (hcd->rsrc_start)
2443 dev_info(hcd->self.controller, "%s 0x%08llx\n",
2444 (hcd->driver->flags & HCD_MEMORY) ?
2445 "io mem" : "io base",
2446 (unsigned long long)hcd->rsrc_start);
2452 * usb_add_hcd - finish generic HCD structure initialization and register
2453 * @hcd: the usb_hcd structure to initialize
2454 * @irqnum: Interrupt line to allocate
2455 * @irqflags: Interrupt type flags
2457 * Finish the remaining parts of generic HCD initialization: allocate the
2458 * buffers of consistent memory, register the bus, request the IRQ line,
2459 * and call the driver's reset() and start() routines.
2461 int usb_add_hcd(struct usb_hcd *hcd,
2462 unsigned int irqnum, unsigned long irqflags)
2465 struct usb_device *rhdev;
2467 dev_info(hcd->self.controller, "%s\n", hcd->product_desc);
2469 /* Keep old behaviour if authorized_default is not in [0, 1]. */
2470 if (authorized_default < 0 || authorized_default > 1)
2471 hcd->authorized_default = hcd->wireless? 0 : 1;
2473 hcd->authorized_default = authorized_default;
2474 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
2476 /* HC is in reset state, but accessible. Now do the one-time init,
2477 * bottom up so that hcds can customize the root hubs before khubd
2478 * starts talking to them. (Note, bus id is assigned early too.)
2480 if ((retval = hcd_buffer_create(hcd)) != 0) {
2481 dev_dbg(hcd->self.controller, "pool alloc failed\n");
2485 if ((retval = usb_register_bus(&hcd->self)) < 0)
2486 goto err_register_bus;
2488 if ((rhdev = usb_alloc_dev(NULL, &hcd->self, 0)) == NULL) {
2489 dev_err(hcd->self.controller, "unable to allocate root hub\n");
2491 goto err_allocate_root_hub;
2493 hcd->self.root_hub = rhdev;
2495 switch (hcd->speed) {
2497 rhdev->speed = USB_SPEED_FULL;
2500 rhdev->speed = USB_SPEED_HIGH;
2503 rhdev->speed = USB_SPEED_SUPER;
2507 goto err_set_rh_speed;
2510 /* wakeup flag init defaults to "everything works" for root hubs,
2511 * but drivers can override it in reset() if needed, along with
2512 * recording the overall controller's system wakeup capability.
2514 device_set_wakeup_capable(&rhdev->dev, 1);
2516 /* HCD_FLAG_RH_RUNNING doesn't matter until the root hub is
2517 * registered. But since the controller can die at any time,
2518 * let's initialize the flag before touching the hardware.
2520 set_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2522 /* "reset" is misnamed; its role is now one-time init. the controller
2523 * should already have been reset (and boot firmware kicked off etc).
2525 if (hcd->driver->reset && (retval = hcd->driver->reset(hcd)) < 0) {
2526 dev_err(hcd->self.controller, "can't setup\n");
2527 goto err_hcd_driver_setup;
2529 hcd->rh_pollable = 1;
2531 /* NOTE: root hub and controller capabilities may not be the same */
2532 if (device_can_wakeup(hcd->self.controller)
2533 && device_can_wakeup(&hcd->self.root_hub->dev))
2534 dev_dbg(hcd->self.controller, "supports USB remote wakeup\n");
2536 /* enable irqs just before we start the controller,
2537 * if the BIOS provides legacy PCI irqs.
2539 if (usb_hcd_is_primary_hcd(hcd) && irqnum) {
2540 retval = usb_hcd_request_irqs(hcd, irqnum, irqflags);
2542 goto err_request_irq;
2545 hcd->state = HC_STATE_RUNNING;
2546 retval = hcd->driver->start(hcd);
2548 dev_err(hcd->self.controller, "startup error %d\n", retval);
2549 goto err_hcd_driver_start;
2552 /* starting here, usbcore will pay attention to this root hub */
2553 rhdev->bus_mA = min(500u, hcd->power_budget);
2554 if ((retval = register_root_hub(hcd)) != 0)
2555 goto err_register_root_hub;
2557 retval = sysfs_create_group(&rhdev->dev.kobj, &usb_bus_attr_group);
2559 printk(KERN_ERR "Cannot register USB bus sysfs attributes: %d\n",
2561 goto error_create_attr_group;
2563 if (hcd->uses_new_polling && HCD_POLL_RH(hcd))
2564 usb_hcd_poll_rh_status(hcd);
2567 * Host controllers don't generate their own wakeup requests;
2568 * they only forward requests from the root hub. Therefore
2569 * controllers should always be enabled for remote wakeup.
2571 device_wakeup_enable(hcd->self.controller);
2574 error_create_attr_group:
2575 clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2576 if (HC_IS_RUNNING(hcd->state))
2577 hcd->state = HC_STATE_QUIESCING;
2578 spin_lock_irq(&hcd_root_hub_lock);
2579 hcd->rh_registered = 0;
2580 spin_unlock_irq(&hcd_root_hub_lock);
2582 #ifdef CONFIG_USB_SUSPEND
2583 cancel_work_sync(&hcd->wakeup_work);
2585 mutex_lock(&usb_bus_list_lock);
2586 usb_disconnect(&rhdev); /* Sets rhdev to NULL */
2587 mutex_unlock(&usb_bus_list_lock);
2588 err_register_root_hub:
2589 hcd->rh_pollable = 0;
2590 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2591 del_timer_sync(&hcd->rh_timer);
2592 hcd->driver->stop(hcd);
2593 hcd->state = HC_STATE_HALT;
2594 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2595 del_timer_sync(&hcd->rh_timer);
2596 err_hcd_driver_start:
2597 if (usb_hcd_is_primary_hcd(hcd) && hcd->irq > 0)
2598 free_irq(irqnum, hcd);
2600 err_hcd_driver_setup:
2602 usb_put_dev(hcd->self.root_hub);
2603 err_allocate_root_hub:
2604 usb_deregister_bus(&hcd->self);
2606 hcd_buffer_destroy(hcd);
2609 EXPORT_SYMBOL_GPL(usb_add_hcd);
2612 * usb_remove_hcd - shutdown processing for generic HCDs
2613 * @hcd: the usb_hcd structure to remove
2614 * Context: !in_interrupt()
2616 * Disconnects the root hub, then reverses the effects of usb_add_hcd(),
2617 * invoking the HCD's stop() method.
2619 void usb_remove_hcd(struct usb_hcd *hcd)
2621 struct usb_device *rhdev = hcd->self.root_hub;
2623 dev_info(hcd->self.controller, "remove, state %x\n", hcd->state);
2626 sysfs_remove_group(&rhdev->dev.kobj, &usb_bus_attr_group);
2628 clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2629 if (HC_IS_RUNNING (hcd->state))
2630 hcd->state = HC_STATE_QUIESCING;
2632 dev_dbg(hcd->self.controller, "roothub graceful disconnect\n");
2633 spin_lock_irq (&hcd_root_hub_lock);
2634 hcd->rh_registered = 0;
2635 spin_unlock_irq (&hcd_root_hub_lock);
2637 #ifdef CONFIG_USB_SUSPEND
2638 cancel_work_sync(&hcd->wakeup_work);
2641 mutex_lock(&usb_bus_list_lock);
2642 usb_disconnect(&rhdev); /* Sets rhdev to NULL */
2643 mutex_unlock(&usb_bus_list_lock);
2645 /* Prevent any more root-hub status calls from the timer.
2646 * The HCD might still restart the timer (if a port status change
2647 * interrupt occurs), but usb_hcd_poll_rh_status() won't invoke
2648 * the hub_status_data() callback.
2650 hcd->rh_pollable = 0;
2651 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2652 del_timer_sync(&hcd->rh_timer);
2654 hcd->driver->stop(hcd);
2655 hcd->state = HC_STATE_HALT;
2657 /* In case the HCD restarted the timer, stop it again. */
2658 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2659 del_timer_sync(&hcd->rh_timer);
2661 if (usb_hcd_is_primary_hcd(hcd)) {
2663 free_irq(hcd->irq, hcd);
2666 usb_put_dev(hcd->self.root_hub);
2667 usb_deregister_bus(&hcd->self);
2668 hcd_buffer_destroy(hcd);
2670 EXPORT_SYMBOL_GPL(usb_remove_hcd);
2673 usb_hcd_platform_shutdown(struct platform_device* dev)
2675 struct usb_hcd *hcd = platform_get_drvdata(dev);
2677 if (hcd->driver->shutdown)
2678 hcd->driver->shutdown(hcd);
2680 EXPORT_SYMBOL_GPL(usb_hcd_platform_shutdown);
2682 /*-------------------------------------------------------------------------*/
2684 #if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
2686 struct usb_mon_operations *mon_ops;
2689 * The registration is unlocked.
2690 * We do it this way because we do not want to lock in hot paths.
2692 * Notice that the code is minimally error-proof. Because usbmon needs
2693 * symbols from usbcore, usbcore gets referenced and cannot be unloaded first.
2696 int usb_mon_register (struct usb_mon_operations *ops)
2706 EXPORT_SYMBOL_GPL (usb_mon_register);
2708 void usb_mon_deregister (void)
2711 if (mon_ops == NULL) {
2712 printk(KERN_ERR "USB: monitor was not registered\n");
2718 EXPORT_SYMBOL_GPL (usb_mon_deregister);
2720 #endif /* CONFIG_USB_MON || CONFIG_USB_MON_MODULE */