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>
35 #include <linux/phy/phy.h>
36 #include <linux/usb.h>
37 #include <linux/usb/hcd.h>
38 #include <linux/usb/otg.h>
44 /*-------------------------------------------------------------------------*/
47 * USB Host Controller Driver framework
49 * Plugs into usbcore (usb_bus) and lets HCDs share code, minimizing
50 * HCD-specific behaviors/bugs.
52 * This does error checks, tracks devices and urbs, and delegates to a
53 * "hc_driver" only for code (and data) that really needs to know about
54 * hardware differences. That includes root hub registers, i/o queues,
55 * and so on ... but as little else as possible.
57 * Shared code includes most of the "root hub" code (these are emulated,
58 * though each HC's hardware works differently) and PCI glue, plus request
59 * tracking overhead. The HCD code should only block on spinlocks or on
60 * hardware handshaking; blocking on software events (such as other kernel
61 * threads releasing resources, or completing actions) is all generic.
63 * Happens the USB 2.0 spec says this would be invisible inside the "USBD",
64 * and includes mostly a "HCDI" (HCD Interface) along with some APIs used
65 * only by the hub driver ... and that neither should be seen or used by
66 * usb client device drivers.
68 * Contributors of ideas or unattributed patches include: David Brownell,
69 * Roman Weissgaerber, Rory Bolt, Greg Kroah-Hartman, ...
72 * 2002-02-21 Pull in most of the usb_bus support from usb.c; some
73 * associated cleanup. "usb_hcd" still != "usb_bus".
74 * 2001-12-12 Initial patch version for Linux 2.5.1 kernel.
77 /*-------------------------------------------------------------------------*/
79 /* Keep track of which host controller drivers are loaded */
80 unsigned long usb_hcds_loaded;
81 EXPORT_SYMBOL_GPL(usb_hcds_loaded);
83 /* host controllers we manage */
84 DEFINE_IDR (usb_bus_idr);
85 EXPORT_SYMBOL_GPL (usb_bus_idr);
87 /* used when allocating bus numbers */
90 /* used when updating list of hcds */
91 DEFINE_MUTEX(usb_bus_idr_lock); /* exported only for usbfs */
92 EXPORT_SYMBOL_GPL (usb_bus_idr_lock);
94 /* used for controlling access to virtual root hubs */
95 static DEFINE_SPINLOCK(hcd_root_hub_lock);
97 /* used when updating an endpoint's URB list */
98 static DEFINE_SPINLOCK(hcd_urb_list_lock);
100 /* used to protect against unlinking URBs after the device is gone */
101 static DEFINE_SPINLOCK(hcd_urb_unlink_lock);
103 /* wait queue for synchronous unlinks */
104 DECLARE_WAIT_QUEUE_HEAD(usb_kill_urb_queue);
106 static inline int is_root_hub(struct usb_device *udev)
108 return (udev->parent == NULL);
111 /*-------------------------------------------------------------------------*/
114 * Sharable chunks of root hub code.
117 /*-------------------------------------------------------------------------*/
118 #define KERNEL_REL bin2bcd(((LINUX_VERSION_CODE >> 16) & 0x0ff))
119 #define KERNEL_VER bin2bcd(((LINUX_VERSION_CODE >> 8) & 0x0ff))
121 /* usb 3.1 root hub device descriptor */
122 static const u8 usb31_rh_dev_descriptor[18] = {
123 0x12, /* __u8 bLength; */
124 USB_DT_DEVICE, /* __u8 bDescriptorType; Device */
125 0x10, 0x03, /* __le16 bcdUSB; v3.1 */
127 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
128 0x00, /* __u8 bDeviceSubClass; */
129 0x03, /* __u8 bDeviceProtocol; USB 3 hub */
130 0x09, /* __u8 bMaxPacketSize0; 2^9 = 512 Bytes */
132 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation 0x1d6b */
133 0x03, 0x00, /* __le16 idProduct; device 0x0003 */
134 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
136 0x03, /* __u8 iManufacturer; */
137 0x02, /* __u8 iProduct; */
138 0x01, /* __u8 iSerialNumber; */
139 0x01 /* __u8 bNumConfigurations; */
142 /* usb 3.0 root hub device descriptor */
143 static const u8 usb3_rh_dev_descriptor[18] = {
144 0x12, /* __u8 bLength; */
145 USB_DT_DEVICE, /* __u8 bDescriptorType; Device */
146 0x00, 0x03, /* __le16 bcdUSB; v3.0 */
148 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
149 0x00, /* __u8 bDeviceSubClass; */
150 0x03, /* __u8 bDeviceProtocol; USB 3.0 hub */
151 0x09, /* __u8 bMaxPacketSize0; 2^9 = 512 Bytes */
153 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation 0x1d6b */
154 0x03, 0x00, /* __le16 idProduct; device 0x0003 */
155 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
157 0x03, /* __u8 iManufacturer; */
158 0x02, /* __u8 iProduct; */
159 0x01, /* __u8 iSerialNumber; */
160 0x01 /* __u8 bNumConfigurations; */
163 /* usb 2.5 (wireless USB 1.0) root hub device descriptor */
164 static const u8 usb25_rh_dev_descriptor[18] = {
165 0x12, /* __u8 bLength; */
166 USB_DT_DEVICE, /* __u8 bDescriptorType; Device */
167 0x50, 0x02, /* __le16 bcdUSB; v2.5 */
169 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
170 0x00, /* __u8 bDeviceSubClass; */
171 0x00, /* __u8 bDeviceProtocol; [ usb 2.0 no TT ] */
172 0xFF, /* __u8 bMaxPacketSize0; always 0xFF (WUSB Spec 7.4.1). */
174 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation 0x1d6b */
175 0x02, 0x00, /* __le16 idProduct; device 0x0002 */
176 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
178 0x03, /* __u8 iManufacturer; */
179 0x02, /* __u8 iProduct; */
180 0x01, /* __u8 iSerialNumber; */
181 0x01 /* __u8 bNumConfigurations; */
184 /* usb 2.0 root hub device descriptor */
185 static const u8 usb2_rh_dev_descriptor[18] = {
186 0x12, /* __u8 bLength; */
187 USB_DT_DEVICE, /* __u8 bDescriptorType; Device */
188 0x00, 0x02, /* __le16 bcdUSB; v2.0 */
190 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
191 0x00, /* __u8 bDeviceSubClass; */
192 0x00, /* __u8 bDeviceProtocol; [ usb 2.0 no TT ] */
193 0x40, /* __u8 bMaxPacketSize0; 64 Bytes */
195 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation 0x1d6b */
196 0x02, 0x00, /* __le16 idProduct; device 0x0002 */
197 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
199 0x03, /* __u8 iManufacturer; */
200 0x02, /* __u8 iProduct; */
201 0x01, /* __u8 iSerialNumber; */
202 0x01 /* __u8 bNumConfigurations; */
205 /* no usb 2.0 root hub "device qualifier" descriptor: one speed only */
207 /* usb 1.1 root hub device descriptor */
208 static const u8 usb11_rh_dev_descriptor[18] = {
209 0x12, /* __u8 bLength; */
210 USB_DT_DEVICE, /* __u8 bDescriptorType; Device */
211 0x10, 0x01, /* __le16 bcdUSB; v1.1 */
213 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
214 0x00, /* __u8 bDeviceSubClass; */
215 0x00, /* __u8 bDeviceProtocol; [ low/full speeds only ] */
216 0x40, /* __u8 bMaxPacketSize0; 64 Bytes */
218 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation 0x1d6b */
219 0x01, 0x00, /* __le16 idProduct; device 0x0001 */
220 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
222 0x03, /* __u8 iManufacturer; */
223 0x02, /* __u8 iProduct; */
224 0x01, /* __u8 iSerialNumber; */
225 0x01 /* __u8 bNumConfigurations; */
229 /*-------------------------------------------------------------------------*/
231 /* Configuration descriptors for our root hubs */
233 static const u8 fs_rh_config_descriptor[] = {
235 /* one configuration */
236 0x09, /* __u8 bLength; */
237 USB_DT_CONFIG, /* __u8 bDescriptorType; Configuration */
238 0x19, 0x00, /* __le16 wTotalLength; */
239 0x01, /* __u8 bNumInterfaces; (1) */
240 0x01, /* __u8 bConfigurationValue; */
241 0x00, /* __u8 iConfiguration; */
242 0xc0, /* __u8 bmAttributes;
247 0x00, /* __u8 MaxPower; */
250 * USB 2.0, single TT organization (mandatory):
251 * one interface, protocol 0
253 * USB 2.0, multiple TT organization (optional):
254 * two interfaces, protocols 1 (like single TT)
255 * and 2 (multiple TT mode) ... config is
261 0x09, /* __u8 if_bLength; */
262 USB_DT_INTERFACE, /* __u8 if_bDescriptorType; Interface */
263 0x00, /* __u8 if_bInterfaceNumber; */
264 0x00, /* __u8 if_bAlternateSetting; */
265 0x01, /* __u8 if_bNumEndpoints; */
266 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
267 0x00, /* __u8 if_bInterfaceSubClass; */
268 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
269 0x00, /* __u8 if_iInterface; */
271 /* one endpoint (status change endpoint) */
272 0x07, /* __u8 ep_bLength; */
273 USB_DT_ENDPOINT, /* __u8 ep_bDescriptorType; Endpoint */
274 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
275 0x03, /* __u8 ep_bmAttributes; Interrupt */
276 0x02, 0x00, /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8) */
277 0xff /* __u8 ep_bInterval; (255ms -- usb 2.0 spec) */
280 static const u8 hs_rh_config_descriptor[] = {
282 /* one configuration */
283 0x09, /* __u8 bLength; */
284 USB_DT_CONFIG, /* __u8 bDescriptorType; Configuration */
285 0x19, 0x00, /* __le16 wTotalLength; */
286 0x01, /* __u8 bNumInterfaces; (1) */
287 0x01, /* __u8 bConfigurationValue; */
288 0x00, /* __u8 iConfiguration; */
289 0xc0, /* __u8 bmAttributes;
294 0x00, /* __u8 MaxPower; */
297 * USB 2.0, single TT organization (mandatory):
298 * one interface, protocol 0
300 * USB 2.0, multiple TT organization (optional):
301 * two interfaces, protocols 1 (like single TT)
302 * and 2 (multiple TT mode) ... config is
308 0x09, /* __u8 if_bLength; */
309 USB_DT_INTERFACE, /* __u8 if_bDescriptorType; Interface */
310 0x00, /* __u8 if_bInterfaceNumber; */
311 0x00, /* __u8 if_bAlternateSetting; */
312 0x01, /* __u8 if_bNumEndpoints; */
313 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
314 0x00, /* __u8 if_bInterfaceSubClass; */
315 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
316 0x00, /* __u8 if_iInterface; */
318 /* one endpoint (status change endpoint) */
319 0x07, /* __u8 ep_bLength; */
320 USB_DT_ENDPOINT, /* __u8 ep_bDescriptorType; Endpoint */
321 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
322 0x03, /* __u8 ep_bmAttributes; Interrupt */
323 /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8)
324 * see hub.c:hub_configure() for details. */
325 (USB_MAXCHILDREN + 1 + 7) / 8, 0x00,
326 0x0c /* __u8 ep_bInterval; (256ms -- usb 2.0 spec) */
329 static const u8 ss_rh_config_descriptor[] = {
330 /* one configuration */
331 0x09, /* __u8 bLength; */
332 USB_DT_CONFIG, /* __u8 bDescriptorType; Configuration */
333 0x1f, 0x00, /* __le16 wTotalLength; */
334 0x01, /* __u8 bNumInterfaces; (1) */
335 0x01, /* __u8 bConfigurationValue; */
336 0x00, /* __u8 iConfiguration; */
337 0xc0, /* __u8 bmAttributes;
342 0x00, /* __u8 MaxPower; */
345 0x09, /* __u8 if_bLength; */
346 USB_DT_INTERFACE, /* __u8 if_bDescriptorType; Interface */
347 0x00, /* __u8 if_bInterfaceNumber; */
348 0x00, /* __u8 if_bAlternateSetting; */
349 0x01, /* __u8 if_bNumEndpoints; */
350 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
351 0x00, /* __u8 if_bInterfaceSubClass; */
352 0x00, /* __u8 if_bInterfaceProtocol; */
353 0x00, /* __u8 if_iInterface; */
355 /* one endpoint (status change endpoint) */
356 0x07, /* __u8 ep_bLength; */
357 USB_DT_ENDPOINT, /* __u8 ep_bDescriptorType; Endpoint */
358 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
359 0x03, /* __u8 ep_bmAttributes; Interrupt */
360 /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8)
361 * see hub.c:hub_configure() for details. */
362 (USB_MAXCHILDREN + 1 + 7) / 8, 0x00,
363 0x0c, /* __u8 ep_bInterval; (256ms -- usb 2.0 spec) */
365 /* one SuperSpeed endpoint companion descriptor */
366 0x06, /* __u8 ss_bLength */
367 USB_DT_SS_ENDPOINT_COMP, /* __u8 ss_bDescriptorType; SuperSpeed EP */
369 0x00, /* __u8 ss_bMaxBurst; allows 1 TX between ACKs */
370 0x00, /* __u8 ss_bmAttributes; 1 packet per service interval */
371 0x02, 0x00 /* __le16 ss_wBytesPerInterval; 15 bits for max 15 ports */
374 /* authorized_default behaviour:
375 * -1 is authorized for all devices except wireless (old behaviour)
376 * 0 is unauthorized for all devices
377 * 1 is authorized for all devices
378 * 2 is authorized for internal devices
380 #define USB_AUTHORIZE_WIRED -1
381 #define USB_AUTHORIZE_NONE 0
382 #define USB_AUTHORIZE_ALL 1
383 #define USB_AUTHORIZE_INTERNAL 2
385 static int authorized_default = USB_AUTHORIZE_WIRED;
386 module_param(authorized_default, int, S_IRUGO|S_IWUSR);
387 MODULE_PARM_DESC(authorized_default,
388 "Default USB device authorization: 0 is not authorized, 1 is "
389 "authorized, 2 is authorized for internal devices, -1 is "
390 "authorized except for wireless USB (default, old behaviour)");
391 /*-------------------------------------------------------------------------*/
394 * ascii2desc() - Helper routine for producing UTF-16LE string descriptors
395 * @s: Null-terminated ASCII (actually ISO-8859-1) string
396 * @buf: Buffer for USB string descriptor (header + UTF-16LE)
397 * @len: Length (in bytes; may be odd) of descriptor buffer.
399 * Return: The number of bytes filled in: 2 + 2*strlen(s) or @len,
403 * USB String descriptors can contain at most 126 characters; input
404 * strings longer than that are truncated.
407 ascii2desc(char const *s, u8 *buf, unsigned len)
409 unsigned n, t = 2 + 2*strlen(s);
412 t = 254; /* Longest possible UTF string descriptor */
416 t += USB_DT_STRING << 8; /* Now t is first 16 bits to store */
424 t = (unsigned char)*s++;
430 * rh_string() - provides string descriptors for root hub
431 * @id: the string ID number (0: langids, 1: serial #, 2: product, 3: vendor)
432 * @hcd: the host controller for this root hub
433 * @data: buffer for output packet
434 * @len: length of the provided buffer
436 * Produces either a manufacturer, product or serial number string for the
437 * virtual root hub device.
439 * Return: The number of bytes filled in: the length of the descriptor or
440 * of the provided buffer, whichever is less.
443 rh_string(int id, struct usb_hcd const *hcd, u8 *data, unsigned len)
447 static char const langids[4] = {4, USB_DT_STRING, 0x09, 0x04};
452 /* Array of LANGID codes (0x0409 is MSFT-speak for "en-us") */
453 /* See http://www.usb.org/developers/docs/USB_LANGIDs.pdf */
456 memcpy(data, langids, len);
460 s = hcd->self.bus_name;
464 s = hcd->product_desc;
468 snprintf (buf, sizeof buf, "%s %s %s", init_utsname()->sysname,
469 init_utsname()->release, hcd->driver->description);
473 /* Can't happen; caller guarantees it */
477 return ascii2desc(s, data, len);
481 /* Root hub control transfers execute synchronously */
482 static int rh_call_control (struct usb_hcd *hcd, struct urb *urb)
484 struct usb_ctrlrequest *cmd;
485 u16 typeReq, wValue, wIndex, wLength;
486 u8 *ubuf = urb->transfer_buffer;
490 u8 patch_protocol = 0;
497 spin_lock_irq(&hcd_root_hub_lock);
498 status = usb_hcd_link_urb_to_ep(hcd, urb);
499 spin_unlock_irq(&hcd_root_hub_lock);
502 urb->hcpriv = hcd; /* Indicate it's queued */
504 cmd = (struct usb_ctrlrequest *) urb->setup_packet;
505 typeReq = (cmd->bRequestType << 8) | cmd->bRequest;
506 wValue = le16_to_cpu (cmd->wValue);
507 wIndex = le16_to_cpu (cmd->wIndex);
508 wLength = le16_to_cpu (cmd->wLength);
510 if (wLength > urb->transfer_buffer_length)
514 * tbuf should be at least as big as the
515 * USB hub descriptor.
517 tbuf_size = max_t(u16, sizeof(struct usb_hub_descriptor), wLength);
518 tbuf = kzalloc(tbuf_size, GFP_KERNEL);
527 urb->actual_length = 0;
530 /* DEVICE REQUESTS */
532 /* The root hub's remote wakeup enable bit is implemented using
533 * driver model wakeup flags. If this system supports wakeup
534 * through USB, userspace may change the default "allow wakeup"
535 * policy through sysfs or these calls.
537 * Most root hubs support wakeup from downstream devices, for
538 * runtime power management (disabling USB clocks and reducing
539 * VBUS power usage). However, not all of them do so; silicon,
540 * board, and BIOS bugs here are not uncommon, so these can't
541 * be treated quite like external hubs.
543 * Likewise, not all root hubs will pass wakeup events upstream,
544 * to wake up the whole system. So don't assume root hub and
545 * controller capabilities are identical.
548 case DeviceRequest | USB_REQ_GET_STATUS:
549 tbuf[0] = (device_may_wakeup(&hcd->self.root_hub->dev)
550 << USB_DEVICE_REMOTE_WAKEUP)
551 | (1 << USB_DEVICE_SELF_POWERED);
555 case DeviceOutRequest | USB_REQ_CLEAR_FEATURE:
556 if (wValue == USB_DEVICE_REMOTE_WAKEUP)
557 device_set_wakeup_enable(&hcd->self.root_hub->dev, 0);
561 case DeviceOutRequest | USB_REQ_SET_FEATURE:
562 if (device_can_wakeup(&hcd->self.root_hub->dev)
563 && wValue == USB_DEVICE_REMOTE_WAKEUP)
564 device_set_wakeup_enable(&hcd->self.root_hub->dev, 1);
568 case DeviceRequest | USB_REQ_GET_CONFIGURATION:
572 case DeviceOutRequest | USB_REQ_SET_CONFIGURATION:
574 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
575 switch (wValue & 0xff00) {
576 case USB_DT_DEVICE << 8:
577 switch (hcd->speed) {
580 bufp = usb31_rh_dev_descriptor;
583 bufp = usb3_rh_dev_descriptor;
586 bufp = usb25_rh_dev_descriptor;
589 bufp = usb2_rh_dev_descriptor;
592 bufp = usb11_rh_dev_descriptor;
601 case USB_DT_CONFIG << 8:
602 switch (hcd->speed) {
606 bufp = ss_rh_config_descriptor;
607 len = sizeof ss_rh_config_descriptor;
611 bufp = hs_rh_config_descriptor;
612 len = sizeof hs_rh_config_descriptor;
615 bufp = fs_rh_config_descriptor;
616 len = sizeof fs_rh_config_descriptor;
621 if (device_can_wakeup(&hcd->self.root_hub->dev))
624 case USB_DT_STRING << 8:
625 if ((wValue & 0xff) < 4)
626 urb->actual_length = rh_string(wValue & 0xff,
628 else /* unsupported IDs --> "protocol stall" */
631 case USB_DT_BOS << 8:
637 case DeviceRequest | USB_REQ_GET_INTERFACE:
641 case DeviceOutRequest | USB_REQ_SET_INTERFACE:
643 case DeviceOutRequest | USB_REQ_SET_ADDRESS:
644 /* wValue == urb->dev->devaddr */
645 dev_dbg (hcd->self.controller, "root hub device address %d\n",
649 /* INTERFACE REQUESTS (no defined feature/status flags) */
651 /* ENDPOINT REQUESTS */
653 case EndpointRequest | USB_REQ_GET_STATUS:
654 /* ENDPOINT_HALT flag */
659 case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
660 case EndpointOutRequest | USB_REQ_SET_FEATURE:
661 dev_dbg (hcd->self.controller, "no endpoint features yet\n");
664 /* CLASS REQUESTS (and errors) */
668 /* non-generic request */
674 if (wValue == HUB_PORT_STATUS)
677 /* other port status types return 8 bytes */
680 case GetHubDescriptor:
681 len = sizeof (struct usb_hub_descriptor);
683 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
684 /* len is returned by hub_control */
687 status = hcd->driver->hub_control (hcd,
688 typeReq, wValue, wIndex,
691 if (typeReq == GetHubDescriptor)
692 usb_hub_adjust_deviceremovable(hcd->self.root_hub,
693 (struct usb_hub_descriptor *)tbuf);
696 /* "protocol stall" on error */
702 if (status != -EPIPE) {
703 dev_dbg (hcd->self.controller,
704 "CTRL: TypeReq=0x%x val=0x%x "
705 "idx=0x%x len=%d ==> %d\n",
706 typeReq, wValue, wIndex,
709 } else if (status > 0) {
710 /* hub_control may return the length of data copied. */
715 if (urb->transfer_buffer_length < len)
716 len = urb->transfer_buffer_length;
717 urb->actual_length = len;
718 /* always USB_DIR_IN, toward host */
719 memcpy (ubuf, bufp, len);
721 /* report whether RH hardware supports remote wakeup */
723 len > offsetof (struct usb_config_descriptor,
725 ((struct usb_config_descriptor *)ubuf)->bmAttributes
726 |= USB_CONFIG_ATT_WAKEUP;
728 /* report whether RH hardware has an integrated TT */
729 if (patch_protocol &&
730 len > offsetof(struct usb_device_descriptor,
732 ((struct usb_device_descriptor *) ubuf)->
733 bDeviceProtocol = USB_HUB_PR_HS_SINGLE_TT;
739 /* any errors get returned through the urb completion */
740 spin_lock_irq(&hcd_root_hub_lock);
741 usb_hcd_unlink_urb_from_ep(hcd, urb);
742 usb_hcd_giveback_urb(hcd, urb, status);
743 spin_unlock_irq(&hcd_root_hub_lock);
747 /*-------------------------------------------------------------------------*/
750 * Root Hub interrupt transfers are polled using a timer if the
751 * driver requests it; otherwise the driver is responsible for
752 * calling usb_hcd_poll_rh_status() when an event occurs.
754 * Completions are called in_interrupt(), but they may or may not
757 void usb_hcd_poll_rh_status(struct usb_hcd *hcd)
762 char buffer[6]; /* Any root hubs with > 31 ports? */
764 if (unlikely(!hcd->rh_pollable))
766 if (!hcd->uses_new_polling && !hcd->status_urb)
769 length = hcd->driver->hub_status_data(hcd, buffer);
772 /* try to complete the status urb */
773 spin_lock_irqsave(&hcd_root_hub_lock, flags);
774 urb = hcd->status_urb;
776 clear_bit(HCD_FLAG_POLL_PENDING, &hcd->flags);
777 hcd->status_urb = NULL;
778 urb->actual_length = length;
779 memcpy(urb->transfer_buffer, buffer, length);
781 usb_hcd_unlink_urb_from_ep(hcd, urb);
782 usb_hcd_giveback_urb(hcd, urb, 0);
785 set_bit(HCD_FLAG_POLL_PENDING, &hcd->flags);
787 spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
790 /* The USB 2.0 spec says 256 ms. This is close enough and won't
791 * exceed that limit if HZ is 100. The math is more clunky than
792 * maybe expected, this is to make sure that all timers for USB devices
793 * fire at the same time to give the CPU a break in between */
794 if (hcd->uses_new_polling ? HCD_POLL_RH(hcd) :
795 (length == 0 && hcd->status_urb != NULL))
796 mod_timer (&hcd->rh_timer, (jiffies/(HZ/4) + 1) * (HZ/4));
798 EXPORT_SYMBOL_GPL(usb_hcd_poll_rh_status);
801 static void rh_timer_func (struct timer_list *t)
803 struct usb_hcd *_hcd = from_timer(_hcd, t, rh_timer);
805 usb_hcd_poll_rh_status(_hcd);
808 /*-------------------------------------------------------------------------*/
810 static int rh_queue_status (struct usb_hcd *hcd, struct urb *urb)
814 unsigned len = 1 + (urb->dev->maxchild / 8);
816 spin_lock_irqsave (&hcd_root_hub_lock, flags);
817 if (hcd->status_urb || urb->transfer_buffer_length < len) {
818 dev_dbg (hcd->self.controller, "not queuing rh status urb\n");
823 retval = usb_hcd_link_urb_to_ep(hcd, urb);
827 hcd->status_urb = urb;
828 urb->hcpriv = hcd; /* indicate it's queued */
829 if (!hcd->uses_new_polling)
830 mod_timer(&hcd->rh_timer, (jiffies/(HZ/4) + 1) * (HZ/4));
832 /* If a status change has already occurred, report it ASAP */
833 else if (HCD_POLL_PENDING(hcd))
834 mod_timer(&hcd->rh_timer, jiffies);
837 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
841 static int rh_urb_enqueue (struct usb_hcd *hcd, struct urb *urb)
843 if (usb_endpoint_xfer_int(&urb->ep->desc))
844 return rh_queue_status (hcd, urb);
845 if (usb_endpoint_xfer_control(&urb->ep->desc))
846 return rh_call_control (hcd, urb);
850 /*-------------------------------------------------------------------------*/
852 /* Unlinks of root-hub control URBs are legal, but they don't do anything
853 * since these URBs always execute synchronously.
855 static int usb_rh_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
860 spin_lock_irqsave(&hcd_root_hub_lock, flags);
861 rc = usb_hcd_check_unlink_urb(hcd, urb, status);
865 if (usb_endpoint_num(&urb->ep->desc) == 0) { /* Control URB */
868 } else { /* Status URB */
869 if (!hcd->uses_new_polling)
870 del_timer (&hcd->rh_timer);
871 if (urb == hcd->status_urb) {
872 hcd->status_urb = NULL;
873 usb_hcd_unlink_urb_from_ep(hcd, urb);
874 usb_hcd_giveback_urb(hcd, urb, status);
878 spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
885 * Show & store the current value of authorized_default
887 static ssize_t authorized_default_show(struct device *dev,
888 struct device_attribute *attr, char *buf)
890 struct usb_device *rh_usb_dev = to_usb_device(dev);
891 struct usb_bus *usb_bus = rh_usb_dev->bus;
894 hcd = bus_to_hcd(usb_bus);
895 return snprintf(buf, PAGE_SIZE, "%u\n", hcd->dev_policy);
898 static ssize_t authorized_default_store(struct device *dev,
899 struct device_attribute *attr,
900 const char *buf, size_t size)
904 struct usb_device *rh_usb_dev = to_usb_device(dev);
905 struct usb_bus *usb_bus = rh_usb_dev->bus;
908 hcd = bus_to_hcd(usb_bus);
909 result = sscanf(buf, "%u\n", &val);
911 hcd->dev_policy = val <= USB_DEVICE_AUTHORIZE_INTERNAL ?
912 val : USB_DEVICE_AUTHORIZE_ALL;
919 static DEVICE_ATTR_RW(authorized_default);
922 * interface_authorized_default_show - show default authorization status
925 * note: interface_authorized_default is the default value
926 * for initializing the authorized attribute of interfaces
928 static ssize_t interface_authorized_default_show(struct device *dev,
929 struct device_attribute *attr, char *buf)
931 struct usb_device *usb_dev = to_usb_device(dev);
932 struct usb_hcd *hcd = bus_to_hcd(usb_dev->bus);
934 return sprintf(buf, "%u\n", !!HCD_INTF_AUTHORIZED(hcd));
938 * interface_authorized_default_store - store default authorization status
941 * note: interface_authorized_default is the default value
942 * for initializing the authorized attribute of interfaces
944 static ssize_t interface_authorized_default_store(struct device *dev,
945 struct device_attribute *attr, const char *buf, size_t count)
947 struct usb_device *usb_dev = to_usb_device(dev);
948 struct usb_hcd *hcd = bus_to_hcd(usb_dev->bus);
952 if (strtobool(buf, &val) != 0)
956 set_bit(HCD_FLAG_INTF_AUTHORIZED, &hcd->flags);
958 clear_bit(HCD_FLAG_INTF_AUTHORIZED, &hcd->flags);
962 static DEVICE_ATTR_RW(interface_authorized_default);
964 /* Group all the USB bus attributes */
965 static struct attribute *usb_bus_attrs[] = {
966 &dev_attr_authorized_default.attr,
967 &dev_attr_interface_authorized_default.attr,
971 static const struct attribute_group usb_bus_attr_group = {
972 .name = NULL, /* we want them in the same directory */
973 .attrs = usb_bus_attrs,
978 /*-------------------------------------------------------------------------*/
981 * usb_bus_init - shared initialization code
982 * @bus: the bus structure being initialized
984 * This code is used to initialize a usb_bus structure, memory for which is
985 * separately managed.
987 static void usb_bus_init (struct usb_bus *bus)
989 memset (&bus->devmap, 0, sizeof(struct usb_devmap));
991 bus->devnum_next = 1;
993 bus->root_hub = NULL;
995 bus->bandwidth_allocated = 0;
996 bus->bandwidth_int_reqs = 0;
997 bus->bandwidth_isoc_reqs = 0;
998 mutex_init(&bus->devnum_next_mutex);
1001 /*-------------------------------------------------------------------------*/
1004 * usb_register_bus - registers the USB host controller with the usb core
1005 * @bus: pointer to the bus to register
1006 * Context: !in_interrupt()
1008 * Assigns a bus number, and links the controller into usbcore data
1009 * structures so that it can be seen by scanning the bus list.
1011 * Return: 0 if successful. A negative error code otherwise.
1013 static int usb_register_bus(struct usb_bus *bus)
1015 int result = -E2BIG;
1018 mutex_lock(&usb_bus_idr_lock);
1019 busnum = idr_alloc(&usb_bus_idr, bus, 1, USB_MAXBUS, GFP_KERNEL);
1021 pr_err("%s: failed to get bus number\n", usbcore_name);
1022 goto error_find_busnum;
1024 bus->busnum = busnum;
1025 mutex_unlock(&usb_bus_idr_lock);
1027 usb_notify_add_bus(bus);
1029 dev_info (bus->controller, "new USB bus registered, assigned bus "
1030 "number %d\n", bus->busnum);
1034 mutex_unlock(&usb_bus_idr_lock);
1039 * usb_deregister_bus - deregisters the USB host controller
1040 * @bus: pointer to the bus to deregister
1041 * Context: !in_interrupt()
1043 * Recycles the bus number, and unlinks the controller from usbcore data
1044 * structures so that it won't be seen by scanning the bus list.
1046 static void usb_deregister_bus (struct usb_bus *bus)
1048 dev_info (bus->controller, "USB bus %d deregistered\n", bus->busnum);
1051 * NOTE: make sure that all the devices are removed by the
1052 * controller code, as well as having it call this when cleaning
1055 mutex_lock(&usb_bus_idr_lock);
1056 idr_remove(&usb_bus_idr, bus->busnum);
1057 mutex_unlock(&usb_bus_idr_lock);
1059 usb_notify_remove_bus(bus);
1063 * register_root_hub - called by usb_add_hcd() to register a root hub
1064 * @hcd: host controller for this root hub
1066 * This function registers the root hub with the USB subsystem. It sets up
1067 * the device properly in the device tree and then calls usb_new_device()
1068 * to register the usb device. It also assigns the root hub's USB address
1071 * Return: 0 if successful. A negative error code otherwise.
1073 static int register_root_hub(struct usb_hcd *hcd)
1075 struct device *parent_dev = hcd->self.controller;
1076 struct usb_device *usb_dev = hcd->self.root_hub;
1077 const int devnum = 1;
1080 usb_dev->devnum = devnum;
1081 usb_dev->bus->devnum_next = devnum + 1;
1082 set_bit (devnum, usb_dev->bus->devmap.devicemap);
1083 usb_set_device_state(usb_dev, USB_STATE_ADDRESS);
1085 mutex_lock(&usb_bus_idr_lock);
1087 usb_dev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
1088 retval = usb_get_device_descriptor(usb_dev, USB_DT_DEVICE_SIZE);
1089 if (retval != sizeof usb_dev->descriptor) {
1090 mutex_unlock(&usb_bus_idr_lock);
1091 dev_dbg (parent_dev, "can't read %s device descriptor %d\n",
1092 dev_name(&usb_dev->dev), retval);
1093 return (retval < 0) ? retval : -EMSGSIZE;
1096 if (le16_to_cpu(usb_dev->descriptor.bcdUSB) >= 0x0201) {
1097 retval = usb_get_bos_descriptor(usb_dev);
1099 usb_dev->lpm_capable = usb_device_supports_lpm(usb_dev);
1100 } else if (usb_dev->speed >= USB_SPEED_SUPER) {
1101 mutex_unlock(&usb_bus_idr_lock);
1102 dev_dbg(parent_dev, "can't read %s bos descriptor %d\n",
1103 dev_name(&usb_dev->dev), retval);
1108 retval = usb_new_device (usb_dev);
1110 dev_err (parent_dev, "can't register root hub for %s, %d\n",
1111 dev_name(&usb_dev->dev), retval);
1113 spin_lock_irq (&hcd_root_hub_lock);
1114 hcd->rh_registered = 1;
1115 spin_unlock_irq (&hcd_root_hub_lock);
1117 /* Did the HC die before the root hub was registered? */
1119 usb_hc_died (hcd); /* This time clean up */
1121 mutex_unlock(&usb_bus_idr_lock);
1127 * usb_hcd_start_port_resume - a root-hub port is sending a resume signal
1128 * @bus: the bus which the root hub belongs to
1129 * @portnum: the port which is being resumed
1131 * HCDs should call this function when they know that a resume signal is
1132 * being sent to a root-hub port. The root hub will be prevented from
1133 * going into autosuspend until usb_hcd_end_port_resume() is called.
1135 * The bus's private lock must be held by the caller.
1137 void usb_hcd_start_port_resume(struct usb_bus *bus, int portnum)
1139 unsigned bit = 1 << portnum;
1141 if (!(bus->resuming_ports & bit)) {
1142 bus->resuming_ports |= bit;
1143 pm_runtime_get_noresume(&bus->root_hub->dev);
1146 EXPORT_SYMBOL_GPL(usb_hcd_start_port_resume);
1149 * usb_hcd_end_port_resume - a root-hub port has stopped sending a resume signal
1150 * @bus: the bus which the root hub belongs to
1151 * @portnum: the port which is being resumed
1153 * HCDs should call this function when they know that a resume signal has
1154 * stopped being sent to a root-hub port. The root hub will be allowed to
1155 * autosuspend again.
1157 * The bus's private lock must be held by the caller.
1159 void usb_hcd_end_port_resume(struct usb_bus *bus, int portnum)
1161 unsigned bit = 1 << portnum;
1163 if (bus->resuming_ports & bit) {
1164 bus->resuming_ports &= ~bit;
1165 pm_runtime_put_noidle(&bus->root_hub->dev);
1168 EXPORT_SYMBOL_GPL(usb_hcd_end_port_resume);
1170 /*-------------------------------------------------------------------------*/
1173 * usb_calc_bus_time - approximate periodic transaction time in nanoseconds
1174 * @speed: from dev->speed; USB_SPEED_{LOW,FULL,HIGH}
1175 * @is_input: true iff the transaction sends data to the host
1176 * @isoc: true for isochronous transactions, false for interrupt ones
1177 * @bytecount: how many bytes in the transaction.
1179 * Return: Approximate bus time in nanoseconds for a periodic transaction.
1182 * See USB 2.0 spec section 5.11.3; only periodic transfers need to be
1183 * scheduled in software, this function is only used for such scheduling.
1185 long usb_calc_bus_time (int speed, int is_input, int isoc, int bytecount)
1190 case USB_SPEED_LOW: /* INTR only */
1192 tmp = (67667L * (31L + 10L * BitTime (bytecount))) / 1000L;
1193 return 64060L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp;
1195 tmp = (66700L * (31L + 10L * BitTime (bytecount))) / 1000L;
1196 return 64107L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp;
1198 case USB_SPEED_FULL: /* ISOC or INTR */
1200 tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
1201 return ((is_input) ? 7268L : 6265L) + BW_HOST_DELAY + tmp;
1203 tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
1204 return 9107L + BW_HOST_DELAY + tmp;
1206 case USB_SPEED_HIGH: /* ISOC or INTR */
1207 /* FIXME adjust for input vs output */
1209 tmp = HS_NSECS_ISO (bytecount);
1211 tmp = HS_NSECS (bytecount);
1214 pr_debug ("%s: bogus device speed!\n", usbcore_name);
1218 EXPORT_SYMBOL_GPL(usb_calc_bus_time);
1221 /*-------------------------------------------------------------------------*/
1224 * Generic HC operations.
1227 /*-------------------------------------------------------------------------*/
1230 * usb_hcd_link_urb_to_ep - add an URB to its endpoint queue
1231 * @hcd: host controller to which @urb was submitted
1232 * @urb: URB being submitted
1234 * Host controller drivers should call this routine in their enqueue()
1235 * method. The HCD's private spinlock must be held and interrupts must
1236 * be disabled. The actions carried out here are required for URB
1237 * submission, as well as for endpoint shutdown and for usb_kill_urb.
1239 * Return: 0 for no error, otherwise a negative error code (in which case
1240 * the enqueue() method must fail). If no error occurs but enqueue() fails
1241 * anyway, it must call usb_hcd_unlink_urb_from_ep() before releasing
1242 * the private spinlock and returning.
1244 int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb)
1248 spin_lock(&hcd_urb_list_lock);
1250 /* Check that the URB isn't being killed */
1251 if (unlikely(atomic_read(&urb->reject))) {
1256 if (unlikely(!urb->ep->enabled)) {
1261 if (unlikely(!urb->dev->can_submit)) {
1267 * Check the host controller's state and add the URB to the
1270 if (HCD_RH_RUNNING(hcd)) {
1272 list_add_tail(&urb->urb_list, &urb->ep->urb_list);
1278 spin_unlock(&hcd_urb_list_lock);
1281 EXPORT_SYMBOL_GPL(usb_hcd_link_urb_to_ep);
1284 * usb_hcd_check_unlink_urb - check whether an URB may be unlinked
1285 * @hcd: host controller to which @urb was submitted
1286 * @urb: URB being checked for unlinkability
1287 * @status: error code to store in @urb if the unlink succeeds
1289 * Host controller drivers should call this routine in their dequeue()
1290 * method. The HCD's private spinlock must be held and interrupts must
1291 * be disabled. The actions carried out here are required for making
1292 * sure than an unlink is valid.
1294 * Return: 0 for no error, otherwise a negative error code (in which case
1295 * the dequeue() method must fail). The possible error codes are:
1297 * -EIDRM: @urb was not submitted or has already completed.
1298 * The completion function may not have been called yet.
1300 * -EBUSY: @urb has already been unlinked.
1302 int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb,
1305 struct list_head *tmp;
1307 /* insist the urb is still queued */
1308 list_for_each(tmp, &urb->ep->urb_list) {
1309 if (tmp == &urb->urb_list)
1312 if (tmp != &urb->urb_list)
1315 /* Any status except -EINPROGRESS means something already started to
1316 * unlink this URB from the hardware. So there's no more work to do.
1320 urb->unlinked = status;
1323 EXPORT_SYMBOL_GPL(usb_hcd_check_unlink_urb);
1326 * usb_hcd_unlink_urb_from_ep - remove an URB from its endpoint queue
1327 * @hcd: host controller to which @urb was submitted
1328 * @urb: URB being unlinked
1330 * Host controller drivers should call this routine before calling
1331 * usb_hcd_giveback_urb(). The HCD's private spinlock must be held and
1332 * interrupts must be disabled. The actions carried out here are required
1333 * for URB completion.
1335 void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb)
1337 /* clear all state linking urb to this dev (and hcd) */
1338 spin_lock(&hcd_urb_list_lock);
1339 list_del_init(&urb->urb_list);
1340 spin_unlock(&hcd_urb_list_lock);
1342 EXPORT_SYMBOL_GPL(usb_hcd_unlink_urb_from_ep);
1345 * Some usb host controllers can only perform dma using a small SRAM area.
1346 * The usb core itself is however optimized for host controllers that can dma
1347 * using regular system memory - like pci devices doing bus mastering.
1349 * To support host controllers with limited dma capabilities we provide dma
1350 * bounce buffers. This feature can be enabled using the HCD_LOCAL_MEM flag.
1351 * For this to work properly the host controller code must first use the
1352 * function dma_declare_coherent_memory() to point out which memory area
1353 * that should be used for dma allocations.
1355 * The HCD_LOCAL_MEM flag then tells the usb code to allocate all data for
1356 * dma using dma_alloc_coherent() which in turn allocates from the memory
1357 * area pointed out with dma_declare_coherent_memory().
1359 * So, to summarize...
1361 * - We need "local" memory, canonical example being
1362 * a small SRAM on a discrete controller being the
1363 * only memory that the controller can read ...
1364 * (a) "normal" kernel memory is no good, and
1365 * (b) there's not enough to share
1367 * - The only *portable* hook for such stuff in the
1368 * DMA framework is dma_declare_coherent_memory()
1370 * - So we use that, even though the primary requirement
1371 * is that the memory be "local" (hence addressable
1372 * by that device), not "coherent".
1376 static int hcd_alloc_coherent(struct usb_bus *bus,
1377 gfp_t mem_flags, dma_addr_t *dma_handle,
1378 void **vaddr_handle, size_t size,
1379 enum dma_data_direction dir)
1381 unsigned char *vaddr;
1383 if (*vaddr_handle == NULL) {
1388 vaddr = hcd_buffer_alloc(bus, size + sizeof(vaddr),
1389 mem_flags, dma_handle);
1394 * Store the virtual address of the buffer at the end
1395 * of the allocated dma buffer. The size of the buffer
1396 * may be uneven so use unaligned functions instead
1397 * of just rounding up. It makes sense to optimize for
1398 * memory footprint over access speed since the amount
1399 * of memory available for dma may be limited.
1401 put_unaligned((unsigned long)*vaddr_handle,
1402 (unsigned long *)(vaddr + size));
1404 if (dir == DMA_TO_DEVICE)
1405 memcpy(vaddr, *vaddr_handle, size);
1407 *vaddr_handle = vaddr;
1411 static void hcd_free_coherent(struct usb_bus *bus, dma_addr_t *dma_handle,
1412 void **vaddr_handle, size_t size,
1413 enum dma_data_direction dir)
1415 unsigned char *vaddr = *vaddr_handle;
1417 vaddr = (void *)get_unaligned((unsigned long *)(vaddr + size));
1419 if (dir == DMA_FROM_DEVICE)
1420 memcpy(vaddr, *vaddr_handle, size);
1422 hcd_buffer_free(bus, size + sizeof(vaddr), *vaddr_handle, *dma_handle);
1424 *vaddr_handle = vaddr;
1428 void usb_hcd_unmap_urb_setup_for_dma(struct usb_hcd *hcd, struct urb *urb)
1430 if (IS_ENABLED(CONFIG_HAS_DMA) &&
1431 (urb->transfer_flags & URB_SETUP_MAP_SINGLE))
1432 dma_unmap_single(hcd->self.sysdev,
1434 sizeof(struct usb_ctrlrequest),
1436 else if (urb->transfer_flags & URB_SETUP_MAP_LOCAL)
1437 hcd_free_coherent(urb->dev->bus,
1439 (void **) &urb->setup_packet,
1440 sizeof(struct usb_ctrlrequest),
1443 /* Make it safe to call this routine more than once */
1444 urb->transfer_flags &= ~(URB_SETUP_MAP_SINGLE | URB_SETUP_MAP_LOCAL);
1446 EXPORT_SYMBOL_GPL(usb_hcd_unmap_urb_setup_for_dma);
1448 static void unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
1450 if (hcd->driver->unmap_urb_for_dma)
1451 hcd->driver->unmap_urb_for_dma(hcd, urb);
1453 usb_hcd_unmap_urb_for_dma(hcd, urb);
1456 void usb_hcd_unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
1458 enum dma_data_direction dir;
1460 usb_hcd_unmap_urb_setup_for_dma(hcd, urb);
1462 dir = usb_urb_dir_in(urb) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
1463 if (IS_ENABLED(CONFIG_HAS_DMA) &&
1464 (urb->transfer_flags & URB_DMA_MAP_SG))
1465 dma_unmap_sg(hcd->self.sysdev,
1469 else if (IS_ENABLED(CONFIG_HAS_DMA) &&
1470 (urb->transfer_flags & URB_DMA_MAP_PAGE))
1471 dma_unmap_page(hcd->self.sysdev,
1473 urb->transfer_buffer_length,
1475 else if (IS_ENABLED(CONFIG_HAS_DMA) &&
1476 (urb->transfer_flags & URB_DMA_MAP_SINGLE))
1477 dma_unmap_single(hcd->self.sysdev,
1479 urb->transfer_buffer_length,
1481 else if (urb->transfer_flags & URB_MAP_LOCAL)
1482 hcd_free_coherent(urb->dev->bus,
1484 &urb->transfer_buffer,
1485 urb->transfer_buffer_length,
1488 /* Make it safe to call this routine more than once */
1489 urb->transfer_flags &= ~(URB_DMA_MAP_SG | URB_DMA_MAP_PAGE |
1490 URB_DMA_MAP_SINGLE | URB_MAP_LOCAL);
1492 EXPORT_SYMBOL_GPL(usb_hcd_unmap_urb_for_dma);
1494 static int map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
1497 if (hcd->driver->map_urb_for_dma)
1498 return hcd->driver->map_urb_for_dma(hcd, urb, mem_flags);
1500 return usb_hcd_map_urb_for_dma(hcd, urb, mem_flags);
1503 int usb_hcd_map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
1506 enum dma_data_direction dir;
1509 /* Map the URB's buffers for DMA access.
1510 * Lower level HCD code should use *_dma exclusively,
1511 * unless it uses pio or talks to another transport,
1512 * or uses the provided scatter gather list for bulk.
1515 if (usb_endpoint_xfer_control(&urb->ep->desc)) {
1516 if (hcd->self.uses_pio_for_control)
1518 if (IS_ENABLED(CONFIG_HAS_DMA) && hcd->self.uses_dma) {
1519 if (is_vmalloc_addr(urb->setup_packet)) {
1520 WARN_ONCE(1, "setup packet is not dma capable\n");
1522 } else if (object_is_on_stack(urb->setup_packet)) {
1523 WARN_ONCE(1, "setup packet is on stack\n");
1527 urb->setup_dma = dma_map_single(
1530 sizeof(struct usb_ctrlrequest),
1532 if (dma_mapping_error(hcd->self.sysdev,
1535 urb->transfer_flags |= URB_SETUP_MAP_SINGLE;
1536 } else if (hcd->driver->flags & HCD_LOCAL_MEM) {
1537 ret = hcd_alloc_coherent(
1538 urb->dev->bus, mem_flags,
1540 (void **)&urb->setup_packet,
1541 sizeof(struct usb_ctrlrequest),
1545 urb->transfer_flags |= URB_SETUP_MAP_LOCAL;
1549 dir = usb_urb_dir_in(urb) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
1550 if (urb->transfer_buffer_length != 0
1551 && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP)) {
1552 if (IS_ENABLED(CONFIG_HAS_DMA) && hcd->self.uses_dma) {
1556 /* We don't support sg for isoc transfers ! */
1557 if (usb_endpoint_xfer_isoc(&urb->ep->desc)) {
1570 urb->transfer_flags |= URB_DMA_MAP_SG;
1571 urb->num_mapped_sgs = n;
1572 if (n != urb->num_sgs)
1573 urb->transfer_flags |=
1574 URB_DMA_SG_COMBINED;
1575 } else if (urb->sg) {
1576 struct scatterlist *sg = urb->sg;
1577 urb->transfer_dma = dma_map_page(
1581 urb->transfer_buffer_length,
1583 if (dma_mapping_error(hcd->self.sysdev,
1587 urb->transfer_flags |= URB_DMA_MAP_PAGE;
1588 } else if (is_vmalloc_addr(urb->transfer_buffer)) {
1589 WARN_ONCE(1, "transfer buffer not dma capable\n");
1591 } else if (object_is_on_stack(urb->transfer_buffer)) {
1592 WARN_ONCE(1, "transfer buffer is on stack\n");
1595 urb->transfer_dma = dma_map_single(
1597 urb->transfer_buffer,
1598 urb->transfer_buffer_length,
1600 if (dma_mapping_error(hcd->self.sysdev,
1604 urb->transfer_flags |= URB_DMA_MAP_SINGLE;
1606 } else if (hcd->driver->flags & HCD_LOCAL_MEM) {
1607 ret = hcd_alloc_coherent(
1608 urb->dev->bus, mem_flags,
1610 &urb->transfer_buffer,
1611 urb->transfer_buffer_length,
1614 urb->transfer_flags |= URB_MAP_LOCAL;
1616 if (ret && (urb->transfer_flags & (URB_SETUP_MAP_SINGLE |
1617 URB_SETUP_MAP_LOCAL)))
1618 usb_hcd_unmap_urb_for_dma(hcd, urb);
1622 EXPORT_SYMBOL_GPL(usb_hcd_map_urb_for_dma);
1624 /*-------------------------------------------------------------------------*/
1626 /* may be called in any context with a valid urb->dev usecount
1627 * caller surrenders "ownership" of urb
1628 * expects usb_submit_urb() to have sanity checked and conditioned all
1631 int usb_hcd_submit_urb (struct urb *urb, gfp_t mem_flags)
1634 struct usb_hcd *hcd = bus_to_hcd(urb->dev->bus);
1636 /* increment urb's reference count as part of giving it to the HCD
1637 * (which will control it). HCD guarantees that it either returns
1638 * an error or calls giveback(), but not both.
1641 atomic_inc(&urb->use_count);
1642 atomic_inc(&urb->dev->urbnum);
1643 usbmon_urb_submit(&hcd->self, urb);
1645 /* NOTE requirements on root-hub callers (usbfs and the hub
1646 * driver, for now): URBs' urb->transfer_buffer must be
1647 * valid and usb_buffer_{sync,unmap}() not be needed, since
1648 * they could clobber root hub response data. Also, control
1649 * URBs must be submitted in process context with interrupts
1653 if (is_root_hub(urb->dev)) {
1654 status = rh_urb_enqueue(hcd, urb);
1656 status = map_urb_for_dma(hcd, urb, mem_flags);
1657 if (likely(status == 0)) {
1658 status = hcd->driver->urb_enqueue(hcd, urb, mem_flags);
1659 if (unlikely(status))
1660 unmap_urb_for_dma(hcd, urb);
1664 if (unlikely(status)) {
1665 usbmon_urb_submit_error(&hcd->self, urb, status);
1667 INIT_LIST_HEAD(&urb->urb_list);
1668 atomic_dec(&urb->use_count);
1669 atomic_dec(&urb->dev->urbnum);
1670 if (atomic_read(&urb->reject))
1671 wake_up(&usb_kill_urb_queue);
1677 /*-------------------------------------------------------------------------*/
1679 /* this makes the hcd giveback() the urb more quickly, by kicking it
1680 * off hardware queues (which may take a while) and returning it as
1681 * soon as practical. we've already set up the urb's return status,
1682 * but we can't know if the callback completed already.
1684 static int unlink1(struct usb_hcd *hcd, struct urb *urb, int status)
1688 if (is_root_hub(urb->dev))
1689 value = usb_rh_urb_dequeue(hcd, urb, status);
1692 /* The only reason an HCD might fail this call is if
1693 * it has not yet fully queued the urb to begin with.
1694 * Such failures should be harmless. */
1695 value = hcd->driver->urb_dequeue(hcd, urb, status);
1701 * called in any context
1703 * caller guarantees urb won't be recycled till both unlink()
1704 * and the urb's completion function return
1706 int usb_hcd_unlink_urb (struct urb *urb, int status)
1708 struct usb_hcd *hcd;
1709 struct usb_device *udev = urb->dev;
1710 int retval = -EIDRM;
1711 unsigned long flags;
1713 /* Prevent the device and bus from going away while
1714 * the unlink is carried out. If they are already gone
1715 * then urb->use_count must be 0, since disconnected
1716 * devices can't have any active URBs.
1718 spin_lock_irqsave(&hcd_urb_unlink_lock, flags);
1719 if (atomic_read(&urb->use_count) > 0) {
1723 spin_unlock_irqrestore(&hcd_urb_unlink_lock, flags);
1725 hcd = bus_to_hcd(urb->dev->bus);
1726 retval = unlink1(hcd, urb, status);
1728 retval = -EINPROGRESS;
1729 else if (retval != -EIDRM && retval != -EBUSY)
1730 dev_dbg(&udev->dev, "hcd_unlink_urb %pK fail %d\n",
1737 /*-------------------------------------------------------------------------*/
1739 static void __usb_hcd_giveback_urb(struct urb *urb)
1741 struct usb_hcd *hcd = bus_to_hcd(urb->dev->bus);
1742 struct usb_anchor *anchor = urb->anchor;
1743 int status = urb->unlinked;
1746 if (unlikely((urb->transfer_flags & URB_SHORT_NOT_OK) &&
1747 urb->actual_length < urb->transfer_buffer_length &&
1749 status = -EREMOTEIO;
1751 unmap_urb_for_dma(hcd, urb);
1752 usbmon_urb_complete(&hcd->self, urb, status);
1753 usb_anchor_suspend_wakeups(anchor);
1754 usb_unanchor_urb(urb);
1755 if (likely(status == 0))
1756 usb_led_activity(USB_LED_EVENT_HOST);
1758 /* pass ownership to the completion handler */
1759 urb->status = status;
1762 usb_anchor_resume_wakeups(anchor);
1763 atomic_dec(&urb->use_count);
1764 if (unlikely(atomic_read(&urb->reject)))
1765 wake_up(&usb_kill_urb_queue);
1769 static void usb_giveback_urb_bh(unsigned long param)
1771 struct giveback_urb_bh *bh = (struct giveback_urb_bh *)param;
1772 struct list_head local_list;
1774 spin_lock_irq(&bh->lock);
1777 list_replace_init(&bh->head, &local_list);
1778 spin_unlock_irq(&bh->lock);
1780 while (!list_empty(&local_list)) {
1783 urb = list_entry(local_list.next, struct urb, urb_list);
1784 list_del_init(&urb->urb_list);
1785 bh->completing_ep = urb->ep;
1786 __usb_hcd_giveback_urb(urb);
1787 bh->completing_ep = NULL;
1790 /* check if there are new URBs to giveback */
1791 spin_lock_irq(&bh->lock);
1792 if (!list_empty(&bh->head))
1794 bh->running = false;
1795 spin_unlock_irq(&bh->lock);
1799 * usb_hcd_giveback_urb - return URB from HCD to device driver
1800 * @hcd: host controller returning the URB
1801 * @urb: urb being returned to the USB device driver.
1802 * @status: completion status code for the URB.
1803 * Context: in_interrupt()
1805 * This hands the URB from HCD to its USB device driver, using its
1806 * completion function. The HCD has freed all per-urb resources
1807 * (and is done using urb->hcpriv). It also released all HCD locks;
1808 * the device driver won't cause problems if it frees, modifies,
1809 * or resubmits this URB.
1811 * If @urb was unlinked, the value of @status will be overridden by
1812 * @urb->unlinked. Erroneous short transfers are detected in case
1813 * the HCD hasn't checked for them.
1815 void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb, int status)
1817 struct giveback_urb_bh *bh;
1818 bool running, high_prio_bh;
1820 /* pass status to tasklet via unlinked */
1821 if (likely(!urb->unlinked))
1822 urb->unlinked = status;
1824 if (!hcd_giveback_urb_in_bh(hcd) && !is_root_hub(urb->dev)) {
1825 __usb_hcd_giveback_urb(urb);
1829 if (usb_pipeisoc(urb->pipe) || usb_pipeint(urb->pipe)) {
1830 bh = &hcd->high_prio_bh;
1831 high_prio_bh = true;
1833 bh = &hcd->low_prio_bh;
1834 high_prio_bh = false;
1837 spin_lock(&bh->lock);
1838 list_add_tail(&urb->urb_list, &bh->head);
1839 running = bh->running;
1840 spin_unlock(&bh->lock);
1844 else if (high_prio_bh)
1845 tasklet_hi_schedule(&bh->bh);
1847 tasklet_schedule(&bh->bh);
1849 EXPORT_SYMBOL_GPL(usb_hcd_giveback_urb);
1851 /*-------------------------------------------------------------------------*/
1853 /* Cancel all URBs pending on this endpoint and wait for the endpoint's
1854 * queue to drain completely. The caller must first insure that no more
1855 * URBs can be submitted for this endpoint.
1857 void usb_hcd_flush_endpoint(struct usb_device *udev,
1858 struct usb_host_endpoint *ep)
1860 struct usb_hcd *hcd;
1866 hcd = bus_to_hcd(udev->bus);
1868 /* No more submits can occur */
1869 spin_lock_irq(&hcd_urb_list_lock);
1871 list_for_each_entry_reverse(urb, &ep->urb_list, urb_list) {
1877 is_in = usb_urb_dir_in(urb);
1878 spin_unlock(&hcd_urb_list_lock);
1881 unlink1(hcd, urb, -ESHUTDOWN);
1882 dev_dbg (hcd->self.controller,
1883 "shutdown urb %pK ep%d%s-%s\n",
1884 urb, usb_endpoint_num(&ep->desc),
1885 is_in ? "in" : "out",
1886 usb_ep_type_string(usb_endpoint_type(&ep->desc)));
1889 /* list contents may have changed */
1890 spin_lock(&hcd_urb_list_lock);
1893 spin_unlock_irq(&hcd_urb_list_lock);
1895 /* Wait until the endpoint queue is completely empty */
1896 while (!list_empty (&ep->urb_list)) {
1897 spin_lock_irq(&hcd_urb_list_lock);
1899 /* The list may have changed while we acquired the spinlock */
1901 if (!list_empty (&ep->urb_list)) {
1902 urb = list_entry (ep->urb_list.prev, struct urb,
1906 spin_unlock_irq(&hcd_urb_list_lock);
1916 * usb_hcd_alloc_bandwidth - check whether a new bandwidth setting exceeds
1918 * @udev: target &usb_device
1919 * @new_config: new configuration to install
1920 * @cur_alt: the current alternate interface setting
1921 * @new_alt: alternate interface setting that is being installed
1923 * To change configurations, pass in the new configuration in new_config,
1924 * and pass NULL for cur_alt and new_alt.
1926 * To reset a device's configuration (put the device in the ADDRESSED state),
1927 * pass in NULL for new_config, cur_alt, and new_alt.
1929 * To change alternate interface settings, pass in NULL for new_config,
1930 * pass in the current alternate interface setting in cur_alt,
1931 * and pass in the new alternate interface setting in new_alt.
1933 * Return: An error if the requested bandwidth change exceeds the
1934 * bus bandwidth or host controller internal resources.
1936 int usb_hcd_alloc_bandwidth(struct usb_device *udev,
1937 struct usb_host_config *new_config,
1938 struct usb_host_interface *cur_alt,
1939 struct usb_host_interface *new_alt)
1941 int num_intfs, i, j;
1942 struct usb_host_interface *alt = NULL;
1944 struct usb_hcd *hcd;
1945 struct usb_host_endpoint *ep;
1947 hcd = bus_to_hcd(udev->bus);
1948 if (!hcd->driver->check_bandwidth)
1951 /* Configuration is being removed - set configuration 0 */
1952 if (!new_config && !cur_alt) {
1953 for (i = 1; i < 16; ++i) {
1954 ep = udev->ep_out[i];
1956 hcd->driver->drop_endpoint(hcd, udev, ep);
1957 ep = udev->ep_in[i];
1959 hcd->driver->drop_endpoint(hcd, udev, ep);
1961 hcd->driver->check_bandwidth(hcd, udev);
1964 /* Check if the HCD says there's enough bandwidth. Enable all endpoints
1965 * each interface's alt setting 0 and ask the HCD to check the bandwidth
1966 * of the bus. There will always be bandwidth for endpoint 0, so it's
1970 num_intfs = new_config->desc.bNumInterfaces;
1971 /* Remove endpoints (except endpoint 0, which is always on the
1972 * schedule) from the old config from the schedule
1974 for (i = 1; i < 16; ++i) {
1975 ep = udev->ep_out[i];
1977 ret = hcd->driver->drop_endpoint(hcd, udev, ep);
1981 ep = udev->ep_in[i];
1983 ret = hcd->driver->drop_endpoint(hcd, udev, ep);
1988 for (i = 0; i < num_intfs; ++i) {
1989 struct usb_host_interface *first_alt;
1992 first_alt = &new_config->intf_cache[i]->altsetting[0];
1993 iface_num = first_alt->desc.bInterfaceNumber;
1994 /* Set up endpoints for alternate interface setting 0 */
1995 alt = usb_find_alt_setting(new_config, iface_num, 0);
1997 /* No alt setting 0? Pick the first setting. */
2000 for (j = 0; j < alt->desc.bNumEndpoints; j++) {
2001 ret = hcd->driver->add_endpoint(hcd, udev, &alt->endpoint[j]);
2007 if (cur_alt && new_alt) {
2008 struct usb_interface *iface = usb_ifnum_to_if(udev,
2009 cur_alt->desc.bInterfaceNumber);
2013 if (iface->resetting_device) {
2015 * The USB core just reset the device, so the xHCI host
2016 * and the device will think alt setting 0 is installed.
2017 * However, the USB core will pass in the alternate
2018 * setting installed before the reset as cur_alt. Dig
2019 * out the alternate setting 0 structure, or the first
2020 * alternate setting if a broken device doesn't have alt
2023 cur_alt = usb_altnum_to_altsetting(iface, 0);
2025 cur_alt = &iface->altsetting[0];
2028 /* Drop all the endpoints in the current alt setting */
2029 for (i = 0; i < cur_alt->desc.bNumEndpoints; i++) {
2030 ret = hcd->driver->drop_endpoint(hcd, udev,
2031 &cur_alt->endpoint[i]);
2035 /* Add all the endpoints in the new alt setting */
2036 for (i = 0; i < new_alt->desc.bNumEndpoints; i++) {
2037 ret = hcd->driver->add_endpoint(hcd, udev,
2038 &new_alt->endpoint[i]);
2043 ret = hcd->driver->check_bandwidth(hcd, udev);
2046 hcd->driver->reset_bandwidth(hcd, udev);
2050 /* Disables the endpoint: synchronizes with the hcd to make sure all
2051 * endpoint state is gone from hardware. usb_hcd_flush_endpoint() must
2052 * have been called previously. Use for set_configuration, set_interface,
2053 * driver removal, physical disconnect.
2055 * example: a qh stored in ep->hcpriv, holding state related to endpoint
2056 * type, maxpacket size, toggle, halt status, and scheduling.
2058 void usb_hcd_disable_endpoint(struct usb_device *udev,
2059 struct usb_host_endpoint *ep)
2061 struct usb_hcd *hcd;
2064 hcd = bus_to_hcd(udev->bus);
2065 if (hcd->driver->endpoint_disable)
2066 hcd->driver->endpoint_disable(hcd, ep);
2070 * usb_hcd_reset_endpoint - reset host endpoint state
2071 * @udev: USB device.
2072 * @ep: the endpoint to reset.
2074 * Resets any host endpoint state such as the toggle bit, sequence
2075 * number and current window.
2077 void usb_hcd_reset_endpoint(struct usb_device *udev,
2078 struct usb_host_endpoint *ep)
2080 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2082 if (hcd->driver->endpoint_reset)
2083 hcd->driver->endpoint_reset(hcd, ep);
2085 int epnum = usb_endpoint_num(&ep->desc);
2086 int is_out = usb_endpoint_dir_out(&ep->desc);
2087 int is_control = usb_endpoint_xfer_control(&ep->desc);
2089 usb_settoggle(udev, epnum, is_out, 0);
2091 usb_settoggle(udev, epnum, !is_out, 0);
2096 * usb_alloc_streams - allocate bulk endpoint stream IDs.
2097 * @interface: alternate setting that includes all endpoints.
2098 * @eps: array of endpoints that need streams.
2099 * @num_eps: number of endpoints in the array.
2100 * @num_streams: number of streams to allocate.
2101 * @mem_flags: flags hcd should use to allocate memory.
2103 * Sets up a group of bulk endpoints to have @num_streams stream IDs available.
2104 * Drivers may queue multiple transfers to different stream IDs, which may
2105 * complete in a different order than they were queued.
2107 * Return: On success, the number of allocated streams. On failure, a negative
2110 int usb_alloc_streams(struct usb_interface *interface,
2111 struct usb_host_endpoint **eps, unsigned int num_eps,
2112 unsigned int num_streams, gfp_t mem_flags)
2114 struct usb_hcd *hcd;
2115 struct usb_device *dev;
2118 dev = interface_to_usbdev(interface);
2119 hcd = bus_to_hcd(dev->bus);
2120 if (!hcd->driver->alloc_streams || !hcd->driver->free_streams)
2122 if (dev->speed < USB_SPEED_SUPER)
2124 if (dev->state < USB_STATE_CONFIGURED)
2127 for (i = 0; i < num_eps; i++) {
2128 /* Streams only apply to bulk endpoints. */
2129 if (!usb_endpoint_xfer_bulk(&eps[i]->desc))
2131 /* Re-alloc is not allowed */
2132 if (eps[i]->streams)
2136 ret = hcd->driver->alloc_streams(hcd, dev, eps, num_eps,
2137 num_streams, mem_flags);
2141 for (i = 0; i < num_eps; i++)
2142 eps[i]->streams = ret;
2146 EXPORT_SYMBOL_GPL(usb_alloc_streams);
2149 * usb_free_streams - free bulk endpoint stream IDs.
2150 * @interface: alternate setting that includes all endpoints.
2151 * @eps: array of endpoints to remove streams from.
2152 * @num_eps: number of endpoints in the array.
2153 * @mem_flags: flags hcd should use to allocate memory.
2155 * Reverts a group of bulk endpoints back to not using stream IDs.
2156 * Can fail if we are given bad arguments, or HCD is broken.
2158 * Return: 0 on success. On failure, a negative error code.
2160 int usb_free_streams(struct usb_interface *interface,
2161 struct usb_host_endpoint **eps, unsigned int num_eps,
2164 struct usb_hcd *hcd;
2165 struct usb_device *dev;
2168 dev = interface_to_usbdev(interface);
2169 hcd = bus_to_hcd(dev->bus);
2170 if (dev->speed < USB_SPEED_SUPER)
2173 /* Double-free is not allowed */
2174 for (i = 0; i < num_eps; i++)
2175 if (!eps[i] || !eps[i]->streams)
2178 ret = hcd->driver->free_streams(hcd, dev, eps, num_eps, mem_flags);
2182 for (i = 0; i < num_eps; i++)
2183 eps[i]->streams = 0;
2187 EXPORT_SYMBOL_GPL(usb_free_streams);
2189 /* Protect against drivers that try to unlink URBs after the device
2190 * is gone, by waiting until all unlinks for @udev are finished.
2191 * Since we don't currently track URBs by device, simply wait until
2192 * nothing is running in the locked region of usb_hcd_unlink_urb().
2194 void usb_hcd_synchronize_unlinks(struct usb_device *udev)
2196 spin_lock_irq(&hcd_urb_unlink_lock);
2197 spin_unlock_irq(&hcd_urb_unlink_lock);
2200 /*-------------------------------------------------------------------------*/
2202 /* called in any context */
2203 int usb_hcd_get_frame_number (struct usb_device *udev)
2205 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2207 if (!HCD_RH_RUNNING(hcd))
2209 return hcd->driver->get_frame_number (hcd);
2212 /*-------------------------------------------------------------------------*/
2216 int hcd_bus_suspend(struct usb_device *rhdev, pm_message_t msg)
2218 struct usb_hcd *hcd = bus_to_hcd(rhdev->bus);
2220 int old_state = hcd->state;
2222 dev_dbg(&rhdev->dev, "bus %ssuspend, wakeup %d\n",
2223 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
2224 rhdev->do_remote_wakeup);
2225 if (HCD_DEAD(hcd)) {
2226 dev_dbg(&rhdev->dev, "skipped %s of dead bus\n", "suspend");
2230 if (!hcd->driver->bus_suspend) {
2233 clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2234 hcd->state = HC_STATE_QUIESCING;
2235 status = hcd->driver->bus_suspend(hcd);
2238 usb_set_device_state(rhdev, USB_STATE_SUSPENDED);
2239 hcd->state = HC_STATE_SUSPENDED;
2241 if (!PMSG_IS_AUTO(msg))
2242 usb_phy_roothub_suspend(hcd->self.sysdev,
2245 /* Did we race with a root-hub wakeup event? */
2246 if (rhdev->do_remote_wakeup) {
2249 status = hcd->driver->hub_status_data(hcd, buffer);
2251 dev_dbg(&rhdev->dev, "suspend raced with wakeup event\n");
2252 hcd_bus_resume(rhdev, PMSG_AUTO_RESUME);
2257 spin_lock_irq(&hcd_root_hub_lock);
2258 if (!HCD_DEAD(hcd)) {
2259 set_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2260 hcd->state = old_state;
2262 spin_unlock_irq(&hcd_root_hub_lock);
2263 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
2269 int hcd_bus_resume(struct usb_device *rhdev, pm_message_t msg)
2271 struct usb_hcd *hcd = bus_to_hcd(rhdev->bus);
2273 int old_state = hcd->state;
2275 dev_dbg(&rhdev->dev, "usb %sresume\n",
2276 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
2277 if (HCD_DEAD(hcd)) {
2278 dev_dbg(&rhdev->dev, "skipped %s of dead bus\n", "resume");
2282 if (!PMSG_IS_AUTO(msg)) {
2283 status = usb_phy_roothub_resume(hcd->self.sysdev,
2289 if (!hcd->driver->bus_resume)
2291 if (HCD_RH_RUNNING(hcd))
2294 hcd->state = HC_STATE_RESUMING;
2295 status = hcd->driver->bus_resume(hcd);
2296 clear_bit(HCD_FLAG_WAKEUP_PENDING, &hcd->flags);
2298 struct usb_device *udev;
2301 spin_lock_irq(&hcd_root_hub_lock);
2302 if (!HCD_DEAD(hcd)) {
2303 usb_set_device_state(rhdev, rhdev->actconfig
2304 ? USB_STATE_CONFIGURED
2305 : USB_STATE_ADDRESS);
2306 set_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2307 hcd->state = HC_STATE_RUNNING;
2309 spin_unlock_irq(&hcd_root_hub_lock);
2312 * Check whether any of the enabled ports on the root hub are
2313 * unsuspended. If they are then a TRSMRCY delay is needed
2314 * (this is what the USB-2 spec calls a "global resume").
2315 * Otherwise we can skip the delay.
2317 usb_hub_for_each_child(rhdev, port1, udev) {
2318 if (udev->state != USB_STATE_NOTATTACHED &&
2319 !udev->port_is_suspended) {
2320 usleep_range(10000, 11000); /* TRSMRCY */
2325 hcd->state = old_state;
2326 usb_phy_roothub_suspend(hcd->self.sysdev, hcd->phy_roothub);
2327 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
2329 if (status != -ESHUTDOWN)
2335 /* Workqueue routine for root-hub remote wakeup */
2336 static void hcd_resume_work(struct work_struct *work)
2338 struct usb_hcd *hcd = container_of(work, struct usb_hcd, wakeup_work);
2339 struct usb_device *udev = hcd->self.root_hub;
2341 usb_remote_wakeup(udev);
2345 * usb_hcd_resume_root_hub - called by HCD to resume its root hub
2346 * @hcd: host controller for this root hub
2348 * The USB host controller calls this function when its root hub is
2349 * suspended (with the remote wakeup feature enabled) and a remote
2350 * wakeup request is received. The routine submits a workqueue request
2351 * to resume the root hub (that is, manage its downstream ports again).
2353 void usb_hcd_resume_root_hub (struct usb_hcd *hcd)
2355 unsigned long flags;
2357 spin_lock_irqsave (&hcd_root_hub_lock, flags);
2358 if (hcd->rh_registered) {
2359 pm_wakeup_event(&hcd->self.root_hub->dev, 0);
2360 set_bit(HCD_FLAG_WAKEUP_PENDING, &hcd->flags);
2361 queue_work(pm_wq, &hcd->wakeup_work);
2363 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
2365 EXPORT_SYMBOL_GPL(usb_hcd_resume_root_hub);
2367 #endif /* CONFIG_PM */
2369 /*-------------------------------------------------------------------------*/
2371 #ifdef CONFIG_USB_OTG
2374 * usb_bus_start_enum - start immediate enumeration (for OTG)
2375 * @bus: the bus (must use hcd framework)
2376 * @port_num: 1-based number of port; usually bus->otg_port
2377 * Context: in_interrupt()
2379 * Starts enumeration, with an immediate reset followed later by
2380 * hub_wq identifying and possibly configuring the device.
2381 * This is needed by OTG controller drivers, where it helps meet
2382 * HNP protocol timing requirements for starting a port reset.
2384 * Return: 0 if successful.
2386 int usb_bus_start_enum(struct usb_bus *bus, unsigned port_num)
2388 struct usb_hcd *hcd;
2389 int status = -EOPNOTSUPP;
2391 /* NOTE: since HNP can't start by grabbing the bus's address0_sem,
2392 * boards with root hubs hooked up to internal devices (instead of
2393 * just the OTG port) may need more attention to resetting...
2395 hcd = bus_to_hcd(bus);
2396 if (port_num && hcd->driver->start_port_reset)
2397 status = hcd->driver->start_port_reset(hcd, port_num);
2399 /* allocate hub_wq shortly after (first) root port reset finishes;
2400 * it may issue others, until at least 50 msecs have passed.
2403 mod_timer(&hcd->rh_timer, jiffies + msecs_to_jiffies(10));
2406 EXPORT_SYMBOL_GPL(usb_bus_start_enum);
2410 /*-------------------------------------------------------------------------*/
2413 * usb_hcd_irq - hook IRQs to HCD framework (bus glue)
2414 * @irq: the IRQ being raised
2415 * @__hcd: pointer to the HCD whose IRQ is being signaled
2417 * If the controller isn't HALTed, calls the driver's irq handler.
2418 * Checks whether the controller is now dead.
2420 * Return: %IRQ_HANDLED if the IRQ was handled. %IRQ_NONE otherwise.
2422 irqreturn_t usb_hcd_irq (int irq, void *__hcd)
2424 struct usb_hcd *hcd = __hcd;
2427 if (unlikely(HCD_DEAD(hcd) || !HCD_HW_ACCESSIBLE(hcd)))
2429 else if (hcd->driver->irq(hcd) == IRQ_NONE)
2436 EXPORT_SYMBOL_GPL(usb_hcd_irq);
2438 /*-------------------------------------------------------------------------*/
2440 /* Workqueue routine for when the root-hub has died. */
2441 static void hcd_died_work(struct work_struct *work)
2443 struct usb_hcd *hcd = container_of(work, struct usb_hcd, died_work);
2444 static char *env[] = {
2449 /* Notify user space that the host controller has died */
2450 kobject_uevent_env(&hcd->self.root_hub->dev.kobj, KOBJ_OFFLINE, env);
2454 * usb_hc_died - report abnormal shutdown of a host controller (bus glue)
2455 * @hcd: pointer to the HCD representing the controller
2457 * This is called by bus glue to report a USB host controller that died
2458 * while operations may still have been pending. It's called automatically
2459 * by the PCI glue, so only glue for non-PCI busses should need to call it.
2461 * Only call this function with the primary HCD.
2463 void usb_hc_died (struct usb_hcd *hcd)
2465 unsigned long flags;
2467 dev_err (hcd->self.controller, "HC died; cleaning up\n");
2469 spin_lock_irqsave (&hcd_root_hub_lock, flags);
2470 clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2471 set_bit(HCD_FLAG_DEAD, &hcd->flags);
2472 if (hcd->rh_registered) {
2473 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2475 /* make hub_wq clean up old urbs and devices */
2476 usb_set_device_state (hcd->self.root_hub,
2477 USB_STATE_NOTATTACHED);
2478 usb_kick_hub_wq(hcd->self.root_hub);
2480 if (usb_hcd_is_primary_hcd(hcd) && hcd->shared_hcd) {
2481 hcd = hcd->shared_hcd;
2482 clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2483 set_bit(HCD_FLAG_DEAD, &hcd->flags);
2484 if (hcd->rh_registered) {
2485 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2487 /* make hub_wq clean up old urbs and devices */
2488 usb_set_device_state(hcd->self.root_hub,
2489 USB_STATE_NOTATTACHED);
2490 usb_kick_hub_wq(hcd->self.root_hub);
2494 /* Handle the case where this function gets called with a shared HCD */
2495 if (usb_hcd_is_primary_hcd(hcd))
2496 schedule_work(&hcd->died_work);
2498 schedule_work(&hcd->primary_hcd->died_work);
2500 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
2501 /* Make sure that the other roothub is also deallocated. */
2503 EXPORT_SYMBOL_GPL (usb_hc_died);
2505 /*-------------------------------------------------------------------------*/
2507 static void init_giveback_urb_bh(struct giveback_urb_bh *bh)
2510 spin_lock_init(&bh->lock);
2511 INIT_LIST_HEAD(&bh->head);
2512 tasklet_init(&bh->bh, usb_giveback_urb_bh, (unsigned long)bh);
2515 struct usb_hcd *__usb_create_hcd(const struct hc_driver *driver,
2516 struct device *sysdev, struct device *dev, const char *bus_name,
2517 struct usb_hcd *primary_hcd)
2519 struct usb_hcd *hcd;
2521 hcd = kzalloc(sizeof(*hcd) + driver->hcd_priv_size, GFP_KERNEL);
2524 if (primary_hcd == NULL) {
2525 hcd->address0_mutex = kmalloc(sizeof(*hcd->address0_mutex),
2527 if (!hcd->address0_mutex) {
2529 dev_dbg(dev, "hcd address0 mutex alloc failed\n");
2532 mutex_init(hcd->address0_mutex);
2533 hcd->bandwidth_mutex = kmalloc(sizeof(*hcd->bandwidth_mutex),
2535 if (!hcd->bandwidth_mutex) {
2536 kfree(hcd->address0_mutex);
2538 dev_dbg(dev, "hcd bandwidth mutex alloc failed\n");
2541 mutex_init(hcd->bandwidth_mutex);
2542 dev_set_drvdata(dev, hcd);
2544 mutex_lock(&usb_port_peer_mutex);
2545 hcd->address0_mutex = primary_hcd->address0_mutex;
2546 hcd->bandwidth_mutex = primary_hcd->bandwidth_mutex;
2547 hcd->primary_hcd = primary_hcd;
2548 primary_hcd->primary_hcd = primary_hcd;
2549 hcd->shared_hcd = primary_hcd;
2550 primary_hcd->shared_hcd = hcd;
2551 mutex_unlock(&usb_port_peer_mutex);
2554 kref_init(&hcd->kref);
2556 usb_bus_init(&hcd->self);
2557 hcd->self.controller = dev;
2558 hcd->self.sysdev = sysdev;
2559 hcd->self.bus_name = bus_name;
2560 hcd->self.uses_dma = (sysdev->dma_mask != NULL);
2562 timer_setup(&hcd->rh_timer, rh_timer_func, 0);
2564 INIT_WORK(&hcd->wakeup_work, hcd_resume_work);
2567 INIT_WORK(&hcd->died_work, hcd_died_work);
2569 hcd->driver = driver;
2570 hcd->speed = driver->flags & HCD_MASK;
2571 hcd->product_desc = (driver->product_desc) ? driver->product_desc :
2572 "USB Host Controller";
2575 EXPORT_SYMBOL_GPL(__usb_create_hcd);
2578 * usb_create_shared_hcd - create and initialize an HCD structure
2579 * @driver: HC driver that will use this hcd
2580 * @dev: device for this HC, stored in hcd->self.controller
2581 * @bus_name: value to store in hcd->self.bus_name
2582 * @primary_hcd: a pointer to the usb_hcd structure that is sharing the
2583 * PCI device. Only allocate certain resources for the primary HCD
2584 * Context: !in_interrupt()
2586 * Allocate a struct usb_hcd, with extra space at the end for the
2587 * HC driver's private data. Initialize the generic members of the
2590 * Return: On success, a pointer to the created and initialized HCD structure.
2591 * On failure (e.g. if memory is unavailable), %NULL.
2593 struct usb_hcd *usb_create_shared_hcd(const struct hc_driver *driver,
2594 struct device *dev, const char *bus_name,
2595 struct usb_hcd *primary_hcd)
2597 return __usb_create_hcd(driver, dev, dev, bus_name, primary_hcd);
2599 EXPORT_SYMBOL_GPL(usb_create_shared_hcd);
2602 * usb_create_hcd - create and initialize an HCD structure
2603 * @driver: HC driver that will use this hcd
2604 * @dev: device for this HC, stored in hcd->self.controller
2605 * @bus_name: value to store in hcd->self.bus_name
2606 * Context: !in_interrupt()
2608 * Allocate a struct usb_hcd, with extra space at the end for the
2609 * HC driver's private data. Initialize the generic members of the
2612 * Return: On success, a pointer to the created and initialized HCD
2613 * structure. On failure (e.g. if memory is unavailable), %NULL.
2615 struct usb_hcd *usb_create_hcd(const struct hc_driver *driver,
2616 struct device *dev, const char *bus_name)
2618 return __usb_create_hcd(driver, dev, dev, bus_name, NULL);
2620 EXPORT_SYMBOL_GPL(usb_create_hcd);
2623 * Roothubs that share one PCI device must also share the bandwidth mutex.
2624 * Don't deallocate the bandwidth_mutex until the last shared usb_hcd is
2627 * Make sure to deallocate the bandwidth_mutex only when the last HCD is
2628 * freed. When hcd_release() is called for either hcd in a peer set,
2629 * invalidate the peer's ->shared_hcd and ->primary_hcd pointers.
2631 static void hcd_release(struct kref *kref)
2633 struct usb_hcd *hcd = container_of (kref, struct usb_hcd, kref);
2635 mutex_lock(&usb_port_peer_mutex);
2636 if (hcd->shared_hcd) {
2637 struct usb_hcd *peer = hcd->shared_hcd;
2639 peer->shared_hcd = NULL;
2640 peer->primary_hcd = NULL;
2642 kfree(hcd->address0_mutex);
2643 kfree(hcd->bandwidth_mutex);
2645 mutex_unlock(&usb_port_peer_mutex);
2649 struct usb_hcd *usb_get_hcd (struct usb_hcd *hcd)
2652 kref_get (&hcd->kref);
2655 EXPORT_SYMBOL_GPL(usb_get_hcd);
2657 void usb_put_hcd (struct usb_hcd *hcd)
2660 kref_put (&hcd->kref, hcd_release);
2662 EXPORT_SYMBOL_GPL(usb_put_hcd);
2664 int usb_hcd_is_primary_hcd(struct usb_hcd *hcd)
2666 if (!hcd->primary_hcd)
2668 return hcd == hcd->primary_hcd;
2670 EXPORT_SYMBOL_GPL(usb_hcd_is_primary_hcd);
2672 int usb_hcd_find_raw_port_number(struct usb_hcd *hcd, int port1)
2674 if (!hcd->driver->find_raw_port_number)
2677 return hcd->driver->find_raw_port_number(hcd, port1);
2680 static int usb_hcd_request_irqs(struct usb_hcd *hcd,
2681 unsigned int irqnum, unsigned long irqflags)
2685 if (hcd->driver->irq) {
2687 snprintf(hcd->irq_descr, sizeof(hcd->irq_descr), "%s:usb%d",
2688 hcd->driver->description, hcd->self.busnum);
2689 retval = request_irq(irqnum, &usb_hcd_irq, irqflags,
2690 hcd->irq_descr, hcd);
2692 dev_err(hcd->self.controller,
2693 "request interrupt %d failed\n",
2698 dev_info(hcd->self.controller, "irq %d, %s 0x%08llx\n", irqnum,
2699 (hcd->driver->flags & HCD_MEMORY) ?
2700 "io mem" : "io base",
2701 (unsigned long long)hcd->rsrc_start);
2704 if (hcd->rsrc_start)
2705 dev_info(hcd->self.controller, "%s 0x%08llx\n",
2706 (hcd->driver->flags & HCD_MEMORY) ?
2707 "io mem" : "io base",
2708 (unsigned long long)hcd->rsrc_start);
2714 * Before we free this root hub, flush in-flight peering attempts
2715 * and disable peer lookups
2717 static void usb_put_invalidate_rhdev(struct usb_hcd *hcd)
2719 struct usb_device *rhdev;
2721 mutex_lock(&usb_port_peer_mutex);
2722 rhdev = hcd->self.root_hub;
2723 hcd->self.root_hub = NULL;
2724 mutex_unlock(&usb_port_peer_mutex);
2729 * usb_add_hcd - finish generic HCD structure initialization and register
2730 * @hcd: the usb_hcd structure to initialize
2731 * @irqnum: Interrupt line to allocate
2732 * @irqflags: Interrupt type flags
2734 * Finish the remaining parts of generic HCD initialization: allocate the
2735 * buffers of consistent memory, register the bus, request the IRQ line,
2736 * and call the driver's reset() and start() routines.
2738 int usb_add_hcd(struct usb_hcd *hcd,
2739 unsigned int irqnum, unsigned long irqflags)
2742 struct usb_device *rhdev;
2744 if (!hcd->skip_phy_initialization && usb_hcd_is_primary_hcd(hcd)) {
2745 hcd->phy_roothub = usb_phy_roothub_alloc(hcd->self.sysdev);
2746 if (IS_ERR(hcd->phy_roothub))
2747 return PTR_ERR(hcd->phy_roothub);
2749 retval = usb_phy_roothub_init(hcd->phy_roothub);
2753 retval = usb_phy_roothub_set_mode(hcd->phy_roothub,
2754 PHY_MODE_USB_HOST_SS);
2756 retval = usb_phy_roothub_set_mode(hcd->phy_roothub,
2759 goto err_usb_phy_roothub_power_on;
2761 retval = usb_phy_roothub_power_on(hcd->phy_roothub);
2763 goto err_usb_phy_roothub_power_on;
2766 dev_info(hcd->self.controller, "%s\n", hcd->product_desc);
2768 switch (authorized_default) {
2769 case USB_AUTHORIZE_NONE:
2770 hcd->dev_policy = USB_DEVICE_AUTHORIZE_NONE;
2773 case USB_AUTHORIZE_ALL:
2774 hcd->dev_policy = USB_DEVICE_AUTHORIZE_ALL;
2777 case USB_AUTHORIZE_INTERNAL:
2778 hcd->dev_policy = USB_DEVICE_AUTHORIZE_INTERNAL;
2781 case USB_AUTHORIZE_WIRED:
2783 hcd->dev_policy = hcd->wireless ?
2784 USB_DEVICE_AUTHORIZE_NONE : USB_DEVICE_AUTHORIZE_ALL;
2788 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
2790 /* per default all interfaces are authorized */
2791 set_bit(HCD_FLAG_INTF_AUTHORIZED, &hcd->flags);
2793 /* HC is in reset state, but accessible. Now do the one-time init,
2794 * bottom up so that hcds can customize the root hubs before hub_wq
2795 * starts talking to them. (Note, bus id is assigned early too.)
2797 retval = hcd_buffer_create(hcd);
2799 dev_dbg(hcd->self.sysdev, "pool alloc failed\n");
2800 goto err_create_buf;
2803 retval = usb_register_bus(&hcd->self);
2805 goto err_register_bus;
2807 rhdev = usb_alloc_dev(NULL, &hcd->self, 0);
2808 if (rhdev == NULL) {
2809 dev_err(hcd->self.sysdev, "unable to allocate root hub\n");
2811 goto err_allocate_root_hub;
2813 mutex_lock(&usb_port_peer_mutex);
2814 hcd->self.root_hub = rhdev;
2815 mutex_unlock(&usb_port_peer_mutex);
2817 rhdev->rx_lanes = 1;
2818 rhdev->tx_lanes = 1;
2820 switch (hcd->speed) {
2822 rhdev->speed = USB_SPEED_FULL;
2825 rhdev->speed = USB_SPEED_HIGH;
2828 rhdev->speed = USB_SPEED_WIRELESS;
2831 rhdev->speed = USB_SPEED_SUPER;
2834 rhdev->rx_lanes = 2;
2835 rhdev->tx_lanes = 2;
2838 rhdev->speed = USB_SPEED_SUPER_PLUS;
2842 goto err_set_rh_speed;
2845 /* wakeup flag init defaults to "everything works" for root hubs,
2846 * but drivers can override it in reset() if needed, along with
2847 * recording the overall controller's system wakeup capability.
2849 device_set_wakeup_capable(&rhdev->dev, 1);
2851 /* HCD_FLAG_RH_RUNNING doesn't matter until the root hub is
2852 * registered. But since the controller can die at any time,
2853 * let's initialize the flag before touching the hardware.
2855 set_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2857 /* "reset" is misnamed; its role is now one-time init. the controller
2858 * should already have been reset (and boot firmware kicked off etc).
2860 if (hcd->driver->reset) {
2861 retval = hcd->driver->reset(hcd);
2863 dev_err(hcd->self.controller, "can't setup: %d\n",
2865 goto err_hcd_driver_setup;
2868 hcd->rh_pollable = 1;
2870 /* NOTE: root hub and controller capabilities may not be the same */
2871 if (device_can_wakeup(hcd->self.controller)
2872 && device_can_wakeup(&hcd->self.root_hub->dev))
2873 dev_dbg(hcd->self.controller, "supports USB remote wakeup\n");
2875 /* initialize tasklets */
2876 init_giveback_urb_bh(&hcd->high_prio_bh);
2877 init_giveback_urb_bh(&hcd->low_prio_bh);
2879 /* enable irqs just before we start the controller,
2880 * if the BIOS provides legacy PCI irqs.
2882 if (usb_hcd_is_primary_hcd(hcd) && irqnum) {
2883 retval = usb_hcd_request_irqs(hcd, irqnum, irqflags);
2885 goto err_request_irq;
2888 hcd->state = HC_STATE_RUNNING;
2889 retval = hcd->driver->start(hcd);
2891 dev_err(hcd->self.controller, "startup error %d\n", retval);
2892 goto err_hcd_driver_start;
2895 /* starting here, usbcore will pay attention to this root hub */
2896 retval = register_root_hub(hcd);
2898 goto err_register_root_hub;
2900 retval = sysfs_create_group(&rhdev->dev.kobj, &usb_bus_attr_group);
2902 printk(KERN_ERR "Cannot register USB bus sysfs attributes: %d\n",
2904 goto error_create_attr_group;
2906 if (hcd->uses_new_polling && HCD_POLL_RH(hcd))
2907 usb_hcd_poll_rh_status(hcd);
2911 error_create_attr_group:
2912 clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2913 if (HC_IS_RUNNING(hcd->state))
2914 hcd->state = HC_STATE_QUIESCING;
2915 spin_lock_irq(&hcd_root_hub_lock);
2916 hcd->rh_registered = 0;
2917 spin_unlock_irq(&hcd_root_hub_lock);
2920 cancel_work_sync(&hcd->wakeup_work);
2922 cancel_work_sync(&hcd->died_work);
2923 mutex_lock(&usb_bus_idr_lock);
2924 usb_disconnect(&rhdev); /* Sets rhdev to NULL */
2925 mutex_unlock(&usb_bus_idr_lock);
2926 err_register_root_hub:
2927 hcd->rh_pollable = 0;
2928 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2929 del_timer_sync(&hcd->rh_timer);
2930 hcd->driver->stop(hcd);
2931 hcd->state = HC_STATE_HALT;
2932 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2933 del_timer_sync(&hcd->rh_timer);
2934 err_hcd_driver_start:
2935 if (usb_hcd_is_primary_hcd(hcd) && hcd->irq > 0)
2936 free_irq(irqnum, hcd);
2938 err_hcd_driver_setup:
2940 usb_put_invalidate_rhdev(hcd);
2941 err_allocate_root_hub:
2942 usb_deregister_bus(&hcd->self);
2944 hcd_buffer_destroy(hcd);
2946 usb_phy_roothub_power_off(hcd->phy_roothub);
2947 err_usb_phy_roothub_power_on:
2948 usb_phy_roothub_exit(hcd->phy_roothub);
2952 EXPORT_SYMBOL_GPL(usb_add_hcd);
2955 * usb_remove_hcd - shutdown processing for generic HCDs
2956 * @hcd: the usb_hcd structure to remove
2957 * Context: !in_interrupt()
2959 * Disconnects the root hub, then reverses the effects of usb_add_hcd(),
2960 * invoking the HCD's stop() method.
2962 void usb_remove_hcd(struct usb_hcd *hcd)
2964 struct usb_device *rhdev = hcd->self.root_hub;
2966 dev_info(hcd->self.controller, "remove, state %x\n", hcd->state);
2969 sysfs_remove_group(&rhdev->dev.kobj, &usb_bus_attr_group);
2971 clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2972 if (HC_IS_RUNNING (hcd->state))
2973 hcd->state = HC_STATE_QUIESCING;
2975 dev_dbg(hcd->self.controller, "roothub graceful disconnect\n");
2976 spin_lock_irq (&hcd_root_hub_lock);
2977 hcd->rh_registered = 0;
2978 spin_unlock_irq (&hcd_root_hub_lock);
2981 cancel_work_sync(&hcd->wakeup_work);
2983 cancel_work_sync(&hcd->died_work);
2985 mutex_lock(&usb_bus_idr_lock);
2986 usb_disconnect(&rhdev); /* Sets rhdev to NULL */
2987 mutex_unlock(&usb_bus_idr_lock);
2990 * tasklet_kill() isn't needed here because:
2991 * - driver's disconnect() called from usb_disconnect() should
2992 * make sure its URBs are completed during the disconnect()
2995 * - it is too late to run complete() here since driver may have
2996 * been removed already now
2999 /* Prevent any more root-hub status calls from the timer.
3000 * The HCD might still restart the timer (if a port status change
3001 * interrupt occurs), but usb_hcd_poll_rh_status() won't invoke
3002 * the hub_status_data() callback.
3004 hcd->rh_pollable = 0;
3005 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
3006 del_timer_sync(&hcd->rh_timer);
3008 hcd->driver->stop(hcd);
3009 hcd->state = HC_STATE_HALT;
3011 /* In case the HCD restarted the timer, stop it again. */
3012 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
3013 del_timer_sync(&hcd->rh_timer);
3015 if (usb_hcd_is_primary_hcd(hcd)) {
3017 free_irq(hcd->irq, hcd);
3020 usb_deregister_bus(&hcd->self);
3021 hcd_buffer_destroy(hcd);
3023 usb_phy_roothub_power_off(hcd->phy_roothub);
3024 usb_phy_roothub_exit(hcd->phy_roothub);
3026 usb_put_invalidate_rhdev(hcd);
3029 EXPORT_SYMBOL_GPL(usb_remove_hcd);
3032 usb_hcd_platform_shutdown(struct platform_device *dev)
3034 struct usb_hcd *hcd = platform_get_drvdata(dev);
3036 /* No need for pm_runtime_put(), we're shutting down */
3037 pm_runtime_get_sync(&dev->dev);
3039 if (hcd->driver->shutdown)
3040 hcd->driver->shutdown(hcd);
3042 EXPORT_SYMBOL_GPL(usb_hcd_platform_shutdown);
3044 int usb_hcd_setup_local_mem(struct usb_hcd *hcd, phys_addr_t phys_addr,
3045 dma_addr_t dma, size_t size)
3050 hcd->localmem_pool = devm_gen_pool_create(hcd->self.sysdev, PAGE_SHIFT,
3051 dev_to_node(hcd->self.sysdev),
3052 dev_name(hcd->self.sysdev));
3053 if (IS_ERR(hcd->localmem_pool))
3054 return PTR_ERR(hcd->localmem_pool);
3056 local_mem = devm_memremap(hcd->self.sysdev, phys_addr,
3062 * Here we pass a dma_addr_t but the arg type is a phys_addr_t.
3063 * It's not backed by system memory and thus there's no kernel mapping
3066 err = gen_pool_add_virt(hcd->localmem_pool, (unsigned long)local_mem,
3067 dma, size, dev_to_node(hcd->self.sysdev));
3069 dev_err(hcd->self.sysdev, "gen_pool_add_virt failed with %d\n",
3076 EXPORT_SYMBOL_GPL(usb_hcd_setup_local_mem);
3078 /*-------------------------------------------------------------------------*/
3080 #if IS_ENABLED(CONFIG_USB_MON)
3082 const struct usb_mon_operations *mon_ops;
3085 * The registration is unlocked.
3086 * We do it this way because we do not want to lock in hot paths.
3088 * Notice that the code is minimally error-proof. Because usbmon needs
3089 * symbols from usbcore, usbcore gets referenced and cannot be unloaded first.
3092 int usb_mon_register(const struct usb_mon_operations *ops)
3102 EXPORT_SYMBOL_GPL (usb_mon_register);
3104 void usb_mon_deregister (void)
3107 if (mon_ops == NULL) {
3108 printk(KERN_ERR "USB: monitor was not registered\n");
3114 EXPORT_SYMBOL_GPL (usb_mon_deregister);
3116 #endif /* CONFIG_USB_MON || CONFIG_USB_MON_MODULE */