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)
798 mutex_lock(&usb_bus_list_lock);
799 busnum = find_next_zero_bit (busmap.busmap, USB_MAXBUS, 1);
800 if (busnum >= USB_MAXBUS) {
801 printk (KERN_ERR "%s: too many buses\n", usbcore_name);
802 goto error_find_busnum;
804 set_bit (busnum, busmap.busmap);
805 bus->busnum = busnum;
806 bus->class_dev = class_device_create(usb_host_class, NULL, MKDEV(0,0),
807 bus->controller, "usb_host%d",
809 result = PTR_ERR(bus->class_dev);
810 if (IS_ERR(bus->class_dev))
811 goto error_create_class_dev;
812 class_set_devdata(bus->class_dev, bus);
814 /* Add it to the local list of buses */
815 list_add (&bus->bus_list, &usb_bus_list);
816 mutex_unlock(&usb_bus_list_lock);
818 usb_notify_add_bus(bus);
820 dev_info (bus->controller, "new USB bus registered, assigned bus "
821 "number %d\n", bus->busnum);
824 error_create_class_dev:
825 clear_bit(busnum, busmap.busmap);
827 mutex_unlock(&usb_bus_list_lock);
832 * usb_deregister_bus - deregisters the USB host controller
833 * @bus: pointer to the bus to deregister
834 * Context: !in_interrupt()
836 * Recycles the bus number, and unlinks the controller from usbcore data
837 * structures so that it won't be seen by scanning the bus list.
839 static void usb_deregister_bus (struct usb_bus *bus)
841 dev_info (bus->controller, "USB bus %d deregistered\n", bus->busnum);
844 * NOTE: make sure that all the devices are removed by the
845 * controller code, as well as having it call this when cleaning
848 mutex_lock(&usb_bus_list_lock);
849 list_del (&bus->bus_list);
850 mutex_unlock(&usb_bus_list_lock);
852 usb_notify_remove_bus(bus);
854 clear_bit (bus->busnum, busmap.busmap);
856 class_device_unregister(bus->class_dev);
860 * register_root_hub - called by usb_add_hcd() to register a root hub
861 * @hcd: host controller for this root hub
863 * This function registers the root hub with the USB subsystem. It sets up
864 * the device properly in the device tree and then calls usb_new_device()
865 * to register the usb device. It also assigns the root hub's USB address
868 static int register_root_hub(struct usb_hcd *hcd)
870 struct device *parent_dev = hcd->self.controller;
871 struct usb_device *usb_dev = hcd->self.root_hub;
872 const int devnum = 1;
875 usb_dev->devnum = devnum;
876 usb_dev->bus->devnum_next = devnum + 1;
877 memset (&usb_dev->bus->devmap.devicemap, 0,
878 sizeof usb_dev->bus->devmap.devicemap);
879 set_bit (devnum, usb_dev->bus->devmap.devicemap);
880 usb_set_device_state(usb_dev, USB_STATE_ADDRESS);
882 mutex_lock(&usb_bus_list_lock);
884 usb_dev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
885 retval = usb_get_device_descriptor(usb_dev, USB_DT_DEVICE_SIZE);
886 if (retval != sizeof usb_dev->descriptor) {
887 mutex_unlock(&usb_bus_list_lock);
888 dev_dbg (parent_dev, "can't read %s device descriptor %d\n",
889 usb_dev->dev.bus_id, retval);
890 return (retval < 0) ? retval : -EMSGSIZE;
893 retval = usb_new_device (usb_dev);
895 dev_err (parent_dev, "can't register root hub for %s, %d\n",
896 usb_dev->dev.bus_id, retval);
898 mutex_unlock(&usb_bus_list_lock);
901 spin_lock_irq (&hcd_root_hub_lock);
902 hcd->rh_registered = 1;
903 spin_unlock_irq (&hcd_root_hub_lock);
905 /* Did the HC die before the root hub was registered? */
906 if (hcd->state == HC_STATE_HALT)
907 usb_hc_died (hcd); /* This time clean up */
913 void usb_enable_root_hub_irq (struct usb_bus *bus)
917 hcd = container_of (bus, struct usb_hcd, self);
918 if (hcd->driver->hub_irq_enable && hcd->state != HC_STATE_HALT)
919 hcd->driver->hub_irq_enable (hcd);
923 /*-------------------------------------------------------------------------*/
926 * usb_calc_bus_time - approximate periodic transaction time in nanoseconds
927 * @speed: from dev->speed; USB_SPEED_{LOW,FULL,HIGH}
928 * @is_input: true iff the transaction sends data to the host
929 * @isoc: true for isochronous transactions, false for interrupt ones
930 * @bytecount: how many bytes in the transaction.
932 * Returns approximate bus time in nanoseconds for a periodic transaction.
933 * See USB 2.0 spec section 5.11.3; only periodic transfers need to be
934 * scheduled in software, this function is only used for such scheduling.
936 long usb_calc_bus_time (int speed, int is_input, int isoc, int bytecount)
941 case USB_SPEED_LOW: /* INTR only */
943 tmp = (67667L * (31L + 10L * BitTime (bytecount))) / 1000L;
944 return (64060L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp);
946 tmp = (66700L * (31L + 10L * BitTime (bytecount))) / 1000L;
947 return (64107L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp);
949 case USB_SPEED_FULL: /* ISOC or INTR */
951 tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
952 return (((is_input) ? 7268L : 6265L) + BW_HOST_DELAY + tmp);
954 tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
955 return (9107L + BW_HOST_DELAY + tmp);
957 case USB_SPEED_HIGH: /* ISOC or INTR */
958 // FIXME adjust for input vs output
960 tmp = HS_NSECS_ISO (bytecount);
962 tmp = HS_NSECS (bytecount);
965 pr_debug ("%s: bogus device speed!\n", usbcore_name);
969 EXPORT_SYMBOL (usb_calc_bus_time);
972 /*-------------------------------------------------------------------------*/
975 * Generic HC operations.
978 /*-------------------------------------------------------------------------*/
980 static int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb)
985 spin_lock_irqsave(&hcd_urb_list_lock, flags);
987 /* Check that the URB isn't being killed */
988 if (unlikely(urb->reject)) {
993 if (unlikely(!urb->ep->enabled)) {
999 * Check the host controller's state and add the URB to the
1002 switch (hcd->state) {
1003 case HC_STATE_RUNNING:
1004 case HC_STATE_RESUMING:
1005 list_add_tail(&urb->urb_list, &urb->ep->urb_list);
1012 spin_unlock_irqrestore(&hcd_urb_list_lock, flags);
1016 static int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb,
1019 unsigned long flags;
1020 struct list_head *tmp;
1024 * we contend for urb->status with the hcd core,
1025 * which changes it while returning the urb.
1027 * Caller guaranteed that the urb pointer hasn't been freed, and
1028 * that it was submitted. But as a rule it can't know whether or
1029 * not it's already been unlinked ... so we respect the reversed
1030 * lock sequence needed for the usb_hcd_giveback_urb() code paths
1031 * (urb lock, then hcd_urb_list_lock) in case some other CPU is now
1034 spin_lock_irqsave(&urb->lock, flags);
1035 spin_lock(&hcd_urb_list_lock);
1037 /* insist the urb is still queued */
1038 list_for_each(tmp, &urb->ep->urb_list) {
1039 if (tmp == &urb->urb_list)
1042 if (tmp != &urb->urb_list) {
1047 /* Any status except -EINPROGRESS means something already started to
1048 * unlink this URB from the hardware. So there's no more work to do.
1050 if (urb->status != -EINPROGRESS) {
1054 urb->status = status;
1056 /* IRQ setup can easily be broken so that USB controllers
1057 * never get completion IRQs ... maybe even the ones we need to
1058 * finish unlinking the initial failed usb_set_address()
1059 * or device descriptor fetch.
1061 if (!test_bit(HCD_FLAG_SAW_IRQ, &hcd->flags) &&
1062 !is_root_hub(urb->dev)) {
1063 dev_warn(hcd->self.controller, "Unlink after no-IRQ? "
1064 "Controller is probably using the wrong IRQ.\n");
1065 set_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
1069 spin_unlock(&hcd_urb_list_lock);
1070 spin_unlock_irqrestore (&urb->lock, flags);
1074 static void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb)
1076 unsigned long flags;
1078 /* clear all state linking urb to this dev (and hcd) */
1079 spin_lock_irqsave(&hcd_urb_list_lock, flags);
1080 list_del_init(&urb->urb_list);
1081 spin_unlock_irqrestore(&hcd_urb_list_lock, flags);
1084 static void map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
1086 /* Map the URB's buffers for DMA access.
1087 * Lower level HCD code should use *_dma exclusively,
1088 * unless it uses pio or talks to another transport.
1090 if (hcd->self.uses_dma && !is_root_hub(urb->dev)) {
1091 if (usb_endpoint_xfer_control(&urb->ep->desc)
1092 && !(urb->transfer_flags & URB_NO_SETUP_DMA_MAP))
1093 urb->setup_dma = dma_map_single (
1094 hcd->self.controller,
1096 sizeof (struct usb_ctrlrequest),
1098 if (urb->transfer_buffer_length != 0
1099 && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP))
1100 urb->transfer_dma = dma_map_single (
1101 hcd->self.controller,
1102 urb->transfer_buffer,
1103 urb->transfer_buffer_length,
1110 static void unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
1112 if (hcd->self.uses_dma && !is_root_hub(urb->dev)) {
1113 if (usb_endpoint_xfer_control(&urb->ep->desc)
1114 && !(urb->transfer_flags & URB_NO_SETUP_DMA_MAP))
1115 dma_unmap_single(hcd->self.controller, urb->setup_dma,
1116 sizeof(struct usb_ctrlrequest),
1118 if (urb->transfer_buffer_length != 0
1119 && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP))
1120 dma_unmap_single(hcd->self.controller,
1122 urb->transfer_buffer_length,
1129 /*-------------------------------------------------------------------------*/
1131 /* may be called in any context with a valid urb->dev usecount
1132 * caller surrenders "ownership" of urb
1133 * expects usb_submit_urb() to have sanity checked and conditioned all
1136 int usb_hcd_submit_urb (struct urb *urb, gfp_t mem_flags)
1139 struct usb_hcd *hcd = bus_to_hcd(urb->dev->bus);
1141 /* increment urb's reference count as part of giving it to the HCD
1142 * (which will control it). HCD guarantees that it either returns
1143 * an error or calls giveback(), but not both.
1146 atomic_inc(&urb->use_count);
1147 usbmon_urb_submit(&hcd->self, urb);
1149 /* NOTE requirements on root-hub callers (usbfs and the hub
1150 * driver, for now): URBs' urb->transfer_buffer must be
1151 * valid and usb_buffer_{sync,unmap}() not be needed, since
1152 * they could clobber root hub response data. Also, control
1153 * URBs must be submitted in process context with interrupts
1156 status = usb_hcd_link_urb_to_ep(hcd, urb);
1158 map_urb_for_dma(hcd, urb);
1159 if (is_root_hub(urb->dev))
1160 status = rh_urb_enqueue(hcd, urb);
1162 status = hcd->driver->urb_enqueue(hcd, urb->ep, urb,
1166 if (unlikely(status)) {
1167 usbmon_urb_submit_error(&hcd->self, urb, status);
1168 unmap_urb_for_dma(hcd, urb);
1169 usb_hcd_unlink_urb_from_ep(hcd, urb);
1170 INIT_LIST_HEAD(&urb->urb_list);
1171 atomic_dec(&urb->use_count);
1173 wake_up(&usb_kill_urb_queue);
1179 /*-------------------------------------------------------------------------*/
1181 /* this makes the hcd giveback() the urb more quickly, by kicking it
1182 * off hardware queues (which may take a while) and returning it as
1183 * soon as practical. we've already set up the urb's return status,
1184 * but we can't know if the callback completed already.
1187 unlink1 (struct usb_hcd *hcd, struct urb *urb)
1191 if (is_root_hub(urb->dev))
1192 value = usb_rh_urb_dequeue (hcd, urb);
1195 /* The only reason an HCD might fail this call is if
1196 * it has not yet fully queued the urb to begin with.
1197 * Such failures should be harmless. */
1198 value = hcd->driver->urb_dequeue (hcd, urb);
1202 dev_dbg (hcd->self.controller, "dequeue %p --> %d\n",
1208 * called in any context
1210 * caller guarantees urb won't be recycled till both unlink()
1211 * and the urb's completion function return
1213 int usb_hcd_unlink_urb (struct urb *urb, int status)
1215 struct usb_hcd *hcd;
1218 hcd = bus_to_hcd(urb->dev->bus);
1220 retval = usb_hcd_check_unlink_urb(hcd, urb, status);
1222 retval = unlink1(hcd, urb);
1225 retval = -EINPROGRESS;
1226 else if (retval != -EIDRM)
1227 dev_dbg(&urb->dev->dev, "hcd_unlink_urb %p fail %d\n",
1232 /*-------------------------------------------------------------------------*/
1235 * usb_hcd_giveback_urb - return URB from HCD to device driver
1236 * @hcd: host controller returning the URB
1237 * @urb: urb being returned to the USB device driver.
1238 * Context: in_interrupt()
1240 * This hands the URB from HCD to its USB device driver, using its
1241 * completion function. The HCD has freed all per-urb resources
1242 * (and is done using urb->hcpriv). It also released all HCD locks;
1243 * the device driver won't cause problems if it frees, modifies,
1244 * or resubmits this URB.
1246 void usb_hcd_giveback_urb (struct usb_hcd *hcd, struct urb *urb)
1248 usb_hcd_unlink_urb_from_ep(hcd, urb);
1249 unmap_urb_for_dma(hcd, urb);
1250 usbmon_urb_complete (&hcd->self, urb);
1251 usb_unanchor_urb(urb);
1253 /* pass ownership to the completion handler */
1254 urb->complete (urb);
1255 atomic_dec (&urb->use_count);
1256 if (unlikely (urb->reject))
1257 wake_up (&usb_kill_urb_queue);
1260 EXPORT_SYMBOL (usb_hcd_giveback_urb);
1262 /*-------------------------------------------------------------------------*/
1264 /* disables the endpoint: cancels any pending urbs, then synchronizes with
1265 * the hcd to make sure all endpoint state is gone from hardware, and then
1266 * waits until the endpoint's queue is completely drained. use for
1267 * set_configuration, set_interface, driver removal, physical disconnect.
1269 * example: a qh stored in ep->hcpriv, holding state related to endpoint
1270 * type, maxpacket size, toggle, halt status, and scheduling.
1272 void usb_hcd_endpoint_disable (struct usb_device *udev,
1273 struct usb_host_endpoint *ep)
1275 struct usb_hcd *hcd;
1279 hcd = bus_to_hcd(udev->bus);
1281 /* ep is already gone from udev->ep_{in,out}[]; no more submits */
1283 spin_lock_irq(&hcd_urb_list_lock);
1284 list_for_each_entry (urb, &ep->urb_list, urb_list) {
1288 /* the urb may already have been unlinked */
1289 if (urb->status != -EINPROGRESS)
1292 is_in = usb_urb_dir_in(urb);
1293 spin_unlock(&hcd_urb_list_lock);
1295 spin_lock (&urb->lock);
1297 if (tmp == -EINPROGRESS)
1298 urb->status = -ESHUTDOWN;
1299 spin_unlock (&urb->lock);
1301 /* kick hcd unless it's already returning this */
1302 if (tmp == -EINPROGRESS) {
1304 dev_dbg (hcd->self.controller,
1305 "shutdown urb %p ep%d%s%s\n",
1306 urb, usb_endpoint_num(&ep->desc),
1307 is_in ? "in" : "out",
1310 switch (usb_endpoint_type(&ep->desc)) {
1311 case USB_ENDPOINT_XFER_CONTROL:
1313 case USB_ENDPOINT_XFER_BULK:
1315 case USB_ENDPOINT_XFER_INT:
1325 /* list contents may have changed */
1328 spin_unlock_irq(&hcd_urb_list_lock);
1330 /* synchronize with the hardware, so old configuration state
1331 * clears out immediately (and will be freed).
1333 if (hcd->driver->endpoint_disable)
1334 hcd->driver->endpoint_disable (hcd, ep);
1336 /* Wait until the endpoint queue is completely empty. Most HCDs
1337 * will have done this already in their endpoint_disable method,
1338 * but some might not. And there could be root-hub control URBs
1339 * still pending since they aren't affected by the HCDs'
1340 * endpoint_disable methods.
1342 while (!list_empty (&ep->urb_list)) {
1343 spin_lock_irq(&hcd_urb_list_lock);
1345 /* The list may have changed while we acquired the spinlock */
1347 if (!list_empty (&ep->urb_list)) {
1348 urb = list_entry (ep->urb_list.prev, struct urb,
1352 spin_unlock_irq(&hcd_urb_list_lock);
1361 /*-------------------------------------------------------------------------*/
1363 /* called in any context */
1364 int usb_hcd_get_frame_number (struct usb_device *udev)
1366 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1368 if (!HC_IS_RUNNING (hcd->state))
1370 return hcd->driver->get_frame_number (hcd);
1373 /*-------------------------------------------------------------------------*/
1377 int hcd_bus_suspend(struct usb_device *rhdev)
1379 struct usb_hcd *hcd = container_of(rhdev->bus, struct usb_hcd, self);
1381 int old_state = hcd->state;
1383 dev_dbg(&rhdev->dev, "bus %s%s\n",
1384 rhdev->auto_pm ? "auto-" : "", "suspend");
1385 if (!hcd->driver->bus_suspend) {
1388 hcd->state = HC_STATE_QUIESCING;
1389 status = hcd->driver->bus_suspend(hcd);
1392 usb_set_device_state(rhdev, USB_STATE_SUSPENDED);
1393 hcd->state = HC_STATE_SUSPENDED;
1395 hcd->state = old_state;
1396 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
1402 int hcd_bus_resume(struct usb_device *rhdev)
1404 struct usb_hcd *hcd = container_of(rhdev->bus, struct usb_hcd, self);
1406 int old_state = hcd->state;
1408 dev_dbg(&rhdev->dev, "usb %s%s\n",
1409 rhdev->auto_pm ? "auto-" : "", "resume");
1410 if (!hcd->driver->bus_resume)
1412 if (hcd->state == HC_STATE_RUNNING)
1415 hcd->state = HC_STATE_RESUMING;
1416 status = hcd->driver->bus_resume(hcd);
1418 /* TRSMRCY = 10 msec */
1420 usb_set_device_state(rhdev, rhdev->actconfig
1421 ? USB_STATE_CONFIGURED
1422 : USB_STATE_ADDRESS);
1423 hcd->state = HC_STATE_RUNNING;
1425 hcd->state = old_state;
1426 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
1428 if (status != -ESHUTDOWN)
1434 /* Workqueue routine for root-hub remote wakeup */
1435 static void hcd_resume_work(struct work_struct *work)
1437 struct usb_hcd *hcd = container_of(work, struct usb_hcd, wakeup_work);
1438 struct usb_device *udev = hcd->self.root_hub;
1440 usb_lock_device(udev);
1441 usb_mark_last_busy(udev);
1442 usb_external_resume_device(udev);
1443 usb_unlock_device(udev);
1447 * usb_hcd_resume_root_hub - called by HCD to resume its root hub
1448 * @hcd: host controller for this root hub
1450 * The USB host controller calls this function when its root hub is
1451 * suspended (with the remote wakeup feature enabled) and a remote
1452 * wakeup request is received. The routine submits a workqueue request
1453 * to resume the root hub (that is, manage its downstream ports again).
1455 void usb_hcd_resume_root_hub (struct usb_hcd *hcd)
1457 unsigned long flags;
1459 spin_lock_irqsave (&hcd_root_hub_lock, flags);
1460 if (hcd->rh_registered)
1461 queue_work(ksuspend_usb_wq, &hcd->wakeup_work);
1462 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
1464 EXPORT_SYMBOL_GPL(usb_hcd_resume_root_hub);
1468 /*-------------------------------------------------------------------------*/
1470 #ifdef CONFIG_USB_OTG
1473 * usb_bus_start_enum - start immediate enumeration (for OTG)
1474 * @bus: the bus (must use hcd framework)
1475 * @port_num: 1-based number of port; usually bus->otg_port
1476 * Context: in_interrupt()
1478 * Starts enumeration, with an immediate reset followed later by
1479 * khubd identifying and possibly configuring the device.
1480 * This is needed by OTG controller drivers, where it helps meet
1481 * HNP protocol timing requirements for starting a port reset.
1483 int usb_bus_start_enum(struct usb_bus *bus, unsigned port_num)
1485 struct usb_hcd *hcd;
1486 int status = -EOPNOTSUPP;
1488 /* NOTE: since HNP can't start by grabbing the bus's address0_sem,
1489 * boards with root hubs hooked up to internal devices (instead of
1490 * just the OTG port) may need more attention to resetting...
1492 hcd = container_of (bus, struct usb_hcd, self);
1493 if (port_num && hcd->driver->start_port_reset)
1494 status = hcd->driver->start_port_reset(hcd, port_num);
1496 /* run khubd shortly after (first) root port reset finishes;
1497 * it may issue others, until at least 50 msecs have passed.
1500 mod_timer(&hcd->rh_timer, jiffies + msecs_to_jiffies(10));
1503 EXPORT_SYMBOL (usb_bus_start_enum);
1507 /*-------------------------------------------------------------------------*/
1510 * usb_hcd_irq - hook IRQs to HCD framework (bus glue)
1511 * @irq: the IRQ being raised
1512 * @__hcd: pointer to the HCD whose IRQ is being signaled
1513 * @r: saved hardware registers
1515 * If the controller isn't HALTed, calls the driver's irq handler.
1516 * Checks whether the controller is now dead.
1518 irqreturn_t usb_hcd_irq (int irq, void *__hcd)
1520 struct usb_hcd *hcd = __hcd;
1521 int start = hcd->state;
1523 if (unlikely(start == HC_STATE_HALT ||
1524 !test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags)))
1526 if (hcd->driver->irq (hcd) == IRQ_NONE)
1529 set_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
1531 if (unlikely(hcd->state == HC_STATE_HALT))
1536 /*-------------------------------------------------------------------------*/
1539 * usb_hc_died - report abnormal shutdown of a host controller (bus glue)
1540 * @hcd: pointer to the HCD representing the controller
1542 * This is called by bus glue to report a USB host controller that died
1543 * while operations may still have been pending. It's called automatically
1544 * by the PCI glue, so only glue for non-PCI busses should need to call it.
1546 void usb_hc_died (struct usb_hcd *hcd)
1548 unsigned long flags;
1550 dev_err (hcd->self.controller, "HC died; cleaning up\n");
1552 spin_lock_irqsave (&hcd_root_hub_lock, flags);
1553 if (hcd->rh_registered) {
1556 /* make khubd clean up old urbs and devices */
1557 usb_set_device_state (hcd->self.root_hub,
1558 USB_STATE_NOTATTACHED);
1559 usb_kick_khubd (hcd->self.root_hub);
1561 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
1563 EXPORT_SYMBOL_GPL (usb_hc_died);
1565 /*-------------------------------------------------------------------------*/
1568 * usb_create_hcd - create and initialize an HCD structure
1569 * @driver: HC driver that will use this hcd
1570 * @dev: device for this HC, stored in hcd->self.controller
1571 * @bus_name: value to store in hcd->self.bus_name
1572 * Context: !in_interrupt()
1574 * Allocate a struct usb_hcd, with extra space at the end for the
1575 * HC driver's private data. Initialize the generic members of the
1578 * If memory is unavailable, returns NULL.
1580 struct usb_hcd *usb_create_hcd (const struct hc_driver *driver,
1581 struct device *dev, char *bus_name)
1583 struct usb_hcd *hcd;
1585 hcd = kzalloc(sizeof(*hcd) + driver->hcd_priv_size, GFP_KERNEL);
1587 dev_dbg (dev, "hcd alloc failed\n");
1590 dev_set_drvdata(dev, hcd);
1591 kref_init(&hcd->kref);
1593 usb_bus_init(&hcd->self);
1594 hcd->self.controller = dev;
1595 hcd->self.bus_name = bus_name;
1596 hcd->self.uses_dma = (dev->dma_mask != NULL);
1598 init_timer(&hcd->rh_timer);
1599 hcd->rh_timer.function = rh_timer_func;
1600 hcd->rh_timer.data = (unsigned long) hcd;
1602 INIT_WORK(&hcd->wakeup_work, hcd_resume_work);
1605 hcd->driver = driver;
1606 hcd->product_desc = (driver->product_desc) ? driver->product_desc :
1607 "USB Host Controller";
1610 EXPORT_SYMBOL (usb_create_hcd);
1612 static void hcd_release (struct kref *kref)
1614 struct usb_hcd *hcd = container_of (kref, struct usb_hcd, kref);
1619 struct usb_hcd *usb_get_hcd (struct usb_hcd *hcd)
1622 kref_get (&hcd->kref);
1625 EXPORT_SYMBOL (usb_get_hcd);
1627 void usb_put_hcd (struct usb_hcd *hcd)
1630 kref_put (&hcd->kref, hcd_release);
1632 EXPORT_SYMBOL (usb_put_hcd);
1635 * usb_add_hcd - finish generic HCD structure initialization and register
1636 * @hcd: the usb_hcd structure to initialize
1637 * @irqnum: Interrupt line to allocate
1638 * @irqflags: Interrupt type flags
1640 * Finish the remaining parts of generic HCD initialization: allocate the
1641 * buffers of consistent memory, register the bus, request the IRQ line,
1642 * and call the driver's reset() and start() routines.
1644 int usb_add_hcd(struct usb_hcd *hcd,
1645 unsigned int irqnum, unsigned long irqflags)
1648 struct usb_device *rhdev;
1650 dev_info(hcd->self.controller, "%s\n", hcd->product_desc);
1652 hcd->authorized_default = hcd->wireless? 0 : 1;
1653 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1655 /* HC is in reset state, but accessible. Now do the one-time init,
1656 * bottom up so that hcds can customize the root hubs before khubd
1657 * starts talking to them. (Note, bus id is assigned early too.)
1659 if ((retval = hcd_buffer_create(hcd)) != 0) {
1660 dev_dbg(hcd->self.controller, "pool alloc failed\n");
1664 if ((retval = usb_register_bus(&hcd->self)) < 0)
1665 goto err_register_bus;
1667 if ((rhdev = usb_alloc_dev(NULL, &hcd->self, 0)) == NULL) {
1668 dev_err(hcd->self.controller, "unable to allocate root hub\n");
1670 goto err_allocate_root_hub;
1672 rhdev->speed = (hcd->driver->flags & HCD_USB2) ? USB_SPEED_HIGH :
1674 hcd->self.root_hub = rhdev;
1676 /* wakeup flag init defaults to "everything works" for root hubs,
1677 * but drivers can override it in reset() if needed, along with
1678 * recording the overall controller's system wakeup capability.
1680 device_init_wakeup(&rhdev->dev, 1);
1682 /* "reset" is misnamed; its role is now one-time init. the controller
1683 * should already have been reset (and boot firmware kicked off etc).
1685 if (hcd->driver->reset && (retval = hcd->driver->reset(hcd)) < 0) {
1686 dev_err(hcd->self.controller, "can't setup\n");
1687 goto err_hcd_driver_setup;
1690 /* NOTE: root hub and controller capabilities may not be the same */
1691 if (device_can_wakeup(hcd->self.controller)
1692 && device_can_wakeup(&hcd->self.root_hub->dev))
1693 dev_dbg(hcd->self.controller, "supports USB remote wakeup\n");
1695 /* enable irqs just before we start the controller */
1696 if (hcd->driver->irq) {
1697 snprintf(hcd->irq_descr, sizeof(hcd->irq_descr), "%s:usb%d",
1698 hcd->driver->description, hcd->self.busnum);
1699 if ((retval = request_irq(irqnum, &usb_hcd_irq, irqflags,
1700 hcd->irq_descr, hcd)) != 0) {
1701 dev_err(hcd->self.controller,
1702 "request interrupt %d failed\n", irqnum);
1703 goto err_request_irq;
1706 dev_info(hcd->self.controller, "irq %d, %s 0x%08llx\n", irqnum,
1707 (hcd->driver->flags & HCD_MEMORY) ?
1708 "io mem" : "io base",
1709 (unsigned long long)hcd->rsrc_start);
1712 if (hcd->rsrc_start)
1713 dev_info(hcd->self.controller, "%s 0x%08llx\n",
1714 (hcd->driver->flags & HCD_MEMORY) ?
1715 "io mem" : "io base",
1716 (unsigned long long)hcd->rsrc_start);
1719 if ((retval = hcd->driver->start(hcd)) < 0) {
1720 dev_err(hcd->self.controller, "startup error %d\n", retval);
1721 goto err_hcd_driver_start;
1724 /* starting here, usbcore will pay attention to this root hub */
1725 rhdev->bus_mA = min(500u, hcd->power_budget);
1726 if ((retval = register_root_hub(hcd)) != 0)
1727 goto err_register_root_hub;
1729 retval = sysfs_create_group(&rhdev->dev.kobj, &usb_bus_attr_group);
1731 printk(KERN_ERR "Cannot register USB bus sysfs attributes: %d\n",
1733 goto error_create_attr_group;
1735 if (hcd->uses_new_polling && hcd->poll_rh)
1736 usb_hcd_poll_rh_status(hcd);
1739 error_create_attr_group:
1740 mutex_lock(&usb_bus_list_lock);
1741 usb_disconnect(&hcd->self.root_hub);
1742 mutex_unlock(&usb_bus_list_lock);
1743 err_register_root_hub:
1744 hcd->driver->stop(hcd);
1745 err_hcd_driver_start:
1747 free_irq(irqnum, hcd);
1749 err_hcd_driver_setup:
1750 hcd->self.root_hub = NULL;
1752 err_allocate_root_hub:
1753 usb_deregister_bus(&hcd->self);
1755 hcd_buffer_destroy(hcd);
1758 EXPORT_SYMBOL (usb_add_hcd);
1761 * usb_remove_hcd - shutdown processing for generic HCDs
1762 * @hcd: the usb_hcd structure to remove
1763 * Context: !in_interrupt()
1765 * Disconnects the root hub, then reverses the effects of usb_add_hcd(),
1766 * invoking the HCD's stop() method.
1768 void usb_remove_hcd(struct usb_hcd *hcd)
1770 dev_info(hcd->self.controller, "remove, state %x\n", hcd->state);
1772 if (HC_IS_RUNNING (hcd->state))
1773 hcd->state = HC_STATE_QUIESCING;
1775 dev_dbg(hcd->self.controller, "roothub graceful disconnect\n");
1776 spin_lock_irq (&hcd_root_hub_lock);
1777 hcd->rh_registered = 0;
1778 spin_unlock_irq (&hcd_root_hub_lock);
1781 cancel_work_sync(&hcd->wakeup_work);
1784 sysfs_remove_group(&hcd->self.root_hub->dev.kobj, &usb_bus_attr_group);
1785 mutex_lock(&usb_bus_list_lock);
1786 usb_disconnect(&hcd->self.root_hub);
1787 mutex_unlock(&usb_bus_list_lock);
1789 hcd->driver->stop(hcd);
1790 hcd->state = HC_STATE_HALT;
1793 del_timer_sync(&hcd->rh_timer);
1796 free_irq(hcd->irq, hcd);
1797 usb_deregister_bus(&hcd->self);
1798 hcd_buffer_destroy(hcd);
1800 EXPORT_SYMBOL (usb_remove_hcd);
1803 usb_hcd_platform_shutdown(struct platform_device* dev)
1805 struct usb_hcd *hcd = platform_get_drvdata(dev);
1807 if (hcd->driver->shutdown)
1808 hcd->driver->shutdown(hcd);
1810 EXPORT_SYMBOL (usb_hcd_platform_shutdown);
1812 /*-------------------------------------------------------------------------*/
1814 #if defined(CONFIG_USB_MON)
1816 struct usb_mon_operations *mon_ops;
1819 * The registration is unlocked.
1820 * We do it this way because we do not want to lock in hot paths.
1822 * Notice that the code is minimally error-proof. Because usbmon needs
1823 * symbols from usbcore, usbcore gets referenced and cannot be unloaded first.
1826 int usb_mon_register (struct usb_mon_operations *ops)
1836 EXPORT_SYMBOL_GPL (usb_mon_register);
1838 void usb_mon_deregister (void)
1841 if (mon_ops == NULL) {
1842 printk(KERN_ERR "USB: monitor was not registered\n");
1848 EXPORT_SYMBOL_GPL (usb_mon_deregister);
1850 #endif /* CONFIG_USB_MON */