1 // SPDX-License-Identifier: GPL-2.0+
3 * (C) Copyright Linus Torvalds 1999
4 * (C) Copyright Johannes Erdfelt 1999-2001
5 * (C) Copyright Andreas Gal 1999
6 * (C) Copyright Gregory P. Smith 1999
7 * (C) Copyright Deti Fliegl 1999
8 * (C) Copyright Randy Dunlap 2000
9 * (C) Copyright David Brownell 2000-2002
12 #include <linux/bcd.h>
13 #include <linux/module.h>
14 #include <linux/version.h>
15 #include <linux/kernel.h>
16 #include <linux/sched/task_stack.h>
17 #include <linux/slab.h>
18 #include <linux/completion.h>
19 #include <linux/utsname.h>
22 #include <linux/device.h>
23 #include <linux/dma-mapping.h>
24 #include <linux/mutex.h>
26 #include <asm/byteorder.h>
27 #include <asm/unaligned.h>
28 #include <linux/platform_device.h>
29 #include <linux/workqueue.h>
30 #include <linux/pm_runtime.h>
31 #include <linux/types.h>
32 #include <linux/genalloc.h>
34 #include <linux/kcov.h>
36 #include <linux/phy/phy.h>
37 #include <linux/usb.h>
38 #include <linux/usb/hcd.h>
39 #include <linux/usb/otg.h>
45 /*-------------------------------------------------------------------------*/
48 * USB Host Controller Driver framework
50 * Plugs into usbcore (usb_bus) and lets HCDs share code, minimizing
51 * HCD-specific behaviors/bugs.
53 * This does error checks, tracks devices and urbs, and delegates to a
54 * "hc_driver" only for code (and data) that really needs to know about
55 * hardware differences. That includes root hub registers, i/o queues,
56 * and so on ... but as little else as possible.
58 * Shared code includes most of the "root hub" code (these are emulated,
59 * though each HC's hardware works differently) and PCI glue, plus request
60 * tracking overhead. The HCD code should only block on spinlocks or on
61 * hardware handshaking; blocking on software events (such as other kernel
62 * threads releasing resources, or completing actions) is all generic.
64 * Happens the USB 2.0 spec says this would be invisible inside the "USBD",
65 * and includes mostly a "HCDI" (HCD Interface) along with some APIs used
66 * only by the hub driver ... and that neither should be seen or used by
67 * usb client device drivers.
69 * Contributors of ideas or unattributed patches include: David Brownell,
70 * Roman Weissgaerber, Rory Bolt, Greg Kroah-Hartman, ...
73 * 2002-02-21 Pull in most of the usb_bus support from usb.c; some
74 * associated cleanup. "usb_hcd" still != "usb_bus".
75 * 2001-12-12 Initial patch version for Linux 2.5.1 kernel.
78 /*-------------------------------------------------------------------------*/
80 /* Keep track of which host controller drivers are loaded */
81 unsigned long usb_hcds_loaded;
82 EXPORT_SYMBOL_GPL(usb_hcds_loaded);
84 /* host controllers we manage */
85 DEFINE_IDR (usb_bus_idr);
86 EXPORT_SYMBOL_GPL (usb_bus_idr);
88 /* used when allocating bus numbers */
91 /* used when updating list of hcds */
92 DEFINE_MUTEX(usb_bus_idr_lock); /* exported only for usbfs */
93 EXPORT_SYMBOL_GPL (usb_bus_idr_lock);
95 /* used for controlling access to virtual root hubs */
96 static DEFINE_SPINLOCK(hcd_root_hub_lock);
98 /* used when updating an endpoint's URB list */
99 static DEFINE_SPINLOCK(hcd_urb_list_lock);
101 /* used to protect against unlinking URBs after the device is gone */
102 static DEFINE_SPINLOCK(hcd_urb_unlink_lock);
104 /* wait queue for synchronous unlinks */
105 DECLARE_WAIT_QUEUE_HEAD(usb_kill_urb_queue);
107 /*-------------------------------------------------------------------------*/
110 * Sharable chunks of root hub code.
113 /*-------------------------------------------------------------------------*/
114 #define KERNEL_REL bin2bcd(LINUX_VERSION_MAJOR)
115 #define KERNEL_VER bin2bcd(LINUX_VERSION_PATCHLEVEL)
117 /* usb 3.1 root hub device descriptor */
118 static const u8 usb31_rh_dev_descriptor[18] = {
119 0x12, /* __u8 bLength; */
120 USB_DT_DEVICE, /* __u8 bDescriptorType; Device */
121 0x10, 0x03, /* __le16 bcdUSB; v3.1 */
123 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
124 0x00, /* __u8 bDeviceSubClass; */
125 0x03, /* __u8 bDeviceProtocol; USB 3 hub */
126 0x09, /* __u8 bMaxPacketSize0; 2^9 = 512 Bytes */
128 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation 0x1d6b */
129 0x03, 0x00, /* __le16 idProduct; device 0x0003 */
130 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
132 0x03, /* __u8 iManufacturer; */
133 0x02, /* __u8 iProduct; */
134 0x01, /* __u8 iSerialNumber; */
135 0x01 /* __u8 bNumConfigurations; */
138 /* usb 3.0 root hub device descriptor */
139 static const u8 usb3_rh_dev_descriptor[18] = {
140 0x12, /* __u8 bLength; */
141 USB_DT_DEVICE, /* __u8 bDescriptorType; Device */
142 0x00, 0x03, /* __le16 bcdUSB; v3.0 */
144 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
145 0x00, /* __u8 bDeviceSubClass; */
146 0x03, /* __u8 bDeviceProtocol; USB 3.0 hub */
147 0x09, /* __u8 bMaxPacketSize0; 2^9 = 512 Bytes */
149 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation 0x1d6b */
150 0x03, 0x00, /* __le16 idProduct; device 0x0003 */
151 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
153 0x03, /* __u8 iManufacturer; */
154 0x02, /* __u8 iProduct; */
155 0x01, /* __u8 iSerialNumber; */
156 0x01 /* __u8 bNumConfigurations; */
159 /* usb 2.0 root hub device descriptor */
160 static const u8 usb2_rh_dev_descriptor[18] = {
161 0x12, /* __u8 bLength; */
162 USB_DT_DEVICE, /* __u8 bDescriptorType; Device */
163 0x00, 0x02, /* __le16 bcdUSB; v2.0 */
165 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
166 0x00, /* __u8 bDeviceSubClass; */
167 0x00, /* __u8 bDeviceProtocol; [ usb 2.0 no TT ] */
168 0x40, /* __u8 bMaxPacketSize0; 64 Bytes */
170 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation 0x1d6b */
171 0x02, 0x00, /* __le16 idProduct; device 0x0002 */
172 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
174 0x03, /* __u8 iManufacturer; */
175 0x02, /* __u8 iProduct; */
176 0x01, /* __u8 iSerialNumber; */
177 0x01 /* __u8 bNumConfigurations; */
180 /* no usb 2.0 root hub "device qualifier" descriptor: one speed only */
182 /* usb 1.1 root hub device descriptor */
183 static const u8 usb11_rh_dev_descriptor[18] = {
184 0x12, /* __u8 bLength; */
185 USB_DT_DEVICE, /* __u8 bDescriptorType; Device */
186 0x10, 0x01, /* __le16 bcdUSB; v1.1 */
188 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
189 0x00, /* __u8 bDeviceSubClass; */
190 0x00, /* __u8 bDeviceProtocol; [ low/full speeds only ] */
191 0x40, /* __u8 bMaxPacketSize0; 64 Bytes */
193 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation 0x1d6b */
194 0x01, 0x00, /* __le16 idProduct; device 0x0001 */
195 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
197 0x03, /* __u8 iManufacturer; */
198 0x02, /* __u8 iProduct; */
199 0x01, /* __u8 iSerialNumber; */
200 0x01 /* __u8 bNumConfigurations; */
204 /*-------------------------------------------------------------------------*/
206 /* Configuration descriptors for our root hubs */
208 static const u8 fs_rh_config_descriptor[] = {
210 /* one configuration */
211 0x09, /* __u8 bLength; */
212 USB_DT_CONFIG, /* __u8 bDescriptorType; Configuration */
213 0x19, 0x00, /* __le16 wTotalLength; */
214 0x01, /* __u8 bNumInterfaces; (1) */
215 0x01, /* __u8 bConfigurationValue; */
216 0x00, /* __u8 iConfiguration; */
217 0xc0, /* __u8 bmAttributes;
222 0x00, /* __u8 MaxPower; */
225 * USB 2.0, single TT organization (mandatory):
226 * one interface, protocol 0
228 * USB 2.0, multiple TT organization (optional):
229 * two interfaces, protocols 1 (like single TT)
230 * and 2 (multiple TT mode) ... config is
236 0x09, /* __u8 if_bLength; */
237 USB_DT_INTERFACE, /* __u8 if_bDescriptorType; Interface */
238 0x00, /* __u8 if_bInterfaceNumber; */
239 0x00, /* __u8 if_bAlternateSetting; */
240 0x01, /* __u8 if_bNumEndpoints; */
241 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
242 0x00, /* __u8 if_bInterfaceSubClass; */
243 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
244 0x00, /* __u8 if_iInterface; */
246 /* one endpoint (status change endpoint) */
247 0x07, /* __u8 ep_bLength; */
248 USB_DT_ENDPOINT, /* __u8 ep_bDescriptorType; Endpoint */
249 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
250 0x03, /* __u8 ep_bmAttributes; Interrupt */
251 0x02, 0x00, /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8) */
252 0xff /* __u8 ep_bInterval; (255ms -- usb 2.0 spec) */
255 static const u8 hs_rh_config_descriptor[] = {
257 /* one configuration */
258 0x09, /* __u8 bLength; */
259 USB_DT_CONFIG, /* __u8 bDescriptorType; Configuration */
260 0x19, 0x00, /* __le16 wTotalLength; */
261 0x01, /* __u8 bNumInterfaces; (1) */
262 0x01, /* __u8 bConfigurationValue; */
263 0x00, /* __u8 iConfiguration; */
264 0xc0, /* __u8 bmAttributes;
269 0x00, /* __u8 MaxPower; */
272 * USB 2.0, single TT organization (mandatory):
273 * one interface, protocol 0
275 * USB 2.0, multiple TT organization (optional):
276 * two interfaces, protocols 1 (like single TT)
277 * and 2 (multiple TT mode) ... config is
283 0x09, /* __u8 if_bLength; */
284 USB_DT_INTERFACE, /* __u8 if_bDescriptorType; Interface */
285 0x00, /* __u8 if_bInterfaceNumber; */
286 0x00, /* __u8 if_bAlternateSetting; */
287 0x01, /* __u8 if_bNumEndpoints; */
288 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
289 0x00, /* __u8 if_bInterfaceSubClass; */
290 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
291 0x00, /* __u8 if_iInterface; */
293 /* one endpoint (status change endpoint) */
294 0x07, /* __u8 ep_bLength; */
295 USB_DT_ENDPOINT, /* __u8 ep_bDescriptorType; Endpoint */
296 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
297 0x03, /* __u8 ep_bmAttributes; Interrupt */
298 /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8)
299 * see hub.c:hub_configure() for details. */
300 (USB_MAXCHILDREN + 1 + 7) / 8, 0x00,
301 0x0c /* __u8 ep_bInterval; (256ms -- usb 2.0 spec) */
304 static const u8 ss_rh_config_descriptor[] = {
305 /* one configuration */
306 0x09, /* __u8 bLength; */
307 USB_DT_CONFIG, /* __u8 bDescriptorType; Configuration */
308 0x1f, 0x00, /* __le16 wTotalLength; */
309 0x01, /* __u8 bNumInterfaces; (1) */
310 0x01, /* __u8 bConfigurationValue; */
311 0x00, /* __u8 iConfiguration; */
312 0xc0, /* __u8 bmAttributes;
317 0x00, /* __u8 MaxPower; */
320 0x09, /* __u8 if_bLength; */
321 USB_DT_INTERFACE, /* __u8 if_bDescriptorType; Interface */
322 0x00, /* __u8 if_bInterfaceNumber; */
323 0x00, /* __u8 if_bAlternateSetting; */
324 0x01, /* __u8 if_bNumEndpoints; */
325 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
326 0x00, /* __u8 if_bInterfaceSubClass; */
327 0x00, /* __u8 if_bInterfaceProtocol; */
328 0x00, /* __u8 if_iInterface; */
330 /* one endpoint (status change endpoint) */
331 0x07, /* __u8 ep_bLength; */
332 USB_DT_ENDPOINT, /* __u8 ep_bDescriptorType; Endpoint */
333 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
334 0x03, /* __u8 ep_bmAttributes; Interrupt */
335 /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8)
336 * see hub.c:hub_configure() for details. */
337 (USB_MAXCHILDREN + 1 + 7) / 8, 0x00,
338 0x0c, /* __u8 ep_bInterval; (256ms -- usb 2.0 spec) */
340 /* one SuperSpeed endpoint companion descriptor */
341 0x06, /* __u8 ss_bLength */
342 USB_DT_SS_ENDPOINT_COMP, /* __u8 ss_bDescriptorType; SuperSpeed EP */
344 0x00, /* __u8 ss_bMaxBurst; allows 1 TX between ACKs */
345 0x00, /* __u8 ss_bmAttributes; 1 packet per service interval */
346 0x02, 0x00 /* __le16 ss_wBytesPerInterval; 15 bits for max 15 ports */
349 /* authorized_default behaviour:
350 * -1 is authorized for all devices (leftover from wireless USB)
351 * 0 is unauthorized for all devices
352 * 1 is authorized for all devices
353 * 2 is authorized for internal devices
355 #define USB_AUTHORIZE_WIRED -1
356 #define USB_AUTHORIZE_NONE 0
357 #define USB_AUTHORIZE_ALL 1
358 #define USB_AUTHORIZE_INTERNAL 2
360 static int authorized_default = USB_AUTHORIZE_WIRED;
361 module_param(authorized_default, int, S_IRUGO|S_IWUSR);
362 MODULE_PARM_DESC(authorized_default,
363 "Default USB device authorization: 0 is not authorized, 1 is "
364 "authorized, 2 is authorized for internal devices, -1 is "
365 "authorized (default, same as 1)");
366 /*-------------------------------------------------------------------------*/
369 * ascii2desc() - Helper routine for producing UTF-16LE string descriptors
370 * @s: Null-terminated ASCII (actually ISO-8859-1) string
371 * @buf: Buffer for USB string descriptor (header + UTF-16LE)
372 * @len: Length (in bytes; may be odd) of descriptor buffer.
374 * Return: The number of bytes filled in: 2 + 2*strlen(s) or @len,
378 * USB String descriptors can contain at most 126 characters; input
379 * strings longer than that are truncated.
382 ascii2desc(char const *s, u8 *buf, unsigned len)
384 unsigned n, t = 2 + 2*strlen(s);
387 t = 254; /* Longest possible UTF string descriptor */
391 t += USB_DT_STRING << 8; /* Now t is first 16 bits to store */
399 t = (unsigned char)*s++;
405 * rh_string() - provides string descriptors for root hub
406 * @id: the string ID number (0: langids, 1: serial #, 2: product, 3: vendor)
407 * @hcd: the host controller for this root hub
408 * @data: buffer for output packet
409 * @len: length of the provided buffer
411 * Produces either a manufacturer, product or serial number string for the
412 * virtual root hub device.
414 * Return: The number of bytes filled in: the length of the descriptor or
415 * of the provided buffer, whichever is less.
418 rh_string(int id, struct usb_hcd const *hcd, u8 *data, unsigned len)
422 static char const langids[4] = {4, USB_DT_STRING, 0x09, 0x04};
427 /* Array of LANGID codes (0x0409 is MSFT-speak for "en-us") */
428 /* See http://www.usb.org/developers/docs/USB_LANGIDs.pdf */
431 memcpy(data, langids, len);
435 s = hcd->self.bus_name;
439 s = hcd->product_desc;
443 snprintf (buf, sizeof buf, "%s %s %s", init_utsname()->sysname,
444 init_utsname()->release, hcd->driver->description);
448 /* Can't happen; caller guarantees it */
452 return ascii2desc(s, data, len);
456 /* Root hub control transfers execute synchronously */
457 static int rh_call_control (struct usb_hcd *hcd, struct urb *urb)
459 struct usb_ctrlrequest *cmd;
460 u16 typeReq, wValue, wIndex, wLength;
461 u8 *ubuf = urb->transfer_buffer;
465 u8 patch_protocol = 0;
472 spin_lock_irq(&hcd_root_hub_lock);
473 status = usb_hcd_link_urb_to_ep(hcd, urb);
474 spin_unlock_irq(&hcd_root_hub_lock);
477 urb->hcpriv = hcd; /* Indicate it's queued */
479 cmd = (struct usb_ctrlrequest *) urb->setup_packet;
480 typeReq = (cmd->bRequestType << 8) | cmd->bRequest;
481 wValue = le16_to_cpu (cmd->wValue);
482 wIndex = le16_to_cpu (cmd->wIndex);
483 wLength = le16_to_cpu (cmd->wLength);
485 if (wLength > urb->transfer_buffer_length)
489 * tbuf should be at least as big as the
490 * USB hub descriptor.
492 tbuf_size = max_t(u16, sizeof(struct usb_hub_descriptor), wLength);
493 tbuf = kzalloc(tbuf_size, GFP_KERNEL);
502 urb->actual_length = 0;
505 /* DEVICE REQUESTS */
507 /* The root hub's remote wakeup enable bit is implemented using
508 * driver model wakeup flags. If this system supports wakeup
509 * through USB, userspace may change the default "allow wakeup"
510 * policy through sysfs or these calls.
512 * Most root hubs support wakeup from downstream devices, for
513 * runtime power management (disabling USB clocks and reducing
514 * VBUS power usage). However, not all of them do so; silicon,
515 * board, and BIOS bugs here are not uncommon, so these can't
516 * be treated quite like external hubs.
518 * Likewise, not all root hubs will pass wakeup events upstream,
519 * to wake up the whole system. So don't assume root hub and
520 * controller capabilities are identical.
523 case DeviceRequest | USB_REQ_GET_STATUS:
524 tbuf[0] = (device_may_wakeup(&hcd->self.root_hub->dev)
525 << USB_DEVICE_REMOTE_WAKEUP)
526 | (1 << USB_DEVICE_SELF_POWERED);
530 case DeviceOutRequest | USB_REQ_CLEAR_FEATURE:
531 if (wValue == USB_DEVICE_REMOTE_WAKEUP)
532 device_set_wakeup_enable(&hcd->self.root_hub->dev, 0);
536 case DeviceOutRequest | USB_REQ_SET_FEATURE:
537 if (device_can_wakeup(&hcd->self.root_hub->dev)
538 && wValue == USB_DEVICE_REMOTE_WAKEUP)
539 device_set_wakeup_enable(&hcd->self.root_hub->dev, 1);
543 case DeviceRequest | USB_REQ_GET_CONFIGURATION:
547 case DeviceOutRequest | USB_REQ_SET_CONFIGURATION:
549 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
550 switch (wValue & 0xff00) {
551 case USB_DT_DEVICE << 8:
552 switch (hcd->speed) {
555 bufp = usb31_rh_dev_descriptor;
558 bufp = usb3_rh_dev_descriptor;
561 bufp = usb2_rh_dev_descriptor;
564 bufp = usb11_rh_dev_descriptor;
573 case USB_DT_CONFIG << 8:
574 switch (hcd->speed) {
578 bufp = ss_rh_config_descriptor;
579 len = sizeof ss_rh_config_descriptor;
582 bufp = hs_rh_config_descriptor;
583 len = sizeof hs_rh_config_descriptor;
586 bufp = fs_rh_config_descriptor;
587 len = sizeof fs_rh_config_descriptor;
592 if (device_can_wakeup(&hcd->self.root_hub->dev))
595 case USB_DT_STRING << 8:
596 if ((wValue & 0xff) < 4)
597 urb->actual_length = rh_string(wValue & 0xff,
599 else /* unsupported IDs --> "protocol stall" */
602 case USB_DT_BOS << 8:
608 case DeviceRequest | USB_REQ_GET_INTERFACE:
612 case DeviceOutRequest | USB_REQ_SET_INTERFACE:
614 case DeviceOutRequest | USB_REQ_SET_ADDRESS:
615 /* wValue == urb->dev->devaddr */
616 dev_dbg (hcd->self.controller, "root hub device address %d\n",
620 /* INTERFACE REQUESTS (no defined feature/status flags) */
622 /* ENDPOINT REQUESTS */
624 case EndpointRequest | USB_REQ_GET_STATUS:
625 /* ENDPOINT_HALT flag */
630 case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
631 case EndpointOutRequest | USB_REQ_SET_FEATURE:
632 dev_dbg (hcd->self.controller, "no endpoint features yet\n");
635 /* CLASS REQUESTS (and errors) */
639 /* non-generic request */
645 if (wValue == HUB_PORT_STATUS)
648 /* other port status types return 8 bytes */
651 case GetHubDescriptor:
652 len = sizeof (struct usb_hub_descriptor);
654 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
655 /* len is returned by hub_control */
658 status = hcd->driver->hub_control (hcd,
659 typeReq, wValue, wIndex,
662 if (typeReq == GetHubDescriptor)
663 usb_hub_adjust_deviceremovable(hcd->self.root_hub,
664 (struct usb_hub_descriptor *)tbuf);
667 /* "protocol stall" on error */
673 if (status != -EPIPE) {
674 dev_dbg (hcd->self.controller,
675 "CTRL: TypeReq=0x%x val=0x%x "
676 "idx=0x%x len=%d ==> %d\n",
677 typeReq, wValue, wIndex,
680 } else if (status > 0) {
681 /* hub_control may return the length of data copied. */
686 if (urb->transfer_buffer_length < len)
687 len = urb->transfer_buffer_length;
688 urb->actual_length = len;
689 /* always USB_DIR_IN, toward host */
690 memcpy (ubuf, bufp, len);
692 /* report whether RH hardware supports remote wakeup */
694 len > offsetof (struct usb_config_descriptor,
696 ((struct usb_config_descriptor *)ubuf)->bmAttributes
697 |= USB_CONFIG_ATT_WAKEUP;
699 /* report whether RH hardware has an integrated TT */
700 if (patch_protocol &&
701 len > offsetof(struct usb_device_descriptor,
703 ((struct usb_device_descriptor *) ubuf)->
704 bDeviceProtocol = USB_HUB_PR_HS_SINGLE_TT;
710 /* any errors get returned through the urb completion */
711 spin_lock_irq(&hcd_root_hub_lock);
712 usb_hcd_unlink_urb_from_ep(hcd, urb);
713 usb_hcd_giveback_urb(hcd, urb, status);
714 spin_unlock_irq(&hcd_root_hub_lock);
718 /*-------------------------------------------------------------------------*/
721 * Root Hub interrupt transfers are polled using a timer if the
722 * driver requests it; otherwise the driver is responsible for
723 * calling usb_hcd_poll_rh_status() when an event occurs.
725 * Completion handler may not sleep. See usb_hcd_giveback_urb() for details.
727 void usb_hcd_poll_rh_status(struct usb_hcd *hcd)
733 char buffer[6]; /* Any root hubs with > 31 ports? */
735 if (unlikely(!hcd->rh_pollable))
737 if (!hcd->uses_new_polling && !hcd->status_urb)
740 length = hcd->driver->hub_status_data(hcd, buffer);
743 /* try to complete the status urb */
744 spin_lock_irqsave(&hcd_root_hub_lock, flags);
745 urb = hcd->status_urb;
747 clear_bit(HCD_FLAG_POLL_PENDING, &hcd->flags);
748 hcd->status_urb = NULL;
749 if (urb->transfer_buffer_length >= length) {
753 length = urb->transfer_buffer_length;
755 urb->actual_length = length;
756 memcpy(urb->transfer_buffer, buffer, length);
758 usb_hcd_unlink_urb_from_ep(hcd, urb);
759 usb_hcd_giveback_urb(hcd, urb, status);
762 set_bit(HCD_FLAG_POLL_PENDING, &hcd->flags);
764 spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
767 /* The USB 2.0 spec says 256 ms. This is close enough and won't
768 * exceed that limit if HZ is 100. The math is more clunky than
769 * maybe expected, this is to make sure that all timers for USB devices
770 * fire at the same time to give the CPU a break in between */
771 if (hcd->uses_new_polling ? HCD_POLL_RH(hcd) :
772 (length == 0 && hcd->status_urb != NULL))
773 mod_timer (&hcd->rh_timer, (jiffies/(HZ/4) + 1) * (HZ/4));
775 EXPORT_SYMBOL_GPL(usb_hcd_poll_rh_status);
778 static void rh_timer_func (struct timer_list *t)
780 struct usb_hcd *_hcd = from_timer(_hcd, t, rh_timer);
782 usb_hcd_poll_rh_status(_hcd);
785 /*-------------------------------------------------------------------------*/
787 static int rh_queue_status (struct usb_hcd *hcd, struct urb *urb)
791 unsigned len = 1 + (urb->dev->maxchild / 8);
793 spin_lock_irqsave (&hcd_root_hub_lock, flags);
794 if (hcd->status_urb || urb->transfer_buffer_length < len) {
795 dev_dbg (hcd->self.controller, "not queuing rh status urb\n");
800 retval = usb_hcd_link_urb_to_ep(hcd, urb);
804 hcd->status_urb = urb;
805 urb->hcpriv = hcd; /* indicate it's queued */
806 if (!hcd->uses_new_polling)
807 mod_timer(&hcd->rh_timer, (jiffies/(HZ/4) + 1) * (HZ/4));
809 /* If a status change has already occurred, report it ASAP */
810 else if (HCD_POLL_PENDING(hcd))
811 mod_timer(&hcd->rh_timer, jiffies);
814 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
818 static int rh_urb_enqueue (struct usb_hcd *hcd, struct urb *urb)
820 if (usb_endpoint_xfer_int(&urb->ep->desc))
821 return rh_queue_status (hcd, urb);
822 if (usb_endpoint_xfer_control(&urb->ep->desc))
823 return rh_call_control (hcd, urb);
827 /*-------------------------------------------------------------------------*/
829 /* Unlinks of root-hub control URBs are legal, but they don't do anything
830 * since these URBs always execute synchronously.
832 static int usb_rh_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
837 spin_lock_irqsave(&hcd_root_hub_lock, flags);
838 rc = usb_hcd_check_unlink_urb(hcd, urb, status);
842 if (usb_endpoint_num(&urb->ep->desc) == 0) { /* Control URB */
845 } else { /* Status URB */
846 if (!hcd->uses_new_polling)
847 del_timer (&hcd->rh_timer);
848 if (urb == hcd->status_urb) {
849 hcd->status_urb = NULL;
850 usb_hcd_unlink_urb_from_ep(hcd, urb);
851 usb_hcd_giveback_urb(hcd, urb, status);
855 spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
860 /*-------------------------------------------------------------------------*/
863 * usb_bus_init - shared initialization code
864 * @bus: the bus structure being initialized
866 * This code is used to initialize a usb_bus structure, memory for which is
867 * separately managed.
869 static void usb_bus_init (struct usb_bus *bus)
871 memset (&bus->devmap, 0, sizeof(struct usb_devmap));
873 bus->devnum_next = 1;
875 bus->root_hub = NULL;
877 bus->bandwidth_allocated = 0;
878 bus->bandwidth_int_reqs = 0;
879 bus->bandwidth_isoc_reqs = 0;
880 mutex_init(&bus->devnum_next_mutex);
883 /*-------------------------------------------------------------------------*/
886 * usb_register_bus - registers the USB host controller with the usb core
887 * @bus: pointer to the bus to register
889 * Context: task context, might sleep.
891 * Assigns a bus number, and links the controller into usbcore data
892 * structures so that it can be seen by scanning the bus list.
894 * Return: 0 if successful. A negative error code otherwise.
896 static int usb_register_bus(struct usb_bus *bus)
901 mutex_lock(&usb_bus_idr_lock);
902 busnum = idr_alloc(&usb_bus_idr, bus, 1, USB_MAXBUS, GFP_KERNEL);
904 pr_err("%s: failed to get bus number\n", usbcore_name);
905 goto error_find_busnum;
907 bus->busnum = busnum;
908 mutex_unlock(&usb_bus_idr_lock);
910 usb_notify_add_bus(bus);
912 dev_info (bus->controller, "new USB bus registered, assigned bus "
913 "number %d\n", bus->busnum);
917 mutex_unlock(&usb_bus_idr_lock);
922 * usb_deregister_bus - deregisters the USB host controller
923 * @bus: pointer to the bus to deregister
925 * Context: task context, might sleep.
927 * Recycles the bus number, and unlinks the controller from usbcore data
928 * structures so that it won't be seen by scanning the bus list.
930 static void usb_deregister_bus (struct usb_bus *bus)
932 dev_info (bus->controller, "USB bus %d deregistered\n", bus->busnum);
935 * NOTE: make sure that all the devices are removed by the
936 * controller code, as well as having it call this when cleaning
939 mutex_lock(&usb_bus_idr_lock);
940 idr_remove(&usb_bus_idr, bus->busnum);
941 mutex_unlock(&usb_bus_idr_lock);
943 usb_notify_remove_bus(bus);
947 * register_root_hub - called by usb_add_hcd() to register a root hub
948 * @hcd: host controller for this root hub
950 * This function registers the root hub with the USB subsystem. It sets up
951 * the device properly in the device tree and then calls usb_new_device()
952 * to register the usb device. It also assigns the root hub's USB address
955 * Return: 0 if successful. A negative error code otherwise.
957 static int register_root_hub(struct usb_hcd *hcd)
959 struct device *parent_dev = hcd->self.controller;
960 struct usb_device *usb_dev = hcd->self.root_hub;
961 struct usb_device_descriptor *descr;
962 const int devnum = 1;
965 usb_dev->devnum = devnum;
966 usb_dev->bus->devnum_next = devnum + 1;
967 set_bit (devnum, usb_dev->bus->devmap.devicemap);
968 usb_set_device_state(usb_dev, USB_STATE_ADDRESS);
970 mutex_lock(&usb_bus_idr_lock);
972 usb_dev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
973 descr = usb_get_device_descriptor(usb_dev);
975 retval = PTR_ERR(descr);
976 mutex_unlock(&usb_bus_idr_lock);
977 dev_dbg (parent_dev, "can't read %s device descriptor %d\n",
978 dev_name(&usb_dev->dev), retval);
981 usb_dev->descriptor = *descr;
984 if (le16_to_cpu(usb_dev->descriptor.bcdUSB) >= 0x0201) {
985 retval = usb_get_bos_descriptor(usb_dev);
987 usb_dev->lpm_capable = usb_device_supports_lpm(usb_dev);
988 } else if (usb_dev->speed >= USB_SPEED_SUPER) {
989 mutex_unlock(&usb_bus_idr_lock);
990 dev_dbg(parent_dev, "can't read %s bos descriptor %d\n",
991 dev_name(&usb_dev->dev), retval);
996 retval = usb_new_device (usb_dev);
998 dev_err (parent_dev, "can't register root hub for %s, %d\n",
999 dev_name(&usb_dev->dev), retval);
1001 spin_lock_irq (&hcd_root_hub_lock);
1002 hcd->rh_registered = 1;
1003 spin_unlock_irq (&hcd_root_hub_lock);
1005 /* Did the HC die before the root hub was registered? */
1007 usb_hc_died (hcd); /* This time clean up */
1009 mutex_unlock(&usb_bus_idr_lock);
1015 * usb_hcd_start_port_resume - a root-hub port is sending a resume signal
1016 * @bus: the bus which the root hub belongs to
1017 * @portnum: the port which is being resumed
1019 * HCDs should call this function when they know that a resume signal is
1020 * being sent to a root-hub port. The root hub will be prevented from
1021 * going into autosuspend until usb_hcd_end_port_resume() is called.
1023 * The bus's private lock must be held by the caller.
1025 void usb_hcd_start_port_resume(struct usb_bus *bus, int portnum)
1027 unsigned bit = 1 << portnum;
1029 if (!(bus->resuming_ports & bit)) {
1030 bus->resuming_ports |= bit;
1031 pm_runtime_get_noresume(&bus->root_hub->dev);
1034 EXPORT_SYMBOL_GPL(usb_hcd_start_port_resume);
1037 * usb_hcd_end_port_resume - a root-hub port has stopped sending a resume signal
1038 * @bus: the bus which the root hub belongs to
1039 * @portnum: the port which is being resumed
1041 * HCDs should call this function when they know that a resume signal has
1042 * stopped being sent to a root-hub port. The root hub will be allowed to
1043 * autosuspend again.
1045 * The bus's private lock must be held by the caller.
1047 void usb_hcd_end_port_resume(struct usb_bus *bus, int portnum)
1049 unsigned bit = 1 << portnum;
1051 if (bus->resuming_ports & bit) {
1052 bus->resuming_ports &= ~bit;
1053 pm_runtime_put_noidle(&bus->root_hub->dev);
1056 EXPORT_SYMBOL_GPL(usb_hcd_end_port_resume);
1058 /*-------------------------------------------------------------------------*/
1061 * usb_calc_bus_time - approximate periodic transaction time in nanoseconds
1062 * @speed: from dev->speed; USB_SPEED_{LOW,FULL,HIGH}
1063 * @is_input: true iff the transaction sends data to the host
1064 * @isoc: true for isochronous transactions, false for interrupt ones
1065 * @bytecount: how many bytes in the transaction.
1067 * Return: Approximate bus time in nanoseconds for a periodic transaction.
1070 * See USB 2.0 spec section 5.11.3; only periodic transfers need to be
1071 * scheduled in software, this function is only used for such scheduling.
1073 long usb_calc_bus_time (int speed, int is_input, int isoc, int bytecount)
1078 case USB_SPEED_LOW: /* INTR only */
1080 tmp = (67667L * (31L + 10L * BitTime (bytecount))) / 1000L;
1081 return 64060L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp;
1083 tmp = (66700L * (31L + 10L * BitTime (bytecount))) / 1000L;
1084 return 64107L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp;
1086 case USB_SPEED_FULL: /* ISOC or INTR */
1088 tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
1089 return ((is_input) ? 7268L : 6265L) + BW_HOST_DELAY + tmp;
1091 tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
1092 return 9107L + BW_HOST_DELAY + tmp;
1094 case USB_SPEED_HIGH: /* ISOC or INTR */
1095 /* FIXME adjust for input vs output */
1097 tmp = HS_NSECS_ISO (bytecount);
1099 tmp = HS_NSECS (bytecount);
1102 pr_debug ("%s: bogus device speed!\n", usbcore_name);
1106 EXPORT_SYMBOL_GPL(usb_calc_bus_time);
1109 /*-------------------------------------------------------------------------*/
1112 * Generic HC operations.
1115 /*-------------------------------------------------------------------------*/
1118 * usb_hcd_link_urb_to_ep - add an URB to its endpoint queue
1119 * @hcd: host controller to which @urb was submitted
1120 * @urb: URB being submitted
1122 * Host controller drivers should call this routine in their enqueue()
1123 * method. The HCD's private spinlock must be held and interrupts must
1124 * be disabled. The actions carried out here are required for URB
1125 * submission, as well as for endpoint shutdown and for usb_kill_urb.
1127 * Return: 0 for no error, otherwise a negative error code (in which case
1128 * the enqueue() method must fail). If no error occurs but enqueue() fails
1129 * anyway, it must call usb_hcd_unlink_urb_from_ep() before releasing
1130 * the private spinlock and returning.
1132 int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb)
1136 spin_lock(&hcd_urb_list_lock);
1138 /* Check that the URB isn't being killed */
1139 if (unlikely(atomic_read(&urb->reject))) {
1144 if (unlikely(!urb->ep->enabled)) {
1149 if (unlikely(!urb->dev->can_submit)) {
1155 * Check the host controller's state and add the URB to the
1158 if (HCD_RH_RUNNING(hcd)) {
1160 list_add_tail(&urb->urb_list, &urb->ep->urb_list);
1166 spin_unlock(&hcd_urb_list_lock);
1169 EXPORT_SYMBOL_GPL(usb_hcd_link_urb_to_ep);
1172 * usb_hcd_check_unlink_urb - check whether an URB may be unlinked
1173 * @hcd: host controller to which @urb was submitted
1174 * @urb: URB being checked for unlinkability
1175 * @status: error code to store in @urb if the unlink succeeds
1177 * Host controller drivers should call this routine in their dequeue()
1178 * method. The HCD's private spinlock must be held and interrupts must
1179 * be disabled. The actions carried out here are required for making
1180 * sure than an unlink is valid.
1182 * Return: 0 for no error, otherwise a negative error code (in which case
1183 * the dequeue() method must fail). The possible error codes are:
1185 * -EIDRM: @urb was not submitted or has already completed.
1186 * The completion function may not have been called yet.
1188 * -EBUSY: @urb has already been unlinked.
1190 int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb,
1193 struct list_head *tmp;
1195 /* insist the urb is still queued */
1196 list_for_each(tmp, &urb->ep->urb_list) {
1197 if (tmp == &urb->urb_list)
1200 if (tmp != &urb->urb_list)
1203 /* Any status except -EINPROGRESS means something already started to
1204 * unlink this URB from the hardware. So there's no more work to do.
1208 urb->unlinked = status;
1211 EXPORT_SYMBOL_GPL(usb_hcd_check_unlink_urb);
1214 * usb_hcd_unlink_urb_from_ep - remove an URB from its endpoint queue
1215 * @hcd: host controller to which @urb was submitted
1216 * @urb: URB being unlinked
1218 * Host controller drivers should call this routine before calling
1219 * usb_hcd_giveback_urb(). The HCD's private spinlock must be held and
1220 * interrupts must be disabled. The actions carried out here are required
1221 * for URB completion.
1223 void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb)
1225 /* clear all state linking urb to this dev (and hcd) */
1226 spin_lock(&hcd_urb_list_lock);
1227 list_del_init(&urb->urb_list);
1228 spin_unlock(&hcd_urb_list_lock);
1230 EXPORT_SYMBOL_GPL(usb_hcd_unlink_urb_from_ep);
1233 * Some usb host controllers can only perform dma using a small SRAM area,
1234 * or have restrictions on addressable DRAM.
1235 * The usb core itself is however optimized for host controllers that can dma
1236 * using regular system memory - like pci devices doing bus mastering.
1238 * To support host controllers with limited dma capabilities we provide dma
1239 * bounce buffers. This feature can be enabled by initializing
1240 * hcd->localmem_pool using usb_hcd_setup_local_mem().
1242 * The initialized hcd->localmem_pool then tells the usb code to allocate all
1243 * data for dma using the genalloc API.
1245 * So, to summarize...
1247 * - We need "local" memory, canonical example being
1248 * a small SRAM on a discrete controller being the
1249 * only memory that the controller can read ...
1250 * (a) "normal" kernel memory is no good, and
1251 * (b) there's not enough to share
1253 * - So we use that, even though the primary requirement
1254 * is that the memory be "local" (hence addressable
1255 * by that device), not "coherent".
1259 static int hcd_alloc_coherent(struct usb_bus *bus,
1260 gfp_t mem_flags, dma_addr_t *dma_handle,
1261 void **vaddr_handle, size_t size,
1262 enum dma_data_direction dir)
1264 unsigned char *vaddr;
1266 if (*vaddr_handle == NULL) {
1271 vaddr = hcd_buffer_alloc(bus, size + sizeof(unsigned long),
1272 mem_flags, dma_handle);
1277 * Store the virtual address of the buffer at the end
1278 * of the allocated dma buffer. The size of the buffer
1279 * may be uneven so use unaligned functions instead
1280 * of just rounding up. It makes sense to optimize for
1281 * memory footprint over access speed since the amount
1282 * of memory available for dma may be limited.
1284 put_unaligned((unsigned long)*vaddr_handle,
1285 (unsigned long *)(vaddr + size));
1287 if (dir == DMA_TO_DEVICE)
1288 memcpy(vaddr, *vaddr_handle, size);
1290 *vaddr_handle = vaddr;
1294 static void hcd_free_coherent(struct usb_bus *bus, dma_addr_t *dma_handle,
1295 void **vaddr_handle, size_t size,
1296 enum dma_data_direction dir)
1298 unsigned char *vaddr = *vaddr_handle;
1300 vaddr = (void *)get_unaligned((unsigned long *)(vaddr + size));
1302 if (dir == DMA_FROM_DEVICE)
1303 memcpy(vaddr, *vaddr_handle, size);
1305 hcd_buffer_free(bus, size + sizeof(vaddr), *vaddr_handle, *dma_handle);
1307 *vaddr_handle = vaddr;
1311 void usb_hcd_unmap_urb_setup_for_dma(struct usb_hcd *hcd, struct urb *urb)
1313 if (IS_ENABLED(CONFIG_HAS_DMA) &&
1314 (urb->transfer_flags & URB_SETUP_MAP_SINGLE))
1315 dma_unmap_single(hcd->self.sysdev,
1317 sizeof(struct usb_ctrlrequest),
1319 else if (urb->transfer_flags & URB_SETUP_MAP_LOCAL)
1320 hcd_free_coherent(urb->dev->bus,
1322 (void **) &urb->setup_packet,
1323 sizeof(struct usb_ctrlrequest),
1326 /* Make it safe to call this routine more than once */
1327 urb->transfer_flags &= ~(URB_SETUP_MAP_SINGLE | URB_SETUP_MAP_LOCAL);
1329 EXPORT_SYMBOL_GPL(usb_hcd_unmap_urb_setup_for_dma);
1331 static void unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
1333 if (hcd->driver->unmap_urb_for_dma)
1334 hcd->driver->unmap_urb_for_dma(hcd, urb);
1336 usb_hcd_unmap_urb_for_dma(hcd, urb);
1339 void usb_hcd_unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
1341 enum dma_data_direction dir;
1343 usb_hcd_unmap_urb_setup_for_dma(hcd, urb);
1345 dir = usb_urb_dir_in(urb) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
1346 if (IS_ENABLED(CONFIG_HAS_DMA) &&
1347 (urb->transfer_flags & URB_DMA_MAP_SG))
1348 dma_unmap_sg(hcd->self.sysdev,
1352 else if (IS_ENABLED(CONFIG_HAS_DMA) &&
1353 (urb->transfer_flags & URB_DMA_MAP_PAGE))
1354 dma_unmap_page(hcd->self.sysdev,
1356 urb->transfer_buffer_length,
1358 else if (IS_ENABLED(CONFIG_HAS_DMA) &&
1359 (urb->transfer_flags & URB_DMA_MAP_SINGLE))
1360 dma_unmap_single(hcd->self.sysdev,
1362 urb->transfer_buffer_length,
1364 else if (urb->transfer_flags & URB_MAP_LOCAL)
1365 hcd_free_coherent(urb->dev->bus,
1367 &urb->transfer_buffer,
1368 urb->transfer_buffer_length,
1371 /* Make it safe to call this routine more than once */
1372 urb->transfer_flags &= ~(URB_DMA_MAP_SG | URB_DMA_MAP_PAGE |
1373 URB_DMA_MAP_SINGLE | URB_MAP_LOCAL);
1375 EXPORT_SYMBOL_GPL(usb_hcd_unmap_urb_for_dma);
1377 static int map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
1380 if (hcd->driver->map_urb_for_dma)
1381 return hcd->driver->map_urb_for_dma(hcd, urb, mem_flags);
1383 return usb_hcd_map_urb_for_dma(hcd, urb, mem_flags);
1386 int usb_hcd_map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
1389 enum dma_data_direction dir;
1392 /* Map the URB's buffers for DMA access.
1393 * Lower level HCD code should use *_dma exclusively,
1394 * unless it uses pio or talks to another transport,
1395 * or uses the provided scatter gather list for bulk.
1398 if (usb_endpoint_xfer_control(&urb->ep->desc)) {
1399 if (hcd->self.uses_pio_for_control)
1401 if (hcd->localmem_pool) {
1402 ret = hcd_alloc_coherent(
1403 urb->dev->bus, mem_flags,
1405 (void **)&urb->setup_packet,
1406 sizeof(struct usb_ctrlrequest),
1410 urb->transfer_flags |= URB_SETUP_MAP_LOCAL;
1411 } else if (hcd_uses_dma(hcd)) {
1412 if (object_is_on_stack(urb->setup_packet)) {
1413 WARN_ONCE(1, "setup packet is on stack\n");
1417 urb->setup_dma = dma_map_single(
1420 sizeof(struct usb_ctrlrequest),
1422 if (dma_mapping_error(hcd->self.sysdev,
1425 urb->transfer_flags |= URB_SETUP_MAP_SINGLE;
1429 dir = usb_urb_dir_in(urb) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
1430 if (urb->transfer_buffer_length != 0
1431 && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP)) {
1432 if (hcd->localmem_pool) {
1433 ret = hcd_alloc_coherent(
1434 urb->dev->bus, mem_flags,
1436 &urb->transfer_buffer,
1437 urb->transfer_buffer_length,
1440 urb->transfer_flags |= URB_MAP_LOCAL;
1441 } else if (hcd_uses_dma(hcd)) {
1445 /* We don't support sg for isoc transfers ! */
1446 if (usb_endpoint_xfer_isoc(&urb->ep->desc)) {
1459 urb->transfer_flags |= URB_DMA_MAP_SG;
1460 urb->num_mapped_sgs = n;
1461 if (n != urb->num_sgs)
1462 urb->transfer_flags |=
1463 URB_DMA_SG_COMBINED;
1464 } else if (urb->sg) {
1465 struct scatterlist *sg = urb->sg;
1466 urb->transfer_dma = dma_map_page(
1470 urb->transfer_buffer_length,
1472 if (dma_mapping_error(hcd->self.sysdev,
1476 urb->transfer_flags |= URB_DMA_MAP_PAGE;
1477 } else if (object_is_on_stack(urb->transfer_buffer)) {
1478 WARN_ONCE(1, "transfer buffer is on stack\n");
1481 urb->transfer_dma = dma_map_single(
1483 urb->transfer_buffer,
1484 urb->transfer_buffer_length,
1486 if (dma_mapping_error(hcd->self.sysdev,
1490 urb->transfer_flags |= URB_DMA_MAP_SINGLE;
1493 if (ret && (urb->transfer_flags & (URB_SETUP_MAP_SINGLE |
1494 URB_SETUP_MAP_LOCAL)))
1495 usb_hcd_unmap_urb_for_dma(hcd, urb);
1499 EXPORT_SYMBOL_GPL(usb_hcd_map_urb_for_dma);
1501 /*-------------------------------------------------------------------------*/
1503 /* may be called in any context with a valid urb->dev usecount
1504 * caller surrenders "ownership" of urb
1505 * expects usb_submit_urb() to have sanity checked and conditioned all
1508 int usb_hcd_submit_urb (struct urb *urb, gfp_t mem_flags)
1511 struct usb_hcd *hcd = bus_to_hcd(urb->dev->bus);
1513 /* increment urb's reference count as part of giving it to the HCD
1514 * (which will control it). HCD guarantees that it either returns
1515 * an error or calls giveback(), but not both.
1518 atomic_inc(&urb->use_count);
1519 atomic_inc(&urb->dev->urbnum);
1520 usbmon_urb_submit(&hcd->self, urb);
1522 /* NOTE requirements on root-hub callers (usbfs and the hub
1523 * driver, for now): URBs' urb->transfer_buffer must be
1524 * valid and usb_buffer_{sync,unmap}() not be needed, since
1525 * they could clobber root hub response data. Also, control
1526 * URBs must be submitted in process context with interrupts
1530 if (is_root_hub(urb->dev)) {
1531 status = rh_urb_enqueue(hcd, urb);
1533 status = map_urb_for_dma(hcd, urb, mem_flags);
1534 if (likely(status == 0)) {
1535 status = hcd->driver->urb_enqueue(hcd, urb, mem_flags);
1536 if (unlikely(status))
1537 unmap_urb_for_dma(hcd, urb);
1541 if (unlikely(status)) {
1542 usbmon_urb_submit_error(&hcd->self, urb, status);
1544 INIT_LIST_HEAD(&urb->urb_list);
1545 atomic_dec(&urb->use_count);
1547 * Order the write of urb->use_count above before the read
1548 * of urb->reject below. Pairs with the memory barriers in
1549 * usb_kill_urb() and usb_poison_urb().
1551 smp_mb__after_atomic();
1553 atomic_dec(&urb->dev->urbnum);
1554 if (atomic_read(&urb->reject))
1555 wake_up(&usb_kill_urb_queue);
1561 /*-------------------------------------------------------------------------*/
1563 /* this makes the hcd giveback() the urb more quickly, by kicking it
1564 * off hardware queues (which may take a while) and returning it as
1565 * soon as practical. we've already set up the urb's return status,
1566 * but we can't know if the callback completed already.
1568 static int unlink1(struct usb_hcd *hcd, struct urb *urb, int status)
1572 if (is_root_hub(urb->dev))
1573 value = usb_rh_urb_dequeue(hcd, urb, status);
1576 /* The only reason an HCD might fail this call is if
1577 * it has not yet fully queued the urb to begin with.
1578 * Such failures should be harmless. */
1579 value = hcd->driver->urb_dequeue(hcd, urb, status);
1585 * called in any context
1587 * caller guarantees urb won't be recycled till both unlink()
1588 * and the urb's completion function return
1590 int usb_hcd_unlink_urb (struct urb *urb, int status)
1592 struct usb_hcd *hcd;
1593 struct usb_device *udev = urb->dev;
1594 int retval = -EIDRM;
1595 unsigned long flags;
1597 /* Prevent the device and bus from going away while
1598 * the unlink is carried out. If they are already gone
1599 * then urb->use_count must be 0, since disconnected
1600 * devices can't have any active URBs.
1602 spin_lock_irqsave(&hcd_urb_unlink_lock, flags);
1603 if (atomic_read(&urb->use_count) > 0) {
1607 spin_unlock_irqrestore(&hcd_urb_unlink_lock, flags);
1609 hcd = bus_to_hcd(urb->dev->bus);
1610 retval = unlink1(hcd, urb, status);
1612 retval = -EINPROGRESS;
1613 else if (retval != -EIDRM && retval != -EBUSY)
1614 dev_dbg(&udev->dev, "hcd_unlink_urb %pK fail %d\n",
1621 /*-------------------------------------------------------------------------*/
1623 static void __usb_hcd_giveback_urb(struct urb *urb)
1625 struct usb_hcd *hcd = bus_to_hcd(urb->dev->bus);
1626 struct usb_anchor *anchor = urb->anchor;
1627 int status = urb->unlinked;
1630 if (unlikely((urb->transfer_flags & URB_SHORT_NOT_OK) &&
1631 urb->actual_length < urb->transfer_buffer_length &&
1633 status = -EREMOTEIO;
1635 unmap_urb_for_dma(hcd, urb);
1636 usbmon_urb_complete(&hcd->self, urb, status);
1637 usb_anchor_suspend_wakeups(anchor);
1638 usb_unanchor_urb(urb);
1639 if (likely(status == 0))
1640 usb_led_activity(USB_LED_EVENT_HOST);
1642 /* pass ownership to the completion handler */
1643 urb->status = status;
1645 * This function can be called in task context inside another remote
1646 * coverage collection section, but kcov doesn't support that kind of
1647 * recursion yet. Only collect coverage in softirq context for now.
1649 kcov_remote_start_usb_softirq((u64)urb->dev->bus->busnum);
1651 kcov_remote_stop_softirq();
1653 usb_anchor_resume_wakeups(anchor);
1654 atomic_dec(&urb->use_count);
1656 * Order the write of urb->use_count above before the read
1657 * of urb->reject below. Pairs with the memory barriers in
1658 * usb_kill_urb() and usb_poison_urb().
1660 smp_mb__after_atomic();
1662 if (unlikely(atomic_read(&urb->reject)))
1663 wake_up(&usb_kill_urb_queue);
1667 static void usb_giveback_urb_bh(struct tasklet_struct *t)
1669 struct giveback_urb_bh *bh = from_tasklet(bh, t, bh);
1670 struct list_head local_list;
1672 spin_lock_irq(&bh->lock);
1674 list_replace_init(&bh->head, &local_list);
1675 spin_unlock_irq(&bh->lock);
1677 while (!list_empty(&local_list)) {
1680 urb = list_entry(local_list.next, struct urb, urb_list);
1681 list_del_init(&urb->urb_list);
1682 bh->completing_ep = urb->ep;
1683 __usb_hcd_giveback_urb(urb);
1684 bh->completing_ep = NULL;
1688 * giveback new URBs next time to prevent this function
1689 * from not exiting for a long time.
1691 spin_lock_irq(&bh->lock);
1692 if (!list_empty(&bh->head)) {
1694 tasklet_hi_schedule(&bh->bh);
1696 tasklet_schedule(&bh->bh);
1698 bh->running = false;
1699 spin_unlock_irq(&bh->lock);
1703 * usb_hcd_giveback_urb - return URB from HCD to device driver
1704 * @hcd: host controller returning the URB
1705 * @urb: urb being returned to the USB device driver.
1706 * @status: completion status code for the URB.
1708 * Context: atomic. The completion callback is invoked in caller's context.
1709 * For HCDs with HCD_BH flag set, the completion callback is invoked in tasklet
1710 * context (except for URBs submitted to the root hub which always complete in
1711 * caller's context).
1713 * This hands the URB from HCD to its USB device driver, using its
1714 * completion function. The HCD has freed all per-urb resources
1715 * (and is done using urb->hcpriv). It also released all HCD locks;
1716 * the device driver won't cause problems if it frees, modifies,
1717 * or resubmits this URB.
1719 * If @urb was unlinked, the value of @status will be overridden by
1720 * @urb->unlinked. Erroneous short transfers are detected in case
1721 * the HCD hasn't checked for them.
1723 void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb, int status)
1725 struct giveback_urb_bh *bh;
1728 /* pass status to tasklet via unlinked */
1729 if (likely(!urb->unlinked))
1730 urb->unlinked = status;
1732 if (!hcd_giveback_urb_in_bh(hcd) && !is_root_hub(urb->dev)) {
1733 __usb_hcd_giveback_urb(urb);
1737 if (usb_pipeisoc(urb->pipe) || usb_pipeint(urb->pipe))
1738 bh = &hcd->high_prio_bh;
1740 bh = &hcd->low_prio_bh;
1742 spin_lock(&bh->lock);
1743 list_add_tail(&urb->urb_list, &bh->head);
1744 running = bh->running;
1745 spin_unlock(&bh->lock);
1749 else if (bh->high_prio)
1750 tasklet_hi_schedule(&bh->bh);
1752 tasklet_schedule(&bh->bh);
1754 EXPORT_SYMBOL_GPL(usb_hcd_giveback_urb);
1756 /*-------------------------------------------------------------------------*/
1758 /* Cancel all URBs pending on this endpoint and wait for the endpoint's
1759 * queue to drain completely. The caller must first insure that no more
1760 * URBs can be submitted for this endpoint.
1762 void usb_hcd_flush_endpoint(struct usb_device *udev,
1763 struct usb_host_endpoint *ep)
1765 struct usb_hcd *hcd;
1771 hcd = bus_to_hcd(udev->bus);
1773 /* No more submits can occur */
1774 spin_lock_irq(&hcd_urb_list_lock);
1776 list_for_each_entry_reverse(urb, &ep->urb_list, urb_list) {
1782 is_in = usb_urb_dir_in(urb);
1783 spin_unlock(&hcd_urb_list_lock);
1786 unlink1(hcd, urb, -ESHUTDOWN);
1787 dev_dbg (hcd->self.controller,
1788 "shutdown urb %pK ep%d%s-%s\n",
1789 urb, usb_endpoint_num(&ep->desc),
1790 is_in ? "in" : "out",
1791 usb_ep_type_string(usb_endpoint_type(&ep->desc)));
1794 /* list contents may have changed */
1795 spin_lock(&hcd_urb_list_lock);
1798 spin_unlock_irq(&hcd_urb_list_lock);
1800 /* Wait until the endpoint queue is completely empty */
1801 while (!list_empty (&ep->urb_list)) {
1802 spin_lock_irq(&hcd_urb_list_lock);
1804 /* The list may have changed while we acquired the spinlock */
1806 if (!list_empty (&ep->urb_list)) {
1807 urb = list_entry (ep->urb_list.prev, struct urb,
1811 spin_unlock_irq(&hcd_urb_list_lock);
1821 * usb_hcd_alloc_bandwidth - check whether a new bandwidth setting exceeds
1823 * @udev: target &usb_device
1824 * @new_config: new configuration to install
1825 * @cur_alt: the current alternate interface setting
1826 * @new_alt: alternate interface setting that is being installed
1828 * To change configurations, pass in the new configuration in new_config,
1829 * and pass NULL for cur_alt and new_alt.
1831 * To reset a device's configuration (put the device in the ADDRESSED state),
1832 * pass in NULL for new_config, cur_alt, and new_alt.
1834 * To change alternate interface settings, pass in NULL for new_config,
1835 * pass in the current alternate interface setting in cur_alt,
1836 * and pass in the new alternate interface setting in new_alt.
1838 * Return: An error if the requested bandwidth change exceeds the
1839 * bus bandwidth or host controller internal resources.
1841 int usb_hcd_alloc_bandwidth(struct usb_device *udev,
1842 struct usb_host_config *new_config,
1843 struct usb_host_interface *cur_alt,
1844 struct usb_host_interface *new_alt)
1846 int num_intfs, i, j;
1847 struct usb_host_interface *alt = NULL;
1849 struct usb_hcd *hcd;
1850 struct usb_host_endpoint *ep;
1852 hcd = bus_to_hcd(udev->bus);
1853 if (!hcd->driver->check_bandwidth)
1856 /* Configuration is being removed - set configuration 0 */
1857 if (!new_config && !cur_alt) {
1858 for (i = 1; i < 16; ++i) {
1859 ep = udev->ep_out[i];
1861 hcd->driver->drop_endpoint(hcd, udev, ep);
1862 ep = udev->ep_in[i];
1864 hcd->driver->drop_endpoint(hcd, udev, ep);
1866 hcd->driver->check_bandwidth(hcd, udev);
1869 /* Check if the HCD says there's enough bandwidth. Enable all endpoints
1870 * each interface's alt setting 0 and ask the HCD to check the bandwidth
1871 * of the bus. There will always be bandwidth for endpoint 0, so it's
1875 num_intfs = new_config->desc.bNumInterfaces;
1876 /* Remove endpoints (except endpoint 0, which is always on the
1877 * schedule) from the old config from the schedule
1879 for (i = 1; i < 16; ++i) {
1880 ep = udev->ep_out[i];
1882 ret = hcd->driver->drop_endpoint(hcd, udev, ep);
1886 ep = udev->ep_in[i];
1888 ret = hcd->driver->drop_endpoint(hcd, udev, ep);
1893 for (i = 0; i < num_intfs; ++i) {
1894 struct usb_host_interface *first_alt;
1897 first_alt = &new_config->intf_cache[i]->altsetting[0];
1898 iface_num = first_alt->desc.bInterfaceNumber;
1899 /* Set up endpoints for alternate interface setting 0 */
1900 alt = usb_find_alt_setting(new_config, iface_num, 0);
1902 /* No alt setting 0? Pick the first setting. */
1905 for (j = 0; j < alt->desc.bNumEndpoints; j++) {
1906 ret = hcd->driver->add_endpoint(hcd, udev, &alt->endpoint[j]);
1912 if (cur_alt && new_alt) {
1913 struct usb_interface *iface = usb_ifnum_to_if(udev,
1914 cur_alt->desc.bInterfaceNumber);
1918 if (iface->resetting_device) {
1920 * The USB core just reset the device, so the xHCI host
1921 * and the device will think alt setting 0 is installed.
1922 * However, the USB core will pass in the alternate
1923 * setting installed before the reset as cur_alt. Dig
1924 * out the alternate setting 0 structure, or the first
1925 * alternate setting if a broken device doesn't have alt
1928 cur_alt = usb_altnum_to_altsetting(iface, 0);
1930 cur_alt = &iface->altsetting[0];
1933 /* Drop all the endpoints in the current alt setting */
1934 for (i = 0; i < cur_alt->desc.bNumEndpoints; i++) {
1935 ret = hcd->driver->drop_endpoint(hcd, udev,
1936 &cur_alt->endpoint[i]);
1940 /* Add all the endpoints in the new alt setting */
1941 for (i = 0; i < new_alt->desc.bNumEndpoints; i++) {
1942 ret = hcd->driver->add_endpoint(hcd, udev,
1943 &new_alt->endpoint[i]);
1948 ret = hcd->driver->check_bandwidth(hcd, udev);
1951 hcd->driver->reset_bandwidth(hcd, udev);
1955 /* Disables the endpoint: synchronizes with the hcd to make sure all
1956 * endpoint state is gone from hardware. usb_hcd_flush_endpoint() must
1957 * have been called previously. Use for set_configuration, set_interface,
1958 * driver removal, physical disconnect.
1960 * example: a qh stored in ep->hcpriv, holding state related to endpoint
1961 * type, maxpacket size, toggle, halt status, and scheduling.
1963 void usb_hcd_disable_endpoint(struct usb_device *udev,
1964 struct usb_host_endpoint *ep)
1966 struct usb_hcd *hcd;
1969 hcd = bus_to_hcd(udev->bus);
1970 if (hcd->driver->endpoint_disable)
1971 hcd->driver->endpoint_disable(hcd, ep);
1975 * usb_hcd_reset_endpoint - reset host endpoint state
1976 * @udev: USB device.
1977 * @ep: the endpoint to reset.
1979 * Resets any host endpoint state such as the toggle bit, sequence
1980 * number and current window.
1982 void usb_hcd_reset_endpoint(struct usb_device *udev,
1983 struct usb_host_endpoint *ep)
1985 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1987 if (hcd->driver->endpoint_reset)
1988 hcd->driver->endpoint_reset(hcd, ep);
1990 int epnum = usb_endpoint_num(&ep->desc);
1991 int is_out = usb_endpoint_dir_out(&ep->desc);
1992 int is_control = usb_endpoint_xfer_control(&ep->desc);
1994 usb_settoggle(udev, epnum, is_out, 0);
1996 usb_settoggle(udev, epnum, !is_out, 0);
2001 * usb_alloc_streams - allocate bulk endpoint stream IDs.
2002 * @interface: alternate setting that includes all endpoints.
2003 * @eps: array of endpoints that need streams.
2004 * @num_eps: number of endpoints in the array.
2005 * @num_streams: number of streams to allocate.
2006 * @mem_flags: flags hcd should use to allocate memory.
2008 * Sets up a group of bulk endpoints to have @num_streams stream IDs available.
2009 * Drivers may queue multiple transfers to different stream IDs, which may
2010 * complete in a different order than they were queued.
2012 * Return: On success, the number of allocated streams. On failure, a negative
2015 int usb_alloc_streams(struct usb_interface *interface,
2016 struct usb_host_endpoint **eps, unsigned int num_eps,
2017 unsigned int num_streams, gfp_t mem_flags)
2019 struct usb_hcd *hcd;
2020 struct usb_device *dev;
2023 dev = interface_to_usbdev(interface);
2024 hcd = bus_to_hcd(dev->bus);
2025 if (!hcd->driver->alloc_streams || !hcd->driver->free_streams)
2027 if (dev->speed < USB_SPEED_SUPER)
2029 if (dev->state < USB_STATE_CONFIGURED)
2032 for (i = 0; i < num_eps; i++) {
2033 /* Streams only apply to bulk endpoints. */
2034 if (!usb_endpoint_xfer_bulk(&eps[i]->desc))
2036 /* Re-alloc is not allowed */
2037 if (eps[i]->streams)
2041 ret = hcd->driver->alloc_streams(hcd, dev, eps, num_eps,
2042 num_streams, mem_flags);
2046 for (i = 0; i < num_eps; i++)
2047 eps[i]->streams = ret;
2051 EXPORT_SYMBOL_GPL(usb_alloc_streams);
2054 * usb_free_streams - free bulk endpoint stream IDs.
2055 * @interface: alternate setting that includes all endpoints.
2056 * @eps: array of endpoints to remove streams from.
2057 * @num_eps: number of endpoints in the array.
2058 * @mem_flags: flags hcd should use to allocate memory.
2060 * Reverts a group of bulk endpoints back to not using stream IDs.
2061 * Can fail if we are given bad arguments, or HCD is broken.
2063 * Return: 0 on success. On failure, a negative error code.
2065 int usb_free_streams(struct usb_interface *interface,
2066 struct usb_host_endpoint **eps, unsigned int num_eps,
2069 struct usb_hcd *hcd;
2070 struct usb_device *dev;
2073 dev = interface_to_usbdev(interface);
2074 hcd = bus_to_hcd(dev->bus);
2075 if (dev->speed < USB_SPEED_SUPER)
2078 /* Double-free is not allowed */
2079 for (i = 0; i < num_eps; i++)
2080 if (!eps[i] || !eps[i]->streams)
2083 ret = hcd->driver->free_streams(hcd, dev, eps, num_eps, mem_flags);
2087 for (i = 0; i < num_eps; i++)
2088 eps[i]->streams = 0;
2092 EXPORT_SYMBOL_GPL(usb_free_streams);
2094 /* Protect against drivers that try to unlink URBs after the device
2095 * is gone, by waiting until all unlinks for @udev are finished.
2096 * Since we don't currently track URBs by device, simply wait until
2097 * nothing is running in the locked region of usb_hcd_unlink_urb().
2099 void usb_hcd_synchronize_unlinks(struct usb_device *udev)
2101 spin_lock_irq(&hcd_urb_unlink_lock);
2102 spin_unlock_irq(&hcd_urb_unlink_lock);
2105 /*-------------------------------------------------------------------------*/
2107 /* called in any context */
2108 int usb_hcd_get_frame_number (struct usb_device *udev)
2110 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2112 if (!HCD_RH_RUNNING(hcd))
2114 return hcd->driver->get_frame_number (hcd);
2117 /*-------------------------------------------------------------------------*/
2118 #ifdef CONFIG_USB_HCD_TEST_MODE
2120 static void usb_ehset_completion(struct urb *urb)
2122 struct completion *done = urb->context;
2127 * Allocate and initialize a control URB. This request will be used by the
2128 * EHSET SINGLE_STEP_SET_FEATURE test in which the DATA and STATUS stages
2129 * of the GetDescriptor request are sent 15 seconds after the SETUP stage.
2130 * Return NULL if failed.
2132 static struct urb *request_single_step_set_feature_urb(
2133 struct usb_device *udev,
2136 struct completion *done)
2139 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2141 urb = usb_alloc_urb(0, GFP_KERNEL);
2145 urb->pipe = usb_rcvctrlpipe(udev, 0);
2147 urb->ep = &udev->ep0;
2149 urb->setup_packet = (void *)dr;
2150 urb->transfer_buffer = buf;
2151 urb->transfer_buffer_length = USB_DT_DEVICE_SIZE;
2152 urb->complete = usb_ehset_completion;
2153 urb->status = -EINPROGRESS;
2154 urb->actual_length = 0;
2155 urb->transfer_flags = URB_DIR_IN;
2157 atomic_inc(&urb->use_count);
2158 atomic_inc(&urb->dev->urbnum);
2159 if (map_urb_for_dma(hcd, urb, GFP_KERNEL)) {
2165 urb->context = done;
2169 int ehset_single_step_set_feature(struct usb_hcd *hcd, int port)
2171 int retval = -ENOMEM;
2172 struct usb_ctrlrequest *dr;
2174 struct usb_device *udev;
2175 struct usb_device_descriptor *buf;
2176 DECLARE_COMPLETION_ONSTACK(done);
2178 /* Obtain udev of the rhub's child port */
2179 udev = usb_hub_find_child(hcd->self.root_hub, port);
2181 dev_err(hcd->self.controller, "No device attached to the RootHub\n");
2184 buf = kmalloc(USB_DT_DEVICE_SIZE, GFP_KERNEL);
2188 dr = kmalloc(sizeof(struct usb_ctrlrequest), GFP_KERNEL);
2194 /* Fill Setup packet for GetDescriptor */
2195 dr->bRequestType = USB_DIR_IN;
2196 dr->bRequest = USB_REQ_GET_DESCRIPTOR;
2197 dr->wValue = cpu_to_le16(USB_DT_DEVICE << 8);
2199 dr->wLength = cpu_to_le16(USB_DT_DEVICE_SIZE);
2200 urb = request_single_step_set_feature_urb(udev, dr, buf, &done);
2204 /* Submit just the SETUP stage */
2205 retval = hcd->driver->submit_single_step_set_feature(hcd, urb, 1);
2208 if (!wait_for_completion_timeout(&done, msecs_to_jiffies(2000))) {
2210 retval = -ETIMEDOUT;
2211 dev_err(hcd->self.controller,
2212 "%s SETUP stage timed out on ep0\n", __func__);
2217 /* Complete remaining DATA and STATUS stages using the same URB */
2218 urb->status = -EINPROGRESS;
2220 atomic_inc(&urb->use_count);
2221 atomic_inc(&urb->dev->urbnum);
2222 retval = hcd->driver->submit_single_step_set_feature(hcd, urb, 0);
2223 if (!retval && !wait_for_completion_timeout(&done,
2224 msecs_to_jiffies(2000))) {
2226 retval = -ETIMEDOUT;
2227 dev_err(hcd->self.controller,
2228 "%s IN stage timed out on ep0\n", __func__);
2237 EXPORT_SYMBOL_GPL(ehset_single_step_set_feature);
2238 #endif /* CONFIG_USB_HCD_TEST_MODE */
2240 /*-------------------------------------------------------------------------*/
2244 int hcd_bus_suspend(struct usb_device *rhdev, pm_message_t msg)
2246 struct usb_hcd *hcd = bus_to_hcd(rhdev->bus);
2248 int old_state = hcd->state;
2250 dev_dbg(&rhdev->dev, "bus %ssuspend, wakeup %d\n",
2251 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
2252 rhdev->do_remote_wakeup);
2253 if (HCD_DEAD(hcd)) {
2254 dev_dbg(&rhdev->dev, "skipped %s of dead bus\n", "suspend");
2258 if (!hcd->driver->bus_suspend) {
2261 clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2262 hcd->state = HC_STATE_QUIESCING;
2263 status = hcd->driver->bus_suspend(hcd);
2266 usb_set_device_state(rhdev, USB_STATE_SUSPENDED);
2267 hcd->state = HC_STATE_SUSPENDED;
2269 if (!PMSG_IS_AUTO(msg))
2270 usb_phy_roothub_suspend(hcd->self.sysdev,
2273 /* Did we race with a root-hub wakeup event? */
2274 if (rhdev->do_remote_wakeup) {
2277 status = hcd->driver->hub_status_data(hcd, buffer);
2279 dev_dbg(&rhdev->dev, "suspend raced with wakeup event\n");
2280 hcd_bus_resume(rhdev, PMSG_AUTO_RESUME);
2285 spin_lock_irq(&hcd_root_hub_lock);
2286 if (!HCD_DEAD(hcd)) {
2287 set_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2288 hcd->state = old_state;
2290 spin_unlock_irq(&hcd_root_hub_lock);
2291 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
2297 int hcd_bus_resume(struct usb_device *rhdev, pm_message_t msg)
2299 struct usb_hcd *hcd = bus_to_hcd(rhdev->bus);
2301 int old_state = hcd->state;
2303 dev_dbg(&rhdev->dev, "usb %sresume\n",
2304 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
2305 if (HCD_DEAD(hcd)) {
2306 dev_dbg(&rhdev->dev, "skipped %s of dead bus\n", "resume");
2310 if (!PMSG_IS_AUTO(msg)) {
2311 status = usb_phy_roothub_resume(hcd->self.sysdev,
2317 if (!hcd->driver->bus_resume)
2319 if (HCD_RH_RUNNING(hcd))
2322 hcd->state = HC_STATE_RESUMING;
2323 status = hcd->driver->bus_resume(hcd);
2324 clear_bit(HCD_FLAG_WAKEUP_PENDING, &hcd->flags);
2326 status = usb_phy_roothub_calibrate(hcd->phy_roothub);
2329 struct usb_device *udev;
2332 spin_lock_irq(&hcd_root_hub_lock);
2333 if (!HCD_DEAD(hcd)) {
2334 usb_set_device_state(rhdev, rhdev->actconfig
2335 ? USB_STATE_CONFIGURED
2336 : USB_STATE_ADDRESS);
2337 set_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2338 hcd->state = HC_STATE_RUNNING;
2340 spin_unlock_irq(&hcd_root_hub_lock);
2343 * Check whether any of the enabled ports on the root hub are
2344 * unsuspended. If they are then a TRSMRCY delay is needed
2345 * (this is what the USB-2 spec calls a "global resume").
2346 * Otherwise we can skip the delay.
2348 usb_hub_for_each_child(rhdev, port1, udev) {
2349 if (udev->state != USB_STATE_NOTATTACHED &&
2350 !udev->port_is_suspended) {
2351 usleep_range(10000, 11000); /* TRSMRCY */
2356 hcd->state = old_state;
2357 usb_phy_roothub_suspend(hcd->self.sysdev, hcd->phy_roothub);
2358 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
2360 if (status != -ESHUTDOWN)
2366 /* Workqueue routine for root-hub remote wakeup */
2367 static void hcd_resume_work(struct work_struct *work)
2369 struct usb_hcd *hcd = container_of(work, struct usb_hcd, wakeup_work);
2370 struct usb_device *udev = hcd->self.root_hub;
2372 usb_remote_wakeup(udev);
2376 * usb_hcd_resume_root_hub - called by HCD to resume its root hub
2377 * @hcd: host controller for this root hub
2379 * The USB host controller calls this function when its root hub is
2380 * suspended (with the remote wakeup feature enabled) and a remote
2381 * wakeup request is received. The routine submits a workqueue request
2382 * to resume the root hub (that is, manage its downstream ports again).
2384 void usb_hcd_resume_root_hub (struct usb_hcd *hcd)
2386 unsigned long flags;
2388 spin_lock_irqsave (&hcd_root_hub_lock, flags);
2389 if (hcd->rh_registered) {
2390 pm_wakeup_event(&hcd->self.root_hub->dev, 0);
2391 set_bit(HCD_FLAG_WAKEUP_PENDING, &hcd->flags);
2392 queue_work(pm_wq, &hcd->wakeup_work);
2394 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
2396 EXPORT_SYMBOL_GPL(usb_hcd_resume_root_hub);
2398 #endif /* CONFIG_PM */
2400 /*-------------------------------------------------------------------------*/
2402 #ifdef CONFIG_USB_OTG
2405 * usb_bus_start_enum - start immediate enumeration (for OTG)
2406 * @bus: the bus (must use hcd framework)
2407 * @port_num: 1-based number of port; usually bus->otg_port
2410 * Starts enumeration, with an immediate reset followed later by
2411 * hub_wq identifying and possibly configuring the device.
2412 * This is needed by OTG controller drivers, where it helps meet
2413 * HNP protocol timing requirements for starting a port reset.
2415 * Return: 0 if successful.
2417 int usb_bus_start_enum(struct usb_bus *bus, unsigned port_num)
2419 struct usb_hcd *hcd;
2420 int status = -EOPNOTSUPP;
2422 /* NOTE: since HNP can't start by grabbing the bus's address0_sem,
2423 * boards with root hubs hooked up to internal devices (instead of
2424 * just the OTG port) may need more attention to resetting...
2426 hcd = bus_to_hcd(bus);
2427 if (port_num && hcd->driver->start_port_reset)
2428 status = hcd->driver->start_port_reset(hcd, port_num);
2430 /* allocate hub_wq shortly after (first) root port reset finishes;
2431 * it may issue others, until at least 50 msecs have passed.
2434 mod_timer(&hcd->rh_timer, jiffies + msecs_to_jiffies(10));
2437 EXPORT_SYMBOL_GPL(usb_bus_start_enum);
2441 /*-------------------------------------------------------------------------*/
2444 * usb_hcd_irq - hook IRQs to HCD framework (bus glue)
2445 * @irq: the IRQ being raised
2446 * @__hcd: pointer to the HCD whose IRQ is being signaled
2448 * If the controller isn't HALTed, calls the driver's irq handler.
2449 * Checks whether the controller is now dead.
2451 * Return: %IRQ_HANDLED if the IRQ was handled. %IRQ_NONE otherwise.
2453 irqreturn_t usb_hcd_irq (int irq, void *__hcd)
2455 struct usb_hcd *hcd = __hcd;
2458 if (unlikely(HCD_DEAD(hcd) || !HCD_HW_ACCESSIBLE(hcd)))
2460 else if (hcd->driver->irq(hcd) == IRQ_NONE)
2467 EXPORT_SYMBOL_GPL(usb_hcd_irq);
2469 /*-------------------------------------------------------------------------*/
2471 /* Workqueue routine for when the root-hub has died. */
2472 static void hcd_died_work(struct work_struct *work)
2474 struct usb_hcd *hcd = container_of(work, struct usb_hcd, died_work);
2475 static char *env[] = {
2480 /* Notify user space that the host controller has died */
2481 kobject_uevent_env(&hcd->self.root_hub->dev.kobj, KOBJ_OFFLINE, env);
2485 * usb_hc_died - report abnormal shutdown of a host controller (bus glue)
2486 * @hcd: pointer to the HCD representing the controller
2488 * This is called by bus glue to report a USB host controller that died
2489 * while operations may still have been pending. It's called automatically
2490 * by the PCI glue, so only glue for non-PCI busses should need to call it.
2492 * Only call this function with the primary HCD.
2494 void usb_hc_died (struct usb_hcd *hcd)
2496 unsigned long flags;
2498 dev_err (hcd->self.controller, "HC died; cleaning up\n");
2500 spin_lock_irqsave (&hcd_root_hub_lock, flags);
2501 clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2502 set_bit(HCD_FLAG_DEAD, &hcd->flags);
2503 if (hcd->rh_registered) {
2504 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2506 /* make hub_wq clean up old urbs and devices */
2507 usb_set_device_state (hcd->self.root_hub,
2508 USB_STATE_NOTATTACHED);
2509 usb_kick_hub_wq(hcd->self.root_hub);
2511 if (usb_hcd_is_primary_hcd(hcd) && hcd->shared_hcd) {
2512 hcd = hcd->shared_hcd;
2513 clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2514 set_bit(HCD_FLAG_DEAD, &hcd->flags);
2515 if (hcd->rh_registered) {
2516 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2518 /* make hub_wq clean up old urbs and devices */
2519 usb_set_device_state(hcd->self.root_hub,
2520 USB_STATE_NOTATTACHED);
2521 usb_kick_hub_wq(hcd->self.root_hub);
2525 /* Handle the case where this function gets called with a shared HCD */
2526 if (usb_hcd_is_primary_hcd(hcd))
2527 schedule_work(&hcd->died_work);
2529 schedule_work(&hcd->primary_hcd->died_work);
2531 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
2532 /* Make sure that the other roothub is also deallocated. */
2534 EXPORT_SYMBOL_GPL (usb_hc_died);
2536 /*-------------------------------------------------------------------------*/
2538 static void init_giveback_urb_bh(struct giveback_urb_bh *bh)
2541 spin_lock_init(&bh->lock);
2542 INIT_LIST_HEAD(&bh->head);
2543 tasklet_setup(&bh->bh, usb_giveback_urb_bh);
2546 struct usb_hcd *__usb_create_hcd(const struct hc_driver *driver,
2547 struct device *sysdev, struct device *dev, const char *bus_name,
2548 struct usb_hcd *primary_hcd)
2550 struct usb_hcd *hcd;
2552 hcd = kzalloc(sizeof(*hcd) + driver->hcd_priv_size, GFP_KERNEL);
2555 if (primary_hcd == NULL) {
2556 hcd->address0_mutex = kmalloc(sizeof(*hcd->address0_mutex),
2558 if (!hcd->address0_mutex) {
2560 dev_dbg(dev, "hcd address0 mutex alloc failed\n");
2563 mutex_init(hcd->address0_mutex);
2564 hcd->bandwidth_mutex = kmalloc(sizeof(*hcd->bandwidth_mutex),
2566 if (!hcd->bandwidth_mutex) {
2567 kfree(hcd->address0_mutex);
2569 dev_dbg(dev, "hcd bandwidth mutex alloc failed\n");
2572 mutex_init(hcd->bandwidth_mutex);
2573 dev_set_drvdata(dev, hcd);
2575 mutex_lock(&usb_port_peer_mutex);
2576 hcd->address0_mutex = primary_hcd->address0_mutex;
2577 hcd->bandwidth_mutex = primary_hcd->bandwidth_mutex;
2578 hcd->primary_hcd = primary_hcd;
2579 primary_hcd->primary_hcd = primary_hcd;
2580 hcd->shared_hcd = primary_hcd;
2581 primary_hcd->shared_hcd = hcd;
2582 mutex_unlock(&usb_port_peer_mutex);
2585 kref_init(&hcd->kref);
2587 usb_bus_init(&hcd->self);
2588 hcd->self.controller = dev;
2589 hcd->self.sysdev = sysdev;
2590 hcd->self.bus_name = bus_name;
2592 timer_setup(&hcd->rh_timer, rh_timer_func, 0);
2594 INIT_WORK(&hcd->wakeup_work, hcd_resume_work);
2597 INIT_WORK(&hcd->died_work, hcd_died_work);
2599 hcd->driver = driver;
2600 hcd->speed = driver->flags & HCD_MASK;
2601 hcd->product_desc = (driver->product_desc) ? driver->product_desc :
2602 "USB Host Controller";
2605 EXPORT_SYMBOL_GPL(__usb_create_hcd);
2608 * usb_create_shared_hcd - create and initialize an HCD structure
2609 * @driver: HC driver that will use this hcd
2610 * @dev: device for this HC, stored in hcd->self.controller
2611 * @bus_name: value to store in hcd->self.bus_name
2612 * @primary_hcd: a pointer to the usb_hcd structure that is sharing the
2613 * PCI device. Only allocate certain resources for the primary HCD
2615 * Context: task context, might sleep.
2617 * Allocate a struct usb_hcd, with extra space at the end for the
2618 * HC driver's private data. Initialize the generic members of the
2621 * Return: On success, a pointer to the created and initialized HCD structure.
2622 * On failure (e.g. if memory is unavailable), %NULL.
2624 struct usb_hcd *usb_create_shared_hcd(const struct hc_driver *driver,
2625 struct device *dev, const char *bus_name,
2626 struct usb_hcd *primary_hcd)
2628 return __usb_create_hcd(driver, dev, dev, bus_name, primary_hcd);
2630 EXPORT_SYMBOL_GPL(usb_create_shared_hcd);
2633 * usb_create_hcd - create and initialize an HCD structure
2634 * @driver: HC driver that will use this hcd
2635 * @dev: device for this HC, stored in hcd->self.controller
2636 * @bus_name: value to store in hcd->self.bus_name
2638 * Context: task context, might sleep.
2640 * Allocate a struct usb_hcd, with extra space at the end for the
2641 * HC driver's private data. Initialize the generic members of the
2644 * Return: On success, a pointer to the created and initialized HCD
2645 * structure. On failure (e.g. if memory is unavailable), %NULL.
2647 struct usb_hcd *usb_create_hcd(const struct hc_driver *driver,
2648 struct device *dev, const char *bus_name)
2650 return __usb_create_hcd(driver, dev, dev, bus_name, NULL);
2652 EXPORT_SYMBOL_GPL(usb_create_hcd);
2655 * Roothubs that share one PCI device must also share the bandwidth mutex.
2656 * Don't deallocate the bandwidth_mutex until the last shared usb_hcd is
2659 * Make sure to deallocate the bandwidth_mutex only when the last HCD is
2660 * freed. When hcd_release() is called for either hcd in a peer set,
2661 * invalidate the peer's ->shared_hcd and ->primary_hcd pointers.
2663 static void hcd_release(struct kref *kref)
2665 struct usb_hcd *hcd = container_of (kref, struct usb_hcd, kref);
2667 mutex_lock(&usb_port_peer_mutex);
2668 if (hcd->shared_hcd) {
2669 struct usb_hcd *peer = hcd->shared_hcd;
2671 peer->shared_hcd = NULL;
2672 peer->primary_hcd = NULL;
2674 kfree(hcd->address0_mutex);
2675 kfree(hcd->bandwidth_mutex);
2677 mutex_unlock(&usb_port_peer_mutex);
2681 struct usb_hcd *usb_get_hcd (struct usb_hcd *hcd)
2684 kref_get (&hcd->kref);
2687 EXPORT_SYMBOL_GPL(usb_get_hcd);
2689 void usb_put_hcd (struct usb_hcd *hcd)
2692 kref_put (&hcd->kref, hcd_release);
2694 EXPORT_SYMBOL_GPL(usb_put_hcd);
2696 int usb_hcd_is_primary_hcd(struct usb_hcd *hcd)
2698 if (!hcd->primary_hcd)
2700 return hcd == hcd->primary_hcd;
2702 EXPORT_SYMBOL_GPL(usb_hcd_is_primary_hcd);
2704 int usb_hcd_find_raw_port_number(struct usb_hcd *hcd, int port1)
2706 if (!hcd->driver->find_raw_port_number)
2709 return hcd->driver->find_raw_port_number(hcd, port1);
2712 static int usb_hcd_request_irqs(struct usb_hcd *hcd,
2713 unsigned int irqnum, unsigned long irqflags)
2717 if (hcd->driver->irq) {
2719 snprintf(hcd->irq_descr, sizeof(hcd->irq_descr), "%s:usb%d",
2720 hcd->driver->description, hcd->self.busnum);
2721 retval = request_irq(irqnum, &usb_hcd_irq, irqflags,
2722 hcd->irq_descr, hcd);
2724 dev_err(hcd->self.controller,
2725 "request interrupt %d failed\n",
2730 dev_info(hcd->self.controller, "irq %d, %s 0x%08llx\n", irqnum,
2731 (hcd->driver->flags & HCD_MEMORY) ?
2732 "io mem" : "io port",
2733 (unsigned long long)hcd->rsrc_start);
2736 if (hcd->rsrc_start)
2737 dev_info(hcd->self.controller, "%s 0x%08llx\n",
2738 (hcd->driver->flags & HCD_MEMORY) ?
2739 "io mem" : "io port",
2740 (unsigned long long)hcd->rsrc_start);
2746 * Before we free this root hub, flush in-flight peering attempts
2747 * and disable peer lookups
2749 static void usb_put_invalidate_rhdev(struct usb_hcd *hcd)
2751 struct usb_device *rhdev;
2753 mutex_lock(&usb_port_peer_mutex);
2754 rhdev = hcd->self.root_hub;
2755 hcd->self.root_hub = NULL;
2756 mutex_unlock(&usb_port_peer_mutex);
2761 * usb_stop_hcd - Halt the HCD
2762 * @hcd: the usb_hcd that has to be halted
2764 * Stop the root-hub polling timer and invoke the HCD's ->stop callback.
2766 static void usb_stop_hcd(struct usb_hcd *hcd)
2768 hcd->rh_pollable = 0;
2769 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2770 del_timer_sync(&hcd->rh_timer);
2772 hcd->driver->stop(hcd);
2773 hcd->state = HC_STATE_HALT;
2775 /* In case the HCD restarted the timer, stop it again. */
2776 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2777 del_timer_sync(&hcd->rh_timer);
2781 * usb_add_hcd - finish generic HCD structure initialization and register
2782 * @hcd: the usb_hcd structure to initialize
2783 * @irqnum: Interrupt line to allocate
2784 * @irqflags: Interrupt type flags
2786 * Finish the remaining parts of generic HCD initialization: allocate the
2787 * buffers of consistent memory, register the bus, request the IRQ line,
2788 * and call the driver's reset() and start() routines.
2790 int usb_add_hcd(struct usb_hcd *hcd,
2791 unsigned int irqnum, unsigned long irqflags)
2794 struct usb_device *rhdev;
2795 struct usb_hcd *shared_hcd;
2797 if (!hcd->skip_phy_initialization && usb_hcd_is_primary_hcd(hcd)) {
2798 hcd->phy_roothub = usb_phy_roothub_alloc(hcd->self.sysdev);
2799 if (IS_ERR(hcd->phy_roothub))
2800 return PTR_ERR(hcd->phy_roothub);
2802 retval = usb_phy_roothub_init(hcd->phy_roothub);
2806 retval = usb_phy_roothub_set_mode(hcd->phy_roothub,
2807 PHY_MODE_USB_HOST_SS);
2809 retval = usb_phy_roothub_set_mode(hcd->phy_roothub,
2812 goto err_usb_phy_roothub_power_on;
2814 retval = usb_phy_roothub_power_on(hcd->phy_roothub);
2816 goto err_usb_phy_roothub_power_on;
2819 dev_info(hcd->self.controller, "%s\n", hcd->product_desc);
2821 switch (authorized_default) {
2822 case USB_AUTHORIZE_NONE:
2823 hcd->dev_policy = USB_DEVICE_AUTHORIZE_NONE;
2826 case USB_AUTHORIZE_INTERNAL:
2827 hcd->dev_policy = USB_DEVICE_AUTHORIZE_INTERNAL;
2830 case USB_AUTHORIZE_ALL:
2831 case USB_AUTHORIZE_WIRED:
2833 hcd->dev_policy = USB_DEVICE_AUTHORIZE_ALL;
2837 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
2839 /* per default all interfaces are authorized */
2840 set_bit(HCD_FLAG_INTF_AUTHORIZED, &hcd->flags);
2842 /* HC is in reset state, but accessible. Now do the one-time init,
2843 * bottom up so that hcds can customize the root hubs before hub_wq
2844 * starts talking to them. (Note, bus id is assigned early too.)
2846 retval = hcd_buffer_create(hcd);
2848 dev_dbg(hcd->self.sysdev, "pool alloc failed\n");
2849 goto err_create_buf;
2852 retval = usb_register_bus(&hcd->self);
2854 goto err_register_bus;
2856 rhdev = usb_alloc_dev(NULL, &hcd->self, 0);
2857 if (rhdev == NULL) {
2858 dev_err(hcd->self.sysdev, "unable to allocate root hub\n");
2860 goto err_allocate_root_hub;
2862 mutex_lock(&usb_port_peer_mutex);
2863 hcd->self.root_hub = rhdev;
2864 mutex_unlock(&usb_port_peer_mutex);
2866 rhdev->rx_lanes = 1;
2867 rhdev->tx_lanes = 1;
2868 rhdev->ssp_rate = USB_SSP_GEN_UNKNOWN;
2870 switch (hcd->speed) {
2872 rhdev->speed = USB_SPEED_FULL;
2875 rhdev->speed = USB_SPEED_HIGH;
2878 rhdev->speed = USB_SPEED_SUPER;
2881 rhdev->rx_lanes = 2;
2882 rhdev->tx_lanes = 2;
2883 rhdev->ssp_rate = USB_SSP_GEN_2x2;
2884 rhdev->speed = USB_SPEED_SUPER_PLUS;
2887 rhdev->ssp_rate = USB_SSP_GEN_2x1;
2888 rhdev->speed = USB_SPEED_SUPER_PLUS;
2892 goto err_set_rh_speed;
2895 /* wakeup flag init defaults to "everything works" for root hubs,
2896 * but drivers can override it in reset() if needed, along with
2897 * recording the overall controller's system wakeup capability.
2899 device_set_wakeup_capable(&rhdev->dev, 1);
2901 /* HCD_FLAG_RH_RUNNING doesn't matter until the root hub is
2902 * registered. But since the controller can die at any time,
2903 * let's initialize the flag before touching the hardware.
2905 set_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2907 /* "reset" is misnamed; its role is now one-time init. the controller
2908 * should already have been reset (and boot firmware kicked off etc).
2910 if (hcd->driver->reset) {
2911 retval = hcd->driver->reset(hcd);
2913 dev_err(hcd->self.controller, "can't setup: %d\n",
2915 goto err_hcd_driver_setup;
2918 hcd->rh_pollable = 1;
2920 retval = usb_phy_roothub_calibrate(hcd->phy_roothub);
2922 goto err_hcd_driver_setup;
2924 /* NOTE: root hub and controller capabilities may not be the same */
2925 if (device_can_wakeup(hcd->self.controller)
2926 && device_can_wakeup(&hcd->self.root_hub->dev))
2927 dev_dbg(hcd->self.controller, "supports USB remote wakeup\n");
2929 /* initialize tasklets */
2930 init_giveback_urb_bh(&hcd->high_prio_bh);
2931 hcd->high_prio_bh.high_prio = true;
2932 init_giveback_urb_bh(&hcd->low_prio_bh);
2934 /* enable irqs just before we start the controller,
2935 * if the BIOS provides legacy PCI irqs.
2937 if (usb_hcd_is_primary_hcd(hcd) && irqnum) {
2938 retval = usb_hcd_request_irqs(hcd, irqnum, irqflags);
2940 goto err_request_irq;
2943 hcd->state = HC_STATE_RUNNING;
2944 retval = hcd->driver->start(hcd);
2946 dev_err(hcd->self.controller, "startup error %d\n", retval);
2947 goto err_hcd_driver_start;
2950 /* starting here, usbcore will pay attention to the shared HCD roothub */
2951 shared_hcd = hcd->shared_hcd;
2952 if (!usb_hcd_is_primary_hcd(hcd) && shared_hcd && HCD_DEFER_RH_REGISTER(shared_hcd)) {
2953 retval = register_root_hub(shared_hcd);
2955 goto err_register_root_hub;
2957 if (shared_hcd->uses_new_polling && HCD_POLL_RH(shared_hcd))
2958 usb_hcd_poll_rh_status(shared_hcd);
2961 /* starting here, usbcore will pay attention to this root hub */
2962 if (!HCD_DEFER_RH_REGISTER(hcd)) {
2963 retval = register_root_hub(hcd);
2965 goto err_register_root_hub;
2967 if (hcd->uses_new_polling && HCD_POLL_RH(hcd))
2968 usb_hcd_poll_rh_status(hcd);
2973 err_register_root_hub:
2975 err_hcd_driver_start:
2976 if (usb_hcd_is_primary_hcd(hcd) && hcd->irq > 0)
2977 free_irq(irqnum, hcd);
2979 err_hcd_driver_setup:
2981 usb_put_invalidate_rhdev(hcd);
2982 err_allocate_root_hub:
2983 usb_deregister_bus(&hcd->self);
2985 hcd_buffer_destroy(hcd);
2987 usb_phy_roothub_power_off(hcd->phy_roothub);
2988 err_usb_phy_roothub_power_on:
2989 usb_phy_roothub_exit(hcd->phy_roothub);
2993 EXPORT_SYMBOL_GPL(usb_add_hcd);
2996 * usb_remove_hcd - shutdown processing for generic HCDs
2997 * @hcd: the usb_hcd structure to remove
2999 * Context: task context, might sleep.
3001 * Disconnects the root hub, then reverses the effects of usb_add_hcd(),
3002 * invoking the HCD's stop() method.
3004 void usb_remove_hcd(struct usb_hcd *hcd)
3006 struct usb_device *rhdev;
3010 pr_debug("%s: hcd is NULL\n", __func__);
3013 rhdev = hcd->self.root_hub;
3015 dev_info(hcd->self.controller, "remove, state %x\n", hcd->state);
3018 clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
3019 if (HC_IS_RUNNING (hcd->state))
3020 hcd->state = HC_STATE_QUIESCING;
3022 dev_dbg(hcd->self.controller, "roothub graceful disconnect\n");
3023 spin_lock_irq (&hcd_root_hub_lock);
3024 rh_registered = hcd->rh_registered;
3025 hcd->rh_registered = 0;
3026 spin_unlock_irq (&hcd_root_hub_lock);
3029 cancel_work_sync(&hcd->wakeup_work);
3031 cancel_work_sync(&hcd->died_work);
3033 mutex_lock(&usb_bus_idr_lock);
3035 usb_disconnect(&rhdev); /* Sets rhdev to NULL */
3036 mutex_unlock(&usb_bus_idr_lock);
3039 * tasklet_kill() isn't needed here because:
3040 * - driver's disconnect() called from usb_disconnect() should
3041 * make sure its URBs are completed during the disconnect()
3044 * - it is too late to run complete() here since driver may have
3045 * been removed already now
3048 /* Prevent any more root-hub status calls from the timer.
3049 * The HCD might still restart the timer (if a port status change
3050 * interrupt occurs), but usb_hcd_poll_rh_status() won't invoke
3051 * the hub_status_data() callback.
3055 if (usb_hcd_is_primary_hcd(hcd)) {
3057 free_irq(hcd->irq, hcd);
3060 usb_deregister_bus(&hcd->self);
3061 hcd_buffer_destroy(hcd);
3063 usb_phy_roothub_power_off(hcd->phy_roothub);
3064 usb_phy_roothub_exit(hcd->phy_roothub);
3066 usb_put_invalidate_rhdev(hcd);
3069 EXPORT_SYMBOL_GPL(usb_remove_hcd);
3072 usb_hcd_platform_shutdown(struct platform_device *dev)
3074 struct usb_hcd *hcd = platform_get_drvdata(dev);
3076 /* No need for pm_runtime_put(), we're shutting down */
3077 pm_runtime_get_sync(&dev->dev);
3079 if (hcd->driver->shutdown)
3080 hcd->driver->shutdown(hcd);
3082 EXPORT_SYMBOL_GPL(usb_hcd_platform_shutdown);
3084 int usb_hcd_setup_local_mem(struct usb_hcd *hcd, phys_addr_t phys_addr,
3085 dma_addr_t dma, size_t size)
3090 hcd->localmem_pool = devm_gen_pool_create(hcd->self.sysdev, 4,
3091 dev_to_node(hcd->self.sysdev),
3092 dev_name(hcd->self.sysdev));
3093 if (IS_ERR(hcd->localmem_pool))
3094 return PTR_ERR(hcd->localmem_pool);
3097 * if a physical SRAM address was passed, map it, otherwise
3098 * allocate system memory as a buffer.
3101 local_mem = devm_memremap(hcd->self.sysdev, phys_addr,
3104 local_mem = dmam_alloc_attrs(hcd->self.sysdev, size, &dma,
3106 DMA_ATTR_WRITE_COMBINE);
3108 if (IS_ERR_OR_NULL(local_mem)) {
3112 return PTR_ERR(local_mem);
3116 * Here we pass a dma_addr_t but the arg type is a phys_addr_t.
3117 * It's not backed by system memory and thus there's no kernel mapping
3120 err = gen_pool_add_virt(hcd->localmem_pool, (unsigned long)local_mem,
3121 dma, size, dev_to_node(hcd->self.sysdev));
3123 dev_err(hcd->self.sysdev, "gen_pool_add_virt failed with %d\n",
3130 EXPORT_SYMBOL_GPL(usb_hcd_setup_local_mem);
3132 /*-------------------------------------------------------------------------*/
3134 #if IS_ENABLED(CONFIG_USB_MON)
3136 const struct usb_mon_operations *mon_ops;
3139 * The registration is unlocked.
3140 * We do it this way because we do not want to lock in hot paths.
3142 * Notice that the code is minimally error-proof. Because usbmon needs
3143 * symbols from usbcore, usbcore gets referenced and cannot be unloaded first.
3146 int usb_mon_register(const struct usb_mon_operations *ops)
3156 EXPORT_SYMBOL_GPL (usb_mon_register);
3158 void usb_mon_deregister (void)
3161 if (mon_ops == NULL) {
3162 printk(KERN_ERR "USB: monitor was not registered\n");
3168 EXPORT_SYMBOL_GPL (usb_mon_deregister);
3170 #endif /* CONFIG_USB_MON || CONFIG_USB_MON_MODULE */