2 * (C) Copyright Linus Torvalds 1999
3 * (C) Copyright Johannes Erdfelt 1999-2001
4 * (C) Copyright Andreas Gal 1999
5 * (C) Copyright Gregory P. Smith 1999
6 * (C) Copyright Deti Fliegl 1999
7 * (C) Copyright Randy Dunlap 2000
8 * (C) Copyright David Brownell 2000-2002
10 * This program is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License as published by the
12 * Free Software Foundation; either version 2 of the License, or (at your
13 * option) any later version.
15 * This program is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
17 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software Foundation,
22 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 #include <linux/bcd.h>
26 #include <linux/module.h>
27 #include <linux/version.h>
28 #include <linux/kernel.h>
29 #include <linux/sched/task_stack.h>
30 #include <linux/slab.h>
31 #include <linux/completion.h>
32 #include <linux/utsname.h>
35 #include <linux/device.h>
36 #include <linux/dma-mapping.h>
37 #include <linux/mutex.h>
39 #include <asm/byteorder.h>
40 #include <asm/unaligned.h>
41 #include <linux/platform_device.h>
42 #include <linux/workqueue.h>
43 #include <linux/pm_runtime.h>
44 #include <linux/types.h>
46 #include <linux/phy/phy.h>
47 #include <linux/usb.h>
48 #include <linux/usb/hcd.h>
49 #include <linux/usb/phy.h>
50 #include <linux/usb/otg.h>
55 /*-------------------------------------------------------------------------*/
58 * USB Host Controller Driver framework
60 * Plugs into usbcore (usb_bus) and lets HCDs share code, minimizing
61 * HCD-specific behaviors/bugs.
63 * This does error checks, tracks devices and urbs, and delegates to a
64 * "hc_driver" only for code (and data) that really needs to know about
65 * hardware differences. That includes root hub registers, i/o queues,
66 * and so on ... but as little else as possible.
68 * Shared code includes most of the "root hub" code (these are emulated,
69 * though each HC's hardware works differently) and PCI glue, plus request
70 * tracking overhead. The HCD code should only block on spinlocks or on
71 * hardware handshaking; blocking on software events (such as other kernel
72 * threads releasing resources, or completing actions) is all generic.
74 * Happens the USB 2.0 spec says this would be invisible inside the "USBD",
75 * and includes mostly a "HCDI" (HCD Interface) along with some APIs used
76 * only by the hub driver ... and that neither should be seen or used by
77 * usb client device drivers.
79 * Contributors of ideas or unattributed patches include: David Brownell,
80 * Roman Weissgaerber, Rory Bolt, Greg Kroah-Hartman, ...
83 * 2002-02-21 Pull in most of the usb_bus support from usb.c; some
84 * associated cleanup. "usb_hcd" still != "usb_bus".
85 * 2001-12-12 Initial patch version for Linux 2.5.1 kernel.
88 /*-------------------------------------------------------------------------*/
90 /* Keep track of which host controller drivers are loaded */
91 unsigned long usb_hcds_loaded;
92 EXPORT_SYMBOL_GPL(usb_hcds_loaded);
94 /* host controllers we manage */
95 DEFINE_IDR (usb_bus_idr);
96 EXPORT_SYMBOL_GPL (usb_bus_idr);
98 /* used when allocating bus numbers */
101 /* used when updating list of hcds */
102 DEFINE_MUTEX(usb_bus_idr_lock); /* exported only for usbfs */
103 EXPORT_SYMBOL_GPL (usb_bus_idr_lock);
105 /* used for controlling access to virtual root hubs */
106 static DEFINE_SPINLOCK(hcd_root_hub_lock);
108 /* used when updating an endpoint's URB list */
109 static DEFINE_SPINLOCK(hcd_urb_list_lock);
111 /* used to protect against unlinking URBs after the device is gone */
112 static DEFINE_SPINLOCK(hcd_urb_unlink_lock);
114 /* wait queue for synchronous unlinks */
115 DECLARE_WAIT_QUEUE_HEAD(usb_kill_urb_queue);
117 static inline int is_root_hub(struct usb_device *udev)
119 return (udev->parent == NULL);
122 /*-------------------------------------------------------------------------*/
125 * Sharable chunks of root hub code.
128 /*-------------------------------------------------------------------------*/
129 #define KERNEL_REL bin2bcd(((LINUX_VERSION_CODE >> 16) & 0x0ff))
130 #define KERNEL_VER bin2bcd(((LINUX_VERSION_CODE >> 8) & 0x0ff))
132 /* usb 3.1 root hub device descriptor */
133 static const u8 usb31_rh_dev_descriptor[18] = {
134 0x12, /* __u8 bLength; */
135 USB_DT_DEVICE, /* __u8 bDescriptorType; Device */
136 0x10, 0x03, /* __le16 bcdUSB; v3.1 */
138 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
139 0x00, /* __u8 bDeviceSubClass; */
140 0x03, /* __u8 bDeviceProtocol; USB 3 hub */
141 0x09, /* __u8 bMaxPacketSize0; 2^9 = 512 Bytes */
143 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation 0x1d6b */
144 0x03, 0x00, /* __le16 idProduct; device 0x0003 */
145 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
147 0x03, /* __u8 iManufacturer; */
148 0x02, /* __u8 iProduct; */
149 0x01, /* __u8 iSerialNumber; */
150 0x01 /* __u8 bNumConfigurations; */
153 /* usb 3.0 root hub device descriptor */
154 static const u8 usb3_rh_dev_descriptor[18] = {
155 0x12, /* __u8 bLength; */
156 USB_DT_DEVICE, /* __u8 bDescriptorType; Device */
157 0x00, 0x03, /* __le16 bcdUSB; v3.0 */
159 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
160 0x00, /* __u8 bDeviceSubClass; */
161 0x03, /* __u8 bDeviceProtocol; USB 3.0 hub */
162 0x09, /* __u8 bMaxPacketSize0; 2^9 = 512 Bytes */
164 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation 0x1d6b */
165 0x03, 0x00, /* __le16 idProduct; device 0x0003 */
166 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
168 0x03, /* __u8 iManufacturer; */
169 0x02, /* __u8 iProduct; */
170 0x01, /* __u8 iSerialNumber; */
171 0x01 /* __u8 bNumConfigurations; */
174 /* usb 2.5 (wireless USB 1.0) root hub device descriptor */
175 static const u8 usb25_rh_dev_descriptor[18] = {
176 0x12, /* __u8 bLength; */
177 USB_DT_DEVICE, /* __u8 bDescriptorType; Device */
178 0x50, 0x02, /* __le16 bcdUSB; v2.5 */
180 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
181 0x00, /* __u8 bDeviceSubClass; */
182 0x00, /* __u8 bDeviceProtocol; [ usb 2.0 no TT ] */
183 0xFF, /* __u8 bMaxPacketSize0; always 0xFF (WUSB Spec 7.4.1). */
185 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation 0x1d6b */
186 0x02, 0x00, /* __le16 idProduct; device 0x0002 */
187 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
189 0x03, /* __u8 iManufacturer; */
190 0x02, /* __u8 iProduct; */
191 0x01, /* __u8 iSerialNumber; */
192 0x01 /* __u8 bNumConfigurations; */
195 /* usb 2.0 root hub device descriptor */
196 static const u8 usb2_rh_dev_descriptor[18] = {
197 0x12, /* __u8 bLength; */
198 USB_DT_DEVICE, /* __u8 bDescriptorType; Device */
199 0x00, 0x02, /* __le16 bcdUSB; v2.0 */
201 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
202 0x00, /* __u8 bDeviceSubClass; */
203 0x00, /* __u8 bDeviceProtocol; [ usb 2.0 no TT ] */
204 0x40, /* __u8 bMaxPacketSize0; 64 Bytes */
206 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation 0x1d6b */
207 0x02, 0x00, /* __le16 idProduct; device 0x0002 */
208 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
210 0x03, /* __u8 iManufacturer; */
211 0x02, /* __u8 iProduct; */
212 0x01, /* __u8 iSerialNumber; */
213 0x01 /* __u8 bNumConfigurations; */
216 /* no usb 2.0 root hub "device qualifier" descriptor: one speed only */
218 /* usb 1.1 root hub device descriptor */
219 static const u8 usb11_rh_dev_descriptor[18] = {
220 0x12, /* __u8 bLength; */
221 USB_DT_DEVICE, /* __u8 bDescriptorType; Device */
222 0x10, 0x01, /* __le16 bcdUSB; v1.1 */
224 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
225 0x00, /* __u8 bDeviceSubClass; */
226 0x00, /* __u8 bDeviceProtocol; [ low/full speeds only ] */
227 0x40, /* __u8 bMaxPacketSize0; 64 Bytes */
229 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation 0x1d6b */
230 0x01, 0x00, /* __le16 idProduct; device 0x0001 */
231 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
233 0x03, /* __u8 iManufacturer; */
234 0x02, /* __u8 iProduct; */
235 0x01, /* __u8 iSerialNumber; */
236 0x01 /* __u8 bNumConfigurations; */
240 /*-------------------------------------------------------------------------*/
242 /* Configuration descriptors for our root hubs */
244 static const u8 fs_rh_config_descriptor[] = {
246 /* one configuration */
247 0x09, /* __u8 bLength; */
248 USB_DT_CONFIG, /* __u8 bDescriptorType; Configuration */
249 0x19, 0x00, /* __le16 wTotalLength; */
250 0x01, /* __u8 bNumInterfaces; (1) */
251 0x01, /* __u8 bConfigurationValue; */
252 0x00, /* __u8 iConfiguration; */
253 0xc0, /* __u8 bmAttributes;
258 0x00, /* __u8 MaxPower; */
261 * USB 2.0, single TT organization (mandatory):
262 * one interface, protocol 0
264 * USB 2.0, multiple TT organization (optional):
265 * two interfaces, protocols 1 (like single TT)
266 * and 2 (multiple TT mode) ... config is
272 0x09, /* __u8 if_bLength; */
273 USB_DT_INTERFACE, /* __u8 if_bDescriptorType; Interface */
274 0x00, /* __u8 if_bInterfaceNumber; */
275 0x00, /* __u8 if_bAlternateSetting; */
276 0x01, /* __u8 if_bNumEndpoints; */
277 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
278 0x00, /* __u8 if_bInterfaceSubClass; */
279 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
280 0x00, /* __u8 if_iInterface; */
282 /* one endpoint (status change endpoint) */
283 0x07, /* __u8 ep_bLength; */
284 USB_DT_ENDPOINT, /* __u8 ep_bDescriptorType; Endpoint */
285 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
286 0x03, /* __u8 ep_bmAttributes; Interrupt */
287 0x02, 0x00, /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8) */
288 0xff /* __u8 ep_bInterval; (255ms -- usb 2.0 spec) */
291 static const u8 hs_rh_config_descriptor[] = {
293 /* one configuration */
294 0x09, /* __u8 bLength; */
295 USB_DT_CONFIG, /* __u8 bDescriptorType; Configuration */
296 0x19, 0x00, /* __le16 wTotalLength; */
297 0x01, /* __u8 bNumInterfaces; (1) */
298 0x01, /* __u8 bConfigurationValue; */
299 0x00, /* __u8 iConfiguration; */
300 0xc0, /* __u8 bmAttributes;
305 0x00, /* __u8 MaxPower; */
308 * USB 2.0, single TT organization (mandatory):
309 * one interface, protocol 0
311 * USB 2.0, multiple TT organization (optional):
312 * two interfaces, protocols 1 (like single TT)
313 * and 2 (multiple TT mode) ... config is
319 0x09, /* __u8 if_bLength; */
320 USB_DT_INTERFACE, /* __u8 if_bDescriptorType; Interface */
321 0x00, /* __u8 if_bInterfaceNumber; */
322 0x00, /* __u8 if_bAlternateSetting; */
323 0x01, /* __u8 if_bNumEndpoints; */
324 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
325 0x00, /* __u8 if_bInterfaceSubClass; */
326 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
327 0x00, /* __u8 if_iInterface; */
329 /* one endpoint (status change endpoint) */
330 0x07, /* __u8 ep_bLength; */
331 USB_DT_ENDPOINT, /* __u8 ep_bDescriptorType; Endpoint */
332 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
333 0x03, /* __u8 ep_bmAttributes; Interrupt */
334 /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8)
335 * see hub.c:hub_configure() for details. */
336 (USB_MAXCHILDREN + 1 + 7) / 8, 0x00,
337 0x0c /* __u8 ep_bInterval; (256ms -- usb 2.0 spec) */
340 static const u8 ss_rh_config_descriptor[] = {
341 /* one configuration */
342 0x09, /* __u8 bLength; */
343 USB_DT_CONFIG, /* __u8 bDescriptorType; Configuration */
344 0x1f, 0x00, /* __le16 wTotalLength; */
345 0x01, /* __u8 bNumInterfaces; (1) */
346 0x01, /* __u8 bConfigurationValue; */
347 0x00, /* __u8 iConfiguration; */
348 0xc0, /* __u8 bmAttributes;
353 0x00, /* __u8 MaxPower; */
356 0x09, /* __u8 if_bLength; */
357 USB_DT_INTERFACE, /* __u8 if_bDescriptorType; Interface */
358 0x00, /* __u8 if_bInterfaceNumber; */
359 0x00, /* __u8 if_bAlternateSetting; */
360 0x01, /* __u8 if_bNumEndpoints; */
361 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
362 0x00, /* __u8 if_bInterfaceSubClass; */
363 0x00, /* __u8 if_bInterfaceProtocol; */
364 0x00, /* __u8 if_iInterface; */
366 /* one endpoint (status change endpoint) */
367 0x07, /* __u8 ep_bLength; */
368 USB_DT_ENDPOINT, /* __u8 ep_bDescriptorType; Endpoint */
369 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
370 0x03, /* __u8 ep_bmAttributes; Interrupt */
371 /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8)
372 * see hub.c:hub_configure() for details. */
373 (USB_MAXCHILDREN + 1 + 7) / 8, 0x00,
374 0x0c, /* __u8 ep_bInterval; (256ms -- usb 2.0 spec) */
376 /* one SuperSpeed endpoint companion descriptor */
377 0x06, /* __u8 ss_bLength */
378 USB_DT_SS_ENDPOINT_COMP, /* __u8 ss_bDescriptorType; SuperSpeed EP */
380 0x00, /* __u8 ss_bMaxBurst; allows 1 TX between ACKs */
381 0x00, /* __u8 ss_bmAttributes; 1 packet per service interval */
382 0x02, 0x00 /* __le16 ss_wBytesPerInterval; 15 bits for max 15 ports */
385 /* authorized_default behaviour:
386 * -1 is authorized for all devices except wireless (old behaviour)
387 * 0 is unauthorized for all devices
388 * 1 is authorized for all devices
390 static int authorized_default = -1;
391 module_param(authorized_default, int, S_IRUGO|S_IWUSR);
392 MODULE_PARM_DESC(authorized_default,
393 "Default USB device authorization: 0 is not authorized, 1 is "
394 "authorized, -1 is authorized except for wireless USB (default, "
396 /*-------------------------------------------------------------------------*/
399 * ascii2desc() - Helper routine for producing UTF-16LE string descriptors
400 * @s: Null-terminated ASCII (actually ISO-8859-1) string
401 * @buf: Buffer for USB string descriptor (header + UTF-16LE)
402 * @len: Length (in bytes; may be odd) of descriptor buffer.
404 * Return: The number of bytes filled in: 2 + 2*strlen(s) or @len,
408 * USB String descriptors can contain at most 126 characters; input
409 * strings longer than that are truncated.
412 ascii2desc(char const *s, u8 *buf, unsigned len)
414 unsigned n, t = 2 + 2*strlen(s);
417 t = 254; /* Longest possible UTF string descriptor */
421 t += USB_DT_STRING << 8; /* Now t is first 16 bits to store */
429 t = (unsigned char)*s++;
435 * rh_string() - provides string descriptors for root hub
436 * @id: the string ID number (0: langids, 1: serial #, 2: product, 3: vendor)
437 * @hcd: the host controller for this root hub
438 * @data: buffer for output packet
439 * @len: length of the provided buffer
441 * Produces either a manufacturer, product or serial number string for the
442 * virtual root hub device.
444 * Return: The number of bytes filled in: the length of the descriptor or
445 * of the provided buffer, whichever is less.
448 rh_string(int id, struct usb_hcd const *hcd, u8 *data, unsigned len)
452 static char const langids[4] = {4, USB_DT_STRING, 0x09, 0x04};
457 /* Array of LANGID codes (0x0409 is MSFT-speak for "en-us") */
458 /* See http://www.usb.org/developers/docs/USB_LANGIDs.pdf */
461 memcpy(data, langids, len);
465 s = hcd->self.bus_name;
469 s = hcd->product_desc;
473 snprintf (buf, sizeof buf, "%s %s %s", init_utsname()->sysname,
474 init_utsname()->release, hcd->driver->description);
478 /* Can't happen; caller guarantees it */
482 return ascii2desc(s, data, len);
486 /* Root hub control transfers execute synchronously */
487 static int rh_call_control (struct usb_hcd *hcd, struct urb *urb)
489 struct usb_ctrlrequest *cmd;
490 u16 typeReq, wValue, wIndex, wLength;
491 u8 *ubuf = urb->transfer_buffer;
495 u8 patch_protocol = 0;
502 spin_lock_irq(&hcd_root_hub_lock);
503 status = usb_hcd_link_urb_to_ep(hcd, urb);
504 spin_unlock_irq(&hcd_root_hub_lock);
507 urb->hcpriv = hcd; /* Indicate it's queued */
509 cmd = (struct usb_ctrlrequest *) urb->setup_packet;
510 typeReq = (cmd->bRequestType << 8) | cmd->bRequest;
511 wValue = le16_to_cpu (cmd->wValue);
512 wIndex = le16_to_cpu (cmd->wIndex);
513 wLength = le16_to_cpu (cmd->wLength);
515 if (wLength > urb->transfer_buffer_length)
519 * tbuf should be at least as big as the
520 * USB hub descriptor.
522 tbuf_size = max_t(u16, sizeof(struct usb_hub_descriptor), wLength);
523 tbuf = kzalloc(tbuf_size, GFP_KERNEL);
532 urb->actual_length = 0;
535 /* DEVICE REQUESTS */
537 /* The root hub's remote wakeup enable bit is implemented using
538 * driver model wakeup flags. If this system supports wakeup
539 * through USB, userspace may change the default "allow wakeup"
540 * policy through sysfs or these calls.
542 * Most root hubs support wakeup from downstream devices, for
543 * runtime power management (disabling USB clocks and reducing
544 * VBUS power usage). However, not all of them do so; silicon,
545 * board, and BIOS bugs here are not uncommon, so these can't
546 * be treated quite like external hubs.
548 * Likewise, not all root hubs will pass wakeup events upstream,
549 * to wake up the whole system. So don't assume root hub and
550 * controller capabilities are identical.
553 case DeviceRequest | USB_REQ_GET_STATUS:
554 tbuf[0] = (device_may_wakeup(&hcd->self.root_hub->dev)
555 << USB_DEVICE_REMOTE_WAKEUP)
556 | (1 << USB_DEVICE_SELF_POWERED);
560 case DeviceOutRequest | USB_REQ_CLEAR_FEATURE:
561 if (wValue == USB_DEVICE_REMOTE_WAKEUP)
562 device_set_wakeup_enable(&hcd->self.root_hub->dev, 0);
566 case DeviceOutRequest | USB_REQ_SET_FEATURE:
567 if (device_can_wakeup(&hcd->self.root_hub->dev)
568 && wValue == USB_DEVICE_REMOTE_WAKEUP)
569 device_set_wakeup_enable(&hcd->self.root_hub->dev, 1);
573 case DeviceRequest | USB_REQ_GET_CONFIGURATION:
577 case DeviceOutRequest | USB_REQ_SET_CONFIGURATION:
579 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
580 switch (wValue & 0xff00) {
581 case USB_DT_DEVICE << 8:
582 switch (hcd->speed) {
584 bufp = usb31_rh_dev_descriptor;
587 bufp = usb3_rh_dev_descriptor;
590 bufp = usb25_rh_dev_descriptor;
593 bufp = usb2_rh_dev_descriptor;
596 bufp = usb11_rh_dev_descriptor;
605 case USB_DT_CONFIG << 8:
606 switch (hcd->speed) {
609 bufp = ss_rh_config_descriptor;
610 len = sizeof ss_rh_config_descriptor;
614 bufp = hs_rh_config_descriptor;
615 len = sizeof hs_rh_config_descriptor;
618 bufp = fs_rh_config_descriptor;
619 len = sizeof fs_rh_config_descriptor;
624 if (device_can_wakeup(&hcd->self.root_hub->dev))
627 case USB_DT_STRING << 8:
628 if ((wValue & 0xff) < 4)
629 urb->actual_length = rh_string(wValue & 0xff,
631 else /* unsupported IDs --> "protocol stall" */
634 case USB_DT_BOS << 8:
640 case DeviceRequest | USB_REQ_GET_INTERFACE:
644 case DeviceOutRequest | USB_REQ_SET_INTERFACE:
646 case DeviceOutRequest | USB_REQ_SET_ADDRESS:
647 /* wValue == urb->dev->devaddr */
648 dev_dbg (hcd->self.controller, "root hub device address %d\n",
652 /* INTERFACE REQUESTS (no defined feature/status flags) */
654 /* ENDPOINT REQUESTS */
656 case EndpointRequest | USB_REQ_GET_STATUS:
657 /* ENDPOINT_HALT flag */
662 case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
663 case EndpointOutRequest | USB_REQ_SET_FEATURE:
664 dev_dbg (hcd->self.controller, "no endpoint features yet\n");
667 /* CLASS REQUESTS (and errors) */
671 /* non-generic request */
677 if (wValue == HUB_PORT_STATUS)
680 /* other port status types return 8 bytes */
683 case GetHubDescriptor:
684 len = sizeof (struct usb_hub_descriptor);
686 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
687 /* len is returned by hub_control */
690 status = hcd->driver->hub_control (hcd,
691 typeReq, wValue, wIndex,
694 if (typeReq == GetHubDescriptor)
695 usb_hub_adjust_deviceremovable(hcd->self.root_hub,
696 (struct usb_hub_descriptor *)tbuf);
699 /* "protocol stall" on error */
705 if (status != -EPIPE) {
706 dev_dbg (hcd->self.controller,
707 "CTRL: TypeReq=0x%x val=0x%x "
708 "idx=0x%x len=%d ==> %d\n",
709 typeReq, wValue, wIndex,
712 } else if (status > 0) {
713 /* hub_control may return the length of data copied. */
718 if (urb->transfer_buffer_length < len)
719 len = urb->transfer_buffer_length;
720 urb->actual_length = len;
721 /* always USB_DIR_IN, toward host */
722 memcpy (ubuf, bufp, len);
724 /* report whether RH hardware supports remote wakeup */
726 len > offsetof (struct usb_config_descriptor,
728 ((struct usb_config_descriptor *)ubuf)->bmAttributes
729 |= USB_CONFIG_ATT_WAKEUP;
731 /* report whether RH hardware has an integrated TT */
732 if (patch_protocol &&
733 len > offsetof(struct usb_device_descriptor,
735 ((struct usb_device_descriptor *) ubuf)->
736 bDeviceProtocol = USB_HUB_PR_HS_SINGLE_TT;
742 /* any errors get returned through the urb completion */
743 spin_lock_irq(&hcd_root_hub_lock);
744 usb_hcd_unlink_urb_from_ep(hcd, urb);
745 usb_hcd_giveback_urb(hcd, urb, status);
746 spin_unlock_irq(&hcd_root_hub_lock);
750 /*-------------------------------------------------------------------------*/
753 * Root Hub interrupt transfers are polled using a timer if the
754 * driver requests it; otherwise the driver is responsible for
755 * calling usb_hcd_poll_rh_status() when an event occurs.
757 * Completions are called in_interrupt(), but they may or may not
760 void usb_hcd_poll_rh_status(struct usb_hcd *hcd)
766 char buffer[6]; /* Any root hubs with > 31 ports? */
768 if (unlikely(!hcd->rh_pollable))
770 if (!hcd->uses_new_polling && !hcd->status_urb)
773 length = hcd->driver->hub_status_data(hcd, buffer);
776 /* try to complete the status urb */
777 spin_lock_irqsave(&hcd_root_hub_lock, flags);
778 urb = hcd->status_urb;
780 clear_bit(HCD_FLAG_POLL_PENDING, &hcd->flags);
781 hcd->status_urb = NULL;
782 if (urb->transfer_buffer_length >= length) {
786 length = urb->transfer_buffer_length;
788 urb->actual_length = length;
789 memcpy(urb->transfer_buffer, buffer, length);
791 usb_hcd_unlink_urb_from_ep(hcd, urb);
792 usb_hcd_giveback_urb(hcd, urb, status);
795 set_bit(HCD_FLAG_POLL_PENDING, &hcd->flags);
797 spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
800 /* The USB 2.0 spec says 256 ms. This is close enough and won't
801 * exceed that limit if HZ is 100. The math is more clunky than
802 * maybe expected, this is to make sure that all timers for USB devices
803 * fire at the same time to give the CPU a break in between */
804 if (hcd->uses_new_polling ? HCD_POLL_RH(hcd) :
805 (length == 0 && hcd->status_urb != NULL))
806 mod_timer (&hcd->rh_timer, (jiffies/(HZ/4) + 1) * (HZ/4));
808 EXPORT_SYMBOL_GPL(usb_hcd_poll_rh_status);
811 static void rh_timer_func (unsigned long _hcd)
813 usb_hcd_poll_rh_status((struct usb_hcd *) _hcd);
816 /*-------------------------------------------------------------------------*/
818 static int rh_queue_status (struct usb_hcd *hcd, struct urb *urb)
822 unsigned len = 1 + (urb->dev->maxchild / 8);
824 spin_lock_irqsave (&hcd_root_hub_lock, flags);
825 if (hcd->status_urb || urb->transfer_buffer_length < len) {
826 dev_dbg (hcd->self.controller, "not queuing rh status urb\n");
831 retval = usb_hcd_link_urb_to_ep(hcd, urb);
835 hcd->status_urb = urb;
836 urb->hcpriv = hcd; /* indicate it's queued */
837 if (!hcd->uses_new_polling)
838 mod_timer(&hcd->rh_timer, (jiffies/(HZ/4) + 1) * (HZ/4));
840 /* If a status change has already occurred, report it ASAP */
841 else if (HCD_POLL_PENDING(hcd))
842 mod_timer(&hcd->rh_timer, jiffies);
845 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
849 static int rh_urb_enqueue (struct usb_hcd *hcd, struct urb *urb)
851 if (usb_endpoint_xfer_int(&urb->ep->desc))
852 return rh_queue_status (hcd, urb);
853 if (usb_endpoint_xfer_control(&urb->ep->desc))
854 return rh_call_control (hcd, urb);
858 /*-------------------------------------------------------------------------*/
860 /* Unlinks of root-hub control URBs are legal, but they don't do anything
861 * since these URBs always execute synchronously.
863 static int usb_rh_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
868 spin_lock_irqsave(&hcd_root_hub_lock, flags);
869 rc = usb_hcd_check_unlink_urb(hcd, urb, status);
873 if (usb_endpoint_num(&urb->ep->desc) == 0) { /* Control URB */
876 } else { /* Status URB */
877 if (!hcd->uses_new_polling)
878 del_timer (&hcd->rh_timer);
879 if (urb == hcd->status_urb) {
880 hcd->status_urb = NULL;
881 usb_hcd_unlink_urb_from_ep(hcd, urb);
882 usb_hcd_giveback_urb(hcd, urb, status);
886 spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
893 * Show & store the current value of authorized_default
895 static ssize_t authorized_default_show(struct device *dev,
896 struct device_attribute *attr, char *buf)
898 struct usb_device *rh_usb_dev = to_usb_device(dev);
899 struct usb_bus *usb_bus = rh_usb_dev->bus;
902 hcd = bus_to_hcd(usb_bus);
903 return snprintf(buf, PAGE_SIZE, "%u\n", !!HCD_DEV_AUTHORIZED(hcd));
906 static ssize_t authorized_default_store(struct device *dev,
907 struct device_attribute *attr,
908 const char *buf, size_t size)
912 struct usb_device *rh_usb_dev = to_usb_device(dev);
913 struct usb_bus *usb_bus = rh_usb_dev->bus;
916 hcd = bus_to_hcd(usb_bus);
917 result = sscanf(buf, "%u\n", &val);
920 set_bit(HCD_FLAG_DEV_AUTHORIZED, &hcd->flags);
922 clear_bit(HCD_FLAG_DEV_AUTHORIZED, &hcd->flags);
930 static DEVICE_ATTR_RW(authorized_default);
933 * interface_authorized_default_show - show default authorization status
936 * note: interface_authorized_default is the default value
937 * for initializing the authorized attribute of interfaces
939 static ssize_t interface_authorized_default_show(struct device *dev,
940 struct device_attribute *attr, char *buf)
942 struct usb_device *usb_dev = to_usb_device(dev);
943 struct usb_hcd *hcd = bus_to_hcd(usb_dev->bus);
945 return sprintf(buf, "%u\n", !!HCD_INTF_AUTHORIZED(hcd));
949 * interface_authorized_default_store - store default authorization status
952 * note: interface_authorized_default is the default value
953 * for initializing the authorized attribute of interfaces
955 static ssize_t interface_authorized_default_store(struct device *dev,
956 struct device_attribute *attr, const char *buf, size_t count)
958 struct usb_device *usb_dev = to_usb_device(dev);
959 struct usb_hcd *hcd = bus_to_hcd(usb_dev->bus);
963 if (strtobool(buf, &val) != 0)
967 set_bit(HCD_FLAG_INTF_AUTHORIZED, &hcd->flags);
969 clear_bit(HCD_FLAG_INTF_AUTHORIZED, &hcd->flags);
973 static DEVICE_ATTR_RW(interface_authorized_default);
975 /* Group all the USB bus attributes */
976 static struct attribute *usb_bus_attrs[] = {
977 &dev_attr_authorized_default.attr,
978 &dev_attr_interface_authorized_default.attr,
982 static const struct attribute_group usb_bus_attr_group = {
983 .name = NULL, /* we want them in the same directory */
984 .attrs = usb_bus_attrs,
989 /*-------------------------------------------------------------------------*/
992 * usb_bus_init - shared initialization code
993 * @bus: the bus structure being initialized
995 * This code is used to initialize a usb_bus structure, memory for which is
996 * separately managed.
998 static void usb_bus_init (struct usb_bus *bus)
1000 memset (&bus->devmap, 0, sizeof(struct usb_devmap));
1002 bus->devnum_next = 1;
1004 bus->root_hub = NULL;
1006 bus->bandwidth_allocated = 0;
1007 bus->bandwidth_int_reqs = 0;
1008 bus->bandwidth_isoc_reqs = 0;
1009 mutex_init(&bus->devnum_next_mutex);
1012 /*-------------------------------------------------------------------------*/
1015 * usb_register_bus - registers the USB host controller with the usb core
1016 * @bus: pointer to the bus to register
1017 * Context: !in_interrupt()
1019 * Assigns a bus number, and links the controller into usbcore data
1020 * structures so that it can be seen by scanning the bus list.
1022 * Return: 0 if successful. A negative error code otherwise.
1024 static int usb_register_bus(struct usb_bus *bus)
1026 int result = -E2BIG;
1029 mutex_lock(&usb_bus_idr_lock);
1030 busnum = idr_alloc(&usb_bus_idr, bus, 1, USB_MAXBUS, GFP_KERNEL);
1032 pr_err("%s: failed to get bus number\n", usbcore_name);
1033 goto error_find_busnum;
1035 bus->busnum = busnum;
1036 mutex_unlock(&usb_bus_idr_lock);
1038 usb_notify_add_bus(bus);
1040 dev_info (bus->controller, "new USB bus registered, assigned bus "
1041 "number %d\n", bus->busnum);
1045 mutex_unlock(&usb_bus_idr_lock);
1050 * usb_deregister_bus - deregisters the USB host controller
1051 * @bus: pointer to the bus to deregister
1052 * Context: !in_interrupt()
1054 * Recycles the bus number, and unlinks the controller from usbcore data
1055 * structures so that it won't be seen by scanning the bus list.
1057 static void usb_deregister_bus (struct usb_bus *bus)
1059 dev_info (bus->controller, "USB bus %d deregistered\n", bus->busnum);
1062 * NOTE: make sure that all the devices are removed by the
1063 * controller code, as well as having it call this when cleaning
1066 mutex_lock(&usb_bus_idr_lock);
1067 idr_remove(&usb_bus_idr, bus->busnum);
1068 mutex_unlock(&usb_bus_idr_lock);
1070 usb_notify_remove_bus(bus);
1074 * register_root_hub - called by usb_add_hcd() to register a root hub
1075 * @hcd: host controller for this root hub
1077 * This function registers the root hub with the USB subsystem. It sets up
1078 * the device properly in the device tree and then calls usb_new_device()
1079 * to register the usb device. It also assigns the root hub's USB address
1082 * Return: 0 if successful. A negative error code otherwise.
1084 static int register_root_hub(struct usb_hcd *hcd)
1086 struct device *parent_dev = hcd->self.controller;
1087 struct usb_device *usb_dev = hcd->self.root_hub;
1088 const int devnum = 1;
1091 usb_dev->devnum = devnum;
1092 usb_dev->bus->devnum_next = devnum + 1;
1093 memset (&usb_dev->bus->devmap.devicemap, 0,
1094 sizeof usb_dev->bus->devmap.devicemap);
1095 set_bit (devnum, usb_dev->bus->devmap.devicemap);
1096 usb_set_device_state(usb_dev, USB_STATE_ADDRESS);
1098 mutex_lock(&usb_bus_idr_lock);
1100 usb_dev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
1101 retval = usb_get_device_descriptor(usb_dev, USB_DT_DEVICE_SIZE);
1102 if (retval != sizeof usb_dev->descriptor) {
1103 mutex_unlock(&usb_bus_idr_lock);
1104 dev_dbg (parent_dev, "can't read %s device descriptor %d\n",
1105 dev_name(&usb_dev->dev), retval);
1106 return (retval < 0) ? retval : -EMSGSIZE;
1109 if (le16_to_cpu(usb_dev->descriptor.bcdUSB) >= 0x0201) {
1110 retval = usb_get_bos_descriptor(usb_dev);
1112 usb_dev->lpm_capable = usb_device_supports_lpm(usb_dev);
1113 } else if (usb_dev->speed >= USB_SPEED_SUPER) {
1114 mutex_unlock(&usb_bus_idr_lock);
1115 dev_dbg(parent_dev, "can't read %s bos descriptor %d\n",
1116 dev_name(&usb_dev->dev), retval);
1121 retval = usb_new_device (usb_dev);
1123 dev_err (parent_dev, "can't register root hub for %s, %d\n",
1124 dev_name(&usb_dev->dev), retval);
1126 spin_lock_irq (&hcd_root_hub_lock);
1127 hcd->rh_registered = 1;
1128 spin_unlock_irq (&hcd_root_hub_lock);
1130 /* Did the HC die before the root hub was registered? */
1132 usb_hc_died (hcd); /* This time clean up */
1134 mutex_unlock(&usb_bus_idr_lock);
1140 * usb_hcd_start_port_resume - a root-hub port is sending a resume signal
1141 * @bus: the bus which the root hub belongs to
1142 * @portnum: the port which is being resumed
1144 * HCDs should call this function when they know that a resume signal is
1145 * being sent to a root-hub port. The root hub will be prevented from
1146 * going into autosuspend until usb_hcd_end_port_resume() is called.
1148 * The bus's private lock must be held by the caller.
1150 void usb_hcd_start_port_resume(struct usb_bus *bus, int portnum)
1152 unsigned bit = 1 << portnum;
1154 if (!(bus->resuming_ports & bit)) {
1155 bus->resuming_ports |= bit;
1156 pm_runtime_get_noresume(&bus->root_hub->dev);
1159 EXPORT_SYMBOL_GPL(usb_hcd_start_port_resume);
1162 * usb_hcd_end_port_resume - a root-hub port has stopped sending a resume signal
1163 * @bus: the bus which the root hub belongs to
1164 * @portnum: the port which is being resumed
1166 * HCDs should call this function when they know that a resume signal has
1167 * stopped being sent to a root-hub port. The root hub will be allowed to
1168 * autosuspend again.
1170 * The bus's private lock must be held by the caller.
1172 void usb_hcd_end_port_resume(struct usb_bus *bus, int portnum)
1174 unsigned bit = 1 << portnum;
1176 if (bus->resuming_ports & bit) {
1177 bus->resuming_ports &= ~bit;
1178 pm_runtime_put_noidle(&bus->root_hub->dev);
1181 EXPORT_SYMBOL_GPL(usb_hcd_end_port_resume);
1183 /*-------------------------------------------------------------------------*/
1186 * usb_calc_bus_time - approximate periodic transaction time in nanoseconds
1187 * @speed: from dev->speed; USB_SPEED_{LOW,FULL,HIGH}
1188 * @is_input: true iff the transaction sends data to the host
1189 * @isoc: true for isochronous transactions, false for interrupt ones
1190 * @bytecount: how many bytes in the transaction.
1192 * Return: Approximate bus time in nanoseconds for a periodic transaction.
1195 * See USB 2.0 spec section 5.11.3; only periodic transfers need to be
1196 * scheduled in software, this function is only used for such scheduling.
1198 long usb_calc_bus_time (int speed, int is_input, int isoc, int bytecount)
1203 case USB_SPEED_LOW: /* INTR only */
1205 tmp = (67667L * (31L + 10L * BitTime (bytecount))) / 1000L;
1206 return 64060L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp;
1208 tmp = (66700L * (31L + 10L * BitTime (bytecount))) / 1000L;
1209 return 64107L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp;
1211 case USB_SPEED_FULL: /* ISOC or INTR */
1213 tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
1214 return ((is_input) ? 7268L : 6265L) + BW_HOST_DELAY + tmp;
1216 tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
1217 return 9107L + BW_HOST_DELAY + tmp;
1219 case USB_SPEED_HIGH: /* ISOC or INTR */
1220 /* FIXME adjust for input vs output */
1222 tmp = HS_NSECS_ISO (bytecount);
1224 tmp = HS_NSECS (bytecount);
1227 pr_debug ("%s: bogus device speed!\n", usbcore_name);
1231 EXPORT_SYMBOL_GPL(usb_calc_bus_time);
1234 /*-------------------------------------------------------------------------*/
1237 * Generic HC operations.
1240 /*-------------------------------------------------------------------------*/
1243 * usb_hcd_link_urb_to_ep - add an URB to its endpoint queue
1244 * @hcd: host controller to which @urb was submitted
1245 * @urb: URB being submitted
1247 * Host controller drivers should call this routine in their enqueue()
1248 * method. The HCD's private spinlock must be held and interrupts must
1249 * be disabled. The actions carried out here are required for URB
1250 * submission, as well as for endpoint shutdown and for usb_kill_urb.
1252 * Return: 0 for no error, otherwise a negative error code (in which case
1253 * the enqueue() method must fail). If no error occurs but enqueue() fails
1254 * anyway, it must call usb_hcd_unlink_urb_from_ep() before releasing
1255 * the private spinlock and returning.
1257 int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb)
1261 spin_lock(&hcd_urb_list_lock);
1263 /* Check that the URB isn't being killed */
1264 if (unlikely(atomic_read(&urb->reject))) {
1269 if (unlikely(!urb->ep->enabled)) {
1274 if (unlikely(!urb->dev->can_submit)) {
1280 * Check the host controller's state and add the URB to the
1283 if (HCD_RH_RUNNING(hcd)) {
1285 list_add_tail(&urb->urb_list, &urb->ep->urb_list);
1291 spin_unlock(&hcd_urb_list_lock);
1294 EXPORT_SYMBOL_GPL(usb_hcd_link_urb_to_ep);
1297 * usb_hcd_check_unlink_urb - check whether an URB may be unlinked
1298 * @hcd: host controller to which @urb was submitted
1299 * @urb: URB being checked for unlinkability
1300 * @status: error code to store in @urb if the unlink succeeds
1302 * Host controller drivers should call this routine in their dequeue()
1303 * method. The HCD's private spinlock must be held and interrupts must
1304 * be disabled. The actions carried out here are required for making
1305 * sure than an unlink is valid.
1307 * Return: 0 for no error, otherwise a negative error code (in which case
1308 * the dequeue() method must fail). The possible error codes are:
1310 * -EIDRM: @urb was not submitted or has already completed.
1311 * The completion function may not have been called yet.
1313 * -EBUSY: @urb has already been unlinked.
1315 int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb,
1318 struct list_head *tmp;
1320 /* insist the urb is still queued */
1321 list_for_each(tmp, &urb->ep->urb_list) {
1322 if (tmp == &urb->urb_list)
1325 if (tmp != &urb->urb_list)
1328 /* Any status except -EINPROGRESS means something already started to
1329 * unlink this URB from the hardware. So there's no more work to do.
1333 urb->unlinked = status;
1336 EXPORT_SYMBOL_GPL(usb_hcd_check_unlink_urb);
1339 * usb_hcd_unlink_urb_from_ep - remove an URB from its endpoint queue
1340 * @hcd: host controller to which @urb was submitted
1341 * @urb: URB being unlinked
1343 * Host controller drivers should call this routine before calling
1344 * usb_hcd_giveback_urb(). The HCD's private spinlock must be held and
1345 * interrupts must be disabled. The actions carried out here are required
1346 * for URB completion.
1348 void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb)
1350 /* clear all state linking urb to this dev (and hcd) */
1351 spin_lock(&hcd_urb_list_lock);
1352 list_del_init(&urb->urb_list);
1353 spin_unlock(&hcd_urb_list_lock);
1355 EXPORT_SYMBOL_GPL(usb_hcd_unlink_urb_from_ep);
1358 * Some usb host controllers can only perform dma using a small SRAM area.
1359 * The usb core itself is however optimized for host controllers that can dma
1360 * using regular system memory - like pci devices doing bus mastering.
1362 * To support host controllers with limited dma capabilities we provide dma
1363 * bounce buffers. This feature can be enabled using the HCD_LOCAL_MEM flag.
1364 * For this to work properly the host controller code must first use the
1365 * function dma_declare_coherent_memory() to point out which memory area
1366 * that should be used for dma allocations.
1368 * The HCD_LOCAL_MEM flag then tells the usb code to allocate all data for
1369 * dma using dma_alloc_coherent() which in turn allocates from the memory
1370 * area pointed out with dma_declare_coherent_memory().
1372 * So, to summarize...
1374 * - We need "local" memory, canonical example being
1375 * a small SRAM on a discrete controller being the
1376 * only memory that the controller can read ...
1377 * (a) "normal" kernel memory is no good, and
1378 * (b) there's not enough to share
1380 * - The only *portable* hook for such stuff in the
1381 * DMA framework is dma_declare_coherent_memory()
1383 * - So we use that, even though the primary requirement
1384 * is that the memory be "local" (hence addressable
1385 * by that device), not "coherent".
1389 static int hcd_alloc_coherent(struct usb_bus *bus,
1390 gfp_t mem_flags, dma_addr_t *dma_handle,
1391 void **vaddr_handle, size_t size,
1392 enum dma_data_direction dir)
1394 unsigned char *vaddr;
1396 if (*vaddr_handle == NULL) {
1401 vaddr = hcd_buffer_alloc(bus, size + sizeof(vaddr),
1402 mem_flags, dma_handle);
1407 * Store the virtual address of the buffer at the end
1408 * of the allocated dma buffer. The size of the buffer
1409 * may be uneven so use unaligned functions instead
1410 * of just rounding up. It makes sense to optimize for
1411 * memory footprint over access speed since the amount
1412 * of memory available for dma may be limited.
1414 put_unaligned((unsigned long)*vaddr_handle,
1415 (unsigned long *)(vaddr + size));
1417 if (dir == DMA_TO_DEVICE)
1418 memcpy(vaddr, *vaddr_handle, size);
1420 *vaddr_handle = vaddr;
1424 static void hcd_free_coherent(struct usb_bus *bus, dma_addr_t *dma_handle,
1425 void **vaddr_handle, size_t size,
1426 enum dma_data_direction dir)
1428 unsigned char *vaddr = *vaddr_handle;
1430 vaddr = (void *)get_unaligned((unsigned long *)(vaddr + size));
1432 if (dir == DMA_FROM_DEVICE)
1433 memcpy(vaddr, *vaddr_handle, size);
1435 hcd_buffer_free(bus, size + sizeof(vaddr), *vaddr_handle, *dma_handle);
1437 *vaddr_handle = vaddr;
1441 void usb_hcd_unmap_urb_setup_for_dma(struct usb_hcd *hcd, struct urb *urb)
1443 if (IS_ENABLED(CONFIG_HAS_DMA) &&
1444 (urb->transfer_flags & URB_SETUP_MAP_SINGLE))
1445 dma_unmap_single(hcd->self.sysdev,
1447 sizeof(struct usb_ctrlrequest),
1449 else if (urb->transfer_flags & URB_SETUP_MAP_LOCAL)
1450 hcd_free_coherent(urb->dev->bus,
1452 (void **) &urb->setup_packet,
1453 sizeof(struct usb_ctrlrequest),
1456 /* Make it safe to call this routine more than once */
1457 urb->transfer_flags &= ~(URB_SETUP_MAP_SINGLE | URB_SETUP_MAP_LOCAL);
1459 EXPORT_SYMBOL_GPL(usb_hcd_unmap_urb_setup_for_dma);
1461 static void unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
1463 if (hcd->driver->unmap_urb_for_dma)
1464 hcd->driver->unmap_urb_for_dma(hcd, urb);
1466 usb_hcd_unmap_urb_for_dma(hcd, urb);
1469 void usb_hcd_unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
1471 enum dma_data_direction dir;
1473 usb_hcd_unmap_urb_setup_for_dma(hcd, urb);
1475 dir = usb_urb_dir_in(urb) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
1476 if (IS_ENABLED(CONFIG_HAS_DMA) &&
1477 (urb->transfer_flags & URB_DMA_MAP_SG))
1478 dma_unmap_sg(hcd->self.sysdev,
1482 else if (IS_ENABLED(CONFIG_HAS_DMA) &&
1483 (urb->transfer_flags & URB_DMA_MAP_PAGE))
1484 dma_unmap_page(hcd->self.sysdev,
1486 urb->transfer_buffer_length,
1488 else if (IS_ENABLED(CONFIG_HAS_DMA) &&
1489 (urb->transfer_flags & URB_DMA_MAP_SINGLE))
1490 dma_unmap_single(hcd->self.sysdev,
1492 urb->transfer_buffer_length,
1494 else if (urb->transfer_flags & URB_MAP_LOCAL)
1495 hcd_free_coherent(urb->dev->bus,
1497 &urb->transfer_buffer,
1498 urb->transfer_buffer_length,
1501 /* Make it safe to call this routine more than once */
1502 urb->transfer_flags &= ~(URB_DMA_MAP_SG | URB_DMA_MAP_PAGE |
1503 URB_DMA_MAP_SINGLE | URB_MAP_LOCAL);
1505 EXPORT_SYMBOL_GPL(usb_hcd_unmap_urb_for_dma);
1507 static int map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
1510 if (hcd->driver->map_urb_for_dma)
1511 return hcd->driver->map_urb_for_dma(hcd, urb, mem_flags);
1513 return usb_hcd_map_urb_for_dma(hcd, urb, mem_flags);
1516 int usb_hcd_map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
1519 enum dma_data_direction dir;
1522 /* Map the URB's buffers for DMA access.
1523 * Lower level HCD code should use *_dma exclusively,
1524 * unless it uses pio or talks to another transport,
1525 * or uses the provided scatter gather list for bulk.
1528 if (usb_endpoint_xfer_control(&urb->ep->desc)) {
1529 if (hcd->self.uses_pio_for_control)
1531 if (IS_ENABLED(CONFIG_HAS_DMA) && hcd->self.uses_dma) {
1532 if (is_vmalloc_addr(urb->setup_packet)) {
1533 WARN_ONCE(1, "setup packet is not dma capable\n");
1535 } else if (object_is_on_stack(urb->setup_packet)) {
1536 WARN_ONCE(1, "setup packet is on stack\n");
1540 urb->setup_dma = dma_map_single(
1543 sizeof(struct usb_ctrlrequest),
1545 if (dma_mapping_error(hcd->self.sysdev,
1548 urb->transfer_flags |= URB_SETUP_MAP_SINGLE;
1549 } else if (hcd->driver->flags & HCD_LOCAL_MEM) {
1550 ret = hcd_alloc_coherent(
1551 urb->dev->bus, mem_flags,
1553 (void **)&urb->setup_packet,
1554 sizeof(struct usb_ctrlrequest),
1558 urb->transfer_flags |= URB_SETUP_MAP_LOCAL;
1562 dir = usb_urb_dir_in(urb) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
1563 if (urb->transfer_buffer_length != 0
1564 && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP)) {
1565 if (IS_ENABLED(CONFIG_HAS_DMA) && hcd->self.uses_dma) {
1569 /* We don't support sg for isoc transfers ! */
1570 if (usb_endpoint_xfer_isoc(&urb->ep->desc)) {
1583 urb->transfer_flags |= URB_DMA_MAP_SG;
1584 urb->num_mapped_sgs = n;
1585 if (n != urb->num_sgs)
1586 urb->transfer_flags |=
1587 URB_DMA_SG_COMBINED;
1588 } else if (urb->sg) {
1589 struct scatterlist *sg = urb->sg;
1590 urb->transfer_dma = dma_map_page(
1594 urb->transfer_buffer_length,
1596 if (dma_mapping_error(hcd->self.sysdev,
1600 urb->transfer_flags |= URB_DMA_MAP_PAGE;
1601 } else if (is_vmalloc_addr(urb->transfer_buffer)) {
1602 WARN_ONCE(1, "transfer buffer not dma capable\n");
1604 } else if (object_is_on_stack(urb->transfer_buffer)) {
1605 WARN_ONCE(1, "transfer buffer is on stack\n");
1608 urb->transfer_dma = dma_map_single(
1610 urb->transfer_buffer,
1611 urb->transfer_buffer_length,
1613 if (dma_mapping_error(hcd->self.sysdev,
1617 urb->transfer_flags |= URB_DMA_MAP_SINGLE;
1619 } else if (hcd->driver->flags & HCD_LOCAL_MEM) {
1620 ret = hcd_alloc_coherent(
1621 urb->dev->bus, mem_flags,
1623 &urb->transfer_buffer,
1624 urb->transfer_buffer_length,
1627 urb->transfer_flags |= URB_MAP_LOCAL;
1629 if (ret && (urb->transfer_flags & (URB_SETUP_MAP_SINGLE |
1630 URB_SETUP_MAP_LOCAL)))
1631 usb_hcd_unmap_urb_for_dma(hcd, urb);
1635 EXPORT_SYMBOL_GPL(usb_hcd_map_urb_for_dma);
1637 /*-------------------------------------------------------------------------*/
1639 /* may be called in any context with a valid urb->dev usecount
1640 * caller surrenders "ownership" of urb
1641 * expects usb_submit_urb() to have sanity checked and conditioned all
1644 int usb_hcd_submit_urb (struct urb *urb, gfp_t mem_flags)
1647 struct usb_hcd *hcd = bus_to_hcd(urb->dev->bus);
1649 /* increment urb's reference count as part of giving it to the HCD
1650 * (which will control it). HCD guarantees that it either returns
1651 * an error or calls giveback(), but not both.
1654 atomic_inc(&urb->use_count);
1655 atomic_inc(&urb->dev->urbnum);
1656 usbmon_urb_submit(&hcd->self, urb);
1658 /* NOTE requirements on root-hub callers (usbfs and the hub
1659 * driver, for now): URBs' urb->transfer_buffer must be
1660 * valid and usb_buffer_{sync,unmap}() not be needed, since
1661 * they could clobber root hub response data. Also, control
1662 * URBs must be submitted in process context with interrupts
1666 if (is_root_hub(urb->dev)) {
1667 status = rh_urb_enqueue(hcd, urb);
1669 status = map_urb_for_dma(hcd, urb, mem_flags);
1670 if (likely(status == 0)) {
1671 status = hcd->driver->urb_enqueue(hcd, urb, mem_flags);
1672 if (unlikely(status))
1673 unmap_urb_for_dma(hcd, urb);
1677 if (unlikely(status)) {
1678 usbmon_urb_submit_error(&hcd->self, urb, status);
1680 INIT_LIST_HEAD(&urb->urb_list);
1681 atomic_dec(&urb->use_count);
1683 * Order the write of urb->use_count above before the read
1684 * of urb->reject below. Pairs with the memory barriers in
1685 * usb_kill_urb() and usb_poison_urb().
1687 smp_mb__after_atomic();
1689 atomic_dec(&urb->dev->urbnum);
1690 if (atomic_read(&urb->reject))
1691 wake_up(&usb_kill_urb_queue);
1697 /*-------------------------------------------------------------------------*/
1699 /* this makes the hcd giveback() the urb more quickly, by kicking it
1700 * off hardware queues (which may take a while) and returning it as
1701 * soon as practical. we've already set up the urb's return status,
1702 * but we can't know if the callback completed already.
1704 static int unlink1(struct usb_hcd *hcd, struct urb *urb, int status)
1708 if (is_root_hub(urb->dev))
1709 value = usb_rh_urb_dequeue(hcd, urb, status);
1712 /* The only reason an HCD might fail this call is if
1713 * it has not yet fully queued the urb to begin with.
1714 * Such failures should be harmless. */
1715 value = hcd->driver->urb_dequeue(hcd, urb, status);
1721 * called in any context
1723 * caller guarantees urb won't be recycled till both unlink()
1724 * and the urb's completion function return
1726 int usb_hcd_unlink_urb (struct urb *urb, int status)
1728 struct usb_hcd *hcd;
1729 struct usb_device *udev = urb->dev;
1730 int retval = -EIDRM;
1731 unsigned long flags;
1733 /* Prevent the device and bus from going away while
1734 * the unlink is carried out. If they are already gone
1735 * then urb->use_count must be 0, since disconnected
1736 * devices can't have any active URBs.
1738 spin_lock_irqsave(&hcd_urb_unlink_lock, flags);
1739 if (atomic_read(&urb->use_count) > 0) {
1743 spin_unlock_irqrestore(&hcd_urb_unlink_lock, flags);
1745 hcd = bus_to_hcd(urb->dev->bus);
1746 retval = unlink1(hcd, urb, status);
1748 retval = -EINPROGRESS;
1749 else if (retval != -EIDRM && retval != -EBUSY)
1750 dev_dbg(&udev->dev, "hcd_unlink_urb %pK fail %d\n",
1757 /*-------------------------------------------------------------------------*/
1759 static void __usb_hcd_giveback_urb(struct urb *urb)
1761 struct usb_hcd *hcd = bus_to_hcd(urb->dev->bus);
1762 struct usb_anchor *anchor = urb->anchor;
1763 int status = urb->unlinked;
1764 unsigned long flags;
1767 if (unlikely((urb->transfer_flags & URB_SHORT_NOT_OK) &&
1768 urb->actual_length < urb->transfer_buffer_length &&
1770 status = -EREMOTEIO;
1772 unmap_urb_for_dma(hcd, urb);
1773 usbmon_urb_complete(&hcd->self, urb, status);
1774 usb_anchor_suspend_wakeups(anchor);
1775 usb_unanchor_urb(urb);
1776 if (likely(status == 0))
1777 usb_led_activity(USB_LED_EVENT_HOST);
1779 /* pass ownership to the completion handler */
1780 urb->status = status;
1783 * We disable local IRQs here avoid possible deadlock because
1784 * drivers may call spin_lock() to hold lock which might be
1785 * acquired in one hard interrupt handler.
1787 * The local_irq_save()/local_irq_restore() around complete()
1788 * will be removed if current USB drivers have been cleaned up
1789 * and no one may trigger the above deadlock situation when
1790 * running complete() in tasklet.
1792 local_irq_save(flags);
1794 local_irq_restore(flags);
1796 usb_anchor_resume_wakeups(anchor);
1797 atomic_dec(&urb->use_count);
1799 * Order the write of urb->use_count above before the read
1800 * of urb->reject below. Pairs with the memory barriers in
1801 * usb_kill_urb() and usb_poison_urb().
1803 smp_mb__after_atomic();
1805 if (unlikely(atomic_read(&urb->reject)))
1806 wake_up(&usb_kill_urb_queue);
1810 static void usb_giveback_urb_bh(unsigned long param)
1812 struct giveback_urb_bh *bh = (struct giveback_urb_bh *)param;
1813 struct list_head local_list;
1815 spin_lock_irq(&bh->lock);
1817 list_replace_init(&bh->head, &local_list);
1818 spin_unlock_irq(&bh->lock);
1820 while (!list_empty(&local_list)) {
1823 urb = list_entry(local_list.next, struct urb, urb_list);
1824 list_del_init(&urb->urb_list);
1825 bh->completing_ep = urb->ep;
1826 __usb_hcd_giveback_urb(urb);
1827 bh->completing_ep = NULL;
1831 * giveback new URBs next time to prevent this function
1832 * from not exiting for a long time.
1834 spin_lock_irq(&bh->lock);
1835 if (!list_empty(&bh->head)) {
1837 tasklet_hi_schedule(&bh->bh);
1839 tasklet_schedule(&bh->bh);
1841 bh->running = false;
1842 spin_unlock_irq(&bh->lock);
1846 * usb_hcd_giveback_urb - return URB from HCD to device driver
1847 * @hcd: host controller returning the URB
1848 * @urb: urb being returned to the USB device driver.
1849 * @status: completion status code for the URB.
1850 * Context: in_interrupt()
1852 * This hands the URB from HCD to its USB device driver, using its
1853 * completion function. The HCD has freed all per-urb resources
1854 * (and is done using urb->hcpriv). It also released all HCD locks;
1855 * the device driver won't cause problems if it frees, modifies,
1856 * or resubmits this URB.
1858 * If @urb was unlinked, the value of @status will be overridden by
1859 * @urb->unlinked. Erroneous short transfers are detected in case
1860 * the HCD hasn't checked for them.
1862 void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb, int status)
1864 struct giveback_urb_bh *bh;
1867 /* pass status to tasklet via unlinked */
1868 if (likely(!urb->unlinked))
1869 urb->unlinked = status;
1871 if (!hcd_giveback_urb_in_bh(hcd) && !is_root_hub(urb->dev)) {
1872 __usb_hcd_giveback_urb(urb);
1876 if (usb_pipeisoc(urb->pipe) || usb_pipeint(urb->pipe))
1877 bh = &hcd->high_prio_bh;
1879 bh = &hcd->low_prio_bh;
1881 spin_lock(&bh->lock);
1882 list_add_tail(&urb->urb_list, &bh->head);
1883 running = bh->running;
1884 spin_unlock(&bh->lock);
1888 else if (bh->high_prio)
1889 tasklet_hi_schedule(&bh->bh);
1891 tasklet_schedule(&bh->bh);
1893 EXPORT_SYMBOL_GPL(usb_hcd_giveback_urb);
1895 /*-------------------------------------------------------------------------*/
1897 /* Cancel all URBs pending on this endpoint and wait for the endpoint's
1898 * queue to drain completely. The caller must first insure that no more
1899 * URBs can be submitted for this endpoint.
1901 void usb_hcd_flush_endpoint(struct usb_device *udev,
1902 struct usb_host_endpoint *ep)
1904 struct usb_hcd *hcd;
1910 hcd = bus_to_hcd(udev->bus);
1912 /* No more submits can occur */
1913 spin_lock_irq(&hcd_urb_list_lock);
1915 list_for_each_entry_reverse(urb, &ep->urb_list, urb_list) {
1921 is_in = usb_urb_dir_in(urb);
1922 spin_unlock(&hcd_urb_list_lock);
1925 unlink1(hcd, urb, -ESHUTDOWN);
1926 dev_dbg (hcd->self.controller,
1927 "shutdown urb %pK ep%d%s%s\n",
1928 urb, usb_endpoint_num(&ep->desc),
1929 is_in ? "in" : "out",
1932 switch (usb_endpoint_type(&ep->desc)) {
1933 case USB_ENDPOINT_XFER_CONTROL:
1935 case USB_ENDPOINT_XFER_BULK:
1937 case USB_ENDPOINT_XFER_INT:
1946 /* list contents may have changed */
1947 spin_lock(&hcd_urb_list_lock);
1950 spin_unlock_irq(&hcd_urb_list_lock);
1952 /* Wait until the endpoint queue is completely empty */
1953 while (!list_empty (&ep->urb_list)) {
1954 spin_lock_irq(&hcd_urb_list_lock);
1956 /* The list may have changed while we acquired the spinlock */
1958 if (!list_empty (&ep->urb_list)) {
1959 urb = list_entry (ep->urb_list.prev, struct urb,
1963 spin_unlock_irq(&hcd_urb_list_lock);
1973 * usb_hcd_alloc_bandwidth - check whether a new bandwidth setting exceeds
1975 * @udev: target &usb_device
1976 * @new_config: new configuration to install
1977 * @cur_alt: the current alternate interface setting
1978 * @new_alt: alternate interface setting that is being installed
1980 * To change configurations, pass in the new configuration in new_config,
1981 * and pass NULL for cur_alt and new_alt.
1983 * To reset a device's configuration (put the device in the ADDRESSED state),
1984 * pass in NULL for new_config, cur_alt, and new_alt.
1986 * To change alternate interface settings, pass in NULL for new_config,
1987 * pass in the current alternate interface setting in cur_alt,
1988 * and pass in the new alternate interface setting in new_alt.
1990 * Return: An error if the requested bandwidth change exceeds the
1991 * bus bandwidth or host controller internal resources.
1993 int usb_hcd_alloc_bandwidth(struct usb_device *udev,
1994 struct usb_host_config *new_config,
1995 struct usb_host_interface *cur_alt,
1996 struct usb_host_interface *new_alt)
1998 int num_intfs, i, j;
1999 struct usb_host_interface *alt = NULL;
2001 struct usb_hcd *hcd;
2002 struct usb_host_endpoint *ep;
2004 hcd = bus_to_hcd(udev->bus);
2005 if (!hcd->driver->check_bandwidth)
2008 /* Configuration is being removed - set configuration 0 */
2009 if (!new_config && !cur_alt) {
2010 for (i = 1; i < 16; ++i) {
2011 ep = udev->ep_out[i];
2013 hcd->driver->drop_endpoint(hcd, udev, ep);
2014 ep = udev->ep_in[i];
2016 hcd->driver->drop_endpoint(hcd, udev, ep);
2018 hcd->driver->check_bandwidth(hcd, udev);
2021 /* Check if the HCD says there's enough bandwidth. Enable all endpoints
2022 * each interface's alt setting 0 and ask the HCD to check the bandwidth
2023 * of the bus. There will always be bandwidth for endpoint 0, so it's
2027 num_intfs = new_config->desc.bNumInterfaces;
2028 /* Remove endpoints (except endpoint 0, which is always on the
2029 * schedule) from the old config from the schedule
2031 for (i = 1; i < 16; ++i) {
2032 ep = udev->ep_out[i];
2034 ret = hcd->driver->drop_endpoint(hcd, udev, ep);
2038 ep = udev->ep_in[i];
2040 ret = hcd->driver->drop_endpoint(hcd, udev, ep);
2045 for (i = 0; i < num_intfs; ++i) {
2046 struct usb_host_interface *first_alt;
2049 first_alt = &new_config->intf_cache[i]->altsetting[0];
2050 iface_num = first_alt->desc.bInterfaceNumber;
2051 /* Set up endpoints for alternate interface setting 0 */
2052 alt = usb_find_alt_setting(new_config, iface_num, 0);
2054 /* No alt setting 0? Pick the first setting. */
2057 for (j = 0; j < alt->desc.bNumEndpoints; j++) {
2058 ret = hcd->driver->add_endpoint(hcd, udev, &alt->endpoint[j]);
2064 if (cur_alt && new_alt) {
2065 struct usb_interface *iface = usb_ifnum_to_if(udev,
2066 cur_alt->desc.bInterfaceNumber);
2070 if (iface->resetting_device) {
2072 * The USB core just reset the device, so the xHCI host
2073 * and the device will think alt setting 0 is installed.
2074 * However, the USB core will pass in the alternate
2075 * setting installed before the reset as cur_alt. Dig
2076 * out the alternate setting 0 structure, or the first
2077 * alternate setting if a broken device doesn't have alt
2080 cur_alt = usb_altnum_to_altsetting(iface, 0);
2082 cur_alt = &iface->altsetting[0];
2085 /* Drop all the endpoints in the current alt setting */
2086 for (i = 0; i < cur_alt->desc.bNumEndpoints; i++) {
2087 ret = hcd->driver->drop_endpoint(hcd, udev,
2088 &cur_alt->endpoint[i]);
2092 /* Add all the endpoints in the new alt setting */
2093 for (i = 0; i < new_alt->desc.bNumEndpoints; i++) {
2094 ret = hcd->driver->add_endpoint(hcd, udev,
2095 &new_alt->endpoint[i]);
2100 ret = hcd->driver->check_bandwidth(hcd, udev);
2103 hcd->driver->reset_bandwidth(hcd, udev);
2107 /* Disables the endpoint: synchronizes with the hcd to make sure all
2108 * endpoint state is gone from hardware. usb_hcd_flush_endpoint() must
2109 * have been called previously. Use for set_configuration, set_interface,
2110 * driver removal, physical disconnect.
2112 * example: a qh stored in ep->hcpriv, holding state related to endpoint
2113 * type, maxpacket size, toggle, halt status, and scheduling.
2115 void usb_hcd_disable_endpoint(struct usb_device *udev,
2116 struct usb_host_endpoint *ep)
2118 struct usb_hcd *hcd;
2121 hcd = bus_to_hcd(udev->bus);
2122 if (hcd->driver->endpoint_disable)
2123 hcd->driver->endpoint_disable(hcd, ep);
2127 * usb_hcd_reset_endpoint - reset host endpoint state
2128 * @udev: USB device.
2129 * @ep: the endpoint to reset.
2131 * Resets any host endpoint state such as the toggle bit, sequence
2132 * number and current window.
2134 void usb_hcd_reset_endpoint(struct usb_device *udev,
2135 struct usb_host_endpoint *ep)
2137 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2139 if (hcd->driver->endpoint_reset)
2140 hcd->driver->endpoint_reset(hcd, ep);
2142 int epnum = usb_endpoint_num(&ep->desc);
2143 int is_out = usb_endpoint_dir_out(&ep->desc);
2144 int is_control = usb_endpoint_xfer_control(&ep->desc);
2146 usb_settoggle(udev, epnum, is_out, 0);
2148 usb_settoggle(udev, epnum, !is_out, 0);
2153 * usb_alloc_streams - allocate bulk endpoint stream IDs.
2154 * @interface: alternate setting that includes all endpoints.
2155 * @eps: array of endpoints that need streams.
2156 * @num_eps: number of endpoints in the array.
2157 * @num_streams: number of streams to allocate.
2158 * @mem_flags: flags hcd should use to allocate memory.
2160 * Sets up a group of bulk endpoints to have @num_streams stream IDs available.
2161 * Drivers may queue multiple transfers to different stream IDs, which may
2162 * complete in a different order than they were queued.
2164 * Return: On success, the number of allocated streams. On failure, a negative
2167 int usb_alloc_streams(struct usb_interface *interface,
2168 struct usb_host_endpoint **eps, unsigned int num_eps,
2169 unsigned int num_streams, gfp_t mem_flags)
2171 struct usb_hcd *hcd;
2172 struct usb_device *dev;
2175 dev = interface_to_usbdev(interface);
2176 hcd = bus_to_hcd(dev->bus);
2177 if (!hcd->driver->alloc_streams || !hcd->driver->free_streams)
2179 if (dev->speed < USB_SPEED_SUPER)
2181 if (dev->state < USB_STATE_CONFIGURED)
2184 for (i = 0; i < num_eps; i++) {
2185 /* Streams only apply to bulk endpoints. */
2186 if (!usb_endpoint_xfer_bulk(&eps[i]->desc))
2188 /* Re-alloc is not allowed */
2189 if (eps[i]->streams)
2193 ret = hcd->driver->alloc_streams(hcd, dev, eps, num_eps,
2194 num_streams, mem_flags);
2198 for (i = 0; i < num_eps; i++)
2199 eps[i]->streams = ret;
2203 EXPORT_SYMBOL_GPL(usb_alloc_streams);
2206 * usb_free_streams - free bulk endpoint stream IDs.
2207 * @interface: alternate setting that includes all endpoints.
2208 * @eps: array of endpoints to remove streams from.
2209 * @num_eps: number of endpoints in the array.
2210 * @mem_flags: flags hcd should use to allocate memory.
2212 * Reverts a group of bulk endpoints back to not using stream IDs.
2213 * Can fail if we are given bad arguments, or HCD is broken.
2215 * Return: 0 on success. On failure, a negative error code.
2217 int usb_free_streams(struct usb_interface *interface,
2218 struct usb_host_endpoint **eps, unsigned int num_eps,
2221 struct usb_hcd *hcd;
2222 struct usb_device *dev;
2225 dev = interface_to_usbdev(interface);
2226 hcd = bus_to_hcd(dev->bus);
2227 if (dev->speed < USB_SPEED_SUPER)
2230 /* Double-free is not allowed */
2231 for (i = 0; i < num_eps; i++)
2232 if (!eps[i] || !eps[i]->streams)
2235 ret = hcd->driver->free_streams(hcd, dev, eps, num_eps, mem_flags);
2239 for (i = 0; i < num_eps; i++)
2240 eps[i]->streams = 0;
2244 EXPORT_SYMBOL_GPL(usb_free_streams);
2246 /* Protect against drivers that try to unlink URBs after the device
2247 * is gone, by waiting until all unlinks for @udev are finished.
2248 * Since we don't currently track URBs by device, simply wait until
2249 * nothing is running in the locked region of usb_hcd_unlink_urb().
2251 void usb_hcd_synchronize_unlinks(struct usb_device *udev)
2253 spin_lock_irq(&hcd_urb_unlink_lock);
2254 spin_unlock_irq(&hcd_urb_unlink_lock);
2257 /*-------------------------------------------------------------------------*/
2259 /* called in any context */
2260 int usb_hcd_get_frame_number (struct usb_device *udev)
2262 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2264 if (!HCD_RH_RUNNING(hcd))
2266 return hcd->driver->get_frame_number (hcd);
2269 /*-------------------------------------------------------------------------*/
2273 int hcd_bus_suspend(struct usb_device *rhdev, pm_message_t msg)
2275 struct usb_hcd *hcd = bus_to_hcd(rhdev->bus);
2277 int old_state = hcd->state;
2279 dev_dbg(&rhdev->dev, "bus %ssuspend, wakeup %d\n",
2280 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
2281 rhdev->do_remote_wakeup);
2282 if (HCD_DEAD(hcd)) {
2283 dev_dbg(&rhdev->dev, "skipped %s of dead bus\n", "suspend");
2287 if (!hcd->driver->bus_suspend) {
2290 clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2291 hcd->state = HC_STATE_QUIESCING;
2292 status = hcd->driver->bus_suspend(hcd);
2295 usb_set_device_state(rhdev, USB_STATE_SUSPENDED);
2296 hcd->state = HC_STATE_SUSPENDED;
2298 /* Did we race with a root-hub wakeup event? */
2299 if (rhdev->do_remote_wakeup) {
2302 status = hcd->driver->hub_status_data(hcd, buffer);
2304 dev_dbg(&rhdev->dev, "suspend raced with wakeup event\n");
2305 hcd_bus_resume(rhdev, PMSG_AUTO_RESUME);
2310 spin_lock_irq(&hcd_root_hub_lock);
2311 if (!HCD_DEAD(hcd)) {
2312 set_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2313 hcd->state = old_state;
2315 spin_unlock_irq(&hcd_root_hub_lock);
2316 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
2322 int hcd_bus_resume(struct usb_device *rhdev, pm_message_t msg)
2324 struct usb_hcd *hcd = bus_to_hcd(rhdev->bus);
2326 int old_state = hcd->state;
2328 dev_dbg(&rhdev->dev, "usb %sresume\n",
2329 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
2330 if (HCD_DEAD(hcd)) {
2331 dev_dbg(&rhdev->dev, "skipped %s of dead bus\n", "resume");
2334 if (!hcd->driver->bus_resume)
2336 if (HCD_RH_RUNNING(hcd))
2339 hcd->state = HC_STATE_RESUMING;
2340 status = hcd->driver->bus_resume(hcd);
2341 clear_bit(HCD_FLAG_WAKEUP_PENDING, &hcd->flags);
2343 struct usb_device *udev;
2346 spin_lock_irq(&hcd_root_hub_lock);
2347 if (!HCD_DEAD(hcd)) {
2348 usb_set_device_state(rhdev, rhdev->actconfig
2349 ? USB_STATE_CONFIGURED
2350 : USB_STATE_ADDRESS);
2351 set_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2352 hcd->state = HC_STATE_RUNNING;
2354 spin_unlock_irq(&hcd_root_hub_lock);
2357 * Check whether any of the enabled ports on the root hub are
2358 * unsuspended. If they are then a TRSMRCY delay is needed
2359 * (this is what the USB-2 spec calls a "global resume").
2360 * Otherwise we can skip the delay.
2362 usb_hub_for_each_child(rhdev, port1, udev) {
2363 if (udev->state != USB_STATE_NOTATTACHED &&
2364 !udev->port_is_suspended) {
2365 usleep_range(10000, 11000); /* TRSMRCY */
2370 hcd->state = old_state;
2371 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
2373 if (status != -ESHUTDOWN)
2379 /* Workqueue routine for root-hub remote wakeup */
2380 static void hcd_resume_work(struct work_struct *work)
2382 struct usb_hcd *hcd = container_of(work, struct usb_hcd, wakeup_work);
2383 struct usb_device *udev = hcd->self.root_hub;
2385 usb_remote_wakeup(udev);
2389 * usb_hcd_resume_root_hub - called by HCD to resume its root hub
2390 * @hcd: host controller for this root hub
2392 * The USB host controller calls this function when its root hub is
2393 * suspended (with the remote wakeup feature enabled) and a remote
2394 * wakeup request is received. The routine submits a workqueue request
2395 * to resume the root hub (that is, manage its downstream ports again).
2397 void usb_hcd_resume_root_hub (struct usb_hcd *hcd)
2399 unsigned long flags;
2401 spin_lock_irqsave (&hcd_root_hub_lock, flags);
2402 if (hcd->rh_registered) {
2403 pm_wakeup_event(&hcd->self.root_hub->dev, 0);
2404 set_bit(HCD_FLAG_WAKEUP_PENDING, &hcd->flags);
2405 queue_work(pm_wq, &hcd->wakeup_work);
2407 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
2409 EXPORT_SYMBOL_GPL(usb_hcd_resume_root_hub);
2411 #endif /* CONFIG_PM */
2413 /*-------------------------------------------------------------------------*/
2415 #ifdef CONFIG_USB_OTG
2418 * usb_bus_start_enum - start immediate enumeration (for OTG)
2419 * @bus: the bus (must use hcd framework)
2420 * @port_num: 1-based number of port; usually bus->otg_port
2421 * Context: in_interrupt()
2423 * Starts enumeration, with an immediate reset followed later by
2424 * hub_wq identifying and possibly configuring the device.
2425 * This is needed by OTG controller drivers, where it helps meet
2426 * HNP protocol timing requirements for starting a port reset.
2428 * Return: 0 if successful.
2430 int usb_bus_start_enum(struct usb_bus *bus, unsigned port_num)
2432 struct usb_hcd *hcd;
2433 int status = -EOPNOTSUPP;
2435 /* NOTE: since HNP can't start by grabbing the bus's address0_sem,
2436 * boards with root hubs hooked up to internal devices (instead of
2437 * just the OTG port) may need more attention to resetting...
2439 hcd = bus_to_hcd(bus);
2440 if (port_num && hcd->driver->start_port_reset)
2441 status = hcd->driver->start_port_reset(hcd, port_num);
2443 /* allocate hub_wq shortly after (first) root port reset finishes;
2444 * it may issue others, until at least 50 msecs have passed.
2447 mod_timer(&hcd->rh_timer, jiffies + msecs_to_jiffies(10));
2450 EXPORT_SYMBOL_GPL(usb_bus_start_enum);
2454 /*-------------------------------------------------------------------------*/
2457 * usb_hcd_irq - hook IRQs to HCD framework (bus glue)
2458 * @irq: the IRQ being raised
2459 * @__hcd: pointer to the HCD whose IRQ is being signaled
2461 * If the controller isn't HALTed, calls the driver's irq handler.
2462 * Checks whether the controller is now dead.
2464 * Return: %IRQ_HANDLED if the IRQ was handled. %IRQ_NONE otherwise.
2466 irqreturn_t usb_hcd_irq (int irq, void *__hcd)
2468 struct usb_hcd *hcd = __hcd;
2471 if (unlikely(HCD_DEAD(hcd) || !HCD_HW_ACCESSIBLE(hcd)))
2473 else if (hcd->driver->irq(hcd) == IRQ_NONE)
2480 EXPORT_SYMBOL_GPL(usb_hcd_irq);
2482 /*-------------------------------------------------------------------------*/
2485 * usb_hc_died - report abnormal shutdown of a host controller (bus glue)
2486 * @hcd: pointer to the HCD representing the controller
2488 * This is called by bus glue to report a USB host controller that died
2489 * while operations may still have been pending. It's called automatically
2490 * by the PCI glue, so only glue for non-PCI busses should need to call it.
2492 * Only call this function with the primary HCD.
2494 void usb_hc_died (struct usb_hcd *hcd)
2496 unsigned long flags;
2498 dev_err (hcd->self.controller, "HC died; cleaning up\n");
2500 spin_lock_irqsave (&hcd_root_hub_lock, flags);
2501 clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2502 set_bit(HCD_FLAG_DEAD, &hcd->flags);
2503 if (hcd->rh_registered) {
2504 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2506 /* make hub_wq clean up old urbs and devices */
2507 usb_set_device_state (hcd->self.root_hub,
2508 USB_STATE_NOTATTACHED);
2509 usb_kick_hub_wq(hcd->self.root_hub);
2511 if (usb_hcd_is_primary_hcd(hcd) && hcd->shared_hcd) {
2512 hcd = hcd->shared_hcd;
2513 clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2514 set_bit(HCD_FLAG_DEAD, &hcd->flags);
2515 if (hcd->rh_registered) {
2516 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2518 /* make hub_wq clean up old urbs and devices */
2519 usb_set_device_state(hcd->self.root_hub,
2520 USB_STATE_NOTATTACHED);
2521 usb_kick_hub_wq(hcd->self.root_hub);
2524 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
2525 /* Make sure that the other roothub is also deallocated. */
2527 EXPORT_SYMBOL_GPL (usb_hc_died);
2529 /*-------------------------------------------------------------------------*/
2531 static void init_giveback_urb_bh(struct giveback_urb_bh *bh)
2534 spin_lock_init(&bh->lock);
2535 INIT_LIST_HEAD(&bh->head);
2536 tasklet_init(&bh->bh, usb_giveback_urb_bh, (unsigned long)bh);
2539 struct usb_hcd *__usb_create_hcd(const struct hc_driver *driver,
2540 struct device *sysdev, struct device *dev, const char *bus_name,
2541 struct usb_hcd *primary_hcd)
2543 struct usb_hcd *hcd;
2545 hcd = kzalloc(sizeof(*hcd) + driver->hcd_priv_size, GFP_KERNEL);
2548 if (primary_hcd == NULL) {
2549 hcd->address0_mutex = kmalloc(sizeof(*hcd->address0_mutex),
2551 if (!hcd->address0_mutex) {
2553 dev_dbg(dev, "hcd address0 mutex alloc failed\n");
2556 mutex_init(hcd->address0_mutex);
2557 hcd->bandwidth_mutex = kmalloc(sizeof(*hcd->bandwidth_mutex),
2559 if (!hcd->bandwidth_mutex) {
2560 kfree(hcd->address0_mutex);
2562 dev_dbg(dev, "hcd bandwidth mutex alloc failed\n");
2565 mutex_init(hcd->bandwidth_mutex);
2566 dev_set_drvdata(dev, hcd);
2568 mutex_lock(&usb_port_peer_mutex);
2569 hcd->address0_mutex = primary_hcd->address0_mutex;
2570 hcd->bandwidth_mutex = primary_hcd->bandwidth_mutex;
2571 hcd->primary_hcd = primary_hcd;
2572 primary_hcd->primary_hcd = primary_hcd;
2573 hcd->shared_hcd = primary_hcd;
2574 primary_hcd->shared_hcd = hcd;
2575 mutex_unlock(&usb_port_peer_mutex);
2578 kref_init(&hcd->kref);
2580 usb_bus_init(&hcd->self);
2581 hcd->self.controller = dev;
2582 hcd->self.sysdev = sysdev;
2583 hcd->self.bus_name = bus_name;
2584 hcd->self.uses_dma = (sysdev->dma_mask != NULL);
2586 init_timer(&hcd->rh_timer);
2587 hcd->rh_timer.function = rh_timer_func;
2588 hcd->rh_timer.data = (unsigned long) hcd;
2590 INIT_WORK(&hcd->wakeup_work, hcd_resume_work);
2593 hcd->driver = driver;
2594 hcd->speed = driver->flags & HCD_MASK;
2595 hcd->product_desc = (driver->product_desc) ? driver->product_desc :
2596 "USB Host Controller";
2599 EXPORT_SYMBOL_GPL(__usb_create_hcd);
2602 * usb_create_shared_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 * @primary_hcd: a pointer to the usb_hcd structure that is sharing the
2607 * PCI device. Only allocate certain resources for the primary HCD
2608 * Context: !in_interrupt()
2610 * Allocate a struct usb_hcd, with extra space at the end for the
2611 * HC driver's private data. Initialize the generic members of the
2614 * Return: On success, a pointer to the created and initialized HCD structure.
2615 * On failure (e.g. if memory is unavailable), %NULL.
2617 struct usb_hcd *usb_create_shared_hcd(const struct hc_driver *driver,
2618 struct device *dev, const char *bus_name,
2619 struct usb_hcd *primary_hcd)
2621 return __usb_create_hcd(driver, dev, dev, bus_name, primary_hcd);
2623 EXPORT_SYMBOL_GPL(usb_create_shared_hcd);
2626 * usb_create_hcd - create and initialize an HCD structure
2627 * @driver: HC driver that will use this hcd
2628 * @dev: device for this HC, stored in hcd->self.controller
2629 * @bus_name: value to store in hcd->self.bus_name
2630 * Context: !in_interrupt()
2632 * Allocate a struct usb_hcd, with extra space at the end for the
2633 * HC driver's private data. Initialize the generic members of the
2636 * Return: On success, a pointer to the created and initialized HCD
2637 * structure. On failure (e.g. if memory is unavailable), %NULL.
2639 struct usb_hcd *usb_create_hcd(const struct hc_driver *driver,
2640 struct device *dev, const char *bus_name)
2642 return __usb_create_hcd(driver, dev, dev, bus_name, NULL);
2644 EXPORT_SYMBOL_GPL(usb_create_hcd);
2647 * Roothubs that share one PCI device must also share the bandwidth mutex.
2648 * Don't deallocate the bandwidth_mutex until the last shared usb_hcd is
2651 * Make sure to deallocate the bandwidth_mutex only when the last HCD is
2652 * freed. When hcd_release() is called for either hcd in a peer set,
2653 * invalidate the peer's ->shared_hcd and ->primary_hcd pointers.
2655 static void hcd_release(struct kref *kref)
2657 struct usb_hcd *hcd = container_of (kref, struct usb_hcd, kref);
2659 mutex_lock(&usb_port_peer_mutex);
2660 if (hcd->shared_hcd) {
2661 struct usb_hcd *peer = hcd->shared_hcd;
2663 peer->shared_hcd = NULL;
2664 peer->primary_hcd = NULL;
2666 kfree(hcd->address0_mutex);
2667 kfree(hcd->bandwidth_mutex);
2669 mutex_unlock(&usb_port_peer_mutex);
2673 struct usb_hcd *usb_get_hcd (struct usb_hcd *hcd)
2676 kref_get (&hcd->kref);
2679 EXPORT_SYMBOL_GPL(usb_get_hcd);
2681 void usb_put_hcd (struct usb_hcd *hcd)
2684 kref_put (&hcd->kref, hcd_release);
2686 EXPORT_SYMBOL_GPL(usb_put_hcd);
2688 int usb_hcd_is_primary_hcd(struct usb_hcd *hcd)
2690 if (!hcd->primary_hcd)
2692 return hcd == hcd->primary_hcd;
2694 EXPORT_SYMBOL_GPL(usb_hcd_is_primary_hcd);
2696 int usb_hcd_find_raw_port_number(struct usb_hcd *hcd, int port1)
2698 if (!hcd->driver->find_raw_port_number)
2701 return hcd->driver->find_raw_port_number(hcd, port1);
2704 static int usb_hcd_request_irqs(struct usb_hcd *hcd,
2705 unsigned int irqnum, unsigned long irqflags)
2709 if (hcd->driver->irq) {
2711 snprintf(hcd->irq_descr, sizeof(hcd->irq_descr), "%s:usb%d",
2712 hcd->driver->description, hcd->self.busnum);
2713 retval = request_irq(irqnum, &usb_hcd_irq, irqflags,
2714 hcd->irq_descr, hcd);
2716 dev_err(hcd->self.controller,
2717 "request interrupt %d failed\n",
2722 dev_info(hcd->self.controller, "irq %d, %s 0x%08llx\n", irqnum,
2723 (hcd->driver->flags & HCD_MEMORY) ?
2724 "io mem" : "io base",
2725 (unsigned long long)hcd->rsrc_start);
2728 if (hcd->rsrc_start)
2729 dev_info(hcd->self.controller, "%s 0x%08llx\n",
2730 (hcd->driver->flags & HCD_MEMORY) ?
2731 "io mem" : "io base",
2732 (unsigned long long)hcd->rsrc_start);
2738 * Before we free this root hub, flush in-flight peering attempts
2739 * and disable peer lookups
2741 static void usb_put_invalidate_rhdev(struct usb_hcd *hcd)
2743 struct usb_device *rhdev;
2745 mutex_lock(&usb_port_peer_mutex);
2746 rhdev = hcd->self.root_hub;
2747 hcd->self.root_hub = NULL;
2748 mutex_unlock(&usb_port_peer_mutex);
2753 * usb_add_hcd - finish generic HCD structure initialization and register
2754 * @hcd: the usb_hcd structure to initialize
2755 * @irqnum: Interrupt line to allocate
2756 * @irqflags: Interrupt type flags
2758 * Finish the remaining parts of generic HCD initialization: allocate the
2759 * buffers of consistent memory, register the bus, request the IRQ line,
2760 * and call the driver's reset() and start() routines.
2762 int usb_add_hcd(struct usb_hcd *hcd,
2763 unsigned int irqnum, unsigned long irqflags)
2766 struct usb_device *rhdev;
2768 if (IS_ENABLED(CONFIG_USB_PHY) && !hcd->usb_phy) {
2769 struct usb_phy *phy = usb_get_phy_dev(hcd->self.sysdev, 0);
2772 retval = PTR_ERR(phy);
2773 if (retval == -EPROBE_DEFER)
2776 retval = usb_phy_init(phy);
2782 hcd->remove_phy = 1;
2786 if (IS_ENABLED(CONFIG_GENERIC_PHY) && !hcd->phy) {
2787 struct phy *phy = phy_get(hcd->self.sysdev, "usb");
2790 retval = PTR_ERR(phy);
2791 if (retval == -EPROBE_DEFER)
2794 retval = phy_init(phy);
2799 retval = phy_power_on(phy);
2806 hcd->remove_phy = 1;
2810 dev_info(hcd->self.controller, "%s\n", hcd->product_desc);
2812 /* Keep old behaviour if authorized_default is not in [0, 1]. */
2813 if (authorized_default < 0 || authorized_default > 1) {
2815 clear_bit(HCD_FLAG_DEV_AUTHORIZED, &hcd->flags);
2817 set_bit(HCD_FLAG_DEV_AUTHORIZED, &hcd->flags);
2819 if (authorized_default)
2820 set_bit(HCD_FLAG_DEV_AUTHORIZED, &hcd->flags);
2822 clear_bit(HCD_FLAG_DEV_AUTHORIZED, &hcd->flags);
2824 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
2826 /* per default all interfaces are authorized */
2827 set_bit(HCD_FLAG_INTF_AUTHORIZED, &hcd->flags);
2829 /* HC is in reset state, but accessible. Now do the one-time init,
2830 * bottom up so that hcds can customize the root hubs before hub_wq
2831 * starts talking to them. (Note, bus id is assigned early too.)
2833 retval = hcd_buffer_create(hcd);
2835 dev_dbg(hcd->self.sysdev, "pool alloc failed\n");
2836 goto err_create_buf;
2839 retval = usb_register_bus(&hcd->self);
2841 goto err_register_bus;
2843 rhdev = usb_alloc_dev(NULL, &hcd->self, 0);
2844 if (rhdev == NULL) {
2845 dev_err(hcd->self.sysdev, "unable to allocate root hub\n");
2847 goto err_allocate_root_hub;
2849 mutex_lock(&usb_port_peer_mutex);
2850 hcd->self.root_hub = rhdev;
2851 mutex_unlock(&usb_port_peer_mutex);
2853 switch (hcd->speed) {
2855 rhdev->speed = USB_SPEED_FULL;
2858 rhdev->speed = USB_SPEED_HIGH;
2861 rhdev->speed = USB_SPEED_WIRELESS;
2864 rhdev->speed = USB_SPEED_SUPER;
2867 rhdev->speed = USB_SPEED_SUPER_PLUS;
2871 goto err_set_rh_speed;
2874 /* wakeup flag init defaults to "everything works" for root hubs,
2875 * but drivers can override it in reset() if needed, along with
2876 * recording the overall controller's system wakeup capability.
2878 device_set_wakeup_capable(&rhdev->dev, 1);
2880 /* HCD_FLAG_RH_RUNNING doesn't matter until the root hub is
2881 * registered. But since the controller can die at any time,
2882 * let's initialize the flag before touching the hardware.
2884 set_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2886 /* "reset" is misnamed; its role is now one-time init. the controller
2887 * should already have been reset (and boot firmware kicked off etc).
2889 if (hcd->driver->reset) {
2890 retval = hcd->driver->reset(hcd);
2892 dev_err(hcd->self.controller, "can't setup: %d\n",
2894 goto err_hcd_driver_setup;
2897 hcd->rh_pollable = 1;
2899 /* NOTE: root hub and controller capabilities may not be the same */
2900 if (device_can_wakeup(hcd->self.controller)
2901 && device_can_wakeup(&hcd->self.root_hub->dev))
2902 dev_dbg(hcd->self.controller, "supports USB remote wakeup\n");
2904 /* initialize tasklets */
2905 init_giveback_urb_bh(&hcd->high_prio_bh);
2906 hcd->high_prio_bh.high_prio = true;
2907 init_giveback_urb_bh(&hcd->low_prio_bh);
2909 /* enable irqs just before we start the controller,
2910 * if the BIOS provides legacy PCI irqs.
2912 if (usb_hcd_is_primary_hcd(hcd) && irqnum) {
2913 retval = usb_hcd_request_irqs(hcd, irqnum, irqflags);
2915 goto err_request_irq;
2918 hcd->state = HC_STATE_RUNNING;
2919 retval = hcd->driver->start(hcd);
2921 dev_err(hcd->self.controller, "startup error %d\n", retval);
2922 goto err_hcd_driver_start;
2925 /* starting here, usbcore will pay attention to this root hub */
2926 retval = register_root_hub(hcd);
2928 goto err_register_root_hub;
2930 retval = sysfs_create_group(&rhdev->dev.kobj, &usb_bus_attr_group);
2932 printk(KERN_ERR "Cannot register USB bus sysfs attributes: %d\n",
2934 goto error_create_attr_group;
2936 if (hcd->uses_new_polling && HCD_POLL_RH(hcd))
2937 usb_hcd_poll_rh_status(hcd);
2941 error_create_attr_group:
2942 clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2943 if (HC_IS_RUNNING(hcd->state))
2944 hcd->state = HC_STATE_QUIESCING;
2945 spin_lock_irq(&hcd_root_hub_lock);
2946 hcd->rh_registered = 0;
2947 spin_unlock_irq(&hcd_root_hub_lock);
2950 cancel_work_sync(&hcd->wakeup_work);
2952 mutex_lock(&usb_bus_idr_lock);
2953 usb_disconnect(&rhdev); /* Sets rhdev to NULL */
2954 mutex_unlock(&usb_bus_idr_lock);
2955 err_register_root_hub:
2956 hcd->rh_pollable = 0;
2957 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2958 del_timer_sync(&hcd->rh_timer);
2959 hcd->driver->stop(hcd);
2960 hcd->state = HC_STATE_HALT;
2961 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2962 del_timer_sync(&hcd->rh_timer);
2963 err_hcd_driver_start:
2964 if (usb_hcd_is_primary_hcd(hcd) && hcd->irq > 0)
2965 free_irq(irqnum, hcd);
2967 err_hcd_driver_setup:
2969 usb_put_invalidate_rhdev(hcd);
2970 err_allocate_root_hub:
2971 usb_deregister_bus(&hcd->self);
2973 hcd_buffer_destroy(hcd);
2975 if (IS_ENABLED(CONFIG_GENERIC_PHY) && hcd->remove_phy && hcd->phy) {
2976 phy_power_off(hcd->phy);
2982 if (hcd->remove_phy && hcd->usb_phy) {
2983 usb_phy_shutdown(hcd->usb_phy);
2984 usb_put_phy(hcd->usb_phy);
2985 hcd->usb_phy = NULL;
2989 EXPORT_SYMBOL_GPL(usb_add_hcd);
2992 * usb_remove_hcd - shutdown processing for generic HCDs
2993 * @hcd: the usb_hcd structure to remove
2994 * Context: !in_interrupt()
2996 * Disconnects the root hub, then reverses the effects of usb_add_hcd(),
2997 * invoking the HCD's stop() method.
2999 void usb_remove_hcd(struct usb_hcd *hcd)
3001 struct usb_device *rhdev = hcd->self.root_hub;
3003 dev_info(hcd->self.controller, "remove, state %x\n", hcd->state);
3006 sysfs_remove_group(&rhdev->dev.kobj, &usb_bus_attr_group);
3008 clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
3009 if (HC_IS_RUNNING (hcd->state))
3010 hcd->state = HC_STATE_QUIESCING;
3012 dev_dbg(hcd->self.controller, "roothub graceful disconnect\n");
3013 spin_lock_irq (&hcd_root_hub_lock);
3014 hcd->rh_registered = 0;
3015 spin_unlock_irq (&hcd_root_hub_lock);
3018 cancel_work_sync(&hcd->wakeup_work);
3021 mutex_lock(&usb_bus_idr_lock);
3022 usb_disconnect(&rhdev); /* Sets rhdev to NULL */
3023 mutex_unlock(&usb_bus_idr_lock);
3026 * tasklet_kill() isn't needed here because:
3027 * - driver's disconnect() called from usb_disconnect() should
3028 * make sure its URBs are completed during the disconnect()
3031 * - it is too late to run complete() here since driver may have
3032 * been removed already now
3035 /* Prevent any more root-hub status calls from the timer.
3036 * The HCD might still restart the timer (if a port status change
3037 * interrupt occurs), but usb_hcd_poll_rh_status() won't invoke
3038 * the hub_status_data() callback.
3040 hcd->rh_pollable = 0;
3041 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
3042 del_timer_sync(&hcd->rh_timer);
3044 hcd->driver->stop(hcd);
3045 hcd->state = HC_STATE_HALT;
3047 /* In case the HCD restarted the timer, stop it again. */
3048 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
3049 del_timer_sync(&hcd->rh_timer);
3051 if (usb_hcd_is_primary_hcd(hcd)) {
3053 free_irq(hcd->irq, hcd);
3056 usb_deregister_bus(&hcd->self);
3057 hcd_buffer_destroy(hcd);
3059 if (IS_ENABLED(CONFIG_GENERIC_PHY) && hcd->remove_phy && hcd->phy) {
3060 phy_power_off(hcd->phy);
3065 if (hcd->remove_phy && hcd->usb_phy) {
3066 usb_phy_shutdown(hcd->usb_phy);
3067 usb_put_phy(hcd->usb_phy);
3068 hcd->usb_phy = NULL;
3071 usb_put_invalidate_rhdev(hcd);
3074 EXPORT_SYMBOL_GPL(usb_remove_hcd);
3077 usb_hcd_platform_shutdown(struct platform_device *dev)
3079 struct usb_hcd *hcd = platform_get_drvdata(dev);
3081 /* No need for pm_runtime_put(), we're shutting down */
3082 pm_runtime_get_sync(&dev->dev);
3084 if (hcd->driver->shutdown)
3085 hcd->driver->shutdown(hcd);
3087 EXPORT_SYMBOL_GPL(usb_hcd_platform_shutdown);
3089 /*-------------------------------------------------------------------------*/
3091 #if IS_ENABLED(CONFIG_USB_MON)
3093 const struct usb_mon_operations *mon_ops;
3096 * The registration is unlocked.
3097 * We do it this way because we do not want to lock in hot paths.
3099 * Notice that the code is minimally error-proof. Because usbmon needs
3100 * symbols from usbcore, usbcore gets referenced and cannot be unloaded first.
3103 int usb_mon_register(const struct usb_mon_operations *ops)
3113 EXPORT_SYMBOL_GPL (usb_mon_register);
3115 void usb_mon_deregister (void)
3118 if (mon_ops == NULL) {
3119 printk(KERN_ERR "USB: monitor was not registered\n");
3125 EXPORT_SYMBOL_GPL (usb_mon_deregister);
3127 #endif /* CONFIG_USB_MON || CONFIG_USB_MON_MODULE */