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 // #define USB_BANDWIDTH_MESSAGES
50 /*-------------------------------------------------------------------------*/
53 * USB Host Controller Driver framework
55 * Plugs into usbcore (usb_bus) and lets HCDs share code, minimizing
56 * HCD-specific behaviors/bugs.
58 * This does error checks, tracks devices and urbs, and delegates to a
59 * "hc_driver" only for code (and data) that really needs to know about
60 * hardware differences. That includes root hub registers, i/o queues,
61 * and so on ... but as little else as possible.
63 * Shared code includes most of the "root hub" code (these are emulated,
64 * though each HC's hardware works differently) and PCI glue, plus request
65 * tracking overhead. The HCD code should only block on spinlocks or on
66 * hardware handshaking; blocking on software events (such as other kernel
67 * threads releasing resources, or completing actions) is all generic.
69 * Happens the USB 2.0 spec says this would be invisible inside the "USBD",
70 * and includes mostly a "HCDI" (HCD Interface) along with some APIs used
71 * only by the hub driver ... and that neither should be seen or used by
72 * usb client device drivers.
74 * Contributors of ideas or unattributed patches include: David Brownell,
75 * Roman Weissgaerber, Rory Bolt, Greg Kroah-Hartman, ...
78 * 2002-02-21 Pull in most of the usb_bus support from usb.c; some
79 * associated cleanup. "usb_hcd" still != "usb_bus".
80 * 2001-12-12 Initial patch version for Linux 2.5.1 kernel.
83 /*-------------------------------------------------------------------------*/
85 /* host controllers we manage */
86 LIST_HEAD (usb_bus_list);
87 EXPORT_SYMBOL_GPL (usb_bus_list);
89 /* used when allocating bus numbers */
92 unsigned long busmap [USB_MAXBUS / (8*sizeof (unsigned long))];
94 static struct usb_busmap busmap;
96 /* used when updating list of hcds */
97 DEFINE_MUTEX(usb_bus_list_lock); /* exported only for usbfs */
98 EXPORT_SYMBOL_GPL (usb_bus_list_lock);
100 /* used for controlling access to virtual root hubs */
101 static DEFINE_SPINLOCK(hcd_root_hub_lock);
103 /* used when updating hcd data */
104 static DEFINE_SPINLOCK(hcd_data_lock);
106 /* wait queue for synchronous unlinks */
107 DECLARE_WAIT_QUEUE_HEAD(usb_kill_urb_queue);
109 /*-------------------------------------------------------------------------*/
112 * Sharable chunks of root hub code.
115 /*-------------------------------------------------------------------------*/
117 #define KERNEL_REL ((LINUX_VERSION_CODE >> 16) & 0x0ff)
118 #define KERNEL_VER ((LINUX_VERSION_CODE >> 8) & 0x0ff)
120 /* usb 2.0 root hub device descriptor */
121 static const u8 usb2_rh_dev_descriptor [18] = {
122 0x12, /* __u8 bLength; */
123 0x01, /* __u8 bDescriptorType; Device */
124 0x00, 0x02, /* __le16 bcdUSB; v2.0 */
126 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
127 0x00, /* __u8 bDeviceSubClass; */
128 0x01, /* __u8 bDeviceProtocol; [ usb 2.0 single TT ]*/
129 0x40, /* __u8 bMaxPacketSize0; 64 Bytes */
131 0x00, 0x00, /* __le16 idVendor; */
132 0x00, 0x00, /* __le16 idProduct; */
133 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
135 0x03, /* __u8 iManufacturer; */
136 0x02, /* __u8 iProduct; */
137 0x01, /* __u8 iSerialNumber; */
138 0x01 /* __u8 bNumConfigurations; */
141 /* no usb 2.0 root hub "device qualifier" descriptor: one speed only */
143 /* usb 1.1 root hub device descriptor */
144 static const u8 usb11_rh_dev_descriptor [18] = {
145 0x12, /* __u8 bLength; */
146 0x01, /* __u8 bDescriptorType; Device */
147 0x10, 0x01, /* __le16 bcdUSB; v1.1 */
149 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
150 0x00, /* __u8 bDeviceSubClass; */
151 0x00, /* __u8 bDeviceProtocol; [ low/full speeds only ] */
152 0x40, /* __u8 bMaxPacketSize0; 64 Bytes */
154 0x00, 0x00, /* __le16 idVendor; */
155 0x00, 0x00, /* __le16 idProduct; */
156 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
158 0x03, /* __u8 iManufacturer; */
159 0x02, /* __u8 iProduct; */
160 0x01, /* __u8 iSerialNumber; */
161 0x01 /* __u8 bNumConfigurations; */
165 /*-------------------------------------------------------------------------*/
167 /* Configuration descriptors for our root hubs */
169 static const u8 fs_rh_config_descriptor [] = {
171 /* one configuration */
172 0x09, /* __u8 bLength; */
173 0x02, /* __u8 bDescriptorType; Configuration */
174 0x19, 0x00, /* __le16 wTotalLength; */
175 0x01, /* __u8 bNumInterfaces; (1) */
176 0x01, /* __u8 bConfigurationValue; */
177 0x00, /* __u8 iConfiguration; */
178 0xc0, /* __u8 bmAttributes;
183 0x00, /* __u8 MaxPower; */
186 * USB 2.0, single TT organization (mandatory):
187 * one interface, protocol 0
189 * USB 2.0, multiple TT organization (optional):
190 * two interfaces, protocols 1 (like single TT)
191 * and 2 (multiple TT mode) ... config is
197 0x09, /* __u8 if_bLength; */
198 0x04, /* __u8 if_bDescriptorType; Interface */
199 0x00, /* __u8 if_bInterfaceNumber; */
200 0x00, /* __u8 if_bAlternateSetting; */
201 0x01, /* __u8 if_bNumEndpoints; */
202 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
203 0x00, /* __u8 if_bInterfaceSubClass; */
204 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
205 0x00, /* __u8 if_iInterface; */
207 /* one endpoint (status change endpoint) */
208 0x07, /* __u8 ep_bLength; */
209 0x05, /* __u8 ep_bDescriptorType; Endpoint */
210 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
211 0x03, /* __u8 ep_bmAttributes; Interrupt */
212 0x02, 0x00, /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8) */
213 0xff /* __u8 ep_bInterval; (255ms -- usb 2.0 spec) */
216 static const u8 hs_rh_config_descriptor [] = {
218 /* one configuration */
219 0x09, /* __u8 bLength; */
220 0x02, /* __u8 bDescriptorType; Configuration */
221 0x19, 0x00, /* __le16 wTotalLength; */
222 0x01, /* __u8 bNumInterfaces; (1) */
223 0x01, /* __u8 bConfigurationValue; */
224 0x00, /* __u8 iConfiguration; */
225 0xc0, /* __u8 bmAttributes;
230 0x00, /* __u8 MaxPower; */
233 * USB 2.0, single TT organization (mandatory):
234 * one interface, protocol 0
236 * USB 2.0, multiple TT organization (optional):
237 * two interfaces, protocols 1 (like single TT)
238 * and 2 (multiple TT mode) ... config is
244 0x09, /* __u8 if_bLength; */
245 0x04, /* __u8 if_bDescriptorType; Interface */
246 0x00, /* __u8 if_bInterfaceNumber; */
247 0x00, /* __u8 if_bAlternateSetting; */
248 0x01, /* __u8 if_bNumEndpoints; */
249 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
250 0x00, /* __u8 if_bInterfaceSubClass; */
251 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
252 0x00, /* __u8 if_iInterface; */
254 /* one endpoint (status change endpoint) */
255 0x07, /* __u8 ep_bLength; */
256 0x05, /* __u8 ep_bDescriptorType; Endpoint */
257 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
258 0x03, /* __u8 ep_bmAttributes; Interrupt */
259 0x02, 0x00, /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8) */
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", system_utsname.sysname,
322 system_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, NULL);
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 (!hcd->uses_new_polling && !hcd->status_urb)
550 length = hcd->driver->hub_status_data(hcd, buffer);
553 /* try to complete the status urb */
554 local_irq_save (flags);
555 spin_lock(&hcd_root_hub_lock);
556 urb = hcd->status_urb;
558 spin_lock(&urb->lock);
559 if (urb->status == -EINPROGRESS) {
560 hcd->poll_pending = 0;
561 hcd->status_urb = NULL;
564 urb->actual_length = length;
565 memcpy(urb->transfer_buffer, buffer, length);
566 } else /* urb has been unlinked */
568 spin_unlock(&urb->lock);
571 spin_unlock(&hcd_root_hub_lock);
573 /* local irqs are always blocked in completions */
575 usb_hcd_giveback_urb (hcd, urb, NULL);
577 hcd->poll_pending = 1;
578 local_irq_restore (flags);
581 /* The USB 2.0 spec says 256 ms. This is close enough and won't
582 * exceed that limit if HZ is 100. */
583 if (hcd->uses_new_polling ? hcd->poll_rh :
584 (length == 0 && hcd->status_urb != NULL))
585 mod_timer (&hcd->rh_timer, jiffies + msecs_to_jiffies(250));
587 EXPORT_SYMBOL_GPL(usb_hcd_poll_rh_status);
590 static void rh_timer_func (unsigned long _hcd)
592 usb_hcd_poll_rh_status((struct usb_hcd *) _hcd);
595 /*-------------------------------------------------------------------------*/
597 static int rh_queue_status (struct usb_hcd *hcd, struct urb *urb)
601 int len = 1 + (urb->dev->maxchild / 8);
603 spin_lock_irqsave (&hcd_root_hub_lock, flags);
604 if (urb->status != -EINPROGRESS) /* already unlinked */
605 retval = urb->status;
606 else if (hcd->status_urb || urb->transfer_buffer_length < len) {
607 dev_dbg (hcd->self.controller, "not queuing rh status urb\n");
610 hcd->status_urb = urb;
611 urb->hcpriv = hcd; /* indicate it's queued */
613 if (!hcd->uses_new_polling)
614 mod_timer (&hcd->rh_timer, jiffies +
615 msecs_to_jiffies(250));
617 /* If a status change has already occurred, report it ASAP */
618 else if (hcd->poll_pending)
619 mod_timer (&hcd->rh_timer, jiffies);
622 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
626 static int rh_urb_enqueue (struct usb_hcd *hcd, struct urb *urb)
628 if (usb_pipeint (urb->pipe))
629 return rh_queue_status (hcd, urb);
630 if (usb_pipecontrol (urb->pipe))
631 return rh_call_control (hcd, urb);
635 /*-------------------------------------------------------------------------*/
637 /* Unlinks of root-hub control URBs are legal, but they don't do anything
638 * since these URBs always execute synchronously.
640 static int usb_rh_urb_dequeue (struct usb_hcd *hcd, struct urb *urb)
644 if (usb_pipeendpoint(urb->pipe) == 0) { /* Control URB */
647 } else { /* Status URB */
648 if (!hcd->uses_new_polling)
649 del_timer (&hcd->rh_timer);
650 local_irq_save (flags);
651 spin_lock (&hcd_root_hub_lock);
652 if (urb == hcd->status_urb) {
653 hcd->status_urb = NULL;
656 urb = NULL; /* wasn't fully queued */
657 spin_unlock (&hcd_root_hub_lock);
659 usb_hcd_giveback_urb (hcd, urb, NULL);
660 local_irq_restore (flags);
666 /*-------------------------------------------------------------------------*/
668 static struct class *usb_host_class;
670 int usb_host_init(void)
674 usb_host_class = class_create(THIS_MODULE, "usb_host");
675 if (IS_ERR(usb_host_class))
676 retval = PTR_ERR(usb_host_class);
680 void usb_host_cleanup(void)
682 class_destroy(usb_host_class);
686 * usb_bus_init - shared initialization code
687 * @bus: the bus structure being initialized
689 * This code is used to initialize a usb_bus structure, memory for which is
690 * separately managed.
692 static void usb_bus_init (struct usb_bus *bus)
694 memset (&bus->devmap, 0, sizeof(struct usb_devmap));
696 bus->devnum_next = 1;
698 bus->root_hub = NULL;
700 bus->bandwidth_allocated = 0;
701 bus->bandwidth_int_reqs = 0;
702 bus->bandwidth_isoc_reqs = 0;
704 INIT_LIST_HEAD (&bus->bus_list);
707 /*-------------------------------------------------------------------------*/
710 * usb_register_bus - registers the USB host controller with the usb core
711 * @bus: pointer to the bus to register
712 * Context: !in_interrupt()
714 * Assigns a bus number, and links the controller into usbcore data
715 * structures so that it can be seen by scanning the bus list.
717 static int usb_register_bus(struct usb_bus *bus)
721 mutex_lock(&usb_bus_list_lock);
722 busnum = find_next_zero_bit (busmap.busmap, USB_MAXBUS, 1);
723 if (busnum < USB_MAXBUS) {
724 set_bit (busnum, busmap.busmap);
725 bus->busnum = busnum;
727 printk (KERN_ERR "%s: too many buses\n", usbcore_name);
728 mutex_unlock(&usb_bus_list_lock);
732 bus->class_dev = class_device_create(usb_host_class, NULL, MKDEV(0,0),
733 bus->controller, "usb_host%d", busnum);
734 if (IS_ERR(bus->class_dev)) {
735 clear_bit(busnum, busmap.busmap);
736 mutex_unlock(&usb_bus_list_lock);
737 return PTR_ERR(bus->class_dev);
740 class_set_devdata(bus->class_dev, bus);
742 /* Add it to the local list of buses */
743 list_add (&bus->bus_list, &usb_bus_list);
744 mutex_unlock(&usb_bus_list_lock);
746 usb_notify_add_bus(bus);
748 dev_info (bus->controller, "new USB bus registered, assigned bus number %d\n", bus->busnum);
753 * usb_deregister_bus - deregisters the USB host controller
754 * @bus: pointer to the bus to deregister
755 * Context: !in_interrupt()
757 * Recycles the bus number, and unlinks the controller from usbcore data
758 * structures so that it won't be seen by scanning the bus list.
760 static void usb_deregister_bus (struct usb_bus *bus)
762 dev_info (bus->controller, "USB bus %d deregistered\n", bus->busnum);
765 * NOTE: make sure that all the devices are removed by the
766 * controller code, as well as having it call this when cleaning
769 mutex_lock(&usb_bus_list_lock);
770 list_del (&bus->bus_list);
771 mutex_unlock(&usb_bus_list_lock);
773 usb_notify_remove_bus(bus);
775 clear_bit (bus->busnum, busmap.busmap);
777 class_device_unregister(bus->class_dev);
781 * register_root_hub - called by usb_add_hcd() to register a root hub
782 * @hcd: host controller for this root hub
784 * This function registers the root hub with the USB subsystem. It sets up
785 * the device properly in the device tree and then calls usb_new_device()
786 * to register the usb device. It also assigns the root hub's USB address
789 static int register_root_hub(struct usb_hcd *hcd)
791 struct device *parent_dev = hcd->self.controller;
792 struct usb_device *usb_dev = hcd->self.root_hub;
793 const int devnum = 1;
796 usb_dev->devnum = devnum;
797 usb_dev->bus->devnum_next = devnum + 1;
798 memset (&usb_dev->bus->devmap.devicemap, 0,
799 sizeof usb_dev->bus->devmap.devicemap);
800 set_bit (devnum, usb_dev->bus->devmap.devicemap);
801 usb_set_device_state(usb_dev, USB_STATE_ADDRESS);
803 mutex_lock(&usb_bus_list_lock);
805 usb_dev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
806 retval = usb_get_device_descriptor(usb_dev, USB_DT_DEVICE_SIZE);
807 if (retval != sizeof usb_dev->descriptor) {
808 mutex_unlock(&usb_bus_list_lock);
809 dev_dbg (parent_dev, "can't read %s device descriptor %d\n",
810 usb_dev->dev.bus_id, retval);
811 return (retval < 0) ? retval : -EMSGSIZE;
814 retval = usb_new_device (usb_dev);
816 dev_err (parent_dev, "can't register root hub for %s, %d\n",
817 usb_dev->dev.bus_id, retval);
819 mutex_unlock(&usb_bus_list_lock);
822 spin_lock_irq (&hcd_root_hub_lock);
823 hcd->rh_registered = 1;
824 spin_unlock_irq (&hcd_root_hub_lock);
826 /* Did the HC die before the root hub was registered? */
827 if (hcd->state == HC_STATE_HALT)
828 usb_hc_died (hcd); /* This time clean up */
834 void usb_enable_root_hub_irq (struct usb_bus *bus)
838 hcd = container_of (bus, struct usb_hcd, self);
839 if (hcd->driver->hub_irq_enable && !hcd->poll_rh &&
840 hcd->state != HC_STATE_HALT)
841 hcd->driver->hub_irq_enable (hcd);
845 /*-------------------------------------------------------------------------*/
848 * usb_calc_bus_time - approximate periodic transaction time in nanoseconds
849 * @speed: from dev->speed; USB_SPEED_{LOW,FULL,HIGH}
850 * @is_input: true iff the transaction sends data to the host
851 * @isoc: true for isochronous transactions, false for interrupt ones
852 * @bytecount: how many bytes in the transaction.
854 * Returns approximate bus time in nanoseconds for a periodic transaction.
855 * See USB 2.0 spec section 5.11.3; only periodic transfers need to be
856 * scheduled in software, this function is only used for such scheduling.
858 long usb_calc_bus_time (int speed, int is_input, int isoc, int bytecount)
863 case USB_SPEED_LOW: /* INTR only */
865 tmp = (67667L * (31L + 10L * BitTime (bytecount))) / 1000L;
866 return (64060L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp);
868 tmp = (66700L * (31L + 10L * BitTime (bytecount))) / 1000L;
869 return (64107L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp);
871 case USB_SPEED_FULL: /* ISOC or INTR */
873 tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
874 return (((is_input) ? 7268L : 6265L) + BW_HOST_DELAY + tmp);
876 tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
877 return (9107L + BW_HOST_DELAY + tmp);
879 case USB_SPEED_HIGH: /* ISOC or INTR */
880 // FIXME adjust for input vs output
882 tmp = HS_NSECS_ISO (bytecount);
884 tmp = HS_NSECS (bytecount);
887 pr_debug ("%s: bogus device speed!\n", usbcore_name);
891 EXPORT_SYMBOL (usb_calc_bus_time);
894 * usb_check_bandwidth():
896 * old_alloc is from host_controller->bandwidth_allocated in microseconds;
897 * bustime is from calc_bus_time(), but converted to microseconds.
899 * returns <bustime in us> if successful,
900 * or -ENOSPC if bandwidth request fails.
903 * This initial implementation does not use Endpoint.bInterval
904 * in managing bandwidth allocation.
905 * It probably needs to be expanded to use Endpoint.bInterval.
906 * This can be done as a later enhancement (correction).
908 * This will also probably require some kind of
909 * frame allocation tracking...meaning, for example,
910 * that if multiple drivers request interrupts every 10 USB frames,
911 * they don't all have to be allocated at
912 * frame numbers N, N+10, N+20, etc. Some of them could be at
913 * N+11, N+21, N+31, etc., and others at
914 * N+12, N+22, N+32, etc.
916 * Similarly for isochronous transfers...
918 * Individual HCDs can schedule more directly ... this logic
919 * is not correct for high speed transfers.
921 int usb_check_bandwidth (struct usb_device *dev, struct urb *urb)
923 unsigned int pipe = urb->pipe;
925 int is_in = usb_pipein (pipe);
926 int is_iso = usb_pipeisoc (pipe);
927 int old_alloc = dev->bus->bandwidth_allocated;
931 bustime = NS_TO_US (usb_calc_bus_time (dev->speed, is_in, is_iso,
932 usb_maxpacket (dev, pipe, !is_in)));
934 bustime /= urb->number_of_packets;
936 new_alloc = old_alloc + (int) bustime;
937 if (new_alloc > FRAME_TIME_MAX_USECS_ALLOC) {
940 #ifdef CONFIG_USB_BANDWIDTH
945 dev_dbg (&dev->dev, "usb_check_bandwidth %sFAILED: %d + %ld = %d usec\n",
946 mode, old_alloc, bustime, new_alloc);
948 #ifdef CONFIG_USB_BANDWIDTH
949 bustime = -ENOSPC; /* report error */
955 EXPORT_SYMBOL (usb_check_bandwidth);
959 * usb_claim_bandwidth - records bandwidth for a periodic transfer
960 * @dev: source/target of request
961 * @urb: request (urb->dev == dev)
962 * @bustime: bandwidth consumed, in (average) microseconds per frame
963 * @isoc: true iff the request is isochronous
965 * Bus bandwidth reservations are recorded purely for diagnostic purposes.
966 * HCDs are expected not to overcommit periodic bandwidth, and to record such
967 * reservations whenever endpoints are added to the periodic schedule.
969 * FIXME averaging per-frame is suboptimal. Better to sum over the HCD's
970 * entire periodic schedule ... 32 frames for OHCI, 1024 for UHCI, settable
971 * for EHCI (256/512/1024 frames, default 1024) and have the bus expose how
972 * large its periodic schedule is.
974 void usb_claim_bandwidth (struct usb_device *dev, struct urb *urb, int bustime, int isoc)
976 dev->bus->bandwidth_allocated += bustime;
978 dev->bus->bandwidth_isoc_reqs++;
980 dev->bus->bandwidth_int_reqs++;
981 urb->bandwidth = bustime;
983 #ifdef USB_BANDWIDTH_MESSAGES
984 dev_dbg (&dev->dev, "bandwidth alloc increased by %d (%s) to %d for %d requesters\n",
986 isoc ? "ISOC" : "INTR",
987 dev->bus->bandwidth_allocated,
988 dev->bus->bandwidth_int_reqs + dev->bus->bandwidth_isoc_reqs);
991 EXPORT_SYMBOL (usb_claim_bandwidth);
995 * usb_release_bandwidth - reverses effect of usb_claim_bandwidth()
996 * @dev: source/target of request
997 * @urb: request (urb->dev == dev)
998 * @isoc: true iff the request is isochronous
1000 * This records that previously allocated bandwidth has been released.
1001 * Bandwidth is released when endpoints are removed from the host controller's
1002 * periodic schedule.
1004 void usb_release_bandwidth (struct usb_device *dev, struct urb *urb, int isoc)
1006 dev->bus->bandwidth_allocated -= urb->bandwidth;
1008 dev->bus->bandwidth_isoc_reqs--;
1010 dev->bus->bandwidth_int_reqs--;
1012 #ifdef USB_BANDWIDTH_MESSAGES
1013 dev_dbg (&dev->dev, "bandwidth alloc reduced by %d (%s) to %d for %d requesters\n",
1015 isoc ? "ISOC" : "INTR",
1016 dev->bus->bandwidth_allocated,
1017 dev->bus->bandwidth_int_reqs + dev->bus->bandwidth_isoc_reqs);
1021 EXPORT_SYMBOL (usb_release_bandwidth);
1024 /*-------------------------------------------------------------------------*/
1027 * Generic HC operations.
1030 /*-------------------------------------------------------------------------*/
1032 static void urb_unlink (struct urb *urb)
1034 unsigned long flags;
1036 /* Release any periodic transfer bandwidth */
1038 usb_release_bandwidth (urb->dev, urb,
1039 usb_pipeisoc (urb->pipe));
1041 /* clear all state linking urb to this dev (and hcd) */
1043 spin_lock_irqsave (&hcd_data_lock, flags);
1044 list_del_init (&urb->urb_list);
1045 spin_unlock_irqrestore (&hcd_data_lock, flags);
1049 /* may be called in any context with a valid urb->dev usecount
1050 * caller surrenders "ownership" of urb
1051 * expects usb_submit_urb() to have sanity checked and conditioned all
1054 int usb_hcd_submit_urb (struct urb *urb, gfp_t mem_flags)
1057 struct usb_hcd *hcd = bus_to_hcd(urb->dev->bus);
1058 struct usb_host_endpoint *ep;
1059 unsigned long flags;
1064 usbmon_urb_submit(&hcd->self, urb);
1067 * Atomically queue the urb, first to our records, then to the HCD.
1068 * Access to urb->status is controlled by urb->lock ... changes on
1069 * i/o completion (normal or fault) or unlinking.
1072 // FIXME: verify that quiescing hc works right (RH cleans up)
1074 spin_lock_irqsave (&hcd_data_lock, flags);
1075 ep = (usb_pipein(urb->pipe) ? urb->dev->ep_in : urb->dev->ep_out)
1076 [usb_pipeendpoint(urb->pipe)];
1079 else if (unlikely (urb->reject))
1081 else switch (hcd->state) {
1082 case HC_STATE_RUNNING:
1083 case HC_STATE_RESUMING:
1085 list_add_tail (&urb->urb_list, &ep->urb_list);
1088 case HC_STATE_SUSPENDED:
1089 /* HC upstream links (register access, wakeup signaling) can work
1090 * even when the downstream links (and DMA etc) are quiesced; let
1091 * usbcore talk to the root hub.
1093 if (hcd->self.controller->power.power_state.event == PM_EVENT_ON
1094 && urb->dev->parent == NULL)
1098 status = -ESHUTDOWN;
1101 spin_unlock_irqrestore (&hcd_data_lock, flags);
1103 INIT_LIST_HEAD (&urb->urb_list);
1104 usbmon_urb_submit_error(&hcd->self, urb, status);
1108 /* increment urb's reference count as part of giving it to the HCD
1109 * (which now controls it). HCD guarantees that it either returns
1110 * an error or calls giveback(), but not both.
1112 urb = usb_get_urb (urb);
1113 atomic_inc (&urb->use_count);
1115 if (urb->dev == hcd->self.root_hub) {
1116 /* NOTE: requirement on hub callers (usbfs and the hub
1117 * driver, for now) that URBs' urb->transfer_buffer be
1118 * valid and usb_buffer_{sync,unmap}() not be needed, since
1119 * they could clobber root hub response data.
1121 status = rh_urb_enqueue (hcd, urb);
1125 /* lower level hcd code should use *_dma exclusively,
1126 * unless it uses pio or talks to another transport.
1128 if (hcd->self.uses_dma) {
1129 if (usb_pipecontrol (urb->pipe)
1130 && !(urb->transfer_flags & URB_NO_SETUP_DMA_MAP))
1131 urb->setup_dma = dma_map_single (
1132 hcd->self.controller,
1134 sizeof (struct usb_ctrlrequest),
1136 if (urb->transfer_buffer_length != 0
1137 && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP))
1138 urb->transfer_dma = dma_map_single (
1139 hcd->self.controller,
1140 urb->transfer_buffer,
1141 urb->transfer_buffer_length,
1142 usb_pipein (urb->pipe)
1147 status = hcd->driver->urb_enqueue (hcd, ep, urb, mem_flags);
1149 if (unlikely (status)) {
1151 atomic_dec (&urb->use_count);
1153 wake_up (&usb_kill_urb_queue);
1155 usbmon_urb_submit_error(&hcd->self, urb, status);
1160 /*-------------------------------------------------------------------------*/
1162 /* called in any context */
1163 int usb_hcd_get_frame_number (struct usb_device *udev)
1165 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1167 if (!HC_IS_RUNNING (hcd->state))
1169 return hcd->driver->get_frame_number (hcd);
1172 /*-------------------------------------------------------------------------*/
1174 /* this makes the hcd giveback() the urb more quickly, by kicking it
1175 * off hardware queues (which may take a while) and returning it as
1176 * soon as practical. we've already set up the urb's return status,
1177 * but we can't know if the callback completed already.
1180 unlink1 (struct usb_hcd *hcd, struct urb *urb)
1184 if (urb->dev == hcd->self.root_hub)
1185 value = usb_rh_urb_dequeue (hcd, urb);
1188 /* The only reason an HCD might fail this call is if
1189 * it has not yet fully queued the urb to begin with.
1190 * Such failures should be harmless. */
1191 value = hcd->driver->urb_dequeue (hcd, urb);
1195 dev_dbg (hcd->self.controller, "dequeue %p --> %d\n",
1201 * called in any context
1203 * caller guarantees urb won't be recycled till both unlink()
1204 * and the urb's completion function return
1206 int usb_hcd_unlink_urb (struct urb *urb, int status)
1208 struct usb_host_endpoint *ep;
1209 struct usb_hcd *hcd = NULL;
1210 struct device *sys = NULL;
1211 unsigned long flags;
1212 struct list_head *tmp;
1217 if (!urb->dev || !urb->dev->bus)
1219 ep = (usb_pipein(urb->pipe) ? urb->dev->ep_in : urb->dev->ep_out)
1220 [usb_pipeendpoint(urb->pipe)];
1225 * we contend for urb->status with the hcd core,
1226 * which changes it while returning the urb.
1228 * Caller guaranteed that the urb pointer hasn't been freed, and
1229 * that it was submitted. But as a rule it can't know whether or
1230 * not it's already been unlinked ... so we respect the reversed
1231 * lock sequence needed for the usb_hcd_giveback_urb() code paths
1232 * (urb lock, then hcd_data_lock) in case some other CPU is now
1235 spin_lock_irqsave (&urb->lock, flags);
1236 spin_lock (&hcd_data_lock);
1238 sys = &urb->dev->dev;
1239 hcd = bus_to_hcd(urb->dev->bus);
1245 /* insist the urb is still queued */
1246 list_for_each(tmp, &ep->urb_list) {
1247 if (tmp == &urb->urb_list)
1250 if (tmp != &urb->urb_list) {
1255 /* Any status except -EINPROGRESS means something already started to
1256 * unlink this URB from the hardware. So there's no more work to do.
1258 if (urb->status != -EINPROGRESS) {
1263 /* IRQ setup can easily be broken so that USB controllers
1264 * never get completion IRQs ... maybe even the ones we need to
1265 * finish unlinking the initial failed usb_set_address()
1266 * or device descriptor fetch.
1268 if (!test_bit(HCD_FLAG_SAW_IRQ, &hcd->flags)
1269 && hcd->self.root_hub != urb->dev) {
1270 dev_warn (hcd->self.controller, "Unlink after no-IRQ? "
1271 "Controller is probably using the wrong IRQ."
1273 set_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
1276 urb->status = status;
1278 spin_unlock (&hcd_data_lock);
1279 spin_unlock_irqrestore (&urb->lock, flags);
1281 retval = unlink1 (hcd, urb);
1283 retval = -EINPROGRESS;
1287 spin_unlock (&hcd_data_lock);
1288 spin_unlock_irqrestore (&urb->lock, flags);
1289 if (retval != -EIDRM && sys && sys->driver)
1290 dev_dbg (sys, "hcd_unlink_urb %p fail %d\n", urb, retval);
1294 /*-------------------------------------------------------------------------*/
1296 /* disables the endpoint: cancels any pending urbs, then synchronizes with
1297 * the hcd to make sure all endpoint state is gone from hardware, and then
1298 * waits until the endpoint's queue is completely drained. use for
1299 * set_configuration, set_interface, driver removal, physical disconnect.
1301 * example: a qh stored in ep->hcpriv, holding state related to endpoint
1302 * type, maxpacket size, toggle, halt status, and scheduling.
1304 void usb_hcd_endpoint_disable (struct usb_device *udev,
1305 struct usb_host_endpoint *ep)
1307 struct usb_hcd *hcd;
1310 hcd = bus_to_hcd(udev->bus);
1312 WARN_ON (!HC_IS_RUNNING (hcd->state) && hcd->state != HC_STATE_HALT &&
1313 udev->state != USB_STATE_NOTATTACHED);
1315 local_irq_disable ();
1317 /* ep is already gone from udev->ep_{in,out}[]; no more submits */
1319 spin_lock (&hcd_data_lock);
1320 list_for_each_entry (urb, &ep->urb_list, urb_list) {
1323 /* the urb may already have been unlinked */
1324 if (urb->status != -EINPROGRESS)
1327 spin_unlock (&hcd_data_lock);
1329 spin_lock (&urb->lock);
1331 if (tmp == -EINPROGRESS)
1332 urb->status = -ESHUTDOWN;
1333 spin_unlock (&urb->lock);
1335 /* kick hcd unless it's already returning this */
1336 if (tmp == -EINPROGRESS) {
1339 dev_dbg (hcd->self.controller,
1340 "shutdown urb %p pipe %08x ep%d%s%s\n",
1341 urb, tmp, usb_pipeendpoint (tmp),
1342 (tmp & USB_DIR_IN) ? "in" : "out",
1344 switch (usb_pipetype (tmp)) { \
1345 case PIPE_CONTROL: s = ""; break; \
1346 case PIPE_BULK: s = "-bulk"; break; \
1347 case PIPE_INTERRUPT: s = "-intr"; break; \
1348 default: s = "-iso"; break; \
1353 /* list contents may have changed */
1356 spin_unlock (&hcd_data_lock);
1357 local_irq_enable ();
1359 /* synchronize with the hardware, so old configuration state
1360 * clears out immediately (and will be freed).
1363 if (hcd->driver->endpoint_disable)
1364 hcd->driver->endpoint_disable (hcd, ep);
1366 /* Wait until the endpoint queue is completely empty. Most HCDs
1367 * will have done this already in their endpoint_disable method,
1368 * but some might not. And there could be root-hub control URBs
1369 * still pending since they aren't affected by the HCDs'
1370 * endpoint_disable methods.
1372 while (!list_empty (&ep->urb_list)) {
1373 spin_lock_irq (&hcd_data_lock);
1375 /* The list may have changed while we acquired the spinlock */
1377 if (!list_empty (&ep->urb_list)) {
1378 urb = list_entry (ep->urb_list.prev, struct urb,
1382 spin_unlock_irq (&hcd_data_lock);
1391 /*-------------------------------------------------------------------------*/
1395 int hcd_bus_suspend (struct usb_bus *bus)
1397 struct usb_hcd *hcd;
1400 hcd = container_of (bus, struct usb_hcd, self);
1401 if (!hcd->driver->bus_suspend)
1403 hcd->state = HC_STATE_QUIESCING;
1404 status = hcd->driver->bus_suspend (hcd);
1406 hcd->state = HC_STATE_SUSPENDED;
1408 dev_dbg(&bus->root_hub->dev, "%s fail, err %d\n",
1413 int hcd_bus_resume (struct usb_bus *bus)
1415 struct usb_hcd *hcd;
1418 hcd = container_of (bus, struct usb_hcd, self);
1419 if (!hcd->driver->bus_resume)
1421 if (hcd->state == HC_STATE_RUNNING)
1423 hcd->state = HC_STATE_RESUMING;
1424 status = hcd->driver->bus_resume (hcd);
1426 hcd->state = HC_STATE_RUNNING;
1428 dev_dbg(&bus->root_hub->dev, "%s fail, err %d\n",
1436 * usb_hcd_resume_root_hub - called by HCD to resume its root hub
1437 * @hcd: host controller for this root hub
1439 * The USB host controller calls this function when its root hub is
1440 * suspended (with the remote wakeup feature enabled) and a remote
1441 * wakeup request is received. It queues a request for khubd to
1442 * resume the root hub (that is, manage its downstream ports again).
1444 void usb_hcd_resume_root_hub (struct usb_hcd *hcd)
1446 unsigned long flags;
1448 spin_lock_irqsave (&hcd_root_hub_lock, flags);
1449 if (hcd->rh_registered)
1450 usb_resume_root_hub (hcd->self.root_hub);
1451 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
1453 EXPORT_SYMBOL_GPL(usb_hcd_resume_root_hub);
1457 /*-------------------------------------------------------------------------*/
1459 #ifdef CONFIG_USB_OTG
1462 * usb_bus_start_enum - start immediate enumeration (for OTG)
1463 * @bus: the bus (must use hcd framework)
1464 * @port_num: 1-based number of port; usually bus->otg_port
1465 * Context: in_interrupt()
1467 * Starts enumeration, with an immediate reset followed later by
1468 * khubd identifying and possibly configuring the device.
1469 * This is needed by OTG controller drivers, where it helps meet
1470 * HNP protocol timing requirements for starting a port reset.
1472 int usb_bus_start_enum(struct usb_bus *bus, unsigned port_num)
1474 struct usb_hcd *hcd;
1475 int status = -EOPNOTSUPP;
1477 /* NOTE: since HNP can't start by grabbing the bus's address0_sem,
1478 * boards with root hubs hooked up to internal devices (instead of
1479 * just the OTG port) may need more attention to resetting...
1481 hcd = container_of (bus, struct usb_hcd, self);
1482 if (port_num && hcd->driver->start_port_reset)
1483 status = hcd->driver->start_port_reset(hcd, port_num);
1485 /* run khubd shortly after (first) root port reset finishes;
1486 * it may issue others, until at least 50 msecs have passed.
1489 mod_timer(&hcd->rh_timer, jiffies + msecs_to_jiffies(10));
1492 EXPORT_SYMBOL (usb_bus_start_enum);
1496 /*-------------------------------------------------------------------------*/
1499 * usb_hcd_giveback_urb - return URB from HCD to device driver
1500 * @hcd: host controller returning the URB
1501 * @urb: urb being returned to the USB device driver.
1502 * @regs: pt_regs, passed down to the URB completion handler
1503 * Context: in_interrupt()
1505 * This hands the URB from HCD to its USB device driver, using its
1506 * completion function. The HCD has freed all per-urb resources
1507 * (and is done using urb->hcpriv). It also released all HCD locks;
1508 * the device driver won't cause problems if it frees, modifies,
1509 * or resubmits this URB.
1511 void usb_hcd_giveback_urb (struct usb_hcd *hcd, struct urb *urb, struct pt_regs *regs)
1515 at_root_hub = (urb->dev == hcd->self.root_hub);
1518 /* lower level hcd code should use *_dma exclusively if the
1519 * host controller does DMA */
1520 if (hcd->self.uses_dma && !at_root_hub) {
1521 if (usb_pipecontrol (urb->pipe)
1522 && !(urb->transfer_flags & URB_NO_SETUP_DMA_MAP))
1523 dma_unmap_single (hcd->self.controller, urb->setup_dma,
1524 sizeof (struct usb_ctrlrequest),
1526 if (urb->transfer_buffer_length != 0
1527 && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP))
1528 dma_unmap_single (hcd->self.controller,
1530 urb->transfer_buffer_length,
1531 usb_pipein (urb->pipe)
1536 usbmon_urb_complete (&hcd->self, urb);
1537 /* pass ownership to the completion handler */
1538 urb->complete (urb, regs);
1539 atomic_dec (&urb->use_count);
1540 if (unlikely (urb->reject))
1541 wake_up (&usb_kill_urb_queue);
1544 EXPORT_SYMBOL (usb_hcd_giveback_urb);
1546 /*-------------------------------------------------------------------------*/
1549 * usb_hcd_irq - hook IRQs to HCD framework (bus glue)
1550 * @irq: the IRQ being raised
1551 * @__hcd: pointer to the HCD whose IRQ is being signaled
1552 * @r: saved hardware registers
1554 * If the controller isn't HALTed, calls the driver's irq handler.
1555 * Checks whether the controller is now dead.
1557 irqreturn_t usb_hcd_irq (int irq, void *__hcd, struct pt_regs * r)
1559 struct usb_hcd *hcd = __hcd;
1560 int start = hcd->state;
1562 if (unlikely(start == HC_STATE_HALT ||
1563 !test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags)))
1565 if (hcd->driver->irq (hcd, r) == IRQ_NONE)
1568 set_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
1570 if (unlikely(hcd->state == HC_STATE_HALT))
1575 /*-------------------------------------------------------------------------*/
1578 * usb_hc_died - report abnormal shutdown of a host controller (bus glue)
1579 * @hcd: pointer to the HCD representing the controller
1581 * This is called by bus glue to report a USB host controller that died
1582 * while operations may still have been pending. It's called automatically
1583 * by the PCI glue, so only glue for non-PCI busses should need to call it.
1585 void usb_hc_died (struct usb_hcd *hcd)
1587 unsigned long flags;
1589 dev_err (hcd->self.controller, "HC died; cleaning up\n");
1591 spin_lock_irqsave (&hcd_root_hub_lock, flags);
1592 if (hcd->rh_registered) {
1595 /* make khubd clean up old urbs and devices */
1596 usb_set_device_state (hcd->self.root_hub,
1597 USB_STATE_NOTATTACHED);
1598 usb_kick_khubd (hcd->self.root_hub);
1600 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
1602 EXPORT_SYMBOL_GPL (usb_hc_died);
1604 /*-------------------------------------------------------------------------*/
1607 * usb_create_hcd - create and initialize an HCD structure
1608 * @driver: HC driver that will use this hcd
1609 * @dev: device for this HC, stored in hcd->self.controller
1610 * @bus_name: value to store in hcd->self.bus_name
1611 * Context: !in_interrupt()
1613 * Allocate a struct usb_hcd, with extra space at the end for the
1614 * HC driver's private data. Initialize the generic members of the
1617 * If memory is unavailable, returns NULL.
1619 struct usb_hcd *usb_create_hcd (const struct hc_driver *driver,
1620 struct device *dev, char *bus_name)
1622 struct usb_hcd *hcd;
1624 hcd = kzalloc(sizeof(*hcd) + driver->hcd_priv_size, GFP_KERNEL);
1626 dev_dbg (dev, "hcd alloc failed\n");
1629 dev_set_drvdata(dev, hcd);
1630 kref_init(&hcd->kref);
1632 usb_bus_init(&hcd->self);
1633 hcd->self.controller = dev;
1634 hcd->self.bus_name = bus_name;
1635 hcd->self.uses_dma = (dev->dma_mask != NULL);
1637 init_timer(&hcd->rh_timer);
1638 hcd->rh_timer.function = rh_timer_func;
1639 hcd->rh_timer.data = (unsigned long) hcd;
1641 hcd->driver = driver;
1642 hcd->product_desc = (driver->product_desc) ? driver->product_desc :
1643 "USB Host Controller";
1647 EXPORT_SYMBOL (usb_create_hcd);
1649 static void hcd_release (struct kref *kref)
1651 struct usb_hcd *hcd = container_of (kref, struct usb_hcd, kref);
1656 struct usb_hcd *usb_get_hcd (struct usb_hcd *hcd)
1659 kref_get (&hcd->kref);
1662 EXPORT_SYMBOL (usb_get_hcd);
1664 void usb_put_hcd (struct usb_hcd *hcd)
1667 kref_put (&hcd->kref, hcd_release);
1669 EXPORT_SYMBOL (usb_put_hcd);
1672 * usb_add_hcd - finish generic HCD structure initialization and register
1673 * @hcd: the usb_hcd structure to initialize
1674 * @irqnum: Interrupt line to allocate
1675 * @irqflags: Interrupt type flags
1677 * Finish the remaining parts of generic HCD initialization: allocate the
1678 * buffers of consistent memory, register the bus, request the IRQ line,
1679 * and call the driver's reset() and start() routines.
1681 int usb_add_hcd(struct usb_hcd *hcd,
1682 unsigned int irqnum, unsigned long irqflags)
1685 struct usb_device *rhdev;
1687 dev_info(hcd->self.controller, "%s\n", hcd->product_desc);
1689 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1691 /* HC is in reset state, but accessible. Now do the one-time init,
1692 * bottom up so that hcds can customize the root hubs before khubd
1693 * starts talking to them. (Note, bus id is assigned early too.)
1695 if ((retval = hcd_buffer_create(hcd)) != 0) {
1696 dev_dbg(hcd->self.controller, "pool alloc failed\n");
1700 if ((retval = usb_register_bus(&hcd->self)) < 0)
1701 goto err_register_bus;
1703 if ((rhdev = usb_alloc_dev(NULL, &hcd->self, 0)) == NULL) {
1704 dev_err(hcd->self.controller, "unable to allocate root hub\n");
1706 goto err_allocate_root_hub;
1708 rhdev->speed = (hcd->driver->flags & HCD_USB2) ? USB_SPEED_HIGH :
1710 hcd->self.root_hub = rhdev;
1712 /* wakeup flag init defaults to "everything works" for root hubs,
1713 * but drivers can override it in reset() if needed, along with
1714 * recording the overall controller's system wakeup capability.
1716 device_init_wakeup(&rhdev->dev, 1);
1718 /* "reset" is misnamed; its role is now one-time init. the controller
1719 * should already have been reset (and boot firmware kicked off etc).
1721 if (hcd->driver->reset && (retval = hcd->driver->reset(hcd)) < 0) {
1722 dev_err(hcd->self.controller, "can't setup\n");
1723 goto err_hcd_driver_setup;
1726 /* NOTE: root hub and controller capabilities may not be the same */
1727 if (device_can_wakeup(hcd->self.controller)
1728 && device_can_wakeup(&hcd->self.root_hub->dev))
1729 dev_dbg(hcd->self.controller, "supports USB remote wakeup\n");
1731 /* enable irqs just before we start the controller */
1732 if (hcd->driver->irq) {
1733 snprintf(hcd->irq_descr, sizeof(hcd->irq_descr), "%s:usb%d",
1734 hcd->driver->description, hcd->self.busnum);
1735 if ((retval = request_irq(irqnum, &usb_hcd_irq, irqflags,
1736 hcd->irq_descr, hcd)) != 0) {
1737 dev_err(hcd->self.controller,
1738 "request interrupt %d failed\n", irqnum);
1739 goto err_request_irq;
1742 dev_info(hcd->self.controller, "irq %d, %s 0x%08llx\n", irqnum,
1743 (hcd->driver->flags & HCD_MEMORY) ?
1744 "io mem" : "io base",
1745 (unsigned long long)hcd->rsrc_start);
1748 if (hcd->rsrc_start)
1749 dev_info(hcd->self.controller, "%s 0x%08llx\n",
1750 (hcd->driver->flags & HCD_MEMORY) ?
1751 "io mem" : "io base",
1752 (unsigned long long)hcd->rsrc_start);
1755 if ((retval = hcd->driver->start(hcd)) < 0) {
1756 dev_err(hcd->self.controller, "startup error %d\n", retval);
1757 goto err_hcd_driver_start;
1760 /* starting here, usbcore will pay attention to this root hub */
1761 rhdev->bus_mA = min(500u, hcd->power_budget);
1762 if ((retval = register_root_hub(hcd)) != 0)
1763 goto err_register_root_hub;
1765 if (hcd->uses_new_polling && hcd->poll_rh)
1766 usb_hcd_poll_rh_status(hcd);
1769 err_register_root_hub:
1770 hcd->driver->stop(hcd);
1771 err_hcd_driver_start:
1773 free_irq(irqnum, hcd);
1775 err_hcd_driver_setup:
1776 hcd->self.root_hub = NULL;
1778 err_allocate_root_hub:
1779 usb_deregister_bus(&hcd->self);
1781 hcd_buffer_destroy(hcd);
1784 EXPORT_SYMBOL (usb_add_hcd);
1787 * usb_remove_hcd - shutdown processing for generic HCDs
1788 * @hcd: the usb_hcd structure to remove
1789 * Context: !in_interrupt()
1791 * Disconnects the root hub, then reverses the effects of usb_add_hcd(),
1792 * invoking the HCD's stop() method.
1794 void usb_remove_hcd(struct usb_hcd *hcd)
1796 dev_info(hcd->self.controller, "remove, state %x\n", hcd->state);
1798 if (HC_IS_RUNNING (hcd->state))
1799 hcd->state = HC_STATE_QUIESCING;
1801 dev_dbg(hcd->self.controller, "roothub graceful disconnect\n");
1802 spin_lock_irq (&hcd_root_hub_lock);
1803 hcd->rh_registered = 0;
1804 spin_unlock_irq (&hcd_root_hub_lock);
1806 mutex_lock(&usb_bus_list_lock);
1807 usb_disconnect(&hcd->self.root_hub);
1808 mutex_unlock(&usb_bus_list_lock);
1811 del_timer_sync(&hcd->rh_timer);
1813 hcd->driver->stop(hcd);
1814 hcd->state = HC_STATE_HALT;
1817 free_irq(hcd->irq, hcd);
1818 usb_deregister_bus(&hcd->self);
1819 hcd_buffer_destroy(hcd);
1821 EXPORT_SYMBOL (usb_remove_hcd);
1824 usb_hcd_platform_shutdown(struct platform_device* dev)
1826 struct usb_hcd *hcd = platform_get_drvdata(dev);
1828 if (hcd->driver->shutdown)
1829 hcd->driver->shutdown(hcd);
1831 EXPORT_SYMBOL (usb_hcd_platform_shutdown);
1833 /*-------------------------------------------------------------------------*/
1835 #if defined(CONFIG_USB_MON)
1837 struct usb_mon_operations *mon_ops;
1840 * The registration is unlocked.
1841 * We do it this way because we do not want to lock in hot paths.
1843 * Notice that the code is minimally error-proof. Because usbmon needs
1844 * symbols from usbcore, usbcore gets referenced and cannot be unloaded first.
1847 int usb_mon_register (struct usb_mon_operations *ops)
1857 EXPORT_SYMBOL_GPL (usb_mon_register);
1859 void usb_mon_deregister (void)
1862 if (mon_ops == NULL) {
1863 printk(KERN_ERR "USB: monitor was not registered\n");
1869 EXPORT_SYMBOL_GPL (usb_mon_deregister);
1871 #endif /* CONFIG_USB_MON */