2 * (C) Copyright Linus Torvalds 1999
3 * (C) Copyright Johannes Erdfelt 1999-2001
4 * (C) Copyright Andreas Gal 1999
5 * (C) Copyright Gregory P. Smith 1999
6 * (C) Copyright Deti Fliegl 1999
7 * (C) Copyright Randy Dunlap 2000
8 * (C) Copyright David Brownell 2000-2002
10 * This program is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License as published by the
12 * Free Software Foundation; either version 2 of the License, or (at your
13 * option) any later version.
15 * This program is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
17 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software Foundation,
22 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 #include <linux/module.h>
26 #include <linux/version.h>
27 #include <linux/kernel.h>
28 #include <linux/slab.h>
29 #include <linux/completion.h>
30 #include <linux/utsname.h>
33 #include <asm/scatterlist.h>
34 #include <linux/device.h>
35 #include <linux/dma-mapping.h>
36 #include <linux/mutex.h>
38 #include <asm/byteorder.h>
39 #include <linux/platform_device.h>
40 #include <linux/workqueue.h>
42 #include <linux/usb.h>
49 /*-------------------------------------------------------------------------*/
52 * USB Host Controller Driver framework
54 * Plugs into usbcore (usb_bus) and lets HCDs share code, minimizing
55 * HCD-specific behaviors/bugs.
57 * This does error checks, tracks devices and urbs, and delegates to a
58 * "hc_driver" only for code (and data) that really needs to know about
59 * hardware differences. That includes root hub registers, i/o queues,
60 * and so on ... but as little else as possible.
62 * Shared code includes most of the "root hub" code (these are emulated,
63 * though each HC's hardware works differently) and PCI glue, plus request
64 * tracking overhead. The HCD code should only block on spinlocks or on
65 * hardware handshaking; blocking on software events (such as other kernel
66 * threads releasing resources, or completing actions) is all generic.
68 * Happens the USB 2.0 spec says this would be invisible inside the "USBD",
69 * and includes mostly a "HCDI" (HCD Interface) along with some APIs used
70 * only by the hub driver ... and that neither should be seen or used by
71 * usb client device drivers.
73 * Contributors of ideas or unattributed patches include: David Brownell,
74 * Roman Weissgaerber, Rory Bolt, Greg Kroah-Hartman, ...
77 * 2002-02-21 Pull in most of the usb_bus support from usb.c; some
78 * associated cleanup. "usb_hcd" still != "usb_bus".
79 * 2001-12-12 Initial patch version for Linux 2.5.1 kernel.
82 /*-------------------------------------------------------------------------*/
84 /* host controllers we manage */
85 LIST_HEAD (usb_bus_list);
86 EXPORT_SYMBOL_GPL (usb_bus_list);
88 /* used when allocating bus numbers */
91 unsigned long busmap [USB_MAXBUS / (8*sizeof (unsigned long))];
93 static struct usb_busmap busmap;
95 /* used when updating list of hcds */
96 DEFINE_MUTEX(usb_bus_list_lock); /* exported only for usbfs */
97 EXPORT_SYMBOL_GPL (usb_bus_list_lock);
99 /* used for controlling access to virtual root hubs */
100 static DEFINE_SPINLOCK(hcd_root_hub_lock);
102 /* used when updating 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 /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8)
259 * see hub.c:hub_configure() for details. */
260 (USB_MAXCHILDREN + 1 + 7) / 8, 0x00,
261 0x0c /* __u8 ep_bInterval; (256ms -- usb 2.0 spec) */
264 /*-------------------------------------------------------------------------*/
267 * helper routine for returning string descriptors in UTF-16LE
268 * input can actually be ISO-8859-1; ASCII is its 7-bit subset
270 static int ascii2utf (char *s, u8 *utf, int utfmax)
274 for (retval = 0; *s && utfmax > 1; utfmax -= 2, retval += 2) {
286 * rh_string - provides manufacturer, product and serial strings for root hub
287 * @id: the string ID number (1: serial number, 2: product, 3: vendor)
288 * @hcd: the host controller for this root hub
289 * @type: string describing our driver
290 * @data: return packet in UTF-16 LE
291 * @len: length of the return packet
293 * Produces either a manufacturer, product or serial number string for the
294 * virtual root hub device.
296 static int rh_string (
306 buf[0] = 4; buf[1] = 3; /* 4 bytes string data */
307 buf[2] = 0x09; buf[3] = 0x04; /* MSFT-speak for "en-us" */
309 memcpy (data, buf, len);
313 } else if (id == 1) {
314 strlcpy (buf, hcd->self.bus_name, sizeof buf);
316 // product description
317 } else if (id == 2) {
318 strlcpy (buf, hcd->product_desc, sizeof buf);
320 // id 3 == vendor description
321 } else if (id == 3) {
322 snprintf (buf, sizeof buf, "%s %s %s", init_utsname()->sysname,
323 init_utsname()->release, hcd->driver->description);
325 // unsupported IDs --> "protocol stall"
329 switch (len) { /* All cases fall through */
331 len = 2 + ascii2utf (buf, data + 2, len - 2);
333 data [1] = 3; /* type == string */
335 data [0] = 2 * (strlen (buf) + 1);
337 ; /* Compiler wants a statement here */
343 /* Root hub control transfers execute synchronously */
344 static int rh_call_control (struct usb_hcd *hcd, struct urb *urb)
346 struct usb_ctrlrequest *cmd;
347 u16 typeReq, wValue, wIndex, wLength;
348 u8 *ubuf = urb->transfer_buffer;
349 u8 tbuf [sizeof (struct usb_hub_descriptor)]
350 __attribute__((aligned(4)));
351 const u8 *bufp = tbuf;
353 int patch_wakeup = 0;
358 cmd = (struct usb_ctrlrequest *) urb->setup_packet;
359 typeReq = (cmd->bRequestType << 8) | cmd->bRequest;
360 wValue = le16_to_cpu (cmd->wValue);
361 wIndex = le16_to_cpu (cmd->wIndex);
362 wLength = le16_to_cpu (cmd->wLength);
364 if (wLength > urb->transfer_buffer_length)
367 urb->actual_length = 0;
370 /* DEVICE REQUESTS */
372 /* The root hub's remote wakeup enable bit is implemented using
373 * driver model wakeup flags. If this system supports wakeup
374 * through USB, userspace may change the default "allow wakeup"
375 * policy through sysfs or these calls.
377 * Most root hubs support wakeup from downstream devices, for
378 * runtime power management (disabling USB clocks and reducing
379 * VBUS power usage). However, not all of them do so; silicon,
380 * board, and BIOS bugs here are not uncommon, so these can't
381 * be treated quite like external hubs.
383 * Likewise, not all root hubs will pass wakeup events upstream,
384 * to wake up the whole system. So don't assume root hub and
385 * controller capabilities are identical.
388 case DeviceRequest | USB_REQ_GET_STATUS:
389 tbuf [0] = (device_may_wakeup(&hcd->self.root_hub->dev)
390 << USB_DEVICE_REMOTE_WAKEUP)
391 | (1 << USB_DEVICE_SELF_POWERED);
395 case DeviceOutRequest | USB_REQ_CLEAR_FEATURE:
396 if (wValue == USB_DEVICE_REMOTE_WAKEUP)
397 device_set_wakeup_enable(&hcd->self.root_hub->dev, 0);
401 case DeviceOutRequest | USB_REQ_SET_FEATURE:
402 if (device_can_wakeup(&hcd->self.root_hub->dev)
403 && wValue == USB_DEVICE_REMOTE_WAKEUP)
404 device_set_wakeup_enable(&hcd->self.root_hub->dev, 1);
408 case DeviceRequest | USB_REQ_GET_CONFIGURATION:
412 case DeviceOutRequest | USB_REQ_SET_CONFIGURATION:
414 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
415 switch (wValue & 0xff00) {
416 case USB_DT_DEVICE << 8:
417 if (hcd->driver->flags & HCD_USB2)
418 bufp = usb2_rh_dev_descriptor;
419 else if (hcd->driver->flags & HCD_USB11)
420 bufp = usb11_rh_dev_descriptor;
425 case USB_DT_CONFIG << 8:
426 if (hcd->driver->flags & HCD_USB2) {
427 bufp = hs_rh_config_descriptor;
428 len = sizeof hs_rh_config_descriptor;
430 bufp = fs_rh_config_descriptor;
431 len = sizeof fs_rh_config_descriptor;
433 if (device_can_wakeup(&hcd->self.root_hub->dev))
436 case USB_DT_STRING << 8:
437 n = rh_string (wValue & 0xff, hcd, ubuf, wLength);
440 urb->actual_length = n;
446 case DeviceRequest | USB_REQ_GET_INTERFACE:
450 case DeviceOutRequest | USB_REQ_SET_INTERFACE:
452 case DeviceOutRequest | USB_REQ_SET_ADDRESS:
453 // wValue == urb->dev->devaddr
454 dev_dbg (hcd->self.controller, "root hub device address %d\n",
458 /* INTERFACE REQUESTS (no defined feature/status flags) */
460 /* ENDPOINT REQUESTS */
462 case EndpointRequest | USB_REQ_GET_STATUS:
463 // ENDPOINT_HALT flag
468 case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
469 case EndpointOutRequest | USB_REQ_SET_FEATURE:
470 dev_dbg (hcd->self.controller, "no endpoint features yet\n");
473 /* CLASS REQUESTS (and errors) */
476 /* non-generic request */
482 case GetHubDescriptor:
483 len = sizeof (struct usb_hub_descriptor);
486 status = hcd->driver->hub_control (hcd,
487 typeReq, wValue, wIndex,
491 /* "protocol stall" on error */
497 if (status != -EPIPE) {
498 dev_dbg (hcd->self.controller,
499 "CTRL: TypeReq=0x%x val=0x%x "
500 "idx=0x%x len=%d ==> %d\n",
501 typeReq, wValue, wIndex,
506 if (urb->transfer_buffer_length < len)
507 len = urb->transfer_buffer_length;
508 urb->actual_length = len;
509 // always USB_DIR_IN, toward host
510 memcpy (ubuf, bufp, len);
512 /* report whether RH hardware supports remote wakeup */
514 len > offsetof (struct usb_config_descriptor,
516 ((struct usb_config_descriptor *)ubuf)->bmAttributes
517 |= USB_CONFIG_ATT_WAKEUP;
520 /* any errors get returned through the urb completion */
521 local_irq_save (flags);
522 spin_lock (&urb->lock);
523 if (urb->status == -EINPROGRESS)
524 urb->status = status;
525 spin_unlock (&urb->lock);
526 usb_hcd_giveback_urb (hcd, urb);
527 local_irq_restore (flags);
531 /*-------------------------------------------------------------------------*/
534 * Root Hub interrupt transfers are polled using a timer if the
535 * driver requests it; otherwise the driver is responsible for
536 * calling usb_hcd_poll_rh_status() when an event occurs.
538 * Completions are called in_interrupt(), but they may or may not
541 void usb_hcd_poll_rh_status(struct usb_hcd *hcd)
546 char buffer[4]; /* Any root hubs with > 31 ports? */
548 if (unlikely(!hcd->rh_registered))
550 if (!hcd->uses_new_polling && !hcd->status_urb)
553 length = hcd->driver->hub_status_data(hcd, buffer);
556 /* try to complete the status urb */
557 local_irq_save (flags);
558 spin_lock(&hcd_root_hub_lock);
559 urb = hcd->status_urb;
561 spin_lock(&urb->lock);
562 if (urb->status == -EINPROGRESS) {
563 hcd->poll_pending = 0;
564 hcd->status_urb = NULL;
567 urb->actual_length = length;
568 memcpy(urb->transfer_buffer, buffer, length);
569 } else /* urb has been unlinked */
571 spin_unlock(&urb->lock);
574 spin_unlock(&hcd_root_hub_lock);
576 /* local irqs are always blocked in completions */
578 usb_hcd_giveback_urb (hcd, urb);
580 hcd->poll_pending = 1;
581 local_irq_restore (flags);
584 /* The USB 2.0 spec says 256 ms. This is close enough and won't
585 * exceed that limit if HZ is 100. The math is more clunky than
586 * maybe expected, this is to make sure that all timers for USB devices
587 * fire at the same time to give the CPU a break inbetween */
588 if (hcd->uses_new_polling ? hcd->poll_rh :
589 (length == 0 && hcd->status_urb != NULL))
590 mod_timer (&hcd->rh_timer, (jiffies/(HZ/4) + 1) * (HZ/4));
592 EXPORT_SYMBOL_GPL(usb_hcd_poll_rh_status);
595 static void rh_timer_func (unsigned long _hcd)
597 usb_hcd_poll_rh_status((struct usb_hcd *) _hcd);
600 /*-------------------------------------------------------------------------*/
602 static int rh_queue_status (struct usb_hcd *hcd, struct urb *urb)
606 int len = 1 + (urb->dev->maxchild / 8);
608 spin_lock_irqsave (&hcd_root_hub_lock, flags);
609 if (urb->status != -EINPROGRESS) /* already unlinked */
610 retval = urb->status;
611 else if (hcd->status_urb || urb->transfer_buffer_length < len) {
612 dev_dbg (hcd->self.controller, "not queuing rh status urb\n");
615 hcd->status_urb = urb;
616 urb->hcpriv = hcd; /* indicate it's queued */
618 if (!hcd->uses_new_polling)
619 mod_timer (&hcd->rh_timer,
620 (jiffies/(HZ/4) + 1) * (HZ/4));
622 /* If a status change has already occurred, report it ASAP */
623 else if (hcd->poll_pending)
624 mod_timer (&hcd->rh_timer, jiffies);
627 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
631 static int rh_urb_enqueue (struct usb_hcd *hcd, struct urb *urb)
633 if (usb_pipeint (urb->pipe))
634 return rh_queue_status (hcd, urb);
635 if (usb_pipecontrol (urb->pipe))
636 return rh_call_control (hcd, urb);
640 /*-------------------------------------------------------------------------*/
642 /* Unlinks of root-hub control URBs are legal, but they don't do anything
643 * since these URBs always execute synchronously.
645 static int usb_rh_urb_dequeue (struct usb_hcd *hcd, struct urb *urb)
649 if (usb_pipeendpoint(urb->pipe) == 0) { /* Control URB */
652 } else { /* Status URB */
653 if (!hcd->uses_new_polling)
654 del_timer (&hcd->rh_timer);
655 local_irq_save (flags);
656 spin_lock (&hcd_root_hub_lock);
657 if (urb == hcd->status_urb) {
658 hcd->status_urb = NULL;
661 urb = NULL; /* wasn't fully queued */
662 spin_unlock (&hcd_root_hub_lock);
664 usb_hcd_giveback_urb (hcd, urb);
665 local_irq_restore (flags);
671 /*-------------------------------------------------------------------------*/
673 static struct class *usb_host_class;
675 int usb_host_init(void)
679 usb_host_class = class_create(THIS_MODULE, "usb_host");
680 if (IS_ERR(usb_host_class))
681 retval = PTR_ERR(usb_host_class);
685 void usb_host_cleanup(void)
687 class_destroy(usb_host_class);
691 * usb_bus_init - shared initialization code
692 * @bus: the bus structure being initialized
694 * This code is used to initialize a usb_bus structure, memory for which is
695 * separately managed.
697 static void usb_bus_init (struct usb_bus *bus)
699 memset (&bus->devmap, 0, sizeof(struct usb_devmap));
701 bus->devnum_next = 1;
703 bus->root_hub = NULL;
705 bus->bandwidth_allocated = 0;
706 bus->bandwidth_int_reqs = 0;
707 bus->bandwidth_isoc_reqs = 0;
709 INIT_LIST_HEAD (&bus->bus_list);
712 /*-------------------------------------------------------------------------*/
715 * usb_register_bus - registers the USB host controller with the usb core
716 * @bus: pointer to the bus to register
717 * Context: !in_interrupt()
719 * Assigns a bus number, and links the controller into usbcore data
720 * structures so that it can be seen by scanning the bus list.
722 static int usb_register_bus(struct usb_bus *bus)
726 mutex_lock(&usb_bus_list_lock);
727 busnum = find_next_zero_bit (busmap.busmap, USB_MAXBUS, 1);
728 if (busnum < USB_MAXBUS) {
729 set_bit (busnum, busmap.busmap);
730 bus->busnum = busnum;
732 printk (KERN_ERR "%s: too many buses\n", usbcore_name);
733 mutex_unlock(&usb_bus_list_lock);
737 bus->class_dev = class_device_create(usb_host_class, NULL, MKDEV(0,0),
738 bus->controller, "usb_host%d", busnum);
739 if (IS_ERR(bus->class_dev)) {
740 clear_bit(busnum, busmap.busmap);
741 mutex_unlock(&usb_bus_list_lock);
742 return PTR_ERR(bus->class_dev);
745 class_set_devdata(bus->class_dev, bus);
747 /* Add it to the local list of buses */
748 list_add (&bus->bus_list, &usb_bus_list);
749 mutex_unlock(&usb_bus_list_lock);
751 usb_notify_add_bus(bus);
753 dev_info (bus->controller, "new USB bus registered, assigned bus number %d\n", bus->busnum);
758 * usb_deregister_bus - deregisters the USB host controller
759 * @bus: pointer to the bus to deregister
760 * Context: !in_interrupt()
762 * Recycles the bus number, and unlinks the controller from usbcore data
763 * structures so that it won't be seen by scanning the bus list.
765 static void usb_deregister_bus (struct usb_bus *bus)
767 dev_info (bus->controller, "USB bus %d deregistered\n", bus->busnum);
770 * NOTE: make sure that all the devices are removed by the
771 * controller code, as well as having it call this when cleaning
774 mutex_lock(&usb_bus_list_lock);
775 list_del (&bus->bus_list);
776 mutex_unlock(&usb_bus_list_lock);
778 usb_notify_remove_bus(bus);
780 clear_bit (bus->busnum, busmap.busmap);
782 class_device_unregister(bus->class_dev);
786 * register_root_hub - called by usb_add_hcd() to register a root hub
787 * @hcd: host controller for this root hub
789 * This function registers the root hub with the USB subsystem. It sets up
790 * the device properly in the device tree and then calls usb_new_device()
791 * to register the usb device. It also assigns the root hub's USB address
794 static int register_root_hub(struct usb_hcd *hcd)
796 struct device *parent_dev = hcd->self.controller;
797 struct usb_device *usb_dev = hcd->self.root_hub;
798 const int devnum = 1;
801 usb_dev->devnum = devnum;
802 usb_dev->bus->devnum_next = devnum + 1;
803 memset (&usb_dev->bus->devmap.devicemap, 0,
804 sizeof usb_dev->bus->devmap.devicemap);
805 set_bit (devnum, usb_dev->bus->devmap.devicemap);
806 usb_set_device_state(usb_dev, USB_STATE_ADDRESS);
808 mutex_lock(&usb_bus_list_lock);
810 usb_dev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
811 retval = usb_get_device_descriptor(usb_dev, USB_DT_DEVICE_SIZE);
812 if (retval != sizeof usb_dev->descriptor) {
813 mutex_unlock(&usb_bus_list_lock);
814 dev_dbg (parent_dev, "can't read %s device descriptor %d\n",
815 usb_dev->dev.bus_id, retval);
816 return (retval < 0) ? retval : -EMSGSIZE;
819 retval = usb_new_device (usb_dev);
821 dev_err (parent_dev, "can't register root hub for %s, %d\n",
822 usb_dev->dev.bus_id, retval);
824 mutex_unlock(&usb_bus_list_lock);
827 spin_lock_irq (&hcd_root_hub_lock);
828 hcd->rh_registered = 1;
829 spin_unlock_irq (&hcd_root_hub_lock);
831 /* Did the HC die before the root hub was registered? */
832 if (hcd->state == HC_STATE_HALT)
833 usb_hc_died (hcd); /* This time clean up */
839 void usb_enable_root_hub_irq (struct usb_bus *bus)
843 hcd = container_of (bus, struct usb_hcd, self);
844 if (hcd->driver->hub_irq_enable && hcd->state != HC_STATE_HALT)
845 hcd->driver->hub_irq_enable (hcd);
849 /*-------------------------------------------------------------------------*/
852 * usb_calc_bus_time - approximate periodic transaction time in nanoseconds
853 * @speed: from dev->speed; USB_SPEED_{LOW,FULL,HIGH}
854 * @is_input: true iff the transaction sends data to the host
855 * @isoc: true for isochronous transactions, false for interrupt ones
856 * @bytecount: how many bytes in the transaction.
858 * Returns approximate bus time in nanoseconds for a periodic transaction.
859 * See USB 2.0 spec section 5.11.3; only periodic transfers need to be
860 * scheduled in software, this function is only used for such scheduling.
862 long usb_calc_bus_time (int speed, int is_input, int isoc, int bytecount)
867 case USB_SPEED_LOW: /* INTR only */
869 tmp = (67667L * (31L + 10L * BitTime (bytecount))) / 1000L;
870 return (64060L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp);
872 tmp = (66700L * (31L + 10L * BitTime (bytecount))) / 1000L;
873 return (64107L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp);
875 case USB_SPEED_FULL: /* ISOC or INTR */
877 tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
878 return (((is_input) ? 7268L : 6265L) + BW_HOST_DELAY + tmp);
880 tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
881 return (9107L + BW_HOST_DELAY + tmp);
883 case USB_SPEED_HIGH: /* ISOC or INTR */
884 // FIXME adjust for input vs output
886 tmp = HS_NSECS_ISO (bytecount);
888 tmp = HS_NSECS (bytecount);
891 pr_debug ("%s: bogus device speed!\n", usbcore_name);
895 EXPORT_SYMBOL (usb_calc_bus_time);
898 /*-------------------------------------------------------------------------*/
901 * Generic HC operations.
904 /*-------------------------------------------------------------------------*/
906 static void urb_unlink(struct usb_hcd *hcd, struct urb *urb)
909 int at_root_hub = (urb->dev == hcd->self.root_hub);
911 /* clear all state linking urb to this dev (and hcd) */
912 spin_lock_irqsave (&hcd_data_lock, flags);
913 list_del_init (&urb->urb_list);
914 spin_unlock_irqrestore (&hcd_data_lock, flags);
916 if (hcd->self.uses_dma && !at_root_hub) {
917 if (usb_pipecontrol (urb->pipe)
918 && !(urb->transfer_flags & URB_NO_SETUP_DMA_MAP))
919 dma_unmap_single (hcd->self.controller, urb->setup_dma,
920 sizeof (struct usb_ctrlrequest),
922 if (urb->transfer_buffer_length != 0
923 && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP))
924 dma_unmap_single (hcd->self.controller,
926 urb->transfer_buffer_length,
927 usb_pipein (urb->pipe)
933 /* may be called in any context with a valid urb->dev usecount
934 * caller surrenders "ownership" of urb
935 * expects usb_submit_urb() to have sanity checked and conditioned all
938 int usb_hcd_submit_urb (struct urb *urb, gfp_t mem_flags)
941 struct usb_hcd *hcd = bus_to_hcd(urb->dev->bus);
942 struct usb_host_endpoint *ep;
948 usbmon_urb_submit(&hcd->self, urb);
951 * Atomically queue the urb, first to our records, then to the HCD.
952 * Access to urb->status is controlled by urb->lock ... changes on
953 * i/o completion (normal or fault) or unlinking.
956 // FIXME: verify that quiescing hc works right (RH cleans up)
958 spin_lock_irqsave (&hcd_data_lock, flags);
959 ep = (usb_pipein(urb->pipe) ? urb->dev->ep_in : urb->dev->ep_out)
960 [usb_pipeendpoint(urb->pipe)];
963 else if (unlikely (urb->reject))
965 else switch (hcd->state) {
966 case HC_STATE_RUNNING:
967 case HC_STATE_RESUMING:
968 list_add_tail (&urb->urb_list, &ep->urb_list);
975 spin_unlock_irqrestore (&hcd_data_lock, flags);
977 INIT_LIST_HEAD (&urb->urb_list);
978 usbmon_urb_submit_error(&hcd->self, urb, status);
982 /* increment urb's reference count as part of giving it to the HCD
983 * (which now controls it). HCD guarantees that it either returns
984 * an error or calls giveback(), but not both.
986 urb = usb_get_urb (urb);
987 atomic_inc (&urb->use_count);
989 if (urb->dev == hcd->self.root_hub) {
990 /* NOTE: requirement on hub callers (usbfs and the hub
991 * driver, for now) that URBs' urb->transfer_buffer be
992 * valid and usb_buffer_{sync,unmap}() not be needed, since
993 * they could clobber root hub response data.
995 status = rh_urb_enqueue (hcd, urb);
999 /* lower level hcd code should use *_dma exclusively,
1000 * unless it uses pio or talks to another transport.
1002 if (hcd->self.uses_dma) {
1003 if (usb_pipecontrol (urb->pipe)
1004 && !(urb->transfer_flags & URB_NO_SETUP_DMA_MAP))
1005 urb->setup_dma = dma_map_single (
1006 hcd->self.controller,
1008 sizeof (struct usb_ctrlrequest),
1010 if (urb->transfer_buffer_length != 0
1011 && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP))
1012 urb->transfer_dma = dma_map_single (
1013 hcd->self.controller,
1014 urb->transfer_buffer,
1015 urb->transfer_buffer_length,
1016 usb_pipein (urb->pipe)
1021 status = hcd->driver->urb_enqueue (hcd, ep, urb, mem_flags);
1023 if (unlikely (status)) {
1024 urb_unlink(hcd, urb);
1025 atomic_dec (&urb->use_count);
1027 wake_up (&usb_kill_urb_queue);
1028 usbmon_urb_submit_error(&hcd->self, urb, status);
1034 /*-------------------------------------------------------------------------*/
1036 /* called in any context */
1037 int usb_hcd_get_frame_number (struct usb_device *udev)
1039 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1041 if (!HC_IS_RUNNING (hcd->state))
1043 return hcd->driver->get_frame_number (hcd);
1046 /*-------------------------------------------------------------------------*/
1048 /* this makes the hcd giveback() the urb more quickly, by kicking it
1049 * off hardware queues (which may take a while) and returning it as
1050 * soon as practical. we've already set up the urb's return status,
1051 * but we can't know if the callback completed already.
1054 unlink1 (struct usb_hcd *hcd, struct urb *urb)
1058 if (urb->dev == hcd->self.root_hub)
1059 value = usb_rh_urb_dequeue (hcd, urb);
1062 /* The only reason an HCD might fail this call is if
1063 * it has not yet fully queued the urb to begin with.
1064 * Such failures should be harmless. */
1065 value = hcd->driver->urb_dequeue (hcd, urb);
1069 dev_dbg (hcd->self.controller, "dequeue %p --> %d\n",
1075 * called in any context
1077 * caller guarantees urb won't be recycled till both unlink()
1078 * and the urb's completion function return
1080 int usb_hcd_unlink_urb (struct urb *urb, int status)
1082 struct usb_host_endpoint *ep;
1083 struct usb_hcd *hcd = NULL;
1084 struct device *sys = NULL;
1085 unsigned long flags;
1086 struct list_head *tmp;
1091 if (!urb->dev || !urb->dev->bus)
1093 ep = (usb_pipein(urb->pipe) ? urb->dev->ep_in : urb->dev->ep_out)
1094 [usb_pipeendpoint(urb->pipe)];
1099 * we contend for urb->status with the hcd core,
1100 * which changes it while returning the urb.
1102 * Caller guaranteed that the urb pointer hasn't been freed, and
1103 * that it was submitted. But as a rule it can't know whether or
1104 * not it's already been unlinked ... so we respect the reversed
1105 * lock sequence needed for the usb_hcd_giveback_urb() code paths
1106 * (urb lock, then hcd_data_lock) in case some other CPU is now
1109 spin_lock_irqsave (&urb->lock, flags);
1110 spin_lock (&hcd_data_lock);
1112 sys = &urb->dev->dev;
1113 hcd = bus_to_hcd(urb->dev->bus);
1119 /* insist the urb is still queued */
1120 list_for_each(tmp, &ep->urb_list) {
1121 if (tmp == &urb->urb_list)
1124 if (tmp != &urb->urb_list) {
1129 /* Any status except -EINPROGRESS means something already started to
1130 * unlink this URB from the hardware. So there's no more work to do.
1132 if (urb->status != -EINPROGRESS) {
1137 /* IRQ setup can easily be broken so that USB controllers
1138 * never get completion IRQs ... maybe even the ones we need to
1139 * finish unlinking the initial failed usb_set_address()
1140 * or device descriptor fetch.
1142 if (!test_bit(HCD_FLAG_SAW_IRQ, &hcd->flags)
1143 && hcd->self.root_hub != urb->dev) {
1144 dev_warn (hcd->self.controller, "Unlink after no-IRQ? "
1145 "Controller is probably using the wrong IRQ."
1147 set_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
1150 urb->status = status;
1152 spin_unlock (&hcd_data_lock);
1153 spin_unlock_irqrestore (&urb->lock, flags);
1155 retval = unlink1 (hcd, urb);
1157 retval = -EINPROGRESS;
1161 spin_unlock (&hcd_data_lock);
1162 spin_unlock_irqrestore (&urb->lock, flags);
1163 if (retval != -EIDRM && sys && sys->driver)
1164 dev_dbg (sys, "hcd_unlink_urb %p fail %d\n", urb, retval);
1168 /*-------------------------------------------------------------------------*/
1170 /* disables the endpoint: cancels any pending urbs, then synchronizes with
1171 * the hcd to make sure all endpoint state is gone from hardware, and then
1172 * waits until the endpoint's queue is completely drained. use for
1173 * set_configuration, set_interface, driver removal, physical disconnect.
1175 * example: a qh stored in ep->hcpriv, holding state related to endpoint
1176 * type, maxpacket size, toggle, halt status, and scheduling.
1178 void usb_hcd_endpoint_disable (struct usb_device *udev,
1179 struct usb_host_endpoint *ep)
1181 struct usb_hcd *hcd;
1184 hcd = bus_to_hcd(udev->bus);
1185 local_irq_disable ();
1187 /* ep is already gone from udev->ep_{in,out}[]; no more submits */
1189 spin_lock (&hcd_data_lock);
1190 list_for_each_entry (urb, &ep->urb_list, urb_list) {
1193 /* the urb may already have been unlinked */
1194 if (urb->status != -EINPROGRESS)
1197 spin_unlock (&hcd_data_lock);
1199 spin_lock (&urb->lock);
1201 if (tmp == -EINPROGRESS)
1202 urb->status = -ESHUTDOWN;
1203 spin_unlock (&urb->lock);
1205 /* kick hcd unless it's already returning this */
1206 if (tmp == -EINPROGRESS) {
1209 dev_dbg (hcd->self.controller,
1210 "shutdown urb %p pipe %08x ep%d%s%s\n",
1211 urb, tmp, usb_pipeendpoint (tmp),
1212 (tmp & USB_DIR_IN) ? "in" : "out",
1214 switch (usb_pipetype (tmp)) { \
1215 case PIPE_CONTROL: s = ""; break; \
1216 case PIPE_BULK: s = "-bulk"; break; \
1217 case PIPE_INTERRUPT: s = "-intr"; break; \
1218 default: s = "-iso"; break; \
1223 /* list contents may have changed */
1226 spin_unlock (&hcd_data_lock);
1227 local_irq_enable ();
1229 /* synchronize with the hardware, so old configuration state
1230 * clears out immediately (and will be freed).
1233 if (hcd->driver->endpoint_disable)
1234 hcd->driver->endpoint_disable (hcd, ep);
1236 /* Wait until the endpoint queue is completely empty. Most HCDs
1237 * will have done this already in their endpoint_disable method,
1238 * but some might not. And there could be root-hub control URBs
1239 * still pending since they aren't affected by the HCDs'
1240 * endpoint_disable methods.
1242 while (!list_empty (&ep->urb_list)) {
1243 spin_lock_irq (&hcd_data_lock);
1245 /* The list may have changed while we acquired the spinlock */
1247 if (!list_empty (&ep->urb_list)) {
1248 urb = list_entry (ep->urb_list.prev, struct urb,
1252 spin_unlock_irq (&hcd_data_lock);
1261 /*-------------------------------------------------------------------------*/
1265 int hcd_bus_suspend(struct usb_device *rhdev)
1267 struct usb_hcd *hcd = container_of(rhdev->bus, struct usb_hcd, self);
1269 int old_state = hcd->state;
1271 dev_dbg(&rhdev->dev, "bus %s%s\n",
1272 rhdev->auto_pm ? "auto-" : "", "suspend");
1273 if (!hcd->driver->bus_suspend) {
1276 hcd->state = HC_STATE_QUIESCING;
1277 status = hcd->driver->bus_suspend(hcd);
1280 usb_set_device_state(rhdev, USB_STATE_SUSPENDED);
1281 hcd->state = HC_STATE_SUSPENDED;
1283 hcd->state = old_state;
1284 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
1290 int hcd_bus_resume(struct usb_device *rhdev)
1292 struct usb_hcd *hcd = container_of(rhdev->bus, struct usb_hcd, self);
1295 dev_dbg(&rhdev->dev, "usb %s%s\n",
1296 rhdev->auto_pm ? "auto-" : "", "resume");
1297 if (!hcd->driver->bus_resume)
1299 if (hcd->state == HC_STATE_RUNNING)
1302 hcd->state = HC_STATE_RESUMING;
1303 status = hcd->driver->bus_resume(hcd);
1305 /* TRSMRCY = 10 msec */
1307 usb_set_device_state(rhdev, rhdev->actconfig
1308 ? USB_STATE_CONFIGURED
1309 : USB_STATE_ADDRESS);
1310 hcd->state = HC_STATE_RUNNING;
1312 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
1319 /* Workqueue routine for root-hub remote wakeup */
1320 static void hcd_resume_work(struct work_struct *work)
1322 struct usb_hcd *hcd = container_of(work, struct usb_hcd, wakeup_work);
1323 struct usb_device *udev = hcd->self.root_hub;
1325 usb_lock_device(udev);
1326 usb_mark_last_busy(udev);
1327 usb_external_resume_device(udev);
1328 usb_unlock_device(udev);
1332 * usb_hcd_resume_root_hub - called by HCD to resume its root hub
1333 * @hcd: host controller for this root hub
1335 * The USB host controller calls this function when its root hub is
1336 * suspended (with the remote wakeup feature enabled) and a remote
1337 * wakeup request is received. The routine submits a workqueue request
1338 * to resume the root hub (that is, manage its downstream ports again).
1340 void usb_hcd_resume_root_hub (struct usb_hcd *hcd)
1342 unsigned long flags;
1344 spin_lock_irqsave (&hcd_root_hub_lock, flags);
1345 if (hcd->rh_registered)
1346 queue_work(ksuspend_usb_wq, &hcd->wakeup_work);
1347 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
1349 EXPORT_SYMBOL_GPL(usb_hcd_resume_root_hub);
1353 /*-------------------------------------------------------------------------*/
1355 #ifdef CONFIG_USB_OTG
1358 * usb_bus_start_enum - start immediate enumeration (for OTG)
1359 * @bus: the bus (must use hcd framework)
1360 * @port_num: 1-based number of port; usually bus->otg_port
1361 * Context: in_interrupt()
1363 * Starts enumeration, with an immediate reset followed later by
1364 * khubd identifying and possibly configuring the device.
1365 * This is needed by OTG controller drivers, where it helps meet
1366 * HNP protocol timing requirements for starting a port reset.
1368 int usb_bus_start_enum(struct usb_bus *bus, unsigned port_num)
1370 struct usb_hcd *hcd;
1371 int status = -EOPNOTSUPP;
1373 /* NOTE: since HNP can't start by grabbing the bus's address0_sem,
1374 * boards with root hubs hooked up to internal devices (instead of
1375 * just the OTG port) may need more attention to resetting...
1377 hcd = container_of (bus, struct usb_hcd, self);
1378 if (port_num && hcd->driver->start_port_reset)
1379 status = hcd->driver->start_port_reset(hcd, port_num);
1381 /* run khubd shortly after (first) root port reset finishes;
1382 * it may issue others, until at least 50 msecs have passed.
1385 mod_timer(&hcd->rh_timer, jiffies + msecs_to_jiffies(10));
1388 EXPORT_SYMBOL (usb_bus_start_enum);
1392 /*-------------------------------------------------------------------------*/
1395 * usb_hcd_giveback_urb - return URB from HCD to device driver
1396 * @hcd: host controller returning the URB
1397 * @urb: urb being returned to the USB device driver.
1398 * Context: in_interrupt()
1400 * This hands the URB from HCD to its USB device driver, using its
1401 * completion function. The HCD has freed all per-urb resources
1402 * (and is done using urb->hcpriv). It also released all HCD locks;
1403 * the device driver won't cause problems if it frees, modifies,
1404 * or resubmits this URB.
1406 void usb_hcd_giveback_urb (struct usb_hcd *hcd, struct urb *urb)
1408 urb_unlink(hcd, urb);
1409 usbmon_urb_complete (&hcd->self, urb);
1410 usb_unanchor_urb(urb);
1412 /* pass ownership to the completion handler */
1413 urb->complete (urb);
1414 atomic_dec (&urb->use_count);
1415 if (unlikely (urb->reject))
1416 wake_up (&usb_kill_urb_queue);
1419 EXPORT_SYMBOL (usb_hcd_giveback_urb);
1421 /*-------------------------------------------------------------------------*/
1424 * usb_hcd_irq - hook IRQs to HCD framework (bus glue)
1425 * @irq: the IRQ being raised
1426 * @__hcd: pointer to the HCD whose IRQ is being signaled
1427 * @r: saved hardware registers
1429 * If the controller isn't HALTed, calls the driver's irq handler.
1430 * Checks whether the controller is now dead.
1432 irqreturn_t usb_hcd_irq (int irq, void *__hcd)
1434 struct usb_hcd *hcd = __hcd;
1435 int start = hcd->state;
1437 if (unlikely(start == HC_STATE_HALT ||
1438 !test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags)))
1440 if (hcd->driver->irq (hcd) == IRQ_NONE)
1443 set_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
1445 if (unlikely(hcd->state == HC_STATE_HALT))
1450 /*-------------------------------------------------------------------------*/
1453 * usb_hc_died - report abnormal shutdown of a host controller (bus glue)
1454 * @hcd: pointer to the HCD representing the controller
1456 * This is called by bus glue to report a USB host controller that died
1457 * while operations may still have been pending. It's called automatically
1458 * by the PCI glue, so only glue for non-PCI busses should need to call it.
1460 void usb_hc_died (struct usb_hcd *hcd)
1462 unsigned long flags;
1464 dev_err (hcd->self.controller, "HC died; cleaning up\n");
1466 spin_lock_irqsave (&hcd_root_hub_lock, flags);
1467 if (hcd->rh_registered) {
1470 /* make khubd clean up old urbs and devices */
1471 usb_set_device_state (hcd->self.root_hub,
1472 USB_STATE_NOTATTACHED);
1473 usb_kick_khubd (hcd->self.root_hub);
1475 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
1477 EXPORT_SYMBOL_GPL (usb_hc_died);
1479 /*-------------------------------------------------------------------------*/
1482 * usb_create_hcd - create and initialize an HCD structure
1483 * @driver: HC driver that will use this hcd
1484 * @dev: device for this HC, stored in hcd->self.controller
1485 * @bus_name: value to store in hcd->self.bus_name
1486 * Context: !in_interrupt()
1488 * Allocate a struct usb_hcd, with extra space at the end for the
1489 * HC driver's private data. Initialize the generic members of the
1492 * If memory is unavailable, returns NULL.
1494 struct usb_hcd *usb_create_hcd (const struct hc_driver *driver,
1495 struct device *dev, char *bus_name)
1497 struct usb_hcd *hcd;
1499 hcd = kzalloc(sizeof(*hcd) + driver->hcd_priv_size, GFP_KERNEL);
1501 dev_dbg (dev, "hcd alloc failed\n");
1504 dev_set_drvdata(dev, hcd);
1505 kref_init(&hcd->kref);
1507 usb_bus_init(&hcd->self);
1508 hcd->self.controller = dev;
1509 hcd->self.bus_name = bus_name;
1510 hcd->self.uses_dma = (dev->dma_mask != NULL);
1512 init_timer(&hcd->rh_timer);
1513 hcd->rh_timer.function = rh_timer_func;
1514 hcd->rh_timer.data = (unsigned long) hcd;
1516 INIT_WORK(&hcd->wakeup_work, hcd_resume_work);
1519 hcd->driver = driver;
1520 hcd->product_desc = (driver->product_desc) ? driver->product_desc :
1521 "USB Host Controller";
1525 EXPORT_SYMBOL (usb_create_hcd);
1527 static void hcd_release (struct kref *kref)
1529 struct usb_hcd *hcd = container_of (kref, struct usb_hcd, kref);
1534 struct usb_hcd *usb_get_hcd (struct usb_hcd *hcd)
1537 kref_get (&hcd->kref);
1540 EXPORT_SYMBOL (usb_get_hcd);
1542 void usb_put_hcd (struct usb_hcd *hcd)
1545 kref_put (&hcd->kref, hcd_release);
1547 EXPORT_SYMBOL (usb_put_hcd);
1550 * usb_add_hcd - finish generic HCD structure initialization and register
1551 * @hcd: the usb_hcd structure to initialize
1552 * @irqnum: Interrupt line to allocate
1553 * @irqflags: Interrupt type flags
1555 * Finish the remaining parts of generic HCD initialization: allocate the
1556 * buffers of consistent memory, register the bus, request the IRQ line,
1557 * and call the driver's reset() and start() routines.
1559 int usb_add_hcd(struct usb_hcd *hcd,
1560 unsigned int irqnum, unsigned long irqflags)
1563 struct usb_device *rhdev;
1565 dev_info(hcd->self.controller, "%s\n", hcd->product_desc);
1567 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1569 /* HC is in reset state, but accessible. Now do the one-time init,
1570 * bottom up so that hcds can customize the root hubs before khubd
1571 * starts talking to them. (Note, bus id is assigned early too.)
1573 if ((retval = hcd_buffer_create(hcd)) != 0) {
1574 dev_dbg(hcd->self.controller, "pool alloc failed\n");
1578 if ((retval = usb_register_bus(&hcd->self)) < 0)
1579 goto err_register_bus;
1581 if ((rhdev = usb_alloc_dev(NULL, &hcd->self, 0)) == NULL) {
1582 dev_err(hcd->self.controller, "unable to allocate root hub\n");
1584 goto err_allocate_root_hub;
1586 rhdev->speed = (hcd->driver->flags & HCD_USB2) ? USB_SPEED_HIGH :
1588 hcd->self.root_hub = rhdev;
1590 /* wakeup flag init defaults to "everything works" for root hubs,
1591 * but drivers can override it in reset() if needed, along with
1592 * recording the overall controller's system wakeup capability.
1594 device_init_wakeup(&rhdev->dev, 1);
1596 /* "reset" is misnamed; its role is now one-time init. the controller
1597 * should already have been reset (and boot firmware kicked off etc).
1599 if (hcd->driver->reset && (retval = hcd->driver->reset(hcd)) < 0) {
1600 dev_err(hcd->self.controller, "can't setup\n");
1601 goto err_hcd_driver_setup;
1604 /* NOTE: root hub and controller capabilities may not be the same */
1605 if (device_can_wakeup(hcd->self.controller)
1606 && device_can_wakeup(&hcd->self.root_hub->dev))
1607 dev_dbg(hcd->self.controller, "supports USB remote wakeup\n");
1609 /* enable irqs just before we start the controller */
1610 if (hcd->driver->irq) {
1611 snprintf(hcd->irq_descr, sizeof(hcd->irq_descr), "%s:usb%d",
1612 hcd->driver->description, hcd->self.busnum);
1613 if ((retval = request_irq(irqnum, &usb_hcd_irq, irqflags,
1614 hcd->irq_descr, hcd)) != 0) {
1615 dev_err(hcd->self.controller,
1616 "request interrupt %d failed\n", irqnum);
1617 goto err_request_irq;
1620 dev_info(hcd->self.controller, "irq %d, %s 0x%08llx\n", irqnum,
1621 (hcd->driver->flags & HCD_MEMORY) ?
1622 "io mem" : "io base",
1623 (unsigned long long)hcd->rsrc_start);
1626 if (hcd->rsrc_start)
1627 dev_info(hcd->self.controller, "%s 0x%08llx\n",
1628 (hcd->driver->flags & HCD_MEMORY) ?
1629 "io mem" : "io base",
1630 (unsigned long long)hcd->rsrc_start);
1633 if ((retval = hcd->driver->start(hcd)) < 0) {
1634 dev_err(hcd->self.controller, "startup error %d\n", retval);
1635 goto err_hcd_driver_start;
1638 /* starting here, usbcore will pay attention to this root hub */
1639 rhdev->bus_mA = min(500u, hcd->power_budget);
1640 if ((retval = register_root_hub(hcd)) != 0)
1641 goto err_register_root_hub;
1643 if (hcd->uses_new_polling && hcd->poll_rh)
1644 usb_hcd_poll_rh_status(hcd);
1647 err_register_root_hub:
1648 hcd->driver->stop(hcd);
1649 err_hcd_driver_start:
1651 free_irq(irqnum, hcd);
1653 err_hcd_driver_setup:
1654 hcd->self.root_hub = NULL;
1656 err_allocate_root_hub:
1657 usb_deregister_bus(&hcd->self);
1659 hcd_buffer_destroy(hcd);
1662 EXPORT_SYMBOL (usb_add_hcd);
1665 * usb_remove_hcd - shutdown processing for generic HCDs
1666 * @hcd: the usb_hcd structure to remove
1667 * Context: !in_interrupt()
1669 * Disconnects the root hub, then reverses the effects of usb_add_hcd(),
1670 * invoking the HCD's stop() method.
1672 void usb_remove_hcd(struct usb_hcd *hcd)
1674 dev_info(hcd->self.controller, "remove, state %x\n", hcd->state);
1676 if (HC_IS_RUNNING (hcd->state))
1677 hcd->state = HC_STATE_QUIESCING;
1679 dev_dbg(hcd->self.controller, "roothub graceful disconnect\n");
1680 spin_lock_irq (&hcd_root_hub_lock);
1681 hcd->rh_registered = 0;
1682 spin_unlock_irq (&hcd_root_hub_lock);
1685 cancel_work_sync(&hcd->wakeup_work);
1688 mutex_lock(&usb_bus_list_lock);
1689 usb_disconnect(&hcd->self.root_hub);
1690 mutex_unlock(&usb_bus_list_lock);
1692 hcd->driver->stop(hcd);
1693 hcd->state = HC_STATE_HALT;
1696 del_timer_sync(&hcd->rh_timer);
1699 free_irq(hcd->irq, hcd);
1700 usb_deregister_bus(&hcd->self);
1701 hcd_buffer_destroy(hcd);
1703 EXPORT_SYMBOL (usb_remove_hcd);
1706 usb_hcd_platform_shutdown(struct platform_device* dev)
1708 struct usb_hcd *hcd = platform_get_drvdata(dev);
1710 if (hcd->driver->shutdown)
1711 hcd->driver->shutdown(hcd);
1713 EXPORT_SYMBOL (usb_hcd_platform_shutdown);
1715 /*-------------------------------------------------------------------------*/
1717 #if defined(CONFIG_USB_MON)
1719 struct usb_mon_operations *mon_ops;
1722 * The registration is unlocked.
1723 * We do it this way because we do not want to lock in hot paths.
1725 * Notice that the code is minimally error-proof. Because usbmon needs
1726 * symbols from usbcore, usbcore gets referenced and cannot be unloaded first.
1729 int usb_mon_register (struct usb_mon_operations *ops)
1739 EXPORT_SYMBOL_GPL (usb_mon_register);
1741 void usb_mon_deregister (void)
1744 if (mon_ops == NULL) {
1745 printk(KERN_ERR "USB: monitor was not registered\n");
1751 EXPORT_SYMBOL_GPL (usb_mon_deregister);
1753 #endif /* CONFIG_USB_MON */