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/config.h>
26 #include <linux/module.h>
27 #include <linux/version.h>
28 #include <linux/kernel.h>
29 #include <linux/slab.h>
30 #include <linux/completion.h>
31 #include <linux/utsname.h>
34 #include <asm/scatterlist.h>
35 #include <linux/device.h>
36 #include <linux/dma-mapping.h>
38 #include <asm/byteorder.h>
40 #include <linux/usb.h>
47 // #define USB_BANDWIDTH_MESSAGES
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 DECLARE_MUTEX (usb_bus_list_lock); /* exported only for usbfs */
97 EXPORT_SYMBOL_GPL (usb_bus_list_lock);
99 /* used for controlling access to virtual root hubs */
100 static DEFINE_SPINLOCK(hcd_root_hub_lock);
102 /* used when updating hcd data */
103 static DEFINE_SPINLOCK(hcd_data_lock);
105 /* wait queue for synchronous unlinks */
106 DECLARE_WAIT_QUEUE_HEAD(usb_kill_urb_queue);
108 /*-------------------------------------------------------------------------*/
111 * Sharable chunks of root hub code.
114 /*-------------------------------------------------------------------------*/
116 #define KERNEL_REL ((LINUX_VERSION_CODE >> 16) & 0x0ff)
117 #define KERNEL_VER ((LINUX_VERSION_CODE >> 8) & 0x0ff)
119 /* usb 2.0 root hub device descriptor */
120 static const u8 usb2_rh_dev_descriptor [18] = {
121 0x12, /* __u8 bLength; */
122 0x01, /* __u8 bDescriptorType; Device */
123 0x00, 0x02, /* __le16 bcdUSB; v2.0 */
125 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
126 0x00, /* __u8 bDeviceSubClass; */
127 0x01, /* __u8 bDeviceProtocol; [ usb 2.0 single TT ]*/
128 0x40, /* __u8 bMaxPacketSize0; 64 Bytes */
130 0x00, 0x00, /* __le16 idVendor; */
131 0x00, 0x00, /* __le16 idProduct; */
132 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
134 0x03, /* __u8 iManufacturer; */
135 0x02, /* __u8 iProduct; */
136 0x01, /* __u8 iSerialNumber; */
137 0x01 /* __u8 bNumConfigurations; */
140 /* no usb 2.0 root hub "device qualifier" descriptor: one speed only */
142 /* usb 1.1 root hub device descriptor */
143 static const u8 usb11_rh_dev_descriptor [18] = {
144 0x12, /* __u8 bLength; */
145 0x01, /* __u8 bDescriptorType; Device */
146 0x10, 0x01, /* __le16 bcdUSB; v1.1 */
148 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
149 0x00, /* __u8 bDeviceSubClass; */
150 0x00, /* __u8 bDeviceProtocol; [ low/full speeds only ] */
151 0x40, /* __u8 bMaxPacketSize0; 64 Bytes */
153 0x00, 0x00, /* __le16 idVendor; */
154 0x00, 0x00, /* __le16 idProduct; */
155 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
157 0x03, /* __u8 iManufacturer; */
158 0x02, /* __u8 iProduct; */
159 0x01, /* __u8 iSerialNumber; */
160 0x01 /* __u8 bNumConfigurations; */
164 /*-------------------------------------------------------------------------*/
166 /* Configuration descriptors for our root hubs */
168 static const u8 fs_rh_config_descriptor [] = {
170 /* one configuration */
171 0x09, /* __u8 bLength; */
172 0x02, /* __u8 bDescriptorType; Configuration */
173 0x19, 0x00, /* __le16 wTotalLength; */
174 0x01, /* __u8 bNumInterfaces; (1) */
175 0x01, /* __u8 bConfigurationValue; */
176 0x00, /* __u8 iConfiguration; */
177 0xc0, /* __u8 bmAttributes;
182 0x00, /* __u8 MaxPower; */
185 * USB 2.0, single TT organization (mandatory):
186 * one interface, protocol 0
188 * USB 2.0, multiple TT organization (optional):
189 * two interfaces, protocols 1 (like single TT)
190 * and 2 (multiple TT mode) ... config is
196 0x09, /* __u8 if_bLength; */
197 0x04, /* __u8 if_bDescriptorType; Interface */
198 0x00, /* __u8 if_bInterfaceNumber; */
199 0x00, /* __u8 if_bAlternateSetting; */
200 0x01, /* __u8 if_bNumEndpoints; */
201 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
202 0x00, /* __u8 if_bInterfaceSubClass; */
203 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
204 0x00, /* __u8 if_iInterface; */
206 /* one endpoint (status change endpoint) */
207 0x07, /* __u8 ep_bLength; */
208 0x05, /* __u8 ep_bDescriptorType; Endpoint */
209 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
210 0x03, /* __u8 ep_bmAttributes; Interrupt */
211 0x02, 0x00, /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8) */
212 0xff /* __u8 ep_bInterval; (255ms -- usb 2.0 spec) */
215 static const u8 hs_rh_config_descriptor [] = {
217 /* one configuration */
218 0x09, /* __u8 bLength; */
219 0x02, /* __u8 bDescriptorType; Configuration */
220 0x19, 0x00, /* __le16 wTotalLength; */
221 0x01, /* __u8 bNumInterfaces; (1) */
222 0x01, /* __u8 bConfigurationValue; */
223 0x00, /* __u8 iConfiguration; */
224 0xc0, /* __u8 bmAttributes;
229 0x00, /* __u8 MaxPower; */
232 * USB 2.0, single TT organization (mandatory):
233 * one interface, protocol 0
235 * USB 2.0, multiple TT organization (optional):
236 * two interfaces, protocols 1 (like single TT)
237 * and 2 (multiple TT mode) ... config is
243 0x09, /* __u8 if_bLength; */
244 0x04, /* __u8 if_bDescriptorType; Interface */
245 0x00, /* __u8 if_bInterfaceNumber; */
246 0x00, /* __u8 if_bAlternateSetting; */
247 0x01, /* __u8 if_bNumEndpoints; */
248 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
249 0x00, /* __u8 if_bInterfaceSubClass; */
250 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
251 0x00, /* __u8 if_iInterface; */
253 /* one endpoint (status change endpoint) */
254 0x07, /* __u8 ep_bLength; */
255 0x05, /* __u8 ep_bDescriptorType; Endpoint */
256 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
257 0x03, /* __u8 ep_bmAttributes; Interrupt */
258 0x02, 0x00, /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8) */
259 0x0c /* __u8 ep_bInterval; (256ms -- usb 2.0 spec) */
262 /*-------------------------------------------------------------------------*/
265 * helper routine for returning string descriptors in UTF-16LE
266 * input can actually be ISO-8859-1; ASCII is its 7-bit subset
268 static int ascii2utf (char *s, u8 *utf, int utfmax)
272 for (retval = 0; *s && utfmax > 1; utfmax -= 2, retval += 2) {
284 * rh_string - provides manufacturer, product and serial strings for root hub
285 * @id: the string ID number (1: serial number, 2: product, 3: vendor)
286 * @hcd: the host controller for this root hub
287 * @type: string describing our driver
288 * @data: return packet in UTF-16 LE
289 * @len: length of the return packet
291 * Produces either a manufacturer, product or serial number string for the
292 * virtual root hub device.
294 static int rh_string (
304 buf[0] = 4; buf[1] = 3; /* 4 bytes string data */
305 buf[2] = 0x09; buf[3] = 0x04; /* MSFT-speak for "en-us" */
307 memcpy (data, buf, len);
311 } else if (id == 1) {
312 strlcpy (buf, hcd->self.bus_name, sizeof buf);
314 // product description
315 } else if (id == 2) {
316 strlcpy (buf, hcd->product_desc, sizeof buf);
318 // id 3 == vendor description
319 } else if (id == 3) {
320 snprintf (buf, sizeof buf, "%s %s %s", system_utsname.sysname,
321 system_utsname.release, hcd->driver->description);
323 // unsupported IDs --> "protocol stall"
327 switch (len) { /* All cases fall through */
329 len = 2 + ascii2utf (buf, data + 2, len - 2);
331 data [1] = 3; /* type == string */
333 data [0] = 2 * (strlen (buf) + 1);
335 ; /* Compiler wants a statement here */
341 /* Root hub control transfers execute synchronously */
342 static int rh_call_control (struct usb_hcd *hcd, struct urb *urb)
344 struct usb_ctrlrequest *cmd;
345 u16 typeReq, wValue, wIndex, wLength;
346 u8 *ubuf = urb->transfer_buffer;
347 u8 tbuf [sizeof (struct usb_hub_descriptor)]
348 __attribute__((aligned(4)));
349 const u8 *bufp = tbuf;
351 int patch_wakeup = 0;
356 cmd = (struct usb_ctrlrequest *) urb->setup_packet;
357 typeReq = (cmd->bRequestType << 8) | cmd->bRequest;
358 wValue = le16_to_cpu (cmd->wValue);
359 wIndex = le16_to_cpu (cmd->wIndex);
360 wLength = le16_to_cpu (cmd->wLength);
362 if (wLength > urb->transfer_buffer_length)
365 urb->actual_length = 0;
368 /* DEVICE REQUESTS */
370 case DeviceRequest | USB_REQ_GET_STATUS:
371 tbuf [0] = (hcd->remote_wakeup << USB_DEVICE_REMOTE_WAKEUP)
372 | (1 << USB_DEVICE_SELF_POWERED);
376 case DeviceOutRequest | USB_REQ_CLEAR_FEATURE:
377 if (wValue == USB_DEVICE_REMOTE_WAKEUP)
378 hcd->remote_wakeup = 0;
382 case DeviceOutRequest | USB_REQ_SET_FEATURE:
383 if (hcd->can_wakeup && wValue == USB_DEVICE_REMOTE_WAKEUP)
384 hcd->remote_wakeup = 1;
388 case DeviceRequest | USB_REQ_GET_CONFIGURATION:
392 case DeviceOutRequest | USB_REQ_SET_CONFIGURATION:
394 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
395 switch (wValue & 0xff00) {
396 case USB_DT_DEVICE << 8:
397 if (hcd->driver->flags & HCD_USB2)
398 bufp = usb2_rh_dev_descriptor;
399 else if (hcd->driver->flags & HCD_USB11)
400 bufp = usb11_rh_dev_descriptor;
405 case USB_DT_CONFIG << 8:
406 if (hcd->driver->flags & HCD_USB2) {
407 bufp = hs_rh_config_descriptor;
408 len = sizeof hs_rh_config_descriptor;
410 bufp = fs_rh_config_descriptor;
411 len = sizeof fs_rh_config_descriptor;
416 case USB_DT_STRING << 8:
417 n = rh_string (wValue & 0xff, hcd, ubuf, wLength);
420 urb->actual_length = n;
426 case DeviceRequest | USB_REQ_GET_INTERFACE:
430 case DeviceOutRequest | USB_REQ_SET_INTERFACE:
432 case DeviceOutRequest | USB_REQ_SET_ADDRESS:
433 // wValue == urb->dev->devaddr
434 dev_dbg (hcd->self.controller, "root hub device address %d\n",
438 /* INTERFACE REQUESTS (no defined feature/status flags) */
440 /* ENDPOINT REQUESTS */
442 case EndpointRequest | USB_REQ_GET_STATUS:
443 // ENDPOINT_HALT flag
448 case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
449 case EndpointOutRequest | USB_REQ_SET_FEATURE:
450 dev_dbg (hcd->self.controller, "no endpoint features yet\n");
453 /* CLASS REQUESTS (and errors) */
456 /* non-generic request */
462 case GetHubDescriptor:
463 len = sizeof (struct usb_hub_descriptor);
466 status = hcd->driver->hub_control (hcd,
467 typeReq, wValue, wIndex,
471 /* "protocol stall" on error */
477 if (status != -EPIPE) {
478 dev_dbg (hcd->self.controller,
479 "CTRL: TypeReq=0x%x val=0x%x "
480 "idx=0x%x len=%d ==> %d\n",
481 typeReq, wValue, wIndex,
486 if (urb->transfer_buffer_length < len)
487 len = urb->transfer_buffer_length;
488 urb->actual_length = len;
489 // always USB_DIR_IN, toward host
490 memcpy (ubuf, bufp, len);
492 /* report whether RH hardware supports remote wakeup */
494 len > offsetof (struct usb_config_descriptor,
496 ((struct usb_config_descriptor *)ubuf)->bmAttributes
497 |= USB_CONFIG_ATT_WAKEUP;
500 /* any errors get returned through the urb completion */
501 local_irq_save (flags);
502 spin_lock (&urb->lock);
503 if (urb->status == -EINPROGRESS)
504 urb->status = status;
505 spin_unlock (&urb->lock);
506 usb_hcd_giveback_urb (hcd, urb, NULL);
507 local_irq_restore (flags);
511 /*-------------------------------------------------------------------------*/
514 * Root Hub interrupt transfers are polled using a timer if the
515 * driver requests it; otherwise the driver is responsible for
516 * calling usb_hcd_poll_rh_status() when an event occurs.
518 * Completions are called in_interrupt(), but they may or may not
521 void usb_hcd_poll_rh_status(struct usb_hcd *hcd)
526 char buffer[4]; /* Any root hubs with > 31 ports? */
528 if (!hcd->uses_new_polling && !hcd->status_urb)
531 length = hcd->driver->hub_status_data(hcd, buffer);
534 /* try to complete the status urb */
535 local_irq_save (flags);
536 spin_lock(&hcd_root_hub_lock);
537 urb = hcd->status_urb;
539 spin_lock(&urb->lock);
540 if (urb->status == -EINPROGRESS) {
541 hcd->poll_pending = 0;
542 hcd->status_urb = NULL;
545 urb->actual_length = length;
546 memcpy(urb->transfer_buffer, buffer, length);
547 } else /* urb has been unlinked */
549 spin_unlock(&urb->lock);
552 spin_unlock(&hcd_root_hub_lock);
554 /* local irqs are always blocked in completions */
556 usb_hcd_giveback_urb (hcd, urb, NULL);
558 hcd->poll_pending = 1;
559 local_irq_restore (flags);
562 /* The USB 2.0 spec says 256 ms. This is close enough and won't
563 * exceed that limit if HZ is 100. */
564 if (hcd->uses_new_polling ? hcd->poll_rh :
565 (length == 0 && hcd->status_urb != NULL))
566 mod_timer (&hcd->rh_timer, jiffies + msecs_to_jiffies(250));
568 EXPORT_SYMBOL_GPL(usb_hcd_poll_rh_status);
571 static void rh_timer_func (unsigned long _hcd)
573 usb_hcd_poll_rh_status((struct usb_hcd *) _hcd);
576 /*-------------------------------------------------------------------------*/
578 static int rh_queue_status (struct usb_hcd *hcd, struct urb *urb)
582 int len = 1 + (urb->dev->maxchild / 8);
584 spin_lock_irqsave (&hcd_root_hub_lock, flags);
585 if (urb->status != -EINPROGRESS) /* already unlinked */
586 retval = urb->status;
587 else if (hcd->status_urb || urb->transfer_buffer_length < len) {
588 dev_dbg (hcd->self.controller, "not queuing rh status urb\n");
591 hcd->status_urb = urb;
592 urb->hcpriv = hcd; /* indicate it's queued */
594 if (!hcd->uses_new_polling)
595 mod_timer (&hcd->rh_timer, jiffies +
596 msecs_to_jiffies(250));
598 /* If a status change has already occurred, report it ASAP */
599 else if (hcd->poll_pending)
600 mod_timer (&hcd->rh_timer, jiffies);
603 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
607 static int rh_urb_enqueue (struct usb_hcd *hcd, struct urb *urb)
609 if (usb_pipeint (urb->pipe))
610 return rh_queue_status (hcd, urb);
611 if (usb_pipecontrol (urb->pipe))
612 return rh_call_control (hcd, urb);
616 /*-------------------------------------------------------------------------*/
618 /* Asynchronous unlinks of root-hub control URBs are legal, but they
619 * don't do anything. Status URB unlinks must be made in process context
620 * with interrupts enabled.
622 static int usb_rh_urb_dequeue (struct usb_hcd *hcd, struct urb *urb)
624 if (usb_pipeendpoint(urb->pipe) == 0) { /* Control URB */
626 return 0; /* nothing to do */
628 spin_lock_irq(&urb->lock); /* from usb_kill_urb */
630 spin_unlock_irq(&urb->lock);
632 wait_event(usb_kill_urb_queue,
633 atomic_read(&urb->use_count) == 0);
635 spin_lock_irq(&urb->lock);
637 spin_unlock_irq(&urb->lock);
639 } else { /* Status URB */
640 if (!hcd->uses_new_polling)
641 del_timer_sync (&hcd->rh_timer);
642 local_irq_disable ();
643 spin_lock (&hcd_root_hub_lock);
644 if (urb == hcd->status_urb) {
645 hcd->status_urb = NULL;
648 urb = NULL; /* wasn't fully queued */
649 spin_unlock (&hcd_root_hub_lock);
651 usb_hcd_giveback_urb (hcd, urb, NULL);
658 /*-------------------------------------------------------------------------*/
660 /* exported only within usbcore */
661 struct usb_bus *usb_bus_get(struct usb_bus *bus)
664 kref_get(&bus->kref);
668 static void usb_host_release(struct kref *kref)
670 struct usb_bus *bus = container_of(kref, struct usb_bus, kref);
676 /* exported only within usbcore */
677 void usb_bus_put(struct usb_bus *bus)
680 kref_put(&bus->kref, usb_host_release);
683 /*-------------------------------------------------------------------------*/
685 static struct class *usb_host_class;
687 int usb_host_init(void)
691 usb_host_class = class_create(THIS_MODULE, "usb_host");
692 if (IS_ERR(usb_host_class))
693 retval = PTR_ERR(usb_host_class);
697 void usb_host_cleanup(void)
699 class_destroy(usb_host_class);
703 * usb_bus_init - shared initialization code
704 * @bus: the bus structure being initialized
706 * This code is used to initialize a usb_bus structure, memory for which is
707 * separately managed.
709 static void usb_bus_init (struct usb_bus *bus)
711 memset (&bus->devmap, 0, sizeof(struct usb_devmap));
713 bus->devnum_next = 1;
715 bus->root_hub = NULL;
718 bus->bandwidth_allocated = 0;
719 bus->bandwidth_int_reqs = 0;
720 bus->bandwidth_isoc_reqs = 0;
722 INIT_LIST_HEAD (&bus->bus_list);
724 kref_init(&bus->kref);
728 * usb_alloc_bus - creates a new USB host controller structure
729 * @op: pointer to a struct usb_operations that this bus structure should use
730 * Context: !in_interrupt()
732 * Creates a USB host controller bus structure with the specified
733 * usb_operations and initializes all the necessary internal objects.
735 * If no memory is available, NULL is returned.
737 * The caller should call usb_put_bus() when it is finished with the structure.
739 struct usb_bus *usb_alloc_bus (struct usb_operations *op)
743 bus = kzalloc (sizeof *bus, GFP_KERNEL);
751 /*-------------------------------------------------------------------------*/
754 * usb_register_bus - registers the USB host controller with the usb core
755 * @bus: pointer to the bus to register
756 * Context: !in_interrupt()
758 * Assigns a bus number, and links the controller into usbcore data
759 * structures so that it can be seen by scanning the bus list.
761 static int usb_register_bus(struct usb_bus *bus)
765 down (&usb_bus_list_lock);
766 busnum = find_next_zero_bit (busmap.busmap, USB_MAXBUS, 1);
767 if (busnum < USB_MAXBUS) {
768 set_bit (busnum, busmap.busmap);
769 bus->busnum = busnum;
771 printk (KERN_ERR "%s: too many buses\n", usbcore_name);
772 up(&usb_bus_list_lock);
776 bus->class_dev = class_device_create(usb_host_class, NULL, MKDEV(0,0),
777 bus->controller, "usb_host%d", busnum);
778 if (IS_ERR(bus->class_dev)) {
779 clear_bit(busnum, busmap.busmap);
780 up(&usb_bus_list_lock);
781 return PTR_ERR(bus->class_dev);
784 class_set_devdata(bus->class_dev, bus);
786 /* Add it to the local list of buses */
787 list_add (&bus->bus_list, &usb_bus_list);
788 up (&usb_bus_list_lock);
790 usb_notify_add_bus(bus);
792 dev_info (bus->controller, "new USB bus registered, assigned bus number %d\n", bus->busnum);
797 * usb_deregister_bus - deregisters the USB host controller
798 * @bus: pointer to the bus to deregister
799 * Context: !in_interrupt()
801 * Recycles the bus number, and unlinks the controller from usbcore data
802 * structures so that it won't be seen by scanning the bus list.
804 static void usb_deregister_bus (struct usb_bus *bus)
806 dev_info (bus->controller, "USB bus %d deregistered\n", bus->busnum);
809 * NOTE: make sure that all the devices are removed by the
810 * controller code, as well as having it call this when cleaning
813 down (&usb_bus_list_lock);
814 list_del (&bus->bus_list);
815 up (&usb_bus_list_lock);
817 usb_notify_remove_bus(bus);
819 clear_bit (bus->busnum, busmap.busmap);
821 class_device_unregister(bus->class_dev);
825 * register_root_hub - called by usb_add_hcd() to register a root hub
826 * @usb_dev: the usb root hub device to be registered.
827 * @hcd: host controller for this root hub
829 * This function registers the root hub with the USB subsystem. It sets up
830 * the device properly in the device tree and stores the root_hub pointer
831 * in the bus structure, then calls usb_new_device() to register the usb
832 * device. It also assigns the root hub's USB address (always 1).
834 static int register_root_hub (struct usb_device *usb_dev,
837 struct device *parent_dev = hcd->self.controller;
838 const int devnum = 1;
841 usb_dev->devnum = devnum;
842 usb_dev->bus->devnum_next = devnum + 1;
843 memset (&usb_dev->bus->devmap.devicemap, 0,
844 sizeof usb_dev->bus->devmap.devicemap);
845 set_bit (devnum, usb_dev->bus->devmap.devicemap);
846 usb_set_device_state(usb_dev, USB_STATE_ADDRESS);
848 down (&usb_bus_list_lock);
849 usb_dev->bus->root_hub = usb_dev;
851 usb_dev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
852 retval = usb_get_device_descriptor(usb_dev, USB_DT_DEVICE_SIZE);
853 if (retval != sizeof usb_dev->descriptor) {
854 usb_dev->bus->root_hub = NULL;
855 up (&usb_bus_list_lock);
856 dev_dbg (parent_dev, "can't read %s device descriptor %d\n",
857 usb_dev->dev.bus_id, retval);
858 return (retval < 0) ? retval : -EMSGSIZE;
861 retval = usb_new_device (usb_dev);
863 usb_dev->bus->root_hub = NULL;
864 dev_err (parent_dev, "can't register root hub for %s, %d\n",
865 usb_dev->dev.bus_id, retval);
867 up (&usb_bus_list_lock);
870 spin_lock_irq (&hcd_root_hub_lock);
871 hcd->rh_registered = 1;
872 spin_unlock_irq (&hcd_root_hub_lock);
874 /* Did the HC die before the root hub was registered? */
875 if (hcd->state == HC_STATE_HALT)
876 usb_hc_died (hcd); /* This time clean up */
882 void usb_enable_root_hub_irq (struct usb_bus *bus)
886 hcd = container_of (bus, struct usb_hcd, self);
887 if (hcd->driver->hub_irq_enable && !hcd->poll_rh &&
888 hcd->state != HC_STATE_HALT)
889 hcd->driver->hub_irq_enable (hcd);
893 /*-------------------------------------------------------------------------*/
896 * usb_calc_bus_time - approximate periodic transaction time in nanoseconds
897 * @speed: from dev->speed; USB_SPEED_{LOW,FULL,HIGH}
898 * @is_input: true iff the transaction sends data to the host
899 * @isoc: true for isochronous transactions, false for interrupt ones
900 * @bytecount: how many bytes in the transaction.
902 * Returns approximate bus time in nanoseconds for a periodic transaction.
903 * See USB 2.0 spec section 5.11.3; only periodic transfers need to be
904 * scheduled in software, this function is only used for such scheduling.
906 long usb_calc_bus_time (int speed, int is_input, int isoc, int bytecount)
911 case USB_SPEED_LOW: /* INTR only */
913 tmp = (67667L * (31L + 10L * BitTime (bytecount))) / 1000L;
914 return (64060L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp);
916 tmp = (66700L * (31L + 10L * BitTime (bytecount))) / 1000L;
917 return (64107L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp);
919 case USB_SPEED_FULL: /* ISOC or INTR */
921 tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
922 return (((is_input) ? 7268L : 6265L) + BW_HOST_DELAY + tmp);
924 tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
925 return (9107L + BW_HOST_DELAY + tmp);
927 case USB_SPEED_HIGH: /* ISOC or INTR */
928 // FIXME adjust for input vs output
930 tmp = HS_NSECS_ISO (bytecount);
932 tmp = HS_NSECS (bytecount);
935 pr_debug ("%s: bogus device speed!\n", usbcore_name);
939 EXPORT_SYMBOL (usb_calc_bus_time);
942 * usb_check_bandwidth():
944 * old_alloc is from host_controller->bandwidth_allocated in microseconds;
945 * bustime is from calc_bus_time(), but converted to microseconds.
947 * returns <bustime in us> if successful,
948 * or -ENOSPC if bandwidth request fails.
951 * This initial implementation does not use Endpoint.bInterval
952 * in managing bandwidth allocation.
953 * It probably needs to be expanded to use Endpoint.bInterval.
954 * This can be done as a later enhancement (correction).
956 * This will also probably require some kind of
957 * frame allocation tracking...meaning, for example,
958 * that if multiple drivers request interrupts every 10 USB frames,
959 * they don't all have to be allocated at
960 * frame numbers N, N+10, N+20, etc. Some of them could be at
961 * N+11, N+21, N+31, etc., and others at
962 * N+12, N+22, N+32, etc.
964 * Similarly for isochronous transfers...
966 * Individual HCDs can schedule more directly ... this logic
967 * is not correct for high speed transfers.
969 int usb_check_bandwidth (struct usb_device *dev, struct urb *urb)
971 unsigned int pipe = urb->pipe;
973 int is_in = usb_pipein (pipe);
974 int is_iso = usb_pipeisoc (pipe);
975 int old_alloc = dev->bus->bandwidth_allocated;
979 bustime = NS_TO_US (usb_calc_bus_time (dev->speed, is_in, is_iso,
980 usb_maxpacket (dev, pipe, !is_in)));
982 bustime /= urb->number_of_packets;
984 new_alloc = old_alloc + (int) bustime;
985 if (new_alloc > FRAME_TIME_MAX_USECS_ALLOC) {
988 #ifdef CONFIG_USB_BANDWIDTH
993 dev_dbg (&dev->dev, "usb_check_bandwidth %sFAILED: %d + %ld = %d usec\n",
994 mode, old_alloc, bustime, new_alloc);
996 #ifdef CONFIG_USB_BANDWIDTH
997 bustime = -ENOSPC; /* report error */
1003 EXPORT_SYMBOL (usb_check_bandwidth);
1007 * usb_claim_bandwidth - records bandwidth for a periodic transfer
1008 * @dev: source/target of request
1009 * @urb: request (urb->dev == dev)
1010 * @bustime: bandwidth consumed, in (average) microseconds per frame
1011 * @isoc: true iff the request is isochronous
1013 * Bus bandwidth reservations are recorded purely for diagnostic purposes.
1014 * HCDs are expected not to overcommit periodic bandwidth, and to record such
1015 * reservations whenever endpoints are added to the periodic schedule.
1017 * FIXME averaging per-frame is suboptimal. Better to sum over the HCD's
1018 * entire periodic schedule ... 32 frames for OHCI, 1024 for UHCI, settable
1019 * for EHCI (256/512/1024 frames, default 1024) and have the bus expose how
1020 * large its periodic schedule is.
1022 void usb_claim_bandwidth (struct usb_device *dev, struct urb *urb, int bustime, int isoc)
1024 dev->bus->bandwidth_allocated += bustime;
1026 dev->bus->bandwidth_isoc_reqs++;
1028 dev->bus->bandwidth_int_reqs++;
1029 urb->bandwidth = bustime;
1031 #ifdef USB_BANDWIDTH_MESSAGES
1032 dev_dbg (&dev->dev, "bandwidth alloc increased by %d (%s) to %d for %d requesters\n",
1034 isoc ? "ISOC" : "INTR",
1035 dev->bus->bandwidth_allocated,
1036 dev->bus->bandwidth_int_reqs + dev->bus->bandwidth_isoc_reqs);
1039 EXPORT_SYMBOL (usb_claim_bandwidth);
1043 * usb_release_bandwidth - reverses effect of usb_claim_bandwidth()
1044 * @dev: source/target of request
1045 * @urb: request (urb->dev == dev)
1046 * @isoc: true iff the request is isochronous
1048 * This records that previously allocated bandwidth has been released.
1049 * Bandwidth is released when endpoints are removed from the host controller's
1050 * periodic schedule.
1052 void usb_release_bandwidth (struct usb_device *dev, struct urb *urb, int isoc)
1054 dev->bus->bandwidth_allocated -= urb->bandwidth;
1056 dev->bus->bandwidth_isoc_reqs--;
1058 dev->bus->bandwidth_int_reqs--;
1060 #ifdef USB_BANDWIDTH_MESSAGES
1061 dev_dbg (&dev->dev, "bandwidth alloc reduced by %d (%s) to %d for %d requesters\n",
1063 isoc ? "ISOC" : "INTR",
1064 dev->bus->bandwidth_allocated,
1065 dev->bus->bandwidth_int_reqs + dev->bus->bandwidth_isoc_reqs);
1069 EXPORT_SYMBOL (usb_release_bandwidth);
1072 /*-------------------------------------------------------------------------*/
1075 * Generic HC operations.
1078 /*-------------------------------------------------------------------------*/
1080 static void urb_unlink (struct urb *urb)
1082 unsigned long flags;
1084 /* Release any periodic transfer bandwidth */
1086 usb_release_bandwidth (urb->dev, urb,
1087 usb_pipeisoc (urb->pipe));
1089 /* clear all state linking urb to this dev (and hcd) */
1091 spin_lock_irqsave (&hcd_data_lock, flags);
1092 list_del_init (&urb->urb_list);
1093 spin_unlock_irqrestore (&hcd_data_lock, flags);
1094 usb_put_dev (urb->dev);
1098 /* may be called in any context with a valid urb->dev usecount
1099 * caller surrenders "ownership" of urb
1100 * expects usb_submit_urb() to have sanity checked and conditioned all
1103 static int hcd_submit_urb (struct urb *urb, gfp_t mem_flags)
1106 struct usb_hcd *hcd = urb->dev->bus->hcpriv;
1107 struct usb_host_endpoint *ep;
1108 unsigned long flags;
1113 usbmon_urb_submit(&hcd->self, urb);
1116 * Atomically queue the urb, first to our records, then to the HCD.
1117 * Access to urb->status is controlled by urb->lock ... changes on
1118 * i/o completion (normal or fault) or unlinking.
1121 // FIXME: verify that quiescing hc works right (RH cleans up)
1123 spin_lock_irqsave (&hcd_data_lock, flags);
1124 ep = (usb_pipein(urb->pipe) ? urb->dev->ep_in : urb->dev->ep_out)
1125 [usb_pipeendpoint(urb->pipe)];
1128 else if (unlikely (urb->reject))
1130 else switch (hcd->state) {
1131 case HC_STATE_RUNNING:
1132 case HC_STATE_RESUMING:
1134 usb_get_dev (urb->dev);
1135 list_add_tail (&urb->urb_list, &ep->urb_list);
1138 case HC_STATE_SUSPENDED:
1139 /* HC upstream links (register access, wakeup signaling) can work
1140 * even when the downstream links (and DMA etc) are quiesced; let
1141 * usbcore talk to the root hub.
1143 if (hcd->self.controller->power.power_state.event == PM_EVENT_ON
1144 && urb->dev->parent == NULL)
1148 status = -ESHUTDOWN;
1151 spin_unlock_irqrestore (&hcd_data_lock, flags);
1153 INIT_LIST_HEAD (&urb->urb_list);
1154 usbmon_urb_submit_error(&hcd->self, urb, status);
1158 /* increment urb's reference count as part of giving it to the HCD
1159 * (which now controls it). HCD guarantees that it either returns
1160 * an error or calls giveback(), but not both.
1162 urb = usb_get_urb (urb);
1163 atomic_inc (&urb->use_count);
1165 if (urb->dev == hcd->self.root_hub) {
1166 /* NOTE: requirement on hub callers (usbfs and the hub
1167 * driver, for now) that URBs' urb->transfer_buffer be
1168 * valid and usb_buffer_{sync,unmap}() not be needed, since
1169 * they could clobber root hub response data.
1171 status = rh_urb_enqueue (hcd, urb);
1175 /* lower level hcd code should use *_dma exclusively,
1176 * unless it uses pio or talks to another transport.
1178 if (hcd->self.controller->dma_mask) {
1179 if (usb_pipecontrol (urb->pipe)
1180 && !(urb->transfer_flags & URB_NO_SETUP_DMA_MAP))
1181 urb->setup_dma = dma_map_single (
1182 hcd->self.controller,
1184 sizeof (struct usb_ctrlrequest),
1186 if (urb->transfer_buffer_length != 0
1187 && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP))
1188 urb->transfer_dma = dma_map_single (
1189 hcd->self.controller,
1190 urb->transfer_buffer,
1191 urb->transfer_buffer_length,
1192 usb_pipein (urb->pipe)
1197 status = hcd->driver->urb_enqueue (hcd, ep, urb, mem_flags);
1199 if (unlikely (status)) {
1201 atomic_dec (&urb->use_count);
1203 wake_up (&usb_kill_urb_queue);
1205 usbmon_urb_submit_error(&hcd->self, urb, status);
1210 /*-------------------------------------------------------------------------*/
1212 /* called in any context */
1213 static int hcd_get_frame_number (struct usb_device *udev)
1215 struct usb_hcd *hcd = (struct usb_hcd *)udev->bus->hcpriv;
1216 if (!HC_IS_RUNNING (hcd->state))
1218 return hcd->driver->get_frame_number (hcd);
1221 /*-------------------------------------------------------------------------*/
1223 /* this makes the hcd giveback() the urb more quickly, by kicking it
1224 * off hardware queues (which may take a while) and returning it as
1225 * soon as practical. we've already set up the urb's return status,
1226 * but we can't know if the callback completed already.
1229 unlink1 (struct usb_hcd *hcd, struct urb *urb)
1233 if (urb->dev == hcd->self.root_hub)
1234 value = usb_rh_urb_dequeue (hcd, urb);
1237 /* The only reason an HCD might fail this call is if
1238 * it has not yet fully queued the urb to begin with.
1239 * Such failures should be harmless. */
1240 value = hcd->driver->urb_dequeue (hcd, urb);
1244 dev_dbg (hcd->self.controller, "dequeue %p --> %d\n",
1250 * called in any context
1252 * caller guarantees urb won't be recycled till both unlink()
1253 * and the urb's completion function return
1255 static int hcd_unlink_urb (struct urb *urb, int status)
1257 struct usb_host_endpoint *ep;
1258 struct usb_hcd *hcd = NULL;
1259 struct device *sys = NULL;
1260 unsigned long flags;
1261 struct list_head *tmp;
1266 if (!urb->dev || !urb->dev->bus)
1268 ep = (usb_pipein(urb->pipe) ? urb->dev->ep_in : urb->dev->ep_out)
1269 [usb_pipeendpoint(urb->pipe)];
1274 * we contend for urb->status with the hcd core,
1275 * which changes it while returning the urb.
1277 * Caller guaranteed that the urb pointer hasn't been freed, and
1278 * that it was submitted. But as a rule it can't know whether or
1279 * not it's already been unlinked ... so we respect the reversed
1280 * lock sequence needed for the usb_hcd_giveback_urb() code paths
1281 * (urb lock, then hcd_data_lock) in case some other CPU is now
1284 spin_lock_irqsave (&urb->lock, flags);
1285 spin_lock (&hcd_data_lock);
1287 sys = &urb->dev->dev;
1288 hcd = urb->dev->bus->hcpriv;
1294 /* insist the urb is still queued */
1295 list_for_each(tmp, &ep->urb_list) {
1296 if (tmp == &urb->urb_list)
1299 if (tmp != &urb->urb_list) {
1304 /* Any status except -EINPROGRESS means something already started to
1305 * unlink this URB from the hardware. So there's no more work to do.
1307 if (urb->status != -EINPROGRESS) {
1312 /* IRQ setup can easily be broken so that USB controllers
1313 * never get completion IRQs ... maybe even the ones we need to
1314 * finish unlinking the initial failed usb_set_address()
1315 * or device descriptor fetch.
1317 if (!test_bit(HCD_FLAG_SAW_IRQ, &hcd->flags)
1318 && hcd->self.root_hub != urb->dev) {
1319 dev_warn (hcd->self.controller, "Unlink after no-IRQ? "
1320 "Controller is probably using the wrong IRQ."
1322 set_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
1325 urb->status = status;
1327 spin_unlock (&hcd_data_lock);
1328 spin_unlock_irqrestore (&urb->lock, flags);
1330 retval = unlink1 (hcd, urb);
1332 retval = -EINPROGRESS;
1336 spin_unlock (&hcd_data_lock);
1337 spin_unlock_irqrestore (&urb->lock, flags);
1338 if (retval != -EIDRM && sys && sys->driver)
1339 dev_dbg (sys, "hcd_unlink_urb %p fail %d\n", urb, retval);
1343 /*-------------------------------------------------------------------------*/
1345 /* disables the endpoint: cancels any pending urbs, then synchronizes with
1346 * the hcd to make sure all endpoint state is gone from hardware. use for
1347 * set_configuration, set_interface, driver removal, physical disconnect.
1349 * example: a qh stored in ep->hcpriv, holding state related to endpoint
1350 * type, maxpacket size, toggle, halt status, and scheduling.
1353 hcd_endpoint_disable (struct usb_device *udev, struct usb_host_endpoint *ep)
1355 struct usb_hcd *hcd;
1358 hcd = udev->bus->hcpriv;
1360 WARN_ON (!HC_IS_RUNNING (hcd->state) && hcd->state != HC_STATE_HALT &&
1361 udev->state != USB_STATE_NOTATTACHED);
1363 local_irq_disable ();
1365 /* FIXME move most of this into message.c as part of its
1366 * endpoint disable logic
1369 /* ep is already gone from udev->ep_{in,out}[]; no more submits */
1371 spin_lock (&hcd_data_lock);
1372 list_for_each_entry (urb, &ep->urb_list, urb_list) {
1375 /* another cpu may be in hcd, spinning on hcd_data_lock
1376 * to giveback() this urb. the races here should be
1377 * small, but a full fix needs a new "can't submit"
1379 * FIXME urb->reject should allow that...
1381 if (urb->status != -EINPROGRESS)
1384 spin_unlock (&hcd_data_lock);
1386 spin_lock (&urb->lock);
1388 if (tmp == -EINPROGRESS)
1389 urb->status = -ESHUTDOWN;
1390 spin_unlock (&urb->lock);
1392 /* kick hcd unless it's already returning this */
1393 if (tmp == -EINPROGRESS) {
1396 dev_dbg (hcd->self.controller,
1397 "shutdown urb %p pipe %08x ep%d%s%s\n",
1398 urb, tmp, usb_pipeendpoint (tmp),
1399 (tmp & USB_DIR_IN) ? "in" : "out",
1401 switch (usb_pipetype (tmp)) { \
1402 case PIPE_CONTROL: s = ""; break; \
1403 case PIPE_BULK: s = "-bulk"; break; \
1404 case PIPE_INTERRUPT: s = "-intr"; break; \
1405 default: s = "-iso"; break; \
1410 /* list contents may have changed */
1413 spin_unlock (&hcd_data_lock);
1414 local_irq_enable ();
1416 /* synchronize with the hardware, so old configuration state
1417 * clears out immediately (and will be freed).
1420 if (hcd->driver->endpoint_disable)
1421 hcd->driver->endpoint_disable (hcd, ep);
1424 /*-------------------------------------------------------------------------*/
1428 int hcd_bus_suspend (struct usb_bus *bus)
1430 struct usb_hcd *hcd;
1433 hcd = container_of (bus, struct usb_hcd, self);
1434 if (!hcd->driver->bus_suspend)
1436 hcd->state = HC_STATE_QUIESCING;
1437 status = hcd->driver->bus_suspend (hcd);
1439 hcd->state = HC_STATE_SUSPENDED;
1441 dev_dbg(&bus->root_hub->dev, "%s fail, err %d\n",
1446 int hcd_bus_resume (struct usb_bus *bus)
1448 struct usb_hcd *hcd;
1451 hcd = container_of (bus, struct usb_hcd, self);
1452 if (!hcd->driver->bus_resume)
1454 if (hcd->state == HC_STATE_RUNNING)
1456 hcd->state = HC_STATE_RESUMING;
1457 status = hcd->driver->bus_resume (hcd);
1459 hcd->state = HC_STATE_RUNNING;
1461 dev_dbg(&bus->root_hub->dev, "%s fail, err %d\n",
1469 * usb_hcd_suspend_root_hub - HCD autosuspends downstream ports
1470 * @hcd: host controller for this root hub
1472 * This call arranges that usb_hcd_resume_root_hub() is safe to call later;
1473 * that the HCD's root hub polling is deactivated; and that the root's hub
1474 * driver is suspended. HCDs may call this to autosuspend when their root
1475 * hub's downstream ports are all inactive: unpowered, disconnected,
1476 * disabled, or suspended.
1478 * The HCD will autoresume on device connect change detection (using SRP
1479 * or a D+/D- pullup). The HCD also autoresumes on remote wakeup signaling
1480 * from any ports that are suspended (if that is enabled). In most cases,
1481 * overcurrent signaling (on powered ports) will also start autoresume.
1483 * Always called with IRQs blocked.
1485 void usb_hcd_suspend_root_hub (struct usb_hcd *hcd)
1489 spin_lock (&hcd_root_hub_lock);
1490 usb_suspend_root_hub (hcd->self.root_hub);
1492 /* force status urb to complete/unlink while suspended */
1493 if (hcd->status_urb) {
1494 urb = hcd->status_urb;
1495 urb->status = -ECONNRESET;
1497 urb->actual_length = 0;
1499 del_timer (&hcd->rh_timer);
1500 hcd->poll_pending = 0;
1501 hcd->status_urb = NULL;
1504 spin_unlock (&hcd_root_hub_lock);
1505 hcd->state = HC_STATE_SUSPENDED;
1508 usb_hcd_giveback_urb (hcd, urb, NULL);
1510 EXPORT_SYMBOL_GPL(usb_hcd_suspend_root_hub);
1513 * usb_hcd_resume_root_hub - called by HCD to resume its root hub
1514 * @hcd: host controller for this root hub
1516 * The USB host controller calls this function when its root hub is
1517 * suspended (with the remote wakeup feature enabled) and a remote
1518 * wakeup request is received. It queues a request for khubd to
1519 * resume the root hub (that is, manage its downstream ports again).
1521 void usb_hcd_resume_root_hub (struct usb_hcd *hcd)
1523 unsigned long flags;
1525 spin_lock_irqsave (&hcd_root_hub_lock, flags);
1526 if (hcd->rh_registered)
1527 usb_resume_root_hub (hcd->self.root_hub);
1528 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
1530 EXPORT_SYMBOL_GPL(usb_hcd_resume_root_hub);
1534 /*-------------------------------------------------------------------------*/
1536 #ifdef CONFIG_USB_OTG
1539 * usb_bus_start_enum - start immediate enumeration (for OTG)
1540 * @bus: the bus (must use hcd framework)
1541 * @port_num: 1-based number of port; usually bus->otg_port
1542 * Context: in_interrupt()
1544 * Starts enumeration, with an immediate reset followed later by
1545 * khubd identifying and possibly configuring the device.
1546 * This is needed by OTG controller drivers, where it helps meet
1547 * HNP protocol timing requirements for starting a port reset.
1549 int usb_bus_start_enum(struct usb_bus *bus, unsigned port_num)
1551 struct usb_hcd *hcd;
1552 int status = -EOPNOTSUPP;
1554 /* NOTE: since HNP can't start by grabbing the bus's address0_sem,
1555 * boards with root hubs hooked up to internal devices (instead of
1556 * just the OTG port) may need more attention to resetting...
1558 hcd = container_of (bus, struct usb_hcd, self);
1559 if (port_num && hcd->driver->start_port_reset)
1560 status = hcd->driver->start_port_reset(hcd, port_num);
1562 /* run khubd shortly after (first) root port reset finishes;
1563 * it may issue others, until at least 50 msecs have passed.
1566 mod_timer(&hcd->rh_timer, jiffies + msecs_to_jiffies(10));
1569 EXPORT_SYMBOL (usb_bus_start_enum);
1573 /*-------------------------------------------------------------------------*/
1576 * usb_hcd_operations - adapts usb_bus framework to HCD framework (bus glue)
1578 static struct usb_operations usb_hcd_operations = {
1579 .get_frame_number = hcd_get_frame_number,
1580 .submit_urb = hcd_submit_urb,
1581 .unlink_urb = hcd_unlink_urb,
1582 .buffer_alloc = hcd_buffer_alloc,
1583 .buffer_free = hcd_buffer_free,
1584 .disable = hcd_endpoint_disable,
1587 /*-------------------------------------------------------------------------*/
1590 * usb_hcd_giveback_urb - return URB from HCD to device driver
1591 * @hcd: host controller returning the URB
1592 * @urb: urb being returned to the USB device driver.
1593 * @regs: pt_regs, passed down to the URB completion handler
1594 * Context: in_interrupt()
1596 * This hands the URB from HCD to its USB device driver, using its
1597 * completion function. The HCD has freed all per-urb resources
1598 * (and is done using urb->hcpriv). It also released all HCD locks;
1599 * the device driver won't cause problems if it frees, modifies,
1600 * or resubmits this URB.
1602 void usb_hcd_giveback_urb (struct usb_hcd *hcd, struct urb *urb, struct pt_regs *regs)
1606 at_root_hub = (urb->dev == hcd->self.root_hub);
1609 /* lower level hcd code should use *_dma exclusively */
1610 if (hcd->self.controller->dma_mask && !at_root_hub) {
1611 if (usb_pipecontrol (urb->pipe)
1612 && !(urb->transfer_flags & URB_NO_SETUP_DMA_MAP))
1613 dma_unmap_single (hcd->self.controller, urb->setup_dma,
1614 sizeof (struct usb_ctrlrequest),
1616 if (urb->transfer_buffer_length != 0
1617 && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP))
1618 dma_unmap_single (hcd->self.controller,
1620 urb->transfer_buffer_length,
1621 usb_pipein (urb->pipe)
1626 usbmon_urb_complete (&hcd->self, urb);
1627 /* pass ownership to the completion handler */
1628 urb->complete (urb, regs);
1629 atomic_dec (&urb->use_count);
1630 if (unlikely (urb->reject))
1631 wake_up (&usb_kill_urb_queue);
1634 EXPORT_SYMBOL (usb_hcd_giveback_urb);
1636 /*-------------------------------------------------------------------------*/
1639 * usb_hcd_irq - hook IRQs to HCD framework (bus glue)
1640 * @irq: the IRQ being raised
1641 * @__hcd: pointer to the HCD whose IRQ is being signaled
1642 * @r: saved hardware registers
1644 * If the controller isn't HALTed, calls the driver's irq handler.
1645 * Checks whether the controller is now dead.
1647 irqreturn_t usb_hcd_irq (int irq, void *__hcd, struct pt_regs * r)
1649 struct usb_hcd *hcd = __hcd;
1650 int start = hcd->state;
1652 if (unlikely(start == HC_STATE_HALT ||
1653 !test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags)))
1655 if (hcd->driver->irq (hcd, r) == IRQ_NONE)
1658 set_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
1660 if (unlikely(hcd->state == HC_STATE_HALT))
1665 /*-------------------------------------------------------------------------*/
1668 * usb_hc_died - report abnormal shutdown of a host controller (bus glue)
1669 * @hcd: pointer to the HCD representing the controller
1671 * This is called by bus glue to report a USB host controller that died
1672 * while operations may still have been pending. It's called automatically
1673 * by the PCI glue, so only glue for non-PCI busses should need to call it.
1675 void usb_hc_died (struct usb_hcd *hcd)
1677 unsigned long flags;
1679 dev_err (hcd->self.controller, "HC died; cleaning up\n");
1681 spin_lock_irqsave (&hcd_root_hub_lock, flags);
1682 if (hcd->rh_registered) {
1685 /* make khubd clean up old urbs and devices */
1686 usb_set_device_state (hcd->self.root_hub,
1687 USB_STATE_NOTATTACHED);
1688 usb_kick_khubd (hcd->self.root_hub);
1690 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
1692 EXPORT_SYMBOL_GPL (usb_hc_died);
1694 /*-------------------------------------------------------------------------*/
1696 static void hcd_release (struct usb_bus *bus)
1698 struct usb_hcd *hcd;
1700 hcd = container_of(bus, struct usb_hcd, self);
1705 * usb_create_hcd - create and initialize an HCD structure
1706 * @driver: HC driver that will use this hcd
1707 * @dev: device for this HC, stored in hcd->self.controller
1708 * @bus_name: value to store in hcd->self.bus_name
1709 * Context: !in_interrupt()
1711 * Allocate a struct usb_hcd, with extra space at the end for the
1712 * HC driver's private data. Initialize the generic members of the
1715 * If memory is unavailable, returns NULL.
1717 struct usb_hcd *usb_create_hcd (const struct hc_driver *driver,
1718 struct device *dev, char *bus_name)
1720 struct usb_hcd *hcd;
1722 hcd = kzalloc(sizeof(*hcd) + driver->hcd_priv_size, GFP_KERNEL);
1724 dev_dbg (dev, "hcd alloc failed\n");
1727 dev_set_drvdata(dev, hcd);
1729 usb_bus_init(&hcd->self);
1730 hcd->self.op = &usb_hcd_operations;
1731 hcd->self.hcpriv = hcd;
1732 hcd->self.release = &hcd_release;
1733 hcd->self.controller = dev;
1734 hcd->self.bus_name = bus_name;
1736 init_timer(&hcd->rh_timer);
1737 hcd->rh_timer.function = rh_timer_func;
1738 hcd->rh_timer.data = (unsigned long) hcd;
1740 hcd->driver = driver;
1741 hcd->product_desc = (driver->product_desc) ? driver->product_desc :
1742 "USB Host Controller";
1746 EXPORT_SYMBOL (usb_create_hcd);
1748 void usb_put_hcd (struct usb_hcd *hcd)
1750 dev_set_drvdata(hcd->self.controller, NULL);
1751 usb_bus_put(&hcd->self);
1753 EXPORT_SYMBOL (usb_put_hcd);
1756 * usb_add_hcd - finish generic HCD structure initialization and register
1757 * @hcd: the usb_hcd structure to initialize
1758 * @irqnum: Interrupt line to allocate
1759 * @irqflags: Interrupt type flags
1761 * Finish the remaining parts of generic HCD initialization: allocate the
1762 * buffers of consistent memory, register the bus, request the IRQ line,
1763 * and call the driver's reset() and start() routines.
1765 int usb_add_hcd(struct usb_hcd *hcd,
1766 unsigned int irqnum, unsigned long irqflags)
1769 struct usb_device *rhdev;
1771 dev_info(hcd->self.controller, "%s\n", hcd->product_desc);
1773 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1775 /* till now HC has been in an indeterminate state ... */
1776 if (hcd->driver->reset && (retval = hcd->driver->reset(hcd)) < 0) {
1777 dev_err(hcd->self.controller, "can't reset\n");
1781 if ((retval = hcd_buffer_create(hcd)) != 0) {
1782 dev_dbg(hcd->self.controller, "pool alloc failed\n");
1786 if ((retval = usb_register_bus(&hcd->self)) < 0)
1787 goto err_register_bus;
1789 if (hcd->driver->irq) {
1790 char buf[8], *bufp = buf;
1793 bufp = __irq_itoa(irqnum);
1795 sprintf(buf, "%d", irqnum);
1798 snprintf(hcd->irq_descr, sizeof(hcd->irq_descr), "%s:usb%d",
1799 hcd->driver->description, hcd->self.busnum);
1800 if ((retval = request_irq(irqnum, &usb_hcd_irq, irqflags,
1801 hcd->irq_descr, hcd)) != 0) {
1802 dev_err(hcd->self.controller,
1803 "request interrupt %s failed\n", bufp);
1804 goto err_request_irq;
1807 dev_info(hcd->self.controller, "irq %s, %s 0x%08llx\n", bufp,
1808 (hcd->driver->flags & HCD_MEMORY) ?
1809 "io mem" : "io base",
1810 (unsigned long long)hcd->rsrc_start);
1813 if (hcd->rsrc_start)
1814 dev_info(hcd->self.controller, "%s 0x%08llx\n",
1815 (hcd->driver->flags & HCD_MEMORY) ?
1816 "io mem" : "io base",
1817 (unsigned long long)hcd->rsrc_start);
1820 /* Allocate the root hub before calling hcd->driver->start(),
1821 * but don't register it until afterward so that the hardware
1824 if ((rhdev = usb_alloc_dev(NULL, &hcd->self, 0)) == NULL) {
1825 dev_err(hcd->self.controller, "unable to allocate root hub\n");
1827 goto err_allocate_root_hub;
1830 /* Although in principle hcd->driver->start() might need to use rhdev,
1831 * none of the current drivers do.
1833 if ((retval = hcd->driver->start(hcd)) < 0) {
1834 dev_err(hcd->self.controller, "startup error %d\n", retval);
1835 goto err_hcd_driver_start;
1838 /* hcd->driver->start() reported can_wakeup, probably with
1839 * assistance from board's boot firmware.
1840 * NOTE: normal devices won't enable wakeup by default.
1842 if (hcd->can_wakeup)
1843 dev_dbg(hcd->self.controller, "supports USB remote wakeup\n");
1844 hcd->remote_wakeup = hcd->can_wakeup;
1846 rhdev->speed = (hcd->driver->flags & HCD_USB2) ? USB_SPEED_HIGH :
1848 rhdev->bus_mA = min(500u, hcd->power_budget);
1849 if ((retval = register_root_hub(rhdev, hcd)) != 0)
1850 goto err_register_root_hub;
1852 if (hcd->uses_new_polling && hcd->poll_rh)
1853 usb_hcd_poll_rh_status(hcd);
1856 err_register_root_hub:
1857 hcd->driver->stop(hcd);
1859 err_hcd_driver_start:
1862 err_allocate_root_hub:
1864 free_irq(irqnum, hcd);
1867 usb_deregister_bus(&hcd->self);
1870 hcd_buffer_destroy(hcd);
1873 EXPORT_SYMBOL (usb_add_hcd);
1876 * usb_remove_hcd - shutdown processing for generic HCDs
1877 * @hcd: the usb_hcd structure to remove
1878 * Context: !in_interrupt()
1880 * Disconnects the root hub, then reverses the effects of usb_add_hcd(),
1881 * invoking the HCD's stop() method.
1883 void usb_remove_hcd(struct usb_hcd *hcd)
1885 dev_info(hcd->self.controller, "remove, state %x\n", hcd->state);
1887 if (HC_IS_RUNNING (hcd->state))
1888 hcd->state = HC_STATE_QUIESCING;
1890 dev_dbg(hcd->self.controller, "roothub graceful disconnect\n");
1891 spin_lock_irq (&hcd_root_hub_lock);
1892 hcd->rh_registered = 0;
1893 spin_unlock_irq (&hcd_root_hub_lock);
1895 down(&usb_bus_list_lock);
1896 usb_disconnect(&hcd->self.root_hub);
1897 up(&usb_bus_list_lock);
1900 del_timer_sync(&hcd->rh_timer);
1902 hcd->driver->stop(hcd);
1903 hcd->state = HC_STATE_HALT;
1906 free_irq(hcd->irq, hcd);
1907 usb_deregister_bus(&hcd->self);
1908 hcd_buffer_destroy(hcd);
1910 EXPORT_SYMBOL (usb_remove_hcd);
1912 /*-------------------------------------------------------------------------*/
1914 #if defined(CONFIG_USB_MON)
1916 struct usb_mon_operations *mon_ops;
1919 * The registration is unlocked.
1920 * We do it this way because we do not want to lock in hot paths.
1922 * Notice that the code is minimally error-proof. Because usbmon needs
1923 * symbols from usbcore, usbcore gets referenced and cannot be unloaded first.
1926 int usb_mon_register (struct usb_mon_operations *ops)
1936 EXPORT_SYMBOL_GPL (usb_mon_register);
1938 void usb_mon_deregister (void)
1941 if (mon_ops == NULL) {
1942 printk(KERN_ERR "USB: monitor was not registered\n");
1948 EXPORT_SYMBOL_GPL (usb_mon_deregister);
1950 #endif /* CONFIG_USB_MON */