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/config.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 <asm/scatterlist.h>
35 #include <linux/device.h>
36 #include <linux/dma-mapping.h>
37 #include <linux/mutex.h>
39 #include <asm/byteorder.h>
41 #include <linux/usb.h>
48 // #define USB_BANDWIDTH_MESSAGES
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 /* host controllers we manage */
86 LIST_HEAD (usb_bus_list
);
87 EXPORT_SYMBOL_GPL (usb_bus_list
);
89 /* used when allocating bus numbers */
92 unsigned long busmap
[USB_MAXBUS
/ (8*sizeof (unsigned long))];
94 static struct usb_busmap busmap
;
96 /* used when updating list of hcds */
97 DEFINE_MUTEX(usb_bus_list_lock
); /* exported only for usbfs */
98 EXPORT_SYMBOL_GPL (usb_bus_list_lock
);
100 /* used for controlling access to virtual root hubs */
101 static DEFINE_SPINLOCK(hcd_root_hub_lock
);
103 /* used when updating hcd data */
104 static DEFINE_SPINLOCK(hcd_data_lock
);
106 /* wait queue for synchronous unlinks */
107 DECLARE_WAIT_QUEUE_HEAD(usb_kill_urb_queue
);
109 /*-------------------------------------------------------------------------*/
112 * Sharable chunks of root hub code.
115 /*-------------------------------------------------------------------------*/
117 #define KERNEL_REL ((LINUX_VERSION_CODE >> 16) & 0x0ff)
118 #define KERNEL_VER ((LINUX_VERSION_CODE >> 8) & 0x0ff)
120 /* usb 2.0 root hub device descriptor */
121 static const u8 usb2_rh_dev_descriptor
[18] = {
122 0x12, /* __u8 bLength; */
123 0x01, /* __u8 bDescriptorType; Device */
124 0x00, 0x02, /* __le16 bcdUSB; v2.0 */
126 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
127 0x00, /* __u8 bDeviceSubClass; */
128 0x01, /* __u8 bDeviceProtocol; [ usb 2.0 single TT ]*/
129 0x40, /* __u8 bMaxPacketSize0; 64 Bytes */
131 0x00, 0x00, /* __le16 idVendor; */
132 0x00, 0x00, /* __le16 idProduct; */
133 KERNEL_VER
, KERNEL_REL
, /* __le16 bcdDevice */
135 0x03, /* __u8 iManufacturer; */
136 0x02, /* __u8 iProduct; */
137 0x01, /* __u8 iSerialNumber; */
138 0x01 /* __u8 bNumConfigurations; */
141 /* no usb 2.0 root hub "device qualifier" descriptor: one speed only */
143 /* usb 1.1 root hub device descriptor */
144 static const u8 usb11_rh_dev_descriptor
[18] = {
145 0x12, /* __u8 bLength; */
146 0x01, /* __u8 bDescriptorType; Device */
147 0x10, 0x01, /* __le16 bcdUSB; v1.1 */
149 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
150 0x00, /* __u8 bDeviceSubClass; */
151 0x00, /* __u8 bDeviceProtocol; [ low/full speeds only ] */
152 0x40, /* __u8 bMaxPacketSize0; 64 Bytes */
154 0x00, 0x00, /* __le16 idVendor; */
155 0x00, 0x00, /* __le16 idProduct; */
156 KERNEL_VER
, KERNEL_REL
, /* __le16 bcdDevice */
158 0x03, /* __u8 iManufacturer; */
159 0x02, /* __u8 iProduct; */
160 0x01, /* __u8 iSerialNumber; */
161 0x01 /* __u8 bNumConfigurations; */
165 /*-------------------------------------------------------------------------*/
167 /* Configuration descriptors for our root hubs */
169 static const u8 fs_rh_config_descriptor
[] = {
171 /* one configuration */
172 0x09, /* __u8 bLength; */
173 0x02, /* __u8 bDescriptorType; Configuration */
174 0x19, 0x00, /* __le16 wTotalLength; */
175 0x01, /* __u8 bNumInterfaces; (1) */
176 0x01, /* __u8 bConfigurationValue; */
177 0x00, /* __u8 iConfiguration; */
178 0xc0, /* __u8 bmAttributes;
183 0x00, /* __u8 MaxPower; */
186 * USB 2.0, single TT organization (mandatory):
187 * one interface, protocol 0
189 * USB 2.0, multiple TT organization (optional):
190 * two interfaces, protocols 1 (like single TT)
191 * and 2 (multiple TT mode) ... config is
197 0x09, /* __u8 if_bLength; */
198 0x04, /* __u8 if_bDescriptorType; Interface */
199 0x00, /* __u8 if_bInterfaceNumber; */
200 0x00, /* __u8 if_bAlternateSetting; */
201 0x01, /* __u8 if_bNumEndpoints; */
202 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
203 0x00, /* __u8 if_bInterfaceSubClass; */
204 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
205 0x00, /* __u8 if_iInterface; */
207 /* one endpoint (status change endpoint) */
208 0x07, /* __u8 ep_bLength; */
209 0x05, /* __u8 ep_bDescriptorType; Endpoint */
210 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
211 0x03, /* __u8 ep_bmAttributes; Interrupt */
212 0x02, 0x00, /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8) */
213 0xff /* __u8 ep_bInterval; (255ms -- usb 2.0 spec) */
216 static const u8 hs_rh_config_descriptor
[] = {
218 /* one configuration */
219 0x09, /* __u8 bLength; */
220 0x02, /* __u8 bDescriptorType; Configuration */
221 0x19, 0x00, /* __le16 wTotalLength; */
222 0x01, /* __u8 bNumInterfaces; (1) */
223 0x01, /* __u8 bConfigurationValue; */
224 0x00, /* __u8 iConfiguration; */
225 0xc0, /* __u8 bmAttributes;
230 0x00, /* __u8 MaxPower; */
233 * USB 2.0, single TT organization (mandatory):
234 * one interface, protocol 0
236 * USB 2.0, multiple TT organization (optional):
237 * two interfaces, protocols 1 (like single TT)
238 * and 2 (multiple TT mode) ... config is
244 0x09, /* __u8 if_bLength; */
245 0x04, /* __u8 if_bDescriptorType; Interface */
246 0x00, /* __u8 if_bInterfaceNumber; */
247 0x00, /* __u8 if_bAlternateSetting; */
248 0x01, /* __u8 if_bNumEndpoints; */
249 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
250 0x00, /* __u8 if_bInterfaceSubClass; */
251 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
252 0x00, /* __u8 if_iInterface; */
254 /* one endpoint (status change endpoint) */
255 0x07, /* __u8 ep_bLength; */
256 0x05, /* __u8 ep_bDescriptorType; Endpoint */
257 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
258 0x03, /* __u8 ep_bmAttributes; Interrupt */
259 0x02, 0x00, /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8) */
260 0x0c /* __u8 ep_bInterval; (256ms -- usb 2.0 spec) */
263 /*-------------------------------------------------------------------------*/
266 * helper routine for returning string descriptors in UTF-16LE
267 * input can actually be ISO-8859-1; ASCII is its 7-bit subset
269 static int ascii2utf (char *s
, u8
*utf
, int utfmax
)
273 for (retval
= 0; *s
&& utfmax
> 1; utfmax
-= 2, retval
+= 2) {
285 * rh_string - provides manufacturer, product and serial strings for root hub
286 * @id: the string ID number (1: serial number, 2: product, 3: vendor)
287 * @hcd: the host controller for this root hub
288 * @type: string describing our driver
289 * @data: return packet in UTF-16 LE
290 * @len: length of the return packet
292 * Produces either a manufacturer, product or serial number string for the
293 * virtual root hub device.
295 static int rh_string (
305 buf
[0] = 4; buf
[1] = 3; /* 4 bytes string data */
306 buf
[2] = 0x09; buf
[3] = 0x04; /* MSFT-speak for "en-us" */
308 memcpy (data
, buf
, len
);
312 } else if (id
== 1) {
313 strlcpy (buf
, hcd
->self
.bus_name
, sizeof buf
);
315 // product description
316 } else if (id
== 2) {
317 strlcpy (buf
, hcd
->product_desc
, sizeof buf
);
319 // id 3 == vendor description
320 } else if (id
== 3) {
321 snprintf (buf
, sizeof buf
, "%s %s %s", system_utsname
.sysname
,
322 system_utsname
.release
, hcd
->driver
->description
);
324 // unsupported IDs --> "protocol stall"
328 switch (len
) { /* All cases fall through */
330 len
= 2 + ascii2utf (buf
, data
+ 2, len
- 2);
332 data
[1] = 3; /* type == string */
334 data
[0] = 2 * (strlen (buf
) + 1);
336 ; /* Compiler wants a statement here */
342 /* Root hub control transfers execute synchronously */
343 static int rh_call_control (struct usb_hcd
*hcd
, struct urb
*urb
)
345 struct usb_ctrlrequest
*cmd
;
346 u16 typeReq
, wValue
, wIndex
, wLength
;
347 u8
*ubuf
= urb
->transfer_buffer
;
348 u8 tbuf
[sizeof (struct usb_hub_descriptor
)];
349 const u8
*bufp
= tbuf
;
351 int patch_wakeup
= 0;
356 cmd
= (struct usb_ctrlrequest
*) urb
->setup_packet
;
357 typeReq
= (cmd
->bRequestType
<< 8) | cmd
->bRequest
;
358 wValue
= le16_to_cpu (cmd
->wValue
);
359 wIndex
= le16_to_cpu (cmd
->wIndex
);
360 wLength
= le16_to_cpu (cmd
->wLength
);
362 if (wLength
> urb
->transfer_buffer_length
)
365 urb
->actual_length
= 0;
368 /* DEVICE REQUESTS */
370 case DeviceRequest
| USB_REQ_GET_STATUS
:
371 tbuf
[0] = (hcd
->remote_wakeup
<< USB_DEVICE_REMOTE_WAKEUP
)
372 | (1 << USB_DEVICE_SELF_POWERED
);
376 case DeviceOutRequest
| USB_REQ_CLEAR_FEATURE
:
377 if (wValue
== USB_DEVICE_REMOTE_WAKEUP
)
378 hcd
->remote_wakeup
= 0;
382 case DeviceOutRequest
| USB_REQ_SET_FEATURE
:
383 if (hcd
->can_wakeup
&& wValue
== USB_DEVICE_REMOTE_WAKEUP
)
384 hcd
->remote_wakeup
= 1;
388 case DeviceRequest
| USB_REQ_GET_CONFIGURATION
:
392 case DeviceOutRequest
| USB_REQ_SET_CONFIGURATION
:
394 case DeviceRequest
| USB_REQ_GET_DESCRIPTOR
:
395 switch (wValue
& 0xff00) {
396 case USB_DT_DEVICE
<< 8:
397 if (hcd
->driver
->flags
& HCD_USB2
)
398 bufp
= usb2_rh_dev_descriptor
;
399 else if (hcd
->driver
->flags
& HCD_USB11
)
400 bufp
= usb11_rh_dev_descriptor
;
405 case USB_DT_CONFIG
<< 8:
406 if (hcd
->driver
->flags
& HCD_USB2
) {
407 bufp
= hs_rh_config_descriptor
;
408 len
= sizeof hs_rh_config_descriptor
;
410 bufp
= fs_rh_config_descriptor
;
411 len
= sizeof fs_rh_config_descriptor
;
416 case USB_DT_STRING
<< 8:
417 n
= rh_string (wValue
& 0xff, hcd
, ubuf
, wLength
);
420 urb
->actual_length
= n
;
426 case DeviceRequest
| USB_REQ_GET_INTERFACE
:
430 case DeviceOutRequest
| USB_REQ_SET_INTERFACE
:
432 case DeviceOutRequest
| USB_REQ_SET_ADDRESS
:
433 // wValue == urb->dev->devaddr
434 dev_dbg (hcd
->self
.controller
, "root hub device address %d\n",
438 /* INTERFACE REQUESTS (no defined feature/status flags) */
440 /* ENDPOINT REQUESTS */
442 case EndpointRequest
| USB_REQ_GET_STATUS
:
443 // ENDPOINT_HALT flag
448 case EndpointOutRequest
| USB_REQ_CLEAR_FEATURE
:
449 case EndpointOutRequest
| USB_REQ_SET_FEATURE
:
450 dev_dbg (hcd
->self
.controller
, "no endpoint features yet\n");
453 /* CLASS REQUESTS (and errors) */
456 /* non-generic request */
462 case GetHubDescriptor
:
463 len
= sizeof (struct usb_hub_descriptor
);
466 status
= hcd
->driver
->hub_control (hcd
,
467 typeReq
, wValue
, wIndex
,
471 /* "protocol stall" on error */
477 if (status
!= -EPIPE
) {
478 dev_dbg (hcd
->self
.controller
,
479 "CTRL: TypeReq=0x%x val=0x%x "
480 "idx=0x%x len=%d ==> %d\n",
481 typeReq
, wValue
, wIndex
,
486 if (urb
->transfer_buffer_length
< len
)
487 len
= urb
->transfer_buffer_length
;
488 urb
->actual_length
= len
;
489 // always USB_DIR_IN, toward host
490 memcpy (ubuf
, bufp
, len
);
492 /* report whether RH hardware supports remote wakeup */
494 len
> offsetof (struct usb_config_descriptor
,
496 ((struct usb_config_descriptor
*)ubuf
)->bmAttributes
497 |= USB_CONFIG_ATT_WAKEUP
;
500 /* any errors get returned through the urb completion */
501 local_irq_save (flags
);
502 spin_lock (&urb
->lock
);
503 if (urb
->status
== -EINPROGRESS
)
504 urb
->status
= status
;
505 spin_unlock (&urb
->lock
);
506 usb_hcd_giveback_urb (hcd
, urb
, NULL
);
507 local_irq_restore (flags
);
511 /*-------------------------------------------------------------------------*/
514 * Root Hub interrupt transfers are polled using a timer if the
515 * driver requests it; otherwise the driver is responsible for
516 * calling usb_hcd_poll_rh_status() when an event occurs.
518 * Completions are called in_interrupt(), but they may or may not
521 void usb_hcd_poll_rh_status(struct usb_hcd
*hcd
)
526 char buffer
[4]; /* Any root hubs with > 31 ports? */
528 if (!hcd
->uses_new_polling
&& !hcd
->status_urb
)
531 length
= hcd
->driver
->hub_status_data(hcd
, buffer
);
534 /* try to complete the status urb */
535 local_irq_save (flags
);
536 spin_lock(&hcd_root_hub_lock
);
537 urb
= hcd
->status_urb
;
539 spin_lock(&urb
->lock
);
540 if (urb
->status
== -EINPROGRESS
) {
541 hcd
->poll_pending
= 0;
542 hcd
->status_urb
= NULL
;
545 urb
->actual_length
= length
;
546 memcpy(urb
->transfer_buffer
, buffer
, length
);
547 } else /* urb has been unlinked */
549 spin_unlock(&urb
->lock
);
552 spin_unlock(&hcd_root_hub_lock
);
554 /* local irqs are always blocked in completions */
556 usb_hcd_giveback_urb (hcd
, urb
, NULL
);
558 hcd
->poll_pending
= 1;
559 local_irq_restore (flags
);
562 /* The USB 2.0 spec says 256 ms. This is close enough and won't
563 * exceed that limit if HZ is 100. */
564 if (hcd
->uses_new_polling
? hcd
->poll_rh
:
565 (length
== 0 && hcd
->status_urb
!= NULL
))
566 mod_timer (&hcd
->rh_timer
, jiffies
+ msecs_to_jiffies(250));
568 EXPORT_SYMBOL_GPL(usb_hcd_poll_rh_status
);
571 static void rh_timer_func (unsigned long _hcd
)
573 usb_hcd_poll_rh_status((struct usb_hcd
*) _hcd
);
576 /*-------------------------------------------------------------------------*/
578 static int rh_queue_status (struct usb_hcd
*hcd
, struct urb
*urb
)
582 int len
= 1 + (urb
->dev
->maxchild
/ 8);
584 spin_lock_irqsave (&hcd_root_hub_lock
, flags
);
585 if (urb
->status
!= -EINPROGRESS
) /* already unlinked */
586 retval
= urb
->status
;
587 else if (hcd
->status_urb
|| urb
->transfer_buffer_length
< len
) {
588 dev_dbg (hcd
->self
.controller
, "not queuing rh status urb\n");
591 hcd
->status_urb
= urb
;
592 urb
->hcpriv
= hcd
; /* indicate it's queued */
594 if (!hcd
->uses_new_polling
)
595 mod_timer (&hcd
->rh_timer
, jiffies
+
596 msecs_to_jiffies(250));
598 /* If a status change has already occurred, report it ASAP */
599 else if (hcd
->poll_pending
)
600 mod_timer (&hcd
->rh_timer
, jiffies
);
603 spin_unlock_irqrestore (&hcd_root_hub_lock
, flags
);
607 static int rh_urb_enqueue (struct usb_hcd
*hcd
, struct urb
*urb
)
609 if (usb_pipeint (urb
->pipe
))
610 return rh_queue_status (hcd
, urb
);
611 if (usb_pipecontrol (urb
->pipe
))
612 return rh_call_control (hcd
, urb
);
616 /*-------------------------------------------------------------------------*/
618 /* Asynchronous unlinks of root-hub control URBs are legal, but they
619 * don't do anything. Status URB unlinks must be made in process context
620 * with interrupts enabled.
622 static int usb_rh_urb_dequeue (struct usb_hcd
*hcd
, struct urb
*urb
)
624 if (usb_pipeendpoint(urb
->pipe
) == 0) { /* Control URB */
626 return 0; /* nothing to do */
628 spin_lock_irq(&urb
->lock
); /* from usb_kill_urb */
630 spin_unlock_irq(&urb
->lock
);
632 wait_event(usb_kill_urb_queue
,
633 atomic_read(&urb
->use_count
) == 0);
635 spin_lock_irq(&urb
->lock
);
637 spin_unlock_irq(&urb
->lock
);
639 } else { /* Status URB */
640 if (!hcd
->uses_new_polling
)
641 del_timer_sync (&hcd
->rh_timer
);
642 local_irq_disable ();
643 spin_lock (&hcd_root_hub_lock
);
644 if (urb
== hcd
->status_urb
) {
645 hcd
->status_urb
= NULL
;
648 urb
= NULL
; /* wasn't fully queued */
649 spin_unlock (&hcd_root_hub_lock
);
651 usb_hcd_giveback_urb (hcd
, urb
, NULL
);
658 /*-------------------------------------------------------------------------*/
660 /* exported only within usbcore */
661 struct usb_bus
*usb_bus_get(struct usb_bus
*bus
)
664 kref_get(&bus
->kref
);
668 static void usb_host_release(struct kref
*kref
)
670 struct usb_bus
*bus
= container_of(kref
, struct usb_bus
, kref
);
676 /* exported only within usbcore */
677 void usb_bus_put(struct usb_bus
*bus
)
680 kref_put(&bus
->kref
, usb_host_release
);
683 /*-------------------------------------------------------------------------*/
685 static struct class *usb_host_class
;
687 int usb_host_init(void)
691 usb_host_class
= class_create(THIS_MODULE
, "usb_host");
692 if (IS_ERR(usb_host_class
))
693 retval
= PTR_ERR(usb_host_class
);
697 void usb_host_cleanup(void)
699 class_destroy(usb_host_class
);
703 * usb_bus_init - shared initialization code
704 * @bus: the bus structure being initialized
706 * This code is used to initialize a usb_bus structure, memory for which is
707 * separately managed.
709 static void usb_bus_init (struct usb_bus
*bus
)
711 memset (&bus
->devmap
, 0, sizeof(struct usb_devmap
));
713 bus
->devnum_next
= 1;
715 bus
->root_hub
= NULL
;
718 bus
->bandwidth_allocated
= 0;
719 bus
->bandwidth_int_reqs
= 0;
720 bus
->bandwidth_isoc_reqs
= 0;
722 INIT_LIST_HEAD (&bus
->bus_list
);
724 kref_init(&bus
->kref
);
728 * usb_alloc_bus - creates a new USB host controller structure
729 * @op: pointer to a struct usb_operations that this bus structure should use
730 * Context: !in_interrupt()
732 * Creates a USB host controller bus structure with the specified
733 * usb_operations and initializes all the necessary internal objects.
735 * If no memory is available, NULL is returned.
737 * The caller should call usb_put_bus() when it is finished with the structure.
739 struct usb_bus
*usb_alloc_bus (struct usb_operations
*op
)
743 bus
= kzalloc (sizeof *bus
, GFP_KERNEL
);
751 /*-------------------------------------------------------------------------*/
754 * usb_register_bus - registers the USB host controller with the usb core
755 * @bus: pointer to the bus to register
756 * Context: !in_interrupt()
758 * Assigns a bus number, and links the controller into usbcore data
759 * structures so that it can be seen by scanning the bus list.
761 static int usb_register_bus(struct usb_bus
*bus
)
765 mutex_lock(&usb_bus_list_lock
);
766 busnum
= find_next_zero_bit (busmap
.busmap
, USB_MAXBUS
, 1);
767 if (busnum
< USB_MAXBUS
) {
768 set_bit (busnum
, busmap
.busmap
);
769 bus
->busnum
= busnum
;
771 printk (KERN_ERR
"%s: too many buses\n", usbcore_name
);
772 mutex_unlock(&usb_bus_list_lock
);
776 bus
->class_dev
= class_device_create(usb_host_class
, NULL
, MKDEV(0,0),
777 bus
->controller
, "usb_host%d", busnum
);
778 if (IS_ERR(bus
->class_dev
)) {
779 clear_bit(busnum
, busmap
.busmap
);
780 mutex_unlock(&usb_bus_list_lock
);
781 return PTR_ERR(bus
->class_dev
);
784 class_set_devdata(bus
->class_dev
, bus
);
786 /* Add it to the local list of buses */
787 list_add (&bus
->bus_list
, &usb_bus_list
);
788 mutex_unlock(&usb_bus_list_lock
);
790 usb_notify_add_bus(bus
);
792 dev_info (bus
->controller
, "new USB bus registered, assigned bus number %d\n", bus
->busnum
);
797 * usb_deregister_bus - deregisters the USB host controller
798 * @bus: pointer to the bus to deregister
799 * Context: !in_interrupt()
801 * Recycles the bus number, and unlinks the controller from usbcore data
802 * structures so that it won't be seen by scanning the bus list.
804 static void usb_deregister_bus (struct usb_bus
*bus
)
806 dev_info (bus
->controller
, "USB bus %d deregistered\n", bus
->busnum
);
809 * NOTE: make sure that all the devices are removed by the
810 * controller code, as well as having it call this when cleaning
813 mutex_lock(&usb_bus_list_lock
);
814 list_del (&bus
->bus_list
);
815 mutex_unlock(&usb_bus_list_lock
);
817 usb_notify_remove_bus(bus
);
819 clear_bit (bus
->busnum
, busmap
.busmap
);
821 class_device_unregister(bus
->class_dev
);
825 * register_root_hub - called by usb_add_hcd() to register a root hub
826 * @hcd: host controller for this root hub
828 * This function registers the root hub with the USB subsystem. It sets up
829 * the device properly in the device tree and then calls usb_new_device()
830 * to register the usb device. It also assigns the root hub's USB address
833 static int register_root_hub(struct usb_hcd
*hcd
)
835 struct device
*parent_dev
= hcd
->self
.controller
;
836 struct usb_device
*usb_dev
= hcd
->self
.root_hub
;
837 const int devnum
= 1;
840 usb_dev
->devnum
= devnum
;
841 usb_dev
->bus
->devnum_next
= devnum
+ 1;
842 memset (&usb_dev
->bus
->devmap
.devicemap
, 0,
843 sizeof usb_dev
->bus
->devmap
.devicemap
);
844 set_bit (devnum
, usb_dev
->bus
->devmap
.devicemap
);
845 usb_set_device_state(usb_dev
, USB_STATE_ADDRESS
);
847 mutex_lock(&usb_bus_list_lock
);
849 usb_dev
->ep0
.desc
.wMaxPacketSize
= __constant_cpu_to_le16(64);
850 retval
= usb_get_device_descriptor(usb_dev
, USB_DT_DEVICE_SIZE
);
851 if (retval
!= sizeof usb_dev
->descriptor
) {
852 mutex_unlock(&usb_bus_list_lock
);
853 dev_dbg (parent_dev
, "can't read %s device descriptor %d\n",
854 usb_dev
->dev
.bus_id
, retval
);
855 return (retval
< 0) ? retval
: -EMSGSIZE
;
858 retval
= usb_new_device (usb_dev
);
860 dev_err (parent_dev
, "can't register root hub for %s, %d\n",
861 usb_dev
->dev
.bus_id
, retval
);
863 mutex_unlock(&usb_bus_list_lock
);
866 spin_lock_irq (&hcd_root_hub_lock
);
867 hcd
->rh_registered
= 1;
868 spin_unlock_irq (&hcd_root_hub_lock
);
870 /* Did the HC die before the root hub was registered? */
871 if (hcd
->state
== HC_STATE_HALT
)
872 usb_hc_died (hcd
); /* This time clean up */
878 void usb_enable_root_hub_irq (struct usb_bus
*bus
)
882 hcd
= container_of (bus
, struct usb_hcd
, self
);
883 if (hcd
->driver
->hub_irq_enable
&& !hcd
->poll_rh
&&
884 hcd
->state
!= HC_STATE_HALT
)
885 hcd
->driver
->hub_irq_enable (hcd
);
889 /*-------------------------------------------------------------------------*/
892 * usb_calc_bus_time - approximate periodic transaction time in nanoseconds
893 * @speed: from dev->speed; USB_SPEED_{LOW,FULL,HIGH}
894 * @is_input: true iff the transaction sends data to the host
895 * @isoc: true for isochronous transactions, false for interrupt ones
896 * @bytecount: how many bytes in the transaction.
898 * Returns approximate bus time in nanoseconds for a periodic transaction.
899 * See USB 2.0 spec section 5.11.3; only periodic transfers need to be
900 * scheduled in software, this function is only used for such scheduling.
902 long usb_calc_bus_time (int speed
, int is_input
, int isoc
, int bytecount
)
907 case USB_SPEED_LOW
: /* INTR only */
909 tmp
= (67667L * (31L + 10L * BitTime (bytecount
))) / 1000L;
910 return (64060L + (2 * BW_HUB_LS_SETUP
) + BW_HOST_DELAY
+ tmp
);
912 tmp
= (66700L * (31L + 10L * BitTime (bytecount
))) / 1000L;
913 return (64107L + (2 * BW_HUB_LS_SETUP
) + BW_HOST_DELAY
+ tmp
);
915 case USB_SPEED_FULL
: /* ISOC or INTR */
917 tmp
= (8354L * (31L + 10L * BitTime (bytecount
))) / 1000L;
918 return (((is_input
) ? 7268L : 6265L) + BW_HOST_DELAY
+ tmp
);
920 tmp
= (8354L * (31L + 10L * BitTime (bytecount
))) / 1000L;
921 return (9107L + BW_HOST_DELAY
+ tmp
);
923 case USB_SPEED_HIGH
: /* ISOC or INTR */
924 // FIXME adjust for input vs output
926 tmp
= HS_NSECS_ISO (bytecount
);
928 tmp
= HS_NSECS (bytecount
);
931 pr_debug ("%s: bogus device speed!\n", usbcore_name
);
935 EXPORT_SYMBOL (usb_calc_bus_time
);
938 * usb_check_bandwidth():
940 * old_alloc is from host_controller->bandwidth_allocated in microseconds;
941 * bustime is from calc_bus_time(), but converted to microseconds.
943 * returns <bustime in us> if successful,
944 * or -ENOSPC if bandwidth request fails.
947 * This initial implementation does not use Endpoint.bInterval
948 * in managing bandwidth allocation.
949 * It probably needs to be expanded to use Endpoint.bInterval.
950 * This can be done as a later enhancement (correction).
952 * This will also probably require some kind of
953 * frame allocation tracking...meaning, for example,
954 * that if multiple drivers request interrupts every 10 USB frames,
955 * they don't all have to be allocated at
956 * frame numbers N, N+10, N+20, etc. Some of them could be at
957 * N+11, N+21, N+31, etc., and others at
958 * N+12, N+22, N+32, etc.
960 * Similarly for isochronous transfers...
962 * Individual HCDs can schedule more directly ... this logic
963 * is not correct for high speed transfers.
965 int usb_check_bandwidth (struct usb_device
*dev
, struct urb
*urb
)
967 unsigned int pipe
= urb
->pipe
;
969 int is_in
= usb_pipein (pipe
);
970 int is_iso
= usb_pipeisoc (pipe
);
971 int old_alloc
= dev
->bus
->bandwidth_allocated
;
975 bustime
= NS_TO_US (usb_calc_bus_time (dev
->speed
, is_in
, is_iso
,
976 usb_maxpacket (dev
, pipe
, !is_in
)));
978 bustime
/= urb
->number_of_packets
;
980 new_alloc
= old_alloc
+ (int) bustime
;
981 if (new_alloc
> FRAME_TIME_MAX_USECS_ALLOC
) {
984 #ifdef CONFIG_USB_BANDWIDTH
989 dev_dbg (&dev
->dev
, "usb_check_bandwidth %sFAILED: %d + %ld = %d usec\n",
990 mode
, old_alloc
, bustime
, new_alloc
);
992 #ifdef CONFIG_USB_BANDWIDTH
993 bustime
= -ENOSPC
; /* report error */
999 EXPORT_SYMBOL (usb_check_bandwidth
);
1003 * usb_claim_bandwidth - records bandwidth for a periodic transfer
1004 * @dev: source/target of request
1005 * @urb: request (urb->dev == dev)
1006 * @bustime: bandwidth consumed, in (average) microseconds per frame
1007 * @isoc: true iff the request is isochronous
1009 * Bus bandwidth reservations are recorded purely for diagnostic purposes.
1010 * HCDs are expected not to overcommit periodic bandwidth, and to record such
1011 * reservations whenever endpoints are added to the periodic schedule.
1013 * FIXME averaging per-frame is suboptimal. Better to sum over the HCD's
1014 * entire periodic schedule ... 32 frames for OHCI, 1024 for UHCI, settable
1015 * for EHCI (256/512/1024 frames, default 1024) and have the bus expose how
1016 * large its periodic schedule is.
1018 void usb_claim_bandwidth (struct usb_device
*dev
, struct urb
*urb
, int bustime
, int isoc
)
1020 dev
->bus
->bandwidth_allocated
+= bustime
;
1022 dev
->bus
->bandwidth_isoc_reqs
++;
1024 dev
->bus
->bandwidth_int_reqs
++;
1025 urb
->bandwidth
= bustime
;
1027 #ifdef USB_BANDWIDTH_MESSAGES
1028 dev_dbg (&dev
->dev
, "bandwidth alloc increased by %d (%s) to %d for %d requesters\n",
1030 isoc
? "ISOC" : "INTR",
1031 dev
->bus
->bandwidth_allocated
,
1032 dev
->bus
->bandwidth_int_reqs
+ dev
->bus
->bandwidth_isoc_reqs
);
1035 EXPORT_SYMBOL (usb_claim_bandwidth
);
1039 * usb_release_bandwidth - reverses effect of usb_claim_bandwidth()
1040 * @dev: source/target of request
1041 * @urb: request (urb->dev == dev)
1042 * @isoc: true iff the request is isochronous
1044 * This records that previously allocated bandwidth has been released.
1045 * Bandwidth is released when endpoints are removed from the host controller's
1046 * periodic schedule.
1048 void usb_release_bandwidth (struct usb_device
*dev
, struct urb
*urb
, int isoc
)
1050 dev
->bus
->bandwidth_allocated
-= urb
->bandwidth
;
1052 dev
->bus
->bandwidth_isoc_reqs
--;
1054 dev
->bus
->bandwidth_int_reqs
--;
1056 #ifdef USB_BANDWIDTH_MESSAGES
1057 dev_dbg (&dev
->dev
, "bandwidth alloc reduced by %d (%s) to %d for %d requesters\n",
1059 isoc
? "ISOC" : "INTR",
1060 dev
->bus
->bandwidth_allocated
,
1061 dev
->bus
->bandwidth_int_reqs
+ dev
->bus
->bandwidth_isoc_reqs
);
1065 EXPORT_SYMBOL (usb_release_bandwidth
);
1068 /*-------------------------------------------------------------------------*/
1071 * Generic HC operations.
1074 /*-------------------------------------------------------------------------*/
1076 static void urb_unlink (struct urb
*urb
)
1078 unsigned long flags
;
1080 /* Release any periodic transfer bandwidth */
1082 usb_release_bandwidth (urb
->dev
, urb
,
1083 usb_pipeisoc (urb
->pipe
));
1085 /* clear all state linking urb to this dev (and hcd) */
1087 spin_lock_irqsave (&hcd_data_lock
, flags
);
1088 list_del_init (&urb
->urb_list
);
1089 spin_unlock_irqrestore (&hcd_data_lock
, flags
);
1090 usb_put_dev (urb
->dev
);
1094 /* may be called in any context with a valid urb->dev usecount
1095 * caller surrenders "ownership" of urb
1096 * expects usb_submit_urb() to have sanity checked and conditioned all
1099 static int hcd_submit_urb (struct urb
*urb
, gfp_t mem_flags
)
1102 struct usb_hcd
*hcd
= urb
->dev
->bus
->hcpriv
;
1103 struct usb_host_endpoint
*ep
;
1104 unsigned long flags
;
1109 usbmon_urb_submit(&hcd
->self
, urb
);
1112 * Atomically queue the urb, first to our records, then to the HCD.
1113 * Access to urb->status is controlled by urb->lock ... changes on
1114 * i/o completion (normal or fault) or unlinking.
1117 // FIXME: verify that quiescing hc works right (RH cleans up)
1119 spin_lock_irqsave (&hcd_data_lock
, flags
);
1120 ep
= (usb_pipein(urb
->pipe
) ? urb
->dev
->ep_in
: urb
->dev
->ep_out
)
1121 [usb_pipeendpoint(urb
->pipe
)];
1124 else if (unlikely (urb
->reject
))
1126 else switch (hcd
->state
) {
1127 case HC_STATE_RUNNING
:
1128 case HC_STATE_RESUMING
:
1130 usb_get_dev (urb
->dev
);
1131 list_add_tail (&urb
->urb_list
, &ep
->urb_list
);
1134 case HC_STATE_SUSPENDED
:
1135 /* HC upstream links (register access, wakeup signaling) can work
1136 * even when the downstream links (and DMA etc) are quiesced; let
1137 * usbcore talk to the root hub.
1139 if (hcd
->self
.controller
->power
.power_state
.event
== PM_EVENT_ON
1140 && urb
->dev
->parent
== NULL
)
1144 status
= -ESHUTDOWN
;
1147 spin_unlock_irqrestore (&hcd_data_lock
, flags
);
1149 INIT_LIST_HEAD (&urb
->urb_list
);
1150 usbmon_urb_submit_error(&hcd
->self
, urb
, status
);
1154 /* increment urb's reference count as part of giving it to the HCD
1155 * (which now controls it). HCD guarantees that it either returns
1156 * an error or calls giveback(), but not both.
1158 urb
= usb_get_urb (urb
);
1159 atomic_inc (&urb
->use_count
);
1161 if (urb
->dev
== hcd
->self
.root_hub
) {
1162 /* NOTE: requirement on hub callers (usbfs and the hub
1163 * driver, for now) that URBs' urb->transfer_buffer be
1164 * valid and usb_buffer_{sync,unmap}() not be needed, since
1165 * they could clobber root hub response data.
1167 status
= rh_urb_enqueue (hcd
, urb
);
1171 /* lower level hcd code should use *_dma exclusively,
1172 * unless it uses pio or talks to another transport.
1174 if (hcd
->self
.controller
->dma_mask
) {
1175 if (usb_pipecontrol (urb
->pipe
)
1176 && !(urb
->transfer_flags
& URB_NO_SETUP_DMA_MAP
))
1177 urb
->setup_dma
= dma_map_single (
1178 hcd
->self
.controller
,
1180 sizeof (struct usb_ctrlrequest
),
1182 if (urb
->transfer_buffer_length
!= 0
1183 && !(urb
->transfer_flags
& URB_NO_TRANSFER_DMA_MAP
))
1184 urb
->transfer_dma
= dma_map_single (
1185 hcd
->self
.controller
,
1186 urb
->transfer_buffer
,
1187 urb
->transfer_buffer_length
,
1188 usb_pipein (urb
->pipe
)
1193 status
= hcd
->driver
->urb_enqueue (hcd
, ep
, urb
, mem_flags
);
1195 if (unlikely (status
)) {
1197 atomic_dec (&urb
->use_count
);
1199 wake_up (&usb_kill_urb_queue
);
1201 usbmon_urb_submit_error(&hcd
->self
, urb
, status
);
1206 /*-------------------------------------------------------------------------*/
1208 /* called in any context */
1209 static int hcd_get_frame_number (struct usb_device
*udev
)
1211 struct usb_hcd
*hcd
= (struct usb_hcd
*)udev
->bus
->hcpriv
;
1212 if (!HC_IS_RUNNING (hcd
->state
))
1214 return hcd
->driver
->get_frame_number (hcd
);
1217 /*-------------------------------------------------------------------------*/
1219 /* this makes the hcd giveback() the urb more quickly, by kicking it
1220 * off hardware queues (which may take a while) and returning it as
1221 * soon as practical. we've already set up the urb's return status,
1222 * but we can't know if the callback completed already.
1225 unlink1 (struct usb_hcd
*hcd
, struct urb
*urb
)
1229 if (urb
->dev
== hcd
->self
.root_hub
)
1230 value
= usb_rh_urb_dequeue (hcd
, urb
);
1233 /* The only reason an HCD might fail this call is if
1234 * it has not yet fully queued the urb to begin with.
1235 * Such failures should be harmless. */
1236 value
= hcd
->driver
->urb_dequeue (hcd
, urb
);
1240 dev_dbg (hcd
->self
.controller
, "dequeue %p --> %d\n",
1246 * called in any context
1248 * caller guarantees urb won't be recycled till both unlink()
1249 * and the urb's completion function return
1251 static int hcd_unlink_urb (struct urb
*urb
, int status
)
1253 struct usb_host_endpoint
*ep
;
1254 struct usb_hcd
*hcd
= NULL
;
1255 struct device
*sys
= NULL
;
1256 unsigned long flags
;
1257 struct list_head
*tmp
;
1262 if (!urb
->dev
|| !urb
->dev
->bus
)
1264 ep
= (usb_pipein(urb
->pipe
) ? urb
->dev
->ep_in
: urb
->dev
->ep_out
)
1265 [usb_pipeendpoint(urb
->pipe
)];
1270 * we contend for urb->status with the hcd core,
1271 * which changes it while returning the urb.
1273 * Caller guaranteed that the urb pointer hasn't been freed, and
1274 * that it was submitted. But as a rule it can't know whether or
1275 * not it's already been unlinked ... so we respect the reversed
1276 * lock sequence needed for the usb_hcd_giveback_urb() code paths
1277 * (urb lock, then hcd_data_lock) in case some other CPU is now
1280 spin_lock_irqsave (&urb
->lock
, flags
);
1281 spin_lock (&hcd_data_lock
);
1283 sys
= &urb
->dev
->dev
;
1284 hcd
= urb
->dev
->bus
->hcpriv
;
1290 /* insist the urb is still queued */
1291 list_for_each(tmp
, &ep
->urb_list
) {
1292 if (tmp
== &urb
->urb_list
)
1295 if (tmp
!= &urb
->urb_list
) {
1300 /* Any status except -EINPROGRESS means something already started to
1301 * unlink this URB from the hardware. So there's no more work to do.
1303 if (urb
->status
!= -EINPROGRESS
) {
1308 /* IRQ setup can easily be broken so that USB controllers
1309 * never get completion IRQs ... maybe even the ones we need to
1310 * finish unlinking the initial failed usb_set_address()
1311 * or device descriptor fetch.
1313 if (!test_bit(HCD_FLAG_SAW_IRQ
, &hcd
->flags
)
1314 && hcd
->self
.root_hub
!= urb
->dev
) {
1315 dev_warn (hcd
->self
.controller
, "Unlink after no-IRQ? "
1316 "Controller is probably using the wrong IRQ."
1318 set_bit(HCD_FLAG_SAW_IRQ
, &hcd
->flags
);
1321 urb
->status
= status
;
1323 spin_unlock (&hcd_data_lock
);
1324 spin_unlock_irqrestore (&urb
->lock
, flags
);
1326 retval
= unlink1 (hcd
, urb
);
1328 retval
= -EINPROGRESS
;
1332 spin_unlock (&hcd_data_lock
);
1333 spin_unlock_irqrestore (&urb
->lock
, flags
);
1334 if (retval
!= -EIDRM
&& sys
&& sys
->driver
)
1335 dev_dbg (sys
, "hcd_unlink_urb %p fail %d\n", urb
, retval
);
1339 /*-------------------------------------------------------------------------*/
1341 /* disables the endpoint: cancels any pending urbs, then synchronizes with
1342 * the hcd to make sure all endpoint state is gone from hardware. use for
1343 * set_configuration, set_interface, driver removal, physical disconnect.
1345 * example: a qh stored in ep->hcpriv, holding state related to endpoint
1346 * type, maxpacket size, toggle, halt status, and scheduling.
1349 hcd_endpoint_disable (struct usb_device
*udev
, struct usb_host_endpoint
*ep
)
1351 struct usb_hcd
*hcd
;
1354 hcd
= udev
->bus
->hcpriv
;
1356 WARN_ON (!HC_IS_RUNNING (hcd
->state
) && hcd
->state
!= HC_STATE_HALT
&&
1357 udev
->state
!= USB_STATE_NOTATTACHED
);
1359 local_irq_disable ();
1361 /* FIXME move most of this into message.c as part of its
1362 * endpoint disable logic
1365 /* ep is already gone from udev->ep_{in,out}[]; no more submits */
1367 spin_lock (&hcd_data_lock
);
1368 list_for_each_entry (urb
, &ep
->urb_list
, urb_list
) {
1371 /* another cpu may be in hcd, spinning on hcd_data_lock
1372 * to giveback() this urb. the races here should be
1373 * small, but a full fix needs a new "can't submit"
1375 * FIXME urb->reject should allow that...
1377 if (urb
->status
!= -EINPROGRESS
)
1380 spin_unlock (&hcd_data_lock
);
1382 spin_lock (&urb
->lock
);
1384 if (tmp
== -EINPROGRESS
)
1385 urb
->status
= -ESHUTDOWN
;
1386 spin_unlock (&urb
->lock
);
1388 /* kick hcd unless it's already returning this */
1389 if (tmp
== -EINPROGRESS
) {
1392 dev_dbg (hcd
->self
.controller
,
1393 "shutdown urb %p pipe %08x ep%d%s%s\n",
1394 urb
, tmp
, usb_pipeendpoint (tmp
),
1395 (tmp
& USB_DIR_IN
) ? "in" : "out",
1397 switch (usb_pipetype (tmp
)) { \
1398 case PIPE_CONTROL
: s
= ""; break; \
1399 case PIPE_BULK
: s
= "-bulk"; break; \
1400 case PIPE_INTERRUPT
: s
= "-intr"; break; \
1401 default: s
= "-iso"; break; \
1406 /* list contents may have changed */
1409 spin_unlock (&hcd_data_lock
);
1410 local_irq_enable ();
1412 /* synchronize with the hardware, so old configuration state
1413 * clears out immediately (and will be freed).
1416 if (hcd
->driver
->endpoint_disable
)
1417 hcd
->driver
->endpoint_disable (hcd
, ep
);
1420 /*-------------------------------------------------------------------------*/
1424 int hcd_bus_suspend (struct usb_bus
*bus
)
1426 struct usb_hcd
*hcd
;
1429 hcd
= container_of (bus
, struct usb_hcd
, self
);
1430 if (!hcd
->driver
->bus_suspend
)
1432 hcd
->state
= HC_STATE_QUIESCING
;
1433 status
= hcd
->driver
->bus_suspend (hcd
);
1435 hcd
->state
= HC_STATE_SUSPENDED
;
1437 dev_dbg(&bus
->root_hub
->dev
, "%s fail, err %d\n",
1442 int hcd_bus_resume (struct usb_bus
*bus
)
1444 struct usb_hcd
*hcd
;
1447 hcd
= container_of (bus
, struct usb_hcd
, self
);
1448 if (!hcd
->driver
->bus_resume
)
1450 if (hcd
->state
== HC_STATE_RUNNING
)
1452 hcd
->state
= HC_STATE_RESUMING
;
1453 status
= hcd
->driver
->bus_resume (hcd
);
1455 hcd
->state
= HC_STATE_RUNNING
;
1457 dev_dbg(&bus
->root_hub
->dev
, "%s fail, err %d\n",
1465 * usb_hcd_suspend_root_hub - HCD autosuspends downstream ports
1466 * @hcd: host controller for this root hub
1468 * This call arranges that usb_hcd_resume_root_hub() is safe to call later;
1469 * that the HCD's root hub polling is deactivated; and that the root's hub
1470 * driver is suspended. HCDs may call this to autosuspend when their root
1471 * hub's downstream ports are all inactive: unpowered, disconnected,
1472 * disabled, or suspended.
1474 * The HCD will autoresume on device connect change detection (using SRP
1475 * or a D+/D- pullup). The HCD also autoresumes on remote wakeup signaling
1476 * from any ports that are suspended (if that is enabled). In most cases,
1477 * overcurrent signaling (on powered ports) will also start autoresume.
1479 * Always called with IRQs blocked.
1481 void usb_hcd_suspend_root_hub (struct usb_hcd
*hcd
)
1485 spin_lock (&hcd_root_hub_lock
);
1486 usb_suspend_root_hub (hcd
->self
.root_hub
);
1488 /* force status urb to complete/unlink while suspended */
1489 if (hcd
->status_urb
) {
1490 urb
= hcd
->status_urb
;
1491 urb
->status
= -ECONNRESET
;
1493 urb
->actual_length
= 0;
1495 del_timer (&hcd
->rh_timer
);
1496 hcd
->poll_pending
= 0;
1497 hcd
->status_urb
= NULL
;
1500 spin_unlock (&hcd_root_hub_lock
);
1501 hcd
->state
= HC_STATE_SUSPENDED
;
1504 usb_hcd_giveback_urb (hcd
, urb
, NULL
);
1506 EXPORT_SYMBOL_GPL(usb_hcd_suspend_root_hub
);
1509 * usb_hcd_resume_root_hub - called by HCD to resume its root hub
1510 * @hcd: host controller for this root hub
1512 * The USB host controller calls this function when its root hub is
1513 * suspended (with the remote wakeup feature enabled) and a remote
1514 * wakeup request is received. It queues a request for khubd to
1515 * resume the root hub (that is, manage its downstream ports again).
1517 void usb_hcd_resume_root_hub (struct usb_hcd
*hcd
)
1519 unsigned long flags
;
1521 spin_lock_irqsave (&hcd_root_hub_lock
, flags
);
1522 if (hcd
->rh_registered
)
1523 usb_resume_root_hub (hcd
->self
.root_hub
);
1524 spin_unlock_irqrestore (&hcd_root_hub_lock
, flags
);
1526 EXPORT_SYMBOL_GPL(usb_hcd_resume_root_hub
);
1530 /*-------------------------------------------------------------------------*/
1532 #ifdef CONFIG_USB_OTG
1535 * usb_bus_start_enum - start immediate enumeration (for OTG)
1536 * @bus: the bus (must use hcd framework)
1537 * @port_num: 1-based number of port; usually bus->otg_port
1538 * Context: in_interrupt()
1540 * Starts enumeration, with an immediate reset followed later by
1541 * khubd identifying and possibly configuring the device.
1542 * This is needed by OTG controller drivers, where it helps meet
1543 * HNP protocol timing requirements for starting a port reset.
1545 int usb_bus_start_enum(struct usb_bus
*bus
, unsigned port_num
)
1547 struct usb_hcd
*hcd
;
1548 int status
= -EOPNOTSUPP
;
1550 /* NOTE: since HNP can't start by grabbing the bus's address0_sem,
1551 * boards with root hubs hooked up to internal devices (instead of
1552 * just the OTG port) may need more attention to resetting...
1554 hcd
= container_of (bus
, struct usb_hcd
, self
);
1555 if (port_num
&& hcd
->driver
->start_port_reset
)
1556 status
= hcd
->driver
->start_port_reset(hcd
, port_num
);
1558 /* run khubd shortly after (first) root port reset finishes;
1559 * it may issue others, until at least 50 msecs have passed.
1562 mod_timer(&hcd
->rh_timer
, jiffies
+ msecs_to_jiffies(10));
1565 EXPORT_SYMBOL (usb_bus_start_enum
);
1569 /*-------------------------------------------------------------------------*/
1572 * usb_hcd_operations - adapts usb_bus framework to HCD framework (bus glue)
1574 static struct usb_operations usb_hcd_operations
= {
1575 .get_frame_number
= hcd_get_frame_number
,
1576 .submit_urb
= hcd_submit_urb
,
1577 .unlink_urb
= hcd_unlink_urb
,
1578 .buffer_alloc
= hcd_buffer_alloc
,
1579 .buffer_free
= hcd_buffer_free
,
1580 .disable
= hcd_endpoint_disable
,
1583 /*-------------------------------------------------------------------------*/
1586 * usb_hcd_giveback_urb - return URB from HCD to device driver
1587 * @hcd: host controller returning the URB
1588 * @urb: urb being returned to the USB device driver.
1589 * @regs: pt_regs, passed down to the URB completion handler
1590 * Context: in_interrupt()
1592 * This hands the URB from HCD to its USB device driver, using its
1593 * completion function. The HCD has freed all per-urb resources
1594 * (and is done using urb->hcpriv). It also released all HCD locks;
1595 * the device driver won't cause problems if it frees, modifies,
1596 * or resubmits this URB.
1598 void usb_hcd_giveback_urb (struct usb_hcd
*hcd
, struct urb
*urb
, struct pt_regs
*regs
)
1602 at_root_hub
= (urb
->dev
== hcd
->self
.root_hub
);
1605 /* lower level hcd code should use *_dma exclusively */
1606 if (hcd
->self
.controller
->dma_mask
&& !at_root_hub
) {
1607 if (usb_pipecontrol (urb
->pipe
)
1608 && !(urb
->transfer_flags
& URB_NO_SETUP_DMA_MAP
))
1609 dma_unmap_single (hcd
->self
.controller
, urb
->setup_dma
,
1610 sizeof (struct usb_ctrlrequest
),
1612 if (urb
->transfer_buffer_length
!= 0
1613 && !(urb
->transfer_flags
& URB_NO_TRANSFER_DMA_MAP
))
1614 dma_unmap_single (hcd
->self
.controller
,
1616 urb
->transfer_buffer_length
,
1617 usb_pipein (urb
->pipe
)
1622 usbmon_urb_complete (&hcd
->self
, urb
);
1623 /* pass ownership to the completion handler */
1624 urb
->complete (urb
, regs
);
1625 atomic_dec (&urb
->use_count
);
1626 if (unlikely (urb
->reject
))
1627 wake_up (&usb_kill_urb_queue
);
1630 EXPORT_SYMBOL (usb_hcd_giveback_urb
);
1632 /*-------------------------------------------------------------------------*/
1635 * usb_hcd_irq - hook IRQs to HCD framework (bus glue)
1636 * @irq: the IRQ being raised
1637 * @__hcd: pointer to the HCD whose IRQ is being signaled
1638 * @r: saved hardware registers
1640 * If the controller isn't HALTed, calls the driver's irq handler.
1641 * Checks whether the controller is now dead.
1643 irqreturn_t
usb_hcd_irq (int irq
, void *__hcd
, struct pt_regs
* r
)
1645 struct usb_hcd
*hcd
= __hcd
;
1646 int start
= hcd
->state
;
1648 if (unlikely(start
== HC_STATE_HALT
||
1649 !test_bit(HCD_FLAG_HW_ACCESSIBLE
, &hcd
->flags
)))
1651 if (hcd
->driver
->irq (hcd
, r
) == IRQ_NONE
)
1654 set_bit(HCD_FLAG_SAW_IRQ
, &hcd
->flags
);
1656 if (unlikely(hcd
->state
== HC_STATE_HALT
))
1661 /*-------------------------------------------------------------------------*/
1664 * usb_hc_died - report abnormal shutdown of a host controller (bus glue)
1665 * @hcd: pointer to the HCD representing the controller
1667 * This is called by bus glue to report a USB host controller that died
1668 * while operations may still have been pending. It's called automatically
1669 * by the PCI glue, so only glue for non-PCI busses should need to call it.
1671 void usb_hc_died (struct usb_hcd
*hcd
)
1673 unsigned long flags
;
1675 dev_err (hcd
->self
.controller
, "HC died; cleaning up\n");
1677 spin_lock_irqsave (&hcd_root_hub_lock
, flags
);
1678 if (hcd
->rh_registered
) {
1681 /* make khubd clean up old urbs and devices */
1682 usb_set_device_state (hcd
->self
.root_hub
,
1683 USB_STATE_NOTATTACHED
);
1684 usb_kick_khubd (hcd
->self
.root_hub
);
1686 spin_unlock_irqrestore (&hcd_root_hub_lock
, flags
);
1688 EXPORT_SYMBOL_GPL (usb_hc_died
);
1690 /*-------------------------------------------------------------------------*/
1692 static void hcd_release (struct usb_bus
*bus
)
1694 struct usb_hcd
*hcd
;
1696 hcd
= container_of(bus
, struct usb_hcd
, self
);
1701 * usb_create_hcd - create and initialize an HCD structure
1702 * @driver: HC driver that will use this hcd
1703 * @dev: device for this HC, stored in hcd->self.controller
1704 * @bus_name: value to store in hcd->self.bus_name
1705 * Context: !in_interrupt()
1707 * Allocate a struct usb_hcd, with extra space at the end for the
1708 * HC driver's private data. Initialize the generic members of the
1711 * If memory is unavailable, returns NULL.
1713 struct usb_hcd
*usb_create_hcd (const struct hc_driver
*driver
,
1714 struct device
*dev
, char *bus_name
)
1716 struct usb_hcd
*hcd
;
1718 hcd
= kzalloc(sizeof(*hcd
) + driver
->hcd_priv_size
, GFP_KERNEL
);
1720 dev_dbg (dev
, "hcd alloc failed\n");
1723 dev_set_drvdata(dev
, hcd
);
1725 usb_bus_init(&hcd
->self
);
1726 hcd
->self
.op
= &usb_hcd_operations
;
1727 hcd
->self
.hcpriv
= hcd
;
1728 hcd
->self
.release
= &hcd_release
;
1729 hcd
->self
.controller
= dev
;
1730 hcd
->self
.bus_name
= bus_name
;
1732 init_timer(&hcd
->rh_timer
);
1733 hcd
->rh_timer
.function
= rh_timer_func
;
1734 hcd
->rh_timer
.data
= (unsigned long) hcd
;
1736 hcd
->driver
= driver
;
1737 hcd
->product_desc
= (driver
->product_desc
) ? driver
->product_desc
:
1738 "USB Host Controller";
1742 EXPORT_SYMBOL (usb_create_hcd
);
1744 void usb_put_hcd (struct usb_hcd
*hcd
)
1746 dev_set_drvdata(hcd
->self
.controller
, NULL
);
1747 usb_bus_put(&hcd
->self
);
1749 EXPORT_SYMBOL (usb_put_hcd
);
1752 * usb_add_hcd - finish generic HCD structure initialization and register
1753 * @hcd: the usb_hcd structure to initialize
1754 * @irqnum: Interrupt line to allocate
1755 * @irqflags: Interrupt type flags
1757 * Finish the remaining parts of generic HCD initialization: allocate the
1758 * buffers of consistent memory, register the bus, request the IRQ line,
1759 * and call the driver's reset() and start() routines.
1761 int usb_add_hcd(struct usb_hcd
*hcd
,
1762 unsigned int irqnum
, unsigned long irqflags
)
1765 struct usb_device
*rhdev
;
1767 dev_info(hcd
->self
.controller
, "%s\n", hcd
->product_desc
);
1769 set_bit(HCD_FLAG_HW_ACCESSIBLE
, &hcd
->flags
);
1771 /* HC is in reset state, but accessible. Now do the one-time init,
1772 * bottom up so that hcds can customize the root hubs before khubd
1773 * starts talking to them. (Note, bus id is assigned early too.)
1775 if ((retval
= hcd_buffer_create(hcd
)) != 0) {
1776 dev_dbg(hcd
->self
.controller
, "pool alloc failed\n");
1780 if ((retval
= usb_register_bus(&hcd
->self
)) < 0)
1781 goto err_register_bus
;
1783 if ((rhdev
= usb_alloc_dev(NULL
, &hcd
->self
, 0)) == NULL
) {
1784 dev_err(hcd
->self
.controller
, "unable to allocate root hub\n");
1786 goto err_allocate_root_hub
;
1788 rhdev
->speed
= (hcd
->driver
->flags
& HCD_USB2
) ? USB_SPEED_HIGH
:
1790 hcd
->self
.root_hub
= rhdev
;
1792 /* "reset" is misnamed; its role is now one-time init. the controller
1793 * should already have been reset (and boot firmware kicked off etc).
1795 if (hcd
->driver
->reset
&& (retval
= hcd
->driver
->reset(hcd
)) < 0) {
1796 dev_err(hcd
->self
.controller
, "can't setup\n");
1797 goto err_hcd_driver_setup
;
1800 /* wakeup flag init is in transition; for now we can't rely on PCI to
1801 * initialize these bits properly, so we let reset() override it.
1802 * This init should _precede_ the reset() once PCI behaves.
1804 device_init_wakeup(&rhdev
->dev
,
1805 device_can_wakeup(hcd
->self
.controller
));
1807 // ... all these hcd->*_wakeup flags will vanish
1808 hcd
->can_wakeup
= device_can_wakeup(hcd
->self
.controller
);
1810 /* hcd->driver->reset() reported can_wakeup, probably with
1811 * assistance from board's boot firmware.
1812 * NOTE: normal devices won't enable wakeup by default.
1814 if (hcd
->can_wakeup
)
1815 dev_dbg(hcd
->self
.controller
, "supports USB remote wakeup\n");
1816 hcd
->remote_wakeup
= hcd
->can_wakeup
;
1818 /* enable irqs just before we start the controller */
1819 if (hcd
->driver
->irq
) {
1820 char buf
[8], *bufp
= buf
;
1823 bufp
= __irq_itoa(irqnum
);
1825 sprintf(buf
, "%d", irqnum
);
1828 snprintf(hcd
->irq_descr
, sizeof(hcd
->irq_descr
), "%s:usb%d",
1829 hcd
->driver
->description
, hcd
->self
.busnum
);
1830 if ((retval
= request_irq(irqnum
, &usb_hcd_irq
, irqflags
,
1831 hcd
->irq_descr
, hcd
)) != 0) {
1832 dev_err(hcd
->self
.controller
,
1833 "request interrupt %s failed\n", bufp
);
1834 goto err_request_irq
;
1837 dev_info(hcd
->self
.controller
, "irq %s, %s 0x%08llx\n", bufp
,
1838 (hcd
->driver
->flags
& HCD_MEMORY
) ?
1839 "io mem" : "io base",
1840 (unsigned long long)hcd
->rsrc_start
);
1843 if (hcd
->rsrc_start
)
1844 dev_info(hcd
->self
.controller
, "%s 0x%08llx\n",
1845 (hcd
->driver
->flags
& HCD_MEMORY
) ?
1846 "io mem" : "io base",
1847 (unsigned long long)hcd
->rsrc_start
);
1850 if ((retval
= hcd
->driver
->start(hcd
)) < 0) {
1851 dev_err(hcd
->self
.controller
, "startup error %d\n", retval
);
1852 goto err_hcd_driver_start
;
1855 /* starting here, usbcore will pay attention to this root hub */
1856 rhdev
->bus_mA
= min(500u, hcd
->power_budget
);
1857 if ((retval
= register_root_hub(hcd
)) != 0)
1858 goto err_register_root_hub
;
1860 if (hcd
->uses_new_polling
&& hcd
->poll_rh
)
1861 usb_hcd_poll_rh_status(hcd
);
1864 err_register_root_hub
:
1865 hcd
->driver
->stop(hcd
);
1866 err_hcd_driver_start
:
1868 free_irq(irqnum
, hcd
);
1870 err_hcd_driver_setup
:
1871 hcd
->self
.root_hub
= NULL
;
1873 err_allocate_root_hub
:
1874 usb_deregister_bus(&hcd
->self
);
1876 hcd_buffer_destroy(hcd
);
1879 EXPORT_SYMBOL (usb_add_hcd
);
1882 * usb_remove_hcd - shutdown processing for generic HCDs
1883 * @hcd: the usb_hcd structure to remove
1884 * Context: !in_interrupt()
1886 * Disconnects the root hub, then reverses the effects of usb_add_hcd(),
1887 * invoking the HCD's stop() method.
1889 void usb_remove_hcd(struct usb_hcd
*hcd
)
1891 dev_info(hcd
->self
.controller
, "remove, state %x\n", hcd
->state
);
1893 if (HC_IS_RUNNING (hcd
->state
))
1894 hcd
->state
= HC_STATE_QUIESCING
;
1896 dev_dbg(hcd
->self
.controller
, "roothub graceful disconnect\n");
1897 spin_lock_irq (&hcd_root_hub_lock
);
1898 hcd
->rh_registered
= 0;
1899 spin_unlock_irq (&hcd_root_hub_lock
);
1901 mutex_lock(&usb_bus_list_lock
);
1902 usb_disconnect(&hcd
->self
.root_hub
);
1903 mutex_unlock(&usb_bus_list_lock
);
1906 del_timer_sync(&hcd
->rh_timer
);
1908 hcd
->driver
->stop(hcd
);
1909 hcd
->state
= HC_STATE_HALT
;
1912 free_irq(hcd
->irq
, hcd
);
1913 usb_deregister_bus(&hcd
->self
);
1914 hcd_buffer_destroy(hcd
);
1916 EXPORT_SYMBOL (usb_remove_hcd
);
1918 /*-------------------------------------------------------------------------*/
1920 #if defined(CONFIG_USB_MON)
1922 struct usb_mon_operations
*mon_ops
;
1925 * The registration is unlocked.
1926 * We do it this way because we do not want to lock in hot paths.
1928 * Notice that the code is minimally error-proof. Because usbmon needs
1929 * symbols from usbcore, usbcore gets referenced and cannot be unloaded first.
1932 int usb_mon_register (struct usb_mon_operations
*ops
)
1942 EXPORT_SYMBOL_GPL (usb_mon_register
);
1944 void usb_mon_deregister (void)
1947 if (mon_ops
== NULL
) {
1948 printk(KERN_ERR
"USB: monitor was not registered\n");
1954 EXPORT_SYMBOL_GPL (usb_mon_deregister
);
1956 #endif /* CONFIG_USB_MON */