2 * (C) Copyright Linus Torvalds 1999
3 * (C) Copyright Johannes Erdfelt 1999-2001
4 * (C) Copyright Andreas Gal 1999
5 * (C) Copyright Gregory P. Smith 1999
6 * (C) Copyright Deti Fliegl 1999
7 * (C) Copyright Randy Dunlap 2000
8 * (C) Copyright David Brownell 2000-2002
10 * This program is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License as published by the
12 * Free Software Foundation; either version 2 of the License, or (at your
13 * option) any later version.
15 * This program is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
17 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software Foundation,
22 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 #include <linux/module.h>
26 #include <linux/version.h>
27 #include <linux/kernel.h>
28 #include <linux/slab.h>
29 #include <linux/completion.h>
30 #include <linux/utsname.h>
33 #include <asm/scatterlist.h>
34 #include <linux/device.h>
35 #include <linux/dma-mapping.h>
36 #include <linux/mutex.h>
38 #include <asm/byteorder.h>
39 #include <linux/platform_device.h>
40 #include <linux/workqueue.h>
42 #include <linux/usb.h>
49 /*-------------------------------------------------------------------------*/
52 * USB Host Controller Driver framework
54 * Plugs into usbcore (usb_bus) and lets HCDs share code, minimizing
55 * HCD-specific behaviors/bugs.
57 * This does error checks, tracks devices and urbs, and delegates to a
58 * "hc_driver" only for code (and data) that really needs to know about
59 * hardware differences. That includes root hub registers, i/o queues,
60 * and so on ... but as little else as possible.
62 * Shared code includes most of the "root hub" code (these are emulated,
63 * though each HC's hardware works differently) and PCI glue, plus request
64 * tracking overhead. The HCD code should only block on spinlocks or on
65 * hardware handshaking; blocking on software events (such as other kernel
66 * threads releasing resources, or completing actions) is all generic.
68 * Happens the USB 2.0 spec says this would be invisible inside the "USBD",
69 * and includes mostly a "HCDI" (HCD Interface) along with some APIs used
70 * only by the hub driver ... and that neither should be seen or used by
71 * usb client device drivers.
73 * Contributors of ideas or unattributed patches include: David Brownell,
74 * Roman Weissgaerber, Rory Bolt, Greg Kroah-Hartman, ...
77 * 2002-02-21 Pull in most of the usb_bus support from usb.c; some
78 * associated cleanup. "usb_hcd" still != "usb_bus".
79 * 2001-12-12 Initial patch version for Linux 2.5.1 kernel.
82 /*-------------------------------------------------------------------------*/
84 /* host controllers we manage */
85 LIST_HEAD (usb_bus_list);
86 EXPORT_SYMBOL_GPL (usb_bus_list);
88 /* used when allocating bus numbers */
91 unsigned long busmap [USB_MAXBUS / (8*sizeof (unsigned long))];
93 static struct usb_busmap busmap;
95 /* used when updating list of hcds */
96 DEFINE_MUTEX(usb_bus_list_lock); /* exported only for usbfs */
97 EXPORT_SYMBOL_GPL (usb_bus_list_lock);
99 /* used for controlling access to virtual root hubs */
100 static DEFINE_SPINLOCK(hcd_root_hub_lock);
102 /* used when updating an endpoint's URB list */
103 static DEFINE_SPINLOCK(hcd_urb_list_lock);
105 /* wait queue for synchronous unlinks */
106 DECLARE_WAIT_QUEUE_HEAD(usb_kill_urb_queue);
108 static inline int is_root_hub(struct usb_device *udev)
110 return (udev->parent == NULL);
113 /*-------------------------------------------------------------------------*/
116 * Sharable chunks of root hub code.
119 /*-------------------------------------------------------------------------*/
121 #define KERNEL_REL ((LINUX_VERSION_CODE >> 16) & 0x0ff)
122 #define KERNEL_VER ((LINUX_VERSION_CODE >> 8) & 0x0ff)
124 /* usb 2.0 root hub device descriptor */
125 static const u8 usb2_rh_dev_descriptor [18] = {
126 0x12, /* __u8 bLength; */
127 0x01, /* __u8 bDescriptorType; Device */
128 0x00, 0x02, /* __le16 bcdUSB; v2.0 */
130 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
131 0x00, /* __u8 bDeviceSubClass; */
132 0x01, /* __u8 bDeviceProtocol; [ usb 2.0 single TT ]*/
133 0x40, /* __u8 bMaxPacketSize0; 64 Bytes */
135 0x00, 0x00, /* __le16 idVendor; */
136 0x00, 0x00, /* __le16 idProduct; */
137 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
139 0x03, /* __u8 iManufacturer; */
140 0x02, /* __u8 iProduct; */
141 0x01, /* __u8 iSerialNumber; */
142 0x01 /* __u8 bNumConfigurations; */
145 /* no usb 2.0 root hub "device qualifier" descriptor: one speed only */
147 /* usb 1.1 root hub device descriptor */
148 static const u8 usb11_rh_dev_descriptor [18] = {
149 0x12, /* __u8 bLength; */
150 0x01, /* __u8 bDescriptorType; Device */
151 0x10, 0x01, /* __le16 bcdUSB; v1.1 */
153 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
154 0x00, /* __u8 bDeviceSubClass; */
155 0x00, /* __u8 bDeviceProtocol; [ low/full speeds only ] */
156 0x40, /* __u8 bMaxPacketSize0; 64 Bytes */
158 0x00, 0x00, /* __le16 idVendor; */
159 0x00, 0x00, /* __le16 idProduct; */
160 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
162 0x03, /* __u8 iManufacturer; */
163 0x02, /* __u8 iProduct; */
164 0x01, /* __u8 iSerialNumber; */
165 0x01 /* __u8 bNumConfigurations; */
169 /*-------------------------------------------------------------------------*/
171 /* Configuration descriptors for our root hubs */
173 static const u8 fs_rh_config_descriptor [] = {
175 /* one configuration */
176 0x09, /* __u8 bLength; */
177 0x02, /* __u8 bDescriptorType; Configuration */
178 0x19, 0x00, /* __le16 wTotalLength; */
179 0x01, /* __u8 bNumInterfaces; (1) */
180 0x01, /* __u8 bConfigurationValue; */
181 0x00, /* __u8 iConfiguration; */
182 0xc0, /* __u8 bmAttributes;
187 0x00, /* __u8 MaxPower; */
190 * USB 2.0, single TT organization (mandatory):
191 * one interface, protocol 0
193 * USB 2.0, multiple TT organization (optional):
194 * two interfaces, protocols 1 (like single TT)
195 * and 2 (multiple TT mode) ... config is
201 0x09, /* __u8 if_bLength; */
202 0x04, /* __u8 if_bDescriptorType; Interface */
203 0x00, /* __u8 if_bInterfaceNumber; */
204 0x00, /* __u8 if_bAlternateSetting; */
205 0x01, /* __u8 if_bNumEndpoints; */
206 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
207 0x00, /* __u8 if_bInterfaceSubClass; */
208 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
209 0x00, /* __u8 if_iInterface; */
211 /* one endpoint (status change endpoint) */
212 0x07, /* __u8 ep_bLength; */
213 0x05, /* __u8 ep_bDescriptorType; Endpoint */
214 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
215 0x03, /* __u8 ep_bmAttributes; Interrupt */
216 0x02, 0x00, /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8) */
217 0xff /* __u8 ep_bInterval; (255ms -- usb 2.0 spec) */
220 static const u8 hs_rh_config_descriptor [] = {
222 /* one configuration */
223 0x09, /* __u8 bLength; */
224 0x02, /* __u8 bDescriptorType; Configuration */
225 0x19, 0x00, /* __le16 wTotalLength; */
226 0x01, /* __u8 bNumInterfaces; (1) */
227 0x01, /* __u8 bConfigurationValue; */
228 0x00, /* __u8 iConfiguration; */
229 0xc0, /* __u8 bmAttributes;
234 0x00, /* __u8 MaxPower; */
237 * USB 2.0, single TT organization (mandatory):
238 * one interface, protocol 0
240 * USB 2.0, multiple TT organization (optional):
241 * two interfaces, protocols 1 (like single TT)
242 * and 2 (multiple TT mode) ... config is
248 0x09, /* __u8 if_bLength; */
249 0x04, /* __u8 if_bDescriptorType; Interface */
250 0x00, /* __u8 if_bInterfaceNumber; */
251 0x00, /* __u8 if_bAlternateSetting; */
252 0x01, /* __u8 if_bNumEndpoints; */
253 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
254 0x00, /* __u8 if_bInterfaceSubClass; */
255 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
256 0x00, /* __u8 if_iInterface; */
258 /* one endpoint (status change endpoint) */
259 0x07, /* __u8 ep_bLength; */
260 0x05, /* __u8 ep_bDescriptorType; Endpoint */
261 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
262 0x03, /* __u8 ep_bmAttributes; Interrupt */
263 /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8)
264 * see hub.c:hub_configure() for details. */
265 (USB_MAXCHILDREN + 1 + 7) / 8, 0x00,
266 0x0c /* __u8 ep_bInterval; (256ms -- usb 2.0 spec) */
269 /*-------------------------------------------------------------------------*/
272 * helper routine for returning string descriptors in UTF-16LE
273 * input can actually be ISO-8859-1; ASCII is its 7-bit subset
275 static int ascii2utf (char *s, u8 *utf, int utfmax)
279 for (retval = 0; *s && utfmax > 1; utfmax -= 2, retval += 2) {
291 * rh_string - provides manufacturer, product and serial strings for root hub
292 * @id: the string ID number (1: serial number, 2: product, 3: vendor)
293 * @hcd: the host controller for this root hub
294 * @type: string describing our driver
295 * @data: return packet in UTF-16 LE
296 * @len: length of the return packet
298 * Produces either a manufacturer, product or serial number string for the
299 * virtual root hub device.
301 static int rh_string (
311 buf[0] = 4; buf[1] = 3; /* 4 bytes string data */
312 buf[2] = 0x09; buf[3] = 0x04; /* MSFT-speak for "en-us" */
314 memcpy (data, buf, len);
318 } else if (id == 1) {
319 strlcpy (buf, hcd->self.bus_name, sizeof buf);
321 // product description
322 } else if (id == 2) {
323 strlcpy (buf, hcd->product_desc, sizeof buf);
325 // id 3 == vendor description
326 } else if (id == 3) {
327 snprintf (buf, sizeof buf, "%s %s %s", init_utsname()->sysname,
328 init_utsname()->release, hcd->driver->description);
330 // unsupported IDs --> "protocol stall"
334 switch (len) { /* All cases fall through */
336 len = 2 + ascii2utf (buf, data + 2, len - 2);
338 data [1] = 3; /* type == string */
340 data [0] = 2 * (strlen (buf) + 1);
342 ; /* Compiler wants a statement here */
348 /* Root hub control transfers execute synchronously */
349 static int rh_call_control (struct usb_hcd *hcd, struct urb *urb)
351 struct usb_ctrlrequest *cmd;
352 u16 typeReq, wValue, wIndex, wLength;
353 u8 *ubuf = urb->transfer_buffer;
354 u8 tbuf [sizeof (struct usb_hub_descriptor)]
355 __attribute__((aligned(4)));
356 const u8 *bufp = tbuf;
358 int patch_wakeup = 0;
364 cmd = (struct usb_ctrlrequest *) urb->setup_packet;
365 typeReq = (cmd->bRequestType << 8) | cmd->bRequest;
366 wValue = le16_to_cpu (cmd->wValue);
367 wIndex = le16_to_cpu (cmd->wIndex);
368 wLength = le16_to_cpu (cmd->wLength);
370 if (wLength > urb->transfer_buffer_length)
373 urb->actual_length = 0;
376 /* DEVICE REQUESTS */
378 /* The root hub's remote wakeup enable bit is implemented using
379 * driver model wakeup flags. If this system supports wakeup
380 * through USB, userspace may change the default "allow wakeup"
381 * policy through sysfs or these calls.
383 * Most root hubs support wakeup from downstream devices, for
384 * runtime power management (disabling USB clocks and reducing
385 * VBUS power usage). However, not all of them do so; silicon,
386 * board, and BIOS bugs here are not uncommon, so these can't
387 * be treated quite like external hubs.
389 * Likewise, not all root hubs will pass wakeup events upstream,
390 * to wake up the whole system. So don't assume root hub and
391 * controller capabilities are identical.
394 case DeviceRequest | USB_REQ_GET_STATUS:
395 tbuf [0] = (device_may_wakeup(&hcd->self.root_hub->dev)
396 << USB_DEVICE_REMOTE_WAKEUP)
397 | (1 << USB_DEVICE_SELF_POWERED);
401 case DeviceOutRequest | USB_REQ_CLEAR_FEATURE:
402 if (wValue == USB_DEVICE_REMOTE_WAKEUP)
403 device_set_wakeup_enable(&hcd->self.root_hub->dev, 0);
407 case DeviceOutRequest | USB_REQ_SET_FEATURE:
408 if (device_can_wakeup(&hcd->self.root_hub->dev)
409 && wValue == USB_DEVICE_REMOTE_WAKEUP)
410 device_set_wakeup_enable(&hcd->self.root_hub->dev, 1);
414 case DeviceRequest | USB_REQ_GET_CONFIGURATION:
418 case DeviceOutRequest | USB_REQ_SET_CONFIGURATION:
420 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
421 switch (wValue & 0xff00) {
422 case USB_DT_DEVICE << 8:
423 if (hcd->driver->flags & HCD_USB2)
424 bufp = usb2_rh_dev_descriptor;
425 else if (hcd->driver->flags & HCD_USB11)
426 bufp = usb11_rh_dev_descriptor;
431 case USB_DT_CONFIG << 8:
432 if (hcd->driver->flags & HCD_USB2) {
433 bufp = hs_rh_config_descriptor;
434 len = sizeof hs_rh_config_descriptor;
436 bufp = fs_rh_config_descriptor;
437 len = sizeof fs_rh_config_descriptor;
439 if (device_can_wakeup(&hcd->self.root_hub->dev))
442 case USB_DT_STRING << 8:
443 n = rh_string (wValue & 0xff, hcd, ubuf, wLength);
446 urb->actual_length = n;
452 case DeviceRequest | USB_REQ_GET_INTERFACE:
456 case DeviceOutRequest | USB_REQ_SET_INTERFACE:
458 case DeviceOutRequest | USB_REQ_SET_ADDRESS:
459 // wValue == urb->dev->devaddr
460 dev_dbg (hcd->self.controller, "root hub device address %d\n",
464 /* INTERFACE REQUESTS (no defined feature/status flags) */
466 /* ENDPOINT REQUESTS */
468 case EndpointRequest | USB_REQ_GET_STATUS:
469 // ENDPOINT_HALT flag
474 case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
475 case EndpointOutRequest | USB_REQ_SET_FEATURE:
476 dev_dbg (hcd->self.controller, "no endpoint features yet\n");
479 /* CLASS REQUESTS (and errors) */
482 /* non-generic request */
488 case GetHubDescriptor:
489 len = sizeof (struct usb_hub_descriptor);
492 status = hcd->driver->hub_control (hcd,
493 typeReq, wValue, wIndex,
497 /* "protocol stall" on error */
503 if (status != -EPIPE) {
504 dev_dbg (hcd->self.controller,
505 "CTRL: TypeReq=0x%x val=0x%x "
506 "idx=0x%x len=%d ==> %d\n",
507 typeReq, wValue, wIndex,
512 if (urb->transfer_buffer_length < len)
513 len = urb->transfer_buffer_length;
514 urb->actual_length = len;
515 // always USB_DIR_IN, toward host
516 memcpy (ubuf, bufp, len);
518 /* report whether RH hardware supports remote wakeup */
520 len > offsetof (struct usb_config_descriptor,
522 ((struct usb_config_descriptor *)ubuf)->bmAttributes
523 |= USB_CONFIG_ATT_WAKEUP;
526 /* any errors get returned through the urb completion */
527 spin_lock_irq(&hcd_root_hub_lock);
528 spin_lock(&urb->lock);
529 if (urb->status == -EINPROGRESS)
530 urb->status = status;
531 spin_unlock(&urb->lock);
533 /* This peculiar use of spinlocks echoes what real HC drivers do.
534 * Avoiding calls to local_irq_disable/enable makes the code
537 spin_unlock(&hcd_root_hub_lock);
538 usb_hcd_giveback_urb(hcd, urb);
539 spin_lock(&hcd_root_hub_lock);
541 spin_unlock_irq(&hcd_root_hub_lock);
545 /*-------------------------------------------------------------------------*/
548 * Root Hub interrupt transfers are polled using a timer if the
549 * driver requests it; otherwise the driver is responsible for
550 * calling usb_hcd_poll_rh_status() when an event occurs.
552 * Completions are called in_interrupt(), but they may or may not
555 void usb_hcd_poll_rh_status(struct usb_hcd *hcd)
560 char buffer[4]; /* Any root hubs with > 31 ports? */
562 if (unlikely(!hcd->rh_registered))
564 if (!hcd->uses_new_polling && !hcd->status_urb)
567 length = hcd->driver->hub_status_data(hcd, buffer);
570 /* try to complete the status urb */
571 spin_lock_irqsave(&hcd_root_hub_lock, flags);
572 urb = hcd->status_urb;
574 spin_lock(&urb->lock);
575 if (urb->status == -EINPROGRESS) {
576 hcd->poll_pending = 0;
577 hcd->status_urb = NULL;
580 urb->actual_length = length;
581 memcpy(urb->transfer_buffer, buffer, length);
582 } else /* urb has been unlinked */
584 spin_unlock(&urb->lock);
586 spin_unlock(&hcd_root_hub_lock);
587 usb_hcd_giveback_urb(hcd, urb);
588 spin_lock(&hcd_root_hub_lock);
593 hcd->poll_pending = 1;
594 spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
597 /* The USB 2.0 spec says 256 ms. This is close enough and won't
598 * exceed that limit if HZ is 100. The math is more clunky than
599 * maybe expected, this is to make sure that all timers for USB devices
600 * fire at the same time to give the CPU a break inbetween */
601 if (hcd->uses_new_polling ? hcd->poll_rh :
602 (length == 0 && hcd->status_urb != NULL))
603 mod_timer (&hcd->rh_timer, (jiffies/(HZ/4) + 1) * (HZ/4));
605 EXPORT_SYMBOL_GPL(usb_hcd_poll_rh_status);
608 static void rh_timer_func (unsigned long _hcd)
610 usb_hcd_poll_rh_status((struct usb_hcd *) _hcd);
613 /*-------------------------------------------------------------------------*/
615 static int rh_queue_status (struct usb_hcd *hcd, struct urb *urb)
619 int len = 1 + (urb->dev->maxchild / 8);
621 spin_lock_irqsave (&hcd_root_hub_lock, flags);
622 if (urb->status != -EINPROGRESS) /* already unlinked */
623 retval = urb->status;
624 else if (hcd->status_urb || urb->transfer_buffer_length < len) {
625 dev_dbg (hcd->self.controller, "not queuing rh status urb\n");
628 hcd->status_urb = urb;
629 urb->hcpriv = hcd; /* indicate it's queued */
631 if (!hcd->uses_new_polling)
632 mod_timer (&hcd->rh_timer,
633 (jiffies/(HZ/4) + 1) * (HZ/4));
635 /* If a status change has already occurred, report it ASAP */
636 else if (hcd->poll_pending)
637 mod_timer (&hcd->rh_timer, jiffies);
640 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
644 static int rh_urb_enqueue (struct usb_hcd *hcd, struct urb *urb)
646 if (usb_endpoint_xfer_int(&urb->ep->desc))
647 return rh_queue_status (hcd, urb);
648 if (usb_endpoint_xfer_control(&urb->ep->desc))
649 return rh_call_control (hcd, urb);
653 /*-------------------------------------------------------------------------*/
655 /* Unlinks of root-hub control URBs are legal, but they don't do anything
656 * since these URBs always execute synchronously.
658 static int usb_rh_urb_dequeue (struct usb_hcd *hcd, struct urb *urb)
662 spin_lock_irqsave(&hcd_root_hub_lock, flags);
663 if (usb_endpoint_num(&urb->ep->desc) == 0) { /* Control URB */
666 } else { /* Status URB */
667 if (!hcd->uses_new_polling)
668 del_timer (&hcd->rh_timer);
669 if (urb == hcd->status_urb) {
670 hcd->status_urb = NULL;
673 spin_unlock(&hcd_root_hub_lock);
674 usb_hcd_giveback_urb(hcd, urb);
675 spin_lock(&hcd_root_hub_lock);
678 spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
685 * Show & store the current value of authorized_default
687 static ssize_t usb_host_authorized_default_show(struct device *dev,
688 struct device_attribute *attr,
691 struct usb_device *rh_usb_dev = to_usb_device(dev);
692 struct usb_bus *usb_bus = rh_usb_dev->bus;
693 struct usb_hcd *usb_hcd;
695 if (usb_bus == NULL) /* FIXME: not sure if this case is possible */
697 usb_hcd = bus_to_hcd(usb_bus);
698 return snprintf(buf, PAGE_SIZE, "%u\n", usb_hcd->authorized_default);
701 static ssize_t usb_host_authorized_default_store(struct device *dev,
702 struct device_attribute *attr,
703 const char *buf, size_t size)
707 struct usb_device *rh_usb_dev = to_usb_device(dev);
708 struct usb_bus *usb_bus = rh_usb_dev->bus;
709 struct usb_hcd *usb_hcd;
711 if (usb_bus == NULL) /* FIXME: not sure if this case is possible */
713 usb_hcd = bus_to_hcd(usb_bus);
714 result = sscanf(buf, "%u\n", &val);
716 usb_hcd->authorized_default = val? 1 : 0;
724 static DEVICE_ATTR(authorized_default, 0644,
725 usb_host_authorized_default_show,
726 usb_host_authorized_default_store);
729 /* Group all the USB bus attributes */
730 static struct attribute *usb_bus_attrs[] = {
731 &dev_attr_authorized_default.attr,
735 static struct attribute_group usb_bus_attr_group = {
736 .name = NULL, /* we want them in the same directory */
737 .attrs = usb_bus_attrs,
742 /*-------------------------------------------------------------------------*/
744 static struct class *usb_host_class;
746 int usb_host_init(void)
750 usb_host_class = class_create(THIS_MODULE, "usb_host");
751 if (IS_ERR(usb_host_class))
752 retval = PTR_ERR(usb_host_class);
756 void usb_host_cleanup(void)
758 class_destroy(usb_host_class);
762 * usb_bus_init - shared initialization code
763 * @bus: the bus structure being initialized
765 * This code is used to initialize a usb_bus structure, memory for which is
766 * separately managed.
768 static void usb_bus_init (struct usb_bus *bus)
770 memset (&bus->devmap, 0, sizeof(struct usb_devmap));
772 bus->devnum_next = 1;
774 bus->root_hub = NULL;
776 bus->bandwidth_allocated = 0;
777 bus->bandwidth_int_reqs = 0;
778 bus->bandwidth_isoc_reqs = 0;
780 INIT_LIST_HEAD (&bus->bus_list);
783 /*-------------------------------------------------------------------------*/
786 * usb_register_bus - registers the USB host controller with the usb core
787 * @bus: pointer to the bus to register
788 * Context: !in_interrupt()
790 * Assigns a bus number, and links the controller into usbcore data
791 * structures so that it can be seen by scanning the bus list.
793 static int usb_register_bus(struct usb_bus *bus)
797 mutex_lock(&usb_bus_list_lock);
798 busnum = find_next_zero_bit (busmap.busmap, USB_MAXBUS, 1);
799 if (busnum < USB_MAXBUS) {
800 set_bit (busnum, busmap.busmap);
801 bus->busnum = busnum;
803 printk (KERN_ERR "%s: too many buses\n", usbcore_name);
804 mutex_unlock(&usb_bus_list_lock);
808 bus->class_dev = class_device_create(usb_host_class, NULL, MKDEV(0,0),
809 bus->controller, "usb_host%d", busnum);
810 if (IS_ERR(bus->class_dev)) {
811 clear_bit(busnum, busmap.busmap);
812 mutex_unlock(&usb_bus_list_lock);
813 return PTR_ERR(bus->class_dev);
816 class_set_devdata(bus->class_dev, bus);
818 /* Add it to the local list of buses */
819 list_add (&bus->bus_list, &usb_bus_list);
820 mutex_unlock(&usb_bus_list_lock);
822 usb_notify_add_bus(bus);
824 dev_info (bus->controller, "new USB bus registered, assigned bus number %d\n", bus->busnum);
829 * usb_deregister_bus - deregisters the USB host controller
830 * @bus: pointer to the bus to deregister
831 * Context: !in_interrupt()
833 * Recycles the bus number, and unlinks the controller from usbcore data
834 * structures so that it won't be seen by scanning the bus list.
836 static void usb_deregister_bus (struct usb_bus *bus)
838 dev_info (bus->controller, "USB bus %d deregistered\n", bus->busnum);
841 * NOTE: make sure that all the devices are removed by the
842 * controller code, as well as having it call this when cleaning
845 mutex_lock(&usb_bus_list_lock);
846 list_del (&bus->bus_list);
847 mutex_unlock(&usb_bus_list_lock);
849 usb_notify_remove_bus(bus);
851 clear_bit (bus->busnum, busmap.busmap);
853 class_device_unregister(bus->class_dev);
857 * register_root_hub - called by usb_add_hcd() to register a root hub
858 * @hcd: host controller for this root hub
860 * This function registers the root hub with the USB subsystem. It sets up
861 * the device properly in the device tree and then calls usb_new_device()
862 * to register the usb device. It also assigns the root hub's USB address
865 static int register_root_hub(struct usb_hcd *hcd)
867 struct device *parent_dev = hcd->self.controller;
868 struct usb_device *usb_dev = hcd->self.root_hub;
869 const int devnum = 1;
872 usb_dev->devnum = devnum;
873 usb_dev->bus->devnum_next = devnum + 1;
874 memset (&usb_dev->bus->devmap.devicemap, 0,
875 sizeof usb_dev->bus->devmap.devicemap);
876 set_bit (devnum, usb_dev->bus->devmap.devicemap);
877 usb_set_device_state(usb_dev, USB_STATE_ADDRESS);
879 mutex_lock(&usb_bus_list_lock);
881 usb_dev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
882 retval = usb_get_device_descriptor(usb_dev, USB_DT_DEVICE_SIZE);
883 if (retval != sizeof usb_dev->descriptor) {
884 mutex_unlock(&usb_bus_list_lock);
885 dev_dbg (parent_dev, "can't read %s device descriptor %d\n",
886 usb_dev->dev.bus_id, retval);
887 return (retval < 0) ? retval : -EMSGSIZE;
890 retval = usb_new_device (usb_dev);
892 dev_err (parent_dev, "can't register root hub for %s, %d\n",
893 usb_dev->dev.bus_id, retval);
895 mutex_unlock(&usb_bus_list_lock);
898 spin_lock_irq (&hcd_root_hub_lock);
899 hcd->rh_registered = 1;
900 spin_unlock_irq (&hcd_root_hub_lock);
902 /* Did the HC die before the root hub was registered? */
903 if (hcd->state == HC_STATE_HALT)
904 usb_hc_died (hcd); /* This time clean up */
910 void usb_enable_root_hub_irq (struct usb_bus *bus)
914 hcd = container_of (bus, struct usb_hcd, self);
915 if (hcd->driver->hub_irq_enable && hcd->state != HC_STATE_HALT)
916 hcd->driver->hub_irq_enable (hcd);
920 /*-------------------------------------------------------------------------*/
923 * usb_calc_bus_time - approximate periodic transaction time in nanoseconds
924 * @speed: from dev->speed; USB_SPEED_{LOW,FULL,HIGH}
925 * @is_input: true iff the transaction sends data to the host
926 * @isoc: true for isochronous transactions, false for interrupt ones
927 * @bytecount: how many bytes in the transaction.
929 * Returns approximate bus time in nanoseconds for a periodic transaction.
930 * See USB 2.0 spec section 5.11.3; only periodic transfers need to be
931 * scheduled in software, this function is only used for such scheduling.
933 long usb_calc_bus_time (int speed, int is_input, int isoc, int bytecount)
938 case USB_SPEED_LOW: /* INTR only */
940 tmp = (67667L * (31L + 10L * BitTime (bytecount))) / 1000L;
941 return (64060L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp);
943 tmp = (66700L * (31L + 10L * BitTime (bytecount))) / 1000L;
944 return (64107L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp);
946 case USB_SPEED_FULL: /* ISOC or INTR */
948 tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
949 return (((is_input) ? 7268L : 6265L) + BW_HOST_DELAY + tmp);
951 tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
952 return (9107L + BW_HOST_DELAY + tmp);
954 case USB_SPEED_HIGH: /* ISOC or INTR */
955 // FIXME adjust for input vs output
957 tmp = HS_NSECS_ISO (bytecount);
959 tmp = HS_NSECS (bytecount);
962 pr_debug ("%s: bogus device speed!\n", usbcore_name);
966 EXPORT_SYMBOL (usb_calc_bus_time);
969 /*-------------------------------------------------------------------------*/
972 * Generic HC operations.
975 /*-------------------------------------------------------------------------*/
977 static int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb)
982 spin_lock_irqsave(&hcd_urb_list_lock, flags);
984 /* Check that the URB isn't being killed */
985 if (unlikely(urb->reject)) {
990 if (unlikely(!urb->ep->enabled)) {
996 * Check the host controller's state and add the URB to the
999 switch (hcd->state) {
1000 case HC_STATE_RUNNING:
1001 case HC_STATE_RESUMING:
1002 list_add_tail(&urb->urb_list, &urb->ep->urb_list);
1009 spin_unlock_irqrestore(&hcd_urb_list_lock, flags);
1013 static int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb,
1016 unsigned long flags;
1017 struct list_head *tmp;
1021 * we contend for urb->status with the hcd core,
1022 * which changes it while returning the urb.
1024 * Caller guaranteed that the urb pointer hasn't been freed, and
1025 * that it was submitted. But as a rule it can't know whether or
1026 * not it's already been unlinked ... so we respect the reversed
1027 * lock sequence needed for the usb_hcd_giveback_urb() code paths
1028 * (urb lock, then hcd_urb_list_lock) in case some other CPU is now
1031 spin_lock_irqsave(&urb->lock, flags);
1032 spin_lock(&hcd_urb_list_lock);
1034 /* insist the urb is still queued */
1035 list_for_each(tmp, &urb->ep->urb_list) {
1036 if (tmp == &urb->urb_list)
1039 if (tmp != &urb->urb_list) {
1044 /* Any status except -EINPROGRESS means something already started to
1045 * unlink this URB from the hardware. So there's no more work to do.
1047 if (urb->status != -EINPROGRESS) {
1051 urb->status = status;
1053 /* IRQ setup can easily be broken so that USB controllers
1054 * never get completion IRQs ... maybe even the ones we need to
1055 * finish unlinking the initial failed usb_set_address()
1056 * or device descriptor fetch.
1058 if (!test_bit(HCD_FLAG_SAW_IRQ, &hcd->flags) &&
1059 !is_root_hub(urb->dev)) {
1060 dev_warn(hcd->self.controller, "Unlink after no-IRQ? "
1061 "Controller is probably using the wrong IRQ.\n");
1062 set_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
1066 spin_unlock(&hcd_urb_list_lock);
1067 spin_unlock_irqrestore (&urb->lock, flags);
1071 static void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb)
1073 unsigned long flags;
1075 /* clear all state linking urb to this dev (and hcd) */
1076 spin_lock_irqsave(&hcd_urb_list_lock, flags);
1077 list_del_init(&urb->urb_list);
1078 spin_unlock_irqrestore(&hcd_urb_list_lock, flags);
1081 static void map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
1083 /* Map the URB's buffers for DMA access.
1084 * Lower level HCD code should use *_dma exclusively,
1085 * unless it uses pio or talks to another transport.
1087 if (hcd->self.uses_dma && !is_root_hub(urb->dev)) {
1088 if (usb_endpoint_xfer_control(&urb->ep->desc)
1089 && !(urb->transfer_flags & URB_NO_SETUP_DMA_MAP))
1090 urb->setup_dma = dma_map_single (
1091 hcd->self.controller,
1093 sizeof (struct usb_ctrlrequest),
1095 if (urb->transfer_buffer_length != 0
1096 && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP))
1097 urb->transfer_dma = dma_map_single (
1098 hcd->self.controller,
1099 urb->transfer_buffer,
1100 urb->transfer_buffer_length,
1107 static void unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
1109 if (hcd->self.uses_dma && !is_root_hub(urb->dev)) {
1110 if (usb_endpoint_xfer_control(&urb->ep->desc)
1111 && !(urb->transfer_flags & URB_NO_SETUP_DMA_MAP))
1112 dma_unmap_single(hcd->self.controller, urb->setup_dma,
1113 sizeof(struct usb_ctrlrequest),
1115 if (urb->transfer_buffer_length != 0
1116 && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP))
1117 dma_unmap_single(hcd->self.controller,
1119 urb->transfer_buffer_length,
1126 /*-------------------------------------------------------------------------*/
1128 /* may be called in any context with a valid urb->dev usecount
1129 * caller surrenders "ownership" of urb
1130 * expects usb_submit_urb() to have sanity checked and conditioned all
1133 int usb_hcd_submit_urb (struct urb *urb, gfp_t mem_flags)
1136 struct usb_hcd *hcd = bus_to_hcd(urb->dev->bus);
1138 /* increment urb's reference count as part of giving it to the HCD
1139 * (which will control it). HCD guarantees that it either returns
1140 * an error or calls giveback(), but not both.
1143 atomic_inc(&urb->use_count);
1144 usbmon_urb_submit(&hcd->self, urb);
1146 /* NOTE requirements on root-hub callers (usbfs and the hub
1147 * driver, for now): URBs' urb->transfer_buffer must be
1148 * valid and usb_buffer_{sync,unmap}() not be needed, since
1149 * they could clobber root hub response data. Also, control
1150 * URBs must be submitted in process context with interrupts
1153 status = usb_hcd_link_urb_to_ep(hcd, urb);
1155 map_urb_for_dma(hcd, urb);
1156 if (is_root_hub(urb->dev))
1157 status = rh_urb_enqueue(hcd, urb);
1159 status = hcd->driver->urb_enqueue(hcd, urb->ep, urb,
1163 if (unlikely(status)) {
1164 usbmon_urb_submit_error(&hcd->self, urb, status);
1165 unmap_urb_for_dma(hcd, urb);
1166 usb_hcd_unlink_urb_from_ep(hcd, urb);
1167 INIT_LIST_HEAD(&urb->urb_list);
1168 atomic_dec(&urb->use_count);
1170 wake_up(&usb_kill_urb_queue);
1176 /*-------------------------------------------------------------------------*/
1178 /* this makes the hcd giveback() the urb more quickly, by kicking it
1179 * off hardware queues (which may take a while) and returning it as
1180 * soon as practical. we've already set up the urb's return status,
1181 * but we can't know if the callback completed already.
1184 unlink1 (struct usb_hcd *hcd, struct urb *urb)
1188 if (is_root_hub(urb->dev))
1189 value = usb_rh_urb_dequeue (hcd, urb);
1192 /* The only reason an HCD might fail this call is if
1193 * it has not yet fully queued the urb to begin with.
1194 * Such failures should be harmless. */
1195 value = hcd->driver->urb_dequeue (hcd, urb);
1199 dev_dbg (hcd->self.controller, "dequeue %p --> %d\n",
1205 * called in any context
1207 * caller guarantees urb won't be recycled till both unlink()
1208 * and the urb's completion function return
1210 int usb_hcd_unlink_urb (struct urb *urb, int status)
1212 struct usb_hcd *hcd;
1215 hcd = bus_to_hcd(urb->dev->bus);
1217 retval = usb_hcd_check_unlink_urb(hcd, urb, status);
1219 retval = unlink1(hcd, urb);
1222 retval = -EINPROGRESS;
1223 else if (retval != -EIDRM)
1224 dev_dbg(&urb->dev->dev, "hcd_unlink_urb %p fail %d\n",
1229 /*-------------------------------------------------------------------------*/
1232 * usb_hcd_giveback_urb - return URB from HCD to device driver
1233 * @hcd: host controller returning the URB
1234 * @urb: urb being returned to the USB device driver.
1235 * Context: in_interrupt()
1237 * This hands the URB from HCD to its USB device driver, using its
1238 * completion function. The HCD has freed all per-urb resources
1239 * (and is done using urb->hcpriv). It also released all HCD locks;
1240 * the device driver won't cause problems if it frees, modifies,
1241 * or resubmits this URB.
1243 void usb_hcd_giveback_urb (struct usb_hcd *hcd, struct urb *urb)
1245 usb_hcd_unlink_urb_from_ep(hcd, urb);
1246 unmap_urb_for_dma(hcd, urb);
1247 usbmon_urb_complete (&hcd->self, urb);
1248 usb_unanchor_urb(urb);
1250 /* pass ownership to the completion handler */
1251 urb->complete (urb);
1252 atomic_dec (&urb->use_count);
1253 if (unlikely (urb->reject))
1254 wake_up (&usb_kill_urb_queue);
1257 EXPORT_SYMBOL (usb_hcd_giveback_urb);
1259 /*-------------------------------------------------------------------------*/
1261 /* disables the endpoint: cancels any pending urbs, then synchronizes with
1262 * the hcd to make sure all endpoint state is gone from hardware, and then
1263 * waits until the endpoint's queue is completely drained. use for
1264 * set_configuration, set_interface, driver removal, physical disconnect.
1266 * example: a qh stored in ep->hcpriv, holding state related to endpoint
1267 * type, maxpacket size, toggle, halt status, and scheduling.
1269 void usb_hcd_endpoint_disable (struct usb_device *udev,
1270 struct usb_host_endpoint *ep)
1272 struct usb_hcd *hcd;
1276 hcd = bus_to_hcd(udev->bus);
1278 /* ep is already gone from udev->ep_{in,out}[]; no more submits */
1280 spin_lock_irq(&hcd_urb_list_lock);
1281 list_for_each_entry (urb, &ep->urb_list, urb_list) {
1285 /* the urb may already have been unlinked */
1286 if (urb->status != -EINPROGRESS)
1289 is_in = usb_urb_dir_in(urb);
1290 spin_unlock(&hcd_urb_list_lock);
1292 spin_lock (&urb->lock);
1294 if (tmp == -EINPROGRESS)
1295 urb->status = -ESHUTDOWN;
1296 spin_unlock (&urb->lock);
1298 /* kick hcd unless it's already returning this */
1299 if (tmp == -EINPROGRESS) {
1301 dev_dbg (hcd->self.controller,
1302 "shutdown urb %p ep%d%s%s\n",
1303 urb, usb_endpoint_num(&ep->desc),
1304 is_in ? "in" : "out",
1307 switch (usb_endpoint_type(&ep->desc)) {
1308 case USB_ENDPOINT_XFER_CONTROL:
1310 case USB_ENDPOINT_XFER_BULK:
1312 case USB_ENDPOINT_XFER_INT:
1322 /* list contents may have changed */
1325 spin_unlock_irq(&hcd_urb_list_lock);
1327 /* synchronize with the hardware, so old configuration state
1328 * clears out immediately (and will be freed).
1330 if (hcd->driver->endpoint_disable)
1331 hcd->driver->endpoint_disable (hcd, ep);
1333 /* Wait until the endpoint queue is completely empty. Most HCDs
1334 * will have done this already in their endpoint_disable method,
1335 * but some might not. And there could be root-hub control URBs
1336 * still pending since they aren't affected by the HCDs'
1337 * endpoint_disable methods.
1339 while (!list_empty (&ep->urb_list)) {
1340 spin_lock_irq(&hcd_urb_list_lock);
1342 /* The list may have changed while we acquired the spinlock */
1344 if (!list_empty (&ep->urb_list)) {
1345 urb = list_entry (ep->urb_list.prev, struct urb,
1349 spin_unlock_irq(&hcd_urb_list_lock);
1358 /*-------------------------------------------------------------------------*/
1360 /* called in any context */
1361 int usb_hcd_get_frame_number (struct usb_device *udev)
1363 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1365 if (!HC_IS_RUNNING (hcd->state))
1367 return hcd->driver->get_frame_number (hcd);
1370 /*-------------------------------------------------------------------------*/
1374 int hcd_bus_suspend(struct usb_device *rhdev)
1376 struct usb_hcd *hcd = container_of(rhdev->bus, struct usb_hcd, self);
1378 int old_state = hcd->state;
1380 dev_dbg(&rhdev->dev, "bus %s%s\n",
1381 rhdev->auto_pm ? "auto-" : "", "suspend");
1382 if (!hcd->driver->bus_suspend) {
1385 hcd->state = HC_STATE_QUIESCING;
1386 status = hcd->driver->bus_suspend(hcd);
1389 usb_set_device_state(rhdev, USB_STATE_SUSPENDED);
1390 hcd->state = HC_STATE_SUSPENDED;
1392 hcd->state = old_state;
1393 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
1399 int hcd_bus_resume(struct usb_device *rhdev)
1401 struct usb_hcd *hcd = container_of(rhdev->bus, struct usb_hcd, self);
1403 int old_state = hcd->state;
1405 dev_dbg(&rhdev->dev, "usb %s%s\n",
1406 rhdev->auto_pm ? "auto-" : "", "resume");
1407 if (!hcd->driver->bus_resume)
1409 if (hcd->state == HC_STATE_RUNNING)
1412 hcd->state = HC_STATE_RESUMING;
1413 status = hcd->driver->bus_resume(hcd);
1415 /* TRSMRCY = 10 msec */
1417 usb_set_device_state(rhdev, rhdev->actconfig
1418 ? USB_STATE_CONFIGURED
1419 : USB_STATE_ADDRESS);
1420 hcd->state = HC_STATE_RUNNING;
1422 hcd->state = old_state;
1423 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
1425 if (status != -ESHUTDOWN)
1431 /* Workqueue routine for root-hub remote wakeup */
1432 static void hcd_resume_work(struct work_struct *work)
1434 struct usb_hcd *hcd = container_of(work, struct usb_hcd, wakeup_work);
1435 struct usb_device *udev = hcd->self.root_hub;
1437 usb_lock_device(udev);
1438 usb_mark_last_busy(udev);
1439 usb_external_resume_device(udev);
1440 usb_unlock_device(udev);
1444 * usb_hcd_resume_root_hub - called by HCD to resume its root hub
1445 * @hcd: host controller for this root hub
1447 * The USB host controller calls this function when its root hub is
1448 * suspended (with the remote wakeup feature enabled) and a remote
1449 * wakeup request is received. The routine submits a workqueue request
1450 * to resume the root hub (that is, manage its downstream ports again).
1452 void usb_hcd_resume_root_hub (struct usb_hcd *hcd)
1454 unsigned long flags;
1456 spin_lock_irqsave (&hcd_root_hub_lock, flags);
1457 if (hcd->rh_registered)
1458 queue_work(ksuspend_usb_wq, &hcd->wakeup_work);
1459 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
1461 EXPORT_SYMBOL_GPL(usb_hcd_resume_root_hub);
1465 /*-------------------------------------------------------------------------*/
1467 #ifdef CONFIG_USB_OTG
1470 * usb_bus_start_enum - start immediate enumeration (for OTG)
1471 * @bus: the bus (must use hcd framework)
1472 * @port_num: 1-based number of port; usually bus->otg_port
1473 * Context: in_interrupt()
1475 * Starts enumeration, with an immediate reset followed later by
1476 * khubd identifying and possibly configuring the device.
1477 * This is needed by OTG controller drivers, where it helps meet
1478 * HNP protocol timing requirements for starting a port reset.
1480 int usb_bus_start_enum(struct usb_bus *bus, unsigned port_num)
1482 struct usb_hcd *hcd;
1483 int status = -EOPNOTSUPP;
1485 /* NOTE: since HNP can't start by grabbing the bus's address0_sem,
1486 * boards with root hubs hooked up to internal devices (instead of
1487 * just the OTG port) may need more attention to resetting...
1489 hcd = container_of (bus, struct usb_hcd, self);
1490 if (port_num && hcd->driver->start_port_reset)
1491 status = hcd->driver->start_port_reset(hcd, port_num);
1493 /* run khubd shortly after (first) root port reset finishes;
1494 * it may issue others, until at least 50 msecs have passed.
1497 mod_timer(&hcd->rh_timer, jiffies + msecs_to_jiffies(10));
1500 EXPORT_SYMBOL (usb_bus_start_enum);
1504 /*-------------------------------------------------------------------------*/
1507 * usb_hcd_irq - hook IRQs to HCD framework (bus glue)
1508 * @irq: the IRQ being raised
1509 * @__hcd: pointer to the HCD whose IRQ is being signaled
1510 * @r: saved hardware registers
1512 * If the controller isn't HALTed, calls the driver's irq handler.
1513 * Checks whether the controller is now dead.
1515 irqreturn_t usb_hcd_irq (int irq, void *__hcd)
1517 struct usb_hcd *hcd = __hcd;
1518 int start = hcd->state;
1520 if (unlikely(start == HC_STATE_HALT ||
1521 !test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags)))
1523 if (hcd->driver->irq (hcd) == IRQ_NONE)
1526 set_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
1528 if (unlikely(hcd->state == HC_STATE_HALT))
1533 /*-------------------------------------------------------------------------*/
1536 * usb_hc_died - report abnormal shutdown of a host controller (bus glue)
1537 * @hcd: pointer to the HCD representing the controller
1539 * This is called by bus glue to report a USB host controller that died
1540 * while operations may still have been pending. It's called automatically
1541 * by the PCI glue, so only glue for non-PCI busses should need to call it.
1543 void usb_hc_died (struct usb_hcd *hcd)
1545 unsigned long flags;
1547 dev_err (hcd->self.controller, "HC died; cleaning up\n");
1549 spin_lock_irqsave (&hcd_root_hub_lock, flags);
1550 if (hcd->rh_registered) {
1553 /* make khubd clean up old urbs and devices */
1554 usb_set_device_state (hcd->self.root_hub,
1555 USB_STATE_NOTATTACHED);
1556 usb_kick_khubd (hcd->self.root_hub);
1558 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
1560 EXPORT_SYMBOL_GPL (usb_hc_died);
1562 /*-------------------------------------------------------------------------*/
1565 * usb_create_hcd - create and initialize an HCD structure
1566 * @driver: HC driver that will use this hcd
1567 * @dev: device for this HC, stored in hcd->self.controller
1568 * @bus_name: value to store in hcd->self.bus_name
1569 * Context: !in_interrupt()
1571 * Allocate a struct usb_hcd, with extra space at the end for the
1572 * HC driver's private data. Initialize the generic members of the
1575 * If memory is unavailable, returns NULL.
1577 struct usb_hcd *usb_create_hcd (const struct hc_driver *driver,
1578 struct device *dev, char *bus_name)
1580 struct usb_hcd *hcd;
1582 hcd = kzalloc(sizeof(*hcd) + driver->hcd_priv_size, GFP_KERNEL);
1584 dev_dbg (dev, "hcd alloc failed\n");
1587 dev_set_drvdata(dev, hcd);
1588 kref_init(&hcd->kref);
1590 usb_bus_init(&hcd->self);
1591 hcd->self.controller = dev;
1592 hcd->self.bus_name = bus_name;
1593 hcd->self.uses_dma = (dev->dma_mask != NULL);
1595 init_timer(&hcd->rh_timer);
1596 hcd->rh_timer.function = rh_timer_func;
1597 hcd->rh_timer.data = (unsigned long) hcd;
1599 INIT_WORK(&hcd->wakeup_work, hcd_resume_work);
1602 hcd->driver = driver;
1603 hcd->product_desc = (driver->product_desc) ? driver->product_desc :
1604 "USB Host Controller";
1607 EXPORT_SYMBOL (usb_create_hcd);
1609 static void hcd_release (struct kref *kref)
1611 struct usb_hcd *hcd = container_of (kref, struct usb_hcd, kref);
1616 struct usb_hcd *usb_get_hcd (struct usb_hcd *hcd)
1619 kref_get (&hcd->kref);
1622 EXPORT_SYMBOL (usb_get_hcd);
1624 void usb_put_hcd (struct usb_hcd *hcd)
1627 kref_put (&hcd->kref, hcd_release);
1629 EXPORT_SYMBOL (usb_put_hcd);
1632 * usb_add_hcd - finish generic HCD structure initialization and register
1633 * @hcd: the usb_hcd structure to initialize
1634 * @irqnum: Interrupt line to allocate
1635 * @irqflags: Interrupt type flags
1637 * Finish the remaining parts of generic HCD initialization: allocate the
1638 * buffers of consistent memory, register the bus, request the IRQ line,
1639 * and call the driver's reset() and start() routines.
1641 int usb_add_hcd(struct usb_hcd *hcd,
1642 unsigned int irqnum, unsigned long irqflags)
1645 struct usb_device *rhdev;
1647 dev_info(hcd->self.controller, "%s\n", hcd->product_desc);
1649 hcd->authorized_default = hcd->wireless? 0 : 1;
1650 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1652 /* HC is in reset state, but accessible. Now do the one-time init,
1653 * bottom up so that hcds can customize the root hubs before khubd
1654 * starts talking to them. (Note, bus id is assigned early too.)
1656 if ((retval = hcd_buffer_create(hcd)) != 0) {
1657 dev_dbg(hcd->self.controller, "pool alloc failed\n");
1661 if ((retval = usb_register_bus(&hcd->self)) < 0)
1662 goto err_register_bus;
1664 if ((rhdev = usb_alloc_dev(NULL, &hcd->self, 0)) == NULL) {
1665 dev_err(hcd->self.controller, "unable to allocate root hub\n");
1667 goto err_allocate_root_hub;
1669 rhdev->speed = (hcd->driver->flags & HCD_USB2) ? USB_SPEED_HIGH :
1671 hcd->self.root_hub = rhdev;
1673 /* wakeup flag init defaults to "everything works" for root hubs,
1674 * but drivers can override it in reset() if needed, along with
1675 * recording the overall controller's system wakeup capability.
1677 device_init_wakeup(&rhdev->dev, 1);
1679 /* "reset" is misnamed; its role is now one-time init. the controller
1680 * should already have been reset (and boot firmware kicked off etc).
1682 if (hcd->driver->reset && (retval = hcd->driver->reset(hcd)) < 0) {
1683 dev_err(hcd->self.controller, "can't setup\n");
1684 goto err_hcd_driver_setup;
1687 /* NOTE: root hub and controller capabilities may not be the same */
1688 if (device_can_wakeup(hcd->self.controller)
1689 && device_can_wakeup(&hcd->self.root_hub->dev))
1690 dev_dbg(hcd->self.controller, "supports USB remote wakeup\n");
1692 /* enable irqs just before we start the controller */
1693 if (hcd->driver->irq) {
1694 snprintf(hcd->irq_descr, sizeof(hcd->irq_descr), "%s:usb%d",
1695 hcd->driver->description, hcd->self.busnum);
1696 if ((retval = request_irq(irqnum, &usb_hcd_irq, irqflags,
1697 hcd->irq_descr, hcd)) != 0) {
1698 dev_err(hcd->self.controller,
1699 "request interrupt %d failed\n", irqnum);
1700 goto err_request_irq;
1703 dev_info(hcd->self.controller, "irq %d, %s 0x%08llx\n", irqnum,
1704 (hcd->driver->flags & HCD_MEMORY) ?
1705 "io mem" : "io base",
1706 (unsigned long long)hcd->rsrc_start);
1709 if (hcd->rsrc_start)
1710 dev_info(hcd->self.controller, "%s 0x%08llx\n",
1711 (hcd->driver->flags & HCD_MEMORY) ?
1712 "io mem" : "io base",
1713 (unsigned long long)hcd->rsrc_start);
1716 if ((retval = hcd->driver->start(hcd)) < 0) {
1717 dev_err(hcd->self.controller, "startup error %d\n", retval);
1718 goto err_hcd_driver_start;
1721 /* starting here, usbcore will pay attention to this root hub */
1722 rhdev->bus_mA = min(500u, hcd->power_budget);
1723 if ((retval = register_root_hub(hcd)) != 0)
1724 goto err_register_root_hub;
1726 retval = sysfs_create_group(&rhdev->dev.kobj, &usb_bus_attr_group);
1728 printk(KERN_ERR "Cannot register USB bus sysfs attributes: %d\n",
1730 goto error_create_attr_group;
1732 if (hcd->uses_new_polling && hcd->poll_rh)
1733 usb_hcd_poll_rh_status(hcd);
1736 error_create_attr_group:
1737 mutex_lock(&usb_bus_list_lock);
1738 usb_disconnect(&hcd->self.root_hub);
1739 mutex_unlock(&usb_bus_list_lock);
1740 err_register_root_hub:
1741 hcd->driver->stop(hcd);
1742 err_hcd_driver_start:
1744 free_irq(irqnum, hcd);
1746 err_hcd_driver_setup:
1747 hcd->self.root_hub = NULL;
1749 err_allocate_root_hub:
1750 usb_deregister_bus(&hcd->self);
1752 hcd_buffer_destroy(hcd);
1755 EXPORT_SYMBOL (usb_add_hcd);
1758 * usb_remove_hcd - shutdown processing for generic HCDs
1759 * @hcd: the usb_hcd structure to remove
1760 * Context: !in_interrupt()
1762 * Disconnects the root hub, then reverses the effects of usb_add_hcd(),
1763 * invoking the HCD's stop() method.
1765 void usb_remove_hcd(struct usb_hcd *hcd)
1767 dev_info(hcd->self.controller, "remove, state %x\n", hcd->state);
1769 if (HC_IS_RUNNING (hcd->state))
1770 hcd->state = HC_STATE_QUIESCING;
1772 dev_dbg(hcd->self.controller, "roothub graceful disconnect\n");
1773 spin_lock_irq (&hcd_root_hub_lock);
1774 hcd->rh_registered = 0;
1775 spin_unlock_irq (&hcd_root_hub_lock);
1778 cancel_work_sync(&hcd->wakeup_work);
1781 sysfs_remove_group(&hcd->self.root_hub->dev.kobj, &usb_bus_attr_group);
1782 mutex_lock(&usb_bus_list_lock);
1783 usb_disconnect(&hcd->self.root_hub);
1784 mutex_unlock(&usb_bus_list_lock);
1786 hcd->driver->stop(hcd);
1787 hcd->state = HC_STATE_HALT;
1790 del_timer_sync(&hcd->rh_timer);
1793 free_irq(hcd->irq, hcd);
1794 usb_deregister_bus(&hcd->self);
1795 hcd_buffer_destroy(hcd);
1797 EXPORT_SYMBOL (usb_remove_hcd);
1800 usb_hcd_platform_shutdown(struct platform_device* dev)
1802 struct usb_hcd *hcd = platform_get_drvdata(dev);
1804 if (hcd->driver->shutdown)
1805 hcd->driver->shutdown(hcd);
1807 EXPORT_SYMBOL (usb_hcd_platform_shutdown);
1809 /*-------------------------------------------------------------------------*/
1811 #if defined(CONFIG_USB_MON)
1813 struct usb_mon_operations *mon_ops;
1816 * The registration is unlocked.
1817 * We do it this way because we do not want to lock in hot paths.
1819 * Notice that the code is minimally error-proof. Because usbmon needs
1820 * symbols from usbcore, usbcore gets referenced and cannot be unloaded first.
1823 int usb_mon_register (struct usb_mon_operations *ops)
1833 EXPORT_SYMBOL_GPL (usb_mon_register);
1835 void usb_mon_deregister (void)
1838 if (mon_ops == NULL) {
1839 printk(KERN_ERR "USB: monitor was not registered\n");
1845 EXPORT_SYMBOL_GPL (usb_mon_deregister);
1847 #endif /* CONFIG_USB_MON */