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 an endpoint's URB list */
103 static DEFINE_SPINLOCK(hcd_urb_list_lock
);
105 /* wait queue for synchronous unlinks */
106 DECLARE_WAIT_QUEUE_HEAD(usb_kill_urb_queue
);
108 static inline int is_root_hub(struct usb_device
*udev
)
110 return (udev
->parent
== NULL
);
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 0x40, /* __u8 bMaxPacketSize0; 64 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 0x40, /* __u8 bMaxPacketSize0; 64 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 /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8)
264 * see hub.c:hub_configure() for details. */
265 (USB_MAXCHILDREN
+ 1 + 7) / 8, 0x00,
266 0x0c /* __u8 ep_bInterval; (256ms -- usb 2.0 spec) */
269 /*-------------------------------------------------------------------------*/
272 * helper routine for returning string descriptors in UTF-16LE
273 * input can actually be ISO-8859-1; ASCII is its 7-bit subset
275 static int ascii2utf (char *s
, u8
*utf
, int utfmax
)
279 for (retval
= 0; *s
&& utfmax
> 1; utfmax
-= 2, retval
+= 2) {
291 * rh_string - provides manufacturer, product and serial strings for root hub
292 * @id: the string ID number (1: serial number, 2: product, 3: vendor)
293 * @hcd: the host controller for this root hub
294 * @type: string describing our driver
295 * @data: return packet in UTF-16 LE
296 * @len: length of the return packet
298 * Produces either a manufacturer, product or serial number string for the
299 * virtual root hub device.
301 static int rh_string (
311 buf
[0] = 4; buf
[1] = 3; /* 4 bytes string data */
312 buf
[2] = 0x09; buf
[3] = 0x04; /* MSFT-speak for "en-us" */
314 memcpy (data
, buf
, len
);
318 } else if (id
== 1) {
319 strlcpy (buf
, hcd
->self
.bus_name
, sizeof buf
);
321 // product description
322 } else if (id
== 2) {
323 strlcpy (buf
, hcd
->product_desc
, sizeof buf
);
325 // id 3 == vendor description
326 } else if (id
== 3) {
327 snprintf (buf
, sizeof buf
, "%s %s %s", init_utsname()->sysname
,
328 init_utsname()->release
, hcd
->driver
->description
);
330 // unsupported IDs --> "protocol stall"
334 switch (len
) { /* All cases fall through */
336 len
= 2 + ascii2utf (buf
, data
+ 2, len
- 2);
338 data
[1] = 3; /* type == string */
340 data
[0] = 2 * (strlen (buf
) + 1);
342 ; /* Compiler wants a statement here */
348 /* Root hub control transfers execute synchronously */
349 static int rh_call_control (struct usb_hcd
*hcd
, struct urb
*urb
)
351 struct usb_ctrlrequest
*cmd
;
352 u16 typeReq
, wValue
, wIndex
, wLength
;
353 u8
*ubuf
= urb
->transfer_buffer
;
354 u8 tbuf
[sizeof (struct usb_hub_descriptor
)]
355 __attribute__((aligned(4)));
356 const u8
*bufp
= tbuf
;
358 int patch_wakeup
= 0;
363 cmd
= (struct usb_ctrlrequest
*) urb
->setup_packet
;
364 typeReq
= (cmd
->bRequestType
<< 8) | cmd
->bRequest
;
365 wValue
= le16_to_cpu (cmd
->wValue
);
366 wIndex
= le16_to_cpu (cmd
->wIndex
);
367 wLength
= le16_to_cpu (cmd
->wLength
);
369 if (wLength
> urb
->transfer_buffer_length
)
372 urb
->actual_length
= 0;
375 /* DEVICE REQUESTS */
377 /* The root hub's remote wakeup enable bit is implemented using
378 * driver model wakeup flags. If this system supports wakeup
379 * through USB, userspace may change the default "allow wakeup"
380 * policy through sysfs or these calls.
382 * Most root hubs support wakeup from downstream devices, for
383 * runtime power management (disabling USB clocks and reducing
384 * VBUS power usage). However, not all of them do so; silicon,
385 * board, and BIOS bugs here are not uncommon, so these can't
386 * be treated quite like external hubs.
388 * Likewise, not all root hubs will pass wakeup events upstream,
389 * to wake up the whole system. So don't assume root hub and
390 * controller capabilities are identical.
393 case DeviceRequest
| USB_REQ_GET_STATUS
:
394 tbuf
[0] = (device_may_wakeup(&hcd
->self
.root_hub
->dev
)
395 << USB_DEVICE_REMOTE_WAKEUP
)
396 | (1 << USB_DEVICE_SELF_POWERED
);
400 case DeviceOutRequest
| USB_REQ_CLEAR_FEATURE
:
401 if (wValue
== USB_DEVICE_REMOTE_WAKEUP
)
402 device_set_wakeup_enable(&hcd
->self
.root_hub
->dev
, 0);
406 case DeviceOutRequest
| USB_REQ_SET_FEATURE
:
407 if (device_can_wakeup(&hcd
->self
.root_hub
->dev
)
408 && wValue
== USB_DEVICE_REMOTE_WAKEUP
)
409 device_set_wakeup_enable(&hcd
->self
.root_hub
->dev
, 1);
413 case DeviceRequest
| USB_REQ_GET_CONFIGURATION
:
417 case DeviceOutRequest
| USB_REQ_SET_CONFIGURATION
:
419 case DeviceRequest
| USB_REQ_GET_DESCRIPTOR
:
420 switch (wValue
& 0xff00) {
421 case USB_DT_DEVICE
<< 8:
422 if (hcd
->driver
->flags
& HCD_USB2
)
423 bufp
= usb2_rh_dev_descriptor
;
424 else if (hcd
->driver
->flags
& HCD_USB11
)
425 bufp
= usb11_rh_dev_descriptor
;
430 case USB_DT_CONFIG
<< 8:
431 if (hcd
->driver
->flags
& HCD_USB2
) {
432 bufp
= hs_rh_config_descriptor
;
433 len
= sizeof hs_rh_config_descriptor
;
435 bufp
= fs_rh_config_descriptor
;
436 len
= sizeof fs_rh_config_descriptor
;
438 if (device_can_wakeup(&hcd
->self
.root_hub
->dev
))
441 case USB_DT_STRING
<< 8:
442 n
= rh_string (wValue
& 0xff, hcd
, ubuf
, wLength
);
445 urb
->actual_length
= n
;
451 case DeviceRequest
| USB_REQ_GET_INTERFACE
:
455 case DeviceOutRequest
| USB_REQ_SET_INTERFACE
:
457 case DeviceOutRequest
| USB_REQ_SET_ADDRESS
:
458 // wValue == urb->dev->devaddr
459 dev_dbg (hcd
->self
.controller
, "root hub device address %d\n",
463 /* INTERFACE REQUESTS (no defined feature/status flags) */
465 /* ENDPOINT REQUESTS */
467 case EndpointRequest
| USB_REQ_GET_STATUS
:
468 // ENDPOINT_HALT flag
473 case EndpointOutRequest
| USB_REQ_CLEAR_FEATURE
:
474 case EndpointOutRequest
| USB_REQ_SET_FEATURE
:
475 dev_dbg (hcd
->self
.controller
, "no endpoint features yet\n");
478 /* CLASS REQUESTS (and errors) */
481 /* non-generic request */
487 case GetHubDescriptor
:
488 len
= sizeof (struct usb_hub_descriptor
);
491 status
= hcd
->driver
->hub_control (hcd
,
492 typeReq
, wValue
, wIndex
,
496 /* "protocol stall" on error */
502 if (status
!= -EPIPE
) {
503 dev_dbg (hcd
->self
.controller
,
504 "CTRL: TypeReq=0x%x val=0x%x "
505 "idx=0x%x len=%d ==> %d\n",
506 typeReq
, wValue
, wIndex
,
511 if (urb
->transfer_buffer_length
< len
)
512 len
= urb
->transfer_buffer_length
;
513 urb
->actual_length
= len
;
514 // always USB_DIR_IN, toward host
515 memcpy (ubuf
, bufp
, len
);
517 /* report whether RH hardware supports remote wakeup */
519 len
> offsetof (struct usb_config_descriptor
,
521 ((struct usb_config_descriptor
*)ubuf
)->bmAttributes
522 |= USB_CONFIG_ATT_WAKEUP
;
525 /* any errors get returned through the urb completion */
526 local_irq_save (flags
);
527 spin_lock (&urb
->lock
);
528 if (urb
->status
== -EINPROGRESS
)
529 urb
->status
= status
;
530 spin_unlock (&urb
->lock
);
531 usb_hcd_giveback_urb (hcd
, urb
);
532 local_irq_restore (flags
);
536 /*-------------------------------------------------------------------------*/
539 * Root Hub interrupt transfers are polled using a timer if the
540 * driver requests it; otherwise the driver is responsible for
541 * calling usb_hcd_poll_rh_status() when an event occurs.
543 * Completions are called in_interrupt(), but they may or may not
546 void usb_hcd_poll_rh_status(struct usb_hcd
*hcd
)
551 char buffer
[4]; /* Any root hubs with > 31 ports? */
553 if (unlikely(!hcd
->rh_registered
))
555 if (!hcd
->uses_new_polling
&& !hcd
->status_urb
)
558 length
= hcd
->driver
->hub_status_data(hcd
, buffer
);
561 /* try to complete the status urb */
562 local_irq_save (flags
);
563 spin_lock(&hcd_root_hub_lock
);
564 urb
= hcd
->status_urb
;
566 spin_lock(&urb
->lock
);
567 if (urb
->status
== -EINPROGRESS
) {
568 hcd
->poll_pending
= 0;
569 hcd
->status_urb
= NULL
;
572 urb
->actual_length
= length
;
573 memcpy(urb
->transfer_buffer
, buffer
, length
);
574 } else /* urb has been unlinked */
576 spin_unlock(&urb
->lock
);
579 spin_unlock(&hcd_root_hub_lock
);
581 /* local irqs are always blocked in completions */
583 usb_hcd_giveback_urb (hcd
, urb
);
585 hcd
->poll_pending
= 1;
586 local_irq_restore (flags
);
589 /* The USB 2.0 spec says 256 ms. This is close enough and won't
590 * exceed that limit if HZ is 100. The math is more clunky than
591 * maybe expected, this is to make sure that all timers for USB devices
592 * fire at the same time to give the CPU a break inbetween */
593 if (hcd
->uses_new_polling
? hcd
->poll_rh
:
594 (length
== 0 && hcd
->status_urb
!= NULL
))
595 mod_timer (&hcd
->rh_timer
, (jiffies
/(HZ
/4) + 1) * (HZ
/4));
597 EXPORT_SYMBOL_GPL(usb_hcd_poll_rh_status
);
600 static void rh_timer_func (unsigned long _hcd
)
602 usb_hcd_poll_rh_status((struct usb_hcd
*) _hcd
);
605 /*-------------------------------------------------------------------------*/
607 static int rh_queue_status (struct usb_hcd
*hcd
, struct urb
*urb
)
611 int len
= 1 + (urb
->dev
->maxchild
/ 8);
613 spin_lock_irqsave (&hcd_root_hub_lock
, flags
);
614 if (urb
->status
!= -EINPROGRESS
) /* already unlinked */
615 retval
= urb
->status
;
616 else if (hcd
->status_urb
|| urb
->transfer_buffer_length
< len
) {
617 dev_dbg (hcd
->self
.controller
, "not queuing rh status urb\n");
620 hcd
->status_urb
= urb
;
621 urb
->hcpriv
= hcd
; /* indicate it's queued */
623 if (!hcd
->uses_new_polling
)
624 mod_timer (&hcd
->rh_timer
,
625 (jiffies
/(HZ
/4) + 1) * (HZ
/4));
627 /* If a status change has already occurred, report it ASAP */
628 else if (hcd
->poll_pending
)
629 mod_timer (&hcd
->rh_timer
, jiffies
);
632 spin_unlock_irqrestore (&hcd_root_hub_lock
, flags
);
636 static int rh_urb_enqueue (struct usb_hcd
*hcd
, struct urb
*urb
)
638 if (usb_endpoint_xfer_int(&urb
->ep
->desc
))
639 return rh_queue_status (hcd
, urb
);
640 if (usb_endpoint_xfer_control(&urb
->ep
->desc
))
641 return rh_call_control (hcd
, urb
);
645 /*-------------------------------------------------------------------------*/
647 /* Unlinks of root-hub control URBs are legal, but they don't do anything
648 * since these URBs always execute synchronously.
650 static int usb_rh_urb_dequeue (struct usb_hcd
*hcd
, struct urb
*urb
)
654 if (usb_endpoint_num(&urb
->ep
->desc
) == 0) { /* Control URB */
657 } else { /* Status URB */
658 if (!hcd
->uses_new_polling
)
659 del_timer (&hcd
->rh_timer
);
660 local_irq_save (flags
);
661 spin_lock (&hcd_root_hub_lock
);
662 if (urb
== hcd
->status_urb
) {
663 hcd
->status_urb
= NULL
;
666 urb
= NULL
; /* wasn't fully queued */
667 spin_unlock (&hcd_root_hub_lock
);
669 usb_hcd_giveback_urb (hcd
, urb
);
670 local_irq_restore (flags
);
676 /*-------------------------------------------------------------------------*/
678 static struct class *usb_host_class
;
680 int usb_host_init(void)
684 usb_host_class
= class_create(THIS_MODULE
, "usb_host");
685 if (IS_ERR(usb_host_class
))
686 retval
= PTR_ERR(usb_host_class
);
690 void usb_host_cleanup(void)
692 class_destroy(usb_host_class
);
696 * usb_bus_init - shared initialization code
697 * @bus: the bus structure being initialized
699 * This code is used to initialize a usb_bus structure, memory for which is
700 * separately managed.
702 static void usb_bus_init (struct usb_bus
*bus
)
704 memset (&bus
->devmap
, 0, sizeof(struct usb_devmap
));
706 bus
->devnum_next
= 1;
708 bus
->root_hub
= NULL
;
710 bus
->bandwidth_allocated
= 0;
711 bus
->bandwidth_int_reqs
= 0;
712 bus
->bandwidth_isoc_reqs
= 0;
714 INIT_LIST_HEAD (&bus
->bus_list
);
717 /*-------------------------------------------------------------------------*/
720 * usb_register_bus - registers the USB host controller with the usb core
721 * @bus: pointer to the bus to register
722 * Context: !in_interrupt()
724 * Assigns a bus number, and links the controller into usbcore data
725 * structures so that it can be seen by scanning the bus list.
727 static int usb_register_bus(struct usb_bus
*bus
)
731 mutex_lock(&usb_bus_list_lock
);
732 busnum
= find_next_zero_bit (busmap
.busmap
, USB_MAXBUS
, 1);
733 if (busnum
< USB_MAXBUS
) {
734 set_bit (busnum
, busmap
.busmap
);
735 bus
->busnum
= busnum
;
737 printk (KERN_ERR
"%s: too many buses\n", usbcore_name
);
738 mutex_unlock(&usb_bus_list_lock
);
742 bus
->class_dev
= class_device_create(usb_host_class
, NULL
, MKDEV(0,0),
743 bus
->controller
, "usb_host%d", busnum
);
744 if (IS_ERR(bus
->class_dev
)) {
745 clear_bit(busnum
, busmap
.busmap
);
746 mutex_unlock(&usb_bus_list_lock
);
747 return PTR_ERR(bus
->class_dev
);
750 class_set_devdata(bus
->class_dev
, bus
);
752 /* Add it to the local list of buses */
753 list_add (&bus
->bus_list
, &usb_bus_list
);
754 mutex_unlock(&usb_bus_list_lock
);
756 usb_notify_add_bus(bus
);
758 dev_info (bus
->controller
, "new USB bus registered, assigned bus number %d\n", bus
->busnum
);
763 * usb_deregister_bus - deregisters the USB host controller
764 * @bus: pointer to the bus to deregister
765 * Context: !in_interrupt()
767 * Recycles the bus number, and unlinks the controller from usbcore data
768 * structures so that it won't be seen by scanning the bus list.
770 static void usb_deregister_bus (struct usb_bus
*bus
)
772 dev_info (bus
->controller
, "USB bus %d deregistered\n", bus
->busnum
);
775 * NOTE: make sure that all the devices are removed by the
776 * controller code, as well as having it call this when cleaning
779 mutex_lock(&usb_bus_list_lock
);
780 list_del (&bus
->bus_list
);
781 mutex_unlock(&usb_bus_list_lock
);
783 usb_notify_remove_bus(bus
);
785 clear_bit (bus
->busnum
, busmap
.busmap
);
787 class_device_unregister(bus
->class_dev
);
791 * register_root_hub - called by usb_add_hcd() to register a root hub
792 * @hcd: host controller for this root hub
794 * This function registers the root hub with the USB subsystem. It sets up
795 * the device properly in the device tree and then calls usb_new_device()
796 * to register the usb device. It also assigns the root hub's USB address
799 static int register_root_hub(struct usb_hcd
*hcd
)
801 struct device
*parent_dev
= hcd
->self
.controller
;
802 struct usb_device
*usb_dev
= hcd
->self
.root_hub
;
803 const int devnum
= 1;
806 usb_dev
->devnum
= devnum
;
807 usb_dev
->bus
->devnum_next
= devnum
+ 1;
808 memset (&usb_dev
->bus
->devmap
.devicemap
, 0,
809 sizeof usb_dev
->bus
->devmap
.devicemap
);
810 set_bit (devnum
, usb_dev
->bus
->devmap
.devicemap
);
811 usb_set_device_state(usb_dev
, USB_STATE_ADDRESS
);
813 mutex_lock(&usb_bus_list_lock
);
815 usb_dev
->ep0
.desc
.wMaxPacketSize
= __constant_cpu_to_le16(64);
816 retval
= usb_get_device_descriptor(usb_dev
, USB_DT_DEVICE_SIZE
);
817 if (retval
!= sizeof usb_dev
->descriptor
) {
818 mutex_unlock(&usb_bus_list_lock
);
819 dev_dbg (parent_dev
, "can't read %s device descriptor %d\n",
820 usb_dev
->dev
.bus_id
, retval
);
821 return (retval
< 0) ? retval
: -EMSGSIZE
;
824 retval
= usb_new_device (usb_dev
);
826 dev_err (parent_dev
, "can't register root hub for %s, %d\n",
827 usb_dev
->dev
.bus_id
, retval
);
829 mutex_unlock(&usb_bus_list_lock
);
832 spin_lock_irq (&hcd_root_hub_lock
);
833 hcd
->rh_registered
= 1;
834 spin_unlock_irq (&hcd_root_hub_lock
);
836 /* Did the HC die before the root hub was registered? */
837 if (hcd
->state
== HC_STATE_HALT
)
838 usb_hc_died (hcd
); /* This time clean up */
844 void usb_enable_root_hub_irq (struct usb_bus
*bus
)
848 hcd
= container_of (bus
, struct usb_hcd
, self
);
849 if (hcd
->driver
->hub_irq_enable
&& hcd
->state
!= HC_STATE_HALT
)
850 hcd
->driver
->hub_irq_enable (hcd
);
854 /*-------------------------------------------------------------------------*/
857 * usb_calc_bus_time - approximate periodic transaction time in nanoseconds
858 * @speed: from dev->speed; USB_SPEED_{LOW,FULL,HIGH}
859 * @is_input: true iff the transaction sends data to the host
860 * @isoc: true for isochronous transactions, false for interrupt ones
861 * @bytecount: how many bytes in the transaction.
863 * Returns approximate bus time in nanoseconds for a periodic transaction.
864 * See USB 2.0 spec section 5.11.3; only periodic transfers need to be
865 * scheduled in software, this function is only used for such scheduling.
867 long usb_calc_bus_time (int speed
, int is_input
, int isoc
, int bytecount
)
872 case USB_SPEED_LOW
: /* INTR only */
874 tmp
= (67667L * (31L + 10L * BitTime (bytecount
))) / 1000L;
875 return (64060L + (2 * BW_HUB_LS_SETUP
) + BW_HOST_DELAY
+ tmp
);
877 tmp
= (66700L * (31L + 10L * BitTime (bytecount
))) / 1000L;
878 return (64107L + (2 * BW_HUB_LS_SETUP
) + BW_HOST_DELAY
+ tmp
);
880 case USB_SPEED_FULL
: /* ISOC or INTR */
882 tmp
= (8354L * (31L + 10L * BitTime (bytecount
))) / 1000L;
883 return (((is_input
) ? 7268L : 6265L) + BW_HOST_DELAY
+ tmp
);
885 tmp
= (8354L * (31L + 10L * BitTime (bytecount
))) / 1000L;
886 return (9107L + BW_HOST_DELAY
+ tmp
);
888 case USB_SPEED_HIGH
: /* ISOC or INTR */
889 // FIXME adjust for input vs output
891 tmp
= HS_NSECS_ISO (bytecount
);
893 tmp
= HS_NSECS (bytecount
);
896 pr_debug ("%s: bogus device speed!\n", usbcore_name
);
900 EXPORT_SYMBOL (usb_calc_bus_time
);
903 /*-------------------------------------------------------------------------*/
906 * Generic HC operations.
909 /*-------------------------------------------------------------------------*/
911 static void urb_unlink(struct usb_hcd
*hcd
, struct urb
*urb
)
915 /* clear all state linking urb to this dev (and hcd) */
916 spin_lock_irqsave(&hcd_urb_list_lock
, flags
);
917 list_del_init (&urb
->urb_list
);
918 spin_unlock_irqrestore(&hcd_urb_list_lock
, flags
);
920 if (hcd
->self
.uses_dma
&& !is_root_hub(urb
->dev
)) {
921 if (usb_endpoint_xfer_control(&urb
->ep
->desc
)
922 && !(urb
->transfer_flags
& URB_NO_SETUP_DMA_MAP
))
923 dma_unmap_single (hcd
->self
.controller
, urb
->setup_dma
,
924 sizeof (struct usb_ctrlrequest
),
926 if (urb
->transfer_buffer_length
!= 0
927 && !(urb
->transfer_flags
& URB_NO_TRANSFER_DMA_MAP
))
928 dma_unmap_single (hcd
->self
.controller
,
930 urb
->transfer_buffer_length
,
937 /* may be called in any context with a valid urb->dev usecount
938 * caller surrenders "ownership" of urb
939 * expects usb_submit_urb() to have sanity checked and conditioned all
942 int usb_hcd_submit_urb (struct urb
*urb
, gfp_t mem_flags
)
945 struct usb_hcd
*hcd
= bus_to_hcd(urb
->dev
->bus
);
951 usbmon_urb_submit(&hcd
->self
, urb
);
954 * Atomically queue the urb, first to our records, then to the HCD.
955 * Access to urb->status is controlled by urb->lock ... changes on
956 * i/o completion (normal or fault) or unlinking.
959 // FIXME: verify that quiescing hc works right (RH cleans up)
961 spin_lock_irqsave(&hcd_urb_list_lock
, flags
);
962 if (unlikely(!urb
->ep
->enabled
))
964 else if (unlikely (urb
->reject
))
966 else switch (hcd
->state
) {
967 case HC_STATE_RUNNING
:
968 case HC_STATE_RESUMING
:
969 list_add_tail (&urb
->urb_list
, &urb
->ep
->urb_list
);
976 spin_unlock_irqrestore(&hcd_urb_list_lock
, flags
);
978 INIT_LIST_HEAD (&urb
->urb_list
);
979 usbmon_urb_submit_error(&hcd
->self
, urb
, status
);
983 /* increment urb's reference count as part of giving it to the HCD
984 * (which now controls it). HCD guarantees that it either returns
985 * an error or calls giveback(), but not both.
987 urb
= usb_get_urb (urb
);
988 atomic_inc (&urb
->use_count
);
990 if (is_root_hub(urb
->dev
)) {
991 /* NOTE: requirement on hub callers (usbfs and the hub
992 * driver, for now) that URBs' urb->transfer_buffer be
993 * valid and usb_buffer_{sync,unmap}() not be needed, since
994 * they could clobber root hub response data.
996 status
= rh_urb_enqueue (hcd
, urb
);
1000 /* lower level hcd code should use *_dma exclusively,
1001 * unless it uses pio or talks to another transport.
1003 if (hcd
->self
.uses_dma
) {
1004 if (usb_endpoint_xfer_control(&urb
->ep
->desc
)
1005 && !(urb
->transfer_flags
& URB_NO_SETUP_DMA_MAP
))
1006 urb
->setup_dma
= dma_map_single (
1007 hcd
->self
.controller
,
1009 sizeof (struct usb_ctrlrequest
),
1011 if (urb
->transfer_buffer_length
!= 0
1012 && !(urb
->transfer_flags
& URB_NO_TRANSFER_DMA_MAP
))
1013 urb
->transfer_dma
= dma_map_single (
1014 hcd
->self
.controller
,
1015 urb
->transfer_buffer
,
1016 urb
->transfer_buffer_length
,
1022 status
= hcd
->driver
->urb_enqueue (hcd
, urb
->ep
, urb
, mem_flags
);
1024 if (unlikely (status
)) {
1025 urb_unlink(hcd
, urb
);
1026 atomic_dec (&urb
->use_count
);
1028 wake_up (&usb_kill_urb_queue
);
1029 usbmon_urb_submit_error(&hcd
->self
, urb
, status
);
1035 /*-------------------------------------------------------------------------*/
1037 /* this makes the hcd giveback() the urb more quickly, by kicking it
1038 * off hardware queues (which may take a while) and returning it as
1039 * soon as practical. we've already set up the urb's return status,
1040 * but we can't know if the callback completed already.
1043 unlink1 (struct usb_hcd
*hcd
, struct urb
*urb
)
1047 if (is_root_hub(urb
->dev
))
1048 value
= usb_rh_urb_dequeue (hcd
, urb
);
1051 /* The only reason an HCD might fail this call is if
1052 * it has not yet fully queued the urb to begin with.
1053 * Such failures should be harmless. */
1054 value
= hcd
->driver
->urb_dequeue (hcd
, urb
);
1058 dev_dbg (hcd
->self
.controller
, "dequeue %p --> %d\n",
1064 * called in any context
1066 * caller guarantees urb won't be recycled till both unlink()
1067 * and the urb's completion function return
1069 int usb_hcd_unlink_urb (struct urb
*urb
, int status
)
1071 struct usb_hcd
*hcd
= NULL
;
1072 struct device
*sys
= NULL
;
1073 unsigned long flags
;
1074 struct list_head
*tmp
;
1078 * we contend for urb->status with the hcd core,
1079 * which changes it while returning the urb.
1081 * Caller guaranteed that the urb pointer hasn't been freed, and
1082 * that it was submitted. But as a rule it can't know whether or
1083 * not it's already been unlinked ... so we respect the reversed
1084 * lock sequence needed for the usb_hcd_giveback_urb() code paths
1085 * (urb lock, then hcd_urb_list_lock) in case some other CPU is now
1088 spin_lock_irqsave (&urb
->lock
, flags
);
1089 spin_lock(&hcd_urb_list_lock
);
1091 sys
= &urb
->dev
->dev
;
1092 hcd
= bus_to_hcd(urb
->dev
->bus
);
1098 /* insist the urb is still queued */
1099 list_for_each(tmp
, &urb
->ep
->urb_list
) {
1100 if (tmp
== &urb
->urb_list
)
1103 if (tmp
!= &urb
->urb_list
) {
1108 /* Any status except -EINPROGRESS means something already started to
1109 * unlink this URB from the hardware. So there's no more work to do.
1111 if (urb
->status
!= -EINPROGRESS
) {
1116 /* IRQ setup can easily be broken so that USB controllers
1117 * never get completion IRQs ... maybe even the ones we need to
1118 * finish unlinking the initial failed usb_set_address()
1119 * or device descriptor fetch.
1121 if (!test_bit(HCD_FLAG_SAW_IRQ
, &hcd
->flags
) &&
1122 !is_root_hub(urb
->dev
)) {
1123 dev_warn (hcd
->self
.controller
, "Unlink after no-IRQ? "
1124 "Controller is probably using the wrong IRQ.\n");
1125 set_bit(HCD_FLAG_SAW_IRQ
, &hcd
->flags
);
1128 urb
->status
= status
;
1130 spin_unlock(&hcd_urb_list_lock
);
1131 spin_unlock_irqrestore (&urb
->lock
, flags
);
1133 retval
= unlink1 (hcd
, urb
);
1135 retval
= -EINPROGRESS
;
1139 spin_unlock(&hcd_urb_list_lock
);
1140 spin_unlock_irqrestore (&urb
->lock
, flags
);
1141 if (retval
!= -EIDRM
&& sys
&& sys
->driver
)
1142 dev_dbg (sys
, "hcd_unlink_urb %p fail %d\n", urb
, retval
);
1146 /*-------------------------------------------------------------------------*/
1149 * usb_hcd_giveback_urb - return URB from HCD to device driver
1150 * @hcd: host controller returning the URB
1151 * @urb: urb being returned to the USB device driver.
1152 * Context: in_interrupt()
1154 * This hands the URB from HCD to its USB device driver, using its
1155 * completion function. The HCD has freed all per-urb resources
1156 * (and is done using urb->hcpriv). It also released all HCD locks;
1157 * the device driver won't cause problems if it frees, modifies,
1158 * or resubmits this URB.
1160 void usb_hcd_giveback_urb (struct usb_hcd
*hcd
, struct urb
*urb
)
1162 urb_unlink(hcd
, urb
);
1163 usbmon_urb_complete (&hcd
->self
, urb
);
1164 usb_unanchor_urb(urb
);
1166 /* pass ownership to the completion handler */
1167 urb
->complete (urb
);
1168 atomic_dec (&urb
->use_count
);
1169 if (unlikely (urb
->reject
))
1170 wake_up (&usb_kill_urb_queue
);
1173 EXPORT_SYMBOL (usb_hcd_giveback_urb
);
1175 /*-------------------------------------------------------------------------*/
1177 /* disables the endpoint: cancels any pending urbs, then synchronizes with
1178 * the hcd to make sure all endpoint state is gone from hardware, and then
1179 * waits until the endpoint's queue is completely drained. use for
1180 * set_configuration, set_interface, driver removal, physical disconnect.
1182 * example: a qh stored in ep->hcpriv, holding state related to endpoint
1183 * type, maxpacket size, toggle, halt status, and scheduling.
1185 void usb_hcd_endpoint_disable (struct usb_device
*udev
,
1186 struct usb_host_endpoint
*ep
)
1188 struct usb_hcd
*hcd
;
1191 hcd
= bus_to_hcd(udev
->bus
);
1192 local_irq_disable ();
1194 /* ep is already gone from udev->ep_{in,out}[]; no more submits */
1196 spin_lock(&hcd_urb_list_lock
);
1197 list_for_each_entry (urb
, &ep
->urb_list
, urb_list
) {
1201 /* the urb may already have been unlinked */
1202 if (urb
->status
!= -EINPROGRESS
)
1205 is_in
= usb_urb_dir_in(urb
);
1206 spin_unlock(&hcd_urb_list_lock
);
1208 spin_lock (&urb
->lock
);
1210 if (tmp
== -EINPROGRESS
)
1211 urb
->status
= -ESHUTDOWN
;
1212 spin_unlock (&urb
->lock
);
1214 /* kick hcd unless it's already returning this */
1215 if (tmp
== -EINPROGRESS
) {
1217 dev_dbg (hcd
->self
.controller
,
1218 "shutdown urb %p ep%d%s%s\n",
1219 urb
, usb_endpoint_num(&ep
->desc
),
1220 is_in
? "in" : "out",
1223 switch (usb_endpoint_type(&ep
->desc
)) {
1224 case USB_ENDPOINT_XFER_CONTROL
:
1226 case USB_ENDPOINT_XFER_BULK
:
1228 case USB_ENDPOINT_XFER_INT
:
1238 /* list contents may have changed */
1241 spin_unlock(&hcd_urb_list_lock
);
1242 local_irq_enable ();
1244 /* synchronize with the hardware, so old configuration state
1245 * clears out immediately (and will be freed).
1248 if (hcd
->driver
->endpoint_disable
)
1249 hcd
->driver
->endpoint_disable (hcd
, ep
);
1251 /* Wait until the endpoint queue is completely empty. Most HCDs
1252 * will have done this already in their endpoint_disable method,
1253 * but some might not. And there could be root-hub control URBs
1254 * still pending since they aren't affected by the HCDs'
1255 * endpoint_disable methods.
1257 while (!list_empty (&ep
->urb_list
)) {
1258 spin_lock_irq(&hcd_urb_list_lock
);
1260 /* The list may have changed while we acquired the spinlock */
1262 if (!list_empty (&ep
->urb_list
)) {
1263 urb
= list_entry (ep
->urb_list
.prev
, struct urb
,
1267 spin_unlock_irq(&hcd_urb_list_lock
);
1276 /*-------------------------------------------------------------------------*/
1278 /* called in any context */
1279 int usb_hcd_get_frame_number (struct usb_device
*udev
)
1281 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
1283 if (!HC_IS_RUNNING (hcd
->state
))
1285 return hcd
->driver
->get_frame_number (hcd
);
1288 /*-------------------------------------------------------------------------*/
1292 int hcd_bus_suspend(struct usb_device
*rhdev
)
1294 struct usb_hcd
*hcd
= container_of(rhdev
->bus
, struct usb_hcd
, self
);
1296 int old_state
= hcd
->state
;
1298 dev_dbg(&rhdev
->dev
, "bus %s%s\n",
1299 rhdev
->auto_pm
? "auto-" : "", "suspend");
1300 if (!hcd
->driver
->bus_suspend
) {
1303 hcd
->state
= HC_STATE_QUIESCING
;
1304 status
= hcd
->driver
->bus_suspend(hcd
);
1307 usb_set_device_state(rhdev
, USB_STATE_SUSPENDED
);
1308 hcd
->state
= HC_STATE_SUSPENDED
;
1310 hcd
->state
= old_state
;
1311 dev_dbg(&rhdev
->dev
, "bus %s fail, err %d\n",
1317 int hcd_bus_resume(struct usb_device
*rhdev
)
1319 struct usb_hcd
*hcd
= container_of(rhdev
->bus
, struct usb_hcd
, self
);
1321 int old_state
= hcd
->state
;
1323 dev_dbg(&rhdev
->dev
, "usb %s%s\n",
1324 rhdev
->auto_pm
? "auto-" : "", "resume");
1325 if (!hcd
->driver
->bus_resume
)
1327 if (hcd
->state
== HC_STATE_RUNNING
)
1330 hcd
->state
= HC_STATE_RESUMING
;
1331 status
= hcd
->driver
->bus_resume(hcd
);
1333 /* TRSMRCY = 10 msec */
1335 usb_set_device_state(rhdev
, rhdev
->actconfig
1336 ? USB_STATE_CONFIGURED
1337 : USB_STATE_ADDRESS
);
1338 hcd
->state
= HC_STATE_RUNNING
;
1340 hcd
->state
= old_state
;
1341 dev_dbg(&rhdev
->dev
, "bus %s fail, err %d\n",
1343 if (status
!= -ESHUTDOWN
)
1349 /* Workqueue routine for root-hub remote wakeup */
1350 static void hcd_resume_work(struct work_struct
*work
)
1352 struct usb_hcd
*hcd
= container_of(work
, struct usb_hcd
, wakeup_work
);
1353 struct usb_device
*udev
= hcd
->self
.root_hub
;
1355 usb_lock_device(udev
);
1356 usb_mark_last_busy(udev
);
1357 usb_external_resume_device(udev
);
1358 usb_unlock_device(udev
);
1362 * usb_hcd_resume_root_hub - called by HCD to resume its root hub
1363 * @hcd: host controller for this root hub
1365 * The USB host controller calls this function when its root hub is
1366 * suspended (with the remote wakeup feature enabled) and a remote
1367 * wakeup request is received. The routine submits a workqueue request
1368 * to resume the root hub (that is, manage its downstream ports again).
1370 void usb_hcd_resume_root_hub (struct usb_hcd
*hcd
)
1372 unsigned long flags
;
1374 spin_lock_irqsave (&hcd_root_hub_lock
, flags
);
1375 if (hcd
->rh_registered
)
1376 queue_work(ksuspend_usb_wq
, &hcd
->wakeup_work
);
1377 spin_unlock_irqrestore (&hcd_root_hub_lock
, flags
);
1379 EXPORT_SYMBOL_GPL(usb_hcd_resume_root_hub
);
1383 /*-------------------------------------------------------------------------*/
1385 #ifdef CONFIG_USB_OTG
1388 * usb_bus_start_enum - start immediate enumeration (for OTG)
1389 * @bus: the bus (must use hcd framework)
1390 * @port_num: 1-based number of port; usually bus->otg_port
1391 * Context: in_interrupt()
1393 * Starts enumeration, with an immediate reset followed later by
1394 * khubd identifying and possibly configuring the device.
1395 * This is needed by OTG controller drivers, where it helps meet
1396 * HNP protocol timing requirements for starting a port reset.
1398 int usb_bus_start_enum(struct usb_bus
*bus
, unsigned port_num
)
1400 struct usb_hcd
*hcd
;
1401 int status
= -EOPNOTSUPP
;
1403 /* NOTE: since HNP can't start by grabbing the bus's address0_sem,
1404 * boards with root hubs hooked up to internal devices (instead of
1405 * just the OTG port) may need more attention to resetting...
1407 hcd
= container_of (bus
, struct usb_hcd
, self
);
1408 if (port_num
&& hcd
->driver
->start_port_reset
)
1409 status
= hcd
->driver
->start_port_reset(hcd
, port_num
);
1411 /* run khubd shortly after (first) root port reset finishes;
1412 * it may issue others, until at least 50 msecs have passed.
1415 mod_timer(&hcd
->rh_timer
, jiffies
+ msecs_to_jiffies(10));
1418 EXPORT_SYMBOL (usb_bus_start_enum
);
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 */