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_CODE >> 16) & 0x0ff))
115 #define KERNEL_VER bin2bcd(((LINUX_VERSION_CODE >> 8) & 0x0ff))
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.5 (wireless USB 1.0) root hub device descriptor */
160 static const u8 usb25_rh_dev_descriptor[18] = {
161 0x12, /* __u8 bLength; */
162 USB_DT_DEVICE, /* __u8 bDescriptorType; Device */
163 0x50, 0x02, /* __le16 bcdUSB; v2.5 */
165 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
166 0x00, /* __u8 bDeviceSubClass; */
167 0x00, /* __u8 bDeviceProtocol; [ usb 2.0 no TT ] */
168 0xFF, /* __u8 bMaxPacketSize0; always 0xFF (WUSB Spec 7.4.1). */
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 /* usb 2.0 root hub device descriptor */
181 static const u8 usb2_rh_dev_descriptor[18] = {
182 0x12, /* __u8 bLength; */
183 USB_DT_DEVICE, /* __u8 bDescriptorType; Device */
184 0x00, 0x02, /* __le16 bcdUSB; v2.0 */
186 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
187 0x00, /* __u8 bDeviceSubClass; */
188 0x00, /* __u8 bDeviceProtocol; [ usb 2.0 no TT ] */
189 0x40, /* __u8 bMaxPacketSize0; 64 Bytes */
191 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation 0x1d6b */
192 0x02, 0x00, /* __le16 idProduct; device 0x0002 */
193 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
195 0x03, /* __u8 iManufacturer; */
196 0x02, /* __u8 iProduct; */
197 0x01, /* __u8 iSerialNumber; */
198 0x01 /* __u8 bNumConfigurations; */
201 /* no usb 2.0 root hub "device qualifier" descriptor: one speed only */
203 /* usb 1.1 root hub device descriptor */
204 static const u8 usb11_rh_dev_descriptor[18] = {
205 0x12, /* __u8 bLength; */
206 USB_DT_DEVICE, /* __u8 bDescriptorType; Device */
207 0x10, 0x01, /* __le16 bcdUSB; v1.1 */
209 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
210 0x00, /* __u8 bDeviceSubClass; */
211 0x00, /* __u8 bDeviceProtocol; [ low/full speeds only ] */
212 0x40, /* __u8 bMaxPacketSize0; 64 Bytes */
214 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation 0x1d6b */
215 0x01, 0x00, /* __le16 idProduct; device 0x0001 */
216 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
218 0x03, /* __u8 iManufacturer; */
219 0x02, /* __u8 iProduct; */
220 0x01, /* __u8 iSerialNumber; */
221 0x01 /* __u8 bNumConfigurations; */
225 /*-------------------------------------------------------------------------*/
227 /* Configuration descriptors for our root hubs */
229 static const u8 fs_rh_config_descriptor[] = {
231 /* one configuration */
232 0x09, /* __u8 bLength; */
233 USB_DT_CONFIG, /* __u8 bDescriptorType; Configuration */
234 0x19, 0x00, /* __le16 wTotalLength; */
235 0x01, /* __u8 bNumInterfaces; (1) */
236 0x01, /* __u8 bConfigurationValue; */
237 0x00, /* __u8 iConfiguration; */
238 0xc0, /* __u8 bmAttributes;
243 0x00, /* __u8 MaxPower; */
246 * USB 2.0, single TT organization (mandatory):
247 * one interface, protocol 0
249 * USB 2.0, multiple TT organization (optional):
250 * two interfaces, protocols 1 (like single TT)
251 * and 2 (multiple TT mode) ... config is
257 0x09, /* __u8 if_bLength; */
258 USB_DT_INTERFACE, /* __u8 if_bDescriptorType; Interface */
259 0x00, /* __u8 if_bInterfaceNumber; */
260 0x00, /* __u8 if_bAlternateSetting; */
261 0x01, /* __u8 if_bNumEndpoints; */
262 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
263 0x00, /* __u8 if_bInterfaceSubClass; */
264 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
265 0x00, /* __u8 if_iInterface; */
267 /* one endpoint (status change endpoint) */
268 0x07, /* __u8 ep_bLength; */
269 USB_DT_ENDPOINT, /* __u8 ep_bDescriptorType; Endpoint */
270 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
271 0x03, /* __u8 ep_bmAttributes; Interrupt */
272 0x02, 0x00, /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8) */
273 0xff /* __u8 ep_bInterval; (255ms -- usb 2.0 spec) */
276 static const u8 hs_rh_config_descriptor[] = {
278 /* one configuration */
279 0x09, /* __u8 bLength; */
280 USB_DT_CONFIG, /* __u8 bDescriptorType; Configuration */
281 0x19, 0x00, /* __le16 wTotalLength; */
282 0x01, /* __u8 bNumInterfaces; (1) */
283 0x01, /* __u8 bConfigurationValue; */
284 0x00, /* __u8 iConfiguration; */
285 0xc0, /* __u8 bmAttributes;
290 0x00, /* __u8 MaxPower; */
293 * USB 2.0, single TT organization (mandatory):
294 * one interface, protocol 0
296 * USB 2.0, multiple TT organization (optional):
297 * two interfaces, protocols 1 (like single TT)
298 * and 2 (multiple TT mode) ... config is
304 0x09, /* __u8 if_bLength; */
305 USB_DT_INTERFACE, /* __u8 if_bDescriptorType; Interface */
306 0x00, /* __u8 if_bInterfaceNumber; */
307 0x00, /* __u8 if_bAlternateSetting; */
308 0x01, /* __u8 if_bNumEndpoints; */
309 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
310 0x00, /* __u8 if_bInterfaceSubClass; */
311 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
312 0x00, /* __u8 if_iInterface; */
314 /* one endpoint (status change endpoint) */
315 0x07, /* __u8 ep_bLength; */
316 USB_DT_ENDPOINT, /* __u8 ep_bDescriptorType; Endpoint */
317 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
318 0x03, /* __u8 ep_bmAttributes; Interrupt */
319 /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8)
320 * see hub.c:hub_configure() for details. */
321 (USB_MAXCHILDREN + 1 + 7) / 8, 0x00,
322 0x0c /* __u8 ep_bInterval; (256ms -- usb 2.0 spec) */
325 static const u8 ss_rh_config_descriptor[] = {
326 /* one configuration */
327 0x09, /* __u8 bLength; */
328 USB_DT_CONFIG, /* __u8 bDescriptorType; Configuration */
329 0x1f, 0x00, /* __le16 wTotalLength; */
330 0x01, /* __u8 bNumInterfaces; (1) */
331 0x01, /* __u8 bConfigurationValue; */
332 0x00, /* __u8 iConfiguration; */
333 0xc0, /* __u8 bmAttributes;
338 0x00, /* __u8 MaxPower; */
341 0x09, /* __u8 if_bLength; */
342 USB_DT_INTERFACE, /* __u8 if_bDescriptorType; Interface */
343 0x00, /* __u8 if_bInterfaceNumber; */
344 0x00, /* __u8 if_bAlternateSetting; */
345 0x01, /* __u8 if_bNumEndpoints; */
346 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
347 0x00, /* __u8 if_bInterfaceSubClass; */
348 0x00, /* __u8 if_bInterfaceProtocol; */
349 0x00, /* __u8 if_iInterface; */
351 /* one endpoint (status change endpoint) */
352 0x07, /* __u8 ep_bLength; */
353 USB_DT_ENDPOINT, /* __u8 ep_bDescriptorType; Endpoint */
354 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
355 0x03, /* __u8 ep_bmAttributes; Interrupt */
356 /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8)
357 * see hub.c:hub_configure() for details. */
358 (USB_MAXCHILDREN + 1 + 7) / 8, 0x00,
359 0x0c, /* __u8 ep_bInterval; (256ms -- usb 2.0 spec) */
361 /* one SuperSpeed endpoint companion descriptor */
362 0x06, /* __u8 ss_bLength */
363 USB_DT_SS_ENDPOINT_COMP, /* __u8 ss_bDescriptorType; SuperSpeed EP */
365 0x00, /* __u8 ss_bMaxBurst; allows 1 TX between ACKs */
366 0x00, /* __u8 ss_bmAttributes; 1 packet per service interval */
367 0x02, 0x00 /* __le16 ss_wBytesPerInterval; 15 bits for max 15 ports */
370 /* authorized_default behaviour:
371 * -1 is authorized for all devices except wireless (old behaviour)
372 * 0 is unauthorized for all devices
373 * 1 is authorized for all devices
374 * 2 is authorized for internal devices
376 #define USB_AUTHORIZE_WIRED -1
377 #define USB_AUTHORIZE_NONE 0
378 #define USB_AUTHORIZE_ALL 1
379 #define USB_AUTHORIZE_INTERNAL 2
381 static int authorized_default = USB_AUTHORIZE_WIRED;
382 module_param(authorized_default, int, S_IRUGO|S_IWUSR);
383 MODULE_PARM_DESC(authorized_default,
384 "Default USB device authorization: 0 is not authorized, 1 is "
385 "authorized, 2 is authorized for internal devices, -1 is "
386 "authorized except for wireless USB (default, old behaviour)");
387 /*-------------------------------------------------------------------------*/
390 * ascii2desc() - Helper routine for producing UTF-16LE string descriptors
391 * @s: Null-terminated ASCII (actually ISO-8859-1) string
392 * @buf: Buffer for USB string descriptor (header + UTF-16LE)
393 * @len: Length (in bytes; may be odd) of descriptor buffer.
395 * Return: The number of bytes filled in: 2 + 2*strlen(s) or @len,
399 * USB String descriptors can contain at most 126 characters; input
400 * strings longer than that are truncated.
403 ascii2desc(char const *s, u8 *buf, unsigned len)
405 unsigned n, t = 2 + 2*strlen(s);
408 t = 254; /* Longest possible UTF string descriptor */
412 t += USB_DT_STRING << 8; /* Now t is first 16 bits to store */
420 t = (unsigned char)*s++;
426 * rh_string() - provides string descriptors for root hub
427 * @id: the string ID number (0: langids, 1: serial #, 2: product, 3: vendor)
428 * @hcd: the host controller for this root hub
429 * @data: buffer for output packet
430 * @len: length of the provided buffer
432 * Produces either a manufacturer, product or serial number string for the
433 * virtual root hub device.
435 * Return: The number of bytes filled in: the length of the descriptor or
436 * of the provided buffer, whichever is less.
439 rh_string(int id, struct usb_hcd const *hcd, u8 *data, unsigned len)
443 static char const langids[4] = {4, USB_DT_STRING, 0x09, 0x04};
448 /* Array of LANGID codes (0x0409 is MSFT-speak for "en-us") */
449 /* See http://www.usb.org/developers/docs/USB_LANGIDs.pdf */
452 memcpy(data, langids, len);
456 s = hcd->self.bus_name;
460 s = hcd->product_desc;
464 snprintf (buf, sizeof buf, "%s %s %s", init_utsname()->sysname,
465 init_utsname()->release, hcd->driver->description);
469 /* Can't happen; caller guarantees it */
473 return ascii2desc(s, data, len);
477 /* Root hub control transfers execute synchronously */
478 static int rh_call_control (struct usb_hcd *hcd, struct urb *urb)
480 struct usb_ctrlrequest *cmd;
481 u16 typeReq, wValue, wIndex, wLength;
482 u8 *ubuf = urb->transfer_buffer;
486 u8 patch_protocol = 0;
493 spin_lock_irq(&hcd_root_hub_lock);
494 status = usb_hcd_link_urb_to_ep(hcd, urb);
495 spin_unlock_irq(&hcd_root_hub_lock);
498 urb->hcpriv = hcd; /* Indicate it's queued */
500 cmd = (struct usb_ctrlrequest *) urb->setup_packet;
501 typeReq = (cmd->bRequestType << 8) | cmd->bRequest;
502 wValue = le16_to_cpu (cmd->wValue);
503 wIndex = le16_to_cpu (cmd->wIndex);
504 wLength = le16_to_cpu (cmd->wLength);
506 if (wLength > urb->transfer_buffer_length)
510 * tbuf should be at least as big as the
511 * USB hub descriptor.
513 tbuf_size = max_t(u16, sizeof(struct usb_hub_descriptor), wLength);
514 tbuf = kzalloc(tbuf_size, GFP_KERNEL);
523 urb->actual_length = 0;
526 /* DEVICE REQUESTS */
528 /* The root hub's remote wakeup enable bit is implemented using
529 * driver model wakeup flags. If this system supports wakeup
530 * through USB, userspace may change the default "allow wakeup"
531 * policy through sysfs or these calls.
533 * Most root hubs support wakeup from downstream devices, for
534 * runtime power management (disabling USB clocks and reducing
535 * VBUS power usage). However, not all of them do so; silicon,
536 * board, and BIOS bugs here are not uncommon, so these can't
537 * be treated quite like external hubs.
539 * Likewise, not all root hubs will pass wakeup events upstream,
540 * to wake up the whole system. So don't assume root hub and
541 * controller capabilities are identical.
544 case DeviceRequest | USB_REQ_GET_STATUS:
545 tbuf[0] = (device_may_wakeup(&hcd->self.root_hub->dev)
546 << USB_DEVICE_REMOTE_WAKEUP)
547 | (1 << USB_DEVICE_SELF_POWERED);
551 case DeviceOutRequest | USB_REQ_CLEAR_FEATURE:
552 if (wValue == USB_DEVICE_REMOTE_WAKEUP)
553 device_set_wakeup_enable(&hcd->self.root_hub->dev, 0);
557 case DeviceOutRequest | USB_REQ_SET_FEATURE:
558 if (device_can_wakeup(&hcd->self.root_hub->dev)
559 && wValue == USB_DEVICE_REMOTE_WAKEUP)
560 device_set_wakeup_enable(&hcd->self.root_hub->dev, 1);
564 case DeviceRequest | USB_REQ_GET_CONFIGURATION:
568 case DeviceOutRequest | USB_REQ_SET_CONFIGURATION:
570 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
571 switch (wValue & 0xff00) {
572 case USB_DT_DEVICE << 8:
573 switch (hcd->speed) {
576 bufp = usb31_rh_dev_descriptor;
579 bufp = usb3_rh_dev_descriptor;
582 bufp = usb25_rh_dev_descriptor;
585 bufp = usb2_rh_dev_descriptor;
588 bufp = usb11_rh_dev_descriptor;
597 case USB_DT_CONFIG << 8:
598 switch (hcd->speed) {
602 bufp = ss_rh_config_descriptor;
603 len = sizeof ss_rh_config_descriptor;
607 bufp = hs_rh_config_descriptor;
608 len = sizeof hs_rh_config_descriptor;
611 bufp = fs_rh_config_descriptor;
612 len = sizeof fs_rh_config_descriptor;
617 if (device_can_wakeup(&hcd->self.root_hub->dev))
620 case USB_DT_STRING << 8:
621 if ((wValue & 0xff) < 4)
622 urb->actual_length = rh_string(wValue & 0xff,
624 else /* unsupported IDs --> "protocol stall" */
627 case USB_DT_BOS << 8:
633 case DeviceRequest | USB_REQ_GET_INTERFACE:
637 case DeviceOutRequest | USB_REQ_SET_INTERFACE:
639 case DeviceOutRequest | USB_REQ_SET_ADDRESS:
640 /* wValue == urb->dev->devaddr */
641 dev_dbg (hcd->self.controller, "root hub device address %d\n",
645 /* INTERFACE REQUESTS (no defined feature/status flags) */
647 /* ENDPOINT REQUESTS */
649 case EndpointRequest | USB_REQ_GET_STATUS:
650 /* ENDPOINT_HALT flag */
655 case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
656 case EndpointOutRequest | USB_REQ_SET_FEATURE:
657 dev_dbg (hcd->self.controller, "no endpoint features yet\n");
660 /* CLASS REQUESTS (and errors) */
664 /* non-generic request */
670 if (wValue == HUB_PORT_STATUS)
673 /* other port status types return 8 bytes */
676 case GetHubDescriptor:
677 len = sizeof (struct usb_hub_descriptor);
679 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
680 /* len is returned by hub_control */
683 status = hcd->driver->hub_control (hcd,
684 typeReq, wValue, wIndex,
687 if (typeReq == GetHubDescriptor)
688 usb_hub_adjust_deviceremovable(hcd->self.root_hub,
689 (struct usb_hub_descriptor *)tbuf);
692 /* "protocol stall" on error */
698 if (status != -EPIPE) {
699 dev_dbg (hcd->self.controller,
700 "CTRL: TypeReq=0x%x val=0x%x "
701 "idx=0x%x len=%d ==> %d\n",
702 typeReq, wValue, wIndex,
705 } else if (status > 0) {
706 /* hub_control may return the length of data copied. */
711 if (urb->transfer_buffer_length < len)
712 len = urb->transfer_buffer_length;
713 urb->actual_length = len;
714 /* always USB_DIR_IN, toward host */
715 memcpy (ubuf, bufp, len);
717 /* report whether RH hardware supports remote wakeup */
719 len > offsetof (struct usb_config_descriptor,
721 ((struct usb_config_descriptor *)ubuf)->bmAttributes
722 |= USB_CONFIG_ATT_WAKEUP;
724 /* report whether RH hardware has an integrated TT */
725 if (patch_protocol &&
726 len > offsetof(struct usb_device_descriptor,
728 ((struct usb_device_descriptor *) ubuf)->
729 bDeviceProtocol = USB_HUB_PR_HS_SINGLE_TT;
735 /* any errors get returned through the urb completion */
736 spin_lock_irq(&hcd_root_hub_lock);
737 usb_hcd_unlink_urb_from_ep(hcd, urb);
738 usb_hcd_giveback_urb(hcd, urb, status);
739 spin_unlock_irq(&hcd_root_hub_lock);
743 /*-------------------------------------------------------------------------*/
746 * Root Hub interrupt transfers are polled using a timer if the
747 * driver requests it; otherwise the driver is responsible for
748 * calling usb_hcd_poll_rh_status() when an event occurs.
750 * Completions are called in_interrupt(), but they may or may not
753 void usb_hcd_poll_rh_status(struct usb_hcd *hcd)
759 char buffer[6]; /* Any root hubs with > 31 ports? */
761 if (unlikely(!hcd->rh_pollable))
763 if (!hcd->uses_new_polling && !hcd->status_urb)
766 length = hcd->driver->hub_status_data(hcd, buffer);
769 /* try to complete the status urb */
770 spin_lock_irqsave(&hcd_root_hub_lock, flags);
771 urb = hcd->status_urb;
773 clear_bit(HCD_FLAG_POLL_PENDING, &hcd->flags);
774 hcd->status_urb = NULL;
775 if (urb->transfer_buffer_length >= length) {
779 length = urb->transfer_buffer_length;
781 urb->actual_length = length;
782 memcpy(urb->transfer_buffer, buffer, length);
784 usb_hcd_unlink_urb_from_ep(hcd, urb);
785 usb_hcd_giveback_urb(hcd, urb, status);
788 set_bit(HCD_FLAG_POLL_PENDING, &hcd->flags);
790 spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
793 /* The USB 2.0 spec says 256 ms. This is close enough and won't
794 * exceed that limit if HZ is 100. The math is more clunky than
795 * maybe expected, this is to make sure that all timers for USB devices
796 * fire at the same time to give the CPU a break in between */
797 if (hcd->uses_new_polling ? HCD_POLL_RH(hcd) :
798 (length == 0 && hcd->status_urb != NULL))
799 mod_timer (&hcd->rh_timer, (jiffies/(HZ/4) + 1) * (HZ/4));
801 EXPORT_SYMBOL_GPL(usb_hcd_poll_rh_status);
804 static void rh_timer_func (struct timer_list *t)
806 struct usb_hcd *_hcd = from_timer(_hcd, t, rh_timer);
808 usb_hcd_poll_rh_status(_hcd);
811 /*-------------------------------------------------------------------------*/
813 static int rh_queue_status (struct usb_hcd *hcd, struct urb *urb)
817 unsigned len = 1 + (urb->dev->maxchild / 8);
819 spin_lock_irqsave (&hcd_root_hub_lock, flags);
820 if (hcd->status_urb || urb->transfer_buffer_length < len) {
821 dev_dbg (hcd->self.controller, "not queuing rh status urb\n");
826 retval = usb_hcd_link_urb_to_ep(hcd, urb);
830 hcd->status_urb = urb;
831 urb->hcpriv = hcd; /* indicate it's queued */
832 if (!hcd->uses_new_polling)
833 mod_timer(&hcd->rh_timer, (jiffies/(HZ/4) + 1) * (HZ/4));
835 /* If a status change has already occurred, report it ASAP */
836 else if (HCD_POLL_PENDING(hcd))
837 mod_timer(&hcd->rh_timer, jiffies);
840 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
844 static int rh_urb_enqueue (struct usb_hcd *hcd, struct urb *urb)
846 if (usb_endpoint_xfer_int(&urb->ep->desc))
847 return rh_queue_status (hcd, urb);
848 if (usb_endpoint_xfer_control(&urb->ep->desc))
849 return rh_call_control (hcd, urb);
853 /*-------------------------------------------------------------------------*/
855 /* Unlinks of root-hub control URBs are legal, but they don't do anything
856 * since these URBs always execute synchronously.
858 static int usb_rh_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
863 spin_lock_irqsave(&hcd_root_hub_lock, flags);
864 rc = usb_hcd_check_unlink_urb(hcd, urb, status);
868 if (usb_endpoint_num(&urb->ep->desc) == 0) { /* Control URB */
871 } else { /* Status URB */
872 if (!hcd->uses_new_polling)
873 del_timer (&hcd->rh_timer);
874 if (urb == hcd->status_urb) {
875 hcd->status_urb = NULL;
876 usb_hcd_unlink_urb_from_ep(hcd, urb);
877 usb_hcd_giveback_urb(hcd, urb, status);
881 spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
886 /*-------------------------------------------------------------------------*/
889 * usb_bus_init - shared initialization code
890 * @bus: the bus structure being initialized
892 * This code is used to initialize a usb_bus structure, memory for which is
893 * separately managed.
895 static void usb_bus_init (struct usb_bus *bus)
897 memset (&bus->devmap, 0, sizeof(struct usb_devmap));
899 bus->devnum_next = 1;
901 bus->root_hub = NULL;
903 bus->bandwidth_allocated = 0;
904 bus->bandwidth_int_reqs = 0;
905 bus->bandwidth_isoc_reqs = 0;
906 mutex_init(&bus->devnum_next_mutex);
909 /*-------------------------------------------------------------------------*/
912 * usb_register_bus - registers the USB host controller with the usb core
913 * @bus: pointer to the bus to register
914 * Context: !in_interrupt()
916 * Assigns a bus number, and links the controller into usbcore data
917 * structures so that it can be seen by scanning the bus list.
919 * Return: 0 if successful. A negative error code otherwise.
921 static int usb_register_bus(struct usb_bus *bus)
926 mutex_lock(&usb_bus_idr_lock);
927 busnum = idr_alloc(&usb_bus_idr, bus, 1, USB_MAXBUS, GFP_KERNEL);
929 pr_err("%s: failed to get bus number\n", usbcore_name);
930 goto error_find_busnum;
932 bus->busnum = busnum;
933 mutex_unlock(&usb_bus_idr_lock);
935 usb_notify_add_bus(bus);
937 dev_info (bus->controller, "new USB bus registered, assigned bus "
938 "number %d\n", bus->busnum);
942 mutex_unlock(&usb_bus_idr_lock);
947 * usb_deregister_bus - deregisters the USB host controller
948 * @bus: pointer to the bus to deregister
949 * Context: !in_interrupt()
951 * Recycles the bus number, and unlinks the controller from usbcore data
952 * structures so that it won't be seen by scanning the bus list.
954 static void usb_deregister_bus (struct usb_bus *bus)
956 dev_info (bus->controller, "USB bus %d deregistered\n", bus->busnum);
959 * NOTE: make sure that all the devices are removed by the
960 * controller code, as well as having it call this when cleaning
963 mutex_lock(&usb_bus_idr_lock);
964 idr_remove(&usb_bus_idr, bus->busnum);
965 mutex_unlock(&usb_bus_idr_lock);
967 usb_notify_remove_bus(bus);
971 * register_root_hub - called by usb_add_hcd() to register a root hub
972 * @hcd: host controller for this root hub
974 * This function registers the root hub with the USB subsystem. It sets up
975 * the device properly in the device tree and then calls usb_new_device()
976 * to register the usb device. It also assigns the root hub's USB address
979 * Return: 0 if successful. A negative error code otherwise.
981 static int register_root_hub(struct usb_hcd *hcd)
983 struct device *parent_dev = hcd->self.controller;
984 struct usb_device *usb_dev = hcd->self.root_hub;
985 struct usb_device_descriptor *descr;
986 const int devnum = 1;
989 usb_dev->devnum = devnum;
990 usb_dev->bus->devnum_next = devnum + 1;
991 set_bit (devnum, usb_dev->bus->devmap.devicemap);
992 usb_set_device_state(usb_dev, USB_STATE_ADDRESS);
994 mutex_lock(&usb_bus_idr_lock);
996 usb_dev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
997 descr = usb_get_device_descriptor(usb_dev);
999 retval = PTR_ERR(descr);
1000 mutex_unlock(&usb_bus_idr_lock);
1001 dev_dbg (parent_dev, "can't read %s device descriptor %d\n",
1002 dev_name(&usb_dev->dev), retval);
1005 usb_dev->descriptor = *descr;
1008 if (le16_to_cpu(usb_dev->descriptor.bcdUSB) >= 0x0201) {
1009 retval = usb_get_bos_descriptor(usb_dev);
1011 usb_dev->lpm_capable = usb_device_supports_lpm(usb_dev);
1012 } else if (usb_dev->speed >= USB_SPEED_SUPER) {
1013 mutex_unlock(&usb_bus_idr_lock);
1014 dev_dbg(parent_dev, "can't read %s bos descriptor %d\n",
1015 dev_name(&usb_dev->dev), retval);
1020 retval = usb_new_device (usb_dev);
1022 dev_err (parent_dev, "can't register root hub for %s, %d\n",
1023 dev_name(&usb_dev->dev), retval);
1025 spin_lock_irq (&hcd_root_hub_lock);
1026 hcd->rh_registered = 1;
1027 spin_unlock_irq (&hcd_root_hub_lock);
1029 /* Did the HC die before the root hub was registered? */
1031 usb_hc_died (hcd); /* This time clean up */
1033 mutex_unlock(&usb_bus_idr_lock);
1039 * usb_hcd_start_port_resume - a root-hub port is sending a resume signal
1040 * @bus: the bus which the root hub belongs to
1041 * @portnum: the port which is being resumed
1043 * HCDs should call this function when they know that a resume signal is
1044 * being sent to a root-hub port. The root hub will be prevented from
1045 * going into autosuspend until usb_hcd_end_port_resume() is called.
1047 * The bus's private lock must be held by the caller.
1049 void usb_hcd_start_port_resume(struct usb_bus *bus, int portnum)
1051 unsigned bit = 1 << portnum;
1053 if (!(bus->resuming_ports & bit)) {
1054 bus->resuming_ports |= bit;
1055 pm_runtime_get_noresume(&bus->root_hub->dev);
1058 EXPORT_SYMBOL_GPL(usb_hcd_start_port_resume);
1061 * usb_hcd_end_port_resume - a root-hub port has stopped sending a resume signal
1062 * @bus: the bus which the root hub belongs to
1063 * @portnum: the port which is being resumed
1065 * HCDs should call this function when they know that a resume signal has
1066 * stopped being sent to a root-hub port. The root hub will be allowed to
1067 * autosuspend again.
1069 * The bus's private lock must be held by the caller.
1071 void usb_hcd_end_port_resume(struct usb_bus *bus, int portnum)
1073 unsigned bit = 1 << portnum;
1075 if (bus->resuming_ports & bit) {
1076 bus->resuming_ports &= ~bit;
1077 pm_runtime_put_noidle(&bus->root_hub->dev);
1080 EXPORT_SYMBOL_GPL(usb_hcd_end_port_resume);
1082 /*-------------------------------------------------------------------------*/
1085 * usb_calc_bus_time - approximate periodic transaction time in nanoseconds
1086 * @speed: from dev->speed; USB_SPEED_{LOW,FULL,HIGH}
1087 * @is_input: true iff the transaction sends data to the host
1088 * @isoc: true for isochronous transactions, false for interrupt ones
1089 * @bytecount: how many bytes in the transaction.
1091 * Return: Approximate bus time in nanoseconds for a periodic transaction.
1094 * See USB 2.0 spec section 5.11.3; only periodic transfers need to be
1095 * scheduled in software, this function is only used for such scheduling.
1097 long usb_calc_bus_time (int speed, int is_input, int isoc, int bytecount)
1102 case USB_SPEED_LOW: /* INTR only */
1104 tmp = (67667L * (31L + 10L * BitTime (bytecount))) / 1000L;
1105 return 64060L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp;
1107 tmp = (66700L * (31L + 10L * BitTime (bytecount))) / 1000L;
1108 return 64107L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp;
1110 case USB_SPEED_FULL: /* ISOC or INTR */
1112 tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
1113 return ((is_input) ? 7268L : 6265L) + BW_HOST_DELAY + tmp;
1115 tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
1116 return 9107L + BW_HOST_DELAY + tmp;
1118 case USB_SPEED_HIGH: /* ISOC or INTR */
1119 /* FIXME adjust for input vs output */
1121 tmp = HS_NSECS_ISO (bytecount);
1123 tmp = HS_NSECS (bytecount);
1126 pr_debug ("%s: bogus device speed!\n", usbcore_name);
1130 EXPORT_SYMBOL_GPL(usb_calc_bus_time);
1133 /*-------------------------------------------------------------------------*/
1136 * Generic HC operations.
1139 /*-------------------------------------------------------------------------*/
1142 * usb_hcd_link_urb_to_ep - add an URB to its endpoint queue
1143 * @hcd: host controller to which @urb was submitted
1144 * @urb: URB being submitted
1146 * Host controller drivers should call this routine in their enqueue()
1147 * method. The HCD's private spinlock must be held and interrupts must
1148 * be disabled. The actions carried out here are required for URB
1149 * submission, as well as for endpoint shutdown and for usb_kill_urb.
1151 * Return: 0 for no error, otherwise a negative error code (in which case
1152 * the enqueue() method must fail). If no error occurs but enqueue() fails
1153 * anyway, it must call usb_hcd_unlink_urb_from_ep() before releasing
1154 * the private spinlock and returning.
1156 int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb)
1160 spin_lock(&hcd_urb_list_lock);
1162 /* Check that the URB isn't being killed */
1163 if (unlikely(atomic_read(&urb->reject))) {
1168 if (unlikely(!urb->ep->enabled)) {
1173 if (unlikely(!urb->dev->can_submit)) {
1179 * Check the host controller's state and add the URB to the
1182 if (HCD_RH_RUNNING(hcd)) {
1184 list_add_tail(&urb->urb_list, &urb->ep->urb_list);
1190 spin_unlock(&hcd_urb_list_lock);
1193 EXPORT_SYMBOL_GPL(usb_hcd_link_urb_to_ep);
1196 * usb_hcd_check_unlink_urb - check whether an URB may be unlinked
1197 * @hcd: host controller to which @urb was submitted
1198 * @urb: URB being checked for unlinkability
1199 * @status: error code to store in @urb if the unlink succeeds
1201 * Host controller drivers should call this routine in their dequeue()
1202 * method. The HCD's private spinlock must be held and interrupts must
1203 * be disabled. The actions carried out here are required for making
1204 * sure than an unlink is valid.
1206 * Return: 0 for no error, otherwise a negative error code (in which case
1207 * the dequeue() method must fail). The possible error codes are:
1209 * -EIDRM: @urb was not submitted or has already completed.
1210 * The completion function may not have been called yet.
1212 * -EBUSY: @urb has already been unlinked.
1214 int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb,
1217 struct list_head *tmp;
1219 /* insist the urb is still queued */
1220 list_for_each(tmp, &urb->ep->urb_list) {
1221 if (tmp == &urb->urb_list)
1224 if (tmp != &urb->urb_list)
1227 /* Any status except -EINPROGRESS means something already started to
1228 * unlink this URB from the hardware. So there's no more work to do.
1232 urb->unlinked = status;
1235 EXPORT_SYMBOL_GPL(usb_hcd_check_unlink_urb);
1238 * usb_hcd_unlink_urb_from_ep - remove an URB from its endpoint queue
1239 * @hcd: host controller to which @urb was submitted
1240 * @urb: URB being unlinked
1242 * Host controller drivers should call this routine before calling
1243 * usb_hcd_giveback_urb(). The HCD's private spinlock must be held and
1244 * interrupts must be disabled. The actions carried out here are required
1245 * for URB completion.
1247 void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb)
1249 /* clear all state linking urb to this dev (and hcd) */
1250 spin_lock(&hcd_urb_list_lock);
1251 list_del_init(&urb->urb_list);
1252 spin_unlock(&hcd_urb_list_lock);
1254 EXPORT_SYMBOL_GPL(usb_hcd_unlink_urb_from_ep);
1257 * Some usb host controllers can only perform dma using a small SRAM area.
1258 * The usb core itself is however optimized for host controllers that can dma
1259 * using regular system memory - like pci devices doing bus mastering.
1261 * To support host controllers with limited dma capabilities we provide dma
1262 * bounce buffers. This feature can be enabled by initializing
1263 * hcd->localmem_pool using usb_hcd_setup_local_mem().
1265 * The initialized hcd->localmem_pool then tells the usb code to allocate all
1266 * data for dma using the genalloc API.
1268 * So, to summarize...
1270 * - We need "local" memory, canonical example being
1271 * a small SRAM on a discrete controller being the
1272 * only memory that the controller can read ...
1273 * (a) "normal" kernel memory is no good, and
1274 * (b) there's not enough to share
1276 * - So we use that, even though the primary requirement
1277 * is that the memory be "local" (hence addressable
1278 * by that device), not "coherent".
1282 static int hcd_alloc_coherent(struct usb_bus *bus,
1283 gfp_t mem_flags, dma_addr_t *dma_handle,
1284 void **vaddr_handle, size_t size,
1285 enum dma_data_direction dir)
1287 unsigned char *vaddr;
1289 if (*vaddr_handle == NULL) {
1294 vaddr = hcd_buffer_alloc(bus, size + sizeof(vaddr),
1295 mem_flags, dma_handle);
1300 * Store the virtual address of the buffer at the end
1301 * of the allocated dma buffer. The size of the buffer
1302 * may be uneven so use unaligned functions instead
1303 * of just rounding up. It makes sense to optimize for
1304 * memory footprint over access speed since the amount
1305 * of memory available for dma may be limited.
1307 put_unaligned((unsigned long)*vaddr_handle,
1308 (unsigned long *)(vaddr + size));
1310 if (dir == DMA_TO_DEVICE)
1311 memcpy(vaddr, *vaddr_handle, size);
1313 *vaddr_handle = vaddr;
1317 static void hcd_free_coherent(struct usb_bus *bus, dma_addr_t *dma_handle,
1318 void **vaddr_handle, size_t size,
1319 enum dma_data_direction dir)
1321 unsigned char *vaddr = *vaddr_handle;
1323 vaddr = (void *)get_unaligned((unsigned long *)(vaddr + size));
1325 if (dir == DMA_FROM_DEVICE)
1326 memcpy(vaddr, *vaddr_handle, size);
1328 hcd_buffer_free(bus, size + sizeof(vaddr), *vaddr_handle, *dma_handle);
1330 *vaddr_handle = vaddr;
1334 void usb_hcd_unmap_urb_setup_for_dma(struct usb_hcd *hcd, struct urb *urb)
1336 if (IS_ENABLED(CONFIG_HAS_DMA) &&
1337 (urb->transfer_flags & URB_SETUP_MAP_SINGLE))
1338 dma_unmap_single(hcd->self.sysdev,
1340 sizeof(struct usb_ctrlrequest),
1342 else if (urb->transfer_flags & URB_SETUP_MAP_LOCAL)
1343 hcd_free_coherent(urb->dev->bus,
1345 (void **) &urb->setup_packet,
1346 sizeof(struct usb_ctrlrequest),
1349 /* Make it safe to call this routine more than once */
1350 urb->transfer_flags &= ~(URB_SETUP_MAP_SINGLE | URB_SETUP_MAP_LOCAL);
1352 EXPORT_SYMBOL_GPL(usb_hcd_unmap_urb_setup_for_dma);
1354 static void unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
1356 if (hcd->driver->unmap_urb_for_dma)
1357 hcd->driver->unmap_urb_for_dma(hcd, urb);
1359 usb_hcd_unmap_urb_for_dma(hcd, urb);
1362 void usb_hcd_unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
1364 enum dma_data_direction dir;
1366 usb_hcd_unmap_urb_setup_for_dma(hcd, urb);
1368 dir = usb_urb_dir_in(urb) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
1369 if (IS_ENABLED(CONFIG_HAS_DMA) &&
1370 (urb->transfer_flags & URB_DMA_MAP_SG))
1371 dma_unmap_sg(hcd->self.sysdev,
1375 else if (IS_ENABLED(CONFIG_HAS_DMA) &&
1376 (urb->transfer_flags & URB_DMA_MAP_PAGE))
1377 dma_unmap_page(hcd->self.sysdev,
1379 urb->transfer_buffer_length,
1381 else if (IS_ENABLED(CONFIG_HAS_DMA) &&
1382 (urb->transfer_flags & URB_DMA_MAP_SINGLE))
1383 dma_unmap_single(hcd->self.sysdev,
1385 urb->transfer_buffer_length,
1387 else if (urb->transfer_flags & URB_MAP_LOCAL)
1388 hcd_free_coherent(urb->dev->bus,
1390 &urb->transfer_buffer,
1391 urb->transfer_buffer_length,
1394 /* Make it safe to call this routine more than once */
1395 urb->transfer_flags &= ~(URB_DMA_MAP_SG | URB_DMA_MAP_PAGE |
1396 URB_DMA_MAP_SINGLE | URB_MAP_LOCAL);
1398 EXPORT_SYMBOL_GPL(usb_hcd_unmap_urb_for_dma);
1400 static int map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
1403 if (hcd->driver->map_urb_for_dma)
1404 return hcd->driver->map_urb_for_dma(hcd, urb, mem_flags);
1406 return usb_hcd_map_urb_for_dma(hcd, urb, mem_flags);
1409 int usb_hcd_map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
1412 enum dma_data_direction dir;
1415 /* Map the URB's buffers for DMA access.
1416 * Lower level HCD code should use *_dma exclusively,
1417 * unless it uses pio or talks to another transport,
1418 * or uses the provided scatter gather list for bulk.
1421 if (usb_endpoint_xfer_control(&urb->ep->desc)) {
1422 if (hcd->self.uses_pio_for_control)
1424 if (hcd->localmem_pool) {
1425 ret = hcd_alloc_coherent(
1426 urb->dev->bus, mem_flags,
1428 (void **)&urb->setup_packet,
1429 sizeof(struct usb_ctrlrequest),
1433 urb->transfer_flags |= URB_SETUP_MAP_LOCAL;
1434 } else if (hcd_uses_dma(hcd)) {
1435 if (object_is_on_stack(urb->setup_packet)) {
1436 WARN_ONCE(1, "setup packet is on stack\n");
1440 urb->setup_dma = dma_map_single(
1443 sizeof(struct usb_ctrlrequest),
1445 if (dma_mapping_error(hcd->self.sysdev,
1448 urb->transfer_flags |= URB_SETUP_MAP_SINGLE;
1452 dir = usb_urb_dir_in(urb) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
1453 if (urb->transfer_buffer_length != 0
1454 && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP)) {
1455 if (hcd->localmem_pool) {
1456 ret = hcd_alloc_coherent(
1457 urb->dev->bus, mem_flags,
1459 &urb->transfer_buffer,
1460 urb->transfer_buffer_length,
1463 urb->transfer_flags |= URB_MAP_LOCAL;
1464 } else if (hcd_uses_dma(hcd)) {
1468 /* We don't support sg for isoc transfers ! */
1469 if (usb_endpoint_xfer_isoc(&urb->ep->desc)) {
1482 urb->transfer_flags |= URB_DMA_MAP_SG;
1483 urb->num_mapped_sgs = n;
1484 if (n != urb->num_sgs)
1485 urb->transfer_flags |=
1486 URB_DMA_SG_COMBINED;
1487 } else if (urb->sg) {
1488 struct scatterlist *sg = urb->sg;
1489 urb->transfer_dma = dma_map_page(
1493 urb->transfer_buffer_length,
1495 if (dma_mapping_error(hcd->self.sysdev,
1499 urb->transfer_flags |= URB_DMA_MAP_PAGE;
1500 } else if (object_is_on_stack(urb->transfer_buffer)) {
1501 WARN_ONCE(1, "transfer buffer is on stack\n");
1504 urb->transfer_dma = dma_map_single(
1506 urb->transfer_buffer,
1507 urb->transfer_buffer_length,
1509 if (dma_mapping_error(hcd->self.sysdev,
1513 urb->transfer_flags |= URB_DMA_MAP_SINGLE;
1516 if (ret && (urb->transfer_flags & (URB_SETUP_MAP_SINGLE |
1517 URB_SETUP_MAP_LOCAL)))
1518 usb_hcd_unmap_urb_for_dma(hcd, urb);
1522 EXPORT_SYMBOL_GPL(usb_hcd_map_urb_for_dma);
1524 /*-------------------------------------------------------------------------*/
1526 /* may be called in any context with a valid urb->dev usecount
1527 * caller surrenders "ownership" of urb
1528 * expects usb_submit_urb() to have sanity checked and conditioned all
1531 int usb_hcd_submit_urb (struct urb *urb, gfp_t mem_flags)
1534 struct usb_hcd *hcd = bus_to_hcd(urb->dev->bus);
1536 /* increment urb's reference count as part of giving it to the HCD
1537 * (which will control it). HCD guarantees that it either returns
1538 * an error or calls giveback(), but not both.
1541 atomic_inc(&urb->use_count);
1542 atomic_inc(&urb->dev->urbnum);
1543 usbmon_urb_submit(&hcd->self, urb);
1545 /* NOTE requirements on root-hub callers (usbfs and the hub
1546 * driver, for now): URBs' urb->transfer_buffer must be
1547 * valid and usb_buffer_{sync,unmap}() not be needed, since
1548 * they could clobber root hub response data. Also, control
1549 * URBs must be submitted in process context with interrupts
1553 if (is_root_hub(urb->dev)) {
1554 status = rh_urb_enqueue(hcd, urb);
1556 status = map_urb_for_dma(hcd, urb, mem_flags);
1557 if (likely(status == 0)) {
1558 status = hcd->driver->urb_enqueue(hcd, urb, mem_flags);
1559 if (unlikely(status))
1560 unmap_urb_for_dma(hcd, urb);
1564 if (unlikely(status)) {
1565 usbmon_urb_submit_error(&hcd->self, urb, status);
1567 INIT_LIST_HEAD(&urb->urb_list);
1568 atomic_dec(&urb->use_count);
1570 * Order the write of urb->use_count above before the read
1571 * of urb->reject below. Pairs with the memory barriers in
1572 * usb_kill_urb() and usb_poison_urb().
1574 smp_mb__after_atomic();
1576 atomic_dec(&urb->dev->urbnum);
1577 if (atomic_read(&urb->reject))
1578 wake_up(&usb_kill_urb_queue);
1584 /*-------------------------------------------------------------------------*/
1586 /* this makes the hcd giveback() the urb more quickly, by kicking it
1587 * off hardware queues (which may take a while) and returning it as
1588 * soon as practical. we've already set up the urb's return status,
1589 * but we can't know if the callback completed already.
1591 static int unlink1(struct usb_hcd *hcd, struct urb *urb, int status)
1595 if (is_root_hub(urb->dev))
1596 value = usb_rh_urb_dequeue(hcd, urb, status);
1599 /* The only reason an HCD might fail this call is if
1600 * it has not yet fully queued the urb to begin with.
1601 * Such failures should be harmless. */
1602 value = hcd->driver->urb_dequeue(hcd, urb, status);
1608 * called in any context
1610 * caller guarantees urb won't be recycled till both unlink()
1611 * and the urb's completion function return
1613 int usb_hcd_unlink_urb (struct urb *urb, int status)
1615 struct usb_hcd *hcd;
1616 struct usb_device *udev = urb->dev;
1617 int retval = -EIDRM;
1618 unsigned long flags;
1620 /* Prevent the device and bus from going away while
1621 * the unlink is carried out. If they are already gone
1622 * then urb->use_count must be 0, since disconnected
1623 * devices can't have any active URBs.
1625 spin_lock_irqsave(&hcd_urb_unlink_lock, flags);
1626 if (atomic_read(&urb->use_count) > 0) {
1630 spin_unlock_irqrestore(&hcd_urb_unlink_lock, flags);
1632 hcd = bus_to_hcd(urb->dev->bus);
1633 retval = unlink1(hcd, urb, status);
1635 retval = -EINPROGRESS;
1636 else if (retval != -EIDRM && retval != -EBUSY)
1637 dev_dbg(&udev->dev, "hcd_unlink_urb %pK fail %d\n",
1644 /*-------------------------------------------------------------------------*/
1646 static void __usb_hcd_giveback_urb(struct urb *urb)
1648 struct usb_hcd *hcd = bus_to_hcd(urb->dev->bus);
1649 struct usb_anchor *anchor = urb->anchor;
1650 int status = urb->unlinked;
1653 if (unlikely((urb->transfer_flags & URB_SHORT_NOT_OK) &&
1654 urb->actual_length < urb->transfer_buffer_length &&
1656 status = -EREMOTEIO;
1658 unmap_urb_for_dma(hcd, urb);
1659 usbmon_urb_complete(&hcd->self, urb, status);
1660 usb_anchor_suspend_wakeups(anchor);
1661 usb_unanchor_urb(urb);
1662 if (likely(status == 0))
1663 usb_led_activity(USB_LED_EVENT_HOST);
1665 /* pass ownership to the completion handler */
1666 urb->status = status;
1668 * This function can be called in task context inside another remote
1669 * coverage collection section, but KCOV doesn't support that kind of
1670 * recursion yet. Only collect coverage in softirq context for now.
1672 if (in_serving_softirq())
1673 kcov_remote_start_usb((u64)urb->dev->bus->busnum);
1675 if (in_serving_softirq())
1678 usb_anchor_resume_wakeups(anchor);
1679 atomic_dec(&urb->use_count);
1681 * Order the write of urb->use_count above before the read
1682 * of urb->reject below. Pairs with the memory barriers in
1683 * usb_kill_urb() and usb_poison_urb().
1685 smp_mb__after_atomic();
1687 if (unlikely(atomic_read(&urb->reject)))
1688 wake_up(&usb_kill_urb_queue);
1692 static void usb_giveback_urb_bh(struct tasklet_struct *t)
1694 struct giveback_urb_bh *bh = from_tasklet(bh, t, bh);
1695 struct list_head local_list;
1697 spin_lock_irq(&bh->lock);
1699 list_replace_init(&bh->head, &local_list);
1700 spin_unlock_irq(&bh->lock);
1702 while (!list_empty(&local_list)) {
1705 urb = list_entry(local_list.next, struct urb, urb_list);
1706 list_del_init(&urb->urb_list);
1707 bh->completing_ep = urb->ep;
1708 __usb_hcd_giveback_urb(urb);
1709 bh->completing_ep = NULL;
1713 * giveback new URBs next time to prevent this function
1714 * from not exiting for a long time.
1716 spin_lock_irq(&bh->lock);
1717 if (!list_empty(&bh->head)) {
1719 tasklet_hi_schedule(&bh->bh);
1721 tasklet_schedule(&bh->bh);
1723 bh->running = false;
1724 spin_unlock_irq(&bh->lock);
1728 * usb_hcd_giveback_urb - return URB from HCD to device driver
1729 * @hcd: host controller returning the URB
1730 * @urb: urb being returned to the USB device driver.
1731 * @status: completion status code for the URB.
1732 * Context: in_interrupt()
1734 * This hands the URB from HCD to its USB device driver, using its
1735 * completion function. The HCD has freed all per-urb resources
1736 * (and is done using urb->hcpriv). It also released all HCD locks;
1737 * the device driver won't cause problems if it frees, modifies,
1738 * or resubmits this URB.
1740 * If @urb was unlinked, the value of @status will be overridden by
1741 * @urb->unlinked. Erroneous short transfers are detected in case
1742 * the HCD hasn't checked for them.
1744 void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb, int status)
1746 struct giveback_urb_bh *bh;
1749 /* pass status to tasklet via unlinked */
1750 if (likely(!urb->unlinked))
1751 urb->unlinked = status;
1753 if (!hcd_giveback_urb_in_bh(hcd) && !is_root_hub(urb->dev)) {
1754 __usb_hcd_giveback_urb(urb);
1758 if (usb_pipeisoc(urb->pipe) || usb_pipeint(urb->pipe))
1759 bh = &hcd->high_prio_bh;
1761 bh = &hcd->low_prio_bh;
1763 spin_lock(&bh->lock);
1764 list_add_tail(&urb->urb_list, &bh->head);
1765 running = bh->running;
1766 spin_unlock(&bh->lock);
1770 else if (bh->high_prio)
1771 tasklet_hi_schedule(&bh->bh);
1773 tasklet_schedule(&bh->bh);
1775 EXPORT_SYMBOL_GPL(usb_hcd_giveback_urb);
1777 /*-------------------------------------------------------------------------*/
1779 /* Cancel all URBs pending on this endpoint and wait for the endpoint's
1780 * queue to drain completely. The caller must first insure that no more
1781 * URBs can be submitted for this endpoint.
1783 void usb_hcd_flush_endpoint(struct usb_device *udev,
1784 struct usb_host_endpoint *ep)
1786 struct usb_hcd *hcd;
1792 hcd = bus_to_hcd(udev->bus);
1794 /* No more submits can occur */
1795 spin_lock_irq(&hcd_urb_list_lock);
1797 list_for_each_entry_reverse(urb, &ep->urb_list, urb_list) {
1803 is_in = usb_urb_dir_in(urb);
1804 spin_unlock(&hcd_urb_list_lock);
1807 unlink1(hcd, urb, -ESHUTDOWN);
1808 dev_dbg (hcd->self.controller,
1809 "shutdown urb %pK ep%d%s-%s\n",
1810 urb, usb_endpoint_num(&ep->desc),
1811 is_in ? "in" : "out",
1812 usb_ep_type_string(usb_endpoint_type(&ep->desc)));
1815 /* list contents may have changed */
1816 spin_lock(&hcd_urb_list_lock);
1819 spin_unlock_irq(&hcd_urb_list_lock);
1821 /* Wait until the endpoint queue is completely empty */
1822 while (!list_empty (&ep->urb_list)) {
1823 spin_lock_irq(&hcd_urb_list_lock);
1825 /* The list may have changed while we acquired the spinlock */
1827 if (!list_empty (&ep->urb_list)) {
1828 urb = list_entry (ep->urb_list.prev, struct urb,
1832 spin_unlock_irq(&hcd_urb_list_lock);
1842 * usb_hcd_alloc_bandwidth - check whether a new bandwidth setting exceeds
1844 * @udev: target &usb_device
1845 * @new_config: new configuration to install
1846 * @cur_alt: the current alternate interface setting
1847 * @new_alt: alternate interface setting that is being installed
1849 * To change configurations, pass in the new configuration in new_config,
1850 * and pass NULL for cur_alt and new_alt.
1852 * To reset a device's configuration (put the device in the ADDRESSED state),
1853 * pass in NULL for new_config, cur_alt, and new_alt.
1855 * To change alternate interface settings, pass in NULL for new_config,
1856 * pass in the current alternate interface setting in cur_alt,
1857 * and pass in the new alternate interface setting in new_alt.
1859 * Return: An error if the requested bandwidth change exceeds the
1860 * bus bandwidth or host controller internal resources.
1862 int usb_hcd_alloc_bandwidth(struct usb_device *udev,
1863 struct usb_host_config *new_config,
1864 struct usb_host_interface *cur_alt,
1865 struct usb_host_interface *new_alt)
1867 int num_intfs, i, j;
1868 struct usb_host_interface *alt = NULL;
1870 struct usb_hcd *hcd;
1871 struct usb_host_endpoint *ep;
1873 hcd = bus_to_hcd(udev->bus);
1874 if (!hcd->driver->check_bandwidth)
1877 /* Configuration is being removed - set configuration 0 */
1878 if (!new_config && !cur_alt) {
1879 for (i = 1; i < 16; ++i) {
1880 ep = udev->ep_out[i];
1882 hcd->driver->drop_endpoint(hcd, udev, ep);
1883 ep = udev->ep_in[i];
1885 hcd->driver->drop_endpoint(hcd, udev, ep);
1887 hcd->driver->check_bandwidth(hcd, udev);
1890 /* Check if the HCD says there's enough bandwidth. Enable all endpoints
1891 * each interface's alt setting 0 and ask the HCD to check the bandwidth
1892 * of the bus. There will always be bandwidth for endpoint 0, so it's
1896 num_intfs = new_config->desc.bNumInterfaces;
1897 /* Remove endpoints (except endpoint 0, which is always on the
1898 * schedule) from the old config from the schedule
1900 for (i = 1; i < 16; ++i) {
1901 ep = udev->ep_out[i];
1903 ret = hcd->driver->drop_endpoint(hcd, udev, ep);
1907 ep = udev->ep_in[i];
1909 ret = hcd->driver->drop_endpoint(hcd, udev, ep);
1914 for (i = 0; i < num_intfs; ++i) {
1915 struct usb_host_interface *first_alt;
1918 first_alt = &new_config->intf_cache[i]->altsetting[0];
1919 iface_num = first_alt->desc.bInterfaceNumber;
1920 /* Set up endpoints for alternate interface setting 0 */
1921 alt = usb_find_alt_setting(new_config, iface_num, 0);
1923 /* No alt setting 0? Pick the first setting. */
1926 for (j = 0; j < alt->desc.bNumEndpoints; j++) {
1927 ret = hcd->driver->add_endpoint(hcd, udev, &alt->endpoint[j]);
1933 if (cur_alt && new_alt) {
1934 struct usb_interface *iface = usb_ifnum_to_if(udev,
1935 cur_alt->desc.bInterfaceNumber);
1939 if (iface->resetting_device) {
1941 * The USB core just reset the device, so the xHCI host
1942 * and the device will think alt setting 0 is installed.
1943 * However, the USB core will pass in the alternate
1944 * setting installed before the reset as cur_alt. Dig
1945 * out the alternate setting 0 structure, or the first
1946 * alternate setting if a broken device doesn't have alt
1949 cur_alt = usb_altnum_to_altsetting(iface, 0);
1951 cur_alt = &iface->altsetting[0];
1954 /* Drop all the endpoints in the current alt setting */
1955 for (i = 0; i < cur_alt->desc.bNumEndpoints; i++) {
1956 ret = hcd->driver->drop_endpoint(hcd, udev,
1957 &cur_alt->endpoint[i]);
1961 /* Add all the endpoints in the new alt setting */
1962 for (i = 0; i < new_alt->desc.bNumEndpoints; i++) {
1963 ret = hcd->driver->add_endpoint(hcd, udev,
1964 &new_alt->endpoint[i]);
1969 ret = hcd->driver->check_bandwidth(hcd, udev);
1972 hcd->driver->reset_bandwidth(hcd, udev);
1976 /* Disables the endpoint: synchronizes with the hcd to make sure all
1977 * endpoint state is gone from hardware. usb_hcd_flush_endpoint() must
1978 * have been called previously. Use for set_configuration, set_interface,
1979 * driver removal, physical disconnect.
1981 * example: a qh stored in ep->hcpriv, holding state related to endpoint
1982 * type, maxpacket size, toggle, halt status, and scheduling.
1984 void usb_hcd_disable_endpoint(struct usb_device *udev,
1985 struct usb_host_endpoint *ep)
1987 struct usb_hcd *hcd;
1990 hcd = bus_to_hcd(udev->bus);
1991 if (hcd->driver->endpoint_disable)
1992 hcd->driver->endpoint_disable(hcd, ep);
1996 * usb_hcd_reset_endpoint - reset host endpoint state
1997 * @udev: USB device.
1998 * @ep: the endpoint to reset.
2000 * Resets any host endpoint state such as the toggle bit, sequence
2001 * number and current window.
2003 void usb_hcd_reset_endpoint(struct usb_device *udev,
2004 struct usb_host_endpoint *ep)
2006 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2008 if (hcd->driver->endpoint_reset)
2009 hcd->driver->endpoint_reset(hcd, ep);
2011 int epnum = usb_endpoint_num(&ep->desc);
2012 int is_out = usb_endpoint_dir_out(&ep->desc);
2013 int is_control = usb_endpoint_xfer_control(&ep->desc);
2015 usb_settoggle(udev, epnum, is_out, 0);
2017 usb_settoggle(udev, epnum, !is_out, 0);
2022 * usb_alloc_streams - allocate bulk endpoint stream IDs.
2023 * @interface: alternate setting that includes all endpoints.
2024 * @eps: array of endpoints that need streams.
2025 * @num_eps: number of endpoints in the array.
2026 * @num_streams: number of streams to allocate.
2027 * @mem_flags: flags hcd should use to allocate memory.
2029 * Sets up a group of bulk endpoints to have @num_streams stream IDs available.
2030 * Drivers may queue multiple transfers to different stream IDs, which may
2031 * complete in a different order than they were queued.
2033 * Return: On success, the number of allocated streams. On failure, a negative
2036 int usb_alloc_streams(struct usb_interface *interface,
2037 struct usb_host_endpoint **eps, unsigned int num_eps,
2038 unsigned int num_streams, gfp_t mem_flags)
2040 struct usb_hcd *hcd;
2041 struct usb_device *dev;
2044 dev = interface_to_usbdev(interface);
2045 hcd = bus_to_hcd(dev->bus);
2046 if (!hcd->driver->alloc_streams || !hcd->driver->free_streams)
2048 if (dev->speed < USB_SPEED_SUPER)
2050 if (dev->state < USB_STATE_CONFIGURED)
2053 for (i = 0; i < num_eps; i++) {
2054 /* Streams only apply to bulk endpoints. */
2055 if (!usb_endpoint_xfer_bulk(&eps[i]->desc))
2057 /* Re-alloc is not allowed */
2058 if (eps[i]->streams)
2062 ret = hcd->driver->alloc_streams(hcd, dev, eps, num_eps,
2063 num_streams, mem_flags);
2067 for (i = 0; i < num_eps; i++)
2068 eps[i]->streams = ret;
2072 EXPORT_SYMBOL_GPL(usb_alloc_streams);
2075 * usb_free_streams - free bulk endpoint stream IDs.
2076 * @interface: alternate setting that includes all endpoints.
2077 * @eps: array of endpoints to remove streams from.
2078 * @num_eps: number of endpoints in the array.
2079 * @mem_flags: flags hcd should use to allocate memory.
2081 * Reverts a group of bulk endpoints back to not using stream IDs.
2082 * Can fail if we are given bad arguments, or HCD is broken.
2084 * Return: 0 on success. On failure, a negative error code.
2086 int usb_free_streams(struct usb_interface *interface,
2087 struct usb_host_endpoint **eps, unsigned int num_eps,
2090 struct usb_hcd *hcd;
2091 struct usb_device *dev;
2094 dev = interface_to_usbdev(interface);
2095 hcd = bus_to_hcd(dev->bus);
2096 if (dev->speed < USB_SPEED_SUPER)
2099 /* Double-free is not allowed */
2100 for (i = 0; i < num_eps; i++)
2101 if (!eps[i] || !eps[i]->streams)
2104 ret = hcd->driver->free_streams(hcd, dev, eps, num_eps, mem_flags);
2108 for (i = 0; i < num_eps; i++)
2109 eps[i]->streams = 0;
2113 EXPORT_SYMBOL_GPL(usb_free_streams);
2115 /* Protect against drivers that try to unlink URBs after the device
2116 * is gone, by waiting until all unlinks for @udev are finished.
2117 * Since we don't currently track URBs by device, simply wait until
2118 * nothing is running in the locked region of usb_hcd_unlink_urb().
2120 void usb_hcd_synchronize_unlinks(struct usb_device *udev)
2122 spin_lock_irq(&hcd_urb_unlink_lock);
2123 spin_unlock_irq(&hcd_urb_unlink_lock);
2126 /*-------------------------------------------------------------------------*/
2128 /* called in any context */
2129 int usb_hcd_get_frame_number (struct usb_device *udev)
2131 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2133 if (!HCD_RH_RUNNING(hcd))
2135 return hcd->driver->get_frame_number (hcd);
2138 /*-------------------------------------------------------------------------*/
2142 int hcd_bus_suspend(struct usb_device *rhdev, pm_message_t msg)
2144 struct usb_hcd *hcd = bus_to_hcd(rhdev->bus);
2146 int old_state = hcd->state;
2148 dev_dbg(&rhdev->dev, "bus %ssuspend, wakeup %d\n",
2149 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
2150 rhdev->do_remote_wakeup);
2151 if (HCD_DEAD(hcd)) {
2152 dev_dbg(&rhdev->dev, "skipped %s of dead bus\n", "suspend");
2156 if (!hcd->driver->bus_suspend) {
2159 clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2160 hcd->state = HC_STATE_QUIESCING;
2161 status = hcd->driver->bus_suspend(hcd);
2164 usb_set_device_state(rhdev, USB_STATE_SUSPENDED);
2165 hcd->state = HC_STATE_SUSPENDED;
2167 if (!PMSG_IS_AUTO(msg))
2168 usb_phy_roothub_suspend(hcd->self.sysdev,
2171 /* Did we race with a root-hub wakeup event? */
2172 if (rhdev->do_remote_wakeup) {
2175 status = hcd->driver->hub_status_data(hcd, buffer);
2177 dev_dbg(&rhdev->dev, "suspend raced with wakeup event\n");
2178 hcd_bus_resume(rhdev, PMSG_AUTO_RESUME);
2183 spin_lock_irq(&hcd_root_hub_lock);
2184 if (!HCD_DEAD(hcd)) {
2185 set_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2186 hcd->state = old_state;
2188 spin_unlock_irq(&hcd_root_hub_lock);
2189 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
2195 int hcd_bus_resume(struct usb_device *rhdev, pm_message_t msg)
2197 struct usb_hcd *hcd = bus_to_hcd(rhdev->bus);
2199 int old_state = hcd->state;
2201 dev_dbg(&rhdev->dev, "usb %sresume\n",
2202 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
2203 if (HCD_DEAD(hcd)) {
2204 dev_dbg(&rhdev->dev, "skipped %s of dead bus\n", "resume");
2208 if (!PMSG_IS_AUTO(msg)) {
2209 status = usb_phy_roothub_resume(hcd->self.sysdev,
2215 if (!hcd->driver->bus_resume)
2217 if (HCD_RH_RUNNING(hcd))
2220 hcd->state = HC_STATE_RESUMING;
2221 status = hcd->driver->bus_resume(hcd);
2222 clear_bit(HCD_FLAG_WAKEUP_PENDING, &hcd->flags);
2224 status = usb_phy_roothub_calibrate(hcd->phy_roothub);
2227 struct usb_device *udev;
2230 spin_lock_irq(&hcd_root_hub_lock);
2231 if (!HCD_DEAD(hcd)) {
2232 usb_set_device_state(rhdev, rhdev->actconfig
2233 ? USB_STATE_CONFIGURED
2234 : USB_STATE_ADDRESS);
2235 set_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2236 hcd->state = HC_STATE_RUNNING;
2238 spin_unlock_irq(&hcd_root_hub_lock);
2241 * Check whether any of the enabled ports on the root hub are
2242 * unsuspended. If they are then a TRSMRCY delay is needed
2243 * (this is what the USB-2 spec calls a "global resume").
2244 * Otherwise we can skip the delay.
2246 usb_hub_for_each_child(rhdev, port1, udev) {
2247 if (udev->state != USB_STATE_NOTATTACHED &&
2248 !udev->port_is_suspended) {
2249 usleep_range(10000, 11000); /* TRSMRCY */
2254 hcd->state = old_state;
2255 usb_phy_roothub_suspend(hcd->self.sysdev, hcd->phy_roothub);
2256 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
2258 if (status != -ESHUTDOWN)
2264 /* Workqueue routine for root-hub remote wakeup */
2265 static void hcd_resume_work(struct work_struct *work)
2267 struct usb_hcd *hcd = container_of(work, struct usb_hcd, wakeup_work);
2268 struct usb_device *udev = hcd->self.root_hub;
2270 usb_remote_wakeup(udev);
2274 * usb_hcd_resume_root_hub - called by HCD to resume its root hub
2275 * @hcd: host controller for this root hub
2277 * The USB host controller calls this function when its root hub is
2278 * suspended (with the remote wakeup feature enabled) and a remote
2279 * wakeup request is received. The routine submits a workqueue request
2280 * to resume the root hub (that is, manage its downstream ports again).
2282 void usb_hcd_resume_root_hub (struct usb_hcd *hcd)
2284 unsigned long flags;
2286 spin_lock_irqsave (&hcd_root_hub_lock, flags);
2287 if (hcd->rh_registered) {
2288 pm_wakeup_event(&hcd->self.root_hub->dev, 0);
2289 set_bit(HCD_FLAG_WAKEUP_PENDING, &hcd->flags);
2290 queue_work(pm_wq, &hcd->wakeup_work);
2292 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
2294 EXPORT_SYMBOL_GPL(usb_hcd_resume_root_hub);
2296 #endif /* CONFIG_PM */
2298 /*-------------------------------------------------------------------------*/
2300 #ifdef CONFIG_USB_OTG
2303 * usb_bus_start_enum - start immediate enumeration (for OTG)
2304 * @bus: the bus (must use hcd framework)
2305 * @port_num: 1-based number of port; usually bus->otg_port
2306 * Context: in_interrupt()
2308 * Starts enumeration, with an immediate reset followed later by
2309 * hub_wq identifying and possibly configuring the device.
2310 * This is needed by OTG controller drivers, where it helps meet
2311 * HNP protocol timing requirements for starting a port reset.
2313 * Return: 0 if successful.
2315 int usb_bus_start_enum(struct usb_bus *bus, unsigned port_num)
2317 struct usb_hcd *hcd;
2318 int status = -EOPNOTSUPP;
2320 /* NOTE: since HNP can't start by grabbing the bus's address0_sem,
2321 * boards with root hubs hooked up to internal devices (instead of
2322 * just the OTG port) may need more attention to resetting...
2324 hcd = bus_to_hcd(bus);
2325 if (port_num && hcd->driver->start_port_reset)
2326 status = hcd->driver->start_port_reset(hcd, port_num);
2328 /* allocate hub_wq shortly after (first) root port reset finishes;
2329 * it may issue others, until at least 50 msecs have passed.
2332 mod_timer(&hcd->rh_timer, jiffies + msecs_to_jiffies(10));
2335 EXPORT_SYMBOL_GPL(usb_bus_start_enum);
2339 /*-------------------------------------------------------------------------*/
2342 * usb_hcd_irq - hook IRQs to HCD framework (bus glue)
2343 * @irq: the IRQ being raised
2344 * @__hcd: pointer to the HCD whose IRQ is being signaled
2346 * If the controller isn't HALTed, calls the driver's irq handler.
2347 * Checks whether the controller is now dead.
2349 * Return: %IRQ_HANDLED if the IRQ was handled. %IRQ_NONE otherwise.
2351 irqreturn_t usb_hcd_irq (int irq, void *__hcd)
2353 struct usb_hcd *hcd = __hcd;
2356 if (unlikely(HCD_DEAD(hcd) || !HCD_HW_ACCESSIBLE(hcd)))
2358 else if (hcd->driver->irq(hcd) == IRQ_NONE)
2365 EXPORT_SYMBOL_GPL(usb_hcd_irq);
2367 /*-------------------------------------------------------------------------*/
2369 /* Workqueue routine for when the root-hub has died. */
2370 static void hcd_died_work(struct work_struct *work)
2372 struct usb_hcd *hcd = container_of(work, struct usb_hcd, died_work);
2373 static char *env[] = {
2378 /* Notify user space that the host controller has died */
2379 kobject_uevent_env(&hcd->self.root_hub->dev.kobj, KOBJ_OFFLINE, env);
2383 * usb_hc_died - report abnormal shutdown of a host controller (bus glue)
2384 * @hcd: pointer to the HCD representing the controller
2386 * This is called by bus glue to report a USB host controller that died
2387 * while operations may still have been pending. It's called automatically
2388 * by the PCI glue, so only glue for non-PCI busses should need to call it.
2390 * Only call this function with the primary HCD.
2392 void usb_hc_died (struct usb_hcd *hcd)
2394 unsigned long flags;
2396 dev_err (hcd->self.controller, "HC died; cleaning up\n");
2398 spin_lock_irqsave (&hcd_root_hub_lock, flags);
2399 clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2400 set_bit(HCD_FLAG_DEAD, &hcd->flags);
2401 if (hcd->rh_registered) {
2402 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2404 /* make hub_wq clean up old urbs and devices */
2405 usb_set_device_state (hcd->self.root_hub,
2406 USB_STATE_NOTATTACHED);
2407 usb_kick_hub_wq(hcd->self.root_hub);
2409 if (usb_hcd_is_primary_hcd(hcd) && hcd->shared_hcd) {
2410 hcd = hcd->shared_hcd;
2411 clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2412 set_bit(HCD_FLAG_DEAD, &hcd->flags);
2413 if (hcd->rh_registered) {
2414 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2416 /* make hub_wq clean up old urbs and devices */
2417 usb_set_device_state(hcd->self.root_hub,
2418 USB_STATE_NOTATTACHED);
2419 usb_kick_hub_wq(hcd->self.root_hub);
2423 /* Handle the case where this function gets called with a shared HCD */
2424 if (usb_hcd_is_primary_hcd(hcd))
2425 schedule_work(&hcd->died_work);
2427 schedule_work(&hcd->primary_hcd->died_work);
2429 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
2430 /* Make sure that the other roothub is also deallocated. */
2432 EXPORT_SYMBOL_GPL (usb_hc_died);
2434 /*-------------------------------------------------------------------------*/
2436 static void init_giveback_urb_bh(struct giveback_urb_bh *bh)
2439 spin_lock_init(&bh->lock);
2440 INIT_LIST_HEAD(&bh->head);
2441 tasklet_setup(&bh->bh, usb_giveback_urb_bh);
2444 struct usb_hcd *__usb_create_hcd(const struct hc_driver *driver,
2445 struct device *sysdev, struct device *dev, const char *bus_name,
2446 struct usb_hcd *primary_hcd)
2448 struct usb_hcd *hcd;
2450 hcd = kzalloc(sizeof(*hcd) + driver->hcd_priv_size, GFP_KERNEL);
2453 if (primary_hcd == NULL) {
2454 hcd->address0_mutex = kmalloc(sizeof(*hcd->address0_mutex),
2456 if (!hcd->address0_mutex) {
2458 dev_dbg(dev, "hcd address0 mutex alloc failed\n");
2461 mutex_init(hcd->address0_mutex);
2462 hcd->bandwidth_mutex = kmalloc(sizeof(*hcd->bandwidth_mutex),
2464 if (!hcd->bandwidth_mutex) {
2465 kfree(hcd->address0_mutex);
2467 dev_dbg(dev, "hcd bandwidth mutex alloc failed\n");
2470 mutex_init(hcd->bandwidth_mutex);
2471 dev_set_drvdata(dev, hcd);
2473 mutex_lock(&usb_port_peer_mutex);
2474 hcd->address0_mutex = primary_hcd->address0_mutex;
2475 hcd->bandwidth_mutex = primary_hcd->bandwidth_mutex;
2476 hcd->primary_hcd = primary_hcd;
2477 primary_hcd->primary_hcd = primary_hcd;
2478 hcd->shared_hcd = primary_hcd;
2479 primary_hcd->shared_hcd = hcd;
2480 mutex_unlock(&usb_port_peer_mutex);
2483 kref_init(&hcd->kref);
2485 usb_bus_init(&hcd->self);
2486 hcd->self.controller = dev;
2487 hcd->self.sysdev = sysdev;
2488 hcd->self.bus_name = bus_name;
2490 timer_setup(&hcd->rh_timer, rh_timer_func, 0);
2492 INIT_WORK(&hcd->wakeup_work, hcd_resume_work);
2495 INIT_WORK(&hcd->died_work, hcd_died_work);
2497 hcd->driver = driver;
2498 hcd->speed = driver->flags & HCD_MASK;
2499 hcd->product_desc = (driver->product_desc) ? driver->product_desc :
2500 "USB Host Controller";
2503 EXPORT_SYMBOL_GPL(__usb_create_hcd);
2506 * usb_create_shared_hcd - create and initialize an HCD structure
2507 * @driver: HC driver that will use this hcd
2508 * @dev: device for this HC, stored in hcd->self.controller
2509 * @bus_name: value to store in hcd->self.bus_name
2510 * @primary_hcd: a pointer to the usb_hcd structure that is sharing the
2511 * PCI device. Only allocate certain resources for the primary HCD
2512 * Context: !in_interrupt()
2514 * Allocate a struct usb_hcd, with extra space at the end for the
2515 * HC driver's private data. Initialize the generic members of the
2518 * Return: On success, a pointer to the created and initialized HCD structure.
2519 * On failure (e.g. if memory is unavailable), %NULL.
2521 struct usb_hcd *usb_create_shared_hcd(const struct hc_driver *driver,
2522 struct device *dev, const char *bus_name,
2523 struct usb_hcd *primary_hcd)
2525 return __usb_create_hcd(driver, dev, dev, bus_name, primary_hcd);
2527 EXPORT_SYMBOL_GPL(usb_create_shared_hcd);
2530 * usb_create_hcd - create and initialize an HCD structure
2531 * @driver: HC driver that will use this hcd
2532 * @dev: device for this HC, stored in hcd->self.controller
2533 * @bus_name: value to store in hcd->self.bus_name
2534 * Context: !in_interrupt()
2536 * Allocate a struct usb_hcd, with extra space at the end for the
2537 * HC driver's private data. Initialize the generic members of the
2540 * Return: On success, a pointer to the created and initialized HCD
2541 * structure. On failure (e.g. if memory is unavailable), %NULL.
2543 struct usb_hcd *usb_create_hcd(const struct hc_driver *driver,
2544 struct device *dev, const char *bus_name)
2546 return __usb_create_hcd(driver, dev, dev, bus_name, NULL);
2548 EXPORT_SYMBOL_GPL(usb_create_hcd);
2551 * Roothubs that share one PCI device must also share the bandwidth mutex.
2552 * Don't deallocate the bandwidth_mutex until the last shared usb_hcd is
2555 * Make sure to deallocate the bandwidth_mutex only when the last HCD is
2556 * freed. When hcd_release() is called for either hcd in a peer set,
2557 * invalidate the peer's ->shared_hcd and ->primary_hcd pointers.
2559 static void hcd_release(struct kref *kref)
2561 struct usb_hcd *hcd = container_of (kref, struct usb_hcd, kref);
2563 mutex_lock(&usb_port_peer_mutex);
2564 if (hcd->shared_hcd) {
2565 struct usb_hcd *peer = hcd->shared_hcd;
2567 peer->shared_hcd = NULL;
2568 peer->primary_hcd = NULL;
2570 kfree(hcd->address0_mutex);
2571 kfree(hcd->bandwidth_mutex);
2573 mutex_unlock(&usb_port_peer_mutex);
2577 struct usb_hcd *usb_get_hcd (struct usb_hcd *hcd)
2580 kref_get (&hcd->kref);
2583 EXPORT_SYMBOL_GPL(usb_get_hcd);
2585 void usb_put_hcd (struct usb_hcd *hcd)
2588 kref_put (&hcd->kref, hcd_release);
2590 EXPORT_SYMBOL_GPL(usb_put_hcd);
2592 int usb_hcd_is_primary_hcd(struct usb_hcd *hcd)
2594 if (!hcd->primary_hcd)
2596 return hcd == hcd->primary_hcd;
2598 EXPORT_SYMBOL_GPL(usb_hcd_is_primary_hcd);
2600 int usb_hcd_find_raw_port_number(struct usb_hcd *hcd, int port1)
2602 if (!hcd->driver->find_raw_port_number)
2605 return hcd->driver->find_raw_port_number(hcd, port1);
2608 static int usb_hcd_request_irqs(struct usb_hcd *hcd,
2609 unsigned int irqnum, unsigned long irqflags)
2613 if (hcd->driver->irq) {
2615 snprintf(hcd->irq_descr, sizeof(hcd->irq_descr), "%s:usb%d",
2616 hcd->driver->description, hcd->self.busnum);
2617 retval = request_irq(irqnum, &usb_hcd_irq, irqflags,
2618 hcd->irq_descr, hcd);
2620 dev_err(hcd->self.controller,
2621 "request interrupt %d failed\n",
2626 dev_info(hcd->self.controller, "irq %d, %s 0x%08llx\n", irqnum,
2627 (hcd->driver->flags & HCD_MEMORY) ?
2628 "io mem" : "io base",
2629 (unsigned long long)hcd->rsrc_start);
2632 if (hcd->rsrc_start)
2633 dev_info(hcd->self.controller, "%s 0x%08llx\n",
2634 (hcd->driver->flags & HCD_MEMORY) ?
2635 "io mem" : "io base",
2636 (unsigned long long)hcd->rsrc_start);
2642 * Before we free this root hub, flush in-flight peering attempts
2643 * and disable peer lookups
2645 static void usb_put_invalidate_rhdev(struct usb_hcd *hcd)
2647 struct usb_device *rhdev;
2649 mutex_lock(&usb_port_peer_mutex);
2650 rhdev = hcd->self.root_hub;
2651 hcd->self.root_hub = NULL;
2652 mutex_unlock(&usb_port_peer_mutex);
2657 * usb_add_hcd - finish generic HCD structure initialization and register
2658 * @hcd: the usb_hcd structure to initialize
2659 * @irqnum: Interrupt line to allocate
2660 * @irqflags: Interrupt type flags
2662 * Finish the remaining parts of generic HCD initialization: allocate the
2663 * buffers of consistent memory, register the bus, request the IRQ line,
2664 * and call the driver's reset() and start() routines.
2666 int usb_add_hcd(struct usb_hcd *hcd,
2667 unsigned int irqnum, unsigned long irqflags)
2670 struct usb_device *rhdev;
2671 struct usb_hcd *shared_hcd;
2673 if (!hcd->skip_phy_initialization && usb_hcd_is_primary_hcd(hcd)) {
2674 hcd->phy_roothub = usb_phy_roothub_alloc(hcd->self.sysdev);
2675 if (IS_ERR(hcd->phy_roothub))
2676 return PTR_ERR(hcd->phy_roothub);
2678 retval = usb_phy_roothub_init(hcd->phy_roothub);
2682 retval = usb_phy_roothub_set_mode(hcd->phy_roothub,
2683 PHY_MODE_USB_HOST_SS);
2685 retval = usb_phy_roothub_set_mode(hcd->phy_roothub,
2688 goto err_usb_phy_roothub_power_on;
2690 retval = usb_phy_roothub_power_on(hcd->phy_roothub);
2692 goto err_usb_phy_roothub_power_on;
2695 dev_info(hcd->self.controller, "%s\n", hcd->product_desc);
2697 switch (authorized_default) {
2698 case USB_AUTHORIZE_NONE:
2699 hcd->dev_policy = USB_DEVICE_AUTHORIZE_NONE;
2702 case USB_AUTHORIZE_ALL:
2703 hcd->dev_policy = USB_DEVICE_AUTHORIZE_ALL;
2706 case USB_AUTHORIZE_INTERNAL:
2707 hcd->dev_policy = USB_DEVICE_AUTHORIZE_INTERNAL;
2710 case USB_AUTHORIZE_WIRED:
2712 hcd->dev_policy = hcd->wireless ?
2713 USB_DEVICE_AUTHORIZE_NONE : USB_DEVICE_AUTHORIZE_ALL;
2717 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
2719 /* per default all interfaces are authorized */
2720 set_bit(HCD_FLAG_INTF_AUTHORIZED, &hcd->flags);
2722 /* HC is in reset state, but accessible. Now do the one-time init,
2723 * bottom up so that hcds can customize the root hubs before hub_wq
2724 * starts talking to them. (Note, bus id is assigned early too.)
2726 retval = hcd_buffer_create(hcd);
2728 dev_dbg(hcd->self.sysdev, "pool alloc failed\n");
2729 goto err_create_buf;
2732 retval = usb_register_bus(&hcd->self);
2734 goto err_register_bus;
2736 rhdev = usb_alloc_dev(NULL, &hcd->self, 0);
2737 if (rhdev == NULL) {
2738 dev_err(hcd->self.sysdev, "unable to allocate root hub\n");
2740 goto err_allocate_root_hub;
2742 mutex_lock(&usb_port_peer_mutex);
2743 hcd->self.root_hub = rhdev;
2744 mutex_unlock(&usb_port_peer_mutex);
2746 rhdev->rx_lanes = 1;
2747 rhdev->tx_lanes = 1;
2748 rhdev->ssp_rate = USB_SSP_GEN_UNKNOWN;
2750 switch (hcd->speed) {
2752 rhdev->speed = USB_SPEED_FULL;
2755 rhdev->speed = USB_SPEED_HIGH;
2758 rhdev->speed = USB_SPEED_WIRELESS;
2761 rhdev->speed = USB_SPEED_SUPER;
2764 rhdev->rx_lanes = 2;
2765 rhdev->tx_lanes = 2;
2766 rhdev->ssp_rate = USB_SSP_GEN_2x2;
2767 rhdev->speed = USB_SPEED_SUPER_PLUS;
2770 rhdev->ssp_rate = USB_SSP_GEN_2x1;
2771 rhdev->speed = USB_SPEED_SUPER_PLUS;
2775 goto err_set_rh_speed;
2778 /* wakeup flag init defaults to "everything works" for root hubs,
2779 * but drivers can override it in reset() if needed, along with
2780 * recording the overall controller's system wakeup capability.
2782 device_set_wakeup_capable(&rhdev->dev, 1);
2784 /* HCD_FLAG_RH_RUNNING doesn't matter until the root hub is
2785 * registered. But since the controller can die at any time,
2786 * let's initialize the flag before touching the hardware.
2788 set_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2790 /* "reset" is misnamed; its role is now one-time init. the controller
2791 * should already have been reset (and boot firmware kicked off etc).
2793 if (hcd->driver->reset) {
2794 retval = hcd->driver->reset(hcd);
2796 dev_err(hcd->self.controller, "can't setup: %d\n",
2798 goto err_hcd_driver_setup;
2801 hcd->rh_pollable = 1;
2803 retval = usb_phy_roothub_calibrate(hcd->phy_roothub);
2805 goto err_hcd_driver_setup;
2807 /* NOTE: root hub and controller capabilities may not be the same */
2808 if (device_can_wakeup(hcd->self.controller)
2809 && device_can_wakeup(&hcd->self.root_hub->dev))
2810 dev_dbg(hcd->self.controller, "supports USB remote wakeup\n");
2812 /* initialize tasklets */
2813 init_giveback_urb_bh(&hcd->high_prio_bh);
2814 hcd->high_prio_bh.high_prio = true;
2815 init_giveback_urb_bh(&hcd->low_prio_bh);
2817 /* enable irqs just before we start the controller,
2818 * if the BIOS provides legacy PCI irqs.
2820 if (usb_hcd_is_primary_hcd(hcd) && irqnum) {
2821 retval = usb_hcd_request_irqs(hcd, irqnum, irqflags);
2823 goto err_request_irq;
2826 hcd->state = HC_STATE_RUNNING;
2827 retval = hcd->driver->start(hcd);
2829 dev_err(hcd->self.controller, "startup error %d\n", retval);
2830 goto err_hcd_driver_start;
2833 /* starting here, usbcore will pay attention to the shared HCD roothub */
2834 shared_hcd = hcd->shared_hcd;
2835 if (!usb_hcd_is_primary_hcd(hcd) && shared_hcd && HCD_DEFER_RH_REGISTER(shared_hcd)) {
2836 retval = register_root_hub(shared_hcd);
2838 goto err_register_root_hub;
2840 if (shared_hcd->uses_new_polling && HCD_POLL_RH(shared_hcd))
2841 usb_hcd_poll_rh_status(shared_hcd);
2844 /* starting here, usbcore will pay attention to this root hub */
2845 if (!HCD_DEFER_RH_REGISTER(hcd)) {
2846 retval = register_root_hub(hcd);
2848 goto err_register_root_hub;
2850 if (hcd->uses_new_polling && HCD_POLL_RH(hcd))
2851 usb_hcd_poll_rh_status(hcd);
2856 err_register_root_hub:
2857 hcd->rh_pollable = 0;
2858 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2859 del_timer_sync(&hcd->rh_timer);
2860 hcd->driver->stop(hcd);
2861 hcd->state = HC_STATE_HALT;
2862 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2863 del_timer_sync(&hcd->rh_timer);
2864 err_hcd_driver_start:
2865 if (usb_hcd_is_primary_hcd(hcd) && hcd->irq > 0)
2866 free_irq(irqnum, hcd);
2868 err_hcd_driver_setup:
2870 usb_put_invalidate_rhdev(hcd);
2871 err_allocate_root_hub:
2872 usb_deregister_bus(&hcd->self);
2874 hcd_buffer_destroy(hcd);
2876 usb_phy_roothub_power_off(hcd->phy_roothub);
2877 err_usb_phy_roothub_power_on:
2878 usb_phy_roothub_exit(hcd->phy_roothub);
2882 EXPORT_SYMBOL_GPL(usb_add_hcd);
2885 * usb_remove_hcd - shutdown processing for generic HCDs
2886 * @hcd: the usb_hcd structure to remove
2887 * Context: !in_interrupt()
2889 * Disconnects the root hub, then reverses the effects of usb_add_hcd(),
2890 * invoking the HCD's stop() method.
2892 void usb_remove_hcd(struct usb_hcd *hcd)
2894 struct usb_device *rhdev = hcd->self.root_hub;
2897 dev_info(hcd->self.controller, "remove, state %x\n", hcd->state);
2900 clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2901 if (HC_IS_RUNNING (hcd->state))
2902 hcd->state = HC_STATE_QUIESCING;
2904 dev_dbg(hcd->self.controller, "roothub graceful disconnect\n");
2905 spin_lock_irq (&hcd_root_hub_lock);
2906 rh_registered = hcd->rh_registered;
2907 hcd->rh_registered = 0;
2908 spin_unlock_irq (&hcd_root_hub_lock);
2911 cancel_work_sync(&hcd->wakeup_work);
2913 cancel_work_sync(&hcd->died_work);
2915 mutex_lock(&usb_bus_idr_lock);
2917 usb_disconnect(&rhdev); /* Sets rhdev to NULL */
2918 mutex_unlock(&usb_bus_idr_lock);
2921 * tasklet_kill() isn't needed here because:
2922 * - driver's disconnect() called from usb_disconnect() should
2923 * make sure its URBs are completed during the disconnect()
2926 * - it is too late to run complete() here since driver may have
2927 * been removed already now
2930 /* Prevent any more root-hub status calls from the timer.
2931 * The HCD might still restart the timer (if a port status change
2932 * interrupt occurs), but usb_hcd_poll_rh_status() won't invoke
2933 * the hub_status_data() callback.
2935 hcd->rh_pollable = 0;
2936 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2937 del_timer_sync(&hcd->rh_timer);
2939 hcd->driver->stop(hcd);
2940 hcd->state = HC_STATE_HALT;
2942 /* In case the HCD restarted the timer, stop it again. */
2943 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2944 del_timer_sync(&hcd->rh_timer);
2946 if (usb_hcd_is_primary_hcd(hcd)) {
2948 free_irq(hcd->irq, hcd);
2951 usb_deregister_bus(&hcd->self);
2952 hcd_buffer_destroy(hcd);
2954 usb_phy_roothub_power_off(hcd->phy_roothub);
2955 usb_phy_roothub_exit(hcd->phy_roothub);
2957 usb_put_invalidate_rhdev(hcd);
2960 EXPORT_SYMBOL_GPL(usb_remove_hcd);
2963 usb_hcd_platform_shutdown(struct platform_device *dev)
2965 struct usb_hcd *hcd = platform_get_drvdata(dev);
2967 /* No need for pm_runtime_put(), we're shutting down */
2968 pm_runtime_get_sync(&dev->dev);
2970 if (hcd->driver->shutdown)
2971 hcd->driver->shutdown(hcd);
2973 EXPORT_SYMBOL_GPL(usb_hcd_platform_shutdown);
2975 int usb_hcd_setup_local_mem(struct usb_hcd *hcd, phys_addr_t phys_addr,
2976 dma_addr_t dma, size_t size)
2981 hcd->localmem_pool = devm_gen_pool_create(hcd->self.sysdev, 4,
2982 dev_to_node(hcd->self.sysdev),
2983 dev_name(hcd->self.sysdev));
2984 if (IS_ERR(hcd->localmem_pool))
2985 return PTR_ERR(hcd->localmem_pool);
2987 local_mem = devm_memremap(hcd->self.sysdev, phys_addr,
2989 if (IS_ERR(local_mem))
2990 return PTR_ERR(local_mem);
2993 * Here we pass a dma_addr_t but the arg type is a phys_addr_t.
2994 * It's not backed by system memory and thus there's no kernel mapping
2997 err = gen_pool_add_virt(hcd->localmem_pool, (unsigned long)local_mem,
2998 dma, size, dev_to_node(hcd->self.sysdev));
3000 dev_err(hcd->self.sysdev, "gen_pool_add_virt failed with %d\n",
3007 EXPORT_SYMBOL_GPL(usb_hcd_setup_local_mem);
3009 /*-------------------------------------------------------------------------*/
3011 #if IS_ENABLED(CONFIG_USB_MON)
3013 const struct usb_mon_operations *mon_ops;
3016 * The registration is unlocked.
3017 * We do it this way because we do not want to lock in hot paths.
3019 * Notice that the code is minimally error-proof. Because usbmon needs
3020 * symbols from usbcore, usbcore gets referenced and cannot be unloaded first.
3023 int usb_mon_register(const struct usb_mon_operations *ops)
3033 EXPORT_SYMBOL_GPL (usb_mon_register);
3035 void usb_mon_deregister (void)
3038 if (mon_ops == NULL) {
3039 printk(KERN_ERR "USB: monitor was not registered\n");
3045 EXPORT_SYMBOL_GPL (usb_mon_deregister);
3047 #endif /* CONFIG_USB_MON || CONFIG_USB_MON_MODULE */