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/module.h>
26 #include <linux/version.h>
27 #include <linux/kernel.h>
28 #include <linux/slab.h>
29 #include <linux/completion.h>
30 #include <linux/utsname.h>
33 #include <asm/scatterlist.h>
34 #include <linux/device.h>
35 #include <linux/dma-mapping.h>
36 #include <linux/mutex.h>
38 #include <asm/byteorder.h>
39 #include <linux/platform_device.h>
40 #include <linux/workqueue.h>
42 #include <linux/usb.h>
49 /*-------------------------------------------------------------------------*/
52 * USB Host Controller Driver framework
54 * Plugs into usbcore (usb_bus) and lets HCDs share code, minimizing
55 * HCD-specific behaviors/bugs.
57 * This does error checks, tracks devices and urbs, and delegates to a
58 * "hc_driver" only for code (and data) that really needs to know about
59 * hardware differences. That includes root hub registers, i/o queues,
60 * and so on ... but as little else as possible.
62 * Shared code includes most of the "root hub" code (these are emulated,
63 * though each HC's hardware works differently) and PCI glue, plus request
64 * tracking overhead. The HCD code should only block on spinlocks or on
65 * hardware handshaking; blocking on software events (such as other kernel
66 * threads releasing resources, or completing actions) is all generic.
68 * Happens the USB 2.0 spec says this would be invisible inside the "USBD",
69 * and includes mostly a "HCDI" (HCD Interface) along with some APIs used
70 * only by the hub driver ... and that neither should be seen or used by
71 * usb client device drivers.
73 * Contributors of ideas or unattributed patches include: David Brownell,
74 * Roman Weissgaerber, Rory Bolt, Greg Kroah-Hartman, ...
77 * 2002-02-21 Pull in most of the usb_bus support from usb.c; some
78 * associated cleanup. "usb_hcd" still != "usb_bus".
79 * 2001-12-12 Initial patch version for Linux 2.5.1 kernel.
82 /*-------------------------------------------------------------------------*/
84 /* host controllers we manage */
85 LIST_HEAD (usb_bus_list
);
86 EXPORT_SYMBOL_GPL (usb_bus_list
);
88 /* used when allocating bus numbers */
91 unsigned long busmap
[USB_MAXBUS
/ (8*sizeof (unsigned long))];
93 static struct usb_busmap busmap
;
95 /* used when updating list of hcds */
96 DEFINE_MUTEX(usb_bus_list_lock
); /* exported only for usbfs */
97 EXPORT_SYMBOL_GPL (usb_bus_list_lock
);
99 /* used for controlling access to virtual root hubs */
100 static DEFINE_SPINLOCK(hcd_root_hub_lock
);
102 /* used when updating hcd data */
103 static DEFINE_SPINLOCK(hcd_data_lock
);
105 /* wait queue for synchronous unlinks */
106 DECLARE_WAIT_QUEUE_HEAD(usb_kill_urb_queue
);
108 /*-------------------------------------------------------------------------*/
111 * Sharable chunks of root hub code.
114 /*-------------------------------------------------------------------------*/
116 #define KERNEL_REL ((LINUX_VERSION_CODE >> 16) & 0x0ff)
117 #define KERNEL_VER ((LINUX_VERSION_CODE >> 8) & 0x0ff)
119 /* usb 2.0 root hub device descriptor */
120 static const u8 usb2_rh_dev_descriptor
[18] = {
121 0x12, /* __u8 bLength; */
122 0x01, /* __u8 bDescriptorType; Device */
123 0x00, 0x02, /* __le16 bcdUSB; v2.0 */
125 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
126 0x00, /* __u8 bDeviceSubClass; */
127 0x01, /* __u8 bDeviceProtocol; [ usb 2.0 single TT ]*/
128 0x40, /* __u8 bMaxPacketSize0; 64 Bytes */
130 0x00, 0x00, /* __le16 idVendor; */
131 0x00, 0x00, /* __le16 idProduct; */
132 KERNEL_VER
, KERNEL_REL
, /* __le16 bcdDevice */
134 0x03, /* __u8 iManufacturer; */
135 0x02, /* __u8 iProduct; */
136 0x01, /* __u8 iSerialNumber; */
137 0x01 /* __u8 bNumConfigurations; */
140 /* no usb 2.0 root hub "device qualifier" descriptor: one speed only */
142 /* usb 1.1 root hub device descriptor */
143 static const u8 usb11_rh_dev_descriptor
[18] = {
144 0x12, /* __u8 bLength; */
145 0x01, /* __u8 bDescriptorType; Device */
146 0x10, 0x01, /* __le16 bcdUSB; v1.1 */
148 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
149 0x00, /* __u8 bDeviceSubClass; */
150 0x00, /* __u8 bDeviceProtocol; [ low/full speeds only ] */
151 0x40, /* __u8 bMaxPacketSize0; 64 Bytes */
153 0x00, 0x00, /* __le16 idVendor; */
154 0x00, 0x00, /* __le16 idProduct; */
155 KERNEL_VER
, KERNEL_REL
, /* __le16 bcdDevice */
157 0x03, /* __u8 iManufacturer; */
158 0x02, /* __u8 iProduct; */
159 0x01, /* __u8 iSerialNumber; */
160 0x01 /* __u8 bNumConfigurations; */
164 /*-------------------------------------------------------------------------*/
166 /* Configuration descriptors for our root hubs */
168 static const u8 fs_rh_config_descriptor
[] = {
170 /* one configuration */
171 0x09, /* __u8 bLength; */
172 0x02, /* __u8 bDescriptorType; Configuration */
173 0x19, 0x00, /* __le16 wTotalLength; */
174 0x01, /* __u8 bNumInterfaces; (1) */
175 0x01, /* __u8 bConfigurationValue; */
176 0x00, /* __u8 iConfiguration; */
177 0xc0, /* __u8 bmAttributes;
182 0x00, /* __u8 MaxPower; */
185 * USB 2.0, single TT organization (mandatory):
186 * one interface, protocol 0
188 * USB 2.0, multiple TT organization (optional):
189 * two interfaces, protocols 1 (like single TT)
190 * and 2 (multiple TT mode) ... config is
196 0x09, /* __u8 if_bLength; */
197 0x04, /* __u8 if_bDescriptorType; Interface */
198 0x00, /* __u8 if_bInterfaceNumber; */
199 0x00, /* __u8 if_bAlternateSetting; */
200 0x01, /* __u8 if_bNumEndpoints; */
201 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
202 0x00, /* __u8 if_bInterfaceSubClass; */
203 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
204 0x00, /* __u8 if_iInterface; */
206 /* one endpoint (status change endpoint) */
207 0x07, /* __u8 ep_bLength; */
208 0x05, /* __u8 ep_bDescriptorType; Endpoint */
209 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
210 0x03, /* __u8 ep_bmAttributes; Interrupt */
211 0x02, 0x00, /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8) */
212 0xff /* __u8 ep_bInterval; (255ms -- usb 2.0 spec) */
215 static const u8 hs_rh_config_descriptor
[] = {
217 /* one configuration */
218 0x09, /* __u8 bLength; */
219 0x02, /* __u8 bDescriptorType; Configuration */
220 0x19, 0x00, /* __le16 wTotalLength; */
221 0x01, /* __u8 bNumInterfaces; (1) */
222 0x01, /* __u8 bConfigurationValue; */
223 0x00, /* __u8 iConfiguration; */
224 0xc0, /* __u8 bmAttributes;
229 0x00, /* __u8 MaxPower; */
232 * USB 2.0, single TT organization (mandatory):
233 * one interface, protocol 0
235 * USB 2.0, multiple TT organization (optional):
236 * two interfaces, protocols 1 (like single TT)
237 * and 2 (multiple TT mode) ... config is
243 0x09, /* __u8 if_bLength; */
244 0x04, /* __u8 if_bDescriptorType; Interface */
245 0x00, /* __u8 if_bInterfaceNumber; */
246 0x00, /* __u8 if_bAlternateSetting; */
247 0x01, /* __u8 if_bNumEndpoints; */
248 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
249 0x00, /* __u8 if_bInterfaceSubClass; */
250 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
251 0x00, /* __u8 if_iInterface; */
253 /* one endpoint (status change endpoint) */
254 0x07, /* __u8 ep_bLength; */
255 0x05, /* __u8 ep_bDescriptorType; Endpoint */
256 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
257 0x03, /* __u8 ep_bmAttributes; Interrupt */
258 /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8)
259 * see hub.c:hub_configure() for details. */
260 (USB_MAXCHILDREN
+ 1 + 7) / 8, 0x00,
261 0x0c /* __u8 ep_bInterval; (256ms -- usb 2.0 spec) */
264 /*-------------------------------------------------------------------------*/
267 * helper routine for returning string descriptors in UTF-16LE
268 * input can actually be ISO-8859-1; ASCII is its 7-bit subset
270 static int ascii2utf (char *s
, u8
*utf
, int utfmax
)
274 for (retval
= 0; *s
&& utfmax
> 1; utfmax
-= 2, retval
+= 2) {
286 * rh_string - provides manufacturer, product and serial strings for root hub
287 * @id: the string ID number (1: serial number, 2: product, 3: vendor)
288 * @hcd: the host controller for this root hub
289 * @type: string describing our driver
290 * @data: return packet in UTF-16 LE
291 * @len: length of the return packet
293 * Produces either a manufacturer, product or serial number string for the
294 * virtual root hub device.
296 static int rh_string (
306 buf
[0] = 4; buf
[1] = 3; /* 4 bytes string data */
307 buf
[2] = 0x09; buf
[3] = 0x04; /* MSFT-speak for "en-us" */
309 memcpy (data
, buf
, len
);
313 } else if (id
== 1) {
314 strlcpy (buf
, hcd
->self
.bus_name
, sizeof buf
);
316 // product description
317 } else if (id
== 2) {
318 strlcpy (buf
, hcd
->product_desc
, sizeof buf
);
320 // id 3 == vendor description
321 } else if (id
== 3) {
322 snprintf (buf
, sizeof buf
, "%s %s %s", init_utsname()->sysname
,
323 init_utsname()->release
, hcd
->driver
->description
);
325 // unsupported IDs --> "protocol stall"
329 switch (len
) { /* All cases fall through */
331 len
= 2 + ascii2utf (buf
, data
+ 2, len
- 2);
333 data
[1] = 3; /* type == string */
335 data
[0] = 2 * (strlen (buf
) + 1);
337 ; /* Compiler wants a statement here */
343 /* Root hub control transfers execute synchronously */
344 static int rh_call_control (struct usb_hcd
*hcd
, struct urb
*urb
)
346 struct usb_ctrlrequest
*cmd
;
347 u16 typeReq
, wValue
, wIndex
, wLength
;
348 u8
*ubuf
= urb
->transfer_buffer
;
349 u8 tbuf
[sizeof (struct usb_hub_descriptor
)]
350 __attribute__((aligned(4)));
351 const u8
*bufp
= tbuf
;
353 int patch_wakeup
= 0;
358 cmd
= (struct usb_ctrlrequest
*) urb
->setup_packet
;
359 typeReq
= (cmd
->bRequestType
<< 8) | cmd
->bRequest
;
360 wValue
= le16_to_cpu (cmd
->wValue
);
361 wIndex
= le16_to_cpu (cmd
->wIndex
);
362 wLength
= le16_to_cpu (cmd
->wLength
);
364 if (wLength
> urb
->transfer_buffer_length
)
367 urb
->actual_length
= 0;
370 /* DEVICE REQUESTS */
372 /* The root hub's remote wakeup enable bit is implemented using
373 * driver model wakeup flags. If this system supports wakeup
374 * through USB, userspace may change the default "allow wakeup"
375 * policy through sysfs or these calls.
377 * Most root hubs support wakeup from downstream devices, for
378 * runtime power management (disabling USB clocks and reducing
379 * VBUS power usage). However, not all of them do so; silicon,
380 * board, and BIOS bugs here are not uncommon, so these can't
381 * be treated quite like external hubs.
383 * Likewise, not all root hubs will pass wakeup events upstream,
384 * to wake up the whole system. So don't assume root hub and
385 * controller capabilities are identical.
388 case DeviceRequest
| USB_REQ_GET_STATUS
:
389 tbuf
[0] = (device_may_wakeup(&hcd
->self
.root_hub
->dev
)
390 << USB_DEVICE_REMOTE_WAKEUP
)
391 | (1 << USB_DEVICE_SELF_POWERED
);
395 case DeviceOutRequest
| USB_REQ_CLEAR_FEATURE
:
396 if (wValue
== USB_DEVICE_REMOTE_WAKEUP
)
397 device_set_wakeup_enable(&hcd
->self
.root_hub
->dev
, 0);
401 case DeviceOutRequest
| USB_REQ_SET_FEATURE
:
402 if (device_can_wakeup(&hcd
->self
.root_hub
->dev
)
403 && wValue
== USB_DEVICE_REMOTE_WAKEUP
)
404 device_set_wakeup_enable(&hcd
->self
.root_hub
->dev
, 1);
408 case DeviceRequest
| USB_REQ_GET_CONFIGURATION
:
412 case DeviceOutRequest
| USB_REQ_SET_CONFIGURATION
:
414 case DeviceRequest
| USB_REQ_GET_DESCRIPTOR
:
415 switch (wValue
& 0xff00) {
416 case USB_DT_DEVICE
<< 8:
417 if (hcd
->driver
->flags
& HCD_USB2
)
418 bufp
= usb2_rh_dev_descriptor
;
419 else if (hcd
->driver
->flags
& HCD_USB11
)
420 bufp
= usb11_rh_dev_descriptor
;
425 case USB_DT_CONFIG
<< 8:
426 if (hcd
->driver
->flags
& HCD_USB2
) {
427 bufp
= hs_rh_config_descriptor
;
428 len
= sizeof hs_rh_config_descriptor
;
430 bufp
= fs_rh_config_descriptor
;
431 len
= sizeof fs_rh_config_descriptor
;
433 if (device_can_wakeup(&hcd
->self
.root_hub
->dev
))
436 case USB_DT_STRING
<< 8:
437 n
= rh_string (wValue
& 0xff, hcd
, ubuf
, wLength
);
440 urb
->actual_length
= n
;
446 case DeviceRequest
| USB_REQ_GET_INTERFACE
:
450 case DeviceOutRequest
| USB_REQ_SET_INTERFACE
:
452 case DeviceOutRequest
| USB_REQ_SET_ADDRESS
:
453 // wValue == urb->dev->devaddr
454 dev_dbg (hcd
->self
.controller
, "root hub device address %d\n",
458 /* INTERFACE REQUESTS (no defined feature/status flags) */
460 /* ENDPOINT REQUESTS */
462 case EndpointRequest
| USB_REQ_GET_STATUS
:
463 // ENDPOINT_HALT flag
468 case EndpointOutRequest
| USB_REQ_CLEAR_FEATURE
:
469 case EndpointOutRequest
| USB_REQ_SET_FEATURE
:
470 dev_dbg (hcd
->self
.controller
, "no endpoint features yet\n");
473 /* CLASS REQUESTS (and errors) */
476 /* non-generic request */
482 case GetHubDescriptor
:
483 len
= sizeof (struct usb_hub_descriptor
);
486 status
= hcd
->driver
->hub_control (hcd
,
487 typeReq
, wValue
, wIndex
,
491 /* "protocol stall" on error */
497 if (status
!= -EPIPE
) {
498 dev_dbg (hcd
->self
.controller
,
499 "CTRL: TypeReq=0x%x val=0x%x "
500 "idx=0x%x len=%d ==> %d\n",
501 typeReq
, wValue
, wIndex
,
506 if (urb
->transfer_buffer_length
< len
)
507 len
= urb
->transfer_buffer_length
;
508 urb
->actual_length
= len
;
509 // always USB_DIR_IN, toward host
510 memcpy (ubuf
, bufp
, len
);
512 /* report whether RH hardware supports remote wakeup */
514 len
> offsetof (struct usb_config_descriptor
,
516 ((struct usb_config_descriptor
*)ubuf
)->bmAttributes
517 |= USB_CONFIG_ATT_WAKEUP
;
520 /* any errors get returned through the urb completion */
521 local_irq_save (flags
);
522 spin_lock (&urb
->lock
);
523 if (urb
->status
== -EINPROGRESS
)
524 urb
->status
= status
;
525 spin_unlock (&urb
->lock
);
526 usb_hcd_giveback_urb (hcd
, urb
);
527 local_irq_restore (flags
);
531 /*-------------------------------------------------------------------------*/
534 * Root Hub interrupt transfers are polled using a timer if the
535 * driver requests it; otherwise the driver is responsible for
536 * calling usb_hcd_poll_rh_status() when an event occurs.
538 * Completions are called in_interrupt(), but they may or may not
541 void usb_hcd_poll_rh_status(struct usb_hcd
*hcd
)
546 char buffer
[4]; /* Any root hubs with > 31 ports? */
548 if (unlikely(!hcd
->rh_registered
))
550 if (!hcd
->uses_new_polling
&& !hcd
->status_urb
)
553 length
= hcd
->driver
->hub_status_data(hcd
, buffer
);
556 /* try to complete the status urb */
557 local_irq_save (flags
);
558 spin_lock(&hcd_root_hub_lock
);
559 urb
= hcd
->status_urb
;
561 spin_lock(&urb
->lock
);
562 if (urb
->status
== -EINPROGRESS
) {
563 hcd
->poll_pending
= 0;
564 hcd
->status_urb
= NULL
;
567 urb
->actual_length
= length
;
568 memcpy(urb
->transfer_buffer
, buffer
, length
);
569 } else /* urb has been unlinked */
571 spin_unlock(&urb
->lock
);
574 spin_unlock(&hcd_root_hub_lock
);
576 /* local irqs are always blocked in completions */
578 usb_hcd_giveback_urb (hcd
, urb
);
580 hcd
->poll_pending
= 1;
581 local_irq_restore (flags
);
584 /* The USB 2.0 spec says 256 ms. This is close enough and won't
585 * exceed that limit if HZ is 100. The math is more clunky than
586 * maybe expected, this is to make sure that all timers for USB devices
587 * fire at the same time to give the CPU a break inbetween */
588 if (hcd
->uses_new_polling
? hcd
->poll_rh
:
589 (length
== 0 && hcd
->status_urb
!= NULL
))
590 mod_timer (&hcd
->rh_timer
, (jiffies
/(HZ
/4) + 1) * (HZ
/4));
592 EXPORT_SYMBOL_GPL(usb_hcd_poll_rh_status
);
595 static void rh_timer_func (unsigned long _hcd
)
597 usb_hcd_poll_rh_status((struct usb_hcd
*) _hcd
);
600 /*-------------------------------------------------------------------------*/
602 static int rh_queue_status (struct usb_hcd
*hcd
, struct urb
*urb
)
606 int len
= 1 + (urb
->dev
->maxchild
/ 8);
608 spin_lock_irqsave (&hcd_root_hub_lock
, flags
);
609 if (urb
->status
!= -EINPROGRESS
) /* already unlinked */
610 retval
= urb
->status
;
611 else if (hcd
->status_urb
|| urb
->transfer_buffer_length
< len
) {
612 dev_dbg (hcd
->self
.controller
, "not queuing rh status urb\n");
615 hcd
->status_urb
= urb
;
616 urb
->hcpriv
= hcd
; /* indicate it's queued */
618 if (!hcd
->uses_new_polling
)
619 mod_timer (&hcd
->rh_timer
,
620 (jiffies
/(HZ
/4) + 1) * (HZ
/4));
622 /* If a status change has already occurred, report it ASAP */
623 else if (hcd
->poll_pending
)
624 mod_timer (&hcd
->rh_timer
, jiffies
);
627 spin_unlock_irqrestore (&hcd_root_hub_lock
, flags
);
631 static int rh_urb_enqueue (struct usb_hcd
*hcd
, struct urb
*urb
)
633 if (usb_pipeint (urb
->pipe
))
634 return rh_queue_status (hcd
, urb
);
635 if (usb_pipecontrol (urb
->pipe
))
636 return rh_call_control (hcd
, urb
);
640 /*-------------------------------------------------------------------------*/
642 /* Unlinks of root-hub control URBs are legal, but they don't do anything
643 * since these URBs always execute synchronously.
645 static int usb_rh_urb_dequeue (struct usb_hcd
*hcd
, struct urb
*urb
)
649 if (usb_pipeendpoint(urb
->pipe
) == 0) { /* Control URB */
652 } else { /* Status URB */
653 if (!hcd
->uses_new_polling
)
654 del_timer (&hcd
->rh_timer
);
655 local_irq_save (flags
);
656 spin_lock (&hcd_root_hub_lock
);
657 if (urb
== hcd
->status_urb
) {
658 hcd
->status_urb
= NULL
;
661 urb
= NULL
; /* wasn't fully queued */
662 spin_unlock (&hcd_root_hub_lock
);
664 usb_hcd_giveback_urb (hcd
, urb
);
665 local_irq_restore (flags
);
671 /*-------------------------------------------------------------------------*/
673 static struct class *usb_host_class
;
675 int usb_host_init(void)
679 usb_host_class
= class_create(THIS_MODULE
, "usb_host");
680 if (IS_ERR(usb_host_class
))
681 retval
= PTR_ERR(usb_host_class
);
685 void usb_host_cleanup(void)
687 class_destroy(usb_host_class
);
691 * usb_bus_init - shared initialization code
692 * @bus: the bus structure being initialized
694 * This code is used to initialize a usb_bus structure, memory for which is
695 * separately managed.
697 static void usb_bus_init (struct usb_bus
*bus
)
699 memset (&bus
->devmap
, 0, sizeof(struct usb_devmap
));
701 bus
->devnum_next
= 1;
703 bus
->root_hub
= NULL
;
705 bus
->bandwidth_allocated
= 0;
706 bus
->bandwidth_int_reqs
= 0;
707 bus
->bandwidth_isoc_reqs
= 0;
709 INIT_LIST_HEAD (&bus
->bus_list
);
712 /*-------------------------------------------------------------------------*/
715 * usb_register_bus - registers the USB host controller with the usb core
716 * @bus: pointer to the bus to register
717 * Context: !in_interrupt()
719 * Assigns a bus number, and links the controller into usbcore data
720 * structures so that it can be seen by scanning the bus list.
722 static int usb_register_bus(struct usb_bus
*bus
)
726 mutex_lock(&usb_bus_list_lock
);
727 busnum
= find_next_zero_bit (busmap
.busmap
, USB_MAXBUS
, 1);
728 if (busnum
< USB_MAXBUS
) {
729 set_bit (busnum
, busmap
.busmap
);
730 bus
->busnum
= busnum
;
732 printk (KERN_ERR
"%s: too many buses\n", usbcore_name
);
733 mutex_unlock(&usb_bus_list_lock
);
737 bus
->class_dev
= class_device_create(usb_host_class
, NULL
, MKDEV(0,0),
738 bus
->controller
, "usb_host%d", busnum
);
739 if (IS_ERR(bus
->class_dev
)) {
740 clear_bit(busnum
, busmap
.busmap
);
741 mutex_unlock(&usb_bus_list_lock
);
742 return PTR_ERR(bus
->class_dev
);
745 class_set_devdata(bus
->class_dev
, bus
);
747 /* Add it to the local list of buses */
748 list_add (&bus
->bus_list
, &usb_bus_list
);
749 mutex_unlock(&usb_bus_list_lock
);
751 usb_notify_add_bus(bus
);
753 dev_info (bus
->controller
, "new USB bus registered, assigned bus number %d\n", bus
->busnum
);
758 * usb_deregister_bus - deregisters the USB host controller
759 * @bus: pointer to the bus to deregister
760 * Context: !in_interrupt()
762 * Recycles the bus number, and unlinks the controller from usbcore data
763 * structures so that it won't be seen by scanning the bus list.
765 static void usb_deregister_bus (struct usb_bus
*bus
)
767 dev_info (bus
->controller
, "USB bus %d deregistered\n", bus
->busnum
);
770 * NOTE: make sure that all the devices are removed by the
771 * controller code, as well as having it call this when cleaning
774 mutex_lock(&usb_bus_list_lock
);
775 list_del (&bus
->bus_list
);
776 mutex_unlock(&usb_bus_list_lock
);
778 usb_notify_remove_bus(bus
);
780 clear_bit (bus
->busnum
, busmap
.busmap
);
782 class_device_unregister(bus
->class_dev
);
786 * register_root_hub - called by usb_add_hcd() to register a root hub
787 * @hcd: host controller for this root hub
789 * This function registers the root hub with the USB subsystem. It sets up
790 * the device properly in the device tree and then calls usb_new_device()
791 * to register the usb device. It also assigns the root hub's USB address
794 static int register_root_hub(struct usb_hcd
*hcd
)
796 struct device
*parent_dev
= hcd
->self
.controller
;
797 struct usb_device
*usb_dev
= hcd
->self
.root_hub
;
798 const int devnum
= 1;
801 usb_dev
->devnum
= devnum
;
802 usb_dev
->bus
->devnum_next
= devnum
+ 1;
803 memset (&usb_dev
->bus
->devmap
.devicemap
, 0,
804 sizeof usb_dev
->bus
->devmap
.devicemap
);
805 set_bit (devnum
, usb_dev
->bus
->devmap
.devicemap
);
806 usb_set_device_state(usb_dev
, USB_STATE_ADDRESS
);
808 mutex_lock(&usb_bus_list_lock
);
810 usb_dev
->ep0
.desc
.wMaxPacketSize
= __constant_cpu_to_le16(64);
811 retval
= usb_get_device_descriptor(usb_dev
, USB_DT_DEVICE_SIZE
);
812 if (retval
!= sizeof usb_dev
->descriptor
) {
813 mutex_unlock(&usb_bus_list_lock
);
814 dev_dbg (parent_dev
, "can't read %s device descriptor %d\n",
815 usb_dev
->dev
.bus_id
, retval
);
816 return (retval
< 0) ? retval
: -EMSGSIZE
;
819 retval
= usb_new_device (usb_dev
);
821 dev_err (parent_dev
, "can't register root hub for %s, %d\n",
822 usb_dev
->dev
.bus_id
, retval
);
824 mutex_unlock(&usb_bus_list_lock
);
827 spin_lock_irq (&hcd_root_hub_lock
);
828 hcd
->rh_registered
= 1;
829 spin_unlock_irq (&hcd_root_hub_lock
);
831 /* Did the HC die before the root hub was registered? */
832 if (hcd
->state
== HC_STATE_HALT
)
833 usb_hc_died (hcd
); /* This time clean up */
839 void usb_enable_root_hub_irq (struct usb_bus
*bus
)
843 hcd
= container_of (bus
, struct usb_hcd
, self
);
844 if (hcd
->driver
->hub_irq_enable
&& hcd
->state
!= HC_STATE_HALT
)
845 hcd
->driver
->hub_irq_enable (hcd
);
849 /*-------------------------------------------------------------------------*/
852 * usb_calc_bus_time - approximate periodic transaction time in nanoseconds
853 * @speed: from dev->speed; USB_SPEED_{LOW,FULL,HIGH}
854 * @is_input: true iff the transaction sends data to the host
855 * @isoc: true for isochronous transactions, false for interrupt ones
856 * @bytecount: how many bytes in the transaction.
858 * Returns approximate bus time in nanoseconds for a periodic transaction.
859 * See USB 2.0 spec section 5.11.3; only periodic transfers need to be
860 * scheduled in software, this function is only used for such scheduling.
862 long usb_calc_bus_time (int speed
, int is_input
, int isoc
, int bytecount
)
867 case USB_SPEED_LOW
: /* INTR only */
869 tmp
= (67667L * (31L + 10L * BitTime (bytecount
))) / 1000L;
870 return (64060L + (2 * BW_HUB_LS_SETUP
) + BW_HOST_DELAY
+ tmp
);
872 tmp
= (66700L * (31L + 10L * BitTime (bytecount
))) / 1000L;
873 return (64107L + (2 * BW_HUB_LS_SETUP
) + BW_HOST_DELAY
+ tmp
);
875 case USB_SPEED_FULL
: /* ISOC or INTR */
877 tmp
= (8354L * (31L + 10L * BitTime (bytecount
))) / 1000L;
878 return (((is_input
) ? 7268L : 6265L) + BW_HOST_DELAY
+ tmp
);
880 tmp
= (8354L * (31L + 10L * BitTime (bytecount
))) / 1000L;
881 return (9107L + BW_HOST_DELAY
+ tmp
);
883 case USB_SPEED_HIGH
: /* ISOC or INTR */
884 // FIXME adjust for input vs output
886 tmp
= HS_NSECS_ISO (bytecount
);
888 tmp
= HS_NSECS (bytecount
);
891 pr_debug ("%s: bogus device speed!\n", usbcore_name
);
895 EXPORT_SYMBOL (usb_calc_bus_time
);
898 /*-------------------------------------------------------------------------*/
901 * Generic HC operations.
904 /*-------------------------------------------------------------------------*/
906 static void urb_unlink (struct urb
*urb
)
910 /* clear all state linking urb to this dev (and hcd) */
912 spin_lock_irqsave (&hcd_data_lock
, flags
);
913 list_del_init (&urb
->urb_list
);
914 spin_unlock_irqrestore (&hcd_data_lock
, flags
);
918 /* may be called in any context with a valid urb->dev usecount
919 * caller surrenders "ownership" of urb
920 * expects usb_submit_urb() to have sanity checked and conditioned all
923 int usb_hcd_submit_urb (struct urb
*urb
, gfp_t mem_flags
)
926 struct usb_hcd
*hcd
= bus_to_hcd(urb
->dev
->bus
);
927 struct usb_host_endpoint
*ep
;
933 usbmon_urb_submit(&hcd
->self
, urb
);
936 * Atomically queue the urb, first to our records, then to the HCD.
937 * Access to urb->status is controlled by urb->lock ... changes on
938 * i/o completion (normal or fault) or unlinking.
941 // FIXME: verify that quiescing hc works right (RH cleans up)
943 spin_lock_irqsave (&hcd_data_lock
, flags
);
944 ep
= (usb_pipein(urb
->pipe
) ? urb
->dev
->ep_in
: urb
->dev
->ep_out
)
945 [usb_pipeendpoint(urb
->pipe
)];
948 else if (unlikely (urb
->reject
))
950 else switch (hcd
->state
) {
951 case HC_STATE_RUNNING
:
952 case HC_STATE_RESUMING
:
954 list_add_tail (&urb
->urb_list
, &ep
->urb_list
);
957 case HC_STATE_SUSPENDED
:
958 /* HC upstream links (register access, wakeup signaling) can work
959 * even when the downstream links (and DMA etc) are quiesced; let
960 * usbcore talk to the root hub.
962 if (hcd
->self
.controller
->power
.power_state
.event
== PM_EVENT_ON
963 && urb
->dev
->parent
== NULL
)
970 spin_unlock_irqrestore (&hcd_data_lock
, flags
);
972 INIT_LIST_HEAD (&urb
->urb_list
);
973 usbmon_urb_submit_error(&hcd
->self
, urb
, status
);
977 /* increment urb's reference count as part of giving it to the HCD
978 * (which now controls it). HCD guarantees that it either returns
979 * an error or calls giveback(), but not both.
981 urb
= usb_get_urb (urb
);
982 atomic_inc (&urb
->use_count
);
984 if (urb
->dev
== hcd
->self
.root_hub
) {
985 /* NOTE: requirement on hub callers (usbfs and the hub
986 * driver, for now) that URBs' urb->transfer_buffer be
987 * valid and usb_buffer_{sync,unmap}() not be needed, since
988 * they could clobber root hub response data.
990 status
= rh_urb_enqueue (hcd
, urb
);
994 /* lower level hcd code should use *_dma exclusively,
995 * unless it uses pio or talks to another transport.
997 if (hcd
->self
.uses_dma
) {
998 if (usb_pipecontrol (urb
->pipe
)
999 && !(urb
->transfer_flags
& URB_NO_SETUP_DMA_MAP
))
1000 urb
->setup_dma
= dma_map_single (
1001 hcd
->self
.controller
,
1003 sizeof (struct usb_ctrlrequest
),
1005 if (urb
->transfer_buffer_length
!= 0
1006 && !(urb
->transfer_flags
& URB_NO_TRANSFER_DMA_MAP
))
1007 urb
->transfer_dma
= dma_map_single (
1008 hcd
->self
.controller
,
1009 urb
->transfer_buffer
,
1010 urb
->transfer_buffer_length
,
1011 usb_pipein (urb
->pipe
)
1016 status
= hcd
->driver
->urb_enqueue (hcd
, ep
, urb
, mem_flags
);
1018 if (unlikely (status
)) {
1020 atomic_dec (&urb
->use_count
);
1022 wake_up (&usb_kill_urb_queue
);
1023 usbmon_urb_submit_error(&hcd
->self
, urb
, status
);
1029 /*-------------------------------------------------------------------------*/
1031 /* called in any context */
1032 int usb_hcd_get_frame_number (struct usb_device
*udev
)
1034 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
1036 if (!HC_IS_RUNNING (hcd
->state
))
1038 return hcd
->driver
->get_frame_number (hcd
);
1041 /*-------------------------------------------------------------------------*/
1043 /* this makes the hcd giveback() the urb more quickly, by kicking it
1044 * off hardware queues (which may take a while) and returning it as
1045 * soon as practical. we've already set up the urb's return status,
1046 * but we can't know if the callback completed already.
1049 unlink1 (struct usb_hcd
*hcd
, struct urb
*urb
)
1053 if (urb
->dev
== hcd
->self
.root_hub
)
1054 value
= usb_rh_urb_dequeue (hcd
, urb
);
1057 /* The only reason an HCD might fail this call is if
1058 * it has not yet fully queued the urb to begin with.
1059 * Such failures should be harmless. */
1060 value
= hcd
->driver
->urb_dequeue (hcd
, urb
);
1064 dev_dbg (hcd
->self
.controller
, "dequeue %p --> %d\n",
1070 * called in any context
1072 * caller guarantees urb won't be recycled till both unlink()
1073 * and the urb's completion function return
1075 int usb_hcd_unlink_urb (struct urb
*urb
, int status
)
1077 struct usb_host_endpoint
*ep
;
1078 struct usb_hcd
*hcd
= NULL
;
1079 struct device
*sys
= NULL
;
1080 unsigned long flags
;
1081 struct list_head
*tmp
;
1086 if (!urb
->dev
|| !urb
->dev
->bus
)
1088 ep
= (usb_pipein(urb
->pipe
) ? urb
->dev
->ep_in
: urb
->dev
->ep_out
)
1089 [usb_pipeendpoint(urb
->pipe
)];
1094 * we contend for urb->status with the hcd core,
1095 * which changes it while returning the urb.
1097 * Caller guaranteed that the urb pointer hasn't been freed, and
1098 * that it was submitted. But as a rule it can't know whether or
1099 * not it's already been unlinked ... so we respect the reversed
1100 * lock sequence needed for the usb_hcd_giveback_urb() code paths
1101 * (urb lock, then hcd_data_lock) in case some other CPU is now
1104 spin_lock_irqsave (&urb
->lock
, flags
);
1105 spin_lock (&hcd_data_lock
);
1107 sys
= &urb
->dev
->dev
;
1108 hcd
= bus_to_hcd(urb
->dev
->bus
);
1114 /* insist the urb is still queued */
1115 list_for_each(tmp
, &ep
->urb_list
) {
1116 if (tmp
== &urb
->urb_list
)
1119 if (tmp
!= &urb
->urb_list
) {
1124 /* Any status except -EINPROGRESS means something already started to
1125 * unlink this URB from the hardware. So there's no more work to do.
1127 if (urb
->status
!= -EINPROGRESS
) {
1132 /* IRQ setup can easily be broken so that USB controllers
1133 * never get completion IRQs ... maybe even the ones we need to
1134 * finish unlinking the initial failed usb_set_address()
1135 * or device descriptor fetch.
1137 if (!test_bit(HCD_FLAG_SAW_IRQ
, &hcd
->flags
)
1138 && hcd
->self
.root_hub
!= urb
->dev
) {
1139 dev_warn (hcd
->self
.controller
, "Unlink after no-IRQ? "
1140 "Controller is probably using the wrong IRQ."
1142 set_bit(HCD_FLAG_SAW_IRQ
, &hcd
->flags
);
1145 urb
->status
= status
;
1147 spin_unlock (&hcd_data_lock
);
1148 spin_unlock_irqrestore (&urb
->lock
, flags
);
1150 retval
= unlink1 (hcd
, urb
);
1152 retval
= -EINPROGRESS
;
1156 spin_unlock (&hcd_data_lock
);
1157 spin_unlock_irqrestore (&urb
->lock
, flags
);
1158 if (retval
!= -EIDRM
&& sys
&& sys
->driver
)
1159 dev_dbg (sys
, "hcd_unlink_urb %p fail %d\n", urb
, retval
);
1163 /*-------------------------------------------------------------------------*/
1165 /* disables the endpoint: cancels any pending urbs, then synchronizes with
1166 * the hcd to make sure all endpoint state is gone from hardware, and then
1167 * waits until the endpoint's queue is completely drained. use for
1168 * set_configuration, set_interface, driver removal, physical disconnect.
1170 * example: a qh stored in ep->hcpriv, holding state related to endpoint
1171 * type, maxpacket size, toggle, halt status, and scheduling.
1173 void usb_hcd_endpoint_disable (struct usb_device
*udev
,
1174 struct usb_host_endpoint
*ep
)
1176 struct usb_hcd
*hcd
;
1179 hcd
= bus_to_hcd(udev
->bus
);
1180 local_irq_disable ();
1182 /* ep is already gone from udev->ep_{in,out}[]; no more submits */
1184 spin_lock (&hcd_data_lock
);
1185 list_for_each_entry (urb
, &ep
->urb_list
, urb_list
) {
1188 /* the urb may already have been unlinked */
1189 if (urb
->status
!= -EINPROGRESS
)
1192 spin_unlock (&hcd_data_lock
);
1194 spin_lock (&urb
->lock
);
1196 if (tmp
== -EINPROGRESS
)
1197 urb
->status
= -ESHUTDOWN
;
1198 spin_unlock (&urb
->lock
);
1200 /* kick hcd unless it's already returning this */
1201 if (tmp
== -EINPROGRESS
) {
1204 dev_dbg (hcd
->self
.controller
,
1205 "shutdown urb %p pipe %08x ep%d%s%s\n",
1206 urb
, tmp
, usb_pipeendpoint (tmp
),
1207 (tmp
& USB_DIR_IN
) ? "in" : "out",
1209 switch (usb_pipetype (tmp
)) { \
1210 case PIPE_CONTROL
: s
= ""; break; \
1211 case PIPE_BULK
: s
= "-bulk"; break; \
1212 case PIPE_INTERRUPT
: s
= "-intr"; break; \
1213 default: s
= "-iso"; break; \
1218 /* list contents may have changed */
1221 spin_unlock (&hcd_data_lock
);
1222 local_irq_enable ();
1224 /* synchronize with the hardware, so old configuration state
1225 * clears out immediately (and will be freed).
1228 if (hcd
->driver
->endpoint_disable
)
1229 hcd
->driver
->endpoint_disable (hcd
, ep
);
1231 /* Wait until the endpoint queue is completely empty. Most HCDs
1232 * will have done this already in their endpoint_disable method,
1233 * but some might not. And there could be root-hub control URBs
1234 * still pending since they aren't affected by the HCDs'
1235 * endpoint_disable methods.
1237 while (!list_empty (&ep
->urb_list
)) {
1238 spin_lock_irq (&hcd_data_lock
);
1240 /* The list may have changed while we acquired the spinlock */
1242 if (!list_empty (&ep
->urb_list
)) {
1243 urb
= list_entry (ep
->urb_list
.prev
, struct urb
,
1247 spin_unlock_irq (&hcd_data_lock
);
1256 /*-------------------------------------------------------------------------*/
1260 int hcd_bus_suspend (struct usb_bus
*bus
)
1262 struct usb_hcd
*hcd
;
1265 hcd
= container_of (bus
, struct usb_hcd
, self
);
1266 if (!hcd
->driver
->bus_suspend
)
1268 hcd
->state
= HC_STATE_QUIESCING
;
1269 status
= hcd
->driver
->bus_suspend (hcd
);
1271 hcd
->state
= HC_STATE_SUSPENDED
;
1273 dev_dbg(&bus
->root_hub
->dev
, "%s fail, err %d\n",
1278 int hcd_bus_resume (struct usb_bus
*bus
)
1280 struct usb_hcd
*hcd
;
1283 hcd
= container_of (bus
, struct usb_hcd
, self
);
1284 if (!hcd
->driver
->bus_resume
)
1286 if (hcd
->state
== HC_STATE_RUNNING
)
1288 hcd
->state
= HC_STATE_RESUMING
;
1289 status
= hcd
->driver
->bus_resume (hcd
);
1291 hcd
->state
= HC_STATE_RUNNING
;
1293 dev_dbg(&bus
->root_hub
->dev
, "%s fail, err %d\n",
1300 /* Workqueue routine for root-hub remote wakeup */
1301 static void hcd_resume_work(struct work_struct
*work
)
1303 struct usb_hcd
*hcd
= container_of(work
, struct usb_hcd
, wakeup_work
);
1304 struct usb_device
*udev
= hcd
->self
.root_hub
;
1306 usb_lock_device(udev
);
1307 usb_mark_last_busy(udev
);
1308 usb_external_resume_device(udev
);
1309 usb_unlock_device(udev
);
1313 * usb_hcd_resume_root_hub - called by HCD to resume its root hub
1314 * @hcd: host controller for this root hub
1316 * The USB host controller calls this function when its root hub is
1317 * suspended (with the remote wakeup feature enabled) and a remote
1318 * wakeup request is received. The routine submits a workqueue request
1319 * to resume the root hub (that is, manage its downstream ports again).
1321 void usb_hcd_resume_root_hub (struct usb_hcd
*hcd
)
1323 unsigned long flags
;
1325 spin_lock_irqsave (&hcd_root_hub_lock
, flags
);
1326 if (hcd
->rh_registered
)
1327 queue_work(ksuspend_usb_wq
, &hcd
->wakeup_work
);
1328 spin_unlock_irqrestore (&hcd_root_hub_lock
, flags
);
1330 EXPORT_SYMBOL_GPL(usb_hcd_resume_root_hub
);
1334 /*-------------------------------------------------------------------------*/
1336 #ifdef CONFIG_USB_OTG
1339 * usb_bus_start_enum - start immediate enumeration (for OTG)
1340 * @bus: the bus (must use hcd framework)
1341 * @port_num: 1-based number of port; usually bus->otg_port
1342 * Context: in_interrupt()
1344 * Starts enumeration, with an immediate reset followed later by
1345 * khubd identifying and possibly configuring the device.
1346 * This is needed by OTG controller drivers, where it helps meet
1347 * HNP protocol timing requirements for starting a port reset.
1349 int usb_bus_start_enum(struct usb_bus
*bus
, unsigned port_num
)
1351 struct usb_hcd
*hcd
;
1352 int status
= -EOPNOTSUPP
;
1354 /* NOTE: since HNP can't start by grabbing the bus's address0_sem,
1355 * boards with root hubs hooked up to internal devices (instead of
1356 * just the OTG port) may need more attention to resetting...
1358 hcd
= container_of (bus
, struct usb_hcd
, self
);
1359 if (port_num
&& hcd
->driver
->start_port_reset
)
1360 status
= hcd
->driver
->start_port_reset(hcd
, port_num
);
1362 /* run khubd shortly after (first) root port reset finishes;
1363 * it may issue others, until at least 50 msecs have passed.
1366 mod_timer(&hcd
->rh_timer
, jiffies
+ msecs_to_jiffies(10));
1369 EXPORT_SYMBOL (usb_bus_start_enum
);
1373 /*-------------------------------------------------------------------------*/
1376 * usb_hcd_giveback_urb - return URB from HCD to device driver
1377 * @hcd: host controller returning the URB
1378 * @urb: urb being returned to the USB device driver.
1379 * Context: in_interrupt()
1381 * This hands the URB from HCD to its USB device driver, using its
1382 * completion function. The HCD has freed all per-urb resources
1383 * (and is done using urb->hcpriv). It also released all HCD locks;
1384 * the device driver won't cause problems if it frees, modifies,
1385 * or resubmits this URB.
1387 void usb_hcd_giveback_urb (struct usb_hcd
*hcd
, struct urb
*urb
)
1391 at_root_hub
= (urb
->dev
== hcd
->self
.root_hub
);
1394 /* lower level hcd code should use *_dma exclusively if the
1395 * host controller does DMA */
1396 if (hcd
->self
.uses_dma
&& !at_root_hub
) {
1397 if (usb_pipecontrol (urb
->pipe
)
1398 && !(urb
->transfer_flags
& URB_NO_SETUP_DMA_MAP
))
1399 dma_unmap_single (hcd
->self
.controller
, urb
->setup_dma
,
1400 sizeof (struct usb_ctrlrequest
),
1402 if (urb
->transfer_buffer_length
!= 0
1403 && !(urb
->transfer_flags
& URB_NO_TRANSFER_DMA_MAP
))
1404 dma_unmap_single (hcd
->self
.controller
,
1406 urb
->transfer_buffer_length
,
1407 usb_pipein (urb
->pipe
)
1412 usbmon_urb_complete (&hcd
->self
, urb
);
1413 /* pass ownership to the completion handler */
1414 urb
->complete (urb
);
1415 atomic_dec (&urb
->use_count
);
1416 if (unlikely (urb
->reject
))
1417 wake_up (&usb_kill_urb_queue
);
1420 EXPORT_SYMBOL (usb_hcd_giveback_urb
);
1422 /*-------------------------------------------------------------------------*/
1425 * usb_hcd_irq - hook IRQs to HCD framework (bus glue)
1426 * @irq: the IRQ being raised
1427 * @__hcd: pointer to the HCD whose IRQ is being signaled
1428 * @r: saved hardware registers
1430 * If the controller isn't HALTed, calls the driver's irq handler.
1431 * Checks whether the controller is now dead.
1433 irqreturn_t
usb_hcd_irq (int irq
, void *__hcd
)
1435 struct usb_hcd
*hcd
= __hcd
;
1436 int start
= hcd
->state
;
1438 if (unlikely(start
== HC_STATE_HALT
||
1439 !test_bit(HCD_FLAG_HW_ACCESSIBLE
, &hcd
->flags
)))
1441 if (hcd
->driver
->irq (hcd
) == IRQ_NONE
)
1444 set_bit(HCD_FLAG_SAW_IRQ
, &hcd
->flags
);
1446 if (unlikely(hcd
->state
== HC_STATE_HALT
))
1451 /*-------------------------------------------------------------------------*/
1454 * usb_hc_died - report abnormal shutdown of a host controller (bus glue)
1455 * @hcd: pointer to the HCD representing the controller
1457 * This is called by bus glue to report a USB host controller that died
1458 * while operations may still have been pending. It's called automatically
1459 * by the PCI glue, so only glue for non-PCI busses should need to call it.
1461 void usb_hc_died (struct usb_hcd
*hcd
)
1463 unsigned long flags
;
1465 dev_err (hcd
->self
.controller
, "HC died; cleaning up\n");
1467 spin_lock_irqsave (&hcd_root_hub_lock
, flags
);
1468 if (hcd
->rh_registered
) {
1471 /* make khubd clean up old urbs and devices */
1472 usb_set_device_state (hcd
->self
.root_hub
,
1473 USB_STATE_NOTATTACHED
);
1474 usb_kick_khubd (hcd
->self
.root_hub
);
1476 spin_unlock_irqrestore (&hcd_root_hub_lock
, flags
);
1478 EXPORT_SYMBOL_GPL (usb_hc_died
);
1480 /*-------------------------------------------------------------------------*/
1483 * usb_create_hcd - create and initialize an HCD structure
1484 * @driver: HC driver that will use this hcd
1485 * @dev: device for this HC, stored in hcd->self.controller
1486 * @bus_name: value to store in hcd->self.bus_name
1487 * Context: !in_interrupt()
1489 * Allocate a struct usb_hcd, with extra space at the end for the
1490 * HC driver's private data. Initialize the generic members of the
1493 * If memory is unavailable, returns NULL.
1495 struct usb_hcd
*usb_create_hcd (const struct hc_driver
*driver
,
1496 struct device
*dev
, char *bus_name
)
1498 struct usb_hcd
*hcd
;
1500 hcd
= kzalloc(sizeof(*hcd
) + driver
->hcd_priv_size
, GFP_KERNEL
);
1502 dev_dbg (dev
, "hcd alloc failed\n");
1505 dev_set_drvdata(dev
, hcd
);
1506 kref_init(&hcd
->kref
);
1508 usb_bus_init(&hcd
->self
);
1509 hcd
->self
.controller
= dev
;
1510 hcd
->self
.bus_name
= bus_name
;
1511 hcd
->self
.uses_dma
= (dev
->dma_mask
!= NULL
);
1513 init_timer(&hcd
->rh_timer
);
1514 hcd
->rh_timer
.function
= rh_timer_func
;
1515 hcd
->rh_timer
.data
= (unsigned long) hcd
;
1517 INIT_WORK(&hcd
->wakeup_work
, hcd_resume_work
);
1520 hcd
->driver
= driver
;
1521 hcd
->product_desc
= (driver
->product_desc
) ? driver
->product_desc
:
1522 "USB Host Controller";
1526 EXPORT_SYMBOL (usb_create_hcd
);
1528 static void hcd_release (struct kref
*kref
)
1530 struct usb_hcd
*hcd
= container_of (kref
, struct usb_hcd
, kref
);
1535 struct usb_hcd
*usb_get_hcd (struct usb_hcd
*hcd
)
1538 kref_get (&hcd
->kref
);
1541 EXPORT_SYMBOL (usb_get_hcd
);
1543 void usb_put_hcd (struct usb_hcd
*hcd
)
1546 kref_put (&hcd
->kref
, hcd_release
);
1548 EXPORT_SYMBOL (usb_put_hcd
);
1551 * usb_add_hcd - finish generic HCD structure initialization and register
1552 * @hcd: the usb_hcd structure to initialize
1553 * @irqnum: Interrupt line to allocate
1554 * @irqflags: Interrupt type flags
1556 * Finish the remaining parts of generic HCD initialization: allocate the
1557 * buffers of consistent memory, register the bus, request the IRQ line,
1558 * and call the driver's reset() and start() routines.
1560 int usb_add_hcd(struct usb_hcd
*hcd
,
1561 unsigned int irqnum
, unsigned long irqflags
)
1564 struct usb_device
*rhdev
;
1566 dev_info(hcd
->self
.controller
, "%s\n", hcd
->product_desc
);
1568 set_bit(HCD_FLAG_HW_ACCESSIBLE
, &hcd
->flags
);
1570 /* HC is in reset state, but accessible. Now do the one-time init,
1571 * bottom up so that hcds can customize the root hubs before khubd
1572 * starts talking to them. (Note, bus id is assigned early too.)
1574 if ((retval
= hcd_buffer_create(hcd
)) != 0) {
1575 dev_dbg(hcd
->self
.controller
, "pool alloc failed\n");
1579 if ((retval
= usb_register_bus(&hcd
->self
)) < 0)
1580 goto err_register_bus
;
1582 if ((rhdev
= usb_alloc_dev(NULL
, &hcd
->self
, 0)) == NULL
) {
1583 dev_err(hcd
->self
.controller
, "unable to allocate root hub\n");
1585 goto err_allocate_root_hub
;
1587 rhdev
->speed
= (hcd
->driver
->flags
& HCD_USB2
) ? USB_SPEED_HIGH
:
1589 hcd
->self
.root_hub
= rhdev
;
1591 /* wakeup flag init defaults to "everything works" for root hubs,
1592 * but drivers can override it in reset() if needed, along with
1593 * recording the overall controller's system wakeup capability.
1595 device_init_wakeup(&rhdev
->dev
, 1);
1597 /* "reset" is misnamed; its role is now one-time init. the controller
1598 * should already have been reset (and boot firmware kicked off etc).
1600 if (hcd
->driver
->reset
&& (retval
= hcd
->driver
->reset(hcd
)) < 0) {
1601 dev_err(hcd
->self
.controller
, "can't setup\n");
1602 goto err_hcd_driver_setup
;
1605 /* NOTE: root hub and controller capabilities may not be the same */
1606 if (device_can_wakeup(hcd
->self
.controller
)
1607 && device_can_wakeup(&hcd
->self
.root_hub
->dev
))
1608 dev_dbg(hcd
->self
.controller
, "supports USB remote wakeup\n");
1610 /* enable irqs just before we start the controller */
1611 if (hcd
->driver
->irq
) {
1612 snprintf(hcd
->irq_descr
, sizeof(hcd
->irq_descr
), "%s:usb%d",
1613 hcd
->driver
->description
, hcd
->self
.busnum
);
1614 if ((retval
= request_irq(irqnum
, &usb_hcd_irq
, irqflags
,
1615 hcd
->irq_descr
, hcd
)) != 0) {
1616 dev_err(hcd
->self
.controller
,
1617 "request interrupt %d failed\n", irqnum
);
1618 goto err_request_irq
;
1621 dev_info(hcd
->self
.controller
, "irq %d, %s 0x%08llx\n", irqnum
,
1622 (hcd
->driver
->flags
& HCD_MEMORY
) ?
1623 "io mem" : "io base",
1624 (unsigned long long)hcd
->rsrc_start
);
1627 if (hcd
->rsrc_start
)
1628 dev_info(hcd
->self
.controller
, "%s 0x%08llx\n",
1629 (hcd
->driver
->flags
& HCD_MEMORY
) ?
1630 "io mem" : "io base",
1631 (unsigned long long)hcd
->rsrc_start
);
1634 if ((retval
= hcd
->driver
->start(hcd
)) < 0) {
1635 dev_err(hcd
->self
.controller
, "startup error %d\n", retval
);
1636 goto err_hcd_driver_start
;
1639 /* starting here, usbcore will pay attention to this root hub */
1640 rhdev
->bus_mA
= min(500u, hcd
->power_budget
);
1641 if ((retval
= register_root_hub(hcd
)) != 0)
1642 goto err_register_root_hub
;
1644 if (hcd
->uses_new_polling
&& hcd
->poll_rh
)
1645 usb_hcd_poll_rh_status(hcd
);
1648 err_register_root_hub
:
1649 hcd
->driver
->stop(hcd
);
1650 err_hcd_driver_start
:
1652 free_irq(irqnum
, hcd
);
1654 err_hcd_driver_setup
:
1655 hcd
->self
.root_hub
= NULL
;
1657 err_allocate_root_hub
:
1658 usb_deregister_bus(&hcd
->self
);
1660 hcd_buffer_destroy(hcd
);
1663 EXPORT_SYMBOL (usb_add_hcd
);
1666 * usb_remove_hcd - shutdown processing for generic HCDs
1667 * @hcd: the usb_hcd structure to remove
1668 * Context: !in_interrupt()
1670 * Disconnects the root hub, then reverses the effects of usb_add_hcd(),
1671 * invoking the HCD's stop() method.
1673 void usb_remove_hcd(struct usb_hcd
*hcd
)
1675 dev_info(hcd
->self
.controller
, "remove, state %x\n", hcd
->state
);
1677 if (HC_IS_RUNNING (hcd
->state
))
1678 hcd
->state
= HC_STATE_QUIESCING
;
1680 dev_dbg(hcd
->self
.controller
, "roothub graceful disconnect\n");
1681 spin_lock_irq (&hcd_root_hub_lock
);
1682 hcd
->rh_registered
= 0;
1683 spin_unlock_irq (&hcd_root_hub_lock
);
1686 cancel_work_sync(&hcd
->wakeup_work
);
1689 mutex_lock(&usb_bus_list_lock
);
1690 usb_disconnect(&hcd
->self
.root_hub
);
1691 mutex_unlock(&usb_bus_list_lock
);
1693 hcd
->driver
->stop(hcd
);
1694 hcd
->state
= HC_STATE_HALT
;
1697 del_timer_sync(&hcd
->rh_timer
);
1700 free_irq(hcd
->irq
, hcd
);
1701 usb_deregister_bus(&hcd
->self
);
1702 hcd_buffer_destroy(hcd
);
1704 EXPORT_SYMBOL (usb_remove_hcd
);
1707 usb_hcd_platform_shutdown(struct platform_device
* dev
)
1709 struct usb_hcd
*hcd
= platform_get_drvdata(dev
);
1711 if (hcd
->driver
->shutdown
)
1712 hcd
->driver
->shutdown(hcd
);
1714 EXPORT_SYMBOL (usb_hcd_platform_shutdown
);
1716 /*-------------------------------------------------------------------------*/
1718 #if defined(CONFIG_USB_MON)
1720 struct usb_mon_operations
*mon_ops
;
1723 * The registration is unlocked.
1724 * We do it this way because we do not want to lock in hot paths.
1726 * Notice that the code is minimally error-proof. Because usbmon needs
1727 * symbols from usbcore, usbcore gets referenced and cannot be unloaded first.
1730 int usb_mon_register (struct usb_mon_operations
*ops
)
1740 EXPORT_SYMBOL_GPL (usb_mon_register
);
1742 void usb_mon_deregister (void)
1745 if (mon_ops
== NULL
) {
1746 printk(KERN_ERR
"USB: monitor was not registered\n");
1752 EXPORT_SYMBOL_GPL (usb_mon_deregister
);
1754 #endif /* CONFIG_USB_MON */