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;
364 spin_lock_irq(&hcd_root_hub_lock);
365 status = usb_hcd_link_urb_to_ep(hcd, urb);
366 spin_unlock_irq(&hcd_root_hub_lock);
370 cmd = (struct usb_ctrlrequest *) urb->setup_packet;
371 typeReq = (cmd->bRequestType << 8) | cmd->bRequest;
372 wValue = le16_to_cpu (cmd->wValue);
373 wIndex = le16_to_cpu (cmd->wIndex);
374 wLength = le16_to_cpu (cmd->wLength);
376 if (wLength > urb->transfer_buffer_length)
379 urb->actual_length = 0;
382 /* DEVICE REQUESTS */
384 /* The root hub's remote wakeup enable bit is implemented using
385 * driver model wakeup flags. If this system supports wakeup
386 * through USB, userspace may change the default "allow wakeup"
387 * policy through sysfs or these calls.
389 * Most root hubs support wakeup from downstream devices, for
390 * runtime power management (disabling USB clocks and reducing
391 * VBUS power usage). However, not all of them do so; silicon,
392 * board, and BIOS bugs here are not uncommon, so these can't
393 * be treated quite like external hubs.
395 * Likewise, not all root hubs will pass wakeup events upstream,
396 * to wake up the whole system. So don't assume root hub and
397 * controller capabilities are identical.
400 case DeviceRequest | USB_REQ_GET_STATUS:
401 tbuf [0] = (device_may_wakeup(&hcd->self.root_hub->dev)
402 << USB_DEVICE_REMOTE_WAKEUP)
403 | (1 << USB_DEVICE_SELF_POWERED);
407 case DeviceOutRequest | USB_REQ_CLEAR_FEATURE:
408 if (wValue == USB_DEVICE_REMOTE_WAKEUP)
409 device_set_wakeup_enable(&hcd->self.root_hub->dev, 0);
413 case DeviceOutRequest | USB_REQ_SET_FEATURE:
414 if (device_can_wakeup(&hcd->self.root_hub->dev)
415 && wValue == USB_DEVICE_REMOTE_WAKEUP)
416 device_set_wakeup_enable(&hcd->self.root_hub->dev, 1);
420 case DeviceRequest | USB_REQ_GET_CONFIGURATION:
424 case DeviceOutRequest | USB_REQ_SET_CONFIGURATION:
426 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
427 switch (wValue & 0xff00) {
428 case USB_DT_DEVICE << 8:
429 if (hcd->driver->flags & HCD_USB2)
430 bufp = usb2_rh_dev_descriptor;
431 else if (hcd->driver->flags & HCD_USB11)
432 bufp = usb11_rh_dev_descriptor;
437 case USB_DT_CONFIG << 8:
438 if (hcd->driver->flags & HCD_USB2) {
439 bufp = hs_rh_config_descriptor;
440 len = sizeof hs_rh_config_descriptor;
442 bufp = fs_rh_config_descriptor;
443 len = sizeof fs_rh_config_descriptor;
445 if (device_can_wakeup(&hcd->self.root_hub->dev))
448 case USB_DT_STRING << 8:
449 n = rh_string (wValue & 0xff, hcd, ubuf, wLength);
452 urb->actual_length = n;
458 case DeviceRequest | USB_REQ_GET_INTERFACE:
462 case DeviceOutRequest | USB_REQ_SET_INTERFACE:
464 case DeviceOutRequest | USB_REQ_SET_ADDRESS:
465 // wValue == urb->dev->devaddr
466 dev_dbg (hcd->self.controller, "root hub device address %d\n",
470 /* INTERFACE REQUESTS (no defined feature/status flags) */
472 /* ENDPOINT REQUESTS */
474 case EndpointRequest | USB_REQ_GET_STATUS:
475 // ENDPOINT_HALT flag
480 case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
481 case EndpointOutRequest | USB_REQ_SET_FEATURE:
482 dev_dbg (hcd->self.controller, "no endpoint features yet\n");
485 /* CLASS REQUESTS (and errors) */
488 /* non-generic request */
494 case GetHubDescriptor:
495 len = sizeof (struct usb_hub_descriptor);
498 status = hcd->driver->hub_control (hcd,
499 typeReq, wValue, wIndex,
503 /* "protocol stall" on error */
509 if (status != -EPIPE) {
510 dev_dbg (hcd->self.controller,
511 "CTRL: TypeReq=0x%x val=0x%x "
512 "idx=0x%x len=%d ==> %d\n",
513 typeReq, wValue, wIndex,
518 if (urb->transfer_buffer_length < len)
519 len = urb->transfer_buffer_length;
520 urb->actual_length = len;
521 // always USB_DIR_IN, toward host
522 memcpy (ubuf, bufp, len);
524 /* report whether RH hardware supports remote wakeup */
526 len > offsetof (struct usb_config_descriptor,
528 ((struct usb_config_descriptor *)ubuf)->bmAttributes
529 |= USB_CONFIG_ATT_WAKEUP;
532 /* any errors get returned through the urb completion */
533 spin_lock_irq(&hcd_root_hub_lock);
534 if (urb->status == -EINPROGRESS)
535 urb->status = status;
536 usb_hcd_unlink_urb_from_ep(hcd, urb);
538 /* This peculiar use of spinlocks echoes what real HC drivers do.
539 * Avoiding calls to local_irq_disable/enable makes the code
542 spin_unlock(&hcd_root_hub_lock);
543 usb_hcd_giveback_urb(hcd, urb);
544 spin_lock(&hcd_root_hub_lock);
546 spin_unlock_irq(&hcd_root_hub_lock);
550 /*-------------------------------------------------------------------------*/
553 * Root Hub interrupt transfers are polled using a timer if the
554 * driver requests it; otherwise the driver is responsible for
555 * calling usb_hcd_poll_rh_status() when an event occurs.
557 * Completions are called in_interrupt(), but they may or may not
560 void usb_hcd_poll_rh_status(struct usb_hcd *hcd)
565 char buffer[4]; /* Any root hubs with > 31 ports? */
567 if (unlikely(!hcd->rh_registered))
569 if (!hcd->uses_new_polling && !hcd->status_urb)
572 length = hcd->driver->hub_status_data(hcd, buffer);
575 /* try to complete the status urb */
576 spin_lock_irqsave(&hcd_root_hub_lock, flags);
577 urb = hcd->status_urb;
579 hcd->poll_pending = 0;
580 hcd->status_urb = NULL;
583 urb->actual_length = length;
584 memcpy(urb->transfer_buffer, buffer, length);
586 usb_hcd_unlink_urb_from_ep(hcd, urb);
587 spin_unlock(&hcd_root_hub_lock);
588 usb_hcd_giveback_urb(hcd, urb);
589 spin_lock(&hcd_root_hub_lock);
592 hcd->poll_pending = 1;
594 spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
597 /* The USB 2.0 spec says 256 ms. This is close enough and won't
598 * exceed that limit if HZ is 100. The math is more clunky than
599 * maybe expected, this is to make sure that all timers for USB devices
600 * fire at the same time to give the CPU a break inbetween */
601 if (hcd->uses_new_polling ? hcd->poll_rh :
602 (length == 0 && hcd->status_urb != NULL))
603 mod_timer (&hcd->rh_timer, (jiffies/(HZ/4) + 1) * (HZ/4));
605 EXPORT_SYMBOL_GPL(usb_hcd_poll_rh_status);
608 static void rh_timer_func (unsigned long _hcd)
610 usb_hcd_poll_rh_status((struct usb_hcd *) _hcd);
613 /*-------------------------------------------------------------------------*/
615 static int rh_queue_status (struct usb_hcd *hcd, struct urb *urb)
619 int len = 1 + (urb->dev->maxchild / 8);
621 spin_lock_irqsave (&hcd_root_hub_lock, flags);
622 if (hcd->status_urb || urb->transfer_buffer_length < len) {
623 dev_dbg (hcd->self.controller, "not queuing rh status urb\n");
628 retval = usb_hcd_link_urb_to_ep(hcd, urb);
632 hcd->status_urb = urb;
633 urb->hcpriv = hcd; /* indicate it's queued */
634 if (!hcd->uses_new_polling)
635 mod_timer(&hcd->rh_timer, (jiffies/(HZ/4) + 1) * (HZ/4));
637 /* If a status change has already occurred, report it ASAP */
638 else if (hcd->poll_pending)
639 mod_timer(&hcd->rh_timer, jiffies);
642 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
646 static int rh_urb_enqueue (struct usb_hcd *hcd, struct urb *urb)
648 if (usb_endpoint_xfer_int(&urb->ep->desc))
649 return rh_queue_status (hcd, urb);
650 if (usb_endpoint_xfer_control(&urb->ep->desc))
651 return rh_call_control (hcd, urb);
655 /*-------------------------------------------------------------------------*/
657 /* Unlinks of root-hub control URBs are legal, but they don't do anything
658 * since these URBs always execute synchronously.
660 static int usb_rh_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
665 spin_lock_irqsave(&hcd_root_hub_lock, flags);
666 rc = usb_hcd_check_unlink_urb(hcd, urb, status);
670 if (usb_endpoint_num(&urb->ep->desc) == 0) { /* Control URB */
673 } else { /* Status URB */
674 if (!hcd->uses_new_polling)
675 del_timer (&hcd->rh_timer);
676 if (urb == hcd->status_urb) {
677 hcd->status_urb = NULL;
679 usb_hcd_unlink_urb_from_ep(hcd, urb);
681 spin_unlock(&hcd_root_hub_lock);
682 usb_hcd_giveback_urb(hcd, urb);
683 spin_lock(&hcd_root_hub_lock);
687 spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
694 * Show & store the current value of authorized_default
696 static ssize_t usb_host_authorized_default_show(struct device *dev,
697 struct device_attribute *attr,
700 struct usb_device *rh_usb_dev = to_usb_device(dev);
701 struct usb_bus *usb_bus = rh_usb_dev->bus;
702 struct usb_hcd *usb_hcd;
704 if (usb_bus == NULL) /* FIXME: not sure if this case is possible */
706 usb_hcd = bus_to_hcd(usb_bus);
707 return snprintf(buf, PAGE_SIZE, "%u\n", usb_hcd->authorized_default);
710 static ssize_t usb_host_authorized_default_store(struct device *dev,
711 struct device_attribute *attr,
712 const char *buf, size_t size)
716 struct usb_device *rh_usb_dev = to_usb_device(dev);
717 struct usb_bus *usb_bus = rh_usb_dev->bus;
718 struct usb_hcd *usb_hcd;
720 if (usb_bus == NULL) /* FIXME: not sure if this case is possible */
722 usb_hcd = bus_to_hcd(usb_bus);
723 result = sscanf(buf, "%u\n", &val);
725 usb_hcd->authorized_default = val? 1 : 0;
733 static DEVICE_ATTR(authorized_default, 0644,
734 usb_host_authorized_default_show,
735 usb_host_authorized_default_store);
738 /* Group all the USB bus attributes */
739 static struct attribute *usb_bus_attrs[] = {
740 &dev_attr_authorized_default.attr,
744 static struct attribute_group usb_bus_attr_group = {
745 .name = NULL, /* we want them in the same directory */
746 .attrs = usb_bus_attrs,
751 /*-------------------------------------------------------------------------*/
753 static struct class *usb_host_class;
755 int usb_host_init(void)
759 usb_host_class = class_create(THIS_MODULE, "usb_host");
760 if (IS_ERR(usb_host_class))
761 retval = PTR_ERR(usb_host_class);
765 void usb_host_cleanup(void)
767 class_destroy(usb_host_class);
771 * usb_bus_init - shared initialization code
772 * @bus: the bus structure being initialized
774 * This code is used to initialize a usb_bus structure, memory for which is
775 * separately managed.
777 static void usb_bus_init (struct usb_bus *bus)
779 memset (&bus->devmap, 0, sizeof(struct usb_devmap));
781 bus->devnum_next = 1;
783 bus->root_hub = NULL;
785 bus->bandwidth_allocated = 0;
786 bus->bandwidth_int_reqs = 0;
787 bus->bandwidth_isoc_reqs = 0;
789 INIT_LIST_HEAD (&bus->bus_list);
792 /*-------------------------------------------------------------------------*/
795 * usb_register_bus - registers the USB host controller with the usb core
796 * @bus: pointer to the bus to register
797 * Context: !in_interrupt()
799 * Assigns a bus number, and links the controller into usbcore data
800 * structures so that it can be seen by scanning the bus list.
802 static int usb_register_bus(struct usb_bus *bus)
807 mutex_lock(&usb_bus_list_lock);
808 busnum = find_next_zero_bit (busmap.busmap, USB_MAXBUS, 1);
809 if (busnum >= USB_MAXBUS) {
810 printk (KERN_ERR "%s: too many buses\n", usbcore_name);
811 goto error_find_busnum;
813 set_bit (busnum, busmap.busmap);
814 bus->busnum = busnum;
815 bus->class_dev = class_device_create(usb_host_class, NULL, MKDEV(0,0),
816 bus->controller, "usb_host%d",
818 result = PTR_ERR(bus->class_dev);
819 if (IS_ERR(bus->class_dev))
820 goto error_create_class_dev;
821 class_set_devdata(bus->class_dev, bus);
823 /* Add it to the local list of buses */
824 list_add (&bus->bus_list, &usb_bus_list);
825 mutex_unlock(&usb_bus_list_lock);
827 usb_notify_add_bus(bus);
829 dev_info (bus->controller, "new USB bus registered, assigned bus "
830 "number %d\n", bus->busnum);
833 error_create_class_dev:
834 clear_bit(busnum, busmap.busmap);
836 mutex_unlock(&usb_bus_list_lock);
841 * usb_deregister_bus - deregisters the USB host controller
842 * @bus: pointer to the bus to deregister
843 * Context: !in_interrupt()
845 * Recycles the bus number, and unlinks the controller from usbcore data
846 * structures so that it won't be seen by scanning the bus list.
848 static void usb_deregister_bus (struct usb_bus *bus)
850 dev_info (bus->controller, "USB bus %d deregistered\n", bus->busnum);
853 * NOTE: make sure that all the devices are removed by the
854 * controller code, as well as having it call this when cleaning
857 mutex_lock(&usb_bus_list_lock);
858 list_del (&bus->bus_list);
859 mutex_unlock(&usb_bus_list_lock);
861 usb_notify_remove_bus(bus);
863 clear_bit (bus->busnum, busmap.busmap);
865 class_device_unregister(bus->class_dev);
869 * register_root_hub - called by usb_add_hcd() to register a root hub
870 * @hcd: host controller for this root hub
872 * This function registers the root hub with the USB subsystem. It sets up
873 * the device properly in the device tree and then calls usb_new_device()
874 * to register the usb device. It also assigns the root hub's USB address
877 static int register_root_hub(struct usb_hcd *hcd)
879 struct device *parent_dev = hcd->self.controller;
880 struct usb_device *usb_dev = hcd->self.root_hub;
881 const int devnum = 1;
884 usb_dev->devnum = devnum;
885 usb_dev->bus->devnum_next = devnum + 1;
886 memset (&usb_dev->bus->devmap.devicemap, 0,
887 sizeof usb_dev->bus->devmap.devicemap);
888 set_bit (devnum, usb_dev->bus->devmap.devicemap);
889 usb_set_device_state(usb_dev, USB_STATE_ADDRESS);
891 mutex_lock(&usb_bus_list_lock);
893 usb_dev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
894 retval = usb_get_device_descriptor(usb_dev, USB_DT_DEVICE_SIZE);
895 if (retval != sizeof usb_dev->descriptor) {
896 mutex_unlock(&usb_bus_list_lock);
897 dev_dbg (parent_dev, "can't read %s device descriptor %d\n",
898 usb_dev->dev.bus_id, retval);
899 return (retval < 0) ? retval : -EMSGSIZE;
902 retval = usb_new_device (usb_dev);
904 dev_err (parent_dev, "can't register root hub for %s, %d\n",
905 usb_dev->dev.bus_id, retval);
907 mutex_unlock(&usb_bus_list_lock);
910 spin_lock_irq (&hcd_root_hub_lock);
911 hcd->rh_registered = 1;
912 spin_unlock_irq (&hcd_root_hub_lock);
914 /* Did the HC die before the root hub was registered? */
915 if (hcd->state == HC_STATE_HALT)
916 usb_hc_died (hcd); /* This time clean up */
922 void usb_enable_root_hub_irq (struct usb_bus *bus)
926 hcd = container_of (bus, struct usb_hcd, self);
927 if (hcd->driver->hub_irq_enable && hcd->state != HC_STATE_HALT)
928 hcd->driver->hub_irq_enable (hcd);
932 /*-------------------------------------------------------------------------*/
935 * usb_calc_bus_time - approximate periodic transaction time in nanoseconds
936 * @speed: from dev->speed; USB_SPEED_{LOW,FULL,HIGH}
937 * @is_input: true iff the transaction sends data to the host
938 * @isoc: true for isochronous transactions, false for interrupt ones
939 * @bytecount: how many bytes in the transaction.
941 * Returns approximate bus time in nanoseconds for a periodic transaction.
942 * See USB 2.0 spec section 5.11.3; only periodic transfers need to be
943 * scheduled in software, this function is only used for such scheduling.
945 long usb_calc_bus_time (int speed, int is_input, int isoc, int bytecount)
950 case USB_SPEED_LOW: /* INTR only */
952 tmp = (67667L * (31L + 10L * BitTime (bytecount))) / 1000L;
953 return (64060L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp);
955 tmp = (66700L * (31L + 10L * BitTime (bytecount))) / 1000L;
956 return (64107L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp);
958 case USB_SPEED_FULL: /* ISOC or INTR */
960 tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
961 return (((is_input) ? 7268L : 6265L) + BW_HOST_DELAY + tmp);
963 tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
964 return (9107L + BW_HOST_DELAY + tmp);
966 case USB_SPEED_HIGH: /* ISOC or INTR */
967 // FIXME adjust for input vs output
969 tmp = HS_NSECS_ISO (bytecount);
971 tmp = HS_NSECS (bytecount);
974 pr_debug ("%s: bogus device speed!\n", usbcore_name);
978 EXPORT_SYMBOL (usb_calc_bus_time);
981 /*-------------------------------------------------------------------------*/
984 * Generic HC operations.
987 /*-------------------------------------------------------------------------*/
990 * usb_hcd_link_urb_to_ep - add an URB to its endpoint queue
991 * @hcd: host controller to which @urb was submitted
992 * @urb: URB being submitted
994 * Host controller drivers should call this routine in their enqueue()
995 * method. The HCD's private spinlock must be held and interrupts must
996 * be disabled. The actions carried out here are required for URB
997 * submission, as well as for endpoint shutdown and for usb_kill_urb.
999 * Returns 0 for no error, otherwise a negative error code (in which case
1000 * the enqueue() method must fail). If no error occurs but enqueue() fails
1001 * anyway, it must call usb_hcd_unlink_urb_from_ep() before releasing
1002 * the private spinlock and returning.
1004 int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb)
1008 spin_lock(&hcd_urb_list_lock);
1010 /* Check that the URB isn't being killed */
1011 if (unlikely(urb->reject)) {
1016 if (unlikely(!urb->ep->enabled)) {
1022 * Check the host controller's state and add the URB to the
1025 switch (hcd->state) {
1026 case HC_STATE_RUNNING:
1027 case HC_STATE_RESUMING:
1028 list_add_tail(&urb->urb_list, &urb->ep->urb_list);
1035 spin_unlock(&hcd_urb_list_lock);
1038 EXPORT_SYMBOL_GPL(usb_hcd_link_urb_to_ep);
1041 * usb_hcd_check_unlink_urb - check whether an URB may be unlinked
1042 * @hcd: host controller to which @urb was submitted
1043 * @urb: URB being checked for unlinkability
1044 * @status: error code to store in @urb if the unlink succeeds
1046 * Host controller drivers should call this routine in their dequeue()
1047 * method. The HCD's private spinlock must be held and interrupts must
1048 * be disabled. The actions carried out here are required for making
1049 * sure than an unlink is valid.
1051 * Returns 0 for no error, otherwise a negative error code (in which case
1052 * the dequeue() method must fail). The possible error codes are:
1054 * -EIDRM: @urb was not submitted or has already completed.
1055 * The completion function may not have been called yet.
1057 * -EBUSY: @urb has already been unlinked.
1059 int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb,
1062 struct list_head *tmp;
1064 /* insist the urb is still queued */
1065 list_for_each(tmp, &urb->ep->urb_list) {
1066 if (tmp == &urb->urb_list)
1069 if (tmp != &urb->urb_list)
1072 /* Any status except -EINPROGRESS means something already started to
1073 * unlink this URB from the hardware. So there's no more work to do.
1075 if (urb->status != -EINPROGRESS)
1077 urb->status = status;
1079 /* IRQ setup can easily be broken so that USB controllers
1080 * never get completion IRQs ... maybe even the ones we need to
1081 * finish unlinking the initial failed usb_set_address()
1082 * or device descriptor fetch.
1084 if (!test_bit(HCD_FLAG_SAW_IRQ, &hcd->flags) &&
1085 !is_root_hub(urb->dev)) {
1086 dev_warn(hcd->self.controller, "Unlink after no-IRQ? "
1087 "Controller is probably using the wrong IRQ.\n");
1088 set_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
1093 EXPORT_SYMBOL_GPL(usb_hcd_check_unlink_urb);
1096 * usb_hcd_unlink_urb_from_ep - remove an URB from its endpoint queue
1097 * @hcd: host controller to which @urb was submitted
1098 * @urb: URB being unlinked
1100 * Host controller drivers should call this routine before calling
1101 * usb_hcd_giveback_urb(). The HCD's private spinlock must be held and
1102 * interrupts must be disabled. The actions carried out here are required
1103 * for URB completion.
1105 void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb)
1107 /* clear all state linking urb to this dev (and hcd) */
1108 spin_lock(&hcd_urb_list_lock);
1109 list_del_init(&urb->urb_list);
1110 spin_unlock(&hcd_urb_list_lock);
1112 EXPORT_SYMBOL_GPL(usb_hcd_unlink_urb_from_ep);
1114 static void map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
1116 /* Map the URB's buffers for DMA access.
1117 * Lower level HCD code should use *_dma exclusively,
1118 * unless it uses pio or talks to another transport.
1120 if (hcd->self.uses_dma && !is_root_hub(urb->dev)) {
1121 if (usb_endpoint_xfer_control(&urb->ep->desc)
1122 && !(urb->transfer_flags & URB_NO_SETUP_DMA_MAP))
1123 urb->setup_dma = dma_map_single (
1124 hcd->self.controller,
1126 sizeof (struct usb_ctrlrequest),
1128 if (urb->transfer_buffer_length != 0
1129 && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP))
1130 urb->transfer_dma = dma_map_single (
1131 hcd->self.controller,
1132 urb->transfer_buffer,
1133 urb->transfer_buffer_length,
1140 static void unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
1142 if (hcd->self.uses_dma && !is_root_hub(urb->dev)) {
1143 if (usb_endpoint_xfer_control(&urb->ep->desc)
1144 && !(urb->transfer_flags & URB_NO_SETUP_DMA_MAP))
1145 dma_unmap_single(hcd->self.controller, urb->setup_dma,
1146 sizeof(struct usb_ctrlrequest),
1148 if (urb->transfer_buffer_length != 0
1149 && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP))
1150 dma_unmap_single(hcd->self.controller,
1152 urb->transfer_buffer_length,
1159 /*-------------------------------------------------------------------------*/
1161 /* may be called in any context with a valid urb->dev usecount
1162 * caller surrenders "ownership" of urb
1163 * expects usb_submit_urb() to have sanity checked and conditioned all
1166 int usb_hcd_submit_urb (struct urb *urb, gfp_t mem_flags)
1169 struct usb_hcd *hcd = bus_to_hcd(urb->dev->bus);
1171 /* increment urb's reference count as part of giving it to the HCD
1172 * (which will control it). HCD guarantees that it either returns
1173 * an error or calls giveback(), but not both.
1176 atomic_inc(&urb->use_count);
1177 usbmon_urb_submit(&hcd->self, urb);
1179 /* NOTE requirements on root-hub callers (usbfs and the hub
1180 * driver, for now): URBs' urb->transfer_buffer must be
1181 * valid and usb_buffer_{sync,unmap}() not be needed, since
1182 * they could clobber root hub response data. Also, control
1183 * URBs must be submitted in process context with interrupts
1186 map_urb_for_dma(hcd, urb);
1187 if (is_root_hub(urb->dev))
1188 status = rh_urb_enqueue(hcd, urb);
1190 status = hcd->driver->urb_enqueue(hcd, urb, mem_flags);
1192 if (unlikely(status)) {
1193 usbmon_urb_submit_error(&hcd->self, urb, status);
1194 unmap_urb_for_dma(hcd, urb);
1195 INIT_LIST_HEAD(&urb->urb_list);
1196 atomic_dec(&urb->use_count);
1198 wake_up(&usb_kill_urb_queue);
1204 /*-------------------------------------------------------------------------*/
1206 /* this makes the hcd giveback() the urb more quickly, by kicking it
1207 * off hardware queues (which may take a while) and returning it as
1208 * soon as practical. we've already set up the urb's return status,
1209 * but we can't know if the callback completed already.
1211 static int unlink1(struct usb_hcd *hcd, struct urb *urb, int status)
1215 if (is_root_hub(urb->dev))
1216 value = usb_rh_urb_dequeue(hcd, urb, status);
1219 /* The only reason an HCD might fail this call is if
1220 * it has not yet fully queued the urb to begin with.
1221 * Such failures should be harmless. */
1222 value = hcd->driver->urb_dequeue(hcd, urb, status);
1228 * called in any context
1230 * caller guarantees urb won't be recycled till both unlink()
1231 * and the urb's completion function return
1233 int usb_hcd_unlink_urb (struct urb *urb, int status)
1235 struct usb_hcd *hcd;
1238 hcd = bus_to_hcd(urb->dev->bus);
1239 retval = unlink1(hcd, urb, status);
1242 retval = -EINPROGRESS;
1243 else if (retval != -EIDRM && retval != -EBUSY)
1244 dev_dbg(&urb->dev->dev, "hcd_unlink_urb %p fail %d\n",
1249 /*-------------------------------------------------------------------------*/
1252 * usb_hcd_giveback_urb - return URB from HCD to device driver
1253 * @hcd: host controller returning the URB
1254 * @urb: urb being returned to the USB device driver.
1255 * Context: in_interrupt()
1257 * This hands the URB from HCD to its USB device driver, using its
1258 * completion function. The HCD has freed all per-urb resources
1259 * (and is done using urb->hcpriv). It also released all HCD locks;
1260 * the device driver won't cause problems if it frees, modifies,
1261 * or resubmits this URB.
1263 void usb_hcd_giveback_urb (struct usb_hcd *hcd, struct urb *urb)
1265 unmap_urb_for_dma(hcd, urb);
1266 usbmon_urb_complete (&hcd->self, urb);
1267 usb_unanchor_urb(urb);
1269 /* pass ownership to the completion handler */
1270 urb->complete (urb);
1271 atomic_dec (&urb->use_count);
1272 if (unlikely (urb->reject))
1273 wake_up (&usb_kill_urb_queue);
1276 EXPORT_SYMBOL (usb_hcd_giveback_urb);
1278 /*-------------------------------------------------------------------------*/
1280 /* disables the endpoint: cancels any pending urbs, then synchronizes with
1281 * the hcd to make sure all endpoint state is gone from hardware, and then
1282 * waits until the endpoint's queue is completely drained. use for
1283 * set_configuration, set_interface, driver removal, physical disconnect.
1285 * example: a qh stored in ep->hcpriv, holding state related to endpoint
1286 * type, maxpacket size, toggle, halt status, and scheduling.
1288 void usb_hcd_endpoint_disable (struct usb_device *udev,
1289 struct usb_host_endpoint *ep)
1291 struct usb_hcd *hcd;
1295 hcd = bus_to_hcd(udev->bus);
1297 /* ep is already gone from udev->ep_{in,out}[]; no more submits */
1299 spin_lock_irq(&hcd_urb_list_lock);
1300 list_for_each_entry (urb, &ep->urb_list, urb_list) {
1303 /* the urb may already have been unlinked */
1304 if (urb->status != -EINPROGRESS)
1307 is_in = usb_urb_dir_in(urb);
1308 spin_unlock(&hcd_urb_list_lock);
1311 unlink1(hcd, urb, -ESHUTDOWN);
1312 dev_dbg (hcd->self.controller,
1313 "shutdown urb %p ep%d%s%s\n",
1314 urb, usb_endpoint_num(&ep->desc),
1315 is_in ? "in" : "out",
1318 switch (usb_endpoint_type(&ep->desc)) {
1319 case USB_ENDPOINT_XFER_CONTROL:
1321 case USB_ENDPOINT_XFER_BULK:
1323 case USB_ENDPOINT_XFER_INT:
1332 /* list contents may have changed */
1335 spin_unlock_irq(&hcd_urb_list_lock);
1337 /* synchronize with the hardware, so old configuration state
1338 * clears out immediately (and will be freed).
1340 if (hcd->driver->endpoint_disable)
1341 hcd->driver->endpoint_disable (hcd, ep);
1343 /* Wait until the endpoint queue is completely empty. Most HCDs
1344 * will have done this already in their endpoint_disable method,
1345 * but some might not. And there could be root-hub control URBs
1346 * still pending since they aren't affected by the HCDs'
1347 * endpoint_disable methods.
1349 while (!list_empty (&ep->urb_list)) {
1350 spin_lock_irq(&hcd_urb_list_lock);
1352 /* The list may have changed while we acquired the spinlock */
1354 if (!list_empty (&ep->urb_list)) {
1355 urb = list_entry (ep->urb_list.prev, struct urb,
1359 spin_unlock_irq(&hcd_urb_list_lock);
1368 /*-------------------------------------------------------------------------*/
1370 /* called in any context */
1371 int usb_hcd_get_frame_number (struct usb_device *udev)
1373 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1375 if (!HC_IS_RUNNING (hcd->state))
1377 return hcd->driver->get_frame_number (hcd);
1380 /*-------------------------------------------------------------------------*/
1384 int hcd_bus_suspend(struct usb_device *rhdev)
1386 struct usb_hcd *hcd = container_of(rhdev->bus, struct usb_hcd, self);
1388 int old_state = hcd->state;
1390 dev_dbg(&rhdev->dev, "bus %s%s\n",
1391 rhdev->auto_pm ? "auto-" : "", "suspend");
1392 if (!hcd->driver->bus_suspend) {
1395 hcd->state = HC_STATE_QUIESCING;
1396 status = hcd->driver->bus_suspend(hcd);
1399 usb_set_device_state(rhdev, USB_STATE_SUSPENDED);
1400 hcd->state = HC_STATE_SUSPENDED;
1402 hcd->state = old_state;
1403 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
1409 int hcd_bus_resume(struct usb_device *rhdev)
1411 struct usb_hcd *hcd = container_of(rhdev->bus, struct usb_hcd, self);
1413 int old_state = hcd->state;
1415 dev_dbg(&rhdev->dev, "usb %s%s\n",
1416 rhdev->auto_pm ? "auto-" : "", "resume");
1417 if (!hcd->driver->bus_resume)
1419 if (hcd->state == HC_STATE_RUNNING)
1422 hcd->state = HC_STATE_RESUMING;
1423 status = hcd->driver->bus_resume(hcd);
1425 /* TRSMRCY = 10 msec */
1427 usb_set_device_state(rhdev, rhdev->actconfig
1428 ? USB_STATE_CONFIGURED
1429 : USB_STATE_ADDRESS);
1430 hcd->state = HC_STATE_RUNNING;
1432 hcd->state = old_state;
1433 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
1435 if (status != -ESHUTDOWN)
1441 /* Workqueue routine for root-hub remote wakeup */
1442 static void hcd_resume_work(struct work_struct *work)
1444 struct usb_hcd *hcd = container_of(work, struct usb_hcd, wakeup_work);
1445 struct usb_device *udev = hcd->self.root_hub;
1447 usb_lock_device(udev);
1448 usb_mark_last_busy(udev);
1449 usb_external_resume_device(udev);
1450 usb_unlock_device(udev);
1454 * usb_hcd_resume_root_hub - called by HCD to resume its root hub
1455 * @hcd: host controller for this root hub
1457 * The USB host controller calls this function when its root hub is
1458 * suspended (with the remote wakeup feature enabled) and a remote
1459 * wakeup request is received. The routine submits a workqueue request
1460 * to resume the root hub (that is, manage its downstream ports again).
1462 void usb_hcd_resume_root_hub (struct usb_hcd *hcd)
1464 unsigned long flags;
1466 spin_lock_irqsave (&hcd_root_hub_lock, flags);
1467 if (hcd->rh_registered)
1468 queue_work(ksuspend_usb_wq, &hcd->wakeup_work);
1469 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
1471 EXPORT_SYMBOL_GPL(usb_hcd_resume_root_hub);
1475 /*-------------------------------------------------------------------------*/
1477 #ifdef CONFIG_USB_OTG
1480 * usb_bus_start_enum - start immediate enumeration (for OTG)
1481 * @bus: the bus (must use hcd framework)
1482 * @port_num: 1-based number of port; usually bus->otg_port
1483 * Context: in_interrupt()
1485 * Starts enumeration, with an immediate reset followed later by
1486 * khubd identifying and possibly configuring the device.
1487 * This is needed by OTG controller drivers, where it helps meet
1488 * HNP protocol timing requirements for starting a port reset.
1490 int usb_bus_start_enum(struct usb_bus *bus, unsigned port_num)
1492 struct usb_hcd *hcd;
1493 int status = -EOPNOTSUPP;
1495 /* NOTE: since HNP can't start by grabbing the bus's address0_sem,
1496 * boards with root hubs hooked up to internal devices (instead of
1497 * just the OTG port) may need more attention to resetting...
1499 hcd = container_of (bus, struct usb_hcd, self);
1500 if (port_num && hcd->driver->start_port_reset)
1501 status = hcd->driver->start_port_reset(hcd, port_num);
1503 /* run khubd shortly after (first) root port reset finishes;
1504 * it may issue others, until at least 50 msecs have passed.
1507 mod_timer(&hcd->rh_timer, jiffies + msecs_to_jiffies(10));
1510 EXPORT_SYMBOL (usb_bus_start_enum);
1514 /*-------------------------------------------------------------------------*/
1517 * usb_hcd_irq - hook IRQs to HCD framework (bus glue)
1518 * @irq: the IRQ being raised
1519 * @__hcd: pointer to the HCD whose IRQ is being signaled
1520 * @r: saved hardware registers
1522 * If the controller isn't HALTed, calls the driver's irq handler.
1523 * Checks whether the controller is now dead.
1525 irqreturn_t usb_hcd_irq (int irq, void *__hcd)
1527 struct usb_hcd *hcd = __hcd;
1528 int start = hcd->state;
1530 if (unlikely(start == HC_STATE_HALT ||
1531 !test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags)))
1533 if (hcd->driver->irq (hcd) == IRQ_NONE)
1536 set_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
1538 if (unlikely(hcd->state == HC_STATE_HALT))
1543 /*-------------------------------------------------------------------------*/
1546 * usb_hc_died - report abnormal shutdown of a host controller (bus glue)
1547 * @hcd: pointer to the HCD representing the controller
1549 * This is called by bus glue to report a USB host controller that died
1550 * while operations may still have been pending. It's called automatically
1551 * by the PCI glue, so only glue for non-PCI busses should need to call it.
1553 void usb_hc_died (struct usb_hcd *hcd)
1555 unsigned long flags;
1557 dev_err (hcd->self.controller, "HC died; cleaning up\n");
1559 spin_lock_irqsave (&hcd_root_hub_lock, flags);
1560 if (hcd->rh_registered) {
1563 /* make khubd clean up old urbs and devices */
1564 usb_set_device_state (hcd->self.root_hub,
1565 USB_STATE_NOTATTACHED);
1566 usb_kick_khubd (hcd->self.root_hub);
1568 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
1570 EXPORT_SYMBOL_GPL (usb_hc_died);
1572 /*-------------------------------------------------------------------------*/
1575 * usb_create_hcd - create and initialize an HCD structure
1576 * @driver: HC driver that will use this hcd
1577 * @dev: device for this HC, stored in hcd->self.controller
1578 * @bus_name: value to store in hcd->self.bus_name
1579 * Context: !in_interrupt()
1581 * Allocate a struct usb_hcd, with extra space at the end for the
1582 * HC driver's private data. Initialize the generic members of the
1585 * If memory is unavailable, returns NULL.
1587 struct usb_hcd *usb_create_hcd (const struct hc_driver *driver,
1588 struct device *dev, char *bus_name)
1590 struct usb_hcd *hcd;
1592 hcd = kzalloc(sizeof(*hcd) + driver->hcd_priv_size, GFP_KERNEL);
1594 dev_dbg (dev, "hcd alloc failed\n");
1597 dev_set_drvdata(dev, hcd);
1598 kref_init(&hcd->kref);
1600 usb_bus_init(&hcd->self);
1601 hcd->self.controller = dev;
1602 hcd->self.bus_name = bus_name;
1603 hcd->self.uses_dma = (dev->dma_mask != NULL);
1605 init_timer(&hcd->rh_timer);
1606 hcd->rh_timer.function = rh_timer_func;
1607 hcd->rh_timer.data = (unsigned long) hcd;
1609 INIT_WORK(&hcd->wakeup_work, hcd_resume_work);
1612 hcd->driver = driver;
1613 hcd->product_desc = (driver->product_desc) ? driver->product_desc :
1614 "USB Host Controller";
1617 EXPORT_SYMBOL (usb_create_hcd);
1619 static void hcd_release (struct kref *kref)
1621 struct usb_hcd *hcd = container_of (kref, struct usb_hcd, kref);
1626 struct usb_hcd *usb_get_hcd (struct usb_hcd *hcd)
1629 kref_get (&hcd->kref);
1632 EXPORT_SYMBOL (usb_get_hcd);
1634 void usb_put_hcd (struct usb_hcd *hcd)
1637 kref_put (&hcd->kref, hcd_release);
1639 EXPORT_SYMBOL (usb_put_hcd);
1642 * usb_add_hcd - finish generic HCD structure initialization and register
1643 * @hcd: the usb_hcd structure to initialize
1644 * @irqnum: Interrupt line to allocate
1645 * @irqflags: Interrupt type flags
1647 * Finish the remaining parts of generic HCD initialization: allocate the
1648 * buffers of consistent memory, register the bus, request the IRQ line,
1649 * and call the driver's reset() and start() routines.
1651 int usb_add_hcd(struct usb_hcd *hcd,
1652 unsigned int irqnum, unsigned long irqflags)
1655 struct usb_device *rhdev;
1657 dev_info(hcd->self.controller, "%s\n", hcd->product_desc);
1659 hcd->authorized_default = hcd->wireless? 0 : 1;
1660 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1662 /* HC is in reset state, but accessible. Now do the one-time init,
1663 * bottom up so that hcds can customize the root hubs before khubd
1664 * starts talking to them. (Note, bus id is assigned early too.)
1666 if ((retval = hcd_buffer_create(hcd)) != 0) {
1667 dev_dbg(hcd->self.controller, "pool alloc failed\n");
1671 if ((retval = usb_register_bus(&hcd->self)) < 0)
1672 goto err_register_bus;
1674 if ((rhdev = usb_alloc_dev(NULL, &hcd->self, 0)) == NULL) {
1675 dev_err(hcd->self.controller, "unable to allocate root hub\n");
1677 goto err_allocate_root_hub;
1679 rhdev->speed = (hcd->driver->flags & HCD_USB2) ? USB_SPEED_HIGH :
1681 hcd->self.root_hub = rhdev;
1683 /* wakeup flag init defaults to "everything works" for root hubs,
1684 * but drivers can override it in reset() if needed, along with
1685 * recording the overall controller's system wakeup capability.
1687 device_init_wakeup(&rhdev->dev, 1);
1689 /* "reset" is misnamed; its role is now one-time init. the controller
1690 * should already have been reset (and boot firmware kicked off etc).
1692 if (hcd->driver->reset && (retval = hcd->driver->reset(hcd)) < 0) {
1693 dev_err(hcd->self.controller, "can't setup\n");
1694 goto err_hcd_driver_setup;
1697 /* NOTE: root hub and controller capabilities may not be the same */
1698 if (device_can_wakeup(hcd->self.controller)
1699 && device_can_wakeup(&hcd->self.root_hub->dev))
1700 dev_dbg(hcd->self.controller, "supports USB remote wakeup\n");
1702 /* enable irqs just before we start the controller */
1703 if (hcd->driver->irq) {
1704 snprintf(hcd->irq_descr, sizeof(hcd->irq_descr), "%s:usb%d",
1705 hcd->driver->description, hcd->self.busnum);
1706 if ((retval = request_irq(irqnum, &usb_hcd_irq, irqflags,
1707 hcd->irq_descr, hcd)) != 0) {
1708 dev_err(hcd->self.controller,
1709 "request interrupt %d failed\n", irqnum);
1710 goto err_request_irq;
1713 dev_info(hcd->self.controller, "irq %d, %s 0x%08llx\n", irqnum,
1714 (hcd->driver->flags & HCD_MEMORY) ?
1715 "io mem" : "io base",
1716 (unsigned long long)hcd->rsrc_start);
1719 if (hcd->rsrc_start)
1720 dev_info(hcd->self.controller, "%s 0x%08llx\n",
1721 (hcd->driver->flags & HCD_MEMORY) ?
1722 "io mem" : "io base",
1723 (unsigned long long)hcd->rsrc_start);
1726 if ((retval = hcd->driver->start(hcd)) < 0) {
1727 dev_err(hcd->self.controller, "startup error %d\n", retval);
1728 goto err_hcd_driver_start;
1731 /* starting here, usbcore will pay attention to this root hub */
1732 rhdev->bus_mA = min(500u, hcd->power_budget);
1733 if ((retval = register_root_hub(hcd)) != 0)
1734 goto err_register_root_hub;
1736 retval = sysfs_create_group(&rhdev->dev.kobj, &usb_bus_attr_group);
1738 printk(KERN_ERR "Cannot register USB bus sysfs attributes: %d\n",
1740 goto error_create_attr_group;
1742 if (hcd->uses_new_polling && hcd->poll_rh)
1743 usb_hcd_poll_rh_status(hcd);
1746 error_create_attr_group:
1747 mutex_lock(&usb_bus_list_lock);
1748 usb_disconnect(&hcd->self.root_hub);
1749 mutex_unlock(&usb_bus_list_lock);
1750 err_register_root_hub:
1751 hcd->driver->stop(hcd);
1752 err_hcd_driver_start:
1754 free_irq(irqnum, hcd);
1756 err_hcd_driver_setup:
1757 hcd->self.root_hub = NULL;
1759 err_allocate_root_hub:
1760 usb_deregister_bus(&hcd->self);
1762 hcd_buffer_destroy(hcd);
1765 EXPORT_SYMBOL (usb_add_hcd);
1768 * usb_remove_hcd - shutdown processing for generic HCDs
1769 * @hcd: the usb_hcd structure to remove
1770 * Context: !in_interrupt()
1772 * Disconnects the root hub, then reverses the effects of usb_add_hcd(),
1773 * invoking the HCD's stop() method.
1775 void usb_remove_hcd(struct usb_hcd *hcd)
1777 dev_info(hcd->self.controller, "remove, state %x\n", hcd->state);
1779 if (HC_IS_RUNNING (hcd->state))
1780 hcd->state = HC_STATE_QUIESCING;
1782 dev_dbg(hcd->self.controller, "roothub graceful disconnect\n");
1783 spin_lock_irq (&hcd_root_hub_lock);
1784 hcd->rh_registered = 0;
1785 spin_unlock_irq (&hcd_root_hub_lock);
1788 cancel_work_sync(&hcd->wakeup_work);
1791 sysfs_remove_group(&hcd->self.root_hub->dev.kobj, &usb_bus_attr_group);
1792 mutex_lock(&usb_bus_list_lock);
1793 usb_disconnect(&hcd->self.root_hub);
1794 mutex_unlock(&usb_bus_list_lock);
1796 hcd->driver->stop(hcd);
1797 hcd->state = HC_STATE_HALT;
1800 del_timer_sync(&hcd->rh_timer);
1803 free_irq(hcd->irq, hcd);
1804 usb_deregister_bus(&hcd->self);
1805 hcd_buffer_destroy(hcd);
1807 EXPORT_SYMBOL (usb_remove_hcd);
1810 usb_hcd_platform_shutdown(struct platform_device* dev)
1812 struct usb_hcd *hcd = platform_get_drvdata(dev);
1814 if (hcd->driver->shutdown)
1815 hcd->driver->shutdown(hcd);
1817 EXPORT_SYMBOL (usb_hcd_platform_shutdown);
1819 /*-------------------------------------------------------------------------*/
1821 #if defined(CONFIG_USB_MON)
1823 struct usb_mon_operations *mon_ops;
1826 * The registration is unlocked.
1827 * We do it this way because we do not want to lock in hot paths.
1829 * Notice that the code is minimally error-proof. Because usbmon needs
1830 * symbols from usbcore, usbcore gets referenced and cannot be unloaded first.
1833 int usb_mon_register (struct usb_mon_operations *ops)
1843 EXPORT_SYMBOL_GPL (usb_mon_register);
1845 void usb_mon_deregister (void)
1848 if (mon_ops == NULL) {
1849 printk(KERN_ERR "USB: monitor was not registered\n");
1855 EXPORT_SYMBOL_GPL (usb_mon_deregister);
1857 #endif /* CONFIG_USB_MON */