1 // SPDX-License-Identifier: GPL-2.0
5 * (C) Copyright 1999 Linus Torvalds
6 * (C) Copyright 1999 Johannes Erdfelt
7 * (C) Copyright 1999 Gregory P. Smith
8 * (C) Copyright 2001 Brad Hards (bhards@bigpond.net.au)
10 * Released under the GPLv2 only.
13 #include <linux/kernel.h>
14 #include <linux/errno.h>
15 #include <linux/module.h>
16 #include <linux/moduleparam.h>
17 #include <linux/completion.h>
18 #include <linux/sched/mm.h>
19 #include <linux/list.h>
20 #include <linux/slab.h>
21 #include <linux/kcov.h>
22 #include <linux/ioctl.h>
23 #include <linux/usb.h>
24 #include <linux/usbdevice_fs.h>
25 #include <linux/usb/hcd.h>
26 #include <linux/usb/otg.h>
27 #include <linux/usb/quirks.h>
28 #include <linux/workqueue.h>
29 #include <linux/mutex.h>
30 #include <linux/random.h>
31 #include <linux/pm_qos.h>
32 #include <linux/kobject.h>
34 #include <linux/bitfield.h>
35 #include <linux/uaccess.h>
36 #include <asm/byteorder.h>
39 #include "otg_productlist.h"
41 #define USB_VENDOR_GENESYS_LOGIC 0x05e3
42 #define USB_VENDOR_SMSC 0x0424
43 #define USB_PRODUCT_USB5534B 0x5534
44 #define USB_VENDOR_CYPRESS 0x04b4
45 #define USB_PRODUCT_CY7C65632 0x6570
46 #define USB_VENDOR_TEXAS_INSTRUMENTS 0x0451
47 #define USB_PRODUCT_TUSB8041_USB3 0x8140
48 #define USB_PRODUCT_TUSB8041_USB2 0x8142
49 #define HUB_QUIRK_CHECK_PORT_AUTOSUSPEND BIT(0)
50 #define HUB_QUIRK_DISABLE_AUTOSUSPEND BIT(1)
52 #define USB_TP_TRANSMISSION_DELAY 40 /* ns */
53 #define USB_TP_TRANSMISSION_DELAY_MAX 65535 /* ns */
54 #define USB_PING_RESPONSE_TIME 400 /* ns */
56 /* Protect struct usb_device->state and ->children members
57 * Note: Both are also protected by ->dev.sem, except that ->state can
58 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
59 static DEFINE_SPINLOCK(device_state_lock);
61 /* workqueue to process hub events */
62 static struct workqueue_struct *hub_wq;
63 static void hub_event(struct work_struct *work);
65 /* synchronize hub-port add/remove and peering operations */
66 DEFINE_MUTEX(usb_port_peer_mutex);
68 /* cycle leds on hubs that aren't blinking for attention */
69 static bool blinkenlights;
70 module_param(blinkenlights, bool, S_IRUGO);
71 MODULE_PARM_DESC(blinkenlights, "true to cycle leds on hubs");
74 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
75 * 10 seconds to send reply for the initial 64-byte descriptor request.
77 /* define initial 64-byte descriptor request timeout in milliseconds */
78 static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
79 module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
80 MODULE_PARM_DESC(initial_descriptor_timeout,
81 "initial 64-byte descriptor request timeout in milliseconds "
82 "(default 5000 - 5.0 seconds)");
85 * As of 2.6.10 we introduce a new USB device initialization scheme which
86 * closely resembles the way Windows works. Hopefully it will be compatible
87 * with a wider range of devices than the old scheme. However some previously
88 * working devices may start giving rise to "device not accepting address"
89 * errors; if that happens the user can try the old scheme by adjusting the
90 * following module parameters.
92 * For maximum flexibility there are two boolean parameters to control the
93 * hub driver's behavior. On the first initialization attempt, if the
94 * "old_scheme_first" parameter is set then the old scheme will be used,
95 * otherwise the new scheme is used. If that fails and "use_both_schemes"
96 * is set, then the driver will make another attempt, using the other scheme.
98 static bool old_scheme_first;
99 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
100 MODULE_PARM_DESC(old_scheme_first,
101 "start with the old device initialization scheme");
103 static bool use_both_schemes = true;
104 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
105 MODULE_PARM_DESC(use_both_schemes,
106 "try the other device initialization scheme if the "
109 /* Mutual exclusion for EHCI CF initialization. This interferes with
110 * port reset on some companion controllers.
112 DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
113 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
115 #define HUB_DEBOUNCE_TIMEOUT 2000
116 #define HUB_DEBOUNCE_STEP 25
117 #define HUB_DEBOUNCE_STABLE 100
119 static int usb_reset_and_verify_device(struct usb_device *udev);
120 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state);
121 static bool hub_port_warm_reset_required(struct usb_hub *hub, int port1,
124 static inline char *portspeed(struct usb_hub *hub, int portstatus)
126 if (hub_is_superspeedplus(hub->hdev))
128 if (hub_is_superspeed(hub->hdev))
130 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
132 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
138 /* Note that hdev or one of its children must be locked! */
139 struct usb_hub *usb_hub_to_struct_hub(struct usb_device *hdev)
141 if (!hdev || !hdev->actconfig || !hdev->maxchild)
143 return usb_get_intfdata(hdev->actconfig->interface[0]);
146 int usb_device_supports_lpm(struct usb_device *udev)
148 /* Some devices have trouble with LPM */
149 if (udev->quirks & USB_QUIRK_NO_LPM)
152 /* Skip if the device BOS descriptor couldn't be read */
156 /* USB 2.1 (and greater) devices indicate LPM support through
157 * their USB 2.0 Extended Capabilities BOS descriptor.
159 if (udev->speed == USB_SPEED_HIGH || udev->speed == USB_SPEED_FULL) {
160 if (udev->bos->ext_cap &&
162 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
168 * According to the USB 3.0 spec, all USB 3.0 devices must support LPM.
169 * However, there are some that don't, and they set the U1/U2 exit
172 if (!udev->bos->ss_cap) {
173 dev_info(&udev->dev, "No LPM exit latency info found, disabling LPM.\n");
177 if (udev->bos->ss_cap->bU1devExitLat == 0 &&
178 udev->bos->ss_cap->bU2DevExitLat == 0) {
180 dev_info(&udev->dev, "LPM exit latency is zeroed, disabling LPM.\n");
182 dev_info(&udev->dev, "We don't know the algorithms for LPM for this host, disabling LPM.\n");
186 if (!udev->parent || udev->parent->lpm_capable)
192 * Set the Maximum Exit Latency (MEL) for the host to wakup up the path from
193 * U1/U2, send a PING to the device and receive a PING_RESPONSE.
194 * See USB 3.1 section C.1.5.2
196 static void usb_set_lpm_mel(struct usb_device *udev,
197 struct usb3_lpm_parameters *udev_lpm_params,
198 unsigned int udev_exit_latency,
200 struct usb3_lpm_parameters *hub_lpm_params,
201 unsigned int hub_exit_latency)
203 unsigned int total_mel;
206 * tMEL1. time to transition path from host to device into U0.
207 * MEL for parent already contains the delay up to parent, so only add
208 * the exit latency for the last link (pick the slower exit latency),
209 * and the hub header decode latency. See USB 3.1 section C 2.2.1
210 * Store MEL in nanoseconds
212 total_mel = hub_lpm_params->mel +
213 max(udev_exit_latency, hub_exit_latency) * 1000 +
214 hub->descriptor->u.ss.bHubHdrDecLat * 100;
217 * tMEL2. Time to submit PING packet. Sum of tTPTransmissionDelay for
218 * each link + wHubDelay for each hub. Add only for last link.
219 * tMEL4, the time for PING_RESPONSE to traverse upstream is similar.
220 * Multiply by 2 to include it as well.
222 total_mel += (__le16_to_cpu(hub->descriptor->u.ss.wHubDelay) +
223 USB_TP_TRANSMISSION_DELAY) * 2;
226 * tMEL3, tPingResponse. Time taken by device to generate PING_RESPONSE
227 * after receiving PING. Also add 2100ns as stated in USB 3.1 C 1.5.2.4
228 * to cover the delay if the PING_RESPONSE is queued behind a Max Packet
230 * Note these delays should be added only once for the entire path, so
231 * add them to the MEL of the device connected to the roothub.
233 if (!hub->hdev->parent)
234 total_mel += USB_PING_RESPONSE_TIME + 2100;
236 udev_lpm_params->mel = total_mel;
240 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
241 * a transition from either U1 or U2.
243 static void usb_set_lpm_pel(struct usb_device *udev,
244 struct usb3_lpm_parameters *udev_lpm_params,
245 unsigned int udev_exit_latency,
247 struct usb3_lpm_parameters *hub_lpm_params,
248 unsigned int hub_exit_latency,
249 unsigned int port_to_port_exit_latency)
251 unsigned int first_link_pel;
252 unsigned int hub_pel;
255 * First, the device sends an LFPS to transition the link between the
256 * device and the parent hub into U0. The exit latency is the bigger of
257 * the device exit latency or the hub exit latency.
259 if (udev_exit_latency > hub_exit_latency)
260 first_link_pel = udev_exit_latency * 1000;
262 first_link_pel = hub_exit_latency * 1000;
265 * When the hub starts to receive the LFPS, there is a slight delay for
266 * it to figure out that one of the ports is sending an LFPS. Then it
267 * will forward the LFPS to its upstream link. The exit latency is the
268 * delay, plus the PEL that we calculated for this hub.
270 hub_pel = port_to_port_exit_latency * 1000 + hub_lpm_params->pel;
273 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
274 * is the greater of the two exit latencies.
276 if (first_link_pel > hub_pel)
277 udev_lpm_params->pel = first_link_pel;
279 udev_lpm_params->pel = hub_pel;
283 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
284 * when a device initiates a transition to U0, until when it will receive the
285 * first packet from the host controller.
287 * Section C.1.5.1 describes the four components to this:
289 * - t2: time for the ERDY to make it from the device to the host.
290 * - t3: a host-specific delay to process the ERDY.
291 * - t4: time for the packet to make it from the host to the device.
293 * t3 is specific to both the xHCI host and the platform the host is integrated
294 * into. The Intel HW folks have said it's negligible, FIXME if a different
295 * vendor says otherwise.
297 static void usb_set_lpm_sel(struct usb_device *udev,
298 struct usb3_lpm_parameters *udev_lpm_params)
300 struct usb_device *parent;
301 unsigned int num_hubs;
302 unsigned int total_sel;
304 /* t1 = device PEL */
305 total_sel = udev_lpm_params->pel;
306 /* How many external hubs are in between the device & the root port. */
307 for (parent = udev->parent, num_hubs = 0; parent->parent;
308 parent = parent->parent)
310 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
312 total_sel += 2100 + 250 * (num_hubs - 1);
314 /* t4 = 250ns * num_hubs */
315 total_sel += 250 * num_hubs;
317 udev_lpm_params->sel = total_sel;
320 static void usb_set_lpm_parameters(struct usb_device *udev)
323 unsigned int port_to_port_delay;
324 unsigned int udev_u1_del;
325 unsigned int udev_u2_del;
326 unsigned int hub_u1_del;
327 unsigned int hub_u2_del;
329 if (!udev->lpm_capable || udev->speed < USB_SPEED_SUPER)
332 /* Skip if the device BOS descriptor couldn't be read */
336 hub = usb_hub_to_struct_hub(udev->parent);
337 /* It doesn't take time to transition the roothub into U0, since it
338 * doesn't have an upstream link.
343 udev_u1_del = udev->bos->ss_cap->bU1devExitLat;
344 udev_u2_del = le16_to_cpu(udev->bos->ss_cap->bU2DevExitLat);
345 hub_u1_del = udev->parent->bos->ss_cap->bU1devExitLat;
346 hub_u2_del = le16_to_cpu(udev->parent->bos->ss_cap->bU2DevExitLat);
348 usb_set_lpm_mel(udev, &udev->u1_params, udev_u1_del,
349 hub, &udev->parent->u1_params, hub_u1_del);
351 usb_set_lpm_mel(udev, &udev->u2_params, udev_u2_del,
352 hub, &udev->parent->u2_params, hub_u2_del);
355 * Appendix C, section C.2.2.2, says that there is a slight delay from
356 * when the parent hub notices the downstream port is trying to
357 * transition to U0 to when the hub initiates a U0 transition on its
358 * upstream port. The section says the delays are tPort2PortU1EL and
359 * tPort2PortU2EL, but it doesn't define what they are.
361 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
362 * about the same delays. Use the maximum delay calculations from those
363 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
364 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
365 * assume the device exit latencies they are talking about are the hub
368 * What do we do if the U2 exit latency is less than the U1 exit
369 * latency? It's possible, although not likely...
371 port_to_port_delay = 1;
373 usb_set_lpm_pel(udev, &udev->u1_params, udev_u1_del,
374 hub, &udev->parent->u1_params, hub_u1_del,
377 if (hub_u2_del > hub_u1_del)
378 port_to_port_delay = 1 + hub_u2_del - hub_u1_del;
380 port_to_port_delay = 1 + hub_u1_del;
382 usb_set_lpm_pel(udev, &udev->u2_params, udev_u2_del,
383 hub, &udev->parent->u2_params, hub_u2_del,
386 /* Now that we've got PEL, calculate SEL. */
387 usb_set_lpm_sel(udev, &udev->u1_params);
388 usb_set_lpm_sel(udev, &udev->u2_params);
391 /* USB 2.0 spec Section 11.24.4.5 */
392 static int get_hub_descriptor(struct usb_device *hdev,
393 struct usb_hub_descriptor *desc)
398 if (hub_is_superspeed(hdev)) {
399 dtype = USB_DT_SS_HUB;
400 size = USB_DT_SS_HUB_SIZE;
403 size = sizeof(struct usb_hub_descriptor);
406 for (i = 0; i < 3; i++) {
407 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
408 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
409 dtype << 8, 0, desc, size,
410 USB_CTRL_GET_TIMEOUT);
411 if (hub_is_superspeed(hdev)) {
414 } else if (ret >= USB_DT_HUB_NONVAR_SIZE + 2) {
415 /* Make sure we have the DeviceRemovable field. */
416 size = USB_DT_HUB_NONVAR_SIZE + desc->bNbrPorts / 8 + 1;
426 * USB 2.0 spec Section 11.24.2.1
428 static int clear_hub_feature(struct usb_device *hdev, int feature)
430 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
431 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
435 * USB 2.0 spec Section 11.24.2.2
437 int usb_clear_port_feature(struct usb_device *hdev, int port1, int feature)
439 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
440 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
445 * USB 2.0 spec Section 11.24.2.13
447 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
449 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
450 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
454 static char *to_led_name(int selector)
471 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
472 * for info about using port indicators
474 static void set_port_led(struct usb_hub *hub, int port1, int selector)
476 struct usb_port *port_dev = hub->ports[port1 - 1];
479 status = set_port_feature(hub->hdev, (selector << 8) | port1,
480 USB_PORT_FEAT_INDICATOR);
481 dev_dbg(&port_dev->dev, "indicator %s status %d\n",
482 to_led_name(selector), status);
485 #define LED_CYCLE_PERIOD ((2*HZ)/3)
487 static void led_work(struct work_struct *work)
489 struct usb_hub *hub =
490 container_of(work, struct usb_hub, leds.work);
491 struct usb_device *hdev = hub->hdev;
493 unsigned changed = 0;
496 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
499 for (i = 0; i < hdev->maxchild; i++) {
500 unsigned selector, mode;
502 /* 30%-50% duty cycle */
504 switch (hub->indicator[i]) {
506 case INDICATOR_CYCLE:
508 selector = HUB_LED_AUTO;
509 mode = INDICATOR_AUTO;
511 /* blinking green = sw attention */
512 case INDICATOR_GREEN_BLINK:
513 selector = HUB_LED_GREEN;
514 mode = INDICATOR_GREEN_BLINK_OFF;
516 case INDICATOR_GREEN_BLINK_OFF:
517 selector = HUB_LED_OFF;
518 mode = INDICATOR_GREEN_BLINK;
520 /* blinking amber = hw attention */
521 case INDICATOR_AMBER_BLINK:
522 selector = HUB_LED_AMBER;
523 mode = INDICATOR_AMBER_BLINK_OFF;
525 case INDICATOR_AMBER_BLINK_OFF:
526 selector = HUB_LED_OFF;
527 mode = INDICATOR_AMBER_BLINK;
529 /* blink green/amber = reserved */
530 case INDICATOR_ALT_BLINK:
531 selector = HUB_LED_GREEN;
532 mode = INDICATOR_ALT_BLINK_OFF;
534 case INDICATOR_ALT_BLINK_OFF:
535 selector = HUB_LED_AMBER;
536 mode = INDICATOR_ALT_BLINK;
541 if (selector != HUB_LED_AUTO)
543 set_port_led(hub, i + 1, selector);
544 hub->indicator[i] = mode;
546 if (!changed && blinkenlights) {
548 cursor %= hdev->maxchild;
549 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
550 hub->indicator[cursor] = INDICATOR_CYCLE;
554 queue_delayed_work(system_power_efficient_wq,
555 &hub->leds, LED_CYCLE_PERIOD);
558 /* use a short timeout for hub/port status fetches */
559 #define USB_STS_TIMEOUT 1000
560 #define USB_STS_RETRIES 5
563 * USB 2.0 spec Section 11.24.2.6
565 static int get_hub_status(struct usb_device *hdev,
566 struct usb_hub_status *data)
568 int i, status = -ETIMEDOUT;
570 for (i = 0; i < USB_STS_RETRIES &&
571 (status == -ETIMEDOUT || status == -EPIPE); i++) {
572 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
573 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
574 data, sizeof(*data), USB_STS_TIMEOUT);
580 * USB 2.0 spec Section 11.24.2.7
581 * USB 3.1 takes into use the wValue and wLength fields, spec Section 10.16.2.6
583 static int get_port_status(struct usb_device *hdev, int port1,
584 void *data, u16 value, u16 length)
586 int i, status = -ETIMEDOUT;
588 for (i = 0; i < USB_STS_RETRIES &&
589 (status == -ETIMEDOUT || status == -EPIPE); i++) {
590 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
591 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, value,
592 port1, data, length, USB_STS_TIMEOUT);
597 static int hub_ext_port_status(struct usb_hub *hub, int port1, int type,
598 u16 *status, u16 *change, u32 *ext_status)
603 if (type != HUB_PORT_STATUS)
606 mutex_lock(&hub->status_mutex);
607 ret = get_port_status(hub->hdev, port1, &hub->status->port, type, len);
610 dev_err(hub->intfdev,
611 "%s failed (err = %d)\n", __func__, ret);
615 *status = le16_to_cpu(hub->status->port.wPortStatus);
616 *change = le16_to_cpu(hub->status->port.wPortChange);
617 if (type != HUB_PORT_STATUS && ext_status)
618 *ext_status = le32_to_cpu(
619 hub->status->port.dwExtPortStatus);
622 mutex_unlock(&hub->status_mutex);
626 static int hub_port_status(struct usb_hub *hub, int port1,
627 u16 *status, u16 *change)
629 return hub_ext_port_status(hub, port1, HUB_PORT_STATUS,
630 status, change, NULL);
633 static void hub_resubmit_irq_urb(struct usb_hub *hub)
638 spin_lock_irqsave(&hub->irq_urb_lock, flags);
640 if (hub->quiescing) {
641 spin_unlock_irqrestore(&hub->irq_urb_lock, flags);
645 status = usb_submit_urb(hub->urb, GFP_ATOMIC);
646 if (status && status != -ENODEV && status != -EPERM &&
647 status != -ESHUTDOWN) {
648 dev_err(hub->intfdev, "resubmit --> %d\n", status);
649 mod_timer(&hub->irq_urb_retry, jiffies + HZ);
652 spin_unlock_irqrestore(&hub->irq_urb_lock, flags);
655 static void hub_retry_irq_urb(struct timer_list *t)
657 struct usb_hub *hub = from_timer(hub, t, irq_urb_retry);
659 hub_resubmit_irq_urb(hub);
663 static void kick_hub_wq(struct usb_hub *hub)
665 struct usb_interface *intf;
667 if (hub->disconnected || work_pending(&hub->events))
671 * Suppress autosuspend until the event is proceed.
673 * Be careful and make sure that the symmetric operation is
674 * always called. We are here only when there is no pending
675 * work for this hub. Therefore put the interface either when
676 * the new work is called or when it is canceled.
678 intf = to_usb_interface(hub->intfdev);
679 usb_autopm_get_interface_no_resume(intf);
682 if (queue_work(hub_wq, &hub->events))
685 /* the work has already been scheduled */
686 usb_autopm_put_interface_async(intf);
690 void usb_kick_hub_wq(struct usb_device *hdev)
692 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
699 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
700 * Notification, which indicates it had initiated remote wakeup.
702 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
703 * device initiates resume, so the USB core will not receive notice of the
704 * resume through the normal hub interrupt URB.
706 void usb_wakeup_notification(struct usb_device *hdev,
707 unsigned int portnum)
710 struct usb_port *port_dev;
715 hub = usb_hub_to_struct_hub(hdev);
717 port_dev = hub->ports[portnum - 1];
718 if (port_dev && port_dev->child)
719 pm_wakeup_event(&port_dev->child->dev, 0);
721 set_bit(portnum, hub->wakeup_bits);
725 EXPORT_SYMBOL_GPL(usb_wakeup_notification);
727 /* completion function, fires on port status changes and various faults */
728 static void hub_irq(struct urb *urb)
730 struct usb_hub *hub = urb->context;
731 int status = urb->status;
736 case -ENOENT: /* synchronous unlink */
737 case -ECONNRESET: /* async unlink */
738 case -ESHUTDOWN: /* hardware going away */
741 default: /* presumably an error */
742 /* Cause a hub reset after 10 consecutive errors */
743 dev_dbg(hub->intfdev, "transfer --> %d\n", status);
744 if ((++hub->nerrors < 10) || hub->error)
749 /* let hub_wq handle things */
750 case 0: /* we got data: port status changed */
752 for (i = 0; i < urb->actual_length; ++i)
753 bits |= ((unsigned long) ((*hub->buffer)[i]))
755 hub->event_bits[0] = bits;
761 /* Something happened, let hub_wq figure it out */
765 hub_resubmit_irq_urb(hub);
768 /* USB 2.0 spec Section 11.24.2.3 */
770 hub_clear_tt_buffer(struct usb_device *hdev, u16 devinfo, u16 tt)
772 /* Need to clear both directions for control ep */
773 if (((devinfo >> 11) & USB_ENDPOINT_XFERTYPE_MASK) ==
774 USB_ENDPOINT_XFER_CONTROL) {
775 int status = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
776 HUB_CLEAR_TT_BUFFER, USB_RT_PORT,
777 devinfo ^ 0x8000, tt, NULL, 0, 1000);
781 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
782 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
787 * enumeration blocks hub_wq for a long time. we use keventd instead, since
788 * long blocking there is the exception, not the rule. accordingly, HCDs
789 * talking to TTs must queue control transfers (not just bulk and iso), so
790 * both can talk to the same hub concurrently.
792 static void hub_tt_work(struct work_struct *work)
794 struct usb_hub *hub =
795 container_of(work, struct usb_hub, tt.clear_work);
798 spin_lock_irqsave(&hub->tt.lock, flags);
799 while (!list_empty(&hub->tt.clear_list)) {
800 struct list_head *next;
801 struct usb_tt_clear *clear;
802 struct usb_device *hdev = hub->hdev;
803 const struct hc_driver *drv;
806 next = hub->tt.clear_list.next;
807 clear = list_entry(next, struct usb_tt_clear, clear_list);
808 list_del(&clear->clear_list);
810 /* drop lock so HCD can concurrently report other TT errors */
811 spin_unlock_irqrestore(&hub->tt.lock, flags);
812 status = hub_clear_tt_buffer(hdev, clear->devinfo, clear->tt);
813 if (status && status != -ENODEV)
815 "clear tt %d (%04x) error %d\n",
816 clear->tt, clear->devinfo, status);
818 /* Tell the HCD, even if the operation failed */
819 drv = clear->hcd->driver;
820 if (drv->clear_tt_buffer_complete)
821 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
824 spin_lock_irqsave(&hub->tt.lock, flags);
826 spin_unlock_irqrestore(&hub->tt.lock, flags);
830 * usb_hub_set_port_power - control hub port's power state
831 * @hdev: USB device belonging to the usb hub
834 * @set: expected status
836 * call this function to control port's power via setting or
837 * clearing the port's PORT_POWER feature.
839 * Return: 0 if successful. A negative error code otherwise.
841 int usb_hub_set_port_power(struct usb_device *hdev, struct usb_hub *hub,
847 ret = set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
849 ret = usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
855 set_bit(port1, hub->power_bits);
857 clear_bit(port1, hub->power_bits);
862 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
863 * @urb: an URB associated with the failed or incomplete split transaction
865 * High speed HCDs use this to tell the hub driver that some split control or
866 * bulk transaction failed in a way that requires clearing internal state of
867 * a transaction translator. This is normally detected (and reported) from
870 * It may not be possible for that hub to handle additional full (or low)
871 * speed transactions until that state is fully cleared out.
873 * Return: 0 if successful. A negative error code otherwise.
875 int usb_hub_clear_tt_buffer(struct urb *urb)
877 struct usb_device *udev = urb->dev;
878 int pipe = urb->pipe;
879 struct usb_tt *tt = udev->tt;
881 struct usb_tt_clear *clear;
883 /* we've got to cope with an arbitrary number of pending TT clears,
884 * since each TT has "at least two" buffers that can need it (and
885 * there can be many TTs per hub). even if they're uncommon.
887 clear = kmalloc(sizeof *clear, GFP_ATOMIC);
889 dev_err(&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
890 /* FIXME recover somehow ... RESET_TT? */
894 /* info that CLEAR_TT_BUFFER needs */
895 clear->tt = tt->multi ? udev->ttport : 1;
896 clear->devinfo = usb_pipeendpoint (pipe);
897 clear->devinfo |= ((u16)udev->devaddr) << 4;
898 clear->devinfo |= usb_pipecontrol(pipe)
899 ? (USB_ENDPOINT_XFER_CONTROL << 11)
900 : (USB_ENDPOINT_XFER_BULK << 11);
901 if (usb_pipein(pipe))
902 clear->devinfo |= 1 << 15;
904 /* info for completion callback */
905 clear->hcd = bus_to_hcd(udev->bus);
908 /* tell keventd to clear state for this TT */
909 spin_lock_irqsave(&tt->lock, flags);
910 list_add_tail(&clear->clear_list, &tt->clear_list);
911 schedule_work(&tt->clear_work);
912 spin_unlock_irqrestore(&tt->lock, flags);
915 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
917 static void hub_power_on(struct usb_hub *hub, bool do_delay)
921 /* Enable power on each port. Some hubs have reserved values
922 * of LPSM (> 2) in their descriptors, even though they are
923 * USB 2.0 hubs. Some hubs do not implement port-power switching
924 * but only emulate it. In all cases, the ports won't work
925 * unless we send these messages to the hub.
927 if (hub_is_port_power_switchable(hub))
928 dev_dbg(hub->intfdev, "enabling power on all ports\n");
930 dev_dbg(hub->intfdev, "trying to enable port power on "
931 "non-switchable hub\n");
932 for (port1 = 1; port1 <= hub->hdev->maxchild; port1++)
933 if (test_bit(port1, hub->power_bits))
934 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
936 usb_clear_port_feature(hub->hdev, port1,
937 USB_PORT_FEAT_POWER);
939 msleep(hub_power_on_good_delay(hub));
942 static int hub_hub_status(struct usb_hub *hub,
943 u16 *status, u16 *change)
947 mutex_lock(&hub->status_mutex);
948 ret = get_hub_status(hub->hdev, &hub->status->hub);
951 dev_err(hub->intfdev,
952 "%s failed (err = %d)\n", __func__, ret);
954 *status = le16_to_cpu(hub->status->hub.wHubStatus);
955 *change = le16_to_cpu(hub->status->hub.wHubChange);
958 mutex_unlock(&hub->status_mutex);
962 static int hub_set_port_link_state(struct usb_hub *hub, int port1,
963 unsigned int link_status)
965 return set_port_feature(hub->hdev,
966 port1 | (link_status << 3),
967 USB_PORT_FEAT_LINK_STATE);
971 * Disable a port and mark a logical connect-change event, so that some
972 * time later hub_wq will disconnect() any existing usb_device on the port
973 * and will re-enumerate if there actually is a device attached.
975 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
977 dev_dbg(&hub->ports[port1 - 1]->dev, "logical disconnect\n");
978 hub_port_disable(hub, port1, 1);
980 /* FIXME let caller ask to power down the port:
981 * - some devices won't enumerate without a VBUS power cycle
982 * - SRP saves power that way
983 * - ... new call, TBD ...
984 * That's easy if this hub can switch power per-port, and
985 * hub_wq reactivates the port later (timer, SRP, etc).
986 * Powerdown must be optional, because of reset/DFU.
989 set_bit(port1, hub->change_bits);
994 * usb_remove_device - disable a device's port on its parent hub
995 * @udev: device to be disabled and removed
996 * Context: @udev locked, must be able to sleep.
998 * After @udev's port has been disabled, hub_wq is notified and it will
999 * see that the device has been disconnected. When the device is
1000 * physically unplugged and something is plugged in, the events will
1001 * be received and processed normally.
1003 * Return: 0 if successful. A negative error code otherwise.
1005 int usb_remove_device(struct usb_device *udev)
1007 struct usb_hub *hub;
1008 struct usb_interface *intf;
1011 if (!udev->parent) /* Can't remove a root hub */
1013 hub = usb_hub_to_struct_hub(udev->parent);
1014 intf = to_usb_interface(hub->intfdev);
1016 ret = usb_autopm_get_interface(intf);
1020 set_bit(udev->portnum, hub->removed_bits);
1021 hub_port_logical_disconnect(hub, udev->portnum);
1022 usb_autopm_put_interface(intf);
1026 enum hub_activation_type {
1027 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
1028 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
1031 static void hub_init_func2(struct work_struct *ws);
1032 static void hub_init_func3(struct work_struct *ws);
1034 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
1036 struct usb_device *hdev = hub->hdev;
1037 struct usb_hcd *hcd;
1041 bool need_debounce_delay = false;
1044 /* Continue a partial initialization */
1045 if (type == HUB_INIT2 || type == HUB_INIT3) {
1046 device_lock(&hdev->dev);
1048 /* Was the hub disconnected while we were waiting? */
1049 if (hub->disconnected)
1051 if (type == HUB_INIT2)
1057 /* The superspeed hub except for root hub has to use Hub Depth
1058 * value as an offset into the route string to locate the bits
1059 * it uses to determine the downstream port number. So hub driver
1060 * should send a set hub depth request to superspeed hub after
1061 * the superspeed hub is set configuration in initialization or
1064 * After a resume, port power should still be on.
1065 * For any other type of activation, turn it on.
1067 if (type != HUB_RESUME) {
1068 if (hdev->parent && hub_is_superspeed(hdev)) {
1069 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
1070 HUB_SET_DEPTH, USB_RT_HUB,
1071 hdev->level - 1, 0, NULL, 0,
1072 USB_CTRL_SET_TIMEOUT);
1074 dev_err(hub->intfdev,
1075 "set hub depth failed\n");
1078 /* Speed up system boot by using a delayed_work for the
1079 * hub's initial power-up delays. This is pretty awkward
1080 * and the implementation looks like a home-brewed sort of
1081 * setjmp/longjmp, but it saves at least 100 ms for each
1082 * root hub (assuming usbcore is compiled into the kernel
1083 * rather than as a module). It adds up.
1085 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1086 * because for those activation types the ports have to be
1087 * operational when we return. In theory this could be done
1088 * for HUB_POST_RESET, but it's easier not to.
1090 if (type == HUB_INIT) {
1091 delay = hub_power_on_good_delay(hub);
1093 hub_power_on(hub, false);
1094 INIT_DELAYED_WORK(&hub->init_work, hub_init_func2);
1095 queue_delayed_work(system_power_efficient_wq,
1097 msecs_to_jiffies(delay));
1099 /* Suppress autosuspend until init is done */
1100 usb_autopm_get_interface_no_resume(
1101 to_usb_interface(hub->intfdev));
1102 return; /* Continues at init2: below */
1103 } else if (type == HUB_RESET_RESUME) {
1104 /* The internal host controller state for the hub device
1105 * may be gone after a host power loss on system resume.
1106 * Update the device's info so the HW knows it's a hub.
1108 hcd = bus_to_hcd(hdev->bus);
1109 if (hcd->driver->update_hub_device) {
1110 ret = hcd->driver->update_hub_device(hcd, hdev,
1111 &hub->tt, GFP_NOIO);
1113 dev_err(hub->intfdev,
1114 "Host not accepting hub info update\n");
1115 dev_err(hub->intfdev,
1116 "LS/FS devices and hubs may not work under this hub\n");
1119 hub_power_on(hub, true);
1121 hub_power_on(hub, true);
1123 /* Give some time on remote wakeup to let links to transit to U0 */
1124 } else if (hub_is_superspeed(hub->hdev))
1130 * Check each port and set hub->change_bits to let hub_wq know
1131 * which ports need attention.
1133 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
1134 struct usb_port *port_dev = hub->ports[port1 - 1];
1135 struct usb_device *udev = port_dev->child;
1136 u16 portstatus, portchange;
1138 portstatus = portchange = 0;
1139 status = hub_port_status(hub, port1, &portstatus, &portchange);
1143 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1144 dev_dbg(&port_dev->dev, "status %04x change %04x\n",
1145 portstatus, portchange);
1148 * After anything other than HUB_RESUME (i.e., initialization
1149 * or any sort of reset), every port should be disabled.
1150 * Unconnected ports should likewise be disabled (paranoia),
1151 * and so should ports for which we have no usb_device.
1153 if ((portstatus & USB_PORT_STAT_ENABLE) && (
1154 type != HUB_RESUME ||
1155 !(portstatus & USB_PORT_STAT_CONNECTION) ||
1157 udev->state == USB_STATE_NOTATTACHED)) {
1159 * USB3 protocol ports will automatically transition
1160 * to Enabled state when detect an USB3.0 device attach.
1161 * Do not disable USB3 protocol ports, just pretend
1164 portstatus &= ~USB_PORT_STAT_ENABLE;
1165 if (!hub_is_superspeed(hdev))
1166 usb_clear_port_feature(hdev, port1,
1167 USB_PORT_FEAT_ENABLE);
1170 /* Make sure a warm-reset request is handled by port_event */
1171 if (type == HUB_RESUME &&
1172 hub_port_warm_reset_required(hub, port1, portstatus))
1173 set_bit(port1, hub->event_bits);
1176 * Add debounce if USB3 link is in polling/link training state.
1177 * Link will automatically transition to Enabled state after
1178 * link training completes.
1180 if (hub_is_superspeed(hdev) &&
1181 ((portstatus & USB_PORT_STAT_LINK_STATE) ==
1182 USB_SS_PORT_LS_POLLING))
1183 need_debounce_delay = true;
1185 /* Clear status-change flags; we'll debounce later */
1186 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1187 need_debounce_delay = true;
1188 usb_clear_port_feature(hub->hdev, port1,
1189 USB_PORT_FEAT_C_CONNECTION);
1191 if (portchange & USB_PORT_STAT_C_ENABLE) {
1192 need_debounce_delay = true;
1193 usb_clear_port_feature(hub->hdev, port1,
1194 USB_PORT_FEAT_C_ENABLE);
1196 if (portchange & USB_PORT_STAT_C_RESET) {
1197 need_debounce_delay = true;
1198 usb_clear_port_feature(hub->hdev, port1,
1199 USB_PORT_FEAT_C_RESET);
1201 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
1202 hub_is_superspeed(hub->hdev)) {
1203 need_debounce_delay = true;
1204 usb_clear_port_feature(hub->hdev, port1,
1205 USB_PORT_FEAT_C_BH_PORT_RESET);
1207 /* We can forget about a "removed" device when there's a
1208 * physical disconnect or the connect status changes.
1210 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
1211 (portchange & USB_PORT_STAT_C_CONNECTION))
1212 clear_bit(port1, hub->removed_bits);
1214 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
1215 /* Tell hub_wq to disconnect the device or
1216 * check for a new connection or over current condition.
1217 * Based on USB2.0 Spec Section 11.12.5,
1218 * C_PORT_OVER_CURRENT could be set while
1219 * PORT_OVER_CURRENT is not. So check for any of them.
1221 if (udev || (portstatus & USB_PORT_STAT_CONNECTION) ||
1222 (portchange & USB_PORT_STAT_C_CONNECTION) ||
1223 (portstatus & USB_PORT_STAT_OVERCURRENT) ||
1224 (portchange & USB_PORT_STAT_C_OVERCURRENT))
1225 set_bit(port1, hub->change_bits);
1227 } else if (portstatus & USB_PORT_STAT_ENABLE) {
1228 bool port_resumed = (portstatus &
1229 USB_PORT_STAT_LINK_STATE) ==
1231 /* The power session apparently survived the resume.
1232 * If there was an overcurrent or suspend change
1233 * (i.e., remote wakeup request), have hub_wq
1234 * take care of it. Look at the port link state
1235 * for USB 3.0 hubs, since they don't have a suspend
1236 * change bit, and they don't set the port link change
1237 * bit on device-initiated resume.
1239 if (portchange || (hub_is_superspeed(hub->hdev) &&
1241 set_bit(port1, hub->event_bits);
1243 } else if (udev->persist_enabled) {
1245 udev->reset_resume = 1;
1247 /* Don't set the change_bits when the device
1250 if (test_bit(port1, hub->power_bits))
1251 set_bit(port1, hub->change_bits);
1254 /* The power session is gone; tell hub_wq */
1255 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1256 set_bit(port1, hub->change_bits);
1260 /* If no port-status-change flags were set, we don't need any
1261 * debouncing. If flags were set we can try to debounce the
1262 * ports all at once right now, instead of letting hub_wq do them
1263 * one at a time later on.
1265 * If any port-status changes do occur during this delay, hub_wq
1266 * will see them later and handle them normally.
1268 if (need_debounce_delay) {
1269 delay = HUB_DEBOUNCE_STABLE;
1271 /* Don't do a long sleep inside a workqueue routine */
1272 if (type == HUB_INIT2) {
1273 INIT_DELAYED_WORK(&hub->init_work, hub_init_func3);
1274 queue_delayed_work(system_power_efficient_wq,
1276 msecs_to_jiffies(delay));
1277 device_unlock(&hdev->dev);
1278 return; /* Continues at init3: below */
1286 status = usb_submit_urb(hub->urb, GFP_NOIO);
1288 dev_err(hub->intfdev, "activate --> %d\n", status);
1289 if (hub->has_indicators && blinkenlights)
1290 queue_delayed_work(system_power_efficient_wq,
1291 &hub->leds, LED_CYCLE_PERIOD);
1293 /* Scan all ports that need attention */
1296 if (type == HUB_INIT2 || type == HUB_INIT3) {
1297 /* Allow autosuspend if it was suppressed */
1299 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
1300 device_unlock(&hdev->dev);
1306 /* Implement the continuations for the delays above */
1307 static void hub_init_func2(struct work_struct *ws)
1309 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1311 hub_activate(hub, HUB_INIT2);
1314 static void hub_init_func3(struct work_struct *ws)
1316 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1318 hub_activate(hub, HUB_INIT3);
1321 enum hub_quiescing_type {
1322 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
1325 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
1327 struct usb_device *hdev = hub->hdev;
1328 unsigned long flags;
1331 /* hub_wq and related activity won't re-trigger */
1332 spin_lock_irqsave(&hub->irq_urb_lock, flags);
1334 spin_unlock_irqrestore(&hub->irq_urb_lock, flags);
1336 if (type != HUB_SUSPEND) {
1337 /* Disconnect all the children */
1338 for (i = 0; i < hdev->maxchild; ++i) {
1339 if (hub->ports[i]->child)
1340 usb_disconnect(&hub->ports[i]->child);
1344 /* Stop hub_wq and related activity */
1345 del_timer_sync(&hub->irq_urb_retry);
1346 usb_kill_urb(hub->urb);
1347 if (hub->has_indicators)
1348 cancel_delayed_work_sync(&hub->leds);
1350 flush_work(&hub->tt.clear_work);
1353 static void hub_pm_barrier_for_all_ports(struct usb_hub *hub)
1357 for (i = 0; i < hub->hdev->maxchild; ++i)
1358 pm_runtime_barrier(&hub->ports[i]->dev);
1361 /* caller has locked the hub device */
1362 static int hub_pre_reset(struct usb_interface *intf)
1364 struct usb_hub *hub = usb_get_intfdata(intf);
1366 hub_quiesce(hub, HUB_PRE_RESET);
1368 hub_pm_barrier_for_all_ports(hub);
1372 /* caller has locked the hub device */
1373 static int hub_post_reset(struct usb_interface *intf)
1375 struct usb_hub *hub = usb_get_intfdata(intf);
1378 hub_pm_barrier_for_all_ports(hub);
1379 hub_activate(hub, HUB_POST_RESET);
1383 static int hub_configure(struct usb_hub *hub,
1384 struct usb_endpoint_descriptor *endpoint)
1386 struct usb_hcd *hcd;
1387 struct usb_device *hdev = hub->hdev;
1388 struct device *hub_dev = hub->intfdev;
1389 u16 hubstatus, hubchange;
1390 u16 wHubCharacteristics;
1393 char *message = "out of memory";
1398 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
1404 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1409 mutex_init(&hub->status_mutex);
1411 hub->descriptor = kzalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1412 if (!hub->descriptor) {
1417 /* Request the entire hub descriptor.
1418 * hub->descriptor can handle USB_MAXCHILDREN ports,
1419 * but a (non-SS) hub can/will return fewer bytes here.
1421 ret = get_hub_descriptor(hdev, hub->descriptor);
1423 message = "can't read hub descriptor";
1427 maxchild = USB_MAXCHILDREN;
1428 if (hub_is_superspeed(hdev))
1429 maxchild = min_t(unsigned, maxchild, USB_SS_MAXPORTS);
1431 if (hub->descriptor->bNbrPorts > maxchild) {
1432 message = "hub has too many ports!";
1435 } else if (hub->descriptor->bNbrPorts == 0) {
1436 message = "hub doesn't have any ports!";
1442 * Accumulate wHubDelay + 40ns for every hub in the tree of devices.
1443 * The resulting value will be used for SetIsochDelay() request.
1445 if (hub_is_superspeed(hdev) || hub_is_superspeedplus(hdev)) {
1446 u32 delay = __le16_to_cpu(hub->descriptor->u.ss.wHubDelay);
1449 delay += hdev->parent->hub_delay;
1451 delay += USB_TP_TRANSMISSION_DELAY;
1452 hdev->hub_delay = min_t(u32, delay, USB_TP_TRANSMISSION_DELAY_MAX);
1455 maxchild = hub->descriptor->bNbrPorts;
1456 dev_info(hub_dev, "%d port%s detected\n", maxchild,
1457 (maxchild == 1) ? "" : "s");
1459 hub->ports = kcalloc(maxchild, sizeof(struct usb_port *), GFP_KERNEL);
1465 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1466 if (hub_is_superspeed(hdev)) {
1474 /* FIXME for USB 3.0, skip for now */
1475 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1476 !(hub_is_superspeed(hdev))) {
1477 char portstr[USB_MAXCHILDREN + 1];
1479 for (i = 0; i < maxchild; i++)
1480 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1481 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1483 portstr[maxchild] = 0;
1484 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1486 dev_dbg(hub_dev, "standalone hub\n");
1488 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1489 case HUB_CHAR_COMMON_LPSM:
1490 dev_dbg(hub_dev, "ganged power switching\n");
1492 case HUB_CHAR_INDV_PORT_LPSM:
1493 dev_dbg(hub_dev, "individual port power switching\n");
1495 case HUB_CHAR_NO_LPSM:
1497 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1501 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1502 case HUB_CHAR_COMMON_OCPM:
1503 dev_dbg(hub_dev, "global over-current protection\n");
1505 case HUB_CHAR_INDV_PORT_OCPM:
1506 dev_dbg(hub_dev, "individual port over-current protection\n");
1508 case HUB_CHAR_NO_OCPM:
1510 dev_dbg(hub_dev, "no over-current protection\n");
1514 spin_lock_init(&hub->tt.lock);
1515 INIT_LIST_HEAD(&hub->tt.clear_list);
1516 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1517 switch (hdev->descriptor.bDeviceProtocol) {
1520 case USB_HUB_PR_HS_SINGLE_TT:
1521 dev_dbg(hub_dev, "Single TT\n");
1524 case USB_HUB_PR_HS_MULTI_TT:
1525 ret = usb_set_interface(hdev, 0, 1);
1527 dev_dbg(hub_dev, "TT per port\n");
1530 dev_err(hub_dev, "Using single TT (err %d)\n",
1535 /* USB 3.0 hubs don't have a TT */
1538 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1539 hdev->descriptor.bDeviceProtocol);
1543 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1544 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1545 case HUB_TTTT_8_BITS:
1546 if (hdev->descriptor.bDeviceProtocol != 0) {
1547 hub->tt.think_time = 666;
1548 dev_dbg(hub_dev, "TT requires at most %d "
1549 "FS bit times (%d ns)\n",
1550 8, hub->tt.think_time);
1553 case HUB_TTTT_16_BITS:
1554 hub->tt.think_time = 666 * 2;
1555 dev_dbg(hub_dev, "TT requires at most %d "
1556 "FS bit times (%d ns)\n",
1557 16, hub->tt.think_time);
1559 case HUB_TTTT_24_BITS:
1560 hub->tt.think_time = 666 * 3;
1561 dev_dbg(hub_dev, "TT requires at most %d "
1562 "FS bit times (%d ns)\n",
1563 24, hub->tt.think_time);
1565 case HUB_TTTT_32_BITS:
1566 hub->tt.think_time = 666 * 4;
1567 dev_dbg(hub_dev, "TT requires at most %d "
1568 "FS bit times (%d ns)\n",
1569 32, hub->tt.think_time);
1573 /* probe() zeroes hub->indicator[] */
1574 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1575 hub->has_indicators = 1;
1576 dev_dbg(hub_dev, "Port indicators are supported\n");
1579 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1580 hub->descriptor->bPwrOn2PwrGood * 2);
1582 /* power budgeting mostly matters with bus-powered hubs,
1583 * and battery-powered root hubs (may provide just 8 mA).
1585 ret = usb_get_std_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1587 message = "can't get hub status";
1590 hcd = bus_to_hcd(hdev->bus);
1591 if (hdev == hdev->bus->root_hub) {
1592 if (hcd->power_budget > 0)
1593 hdev->bus_mA = hcd->power_budget;
1595 hdev->bus_mA = full_load * maxchild;
1596 if (hdev->bus_mA >= full_load)
1597 hub->mA_per_port = full_load;
1599 hub->mA_per_port = hdev->bus_mA;
1600 hub->limited_power = 1;
1602 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1603 int remaining = hdev->bus_mA -
1604 hub->descriptor->bHubContrCurrent;
1606 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1607 hub->descriptor->bHubContrCurrent);
1608 hub->limited_power = 1;
1610 if (remaining < maxchild * unit_load)
1612 "insufficient power available "
1613 "to use all downstream ports\n");
1614 hub->mA_per_port = unit_load; /* 7.2.1 */
1616 } else { /* Self-powered external hub */
1617 /* FIXME: What about battery-powered external hubs that
1618 * provide less current per port? */
1619 hub->mA_per_port = full_load;
1621 if (hub->mA_per_port < full_load)
1622 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1625 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1627 message = "can't get hub status";
1631 /* local power status reports aren't always correct */
1632 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1633 dev_dbg(hub_dev, "local power source is %s\n",
1634 (hubstatus & HUB_STATUS_LOCAL_POWER)
1635 ? "lost (inactive)" : "good");
1637 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1638 dev_dbg(hub_dev, "%sover-current condition exists\n",
1639 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1641 /* set up the interrupt endpoint
1642 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1643 * bytes as USB2.0[11.12.3] says because some hubs are known
1644 * to send more data (and thus cause overflow). For root hubs,
1645 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1646 * to be big enough for at least USB_MAXCHILDREN ports. */
1647 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1648 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1650 if (maxp > sizeof(*hub->buffer))
1651 maxp = sizeof(*hub->buffer);
1653 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1659 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1660 hub, endpoint->bInterval);
1662 /* maybe cycle the hub leds */
1663 if (hub->has_indicators && blinkenlights)
1664 hub->indicator[0] = INDICATOR_CYCLE;
1666 mutex_lock(&usb_port_peer_mutex);
1667 for (i = 0; i < maxchild; i++) {
1668 ret = usb_hub_create_port_device(hub, i + 1);
1670 dev_err(hub->intfdev,
1671 "couldn't create port%d device.\n", i + 1);
1676 for (i = 0; i < hdev->maxchild; i++) {
1677 struct usb_port *port_dev = hub->ports[i];
1679 pm_runtime_put(&port_dev->dev);
1682 mutex_unlock(&usb_port_peer_mutex);
1686 /* Update the HCD's internal representation of this hub before hub_wq
1687 * starts getting port status changes for devices under the hub.
1689 if (hcd->driver->update_hub_device) {
1690 ret = hcd->driver->update_hub_device(hcd, hdev,
1691 &hub->tt, GFP_KERNEL);
1693 message = "can't update HCD hub info";
1698 usb_hub_adjust_deviceremovable(hdev, hub->descriptor);
1700 hub_activate(hub, HUB_INIT);
1704 dev_err(hub_dev, "config failed, %s (err %d)\n",
1706 /* hub_disconnect() frees urb and descriptor */
1710 static void hub_release(struct kref *kref)
1712 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1714 usb_put_dev(hub->hdev);
1715 usb_put_intf(to_usb_interface(hub->intfdev));
1719 void hub_get(struct usb_hub *hub)
1721 kref_get(&hub->kref);
1724 void hub_put(struct usb_hub *hub)
1726 kref_put(&hub->kref, hub_release);
1729 static unsigned highspeed_hubs;
1731 static void hub_disconnect(struct usb_interface *intf)
1733 struct usb_hub *hub = usb_get_intfdata(intf);
1734 struct usb_device *hdev = interface_to_usbdev(intf);
1738 * Stop adding new hub events. We do not want to block here and thus
1739 * will not try to remove any pending work item.
1741 hub->disconnected = 1;
1743 /* Disconnect all children and quiesce the hub */
1745 hub_quiesce(hub, HUB_DISCONNECT);
1747 mutex_lock(&usb_port_peer_mutex);
1749 /* Avoid races with recursively_mark_NOTATTACHED() */
1750 spin_lock_irq(&device_state_lock);
1751 port1 = hdev->maxchild;
1753 usb_set_intfdata(intf, NULL);
1754 spin_unlock_irq(&device_state_lock);
1756 for (; port1 > 0; --port1)
1757 usb_hub_remove_port_device(hub, port1);
1759 mutex_unlock(&usb_port_peer_mutex);
1761 if (hub->hdev->speed == USB_SPEED_HIGH)
1764 usb_free_urb(hub->urb);
1766 kfree(hub->descriptor);
1770 pm_suspend_ignore_children(&intf->dev, false);
1772 if (hub->quirk_disable_autosuspend)
1773 usb_autopm_put_interface(intf);
1778 static bool hub_descriptor_is_sane(struct usb_host_interface *desc)
1780 /* Some hubs have a subclass of 1, which AFAICT according to the */
1781 /* specs is not defined, but it works */
1782 if (desc->desc.bInterfaceSubClass != 0 &&
1783 desc->desc.bInterfaceSubClass != 1)
1786 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1787 if (desc->desc.bNumEndpoints != 1)
1790 /* If the first endpoint is not interrupt IN, we'd better punt! */
1791 if (!usb_endpoint_is_int_in(&desc->endpoint[0].desc))
1797 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1799 struct usb_host_interface *desc;
1800 struct usb_device *hdev;
1801 struct usb_hub *hub;
1803 desc = intf->cur_altsetting;
1804 hdev = interface_to_usbdev(intf);
1807 * Set default autosuspend delay as 0 to speedup bus suspend,
1808 * based on the below considerations:
1810 * - Unlike other drivers, the hub driver does not rely on the
1811 * autosuspend delay to provide enough time to handle a wakeup
1812 * event, and the submitted status URB is just to check future
1813 * change on hub downstream ports, so it is safe to do it.
1815 * - The patch might cause one or more auto supend/resume for
1816 * below very rare devices when they are plugged into hub
1819 * devices having trouble initializing, and disconnect
1820 * themselves from the bus and then reconnect a second
1823 * devices just for downloading firmware, and disconnects
1824 * themselves after completing it
1826 * For these quite rare devices, their drivers may change the
1827 * autosuspend delay of their parent hub in the probe() to one
1828 * appropriate value to avoid the subtle problem if someone
1831 * - The patch may cause one or more auto suspend/resume on
1832 * hub during running 'lsusb', but it is probably too
1833 * infrequent to worry about.
1835 * - Change autosuspend delay of hub can avoid unnecessary auto
1836 * suspend timer for hub, also may decrease power consumption
1839 * - If user has indicated to prevent autosuspend by passing
1840 * usbcore.autosuspend = -1 then keep autosuspend disabled.
1843 if (hdev->dev.power.autosuspend_delay >= 0)
1844 pm_runtime_set_autosuspend_delay(&hdev->dev, 0);
1848 * Hubs have proper suspend/resume support, except for root hubs
1849 * where the controller driver doesn't have bus_suspend and
1850 * bus_resume methods.
1852 if (hdev->parent) { /* normal device */
1853 usb_enable_autosuspend(hdev);
1854 } else { /* root hub */
1855 const struct hc_driver *drv = bus_to_hcd(hdev->bus)->driver;
1857 if (drv->bus_suspend && drv->bus_resume)
1858 usb_enable_autosuspend(hdev);
1861 if (hdev->level == MAX_TOPO_LEVEL) {
1863 "Unsupported bus topology: hub nested too deep\n");
1867 #ifdef CONFIG_USB_OTG_DISABLE_EXTERNAL_HUB
1869 dev_warn(&intf->dev, "ignoring external hub\n");
1874 if (!hub_descriptor_is_sane(desc)) {
1875 dev_err(&intf->dev, "bad descriptor, ignoring hub\n");
1879 /* We found a hub */
1880 dev_info(&intf->dev, "USB hub found\n");
1882 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1886 kref_init(&hub->kref);
1887 hub->intfdev = &intf->dev;
1889 INIT_DELAYED_WORK(&hub->leds, led_work);
1890 INIT_DELAYED_WORK(&hub->init_work, NULL);
1891 INIT_WORK(&hub->events, hub_event);
1892 spin_lock_init(&hub->irq_urb_lock);
1893 timer_setup(&hub->irq_urb_retry, hub_retry_irq_urb, 0);
1897 usb_set_intfdata(intf, hub);
1898 intf->needs_remote_wakeup = 1;
1899 pm_suspend_ignore_children(&intf->dev, true);
1901 if (hdev->speed == USB_SPEED_HIGH)
1904 if (id->driver_info & HUB_QUIRK_CHECK_PORT_AUTOSUSPEND)
1905 hub->quirk_check_port_auto_suspend = 1;
1907 if (id->driver_info & HUB_QUIRK_DISABLE_AUTOSUSPEND) {
1908 hub->quirk_disable_autosuspend = 1;
1909 usb_autopm_get_interface_no_resume(intf);
1912 if (hub_configure(hub, &desc->endpoint[0].desc) >= 0)
1915 hub_disconnect(intf);
1920 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1922 struct usb_device *hdev = interface_to_usbdev(intf);
1923 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1925 /* assert ifno == 0 (part of hub spec) */
1927 case USBDEVFS_HUB_PORTINFO: {
1928 struct usbdevfs_hub_portinfo *info = user_data;
1931 spin_lock_irq(&device_state_lock);
1932 if (hdev->devnum <= 0)
1935 info->nports = hdev->maxchild;
1936 for (i = 0; i < info->nports; i++) {
1937 if (hub->ports[i]->child == NULL)
1941 hub->ports[i]->child->devnum;
1944 spin_unlock_irq(&device_state_lock);
1946 return info->nports + 1;
1955 * Allow user programs to claim ports on a hub. When a device is attached
1956 * to one of these "claimed" ports, the program will "own" the device.
1958 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1959 struct usb_dev_state ***ppowner)
1961 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1963 if (hdev->state == USB_STATE_NOTATTACHED)
1965 if (port1 == 0 || port1 > hdev->maxchild)
1968 /* Devices not managed by the hub driver
1969 * will always have maxchild equal to 0.
1971 *ppowner = &(hub->ports[port1 - 1]->port_owner);
1975 /* In the following three functions, the caller must hold hdev's lock */
1976 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
1977 struct usb_dev_state *owner)
1980 struct usb_dev_state **powner;
1982 rc = find_port_owner(hdev, port1, &powner);
1990 EXPORT_SYMBOL_GPL(usb_hub_claim_port);
1992 int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
1993 struct usb_dev_state *owner)
1996 struct usb_dev_state **powner;
1998 rc = find_port_owner(hdev, port1, &powner);
2001 if (*powner != owner)
2006 EXPORT_SYMBOL_GPL(usb_hub_release_port);
2008 void usb_hub_release_all_ports(struct usb_device *hdev, struct usb_dev_state *owner)
2010 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
2013 for (n = 0; n < hdev->maxchild; n++) {
2014 if (hub->ports[n]->port_owner == owner)
2015 hub->ports[n]->port_owner = NULL;
2020 /* The caller must hold udev's lock */
2021 bool usb_device_is_owned(struct usb_device *udev)
2023 struct usb_hub *hub;
2025 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
2027 hub = usb_hub_to_struct_hub(udev->parent);
2028 return !!hub->ports[udev->portnum - 1]->port_owner;
2031 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
2033 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2036 for (i = 0; i < udev->maxchild; ++i) {
2037 if (hub->ports[i]->child)
2038 recursively_mark_NOTATTACHED(hub->ports[i]->child);
2040 if (udev->state == USB_STATE_SUSPENDED)
2041 udev->active_duration -= jiffies;
2042 udev->state = USB_STATE_NOTATTACHED;
2046 * usb_set_device_state - change a device's current state (usbcore, hcds)
2047 * @udev: pointer to device whose state should be changed
2048 * @new_state: new state value to be stored
2050 * udev->state is _not_ fully protected by the device lock. Although
2051 * most transitions are made only while holding the lock, the state can
2052 * can change to USB_STATE_NOTATTACHED at almost any time. This
2053 * is so that devices can be marked as disconnected as soon as possible,
2054 * without having to wait for any semaphores to be released. As a result,
2055 * all changes to any device's state must be protected by the
2056 * device_state_lock spinlock.
2058 * Once a device has been added to the device tree, all changes to its state
2059 * should be made using this routine. The state should _not_ be set directly.
2061 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
2062 * Otherwise udev->state is set to new_state, and if new_state is
2063 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
2064 * to USB_STATE_NOTATTACHED.
2066 void usb_set_device_state(struct usb_device *udev,
2067 enum usb_device_state new_state)
2069 unsigned long flags;
2072 spin_lock_irqsave(&device_state_lock, flags);
2073 if (udev->state == USB_STATE_NOTATTACHED)
2075 else if (new_state != USB_STATE_NOTATTACHED) {
2077 /* root hub wakeup capabilities are managed out-of-band
2078 * and may involve silicon errata ... ignore them here.
2081 if (udev->state == USB_STATE_SUSPENDED
2082 || new_state == USB_STATE_SUSPENDED)
2083 ; /* No change to wakeup settings */
2084 else if (new_state == USB_STATE_CONFIGURED)
2085 wakeup = (udev->quirks &
2086 USB_QUIRK_IGNORE_REMOTE_WAKEUP) ? 0 :
2087 udev->actconfig->desc.bmAttributes &
2088 USB_CONFIG_ATT_WAKEUP;
2092 if (udev->state == USB_STATE_SUSPENDED &&
2093 new_state != USB_STATE_SUSPENDED)
2094 udev->active_duration -= jiffies;
2095 else if (new_state == USB_STATE_SUSPENDED &&
2096 udev->state != USB_STATE_SUSPENDED)
2097 udev->active_duration += jiffies;
2098 udev->state = new_state;
2100 recursively_mark_NOTATTACHED(udev);
2101 spin_unlock_irqrestore(&device_state_lock, flags);
2103 device_set_wakeup_capable(&udev->dev, wakeup);
2105 EXPORT_SYMBOL_GPL(usb_set_device_state);
2108 * Choose a device number.
2110 * Device numbers are used as filenames in usbfs. On USB-1.1 and
2111 * USB-2.0 buses they are also used as device addresses, however on
2112 * USB-3.0 buses the address is assigned by the controller hardware
2113 * and it usually is not the same as the device number.
2115 * WUSB devices are simple: they have no hubs behind, so the mapping
2116 * device <-> virtual port number becomes 1:1. Why? to simplify the
2117 * life of the device connection logic in
2118 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
2119 * handshake we need to assign a temporary address in the unauthorized
2120 * space. For simplicity we use the first virtual port number found to
2121 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
2122 * and that becomes it's address [X < 128] or its unauthorized address
2125 * We add 1 as an offset to the one-based USB-stack port number
2126 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
2127 * 0 is reserved by USB for default address; (b) Linux's USB stack
2128 * uses always #1 for the root hub of the controller. So USB stack's
2129 * port #1, which is wusb virtual-port #0 has address #2.
2131 * Devices connected under xHCI are not as simple. The host controller
2132 * supports virtualization, so the hardware assigns device addresses and
2133 * the HCD must setup data structures before issuing a set address
2134 * command to the hardware.
2136 static void choose_devnum(struct usb_device *udev)
2139 struct usb_bus *bus = udev->bus;
2141 /* be safe when more hub events are proceed in parallel */
2142 mutex_lock(&bus->devnum_next_mutex);
2144 devnum = udev->portnum + 1;
2145 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
2147 /* Try to allocate the next devnum beginning at
2148 * bus->devnum_next. */
2149 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
2152 devnum = find_next_zero_bit(bus->devmap.devicemap,
2154 bus->devnum_next = (devnum >= 127 ? 1 : devnum + 1);
2157 set_bit(devnum, bus->devmap.devicemap);
2158 udev->devnum = devnum;
2160 mutex_unlock(&bus->devnum_next_mutex);
2163 static void release_devnum(struct usb_device *udev)
2165 if (udev->devnum > 0) {
2166 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
2171 static void update_devnum(struct usb_device *udev, int devnum)
2173 /* The address for a WUSB device is managed by wusbcore. */
2175 udev->devnum = devnum;
2177 udev->devaddr = (u8)devnum;
2180 static void hub_free_dev(struct usb_device *udev)
2182 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2184 /* Root hubs aren't real devices, so don't free HCD resources */
2185 if (hcd->driver->free_dev && udev->parent)
2186 hcd->driver->free_dev(hcd, udev);
2189 static void hub_disconnect_children(struct usb_device *udev)
2191 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2194 /* Free up all the children before we remove this device */
2195 for (i = 0; i < udev->maxchild; i++) {
2196 if (hub->ports[i]->child)
2197 usb_disconnect(&hub->ports[i]->child);
2202 * usb_disconnect - disconnect a device (usbcore-internal)
2203 * @pdev: pointer to device being disconnected
2204 * Context: !in_interrupt ()
2206 * Something got disconnected. Get rid of it and all of its children.
2208 * If *pdev is a normal device then the parent hub must already be locked.
2209 * If *pdev is a root hub then the caller must hold the usb_bus_idr_lock,
2210 * which protects the set of root hubs as well as the list of buses.
2212 * Only hub drivers (including virtual root hub drivers for host
2213 * controllers) should ever call this.
2215 * This call is synchronous, and may not be used in an interrupt context.
2217 void usb_disconnect(struct usb_device **pdev)
2219 struct usb_port *port_dev = NULL;
2220 struct usb_device *udev = *pdev;
2221 struct usb_hub *hub = NULL;
2224 /* mark the device as inactive, so any further urb submissions for
2225 * this device (and any of its children) will fail immediately.
2226 * this quiesces everything except pending urbs.
2228 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2229 dev_info(&udev->dev, "USB disconnect, device number %d\n",
2233 * Ensure that the pm runtime code knows that the USB device
2234 * is in the process of being disconnected.
2236 pm_runtime_barrier(&udev->dev);
2238 usb_lock_device(udev);
2240 hub_disconnect_children(udev);
2242 /* deallocate hcd/hardware state ... nuking all pending urbs and
2243 * cleaning up all state associated with the current configuration
2244 * so that the hardware is now fully quiesced.
2246 dev_dbg(&udev->dev, "unregistering device\n");
2247 usb_disable_device(udev, 0);
2248 usb_hcd_synchronize_unlinks(udev);
2251 port1 = udev->portnum;
2252 hub = usb_hub_to_struct_hub(udev->parent);
2253 port_dev = hub->ports[port1 - 1];
2255 sysfs_remove_link(&udev->dev.kobj, "port");
2256 sysfs_remove_link(&port_dev->dev.kobj, "device");
2259 * As usb_port_runtime_resume() de-references udev, make
2260 * sure no resumes occur during removal
2262 if (!test_and_set_bit(port1, hub->child_usage_bits))
2263 pm_runtime_get_sync(&port_dev->dev);
2266 usb_remove_ep_devs(&udev->ep0);
2267 usb_unlock_device(udev);
2269 /* Unregister the device. The device driver is responsible
2270 * for de-configuring the device and invoking the remove-device
2271 * notifier chain (used by usbfs and possibly others).
2273 device_del(&udev->dev);
2275 /* Free the device number and delete the parent's children[]
2276 * (or root_hub) pointer.
2278 release_devnum(udev);
2280 /* Avoid races with recursively_mark_NOTATTACHED() */
2281 spin_lock_irq(&device_state_lock);
2283 spin_unlock_irq(&device_state_lock);
2285 if (port_dev && test_and_clear_bit(port1, hub->child_usage_bits))
2286 pm_runtime_put(&port_dev->dev);
2290 put_device(&udev->dev);
2293 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2294 static void show_string(struct usb_device *udev, char *id, char *string)
2298 dev_info(&udev->dev, "%s: %s\n", id, string);
2301 static void announce_device(struct usb_device *udev)
2303 u16 bcdDevice = le16_to_cpu(udev->descriptor.bcdDevice);
2305 dev_info(&udev->dev,
2306 "New USB device found, idVendor=%04x, idProduct=%04x, bcdDevice=%2x.%02x\n",
2307 le16_to_cpu(udev->descriptor.idVendor),
2308 le16_to_cpu(udev->descriptor.idProduct),
2309 bcdDevice >> 8, bcdDevice & 0xff);
2310 dev_info(&udev->dev,
2311 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2312 udev->descriptor.iManufacturer,
2313 udev->descriptor.iProduct,
2314 udev->descriptor.iSerialNumber);
2315 show_string(udev, "Product", udev->product);
2316 show_string(udev, "Manufacturer", udev->manufacturer);
2317 show_string(udev, "SerialNumber", udev->serial);
2320 static inline void announce_device(struct usb_device *udev) { }
2325 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2326 * @udev: newly addressed device (in ADDRESS state)
2328 * Finish enumeration for On-The-Go devices
2330 * Return: 0 if successful. A negative error code otherwise.
2332 static int usb_enumerate_device_otg(struct usb_device *udev)
2336 #ifdef CONFIG_USB_OTG
2338 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2339 * to wake us after we've powered off VBUS; and HNP, switching roles
2340 * "host" to "peripheral". The OTG descriptor helps figure this out.
2342 if (!udev->bus->is_b_host
2344 && udev->parent == udev->bus->root_hub) {
2345 struct usb_otg_descriptor *desc = NULL;
2346 struct usb_bus *bus = udev->bus;
2347 unsigned port1 = udev->portnum;
2349 /* descriptor may appear anywhere in config */
2350 err = __usb_get_extra_descriptor(udev->rawdescriptors[0],
2351 le16_to_cpu(udev->config[0].desc.wTotalLength),
2352 USB_DT_OTG, (void **) &desc, sizeof(*desc));
2353 if (err || !(desc->bmAttributes & USB_OTG_HNP))
2356 dev_info(&udev->dev, "Dual-Role OTG device on %sHNP port\n",
2357 (port1 == bus->otg_port) ? "" : "non-");
2359 /* enable HNP before suspend, it's simpler */
2360 if (port1 == bus->otg_port) {
2361 bus->b_hnp_enable = 1;
2362 err = usb_control_msg(udev,
2363 usb_sndctrlpipe(udev, 0),
2364 USB_REQ_SET_FEATURE, 0,
2365 USB_DEVICE_B_HNP_ENABLE,
2367 USB_CTRL_SET_TIMEOUT);
2370 * OTG MESSAGE: report errors here,
2371 * customize to match your product.
2373 dev_err(&udev->dev, "can't set HNP mode: %d\n",
2375 bus->b_hnp_enable = 0;
2377 } else if (desc->bLength == sizeof
2378 (struct usb_otg_descriptor)) {
2380 * We are operating on a legacy OTP device
2381 * These should be told that they are operating
2382 * on the wrong port if we have another port that does
2385 if (bus->otg_port != 0) {
2386 /* Set a_alt_hnp_support for legacy otg device */
2387 err = usb_control_msg(udev,
2388 usb_sndctrlpipe(udev, 0),
2389 USB_REQ_SET_FEATURE, 0,
2390 USB_DEVICE_A_ALT_HNP_SUPPORT,
2392 USB_CTRL_SET_TIMEOUT);
2395 "set a_alt_hnp_support failed: %d\n",
2406 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2407 * @udev: newly addressed device (in ADDRESS state)
2409 * This is only called by usb_new_device() -- all comments that apply there
2410 * apply here wrt to environment.
2412 * If the device is WUSB and not authorized, we don't attempt to read
2413 * the string descriptors, as they will be errored out by the device
2414 * until it has been authorized.
2416 * Return: 0 if successful. A negative error code otherwise.
2418 static int usb_enumerate_device(struct usb_device *udev)
2421 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2423 if (udev->config == NULL) {
2424 err = usb_get_configuration(udev);
2427 dev_err(&udev->dev, "can't read configurations, error %d\n",
2433 /* read the standard strings and cache them if present */
2434 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
2435 udev->manufacturer = usb_cache_string(udev,
2436 udev->descriptor.iManufacturer);
2437 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
2439 err = usb_enumerate_device_otg(udev);
2443 if (IS_ENABLED(CONFIG_USB_OTG_PRODUCTLIST) && hcd->tpl_support &&
2444 !is_targeted(udev)) {
2445 /* Maybe it can talk to us, though we can't talk to it.
2446 * (Includes HNP test device.)
2448 if (IS_ENABLED(CONFIG_USB_OTG) && (udev->bus->b_hnp_enable
2449 || udev->bus->is_b_host)) {
2450 err = usb_port_suspend(udev, PMSG_AUTO_SUSPEND);
2452 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
2457 usb_detect_interface_quirks(udev);
2462 static void set_usb_port_removable(struct usb_device *udev)
2464 struct usb_device *hdev = udev->parent;
2465 struct usb_hub *hub;
2466 u8 port = udev->portnum;
2467 u16 wHubCharacteristics;
2468 bool removable = true;
2470 dev_set_removable(&udev->dev, DEVICE_REMOVABLE_UNKNOWN);
2475 hub = usb_hub_to_struct_hub(udev->parent);
2478 * If the platform firmware has provided information about a port,
2479 * use that to determine whether it's removable.
2481 switch (hub->ports[udev->portnum - 1]->connect_type) {
2482 case USB_PORT_CONNECT_TYPE_HOT_PLUG:
2483 dev_set_removable(&udev->dev, DEVICE_REMOVABLE);
2485 case USB_PORT_CONNECT_TYPE_HARD_WIRED:
2486 case USB_PORT_NOT_USED:
2487 dev_set_removable(&udev->dev, DEVICE_FIXED);
2494 * Otherwise, check whether the hub knows whether a port is removable
2497 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2499 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
2502 if (hub_is_superspeed(hdev)) {
2503 if (le16_to_cpu(hub->descriptor->u.ss.DeviceRemovable)
2507 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
2512 dev_set_removable(&udev->dev, DEVICE_REMOVABLE);
2514 dev_set_removable(&udev->dev, DEVICE_FIXED);
2519 * usb_new_device - perform initial device setup (usbcore-internal)
2520 * @udev: newly addressed device (in ADDRESS state)
2522 * This is called with devices which have been detected but not fully
2523 * enumerated. The device descriptor is available, but not descriptors
2524 * for any device configuration. The caller must have locked either
2525 * the parent hub (if udev is a normal device) or else the
2526 * usb_bus_idr_lock (if udev is a root hub). The parent's pointer to
2527 * udev has already been installed, but udev is not yet visible through
2528 * sysfs or other filesystem code.
2530 * This call is synchronous, and may not be used in an interrupt context.
2532 * Only the hub driver or root-hub registrar should ever call this.
2534 * Return: Whether the device is configured properly or not. Zero if the
2535 * interface was registered with the driver core; else a negative errno
2539 int usb_new_device(struct usb_device *udev)
2544 /* Initialize non-root-hub device wakeup to disabled;
2545 * device (un)configuration controls wakeup capable
2546 * sysfs power/wakeup controls wakeup enabled/disabled
2548 device_init_wakeup(&udev->dev, 0);
2551 /* Tell the runtime-PM framework the device is active */
2552 pm_runtime_set_active(&udev->dev);
2553 pm_runtime_get_noresume(&udev->dev);
2554 pm_runtime_use_autosuspend(&udev->dev);
2555 pm_runtime_enable(&udev->dev);
2557 /* By default, forbid autosuspend for all devices. It will be
2558 * allowed for hubs during binding.
2560 usb_disable_autosuspend(udev);
2562 err = usb_enumerate_device(udev); /* Read descriptors */
2565 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
2566 udev->devnum, udev->bus->busnum,
2567 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2568 /* export the usbdev device-node for libusb */
2569 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
2570 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2572 /* Tell the world! */
2573 announce_device(udev);
2576 add_device_randomness(udev->serial, strlen(udev->serial));
2578 add_device_randomness(udev->product, strlen(udev->product));
2579 if (udev->manufacturer)
2580 add_device_randomness(udev->manufacturer,
2581 strlen(udev->manufacturer));
2583 device_enable_async_suspend(&udev->dev);
2585 /* check whether the hub or firmware marks this port as non-removable */
2586 set_usb_port_removable(udev);
2588 /* Register the device. The device driver is responsible
2589 * for configuring the device and invoking the add-device
2590 * notifier chain (used by usbfs and possibly others).
2592 err = device_add(&udev->dev);
2594 dev_err(&udev->dev, "can't device_add, error %d\n", err);
2598 /* Create link files between child device and usb port device. */
2600 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2601 int port1 = udev->portnum;
2602 struct usb_port *port_dev = hub->ports[port1 - 1];
2604 err = sysfs_create_link(&udev->dev.kobj,
2605 &port_dev->dev.kobj, "port");
2609 err = sysfs_create_link(&port_dev->dev.kobj,
2610 &udev->dev.kobj, "device");
2612 sysfs_remove_link(&udev->dev.kobj, "port");
2616 if (!test_and_set_bit(port1, hub->child_usage_bits))
2617 pm_runtime_get_sync(&port_dev->dev);
2620 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
2621 usb_mark_last_busy(udev);
2622 pm_runtime_put_sync_autosuspend(&udev->dev);
2626 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2627 pm_runtime_disable(&udev->dev);
2628 pm_runtime_set_suspended(&udev->dev);
2634 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2635 * @usb_dev: USB device
2637 * Move the USB device to a very basic state where interfaces are disabled
2638 * and the device is in fact unconfigured and unusable.
2640 * We share a lock (that we have) with device_del(), so we need to
2645 int usb_deauthorize_device(struct usb_device *usb_dev)
2647 usb_lock_device(usb_dev);
2648 if (usb_dev->authorized == 0)
2649 goto out_unauthorized;
2651 usb_dev->authorized = 0;
2652 usb_set_configuration(usb_dev, -1);
2655 usb_unlock_device(usb_dev);
2660 int usb_authorize_device(struct usb_device *usb_dev)
2664 usb_lock_device(usb_dev);
2665 if (usb_dev->authorized == 1)
2666 goto out_authorized;
2668 result = usb_autoresume_device(usb_dev);
2670 dev_err(&usb_dev->dev,
2671 "can't autoresume for authorization: %d\n", result);
2672 goto error_autoresume;
2675 if (usb_dev->wusb) {
2676 struct usb_device_descriptor *descr;
2678 descr = usb_get_device_descriptor(usb_dev);
2679 if (IS_ERR(descr)) {
2680 result = PTR_ERR(descr);
2681 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2682 "authorization: %d\n", result);
2683 goto error_device_descriptor;
2685 usb_dev->descriptor = *descr;
2689 usb_dev->authorized = 1;
2690 /* Choose and set the configuration. This registers the interfaces
2691 * with the driver core and lets interface drivers bind to them.
2693 c = usb_choose_configuration(usb_dev);
2695 result = usb_set_configuration(usb_dev, c);
2697 dev_err(&usb_dev->dev,
2698 "can't set config #%d, error %d\n", c, result);
2699 /* This need not be fatal. The user can try to
2700 * set other configurations. */
2703 dev_info(&usb_dev->dev, "authorized to connect\n");
2705 error_device_descriptor:
2706 usb_autosuspend_device(usb_dev);
2709 usb_unlock_device(usb_dev); /* complements locktree */
2714 * get_port_ssp_rate - Match the extended port status to SSP rate
2715 * @hdev: The hub device
2716 * @ext_portstatus: extended port status
2718 * Match the extended port status speed id to the SuperSpeed Plus sublink speed
2719 * capability attributes. Base on the number of connected lanes and speed,
2720 * return the corresponding enum usb_ssp_rate.
2722 static enum usb_ssp_rate get_port_ssp_rate(struct usb_device *hdev,
2725 struct usb_ssp_cap_descriptor *ssp_cap = hdev->bos->ssp_cap;
2735 speed_id = ext_portstatus & USB_EXT_PORT_STAT_RX_SPEED_ID;
2736 lanes = USB_EXT_PORT_RX_LANES(ext_portstatus) + 1;
2738 ssac = le32_to_cpu(ssp_cap->bmAttributes) &
2739 USB_SSP_SUBLINK_SPEED_ATTRIBS;
2741 for (i = 0; i <= ssac; i++) {
2744 attr = le32_to_cpu(ssp_cap->bmSublinkSpeedAttr[i]);
2745 ssid = FIELD_GET(USB_SSP_SUBLINK_SPEED_SSID, attr);
2746 if (speed_id == ssid) {
2752 * Note: currently asymmetric lane types are only
2753 * applicable for SSIC operate in SuperSpeed protocol
2755 type = FIELD_GET(USB_SSP_SUBLINK_SPEED_ST, attr);
2756 if (type == USB_SSP_SUBLINK_SPEED_ST_ASYM_RX ||
2757 type == USB_SSP_SUBLINK_SPEED_ST_ASYM_TX)
2760 if (FIELD_GET(USB_SSP_SUBLINK_SPEED_LP, attr) !=
2761 USB_SSP_SUBLINK_SPEED_LP_SSP)
2764 lse = FIELD_GET(USB_SSP_SUBLINK_SPEED_LSE, attr);
2765 mantissa = FIELD_GET(USB_SSP_SUBLINK_SPEED_LSM, attr);
2767 /* Convert to Gbps */
2768 for (; lse < USB_SSP_SUBLINK_SPEED_LSE_GBPS; lse++)
2771 if (mantissa >= 10 && lanes == 1)
2772 return USB_SSP_GEN_2x1;
2774 if (mantissa >= 10 && lanes == 2)
2775 return USB_SSP_GEN_2x2;
2777 if (mantissa >= 5 && lanes == 2)
2778 return USB_SSP_GEN_1x2;
2785 return USB_SSP_GEN_UNKNOWN;
2789 * Return 1 if port speed is SuperSpeedPlus, 0 otherwise or if the
2790 * capability couldn't be checked.
2791 * check it from the link protocol field of the current speed ID attribute.
2792 * current speed ID is got from ext port status request. Sublink speed attribute
2793 * table is returned with the hub BOS SSP device capability descriptor
2795 static int port_speed_is_ssp(struct usb_device *hdev, int speed_id)
2800 struct usb_ssp_cap_descriptor *ssp_cap;
2805 ssp_cap = hdev->bos->ssp_cap;
2809 ssa_count = le32_to_cpu(ssp_cap->bmAttributes) &
2810 USB_SSP_SUBLINK_SPEED_ATTRIBS;
2812 for (i = 0; i <= ssa_count; i++) {
2813 ss_attr = le32_to_cpu(ssp_cap->bmSublinkSpeedAttr[i]);
2814 if (speed_id == (ss_attr & USB_SSP_SUBLINK_SPEED_SSID))
2815 return !!(ss_attr & USB_SSP_SUBLINK_SPEED_LP);
2820 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2821 static unsigned hub_is_wusb(struct usb_hub *hub)
2823 struct usb_hcd *hcd;
2824 if (hub->hdev->parent != NULL) /* not a root hub? */
2826 hcd = bus_to_hcd(hub->hdev->bus);
2827 return hcd->wireless;
2831 #ifdef CONFIG_USB_FEW_INIT_RETRIES
2832 #define PORT_RESET_TRIES 2
2833 #define SET_ADDRESS_TRIES 1
2834 #define GET_DESCRIPTOR_TRIES 1
2835 #define GET_MAXPACKET0_TRIES 1
2836 #define PORT_INIT_TRIES 4
2839 #define PORT_RESET_TRIES 5
2840 #define SET_ADDRESS_TRIES 2
2841 #define GET_DESCRIPTOR_TRIES 2
2842 #define GET_MAXPACKET0_TRIES 3
2843 #define PORT_INIT_TRIES 4
2844 #endif /* CONFIG_USB_FEW_INIT_RETRIES */
2846 #define HUB_ROOT_RESET_TIME 60 /* times are in msec */
2847 #define HUB_SHORT_RESET_TIME 10
2848 #define HUB_BH_RESET_TIME 50
2849 #define HUB_LONG_RESET_TIME 200
2850 #define HUB_RESET_TIMEOUT 800
2852 static bool use_new_scheme(struct usb_device *udev, int retry,
2853 struct usb_port *port_dev)
2855 int old_scheme_first_port =
2856 (port_dev->quirks & USB_PORT_QUIRK_OLD_SCHEME) ||
2860 * "New scheme" enumeration causes an extra state transition to be
2861 * exposed to an xhci host and causes USB3 devices to receive control
2862 * commands in the default state. This has been seen to cause
2863 * enumeration failures, so disable this enumeration scheme for USB3
2866 if (udev->speed >= USB_SPEED_SUPER)
2870 * If use_both_schemes is set, use the first scheme (whichever
2871 * it is) for the larger half of the retries, then use the other
2872 * scheme. Otherwise, use the first scheme for all the retries.
2874 if (use_both_schemes && retry >= (PORT_INIT_TRIES + 1) / 2)
2875 return old_scheme_first_port; /* Second half */
2876 return !old_scheme_first_port; /* First half or all */
2879 /* Is a USB 3.0 port in the Inactive or Compliance Mode state?
2880 * Port warm reset is required to recover
2882 static bool hub_port_warm_reset_required(struct usb_hub *hub, int port1,
2887 if (!hub_is_superspeed(hub->hdev))
2890 if (test_bit(port1, hub->warm_reset_bits))
2893 link_state = portstatus & USB_PORT_STAT_LINK_STATE;
2894 return link_state == USB_SS_PORT_LS_SS_INACTIVE
2895 || link_state == USB_SS_PORT_LS_COMP_MOD;
2898 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2899 struct usb_device *udev, unsigned int delay, bool warm)
2901 int delay_time, ret;
2904 u32 ext_portstatus = 0;
2906 for (delay_time = 0;
2907 delay_time < HUB_RESET_TIMEOUT;
2908 delay_time += delay) {
2909 /* wait to give the device a chance to reset */
2912 /* read and decode port status */
2913 if (hub_is_superspeedplus(hub->hdev))
2914 ret = hub_ext_port_status(hub, port1,
2915 HUB_EXT_PORT_STATUS,
2916 &portstatus, &portchange,
2919 ret = hub_port_status(hub, port1, &portstatus,
2925 * The port state is unknown until the reset completes.
2927 * On top of that, some chips may require additional time
2928 * to re-establish a connection after the reset is complete,
2929 * so also wait for the connection to be re-established.
2931 if (!(portstatus & USB_PORT_STAT_RESET) &&
2932 (portstatus & USB_PORT_STAT_CONNECTION))
2935 /* switch to the long delay after two short delay failures */
2936 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2937 delay = HUB_LONG_RESET_TIME;
2939 dev_dbg(&hub->ports[port1 - 1]->dev,
2940 "not %sreset yet, waiting %dms\n",
2941 warm ? "warm " : "", delay);
2944 if ((portstatus & USB_PORT_STAT_RESET))
2947 if (hub_port_warm_reset_required(hub, port1, portstatus))
2950 /* Device went away? */
2951 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2954 /* Retry if connect change is set but status is still connected.
2955 * A USB 3.0 connection may bounce if multiple warm resets were issued,
2956 * but the device may have successfully re-connected. Ignore it.
2958 if (!hub_is_superspeed(hub->hdev) &&
2959 (portchange & USB_PORT_STAT_C_CONNECTION)) {
2960 usb_clear_port_feature(hub->hdev, port1,
2961 USB_PORT_FEAT_C_CONNECTION);
2965 if (!(portstatus & USB_PORT_STAT_ENABLE))
2971 if (hub_is_superspeedplus(hub->hdev)) {
2972 /* extended portstatus Rx and Tx lane count are zero based */
2973 udev->rx_lanes = USB_EXT_PORT_RX_LANES(ext_portstatus) + 1;
2974 udev->tx_lanes = USB_EXT_PORT_TX_LANES(ext_portstatus) + 1;
2975 udev->ssp_rate = get_port_ssp_rate(hub->hdev, ext_portstatus);
2979 udev->ssp_rate = USB_SSP_GEN_UNKNOWN;
2981 if (hub_is_wusb(hub))
2982 udev->speed = USB_SPEED_WIRELESS;
2983 else if (hub_is_superspeedplus(hub->hdev) &&
2984 port_speed_is_ssp(hub->hdev, ext_portstatus &
2985 USB_EXT_PORT_STAT_RX_SPEED_ID))
2986 udev->speed = USB_SPEED_SUPER_PLUS;
2987 else if (hub_is_superspeed(hub->hdev))
2988 udev->speed = USB_SPEED_SUPER;
2989 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2990 udev->speed = USB_SPEED_HIGH;
2991 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2992 udev->speed = USB_SPEED_LOW;
2994 udev->speed = USB_SPEED_FULL;
2998 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2999 static int hub_port_reset(struct usb_hub *hub, int port1,
3000 struct usb_device *udev, unsigned int delay, bool warm)
3003 u16 portchange, portstatus;
3004 struct usb_port *port_dev = hub->ports[port1 - 1];
3005 int reset_recovery_time;
3007 if (!hub_is_superspeed(hub->hdev)) {
3009 dev_err(hub->intfdev, "only USB3 hub support "
3013 /* Block EHCI CF initialization during the port reset.
3014 * Some companion controllers don't like it when they mix.
3016 down_read(&ehci_cf_port_reset_rwsem);
3019 * If the caller hasn't explicitly requested a warm reset,
3020 * double check and see if one is needed.
3022 if (hub_port_status(hub, port1, &portstatus, &portchange) == 0)
3023 if (hub_port_warm_reset_required(hub, port1,
3027 clear_bit(port1, hub->warm_reset_bits);
3029 /* Reset the port */
3030 for (i = 0; i < PORT_RESET_TRIES; i++) {
3031 status = set_port_feature(hub->hdev, port1, (warm ?
3032 USB_PORT_FEAT_BH_PORT_RESET :
3033 USB_PORT_FEAT_RESET));
3034 if (status == -ENODEV) {
3035 ; /* The hub is gone */
3036 } else if (status) {
3037 dev_err(&port_dev->dev,
3038 "cannot %sreset (err = %d)\n",
3039 warm ? "warm " : "", status);
3041 status = hub_port_wait_reset(hub, port1, udev, delay,
3043 if (status && status != -ENOTCONN && status != -ENODEV)
3044 dev_dbg(hub->intfdev,
3045 "port_wait_reset: err = %d\n",
3049 /* Check for disconnect or reset */
3050 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
3051 usb_clear_port_feature(hub->hdev, port1,
3052 USB_PORT_FEAT_C_RESET);
3054 if (!hub_is_superspeed(hub->hdev))
3057 usb_clear_port_feature(hub->hdev, port1,
3058 USB_PORT_FEAT_C_BH_PORT_RESET);
3059 usb_clear_port_feature(hub->hdev, port1,
3060 USB_PORT_FEAT_C_PORT_LINK_STATE);
3063 usb_clear_port_feature(hub->hdev, port1,
3064 USB_PORT_FEAT_C_CONNECTION);
3067 * If a USB 3.0 device migrates from reset to an error
3068 * state, re-issue the warm reset.
3070 if (hub_port_status(hub, port1,
3071 &portstatus, &portchange) < 0)
3074 if (!hub_port_warm_reset_required(hub, port1,
3079 * If the port is in SS.Inactive or Compliance Mode, the
3080 * hot or warm reset failed. Try another warm reset.
3083 dev_dbg(&port_dev->dev,
3084 "hot reset failed, warm reset\n");
3089 dev_dbg(&port_dev->dev,
3090 "not enabled, trying %sreset again...\n",
3091 warm ? "warm " : "");
3092 delay = HUB_LONG_RESET_TIME;
3095 dev_err(&port_dev->dev, "Cannot enable. Maybe the USB cable is bad?\n");
3099 if (port_dev->quirks & USB_PORT_QUIRK_FAST_ENUM)
3100 usleep_range(10000, 12000);
3102 /* TRSTRCY = 10 ms; plus some extra */
3103 reset_recovery_time = 10 + 40;
3105 /* Hub needs extra delay after resetting its port. */
3106 if (hub->hdev->quirks & USB_QUIRK_HUB_SLOW_RESET)
3107 reset_recovery_time += 100;
3109 msleep(reset_recovery_time);
3113 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3115 update_devnum(udev, 0);
3116 /* The xHC may think the device is already reset,
3117 * so ignore the status.
3119 if (hcd->driver->reset_device)
3120 hcd->driver->reset_device(hcd, udev);
3122 usb_set_device_state(udev, USB_STATE_DEFAULT);
3126 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
3129 if (!hub_is_superspeed(hub->hdev))
3130 up_read(&ehci_cf_port_reset_rwsem);
3135 /* Check if a port is power on */
3136 static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
3140 if (hub_is_superspeed(hub->hdev)) {
3141 if (portstatus & USB_SS_PORT_STAT_POWER)
3144 if (portstatus & USB_PORT_STAT_POWER)
3151 static void usb_lock_port(struct usb_port *port_dev)
3152 __acquires(&port_dev->status_lock)
3154 mutex_lock(&port_dev->status_lock);
3155 __acquire(&port_dev->status_lock);
3158 static void usb_unlock_port(struct usb_port *port_dev)
3159 __releases(&port_dev->status_lock)
3161 mutex_unlock(&port_dev->status_lock);
3162 __release(&port_dev->status_lock);
3167 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
3168 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
3172 if (hub_is_superspeed(hub->hdev)) {
3173 if ((portstatus & USB_PORT_STAT_LINK_STATE)
3174 == USB_SS_PORT_LS_U3)
3177 if (portstatus & USB_PORT_STAT_SUSPEND)
3184 /* Determine whether the device on a port is ready for a normal resume,
3185 * is ready for a reset-resume, or should be disconnected.
3187 static int check_port_resume_type(struct usb_device *udev,
3188 struct usb_hub *hub, int port1,
3189 int status, u16 portchange, u16 portstatus)
3191 struct usb_port *port_dev = hub->ports[port1 - 1];
3195 /* Is a warm reset needed to recover the connection? */
3196 if (status == 0 && udev->reset_resume
3197 && hub_port_warm_reset_required(hub, port1, portstatus)) {
3200 /* Is the device still present? */
3201 else if (status || port_is_suspended(hub, portstatus) ||
3202 !port_is_power_on(hub, portstatus)) {
3205 } else if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
3207 usleep_range(200, 300);
3208 status = hub_port_status(hub, port1, &portstatus,
3215 /* Can't do a normal resume if the port isn't enabled,
3216 * so try a reset-resume instead.
3218 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
3219 if (udev->persist_enabled)
3220 udev->reset_resume = 1;
3226 dev_dbg(&port_dev->dev, "status %04x.%04x after resume, %d\n",
3227 portchange, portstatus, status);
3228 } else if (udev->reset_resume) {
3230 /* Late port handoff can set status-change bits */
3231 if (portchange & USB_PORT_STAT_C_CONNECTION)
3232 usb_clear_port_feature(hub->hdev, port1,
3233 USB_PORT_FEAT_C_CONNECTION);
3234 if (portchange & USB_PORT_STAT_C_ENABLE)
3235 usb_clear_port_feature(hub->hdev, port1,
3236 USB_PORT_FEAT_C_ENABLE);
3239 * Whatever made this reset-resume necessary may have
3240 * turned on the port1 bit in hub->change_bits. But after
3241 * a successful reset-resume we want the bit to be clear;
3242 * if it was on it would indicate that something happened
3243 * following the reset-resume.
3245 clear_bit(port1, hub->change_bits);
3251 int usb_disable_ltm(struct usb_device *udev)
3253 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3255 /* Check if the roothub and device supports LTM. */
3256 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
3257 !usb_device_supports_ltm(udev))
3260 /* Clear Feature LTM Enable can only be sent if the device is
3263 if (!udev->actconfig)
3266 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3267 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
3268 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
3269 USB_CTRL_SET_TIMEOUT);
3271 EXPORT_SYMBOL_GPL(usb_disable_ltm);
3273 void usb_enable_ltm(struct usb_device *udev)
3275 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3277 /* Check if the roothub and device supports LTM. */
3278 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
3279 !usb_device_supports_ltm(udev))
3282 /* Set Feature LTM Enable can only be sent if the device is
3285 if (!udev->actconfig)
3288 usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3289 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
3290 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
3291 USB_CTRL_SET_TIMEOUT);
3293 EXPORT_SYMBOL_GPL(usb_enable_ltm);
3296 * usb_enable_remote_wakeup - enable remote wakeup for a device
3297 * @udev: target device
3299 * For USB-2 devices: Set the device's remote wakeup feature.
3301 * For USB-3 devices: Assume there's only one function on the device and
3302 * enable remote wake for the first interface. FIXME if the interface
3303 * association descriptor shows there's more than one function.
3305 static int usb_enable_remote_wakeup(struct usb_device *udev)
3307 if (udev->speed < USB_SPEED_SUPER)
3308 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3309 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
3310 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
3311 USB_CTRL_SET_TIMEOUT);
3313 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3314 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
3315 USB_INTRF_FUNC_SUSPEND,
3316 USB_INTRF_FUNC_SUSPEND_RW |
3317 USB_INTRF_FUNC_SUSPEND_LP,
3318 NULL, 0, USB_CTRL_SET_TIMEOUT);
3322 * usb_disable_remote_wakeup - disable remote wakeup for a device
3323 * @udev: target device
3325 * For USB-2 devices: Clear the device's remote wakeup feature.
3327 * For USB-3 devices: Assume there's only one function on the device and
3328 * disable remote wake for the first interface. FIXME if the interface
3329 * association descriptor shows there's more than one function.
3331 static int usb_disable_remote_wakeup(struct usb_device *udev)
3333 if (udev->speed < USB_SPEED_SUPER)
3334 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3335 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
3336 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
3337 USB_CTRL_SET_TIMEOUT);
3339 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3340 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
3341 USB_INTRF_FUNC_SUSPEND, 0, NULL, 0,
3342 USB_CTRL_SET_TIMEOUT);
3345 /* Count of wakeup-enabled devices at or below udev */
3346 unsigned usb_wakeup_enabled_descendants(struct usb_device *udev)
3348 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
3350 return udev->do_remote_wakeup +
3351 (hub ? hub->wakeup_enabled_descendants : 0);
3353 EXPORT_SYMBOL_GPL(usb_wakeup_enabled_descendants);
3356 * usb_port_suspend - suspend a usb device's upstream port
3357 * @udev: device that's no longer in active use, not a root hub
3358 * Context: must be able to sleep; device not locked; pm locks held
3360 * Suspends a USB device that isn't in active use, conserving power.
3361 * Devices may wake out of a suspend, if anything important happens,
3362 * using the remote wakeup mechanism. They may also be taken out of
3363 * suspend by the host, using usb_port_resume(). It's also routine
3364 * to disconnect devices while they are suspended.
3366 * This only affects the USB hardware for a device; its interfaces
3367 * (and, for hubs, child devices) must already have been suspended.
3369 * Selective port suspend reduces power; most suspended devices draw
3370 * less than 500 uA. It's also used in OTG, along with remote wakeup.
3371 * All devices below the suspended port are also suspended.
3373 * Devices leave suspend state when the host wakes them up. Some devices
3374 * also support "remote wakeup", where the device can activate the USB
3375 * tree above them to deliver data, such as a keypress or packet. In
3376 * some cases, this wakes the USB host.
3378 * Suspending OTG devices may trigger HNP, if that's been enabled
3379 * between a pair of dual-role devices. That will change roles, such
3380 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
3382 * Devices on USB hub ports have only one "suspend" state, corresponding
3383 * to ACPI D2, "may cause the device to lose some context".
3384 * State transitions include:
3386 * - suspend, resume ... when the VBUS power link stays live
3387 * - suspend, disconnect ... VBUS lost
3389 * Once VBUS drop breaks the circuit, the port it's using has to go through
3390 * normal re-enumeration procedures, starting with enabling VBUS power.
3391 * Other than re-initializing the hub (plug/unplug, except for root hubs),
3392 * Linux (2.6) currently has NO mechanisms to initiate that: no hub_wq
3393 * timer, no SRP, no requests through sysfs.
3395 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
3396 * suspended until their bus goes into global suspend (i.e., the root
3397 * hub is suspended). Nevertheless, we change @udev->state to
3398 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
3399 * upstream port setting is stored in @udev->port_is_suspended.
3401 * Returns 0 on success, else negative errno.
3403 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
3405 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3406 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3407 int port1 = udev->portnum;
3409 bool really_suspend = true;
3411 usb_lock_port(port_dev);
3413 /* enable remote wakeup when appropriate; this lets the device
3414 * wake up the upstream hub (including maybe the root hub).
3416 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
3417 * we don't explicitly enable it here.
3419 if (udev->do_remote_wakeup) {
3420 status = usb_enable_remote_wakeup(udev);
3422 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
3424 /* bail if autosuspend is requested */
3425 if (PMSG_IS_AUTO(msg))
3430 /* disable USB2 hardware LPM */
3431 usb_disable_usb2_hardware_lpm(udev);
3433 if (usb_disable_ltm(udev)) {
3434 dev_err(&udev->dev, "Failed to disable LTM before suspend\n");
3436 if (PMSG_IS_AUTO(msg))
3441 if (hub_is_superspeed(hub->hdev))
3442 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U3);
3445 * For system suspend, we do not need to enable the suspend feature
3446 * on individual USB-2 ports. The devices will automatically go
3447 * into suspend a few ms after the root hub stops sending packets.
3448 * The USB 2.0 spec calls this "global suspend".
3450 * However, many USB hubs have a bug: They don't relay wakeup requests
3451 * from a downstream port if the port's suspend feature isn't on.
3452 * Therefore we will turn on the suspend feature if udev or any of its
3453 * descendants is enabled for remote wakeup.
3455 else if (PMSG_IS_AUTO(msg) || usb_wakeup_enabled_descendants(udev) > 0)
3456 status = set_port_feature(hub->hdev, port1,
3457 USB_PORT_FEAT_SUSPEND);
3459 really_suspend = false;
3463 dev_dbg(&port_dev->dev, "can't suspend, status %d\n", status);
3465 /* Try to enable USB3 LTM again */
3466 usb_enable_ltm(udev);
3468 /* Try to enable USB2 hardware LPM again */
3469 usb_enable_usb2_hardware_lpm(udev);
3471 if (udev->do_remote_wakeup)
3472 (void) usb_disable_remote_wakeup(udev);
3475 /* System sleep transitions should never fail */
3476 if (!PMSG_IS_AUTO(msg))
3479 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
3480 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
3481 udev->do_remote_wakeup);
3482 if (really_suspend) {
3483 udev->port_is_suspended = 1;
3485 /* device has up to 10 msec to fully suspend */
3488 usb_set_device_state(udev, USB_STATE_SUSPENDED);
3491 if (status == 0 && !udev->do_remote_wakeup && udev->persist_enabled
3492 && test_and_clear_bit(port1, hub->child_usage_bits))
3493 pm_runtime_put_sync(&port_dev->dev);
3495 usb_mark_last_busy(hub->hdev);
3497 usb_unlock_port(port_dev);
3502 * If the USB "suspend" state is in use (rather than "global suspend"),
3503 * many devices will be individually taken out of suspend state using
3504 * special "resume" signaling. This routine kicks in shortly after
3505 * hardware resume signaling is finished, either because of selective
3506 * resume (by host) or remote wakeup (by device) ... now see what changed
3507 * in the tree that's rooted at this device.
3509 * If @udev->reset_resume is set then the device is reset before the
3510 * status check is done.
3512 static int finish_port_resume(struct usb_device *udev)
3517 /* caller owns the udev device lock */
3518 dev_dbg(&udev->dev, "%s\n",
3519 udev->reset_resume ? "finish reset-resume" : "finish resume");
3521 /* usb ch9 identifies four variants of SUSPENDED, based on what
3522 * state the device resumes to. Linux currently won't see the
3523 * first two on the host side; they'd be inside hub_port_init()
3524 * during many timeouts, but hub_wq can't suspend until later.
3526 usb_set_device_state(udev, udev->actconfig
3527 ? USB_STATE_CONFIGURED
3528 : USB_STATE_ADDRESS);
3530 /* 10.5.4.5 says not to reset a suspended port if the attached
3531 * device is enabled for remote wakeup. Hence the reset
3532 * operation is carried out here, after the port has been
3535 if (udev->reset_resume) {
3537 * If the device morphs or switches modes when it is reset,
3538 * we don't want to perform a reset-resume. We'll fail the
3539 * resume, which will cause a logical disconnect, and then
3540 * the device will be rediscovered.
3543 if (udev->quirks & USB_QUIRK_RESET)
3546 status = usb_reset_and_verify_device(udev);
3549 /* 10.5.4.5 says be sure devices in the tree are still there.
3550 * For now let's assume the device didn't go crazy on resume,
3551 * and device drivers will know about any resume quirks.
3555 status = usb_get_std_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
3557 /* If a normal resume failed, try doing a reset-resume */
3558 if (status && !udev->reset_resume && udev->persist_enabled) {
3559 dev_dbg(&udev->dev, "retry with reset-resume\n");
3560 udev->reset_resume = 1;
3561 goto retry_reset_resume;
3566 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
3569 * There are a few quirky devices which violate the standard
3570 * by claiming to have remote wakeup enabled after a reset,
3571 * which crash if the feature is cleared, hence check for
3572 * udev->reset_resume
3574 } else if (udev->actconfig && !udev->reset_resume) {
3575 if (udev->speed < USB_SPEED_SUPER) {
3576 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
3577 status = usb_disable_remote_wakeup(udev);
3579 status = usb_get_std_status(udev, USB_RECIP_INTERFACE, 0,
3581 if (!status && devstatus & (USB_INTRF_STAT_FUNC_RW_CAP
3582 | USB_INTRF_STAT_FUNC_RW))
3583 status = usb_disable_remote_wakeup(udev);
3588 "disable remote wakeup, status %d\n",
3596 * There are some SS USB devices which take longer time for link training.
3597 * XHCI specs 4.19.4 says that when Link training is successful, port
3598 * sets CCS bit to 1. So if SW reads port status before successful link
3599 * training, then it will not find device to be present.
3600 * USB Analyzer log with such buggy devices show that in some cases
3601 * device switch on the RX termination after long delay of host enabling
3602 * the VBUS. In few other cases it has been seen that device fails to
3603 * negotiate link training in first attempt. It has been
3604 * reported till now that few devices take as long as 2000 ms to train
3605 * the link after host enabling its VBUS and termination. Following
3606 * routine implements a 2000 ms timeout for link training. If in a case
3607 * link trains before timeout, loop will exit earlier.
3609 * There are also some 2.0 hard drive based devices and 3.0 thumb
3610 * drives that, when plugged into a 2.0 only port, take a long
3611 * time to set CCS after VBUS enable.
3613 * FIXME: If a device was connected before suspend, but was removed
3614 * while system was asleep, then the loop in the following routine will
3615 * only exit at timeout.
3617 * This routine should only be called when persist is enabled.
3619 static int wait_for_connected(struct usb_device *udev,
3620 struct usb_hub *hub, int *port1,
3621 u16 *portchange, u16 *portstatus)
3623 int status = 0, delay_ms = 0;
3625 while (delay_ms < 2000) {
3626 if (status || *portstatus & USB_PORT_STAT_CONNECTION)
3628 if (!port_is_power_on(hub, *portstatus)) {
3634 status = hub_port_status(hub, *port1, portstatus, portchange);
3636 dev_dbg(&udev->dev, "Waited %dms for CONNECT\n", delay_ms);
3641 * usb_port_resume - re-activate a suspended usb device's upstream port
3642 * @udev: device to re-activate, not a root hub
3643 * Context: must be able to sleep; device not locked; pm locks held
3645 * This will re-activate the suspended device, increasing power usage
3646 * while letting drivers communicate again with its endpoints.
3647 * USB resume explicitly guarantees that the power session between
3648 * the host and the device is the same as it was when the device
3651 * If @udev->reset_resume is set then this routine won't check that the
3652 * port is still enabled. Furthermore, finish_port_resume() above will
3653 * reset @udev. The end result is that a broken power session can be
3654 * recovered and @udev will appear to persist across a loss of VBUS power.
3656 * For example, if a host controller doesn't maintain VBUS suspend current
3657 * during a system sleep or is reset when the system wakes up, all the USB
3658 * power sessions below it will be broken. This is especially troublesome
3659 * for mass-storage devices containing mounted filesystems, since the
3660 * device will appear to have disconnected and all the memory mappings
3661 * to it will be lost. Using the USB_PERSIST facility, the device can be
3662 * made to appear as if it had not disconnected.
3664 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3665 * every effort to insure that the same device is present after the
3666 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3667 * quite possible for a device to remain unaltered but its media to be
3668 * changed. If the user replaces a flash memory card while the system is
3669 * asleep, he will have only himself to blame when the filesystem on the
3670 * new card is corrupted and the system crashes.
3672 * Returns 0 on success, else negative errno.
3674 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
3676 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3677 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3678 int port1 = udev->portnum;
3680 u16 portchange, portstatus;
3682 if (!test_and_set_bit(port1, hub->child_usage_bits)) {
3683 status = pm_runtime_resume_and_get(&port_dev->dev);
3685 dev_dbg(&udev->dev, "can't resume usb port, status %d\n",
3691 usb_lock_port(port_dev);
3693 /* Skip the initial Clear-Suspend step for a remote wakeup */
3694 status = hub_port_status(hub, port1, &portstatus, &portchange);
3695 if (status == 0 && !port_is_suspended(hub, portstatus)) {
3696 if (portchange & USB_PORT_STAT_C_SUSPEND)
3697 pm_wakeup_event(&udev->dev, 0);
3698 goto SuspendCleared;
3701 /* see 7.1.7.7; affects power usage, but not budgeting */
3702 if (hub_is_superspeed(hub->hdev))
3703 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U0);
3705 status = usb_clear_port_feature(hub->hdev,
3706 port1, USB_PORT_FEAT_SUSPEND);
3708 dev_dbg(&port_dev->dev, "can't resume, status %d\n", status);
3710 /* drive resume for USB_RESUME_TIMEOUT msec */
3711 dev_dbg(&udev->dev, "usb %sresume\n",
3712 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
3713 msleep(USB_RESUME_TIMEOUT);
3715 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3716 * stop resume signaling. Then finish the resume
3719 status = hub_port_status(hub, port1, &portstatus, &portchange);
3724 udev->port_is_suspended = 0;
3725 if (hub_is_superspeed(hub->hdev)) {
3726 if (portchange & USB_PORT_STAT_C_LINK_STATE)
3727 usb_clear_port_feature(hub->hdev, port1,
3728 USB_PORT_FEAT_C_PORT_LINK_STATE);
3730 if (portchange & USB_PORT_STAT_C_SUSPEND)
3731 usb_clear_port_feature(hub->hdev, port1,
3732 USB_PORT_FEAT_C_SUSPEND);
3735 /* TRSMRCY = 10 msec */
3739 if (udev->persist_enabled)
3740 status = wait_for_connected(udev, hub, &port1, &portchange,
3743 status = check_port_resume_type(udev,
3744 hub, port1, status, portchange, portstatus);
3746 status = finish_port_resume(udev);
3748 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
3749 hub_port_logical_disconnect(hub, port1);
3751 /* Try to enable USB2 hardware LPM */
3752 usb_enable_usb2_hardware_lpm(udev);
3754 /* Try to enable USB3 LTM */
3755 usb_enable_ltm(udev);
3758 usb_unlock_port(port_dev);
3763 int usb_remote_wakeup(struct usb_device *udev)
3767 usb_lock_device(udev);
3768 if (udev->state == USB_STATE_SUSPENDED) {
3769 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
3770 status = usb_autoresume_device(udev);
3772 /* Let the drivers do their thing, then... */
3773 usb_autosuspend_device(udev);
3776 usb_unlock_device(udev);
3780 /* Returns 1 if there was a remote wakeup and a connect status change. */
3781 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
3782 u16 portstatus, u16 portchange)
3783 __must_hold(&port_dev->status_lock)
3785 struct usb_port *port_dev = hub->ports[port - 1];
3786 struct usb_device *hdev;
3787 struct usb_device *udev;
3788 int connect_change = 0;
3793 udev = port_dev->child;
3794 if (!hub_is_superspeed(hdev)) {
3795 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
3797 usb_clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
3799 link_state = portstatus & USB_PORT_STAT_LINK_STATE;
3800 if (!udev || udev->state != USB_STATE_SUSPENDED ||
3801 (link_state != USB_SS_PORT_LS_U0 &&
3802 link_state != USB_SS_PORT_LS_U1 &&
3803 link_state != USB_SS_PORT_LS_U2))
3808 /* TRSMRCY = 10 msec */
3811 usb_unlock_port(port_dev);
3812 ret = usb_remote_wakeup(udev);
3813 usb_lock_port(port_dev);
3818 hub_port_disable(hub, port, 1);
3820 dev_dbg(&port_dev->dev, "resume, status %d\n", ret);
3821 return connect_change;
3824 static int check_ports_changed(struct usb_hub *hub)
3828 for (port1 = 1; port1 <= hub->hdev->maxchild; ++port1) {
3829 u16 portstatus, portchange;
3832 status = hub_port_status(hub, port1, &portstatus, &portchange);
3833 if (!status && portchange)
3839 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
3841 struct usb_hub *hub = usb_get_intfdata(intf);
3842 struct usb_device *hdev = hub->hdev;
3846 * Warn if children aren't already suspended.
3847 * Also, add up the number of wakeup-enabled descendants.
3849 hub->wakeup_enabled_descendants = 0;
3850 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3851 struct usb_port *port_dev = hub->ports[port1 - 1];
3852 struct usb_device *udev = port_dev->child;
3854 if (udev && udev->can_submit) {
3855 dev_warn(&port_dev->dev, "device %s not suspended yet\n",
3856 dev_name(&udev->dev));
3857 if (PMSG_IS_AUTO(msg))
3861 hub->wakeup_enabled_descendants +=
3862 usb_wakeup_enabled_descendants(udev);
3865 if (hdev->do_remote_wakeup && hub->quirk_check_port_auto_suspend) {
3866 /* check if there are changes pending on hub ports */
3867 if (check_ports_changed(hub)) {
3868 if (PMSG_IS_AUTO(msg))
3870 pm_wakeup_event(&hdev->dev, 2000);
3874 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
3875 /* Enable hub to send remote wakeup for all ports. */
3876 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3877 set_port_feature(hdev,
3879 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
3880 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
3881 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
3882 USB_PORT_FEAT_REMOTE_WAKE_MASK);
3886 dev_dbg(&intf->dev, "%s\n", __func__);
3888 /* stop hub_wq and related activity */
3889 hub_quiesce(hub, HUB_SUSPEND);
3893 /* Report wakeup requests from the ports of a resuming root hub */
3894 static void report_wakeup_requests(struct usb_hub *hub)
3896 struct usb_device *hdev = hub->hdev;
3897 struct usb_device *udev;
3898 struct usb_hcd *hcd;
3899 unsigned long resuming_ports;
3903 return; /* Not a root hub */
3905 hcd = bus_to_hcd(hdev->bus);
3906 if (hcd->driver->get_resuming_ports) {
3909 * The get_resuming_ports() method returns a bitmap (origin 0)
3910 * of ports which have started wakeup signaling but have not
3911 * yet finished resuming. During system resume we will
3912 * resume all the enabled ports, regardless of any wakeup
3913 * signals, which means the wakeup requests would be lost.
3914 * To prevent this, report them to the PM core here.
3916 resuming_ports = hcd->driver->get_resuming_ports(hcd);
3917 for (i = 0; i < hdev->maxchild; ++i) {
3918 if (test_bit(i, &resuming_ports)) {
3919 udev = hub->ports[i]->child;
3921 pm_wakeup_event(&udev->dev, 0);
3927 static int hub_resume(struct usb_interface *intf)
3929 struct usb_hub *hub = usb_get_intfdata(intf);
3931 dev_dbg(&intf->dev, "%s\n", __func__);
3932 hub_activate(hub, HUB_RESUME);
3935 * This should be called only for system resume, not runtime resume.
3936 * We can't tell the difference here, so some wakeup requests will be
3937 * reported at the wrong time or more than once. This shouldn't
3938 * matter much, so long as they do get reported.
3940 report_wakeup_requests(hub);
3944 static int hub_reset_resume(struct usb_interface *intf)
3946 struct usb_hub *hub = usb_get_intfdata(intf);
3948 dev_dbg(&intf->dev, "%s\n", __func__);
3949 hub_activate(hub, HUB_RESET_RESUME);
3954 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3955 * @rhdev: struct usb_device for the root hub
3957 * The USB host controller driver calls this function when its root hub
3958 * is resumed and Vbus power has been interrupted or the controller
3959 * has been reset. The routine marks @rhdev as having lost power.
3960 * When the hub driver is resumed it will take notice and carry out
3961 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3962 * the others will be disconnected.
3964 void usb_root_hub_lost_power(struct usb_device *rhdev)
3966 dev_notice(&rhdev->dev, "root hub lost power or was reset\n");
3967 rhdev->reset_resume = 1;
3969 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
3971 static const char * const usb3_lpm_names[] = {
3979 * Send a Set SEL control transfer to the device, prior to enabling
3980 * device-initiated U1 or U2. This lets the device know the exit latencies from
3981 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3982 * packet from the host.
3984 * This function will fail if the SEL or PEL values for udev are greater than
3985 * the maximum allowed values for the link state to be enabled.
3987 static int usb_req_set_sel(struct usb_device *udev, enum usb3_link_state state)
3989 struct usb_set_sel_req *sel_values;
3990 unsigned long long u1_sel;
3991 unsigned long long u1_pel;
3992 unsigned long long u2_sel;
3993 unsigned long long u2_pel;
3996 if (udev->state != USB_STATE_CONFIGURED)
3999 /* Convert SEL and PEL stored in ns to us */
4000 u1_sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
4001 u1_pel = DIV_ROUND_UP(udev->u1_params.pel, 1000);
4002 u2_sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
4003 u2_pel = DIV_ROUND_UP(udev->u2_params.pel, 1000);
4006 * Make sure that the calculated SEL and PEL values for the link
4007 * state we're enabling aren't bigger than the max SEL/PEL
4008 * value that will fit in the SET SEL control transfer.
4009 * Otherwise the device would get an incorrect idea of the exit
4010 * latency for the link state, and could start a device-initiated
4011 * U1/U2 when the exit latencies are too high.
4013 if ((state == USB3_LPM_U1 &&
4014 (u1_sel > USB3_LPM_MAX_U1_SEL_PEL ||
4015 u1_pel > USB3_LPM_MAX_U1_SEL_PEL)) ||
4016 (state == USB3_LPM_U2 &&
4017 (u2_sel > USB3_LPM_MAX_U2_SEL_PEL ||
4018 u2_pel > USB3_LPM_MAX_U2_SEL_PEL))) {
4019 dev_dbg(&udev->dev, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
4020 usb3_lpm_names[state], u1_sel, u1_pel);
4025 * If we're enabling device-initiated LPM for one link state,
4026 * but the other link state has a too high SEL or PEL value,
4027 * just set those values to the max in the Set SEL request.
4029 if (u1_sel > USB3_LPM_MAX_U1_SEL_PEL)
4030 u1_sel = USB3_LPM_MAX_U1_SEL_PEL;
4032 if (u1_pel > USB3_LPM_MAX_U1_SEL_PEL)
4033 u1_pel = USB3_LPM_MAX_U1_SEL_PEL;
4035 if (u2_sel > USB3_LPM_MAX_U2_SEL_PEL)
4036 u2_sel = USB3_LPM_MAX_U2_SEL_PEL;
4038 if (u2_pel > USB3_LPM_MAX_U2_SEL_PEL)
4039 u2_pel = USB3_LPM_MAX_U2_SEL_PEL;
4042 * usb_enable_lpm() can be called as part of a failed device reset,
4043 * which may be initiated by an error path of a mass storage driver.
4044 * Therefore, use GFP_NOIO.
4046 sel_values = kmalloc(sizeof *(sel_values), GFP_NOIO);
4050 sel_values->u1_sel = u1_sel;
4051 sel_values->u1_pel = u1_pel;
4052 sel_values->u2_sel = cpu_to_le16(u2_sel);
4053 sel_values->u2_pel = cpu_to_le16(u2_pel);
4055 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
4059 sel_values, sizeof *(sel_values),
4060 USB_CTRL_SET_TIMEOUT);
4066 * Enable or disable device-initiated U1 or U2 transitions.
4068 static int usb_set_device_initiated_lpm(struct usb_device *udev,
4069 enum usb3_link_state state, bool enable)
4076 feature = USB_DEVICE_U1_ENABLE;
4079 feature = USB_DEVICE_U2_ENABLE;
4082 dev_warn(&udev->dev, "%s: Can't %s non-U1 or U2 state.\n",
4083 __func__, enable ? "enable" : "disable");
4087 if (udev->state != USB_STATE_CONFIGURED) {
4088 dev_dbg(&udev->dev, "%s: Can't %s %s state "
4089 "for unconfigured device.\n",
4090 __func__, enable ? "enable" : "disable",
4091 usb3_lpm_names[state]);
4097 * Now send the control transfer to enable device-initiated LPM
4098 * for either U1 or U2.
4100 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
4101 USB_REQ_SET_FEATURE,
4105 USB_CTRL_SET_TIMEOUT);
4107 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
4108 USB_REQ_CLEAR_FEATURE,
4112 USB_CTRL_SET_TIMEOUT);
4115 dev_warn(&udev->dev, "%s of device-initiated %s failed.\n",
4116 enable ? "Enable" : "Disable",
4117 usb3_lpm_names[state]);
4123 static int usb_set_lpm_timeout(struct usb_device *udev,
4124 enum usb3_link_state state, int timeout)
4131 feature = USB_PORT_FEAT_U1_TIMEOUT;
4134 feature = USB_PORT_FEAT_U2_TIMEOUT;
4137 dev_warn(&udev->dev, "%s: Can't set timeout for non-U1 or U2 state.\n",
4142 if (state == USB3_LPM_U1 && timeout > USB3_LPM_U1_MAX_TIMEOUT &&
4143 timeout != USB3_LPM_DEVICE_INITIATED) {
4144 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x, "
4145 "which is a reserved value.\n",
4146 usb3_lpm_names[state], timeout);
4150 ret = set_port_feature(udev->parent,
4151 USB_PORT_LPM_TIMEOUT(timeout) | udev->portnum,
4154 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x,"
4155 "error code %i\n", usb3_lpm_names[state],
4159 if (state == USB3_LPM_U1)
4160 udev->u1_params.timeout = timeout;
4162 udev->u2_params.timeout = timeout;
4167 * Don't allow device intiated U1/U2 if the system exit latency + one bus
4168 * interval is greater than the minimum service interval of any active
4169 * periodic endpoint. See USB 3.2 section 9.4.9
4171 static bool usb_device_may_initiate_lpm(struct usb_device *udev,
4172 enum usb3_link_state state)
4174 unsigned int sel; /* us */
4177 if (state == USB3_LPM_U1)
4178 sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
4179 else if (state == USB3_LPM_U2)
4180 sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
4184 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
4185 struct usb_interface *intf;
4186 struct usb_endpoint_descriptor *desc;
4187 unsigned int interval;
4189 intf = udev->actconfig->interface[i];
4193 for (j = 0; j < intf->cur_altsetting->desc.bNumEndpoints; j++) {
4194 desc = &intf->cur_altsetting->endpoint[j].desc;
4196 if (usb_endpoint_xfer_int(desc) ||
4197 usb_endpoint_xfer_isoc(desc)) {
4198 interval = (1 << (desc->bInterval - 1)) * 125;
4199 if (sel + 125 > interval)
4208 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
4211 * We will attempt to enable U1 or U2, but there are no guarantees that the
4212 * control transfers to set the hub timeout or enable device-initiated U1/U2
4213 * will be successful.
4215 * If the control transfer to enable device-initiated U1/U2 entry fails, then
4216 * hub-initiated U1/U2 will be disabled.
4218 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
4219 * driver know about it. If that call fails, it should be harmless, and just
4220 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
4222 static void usb_enable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
4223 enum usb3_link_state state)
4229 /* Skip if the device BOS descriptor couldn't be read */
4233 u1_mel = udev->bos->ss_cap->bU1devExitLat;
4234 u2_mel = udev->bos->ss_cap->bU2DevExitLat;
4236 /* If the device says it doesn't have *any* exit latency to come out of
4237 * U1 or U2, it's probably lying. Assume it doesn't implement that link
4240 if ((state == USB3_LPM_U1 && u1_mel == 0) ||
4241 (state == USB3_LPM_U2 && u2_mel == 0))
4245 * First, let the device know about the exit latencies
4246 * associated with the link state we're about to enable.
4248 ret = usb_req_set_sel(udev, state);
4250 dev_warn(&udev->dev, "Set SEL for device-initiated %s failed.\n",
4251 usb3_lpm_names[state]);
4255 /* We allow the host controller to set the U1/U2 timeout internally
4256 * first, so that it can change its schedule to account for the
4257 * additional latency to send data to a device in a lower power
4260 timeout = hcd->driver->enable_usb3_lpm_timeout(hcd, udev, state);
4262 /* xHCI host controller doesn't want to enable this LPM state. */
4267 dev_warn(&udev->dev, "Could not enable %s link state, "
4268 "xHCI error %i.\n", usb3_lpm_names[state],
4273 if (usb_set_lpm_timeout(udev, state, timeout)) {
4274 /* If we can't set the parent hub U1/U2 timeout,
4275 * device-initiated LPM won't be allowed either, so let the xHCI
4276 * host know that this link state won't be enabled.
4278 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
4282 /* Only a configured device will accept the Set Feature
4285 if (udev->actconfig &&
4286 usb_device_may_initiate_lpm(udev, state)) {
4287 if (usb_set_device_initiated_lpm(udev, state, true)) {
4289 * Request to enable device initiated U1/U2 failed,
4290 * better to turn off lpm in this case.
4292 usb_set_lpm_timeout(udev, state, 0);
4293 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
4298 if (state == USB3_LPM_U1)
4299 udev->usb3_lpm_u1_enabled = 1;
4300 else if (state == USB3_LPM_U2)
4301 udev->usb3_lpm_u2_enabled = 1;
4304 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
4307 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
4308 * If zero is returned, the parent will not allow the link to go into U1/U2.
4310 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
4311 * it won't have an effect on the bus link state because the parent hub will
4312 * still disallow device-initiated U1/U2 entry.
4314 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
4315 * possible. The result will be slightly more bus bandwidth will be taken up
4316 * (to account for U1/U2 exit latency), but it should be harmless.
4318 static int usb_disable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
4319 enum usb3_link_state state)
4326 dev_warn(&udev->dev, "%s: Can't disable non-U1 or U2 state.\n",
4331 if (usb_set_lpm_timeout(udev, state, 0))
4334 usb_set_device_initiated_lpm(udev, state, false);
4336 if (hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state))
4337 dev_warn(&udev->dev, "Could not disable xHCI %s timeout, "
4338 "bus schedule bandwidth may be impacted.\n",
4339 usb3_lpm_names[state]);
4341 /* As soon as usb_set_lpm_timeout(0) return 0, hub initiated LPM
4342 * is disabled. Hub will disallows link to enter U1/U2 as well,
4343 * even device is initiating LPM. Hence LPM is disabled if hub LPM
4344 * timeout set to 0, no matter device-initiated LPM is disabled or
4347 if (state == USB3_LPM_U1)
4348 udev->usb3_lpm_u1_enabled = 0;
4349 else if (state == USB3_LPM_U2)
4350 udev->usb3_lpm_u2_enabled = 0;
4356 * Disable hub-initiated and device-initiated U1 and U2 entry.
4357 * Caller must own the bandwidth_mutex.
4359 * This will call usb_enable_lpm() on failure, which will decrement
4360 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
4362 int usb_disable_lpm(struct usb_device *udev)
4364 struct usb_hcd *hcd;
4366 if (!udev || !udev->parent ||
4367 udev->speed < USB_SPEED_SUPER ||
4368 !udev->lpm_capable ||
4369 udev->state < USB_STATE_CONFIGURED)
4372 hcd = bus_to_hcd(udev->bus);
4373 if (!hcd || !hcd->driver->disable_usb3_lpm_timeout)
4376 udev->lpm_disable_count++;
4377 if ((udev->u1_params.timeout == 0 && udev->u2_params.timeout == 0))
4380 /* If LPM is enabled, attempt to disable it. */
4381 if (usb_disable_link_state(hcd, udev, USB3_LPM_U1))
4383 if (usb_disable_link_state(hcd, udev, USB3_LPM_U2))
4389 usb_enable_lpm(udev);
4392 EXPORT_SYMBOL_GPL(usb_disable_lpm);
4394 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
4395 int usb_unlocked_disable_lpm(struct usb_device *udev)
4397 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4403 mutex_lock(hcd->bandwidth_mutex);
4404 ret = usb_disable_lpm(udev);
4405 mutex_unlock(hcd->bandwidth_mutex);
4409 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
4412 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
4413 * xHCI host policy may prevent U1 or U2 from being enabled.
4415 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
4416 * until the lpm_disable_count drops to zero. Caller must own the
4419 void usb_enable_lpm(struct usb_device *udev)
4421 struct usb_hcd *hcd;
4422 struct usb_hub *hub;
4423 struct usb_port *port_dev;
4425 if (!udev || !udev->parent ||
4426 udev->speed < USB_SPEED_SUPER ||
4427 !udev->lpm_capable ||
4428 udev->state < USB_STATE_CONFIGURED)
4431 udev->lpm_disable_count--;
4432 hcd = bus_to_hcd(udev->bus);
4433 /* Double check that we can both enable and disable LPM.
4434 * Device must be configured to accept set feature U1/U2 timeout.
4436 if (!hcd || !hcd->driver->enable_usb3_lpm_timeout ||
4437 !hcd->driver->disable_usb3_lpm_timeout)
4440 if (udev->lpm_disable_count > 0)
4443 hub = usb_hub_to_struct_hub(udev->parent);
4447 port_dev = hub->ports[udev->portnum - 1];
4449 if (port_dev->usb3_lpm_u1_permit)
4450 usb_enable_link_state(hcd, udev, USB3_LPM_U1);
4452 if (port_dev->usb3_lpm_u2_permit)
4453 usb_enable_link_state(hcd, udev, USB3_LPM_U2);
4455 EXPORT_SYMBOL_GPL(usb_enable_lpm);
4457 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
4458 void usb_unlocked_enable_lpm(struct usb_device *udev)
4460 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4465 mutex_lock(hcd->bandwidth_mutex);
4466 usb_enable_lpm(udev);
4467 mutex_unlock(hcd->bandwidth_mutex);
4469 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
4471 /* usb3 devices use U3 for disabled, make sure remote wakeup is disabled */
4472 static void hub_usb3_port_prepare_disable(struct usb_hub *hub,
4473 struct usb_port *port_dev)
4475 struct usb_device *udev = port_dev->child;
4478 if (udev && udev->port_is_suspended && udev->do_remote_wakeup) {
4479 ret = hub_set_port_link_state(hub, port_dev->portnum,
4482 msleep(USB_RESUME_TIMEOUT);
4483 ret = usb_disable_remote_wakeup(udev);
4486 dev_warn(&udev->dev,
4487 "Port disable: can't disable remote wake\n");
4488 udev->do_remote_wakeup = 0;
4492 #else /* CONFIG_PM */
4494 #define hub_suspend NULL
4495 #define hub_resume NULL
4496 #define hub_reset_resume NULL
4498 static inline void hub_usb3_port_prepare_disable(struct usb_hub *hub,
4499 struct usb_port *port_dev) { }
4501 int usb_disable_lpm(struct usb_device *udev)
4505 EXPORT_SYMBOL_GPL(usb_disable_lpm);
4507 void usb_enable_lpm(struct usb_device *udev) { }
4508 EXPORT_SYMBOL_GPL(usb_enable_lpm);
4510 int usb_unlocked_disable_lpm(struct usb_device *udev)
4514 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
4516 void usb_unlocked_enable_lpm(struct usb_device *udev) { }
4517 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
4519 int usb_disable_ltm(struct usb_device *udev)
4523 EXPORT_SYMBOL_GPL(usb_disable_ltm);
4525 void usb_enable_ltm(struct usb_device *udev) { }
4526 EXPORT_SYMBOL_GPL(usb_enable_ltm);
4528 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
4529 u16 portstatus, u16 portchange)
4534 #endif /* CONFIG_PM */
4537 * USB-3 does not have a similar link state as USB-2 that will avoid negotiating
4538 * a connection with a plugged-in cable but will signal the host when the cable
4539 * is unplugged. Disable remote wake and set link state to U3 for USB-3 devices
4541 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
4543 struct usb_port *port_dev = hub->ports[port1 - 1];
4544 struct usb_device *hdev = hub->hdev;
4548 if (hub_is_superspeed(hub->hdev)) {
4549 hub_usb3_port_prepare_disable(hub, port_dev);
4550 ret = hub_set_port_link_state(hub, port_dev->portnum,
4553 ret = usb_clear_port_feature(hdev, port1,
4554 USB_PORT_FEAT_ENABLE);
4557 if (port_dev->child && set_state)
4558 usb_set_device_state(port_dev->child, USB_STATE_NOTATTACHED);
4559 if (ret && ret != -ENODEV)
4560 dev_err(&port_dev->dev, "cannot disable (err = %d)\n", ret);
4565 * usb_port_disable - disable a usb device's upstream port
4566 * @udev: device to disable
4567 * Context: @udev locked, must be able to sleep.
4569 * Disables a USB device that isn't in active use.
4571 int usb_port_disable(struct usb_device *udev)
4573 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
4575 return hub_port_disable(hub, udev->portnum, 0);
4578 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
4580 * Between connect detection and reset signaling there must be a delay
4581 * of 100ms at least for debounce and power-settling. The corresponding
4582 * timer shall restart whenever the downstream port detects a disconnect.
4584 * Apparently there are some bluetooth and irda-dongles and a number of
4585 * low-speed devices for which this debounce period may last over a second.
4586 * Not covered by the spec - but easy to deal with.
4588 * This implementation uses a 1500ms total debounce timeout; if the
4589 * connection isn't stable by then it returns -ETIMEDOUT. It checks
4590 * every 25ms for transient disconnects. When the port status has been
4591 * unchanged for 100ms it returns the port status.
4593 int hub_port_debounce(struct usb_hub *hub, int port1, bool must_be_connected)
4596 u16 portchange, portstatus;
4597 unsigned connection = 0xffff;
4598 int total_time, stable_time = 0;
4599 struct usb_port *port_dev = hub->ports[port1 - 1];
4601 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
4602 ret = hub_port_status(hub, port1, &portstatus, &portchange);
4606 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
4607 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
4608 if (!must_be_connected ||
4609 (connection == USB_PORT_STAT_CONNECTION))
4610 stable_time += HUB_DEBOUNCE_STEP;
4611 if (stable_time >= HUB_DEBOUNCE_STABLE)
4615 connection = portstatus & USB_PORT_STAT_CONNECTION;
4618 if (portchange & USB_PORT_STAT_C_CONNECTION) {
4619 usb_clear_port_feature(hub->hdev, port1,
4620 USB_PORT_FEAT_C_CONNECTION);
4623 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
4625 msleep(HUB_DEBOUNCE_STEP);
4628 dev_dbg(&port_dev->dev, "debounce total %dms stable %dms status 0x%x\n",
4629 total_time, stable_time, portstatus);
4631 if (stable_time < HUB_DEBOUNCE_STABLE)
4636 void usb_ep0_reinit(struct usb_device *udev)
4638 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
4639 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
4640 usb_enable_endpoint(udev, &udev->ep0, true);
4642 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
4644 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
4645 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
4647 static int hub_set_address(struct usb_device *udev, int devnum)
4650 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4653 * The host controller will choose the device address,
4654 * instead of the core having chosen it earlier
4656 if (!hcd->driver->address_device && devnum <= 1)
4658 if (udev->state == USB_STATE_ADDRESS)
4660 if (udev->state != USB_STATE_DEFAULT)
4662 if (hcd->driver->address_device)
4663 retval = hcd->driver->address_device(hcd, udev);
4665 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
4666 USB_REQ_SET_ADDRESS, 0, devnum, 0,
4667 NULL, 0, USB_CTRL_SET_TIMEOUT);
4669 update_devnum(udev, devnum);
4670 /* Device now using proper address. */
4671 usb_set_device_state(udev, USB_STATE_ADDRESS);
4672 usb_ep0_reinit(udev);
4678 * There are reports of USB 3.0 devices that say they support USB 2.0 Link PM
4679 * when they're plugged into a USB 2.0 port, but they don't work when LPM is
4682 * Only enable USB 2.0 Link PM if the port is internal (hardwired), or the
4683 * device says it supports the new USB 2.0 Link PM errata by setting the BESL
4684 * support bit in the BOS descriptor.
4686 static void hub_set_initial_usb2_lpm_policy(struct usb_device *udev)
4688 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
4689 int connect_type = USB_PORT_CONNECT_TYPE_UNKNOWN;
4691 if (!udev->usb2_hw_lpm_capable || !udev->bos)
4695 connect_type = hub->ports[udev->portnum - 1]->connect_type;
4697 if ((udev->bos->ext_cap->bmAttributes & cpu_to_le32(USB_BESL_SUPPORT)) ||
4698 connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
4699 udev->usb2_hw_lpm_allowed = 1;
4700 usb_enable_usb2_hardware_lpm(udev);
4704 static int hub_enable_device(struct usb_device *udev)
4706 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4708 if (!hcd->driver->enable_device)
4710 if (udev->state == USB_STATE_ADDRESS)
4712 if (udev->state != USB_STATE_DEFAULT)
4715 return hcd->driver->enable_device(hcd, udev);
4719 * Get the bMaxPacketSize0 value during initialization by reading the
4720 * device's device descriptor. Since we don't already know this value,
4721 * the transfer is unsafe and it ignores I/O errors, only testing for
4722 * reasonable received values.
4724 * For "old scheme" initialization, size will be 8 so we read just the
4725 * start of the device descriptor, which should work okay regardless of
4726 * the actual bMaxPacketSize0 value. For "new scheme" initialization,
4727 * size will be 64 (and buf will point to a sufficiently large buffer),
4728 * which might not be kosher according to the USB spec but it's what
4729 * Windows does and what many devices expect.
4731 * Returns: bMaxPacketSize0 or a negative error code.
4733 static int get_bMaxPacketSize0(struct usb_device *udev,
4734 struct usb_device_descriptor *buf, int size, bool first_time)
4739 * Retry on all errors; some devices are flakey.
4740 * 255 is for WUSB devices, we actually need to use
4741 * 512 (WUSB1.0[4.8.1]).
4743 for (i = 0; i < GET_MAXPACKET0_TRIES; ++i) {
4744 /* Start with invalid values in case the transfer fails */
4745 buf->bDescriptorType = buf->bMaxPacketSize0 = 0;
4746 rc = usb_control_msg(udev, usb_rcvaddr0pipe(),
4747 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
4748 USB_DT_DEVICE << 8, 0,
4750 initial_descriptor_timeout);
4751 switch (buf->bMaxPacketSize0) {
4752 case 8: case 16: case 32: case 64: case 9:
4753 if (buf->bDescriptorType == USB_DT_DEVICE) {
4754 rc = buf->bMaxPacketSize0;
4765 * Some devices time out if they are powered on
4766 * when already connected. They need a second
4767 * reset, so return early. But only on the first
4768 * attempt, lest we get into a time-out/reset loop.
4770 if (rc > 0 || (rc == -ETIMEDOUT && first_time &&
4771 udev->speed > USB_SPEED_FULL))
4777 #define GET_DESCRIPTOR_BUFSIZE 64
4779 /* Reset device, (re)assign address, get device descriptor.
4780 * Device connection must be stable, no more debouncing needed.
4781 * Returns device in USB_STATE_ADDRESS, except on error.
4783 * If this is called for an already-existing device (as part of
4784 * usb_reset_and_verify_device), the caller must own the device lock and
4785 * the port lock. For a newly detected device that is not accessible
4786 * through any global pointers, it's not necessary to lock the device,
4787 * but it is still necessary to lock the port.
4789 * For a newly detected device, @dev_descr must be NULL. The device
4790 * descriptor retrieved from the device will then be stored in
4791 * @udev->descriptor. For an already existing device, @dev_descr
4792 * must be non-NULL. The device descriptor will be stored there,
4793 * not in @udev->descriptor, because descriptors for registered
4794 * devices are meant to be immutable.
4797 hub_port_init(struct usb_hub *hub, struct usb_device *udev, int port1,
4798 int retry_counter, struct usb_device_descriptor *dev_descr)
4800 struct usb_device *hdev = hub->hdev;
4801 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4802 struct usb_port *port_dev = hub->ports[port1 - 1];
4803 int retries, operations, retval, i;
4804 unsigned delay = HUB_SHORT_RESET_TIME;
4805 enum usb_device_speed oldspeed = udev->speed;
4807 int devnum = udev->devnum;
4808 const char *driver_name;
4810 const bool initial = !dev_descr;
4812 struct usb_device_descriptor *buf, *descr;
4814 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
4818 /* root hub ports have a slightly longer reset period
4819 * (from USB 2.0 spec, section 7.1.7.5)
4821 if (!hdev->parent) {
4822 delay = HUB_ROOT_RESET_TIME;
4823 if (port1 == hdev->bus->otg_port)
4824 hdev->bus->b_hnp_enable = 0;
4827 /* Some low speed devices have problems with the quick delay, so */
4828 /* be a bit pessimistic with those devices. RHbug #23670 */
4829 if (oldspeed == USB_SPEED_LOW)
4830 delay = HUB_LONG_RESET_TIME;
4832 /* Reset the device; full speed may morph to high speed */
4833 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
4834 retval = hub_port_reset(hub, port1, udev, delay, false);
4835 if (retval < 0) /* error or disconnect */
4837 /* success, speed is known */
4841 /* Don't allow speed changes at reset, except usb 3.0 to faster */
4842 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed &&
4843 !(oldspeed == USB_SPEED_SUPER && udev->speed > oldspeed)) {
4844 dev_dbg(&udev->dev, "device reset changed speed!\n");
4847 oldspeed = udev->speed;
4850 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4851 * it's fixed size except for full speed devices.
4852 * For Wireless USB devices, ep0 max packet is always 512 (tho
4853 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4855 switch (udev->speed) {
4856 case USB_SPEED_SUPER_PLUS:
4857 case USB_SPEED_SUPER:
4858 case USB_SPEED_WIRELESS: /* fixed at 512 */
4859 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
4861 case USB_SPEED_HIGH: /* fixed at 64 */
4862 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4864 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
4865 /* to determine the ep0 maxpacket size, try to read
4866 * the device descriptor to get bMaxPacketSize0 and
4867 * then correct our initial guess.
4869 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4871 case USB_SPEED_LOW: /* fixed at 8 */
4872 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
4879 if (udev->speed == USB_SPEED_WIRELESS)
4880 speed = "variable speed Wireless";
4882 speed = usb_speed_string(udev->speed);
4885 * The controller driver may be NULL if the controller device
4886 * is the middle device between platform device and roothub.
4887 * This middle device may not need a device driver due to
4888 * all hardware control can be at platform device driver, this
4889 * platform device is usually a dual-role USB controller device.
4891 if (udev->bus->controller->driver)
4892 driver_name = udev->bus->controller->driver->name;
4894 driver_name = udev->bus->sysdev->driver->name;
4896 if (udev->speed < USB_SPEED_SUPER)
4897 dev_info(&udev->dev,
4898 "%s %s USB device number %d using %s\n",
4899 (initial ? "new" : "reset"), speed,
4900 devnum, driver_name);
4903 /* Set up TT records, if needed */
4905 udev->tt = hdev->tt;
4906 udev->ttport = hdev->ttport;
4907 } else if (udev->speed != USB_SPEED_HIGH
4908 && hdev->speed == USB_SPEED_HIGH) {
4910 dev_err(&udev->dev, "parent hub has no TT\n");
4914 udev->tt = &hub->tt;
4915 udev->ttport = port1;
4919 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4920 * Because device hardware and firmware is sometimes buggy in
4921 * this area, and this is how Linux has done it for ages.
4922 * Change it cautiously.
4924 * NOTE: If use_new_scheme() is true we will start by issuing
4925 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4926 * so it may help with some non-standards-compliant devices.
4927 * Otherwise we start with SET_ADDRESS and then try to read the
4928 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4931 do_new_scheme = use_new_scheme(udev, retry_counter, port_dev);
4933 for (retries = 0; retries < GET_DESCRIPTOR_TRIES; (++retries, msleep(100))) {
4934 if (do_new_scheme) {
4935 retval = hub_enable_device(udev);
4938 "hub failed to enable device, error %d\n",
4943 maxp0 = get_bMaxPacketSize0(udev, buf,
4944 GET_DESCRIPTOR_BUFSIZE, retries == 0);
4945 if (maxp0 > 0 && !initial &&
4946 maxp0 != udev->descriptor.bMaxPacketSize0) {
4947 dev_err(&udev->dev, "device reset changed ep0 maxpacket size!\n");
4952 retval = hub_port_reset(hub, port1, udev, delay, false);
4953 if (retval < 0) /* error or disconnect */
4955 if (oldspeed != udev->speed) {
4957 "device reset changed speed!\n");
4962 if (maxp0 != -ENODEV)
4963 dev_err(&udev->dev, "device descriptor read/64, error %d\n",
4971 * If device is WUSB, we already assigned an
4972 * unauthorized address in the Connect Ack sequence;
4973 * authorization will assign the final address.
4975 if (udev->wusb == 0) {
4976 for (operations = 0; operations < SET_ADDRESS_TRIES; ++operations) {
4977 retval = hub_set_address(udev, devnum);
4983 if (retval != -ENODEV)
4984 dev_err(&udev->dev, "device not accepting address %d, error %d\n",
4988 if (udev->speed >= USB_SPEED_SUPER) {
4989 devnum = udev->devnum;
4990 dev_info(&udev->dev,
4991 "%s SuperSpeed%s%s USB device number %d using %s\n",
4992 (udev->config) ? "reset" : "new",
4993 (udev->speed == USB_SPEED_SUPER_PLUS) ?
4994 "Plus Gen 2" : " Gen 1",
4995 (udev->rx_lanes == 2 && udev->tx_lanes == 2) ?
4997 devnum, driver_name);
5000 /* cope with hardware quirkiness:
5001 * - let SET_ADDRESS settle, some device hardware wants it
5002 * - read ep0 maxpacket even for high and low speed,
5009 /* !do_new_scheme || wusb */
5010 maxp0 = get_bMaxPacketSize0(udev, buf, 8, retries == 0);
5013 if (retval != -ENODEV)
5015 "device descriptor read/8, error %d\n",
5020 if (!initial && maxp0 != udev->descriptor.bMaxPacketSize0) {
5021 dev_err(&udev->dev, "device reset changed ep0 maxpacket size!\n");
5026 delay = udev->parent->hub_delay;
5027 udev->hub_delay = min_t(u32, delay,
5028 USB_TP_TRANSMISSION_DELAY_MAX);
5029 retval = usb_set_isoch_delay(udev);
5032 "Failed set isoch delay, error %d\n",
5043 * Check the ep0 maxpacket guess and correct it if necessary.
5044 * maxp0 is the value stored in the device descriptor;
5045 * i is the value it encodes (logarithmic for SuperSpeed or greater).
5048 if (udev->speed >= USB_SPEED_SUPER) {
5052 i = 0; /* Invalid */
5054 if (usb_endpoint_maxp(&udev->ep0.desc) == i) {
5055 ; /* Initial ep0 maxpacket guess is right */
5056 } else if (((udev->speed == USB_SPEED_FULL ||
5057 udev->speed == USB_SPEED_HIGH) &&
5058 (i == 8 || i == 16 || i == 32 || i == 64)) ||
5059 (udev->speed >= USB_SPEED_SUPER && i > 0)) {
5060 /* Initial guess is wrong; use the descriptor's value */
5061 if (udev->speed == USB_SPEED_FULL)
5062 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
5064 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
5065 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
5066 usb_ep0_reinit(udev);
5068 /* Initial guess is wrong and descriptor's value is invalid */
5069 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", maxp0);
5074 descr = usb_get_device_descriptor(udev);
5075 if (IS_ERR(descr)) {
5076 retval = PTR_ERR(descr);
5077 if (retval != -ENODEV)
5078 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
5083 udev->descriptor = *descr;
5085 *dev_descr = *descr;
5089 * Some superspeed devices have finished the link training process
5090 * and attached to a superspeed hub port, but the device descriptor
5091 * got from those devices show they aren't superspeed devices. Warm
5092 * reset the port attached by the devices can fix them.
5094 if ((udev->speed >= USB_SPEED_SUPER) &&
5095 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
5096 dev_err(&udev->dev, "got a wrong device descriptor, warm reset device\n");
5097 hub_port_reset(hub, port1, udev, HUB_BH_RESET_TIME, true);
5102 usb_detect_quirks(udev);
5104 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
5105 retval = usb_get_bos_descriptor(udev);
5107 udev->lpm_capable = usb_device_supports_lpm(udev);
5108 usb_set_lpm_parameters(udev);
5113 /* notify HCD that we have a device connected and addressed */
5114 if (hcd->driver->update_device)
5115 hcd->driver->update_device(hcd, udev);
5116 hub_set_initial_usb2_lpm_policy(udev);
5119 hub_port_disable(hub, port1, 0);
5120 update_devnum(udev, devnum); /* for disconnect processing */
5127 check_highspeed(struct usb_hub *hub, struct usb_device *udev, int port1)
5129 struct usb_qualifier_descriptor *qual;
5132 if (udev->quirks & USB_QUIRK_DEVICE_QUALIFIER)
5135 qual = kmalloc(sizeof *qual, GFP_KERNEL);
5139 status = usb_get_descriptor(udev, USB_DT_DEVICE_QUALIFIER, 0,
5140 qual, sizeof *qual);
5141 if (status == sizeof *qual) {
5142 dev_info(&udev->dev, "not running at top speed; "
5143 "connect to a high speed hub\n");
5144 /* hub LEDs are probably harder to miss than syslog */
5145 if (hub->has_indicators) {
5146 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
5147 queue_delayed_work(system_power_efficient_wq,
5155 hub_power_remaining(struct usb_hub *hub)
5157 struct usb_device *hdev = hub->hdev;
5161 if (!hub->limited_power)
5164 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
5165 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
5166 struct usb_port *port_dev = hub->ports[port1 - 1];
5167 struct usb_device *udev = port_dev->child;
5173 if (hub_is_superspeed(udev))
5179 * Unconfigured devices may not use more than one unit load,
5180 * or 8mA for OTG ports
5182 if (udev->actconfig)
5183 delta = usb_get_max_power(udev, udev->actconfig);
5184 else if (port1 != udev->bus->otg_port || hdev->parent)
5188 if (delta > hub->mA_per_port)
5189 dev_warn(&port_dev->dev, "%dmA is over %umA budget!\n",
5190 delta, hub->mA_per_port);
5193 if (remaining < 0) {
5194 dev_warn(hub->intfdev, "%dmA over power budget!\n",
5202 static int descriptors_changed(struct usb_device *udev,
5203 struct usb_device_descriptor *new_device_descriptor,
5204 struct usb_host_bos *old_bos)
5208 unsigned serial_len = 0;
5210 unsigned old_length;
5214 if (memcmp(&udev->descriptor, new_device_descriptor,
5215 sizeof(*new_device_descriptor)) != 0)
5218 if ((old_bos && !udev->bos) || (!old_bos && udev->bos))
5221 len = le16_to_cpu(udev->bos->desc->wTotalLength);
5222 if (len != le16_to_cpu(old_bos->desc->wTotalLength))
5224 if (memcmp(udev->bos->desc, old_bos->desc, len))
5228 /* Since the idVendor, idProduct, and bcdDevice values in the
5229 * device descriptor haven't changed, we will assume the
5230 * Manufacturer and Product strings haven't changed either.
5231 * But the SerialNumber string could be different (e.g., a
5232 * different flash card of the same brand).
5235 serial_len = strlen(udev->serial) + 1;
5238 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5239 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5240 len = max(len, old_length);
5243 buf = kmalloc(len, GFP_NOIO);
5245 /* assume the worst */
5248 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5249 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5250 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
5252 if (length != old_length) {
5253 dev_dbg(&udev->dev, "config index %d, error %d\n",
5258 if (memcmp(buf, udev->rawdescriptors[index], old_length)
5260 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
5262 ((struct usb_config_descriptor *) buf)->
5263 bConfigurationValue);
5269 if (!changed && serial_len) {
5270 length = usb_string(udev, udev->descriptor.iSerialNumber,
5272 if (length + 1 != serial_len) {
5273 dev_dbg(&udev->dev, "serial string error %d\n",
5276 } else if (memcmp(buf, udev->serial, length) != 0) {
5277 dev_dbg(&udev->dev, "serial string changed\n");
5286 static void hub_port_connect(struct usb_hub *hub, int port1, u16 portstatus,
5289 int status = -ENODEV;
5292 struct usb_device *hdev = hub->hdev;
5293 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
5294 struct usb_port *port_dev = hub->ports[port1 - 1];
5295 struct usb_device *udev = port_dev->child;
5296 static int unreliable_port = -1;
5299 /* Disconnect any existing devices under this port */
5301 if (hcd->usb_phy && !hdev->parent)
5302 usb_phy_notify_disconnect(hcd->usb_phy, udev->speed);
5303 usb_disconnect(&port_dev->child);
5306 /* We can forget about a "removed" device when there's a physical
5307 * disconnect or the connect status changes.
5309 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
5310 (portchange & USB_PORT_STAT_C_CONNECTION))
5311 clear_bit(port1, hub->removed_bits);
5313 if (portchange & (USB_PORT_STAT_C_CONNECTION |
5314 USB_PORT_STAT_C_ENABLE)) {
5315 status = hub_port_debounce_be_stable(hub, port1);
5317 if (status != -ENODEV &&
5318 port1 != unreliable_port &&
5320 dev_err(&port_dev->dev, "connect-debounce failed\n");
5321 portstatus &= ~USB_PORT_STAT_CONNECTION;
5322 unreliable_port = port1;
5324 portstatus = status;
5328 /* Return now if debouncing failed or nothing is connected or
5329 * the device was "removed".
5331 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
5332 test_bit(port1, hub->removed_bits)) {
5335 * maybe switch power back on (e.g. root hub was reset)
5336 * but only if the port isn't owned by someone else.
5338 if (hub_is_port_power_switchable(hub)
5339 && !port_is_power_on(hub, portstatus)
5340 && !port_dev->port_owner)
5341 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
5343 if (portstatus & USB_PORT_STAT_ENABLE)
5347 if (hub_is_superspeed(hub->hdev))
5354 for (i = 0; i < PORT_INIT_TRIES; i++) {
5355 usb_lock_port(port_dev);
5356 mutex_lock(hcd->address0_mutex);
5357 retry_locked = true;
5358 /* reallocate for each attempt, since references
5359 * to the previous one can escape in various ways
5361 udev = usb_alloc_dev(hdev, hdev->bus, port1);
5363 dev_err(&port_dev->dev,
5364 "couldn't allocate usb_device\n");
5365 mutex_unlock(hcd->address0_mutex);
5366 usb_unlock_port(port_dev);
5370 usb_set_device_state(udev, USB_STATE_POWERED);
5371 udev->bus_mA = hub->mA_per_port;
5372 udev->level = hdev->level + 1;
5373 udev->wusb = hub_is_wusb(hub);
5375 /* Devices connected to SuperSpeed hubs are USB 3.0 or later */
5376 if (hub_is_superspeed(hub->hdev))
5377 udev->speed = USB_SPEED_SUPER;
5379 udev->speed = USB_SPEED_UNKNOWN;
5381 choose_devnum(udev);
5382 if (udev->devnum <= 0) {
5383 status = -ENOTCONN; /* Don't retry */
5387 /* reset (non-USB 3.0 devices) and get descriptor */
5388 status = hub_port_init(hub, udev, port1, i, NULL);
5392 mutex_unlock(hcd->address0_mutex);
5393 usb_unlock_port(port_dev);
5394 retry_locked = false;
5396 if (udev->quirks & USB_QUIRK_DELAY_INIT)
5399 /* consecutive bus-powered hubs aren't reliable; they can
5400 * violate the voltage drop budget. if the new child has
5401 * a "powered" LED, users should notice we didn't enable it
5402 * (without reading syslog), even without per-port LEDs
5405 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
5406 && udev->bus_mA <= unit_load) {
5409 status = usb_get_std_status(udev, USB_RECIP_DEVICE, 0,
5412 dev_dbg(&udev->dev, "get status %d ?\n", status);
5415 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
5417 "can't connect bus-powered hub "
5419 if (hub->has_indicators) {
5420 hub->indicator[port1-1] =
5421 INDICATOR_AMBER_BLINK;
5423 system_power_efficient_wq,
5426 status = -ENOTCONN; /* Don't retry */
5431 /* check for devices running slower than they could */
5432 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
5433 && udev->speed == USB_SPEED_FULL
5434 && highspeed_hubs != 0)
5435 check_highspeed(hub, udev, port1);
5437 /* Store the parent's children[] pointer. At this point
5438 * udev becomes globally accessible, although presumably
5439 * no one will look at it until hdev is unlocked.
5443 mutex_lock(&usb_port_peer_mutex);
5445 /* We mustn't add new devices if the parent hub has
5446 * been disconnected; we would race with the
5447 * recursively_mark_NOTATTACHED() routine.
5449 spin_lock_irq(&device_state_lock);
5450 if (hdev->state == USB_STATE_NOTATTACHED)
5453 port_dev->child = udev;
5454 spin_unlock_irq(&device_state_lock);
5455 mutex_unlock(&usb_port_peer_mutex);
5457 /* Run it through the hoops (find a driver, etc) */
5459 status = usb_new_device(udev);
5461 mutex_lock(&usb_port_peer_mutex);
5462 spin_lock_irq(&device_state_lock);
5463 port_dev->child = NULL;
5464 spin_unlock_irq(&device_state_lock);
5465 mutex_unlock(&usb_port_peer_mutex);
5467 if (hcd->usb_phy && !hdev->parent)
5468 usb_phy_notify_connect(hcd->usb_phy,
5476 status = hub_power_remaining(hub);
5478 dev_dbg(hub->intfdev, "%dmA power budget left\n", status);
5483 hub_port_disable(hub, port1, 1);
5485 usb_ep0_reinit(udev);
5486 release_devnum(udev);
5489 mutex_unlock(hcd->address0_mutex);
5490 usb_unlock_port(port_dev);
5493 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
5496 /* When halfway through our retry count, power-cycle the port */
5497 if (i == (PORT_INIT_TRIES - 1) / 2) {
5498 dev_info(&port_dev->dev, "attempt power cycle\n");
5499 usb_hub_set_port_power(hdev, hub, port1, false);
5500 msleep(2 * hub_power_on_good_delay(hub));
5501 usb_hub_set_port_power(hdev, hub, port1, true);
5502 msleep(hub_power_on_good_delay(hub));
5505 if (hub->hdev->parent ||
5506 !hcd->driver->port_handed_over ||
5507 !(hcd->driver->port_handed_over)(hcd, port1)) {
5508 if (status != -ENOTCONN && status != -ENODEV)
5509 dev_err(&port_dev->dev,
5510 "unable to enumerate USB device\n");
5514 hub_port_disable(hub, port1, 1);
5515 if (hcd->driver->relinquish_port && !hub->hdev->parent) {
5516 if (status != -ENOTCONN && status != -ENODEV)
5517 hcd->driver->relinquish_port(hcd, port1);
5521 /* Handle physical or logical connection change events.
5522 * This routine is called when:
5523 * a port connection-change occurs;
5524 * a port enable-change occurs (often caused by EMI);
5525 * usb_reset_and_verify_device() encounters changed descriptors (as from
5526 * a firmware download)
5527 * caller already locked the hub
5529 static void hub_port_connect_change(struct usb_hub *hub, int port1,
5530 u16 portstatus, u16 portchange)
5531 __must_hold(&port_dev->status_lock)
5533 struct usb_port *port_dev = hub->ports[port1 - 1];
5534 struct usb_device *udev = port_dev->child;
5535 struct usb_device_descriptor *descr;
5536 int status = -ENODEV;
5538 dev_dbg(&port_dev->dev, "status %04x, change %04x, %s\n", portstatus,
5539 portchange, portspeed(hub, portstatus));
5541 if (hub->has_indicators) {
5542 set_port_led(hub, port1, HUB_LED_AUTO);
5543 hub->indicator[port1-1] = INDICATOR_AUTO;
5546 #ifdef CONFIG_USB_OTG
5547 /* during HNP, don't repeat the debounce */
5548 if (hub->hdev->bus->is_b_host)
5549 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
5550 USB_PORT_STAT_C_ENABLE);
5553 /* Try to resuscitate an existing device */
5554 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
5555 udev->state != USB_STATE_NOTATTACHED) {
5556 if (portstatus & USB_PORT_STAT_ENABLE) {
5558 * USB-3 connections are initialized automatically by
5559 * the hostcontroller hardware. Therefore check for
5560 * changed device descriptors before resuscitating the
5563 descr = usb_get_device_descriptor(udev);
5564 if (IS_ERR(descr)) {
5566 "can't read device descriptor %ld\n",
5569 if (descriptors_changed(udev, descr,
5572 "device descriptor has changed\n");
5574 status = 0; /* Nothing to do */
5579 } else if (udev->state == USB_STATE_SUSPENDED &&
5580 udev->persist_enabled) {
5581 /* For a suspended device, treat this as a
5582 * remote wakeup event.
5584 usb_unlock_port(port_dev);
5585 status = usb_remote_wakeup(udev);
5586 usb_lock_port(port_dev);
5589 /* Don't resuscitate */;
5592 clear_bit(port1, hub->change_bits);
5594 /* successfully revalidated the connection */
5598 usb_unlock_port(port_dev);
5599 hub_port_connect(hub, port1, portstatus, portchange);
5600 usb_lock_port(port_dev);
5603 /* Handle notifying userspace about hub over-current events */
5604 static void port_over_current_notify(struct usb_port *port_dev)
5607 struct device *hub_dev;
5608 char *port_dev_path;
5610 sysfs_notify(&port_dev->dev.kobj, NULL, "over_current_count");
5612 hub_dev = port_dev->dev.parent;
5617 port_dev_path = kobject_get_path(&port_dev->dev.kobj, GFP_KERNEL);
5621 envp[0] = kasprintf(GFP_KERNEL, "OVER_CURRENT_PORT=%s", port_dev_path);
5625 envp[1] = kasprintf(GFP_KERNEL, "OVER_CURRENT_COUNT=%u",
5626 port_dev->over_current_count);
5631 kobject_uevent_env(&hub_dev->kobj, KOBJ_CHANGE, envp);
5637 kfree(port_dev_path);
5640 static void port_event(struct usb_hub *hub, int port1)
5641 __must_hold(&port_dev->status_lock)
5644 struct usb_port *port_dev = hub->ports[port1 - 1];
5645 struct usb_device *udev = port_dev->child;
5646 struct usb_device *hdev = hub->hdev;
5647 u16 portstatus, portchange;
5649 connect_change = test_bit(port1, hub->change_bits);
5650 clear_bit(port1, hub->event_bits);
5651 clear_bit(port1, hub->wakeup_bits);
5653 if (hub_port_status(hub, port1, &portstatus, &portchange) < 0)
5656 if (portchange & USB_PORT_STAT_C_CONNECTION) {
5657 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_CONNECTION);
5661 if (portchange & USB_PORT_STAT_C_ENABLE) {
5662 if (!connect_change)
5663 dev_dbg(&port_dev->dev, "enable change, status %08x\n",
5665 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_ENABLE);
5668 * EM interference sometimes causes badly shielded USB devices
5669 * to be shutdown by the hub, this hack enables them again.
5670 * Works at least with mouse driver.
5672 if (!(portstatus & USB_PORT_STAT_ENABLE)
5673 && !connect_change && udev) {
5674 dev_err(&port_dev->dev, "disabled by hub (EMI?), re-enabling...\n");
5679 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
5680 u16 status = 0, unused;
5681 port_dev->over_current_count++;
5682 port_over_current_notify(port_dev);
5684 dev_dbg(&port_dev->dev, "over-current change #%u\n",
5685 port_dev->over_current_count);
5686 usb_clear_port_feature(hdev, port1,
5687 USB_PORT_FEAT_C_OVER_CURRENT);
5688 msleep(100); /* Cool down */
5689 hub_power_on(hub, true);
5690 hub_port_status(hub, port1, &status, &unused);
5691 if (status & USB_PORT_STAT_OVERCURRENT)
5692 dev_err(&port_dev->dev, "over-current condition\n");
5695 if (portchange & USB_PORT_STAT_C_RESET) {
5696 dev_dbg(&port_dev->dev, "reset change\n");
5697 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_RESET);
5699 if ((portchange & USB_PORT_STAT_C_BH_RESET)
5700 && hub_is_superspeed(hdev)) {
5701 dev_dbg(&port_dev->dev, "warm reset change\n");
5702 usb_clear_port_feature(hdev, port1,
5703 USB_PORT_FEAT_C_BH_PORT_RESET);
5705 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
5706 dev_dbg(&port_dev->dev, "link state change\n");
5707 usb_clear_port_feature(hdev, port1,
5708 USB_PORT_FEAT_C_PORT_LINK_STATE);
5710 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
5711 dev_warn(&port_dev->dev, "config error\n");
5712 usb_clear_port_feature(hdev, port1,
5713 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
5716 /* skip port actions that require the port to be powered on */
5717 if (!pm_runtime_active(&port_dev->dev))
5720 if (hub_handle_remote_wakeup(hub, port1, portstatus, portchange))
5724 * Warm reset a USB3 protocol port if it's in
5725 * SS.Inactive state.
5727 if (hub_port_warm_reset_required(hub, port1, portstatus)) {
5728 dev_dbg(&port_dev->dev, "do warm reset\n");
5729 if (!udev || !(portstatus & USB_PORT_STAT_CONNECTION)
5730 || udev->state == USB_STATE_NOTATTACHED) {
5731 if (hub_port_reset(hub, port1, NULL,
5732 HUB_BH_RESET_TIME, true) < 0)
5733 hub_port_disable(hub, port1, 1);
5735 usb_unlock_port(port_dev);
5736 usb_lock_device(udev);
5737 usb_reset_device(udev);
5738 usb_unlock_device(udev);
5739 usb_lock_port(port_dev);
5745 hub_port_connect_change(hub, port1, portstatus, portchange);
5748 static void hub_event(struct work_struct *work)
5750 struct usb_device *hdev;
5751 struct usb_interface *intf;
5752 struct usb_hub *hub;
5753 struct device *hub_dev;
5758 hub = container_of(work, struct usb_hub, events);
5760 hub_dev = hub->intfdev;
5761 intf = to_usb_interface(hub_dev);
5763 kcov_remote_start_usb((u64)hdev->bus->busnum);
5765 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
5766 hdev->state, hdev->maxchild,
5767 /* NOTE: expects max 15 ports... */
5768 (u16) hub->change_bits[0],
5769 (u16) hub->event_bits[0]);
5771 /* Lock the device, then check to see if we were
5772 * disconnected while waiting for the lock to succeed. */
5773 usb_lock_device(hdev);
5774 if (unlikely(hub->disconnected))
5777 /* If the hub has died, clean up after it */
5778 if (hdev->state == USB_STATE_NOTATTACHED) {
5779 hub->error = -ENODEV;
5780 hub_quiesce(hub, HUB_DISCONNECT);
5785 ret = usb_autopm_get_interface(intf);
5787 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
5791 /* If this is an inactive hub, do nothing */
5796 dev_dbg(hub_dev, "resetting for error %d\n", hub->error);
5798 ret = usb_reset_device(hdev);
5800 dev_dbg(hub_dev, "error resetting hub: %d\n", ret);
5808 /* deal with port status changes */
5809 for (i = 1; i <= hdev->maxchild; i++) {
5810 struct usb_port *port_dev = hub->ports[i - 1];
5812 if (test_bit(i, hub->event_bits)
5813 || test_bit(i, hub->change_bits)
5814 || test_bit(i, hub->wakeup_bits)) {
5816 * The get_noresume and barrier ensure that if
5817 * the port was in the process of resuming, we
5818 * flush that work and keep the port active for
5819 * the duration of the port_event(). However,
5820 * if the port is runtime pm suspended
5821 * (powered-off), we leave it in that state, run
5822 * an abbreviated port_event(), and move on.
5824 pm_runtime_get_noresume(&port_dev->dev);
5825 pm_runtime_barrier(&port_dev->dev);
5826 usb_lock_port(port_dev);
5828 usb_unlock_port(port_dev);
5829 pm_runtime_put_sync(&port_dev->dev);
5833 /* deal with hub status changes */
5834 if (test_and_clear_bit(0, hub->event_bits) == 0)
5836 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
5837 dev_err(hub_dev, "get_hub_status failed\n");
5839 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
5840 dev_dbg(hub_dev, "power change\n");
5841 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
5842 if (hubstatus & HUB_STATUS_LOCAL_POWER)
5843 /* FIXME: Is this always true? */
5844 hub->limited_power = 1;
5846 hub->limited_power = 0;
5848 if (hubchange & HUB_CHANGE_OVERCURRENT) {
5852 dev_dbg(hub_dev, "over-current change\n");
5853 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
5854 msleep(500); /* Cool down */
5855 hub_power_on(hub, true);
5856 hub_hub_status(hub, &status, &unused);
5857 if (status & HUB_STATUS_OVERCURRENT)
5858 dev_err(hub_dev, "over-current condition\n");
5863 /* Balance the usb_autopm_get_interface() above */
5864 usb_autopm_put_interface_no_suspend(intf);
5866 usb_unlock_device(hdev);
5868 /* Balance the stuff in kick_hub_wq() and allow autosuspend */
5869 usb_autopm_put_interface(intf);
5875 static const struct usb_device_id hub_id_table[] = {
5876 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5877 | USB_DEVICE_ID_MATCH_PRODUCT
5878 | USB_DEVICE_ID_MATCH_INT_CLASS,
5879 .idVendor = USB_VENDOR_SMSC,
5880 .idProduct = USB_PRODUCT_USB5534B,
5881 .bInterfaceClass = USB_CLASS_HUB,
5882 .driver_info = HUB_QUIRK_DISABLE_AUTOSUSPEND},
5883 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5884 | USB_DEVICE_ID_MATCH_PRODUCT,
5885 .idVendor = USB_VENDOR_CYPRESS,
5886 .idProduct = USB_PRODUCT_CY7C65632,
5887 .driver_info = HUB_QUIRK_DISABLE_AUTOSUSPEND},
5888 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5889 | USB_DEVICE_ID_MATCH_INT_CLASS,
5890 .idVendor = USB_VENDOR_GENESYS_LOGIC,
5891 .bInterfaceClass = USB_CLASS_HUB,
5892 .driver_info = HUB_QUIRK_CHECK_PORT_AUTOSUSPEND},
5893 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5894 | USB_DEVICE_ID_MATCH_PRODUCT,
5895 .idVendor = USB_VENDOR_TEXAS_INSTRUMENTS,
5896 .idProduct = USB_PRODUCT_TUSB8041_USB2,
5897 .driver_info = HUB_QUIRK_DISABLE_AUTOSUSPEND},
5898 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5899 | USB_DEVICE_ID_MATCH_PRODUCT,
5900 .idVendor = USB_VENDOR_TEXAS_INSTRUMENTS,
5901 .idProduct = USB_PRODUCT_TUSB8041_USB3,
5902 .driver_info = HUB_QUIRK_DISABLE_AUTOSUSPEND},
5903 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
5904 .bDeviceClass = USB_CLASS_HUB},
5905 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
5906 .bInterfaceClass = USB_CLASS_HUB},
5907 { } /* Terminating entry */
5910 MODULE_DEVICE_TABLE(usb, hub_id_table);
5912 static struct usb_driver hub_driver = {
5915 .disconnect = hub_disconnect,
5916 .suspend = hub_suspend,
5917 .resume = hub_resume,
5918 .reset_resume = hub_reset_resume,
5919 .pre_reset = hub_pre_reset,
5920 .post_reset = hub_post_reset,
5921 .unlocked_ioctl = hub_ioctl,
5922 .id_table = hub_id_table,
5923 .supports_autosuspend = 1,
5926 int usb_hub_init(void)
5928 if (usb_register(&hub_driver) < 0) {
5929 printk(KERN_ERR "%s: can't register hub driver\n",
5935 * The workqueue needs to be freezable to avoid interfering with
5936 * USB-PERSIST port handover. Otherwise it might see that a full-speed
5937 * device was gone before the EHCI controller had handed its port
5938 * over to the companion full-speed controller.
5940 hub_wq = alloc_workqueue("usb_hub_wq", WQ_FREEZABLE, 0);
5944 /* Fall through if kernel_thread failed */
5945 usb_deregister(&hub_driver);
5946 pr_err("%s: can't allocate workqueue for usb hub\n", usbcore_name);
5951 void usb_hub_cleanup(void)
5953 destroy_workqueue(hub_wq);
5956 * Hub resources are freed for us by usb_deregister. It calls
5957 * usb_driver_purge on every device which in turn calls that
5958 * devices disconnect function if it is using this driver.
5959 * The hub_disconnect function takes care of releasing the
5960 * individual hub resources. -greg
5962 usb_deregister(&hub_driver);
5963 } /* usb_hub_cleanup() */
5966 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5967 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5969 * WARNING - don't use this routine to reset a composite device
5970 * (one with multiple interfaces owned by separate drivers)!
5971 * Use usb_reset_device() instead.
5973 * Do a port reset, reassign the device's address, and establish its
5974 * former operating configuration. If the reset fails, or the device's
5975 * descriptors change from their values before the reset, or the original
5976 * configuration and altsettings cannot be restored, a flag will be set
5977 * telling hub_wq to pretend the device has been disconnected and then
5978 * re-connected. All drivers will be unbound, and the device will be
5979 * re-enumerated and probed all over again.
5981 * Return: 0 if the reset succeeded, -ENODEV if the device has been
5982 * flagged for logical disconnection, or some other negative error code
5983 * if the reset wasn't even attempted.
5986 * The caller must own the device lock and the port lock, the latter is
5987 * taken by usb_reset_device(). For example, it's safe to use
5988 * usb_reset_device() from a driver probe() routine after downloading
5989 * new firmware. For calls that might not occur during probe(), drivers
5990 * should lock the device using usb_lock_device_for_reset().
5992 * Locking exception: This routine may also be called from within an
5993 * autoresume handler. Such usage won't conflict with other tasks
5994 * holding the device lock because these tasks should always call
5995 * usb_autopm_resume_device(), thereby preventing any unwanted
5996 * autoresume. The autoresume handler is expected to have already
5997 * acquired the port lock before calling this routine.
5999 static int usb_reset_and_verify_device(struct usb_device *udev)
6001 struct usb_device *parent_hdev = udev->parent;
6002 struct usb_hub *parent_hub;
6003 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
6004 struct usb_device_descriptor descriptor;
6005 struct usb_host_bos *bos;
6007 int port1 = udev->portnum;
6009 if (udev->state == USB_STATE_NOTATTACHED ||
6010 udev->state == USB_STATE_SUSPENDED) {
6011 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
6019 parent_hub = usb_hub_to_struct_hub(parent_hdev);
6021 /* Disable USB2 hardware LPM.
6022 * It will be re-enabled by the enumeration process.
6024 usb_disable_usb2_hardware_lpm(udev);
6026 /* Disable LPM while we reset the device and reinstall the alt settings.
6027 * Device-initiated LPM, and system exit latency settings are cleared
6028 * when the device is reset, so we have to set them up again.
6030 ret = usb_unlocked_disable_lpm(udev);
6032 dev_err(&udev->dev, "%s Failed to disable LPM\n", __func__);
6033 goto re_enumerate_no_bos;
6039 mutex_lock(hcd->address0_mutex);
6041 for (i = 0; i < PORT_INIT_TRIES; ++i) {
6043 /* ep0 maxpacket size may change; let the HCD know about it.
6044 * Other endpoints will be handled by re-enumeration. */
6045 usb_ep0_reinit(udev);
6046 ret = hub_port_init(parent_hub, udev, port1, i, &descriptor);
6047 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
6050 mutex_unlock(hcd->address0_mutex);
6055 /* Device might have changed firmware (DFU or similar) */
6056 if (descriptors_changed(udev, &descriptor, bos)) {
6057 dev_info(&udev->dev, "device firmware changed\n");
6061 /* Restore the device's previous configuration */
6062 if (!udev->actconfig)
6065 mutex_lock(hcd->bandwidth_mutex);
6066 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
6068 dev_warn(&udev->dev,
6069 "Busted HC? Not enough HCD resources for "
6070 "old configuration.\n");
6071 mutex_unlock(hcd->bandwidth_mutex);
6074 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
6075 USB_REQ_SET_CONFIGURATION, 0,
6076 udev->actconfig->desc.bConfigurationValue, 0,
6077 NULL, 0, USB_CTRL_SET_TIMEOUT);
6080 "can't restore configuration #%d (error=%d)\n",
6081 udev->actconfig->desc.bConfigurationValue, ret);
6082 mutex_unlock(hcd->bandwidth_mutex);
6085 mutex_unlock(hcd->bandwidth_mutex);
6086 usb_set_device_state(udev, USB_STATE_CONFIGURED);
6088 /* Put interfaces back into the same altsettings as before.
6089 * Don't bother to send the Set-Interface request for interfaces
6090 * that were already in altsetting 0; besides being unnecessary,
6091 * many devices can't handle it. Instead just reset the host-side
6094 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
6095 struct usb_host_config *config = udev->actconfig;
6096 struct usb_interface *intf = config->interface[i];
6097 struct usb_interface_descriptor *desc;
6099 desc = &intf->cur_altsetting->desc;
6100 if (desc->bAlternateSetting == 0) {
6101 usb_disable_interface(udev, intf, true);
6102 usb_enable_interface(udev, intf, true);
6105 /* Let the bandwidth allocation function know that this
6106 * device has been reset, and it will have to use
6107 * alternate setting 0 as the current alternate setting.
6109 intf->resetting_device = 1;
6110 ret = usb_set_interface(udev, desc->bInterfaceNumber,
6111 desc->bAlternateSetting);
6112 intf->resetting_device = 0;
6115 dev_err(&udev->dev, "failed to restore interface %d "
6116 "altsetting %d (error=%d)\n",
6117 desc->bInterfaceNumber,
6118 desc->bAlternateSetting,
6122 /* Resetting also frees any allocated streams */
6123 for (j = 0; j < intf->cur_altsetting->desc.bNumEndpoints; j++)
6124 intf->cur_altsetting->endpoint[j].streams = 0;
6128 /* Now that the alt settings are re-installed, enable LTM and LPM. */
6129 usb_enable_usb2_hardware_lpm(udev);
6130 usb_unlocked_enable_lpm(udev);
6131 usb_enable_ltm(udev);
6132 usb_release_bos_descriptor(udev);
6137 usb_release_bos_descriptor(udev);
6139 re_enumerate_no_bos:
6140 /* LPM state doesn't matter when we're about to destroy the device. */
6141 hub_port_logical_disconnect(parent_hub, port1);
6146 * usb_reset_device - warn interface drivers and perform a USB port reset
6147 * @udev: device to reset (not in NOTATTACHED state)
6149 * Warns all drivers bound to registered interfaces (using their pre_reset
6150 * method), performs the port reset, and then lets the drivers know that
6151 * the reset is over (using their post_reset method).
6153 * Return: The same as for usb_reset_and_verify_device().
6154 * However, if a reset is already in progress (for instance, if a
6155 * driver doesn't have pre_reset() or post_reset() callbacks, and while
6156 * being unbound or re-bound during the ongoing reset its disconnect()
6157 * or probe() routine tries to perform a second, nested reset), the
6158 * routine returns -EINPROGRESS.
6161 * The caller must own the device lock. For example, it's safe to use
6162 * this from a driver probe() routine after downloading new firmware.
6163 * For calls that might not occur during probe(), drivers should lock
6164 * the device using usb_lock_device_for_reset().
6166 * If an interface is currently being probed or disconnected, we assume
6167 * its driver knows how to handle resets. For all other interfaces,
6168 * if the driver doesn't have pre_reset and post_reset methods then
6169 * we attempt to unbind it and rebind afterward.
6171 int usb_reset_device(struct usb_device *udev)
6175 unsigned int noio_flag;
6176 struct usb_port *port_dev;
6177 struct usb_host_config *config = udev->actconfig;
6178 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
6180 if (udev->state == USB_STATE_NOTATTACHED) {
6181 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
6186 if (!udev->parent) {
6187 /* this requires hcd-specific logic; see ohci_restart() */
6188 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
6192 if (udev->reset_in_progress)
6193 return -EINPROGRESS;
6194 udev->reset_in_progress = 1;
6196 port_dev = hub->ports[udev->portnum - 1];
6199 * Don't allocate memory with GFP_KERNEL in current
6200 * context to avoid possible deadlock if usb mass
6201 * storage interface or usbnet interface(iSCSI case)
6202 * is included in current configuration. The easist
6203 * approach is to do it for every device reset,
6204 * because the device 'memalloc_noio' flag may have
6205 * not been set before reseting the usb device.
6207 noio_flag = memalloc_noio_save();
6209 /* Prevent autosuspend during the reset */
6210 usb_autoresume_device(udev);
6213 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
6214 struct usb_interface *cintf = config->interface[i];
6215 struct usb_driver *drv;
6218 if (cintf->dev.driver) {
6219 drv = to_usb_driver(cintf->dev.driver);
6220 if (drv->pre_reset && drv->post_reset)
6221 unbind = (drv->pre_reset)(cintf);
6222 else if (cintf->condition ==
6223 USB_INTERFACE_BOUND)
6226 usb_forced_unbind_intf(cintf);
6231 usb_lock_port(port_dev);
6232 ret = usb_reset_and_verify_device(udev);
6233 usb_unlock_port(port_dev);
6236 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
6237 struct usb_interface *cintf = config->interface[i];
6238 struct usb_driver *drv;
6239 int rebind = cintf->needs_binding;
6241 if (!rebind && cintf->dev.driver) {
6242 drv = to_usb_driver(cintf->dev.driver);
6243 if (drv->post_reset)
6244 rebind = (drv->post_reset)(cintf);
6245 else if (cintf->condition ==
6246 USB_INTERFACE_BOUND)
6249 cintf->needs_binding = 1;
6253 /* If the reset failed, hub_wq will unbind drivers later */
6255 usb_unbind_and_rebind_marked_interfaces(udev);
6258 usb_autosuspend_device(udev);
6259 memalloc_noio_restore(noio_flag);
6260 udev->reset_in_progress = 0;
6263 EXPORT_SYMBOL_GPL(usb_reset_device);
6267 * usb_queue_reset_device - Reset a USB device from an atomic context
6268 * @iface: USB interface belonging to the device to reset
6270 * This function can be used to reset a USB device from an atomic
6271 * context, where usb_reset_device() won't work (as it blocks).
6273 * Doing a reset via this method is functionally equivalent to calling
6274 * usb_reset_device(), except for the fact that it is delayed to a
6275 * workqueue. This means that any drivers bound to other interfaces
6276 * might be unbound, as well as users from usbfs in user space.
6280 * - Scheduling two resets at the same time from two different drivers
6281 * attached to two different interfaces of the same device is
6282 * possible; depending on how the driver attached to each interface
6283 * handles ->pre_reset(), the second reset might happen or not.
6285 * - If the reset is delayed so long that the interface is unbound from
6286 * its driver, the reset will be skipped.
6288 * - This function can be called during .probe(). It can also be called
6289 * during .disconnect(), but doing so is pointless because the reset
6290 * will not occur. If you really want to reset the device during
6291 * .disconnect(), call usb_reset_device() directly -- but watch out
6292 * for nested unbinding issues!
6294 void usb_queue_reset_device(struct usb_interface *iface)
6296 if (schedule_work(&iface->reset_ws))
6297 usb_get_intf(iface);
6299 EXPORT_SYMBOL_GPL(usb_queue_reset_device);
6302 * usb_hub_find_child - Get the pointer of child device
6303 * attached to the port which is specified by @port1.
6304 * @hdev: USB device belonging to the usb hub
6305 * @port1: port num to indicate which port the child device
6308 * USB drivers call this function to get hub's child device
6311 * Return: %NULL if input param is invalid and
6312 * child's usb_device pointer if non-NULL.
6314 struct usb_device *usb_hub_find_child(struct usb_device *hdev,
6317 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
6319 if (port1 < 1 || port1 > hdev->maxchild)
6321 return hub->ports[port1 - 1]->child;
6323 EXPORT_SYMBOL_GPL(usb_hub_find_child);
6325 void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
6326 struct usb_hub_descriptor *desc)
6328 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
6329 enum usb_port_connect_type connect_type;
6335 if (!hub_is_superspeed(hdev)) {
6336 for (i = 1; i <= hdev->maxchild; i++) {
6337 struct usb_port *port_dev = hub->ports[i - 1];
6339 connect_type = port_dev->connect_type;
6340 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
6341 u8 mask = 1 << (i%8);
6343 if (!(desc->u.hs.DeviceRemovable[i/8] & mask)) {
6344 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
6345 desc->u.hs.DeviceRemovable[i/8] |= mask;
6350 u16 port_removable = le16_to_cpu(desc->u.ss.DeviceRemovable);
6352 for (i = 1; i <= hdev->maxchild; i++) {
6353 struct usb_port *port_dev = hub->ports[i - 1];
6355 connect_type = port_dev->connect_type;
6356 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
6359 if (!(port_removable & mask)) {
6360 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
6361 port_removable |= mask;
6366 desc->u.ss.DeviceRemovable = cpu_to_le16(port_removable);
6372 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
6373 * @hdev: USB device belonging to the usb hub
6374 * @port1: port num of the port
6376 * Return: Port's acpi handle if successful, %NULL if params are
6379 acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
6382 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
6387 return ACPI_HANDLE(&hub->ports[port1 - 1]->dev);