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>
41 #include <linux/usb.h>
48 /*-------------------------------------------------------------------------*/
51 * USB Host Controller Driver framework
53 * Plugs into usbcore (usb_bus) and lets HCDs share code, minimizing
54 * HCD-specific behaviors/bugs.
56 * This does error checks, tracks devices and urbs, and delegates to a
57 * "hc_driver" only for code (and data) that really needs to know about
58 * hardware differences. That includes root hub registers, i/o queues,
59 * and so on ... but as little else as possible.
61 * Shared code includes most of the "root hub" code (these are emulated,
62 * though each HC's hardware works differently) and PCI glue, plus request
63 * tracking overhead. The HCD code should only block on spinlocks or on
64 * hardware handshaking; blocking on software events (such as other kernel
65 * threads releasing resources, or completing actions) is all generic.
67 * Happens the USB 2.0 spec says this would be invisible inside the "USBD",
68 * and includes mostly a "HCDI" (HCD Interface) along with some APIs used
69 * only by the hub driver ... and that neither should be seen or used by
70 * usb client device drivers.
72 * Contributors of ideas or unattributed patches include: David Brownell,
73 * Roman Weissgaerber, Rory Bolt, Greg Kroah-Hartman, ...
76 * 2002-02-21 Pull in most of the usb_bus support from usb.c; some
77 * associated cleanup. "usb_hcd" still != "usb_bus".
78 * 2001-12-12 Initial patch version for Linux 2.5.1 kernel.
81 /*-------------------------------------------------------------------------*/
83 /* host controllers we manage */
84 LIST_HEAD (usb_bus_list
);
85 EXPORT_SYMBOL_GPL (usb_bus_list
);
87 /* used when allocating bus numbers */
90 unsigned long busmap
[USB_MAXBUS
/ (8*sizeof (unsigned long))];
92 static struct usb_busmap busmap
;
94 /* used when updating list of hcds */
95 DEFINE_MUTEX(usb_bus_list_lock
); /* exported only for usbfs */
96 EXPORT_SYMBOL_GPL (usb_bus_list_lock
);
98 /* used for controlling access to virtual root hubs */
99 static DEFINE_SPINLOCK(hcd_root_hub_lock
);
101 /* used when updating hcd data */
102 static DEFINE_SPINLOCK(hcd_data_lock
);
104 /* wait queue for synchronous unlinks */
105 DECLARE_WAIT_QUEUE_HEAD(usb_kill_urb_queue
);
107 /*-------------------------------------------------------------------------*/
110 * Sharable chunks of root hub code.
113 /*-------------------------------------------------------------------------*/
115 #define KERNEL_REL ((LINUX_VERSION_CODE >> 16) & 0x0ff)
116 #define KERNEL_VER ((LINUX_VERSION_CODE >> 8) & 0x0ff)
118 /* usb 2.0 root hub device descriptor */
119 static const u8 usb2_rh_dev_descriptor
[18] = {
120 0x12, /* __u8 bLength; */
121 0x01, /* __u8 bDescriptorType; Device */
122 0x00, 0x02, /* __le16 bcdUSB; v2.0 */
124 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
125 0x00, /* __u8 bDeviceSubClass; */
126 0x01, /* __u8 bDeviceProtocol; [ usb 2.0 single TT ]*/
127 0x40, /* __u8 bMaxPacketSize0; 64 Bytes */
129 0x00, 0x00, /* __le16 idVendor; */
130 0x00, 0x00, /* __le16 idProduct; */
131 KERNEL_VER
, KERNEL_REL
, /* __le16 bcdDevice */
133 0x03, /* __u8 iManufacturer; */
134 0x02, /* __u8 iProduct; */
135 0x01, /* __u8 iSerialNumber; */
136 0x01 /* __u8 bNumConfigurations; */
139 /* no usb 2.0 root hub "device qualifier" descriptor: one speed only */
141 /* usb 1.1 root hub device descriptor */
142 static const u8 usb11_rh_dev_descriptor
[18] = {
143 0x12, /* __u8 bLength; */
144 0x01, /* __u8 bDescriptorType; Device */
145 0x10, 0x01, /* __le16 bcdUSB; v1.1 */
147 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
148 0x00, /* __u8 bDeviceSubClass; */
149 0x00, /* __u8 bDeviceProtocol; [ low/full speeds only ] */
150 0x40, /* __u8 bMaxPacketSize0; 64 Bytes */
152 0x00, 0x00, /* __le16 idVendor; */
153 0x00, 0x00, /* __le16 idProduct; */
154 KERNEL_VER
, KERNEL_REL
, /* __le16 bcdDevice */
156 0x03, /* __u8 iManufacturer; */
157 0x02, /* __u8 iProduct; */
158 0x01, /* __u8 iSerialNumber; */
159 0x01 /* __u8 bNumConfigurations; */
163 /*-------------------------------------------------------------------------*/
165 /* Configuration descriptors for our root hubs */
167 static const u8 fs_rh_config_descriptor
[] = {
169 /* one configuration */
170 0x09, /* __u8 bLength; */
171 0x02, /* __u8 bDescriptorType; Configuration */
172 0x19, 0x00, /* __le16 wTotalLength; */
173 0x01, /* __u8 bNumInterfaces; (1) */
174 0x01, /* __u8 bConfigurationValue; */
175 0x00, /* __u8 iConfiguration; */
176 0xc0, /* __u8 bmAttributes;
181 0x00, /* __u8 MaxPower; */
184 * USB 2.0, single TT organization (mandatory):
185 * one interface, protocol 0
187 * USB 2.0, multiple TT organization (optional):
188 * two interfaces, protocols 1 (like single TT)
189 * and 2 (multiple TT mode) ... config is
195 0x09, /* __u8 if_bLength; */
196 0x04, /* __u8 if_bDescriptorType; Interface */
197 0x00, /* __u8 if_bInterfaceNumber; */
198 0x00, /* __u8 if_bAlternateSetting; */
199 0x01, /* __u8 if_bNumEndpoints; */
200 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
201 0x00, /* __u8 if_bInterfaceSubClass; */
202 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
203 0x00, /* __u8 if_iInterface; */
205 /* one endpoint (status change endpoint) */
206 0x07, /* __u8 ep_bLength; */
207 0x05, /* __u8 ep_bDescriptorType; Endpoint */
208 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
209 0x03, /* __u8 ep_bmAttributes; Interrupt */
210 0x02, 0x00, /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8) */
211 0xff /* __u8 ep_bInterval; (255ms -- usb 2.0 spec) */
214 static const u8 hs_rh_config_descriptor
[] = {
216 /* one configuration */
217 0x09, /* __u8 bLength; */
218 0x02, /* __u8 bDescriptorType; Configuration */
219 0x19, 0x00, /* __le16 wTotalLength; */
220 0x01, /* __u8 bNumInterfaces; (1) */
221 0x01, /* __u8 bConfigurationValue; */
222 0x00, /* __u8 iConfiguration; */
223 0xc0, /* __u8 bmAttributes;
228 0x00, /* __u8 MaxPower; */
231 * USB 2.0, single TT organization (mandatory):
232 * one interface, protocol 0
234 * USB 2.0, multiple TT organization (optional):
235 * two interfaces, protocols 1 (like single TT)
236 * and 2 (multiple TT mode) ... config is
242 0x09, /* __u8 if_bLength; */
243 0x04, /* __u8 if_bDescriptorType; Interface */
244 0x00, /* __u8 if_bInterfaceNumber; */
245 0x00, /* __u8 if_bAlternateSetting; */
246 0x01, /* __u8 if_bNumEndpoints; */
247 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
248 0x00, /* __u8 if_bInterfaceSubClass; */
249 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
250 0x00, /* __u8 if_iInterface; */
252 /* one endpoint (status change endpoint) */
253 0x07, /* __u8 ep_bLength; */
254 0x05, /* __u8 ep_bDescriptorType; Endpoint */
255 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
256 0x03, /* __u8 ep_bmAttributes; Interrupt */
257 /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8)
258 * see hub.c:hub_configure() for details. */
259 (USB_MAXCHILDREN
+ 1 + 7) / 8, 0x00,
260 0x0c /* __u8 ep_bInterval; (256ms -- usb 2.0 spec) */
263 /*-------------------------------------------------------------------------*/
266 * helper routine for returning string descriptors in UTF-16LE
267 * input can actually be ISO-8859-1; ASCII is its 7-bit subset
269 static int ascii2utf (char *s
, u8
*utf
, int utfmax
)
273 for (retval
= 0; *s
&& utfmax
> 1; utfmax
-= 2, retval
+= 2) {
285 * rh_string - provides manufacturer, product and serial strings for root hub
286 * @id: the string ID number (1: serial number, 2: product, 3: vendor)
287 * @hcd: the host controller for this root hub
288 * @type: string describing our driver
289 * @data: return packet in UTF-16 LE
290 * @len: length of the return packet
292 * Produces either a manufacturer, product or serial number string for the
293 * virtual root hub device.
295 static int rh_string (
305 buf
[0] = 4; buf
[1] = 3; /* 4 bytes string data */
306 buf
[2] = 0x09; buf
[3] = 0x04; /* MSFT-speak for "en-us" */
308 memcpy (data
, buf
, len
);
312 } else if (id
== 1) {
313 strlcpy (buf
, hcd
->self
.bus_name
, sizeof buf
);
315 // product description
316 } else if (id
== 2) {
317 strlcpy (buf
, hcd
->product_desc
, sizeof buf
);
319 // id 3 == vendor description
320 } else if (id
== 3) {
321 snprintf (buf
, sizeof buf
, "%s %s %s", init_utsname()->sysname
,
322 init_utsname()->release
, hcd
->driver
->description
);
324 // unsupported IDs --> "protocol stall"
328 switch (len
) { /* All cases fall through */
330 len
= 2 + ascii2utf (buf
, data
+ 2, len
- 2);
332 data
[1] = 3; /* type == string */
334 data
[0] = 2 * (strlen (buf
) + 1);
336 ; /* Compiler wants a statement here */
342 /* Root hub control transfers execute synchronously */
343 static int rh_call_control (struct usb_hcd
*hcd
, struct urb
*urb
)
345 struct usb_ctrlrequest
*cmd
;
346 u16 typeReq
, wValue
, wIndex
, wLength
;
347 u8
*ubuf
= urb
->transfer_buffer
;
348 u8 tbuf
[sizeof (struct usb_hub_descriptor
)]
349 __attribute__((aligned(4)));
350 const u8
*bufp
= tbuf
;
352 int patch_wakeup
= 0;
357 cmd
= (struct usb_ctrlrequest
*) urb
->setup_packet
;
358 typeReq
= (cmd
->bRequestType
<< 8) | cmd
->bRequest
;
359 wValue
= le16_to_cpu (cmd
->wValue
);
360 wIndex
= le16_to_cpu (cmd
->wIndex
);
361 wLength
= le16_to_cpu (cmd
->wLength
);
363 if (wLength
> urb
->transfer_buffer_length
)
366 urb
->actual_length
= 0;
369 /* DEVICE REQUESTS */
371 /* The root hub's remote wakeup enable bit is implemented using
372 * driver model wakeup flags. If this system supports wakeup
373 * through USB, userspace may change the default "allow wakeup"
374 * policy through sysfs or these calls.
376 * Most root hubs support wakeup from downstream devices, for
377 * runtime power management (disabling USB clocks and reducing
378 * VBUS power usage). However, not all of them do so; silicon,
379 * board, and BIOS bugs here are not uncommon, so these can't
380 * be treated quite like external hubs.
382 * Likewise, not all root hubs will pass wakeup events upstream,
383 * to wake up the whole system. So don't assume root hub and
384 * controller capabilities are identical.
387 case DeviceRequest
| USB_REQ_GET_STATUS
:
388 tbuf
[0] = (device_may_wakeup(&hcd
->self
.root_hub
->dev
)
389 << USB_DEVICE_REMOTE_WAKEUP
)
390 | (1 << USB_DEVICE_SELF_POWERED
);
394 case DeviceOutRequest
| USB_REQ_CLEAR_FEATURE
:
395 if (wValue
== USB_DEVICE_REMOTE_WAKEUP
)
396 device_set_wakeup_enable(&hcd
->self
.root_hub
->dev
, 0);
400 case DeviceOutRequest
| USB_REQ_SET_FEATURE
:
401 if (device_can_wakeup(&hcd
->self
.root_hub
->dev
)
402 && wValue
== USB_DEVICE_REMOTE_WAKEUP
)
403 device_set_wakeup_enable(&hcd
->self
.root_hub
->dev
, 1);
407 case DeviceRequest
| USB_REQ_GET_CONFIGURATION
:
411 case DeviceOutRequest
| USB_REQ_SET_CONFIGURATION
:
413 case DeviceRequest
| USB_REQ_GET_DESCRIPTOR
:
414 switch (wValue
& 0xff00) {
415 case USB_DT_DEVICE
<< 8:
416 if (hcd
->driver
->flags
& HCD_USB2
)
417 bufp
= usb2_rh_dev_descriptor
;
418 else if (hcd
->driver
->flags
& HCD_USB11
)
419 bufp
= usb11_rh_dev_descriptor
;
424 case USB_DT_CONFIG
<< 8:
425 if (hcd
->driver
->flags
& HCD_USB2
) {
426 bufp
= hs_rh_config_descriptor
;
427 len
= sizeof hs_rh_config_descriptor
;
429 bufp
= fs_rh_config_descriptor
;
430 len
= sizeof fs_rh_config_descriptor
;
432 if (device_can_wakeup(&hcd
->self
.root_hub
->dev
))
435 case USB_DT_STRING
<< 8:
436 n
= rh_string (wValue
& 0xff, hcd
, ubuf
, wLength
);
439 urb
->actual_length
= n
;
445 case DeviceRequest
| USB_REQ_GET_INTERFACE
:
449 case DeviceOutRequest
| USB_REQ_SET_INTERFACE
:
451 case DeviceOutRequest
| USB_REQ_SET_ADDRESS
:
452 // wValue == urb->dev->devaddr
453 dev_dbg (hcd
->self
.controller
, "root hub device address %d\n",
457 /* INTERFACE REQUESTS (no defined feature/status flags) */
459 /* ENDPOINT REQUESTS */
461 case EndpointRequest
| USB_REQ_GET_STATUS
:
462 // ENDPOINT_HALT flag
467 case EndpointOutRequest
| USB_REQ_CLEAR_FEATURE
:
468 case EndpointOutRequest
| USB_REQ_SET_FEATURE
:
469 dev_dbg (hcd
->self
.controller
, "no endpoint features yet\n");
472 /* CLASS REQUESTS (and errors) */
475 /* non-generic request */
481 case GetHubDescriptor
:
482 len
= sizeof (struct usb_hub_descriptor
);
485 status
= hcd
->driver
->hub_control (hcd
,
486 typeReq
, wValue
, wIndex
,
490 /* "protocol stall" on error */
496 if (status
!= -EPIPE
) {
497 dev_dbg (hcd
->self
.controller
,
498 "CTRL: TypeReq=0x%x val=0x%x "
499 "idx=0x%x len=%d ==> %d\n",
500 typeReq
, wValue
, wIndex
,
505 if (urb
->transfer_buffer_length
< len
)
506 len
= urb
->transfer_buffer_length
;
507 urb
->actual_length
= len
;
508 // always USB_DIR_IN, toward host
509 memcpy (ubuf
, bufp
, len
);
511 /* report whether RH hardware supports remote wakeup */
513 len
> offsetof (struct usb_config_descriptor
,
515 ((struct usb_config_descriptor
*)ubuf
)->bmAttributes
516 |= USB_CONFIG_ATT_WAKEUP
;
519 /* any errors get returned through the urb completion */
520 local_irq_save (flags
);
521 spin_lock (&urb
->lock
);
522 if (urb
->status
== -EINPROGRESS
)
523 urb
->status
= status
;
524 spin_unlock (&urb
->lock
);
525 usb_hcd_giveback_urb (hcd
, urb
);
526 local_irq_restore (flags
);
530 /*-------------------------------------------------------------------------*/
533 * Root Hub interrupt transfers are polled using a timer if the
534 * driver requests it; otherwise the driver is responsible for
535 * calling usb_hcd_poll_rh_status() when an event occurs.
537 * Completions are called in_interrupt(), but they may or may not
540 void usb_hcd_poll_rh_status(struct usb_hcd
*hcd
)
545 char buffer
[4]; /* Any root hubs with > 31 ports? */
547 if (unlikely(!hcd
->rh_registered
))
549 if (!hcd
->uses_new_polling
&& !hcd
->status_urb
)
552 length
= hcd
->driver
->hub_status_data(hcd
, buffer
);
555 /* try to complete the status urb */
556 local_irq_save (flags
);
557 spin_lock(&hcd_root_hub_lock
);
558 urb
= hcd
->status_urb
;
560 spin_lock(&urb
->lock
);
561 if (urb
->status
== -EINPROGRESS
) {
562 hcd
->poll_pending
= 0;
563 hcd
->status_urb
= NULL
;
566 urb
->actual_length
= length
;
567 memcpy(urb
->transfer_buffer
, buffer
, length
);
568 } else /* urb has been unlinked */
570 spin_unlock(&urb
->lock
);
573 spin_unlock(&hcd_root_hub_lock
);
575 /* local irqs are always blocked in completions */
577 usb_hcd_giveback_urb (hcd
, urb
);
579 hcd
->poll_pending
= 1;
580 local_irq_restore (flags
);
583 /* The USB 2.0 spec says 256 ms. This is close enough and won't
584 * exceed that limit if HZ is 100. */
585 if (hcd
->uses_new_polling
? hcd
->poll_rh
:
586 (length
== 0 && hcd
->status_urb
!= NULL
))
587 mod_timer (&hcd
->rh_timer
, jiffies
+ msecs_to_jiffies(250));
589 EXPORT_SYMBOL_GPL(usb_hcd_poll_rh_status
);
592 static void rh_timer_func (unsigned long _hcd
)
594 usb_hcd_poll_rh_status((struct usb_hcd
*) _hcd
);
597 /*-------------------------------------------------------------------------*/
599 static int rh_queue_status (struct usb_hcd
*hcd
, struct urb
*urb
)
603 int len
= 1 + (urb
->dev
->maxchild
/ 8);
605 spin_lock_irqsave (&hcd_root_hub_lock
, flags
);
606 if (urb
->status
!= -EINPROGRESS
) /* already unlinked */
607 retval
= urb
->status
;
608 else if (hcd
->status_urb
|| urb
->transfer_buffer_length
< len
) {
609 dev_dbg (hcd
->self
.controller
, "not queuing rh status urb\n");
612 hcd
->status_urb
= urb
;
613 urb
->hcpriv
= hcd
; /* indicate it's queued */
615 if (!hcd
->uses_new_polling
)
616 mod_timer (&hcd
->rh_timer
, jiffies
+
617 msecs_to_jiffies(250));
619 /* If a status change has already occurred, report it ASAP */
620 else if (hcd
->poll_pending
)
621 mod_timer (&hcd
->rh_timer
, jiffies
);
624 spin_unlock_irqrestore (&hcd_root_hub_lock
, flags
);
628 static int rh_urb_enqueue (struct usb_hcd
*hcd
, struct urb
*urb
)
630 if (usb_pipeint (urb
->pipe
))
631 return rh_queue_status (hcd
, urb
);
632 if (usb_pipecontrol (urb
->pipe
))
633 return rh_call_control (hcd
, urb
);
637 /*-------------------------------------------------------------------------*/
639 /* Unlinks of root-hub control URBs are legal, but they don't do anything
640 * since these URBs always execute synchronously.
642 static int usb_rh_urb_dequeue (struct usb_hcd
*hcd
, struct urb
*urb
)
646 if (usb_pipeendpoint(urb
->pipe
) == 0) { /* Control URB */
649 } else { /* Status URB */
650 if (!hcd
->uses_new_polling
)
651 del_timer (&hcd
->rh_timer
);
652 local_irq_save (flags
);
653 spin_lock (&hcd_root_hub_lock
);
654 if (urb
== hcd
->status_urb
) {
655 hcd
->status_urb
= NULL
;
658 urb
= NULL
; /* wasn't fully queued */
659 spin_unlock (&hcd_root_hub_lock
);
661 usb_hcd_giveback_urb (hcd
, urb
);
662 local_irq_restore (flags
);
668 /*-------------------------------------------------------------------------*/
670 static struct class *usb_host_class
;
672 int usb_host_init(void)
676 usb_host_class
= class_create(THIS_MODULE
, "usb_host");
677 if (IS_ERR(usb_host_class
))
678 retval
= PTR_ERR(usb_host_class
);
682 void usb_host_cleanup(void)
684 class_destroy(usb_host_class
);
688 * usb_bus_init - shared initialization code
689 * @bus: the bus structure being initialized
691 * This code is used to initialize a usb_bus structure, memory for which is
692 * separately managed.
694 static void usb_bus_init (struct usb_bus
*bus
)
696 memset (&bus
->devmap
, 0, sizeof(struct usb_devmap
));
698 bus
->devnum_next
= 1;
700 bus
->root_hub
= NULL
;
702 bus
->bandwidth_allocated
= 0;
703 bus
->bandwidth_int_reqs
= 0;
704 bus
->bandwidth_isoc_reqs
= 0;
706 INIT_LIST_HEAD (&bus
->bus_list
);
709 /*-------------------------------------------------------------------------*/
712 * usb_register_bus - registers the USB host controller with the usb core
713 * @bus: pointer to the bus to register
714 * Context: !in_interrupt()
716 * Assigns a bus number, and links the controller into usbcore data
717 * structures so that it can be seen by scanning the bus list.
719 static int usb_register_bus(struct usb_bus
*bus
)
723 mutex_lock(&usb_bus_list_lock
);
724 busnum
= find_next_zero_bit (busmap
.busmap
, USB_MAXBUS
, 1);
725 if (busnum
< USB_MAXBUS
) {
726 set_bit (busnum
, busmap
.busmap
);
727 bus
->busnum
= busnum
;
729 printk (KERN_ERR
"%s: too many buses\n", usbcore_name
);
730 mutex_unlock(&usb_bus_list_lock
);
734 bus
->class_dev
= class_device_create(usb_host_class
, NULL
, MKDEV(0,0),
735 bus
->controller
, "usb_host%d", busnum
);
736 if (IS_ERR(bus
->class_dev
)) {
737 clear_bit(busnum
, busmap
.busmap
);
738 mutex_unlock(&usb_bus_list_lock
);
739 return PTR_ERR(bus
->class_dev
);
742 class_set_devdata(bus
->class_dev
, bus
);
744 /* Add it to the local list of buses */
745 list_add (&bus
->bus_list
, &usb_bus_list
);
746 mutex_unlock(&usb_bus_list_lock
);
748 usb_notify_add_bus(bus
);
750 dev_info (bus
->controller
, "new USB bus registered, assigned bus number %d\n", bus
->busnum
);
755 * usb_deregister_bus - deregisters the USB host controller
756 * @bus: pointer to the bus to deregister
757 * Context: !in_interrupt()
759 * Recycles the bus number, and unlinks the controller from usbcore data
760 * structures so that it won't be seen by scanning the bus list.
762 static void usb_deregister_bus (struct usb_bus
*bus
)
764 dev_info (bus
->controller
, "USB bus %d deregistered\n", bus
->busnum
);
767 * NOTE: make sure that all the devices are removed by the
768 * controller code, as well as having it call this when cleaning
771 mutex_lock(&usb_bus_list_lock
);
772 list_del (&bus
->bus_list
);
773 mutex_unlock(&usb_bus_list_lock
);
775 usb_notify_remove_bus(bus
);
777 clear_bit (bus
->busnum
, busmap
.busmap
);
779 class_device_unregister(bus
->class_dev
);
783 * register_root_hub - called by usb_add_hcd() to register a root hub
784 * @hcd: host controller for this root hub
786 * This function registers the root hub with the USB subsystem. It sets up
787 * the device properly in the device tree and then calls usb_new_device()
788 * to register the usb device. It also assigns the root hub's USB address
791 static int register_root_hub(struct usb_hcd
*hcd
)
793 struct device
*parent_dev
= hcd
->self
.controller
;
794 struct usb_device
*usb_dev
= hcd
->self
.root_hub
;
795 const int devnum
= 1;
798 usb_dev
->devnum
= devnum
;
799 usb_dev
->bus
->devnum_next
= devnum
+ 1;
800 memset (&usb_dev
->bus
->devmap
.devicemap
, 0,
801 sizeof usb_dev
->bus
->devmap
.devicemap
);
802 set_bit (devnum
, usb_dev
->bus
->devmap
.devicemap
);
803 usb_set_device_state(usb_dev
, USB_STATE_ADDRESS
);
805 mutex_lock(&usb_bus_list_lock
);
807 usb_dev
->ep0
.desc
.wMaxPacketSize
= __constant_cpu_to_le16(64);
808 retval
= usb_get_device_descriptor(usb_dev
, USB_DT_DEVICE_SIZE
);
809 if (retval
!= sizeof usb_dev
->descriptor
) {
810 mutex_unlock(&usb_bus_list_lock
);
811 dev_dbg (parent_dev
, "can't read %s device descriptor %d\n",
812 usb_dev
->dev
.bus_id
, retval
);
813 return (retval
< 0) ? retval
: -EMSGSIZE
;
816 retval
= usb_new_device (usb_dev
);
818 dev_err (parent_dev
, "can't register root hub for %s, %d\n",
819 usb_dev
->dev
.bus_id
, retval
);
821 mutex_unlock(&usb_bus_list_lock
);
824 spin_lock_irq (&hcd_root_hub_lock
);
825 hcd
->rh_registered
= 1;
826 spin_unlock_irq (&hcd_root_hub_lock
);
828 /* Did the HC die before the root hub was registered? */
829 if (hcd
->state
== HC_STATE_HALT
)
830 usb_hc_died (hcd
); /* This time clean up */
836 void usb_enable_root_hub_irq (struct usb_bus
*bus
)
840 hcd
= container_of (bus
, struct usb_hcd
, self
);
841 if (hcd
->driver
->hub_irq_enable
&& hcd
->state
!= HC_STATE_HALT
)
842 hcd
->driver
->hub_irq_enable (hcd
);
846 /*-------------------------------------------------------------------------*/
849 * usb_calc_bus_time - approximate periodic transaction time in nanoseconds
850 * @speed: from dev->speed; USB_SPEED_{LOW,FULL,HIGH}
851 * @is_input: true iff the transaction sends data to the host
852 * @isoc: true for isochronous transactions, false for interrupt ones
853 * @bytecount: how many bytes in the transaction.
855 * Returns approximate bus time in nanoseconds for a periodic transaction.
856 * See USB 2.0 spec section 5.11.3; only periodic transfers need to be
857 * scheduled in software, this function is only used for such scheduling.
859 long usb_calc_bus_time (int speed
, int is_input
, int isoc
, int bytecount
)
864 case USB_SPEED_LOW
: /* INTR only */
866 tmp
= (67667L * (31L + 10L * BitTime (bytecount
))) / 1000L;
867 return (64060L + (2 * BW_HUB_LS_SETUP
) + BW_HOST_DELAY
+ tmp
);
869 tmp
= (66700L * (31L + 10L * BitTime (bytecount
))) / 1000L;
870 return (64107L + (2 * BW_HUB_LS_SETUP
) + BW_HOST_DELAY
+ tmp
);
872 case USB_SPEED_FULL
: /* ISOC or INTR */
874 tmp
= (8354L * (31L + 10L * BitTime (bytecount
))) / 1000L;
875 return (((is_input
) ? 7268L : 6265L) + BW_HOST_DELAY
+ tmp
);
877 tmp
= (8354L * (31L + 10L * BitTime (bytecount
))) / 1000L;
878 return (9107L + BW_HOST_DELAY
+ tmp
);
880 case USB_SPEED_HIGH
: /* ISOC or INTR */
881 // FIXME adjust for input vs output
883 tmp
= HS_NSECS_ISO (bytecount
);
885 tmp
= HS_NSECS (bytecount
);
888 pr_debug ("%s: bogus device speed!\n", usbcore_name
);
892 EXPORT_SYMBOL (usb_calc_bus_time
);
895 /*-------------------------------------------------------------------------*/
898 * Generic HC operations.
901 /*-------------------------------------------------------------------------*/
903 static void urb_unlink (struct urb
*urb
)
907 /* clear all state linking urb to this dev (and hcd) */
909 spin_lock_irqsave (&hcd_data_lock
, flags
);
910 list_del_init (&urb
->urb_list
);
911 spin_unlock_irqrestore (&hcd_data_lock
, flags
);
915 /* may be called in any context with a valid urb->dev usecount
916 * caller surrenders "ownership" of urb
917 * expects usb_submit_urb() to have sanity checked and conditioned all
920 int usb_hcd_submit_urb (struct urb
*urb
, gfp_t mem_flags
)
923 struct usb_hcd
*hcd
= bus_to_hcd(urb
->dev
->bus
);
924 struct usb_host_endpoint
*ep
;
930 usbmon_urb_submit(&hcd
->self
, urb
);
933 * Atomically queue the urb, first to our records, then to the HCD.
934 * Access to urb->status is controlled by urb->lock ... changes on
935 * i/o completion (normal or fault) or unlinking.
938 // FIXME: verify that quiescing hc works right (RH cleans up)
940 spin_lock_irqsave (&hcd_data_lock
, flags
);
941 ep
= (usb_pipein(urb
->pipe
) ? urb
->dev
->ep_in
: urb
->dev
->ep_out
)
942 [usb_pipeendpoint(urb
->pipe
)];
945 else if (unlikely (urb
->reject
))
947 else switch (hcd
->state
) {
948 case HC_STATE_RUNNING
:
949 case HC_STATE_RESUMING
:
951 list_add_tail (&urb
->urb_list
, &ep
->urb_list
);
954 case HC_STATE_SUSPENDED
:
955 /* HC upstream links (register access, wakeup signaling) can work
956 * even when the downstream links (and DMA etc) are quiesced; let
957 * usbcore talk to the root hub.
959 if (hcd
->self
.controller
->power
.power_state
.event
== PM_EVENT_ON
960 && urb
->dev
->parent
== NULL
)
967 spin_unlock_irqrestore (&hcd_data_lock
, flags
);
969 INIT_LIST_HEAD (&urb
->urb_list
);
970 usbmon_urb_submit_error(&hcd
->self
, urb
, status
);
974 /* increment urb's reference count as part of giving it to the HCD
975 * (which now controls it). HCD guarantees that it either returns
976 * an error or calls giveback(), but not both.
978 urb
= usb_get_urb (urb
);
979 atomic_inc (&urb
->use_count
);
981 if (urb
->dev
== hcd
->self
.root_hub
) {
982 /* NOTE: requirement on hub callers (usbfs and the hub
983 * driver, for now) that URBs' urb->transfer_buffer be
984 * valid and usb_buffer_{sync,unmap}() not be needed, since
985 * they could clobber root hub response data.
987 status
= rh_urb_enqueue (hcd
, urb
);
991 /* lower level hcd code should use *_dma exclusively,
992 * unless it uses pio or talks to another transport.
994 if (hcd
->self
.uses_dma
) {
995 if (usb_pipecontrol (urb
->pipe
)
996 && !(urb
->transfer_flags
& URB_NO_SETUP_DMA_MAP
))
997 urb
->setup_dma
= dma_map_single (
998 hcd
->self
.controller
,
1000 sizeof (struct usb_ctrlrequest
),
1002 if (urb
->transfer_buffer_length
!= 0
1003 && !(urb
->transfer_flags
& URB_NO_TRANSFER_DMA_MAP
))
1004 urb
->transfer_dma
= dma_map_single (
1005 hcd
->self
.controller
,
1006 urb
->transfer_buffer
,
1007 urb
->transfer_buffer_length
,
1008 usb_pipein (urb
->pipe
)
1013 status
= hcd
->driver
->urb_enqueue (hcd
, ep
, urb
, mem_flags
);
1015 if (unlikely (status
)) {
1017 atomic_dec (&urb
->use_count
);
1019 wake_up (&usb_kill_urb_queue
);
1021 usbmon_urb_submit_error(&hcd
->self
, urb
, status
);
1026 /*-------------------------------------------------------------------------*/
1028 /* called in any context */
1029 int usb_hcd_get_frame_number (struct usb_device
*udev
)
1031 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
1033 if (!HC_IS_RUNNING (hcd
->state
))
1035 return hcd
->driver
->get_frame_number (hcd
);
1038 /*-------------------------------------------------------------------------*/
1040 /* this makes the hcd giveback() the urb more quickly, by kicking it
1041 * off hardware queues (which may take a while) and returning it as
1042 * soon as practical. we've already set up the urb's return status,
1043 * but we can't know if the callback completed already.
1046 unlink1 (struct usb_hcd
*hcd
, struct urb
*urb
)
1050 if (urb
->dev
== hcd
->self
.root_hub
)
1051 value
= usb_rh_urb_dequeue (hcd
, urb
);
1054 /* The only reason an HCD might fail this call is if
1055 * it has not yet fully queued the urb to begin with.
1056 * Such failures should be harmless. */
1057 value
= hcd
->driver
->urb_dequeue (hcd
, urb
);
1061 dev_dbg (hcd
->self
.controller
, "dequeue %p --> %d\n",
1067 * called in any context
1069 * caller guarantees urb won't be recycled till both unlink()
1070 * and the urb's completion function return
1072 int usb_hcd_unlink_urb (struct urb
*urb
, int status
)
1074 struct usb_host_endpoint
*ep
;
1075 struct usb_hcd
*hcd
= NULL
;
1076 struct device
*sys
= NULL
;
1077 unsigned long flags
;
1078 struct list_head
*tmp
;
1083 if (!urb
->dev
|| !urb
->dev
->bus
)
1085 ep
= (usb_pipein(urb
->pipe
) ? urb
->dev
->ep_in
: urb
->dev
->ep_out
)
1086 [usb_pipeendpoint(urb
->pipe
)];
1091 * we contend for urb->status with the hcd core,
1092 * which changes it while returning the urb.
1094 * Caller guaranteed that the urb pointer hasn't been freed, and
1095 * that it was submitted. But as a rule it can't know whether or
1096 * not it's already been unlinked ... so we respect the reversed
1097 * lock sequence needed for the usb_hcd_giveback_urb() code paths
1098 * (urb lock, then hcd_data_lock) in case some other CPU is now
1101 spin_lock_irqsave (&urb
->lock
, flags
);
1102 spin_lock (&hcd_data_lock
);
1104 sys
= &urb
->dev
->dev
;
1105 hcd
= bus_to_hcd(urb
->dev
->bus
);
1111 /* insist the urb is still queued */
1112 list_for_each(tmp
, &ep
->urb_list
) {
1113 if (tmp
== &urb
->urb_list
)
1116 if (tmp
!= &urb
->urb_list
) {
1121 /* Any status except -EINPROGRESS means something already started to
1122 * unlink this URB from the hardware. So there's no more work to do.
1124 if (urb
->status
!= -EINPROGRESS
) {
1129 /* IRQ setup can easily be broken so that USB controllers
1130 * never get completion IRQs ... maybe even the ones we need to
1131 * finish unlinking the initial failed usb_set_address()
1132 * or device descriptor fetch.
1134 if (!test_bit(HCD_FLAG_SAW_IRQ
, &hcd
->flags
)
1135 && hcd
->self
.root_hub
!= urb
->dev
) {
1136 dev_warn (hcd
->self
.controller
, "Unlink after no-IRQ? "
1137 "Controller is probably using the wrong IRQ."
1139 set_bit(HCD_FLAG_SAW_IRQ
, &hcd
->flags
);
1142 urb
->status
= status
;
1144 spin_unlock (&hcd_data_lock
);
1145 spin_unlock_irqrestore (&urb
->lock
, flags
);
1147 retval
= unlink1 (hcd
, urb
);
1149 retval
= -EINPROGRESS
;
1153 spin_unlock (&hcd_data_lock
);
1154 spin_unlock_irqrestore (&urb
->lock
, flags
);
1155 if (retval
!= -EIDRM
&& sys
&& sys
->driver
)
1156 dev_dbg (sys
, "hcd_unlink_urb %p fail %d\n", urb
, retval
);
1160 /*-------------------------------------------------------------------------*/
1162 /* disables the endpoint: cancels any pending urbs, then synchronizes with
1163 * the hcd to make sure all endpoint state is gone from hardware, and then
1164 * waits until the endpoint's queue is completely drained. use for
1165 * set_configuration, set_interface, driver removal, physical disconnect.
1167 * example: a qh stored in ep->hcpriv, holding state related to endpoint
1168 * type, maxpacket size, toggle, halt status, and scheduling.
1170 void usb_hcd_endpoint_disable (struct usb_device
*udev
,
1171 struct usb_host_endpoint
*ep
)
1173 struct usb_hcd
*hcd
;
1176 hcd
= bus_to_hcd(udev
->bus
);
1178 WARN_ON (!HC_IS_RUNNING (hcd
->state
) && hcd
->state
!= HC_STATE_HALT
&&
1179 udev
->state
!= USB_STATE_NOTATTACHED
);
1181 local_irq_disable ();
1183 /* ep is already gone from udev->ep_{in,out}[]; no more submits */
1185 spin_lock (&hcd_data_lock
);
1186 list_for_each_entry (urb
, &ep
->urb_list
, urb_list
) {
1189 /* the urb may already have been unlinked */
1190 if (urb
->status
!= -EINPROGRESS
)
1193 spin_unlock (&hcd_data_lock
);
1195 spin_lock (&urb
->lock
);
1197 if (tmp
== -EINPROGRESS
)
1198 urb
->status
= -ESHUTDOWN
;
1199 spin_unlock (&urb
->lock
);
1201 /* kick hcd unless it's already returning this */
1202 if (tmp
== -EINPROGRESS
) {
1205 dev_dbg (hcd
->self
.controller
,
1206 "shutdown urb %p pipe %08x ep%d%s%s\n",
1207 urb
, tmp
, usb_pipeendpoint (tmp
),
1208 (tmp
& USB_DIR_IN
) ? "in" : "out",
1210 switch (usb_pipetype (tmp
)) { \
1211 case PIPE_CONTROL
: s
= ""; break; \
1212 case PIPE_BULK
: s
= "-bulk"; break; \
1213 case PIPE_INTERRUPT
: s
= "-intr"; break; \
1214 default: s
= "-iso"; break; \
1219 /* list contents may have changed */
1222 spin_unlock (&hcd_data_lock
);
1223 local_irq_enable ();
1225 /* synchronize with the hardware, so old configuration state
1226 * clears out immediately (and will be freed).
1229 if (hcd
->driver
->endpoint_disable
)
1230 hcd
->driver
->endpoint_disable (hcd
, ep
);
1232 /* Wait until the endpoint queue is completely empty. Most HCDs
1233 * will have done this already in their endpoint_disable method,
1234 * but some might not. And there could be root-hub control URBs
1235 * still pending since they aren't affected by the HCDs'
1236 * endpoint_disable methods.
1238 while (!list_empty (&ep
->urb_list
)) {
1239 spin_lock_irq (&hcd_data_lock
);
1241 /* The list may have changed while we acquired the spinlock */
1243 if (!list_empty (&ep
->urb_list
)) {
1244 urb
= list_entry (ep
->urb_list
.prev
, struct urb
,
1248 spin_unlock_irq (&hcd_data_lock
);
1257 /*-------------------------------------------------------------------------*/
1261 int hcd_bus_suspend (struct usb_bus
*bus
)
1263 struct usb_hcd
*hcd
;
1266 hcd
= container_of (bus
, struct usb_hcd
, self
);
1267 if (!hcd
->driver
->bus_suspend
)
1269 hcd
->state
= HC_STATE_QUIESCING
;
1270 status
= hcd
->driver
->bus_suspend (hcd
);
1272 hcd
->state
= HC_STATE_SUSPENDED
;
1274 dev_dbg(&bus
->root_hub
->dev
, "%s fail, err %d\n",
1279 int hcd_bus_resume (struct usb_bus
*bus
)
1281 struct usb_hcd
*hcd
;
1284 hcd
= container_of (bus
, struct usb_hcd
, self
);
1285 if (!hcd
->driver
->bus_resume
)
1287 if (hcd
->state
== HC_STATE_RUNNING
)
1289 hcd
->state
= HC_STATE_RESUMING
;
1290 status
= hcd
->driver
->bus_resume (hcd
);
1292 hcd
->state
= HC_STATE_RUNNING
;
1294 dev_dbg(&bus
->root_hub
->dev
, "%s fail, err %d\n",
1302 * usb_hcd_resume_root_hub - called by HCD to resume its root hub
1303 * @hcd: host controller for this root hub
1305 * The USB host controller calls this function when its root hub is
1306 * suspended (with the remote wakeup feature enabled) and a remote
1307 * wakeup request is received. It queues a request for khubd to
1308 * resume the root hub (that is, manage its downstream ports again).
1310 void usb_hcd_resume_root_hub (struct usb_hcd
*hcd
)
1312 unsigned long flags
;
1314 spin_lock_irqsave (&hcd_root_hub_lock
, flags
);
1315 if (hcd
->rh_registered
)
1316 usb_resume_root_hub (hcd
->self
.root_hub
);
1317 spin_unlock_irqrestore (&hcd_root_hub_lock
, flags
);
1319 EXPORT_SYMBOL_GPL(usb_hcd_resume_root_hub
);
1323 /*-------------------------------------------------------------------------*/
1325 #ifdef CONFIG_USB_OTG
1328 * usb_bus_start_enum - start immediate enumeration (for OTG)
1329 * @bus: the bus (must use hcd framework)
1330 * @port_num: 1-based number of port; usually bus->otg_port
1331 * Context: in_interrupt()
1333 * Starts enumeration, with an immediate reset followed later by
1334 * khubd identifying and possibly configuring the device.
1335 * This is needed by OTG controller drivers, where it helps meet
1336 * HNP protocol timing requirements for starting a port reset.
1338 int usb_bus_start_enum(struct usb_bus
*bus
, unsigned port_num
)
1340 struct usb_hcd
*hcd
;
1341 int status
= -EOPNOTSUPP
;
1343 /* NOTE: since HNP can't start by grabbing the bus's address0_sem,
1344 * boards with root hubs hooked up to internal devices (instead of
1345 * just the OTG port) may need more attention to resetting...
1347 hcd
= container_of (bus
, struct usb_hcd
, self
);
1348 if (port_num
&& hcd
->driver
->start_port_reset
)
1349 status
= hcd
->driver
->start_port_reset(hcd
, port_num
);
1351 /* run khubd shortly after (first) root port reset finishes;
1352 * it may issue others, until at least 50 msecs have passed.
1355 mod_timer(&hcd
->rh_timer
, jiffies
+ msecs_to_jiffies(10));
1358 EXPORT_SYMBOL (usb_bus_start_enum
);
1362 /*-------------------------------------------------------------------------*/
1365 * usb_hcd_giveback_urb - return URB from HCD to device driver
1366 * @hcd: host controller returning the URB
1367 * @urb: urb being returned to the USB device driver.
1368 * Context: in_interrupt()
1370 * This hands the URB from HCD to its USB device driver, using its
1371 * completion function. The HCD has freed all per-urb resources
1372 * (and is done using urb->hcpriv). It also released all HCD locks;
1373 * the device driver won't cause problems if it frees, modifies,
1374 * or resubmits this URB.
1376 void usb_hcd_giveback_urb (struct usb_hcd
*hcd
, struct urb
*urb
)
1380 at_root_hub
= (urb
->dev
== hcd
->self
.root_hub
);
1383 /* lower level hcd code should use *_dma exclusively if the
1384 * host controller does DMA */
1385 if (hcd
->self
.uses_dma
&& !at_root_hub
) {
1386 if (usb_pipecontrol (urb
->pipe
)
1387 && !(urb
->transfer_flags
& URB_NO_SETUP_DMA_MAP
))
1388 dma_unmap_single (hcd
->self
.controller
, urb
->setup_dma
,
1389 sizeof (struct usb_ctrlrequest
),
1391 if (urb
->transfer_buffer_length
!= 0
1392 && !(urb
->transfer_flags
& URB_NO_TRANSFER_DMA_MAP
))
1393 dma_unmap_single (hcd
->self
.controller
,
1395 urb
->transfer_buffer_length
,
1396 usb_pipein (urb
->pipe
)
1401 usbmon_urb_complete (&hcd
->self
, urb
);
1402 /* pass ownership to the completion handler */
1403 urb
->complete (urb
);
1404 atomic_dec (&urb
->use_count
);
1405 if (unlikely (urb
->reject
))
1406 wake_up (&usb_kill_urb_queue
);
1409 EXPORT_SYMBOL (usb_hcd_giveback_urb
);
1411 /*-------------------------------------------------------------------------*/
1414 * usb_hcd_irq - hook IRQs to HCD framework (bus glue)
1415 * @irq: the IRQ being raised
1416 * @__hcd: pointer to the HCD whose IRQ is being signaled
1417 * @r: saved hardware registers
1419 * If the controller isn't HALTed, calls the driver's irq handler.
1420 * Checks whether the controller is now dead.
1422 irqreturn_t
usb_hcd_irq (int irq
, void *__hcd
)
1424 struct usb_hcd
*hcd
= __hcd
;
1425 int start
= hcd
->state
;
1427 if (unlikely(start
== HC_STATE_HALT
||
1428 !test_bit(HCD_FLAG_HW_ACCESSIBLE
, &hcd
->flags
)))
1430 if (hcd
->driver
->irq (hcd
) == IRQ_NONE
)
1433 set_bit(HCD_FLAG_SAW_IRQ
, &hcd
->flags
);
1435 if (unlikely(hcd
->state
== HC_STATE_HALT
))
1440 /*-------------------------------------------------------------------------*/
1443 * usb_hc_died - report abnormal shutdown of a host controller (bus glue)
1444 * @hcd: pointer to the HCD representing the controller
1446 * This is called by bus glue to report a USB host controller that died
1447 * while operations may still have been pending. It's called automatically
1448 * by the PCI glue, so only glue for non-PCI busses should need to call it.
1450 void usb_hc_died (struct usb_hcd
*hcd
)
1452 unsigned long flags
;
1454 dev_err (hcd
->self
.controller
, "HC died; cleaning up\n");
1456 spin_lock_irqsave (&hcd_root_hub_lock
, flags
);
1457 if (hcd
->rh_registered
) {
1460 /* make khubd clean up old urbs and devices */
1461 usb_set_device_state (hcd
->self
.root_hub
,
1462 USB_STATE_NOTATTACHED
);
1463 usb_kick_khubd (hcd
->self
.root_hub
);
1465 spin_unlock_irqrestore (&hcd_root_hub_lock
, flags
);
1467 EXPORT_SYMBOL_GPL (usb_hc_died
);
1469 /*-------------------------------------------------------------------------*/
1472 * usb_create_hcd - create and initialize an HCD structure
1473 * @driver: HC driver that will use this hcd
1474 * @dev: device for this HC, stored in hcd->self.controller
1475 * @bus_name: value to store in hcd->self.bus_name
1476 * Context: !in_interrupt()
1478 * Allocate a struct usb_hcd, with extra space at the end for the
1479 * HC driver's private data. Initialize the generic members of the
1482 * If memory is unavailable, returns NULL.
1484 struct usb_hcd
*usb_create_hcd (const struct hc_driver
*driver
,
1485 struct device
*dev
, char *bus_name
)
1487 struct usb_hcd
*hcd
;
1489 hcd
= kzalloc(sizeof(*hcd
) + driver
->hcd_priv_size
, GFP_KERNEL
);
1491 dev_dbg (dev
, "hcd alloc failed\n");
1494 dev_set_drvdata(dev
, hcd
);
1495 kref_init(&hcd
->kref
);
1497 usb_bus_init(&hcd
->self
);
1498 hcd
->self
.controller
= dev
;
1499 hcd
->self
.bus_name
= bus_name
;
1500 hcd
->self
.uses_dma
= (dev
->dma_mask
!= NULL
);
1502 init_timer(&hcd
->rh_timer
);
1503 hcd
->rh_timer
.function
= rh_timer_func
;
1504 hcd
->rh_timer
.data
= (unsigned long) hcd
;
1506 hcd
->driver
= driver
;
1507 hcd
->product_desc
= (driver
->product_desc
) ? driver
->product_desc
:
1508 "USB Host Controller";
1512 EXPORT_SYMBOL (usb_create_hcd
);
1514 static void hcd_release (struct kref
*kref
)
1516 struct usb_hcd
*hcd
= container_of (kref
, struct usb_hcd
, kref
);
1521 struct usb_hcd
*usb_get_hcd (struct usb_hcd
*hcd
)
1524 kref_get (&hcd
->kref
);
1527 EXPORT_SYMBOL (usb_get_hcd
);
1529 void usb_put_hcd (struct usb_hcd
*hcd
)
1532 kref_put (&hcd
->kref
, hcd_release
);
1534 EXPORT_SYMBOL (usb_put_hcd
);
1537 * usb_add_hcd - finish generic HCD structure initialization and register
1538 * @hcd: the usb_hcd structure to initialize
1539 * @irqnum: Interrupt line to allocate
1540 * @irqflags: Interrupt type flags
1542 * Finish the remaining parts of generic HCD initialization: allocate the
1543 * buffers of consistent memory, register the bus, request the IRQ line,
1544 * and call the driver's reset() and start() routines.
1546 int usb_add_hcd(struct usb_hcd
*hcd
,
1547 unsigned int irqnum
, unsigned long irqflags
)
1550 struct usb_device
*rhdev
;
1552 dev_info(hcd
->self
.controller
, "%s\n", hcd
->product_desc
);
1554 set_bit(HCD_FLAG_HW_ACCESSIBLE
, &hcd
->flags
);
1556 /* HC is in reset state, but accessible. Now do the one-time init,
1557 * bottom up so that hcds can customize the root hubs before khubd
1558 * starts talking to them. (Note, bus id is assigned early too.)
1560 if ((retval
= hcd_buffer_create(hcd
)) != 0) {
1561 dev_dbg(hcd
->self
.controller
, "pool alloc failed\n");
1565 if ((retval
= usb_register_bus(&hcd
->self
)) < 0)
1566 goto err_register_bus
;
1568 if ((rhdev
= usb_alloc_dev(NULL
, &hcd
->self
, 0)) == NULL
) {
1569 dev_err(hcd
->self
.controller
, "unable to allocate root hub\n");
1571 goto err_allocate_root_hub
;
1573 rhdev
->speed
= (hcd
->driver
->flags
& HCD_USB2
) ? USB_SPEED_HIGH
:
1575 hcd
->self
.root_hub
= rhdev
;
1577 /* wakeup flag init defaults to "everything works" for root hubs,
1578 * but drivers can override it in reset() if needed, along with
1579 * recording the overall controller's system wakeup capability.
1581 device_init_wakeup(&rhdev
->dev
, 1);
1583 /* "reset" is misnamed; its role is now one-time init. the controller
1584 * should already have been reset (and boot firmware kicked off etc).
1586 if (hcd
->driver
->reset
&& (retval
= hcd
->driver
->reset(hcd
)) < 0) {
1587 dev_err(hcd
->self
.controller
, "can't setup\n");
1588 goto err_hcd_driver_setup
;
1591 /* NOTE: root hub and controller capabilities may not be the same */
1592 if (device_can_wakeup(hcd
->self
.controller
)
1593 && device_can_wakeup(&hcd
->self
.root_hub
->dev
))
1594 dev_dbg(hcd
->self
.controller
, "supports USB remote wakeup\n");
1596 /* enable irqs just before we start the controller */
1597 if (hcd
->driver
->irq
) {
1598 snprintf(hcd
->irq_descr
, sizeof(hcd
->irq_descr
), "%s:usb%d",
1599 hcd
->driver
->description
, hcd
->self
.busnum
);
1600 if ((retval
= request_irq(irqnum
, &usb_hcd_irq
, irqflags
,
1601 hcd
->irq_descr
, hcd
)) != 0) {
1602 dev_err(hcd
->self
.controller
,
1603 "request interrupt %d failed\n", irqnum
);
1604 goto err_request_irq
;
1607 dev_info(hcd
->self
.controller
, "irq %d, %s 0x%08llx\n", irqnum
,
1608 (hcd
->driver
->flags
& HCD_MEMORY
) ?
1609 "io mem" : "io base",
1610 (unsigned long long)hcd
->rsrc_start
);
1613 if (hcd
->rsrc_start
)
1614 dev_info(hcd
->self
.controller
, "%s 0x%08llx\n",
1615 (hcd
->driver
->flags
& HCD_MEMORY
) ?
1616 "io mem" : "io base",
1617 (unsigned long long)hcd
->rsrc_start
);
1620 if ((retval
= hcd
->driver
->start(hcd
)) < 0) {
1621 dev_err(hcd
->self
.controller
, "startup error %d\n", retval
);
1622 goto err_hcd_driver_start
;
1625 /* starting here, usbcore will pay attention to this root hub */
1626 rhdev
->bus_mA
= min(500u, hcd
->power_budget
);
1627 if ((retval
= register_root_hub(hcd
)) != 0)
1628 goto err_register_root_hub
;
1630 if (hcd
->uses_new_polling
&& hcd
->poll_rh
)
1631 usb_hcd_poll_rh_status(hcd
);
1634 err_register_root_hub
:
1635 hcd
->driver
->stop(hcd
);
1636 err_hcd_driver_start
:
1638 free_irq(irqnum
, hcd
);
1640 err_hcd_driver_setup
:
1641 hcd
->self
.root_hub
= NULL
;
1643 err_allocate_root_hub
:
1644 usb_deregister_bus(&hcd
->self
);
1646 hcd_buffer_destroy(hcd
);
1649 EXPORT_SYMBOL (usb_add_hcd
);
1652 * usb_remove_hcd - shutdown processing for generic HCDs
1653 * @hcd: the usb_hcd structure to remove
1654 * Context: !in_interrupt()
1656 * Disconnects the root hub, then reverses the effects of usb_add_hcd(),
1657 * invoking the HCD's stop() method.
1659 void usb_remove_hcd(struct usb_hcd
*hcd
)
1661 dev_info(hcd
->self
.controller
, "remove, state %x\n", hcd
->state
);
1663 if (HC_IS_RUNNING (hcd
->state
))
1664 hcd
->state
= HC_STATE_QUIESCING
;
1666 dev_dbg(hcd
->self
.controller
, "roothub graceful disconnect\n");
1667 spin_lock_irq (&hcd_root_hub_lock
);
1668 hcd
->rh_registered
= 0;
1669 spin_unlock_irq (&hcd_root_hub_lock
);
1671 mutex_lock(&usb_bus_list_lock
);
1672 usb_disconnect(&hcd
->self
.root_hub
);
1673 mutex_unlock(&usb_bus_list_lock
);
1675 hcd
->driver
->stop(hcd
);
1676 hcd
->state
= HC_STATE_HALT
;
1679 del_timer_sync(&hcd
->rh_timer
);
1682 free_irq(hcd
->irq
, hcd
);
1683 usb_deregister_bus(&hcd
->self
);
1684 hcd_buffer_destroy(hcd
);
1686 EXPORT_SYMBOL (usb_remove_hcd
);
1689 usb_hcd_platform_shutdown(struct platform_device
* dev
)
1691 struct usb_hcd
*hcd
= platform_get_drvdata(dev
);
1693 if (hcd
->driver
->shutdown
)
1694 hcd
->driver
->shutdown(hcd
);
1696 EXPORT_SYMBOL (usb_hcd_platform_shutdown
);
1698 /*-------------------------------------------------------------------------*/
1700 #if defined(CONFIG_USB_MON)
1702 struct usb_mon_operations
*mon_ops
;
1705 * The registration is unlocked.
1706 * We do it this way because we do not want to lock in hot paths.
1708 * Notice that the code is minimally error-proof. Because usbmon needs
1709 * symbols from usbcore, usbcore gets referenced and cannot be unloaded first.
1712 int usb_mon_register (struct usb_mon_operations
*ops
)
1722 EXPORT_SYMBOL_GPL (usb_mon_register
);
1724 void usb_mon_deregister (void)
1727 if (mon_ops
== NULL
) {
1728 printk(KERN_ERR
"USB: monitor was not registered\n");
1734 EXPORT_SYMBOL_GPL (usb_mon_deregister
);
1736 #endif /* CONFIG_USB_MON */