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/onboard_hub.h>
27 #include <linux/usb/otg.h>
28 #include <linux/usb/quirks.h>
29 #include <linux/workqueue.h>
30 #include <linux/mutex.h>
31 #include <linux/random.h>
32 #include <linux/pm_qos.h>
33 #include <linux/kobject.h>
35 #include <linux/bitfield.h>
36 #include <linux/uaccess.h>
37 #include <asm/byteorder.h>
40 #include "otg_productlist.h"
42 #define USB_VENDOR_GENESYS_LOGIC 0x05e3
43 #define USB_VENDOR_SMSC 0x0424
44 #define USB_PRODUCT_USB5534B 0x5534
45 #define USB_VENDOR_CYPRESS 0x04b4
46 #define USB_PRODUCT_CY7C65632 0x6570
47 #define USB_VENDOR_TEXAS_INSTRUMENTS 0x0451
48 #define USB_PRODUCT_TUSB8041_USB3 0x8140
49 #define USB_PRODUCT_TUSB8041_USB2 0x8142
50 #define USB_VENDOR_MICROCHIP 0x0424
51 #define USB_PRODUCT_USB4913 0x4913
52 #define USB_PRODUCT_USB4914 0x4914
53 #define USB_PRODUCT_USB4915 0x4915
54 #define HUB_QUIRK_CHECK_PORT_AUTOSUSPEND BIT(0)
55 #define HUB_QUIRK_DISABLE_AUTOSUSPEND BIT(1)
56 #define HUB_QUIRK_REDUCE_FRAME_INTR_BINTERVAL BIT(2)
58 #define USB_TP_TRANSMISSION_DELAY 40 /* ns */
59 #define USB_TP_TRANSMISSION_DELAY_MAX 65535 /* ns */
60 #define USB_PING_RESPONSE_TIME 400 /* ns */
61 #define USB_REDUCE_FRAME_INTR_BINTERVAL 9
64 * The SET_ADDRESS request timeout will be 500 ms when
65 * USB_QUIRK_SHORT_SET_ADDRESS_REQ_TIMEOUT quirk flag is set.
67 #define USB_SHORT_SET_ADDRESS_REQ_TIMEOUT 500 /* ms */
69 /* Protect struct usb_device->state and ->children members
70 * Note: Both are also protected by ->dev.sem, except that ->state can
71 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
72 static DEFINE_SPINLOCK(device_state_lock);
74 /* workqueue to process hub events */
75 static struct workqueue_struct *hub_wq;
76 static void hub_event(struct work_struct *work);
78 /* synchronize hub-port add/remove and peering operations */
79 DEFINE_MUTEX(usb_port_peer_mutex);
81 /* cycle leds on hubs that aren't blinking for attention */
82 static bool blinkenlights;
83 module_param(blinkenlights, bool, S_IRUGO);
84 MODULE_PARM_DESC(blinkenlights, "true to cycle leds on hubs");
87 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
88 * 10 seconds to send reply for the initial 64-byte descriptor request.
90 /* define initial 64-byte descriptor request timeout in milliseconds */
91 static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
92 module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
93 MODULE_PARM_DESC(initial_descriptor_timeout,
94 "initial 64-byte descriptor request timeout in milliseconds "
95 "(default 5000 - 5.0 seconds)");
98 * As of 2.6.10 we introduce a new USB device initialization scheme which
99 * closely resembles the way Windows works. Hopefully it will be compatible
100 * with a wider range of devices than the old scheme. However some previously
101 * working devices may start giving rise to "device not accepting address"
102 * errors; if that happens the user can try the old scheme by adjusting the
103 * following module parameters.
105 * For maximum flexibility there are two boolean parameters to control the
106 * hub driver's behavior. On the first initialization attempt, if the
107 * "old_scheme_first" parameter is set then the old scheme will be used,
108 * otherwise the new scheme is used. If that fails and "use_both_schemes"
109 * is set, then the driver will make another attempt, using the other scheme.
111 static bool old_scheme_first;
112 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
113 MODULE_PARM_DESC(old_scheme_first,
114 "start with the old device initialization scheme");
116 static bool use_both_schemes = true;
117 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
118 MODULE_PARM_DESC(use_both_schemes,
119 "try the other device initialization scheme if the "
122 /* Mutual exclusion for EHCI CF initialization. This interferes with
123 * port reset on some companion controllers.
125 DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
126 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
128 #define HUB_DEBOUNCE_TIMEOUT 2000
129 #define HUB_DEBOUNCE_STEP 25
130 #define HUB_DEBOUNCE_STABLE 100
132 static int usb_reset_and_verify_device(struct usb_device *udev);
133 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state);
134 static bool hub_port_warm_reset_required(struct usb_hub *hub, int port1,
137 static inline char *portspeed(struct usb_hub *hub, int portstatus)
139 if (hub_is_superspeedplus(hub->hdev))
141 if (hub_is_superspeed(hub->hdev))
143 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
145 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
151 /* Note that hdev or one of its children must be locked! */
152 struct usb_hub *usb_hub_to_struct_hub(struct usb_device *hdev)
154 if (!hdev || !hdev->actconfig || !hdev->maxchild)
156 return usb_get_intfdata(hdev->actconfig->interface[0]);
159 int usb_device_supports_lpm(struct usb_device *udev)
161 /* Some devices have trouble with LPM */
162 if (udev->quirks & USB_QUIRK_NO_LPM)
165 /* Skip if the device BOS descriptor couldn't be read */
169 /* USB 2.1 (and greater) devices indicate LPM support through
170 * their USB 2.0 Extended Capabilities BOS descriptor.
172 if (udev->speed == USB_SPEED_HIGH || udev->speed == USB_SPEED_FULL) {
173 if (udev->bos->ext_cap &&
175 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
181 * According to the USB 3.0 spec, all USB 3.0 devices must support LPM.
182 * However, there are some that don't, and they set the U1/U2 exit
185 if (!udev->bos->ss_cap) {
186 dev_info(&udev->dev, "No LPM exit latency info found, disabling LPM.\n");
190 if (udev->bos->ss_cap->bU1devExitLat == 0 &&
191 udev->bos->ss_cap->bU2DevExitLat == 0) {
193 dev_info(&udev->dev, "LPM exit latency is zeroed, disabling LPM.\n");
195 dev_info(&udev->dev, "We don't know the algorithms for LPM for this host, disabling LPM.\n");
199 if (!udev->parent || udev->parent->lpm_capable)
205 * Set the Maximum Exit Latency (MEL) for the host to wakup up the path from
206 * U1/U2, send a PING to the device and receive a PING_RESPONSE.
207 * See USB 3.1 section C.1.5.2
209 static void usb_set_lpm_mel(struct usb_device *udev,
210 struct usb3_lpm_parameters *udev_lpm_params,
211 unsigned int udev_exit_latency,
213 struct usb3_lpm_parameters *hub_lpm_params,
214 unsigned int hub_exit_latency)
216 unsigned int total_mel;
219 * tMEL1. time to transition path from host to device into U0.
220 * MEL for parent already contains the delay up to parent, so only add
221 * the exit latency for the last link (pick the slower exit latency),
222 * and the hub header decode latency. See USB 3.1 section C 2.2.1
223 * Store MEL in nanoseconds
225 total_mel = hub_lpm_params->mel +
226 max(udev_exit_latency, hub_exit_latency) * 1000 +
227 hub->descriptor->u.ss.bHubHdrDecLat * 100;
230 * tMEL2. Time to submit PING packet. Sum of tTPTransmissionDelay for
231 * each link + wHubDelay for each hub. Add only for last link.
232 * tMEL4, the time for PING_RESPONSE to traverse upstream is similar.
233 * Multiply by 2 to include it as well.
235 total_mel += (__le16_to_cpu(hub->descriptor->u.ss.wHubDelay) +
236 USB_TP_TRANSMISSION_DELAY) * 2;
239 * tMEL3, tPingResponse. Time taken by device to generate PING_RESPONSE
240 * after receiving PING. Also add 2100ns as stated in USB 3.1 C 1.5.2.4
241 * to cover the delay if the PING_RESPONSE is queued behind a Max Packet
243 * Note these delays should be added only once for the entire path, so
244 * add them to the MEL of the device connected to the roothub.
246 if (!hub->hdev->parent)
247 total_mel += USB_PING_RESPONSE_TIME + 2100;
249 udev_lpm_params->mel = total_mel;
253 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
254 * a transition from either U1 or U2.
256 static void usb_set_lpm_pel(struct usb_device *udev,
257 struct usb3_lpm_parameters *udev_lpm_params,
258 unsigned int udev_exit_latency,
260 struct usb3_lpm_parameters *hub_lpm_params,
261 unsigned int hub_exit_latency,
262 unsigned int port_to_port_exit_latency)
264 unsigned int first_link_pel;
265 unsigned int hub_pel;
268 * First, the device sends an LFPS to transition the link between the
269 * device and the parent hub into U0. The exit latency is the bigger of
270 * the device exit latency or the hub exit latency.
272 if (udev_exit_latency > hub_exit_latency)
273 first_link_pel = udev_exit_latency * 1000;
275 first_link_pel = hub_exit_latency * 1000;
278 * When the hub starts to receive the LFPS, there is a slight delay for
279 * it to figure out that one of the ports is sending an LFPS. Then it
280 * will forward the LFPS to its upstream link. The exit latency is the
281 * delay, plus the PEL that we calculated for this hub.
283 hub_pel = port_to_port_exit_latency * 1000 + hub_lpm_params->pel;
286 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
287 * is the greater of the two exit latencies.
289 if (first_link_pel > hub_pel)
290 udev_lpm_params->pel = first_link_pel;
292 udev_lpm_params->pel = hub_pel;
296 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
297 * when a device initiates a transition to U0, until when it will receive the
298 * first packet from the host controller.
300 * Section C.1.5.1 describes the four components to this:
302 * - t2: time for the ERDY to make it from the device to the host.
303 * - t3: a host-specific delay to process the ERDY.
304 * - t4: time for the packet to make it from the host to the device.
306 * t3 is specific to both the xHCI host and the platform the host is integrated
307 * into. The Intel HW folks have said it's negligible, FIXME if a different
308 * vendor says otherwise.
310 static void usb_set_lpm_sel(struct usb_device *udev,
311 struct usb3_lpm_parameters *udev_lpm_params)
313 struct usb_device *parent;
314 unsigned int num_hubs;
315 unsigned int total_sel;
317 /* t1 = device PEL */
318 total_sel = udev_lpm_params->pel;
319 /* How many external hubs are in between the device & the root port. */
320 for (parent = udev->parent, num_hubs = 0; parent->parent;
321 parent = parent->parent)
323 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
325 total_sel += 2100 + 250 * (num_hubs - 1);
327 /* t4 = 250ns * num_hubs */
328 total_sel += 250 * num_hubs;
330 udev_lpm_params->sel = total_sel;
333 static void usb_set_lpm_parameters(struct usb_device *udev)
336 unsigned int port_to_port_delay;
337 unsigned int udev_u1_del;
338 unsigned int udev_u2_del;
339 unsigned int hub_u1_del;
340 unsigned int hub_u2_del;
342 if (!udev->lpm_capable || udev->speed < USB_SPEED_SUPER)
345 /* Skip if the device BOS descriptor couldn't be read */
349 hub = usb_hub_to_struct_hub(udev->parent);
350 /* It doesn't take time to transition the roothub into U0, since it
351 * doesn't have an upstream link.
356 udev_u1_del = udev->bos->ss_cap->bU1devExitLat;
357 udev_u2_del = le16_to_cpu(udev->bos->ss_cap->bU2DevExitLat);
358 hub_u1_del = udev->parent->bos->ss_cap->bU1devExitLat;
359 hub_u2_del = le16_to_cpu(udev->parent->bos->ss_cap->bU2DevExitLat);
361 usb_set_lpm_mel(udev, &udev->u1_params, udev_u1_del,
362 hub, &udev->parent->u1_params, hub_u1_del);
364 usb_set_lpm_mel(udev, &udev->u2_params, udev_u2_del,
365 hub, &udev->parent->u2_params, hub_u2_del);
368 * Appendix C, section C.2.2.2, says that there is a slight delay from
369 * when the parent hub notices the downstream port is trying to
370 * transition to U0 to when the hub initiates a U0 transition on its
371 * upstream port. The section says the delays are tPort2PortU1EL and
372 * tPort2PortU2EL, but it doesn't define what they are.
374 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
375 * about the same delays. Use the maximum delay calculations from those
376 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
377 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
378 * assume the device exit latencies they are talking about are the hub
381 * What do we do if the U2 exit latency is less than the U1 exit
382 * latency? It's possible, although not likely...
384 port_to_port_delay = 1;
386 usb_set_lpm_pel(udev, &udev->u1_params, udev_u1_del,
387 hub, &udev->parent->u1_params, hub_u1_del,
390 if (hub_u2_del > hub_u1_del)
391 port_to_port_delay = 1 + hub_u2_del - hub_u1_del;
393 port_to_port_delay = 1 + hub_u1_del;
395 usb_set_lpm_pel(udev, &udev->u2_params, udev_u2_del,
396 hub, &udev->parent->u2_params, hub_u2_del,
399 /* Now that we've got PEL, calculate SEL. */
400 usb_set_lpm_sel(udev, &udev->u1_params);
401 usb_set_lpm_sel(udev, &udev->u2_params);
404 /* USB 2.0 spec Section 11.24.4.5 */
405 static int get_hub_descriptor(struct usb_device *hdev,
406 struct usb_hub_descriptor *desc)
411 if (hub_is_superspeed(hdev)) {
412 dtype = USB_DT_SS_HUB;
413 size = USB_DT_SS_HUB_SIZE;
416 size = sizeof(struct usb_hub_descriptor);
419 for (i = 0; i < 3; i++) {
420 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
421 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
422 dtype << 8, 0, desc, size,
423 USB_CTRL_GET_TIMEOUT);
424 if (hub_is_superspeed(hdev)) {
427 } else if (ret >= USB_DT_HUB_NONVAR_SIZE + 2) {
428 /* Make sure we have the DeviceRemovable field. */
429 size = USB_DT_HUB_NONVAR_SIZE + desc->bNbrPorts / 8 + 1;
439 * USB 2.0 spec Section 11.24.2.1
441 static int clear_hub_feature(struct usb_device *hdev, int feature)
443 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
444 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
448 * USB 2.0 spec Section 11.24.2.2
450 int usb_clear_port_feature(struct usb_device *hdev, int port1, int feature)
452 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
453 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
458 * USB 2.0 spec Section 11.24.2.13
460 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
462 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
463 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
467 static char *to_led_name(int selector)
484 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
485 * for info about using port indicators
487 static void set_port_led(struct usb_hub *hub, int port1, int selector)
489 struct usb_port *port_dev = hub->ports[port1 - 1];
492 status = set_port_feature(hub->hdev, (selector << 8) | port1,
493 USB_PORT_FEAT_INDICATOR);
494 dev_dbg(&port_dev->dev, "indicator %s status %d\n",
495 to_led_name(selector), status);
498 #define LED_CYCLE_PERIOD ((2*HZ)/3)
500 static void led_work(struct work_struct *work)
502 struct usb_hub *hub =
503 container_of(work, struct usb_hub, leds.work);
504 struct usb_device *hdev = hub->hdev;
506 unsigned changed = 0;
509 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
512 for (i = 0; i < hdev->maxchild; i++) {
513 unsigned selector, mode;
515 /* 30%-50% duty cycle */
517 switch (hub->indicator[i]) {
519 case INDICATOR_CYCLE:
521 selector = HUB_LED_AUTO;
522 mode = INDICATOR_AUTO;
524 /* blinking green = sw attention */
525 case INDICATOR_GREEN_BLINK:
526 selector = HUB_LED_GREEN;
527 mode = INDICATOR_GREEN_BLINK_OFF;
529 case INDICATOR_GREEN_BLINK_OFF:
530 selector = HUB_LED_OFF;
531 mode = INDICATOR_GREEN_BLINK;
533 /* blinking amber = hw attention */
534 case INDICATOR_AMBER_BLINK:
535 selector = HUB_LED_AMBER;
536 mode = INDICATOR_AMBER_BLINK_OFF;
538 case INDICATOR_AMBER_BLINK_OFF:
539 selector = HUB_LED_OFF;
540 mode = INDICATOR_AMBER_BLINK;
542 /* blink green/amber = reserved */
543 case INDICATOR_ALT_BLINK:
544 selector = HUB_LED_GREEN;
545 mode = INDICATOR_ALT_BLINK_OFF;
547 case INDICATOR_ALT_BLINK_OFF:
548 selector = HUB_LED_AMBER;
549 mode = INDICATOR_ALT_BLINK;
554 if (selector != HUB_LED_AUTO)
556 set_port_led(hub, i + 1, selector);
557 hub->indicator[i] = mode;
559 if (!changed && blinkenlights) {
561 cursor %= hdev->maxchild;
562 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
563 hub->indicator[cursor] = INDICATOR_CYCLE;
567 queue_delayed_work(system_power_efficient_wq,
568 &hub->leds, LED_CYCLE_PERIOD);
571 /* use a short timeout for hub/port status fetches */
572 #define USB_STS_TIMEOUT 1000
573 #define USB_STS_RETRIES 5
576 * USB 2.0 spec Section 11.24.2.6
578 static int get_hub_status(struct usb_device *hdev,
579 struct usb_hub_status *data)
581 int i, status = -ETIMEDOUT;
583 for (i = 0; i < USB_STS_RETRIES &&
584 (status == -ETIMEDOUT || status == -EPIPE); i++) {
585 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
586 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
587 data, sizeof(*data), USB_STS_TIMEOUT);
593 * USB 2.0 spec Section 11.24.2.7
594 * USB 3.1 takes into use the wValue and wLength fields, spec Section 10.16.2.6
596 static int get_port_status(struct usb_device *hdev, int port1,
597 void *data, u16 value, u16 length)
599 int i, status = -ETIMEDOUT;
601 for (i = 0; i < USB_STS_RETRIES &&
602 (status == -ETIMEDOUT || status == -EPIPE); i++) {
603 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
604 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, value,
605 port1, data, length, USB_STS_TIMEOUT);
610 static int hub_ext_port_status(struct usb_hub *hub, int port1, int type,
611 u16 *status, u16 *change, u32 *ext_status)
616 if (type != HUB_PORT_STATUS)
619 mutex_lock(&hub->status_mutex);
620 ret = get_port_status(hub->hdev, port1, &hub->status->port, type, len);
623 dev_err(hub->intfdev,
624 "%s failed (err = %d)\n", __func__, ret);
628 *status = le16_to_cpu(hub->status->port.wPortStatus);
629 *change = le16_to_cpu(hub->status->port.wPortChange);
630 if (type != HUB_PORT_STATUS && ext_status)
631 *ext_status = le32_to_cpu(
632 hub->status->port.dwExtPortStatus);
635 mutex_unlock(&hub->status_mutex);
639 int usb_hub_port_status(struct usb_hub *hub, int port1,
640 u16 *status, u16 *change)
642 return hub_ext_port_status(hub, port1, HUB_PORT_STATUS,
643 status, change, NULL);
646 static void hub_resubmit_irq_urb(struct usb_hub *hub)
651 spin_lock_irqsave(&hub->irq_urb_lock, flags);
653 if (hub->quiescing) {
654 spin_unlock_irqrestore(&hub->irq_urb_lock, flags);
658 status = usb_submit_urb(hub->urb, GFP_ATOMIC);
659 if (status && status != -ENODEV && status != -EPERM &&
660 status != -ESHUTDOWN) {
661 dev_err(hub->intfdev, "resubmit --> %d\n", status);
662 mod_timer(&hub->irq_urb_retry, jiffies + HZ);
665 spin_unlock_irqrestore(&hub->irq_urb_lock, flags);
668 static void hub_retry_irq_urb(struct timer_list *t)
670 struct usb_hub *hub = from_timer(hub, t, irq_urb_retry);
672 hub_resubmit_irq_urb(hub);
676 static void kick_hub_wq(struct usb_hub *hub)
678 struct usb_interface *intf;
680 if (hub->disconnected || work_pending(&hub->events))
684 * Suppress autosuspend until the event is proceed.
686 * Be careful and make sure that the symmetric operation is
687 * always called. We are here only when there is no pending
688 * work for this hub. Therefore put the interface either when
689 * the new work is called or when it is canceled.
691 intf = to_usb_interface(hub->intfdev);
692 usb_autopm_get_interface_no_resume(intf);
695 if (queue_work(hub_wq, &hub->events))
698 /* the work has already been scheduled */
699 usb_autopm_put_interface_async(intf);
703 void usb_kick_hub_wq(struct usb_device *hdev)
705 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
712 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
713 * Notification, which indicates it had initiated remote wakeup.
715 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
716 * device initiates resume, so the USB core will not receive notice of the
717 * resume through the normal hub interrupt URB.
719 void usb_wakeup_notification(struct usb_device *hdev,
720 unsigned int portnum)
723 struct usb_port *port_dev;
728 hub = usb_hub_to_struct_hub(hdev);
730 port_dev = hub->ports[portnum - 1];
731 if (port_dev && port_dev->child)
732 pm_wakeup_event(&port_dev->child->dev, 0);
734 set_bit(portnum, hub->wakeup_bits);
738 EXPORT_SYMBOL_GPL(usb_wakeup_notification);
740 /* completion function, fires on port status changes and various faults */
741 static void hub_irq(struct urb *urb)
743 struct usb_hub *hub = urb->context;
744 int status = urb->status;
749 case -ENOENT: /* synchronous unlink */
750 case -ECONNRESET: /* async unlink */
751 case -ESHUTDOWN: /* hardware going away */
754 default: /* presumably an error */
755 /* Cause a hub reset after 10 consecutive errors */
756 dev_dbg(hub->intfdev, "transfer --> %d\n", status);
757 if ((++hub->nerrors < 10) || hub->error)
762 /* let hub_wq handle things */
763 case 0: /* we got data: port status changed */
765 for (i = 0; i < urb->actual_length; ++i)
766 bits |= ((unsigned long) ((*hub->buffer)[i]))
768 hub->event_bits[0] = bits;
774 /* Something happened, let hub_wq figure it out */
778 hub_resubmit_irq_urb(hub);
781 /* USB 2.0 spec Section 11.24.2.3 */
783 hub_clear_tt_buffer(struct usb_device *hdev, u16 devinfo, u16 tt)
785 /* Need to clear both directions for control ep */
786 if (((devinfo >> 11) & USB_ENDPOINT_XFERTYPE_MASK) ==
787 USB_ENDPOINT_XFER_CONTROL) {
788 int status = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
789 HUB_CLEAR_TT_BUFFER, USB_RT_PORT,
790 devinfo ^ 0x8000, tt, NULL, 0, 1000);
794 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
795 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
800 * enumeration blocks hub_wq for a long time. we use keventd instead, since
801 * long blocking there is the exception, not the rule. accordingly, HCDs
802 * talking to TTs must queue control transfers (not just bulk and iso), so
803 * both can talk to the same hub concurrently.
805 static void hub_tt_work(struct work_struct *work)
807 struct usb_hub *hub =
808 container_of(work, struct usb_hub, tt.clear_work);
811 spin_lock_irqsave(&hub->tt.lock, flags);
812 while (!list_empty(&hub->tt.clear_list)) {
813 struct list_head *next;
814 struct usb_tt_clear *clear;
815 struct usb_device *hdev = hub->hdev;
816 const struct hc_driver *drv;
819 next = hub->tt.clear_list.next;
820 clear = list_entry(next, struct usb_tt_clear, clear_list);
821 list_del(&clear->clear_list);
823 /* drop lock so HCD can concurrently report other TT errors */
824 spin_unlock_irqrestore(&hub->tt.lock, flags);
825 status = hub_clear_tt_buffer(hdev, clear->devinfo, clear->tt);
826 if (status && status != -ENODEV)
828 "clear tt %d (%04x) error %d\n",
829 clear->tt, clear->devinfo, status);
831 /* Tell the HCD, even if the operation failed */
832 drv = clear->hcd->driver;
833 if (drv->clear_tt_buffer_complete)
834 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
837 spin_lock_irqsave(&hub->tt.lock, flags);
839 spin_unlock_irqrestore(&hub->tt.lock, flags);
843 * usb_hub_set_port_power - control hub port's power state
844 * @hdev: USB device belonging to the usb hub
847 * @set: expected status
849 * call this function to control port's power via setting or
850 * clearing the port's PORT_POWER feature.
852 * Return: 0 if successful. A negative error code otherwise.
854 int usb_hub_set_port_power(struct usb_device *hdev, struct usb_hub *hub,
860 ret = set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
862 ret = usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
868 set_bit(port1, hub->power_bits);
870 clear_bit(port1, hub->power_bits);
875 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
876 * @urb: an URB associated with the failed or incomplete split transaction
878 * High speed HCDs use this to tell the hub driver that some split control or
879 * bulk transaction failed in a way that requires clearing internal state of
880 * a transaction translator. This is normally detected (and reported) from
883 * It may not be possible for that hub to handle additional full (or low)
884 * speed transactions until that state is fully cleared out.
886 * Return: 0 if successful. A negative error code otherwise.
888 int usb_hub_clear_tt_buffer(struct urb *urb)
890 struct usb_device *udev = urb->dev;
891 int pipe = urb->pipe;
892 struct usb_tt *tt = udev->tt;
894 struct usb_tt_clear *clear;
896 /* we've got to cope with an arbitrary number of pending TT clears,
897 * since each TT has "at least two" buffers that can need it (and
898 * there can be many TTs per hub). even if they're uncommon.
900 clear = kmalloc(sizeof *clear, GFP_ATOMIC);
902 dev_err(&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
903 /* FIXME recover somehow ... RESET_TT? */
907 /* info that CLEAR_TT_BUFFER needs */
908 clear->tt = tt->multi ? udev->ttport : 1;
909 clear->devinfo = usb_pipeendpoint (pipe);
910 clear->devinfo |= ((u16)udev->devaddr) << 4;
911 clear->devinfo |= usb_pipecontrol(pipe)
912 ? (USB_ENDPOINT_XFER_CONTROL << 11)
913 : (USB_ENDPOINT_XFER_BULK << 11);
914 if (usb_pipein(pipe))
915 clear->devinfo |= 1 << 15;
917 /* info for completion callback */
918 clear->hcd = bus_to_hcd(udev->bus);
921 /* tell keventd to clear state for this TT */
922 spin_lock_irqsave(&tt->lock, flags);
923 list_add_tail(&clear->clear_list, &tt->clear_list);
924 schedule_work(&tt->clear_work);
925 spin_unlock_irqrestore(&tt->lock, flags);
928 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
930 static void hub_power_on(struct usb_hub *hub, bool do_delay)
934 /* Enable power on each port. Some hubs have reserved values
935 * of LPSM (> 2) in their descriptors, even though they are
936 * USB 2.0 hubs. Some hubs do not implement port-power switching
937 * but only emulate it. In all cases, the ports won't work
938 * unless we send these messages to the hub.
940 if (hub_is_port_power_switchable(hub))
941 dev_dbg(hub->intfdev, "enabling power on all ports\n");
943 dev_dbg(hub->intfdev, "trying to enable port power on "
944 "non-switchable hub\n");
945 for (port1 = 1; port1 <= hub->hdev->maxchild; port1++)
946 if (test_bit(port1, hub->power_bits))
947 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
949 usb_clear_port_feature(hub->hdev, port1,
950 USB_PORT_FEAT_POWER);
952 msleep(hub_power_on_good_delay(hub));
955 static int hub_hub_status(struct usb_hub *hub,
956 u16 *status, u16 *change)
960 mutex_lock(&hub->status_mutex);
961 ret = get_hub_status(hub->hdev, &hub->status->hub);
964 dev_err(hub->intfdev,
965 "%s failed (err = %d)\n", __func__, ret);
967 *status = le16_to_cpu(hub->status->hub.wHubStatus);
968 *change = le16_to_cpu(hub->status->hub.wHubChange);
971 mutex_unlock(&hub->status_mutex);
975 static int hub_set_port_link_state(struct usb_hub *hub, int port1,
976 unsigned int link_status)
978 return set_port_feature(hub->hdev,
979 port1 | (link_status << 3),
980 USB_PORT_FEAT_LINK_STATE);
984 * Disable a port and mark a logical connect-change event, so that some
985 * time later hub_wq will disconnect() any existing usb_device on the port
986 * and will re-enumerate if there actually is a device attached.
988 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
990 dev_dbg(&hub->ports[port1 - 1]->dev, "logical disconnect\n");
991 hub_port_disable(hub, port1, 1);
993 /* FIXME let caller ask to power down the port:
994 * - some devices won't enumerate without a VBUS power cycle
995 * - SRP saves power that way
996 * - ... new call, TBD ...
997 * That's easy if this hub can switch power per-port, and
998 * hub_wq reactivates the port later (timer, SRP, etc).
999 * Powerdown must be optional, because of reset/DFU.
1002 set_bit(port1, hub->change_bits);
1007 * usb_remove_device - disable a device's port on its parent hub
1008 * @udev: device to be disabled and removed
1009 * Context: @udev locked, must be able to sleep.
1011 * After @udev's port has been disabled, hub_wq is notified and it will
1012 * see that the device has been disconnected. When the device is
1013 * physically unplugged and something is plugged in, the events will
1014 * be received and processed normally.
1016 * Return: 0 if successful. A negative error code otherwise.
1018 int usb_remove_device(struct usb_device *udev)
1020 struct usb_hub *hub;
1021 struct usb_interface *intf;
1024 if (!udev->parent) /* Can't remove a root hub */
1026 hub = usb_hub_to_struct_hub(udev->parent);
1027 intf = to_usb_interface(hub->intfdev);
1029 ret = usb_autopm_get_interface(intf);
1033 set_bit(udev->portnum, hub->removed_bits);
1034 hub_port_logical_disconnect(hub, udev->portnum);
1035 usb_autopm_put_interface(intf);
1039 enum hub_activation_type {
1040 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
1041 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
1044 static void hub_init_func2(struct work_struct *ws);
1045 static void hub_init_func3(struct work_struct *ws);
1047 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
1049 struct usb_device *hdev = hub->hdev;
1050 struct usb_hcd *hcd;
1054 bool need_debounce_delay = false;
1057 /* Continue a partial initialization */
1058 if (type == HUB_INIT2 || type == HUB_INIT3) {
1059 device_lock(&hdev->dev);
1061 /* Was the hub disconnected while we were waiting? */
1062 if (hub->disconnected)
1064 if (type == HUB_INIT2)
1070 /* The superspeed hub except for root hub has to use Hub Depth
1071 * value as an offset into the route string to locate the bits
1072 * it uses to determine the downstream port number. So hub driver
1073 * should send a set hub depth request to superspeed hub after
1074 * the superspeed hub is set configuration in initialization or
1077 * After a resume, port power should still be on.
1078 * For any other type of activation, turn it on.
1080 if (type != HUB_RESUME) {
1081 if (hdev->parent && hub_is_superspeed(hdev)) {
1082 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
1083 HUB_SET_DEPTH, USB_RT_HUB,
1084 hdev->level - 1, 0, NULL, 0,
1085 USB_CTRL_SET_TIMEOUT);
1087 dev_err(hub->intfdev,
1088 "set hub depth failed\n");
1091 /* Speed up system boot by using a delayed_work for the
1092 * hub's initial power-up delays. This is pretty awkward
1093 * and the implementation looks like a home-brewed sort of
1094 * setjmp/longjmp, but it saves at least 100 ms for each
1095 * root hub (assuming usbcore is compiled into the kernel
1096 * rather than as a module). It adds up.
1098 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1099 * because for those activation types the ports have to be
1100 * operational when we return. In theory this could be done
1101 * for HUB_POST_RESET, but it's easier not to.
1103 if (type == HUB_INIT) {
1104 delay = hub_power_on_good_delay(hub);
1106 hub_power_on(hub, false);
1107 INIT_DELAYED_WORK(&hub->init_work, hub_init_func2);
1108 queue_delayed_work(system_power_efficient_wq,
1110 msecs_to_jiffies(delay));
1112 /* Suppress autosuspend until init is done */
1113 usb_autopm_get_interface_no_resume(
1114 to_usb_interface(hub->intfdev));
1115 return; /* Continues at init2: below */
1116 } else if (type == HUB_RESET_RESUME) {
1117 /* The internal host controller state for the hub device
1118 * may be gone after a host power loss on system resume.
1119 * Update the device's info so the HW knows it's a hub.
1121 hcd = bus_to_hcd(hdev->bus);
1122 if (hcd->driver->update_hub_device) {
1123 ret = hcd->driver->update_hub_device(hcd, hdev,
1124 &hub->tt, GFP_NOIO);
1126 dev_err(hub->intfdev,
1127 "Host not accepting hub info update\n");
1128 dev_err(hub->intfdev,
1129 "LS/FS devices and hubs may not work under this hub\n");
1132 hub_power_on(hub, true);
1134 hub_power_on(hub, true);
1136 /* Give some time on remote wakeup to let links to transit to U0 */
1137 } else if (hub_is_superspeed(hub->hdev))
1143 * Check each port and set hub->change_bits to let hub_wq know
1144 * which ports need attention.
1146 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
1147 struct usb_port *port_dev = hub->ports[port1 - 1];
1148 struct usb_device *udev = port_dev->child;
1149 u16 portstatus, portchange;
1151 portstatus = portchange = 0;
1152 status = usb_hub_port_status(hub, port1, &portstatus, &portchange);
1156 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1157 dev_dbg(&port_dev->dev, "status %04x change %04x\n",
1158 portstatus, portchange);
1161 * After anything other than HUB_RESUME (i.e., initialization
1162 * or any sort of reset), every port should be disabled.
1163 * Unconnected ports should likewise be disabled (paranoia),
1164 * and so should ports for which we have no usb_device.
1166 if ((portstatus & USB_PORT_STAT_ENABLE) && (
1167 type != HUB_RESUME ||
1168 !(portstatus & USB_PORT_STAT_CONNECTION) ||
1170 udev->state == USB_STATE_NOTATTACHED)) {
1172 * USB3 protocol ports will automatically transition
1173 * to Enabled state when detect an USB3.0 device attach.
1174 * Do not disable USB3 protocol ports, just pretend
1177 portstatus &= ~USB_PORT_STAT_ENABLE;
1178 if (!hub_is_superspeed(hdev))
1179 usb_clear_port_feature(hdev, port1,
1180 USB_PORT_FEAT_ENABLE);
1183 /* Make sure a warm-reset request is handled by port_event */
1184 if (type == HUB_RESUME &&
1185 hub_port_warm_reset_required(hub, port1, portstatus))
1186 set_bit(port1, hub->event_bits);
1189 * Add debounce if USB3 link is in polling/link training state.
1190 * Link will automatically transition to Enabled state after
1191 * link training completes.
1193 if (hub_is_superspeed(hdev) &&
1194 ((portstatus & USB_PORT_STAT_LINK_STATE) ==
1195 USB_SS_PORT_LS_POLLING))
1196 need_debounce_delay = true;
1198 /* Clear status-change flags; we'll debounce later */
1199 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1200 need_debounce_delay = true;
1201 usb_clear_port_feature(hub->hdev, port1,
1202 USB_PORT_FEAT_C_CONNECTION);
1204 if (portchange & USB_PORT_STAT_C_ENABLE) {
1205 need_debounce_delay = true;
1206 usb_clear_port_feature(hub->hdev, port1,
1207 USB_PORT_FEAT_C_ENABLE);
1209 if (portchange & USB_PORT_STAT_C_RESET) {
1210 need_debounce_delay = true;
1211 usb_clear_port_feature(hub->hdev, port1,
1212 USB_PORT_FEAT_C_RESET);
1214 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
1215 hub_is_superspeed(hub->hdev)) {
1216 need_debounce_delay = true;
1217 usb_clear_port_feature(hub->hdev, port1,
1218 USB_PORT_FEAT_C_BH_PORT_RESET);
1220 /* We can forget about a "removed" device when there's a
1221 * physical disconnect or the connect status changes.
1223 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
1224 (portchange & USB_PORT_STAT_C_CONNECTION))
1225 clear_bit(port1, hub->removed_bits);
1227 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
1228 /* Tell hub_wq to disconnect the device or
1229 * check for a new connection or over current condition.
1230 * Based on USB2.0 Spec Section 11.12.5,
1231 * C_PORT_OVER_CURRENT could be set while
1232 * PORT_OVER_CURRENT is not. So check for any of them.
1234 if (udev || (portstatus & USB_PORT_STAT_CONNECTION) ||
1235 (portchange & USB_PORT_STAT_C_CONNECTION) ||
1236 (portstatus & USB_PORT_STAT_OVERCURRENT) ||
1237 (portchange & USB_PORT_STAT_C_OVERCURRENT))
1238 set_bit(port1, hub->change_bits);
1240 } else if (portstatus & USB_PORT_STAT_ENABLE) {
1241 bool port_resumed = (portstatus &
1242 USB_PORT_STAT_LINK_STATE) ==
1244 /* The power session apparently survived the resume.
1245 * If there was an overcurrent or suspend change
1246 * (i.e., remote wakeup request), have hub_wq
1247 * take care of it. Look at the port link state
1248 * for USB 3.0 hubs, since they don't have a suspend
1249 * change bit, and they don't set the port link change
1250 * bit on device-initiated resume.
1252 if (portchange || (hub_is_superspeed(hub->hdev) &&
1254 set_bit(port1, hub->event_bits);
1256 } else if (udev->persist_enabled) {
1258 udev->reset_resume = 1;
1260 /* Don't set the change_bits when the device
1263 if (test_bit(port1, hub->power_bits))
1264 set_bit(port1, hub->change_bits);
1267 /* The power session is gone; tell hub_wq */
1268 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1269 set_bit(port1, hub->change_bits);
1273 /* If no port-status-change flags were set, we don't need any
1274 * debouncing. If flags were set we can try to debounce the
1275 * ports all at once right now, instead of letting hub_wq do them
1276 * one at a time later on.
1278 * If any port-status changes do occur during this delay, hub_wq
1279 * will see them later and handle them normally.
1281 if (need_debounce_delay) {
1282 delay = HUB_DEBOUNCE_STABLE;
1284 /* Don't do a long sleep inside a workqueue routine */
1285 if (type == HUB_INIT2) {
1286 INIT_DELAYED_WORK(&hub->init_work, hub_init_func3);
1287 queue_delayed_work(system_power_efficient_wq,
1289 msecs_to_jiffies(delay));
1290 device_unlock(&hdev->dev);
1291 return; /* Continues at init3: below */
1299 status = usb_submit_urb(hub->urb, GFP_NOIO);
1301 dev_err(hub->intfdev, "activate --> %d\n", status);
1302 if (hub->has_indicators && blinkenlights)
1303 queue_delayed_work(system_power_efficient_wq,
1304 &hub->leds, LED_CYCLE_PERIOD);
1306 /* Scan all ports that need attention */
1309 if (type == HUB_INIT2 || type == HUB_INIT3) {
1310 /* Allow autosuspend if it was suppressed */
1312 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
1313 device_unlock(&hdev->dev);
1319 /* Implement the continuations for the delays above */
1320 static void hub_init_func2(struct work_struct *ws)
1322 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1324 hub_activate(hub, HUB_INIT2);
1327 static void hub_init_func3(struct work_struct *ws)
1329 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1331 hub_activate(hub, HUB_INIT3);
1334 enum hub_quiescing_type {
1335 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
1338 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
1340 struct usb_device *hdev = hub->hdev;
1341 unsigned long flags;
1344 /* hub_wq and related activity won't re-trigger */
1345 spin_lock_irqsave(&hub->irq_urb_lock, flags);
1347 spin_unlock_irqrestore(&hub->irq_urb_lock, flags);
1349 if (type != HUB_SUSPEND) {
1350 /* Disconnect all the children */
1351 for (i = 0; i < hdev->maxchild; ++i) {
1352 if (hub->ports[i]->child)
1353 usb_disconnect(&hub->ports[i]->child);
1357 /* Stop hub_wq and related activity */
1358 del_timer_sync(&hub->irq_urb_retry);
1359 usb_kill_urb(hub->urb);
1360 if (hub->has_indicators)
1361 cancel_delayed_work_sync(&hub->leds);
1363 flush_work(&hub->tt.clear_work);
1366 static void hub_pm_barrier_for_all_ports(struct usb_hub *hub)
1370 for (i = 0; i < hub->hdev->maxchild; ++i)
1371 pm_runtime_barrier(&hub->ports[i]->dev);
1374 /* caller has locked the hub device */
1375 static int hub_pre_reset(struct usb_interface *intf)
1377 struct usb_hub *hub = usb_get_intfdata(intf);
1379 hub_quiesce(hub, HUB_PRE_RESET);
1381 hub_pm_barrier_for_all_ports(hub);
1385 /* caller has locked the hub device */
1386 static int hub_post_reset(struct usb_interface *intf)
1388 struct usb_hub *hub = usb_get_intfdata(intf);
1391 hub_pm_barrier_for_all_ports(hub);
1392 hub_activate(hub, HUB_POST_RESET);
1396 static int hub_configure(struct usb_hub *hub,
1397 struct usb_endpoint_descriptor *endpoint)
1399 struct usb_hcd *hcd;
1400 struct usb_device *hdev = hub->hdev;
1401 struct device *hub_dev = hub->intfdev;
1402 u16 hubstatus, hubchange;
1403 u16 wHubCharacteristics;
1406 char *message = "out of memory";
1411 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
1417 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1422 mutex_init(&hub->status_mutex);
1424 hub->descriptor = kzalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1425 if (!hub->descriptor) {
1430 /* Request the entire hub descriptor.
1431 * hub->descriptor can handle USB_MAXCHILDREN ports,
1432 * but a (non-SS) hub can/will return fewer bytes here.
1434 ret = get_hub_descriptor(hdev, hub->descriptor);
1436 message = "can't read hub descriptor";
1440 maxchild = USB_MAXCHILDREN;
1441 if (hub_is_superspeed(hdev))
1442 maxchild = min_t(unsigned, maxchild, USB_SS_MAXPORTS);
1444 if (hub->descriptor->bNbrPorts > maxchild) {
1445 message = "hub has too many ports!";
1448 } else if (hub->descriptor->bNbrPorts == 0) {
1449 message = "hub doesn't have any ports!";
1455 * Accumulate wHubDelay + 40ns for every hub in the tree of devices.
1456 * The resulting value will be used for SetIsochDelay() request.
1458 if (hub_is_superspeed(hdev) || hub_is_superspeedplus(hdev)) {
1459 u32 delay = __le16_to_cpu(hub->descriptor->u.ss.wHubDelay);
1462 delay += hdev->parent->hub_delay;
1464 delay += USB_TP_TRANSMISSION_DELAY;
1465 hdev->hub_delay = min_t(u32, delay, USB_TP_TRANSMISSION_DELAY_MAX);
1468 maxchild = hub->descriptor->bNbrPorts;
1469 dev_info(hub_dev, "%d port%s detected\n", maxchild,
1470 (maxchild == 1) ? "" : "s");
1472 hub->ports = kcalloc(maxchild, sizeof(struct usb_port *), GFP_KERNEL);
1478 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1479 if (hub_is_superspeed(hdev)) {
1487 /* FIXME for USB 3.0, skip for now */
1488 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1489 !(hub_is_superspeed(hdev))) {
1490 char portstr[USB_MAXCHILDREN + 1];
1492 for (i = 0; i < maxchild; i++)
1493 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1494 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1496 portstr[maxchild] = 0;
1497 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1499 dev_dbg(hub_dev, "standalone hub\n");
1501 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1502 case HUB_CHAR_COMMON_LPSM:
1503 dev_dbg(hub_dev, "ganged power switching\n");
1505 case HUB_CHAR_INDV_PORT_LPSM:
1506 dev_dbg(hub_dev, "individual port power switching\n");
1508 case HUB_CHAR_NO_LPSM:
1510 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1514 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1515 case HUB_CHAR_COMMON_OCPM:
1516 dev_dbg(hub_dev, "global over-current protection\n");
1518 case HUB_CHAR_INDV_PORT_OCPM:
1519 dev_dbg(hub_dev, "individual port over-current protection\n");
1521 case HUB_CHAR_NO_OCPM:
1523 dev_dbg(hub_dev, "no over-current protection\n");
1527 spin_lock_init(&hub->tt.lock);
1528 INIT_LIST_HEAD(&hub->tt.clear_list);
1529 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1530 switch (hdev->descriptor.bDeviceProtocol) {
1533 case USB_HUB_PR_HS_SINGLE_TT:
1534 dev_dbg(hub_dev, "Single TT\n");
1537 case USB_HUB_PR_HS_MULTI_TT:
1538 ret = usb_set_interface(hdev, 0, 1);
1540 dev_dbg(hub_dev, "TT per port\n");
1543 dev_err(hub_dev, "Using single TT (err %d)\n",
1548 /* USB 3.0 hubs don't have a TT */
1551 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1552 hdev->descriptor.bDeviceProtocol);
1556 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1557 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1558 case HUB_TTTT_8_BITS:
1559 if (hdev->descriptor.bDeviceProtocol != 0) {
1560 hub->tt.think_time = 666;
1561 dev_dbg(hub_dev, "TT requires at most %d "
1562 "FS bit times (%d ns)\n",
1563 8, hub->tt.think_time);
1566 case HUB_TTTT_16_BITS:
1567 hub->tt.think_time = 666 * 2;
1568 dev_dbg(hub_dev, "TT requires at most %d "
1569 "FS bit times (%d ns)\n",
1570 16, hub->tt.think_time);
1572 case HUB_TTTT_24_BITS:
1573 hub->tt.think_time = 666 * 3;
1574 dev_dbg(hub_dev, "TT requires at most %d "
1575 "FS bit times (%d ns)\n",
1576 24, hub->tt.think_time);
1578 case HUB_TTTT_32_BITS:
1579 hub->tt.think_time = 666 * 4;
1580 dev_dbg(hub_dev, "TT requires at most %d "
1581 "FS bit times (%d ns)\n",
1582 32, hub->tt.think_time);
1586 /* probe() zeroes hub->indicator[] */
1587 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1588 hub->has_indicators = 1;
1589 dev_dbg(hub_dev, "Port indicators are supported\n");
1592 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1593 hub->descriptor->bPwrOn2PwrGood * 2);
1595 /* power budgeting mostly matters with bus-powered hubs,
1596 * and battery-powered root hubs (may provide just 8 mA).
1598 ret = usb_get_std_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1600 message = "can't get hub status";
1603 hcd = bus_to_hcd(hdev->bus);
1604 if (hdev == hdev->bus->root_hub) {
1605 if (hcd->power_budget > 0)
1606 hdev->bus_mA = hcd->power_budget;
1608 hdev->bus_mA = full_load * maxchild;
1609 if (hdev->bus_mA >= full_load)
1610 hub->mA_per_port = full_load;
1612 hub->mA_per_port = hdev->bus_mA;
1613 hub->limited_power = 1;
1615 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1616 int remaining = hdev->bus_mA -
1617 hub->descriptor->bHubContrCurrent;
1619 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1620 hub->descriptor->bHubContrCurrent);
1621 hub->limited_power = 1;
1623 if (remaining < maxchild * unit_load)
1625 "insufficient power available "
1626 "to use all downstream ports\n");
1627 hub->mA_per_port = unit_load; /* 7.2.1 */
1629 } else { /* Self-powered external hub */
1630 /* FIXME: What about battery-powered external hubs that
1631 * provide less current per port? */
1632 hub->mA_per_port = full_load;
1634 if (hub->mA_per_port < full_load)
1635 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1638 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1640 message = "can't get hub status";
1644 /* local power status reports aren't always correct */
1645 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1646 dev_dbg(hub_dev, "local power source is %s\n",
1647 (hubstatus & HUB_STATUS_LOCAL_POWER)
1648 ? "lost (inactive)" : "good");
1650 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1651 dev_dbg(hub_dev, "%sover-current condition exists\n",
1652 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1654 /* set up the interrupt endpoint
1655 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1656 * bytes as USB2.0[11.12.3] says because some hubs are known
1657 * to send more data (and thus cause overflow). For root hubs,
1658 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1659 * to be big enough for at least USB_MAXCHILDREN ports. */
1660 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1661 maxp = usb_maxpacket(hdev, pipe);
1663 if (maxp > sizeof(*hub->buffer))
1664 maxp = sizeof(*hub->buffer);
1666 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1672 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1673 hub, endpoint->bInterval);
1675 /* maybe cycle the hub leds */
1676 if (hub->has_indicators && blinkenlights)
1677 hub->indicator[0] = INDICATOR_CYCLE;
1679 mutex_lock(&usb_port_peer_mutex);
1680 for (i = 0; i < maxchild; i++) {
1681 ret = usb_hub_create_port_device(hub, i + 1);
1683 dev_err(hub->intfdev,
1684 "couldn't create port%d device.\n", i + 1);
1689 for (i = 0; i < hdev->maxchild; i++) {
1690 struct usb_port *port_dev = hub->ports[i];
1692 pm_runtime_put(&port_dev->dev);
1695 mutex_unlock(&usb_port_peer_mutex);
1699 /* Update the HCD's internal representation of this hub before hub_wq
1700 * starts getting port status changes for devices under the hub.
1702 if (hcd->driver->update_hub_device) {
1703 ret = hcd->driver->update_hub_device(hcd, hdev,
1704 &hub->tt, GFP_KERNEL);
1706 message = "can't update HCD hub info";
1711 usb_hub_adjust_deviceremovable(hdev, hub->descriptor);
1713 hub_activate(hub, HUB_INIT);
1717 dev_err(hub_dev, "config failed, %s (err %d)\n",
1719 /* hub_disconnect() frees urb and descriptor */
1723 static void hub_release(struct kref *kref)
1725 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1727 usb_put_dev(hub->hdev);
1728 usb_put_intf(to_usb_interface(hub->intfdev));
1732 void hub_get(struct usb_hub *hub)
1734 kref_get(&hub->kref);
1737 void hub_put(struct usb_hub *hub)
1739 kref_put(&hub->kref, hub_release);
1742 static unsigned highspeed_hubs;
1744 static void hub_disconnect(struct usb_interface *intf)
1746 struct usb_hub *hub = usb_get_intfdata(intf);
1747 struct usb_device *hdev = interface_to_usbdev(intf);
1751 * Stop adding new hub events. We do not want to block here and thus
1752 * will not try to remove any pending work item.
1754 hub->disconnected = 1;
1756 /* Disconnect all children and quiesce the hub */
1758 hub_quiesce(hub, HUB_DISCONNECT);
1760 mutex_lock(&usb_port_peer_mutex);
1762 /* Avoid races with recursively_mark_NOTATTACHED() */
1763 spin_lock_irq(&device_state_lock);
1764 port1 = hdev->maxchild;
1766 usb_set_intfdata(intf, NULL);
1767 spin_unlock_irq(&device_state_lock);
1769 for (; port1 > 0; --port1)
1770 usb_hub_remove_port_device(hub, port1);
1772 mutex_unlock(&usb_port_peer_mutex);
1774 if (hub->hdev->speed == USB_SPEED_HIGH)
1777 usb_free_urb(hub->urb);
1779 kfree(hub->descriptor);
1783 pm_suspend_ignore_children(&intf->dev, false);
1785 if (hub->quirk_disable_autosuspend)
1786 usb_autopm_put_interface(intf);
1788 onboard_hub_destroy_pdevs(&hub->onboard_hub_devs);
1793 static bool hub_descriptor_is_sane(struct usb_host_interface *desc)
1795 /* Some hubs have a subclass of 1, which AFAICT according to the */
1796 /* specs is not defined, but it works */
1797 if (desc->desc.bInterfaceSubClass != 0 &&
1798 desc->desc.bInterfaceSubClass != 1)
1801 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1802 if (desc->desc.bNumEndpoints != 1)
1805 /* If the first endpoint is not interrupt IN, we'd better punt! */
1806 if (!usb_endpoint_is_int_in(&desc->endpoint[0].desc))
1812 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1814 struct usb_host_interface *desc;
1815 struct usb_device *hdev;
1816 struct usb_hub *hub;
1818 desc = intf->cur_altsetting;
1819 hdev = interface_to_usbdev(intf);
1822 * Set default autosuspend delay as 0 to speedup bus suspend,
1823 * based on the below considerations:
1825 * - Unlike other drivers, the hub driver does not rely on the
1826 * autosuspend delay to provide enough time to handle a wakeup
1827 * event, and the submitted status URB is just to check future
1828 * change on hub downstream ports, so it is safe to do it.
1830 * - The patch might cause one or more auto supend/resume for
1831 * below very rare devices when they are plugged into hub
1834 * devices having trouble initializing, and disconnect
1835 * themselves from the bus and then reconnect a second
1838 * devices just for downloading firmware, and disconnects
1839 * themselves after completing it
1841 * For these quite rare devices, their drivers may change the
1842 * autosuspend delay of their parent hub in the probe() to one
1843 * appropriate value to avoid the subtle problem if someone
1846 * - The patch may cause one or more auto suspend/resume on
1847 * hub during running 'lsusb', but it is probably too
1848 * infrequent to worry about.
1850 * - Change autosuspend delay of hub can avoid unnecessary auto
1851 * suspend timer for hub, also may decrease power consumption
1854 * - If user has indicated to prevent autosuspend by passing
1855 * usbcore.autosuspend = -1 then keep autosuspend disabled.
1858 if (hdev->dev.power.autosuspend_delay >= 0)
1859 pm_runtime_set_autosuspend_delay(&hdev->dev, 0);
1863 * Hubs have proper suspend/resume support, except for root hubs
1864 * where the controller driver doesn't have bus_suspend and
1865 * bus_resume methods.
1867 if (hdev->parent) { /* normal device */
1868 usb_enable_autosuspend(hdev);
1869 } else { /* root hub */
1870 const struct hc_driver *drv = bus_to_hcd(hdev->bus)->driver;
1872 if (drv->bus_suspend && drv->bus_resume)
1873 usb_enable_autosuspend(hdev);
1876 if (hdev->level == MAX_TOPO_LEVEL) {
1878 "Unsupported bus topology: hub nested too deep\n");
1882 #ifdef CONFIG_USB_OTG_DISABLE_EXTERNAL_HUB
1884 dev_warn(&intf->dev, "ignoring external hub\n");
1889 if (!hub_descriptor_is_sane(desc)) {
1890 dev_err(&intf->dev, "bad descriptor, ignoring hub\n");
1894 /* We found a hub */
1895 dev_info(&intf->dev, "USB hub found\n");
1897 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1901 kref_init(&hub->kref);
1902 hub->intfdev = &intf->dev;
1904 INIT_DELAYED_WORK(&hub->leds, led_work);
1905 INIT_DELAYED_WORK(&hub->init_work, NULL);
1906 INIT_WORK(&hub->events, hub_event);
1907 INIT_LIST_HEAD(&hub->onboard_hub_devs);
1908 spin_lock_init(&hub->irq_urb_lock);
1909 timer_setup(&hub->irq_urb_retry, hub_retry_irq_urb, 0);
1913 usb_set_intfdata(intf, hub);
1914 intf->needs_remote_wakeup = 1;
1915 pm_suspend_ignore_children(&intf->dev, true);
1917 if (hdev->speed == USB_SPEED_HIGH)
1920 if (id->driver_info & HUB_QUIRK_CHECK_PORT_AUTOSUSPEND)
1921 hub->quirk_check_port_auto_suspend = 1;
1923 if (id->driver_info & HUB_QUIRK_DISABLE_AUTOSUSPEND) {
1924 hub->quirk_disable_autosuspend = 1;
1925 usb_autopm_get_interface_no_resume(intf);
1928 if ((id->driver_info & HUB_QUIRK_REDUCE_FRAME_INTR_BINTERVAL) &&
1929 desc->endpoint[0].desc.bInterval > USB_REDUCE_FRAME_INTR_BINTERVAL) {
1930 desc->endpoint[0].desc.bInterval =
1931 USB_REDUCE_FRAME_INTR_BINTERVAL;
1932 /* Tell the HCD about the interrupt ep's new bInterval */
1933 usb_set_interface(hdev, 0, 0);
1936 if (hub_configure(hub, &desc->endpoint[0].desc) >= 0) {
1937 onboard_hub_create_pdevs(hdev, &hub->onboard_hub_devs);
1942 hub_disconnect(intf);
1947 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1949 struct usb_device *hdev = interface_to_usbdev(intf);
1950 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1952 /* assert ifno == 0 (part of hub spec) */
1954 case USBDEVFS_HUB_PORTINFO: {
1955 struct usbdevfs_hub_portinfo *info = user_data;
1958 spin_lock_irq(&device_state_lock);
1959 if (hdev->devnum <= 0)
1962 info->nports = hdev->maxchild;
1963 for (i = 0; i < info->nports; i++) {
1964 if (hub->ports[i]->child == NULL)
1968 hub->ports[i]->child->devnum;
1971 spin_unlock_irq(&device_state_lock);
1973 return info->nports + 1;
1982 * Allow user programs to claim ports on a hub. When a device is attached
1983 * to one of these "claimed" ports, the program will "own" the device.
1985 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1986 struct usb_dev_state ***ppowner)
1988 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1990 if (hdev->state == USB_STATE_NOTATTACHED)
1992 if (port1 == 0 || port1 > hdev->maxchild)
1995 /* Devices not managed by the hub driver
1996 * will always have maxchild equal to 0.
1998 *ppowner = &(hub->ports[port1 - 1]->port_owner);
2002 /* In the following three functions, the caller must hold hdev's lock */
2003 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
2004 struct usb_dev_state *owner)
2007 struct usb_dev_state **powner;
2009 rc = find_port_owner(hdev, port1, &powner);
2017 EXPORT_SYMBOL_GPL(usb_hub_claim_port);
2019 int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
2020 struct usb_dev_state *owner)
2023 struct usb_dev_state **powner;
2025 rc = find_port_owner(hdev, port1, &powner);
2028 if (*powner != owner)
2033 EXPORT_SYMBOL_GPL(usb_hub_release_port);
2035 void usb_hub_release_all_ports(struct usb_device *hdev, struct usb_dev_state *owner)
2037 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
2040 for (n = 0; n < hdev->maxchild; n++) {
2041 if (hub->ports[n]->port_owner == owner)
2042 hub->ports[n]->port_owner = NULL;
2047 /* The caller must hold udev's lock */
2048 bool usb_device_is_owned(struct usb_device *udev)
2050 struct usb_hub *hub;
2052 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
2054 hub = usb_hub_to_struct_hub(udev->parent);
2055 return !!hub->ports[udev->portnum - 1]->port_owner;
2058 static void update_port_device_state(struct usb_device *udev)
2060 struct usb_hub *hub;
2061 struct usb_port *port_dev;
2064 hub = usb_hub_to_struct_hub(udev->parent);
2067 * The Link Layer Validation System Driver (lvstest)
2068 * has a test step to unbind the hub before running the
2069 * rest of the procedure. This triggers hub_disconnect
2070 * which will set the hub's maxchild to 0, further
2071 * resulting in usb_hub_to_struct_hub returning NULL.
2074 port_dev = hub->ports[udev->portnum - 1];
2075 WRITE_ONCE(port_dev->state, udev->state);
2076 sysfs_notify_dirent(port_dev->state_kn);
2081 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
2083 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2086 for (i = 0; i < udev->maxchild; ++i) {
2087 if (hub->ports[i]->child)
2088 recursively_mark_NOTATTACHED(hub->ports[i]->child);
2090 if (udev->state == USB_STATE_SUSPENDED)
2091 udev->active_duration -= jiffies;
2092 udev->state = USB_STATE_NOTATTACHED;
2093 update_port_device_state(udev);
2097 * usb_set_device_state - change a device's current state (usbcore, hcds)
2098 * @udev: pointer to device whose state should be changed
2099 * @new_state: new state value to be stored
2101 * udev->state is _not_ fully protected by the device lock. Although
2102 * most transitions are made only while holding the lock, the state can
2103 * can change to USB_STATE_NOTATTACHED at almost any time. This
2104 * is so that devices can be marked as disconnected as soon as possible,
2105 * without having to wait for any semaphores to be released. As a result,
2106 * all changes to any device's state must be protected by the
2107 * device_state_lock spinlock.
2109 * Once a device has been added to the device tree, all changes to its state
2110 * should be made using this routine. The state should _not_ be set directly.
2112 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
2113 * Otherwise udev->state is set to new_state, and if new_state is
2114 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
2115 * to USB_STATE_NOTATTACHED.
2117 void usb_set_device_state(struct usb_device *udev,
2118 enum usb_device_state new_state)
2120 unsigned long flags;
2123 spin_lock_irqsave(&device_state_lock, flags);
2124 if (udev->state == USB_STATE_NOTATTACHED)
2126 else if (new_state != USB_STATE_NOTATTACHED) {
2128 /* root hub wakeup capabilities are managed out-of-band
2129 * and may involve silicon errata ... ignore them here.
2132 if (udev->state == USB_STATE_SUSPENDED
2133 || new_state == USB_STATE_SUSPENDED)
2134 ; /* No change to wakeup settings */
2135 else if (new_state == USB_STATE_CONFIGURED)
2136 wakeup = (udev->quirks &
2137 USB_QUIRK_IGNORE_REMOTE_WAKEUP) ? 0 :
2138 udev->actconfig->desc.bmAttributes &
2139 USB_CONFIG_ATT_WAKEUP;
2143 if (udev->state == USB_STATE_SUSPENDED &&
2144 new_state != USB_STATE_SUSPENDED)
2145 udev->active_duration -= jiffies;
2146 else if (new_state == USB_STATE_SUSPENDED &&
2147 udev->state != USB_STATE_SUSPENDED)
2148 udev->active_duration += jiffies;
2149 udev->state = new_state;
2150 update_port_device_state(udev);
2152 recursively_mark_NOTATTACHED(udev);
2153 spin_unlock_irqrestore(&device_state_lock, flags);
2155 device_set_wakeup_capable(&udev->dev, wakeup);
2157 EXPORT_SYMBOL_GPL(usb_set_device_state);
2160 * Choose a device number.
2162 * Device numbers are used as filenames in usbfs. On USB-1.1 and
2163 * USB-2.0 buses they are also used as device addresses, however on
2164 * USB-3.0 buses the address is assigned by the controller hardware
2165 * and it usually is not the same as the device number.
2167 * Devices connected under xHCI are not as simple. The host controller
2168 * supports virtualization, so the hardware assigns device addresses and
2169 * the HCD must setup data structures before issuing a set address
2170 * command to the hardware.
2172 static void choose_devnum(struct usb_device *udev)
2175 struct usb_bus *bus = udev->bus;
2177 /* be safe when more hub events are proceed in parallel */
2178 mutex_lock(&bus->devnum_next_mutex);
2180 /* Try to allocate the next devnum beginning at bus->devnum_next. */
2181 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
2184 devnum = find_next_zero_bit(bus->devmap.devicemap, 128, 1);
2185 bus->devnum_next = (devnum >= 127 ? 1 : devnum + 1);
2187 set_bit(devnum, bus->devmap.devicemap);
2188 udev->devnum = devnum;
2190 mutex_unlock(&bus->devnum_next_mutex);
2193 static void release_devnum(struct usb_device *udev)
2195 if (udev->devnum > 0) {
2196 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
2201 static void update_devnum(struct usb_device *udev, int devnum)
2203 udev->devnum = devnum;
2205 udev->devaddr = (u8)devnum;
2208 static void hub_free_dev(struct usb_device *udev)
2210 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2212 /* Root hubs aren't real devices, so don't free HCD resources */
2213 if (hcd->driver->free_dev && udev->parent)
2214 hcd->driver->free_dev(hcd, udev);
2217 static void hub_disconnect_children(struct usb_device *udev)
2219 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2222 /* Free up all the children before we remove this device */
2223 for (i = 0; i < udev->maxchild; i++) {
2224 if (hub->ports[i]->child)
2225 usb_disconnect(&hub->ports[i]->child);
2230 * usb_disconnect - disconnect a device (usbcore-internal)
2231 * @pdev: pointer to device being disconnected
2233 * Context: task context, might sleep
2235 * Something got disconnected. Get rid of it and all of its children.
2237 * If *pdev is a normal device then the parent hub must already be locked.
2238 * If *pdev is a root hub then the caller must hold the usb_bus_idr_lock,
2239 * which protects the set of root hubs as well as the list of buses.
2241 * Only hub drivers (including virtual root hub drivers for host
2242 * controllers) should ever call this.
2244 * This call is synchronous, and may not be used in an interrupt context.
2246 void usb_disconnect(struct usb_device **pdev)
2248 struct usb_port *port_dev = NULL;
2249 struct usb_device *udev = *pdev;
2250 struct usb_hub *hub = NULL;
2253 /* mark the device as inactive, so any further urb submissions for
2254 * this device (and any of its children) will fail immediately.
2255 * this quiesces everything except pending urbs.
2257 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2258 dev_info(&udev->dev, "USB disconnect, device number %d\n",
2262 * Ensure that the pm runtime code knows that the USB device
2263 * is in the process of being disconnected.
2265 pm_runtime_barrier(&udev->dev);
2267 usb_lock_device(udev);
2269 hub_disconnect_children(udev);
2271 /* deallocate hcd/hardware state ... nuking all pending urbs and
2272 * cleaning up all state associated with the current configuration
2273 * so that the hardware is now fully quiesced.
2275 dev_dbg(&udev->dev, "unregistering device\n");
2276 usb_disable_device(udev, 0);
2277 usb_hcd_synchronize_unlinks(udev);
2280 port1 = udev->portnum;
2281 hub = usb_hub_to_struct_hub(udev->parent);
2282 port_dev = hub->ports[port1 - 1];
2284 sysfs_remove_link(&udev->dev.kobj, "port");
2285 sysfs_remove_link(&port_dev->dev.kobj, "device");
2288 * As usb_port_runtime_resume() de-references udev, make
2289 * sure no resumes occur during removal
2291 if (!test_and_set_bit(port1, hub->child_usage_bits))
2292 pm_runtime_get_sync(&port_dev->dev);
2294 typec_deattach(port_dev->connector, &udev->dev);
2297 usb_remove_ep_devs(&udev->ep0);
2298 usb_unlock_device(udev);
2300 /* Unregister the device. The device driver is responsible
2301 * for de-configuring the device and invoking the remove-device
2302 * notifier chain (used by usbfs and possibly others).
2304 device_del(&udev->dev);
2306 /* Free the device number and delete the parent's children[]
2307 * (or root_hub) pointer.
2309 release_devnum(udev);
2311 /* Avoid races with recursively_mark_NOTATTACHED() */
2312 spin_lock_irq(&device_state_lock);
2314 spin_unlock_irq(&device_state_lock);
2316 if (port_dev && test_and_clear_bit(port1, hub->child_usage_bits))
2317 pm_runtime_put(&port_dev->dev);
2321 put_device(&udev->dev);
2324 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2325 static void show_string(struct usb_device *udev, char *id, char *string)
2329 dev_info(&udev->dev, "%s: %s\n", id, string);
2332 static void announce_device(struct usb_device *udev)
2334 u16 bcdDevice = le16_to_cpu(udev->descriptor.bcdDevice);
2336 dev_info(&udev->dev,
2337 "New USB device found, idVendor=%04x, idProduct=%04x, bcdDevice=%2x.%02x\n",
2338 le16_to_cpu(udev->descriptor.idVendor),
2339 le16_to_cpu(udev->descriptor.idProduct),
2340 bcdDevice >> 8, bcdDevice & 0xff);
2341 dev_info(&udev->dev,
2342 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2343 udev->descriptor.iManufacturer,
2344 udev->descriptor.iProduct,
2345 udev->descriptor.iSerialNumber);
2346 show_string(udev, "Product", udev->product);
2347 show_string(udev, "Manufacturer", udev->manufacturer);
2348 show_string(udev, "SerialNumber", udev->serial);
2351 static inline void announce_device(struct usb_device *udev) { }
2356 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2357 * @udev: newly addressed device (in ADDRESS state)
2359 * Finish enumeration for On-The-Go devices
2361 * Return: 0 if successful. A negative error code otherwise.
2363 static int usb_enumerate_device_otg(struct usb_device *udev)
2367 #ifdef CONFIG_USB_OTG
2369 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2370 * to wake us after we've powered off VBUS; and HNP, switching roles
2371 * "host" to "peripheral". The OTG descriptor helps figure this out.
2373 if (!udev->bus->is_b_host
2375 && udev->parent == udev->bus->root_hub) {
2376 struct usb_otg_descriptor *desc = NULL;
2377 struct usb_bus *bus = udev->bus;
2378 unsigned port1 = udev->portnum;
2380 /* descriptor may appear anywhere in config */
2381 err = __usb_get_extra_descriptor(udev->rawdescriptors[0],
2382 le16_to_cpu(udev->config[0].desc.wTotalLength),
2383 USB_DT_OTG, (void **) &desc, sizeof(*desc));
2384 if (err || !(desc->bmAttributes & USB_OTG_HNP))
2387 dev_info(&udev->dev, "Dual-Role OTG device on %sHNP port\n",
2388 (port1 == bus->otg_port) ? "" : "non-");
2390 /* enable HNP before suspend, it's simpler */
2391 if (port1 == bus->otg_port) {
2392 bus->b_hnp_enable = 1;
2393 err = usb_control_msg(udev,
2394 usb_sndctrlpipe(udev, 0),
2395 USB_REQ_SET_FEATURE, 0,
2396 USB_DEVICE_B_HNP_ENABLE,
2398 USB_CTRL_SET_TIMEOUT);
2401 * OTG MESSAGE: report errors here,
2402 * customize to match your product.
2404 dev_err(&udev->dev, "can't set HNP mode: %d\n",
2406 bus->b_hnp_enable = 0;
2408 } else if (desc->bLength == sizeof
2409 (struct usb_otg_descriptor)) {
2411 * We are operating on a legacy OTP device
2412 * These should be told that they are operating
2413 * on the wrong port if we have another port that does
2416 if (bus->otg_port != 0) {
2417 /* Set a_alt_hnp_support for legacy otg device */
2418 err = usb_control_msg(udev,
2419 usb_sndctrlpipe(udev, 0),
2420 USB_REQ_SET_FEATURE, 0,
2421 USB_DEVICE_A_ALT_HNP_SUPPORT,
2423 USB_CTRL_SET_TIMEOUT);
2426 "set a_alt_hnp_support failed: %d\n",
2437 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2438 * @udev: newly addressed device (in ADDRESS state)
2440 * This is only called by usb_new_device() -- all comments that apply there
2441 * apply here wrt to environment.
2443 * If the device is WUSB and not authorized, we don't attempt to read
2444 * the string descriptors, as they will be errored out by the device
2445 * until it has been authorized.
2447 * Return: 0 if successful. A negative error code otherwise.
2449 static int usb_enumerate_device(struct usb_device *udev)
2452 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2454 if (udev->config == NULL) {
2455 err = usb_get_configuration(udev);
2458 dev_err(&udev->dev, "can't read configurations, error %d\n",
2464 /* read the standard strings and cache them if present */
2465 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
2466 udev->manufacturer = usb_cache_string(udev,
2467 udev->descriptor.iManufacturer);
2468 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
2470 err = usb_enumerate_device_otg(udev);
2474 if (IS_ENABLED(CONFIG_USB_OTG_PRODUCTLIST) && hcd->tpl_support &&
2475 !is_targeted(udev)) {
2476 /* Maybe it can talk to us, though we can't talk to it.
2477 * (Includes HNP test device.)
2479 if (IS_ENABLED(CONFIG_USB_OTG) && (udev->bus->b_hnp_enable
2480 || udev->bus->is_b_host)) {
2481 err = usb_port_suspend(udev, PMSG_AUTO_SUSPEND);
2483 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
2488 usb_detect_interface_quirks(udev);
2493 static void set_usb_port_removable(struct usb_device *udev)
2495 struct usb_device *hdev = udev->parent;
2496 struct usb_hub *hub;
2497 u8 port = udev->portnum;
2498 u16 wHubCharacteristics;
2499 bool removable = true;
2501 dev_set_removable(&udev->dev, DEVICE_REMOVABLE_UNKNOWN);
2506 hub = usb_hub_to_struct_hub(udev->parent);
2509 * If the platform firmware has provided information about a port,
2510 * use that to determine whether it's removable.
2512 switch (hub->ports[udev->portnum - 1]->connect_type) {
2513 case USB_PORT_CONNECT_TYPE_HOT_PLUG:
2514 dev_set_removable(&udev->dev, DEVICE_REMOVABLE);
2516 case USB_PORT_CONNECT_TYPE_HARD_WIRED:
2517 case USB_PORT_NOT_USED:
2518 dev_set_removable(&udev->dev, DEVICE_FIXED);
2525 * Otherwise, check whether the hub knows whether a port is removable
2528 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2530 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
2533 if (hub_is_superspeed(hdev)) {
2534 if (le16_to_cpu(hub->descriptor->u.ss.DeviceRemovable)
2538 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
2543 dev_set_removable(&udev->dev, DEVICE_REMOVABLE);
2545 dev_set_removable(&udev->dev, DEVICE_FIXED);
2550 * usb_new_device - perform initial device setup (usbcore-internal)
2551 * @udev: newly addressed device (in ADDRESS state)
2553 * This is called with devices which have been detected but not fully
2554 * enumerated. The device descriptor is available, but not descriptors
2555 * for any device configuration. The caller must have locked either
2556 * the parent hub (if udev is a normal device) or else the
2557 * usb_bus_idr_lock (if udev is a root hub). The parent's pointer to
2558 * udev has already been installed, but udev is not yet visible through
2559 * sysfs or other filesystem code.
2561 * This call is synchronous, and may not be used in an interrupt context.
2563 * Only the hub driver or root-hub registrar should ever call this.
2565 * Return: Whether the device is configured properly or not. Zero if the
2566 * interface was registered with the driver core; else a negative errno
2570 int usb_new_device(struct usb_device *udev)
2575 /* Initialize non-root-hub device wakeup to disabled;
2576 * device (un)configuration controls wakeup capable
2577 * sysfs power/wakeup controls wakeup enabled/disabled
2579 device_init_wakeup(&udev->dev, 0);
2582 /* Tell the runtime-PM framework the device is active */
2583 pm_runtime_set_active(&udev->dev);
2584 pm_runtime_get_noresume(&udev->dev);
2585 pm_runtime_use_autosuspend(&udev->dev);
2586 pm_runtime_enable(&udev->dev);
2588 /* By default, forbid autosuspend for all devices. It will be
2589 * allowed for hubs during binding.
2591 usb_disable_autosuspend(udev);
2593 err = usb_enumerate_device(udev); /* Read descriptors */
2596 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
2597 udev->devnum, udev->bus->busnum,
2598 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2599 /* export the usbdev device-node for libusb */
2600 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
2601 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2603 /* Tell the world! */
2604 announce_device(udev);
2607 add_device_randomness(udev->serial, strlen(udev->serial));
2609 add_device_randomness(udev->product, strlen(udev->product));
2610 if (udev->manufacturer)
2611 add_device_randomness(udev->manufacturer,
2612 strlen(udev->manufacturer));
2614 device_enable_async_suspend(&udev->dev);
2616 /* check whether the hub or firmware marks this port as non-removable */
2617 set_usb_port_removable(udev);
2619 /* Register the device. The device driver is responsible
2620 * for configuring the device and invoking the add-device
2621 * notifier chain (used by usbfs and possibly others).
2623 err = device_add(&udev->dev);
2625 dev_err(&udev->dev, "can't device_add, error %d\n", err);
2629 /* Create link files between child device and usb port device. */
2631 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2632 int port1 = udev->portnum;
2633 struct usb_port *port_dev = hub->ports[port1 - 1];
2635 err = sysfs_create_link(&udev->dev.kobj,
2636 &port_dev->dev.kobj, "port");
2640 err = sysfs_create_link(&port_dev->dev.kobj,
2641 &udev->dev.kobj, "device");
2643 sysfs_remove_link(&udev->dev.kobj, "port");
2647 if (!test_and_set_bit(port1, hub->child_usage_bits))
2648 pm_runtime_get_sync(&port_dev->dev);
2650 typec_attach(port_dev->connector, &udev->dev);
2653 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
2654 usb_mark_last_busy(udev);
2655 pm_runtime_put_sync_autosuspend(&udev->dev);
2659 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2660 pm_runtime_disable(&udev->dev);
2661 pm_runtime_set_suspended(&udev->dev);
2667 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2668 * @usb_dev: USB device
2670 * Move the USB device to a very basic state where interfaces are disabled
2671 * and the device is in fact unconfigured and unusable.
2673 * We share a lock (that we have) with device_del(), so we need to
2678 int usb_deauthorize_device(struct usb_device *usb_dev)
2680 usb_lock_device(usb_dev);
2681 if (usb_dev->authorized == 0)
2682 goto out_unauthorized;
2684 usb_dev->authorized = 0;
2685 usb_set_configuration(usb_dev, -1);
2688 usb_unlock_device(usb_dev);
2693 int usb_authorize_device(struct usb_device *usb_dev)
2697 usb_lock_device(usb_dev);
2698 if (usb_dev->authorized == 1)
2699 goto out_authorized;
2701 result = usb_autoresume_device(usb_dev);
2703 dev_err(&usb_dev->dev,
2704 "can't autoresume for authorization: %d\n", result);
2705 goto error_autoresume;
2708 usb_dev->authorized = 1;
2709 /* Choose and set the configuration. This registers the interfaces
2710 * with the driver core and lets interface drivers bind to them.
2712 c = usb_choose_configuration(usb_dev);
2714 result = usb_set_configuration(usb_dev, c);
2716 dev_err(&usb_dev->dev,
2717 "can't set config #%d, error %d\n", c, result);
2718 /* This need not be fatal. The user can try to
2719 * set other configurations. */
2722 dev_info(&usb_dev->dev, "authorized to connect\n");
2724 usb_autosuspend_device(usb_dev);
2727 usb_unlock_device(usb_dev); /* complements locktree */
2732 * get_port_ssp_rate - Match the extended port status to SSP rate
2733 * @hdev: The hub device
2734 * @ext_portstatus: extended port status
2736 * Match the extended port status speed id to the SuperSpeed Plus sublink speed
2737 * capability attributes. Base on the number of connected lanes and speed,
2738 * return the corresponding enum usb_ssp_rate.
2740 static enum usb_ssp_rate get_port_ssp_rate(struct usb_device *hdev,
2743 struct usb_ssp_cap_descriptor *ssp_cap;
2753 ssp_cap = hdev->bos->ssp_cap;
2757 speed_id = ext_portstatus & USB_EXT_PORT_STAT_RX_SPEED_ID;
2758 lanes = USB_EXT_PORT_RX_LANES(ext_portstatus) + 1;
2760 ssac = le32_to_cpu(ssp_cap->bmAttributes) &
2761 USB_SSP_SUBLINK_SPEED_ATTRIBS;
2763 for (i = 0; i <= ssac; i++) {
2766 attr = le32_to_cpu(ssp_cap->bmSublinkSpeedAttr[i]);
2767 ssid = FIELD_GET(USB_SSP_SUBLINK_SPEED_SSID, attr);
2768 if (speed_id == ssid) {
2774 * Note: currently asymmetric lane types are only
2775 * applicable for SSIC operate in SuperSpeed protocol
2777 type = FIELD_GET(USB_SSP_SUBLINK_SPEED_ST, attr);
2778 if (type == USB_SSP_SUBLINK_SPEED_ST_ASYM_RX ||
2779 type == USB_SSP_SUBLINK_SPEED_ST_ASYM_TX)
2782 if (FIELD_GET(USB_SSP_SUBLINK_SPEED_LP, attr) !=
2783 USB_SSP_SUBLINK_SPEED_LP_SSP)
2786 lse = FIELD_GET(USB_SSP_SUBLINK_SPEED_LSE, attr);
2787 mantissa = FIELD_GET(USB_SSP_SUBLINK_SPEED_LSM, attr);
2789 /* Convert to Gbps */
2790 for (; lse < USB_SSP_SUBLINK_SPEED_LSE_GBPS; lse++)
2793 if (mantissa >= 10 && lanes == 1)
2794 return USB_SSP_GEN_2x1;
2796 if (mantissa >= 10 && lanes == 2)
2797 return USB_SSP_GEN_2x2;
2799 if (mantissa >= 5 && lanes == 2)
2800 return USB_SSP_GEN_1x2;
2807 return USB_SSP_GEN_UNKNOWN;
2810 #ifdef CONFIG_USB_FEW_INIT_RETRIES
2811 #define PORT_RESET_TRIES 2
2812 #define SET_ADDRESS_TRIES 1
2813 #define GET_DESCRIPTOR_TRIES 1
2814 #define GET_MAXPACKET0_TRIES 1
2815 #define PORT_INIT_TRIES 4
2818 #define PORT_RESET_TRIES 5
2819 #define SET_ADDRESS_TRIES 2
2820 #define GET_DESCRIPTOR_TRIES 2
2821 #define GET_MAXPACKET0_TRIES 3
2822 #define PORT_INIT_TRIES 4
2823 #endif /* CONFIG_USB_FEW_INIT_RETRIES */
2825 #define DETECT_DISCONNECT_TRIES 5
2827 #define HUB_ROOT_RESET_TIME 60 /* times are in msec */
2828 #define HUB_SHORT_RESET_TIME 10
2829 #define HUB_BH_RESET_TIME 50
2830 #define HUB_LONG_RESET_TIME 200
2831 #define HUB_RESET_TIMEOUT 800
2833 static bool use_new_scheme(struct usb_device *udev, int retry,
2834 struct usb_port *port_dev)
2836 int old_scheme_first_port =
2837 (port_dev->quirks & USB_PORT_QUIRK_OLD_SCHEME) ||
2841 * "New scheme" enumeration causes an extra state transition to be
2842 * exposed to an xhci host and causes USB3 devices to receive control
2843 * commands in the default state. This has been seen to cause
2844 * enumeration failures, so disable this enumeration scheme for USB3
2847 if (udev->speed >= USB_SPEED_SUPER)
2851 * If use_both_schemes is set, use the first scheme (whichever
2852 * it is) for the larger half of the retries, then use the other
2853 * scheme. Otherwise, use the first scheme for all the retries.
2855 if (use_both_schemes && retry >= (PORT_INIT_TRIES + 1) / 2)
2856 return old_scheme_first_port; /* Second half */
2857 return !old_scheme_first_port; /* First half or all */
2860 /* Is a USB 3.0 port in the Inactive or Compliance Mode state?
2861 * Port warm reset is required to recover
2863 static bool hub_port_warm_reset_required(struct usb_hub *hub, int port1,
2868 if (!hub_is_superspeed(hub->hdev))
2871 if (test_bit(port1, hub->warm_reset_bits))
2874 link_state = portstatus & USB_PORT_STAT_LINK_STATE;
2875 return link_state == USB_SS_PORT_LS_SS_INACTIVE
2876 || link_state == USB_SS_PORT_LS_COMP_MOD;
2879 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2880 struct usb_device *udev, unsigned int delay, bool warm)
2882 int delay_time, ret;
2885 u32 ext_portstatus = 0;
2887 for (delay_time = 0;
2888 delay_time < HUB_RESET_TIMEOUT;
2889 delay_time += delay) {
2890 /* wait to give the device a chance to reset */
2893 /* read and decode port status */
2894 if (hub_is_superspeedplus(hub->hdev))
2895 ret = hub_ext_port_status(hub, port1,
2896 HUB_EXT_PORT_STATUS,
2897 &portstatus, &portchange,
2900 ret = usb_hub_port_status(hub, port1, &portstatus,
2906 * The port state is unknown until the reset completes.
2908 * On top of that, some chips may require additional time
2909 * to re-establish a connection after the reset is complete,
2910 * so also wait for the connection to be re-established.
2912 if (!(portstatus & USB_PORT_STAT_RESET) &&
2913 (portstatus & USB_PORT_STAT_CONNECTION))
2916 /* switch to the long delay after two short delay failures */
2917 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2918 delay = HUB_LONG_RESET_TIME;
2920 dev_dbg(&hub->ports[port1 - 1]->dev,
2921 "not %sreset yet, waiting %dms\n",
2922 warm ? "warm " : "", delay);
2925 if ((portstatus & USB_PORT_STAT_RESET))
2928 if (hub_port_warm_reset_required(hub, port1, portstatus))
2931 /* Device went away? */
2932 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2935 /* Retry if connect change is set but status is still connected.
2936 * A USB 3.0 connection may bounce if multiple warm resets were issued,
2937 * but the device may have successfully re-connected. Ignore it.
2939 if (!hub_is_superspeed(hub->hdev) &&
2940 (portchange & USB_PORT_STAT_C_CONNECTION)) {
2941 usb_clear_port_feature(hub->hdev, port1,
2942 USB_PORT_FEAT_C_CONNECTION);
2946 if (!(portstatus & USB_PORT_STAT_ENABLE))
2952 if (hub_is_superspeedplus(hub->hdev)) {
2953 /* extended portstatus Rx and Tx lane count are zero based */
2954 udev->rx_lanes = USB_EXT_PORT_RX_LANES(ext_portstatus) + 1;
2955 udev->tx_lanes = USB_EXT_PORT_TX_LANES(ext_portstatus) + 1;
2956 udev->ssp_rate = get_port_ssp_rate(hub->hdev, ext_portstatus);
2960 udev->ssp_rate = USB_SSP_GEN_UNKNOWN;
2962 if (udev->ssp_rate != USB_SSP_GEN_UNKNOWN)
2963 udev->speed = USB_SPEED_SUPER_PLUS;
2964 else if (hub_is_superspeed(hub->hdev))
2965 udev->speed = USB_SPEED_SUPER;
2966 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2967 udev->speed = USB_SPEED_HIGH;
2968 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2969 udev->speed = USB_SPEED_LOW;
2971 udev->speed = USB_SPEED_FULL;
2975 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2976 static int hub_port_reset(struct usb_hub *hub, int port1,
2977 struct usb_device *udev, unsigned int delay, bool warm)
2980 u16 portchange, portstatus;
2981 struct usb_port *port_dev = hub->ports[port1 - 1];
2982 int reset_recovery_time;
2984 if (!hub_is_superspeed(hub->hdev)) {
2986 dev_err(hub->intfdev, "only USB3 hub support "
2990 /* Block EHCI CF initialization during the port reset.
2991 * Some companion controllers don't like it when they mix.
2993 down_read(&ehci_cf_port_reset_rwsem);
2996 * If the caller hasn't explicitly requested a warm reset,
2997 * double check and see if one is needed.
2999 if (usb_hub_port_status(hub, port1, &portstatus,
3001 if (hub_port_warm_reset_required(hub, port1,
3005 clear_bit(port1, hub->warm_reset_bits);
3007 /* Reset the port */
3008 for (i = 0; i < PORT_RESET_TRIES; i++) {
3009 status = set_port_feature(hub->hdev, port1, (warm ?
3010 USB_PORT_FEAT_BH_PORT_RESET :
3011 USB_PORT_FEAT_RESET));
3012 if (status == -ENODEV) {
3013 ; /* The hub is gone */
3014 } else if (status) {
3015 dev_err(&port_dev->dev,
3016 "cannot %sreset (err = %d)\n",
3017 warm ? "warm " : "", status);
3019 status = hub_port_wait_reset(hub, port1, udev, delay,
3021 if (status && status != -ENOTCONN && status != -ENODEV)
3022 dev_dbg(hub->intfdev,
3023 "port_wait_reset: err = %d\n",
3028 * Check for disconnect or reset, and bail out after several
3029 * reset attempts to avoid warm reset loop.
3031 if (status == 0 || status == -ENOTCONN || status == -ENODEV ||
3032 (status == -EBUSY && i == PORT_RESET_TRIES - 1)) {
3033 usb_clear_port_feature(hub->hdev, port1,
3034 USB_PORT_FEAT_C_RESET);
3036 if (!hub_is_superspeed(hub->hdev))
3039 usb_clear_port_feature(hub->hdev, port1,
3040 USB_PORT_FEAT_C_BH_PORT_RESET);
3041 usb_clear_port_feature(hub->hdev, port1,
3042 USB_PORT_FEAT_C_PORT_LINK_STATE);
3045 usb_clear_port_feature(hub->hdev, port1,
3046 USB_PORT_FEAT_C_CONNECTION);
3049 * If a USB 3.0 device migrates from reset to an error
3050 * state, re-issue the warm reset.
3052 if (usb_hub_port_status(hub, port1,
3053 &portstatus, &portchange) < 0)
3056 if (!hub_port_warm_reset_required(hub, port1,
3061 * If the port is in SS.Inactive or Compliance Mode, the
3062 * hot or warm reset failed. Try another warm reset.
3065 dev_dbg(&port_dev->dev,
3066 "hot reset failed, warm reset\n");
3071 dev_dbg(&port_dev->dev,
3072 "not enabled, trying %sreset again...\n",
3073 warm ? "warm " : "");
3074 delay = HUB_LONG_RESET_TIME;
3077 dev_err(&port_dev->dev, "Cannot enable. Maybe the USB cable is bad?\n");
3081 if (port_dev->quirks & USB_PORT_QUIRK_FAST_ENUM)
3082 usleep_range(10000, 12000);
3084 /* TRSTRCY = 10 ms; plus some extra */
3085 reset_recovery_time = 10 + 40;
3087 /* Hub needs extra delay after resetting its port. */
3088 if (hub->hdev->quirks & USB_QUIRK_HUB_SLOW_RESET)
3089 reset_recovery_time += 100;
3091 msleep(reset_recovery_time);
3095 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3097 update_devnum(udev, 0);
3098 /* The xHC may think the device is already reset,
3099 * so ignore the status.
3101 if (hcd->driver->reset_device)
3102 hcd->driver->reset_device(hcd, udev);
3104 usb_set_device_state(udev, USB_STATE_DEFAULT);
3108 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
3111 if (!hub_is_superspeed(hub->hdev))
3112 up_read(&ehci_cf_port_reset_rwsem);
3118 * hub_port_stop_enumerate - stop USB enumeration or ignore port events
3120 * @port1: port num of the port
3121 * @retries: port retries number of hub_port_init()
3124 * true: ignore port actions/events or give up connection attempts.
3125 * false: keep original behavior.
3127 * This function will be based on retries to check whether the port which is
3128 * marked with early_stop attribute would stop enumeration or ignore events.
3131 * This function didn't change anything if early_stop is not set, and it will
3132 * prevent all connection attempts when early_stop is set and the attempts of
3133 * the port are more than 1.
3135 static bool hub_port_stop_enumerate(struct usb_hub *hub, int port1, int retries)
3137 struct usb_port *port_dev = hub->ports[port1 - 1];
3139 if (port_dev->early_stop) {
3140 if (port_dev->ignore_event)
3144 * We want unsuccessful attempts to fail quickly.
3145 * Since some devices may need one failure during
3146 * port initialization, we allow two tries but no
3152 port_dev->ignore_event = 1;
3154 port_dev->ignore_event = 0;
3156 return port_dev->ignore_event;
3159 /* Check if a port is power on */
3160 int usb_port_is_power_on(struct usb_hub *hub, unsigned int portstatus)
3164 if (hub_is_superspeed(hub->hdev)) {
3165 if (portstatus & USB_SS_PORT_STAT_POWER)
3168 if (portstatus & USB_PORT_STAT_POWER)
3175 static void usb_lock_port(struct usb_port *port_dev)
3176 __acquires(&port_dev->status_lock)
3178 mutex_lock(&port_dev->status_lock);
3179 __acquire(&port_dev->status_lock);
3182 static void usb_unlock_port(struct usb_port *port_dev)
3183 __releases(&port_dev->status_lock)
3185 mutex_unlock(&port_dev->status_lock);
3186 __release(&port_dev->status_lock);
3191 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
3192 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
3196 if (hub_is_superspeed(hub->hdev)) {
3197 if ((portstatus & USB_PORT_STAT_LINK_STATE)
3198 == USB_SS_PORT_LS_U3)
3201 if (portstatus & USB_PORT_STAT_SUSPEND)
3208 /* Determine whether the device on a port is ready for a normal resume,
3209 * is ready for a reset-resume, or should be disconnected.
3211 static int check_port_resume_type(struct usb_device *udev,
3212 struct usb_hub *hub, int port1,
3213 int status, u16 portchange, u16 portstatus)
3215 struct usb_port *port_dev = hub->ports[port1 - 1];
3219 /* Is a warm reset needed to recover the connection? */
3220 if (status == 0 && udev->reset_resume
3221 && hub_port_warm_reset_required(hub, port1, portstatus)) {
3224 /* Is the device still present? */
3225 else if (status || port_is_suspended(hub, portstatus) ||
3226 !usb_port_is_power_on(hub, portstatus)) {
3229 } else if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
3231 usleep_range(200, 300);
3232 status = usb_hub_port_status(hub, port1, &portstatus,
3239 /* Can't do a normal resume if the port isn't enabled,
3240 * so try a reset-resume instead.
3242 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
3243 if (udev->persist_enabled)
3244 udev->reset_resume = 1;
3250 dev_dbg(&port_dev->dev, "status %04x.%04x after resume, %d\n",
3251 portchange, portstatus, status);
3252 } else if (udev->reset_resume) {
3254 /* Late port handoff can set status-change bits */
3255 if (portchange & USB_PORT_STAT_C_CONNECTION)
3256 usb_clear_port_feature(hub->hdev, port1,
3257 USB_PORT_FEAT_C_CONNECTION);
3258 if (portchange & USB_PORT_STAT_C_ENABLE)
3259 usb_clear_port_feature(hub->hdev, port1,
3260 USB_PORT_FEAT_C_ENABLE);
3263 * Whatever made this reset-resume necessary may have
3264 * turned on the port1 bit in hub->change_bits. But after
3265 * a successful reset-resume we want the bit to be clear;
3266 * if it was on it would indicate that something happened
3267 * following the reset-resume.
3269 clear_bit(port1, hub->change_bits);
3275 int usb_disable_ltm(struct usb_device *udev)
3277 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3279 /* Check if the roothub and device supports LTM. */
3280 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
3281 !usb_device_supports_ltm(udev))
3284 /* Clear Feature LTM Enable can only be sent if the device is
3287 if (!udev->actconfig)
3290 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3291 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
3292 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
3293 USB_CTRL_SET_TIMEOUT);
3295 EXPORT_SYMBOL_GPL(usb_disable_ltm);
3297 void usb_enable_ltm(struct usb_device *udev)
3299 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3301 /* Check if the roothub and device supports LTM. */
3302 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
3303 !usb_device_supports_ltm(udev))
3306 /* Set Feature LTM Enable can only be sent if the device is
3309 if (!udev->actconfig)
3312 usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3313 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
3314 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
3315 USB_CTRL_SET_TIMEOUT);
3317 EXPORT_SYMBOL_GPL(usb_enable_ltm);
3320 * usb_enable_remote_wakeup - enable remote wakeup for a device
3321 * @udev: target device
3323 * For USB-2 devices: Set the device's remote wakeup feature.
3325 * For USB-3 devices: Assume there's only one function on the device and
3326 * enable remote wake for the first interface. FIXME if the interface
3327 * association descriptor shows there's more than one function.
3329 static int usb_enable_remote_wakeup(struct usb_device *udev)
3331 if (udev->speed < USB_SPEED_SUPER)
3332 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3333 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
3334 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
3335 USB_CTRL_SET_TIMEOUT);
3337 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3338 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
3339 USB_INTRF_FUNC_SUSPEND,
3340 USB_INTRF_FUNC_SUSPEND_RW |
3341 USB_INTRF_FUNC_SUSPEND_LP,
3342 NULL, 0, USB_CTRL_SET_TIMEOUT);
3346 * usb_disable_remote_wakeup - disable remote wakeup for a device
3347 * @udev: target device
3349 * For USB-2 devices: Clear the device's remote wakeup feature.
3351 * For USB-3 devices: Assume there's only one function on the device and
3352 * disable remote wake for the first interface. FIXME if the interface
3353 * association descriptor shows there's more than one function.
3355 static int usb_disable_remote_wakeup(struct usb_device *udev)
3357 if (udev->speed < USB_SPEED_SUPER)
3358 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3359 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
3360 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
3361 USB_CTRL_SET_TIMEOUT);
3363 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3364 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
3365 USB_INTRF_FUNC_SUSPEND, 0, NULL, 0,
3366 USB_CTRL_SET_TIMEOUT);
3369 /* Count of wakeup-enabled devices at or below udev */
3370 unsigned usb_wakeup_enabled_descendants(struct usb_device *udev)
3372 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
3374 return udev->do_remote_wakeup +
3375 (hub ? hub->wakeup_enabled_descendants : 0);
3377 EXPORT_SYMBOL_GPL(usb_wakeup_enabled_descendants);
3380 * usb_port_suspend - suspend a usb device's upstream port
3381 * @udev: device that's no longer in active use, not a root hub
3382 * Context: must be able to sleep; device not locked; pm locks held
3384 * Suspends a USB device that isn't in active use, conserving power.
3385 * Devices may wake out of a suspend, if anything important happens,
3386 * using the remote wakeup mechanism. They may also be taken out of
3387 * suspend by the host, using usb_port_resume(). It's also routine
3388 * to disconnect devices while they are suspended.
3390 * This only affects the USB hardware for a device; its interfaces
3391 * (and, for hubs, child devices) must already have been suspended.
3393 * Selective port suspend reduces power; most suspended devices draw
3394 * less than 500 uA. It's also used in OTG, along with remote wakeup.
3395 * All devices below the suspended port are also suspended.
3397 * Devices leave suspend state when the host wakes them up. Some devices
3398 * also support "remote wakeup", where the device can activate the USB
3399 * tree above them to deliver data, such as a keypress or packet. In
3400 * some cases, this wakes the USB host.
3402 * Suspending OTG devices may trigger HNP, if that's been enabled
3403 * between a pair of dual-role devices. That will change roles, such
3404 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
3406 * Devices on USB hub ports have only one "suspend" state, corresponding
3407 * to ACPI D2, "may cause the device to lose some context".
3408 * State transitions include:
3410 * - suspend, resume ... when the VBUS power link stays live
3411 * - suspend, disconnect ... VBUS lost
3413 * Once VBUS drop breaks the circuit, the port it's using has to go through
3414 * normal re-enumeration procedures, starting with enabling VBUS power.
3415 * Other than re-initializing the hub (plug/unplug, except for root hubs),
3416 * Linux (2.6) currently has NO mechanisms to initiate that: no hub_wq
3417 * timer, no SRP, no requests through sysfs.
3419 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
3420 * suspended until their bus goes into global suspend (i.e., the root
3421 * hub is suspended). Nevertheless, we change @udev->state to
3422 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
3423 * upstream port setting is stored in @udev->port_is_suspended.
3425 * Returns 0 on success, else negative errno.
3427 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
3429 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3430 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3431 int port1 = udev->portnum;
3433 bool really_suspend = true;
3435 usb_lock_port(port_dev);
3437 /* enable remote wakeup when appropriate; this lets the device
3438 * wake up the upstream hub (including maybe the root hub).
3440 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
3441 * we don't explicitly enable it here.
3443 if (udev->do_remote_wakeup) {
3444 status = usb_enable_remote_wakeup(udev);
3446 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
3448 /* bail if autosuspend is requested */
3449 if (PMSG_IS_AUTO(msg))
3454 /* disable USB2 hardware LPM */
3455 usb_disable_usb2_hardware_lpm(udev);
3457 if (usb_disable_ltm(udev)) {
3458 dev_err(&udev->dev, "Failed to disable LTM before suspend\n");
3460 if (PMSG_IS_AUTO(msg))
3465 if (hub_is_superspeed(hub->hdev))
3466 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U3);
3469 * For system suspend, we do not need to enable the suspend feature
3470 * on individual USB-2 ports. The devices will automatically go
3471 * into suspend a few ms after the root hub stops sending packets.
3472 * The USB 2.0 spec calls this "global suspend".
3474 * However, many USB hubs have a bug: They don't relay wakeup requests
3475 * from a downstream port if the port's suspend feature isn't on.
3476 * Therefore we will turn on the suspend feature if udev or any of its
3477 * descendants is enabled for remote wakeup.
3479 else if (PMSG_IS_AUTO(msg) || usb_wakeup_enabled_descendants(udev) > 0)
3480 status = set_port_feature(hub->hdev, port1,
3481 USB_PORT_FEAT_SUSPEND);
3483 really_suspend = false;
3487 /* Check if the port has been suspended for the timeout case
3488 * to prevent the suspended port from incorrect handling.
3490 if (status == -ETIMEDOUT) {
3492 u16 portstatus, portchange;
3494 portstatus = portchange = 0;
3495 ret = usb_hub_port_status(hub, port1, &portstatus,
3498 dev_dbg(&port_dev->dev,
3499 "suspend timeout, status %04x\n", portstatus);
3501 if (ret == 0 && port_is_suspended(hub, portstatus)) {
3507 dev_dbg(&port_dev->dev, "can't suspend, status %d\n", status);
3509 /* Try to enable USB3 LTM again */
3510 usb_enable_ltm(udev);
3512 /* Try to enable USB2 hardware LPM again */
3513 usb_enable_usb2_hardware_lpm(udev);
3515 if (udev->do_remote_wakeup)
3516 (void) usb_disable_remote_wakeup(udev);
3519 /* System sleep transitions should never fail */
3520 if (!PMSG_IS_AUTO(msg))
3524 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
3525 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
3526 udev->do_remote_wakeup);
3527 if (really_suspend) {
3528 udev->port_is_suspended = 1;
3530 /* device has up to 10 msec to fully suspend */
3533 usb_set_device_state(udev, USB_STATE_SUSPENDED);
3536 if (status == 0 && !udev->do_remote_wakeup && udev->persist_enabled
3537 && test_and_clear_bit(port1, hub->child_usage_bits))
3538 pm_runtime_put_sync(&port_dev->dev);
3540 usb_mark_last_busy(hub->hdev);
3542 usb_unlock_port(port_dev);
3547 * If the USB "suspend" state is in use (rather than "global suspend"),
3548 * many devices will be individually taken out of suspend state using
3549 * special "resume" signaling. This routine kicks in shortly after
3550 * hardware resume signaling is finished, either because of selective
3551 * resume (by host) or remote wakeup (by device) ... now see what changed
3552 * in the tree that's rooted at this device.
3554 * If @udev->reset_resume is set then the device is reset before the
3555 * status check is done.
3557 static int finish_port_resume(struct usb_device *udev)
3562 /* caller owns the udev device lock */
3563 dev_dbg(&udev->dev, "%s\n",
3564 udev->reset_resume ? "finish reset-resume" : "finish resume");
3566 /* usb ch9 identifies four variants of SUSPENDED, based on what
3567 * state the device resumes to. Linux currently won't see the
3568 * first two on the host side; they'd be inside hub_port_init()
3569 * during many timeouts, but hub_wq can't suspend until later.
3571 usb_set_device_state(udev, udev->actconfig
3572 ? USB_STATE_CONFIGURED
3573 : USB_STATE_ADDRESS);
3575 /* 10.5.4.5 says not to reset a suspended port if the attached
3576 * device is enabled for remote wakeup. Hence the reset
3577 * operation is carried out here, after the port has been
3580 if (udev->reset_resume) {
3582 * If the device morphs or switches modes when it is reset,
3583 * we don't want to perform a reset-resume. We'll fail the
3584 * resume, which will cause a logical disconnect, and then
3585 * the device will be rediscovered.
3588 if (udev->quirks & USB_QUIRK_RESET)
3591 status = usb_reset_and_verify_device(udev);
3594 /* 10.5.4.5 says be sure devices in the tree are still there.
3595 * For now let's assume the device didn't go crazy on resume,
3596 * and device drivers will know about any resume quirks.
3600 status = usb_get_std_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
3602 /* If a normal resume failed, try doing a reset-resume */
3603 if (status && !udev->reset_resume && udev->persist_enabled) {
3604 dev_dbg(&udev->dev, "retry with reset-resume\n");
3605 udev->reset_resume = 1;
3606 goto retry_reset_resume;
3611 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
3614 * There are a few quirky devices which violate the standard
3615 * by claiming to have remote wakeup enabled after a reset,
3616 * which crash if the feature is cleared, hence check for
3617 * udev->reset_resume
3619 } else if (udev->actconfig && !udev->reset_resume) {
3620 if (udev->speed < USB_SPEED_SUPER) {
3621 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
3622 status = usb_disable_remote_wakeup(udev);
3624 status = usb_get_std_status(udev, USB_RECIP_INTERFACE, 0,
3626 if (!status && devstatus & (USB_INTRF_STAT_FUNC_RW_CAP
3627 | USB_INTRF_STAT_FUNC_RW))
3628 status = usb_disable_remote_wakeup(udev);
3633 "disable remote wakeup, status %d\n",
3641 * There are some SS USB devices which take longer time for link training.
3642 * XHCI specs 4.19.4 says that when Link training is successful, port
3643 * sets CCS bit to 1. So if SW reads port status before successful link
3644 * training, then it will not find device to be present.
3645 * USB Analyzer log with such buggy devices show that in some cases
3646 * device switch on the RX termination after long delay of host enabling
3647 * the VBUS. In few other cases it has been seen that device fails to
3648 * negotiate link training in first attempt. It has been
3649 * reported till now that few devices take as long as 2000 ms to train
3650 * the link after host enabling its VBUS and termination. Following
3651 * routine implements a 2000 ms timeout for link training. If in a case
3652 * link trains before timeout, loop will exit earlier.
3654 * There are also some 2.0 hard drive based devices and 3.0 thumb
3655 * drives that, when plugged into a 2.0 only port, take a long
3656 * time to set CCS after VBUS enable.
3658 * FIXME: If a device was connected before suspend, but was removed
3659 * while system was asleep, then the loop in the following routine will
3660 * only exit at timeout.
3662 * This routine should only be called when persist is enabled.
3664 static int wait_for_connected(struct usb_device *udev,
3665 struct usb_hub *hub, int port1,
3666 u16 *portchange, u16 *portstatus)
3668 int status = 0, delay_ms = 0;
3670 while (delay_ms < 2000) {
3671 if (status || *portstatus & USB_PORT_STAT_CONNECTION)
3673 if (!usb_port_is_power_on(hub, *portstatus)) {
3679 status = usb_hub_port_status(hub, port1, portstatus, portchange);
3681 dev_dbg(&udev->dev, "Waited %dms for CONNECT\n", delay_ms);
3686 * usb_port_resume - re-activate a suspended usb device's upstream port
3687 * @udev: device to re-activate, not a root hub
3688 * Context: must be able to sleep; device not locked; pm locks held
3690 * This will re-activate the suspended device, increasing power usage
3691 * while letting drivers communicate again with its endpoints.
3692 * USB resume explicitly guarantees that the power session between
3693 * the host and the device is the same as it was when the device
3696 * If @udev->reset_resume is set then this routine won't check that the
3697 * port is still enabled. Furthermore, finish_port_resume() above will
3698 * reset @udev. The end result is that a broken power session can be
3699 * recovered and @udev will appear to persist across a loss of VBUS power.
3701 * For example, if a host controller doesn't maintain VBUS suspend current
3702 * during a system sleep or is reset when the system wakes up, all the USB
3703 * power sessions below it will be broken. This is especially troublesome
3704 * for mass-storage devices containing mounted filesystems, since the
3705 * device will appear to have disconnected and all the memory mappings
3706 * to it will be lost. Using the USB_PERSIST facility, the device can be
3707 * made to appear as if it had not disconnected.
3709 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3710 * every effort to insure that the same device is present after the
3711 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3712 * quite possible for a device to remain unaltered but its media to be
3713 * changed. If the user replaces a flash memory card while the system is
3714 * asleep, he will have only himself to blame when the filesystem on the
3715 * new card is corrupted and the system crashes.
3717 * Returns 0 on success, else negative errno.
3719 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
3721 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3722 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3723 int port1 = udev->portnum;
3725 u16 portchange, portstatus;
3727 if (!test_and_set_bit(port1, hub->child_usage_bits)) {
3728 status = pm_runtime_resume_and_get(&port_dev->dev);
3730 dev_dbg(&udev->dev, "can't resume usb port, status %d\n",
3736 usb_lock_port(port_dev);
3738 /* Skip the initial Clear-Suspend step for a remote wakeup */
3739 status = usb_hub_port_status(hub, port1, &portstatus, &portchange);
3740 if (status == 0 && !port_is_suspended(hub, portstatus)) {
3741 if (portchange & USB_PORT_STAT_C_SUSPEND)
3742 pm_wakeup_event(&udev->dev, 0);
3743 goto SuspendCleared;
3746 /* see 7.1.7.7; affects power usage, but not budgeting */
3747 if (hub_is_superspeed(hub->hdev))
3748 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U0);
3750 status = usb_clear_port_feature(hub->hdev,
3751 port1, USB_PORT_FEAT_SUSPEND);
3753 dev_dbg(&port_dev->dev, "can't resume, status %d\n", status);
3755 /* drive resume for USB_RESUME_TIMEOUT msec */
3756 dev_dbg(&udev->dev, "usb %sresume\n",
3757 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
3758 msleep(USB_RESUME_TIMEOUT);
3760 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3761 * stop resume signaling. Then finish the resume
3764 status = usb_hub_port_status(hub, port1, &portstatus, &portchange);
3769 udev->port_is_suspended = 0;
3770 if (hub_is_superspeed(hub->hdev)) {
3771 if (portchange & USB_PORT_STAT_C_LINK_STATE)
3772 usb_clear_port_feature(hub->hdev, port1,
3773 USB_PORT_FEAT_C_PORT_LINK_STATE);
3775 if (portchange & USB_PORT_STAT_C_SUSPEND)
3776 usb_clear_port_feature(hub->hdev, port1,
3777 USB_PORT_FEAT_C_SUSPEND);
3780 /* TRSMRCY = 10 msec */
3784 if (udev->persist_enabled)
3785 status = wait_for_connected(udev, hub, port1, &portchange,
3788 status = check_port_resume_type(udev,
3789 hub, port1, status, portchange, portstatus);
3791 status = finish_port_resume(udev);
3793 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
3794 hub_port_logical_disconnect(hub, port1);
3796 /* Try to enable USB2 hardware LPM */
3797 usb_enable_usb2_hardware_lpm(udev);
3799 /* Try to enable USB3 LTM */
3800 usb_enable_ltm(udev);
3803 usb_unlock_port(port_dev);
3808 int usb_remote_wakeup(struct usb_device *udev)
3812 usb_lock_device(udev);
3813 if (udev->state == USB_STATE_SUSPENDED) {
3814 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
3815 status = usb_autoresume_device(udev);
3817 /* Let the drivers do their thing, then... */
3818 usb_autosuspend_device(udev);
3821 usb_unlock_device(udev);
3825 /* Returns 1 if there was a remote wakeup and a connect status change. */
3826 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
3827 u16 portstatus, u16 portchange)
3828 __must_hold(&port_dev->status_lock)
3830 struct usb_port *port_dev = hub->ports[port - 1];
3831 struct usb_device *hdev;
3832 struct usb_device *udev;
3833 int connect_change = 0;
3838 udev = port_dev->child;
3839 if (!hub_is_superspeed(hdev)) {
3840 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
3842 usb_clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
3844 link_state = portstatus & USB_PORT_STAT_LINK_STATE;
3845 if (!udev || udev->state != USB_STATE_SUSPENDED ||
3846 (link_state != USB_SS_PORT_LS_U0 &&
3847 link_state != USB_SS_PORT_LS_U1 &&
3848 link_state != USB_SS_PORT_LS_U2))
3853 /* TRSMRCY = 10 msec */
3856 usb_unlock_port(port_dev);
3857 ret = usb_remote_wakeup(udev);
3858 usb_lock_port(port_dev);
3863 hub_port_disable(hub, port, 1);
3865 dev_dbg(&port_dev->dev, "resume, status %d\n", ret);
3866 return connect_change;
3869 static int check_ports_changed(struct usb_hub *hub)
3873 for (port1 = 1; port1 <= hub->hdev->maxchild; ++port1) {
3874 u16 portstatus, portchange;
3877 status = usb_hub_port_status(hub, port1, &portstatus, &portchange);
3878 if (!status && portchange)
3884 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
3886 struct usb_hub *hub = usb_get_intfdata(intf);
3887 struct usb_device *hdev = hub->hdev;
3891 * Warn if children aren't already suspended.
3892 * Also, add up the number of wakeup-enabled descendants.
3894 hub->wakeup_enabled_descendants = 0;
3895 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3896 struct usb_port *port_dev = hub->ports[port1 - 1];
3897 struct usb_device *udev = port_dev->child;
3899 if (udev && udev->can_submit) {
3900 dev_warn(&port_dev->dev, "device %s not suspended yet\n",
3901 dev_name(&udev->dev));
3902 if (PMSG_IS_AUTO(msg))
3906 hub->wakeup_enabled_descendants +=
3907 usb_wakeup_enabled_descendants(udev);
3910 if (hdev->do_remote_wakeup && hub->quirk_check_port_auto_suspend) {
3911 /* check if there are changes pending on hub ports */
3912 if (check_ports_changed(hub)) {
3913 if (PMSG_IS_AUTO(msg))
3915 pm_wakeup_event(&hdev->dev, 2000);
3919 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
3920 /* Enable hub to send remote wakeup for all ports. */
3921 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3922 set_port_feature(hdev,
3924 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
3925 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
3926 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
3927 USB_PORT_FEAT_REMOTE_WAKE_MASK);
3931 dev_dbg(&intf->dev, "%s\n", __func__);
3933 /* stop hub_wq and related activity */
3934 hub_quiesce(hub, HUB_SUSPEND);
3938 /* Report wakeup requests from the ports of a resuming root hub */
3939 static void report_wakeup_requests(struct usb_hub *hub)
3941 struct usb_device *hdev = hub->hdev;
3942 struct usb_device *udev;
3943 struct usb_hcd *hcd;
3944 unsigned long resuming_ports;
3948 return; /* Not a root hub */
3950 hcd = bus_to_hcd(hdev->bus);
3951 if (hcd->driver->get_resuming_ports) {
3954 * The get_resuming_ports() method returns a bitmap (origin 0)
3955 * of ports which have started wakeup signaling but have not
3956 * yet finished resuming. During system resume we will
3957 * resume all the enabled ports, regardless of any wakeup
3958 * signals, which means the wakeup requests would be lost.
3959 * To prevent this, report them to the PM core here.
3961 resuming_ports = hcd->driver->get_resuming_ports(hcd);
3962 for (i = 0; i < hdev->maxchild; ++i) {
3963 if (test_bit(i, &resuming_ports)) {
3964 udev = hub->ports[i]->child;
3966 pm_wakeup_event(&udev->dev, 0);
3972 static int hub_resume(struct usb_interface *intf)
3974 struct usb_hub *hub = usb_get_intfdata(intf);
3976 dev_dbg(&intf->dev, "%s\n", __func__);
3977 hub_activate(hub, HUB_RESUME);
3980 * This should be called only for system resume, not runtime resume.
3981 * We can't tell the difference here, so some wakeup requests will be
3982 * reported at the wrong time or more than once. This shouldn't
3983 * matter much, so long as they do get reported.
3985 report_wakeup_requests(hub);
3989 static int hub_reset_resume(struct usb_interface *intf)
3991 struct usb_hub *hub = usb_get_intfdata(intf);
3993 dev_dbg(&intf->dev, "%s\n", __func__);
3994 hub_activate(hub, HUB_RESET_RESUME);
3999 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
4000 * @rhdev: struct usb_device for the root hub
4002 * The USB host controller driver calls this function when its root hub
4003 * is resumed and Vbus power has been interrupted or the controller
4004 * has been reset. The routine marks @rhdev as having lost power.
4005 * When the hub driver is resumed it will take notice and carry out
4006 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
4007 * the others will be disconnected.
4009 void usb_root_hub_lost_power(struct usb_device *rhdev)
4011 dev_notice(&rhdev->dev, "root hub lost power or was reset\n");
4012 rhdev->reset_resume = 1;
4014 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
4016 static const char * const usb3_lpm_names[] = {
4024 * Send a Set SEL control transfer to the device, prior to enabling
4025 * device-initiated U1 or U2. This lets the device know the exit latencies from
4026 * the time the device initiates a U1 or U2 exit, to the time it will receive a
4027 * packet from the host.
4029 * This function will fail if the SEL or PEL values for udev are greater than
4030 * the maximum allowed values for the link state to be enabled.
4032 static int usb_req_set_sel(struct usb_device *udev)
4034 struct usb_set_sel_req *sel_values;
4035 unsigned long long u1_sel;
4036 unsigned long long u1_pel;
4037 unsigned long long u2_sel;
4038 unsigned long long u2_pel;
4041 if (!udev->parent || udev->speed < USB_SPEED_SUPER || !udev->lpm_capable)
4044 /* Convert SEL and PEL stored in ns to us */
4045 u1_sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
4046 u1_pel = DIV_ROUND_UP(udev->u1_params.pel, 1000);
4047 u2_sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
4048 u2_pel = DIV_ROUND_UP(udev->u2_params.pel, 1000);
4051 * Make sure that the calculated SEL and PEL values for the link
4052 * state we're enabling aren't bigger than the max SEL/PEL
4053 * value that will fit in the SET SEL control transfer.
4054 * Otherwise the device would get an incorrect idea of the exit
4055 * latency for the link state, and could start a device-initiated
4056 * U1/U2 when the exit latencies are too high.
4058 if (u1_sel > USB3_LPM_MAX_U1_SEL_PEL ||
4059 u1_pel > USB3_LPM_MAX_U1_SEL_PEL ||
4060 u2_sel > USB3_LPM_MAX_U2_SEL_PEL ||
4061 u2_pel > USB3_LPM_MAX_U2_SEL_PEL) {
4062 dev_dbg(&udev->dev, "Device-initiated U1/U2 disabled due to long SEL or PEL\n");
4067 * usb_enable_lpm() can be called as part of a failed device reset,
4068 * which may be initiated by an error path of a mass storage driver.
4069 * Therefore, use GFP_NOIO.
4071 sel_values = kmalloc(sizeof *(sel_values), GFP_NOIO);
4075 sel_values->u1_sel = u1_sel;
4076 sel_values->u1_pel = u1_pel;
4077 sel_values->u2_sel = cpu_to_le16(u2_sel);
4078 sel_values->u2_pel = cpu_to_le16(u2_pel);
4080 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
4084 sel_values, sizeof *(sel_values),
4085 USB_CTRL_SET_TIMEOUT);
4089 udev->lpm_devinit_allow = 1;
4095 * Enable or disable device-initiated U1 or U2 transitions.
4097 static int usb_set_device_initiated_lpm(struct usb_device *udev,
4098 enum usb3_link_state state, bool enable)
4105 feature = USB_DEVICE_U1_ENABLE;
4108 feature = USB_DEVICE_U2_ENABLE;
4111 dev_warn(&udev->dev, "%s: Can't %s non-U1 or U2 state.\n",
4112 __func__, enable ? "enable" : "disable");
4116 if (udev->state != USB_STATE_CONFIGURED) {
4117 dev_dbg(&udev->dev, "%s: Can't %s %s state "
4118 "for unconfigured device.\n",
4119 __func__, enable ? "enable" : "disable",
4120 usb3_lpm_names[state]);
4126 * Now send the control transfer to enable device-initiated LPM
4127 * for either U1 or U2.
4129 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
4130 USB_REQ_SET_FEATURE,
4134 USB_CTRL_SET_TIMEOUT);
4136 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
4137 USB_REQ_CLEAR_FEATURE,
4141 USB_CTRL_SET_TIMEOUT);
4144 dev_warn(&udev->dev, "%s of device-initiated %s failed.\n",
4145 enable ? "Enable" : "Disable",
4146 usb3_lpm_names[state]);
4152 static int usb_set_lpm_timeout(struct usb_device *udev,
4153 enum usb3_link_state state, int timeout)
4160 feature = USB_PORT_FEAT_U1_TIMEOUT;
4163 feature = USB_PORT_FEAT_U2_TIMEOUT;
4166 dev_warn(&udev->dev, "%s: Can't set timeout for non-U1 or U2 state.\n",
4171 if (state == USB3_LPM_U1 && timeout > USB3_LPM_U1_MAX_TIMEOUT &&
4172 timeout != USB3_LPM_DEVICE_INITIATED) {
4173 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x, "
4174 "which is a reserved value.\n",
4175 usb3_lpm_names[state], timeout);
4179 ret = set_port_feature(udev->parent,
4180 USB_PORT_LPM_TIMEOUT(timeout) | udev->portnum,
4183 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x,"
4184 "error code %i\n", usb3_lpm_names[state],
4188 if (state == USB3_LPM_U1)
4189 udev->u1_params.timeout = timeout;
4191 udev->u2_params.timeout = timeout;
4196 * Don't allow device intiated U1/U2 if the system exit latency + one bus
4197 * interval is greater than the minimum service interval of any active
4198 * periodic endpoint. See USB 3.2 section 9.4.9
4200 static bool usb_device_may_initiate_lpm(struct usb_device *udev,
4201 enum usb3_link_state state)
4203 unsigned int sel; /* us */
4206 if (!udev->lpm_devinit_allow)
4209 if (state == USB3_LPM_U1)
4210 sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
4211 else if (state == USB3_LPM_U2)
4212 sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
4216 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
4217 struct usb_interface *intf;
4218 struct usb_endpoint_descriptor *desc;
4219 unsigned int interval;
4221 intf = udev->actconfig->interface[i];
4225 for (j = 0; j < intf->cur_altsetting->desc.bNumEndpoints; j++) {
4226 desc = &intf->cur_altsetting->endpoint[j].desc;
4228 if (usb_endpoint_xfer_int(desc) ||
4229 usb_endpoint_xfer_isoc(desc)) {
4230 interval = (1 << (desc->bInterval - 1)) * 125;
4231 if (sel + 125 > interval)
4240 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
4243 * We will attempt to enable U1 or U2, but there are no guarantees that the
4244 * control transfers to set the hub timeout or enable device-initiated U1/U2
4245 * will be successful.
4247 * If the control transfer to enable device-initiated U1/U2 entry fails, then
4248 * hub-initiated U1/U2 will be disabled.
4250 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
4251 * driver know about it. If that call fails, it should be harmless, and just
4252 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
4254 static void usb_enable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
4255 enum usb3_link_state state)
4261 /* Skip if the device BOS descriptor couldn't be read */
4265 u1_mel = udev->bos->ss_cap->bU1devExitLat;
4266 u2_mel = udev->bos->ss_cap->bU2DevExitLat;
4268 /* If the device says it doesn't have *any* exit latency to come out of
4269 * U1 or U2, it's probably lying. Assume it doesn't implement that link
4272 if ((state == USB3_LPM_U1 && u1_mel == 0) ||
4273 (state == USB3_LPM_U2 && u2_mel == 0))
4276 /* We allow the host controller to set the U1/U2 timeout internally
4277 * first, so that it can change its schedule to account for the
4278 * additional latency to send data to a device in a lower power
4281 timeout = hcd->driver->enable_usb3_lpm_timeout(hcd, udev, state);
4283 /* xHCI host controller doesn't want to enable this LPM state. */
4288 dev_warn(&udev->dev, "Could not enable %s link state, "
4289 "xHCI error %i.\n", usb3_lpm_names[state],
4294 if (usb_set_lpm_timeout(udev, state, timeout)) {
4295 /* If we can't set the parent hub U1/U2 timeout,
4296 * device-initiated LPM won't be allowed either, so let the xHCI
4297 * host know that this link state won't be enabled.
4299 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
4303 /* Only a configured device will accept the Set Feature
4306 if (udev->actconfig &&
4307 usb_device_may_initiate_lpm(udev, state)) {
4308 if (usb_set_device_initiated_lpm(udev, state, true)) {
4310 * Request to enable device initiated U1/U2 failed,
4311 * better to turn off lpm in this case.
4313 usb_set_lpm_timeout(udev, state, 0);
4314 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
4319 if (state == USB3_LPM_U1)
4320 udev->usb3_lpm_u1_enabled = 1;
4321 else if (state == USB3_LPM_U2)
4322 udev->usb3_lpm_u2_enabled = 1;
4325 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
4328 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
4329 * If zero is returned, the parent will not allow the link to go into U1/U2.
4331 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
4332 * it won't have an effect on the bus link state because the parent hub will
4333 * still disallow device-initiated U1/U2 entry.
4335 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
4336 * possible. The result will be slightly more bus bandwidth will be taken up
4337 * (to account for U1/U2 exit latency), but it should be harmless.
4339 static int usb_disable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
4340 enum usb3_link_state state)
4347 dev_warn(&udev->dev, "%s: Can't disable non-U1 or U2 state.\n",
4352 if (usb_set_lpm_timeout(udev, state, 0))
4355 usb_set_device_initiated_lpm(udev, state, false);
4357 if (hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state))
4358 dev_warn(&udev->dev, "Could not disable xHCI %s timeout, "
4359 "bus schedule bandwidth may be impacted.\n",
4360 usb3_lpm_names[state]);
4362 /* As soon as usb_set_lpm_timeout(0) return 0, hub initiated LPM
4363 * is disabled. Hub will disallows link to enter U1/U2 as well,
4364 * even device is initiating LPM. Hence LPM is disabled if hub LPM
4365 * timeout set to 0, no matter device-initiated LPM is disabled or
4368 if (state == USB3_LPM_U1)
4369 udev->usb3_lpm_u1_enabled = 0;
4370 else if (state == USB3_LPM_U2)
4371 udev->usb3_lpm_u2_enabled = 0;
4377 * Disable hub-initiated and device-initiated U1 and U2 entry.
4378 * Caller must own the bandwidth_mutex.
4380 * This will call usb_enable_lpm() on failure, which will decrement
4381 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
4383 int usb_disable_lpm(struct usb_device *udev)
4385 struct usb_hcd *hcd;
4387 if (!udev || !udev->parent ||
4388 udev->speed < USB_SPEED_SUPER ||
4389 !udev->lpm_capable ||
4390 udev->state < USB_STATE_CONFIGURED)
4393 hcd = bus_to_hcd(udev->bus);
4394 if (!hcd || !hcd->driver->disable_usb3_lpm_timeout)
4397 udev->lpm_disable_count++;
4398 if ((udev->u1_params.timeout == 0 && udev->u2_params.timeout == 0))
4401 /* If LPM is enabled, attempt to disable it. */
4402 if (usb_disable_link_state(hcd, udev, USB3_LPM_U1))
4404 if (usb_disable_link_state(hcd, udev, USB3_LPM_U2))
4410 usb_enable_lpm(udev);
4413 EXPORT_SYMBOL_GPL(usb_disable_lpm);
4415 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
4416 int usb_unlocked_disable_lpm(struct usb_device *udev)
4418 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4424 mutex_lock(hcd->bandwidth_mutex);
4425 ret = usb_disable_lpm(udev);
4426 mutex_unlock(hcd->bandwidth_mutex);
4430 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
4433 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
4434 * xHCI host policy may prevent U1 or U2 from being enabled.
4436 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
4437 * until the lpm_disable_count drops to zero. Caller must own the
4440 void usb_enable_lpm(struct usb_device *udev)
4442 struct usb_hcd *hcd;
4443 struct usb_hub *hub;
4444 struct usb_port *port_dev;
4446 if (!udev || !udev->parent ||
4447 udev->speed < USB_SPEED_SUPER ||
4448 !udev->lpm_capable ||
4449 udev->state < USB_STATE_CONFIGURED)
4452 udev->lpm_disable_count--;
4453 hcd = bus_to_hcd(udev->bus);
4454 /* Double check that we can both enable and disable LPM.
4455 * Device must be configured to accept set feature U1/U2 timeout.
4457 if (!hcd || !hcd->driver->enable_usb3_lpm_timeout ||
4458 !hcd->driver->disable_usb3_lpm_timeout)
4461 if (udev->lpm_disable_count > 0)
4464 hub = usb_hub_to_struct_hub(udev->parent);
4468 port_dev = hub->ports[udev->portnum - 1];
4470 if (port_dev->usb3_lpm_u1_permit)
4471 usb_enable_link_state(hcd, udev, USB3_LPM_U1);
4473 if (port_dev->usb3_lpm_u2_permit)
4474 usb_enable_link_state(hcd, udev, USB3_LPM_U2);
4476 EXPORT_SYMBOL_GPL(usb_enable_lpm);
4478 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
4479 void usb_unlocked_enable_lpm(struct usb_device *udev)
4481 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4486 mutex_lock(hcd->bandwidth_mutex);
4487 usb_enable_lpm(udev);
4488 mutex_unlock(hcd->bandwidth_mutex);
4490 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
4492 /* usb3 devices use U3 for disabled, make sure remote wakeup is disabled */
4493 static void hub_usb3_port_prepare_disable(struct usb_hub *hub,
4494 struct usb_port *port_dev)
4496 struct usb_device *udev = port_dev->child;
4499 if (udev && udev->port_is_suspended && udev->do_remote_wakeup) {
4500 ret = hub_set_port_link_state(hub, port_dev->portnum,
4503 msleep(USB_RESUME_TIMEOUT);
4504 ret = usb_disable_remote_wakeup(udev);
4507 dev_warn(&udev->dev,
4508 "Port disable: can't disable remote wake\n");
4509 udev->do_remote_wakeup = 0;
4513 #else /* CONFIG_PM */
4515 #define hub_suspend NULL
4516 #define hub_resume NULL
4517 #define hub_reset_resume NULL
4519 static inline void hub_usb3_port_prepare_disable(struct usb_hub *hub,
4520 struct usb_port *port_dev) { }
4522 int usb_disable_lpm(struct usb_device *udev)
4526 EXPORT_SYMBOL_GPL(usb_disable_lpm);
4528 void usb_enable_lpm(struct usb_device *udev) { }
4529 EXPORT_SYMBOL_GPL(usb_enable_lpm);
4531 int usb_unlocked_disable_lpm(struct usb_device *udev)
4535 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
4537 void usb_unlocked_enable_lpm(struct usb_device *udev) { }
4538 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
4540 int usb_disable_ltm(struct usb_device *udev)
4544 EXPORT_SYMBOL_GPL(usb_disable_ltm);
4546 void usb_enable_ltm(struct usb_device *udev) { }
4547 EXPORT_SYMBOL_GPL(usb_enable_ltm);
4549 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
4550 u16 portstatus, u16 portchange)
4555 static int usb_req_set_sel(struct usb_device *udev)
4560 #endif /* CONFIG_PM */
4563 * USB-3 does not have a similar link state as USB-2 that will avoid negotiating
4564 * a connection with a plugged-in cable but will signal the host when the cable
4565 * is unplugged. Disable remote wake and set link state to U3 for USB-3 devices
4567 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
4569 struct usb_port *port_dev = hub->ports[port1 - 1];
4570 struct usb_device *hdev = hub->hdev;
4574 if (hub_is_superspeed(hub->hdev)) {
4575 hub_usb3_port_prepare_disable(hub, port_dev);
4576 ret = hub_set_port_link_state(hub, port_dev->portnum,
4579 ret = usb_clear_port_feature(hdev, port1,
4580 USB_PORT_FEAT_ENABLE);
4583 if (port_dev->child && set_state)
4584 usb_set_device_state(port_dev->child, USB_STATE_NOTATTACHED);
4585 if (ret && ret != -ENODEV)
4586 dev_err(&port_dev->dev, "cannot disable (err = %d)\n", ret);
4591 * usb_port_disable - disable a usb device's upstream port
4592 * @udev: device to disable
4593 * Context: @udev locked, must be able to sleep.
4595 * Disables a USB device that isn't in active use.
4597 int usb_port_disable(struct usb_device *udev)
4599 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
4601 return hub_port_disable(hub, udev->portnum, 0);
4604 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
4606 * Between connect detection and reset signaling there must be a delay
4607 * of 100ms at least for debounce and power-settling. The corresponding
4608 * timer shall restart whenever the downstream port detects a disconnect.
4610 * Apparently there are some bluetooth and irda-dongles and a number of
4611 * low-speed devices for which this debounce period may last over a second.
4612 * Not covered by the spec - but easy to deal with.
4614 * This implementation uses a 1500ms total debounce timeout; if the
4615 * connection isn't stable by then it returns -ETIMEDOUT. It checks
4616 * every 25ms for transient disconnects. When the port status has been
4617 * unchanged for 100ms it returns the port status.
4619 int hub_port_debounce(struct usb_hub *hub, int port1, bool must_be_connected)
4622 u16 portchange, portstatus;
4623 unsigned connection = 0xffff;
4624 int total_time, stable_time = 0;
4625 struct usb_port *port_dev = hub->ports[port1 - 1];
4627 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
4628 ret = usb_hub_port_status(hub, port1, &portstatus, &portchange);
4632 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
4633 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
4634 if (!must_be_connected ||
4635 (connection == USB_PORT_STAT_CONNECTION))
4636 stable_time += HUB_DEBOUNCE_STEP;
4637 if (stable_time >= HUB_DEBOUNCE_STABLE)
4641 connection = portstatus & USB_PORT_STAT_CONNECTION;
4644 if (portchange & USB_PORT_STAT_C_CONNECTION) {
4645 usb_clear_port_feature(hub->hdev, port1,
4646 USB_PORT_FEAT_C_CONNECTION);
4649 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
4651 msleep(HUB_DEBOUNCE_STEP);
4654 dev_dbg(&port_dev->dev, "debounce total %dms stable %dms status 0x%x\n",
4655 total_time, stable_time, portstatus);
4657 if (stable_time < HUB_DEBOUNCE_STABLE)
4662 void usb_ep0_reinit(struct usb_device *udev)
4664 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
4665 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
4666 usb_enable_endpoint(udev, &udev->ep0, true);
4668 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
4670 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
4671 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
4673 static int hub_set_address(struct usb_device *udev, int devnum)
4676 unsigned int timeout_ms = USB_CTRL_SET_TIMEOUT;
4677 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4678 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
4680 if (hub->hdev->quirks & USB_QUIRK_SHORT_SET_ADDRESS_REQ_TIMEOUT)
4681 timeout_ms = USB_SHORT_SET_ADDRESS_REQ_TIMEOUT;
4684 * The host controller will choose the device address,
4685 * instead of the core having chosen it earlier
4687 if (!hcd->driver->address_device && devnum <= 1)
4689 if (udev->state == USB_STATE_ADDRESS)
4691 if (udev->state != USB_STATE_DEFAULT)
4693 if (hcd->driver->address_device)
4694 retval = hcd->driver->address_device(hcd, udev, timeout_ms);
4696 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
4697 USB_REQ_SET_ADDRESS, 0, devnum, 0,
4698 NULL, 0, timeout_ms);
4700 update_devnum(udev, devnum);
4701 /* Device now using proper address. */
4702 usb_set_device_state(udev, USB_STATE_ADDRESS);
4703 usb_ep0_reinit(udev);
4709 * There are reports of USB 3.0 devices that say they support USB 2.0 Link PM
4710 * when they're plugged into a USB 2.0 port, but they don't work when LPM is
4713 * Only enable USB 2.0 Link PM if the port is internal (hardwired), or the
4714 * device says it supports the new USB 2.0 Link PM errata by setting the BESL
4715 * support bit in the BOS descriptor.
4717 static void hub_set_initial_usb2_lpm_policy(struct usb_device *udev)
4719 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
4720 int connect_type = USB_PORT_CONNECT_TYPE_UNKNOWN;
4722 if (!udev->usb2_hw_lpm_capable || !udev->bos)
4726 connect_type = hub->ports[udev->portnum - 1]->connect_type;
4728 if ((udev->bos->ext_cap->bmAttributes & cpu_to_le32(USB_BESL_SUPPORT)) ||
4729 connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
4730 udev->usb2_hw_lpm_allowed = 1;
4731 usb_enable_usb2_hardware_lpm(udev);
4735 static int hub_enable_device(struct usb_device *udev)
4737 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4739 if (!hcd->driver->enable_device)
4741 if (udev->state == USB_STATE_ADDRESS)
4743 if (udev->state != USB_STATE_DEFAULT)
4746 return hcd->driver->enable_device(hcd, udev);
4750 * Get the bMaxPacketSize0 value during initialization by reading the
4751 * device's device descriptor. Since we don't already know this value,
4752 * the transfer is unsafe and it ignores I/O errors, only testing for
4753 * reasonable received values.
4755 * For "old scheme" initialization, size will be 8 so we read just the
4756 * start of the device descriptor, which should work okay regardless of
4757 * the actual bMaxPacketSize0 value. For "new scheme" initialization,
4758 * size will be 64 (and buf will point to a sufficiently large buffer),
4759 * which might not be kosher according to the USB spec but it's what
4760 * Windows does and what many devices expect.
4762 * Returns: bMaxPacketSize0 or a negative error code.
4764 static int get_bMaxPacketSize0(struct usb_device *udev,
4765 struct usb_device_descriptor *buf, int size, bool first_time)
4770 * Retry on all errors; some devices are flakey.
4771 * 255 is for WUSB devices, we actually need to use
4772 * 512 (WUSB1.0[4.8.1]).
4774 for (i = 0; i < GET_MAXPACKET0_TRIES; ++i) {
4775 /* Start with invalid values in case the transfer fails */
4776 buf->bDescriptorType = buf->bMaxPacketSize0 = 0;
4777 rc = usb_control_msg(udev, usb_rcvaddr0pipe(),
4778 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
4779 USB_DT_DEVICE << 8, 0,
4781 initial_descriptor_timeout);
4782 switch (buf->bMaxPacketSize0) {
4783 case 8: case 16: case 32: case 64: case 9:
4784 if (buf->bDescriptorType == USB_DT_DEVICE) {
4785 rc = buf->bMaxPacketSize0;
4796 * Some devices time out if they are powered on
4797 * when already connected. They need a second
4798 * reset, so return early. But only on the first
4799 * attempt, lest we get into a time-out/reset loop.
4801 if (rc > 0 || (rc == -ETIMEDOUT && first_time &&
4802 udev->speed > USB_SPEED_FULL))
4808 #define GET_DESCRIPTOR_BUFSIZE 64
4810 /* Reset device, (re)assign address, get device descriptor.
4811 * Device connection must be stable, no more debouncing needed.
4812 * Returns device in USB_STATE_ADDRESS, except on error.
4814 * If this is called for an already-existing device (as part of
4815 * usb_reset_and_verify_device), the caller must own the device lock and
4816 * the port lock. For a newly detected device that is not accessible
4817 * through any global pointers, it's not necessary to lock the device,
4818 * but it is still necessary to lock the port.
4820 * For a newly detected device, @dev_descr must be NULL. The device
4821 * descriptor retrieved from the device will then be stored in
4822 * @udev->descriptor. For an already existing device, @dev_descr
4823 * must be non-NULL. The device descriptor will be stored there,
4824 * not in @udev->descriptor, because descriptors for registered
4825 * devices are meant to be immutable.
4828 hub_port_init(struct usb_hub *hub, struct usb_device *udev, int port1,
4829 int retry_counter, struct usb_device_descriptor *dev_descr)
4831 struct usb_device *hdev = hub->hdev;
4832 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4833 struct usb_port *port_dev = hub->ports[port1 - 1];
4834 int retries, operations, retval, i;
4835 unsigned delay = HUB_SHORT_RESET_TIME;
4836 enum usb_device_speed oldspeed = udev->speed;
4838 int devnum = udev->devnum;
4839 const char *driver_name;
4841 const bool initial = !dev_descr;
4843 struct usb_device_descriptor *buf, *descr;
4845 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
4849 /* root hub ports have a slightly longer reset period
4850 * (from USB 2.0 spec, section 7.1.7.5)
4852 if (!hdev->parent) {
4853 delay = HUB_ROOT_RESET_TIME;
4854 if (port1 == hdev->bus->otg_port)
4855 hdev->bus->b_hnp_enable = 0;
4858 /* Some low speed devices have problems with the quick delay, so */
4859 /* be a bit pessimistic with those devices. RHbug #23670 */
4860 if (oldspeed == USB_SPEED_LOW)
4861 delay = HUB_LONG_RESET_TIME;
4863 /* Reset the device; full speed may morph to high speed */
4864 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
4865 retval = hub_port_reset(hub, port1, udev, delay, false);
4866 if (retval < 0) /* error or disconnect */
4868 /* success, speed is known */
4872 /* Don't allow speed changes at reset, except usb 3.0 to faster */
4873 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed &&
4874 !(oldspeed == USB_SPEED_SUPER && udev->speed > oldspeed)) {
4875 dev_dbg(&udev->dev, "device reset changed speed!\n");
4878 oldspeed = udev->speed;
4881 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4882 * it's fixed size except for full speed devices.
4884 switch (udev->speed) {
4885 case USB_SPEED_SUPER_PLUS:
4886 case USB_SPEED_SUPER:
4887 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
4889 case USB_SPEED_HIGH: /* fixed at 64 */
4890 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4892 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
4893 /* to determine the ep0 maxpacket size, try to read
4894 * the device descriptor to get bMaxPacketSize0 and
4895 * then correct our initial guess.
4897 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4899 case USB_SPEED_LOW: /* fixed at 8 */
4900 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
4907 speed = usb_speed_string(udev->speed);
4910 * The controller driver may be NULL if the controller device
4911 * is the middle device between platform device and roothub.
4912 * This middle device may not need a device driver due to
4913 * all hardware control can be at platform device driver, this
4914 * platform device is usually a dual-role USB controller device.
4916 if (udev->bus->controller->driver)
4917 driver_name = udev->bus->controller->driver->name;
4919 driver_name = udev->bus->sysdev->driver->name;
4921 if (udev->speed < USB_SPEED_SUPER)
4922 dev_info(&udev->dev,
4923 "%s %s USB device number %d using %s\n",
4924 (initial ? "new" : "reset"), speed,
4925 devnum, driver_name);
4928 /* Set up TT records, if needed */
4930 udev->tt = hdev->tt;
4931 udev->ttport = hdev->ttport;
4932 } else if (udev->speed != USB_SPEED_HIGH
4933 && hdev->speed == USB_SPEED_HIGH) {
4935 dev_err(&udev->dev, "parent hub has no TT\n");
4939 udev->tt = &hub->tt;
4940 udev->ttport = port1;
4944 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4945 * Because device hardware and firmware is sometimes buggy in
4946 * this area, and this is how Linux has done it for ages.
4947 * Change it cautiously.
4949 * NOTE: If use_new_scheme() is true we will start by issuing
4950 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4951 * so it may help with some non-standards-compliant devices.
4952 * Otherwise we start with SET_ADDRESS and then try to read the
4953 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4956 do_new_scheme = use_new_scheme(udev, retry_counter, port_dev);
4958 for (retries = 0; retries < GET_DESCRIPTOR_TRIES; (++retries, msleep(100))) {
4959 if (hub_port_stop_enumerate(hub, port1, retries)) {
4964 if (do_new_scheme) {
4965 retval = hub_enable_device(udev);
4968 "hub failed to enable device, error %d\n",
4973 maxp0 = get_bMaxPacketSize0(udev, buf,
4974 GET_DESCRIPTOR_BUFSIZE, retries == 0);
4975 if (maxp0 > 0 && !initial &&
4976 maxp0 != udev->descriptor.bMaxPacketSize0) {
4977 dev_err(&udev->dev, "device reset changed ep0 maxpacket size!\n");
4982 retval = hub_port_reset(hub, port1, udev, delay, false);
4983 if (retval < 0) /* error or disconnect */
4985 if (oldspeed != udev->speed) {
4987 "device reset changed speed!\n");
4992 if (maxp0 != -ENODEV)
4993 dev_err(&udev->dev, "device descriptor read/64, error %d\n",
5000 for (operations = 0; operations < SET_ADDRESS_TRIES; ++operations) {
5001 retval = hub_set_address(udev, devnum);
5007 if (retval != -ENODEV)
5008 dev_err(&udev->dev, "device not accepting address %d, error %d\n",
5012 if (udev->speed >= USB_SPEED_SUPER) {
5013 devnum = udev->devnum;
5014 dev_info(&udev->dev,
5015 "%s SuperSpeed%s%s USB device number %d using %s\n",
5016 (udev->config) ? "reset" : "new",
5017 (udev->speed == USB_SPEED_SUPER_PLUS) ?
5019 (udev->ssp_rate == USB_SSP_GEN_2x2) ?
5021 (udev->ssp_rate == USB_SSP_GEN_2x1) ?
5023 (udev->ssp_rate == USB_SSP_GEN_1x2) ?
5025 devnum, driver_name);
5029 * cope with hardware quirkiness:
5030 * - let SET_ADDRESS settle, some device hardware wants it
5031 * - read ep0 maxpacket even for high and low speed,
5038 maxp0 = get_bMaxPacketSize0(udev, buf, 8, retries == 0);
5041 if (retval != -ENODEV)
5043 "device descriptor read/8, error %d\n",
5048 if (!initial && maxp0 != udev->descriptor.bMaxPacketSize0) {
5049 dev_err(&udev->dev, "device reset changed ep0 maxpacket size!\n");
5054 delay = udev->parent->hub_delay;
5055 udev->hub_delay = min_t(u32, delay,
5056 USB_TP_TRANSMISSION_DELAY_MAX);
5057 retval = usb_set_isoch_delay(udev);
5060 "Failed set isoch delay, error %d\n",
5071 * Check the ep0 maxpacket guess and correct it if necessary.
5072 * maxp0 is the value stored in the device descriptor;
5073 * i is the value it encodes (logarithmic for SuperSpeed or greater).
5076 if (udev->speed >= USB_SPEED_SUPER) {
5080 i = 0; /* Invalid */
5082 if (usb_endpoint_maxp(&udev->ep0.desc) == i) {
5083 ; /* Initial ep0 maxpacket guess is right */
5084 } else if ((udev->speed == USB_SPEED_FULL ||
5085 udev->speed == USB_SPEED_HIGH) &&
5086 (i == 8 || i == 16 || i == 32 || i == 64)) {
5087 /* Initial guess is wrong; use the descriptor's value */
5088 if (udev->speed == USB_SPEED_FULL)
5089 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
5091 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
5092 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
5093 usb_ep0_reinit(udev);
5095 /* Initial guess is wrong and descriptor's value is invalid */
5096 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", maxp0);
5101 descr = usb_get_device_descriptor(udev);
5102 if (IS_ERR(descr)) {
5103 retval = PTR_ERR(descr);
5104 if (retval != -ENODEV)
5105 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
5110 udev->descriptor = *descr;
5112 *dev_descr = *descr;
5116 * Some superspeed devices have finished the link training process
5117 * and attached to a superspeed hub port, but the device descriptor
5118 * got from those devices show they aren't superspeed devices. Warm
5119 * reset the port attached by the devices can fix them.
5121 if ((udev->speed >= USB_SPEED_SUPER) &&
5122 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
5123 dev_err(&udev->dev, "got a wrong device descriptor, warm reset device\n");
5124 hub_port_reset(hub, port1, udev, HUB_BH_RESET_TIME, true);
5129 usb_detect_quirks(udev);
5131 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
5132 retval = usb_get_bos_descriptor(udev);
5134 udev->lpm_capable = usb_device_supports_lpm(udev);
5135 udev->lpm_disable_count = 1;
5136 usb_set_lpm_parameters(udev);
5137 usb_req_set_sel(udev);
5142 /* notify HCD that we have a device connected and addressed */
5143 if (hcd->driver->update_device)
5144 hcd->driver->update_device(hcd, udev);
5145 hub_set_initial_usb2_lpm_policy(udev);
5148 hub_port_disable(hub, port1, 0);
5149 update_devnum(udev, devnum); /* for disconnect processing */
5156 check_highspeed(struct usb_hub *hub, struct usb_device *udev, int port1)
5158 struct usb_qualifier_descriptor *qual;
5161 if (udev->quirks & USB_QUIRK_DEVICE_QUALIFIER)
5164 qual = kmalloc(sizeof *qual, GFP_KERNEL);
5168 status = usb_get_descriptor(udev, USB_DT_DEVICE_QUALIFIER, 0,
5169 qual, sizeof *qual);
5170 if (status == sizeof *qual) {
5171 dev_info(&udev->dev, "not running at top speed; "
5172 "connect to a high speed hub\n");
5173 /* hub LEDs are probably harder to miss than syslog */
5174 if (hub->has_indicators) {
5175 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
5176 queue_delayed_work(system_power_efficient_wq,
5184 hub_power_remaining(struct usb_hub *hub)
5186 struct usb_device *hdev = hub->hdev;
5190 if (!hub->limited_power)
5193 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
5194 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
5195 struct usb_port *port_dev = hub->ports[port1 - 1];
5196 struct usb_device *udev = port_dev->child;
5202 if (hub_is_superspeed(udev))
5208 * Unconfigured devices may not use more than one unit load,
5209 * or 8mA for OTG ports
5211 if (udev->actconfig)
5212 delta = usb_get_max_power(udev, udev->actconfig);
5213 else if (port1 != udev->bus->otg_port || hdev->parent)
5217 if (delta > hub->mA_per_port)
5218 dev_warn(&port_dev->dev, "%dmA is over %umA budget!\n",
5219 delta, hub->mA_per_port);
5222 if (remaining < 0) {
5223 dev_warn(hub->intfdev, "%dmA over power budget!\n",
5231 static int descriptors_changed(struct usb_device *udev,
5232 struct usb_device_descriptor *new_device_descriptor,
5233 struct usb_host_bos *old_bos)
5237 unsigned serial_len = 0;
5239 unsigned old_length;
5243 if (memcmp(&udev->descriptor, new_device_descriptor,
5244 sizeof(*new_device_descriptor)) != 0)
5247 if ((old_bos && !udev->bos) || (!old_bos && udev->bos))
5250 len = le16_to_cpu(udev->bos->desc->wTotalLength);
5251 if (len != le16_to_cpu(old_bos->desc->wTotalLength))
5253 if (memcmp(udev->bos->desc, old_bos->desc, len))
5257 /* Since the idVendor, idProduct, and bcdDevice values in the
5258 * device descriptor haven't changed, we will assume the
5259 * Manufacturer and Product strings haven't changed either.
5260 * But the SerialNumber string could be different (e.g., a
5261 * different flash card of the same brand).
5264 serial_len = strlen(udev->serial) + 1;
5267 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5268 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5269 len = max(len, old_length);
5272 buf = kmalloc(len, GFP_NOIO);
5274 /* assume the worst */
5277 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5278 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5279 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
5281 if (length != old_length) {
5282 dev_dbg(&udev->dev, "config index %d, error %d\n",
5287 if (memcmp(buf, udev->rawdescriptors[index], old_length)
5289 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
5291 ((struct usb_config_descriptor *) buf)->
5292 bConfigurationValue);
5298 if (!changed && serial_len) {
5299 length = usb_string(udev, udev->descriptor.iSerialNumber,
5301 if (length + 1 != serial_len) {
5302 dev_dbg(&udev->dev, "serial string error %d\n",
5305 } else if (memcmp(buf, udev->serial, length) != 0) {
5306 dev_dbg(&udev->dev, "serial string changed\n");
5315 static void hub_port_connect(struct usb_hub *hub, int port1, u16 portstatus,
5318 int status = -ENODEV;
5321 struct usb_device *hdev = hub->hdev;
5322 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
5323 struct usb_port *port_dev = hub->ports[port1 - 1];
5324 struct usb_device *udev = port_dev->child;
5325 static int unreliable_port = -1;
5328 /* Disconnect any existing devices under this port */
5330 if (hcd->usb_phy && !hdev->parent)
5331 usb_phy_notify_disconnect(hcd->usb_phy, udev->speed);
5332 usb_disconnect(&port_dev->child);
5335 /* We can forget about a "removed" device when there's a physical
5336 * disconnect or the connect status changes.
5338 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
5339 (portchange & USB_PORT_STAT_C_CONNECTION))
5340 clear_bit(port1, hub->removed_bits);
5342 if (portchange & (USB_PORT_STAT_C_CONNECTION |
5343 USB_PORT_STAT_C_ENABLE)) {
5344 status = hub_port_debounce_be_stable(hub, port1);
5346 if (status != -ENODEV &&
5347 port1 != unreliable_port &&
5349 dev_err(&port_dev->dev, "connect-debounce failed\n");
5350 portstatus &= ~USB_PORT_STAT_CONNECTION;
5351 unreliable_port = port1;
5353 portstatus = status;
5357 /* Return now if debouncing failed or nothing is connected or
5358 * the device was "removed".
5360 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
5361 test_bit(port1, hub->removed_bits)) {
5364 * maybe switch power back on (e.g. root hub was reset)
5365 * but only if the port isn't owned by someone else.
5367 if (hub_is_port_power_switchable(hub)
5368 && !usb_port_is_power_on(hub, portstatus)
5369 && !port_dev->port_owner)
5370 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
5372 if (portstatus & USB_PORT_STAT_ENABLE)
5376 if (hub_is_superspeed(hub->hdev))
5383 for (i = 0; i < PORT_INIT_TRIES; i++) {
5384 if (hub_port_stop_enumerate(hub, port1, i)) {
5389 usb_lock_port(port_dev);
5390 mutex_lock(hcd->address0_mutex);
5391 retry_locked = true;
5392 /* reallocate for each attempt, since references
5393 * to the previous one can escape in various ways
5395 udev = usb_alloc_dev(hdev, hdev->bus, port1);
5397 dev_err(&port_dev->dev,
5398 "couldn't allocate usb_device\n");
5399 mutex_unlock(hcd->address0_mutex);
5400 usb_unlock_port(port_dev);
5404 usb_set_device_state(udev, USB_STATE_POWERED);
5405 udev->bus_mA = hub->mA_per_port;
5406 udev->level = hdev->level + 1;
5408 /* Devices connected to SuperSpeed hubs are USB 3.0 or later */
5409 if (hub_is_superspeed(hub->hdev))
5410 udev->speed = USB_SPEED_SUPER;
5412 udev->speed = USB_SPEED_UNKNOWN;
5414 choose_devnum(udev);
5415 if (udev->devnum <= 0) {
5416 status = -ENOTCONN; /* Don't retry */
5420 /* reset (non-USB 3.0 devices) and get descriptor */
5421 status = hub_port_init(hub, udev, port1, i, NULL);
5425 mutex_unlock(hcd->address0_mutex);
5426 usb_unlock_port(port_dev);
5427 retry_locked = false;
5429 if (udev->quirks & USB_QUIRK_DELAY_INIT)
5432 /* consecutive bus-powered hubs aren't reliable; they can
5433 * violate the voltage drop budget. if the new child has
5434 * a "powered" LED, users should notice we didn't enable it
5435 * (without reading syslog), even without per-port LEDs
5438 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
5439 && udev->bus_mA <= unit_load) {
5442 status = usb_get_std_status(udev, USB_RECIP_DEVICE, 0,
5445 dev_dbg(&udev->dev, "get status %d ?\n", status);
5448 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
5450 "can't connect bus-powered hub "
5452 if (hub->has_indicators) {
5453 hub->indicator[port1-1] =
5454 INDICATOR_AMBER_BLINK;
5456 system_power_efficient_wq,
5459 status = -ENOTCONN; /* Don't retry */
5464 /* check for devices running slower than they could */
5465 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
5466 && udev->speed == USB_SPEED_FULL
5467 && highspeed_hubs != 0)
5468 check_highspeed(hub, udev, port1);
5470 /* Store the parent's children[] pointer. At this point
5471 * udev becomes globally accessible, although presumably
5472 * no one will look at it until hdev is unlocked.
5476 mutex_lock(&usb_port_peer_mutex);
5478 /* We mustn't add new devices if the parent hub has
5479 * been disconnected; we would race with the
5480 * recursively_mark_NOTATTACHED() routine.
5482 spin_lock_irq(&device_state_lock);
5483 if (hdev->state == USB_STATE_NOTATTACHED)
5486 port_dev->child = udev;
5487 spin_unlock_irq(&device_state_lock);
5488 mutex_unlock(&usb_port_peer_mutex);
5490 /* Run it through the hoops (find a driver, etc) */
5492 status = usb_new_device(udev);
5494 mutex_lock(&usb_port_peer_mutex);
5495 spin_lock_irq(&device_state_lock);
5496 port_dev->child = NULL;
5497 spin_unlock_irq(&device_state_lock);
5498 mutex_unlock(&usb_port_peer_mutex);
5500 if (hcd->usb_phy && !hdev->parent)
5501 usb_phy_notify_connect(hcd->usb_phy,
5509 status = hub_power_remaining(hub);
5511 dev_dbg(hub->intfdev, "%dmA power budget left\n", status);
5516 hub_port_disable(hub, port1, 1);
5518 usb_ep0_reinit(udev);
5519 release_devnum(udev);
5522 mutex_unlock(hcd->address0_mutex);
5523 usb_unlock_port(port_dev);
5526 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
5529 /* When halfway through our retry count, power-cycle the port */
5530 if (i == (PORT_INIT_TRIES - 1) / 2) {
5531 dev_info(&port_dev->dev, "attempt power cycle\n");
5532 usb_hub_set_port_power(hdev, hub, port1, false);
5533 msleep(2 * hub_power_on_good_delay(hub));
5534 usb_hub_set_port_power(hdev, hub, port1, true);
5535 msleep(hub_power_on_good_delay(hub));
5538 if (hub->hdev->parent ||
5539 !hcd->driver->port_handed_over ||
5540 !(hcd->driver->port_handed_over)(hcd, port1)) {
5541 if (status != -ENOTCONN && status != -ENODEV)
5542 dev_err(&port_dev->dev,
5543 "unable to enumerate USB device\n");
5547 hub_port_disable(hub, port1, 1);
5548 if (hcd->driver->relinquish_port && !hub->hdev->parent) {
5549 if (status != -ENOTCONN && status != -ENODEV)
5550 hcd->driver->relinquish_port(hcd, port1);
5554 /* Handle physical or logical connection change events.
5555 * This routine is called when:
5556 * a port connection-change occurs;
5557 * a port enable-change occurs (often caused by EMI);
5558 * usb_reset_and_verify_device() encounters changed descriptors (as from
5559 * a firmware download)
5560 * caller already locked the hub
5562 static void hub_port_connect_change(struct usb_hub *hub, int port1,
5563 u16 portstatus, u16 portchange)
5564 __must_hold(&port_dev->status_lock)
5566 struct usb_port *port_dev = hub->ports[port1 - 1];
5567 struct usb_device *udev = port_dev->child;
5568 struct usb_device_descriptor *descr;
5569 int status = -ENODEV;
5571 dev_dbg(&port_dev->dev, "status %04x, change %04x, %s\n", portstatus,
5572 portchange, portspeed(hub, portstatus));
5574 if (hub->has_indicators) {
5575 set_port_led(hub, port1, HUB_LED_AUTO);
5576 hub->indicator[port1-1] = INDICATOR_AUTO;
5579 #ifdef CONFIG_USB_OTG
5580 /* during HNP, don't repeat the debounce */
5581 if (hub->hdev->bus->is_b_host)
5582 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
5583 USB_PORT_STAT_C_ENABLE);
5586 /* Try to resuscitate an existing device */
5587 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
5588 udev->state != USB_STATE_NOTATTACHED) {
5589 if (portstatus & USB_PORT_STAT_ENABLE) {
5591 * USB-3 connections are initialized automatically by
5592 * the hostcontroller hardware. Therefore check for
5593 * changed device descriptors before resuscitating the
5596 descr = usb_get_device_descriptor(udev);
5597 if (IS_ERR(descr)) {
5599 "can't read device descriptor %ld\n",
5602 if (descriptors_changed(udev, descr,
5605 "device descriptor has changed\n");
5607 status = 0; /* Nothing to do */
5612 } else if (udev->state == USB_STATE_SUSPENDED &&
5613 udev->persist_enabled) {
5614 /* For a suspended device, treat this as a
5615 * remote wakeup event.
5617 usb_unlock_port(port_dev);
5618 status = usb_remote_wakeup(udev);
5619 usb_lock_port(port_dev);
5622 /* Don't resuscitate */;
5625 clear_bit(port1, hub->change_bits);
5627 /* successfully revalidated the connection */
5631 usb_unlock_port(port_dev);
5632 hub_port_connect(hub, port1, portstatus, portchange);
5633 usb_lock_port(port_dev);
5636 /* Handle notifying userspace about hub over-current events */
5637 static void port_over_current_notify(struct usb_port *port_dev)
5639 char *envp[3] = { NULL, NULL, NULL };
5640 struct device *hub_dev;
5641 char *port_dev_path;
5643 sysfs_notify(&port_dev->dev.kobj, NULL, "over_current_count");
5645 hub_dev = port_dev->dev.parent;
5650 port_dev_path = kobject_get_path(&port_dev->dev.kobj, GFP_KERNEL);
5654 envp[0] = kasprintf(GFP_KERNEL, "OVER_CURRENT_PORT=%s", port_dev_path);
5658 envp[1] = kasprintf(GFP_KERNEL, "OVER_CURRENT_COUNT=%u",
5659 port_dev->over_current_count);
5663 kobject_uevent_env(&hub_dev->kobj, KOBJ_CHANGE, envp);
5668 kfree(port_dev_path);
5671 static void port_event(struct usb_hub *hub, int port1)
5672 __must_hold(&port_dev->status_lock)
5675 struct usb_port *port_dev = hub->ports[port1 - 1];
5676 struct usb_device *udev = port_dev->child;
5677 struct usb_device *hdev = hub->hdev;
5678 u16 portstatus, portchange;
5681 connect_change = test_bit(port1, hub->change_bits);
5682 clear_bit(port1, hub->event_bits);
5683 clear_bit(port1, hub->wakeup_bits);
5685 if (usb_hub_port_status(hub, port1, &portstatus, &portchange) < 0)
5688 if (portchange & USB_PORT_STAT_C_CONNECTION) {
5689 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_CONNECTION);
5693 if (portchange & USB_PORT_STAT_C_ENABLE) {
5694 if (!connect_change)
5695 dev_dbg(&port_dev->dev, "enable change, status %08x\n",
5697 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_ENABLE);
5700 * EM interference sometimes causes badly shielded USB devices
5701 * to be shutdown by the hub, this hack enables them again.
5702 * Works at least with mouse driver.
5704 if (!(portstatus & USB_PORT_STAT_ENABLE)
5705 && !connect_change && udev) {
5706 dev_err(&port_dev->dev, "disabled by hub (EMI?), re-enabling...\n");
5711 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
5712 u16 status = 0, unused;
5713 port_dev->over_current_count++;
5714 port_over_current_notify(port_dev);
5716 dev_dbg(&port_dev->dev, "over-current change #%u\n",
5717 port_dev->over_current_count);
5718 usb_clear_port_feature(hdev, port1,
5719 USB_PORT_FEAT_C_OVER_CURRENT);
5720 msleep(100); /* Cool down */
5721 hub_power_on(hub, true);
5722 usb_hub_port_status(hub, port1, &status, &unused);
5723 if (status & USB_PORT_STAT_OVERCURRENT)
5724 dev_err(&port_dev->dev, "over-current condition\n");
5727 if (portchange & USB_PORT_STAT_C_RESET) {
5728 dev_dbg(&port_dev->dev, "reset change\n");
5729 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_RESET);
5731 if ((portchange & USB_PORT_STAT_C_BH_RESET)
5732 && hub_is_superspeed(hdev)) {
5733 dev_dbg(&port_dev->dev, "warm reset change\n");
5734 usb_clear_port_feature(hdev, port1,
5735 USB_PORT_FEAT_C_BH_PORT_RESET);
5737 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
5738 dev_dbg(&port_dev->dev, "link state change\n");
5739 usb_clear_port_feature(hdev, port1,
5740 USB_PORT_FEAT_C_PORT_LINK_STATE);
5742 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
5743 dev_warn(&port_dev->dev, "config error\n");
5744 usb_clear_port_feature(hdev, port1,
5745 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
5748 /* skip port actions that require the port to be powered on */
5749 if (!pm_runtime_active(&port_dev->dev))
5752 /* skip port actions if ignore_event and early_stop are true */
5753 if (port_dev->ignore_event && port_dev->early_stop)
5756 if (hub_handle_remote_wakeup(hub, port1, portstatus, portchange))
5760 * Avoid trying to recover a USB3 SS.Inactive port with a warm reset if
5761 * the device was disconnected. A 12ms disconnect detect timer in
5762 * SS.Inactive state transitions the port to RxDetect automatically.
5763 * SS.Inactive link error state is common during device disconnect.
5765 while (hub_port_warm_reset_required(hub, port1, portstatus)) {
5766 if ((i++ < DETECT_DISCONNECT_TRIES) && udev) {
5770 usb_hub_port_status(hub, port1, &portstatus, &unused);
5771 dev_dbg(&port_dev->dev, "Wait for inactive link disconnect detect\n");
5773 } else if (!udev || !(portstatus & USB_PORT_STAT_CONNECTION)
5774 || udev->state == USB_STATE_NOTATTACHED) {
5775 dev_dbg(&port_dev->dev, "do warm reset, port only\n");
5776 if (hub_port_reset(hub, port1, NULL,
5777 HUB_BH_RESET_TIME, true) < 0)
5778 hub_port_disable(hub, port1, 1);
5780 dev_dbg(&port_dev->dev, "do warm reset, full device\n");
5781 usb_unlock_port(port_dev);
5782 usb_lock_device(udev);
5783 usb_reset_device(udev);
5784 usb_unlock_device(udev);
5785 usb_lock_port(port_dev);
5792 hub_port_connect_change(hub, port1, portstatus, portchange);
5795 static void hub_event(struct work_struct *work)
5797 struct usb_device *hdev;
5798 struct usb_interface *intf;
5799 struct usb_hub *hub;
5800 struct device *hub_dev;
5805 hub = container_of(work, struct usb_hub, events);
5807 hub_dev = hub->intfdev;
5808 intf = to_usb_interface(hub_dev);
5810 kcov_remote_start_usb((u64)hdev->bus->busnum);
5812 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
5813 hdev->state, hdev->maxchild,
5814 /* NOTE: expects max 15 ports... */
5815 (u16) hub->change_bits[0],
5816 (u16) hub->event_bits[0]);
5818 /* Lock the device, then check to see if we were
5819 * disconnected while waiting for the lock to succeed. */
5820 usb_lock_device(hdev);
5821 if (unlikely(hub->disconnected))
5824 /* If the hub has died, clean up after it */
5825 if (hdev->state == USB_STATE_NOTATTACHED) {
5826 hub->error = -ENODEV;
5827 hub_quiesce(hub, HUB_DISCONNECT);
5832 ret = usb_autopm_get_interface(intf);
5834 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
5838 /* If this is an inactive hub, do nothing */
5843 dev_dbg(hub_dev, "resetting for error %d\n", hub->error);
5845 ret = usb_reset_device(hdev);
5847 dev_dbg(hub_dev, "error resetting hub: %d\n", ret);
5855 /* deal with port status changes */
5856 for (i = 1; i <= hdev->maxchild; i++) {
5857 struct usb_port *port_dev = hub->ports[i - 1];
5859 if (test_bit(i, hub->event_bits)
5860 || test_bit(i, hub->change_bits)
5861 || test_bit(i, hub->wakeup_bits)) {
5863 * The get_noresume and barrier ensure that if
5864 * the port was in the process of resuming, we
5865 * flush that work and keep the port active for
5866 * the duration of the port_event(). However,
5867 * if the port is runtime pm suspended
5868 * (powered-off), we leave it in that state, run
5869 * an abbreviated port_event(), and move on.
5871 pm_runtime_get_noresume(&port_dev->dev);
5872 pm_runtime_barrier(&port_dev->dev);
5873 usb_lock_port(port_dev);
5875 usb_unlock_port(port_dev);
5876 pm_runtime_put_sync(&port_dev->dev);
5880 /* deal with hub status changes */
5881 if (test_and_clear_bit(0, hub->event_bits) == 0)
5883 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
5884 dev_err(hub_dev, "get_hub_status failed\n");
5886 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
5887 dev_dbg(hub_dev, "power change\n");
5888 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
5889 if (hubstatus & HUB_STATUS_LOCAL_POWER)
5890 /* FIXME: Is this always true? */
5891 hub->limited_power = 1;
5893 hub->limited_power = 0;
5895 if (hubchange & HUB_CHANGE_OVERCURRENT) {
5899 dev_dbg(hub_dev, "over-current change\n");
5900 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
5901 msleep(500); /* Cool down */
5902 hub_power_on(hub, true);
5903 hub_hub_status(hub, &status, &unused);
5904 if (status & HUB_STATUS_OVERCURRENT)
5905 dev_err(hub_dev, "over-current condition\n");
5910 /* Balance the usb_autopm_get_interface() above */
5911 usb_autopm_put_interface_no_suspend(intf);
5913 usb_unlock_device(hdev);
5915 /* Balance the stuff in kick_hub_wq() and allow autosuspend */
5916 usb_autopm_put_interface(intf);
5922 static const struct usb_device_id hub_id_table[] = {
5923 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5924 | USB_DEVICE_ID_MATCH_PRODUCT
5925 | USB_DEVICE_ID_MATCH_INT_CLASS,
5926 .idVendor = USB_VENDOR_SMSC,
5927 .idProduct = USB_PRODUCT_USB5534B,
5928 .bInterfaceClass = USB_CLASS_HUB,
5929 .driver_info = HUB_QUIRK_DISABLE_AUTOSUSPEND},
5930 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5931 | USB_DEVICE_ID_MATCH_PRODUCT,
5932 .idVendor = USB_VENDOR_CYPRESS,
5933 .idProduct = USB_PRODUCT_CY7C65632,
5934 .driver_info = HUB_QUIRK_DISABLE_AUTOSUSPEND},
5935 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5936 | USB_DEVICE_ID_MATCH_INT_CLASS,
5937 .idVendor = USB_VENDOR_GENESYS_LOGIC,
5938 .bInterfaceClass = USB_CLASS_HUB,
5939 .driver_info = HUB_QUIRK_CHECK_PORT_AUTOSUSPEND},
5940 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5941 | USB_DEVICE_ID_MATCH_PRODUCT,
5942 .idVendor = USB_VENDOR_TEXAS_INSTRUMENTS,
5943 .idProduct = USB_PRODUCT_TUSB8041_USB2,
5944 .driver_info = HUB_QUIRK_DISABLE_AUTOSUSPEND},
5945 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5946 | USB_DEVICE_ID_MATCH_PRODUCT,
5947 .idVendor = USB_VENDOR_TEXAS_INSTRUMENTS,
5948 .idProduct = USB_PRODUCT_TUSB8041_USB3,
5949 .driver_info = HUB_QUIRK_DISABLE_AUTOSUSPEND},
5950 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5951 | USB_DEVICE_ID_MATCH_PRODUCT,
5952 .idVendor = USB_VENDOR_MICROCHIP,
5953 .idProduct = USB_PRODUCT_USB4913,
5954 .driver_info = HUB_QUIRK_REDUCE_FRAME_INTR_BINTERVAL},
5955 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5956 | USB_DEVICE_ID_MATCH_PRODUCT,
5957 .idVendor = USB_VENDOR_MICROCHIP,
5958 .idProduct = USB_PRODUCT_USB4914,
5959 .driver_info = HUB_QUIRK_REDUCE_FRAME_INTR_BINTERVAL},
5960 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5961 | USB_DEVICE_ID_MATCH_PRODUCT,
5962 .idVendor = USB_VENDOR_MICROCHIP,
5963 .idProduct = USB_PRODUCT_USB4915,
5964 .driver_info = HUB_QUIRK_REDUCE_FRAME_INTR_BINTERVAL},
5965 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
5966 .bDeviceClass = USB_CLASS_HUB},
5967 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
5968 .bInterfaceClass = USB_CLASS_HUB},
5969 { } /* Terminating entry */
5972 MODULE_DEVICE_TABLE(usb, hub_id_table);
5974 static struct usb_driver hub_driver = {
5977 .disconnect = hub_disconnect,
5978 .suspend = hub_suspend,
5979 .resume = hub_resume,
5980 .reset_resume = hub_reset_resume,
5981 .pre_reset = hub_pre_reset,
5982 .post_reset = hub_post_reset,
5983 .unlocked_ioctl = hub_ioctl,
5984 .id_table = hub_id_table,
5985 .supports_autosuspend = 1,
5988 int usb_hub_init(void)
5990 if (usb_register(&hub_driver) < 0) {
5991 printk(KERN_ERR "%s: can't register hub driver\n",
5997 * The workqueue needs to be freezable to avoid interfering with
5998 * USB-PERSIST port handover. Otherwise it might see that a full-speed
5999 * device was gone before the EHCI controller had handed its port
6000 * over to the companion full-speed controller.
6002 hub_wq = alloc_workqueue("usb_hub_wq", WQ_FREEZABLE, 0);
6006 /* Fall through if kernel_thread failed */
6007 usb_deregister(&hub_driver);
6008 pr_err("%s: can't allocate workqueue for usb hub\n", usbcore_name);
6013 void usb_hub_cleanup(void)
6015 destroy_workqueue(hub_wq);
6018 * Hub resources are freed for us by usb_deregister. It calls
6019 * usb_driver_purge on every device which in turn calls that
6020 * devices disconnect function if it is using this driver.
6021 * The hub_disconnect function takes care of releasing the
6022 * individual hub resources. -greg
6024 usb_deregister(&hub_driver);
6025 } /* usb_hub_cleanup() */
6028 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
6029 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
6031 * WARNING - don't use this routine to reset a composite device
6032 * (one with multiple interfaces owned by separate drivers)!
6033 * Use usb_reset_device() instead.
6035 * Do a port reset, reassign the device's address, and establish its
6036 * former operating configuration. If the reset fails, or the device's
6037 * descriptors change from their values before the reset, or the original
6038 * configuration and altsettings cannot be restored, a flag will be set
6039 * telling hub_wq to pretend the device has been disconnected and then
6040 * re-connected. All drivers will be unbound, and the device will be
6041 * re-enumerated and probed all over again.
6043 * Return: 0 if the reset succeeded, -ENODEV if the device has been
6044 * flagged for logical disconnection, or some other negative error code
6045 * if the reset wasn't even attempted.
6048 * The caller must own the device lock and the port lock, the latter is
6049 * taken by usb_reset_device(). For example, it's safe to use
6050 * usb_reset_device() from a driver probe() routine after downloading
6051 * new firmware. For calls that might not occur during probe(), drivers
6052 * should lock the device using usb_lock_device_for_reset().
6054 * Locking exception: This routine may also be called from within an
6055 * autoresume handler. Such usage won't conflict with other tasks
6056 * holding the device lock because these tasks should always call
6057 * usb_autopm_resume_device(), thereby preventing any unwanted
6058 * autoresume. The autoresume handler is expected to have already
6059 * acquired the port lock before calling this routine.
6061 static int usb_reset_and_verify_device(struct usb_device *udev)
6063 struct usb_device *parent_hdev = udev->parent;
6064 struct usb_hub *parent_hub;
6065 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
6066 struct usb_device_descriptor descriptor;
6067 struct usb_host_bos *bos;
6069 int port1 = udev->portnum;
6071 if (udev->state == USB_STATE_NOTATTACHED ||
6072 udev->state == USB_STATE_SUSPENDED) {
6073 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
6081 parent_hub = usb_hub_to_struct_hub(parent_hdev);
6083 /* Disable USB2 hardware LPM.
6084 * It will be re-enabled by the enumeration process.
6086 usb_disable_usb2_hardware_lpm(udev);
6091 mutex_lock(hcd->address0_mutex);
6093 for (i = 0; i < PORT_INIT_TRIES; ++i) {
6094 if (hub_port_stop_enumerate(parent_hub, port1, i)) {
6099 /* ep0 maxpacket size may change; let the HCD know about it.
6100 * Other endpoints will be handled by re-enumeration. */
6101 usb_ep0_reinit(udev);
6102 ret = hub_port_init(parent_hub, udev, port1, i, &descriptor);
6103 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
6106 mutex_unlock(hcd->address0_mutex);
6111 /* Device might have changed firmware (DFU or similar) */
6112 if (descriptors_changed(udev, &descriptor, bos)) {
6113 dev_info(&udev->dev, "device firmware changed\n");
6117 /* Restore the device's previous configuration */
6118 if (!udev->actconfig)
6121 mutex_lock(hcd->bandwidth_mutex);
6122 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
6124 dev_warn(&udev->dev,
6125 "Busted HC? Not enough HCD resources for "
6126 "old configuration.\n");
6127 mutex_unlock(hcd->bandwidth_mutex);
6130 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
6131 USB_REQ_SET_CONFIGURATION, 0,
6132 udev->actconfig->desc.bConfigurationValue, 0,
6133 NULL, 0, USB_CTRL_SET_TIMEOUT);
6136 "can't restore configuration #%d (error=%d)\n",
6137 udev->actconfig->desc.bConfigurationValue, ret);
6138 mutex_unlock(hcd->bandwidth_mutex);
6141 mutex_unlock(hcd->bandwidth_mutex);
6142 usb_set_device_state(udev, USB_STATE_CONFIGURED);
6144 /* Put interfaces back into the same altsettings as before.
6145 * Don't bother to send the Set-Interface request for interfaces
6146 * that were already in altsetting 0; besides being unnecessary,
6147 * many devices can't handle it. Instead just reset the host-side
6150 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
6151 struct usb_host_config *config = udev->actconfig;
6152 struct usb_interface *intf = config->interface[i];
6153 struct usb_interface_descriptor *desc;
6155 desc = &intf->cur_altsetting->desc;
6156 if (desc->bAlternateSetting == 0) {
6157 usb_disable_interface(udev, intf, true);
6158 usb_enable_interface(udev, intf, true);
6161 /* Let the bandwidth allocation function know that this
6162 * device has been reset, and it will have to use
6163 * alternate setting 0 as the current alternate setting.
6165 intf->resetting_device = 1;
6166 ret = usb_set_interface(udev, desc->bInterfaceNumber,
6167 desc->bAlternateSetting);
6168 intf->resetting_device = 0;
6171 dev_err(&udev->dev, "failed to restore interface %d "
6172 "altsetting %d (error=%d)\n",
6173 desc->bInterfaceNumber,
6174 desc->bAlternateSetting,
6178 /* Resetting also frees any allocated streams */
6179 for (j = 0; j < intf->cur_altsetting->desc.bNumEndpoints; j++)
6180 intf->cur_altsetting->endpoint[j].streams = 0;
6184 /* Now that the alt settings are re-installed, enable LTM and LPM. */
6185 usb_enable_usb2_hardware_lpm(udev);
6186 usb_unlocked_enable_lpm(udev);
6187 usb_enable_ltm(udev);
6188 usb_release_bos_descriptor(udev);
6193 usb_release_bos_descriptor(udev);
6195 hub_port_logical_disconnect(parent_hub, port1);
6200 * usb_reset_device - warn interface drivers and perform a USB port reset
6201 * @udev: device to reset (not in NOTATTACHED state)
6203 * Warns all drivers bound to registered interfaces (using their pre_reset
6204 * method), performs the port reset, and then lets the drivers know that
6205 * the reset is over (using their post_reset method).
6207 * Return: The same as for usb_reset_and_verify_device().
6208 * However, if a reset is already in progress (for instance, if a
6209 * driver doesn't have pre_reset() or post_reset() callbacks, and while
6210 * being unbound or re-bound during the ongoing reset its disconnect()
6211 * or probe() routine tries to perform a second, nested reset), the
6212 * routine returns -EINPROGRESS.
6215 * The caller must own the device lock. For example, it's safe to use
6216 * this from a driver probe() routine after downloading new firmware.
6217 * For calls that might not occur during probe(), drivers should lock
6218 * the device using usb_lock_device_for_reset().
6220 * If an interface is currently being probed or disconnected, we assume
6221 * its driver knows how to handle resets. For all other interfaces,
6222 * if the driver doesn't have pre_reset and post_reset methods then
6223 * we attempt to unbind it and rebind afterward.
6225 int usb_reset_device(struct usb_device *udev)
6229 unsigned int noio_flag;
6230 struct usb_port *port_dev;
6231 struct usb_host_config *config = udev->actconfig;
6232 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
6234 if (udev->state == USB_STATE_NOTATTACHED) {
6235 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
6240 if (!udev->parent) {
6241 /* this requires hcd-specific logic; see ohci_restart() */
6242 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
6246 if (udev->reset_in_progress)
6247 return -EINPROGRESS;
6248 udev->reset_in_progress = 1;
6250 port_dev = hub->ports[udev->portnum - 1];
6253 * Don't allocate memory with GFP_KERNEL in current
6254 * context to avoid possible deadlock if usb mass
6255 * storage interface or usbnet interface(iSCSI case)
6256 * is included in current configuration. The easist
6257 * approach is to do it for every device reset,
6258 * because the device 'memalloc_noio' flag may have
6259 * not been set before reseting the usb device.
6261 noio_flag = memalloc_noio_save();
6263 /* Prevent autosuspend during the reset */
6264 usb_autoresume_device(udev);
6267 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
6268 struct usb_interface *cintf = config->interface[i];
6269 struct usb_driver *drv;
6272 if (cintf->dev.driver) {
6273 drv = to_usb_driver(cintf->dev.driver);
6274 if (drv->pre_reset && drv->post_reset)
6275 unbind = (drv->pre_reset)(cintf);
6276 else if (cintf->condition ==
6277 USB_INTERFACE_BOUND)
6280 usb_forced_unbind_intf(cintf);
6285 usb_lock_port(port_dev);
6286 ret = usb_reset_and_verify_device(udev);
6287 usb_unlock_port(port_dev);
6290 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
6291 struct usb_interface *cintf = config->interface[i];
6292 struct usb_driver *drv;
6293 int rebind = cintf->needs_binding;
6295 if (!rebind && cintf->dev.driver) {
6296 drv = to_usb_driver(cintf->dev.driver);
6297 if (drv->post_reset)
6298 rebind = (drv->post_reset)(cintf);
6299 else if (cintf->condition ==
6300 USB_INTERFACE_BOUND)
6303 cintf->needs_binding = 1;
6307 /* If the reset failed, hub_wq will unbind drivers later */
6309 usb_unbind_and_rebind_marked_interfaces(udev);
6312 usb_autosuspend_device(udev);
6313 memalloc_noio_restore(noio_flag);
6314 udev->reset_in_progress = 0;
6317 EXPORT_SYMBOL_GPL(usb_reset_device);
6321 * usb_queue_reset_device - Reset a USB device from an atomic context
6322 * @iface: USB interface belonging to the device to reset
6324 * This function can be used to reset a USB device from an atomic
6325 * context, where usb_reset_device() won't work (as it blocks).
6327 * Doing a reset via this method is functionally equivalent to calling
6328 * usb_reset_device(), except for the fact that it is delayed to a
6329 * workqueue. This means that any drivers bound to other interfaces
6330 * might be unbound, as well as users from usbfs in user space.
6334 * - Scheduling two resets at the same time from two different drivers
6335 * attached to two different interfaces of the same device is
6336 * possible; depending on how the driver attached to each interface
6337 * handles ->pre_reset(), the second reset might happen or not.
6339 * - If the reset is delayed so long that the interface is unbound from
6340 * its driver, the reset will be skipped.
6342 * - This function can be called during .probe(). It can also be called
6343 * during .disconnect(), but doing so is pointless because the reset
6344 * will not occur. If you really want to reset the device during
6345 * .disconnect(), call usb_reset_device() directly -- but watch out
6346 * for nested unbinding issues!
6348 void usb_queue_reset_device(struct usb_interface *iface)
6350 if (schedule_work(&iface->reset_ws))
6351 usb_get_intf(iface);
6353 EXPORT_SYMBOL_GPL(usb_queue_reset_device);
6356 * usb_hub_find_child - Get the pointer of child device
6357 * attached to the port which is specified by @port1.
6358 * @hdev: USB device belonging to the usb hub
6359 * @port1: port num to indicate which port the child device
6362 * USB drivers call this function to get hub's child device
6365 * Return: %NULL if input param is invalid and
6366 * child's usb_device pointer if non-NULL.
6368 struct usb_device *usb_hub_find_child(struct usb_device *hdev,
6371 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
6373 if (port1 < 1 || port1 > hdev->maxchild)
6375 return hub->ports[port1 - 1]->child;
6377 EXPORT_SYMBOL_GPL(usb_hub_find_child);
6379 void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
6380 struct usb_hub_descriptor *desc)
6382 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
6383 enum usb_port_connect_type connect_type;
6389 if (!hub_is_superspeed(hdev)) {
6390 for (i = 1; i <= hdev->maxchild; i++) {
6391 struct usb_port *port_dev = hub->ports[i - 1];
6393 connect_type = port_dev->connect_type;
6394 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
6395 u8 mask = 1 << (i%8);
6397 if (!(desc->u.hs.DeviceRemovable[i/8] & mask)) {
6398 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
6399 desc->u.hs.DeviceRemovable[i/8] |= mask;
6404 u16 port_removable = le16_to_cpu(desc->u.ss.DeviceRemovable);
6406 for (i = 1; i <= hdev->maxchild; i++) {
6407 struct usb_port *port_dev = hub->ports[i - 1];
6409 connect_type = port_dev->connect_type;
6410 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
6413 if (!(port_removable & mask)) {
6414 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
6415 port_removable |= mask;
6420 desc->u.ss.DeviceRemovable = cpu_to_le16(port_removable);
6426 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
6427 * @hdev: USB device belonging to the usb hub
6428 * @port1: port num of the port
6430 * Return: Port's acpi handle if successful, %NULL if params are
6433 acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
6436 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
6441 return ACPI_HANDLE(&hub->ports[port1 - 1]->dev);