4 * (C) Copyright 1999 Linus Torvalds
5 * (C) Copyright 1999 Johannes Erdfelt
6 * (C) Copyright 1999 Gregory P. Smith
7 * (C) Copyright 2001 Brad Hards (bhards@bigpond.net.au)
9 * Released under the GPLv2 only.
10 * SPDX-License-Identifier: GPL-2.0
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/ioctl.h>
22 #include <linux/usb.h>
23 #include <linux/usbdevice_fs.h>
24 #include <linux/usb/hcd.h>
25 #include <linux/usb/otg.h>
26 #include <linux/usb/quirks.h>
27 #include <linux/workqueue.h>
28 #include <linux/mutex.h>
29 #include <linux/random.h>
30 #include <linux/pm_qos.h>
32 #include <linux/uaccess.h>
33 #include <asm/byteorder.h>
36 #include "otg_whitelist.h"
38 #define USB_VENDOR_GENESYS_LOGIC 0x05e3
39 #define HUB_QUIRK_CHECK_PORT_AUTOSUSPEND 0x01
41 /* Protect struct usb_device->state and ->children members
42 * Note: Both are also protected by ->dev.sem, except that ->state can
43 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
44 static DEFINE_SPINLOCK(device_state_lock);
46 /* workqueue to process hub events */
47 static struct workqueue_struct *hub_wq;
48 static void hub_event(struct work_struct *work);
50 /* synchronize hub-port add/remove and peering operations */
51 DEFINE_MUTEX(usb_port_peer_mutex);
53 /* cycle leds on hubs that aren't blinking for attention */
54 static bool blinkenlights;
55 module_param(blinkenlights, bool, S_IRUGO);
56 MODULE_PARM_DESC(blinkenlights, "true to cycle leds on hubs");
59 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
60 * 10 seconds to send reply for the initial 64-byte descriptor request.
62 /* define initial 64-byte descriptor request timeout in milliseconds */
63 static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
64 module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
65 MODULE_PARM_DESC(initial_descriptor_timeout,
66 "initial 64-byte descriptor request timeout in milliseconds "
67 "(default 5000 - 5.0 seconds)");
70 * As of 2.6.10 we introduce a new USB device initialization scheme which
71 * closely resembles the way Windows works. Hopefully it will be compatible
72 * with a wider range of devices than the old scheme. However some previously
73 * working devices may start giving rise to "device not accepting address"
74 * errors; if that happens the user can try the old scheme by adjusting the
75 * following module parameters.
77 * For maximum flexibility there are two boolean parameters to control the
78 * hub driver's behavior. On the first initialization attempt, if the
79 * "old_scheme_first" parameter is set then the old scheme will be used,
80 * otherwise the new scheme is used. If that fails and "use_both_schemes"
81 * is set, then the driver will make another attempt, using the other scheme.
83 static bool old_scheme_first;
84 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
85 MODULE_PARM_DESC(old_scheme_first,
86 "start with the old device initialization scheme");
88 static bool use_both_schemes = 1;
89 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
90 MODULE_PARM_DESC(use_both_schemes,
91 "try the other device initialization scheme if the "
94 /* Mutual exclusion for EHCI CF initialization. This interferes with
95 * port reset on some companion controllers.
97 DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
98 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
100 #define HUB_DEBOUNCE_TIMEOUT 2000
101 #define HUB_DEBOUNCE_STEP 25
102 #define HUB_DEBOUNCE_STABLE 100
104 static void hub_release(struct kref *kref);
105 static int usb_reset_and_verify_device(struct usb_device *udev);
106 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state);
108 static inline char *portspeed(struct usb_hub *hub, int portstatus)
110 if (hub_is_superspeedplus(hub->hdev))
112 if (hub_is_superspeed(hub->hdev))
114 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
116 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
122 /* Note that hdev or one of its children must be locked! */
123 struct usb_hub *usb_hub_to_struct_hub(struct usb_device *hdev)
125 if (!hdev || !hdev->actconfig || !hdev->maxchild)
127 return usb_get_intfdata(hdev->actconfig->interface[0]);
130 int usb_device_supports_lpm(struct usb_device *udev)
132 /* Some devices have trouble with LPM */
133 if (udev->quirks & USB_QUIRK_NO_LPM)
136 /* USB 2.1 (and greater) devices indicate LPM support through
137 * their USB 2.0 Extended Capabilities BOS descriptor.
139 if (udev->speed == USB_SPEED_HIGH || udev->speed == USB_SPEED_FULL) {
140 if (udev->bos->ext_cap &&
142 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
148 * According to the USB 3.0 spec, all USB 3.0 devices must support LPM.
149 * However, there are some that don't, and they set the U1/U2 exit
152 if (!udev->bos->ss_cap) {
153 dev_info(&udev->dev, "No LPM exit latency info found, disabling LPM.\n");
157 if (udev->bos->ss_cap->bU1devExitLat == 0 &&
158 udev->bos->ss_cap->bU2DevExitLat == 0) {
160 dev_info(&udev->dev, "LPM exit latency is zeroed, disabling LPM.\n");
162 dev_info(&udev->dev, "We don't know the algorithms for LPM for this host, disabling LPM.\n");
166 if (!udev->parent || udev->parent->lpm_capable)
172 * Set the Maximum Exit Latency (MEL) for the host to initiate a transition from
175 static void usb_set_lpm_mel(struct usb_device *udev,
176 struct usb3_lpm_parameters *udev_lpm_params,
177 unsigned int udev_exit_latency,
179 struct usb3_lpm_parameters *hub_lpm_params,
180 unsigned int hub_exit_latency)
182 unsigned int total_mel;
183 unsigned int device_mel;
184 unsigned int hub_mel;
187 * Calculate the time it takes to transition all links from the roothub
188 * to the parent hub into U0. The parent hub must then decode the
189 * packet (hub header decode latency) to figure out which port it was
192 * The Hub Header decode latency is expressed in 0.1us intervals (0x1
193 * means 0.1us). Multiply that by 100 to get nanoseconds.
195 total_mel = hub_lpm_params->mel +
196 (hub->descriptor->u.ss.bHubHdrDecLat * 100);
199 * How long will it take to transition the downstream hub's port into
200 * U0? The greater of either the hub exit latency or the device exit
203 * The BOS U1/U2 exit latencies are expressed in 1us intervals.
204 * Multiply that by 1000 to get nanoseconds.
206 device_mel = udev_exit_latency * 1000;
207 hub_mel = hub_exit_latency * 1000;
208 if (device_mel > hub_mel)
209 total_mel += device_mel;
211 total_mel += hub_mel;
213 udev_lpm_params->mel = total_mel;
217 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
218 * a transition from either U1 or U2.
220 static void usb_set_lpm_pel(struct usb_device *udev,
221 struct usb3_lpm_parameters *udev_lpm_params,
222 unsigned int udev_exit_latency,
224 struct usb3_lpm_parameters *hub_lpm_params,
225 unsigned int hub_exit_latency,
226 unsigned int port_to_port_exit_latency)
228 unsigned int first_link_pel;
229 unsigned int hub_pel;
232 * First, the device sends an LFPS to transition the link between the
233 * device and the parent hub into U0. The exit latency is the bigger of
234 * the device exit latency or the hub exit latency.
236 if (udev_exit_latency > hub_exit_latency)
237 first_link_pel = udev_exit_latency * 1000;
239 first_link_pel = hub_exit_latency * 1000;
242 * When the hub starts to receive the LFPS, there is a slight delay for
243 * it to figure out that one of the ports is sending an LFPS. Then it
244 * will forward the LFPS to its upstream link. The exit latency is the
245 * delay, plus the PEL that we calculated for this hub.
247 hub_pel = port_to_port_exit_latency * 1000 + hub_lpm_params->pel;
250 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
251 * is the greater of the two exit latencies.
253 if (first_link_pel > hub_pel)
254 udev_lpm_params->pel = first_link_pel;
256 udev_lpm_params->pel = hub_pel;
260 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
261 * when a device initiates a transition to U0, until when it will receive the
262 * first packet from the host controller.
264 * Section C.1.5.1 describes the four components to this:
266 * - t2: time for the ERDY to make it from the device to the host.
267 * - t3: a host-specific delay to process the ERDY.
268 * - t4: time for the packet to make it from the host to the device.
270 * t3 is specific to both the xHCI host and the platform the host is integrated
271 * into. The Intel HW folks have said it's negligible, FIXME if a different
272 * vendor says otherwise.
274 static void usb_set_lpm_sel(struct usb_device *udev,
275 struct usb3_lpm_parameters *udev_lpm_params)
277 struct usb_device *parent;
278 unsigned int num_hubs;
279 unsigned int total_sel;
281 /* t1 = device PEL */
282 total_sel = udev_lpm_params->pel;
283 /* How many external hubs are in between the device & the root port. */
284 for (parent = udev->parent, num_hubs = 0; parent->parent;
285 parent = parent->parent)
287 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
289 total_sel += 2100 + 250 * (num_hubs - 1);
291 /* t4 = 250ns * num_hubs */
292 total_sel += 250 * num_hubs;
294 udev_lpm_params->sel = total_sel;
297 static void usb_set_lpm_parameters(struct usb_device *udev)
300 unsigned int port_to_port_delay;
301 unsigned int udev_u1_del;
302 unsigned int udev_u2_del;
303 unsigned int hub_u1_del;
304 unsigned int hub_u2_del;
306 if (!udev->lpm_capable || udev->speed < USB_SPEED_SUPER)
309 hub = usb_hub_to_struct_hub(udev->parent);
310 /* It doesn't take time to transition the roothub into U0, since it
311 * doesn't have an upstream link.
316 udev_u1_del = udev->bos->ss_cap->bU1devExitLat;
317 udev_u2_del = le16_to_cpu(udev->bos->ss_cap->bU2DevExitLat);
318 hub_u1_del = udev->parent->bos->ss_cap->bU1devExitLat;
319 hub_u2_del = le16_to_cpu(udev->parent->bos->ss_cap->bU2DevExitLat);
321 usb_set_lpm_mel(udev, &udev->u1_params, udev_u1_del,
322 hub, &udev->parent->u1_params, hub_u1_del);
324 usb_set_lpm_mel(udev, &udev->u2_params, udev_u2_del,
325 hub, &udev->parent->u2_params, hub_u2_del);
328 * Appendix C, section C.2.2.2, says that there is a slight delay from
329 * when the parent hub notices the downstream port is trying to
330 * transition to U0 to when the hub initiates a U0 transition on its
331 * upstream port. The section says the delays are tPort2PortU1EL and
332 * tPort2PortU2EL, but it doesn't define what they are.
334 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
335 * about the same delays. Use the maximum delay calculations from those
336 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
337 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
338 * assume the device exit latencies they are talking about are the hub
341 * What do we do if the U2 exit latency is less than the U1 exit
342 * latency? It's possible, although not likely...
344 port_to_port_delay = 1;
346 usb_set_lpm_pel(udev, &udev->u1_params, udev_u1_del,
347 hub, &udev->parent->u1_params, hub_u1_del,
350 if (hub_u2_del > hub_u1_del)
351 port_to_port_delay = 1 + hub_u2_del - hub_u1_del;
353 port_to_port_delay = 1 + hub_u1_del;
355 usb_set_lpm_pel(udev, &udev->u2_params, udev_u2_del,
356 hub, &udev->parent->u2_params, hub_u2_del,
359 /* Now that we've got PEL, calculate SEL. */
360 usb_set_lpm_sel(udev, &udev->u1_params);
361 usb_set_lpm_sel(udev, &udev->u2_params);
364 /* USB 2.0 spec Section 11.24.4.5 */
365 static int get_hub_descriptor(struct usb_device *hdev, void *data)
370 if (hub_is_superspeed(hdev)) {
371 dtype = USB_DT_SS_HUB;
372 size = USB_DT_SS_HUB_SIZE;
375 size = sizeof(struct usb_hub_descriptor);
378 for (i = 0; i < 3; i++) {
379 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
380 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
381 dtype << 8, 0, data, size,
382 USB_CTRL_GET_TIMEOUT);
383 if (hub_is_superspeed(hdev)) {
386 } else if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2)) {
394 * USB 2.0 spec Section 11.24.2.1
396 static int clear_hub_feature(struct usb_device *hdev, int feature)
398 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
399 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
403 * USB 2.0 spec Section 11.24.2.2
405 int usb_clear_port_feature(struct usb_device *hdev, int port1, int feature)
407 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
408 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
413 * USB 2.0 spec Section 11.24.2.13
415 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
417 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
418 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
422 static char *to_led_name(int selector)
439 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
440 * for info about using port indicators
442 static void set_port_led(struct usb_hub *hub, int port1, int selector)
444 struct usb_port *port_dev = hub->ports[port1 - 1];
447 status = set_port_feature(hub->hdev, (selector << 8) | port1,
448 USB_PORT_FEAT_INDICATOR);
449 dev_dbg(&port_dev->dev, "indicator %s status %d\n",
450 to_led_name(selector), status);
453 #define LED_CYCLE_PERIOD ((2*HZ)/3)
455 static void led_work(struct work_struct *work)
457 struct usb_hub *hub =
458 container_of(work, struct usb_hub, leds.work);
459 struct usb_device *hdev = hub->hdev;
461 unsigned changed = 0;
464 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
467 for (i = 0; i < hdev->maxchild; i++) {
468 unsigned selector, mode;
470 /* 30%-50% duty cycle */
472 switch (hub->indicator[i]) {
474 case INDICATOR_CYCLE:
476 selector = HUB_LED_AUTO;
477 mode = INDICATOR_AUTO;
479 /* blinking green = sw attention */
480 case INDICATOR_GREEN_BLINK:
481 selector = HUB_LED_GREEN;
482 mode = INDICATOR_GREEN_BLINK_OFF;
484 case INDICATOR_GREEN_BLINK_OFF:
485 selector = HUB_LED_OFF;
486 mode = INDICATOR_GREEN_BLINK;
488 /* blinking amber = hw attention */
489 case INDICATOR_AMBER_BLINK:
490 selector = HUB_LED_AMBER;
491 mode = INDICATOR_AMBER_BLINK_OFF;
493 case INDICATOR_AMBER_BLINK_OFF:
494 selector = HUB_LED_OFF;
495 mode = INDICATOR_AMBER_BLINK;
497 /* blink green/amber = reserved */
498 case INDICATOR_ALT_BLINK:
499 selector = HUB_LED_GREEN;
500 mode = INDICATOR_ALT_BLINK_OFF;
502 case INDICATOR_ALT_BLINK_OFF:
503 selector = HUB_LED_AMBER;
504 mode = INDICATOR_ALT_BLINK;
509 if (selector != HUB_LED_AUTO)
511 set_port_led(hub, i + 1, selector);
512 hub->indicator[i] = mode;
514 if (!changed && blinkenlights) {
516 cursor %= hdev->maxchild;
517 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
518 hub->indicator[cursor] = INDICATOR_CYCLE;
522 queue_delayed_work(system_power_efficient_wq,
523 &hub->leds, LED_CYCLE_PERIOD);
526 /* use a short timeout for hub/port status fetches */
527 #define USB_STS_TIMEOUT 1000
528 #define USB_STS_RETRIES 5
531 * USB 2.0 spec Section 11.24.2.6
533 static int get_hub_status(struct usb_device *hdev,
534 struct usb_hub_status *data)
536 int i, status = -ETIMEDOUT;
538 for (i = 0; i < USB_STS_RETRIES &&
539 (status == -ETIMEDOUT || status == -EPIPE); i++) {
540 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
541 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
542 data, sizeof(*data), USB_STS_TIMEOUT);
548 * USB 2.0 spec Section 11.24.2.7
549 * USB 3.1 takes into use the wValue and wLength fields, spec Section 10.16.2.6
551 static int get_port_status(struct usb_device *hdev, int port1,
552 void *data, u16 value, u16 length)
554 int i, status = -ETIMEDOUT;
556 for (i = 0; i < USB_STS_RETRIES &&
557 (status == -ETIMEDOUT || status == -EPIPE); i++) {
558 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
559 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, value,
560 port1, data, length, USB_STS_TIMEOUT);
565 static int hub_ext_port_status(struct usb_hub *hub, int port1, int type,
566 u16 *status, u16 *change, u32 *ext_status)
571 if (type != HUB_PORT_STATUS)
574 mutex_lock(&hub->status_mutex);
575 ret = get_port_status(hub->hdev, port1, &hub->status->port, type, len);
578 dev_err(hub->intfdev,
579 "%s failed (err = %d)\n", __func__, ret);
583 *status = le16_to_cpu(hub->status->port.wPortStatus);
584 *change = le16_to_cpu(hub->status->port.wPortChange);
585 if (type != HUB_PORT_STATUS && ext_status)
586 *ext_status = le32_to_cpu(
587 hub->status->port.dwExtPortStatus);
590 mutex_unlock(&hub->status_mutex);
594 static int hub_port_status(struct usb_hub *hub, int port1,
595 u16 *status, u16 *change)
597 return hub_ext_port_status(hub, port1, HUB_PORT_STATUS,
598 status, change, NULL);
601 static void kick_hub_wq(struct usb_hub *hub)
603 struct usb_interface *intf;
605 if (hub->disconnected || work_pending(&hub->events))
609 * Suppress autosuspend until the event is proceed.
611 * Be careful and make sure that the symmetric operation is
612 * always called. We are here only when there is no pending
613 * work for this hub. Therefore put the interface either when
614 * the new work is called or when it is canceled.
616 intf = to_usb_interface(hub->intfdev);
617 usb_autopm_get_interface_no_resume(intf);
618 kref_get(&hub->kref);
620 if (queue_work(hub_wq, &hub->events))
623 /* the work has already been scheduled */
624 usb_autopm_put_interface_async(intf);
625 kref_put(&hub->kref, hub_release);
628 void usb_kick_hub_wq(struct usb_device *hdev)
630 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
637 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
638 * Notification, which indicates it had initiated remote wakeup.
640 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
641 * device initiates resume, so the USB core will not receive notice of the
642 * resume through the normal hub interrupt URB.
644 void usb_wakeup_notification(struct usb_device *hdev,
645 unsigned int portnum)
652 hub = usb_hub_to_struct_hub(hdev);
654 set_bit(portnum, hub->wakeup_bits);
658 EXPORT_SYMBOL_GPL(usb_wakeup_notification);
660 /* completion function, fires on port status changes and various faults */
661 static void hub_irq(struct urb *urb)
663 struct usb_hub *hub = urb->context;
664 int status = urb->status;
669 case -ENOENT: /* synchronous unlink */
670 case -ECONNRESET: /* async unlink */
671 case -ESHUTDOWN: /* hardware going away */
674 default: /* presumably an error */
675 /* Cause a hub reset after 10 consecutive errors */
676 dev_dbg(hub->intfdev, "transfer --> %d\n", status);
677 if ((++hub->nerrors < 10) || hub->error)
682 /* let hub_wq handle things */
683 case 0: /* we got data: port status changed */
685 for (i = 0; i < urb->actual_length; ++i)
686 bits |= ((unsigned long) ((*hub->buffer)[i]))
688 hub->event_bits[0] = bits;
694 /* Something happened, let hub_wq figure it out */
701 status = usb_submit_urb(hub->urb, GFP_ATOMIC);
702 if (status != 0 && status != -ENODEV && status != -EPERM)
703 dev_err(hub->intfdev, "resubmit --> %d\n", status);
706 /* USB 2.0 spec Section 11.24.2.3 */
708 hub_clear_tt_buffer(struct usb_device *hdev, u16 devinfo, u16 tt)
710 /* Need to clear both directions for control ep */
711 if (((devinfo >> 11) & USB_ENDPOINT_XFERTYPE_MASK) ==
712 USB_ENDPOINT_XFER_CONTROL) {
713 int status = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
714 HUB_CLEAR_TT_BUFFER, USB_RT_PORT,
715 devinfo ^ 0x8000, tt, NULL, 0, 1000);
719 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
720 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
725 * enumeration blocks hub_wq for a long time. we use keventd instead, since
726 * long blocking there is the exception, not the rule. accordingly, HCDs
727 * talking to TTs must queue control transfers (not just bulk and iso), so
728 * both can talk to the same hub concurrently.
730 static void hub_tt_work(struct work_struct *work)
732 struct usb_hub *hub =
733 container_of(work, struct usb_hub, tt.clear_work);
736 spin_lock_irqsave(&hub->tt.lock, flags);
737 while (!list_empty(&hub->tt.clear_list)) {
738 struct list_head *next;
739 struct usb_tt_clear *clear;
740 struct usb_device *hdev = hub->hdev;
741 const struct hc_driver *drv;
744 next = hub->tt.clear_list.next;
745 clear = list_entry(next, struct usb_tt_clear, clear_list);
746 list_del(&clear->clear_list);
748 /* drop lock so HCD can concurrently report other TT errors */
749 spin_unlock_irqrestore(&hub->tt.lock, flags);
750 status = hub_clear_tt_buffer(hdev, clear->devinfo, clear->tt);
751 if (status && status != -ENODEV)
753 "clear tt %d (%04x) error %d\n",
754 clear->tt, clear->devinfo, status);
756 /* Tell the HCD, even if the operation failed */
757 drv = clear->hcd->driver;
758 if (drv->clear_tt_buffer_complete)
759 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
762 spin_lock_irqsave(&hub->tt.lock, flags);
764 spin_unlock_irqrestore(&hub->tt.lock, flags);
768 * usb_hub_set_port_power - control hub port's power state
769 * @hdev: USB device belonging to the usb hub
772 * @set: expected status
774 * call this function to control port's power via setting or
775 * clearing the port's PORT_POWER feature.
777 * Return: 0 if successful. A negative error code otherwise.
779 int usb_hub_set_port_power(struct usb_device *hdev, struct usb_hub *hub,
785 ret = set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
787 ret = usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
793 set_bit(port1, hub->power_bits);
795 clear_bit(port1, hub->power_bits);
800 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
801 * @urb: an URB associated with the failed or incomplete split transaction
803 * High speed HCDs use this to tell the hub driver that some split control or
804 * bulk transaction failed in a way that requires clearing internal state of
805 * a transaction translator. This is normally detected (and reported) from
808 * It may not be possible for that hub to handle additional full (or low)
809 * speed transactions until that state is fully cleared out.
811 * Return: 0 if successful. A negative error code otherwise.
813 int usb_hub_clear_tt_buffer(struct urb *urb)
815 struct usb_device *udev = urb->dev;
816 int pipe = urb->pipe;
817 struct usb_tt *tt = udev->tt;
819 struct usb_tt_clear *clear;
821 /* we've got to cope with an arbitrary number of pending TT clears,
822 * since each TT has "at least two" buffers that can need it (and
823 * there can be many TTs per hub). even if they're uncommon.
825 clear = kmalloc(sizeof *clear, GFP_ATOMIC);
827 dev_err(&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
828 /* FIXME recover somehow ... RESET_TT? */
832 /* info that CLEAR_TT_BUFFER needs */
833 clear->tt = tt->multi ? udev->ttport : 1;
834 clear->devinfo = usb_pipeendpoint (pipe);
835 clear->devinfo |= udev->devnum << 4;
836 clear->devinfo |= usb_pipecontrol(pipe)
837 ? (USB_ENDPOINT_XFER_CONTROL << 11)
838 : (USB_ENDPOINT_XFER_BULK << 11);
839 if (usb_pipein(pipe))
840 clear->devinfo |= 1 << 15;
842 /* info for completion callback */
843 clear->hcd = bus_to_hcd(udev->bus);
846 /* tell keventd to clear state for this TT */
847 spin_lock_irqsave(&tt->lock, flags);
848 list_add_tail(&clear->clear_list, &tt->clear_list);
849 schedule_work(&tt->clear_work);
850 spin_unlock_irqrestore(&tt->lock, flags);
853 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
855 static void hub_power_on(struct usb_hub *hub, bool do_delay)
859 /* Enable power on each port. Some hubs have reserved values
860 * of LPSM (> 2) in their descriptors, even though they are
861 * USB 2.0 hubs. Some hubs do not implement port-power switching
862 * but only emulate it. In all cases, the ports won't work
863 * unless we send these messages to the hub.
865 if (hub_is_port_power_switchable(hub))
866 dev_dbg(hub->intfdev, "enabling power on all ports\n");
868 dev_dbg(hub->intfdev, "trying to enable port power on "
869 "non-switchable hub\n");
870 for (port1 = 1; port1 <= hub->hdev->maxchild; port1++)
871 if (test_bit(port1, hub->power_bits))
872 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
874 usb_clear_port_feature(hub->hdev, port1,
875 USB_PORT_FEAT_POWER);
877 msleep(hub_power_on_good_delay(hub));
880 static int hub_hub_status(struct usb_hub *hub,
881 u16 *status, u16 *change)
885 mutex_lock(&hub->status_mutex);
886 ret = get_hub_status(hub->hdev, &hub->status->hub);
889 dev_err(hub->intfdev,
890 "%s failed (err = %d)\n", __func__, ret);
892 *status = le16_to_cpu(hub->status->hub.wHubStatus);
893 *change = le16_to_cpu(hub->status->hub.wHubChange);
896 mutex_unlock(&hub->status_mutex);
900 static int hub_set_port_link_state(struct usb_hub *hub, int port1,
901 unsigned int link_status)
903 return set_port_feature(hub->hdev,
904 port1 | (link_status << 3),
905 USB_PORT_FEAT_LINK_STATE);
909 * Disable a port and mark a logical connect-change event, so that some
910 * time later hub_wq will disconnect() any existing usb_device on the port
911 * and will re-enumerate if there actually is a device attached.
913 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
915 dev_dbg(&hub->ports[port1 - 1]->dev, "logical disconnect\n");
916 hub_port_disable(hub, port1, 1);
918 /* FIXME let caller ask to power down the port:
919 * - some devices won't enumerate without a VBUS power cycle
920 * - SRP saves power that way
921 * - ... new call, TBD ...
922 * That's easy if this hub can switch power per-port, and
923 * hub_wq reactivates the port later (timer, SRP, etc).
924 * Powerdown must be optional, because of reset/DFU.
927 set_bit(port1, hub->change_bits);
932 * usb_remove_device - disable a device's port on its parent hub
933 * @udev: device to be disabled and removed
934 * Context: @udev locked, must be able to sleep.
936 * After @udev's port has been disabled, hub_wq is notified and it will
937 * see that the device has been disconnected. When the device is
938 * physically unplugged and something is plugged in, the events will
939 * be received and processed normally.
941 * Return: 0 if successful. A negative error code otherwise.
943 int usb_remove_device(struct usb_device *udev)
946 struct usb_interface *intf;
948 if (!udev->parent) /* Can't remove a root hub */
950 hub = usb_hub_to_struct_hub(udev->parent);
951 intf = to_usb_interface(hub->intfdev);
953 usb_autopm_get_interface(intf);
954 set_bit(udev->portnum, hub->removed_bits);
955 hub_port_logical_disconnect(hub, udev->portnum);
956 usb_autopm_put_interface(intf);
960 enum hub_activation_type {
961 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
962 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
965 static void hub_init_func2(struct work_struct *ws);
966 static void hub_init_func3(struct work_struct *ws);
968 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
970 struct usb_device *hdev = hub->hdev;
975 bool need_debounce_delay = false;
978 /* Continue a partial initialization */
979 if (type == HUB_INIT2 || type == HUB_INIT3) {
980 device_lock(&hdev->dev);
982 /* Was the hub disconnected while we were waiting? */
983 if (hub->disconnected)
985 if (type == HUB_INIT2)
989 kref_get(&hub->kref);
991 /* The superspeed hub except for root hub has to use Hub Depth
992 * value as an offset into the route string to locate the bits
993 * it uses to determine the downstream port number. So hub driver
994 * should send a set hub depth request to superspeed hub after
995 * the superspeed hub is set configuration in initialization or
998 * After a resume, port power should still be on.
999 * For any other type of activation, turn it on.
1001 if (type != HUB_RESUME) {
1002 if (hdev->parent && hub_is_superspeed(hdev)) {
1003 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
1004 HUB_SET_DEPTH, USB_RT_HUB,
1005 hdev->level - 1, 0, NULL, 0,
1006 USB_CTRL_SET_TIMEOUT);
1008 dev_err(hub->intfdev,
1009 "set hub depth failed\n");
1012 /* Speed up system boot by using a delayed_work for the
1013 * hub's initial power-up delays. This is pretty awkward
1014 * and the implementation looks like a home-brewed sort of
1015 * setjmp/longjmp, but it saves at least 100 ms for each
1016 * root hub (assuming usbcore is compiled into the kernel
1017 * rather than as a module). It adds up.
1019 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1020 * because for those activation types the ports have to be
1021 * operational when we return. In theory this could be done
1022 * for HUB_POST_RESET, but it's easier not to.
1024 if (type == HUB_INIT) {
1025 delay = hub_power_on_good_delay(hub);
1027 hub_power_on(hub, false);
1028 INIT_DELAYED_WORK(&hub->init_work, hub_init_func2);
1029 queue_delayed_work(system_power_efficient_wq,
1031 msecs_to_jiffies(delay));
1033 /* Suppress autosuspend until init is done */
1034 usb_autopm_get_interface_no_resume(
1035 to_usb_interface(hub->intfdev));
1036 return; /* Continues at init2: below */
1037 } else if (type == HUB_RESET_RESUME) {
1038 /* The internal host controller state for the hub device
1039 * may be gone after a host power loss on system resume.
1040 * Update the device's info so the HW knows it's a hub.
1042 hcd = bus_to_hcd(hdev->bus);
1043 if (hcd->driver->update_hub_device) {
1044 ret = hcd->driver->update_hub_device(hcd, hdev,
1045 &hub->tt, GFP_NOIO);
1047 dev_err(hub->intfdev, "Host not "
1048 "accepting hub info "
1050 dev_err(hub->intfdev, "LS/FS devices "
1051 "and hubs may not work "
1052 "under this hub\n.");
1055 hub_power_on(hub, true);
1057 hub_power_on(hub, true);
1063 * Check each port and set hub->change_bits to let hub_wq know
1064 * which ports need attention.
1066 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
1067 struct usb_port *port_dev = hub->ports[port1 - 1];
1068 struct usb_device *udev = port_dev->child;
1069 u16 portstatus, portchange;
1071 portstatus = portchange = 0;
1072 status = hub_port_status(hub, port1, &portstatus, &portchange);
1076 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1077 dev_dbg(&port_dev->dev, "status %04x change %04x\n",
1078 portstatus, portchange);
1081 * After anything other than HUB_RESUME (i.e., initialization
1082 * or any sort of reset), every port should be disabled.
1083 * Unconnected ports should likewise be disabled (paranoia),
1084 * and so should ports for which we have no usb_device.
1086 if ((portstatus & USB_PORT_STAT_ENABLE) && (
1087 type != HUB_RESUME ||
1088 !(portstatus & USB_PORT_STAT_CONNECTION) ||
1090 udev->state == USB_STATE_NOTATTACHED)) {
1092 * USB3 protocol ports will automatically transition
1093 * to Enabled state when detect an USB3.0 device attach.
1094 * Do not disable USB3 protocol ports, just pretend
1097 portstatus &= ~USB_PORT_STAT_ENABLE;
1098 if (!hub_is_superspeed(hdev))
1099 usb_clear_port_feature(hdev, port1,
1100 USB_PORT_FEAT_ENABLE);
1103 /* Clear status-change flags; we'll debounce later */
1104 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1105 need_debounce_delay = true;
1106 usb_clear_port_feature(hub->hdev, port1,
1107 USB_PORT_FEAT_C_CONNECTION);
1109 if (portchange & USB_PORT_STAT_C_ENABLE) {
1110 need_debounce_delay = true;
1111 usb_clear_port_feature(hub->hdev, port1,
1112 USB_PORT_FEAT_C_ENABLE);
1114 if (portchange & USB_PORT_STAT_C_RESET) {
1115 need_debounce_delay = true;
1116 usb_clear_port_feature(hub->hdev, port1,
1117 USB_PORT_FEAT_C_RESET);
1119 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
1120 hub_is_superspeed(hub->hdev)) {
1121 need_debounce_delay = true;
1122 usb_clear_port_feature(hub->hdev, port1,
1123 USB_PORT_FEAT_C_BH_PORT_RESET);
1125 /* We can forget about a "removed" device when there's a
1126 * physical disconnect or the connect status changes.
1128 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
1129 (portchange & USB_PORT_STAT_C_CONNECTION))
1130 clear_bit(port1, hub->removed_bits);
1132 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
1133 /* Tell hub_wq to disconnect the device or
1134 * check for a new connection
1136 if (udev || (portstatus & USB_PORT_STAT_CONNECTION) ||
1137 (portstatus & USB_PORT_STAT_OVERCURRENT))
1138 set_bit(port1, hub->change_bits);
1140 } else if (portstatus & USB_PORT_STAT_ENABLE) {
1141 bool port_resumed = (portstatus &
1142 USB_PORT_STAT_LINK_STATE) ==
1144 /* The power session apparently survived the resume.
1145 * If there was an overcurrent or suspend change
1146 * (i.e., remote wakeup request), have hub_wq
1147 * take care of it. Look at the port link state
1148 * for USB 3.0 hubs, since they don't have a suspend
1149 * change bit, and they don't set the port link change
1150 * bit on device-initiated resume.
1152 if (portchange || (hub_is_superspeed(hub->hdev) &&
1154 set_bit(port1, hub->change_bits);
1156 } else if (udev->persist_enabled) {
1158 udev->reset_resume = 1;
1160 /* Don't set the change_bits when the device
1163 if (test_bit(port1, hub->power_bits))
1164 set_bit(port1, hub->change_bits);
1167 /* The power session is gone; tell hub_wq */
1168 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1169 set_bit(port1, hub->change_bits);
1173 /* If no port-status-change flags were set, we don't need any
1174 * debouncing. If flags were set we can try to debounce the
1175 * ports all at once right now, instead of letting hub_wq do them
1176 * one at a time later on.
1178 * If any port-status changes do occur during this delay, hub_wq
1179 * will see them later and handle them normally.
1181 if (need_debounce_delay) {
1182 delay = HUB_DEBOUNCE_STABLE;
1184 /* Don't do a long sleep inside a workqueue routine */
1185 if (type == HUB_INIT2) {
1186 INIT_DELAYED_WORK(&hub->init_work, hub_init_func3);
1187 queue_delayed_work(system_power_efficient_wq,
1189 msecs_to_jiffies(delay));
1190 device_unlock(&hdev->dev);
1191 return; /* Continues at init3: below */
1199 status = usb_submit_urb(hub->urb, GFP_NOIO);
1201 dev_err(hub->intfdev, "activate --> %d\n", status);
1202 if (hub->has_indicators && blinkenlights)
1203 queue_delayed_work(system_power_efficient_wq,
1204 &hub->leds, LED_CYCLE_PERIOD);
1206 /* Scan all ports that need attention */
1209 if (type == HUB_INIT2 || type == HUB_INIT3) {
1210 /* Allow autosuspend if it was suppressed */
1212 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
1213 device_unlock(&hdev->dev);
1216 kref_put(&hub->kref, hub_release);
1219 /* Implement the continuations for the delays above */
1220 static void hub_init_func2(struct work_struct *ws)
1222 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1224 hub_activate(hub, HUB_INIT2);
1227 static void hub_init_func3(struct work_struct *ws)
1229 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1231 hub_activate(hub, HUB_INIT3);
1234 enum hub_quiescing_type {
1235 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
1238 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
1240 struct usb_device *hdev = hub->hdev;
1243 /* hub_wq and related activity won't re-trigger */
1246 if (type != HUB_SUSPEND) {
1247 /* Disconnect all the children */
1248 for (i = 0; i < hdev->maxchild; ++i) {
1249 if (hub->ports[i]->child)
1250 usb_disconnect(&hub->ports[i]->child);
1254 /* Stop hub_wq and related activity */
1255 usb_kill_urb(hub->urb);
1256 if (hub->has_indicators)
1257 cancel_delayed_work_sync(&hub->leds);
1259 flush_work(&hub->tt.clear_work);
1262 static void hub_pm_barrier_for_all_ports(struct usb_hub *hub)
1266 for (i = 0; i < hub->hdev->maxchild; ++i)
1267 pm_runtime_barrier(&hub->ports[i]->dev);
1270 /* caller has locked the hub device */
1271 static int hub_pre_reset(struct usb_interface *intf)
1273 struct usb_hub *hub = usb_get_intfdata(intf);
1275 hub_quiesce(hub, HUB_PRE_RESET);
1277 hub_pm_barrier_for_all_ports(hub);
1281 /* caller has locked the hub device */
1282 static int hub_post_reset(struct usb_interface *intf)
1284 struct usb_hub *hub = usb_get_intfdata(intf);
1287 hub_pm_barrier_for_all_ports(hub);
1288 hub_activate(hub, HUB_POST_RESET);
1292 static int hub_configure(struct usb_hub *hub,
1293 struct usb_endpoint_descriptor *endpoint)
1295 struct usb_hcd *hcd;
1296 struct usb_device *hdev = hub->hdev;
1297 struct device *hub_dev = hub->intfdev;
1298 u16 hubstatus, hubchange;
1299 u16 wHubCharacteristics;
1302 char *message = "out of memory";
1307 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
1313 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1318 mutex_init(&hub->status_mutex);
1320 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1321 if (!hub->descriptor) {
1326 /* Request the entire hub descriptor.
1327 * hub->descriptor can handle USB_MAXCHILDREN ports,
1328 * but a (non-SS) hub can/will return fewer bytes here.
1330 ret = get_hub_descriptor(hdev, hub->descriptor);
1332 message = "can't read hub descriptor";
1334 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
1335 message = "hub has too many ports!";
1338 } else if (hub->descriptor->bNbrPorts == 0) {
1339 message = "hub doesn't have any ports!";
1344 maxchild = hub->descriptor->bNbrPorts;
1345 dev_info(hub_dev, "%d port%s detected\n", maxchild,
1346 (maxchild == 1) ? "" : "s");
1348 hub->ports = kzalloc(maxchild * sizeof(struct usb_port *), GFP_KERNEL);
1354 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1355 if (hub_is_superspeed(hdev)) {
1363 /* FIXME for USB 3.0, skip for now */
1364 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1365 !(hub_is_superspeed(hdev))) {
1366 char portstr[USB_MAXCHILDREN + 1];
1368 for (i = 0; i < maxchild; i++)
1369 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1370 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1372 portstr[maxchild] = 0;
1373 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1375 dev_dbg(hub_dev, "standalone hub\n");
1377 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1378 case HUB_CHAR_COMMON_LPSM:
1379 dev_dbg(hub_dev, "ganged power switching\n");
1381 case HUB_CHAR_INDV_PORT_LPSM:
1382 dev_dbg(hub_dev, "individual port power switching\n");
1384 case HUB_CHAR_NO_LPSM:
1386 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1390 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1391 case HUB_CHAR_COMMON_OCPM:
1392 dev_dbg(hub_dev, "global over-current protection\n");
1394 case HUB_CHAR_INDV_PORT_OCPM:
1395 dev_dbg(hub_dev, "individual port over-current protection\n");
1397 case HUB_CHAR_NO_OCPM:
1399 dev_dbg(hub_dev, "no over-current protection\n");
1403 spin_lock_init(&hub->tt.lock);
1404 INIT_LIST_HEAD(&hub->tt.clear_list);
1405 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1406 switch (hdev->descriptor.bDeviceProtocol) {
1409 case USB_HUB_PR_HS_SINGLE_TT:
1410 dev_dbg(hub_dev, "Single TT\n");
1413 case USB_HUB_PR_HS_MULTI_TT:
1414 ret = usb_set_interface(hdev, 0, 1);
1416 dev_dbg(hub_dev, "TT per port\n");
1419 dev_err(hub_dev, "Using single TT (err %d)\n",
1424 /* USB 3.0 hubs don't have a TT */
1427 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1428 hdev->descriptor.bDeviceProtocol);
1432 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1433 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1434 case HUB_TTTT_8_BITS:
1435 if (hdev->descriptor.bDeviceProtocol != 0) {
1436 hub->tt.think_time = 666;
1437 dev_dbg(hub_dev, "TT requires at most %d "
1438 "FS bit times (%d ns)\n",
1439 8, hub->tt.think_time);
1442 case HUB_TTTT_16_BITS:
1443 hub->tt.think_time = 666 * 2;
1444 dev_dbg(hub_dev, "TT requires at most %d "
1445 "FS bit times (%d ns)\n",
1446 16, hub->tt.think_time);
1448 case HUB_TTTT_24_BITS:
1449 hub->tt.think_time = 666 * 3;
1450 dev_dbg(hub_dev, "TT requires at most %d "
1451 "FS bit times (%d ns)\n",
1452 24, hub->tt.think_time);
1454 case HUB_TTTT_32_BITS:
1455 hub->tt.think_time = 666 * 4;
1456 dev_dbg(hub_dev, "TT requires at most %d "
1457 "FS bit times (%d ns)\n",
1458 32, hub->tt.think_time);
1462 /* probe() zeroes hub->indicator[] */
1463 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1464 hub->has_indicators = 1;
1465 dev_dbg(hub_dev, "Port indicators are supported\n");
1468 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1469 hub->descriptor->bPwrOn2PwrGood * 2);
1471 /* power budgeting mostly matters with bus-powered hubs,
1472 * and battery-powered root hubs (may provide just 8 mA).
1474 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1476 message = "can't get hub status";
1479 hcd = bus_to_hcd(hdev->bus);
1480 if (hdev == hdev->bus->root_hub) {
1481 if (hcd->power_budget > 0)
1482 hdev->bus_mA = hcd->power_budget;
1484 hdev->bus_mA = full_load * maxchild;
1485 if (hdev->bus_mA >= full_load)
1486 hub->mA_per_port = full_load;
1488 hub->mA_per_port = hdev->bus_mA;
1489 hub->limited_power = 1;
1491 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1492 int remaining = hdev->bus_mA -
1493 hub->descriptor->bHubContrCurrent;
1495 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1496 hub->descriptor->bHubContrCurrent);
1497 hub->limited_power = 1;
1499 if (remaining < maxchild * unit_load)
1501 "insufficient power available "
1502 "to use all downstream ports\n");
1503 hub->mA_per_port = unit_load; /* 7.2.1 */
1505 } else { /* Self-powered external hub */
1506 /* FIXME: What about battery-powered external hubs that
1507 * provide less current per port? */
1508 hub->mA_per_port = full_load;
1510 if (hub->mA_per_port < full_load)
1511 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1514 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1516 message = "can't get hub status";
1520 /* local power status reports aren't always correct */
1521 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1522 dev_dbg(hub_dev, "local power source is %s\n",
1523 (hubstatus & HUB_STATUS_LOCAL_POWER)
1524 ? "lost (inactive)" : "good");
1526 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1527 dev_dbg(hub_dev, "%sover-current condition exists\n",
1528 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1530 /* set up the interrupt endpoint
1531 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1532 * bytes as USB2.0[11.12.3] says because some hubs are known
1533 * to send more data (and thus cause overflow). For root hubs,
1534 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1535 * to be big enough for at least USB_MAXCHILDREN ports. */
1536 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1537 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1539 if (maxp > sizeof(*hub->buffer))
1540 maxp = sizeof(*hub->buffer);
1542 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1548 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1549 hub, endpoint->bInterval);
1551 /* maybe cycle the hub leds */
1552 if (hub->has_indicators && blinkenlights)
1553 hub->indicator[0] = INDICATOR_CYCLE;
1555 mutex_lock(&usb_port_peer_mutex);
1556 for (i = 0; i < maxchild; i++) {
1557 ret = usb_hub_create_port_device(hub, i + 1);
1559 dev_err(hub->intfdev,
1560 "couldn't create port%d device.\n", i + 1);
1565 for (i = 0; i < hdev->maxchild; i++) {
1566 struct usb_port *port_dev = hub->ports[i];
1568 pm_runtime_put(&port_dev->dev);
1571 mutex_unlock(&usb_port_peer_mutex);
1575 /* Update the HCD's internal representation of this hub before hub_wq
1576 * starts getting port status changes for devices under the hub.
1578 if (hcd->driver->update_hub_device) {
1579 ret = hcd->driver->update_hub_device(hcd, hdev,
1580 &hub->tt, GFP_KERNEL);
1582 message = "can't update HCD hub info";
1587 usb_hub_adjust_deviceremovable(hdev, hub->descriptor);
1589 hub_activate(hub, HUB_INIT);
1593 dev_err(hub_dev, "config failed, %s (err %d)\n",
1595 /* hub_disconnect() frees urb and descriptor */
1599 static void hub_release(struct kref *kref)
1601 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1603 usb_put_dev(hub->hdev);
1604 usb_put_intf(to_usb_interface(hub->intfdev));
1608 static unsigned highspeed_hubs;
1610 static void hub_disconnect(struct usb_interface *intf)
1612 struct usb_hub *hub = usb_get_intfdata(intf);
1613 struct usb_device *hdev = interface_to_usbdev(intf);
1617 * Stop adding new hub events. We do not want to block here and thus
1618 * will not try to remove any pending work item.
1620 hub->disconnected = 1;
1622 /* Disconnect all children and quiesce the hub */
1624 hub_quiesce(hub, HUB_DISCONNECT);
1626 mutex_lock(&usb_port_peer_mutex);
1628 /* Avoid races with recursively_mark_NOTATTACHED() */
1629 spin_lock_irq(&device_state_lock);
1630 port1 = hdev->maxchild;
1632 usb_set_intfdata(intf, NULL);
1633 spin_unlock_irq(&device_state_lock);
1635 for (; port1 > 0; --port1)
1636 usb_hub_remove_port_device(hub, port1);
1638 mutex_unlock(&usb_port_peer_mutex);
1640 if (hub->hdev->speed == USB_SPEED_HIGH)
1643 usb_free_urb(hub->urb);
1645 kfree(hub->descriptor);
1649 pm_suspend_ignore_children(&intf->dev, false);
1650 kref_put(&hub->kref, hub_release);
1653 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1655 struct usb_host_interface *desc;
1656 struct usb_endpoint_descriptor *endpoint;
1657 struct usb_device *hdev;
1658 struct usb_hub *hub;
1660 desc = intf->cur_altsetting;
1661 hdev = interface_to_usbdev(intf);
1664 * Set default autosuspend delay as 0 to speedup bus suspend,
1665 * based on the below considerations:
1667 * - Unlike other drivers, the hub driver does not rely on the
1668 * autosuspend delay to provide enough time to handle a wakeup
1669 * event, and the submitted status URB is just to check future
1670 * change on hub downstream ports, so it is safe to do it.
1672 * - The patch might cause one or more auto supend/resume for
1673 * below very rare devices when they are plugged into hub
1676 * devices having trouble initializing, and disconnect
1677 * themselves from the bus and then reconnect a second
1680 * devices just for downloading firmware, and disconnects
1681 * themselves after completing it
1683 * For these quite rare devices, their drivers may change the
1684 * autosuspend delay of their parent hub in the probe() to one
1685 * appropriate value to avoid the subtle problem if someone
1688 * - The patch may cause one or more auto suspend/resume on
1689 * hub during running 'lsusb', but it is probably too
1690 * infrequent to worry about.
1692 * - Change autosuspend delay of hub can avoid unnecessary auto
1693 * suspend timer for hub, also may decrease power consumption
1696 * - If user has indicated to prevent autosuspend by passing
1697 * usbcore.autosuspend = -1 then keep autosuspend disabled.
1700 if (hdev->dev.power.autosuspend_delay >= 0)
1701 pm_runtime_set_autosuspend_delay(&hdev->dev, 0);
1705 * Hubs have proper suspend/resume support, except for root hubs
1706 * where the controller driver doesn't have bus_suspend and
1707 * bus_resume methods.
1709 if (hdev->parent) { /* normal device */
1710 usb_enable_autosuspend(hdev);
1711 } else { /* root hub */
1712 const struct hc_driver *drv = bus_to_hcd(hdev->bus)->driver;
1714 if (drv->bus_suspend && drv->bus_resume)
1715 usb_enable_autosuspend(hdev);
1718 if (hdev->level == MAX_TOPO_LEVEL) {
1720 "Unsupported bus topology: hub nested too deep\n");
1724 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1726 dev_warn(&intf->dev, "ignoring external hub\n");
1731 /* Some hubs have a subclass of 1, which AFAICT according to the */
1732 /* specs is not defined, but it works */
1733 if ((desc->desc.bInterfaceSubClass != 0) &&
1734 (desc->desc.bInterfaceSubClass != 1)) {
1736 dev_err(&intf->dev, "bad descriptor, ignoring hub\n");
1740 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1741 if (desc->desc.bNumEndpoints != 1)
1742 goto descriptor_error;
1744 endpoint = &desc->endpoint[0].desc;
1746 /* If it's not an interrupt in endpoint, we'd better punt! */
1747 if (!usb_endpoint_is_int_in(endpoint))
1748 goto descriptor_error;
1750 /* We found a hub */
1751 dev_info(&intf->dev, "USB hub found\n");
1753 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1757 kref_init(&hub->kref);
1758 hub->intfdev = &intf->dev;
1760 INIT_DELAYED_WORK(&hub->leds, led_work);
1761 INIT_DELAYED_WORK(&hub->init_work, NULL);
1762 INIT_WORK(&hub->events, hub_event);
1766 usb_set_intfdata(intf, hub);
1767 intf->needs_remote_wakeup = 1;
1768 pm_suspend_ignore_children(&intf->dev, true);
1770 if (hdev->speed == USB_SPEED_HIGH)
1773 if (id->driver_info & HUB_QUIRK_CHECK_PORT_AUTOSUSPEND)
1774 hub->quirk_check_port_auto_suspend = 1;
1776 if (hub_configure(hub, endpoint) >= 0)
1779 hub_disconnect(intf);
1784 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1786 struct usb_device *hdev = interface_to_usbdev(intf);
1787 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1789 /* assert ifno == 0 (part of hub spec) */
1791 case USBDEVFS_HUB_PORTINFO: {
1792 struct usbdevfs_hub_portinfo *info = user_data;
1795 spin_lock_irq(&device_state_lock);
1796 if (hdev->devnum <= 0)
1799 info->nports = hdev->maxchild;
1800 for (i = 0; i < info->nports; i++) {
1801 if (hub->ports[i]->child == NULL)
1805 hub->ports[i]->child->devnum;
1808 spin_unlock_irq(&device_state_lock);
1810 return info->nports + 1;
1819 * Allow user programs to claim ports on a hub. When a device is attached
1820 * to one of these "claimed" ports, the program will "own" the device.
1822 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1823 struct usb_dev_state ***ppowner)
1825 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1827 if (hdev->state == USB_STATE_NOTATTACHED)
1829 if (port1 == 0 || port1 > hdev->maxchild)
1832 /* Devices not managed by the hub driver
1833 * will always have maxchild equal to 0.
1835 *ppowner = &(hub->ports[port1 - 1]->port_owner);
1839 /* In the following three functions, the caller must hold hdev's lock */
1840 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
1841 struct usb_dev_state *owner)
1844 struct usb_dev_state **powner;
1846 rc = find_port_owner(hdev, port1, &powner);
1854 EXPORT_SYMBOL_GPL(usb_hub_claim_port);
1856 int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
1857 struct usb_dev_state *owner)
1860 struct usb_dev_state **powner;
1862 rc = find_port_owner(hdev, port1, &powner);
1865 if (*powner != owner)
1870 EXPORT_SYMBOL_GPL(usb_hub_release_port);
1872 void usb_hub_release_all_ports(struct usb_device *hdev, struct usb_dev_state *owner)
1874 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1877 for (n = 0; n < hdev->maxchild; n++) {
1878 if (hub->ports[n]->port_owner == owner)
1879 hub->ports[n]->port_owner = NULL;
1884 /* The caller must hold udev's lock */
1885 bool usb_device_is_owned(struct usb_device *udev)
1887 struct usb_hub *hub;
1889 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1891 hub = usb_hub_to_struct_hub(udev->parent);
1892 return !!hub->ports[udev->portnum - 1]->port_owner;
1895 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1897 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
1900 for (i = 0; i < udev->maxchild; ++i) {
1901 if (hub->ports[i]->child)
1902 recursively_mark_NOTATTACHED(hub->ports[i]->child);
1904 if (udev->state == USB_STATE_SUSPENDED)
1905 udev->active_duration -= jiffies;
1906 udev->state = USB_STATE_NOTATTACHED;
1910 * usb_set_device_state - change a device's current state (usbcore, hcds)
1911 * @udev: pointer to device whose state should be changed
1912 * @new_state: new state value to be stored
1914 * udev->state is _not_ fully protected by the device lock. Although
1915 * most transitions are made only while holding the lock, the state can
1916 * can change to USB_STATE_NOTATTACHED at almost any time. This
1917 * is so that devices can be marked as disconnected as soon as possible,
1918 * without having to wait for any semaphores to be released. As a result,
1919 * all changes to any device's state must be protected by the
1920 * device_state_lock spinlock.
1922 * Once a device has been added to the device tree, all changes to its state
1923 * should be made using this routine. The state should _not_ be set directly.
1925 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1926 * Otherwise udev->state is set to new_state, and if new_state is
1927 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1928 * to USB_STATE_NOTATTACHED.
1930 void usb_set_device_state(struct usb_device *udev,
1931 enum usb_device_state new_state)
1933 unsigned long flags;
1936 spin_lock_irqsave(&device_state_lock, flags);
1937 if (udev->state == USB_STATE_NOTATTACHED)
1939 else if (new_state != USB_STATE_NOTATTACHED) {
1941 /* root hub wakeup capabilities are managed out-of-band
1942 * and may involve silicon errata ... ignore them here.
1945 if (udev->state == USB_STATE_SUSPENDED
1946 || new_state == USB_STATE_SUSPENDED)
1947 ; /* No change to wakeup settings */
1948 else if (new_state == USB_STATE_CONFIGURED)
1949 wakeup = (udev->quirks &
1950 USB_QUIRK_IGNORE_REMOTE_WAKEUP) ? 0 :
1951 udev->actconfig->desc.bmAttributes &
1952 USB_CONFIG_ATT_WAKEUP;
1956 if (udev->state == USB_STATE_SUSPENDED &&
1957 new_state != USB_STATE_SUSPENDED)
1958 udev->active_duration -= jiffies;
1959 else if (new_state == USB_STATE_SUSPENDED &&
1960 udev->state != USB_STATE_SUSPENDED)
1961 udev->active_duration += jiffies;
1962 udev->state = new_state;
1964 recursively_mark_NOTATTACHED(udev);
1965 spin_unlock_irqrestore(&device_state_lock, flags);
1967 device_set_wakeup_capable(&udev->dev, wakeup);
1969 EXPORT_SYMBOL_GPL(usb_set_device_state);
1972 * Choose a device number.
1974 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1975 * USB-2.0 buses they are also used as device addresses, however on
1976 * USB-3.0 buses the address is assigned by the controller hardware
1977 * and it usually is not the same as the device number.
1979 * WUSB devices are simple: they have no hubs behind, so the mapping
1980 * device <-> virtual port number becomes 1:1. Why? to simplify the
1981 * life of the device connection logic in
1982 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1983 * handshake we need to assign a temporary address in the unauthorized
1984 * space. For simplicity we use the first virtual port number found to
1985 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1986 * and that becomes it's address [X < 128] or its unauthorized address
1989 * We add 1 as an offset to the one-based USB-stack port number
1990 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1991 * 0 is reserved by USB for default address; (b) Linux's USB stack
1992 * uses always #1 for the root hub of the controller. So USB stack's
1993 * port #1, which is wusb virtual-port #0 has address #2.
1995 * Devices connected under xHCI are not as simple. The host controller
1996 * supports virtualization, so the hardware assigns device addresses and
1997 * the HCD must setup data structures before issuing a set address
1998 * command to the hardware.
2000 static void choose_devnum(struct usb_device *udev)
2003 struct usb_bus *bus = udev->bus;
2005 /* be safe when more hub events are proceed in parallel */
2006 mutex_lock(&bus->devnum_next_mutex);
2008 devnum = udev->portnum + 1;
2009 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
2011 /* Try to allocate the next devnum beginning at
2012 * bus->devnum_next. */
2013 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
2016 devnum = find_next_zero_bit(bus->devmap.devicemap,
2018 bus->devnum_next = (devnum >= 127 ? 1 : devnum + 1);
2021 set_bit(devnum, bus->devmap.devicemap);
2022 udev->devnum = devnum;
2024 mutex_unlock(&bus->devnum_next_mutex);
2027 static void release_devnum(struct usb_device *udev)
2029 if (udev->devnum > 0) {
2030 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
2035 static void update_devnum(struct usb_device *udev, int devnum)
2037 /* The address for a WUSB device is managed by wusbcore. */
2039 udev->devnum = devnum;
2042 static void hub_free_dev(struct usb_device *udev)
2044 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2046 /* Root hubs aren't real devices, so don't free HCD resources */
2047 if (hcd->driver->free_dev && udev->parent)
2048 hcd->driver->free_dev(hcd, udev);
2051 static void hub_disconnect_children(struct usb_device *udev)
2053 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2056 /* Free up all the children before we remove this device */
2057 for (i = 0; i < udev->maxchild; i++) {
2058 if (hub->ports[i]->child)
2059 usb_disconnect(&hub->ports[i]->child);
2064 * usb_disconnect - disconnect a device (usbcore-internal)
2065 * @pdev: pointer to device being disconnected
2066 * Context: !in_interrupt ()
2068 * Something got disconnected. Get rid of it and all of its children.
2070 * If *pdev is a normal device then the parent hub must already be locked.
2071 * If *pdev is a root hub then the caller must hold the usb_bus_idr_lock,
2072 * which protects the set of root hubs as well as the list of buses.
2074 * Only hub drivers (including virtual root hub drivers for host
2075 * controllers) should ever call this.
2077 * This call is synchronous, and may not be used in an interrupt context.
2079 void usb_disconnect(struct usb_device **pdev)
2081 struct usb_port *port_dev = NULL;
2082 struct usb_device *udev = *pdev;
2083 struct usb_hub *hub = NULL;
2086 /* mark the device as inactive, so any further urb submissions for
2087 * this device (and any of its children) will fail immediately.
2088 * this quiesces everything except pending urbs.
2090 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2091 dev_info(&udev->dev, "USB disconnect, device number %d\n",
2095 * Ensure that the pm runtime code knows that the USB device
2096 * is in the process of being disconnected.
2098 pm_runtime_barrier(&udev->dev);
2100 usb_lock_device(udev);
2102 hub_disconnect_children(udev);
2104 /* deallocate hcd/hardware state ... nuking all pending urbs and
2105 * cleaning up all state associated with the current configuration
2106 * so that the hardware is now fully quiesced.
2108 dev_dbg(&udev->dev, "unregistering device\n");
2109 usb_disable_device(udev, 0);
2110 usb_hcd_synchronize_unlinks(udev);
2113 port1 = udev->portnum;
2114 hub = usb_hub_to_struct_hub(udev->parent);
2115 port_dev = hub->ports[port1 - 1];
2117 sysfs_remove_link(&udev->dev.kobj, "port");
2118 sysfs_remove_link(&port_dev->dev.kobj, "device");
2121 * As usb_port_runtime_resume() de-references udev, make
2122 * sure no resumes occur during removal
2124 if (!test_and_set_bit(port1, hub->child_usage_bits))
2125 pm_runtime_get_sync(&port_dev->dev);
2128 usb_remove_ep_devs(&udev->ep0);
2129 usb_unlock_device(udev);
2131 /* Unregister the device. The device driver is responsible
2132 * for de-configuring the device and invoking the remove-device
2133 * notifier chain (used by usbfs and possibly others).
2135 device_del(&udev->dev);
2137 /* Free the device number and delete the parent's children[]
2138 * (or root_hub) pointer.
2140 release_devnum(udev);
2142 /* Avoid races with recursively_mark_NOTATTACHED() */
2143 spin_lock_irq(&device_state_lock);
2145 spin_unlock_irq(&device_state_lock);
2147 if (port_dev && test_and_clear_bit(port1, hub->child_usage_bits))
2148 pm_runtime_put(&port_dev->dev);
2152 put_device(&udev->dev);
2155 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2156 static void show_string(struct usb_device *udev, char *id, char *string)
2160 dev_info(&udev->dev, "%s: %s\n", id, string);
2163 static void announce_device(struct usb_device *udev)
2165 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2166 le16_to_cpu(udev->descriptor.idVendor),
2167 le16_to_cpu(udev->descriptor.idProduct));
2168 dev_info(&udev->dev,
2169 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2170 udev->descriptor.iManufacturer,
2171 udev->descriptor.iProduct,
2172 udev->descriptor.iSerialNumber);
2173 show_string(udev, "Product", udev->product);
2174 show_string(udev, "Manufacturer", udev->manufacturer);
2175 show_string(udev, "SerialNumber", udev->serial);
2178 static inline void announce_device(struct usb_device *udev) { }
2183 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2184 * @udev: newly addressed device (in ADDRESS state)
2186 * Finish enumeration for On-The-Go devices
2188 * Return: 0 if successful. A negative error code otherwise.
2190 static int usb_enumerate_device_otg(struct usb_device *udev)
2194 #ifdef CONFIG_USB_OTG
2196 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2197 * to wake us after we've powered off VBUS; and HNP, switching roles
2198 * "host" to "peripheral". The OTG descriptor helps figure this out.
2200 if (!udev->bus->is_b_host
2202 && udev->parent == udev->bus->root_hub) {
2203 struct usb_otg_descriptor *desc = NULL;
2204 struct usb_bus *bus = udev->bus;
2205 unsigned port1 = udev->portnum;
2207 /* descriptor may appear anywhere in config */
2208 err = __usb_get_extra_descriptor(udev->rawdescriptors[0],
2209 le16_to_cpu(udev->config[0].desc.wTotalLength),
2210 USB_DT_OTG, (void **) &desc);
2211 if (err || !(desc->bmAttributes & USB_OTG_HNP))
2214 dev_info(&udev->dev, "Dual-Role OTG device on %sHNP port\n",
2215 (port1 == bus->otg_port) ? "" : "non-");
2217 /* enable HNP before suspend, it's simpler */
2218 if (port1 == bus->otg_port) {
2219 bus->b_hnp_enable = 1;
2220 err = usb_control_msg(udev,
2221 usb_sndctrlpipe(udev, 0),
2222 USB_REQ_SET_FEATURE, 0,
2223 USB_DEVICE_B_HNP_ENABLE,
2225 USB_CTRL_SET_TIMEOUT);
2228 * OTG MESSAGE: report errors here,
2229 * customize to match your product.
2231 dev_err(&udev->dev, "can't set HNP mode: %d\n",
2233 bus->b_hnp_enable = 0;
2235 } else if (desc->bLength == sizeof
2236 (struct usb_otg_descriptor)) {
2237 /* Set a_alt_hnp_support for legacy otg device */
2238 err = usb_control_msg(udev,
2239 usb_sndctrlpipe(udev, 0),
2240 USB_REQ_SET_FEATURE, 0,
2241 USB_DEVICE_A_ALT_HNP_SUPPORT,
2243 USB_CTRL_SET_TIMEOUT);
2246 "set a_alt_hnp_support failed: %d\n",
2256 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2257 * @udev: newly addressed device (in ADDRESS state)
2259 * This is only called by usb_new_device() and usb_authorize_device()
2260 * and FIXME -- all comments that apply to them apply here wrt to
2263 * If the device is WUSB and not authorized, we don't attempt to read
2264 * the string descriptors, as they will be errored out by the device
2265 * until it has been authorized.
2267 * Return: 0 if successful. A negative error code otherwise.
2269 static int usb_enumerate_device(struct usb_device *udev)
2272 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2274 if (udev->config == NULL) {
2275 err = usb_get_configuration(udev);
2278 dev_err(&udev->dev, "can't read configurations, error %d\n",
2284 /* read the standard strings and cache them if present */
2285 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
2286 udev->manufacturer = usb_cache_string(udev,
2287 udev->descriptor.iManufacturer);
2288 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
2290 err = usb_enumerate_device_otg(udev);
2294 if (IS_ENABLED(CONFIG_USB_OTG_WHITELIST) && hcd->tpl_support &&
2295 !is_targeted(udev)) {
2296 /* Maybe it can talk to us, though we can't talk to it.
2297 * (Includes HNP test device.)
2299 if (IS_ENABLED(CONFIG_USB_OTG) && (udev->bus->b_hnp_enable
2300 || udev->bus->is_b_host)) {
2301 err = usb_port_suspend(udev, PMSG_AUTO_SUSPEND);
2303 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
2308 usb_detect_interface_quirks(udev);
2313 static void set_usb_port_removable(struct usb_device *udev)
2315 struct usb_device *hdev = udev->parent;
2316 struct usb_hub *hub;
2317 u8 port = udev->portnum;
2318 u16 wHubCharacteristics;
2319 bool removable = true;
2324 hub = usb_hub_to_struct_hub(udev->parent);
2327 * If the platform firmware has provided information about a port,
2328 * use that to determine whether it's removable.
2330 switch (hub->ports[udev->portnum - 1]->connect_type) {
2331 case USB_PORT_CONNECT_TYPE_HOT_PLUG:
2332 udev->removable = USB_DEVICE_REMOVABLE;
2334 case USB_PORT_CONNECT_TYPE_HARD_WIRED:
2335 case USB_PORT_NOT_USED:
2336 udev->removable = USB_DEVICE_FIXED;
2343 * Otherwise, check whether the hub knows whether a port is removable
2346 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2348 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
2351 if (hub_is_superspeed(hdev)) {
2352 if (le16_to_cpu(hub->descriptor->u.ss.DeviceRemovable)
2356 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
2361 udev->removable = USB_DEVICE_REMOVABLE;
2363 udev->removable = USB_DEVICE_FIXED;
2368 * usb_new_device - perform initial device setup (usbcore-internal)
2369 * @udev: newly addressed device (in ADDRESS state)
2371 * This is called with devices which have been detected but not fully
2372 * enumerated. The device descriptor is available, but not descriptors
2373 * for any device configuration. The caller must have locked either
2374 * the parent hub (if udev is a normal device) or else the
2375 * usb_bus_idr_lock (if udev is a root hub). The parent's pointer to
2376 * udev has already been installed, but udev is not yet visible through
2377 * sysfs or other filesystem code.
2379 * This call is synchronous, and may not be used in an interrupt context.
2381 * Only the hub driver or root-hub registrar should ever call this.
2383 * Return: Whether the device is configured properly or not. Zero if the
2384 * interface was registered with the driver core; else a negative errno
2388 int usb_new_device(struct usb_device *udev)
2393 /* Initialize non-root-hub device wakeup to disabled;
2394 * device (un)configuration controls wakeup capable
2395 * sysfs power/wakeup controls wakeup enabled/disabled
2397 device_init_wakeup(&udev->dev, 0);
2400 /* Tell the runtime-PM framework the device is active */
2401 pm_runtime_set_active(&udev->dev);
2402 pm_runtime_get_noresume(&udev->dev);
2403 pm_runtime_use_autosuspend(&udev->dev);
2404 pm_runtime_enable(&udev->dev);
2406 /* By default, forbid autosuspend for all devices. It will be
2407 * allowed for hubs during binding.
2409 usb_disable_autosuspend(udev);
2411 err = usb_enumerate_device(udev); /* Read descriptors */
2414 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
2415 udev->devnum, udev->bus->busnum,
2416 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2417 /* export the usbdev device-node for libusb */
2418 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
2419 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2421 /* Tell the world! */
2422 announce_device(udev);
2425 add_device_randomness(udev->serial, strlen(udev->serial));
2427 add_device_randomness(udev->product, strlen(udev->product));
2428 if (udev->manufacturer)
2429 add_device_randomness(udev->manufacturer,
2430 strlen(udev->manufacturer));
2432 device_enable_async_suspend(&udev->dev);
2434 /* check whether the hub or firmware marks this port as non-removable */
2436 set_usb_port_removable(udev);
2438 /* Register the device. The device driver is responsible
2439 * for configuring the device and invoking the add-device
2440 * notifier chain (used by usbfs and possibly others).
2442 err = device_add(&udev->dev);
2444 dev_err(&udev->dev, "can't device_add, error %d\n", err);
2448 /* Create link files between child device and usb port device. */
2450 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2451 int port1 = udev->portnum;
2452 struct usb_port *port_dev = hub->ports[port1 - 1];
2454 err = sysfs_create_link(&udev->dev.kobj,
2455 &port_dev->dev.kobj, "port");
2459 err = sysfs_create_link(&port_dev->dev.kobj,
2460 &udev->dev.kobj, "device");
2462 sysfs_remove_link(&udev->dev.kobj, "port");
2466 if (!test_and_set_bit(port1, hub->child_usage_bits))
2467 pm_runtime_get_sync(&port_dev->dev);
2470 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
2471 usb_mark_last_busy(udev);
2472 pm_runtime_put_sync_autosuspend(&udev->dev);
2476 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2477 pm_runtime_disable(&udev->dev);
2478 pm_runtime_set_suspended(&udev->dev);
2484 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2485 * @usb_dev: USB device
2487 * Move the USB device to a very basic state where interfaces are disabled
2488 * and the device is in fact unconfigured and unusable.
2490 * We share a lock (that we have) with device_del(), so we need to
2495 int usb_deauthorize_device(struct usb_device *usb_dev)
2497 usb_lock_device(usb_dev);
2498 if (usb_dev->authorized == 0)
2499 goto out_unauthorized;
2501 usb_dev->authorized = 0;
2502 usb_set_configuration(usb_dev, -1);
2505 usb_unlock_device(usb_dev);
2510 int usb_authorize_device(struct usb_device *usb_dev)
2514 usb_lock_device(usb_dev);
2515 if (usb_dev->authorized == 1)
2516 goto out_authorized;
2518 result = usb_autoresume_device(usb_dev);
2520 dev_err(&usb_dev->dev,
2521 "can't autoresume for authorization: %d\n", result);
2522 goto error_autoresume;
2525 if (usb_dev->wusb) {
2526 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2528 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2529 "authorization: %d\n", result);
2530 goto error_device_descriptor;
2534 usb_dev->authorized = 1;
2535 /* Choose and set the configuration. This registers the interfaces
2536 * with the driver core and lets interface drivers bind to them.
2538 c = usb_choose_configuration(usb_dev);
2540 result = usb_set_configuration(usb_dev, c);
2542 dev_err(&usb_dev->dev,
2543 "can't set config #%d, error %d\n", c, result);
2544 /* This need not be fatal. The user can try to
2545 * set other configurations. */
2548 dev_info(&usb_dev->dev, "authorized to connect\n");
2550 error_device_descriptor:
2551 usb_autosuspend_device(usb_dev);
2554 usb_unlock_device(usb_dev); /* complements locktree */
2559 * Return 1 if port speed is SuperSpeedPlus, 0 otherwise
2560 * check it from the link protocol field of the current speed ID attribute.
2561 * current speed ID is got from ext port status request. Sublink speed attribute
2562 * table is returned with the hub BOS SSP device capability descriptor
2564 static int port_speed_is_ssp(struct usb_device *hdev, int speed_id)
2569 struct usb_ssp_cap_descriptor *ssp_cap = hdev->bos->ssp_cap;
2574 ssa_count = le32_to_cpu(ssp_cap->bmAttributes) &
2575 USB_SSP_SUBLINK_SPEED_ATTRIBS;
2577 for (i = 0; i <= ssa_count; i++) {
2578 ss_attr = le32_to_cpu(ssp_cap->bmSublinkSpeedAttr[i]);
2579 if (speed_id == (ss_attr & USB_SSP_SUBLINK_SPEED_SSID))
2580 return !!(ss_attr & USB_SSP_SUBLINK_SPEED_LP);
2585 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2586 static unsigned hub_is_wusb(struct usb_hub *hub)
2588 struct usb_hcd *hcd;
2589 if (hub->hdev->parent != NULL) /* not a root hub? */
2591 hcd = bus_to_hcd(hub->hdev->bus);
2592 return hcd->wireless;
2596 #define PORT_RESET_TRIES 5
2597 #define SET_ADDRESS_TRIES 2
2598 #define GET_DESCRIPTOR_TRIES 2
2599 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2600 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2602 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2603 #define HUB_SHORT_RESET_TIME 10
2604 #define HUB_BH_RESET_TIME 50
2605 #define HUB_LONG_RESET_TIME 200
2606 #define HUB_RESET_TIMEOUT 800
2609 * "New scheme" enumeration causes an extra state transition to be
2610 * exposed to an xhci host and causes USB3 devices to receive control
2611 * commands in the default state. This has been seen to cause
2612 * enumeration failures, so disable this enumeration scheme for USB3
2615 static bool use_new_scheme(struct usb_device *udev, int retry)
2617 if (udev->speed >= USB_SPEED_SUPER)
2620 return USE_NEW_SCHEME(retry);
2623 /* Is a USB 3.0 port in the Inactive or Compliance Mode state?
2624 * Port worm reset is required to recover
2626 static bool hub_port_warm_reset_required(struct usb_hub *hub, int port1,
2631 if (!hub_is_superspeed(hub->hdev))
2634 if (test_bit(port1, hub->warm_reset_bits))
2637 link_state = portstatus & USB_PORT_STAT_LINK_STATE;
2638 return link_state == USB_SS_PORT_LS_SS_INACTIVE
2639 || link_state == USB_SS_PORT_LS_COMP_MOD;
2642 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2643 struct usb_device *udev, unsigned int delay, bool warm)
2645 int delay_time, ret;
2648 u32 ext_portstatus = 0;
2650 for (delay_time = 0;
2651 delay_time < HUB_RESET_TIMEOUT;
2652 delay_time += delay) {
2653 /* wait to give the device a chance to reset */
2656 /* read and decode port status */
2657 if (hub_is_superspeedplus(hub->hdev))
2658 ret = hub_ext_port_status(hub, port1,
2659 HUB_EXT_PORT_STATUS,
2660 &portstatus, &portchange,
2663 ret = hub_port_status(hub, port1, &portstatus,
2669 * The port state is unknown until the reset completes.
2671 * On top of that, some chips may require additional time
2672 * to re-establish a connection after the reset is complete,
2673 * so also wait for the connection to be re-established.
2675 if (!(portstatus & USB_PORT_STAT_RESET) &&
2676 (portstatus & USB_PORT_STAT_CONNECTION))
2679 /* switch to the long delay after two short delay failures */
2680 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2681 delay = HUB_LONG_RESET_TIME;
2683 dev_dbg(&hub->ports[port1 - 1]->dev,
2684 "not %sreset yet, waiting %dms\n",
2685 warm ? "warm " : "", delay);
2688 if ((portstatus & USB_PORT_STAT_RESET))
2691 if (hub_port_warm_reset_required(hub, port1, portstatus))
2694 /* Device went away? */
2695 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2698 /* bomb out completely if the connection bounced. A USB 3.0
2699 * connection may bounce if multiple warm resets were issued,
2700 * but the device may have successfully re-connected. Ignore it.
2702 if (!hub_is_superspeed(hub->hdev) &&
2703 (portchange & USB_PORT_STAT_C_CONNECTION))
2706 if (!(portstatus & USB_PORT_STAT_ENABLE))
2712 if (hub_is_wusb(hub))
2713 udev->speed = USB_SPEED_WIRELESS;
2714 else if (hub_is_superspeedplus(hub->hdev) &&
2715 port_speed_is_ssp(hub->hdev, ext_portstatus &
2716 USB_EXT_PORT_STAT_RX_SPEED_ID))
2717 udev->speed = USB_SPEED_SUPER_PLUS;
2718 else if (hub_is_superspeed(hub->hdev))
2719 udev->speed = USB_SPEED_SUPER;
2720 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2721 udev->speed = USB_SPEED_HIGH;
2722 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2723 udev->speed = USB_SPEED_LOW;
2725 udev->speed = USB_SPEED_FULL;
2729 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2730 static int hub_port_reset(struct usb_hub *hub, int port1,
2731 struct usb_device *udev, unsigned int delay, bool warm)
2734 u16 portchange, portstatus;
2735 struct usb_port *port_dev = hub->ports[port1 - 1];
2737 if (!hub_is_superspeed(hub->hdev)) {
2739 dev_err(hub->intfdev, "only USB3 hub support "
2743 /* Block EHCI CF initialization during the port reset.
2744 * Some companion controllers don't like it when they mix.
2746 down_read(&ehci_cf_port_reset_rwsem);
2749 * If the caller hasn't explicitly requested a warm reset,
2750 * double check and see if one is needed.
2752 if (hub_port_status(hub, port1, &portstatus, &portchange) == 0)
2753 if (hub_port_warm_reset_required(hub, port1,
2757 clear_bit(port1, hub->warm_reset_bits);
2759 /* Reset the port */
2760 for (i = 0; i < PORT_RESET_TRIES; i++) {
2761 status = set_port_feature(hub->hdev, port1, (warm ?
2762 USB_PORT_FEAT_BH_PORT_RESET :
2763 USB_PORT_FEAT_RESET));
2764 if (status == -ENODEV) {
2765 ; /* The hub is gone */
2766 } else if (status) {
2767 dev_err(&port_dev->dev,
2768 "cannot %sreset (err = %d)\n",
2769 warm ? "warm " : "", status);
2771 status = hub_port_wait_reset(hub, port1, udev, delay,
2773 if (status && status != -ENOTCONN && status != -ENODEV)
2774 dev_dbg(hub->intfdev,
2775 "port_wait_reset: err = %d\n",
2779 /* Check for disconnect or reset */
2780 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2781 usb_clear_port_feature(hub->hdev, port1,
2782 USB_PORT_FEAT_C_RESET);
2784 if (!hub_is_superspeed(hub->hdev))
2787 usb_clear_port_feature(hub->hdev, port1,
2788 USB_PORT_FEAT_C_BH_PORT_RESET);
2789 usb_clear_port_feature(hub->hdev, port1,
2790 USB_PORT_FEAT_C_PORT_LINK_STATE);
2791 usb_clear_port_feature(hub->hdev, port1,
2792 USB_PORT_FEAT_C_CONNECTION);
2795 * If a USB 3.0 device migrates from reset to an error
2796 * state, re-issue the warm reset.
2798 if (hub_port_status(hub, port1,
2799 &portstatus, &portchange) < 0)
2802 if (!hub_port_warm_reset_required(hub, port1,
2807 * If the port is in SS.Inactive or Compliance Mode, the
2808 * hot or warm reset failed. Try another warm reset.
2811 dev_dbg(&port_dev->dev,
2812 "hot reset failed, warm reset\n");
2817 dev_dbg(&port_dev->dev,
2818 "not enabled, trying %sreset again...\n",
2819 warm ? "warm " : "");
2820 delay = HUB_LONG_RESET_TIME;
2823 dev_err(&port_dev->dev, "Cannot enable. Maybe the USB cable is bad?\n");
2827 /* TRSTRCY = 10 ms; plus some extra */
2830 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2832 update_devnum(udev, 0);
2833 /* The xHC may think the device is already reset,
2834 * so ignore the status.
2836 if (hcd->driver->reset_device)
2837 hcd->driver->reset_device(hcd, udev);
2839 usb_set_device_state(udev, USB_STATE_DEFAULT);
2843 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2846 if (!hub_is_superspeed(hub->hdev))
2847 up_read(&ehci_cf_port_reset_rwsem);
2852 /* Check if a port is power on */
2853 static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2857 if (hub_is_superspeed(hub->hdev)) {
2858 if (portstatus & USB_SS_PORT_STAT_POWER)
2861 if (portstatus & USB_PORT_STAT_POWER)
2868 static void usb_lock_port(struct usb_port *port_dev)
2869 __acquires(&port_dev->status_lock)
2871 mutex_lock(&port_dev->status_lock);
2872 __acquire(&port_dev->status_lock);
2875 static void usb_unlock_port(struct usb_port *port_dev)
2876 __releases(&port_dev->status_lock)
2878 mutex_unlock(&port_dev->status_lock);
2879 __release(&port_dev->status_lock);
2884 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2885 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
2889 if (hub_is_superspeed(hub->hdev)) {
2890 if ((portstatus & USB_PORT_STAT_LINK_STATE)
2891 == USB_SS_PORT_LS_U3)
2894 if (portstatus & USB_PORT_STAT_SUSPEND)
2901 /* Determine whether the device on a port is ready for a normal resume,
2902 * is ready for a reset-resume, or should be disconnected.
2904 static int check_port_resume_type(struct usb_device *udev,
2905 struct usb_hub *hub, int port1,
2906 int status, u16 portchange, u16 portstatus)
2908 struct usb_port *port_dev = hub->ports[port1 - 1];
2912 /* Is a warm reset needed to recover the connection? */
2913 if (status == 0 && udev->reset_resume
2914 && hub_port_warm_reset_required(hub, port1, portstatus)) {
2917 /* Is the device still present? */
2918 else if (status || port_is_suspended(hub, portstatus) ||
2919 !port_is_power_on(hub, portstatus)) {
2922 } else if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
2924 usleep_range(200, 300);
2925 status = hub_port_status(hub, port1, &portstatus,
2932 /* Can't do a normal resume if the port isn't enabled,
2933 * so try a reset-resume instead.
2935 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2936 if (udev->persist_enabled)
2937 udev->reset_resume = 1;
2943 dev_dbg(&port_dev->dev, "status %04x.%04x after resume, %d\n",
2944 portchange, portstatus, status);
2945 } else if (udev->reset_resume) {
2947 /* Late port handoff can set status-change bits */
2948 if (portchange & USB_PORT_STAT_C_CONNECTION)
2949 usb_clear_port_feature(hub->hdev, port1,
2950 USB_PORT_FEAT_C_CONNECTION);
2951 if (portchange & USB_PORT_STAT_C_ENABLE)
2952 usb_clear_port_feature(hub->hdev, port1,
2953 USB_PORT_FEAT_C_ENABLE);
2959 int usb_disable_ltm(struct usb_device *udev)
2961 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2963 /* Check if the roothub and device supports LTM. */
2964 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
2965 !usb_device_supports_ltm(udev))
2968 /* Clear Feature LTM Enable can only be sent if the device is
2971 if (!udev->actconfig)
2974 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2975 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2976 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
2977 USB_CTRL_SET_TIMEOUT);
2979 EXPORT_SYMBOL_GPL(usb_disable_ltm);
2981 void usb_enable_ltm(struct usb_device *udev)
2983 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2985 /* Check if the roothub and device supports LTM. */
2986 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
2987 !usb_device_supports_ltm(udev))
2990 /* Set Feature LTM Enable can only be sent if the device is
2993 if (!udev->actconfig)
2996 usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2997 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2998 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
2999 USB_CTRL_SET_TIMEOUT);
3001 EXPORT_SYMBOL_GPL(usb_enable_ltm);
3004 * usb_enable_remote_wakeup - enable remote wakeup for a device
3005 * @udev: target device
3007 * For USB-2 devices: Set the device's remote wakeup feature.
3009 * For USB-3 devices: Assume there's only one function on the device and
3010 * enable remote wake for the first interface. FIXME if the interface
3011 * association descriptor shows there's more than one function.
3013 static int usb_enable_remote_wakeup(struct usb_device *udev)
3015 if (udev->speed < USB_SPEED_SUPER)
3016 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3017 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
3018 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
3019 USB_CTRL_SET_TIMEOUT);
3021 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3022 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
3023 USB_INTRF_FUNC_SUSPEND,
3024 USB_INTRF_FUNC_SUSPEND_RW |
3025 USB_INTRF_FUNC_SUSPEND_LP,
3026 NULL, 0, USB_CTRL_SET_TIMEOUT);
3030 * usb_disable_remote_wakeup - disable remote wakeup for a device
3031 * @udev: target device
3033 * For USB-2 devices: Clear the device's remote wakeup feature.
3035 * For USB-3 devices: Assume there's only one function on the device and
3036 * disable remote wake for the first interface. FIXME if the interface
3037 * association descriptor shows there's more than one function.
3039 static int usb_disable_remote_wakeup(struct usb_device *udev)
3041 if (udev->speed < USB_SPEED_SUPER)
3042 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3043 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
3044 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
3045 USB_CTRL_SET_TIMEOUT);
3047 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3048 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
3049 USB_INTRF_FUNC_SUSPEND, 0, NULL, 0,
3050 USB_CTRL_SET_TIMEOUT);
3053 /* Count of wakeup-enabled devices at or below udev */
3054 static unsigned wakeup_enabled_descendants(struct usb_device *udev)
3056 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
3058 return udev->do_remote_wakeup +
3059 (hub ? hub->wakeup_enabled_descendants : 0);
3063 * usb_port_suspend - suspend a usb device's upstream port
3064 * @udev: device that's no longer in active use, not a root hub
3065 * Context: must be able to sleep; device not locked; pm locks held
3067 * Suspends a USB device that isn't in active use, conserving power.
3068 * Devices may wake out of a suspend, if anything important happens,
3069 * using the remote wakeup mechanism. They may also be taken out of
3070 * suspend by the host, using usb_port_resume(). It's also routine
3071 * to disconnect devices while they are suspended.
3073 * This only affects the USB hardware for a device; its interfaces
3074 * (and, for hubs, child devices) must already have been suspended.
3076 * Selective port suspend reduces power; most suspended devices draw
3077 * less than 500 uA. It's also used in OTG, along with remote wakeup.
3078 * All devices below the suspended port are also suspended.
3080 * Devices leave suspend state when the host wakes them up. Some devices
3081 * also support "remote wakeup", where the device can activate the USB
3082 * tree above them to deliver data, such as a keypress or packet. In
3083 * some cases, this wakes the USB host.
3085 * Suspending OTG devices may trigger HNP, if that's been enabled
3086 * between a pair of dual-role devices. That will change roles, such
3087 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
3089 * Devices on USB hub ports have only one "suspend" state, corresponding
3090 * to ACPI D2, "may cause the device to lose some context".
3091 * State transitions include:
3093 * - suspend, resume ... when the VBUS power link stays live
3094 * - suspend, disconnect ... VBUS lost
3096 * Once VBUS drop breaks the circuit, the port it's using has to go through
3097 * normal re-enumeration procedures, starting with enabling VBUS power.
3098 * Other than re-initializing the hub (plug/unplug, except for root hubs),
3099 * Linux (2.6) currently has NO mechanisms to initiate that: no hub_wq
3100 * timer, no SRP, no requests through sysfs.
3102 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
3103 * suspended until their bus goes into global suspend (i.e., the root
3104 * hub is suspended). Nevertheless, we change @udev->state to
3105 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
3106 * upstream port setting is stored in @udev->port_is_suspended.
3108 * Returns 0 on success, else negative errno.
3110 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
3112 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3113 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3114 int port1 = udev->portnum;
3116 bool really_suspend = true;
3118 usb_lock_port(port_dev);
3120 /* enable remote wakeup when appropriate; this lets the device
3121 * wake up the upstream hub (including maybe the root hub).
3123 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
3124 * we don't explicitly enable it here.
3126 if (udev->do_remote_wakeup) {
3127 status = usb_enable_remote_wakeup(udev);
3129 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
3131 /* bail if autosuspend is requested */
3132 if (PMSG_IS_AUTO(msg))
3137 /* disable USB2 hardware LPM */
3138 if (udev->usb2_hw_lpm_enabled == 1)
3139 usb_set_usb2_hardware_lpm(udev, 0);
3141 if (usb_disable_ltm(udev)) {
3142 dev_err(&udev->dev, "Failed to disable LTM before suspend\n.");
3144 if (PMSG_IS_AUTO(msg))
3147 if (usb_unlocked_disable_lpm(udev)) {
3148 dev_err(&udev->dev, "Failed to disable LPM before suspend\n.");
3150 if (PMSG_IS_AUTO(msg))
3155 if (hub_is_superspeed(hub->hdev))
3156 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U3);
3159 * For system suspend, we do not need to enable the suspend feature
3160 * on individual USB-2 ports. The devices will automatically go
3161 * into suspend a few ms after the root hub stops sending packets.
3162 * The USB 2.0 spec calls this "global suspend".
3164 * However, many USB hubs have a bug: They don't relay wakeup requests
3165 * from a downstream port if the port's suspend feature isn't on.
3166 * Therefore we will turn on the suspend feature if udev or any of its
3167 * descendants is enabled for remote wakeup.
3169 else if (PMSG_IS_AUTO(msg) || wakeup_enabled_descendants(udev) > 0)
3170 status = set_port_feature(hub->hdev, port1,
3171 USB_PORT_FEAT_SUSPEND);
3173 really_suspend = false;
3177 dev_dbg(&port_dev->dev, "can't suspend, status %d\n", status);
3179 /* Try to enable USB3 LPM and LTM again */
3180 usb_unlocked_enable_lpm(udev);
3182 usb_enable_ltm(udev);
3184 /* Try to enable USB2 hardware LPM again */
3185 if (udev->usb2_hw_lpm_capable == 1)
3186 usb_set_usb2_hardware_lpm(udev, 1);
3188 if (udev->do_remote_wakeup)
3189 (void) usb_disable_remote_wakeup(udev);
3192 /* System sleep transitions should never fail */
3193 if (!PMSG_IS_AUTO(msg))
3196 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
3197 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
3198 udev->do_remote_wakeup);
3199 if (really_suspend) {
3200 udev->port_is_suspended = 1;
3202 /* device has up to 10 msec to fully suspend */
3205 usb_set_device_state(udev, USB_STATE_SUSPENDED);
3208 if (status == 0 && !udev->do_remote_wakeup && udev->persist_enabled
3209 && test_and_clear_bit(port1, hub->child_usage_bits))
3210 pm_runtime_put_sync(&port_dev->dev);
3212 usb_mark_last_busy(hub->hdev);
3214 usb_unlock_port(port_dev);
3219 * If the USB "suspend" state is in use (rather than "global suspend"),
3220 * many devices will be individually taken out of suspend state using
3221 * special "resume" signaling. This routine kicks in shortly after
3222 * hardware resume signaling is finished, either because of selective
3223 * resume (by host) or remote wakeup (by device) ... now see what changed
3224 * in the tree that's rooted at this device.
3226 * If @udev->reset_resume is set then the device is reset before the
3227 * status check is done.
3229 static int finish_port_resume(struct usb_device *udev)
3234 /* caller owns the udev device lock */
3235 dev_dbg(&udev->dev, "%s\n",
3236 udev->reset_resume ? "finish reset-resume" : "finish resume");
3238 /* usb ch9 identifies four variants of SUSPENDED, based on what
3239 * state the device resumes to. Linux currently won't see the
3240 * first two on the host side; they'd be inside hub_port_init()
3241 * during many timeouts, but hub_wq can't suspend until later.
3243 usb_set_device_state(udev, udev->actconfig
3244 ? USB_STATE_CONFIGURED
3245 : USB_STATE_ADDRESS);
3247 /* 10.5.4.5 says not to reset a suspended port if the attached
3248 * device is enabled for remote wakeup. Hence the reset
3249 * operation is carried out here, after the port has been
3252 if (udev->reset_resume) {
3254 * If the device morphs or switches modes when it is reset,
3255 * we don't want to perform a reset-resume. We'll fail the
3256 * resume, which will cause a logical disconnect, and then
3257 * the device will be rediscovered.
3260 if (udev->quirks & USB_QUIRK_RESET)
3263 status = usb_reset_and_verify_device(udev);
3266 /* 10.5.4.5 says be sure devices in the tree are still there.
3267 * For now let's assume the device didn't go crazy on resume,
3268 * and device drivers will know about any resume quirks.
3272 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
3274 /* If a normal resume failed, try doing a reset-resume */
3275 if (status && !udev->reset_resume && udev->persist_enabled) {
3276 dev_dbg(&udev->dev, "retry with reset-resume\n");
3277 udev->reset_resume = 1;
3278 goto retry_reset_resume;
3283 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
3286 * There are a few quirky devices which violate the standard
3287 * by claiming to have remote wakeup enabled after a reset,
3288 * which crash if the feature is cleared, hence check for
3289 * udev->reset_resume
3291 } else if (udev->actconfig && !udev->reset_resume) {
3292 if (udev->speed < USB_SPEED_SUPER) {
3293 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
3294 status = usb_disable_remote_wakeup(udev);
3296 status = usb_get_status(udev, USB_RECIP_INTERFACE, 0,
3298 if (!status && devstatus & (USB_INTRF_STAT_FUNC_RW_CAP
3299 | USB_INTRF_STAT_FUNC_RW))
3300 status = usb_disable_remote_wakeup(udev);
3305 "disable remote wakeup, status %d\n",
3313 * There are some SS USB devices which take longer time for link training.
3314 * XHCI specs 4.19.4 says that when Link training is successful, port
3315 * sets CCS bit to 1. So if SW reads port status before successful link
3316 * training, then it will not find device to be present.
3317 * USB Analyzer log with such buggy devices show that in some cases
3318 * device switch on the RX termination after long delay of host enabling
3319 * the VBUS. In few other cases it has been seen that device fails to
3320 * negotiate link training in first attempt. It has been
3321 * reported till now that few devices take as long as 2000 ms to train
3322 * the link after host enabling its VBUS and termination. Following
3323 * routine implements a 2000 ms timeout for link training. If in a case
3324 * link trains before timeout, loop will exit earlier.
3326 * There are also some 2.0 hard drive based devices and 3.0 thumb
3327 * drives that, when plugged into a 2.0 only port, take a long
3328 * time to set CCS after VBUS enable.
3330 * FIXME: If a device was connected before suspend, but was removed
3331 * while system was asleep, then the loop in the following routine will
3332 * only exit at timeout.
3334 * This routine should only be called when persist is enabled.
3336 static int wait_for_connected(struct usb_device *udev,
3337 struct usb_hub *hub, int *port1,
3338 u16 *portchange, u16 *portstatus)
3340 int status = 0, delay_ms = 0;
3342 while (delay_ms < 2000) {
3343 if (status || *portstatus & USB_PORT_STAT_CONNECTION)
3347 status = hub_port_status(hub, *port1, portstatus, portchange);
3349 dev_dbg(&udev->dev, "Waited %dms for CONNECT\n", delay_ms);
3354 * usb_port_resume - re-activate a suspended usb device's upstream port
3355 * @udev: device to re-activate, not a root hub
3356 * Context: must be able to sleep; device not locked; pm locks held
3358 * This will re-activate the suspended device, increasing power usage
3359 * while letting drivers communicate again with its endpoints.
3360 * USB resume explicitly guarantees that the power session between
3361 * the host and the device is the same as it was when the device
3364 * If @udev->reset_resume is set then this routine won't check that the
3365 * port is still enabled. Furthermore, finish_port_resume() above will
3366 * reset @udev. The end result is that a broken power session can be
3367 * recovered and @udev will appear to persist across a loss of VBUS power.
3369 * For example, if a host controller doesn't maintain VBUS suspend current
3370 * during a system sleep or is reset when the system wakes up, all the USB
3371 * power sessions below it will be broken. This is especially troublesome
3372 * for mass-storage devices containing mounted filesystems, since the
3373 * device will appear to have disconnected and all the memory mappings
3374 * to it will be lost. Using the USB_PERSIST facility, the device can be
3375 * made to appear as if it had not disconnected.
3377 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3378 * every effort to insure that the same device is present after the
3379 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3380 * quite possible for a device to remain unaltered but its media to be
3381 * changed. If the user replaces a flash memory card while the system is
3382 * asleep, he will have only himself to blame when the filesystem on the
3383 * new card is corrupted and the system crashes.
3385 * Returns 0 on success, else negative errno.
3387 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
3389 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3390 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3391 int port1 = udev->portnum;
3393 u16 portchange, portstatus;
3395 if (!test_and_set_bit(port1, hub->child_usage_bits)) {
3396 status = pm_runtime_get_sync(&port_dev->dev);
3398 dev_dbg(&udev->dev, "can't resume usb port, status %d\n",
3404 usb_lock_port(port_dev);
3406 /* Skip the initial Clear-Suspend step for a remote wakeup */
3407 status = hub_port_status(hub, port1, &portstatus, &portchange);
3408 if (status == 0 && !port_is_suspended(hub, portstatus))
3409 goto SuspendCleared;
3411 /* see 7.1.7.7; affects power usage, but not budgeting */
3412 if (hub_is_superspeed(hub->hdev))
3413 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U0);
3415 status = usb_clear_port_feature(hub->hdev,
3416 port1, USB_PORT_FEAT_SUSPEND);
3418 dev_dbg(&port_dev->dev, "can't resume, status %d\n", status);
3420 /* drive resume for USB_RESUME_TIMEOUT msec */
3421 dev_dbg(&udev->dev, "usb %sresume\n",
3422 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
3423 msleep(USB_RESUME_TIMEOUT);
3425 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3426 * stop resume signaling. Then finish the resume
3429 status = hub_port_status(hub, port1, &portstatus, &portchange);
3431 /* TRSMRCY = 10 msec */
3437 udev->port_is_suspended = 0;
3438 if (hub_is_superspeed(hub->hdev)) {
3439 if (portchange & USB_PORT_STAT_C_LINK_STATE)
3440 usb_clear_port_feature(hub->hdev, port1,
3441 USB_PORT_FEAT_C_PORT_LINK_STATE);
3443 if (portchange & USB_PORT_STAT_C_SUSPEND)
3444 usb_clear_port_feature(hub->hdev, port1,
3445 USB_PORT_FEAT_C_SUSPEND);
3449 if (udev->persist_enabled)
3450 status = wait_for_connected(udev, hub, &port1, &portchange,
3453 status = check_port_resume_type(udev,
3454 hub, port1, status, portchange, portstatus);
3456 status = finish_port_resume(udev);
3458 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
3459 hub_port_logical_disconnect(hub, port1);
3461 /* Try to enable USB2 hardware LPM */
3462 if (udev->usb2_hw_lpm_capable == 1)
3463 usb_set_usb2_hardware_lpm(udev, 1);
3465 /* Try to enable USB3 LTM and LPM */
3466 usb_enable_ltm(udev);
3467 usb_unlocked_enable_lpm(udev);
3470 usb_unlock_port(port_dev);
3475 int usb_remote_wakeup(struct usb_device *udev)
3479 usb_lock_device(udev);
3480 if (udev->state == USB_STATE_SUSPENDED) {
3481 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
3482 status = usb_autoresume_device(udev);
3484 /* Let the drivers do their thing, then... */
3485 usb_autosuspend_device(udev);
3488 usb_unlock_device(udev);
3492 /* Returns 1 if there was a remote wakeup and a connect status change. */
3493 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
3494 u16 portstatus, u16 portchange)
3495 __must_hold(&port_dev->status_lock)
3497 struct usb_port *port_dev = hub->ports[port - 1];
3498 struct usb_device *hdev;
3499 struct usb_device *udev;
3500 int connect_change = 0;
3504 udev = port_dev->child;
3505 if (!hub_is_superspeed(hdev)) {
3506 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
3508 usb_clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
3510 if (!udev || udev->state != USB_STATE_SUSPENDED ||
3511 (portstatus & USB_PORT_STAT_LINK_STATE) !=
3517 /* TRSMRCY = 10 msec */
3520 usb_unlock_port(port_dev);
3521 ret = usb_remote_wakeup(udev);
3522 usb_lock_port(port_dev);
3527 hub_port_disable(hub, port, 1);
3529 dev_dbg(&port_dev->dev, "resume, status %d\n", ret);
3530 return connect_change;
3533 static int check_ports_changed(struct usb_hub *hub)
3537 for (port1 = 1; port1 <= hub->hdev->maxchild; ++port1) {
3538 u16 portstatus, portchange;
3541 status = hub_port_status(hub, port1, &portstatus, &portchange);
3542 if (!status && portchange)
3548 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
3550 struct usb_hub *hub = usb_get_intfdata(intf);
3551 struct usb_device *hdev = hub->hdev;
3556 * Warn if children aren't already suspended.
3557 * Also, add up the number of wakeup-enabled descendants.
3559 hub->wakeup_enabled_descendants = 0;
3560 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3561 struct usb_port *port_dev = hub->ports[port1 - 1];
3562 struct usb_device *udev = port_dev->child;
3564 if (udev && udev->can_submit) {
3565 dev_warn(&port_dev->dev, "device %s not suspended yet\n",
3566 dev_name(&udev->dev));
3567 if (PMSG_IS_AUTO(msg))
3571 hub->wakeup_enabled_descendants +=
3572 wakeup_enabled_descendants(udev);
3575 if (hdev->do_remote_wakeup && hub->quirk_check_port_auto_suspend) {
3576 /* check if there are changes pending on hub ports */
3577 if (check_ports_changed(hub)) {
3578 if (PMSG_IS_AUTO(msg))
3580 pm_wakeup_event(&hdev->dev, 2000);
3584 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
3585 /* Enable hub to send remote wakeup for all ports. */
3586 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3587 status = set_port_feature(hdev,
3589 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
3590 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
3591 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
3592 USB_PORT_FEAT_REMOTE_WAKE_MASK);
3596 dev_dbg(&intf->dev, "%s\n", __func__);
3598 /* stop hub_wq and related activity */
3599 hub_quiesce(hub, HUB_SUSPEND);
3603 static int hub_resume(struct usb_interface *intf)
3605 struct usb_hub *hub = usb_get_intfdata(intf);
3607 dev_dbg(&intf->dev, "%s\n", __func__);
3608 hub_activate(hub, HUB_RESUME);
3612 static int hub_reset_resume(struct usb_interface *intf)
3614 struct usb_hub *hub = usb_get_intfdata(intf);
3616 dev_dbg(&intf->dev, "%s\n", __func__);
3617 hub_activate(hub, HUB_RESET_RESUME);
3622 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3623 * @rhdev: struct usb_device for the root hub
3625 * The USB host controller driver calls this function when its root hub
3626 * is resumed and Vbus power has been interrupted or the controller
3627 * has been reset. The routine marks @rhdev as having lost power.
3628 * When the hub driver is resumed it will take notice and carry out
3629 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3630 * the others will be disconnected.
3632 void usb_root_hub_lost_power(struct usb_device *rhdev)
3634 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
3635 rhdev->reset_resume = 1;
3637 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
3639 static const char * const usb3_lpm_names[] = {
3647 * Send a Set SEL control transfer to the device, prior to enabling
3648 * device-initiated U1 or U2. This lets the device know the exit latencies from
3649 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3650 * packet from the host.
3652 * This function will fail if the SEL or PEL values for udev are greater than
3653 * the maximum allowed values for the link state to be enabled.
3655 static int usb_req_set_sel(struct usb_device *udev, enum usb3_link_state state)
3657 struct usb_set_sel_req *sel_values;
3658 unsigned long long u1_sel;
3659 unsigned long long u1_pel;
3660 unsigned long long u2_sel;
3661 unsigned long long u2_pel;
3664 if (udev->state != USB_STATE_CONFIGURED)
3667 /* Convert SEL and PEL stored in ns to us */
3668 u1_sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
3669 u1_pel = DIV_ROUND_UP(udev->u1_params.pel, 1000);
3670 u2_sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
3671 u2_pel = DIV_ROUND_UP(udev->u2_params.pel, 1000);
3674 * Make sure that the calculated SEL and PEL values for the link
3675 * state we're enabling aren't bigger than the max SEL/PEL
3676 * value that will fit in the SET SEL control transfer.
3677 * Otherwise the device would get an incorrect idea of the exit
3678 * latency for the link state, and could start a device-initiated
3679 * U1/U2 when the exit latencies are too high.
3681 if ((state == USB3_LPM_U1 &&
3682 (u1_sel > USB3_LPM_MAX_U1_SEL_PEL ||
3683 u1_pel > USB3_LPM_MAX_U1_SEL_PEL)) ||
3684 (state == USB3_LPM_U2 &&
3685 (u2_sel > USB3_LPM_MAX_U2_SEL_PEL ||
3686 u2_pel > USB3_LPM_MAX_U2_SEL_PEL))) {
3687 dev_dbg(&udev->dev, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3688 usb3_lpm_names[state], u1_sel, u1_pel);
3693 * If we're enabling device-initiated LPM for one link state,
3694 * but the other link state has a too high SEL or PEL value,
3695 * just set those values to the max in the Set SEL request.
3697 if (u1_sel > USB3_LPM_MAX_U1_SEL_PEL)
3698 u1_sel = USB3_LPM_MAX_U1_SEL_PEL;
3700 if (u1_pel > USB3_LPM_MAX_U1_SEL_PEL)
3701 u1_pel = USB3_LPM_MAX_U1_SEL_PEL;
3703 if (u2_sel > USB3_LPM_MAX_U2_SEL_PEL)
3704 u2_sel = USB3_LPM_MAX_U2_SEL_PEL;
3706 if (u2_pel > USB3_LPM_MAX_U2_SEL_PEL)
3707 u2_pel = USB3_LPM_MAX_U2_SEL_PEL;
3710 * usb_enable_lpm() can be called as part of a failed device reset,
3711 * which may be initiated by an error path of a mass storage driver.
3712 * Therefore, use GFP_NOIO.
3714 sel_values = kmalloc(sizeof *(sel_values), GFP_NOIO);
3718 sel_values->u1_sel = u1_sel;
3719 sel_values->u1_pel = u1_pel;
3720 sel_values->u2_sel = cpu_to_le16(u2_sel);
3721 sel_values->u2_pel = cpu_to_le16(u2_pel);
3723 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3727 sel_values, sizeof *(sel_values),
3728 USB_CTRL_SET_TIMEOUT);
3734 * Enable or disable device-initiated U1 or U2 transitions.
3736 static int usb_set_device_initiated_lpm(struct usb_device *udev,
3737 enum usb3_link_state state, bool enable)
3744 feature = USB_DEVICE_U1_ENABLE;
3747 feature = USB_DEVICE_U2_ENABLE;
3750 dev_warn(&udev->dev, "%s: Can't %s non-U1 or U2 state.\n",
3751 __func__, enable ? "enable" : "disable");
3755 if (udev->state != USB_STATE_CONFIGURED) {
3756 dev_dbg(&udev->dev, "%s: Can't %s %s state "
3757 "for unconfigured device.\n",
3758 __func__, enable ? "enable" : "disable",
3759 usb3_lpm_names[state]);
3765 * Now send the control transfer to enable device-initiated LPM
3766 * for either U1 or U2.
3768 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3769 USB_REQ_SET_FEATURE,
3773 USB_CTRL_SET_TIMEOUT);
3775 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3776 USB_REQ_CLEAR_FEATURE,
3780 USB_CTRL_SET_TIMEOUT);
3783 dev_warn(&udev->dev, "%s of device-initiated %s failed.\n",
3784 enable ? "Enable" : "Disable",
3785 usb3_lpm_names[state]);
3791 static int usb_set_lpm_timeout(struct usb_device *udev,
3792 enum usb3_link_state state, int timeout)
3799 feature = USB_PORT_FEAT_U1_TIMEOUT;
3802 feature = USB_PORT_FEAT_U2_TIMEOUT;
3805 dev_warn(&udev->dev, "%s: Can't set timeout for non-U1 or U2 state.\n",
3810 if (state == USB3_LPM_U1 && timeout > USB3_LPM_U1_MAX_TIMEOUT &&
3811 timeout != USB3_LPM_DEVICE_INITIATED) {
3812 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x, "
3813 "which is a reserved value.\n",
3814 usb3_lpm_names[state], timeout);
3818 ret = set_port_feature(udev->parent,
3819 USB_PORT_LPM_TIMEOUT(timeout) | udev->portnum,
3822 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x,"
3823 "error code %i\n", usb3_lpm_names[state],
3827 if (state == USB3_LPM_U1)
3828 udev->u1_params.timeout = timeout;
3830 udev->u2_params.timeout = timeout;
3835 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3838 * We will attempt to enable U1 or U2, but there are no guarantees that the
3839 * control transfers to set the hub timeout or enable device-initiated U1/U2
3840 * will be successful.
3842 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3843 * driver know about it. If that call fails, it should be harmless, and just
3844 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3846 static void usb_enable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3847 enum usb3_link_state state)
3850 __u8 u1_mel = udev->bos->ss_cap->bU1devExitLat;
3851 __le16 u2_mel = udev->bos->ss_cap->bU2DevExitLat;
3853 /* If the device says it doesn't have *any* exit latency to come out of
3854 * U1 or U2, it's probably lying. Assume it doesn't implement that link
3857 if ((state == USB3_LPM_U1 && u1_mel == 0) ||
3858 (state == USB3_LPM_U2 && u2_mel == 0))
3862 * First, let the device know about the exit latencies
3863 * associated with the link state we're about to enable.
3865 ret = usb_req_set_sel(udev, state);
3867 dev_warn(&udev->dev, "Set SEL for device-initiated %s failed.\n",
3868 usb3_lpm_names[state]);
3872 /* We allow the host controller to set the U1/U2 timeout internally
3873 * first, so that it can change its schedule to account for the
3874 * additional latency to send data to a device in a lower power
3877 timeout = hcd->driver->enable_usb3_lpm_timeout(hcd, udev, state);
3879 /* xHCI host controller doesn't want to enable this LPM state. */
3884 dev_warn(&udev->dev, "Could not enable %s link state, "
3885 "xHCI error %i.\n", usb3_lpm_names[state],
3890 if (usb_set_lpm_timeout(udev, state, timeout)) {
3891 /* If we can't set the parent hub U1/U2 timeout,
3892 * device-initiated LPM won't be allowed either, so let the xHCI
3893 * host know that this link state won't be enabled.
3895 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
3897 /* Only a configured device will accept the Set Feature
3900 if (udev->actconfig)
3901 usb_set_device_initiated_lpm(udev, state, true);
3903 /* As soon as usb_set_lpm_timeout(timeout) returns 0, the
3904 * hub-initiated LPM is enabled. Thus, LPM is enabled no
3905 * matter the result of usb_set_device_initiated_lpm().
3906 * The only difference is whether device is able to initiate
3909 if (state == USB3_LPM_U1)
3910 udev->usb3_lpm_u1_enabled = 1;
3911 else if (state == USB3_LPM_U2)
3912 udev->usb3_lpm_u2_enabled = 1;
3917 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
3920 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
3921 * If zero is returned, the parent will not allow the link to go into U1/U2.
3923 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
3924 * it won't have an effect on the bus link state because the parent hub will
3925 * still disallow device-initiated U1/U2 entry.
3927 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
3928 * possible. The result will be slightly more bus bandwidth will be taken up
3929 * (to account for U1/U2 exit latency), but it should be harmless.
3931 static int usb_disable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3932 enum usb3_link_state state)
3939 dev_warn(&udev->dev, "%s: Can't disable non-U1 or U2 state.\n",
3944 if (usb_set_lpm_timeout(udev, state, 0))
3947 usb_set_device_initiated_lpm(udev, state, false);
3949 if (hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state))
3950 dev_warn(&udev->dev, "Could not disable xHCI %s timeout, "
3951 "bus schedule bandwidth may be impacted.\n",
3952 usb3_lpm_names[state]);
3954 /* As soon as usb_set_lpm_timeout(0) return 0, hub initiated LPM
3955 * is disabled. Hub will disallows link to enter U1/U2 as well,
3956 * even device is initiating LPM. Hence LPM is disabled if hub LPM
3957 * timeout set to 0, no matter device-initiated LPM is disabled or
3960 if (state == USB3_LPM_U1)
3961 udev->usb3_lpm_u1_enabled = 0;
3962 else if (state == USB3_LPM_U2)
3963 udev->usb3_lpm_u2_enabled = 0;
3969 * Disable hub-initiated and device-initiated U1 and U2 entry.
3970 * Caller must own the bandwidth_mutex.
3972 * This will call usb_enable_lpm() on failure, which will decrement
3973 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
3975 int usb_disable_lpm(struct usb_device *udev)
3977 struct usb_hcd *hcd;
3979 if (!udev || !udev->parent ||
3980 udev->speed < USB_SPEED_SUPER ||
3981 !udev->lpm_capable ||
3982 udev->state < USB_STATE_DEFAULT)
3985 hcd = bus_to_hcd(udev->bus);
3986 if (!hcd || !hcd->driver->disable_usb3_lpm_timeout)
3989 udev->lpm_disable_count++;
3990 if ((udev->u1_params.timeout == 0 && udev->u2_params.timeout == 0))
3993 /* If LPM is enabled, attempt to disable it. */
3994 if (usb_disable_link_state(hcd, udev, USB3_LPM_U1))
3996 if (usb_disable_link_state(hcd, udev, USB3_LPM_U2))
4002 usb_enable_lpm(udev);
4005 EXPORT_SYMBOL_GPL(usb_disable_lpm);
4007 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
4008 int usb_unlocked_disable_lpm(struct usb_device *udev)
4010 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4016 mutex_lock(hcd->bandwidth_mutex);
4017 ret = usb_disable_lpm(udev);
4018 mutex_unlock(hcd->bandwidth_mutex);
4022 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
4025 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
4026 * xHCI host policy may prevent U1 or U2 from being enabled.
4028 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
4029 * until the lpm_disable_count drops to zero. Caller must own the
4032 void usb_enable_lpm(struct usb_device *udev)
4034 struct usb_hcd *hcd;
4035 struct usb_hub *hub;
4036 struct usb_port *port_dev;
4038 if (!udev || !udev->parent ||
4039 udev->speed < USB_SPEED_SUPER ||
4040 !udev->lpm_capable ||
4041 udev->state < USB_STATE_DEFAULT)
4044 udev->lpm_disable_count--;
4045 hcd = bus_to_hcd(udev->bus);
4046 /* Double check that we can both enable and disable LPM.
4047 * Device must be configured to accept set feature U1/U2 timeout.
4049 if (!hcd || !hcd->driver->enable_usb3_lpm_timeout ||
4050 !hcd->driver->disable_usb3_lpm_timeout)
4053 if (udev->lpm_disable_count > 0)
4056 hub = usb_hub_to_struct_hub(udev->parent);
4060 port_dev = hub->ports[udev->portnum - 1];
4062 if (port_dev->usb3_lpm_u1_permit)
4063 usb_enable_link_state(hcd, udev, USB3_LPM_U1);
4065 if (port_dev->usb3_lpm_u2_permit)
4066 usb_enable_link_state(hcd, udev, USB3_LPM_U2);
4068 EXPORT_SYMBOL_GPL(usb_enable_lpm);
4070 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
4071 void usb_unlocked_enable_lpm(struct usb_device *udev)
4073 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4078 mutex_lock(hcd->bandwidth_mutex);
4079 usb_enable_lpm(udev);
4080 mutex_unlock(hcd->bandwidth_mutex);
4082 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
4084 /* usb3 devices use U3 for disabled, make sure remote wakeup is disabled */
4085 static void hub_usb3_port_prepare_disable(struct usb_hub *hub,
4086 struct usb_port *port_dev)
4088 struct usb_device *udev = port_dev->child;
4091 if (udev && udev->port_is_suspended && udev->do_remote_wakeup) {
4092 ret = hub_set_port_link_state(hub, port_dev->portnum,
4095 msleep(USB_RESUME_TIMEOUT);
4096 ret = usb_disable_remote_wakeup(udev);
4099 dev_warn(&udev->dev,
4100 "Port disable: can't disable remote wake\n");
4101 udev->do_remote_wakeup = 0;
4105 #else /* CONFIG_PM */
4107 #define hub_suspend NULL
4108 #define hub_resume NULL
4109 #define hub_reset_resume NULL
4111 static inline void hub_usb3_port_prepare_disable(struct usb_hub *hub,
4112 struct usb_port *port_dev) { }
4114 int usb_disable_lpm(struct usb_device *udev)
4118 EXPORT_SYMBOL_GPL(usb_disable_lpm);
4120 void usb_enable_lpm(struct usb_device *udev) { }
4121 EXPORT_SYMBOL_GPL(usb_enable_lpm);
4123 int usb_unlocked_disable_lpm(struct usb_device *udev)
4127 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
4129 void usb_unlocked_enable_lpm(struct usb_device *udev) { }
4130 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
4132 int usb_disable_ltm(struct usb_device *udev)
4136 EXPORT_SYMBOL_GPL(usb_disable_ltm);
4138 void usb_enable_ltm(struct usb_device *udev) { }
4139 EXPORT_SYMBOL_GPL(usb_enable_ltm);
4141 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
4142 u16 portstatus, u16 portchange)
4147 #endif /* CONFIG_PM */
4150 * USB-3 does not have a similar link state as USB-2 that will avoid negotiating
4151 * a connection with a plugged-in cable but will signal the host when the cable
4152 * is unplugged. Disable remote wake and set link state to U3 for USB-3 devices
4154 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
4156 struct usb_port *port_dev = hub->ports[port1 - 1];
4157 struct usb_device *hdev = hub->hdev;
4161 if (hub_is_superspeed(hub->hdev)) {
4162 hub_usb3_port_prepare_disable(hub, port_dev);
4163 ret = hub_set_port_link_state(hub, port_dev->portnum,
4166 ret = usb_clear_port_feature(hdev, port1,
4167 USB_PORT_FEAT_ENABLE);
4170 if (port_dev->child && set_state)
4171 usb_set_device_state(port_dev->child, USB_STATE_NOTATTACHED);
4172 if (ret && ret != -ENODEV)
4173 dev_err(&port_dev->dev, "cannot disable (err = %d)\n", ret);
4178 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
4180 * Between connect detection and reset signaling there must be a delay
4181 * of 100ms at least for debounce and power-settling. The corresponding
4182 * timer shall restart whenever the downstream port detects a disconnect.
4184 * Apparently there are some bluetooth and irda-dongles and a number of
4185 * low-speed devices for which this debounce period may last over a second.
4186 * Not covered by the spec - but easy to deal with.
4188 * This implementation uses a 1500ms total debounce timeout; if the
4189 * connection isn't stable by then it returns -ETIMEDOUT. It checks
4190 * every 25ms for transient disconnects. When the port status has been
4191 * unchanged for 100ms it returns the port status.
4193 int hub_port_debounce(struct usb_hub *hub, int port1, bool must_be_connected)
4196 u16 portchange, portstatus;
4197 unsigned connection = 0xffff;
4198 int total_time, stable_time = 0;
4199 struct usb_port *port_dev = hub->ports[port1 - 1];
4201 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
4202 ret = hub_port_status(hub, port1, &portstatus, &portchange);
4206 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
4207 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
4208 if (!must_be_connected ||
4209 (connection == USB_PORT_STAT_CONNECTION))
4210 stable_time += HUB_DEBOUNCE_STEP;
4211 if (stable_time >= HUB_DEBOUNCE_STABLE)
4215 connection = portstatus & USB_PORT_STAT_CONNECTION;
4218 if (portchange & USB_PORT_STAT_C_CONNECTION) {
4219 usb_clear_port_feature(hub->hdev, port1,
4220 USB_PORT_FEAT_C_CONNECTION);
4223 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
4225 msleep(HUB_DEBOUNCE_STEP);
4228 dev_dbg(&port_dev->dev, "debounce total %dms stable %dms status 0x%x\n",
4229 total_time, stable_time, portstatus);
4231 if (stable_time < HUB_DEBOUNCE_STABLE)
4236 void usb_ep0_reinit(struct usb_device *udev)
4238 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
4239 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
4240 usb_enable_endpoint(udev, &udev->ep0, true);
4242 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
4244 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
4245 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
4247 static int hub_set_address(struct usb_device *udev, int devnum)
4250 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4253 * The host controller will choose the device address,
4254 * instead of the core having chosen it earlier
4256 if (!hcd->driver->address_device && devnum <= 1)
4258 if (udev->state == USB_STATE_ADDRESS)
4260 if (udev->state != USB_STATE_DEFAULT)
4262 if (hcd->driver->address_device)
4263 retval = hcd->driver->address_device(hcd, udev);
4265 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
4266 USB_REQ_SET_ADDRESS, 0, devnum, 0,
4267 NULL, 0, USB_CTRL_SET_TIMEOUT);
4269 update_devnum(udev, devnum);
4270 /* Device now using proper address. */
4271 usb_set_device_state(udev, USB_STATE_ADDRESS);
4272 usb_ep0_reinit(udev);
4278 * There are reports of USB 3.0 devices that say they support USB 2.0 Link PM
4279 * when they're plugged into a USB 2.0 port, but they don't work when LPM is
4282 * Only enable USB 2.0 Link PM if the port is internal (hardwired), or the
4283 * device says it supports the new USB 2.0 Link PM errata by setting the BESL
4284 * support bit in the BOS descriptor.
4286 static void hub_set_initial_usb2_lpm_policy(struct usb_device *udev)
4288 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
4289 int connect_type = USB_PORT_CONNECT_TYPE_UNKNOWN;
4291 if (!udev->usb2_hw_lpm_capable || !udev->bos)
4295 connect_type = hub->ports[udev->portnum - 1]->connect_type;
4297 if ((udev->bos->ext_cap->bmAttributes & cpu_to_le32(USB_BESL_SUPPORT)) ||
4298 connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
4299 udev->usb2_hw_lpm_allowed = 1;
4300 usb_set_usb2_hardware_lpm(udev, 1);
4304 static int hub_enable_device(struct usb_device *udev)
4306 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4308 if (!hcd->driver->enable_device)
4310 if (udev->state == USB_STATE_ADDRESS)
4312 if (udev->state != USB_STATE_DEFAULT)
4315 return hcd->driver->enable_device(hcd, udev);
4318 /* Reset device, (re)assign address, get device descriptor.
4319 * Device connection must be stable, no more debouncing needed.
4320 * Returns device in USB_STATE_ADDRESS, except on error.
4322 * If this is called for an already-existing device (as part of
4323 * usb_reset_and_verify_device), the caller must own the device lock and
4324 * the port lock. For a newly detected device that is not accessible
4325 * through any global pointers, it's not necessary to lock the device,
4326 * but it is still necessary to lock the port.
4329 hub_port_init(struct usb_hub *hub, struct usb_device *udev, int port1,
4332 struct usb_device *hdev = hub->hdev;
4333 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4334 int retries, operations, retval, i;
4335 unsigned delay = HUB_SHORT_RESET_TIME;
4336 enum usb_device_speed oldspeed = udev->speed;
4338 int devnum = udev->devnum;
4340 /* root hub ports have a slightly longer reset period
4341 * (from USB 2.0 spec, section 7.1.7.5)
4343 if (!hdev->parent) {
4344 delay = HUB_ROOT_RESET_TIME;
4345 if (port1 == hdev->bus->otg_port)
4346 hdev->bus->b_hnp_enable = 0;
4349 /* Some low speed devices have problems with the quick delay, so */
4350 /* be a bit pessimistic with those devices. RHbug #23670 */
4351 if (oldspeed == USB_SPEED_LOW)
4352 delay = HUB_LONG_RESET_TIME;
4354 mutex_lock(hcd->address0_mutex);
4356 /* Reset the device; full speed may morph to high speed */
4357 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
4358 retval = hub_port_reset(hub, port1, udev, delay, false);
4359 if (retval < 0) /* error or disconnect */
4361 /* success, speed is known */
4365 /* Don't allow speed changes at reset, except usb 3.0 to faster */
4366 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed &&
4367 !(oldspeed == USB_SPEED_SUPER && udev->speed > oldspeed)) {
4368 dev_dbg(&udev->dev, "device reset changed speed!\n");
4371 oldspeed = udev->speed;
4373 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4374 * it's fixed size except for full speed devices.
4375 * For Wireless USB devices, ep0 max packet is always 512 (tho
4376 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4378 switch (udev->speed) {
4379 case USB_SPEED_SUPER_PLUS:
4380 case USB_SPEED_SUPER:
4381 case USB_SPEED_WIRELESS: /* fixed at 512 */
4382 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
4384 case USB_SPEED_HIGH: /* fixed at 64 */
4385 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4387 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
4388 /* to determine the ep0 maxpacket size, try to read
4389 * the device descriptor to get bMaxPacketSize0 and
4390 * then correct our initial guess.
4392 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4394 case USB_SPEED_LOW: /* fixed at 8 */
4395 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
4401 if (udev->speed == USB_SPEED_WIRELESS)
4402 speed = "variable speed Wireless";
4404 speed = usb_speed_string(udev->speed);
4406 if (udev->speed < USB_SPEED_SUPER)
4407 dev_info(&udev->dev,
4408 "%s %s USB device number %d using %s\n",
4409 (udev->config) ? "reset" : "new", speed,
4410 devnum, udev->bus->controller->driver->name);
4412 /* Set up TT records, if needed */
4414 udev->tt = hdev->tt;
4415 udev->ttport = hdev->ttport;
4416 } else if (udev->speed != USB_SPEED_HIGH
4417 && hdev->speed == USB_SPEED_HIGH) {
4419 dev_err(&udev->dev, "parent hub has no TT\n");
4423 udev->tt = &hub->tt;
4424 udev->ttport = port1;
4427 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4428 * Because device hardware and firmware is sometimes buggy in
4429 * this area, and this is how Linux has done it for ages.
4430 * Change it cautiously.
4432 * NOTE: If use_new_scheme() is true we will start by issuing
4433 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4434 * so it may help with some non-standards-compliant devices.
4435 * Otherwise we start with SET_ADDRESS and then try to read the
4436 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4439 for (retries = 0; retries < GET_DESCRIPTOR_TRIES; (++retries, msleep(100))) {
4440 bool did_new_scheme = false;
4442 if (use_new_scheme(udev, retry_counter)) {
4443 struct usb_device_descriptor *buf;
4446 did_new_scheme = true;
4447 retval = hub_enable_device(udev);
4450 "hub failed to enable device, error %d\n",
4455 #define GET_DESCRIPTOR_BUFSIZE 64
4456 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
4462 /* Retry on all errors; some devices are flakey.
4463 * 255 is for WUSB devices, we actually need to use
4464 * 512 (WUSB1.0[4.8.1]).
4466 for (operations = 0; operations < 3; ++operations) {
4467 buf->bMaxPacketSize0 = 0;
4468 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
4469 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
4470 USB_DT_DEVICE << 8, 0,
4471 buf, GET_DESCRIPTOR_BUFSIZE,
4472 initial_descriptor_timeout);
4473 switch (buf->bMaxPacketSize0) {
4474 case 8: case 16: case 32: case 64: case 255:
4475 if (buf->bDescriptorType ==
4487 * Some devices time out if they are powered on
4488 * when already connected. They need a second
4489 * reset. But only on the first attempt,
4490 * lest we get into a time out/reset loop
4492 if (r == 0 || (r == -ETIMEDOUT && retries == 0))
4495 udev->descriptor.bMaxPacketSize0 =
4496 buf->bMaxPacketSize0;
4499 retval = hub_port_reset(hub, port1, udev, delay, false);
4500 if (retval < 0) /* error or disconnect */
4502 if (oldspeed != udev->speed) {
4504 "device reset changed speed!\n");
4510 dev_err(&udev->dev, "device descriptor read/64, error %d\n",
4515 #undef GET_DESCRIPTOR_BUFSIZE
4519 * If device is WUSB, we already assigned an
4520 * unauthorized address in the Connect Ack sequence;
4521 * authorization will assign the final address.
4523 if (udev->wusb == 0) {
4524 for (operations = 0; operations < SET_ADDRESS_TRIES; ++operations) {
4525 retval = hub_set_address(udev, devnum);
4531 if (retval != -ENODEV)
4532 dev_err(&udev->dev, "device not accepting address %d, error %d\n",
4536 if (udev->speed >= USB_SPEED_SUPER) {
4537 devnum = udev->devnum;
4538 dev_info(&udev->dev,
4539 "%s SuperSpeed%s USB device number %d using %s\n",
4540 (udev->config) ? "reset" : "new",
4541 (udev->speed == USB_SPEED_SUPER_PLUS) ? "Plus" : "",
4542 devnum, udev->bus->controller->driver->name);
4545 /* cope with hardware quirkiness:
4546 * - let SET_ADDRESS settle, some device hardware wants it
4547 * - read ep0 maxpacket even for high and low speed,
4550 /* use_new_scheme() checks the speed which may have
4551 * changed since the initial look so we cache the result
4558 retval = usb_get_device_descriptor(udev, 8);
4560 if (retval != -ENODEV)
4562 "device descriptor read/8, error %d\n",
4575 * Some superspeed devices have finished the link training process
4576 * and attached to a superspeed hub port, but the device descriptor
4577 * got from those devices show they aren't superspeed devices. Warm
4578 * reset the port attached by the devices can fix them.
4580 if ((udev->speed >= USB_SPEED_SUPER) &&
4581 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
4582 dev_err(&udev->dev, "got a wrong device descriptor, "
4583 "warm reset device\n");
4584 hub_port_reset(hub, port1, udev,
4585 HUB_BH_RESET_TIME, true);
4590 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
4591 udev->speed >= USB_SPEED_SUPER)
4594 i = udev->descriptor.bMaxPacketSize0;
4595 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
4596 if (udev->speed == USB_SPEED_LOW ||
4597 !(i == 8 || i == 16 || i == 32 || i == 64)) {
4598 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
4602 if (udev->speed == USB_SPEED_FULL)
4603 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
4605 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
4606 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
4607 usb_ep0_reinit(udev);
4610 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
4611 if (retval < (signed)sizeof(udev->descriptor)) {
4612 if (retval != -ENODEV)
4613 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
4620 usb_detect_quirks(udev);
4622 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
4623 retval = usb_get_bos_descriptor(udev);
4625 udev->lpm_capable = usb_device_supports_lpm(udev);
4626 usb_set_lpm_parameters(udev);
4631 /* notify HCD that we have a device connected and addressed */
4632 if (hcd->driver->update_device)
4633 hcd->driver->update_device(hcd, udev);
4634 hub_set_initial_usb2_lpm_policy(udev);
4637 hub_port_disable(hub, port1, 0);
4638 update_devnum(udev, devnum); /* for disconnect processing */
4640 mutex_unlock(hcd->address0_mutex);
4645 check_highspeed(struct usb_hub *hub, struct usb_device *udev, int port1)
4647 struct usb_qualifier_descriptor *qual;
4650 if (udev->quirks & USB_QUIRK_DEVICE_QUALIFIER)
4653 qual = kmalloc(sizeof *qual, GFP_KERNEL);
4657 status = usb_get_descriptor(udev, USB_DT_DEVICE_QUALIFIER, 0,
4658 qual, sizeof *qual);
4659 if (status == sizeof *qual) {
4660 dev_info(&udev->dev, "not running at top speed; "
4661 "connect to a high speed hub\n");
4662 /* hub LEDs are probably harder to miss than syslog */
4663 if (hub->has_indicators) {
4664 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
4665 queue_delayed_work(system_power_efficient_wq,
4673 hub_power_remaining(struct usb_hub *hub)
4675 struct usb_device *hdev = hub->hdev;
4679 if (!hub->limited_power)
4682 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
4683 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
4684 struct usb_port *port_dev = hub->ports[port1 - 1];
4685 struct usb_device *udev = port_dev->child;
4691 if (hub_is_superspeed(udev))
4697 * Unconfigured devices may not use more than one unit load,
4698 * or 8mA for OTG ports
4700 if (udev->actconfig)
4701 delta = usb_get_max_power(udev, udev->actconfig);
4702 else if (port1 != udev->bus->otg_port || hdev->parent)
4706 if (delta > hub->mA_per_port)
4707 dev_warn(&port_dev->dev, "%dmA is over %umA budget!\n",
4708 delta, hub->mA_per_port);
4711 if (remaining < 0) {
4712 dev_warn(hub->intfdev, "%dmA over power budget!\n",
4719 static void hub_port_connect(struct usb_hub *hub, int port1, u16 portstatus,
4724 struct usb_device *hdev = hub->hdev;
4725 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4726 struct usb_port *port_dev = hub->ports[port1 - 1];
4727 struct usb_device *udev = port_dev->child;
4728 static int unreliable_port = -1;
4730 /* Disconnect any existing devices under this port */
4732 if (hcd->usb_phy && !hdev->parent)
4733 usb_phy_notify_disconnect(hcd->usb_phy, udev->speed);
4734 usb_disconnect(&port_dev->child);
4737 /* We can forget about a "removed" device when there's a physical
4738 * disconnect or the connect status changes.
4740 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4741 (portchange & USB_PORT_STAT_C_CONNECTION))
4742 clear_bit(port1, hub->removed_bits);
4744 if (portchange & (USB_PORT_STAT_C_CONNECTION |
4745 USB_PORT_STAT_C_ENABLE)) {
4746 status = hub_port_debounce_be_stable(hub, port1);
4748 if (status != -ENODEV &&
4749 port1 != unreliable_port &&
4751 dev_err(&port_dev->dev, "connect-debounce failed\n");
4752 portstatus &= ~USB_PORT_STAT_CONNECTION;
4753 unreliable_port = port1;
4755 portstatus = status;
4759 /* Return now if debouncing failed or nothing is connected or
4760 * the device was "removed".
4762 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4763 test_bit(port1, hub->removed_bits)) {
4766 * maybe switch power back on (e.g. root hub was reset)
4767 * but only if the port isn't owned by someone else.
4769 if (hub_is_port_power_switchable(hub)
4770 && !port_is_power_on(hub, portstatus)
4771 && !port_dev->port_owner)
4772 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
4774 if (portstatus & USB_PORT_STAT_ENABLE)
4778 if (hub_is_superspeed(hub->hdev))
4784 for (i = 0; i < SET_CONFIG_TRIES; i++) {
4786 /* reallocate for each attempt, since references
4787 * to the previous one can escape in various ways
4789 udev = usb_alloc_dev(hdev, hdev->bus, port1);
4791 dev_err(&port_dev->dev,
4792 "couldn't allocate usb_device\n");
4796 usb_set_device_state(udev, USB_STATE_POWERED);
4797 udev->bus_mA = hub->mA_per_port;
4798 udev->level = hdev->level + 1;
4799 udev->wusb = hub_is_wusb(hub);
4801 /* Devices connected to SuperSpeed hubs are USB 3.0 or later */
4802 if (hub_is_superspeed(hub->hdev))
4803 udev->speed = USB_SPEED_SUPER;
4805 udev->speed = USB_SPEED_UNKNOWN;
4807 choose_devnum(udev);
4808 if (udev->devnum <= 0) {
4809 status = -ENOTCONN; /* Don't retry */
4813 /* reset (non-USB 3.0 devices) and get descriptor */
4814 usb_lock_port(port_dev);
4815 status = hub_port_init(hub, udev, port1, i);
4816 usb_unlock_port(port_dev);
4820 if (udev->quirks & USB_QUIRK_DELAY_INIT)
4823 /* consecutive bus-powered hubs aren't reliable; they can
4824 * violate the voltage drop budget. if the new child has
4825 * a "powered" LED, users should notice we didn't enable it
4826 * (without reading syslog), even without per-port LEDs
4829 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
4830 && udev->bus_mA <= unit_load) {
4833 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
4836 dev_dbg(&udev->dev, "get status %d ?\n", status);
4839 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
4841 "can't connect bus-powered hub "
4843 if (hub->has_indicators) {
4844 hub->indicator[port1-1] =
4845 INDICATOR_AMBER_BLINK;
4847 system_power_efficient_wq,
4850 status = -ENOTCONN; /* Don't retry */
4855 /* check for devices running slower than they could */
4856 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
4857 && udev->speed == USB_SPEED_FULL
4858 && highspeed_hubs != 0)
4859 check_highspeed(hub, udev, port1);
4861 /* Store the parent's children[] pointer. At this point
4862 * udev becomes globally accessible, although presumably
4863 * no one will look at it until hdev is unlocked.
4867 mutex_lock(&usb_port_peer_mutex);
4869 /* We mustn't add new devices if the parent hub has
4870 * been disconnected; we would race with the
4871 * recursively_mark_NOTATTACHED() routine.
4873 spin_lock_irq(&device_state_lock);
4874 if (hdev->state == USB_STATE_NOTATTACHED)
4877 port_dev->child = udev;
4878 spin_unlock_irq(&device_state_lock);
4879 mutex_unlock(&usb_port_peer_mutex);
4881 /* Run it through the hoops (find a driver, etc) */
4883 status = usb_new_device(udev);
4885 mutex_lock(&usb_port_peer_mutex);
4886 spin_lock_irq(&device_state_lock);
4887 port_dev->child = NULL;
4888 spin_unlock_irq(&device_state_lock);
4889 mutex_unlock(&usb_port_peer_mutex);
4891 if (hcd->usb_phy && !hdev->parent)
4892 usb_phy_notify_connect(hcd->usb_phy,
4900 status = hub_power_remaining(hub);
4902 dev_dbg(hub->intfdev, "%dmA power budget left\n", status);
4907 hub_port_disable(hub, port1, 1);
4909 usb_ep0_reinit(udev);
4910 release_devnum(udev);
4913 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
4916 if (hub->hdev->parent ||
4917 !hcd->driver->port_handed_over ||
4918 !(hcd->driver->port_handed_over)(hcd, port1)) {
4919 if (status != -ENOTCONN && status != -ENODEV)
4920 dev_err(&port_dev->dev,
4921 "unable to enumerate USB device\n");
4925 hub_port_disable(hub, port1, 1);
4926 if (hcd->driver->relinquish_port && !hub->hdev->parent)
4927 hcd->driver->relinquish_port(hcd, port1);
4931 /* Handle physical or logical connection change events.
4932 * This routine is called when:
4933 * a port connection-change occurs;
4934 * a port enable-change occurs (often caused by EMI);
4935 * usb_reset_and_verify_device() encounters changed descriptors (as from
4936 * a firmware download)
4937 * caller already locked the hub
4939 static void hub_port_connect_change(struct usb_hub *hub, int port1,
4940 u16 portstatus, u16 portchange)
4941 __must_hold(&port_dev->status_lock)
4943 struct usb_port *port_dev = hub->ports[port1 - 1];
4944 struct usb_device *udev = port_dev->child;
4945 int status = -ENODEV;
4947 dev_dbg(&port_dev->dev, "status %04x, change %04x, %s\n", portstatus,
4948 portchange, portspeed(hub, portstatus));
4950 if (hub->has_indicators) {
4951 set_port_led(hub, port1, HUB_LED_AUTO);
4952 hub->indicator[port1-1] = INDICATOR_AUTO;
4955 #ifdef CONFIG_USB_OTG
4956 /* during HNP, don't repeat the debounce */
4957 if (hub->hdev->bus->is_b_host)
4958 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
4959 USB_PORT_STAT_C_ENABLE);
4962 /* Try to resuscitate an existing device */
4963 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
4964 udev->state != USB_STATE_NOTATTACHED) {
4965 if (portstatus & USB_PORT_STAT_ENABLE) {
4966 status = 0; /* Nothing to do */
4968 } else if (udev->state == USB_STATE_SUSPENDED &&
4969 udev->persist_enabled) {
4970 /* For a suspended device, treat this as a
4971 * remote wakeup event.
4973 usb_unlock_port(port_dev);
4974 status = usb_remote_wakeup(udev);
4975 usb_lock_port(port_dev);
4978 /* Don't resuscitate */;
4981 clear_bit(port1, hub->change_bits);
4983 /* successfully revalidated the connection */
4987 usb_unlock_port(port_dev);
4988 hub_port_connect(hub, port1, portstatus, portchange);
4989 usb_lock_port(port_dev);
4992 static void port_event(struct usb_hub *hub, int port1)
4993 __must_hold(&port_dev->status_lock)
4996 struct usb_port *port_dev = hub->ports[port1 - 1];
4997 struct usb_device *udev = port_dev->child;
4998 struct usb_device *hdev = hub->hdev;
4999 u16 portstatus, portchange;
5001 connect_change = test_bit(port1, hub->change_bits);
5002 clear_bit(port1, hub->event_bits);
5003 clear_bit(port1, hub->wakeup_bits);
5005 if (hub_port_status(hub, port1, &portstatus, &portchange) < 0)
5008 if (portchange & USB_PORT_STAT_C_CONNECTION) {
5009 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_CONNECTION);
5013 if (portchange & USB_PORT_STAT_C_ENABLE) {
5014 if (!connect_change)
5015 dev_dbg(&port_dev->dev, "enable change, status %08x\n",
5017 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_ENABLE);
5020 * EM interference sometimes causes badly shielded USB devices
5021 * to be shutdown by the hub, this hack enables them again.
5022 * Works at least with mouse driver.
5024 if (!(portstatus & USB_PORT_STAT_ENABLE)
5025 && !connect_change && udev) {
5026 dev_err(&port_dev->dev, "disabled by hub (EMI?), re-enabling...\n");
5031 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
5032 u16 status = 0, unused;
5034 dev_dbg(&port_dev->dev, "over-current change\n");
5035 usb_clear_port_feature(hdev, port1,
5036 USB_PORT_FEAT_C_OVER_CURRENT);
5037 msleep(100); /* Cool down */
5038 hub_power_on(hub, true);
5039 hub_port_status(hub, port1, &status, &unused);
5040 if (status & USB_PORT_STAT_OVERCURRENT)
5041 dev_err(&port_dev->dev, "over-current condition\n");
5044 if (portchange & USB_PORT_STAT_C_RESET) {
5045 dev_dbg(&port_dev->dev, "reset change\n");
5046 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_RESET);
5048 if ((portchange & USB_PORT_STAT_C_BH_RESET)
5049 && hub_is_superspeed(hdev)) {
5050 dev_dbg(&port_dev->dev, "warm reset change\n");
5051 usb_clear_port_feature(hdev, port1,
5052 USB_PORT_FEAT_C_BH_PORT_RESET);
5054 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
5055 dev_dbg(&port_dev->dev, "link state change\n");
5056 usb_clear_port_feature(hdev, port1,
5057 USB_PORT_FEAT_C_PORT_LINK_STATE);
5059 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
5060 dev_warn(&port_dev->dev, "config error\n");
5061 usb_clear_port_feature(hdev, port1,
5062 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
5065 /* skip port actions that require the port to be powered on */
5066 if (!pm_runtime_active(&port_dev->dev))
5069 if (hub_handle_remote_wakeup(hub, port1, portstatus, portchange))
5073 * Warm reset a USB3 protocol port if it's in
5074 * SS.Inactive state.
5076 if (hub_port_warm_reset_required(hub, port1, portstatus)) {
5077 dev_dbg(&port_dev->dev, "do warm reset\n");
5078 if (!udev || !(portstatus & USB_PORT_STAT_CONNECTION)
5079 || udev->state == USB_STATE_NOTATTACHED) {
5080 if (hub_port_reset(hub, port1, NULL,
5081 HUB_BH_RESET_TIME, true) < 0)
5082 hub_port_disable(hub, port1, 1);
5084 usb_unlock_port(port_dev);
5085 usb_lock_device(udev);
5086 usb_reset_device(udev);
5087 usb_unlock_device(udev);
5088 usb_lock_port(port_dev);
5094 hub_port_connect_change(hub, port1, portstatus, portchange);
5097 static void hub_event(struct work_struct *work)
5099 struct usb_device *hdev;
5100 struct usb_interface *intf;
5101 struct usb_hub *hub;
5102 struct device *hub_dev;
5107 hub = container_of(work, struct usb_hub, events);
5109 hub_dev = hub->intfdev;
5110 intf = to_usb_interface(hub_dev);
5112 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
5113 hdev->state, hdev->maxchild,
5114 /* NOTE: expects max 15 ports... */
5115 (u16) hub->change_bits[0],
5116 (u16) hub->event_bits[0]);
5118 /* Lock the device, then check to see if we were
5119 * disconnected while waiting for the lock to succeed. */
5120 usb_lock_device(hdev);
5121 if (unlikely(hub->disconnected))
5124 /* If the hub has died, clean up after it */
5125 if (hdev->state == USB_STATE_NOTATTACHED) {
5126 hub->error = -ENODEV;
5127 hub_quiesce(hub, HUB_DISCONNECT);
5132 ret = usb_autopm_get_interface(intf);
5134 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
5138 /* If this is an inactive hub, do nothing */
5143 dev_dbg(hub_dev, "resetting for error %d\n", hub->error);
5145 ret = usb_reset_device(hdev);
5147 dev_dbg(hub_dev, "error resetting hub: %d\n", ret);
5155 /* deal with port status changes */
5156 for (i = 1; i <= hdev->maxchild; i++) {
5157 struct usb_port *port_dev = hub->ports[i - 1];
5159 if (test_bit(i, hub->event_bits)
5160 || test_bit(i, hub->change_bits)
5161 || test_bit(i, hub->wakeup_bits)) {
5163 * The get_noresume and barrier ensure that if
5164 * the port was in the process of resuming, we
5165 * flush that work and keep the port active for
5166 * the duration of the port_event(). However,
5167 * if the port is runtime pm suspended
5168 * (powered-off), we leave it in that state, run
5169 * an abbreviated port_event(), and move on.
5171 pm_runtime_get_noresume(&port_dev->dev);
5172 pm_runtime_barrier(&port_dev->dev);
5173 usb_lock_port(port_dev);
5175 usb_unlock_port(port_dev);
5176 pm_runtime_put_sync(&port_dev->dev);
5180 /* deal with hub status changes */
5181 if (test_and_clear_bit(0, hub->event_bits) == 0)
5183 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
5184 dev_err(hub_dev, "get_hub_status failed\n");
5186 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
5187 dev_dbg(hub_dev, "power change\n");
5188 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
5189 if (hubstatus & HUB_STATUS_LOCAL_POWER)
5190 /* FIXME: Is this always true? */
5191 hub->limited_power = 1;
5193 hub->limited_power = 0;
5195 if (hubchange & HUB_CHANGE_OVERCURRENT) {
5199 dev_dbg(hub_dev, "over-current change\n");
5200 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
5201 msleep(500); /* Cool down */
5202 hub_power_on(hub, true);
5203 hub_hub_status(hub, &status, &unused);
5204 if (status & HUB_STATUS_OVERCURRENT)
5205 dev_err(hub_dev, "over-current condition\n");
5210 /* Balance the usb_autopm_get_interface() above */
5211 usb_autopm_put_interface_no_suspend(intf);
5213 usb_unlock_device(hdev);
5215 /* Balance the stuff in kick_hub_wq() and allow autosuspend */
5216 usb_autopm_put_interface(intf);
5217 kref_put(&hub->kref, hub_release);
5220 static const struct usb_device_id hub_id_table[] = {
5221 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5222 | USB_DEVICE_ID_MATCH_INT_CLASS,
5223 .idVendor = USB_VENDOR_GENESYS_LOGIC,
5224 .bInterfaceClass = USB_CLASS_HUB,
5225 .driver_info = HUB_QUIRK_CHECK_PORT_AUTOSUSPEND},
5226 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
5227 .bDeviceClass = USB_CLASS_HUB},
5228 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
5229 .bInterfaceClass = USB_CLASS_HUB},
5230 { } /* Terminating entry */
5233 MODULE_DEVICE_TABLE(usb, hub_id_table);
5235 static struct usb_driver hub_driver = {
5238 .disconnect = hub_disconnect,
5239 .suspend = hub_suspend,
5240 .resume = hub_resume,
5241 .reset_resume = hub_reset_resume,
5242 .pre_reset = hub_pre_reset,
5243 .post_reset = hub_post_reset,
5244 .unlocked_ioctl = hub_ioctl,
5245 .id_table = hub_id_table,
5246 .supports_autosuspend = 1,
5249 int usb_hub_init(void)
5251 if (usb_register(&hub_driver) < 0) {
5252 printk(KERN_ERR "%s: can't register hub driver\n",
5258 * The workqueue needs to be freezable to avoid interfering with
5259 * USB-PERSIST port handover. Otherwise it might see that a full-speed
5260 * device was gone before the EHCI controller had handed its port
5261 * over to the companion full-speed controller.
5263 hub_wq = alloc_workqueue("usb_hub_wq", WQ_FREEZABLE, 0);
5267 /* Fall through if kernel_thread failed */
5268 usb_deregister(&hub_driver);
5269 pr_err("%s: can't allocate workqueue for usb hub\n", usbcore_name);
5274 void usb_hub_cleanup(void)
5276 destroy_workqueue(hub_wq);
5279 * Hub resources are freed for us by usb_deregister. It calls
5280 * usb_driver_purge on every device which in turn calls that
5281 * devices disconnect function if it is using this driver.
5282 * The hub_disconnect function takes care of releasing the
5283 * individual hub resources. -greg
5285 usb_deregister(&hub_driver);
5286 } /* usb_hub_cleanup() */
5288 static int descriptors_changed(struct usb_device *udev,
5289 struct usb_device_descriptor *old_device_descriptor,
5290 struct usb_host_bos *old_bos)
5294 unsigned serial_len = 0;
5296 unsigned old_length;
5300 if (memcmp(&udev->descriptor, old_device_descriptor,
5301 sizeof(*old_device_descriptor)) != 0)
5304 if ((old_bos && !udev->bos) || (!old_bos && udev->bos))
5307 len = le16_to_cpu(udev->bos->desc->wTotalLength);
5308 if (len != le16_to_cpu(old_bos->desc->wTotalLength))
5310 if (memcmp(udev->bos->desc, old_bos->desc, len))
5314 /* Since the idVendor, idProduct, and bcdDevice values in the
5315 * device descriptor haven't changed, we will assume the
5316 * Manufacturer and Product strings haven't changed either.
5317 * But the SerialNumber string could be different (e.g., a
5318 * different flash card of the same brand).
5321 serial_len = strlen(udev->serial) + 1;
5324 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5325 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5326 len = max(len, old_length);
5329 buf = kmalloc(len, GFP_NOIO);
5331 /* assume the worst */
5334 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5335 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5336 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
5338 if (length != old_length) {
5339 dev_dbg(&udev->dev, "config index %d, error %d\n",
5344 if (memcmp(buf, udev->rawdescriptors[index], old_length)
5346 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
5348 ((struct usb_config_descriptor *) buf)->
5349 bConfigurationValue);
5355 if (!changed && serial_len) {
5356 length = usb_string(udev, udev->descriptor.iSerialNumber,
5358 if (length + 1 != serial_len) {
5359 dev_dbg(&udev->dev, "serial string error %d\n",
5362 } else if (memcmp(buf, udev->serial, length) != 0) {
5363 dev_dbg(&udev->dev, "serial string changed\n");
5373 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5374 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5376 * WARNING - don't use this routine to reset a composite device
5377 * (one with multiple interfaces owned by separate drivers)!
5378 * Use usb_reset_device() instead.
5380 * Do a port reset, reassign the device's address, and establish its
5381 * former operating configuration. If the reset fails, or the device's
5382 * descriptors change from their values before the reset, or the original
5383 * configuration and altsettings cannot be restored, a flag will be set
5384 * telling hub_wq to pretend the device has been disconnected and then
5385 * re-connected. All drivers will be unbound, and the device will be
5386 * re-enumerated and probed all over again.
5388 * Return: 0 if the reset succeeded, -ENODEV if the device has been
5389 * flagged for logical disconnection, or some other negative error code
5390 * if the reset wasn't even attempted.
5393 * The caller must own the device lock and the port lock, the latter is
5394 * taken by usb_reset_device(). For example, it's safe to use
5395 * usb_reset_device() from a driver probe() routine after downloading
5396 * new firmware. For calls that might not occur during probe(), drivers
5397 * should lock the device using usb_lock_device_for_reset().
5399 * Locking exception: This routine may also be called from within an
5400 * autoresume handler. Such usage won't conflict with other tasks
5401 * holding the device lock because these tasks should always call
5402 * usb_autopm_resume_device(), thereby preventing any unwanted
5403 * autoresume. The autoresume handler is expected to have already
5404 * acquired the port lock before calling this routine.
5406 static int usb_reset_and_verify_device(struct usb_device *udev)
5408 struct usb_device *parent_hdev = udev->parent;
5409 struct usb_hub *parent_hub;
5410 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
5411 struct usb_device_descriptor descriptor = udev->descriptor;
5412 struct usb_host_bos *bos;
5414 int port1 = udev->portnum;
5416 if (udev->state == USB_STATE_NOTATTACHED ||
5417 udev->state == USB_STATE_SUSPENDED) {
5418 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5426 parent_hub = usb_hub_to_struct_hub(parent_hdev);
5428 /* Disable USB2 hardware LPM.
5429 * It will be re-enabled by the enumeration process.
5431 if (udev->usb2_hw_lpm_enabled == 1)
5432 usb_set_usb2_hardware_lpm(udev, 0);
5434 /* Disable LPM and LTM while we reset the device and reinstall the alt
5435 * settings. Device-initiated LPM settings, and system exit latency
5436 * settings are cleared when the device is reset, so we have to set
5439 ret = usb_unlocked_disable_lpm(udev);
5441 dev_err(&udev->dev, "%s Failed to disable LPM\n.", __func__);
5442 goto re_enumerate_no_bos;
5444 ret = usb_disable_ltm(udev);
5446 dev_err(&udev->dev, "%s Failed to disable LTM\n.",
5448 goto re_enumerate_no_bos;
5454 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
5456 /* ep0 maxpacket size may change; let the HCD know about it.
5457 * Other endpoints will be handled by re-enumeration. */
5458 usb_ep0_reinit(udev);
5459 ret = hub_port_init(parent_hub, udev, port1, i);
5460 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
5467 /* Device might have changed firmware (DFU or similar) */
5468 if (descriptors_changed(udev, &descriptor, bos)) {
5469 dev_info(&udev->dev, "device firmware changed\n");
5470 udev->descriptor = descriptor; /* for disconnect() calls */
5474 /* Restore the device's previous configuration */
5475 if (!udev->actconfig)
5478 mutex_lock(hcd->bandwidth_mutex);
5479 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
5481 dev_warn(&udev->dev,
5482 "Busted HC? Not enough HCD resources for "
5483 "old configuration.\n");
5484 mutex_unlock(hcd->bandwidth_mutex);
5487 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
5488 USB_REQ_SET_CONFIGURATION, 0,
5489 udev->actconfig->desc.bConfigurationValue, 0,
5490 NULL, 0, USB_CTRL_SET_TIMEOUT);
5493 "can't restore configuration #%d (error=%d)\n",
5494 udev->actconfig->desc.bConfigurationValue, ret);
5495 mutex_unlock(hcd->bandwidth_mutex);
5498 mutex_unlock(hcd->bandwidth_mutex);
5499 usb_set_device_state(udev, USB_STATE_CONFIGURED);
5501 /* Put interfaces back into the same altsettings as before.
5502 * Don't bother to send the Set-Interface request for interfaces
5503 * that were already in altsetting 0; besides being unnecessary,
5504 * many devices can't handle it. Instead just reset the host-side
5507 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
5508 struct usb_host_config *config = udev->actconfig;
5509 struct usb_interface *intf = config->interface[i];
5510 struct usb_interface_descriptor *desc;
5512 desc = &intf->cur_altsetting->desc;
5513 if (desc->bAlternateSetting == 0) {
5514 usb_disable_interface(udev, intf, true);
5515 usb_enable_interface(udev, intf, true);
5518 /* Let the bandwidth allocation function know that this
5519 * device has been reset, and it will have to use
5520 * alternate setting 0 as the current alternate setting.
5522 intf->resetting_device = 1;
5523 ret = usb_set_interface(udev, desc->bInterfaceNumber,
5524 desc->bAlternateSetting);
5525 intf->resetting_device = 0;
5528 dev_err(&udev->dev, "failed to restore interface %d "
5529 "altsetting %d (error=%d)\n",
5530 desc->bInterfaceNumber,
5531 desc->bAlternateSetting,
5535 /* Resetting also frees any allocated streams */
5536 for (j = 0; j < intf->cur_altsetting->desc.bNumEndpoints; j++)
5537 intf->cur_altsetting->endpoint[j].streams = 0;
5541 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5542 usb_set_usb2_hardware_lpm(udev, 1);
5543 usb_unlocked_enable_lpm(udev);
5544 usb_enable_ltm(udev);
5545 usb_release_bos_descriptor(udev);
5550 usb_release_bos_descriptor(udev);
5552 re_enumerate_no_bos:
5553 /* LPM state doesn't matter when we're about to destroy the device. */
5554 hub_port_logical_disconnect(parent_hub, port1);
5559 * usb_reset_device - warn interface drivers and perform a USB port reset
5560 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5562 * Warns all drivers bound to registered interfaces (using their pre_reset
5563 * method), performs the port reset, and then lets the drivers know that
5564 * the reset is over (using their post_reset method).
5566 * Return: The same as for usb_reset_and_verify_device().
5569 * The caller must own the device lock. For example, it's safe to use
5570 * this from a driver probe() routine after downloading new firmware.
5571 * For calls that might not occur during probe(), drivers should lock
5572 * the device using usb_lock_device_for_reset().
5574 * If an interface is currently being probed or disconnected, we assume
5575 * its driver knows how to handle resets. For all other interfaces,
5576 * if the driver doesn't have pre_reset and post_reset methods then
5577 * we attempt to unbind it and rebind afterward.
5579 int usb_reset_device(struct usb_device *udev)
5583 unsigned int noio_flag;
5584 struct usb_port *port_dev;
5585 struct usb_host_config *config = udev->actconfig;
5586 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
5588 if (udev->state == USB_STATE_NOTATTACHED ||
5589 udev->state == USB_STATE_SUSPENDED) {
5590 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5595 if (!udev->parent) {
5596 /* this requires hcd-specific logic; see ohci_restart() */
5597 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
5601 port_dev = hub->ports[udev->portnum - 1];
5604 * Don't allocate memory with GFP_KERNEL in current
5605 * context to avoid possible deadlock if usb mass
5606 * storage interface or usbnet interface(iSCSI case)
5607 * is included in current configuration. The easist
5608 * approach is to do it for every device reset,
5609 * because the device 'memalloc_noio' flag may have
5610 * not been set before reseting the usb device.
5612 noio_flag = memalloc_noio_save();
5614 /* Prevent autosuspend during the reset */
5615 usb_autoresume_device(udev);
5618 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
5619 struct usb_interface *cintf = config->interface[i];
5620 struct usb_driver *drv;
5623 if (cintf->dev.driver) {
5624 drv = to_usb_driver(cintf->dev.driver);
5625 if (drv->pre_reset && drv->post_reset)
5626 unbind = (drv->pre_reset)(cintf);
5627 else if (cintf->condition ==
5628 USB_INTERFACE_BOUND)
5631 usb_forced_unbind_intf(cintf);
5636 usb_lock_port(port_dev);
5637 ret = usb_reset_and_verify_device(udev);
5638 usb_unlock_port(port_dev);
5641 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
5642 struct usb_interface *cintf = config->interface[i];
5643 struct usb_driver *drv;
5644 int rebind = cintf->needs_binding;
5646 if (!rebind && cintf->dev.driver) {
5647 drv = to_usb_driver(cintf->dev.driver);
5648 if (drv->post_reset)
5649 rebind = (drv->post_reset)(cintf);
5650 else if (cintf->condition ==
5651 USB_INTERFACE_BOUND)
5654 cintf->needs_binding = 1;
5657 usb_unbind_and_rebind_marked_interfaces(udev);
5660 usb_autosuspend_device(udev);
5661 memalloc_noio_restore(noio_flag);
5664 EXPORT_SYMBOL_GPL(usb_reset_device);
5668 * usb_queue_reset_device - Reset a USB device from an atomic context
5669 * @iface: USB interface belonging to the device to reset
5671 * This function can be used to reset a USB device from an atomic
5672 * context, where usb_reset_device() won't work (as it blocks).
5674 * Doing a reset via this method is functionally equivalent to calling
5675 * usb_reset_device(), except for the fact that it is delayed to a
5676 * workqueue. This means that any drivers bound to other interfaces
5677 * might be unbound, as well as users from usbfs in user space.
5681 * - Scheduling two resets at the same time from two different drivers
5682 * attached to two different interfaces of the same device is
5683 * possible; depending on how the driver attached to each interface
5684 * handles ->pre_reset(), the second reset might happen or not.
5686 * - If the reset is delayed so long that the interface is unbound from
5687 * its driver, the reset will be skipped.
5689 * - This function can be called during .probe(). It can also be called
5690 * during .disconnect(), but doing so is pointless because the reset
5691 * will not occur. If you really want to reset the device during
5692 * .disconnect(), call usb_reset_device() directly -- but watch out
5693 * for nested unbinding issues!
5695 void usb_queue_reset_device(struct usb_interface *iface)
5697 if (schedule_work(&iface->reset_ws))
5698 usb_get_intf(iface);
5700 EXPORT_SYMBOL_GPL(usb_queue_reset_device);
5703 * usb_hub_find_child - Get the pointer of child device
5704 * attached to the port which is specified by @port1.
5705 * @hdev: USB device belonging to the usb hub
5706 * @port1: port num to indicate which port the child device
5709 * USB drivers call this function to get hub's child device
5712 * Return: %NULL if input param is invalid and
5713 * child's usb_device pointer if non-NULL.
5715 struct usb_device *usb_hub_find_child(struct usb_device *hdev,
5718 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5720 if (port1 < 1 || port1 > hdev->maxchild)
5722 return hub->ports[port1 - 1]->child;
5724 EXPORT_SYMBOL_GPL(usb_hub_find_child);
5726 void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
5727 struct usb_hub_descriptor *desc)
5729 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5730 enum usb_port_connect_type connect_type;
5736 if (!hub_is_superspeed(hdev)) {
5737 for (i = 1; i <= hdev->maxchild; i++) {
5738 struct usb_port *port_dev = hub->ports[i - 1];
5740 connect_type = port_dev->connect_type;
5741 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5742 u8 mask = 1 << (i%8);
5744 if (!(desc->u.hs.DeviceRemovable[i/8] & mask)) {
5745 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
5746 desc->u.hs.DeviceRemovable[i/8] |= mask;
5751 u16 port_removable = le16_to_cpu(desc->u.ss.DeviceRemovable);
5753 for (i = 1; i <= hdev->maxchild; i++) {
5754 struct usb_port *port_dev = hub->ports[i - 1];
5756 connect_type = port_dev->connect_type;
5757 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5760 if (!(port_removable & mask)) {
5761 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
5762 port_removable |= mask;
5767 desc->u.ss.DeviceRemovable = cpu_to_le16(port_removable);
5773 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5774 * @hdev: USB device belonging to the usb hub
5775 * @port1: port num of the port
5777 * Return: Port's acpi handle if successful, %NULL if params are
5780 acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
5783 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5788 return ACPI_HANDLE(&hub->ports[port1 - 1]->dev);