1 // SPDX-License-Identifier: GPL-2.0
5 * (C) Copyright 1999 Linus Torvalds
6 * (C) Copyright 1999 Johannes Erdfelt
7 * (C) Copyright 1999 Gregory P. Smith
8 * (C) Copyright 2001 Brad Hards (bhards@bigpond.net.au)
10 * Released under the GPLv2 only.
13 #include <linux/kernel.h>
14 #include <linux/errno.h>
15 #include <linux/module.h>
16 #include <linux/moduleparam.h>
17 #include <linux/completion.h>
18 #include <linux/sched/mm.h>
19 #include <linux/list.h>
20 #include <linux/slab.h>
21 #include <linux/kcov.h>
22 #include <linux/ioctl.h>
23 #include <linux/usb.h>
24 #include <linux/usbdevice_fs.h>
25 #include <linux/usb/hcd.h>
26 #include <linux/usb/otg.h>
27 #include <linux/usb/quirks.h>
28 #include <linux/workqueue.h>
29 #include <linux/mutex.h>
30 #include <linux/random.h>
31 #include <linux/pm_qos.h>
32 #include <linux/kobject.h>
34 #include <linux/bitfield.h>
35 #include <linux/uaccess.h>
36 #include <asm/byteorder.h>
39 #include "otg_productlist.h"
41 #define USB_VENDOR_GENESYS_LOGIC 0x05e3
42 #define USB_VENDOR_SMSC 0x0424
43 #define USB_PRODUCT_USB5534B 0x5534
44 #define HUB_QUIRK_CHECK_PORT_AUTOSUSPEND 0x01
45 #define HUB_QUIRK_DISABLE_AUTOSUSPEND 0x02
47 #define USB_TP_TRANSMISSION_DELAY 40 /* ns */
48 #define USB_TP_TRANSMISSION_DELAY_MAX 65535 /* ns */
50 /* Protect struct usb_device->state and ->children members
51 * Note: Both are also protected by ->dev.sem, except that ->state can
52 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
53 static DEFINE_SPINLOCK(device_state_lock);
55 /* workqueue to process hub events */
56 static struct workqueue_struct *hub_wq;
57 static void hub_event(struct work_struct *work);
59 /* synchronize hub-port add/remove and peering operations */
60 DEFINE_MUTEX(usb_port_peer_mutex);
62 /* cycle leds on hubs that aren't blinking for attention */
63 static bool blinkenlights;
64 module_param(blinkenlights, bool, S_IRUGO);
65 MODULE_PARM_DESC(blinkenlights, "true to cycle leds on hubs");
68 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
69 * 10 seconds to send reply for the initial 64-byte descriptor request.
71 /* define initial 64-byte descriptor request timeout in milliseconds */
72 static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
73 module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
74 MODULE_PARM_DESC(initial_descriptor_timeout,
75 "initial 64-byte descriptor request timeout in milliseconds "
76 "(default 5000 - 5.0 seconds)");
79 * As of 2.6.10 we introduce a new USB device initialization scheme which
80 * closely resembles the way Windows works. Hopefully it will be compatible
81 * with a wider range of devices than the old scheme. However some previously
82 * working devices may start giving rise to "device not accepting address"
83 * errors; if that happens the user can try the old scheme by adjusting the
84 * following module parameters.
86 * For maximum flexibility there are two boolean parameters to control the
87 * hub driver's behavior. On the first initialization attempt, if the
88 * "old_scheme_first" parameter is set then the old scheme will be used,
89 * otherwise the new scheme is used. If that fails and "use_both_schemes"
90 * is set, then the driver will make another attempt, using the other scheme.
92 static bool old_scheme_first;
93 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
94 MODULE_PARM_DESC(old_scheme_first,
95 "start with the old device initialization scheme");
97 static bool use_both_schemes = true;
98 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
99 MODULE_PARM_DESC(use_both_schemes,
100 "try the other device initialization scheme if the "
103 /* Mutual exclusion for EHCI CF initialization. This interferes with
104 * port reset on some companion controllers.
106 DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
107 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
109 #define HUB_DEBOUNCE_TIMEOUT 2000
110 #define HUB_DEBOUNCE_STEP 25
111 #define HUB_DEBOUNCE_STABLE 100
113 static void hub_release(struct kref *kref);
114 static int usb_reset_and_verify_device(struct usb_device *udev);
115 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state);
116 static bool hub_port_warm_reset_required(struct usb_hub *hub, int port1,
119 static inline char *portspeed(struct usb_hub *hub, int portstatus)
121 if (hub_is_superspeedplus(hub->hdev))
123 if (hub_is_superspeed(hub->hdev))
125 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
127 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
133 /* Note that hdev or one of its children must be locked! */
134 struct usb_hub *usb_hub_to_struct_hub(struct usb_device *hdev)
136 if (!hdev || !hdev->actconfig || !hdev->maxchild)
138 return usb_get_intfdata(hdev->actconfig->interface[0]);
141 int usb_device_supports_lpm(struct usb_device *udev)
143 /* Some devices have trouble with LPM */
144 if (udev->quirks & USB_QUIRK_NO_LPM)
147 /* USB 2.1 (and greater) devices indicate LPM support through
148 * their USB 2.0 Extended Capabilities BOS descriptor.
150 if (udev->speed == USB_SPEED_HIGH || udev->speed == USB_SPEED_FULL) {
151 if (udev->bos->ext_cap &&
153 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
159 * According to the USB 3.0 spec, all USB 3.0 devices must support LPM.
160 * However, there are some that don't, and they set the U1/U2 exit
163 if (!udev->bos->ss_cap) {
164 dev_info(&udev->dev, "No LPM exit latency info found, disabling LPM.\n");
168 if (udev->bos->ss_cap->bU1devExitLat == 0 &&
169 udev->bos->ss_cap->bU2DevExitLat == 0) {
171 dev_info(&udev->dev, "LPM exit latency is zeroed, disabling LPM.\n");
173 dev_info(&udev->dev, "We don't know the algorithms for LPM for this host, disabling LPM.\n");
177 if (!udev->parent || udev->parent->lpm_capable)
183 * Set the Maximum Exit Latency (MEL) for the host to initiate a transition from
186 static void usb_set_lpm_mel(struct usb_device *udev,
187 struct usb3_lpm_parameters *udev_lpm_params,
188 unsigned int udev_exit_latency,
190 struct usb3_lpm_parameters *hub_lpm_params,
191 unsigned int hub_exit_latency)
193 unsigned int total_mel;
194 unsigned int device_mel;
195 unsigned int hub_mel;
198 * Calculate the time it takes to transition all links from the roothub
199 * to the parent hub into U0. The parent hub must then decode the
200 * packet (hub header decode latency) to figure out which port it was
203 * The Hub Header decode latency is expressed in 0.1us intervals (0x1
204 * means 0.1us). Multiply that by 100 to get nanoseconds.
206 total_mel = hub_lpm_params->mel +
207 (hub->descriptor->u.ss.bHubHdrDecLat * 100);
210 * How long will it take to transition the downstream hub's port into
211 * U0? The greater of either the hub exit latency or the device exit
214 * The BOS U1/U2 exit latencies are expressed in 1us intervals.
215 * Multiply that by 1000 to get nanoseconds.
217 device_mel = udev_exit_latency * 1000;
218 hub_mel = hub_exit_latency * 1000;
219 if (device_mel > hub_mel)
220 total_mel += device_mel;
222 total_mel += hub_mel;
224 udev_lpm_params->mel = total_mel;
228 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
229 * a transition from either U1 or U2.
231 static void usb_set_lpm_pel(struct usb_device *udev,
232 struct usb3_lpm_parameters *udev_lpm_params,
233 unsigned int udev_exit_latency,
235 struct usb3_lpm_parameters *hub_lpm_params,
236 unsigned int hub_exit_latency,
237 unsigned int port_to_port_exit_latency)
239 unsigned int first_link_pel;
240 unsigned int hub_pel;
243 * First, the device sends an LFPS to transition the link between the
244 * device and the parent hub into U0. The exit latency is the bigger of
245 * the device exit latency or the hub exit latency.
247 if (udev_exit_latency > hub_exit_latency)
248 first_link_pel = udev_exit_latency * 1000;
250 first_link_pel = hub_exit_latency * 1000;
253 * When the hub starts to receive the LFPS, there is a slight delay for
254 * it to figure out that one of the ports is sending an LFPS. Then it
255 * will forward the LFPS to its upstream link. The exit latency is the
256 * delay, plus the PEL that we calculated for this hub.
258 hub_pel = port_to_port_exit_latency * 1000 + hub_lpm_params->pel;
261 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
262 * is the greater of the two exit latencies.
264 if (first_link_pel > hub_pel)
265 udev_lpm_params->pel = first_link_pel;
267 udev_lpm_params->pel = hub_pel;
271 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
272 * when a device initiates a transition to U0, until when it will receive the
273 * first packet from the host controller.
275 * Section C.1.5.1 describes the four components to this:
277 * - t2: time for the ERDY to make it from the device to the host.
278 * - t3: a host-specific delay to process the ERDY.
279 * - t4: time for the packet to make it from the host to the device.
281 * t3 is specific to both the xHCI host and the platform the host is integrated
282 * into. The Intel HW folks have said it's negligible, FIXME if a different
283 * vendor says otherwise.
285 static void usb_set_lpm_sel(struct usb_device *udev,
286 struct usb3_lpm_parameters *udev_lpm_params)
288 struct usb_device *parent;
289 unsigned int num_hubs;
290 unsigned int total_sel;
292 /* t1 = device PEL */
293 total_sel = udev_lpm_params->pel;
294 /* How many external hubs are in between the device & the root port. */
295 for (parent = udev->parent, num_hubs = 0; parent->parent;
296 parent = parent->parent)
298 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
300 total_sel += 2100 + 250 * (num_hubs - 1);
302 /* t4 = 250ns * num_hubs */
303 total_sel += 250 * num_hubs;
305 udev_lpm_params->sel = total_sel;
308 static void usb_set_lpm_parameters(struct usb_device *udev)
311 unsigned int port_to_port_delay;
312 unsigned int udev_u1_del;
313 unsigned int udev_u2_del;
314 unsigned int hub_u1_del;
315 unsigned int hub_u2_del;
317 if (!udev->lpm_capable || udev->speed < USB_SPEED_SUPER)
320 hub = usb_hub_to_struct_hub(udev->parent);
321 /* It doesn't take time to transition the roothub into U0, since it
322 * doesn't have an upstream link.
327 udev_u1_del = udev->bos->ss_cap->bU1devExitLat;
328 udev_u2_del = le16_to_cpu(udev->bos->ss_cap->bU2DevExitLat);
329 hub_u1_del = udev->parent->bos->ss_cap->bU1devExitLat;
330 hub_u2_del = le16_to_cpu(udev->parent->bos->ss_cap->bU2DevExitLat);
332 usb_set_lpm_mel(udev, &udev->u1_params, udev_u1_del,
333 hub, &udev->parent->u1_params, hub_u1_del);
335 usb_set_lpm_mel(udev, &udev->u2_params, udev_u2_del,
336 hub, &udev->parent->u2_params, hub_u2_del);
339 * Appendix C, section C.2.2.2, says that there is a slight delay from
340 * when the parent hub notices the downstream port is trying to
341 * transition to U0 to when the hub initiates a U0 transition on its
342 * upstream port. The section says the delays are tPort2PortU1EL and
343 * tPort2PortU2EL, but it doesn't define what they are.
345 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
346 * about the same delays. Use the maximum delay calculations from those
347 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
348 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
349 * assume the device exit latencies they are talking about are the hub
352 * What do we do if the U2 exit latency is less than the U1 exit
353 * latency? It's possible, although not likely...
355 port_to_port_delay = 1;
357 usb_set_lpm_pel(udev, &udev->u1_params, udev_u1_del,
358 hub, &udev->parent->u1_params, hub_u1_del,
361 if (hub_u2_del > hub_u1_del)
362 port_to_port_delay = 1 + hub_u2_del - hub_u1_del;
364 port_to_port_delay = 1 + hub_u1_del;
366 usb_set_lpm_pel(udev, &udev->u2_params, udev_u2_del,
367 hub, &udev->parent->u2_params, hub_u2_del,
370 /* Now that we've got PEL, calculate SEL. */
371 usb_set_lpm_sel(udev, &udev->u1_params);
372 usb_set_lpm_sel(udev, &udev->u2_params);
375 /* USB 2.0 spec Section 11.24.4.5 */
376 static int get_hub_descriptor(struct usb_device *hdev,
377 struct usb_hub_descriptor *desc)
382 if (hub_is_superspeed(hdev)) {
383 dtype = USB_DT_SS_HUB;
384 size = USB_DT_SS_HUB_SIZE;
387 size = sizeof(struct usb_hub_descriptor);
390 for (i = 0; i < 3; i++) {
391 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
392 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
393 dtype << 8, 0, desc, size,
394 USB_CTRL_GET_TIMEOUT);
395 if (hub_is_superspeed(hdev)) {
398 } else if (ret >= USB_DT_HUB_NONVAR_SIZE + 2) {
399 /* Make sure we have the DeviceRemovable field. */
400 size = USB_DT_HUB_NONVAR_SIZE + desc->bNbrPorts / 8 + 1;
410 * USB 2.0 spec Section 11.24.2.1
412 static int clear_hub_feature(struct usb_device *hdev, int feature)
414 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
415 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
419 * USB 2.0 spec Section 11.24.2.2
421 int usb_clear_port_feature(struct usb_device *hdev, int port1, int feature)
423 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
424 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
429 * USB 2.0 spec Section 11.24.2.13
431 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
433 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
434 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
438 static char *to_led_name(int selector)
455 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
456 * for info about using port indicators
458 static void set_port_led(struct usb_hub *hub, int port1, int selector)
460 struct usb_port *port_dev = hub->ports[port1 - 1];
463 status = set_port_feature(hub->hdev, (selector << 8) | port1,
464 USB_PORT_FEAT_INDICATOR);
465 dev_dbg(&port_dev->dev, "indicator %s status %d\n",
466 to_led_name(selector), status);
469 #define LED_CYCLE_PERIOD ((2*HZ)/3)
471 static void led_work(struct work_struct *work)
473 struct usb_hub *hub =
474 container_of(work, struct usb_hub, leds.work);
475 struct usb_device *hdev = hub->hdev;
477 unsigned changed = 0;
480 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
483 for (i = 0; i < hdev->maxchild; i++) {
484 unsigned selector, mode;
486 /* 30%-50% duty cycle */
488 switch (hub->indicator[i]) {
490 case INDICATOR_CYCLE:
492 selector = HUB_LED_AUTO;
493 mode = INDICATOR_AUTO;
495 /* blinking green = sw attention */
496 case INDICATOR_GREEN_BLINK:
497 selector = HUB_LED_GREEN;
498 mode = INDICATOR_GREEN_BLINK_OFF;
500 case INDICATOR_GREEN_BLINK_OFF:
501 selector = HUB_LED_OFF;
502 mode = INDICATOR_GREEN_BLINK;
504 /* blinking amber = hw attention */
505 case INDICATOR_AMBER_BLINK:
506 selector = HUB_LED_AMBER;
507 mode = INDICATOR_AMBER_BLINK_OFF;
509 case INDICATOR_AMBER_BLINK_OFF:
510 selector = HUB_LED_OFF;
511 mode = INDICATOR_AMBER_BLINK;
513 /* blink green/amber = reserved */
514 case INDICATOR_ALT_BLINK:
515 selector = HUB_LED_GREEN;
516 mode = INDICATOR_ALT_BLINK_OFF;
518 case INDICATOR_ALT_BLINK_OFF:
519 selector = HUB_LED_AMBER;
520 mode = INDICATOR_ALT_BLINK;
525 if (selector != HUB_LED_AUTO)
527 set_port_led(hub, i + 1, selector);
528 hub->indicator[i] = mode;
530 if (!changed && blinkenlights) {
532 cursor %= hdev->maxchild;
533 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
534 hub->indicator[cursor] = INDICATOR_CYCLE;
538 queue_delayed_work(system_power_efficient_wq,
539 &hub->leds, LED_CYCLE_PERIOD);
542 /* use a short timeout for hub/port status fetches */
543 #define USB_STS_TIMEOUT 1000
544 #define USB_STS_RETRIES 5
547 * USB 2.0 spec Section 11.24.2.6
549 static int get_hub_status(struct usb_device *hdev,
550 struct usb_hub_status *data)
552 int i, status = -ETIMEDOUT;
554 for (i = 0; i < USB_STS_RETRIES &&
555 (status == -ETIMEDOUT || status == -EPIPE); i++) {
556 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
557 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
558 data, sizeof(*data), USB_STS_TIMEOUT);
564 * USB 2.0 spec Section 11.24.2.7
565 * USB 3.1 takes into use the wValue and wLength fields, spec Section 10.16.2.6
567 static int get_port_status(struct usb_device *hdev, int port1,
568 void *data, u16 value, u16 length)
570 int i, status = -ETIMEDOUT;
572 for (i = 0; i < USB_STS_RETRIES &&
573 (status == -ETIMEDOUT || status == -EPIPE); i++) {
574 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
575 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, value,
576 port1, data, length, USB_STS_TIMEOUT);
581 static int hub_ext_port_status(struct usb_hub *hub, int port1, int type,
582 u16 *status, u16 *change, u32 *ext_status)
587 if (type != HUB_PORT_STATUS)
590 mutex_lock(&hub->status_mutex);
591 ret = get_port_status(hub->hdev, port1, &hub->status->port, type, len);
594 dev_err(hub->intfdev,
595 "%s failed (err = %d)\n", __func__, ret);
599 *status = le16_to_cpu(hub->status->port.wPortStatus);
600 *change = le16_to_cpu(hub->status->port.wPortChange);
601 if (type != HUB_PORT_STATUS && ext_status)
602 *ext_status = le32_to_cpu(
603 hub->status->port.dwExtPortStatus);
606 mutex_unlock(&hub->status_mutex);
610 static int hub_port_status(struct usb_hub *hub, int port1,
611 u16 *status, u16 *change)
613 return hub_ext_port_status(hub, port1, HUB_PORT_STATUS,
614 status, change, NULL);
617 static void hub_resubmit_irq_urb(struct usb_hub *hub)
622 spin_lock_irqsave(&hub->irq_urb_lock, flags);
624 if (hub->quiescing) {
625 spin_unlock_irqrestore(&hub->irq_urb_lock, flags);
629 status = usb_submit_urb(hub->urb, GFP_ATOMIC);
630 if (status && status != -ENODEV && status != -EPERM &&
631 status != -ESHUTDOWN) {
632 dev_err(hub->intfdev, "resubmit --> %d\n", status);
633 mod_timer(&hub->irq_urb_retry, jiffies + HZ);
636 spin_unlock_irqrestore(&hub->irq_urb_lock, flags);
639 static void hub_retry_irq_urb(struct timer_list *t)
641 struct usb_hub *hub = from_timer(hub, t, irq_urb_retry);
643 hub_resubmit_irq_urb(hub);
647 static void kick_hub_wq(struct usb_hub *hub)
649 struct usb_interface *intf;
651 if (hub->disconnected || work_pending(&hub->events))
655 * Suppress autosuspend until the event is proceed.
657 * Be careful and make sure that the symmetric operation is
658 * always called. We are here only when there is no pending
659 * work for this hub. Therefore put the interface either when
660 * the new work is called or when it is canceled.
662 intf = to_usb_interface(hub->intfdev);
663 usb_autopm_get_interface_no_resume(intf);
664 kref_get(&hub->kref);
666 if (queue_work(hub_wq, &hub->events))
669 /* the work has already been scheduled */
670 usb_autopm_put_interface_async(intf);
671 kref_put(&hub->kref, hub_release);
674 void usb_kick_hub_wq(struct usb_device *hdev)
676 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
683 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
684 * Notification, which indicates it had initiated remote wakeup.
686 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
687 * device initiates resume, so the USB core will not receive notice of the
688 * resume through the normal hub interrupt URB.
690 void usb_wakeup_notification(struct usb_device *hdev,
691 unsigned int portnum)
694 struct usb_port *port_dev;
699 hub = usb_hub_to_struct_hub(hdev);
701 port_dev = hub->ports[portnum - 1];
702 if (port_dev && port_dev->child)
703 pm_wakeup_event(&port_dev->child->dev, 0);
705 set_bit(portnum, hub->wakeup_bits);
709 EXPORT_SYMBOL_GPL(usb_wakeup_notification);
711 /* completion function, fires on port status changes and various faults */
712 static void hub_irq(struct urb *urb)
714 struct usb_hub *hub = urb->context;
715 int status = urb->status;
720 case -ENOENT: /* synchronous unlink */
721 case -ECONNRESET: /* async unlink */
722 case -ESHUTDOWN: /* hardware going away */
725 default: /* presumably an error */
726 /* Cause a hub reset after 10 consecutive errors */
727 dev_dbg(hub->intfdev, "transfer --> %d\n", status);
728 if ((++hub->nerrors < 10) || hub->error)
733 /* let hub_wq handle things */
734 case 0: /* we got data: port status changed */
736 for (i = 0; i < urb->actual_length; ++i)
737 bits |= ((unsigned long) ((*hub->buffer)[i]))
739 hub->event_bits[0] = bits;
745 /* Something happened, let hub_wq figure it out */
749 hub_resubmit_irq_urb(hub);
752 /* USB 2.0 spec Section 11.24.2.3 */
754 hub_clear_tt_buffer(struct usb_device *hdev, u16 devinfo, u16 tt)
756 /* Need to clear both directions for control ep */
757 if (((devinfo >> 11) & USB_ENDPOINT_XFERTYPE_MASK) ==
758 USB_ENDPOINT_XFER_CONTROL) {
759 int status = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
760 HUB_CLEAR_TT_BUFFER, USB_RT_PORT,
761 devinfo ^ 0x8000, tt, NULL, 0, 1000);
765 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
766 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
771 * enumeration blocks hub_wq for a long time. we use keventd instead, since
772 * long blocking there is the exception, not the rule. accordingly, HCDs
773 * talking to TTs must queue control transfers (not just bulk and iso), so
774 * both can talk to the same hub concurrently.
776 static void hub_tt_work(struct work_struct *work)
778 struct usb_hub *hub =
779 container_of(work, struct usb_hub, tt.clear_work);
782 spin_lock_irqsave(&hub->tt.lock, flags);
783 while (!list_empty(&hub->tt.clear_list)) {
784 struct list_head *next;
785 struct usb_tt_clear *clear;
786 struct usb_device *hdev = hub->hdev;
787 const struct hc_driver *drv;
790 next = hub->tt.clear_list.next;
791 clear = list_entry(next, struct usb_tt_clear, clear_list);
792 list_del(&clear->clear_list);
794 /* drop lock so HCD can concurrently report other TT errors */
795 spin_unlock_irqrestore(&hub->tt.lock, flags);
796 status = hub_clear_tt_buffer(hdev, clear->devinfo, clear->tt);
797 if (status && status != -ENODEV)
799 "clear tt %d (%04x) error %d\n",
800 clear->tt, clear->devinfo, status);
802 /* Tell the HCD, even if the operation failed */
803 drv = clear->hcd->driver;
804 if (drv->clear_tt_buffer_complete)
805 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
808 spin_lock_irqsave(&hub->tt.lock, flags);
810 spin_unlock_irqrestore(&hub->tt.lock, flags);
814 * usb_hub_set_port_power - control hub port's power state
815 * @hdev: USB device belonging to the usb hub
818 * @set: expected status
820 * call this function to control port's power via setting or
821 * clearing the port's PORT_POWER feature.
823 * Return: 0 if successful. A negative error code otherwise.
825 int usb_hub_set_port_power(struct usb_device *hdev, struct usb_hub *hub,
831 ret = set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
833 ret = usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
839 set_bit(port1, hub->power_bits);
841 clear_bit(port1, hub->power_bits);
846 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
847 * @urb: an URB associated with the failed or incomplete split transaction
849 * High speed HCDs use this to tell the hub driver that some split control or
850 * bulk transaction failed in a way that requires clearing internal state of
851 * a transaction translator. This is normally detected (and reported) from
854 * It may not be possible for that hub to handle additional full (or low)
855 * speed transactions until that state is fully cleared out.
857 * Return: 0 if successful. A negative error code otherwise.
859 int usb_hub_clear_tt_buffer(struct urb *urb)
861 struct usb_device *udev = urb->dev;
862 int pipe = urb->pipe;
863 struct usb_tt *tt = udev->tt;
865 struct usb_tt_clear *clear;
867 /* we've got to cope with an arbitrary number of pending TT clears,
868 * since each TT has "at least two" buffers that can need it (and
869 * there can be many TTs per hub). even if they're uncommon.
871 clear = kmalloc(sizeof *clear, GFP_ATOMIC);
873 dev_err(&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
874 /* FIXME recover somehow ... RESET_TT? */
878 /* info that CLEAR_TT_BUFFER needs */
879 clear->tt = tt->multi ? udev->ttport : 1;
880 clear->devinfo = usb_pipeendpoint (pipe);
881 clear->devinfo |= ((u16)udev->devaddr) << 4;
882 clear->devinfo |= usb_pipecontrol(pipe)
883 ? (USB_ENDPOINT_XFER_CONTROL << 11)
884 : (USB_ENDPOINT_XFER_BULK << 11);
885 if (usb_pipein(pipe))
886 clear->devinfo |= 1 << 15;
888 /* info for completion callback */
889 clear->hcd = bus_to_hcd(udev->bus);
892 /* tell keventd to clear state for this TT */
893 spin_lock_irqsave(&tt->lock, flags);
894 list_add_tail(&clear->clear_list, &tt->clear_list);
895 schedule_work(&tt->clear_work);
896 spin_unlock_irqrestore(&tt->lock, flags);
899 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
901 static void hub_power_on(struct usb_hub *hub, bool do_delay)
905 /* Enable power on each port. Some hubs have reserved values
906 * of LPSM (> 2) in their descriptors, even though they are
907 * USB 2.0 hubs. Some hubs do not implement port-power switching
908 * but only emulate it. In all cases, the ports won't work
909 * unless we send these messages to the hub.
911 if (hub_is_port_power_switchable(hub))
912 dev_dbg(hub->intfdev, "enabling power on all ports\n");
914 dev_dbg(hub->intfdev, "trying to enable port power on "
915 "non-switchable hub\n");
916 for (port1 = 1; port1 <= hub->hdev->maxchild; port1++)
917 if (test_bit(port1, hub->power_bits))
918 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
920 usb_clear_port_feature(hub->hdev, port1,
921 USB_PORT_FEAT_POWER);
923 msleep(hub_power_on_good_delay(hub));
926 static int hub_hub_status(struct usb_hub *hub,
927 u16 *status, u16 *change)
931 mutex_lock(&hub->status_mutex);
932 ret = get_hub_status(hub->hdev, &hub->status->hub);
935 dev_err(hub->intfdev,
936 "%s failed (err = %d)\n", __func__, ret);
938 *status = le16_to_cpu(hub->status->hub.wHubStatus);
939 *change = le16_to_cpu(hub->status->hub.wHubChange);
942 mutex_unlock(&hub->status_mutex);
946 static int hub_set_port_link_state(struct usb_hub *hub, int port1,
947 unsigned int link_status)
949 return set_port_feature(hub->hdev,
950 port1 | (link_status << 3),
951 USB_PORT_FEAT_LINK_STATE);
955 * Disable a port and mark a logical connect-change event, so that some
956 * time later hub_wq will disconnect() any existing usb_device on the port
957 * and will re-enumerate if there actually is a device attached.
959 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
961 dev_dbg(&hub->ports[port1 - 1]->dev, "logical disconnect\n");
962 hub_port_disable(hub, port1, 1);
964 /* FIXME let caller ask to power down the port:
965 * - some devices won't enumerate without a VBUS power cycle
966 * - SRP saves power that way
967 * - ... new call, TBD ...
968 * That's easy if this hub can switch power per-port, and
969 * hub_wq reactivates the port later (timer, SRP, etc).
970 * Powerdown must be optional, because of reset/DFU.
973 set_bit(port1, hub->change_bits);
978 * usb_remove_device - disable a device's port on its parent hub
979 * @udev: device to be disabled and removed
980 * Context: @udev locked, must be able to sleep.
982 * After @udev's port has been disabled, hub_wq is notified and it will
983 * see that the device has been disconnected. When the device is
984 * physically unplugged and something is plugged in, the events will
985 * be received and processed normally.
987 * Return: 0 if successful. A negative error code otherwise.
989 int usb_remove_device(struct usb_device *udev)
992 struct usb_interface *intf;
995 if (!udev->parent) /* Can't remove a root hub */
997 hub = usb_hub_to_struct_hub(udev->parent);
998 intf = to_usb_interface(hub->intfdev);
1000 ret = usb_autopm_get_interface(intf);
1004 set_bit(udev->portnum, hub->removed_bits);
1005 hub_port_logical_disconnect(hub, udev->portnum);
1006 usb_autopm_put_interface(intf);
1010 enum hub_activation_type {
1011 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
1012 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
1015 static void hub_init_func2(struct work_struct *ws);
1016 static void hub_init_func3(struct work_struct *ws);
1018 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
1020 struct usb_device *hdev = hub->hdev;
1021 struct usb_hcd *hcd;
1025 bool need_debounce_delay = false;
1028 /* Continue a partial initialization */
1029 if (type == HUB_INIT2 || type == HUB_INIT3) {
1030 device_lock(&hdev->dev);
1032 /* Was the hub disconnected while we were waiting? */
1033 if (hub->disconnected)
1035 if (type == HUB_INIT2)
1039 kref_get(&hub->kref);
1041 /* The superspeed hub except for root hub has to use Hub Depth
1042 * value as an offset into the route string to locate the bits
1043 * it uses to determine the downstream port number. So hub driver
1044 * should send a set hub depth request to superspeed hub after
1045 * the superspeed hub is set configuration in initialization or
1048 * After a resume, port power should still be on.
1049 * For any other type of activation, turn it on.
1051 if (type != HUB_RESUME) {
1052 if (hdev->parent && hub_is_superspeed(hdev)) {
1053 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
1054 HUB_SET_DEPTH, USB_RT_HUB,
1055 hdev->level - 1, 0, NULL, 0,
1056 USB_CTRL_SET_TIMEOUT);
1058 dev_err(hub->intfdev,
1059 "set hub depth failed\n");
1062 /* Speed up system boot by using a delayed_work for the
1063 * hub's initial power-up delays. This is pretty awkward
1064 * and the implementation looks like a home-brewed sort of
1065 * setjmp/longjmp, but it saves at least 100 ms for each
1066 * root hub (assuming usbcore is compiled into the kernel
1067 * rather than as a module). It adds up.
1069 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1070 * because for those activation types the ports have to be
1071 * operational when we return. In theory this could be done
1072 * for HUB_POST_RESET, but it's easier not to.
1074 if (type == HUB_INIT) {
1075 delay = hub_power_on_good_delay(hub);
1077 hub_power_on(hub, false);
1078 INIT_DELAYED_WORK(&hub->init_work, hub_init_func2);
1079 queue_delayed_work(system_power_efficient_wq,
1081 msecs_to_jiffies(delay));
1083 /* Suppress autosuspend until init is done */
1084 usb_autopm_get_interface_no_resume(
1085 to_usb_interface(hub->intfdev));
1086 return; /* Continues at init2: below */
1087 } else if (type == HUB_RESET_RESUME) {
1088 /* The internal host controller state for the hub device
1089 * may be gone after a host power loss on system resume.
1090 * Update the device's info so the HW knows it's a hub.
1092 hcd = bus_to_hcd(hdev->bus);
1093 if (hcd->driver->update_hub_device) {
1094 ret = hcd->driver->update_hub_device(hcd, hdev,
1095 &hub->tt, GFP_NOIO);
1097 dev_err(hub->intfdev,
1098 "Host not accepting hub info update\n");
1099 dev_err(hub->intfdev,
1100 "LS/FS devices and hubs may not work under this hub\n");
1103 hub_power_on(hub, true);
1105 hub_power_on(hub, true);
1111 * Check each port and set hub->change_bits to let hub_wq know
1112 * which ports need attention.
1114 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
1115 struct usb_port *port_dev = hub->ports[port1 - 1];
1116 struct usb_device *udev = port_dev->child;
1117 u16 portstatus, portchange;
1119 portstatus = portchange = 0;
1120 status = hub_port_status(hub, port1, &portstatus, &portchange);
1124 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1125 dev_dbg(&port_dev->dev, "status %04x change %04x\n",
1126 portstatus, portchange);
1129 * After anything other than HUB_RESUME (i.e., initialization
1130 * or any sort of reset), every port should be disabled.
1131 * Unconnected ports should likewise be disabled (paranoia),
1132 * and so should ports for which we have no usb_device.
1134 if ((portstatus & USB_PORT_STAT_ENABLE) && (
1135 type != HUB_RESUME ||
1136 !(portstatus & USB_PORT_STAT_CONNECTION) ||
1138 udev->state == USB_STATE_NOTATTACHED)) {
1140 * USB3 protocol ports will automatically transition
1141 * to Enabled state when detect an USB3.0 device attach.
1142 * Do not disable USB3 protocol ports, just pretend
1145 portstatus &= ~USB_PORT_STAT_ENABLE;
1146 if (!hub_is_superspeed(hdev))
1147 usb_clear_port_feature(hdev, port1,
1148 USB_PORT_FEAT_ENABLE);
1151 /* Make sure a warm-reset request is handled by port_event */
1152 if (type == HUB_RESUME &&
1153 hub_port_warm_reset_required(hub, port1, portstatus))
1154 set_bit(port1, hub->event_bits);
1157 * Add debounce if USB3 link is in polling/link training state.
1158 * Link will automatically transition to Enabled state after
1159 * link training completes.
1161 if (hub_is_superspeed(hdev) &&
1162 ((portstatus & USB_PORT_STAT_LINK_STATE) ==
1163 USB_SS_PORT_LS_POLLING))
1164 need_debounce_delay = true;
1166 /* Clear status-change flags; we'll debounce later */
1167 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1168 need_debounce_delay = true;
1169 usb_clear_port_feature(hub->hdev, port1,
1170 USB_PORT_FEAT_C_CONNECTION);
1172 if (portchange & USB_PORT_STAT_C_ENABLE) {
1173 need_debounce_delay = true;
1174 usb_clear_port_feature(hub->hdev, port1,
1175 USB_PORT_FEAT_C_ENABLE);
1177 if (portchange & USB_PORT_STAT_C_RESET) {
1178 need_debounce_delay = true;
1179 usb_clear_port_feature(hub->hdev, port1,
1180 USB_PORT_FEAT_C_RESET);
1182 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
1183 hub_is_superspeed(hub->hdev)) {
1184 need_debounce_delay = true;
1185 usb_clear_port_feature(hub->hdev, port1,
1186 USB_PORT_FEAT_C_BH_PORT_RESET);
1188 /* We can forget about a "removed" device when there's a
1189 * physical disconnect or the connect status changes.
1191 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
1192 (portchange & USB_PORT_STAT_C_CONNECTION))
1193 clear_bit(port1, hub->removed_bits);
1195 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
1196 /* Tell hub_wq to disconnect the device or
1197 * check for a new connection or over current condition.
1198 * Based on USB2.0 Spec Section 11.12.5,
1199 * C_PORT_OVER_CURRENT could be set while
1200 * PORT_OVER_CURRENT is not. So check for any of them.
1202 if (udev || (portstatus & USB_PORT_STAT_CONNECTION) ||
1203 (portchange & USB_PORT_STAT_C_CONNECTION) ||
1204 (portstatus & USB_PORT_STAT_OVERCURRENT) ||
1205 (portchange & USB_PORT_STAT_C_OVERCURRENT))
1206 set_bit(port1, hub->change_bits);
1208 } else if (portstatus & USB_PORT_STAT_ENABLE) {
1209 bool port_resumed = (portstatus &
1210 USB_PORT_STAT_LINK_STATE) ==
1212 /* The power session apparently survived the resume.
1213 * If there was an overcurrent or suspend change
1214 * (i.e., remote wakeup request), have hub_wq
1215 * take care of it. Look at the port link state
1216 * for USB 3.0 hubs, since they don't have a suspend
1217 * change bit, and they don't set the port link change
1218 * bit on device-initiated resume.
1220 if (portchange || (hub_is_superspeed(hub->hdev) &&
1222 set_bit(port1, hub->change_bits);
1224 } else if (udev->persist_enabled) {
1226 udev->reset_resume = 1;
1228 /* Don't set the change_bits when the device
1231 if (test_bit(port1, hub->power_bits))
1232 set_bit(port1, hub->change_bits);
1235 /* The power session is gone; tell hub_wq */
1236 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1237 set_bit(port1, hub->change_bits);
1241 /* If no port-status-change flags were set, we don't need any
1242 * debouncing. If flags were set we can try to debounce the
1243 * ports all at once right now, instead of letting hub_wq do them
1244 * one at a time later on.
1246 * If any port-status changes do occur during this delay, hub_wq
1247 * will see them later and handle them normally.
1249 if (need_debounce_delay) {
1250 delay = HUB_DEBOUNCE_STABLE;
1252 /* Don't do a long sleep inside a workqueue routine */
1253 if (type == HUB_INIT2) {
1254 INIT_DELAYED_WORK(&hub->init_work, hub_init_func3);
1255 queue_delayed_work(system_power_efficient_wq,
1257 msecs_to_jiffies(delay));
1258 device_unlock(&hdev->dev);
1259 return; /* Continues at init3: below */
1267 status = usb_submit_urb(hub->urb, GFP_NOIO);
1269 dev_err(hub->intfdev, "activate --> %d\n", status);
1270 if (hub->has_indicators && blinkenlights)
1271 queue_delayed_work(system_power_efficient_wq,
1272 &hub->leds, LED_CYCLE_PERIOD);
1274 /* Scan all ports that need attention */
1277 if (type == HUB_INIT2 || type == HUB_INIT3) {
1278 /* Allow autosuspend if it was suppressed */
1280 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
1281 device_unlock(&hdev->dev);
1284 kref_put(&hub->kref, hub_release);
1287 /* Implement the continuations for the delays above */
1288 static void hub_init_func2(struct work_struct *ws)
1290 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1292 hub_activate(hub, HUB_INIT2);
1295 static void hub_init_func3(struct work_struct *ws)
1297 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1299 hub_activate(hub, HUB_INIT3);
1302 enum hub_quiescing_type {
1303 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
1306 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
1308 struct usb_device *hdev = hub->hdev;
1309 unsigned long flags;
1312 /* hub_wq and related activity won't re-trigger */
1313 spin_lock_irqsave(&hub->irq_urb_lock, flags);
1315 spin_unlock_irqrestore(&hub->irq_urb_lock, flags);
1317 if (type != HUB_SUSPEND) {
1318 /* Disconnect all the children */
1319 for (i = 0; i < hdev->maxchild; ++i) {
1320 if (hub->ports[i]->child)
1321 usb_disconnect(&hub->ports[i]->child);
1325 /* Stop hub_wq and related activity */
1326 del_timer_sync(&hub->irq_urb_retry);
1327 usb_kill_urb(hub->urb);
1328 if (hub->has_indicators)
1329 cancel_delayed_work_sync(&hub->leds);
1331 flush_work(&hub->tt.clear_work);
1334 static void hub_pm_barrier_for_all_ports(struct usb_hub *hub)
1338 for (i = 0; i < hub->hdev->maxchild; ++i)
1339 pm_runtime_barrier(&hub->ports[i]->dev);
1342 /* caller has locked the hub device */
1343 static int hub_pre_reset(struct usb_interface *intf)
1345 struct usb_hub *hub = usb_get_intfdata(intf);
1347 hub_quiesce(hub, HUB_PRE_RESET);
1349 hub_pm_barrier_for_all_ports(hub);
1353 /* caller has locked the hub device */
1354 static int hub_post_reset(struct usb_interface *intf)
1356 struct usb_hub *hub = usb_get_intfdata(intf);
1359 hub_pm_barrier_for_all_ports(hub);
1360 hub_activate(hub, HUB_POST_RESET);
1364 static int hub_configure(struct usb_hub *hub,
1365 struct usb_endpoint_descriptor *endpoint)
1367 struct usb_hcd *hcd;
1368 struct usb_device *hdev = hub->hdev;
1369 struct device *hub_dev = hub->intfdev;
1370 u16 hubstatus, hubchange;
1371 u16 wHubCharacteristics;
1374 char *message = "out of memory";
1379 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
1385 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1390 mutex_init(&hub->status_mutex);
1392 hub->descriptor = kzalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1393 if (!hub->descriptor) {
1398 /* Request the entire hub descriptor.
1399 * hub->descriptor can handle USB_MAXCHILDREN ports,
1400 * but a (non-SS) hub can/will return fewer bytes here.
1402 ret = get_hub_descriptor(hdev, hub->descriptor);
1404 message = "can't read hub descriptor";
1408 maxchild = USB_MAXCHILDREN;
1409 if (hub_is_superspeed(hdev))
1410 maxchild = min_t(unsigned, maxchild, USB_SS_MAXPORTS);
1412 if (hub->descriptor->bNbrPorts > maxchild) {
1413 message = "hub has too many ports!";
1416 } else if (hub->descriptor->bNbrPorts == 0) {
1417 message = "hub doesn't have any ports!";
1423 * Accumulate wHubDelay + 40ns for every hub in the tree of devices.
1424 * The resulting value will be used for SetIsochDelay() request.
1426 if (hub_is_superspeed(hdev) || hub_is_superspeedplus(hdev)) {
1427 u32 delay = __le16_to_cpu(hub->descriptor->u.ss.wHubDelay);
1430 delay += hdev->parent->hub_delay;
1432 delay += USB_TP_TRANSMISSION_DELAY;
1433 hdev->hub_delay = min_t(u32, delay, USB_TP_TRANSMISSION_DELAY_MAX);
1436 maxchild = hub->descriptor->bNbrPorts;
1437 dev_info(hub_dev, "%d port%s detected\n", maxchild,
1438 (maxchild == 1) ? "" : "s");
1440 hub->ports = kcalloc(maxchild, sizeof(struct usb_port *), GFP_KERNEL);
1446 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1447 if (hub_is_superspeed(hdev)) {
1455 /* FIXME for USB 3.0, skip for now */
1456 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1457 !(hub_is_superspeed(hdev))) {
1458 char portstr[USB_MAXCHILDREN + 1];
1460 for (i = 0; i < maxchild; i++)
1461 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1462 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1464 portstr[maxchild] = 0;
1465 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1467 dev_dbg(hub_dev, "standalone hub\n");
1469 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1470 case HUB_CHAR_COMMON_LPSM:
1471 dev_dbg(hub_dev, "ganged power switching\n");
1473 case HUB_CHAR_INDV_PORT_LPSM:
1474 dev_dbg(hub_dev, "individual port power switching\n");
1476 case HUB_CHAR_NO_LPSM:
1478 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1482 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1483 case HUB_CHAR_COMMON_OCPM:
1484 dev_dbg(hub_dev, "global over-current protection\n");
1486 case HUB_CHAR_INDV_PORT_OCPM:
1487 dev_dbg(hub_dev, "individual port over-current protection\n");
1489 case HUB_CHAR_NO_OCPM:
1491 dev_dbg(hub_dev, "no over-current protection\n");
1495 spin_lock_init(&hub->tt.lock);
1496 INIT_LIST_HEAD(&hub->tt.clear_list);
1497 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1498 switch (hdev->descriptor.bDeviceProtocol) {
1501 case USB_HUB_PR_HS_SINGLE_TT:
1502 dev_dbg(hub_dev, "Single TT\n");
1505 case USB_HUB_PR_HS_MULTI_TT:
1506 ret = usb_set_interface(hdev, 0, 1);
1508 dev_dbg(hub_dev, "TT per port\n");
1511 dev_err(hub_dev, "Using single TT (err %d)\n",
1516 /* USB 3.0 hubs don't have a TT */
1519 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1520 hdev->descriptor.bDeviceProtocol);
1524 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1525 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1526 case HUB_TTTT_8_BITS:
1527 if (hdev->descriptor.bDeviceProtocol != 0) {
1528 hub->tt.think_time = 666;
1529 dev_dbg(hub_dev, "TT requires at most %d "
1530 "FS bit times (%d ns)\n",
1531 8, hub->tt.think_time);
1534 case HUB_TTTT_16_BITS:
1535 hub->tt.think_time = 666 * 2;
1536 dev_dbg(hub_dev, "TT requires at most %d "
1537 "FS bit times (%d ns)\n",
1538 16, hub->tt.think_time);
1540 case HUB_TTTT_24_BITS:
1541 hub->tt.think_time = 666 * 3;
1542 dev_dbg(hub_dev, "TT requires at most %d "
1543 "FS bit times (%d ns)\n",
1544 24, hub->tt.think_time);
1546 case HUB_TTTT_32_BITS:
1547 hub->tt.think_time = 666 * 4;
1548 dev_dbg(hub_dev, "TT requires at most %d "
1549 "FS bit times (%d ns)\n",
1550 32, hub->tt.think_time);
1554 /* probe() zeroes hub->indicator[] */
1555 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1556 hub->has_indicators = 1;
1557 dev_dbg(hub_dev, "Port indicators are supported\n");
1560 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1561 hub->descriptor->bPwrOn2PwrGood * 2);
1563 /* power budgeting mostly matters with bus-powered hubs,
1564 * and battery-powered root hubs (may provide just 8 mA).
1566 ret = usb_get_std_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1568 message = "can't get hub status";
1571 hcd = bus_to_hcd(hdev->bus);
1572 if (hdev == hdev->bus->root_hub) {
1573 if (hcd->power_budget > 0)
1574 hdev->bus_mA = hcd->power_budget;
1576 hdev->bus_mA = full_load * maxchild;
1577 if (hdev->bus_mA >= full_load)
1578 hub->mA_per_port = full_load;
1580 hub->mA_per_port = hdev->bus_mA;
1581 hub->limited_power = 1;
1583 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1584 int remaining = hdev->bus_mA -
1585 hub->descriptor->bHubContrCurrent;
1587 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1588 hub->descriptor->bHubContrCurrent);
1589 hub->limited_power = 1;
1591 if (remaining < maxchild * unit_load)
1593 "insufficient power available "
1594 "to use all downstream ports\n");
1595 hub->mA_per_port = unit_load; /* 7.2.1 */
1597 } else { /* Self-powered external hub */
1598 /* FIXME: What about battery-powered external hubs that
1599 * provide less current per port? */
1600 hub->mA_per_port = full_load;
1602 if (hub->mA_per_port < full_load)
1603 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1606 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1608 message = "can't get hub status";
1612 /* local power status reports aren't always correct */
1613 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1614 dev_dbg(hub_dev, "local power source is %s\n",
1615 (hubstatus & HUB_STATUS_LOCAL_POWER)
1616 ? "lost (inactive)" : "good");
1618 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1619 dev_dbg(hub_dev, "%sover-current condition exists\n",
1620 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1622 /* set up the interrupt endpoint
1623 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1624 * bytes as USB2.0[11.12.3] says because some hubs are known
1625 * to send more data (and thus cause overflow). For root hubs,
1626 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1627 * to be big enough for at least USB_MAXCHILDREN ports. */
1628 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1629 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1631 if (maxp > sizeof(*hub->buffer))
1632 maxp = sizeof(*hub->buffer);
1634 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1640 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1641 hub, endpoint->bInterval);
1643 /* maybe cycle the hub leds */
1644 if (hub->has_indicators && blinkenlights)
1645 hub->indicator[0] = INDICATOR_CYCLE;
1647 mutex_lock(&usb_port_peer_mutex);
1648 for (i = 0; i < maxchild; i++) {
1649 ret = usb_hub_create_port_device(hub, i + 1);
1651 dev_err(hub->intfdev,
1652 "couldn't create port%d device.\n", i + 1);
1657 for (i = 0; i < hdev->maxchild; i++) {
1658 struct usb_port *port_dev = hub->ports[i];
1660 pm_runtime_put(&port_dev->dev);
1663 mutex_unlock(&usb_port_peer_mutex);
1667 /* Update the HCD's internal representation of this hub before hub_wq
1668 * starts getting port status changes for devices under the hub.
1670 if (hcd->driver->update_hub_device) {
1671 ret = hcd->driver->update_hub_device(hcd, hdev,
1672 &hub->tt, GFP_KERNEL);
1674 message = "can't update HCD hub info";
1679 usb_hub_adjust_deviceremovable(hdev, hub->descriptor);
1681 hub_activate(hub, HUB_INIT);
1685 dev_err(hub_dev, "config failed, %s (err %d)\n",
1687 /* hub_disconnect() frees urb and descriptor */
1691 static void hub_release(struct kref *kref)
1693 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1695 usb_put_dev(hub->hdev);
1696 usb_put_intf(to_usb_interface(hub->intfdev));
1700 static unsigned highspeed_hubs;
1702 static void hub_disconnect(struct usb_interface *intf)
1704 struct usb_hub *hub = usb_get_intfdata(intf);
1705 struct usb_device *hdev = interface_to_usbdev(intf);
1709 * Stop adding new hub events. We do not want to block here and thus
1710 * will not try to remove any pending work item.
1712 hub->disconnected = 1;
1714 /* Disconnect all children and quiesce the hub */
1716 hub_quiesce(hub, HUB_DISCONNECT);
1718 mutex_lock(&usb_port_peer_mutex);
1720 /* Avoid races with recursively_mark_NOTATTACHED() */
1721 spin_lock_irq(&device_state_lock);
1722 port1 = hdev->maxchild;
1724 usb_set_intfdata(intf, NULL);
1725 spin_unlock_irq(&device_state_lock);
1727 for (; port1 > 0; --port1)
1728 usb_hub_remove_port_device(hub, port1);
1730 mutex_unlock(&usb_port_peer_mutex);
1732 if (hub->hdev->speed == USB_SPEED_HIGH)
1735 usb_free_urb(hub->urb);
1737 kfree(hub->descriptor);
1741 pm_suspend_ignore_children(&intf->dev, false);
1743 if (hub->quirk_disable_autosuspend)
1744 usb_autopm_put_interface(intf);
1746 kref_put(&hub->kref, hub_release);
1749 static bool hub_descriptor_is_sane(struct usb_host_interface *desc)
1751 /* Some hubs have a subclass of 1, which AFAICT according to the */
1752 /* specs is not defined, but it works */
1753 if (desc->desc.bInterfaceSubClass != 0 &&
1754 desc->desc.bInterfaceSubClass != 1)
1757 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1758 if (desc->desc.bNumEndpoints != 1)
1761 /* If the first endpoint is not interrupt IN, we'd better punt! */
1762 if (!usb_endpoint_is_int_in(&desc->endpoint[0].desc))
1768 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1770 struct usb_host_interface *desc;
1771 struct usb_device *hdev;
1772 struct usb_hub *hub;
1774 desc = intf->cur_altsetting;
1775 hdev = interface_to_usbdev(intf);
1778 * Set default autosuspend delay as 0 to speedup bus suspend,
1779 * based on the below considerations:
1781 * - Unlike other drivers, the hub driver does not rely on the
1782 * autosuspend delay to provide enough time to handle a wakeup
1783 * event, and the submitted status URB is just to check future
1784 * change on hub downstream ports, so it is safe to do it.
1786 * - The patch might cause one or more auto supend/resume for
1787 * below very rare devices when they are plugged into hub
1790 * devices having trouble initializing, and disconnect
1791 * themselves from the bus and then reconnect a second
1794 * devices just for downloading firmware, and disconnects
1795 * themselves after completing it
1797 * For these quite rare devices, their drivers may change the
1798 * autosuspend delay of their parent hub in the probe() to one
1799 * appropriate value to avoid the subtle problem if someone
1802 * - The patch may cause one or more auto suspend/resume on
1803 * hub during running 'lsusb', but it is probably too
1804 * infrequent to worry about.
1806 * - Change autosuspend delay of hub can avoid unnecessary auto
1807 * suspend timer for hub, also may decrease power consumption
1810 * - If user has indicated to prevent autosuspend by passing
1811 * usbcore.autosuspend = -1 then keep autosuspend disabled.
1814 if (hdev->dev.power.autosuspend_delay >= 0)
1815 pm_runtime_set_autosuspend_delay(&hdev->dev, 0);
1819 * Hubs have proper suspend/resume support, except for root hubs
1820 * where the controller driver doesn't have bus_suspend and
1821 * bus_resume methods.
1823 if (hdev->parent) { /* normal device */
1824 usb_enable_autosuspend(hdev);
1825 } else { /* root hub */
1826 const struct hc_driver *drv = bus_to_hcd(hdev->bus)->driver;
1828 if (drv->bus_suspend && drv->bus_resume)
1829 usb_enable_autosuspend(hdev);
1832 if (hdev->level == MAX_TOPO_LEVEL) {
1834 "Unsupported bus topology: hub nested too deep\n");
1838 #ifdef CONFIG_USB_OTG_DISABLE_EXTERNAL_HUB
1840 dev_warn(&intf->dev, "ignoring external hub\n");
1845 if (!hub_descriptor_is_sane(desc)) {
1846 dev_err(&intf->dev, "bad descriptor, ignoring hub\n");
1850 /* We found a hub */
1851 dev_info(&intf->dev, "USB hub found\n");
1853 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1857 kref_init(&hub->kref);
1858 hub->intfdev = &intf->dev;
1860 INIT_DELAYED_WORK(&hub->leds, led_work);
1861 INIT_DELAYED_WORK(&hub->init_work, NULL);
1862 INIT_WORK(&hub->events, hub_event);
1863 spin_lock_init(&hub->irq_urb_lock);
1864 timer_setup(&hub->irq_urb_retry, hub_retry_irq_urb, 0);
1868 usb_set_intfdata(intf, hub);
1869 intf->needs_remote_wakeup = 1;
1870 pm_suspend_ignore_children(&intf->dev, true);
1872 if (hdev->speed == USB_SPEED_HIGH)
1875 if (id->driver_info & HUB_QUIRK_CHECK_PORT_AUTOSUSPEND)
1876 hub->quirk_check_port_auto_suspend = 1;
1878 if (id->driver_info & HUB_QUIRK_DISABLE_AUTOSUSPEND) {
1879 hub->quirk_disable_autosuspend = 1;
1880 usb_autopm_get_interface_no_resume(intf);
1883 if (hub_configure(hub, &desc->endpoint[0].desc) >= 0)
1886 hub_disconnect(intf);
1891 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1893 struct usb_device *hdev = interface_to_usbdev(intf);
1894 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1896 /* assert ifno == 0 (part of hub spec) */
1898 case USBDEVFS_HUB_PORTINFO: {
1899 struct usbdevfs_hub_portinfo *info = user_data;
1902 spin_lock_irq(&device_state_lock);
1903 if (hdev->devnum <= 0)
1906 info->nports = hdev->maxchild;
1907 for (i = 0; i < info->nports; i++) {
1908 if (hub->ports[i]->child == NULL)
1912 hub->ports[i]->child->devnum;
1915 spin_unlock_irq(&device_state_lock);
1917 return info->nports + 1;
1926 * Allow user programs to claim ports on a hub. When a device is attached
1927 * to one of these "claimed" ports, the program will "own" the device.
1929 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1930 struct usb_dev_state ***ppowner)
1932 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1934 if (hdev->state == USB_STATE_NOTATTACHED)
1936 if (port1 == 0 || port1 > hdev->maxchild)
1939 /* Devices not managed by the hub driver
1940 * will always have maxchild equal to 0.
1942 *ppowner = &(hub->ports[port1 - 1]->port_owner);
1946 /* In the following three functions, the caller must hold hdev's lock */
1947 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
1948 struct usb_dev_state *owner)
1951 struct usb_dev_state **powner;
1953 rc = find_port_owner(hdev, port1, &powner);
1961 EXPORT_SYMBOL_GPL(usb_hub_claim_port);
1963 int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
1964 struct usb_dev_state *owner)
1967 struct usb_dev_state **powner;
1969 rc = find_port_owner(hdev, port1, &powner);
1972 if (*powner != owner)
1977 EXPORT_SYMBOL_GPL(usb_hub_release_port);
1979 void usb_hub_release_all_ports(struct usb_device *hdev, struct usb_dev_state *owner)
1981 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1984 for (n = 0; n < hdev->maxchild; n++) {
1985 if (hub->ports[n]->port_owner == owner)
1986 hub->ports[n]->port_owner = NULL;
1991 /* The caller must hold udev's lock */
1992 bool usb_device_is_owned(struct usb_device *udev)
1994 struct usb_hub *hub;
1996 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1998 hub = usb_hub_to_struct_hub(udev->parent);
1999 return !!hub->ports[udev->portnum - 1]->port_owner;
2002 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
2004 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2007 for (i = 0; i < udev->maxchild; ++i) {
2008 if (hub->ports[i]->child)
2009 recursively_mark_NOTATTACHED(hub->ports[i]->child);
2011 if (udev->state == USB_STATE_SUSPENDED)
2012 udev->active_duration -= jiffies;
2013 udev->state = USB_STATE_NOTATTACHED;
2017 * usb_set_device_state - change a device's current state (usbcore, hcds)
2018 * @udev: pointer to device whose state should be changed
2019 * @new_state: new state value to be stored
2021 * udev->state is _not_ fully protected by the device lock. Although
2022 * most transitions are made only while holding the lock, the state can
2023 * can change to USB_STATE_NOTATTACHED at almost any time. This
2024 * is so that devices can be marked as disconnected as soon as possible,
2025 * without having to wait for any semaphores to be released. As a result,
2026 * all changes to any device's state must be protected by the
2027 * device_state_lock spinlock.
2029 * Once a device has been added to the device tree, all changes to its state
2030 * should be made using this routine. The state should _not_ be set directly.
2032 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
2033 * Otherwise udev->state is set to new_state, and if new_state is
2034 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
2035 * to USB_STATE_NOTATTACHED.
2037 void usb_set_device_state(struct usb_device *udev,
2038 enum usb_device_state new_state)
2040 unsigned long flags;
2043 spin_lock_irqsave(&device_state_lock, flags);
2044 if (udev->state == USB_STATE_NOTATTACHED)
2046 else if (new_state != USB_STATE_NOTATTACHED) {
2048 /* root hub wakeup capabilities are managed out-of-band
2049 * and may involve silicon errata ... ignore them here.
2052 if (udev->state == USB_STATE_SUSPENDED
2053 || new_state == USB_STATE_SUSPENDED)
2054 ; /* No change to wakeup settings */
2055 else if (new_state == USB_STATE_CONFIGURED)
2056 wakeup = (udev->quirks &
2057 USB_QUIRK_IGNORE_REMOTE_WAKEUP) ? 0 :
2058 udev->actconfig->desc.bmAttributes &
2059 USB_CONFIG_ATT_WAKEUP;
2063 if (udev->state == USB_STATE_SUSPENDED &&
2064 new_state != USB_STATE_SUSPENDED)
2065 udev->active_duration -= jiffies;
2066 else if (new_state == USB_STATE_SUSPENDED &&
2067 udev->state != USB_STATE_SUSPENDED)
2068 udev->active_duration += jiffies;
2069 udev->state = new_state;
2071 recursively_mark_NOTATTACHED(udev);
2072 spin_unlock_irqrestore(&device_state_lock, flags);
2074 device_set_wakeup_capable(&udev->dev, wakeup);
2076 EXPORT_SYMBOL_GPL(usb_set_device_state);
2079 * Choose a device number.
2081 * Device numbers are used as filenames in usbfs. On USB-1.1 and
2082 * USB-2.0 buses they are also used as device addresses, however on
2083 * USB-3.0 buses the address is assigned by the controller hardware
2084 * and it usually is not the same as the device number.
2086 * WUSB devices are simple: they have no hubs behind, so the mapping
2087 * device <-> virtual port number becomes 1:1. Why? to simplify the
2088 * life of the device connection logic in
2089 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
2090 * handshake we need to assign a temporary address in the unauthorized
2091 * space. For simplicity we use the first virtual port number found to
2092 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
2093 * and that becomes it's address [X < 128] or its unauthorized address
2096 * We add 1 as an offset to the one-based USB-stack port number
2097 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
2098 * 0 is reserved by USB for default address; (b) Linux's USB stack
2099 * uses always #1 for the root hub of the controller. So USB stack's
2100 * port #1, which is wusb virtual-port #0 has address #2.
2102 * Devices connected under xHCI are not as simple. The host controller
2103 * supports virtualization, so the hardware assigns device addresses and
2104 * the HCD must setup data structures before issuing a set address
2105 * command to the hardware.
2107 static void choose_devnum(struct usb_device *udev)
2110 struct usb_bus *bus = udev->bus;
2112 /* be safe when more hub events are proceed in parallel */
2113 mutex_lock(&bus->devnum_next_mutex);
2115 devnum = udev->portnum + 1;
2116 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
2118 /* Try to allocate the next devnum beginning at
2119 * bus->devnum_next. */
2120 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
2123 devnum = find_next_zero_bit(bus->devmap.devicemap,
2125 bus->devnum_next = (devnum >= 127 ? 1 : devnum + 1);
2128 set_bit(devnum, bus->devmap.devicemap);
2129 udev->devnum = devnum;
2131 mutex_unlock(&bus->devnum_next_mutex);
2134 static void release_devnum(struct usb_device *udev)
2136 if (udev->devnum > 0) {
2137 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
2142 static void update_devnum(struct usb_device *udev, int devnum)
2144 /* The address for a WUSB device is managed by wusbcore. */
2146 udev->devnum = devnum;
2148 udev->devaddr = (u8)devnum;
2151 static void hub_free_dev(struct usb_device *udev)
2153 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2155 /* Root hubs aren't real devices, so don't free HCD resources */
2156 if (hcd->driver->free_dev && udev->parent)
2157 hcd->driver->free_dev(hcd, udev);
2160 static void hub_disconnect_children(struct usb_device *udev)
2162 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2165 /* Free up all the children before we remove this device */
2166 for (i = 0; i < udev->maxchild; i++) {
2167 if (hub->ports[i]->child)
2168 usb_disconnect(&hub->ports[i]->child);
2173 * usb_disconnect - disconnect a device (usbcore-internal)
2174 * @pdev: pointer to device being disconnected
2176 * Context: task context, might sleep
2178 * Something got disconnected. Get rid of it and all of its children.
2180 * If *pdev is a normal device then the parent hub must already be locked.
2181 * If *pdev is a root hub then the caller must hold the usb_bus_idr_lock,
2182 * which protects the set of root hubs as well as the list of buses.
2184 * Only hub drivers (including virtual root hub drivers for host
2185 * controllers) should ever call this.
2187 * This call is synchronous, and may not be used in an interrupt context.
2189 void usb_disconnect(struct usb_device **pdev)
2191 struct usb_port *port_dev = NULL;
2192 struct usb_device *udev = *pdev;
2193 struct usb_hub *hub = NULL;
2196 /* mark the device as inactive, so any further urb submissions for
2197 * this device (and any of its children) will fail immediately.
2198 * this quiesces everything except pending urbs.
2200 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2201 dev_info(&udev->dev, "USB disconnect, device number %d\n",
2205 * Ensure that the pm runtime code knows that the USB device
2206 * is in the process of being disconnected.
2208 pm_runtime_barrier(&udev->dev);
2210 usb_lock_device(udev);
2212 hub_disconnect_children(udev);
2214 /* deallocate hcd/hardware state ... nuking all pending urbs and
2215 * cleaning up all state associated with the current configuration
2216 * so that the hardware is now fully quiesced.
2218 dev_dbg(&udev->dev, "unregistering device\n");
2219 usb_disable_device(udev, 0);
2220 usb_hcd_synchronize_unlinks(udev);
2223 port1 = udev->portnum;
2224 hub = usb_hub_to_struct_hub(udev->parent);
2225 port_dev = hub->ports[port1 - 1];
2227 sysfs_remove_link(&udev->dev.kobj, "port");
2228 sysfs_remove_link(&port_dev->dev.kobj, "device");
2231 * As usb_port_runtime_resume() de-references udev, make
2232 * sure no resumes occur during removal
2234 if (!test_and_set_bit(port1, hub->child_usage_bits))
2235 pm_runtime_get_sync(&port_dev->dev);
2238 usb_remove_ep_devs(&udev->ep0);
2239 usb_unlock_device(udev);
2241 /* Unregister the device. The device driver is responsible
2242 * for de-configuring the device and invoking the remove-device
2243 * notifier chain (used by usbfs and possibly others).
2245 device_del(&udev->dev);
2247 /* Free the device number and delete the parent's children[]
2248 * (or root_hub) pointer.
2250 release_devnum(udev);
2252 /* Avoid races with recursively_mark_NOTATTACHED() */
2253 spin_lock_irq(&device_state_lock);
2255 spin_unlock_irq(&device_state_lock);
2257 if (port_dev && test_and_clear_bit(port1, hub->child_usage_bits))
2258 pm_runtime_put(&port_dev->dev);
2262 put_device(&udev->dev);
2265 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2266 static void show_string(struct usb_device *udev, char *id, char *string)
2270 dev_info(&udev->dev, "%s: %s\n", id, string);
2273 static void announce_device(struct usb_device *udev)
2275 u16 bcdDevice = le16_to_cpu(udev->descriptor.bcdDevice);
2277 dev_info(&udev->dev,
2278 "New USB device found, idVendor=%04x, idProduct=%04x, bcdDevice=%2x.%02x\n",
2279 le16_to_cpu(udev->descriptor.idVendor),
2280 le16_to_cpu(udev->descriptor.idProduct),
2281 bcdDevice >> 8, bcdDevice & 0xff);
2282 dev_info(&udev->dev,
2283 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2284 udev->descriptor.iManufacturer,
2285 udev->descriptor.iProduct,
2286 udev->descriptor.iSerialNumber);
2287 show_string(udev, "Product", udev->product);
2288 show_string(udev, "Manufacturer", udev->manufacturer);
2289 show_string(udev, "SerialNumber", udev->serial);
2292 static inline void announce_device(struct usb_device *udev) { }
2297 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2298 * @udev: newly addressed device (in ADDRESS state)
2300 * Finish enumeration for On-The-Go devices
2302 * Return: 0 if successful. A negative error code otherwise.
2304 static int usb_enumerate_device_otg(struct usb_device *udev)
2308 #ifdef CONFIG_USB_OTG
2310 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2311 * to wake us after we've powered off VBUS; and HNP, switching roles
2312 * "host" to "peripheral". The OTG descriptor helps figure this out.
2314 if (!udev->bus->is_b_host
2316 && udev->parent == udev->bus->root_hub) {
2317 struct usb_otg_descriptor *desc = NULL;
2318 struct usb_bus *bus = udev->bus;
2319 unsigned port1 = udev->portnum;
2321 /* descriptor may appear anywhere in config */
2322 err = __usb_get_extra_descriptor(udev->rawdescriptors[0],
2323 le16_to_cpu(udev->config[0].desc.wTotalLength),
2324 USB_DT_OTG, (void **) &desc, sizeof(*desc));
2325 if (err || !(desc->bmAttributes & USB_OTG_HNP))
2328 dev_info(&udev->dev, "Dual-Role OTG device on %sHNP port\n",
2329 (port1 == bus->otg_port) ? "" : "non-");
2331 /* enable HNP before suspend, it's simpler */
2332 if (port1 == bus->otg_port) {
2333 bus->b_hnp_enable = 1;
2334 err = usb_control_msg(udev,
2335 usb_sndctrlpipe(udev, 0),
2336 USB_REQ_SET_FEATURE, 0,
2337 USB_DEVICE_B_HNP_ENABLE,
2339 USB_CTRL_SET_TIMEOUT);
2342 * OTG MESSAGE: report errors here,
2343 * customize to match your product.
2345 dev_err(&udev->dev, "can't set HNP mode: %d\n",
2347 bus->b_hnp_enable = 0;
2349 } else if (desc->bLength == sizeof
2350 (struct usb_otg_descriptor)) {
2351 /* Set a_alt_hnp_support for legacy otg device */
2352 err = usb_control_msg(udev,
2353 usb_sndctrlpipe(udev, 0),
2354 USB_REQ_SET_FEATURE, 0,
2355 USB_DEVICE_A_ALT_HNP_SUPPORT,
2357 USB_CTRL_SET_TIMEOUT);
2360 "set a_alt_hnp_support failed: %d\n",
2370 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2371 * @udev: newly addressed device (in ADDRESS state)
2373 * This is only called by usb_new_device() and usb_authorize_device()
2374 * and FIXME -- all comments that apply to them apply here wrt to
2377 * If the device is WUSB and not authorized, we don't attempt to read
2378 * the string descriptors, as they will be errored out by the device
2379 * until it has been authorized.
2381 * Return: 0 if successful. A negative error code otherwise.
2383 static int usb_enumerate_device(struct usb_device *udev)
2386 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2388 if (udev->config == NULL) {
2389 err = usb_get_configuration(udev);
2392 dev_err(&udev->dev, "can't read configurations, error %d\n",
2398 /* read the standard strings and cache them if present */
2399 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
2400 udev->manufacturer = usb_cache_string(udev,
2401 udev->descriptor.iManufacturer);
2402 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
2404 err = usb_enumerate_device_otg(udev);
2408 if (IS_ENABLED(CONFIG_USB_OTG_PRODUCTLIST) && hcd->tpl_support &&
2409 !is_targeted(udev)) {
2410 /* Maybe it can talk to us, though we can't talk to it.
2411 * (Includes HNP test device.)
2413 if (IS_ENABLED(CONFIG_USB_OTG) && (udev->bus->b_hnp_enable
2414 || udev->bus->is_b_host)) {
2415 err = usb_port_suspend(udev, PMSG_AUTO_SUSPEND);
2417 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
2422 usb_detect_interface_quirks(udev);
2427 static void set_usb_port_removable(struct usb_device *udev)
2429 struct usb_device *hdev = udev->parent;
2430 struct usb_hub *hub;
2431 u8 port = udev->portnum;
2432 u16 wHubCharacteristics;
2433 bool removable = true;
2438 hub = usb_hub_to_struct_hub(udev->parent);
2441 * If the platform firmware has provided information about a port,
2442 * use that to determine whether it's removable.
2444 switch (hub->ports[udev->portnum - 1]->connect_type) {
2445 case USB_PORT_CONNECT_TYPE_HOT_PLUG:
2446 udev->removable = USB_DEVICE_REMOVABLE;
2448 case USB_PORT_CONNECT_TYPE_HARD_WIRED:
2449 case USB_PORT_NOT_USED:
2450 udev->removable = USB_DEVICE_FIXED;
2457 * Otherwise, check whether the hub knows whether a port is removable
2460 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2462 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
2465 if (hub_is_superspeed(hdev)) {
2466 if (le16_to_cpu(hub->descriptor->u.ss.DeviceRemovable)
2470 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
2475 udev->removable = USB_DEVICE_REMOVABLE;
2477 udev->removable = USB_DEVICE_FIXED;
2482 * usb_new_device - perform initial device setup (usbcore-internal)
2483 * @udev: newly addressed device (in ADDRESS state)
2485 * This is called with devices which have been detected but not fully
2486 * enumerated. The device descriptor is available, but not descriptors
2487 * for any device configuration. The caller must have locked either
2488 * the parent hub (if udev is a normal device) or else the
2489 * usb_bus_idr_lock (if udev is a root hub). The parent's pointer to
2490 * udev has already been installed, but udev is not yet visible through
2491 * sysfs or other filesystem code.
2493 * This call is synchronous, and may not be used in an interrupt context.
2495 * Only the hub driver or root-hub registrar should ever call this.
2497 * Return: Whether the device is configured properly or not. Zero if the
2498 * interface was registered with the driver core; else a negative errno
2502 int usb_new_device(struct usb_device *udev)
2507 /* Initialize non-root-hub device wakeup to disabled;
2508 * device (un)configuration controls wakeup capable
2509 * sysfs power/wakeup controls wakeup enabled/disabled
2511 device_init_wakeup(&udev->dev, 0);
2514 /* Tell the runtime-PM framework the device is active */
2515 pm_runtime_set_active(&udev->dev);
2516 pm_runtime_get_noresume(&udev->dev);
2517 pm_runtime_use_autosuspend(&udev->dev);
2518 pm_runtime_enable(&udev->dev);
2520 /* By default, forbid autosuspend for all devices. It will be
2521 * allowed for hubs during binding.
2523 usb_disable_autosuspend(udev);
2525 err = usb_enumerate_device(udev); /* Read descriptors */
2528 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
2529 udev->devnum, udev->bus->busnum,
2530 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2531 /* export the usbdev device-node for libusb */
2532 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
2533 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2535 /* Tell the world! */
2536 announce_device(udev);
2539 add_device_randomness(udev->serial, strlen(udev->serial));
2541 add_device_randomness(udev->product, strlen(udev->product));
2542 if (udev->manufacturer)
2543 add_device_randomness(udev->manufacturer,
2544 strlen(udev->manufacturer));
2546 device_enable_async_suspend(&udev->dev);
2548 /* check whether the hub or firmware marks this port as non-removable */
2550 set_usb_port_removable(udev);
2552 /* Register the device. The device driver is responsible
2553 * for configuring the device and invoking the add-device
2554 * notifier chain (used by usbfs and possibly others).
2556 err = device_add(&udev->dev);
2558 dev_err(&udev->dev, "can't device_add, error %d\n", err);
2562 /* Create link files between child device and usb port device. */
2564 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2565 int port1 = udev->portnum;
2566 struct usb_port *port_dev = hub->ports[port1 - 1];
2568 err = sysfs_create_link(&udev->dev.kobj,
2569 &port_dev->dev.kobj, "port");
2573 err = sysfs_create_link(&port_dev->dev.kobj,
2574 &udev->dev.kobj, "device");
2576 sysfs_remove_link(&udev->dev.kobj, "port");
2580 if (!test_and_set_bit(port1, hub->child_usage_bits))
2581 pm_runtime_get_sync(&port_dev->dev);
2584 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
2585 usb_mark_last_busy(udev);
2586 pm_runtime_put_sync_autosuspend(&udev->dev);
2590 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2591 pm_runtime_disable(&udev->dev);
2592 pm_runtime_set_suspended(&udev->dev);
2598 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2599 * @usb_dev: USB device
2601 * Move the USB device to a very basic state where interfaces are disabled
2602 * and the device is in fact unconfigured and unusable.
2604 * We share a lock (that we have) with device_del(), so we need to
2609 int usb_deauthorize_device(struct usb_device *usb_dev)
2611 usb_lock_device(usb_dev);
2612 if (usb_dev->authorized == 0)
2613 goto out_unauthorized;
2615 usb_dev->authorized = 0;
2616 usb_set_configuration(usb_dev, -1);
2619 usb_unlock_device(usb_dev);
2624 int usb_authorize_device(struct usb_device *usb_dev)
2628 usb_lock_device(usb_dev);
2629 if (usb_dev->authorized == 1)
2630 goto out_authorized;
2632 result = usb_autoresume_device(usb_dev);
2634 dev_err(&usb_dev->dev,
2635 "can't autoresume for authorization: %d\n", result);
2636 goto error_autoresume;
2639 if (usb_dev->wusb) {
2640 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2642 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2643 "authorization: %d\n", result);
2644 goto error_device_descriptor;
2648 usb_dev->authorized = 1;
2649 /* Choose and set the configuration. This registers the interfaces
2650 * with the driver core and lets interface drivers bind to them.
2652 c = usb_choose_configuration(usb_dev);
2654 result = usb_set_configuration(usb_dev, c);
2656 dev_err(&usb_dev->dev,
2657 "can't set config #%d, error %d\n", c, result);
2658 /* This need not be fatal. The user can try to
2659 * set other configurations. */
2662 dev_info(&usb_dev->dev, "authorized to connect\n");
2664 error_device_descriptor:
2665 usb_autosuspend_device(usb_dev);
2668 usb_unlock_device(usb_dev); /* complements locktree */
2673 * get_port_ssp_rate - Match the extended port status to SSP rate
2674 * @hdev: The hub device
2675 * @ext_portstatus: extended port status
2677 * Match the extended port status speed id to the SuperSpeed Plus sublink speed
2678 * capability attributes. Base on the number of connected lanes and speed,
2679 * return the corresponding enum usb_ssp_rate.
2681 static enum usb_ssp_rate get_port_ssp_rate(struct usb_device *hdev,
2684 struct usb_ssp_cap_descriptor *ssp_cap = hdev->bos->ssp_cap;
2694 speed_id = ext_portstatus & USB_EXT_PORT_STAT_RX_SPEED_ID;
2695 lanes = USB_EXT_PORT_RX_LANES(ext_portstatus) + 1;
2697 ssac = le32_to_cpu(ssp_cap->bmAttributes) &
2698 USB_SSP_SUBLINK_SPEED_ATTRIBS;
2700 for (i = 0; i <= ssac; i++) {
2703 attr = le32_to_cpu(ssp_cap->bmSublinkSpeedAttr[i]);
2704 ssid = FIELD_GET(USB_SSP_SUBLINK_SPEED_SSID, attr);
2705 if (speed_id == ssid) {
2711 * Note: currently asymmetric lane types are only
2712 * applicable for SSIC operate in SuperSpeed protocol
2714 type = FIELD_GET(USB_SSP_SUBLINK_SPEED_ST, attr);
2715 if (type == USB_SSP_SUBLINK_SPEED_ST_ASYM_RX ||
2716 type == USB_SSP_SUBLINK_SPEED_ST_ASYM_TX)
2719 if (FIELD_GET(USB_SSP_SUBLINK_SPEED_LP, attr) !=
2720 USB_SSP_SUBLINK_SPEED_LP_SSP)
2723 lse = FIELD_GET(USB_SSP_SUBLINK_SPEED_LSE, attr);
2724 mantissa = FIELD_GET(USB_SSP_SUBLINK_SPEED_LSM, attr);
2726 /* Convert to Gbps */
2727 for (; lse < USB_SSP_SUBLINK_SPEED_LSE_GBPS; lse++)
2730 if (mantissa >= 10 && lanes == 1)
2731 return USB_SSP_GEN_2x1;
2733 if (mantissa >= 10 && lanes == 2)
2734 return USB_SSP_GEN_2x2;
2736 if (mantissa >= 5 && lanes == 2)
2737 return USB_SSP_GEN_1x2;
2744 return USB_SSP_GEN_UNKNOWN;
2747 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2748 static unsigned hub_is_wusb(struct usb_hub *hub)
2750 struct usb_hcd *hcd;
2751 if (hub->hdev->parent != NULL) /* not a root hub? */
2753 hcd = bus_to_hcd(hub->hdev->bus);
2754 return hcd->wireless;
2758 #ifdef CONFIG_USB_FEW_INIT_RETRIES
2759 #define PORT_RESET_TRIES 2
2760 #define SET_ADDRESS_TRIES 1
2761 #define GET_DESCRIPTOR_TRIES 1
2762 #define GET_MAXPACKET0_TRIES 1
2763 #define PORT_INIT_TRIES 4
2766 #define PORT_RESET_TRIES 5
2767 #define SET_ADDRESS_TRIES 2
2768 #define GET_DESCRIPTOR_TRIES 2
2769 #define GET_MAXPACKET0_TRIES 3
2770 #define PORT_INIT_TRIES 4
2771 #endif /* CONFIG_USB_FEW_INIT_RETRIES */
2773 #define HUB_ROOT_RESET_TIME 60 /* times are in msec */
2774 #define HUB_SHORT_RESET_TIME 10
2775 #define HUB_BH_RESET_TIME 50
2776 #define HUB_LONG_RESET_TIME 200
2777 #define HUB_RESET_TIMEOUT 800
2779 static bool use_new_scheme(struct usb_device *udev, int retry,
2780 struct usb_port *port_dev)
2782 int old_scheme_first_port =
2783 (port_dev->quirks & USB_PORT_QUIRK_OLD_SCHEME) ||
2787 * "New scheme" enumeration causes an extra state transition to be
2788 * exposed to an xhci host and causes USB3 devices to receive control
2789 * commands in the default state. This has been seen to cause
2790 * enumeration failures, so disable this enumeration scheme for USB3
2793 if (udev->speed >= USB_SPEED_SUPER)
2797 * If use_both_schemes is set, use the first scheme (whichever
2798 * it is) for the larger half of the retries, then use the other
2799 * scheme. Otherwise, use the first scheme for all the retries.
2801 if (use_both_schemes && retry >= (PORT_INIT_TRIES + 1) / 2)
2802 return old_scheme_first_port; /* Second half */
2803 return !old_scheme_first_port; /* First half or all */
2806 /* Is a USB 3.0 port in the Inactive or Compliance Mode state?
2807 * Port warm reset is required to recover
2809 static bool hub_port_warm_reset_required(struct usb_hub *hub, int port1,
2814 if (!hub_is_superspeed(hub->hdev))
2817 if (test_bit(port1, hub->warm_reset_bits))
2820 link_state = portstatus & USB_PORT_STAT_LINK_STATE;
2821 return link_state == USB_SS_PORT_LS_SS_INACTIVE
2822 || link_state == USB_SS_PORT_LS_COMP_MOD;
2825 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2826 struct usb_device *udev, unsigned int delay, bool warm)
2828 int delay_time, ret;
2831 u32 ext_portstatus = 0;
2833 for (delay_time = 0;
2834 delay_time < HUB_RESET_TIMEOUT;
2835 delay_time += delay) {
2836 /* wait to give the device a chance to reset */
2839 /* read and decode port status */
2840 if (hub_is_superspeedplus(hub->hdev))
2841 ret = hub_ext_port_status(hub, port1,
2842 HUB_EXT_PORT_STATUS,
2843 &portstatus, &portchange,
2846 ret = hub_port_status(hub, port1, &portstatus,
2852 * The port state is unknown until the reset completes.
2854 * On top of that, some chips may require additional time
2855 * to re-establish a connection after the reset is complete,
2856 * so also wait for the connection to be re-established.
2858 if (!(portstatus & USB_PORT_STAT_RESET) &&
2859 (portstatus & USB_PORT_STAT_CONNECTION))
2862 /* switch to the long delay after two short delay failures */
2863 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2864 delay = HUB_LONG_RESET_TIME;
2866 dev_dbg(&hub->ports[port1 - 1]->dev,
2867 "not %sreset yet, waiting %dms\n",
2868 warm ? "warm " : "", delay);
2871 if ((portstatus & USB_PORT_STAT_RESET))
2874 if (hub_port_warm_reset_required(hub, port1, portstatus))
2877 /* Device went away? */
2878 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2881 /* Retry if connect change is set but status is still connected.
2882 * A USB 3.0 connection may bounce if multiple warm resets were issued,
2883 * but the device may have successfully re-connected. Ignore it.
2885 if (!hub_is_superspeed(hub->hdev) &&
2886 (portchange & USB_PORT_STAT_C_CONNECTION)) {
2887 usb_clear_port_feature(hub->hdev, port1,
2888 USB_PORT_FEAT_C_CONNECTION);
2892 if (!(portstatus & USB_PORT_STAT_ENABLE))
2898 if (hub_is_superspeedplus(hub->hdev)) {
2899 /* extended portstatus Rx and Tx lane count are zero based */
2900 udev->rx_lanes = USB_EXT_PORT_RX_LANES(ext_portstatus) + 1;
2901 udev->tx_lanes = USB_EXT_PORT_TX_LANES(ext_portstatus) + 1;
2902 udev->ssp_rate = get_port_ssp_rate(hub->hdev, ext_portstatus);
2906 udev->ssp_rate = USB_SSP_GEN_UNKNOWN;
2908 if (hub_is_wusb(hub))
2909 udev->speed = USB_SPEED_WIRELESS;
2910 else if (udev->ssp_rate != USB_SSP_GEN_UNKNOWN)
2911 udev->speed = USB_SPEED_SUPER_PLUS;
2912 else if (hub_is_superspeed(hub->hdev))
2913 udev->speed = USB_SPEED_SUPER;
2914 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2915 udev->speed = USB_SPEED_HIGH;
2916 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2917 udev->speed = USB_SPEED_LOW;
2919 udev->speed = USB_SPEED_FULL;
2923 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2924 static int hub_port_reset(struct usb_hub *hub, int port1,
2925 struct usb_device *udev, unsigned int delay, bool warm)
2928 u16 portchange, portstatus;
2929 struct usb_port *port_dev = hub->ports[port1 - 1];
2930 int reset_recovery_time;
2932 if (!hub_is_superspeed(hub->hdev)) {
2934 dev_err(hub->intfdev, "only USB3 hub support "
2938 /* Block EHCI CF initialization during the port reset.
2939 * Some companion controllers don't like it when they mix.
2941 down_read(&ehci_cf_port_reset_rwsem);
2944 * If the caller hasn't explicitly requested a warm reset,
2945 * double check and see if one is needed.
2947 if (hub_port_status(hub, port1, &portstatus, &portchange) == 0)
2948 if (hub_port_warm_reset_required(hub, port1,
2952 clear_bit(port1, hub->warm_reset_bits);
2954 /* Reset the port */
2955 for (i = 0; i < PORT_RESET_TRIES; i++) {
2956 status = set_port_feature(hub->hdev, port1, (warm ?
2957 USB_PORT_FEAT_BH_PORT_RESET :
2958 USB_PORT_FEAT_RESET));
2959 if (status == -ENODEV) {
2960 ; /* The hub is gone */
2961 } else if (status) {
2962 dev_err(&port_dev->dev,
2963 "cannot %sreset (err = %d)\n",
2964 warm ? "warm " : "", status);
2966 status = hub_port_wait_reset(hub, port1, udev, delay,
2968 if (status && status != -ENOTCONN && status != -ENODEV)
2969 dev_dbg(hub->intfdev,
2970 "port_wait_reset: err = %d\n",
2974 /* Check for disconnect or reset */
2975 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2976 usb_clear_port_feature(hub->hdev, port1,
2977 USB_PORT_FEAT_C_RESET);
2979 if (!hub_is_superspeed(hub->hdev))
2982 usb_clear_port_feature(hub->hdev, port1,
2983 USB_PORT_FEAT_C_BH_PORT_RESET);
2984 usb_clear_port_feature(hub->hdev, port1,
2985 USB_PORT_FEAT_C_PORT_LINK_STATE);
2988 usb_clear_port_feature(hub->hdev, port1,
2989 USB_PORT_FEAT_C_CONNECTION);
2992 * If a USB 3.0 device migrates from reset to an error
2993 * state, re-issue the warm reset.
2995 if (hub_port_status(hub, port1,
2996 &portstatus, &portchange) < 0)
2999 if (!hub_port_warm_reset_required(hub, port1,
3004 * If the port is in SS.Inactive or Compliance Mode, the
3005 * hot or warm reset failed. Try another warm reset.
3008 dev_dbg(&port_dev->dev,
3009 "hot reset failed, warm reset\n");
3014 dev_dbg(&port_dev->dev,
3015 "not enabled, trying %sreset again...\n",
3016 warm ? "warm " : "");
3017 delay = HUB_LONG_RESET_TIME;
3020 dev_err(&port_dev->dev, "Cannot enable. Maybe the USB cable is bad?\n");
3024 if (port_dev->quirks & USB_PORT_QUIRK_FAST_ENUM)
3025 usleep_range(10000, 12000);
3027 /* TRSTRCY = 10 ms; plus some extra */
3028 reset_recovery_time = 10 + 40;
3030 /* Hub needs extra delay after resetting its port. */
3031 if (hub->hdev->quirks & USB_QUIRK_HUB_SLOW_RESET)
3032 reset_recovery_time += 100;
3034 msleep(reset_recovery_time);
3038 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3040 update_devnum(udev, 0);
3041 /* The xHC may think the device is already reset,
3042 * so ignore the status.
3044 if (hcd->driver->reset_device)
3045 hcd->driver->reset_device(hcd, udev);
3047 usb_set_device_state(udev, USB_STATE_DEFAULT);
3051 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
3054 if (!hub_is_superspeed(hub->hdev))
3055 up_read(&ehci_cf_port_reset_rwsem);
3060 /* Check if a port is power on */
3061 static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
3065 if (hub_is_superspeed(hub->hdev)) {
3066 if (portstatus & USB_SS_PORT_STAT_POWER)
3069 if (portstatus & USB_PORT_STAT_POWER)
3076 static void usb_lock_port(struct usb_port *port_dev)
3077 __acquires(&port_dev->status_lock)
3079 mutex_lock(&port_dev->status_lock);
3080 __acquire(&port_dev->status_lock);
3083 static void usb_unlock_port(struct usb_port *port_dev)
3084 __releases(&port_dev->status_lock)
3086 mutex_unlock(&port_dev->status_lock);
3087 __release(&port_dev->status_lock);
3092 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
3093 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
3097 if (hub_is_superspeed(hub->hdev)) {
3098 if ((portstatus & USB_PORT_STAT_LINK_STATE)
3099 == USB_SS_PORT_LS_U3)
3102 if (portstatus & USB_PORT_STAT_SUSPEND)
3109 /* Determine whether the device on a port is ready for a normal resume,
3110 * is ready for a reset-resume, or should be disconnected.
3112 static int check_port_resume_type(struct usb_device *udev,
3113 struct usb_hub *hub, int port1,
3114 int status, u16 portchange, u16 portstatus)
3116 struct usb_port *port_dev = hub->ports[port1 - 1];
3120 /* Is a warm reset needed to recover the connection? */
3121 if (status == 0 && udev->reset_resume
3122 && hub_port_warm_reset_required(hub, port1, portstatus)) {
3125 /* Is the device still present? */
3126 else if (status || port_is_suspended(hub, portstatus) ||
3127 !port_is_power_on(hub, portstatus)) {
3130 } else if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
3132 usleep_range(200, 300);
3133 status = hub_port_status(hub, port1, &portstatus,
3140 /* Can't do a normal resume if the port isn't enabled,
3141 * so try a reset-resume instead.
3143 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
3144 if (udev->persist_enabled)
3145 udev->reset_resume = 1;
3151 dev_dbg(&port_dev->dev, "status %04x.%04x after resume, %d\n",
3152 portchange, portstatus, status);
3153 } else if (udev->reset_resume) {
3155 /* Late port handoff can set status-change bits */
3156 if (portchange & USB_PORT_STAT_C_CONNECTION)
3157 usb_clear_port_feature(hub->hdev, port1,
3158 USB_PORT_FEAT_C_CONNECTION);
3159 if (portchange & USB_PORT_STAT_C_ENABLE)
3160 usb_clear_port_feature(hub->hdev, port1,
3161 USB_PORT_FEAT_C_ENABLE);
3164 * Whatever made this reset-resume necessary may have
3165 * turned on the port1 bit in hub->change_bits. But after
3166 * a successful reset-resume we want the bit to be clear;
3167 * if it was on it would indicate that something happened
3168 * following the reset-resume.
3170 clear_bit(port1, hub->change_bits);
3176 int usb_disable_ltm(struct usb_device *udev)
3178 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3180 /* Check if the roothub and device supports LTM. */
3181 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
3182 !usb_device_supports_ltm(udev))
3185 /* Clear Feature LTM Enable can only be sent if the device is
3188 if (!udev->actconfig)
3191 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3192 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
3193 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
3194 USB_CTRL_SET_TIMEOUT);
3196 EXPORT_SYMBOL_GPL(usb_disable_ltm);
3198 void usb_enable_ltm(struct usb_device *udev)
3200 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3202 /* Check if the roothub and device supports LTM. */
3203 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
3204 !usb_device_supports_ltm(udev))
3207 /* Set Feature LTM Enable can only be sent if the device is
3210 if (!udev->actconfig)
3213 usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3214 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
3215 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
3216 USB_CTRL_SET_TIMEOUT);
3218 EXPORT_SYMBOL_GPL(usb_enable_ltm);
3221 * usb_enable_remote_wakeup - enable remote wakeup for a device
3222 * @udev: target device
3224 * For USB-2 devices: Set the device's remote wakeup feature.
3226 * For USB-3 devices: Assume there's only one function on the device and
3227 * enable remote wake for the first interface. FIXME if the interface
3228 * association descriptor shows there's more than one function.
3230 static int usb_enable_remote_wakeup(struct usb_device *udev)
3232 if (udev->speed < USB_SPEED_SUPER)
3233 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3234 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
3235 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
3236 USB_CTRL_SET_TIMEOUT);
3238 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3239 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
3240 USB_INTRF_FUNC_SUSPEND,
3241 USB_INTRF_FUNC_SUSPEND_RW |
3242 USB_INTRF_FUNC_SUSPEND_LP,
3243 NULL, 0, USB_CTRL_SET_TIMEOUT);
3247 * usb_disable_remote_wakeup - disable remote wakeup for a device
3248 * @udev: target device
3250 * For USB-2 devices: Clear the device's remote wakeup feature.
3252 * For USB-3 devices: Assume there's only one function on the device and
3253 * disable remote wake for the first interface. FIXME if the interface
3254 * association descriptor shows there's more than one function.
3256 static int usb_disable_remote_wakeup(struct usb_device *udev)
3258 if (udev->speed < USB_SPEED_SUPER)
3259 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3260 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
3261 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
3262 USB_CTRL_SET_TIMEOUT);
3264 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3265 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
3266 USB_INTRF_FUNC_SUSPEND, 0, NULL, 0,
3267 USB_CTRL_SET_TIMEOUT);
3270 /* Count of wakeup-enabled devices at or below udev */
3271 unsigned usb_wakeup_enabled_descendants(struct usb_device *udev)
3273 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
3275 return udev->do_remote_wakeup +
3276 (hub ? hub->wakeup_enabled_descendants : 0);
3278 EXPORT_SYMBOL_GPL(usb_wakeup_enabled_descendants);
3281 * usb_port_suspend - suspend a usb device's upstream port
3282 * @udev: device that's no longer in active use, not a root hub
3283 * Context: must be able to sleep; device not locked; pm locks held
3285 * Suspends a USB device that isn't in active use, conserving power.
3286 * Devices may wake out of a suspend, if anything important happens,
3287 * using the remote wakeup mechanism. They may also be taken out of
3288 * suspend by the host, using usb_port_resume(). It's also routine
3289 * to disconnect devices while they are suspended.
3291 * This only affects the USB hardware for a device; its interfaces
3292 * (and, for hubs, child devices) must already have been suspended.
3294 * Selective port suspend reduces power; most suspended devices draw
3295 * less than 500 uA. It's also used in OTG, along with remote wakeup.
3296 * All devices below the suspended port are also suspended.
3298 * Devices leave suspend state when the host wakes them up. Some devices
3299 * also support "remote wakeup", where the device can activate the USB
3300 * tree above them to deliver data, such as a keypress or packet. In
3301 * some cases, this wakes the USB host.
3303 * Suspending OTG devices may trigger HNP, if that's been enabled
3304 * between a pair of dual-role devices. That will change roles, such
3305 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
3307 * Devices on USB hub ports have only one "suspend" state, corresponding
3308 * to ACPI D2, "may cause the device to lose some context".
3309 * State transitions include:
3311 * - suspend, resume ... when the VBUS power link stays live
3312 * - suspend, disconnect ... VBUS lost
3314 * Once VBUS drop breaks the circuit, the port it's using has to go through
3315 * normal re-enumeration procedures, starting with enabling VBUS power.
3316 * Other than re-initializing the hub (plug/unplug, except for root hubs),
3317 * Linux (2.6) currently has NO mechanisms to initiate that: no hub_wq
3318 * timer, no SRP, no requests through sysfs.
3320 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
3321 * suspended until their bus goes into global suspend (i.e., the root
3322 * hub is suspended). Nevertheless, we change @udev->state to
3323 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
3324 * upstream port setting is stored in @udev->port_is_suspended.
3326 * Returns 0 on success, else negative errno.
3328 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
3330 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3331 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3332 int port1 = udev->portnum;
3334 bool really_suspend = true;
3336 usb_lock_port(port_dev);
3338 /* enable remote wakeup when appropriate; this lets the device
3339 * wake up the upstream hub (including maybe the root hub).
3341 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
3342 * we don't explicitly enable it here.
3344 if (udev->do_remote_wakeup) {
3345 status = usb_enable_remote_wakeup(udev);
3347 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
3349 /* bail if autosuspend is requested */
3350 if (PMSG_IS_AUTO(msg))
3355 /* disable USB2 hardware LPM */
3356 usb_disable_usb2_hardware_lpm(udev);
3358 if (usb_disable_ltm(udev)) {
3359 dev_err(&udev->dev, "Failed to disable LTM before suspend\n");
3361 if (PMSG_IS_AUTO(msg))
3366 if (hub_is_superspeed(hub->hdev))
3367 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U3);
3370 * For system suspend, we do not need to enable the suspend feature
3371 * on individual USB-2 ports. The devices will automatically go
3372 * into suspend a few ms after the root hub stops sending packets.
3373 * The USB 2.0 spec calls this "global suspend".
3375 * However, many USB hubs have a bug: They don't relay wakeup requests
3376 * from a downstream port if the port's suspend feature isn't on.
3377 * Therefore we will turn on the suspend feature if udev or any of its
3378 * descendants is enabled for remote wakeup.
3380 else if (PMSG_IS_AUTO(msg) || usb_wakeup_enabled_descendants(udev) > 0)
3381 status = set_port_feature(hub->hdev, port1,
3382 USB_PORT_FEAT_SUSPEND);
3384 really_suspend = false;
3388 dev_dbg(&port_dev->dev, "can't suspend, status %d\n", status);
3390 /* Try to enable USB3 LTM again */
3391 usb_enable_ltm(udev);
3393 /* Try to enable USB2 hardware LPM again */
3394 usb_enable_usb2_hardware_lpm(udev);
3396 if (udev->do_remote_wakeup)
3397 (void) usb_disable_remote_wakeup(udev);
3400 /* System sleep transitions should never fail */
3401 if (!PMSG_IS_AUTO(msg))
3404 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
3405 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
3406 udev->do_remote_wakeup);
3407 if (really_suspend) {
3408 udev->port_is_suspended = 1;
3410 /* device has up to 10 msec to fully suspend */
3413 usb_set_device_state(udev, USB_STATE_SUSPENDED);
3416 if (status == 0 && !udev->do_remote_wakeup && udev->persist_enabled
3417 && test_and_clear_bit(port1, hub->child_usage_bits))
3418 pm_runtime_put_sync(&port_dev->dev);
3420 usb_mark_last_busy(hub->hdev);
3422 usb_unlock_port(port_dev);
3427 * If the USB "suspend" state is in use (rather than "global suspend"),
3428 * many devices will be individually taken out of suspend state using
3429 * special "resume" signaling. This routine kicks in shortly after
3430 * hardware resume signaling is finished, either because of selective
3431 * resume (by host) or remote wakeup (by device) ... now see what changed
3432 * in the tree that's rooted at this device.
3434 * If @udev->reset_resume is set then the device is reset before the
3435 * status check is done.
3437 static int finish_port_resume(struct usb_device *udev)
3442 /* caller owns the udev device lock */
3443 dev_dbg(&udev->dev, "%s\n",
3444 udev->reset_resume ? "finish reset-resume" : "finish resume");
3446 /* usb ch9 identifies four variants of SUSPENDED, based on what
3447 * state the device resumes to. Linux currently won't see the
3448 * first two on the host side; they'd be inside hub_port_init()
3449 * during many timeouts, but hub_wq can't suspend until later.
3451 usb_set_device_state(udev, udev->actconfig
3452 ? USB_STATE_CONFIGURED
3453 : USB_STATE_ADDRESS);
3455 /* 10.5.4.5 says not to reset a suspended port if the attached
3456 * device is enabled for remote wakeup. Hence the reset
3457 * operation is carried out here, after the port has been
3460 if (udev->reset_resume) {
3462 * If the device morphs or switches modes when it is reset,
3463 * we don't want to perform a reset-resume. We'll fail the
3464 * resume, which will cause a logical disconnect, and then
3465 * the device will be rediscovered.
3468 if (udev->quirks & USB_QUIRK_RESET)
3471 status = usb_reset_and_verify_device(udev);
3474 /* 10.5.4.5 says be sure devices in the tree are still there.
3475 * For now let's assume the device didn't go crazy on resume,
3476 * and device drivers will know about any resume quirks.
3480 status = usb_get_std_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
3482 /* If a normal resume failed, try doing a reset-resume */
3483 if (status && !udev->reset_resume && udev->persist_enabled) {
3484 dev_dbg(&udev->dev, "retry with reset-resume\n");
3485 udev->reset_resume = 1;
3486 goto retry_reset_resume;
3491 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
3494 * There are a few quirky devices which violate the standard
3495 * by claiming to have remote wakeup enabled after a reset,
3496 * which crash if the feature is cleared, hence check for
3497 * udev->reset_resume
3499 } else if (udev->actconfig && !udev->reset_resume) {
3500 if (udev->speed < USB_SPEED_SUPER) {
3501 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
3502 status = usb_disable_remote_wakeup(udev);
3504 status = usb_get_std_status(udev, USB_RECIP_INTERFACE, 0,
3506 if (!status && devstatus & (USB_INTRF_STAT_FUNC_RW_CAP
3507 | USB_INTRF_STAT_FUNC_RW))
3508 status = usb_disable_remote_wakeup(udev);
3513 "disable remote wakeup, status %d\n",
3521 * There are some SS USB devices which take longer time for link training.
3522 * XHCI specs 4.19.4 says that when Link training is successful, port
3523 * sets CCS bit to 1. So if SW reads port status before successful link
3524 * training, then it will not find device to be present.
3525 * USB Analyzer log with such buggy devices show that in some cases
3526 * device switch on the RX termination after long delay of host enabling
3527 * the VBUS. In few other cases it has been seen that device fails to
3528 * negotiate link training in first attempt. It has been
3529 * reported till now that few devices take as long as 2000 ms to train
3530 * the link after host enabling its VBUS and termination. Following
3531 * routine implements a 2000 ms timeout for link training. If in a case
3532 * link trains before timeout, loop will exit earlier.
3534 * There are also some 2.0 hard drive based devices and 3.0 thumb
3535 * drives that, when plugged into a 2.0 only port, take a long
3536 * time to set CCS after VBUS enable.
3538 * FIXME: If a device was connected before suspend, but was removed
3539 * while system was asleep, then the loop in the following routine will
3540 * only exit at timeout.
3542 * This routine should only be called when persist is enabled.
3544 static int wait_for_connected(struct usb_device *udev,
3545 struct usb_hub *hub, int *port1,
3546 u16 *portchange, u16 *portstatus)
3548 int status = 0, delay_ms = 0;
3550 while (delay_ms < 2000) {
3551 if (status || *portstatus & USB_PORT_STAT_CONNECTION)
3553 if (!port_is_power_on(hub, *portstatus)) {
3559 status = hub_port_status(hub, *port1, portstatus, portchange);
3561 dev_dbg(&udev->dev, "Waited %dms for CONNECT\n", delay_ms);
3566 * usb_port_resume - re-activate a suspended usb device's upstream port
3567 * @udev: device to re-activate, not a root hub
3568 * Context: must be able to sleep; device not locked; pm locks held
3570 * This will re-activate the suspended device, increasing power usage
3571 * while letting drivers communicate again with its endpoints.
3572 * USB resume explicitly guarantees that the power session between
3573 * the host and the device is the same as it was when the device
3576 * If @udev->reset_resume is set then this routine won't check that the
3577 * port is still enabled. Furthermore, finish_port_resume() above will
3578 * reset @udev. The end result is that a broken power session can be
3579 * recovered and @udev will appear to persist across a loss of VBUS power.
3581 * For example, if a host controller doesn't maintain VBUS suspend current
3582 * during a system sleep or is reset when the system wakes up, all the USB
3583 * power sessions below it will be broken. This is especially troublesome
3584 * for mass-storage devices containing mounted filesystems, since the
3585 * device will appear to have disconnected and all the memory mappings
3586 * to it will be lost. Using the USB_PERSIST facility, the device can be
3587 * made to appear as if it had not disconnected.
3589 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3590 * every effort to insure that the same device is present after the
3591 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3592 * quite possible for a device to remain unaltered but its media to be
3593 * changed. If the user replaces a flash memory card while the system is
3594 * asleep, he will have only himself to blame when the filesystem on the
3595 * new card is corrupted and the system crashes.
3597 * Returns 0 on success, else negative errno.
3599 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
3601 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3602 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3603 int port1 = udev->portnum;
3605 u16 portchange, portstatus;
3607 if (!test_and_set_bit(port1, hub->child_usage_bits)) {
3608 status = pm_runtime_resume_and_get(&port_dev->dev);
3610 dev_dbg(&udev->dev, "can't resume usb port, status %d\n",
3616 usb_lock_port(port_dev);
3618 /* Skip the initial Clear-Suspend step for a remote wakeup */
3619 status = hub_port_status(hub, port1, &portstatus, &portchange);
3620 if (status == 0 && !port_is_suspended(hub, portstatus)) {
3621 if (portchange & USB_PORT_STAT_C_SUSPEND)
3622 pm_wakeup_event(&udev->dev, 0);
3623 goto SuspendCleared;
3626 /* see 7.1.7.7; affects power usage, but not budgeting */
3627 if (hub_is_superspeed(hub->hdev))
3628 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U0);
3630 status = usb_clear_port_feature(hub->hdev,
3631 port1, USB_PORT_FEAT_SUSPEND);
3633 dev_dbg(&port_dev->dev, "can't resume, status %d\n", status);
3635 /* drive resume for USB_RESUME_TIMEOUT msec */
3636 dev_dbg(&udev->dev, "usb %sresume\n",
3637 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
3638 msleep(USB_RESUME_TIMEOUT);
3640 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3641 * stop resume signaling. Then finish the resume
3644 status = hub_port_status(hub, port1, &portstatus, &portchange);
3649 udev->port_is_suspended = 0;
3650 if (hub_is_superspeed(hub->hdev)) {
3651 if (portchange & USB_PORT_STAT_C_LINK_STATE)
3652 usb_clear_port_feature(hub->hdev, port1,
3653 USB_PORT_FEAT_C_PORT_LINK_STATE);
3655 if (portchange & USB_PORT_STAT_C_SUSPEND)
3656 usb_clear_port_feature(hub->hdev, port1,
3657 USB_PORT_FEAT_C_SUSPEND);
3660 /* TRSMRCY = 10 msec */
3664 if (udev->persist_enabled)
3665 status = wait_for_connected(udev, hub, &port1, &portchange,
3668 status = check_port_resume_type(udev,
3669 hub, port1, status, portchange, portstatus);
3671 status = finish_port_resume(udev);
3673 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
3674 hub_port_logical_disconnect(hub, port1);
3676 /* Try to enable USB2 hardware LPM */
3677 usb_enable_usb2_hardware_lpm(udev);
3679 /* Try to enable USB3 LTM */
3680 usb_enable_ltm(udev);
3683 usb_unlock_port(port_dev);
3688 int usb_remote_wakeup(struct usb_device *udev)
3692 usb_lock_device(udev);
3693 if (udev->state == USB_STATE_SUSPENDED) {
3694 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
3695 status = usb_autoresume_device(udev);
3697 /* Let the drivers do their thing, then... */
3698 usb_autosuspend_device(udev);
3701 usb_unlock_device(udev);
3705 /* Returns 1 if there was a remote wakeup and a connect status change. */
3706 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
3707 u16 portstatus, u16 portchange)
3708 __must_hold(&port_dev->status_lock)
3710 struct usb_port *port_dev = hub->ports[port - 1];
3711 struct usb_device *hdev;
3712 struct usb_device *udev;
3713 int connect_change = 0;
3718 udev = port_dev->child;
3719 if (!hub_is_superspeed(hdev)) {
3720 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
3722 usb_clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
3724 link_state = portstatus & USB_PORT_STAT_LINK_STATE;
3725 if (!udev || udev->state != USB_STATE_SUSPENDED ||
3726 (link_state != USB_SS_PORT_LS_U0 &&
3727 link_state != USB_SS_PORT_LS_U1 &&
3728 link_state != USB_SS_PORT_LS_U2))
3733 /* TRSMRCY = 10 msec */
3736 usb_unlock_port(port_dev);
3737 ret = usb_remote_wakeup(udev);
3738 usb_lock_port(port_dev);
3743 hub_port_disable(hub, port, 1);
3745 dev_dbg(&port_dev->dev, "resume, status %d\n", ret);
3746 return connect_change;
3749 static int check_ports_changed(struct usb_hub *hub)
3753 for (port1 = 1; port1 <= hub->hdev->maxchild; ++port1) {
3754 u16 portstatus, portchange;
3757 status = hub_port_status(hub, port1, &portstatus, &portchange);
3758 if (!status && portchange)
3764 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
3766 struct usb_hub *hub = usb_get_intfdata(intf);
3767 struct usb_device *hdev = hub->hdev;
3771 * Warn if children aren't already suspended.
3772 * Also, add up the number of wakeup-enabled descendants.
3774 hub->wakeup_enabled_descendants = 0;
3775 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3776 struct usb_port *port_dev = hub->ports[port1 - 1];
3777 struct usb_device *udev = port_dev->child;
3779 if (udev && udev->can_submit) {
3780 dev_warn(&port_dev->dev, "device %s not suspended yet\n",
3781 dev_name(&udev->dev));
3782 if (PMSG_IS_AUTO(msg))
3786 hub->wakeup_enabled_descendants +=
3787 usb_wakeup_enabled_descendants(udev);
3790 if (hdev->do_remote_wakeup && hub->quirk_check_port_auto_suspend) {
3791 /* check if there are changes pending on hub ports */
3792 if (check_ports_changed(hub)) {
3793 if (PMSG_IS_AUTO(msg))
3795 pm_wakeup_event(&hdev->dev, 2000);
3799 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
3800 /* Enable hub to send remote wakeup for all ports. */
3801 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3802 set_port_feature(hdev,
3804 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
3805 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
3806 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
3807 USB_PORT_FEAT_REMOTE_WAKE_MASK);
3811 dev_dbg(&intf->dev, "%s\n", __func__);
3813 /* stop hub_wq and related activity */
3814 hub_quiesce(hub, HUB_SUSPEND);
3818 /* Report wakeup requests from the ports of a resuming root hub */
3819 static void report_wakeup_requests(struct usb_hub *hub)
3821 struct usb_device *hdev = hub->hdev;
3822 struct usb_device *udev;
3823 struct usb_hcd *hcd;
3824 unsigned long resuming_ports;
3828 return; /* Not a root hub */
3830 hcd = bus_to_hcd(hdev->bus);
3831 if (hcd->driver->get_resuming_ports) {
3834 * The get_resuming_ports() method returns a bitmap (origin 0)
3835 * of ports which have started wakeup signaling but have not
3836 * yet finished resuming. During system resume we will
3837 * resume all the enabled ports, regardless of any wakeup
3838 * signals, which means the wakeup requests would be lost.
3839 * To prevent this, report them to the PM core here.
3841 resuming_ports = hcd->driver->get_resuming_ports(hcd);
3842 for (i = 0; i < hdev->maxchild; ++i) {
3843 if (test_bit(i, &resuming_ports)) {
3844 udev = hub->ports[i]->child;
3846 pm_wakeup_event(&udev->dev, 0);
3852 static int hub_resume(struct usb_interface *intf)
3854 struct usb_hub *hub = usb_get_intfdata(intf);
3856 dev_dbg(&intf->dev, "%s\n", __func__);
3857 hub_activate(hub, HUB_RESUME);
3860 * This should be called only for system resume, not runtime resume.
3861 * We can't tell the difference here, so some wakeup requests will be
3862 * reported at the wrong time or more than once. This shouldn't
3863 * matter much, so long as they do get reported.
3865 report_wakeup_requests(hub);
3869 static int hub_reset_resume(struct usb_interface *intf)
3871 struct usb_hub *hub = usb_get_intfdata(intf);
3873 dev_dbg(&intf->dev, "%s\n", __func__);
3874 hub_activate(hub, HUB_RESET_RESUME);
3879 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3880 * @rhdev: struct usb_device for the root hub
3882 * The USB host controller driver calls this function when its root hub
3883 * is resumed and Vbus power has been interrupted or the controller
3884 * has been reset. The routine marks @rhdev as having lost power.
3885 * When the hub driver is resumed it will take notice and carry out
3886 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3887 * the others will be disconnected.
3889 void usb_root_hub_lost_power(struct usb_device *rhdev)
3891 dev_notice(&rhdev->dev, "root hub lost power or was reset\n");
3892 rhdev->reset_resume = 1;
3894 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
3896 static const char * const usb3_lpm_names[] = {
3904 * Send a Set SEL control transfer to the device, prior to enabling
3905 * device-initiated U1 or U2. This lets the device know the exit latencies from
3906 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3907 * packet from the host.
3909 * This function will fail if the SEL or PEL values for udev are greater than
3910 * the maximum allowed values for the link state to be enabled.
3912 static int usb_req_set_sel(struct usb_device *udev, enum usb3_link_state state)
3914 struct usb_set_sel_req *sel_values;
3915 unsigned long long u1_sel;
3916 unsigned long long u1_pel;
3917 unsigned long long u2_sel;
3918 unsigned long long u2_pel;
3921 if (udev->state != USB_STATE_CONFIGURED)
3924 /* Convert SEL and PEL stored in ns to us */
3925 u1_sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
3926 u1_pel = DIV_ROUND_UP(udev->u1_params.pel, 1000);
3927 u2_sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
3928 u2_pel = DIV_ROUND_UP(udev->u2_params.pel, 1000);
3931 * Make sure that the calculated SEL and PEL values for the link
3932 * state we're enabling aren't bigger than the max SEL/PEL
3933 * value that will fit in the SET SEL control transfer.
3934 * Otherwise the device would get an incorrect idea of the exit
3935 * latency for the link state, and could start a device-initiated
3936 * U1/U2 when the exit latencies are too high.
3938 if ((state == USB3_LPM_U1 &&
3939 (u1_sel > USB3_LPM_MAX_U1_SEL_PEL ||
3940 u1_pel > USB3_LPM_MAX_U1_SEL_PEL)) ||
3941 (state == USB3_LPM_U2 &&
3942 (u2_sel > USB3_LPM_MAX_U2_SEL_PEL ||
3943 u2_pel > USB3_LPM_MAX_U2_SEL_PEL))) {
3944 dev_dbg(&udev->dev, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3945 usb3_lpm_names[state], u1_sel, u1_pel);
3950 * If we're enabling device-initiated LPM for one link state,
3951 * but the other link state has a too high SEL or PEL value,
3952 * just set those values to the max in the Set SEL request.
3954 if (u1_sel > USB3_LPM_MAX_U1_SEL_PEL)
3955 u1_sel = USB3_LPM_MAX_U1_SEL_PEL;
3957 if (u1_pel > USB3_LPM_MAX_U1_SEL_PEL)
3958 u1_pel = USB3_LPM_MAX_U1_SEL_PEL;
3960 if (u2_sel > USB3_LPM_MAX_U2_SEL_PEL)
3961 u2_sel = USB3_LPM_MAX_U2_SEL_PEL;
3963 if (u2_pel > USB3_LPM_MAX_U2_SEL_PEL)
3964 u2_pel = USB3_LPM_MAX_U2_SEL_PEL;
3967 * usb_enable_lpm() can be called as part of a failed device reset,
3968 * which may be initiated by an error path of a mass storage driver.
3969 * Therefore, use GFP_NOIO.
3971 sel_values = kmalloc(sizeof *(sel_values), GFP_NOIO);
3975 sel_values->u1_sel = u1_sel;
3976 sel_values->u1_pel = u1_pel;
3977 sel_values->u2_sel = cpu_to_le16(u2_sel);
3978 sel_values->u2_pel = cpu_to_le16(u2_pel);
3980 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3984 sel_values, sizeof *(sel_values),
3985 USB_CTRL_SET_TIMEOUT);
3991 * Enable or disable device-initiated U1 or U2 transitions.
3993 static int usb_set_device_initiated_lpm(struct usb_device *udev,
3994 enum usb3_link_state state, bool enable)
4001 feature = USB_DEVICE_U1_ENABLE;
4004 feature = USB_DEVICE_U2_ENABLE;
4007 dev_warn(&udev->dev, "%s: Can't %s non-U1 or U2 state.\n",
4008 __func__, enable ? "enable" : "disable");
4012 if (udev->state != USB_STATE_CONFIGURED) {
4013 dev_dbg(&udev->dev, "%s: Can't %s %s state "
4014 "for unconfigured device.\n",
4015 __func__, enable ? "enable" : "disable",
4016 usb3_lpm_names[state]);
4022 * Now send the control transfer to enable device-initiated LPM
4023 * for either U1 or U2.
4025 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
4026 USB_REQ_SET_FEATURE,
4030 USB_CTRL_SET_TIMEOUT);
4032 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
4033 USB_REQ_CLEAR_FEATURE,
4037 USB_CTRL_SET_TIMEOUT);
4040 dev_warn(&udev->dev, "%s of device-initiated %s failed.\n",
4041 enable ? "Enable" : "Disable",
4042 usb3_lpm_names[state]);
4048 static int usb_set_lpm_timeout(struct usb_device *udev,
4049 enum usb3_link_state state, int timeout)
4056 feature = USB_PORT_FEAT_U1_TIMEOUT;
4059 feature = USB_PORT_FEAT_U2_TIMEOUT;
4062 dev_warn(&udev->dev, "%s: Can't set timeout for non-U1 or U2 state.\n",
4067 if (state == USB3_LPM_U1 && timeout > USB3_LPM_U1_MAX_TIMEOUT &&
4068 timeout != USB3_LPM_DEVICE_INITIATED) {
4069 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x, "
4070 "which is a reserved value.\n",
4071 usb3_lpm_names[state], timeout);
4075 ret = set_port_feature(udev->parent,
4076 USB_PORT_LPM_TIMEOUT(timeout) | udev->portnum,
4079 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x,"
4080 "error code %i\n", usb3_lpm_names[state],
4084 if (state == USB3_LPM_U1)
4085 udev->u1_params.timeout = timeout;
4087 udev->u2_params.timeout = timeout;
4092 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
4095 * We will attempt to enable U1 or U2, but there are no guarantees that the
4096 * control transfers to set the hub timeout or enable device-initiated U1/U2
4097 * will be successful.
4099 * If the control transfer to enable device-initiated U1/U2 entry fails, then
4100 * hub-initiated U1/U2 will be disabled.
4102 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
4103 * driver know about it. If that call fails, it should be harmless, and just
4104 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
4106 static void usb_enable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
4107 enum usb3_link_state state)
4110 __u8 u1_mel = udev->bos->ss_cap->bU1devExitLat;
4111 __le16 u2_mel = udev->bos->ss_cap->bU2DevExitLat;
4113 /* If the device says it doesn't have *any* exit latency to come out of
4114 * U1 or U2, it's probably lying. Assume it doesn't implement that link
4117 if ((state == USB3_LPM_U1 && u1_mel == 0) ||
4118 (state == USB3_LPM_U2 && u2_mel == 0))
4122 * First, let the device know about the exit latencies
4123 * associated with the link state we're about to enable.
4125 ret = usb_req_set_sel(udev, state);
4127 dev_warn(&udev->dev, "Set SEL for device-initiated %s failed.\n",
4128 usb3_lpm_names[state]);
4132 /* We allow the host controller to set the U1/U2 timeout internally
4133 * first, so that it can change its schedule to account for the
4134 * additional latency to send data to a device in a lower power
4137 timeout = hcd->driver->enable_usb3_lpm_timeout(hcd, udev, state);
4139 /* xHCI host controller doesn't want to enable this LPM state. */
4144 dev_warn(&udev->dev, "Could not enable %s link state, "
4145 "xHCI error %i.\n", usb3_lpm_names[state],
4150 if (usb_set_lpm_timeout(udev, state, timeout)) {
4151 /* If we can't set the parent hub U1/U2 timeout,
4152 * device-initiated LPM won't be allowed either, so let the xHCI
4153 * host know that this link state won't be enabled.
4155 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
4159 /* Only a configured device will accept the Set Feature
4162 if (udev->actconfig &&
4163 usb_set_device_initiated_lpm(udev, state, true) == 0) {
4164 if (state == USB3_LPM_U1)
4165 udev->usb3_lpm_u1_enabled = 1;
4166 else if (state == USB3_LPM_U2)
4167 udev->usb3_lpm_u2_enabled = 1;
4169 /* Don't request U1/U2 entry if the device
4170 * cannot transition to U1/U2.
4172 usb_set_lpm_timeout(udev, state, 0);
4173 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
4178 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
4181 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
4182 * If zero is returned, the parent will not allow the link to go into U1/U2.
4184 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
4185 * it won't have an effect on the bus link state because the parent hub will
4186 * still disallow device-initiated U1/U2 entry.
4188 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
4189 * possible. The result will be slightly more bus bandwidth will be taken up
4190 * (to account for U1/U2 exit latency), but it should be harmless.
4192 static int usb_disable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
4193 enum usb3_link_state state)
4200 dev_warn(&udev->dev, "%s: Can't disable non-U1 or U2 state.\n",
4205 if (usb_set_lpm_timeout(udev, state, 0))
4208 usb_set_device_initiated_lpm(udev, state, false);
4210 if (hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state))
4211 dev_warn(&udev->dev, "Could not disable xHCI %s timeout, "
4212 "bus schedule bandwidth may be impacted.\n",
4213 usb3_lpm_names[state]);
4215 /* As soon as usb_set_lpm_timeout(0) return 0, hub initiated LPM
4216 * is disabled. Hub will disallows link to enter U1/U2 as well,
4217 * even device is initiating LPM. Hence LPM is disabled if hub LPM
4218 * timeout set to 0, no matter device-initiated LPM is disabled or
4221 if (state == USB3_LPM_U1)
4222 udev->usb3_lpm_u1_enabled = 0;
4223 else if (state == USB3_LPM_U2)
4224 udev->usb3_lpm_u2_enabled = 0;
4230 * Disable hub-initiated and device-initiated U1 and U2 entry.
4231 * Caller must own the bandwidth_mutex.
4233 * This will call usb_enable_lpm() on failure, which will decrement
4234 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
4236 int usb_disable_lpm(struct usb_device *udev)
4238 struct usb_hcd *hcd;
4240 if (!udev || !udev->parent ||
4241 udev->speed < USB_SPEED_SUPER ||
4242 !udev->lpm_capable ||
4243 udev->state < USB_STATE_CONFIGURED)
4246 hcd = bus_to_hcd(udev->bus);
4247 if (!hcd || !hcd->driver->disable_usb3_lpm_timeout)
4250 udev->lpm_disable_count++;
4251 if ((udev->u1_params.timeout == 0 && udev->u2_params.timeout == 0))
4254 /* If LPM is enabled, attempt to disable it. */
4255 if (usb_disable_link_state(hcd, udev, USB3_LPM_U1))
4257 if (usb_disable_link_state(hcd, udev, USB3_LPM_U2))
4263 usb_enable_lpm(udev);
4266 EXPORT_SYMBOL_GPL(usb_disable_lpm);
4268 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
4269 int usb_unlocked_disable_lpm(struct usb_device *udev)
4271 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4277 mutex_lock(hcd->bandwidth_mutex);
4278 ret = usb_disable_lpm(udev);
4279 mutex_unlock(hcd->bandwidth_mutex);
4283 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
4286 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
4287 * xHCI host policy may prevent U1 or U2 from being enabled.
4289 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
4290 * until the lpm_disable_count drops to zero. Caller must own the
4293 void usb_enable_lpm(struct usb_device *udev)
4295 struct usb_hcd *hcd;
4296 struct usb_hub *hub;
4297 struct usb_port *port_dev;
4299 if (!udev || !udev->parent ||
4300 udev->speed < USB_SPEED_SUPER ||
4301 !udev->lpm_capable ||
4302 udev->state < USB_STATE_CONFIGURED)
4305 udev->lpm_disable_count--;
4306 hcd = bus_to_hcd(udev->bus);
4307 /* Double check that we can both enable and disable LPM.
4308 * Device must be configured to accept set feature U1/U2 timeout.
4310 if (!hcd || !hcd->driver->enable_usb3_lpm_timeout ||
4311 !hcd->driver->disable_usb3_lpm_timeout)
4314 if (udev->lpm_disable_count > 0)
4317 hub = usb_hub_to_struct_hub(udev->parent);
4321 port_dev = hub->ports[udev->portnum - 1];
4323 if (port_dev->usb3_lpm_u1_permit)
4324 usb_enable_link_state(hcd, udev, USB3_LPM_U1);
4326 if (port_dev->usb3_lpm_u2_permit)
4327 usb_enable_link_state(hcd, udev, USB3_LPM_U2);
4329 EXPORT_SYMBOL_GPL(usb_enable_lpm);
4331 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
4332 void usb_unlocked_enable_lpm(struct usb_device *udev)
4334 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4339 mutex_lock(hcd->bandwidth_mutex);
4340 usb_enable_lpm(udev);
4341 mutex_unlock(hcd->bandwidth_mutex);
4343 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
4345 /* usb3 devices use U3 for disabled, make sure remote wakeup is disabled */
4346 static void hub_usb3_port_prepare_disable(struct usb_hub *hub,
4347 struct usb_port *port_dev)
4349 struct usb_device *udev = port_dev->child;
4352 if (udev && udev->port_is_suspended && udev->do_remote_wakeup) {
4353 ret = hub_set_port_link_state(hub, port_dev->portnum,
4356 msleep(USB_RESUME_TIMEOUT);
4357 ret = usb_disable_remote_wakeup(udev);
4360 dev_warn(&udev->dev,
4361 "Port disable: can't disable remote wake\n");
4362 udev->do_remote_wakeup = 0;
4366 #else /* CONFIG_PM */
4368 #define hub_suspend NULL
4369 #define hub_resume NULL
4370 #define hub_reset_resume NULL
4372 static inline void hub_usb3_port_prepare_disable(struct usb_hub *hub,
4373 struct usb_port *port_dev) { }
4375 int usb_disable_lpm(struct usb_device *udev)
4379 EXPORT_SYMBOL_GPL(usb_disable_lpm);
4381 void usb_enable_lpm(struct usb_device *udev) { }
4382 EXPORT_SYMBOL_GPL(usb_enable_lpm);
4384 int usb_unlocked_disable_lpm(struct usb_device *udev)
4388 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
4390 void usb_unlocked_enable_lpm(struct usb_device *udev) { }
4391 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
4393 int usb_disable_ltm(struct usb_device *udev)
4397 EXPORT_SYMBOL_GPL(usb_disable_ltm);
4399 void usb_enable_ltm(struct usb_device *udev) { }
4400 EXPORT_SYMBOL_GPL(usb_enable_ltm);
4402 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
4403 u16 portstatus, u16 portchange)
4408 #endif /* CONFIG_PM */
4411 * USB-3 does not have a similar link state as USB-2 that will avoid negotiating
4412 * a connection with a plugged-in cable but will signal the host when the cable
4413 * is unplugged. Disable remote wake and set link state to U3 for USB-3 devices
4415 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
4417 struct usb_port *port_dev = hub->ports[port1 - 1];
4418 struct usb_device *hdev = hub->hdev;
4422 if (hub_is_superspeed(hub->hdev)) {
4423 hub_usb3_port_prepare_disable(hub, port_dev);
4424 ret = hub_set_port_link_state(hub, port_dev->portnum,
4427 ret = usb_clear_port_feature(hdev, port1,
4428 USB_PORT_FEAT_ENABLE);
4431 if (port_dev->child && set_state)
4432 usb_set_device_state(port_dev->child, USB_STATE_NOTATTACHED);
4433 if (ret && ret != -ENODEV)
4434 dev_err(&port_dev->dev, "cannot disable (err = %d)\n", ret);
4439 * usb_port_disable - disable a usb device's upstream port
4440 * @udev: device to disable
4441 * Context: @udev locked, must be able to sleep.
4443 * Disables a USB device that isn't in active use.
4445 int usb_port_disable(struct usb_device *udev)
4447 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
4449 return hub_port_disable(hub, udev->portnum, 0);
4452 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
4454 * Between connect detection and reset signaling there must be a delay
4455 * of 100ms at least for debounce and power-settling. The corresponding
4456 * timer shall restart whenever the downstream port detects a disconnect.
4458 * Apparently there are some bluetooth and irda-dongles and a number of
4459 * low-speed devices for which this debounce period may last over a second.
4460 * Not covered by the spec - but easy to deal with.
4462 * This implementation uses a 1500ms total debounce timeout; if the
4463 * connection isn't stable by then it returns -ETIMEDOUT. It checks
4464 * every 25ms for transient disconnects. When the port status has been
4465 * unchanged for 100ms it returns the port status.
4467 int hub_port_debounce(struct usb_hub *hub, int port1, bool must_be_connected)
4470 u16 portchange, portstatus;
4471 unsigned connection = 0xffff;
4472 int total_time, stable_time = 0;
4473 struct usb_port *port_dev = hub->ports[port1 - 1];
4475 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
4476 ret = hub_port_status(hub, port1, &portstatus, &portchange);
4480 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
4481 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
4482 if (!must_be_connected ||
4483 (connection == USB_PORT_STAT_CONNECTION))
4484 stable_time += HUB_DEBOUNCE_STEP;
4485 if (stable_time >= HUB_DEBOUNCE_STABLE)
4489 connection = portstatus & USB_PORT_STAT_CONNECTION;
4492 if (portchange & USB_PORT_STAT_C_CONNECTION) {
4493 usb_clear_port_feature(hub->hdev, port1,
4494 USB_PORT_FEAT_C_CONNECTION);
4497 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
4499 msleep(HUB_DEBOUNCE_STEP);
4502 dev_dbg(&port_dev->dev, "debounce total %dms stable %dms status 0x%x\n",
4503 total_time, stable_time, portstatus);
4505 if (stable_time < HUB_DEBOUNCE_STABLE)
4510 void usb_ep0_reinit(struct usb_device *udev)
4512 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
4513 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
4514 usb_enable_endpoint(udev, &udev->ep0, true);
4516 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
4518 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
4519 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
4521 static int hub_set_address(struct usb_device *udev, int devnum)
4524 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4527 * The host controller will choose the device address,
4528 * instead of the core having chosen it earlier
4530 if (!hcd->driver->address_device && devnum <= 1)
4532 if (udev->state == USB_STATE_ADDRESS)
4534 if (udev->state != USB_STATE_DEFAULT)
4536 if (hcd->driver->address_device)
4537 retval = hcd->driver->address_device(hcd, udev);
4539 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
4540 USB_REQ_SET_ADDRESS, 0, devnum, 0,
4541 NULL, 0, USB_CTRL_SET_TIMEOUT);
4543 update_devnum(udev, devnum);
4544 /* Device now using proper address. */
4545 usb_set_device_state(udev, USB_STATE_ADDRESS);
4546 usb_ep0_reinit(udev);
4552 * There are reports of USB 3.0 devices that say they support USB 2.0 Link PM
4553 * when they're plugged into a USB 2.0 port, but they don't work when LPM is
4556 * Only enable USB 2.0 Link PM if the port is internal (hardwired), or the
4557 * device says it supports the new USB 2.0 Link PM errata by setting the BESL
4558 * support bit in the BOS descriptor.
4560 static void hub_set_initial_usb2_lpm_policy(struct usb_device *udev)
4562 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
4563 int connect_type = USB_PORT_CONNECT_TYPE_UNKNOWN;
4565 if (!udev->usb2_hw_lpm_capable || !udev->bos)
4569 connect_type = hub->ports[udev->portnum - 1]->connect_type;
4571 if ((udev->bos->ext_cap->bmAttributes & cpu_to_le32(USB_BESL_SUPPORT)) ||
4572 connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
4573 udev->usb2_hw_lpm_allowed = 1;
4574 usb_enable_usb2_hardware_lpm(udev);
4578 static int hub_enable_device(struct usb_device *udev)
4580 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4582 if (!hcd->driver->enable_device)
4584 if (udev->state == USB_STATE_ADDRESS)
4586 if (udev->state != USB_STATE_DEFAULT)
4589 return hcd->driver->enable_device(hcd, udev);
4592 /* Reset device, (re)assign address, get device descriptor.
4593 * Device connection must be stable, no more debouncing needed.
4594 * Returns device in USB_STATE_ADDRESS, except on error.
4596 * If this is called for an already-existing device (as part of
4597 * usb_reset_and_verify_device), the caller must own the device lock and
4598 * the port lock. For a newly detected device that is not accessible
4599 * through any global pointers, it's not necessary to lock the device,
4600 * but it is still necessary to lock the port.
4603 hub_port_init(struct usb_hub *hub, struct usb_device *udev, int port1,
4606 struct usb_device *hdev = hub->hdev;
4607 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4608 struct usb_port *port_dev = hub->ports[port1 - 1];
4609 int retries, operations, retval, i;
4610 unsigned delay = HUB_SHORT_RESET_TIME;
4611 enum usb_device_speed oldspeed = udev->speed;
4613 int devnum = udev->devnum;
4614 const char *driver_name;
4617 /* root hub ports have a slightly longer reset period
4618 * (from USB 2.0 spec, section 7.1.7.5)
4620 if (!hdev->parent) {
4621 delay = HUB_ROOT_RESET_TIME;
4622 if (port1 == hdev->bus->otg_port)
4623 hdev->bus->b_hnp_enable = 0;
4626 /* Some low speed devices have problems with the quick delay, so */
4627 /* be a bit pessimistic with those devices. RHbug #23670 */
4628 if (oldspeed == USB_SPEED_LOW)
4629 delay = HUB_LONG_RESET_TIME;
4631 mutex_lock(hcd->address0_mutex);
4633 /* Reset the device; full speed may morph to high speed */
4634 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
4635 retval = hub_port_reset(hub, port1, udev, delay, false);
4636 if (retval < 0) /* error or disconnect */
4638 /* success, speed is known */
4642 /* Don't allow speed changes at reset, except usb 3.0 to faster */
4643 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed &&
4644 !(oldspeed == USB_SPEED_SUPER && udev->speed > oldspeed)) {
4645 dev_dbg(&udev->dev, "device reset changed speed!\n");
4648 oldspeed = udev->speed;
4650 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4651 * it's fixed size except for full speed devices.
4652 * For Wireless USB devices, ep0 max packet is always 512 (tho
4653 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4655 switch (udev->speed) {
4656 case USB_SPEED_SUPER_PLUS:
4657 case USB_SPEED_SUPER:
4658 case USB_SPEED_WIRELESS: /* fixed at 512 */
4659 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
4661 case USB_SPEED_HIGH: /* fixed at 64 */
4662 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4664 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
4665 /* to determine the ep0 maxpacket size, try to read
4666 * the device descriptor to get bMaxPacketSize0 and
4667 * then correct our initial guess.
4669 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4671 case USB_SPEED_LOW: /* fixed at 8 */
4672 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
4678 if (udev->speed == USB_SPEED_WIRELESS)
4679 speed = "variable speed Wireless";
4681 speed = usb_speed_string(udev->speed);
4684 * The controller driver may be NULL if the controller device
4685 * is the middle device between platform device and roothub.
4686 * This middle device may not need a device driver due to
4687 * all hardware control can be at platform device driver, this
4688 * platform device is usually a dual-role USB controller device.
4690 if (udev->bus->controller->driver)
4691 driver_name = udev->bus->controller->driver->name;
4693 driver_name = udev->bus->sysdev->driver->name;
4695 if (udev->speed < USB_SPEED_SUPER)
4696 dev_info(&udev->dev,
4697 "%s %s USB device number %d using %s\n",
4698 (udev->config) ? "reset" : "new", speed,
4699 devnum, driver_name);
4701 /* Set up TT records, if needed */
4703 udev->tt = hdev->tt;
4704 udev->ttport = hdev->ttport;
4705 } else if (udev->speed != USB_SPEED_HIGH
4706 && hdev->speed == USB_SPEED_HIGH) {
4708 dev_err(&udev->dev, "parent hub has no TT\n");
4712 udev->tt = &hub->tt;
4713 udev->ttport = port1;
4716 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4717 * Because device hardware and firmware is sometimes buggy in
4718 * this area, and this is how Linux has done it for ages.
4719 * Change it cautiously.
4721 * NOTE: If use_new_scheme() is true we will start by issuing
4722 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4723 * so it may help with some non-standards-compliant devices.
4724 * Otherwise we start with SET_ADDRESS and then try to read the
4725 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4728 do_new_scheme = use_new_scheme(udev, retry_counter, port_dev);
4730 for (retries = 0; retries < GET_DESCRIPTOR_TRIES; (++retries, msleep(100))) {
4731 if (do_new_scheme) {
4732 struct usb_device_descriptor *buf;
4735 retval = hub_enable_device(udev);
4738 "hub failed to enable device, error %d\n",
4743 #define GET_DESCRIPTOR_BUFSIZE 64
4744 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
4750 /* Retry on all errors; some devices are flakey.
4751 * 255 is for WUSB devices, we actually need to use
4752 * 512 (WUSB1.0[4.8.1]).
4754 for (operations = 0; operations < GET_MAXPACKET0_TRIES;
4756 buf->bMaxPacketSize0 = 0;
4757 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
4758 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
4759 USB_DT_DEVICE << 8, 0,
4760 buf, GET_DESCRIPTOR_BUFSIZE,
4761 initial_descriptor_timeout);
4762 switch (buf->bMaxPacketSize0) {
4763 case 8: case 16: case 32: case 64: case 255:
4764 if (buf->bDescriptorType ==
4776 * Some devices time out if they are powered on
4777 * when already connected. They need a second
4778 * reset. But only on the first attempt,
4779 * lest we get into a time out/reset loop
4781 if (r == 0 || (r == -ETIMEDOUT &&
4783 udev->speed > USB_SPEED_FULL))
4786 udev->descriptor.bMaxPacketSize0 =
4787 buf->bMaxPacketSize0;
4790 retval = hub_port_reset(hub, port1, udev, delay, false);
4791 if (retval < 0) /* error or disconnect */
4793 if (oldspeed != udev->speed) {
4795 "device reset changed speed!\n");
4801 dev_err(&udev->dev, "device descriptor read/64, error %d\n",
4806 #undef GET_DESCRIPTOR_BUFSIZE
4810 * If device is WUSB, we already assigned an
4811 * unauthorized address in the Connect Ack sequence;
4812 * authorization will assign the final address.
4814 if (udev->wusb == 0) {
4815 for (operations = 0; operations < SET_ADDRESS_TRIES; ++operations) {
4816 retval = hub_set_address(udev, devnum);
4822 if (retval != -ENODEV)
4823 dev_err(&udev->dev, "device not accepting address %d, error %d\n",
4827 if (udev->speed >= USB_SPEED_SUPER) {
4828 devnum = udev->devnum;
4829 dev_info(&udev->dev,
4830 "%s SuperSpeed%s%s USB device number %d using %s\n",
4831 (udev->config) ? "reset" : "new",
4832 (udev->speed == USB_SPEED_SUPER_PLUS) ?
4834 (udev->ssp_rate == USB_SSP_GEN_2x2) ?
4836 (udev->ssp_rate == USB_SSP_GEN_2x1) ?
4838 (udev->ssp_rate == USB_SSP_GEN_1x2) ?
4840 devnum, driver_name);
4843 /* cope with hardware quirkiness:
4844 * - let SET_ADDRESS settle, some device hardware wants it
4845 * - read ep0 maxpacket even for high and low speed,
4852 retval = usb_get_device_descriptor(udev, 8);
4854 if (retval != -ENODEV)
4856 "device descriptor read/8, error %d\n",
4865 delay = udev->parent->hub_delay;
4866 udev->hub_delay = min_t(u32, delay,
4867 USB_TP_TRANSMISSION_DELAY_MAX);
4868 retval = usb_set_isoch_delay(udev);
4871 "Failed set isoch delay, error %d\n",
4882 * Some superspeed devices have finished the link training process
4883 * and attached to a superspeed hub port, but the device descriptor
4884 * got from those devices show they aren't superspeed devices. Warm
4885 * reset the port attached by the devices can fix them.
4887 if ((udev->speed >= USB_SPEED_SUPER) &&
4888 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
4889 dev_err(&udev->dev, "got a wrong device descriptor, "
4890 "warm reset device\n");
4891 hub_port_reset(hub, port1, udev,
4892 HUB_BH_RESET_TIME, true);
4897 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
4898 udev->speed >= USB_SPEED_SUPER)
4901 i = udev->descriptor.bMaxPacketSize0;
4902 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
4903 if (udev->speed == USB_SPEED_LOW ||
4904 !(i == 8 || i == 16 || i == 32 || i == 64)) {
4905 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
4909 if (udev->speed == USB_SPEED_FULL)
4910 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
4912 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
4913 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
4914 usb_ep0_reinit(udev);
4917 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
4918 if (retval < (signed)sizeof(udev->descriptor)) {
4919 if (retval != -ENODEV)
4920 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
4927 usb_detect_quirks(udev);
4929 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
4930 retval = usb_get_bos_descriptor(udev);
4932 udev->lpm_capable = usb_device_supports_lpm(udev);
4933 usb_set_lpm_parameters(udev);
4938 /* notify HCD that we have a device connected and addressed */
4939 if (hcd->driver->update_device)
4940 hcd->driver->update_device(hcd, udev);
4941 hub_set_initial_usb2_lpm_policy(udev);
4944 hub_port_disable(hub, port1, 0);
4945 update_devnum(udev, devnum); /* for disconnect processing */
4947 mutex_unlock(hcd->address0_mutex);
4952 check_highspeed(struct usb_hub *hub, struct usb_device *udev, int port1)
4954 struct usb_qualifier_descriptor *qual;
4957 if (udev->quirks & USB_QUIRK_DEVICE_QUALIFIER)
4960 qual = kmalloc(sizeof *qual, GFP_KERNEL);
4964 status = usb_get_descriptor(udev, USB_DT_DEVICE_QUALIFIER, 0,
4965 qual, sizeof *qual);
4966 if (status == sizeof *qual) {
4967 dev_info(&udev->dev, "not running at top speed; "
4968 "connect to a high speed hub\n");
4969 /* hub LEDs are probably harder to miss than syslog */
4970 if (hub->has_indicators) {
4971 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
4972 queue_delayed_work(system_power_efficient_wq,
4980 hub_power_remaining(struct usb_hub *hub)
4982 struct usb_device *hdev = hub->hdev;
4986 if (!hub->limited_power)
4989 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
4990 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
4991 struct usb_port *port_dev = hub->ports[port1 - 1];
4992 struct usb_device *udev = port_dev->child;
4998 if (hub_is_superspeed(udev))
5004 * Unconfigured devices may not use more than one unit load,
5005 * or 8mA for OTG ports
5007 if (udev->actconfig)
5008 delta = usb_get_max_power(udev, udev->actconfig);
5009 else if (port1 != udev->bus->otg_port || hdev->parent)
5013 if (delta > hub->mA_per_port)
5014 dev_warn(&port_dev->dev, "%dmA is over %umA budget!\n",
5015 delta, hub->mA_per_port);
5018 if (remaining < 0) {
5019 dev_warn(hub->intfdev, "%dmA over power budget!\n",
5027 static int descriptors_changed(struct usb_device *udev,
5028 struct usb_device_descriptor *old_device_descriptor,
5029 struct usb_host_bos *old_bos)
5033 unsigned serial_len = 0;
5035 unsigned old_length;
5039 if (memcmp(&udev->descriptor, old_device_descriptor,
5040 sizeof(*old_device_descriptor)) != 0)
5043 if ((old_bos && !udev->bos) || (!old_bos && udev->bos))
5046 len = le16_to_cpu(udev->bos->desc->wTotalLength);
5047 if (len != le16_to_cpu(old_bos->desc->wTotalLength))
5049 if (memcmp(udev->bos->desc, old_bos->desc, len))
5053 /* Since the idVendor, idProduct, and bcdDevice values in the
5054 * device descriptor haven't changed, we will assume the
5055 * Manufacturer and Product strings haven't changed either.
5056 * But the SerialNumber string could be different (e.g., a
5057 * different flash card of the same brand).
5060 serial_len = strlen(udev->serial) + 1;
5063 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5064 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5065 len = max(len, old_length);
5068 buf = kmalloc(len, GFP_NOIO);
5070 /* assume the worst */
5073 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5074 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5075 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
5077 if (length != old_length) {
5078 dev_dbg(&udev->dev, "config index %d, error %d\n",
5083 if (memcmp(buf, udev->rawdescriptors[index], old_length)
5085 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
5087 ((struct usb_config_descriptor *) buf)->
5088 bConfigurationValue);
5094 if (!changed && serial_len) {
5095 length = usb_string(udev, udev->descriptor.iSerialNumber,
5097 if (length + 1 != serial_len) {
5098 dev_dbg(&udev->dev, "serial string error %d\n",
5101 } else if (memcmp(buf, udev->serial, length) != 0) {
5102 dev_dbg(&udev->dev, "serial string changed\n");
5111 static void hub_port_connect(struct usb_hub *hub, int port1, u16 portstatus,
5114 int status = -ENODEV;
5117 struct usb_device *hdev = hub->hdev;
5118 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
5119 struct usb_port *port_dev = hub->ports[port1 - 1];
5120 struct usb_device *udev = port_dev->child;
5121 static int unreliable_port = -1;
5123 /* Disconnect any existing devices under this port */
5125 if (hcd->usb_phy && !hdev->parent)
5126 usb_phy_notify_disconnect(hcd->usb_phy, udev->speed);
5127 usb_disconnect(&port_dev->child);
5130 /* We can forget about a "removed" device when there's a physical
5131 * disconnect or the connect status changes.
5133 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
5134 (portchange & USB_PORT_STAT_C_CONNECTION))
5135 clear_bit(port1, hub->removed_bits);
5137 if (portchange & (USB_PORT_STAT_C_CONNECTION |
5138 USB_PORT_STAT_C_ENABLE)) {
5139 status = hub_port_debounce_be_stable(hub, port1);
5141 if (status != -ENODEV &&
5142 port1 != unreliable_port &&
5144 dev_err(&port_dev->dev, "connect-debounce failed\n");
5145 portstatus &= ~USB_PORT_STAT_CONNECTION;
5146 unreliable_port = port1;
5148 portstatus = status;
5152 /* Return now if debouncing failed or nothing is connected or
5153 * the device was "removed".
5155 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
5156 test_bit(port1, hub->removed_bits)) {
5159 * maybe switch power back on (e.g. root hub was reset)
5160 * but only if the port isn't owned by someone else.
5162 if (hub_is_port_power_switchable(hub)
5163 && !port_is_power_on(hub, portstatus)
5164 && !port_dev->port_owner)
5165 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
5167 if (portstatus & USB_PORT_STAT_ENABLE)
5171 if (hub_is_superspeed(hub->hdev))
5177 for (i = 0; i < PORT_INIT_TRIES; i++) {
5179 /* reallocate for each attempt, since references
5180 * to the previous one can escape in various ways
5182 udev = usb_alloc_dev(hdev, hdev->bus, port1);
5184 dev_err(&port_dev->dev,
5185 "couldn't allocate usb_device\n");
5189 usb_set_device_state(udev, USB_STATE_POWERED);
5190 udev->bus_mA = hub->mA_per_port;
5191 udev->level = hdev->level + 1;
5192 udev->wusb = hub_is_wusb(hub);
5194 /* Devices connected to SuperSpeed hubs are USB 3.0 or later */
5195 if (hub_is_superspeed(hub->hdev))
5196 udev->speed = USB_SPEED_SUPER;
5198 udev->speed = USB_SPEED_UNKNOWN;
5200 choose_devnum(udev);
5201 if (udev->devnum <= 0) {
5202 status = -ENOTCONN; /* Don't retry */
5206 /* reset (non-USB 3.0 devices) and get descriptor */
5207 usb_lock_port(port_dev);
5208 status = hub_port_init(hub, udev, port1, i);
5209 usb_unlock_port(port_dev);
5213 if (udev->quirks & USB_QUIRK_DELAY_INIT)
5216 /* consecutive bus-powered hubs aren't reliable; they can
5217 * violate the voltage drop budget. if the new child has
5218 * a "powered" LED, users should notice we didn't enable it
5219 * (without reading syslog), even without per-port LEDs
5222 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
5223 && udev->bus_mA <= unit_load) {
5226 status = usb_get_std_status(udev, USB_RECIP_DEVICE, 0,
5229 dev_dbg(&udev->dev, "get status %d ?\n", status);
5232 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
5234 "can't connect bus-powered hub "
5236 if (hub->has_indicators) {
5237 hub->indicator[port1-1] =
5238 INDICATOR_AMBER_BLINK;
5240 system_power_efficient_wq,
5243 status = -ENOTCONN; /* Don't retry */
5248 /* check for devices running slower than they could */
5249 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
5250 && udev->speed == USB_SPEED_FULL
5251 && highspeed_hubs != 0)
5252 check_highspeed(hub, udev, port1);
5254 /* Store the parent's children[] pointer. At this point
5255 * udev becomes globally accessible, although presumably
5256 * no one will look at it until hdev is unlocked.
5260 mutex_lock(&usb_port_peer_mutex);
5262 /* We mustn't add new devices if the parent hub has
5263 * been disconnected; we would race with the
5264 * recursively_mark_NOTATTACHED() routine.
5266 spin_lock_irq(&device_state_lock);
5267 if (hdev->state == USB_STATE_NOTATTACHED)
5270 port_dev->child = udev;
5271 spin_unlock_irq(&device_state_lock);
5272 mutex_unlock(&usb_port_peer_mutex);
5274 /* Run it through the hoops (find a driver, etc) */
5276 status = usb_new_device(udev);
5278 mutex_lock(&usb_port_peer_mutex);
5279 spin_lock_irq(&device_state_lock);
5280 port_dev->child = NULL;
5281 spin_unlock_irq(&device_state_lock);
5282 mutex_unlock(&usb_port_peer_mutex);
5284 if (hcd->usb_phy && !hdev->parent)
5285 usb_phy_notify_connect(hcd->usb_phy,
5293 status = hub_power_remaining(hub);
5295 dev_dbg(hub->intfdev, "%dmA power budget left\n", status);
5300 hub_port_disable(hub, port1, 1);
5302 usb_ep0_reinit(udev);
5303 release_devnum(udev);
5306 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
5309 /* When halfway through our retry count, power-cycle the port */
5310 if (i == (PORT_INIT_TRIES - 1) / 2) {
5311 dev_info(&port_dev->dev, "attempt power cycle\n");
5312 usb_hub_set_port_power(hdev, hub, port1, false);
5313 msleep(2 * hub_power_on_good_delay(hub));
5314 usb_hub_set_port_power(hdev, hub, port1, true);
5315 msleep(hub_power_on_good_delay(hub));
5318 if (hub->hdev->parent ||
5319 !hcd->driver->port_handed_over ||
5320 !(hcd->driver->port_handed_over)(hcd, port1)) {
5321 if (status != -ENOTCONN && status != -ENODEV)
5322 dev_err(&port_dev->dev,
5323 "unable to enumerate USB device\n");
5327 hub_port_disable(hub, port1, 1);
5328 if (hcd->driver->relinquish_port && !hub->hdev->parent) {
5329 if (status != -ENOTCONN && status != -ENODEV)
5330 hcd->driver->relinquish_port(hcd, port1);
5334 /* Handle physical or logical connection change events.
5335 * This routine is called when:
5336 * a port connection-change occurs;
5337 * a port enable-change occurs (often caused by EMI);
5338 * usb_reset_and_verify_device() encounters changed descriptors (as from
5339 * a firmware download)
5340 * caller already locked the hub
5342 static void hub_port_connect_change(struct usb_hub *hub, int port1,
5343 u16 portstatus, u16 portchange)
5344 __must_hold(&port_dev->status_lock)
5346 struct usb_port *port_dev = hub->ports[port1 - 1];
5347 struct usb_device *udev = port_dev->child;
5348 struct usb_device_descriptor descriptor;
5349 int status = -ENODEV;
5352 dev_dbg(&port_dev->dev, "status %04x, change %04x, %s\n", portstatus,
5353 portchange, portspeed(hub, portstatus));
5355 if (hub->has_indicators) {
5356 set_port_led(hub, port1, HUB_LED_AUTO);
5357 hub->indicator[port1-1] = INDICATOR_AUTO;
5360 #ifdef CONFIG_USB_OTG
5361 /* during HNP, don't repeat the debounce */
5362 if (hub->hdev->bus->is_b_host)
5363 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
5364 USB_PORT_STAT_C_ENABLE);
5367 /* Try to resuscitate an existing device */
5368 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
5369 udev->state != USB_STATE_NOTATTACHED) {
5370 if (portstatus & USB_PORT_STAT_ENABLE) {
5372 * USB-3 connections are initialized automatically by
5373 * the hostcontroller hardware. Therefore check for
5374 * changed device descriptors before resuscitating the
5377 descriptor = udev->descriptor;
5378 retval = usb_get_device_descriptor(udev,
5379 sizeof(udev->descriptor));
5382 "can't read device descriptor %d\n",
5385 if (descriptors_changed(udev, &descriptor,
5388 "device descriptor has changed\n");
5389 /* for disconnect() calls */
5390 udev->descriptor = descriptor;
5392 status = 0; /* Nothing to do */
5396 } else if (udev->state == USB_STATE_SUSPENDED &&
5397 udev->persist_enabled) {
5398 /* For a suspended device, treat this as a
5399 * remote wakeup event.
5401 usb_unlock_port(port_dev);
5402 status = usb_remote_wakeup(udev);
5403 usb_lock_port(port_dev);
5406 /* Don't resuscitate */;
5409 clear_bit(port1, hub->change_bits);
5411 /* successfully revalidated the connection */
5415 usb_unlock_port(port_dev);
5416 hub_port_connect(hub, port1, portstatus, portchange);
5417 usb_lock_port(port_dev);
5420 /* Handle notifying userspace about hub over-current events */
5421 static void port_over_current_notify(struct usb_port *port_dev)
5424 struct device *hub_dev;
5425 char *port_dev_path;
5427 sysfs_notify(&port_dev->dev.kobj, NULL, "over_current_count");
5429 hub_dev = port_dev->dev.parent;
5434 port_dev_path = kobject_get_path(&port_dev->dev.kobj, GFP_KERNEL);
5438 envp[0] = kasprintf(GFP_KERNEL, "OVER_CURRENT_PORT=%s", port_dev_path);
5442 envp[1] = kasprintf(GFP_KERNEL, "OVER_CURRENT_COUNT=%u",
5443 port_dev->over_current_count);
5448 kobject_uevent_env(&hub_dev->kobj, KOBJ_CHANGE, envp);
5454 kfree(port_dev_path);
5457 static void port_event(struct usb_hub *hub, int port1)
5458 __must_hold(&port_dev->status_lock)
5461 struct usb_port *port_dev = hub->ports[port1 - 1];
5462 struct usb_device *udev = port_dev->child;
5463 struct usb_device *hdev = hub->hdev;
5464 u16 portstatus, portchange;
5466 connect_change = test_bit(port1, hub->change_bits);
5467 clear_bit(port1, hub->event_bits);
5468 clear_bit(port1, hub->wakeup_bits);
5470 if (hub_port_status(hub, port1, &portstatus, &portchange) < 0)
5473 if (portchange & USB_PORT_STAT_C_CONNECTION) {
5474 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_CONNECTION);
5478 if (portchange & USB_PORT_STAT_C_ENABLE) {
5479 if (!connect_change)
5480 dev_dbg(&port_dev->dev, "enable change, status %08x\n",
5482 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_ENABLE);
5485 * EM interference sometimes causes badly shielded USB devices
5486 * to be shutdown by the hub, this hack enables them again.
5487 * Works at least with mouse driver.
5489 if (!(portstatus & USB_PORT_STAT_ENABLE)
5490 && !connect_change && udev) {
5491 dev_err(&port_dev->dev, "disabled by hub (EMI?), re-enabling...\n");
5496 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
5497 u16 status = 0, unused;
5498 port_dev->over_current_count++;
5499 port_over_current_notify(port_dev);
5501 dev_dbg(&port_dev->dev, "over-current change #%u\n",
5502 port_dev->over_current_count);
5503 usb_clear_port_feature(hdev, port1,
5504 USB_PORT_FEAT_C_OVER_CURRENT);
5505 msleep(100); /* Cool down */
5506 hub_power_on(hub, true);
5507 hub_port_status(hub, port1, &status, &unused);
5508 if (status & USB_PORT_STAT_OVERCURRENT)
5509 dev_err(&port_dev->dev, "over-current condition\n");
5512 if (portchange & USB_PORT_STAT_C_RESET) {
5513 dev_dbg(&port_dev->dev, "reset change\n");
5514 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_RESET);
5516 if ((portchange & USB_PORT_STAT_C_BH_RESET)
5517 && hub_is_superspeed(hdev)) {
5518 dev_dbg(&port_dev->dev, "warm reset change\n");
5519 usb_clear_port_feature(hdev, port1,
5520 USB_PORT_FEAT_C_BH_PORT_RESET);
5522 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
5523 dev_dbg(&port_dev->dev, "link state change\n");
5524 usb_clear_port_feature(hdev, port1,
5525 USB_PORT_FEAT_C_PORT_LINK_STATE);
5527 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
5528 dev_warn(&port_dev->dev, "config error\n");
5529 usb_clear_port_feature(hdev, port1,
5530 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
5533 /* skip port actions that require the port to be powered on */
5534 if (!pm_runtime_active(&port_dev->dev))
5537 if (hub_handle_remote_wakeup(hub, port1, portstatus, portchange))
5541 * Warm reset a USB3 protocol port if it's in
5542 * SS.Inactive state.
5544 if (hub_port_warm_reset_required(hub, port1, portstatus)) {
5545 dev_dbg(&port_dev->dev, "do warm reset\n");
5546 if (!udev || !(portstatus & USB_PORT_STAT_CONNECTION)
5547 || udev->state == USB_STATE_NOTATTACHED) {
5548 if (hub_port_reset(hub, port1, NULL,
5549 HUB_BH_RESET_TIME, true) < 0)
5550 hub_port_disable(hub, port1, 1);
5552 usb_unlock_port(port_dev);
5553 usb_lock_device(udev);
5554 usb_reset_device(udev);
5555 usb_unlock_device(udev);
5556 usb_lock_port(port_dev);
5562 hub_port_connect_change(hub, port1, portstatus, portchange);
5565 static void hub_event(struct work_struct *work)
5567 struct usb_device *hdev;
5568 struct usb_interface *intf;
5569 struct usb_hub *hub;
5570 struct device *hub_dev;
5575 hub = container_of(work, struct usb_hub, events);
5577 hub_dev = hub->intfdev;
5578 intf = to_usb_interface(hub_dev);
5580 kcov_remote_start_usb((u64)hdev->bus->busnum);
5582 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
5583 hdev->state, hdev->maxchild,
5584 /* NOTE: expects max 15 ports... */
5585 (u16) hub->change_bits[0],
5586 (u16) hub->event_bits[0]);
5588 /* Lock the device, then check to see if we were
5589 * disconnected while waiting for the lock to succeed. */
5590 usb_lock_device(hdev);
5591 if (unlikely(hub->disconnected))
5594 /* If the hub has died, clean up after it */
5595 if (hdev->state == USB_STATE_NOTATTACHED) {
5596 hub->error = -ENODEV;
5597 hub_quiesce(hub, HUB_DISCONNECT);
5602 ret = usb_autopm_get_interface(intf);
5604 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
5608 /* If this is an inactive hub, do nothing */
5613 dev_dbg(hub_dev, "resetting for error %d\n", hub->error);
5615 ret = usb_reset_device(hdev);
5617 dev_dbg(hub_dev, "error resetting hub: %d\n", ret);
5625 /* deal with port status changes */
5626 for (i = 1; i <= hdev->maxchild; i++) {
5627 struct usb_port *port_dev = hub->ports[i - 1];
5629 if (test_bit(i, hub->event_bits)
5630 || test_bit(i, hub->change_bits)
5631 || test_bit(i, hub->wakeup_bits)) {
5633 * The get_noresume and barrier ensure that if
5634 * the port was in the process of resuming, we
5635 * flush that work and keep the port active for
5636 * the duration of the port_event(). However,
5637 * if the port is runtime pm suspended
5638 * (powered-off), we leave it in that state, run
5639 * an abbreviated port_event(), and move on.
5641 pm_runtime_get_noresume(&port_dev->dev);
5642 pm_runtime_barrier(&port_dev->dev);
5643 usb_lock_port(port_dev);
5645 usb_unlock_port(port_dev);
5646 pm_runtime_put_sync(&port_dev->dev);
5650 /* deal with hub status changes */
5651 if (test_and_clear_bit(0, hub->event_bits) == 0)
5653 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
5654 dev_err(hub_dev, "get_hub_status failed\n");
5656 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
5657 dev_dbg(hub_dev, "power change\n");
5658 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
5659 if (hubstatus & HUB_STATUS_LOCAL_POWER)
5660 /* FIXME: Is this always true? */
5661 hub->limited_power = 1;
5663 hub->limited_power = 0;
5665 if (hubchange & HUB_CHANGE_OVERCURRENT) {
5669 dev_dbg(hub_dev, "over-current change\n");
5670 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
5671 msleep(500); /* Cool down */
5672 hub_power_on(hub, true);
5673 hub_hub_status(hub, &status, &unused);
5674 if (status & HUB_STATUS_OVERCURRENT)
5675 dev_err(hub_dev, "over-current condition\n");
5680 /* Balance the usb_autopm_get_interface() above */
5681 usb_autopm_put_interface_no_suspend(intf);
5683 usb_unlock_device(hdev);
5685 /* Balance the stuff in kick_hub_wq() and allow autosuspend */
5686 usb_autopm_put_interface(intf);
5687 kref_put(&hub->kref, hub_release);
5692 static const struct usb_device_id hub_id_table[] = {
5693 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5694 | USB_DEVICE_ID_MATCH_PRODUCT
5695 | USB_DEVICE_ID_MATCH_INT_CLASS,
5696 .idVendor = USB_VENDOR_SMSC,
5697 .idProduct = USB_PRODUCT_USB5534B,
5698 .bInterfaceClass = USB_CLASS_HUB,
5699 .driver_info = HUB_QUIRK_DISABLE_AUTOSUSPEND},
5700 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5701 | USB_DEVICE_ID_MATCH_INT_CLASS,
5702 .idVendor = USB_VENDOR_GENESYS_LOGIC,
5703 .bInterfaceClass = USB_CLASS_HUB,
5704 .driver_info = HUB_QUIRK_CHECK_PORT_AUTOSUSPEND},
5705 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
5706 .bDeviceClass = USB_CLASS_HUB},
5707 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
5708 .bInterfaceClass = USB_CLASS_HUB},
5709 { } /* Terminating entry */
5712 MODULE_DEVICE_TABLE(usb, hub_id_table);
5714 static struct usb_driver hub_driver = {
5717 .disconnect = hub_disconnect,
5718 .suspend = hub_suspend,
5719 .resume = hub_resume,
5720 .reset_resume = hub_reset_resume,
5721 .pre_reset = hub_pre_reset,
5722 .post_reset = hub_post_reset,
5723 .unlocked_ioctl = hub_ioctl,
5724 .id_table = hub_id_table,
5725 .supports_autosuspend = 1,
5728 int usb_hub_init(void)
5730 if (usb_register(&hub_driver) < 0) {
5731 printk(KERN_ERR "%s: can't register hub driver\n",
5737 * The workqueue needs to be freezable to avoid interfering with
5738 * USB-PERSIST port handover. Otherwise it might see that a full-speed
5739 * device was gone before the EHCI controller had handed its port
5740 * over to the companion full-speed controller.
5742 hub_wq = alloc_workqueue("usb_hub_wq", WQ_FREEZABLE, 0);
5746 /* Fall through if kernel_thread failed */
5747 usb_deregister(&hub_driver);
5748 pr_err("%s: can't allocate workqueue for usb hub\n", usbcore_name);
5753 void usb_hub_cleanup(void)
5755 destroy_workqueue(hub_wq);
5758 * Hub resources are freed for us by usb_deregister. It calls
5759 * usb_driver_purge on every device which in turn calls that
5760 * devices disconnect function if it is using this driver.
5761 * The hub_disconnect function takes care of releasing the
5762 * individual hub resources. -greg
5764 usb_deregister(&hub_driver);
5765 } /* usb_hub_cleanup() */
5768 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5769 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5771 * WARNING - don't use this routine to reset a composite device
5772 * (one with multiple interfaces owned by separate drivers)!
5773 * Use usb_reset_device() instead.
5775 * Do a port reset, reassign the device's address, and establish its
5776 * former operating configuration. If the reset fails, or the device's
5777 * descriptors change from their values before the reset, or the original
5778 * configuration and altsettings cannot be restored, a flag will be set
5779 * telling hub_wq to pretend the device has been disconnected and then
5780 * re-connected. All drivers will be unbound, and the device will be
5781 * re-enumerated and probed all over again.
5783 * Return: 0 if the reset succeeded, -ENODEV if the device has been
5784 * flagged for logical disconnection, or some other negative error code
5785 * if the reset wasn't even attempted.
5788 * The caller must own the device lock and the port lock, the latter is
5789 * taken by usb_reset_device(). For example, it's safe to use
5790 * usb_reset_device() from a driver probe() routine after downloading
5791 * new firmware. For calls that might not occur during probe(), drivers
5792 * should lock the device using usb_lock_device_for_reset().
5794 * Locking exception: This routine may also be called from within an
5795 * autoresume handler. Such usage won't conflict with other tasks
5796 * holding the device lock because these tasks should always call
5797 * usb_autopm_resume_device(), thereby preventing any unwanted
5798 * autoresume. The autoresume handler is expected to have already
5799 * acquired the port lock before calling this routine.
5801 static int usb_reset_and_verify_device(struct usb_device *udev)
5803 struct usb_device *parent_hdev = udev->parent;
5804 struct usb_hub *parent_hub;
5805 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
5806 struct usb_device_descriptor descriptor = udev->descriptor;
5807 struct usb_host_bos *bos;
5809 int port1 = udev->portnum;
5811 if (udev->state == USB_STATE_NOTATTACHED ||
5812 udev->state == USB_STATE_SUSPENDED) {
5813 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5821 parent_hub = usb_hub_to_struct_hub(parent_hdev);
5823 /* Disable USB2 hardware LPM.
5824 * It will be re-enabled by the enumeration process.
5826 usb_disable_usb2_hardware_lpm(udev);
5828 /* Disable LPM while we reset the device and reinstall the alt settings.
5829 * Device-initiated LPM, and system exit latency settings are cleared
5830 * when the device is reset, so we have to set them up again.
5832 ret = usb_unlocked_disable_lpm(udev);
5834 dev_err(&udev->dev, "%s Failed to disable LPM\n", __func__);
5835 goto re_enumerate_no_bos;
5841 for (i = 0; i < PORT_INIT_TRIES; ++i) {
5843 /* ep0 maxpacket size may change; let the HCD know about it.
5844 * Other endpoints will be handled by re-enumeration. */
5845 usb_ep0_reinit(udev);
5846 ret = hub_port_init(parent_hub, udev, port1, i);
5847 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
5854 /* Device might have changed firmware (DFU or similar) */
5855 if (descriptors_changed(udev, &descriptor, bos)) {
5856 dev_info(&udev->dev, "device firmware changed\n");
5857 udev->descriptor = descriptor; /* for disconnect() calls */
5861 /* Restore the device's previous configuration */
5862 if (!udev->actconfig)
5865 mutex_lock(hcd->bandwidth_mutex);
5866 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
5868 dev_warn(&udev->dev,
5869 "Busted HC? Not enough HCD resources for "
5870 "old configuration.\n");
5871 mutex_unlock(hcd->bandwidth_mutex);
5874 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
5875 USB_REQ_SET_CONFIGURATION, 0,
5876 udev->actconfig->desc.bConfigurationValue, 0,
5877 NULL, 0, USB_CTRL_SET_TIMEOUT);
5880 "can't restore configuration #%d (error=%d)\n",
5881 udev->actconfig->desc.bConfigurationValue, ret);
5882 mutex_unlock(hcd->bandwidth_mutex);
5885 mutex_unlock(hcd->bandwidth_mutex);
5886 usb_set_device_state(udev, USB_STATE_CONFIGURED);
5888 /* Put interfaces back into the same altsettings as before.
5889 * Don't bother to send the Set-Interface request for interfaces
5890 * that were already in altsetting 0; besides being unnecessary,
5891 * many devices can't handle it. Instead just reset the host-side
5894 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
5895 struct usb_host_config *config = udev->actconfig;
5896 struct usb_interface *intf = config->interface[i];
5897 struct usb_interface_descriptor *desc;
5899 desc = &intf->cur_altsetting->desc;
5900 if (desc->bAlternateSetting == 0) {
5901 usb_disable_interface(udev, intf, true);
5902 usb_enable_interface(udev, intf, true);
5905 /* Let the bandwidth allocation function know that this
5906 * device has been reset, and it will have to use
5907 * alternate setting 0 as the current alternate setting.
5909 intf->resetting_device = 1;
5910 ret = usb_set_interface(udev, desc->bInterfaceNumber,
5911 desc->bAlternateSetting);
5912 intf->resetting_device = 0;
5915 dev_err(&udev->dev, "failed to restore interface %d "
5916 "altsetting %d (error=%d)\n",
5917 desc->bInterfaceNumber,
5918 desc->bAlternateSetting,
5922 /* Resetting also frees any allocated streams */
5923 for (j = 0; j < intf->cur_altsetting->desc.bNumEndpoints; j++)
5924 intf->cur_altsetting->endpoint[j].streams = 0;
5928 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5929 usb_enable_usb2_hardware_lpm(udev);
5930 usb_unlocked_enable_lpm(udev);
5931 usb_enable_ltm(udev);
5932 usb_release_bos_descriptor(udev);
5937 usb_release_bos_descriptor(udev);
5939 re_enumerate_no_bos:
5940 /* LPM state doesn't matter when we're about to destroy the device. */
5941 hub_port_logical_disconnect(parent_hub, port1);
5946 * usb_reset_device - warn interface drivers and perform a USB port reset
5947 * @udev: device to reset (not in NOTATTACHED state)
5949 * Warns all drivers bound to registered interfaces (using their pre_reset
5950 * method), performs the port reset, and then lets the drivers know that
5951 * the reset is over (using their post_reset method).
5953 * Return: The same as for usb_reset_and_verify_device().
5956 * The caller must own the device lock. For example, it's safe to use
5957 * this from a driver probe() routine after downloading new firmware.
5958 * For calls that might not occur during probe(), drivers should lock
5959 * the device using usb_lock_device_for_reset().
5961 * If an interface is currently being probed or disconnected, we assume
5962 * its driver knows how to handle resets. For all other interfaces,
5963 * if the driver doesn't have pre_reset and post_reset methods then
5964 * we attempt to unbind it and rebind afterward.
5966 int usb_reset_device(struct usb_device *udev)
5970 unsigned int noio_flag;
5971 struct usb_port *port_dev;
5972 struct usb_host_config *config = udev->actconfig;
5973 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
5975 if (udev->state == USB_STATE_NOTATTACHED) {
5976 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5981 if (!udev->parent) {
5982 /* this requires hcd-specific logic; see ohci_restart() */
5983 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
5987 port_dev = hub->ports[udev->portnum - 1];
5990 * Don't allocate memory with GFP_KERNEL in current
5991 * context to avoid possible deadlock if usb mass
5992 * storage interface or usbnet interface(iSCSI case)
5993 * is included in current configuration. The easist
5994 * approach is to do it for every device reset,
5995 * because the device 'memalloc_noio' flag may have
5996 * not been set before reseting the usb device.
5998 noio_flag = memalloc_noio_save();
6000 /* Prevent autosuspend during the reset */
6001 usb_autoresume_device(udev);
6004 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
6005 struct usb_interface *cintf = config->interface[i];
6006 struct usb_driver *drv;
6009 if (cintf->dev.driver) {
6010 drv = to_usb_driver(cintf->dev.driver);
6011 if (drv->pre_reset && drv->post_reset)
6012 unbind = (drv->pre_reset)(cintf);
6013 else if (cintf->condition ==
6014 USB_INTERFACE_BOUND)
6017 usb_forced_unbind_intf(cintf);
6022 usb_lock_port(port_dev);
6023 ret = usb_reset_and_verify_device(udev);
6024 usb_unlock_port(port_dev);
6027 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
6028 struct usb_interface *cintf = config->interface[i];
6029 struct usb_driver *drv;
6030 int rebind = cintf->needs_binding;
6032 if (!rebind && cintf->dev.driver) {
6033 drv = to_usb_driver(cintf->dev.driver);
6034 if (drv->post_reset)
6035 rebind = (drv->post_reset)(cintf);
6036 else if (cintf->condition ==
6037 USB_INTERFACE_BOUND)
6040 cintf->needs_binding = 1;
6044 /* If the reset failed, hub_wq will unbind drivers later */
6046 usb_unbind_and_rebind_marked_interfaces(udev);
6049 usb_autosuspend_device(udev);
6050 memalloc_noio_restore(noio_flag);
6053 EXPORT_SYMBOL_GPL(usb_reset_device);
6057 * usb_queue_reset_device - Reset a USB device from an atomic context
6058 * @iface: USB interface belonging to the device to reset
6060 * This function can be used to reset a USB device from an atomic
6061 * context, where usb_reset_device() won't work (as it blocks).
6063 * Doing a reset via this method is functionally equivalent to calling
6064 * usb_reset_device(), except for the fact that it is delayed to a
6065 * workqueue. This means that any drivers bound to other interfaces
6066 * might be unbound, as well as users from usbfs in user space.
6070 * - Scheduling two resets at the same time from two different drivers
6071 * attached to two different interfaces of the same device is
6072 * possible; depending on how the driver attached to each interface
6073 * handles ->pre_reset(), the second reset might happen or not.
6075 * - If the reset is delayed so long that the interface is unbound from
6076 * its driver, the reset will be skipped.
6078 * - This function can be called during .probe(). It can also be called
6079 * during .disconnect(), but doing so is pointless because the reset
6080 * will not occur. If you really want to reset the device during
6081 * .disconnect(), call usb_reset_device() directly -- but watch out
6082 * for nested unbinding issues!
6084 void usb_queue_reset_device(struct usb_interface *iface)
6086 if (schedule_work(&iface->reset_ws))
6087 usb_get_intf(iface);
6089 EXPORT_SYMBOL_GPL(usb_queue_reset_device);
6092 * usb_hub_find_child - Get the pointer of child device
6093 * attached to the port which is specified by @port1.
6094 * @hdev: USB device belonging to the usb hub
6095 * @port1: port num to indicate which port the child device
6098 * USB drivers call this function to get hub's child device
6101 * Return: %NULL if input param is invalid and
6102 * child's usb_device pointer if non-NULL.
6104 struct usb_device *usb_hub_find_child(struct usb_device *hdev,
6107 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
6109 if (port1 < 1 || port1 > hdev->maxchild)
6111 return hub->ports[port1 - 1]->child;
6113 EXPORT_SYMBOL_GPL(usb_hub_find_child);
6115 void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
6116 struct usb_hub_descriptor *desc)
6118 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
6119 enum usb_port_connect_type connect_type;
6125 if (!hub_is_superspeed(hdev)) {
6126 for (i = 1; i <= hdev->maxchild; i++) {
6127 struct usb_port *port_dev = hub->ports[i - 1];
6129 connect_type = port_dev->connect_type;
6130 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
6131 u8 mask = 1 << (i%8);
6133 if (!(desc->u.hs.DeviceRemovable[i/8] & mask)) {
6134 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
6135 desc->u.hs.DeviceRemovable[i/8] |= mask;
6140 u16 port_removable = le16_to_cpu(desc->u.ss.DeviceRemovable);
6142 for (i = 1; i <= hdev->maxchild; i++) {
6143 struct usb_port *port_dev = hub->ports[i - 1];
6145 connect_type = port_dev->connect_type;
6146 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
6149 if (!(port_removable & mask)) {
6150 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
6151 port_removable |= mask;
6156 desc->u.ss.DeviceRemovable = cpu_to_le16(port_removable);
6162 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
6163 * @hdev: USB device belonging to the usb hub
6164 * @port1: port num of the port
6166 * Return: Port's acpi handle if successful, %NULL if params are
6169 acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
6172 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
6177 return ACPI_HANDLE(&hub->ports[port1 - 1]->dev);