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>
38 #include <asm/byteorder.h>
40 #include <linux/usb.h>
47 // #define USB_BANDWIDTH_MESSAGES
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 /* host controllers we manage */
85 LIST_HEAD (usb_bus_list
);
86 EXPORT_SYMBOL_GPL (usb_bus_list
);
88 /* used when allocating bus numbers */
91 unsigned long busmap
[USB_MAXBUS
/ (8*sizeof (unsigned long))];
93 static struct usb_busmap busmap
;
95 /* used when updating list of hcds */
96 DECLARE_MUTEX (usb_bus_list_lock
); /* exported only for usbfs */
97 EXPORT_SYMBOL_GPL (usb_bus_list_lock
);
99 /* used for controlling access to virtual root hubs */
100 static DEFINE_SPINLOCK(hcd_root_hub_lock
);
102 /* used when updating hcd data */
103 static DEFINE_SPINLOCK(hcd_data_lock
);
105 /* wait queue for synchronous unlinks */
106 DECLARE_WAIT_QUEUE_HEAD(usb_kill_urb_queue
);
108 /*-------------------------------------------------------------------------*/
111 * Sharable chunks of root hub code.
114 /*-------------------------------------------------------------------------*/
116 #define KERNEL_REL ((LINUX_VERSION_CODE >> 16) & 0x0ff)
117 #define KERNEL_VER ((LINUX_VERSION_CODE >> 8) & 0x0ff)
119 /* usb 2.0 root hub device descriptor */
120 static const u8 usb2_rh_dev_descriptor
[18] = {
121 0x12, /* __u8 bLength; */
122 0x01, /* __u8 bDescriptorType; Device */
123 0x00, 0x02, /* __le16 bcdUSB; v2.0 */
125 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
126 0x00, /* __u8 bDeviceSubClass; */
127 0x01, /* __u8 bDeviceProtocol; [ usb 2.0 single TT ]*/
128 0x40, /* __u8 bMaxPacketSize0; 64 Bytes */
130 0x00, 0x00, /* __le16 idVendor; */
131 0x00, 0x00, /* __le16 idProduct; */
132 KERNEL_VER
, KERNEL_REL
, /* __le16 bcdDevice */
134 0x03, /* __u8 iManufacturer; */
135 0x02, /* __u8 iProduct; */
136 0x01, /* __u8 iSerialNumber; */
137 0x01 /* __u8 bNumConfigurations; */
140 /* no usb 2.0 root hub "device qualifier" descriptor: one speed only */
142 /* usb 1.1 root hub device descriptor */
143 static const u8 usb11_rh_dev_descriptor
[18] = {
144 0x12, /* __u8 bLength; */
145 0x01, /* __u8 bDescriptorType; Device */
146 0x10, 0x01, /* __le16 bcdUSB; v1.1 */
148 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
149 0x00, /* __u8 bDeviceSubClass; */
150 0x00, /* __u8 bDeviceProtocol; [ low/full speeds only ] */
151 0x40, /* __u8 bMaxPacketSize0; 64 Bytes */
153 0x00, 0x00, /* __le16 idVendor; */
154 0x00, 0x00, /* __le16 idProduct; */
155 KERNEL_VER
, KERNEL_REL
, /* __le16 bcdDevice */
157 0x03, /* __u8 iManufacturer; */
158 0x02, /* __u8 iProduct; */
159 0x01, /* __u8 iSerialNumber; */
160 0x01 /* __u8 bNumConfigurations; */
164 /*-------------------------------------------------------------------------*/
166 /* Configuration descriptors for our root hubs */
168 static const u8 fs_rh_config_descriptor
[] = {
170 /* one configuration */
171 0x09, /* __u8 bLength; */
172 0x02, /* __u8 bDescriptorType; Configuration */
173 0x19, 0x00, /* __le16 wTotalLength; */
174 0x01, /* __u8 bNumInterfaces; (1) */
175 0x01, /* __u8 bConfigurationValue; */
176 0x00, /* __u8 iConfiguration; */
177 0xc0, /* __u8 bmAttributes;
182 0x00, /* __u8 MaxPower; */
185 * USB 2.0, single TT organization (mandatory):
186 * one interface, protocol 0
188 * USB 2.0, multiple TT organization (optional):
189 * two interfaces, protocols 1 (like single TT)
190 * and 2 (multiple TT mode) ... config is
196 0x09, /* __u8 if_bLength; */
197 0x04, /* __u8 if_bDescriptorType; Interface */
198 0x00, /* __u8 if_bInterfaceNumber; */
199 0x00, /* __u8 if_bAlternateSetting; */
200 0x01, /* __u8 if_bNumEndpoints; */
201 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
202 0x00, /* __u8 if_bInterfaceSubClass; */
203 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
204 0x00, /* __u8 if_iInterface; */
206 /* one endpoint (status change endpoint) */
207 0x07, /* __u8 ep_bLength; */
208 0x05, /* __u8 ep_bDescriptorType; Endpoint */
209 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
210 0x03, /* __u8 ep_bmAttributes; Interrupt */
211 0x02, 0x00, /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8) */
212 0xff /* __u8 ep_bInterval; (255ms -- usb 2.0 spec) */
215 static const u8 hs_rh_config_descriptor
[] = {
217 /* one configuration */
218 0x09, /* __u8 bLength; */
219 0x02, /* __u8 bDescriptorType; Configuration */
220 0x19, 0x00, /* __le16 wTotalLength; */
221 0x01, /* __u8 bNumInterfaces; (1) */
222 0x01, /* __u8 bConfigurationValue; */
223 0x00, /* __u8 iConfiguration; */
224 0xc0, /* __u8 bmAttributes;
229 0x00, /* __u8 MaxPower; */
232 * USB 2.0, single TT organization (mandatory):
233 * one interface, protocol 0
235 * USB 2.0, multiple TT organization (optional):
236 * two interfaces, protocols 1 (like single TT)
237 * and 2 (multiple TT mode) ... config is
243 0x09, /* __u8 if_bLength; */
244 0x04, /* __u8 if_bDescriptorType; Interface */
245 0x00, /* __u8 if_bInterfaceNumber; */
246 0x00, /* __u8 if_bAlternateSetting; */
247 0x01, /* __u8 if_bNumEndpoints; */
248 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
249 0x00, /* __u8 if_bInterfaceSubClass; */
250 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
251 0x00, /* __u8 if_iInterface; */
253 /* one endpoint (status change endpoint) */
254 0x07, /* __u8 ep_bLength; */
255 0x05, /* __u8 ep_bDescriptorType; Endpoint */
256 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
257 0x03, /* __u8 ep_bmAttributes; Interrupt */
258 0x02, 0x00, /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8) */
259 0x0c /* __u8 ep_bInterval; (256ms -- usb 2.0 spec) */
262 /*-------------------------------------------------------------------------*/
265 * helper routine for returning string descriptors in UTF-16LE
266 * input can actually be ISO-8859-1; ASCII is its 7-bit subset
268 static int ascii2utf (char *s
, u8
*utf
, int utfmax
)
272 for (retval
= 0; *s
&& utfmax
> 1; utfmax
-= 2, retval
+= 2) {
284 * rh_string - provides manufacturer, product and serial strings for root hub
285 * @id: the string ID number (1: serial number, 2: product, 3: vendor)
286 * @hcd: the host controller for this root hub
287 * @type: string describing our driver
288 * @data: return packet in UTF-16 LE
289 * @len: length of the return packet
291 * Produces either a manufacturer, product or serial number string for the
292 * virtual root hub device.
294 static int rh_string (
304 buf
[0] = 4; buf
[1] = 3; /* 4 bytes string data */
305 buf
[2] = 0x09; buf
[3] = 0x04; /* MSFT-speak for "en-us" */
307 memcpy (data
, buf
, len
);
311 } else if (id
== 1) {
312 strlcpy (buf
, hcd
->self
.bus_name
, sizeof buf
);
314 // product description
315 } else if (id
== 2) {
316 strlcpy (buf
, hcd
->product_desc
, sizeof buf
);
318 // id 3 == vendor description
319 } else if (id
== 3) {
320 snprintf (buf
, sizeof buf
, "%s %s %s", system_utsname
.sysname
,
321 system_utsname
.release
, hcd
->driver
->description
);
323 // unsupported IDs --> "protocol stall"
327 switch (len
) { /* All cases fall through */
329 len
= 2 + ascii2utf (buf
, data
+ 2, len
- 2);
331 data
[1] = 3; /* type == string */
333 data
[0] = 2 * (strlen (buf
) + 1);
335 ; /* Compiler wants a statement here */
341 /* Root hub control transfers execute synchronously */
342 static int rh_call_control (struct usb_hcd
*hcd
, struct urb
*urb
)
344 struct usb_ctrlrequest
*cmd
;
345 u16 typeReq
, wValue
, wIndex
, wLength
;
346 u8
*ubuf
= urb
->transfer_buffer
;
347 u8 tbuf
[sizeof (struct usb_hub_descriptor
)];
348 const u8
*bufp
= tbuf
;
350 int patch_wakeup
= 0;
355 cmd
= (struct usb_ctrlrequest
*) urb
->setup_packet
;
356 typeReq
= (cmd
->bRequestType
<< 8) | cmd
->bRequest
;
357 wValue
= le16_to_cpu (cmd
->wValue
);
358 wIndex
= le16_to_cpu (cmd
->wIndex
);
359 wLength
= le16_to_cpu (cmd
->wLength
);
361 if (wLength
> urb
->transfer_buffer_length
)
364 urb
->actual_length
= 0;
367 /* DEVICE REQUESTS */
369 case DeviceRequest
| USB_REQ_GET_STATUS
:
370 tbuf
[0] = (hcd
->remote_wakeup
<< USB_DEVICE_REMOTE_WAKEUP
)
371 | (1 << USB_DEVICE_SELF_POWERED
);
375 case DeviceOutRequest
| USB_REQ_CLEAR_FEATURE
:
376 if (wValue
== USB_DEVICE_REMOTE_WAKEUP
)
377 hcd
->remote_wakeup
= 0;
381 case DeviceOutRequest
| USB_REQ_SET_FEATURE
:
382 if (hcd
->can_wakeup
&& wValue
== USB_DEVICE_REMOTE_WAKEUP
)
383 hcd
->remote_wakeup
= 1;
387 case DeviceRequest
| USB_REQ_GET_CONFIGURATION
:
391 case DeviceOutRequest
| USB_REQ_SET_CONFIGURATION
:
393 case DeviceRequest
| USB_REQ_GET_DESCRIPTOR
:
394 switch (wValue
& 0xff00) {
395 case USB_DT_DEVICE
<< 8:
396 if (hcd
->driver
->flags
& HCD_USB2
)
397 bufp
= usb2_rh_dev_descriptor
;
398 else if (hcd
->driver
->flags
& HCD_USB11
)
399 bufp
= usb11_rh_dev_descriptor
;
404 case USB_DT_CONFIG
<< 8:
405 if (hcd
->driver
->flags
& HCD_USB2
) {
406 bufp
= hs_rh_config_descriptor
;
407 len
= sizeof hs_rh_config_descriptor
;
409 bufp
= fs_rh_config_descriptor
;
410 len
= sizeof fs_rh_config_descriptor
;
415 case USB_DT_STRING
<< 8:
416 n
= rh_string (wValue
& 0xff, hcd
, ubuf
, wLength
);
419 urb
->actual_length
= n
;
425 case DeviceRequest
| USB_REQ_GET_INTERFACE
:
429 case DeviceOutRequest
| USB_REQ_SET_INTERFACE
:
431 case DeviceOutRequest
| USB_REQ_SET_ADDRESS
:
432 // wValue == urb->dev->devaddr
433 dev_dbg (hcd
->self
.controller
, "root hub device address %d\n",
437 /* INTERFACE REQUESTS (no defined feature/status flags) */
439 /* ENDPOINT REQUESTS */
441 case EndpointRequest
| USB_REQ_GET_STATUS
:
442 // ENDPOINT_HALT flag
447 case EndpointOutRequest
| USB_REQ_CLEAR_FEATURE
:
448 case EndpointOutRequest
| USB_REQ_SET_FEATURE
:
449 dev_dbg (hcd
->self
.controller
, "no endpoint features yet\n");
452 /* CLASS REQUESTS (and errors) */
455 /* non-generic request */
461 case GetHubDescriptor
:
462 len
= sizeof (struct usb_hub_descriptor
);
465 status
= hcd
->driver
->hub_control (hcd
,
466 typeReq
, wValue
, wIndex
,
470 /* "protocol stall" on error */
476 if (status
!= -EPIPE
) {
477 dev_dbg (hcd
->self
.controller
,
478 "CTRL: TypeReq=0x%x val=0x%x "
479 "idx=0x%x len=%d ==> %d\n",
480 typeReq
, wValue
, wIndex
,
485 if (urb
->transfer_buffer_length
< len
)
486 len
= urb
->transfer_buffer_length
;
487 urb
->actual_length
= len
;
488 // always USB_DIR_IN, toward host
489 memcpy (ubuf
, bufp
, len
);
491 /* report whether RH hardware supports remote wakeup */
493 len
> offsetof (struct usb_config_descriptor
,
495 ((struct usb_config_descriptor
*)ubuf
)->bmAttributes
496 |= USB_CONFIG_ATT_WAKEUP
;
499 /* any errors get returned through the urb completion */
500 local_irq_save (flags
);
501 spin_lock (&urb
->lock
);
502 if (urb
->status
== -EINPROGRESS
)
503 urb
->status
= status
;
504 spin_unlock (&urb
->lock
);
505 usb_hcd_giveback_urb (hcd
, urb
, NULL
);
506 local_irq_restore (flags
);
510 /*-------------------------------------------------------------------------*/
513 * Root Hub interrupt transfers are polled using a timer if the
514 * driver requests it; otherwise the driver is responsible for
515 * calling usb_hcd_poll_rh_status() when an event occurs.
517 * Completions are called in_interrupt(), but they may or may not
520 void usb_hcd_poll_rh_status(struct usb_hcd
*hcd
)
525 char buffer
[4]; /* Any root hubs with > 31 ports? */
527 if (!hcd
->uses_new_polling
&& !hcd
->status_urb
)
530 length
= hcd
->driver
->hub_status_data(hcd
, buffer
);
533 /* try to complete the status urb */
534 local_irq_save (flags
);
535 spin_lock(&hcd_root_hub_lock
);
536 urb
= hcd
->status_urb
;
538 spin_lock(&urb
->lock
);
539 if (urb
->status
== -EINPROGRESS
) {
540 hcd
->poll_pending
= 0;
541 hcd
->status_urb
= NULL
;
544 urb
->actual_length
= length
;
545 memcpy(urb
->transfer_buffer
, buffer
, length
);
546 } else /* urb has been unlinked */
548 spin_unlock(&urb
->lock
);
551 spin_unlock(&hcd_root_hub_lock
);
553 /* local irqs are always blocked in completions */
555 usb_hcd_giveback_urb (hcd
, urb
, NULL
);
557 hcd
->poll_pending
= 1;
558 local_irq_restore (flags
);
561 /* The USB 2.0 spec says 256 ms. This is close enough and won't
562 * exceed that limit if HZ is 100. */
563 if (hcd
->uses_new_polling
? hcd
->poll_rh
:
564 (length
== 0 && hcd
->status_urb
!= NULL
))
565 mod_timer (&hcd
->rh_timer
, jiffies
+ msecs_to_jiffies(250));
567 EXPORT_SYMBOL_GPL(usb_hcd_poll_rh_status
);
570 static void rh_timer_func (unsigned long _hcd
)
572 usb_hcd_poll_rh_status((struct usb_hcd
*) _hcd
);
575 /*-------------------------------------------------------------------------*/
577 static int rh_queue_status (struct usb_hcd
*hcd
, struct urb
*urb
)
581 int len
= 1 + (urb
->dev
->maxchild
/ 8);
583 spin_lock_irqsave (&hcd_root_hub_lock
, flags
);
584 if (urb
->status
!= -EINPROGRESS
) /* already unlinked */
585 retval
= urb
->status
;
586 else if (hcd
->status_urb
|| urb
->transfer_buffer_length
< len
) {
587 dev_dbg (hcd
->self
.controller
, "not queuing rh status urb\n");
590 hcd
->status_urb
= urb
;
591 urb
->hcpriv
= hcd
; /* indicate it's queued */
593 if (!hcd
->uses_new_polling
)
594 mod_timer (&hcd
->rh_timer
, jiffies
+
595 msecs_to_jiffies(250));
597 /* If a status change has already occurred, report it ASAP */
598 else if (hcd
->poll_pending
)
599 mod_timer (&hcd
->rh_timer
, jiffies
);
602 spin_unlock_irqrestore (&hcd_root_hub_lock
, flags
);
606 static int rh_urb_enqueue (struct usb_hcd
*hcd
, struct urb
*urb
)
608 if (usb_pipeint (urb
->pipe
))
609 return rh_queue_status (hcd
, urb
);
610 if (usb_pipecontrol (urb
->pipe
))
611 return rh_call_control (hcd
, urb
);
615 /*-------------------------------------------------------------------------*/
617 /* Asynchronous unlinks of root-hub control URBs are legal, but they
618 * don't do anything. Status URB unlinks must be made in process context
619 * with interrupts enabled.
621 static int usb_rh_urb_dequeue (struct usb_hcd
*hcd
, struct urb
*urb
)
623 if (usb_pipeendpoint(urb
->pipe
) == 0) { /* Control URB */
625 return 0; /* nothing to do */
627 spin_lock_irq(&urb
->lock
); /* from usb_kill_urb */
629 spin_unlock_irq(&urb
->lock
);
631 wait_event(usb_kill_urb_queue
,
632 atomic_read(&urb
->use_count
) == 0);
634 spin_lock_irq(&urb
->lock
);
636 spin_unlock_irq(&urb
->lock
);
638 } else { /* Status URB */
639 if (!hcd
->uses_new_polling
)
640 del_timer_sync (&hcd
->rh_timer
);
641 local_irq_disable ();
642 spin_lock (&hcd_root_hub_lock
);
643 if (urb
== hcd
->status_urb
) {
644 hcd
->status_urb
= NULL
;
647 urb
= NULL
; /* wasn't fully queued */
648 spin_unlock (&hcd_root_hub_lock
);
650 usb_hcd_giveback_urb (hcd
, urb
, NULL
);
657 /*-------------------------------------------------------------------------*/
659 /* exported only within usbcore */
660 struct usb_bus
*usb_bus_get(struct usb_bus
*bus
)
663 kref_get(&bus
->kref
);
667 static void usb_host_release(struct kref
*kref
)
669 struct usb_bus
*bus
= container_of(kref
, struct usb_bus
, kref
);
675 /* exported only within usbcore */
676 void usb_bus_put(struct usb_bus
*bus
)
679 kref_put(&bus
->kref
, usb_host_release
);
682 /*-------------------------------------------------------------------------*/
684 static struct class *usb_host_class
;
686 int usb_host_init(void)
690 usb_host_class
= class_create(THIS_MODULE
, "usb_host");
691 if (IS_ERR(usb_host_class
))
692 retval
= PTR_ERR(usb_host_class
);
696 void usb_host_cleanup(void)
698 class_destroy(usb_host_class
);
702 * usb_bus_init - shared initialization code
703 * @bus: the bus structure being initialized
705 * This code is used to initialize a usb_bus structure, memory for which is
706 * separately managed.
708 static void usb_bus_init (struct usb_bus
*bus
)
710 memset (&bus
->devmap
, 0, sizeof(struct usb_devmap
));
712 bus
->devnum_next
= 1;
714 bus
->root_hub
= NULL
;
717 bus
->bandwidth_allocated
= 0;
718 bus
->bandwidth_int_reqs
= 0;
719 bus
->bandwidth_isoc_reqs
= 0;
721 INIT_LIST_HEAD (&bus
->bus_list
);
723 kref_init(&bus
->kref
);
727 * usb_alloc_bus - creates a new USB host controller structure
728 * @op: pointer to a struct usb_operations that this bus structure should use
729 * Context: !in_interrupt()
731 * Creates a USB host controller bus structure with the specified
732 * usb_operations and initializes all the necessary internal objects.
734 * If no memory is available, NULL is returned.
736 * The caller should call usb_put_bus() when it is finished with the structure.
738 struct usb_bus
*usb_alloc_bus (struct usb_operations
*op
)
742 bus
= kzalloc (sizeof *bus
, GFP_KERNEL
);
750 /*-------------------------------------------------------------------------*/
753 * usb_register_bus - registers the USB host controller with the usb core
754 * @bus: pointer to the bus to register
755 * Context: !in_interrupt()
757 * Assigns a bus number, and links the controller into usbcore data
758 * structures so that it can be seen by scanning the bus list.
760 static int usb_register_bus(struct usb_bus
*bus
)
764 down (&usb_bus_list_lock
);
765 busnum
= find_next_zero_bit (busmap
.busmap
, USB_MAXBUS
, 1);
766 if (busnum
< USB_MAXBUS
) {
767 set_bit (busnum
, busmap
.busmap
);
768 bus
->busnum
= busnum
;
770 printk (KERN_ERR
"%s: too many buses\n", usbcore_name
);
771 up(&usb_bus_list_lock
);
775 bus
->class_dev
= class_device_create(usb_host_class
, NULL
, MKDEV(0,0),
776 bus
->controller
, "usb_host%d", busnum
);
777 if (IS_ERR(bus
->class_dev
)) {
778 clear_bit(busnum
, busmap
.busmap
);
779 up(&usb_bus_list_lock
);
780 return PTR_ERR(bus
->class_dev
);
783 class_set_devdata(bus
->class_dev
, bus
);
785 /* Add it to the local list of buses */
786 list_add (&bus
->bus_list
, &usb_bus_list
);
787 up (&usb_bus_list_lock
);
789 usb_notify_add_bus(bus
);
791 dev_info (bus
->controller
, "new USB bus registered, assigned bus number %d\n", bus
->busnum
);
796 * usb_deregister_bus - deregisters the USB host controller
797 * @bus: pointer to the bus to deregister
798 * Context: !in_interrupt()
800 * Recycles the bus number, and unlinks the controller from usbcore data
801 * structures so that it won't be seen by scanning the bus list.
803 static void usb_deregister_bus (struct usb_bus
*bus
)
805 dev_info (bus
->controller
, "USB bus %d deregistered\n", bus
->busnum
);
808 * NOTE: make sure that all the devices are removed by the
809 * controller code, as well as having it call this when cleaning
812 down (&usb_bus_list_lock
);
813 list_del (&bus
->bus_list
);
814 up (&usb_bus_list_lock
);
816 usb_notify_remove_bus(bus
);
818 clear_bit (bus
->busnum
, busmap
.busmap
);
820 class_device_unregister(bus
->class_dev
);
824 * register_root_hub - called by usb_add_hcd() to register a root hub
825 * @usb_dev: the usb root hub device to be registered.
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 stores the root_hub pointer
830 * in the bus structure, then calls usb_new_device() to register the usb
831 * device. It also assigns the root hub's USB address (always 1).
833 static int register_root_hub (struct usb_device
*usb_dev
,
836 struct device
*parent_dev
= hcd
->self
.controller
;
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 down (&usb_bus_list_lock
);
848 usb_dev
->bus
->root_hub
= usb_dev
;
850 usb_dev
->ep0
.desc
.wMaxPacketSize
= __constant_cpu_to_le16(64);
851 retval
= usb_get_device_descriptor(usb_dev
, USB_DT_DEVICE_SIZE
);
852 if (retval
!= sizeof usb_dev
->descriptor
) {
853 usb_dev
->bus
->root_hub
= NULL
;
854 up (&usb_bus_list_lock
);
855 dev_dbg (parent_dev
, "can't read %s device descriptor %d\n",
856 usb_dev
->dev
.bus_id
, retval
);
857 return (retval
< 0) ? retval
: -EMSGSIZE
;
860 usb_lock_device (usb_dev
);
861 retval
= usb_new_device (usb_dev
);
862 usb_unlock_device (usb_dev
);
864 usb_dev
->bus
->root_hub
= NULL
;
865 dev_err (parent_dev
, "can't register root hub for %s, %d\n",
866 usb_dev
->dev
.bus_id
, retval
);
868 up (&usb_bus_list_lock
);
871 spin_lock_irq (&hcd_root_hub_lock
);
872 hcd
->rh_registered
= 1;
873 spin_unlock_irq (&hcd_root_hub_lock
);
875 /* Did the HC die before the root hub was registered? */
876 if (hcd
->state
== HC_STATE_HALT
)
877 usb_hc_died (hcd
); /* This time clean up */
883 void usb_enable_root_hub_irq (struct usb_bus
*bus
)
887 hcd
= container_of (bus
, struct usb_hcd
, self
);
888 if (hcd
->driver
->hub_irq_enable
&& !hcd
->poll_rh
&&
889 hcd
->state
!= HC_STATE_HALT
)
890 hcd
->driver
->hub_irq_enable (hcd
);
894 /*-------------------------------------------------------------------------*/
897 * usb_calc_bus_time - approximate periodic transaction time in nanoseconds
898 * @speed: from dev->speed; USB_SPEED_{LOW,FULL,HIGH}
899 * @is_input: true iff the transaction sends data to the host
900 * @isoc: true for isochronous transactions, false for interrupt ones
901 * @bytecount: how many bytes in the transaction.
903 * Returns approximate bus time in nanoseconds for a periodic transaction.
904 * See USB 2.0 spec section 5.11.3; only periodic transfers need to be
905 * scheduled in software, this function is only used for such scheduling.
907 long usb_calc_bus_time (int speed
, int is_input
, int isoc
, int bytecount
)
912 case USB_SPEED_LOW
: /* INTR only */
914 tmp
= (67667L * (31L + 10L * BitTime (bytecount
))) / 1000L;
915 return (64060L + (2 * BW_HUB_LS_SETUP
) + BW_HOST_DELAY
+ tmp
);
917 tmp
= (66700L * (31L + 10L * BitTime (bytecount
))) / 1000L;
918 return (64107L + (2 * BW_HUB_LS_SETUP
) + BW_HOST_DELAY
+ tmp
);
920 case USB_SPEED_FULL
: /* ISOC or INTR */
922 tmp
= (8354L * (31L + 10L * BitTime (bytecount
))) / 1000L;
923 return (((is_input
) ? 7268L : 6265L) + BW_HOST_DELAY
+ tmp
);
925 tmp
= (8354L * (31L + 10L * BitTime (bytecount
))) / 1000L;
926 return (9107L + BW_HOST_DELAY
+ tmp
);
928 case USB_SPEED_HIGH
: /* ISOC or INTR */
929 // FIXME adjust for input vs output
931 tmp
= HS_NSECS_ISO (bytecount
);
933 tmp
= HS_NSECS (bytecount
);
936 pr_debug ("%s: bogus device speed!\n", usbcore_name
);
940 EXPORT_SYMBOL (usb_calc_bus_time
);
943 * usb_check_bandwidth():
945 * old_alloc is from host_controller->bandwidth_allocated in microseconds;
946 * bustime is from calc_bus_time(), but converted to microseconds.
948 * returns <bustime in us> if successful,
949 * or -ENOSPC if bandwidth request fails.
952 * This initial implementation does not use Endpoint.bInterval
953 * in managing bandwidth allocation.
954 * It probably needs to be expanded to use Endpoint.bInterval.
955 * This can be done as a later enhancement (correction).
957 * This will also probably require some kind of
958 * frame allocation tracking...meaning, for example,
959 * that if multiple drivers request interrupts every 10 USB frames,
960 * they don't all have to be allocated at
961 * frame numbers N, N+10, N+20, etc. Some of them could be at
962 * N+11, N+21, N+31, etc., and others at
963 * N+12, N+22, N+32, etc.
965 * Similarly for isochronous transfers...
967 * Individual HCDs can schedule more directly ... this logic
968 * is not correct for high speed transfers.
970 int usb_check_bandwidth (struct usb_device
*dev
, struct urb
*urb
)
972 unsigned int pipe
= urb
->pipe
;
974 int is_in
= usb_pipein (pipe
);
975 int is_iso
= usb_pipeisoc (pipe
);
976 int old_alloc
= dev
->bus
->bandwidth_allocated
;
980 bustime
= NS_TO_US (usb_calc_bus_time (dev
->speed
, is_in
, is_iso
,
981 usb_maxpacket (dev
, pipe
, !is_in
)));
983 bustime
/= urb
->number_of_packets
;
985 new_alloc
= old_alloc
+ (int) bustime
;
986 if (new_alloc
> FRAME_TIME_MAX_USECS_ALLOC
) {
989 #ifdef CONFIG_USB_BANDWIDTH
994 dev_dbg (&dev
->dev
, "usb_check_bandwidth %sFAILED: %d + %ld = %d usec\n",
995 mode
, old_alloc
, bustime
, new_alloc
);
997 #ifdef CONFIG_USB_BANDWIDTH
998 bustime
= -ENOSPC
; /* report error */
1004 EXPORT_SYMBOL (usb_check_bandwidth
);
1008 * usb_claim_bandwidth - records bandwidth for a periodic transfer
1009 * @dev: source/target of request
1010 * @urb: request (urb->dev == dev)
1011 * @bustime: bandwidth consumed, in (average) microseconds per frame
1012 * @isoc: true iff the request is isochronous
1014 * Bus bandwidth reservations are recorded purely for diagnostic purposes.
1015 * HCDs are expected not to overcommit periodic bandwidth, and to record such
1016 * reservations whenever endpoints are added to the periodic schedule.
1018 * FIXME averaging per-frame is suboptimal. Better to sum over the HCD's
1019 * entire periodic schedule ... 32 frames for OHCI, 1024 for UHCI, settable
1020 * for EHCI (256/512/1024 frames, default 1024) and have the bus expose how
1021 * large its periodic schedule is.
1023 void usb_claim_bandwidth (struct usb_device
*dev
, struct urb
*urb
, int bustime
, int isoc
)
1025 dev
->bus
->bandwidth_allocated
+= bustime
;
1027 dev
->bus
->bandwidth_isoc_reqs
++;
1029 dev
->bus
->bandwidth_int_reqs
++;
1030 urb
->bandwidth
= bustime
;
1032 #ifdef USB_BANDWIDTH_MESSAGES
1033 dev_dbg (&dev
->dev
, "bandwidth alloc increased by %d (%s) to %d for %d requesters\n",
1035 isoc
? "ISOC" : "INTR",
1036 dev
->bus
->bandwidth_allocated
,
1037 dev
->bus
->bandwidth_int_reqs
+ dev
->bus
->bandwidth_isoc_reqs
);
1040 EXPORT_SYMBOL (usb_claim_bandwidth
);
1044 * usb_release_bandwidth - reverses effect of usb_claim_bandwidth()
1045 * @dev: source/target of request
1046 * @urb: request (urb->dev == dev)
1047 * @isoc: true iff the request is isochronous
1049 * This records that previously allocated bandwidth has been released.
1050 * Bandwidth is released when endpoints are removed from the host controller's
1051 * periodic schedule.
1053 void usb_release_bandwidth (struct usb_device
*dev
, struct urb
*urb
, int isoc
)
1055 dev
->bus
->bandwidth_allocated
-= urb
->bandwidth
;
1057 dev
->bus
->bandwidth_isoc_reqs
--;
1059 dev
->bus
->bandwidth_int_reqs
--;
1061 #ifdef USB_BANDWIDTH_MESSAGES
1062 dev_dbg (&dev
->dev
, "bandwidth alloc reduced by %d (%s) to %d for %d requesters\n",
1064 isoc
? "ISOC" : "INTR",
1065 dev
->bus
->bandwidth_allocated
,
1066 dev
->bus
->bandwidth_int_reqs
+ dev
->bus
->bandwidth_isoc_reqs
);
1070 EXPORT_SYMBOL (usb_release_bandwidth
);
1073 /*-------------------------------------------------------------------------*/
1076 * Generic HC operations.
1079 /*-------------------------------------------------------------------------*/
1081 static void urb_unlink (struct urb
*urb
)
1083 unsigned long flags
;
1085 /* Release any periodic transfer bandwidth */
1087 usb_release_bandwidth (urb
->dev
, urb
,
1088 usb_pipeisoc (urb
->pipe
));
1090 /* clear all state linking urb to this dev (and hcd) */
1092 spin_lock_irqsave (&hcd_data_lock
, flags
);
1093 list_del_init (&urb
->urb_list
);
1094 spin_unlock_irqrestore (&hcd_data_lock
, flags
);
1095 usb_put_dev (urb
->dev
);
1099 /* may be called in any context with a valid urb->dev usecount
1100 * caller surrenders "ownership" of urb
1101 * expects usb_submit_urb() to have sanity checked and conditioned all
1104 static int hcd_submit_urb (struct urb
*urb
, gfp_t mem_flags
)
1107 struct usb_hcd
*hcd
= urb
->dev
->bus
->hcpriv
;
1108 struct usb_host_endpoint
*ep
;
1109 unsigned long flags
;
1114 usbmon_urb_submit(&hcd
->self
, urb
);
1117 * Atomically queue the urb, first to our records, then to the HCD.
1118 * Access to urb->status is controlled by urb->lock ... changes on
1119 * i/o completion (normal or fault) or unlinking.
1122 // FIXME: verify that quiescing hc works right (RH cleans up)
1124 spin_lock_irqsave (&hcd_data_lock
, flags
);
1125 ep
= (usb_pipein(urb
->pipe
) ? urb
->dev
->ep_in
: urb
->dev
->ep_out
)
1126 [usb_pipeendpoint(urb
->pipe
)];
1129 else if (unlikely (urb
->reject
))
1131 else switch (hcd
->state
) {
1132 case HC_STATE_RUNNING
:
1133 case HC_STATE_RESUMING
:
1135 usb_get_dev (urb
->dev
);
1136 list_add_tail (&urb
->urb_list
, &ep
->urb_list
);
1139 case HC_STATE_SUSPENDED
:
1140 /* HC upstream links (register access, wakeup signaling) can work
1141 * even when the downstream links (and DMA etc) are quiesced; let
1142 * usbcore talk to the root hub.
1144 if (hcd
->self
.controller
->power
.power_state
.event
== PM_EVENT_ON
1145 && urb
->dev
->parent
== NULL
)
1149 status
= -ESHUTDOWN
;
1152 spin_unlock_irqrestore (&hcd_data_lock
, flags
);
1154 INIT_LIST_HEAD (&urb
->urb_list
);
1155 usbmon_urb_submit_error(&hcd
->self
, urb
, status
);
1159 /* increment urb's reference count as part of giving it to the HCD
1160 * (which now controls it). HCD guarantees that it either returns
1161 * an error or calls giveback(), but not both.
1163 urb
= usb_get_urb (urb
);
1164 atomic_inc (&urb
->use_count
);
1166 if (urb
->dev
== hcd
->self
.root_hub
) {
1167 /* NOTE: requirement on hub callers (usbfs and the hub
1168 * driver, for now) that URBs' urb->transfer_buffer be
1169 * valid and usb_buffer_{sync,unmap}() not be needed, since
1170 * they could clobber root hub response data.
1172 status
= rh_urb_enqueue (hcd
, urb
);
1176 /* lower level hcd code should use *_dma exclusively,
1177 * unless it uses pio or talks to another transport.
1179 if (hcd
->self
.controller
->dma_mask
) {
1180 if (usb_pipecontrol (urb
->pipe
)
1181 && !(urb
->transfer_flags
& URB_NO_SETUP_DMA_MAP
))
1182 urb
->setup_dma
= dma_map_single (
1183 hcd
->self
.controller
,
1185 sizeof (struct usb_ctrlrequest
),
1187 if (urb
->transfer_buffer_length
!= 0
1188 && !(urb
->transfer_flags
& URB_NO_TRANSFER_DMA_MAP
))
1189 urb
->transfer_dma
= dma_map_single (
1190 hcd
->self
.controller
,
1191 urb
->transfer_buffer
,
1192 urb
->transfer_buffer_length
,
1193 usb_pipein (urb
->pipe
)
1198 status
= hcd
->driver
->urb_enqueue (hcd
, ep
, urb
, mem_flags
);
1200 if (unlikely (status
)) {
1202 atomic_dec (&urb
->use_count
);
1204 wake_up (&usb_kill_urb_queue
);
1206 usbmon_urb_submit_error(&hcd
->self
, urb
, status
);
1211 /*-------------------------------------------------------------------------*/
1213 /* called in any context */
1214 static int hcd_get_frame_number (struct usb_device
*udev
)
1216 struct usb_hcd
*hcd
= (struct usb_hcd
*)udev
->bus
->hcpriv
;
1217 if (!HC_IS_RUNNING (hcd
->state
))
1219 return hcd
->driver
->get_frame_number (hcd
);
1222 /*-------------------------------------------------------------------------*/
1224 /* this makes the hcd giveback() the urb more quickly, by kicking it
1225 * off hardware queues (which may take a while) and returning it as
1226 * soon as practical. we've already set up the urb's return status,
1227 * but we can't know if the callback completed already.
1230 unlink1 (struct usb_hcd
*hcd
, struct urb
*urb
)
1234 if (urb
->dev
== hcd
->self
.root_hub
)
1235 value
= usb_rh_urb_dequeue (hcd
, urb
);
1238 /* The only reason an HCD might fail this call is if
1239 * it has not yet fully queued the urb to begin with.
1240 * Such failures should be harmless. */
1241 value
= hcd
->driver
->urb_dequeue (hcd
, urb
);
1245 dev_dbg (hcd
->self
.controller
, "dequeue %p --> %d\n",
1251 * called in any context
1253 * caller guarantees urb won't be recycled till both unlink()
1254 * and the urb's completion function return
1256 static int hcd_unlink_urb (struct urb
*urb
, int status
)
1258 struct usb_host_endpoint
*ep
;
1259 struct usb_hcd
*hcd
= NULL
;
1260 struct device
*sys
= NULL
;
1261 unsigned long flags
;
1262 struct list_head
*tmp
;
1267 if (!urb
->dev
|| !urb
->dev
->bus
)
1269 ep
= (usb_pipein(urb
->pipe
) ? urb
->dev
->ep_in
: urb
->dev
->ep_out
)
1270 [usb_pipeendpoint(urb
->pipe
)];
1275 * we contend for urb->status with the hcd core,
1276 * which changes it while returning the urb.
1278 * Caller guaranteed that the urb pointer hasn't been freed, and
1279 * that it was submitted. But as a rule it can't know whether or
1280 * not it's already been unlinked ... so we respect the reversed
1281 * lock sequence needed for the usb_hcd_giveback_urb() code paths
1282 * (urb lock, then hcd_data_lock) in case some other CPU is now
1285 spin_lock_irqsave (&urb
->lock
, flags
);
1286 spin_lock (&hcd_data_lock
);
1288 sys
= &urb
->dev
->dev
;
1289 hcd
= urb
->dev
->bus
->hcpriv
;
1295 /* insist the urb is still queued */
1296 list_for_each(tmp
, &ep
->urb_list
) {
1297 if (tmp
== &urb
->urb_list
)
1300 if (tmp
!= &urb
->urb_list
) {
1305 /* Any status except -EINPROGRESS means something already started to
1306 * unlink this URB from the hardware. So there's no more work to do.
1308 if (urb
->status
!= -EINPROGRESS
) {
1313 /* IRQ setup can easily be broken so that USB controllers
1314 * never get completion IRQs ... maybe even the ones we need to
1315 * finish unlinking the initial failed usb_set_address()
1316 * or device descriptor fetch.
1318 if (!test_bit(HCD_FLAG_SAW_IRQ
, &hcd
->flags
)
1319 && hcd
->self
.root_hub
!= urb
->dev
) {
1320 dev_warn (hcd
->self
.controller
, "Unlink after no-IRQ? "
1321 "Controller is probably using the wrong IRQ."
1323 set_bit(HCD_FLAG_SAW_IRQ
, &hcd
->flags
);
1326 urb
->status
= status
;
1328 spin_unlock (&hcd_data_lock
);
1329 spin_unlock_irqrestore (&urb
->lock
, flags
);
1331 retval
= unlink1 (hcd
, urb
);
1333 retval
= -EINPROGRESS
;
1337 spin_unlock (&hcd_data_lock
);
1338 spin_unlock_irqrestore (&urb
->lock
, flags
);
1339 if (retval
!= -EIDRM
&& sys
&& sys
->driver
)
1340 dev_dbg (sys
, "hcd_unlink_urb %p fail %d\n", urb
, retval
);
1344 /*-------------------------------------------------------------------------*/
1346 /* disables the endpoint: cancels any pending urbs, then synchronizes with
1347 * the hcd to make sure all endpoint state is gone from hardware. use for
1348 * set_configuration, set_interface, driver removal, physical disconnect.
1350 * example: a qh stored in ep->hcpriv, holding state related to endpoint
1351 * type, maxpacket size, toggle, halt status, and scheduling.
1354 hcd_endpoint_disable (struct usb_device
*udev
, struct usb_host_endpoint
*ep
)
1356 struct usb_hcd
*hcd
;
1359 hcd
= udev
->bus
->hcpriv
;
1361 WARN_ON (!HC_IS_RUNNING (hcd
->state
) && hcd
->state
!= HC_STATE_HALT
&&
1362 udev
->state
!= USB_STATE_NOTATTACHED
);
1364 local_irq_disable ();
1366 /* FIXME move most of this into message.c as part of its
1367 * endpoint disable logic
1370 /* ep is already gone from udev->ep_{in,out}[]; no more submits */
1372 spin_lock (&hcd_data_lock
);
1373 list_for_each_entry (urb
, &ep
->urb_list
, urb_list
) {
1376 /* another cpu may be in hcd, spinning on hcd_data_lock
1377 * to giveback() this urb. the races here should be
1378 * small, but a full fix needs a new "can't submit"
1380 * FIXME urb->reject should allow that...
1382 if (urb
->status
!= -EINPROGRESS
)
1385 spin_unlock (&hcd_data_lock
);
1387 spin_lock (&urb
->lock
);
1389 if (tmp
== -EINPROGRESS
)
1390 urb
->status
= -ESHUTDOWN
;
1391 spin_unlock (&urb
->lock
);
1393 /* kick hcd unless it's already returning this */
1394 if (tmp
== -EINPROGRESS
) {
1397 dev_dbg (hcd
->self
.controller
,
1398 "shutdown urb %p pipe %08x ep%d%s%s\n",
1399 urb
, tmp
, usb_pipeendpoint (tmp
),
1400 (tmp
& USB_DIR_IN
) ? "in" : "out",
1402 switch (usb_pipetype (tmp
)) { \
1403 case PIPE_CONTROL
: s
= ""; break; \
1404 case PIPE_BULK
: s
= "-bulk"; break; \
1405 case PIPE_INTERRUPT
: s
= "-intr"; break; \
1406 default: s
= "-iso"; break; \
1411 /* list contents may have changed */
1414 spin_unlock (&hcd_data_lock
);
1415 local_irq_enable ();
1417 /* synchronize with the hardware, so old configuration state
1418 * clears out immediately (and will be freed).
1421 if (hcd
->driver
->endpoint_disable
)
1422 hcd
->driver
->endpoint_disable (hcd
, ep
);
1425 /*-------------------------------------------------------------------------*/
1429 int hcd_bus_suspend (struct usb_bus
*bus
)
1431 struct usb_hcd
*hcd
;
1434 hcd
= container_of (bus
, struct usb_hcd
, self
);
1435 if (!hcd
->driver
->bus_suspend
)
1437 hcd
->state
= HC_STATE_QUIESCING
;
1438 status
= hcd
->driver
->bus_suspend (hcd
);
1440 hcd
->state
= HC_STATE_SUSPENDED
;
1442 dev_dbg(&bus
->root_hub
->dev
, "%s fail, err %d\n",
1447 int hcd_bus_resume (struct usb_bus
*bus
)
1449 struct usb_hcd
*hcd
;
1452 hcd
= container_of (bus
, struct usb_hcd
, self
);
1453 if (!hcd
->driver
->bus_resume
)
1455 if (hcd
->state
== HC_STATE_RUNNING
)
1457 hcd
->state
= HC_STATE_RESUMING
;
1458 status
= hcd
->driver
->bus_resume (hcd
);
1460 hcd
->state
= HC_STATE_RUNNING
;
1462 dev_dbg(&bus
->root_hub
->dev
, "%s fail, err %d\n",
1470 * usb_hcd_suspend_root_hub - HCD autosuspends downstream ports
1471 * @hcd: host controller for this root hub
1473 * This call arranges that usb_hcd_resume_root_hub() is safe to call later;
1474 * that the HCD's root hub polling is deactivated; and that the root's hub
1475 * driver is suspended. HCDs may call this to autosuspend when their root
1476 * hub's downstream ports are all inactive: unpowered, disconnected,
1477 * disabled, or suspended.
1479 * The HCD will autoresume on device connect change detection (using SRP
1480 * or a D+/D- pullup). The HCD also autoresumes on remote wakeup signaling
1481 * from any ports that are suspended (if that is enabled). In most cases,
1482 * overcurrent signaling (on powered ports) will also start autoresume.
1484 * Always called with IRQs blocked.
1486 void usb_hcd_suspend_root_hub (struct usb_hcd
*hcd
)
1490 spin_lock (&hcd_root_hub_lock
);
1491 usb_suspend_root_hub (hcd
->self
.root_hub
);
1493 /* force status urb to complete/unlink while suspended */
1494 if (hcd
->status_urb
) {
1495 urb
= hcd
->status_urb
;
1496 urb
->status
= -ECONNRESET
;
1498 urb
->actual_length
= 0;
1500 del_timer (&hcd
->rh_timer
);
1501 hcd
->poll_pending
= 0;
1502 hcd
->status_urb
= NULL
;
1505 spin_unlock (&hcd_root_hub_lock
);
1506 hcd
->state
= HC_STATE_SUSPENDED
;
1509 usb_hcd_giveback_urb (hcd
, urb
, NULL
);
1511 EXPORT_SYMBOL_GPL(usb_hcd_suspend_root_hub
);
1514 * usb_hcd_resume_root_hub - called by HCD to resume its root hub
1515 * @hcd: host controller for this root hub
1517 * The USB host controller calls this function when its root hub is
1518 * suspended (with the remote wakeup feature enabled) and a remote
1519 * wakeup request is received. It queues a request for khubd to
1520 * resume the root hub (that is, manage its downstream ports again).
1522 void usb_hcd_resume_root_hub (struct usb_hcd
*hcd
)
1524 unsigned long flags
;
1526 spin_lock_irqsave (&hcd_root_hub_lock
, flags
);
1527 if (hcd
->rh_registered
)
1528 usb_resume_root_hub (hcd
->self
.root_hub
);
1529 spin_unlock_irqrestore (&hcd_root_hub_lock
, flags
);
1531 EXPORT_SYMBOL_GPL(usb_hcd_resume_root_hub
);
1535 /*-------------------------------------------------------------------------*/
1537 #ifdef CONFIG_USB_OTG
1540 * usb_bus_start_enum - start immediate enumeration (for OTG)
1541 * @bus: the bus (must use hcd framework)
1542 * @port_num: 1-based number of port; usually bus->otg_port
1543 * Context: in_interrupt()
1545 * Starts enumeration, with an immediate reset followed later by
1546 * khubd identifying and possibly configuring the device.
1547 * This is needed by OTG controller drivers, where it helps meet
1548 * HNP protocol timing requirements for starting a port reset.
1550 int usb_bus_start_enum(struct usb_bus
*bus
, unsigned port_num
)
1552 struct usb_hcd
*hcd
;
1553 int status
= -EOPNOTSUPP
;
1555 /* NOTE: since HNP can't start by grabbing the bus's address0_sem,
1556 * boards with root hubs hooked up to internal devices (instead of
1557 * just the OTG port) may need more attention to resetting...
1559 hcd
= container_of (bus
, struct usb_hcd
, self
);
1560 if (port_num
&& hcd
->driver
->start_port_reset
)
1561 status
= hcd
->driver
->start_port_reset(hcd
, port_num
);
1563 /* run khubd shortly after (first) root port reset finishes;
1564 * it may issue others, until at least 50 msecs have passed.
1567 mod_timer(&hcd
->rh_timer
, jiffies
+ msecs_to_jiffies(10));
1570 EXPORT_SYMBOL (usb_bus_start_enum
);
1574 /*-------------------------------------------------------------------------*/
1577 * usb_hcd_operations - adapts usb_bus framework to HCD framework (bus glue)
1579 static struct usb_operations usb_hcd_operations
= {
1580 .get_frame_number
= hcd_get_frame_number
,
1581 .submit_urb
= hcd_submit_urb
,
1582 .unlink_urb
= hcd_unlink_urb
,
1583 .buffer_alloc
= hcd_buffer_alloc
,
1584 .buffer_free
= hcd_buffer_free
,
1585 .disable
= hcd_endpoint_disable
,
1588 /*-------------------------------------------------------------------------*/
1591 * usb_hcd_giveback_urb - return URB from HCD to device driver
1592 * @hcd: host controller returning the URB
1593 * @urb: urb being returned to the USB device driver.
1594 * @regs: pt_regs, passed down to the URB completion handler
1595 * Context: in_interrupt()
1597 * This hands the URB from HCD to its USB device driver, using its
1598 * completion function. The HCD has freed all per-urb resources
1599 * (and is done using urb->hcpriv). It also released all HCD locks;
1600 * the device driver won't cause problems if it frees, modifies,
1601 * or resubmits this URB.
1603 void usb_hcd_giveback_urb (struct usb_hcd
*hcd
, struct urb
*urb
, struct pt_regs
*regs
)
1607 at_root_hub
= (urb
->dev
== hcd
->self
.root_hub
);
1610 /* lower level hcd code should use *_dma exclusively */
1611 if (hcd
->self
.controller
->dma_mask
&& !at_root_hub
) {
1612 if (usb_pipecontrol (urb
->pipe
)
1613 && !(urb
->transfer_flags
& URB_NO_SETUP_DMA_MAP
))
1614 dma_unmap_single (hcd
->self
.controller
, urb
->setup_dma
,
1615 sizeof (struct usb_ctrlrequest
),
1617 if (urb
->transfer_buffer_length
!= 0
1618 && !(urb
->transfer_flags
& URB_NO_TRANSFER_DMA_MAP
))
1619 dma_unmap_single (hcd
->self
.controller
,
1621 urb
->transfer_buffer_length
,
1622 usb_pipein (urb
->pipe
)
1627 usbmon_urb_complete (&hcd
->self
, urb
);
1628 /* pass ownership to the completion handler */
1629 urb
->complete (urb
, regs
);
1630 atomic_dec (&urb
->use_count
);
1631 if (unlikely (urb
->reject
))
1632 wake_up (&usb_kill_urb_queue
);
1635 EXPORT_SYMBOL (usb_hcd_giveback_urb
);
1637 /*-------------------------------------------------------------------------*/
1640 * usb_hcd_irq - hook IRQs to HCD framework (bus glue)
1641 * @irq: the IRQ being raised
1642 * @__hcd: pointer to the HCD whose IRQ is being signaled
1643 * @r: saved hardware registers
1645 * If the controller isn't HALTed, calls the driver's irq handler.
1646 * Checks whether the controller is now dead.
1648 irqreturn_t
usb_hcd_irq (int irq
, void *__hcd
, struct pt_regs
* r
)
1650 struct usb_hcd
*hcd
= __hcd
;
1651 int start
= hcd
->state
;
1653 if (unlikely(start
== HC_STATE_HALT
||
1654 !test_bit(HCD_FLAG_HW_ACCESSIBLE
, &hcd
->flags
)))
1656 if (hcd
->driver
->irq (hcd
, r
) == IRQ_NONE
)
1659 set_bit(HCD_FLAG_SAW_IRQ
, &hcd
->flags
);
1661 if (unlikely(hcd
->state
== HC_STATE_HALT
))
1666 /*-------------------------------------------------------------------------*/
1669 * usb_hc_died - report abnormal shutdown of a host controller (bus glue)
1670 * @hcd: pointer to the HCD representing the controller
1672 * This is called by bus glue to report a USB host controller that died
1673 * while operations may still have been pending. It's called automatically
1674 * by the PCI glue, so only glue for non-PCI busses should need to call it.
1676 void usb_hc_died (struct usb_hcd
*hcd
)
1678 unsigned long flags
;
1680 dev_err (hcd
->self
.controller
, "HC died; cleaning up\n");
1682 spin_lock_irqsave (&hcd_root_hub_lock
, flags
);
1683 if (hcd
->rh_registered
) {
1686 /* make khubd clean up old urbs and devices */
1687 usb_set_device_state (hcd
->self
.root_hub
,
1688 USB_STATE_NOTATTACHED
);
1689 usb_kick_khubd (hcd
->self
.root_hub
);
1691 spin_unlock_irqrestore (&hcd_root_hub_lock
, flags
);
1693 EXPORT_SYMBOL_GPL (usb_hc_died
);
1695 /*-------------------------------------------------------------------------*/
1697 static void hcd_release (struct usb_bus
*bus
)
1699 struct usb_hcd
*hcd
;
1701 hcd
= container_of(bus
, struct usb_hcd
, self
);
1706 * usb_create_hcd - create and initialize an HCD structure
1707 * @driver: HC driver that will use this hcd
1708 * @dev: device for this HC, stored in hcd->self.controller
1709 * @bus_name: value to store in hcd->self.bus_name
1710 * Context: !in_interrupt()
1712 * Allocate a struct usb_hcd, with extra space at the end for the
1713 * HC driver's private data. Initialize the generic members of the
1716 * If memory is unavailable, returns NULL.
1718 struct usb_hcd
*usb_create_hcd (const struct hc_driver
*driver
,
1719 struct device
*dev
, char *bus_name
)
1721 struct usb_hcd
*hcd
;
1723 hcd
= kzalloc(sizeof(*hcd
) + driver
->hcd_priv_size
, GFP_KERNEL
);
1725 dev_dbg (dev
, "hcd alloc failed\n");
1728 dev_set_drvdata(dev
, hcd
);
1730 usb_bus_init(&hcd
->self
);
1731 hcd
->self
.op
= &usb_hcd_operations
;
1732 hcd
->self
.hcpriv
= hcd
;
1733 hcd
->self
.release
= &hcd_release
;
1734 hcd
->self
.controller
= dev
;
1735 hcd
->self
.bus_name
= bus_name
;
1737 init_timer(&hcd
->rh_timer
);
1738 hcd
->rh_timer
.function
= rh_timer_func
;
1739 hcd
->rh_timer
.data
= (unsigned long) hcd
;
1741 hcd
->driver
= driver
;
1742 hcd
->product_desc
= (driver
->product_desc
) ? driver
->product_desc
:
1743 "USB Host Controller";
1747 EXPORT_SYMBOL (usb_create_hcd
);
1749 void usb_put_hcd (struct usb_hcd
*hcd
)
1751 dev_set_drvdata(hcd
->self
.controller
, NULL
);
1752 usb_bus_put(&hcd
->self
);
1754 EXPORT_SYMBOL (usb_put_hcd
);
1757 * usb_add_hcd - finish generic HCD structure initialization and register
1758 * @hcd: the usb_hcd structure to initialize
1759 * @irqnum: Interrupt line to allocate
1760 * @irqflags: Interrupt type flags
1762 * Finish the remaining parts of generic HCD initialization: allocate the
1763 * buffers of consistent memory, register the bus, request the IRQ line,
1764 * and call the driver's reset() and start() routines.
1766 int usb_add_hcd(struct usb_hcd
*hcd
,
1767 unsigned int irqnum
, unsigned long irqflags
)
1770 struct usb_device
*rhdev
;
1772 dev_info(hcd
->self
.controller
, "%s\n", hcd
->product_desc
);
1774 set_bit(HCD_FLAG_HW_ACCESSIBLE
, &hcd
->flags
);
1776 /* till now HC has been in an indeterminate state ... */
1777 if (hcd
->driver
->reset
&& (retval
= hcd
->driver
->reset(hcd
)) < 0) {
1778 dev_err(hcd
->self
.controller
, "can't reset\n");
1782 if ((retval
= hcd_buffer_create(hcd
)) != 0) {
1783 dev_dbg(hcd
->self
.controller
, "pool alloc failed\n");
1787 if ((retval
= usb_register_bus(&hcd
->self
)) < 0)
1788 goto err_register_bus
;
1790 if (hcd
->driver
->irq
) {
1791 char buf
[8], *bufp
= buf
;
1794 bufp
= __irq_itoa(irqnum
);
1796 sprintf(buf
, "%d", irqnum
);
1799 snprintf(hcd
->irq_descr
, sizeof(hcd
->irq_descr
), "%s:usb%d",
1800 hcd
->driver
->description
, hcd
->self
.busnum
);
1801 if ((retval
= request_irq(irqnum
, &usb_hcd_irq
, irqflags
,
1802 hcd
->irq_descr
, hcd
)) != 0) {
1803 dev_err(hcd
->self
.controller
,
1804 "request interrupt %s failed\n", bufp
);
1805 goto err_request_irq
;
1808 dev_info(hcd
->self
.controller
, "irq %s, %s 0x%08llx\n", bufp
,
1809 (hcd
->driver
->flags
& HCD_MEMORY
) ?
1810 "io mem" : "io base",
1811 (unsigned long long)hcd
->rsrc_start
);
1814 if (hcd
->rsrc_start
)
1815 dev_info(hcd
->self
.controller
, "%s 0x%08llx\n",
1816 (hcd
->driver
->flags
& HCD_MEMORY
) ?
1817 "io mem" : "io base",
1818 (unsigned long long)hcd
->rsrc_start
);
1821 /* Allocate the root hub before calling hcd->driver->start(),
1822 * but don't register it until afterward so that the hardware
1825 if ((rhdev
= usb_alloc_dev(NULL
, &hcd
->self
, 0)) == NULL
) {
1826 dev_err(hcd
->self
.controller
, "unable to allocate root hub\n");
1828 goto err_allocate_root_hub
;
1830 rhdev
->speed
= (hcd
->driver
->flags
& HCD_USB2
) ? USB_SPEED_HIGH
:
1833 /* Although in principle hcd->driver->start() might need to use rhdev,
1834 * none of the current drivers do.
1836 if ((retval
= hcd
->driver
->start(hcd
)) < 0) {
1837 dev_err(hcd
->self
.controller
, "startup error %d\n", retval
);
1838 goto err_hcd_driver_start
;
1841 /* hcd->driver->start() reported can_wakeup, probably with
1842 * assistance from board's boot firmware.
1843 * NOTE: normal devices won't enable wakeup by default.
1845 if (hcd
->can_wakeup
)
1846 dev_dbg(hcd
->self
.controller
, "supports USB remote wakeup\n");
1847 hcd
->remote_wakeup
= hcd
->can_wakeup
;
1849 if ((retval
= register_root_hub(rhdev
, hcd
)) != 0)
1850 goto err_register_root_hub
;
1852 if (hcd
->uses_new_polling
&& hcd
->poll_rh
)
1853 usb_hcd_poll_rh_status(hcd
);
1856 err_register_root_hub
:
1857 hcd
->driver
->stop(hcd
);
1859 err_hcd_driver_start
:
1862 err_allocate_root_hub
:
1864 free_irq(irqnum
, hcd
);
1867 usb_deregister_bus(&hcd
->self
);
1870 hcd_buffer_destroy(hcd
);
1873 EXPORT_SYMBOL (usb_add_hcd
);
1876 * usb_remove_hcd - shutdown processing for generic HCDs
1877 * @hcd: the usb_hcd structure to remove
1878 * Context: !in_interrupt()
1880 * Disconnects the root hub, then reverses the effects of usb_add_hcd(),
1881 * invoking the HCD's stop() method.
1883 void usb_remove_hcd(struct usb_hcd
*hcd
)
1885 dev_info(hcd
->self
.controller
, "remove, state %x\n", hcd
->state
);
1887 if (HC_IS_RUNNING (hcd
->state
))
1888 hcd
->state
= HC_STATE_QUIESCING
;
1890 dev_dbg(hcd
->self
.controller
, "roothub graceful disconnect\n");
1891 spin_lock_irq (&hcd_root_hub_lock
);
1892 hcd
->rh_registered
= 0;
1893 spin_unlock_irq (&hcd_root_hub_lock
);
1894 usb_disconnect(&hcd
->self
.root_hub
);
1897 del_timer_sync(&hcd
->rh_timer
);
1899 hcd
->driver
->stop(hcd
);
1900 hcd
->state
= HC_STATE_HALT
;
1903 free_irq(hcd
->irq
, hcd
);
1904 usb_deregister_bus(&hcd
->self
);
1905 hcd_buffer_destroy(hcd
);
1907 EXPORT_SYMBOL (usb_remove_hcd
);
1909 /*-------------------------------------------------------------------------*/
1911 #if defined(CONFIG_USB_MON)
1913 struct usb_mon_operations
*mon_ops
;
1916 * The registration is unlocked.
1917 * We do it this way because we do not want to lock in hot paths.
1919 * Notice that the code is minimally error-proof. Because usbmon needs
1920 * symbols from usbcore, usbcore gets referenced and cannot be unloaded first.
1923 int usb_mon_register (struct usb_mon_operations
*ops
)
1933 EXPORT_SYMBOL_GPL (usb_mon_register
);
1935 void usb_mon_deregister (void)
1938 if (mon_ops
== NULL
) {
1939 printk(KERN_ERR
"USB: monitor was not registered\n");
1945 EXPORT_SYMBOL_GPL (usb_mon_deregister
);
1947 #endif /* CONFIG_USB_MON */