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/slab.h>
30 #include <linux/completion.h>
31 #include <linux/utsname.h>
34 #include <linux/device.h>
35 #include <linux/dma-mapping.h>
36 #include <linux/mutex.h>
38 #include <asm/byteorder.h>
39 #include <asm/unaligned.h>
40 #include <linux/platform_device.h>
41 #include <linux/workqueue.h>
42 #include <linux/pm_runtime.h>
43 #include <linux/types.h>
45 #include <linux/phy/phy.h>
46 #include <linux/usb.h>
47 #include <linux/usb/hcd.h>
48 #include <linux/usb/phy.h>
49 #include <linux/usb/otg.h>
54 /*-------------------------------------------------------------------------*/
57 * USB Host Controller Driver framework
59 * Plugs into usbcore (usb_bus) and lets HCDs share code, minimizing
60 * HCD-specific behaviors/bugs.
62 * This does error checks, tracks devices and urbs, and delegates to a
63 * "hc_driver" only for code (and data) that really needs to know about
64 * hardware differences. That includes root hub registers, i/o queues,
65 * and so on ... but as little else as possible.
67 * Shared code includes most of the "root hub" code (these are emulated,
68 * though each HC's hardware works differently) and PCI glue, plus request
69 * tracking overhead. The HCD code should only block on spinlocks or on
70 * hardware handshaking; blocking on software events (such as other kernel
71 * threads releasing resources, or completing actions) is all generic.
73 * Happens the USB 2.0 spec says this would be invisible inside the "USBD",
74 * and includes mostly a "HCDI" (HCD Interface) along with some APIs used
75 * only by the hub driver ... and that neither should be seen or used by
76 * usb client device drivers.
78 * Contributors of ideas or unattributed patches include: David Brownell,
79 * Roman Weissgaerber, Rory Bolt, Greg Kroah-Hartman, ...
82 * 2002-02-21 Pull in most of the usb_bus support from usb.c; some
83 * associated cleanup. "usb_hcd" still != "usb_bus".
84 * 2001-12-12 Initial patch version for Linux 2.5.1 kernel.
87 /*-------------------------------------------------------------------------*/
89 /* Keep track of which host controller drivers are loaded */
90 unsigned long usb_hcds_loaded;
91 EXPORT_SYMBOL_GPL(usb_hcds_loaded);
93 /* host controllers we manage */
94 DEFINE_IDR (usb_bus_idr);
95 EXPORT_SYMBOL_GPL (usb_bus_idr);
97 /* used when allocating bus numbers */
100 /* used when updating list of hcds */
101 DEFINE_MUTEX(usb_bus_idr_lock); /* exported only for usbfs */
102 EXPORT_SYMBOL_GPL (usb_bus_idr_lock);
104 /* used for controlling access to virtual root hubs */
105 static DEFINE_SPINLOCK(hcd_root_hub_lock);
107 /* used when updating an endpoint's URB list */
108 static DEFINE_SPINLOCK(hcd_urb_list_lock);
110 /* used to protect against unlinking URBs after the device is gone */
111 static DEFINE_SPINLOCK(hcd_urb_unlink_lock);
113 /* wait queue for synchronous unlinks */
114 DECLARE_WAIT_QUEUE_HEAD(usb_kill_urb_queue);
116 static inline int is_root_hub(struct usb_device *udev)
118 return (udev->parent == NULL);
121 /*-------------------------------------------------------------------------*/
124 * Sharable chunks of root hub code.
127 /*-------------------------------------------------------------------------*/
128 #define KERNEL_REL bin2bcd(((LINUX_VERSION_CODE >> 16) & 0x0ff))
129 #define KERNEL_VER bin2bcd(((LINUX_VERSION_CODE >> 8) & 0x0ff))
131 /* usb 3.1 root hub device descriptor */
132 static const u8 usb31_rh_dev_descriptor[18] = {
133 0x12, /* __u8 bLength; */
134 USB_DT_DEVICE, /* __u8 bDescriptorType; Device */
135 0x10, 0x03, /* __le16 bcdUSB; v3.1 */
137 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
138 0x00, /* __u8 bDeviceSubClass; */
139 0x03, /* __u8 bDeviceProtocol; USB 3 hub */
140 0x09, /* __u8 bMaxPacketSize0; 2^9 = 512 Bytes */
142 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation 0x1d6b */
143 0x03, 0x00, /* __le16 idProduct; device 0x0003 */
144 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
146 0x03, /* __u8 iManufacturer; */
147 0x02, /* __u8 iProduct; */
148 0x01, /* __u8 iSerialNumber; */
149 0x01 /* __u8 bNumConfigurations; */
152 /* usb 3.0 root hub device descriptor */
153 static const u8 usb3_rh_dev_descriptor[18] = {
154 0x12, /* __u8 bLength; */
155 USB_DT_DEVICE, /* __u8 bDescriptorType; Device */
156 0x00, 0x03, /* __le16 bcdUSB; v3.0 */
158 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
159 0x00, /* __u8 bDeviceSubClass; */
160 0x03, /* __u8 bDeviceProtocol; USB 3.0 hub */
161 0x09, /* __u8 bMaxPacketSize0; 2^9 = 512 Bytes */
163 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation 0x1d6b */
164 0x03, 0x00, /* __le16 idProduct; device 0x0003 */
165 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
167 0x03, /* __u8 iManufacturer; */
168 0x02, /* __u8 iProduct; */
169 0x01, /* __u8 iSerialNumber; */
170 0x01 /* __u8 bNumConfigurations; */
173 /* usb 2.5 (wireless USB 1.0) root hub device descriptor */
174 static const u8 usb25_rh_dev_descriptor[18] = {
175 0x12, /* __u8 bLength; */
176 USB_DT_DEVICE, /* __u8 bDescriptorType; Device */
177 0x50, 0x02, /* __le16 bcdUSB; v2.5 */
179 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
180 0x00, /* __u8 bDeviceSubClass; */
181 0x00, /* __u8 bDeviceProtocol; [ usb 2.0 no TT ] */
182 0xFF, /* __u8 bMaxPacketSize0; always 0xFF (WUSB Spec 7.4.1). */
184 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation 0x1d6b */
185 0x02, 0x00, /* __le16 idProduct; device 0x0002 */
186 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
188 0x03, /* __u8 iManufacturer; */
189 0x02, /* __u8 iProduct; */
190 0x01, /* __u8 iSerialNumber; */
191 0x01 /* __u8 bNumConfigurations; */
194 /* usb 2.0 root hub device descriptor */
195 static const u8 usb2_rh_dev_descriptor[18] = {
196 0x12, /* __u8 bLength; */
197 USB_DT_DEVICE, /* __u8 bDescriptorType; Device */
198 0x00, 0x02, /* __le16 bcdUSB; v2.0 */
200 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
201 0x00, /* __u8 bDeviceSubClass; */
202 0x00, /* __u8 bDeviceProtocol; [ usb 2.0 no TT ] */
203 0x40, /* __u8 bMaxPacketSize0; 64 Bytes */
205 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation 0x1d6b */
206 0x02, 0x00, /* __le16 idProduct; device 0x0002 */
207 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
209 0x03, /* __u8 iManufacturer; */
210 0x02, /* __u8 iProduct; */
211 0x01, /* __u8 iSerialNumber; */
212 0x01 /* __u8 bNumConfigurations; */
215 /* no usb 2.0 root hub "device qualifier" descriptor: one speed only */
217 /* usb 1.1 root hub device descriptor */
218 static const u8 usb11_rh_dev_descriptor[18] = {
219 0x12, /* __u8 bLength; */
220 USB_DT_DEVICE, /* __u8 bDescriptorType; Device */
221 0x10, 0x01, /* __le16 bcdUSB; v1.1 */
223 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
224 0x00, /* __u8 bDeviceSubClass; */
225 0x00, /* __u8 bDeviceProtocol; [ low/full speeds only ] */
226 0x40, /* __u8 bMaxPacketSize0; 64 Bytes */
228 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation 0x1d6b */
229 0x01, 0x00, /* __le16 idProduct; device 0x0001 */
230 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
232 0x03, /* __u8 iManufacturer; */
233 0x02, /* __u8 iProduct; */
234 0x01, /* __u8 iSerialNumber; */
235 0x01 /* __u8 bNumConfigurations; */
239 /*-------------------------------------------------------------------------*/
241 /* Configuration descriptors for our root hubs */
243 static const u8 fs_rh_config_descriptor[] = {
245 /* one configuration */
246 0x09, /* __u8 bLength; */
247 USB_DT_CONFIG, /* __u8 bDescriptorType; Configuration */
248 0x19, 0x00, /* __le16 wTotalLength; */
249 0x01, /* __u8 bNumInterfaces; (1) */
250 0x01, /* __u8 bConfigurationValue; */
251 0x00, /* __u8 iConfiguration; */
252 0xc0, /* __u8 bmAttributes;
257 0x00, /* __u8 MaxPower; */
260 * USB 2.0, single TT organization (mandatory):
261 * one interface, protocol 0
263 * USB 2.0, multiple TT organization (optional):
264 * two interfaces, protocols 1 (like single TT)
265 * and 2 (multiple TT mode) ... config is
271 0x09, /* __u8 if_bLength; */
272 USB_DT_INTERFACE, /* __u8 if_bDescriptorType; Interface */
273 0x00, /* __u8 if_bInterfaceNumber; */
274 0x00, /* __u8 if_bAlternateSetting; */
275 0x01, /* __u8 if_bNumEndpoints; */
276 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
277 0x00, /* __u8 if_bInterfaceSubClass; */
278 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
279 0x00, /* __u8 if_iInterface; */
281 /* one endpoint (status change endpoint) */
282 0x07, /* __u8 ep_bLength; */
283 USB_DT_ENDPOINT, /* __u8 ep_bDescriptorType; Endpoint */
284 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
285 0x03, /* __u8 ep_bmAttributes; Interrupt */
286 0x02, 0x00, /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8) */
287 0xff /* __u8 ep_bInterval; (255ms -- usb 2.0 spec) */
290 static const u8 hs_rh_config_descriptor[] = {
292 /* one configuration */
293 0x09, /* __u8 bLength; */
294 USB_DT_CONFIG, /* __u8 bDescriptorType; Configuration */
295 0x19, 0x00, /* __le16 wTotalLength; */
296 0x01, /* __u8 bNumInterfaces; (1) */
297 0x01, /* __u8 bConfigurationValue; */
298 0x00, /* __u8 iConfiguration; */
299 0xc0, /* __u8 bmAttributes;
304 0x00, /* __u8 MaxPower; */
307 * USB 2.0, single TT organization (mandatory):
308 * one interface, protocol 0
310 * USB 2.0, multiple TT organization (optional):
311 * two interfaces, protocols 1 (like single TT)
312 * and 2 (multiple TT mode) ... config is
318 0x09, /* __u8 if_bLength; */
319 USB_DT_INTERFACE, /* __u8 if_bDescriptorType; Interface */
320 0x00, /* __u8 if_bInterfaceNumber; */
321 0x00, /* __u8 if_bAlternateSetting; */
322 0x01, /* __u8 if_bNumEndpoints; */
323 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
324 0x00, /* __u8 if_bInterfaceSubClass; */
325 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
326 0x00, /* __u8 if_iInterface; */
328 /* one endpoint (status change endpoint) */
329 0x07, /* __u8 ep_bLength; */
330 USB_DT_ENDPOINT, /* __u8 ep_bDescriptorType; Endpoint */
331 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
332 0x03, /* __u8 ep_bmAttributes; Interrupt */
333 /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8)
334 * see hub.c:hub_configure() for details. */
335 (USB_MAXCHILDREN + 1 + 7) / 8, 0x00,
336 0x0c /* __u8 ep_bInterval; (256ms -- usb 2.0 spec) */
339 static const u8 ss_rh_config_descriptor[] = {
340 /* one configuration */
341 0x09, /* __u8 bLength; */
342 USB_DT_CONFIG, /* __u8 bDescriptorType; Configuration */
343 0x1f, 0x00, /* __le16 wTotalLength; */
344 0x01, /* __u8 bNumInterfaces; (1) */
345 0x01, /* __u8 bConfigurationValue; */
346 0x00, /* __u8 iConfiguration; */
347 0xc0, /* __u8 bmAttributes;
352 0x00, /* __u8 MaxPower; */
355 0x09, /* __u8 if_bLength; */
356 USB_DT_INTERFACE, /* __u8 if_bDescriptorType; Interface */
357 0x00, /* __u8 if_bInterfaceNumber; */
358 0x00, /* __u8 if_bAlternateSetting; */
359 0x01, /* __u8 if_bNumEndpoints; */
360 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
361 0x00, /* __u8 if_bInterfaceSubClass; */
362 0x00, /* __u8 if_bInterfaceProtocol; */
363 0x00, /* __u8 if_iInterface; */
365 /* one endpoint (status change endpoint) */
366 0x07, /* __u8 ep_bLength; */
367 USB_DT_ENDPOINT, /* __u8 ep_bDescriptorType; Endpoint */
368 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
369 0x03, /* __u8 ep_bmAttributes; Interrupt */
370 /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8)
371 * see hub.c:hub_configure() for details. */
372 (USB_MAXCHILDREN + 1 + 7) / 8, 0x00,
373 0x0c, /* __u8 ep_bInterval; (256ms -- usb 2.0 spec) */
375 /* one SuperSpeed endpoint companion descriptor */
376 0x06, /* __u8 ss_bLength */
377 USB_DT_SS_ENDPOINT_COMP, /* __u8 ss_bDescriptorType; SuperSpeed EP */
379 0x00, /* __u8 ss_bMaxBurst; allows 1 TX between ACKs */
380 0x00, /* __u8 ss_bmAttributes; 1 packet per service interval */
381 0x02, 0x00 /* __le16 ss_wBytesPerInterval; 15 bits for max 15 ports */
384 /* authorized_default behaviour:
385 * -1 is authorized for all devices except wireless (old behaviour)
386 * 0 is unauthorized for all devices
387 * 1 is authorized for all devices
389 static int authorized_default = -1;
390 module_param(authorized_default, int, S_IRUGO|S_IWUSR);
391 MODULE_PARM_DESC(authorized_default,
392 "Default USB device authorization: 0 is not authorized, 1 is "
393 "authorized, -1 is authorized except for wireless USB (default, "
395 /*-------------------------------------------------------------------------*/
398 * ascii2desc() - Helper routine for producing UTF-16LE string descriptors
399 * @s: Null-terminated ASCII (actually ISO-8859-1) string
400 * @buf: Buffer for USB string descriptor (header + UTF-16LE)
401 * @len: Length (in bytes; may be odd) of descriptor buffer.
403 * Return: The number of bytes filled in: 2 + 2*strlen(s) or @len,
407 * USB String descriptors can contain at most 126 characters; input
408 * strings longer than that are truncated.
411 ascii2desc(char const *s, u8 *buf, unsigned len)
413 unsigned n, t = 2 + 2*strlen(s);
416 t = 254; /* Longest possible UTF string descriptor */
420 t += USB_DT_STRING << 8; /* Now t is first 16 bits to store */
428 t = (unsigned char)*s++;
434 * rh_string() - provides string descriptors for root hub
435 * @id: the string ID number (0: langids, 1: serial #, 2: product, 3: vendor)
436 * @hcd: the host controller for this root hub
437 * @data: buffer for output packet
438 * @len: length of the provided buffer
440 * Produces either a manufacturer, product or serial number string for the
441 * virtual root hub device.
443 * Return: The number of bytes filled in: the length of the descriptor or
444 * of the provided buffer, whichever is less.
447 rh_string(int id, struct usb_hcd const *hcd, u8 *data, unsigned len)
451 static char const langids[4] = {4, USB_DT_STRING, 0x09, 0x04};
456 /* Array of LANGID codes (0x0409 is MSFT-speak for "en-us") */
457 /* See http://www.usb.org/developers/docs/USB_LANGIDs.pdf */
460 memcpy(data, langids, len);
464 s = hcd->self.bus_name;
468 s = hcd->product_desc;
472 snprintf (buf, sizeof buf, "%s %s %s", init_utsname()->sysname,
473 init_utsname()->release, hcd->driver->description);
477 /* Can't happen; caller guarantees it */
481 return ascii2desc(s, data, len);
485 /* Root hub control transfers execute synchronously */
486 static int rh_call_control (struct usb_hcd *hcd, struct urb *urb)
488 struct usb_ctrlrequest *cmd;
489 u16 typeReq, wValue, wIndex, wLength;
490 u8 *ubuf = urb->transfer_buffer;
494 u8 patch_protocol = 0;
501 spin_lock_irq(&hcd_root_hub_lock);
502 status = usb_hcd_link_urb_to_ep(hcd, urb);
503 spin_unlock_irq(&hcd_root_hub_lock);
506 urb->hcpriv = hcd; /* Indicate it's queued */
508 cmd = (struct usb_ctrlrequest *) urb->setup_packet;
509 typeReq = (cmd->bRequestType << 8) | cmd->bRequest;
510 wValue = le16_to_cpu (cmd->wValue);
511 wIndex = le16_to_cpu (cmd->wIndex);
512 wLength = le16_to_cpu (cmd->wLength);
514 if (wLength > urb->transfer_buffer_length)
518 * tbuf should be at least as big as the
519 * USB hub descriptor.
521 tbuf_size = max_t(u16, sizeof(struct usb_hub_descriptor), wLength);
522 tbuf = kzalloc(tbuf_size, GFP_KERNEL);
531 urb->actual_length = 0;
534 /* DEVICE REQUESTS */
536 /* The root hub's remote wakeup enable bit is implemented using
537 * driver model wakeup flags. If this system supports wakeup
538 * through USB, userspace may change the default "allow wakeup"
539 * policy through sysfs or these calls.
541 * Most root hubs support wakeup from downstream devices, for
542 * runtime power management (disabling USB clocks and reducing
543 * VBUS power usage). However, not all of them do so; silicon,
544 * board, and BIOS bugs here are not uncommon, so these can't
545 * be treated quite like external hubs.
547 * Likewise, not all root hubs will pass wakeup events upstream,
548 * to wake up the whole system. So don't assume root hub and
549 * controller capabilities are identical.
552 case DeviceRequest | USB_REQ_GET_STATUS:
553 tbuf[0] = (device_may_wakeup(&hcd->self.root_hub->dev)
554 << USB_DEVICE_REMOTE_WAKEUP)
555 | (1 << USB_DEVICE_SELF_POWERED);
559 case DeviceOutRequest | USB_REQ_CLEAR_FEATURE:
560 if (wValue == USB_DEVICE_REMOTE_WAKEUP)
561 device_set_wakeup_enable(&hcd->self.root_hub->dev, 0);
565 case DeviceOutRequest | USB_REQ_SET_FEATURE:
566 if (device_can_wakeup(&hcd->self.root_hub->dev)
567 && wValue == USB_DEVICE_REMOTE_WAKEUP)
568 device_set_wakeup_enable(&hcd->self.root_hub->dev, 1);
572 case DeviceRequest | USB_REQ_GET_CONFIGURATION:
576 case DeviceOutRequest | USB_REQ_SET_CONFIGURATION:
578 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
579 switch (wValue & 0xff00) {
580 case USB_DT_DEVICE << 8:
581 switch (hcd->speed) {
583 bufp = usb31_rh_dev_descriptor;
586 bufp = usb3_rh_dev_descriptor;
589 bufp = usb25_rh_dev_descriptor;
592 bufp = usb2_rh_dev_descriptor;
595 bufp = usb11_rh_dev_descriptor;
604 case USB_DT_CONFIG << 8:
605 switch (hcd->speed) {
608 bufp = ss_rh_config_descriptor;
609 len = sizeof ss_rh_config_descriptor;
613 bufp = hs_rh_config_descriptor;
614 len = sizeof hs_rh_config_descriptor;
617 bufp = fs_rh_config_descriptor;
618 len = sizeof fs_rh_config_descriptor;
623 if (device_can_wakeup(&hcd->self.root_hub->dev))
626 case USB_DT_STRING << 8:
627 if ((wValue & 0xff) < 4)
628 urb->actual_length = rh_string(wValue & 0xff,
630 else /* unsupported IDs --> "protocol stall" */
633 case USB_DT_BOS << 8:
639 case DeviceRequest | USB_REQ_GET_INTERFACE:
643 case DeviceOutRequest | USB_REQ_SET_INTERFACE:
645 case DeviceOutRequest | USB_REQ_SET_ADDRESS:
646 /* wValue == urb->dev->devaddr */
647 dev_dbg (hcd->self.controller, "root hub device address %d\n",
651 /* INTERFACE REQUESTS (no defined feature/status flags) */
653 /* ENDPOINT REQUESTS */
655 case EndpointRequest | USB_REQ_GET_STATUS:
656 /* ENDPOINT_HALT flag */
661 case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
662 case EndpointOutRequest | USB_REQ_SET_FEATURE:
663 dev_dbg (hcd->self.controller, "no endpoint features yet\n");
666 /* CLASS REQUESTS (and errors) */
670 /* non-generic request */
676 if (wValue == HUB_PORT_STATUS)
679 /* other port status types return 8 bytes */
682 case GetHubDescriptor:
683 len = sizeof (struct usb_hub_descriptor);
685 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
686 /* len is returned by hub_control */
689 status = hcd->driver->hub_control (hcd,
690 typeReq, wValue, wIndex,
693 if (typeReq == GetHubDescriptor)
694 usb_hub_adjust_deviceremovable(hcd->self.root_hub,
695 (struct usb_hub_descriptor *)tbuf);
698 /* "protocol stall" on error */
704 if (status != -EPIPE) {
705 dev_dbg (hcd->self.controller,
706 "CTRL: TypeReq=0x%x val=0x%x "
707 "idx=0x%x len=%d ==> %d\n",
708 typeReq, wValue, wIndex,
711 } else if (status > 0) {
712 /* hub_control may return the length of data copied. */
717 if (urb->transfer_buffer_length < len)
718 len = urb->transfer_buffer_length;
719 urb->actual_length = len;
720 /* always USB_DIR_IN, toward host */
721 memcpy (ubuf, bufp, len);
723 /* report whether RH hardware supports remote wakeup */
725 len > offsetof (struct usb_config_descriptor,
727 ((struct usb_config_descriptor *)ubuf)->bmAttributes
728 |= USB_CONFIG_ATT_WAKEUP;
730 /* report whether RH hardware has an integrated TT */
731 if (patch_protocol &&
732 len > offsetof(struct usb_device_descriptor,
734 ((struct usb_device_descriptor *) ubuf)->
735 bDeviceProtocol = USB_HUB_PR_HS_SINGLE_TT;
741 /* any errors get returned through the urb completion */
742 spin_lock_irq(&hcd_root_hub_lock);
743 usb_hcd_unlink_urb_from_ep(hcd, urb);
744 usb_hcd_giveback_urb(hcd, urb, status);
745 spin_unlock_irq(&hcd_root_hub_lock);
749 /*-------------------------------------------------------------------------*/
752 * Root Hub interrupt transfers are polled using a timer if the
753 * driver requests it; otherwise the driver is responsible for
754 * calling usb_hcd_poll_rh_status() when an event occurs.
756 * Completions are called in_interrupt(), but they may or may not
759 void usb_hcd_poll_rh_status(struct usb_hcd *hcd)
765 char buffer[6]; /* Any root hubs with > 31 ports? */
767 if (unlikely(!hcd->rh_pollable))
769 if (!hcd->uses_new_polling && !hcd->status_urb)
772 length = hcd->driver->hub_status_data(hcd, buffer);
775 /* try to complete the status urb */
776 spin_lock_irqsave(&hcd_root_hub_lock, flags);
777 urb = hcd->status_urb;
779 clear_bit(HCD_FLAG_POLL_PENDING, &hcd->flags);
780 hcd->status_urb = NULL;
781 if (urb->transfer_buffer_length >= length) {
785 length = urb->transfer_buffer_length;
787 urb->actual_length = length;
788 memcpy(urb->transfer_buffer, buffer, length);
790 usb_hcd_unlink_urb_from_ep(hcd, urb);
791 usb_hcd_giveback_urb(hcd, urb, status);
794 set_bit(HCD_FLAG_POLL_PENDING, &hcd->flags);
796 spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
799 /* The USB 2.0 spec says 256 ms. This is close enough and won't
800 * exceed that limit if HZ is 100. The math is more clunky than
801 * maybe expected, this is to make sure that all timers for USB devices
802 * fire at the same time to give the CPU a break in between */
803 if (hcd->uses_new_polling ? HCD_POLL_RH(hcd) :
804 (length == 0 && hcd->status_urb != NULL))
805 mod_timer (&hcd->rh_timer, (jiffies/(HZ/4) + 1) * (HZ/4));
807 EXPORT_SYMBOL_GPL(usb_hcd_poll_rh_status);
810 static void rh_timer_func (unsigned long _hcd)
812 usb_hcd_poll_rh_status((struct usb_hcd *) _hcd);
815 /*-------------------------------------------------------------------------*/
817 static int rh_queue_status (struct usb_hcd *hcd, struct urb *urb)
821 unsigned len = 1 + (urb->dev->maxchild / 8);
823 spin_lock_irqsave (&hcd_root_hub_lock, flags);
824 if (hcd->status_urb || urb->transfer_buffer_length < len) {
825 dev_dbg (hcd->self.controller, "not queuing rh status urb\n");
830 retval = usb_hcd_link_urb_to_ep(hcd, urb);
834 hcd->status_urb = urb;
835 urb->hcpriv = hcd; /* indicate it's queued */
836 if (!hcd->uses_new_polling)
837 mod_timer(&hcd->rh_timer, (jiffies/(HZ/4) + 1) * (HZ/4));
839 /* If a status change has already occurred, report it ASAP */
840 else if (HCD_POLL_PENDING(hcd))
841 mod_timer(&hcd->rh_timer, jiffies);
844 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
848 static int rh_urb_enqueue (struct usb_hcd *hcd, struct urb *urb)
850 if (usb_endpoint_xfer_int(&urb->ep->desc))
851 return rh_queue_status (hcd, urb);
852 if (usb_endpoint_xfer_control(&urb->ep->desc))
853 return rh_call_control (hcd, urb);
857 /*-------------------------------------------------------------------------*/
859 /* Unlinks of root-hub control URBs are legal, but they don't do anything
860 * since these URBs always execute synchronously.
862 static int usb_rh_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
867 spin_lock_irqsave(&hcd_root_hub_lock, flags);
868 rc = usb_hcd_check_unlink_urb(hcd, urb, status);
872 if (usb_endpoint_num(&urb->ep->desc) == 0) { /* Control URB */
875 } else { /* Status URB */
876 if (!hcd->uses_new_polling)
877 del_timer (&hcd->rh_timer);
878 if (urb == hcd->status_urb) {
879 hcd->status_urb = NULL;
880 usb_hcd_unlink_urb_from_ep(hcd, urb);
881 usb_hcd_giveback_urb(hcd, urb, status);
885 spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
892 * Show & store the current value of authorized_default
894 static ssize_t authorized_default_show(struct device *dev,
895 struct device_attribute *attr, char *buf)
897 struct usb_device *rh_usb_dev = to_usb_device(dev);
898 struct usb_bus *usb_bus = rh_usb_dev->bus;
901 hcd = bus_to_hcd(usb_bus);
902 return snprintf(buf, PAGE_SIZE, "%u\n", !!HCD_DEV_AUTHORIZED(hcd));
905 static ssize_t authorized_default_store(struct device *dev,
906 struct device_attribute *attr,
907 const char *buf, size_t size)
911 struct usb_device *rh_usb_dev = to_usb_device(dev);
912 struct usb_bus *usb_bus = rh_usb_dev->bus;
915 hcd = bus_to_hcd(usb_bus);
916 result = sscanf(buf, "%u\n", &val);
919 set_bit(HCD_FLAG_DEV_AUTHORIZED, &hcd->flags);
921 clear_bit(HCD_FLAG_DEV_AUTHORIZED, &hcd->flags);
929 static DEVICE_ATTR_RW(authorized_default);
932 * interface_authorized_default_show - show default authorization status
935 * note: interface_authorized_default is the default value
936 * for initializing the authorized attribute of interfaces
938 static ssize_t interface_authorized_default_show(struct device *dev,
939 struct device_attribute *attr, char *buf)
941 struct usb_device *usb_dev = to_usb_device(dev);
942 struct usb_hcd *hcd = bus_to_hcd(usb_dev->bus);
944 return sprintf(buf, "%u\n", !!HCD_INTF_AUTHORIZED(hcd));
948 * interface_authorized_default_store - store default authorization status
951 * note: interface_authorized_default is the default value
952 * for initializing the authorized attribute of interfaces
954 static ssize_t interface_authorized_default_store(struct device *dev,
955 struct device_attribute *attr, const char *buf, size_t count)
957 struct usb_device *usb_dev = to_usb_device(dev);
958 struct usb_hcd *hcd = bus_to_hcd(usb_dev->bus);
962 if (strtobool(buf, &val) != 0)
966 set_bit(HCD_FLAG_INTF_AUTHORIZED, &hcd->flags);
968 clear_bit(HCD_FLAG_INTF_AUTHORIZED, &hcd->flags);
972 static DEVICE_ATTR_RW(interface_authorized_default);
974 /* Group all the USB bus attributes */
975 static struct attribute *usb_bus_attrs[] = {
976 &dev_attr_authorized_default.attr,
977 &dev_attr_interface_authorized_default.attr,
981 static struct attribute_group usb_bus_attr_group = {
982 .name = NULL, /* we want them in the same directory */
983 .attrs = usb_bus_attrs,
988 /*-------------------------------------------------------------------------*/
991 * usb_bus_init - shared initialization code
992 * @bus: the bus structure being initialized
994 * This code is used to initialize a usb_bus structure, memory for which is
995 * separately managed.
997 static void usb_bus_init (struct usb_bus *bus)
999 memset (&bus->devmap, 0, sizeof(struct usb_devmap));
1001 bus->devnum_next = 1;
1003 bus->root_hub = NULL;
1005 bus->bandwidth_allocated = 0;
1006 bus->bandwidth_int_reqs = 0;
1007 bus->bandwidth_isoc_reqs = 0;
1008 mutex_init(&bus->devnum_next_mutex);
1011 /*-------------------------------------------------------------------------*/
1014 * usb_register_bus - registers the USB host controller with the usb core
1015 * @bus: pointer to the bus to register
1016 * Context: !in_interrupt()
1018 * Assigns a bus number, and links the controller into usbcore data
1019 * structures so that it can be seen by scanning the bus list.
1021 * Return: 0 if successful. A negative error code otherwise.
1023 static int usb_register_bus(struct usb_bus *bus)
1025 int result = -E2BIG;
1028 mutex_lock(&usb_bus_idr_lock);
1029 busnum = idr_alloc(&usb_bus_idr, bus, 1, USB_MAXBUS, GFP_KERNEL);
1031 pr_err("%s: failed to get bus number\n", usbcore_name);
1032 goto error_find_busnum;
1034 bus->busnum = busnum;
1035 mutex_unlock(&usb_bus_idr_lock);
1037 usb_notify_add_bus(bus);
1039 dev_info (bus->controller, "new USB bus registered, assigned bus "
1040 "number %d\n", bus->busnum);
1044 mutex_unlock(&usb_bus_idr_lock);
1049 * usb_deregister_bus - deregisters the USB host controller
1050 * @bus: pointer to the bus to deregister
1051 * Context: !in_interrupt()
1053 * Recycles the bus number, and unlinks the controller from usbcore data
1054 * structures so that it won't be seen by scanning the bus list.
1056 static void usb_deregister_bus (struct usb_bus *bus)
1058 dev_info (bus->controller, "USB bus %d deregistered\n", bus->busnum);
1061 * NOTE: make sure that all the devices are removed by the
1062 * controller code, as well as having it call this when cleaning
1065 mutex_lock(&usb_bus_idr_lock);
1066 idr_remove(&usb_bus_idr, bus->busnum);
1067 mutex_unlock(&usb_bus_idr_lock);
1069 usb_notify_remove_bus(bus);
1073 * register_root_hub - called by usb_add_hcd() to register a root hub
1074 * @hcd: host controller for this root hub
1076 * This function registers the root hub with the USB subsystem. It sets up
1077 * the device properly in the device tree and then calls usb_new_device()
1078 * to register the usb device. It also assigns the root hub's USB address
1081 * Return: 0 if successful. A negative error code otherwise.
1083 static int register_root_hub(struct usb_hcd *hcd)
1085 struct device *parent_dev = hcd->self.controller;
1086 struct usb_device *usb_dev = hcd->self.root_hub;
1087 const int devnum = 1;
1090 usb_dev->devnum = devnum;
1091 usb_dev->bus->devnum_next = devnum + 1;
1092 memset (&usb_dev->bus->devmap.devicemap, 0,
1093 sizeof usb_dev->bus->devmap.devicemap);
1094 set_bit (devnum, usb_dev->bus->devmap.devicemap);
1095 usb_set_device_state(usb_dev, USB_STATE_ADDRESS);
1097 mutex_lock(&usb_bus_idr_lock);
1099 usb_dev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
1100 retval = usb_get_device_descriptor(usb_dev, USB_DT_DEVICE_SIZE);
1101 if (retval != sizeof usb_dev->descriptor) {
1102 mutex_unlock(&usb_bus_idr_lock);
1103 dev_dbg (parent_dev, "can't read %s device descriptor %d\n",
1104 dev_name(&usb_dev->dev), retval);
1105 return (retval < 0) ? retval : -EMSGSIZE;
1108 if (le16_to_cpu(usb_dev->descriptor.bcdUSB) >= 0x0201) {
1109 retval = usb_get_bos_descriptor(usb_dev);
1111 usb_dev->lpm_capable = usb_device_supports_lpm(usb_dev);
1112 } else if (usb_dev->speed >= USB_SPEED_SUPER) {
1113 mutex_unlock(&usb_bus_idr_lock);
1114 dev_dbg(parent_dev, "can't read %s bos descriptor %d\n",
1115 dev_name(&usb_dev->dev), retval);
1120 retval = usb_new_device (usb_dev);
1122 dev_err (parent_dev, "can't register root hub for %s, %d\n",
1123 dev_name(&usb_dev->dev), retval);
1125 spin_lock_irq (&hcd_root_hub_lock);
1126 hcd->rh_registered = 1;
1127 spin_unlock_irq (&hcd_root_hub_lock);
1129 /* Did the HC die before the root hub was registered? */
1131 usb_hc_died (hcd); /* This time clean up */
1132 usb_dev->dev.of_node = parent_dev->of_node;
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.controller,
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.controller,
1482 else if (IS_ENABLED(CONFIG_HAS_DMA) &&
1483 (urb->transfer_flags & URB_DMA_MAP_PAGE))
1484 dma_unmap_page(hcd->self.controller,
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.controller,
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 urb->setup_dma = dma_map_single(
1533 hcd->self.controller,
1535 sizeof(struct usb_ctrlrequest),
1537 if (dma_mapping_error(hcd->self.controller,
1540 urb->transfer_flags |= URB_SETUP_MAP_SINGLE;
1541 } else if (hcd->driver->flags & HCD_LOCAL_MEM) {
1542 ret = hcd_alloc_coherent(
1543 urb->dev->bus, mem_flags,
1545 (void **)&urb->setup_packet,
1546 sizeof(struct usb_ctrlrequest),
1550 urb->transfer_flags |= URB_SETUP_MAP_LOCAL;
1554 dir = usb_urb_dir_in(urb) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
1555 if (urb->transfer_buffer_length != 0
1556 && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP)) {
1557 if (IS_ENABLED(CONFIG_HAS_DMA) && hcd->self.uses_dma) {
1561 /* We don't support sg for isoc transfers ! */
1562 if (usb_endpoint_xfer_isoc(&urb->ep->desc)) {
1568 hcd->self.controller,
1575 urb->transfer_flags |= URB_DMA_MAP_SG;
1576 urb->num_mapped_sgs = n;
1577 if (n != urb->num_sgs)
1578 urb->transfer_flags |=
1579 URB_DMA_SG_COMBINED;
1580 } else if (urb->sg) {
1581 struct scatterlist *sg = urb->sg;
1582 urb->transfer_dma = dma_map_page(
1583 hcd->self.controller,
1586 urb->transfer_buffer_length,
1588 if (dma_mapping_error(hcd->self.controller,
1592 urb->transfer_flags |= URB_DMA_MAP_PAGE;
1593 } else if (is_vmalloc_addr(urb->transfer_buffer)) {
1594 WARN_ONCE(1, "transfer buffer not dma capable\n");
1597 urb->transfer_dma = dma_map_single(
1598 hcd->self.controller,
1599 urb->transfer_buffer,
1600 urb->transfer_buffer_length,
1602 if (dma_mapping_error(hcd->self.controller,
1606 urb->transfer_flags |= URB_DMA_MAP_SINGLE;
1608 } else if (hcd->driver->flags & HCD_LOCAL_MEM) {
1609 ret = hcd_alloc_coherent(
1610 urb->dev->bus, mem_flags,
1612 &urb->transfer_buffer,
1613 urb->transfer_buffer_length,
1616 urb->transfer_flags |= URB_MAP_LOCAL;
1618 if (ret && (urb->transfer_flags & (URB_SETUP_MAP_SINGLE |
1619 URB_SETUP_MAP_LOCAL)))
1620 usb_hcd_unmap_urb_for_dma(hcd, urb);
1624 EXPORT_SYMBOL_GPL(usb_hcd_map_urb_for_dma);
1626 /*-------------------------------------------------------------------------*/
1628 /* may be called in any context with a valid urb->dev usecount
1629 * caller surrenders "ownership" of urb
1630 * expects usb_submit_urb() to have sanity checked and conditioned all
1633 int usb_hcd_submit_urb (struct urb *urb, gfp_t mem_flags)
1636 struct usb_hcd *hcd = bus_to_hcd(urb->dev->bus);
1638 /* increment urb's reference count as part of giving it to the HCD
1639 * (which will control it). HCD guarantees that it either returns
1640 * an error or calls giveback(), but not both.
1643 atomic_inc(&urb->use_count);
1644 atomic_inc(&urb->dev->urbnum);
1645 usbmon_urb_submit(&hcd->self, urb);
1647 /* NOTE requirements on root-hub callers (usbfs and the hub
1648 * driver, for now): URBs' urb->transfer_buffer must be
1649 * valid and usb_buffer_{sync,unmap}() not be needed, since
1650 * they could clobber root hub response data. Also, control
1651 * URBs must be submitted in process context with interrupts
1655 if (is_root_hub(urb->dev)) {
1656 status = rh_urb_enqueue(hcd, urb);
1658 status = map_urb_for_dma(hcd, urb, mem_flags);
1659 if (likely(status == 0)) {
1660 status = hcd->driver->urb_enqueue(hcd, urb, mem_flags);
1661 if (unlikely(status))
1662 unmap_urb_for_dma(hcd, urb);
1666 if (unlikely(status)) {
1667 usbmon_urb_submit_error(&hcd->self, urb, status);
1669 INIT_LIST_HEAD(&urb->urb_list);
1670 atomic_dec(&urb->use_count);
1672 * Order the write of urb->use_count above before the read
1673 * of urb->reject below. Pairs with the memory barriers in
1674 * usb_kill_urb() and usb_poison_urb().
1676 smp_mb__after_atomic();
1678 atomic_dec(&urb->dev->urbnum);
1679 if (atomic_read(&urb->reject))
1680 wake_up(&usb_kill_urb_queue);
1686 /*-------------------------------------------------------------------------*/
1688 /* this makes the hcd giveback() the urb more quickly, by kicking it
1689 * off hardware queues (which may take a while) and returning it as
1690 * soon as practical. we've already set up the urb's return status,
1691 * but we can't know if the callback completed already.
1693 static int unlink1(struct usb_hcd *hcd, struct urb *urb, int status)
1697 if (is_root_hub(urb->dev))
1698 value = usb_rh_urb_dequeue(hcd, urb, status);
1701 /* The only reason an HCD might fail this call is if
1702 * it has not yet fully queued the urb to begin with.
1703 * Such failures should be harmless. */
1704 value = hcd->driver->urb_dequeue(hcd, urb, status);
1710 * called in any context
1712 * caller guarantees urb won't be recycled till both unlink()
1713 * and the urb's completion function return
1715 int usb_hcd_unlink_urb (struct urb *urb, int status)
1717 struct usb_hcd *hcd;
1718 struct usb_device *udev = urb->dev;
1719 int retval = -EIDRM;
1720 unsigned long flags;
1722 /* Prevent the device and bus from going away while
1723 * the unlink is carried out. If they are already gone
1724 * then urb->use_count must be 0, since disconnected
1725 * devices can't have any active URBs.
1727 spin_lock_irqsave(&hcd_urb_unlink_lock, flags);
1728 if (atomic_read(&urb->use_count) > 0) {
1732 spin_unlock_irqrestore(&hcd_urb_unlink_lock, flags);
1734 hcd = bus_to_hcd(urb->dev->bus);
1735 retval = unlink1(hcd, urb, status);
1737 retval = -EINPROGRESS;
1738 else if (retval != -EIDRM && retval != -EBUSY)
1739 dev_dbg(&udev->dev, "hcd_unlink_urb %pK fail %d\n",
1746 /*-------------------------------------------------------------------------*/
1748 static void __usb_hcd_giveback_urb(struct urb *urb)
1750 struct usb_hcd *hcd = bus_to_hcd(urb->dev->bus);
1751 struct usb_anchor *anchor = urb->anchor;
1752 int status = urb->unlinked;
1753 unsigned long flags;
1756 if (unlikely((urb->transfer_flags & URB_SHORT_NOT_OK) &&
1757 urb->actual_length < urb->transfer_buffer_length &&
1759 status = -EREMOTEIO;
1761 unmap_urb_for_dma(hcd, urb);
1762 usbmon_urb_complete(&hcd->self, urb, status);
1763 usb_anchor_suspend_wakeups(anchor);
1764 usb_unanchor_urb(urb);
1765 if (likely(status == 0))
1766 usb_led_activity(USB_LED_EVENT_HOST);
1768 /* pass ownership to the completion handler */
1769 urb->status = status;
1772 * We disable local IRQs here avoid possible deadlock because
1773 * drivers may call spin_lock() to hold lock which might be
1774 * acquired in one hard interrupt handler.
1776 * The local_irq_save()/local_irq_restore() around complete()
1777 * will be removed if current USB drivers have been cleaned up
1778 * and no one may trigger the above deadlock situation when
1779 * running complete() in tasklet.
1781 local_irq_save(flags);
1783 local_irq_restore(flags);
1785 usb_anchor_resume_wakeups(anchor);
1786 atomic_dec(&urb->use_count);
1788 * Order the write of urb->use_count above before the read
1789 * of urb->reject below. Pairs with the memory barriers in
1790 * usb_kill_urb() and usb_poison_urb().
1792 smp_mb__after_atomic();
1794 if (unlikely(atomic_read(&urb->reject)))
1795 wake_up(&usb_kill_urb_queue);
1799 static void usb_giveback_urb_bh(unsigned long param)
1801 struct giveback_urb_bh *bh = (struct giveback_urb_bh *)param;
1802 struct list_head local_list;
1804 spin_lock_irq(&bh->lock);
1807 list_replace_init(&bh->head, &local_list);
1808 spin_unlock_irq(&bh->lock);
1810 while (!list_empty(&local_list)) {
1813 urb = list_entry(local_list.next, struct urb, urb_list);
1814 list_del_init(&urb->urb_list);
1815 bh->completing_ep = urb->ep;
1816 __usb_hcd_giveback_urb(urb);
1817 bh->completing_ep = NULL;
1820 /* check if there are new URBs to giveback */
1821 spin_lock_irq(&bh->lock);
1822 if (!list_empty(&bh->head))
1824 bh->running = false;
1825 spin_unlock_irq(&bh->lock);
1829 * usb_hcd_giveback_urb - return URB from HCD to device driver
1830 * @hcd: host controller returning the URB
1831 * @urb: urb being returned to the USB device driver.
1832 * @status: completion status code for the URB.
1833 * Context: in_interrupt()
1835 * This hands the URB from HCD to its USB device driver, using its
1836 * completion function. The HCD has freed all per-urb resources
1837 * (and is done using urb->hcpriv). It also released all HCD locks;
1838 * the device driver won't cause problems if it frees, modifies,
1839 * or resubmits this URB.
1841 * If @urb was unlinked, the value of @status will be overridden by
1842 * @urb->unlinked. Erroneous short transfers are detected in case
1843 * the HCD hasn't checked for them.
1845 void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb, int status)
1847 struct giveback_urb_bh *bh;
1848 bool running, high_prio_bh;
1850 /* pass status to tasklet via unlinked */
1851 if (likely(!urb->unlinked))
1852 urb->unlinked = status;
1854 if (!hcd_giveback_urb_in_bh(hcd) && !is_root_hub(urb->dev)) {
1855 __usb_hcd_giveback_urb(urb);
1859 if (usb_pipeisoc(urb->pipe) || usb_pipeint(urb->pipe)) {
1860 bh = &hcd->high_prio_bh;
1861 high_prio_bh = true;
1863 bh = &hcd->low_prio_bh;
1864 high_prio_bh = false;
1867 spin_lock(&bh->lock);
1868 list_add_tail(&urb->urb_list, &bh->head);
1869 running = bh->running;
1870 spin_unlock(&bh->lock);
1874 else if (high_prio_bh)
1875 tasklet_hi_schedule(&bh->bh);
1877 tasklet_schedule(&bh->bh);
1879 EXPORT_SYMBOL_GPL(usb_hcd_giveback_urb);
1881 /*-------------------------------------------------------------------------*/
1883 /* Cancel all URBs pending on this endpoint and wait for the endpoint's
1884 * queue to drain completely. The caller must first insure that no more
1885 * URBs can be submitted for this endpoint.
1887 void usb_hcd_flush_endpoint(struct usb_device *udev,
1888 struct usb_host_endpoint *ep)
1890 struct usb_hcd *hcd;
1896 hcd = bus_to_hcd(udev->bus);
1898 /* No more submits can occur */
1899 spin_lock_irq(&hcd_urb_list_lock);
1901 list_for_each_entry_reverse(urb, &ep->urb_list, urb_list) {
1907 is_in = usb_urb_dir_in(urb);
1908 spin_unlock(&hcd_urb_list_lock);
1911 unlink1(hcd, urb, -ESHUTDOWN);
1912 dev_dbg (hcd->self.controller,
1913 "shutdown urb %pK ep%d%s%s\n",
1914 urb, usb_endpoint_num(&ep->desc),
1915 is_in ? "in" : "out",
1918 switch (usb_endpoint_type(&ep->desc)) {
1919 case USB_ENDPOINT_XFER_CONTROL:
1921 case USB_ENDPOINT_XFER_BULK:
1923 case USB_ENDPOINT_XFER_INT:
1932 /* list contents may have changed */
1933 spin_lock(&hcd_urb_list_lock);
1936 spin_unlock_irq(&hcd_urb_list_lock);
1938 /* Wait until the endpoint queue is completely empty */
1939 while (!list_empty (&ep->urb_list)) {
1940 spin_lock_irq(&hcd_urb_list_lock);
1942 /* The list may have changed while we acquired the spinlock */
1944 if (!list_empty (&ep->urb_list)) {
1945 urb = list_entry (ep->urb_list.prev, struct urb,
1949 spin_unlock_irq(&hcd_urb_list_lock);
1959 * usb_hcd_alloc_bandwidth - check whether a new bandwidth setting exceeds
1961 * @udev: target &usb_device
1962 * @new_config: new configuration to install
1963 * @cur_alt: the current alternate interface setting
1964 * @new_alt: alternate interface setting that is being installed
1966 * To change configurations, pass in the new configuration in new_config,
1967 * and pass NULL for cur_alt and new_alt.
1969 * To reset a device's configuration (put the device in the ADDRESSED state),
1970 * pass in NULL for new_config, cur_alt, and new_alt.
1972 * To change alternate interface settings, pass in NULL for new_config,
1973 * pass in the current alternate interface setting in cur_alt,
1974 * and pass in the new alternate interface setting in new_alt.
1976 * Return: An error if the requested bandwidth change exceeds the
1977 * bus bandwidth or host controller internal resources.
1979 int usb_hcd_alloc_bandwidth(struct usb_device *udev,
1980 struct usb_host_config *new_config,
1981 struct usb_host_interface *cur_alt,
1982 struct usb_host_interface *new_alt)
1984 int num_intfs, i, j;
1985 struct usb_host_interface *alt = NULL;
1987 struct usb_hcd *hcd;
1988 struct usb_host_endpoint *ep;
1990 hcd = bus_to_hcd(udev->bus);
1991 if (!hcd->driver->check_bandwidth)
1994 /* Configuration is being removed - set configuration 0 */
1995 if (!new_config && !cur_alt) {
1996 for (i = 1; i < 16; ++i) {
1997 ep = udev->ep_out[i];
1999 hcd->driver->drop_endpoint(hcd, udev, ep);
2000 ep = udev->ep_in[i];
2002 hcd->driver->drop_endpoint(hcd, udev, ep);
2004 hcd->driver->check_bandwidth(hcd, udev);
2007 /* Check if the HCD says there's enough bandwidth. Enable all endpoints
2008 * each interface's alt setting 0 and ask the HCD to check the bandwidth
2009 * of the bus. There will always be bandwidth for endpoint 0, so it's
2013 num_intfs = new_config->desc.bNumInterfaces;
2014 /* Remove endpoints (except endpoint 0, which is always on the
2015 * schedule) from the old config from the schedule
2017 for (i = 1; i < 16; ++i) {
2018 ep = udev->ep_out[i];
2020 ret = hcd->driver->drop_endpoint(hcd, udev, ep);
2024 ep = udev->ep_in[i];
2026 ret = hcd->driver->drop_endpoint(hcd, udev, ep);
2031 for (i = 0; i < num_intfs; ++i) {
2032 struct usb_host_interface *first_alt;
2035 first_alt = &new_config->intf_cache[i]->altsetting[0];
2036 iface_num = first_alt->desc.bInterfaceNumber;
2037 /* Set up endpoints for alternate interface setting 0 */
2038 alt = usb_find_alt_setting(new_config, iface_num, 0);
2040 /* No alt setting 0? Pick the first setting. */
2043 for (j = 0; j < alt->desc.bNumEndpoints; j++) {
2044 ret = hcd->driver->add_endpoint(hcd, udev, &alt->endpoint[j]);
2050 if (cur_alt && new_alt) {
2051 struct usb_interface *iface = usb_ifnum_to_if(udev,
2052 cur_alt->desc.bInterfaceNumber);
2056 if (iface->resetting_device) {
2058 * The USB core just reset the device, so the xHCI host
2059 * and the device will think alt setting 0 is installed.
2060 * However, the USB core will pass in the alternate
2061 * setting installed before the reset as cur_alt. Dig
2062 * out the alternate setting 0 structure, or the first
2063 * alternate setting if a broken device doesn't have alt
2066 cur_alt = usb_altnum_to_altsetting(iface, 0);
2068 cur_alt = &iface->altsetting[0];
2071 /* Drop all the endpoints in the current alt setting */
2072 for (i = 0; i < cur_alt->desc.bNumEndpoints; i++) {
2073 ret = hcd->driver->drop_endpoint(hcd, udev,
2074 &cur_alt->endpoint[i]);
2078 /* Add all the endpoints in the new alt setting */
2079 for (i = 0; i < new_alt->desc.bNumEndpoints; i++) {
2080 ret = hcd->driver->add_endpoint(hcd, udev,
2081 &new_alt->endpoint[i]);
2086 ret = hcd->driver->check_bandwidth(hcd, udev);
2089 hcd->driver->reset_bandwidth(hcd, udev);
2093 /* Disables the endpoint: synchronizes with the hcd to make sure all
2094 * endpoint state is gone from hardware. usb_hcd_flush_endpoint() must
2095 * have been called previously. Use for set_configuration, set_interface,
2096 * driver removal, physical disconnect.
2098 * example: a qh stored in ep->hcpriv, holding state related to endpoint
2099 * type, maxpacket size, toggle, halt status, and scheduling.
2101 void usb_hcd_disable_endpoint(struct usb_device *udev,
2102 struct usb_host_endpoint *ep)
2104 struct usb_hcd *hcd;
2107 hcd = bus_to_hcd(udev->bus);
2108 if (hcd->driver->endpoint_disable)
2109 hcd->driver->endpoint_disable(hcd, ep);
2113 * usb_hcd_reset_endpoint - reset host endpoint state
2114 * @udev: USB device.
2115 * @ep: the endpoint to reset.
2117 * Resets any host endpoint state such as the toggle bit, sequence
2118 * number and current window.
2120 void usb_hcd_reset_endpoint(struct usb_device *udev,
2121 struct usb_host_endpoint *ep)
2123 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2125 if (hcd->driver->endpoint_reset)
2126 hcd->driver->endpoint_reset(hcd, ep);
2128 int epnum = usb_endpoint_num(&ep->desc);
2129 int is_out = usb_endpoint_dir_out(&ep->desc);
2130 int is_control = usb_endpoint_xfer_control(&ep->desc);
2132 usb_settoggle(udev, epnum, is_out, 0);
2134 usb_settoggle(udev, epnum, !is_out, 0);
2139 * usb_alloc_streams - allocate bulk endpoint stream IDs.
2140 * @interface: alternate setting that includes all endpoints.
2141 * @eps: array of endpoints that need streams.
2142 * @num_eps: number of endpoints in the array.
2143 * @num_streams: number of streams to allocate.
2144 * @mem_flags: flags hcd should use to allocate memory.
2146 * Sets up a group of bulk endpoints to have @num_streams stream IDs available.
2147 * Drivers may queue multiple transfers to different stream IDs, which may
2148 * complete in a different order than they were queued.
2150 * Return: On success, the number of allocated streams. On failure, a negative
2153 int usb_alloc_streams(struct usb_interface *interface,
2154 struct usb_host_endpoint **eps, unsigned int num_eps,
2155 unsigned int num_streams, gfp_t mem_flags)
2157 struct usb_hcd *hcd;
2158 struct usb_device *dev;
2161 dev = interface_to_usbdev(interface);
2162 hcd = bus_to_hcd(dev->bus);
2163 if (!hcd->driver->alloc_streams || !hcd->driver->free_streams)
2165 if (dev->speed < USB_SPEED_SUPER)
2167 if (dev->state < USB_STATE_CONFIGURED)
2170 for (i = 0; i < num_eps; i++) {
2171 /* Streams only apply to bulk endpoints. */
2172 if (!usb_endpoint_xfer_bulk(&eps[i]->desc))
2174 /* Re-alloc is not allowed */
2175 if (eps[i]->streams)
2179 ret = hcd->driver->alloc_streams(hcd, dev, eps, num_eps,
2180 num_streams, mem_flags);
2184 for (i = 0; i < num_eps; i++)
2185 eps[i]->streams = ret;
2189 EXPORT_SYMBOL_GPL(usb_alloc_streams);
2192 * usb_free_streams - free bulk endpoint stream IDs.
2193 * @interface: alternate setting that includes all endpoints.
2194 * @eps: array of endpoints to remove streams from.
2195 * @num_eps: number of endpoints in the array.
2196 * @mem_flags: flags hcd should use to allocate memory.
2198 * Reverts a group of bulk endpoints back to not using stream IDs.
2199 * Can fail if we are given bad arguments, or HCD is broken.
2201 * Return: 0 on success. On failure, a negative error code.
2203 int usb_free_streams(struct usb_interface *interface,
2204 struct usb_host_endpoint **eps, unsigned int num_eps,
2207 struct usb_hcd *hcd;
2208 struct usb_device *dev;
2211 dev = interface_to_usbdev(interface);
2212 hcd = bus_to_hcd(dev->bus);
2213 if (dev->speed < USB_SPEED_SUPER)
2216 /* Double-free is not allowed */
2217 for (i = 0; i < num_eps; i++)
2218 if (!eps[i] || !eps[i]->streams)
2221 ret = hcd->driver->free_streams(hcd, dev, eps, num_eps, mem_flags);
2225 for (i = 0; i < num_eps; i++)
2226 eps[i]->streams = 0;
2230 EXPORT_SYMBOL_GPL(usb_free_streams);
2232 /* Protect against drivers that try to unlink URBs after the device
2233 * is gone, by waiting until all unlinks for @udev are finished.
2234 * Since we don't currently track URBs by device, simply wait until
2235 * nothing is running in the locked region of usb_hcd_unlink_urb().
2237 void usb_hcd_synchronize_unlinks(struct usb_device *udev)
2239 spin_lock_irq(&hcd_urb_unlink_lock);
2240 spin_unlock_irq(&hcd_urb_unlink_lock);
2243 /*-------------------------------------------------------------------------*/
2245 /* called in any context */
2246 int usb_hcd_get_frame_number (struct usb_device *udev)
2248 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2250 if (!HCD_RH_RUNNING(hcd))
2252 return hcd->driver->get_frame_number (hcd);
2255 /*-------------------------------------------------------------------------*/
2259 int hcd_bus_suspend(struct usb_device *rhdev, pm_message_t msg)
2261 struct usb_hcd *hcd = bus_to_hcd(rhdev->bus);
2263 int old_state = hcd->state;
2265 dev_dbg(&rhdev->dev, "bus %ssuspend, wakeup %d\n",
2266 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
2267 rhdev->do_remote_wakeup);
2268 if (HCD_DEAD(hcd)) {
2269 dev_dbg(&rhdev->dev, "skipped %s of dead bus\n", "suspend");
2273 if (!hcd->driver->bus_suspend) {
2276 clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2277 hcd->state = HC_STATE_QUIESCING;
2278 status = hcd->driver->bus_suspend(hcd);
2281 usb_set_device_state(rhdev, USB_STATE_SUSPENDED);
2282 hcd->state = HC_STATE_SUSPENDED;
2284 /* Did we race with a root-hub wakeup event? */
2285 if (rhdev->do_remote_wakeup) {
2288 status = hcd->driver->hub_status_data(hcd, buffer);
2290 dev_dbg(&rhdev->dev, "suspend raced with wakeup event\n");
2291 hcd_bus_resume(rhdev, PMSG_AUTO_RESUME);
2296 spin_lock_irq(&hcd_root_hub_lock);
2297 if (!HCD_DEAD(hcd)) {
2298 set_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2299 hcd->state = old_state;
2301 spin_unlock_irq(&hcd_root_hub_lock);
2302 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
2308 int hcd_bus_resume(struct usb_device *rhdev, pm_message_t msg)
2310 struct usb_hcd *hcd = bus_to_hcd(rhdev->bus);
2312 int old_state = hcd->state;
2314 dev_dbg(&rhdev->dev, "usb %sresume\n",
2315 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
2316 if (HCD_DEAD(hcd)) {
2317 dev_dbg(&rhdev->dev, "skipped %s of dead bus\n", "resume");
2320 if (!hcd->driver->bus_resume)
2322 if (HCD_RH_RUNNING(hcd))
2325 hcd->state = HC_STATE_RESUMING;
2326 status = hcd->driver->bus_resume(hcd);
2327 clear_bit(HCD_FLAG_WAKEUP_PENDING, &hcd->flags);
2329 struct usb_device *udev;
2332 spin_lock_irq(&hcd_root_hub_lock);
2333 if (!HCD_DEAD(hcd)) {
2334 usb_set_device_state(rhdev, rhdev->actconfig
2335 ? USB_STATE_CONFIGURED
2336 : USB_STATE_ADDRESS);
2337 set_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2338 hcd->state = HC_STATE_RUNNING;
2340 spin_unlock_irq(&hcd_root_hub_lock);
2343 * Check whether any of the enabled ports on the root hub are
2344 * unsuspended. If they are then a TRSMRCY delay is needed
2345 * (this is what the USB-2 spec calls a "global resume").
2346 * Otherwise we can skip the delay.
2348 usb_hub_for_each_child(rhdev, port1, udev) {
2349 if (udev->state != USB_STATE_NOTATTACHED &&
2350 !udev->port_is_suspended) {
2351 usleep_range(10000, 11000); /* TRSMRCY */
2356 hcd->state = old_state;
2357 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
2359 if (status != -ESHUTDOWN)
2365 /* Workqueue routine for root-hub remote wakeup */
2366 static void hcd_resume_work(struct work_struct *work)
2368 struct usb_hcd *hcd = container_of(work, struct usb_hcd, wakeup_work);
2369 struct usb_device *udev = hcd->self.root_hub;
2371 usb_remote_wakeup(udev);
2375 * usb_hcd_resume_root_hub - called by HCD to resume its root hub
2376 * @hcd: host controller for this root hub
2378 * The USB host controller calls this function when its root hub is
2379 * suspended (with the remote wakeup feature enabled) and a remote
2380 * wakeup request is received. The routine submits a workqueue request
2381 * to resume the root hub (that is, manage its downstream ports again).
2383 void usb_hcd_resume_root_hub (struct usb_hcd *hcd)
2385 unsigned long flags;
2387 spin_lock_irqsave (&hcd_root_hub_lock, flags);
2388 if (hcd->rh_registered) {
2389 pm_wakeup_event(&hcd->self.root_hub->dev, 0);
2390 set_bit(HCD_FLAG_WAKEUP_PENDING, &hcd->flags);
2391 queue_work(pm_wq, &hcd->wakeup_work);
2393 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
2395 EXPORT_SYMBOL_GPL(usb_hcd_resume_root_hub);
2397 #endif /* CONFIG_PM */
2399 /*-------------------------------------------------------------------------*/
2401 #ifdef CONFIG_USB_OTG
2404 * usb_bus_start_enum - start immediate enumeration (for OTG)
2405 * @bus: the bus (must use hcd framework)
2406 * @port_num: 1-based number of port; usually bus->otg_port
2407 * Context: in_interrupt()
2409 * Starts enumeration, with an immediate reset followed later by
2410 * hub_wq identifying and possibly configuring the device.
2411 * This is needed by OTG controller drivers, where it helps meet
2412 * HNP protocol timing requirements for starting a port reset.
2414 * Return: 0 if successful.
2416 int usb_bus_start_enum(struct usb_bus *bus, unsigned port_num)
2418 struct usb_hcd *hcd;
2419 int status = -EOPNOTSUPP;
2421 /* NOTE: since HNP can't start by grabbing the bus's address0_sem,
2422 * boards with root hubs hooked up to internal devices (instead of
2423 * just the OTG port) may need more attention to resetting...
2425 hcd = bus_to_hcd(bus);
2426 if (port_num && hcd->driver->start_port_reset)
2427 status = hcd->driver->start_port_reset(hcd, port_num);
2429 /* allocate hub_wq shortly after (first) root port reset finishes;
2430 * it may issue others, until at least 50 msecs have passed.
2433 mod_timer(&hcd->rh_timer, jiffies + msecs_to_jiffies(10));
2436 EXPORT_SYMBOL_GPL(usb_bus_start_enum);
2440 /*-------------------------------------------------------------------------*/
2443 * usb_hcd_irq - hook IRQs to HCD framework (bus glue)
2444 * @irq: the IRQ being raised
2445 * @__hcd: pointer to the HCD whose IRQ is being signaled
2447 * If the controller isn't HALTed, calls the driver's irq handler.
2448 * Checks whether the controller is now dead.
2450 * Return: %IRQ_HANDLED if the IRQ was handled. %IRQ_NONE otherwise.
2452 irqreturn_t usb_hcd_irq (int irq, void *__hcd)
2454 struct usb_hcd *hcd = __hcd;
2457 if (unlikely(HCD_DEAD(hcd) || !HCD_HW_ACCESSIBLE(hcd)))
2459 else if (hcd->driver->irq(hcd) == IRQ_NONE)
2466 EXPORT_SYMBOL_GPL(usb_hcd_irq);
2468 /*-------------------------------------------------------------------------*/
2471 * usb_hc_died - report abnormal shutdown of a host controller (bus glue)
2472 * @hcd: pointer to the HCD representing the controller
2474 * This is called by bus glue to report a USB host controller that died
2475 * while operations may still have been pending. It's called automatically
2476 * by the PCI glue, so only glue for non-PCI busses should need to call it.
2478 * Only call this function with the primary HCD.
2480 void usb_hc_died (struct usb_hcd *hcd)
2482 unsigned long flags;
2484 dev_err (hcd->self.controller, "HC died; cleaning up\n");
2486 spin_lock_irqsave (&hcd_root_hub_lock, flags);
2487 clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2488 set_bit(HCD_FLAG_DEAD, &hcd->flags);
2489 if (hcd->rh_registered) {
2490 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2492 /* make hub_wq clean up old urbs and devices */
2493 usb_set_device_state (hcd->self.root_hub,
2494 USB_STATE_NOTATTACHED);
2495 usb_kick_hub_wq(hcd->self.root_hub);
2497 if (usb_hcd_is_primary_hcd(hcd) && hcd->shared_hcd) {
2498 hcd = hcd->shared_hcd;
2499 clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2500 set_bit(HCD_FLAG_DEAD, &hcd->flags);
2501 if (hcd->rh_registered) {
2502 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2504 /* make hub_wq clean up old urbs and devices */
2505 usb_set_device_state(hcd->self.root_hub,
2506 USB_STATE_NOTATTACHED);
2507 usb_kick_hub_wq(hcd->self.root_hub);
2510 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
2511 /* Make sure that the other roothub is also deallocated. */
2513 EXPORT_SYMBOL_GPL (usb_hc_died);
2515 /*-------------------------------------------------------------------------*/
2517 static void init_giveback_urb_bh(struct giveback_urb_bh *bh)
2520 spin_lock_init(&bh->lock);
2521 INIT_LIST_HEAD(&bh->head);
2522 tasklet_init(&bh->bh, usb_giveback_urb_bh, (unsigned long)bh);
2526 * usb_create_shared_hcd - create and initialize an HCD structure
2527 * @driver: HC driver that will use this hcd
2528 * @dev: device for this HC, stored in hcd->self.controller
2529 * @bus_name: value to store in hcd->self.bus_name
2530 * @primary_hcd: a pointer to the usb_hcd structure that is sharing the
2531 * PCI device. Only allocate certain resources for the primary HCD
2532 * Context: !in_interrupt()
2534 * Allocate a struct usb_hcd, with extra space at the end for the
2535 * HC driver's private data. Initialize the generic members of the
2538 * Return: On success, a pointer to the created and initialized HCD structure.
2539 * On failure (e.g. if memory is unavailable), %NULL.
2541 struct usb_hcd *usb_create_shared_hcd(const struct hc_driver *driver,
2542 struct device *dev, const char *bus_name,
2543 struct usb_hcd *primary_hcd)
2545 struct usb_hcd *hcd;
2547 hcd = kzalloc(sizeof(*hcd) + driver->hcd_priv_size, GFP_KERNEL);
2550 if (primary_hcd == NULL) {
2551 hcd->address0_mutex = kmalloc(sizeof(*hcd->address0_mutex),
2553 if (!hcd->address0_mutex) {
2555 dev_dbg(dev, "hcd address0 mutex alloc failed\n");
2558 mutex_init(hcd->address0_mutex);
2559 hcd->bandwidth_mutex = kmalloc(sizeof(*hcd->bandwidth_mutex),
2561 if (!hcd->bandwidth_mutex) {
2562 kfree(hcd->address0_mutex);
2564 dev_dbg(dev, "hcd bandwidth mutex alloc failed\n");
2567 mutex_init(hcd->bandwidth_mutex);
2568 dev_set_drvdata(dev, hcd);
2570 mutex_lock(&usb_port_peer_mutex);
2571 hcd->address0_mutex = primary_hcd->address0_mutex;
2572 hcd->bandwidth_mutex = primary_hcd->bandwidth_mutex;
2573 hcd->primary_hcd = primary_hcd;
2574 primary_hcd->primary_hcd = primary_hcd;
2575 hcd->shared_hcd = primary_hcd;
2576 primary_hcd->shared_hcd = hcd;
2577 mutex_unlock(&usb_port_peer_mutex);
2580 kref_init(&hcd->kref);
2582 usb_bus_init(&hcd->self);
2583 hcd->self.controller = dev;
2584 hcd->self.bus_name = bus_name;
2585 hcd->self.uses_dma = (dev->dma_mask != NULL);
2587 init_timer(&hcd->rh_timer);
2588 hcd->rh_timer.function = rh_timer_func;
2589 hcd->rh_timer.data = (unsigned long) hcd;
2591 INIT_WORK(&hcd->wakeup_work, hcd_resume_work);
2594 hcd->driver = driver;
2595 hcd->speed = driver->flags & HCD_MASK;
2596 hcd->product_desc = (driver->product_desc) ? driver->product_desc :
2597 "USB Host Controller";
2600 EXPORT_SYMBOL_GPL(usb_create_shared_hcd);
2603 * usb_create_hcd - create and initialize an HCD structure
2604 * @driver: HC driver that will use this hcd
2605 * @dev: device for this HC, stored in hcd->self.controller
2606 * @bus_name: value to store in hcd->self.bus_name
2607 * Context: !in_interrupt()
2609 * Allocate a struct usb_hcd, with extra space at the end for the
2610 * HC driver's private data. Initialize the generic members of the
2613 * Return: On success, a pointer to the created and initialized HCD
2614 * structure. On failure (e.g. if memory is unavailable), %NULL.
2616 struct usb_hcd *usb_create_hcd(const struct hc_driver *driver,
2617 struct device *dev, const char *bus_name)
2619 return usb_create_shared_hcd(driver, dev, bus_name, NULL);
2621 EXPORT_SYMBOL_GPL(usb_create_hcd);
2624 * Roothubs that share one PCI device must also share the bandwidth mutex.
2625 * Don't deallocate the bandwidth_mutex until the last shared usb_hcd is
2628 * Make sure to deallocate the bandwidth_mutex only when the last HCD is
2629 * freed. When hcd_release() is called for either hcd in a peer set,
2630 * invalidate the peer's ->shared_hcd and ->primary_hcd pointers.
2632 static void hcd_release(struct kref *kref)
2634 struct usb_hcd *hcd = container_of (kref, struct usb_hcd, kref);
2636 mutex_lock(&usb_port_peer_mutex);
2637 if (hcd->shared_hcd) {
2638 struct usb_hcd *peer = hcd->shared_hcd;
2640 peer->shared_hcd = NULL;
2641 peer->primary_hcd = NULL;
2643 kfree(hcd->address0_mutex);
2644 kfree(hcd->bandwidth_mutex);
2646 mutex_unlock(&usb_port_peer_mutex);
2650 struct usb_hcd *usb_get_hcd (struct usb_hcd *hcd)
2653 kref_get (&hcd->kref);
2656 EXPORT_SYMBOL_GPL(usb_get_hcd);
2658 void usb_put_hcd (struct usb_hcd *hcd)
2661 kref_put (&hcd->kref, hcd_release);
2663 EXPORT_SYMBOL_GPL(usb_put_hcd);
2665 int usb_hcd_is_primary_hcd(struct usb_hcd *hcd)
2667 if (!hcd->primary_hcd)
2669 return hcd == hcd->primary_hcd;
2671 EXPORT_SYMBOL_GPL(usb_hcd_is_primary_hcd);
2673 int usb_hcd_find_raw_port_number(struct usb_hcd *hcd, int port1)
2675 if (!hcd->driver->find_raw_port_number)
2678 return hcd->driver->find_raw_port_number(hcd, port1);
2681 static int usb_hcd_request_irqs(struct usb_hcd *hcd,
2682 unsigned int irqnum, unsigned long irqflags)
2686 if (hcd->driver->irq) {
2688 snprintf(hcd->irq_descr, sizeof(hcd->irq_descr), "%s:usb%d",
2689 hcd->driver->description, hcd->self.busnum);
2690 retval = request_irq(irqnum, &usb_hcd_irq, irqflags,
2691 hcd->irq_descr, hcd);
2693 dev_err(hcd->self.controller,
2694 "request interrupt %d failed\n",
2699 dev_info(hcd->self.controller, "irq %d, %s 0x%08llx\n", irqnum,
2700 (hcd->driver->flags & HCD_MEMORY) ?
2701 "io mem" : "io base",
2702 (unsigned long long)hcd->rsrc_start);
2705 if (hcd->rsrc_start)
2706 dev_info(hcd->self.controller, "%s 0x%08llx\n",
2707 (hcd->driver->flags & HCD_MEMORY) ?
2708 "io mem" : "io base",
2709 (unsigned long long)hcd->rsrc_start);
2715 * Before we free this root hub, flush in-flight peering attempts
2716 * and disable peer lookups
2718 static void usb_put_invalidate_rhdev(struct usb_hcd *hcd)
2720 struct usb_device *rhdev;
2722 mutex_lock(&usb_port_peer_mutex);
2723 rhdev = hcd->self.root_hub;
2724 hcd->self.root_hub = NULL;
2725 mutex_unlock(&usb_port_peer_mutex);
2730 * usb_add_hcd - finish generic HCD structure initialization and register
2731 * @hcd: the usb_hcd structure to initialize
2732 * @irqnum: Interrupt line to allocate
2733 * @irqflags: Interrupt type flags
2735 * Finish the remaining parts of generic HCD initialization: allocate the
2736 * buffers of consistent memory, register the bus, request the IRQ line,
2737 * and call the driver's reset() and start() routines.
2739 int usb_add_hcd(struct usb_hcd *hcd,
2740 unsigned int irqnum, unsigned long irqflags)
2743 struct usb_device *rhdev;
2745 if (IS_ENABLED(CONFIG_USB_PHY) && !hcd->usb_phy) {
2746 struct usb_phy *phy = usb_get_phy_dev(hcd->self.controller, 0);
2749 retval = PTR_ERR(phy);
2750 if (retval == -EPROBE_DEFER)
2753 retval = usb_phy_init(phy);
2759 hcd->remove_phy = 1;
2763 if (IS_ENABLED(CONFIG_GENERIC_PHY) && !hcd->phy) {
2764 struct phy *phy = phy_get(hcd->self.controller, "usb");
2767 retval = PTR_ERR(phy);
2768 if (retval == -EPROBE_DEFER)
2771 retval = phy_init(phy);
2776 retval = phy_power_on(phy);
2783 hcd->remove_phy = 1;
2787 dev_info(hcd->self.controller, "%s\n", hcd->product_desc);
2789 /* Keep old behaviour if authorized_default is not in [0, 1]. */
2790 if (authorized_default < 0 || authorized_default > 1) {
2792 clear_bit(HCD_FLAG_DEV_AUTHORIZED, &hcd->flags);
2794 set_bit(HCD_FLAG_DEV_AUTHORIZED, &hcd->flags);
2796 if (authorized_default)
2797 set_bit(HCD_FLAG_DEV_AUTHORIZED, &hcd->flags);
2799 clear_bit(HCD_FLAG_DEV_AUTHORIZED, &hcd->flags);
2801 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
2803 /* per default all interfaces are authorized */
2804 set_bit(HCD_FLAG_INTF_AUTHORIZED, &hcd->flags);
2806 /* HC is in reset state, but accessible. Now do the one-time init,
2807 * bottom up so that hcds can customize the root hubs before hub_wq
2808 * starts talking to them. (Note, bus id is assigned early too.)
2810 retval = hcd_buffer_create(hcd);
2812 dev_dbg(hcd->self.controller, "pool alloc failed\n");
2813 goto err_create_buf;
2816 retval = usb_register_bus(&hcd->self);
2818 goto err_register_bus;
2820 rhdev = usb_alloc_dev(NULL, &hcd->self, 0);
2821 if (rhdev == NULL) {
2822 dev_err(hcd->self.controller, "unable to allocate root hub\n");
2824 goto err_allocate_root_hub;
2826 mutex_lock(&usb_port_peer_mutex);
2827 hcd->self.root_hub = rhdev;
2828 mutex_unlock(&usb_port_peer_mutex);
2830 switch (hcd->speed) {
2832 rhdev->speed = USB_SPEED_FULL;
2835 rhdev->speed = USB_SPEED_HIGH;
2838 rhdev->speed = USB_SPEED_WIRELESS;
2841 rhdev->speed = USB_SPEED_SUPER;
2844 rhdev->speed = USB_SPEED_SUPER_PLUS;
2848 goto err_set_rh_speed;
2851 /* wakeup flag init defaults to "everything works" for root hubs,
2852 * but drivers can override it in reset() if needed, along with
2853 * recording the overall controller's system wakeup capability.
2855 device_set_wakeup_capable(&rhdev->dev, 1);
2857 /* HCD_FLAG_RH_RUNNING doesn't matter until the root hub is
2858 * registered. But since the controller can die at any time,
2859 * let's initialize the flag before touching the hardware.
2861 set_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2863 /* "reset" is misnamed; its role is now one-time init. the controller
2864 * should already have been reset (and boot firmware kicked off etc).
2866 if (hcd->driver->reset) {
2867 retval = hcd->driver->reset(hcd);
2869 dev_err(hcd->self.controller, "can't setup: %d\n",
2871 goto err_hcd_driver_setup;
2874 hcd->rh_pollable = 1;
2876 /* NOTE: root hub and controller capabilities may not be the same */
2877 if (device_can_wakeup(hcd->self.controller)
2878 && device_can_wakeup(&hcd->self.root_hub->dev))
2879 dev_dbg(hcd->self.controller, "supports USB remote wakeup\n");
2881 /* initialize tasklets */
2882 init_giveback_urb_bh(&hcd->high_prio_bh);
2883 init_giveback_urb_bh(&hcd->low_prio_bh);
2885 /* enable irqs just before we start the controller,
2886 * if the BIOS provides legacy PCI irqs.
2888 if (usb_hcd_is_primary_hcd(hcd) && irqnum) {
2889 retval = usb_hcd_request_irqs(hcd, irqnum, irqflags);
2891 goto err_request_irq;
2894 hcd->state = HC_STATE_RUNNING;
2895 retval = hcd->driver->start(hcd);
2897 dev_err(hcd->self.controller, "startup error %d\n", retval);
2898 goto err_hcd_driver_start;
2901 /* starting here, usbcore will pay attention to this root hub */
2902 retval = register_root_hub(hcd);
2904 goto err_register_root_hub;
2906 retval = sysfs_create_group(&rhdev->dev.kobj, &usb_bus_attr_group);
2908 printk(KERN_ERR "Cannot register USB bus sysfs attributes: %d\n",
2910 goto error_create_attr_group;
2912 if (hcd->uses_new_polling && HCD_POLL_RH(hcd))
2913 usb_hcd_poll_rh_status(hcd);
2917 error_create_attr_group:
2918 clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2919 if (HC_IS_RUNNING(hcd->state))
2920 hcd->state = HC_STATE_QUIESCING;
2921 spin_lock_irq(&hcd_root_hub_lock);
2922 hcd->rh_registered = 0;
2923 spin_unlock_irq(&hcd_root_hub_lock);
2926 cancel_work_sync(&hcd->wakeup_work);
2928 mutex_lock(&usb_bus_idr_lock);
2929 usb_disconnect(&rhdev); /* Sets rhdev to NULL */
2930 mutex_unlock(&usb_bus_idr_lock);
2931 err_register_root_hub:
2932 hcd->rh_pollable = 0;
2933 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2934 del_timer_sync(&hcd->rh_timer);
2935 hcd->driver->stop(hcd);
2936 hcd->state = HC_STATE_HALT;
2937 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2938 del_timer_sync(&hcd->rh_timer);
2939 err_hcd_driver_start:
2940 if (usb_hcd_is_primary_hcd(hcd) && hcd->irq > 0)
2941 free_irq(irqnum, hcd);
2943 err_hcd_driver_setup:
2945 usb_put_invalidate_rhdev(hcd);
2946 err_allocate_root_hub:
2947 usb_deregister_bus(&hcd->self);
2949 hcd_buffer_destroy(hcd);
2951 if (IS_ENABLED(CONFIG_GENERIC_PHY) && hcd->remove_phy && hcd->phy) {
2952 phy_power_off(hcd->phy);
2958 if (hcd->remove_phy && hcd->usb_phy) {
2959 usb_phy_shutdown(hcd->usb_phy);
2960 usb_put_phy(hcd->usb_phy);
2961 hcd->usb_phy = NULL;
2965 EXPORT_SYMBOL_GPL(usb_add_hcd);
2968 * usb_remove_hcd - shutdown processing for generic HCDs
2969 * @hcd: the usb_hcd structure to remove
2970 * Context: !in_interrupt()
2972 * Disconnects the root hub, then reverses the effects of usb_add_hcd(),
2973 * invoking the HCD's stop() method.
2975 void usb_remove_hcd(struct usb_hcd *hcd)
2977 struct usb_device *rhdev = hcd->self.root_hub;
2979 dev_info(hcd->self.controller, "remove, state %x\n", hcd->state);
2982 sysfs_remove_group(&rhdev->dev.kobj, &usb_bus_attr_group);
2984 clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2985 if (HC_IS_RUNNING (hcd->state))
2986 hcd->state = HC_STATE_QUIESCING;
2988 dev_dbg(hcd->self.controller, "roothub graceful disconnect\n");
2989 spin_lock_irq (&hcd_root_hub_lock);
2990 hcd->rh_registered = 0;
2991 spin_unlock_irq (&hcd_root_hub_lock);
2994 cancel_work_sync(&hcd->wakeup_work);
2997 mutex_lock(&usb_bus_idr_lock);
2998 usb_disconnect(&rhdev); /* Sets rhdev to NULL */
2999 mutex_unlock(&usb_bus_idr_lock);
3002 * tasklet_kill() isn't needed here because:
3003 * - driver's disconnect() called from usb_disconnect() should
3004 * make sure its URBs are completed during the disconnect()
3007 * - it is too late to run complete() here since driver may have
3008 * been removed already now
3011 /* Prevent any more root-hub status calls from the timer.
3012 * The HCD might still restart the timer (if a port status change
3013 * interrupt occurs), but usb_hcd_poll_rh_status() won't invoke
3014 * the hub_status_data() callback.
3016 hcd->rh_pollable = 0;
3017 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
3018 del_timer_sync(&hcd->rh_timer);
3020 hcd->driver->stop(hcd);
3021 hcd->state = HC_STATE_HALT;
3023 /* In case the HCD restarted the timer, stop it again. */
3024 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
3025 del_timer_sync(&hcd->rh_timer);
3027 if (usb_hcd_is_primary_hcd(hcd)) {
3029 free_irq(hcd->irq, hcd);
3032 usb_deregister_bus(&hcd->self);
3033 hcd_buffer_destroy(hcd);
3035 if (IS_ENABLED(CONFIG_GENERIC_PHY) && hcd->remove_phy && hcd->phy) {
3036 phy_power_off(hcd->phy);
3041 if (hcd->remove_phy && hcd->usb_phy) {
3042 usb_phy_shutdown(hcd->usb_phy);
3043 usb_put_phy(hcd->usb_phy);
3044 hcd->usb_phy = NULL;
3047 usb_put_invalidate_rhdev(hcd);
3050 EXPORT_SYMBOL_GPL(usb_remove_hcd);
3053 usb_hcd_platform_shutdown(struct platform_device *dev)
3055 struct usb_hcd *hcd = platform_get_drvdata(dev);
3057 /* No need for pm_runtime_put(), we're shutting down */
3058 pm_runtime_get_sync(&dev->dev);
3060 if (hcd->driver->shutdown)
3061 hcd->driver->shutdown(hcd);
3063 EXPORT_SYMBOL_GPL(usb_hcd_platform_shutdown);
3065 /*-------------------------------------------------------------------------*/
3067 #if IS_ENABLED(CONFIG_USB_MON)
3069 const struct usb_mon_operations *mon_ops;
3072 * The registration is unlocked.
3073 * We do it this way because we do not want to lock in hot paths.
3075 * Notice that the code is minimally error-proof. Because usbmon needs
3076 * symbols from usbcore, usbcore gets referenced and cannot be unloaded first.
3079 int usb_mon_register(const struct usb_mon_operations *ops)
3089 EXPORT_SYMBOL_GPL (usb_mon_register);
3091 void usb_mon_deregister (void)
3094 if (mon_ops == NULL) {
3095 printk(KERN_ERR "USB: monitor was not registered\n");
3101 EXPORT_SYMBOL_GPL (usb_mon_deregister);
3103 #endif /* CONFIG_USB_MON || CONFIG_USB_MON_MODULE */