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>
27 #ifdef CONFIG_USB_DEBUG
31 #include <linux/module.h>
32 #include <linux/version.h>
33 #include <linux/kernel.h>
34 #include <linux/slab.h>
35 #include <linux/completion.h>
36 #include <linux/utsname.h>
39 #include <asm/scatterlist.h>
40 #include <linux/device.h>
41 #include <linux/dma-mapping.h>
43 #include <asm/byteorder.h>
45 #include <linux/usb.h>
52 // #define USB_BANDWIDTH_MESSAGES
54 /*-------------------------------------------------------------------------*/
57 * USB Host Controller Driver framework
59 * Plugs into usbcore (usb_bus) and lets HCDs share code, minimizing
60 * HCD-specific behaviors/bugs.
62 * This does error checks, tracks devices and urbs, and delegates to a
63 * "hc_driver" only for code (and data) that really needs to know about
64 * hardware differences. That includes root hub registers, i/o queues,
65 * and so on ... but as little else as possible.
67 * Shared code includes most of the "root hub" code (these are emulated,
68 * though each HC's hardware works differently) and PCI glue, plus request
69 * tracking overhead. The HCD code should only block on spinlocks or on
70 * hardware handshaking; blocking on software events (such as other kernel
71 * threads releasing resources, or completing actions) is all generic.
73 * Happens the USB 2.0 spec says this would be invisible inside the "USBD",
74 * and includes mostly a "HCDI" (HCD Interface) along with some APIs used
75 * only by the hub driver ... and that neither should be seen or used by
76 * usb client device drivers.
78 * Contributors of ideas or unattributed patches include: David Brownell,
79 * Roman Weissgaerber, Rory Bolt, Greg Kroah-Hartman, ...
82 * 2002-02-21 Pull in most of the usb_bus support from usb.c; some
83 * associated cleanup. "usb_hcd" still != "usb_bus".
84 * 2001-12-12 Initial patch version for Linux 2.5.1 kernel.
87 /*-------------------------------------------------------------------------*/
89 /* host controllers we manage */
90 LIST_HEAD (usb_bus_list
);
91 EXPORT_SYMBOL_GPL (usb_bus_list
);
93 /* used when allocating bus numbers */
96 unsigned long busmap
[USB_MAXBUS
/ (8*sizeof (unsigned long))];
98 static struct usb_busmap busmap
;
100 /* used when updating list of hcds */
101 DECLARE_MUTEX (usb_bus_list_lock
); /* exported only for usbfs */
102 EXPORT_SYMBOL_GPL (usb_bus_list_lock
);
104 /* used for controlling access to virtual root hubs */
105 static DEFINE_SPINLOCK(hcd_root_hub_lock
);
107 /* used when updating hcd data */
108 static DEFINE_SPINLOCK(hcd_data_lock
);
110 /* wait queue for synchronous unlinks */
111 DECLARE_WAIT_QUEUE_HEAD(usb_kill_urb_queue
);
113 /*-------------------------------------------------------------------------*/
116 * Sharable chunks of root hub code.
119 /*-------------------------------------------------------------------------*/
121 #define KERNEL_REL ((LINUX_VERSION_CODE >> 16) & 0x0ff)
122 #define KERNEL_VER ((LINUX_VERSION_CODE >> 8) & 0x0ff)
124 /* usb 2.0 root hub device descriptor */
125 static const u8 usb2_rh_dev_descriptor
[18] = {
126 0x12, /* __u8 bLength; */
127 0x01, /* __u8 bDescriptorType; Device */
128 0x00, 0x02, /* __le16 bcdUSB; v2.0 */
130 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
131 0x00, /* __u8 bDeviceSubClass; */
132 0x01, /* __u8 bDeviceProtocol; [ usb 2.0 single TT ]*/
133 0x08, /* __u8 bMaxPacketSize0; 8 Bytes */
135 0x00, 0x00, /* __le16 idVendor; */
136 0x00, 0x00, /* __le16 idProduct; */
137 KERNEL_VER
, KERNEL_REL
, /* __le16 bcdDevice */
139 0x03, /* __u8 iManufacturer; */
140 0x02, /* __u8 iProduct; */
141 0x01, /* __u8 iSerialNumber; */
142 0x01 /* __u8 bNumConfigurations; */
145 /* no usb 2.0 root hub "device qualifier" descriptor: one speed only */
147 /* usb 1.1 root hub device descriptor */
148 static const u8 usb11_rh_dev_descriptor
[18] = {
149 0x12, /* __u8 bLength; */
150 0x01, /* __u8 bDescriptorType; Device */
151 0x10, 0x01, /* __le16 bcdUSB; v1.1 */
153 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
154 0x00, /* __u8 bDeviceSubClass; */
155 0x00, /* __u8 bDeviceProtocol; [ low/full speeds only ] */
156 0x08, /* __u8 bMaxPacketSize0; 8 Bytes */
158 0x00, 0x00, /* __le16 idVendor; */
159 0x00, 0x00, /* __le16 idProduct; */
160 KERNEL_VER
, KERNEL_REL
, /* __le16 bcdDevice */
162 0x03, /* __u8 iManufacturer; */
163 0x02, /* __u8 iProduct; */
164 0x01, /* __u8 iSerialNumber; */
165 0x01 /* __u8 bNumConfigurations; */
169 /*-------------------------------------------------------------------------*/
171 /* Configuration descriptors for our root hubs */
173 static const u8 fs_rh_config_descriptor
[] = {
175 /* one configuration */
176 0x09, /* __u8 bLength; */
177 0x02, /* __u8 bDescriptorType; Configuration */
178 0x19, 0x00, /* __le16 wTotalLength; */
179 0x01, /* __u8 bNumInterfaces; (1) */
180 0x01, /* __u8 bConfigurationValue; */
181 0x00, /* __u8 iConfiguration; */
182 0xc0, /* __u8 bmAttributes;
187 0x00, /* __u8 MaxPower; */
190 * USB 2.0, single TT organization (mandatory):
191 * one interface, protocol 0
193 * USB 2.0, multiple TT organization (optional):
194 * two interfaces, protocols 1 (like single TT)
195 * and 2 (multiple TT mode) ... config is
201 0x09, /* __u8 if_bLength; */
202 0x04, /* __u8 if_bDescriptorType; Interface */
203 0x00, /* __u8 if_bInterfaceNumber; */
204 0x00, /* __u8 if_bAlternateSetting; */
205 0x01, /* __u8 if_bNumEndpoints; */
206 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
207 0x00, /* __u8 if_bInterfaceSubClass; */
208 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
209 0x00, /* __u8 if_iInterface; */
211 /* one endpoint (status change endpoint) */
212 0x07, /* __u8 ep_bLength; */
213 0x05, /* __u8 ep_bDescriptorType; Endpoint */
214 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
215 0x03, /* __u8 ep_bmAttributes; Interrupt */
216 0x02, 0x00, /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8) */
217 0xff /* __u8 ep_bInterval; (255ms -- usb 2.0 spec) */
220 static const u8 hs_rh_config_descriptor
[] = {
222 /* one configuration */
223 0x09, /* __u8 bLength; */
224 0x02, /* __u8 bDescriptorType; Configuration */
225 0x19, 0x00, /* __le16 wTotalLength; */
226 0x01, /* __u8 bNumInterfaces; (1) */
227 0x01, /* __u8 bConfigurationValue; */
228 0x00, /* __u8 iConfiguration; */
229 0xc0, /* __u8 bmAttributes;
234 0x00, /* __u8 MaxPower; */
237 * USB 2.0, single TT organization (mandatory):
238 * one interface, protocol 0
240 * USB 2.0, multiple TT organization (optional):
241 * two interfaces, protocols 1 (like single TT)
242 * and 2 (multiple TT mode) ... config is
248 0x09, /* __u8 if_bLength; */
249 0x04, /* __u8 if_bDescriptorType; Interface */
250 0x00, /* __u8 if_bInterfaceNumber; */
251 0x00, /* __u8 if_bAlternateSetting; */
252 0x01, /* __u8 if_bNumEndpoints; */
253 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
254 0x00, /* __u8 if_bInterfaceSubClass; */
255 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
256 0x00, /* __u8 if_iInterface; */
258 /* one endpoint (status change endpoint) */
259 0x07, /* __u8 ep_bLength; */
260 0x05, /* __u8 ep_bDescriptorType; Endpoint */
261 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
262 0x03, /* __u8 ep_bmAttributes; Interrupt */
263 0x02, 0x00, /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8) */
264 0x0c /* __u8 ep_bInterval; (256ms -- usb 2.0 spec) */
267 /*-------------------------------------------------------------------------*/
270 * helper routine for returning string descriptors in UTF-16LE
271 * input can actually be ISO-8859-1; ASCII is its 7-bit subset
273 static int ascii2utf (char *s
, u8
*utf
, int utfmax
)
277 for (retval
= 0; *s
&& utfmax
> 1; utfmax
-= 2, retval
+= 2) {
289 * rh_string - provides manufacturer, product and serial strings for root hub
290 * @id: the string ID number (1: serial number, 2: product, 3: vendor)
291 * @hcd: the host controller for this root hub
292 * @type: string describing our driver
293 * @data: return packet in UTF-16 LE
294 * @len: length of the return packet
296 * Produces either a manufacturer, product or serial number string for the
297 * virtual root hub device.
299 static int rh_string (
309 buf
[0] = 4; buf
[1] = 3; /* 4 bytes string data */
310 buf
[2] = 0x09; buf
[3] = 0x04; /* MSFT-speak for "en-us" */
312 memcpy (data
, buf
, len
);
316 } else if (id
== 1) {
317 strlcpy (buf
, hcd
->self
.bus_name
, sizeof buf
);
319 // product description
320 } else if (id
== 2) {
321 strlcpy (buf
, hcd
->product_desc
, sizeof buf
);
323 // id 3 == vendor description
324 } else if (id
== 3) {
325 snprintf (buf
, sizeof buf
, "%s %s %s", system_utsname
.sysname
,
326 system_utsname
.release
, hcd
->driver
->description
);
328 // unsupported IDs --> "protocol stall"
332 switch (len
) { /* All cases fall through */
334 len
= 2 + ascii2utf (buf
, data
+ 2, len
- 2);
336 data
[1] = 3; /* type == string */
338 data
[0] = 2 * (strlen (buf
) + 1);
340 ; /* Compiler wants a statement here */
346 /* Root hub control transfers execute synchronously */
347 static int rh_call_control (struct usb_hcd
*hcd
, struct urb
*urb
)
349 struct usb_ctrlrequest
*cmd
;
350 u16 typeReq
, wValue
, wIndex
, wLength
;
351 u8
*ubuf
= urb
->transfer_buffer
;
352 u8 tbuf
[sizeof (struct usb_hub_descriptor
)];
353 const u8
*bufp
= tbuf
;
355 int patch_wakeup
= 0;
360 cmd
= (struct usb_ctrlrequest
*) urb
->setup_packet
;
361 typeReq
= (cmd
->bRequestType
<< 8) | cmd
->bRequest
;
362 wValue
= le16_to_cpu (cmd
->wValue
);
363 wIndex
= le16_to_cpu (cmd
->wIndex
);
364 wLength
= le16_to_cpu (cmd
->wLength
);
366 if (wLength
> urb
->transfer_buffer_length
)
369 urb
->actual_length
= 0;
372 /* DEVICE REQUESTS */
374 case DeviceRequest
| USB_REQ_GET_STATUS
:
375 tbuf
[0] = (hcd
->remote_wakeup
<< USB_DEVICE_REMOTE_WAKEUP
)
376 | (1 << USB_DEVICE_SELF_POWERED
);
380 case DeviceOutRequest
| USB_REQ_CLEAR_FEATURE
:
381 if (wValue
== USB_DEVICE_REMOTE_WAKEUP
)
382 hcd
->remote_wakeup
= 0;
386 case DeviceOutRequest
| USB_REQ_SET_FEATURE
:
387 if (hcd
->can_wakeup
&& wValue
== USB_DEVICE_REMOTE_WAKEUP
)
388 hcd
->remote_wakeup
= 1;
392 case DeviceRequest
| USB_REQ_GET_CONFIGURATION
:
396 case DeviceOutRequest
| USB_REQ_SET_CONFIGURATION
:
398 case DeviceRequest
| USB_REQ_GET_DESCRIPTOR
:
399 switch (wValue
& 0xff00) {
400 case USB_DT_DEVICE
<< 8:
401 if (hcd
->driver
->flags
& HCD_USB2
)
402 bufp
= usb2_rh_dev_descriptor
;
403 else if (hcd
->driver
->flags
& HCD_USB11
)
404 bufp
= usb11_rh_dev_descriptor
;
409 case USB_DT_CONFIG
<< 8:
410 if (hcd
->driver
->flags
& HCD_USB2
) {
411 bufp
= hs_rh_config_descriptor
;
412 len
= sizeof hs_rh_config_descriptor
;
414 bufp
= fs_rh_config_descriptor
;
415 len
= sizeof fs_rh_config_descriptor
;
420 case USB_DT_STRING
<< 8:
421 n
= rh_string (wValue
& 0xff, hcd
, ubuf
, wLength
);
424 urb
->actual_length
= n
;
430 case DeviceRequest
| USB_REQ_GET_INTERFACE
:
434 case DeviceOutRequest
| USB_REQ_SET_INTERFACE
:
436 case DeviceOutRequest
| USB_REQ_SET_ADDRESS
:
437 // wValue == urb->dev->devaddr
438 dev_dbg (hcd
->self
.controller
, "root hub device address %d\n",
442 /* INTERFACE REQUESTS (no defined feature/status flags) */
444 /* ENDPOINT REQUESTS */
446 case EndpointRequest
| USB_REQ_GET_STATUS
:
447 // ENDPOINT_HALT flag
452 case EndpointOutRequest
| USB_REQ_CLEAR_FEATURE
:
453 case EndpointOutRequest
| USB_REQ_SET_FEATURE
:
454 dev_dbg (hcd
->self
.controller
, "no endpoint features yet\n");
457 /* CLASS REQUESTS (and errors) */
460 /* non-generic request */
461 if (HC_IS_SUSPENDED (hcd
->state
))
469 case GetHubDescriptor
:
470 len
= sizeof (struct usb_hub_descriptor
);
473 status
= hcd
->driver
->hub_control (hcd
,
474 typeReq
, wValue
, wIndex
,
479 /* "protocol stall" on error */
485 if (status
!= -EPIPE
) {
486 dev_dbg (hcd
->self
.controller
,
487 "CTRL: TypeReq=0x%x val=0x%x "
488 "idx=0x%x len=%d ==> %d\n",
489 typeReq
, wValue
, wIndex
,
490 wLength
, urb
->status
);
494 if (urb
->transfer_buffer_length
< len
)
495 len
= urb
->transfer_buffer_length
;
496 urb
->actual_length
= len
;
497 // always USB_DIR_IN, toward host
498 memcpy (ubuf
, bufp
, len
);
500 /* report whether RH hardware supports remote wakeup */
502 len
> offsetof (struct usb_config_descriptor
,
504 ((struct usb_config_descriptor
*)ubuf
)->bmAttributes
505 |= USB_CONFIG_ATT_WAKEUP
;
508 /* any errors get returned through the urb completion */
509 local_irq_save (flags
);
510 spin_lock (&urb
->lock
);
511 if (urb
->status
== -EINPROGRESS
)
512 urb
->status
= status
;
513 spin_unlock (&urb
->lock
);
514 usb_hcd_giveback_urb (hcd
, urb
, NULL
);
515 local_irq_restore (flags
);
519 /*-------------------------------------------------------------------------*/
522 * Root Hub interrupt transfers are synthesized with a timer.
523 * Completions are called in_interrupt() but not in_irq().
525 * Note: some root hubs (including common UHCI based designs) can't
526 * correctly issue port change IRQs. They're the ones that _need_ a
527 * timer; most other root hubs don't. Some systems could save a
528 * lot of battery power by eliminating these root hub timer IRQs.
531 static void rh_report_status (unsigned long ptr
);
533 static int rh_status_urb (struct usb_hcd
*hcd
, struct urb
*urb
)
535 int len
= 1 + (urb
->dev
->maxchild
/ 8);
537 /* rh_timer protected by hcd_data_lock */
538 if (hcd
->rh_timer
.data
|| urb
->transfer_buffer_length
< len
) {
539 dev_dbg (hcd
->self
.controller
,
540 "not queuing rh status urb, stat %d\n",
545 init_timer (&hcd
->rh_timer
);
546 hcd
->rh_timer
.function
= rh_report_status
;
547 hcd
->rh_timer
.data
= (unsigned long) urb
;
548 /* USB 2.0 spec says 256msec; this is close enough */
549 hcd
->rh_timer
.expires
= jiffies
+ HZ
/4;
550 add_timer (&hcd
->rh_timer
);
551 urb
->hcpriv
= hcd
; /* nonzero to indicate it's queued */
557 static void rh_report_status (unsigned long ptr
)
564 urb
= (struct urb
*) ptr
;
565 local_irq_save (flags
);
566 spin_lock (&urb
->lock
);
568 /* do nothing if the urb's been unlinked */
570 || urb
->status
!= -EINPROGRESS
571 || (hcd
= urb
->dev
->bus
->hcpriv
) == NULL
) {
572 spin_unlock (&urb
->lock
);
573 local_irq_restore (flags
);
577 /* complete the status urb, or retrigger the timer */
578 spin_lock (&hcd_data_lock
);
579 if (urb
->dev
->state
== USB_STATE_CONFIGURED
) {
580 length
= hcd
->driver
->hub_status_data (
581 hcd
, urb
->transfer_buffer
);
583 hcd
->rh_timer
.data
= 0;
584 urb
->actual_length
= length
;
588 mod_timer (&hcd
->rh_timer
, jiffies
+ HZ
/4);
590 spin_unlock (&hcd_data_lock
);
591 spin_unlock (&urb
->lock
);
593 /* local irqs are always blocked in completions */
595 usb_hcd_giveback_urb (hcd
, urb
, NULL
);
596 local_irq_restore (flags
);
599 /*-------------------------------------------------------------------------*/
601 static int rh_urb_enqueue (struct usb_hcd
*hcd
, struct urb
*urb
)
603 if (usb_pipeint (urb
->pipe
)) {
607 spin_lock_irqsave (&hcd_data_lock
, flags
);
608 retval
= rh_status_urb (hcd
, urb
);
609 spin_unlock_irqrestore (&hcd_data_lock
, flags
);
612 if (usb_pipecontrol (urb
->pipe
))
613 return rh_call_control (hcd
, urb
);
618 /*-------------------------------------------------------------------------*/
620 static int usb_rh_urb_dequeue (struct usb_hcd
*hcd
, struct urb
*urb
)
624 /* note: always a synchronous unlink */
625 if ((unsigned long) urb
== hcd
->rh_timer
.data
) {
626 del_timer_sync (&hcd
->rh_timer
);
627 hcd
->rh_timer
.data
= 0;
629 local_irq_save (flags
);
631 usb_hcd_giveback_urb (hcd
, urb
, NULL
);
632 local_irq_restore (flags
);
634 } else if (usb_pipeendpoint(urb
->pipe
) == 0) {
635 spin_lock_irq(&urb
->lock
); /* from usb_kill_urb */
637 spin_unlock_irq(&urb
->lock
);
639 wait_event(usb_kill_urb_queue
,
640 atomic_read(&urb
->use_count
) == 0);
642 spin_lock_irq(&urb
->lock
);
644 spin_unlock_irq(&urb
->lock
);
651 /*-------------------------------------------------------------------------*/
653 /* exported only within usbcore */
654 struct usb_bus
*usb_bus_get(struct usb_bus
*bus
)
657 kref_get(&bus
->kref
);
661 static void usb_host_release(struct kref
*kref
)
663 struct usb_bus
*bus
= container_of(kref
, struct usb_bus
, kref
);
669 /* exported only within usbcore */
670 void usb_bus_put(struct usb_bus
*bus
)
673 kref_put(&bus
->kref
, usb_host_release
);
676 /*-------------------------------------------------------------------------*/
678 static struct class *usb_host_class
;
680 int usb_host_init(void)
684 usb_host_class
= class_create(THIS_MODULE
, "usb_host");
685 if (IS_ERR(usb_host_class
))
686 retval
= PTR_ERR(usb_host_class
);
690 void usb_host_cleanup(void)
692 class_destroy(usb_host_class
);
696 * usb_bus_init - shared initialization code
697 * @bus: the bus structure being initialized
699 * This code is used to initialize a usb_bus structure, memory for which is
700 * separately managed.
702 static void usb_bus_init (struct usb_bus
*bus
)
704 memset (&bus
->devmap
, 0, sizeof(struct usb_devmap
));
706 bus
->devnum_next
= 1;
708 bus
->root_hub
= NULL
;
711 bus
->bandwidth_allocated
= 0;
712 bus
->bandwidth_int_reqs
= 0;
713 bus
->bandwidth_isoc_reqs
= 0;
715 INIT_LIST_HEAD (&bus
->bus_list
);
717 kref_init(&bus
->kref
);
721 * usb_alloc_bus - creates a new USB host controller structure
722 * @op: pointer to a struct usb_operations that this bus structure should use
723 * Context: !in_interrupt()
725 * Creates a USB host controller bus structure with the specified
726 * usb_operations and initializes all the necessary internal objects.
728 * If no memory is available, NULL is returned.
730 * The caller should call usb_put_bus() when it is finished with the structure.
732 struct usb_bus
*usb_alloc_bus (struct usb_operations
*op
)
736 bus
= kmalloc (sizeof *bus
, GFP_KERNEL
);
739 memset(bus
, 0, sizeof(struct usb_bus
));
745 /*-------------------------------------------------------------------------*/
748 * usb_register_bus - registers the USB host controller with the usb core
749 * @bus: pointer to the bus to register
750 * Context: !in_interrupt()
752 * Assigns a bus number, and links the controller into usbcore data
753 * structures so that it can be seen by scanning the bus list.
755 static int usb_register_bus(struct usb_bus
*bus
)
759 down (&usb_bus_list_lock
);
760 busnum
= find_next_zero_bit (busmap
.busmap
, USB_MAXBUS
, 1);
761 if (busnum
< USB_MAXBUS
) {
762 set_bit (busnum
, busmap
.busmap
);
763 bus
->busnum
= busnum
;
765 printk (KERN_ERR
"%s: too many buses\n", usbcore_name
);
766 up(&usb_bus_list_lock
);
770 bus
->class_dev
= class_device_create(usb_host_class
, MKDEV(0,0), bus
->controller
, "usb%d", busnum
);
771 if (IS_ERR(bus
->class_dev
)) {
772 clear_bit(busnum
, busmap
.busmap
);
773 up(&usb_bus_list_lock
);
774 return PTR_ERR(bus
->class_dev
);
777 class_set_devdata(bus
->class_dev
, bus
);
779 /* Add it to the local list of buses */
780 list_add (&bus
->bus_list
, &usb_bus_list
);
781 up (&usb_bus_list_lock
);
784 usbmon_notify_bus_add (bus
);
786 dev_info (bus
->controller
, "new USB bus registered, assigned bus number %d\n", bus
->busnum
);
791 * usb_deregister_bus - deregisters the USB host controller
792 * @bus: pointer to the bus to deregister
793 * Context: !in_interrupt()
795 * Recycles the bus number, and unlinks the controller from usbcore data
796 * structures so that it won't be seen by scanning the bus list.
798 static void usb_deregister_bus (struct usb_bus
*bus
)
800 dev_info (bus
->controller
, "USB bus %d deregistered\n", bus
->busnum
);
803 * NOTE: make sure that all the devices are removed by the
804 * controller code, as well as having it call this when cleaning
807 down (&usb_bus_list_lock
);
808 list_del (&bus
->bus_list
);
809 up (&usb_bus_list_lock
);
811 usbmon_notify_bus_remove (bus
);
812 usbfs_remove_bus (bus
);
814 clear_bit (bus
->busnum
, busmap
.busmap
);
816 class_device_unregister(bus
->class_dev
);
820 * usb_hcd_register_root_hub - called by HCD to register its root hub
821 * @usb_dev: the usb root hub device to be registered.
822 * @hcd: host controller for this root hub
824 * The USB host controller calls this function to register the root hub
825 * properly with the USB subsystem. It sets up the device properly in
826 * the device tree and stores the root_hub pointer in the bus structure,
827 * then calls usb_new_device() to register the usb device. It also
828 * assigns the root hub's USB address (always 1).
830 int usb_hcd_register_root_hub (struct usb_device
*usb_dev
, struct usb_hcd
*hcd
)
832 struct device
*parent_dev
= hcd
->self
.controller
;
833 const int devnum
= 1;
836 /* hcd->driver->start() reported can_wakeup, probably with
837 * assistance from board's boot firmware.
838 * NOTE: normal devices won't enable wakeup by default.
841 dev_dbg (parent_dev
, "supports USB remote wakeup\n");
842 hcd
->remote_wakeup
= hcd
->can_wakeup
;
844 usb_dev
->devnum
= devnum
;
845 usb_dev
->bus
->devnum_next
= devnum
+ 1;
846 memset (&usb_dev
->bus
->devmap
.devicemap
, 0,
847 sizeof usb_dev
->bus
->devmap
.devicemap
);
848 set_bit (devnum
, usb_dev
->bus
->devmap
.devicemap
);
849 usb_set_device_state(usb_dev
, USB_STATE_ADDRESS
);
851 down (&usb_bus_list_lock
);
852 usb_dev
->bus
->root_hub
= usb_dev
;
854 usb_dev
->ep0
.desc
.wMaxPacketSize
= __constant_cpu_to_le16(64);
855 retval
= usb_get_device_descriptor(usb_dev
, USB_DT_DEVICE_SIZE
);
856 if (retval
!= sizeof usb_dev
->descriptor
) {
857 usb_dev
->bus
->root_hub
= NULL
;
858 up (&usb_bus_list_lock
);
859 dev_dbg (parent_dev
, "can't read %s device descriptor %d\n",
860 usb_dev
->dev
.bus_id
, retval
);
861 return (retval
< 0) ? retval
: -EMSGSIZE
;
864 usb_lock_device (usb_dev
);
865 retval
= usb_new_device (usb_dev
);
866 usb_unlock_device (usb_dev
);
868 usb_dev
->bus
->root_hub
= NULL
;
869 dev_err (parent_dev
, "can't register root hub for %s, %d\n",
870 usb_dev
->dev
.bus_id
, retval
);
872 up (&usb_bus_list_lock
);
875 spin_lock_irq (&hcd_root_hub_lock
);
876 hcd
->rh_registered
= 1;
877 spin_unlock_irq (&hcd_root_hub_lock
);
879 /* Did the HC die before the root hub was registered? */
880 if (hcd
->state
== HC_STATE_HALT
)
881 usb_hc_died (hcd
); /* This time clean up */
886 EXPORT_SYMBOL_GPL(usb_hcd_register_root_hub
);
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_USECS (bytecount
);
928 tmp
= HS_USECS_ISO (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
, int 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
:
1129 usb_get_dev (urb
->dev
);
1130 list_add_tail (&urb
->urb_list
, &ep
->urb_list
);
1134 status
= -ESHUTDOWN
;
1137 spin_unlock_irqrestore (&hcd_data_lock
, flags
);
1139 INIT_LIST_HEAD (&urb
->urb_list
);
1140 usbmon_urb_submit_error(&hcd
->self
, urb
, status
);
1144 /* increment urb's reference count as part of giving it to the HCD
1145 * (which now controls it). HCD guarantees that it either returns
1146 * an error or calls giveback(), but not both.
1148 urb
= usb_get_urb (urb
);
1149 atomic_inc (&urb
->use_count
);
1151 if (urb
->dev
== hcd
->self
.root_hub
) {
1152 /* NOTE: requirement on hub callers (usbfs and the hub
1153 * driver, for now) that URBs' urb->transfer_buffer be
1154 * valid and usb_buffer_{sync,unmap}() not be needed, since
1155 * they could clobber root hub response data.
1157 status
= rh_urb_enqueue (hcd
, urb
);
1161 /* lower level hcd code should use *_dma exclusively,
1162 * unless it uses pio or talks to another transport.
1164 if (hcd
->self
.controller
->dma_mask
) {
1165 if (usb_pipecontrol (urb
->pipe
)
1166 && !(urb
->transfer_flags
& URB_NO_SETUP_DMA_MAP
))
1167 urb
->setup_dma
= dma_map_single (
1168 hcd
->self
.controller
,
1170 sizeof (struct usb_ctrlrequest
),
1172 if (urb
->transfer_buffer_length
!= 0
1173 && !(urb
->transfer_flags
& URB_NO_TRANSFER_DMA_MAP
))
1174 urb
->transfer_dma
= dma_map_single (
1175 hcd
->self
.controller
,
1176 urb
->transfer_buffer
,
1177 urb
->transfer_buffer_length
,
1178 usb_pipein (urb
->pipe
)
1183 status
= hcd
->driver
->urb_enqueue (hcd
, ep
, urb
, mem_flags
);
1185 if (unlikely (status
)) {
1187 atomic_dec (&urb
->use_count
);
1189 wake_up (&usb_kill_urb_queue
);
1191 usbmon_urb_submit_error(&hcd
->self
, urb
, status
);
1196 /*-------------------------------------------------------------------------*/
1198 /* called in any context */
1199 static int hcd_get_frame_number (struct usb_device
*udev
)
1201 struct usb_hcd
*hcd
= (struct usb_hcd
*)udev
->bus
->hcpriv
;
1202 if (!HC_IS_RUNNING (hcd
->state
))
1204 return hcd
->driver
->get_frame_number (hcd
);
1207 /*-------------------------------------------------------------------------*/
1209 /* this makes the hcd giveback() the urb more quickly, by kicking it
1210 * off hardware queues (which may take a while) and returning it as
1211 * soon as practical. we've already set up the urb's return status,
1212 * but we can't know if the callback completed already.
1215 unlink1 (struct usb_hcd
*hcd
, struct urb
*urb
)
1219 if (urb
->dev
== hcd
->self
.root_hub
)
1220 value
= usb_rh_urb_dequeue (hcd
, urb
);
1223 /* The only reason an HCD might fail this call is if
1224 * it has not yet fully queued the urb to begin with.
1225 * Such failures should be harmless. */
1226 value
= hcd
->driver
->urb_dequeue (hcd
, urb
);
1230 dev_dbg (hcd
->self
.controller
, "dequeue %p --> %d\n",
1236 * called in any context
1238 * caller guarantees urb won't be recycled till both unlink()
1239 * and the urb's completion function return
1241 static int hcd_unlink_urb (struct urb
*urb
, int status
)
1243 struct usb_host_endpoint
*ep
;
1244 struct usb_hcd
*hcd
= NULL
;
1245 struct device
*sys
= NULL
;
1246 unsigned long flags
;
1247 struct list_head
*tmp
;
1252 if (!urb
->dev
|| !urb
->dev
->bus
)
1254 ep
= (usb_pipein(urb
->pipe
) ? urb
->dev
->ep_in
: urb
->dev
->ep_out
)
1255 [usb_pipeendpoint(urb
->pipe
)];
1260 * we contend for urb->status with the hcd core,
1261 * which changes it while returning the urb.
1263 * Caller guaranteed that the urb pointer hasn't been freed, and
1264 * that it was submitted. But as a rule it can't know whether or
1265 * not it's already been unlinked ... so we respect the reversed
1266 * lock sequence needed for the usb_hcd_giveback_urb() code paths
1267 * (urb lock, then hcd_data_lock) in case some other CPU is now
1270 spin_lock_irqsave (&urb
->lock
, flags
);
1271 spin_lock (&hcd_data_lock
);
1273 sys
= &urb
->dev
->dev
;
1274 hcd
= urb
->dev
->bus
->hcpriv
;
1280 /* running ~= hc unlink handshake works (irq, timer, etc)
1281 * halted ~= no unlink handshake is needed
1282 * suspended, resuming == should never happen
1284 WARN_ON (!HC_IS_RUNNING (hcd
->state
) && hcd
->state
!= HC_STATE_HALT
);
1286 /* insist the urb is still queued */
1287 list_for_each(tmp
, &ep
->urb_list
) {
1288 if (tmp
== &urb
->urb_list
)
1291 if (tmp
!= &urb
->urb_list
) {
1296 /* Any status except -EINPROGRESS means something already started to
1297 * unlink this URB from the hardware. So there's no more work to do.
1299 if (urb
->status
!= -EINPROGRESS
) {
1304 /* IRQ setup can easily be broken so that USB controllers
1305 * never get completion IRQs ... maybe even the ones we need to
1306 * finish unlinking the initial failed usb_set_address()
1307 * or device descriptor fetch.
1309 if (!hcd
->saw_irq
&& hcd
->self
.root_hub
!= urb
->dev
) {
1310 dev_warn (hcd
->self
.controller
, "Unlink after no-IRQ? "
1311 "Controller is probably using the wrong IRQ."
1316 urb
->status
= status
;
1318 spin_unlock (&hcd_data_lock
);
1319 spin_unlock_irqrestore (&urb
->lock
, flags
);
1321 retval
= unlink1 (hcd
, urb
);
1323 retval
= -EINPROGRESS
;
1327 spin_unlock (&hcd_data_lock
);
1328 spin_unlock_irqrestore (&urb
->lock
, flags
);
1329 if (retval
!= -EIDRM
&& sys
&& sys
->driver
)
1330 dev_dbg (sys
, "hcd_unlink_urb %p fail %d\n", urb
, retval
);
1334 /*-------------------------------------------------------------------------*/
1336 /* disables the endpoint: cancels any pending urbs, then synchronizes with
1337 * the hcd to make sure all endpoint state is gone from hardware. use for
1338 * set_configuration, set_interface, driver removal, physical disconnect.
1340 * example: a qh stored in ep->hcpriv, holding state related to endpoint
1341 * type, maxpacket size, toggle, halt status, and scheduling.
1344 hcd_endpoint_disable (struct usb_device
*udev
, struct usb_host_endpoint
*ep
)
1346 struct usb_hcd
*hcd
;
1349 hcd
= udev
->bus
->hcpriv
;
1351 WARN_ON (!HC_IS_RUNNING (hcd
->state
) && hcd
->state
!= HC_STATE_HALT
);
1353 local_irq_disable ();
1355 /* FIXME move most of this into message.c as part of its
1356 * endpoint disable logic
1359 /* ep is already gone from udev->ep_{in,out}[]; no more submits */
1361 spin_lock (&hcd_data_lock
);
1362 list_for_each_entry (urb
, &ep
->urb_list
, urb_list
) {
1365 /* another cpu may be in hcd, spinning on hcd_data_lock
1366 * to giveback() this urb. the races here should be
1367 * small, but a full fix needs a new "can't submit"
1369 * FIXME urb->reject should allow that...
1371 if (urb
->status
!= -EINPROGRESS
)
1374 spin_unlock (&hcd_data_lock
);
1376 spin_lock (&urb
->lock
);
1378 if (tmp
== -EINPROGRESS
)
1379 urb
->status
= -ESHUTDOWN
;
1380 spin_unlock (&urb
->lock
);
1382 /* kick hcd unless it's already returning this */
1383 if (tmp
== -EINPROGRESS
) {
1386 dev_dbg (hcd
->self
.controller
,
1387 "shutdown urb %p pipe %08x ep%d%s%s\n",
1388 urb
, tmp
, usb_pipeendpoint (tmp
),
1389 (tmp
& USB_DIR_IN
) ? "in" : "out",
1391 switch (usb_pipetype (tmp
)) { \
1392 case PIPE_CONTROL
: s
= ""; break; \
1393 case PIPE_BULK
: s
= "-bulk"; break; \
1394 case PIPE_INTERRUPT
: s
= "-intr"; break; \
1395 default: s
= "-iso"; break; \
1400 /* list contents may have changed */
1403 spin_unlock (&hcd_data_lock
);
1404 local_irq_enable ();
1406 /* synchronize with the hardware, so old configuration state
1407 * clears out immediately (and will be freed).
1410 if (hcd
->driver
->endpoint_disable
)
1411 hcd
->driver
->endpoint_disable (hcd
, ep
);
1414 /*-------------------------------------------------------------------------*/
1416 #ifdef CONFIG_USB_SUSPEND
1418 static int hcd_hub_suspend (struct usb_bus
*bus
)
1420 struct usb_hcd
*hcd
;
1422 hcd
= container_of (bus
, struct usb_hcd
, self
);
1423 if (hcd
->driver
->hub_suspend
)
1424 return hcd
->driver
->hub_suspend (hcd
);
1428 static int hcd_hub_resume (struct usb_bus
*bus
)
1430 struct usb_hcd
*hcd
;
1432 hcd
= container_of (bus
, struct usb_hcd
, self
);
1433 if (hcd
->driver
->hub_resume
)
1434 return hcd
->driver
->hub_resume (hcd
);
1439 * usb_hcd_resume_root_hub - called by HCD to resume its root hub
1440 * @hcd: host controller for this root hub
1442 * The USB host controller calls this function when its root hub is
1443 * suspended (with the remote wakeup feature enabled) and a remote
1444 * wakeup request is received. It queues a request for khubd to
1445 * resume the root hub.
1447 void usb_hcd_resume_root_hub (struct usb_hcd
*hcd
)
1449 unsigned long flags
;
1451 spin_lock_irqsave (&hcd_root_hub_lock
, flags
);
1452 if (hcd
->rh_registered
)
1453 usb_resume_root_hub (hcd
->self
.root_hub
);
1454 spin_unlock_irqrestore (&hcd_root_hub_lock
, flags
);
1458 void usb_hcd_resume_root_hub (struct usb_hcd
*hcd
)
1462 EXPORT_SYMBOL_GPL(usb_hcd_resume_root_hub
);
1464 /*-------------------------------------------------------------------------*/
1466 #ifdef CONFIG_USB_OTG
1469 * usb_bus_start_enum - start immediate enumeration (for OTG)
1470 * @bus: the bus (must use hcd framework)
1471 * @port_num: 1-based number of port; usually bus->otg_port
1472 * Context: in_interrupt()
1474 * Starts enumeration, with an immediate reset followed later by
1475 * khubd identifying and possibly configuring the device.
1476 * This is needed by OTG controller drivers, where it helps meet
1477 * HNP protocol timing requirements for starting a port reset.
1479 int usb_bus_start_enum(struct usb_bus
*bus
, unsigned port_num
)
1481 struct usb_hcd
*hcd
;
1482 int status
= -EOPNOTSUPP
;
1484 /* NOTE: since HNP can't start by grabbing the bus's address0_sem,
1485 * boards with root hubs hooked up to internal devices (instead of
1486 * just the OTG port) may need more attention to resetting...
1488 hcd
= container_of (bus
, struct usb_hcd
, self
);
1489 if (port_num
&& hcd
->driver
->start_port_reset
)
1490 status
= hcd
->driver
->start_port_reset(hcd
, port_num
);
1492 /* run khubd shortly after (first) root port reset finishes;
1493 * it may issue others, until at least 50 msecs have passed.
1496 mod_timer(&hcd
->rh_timer
, jiffies
+ msecs_to_jiffies(10));
1499 EXPORT_SYMBOL (usb_bus_start_enum
);
1503 /*-------------------------------------------------------------------------*/
1506 * usb_hcd_operations - adapts usb_bus framework to HCD framework (bus glue)
1508 static struct usb_operations usb_hcd_operations
= {
1509 .get_frame_number
= hcd_get_frame_number
,
1510 .submit_urb
= hcd_submit_urb
,
1511 .unlink_urb
= hcd_unlink_urb
,
1512 .buffer_alloc
= hcd_buffer_alloc
,
1513 .buffer_free
= hcd_buffer_free
,
1514 .disable
= hcd_endpoint_disable
,
1515 #ifdef CONFIG_USB_SUSPEND
1516 .hub_suspend
= hcd_hub_suspend
,
1517 .hub_resume
= hcd_hub_resume
,
1521 /*-------------------------------------------------------------------------*/
1524 * usb_hcd_giveback_urb - return URB from HCD to device driver
1525 * @hcd: host controller returning the URB
1526 * @urb: urb being returned to the USB device driver.
1527 * @regs: pt_regs, passed down to the URB completion handler
1528 * Context: in_interrupt()
1530 * This hands the URB from HCD to its USB device driver, using its
1531 * completion function. The HCD has freed all per-urb resources
1532 * (and is done using urb->hcpriv). It also released all HCD locks;
1533 * the device driver won't cause problems if it frees, modifies,
1534 * or resubmits this URB.
1536 void usb_hcd_giveback_urb (struct usb_hcd
*hcd
, struct urb
*urb
, struct pt_regs
*regs
)
1540 at_root_hub
= (urb
->dev
== hcd
->self
.root_hub
);
1543 /* lower level hcd code should use *_dma exclusively */
1544 if (hcd
->self
.controller
->dma_mask
&& !at_root_hub
) {
1545 if (usb_pipecontrol (urb
->pipe
)
1546 && !(urb
->transfer_flags
& URB_NO_SETUP_DMA_MAP
))
1547 dma_unmap_single (hcd
->self
.controller
, urb
->setup_dma
,
1548 sizeof (struct usb_ctrlrequest
),
1550 if (urb
->transfer_buffer_length
!= 0
1551 && !(urb
->transfer_flags
& URB_NO_TRANSFER_DMA_MAP
))
1552 dma_unmap_single (hcd
->self
.controller
,
1554 urb
->transfer_buffer_length
,
1555 usb_pipein (urb
->pipe
)
1560 usbmon_urb_complete (&hcd
->self
, urb
);
1561 /* pass ownership to the completion handler */
1562 urb
->complete (urb
, regs
);
1563 atomic_dec (&urb
->use_count
);
1564 if (unlikely (urb
->reject
))
1565 wake_up (&usb_kill_urb_queue
);
1568 EXPORT_SYMBOL (usb_hcd_giveback_urb
);
1570 /*-------------------------------------------------------------------------*/
1573 * usb_hcd_irq - hook IRQs to HCD framework (bus glue)
1574 * @irq: the IRQ being raised
1575 * @__hcd: pointer to the HCD whose IRQ is being signaled
1576 * @r: saved hardware registers
1578 * If the controller isn't HALTed, calls the driver's irq handler.
1579 * Checks whether the controller is now dead.
1581 irqreturn_t
usb_hcd_irq (int irq
, void *__hcd
, struct pt_regs
* r
)
1583 struct usb_hcd
*hcd
= __hcd
;
1584 int start
= hcd
->state
;
1586 if (start
== HC_STATE_HALT
)
1588 if (hcd
->driver
->irq (hcd
, r
) == IRQ_NONE
)
1592 if (hcd
->state
!= start
&& hcd
->state
== HC_STATE_HALT
)
1597 /*-------------------------------------------------------------------------*/
1600 * usb_hc_died - report abnormal shutdown of a host controller (bus glue)
1601 * @hcd: pointer to the HCD representing the controller
1603 * This is called by bus glue to report a USB host controller that died
1604 * while operations may still have been pending. It's called automatically
1605 * by the PCI glue, so only glue for non-PCI busses should need to call it.
1607 void usb_hc_died (struct usb_hcd
*hcd
)
1609 unsigned long flags
;
1611 dev_err (hcd
->self
.controller
, "HC died; cleaning up\n");
1613 spin_lock_irqsave (&hcd_root_hub_lock
, flags
);
1614 if (hcd
->rh_registered
) {
1616 /* make khubd clean up old urbs and devices */
1617 usb_set_device_state (hcd
->self
.root_hub
,
1618 USB_STATE_NOTATTACHED
);
1619 usb_kick_khubd (hcd
->self
.root_hub
);
1621 spin_unlock_irqrestore (&hcd_root_hub_lock
, flags
);
1623 EXPORT_SYMBOL_GPL (usb_hc_died
);
1625 /*-------------------------------------------------------------------------*/
1627 static void hcd_release (struct usb_bus
*bus
)
1629 struct usb_hcd
*hcd
;
1631 hcd
= container_of(bus
, struct usb_hcd
, self
);
1636 * usb_create_hcd - create and initialize an HCD structure
1637 * @driver: HC driver that will use this hcd
1638 * @dev: device for this HC, stored in hcd->self.controller
1639 * @bus_name: value to store in hcd->self.bus_name
1640 * Context: !in_interrupt()
1642 * Allocate a struct usb_hcd, with extra space at the end for the
1643 * HC driver's private data. Initialize the generic members of the
1646 * If memory is unavailable, returns NULL.
1648 struct usb_hcd
*usb_create_hcd (const struct hc_driver
*driver
,
1649 struct device
*dev
, char *bus_name
)
1651 struct usb_hcd
*hcd
;
1653 hcd
= kcalloc(1, sizeof(*hcd
) + driver
->hcd_priv_size
, GFP_KERNEL
);
1655 dev_dbg (dev
, "hcd alloc failed\n");
1658 dev_set_drvdata(dev
, hcd
);
1660 usb_bus_init(&hcd
->self
);
1661 hcd
->self
.op
= &usb_hcd_operations
;
1662 hcd
->self
.hcpriv
= hcd
;
1663 hcd
->self
.release
= &hcd_release
;
1664 hcd
->self
.controller
= dev
;
1665 hcd
->self
.bus_name
= bus_name
;
1667 init_timer(&hcd
->rh_timer
);
1669 hcd
->driver
= driver
;
1670 hcd
->product_desc
= (driver
->product_desc
) ? driver
->product_desc
:
1671 "USB Host Controller";
1675 EXPORT_SYMBOL (usb_create_hcd
);
1677 void usb_put_hcd (struct usb_hcd
*hcd
)
1679 dev_set_drvdata(hcd
->self
.controller
, NULL
);
1680 usb_bus_put(&hcd
->self
);
1682 EXPORT_SYMBOL (usb_put_hcd
);
1685 * usb_add_hcd - finish generic HCD structure initialization and register
1686 * @hcd: the usb_hcd structure to initialize
1687 * @irqnum: Interrupt line to allocate
1688 * @irqflags: Interrupt type flags
1690 * Finish the remaining parts of generic HCD initialization: allocate the
1691 * buffers of consistent memory, register the bus, request the IRQ line,
1692 * and call the driver's reset() and start() routines.
1694 int usb_add_hcd(struct usb_hcd
*hcd
,
1695 unsigned int irqnum
, unsigned long irqflags
)
1699 dev_info(hcd
->self
.controller
, "%s\n", hcd
->product_desc
);
1701 /* till now HC has been in an indeterminate state ... */
1702 if (hcd
->driver
->reset
&& (retval
= hcd
->driver
->reset(hcd
)) < 0) {
1703 dev_err(hcd
->self
.controller
, "can't reset\n");
1707 if ((retval
= hcd_buffer_create(hcd
)) != 0) {
1708 dev_dbg(hcd
->self
.controller
, "pool alloc failed\n");
1712 if ((retval
= usb_register_bus(&hcd
->self
)) < 0)
1715 if (hcd
->driver
->irq
) {
1716 char buf
[8], *bufp
= buf
;
1719 bufp
= __irq_itoa(irqnum
);
1721 sprintf(buf
, "%d", irqnum
);
1724 snprintf(hcd
->irq_descr
, sizeof(hcd
->irq_descr
), "%s:usb%d",
1725 hcd
->driver
->description
, hcd
->self
.busnum
);
1726 if ((retval
= request_irq(irqnum
, &usb_hcd_irq
, irqflags
,
1727 hcd
->irq_descr
, hcd
)) != 0) {
1728 dev_err(hcd
->self
.controller
,
1729 "request interrupt %s failed\n", bufp
);
1733 dev_info(hcd
->self
.controller
, "irq %s, %s 0x%08llx\n", bufp
,
1734 (hcd
->driver
->flags
& HCD_MEMORY
) ?
1735 "io mem" : "io base",
1736 (unsigned long long)hcd
->rsrc_start
);
1739 if (hcd
->rsrc_start
)
1740 dev_info(hcd
->self
.controller
, "%s 0x%08llx\n",
1741 (hcd
->driver
->flags
& HCD_MEMORY
) ?
1742 "io mem" : "io base",
1743 (unsigned long long)hcd
->rsrc_start
);
1746 if ((retval
= hcd
->driver
->start(hcd
)) < 0) {
1747 dev_err(hcd
->self
.controller
, "startup error %d\n", retval
);
1755 free_irq(irqnum
, hcd
);
1757 usb_deregister_bus(&hcd
->self
);
1759 hcd_buffer_destroy(hcd
);
1762 EXPORT_SYMBOL (usb_add_hcd
);
1765 * usb_remove_hcd - shutdown processing for generic HCDs
1766 * @hcd: the usb_hcd structure to remove
1767 * Context: !in_interrupt()
1769 * Disconnects the root hub, then reverses the effects of usb_add_hcd(),
1770 * invoking the HCD's stop() method.
1772 void usb_remove_hcd(struct usb_hcd
*hcd
)
1774 dev_info(hcd
->self
.controller
, "remove, state %x\n", hcd
->state
);
1776 if (HC_IS_RUNNING (hcd
->state
))
1777 hcd
->state
= HC_STATE_QUIESCING
;
1779 dev_dbg(hcd
->self
.controller
, "roothub graceful disconnect\n");
1780 spin_lock_irq (&hcd_root_hub_lock
);
1781 hcd
->rh_registered
= 0;
1782 spin_unlock_irq (&hcd_root_hub_lock
);
1783 usb_disconnect(&hcd
->self
.root_hub
);
1785 hcd
->driver
->stop(hcd
);
1786 hcd
->state
= HC_STATE_HALT
;
1789 free_irq(hcd
->irq
, hcd
);
1790 usb_deregister_bus(&hcd
->self
);
1791 hcd_buffer_destroy(hcd
);
1793 EXPORT_SYMBOL (usb_remove_hcd
);
1795 /*-------------------------------------------------------------------------*/
1797 #if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
1799 struct usb_mon_operations
*mon_ops
;
1802 * The registration is unlocked.
1803 * We do it this way because we do not want to lock in hot paths.
1805 * Notice that the code is minimally error-proof. Because usbmon needs
1806 * symbols from usbcore, usbcore gets referenced and cannot be unloaded first.
1809 int usb_mon_register (struct usb_mon_operations
*ops
)
1819 EXPORT_SYMBOL_GPL (usb_mon_register
);
1821 void usb_mon_deregister (void)
1824 if (mon_ops
== NULL
) {
1825 printk(KERN_ERR
"USB: monitor was not registered\n");
1831 EXPORT_SYMBOL_GPL (usb_mon_deregister
);
1833 #endif /* CONFIG_USB_MON */