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>
43 #include <linux/usb.h>
44 #include <linux/usb/hcd.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 /*-------------------------------------------------------------------------*/
127 #define KERNEL_REL bin2bcd(((LINUX_VERSION_CODE >> 16) & 0x0ff))
128 #define KERNEL_VER bin2bcd(((LINUX_VERSION_CODE >> 8) & 0x0ff))
130 /* usb 3.0 root hub device descriptor */
131 static const u8 usb3_rh_dev_descriptor
[18] = {
132 0x12, /* __u8 bLength; */
133 0x01, /* __u8 bDescriptorType; Device */
134 0x00, 0x03, /* __le16 bcdUSB; v3.0 */
136 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
137 0x00, /* __u8 bDeviceSubClass; */
138 0x03, /* __u8 bDeviceProtocol; USB 3.0 hub */
139 0x09, /* __u8 bMaxPacketSize0; 2^9 = 512 Bytes */
141 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation 0x1d6b */
142 0x03, 0x00, /* __le16 idProduct; device 0x0003 */
143 KERNEL_VER
, KERNEL_REL
, /* __le16 bcdDevice */
145 0x03, /* __u8 iManufacturer; */
146 0x02, /* __u8 iProduct; */
147 0x01, /* __u8 iSerialNumber; */
148 0x01 /* __u8 bNumConfigurations; */
151 /* usb 2.0 root hub device descriptor */
152 static const u8 usb2_rh_dev_descriptor
[18] = {
153 0x12, /* __u8 bLength; */
154 0x01, /* __u8 bDescriptorType; Device */
155 0x00, 0x02, /* __le16 bcdUSB; v2.0 */
157 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
158 0x00, /* __u8 bDeviceSubClass; */
159 0x00, /* __u8 bDeviceProtocol; [ usb 2.0 no TT ] */
160 0x40, /* __u8 bMaxPacketSize0; 64 Bytes */
162 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation 0x1d6b */
163 0x02, 0x00, /* __le16 idProduct; device 0x0002 */
164 KERNEL_VER
, KERNEL_REL
, /* __le16 bcdDevice */
166 0x03, /* __u8 iManufacturer; */
167 0x02, /* __u8 iProduct; */
168 0x01, /* __u8 iSerialNumber; */
169 0x01 /* __u8 bNumConfigurations; */
172 /* no usb 2.0 root hub "device qualifier" descriptor: one speed only */
174 /* usb 1.1 root hub device descriptor */
175 static const u8 usb11_rh_dev_descriptor
[18] = {
176 0x12, /* __u8 bLength; */
177 0x01, /* __u8 bDescriptorType; Device */
178 0x10, 0x01, /* __le16 bcdUSB; v1.1 */
180 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
181 0x00, /* __u8 bDeviceSubClass; */
182 0x00, /* __u8 bDeviceProtocol; [ low/full speeds only ] */
183 0x40, /* __u8 bMaxPacketSize0; 64 Bytes */
185 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation 0x1d6b */
186 0x01, 0x00, /* __le16 idProduct; device 0x0001 */
187 KERNEL_VER
, KERNEL_REL
, /* __le16 bcdDevice */
189 0x03, /* __u8 iManufacturer; */
190 0x02, /* __u8 iProduct; */
191 0x01, /* __u8 iSerialNumber; */
192 0x01 /* __u8 bNumConfigurations; */
196 /*-------------------------------------------------------------------------*/
198 /* Configuration descriptors for our root hubs */
200 static const u8 fs_rh_config_descriptor
[] = {
202 /* one configuration */
203 0x09, /* __u8 bLength; */
204 0x02, /* __u8 bDescriptorType; Configuration */
205 0x19, 0x00, /* __le16 wTotalLength; */
206 0x01, /* __u8 bNumInterfaces; (1) */
207 0x01, /* __u8 bConfigurationValue; */
208 0x00, /* __u8 iConfiguration; */
209 0xc0, /* __u8 bmAttributes;
214 0x00, /* __u8 MaxPower; */
217 * USB 2.0, single TT organization (mandatory):
218 * one interface, protocol 0
220 * USB 2.0, multiple TT organization (optional):
221 * two interfaces, protocols 1 (like single TT)
222 * and 2 (multiple TT mode) ... config is
228 0x09, /* __u8 if_bLength; */
229 0x04, /* __u8 if_bDescriptorType; Interface */
230 0x00, /* __u8 if_bInterfaceNumber; */
231 0x00, /* __u8 if_bAlternateSetting; */
232 0x01, /* __u8 if_bNumEndpoints; */
233 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
234 0x00, /* __u8 if_bInterfaceSubClass; */
235 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
236 0x00, /* __u8 if_iInterface; */
238 /* one endpoint (status change endpoint) */
239 0x07, /* __u8 ep_bLength; */
240 0x05, /* __u8 ep_bDescriptorType; Endpoint */
241 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
242 0x03, /* __u8 ep_bmAttributes; Interrupt */
243 0x02, 0x00, /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8) */
244 0xff /* __u8 ep_bInterval; (255ms -- usb 2.0 spec) */
247 static const u8 hs_rh_config_descriptor
[] = {
249 /* one configuration */
250 0x09, /* __u8 bLength; */
251 0x02, /* __u8 bDescriptorType; Configuration */
252 0x19, 0x00, /* __le16 wTotalLength; */
253 0x01, /* __u8 bNumInterfaces; (1) */
254 0x01, /* __u8 bConfigurationValue; */
255 0x00, /* __u8 iConfiguration; */
256 0xc0, /* __u8 bmAttributes;
261 0x00, /* __u8 MaxPower; */
264 * USB 2.0, single TT organization (mandatory):
265 * one interface, protocol 0
267 * USB 2.0, multiple TT organization (optional):
268 * two interfaces, protocols 1 (like single TT)
269 * and 2 (multiple TT mode) ... config is
275 0x09, /* __u8 if_bLength; */
276 0x04, /* __u8 if_bDescriptorType; Interface */
277 0x00, /* __u8 if_bInterfaceNumber; */
278 0x00, /* __u8 if_bAlternateSetting; */
279 0x01, /* __u8 if_bNumEndpoints; */
280 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
281 0x00, /* __u8 if_bInterfaceSubClass; */
282 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
283 0x00, /* __u8 if_iInterface; */
285 /* one endpoint (status change endpoint) */
286 0x07, /* __u8 ep_bLength; */
287 0x05, /* __u8 ep_bDescriptorType; Endpoint */
288 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
289 0x03, /* __u8 ep_bmAttributes; Interrupt */
290 /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8)
291 * see hub.c:hub_configure() for details. */
292 (USB_MAXCHILDREN
+ 1 + 7) / 8, 0x00,
293 0x0c /* __u8 ep_bInterval; (256ms -- usb 2.0 spec) */
296 static const u8 ss_rh_config_descriptor
[] = {
297 /* one configuration */
298 0x09, /* __u8 bLength; */
299 0x02, /* __u8 bDescriptorType; Configuration */
300 0x1f, 0x00, /* __le16 wTotalLength; */
301 0x01, /* __u8 bNumInterfaces; (1) */
302 0x01, /* __u8 bConfigurationValue; */
303 0x00, /* __u8 iConfiguration; */
304 0xc0, /* __u8 bmAttributes;
309 0x00, /* __u8 MaxPower; */
312 0x09, /* __u8 if_bLength; */
313 0x04, /* __u8 if_bDescriptorType; Interface */
314 0x00, /* __u8 if_bInterfaceNumber; */
315 0x00, /* __u8 if_bAlternateSetting; */
316 0x01, /* __u8 if_bNumEndpoints; */
317 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
318 0x00, /* __u8 if_bInterfaceSubClass; */
319 0x00, /* __u8 if_bInterfaceProtocol; */
320 0x00, /* __u8 if_iInterface; */
322 /* one endpoint (status change endpoint) */
323 0x07, /* __u8 ep_bLength; */
324 0x05, /* __u8 ep_bDescriptorType; Endpoint */
325 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
326 0x03, /* __u8 ep_bmAttributes; Interrupt */
327 /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8)
328 * see hub.c:hub_configure() for details. */
329 (USB_MAXCHILDREN
+ 1 + 7) / 8, 0x00,
330 0x0c, /* __u8 ep_bInterval; (256ms -- usb 2.0 spec) */
332 /* one SuperSpeed endpoint companion descriptor */
333 0x06, /* __u8 ss_bLength */
334 0x30, /* __u8 ss_bDescriptorType; SuperSpeed EP Companion */
335 0x00, /* __u8 ss_bMaxBurst; allows 1 TX between ACKs */
336 0x00, /* __u8 ss_bmAttributes; 1 packet per service interval */
337 0x02, 0x00 /* __le16 ss_wBytesPerInterval; 15 bits for max 15 ports */
340 /* authorized_default behaviour:
341 * -1 is authorized for all devices except wireless (old behaviour)
342 * 0 is unauthorized for all devices
343 * 1 is authorized for all devices
345 static int authorized_default
= -1;
346 module_param(authorized_default
, int, S_IRUGO
|S_IWUSR
);
347 MODULE_PARM_DESC(authorized_default
,
348 "Default USB device authorization: 0 is not authorized, 1 is "
349 "authorized, -1 is authorized except for wireless USB (default, "
351 /*-------------------------------------------------------------------------*/
354 * ascii2desc() - Helper routine for producing UTF-16LE string descriptors
355 * @s: Null-terminated ASCII (actually ISO-8859-1) string
356 * @buf: Buffer for USB string descriptor (header + UTF-16LE)
357 * @len: Length (in bytes; may be odd) of descriptor buffer.
359 * The return value is the number of bytes filled in: 2 + 2*strlen(s) or
360 * buflen, whichever is less.
362 * USB String descriptors can contain at most 126 characters; input
363 * strings longer than that are truncated.
366 ascii2desc(char const *s
, u8
*buf
, unsigned len
)
368 unsigned n
, t
= 2 + 2*strlen(s
);
371 t
= 254; /* Longest possible UTF string descriptor */
375 t
+= USB_DT_STRING
<< 8; /* Now t is first 16 bits to store */
383 t
= (unsigned char)*s
++;
389 * rh_string() - provides string descriptors for root hub
390 * @id: the string ID number (0: langids, 1: serial #, 2: product, 3: vendor)
391 * @hcd: the host controller for this root hub
392 * @data: buffer for output packet
393 * @len: length of the provided buffer
395 * Produces either a manufacturer, product or serial number string for the
396 * virtual root hub device.
397 * Returns the number of bytes filled in: the length of the descriptor or
398 * of the provided buffer, whichever is less.
401 rh_string(int id
, struct usb_hcd
const *hcd
, u8
*data
, unsigned len
)
405 static char const langids
[4] = {4, USB_DT_STRING
, 0x09, 0x04};
410 /* Array of LANGID codes (0x0409 is MSFT-speak for "en-us") */
411 /* See http://www.usb.org/developers/docs/USB_LANGIDs.pdf */
414 memcpy(data
, langids
, len
);
418 s
= hcd
->self
.bus_name
;
422 s
= hcd
->product_desc
;
426 snprintf (buf
, sizeof buf
, "%s %s %s", init_utsname()->sysname
,
427 init_utsname()->release
, hcd
->driver
->description
);
431 /* Can't happen; caller guarantees it */
435 return ascii2desc(s
, data
, len
);
439 /* Root hub control transfers execute synchronously */
440 static int rh_call_control (struct usb_hcd
*hcd
, struct urb
*urb
)
442 struct usb_ctrlrequest
*cmd
;
443 u16 typeReq
, wValue
, wIndex
, wLength
;
444 u8
*ubuf
= urb
->transfer_buffer
;
446 * tbuf should be as big as the BOS descriptor and
447 * the USB hub descriptor.
449 u8 tbuf
[USB_DT_BOS_SIZE
+ USB_DT_USB_SS_CAP_SIZE
]
450 __attribute__((aligned(4)));
451 const u8
*bufp
= tbuf
;
455 u8 patch_protocol
= 0;
459 spin_lock_irq(&hcd_root_hub_lock
);
460 status
= usb_hcd_link_urb_to_ep(hcd
, urb
);
461 spin_unlock_irq(&hcd_root_hub_lock
);
464 urb
->hcpriv
= hcd
; /* Indicate it's queued */
466 cmd
= (struct usb_ctrlrequest
*) urb
->setup_packet
;
467 typeReq
= (cmd
->bRequestType
<< 8) | cmd
->bRequest
;
468 wValue
= le16_to_cpu (cmd
->wValue
);
469 wIndex
= le16_to_cpu (cmd
->wIndex
);
470 wLength
= le16_to_cpu (cmd
->wLength
);
472 if (wLength
> urb
->transfer_buffer_length
)
475 urb
->actual_length
= 0;
478 /* DEVICE REQUESTS */
480 /* The root hub's remote wakeup enable bit is implemented using
481 * driver model wakeup flags. If this system supports wakeup
482 * through USB, userspace may change the default "allow wakeup"
483 * policy through sysfs or these calls.
485 * Most root hubs support wakeup from downstream devices, for
486 * runtime power management (disabling USB clocks and reducing
487 * VBUS power usage). However, not all of them do so; silicon,
488 * board, and BIOS bugs here are not uncommon, so these can't
489 * be treated quite like external hubs.
491 * Likewise, not all root hubs will pass wakeup events upstream,
492 * to wake up the whole system. So don't assume root hub and
493 * controller capabilities are identical.
496 case DeviceRequest
| USB_REQ_GET_STATUS
:
497 tbuf
[0] = (device_may_wakeup(&hcd
->self
.root_hub
->dev
)
498 << USB_DEVICE_REMOTE_WAKEUP
)
499 | (1 << USB_DEVICE_SELF_POWERED
);
503 case DeviceOutRequest
| USB_REQ_CLEAR_FEATURE
:
504 if (wValue
== USB_DEVICE_REMOTE_WAKEUP
)
505 device_set_wakeup_enable(&hcd
->self
.root_hub
->dev
, 0);
509 case DeviceOutRequest
| USB_REQ_SET_FEATURE
:
510 if (device_can_wakeup(&hcd
->self
.root_hub
->dev
)
511 && wValue
== USB_DEVICE_REMOTE_WAKEUP
)
512 device_set_wakeup_enable(&hcd
->self
.root_hub
->dev
, 1);
516 case DeviceRequest
| USB_REQ_GET_CONFIGURATION
:
520 case DeviceOutRequest
| USB_REQ_SET_CONFIGURATION
:
522 case DeviceRequest
| USB_REQ_GET_DESCRIPTOR
:
523 switch (wValue
& 0xff00) {
524 case USB_DT_DEVICE
<< 8:
525 switch (hcd
->speed
) {
527 bufp
= usb3_rh_dev_descriptor
;
530 bufp
= usb2_rh_dev_descriptor
;
533 bufp
= usb11_rh_dev_descriptor
;
542 case USB_DT_CONFIG
<< 8:
543 switch (hcd
->speed
) {
545 bufp
= ss_rh_config_descriptor
;
546 len
= sizeof ss_rh_config_descriptor
;
549 bufp
= hs_rh_config_descriptor
;
550 len
= sizeof hs_rh_config_descriptor
;
553 bufp
= fs_rh_config_descriptor
;
554 len
= sizeof fs_rh_config_descriptor
;
559 if (device_can_wakeup(&hcd
->self
.root_hub
->dev
))
562 case USB_DT_STRING
<< 8:
563 if ((wValue
& 0xff) < 4)
564 urb
->actual_length
= rh_string(wValue
& 0xff,
566 else /* unsupported IDs --> "protocol stall" */
569 case USB_DT_BOS
<< 8:
575 case DeviceRequest
| USB_REQ_GET_INTERFACE
:
579 case DeviceOutRequest
| USB_REQ_SET_INTERFACE
:
581 case DeviceOutRequest
| USB_REQ_SET_ADDRESS
:
582 // wValue == urb->dev->devaddr
583 dev_dbg (hcd
->self
.controller
, "root hub device address %d\n",
587 /* INTERFACE REQUESTS (no defined feature/status flags) */
589 /* ENDPOINT REQUESTS */
591 case EndpointRequest
| USB_REQ_GET_STATUS
:
592 // ENDPOINT_HALT flag
597 case EndpointOutRequest
| USB_REQ_CLEAR_FEATURE
:
598 case EndpointOutRequest
| USB_REQ_SET_FEATURE
:
599 dev_dbg (hcd
->self
.controller
, "no endpoint features yet\n");
602 /* CLASS REQUESTS (and errors) */
606 /* non-generic request */
612 case GetHubDescriptor
:
613 len
= sizeof (struct usb_hub_descriptor
);
615 case DeviceRequest
| USB_REQ_GET_DESCRIPTOR
:
616 /* len is returned by hub_control */
619 status
= hcd
->driver
->hub_control (hcd
,
620 typeReq
, wValue
, wIndex
,
624 /* "protocol stall" on error */
630 if (status
!= -EPIPE
) {
631 dev_dbg (hcd
->self
.controller
,
632 "CTRL: TypeReq=0x%x val=0x%x "
633 "idx=0x%x len=%d ==> %d\n",
634 typeReq
, wValue
, wIndex
,
637 } else if (status
> 0) {
638 /* hub_control may return the length of data copied. */
643 if (urb
->transfer_buffer_length
< len
)
644 len
= urb
->transfer_buffer_length
;
645 urb
->actual_length
= len
;
646 // always USB_DIR_IN, toward host
647 memcpy (ubuf
, bufp
, len
);
649 /* report whether RH hardware supports remote wakeup */
651 len
> offsetof (struct usb_config_descriptor
,
653 ((struct usb_config_descriptor
*)ubuf
)->bmAttributes
654 |= USB_CONFIG_ATT_WAKEUP
;
656 /* report whether RH hardware has an integrated TT */
657 if (patch_protocol
&&
658 len
> offsetof(struct usb_device_descriptor
,
660 ((struct usb_device_descriptor
*) ubuf
)->
661 bDeviceProtocol
= USB_HUB_PR_HS_SINGLE_TT
;
664 /* any errors get returned through the urb completion */
665 spin_lock_irq(&hcd_root_hub_lock
);
666 usb_hcd_unlink_urb_from_ep(hcd
, urb
);
668 /* This peculiar use of spinlocks echoes what real HC drivers do.
669 * Avoiding calls to local_irq_disable/enable makes the code
672 spin_unlock(&hcd_root_hub_lock
);
673 usb_hcd_giveback_urb(hcd
, urb
, status
);
674 spin_lock(&hcd_root_hub_lock
);
676 spin_unlock_irq(&hcd_root_hub_lock
);
680 /*-------------------------------------------------------------------------*/
683 * Root Hub interrupt transfers are polled using a timer if the
684 * driver requests it; otherwise the driver is responsible for
685 * calling usb_hcd_poll_rh_status() when an event occurs.
687 * Completions are called in_interrupt(), but they may or may not
690 void usb_hcd_poll_rh_status(struct usb_hcd
*hcd
)
695 char buffer
[6]; /* Any root hubs with > 31 ports? */
697 if (unlikely(!hcd
->rh_pollable
))
699 if (!hcd
->uses_new_polling
&& !hcd
->status_urb
)
702 length
= hcd
->driver
->hub_status_data(hcd
, buffer
);
705 /* try to complete the status urb */
706 spin_lock_irqsave(&hcd_root_hub_lock
, flags
);
707 urb
= hcd
->status_urb
;
709 clear_bit(HCD_FLAG_POLL_PENDING
, &hcd
->flags
);
710 hcd
->status_urb
= NULL
;
711 urb
->actual_length
= length
;
712 memcpy(urb
->transfer_buffer
, buffer
, length
);
714 usb_hcd_unlink_urb_from_ep(hcd
, urb
);
715 spin_unlock(&hcd_root_hub_lock
);
716 usb_hcd_giveback_urb(hcd
, urb
, 0);
717 spin_lock(&hcd_root_hub_lock
);
720 set_bit(HCD_FLAG_POLL_PENDING
, &hcd
->flags
);
722 spin_unlock_irqrestore(&hcd_root_hub_lock
, flags
);
725 /* The USB 2.0 spec says 256 ms. This is close enough and won't
726 * exceed that limit if HZ is 100. The math is more clunky than
727 * maybe expected, this is to make sure that all timers for USB devices
728 * fire at the same time to give the CPU a break in between */
729 if (hcd
->uses_new_polling
? HCD_POLL_RH(hcd
) :
730 (length
== 0 && hcd
->status_urb
!= NULL
))
731 mod_timer (&hcd
->rh_timer
, (jiffies
/(HZ
/4) + 1) * (HZ
/4));
733 EXPORT_SYMBOL_GPL(usb_hcd_poll_rh_status
);
736 static void rh_timer_func (unsigned long _hcd
)
738 usb_hcd_poll_rh_status((struct usb_hcd
*) _hcd
);
741 /*-------------------------------------------------------------------------*/
743 static int rh_queue_status (struct usb_hcd
*hcd
, struct urb
*urb
)
747 unsigned len
= 1 + (urb
->dev
->maxchild
/ 8);
749 spin_lock_irqsave (&hcd_root_hub_lock
, flags
);
750 if (hcd
->status_urb
|| urb
->transfer_buffer_length
< len
) {
751 dev_dbg (hcd
->self
.controller
, "not queuing rh status urb\n");
756 retval
= usb_hcd_link_urb_to_ep(hcd
, urb
);
760 hcd
->status_urb
= urb
;
761 urb
->hcpriv
= hcd
; /* indicate it's queued */
762 if (!hcd
->uses_new_polling
)
763 mod_timer(&hcd
->rh_timer
, (jiffies
/(HZ
/4) + 1) * (HZ
/4));
765 /* If a status change has already occurred, report it ASAP */
766 else if (HCD_POLL_PENDING(hcd
))
767 mod_timer(&hcd
->rh_timer
, jiffies
);
770 spin_unlock_irqrestore (&hcd_root_hub_lock
, flags
);
774 static int rh_urb_enqueue (struct usb_hcd
*hcd
, struct urb
*urb
)
776 if (usb_endpoint_xfer_int(&urb
->ep
->desc
))
777 return rh_queue_status (hcd
, urb
);
778 if (usb_endpoint_xfer_control(&urb
->ep
->desc
))
779 return rh_call_control (hcd
, urb
);
783 /*-------------------------------------------------------------------------*/
785 /* Unlinks of root-hub control URBs are legal, but they don't do anything
786 * since these URBs always execute synchronously.
788 static int usb_rh_urb_dequeue(struct usb_hcd
*hcd
, struct urb
*urb
, int status
)
793 spin_lock_irqsave(&hcd_root_hub_lock
, flags
);
794 rc
= usb_hcd_check_unlink_urb(hcd
, urb
, status
);
798 if (usb_endpoint_num(&urb
->ep
->desc
) == 0) { /* Control URB */
801 } else { /* Status URB */
802 if (!hcd
->uses_new_polling
)
803 del_timer (&hcd
->rh_timer
);
804 if (urb
== hcd
->status_urb
) {
805 hcd
->status_urb
= NULL
;
806 usb_hcd_unlink_urb_from_ep(hcd
, urb
);
808 spin_unlock(&hcd_root_hub_lock
);
809 usb_hcd_giveback_urb(hcd
, urb
, status
);
810 spin_lock(&hcd_root_hub_lock
);
814 spin_unlock_irqrestore(&hcd_root_hub_lock
, flags
);
821 * Show & store the current value of authorized_default
823 static ssize_t
usb_host_authorized_default_show(struct device
*dev
,
824 struct device_attribute
*attr
,
827 struct usb_device
*rh_usb_dev
= to_usb_device(dev
);
828 struct usb_bus
*usb_bus
= rh_usb_dev
->bus
;
829 struct usb_hcd
*usb_hcd
;
831 if (usb_bus
== NULL
) /* FIXME: not sure if this case is possible */
833 usb_hcd
= bus_to_hcd(usb_bus
);
834 return snprintf(buf
, PAGE_SIZE
, "%u\n", usb_hcd
->authorized_default
);
837 static ssize_t
usb_host_authorized_default_store(struct device
*dev
,
838 struct device_attribute
*attr
,
839 const char *buf
, size_t size
)
843 struct usb_device
*rh_usb_dev
= to_usb_device(dev
);
844 struct usb_bus
*usb_bus
= rh_usb_dev
->bus
;
845 struct usb_hcd
*usb_hcd
;
847 if (usb_bus
== NULL
) /* FIXME: not sure if this case is possible */
849 usb_hcd
= bus_to_hcd(usb_bus
);
850 result
= sscanf(buf
, "%u\n", &val
);
852 usb_hcd
->authorized_default
= val
? 1 : 0;
860 static DEVICE_ATTR(authorized_default
, 0644,
861 usb_host_authorized_default_show
,
862 usb_host_authorized_default_store
);
865 /* Group all the USB bus attributes */
866 static struct attribute
*usb_bus_attrs
[] = {
867 &dev_attr_authorized_default
.attr
,
871 static struct attribute_group usb_bus_attr_group
= {
872 .name
= NULL
, /* we want them in the same directory */
873 .attrs
= usb_bus_attrs
,
878 /*-------------------------------------------------------------------------*/
881 * usb_bus_init - shared initialization code
882 * @bus: the bus structure being initialized
884 * This code is used to initialize a usb_bus structure, memory for which is
885 * separately managed.
887 static void usb_bus_init (struct usb_bus
*bus
)
889 memset (&bus
->devmap
, 0, sizeof(struct usb_devmap
));
891 bus
->devnum_next
= 1;
893 bus
->root_hub
= NULL
;
895 bus
->bandwidth_allocated
= 0;
896 bus
->bandwidth_int_reqs
= 0;
897 bus
->bandwidth_isoc_reqs
= 0;
899 INIT_LIST_HEAD (&bus
->bus_list
);
902 /*-------------------------------------------------------------------------*/
905 * usb_register_bus - registers the USB host controller with the usb core
906 * @bus: pointer to the bus to register
907 * Context: !in_interrupt()
909 * Assigns a bus number, and links the controller into usbcore data
910 * structures so that it can be seen by scanning the bus list.
912 static int usb_register_bus(struct usb_bus
*bus
)
917 mutex_lock(&usb_bus_list_lock
);
918 busnum
= find_next_zero_bit (busmap
.busmap
, USB_MAXBUS
, 1);
919 if (busnum
>= USB_MAXBUS
) {
920 printk (KERN_ERR
"%s: too many buses\n", usbcore_name
);
921 goto error_find_busnum
;
923 set_bit (busnum
, busmap
.busmap
);
924 bus
->busnum
= busnum
;
926 /* Add it to the local list of buses */
927 list_add (&bus
->bus_list
, &usb_bus_list
);
928 mutex_unlock(&usb_bus_list_lock
);
930 usb_notify_add_bus(bus
);
932 dev_info (bus
->controller
, "new USB bus registered, assigned bus "
933 "number %d\n", bus
->busnum
);
937 mutex_unlock(&usb_bus_list_lock
);
942 * usb_deregister_bus - deregisters the USB host controller
943 * @bus: pointer to the bus to deregister
944 * Context: !in_interrupt()
946 * Recycles the bus number, and unlinks the controller from usbcore data
947 * structures so that it won't be seen by scanning the bus list.
949 static void usb_deregister_bus (struct usb_bus
*bus
)
951 dev_info (bus
->controller
, "USB bus %d deregistered\n", bus
->busnum
);
954 * NOTE: make sure that all the devices are removed by the
955 * controller code, as well as having it call this when cleaning
958 mutex_lock(&usb_bus_list_lock
);
959 list_del (&bus
->bus_list
);
960 mutex_unlock(&usb_bus_list_lock
);
962 usb_notify_remove_bus(bus
);
964 clear_bit (bus
->busnum
, busmap
.busmap
);
968 * register_root_hub - called by usb_add_hcd() to register a root hub
969 * @hcd: host controller for this root hub
971 * This function registers the root hub with the USB subsystem. It sets up
972 * the device properly in the device tree and then calls usb_new_device()
973 * to register the usb device. It also assigns the root hub's USB address
976 static int register_root_hub(struct usb_hcd
*hcd
)
978 struct device
*parent_dev
= hcd
->self
.controller
;
979 struct usb_device
*usb_dev
= hcd
->self
.root_hub
;
980 const int devnum
= 1;
983 usb_dev
->devnum
= devnum
;
984 usb_dev
->bus
->devnum_next
= devnum
+ 1;
985 memset (&usb_dev
->bus
->devmap
.devicemap
, 0,
986 sizeof usb_dev
->bus
->devmap
.devicemap
);
987 set_bit (devnum
, usb_dev
->bus
->devmap
.devicemap
);
988 usb_set_device_state(usb_dev
, USB_STATE_ADDRESS
);
990 mutex_lock(&usb_bus_list_lock
);
992 usb_dev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(64);
993 retval
= usb_get_device_descriptor(usb_dev
, USB_DT_DEVICE_SIZE
);
994 if (retval
!= sizeof usb_dev
->descriptor
) {
995 mutex_unlock(&usb_bus_list_lock
);
996 dev_dbg (parent_dev
, "can't read %s device descriptor %d\n",
997 dev_name(&usb_dev
->dev
), retval
);
998 return (retval
< 0) ? retval
: -EMSGSIZE
;
1000 if (usb_dev
->speed
== USB_SPEED_SUPER
) {
1001 retval
= usb_get_bos_descriptor(usb_dev
);
1003 mutex_unlock(&usb_bus_list_lock
);
1004 dev_dbg(parent_dev
, "can't read %s bos descriptor %d\n",
1005 dev_name(&usb_dev
->dev
), retval
);
1010 retval
= usb_new_device (usb_dev
);
1012 dev_err (parent_dev
, "can't register root hub for %s, %d\n",
1013 dev_name(&usb_dev
->dev
), retval
);
1015 spin_lock_irq (&hcd_root_hub_lock
);
1016 hcd
->rh_registered
= 1;
1017 spin_unlock_irq (&hcd_root_hub_lock
);
1019 /* Did the HC die before the root hub was registered? */
1021 usb_hc_died (hcd
); /* This time clean up */
1023 mutex_unlock(&usb_bus_list_lock
);
1029 /*-------------------------------------------------------------------------*/
1032 * usb_calc_bus_time - approximate periodic transaction time in nanoseconds
1033 * @speed: from dev->speed; USB_SPEED_{LOW,FULL,HIGH}
1034 * @is_input: true iff the transaction sends data to the host
1035 * @isoc: true for isochronous transactions, false for interrupt ones
1036 * @bytecount: how many bytes in the transaction.
1038 * Returns approximate bus time in nanoseconds for a periodic transaction.
1039 * See USB 2.0 spec section 5.11.3; only periodic transfers need to be
1040 * scheduled in software, this function is only used for such scheduling.
1042 long usb_calc_bus_time (int speed
, int is_input
, int isoc
, int bytecount
)
1047 case USB_SPEED_LOW
: /* INTR only */
1049 tmp
= (67667L * (31L + 10L * BitTime (bytecount
))) / 1000L;
1050 return (64060L + (2 * BW_HUB_LS_SETUP
) + BW_HOST_DELAY
+ tmp
);
1052 tmp
= (66700L * (31L + 10L * BitTime (bytecount
))) / 1000L;
1053 return (64107L + (2 * BW_HUB_LS_SETUP
) + BW_HOST_DELAY
+ tmp
);
1055 case USB_SPEED_FULL
: /* ISOC or INTR */
1057 tmp
= (8354L * (31L + 10L * BitTime (bytecount
))) / 1000L;
1058 return (((is_input
) ? 7268L : 6265L) + BW_HOST_DELAY
+ tmp
);
1060 tmp
= (8354L * (31L + 10L * BitTime (bytecount
))) / 1000L;
1061 return (9107L + BW_HOST_DELAY
+ tmp
);
1063 case USB_SPEED_HIGH
: /* ISOC or INTR */
1064 // FIXME adjust for input vs output
1066 tmp
= HS_NSECS_ISO (bytecount
);
1068 tmp
= HS_NSECS (bytecount
);
1071 pr_debug ("%s: bogus device speed!\n", usbcore_name
);
1075 EXPORT_SYMBOL_GPL(usb_calc_bus_time
);
1078 /*-------------------------------------------------------------------------*/
1081 * Generic HC operations.
1084 /*-------------------------------------------------------------------------*/
1087 * usb_hcd_link_urb_to_ep - add an URB to its endpoint queue
1088 * @hcd: host controller to which @urb was submitted
1089 * @urb: URB being submitted
1091 * Host controller drivers should call this routine in their enqueue()
1092 * method. The HCD's private spinlock must be held and interrupts must
1093 * be disabled. The actions carried out here are required for URB
1094 * submission, as well as for endpoint shutdown and for usb_kill_urb.
1096 * Returns 0 for no error, otherwise a negative error code (in which case
1097 * the enqueue() method must fail). If no error occurs but enqueue() fails
1098 * anyway, it must call usb_hcd_unlink_urb_from_ep() before releasing
1099 * the private spinlock and returning.
1101 int usb_hcd_link_urb_to_ep(struct usb_hcd
*hcd
, struct urb
*urb
)
1105 spin_lock(&hcd_urb_list_lock
);
1107 /* Check that the URB isn't being killed */
1108 if (unlikely(atomic_read(&urb
->reject
))) {
1113 if (unlikely(!urb
->ep
->enabled
)) {
1118 if (unlikely(!urb
->dev
->can_submit
)) {
1124 * Check the host controller's state and add the URB to the
1127 if (HCD_RH_RUNNING(hcd
)) {
1129 list_add_tail(&urb
->urb_list
, &urb
->ep
->urb_list
);
1135 spin_unlock(&hcd_urb_list_lock
);
1138 EXPORT_SYMBOL_GPL(usb_hcd_link_urb_to_ep
);
1141 * usb_hcd_check_unlink_urb - check whether an URB may be unlinked
1142 * @hcd: host controller to which @urb was submitted
1143 * @urb: URB being checked for unlinkability
1144 * @status: error code to store in @urb if the unlink succeeds
1146 * Host controller drivers should call this routine in their dequeue()
1147 * method. The HCD's private spinlock must be held and interrupts must
1148 * be disabled. The actions carried out here are required for making
1149 * sure than an unlink is valid.
1151 * Returns 0 for no error, otherwise a negative error code (in which case
1152 * the dequeue() method must fail). The possible error codes are:
1154 * -EIDRM: @urb was not submitted or has already completed.
1155 * The completion function may not have been called yet.
1157 * -EBUSY: @urb has already been unlinked.
1159 int usb_hcd_check_unlink_urb(struct usb_hcd
*hcd
, struct urb
*urb
,
1162 struct list_head
*tmp
;
1164 /* insist the urb is still queued */
1165 list_for_each(tmp
, &urb
->ep
->urb_list
) {
1166 if (tmp
== &urb
->urb_list
)
1169 if (tmp
!= &urb
->urb_list
)
1172 /* Any status except -EINPROGRESS means something already started to
1173 * unlink this URB from the hardware. So there's no more work to do.
1177 urb
->unlinked
= status
;
1180 EXPORT_SYMBOL_GPL(usb_hcd_check_unlink_urb
);
1183 * usb_hcd_unlink_urb_from_ep - remove an URB from its endpoint queue
1184 * @hcd: host controller to which @urb was submitted
1185 * @urb: URB being unlinked
1187 * Host controller drivers should call this routine before calling
1188 * usb_hcd_giveback_urb(). The HCD's private spinlock must be held and
1189 * interrupts must be disabled. The actions carried out here are required
1190 * for URB completion.
1192 void usb_hcd_unlink_urb_from_ep(struct usb_hcd
*hcd
, struct urb
*urb
)
1194 /* clear all state linking urb to this dev (and hcd) */
1195 spin_lock(&hcd_urb_list_lock
);
1196 list_del_init(&urb
->urb_list
);
1197 spin_unlock(&hcd_urb_list_lock
);
1199 EXPORT_SYMBOL_GPL(usb_hcd_unlink_urb_from_ep
);
1202 * Some usb host controllers can only perform dma using a small SRAM area.
1203 * The usb core itself is however optimized for host controllers that can dma
1204 * using regular system memory - like pci devices doing bus mastering.
1206 * To support host controllers with limited dma capabilites we provide dma
1207 * bounce buffers. This feature can be enabled using the HCD_LOCAL_MEM flag.
1208 * For this to work properly the host controller code must first use the
1209 * function dma_declare_coherent_memory() to point out which memory area
1210 * that should be used for dma allocations.
1212 * The HCD_LOCAL_MEM flag then tells the usb code to allocate all data for
1213 * dma using dma_alloc_coherent() which in turn allocates from the memory
1214 * area pointed out with dma_declare_coherent_memory().
1216 * So, to summarize...
1218 * - We need "local" memory, canonical example being
1219 * a small SRAM on a discrete controller being the
1220 * only memory that the controller can read ...
1221 * (a) "normal" kernel memory is no good, and
1222 * (b) there's not enough to share
1224 * - The only *portable* hook for such stuff in the
1225 * DMA framework is dma_declare_coherent_memory()
1227 * - So we use that, even though the primary requirement
1228 * is that the memory be "local" (hence addressible
1229 * by that device), not "coherent".
1233 static int hcd_alloc_coherent(struct usb_bus
*bus
,
1234 gfp_t mem_flags
, dma_addr_t
*dma_handle
,
1235 void **vaddr_handle
, size_t size
,
1236 enum dma_data_direction dir
)
1238 unsigned char *vaddr
;
1240 if (*vaddr_handle
== NULL
) {
1245 vaddr
= hcd_buffer_alloc(bus
, size
+ sizeof(vaddr
),
1246 mem_flags
, dma_handle
);
1251 * Store the virtual address of the buffer at the end
1252 * of the allocated dma buffer. The size of the buffer
1253 * may be uneven so use unaligned functions instead
1254 * of just rounding up. It makes sense to optimize for
1255 * memory footprint over access speed since the amount
1256 * of memory available for dma may be limited.
1258 put_unaligned((unsigned long)*vaddr_handle
,
1259 (unsigned long *)(vaddr
+ size
));
1261 if (dir
== DMA_TO_DEVICE
)
1262 memcpy(vaddr
, *vaddr_handle
, size
);
1264 *vaddr_handle
= vaddr
;
1268 static void hcd_free_coherent(struct usb_bus
*bus
, dma_addr_t
*dma_handle
,
1269 void **vaddr_handle
, size_t size
,
1270 enum dma_data_direction dir
)
1272 unsigned char *vaddr
= *vaddr_handle
;
1274 vaddr
= (void *)get_unaligned((unsigned long *)(vaddr
+ size
));
1276 if (dir
== DMA_FROM_DEVICE
)
1277 memcpy(vaddr
, *vaddr_handle
, size
);
1279 hcd_buffer_free(bus
, size
+ sizeof(vaddr
), *vaddr_handle
, *dma_handle
);
1281 *vaddr_handle
= vaddr
;
1285 void usb_hcd_unmap_urb_setup_for_dma(struct usb_hcd
*hcd
, struct urb
*urb
)
1287 if (urb
->transfer_flags
& URB_SETUP_MAP_SINGLE
)
1288 dma_unmap_single(hcd
->self
.controller
,
1290 sizeof(struct usb_ctrlrequest
),
1292 else if (urb
->transfer_flags
& URB_SETUP_MAP_LOCAL
)
1293 hcd_free_coherent(urb
->dev
->bus
,
1295 (void **) &urb
->setup_packet
,
1296 sizeof(struct usb_ctrlrequest
),
1299 /* Make it safe to call this routine more than once */
1300 urb
->transfer_flags
&= ~(URB_SETUP_MAP_SINGLE
| URB_SETUP_MAP_LOCAL
);
1302 EXPORT_SYMBOL_GPL(usb_hcd_unmap_urb_setup_for_dma
);
1304 static void unmap_urb_for_dma(struct usb_hcd
*hcd
, struct urb
*urb
)
1306 if (hcd
->driver
->unmap_urb_for_dma
)
1307 hcd
->driver
->unmap_urb_for_dma(hcd
, urb
);
1309 usb_hcd_unmap_urb_for_dma(hcd
, urb
);
1312 void usb_hcd_unmap_urb_for_dma(struct usb_hcd
*hcd
, struct urb
*urb
)
1314 enum dma_data_direction dir
;
1316 usb_hcd_unmap_urb_setup_for_dma(hcd
, urb
);
1318 dir
= usb_urb_dir_in(urb
) ? DMA_FROM_DEVICE
: DMA_TO_DEVICE
;
1319 if (urb
->transfer_flags
& URB_DMA_MAP_SG
)
1320 dma_unmap_sg(hcd
->self
.controller
,
1324 else if (urb
->transfer_flags
& URB_DMA_MAP_PAGE
)
1325 dma_unmap_page(hcd
->self
.controller
,
1327 urb
->transfer_buffer_length
,
1329 else if (urb
->transfer_flags
& URB_DMA_MAP_SINGLE
)
1330 dma_unmap_single(hcd
->self
.controller
,
1332 urb
->transfer_buffer_length
,
1334 else if (urb
->transfer_flags
& URB_MAP_LOCAL
)
1335 hcd_free_coherent(urb
->dev
->bus
,
1337 &urb
->transfer_buffer
,
1338 urb
->transfer_buffer_length
,
1341 /* Make it safe to call this routine more than once */
1342 urb
->transfer_flags
&= ~(URB_DMA_MAP_SG
| URB_DMA_MAP_PAGE
|
1343 URB_DMA_MAP_SINGLE
| URB_MAP_LOCAL
);
1345 EXPORT_SYMBOL_GPL(usb_hcd_unmap_urb_for_dma
);
1347 static int map_urb_for_dma(struct usb_hcd
*hcd
, struct urb
*urb
,
1350 if (hcd
->driver
->map_urb_for_dma
)
1351 return hcd
->driver
->map_urb_for_dma(hcd
, urb
, mem_flags
);
1353 return usb_hcd_map_urb_for_dma(hcd
, urb
, mem_flags
);
1356 int usb_hcd_map_urb_for_dma(struct usb_hcd
*hcd
, struct urb
*urb
,
1359 enum dma_data_direction dir
;
1362 /* Map the URB's buffers for DMA access.
1363 * Lower level HCD code should use *_dma exclusively,
1364 * unless it uses pio or talks to another transport,
1365 * or uses the provided scatter gather list for bulk.
1368 if (usb_endpoint_xfer_control(&urb
->ep
->desc
)) {
1369 if (hcd
->self
.uses_pio_for_control
)
1371 if (hcd
->self
.uses_dma
) {
1372 urb
->setup_dma
= dma_map_single(
1373 hcd
->self
.controller
,
1375 sizeof(struct usb_ctrlrequest
),
1377 if (dma_mapping_error(hcd
->self
.controller
,
1380 urb
->transfer_flags
|= URB_SETUP_MAP_SINGLE
;
1381 } else if (hcd
->driver
->flags
& HCD_LOCAL_MEM
) {
1382 ret
= hcd_alloc_coherent(
1383 urb
->dev
->bus
, mem_flags
,
1385 (void **)&urb
->setup_packet
,
1386 sizeof(struct usb_ctrlrequest
),
1390 urb
->transfer_flags
|= URB_SETUP_MAP_LOCAL
;
1394 dir
= usb_urb_dir_in(urb
) ? DMA_FROM_DEVICE
: DMA_TO_DEVICE
;
1395 if (urb
->transfer_buffer_length
!= 0
1396 && !(urb
->transfer_flags
& URB_NO_TRANSFER_DMA_MAP
)) {
1397 if (hcd
->self
.uses_dma
) {
1401 /* We don't support sg for isoc transfers ! */
1402 if (usb_endpoint_xfer_isoc(&urb
->ep
->desc
)) {
1408 hcd
->self
.controller
,
1415 urb
->transfer_flags
|= URB_DMA_MAP_SG
;
1416 urb
->num_mapped_sgs
= n
;
1417 if (n
!= urb
->num_sgs
)
1418 urb
->transfer_flags
|=
1419 URB_DMA_SG_COMBINED
;
1420 } else if (urb
->sg
) {
1421 struct scatterlist
*sg
= urb
->sg
;
1422 urb
->transfer_dma
= dma_map_page(
1423 hcd
->self
.controller
,
1426 urb
->transfer_buffer_length
,
1428 if (dma_mapping_error(hcd
->self
.controller
,
1432 urb
->transfer_flags
|= URB_DMA_MAP_PAGE
;
1434 urb
->transfer_dma
= dma_map_single(
1435 hcd
->self
.controller
,
1436 urb
->transfer_buffer
,
1437 urb
->transfer_buffer_length
,
1439 if (dma_mapping_error(hcd
->self
.controller
,
1443 urb
->transfer_flags
|= URB_DMA_MAP_SINGLE
;
1445 } else if (hcd
->driver
->flags
& HCD_LOCAL_MEM
) {
1446 ret
= hcd_alloc_coherent(
1447 urb
->dev
->bus
, mem_flags
,
1449 &urb
->transfer_buffer
,
1450 urb
->transfer_buffer_length
,
1453 urb
->transfer_flags
|= URB_MAP_LOCAL
;
1455 if (ret
&& (urb
->transfer_flags
& (URB_SETUP_MAP_SINGLE
|
1456 URB_SETUP_MAP_LOCAL
)))
1457 usb_hcd_unmap_urb_for_dma(hcd
, urb
);
1461 EXPORT_SYMBOL_GPL(usb_hcd_map_urb_for_dma
);
1463 /*-------------------------------------------------------------------------*/
1465 /* may be called in any context with a valid urb->dev usecount
1466 * caller surrenders "ownership" of urb
1467 * expects usb_submit_urb() to have sanity checked and conditioned all
1470 int usb_hcd_submit_urb (struct urb
*urb
, gfp_t mem_flags
)
1473 struct usb_hcd
*hcd
= bus_to_hcd(urb
->dev
->bus
);
1475 /* increment urb's reference count as part of giving it to the HCD
1476 * (which will control it). HCD guarantees that it either returns
1477 * an error or calls giveback(), but not both.
1480 atomic_inc(&urb
->use_count
);
1481 atomic_inc(&urb
->dev
->urbnum
);
1482 usbmon_urb_submit(&hcd
->self
, urb
);
1484 /* NOTE requirements on root-hub callers (usbfs and the hub
1485 * driver, for now): URBs' urb->transfer_buffer must be
1486 * valid and usb_buffer_{sync,unmap}() not be needed, since
1487 * they could clobber root hub response data. Also, control
1488 * URBs must be submitted in process context with interrupts
1492 if (is_root_hub(urb
->dev
)) {
1493 status
= rh_urb_enqueue(hcd
, urb
);
1495 status
= map_urb_for_dma(hcd
, urb
, mem_flags
);
1496 if (likely(status
== 0)) {
1497 status
= hcd
->driver
->urb_enqueue(hcd
, urb
, mem_flags
);
1498 if (unlikely(status
))
1499 unmap_urb_for_dma(hcd
, urb
);
1503 if (unlikely(status
)) {
1504 usbmon_urb_submit_error(&hcd
->self
, urb
, status
);
1506 INIT_LIST_HEAD(&urb
->urb_list
);
1507 atomic_dec(&urb
->use_count
);
1508 atomic_dec(&urb
->dev
->urbnum
);
1509 if (atomic_read(&urb
->reject
))
1510 wake_up(&usb_kill_urb_queue
);
1516 /*-------------------------------------------------------------------------*/
1518 /* this makes the hcd giveback() the urb more quickly, by kicking it
1519 * off hardware queues (which may take a while) and returning it as
1520 * soon as practical. we've already set up the urb's return status,
1521 * but we can't know if the callback completed already.
1523 static int unlink1(struct usb_hcd
*hcd
, struct urb
*urb
, int status
)
1527 if (is_root_hub(urb
->dev
))
1528 value
= usb_rh_urb_dequeue(hcd
, urb
, status
);
1531 /* The only reason an HCD might fail this call is if
1532 * it has not yet fully queued the urb to begin with.
1533 * Such failures should be harmless. */
1534 value
= hcd
->driver
->urb_dequeue(hcd
, urb
, status
);
1540 * called in any context
1542 * caller guarantees urb won't be recycled till both unlink()
1543 * and the urb's completion function return
1545 int usb_hcd_unlink_urb (struct urb
*urb
, int status
)
1547 struct usb_hcd
*hcd
;
1548 int retval
= -EIDRM
;
1549 unsigned long flags
;
1551 /* Prevent the device and bus from going away while
1552 * the unlink is carried out. If they are already gone
1553 * then urb->use_count must be 0, since disconnected
1554 * devices can't have any active URBs.
1556 spin_lock_irqsave(&hcd_urb_unlink_lock
, flags
);
1557 if (atomic_read(&urb
->use_count
) > 0) {
1559 usb_get_dev(urb
->dev
);
1561 spin_unlock_irqrestore(&hcd_urb_unlink_lock
, flags
);
1563 hcd
= bus_to_hcd(urb
->dev
->bus
);
1564 retval
= unlink1(hcd
, urb
, status
);
1565 usb_put_dev(urb
->dev
);
1569 retval
= -EINPROGRESS
;
1570 else if (retval
!= -EIDRM
&& retval
!= -EBUSY
)
1571 dev_dbg(&urb
->dev
->dev
, "hcd_unlink_urb %p fail %d\n",
1576 /*-------------------------------------------------------------------------*/
1579 * usb_hcd_giveback_urb - return URB from HCD to device driver
1580 * @hcd: host controller returning the URB
1581 * @urb: urb being returned to the USB device driver.
1582 * @status: completion status code for the URB.
1583 * Context: in_interrupt()
1585 * This hands the URB from HCD to its USB device driver, using its
1586 * completion function. The HCD has freed all per-urb resources
1587 * (and is done using urb->hcpriv). It also released all HCD locks;
1588 * the device driver won't cause problems if it frees, modifies,
1589 * or resubmits this URB.
1591 * If @urb was unlinked, the value of @status will be overridden by
1592 * @urb->unlinked. Erroneous short transfers are detected in case
1593 * the HCD hasn't checked for them.
1595 void usb_hcd_giveback_urb(struct usb_hcd
*hcd
, struct urb
*urb
, int status
)
1598 if (unlikely(urb
->unlinked
))
1599 status
= urb
->unlinked
;
1600 else if (unlikely((urb
->transfer_flags
& URB_SHORT_NOT_OK
) &&
1601 urb
->actual_length
< urb
->transfer_buffer_length
&&
1603 status
= -EREMOTEIO
;
1605 unmap_urb_for_dma(hcd
, urb
);
1606 usbmon_urb_complete(&hcd
->self
, urb
, status
);
1607 usb_unanchor_urb(urb
);
1609 /* pass ownership to the completion handler */
1610 urb
->status
= status
;
1611 urb
->complete (urb
);
1612 atomic_dec (&urb
->use_count
);
1613 if (unlikely(atomic_read(&urb
->reject
)))
1614 wake_up (&usb_kill_urb_queue
);
1617 EXPORT_SYMBOL_GPL(usb_hcd_giveback_urb
);
1619 /*-------------------------------------------------------------------------*/
1621 /* Cancel all URBs pending on this endpoint and wait for the endpoint's
1622 * queue to drain completely. The caller must first insure that no more
1623 * URBs can be submitted for this endpoint.
1625 void usb_hcd_flush_endpoint(struct usb_device
*udev
,
1626 struct usb_host_endpoint
*ep
)
1628 struct usb_hcd
*hcd
;
1634 hcd
= bus_to_hcd(udev
->bus
);
1636 /* No more submits can occur */
1637 spin_lock_irq(&hcd_urb_list_lock
);
1639 list_for_each_entry (urb
, &ep
->urb_list
, urb_list
) {
1645 is_in
= usb_urb_dir_in(urb
);
1646 spin_unlock(&hcd_urb_list_lock
);
1649 unlink1(hcd
, urb
, -ESHUTDOWN
);
1650 dev_dbg (hcd
->self
.controller
,
1651 "shutdown urb %p ep%d%s%s\n",
1652 urb
, usb_endpoint_num(&ep
->desc
),
1653 is_in
? "in" : "out",
1656 switch (usb_endpoint_type(&ep
->desc
)) {
1657 case USB_ENDPOINT_XFER_CONTROL
:
1659 case USB_ENDPOINT_XFER_BULK
:
1661 case USB_ENDPOINT_XFER_INT
:
1670 /* list contents may have changed */
1671 spin_lock(&hcd_urb_list_lock
);
1674 spin_unlock_irq(&hcd_urb_list_lock
);
1676 /* Wait until the endpoint queue is completely empty */
1677 while (!list_empty (&ep
->urb_list
)) {
1678 spin_lock_irq(&hcd_urb_list_lock
);
1680 /* The list may have changed while we acquired the spinlock */
1682 if (!list_empty (&ep
->urb_list
)) {
1683 urb
= list_entry (ep
->urb_list
.prev
, struct urb
,
1687 spin_unlock_irq(&hcd_urb_list_lock
);
1697 * usb_hcd_alloc_bandwidth - check whether a new bandwidth setting exceeds
1699 * @udev: target &usb_device
1700 * @new_config: new configuration to install
1701 * @cur_alt: the current alternate interface setting
1702 * @new_alt: alternate interface setting that is being installed
1704 * To change configurations, pass in the new configuration in new_config,
1705 * and pass NULL for cur_alt and new_alt.
1707 * To reset a device's configuration (put the device in the ADDRESSED state),
1708 * pass in NULL for new_config, cur_alt, and new_alt.
1710 * To change alternate interface settings, pass in NULL for new_config,
1711 * pass in the current alternate interface setting in cur_alt,
1712 * and pass in the new alternate interface setting in new_alt.
1714 * Returns an error if the requested bandwidth change exceeds the
1715 * bus bandwidth or host controller internal resources.
1717 int usb_hcd_alloc_bandwidth(struct usb_device
*udev
,
1718 struct usb_host_config
*new_config
,
1719 struct usb_host_interface
*cur_alt
,
1720 struct usb_host_interface
*new_alt
)
1722 int num_intfs
, i
, j
;
1723 struct usb_host_interface
*alt
= NULL
;
1725 struct usb_hcd
*hcd
;
1726 struct usb_host_endpoint
*ep
;
1728 hcd
= bus_to_hcd(udev
->bus
);
1729 if (!hcd
->driver
->check_bandwidth
)
1732 /* Configuration is being removed - set configuration 0 */
1733 if (!new_config
&& !cur_alt
) {
1734 for (i
= 1; i
< 16; ++i
) {
1735 ep
= udev
->ep_out
[i
];
1737 hcd
->driver
->drop_endpoint(hcd
, udev
, ep
);
1738 ep
= udev
->ep_in
[i
];
1740 hcd
->driver
->drop_endpoint(hcd
, udev
, ep
);
1742 hcd
->driver
->check_bandwidth(hcd
, udev
);
1745 /* Check if the HCD says there's enough bandwidth. Enable all endpoints
1746 * each interface's alt setting 0 and ask the HCD to check the bandwidth
1747 * of the bus. There will always be bandwidth for endpoint 0, so it's
1751 num_intfs
= new_config
->desc
.bNumInterfaces
;
1752 /* Remove endpoints (except endpoint 0, which is always on the
1753 * schedule) from the old config from the schedule
1755 for (i
= 1; i
< 16; ++i
) {
1756 ep
= udev
->ep_out
[i
];
1758 ret
= hcd
->driver
->drop_endpoint(hcd
, udev
, ep
);
1762 ep
= udev
->ep_in
[i
];
1764 ret
= hcd
->driver
->drop_endpoint(hcd
, udev
, ep
);
1769 for (i
= 0; i
< num_intfs
; ++i
) {
1770 struct usb_host_interface
*first_alt
;
1773 first_alt
= &new_config
->intf_cache
[i
]->altsetting
[0];
1774 iface_num
= first_alt
->desc
.bInterfaceNumber
;
1775 /* Set up endpoints for alternate interface setting 0 */
1776 alt
= usb_find_alt_setting(new_config
, iface_num
, 0);
1778 /* No alt setting 0? Pick the first setting. */
1781 for (j
= 0; j
< alt
->desc
.bNumEndpoints
; j
++) {
1782 ret
= hcd
->driver
->add_endpoint(hcd
, udev
, &alt
->endpoint
[j
]);
1788 if (cur_alt
&& new_alt
) {
1789 struct usb_interface
*iface
= usb_ifnum_to_if(udev
,
1790 cur_alt
->desc
.bInterfaceNumber
);
1794 if (iface
->resetting_device
) {
1796 * The USB core just reset the device, so the xHCI host
1797 * and the device will think alt setting 0 is installed.
1798 * However, the USB core will pass in the alternate
1799 * setting installed before the reset as cur_alt. Dig
1800 * out the alternate setting 0 structure, or the first
1801 * alternate setting if a broken device doesn't have alt
1804 cur_alt
= usb_altnum_to_altsetting(iface
, 0);
1806 cur_alt
= &iface
->altsetting
[0];
1809 /* Drop all the endpoints in the current alt setting */
1810 for (i
= 0; i
< cur_alt
->desc
.bNumEndpoints
; i
++) {
1811 ret
= hcd
->driver
->drop_endpoint(hcd
, udev
,
1812 &cur_alt
->endpoint
[i
]);
1816 /* Add all the endpoints in the new alt setting */
1817 for (i
= 0; i
< new_alt
->desc
.bNumEndpoints
; i
++) {
1818 ret
= hcd
->driver
->add_endpoint(hcd
, udev
,
1819 &new_alt
->endpoint
[i
]);
1824 ret
= hcd
->driver
->check_bandwidth(hcd
, udev
);
1827 hcd
->driver
->reset_bandwidth(hcd
, udev
);
1831 /* Disables the endpoint: synchronizes with the hcd to make sure all
1832 * endpoint state is gone from hardware. usb_hcd_flush_endpoint() must
1833 * have been called previously. Use for set_configuration, set_interface,
1834 * driver removal, physical disconnect.
1836 * example: a qh stored in ep->hcpriv, holding state related to endpoint
1837 * type, maxpacket size, toggle, halt status, and scheduling.
1839 void usb_hcd_disable_endpoint(struct usb_device
*udev
,
1840 struct usb_host_endpoint
*ep
)
1842 struct usb_hcd
*hcd
;
1845 hcd
= bus_to_hcd(udev
->bus
);
1846 if (hcd
->driver
->endpoint_disable
)
1847 hcd
->driver
->endpoint_disable(hcd
, ep
);
1851 * usb_hcd_reset_endpoint - reset host endpoint state
1852 * @udev: USB device.
1853 * @ep: the endpoint to reset.
1855 * Resets any host endpoint state such as the toggle bit, sequence
1856 * number and current window.
1858 void usb_hcd_reset_endpoint(struct usb_device
*udev
,
1859 struct usb_host_endpoint
*ep
)
1861 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
1863 if (hcd
->driver
->endpoint_reset
)
1864 hcd
->driver
->endpoint_reset(hcd
, ep
);
1866 int epnum
= usb_endpoint_num(&ep
->desc
);
1867 int is_out
= usb_endpoint_dir_out(&ep
->desc
);
1868 int is_control
= usb_endpoint_xfer_control(&ep
->desc
);
1870 usb_settoggle(udev
, epnum
, is_out
, 0);
1872 usb_settoggle(udev
, epnum
, !is_out
, 0);
1877 * usb_alloc_streams - allocate bulk endpoint stream IDs.
1878 * @interface: alternate setting that includes all endpoints.
1879 * @eps: array of endpoints that need streams.
1880 * @num_eps: number of endpoints in the array.
1881 * @num_streams: number of streams to allocate.
1882 * @mem_flags: flags hcd should use to allocate memory.
1884 * Sets up a group of bulk endpoints to have num_streams stream IDs available.
1885 * Drivers may queue multiple transfers to different stream IDs, which may
1886 * complete in a different order than they were queued.
1888 int usb_alloc_streams(struct usb_interface
*interface
,
1889 struct usb_host_endpoint
**eps
, unsigned int num_eps
,
1890 unsigned int num_streams
, gfp_t mem_flags
)
1892 struct usb_hcd
*hcd
;
1893 struct usb_device
*dev
;
1896 dev
= interface_to_usbdev(interface
);
1897 hcd
= bus_to_hcd(dev
->bus
);
1898 if (!hcd
->driver
->alloc_streams
|| !hcd
->driver
->free_streams
)
1900 if (dev
->speed
!= USB_SPEED_SUPER
)
1903 /* Streams only apply to bulk endpoints. */
1904 for (i
= 0; i
< num_eps
; i
++)
1905 if (!usb_endpoint_xfer_bulk(&eps
[i
]->desc
))
1908 return hcd
->driver
->alloc_streams(hcd
, dev
, eps
, num_eps
,
1909 num_streams
, mem_flags
);
1911 EXPORT_SYMBOL_GPL(usb_alloc_streams
);
1914 * usb_free_streams - free bulk endpoint stream IDs.
1915 * @interface: alternate setting that includes all endpoints.
1916 * @eps: array of endpoints to remove streams from.
1917 * @num_eps: number of endpoints in the array.
1918 * @mem_flags: flags hcd should use to allocate memory.
1920 * Reverts a group of bulk endpoints back to not using stream IDs.
1921 * Can fail if we are given bad arguments, or HCD is broken.
1923 void usb_free_streams(struct usb_interface
*interface
,
1924 struct usb_host_endpoint
**eps
, unsigned int num_eps
,
1927 struct usb_hcd
*hcd
;
1928 struct usb_device
*dev
;
1931 dev
= interface_to_usbdev(interface
);
1932 hcd
= bus_to_hcd(dev
->bus
);
1933 if (dev
->speed
!= USB_SPEED_SUPER
)
1936 /* Streams only apply to bulk endpoints. */
1937 for (i
= 0; i
< num_eps
; i
++)
1938 if (!eps
[i
] || !usb_endpoint_xfer_bulk(&eps
[i
]->desc
))
1941 hcd
->driver
->free_streams(hcd
, dev
, eps
, num_eps
, mem_flags
);
1943 EXPORT_SYMBOL_GPL(usb_free_streams
);
1945 /* Protect against drivers that try to unlink URBs after the device
1946 * is gone, by waiting until all unlinks for @udev are finished.
1947 * Since we don't currently track URBs by device, simply wait until
1948 * nothing is running in the locked region of usb_hcd_unlink_urb().
1950 void usb_hcd_synchronize_unlinks(struct usb_device
*udev
)
1952 spin_lock_irq(&hcd_urb_unlink_lock
);
1953 spin_unlock_irq(&hcd_urb_unlink_lock
);
1956 /*-------------------------------------------------------------------------*/
1958 /* called in any context */
1959 int usb_hcd_get_frame_number (struct usb_device
*udev
)
1961 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
1963 if (!HCD_RH_RUNNING(hcd
))
1965 return hcd
->driver
->get_frame_number (hcd
);
1968 /*-------------------------------------------------------------------------*/
1972 int hcd_bus_suspend(struct usb_device
*rhdev
, pm_message_t msg
)
1974 struct usb_hcd
*hcd
= container_of(rhdev
->bus
, struct usb_hcd
, self
);
1976 int old_state
= hcd
->state
;
1978 dev_dbg(&rhdev
->dev
, "bus %ssuspend, wakeup %d\n",
1979 (PMSG_IS_AUTO(msg
) ? "auto-" : ""),
1980 rhdev
->do_remote_wakeup
);
1981 if (HCD_DEAD(hcd
)) {
1982 dev_dbg(&rhdev
->dev
, "skipped %s of dead bus\n", "suspend");
1986 if (!hcd
->driver
->bus_suspend
) {
1989 clear_bit(HCD_FLAG_RH_RUNNING
, &hcd
->flags
);
1990 hcd
->state
= HC_STATE_QUIESCING
;
1991 status
= hcd
->driver
->bus_suspend(hcd
);
1994 usb_set_device_state(rhdev
, USB_STATE_SUSPENDED
);
1995 hcd
->state
= HC_STATE_SUSPENDED
;
1997 /* Did we race with a root-hub wakeup event? */
1998 if (rhdev
->do_remote_wakeup
) {
2001 status
= hcd
->driver
->hub_status_data(hcd
, buffer
);
2003 dev_dbg(&rhdev
->dev
, "suspend raced with wakeup event\n");
2004 hcd_bus_resume(rhdev
, PMSG_AUTO_RESUME
);
2009 spin_lock_irq(&hcd_root_hub_lock
);
2010 if (!HCD_DEAD(hcd
)) {
2011 set_bit(HCD_FLAG_RH_RUNNING
, &hcd
->flags
);
2012 hcd
->state
= old_state
;
2014 spin_unlock_irq(&hcd_root_hub_lock
);
2015 dev_dbg(&rhdev
->dev
, "bus %s fail, err %d\n",
2021 int hcd_bus_resume(struct usb_device
*rhdev
, pm_message_t msg
)
2023 struct usb_hcd
*hcd
= container_of(rhdev
->bus
, struct usb_hcd
, self
);
2025 int old_state
= hcd
->state
;
2027 dev_dbg(&rhdev
->dev
, "usb %sresume\n",
2028 (PMSG_IS_AUTO(msg
) ? "auto-" : ""));
2029 if (HCD_DEAD(hcd
)) {
2030 dev_dbg(&rhdev
->dev
, "skipped %s of dead bus\n", "resume");
2033 if (!hcd
->driver
->bus_resume
)
2035 if (HCD_RH_RUNNING(hcd
))
2038 hcd
->state
= HC_STATE_RESUMING
;
2039 status
= hcd
->driver
->bus_resume(hcd
);
2040 clear_bit(HCD_FLAG_WAKEUP_PENDING
, &hcd
->flags
);
2042 struct usb_device
*udev
;
2045 spin_lock_irq(&hcd_root_hub_lock
);
2046 if (!HCD_DEAD(hcd
)) {
2047 usb_set_device_state(rhdev
, rhdev
->actconfig
2048 ? USB_STATE_CONFIGURED
2049 : USB_STATE_ADDRESS
);
2050 set_bit(HCD_FLAG_RH_RUNNING
, &hcd
->flags
);
2051 hcd
->state
= HC_STATE_RUNNING
;
2053 spin_unlock_irq(&hcd_root_hub_lock
);
2056 * Check whether any of the enabled ports on the root hub are
2057 * unsuspended. If they are then a TRSMRCY delay is needed
2058 * (this is what the USB-2 spec calls a "global resume").
2059 * Otherwise we can skip the delay.
2061 usb_hub_for_each_child(rhdev
, port1
, udev
) {
2062 if (udev
->state
!= USB_STATE_NOTATTACHED
&&
2063 !udev
->port_is_suspended
) {
2064 usleep_range(10000, 11000); /* TRSMRCY */
2069 hcd
->state
= old_state
;
2070 dev_dbg(&rhdev
->dev
, "bus %s fail, err %d\n",
2072 if (status
!= -ESHUTDOWN
)
2078 #endif /* CONFIG_PM */
2080 #ifdef CONFIG_USB_SUSPEND
2082 /* Workqueue routine for root-hub remote wakeup */
2083 static void hcd_resume_work(struct work_struct
*work
)
2085 struct usb_hcd
*hcd
= container_of(work
, struct usb_hcd
, wakeup_work
);
2086 struct usb_device
*udev
= hcd
->self
.root_hub
;
2088 usb_lock_device(udev
);
2089 usb_remote_wakeup(udev
);
2090 usb_unlock_device(udev
);
2094 * usb_hcd_resume_root_hub - called by HCD to resume its root hub
2095 * @hcd: host controller for this root hub
2097 * The USB host controller calls this function when its root hub is
2098 * suspended (with the remote wakeup feature enabled) and a remote
2099 * wakeup request is received. The routine submits a workqueue request
2100 * to resume the root hub (that is, manage its downstream ports again).
2102 void usb_hcd_resume_root_hub (struct usb_hcd
*hcd
)
2104 unsigned long flags
;
2106 spin_lock_irqsave (&hcd_root_hub_lock
, flags
);
2107 if (hcd
->rh_registered
) {
2108 set_bit(HCD_FLAG_WAKEUP_PENDING
, &hcd
->flags
);
2109 queue_work(pm_wq
, &hcd
->wakeup_work
);
2111 spin_unlock_irqrestore (&hcd_root_hub_lock
, flags
);
2113 EXPORT_SYMBOL_GPL(usb_hcd_resume_root_hub
);
2115 #endif /* CONFIG_USB_SUSPEND */
2117 /*-------------------------------------------------------------------------*/
2119 #ifdef CONFIG_USB_OTG
2122 * usb_bus_start_enum - start immediate enumeration (for OTG)
2123 * @bus: the bus (must use hcd framework)
2124 * @port_num: 1-based number of port; usually bus->otg_port
2125 * Context: in_interrupt()
2127 * Starts enumeration, with an immediate reset followed later by
2128 * khubd identifying and possibly configuring the device.
2129 * This is needed by OTG controller drivers, where it helps meet
2130 * HNP protocol timing requirements for starting a port reset.
2132 int usb_bus_start_enum(struct usb_bus
*bus
, unsigned port_num
)
2134 struct usb_hcd
*hcd
;
2135 int status
= -EOPNOTSUPP
;
2137 /* NOTE: since HNP can't start by grabbing the bus's address0_sem,
2138 * boards with root hubs hooked up to internal devices (instead of
2139 * just the OTG port) may need more attention to resetting...
2141 hcd
= container_of (bus
, struct usb_hcd
, self
);
2142 if (port_num
&& hcd
->driver
->start_port_reset
)
2143 status
= hcd
->driver
->start_port_reset(hcd
, port_num
);
2145 /* run khubd shortly after (first) root port reset finishes;
2146 * it may issue others, until at least 50 msecs have passed.
2149 mod_timer(&hcd
->rh_timer
, jiffies
+ msecs_to_jiffies(10));
2152 EXPORT_SYMBOL_GPL(usb_bus_start_enum
);
2156 /*-------------------------------------------------------------------------*/
2159 * usb_hcd_irq - hook IRQs to HCD framework (bus glue)
2160 * @irq: the IRQ being raised
2161 * @__hcd: pointer to the HCD whose IRQ is being signaled
2163 * If the controller isn't HALTed, calls the driver's irq handler.
2164 * Checks whether the controller is now dead.
2166 irqreturn_t
usb_hcd_irq (int irq
, void *__hcd
)
2168 struct usb_hcd
*hcd
= __hcd
;
2169 unsigned long flags
;
2172 /* IRQF_DISABLED doesn't work correctly with shared IRQs
2173 * when the first handler doesn't use it. So let's just
2174 * assume it's never used.
2176 local_irq_save(flags
);
2178 if (unlikely(HCD_DEAD(hcd
) || !HCD_HW_ACCESSIBLE(hcd
)))
2180 else if (hcd
->driver
->irq(hcd
) == IRQ_NONE
)
2185 local_irq_restore(flags
);
2188 EXPORT_SYMBOL_GPL(usb_hcd_irq
);
2190 /*-------------------------------------------------------------------------*/
2193 * usb_hc_died - report abnormal shutdown of a host controller (bus glue)
2194 * @hcd: pointer to the HCD representing the controller
2196 * This is called by bus glue to report a USB host controller that died
2197 * while operations may still have been pending. It's called automatically
2198 * by the PCI glue, so only glue for non-PCI busses should need to call it.
2200 * Only call this function with the primary HCD.
2202 void usb_hc_died (struct usb_hcd
*hcd
)
2204 unsigned long flags
;
2206 dev_err (hcd
->self
.controller
, "HC died; cleaning up\n");
2208 spin_lock_irqsave (&hcd_root_hub_lock
, flags
);
2209 clear_bit(HCD_FLAG_RH_RUNNING
, &hcd
->flags
);
2210 set_bit(HCD_FLAG_DEAD
, &hcd
->flags
);
2211 if (hcd
->rh_registered
) {
2212 clear_bit(HCD_FLAG_POLL_RH
, &hcd
->flags
);
2214 /* make khubd clean up old urbs and devices */
2215 usb_set_device_state (hcd
->self
.root_hub
,
2216 USB_STATE_NOTATTACHED
);
2217 usb_kick_khubd (hcd
->self
.root_hub
);
2219 if (usb_hcd_is_primary_hcd(hcd
) && hcd
->shared_hcd
) {
2220 hcd
= hcd
->shared_hcd
;
2221 if (hcd
->rh_registered
) {
2222 clear_bit(HCD_FLAG_POLL_RH
, &hcd
->flags
);
2224 /* make khubd clean up old urbs and devices */
2225 usb_set_device_state(hcd
->self
.root_hub
,
2226 USB_STATE_NOTATTACHED
);
2227 usb_kick_khubd(hcd
->self
.root_hub
);
2230 spin_unlock_irqrestore (&hcd_root_hub_lock
, flags
);
2231 /* Make sure that the other roothub is also deallocated. */
2233 EXPORT_SYMBOL_GPL (usb_hc_died
);
2235 /*-------------------------------------------------------------------------*/
2238 * usb_create_shared_hcd - create and initialize an HCD structure
2239 * @driver: HC driver that will use this hcd
2240 * @dev: device for this HC, stored in hcd->self.controller
2241 * @bus_name: value to store in hcd->self.bus_name
2242 * @primary_hcd: a pointer to the usb_hcd structure that is sharing the
2243 * PCI device. Only allocate certain resources for the primary HCD
2244 * Context: !in_interrupt()
2246 * Allocate a struct usb_hcd, with extra space at the end for the
2247 * HC driver's private data. Initialize the generic members of the
2250 * If memory is unavailable, returns NULL.
2252 struct usb_hcd
*usb_create_shared_hcd(const struct hc_driver
*driver
,
2253 struct device
*dev
, const char *bus_name
,
2254 struct usb_hcd
*primary_hcd
)
2256 struct usb_hcd
*hcd
;
2258 hcd
= kzalloc(sizeof(*hcd
) + driver
->hcd_priv_size
, GFP_KERNEL
);
2260 dev_dbg (dev
, "hcd alloc failed\n");
2263 if (primary_hcd
== NULL
) {
2264 hcd
->bandwidth_mutex
= kmalloc(sizeof(*hcd
->bandwidth_mutex
),
2266 if (!hcd
->bandwidth_mutex
) {
2268 dev_dbg(dev
, "hcd bandwidth mutex alloc failed\n");
2271 mutex_init(hcd
->bandwidth_mutex
);
2272 dev_set_drvdata(dev
, hcd
);
2274 hcd
->bandwidth_mutex
= primary_hcd
->bandwidth_mutex
;
2275 hcd
->primary_hcd
= primary_hcd
;
2276 primary_hcd
->primary_hcd
= primary_hcd
;
2277 hcd
->shared_hcd
= primary_hcd
;
2278 primary_hcd
->shared_hcd
= hcd
;
2281 kref_init(&hcd
->kref
);
2283 usb_bus_init(&hcd
->self
);
2284 hcd
->self
.controller
= dev
;
2285 hcd
->self
.bus_name
= bus_name
;
2286 hcd
->self
.uses_dma
= (dev
->dma_mask
!= NULL
);
2288 init_timer(&hcd
->rh_timer
);
2289 hcd
->rh_timer
.function
= rh_timer_func
;
2290 hcd
->rh_timer
.data
= (unsigned long) hcd
;
2291 #ifdef CONFIG_USB_SUSPEND
2292 INIT_WORK(&hcd
->wakeup_work
, hcd_resume_work
);
2295 hcd
->driver
= driver
;
2296 hcd
->speed
= driver
->flags
& HCD_MASK
;
2297 hcd
->product_desc
= (driver
->product_desc
) ? driver
->product_desc
:
2298 "USB Host Controller";
2301 EXPORT_SYMBOL_GPL(usb_create_shared_hcd
);
2304 * usb_create_hcd - create and initialize an HCD structure
2305 * @driver: HC driver that will use this hcd
2306 * @dev: device for this HC, stored in hcd->self.controller
2307 * @bus_name: value to store in hcd->self.bus_name
2308 * Context: !in_interrupt()
2310 * Allocate a struct usb_hcd, with extra space at the end for the
2311 * HC driver's private data. Initialize the generic members of the
2314 * If memory is unavailable, returns NULL.
2316 struct usb_hcd
*usb_create_hcd(const struct hc_driver
*driver
,
2317 struct device
*dev
, const char *bus_name
)
2319 return usb_create_shared_hcd(driver
, dev
, bus_name
, NULL
);
2321 EXPORT_SYMBOL_GPL(usb_create_hcd
);
2324 * Roothubs that share one PCI device must also share the bandwidth mutex.
2325 * Don't deallocate the bandwidth_mutex until the last shared usb_hcd is
2328 * Make sure to only deallocate the bandwidth_mutex when the primary HCD is
2329 * freed. When hcd_release() is called for the non-primary HCD, set the
2330 * primary_hcd's shared_hcd pointer to null (since the non-primary HCD will be
2333 static void hcd_release (struct kref
*kref
)
2335 struct usb_hcd
*hcd
= container_of (kref
, struct usb_hcd
, kref
);
2337 if (usb_hcd_is_primary_hcd(hcd
))
2338 kfree(hcd
->bandwidth_mutex
);
2340 hcd
->shared_hcd
->shared_hcd
= NULL
;
2344 struct usb_hcd
*usb_get_hcd (struct usb_hcd
*hcd
)
2347 kref_get (&hcd
->kref
);
2350 EXPORT_SYMBOL_GPL(usb_get_hcd
);
2352 void usb_put_hcd (struct usb_hcd
*hcd
)
2355 kref_put (&hcd
->kref
, hcd_release
);
2357 EXPORT_SYMBOL_GPL(usb_put_hcd
);
2359 int usb_hcd_is_primary_hcd(struct usb_hcd
*hcd
)
2361 if (!hcd
->primary_hcd
)
2363 return hcd
== hcd
->primary_hcd
;
2365 EXPORT_SYMBOL_GPL(usb_hcd_is_primary_hcd
);
2367 static int usb_hcd_request_irqs(struct usb_hcd
*hcd
,
2368 unsigned int irqnum
, unsigned long irqflags
)
2372 if (hcd
->driver
->irq
) {
2374 /* IRQF_DISABLED doesn't work as advertised when used together
2375 * with IRQF_SHARED. As usb_hcd_irq() will always disable
2376 * interrupts we can remove it here.
2378 if (irqflags
& IRQF_SHARED
)
2379 irqflags
&= ~IRQF_DISABLED
;
2381 snprintf(hcd
->irq_descr
, sizeof(hcd
->irq_descr
), "%s:usb%d",
2382 hcd
->driver
->description
, hcd
->self
.busnum
);
2383 retval
= request_irq(irqnum
, &usb_hcd_irq
, irqflags
,
2384 hcd
->irq_descr
, hcd
);
2386 dev_err(hcd
->self
.controller
,
2387 "request interrupt %d failed\n",
2392 dev_info(hcd
->self
.controller
, "irq %d, %s 0x%08llx\n", irqnum
,
2393 (hcd
->driver
->flags
& HCD_MEMORY
) ?
2394 "io mem" : "io base",
2395 (unsigned long long)hcd
->rsrc_start
);
2398 if (hcd
->rsrc_start
)
2399 dev_info(hcd
->self
.controller
, "%s 0x%08llx\n",
2400 (hcd
->driver
->flags
& HCD_MEMORY
) ?
2401 "io mem" : "io base",
2402 (unsigned long long)hcd
->rsrc_start
);
2408 * usb_add_hcd - finish generic HCD structure initialization and register
2409 * @hcd: the usb_hcd structure to initialize
2410 * @irqnum: Interrupt line to allocate
2411 * @irqflags: Interrupt type flags
2413 * Finish the remaining parts of generic HCD initialization: allocate the
2414 * buffers of consistent memory, register the bus, request the IRQ line,
2415 * and call the driver's reset() and start() routines.
2417 int usb_add_hcd(struct usb_hcd
*hcd
,
2418 unsigned int irqnum
, unsigned long irqflags
)
2421 struct usb_device
*rhdev
;
2423 dev_info(hcd
->self
.controller
, "%s\n", hcd
->product_desc
);
2425 /* Keep old behaviour if authorized_default is not in [0, 1]. */
2426 if (authorized_default
< 0 || authorized_default
> 1)
2427 hcd
->authorized_default
= hcd
->wireless
? 0 : 1;
2429 hcd
->authorized_default
= authorized_default
;
2430 set_bit(HCD_FLAG_HW_ACCESSIBLE
, &hcd
->flags
);
2432 /* HC is in reset state, but accessible. Now do the one-time init,
2433 * bottom up so that hcds can customize the root hubs before khubd
2434 * starts talking to them. (Note, bus id is assigned early too.)
2436 if ((retval
= hcd_buffer_create(hcd
)) != 0) {
2437 dev_dbg(hcd
->self
.controller
, "pool alloc failed\n");
2441 if ((retval
= usb_register_bus(&hcd
->self
)) < 0)
2442 goto err_register_bus
;
2444 if ((rhdev
= usb_alloc_dev(NULL
, &hcd
->self
, 0)) == NULL
) {
2445 dev_err(hcd
->self
.controller
, "unable to allocate root hub\n");
2447 goto err_allocate_root_hub
;
2449 hcd
->self
.root_hub
= rhdev
;
2451 switch (hcd
->speed
) {
2453 rhdev
->speed
= USB_SPEED_FULL
;
2456 rhdev
->speed
= USB_SPEED_HIGH
;
2459 rhdev
->speed
= USB_SPEED_SUPER
;
2463 goto err_set_rh_speed
;
2466 /* wakeup flag init defaults to "everything works" for root hubs,
2467 * but drivers can override it in reset() if needed, along with
2468 * recording the overall controller's system wakeup capability.
2470 device_set_wakeup_capable(&rhdev
->dev
, 1);
2472 /* HCD_FLAG_RH_RUNNING doesn't matter until the root hub is
2473 * registered. But since the controller can die at any time,
2474 * let's initialize the flag before touching the hardware.
2476 set_bit(HCD_FLAG_RH_RUNNING
, &hcd
->flags
);
2478 /* "reset" is misnamed; its role is now one-time init. the controller
2479 * should already have been reset (and boot firmware kicked off etc).
2481 if (hcd
->driver
->reset
&& (retval
= hcd
->driver
->reset(hcd
)) < 0) {
2482 dev_err(hcd
->self
.controller
, "can't setup\n");
2483 goto err_hcd_driver_setup
;
2485 hcd
->rh_pollable
= 1;
2487 /* NOTE: root hub and controller capabilities may not be the same */
2488 if (device_can_wakeup(hcd
->self
.controller
)
2489 && device_can_wakeup(&hcd
->self
.root_hub
->dev
))
2490 dev_dbg(hcd
->self
.controller
, "supports USB remote wakeup\n");
2492 /* enable irqs just before we start the controller,
2493 * if the BIOS provides legacy PCI irqs.
2495 if (usb_hcd_is_primary_hcd(hcd
) && irqnum
) {
2496 retval
= usb_hcd_request_irqs(hcd
, irqnum
, irqflags
);
2498 goto err_request_irq
;
2501 hcd
->state
= HC_STATE_RUNNING
;
2502 retval
= hcd
->driver
->start(hcd
);
2504 dev_err(hcd
->self
.controller
, "startup error %d\n", retval
);
2505 goto err_hcd_driver_start
;
2508 /* starting here, usbcore will pay attention to this root hub */
2509 rhdev
->bus_mA
= min(500u, hcd
->power_budget
);
2510 if ((retval
= register_root_hub(hcd
)) != 0)
2511 goto err_register_root_hub
;
2513 retval
= sysfs_create_group(&rhdev
->dev
.kobj
, &usb_bus_attr_group
);
2515 printk(KERN_ERR
"Cannot register USB bus sysfs attributes: %d\n",
2517 goto error_create_attr_group
;
2519 if (hcd
->uses_new_polling
&& HCD_POLL_RH(hcd
))
2520 usb_hcd_poll_rh_status(hcd
);
2523 * Host controllers don't generate their own wakeup requests;
2524 * they only forward requests from the root hub. Therefore
2525 * controllers should always be enabled for remote wakeup.
2527 device_wakeup_enable(hcd
->self
.controller
);
2530 error_create_attr_group
:
2531 clear_bit(HCD_FLAG_RH_RUNNING
, &hcd
->flags
);
2532 if (HC_IS_RUNNING(hcd
->state
))
2533 hcd
->state
= HC_STATE_QUIESCING
;
2534 spin_lock_irq(&hcd_root_hub_lock
);
2535 hcd
->rh_registered
= 0;
2536 spin_unlock_irq(&hcd_root_hub_lock
);
2538 #ifdef CONFIG_USB_SUSPEND
2539 cancel_work_sync(&hcd
->wakeup_work
);
2541 mutex_lock(&usb_bus_list_lock
);
2542 usb_disconnect(&rhdev
); /* Sets rhdev to NULL */
2543 mutex_unlock(&usb_bus_list_lock
);
2544 err_register_root_hub
:
2545 hcd
->rh_pollable
= 0;
2546 clear_bit(HCD_FLAG_POLL_RH
, &hcd
->flags
);
2547 del_timer_sync(&hcd
->rh_timer
);
2548 hcd
->driver
->stop(hcd
);
2549 hcd
->state
= HC_STATE_HALT
;
2550 clear_bit(HCD_FLAG_POLL_RH
, &hcd
->flags
);
2551 del_timer_sync(&hcd
->rh_timer
);
2552 err_hcd_driver_start
:
2553 if (usb_hcd_is_primary_hcd(hcd
) && hcd
->irq
> 0)
2554 free_irq(irqnum
, hcd
);
2556 err_hcd_driver_setup
:
2558 usb_put_dev(hcd
->self
.root_hub
);
2559 err_allocate_root_hub
:
2560 usb_deregister_bus(&hcd
->self
);
2562 hcd_buffer_destroy(hcd
);
2565 EXPORT_SYMBOL_GPL(usb_add_hcd
);
2568 * usb_remove_hcd - shutdown processing for generic HCDs
2569 * @hcd: the usb_hcd structure to remove
2570 * Context: !in_interrupt()
2572 * Disconnects the root hub, then reverses the effects of usb_add_hcd(),
2573 * invoking the HCD's stop() method.
2575 void usb_remove_hcd(struct usb_hcd
*hcd
)
2577 struct usb_device
*rhdev
= hcd
->self
.root_hub
;
2579 dev_info(hcd
->self
.controller
, "remove, state %x\n", hcd
->state
);
2582 sysfs_remove_group(&rhdev
->dev
.kobj
, &usb_bus_attr_group
);
2584 clear_bit(HCD_FLAG_RH_RUNNING
, &hcd
->flags
);
2585 if (HC_IS_RUNNING (hcd
->state
))
2586 hcd
->state
= HC_STATE_QUIESCING
;
2588 dev_dbg(hcd
->self
.controller
, "roothub graceful disconnect\n");
2589 spin_lock_irq (&hcd_root_hub_lock
);
2590 hcd
->rh_registered
= 0;
2591 spin_unlock_irq (&hcd_root_hub_lock
);
2593 #ifdef CONFIG_USB_SUSPEND
2594 cancel_work_sync(&hcd
->wakeup_work
);
2597 mutex_lock(&usb_bus_list_lock
);
2598 usb_disconnect(&rhdev
); /* Sets rhdev to NULL */
2599 mutex_unlock(&usb_bus_list_lock
);
2601 /* Prevent any more root-hub status calls from the timer.
2602 * The HCD might still restart the timer (if a port status change
2603 * interrupt occurs), but usb_hcd_poll_rh_status() won't invoke
2604 * the hub_status_data() callback.
2606 hcd
->rh_pollable
= 0;
2607 clear_bit(HCD_FLAG_POLL_RH
, &hcd
->flags
);
2608 del_timer_sync(&hcd
->rh_timer
);
2610 hcd
->driver
->stop(hcd
);
2611 hcd
->state
= HC_STATE_HALT
;
2613 /* In case the HCD restarted the timer, stop it again. */
2614 clear_bit(HCD_FLAG_POLL_RH
, &hcd
->flags
);
2615 del_timer_sync(&hcd
->rh_timer
);
2617 if (usb_hcd_is_primary_hcd(hcd
)) {
2619 free_irq(hcd
->irq
, hcd
);
2622 usb_put_dev(hcd
->self
.root_hub
);
2623 usb_deregister_bus(&hcd
->self
);
2624 hcd_buffer_destroy(hcd
);
2626 EXPORT_SYMBOL_GPL(usb_remove_hcd
);
2629 usb_hcd_platform_shutdown(struct platform_device
* dev
)
2631 struct usb_hcd
*hcd
= platform_get_drvdata(dev
);
2633 if (hcd
->driver
->shutdown
)
2634 hcd
->driver
->shutdown(hcd
);
2636 EXPORT_SYMBOL_GPL(usb_hcd_platform_shutdown
);
2638 /*-------------------------------------------------------------------------*/
2640 #if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
2642 struct usb_mon_operations
*mon_ops
;
2645 * The registration is unlocked.
2646 * We do it this way because we do not want to lock in hot paths.
2648 * Notice that the code is minimally error-proof. Because usbmon needs
2649 * symbols from usbcore, usbcore gets referenced and cannot be unloaded first.
2652 int usb_mon_register (struct usb_mon_operations
*ops
)
2662 EXPORT_SYMBOL_GPL (usb_mon_register
);
2664 void usb_mon_deregister (void)
2667 if (mon_ops
== NULL
) {
2668 printk(KERN_ERR
"USB: monitor was not registered\n");
2674 EXPORT_SYMBOL_GPL (usb_mon_deregister
);
2676 #endif /* CONFIG_USB_MON || CONFIG_USB_MON_MODULE */