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 polled using a timer if the
523 * driver requests it; otherwise the driver is responsible for
524 * calling usb_hcd_poll_rh_status() when an event occurs.
526 * Completions are called in_interrupt(), but they may or may not
529 void usb_hcd_poll_rh_status(struct usb_hcd
*hcd
)
534 char buffer
[4]; /* Any root hubs with > 31 ports? */
536 if (!hcd
->uses_new_polling
&& !hcd
->status_urb
)
539 length
= hcd
->driver
->hub_status_data(hcd
, buffer
);
542 /* try to complete the status urb */
543 local_irq_save (flags
);
544 spin_lock(&hcd_root_hub_lock
);
545 urb
= hcd
->status_urb
;
547 spin_lock(&urb
->lock
);
548 if (urb
->status
== -EINPROGRESS
) {
549 hcd
->poll_pending
= 0;
550 hcd
->status_urb
= NULL
;
553 urb
->actual_length
= length
;
554 memcpy(urb
->transfer_buffer
, buffer
, length
);
555 } else /* urb has been unlinked */
557 spin_unlock(&urb
->lock
);
560 spin_unlock(&hcd_root_hub_lock
);
562 /* local irqs are always blocked in completions */
564 usb_hcd_giveback_urb (hcd
, urb
, NULL
);
566 hcd
->poll_pending
= 1;
567 local_irq_restore (flags
);
570 /* The USB 2.0 spec says 256 ms. This is close enough and won't
571 * exceed that limit if HZ is 100. */
572 if (hcd
->uses_new_polling
? hcd
->poll_rh
:
573 (length
== 0 && hcd
->status_urb
!= NULL
))
574 mod_timer (&hcd
->rh_timer
, jiffies
+ msecs_to_jiffies(250));
576 EXPORT_SYMBOL_GPL(usb_hcd_poll_rh_status
);
579 static void rh_timer_func (unsigned long _hcd
)
581 usb_hcd_poll_rh_status((struct usb_hcd
*) _hcd
);
584 /*-------------------------------------------------------------------------*/
586 static int rh_queue_status (struct usb_hcd
*hcd
, struct urb
*urb
)
590 int len
= 1 + (urb
->dev
->maxchild
/ 8);
592 spin_lock_irqsave (&hcd_root_hub_lock
, flags
);
593 if (urb
->status
!= -EINPROGRESS
) /* already unlinked */
594 retval
= urb
->status
;
595 else if (hcd
->status_urb
|| urb
->transfer_buffer_length
< len
) {
596 dev_dbg (hcd
->self
.controller
, "not queuing rh status urb\n");
599 hcd
->status_urb
= urb
;
600 urb
->hcpriv
= hcd
; /* indicate it's queued */
602 if (!hcd
->uses_new_polling
)
603 mod_timer (&hcd
->rh_timer
, jiffies
+
604 msecs_to_jiffies(250));
606 /* If a status change has already occurred, report it ASAP */
607 else if (hcd
->poll_pending
)
608 mod_timer (&hcd
->rh_timer
, jiffies
);
611 spin_unlock_irqrestore (&hcd_root_hub_lock
, flags
);
615 static int rh_urb_enqueue (struct usb_hcd
*hcd
, struct urb
*urb
)
617 if (usb_pipeint (urb
->pipe
))
618 return rh_queue_status (hcd
, urb
);
619 if (usb_pipecontrol (urb
->pipe
))
620 return rh_call_control (hcd
, urb
);
624 /*-------------------------------------------------------------------------*/
626 /* Asynchronous unlinks of root-hub control URBs are legal, but they
627 * don't do anything. Status URB unlinks must be made in process context
628 * with interrupts enabled.
630 static int usb_rh_urb_dequeue (struct usb_hcd
*hcd
, struct urb
*urb
)
632 if (usb_pipeendpoint(urb
->pipe
) == 0) { /* Control URB */
634 return 0; /* nothing to do */
636 spin_lock_irq(&urb
->lock
); /* from usb_kill_urb */
638 spin_unlock_irq(&urb
->lock
);
640 wait_event(usb_kill_urb_queue
,
641 atomic_read(&urb
->use_count
) == 0);
643 spin_lock_irq(&urb
->lock
);
645 spin_unlock_irq(&urb
->lock
);
647 } else { /* Status URB */
648 if (!hcd
->uses_new_polling
)
649 del_timer_sync (&hcd
->rh_timer
);
650 local_irq_disable ();
651 spin_lock (&hcd_root_hub_lock
);
652 if (urb
== hcd
->status_urb
) {
653 hcd
->status_urb
= NULL
;
656 urb
= NULL
; /* wasn't fully queued */
657 spin_unlock (&hcd_root_hub_lock
);
659 usb_hcd_giveback_urb (hcd
, urb
, NULL
);
666 /*-------------------------------------------------------------------------*/
668 /* exported only within usbcore */
669 struct usb_bus
*usb_bus_get(struct usb_bus
*bus
)
672 kref_get(&bus
->kref
);
676 static void usb_host_release(struct kref
*kref
)
678 struct usb_bus
*bus
= container_of(kref
, struct usb_bus
, kref
);
684 /* exported only within usbcore */
685 void usb_bus_put(struct usb_bus
*bus
)
688 kref_put(&bus
->kref
, usb_host_release
);
691 /*-------------------------------------------------------------------------*/
693 static struct class *usb_host_class
;
695 int usb_host_init(void)
699 usb_host_class
= class_create(THIS_MODULE
, "usb_host");
700 if (IS_ERR(usb_host_class
))
701 retval
= PTR_ERR(usb_host_class
);
705 void usb_host_cleanup(void)
707 class_destroy(usb_host_class
);
711 * usb_bus_init - shared initialization code
712 * @bus: the bus structure being initialized
714 * This code is used to initialize a usb_bus structure, memory for which is
715 * separately managed.
717 static void usb_bus_init (struct usb_bus
*bus
)
719 memset (&bus
->devmap
, 0, sizeof(struct usb_devmap
));
721 bus
->devnum_next
= 1;
723 bus
->root_hub
= NULL
;
726 bus
->bandwidth_allocated
= 0;
727 bus
->bandwidth_int_reqs
= 0;
728 bus
->bandwidth_isoc_reqs
= 0;
730 INIT_LIST_HEAD (&bus
->bus_list
);
732 kref_init(&bus
->kref
);
736 * usb_alloc_bus - creates a new USB host controller structure
737 * @op: pointer to a struct usb_operations that this bus structure should use
738 * Context: !in_interrupt()
740 * Creates a USB host controller bus structure with the specified
741 * usb_operations and initializes all the necessary internal objects.
743 * If no memory is available, NULL is returned.
745 * The caller should call usb_put_bus() when it is finished with the structure.
747 struct usb_bus
*usb_alloc_bus (struct usb_operations
*op
)
751 bus
= kmalloc (sizeof *bus
, GFP_KERNEL
);
754 memset(bus
, 0, sizeof(struct usb_bus
));
760 /*-------------------------------------------------------------------------*/
763 * usb_register_bus - registers the USB host controller with the usb core
764 * @bus: pointer to the bus to register
765 * Context: !in_interrupt()
767 * Assigns a bus number, and links the controller into usbcore data
768 * structures so that it can be seen by scanning the bus list.
770 static int usb_register_bus(struct usb_bus
*bus
)
774 down (&usb_bus_list_lock
);
775 busnum
= find_next_zero_bit (busmap
.busmap
, USB_MAXBUS
, 1);
776 if (busnum
< USB_MAXBUS
) {
777 set_bit (busnum
, busmap
.busmap
);
778 bus
->busnum
= busnum
;
780 printk (KERN_ERR
"%s: too many buses\n", usbcore_name
);
781 up(&usb_bus_list_lock
);
785 bus
->class_dev
= class_device_create(usb_host_class
, NULL
, MKDEV(0,0),
786 bus
->controller
, "usb_host%d", busnum
);
787 if (IS_ERR(bus
->class_dev
)) {
788 clear_bit(busnum
, busmap
.busmap
);
789 up(&usb_bus_list_lock
);
790 return PTR_ERR(bus
->class_dev
);
793 class_set_devdata(bus
->class_dev
, bus
);
795 /* Add it to the local list of buses */
796 list_add (&bus
->bus_list
, &usb_bus_list
);
797 up (&usb_bus_list_lock
);
800 usbmon_notify_bus_add (bus
);
802 dev_info (bus
->controller
, "new USB bus registered, assigned bus number %d\n", bus
->busnum
);
807 * usb_deregister_bus - deregisters the USB host controller
808 * @bus: pointer to the bus to deregister
809 * Context: !in_interrupt()
811 * Recycles the bus number, and unlinks the controller from usbcore data
812 * structures so that it won't be seen by scanning the bus list.
814 static void usb_deregister_bus (struct usb_bus
*bus
)
816 dev_info (bus
->controller
, "USB bus %d deregistered\n", bus
->busnum
);
819 * NOTE: make sure that all the devices are removed by the
820 * controller code, as well as having it call this when cleaning
823 down (&usb_bus_list_lock
);
824 list_del (&bus
->bus_list
);
825 up (&usb_bus_list_lock
);
827 usbmon_notify_bus_remove (bus
);
828 usbfs_remove_bus (bus
);
830 clear_bit (bus
->busnum
, busmap
.busmap
);
832 class_device_unregister(bus
->class_dev
);
836 * register_root_hub - called by usb_add_hcd() to register a root hub
837 * @usb_dev: the usb root hub device to be registered.
838 * @hcd: host controller for this root hub
840 * This function registers the root hub with the USB subsystem. It sets up
841 * the device properly in the device tree and stores the root_hub pointer
842 * in the bus structure, then calls usb_new_device() to register the usb
843 * device. It also assigns the root hub's USB address (always 1).
845 static int register_root_hub (struct usb_device
*usb_dev
,
848 struct device
*parent_dev
= hcd
->self
.controller
;
849 const int devnum
= 1;
852 usb_dev
->devnum
= devnum
;
853 usb_dev
->bus
->devnum_next
= devnum
+ 1;
854 memset (&usb_dev
->bus
->devmap
.devicemap
, 0,
855 sizeof usb_dev
->bus
->devmap
.devicemap
);
856 set_bit (devnum
, usb_dev
->bus
->devmap
.devicemap
);
857 usb_set_device_state(usb_dev
, USB_STATE_ADDRESS
);
859 down (&usb_bus_list_lock
);
860 usb_dev
->bus
->root_hub
= usb_dev
;
862 usb_dev
->ep0
.desc
.wMaxPacketSize
= __constant_cpu_to_le16(64);
863 retval
= usb_get_device_descriptor(usb_dev
, USB_DT_DEVICE_SIZE
);
864 if (retval
!= sizeof usb_dev
->descriptor
) {
865 usb_dev
->bus
->root_hub
= NULL
;
866 up (&usb_bus_list_lock
);
867 dev_dbg (parent_dev
, "can't read %s device descriptor %d\n",
868 usb_dev
->dev
.bus_id
, retval
);
869 return (retval
< 0) ? retval
: -EMSGSIZE
;
872 usb_lock_device (usb_dev
);
873 retval
= usb_new_device (usb_dev
);
874 usb_unlock_device (usb_dev
);
876 usb_dev
->bus
->root_hub
= NULL
;
877 dev_err (parent_dev
, "can't register root hub for %s, %d\n",
878 usb_dev
->dev
.bus_id
, retval
);
880 up (&usb_bus_list_lock
);
883 spin_lock_irq (&hcd_root_hub_lock
);
884 hcd
->rh_registered
= 1;
885 spin_unlock_irq (&hcd_root_hub_lock
);
887 /* Did the HC die before the root hub was registered? */
888 if (hcd
->state
== HC_STATE_HALT
)
889 usb_hc_died (hcd
); /* This time clean up */
895 void usb_enable_root_hub_irq (struct usb_bus
*bus
)
899 hcd
= container_of (bus
, struct usb_hcd
, self
);
900 if (hcd
->driver
->hub_irq_enable
&& !hcd
->poll_rh
&&
901 hcd
->state
!= HC_STATE_HALT
)
902 hcd
->driver
->hub_irq_enable (hcd
);
906 /*-------------------------------------------------------------------------*/
909 * usb_calc_bus_time - approximate periodic transaction time in nanoseconds
910 * @speed: from dev->speed; USB_SPEED_{LOW,FULL,HIGH}
911 * @is_input: true iff the transaction sends data to the host
912 * @isoc: true for isochronous transactions, false for interrupt ones
913 * @bytecount: how many bytes in the transaction.
915 * Returns approximate bus time in nanoseconds for a periodic transaction.
916 * See USB 2.0 spec section 5.11.3; only periodic transfers need to be
917 * scheduled in software, this function is only used for such scheduling.
919 long usb_calc_bus_time (int speed
, int is_input
, int isoc
, int bytecount
)
924 case USB_SPEED_LOW
: /* INTR only */
926 tmp
= (67667L * (31L + 10L * BitTime (bytecount
))) / 1000L;
927 return (64060L + (2 * BW_HUB_LS_SETUP
) + BW_HOST_DELAY
+ tmp
);
929 tmp
= (66700L * (31L + 10L * BitTime (bytecount
))) / 1000L;
930 return (64107L + (2 * BW_HUB_LS_SETUP
) + BW_HOST_DELAY
+ tmp
);
932 case USB_SPEED_FULL
: /* ISOC or INTR */
934 tmp
= (8354L * (31L + 10L * BitTime (bytecount
))) / 1000L;
935 return (((is_input
) ? 7268L : 6265L) + BW_HOST_DELAY
+ tmp
);
937 tmp
= (8354L * (31L + 10L * BitTime (bytecount
))) / 1000L;
938 return (9107L + BW_HOST_DELAY
+ tmp
);
940 case USB_SPEED_HIGH
: /* ISOC or INTR */
941 // FIXME adjust for input vs output
943 tmp
= HS_NSECS_ISO (bytecount
);
945 tmp
= HS_NSECS (bytecount
);
948 pr_debug ("%s: bogus device speed!\n", usbcore_name
);
952 EXPORT_SYMBOL (usb_calc_bus_time
);
955 * usb_check_bandwidth():
957 * old_alloc is from host_controller->bandwidth_allocated in microseconds;
958 * bustime is from calc_bus_time(), but converted to microseconds.
960 * returns <bustime in us> if successful,
961 * or -ENOSPC if bandwidth request fails.
964 * This initial implementation does not use Endpoint.bInterval
965 * in managing bandwidth allocation.
966 * It probably needs to be expanded to use Endpoint.bInterval.
967 * This can be done as a later enhancement (correction).
969 * This will also probably require some kind of
970 * frame allocation tracking...meaning, for example,
971 * that if multiple drivers request interrupts every 10 USB frames,
972 * they don't all have to be allocated at
973 * frame numbers N, N+10, N+20, etc. Some of them could be at
974 * N+11, N+21, N+31, etc., and others at
975 * N+12, N+22, N+32, etc.
977 * Similarly for isochronous transfers...
979 * Individual HCDs can schedule more directly ... this logic
980 * is not correct for high speed transfers.
982 int usb_check_bandwidth (struct usb_device
*dev
, struct urb
*urb
)
984 unsigned int pipe
= urb
->pipe
;
986 int is_in
= usb_pipein (pipe
);
987 int is_iso
= usb_pipeisoc (pipe
);
988 int old_alloc
= dev
->bus
->bandwidth_allocated
;
992 bustime
= NS_TO_US (usb_calc_bus_time (dev
->speed
, is_in
, is_iso
,
993 usb_maxpacket (dev
, pipe
, !is_in
)));
995 bustime
/= urb
->number_of_packets
;
997 new_alloc
= old_alloc
+ (int) bustime
;
998 if (new_alloc
> FRAME_TIME_MAX_USECS_ALLOC
) {
1001 #ifdef CONFIG_USB_BANDWIDTH
1006 dev_dbg (&dev
->dev
, "usb_check_bandwidth %sFAILED: %d + %ld = %d usec\n",
1007 mode
, old_alloc
, bustime
, new_alloc
);
1009 #ifdef CONFIG_USB_BANDWIDTH
1010 bustime
= -ENOSPC
; /* report error */
1016 EXPORT_SYMBOL (usb_check_bandwidth
);
1020 * usb_claim_bandwidth - records bandwidth for a periodic transfer
1021 * @dev: source/target of request
1022 * @urb: request (urb->dev == dev)
1023 * @bustime: bandwidth consumed, in (average) microseconds per frame
1024 * @isoc: true iff the request is isochronous
1026 * Bus bandwidth reservations are recorded purely for diagnostic purposes.
1027 * HCDs are expected not to overcommit periodic bandwidth, and to record such
1028 * reservations whenever endpoints are added to the periodic schedule.
1030 * FIXME averaging per-frame is suboptimal. Better to sum over the HCD's
1031 * entire periodic schedule ... 32 frames for OHCI, 1024 for UHCI, settable
1032 * for EHCI (256/512/1024 frames, default 1024) and have the bus expose how
1033 * large its periodic schedule is.
1035 void usb_claim_bandwidth (struct usb_device
*dev
, struct urb
*urb
, int bustime
, int isoc
)
1037 dev
->bus
->bandwidth_allocated
+= bustime
;
1039 dev
->bus
->bandwidth_isoc_reqs
++;
1041 dev
->bus
->bandwidth_int_reqs
++;
1042 urb
->bandwidth
= bustime
;
1044 #ifdef USB_BANDWIDTH_MESSAGES
1045 dev_dbg (&dev
->dev
, "bandwidth alloc increased by %d (%s) to %d for %d requesters\n",
1047 isoc
? "ISOC" : "INTR",
1048 dev
->bus
->bandwidth_allocated
,
1049 dev
->bus
->bandwidth_int_reqs
+ dev
->bus
->bandwidth_isoc_reqs
);
1052 EXPORT_SYMBOL (usb_claim_bandwidth
);
1056 * usb_release_bandwidth - reverses effect of usb_claim_bandwidth()
1057 * @dev: source/target of request
1058 * @urb: request (urb->dev == dev)
1059 * @isoc: true iff the request is isochronous
1061 * This records that previously allocated bandwidth has been released.
1062 * Bandwidth is released when endpoints are removed from the host controller's
1063 * periodic schedule.
1065 void usb_release_bandwidth (struct usb_device
*dev
, struct urb
*urb
, int isoc
)
1067 dev
->bus
->bandwidth_allocated
-= urb
->bandwidth
;
1069 dev
->bus
->bandwidth_isoc_reqs
--;
1071 dev
->bus
->bandwidth_int_reqs
--;
1073 #ifdef USB_BANDWIDTH_MESSAGES
1074 dev_dbg (&dev
->dev
, "bandwidth alloc reduced by %d (%s) to %d for %d requesters\n",
1076 isoc
? "ISOC" : "INTR",
1077 dev
->bus
->bandwidth_allocated
,
1078 dev
->bus
->bandwidth_int_reqs
+ dev
->bus
->bandwidth_isoc_reqs
);
1082 EXPORT_SYMBOL (usb_release_bandwidth
);
1085 /*-------------------------------------------------------------------------*/
1088 * Generic HC operations.
1091 /*-------------------------------------------------------------------------*/
1093 static void urb_unlink (struct urb
*urb
)
1095 unsigned long flags
;
1097 /* Release any periodic transfer bandwidth */
1099 usb_release_bandwidth (urb
->dev
, urb
,
1100 usb_pipeisoc (urb
->pipe
));
1102 /* clear all state linking urb to this dev (and hcd) */
1104 spin_lock_irqsave (&hcd_data_lock
, flags
);
1105 list_del_init (&urb
->urb_list
);
1106 spin_unlock_irqrestore (&hcd_data_lock
, flags
);
1107 usb_put_dev (urb
->dev
);
1111 /* may be called in any context with a valid urb->dev usecount
1112 * caller surrenders "ownership" of urb
1113 * expects usb_submit_urb() to have sanity checked and conditioned all
1116 static int hcd_submit_urb (struct urb
*urb
, gfp_t mem_flags
)
1119 struct usb_hcd
*hcd
= urb
->dev
->bus
->hcpriv
;
1120 struct usb_host_endpoint
*ep
;
1121 unsigned long flags
;
1126 usbmon_urb_submit(&hcd
->self
, urb
);
1129 * Atomically queue the urb, first to our records, then to the HCD.
1130 * Access to urb->status is controlled by urb->lock ... changes on
1131 * i/o completion (normal or fault) or unlinking.
1134 // FIXME: verify that quiescing hc works right (RH cleans up)
1136 spin_lock_irqsave (&hcd_data_lock
, flags
);
1137 ep
= (usb_pipein(urb
->pipe
) ? urb
->dev
->ep_in
: urb
->dev
->ep_out
)
1138 [usb_pipeendpoint(urb
->pipe
)];
1141 else if (unlikely (urb
->reject
))
1143 else switch (hcd
->state
) {
1144 case HC_STATE_RUNNING
:
1145 case HC_STATE_RESUMING
:
1146 usb_get_dev (urb
->dev
);
1147 list_add_tail (&urb
->urb_list
, &ep
->urb_list
);
1151 status
= -ESHUTDOWN
;
1154 spin_unlock_irqrestore (&hcd_data_lock
, flags
);
1156 INIT_LIST_HEAD (&urb
->urb_list
);
1157 usbmon_urb_submit_error(&hcd
->self
, urb
, status
);
1161 /* increment urb's reference count as part of giving it to the HCD
1162 * (which now controls it). HCD guarantees that it either returns
1163 * an error or calls giveback(), but not both.
1165 urb
= usb_get_urb (urb
);
1166 atomic_inc (&urb
->use_count
);
1168 if (urb
->dev
== hcd
->self
.root_hub
) {
1169 /* NOTE: requirement on hub callers (usbfs and the hub
1170 * driver, for now) that URBs' urb->transfer_buffer be
1171 * valid and usb_buffer_{sync,unmap}() not be needed, since
1172 * they could clobber root hub response data.
1174 status
= rh_urb_enqueue (hcd
, urb
);
1178 /* lower level hcd code should use *_dma exclusively,
1179 * unless it uses pio or talks to another transport.
1181 if (hcd
->self
.controller
->dma_mask
) {
1182 if (usb_pipecontrol (urb
->pipe
)
1183 && !(urb
->transfer_flags
& URB_NO_SETUP_DMA_MAP
))
1184 urb
->setup_dma
= dma_map_single (
1185 hcd
->self
.controller
,
1187 sizeof (struct usb_ctrlrequest
),
1189 if (urb
->transfer_buffer_length
!= 0
1190 && !(urb
->transfer_flags
& URB_NO_TRANSFER_DMA_MAP
))
1191 urb
->transfer_dma
= dma_map_single (
1192 hcd
->self
.controller
,
1193 urb
->transfer_buffer
,
1194 urb
->transfer_buffer_length
,
1195 usb_pipein (urb
->pipe
)
1200 status
= hcd
->driver
->urb_enqueue (hcd
, ep
, urb
, mem_flags
);
1202 if (unlikely (status
)) {
1204 atomic_dec (&urb
->use_count
);
1206 wake_up (&usb_kill_urb_queue
);
1208 usbmon_urb_submit_error(&hcd
->self
, urb
, status
);
1213 /*-------------------------------------------------------------------------*/
1215 /* called in any context */
1216 static int hcd_get_frame_number (struct usb_device
*udev
)
1218 struct usb_hcd
*hcd
= (struct usb_hcd
*)udev
->bus
->hcpriv
;
1219 if (!HC_IS_RUNNING (hcd
->state
))
1221 return hcd
->driver
->get_frame_number (hcd
);
1224 /*-------------------------------------------------------------------------*/
1226 /* this makes the hcd giveback() the urb more quickly, by kicking it
1227 * off hardware queues (which may take a while) and returning it as
1228 * soon as practical. we've already set up the urb's return status,
1229 * but we can't know if the callback completed already.
1232 unlink1 (struct usb_hcd
*hcd
, struct urb
*urb
)
1236 if (urb
->dev
== hcd
->self
.root_hub
)
1237 value
= usb_rh_urb_dequeue (hcd
, urb
);
1240 /* The only reason an HCD might fail this call is if
1241 * it has not yet fully queued the urb to begin with.
1242 * Such failures should be harmless. */
1243 value
= hcd
->driver
->urb_dequeue (hcd
, urb
);
1247 dev_dbg (hcd
->self
.controller
, "dequeue %p --> %d\n",
1253 * called in any context
1255 * caller guarantees urb won't be recycled till both unlink()
1256 * and the urb's completion function return
1258 static int hcd_unlink_urb (struct urb
*urb
, int status
)
1260 struct usb_host_endpoint
*ep
;
1261 struct usb_hcd
*hcd
= NULL
;
1262 struct device
*sys
= NULL
;
1263 unsigned long flags
;
1264 struct list_head
*tmp
;
1269 if (!urb
->dev
|| !urb
->dev
->bus
)
1271 ep
= (usb_pipein(urb
->pipe
) ? urb
->dev
->ep_in
: urb
->dev
->ep_out
)
1272 [usb_pipeendpoint(urb
->pipe
)];
1277 * we contend for urb->status with the hcd core,
1278 * which changes it while returning the urb.
1280 * Caller guaranteed that the urb pointer hasn't been freed, and
1281 * that it was submitted. But as a rule it can't know whether or
1282 * not it's already been unlinked ... so we respect the reversed
1283 * lock sequence needed for the usb_hcd_giveback_urb() code paths
1284 * (urb lock, then hcd_data_lock) in case some other CPU is now
1287 spin_lock_irqsave (&urb
->lock
, flags
);
1288 spin_lock (&hcd_data_lock
);
1290 sys
= &urb
->dev
->dev
;
1291 hcd
= urb
->dev
->bus
->hcpriv
;
1297 /* running ~= hc unlink handshake works (irq, timer, etc)
1298 * halted ~= no unlink handshake is needed
1299 * suspended, resuming == should never happen
1301 WARN_ON (!HC_IS_RUNNING (hcd
->state
) && hcd
->state
!= HC_STATE_HALT
);
1303 /* insist the urb is still queued */
1304 list_for_each(tmp
, &ep
->urb_list
) {
1305 if (tmp
== &urb
->urb_list
)
1308 if (tmp
!= &urb
->urb_list
) {
1313 /* Any status except -EINPROGRESS means something already started to
1314 * unlink this URB from the hardware. So there's no more work to do.
1316 if (urb
->status
!= -EINPROGRESS
) {
1321 /* IRQ setup can easily be broken so that USB controllers
1322 * never get completion IRQs ... maybe even the ones we need to
1323 * finish unlinking the initial failed usb_set_address()
1324 * or device descriptor fetch.
1326 if (!hcd
->saw_irq
&& hcd
->self
.root_hub
!= urb
->dev
) {
1327 dev_warn (hcd
->self
.controller
, "Unlink after no-IRQ? "
1328 "Controller is probably using the wrong IRQ."
1333 urb
->status
= status
;
1335 spin_unlock (&hcd_data_lock
);
1336 spin_unlock_irqrestore (&urb
->lock
, flags
);
1338 retval
= unlink1 (hcd
, urb
);
1340 retval
= -EINPROGRESS
;
1344 spin_unlock (&hcd_data_lock
);
1345 spin_unlock_irqrestore (&urb
->lock
, flags
);
1346 if (retval
!= -EIDRM
&& sys
&& sys
->driver
)
1347 dev_dbg (sys
, "hcd_unlink_urb %p fail %d\n", urb
, retval
);
1351 /*-------------------------------------------------------------------------*/
1353 /* disables the endpoint: cancels any pending urbs, then synchronizes with
1354 * the hcd to make sure all endpoint state is gone from hardware. use for
1355 * set_configuration, set_interface, driver removal, physical disconnect.
1357 * example: a qh stored in ep->hcpriv, holding state related to endpoint
1358 * type, maxpacket size, toggle, halt status, and scheduling.
1361 hcd_endpoint_disable (struct usb_device
*udev
, struct usb_host_endpoint
*ep
)
1363 struct usb_hcd
*hcd
;
1366 hcd
= udev
->bus
->hcpriv
;
1368 WARN_ON (!HC_IS_RUNNING (hcd
->state
) && hcd
->state
!= HC_STATE_HALT
&&
1369 udev
->state
!= USB_STATE_NOTATTACHED
);
1371 local_irq_disable ();
1373 /* FIXME move most of this into message.c as part of its
1374 * endpoint disable logic
1377 /* ep is already gone from udev->ep_{in,out}[]; no more submits */
1379 spin_lock (&hcd_data_lock
);
1380 list_for_each_entry (urb
, &ep
->urb_list
, urb_list
) {
1383 /* another cpu may be in hcd, spinning on hcd_data_lock
1384 * to giveback() this urb. the races here should be
1385 * small, but a full fix needs a new "can't submit"
1387 * FIXME urb->reject should allow that...
1389 if (urb
->status
!= -EINPROGRESS
)
1392 spin_unlock (&hcd_data_lock
);
1394 spin_lock (&urb
->lock
);
1396 if (tmp
== -EINPROGRESS
)
1397 urb
->status
= -ESHUTDOWN
;
1398 spin_unlock (&urb
->lock
);
1400 /* kick hcd unless it's already returning this */
1401 if (tmp
== -EINPROGRESS
) {
1404 dev_dbg (hcd
->self
.controller
,
1405 "shutdown urb %p pipe %08x ep%d%s%s\n",
1406 urb
, tmp
, usb_pipeendpoint (tmp
),
1407 (tmp
& USB_DIR_IN
) ? "in" : "out",
1409 switch (usb_pipetype (tmp
)) { \
1410 case PIPE_CONTROL
: s
= ""; break; \
1411 case PIPE_BULK
: s
= "-bulk"; break; \
1412 case PIPE_INTERRUPT
: s
= "-intr"; break; \
1413 default: s
= "-iso"; break; \
1418 /* list contents may have changed */
1421 spin_unlock (&hcd_data_lock
);
1422 local_irq_enable ();
1424 /* synchronize with the hardware, so old configuration state
1425 * clears out immediately (and will be freed).
1428 if (hcd
->driver
->endpoint_disable
)
1429 hcd
->driver
->endpoint_disable (hcd
, ep
);
1432 /*-------------------------------------------------------------------------*/
1436 static int hcd_hub_suspend (struct usb_bus
*bus
)
1438 struct usb_hcd
*hcd
;
1441 hcd
= container_of (bus
, struct usb_hcd
, self
);
1442 if (!hcd
->driver
->hub_suspend
)
1444 hcd
->state
= HC_STATE_QUIESCING
;
1445 status
= hcd
->driver
->hub_suspend (hcd
);
1447 hcd
->state
= HC_STATE_SUSPENDED
;
1449 dev_dbg(&bus
->root_hub
->dev
, "%s fail, err %d\n",
1454 static int hcd_hub_resume (struct usb_bus
*bus
)
1456 struct usb_hcd
*hcd
;
1459 hcd
= container_of (bus
, struct usb_hcd
, self
);
1460 if (!hcd
->driver
->hub_resume
)
1462 hcd
->state
= HC_STATE_RESUMING
;
1463 status
= hcd
->driver
->hub_resume (hcd
);
1465 hcd
->state
= HC_STATE_RUNNING
;
1467 dev_dbg(&bus
->root_hub
->dev
, "%s fail, err %d\n",
1475 * usb_hcd_resume_root_hub - called by HCD to resume its root hub
1476 * @hcd: host controller for this root hub
1478 * The USB host controller calls this function when its root hub is
1479 * suspended (with the remote wakeup feature enabled) and a remote
1480 * wakeup request is received. It queues a request for khubd to
1481 * resume the root hub.
1483 void usb_hcd_resume_root_hub (struct usb_hcd
*hcd
)
1485 unsigned long flags
;
1487 spin_lock_irqsave (&hcd_root_hub_lock
, flags
);
1488 if (hcd
->rh_registered
)
1489 usb_resume_root_hub (hcd
->self
.root_hub
);
1490 spin_unlock_irqrestore (&hcd_root_hub_lock
, flags
);
1492 EXPORT_SYMBOL_GPL(usb_hcd_resume_root_hub
);
1496 /*-------------------------------------------------------------------------*/
1498 #ifdef CONFIG_USB_OTG
1501 * usb_bus_start_enum - start immediate enumeration (for OTG)
1502 * @bus: the bus (must use hcd framework)
1503 * @port_num: 1-based number of port; usually bus->otg_port
1504 * Context: in_interrupt()
1506 * Starts enumeration, with an immediate reset followed later by
1507 * khubd identifying and possibly configuring the device.
1508 * This is needed by OTG controller drivers, where it helps meet
1509 * HNP protocol timing requirements for starting a port reset.
1511 int usb_bus_start_enum(struct usb_bus
*bus
, unsigned port_num
)
1513 struct usb_hcd
*hcd
;
1514 int status
= -EOPNOTSUPP
;
1516 /* NOTE: since HNP can't start by grabbing the bus's address0_sem,
1517 * boards with root hubs hooked up to internal devices (instead of
1518 * just the OTG port) may need more attention to resetting...
1520 hcd
= container_of (bus
, struct usb_hcd
, self
);
1521 if (port_num
&& hcd
->driver
->start_port_reset
)
1522 status
= hcd
->driver
->start_port_reset(hcd
, port_num
);
1524 /* run khubd shortly after (first) root port reset finishes;
1525 * it may issue others, until at least 50 msecs have passed.
1528 mod_timer(&hcd
->rh_timer
, jiffies
+ msecs_to_jiffies(10));
1531 EXPORT_SYMBOL (usb_bus_start_enum
);
1535 /*-------------------------------------------------------------------------*/
1538 * usb_hcd_operations - adapts usb_bus framework to HCD framework (bus glue)
1540 static struct usb_operations usb_hcd_operations
= {
1541 .get_frame_number
= hcd_get_frame_number
,
1542 .submit_urb
= hcd_submit_urb
,
1543 .unlink_urb
= hcd_unlink_urb
,
1544 .buffer_alloc
= hcd_buffer_alloc
,
1545 .buffer_free
= hcd_buffer_free
,
1546 .disable
= hcd_endpoint_disable
,
1548 .hub_suspend
= hcd_hub_suspend
,
1549 .hub_resume
= hcd_hub_resume
,
1553 /*-------------------------------------------------------------------------*/
1556 * usb_hcd_giveback_urb - return URB from HCD to device driver
1557 * @hcd: host controller returning the URB
1558 * @urb: urb being returned to the USB device driver.
1559 * @regs: pt_regs, passed down to the URB completion handler
1560 * Context: in_interrupt()
1562 * This hands the URB from HCD to its USB device driver, using its
1563 * completion function. The HCD has freed all per-urb resources
1564 * (and is done using urb->hcpriv). It also released all HCD locks;
1565 * the device driver won't cause problems if it frees, modifies,
1566 * or resubmits this URB.
1568 void usb_hcd_giveback_urb (struct usb_hcd
*hcd
, struct urb
*urb
, struct pt_regs
*regs
)
1572 at_root_hub
= (urb
->dev
== hcd
->self
.root_hub
);
1575 /* lower level hcd code should use *_dma exclusively */
1576 if (hcd
->self
.controller
->dma_mask
&& !at_root_hub
) {
1577 if (usb_pipecontrol (urb
->pipe
)
1578 && !(urb
->transfer_flags
& URB_NO_SETUP_DMA_MAP
))
1579 dma_unmap_single (hcd
->self
.controller
, urb
->setup_dma
,
1580 sizeof (struct usb_ctrlrequest
),
1582 if (urb
->transfer_buffer_length
!= 0
1583 && !(urb
->transfer_flags
& URB_NO_TRANSFER_DMA_MAP
))
1584 dma_unmap_single (hcd
->self
.controller
,
1586 urb
->transfer_buffer_length
,
1587 usb_pipein (urb
->pipe
)
1592 usbmon_urb_complete (&hcd
->self
, urb
);
1593 /* pass ownership to the completion handler */
1594 urb
->complete (urb
, regs
);
1595 atomic_dec (&urb
->use_count
);
1596 if (unlikely (urb
->reject
))
1597 wake_up (&usb_kill_urb_queue
);
1600 EXPORT_SYMBOL (usb_hcd_giveback_urb
);
1602 /*-------------------------------------------------------------------------*/
1605 * usb_hcd_irq - hook IRQs to HCD framework (bus glue)
1606 * @irq: the IRQ being raised
1607 * @__hcd: pointer to the HCD whose IRQ is being signaled
1608 * @r: saved hardware registers
1610 * If the controller isn't HALTed, calls the driver's irq handler.
1611 * Checks whether the controller is now dead.
1613 irqreturn_t
usb_hcd_irq (int irq
, void *__hcd
, struct pt_regs
* r
)
1615 struct usb_hcd
*hcd
= __hcd
;
1616 int start
= hcd
->state
;
1618 if (start
== HC_STATE_HALT
)
1620 if (hcd
->driver
->irq (hcd
, r
) == IRQ_NONE
)
1624 if (hcd
->state
== HC_STATE_HALT
)
1629 /*-------------------------------------------------------------------------*/
1632 * usb_hc_died - report abnormal shutdown of a host controller (bus glue)
1633 * @hcd: pointer to the HCD representing the controller
1635 * This is called by bus glue to report a USB host controller that died
1636 * while operations may still have been pending. It's called automatically
1637 * by the PCI glue, so only glue for non-PCI busses should need to call it.
1639 void usb_hc_died (struct usb_hcd
*hcd
)
1641 unsigned long flags
;
1643 dev_err (hcd
->self
.controller
, "HC died; cleaning up\n");
1645 spin_lock_irqsave (&hcd_root_hub_lock
, flags
);
1646 if (hcd
->rh_registered
) {
1649 /* make khubd clean up old urbs and devices */
1650 usb_set_device_state (hcd
->self
.root_hub
,
1651 USB_STATE_NOTATTACHED
);
1652 usb_kick_khubd (hcd
->self
.root_hub
);
1654 spin_unlock_irqrestore (&hcd_root_hub_lock
, flags
);
1656 EXPORT_SYMBOL_GPL (usb_hc_died
);
1658 /*-------------------------------------------------------------------------*/
1660 static void hcd_release (struct usb_bus
*bus
)
1662 struct usb_hcd
*hcd
;
1664 hcd
= container_of(bus
, struct usb_hcd
, self
);
1669 * usb_create_hcd - create and initialize an HCD structure
1670 * @driver: HC driver that will use this hcd
1671 * @dev: device for this HC, stored in hcd->self.controller
1672 * @bus_name: value to store in hcd->self.bus_name
1673 * Context: !in_interrupt()
1675 * Allocate a struct usb_hcd, with extra space at the end for the
1676 * HC driver's private data. Initialize the generic members of the
1679 * If memory is unavailable, returns NULL.
1681 struct usb_hcd
*usb_create_hcd (const struct hc_driver
*driver
,
1682 struct device
*dev
, char *bus_name
)
1684 struct usb_hcd
*hcd
;
1686 hcd
= kzalloc(sizeof(*hcd
) + driver
->hcd_priv_size
, GFP_KERNEL
);
1688 dev_dbg (dev
, "hcd alloc failed\n");
1691 dev_set_drvdata(dev
, hcd
);
1693 usb_bus_init(&hcd
->self
);
1694 hcd
->self
.op
= &usb_hcd_operations
;
1695 hcd
->self
.hcpriv
= hcd
;
1696 hcd
->self
.release
= &hcd_release
;
1697 hcd
->self
.controller
= dev
;
1698 hcd
->self
.bus_name
= bus_name
;
1700 init_timer(&hcd
->rh_timer
);
1701 hcd
->rh_timer
.function
= rh_timer_func
;
1702 hcd
->rh_timer
.data
= (unsigned long) hcd
;
1704 hcd
->driver
= driver
;
1705 hcd
->product_desc
= (driver
->product_desc
) ? driver
->product_desc
:
1706 "USB Host Controller";
1710 EXPORT_SYMBOL (usb_create_hcd
);
1712 void usb_put_hcd (struct usb_hcd
*hcd
)
1714 dev_set_drvdata(hcd
->self
.controller
, NULL
);
1715 usb_bus_put(&hcd
->self
);
1717 EXPORT_SYMBOL (usb_put_hcd
);
1720 * usb_add_hcd - finish generic HCD structure initialization and register
1721 * @hcd: the usb_hcd structure to initialize
1722 * @irqnum: Interrupt line to allocate
1723 * @irqflags: Interrupt type flags
1725 * Finish the remaining parts of generic HCD initialization: allocate the
1726 * buffers of consistent memory, register the bus, request the IRQ line,
1727 * and call the driver's reset() and start() routines.
1729 int usb_add_hcd(struct usb_hcd
*hcd
,
1730 unsigned int irqnum
, unsigned long irqflags
)
1733 struct usb_device
*rhdev
;
1735 dev_info(hcd
->self
.controller
, "%s\n", hcd
->product_desc
);
1737 /* till now HC has been in an indeterminate state ... */
1738 if (hcd
->driver
->reset
&& (retval
= hcd
->driver
->reset(hcd
)) < 0) {
1739 dev_err(hcd
->self
.controller
, "can't reset\n");
1743 if ((retval
= hcd_buffer_create(hcd
)) != 0) {
1744 dev_dbg(hcd
->self
.controller
, "pool alloc failed\n");
1748 if ((retval
= usb_register_bus(&hcd
->self
)) < 0)
1749 goto err_register_bus
;
1751 if (hcd
->driver
->irq
) {
1752 char buf
[8], *bufp
= buf
;
1755 bufp
= __irq_itoa(irqnum
);
1757 sprintf(buf
, "%d", irqnum
);
1760 snprintf(hcd
->irq_descr
, sizeof(hcd
->irq_descr
), "%s:usb%d",
1761 hcd
->driver
->description
, hcd
->self
.busnum
);
1762 if ((retval
= request_irq(irqnum
, &usb_hcd_irq
, irqflags
,
1763 hcd
->irq_descr
, hcd
)) != 0) {
1764 dev_err(hcd
->self
.controller
,
1765 "request interrupt %s failed\n", bufp
);
1766 goto err_request_irq
;
1769 dev_info(hcd
->self
.controller
, "irq %s, %s 0x%08llx\n", bufp
,
1770 (hcd
->driver
->flags
& HCD_MEMORY
) ?
1771 "io mem" : "io base",
1772 (unsigned long long)hcd
->rsrc_start
);
1775 if (hcd
->rsrc_start
)
1776 dev_info(hcd
->self
.controller
, "%s 0x%08llx\n",
1777 (hcd
->driver
->flags
& HCD_MEMORY
) ?
1778 "io mem" : "io base",
1779 (unsigned long long)hcd
->rsrc_start
);
1782 /* Allocate the root hub before calling hcd->driver->start(),
1783 * but don't register it until afterward so that the hardware
1786 if ((rhdev
= usb_alloc_dev(NULL
, &hcd
->self
, 0)) == NULL
) {
1787 dev_err(hcd
->self
.controller
, "unable to allocate root hub\n");
1789 goto err_allocate_root_hub
;
1791 rhdev
->speed
= (hcd
->driver
->flags
& HCD_USB2
) ? USB_SPEED_HIGH
:
1794 /* Although in principle hcd->driver->start() might need to use rhdev,
1795 * none of the current drivers do.
1797 if ((retval
= hcd
->driver
->start(hcd
)) < 0) {
1798 dev_err(hcd
->self
.controller
, "startup error %d\n", retval
);
1799 goto err_hcd_driver_start
;
1802 /* hcd->driver->start() reported can_wakeup, probably with
1803 * assistance from board's boot firmware.
1804 * NOTE: normal devices won't enable wakeup by default.
1806 if (hcd
->can_wakeup
)
1807 dev_dbg(hcd
->self
.controller
, "supports USB remote wakeup\n");
1808 hcd
->remote_wakeup
= hcd
->can_wakeup
;
1810 if ((retval
= register_root_hub(rhdev
, hcd
)) != 0)
1811 goto err_register_root_hub
;
1813 if (hcd
->uses_new_polling
&& hcd
->poll_rh
)
1814 usb_hcd_poll_rh_status(hcd
);
1817 err_register_root_hub
:
1818 hcd
->driver
->stop(hcd
);
1820 err_hcd_driver_start
:
1823 err_allocate_root_hub
:
1825 free_irq(irqnum
, hcd
);
1828 usb_deregister_bus(&hcd
->self
);
1831 hcd_buffer_destroy(hcd
);
1834 EXPORT_SYMBOL (usb_add_hcd
);
1837 * usb_remove_hcd - shutdown processing for generic HCDs
1838 * @hcd: the usb_hcd structure to remove
1839 * Context: !in_interrupt()
1841 * Disconnects the root hub, then reverses the effects of usb_add_hcd(),
1842 * invoking the HCD's stop() method.
1844 void usb_remove_hcd(struct usb_hcd
*hcd
)
1846 dev_info(hcd
->self
.controller
, "remove, state %x\n", hcd
->state
);
1848 if (HC_IS_RUNNING (hcd
->state
))
1849 hcd
->state
= HC_STATE_QUIESCING
;
1851 dev_dbg(hcd
->self
.controller
, "roothub graceful disconnect\n");
1852 spin_lock_irq (&hcd_root_hub_lock
);
1853 hcd
->rh_registered
= 0;
1854 spin_unlock_irq (&hcd_root_hub_lock
);
1855 usb_disconnect(&hcd
->self
.root_hub
);
1858 del_timer_sync(&hcd
->rh_timer
);
1860 hcd
->driver
->stop(hcd
);
1861 hcd
->state
= HC_STATE_HALT
;
1864 free_irq(hcd
->irq
, hcd
);
1865 usb_deregister_bus(&hcd
->self
);
1866 hcd_buffer_destroy(hcd
);
1868 EXPORT_SYMBOL (usb_remove_hcd
);
1870 /*-------------------------------------------------------------------------*/
1872 #if defined(CONFIG_USB_MON)
1874 struct usb_mon_operations
*mon_ops
;
1877 * The registration is unlocked.
1878 * We do it this way because we do not want to lock in hot paths.
1880 * Notice that the code is minimally error-proof. Because usbmon needs
1881 * symbols from usbcore, usbcore gets referenced and cannot be unloaded first.
1884 int usb_mon_register (struct usb_mon_operations
*ops
)
1894 EXPORT_SYMBOL_GPL (usb_mon_register
);
1896 void usb_mon_deregister (void)
1899 if (mon_ops
== NULL
) {
1900 printk(KERN_ERR
"USB: monitor was not registered\n");
1906 EXPORT_SYMBOL_GPL (usb_mon_deregister
);
1908 #endif /* CONFIG_USB_MON */