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 USB_VENDOR_SMSC 0x0424
40 #define USB_PRODUCT_USB5534B 0x5534
41 #define USB_VENDOR_CYPRESS 0x04b4
42 #define USB_PRODUCT_CY7C65632 0x6570
43 #define USB_VENDOR_TEXAS_INSTRUMENTS 0x0451
44 #define USB_PRODUCT_TUSB8041_USB3 0x8140
45 #define USB_PRODUCT_TUSB8041_USB2 0x8142
46 #define HUB_QUIRK_CHECK_PORT_AUTOSUSPEND 0x01
47 #define HUB_QUIRK_DISABLE_AUTOSUSPEND 0x02
49 /* Protect struct usb_device->state and ->children members
50 * Note: Both are also protected by ->dev.sem, except that ->state can
51 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
52 static DEFINE_SPINLOCK(device_state_lock);
54 /* workqueue to process hub events */
55 static struct workqueue_struct *hub_wq;
56 static void hub_event(struct work_struct *work);
58 /* synchronize hub-port add/remove and peering operations */
59 DEFINE_MUTEX(usb_port_peer_mutex);
61 /* cycle leds on hubs that aren't blinking for attention */
62 static bool blinkenlights;
63 module_param(blinkenlights, bool, S_IRUGO);
64 MODULE_PARM_DESC(blinkenlights, "true to cycle leds on hubs");
67 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
68 * 10 seconds to send reply for the initial 64-byte descriptor request.
70 /* define initial 64-byte descriptor request timeout in milliseconds */
71 static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
72 module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
73 MODULE_PARM_DESC(initial_descriptor_timeout,
74 "initial 64-byte descriptor request timeout in milliseconds "
75 "(default 5000 - 5.0 seconds)");
78 * As of 2.6.10 we introduce a new USB device initialization scheme which
79 * closely resembles the way Windows works. Hopefully it will be compatible
80 * with a wider range of devices than the old scheme. However some previously
81 * working devices may start giving rise to "device not accepting address"
82 * errors; if that happens the user can try the old scheme by adjusting the
83 * following module parameters.
85 * For maximum flexibility there are two boolean parameters to control the
86 * hub driver's behavior. On the first initialization attempt, if the
87 * "old_scheme_first" parameter is set then the old scheme will be used,
88 * otherwise the new scheme is used. If that fails and "use_both_schemes"
89 * is set, then the driver will make another attempt, using the other scheme.
91 static bool old_scheme_first;
92 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
93 MODULE_PARM_DESC(old_scheme_first,
94 "start with the old device initialization scheme");
96 static bool use_both_schemes = 1;
97 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
98 MODULE_PARM_DESC(use_both_schemes,
99 "try the other device initialization scheme if the "
102 /* Mutual exclusion for EHCI CF initialization. This interferes with
103 * port reset on some companion controllers.
105 DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
106 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
108 #define HUB_DEBOUNCE_TIMEOUT 2000
109 #define HUB_DEBOUNCE_STEP 25
110 #define HUB_DEBOUNCE_STABLE 100
112 static void hub_release(struct kref *kref);
113 static int usb_reset_and_verify_device(struct usb_device *udev);
114 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state);
115 static bool hub_port_warm_reset_required(struct usb_hub *hub, int port1,
118 static inline char *portspeed(struct usb_hub *hub, int portstatus)
120 if (hub_is_superspeedplus(hub->hdev))
122 if (hub_is_superspeed(hub->hdev))
124 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
126 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
132 /* Note that hdev or one of its children must be locked! */
133 struct usb_hub *usb_hub_to_struct_hub(struct usb_device *hdev)
135 if (!hdev || !hdev->actconfig || !hdev->maxchild)
137 return usb_get_intfdata(hdev->actconfig->interface[0]);
140 int usb_device_supports_lpm(struct usb_device *udev)
142 /* Some devices have trouble with LPM */
143 if (udev->quirks & USB_QUIRK_NO_LPM)
146 /* Skip if the device BOS descriptor couldn't be read */
150 /* USB 2.1 (and greater) devices indicate LPM support through
151 * their USB 2.0 Extended Capabilities BOS descriptor.
153 if (udev->speed == USB_SPEED_HIGH || udev->speed == USB_SPEED_FULL) {
154 if (udev->bos->ext_cap &&
156 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
162 * According to the USB 3.0 spec, all USB 3.0 devices must support LPM.
163 * However, there are some that don't, and they set the U1/U2 exit
166 if (!udev->bos->ss_cap) {
167 dev_info(&udev->dev, "No LPM exit latency info found, disabling LPM.\n");
171 if (udev->bos->ss_cap->bU1devExitLat == 0 &&
172 udev->bos->ss_cap->bU2DevExitLat == 0) {
174 dev_info(&udev->dev, "LPM exit latency is zeroed, disabling LPM.\n");
176 dev_info(&udev->dev, "We don't know the algorithms for LPM for this host, disabling LPM.\n");
180 if (!udev->parent || udev->parent->lpm_capable)
186 * Set the Maximum Exit Latency (MEL) for the host to initiate a transition from
189 static void usb_set_lpm_mel(struct usb_device *udev,
190 struct usb3_lpm_parameters *udev_lpm_params,
191 unsigned int udev_exit_latency,
193 struct usb3_lpm_parameters *hub_lpm_params,
194 unsigned int hub_exit_latency)
196 unsigned int total_mel;
197 unsigned int device_mel;
198 unsigned int hub_mel;
201 * Calculate the time it takes to transition all links from the roothub
202 * to the parent hub into U0. The parent hub must then decode the
203 * packet (hub header decode latency) to figure out which port it was
206 * The Hub Header decode latency is expressed in 0.1us intervals (0x1
207 * means 0.1us). Multiply that by 100 to get nanoseconds.
209 total_mel = hub_lpm_params->mel +
210 (hub->descriptor->u.ss.bHubHdrDecLat * 100);
213 * How long will it take to transition the downstream hub's port into
214 * U0? The greater of either the hub exit latency or the device exit
217 * The BOS U1/U2 exit latencies are expressed in 1us intervals.
218 * Multiply that by 1000 to get nanoseconds.
220 device_mel = udev_exit_latency * 1000;
221 hub_mel = hub_exit_latency * 1000;
222 if (device_mel > hub_mel)
223 total_mel += device_mel;
225 total_mel += hub_mel;
227 udev_lpm_params->mel = total_mel;
231 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
232 * a transition from either U1 or U2.
234 static void usb_set_lpm_pel(struct usb_device *udev,
235 struct usb3_lpm_parameters *udev_lpm_params,
236 unsigned int udev_exit_latency,
238 struct usb3_lpm_parameters *hub_lpm_params,
239 unsigned int hub_exit_latency,
240 unsigned int port_to_port_exit_latency)
242 unsigned int first_link_pel;
243 unsigned int hub_pel;
246 * First, the device sends an LFPS to transition the link between the
247 * device and the parent hub into U0. The exit latency is the bigger of
248 * the device exit latency or the hub exit latency.
250 if (udev_exit_latency > hub_exit_latency)
251 first_link_pel = udev_exit_latency * 1000;
253 first_link_pel = hub_exit_latency * 1000;
256 * When the hub starts to receive the LFPS, there is a slight delay for
257 * it to figure out that one of the ports is sending an LFPS. Then it
258 * will forward the LFPS to its upstream link. The exit latency is the
259 * delay, plus the PEL that we calculated for this hub.
261 hub_pel = port_to_port_exit_latency * 1000 + hub_lpm_params->pel;
264 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
265 * is the greater of the two exit latencies.
267 if (first_link_pel > hub_pel)
268 udev_lpm_params->pel = first_link_pel;
270 udev_lpm_params->pel = hub_pel;
274 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
275 * when a device initiates a transition to U0, until when it will receive the
276 * first packet from the host controller.
278 * Section C.1.5.1 describes the four components to this:
280 * - t2: time for the ERDY to make it from the device to the host.
281 * - t3: a host-specific delay to process the ERDY.
282 * - t4: time for the packet to make it from the host to the device.
284 * t3 is specific to both the xHCI host and the platform the host is integrated
285 * into. The Intel HW folks have said it's negligible, FIXME if a different
286 * vendor says otherwise.
288 static void usb_set_lpm_sel(struct usb_device *udev,
289 struct usb3_lpm_parameters *udev_lpm_params)
291 struct usb_device *parent;
292 unsigned int num_hubs;
293 unsigned int total_sel;
295 /* t1 = device PEL */
296 total_sel = udev_lpm_params->pel;
297 /* How many external hubs are in between the device & the root port. */
298 for (parent = udev->parent, num_hubs = 0; parent->parent;
299 parent = parent->parent)
301 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
303 total_sel += 2100 + 250 * (num_hubs - 1);
305 /* t4 = 250ns * num_hubs */
306 total_sel += 250 * num_hubs;
308 udev_lpm_params->sel = total_sel;
311 static void usb_set_lpm_parameters(struct usb_device *udev)
314 unsigned int port_to_port_delay;
315 unsigned int udev_u1_del;
316 unsigned int udev_u2_del;
317 unsigned int hub_u1_del;
318 unsigned int hub_u2_del;
320 if (!udev->lpm_capable || udev->speed < USB_SPEED_SUPER)
323 /* Skip if the device BOS descriptor couldn't be read */
327 hub = usb_hub_to_struct_hub(udev->parent);
328 /* It doesn't take time to transition the roothub into U0, since it
329 * doesn't have an upstream link.
334 udev_u1_del = udev->bos->ss_cap->bU1devExitLat;
335 udev_u2_del = le16_to_cpu(udev->bos->ss_cap->bU2DevExitLat);
336 hub_u1_del = udev->parent->bos->ss_cap->bU1devExitLat;
337 hub_u2_del = le16_to_cpu(udev->parent->bos->ss_cap->bU2DevExitLat);
339 usb_set_lpm_mel(udev, &udev->u1_params, udev_u1_del,
340 hub, &udev->parent->u1_params, hub_u1_del);
342 usb_set_lpm_mel(udev, &udev->u2_params, udev_u2_del,
343 hub, &udev->parent->u2_params, hub_u2_del);
346 * Appendix C, section C.2.2.2, says that there is a slight delay from
347 * when the parent hub notices the downstream port is trying to
348 * transition to U0 to when the hub initiates a U0 transition on its
349 * upstream port. The section says the delays are tPort2PortU1EL and
350 * tPort2PortU2EL, but it doesn't define what they are.
352 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
353 * about the same delays. Use the maximum delay calculations from those
354 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
355 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
356 * assume the device exit latencies they are talking about are the hub
359 * What do we do if the U2 exit latency is less than the U1 exit
360 * latency? It's possible, although not likely...
362 port_to_port_delay = 1;
364 usb_set_lpm_pel(udev, &udev->u1_params, udev_u1_del,
365 hub, &udev->parent->u1_params, hub_u1_del,
368 if (hub_u2_del > hub_u1_del)
369 port_to_port_delay = 1 + hub_u2_del - hub_u1_del;
371 port_to_port_delay = 1 + hub_u1_del;
373 usb_set_lpm_pel(udev, &udev->u2_params, udev_u2_del,
374 hub, &udev->parent->u2_params, hub_u2_del,
377 /* Now that we've got PEL, calculate SEL. */
378 usb_set_lpm_sel(udev, &udev->u1_params);
379 usb_set_lpm_sel(udev, &udev->u2_params);
382 /* USB 2.0 spec Section 11.24.4.5 */
383 static int get_hub_descriptor(struct usb_device *hdev,
384 struct usb_hub_descriptor *desc)
389 if (hub_is_superspeed(hdev)) {
390 dtype = USB_DT_SS_HUB;
391 size = USB_DT_SS_HUB_SIZE;
394 size = sizeof(struct usb_hub_descriptor);
397 for (i = 0; i < 3; i++) {
398 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
399 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
400 dtype << 8, 0, desc, size,
401 USB_CTRL_GET_TIMEOUT);
402 if (hub_is_superspeed(hdev)) {
405 } else if (ret >= USB_DT_HUB_NONVAR_SIZE + 2) {
406 /* Make sure we have the DeviceRemovable field. */
407 size = USB_DT_HUB_NONVAR_SIZE + desc->bNbrPorts / 8 + 1;
417 * USB 2.0 spec Section 11.24.2.1
419 static int clear_hub_feature(struct usb_device *hdev, int feature)
421 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
422 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
426 * USB 2.0 spec Section 11.24.2.2
428 int usb_clear_port_feature(struct usb_device *hdev, int port1, int feature)
430 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
431 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
436 * USB 2.0 spec Section 11.24.2.13
438 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
440 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
441 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
445 static char *to_led_name(int selector)
462 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
463 * for info about using port indicators
465 static void set_port_led(struct usb_hub *hub, int port1, int selector)
467 struct usb_port *port_dev = hub->ports[port1 - 1];
470 status = set_port_feature(hub->hdev, (selector << 8) | port1,
471 USB_PORT_FEAT_INDICATOR);
472 dev_dbg(&port_dev->dev, "indicator %s status %d\n",
473 to_led_name(selector), status);
476 #define LED_CYCLE_PERIOD ((2*HZ)/3)
478 static void led_work(struct work_struct *work)
480 struct usb_hub *hub =
481 container_of(work, struct usb_hub, leds.work);
482 struct usb_device *hdev = hub->hdev;
484 unsigned changed = 0;
487 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
490 for (i = 0; i < hdev->maxchild; i++) {
491 unsigned selector, mode;
493 /* 30%-50% duty cycle */
495 switch (hub->indicator[i]) {
497 case INDICATOR_CYCLE:
499 selector = HUB_LED_AUTO;
500 mode = INDICATOR_AUTO;
502 /* blinking green = sw attention */
503 case INDICATOR_GREEN_BLINK:
504 selector = HUB_LED_GREEN;
505 mode = INDICATOR_GREEN_BLINK_OFF;
507 case INDICATOR_GREEN_BLINK_OFF:
508 selector = HUB_LED_OFF;
509 mode = INDICATOR_GREEN_BLINK;
511 /* blinking amber = hw attention */
512 case INDICATOR_AMBER_BLINK:
513 selector = HUB_LED_AMBER;
514 mode = INDICATOR_AMBER_BLINK_OFF;
516 case INDICATOR_AMBER_BLINK_OFF:
517 selector = HUB_LED_OFF;
518 mode = INDICATOR_AMBER_BLINK;
520 /* blink green/amber = reserved */
521 case INDICATOR_ALT_BLINK:
522 selector = HUB_LED_GREEN;
523 mode = INDICATOR_ALT_BLINK_OFF;
525 case INDICATOR_ALT_BLINK_OFF:
526 selector = HUB_LED_AMBER;
527 mode = INDICATOR_ALT_BLINK;
532 if (selector != HUB_LED_AUTO)
534 set_port_led(hub, i + 1, selector);
535 hub->indicator[i] = mode;
537 if (!changed && blinkenlights) {
539 cursor %= hdev->maxchild;
540 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
541 hub->indicator[cursor] = INDICATOR_CYCLE;
545 queue_delayed_work(system_power_efficient_wq,
546 &hub->leds, LED_CYCLE_PERIOD);
549 /* use a short timeout for hub/port status fetches */
550 #define USB_STS_TIMEOUT 1000
551 #define USB_STS_RETRIES 5
554 * USB 2.0 spec Section 11.24.2.6
556 static int get_hub_status(struct usb_device *hdev,
557 struct usb_hub_status *data)
559 int i, status = -ETIMEDOUT;
561 for (i = 0; i < USB_STS_RETRIES &&
562 (status == -ETIMEDOUT || status == -EPIPE); i++) {
563 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
564 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
565 data, sizeof(*data), USB_STS_TIMEOUT);
571 * USB 2.0 spec Section 11.24.2.7
572 * USB 3.1 takes into use the wValue and wLength fields, spec Section 10.16.2.6
574 static int get_port_status(struct usb_device *hdev, int port1,
575 void *data, u16 value, u16 length)
577 int i, status = -ETIMEDOUT;
579 for (i = 0; i < USB_STS_RETRIES &&
580 (status == -ETIMEDOUT || status == -EPIPE); i++) {
581 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
582 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, value,
583 port1, data, length, USB_STS_TIMEOUT);
588 static int hub_ext_port_status(struct usb_hub *hub, int port1, int type,
589 u16 *status, u16 *change, u32 *ext_status)
594 if (type != HUB_PORT_STATUS)
597 mutex_lock(&hub->status_mutex);
598 ret = get_port_status(hub->hdev, port1, &hub->status->port, type, len);
601 dev_err(hub->intfdev,
602 "%s failed (err = %d)\n", __func__, ret);
606 *status = le16_to_cpu(hub->status->port.wPortStatus);
607 *change = le16_to_cpu(hub->status->port.wPortChange);
608 if (type != HUB_PORT_STATUS && ext_status)
609 *ext_status = le32_to_cpu(
610 hub->status->port.dwExtPortStatus);
613 mutex_unlock(&hub->status_mutex);
617 static int hub_port_status(struct usb_hub *hub, int port1,
618 u16 *status, u16 *change)
620 return hub_ext_port_status(hub, port1, HUB_PORT_STATUS,
621 status, change, NULL);
624 static void kick_hub_wq(struct usb_hub *hub)
626 struct usb_interface *intf;
628 if (hub->disconnected || work_pending(&hub->events))
632 * Suppress autosuspend until the event is proceed.
634 * Be careful and make sure that the symmetric operation is
635 * always called. We are here only when there is no pending
636 * work for this hub. Therefore put the interface either when
637 * the new work is called or when it is canceled.
639 intf = to_usb_interface(hub->intfdev);
640 usb_autopm_get_interface_no_resume(intf);
641 kref_get(&hub->kref);
643 if (queue_work(hub_wq, &hub->events))
646 /* the work has already been scheduled */
647 usb_autopm_put_interface_async(intf);
648 kref_put(&hub->kref, hub_release);
651 void usb_kick_hub_wq(struct usb_device *hdev)
653 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
660 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
661 * Notification, which indicates it had initiated remote wakeup.
663 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
664 * device initiates resume, so the USB core will not receive notice of the
665 * resume through the normal hub interrupt URB.
667 void usb_wakeup_notification(struct usb_device *hdev,
668 unsigned int portnum)
671 struct usb_port *port_dev;
676 hub = usb_hub_to_struct_hub(hdev);
678 port_dev = hub->ports[portnum - 1];
679 if (port_dev && port_dev->child)
680 pm_wakeup_event(&port_dev->child->dev, 0);
682 set_bit(portnum, hub->wakeup_bits);
686 EXPORT_SYMBOL_GPL(usb_wakeup_notification);
688 /* completion function, fires on port status changes and various faults */
689 static void hub_irq(struct urb *urb)
691 struct usb_hub *hub = urb->context;
692 int status = urb->status;
697 case -ENOENT: /* synchronous unlink */
698 case -ECONNRESET: /* async unlink */
699 case -ESHUTDOWN: /* hardware going away */
702 default: /* presumably an error */
703 /* Cause a hub reset after 10 consecutive errors */
704 dev_dbg(hub->intfdev, "transfer --> %d\n", status);
705 if ((++hub->nerrors < 10) || hub->error)
710 /* let hub_wq handle things */
711 case 0: /* we got data: port status changed */
713 for (i = 0; i < urb->actual_length; ++i)
714 bits |= ((unsigned long) ((*hub->buffer)[i]))
716 hub->event_bits[0] = bits;
722 /* Something happened, let hub_wq figure it out */
729 status = usb_submit_urb(hub->urb, GFP_ATOMIC);
730 if (status != 0 && status != -ENODEV && status != -EPERM)
731 dev_err(hub->intfdev, "resubmit --> %d\n", status);
734 /* USB 2.0 spec Section 11.24.2.3 */
736 hub_clear_tt_buffer(struct usb_device *hdev, u16 devinfo, u16 tt)
738 /* Need to clear both directions for control ep */
739 if (((devinfo >> 11) & USB_ENDPOINT_XFERTYPE_MASK) ==
740 USB_ENDPOINT_XFER_CONTROL) {
741 int status = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
742 HUB_CLEAR_TT_BUFFER, USB_RT_PORT,
743 devinfo ^ 0x8000, tt, NULL, 0, 1000);
747 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
748 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
753 * enumeration blocks hub_wq for a long time. we use keventd instead, since
754 * long blocking there is the exception, not the rule. accordingly, HCDs
755 * talking to TTs must queue control transfers (not just bulk and iso), so
756 * both can talk to the same hub concurrently.
758 static void hub_tt_work(struct work_struct *work)
760 struct usb_hub *hub =
761 container_of(work, struct usb_hub, tt.clear_work);
764 spin_lock_irqsave(&hub->tt.lock, flags);
765 while (!list_empty(&hub->tt.clear_list)) {
766 struct list_head *next;
767 struct usb_tt_clear *clear;
768 struct usb_device *hdev = hub->hdev;
769 const struct hc_driver *drv;
772 next = hub->tt.clear_list.next;
773 clear = list_entry(next, struct usb_tt_clear, clear_list);
774 list_del(&clear->clear_list);
776 /* drop lock so HCD can concurrently report other TT errors */
777 spin_unlock_irqrestore(&hub->tt.lock, flags);
778 status = hub_clear_tt_buffer(hdev, clear->devinfo, clear->tt);
779 if (status && status != -ENODEV)
781 "clear tt %d (%04x) error %d\n",
782 clear->tt, clear->devinfo, status);
784 /* Tell the HCD, even if the operation failed */
785 drv = clear->hcd->driver;
786 if (drv->clear_tt_buffer_complete)
787 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
790 spin_lock_irqsave(&hub->tt.lock, flags);
792 spin_unlock_irqrestore(&hub->tt.lock, flags);
796 * usb_hub_set_port_power - control hub port's power state
797 * @hdev: USB device belonging to the usb hub
800 * @set: expected status
802 * call this function to control port's power via setting or
803 * clearing the port's PORT_POWER feature.
805 * Return: 0 if successful. A negative error code otherwise.
807 int usb_hub_set_port_power(struct usb_device *hdev, struct usb_hub *hub,
813 ret = set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
815 ret = usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
821 set_bit(port1, hub->power_bits);
823 clear_bit(port1, hub->power_bits);
828 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
829 * @urb: an URB associated with the failed or incomplete split transaction
831 * High speed HCDs use this to tell the hub driver that some split control or
832 * bulk transaction failed in a way that requires clearing internal state of
833 * a transaction translator. This is normally detected (and reported) from
836 * It may not be possible for that hub to handle additional full (or low)
837 * speed transactions until that state is fully cleared out.
839 * Return: 0 if successful. A negative error code otherwise.
841 int usb_hub_clear_tt_buffer(struct urb *urb)
843 struct usb_device *udev = urb->dev;
844 int pipe = urb->pipe;
845 struct usb_tt *tt = udev->tt;
847 struct usb_tt_clear *clear;
849 /* we've got to cope with an arbitrary number of pending TT clears,
850 * since each TT has "at least two" buffers that can need it (and
851 * there can be many TTs per hub). even if they're uncommon.
853 clear = kmalloc(sizeof *clear, GFP_ATOMIC);
855 dev_err(&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
856 /* FIXME recover somehow ... RESET_TT? */
860 /* info that CLEAR_TT_BUFFER needs */
861 clear->tt = tt->multi ? udev->ttport : 1;
862 clear->devinfo = usb_pipeendpoint (pipe);
863 clear->devinfo |= udev->devnum << 4;
864 clear->devinfo |= usb_pipecontrol(pipe)
865 ? (USB_ENDPOINT_XFER_CONTROL << 11)
866 : (USB_ENDPOINT_XFER_BULK << 11);
867 if (usb_pipein(pipe))
868 clear->devinfo |= 1 << 15;
870 /* info for completion callback */
871 clear->hcd = bus_to_hcd(udev->bus);
874 /* tell keventd to clear state for this TT */
875 spin_lock_irqsave(&tt->lock, flags);
876 list_add_tail(&clear->clear_list, &tt->clear_list);
877 schedule_work(&tt->clear_work);
878 spin_unlock_irqrestore(&tt->lock, flags);
881 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
883 static void hub_power_on(struct usb_hub *hub, bool do_delay)
887 /* Enable power on each port. Some hubs have reserved values
888 * of LPSM (> 2) in their descriptors, even though they are
889 * USB 2.0 hubs. Some hubs do not implement port-power switching
890 * but only emulate it. In all cases, the ports won't work
891 * unless we send these messages to the hub.
893 if (hub_is_port_power_switchable(hub))
894 dev_dbg(hub->intfdev, "enabling power on all ports\n");
896 dev_dbg(hub->intfdev, "trying to enable port power on "
897 "non-switchable hub\n");
898 for (port1 = 1; port1 <= hub->hdev->maxchild; port1++)
899 if (test_bit(port1, hub->power_bits))
900 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
902 usb_clear_port_feature(hub->hdev, port1,
903 USB_PORT_FEAT_POWER);
905 msleep(hub_power_on_good_delay(hub));
908 static int hub_hub_status(struct usb_hub *hub,
909 u16 *status, u16 *change)
913 mutex_lock(&hub->status_mutex);
914 ret = get_hub_status(hub->hdev, &hub->status->hub);
917 dev_err(hub->intfdev,
918 "%s failed (err = %d)\n", __func__, ret);
920 *status = le16_to_cpu(hub->status->hub.wHubStatus);
921 *change = le16_to_cpu(hub->status->hub.wHubChange);
924 mutex_unlock(&hub->status_mutex);
928 static int hub_set_port_link_state(struct usb_hub *hub, int port1,
929 unsigned int link_status)
931 return set_port_feature(hub->hdev,
932 port1 | (link_status << 3),
933 USB_PORT_FEAT_LINK_STATE);
937 * Disable a port and mark a logical connect-change event, so that some
938 * time later hub_wq will disconnect() any existing usb_device on the port
939 * and will re-enumerate if there actually is a device attached.
941 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
943 dev_dbg(&hub->ports[port1 - 1]->dev, "logical disconnect\n");
944 hub_port_disable(hub, port1, 1);
946 /* FIXME let caller ask to power down the port:
947 * - some devices won't enumerate without a VBUS power cycle
948 * - SRP saves power that way
949 * - ... new call, TBD ...
950 * That's easy if this hub can switch power per-port, and
951 * hub_wq reactivates the port later (timer, SRP, etc).
952 * Powerdown must be optional, because of reset/DFU.
955 set_bit(port1, hub->change_bits);
960 * usb_remove_device - disable a device's port on its parent hub
961 * @udev: device to be disabled and removed
962 * Context: @udev locked, must be able to sleep.
964 * After @udev's port has been disabled, hub_wq is notified and it will
965 * see that the device has been disconnected. When the device is
966 * physically unplugged and something is plugged in, the events will
967 * be received and processed normally.
969 * Return: 0 if successful. A negative error code otherwise.
971 int usb_remove_device(struct usb_device *udev)
974 struct usb_interface *intf;
977 if (!udev->parent) /* Can't remove a root hub */
979 hub = usb_hub_to_struct_hub(udev->parent);
980 intf = to_usb_interface(hub->intfdev);
982 ret = usb_autopm_get_interface(intf);
986 set_bit(udev->portnum, hub->removed_bits);
987 hub_port_logical_disconnect(hub, udev->portnum);
988 usb_autopm_put_interface(intf);
992 enum hub_activation_type {
993 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
994 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
997 static void hub_init_func2(struct work_struct *ws);
998 static void hub_init_func3(struct work_struct *ws);
1000 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
1002 struct usb_device *hdev = hub->hdev;
1003 struct usb_hcd *hcd;
1007 bool need_debounce_delay = false;
1010 /* Continue a partial initialization */
1011 if (type == HUB_INIT2 || type == HUB_INIT3) {
1012 device_lock(&hdev->dev);
1014 /* Was the hub disconnected while we were waiting? */
1015 if (hub->disconnected)
1017 if (type == HUB_INIT2)
1021 kref_get(&hub->kref);
1023 /* The superspeed hub except for root hub has to use Hub Depth
1024 * value as an offset into the route string to locate the bits
1025 * it uses to determine the downstream port number. So hub driver
1026 * should send a set hub depth request to superspeed hub after
1027 * the superspeed hub is set configuration in initialization or
1030 * After a resume, port power should still be on.
1031 * For any other type of activation, turn it on.
1033 if (type != HUB_RESUME) {
1034 if (hdev->parent && hub_is_superspeed(hdev)) {
1035 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
1036 HUB_SET_DEPTH, USB_RT_HUB,
1037 hdev->level - 1, 0, NULL, 0,
1038 USB_CTRL_SET_TIMEOUT);
1040 dev_err(hub->intfdev,
1041 "set hub depth failed\n");
1044 /* Speed up system boot by using a delayed_work for the
1045 * hub's initial power-up delays. This is pretty awkward
1046 * and the implementation looks like a home-brewed sort of
1047 * setjmp/longjmp, but it saves at least 100 ms for each
1048 * root hub (assuming usbcore is compiled into the kernel
1049 * rather than as a module). It adds up.
1051 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1052 * because for those activation types the ports have to be
1053 * operational when we return. In theory this could be done
1054 * for HUB_POST_RESET, but it's easier not to.
1056 if (type == HUB_INIT) {
1057 delay = hub_power_on_good_delay(hub);
1059 hub_power_on(hub, false);
1060 INIT_DELAYED_WORK(&hub->init_work, hub_init_func2);
1061 queue_delayed_work(system_power_efficient_wq,
1063 msecs_to_jiffies(delay));
1065 /* Suppress autosuspend until init is done */
1066 usb_autopm_get_interface_no_resume(
1067 to_usb_interface(hub->intfdev));
1068 return; /* Continues at init2: below */
1069 } else if (type == HUB_RESET_RESUME) {
1070 /* The internal host controller state for the hub device
1071 * may be gone after a host power loss on system resume.
1072 * Update the device's info so the HW knows it's a hub.
1074 hcd = bus_to_hcd(hdev->bus);
1075 if (hcd->driver->update_hub_device) {
1076 ret = hcd->driver->update_hub_device(hcd, hdev,
1077 &hub->tt, GFP_NOIO);
1079 dev_err(hub->intfdev, "Host not "
1080 "accepting hub info "
1082 dev_err(hub->intfdev, "LS/FS devices "
1083 "and hubs may not work "
1084 "under this hub\n.");
1087 hub_power_on(hub, true);
1089 hub_power_on(hub, true);
1091 /* Give some time on remote wakeup to let links to transit to U0 */
1092 } else if (hub_is_superspeed(hub->hdev))
1098 * Check each port and set hub->change_bits to let hub_wq know
1099 * which ports need attention.
1101 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
1102 struct usb_port *port_dev = hub->ports[port1 - 1];
1103 struct usb_device *udev = port_dev->child;
1104 u16 portstatus, portchange;
1106 portstatus = portchange = 0;
1107 status = hub_port_status(hub, port1, &portstatus, &portchange);
1111 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1112 dev_dbg(&port_dev->dev, "status %04x change %04x\n",
1113 portstatus, portchange);
1116 * After anything other than HUB_RESUME (i.e., initialization
1117 * or any sort of reset), every port should be disabled.
1118 * Unconnected ports should likewise be disabled (paranoia),
1119 * and so should ports for which we have no usb_device.
1121 if ((portstatus & USB_PORT_STAT_ENABLE) && (
1122 type != HUB_RESUME ||
1123 !(portstatus & USB_PORT_STAT_CONNECTION) ||
1125 udev->state == USB_STATE_NOTATTACHED)) {
1127 * USB3 protocol ports will automatically transition
1128 * to Enabled state when detect an USB3.0 device attach.
1129 * Do not disable USB3 protocol ports, just pretend
1132 portstatus &= ~USB_PORT_STAT_ENABLE;
1133 if (!hub_is_superspeed(hdev))
1134 usb_clear_port_feature(hdev, port1,
1135 USB_PORT_FEAT_ENABLE);
1138 /* Make sure a warm-reset request is handled by port_event */
1139 if (type == HUB_RESUME &&
1140 hub_port_warm_reset_required(hub, port1, portstatus))
1141 set_bit(port1, hub->event_bits);
1144 * Add debounce if USB3 link is in polling/link training state.
1145 * Link will automatically transition to Enabled state after
1146 * link training completes.
1148 if (hub_is_superspeed(hdev) &&
1149 ((portstatus & USB_PORT_STAT_LINK_STATE) ==
1150 USB_SS_PORT_LS_POLLING))
1151 need_debounce_delay = true;
1153 /* Clear status-change flags; we'll debounce later */
1154 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1155 need_debounce_delay = true;
1156 usb_clear_port_feature(hub->hdev, port1,
1157 USB_PORT_FEAT_C_CONNECTION);
1159 if (portchange & USB_PORT_STAT_C_ENABLE) {
1160 need_debounce_delay = true;
1161 usb_clear_port_feature(hub->hdev, port1,
1162 USB_PORT_FEAT_C_ENABLE);
1164 if (portchange & USB_PORT_STAT_C_RESET) {
1165 need_debounce_delay = true;
1166 usb_clear_port_feature(hub->hdev, port1,
1167 USB_PORT_FEAT_C_RESET);
1169 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
1170 hub_is_superspeed(hub->hdev)) {
1171 need_debounce_delay = true;
1172 usb_clear_port_feature(hub->hdev, port1,
1173 USB_PORT_FEAT_C_BH_PORT_RESET);
1175 /* We can forget about a "removed" device when there's a
1176 * physical disconnect or the connect status changes.
1178 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
1179 (portchange & USB_PORT_STAT_C_CONNECTION))
1180 clear_bit(port1, hub->removed_bits);
1182 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
1183 /* Tell hub_wq to disconnect the device or
1184 * check for a new connection or over current condition.
1185 * Based on USB2.0 Spec Section 11.12.5,
1186 * C_PORT_OVER_CURRENT could be set while
1187 * PORT_OVER_CURRENT is not. So check for any of them.
1189 if (udev || (portstatus & USB_PORT_STAT_CONNECTION) ||
1190 (portchange & USB_PORT_STAT_C_CONNECTION) ||
1191 (portstatus & USB_PORT_STAT_OVERCURRENT) ||
1192 (portchange & USB_PORT_STAT_C_OVERCURRENT))
1193 set_bit(port1, hub->change_bits);
1195 } else if (portstatus & USB_PORT_STAT_ENABLE) {
1196 bool port_resumed = (portstatus &
1197 USB_PORT_STAT_LINK_STATE) ==
1199 /* The power session apparently survived the resume.
1200 * If there was an overcurrent or suspend change
1201 * (i.e., remote wakeup request), have hub_wq
1202 * take care of it. Look at the port link state
1203 * for USB 3.0 hubs, since they don't have a suspend
1204 * change bit, and they don't set the port link change
1205 * bit on device-initiated resume.
1207 if (portchange || (hub_is_superspeed(hub->hdev) &&
1209 set_bit(port1, hub->event_bits);
1211 } else if (udev->persist_enabled) {
1213 udev->reset_resume = 1;
1215 /* Don't set the change_bits when the device
1218 if (test_bit(port1, hub->power_bits))
1219 set_bit(port1, hub->change_bits);
1222 /* The power session is gone; tell hub_wq */
1223 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1224 set_bit(port1, hub->change_bits);
1228 /* If no port-status-change flags were set, we don't need any
1229 * debouncing. If flags were set we can try to debounce the
1230 * ports all at once right now, instead of letting hub_wq do them
1231 * one at a time later on.
1233 * If any port-status changes do occur during this delay, hub_wq
1234 * will see them later and handle them normally.
1236 if (need_debounce_delay) {
1237 delay = HUB_DEBOUNCE_STABLE;
1239 /* Don't do a long sleep inside a workqueue routine */
1240 if (type == HUB_INIT2) {
1241 INIT_DELAYED_WORK(&hub->init_work, hub_init_func3);
1242 queue_delayed_work(system_power_efficient_wq,
1244 msecs_to_jiffies(delay));
1245 device_unlock(&hdev->dev);
1246 return; /* Continues at init3: below */
1254 status = usb_submit_urb(hub->urb, GFP_NOIO);
1256 dev_err(hub->intfdev, "activate --> %d\n", status);
1257 if (hub->has_indicators && blinkenlights)
1258 queue_delayed_work(system_power_efficient_wq,
1259 &hub->leds, LED_CYCLE_PERIOD);
1261 /* Scan all ports that need attention */
1264 if (type == HUB_INIT2 || type == HUB_INIT3) {
1265 /* Allow autosuspend if it was suppressed */
1267 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
1268 device_unlock(&hdev->dev);
1271 kref_put(&hub->kref, hub_release);
1274 /* Implement the continuations for the delays above */
1275 static void hub_init_func2(struct work_struct *ws)
1277 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1279 hub_activate(hub, HUB_INIT2);
1282 static void hub_init_func3(struct work_struct *ws)
1284 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1286 hub_activate(hub, HUB_INIT3);
1289 enum hub_quiescing_type {
1290 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
1293 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
1295 struct usb_device *hdev = hub->hdev;
1298 /* hub_wq and related activity won't re-trigger */
1301 if (type != HUB_SUSPEND) {
1302 /* Disconnect all the children */
1303 for (i = 0; i < hdev->maxchild; ++i) {
1304 if (hub->ports[i]->child)
1305 usb_disconnect(&hub->ports[i]->child);
1309 /* Stop hub_wq and related activity */
1310 usb_kill_urb(hub->urb);
1311 if (hub->has_indicators)
1312 cancel_delayed_work_sync(&hub->leds);
1314 flush_work(&hub->tt.clear_work);
1317 static void hub_pm_barrier_for_all_ports(struct usb_hub *hub)
1321 for (i = 0; i < hub->hdev->maxchild; ++i)
1322 pm_runtime_barrier(&hub->ports[i]->dev);
1325 /* caller has locked the hub device */
1326 static int hub_pre_reset(struct usb_interface *intf)
1328 struct usb_hub *hub = usb_get_intfdata(intf);
1330 hub_quiesce(hub, HUB_PRE_RESET);
1332 hub_pm_barrier_for_all_ports(hub);
1336 /* caller has locked the hub device */
1337 static int hub_post_reset(struct usb_interface *intf)
1339 struct usb_hub *hub = usb_get_intfdata(intf);
1342 hub_pm_barrier_for_all_ports(hub);
1343 hub_activate(hub, HUB_POST_RESET);
1347 static int hub_configure(struct usb_hub *hub,
1348 struct usb_endpoint_descriptor *endpoint)
1350 struct usb_hcd *hcd;
1351 struct usb_device *hdev = hub->hdev;
1352 struct device *hub_dev = hub->intfdev;
1353 u16 hubstatus, hubchange;
1354 u16 wHubCharacteristics;
1357 char *message = "out of memory";
1362 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
1368 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1373 mutex_init(&hub->status_mutex);
1375 hub->descriptor = kzalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1376 if (!hub->descriptor) {
1381 /* Request the entire hub descriptor.
1382 * hub->descriptor can handle USB_MAXCHILDREN ports,
1383 * but a (non-SS) hub can/will return fewer bytes here.
1385 ret = get_hub_descriptor(hdev, hub->descriptor);
1387 message = "can't read hub descriptor";
1391 maxchild = USB_MAXCHILDREN;
1392 if (hub_is_superspeed(hdev))
1393 maxchild = min_t(unsigned, maxchild, USB_SS_MAXPORTS);
1395 if (hub->descriptor->bNbrPorts > maxchild) {
1396 message = "hub has too many ports!";
1399 } else if (hub->descriptor->bNbrPorts == 0) {
1400 message = "hub doesn't have any ports!";
1405 maxchild = hub->descriptor->bNbrPorts;
1406 dev_info(hub_dev, "%d port%s detected\n", maxchild,
1407 (maxchild == 1) ? "" : "s");
1409 hub->ports = kzalloc(maxchild * sizeof(struct usb_port *), GFP_KERNEL);
1415 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1416 if (hub_is_superspeed(hdev)) {
1424 /* FIXME for USB 3.0, skip for now */
1425 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1426 !(hub_is_superspeed(hdev))) {
1427 char portstr[USB_MAXCHILDREN + 1];
1429 for (i = 0; i < maxchild; i++)
1430 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1431 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1433 portstr[maxchild] = 0;
1434 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1436 dev_dbg(hub_dev, "standalone hub\n");
1438 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1439 case HUB_CHAR_COMMON_LPSM:
1440 dev_dbg(hub_dev, "ganged power switching\n");
1442 case HUB_CHAR_INDV_PORT_LPSM:
1443 dev_dbg(hub_dev, "individual port power switching\n");
1445 case HUB_CHAR_NO_LPSM:
1447 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1451 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1452 case HUB_CHAR_COMMON_OCPM:
1453 dev_dbg(hub_dev, "global over-current protection\n");
1455 case HUB_CHAR_INDV_PORT_OCPM:
1456 dev_dbg(hub_dev, "individual port over-current protection\n");
1458 case HUB_CHAR_NO_OCPM:
1460 dev_dbg(hub_dev, "no over-current protection\n");
1464 spin_lock_init(&hub->tt.lock);
1465 INIT_LIST_HEAD(&hub->tt.clear_list);
1466 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1467 switch (hdev->descriptor.bDeviceProtocol) {
1470 case USB_HUB_PR_HS_SINGLE_TT:
1471 dev_dbg(hub_dev, "Single TT\n");
1474 case USB_HUB_PR_HS_MULTI_TT:
1475 ret = usb_set_interface(hdev, 0, 1);
1477 dev_dbg(hub_dev, "TT per port\n");
1480 dev_err(hub_dev, "Using single TT (err %d)\n",
1485 /* USB 3.0 hubs don't have a TT */
1488 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1489 hdev->descriptor.bDeviceProtocol);
1493 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1494 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1495 case HUB_TTTT_8_BITS:
1496 if (hdev->descriptor.bDeviceProtocol != 0) {
1497 hub->tt.think_time = 666;
1498 dev_dbg(hub_dev, "TT requires at most %d "
1499 "FS bit times (%d ns)\n",
1500 8, hub->tt.think_time);
1503 case HUB_TTTT_16_BITS:
1504 hub->tt.think_time = 666 * 2;
1505 dev_dbg(hub_dev, "TT requires at most %d "
1506 "FS bit times (%d ns)\n",
1507 16, hub->tt.think_time);
1509 case HUB_TTTT_24_BITS:
1510 hub->tt.think_time = 666 * 3;
1511 dev_dbg(hub_dev, "TT requires at most %d "
1512 "FS bit times (%d ns)\n",
1513 24, hub->tt.think_time);
1515 case HUB_TTTT_32_BITS:
1516 hub->tt.think_time = 666 * 4;
1517 dev_dbg(hub_dev, "TT requires at most %d "
1518 "FS bit times (%d ns)\n",
1519 32, hub->tt.think_time);
1523 /* probe() zeroes hub->indicator[] */
1524 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1525 hub->has_indicators = 1;
1526 dev_dbg(hub_dev, "Port indicators are supported\n");
1529 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1530 hub->descriptor->bPwrOn2PwrGood * 2);
1532 /* power budgeting mostly matters with bus-powered hubs,
1533 * and battery-powered root hubs (may provide just 8 mA).
1535 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1537 message = "can't get hub status";
1540 hcd = bus_to_hcd(hdev->bus);
1541 if (hdev == hdev->bus->root_hub) {
1542 if (hcd->power_budget > 0)
1543 hdev->bus_mA = hcd->power_budget;
1545 hdev->bus_mA = full_load * maxchild;
1546 if (hdev->bus_mA >= full_load)
1547 hub->mA_per_port = full_load;
1549 hub->mA_per_port = hdev->bus_mA;
1550 hub->limited_power = 1;
1552 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1553 int remaining = hdev->bus_mA -
1554 hub->descriptor->bHubContrCurrent;
1556 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1557 hub->descriptor->bHubContrCurrent);
1558 hub->limited_power = 1;
1560 if (remaining < maxchild * unit_load)
1562 "insufficient power available "
1563 "to use all downstream ports\n");
1564 hub->mA_per_port = unit_load; /* 7.2.1 */
1566 } else { /* Self-powered external hub */
1567 /* FIXME: What about battery-powered external hubs that
1568 * provide less current per port? */
1569 hub->mA_per_port = full_load;
1571 if (hub->mA_per_port < full_load)
1572 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1575 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1577 message = "can't get hub status";
1581 /* local power status reports aren't always correct */
1582 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1583 dev_dbg(hub_dev, "local power source is %s\n",
1584 (hubstatus & HUB_STATUS_LOCAL_POWER)
1585 ? "lost (inactive)" : "good");
1587 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1588 dev_dbg(hub_dev, "%sover-current condition exists\n",
1589 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1591 /* set up the interrupt endpoint
1592 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1593 * bytes as USB2.0[11.12.3] says because some hubs are known
1594 * to send more data (and thus cause overflow). For root hubs,
1595 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1596 * to be big enough for at least USB_MAXCHILDREN ports. */
1597 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1598 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1600 if (maxp > sizeof(*hub->buffer))
1601 maxp = sizeof(*hub->buffer);
1603 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1609 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1610 hub, endpoint->bInterval);
1612 /* maybe cycle the hub leds */
1613 if (hub->has_indicators && blinkenlights)
1614 hub->indicator[0] = INDICATOR_CYCLE;
1616 mutex_lock(&usb_port_peer_mutex);
1617 for (i = 0; i < maxchild; i++) {
1618 ret = usb_hub_create_port_device(hub, i + 1);
1620 dev_err(hub->intfdev,
1621 "couldn't create port%d device.\n", i + 1);
1626 for (i = 0; i < hdev->maxchild; i++) {
1627 struct usb_port *port_dev = hub->ports[i];
1629 pm_runtime_put(&port_dev->dev);
1632 mutex_unlock(&usb_port_peer_mutex);
1636 /* Update the HCD's internal representation of this hub before hub_wq
1637 * starts getting port status changes for devices under the hub.
1639 if (hcd->driver->update_hub_device) {
1640 ret = hcd->driver->update_hub_device(hcd, hdev,
1641 &hub->tt, GFP_KERNEL);
1643 message = "can't update HCD hub info";
1648 usb_hub_adjust_deviceremovable(hdev, hub->descriptor);
1650 hub_activate(hub, HUB_INIT);
1654 dev_err(hub_dev, "config failed, %s (err %d)\n",
1656 /* hub_disconnect() frees urb and descriptor */
1660 static void hub_release(struct kref *kref)
1662 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1664 usb_put_dev(hub->hdev);
1665 usb_put_intf(to_usb_interface(hub->intfdev));
1669 static unsigned highspeed_hubs;
1671 static void hub_disconnect(struct usb_interface *intf)
1673 struct usb_hub *hub = usb_get_intfdata(intf);
1674 struct usb_device *hdev = interface_to_usbdev(intf);
1678 * Stop adding new hub events. We do not want to block here and thus
1679 * will not try to remove any pending work item.
1681 hub->disconnected = 1;
1683 /* Disconnect all children and quiesce the hub */
1685 hub_quiesce(hub, HUB_DISCONNECT);
1687 mutex_lock(&usb_port_peer_mutex);
1689 /* Avoid races with recursively_mark_NOTATTACHED() */
1690 spin_lock_irq(&device_state_lock);
1691 port1 = hdev->maxchild;
1693 usb_set_intfdata(intf, NULL);
1694 spin_unlock_irq(&device_state_lock);
1696 for (; port1 > 0; --port1)
1697 usb_hub_remove_port_device(hub, port1);
1699 mutex_unlock(&usb_port_peer_mutex);
1701 if (hub->hdev->speed == USB_SPEED_HIGH)
1704 usb_free_urb(hub->urb);
1706 kfree(hub->descriptor);
1710 pm_suspend_ignore_children(&intf->dev, false);
1712 if (hub->quirk_disable_autosuspend)
1713 usb_autopm_put_interface(intf);
1715 kref_put(&hub->kref, hub_release);
1718 static bool hub_descriptor_is_sane(struct usb_host_interface *desc)
1720 /* Some hubs have a subclass of 1, which AFAICT according to the */
1721 /* specs is not defined, but it works */
1722 if (desc->desc.bInterfaceSubClass != 0 &&
1723 desc->desc.bInterfaceSubClass != 1)
1726 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1727 if (desc->desc.bNumEndpoints != 1)
1730 /* If the first endpoint is not interrupt IN, we'd better punt! */
1731 if (!usb_endpoint_is_int_in(&desc->endpoint[0].desc))
1737 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1739 struct usb_host_interface *desc;
1740 struct usb_device *hdev;
1741 struct usb_hub *hub;
1743 desc = intf->cur_altsetting;
1744 hdev = interface_to_usbdev(intf);
1747 * Set default autosuspend delay as 0 to speedup bus suspend,
1748 * based on the below considerations:
1750 * - Unlike other drivers, the hub driver does not rely on the
1751 * autosuspend delay to provide enough time to handle a wakeup
1752 * event, and the submitted status URB is just to check future
1753 * change on hub downstream ports, so it is safe to do it.
1755 * - The patch might cause one or more auto supend/resume for
1756 * below very rare devices when they are plugged into hub
1759 * devices having trouble initializing, and disconnect
1760 * themselves from the bus and then reconnect a second
1763 * devices just for downloading firmware, and disconnects
1764 * themselves after completing it
1766 * For these quite rare devices, their drivers may change the
1767 * autosuspend delay of their parent hub in the probe() to one
1768 * appropriate value to avoid the subtle problem if someone
1771 * - The patch may cause one or more auto suspend/resume on
1772 * hub during running 'lsusb', but it is probably too
1773 * infrequent to worry about.
1775 * - Change autosuspend delay of hub can avoid unnecessary auto
1776 * suspend timer for hub, also may decrease power consumption
1779 * - If user has indicated to prevent autosuspend by passing
1780 * usbcore.autosuspend = -1 then keep autosuspend disabled.
1783 if (hdev->dev.power.autosuspend_delay >= 0)
1784 pm_runtime_set_autosuspend_delay(&hdev->dev, 0);
1788 * Hubs have proper suspend/resume support, except for root hubs
1789 * where the controller driver doesn't have bus_suspend and
1790 * bus_resume methods.
1792 if (hdev->parent) { /* normal device */
1793 usb_enable_autosuspend(hdev);
1794 } else { /* root hub */
1795 const struct hc_driver *drv = bus_to_hcd(hdev->bus)->driver;
1797 if (drv->bus_suspend && drv->bus_resume)
1798 usb_enable_autosuspend(hdev);
1801 if (hdev->level == MAX_TOPO_LEVEL) {
1803 "Unsupported bus topology: hub nested too deep\n");
1807 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1809 dev_warn(&intf->dev, "ignoring external hub\n");
1814 if (!hub_descriptor_is_sane(desc)) {
1815 dev_err(&intf->dev, "bad descriptor, ignoring hub\n");
1819 /* We found a hub */
1820 dev_info(&intf->dev, "USB hub found\n");
1822 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1826 kref_init(&hub->kref);
1827 hub->intfdev = &intf->dev;
1829 INIT_DELAYED_WORK(&hub->leds, led_work);
1830 INIT_DELAYED_WORK(&hub->init_work, NULL);
1831 INIT_WORK(&hub->events, hub_event);
1835 usb_set_intfdata(intf, hub);
1836 intf->needs_remote_wakeup = 1;
1837 pm_suspend_ignore_children(&intf->dev, true);
1839 if (hdev->speed == USB_SPEED_HIGH)
1842 if (id->driver_info & HUB_QUIRK_CHECK_PORT_AUTOSUSPEND)
1843 hub->quirk_check_port_auto_suspend = 1;
1845 if (id->driver_info & HUB_QUIRK_DISABLE_AUTOSUSPEND) {
1846 hub->quirk_disable_autosuspend = 1;
1847 usb_autopm_get_interface_no_resume(intf);
1850 if (hub_configure(hub, &desc->endpoint[0].desc) >= 0)
1853 hub_disconnect(intf);
1858 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1860 struct usb_device *hdev = interface_to_usbdev(intf);
1861 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1863 /* assert ifno == 0 (part of hub spec) */
1865 case USBDEVFS_HUB_PORTINFO: {
1866 struct usbdevfs_hub_portinfo *info = user_data;
1869 spin_lock_irq(&device_state_lock);
1870 if (hdev->devnum <= 0)
1873 info->nports = hdev->maxchild;
1874 for (i = 0; i < info->nports; i++) {
1875 if (hub->ports[i]->child == NULL)
1879 hub->ports[i]->child->devnum;
1882 spin_unlock_irq(&device_state_lock);
1884 return info->nports + 1;
1893 * Allow user programs to claim ports on a hub. When a device is attached
1894 * to one of these "claimed" ports, the program will "own" the device.
1896 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1897 struct usb_dev_state ***ppowner)
1899 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1901 if (hdev->state == USB_STATE_NOTATTACHED)
1903 if (port1 == 0 || port1 > hdev->maxchild)
1906 /* Devices not managed by the hub driver
1907 * will always have maxchild equal to 0.
1909 *ppowner = &(hub->ports[port1 - 1]->port_owner);
1913 /* In the following three functions, the caller must hold hdev's lock */
1914 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
1915 struct usb_dev_state *owner)
1918 struct usb_dev_state **powner;
1920 rc = find_port_owner(hdev, port1, &powner);
1928 EXPORT_SYMBOL_GPL(usb_hub_claim_port);
1930 int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
1931 struct usb_dev_state *owner)
1934 struct usb_dev_state **powner;
1936 rc = find_port_owner(hdev, port1, &powner);
1939 if (*powner != owner)
1944 EXPORT_SYMBOL_GPL(usb_hub_release_port);
1946 void usb_hub_release_all_ports(struct usb_device *hdev, struct usb_dev_state *owner)
1948 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1951 for (n = 0; n < hdev->maxchild; n++) {
1952 if (hub->ports[n]->port_owner == owner)
1953 hub->ports[n]->port_owner = NULL;
1958 /* The caller must hold udev's lock */
1959 bool usb_device_is_owned(struct usb_device *udev)
1961 struct usb_hub *hub;
1963 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1965 hub = usb_hub_to_struct_hub(udev->parent);
1966 return !!hub->ports[udev->portnum - 1]->port_owner;
1969 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1971 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
1974 for (i = 0; i < udev->maxchild; ++i) {
1975 if (hub->ports[i]->child)
1976 recursively_mark_NOTATTACHED(hub->ports[i]->child);
1978 if (udev->state == USB_STATE_SUSPENDED)
1979 udev->active_duration -= jiffies;
1980 udev->state = USB_STATE_NOTATTACHED;
1984 * usb_set_device_state - change a device's current state (usbcore, hcds)
1985 * @udev: pointer to device whose state should be changed
1986 * @new_state: new state value to be stored
1988 * udev->state is _not_ fully protected by the device lock. Although
1989 * most transitions are made only while holding the lock, the state can
1990 * can change to USB_STATE_NOTATTACHED at almost any time. This
1991 * is so that devices can be marked as disconnected as soon as possible,
1992 * without having to wait for any semaphores to be released. As a result,
1993 * all changes to any device's state must be protected by the
1994 * device_state_lock spinlock.
1996 * Once a device has been added to the device tree, all changes to its state
1997 * should be made using this routine. The state should _not_ be set directly.
1999 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
2000 * Otherwise udev->state is set to new_state, and if new_state is
2001 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
2002 * to USB_STATE_NOTATTACHED.
2004 void usb_set_device_state(struct usb_device *udev,
2005 enum usb_device_state new_state)
2007 unsigned long flags;
2010 spin_lock_irqsave(&device_state_lock, flags);
2011 if (udev->state == USB_STATE_NOTATTACHED)
2013 else if (new_state != USB_STATE_NOTATTACHED) {
2015 /* root hub wakeup capabilities are managed out-of-band
2016 * and may involve silicon errata ... ignore them here.
2019 if (udev->state == USB_STATE_SUSPENDED
2020 || new_state == USB_STATE_SUSPENDED)
2021 ; /* No change to wakeup settings */
2022 else if (new_state == USB_STATE_CONFIGURED)
2023 wakeup = (udev->quirks &
2024 USB_QUIRK_IGNORE_REMOTE_WAKEUP) ? 0 :
2025 udev->actconfig->desc.bmAttributes &
2026 USB_CONFIG_ATT_WAKEUP;
2030 if (udev->state == USB_STATE_SUSPENDED &&
2031 new_state != USB_STATE_SUSPENDED)
2032 udev->active_duration -= jiffies;
2033 else if (new_state == USB_STATE_SUSPENDED &&
2034 udev->state != USB_STATE_SUSPENDED)
2035 udev->active_duration += jiffies;
2036 udev->state = new_state;
2038 recursively_mark_NOTATTACHED(udev);
2039 spin_unlock_irqrestore(&device_state_lock, flags);
2041 device_set_wakeup_capable(&udev->dev, wakeup);
2043 EXPORT_SYMBOL_GPL(usb_set_device_state);
2046 * Choose a device number.
2048 * Device numbers are used as filenames in usbfs. On USB-1.1 and
2049 * USB-2.0 buses they are also used as device addresses, however on
2050 * USB-3.0 buses the address is assigned by the controller hardware
2051 * and it usually is not the same as the device number.
2053 * WUSB devices are simple: they have no hubs behind, so the mapping
2054 * device <-> virtual port number becomes 1:1. Why? to simplify the
2055 * life of the device connection logic in
2056 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
2057 * handshake we need to assign a temporary address in the unauthorized
2058 * space. For simplicity we use the first virtual port number found to
2059 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
2060 * and that becomes it's address [X < 128] or its unauthorized address
2063 * We add 1 as an offset to the one-based USB-stack port number
2064 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
2065 * 0 is reserved by USB for default address; (b) Linux's USB stack
2066 * uses always #1 for the root hub of the controller. So USB stack's
2067 * port #1, which is wusb virtual-port #0 has address #2.
2069 * Devices connected under xHCI are not as simple. The host controller
2070 * supports virtualization, so the hardware assigns device addresses and
2071 * the HCD must setup data structures before issuing a set address
2072 * command to the hardware.
2074 static void choose_devnum(struct usb_device *udev)
2077 struct usb_bus *bus = udev->bus;
2079 /* be safe when more hub events are proceed in parallel */
2080 mutex_lock(&bus->devnum_next_mutex);
2082 devnum = udev->portnum + 1;
2083 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
2085 /* Try to allocate the next devnum beginning at
2086 * bus->devnum_next. */
2087 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
2090 devnum = find_next_zero_bit(bus->devmap.devicemap,
2092 bus->devnum_next = (devnum >= 127 ? 1 : devnum + 1);
2095 set_bit(devnum, bus->devmap.devicemap);
2096 udev->devnum = devnum;
2098 mutex_unlock(&bus->devnum_next_mutex);
2101 static void release_devnum(struct usb_device *udev)
2103 if (udev->devnum > 0) {
2104 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
2109 static void update_devnum(struct usb_device *udev, int devnum)
2111 /* The address for a WUSB device is managed by wusbcore. */
2113 udev->devnum = devnum;
2116 static void hub_free_dev(struct usb_device *udev)
2118 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2120 /* Root hubs aren't real devices, so don't free HCD resources */
2121 if (hcd->driver->free_dev && udev->parent)
2122 hcd->driver->free_dev(hcd, udev);
2125 static void hub_disconnect_children(struct usb_device *udev)
2127 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2130 /* Free up all the children before we remove this device */
2131 for (i = 0; i < udev->maxchild; i++) {
2132 if (hub->ports[i]->child)
2133 usb_disconnect(&hub->ports[i]->child);
2138 * usb_disconnect - disconnect a device (usbcore-internal)
2139 * @pdev: pointer to device being disconnected
2140 * Context: !in_interrupt ()
2142 * Something got disconnected. Get rid of it and all of its children.
2144 * If *pdev is a normal device then the parent hub must already be locked.
2145 * If *pdev is a root hub then the caller must hold the usb_bus_idr_lock,
2146 * which protects the set of root hubs as well as the list of buses.
2148 * Only hub drivers (including virtual root hub drivers for host
2149 * controllers) should ever call this.
2151 * This call is synchronous, and may not be used in an interrupt context.
2153 void usb_disconnect(struct usb_device **pdev)
2155 struct usb_port *port_dev = NULL;
2156 struct usb_device *udev = *pdev;
2157 struct usb_hub *hub = NULL;
2160 /* mark the device as inactive, so any further urb submissions for
2161 * this device (and any of its children) will fail immediately.
2162 * this quiesces everything except pending urbs.
2164 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2165 dev_info(&udev->dev, "USB disconnect, device number %d\n",
2169 * Ensure that the pm runtime code knows that the USB device
2170 * is in the process of being disconnected.
2172 pm_runtime_barrier(&udev->dev);
2174 usb_lock_device(udev);
2176 hub_disconnect_children(udev);
2178 /* deallocate hcd/hardware state ... nuking all pending urbs and
2179 * cleaning up all state associated with the current configuration
2180 * so that the hardware is now fully quiesced.
2182 dev_dbg(&udev->dev, "unregistering device\n");
2183 usb_disable_device(udev, 0);
2184 usb_hcd_synchronize_unlinks(udev);
2187 port1 = udev->portnum;
2188 hub = usb_hub_to_struct_hub(udev->parent);
2189 port_dev = hub->ports[port1 - 1];
2191 sysfs_remove_link(&udev->dev.kobj, "port");
2192 sysfs_remove_link(&port_dev->dev.kobj, "device");
2195 * As usb_port_runtime_resume() de-references udev, make
2196 * sure no resumes occur during removal
2198 if (!test_and_set_bit(port1, hub->child_usage_bits))
2199 pm_runtime_get_sync(&port_dev->dev);
2202 usb_remove_ep_devs(&udev->ep0);
2203 usb_unlock_device(udev);
2205 /* Unregister the device. The device driver is responsible
2206 * for de-configuring the device and invoking the remove-device
2207 * notifier chain (used by usbfs and possibly others).
2209 device_del(&udev->dev);
2211 /* Free the device number and delete the parent's children[]
2212 * (or root_hub) pointer.
2214 release_devnum(udev);
2216 /* Avoid races with recursively_mark_NOTATTACHED() */
2217 spin_lock_irq(&device_state_lock);
2219 spin_unlock_irq(&device_state_lock);
2221 if (port_dev && test_and_clear_bit(port1, hub->child_usage_bits))
2222 pm_runtime_put(&port_dev->dev);
2226 put_device(&udev->dev);
2229 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2230 static void show_string(struct usb_device *udev, char *id, char *string)
2234 dev_info(&udev->dev, "%s: %s\n", id, string);
2237 static void announce_device(struct usb_device *udev)
2239 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2240 le16_to_cpu(udev->descriptor.idVendor),
2241 le16_to_cpu(udev->descriptor.idProduct));
2242 dev_info(&udev->dev,
2243 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2244 udev->descriptor.iManufacturer,
2245 udev->descriptor.iProduct,
2246 udev->descriptor.iSerialNumber);
2247 show_string(udev, "Product", udev->product);
2248 show_string(udev, "Manufacturer", udev->manufacturer);
2249 show_string(udev, "SerialNumber", udev->serial);
2252 static inline void announce_device(struct usb_device *udev) { }
2257 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2258 * @udev: newly addressed device (in ADDRESS state)
2260 * Finish enumeration for On-The-Go devices
2262 * Return: 0 if successful. A negative error code otherwise.
2264 static int usb_enumerate_device_otg(struct usb_device *udev)
2268 #ifdef CONFIG_USB_OTG
2270 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2271 * to wake us after we've powered off VBUS; and HNP, switching roles
2272 * "host" to "peripheral". The OTG descriptor helps figure this out.
2274 if (!udev->bus->is_b_host
2276 && udev->parent == udev->bus->root_hub) {
2277 struct usb_otg_descriptor *desc = NULL;
2278 struct usb_bus *bus = udev->bus;
2279 unsigned port1 = udev->portnum;
2281 /* descriptor may appear anywhere in config */
2282 err = __usb_get_extra_descriptor(udev->rawdescriptors[0],
2283 le16_to_cpu(udev->config[0].desc.wTotalLength),
2284 USB_DT_OTG, (void **) &desc, sizeof(*desc));
2285 if (err || !(desc->bmAttributes & USB_OTG_HNP))
2288 dev_info(&udev->dev, "Dual-Role OTG device on %sHNP port\n",
2289 (port1 == bus->otg_port) ? "" : "non-");
2291 /* enable HNP before suspend, it's simpler */
2292 if (port1 == bus->otg_port) {
2293 bus->b_hnp_enable = 1;
2294 err = usb_control_msg(udev,
2295 usb_sndctrlpipe(udev, 0),
2296 USB_REQ_SET_FEATURE, 0,
2297 USB_DEVICE_B_HNP_ENABLE,
2299 USB_CTRL_SET_TIMEOUT);
2302 * OTG MESSAGE: report errors here,
2303 * customize to match your product.
2305 dev_err(&udev->dev, "can't set HNP mode: %d\n",
2307 bus->b_hnp_enable = 0;
2309 } else if (desc->bLength == sizeof
2310 (struct usb_otg_descriptor)) {
2311 /* Set a_alt_hnp_support for legacy otg device */
2312 err = usb_control_msg(udev,
2313 usb_sndctrlpipe(udev, 0),
2314 USB_REQ_SET_FEATURE, 0,
2315 USB_DEVICE_A_ALT_HNP_SUPPORT,
2317 USB_CTRL_SET_TIMEOUT);
2320 "set a_alt_hnp_support failed: %d\n",
2330 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2331 * @udev: newly addressed device (in ADDRESS state)
2333 * This is only called by usb_new_device() -- all comments that apply there
2334 * apply here wrt to environment.
2336 * If the device is WUSB and not authorized, we don't attempt to read
2337 * the string descriptors, as they will be errored out by the device
2338 * until it has been authorized.
2340 * Return: 0 if successful. A negative error code otherwise.
2342 static int usb_enumerate_device(struct usb_device *udev)
2345 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2347 if (udev->config == NULL) {
2348 err = usb_get_configuration(udev);
2351 dev_err(&udev->dev, "can't read configurations, error %d\n",
2357 /* read the standard strings and cache them if present */
2358 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
2359 udev->manufacturer = usb_cache_string(udev,
2360 udev->descriptor.iManufacturer);
2361 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
2363 err = usb_enumerate_device_otg(udev);
2367 if (IS_ENABLED(CONFIG_USB_OTG_WHITELIST) && hcd->tpl_support &&
2368 !is_targeted(udev)) {
2369 /* Maybe it can talk to us, though we can't talk to it.
2370 * (Includes HNP test device.)
2372 if (IS_ENABLED(CONFIG_USB_OTG) && (udev->bus->b_hnp_enable
2373 || udev->bus->is_b_host)) {
2374 err = usb_port_suspend(udev, PMSG_AUTO_SUSPEND);
2376 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
2381 usb_detect_interface_quirks(udev);
2386 static void set_usb_port_removable(struct usb_device *udev)
2388 struct usb_device *hdev = udev->parent;
2389 struct usb_hub *hub;
2390 u8 port = udev->portnum;
2391 u16 wHubCharacteristics;
2392 bool removable = true;
2397 hub = usb_hub_to_struct_hub(udev->parent);
2400 * If the platform firmware has provided information about a port,
2401 * use that to determine whether it's removable.
2403 switch (hub->ports[udev->portnum - 1]->connect_type) {
2404 case USB_PORT_CONNECT_TYPE_HOT_PLUG:
2405 udev->removable = USB_DEVICE_REMOVABLE;
2407 case USB_PORT_CONNECT_TYPE_HARD_WIRED:
2408 case USB_PORT_NOT_USED:
2409 udev->removable = USB_DEVICE_FIXED;
2416 * Otherwise, check whether the hub knows whether a port is removable
2419 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2421 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
2424 if (hub_is_superspeed(hdev)) {
2425 if (le16_to_cpu(hub->descriptor->u.ss.DeviceRemovable)
2429 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
2434 udev->removable = USB_DEVICE_REMOVABLE;
2436 udev->removable = USB_DEVICE_FIXED;
2441 * usb_new_device - perform initial device setup (usbcore-internal)
2442 * @udev: newly addressed device (in ADDRESS state)
2444 * This is called with devices which have been detected but not fully
2445 * enumerated. The device descriptor is available, but not descriptors
2446 * for any device configuration. The caller must have locked either
2447 * the parent hub (if udev is a normal device) or else the
2448 * usb_bus_idr_lock (if udev is a root hub). The parent's pointer to
2449 * udev has already been installed, but udev is not yet visible through
2450 * sysfs or other filesystem code.
2452 * This call is synchronous, and may not be used in an interrupt context.
2454 * Only the hub driver or root-hub registrar should ever call this.
2456 * Return: Whether the device is configured properly or not. Zero if the
2457 * interface was registered with the driver core; else a negative errno
2461 int usb_new_device(struct usb_device *udev)
2466 /* Initialize non-root-hub device wakeup to disabled;
2467 * device (un)configuration controls wakeup capable
2468 * sysfs power/wakeup controls wakeup enabled/disabled
2470 device_init_wakeup(&udev->dev, 0);
2473 /* Tell the runtime-PM framework the device is active */
2474 pm_runtime_set_active(&udev->dev);
2475 pm_runtime_get_noresume(&udev->dev);
2476 pm_runtime_use_autosuspend(&udev->dev);
2477 pm_runtime_enable(&udev->dev);
2479 /* By default, forbid autosuspend for all devices. It will be
2480 * allowed for hubs during binding.
2482 usb_disable_autosuspend(udev);
2484 err = usb_enumerate_device(udev); /* Read descriptors */
2487 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
2488 udev->devnum, udev->bus->busnum,
2489 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2490 /* export the usbdev device-node for libusb */
2491 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
2492 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2494 /* Tell the world! */
2495 announce_device(udev);
2498 add_device_randomness(udev->serial, strlen(udev->serial));
2500 add_device_randomness(udev->product, strlen(udev->product));
2501 if (udev->manufacturer)
2502 add_device_randomness(udev->manufacturer,
2503 strlen(udev->manufacturer));
2505 device_enable_async_suspend(&udev->dev);
2507 /* check whether the hub or firmware marks this port as non-removable */
2509 set_usb_port_removable(udev);
2511 /* Register the device. The device driver is responsible
2512 * for configuring the device and invoking the add-device
2513 * notifier chain (used by usbfs and possibly others).
2515 err = device_add(&udev->dev);
2517 dev_err(&udev->dev, "can't device_add, error %d\n", err);
2521 /* Create link files between child device and usb port device. */
2523 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2524 int port1 = udev->portnum;
2525 struct usb_port *port_dev = hub->ports[port1 - 1];
2527 err = sysfs_create_link(&udev->dev.kobj,
2528 &port_dev->dev.kobj, "port");
2532 err = sysfs_create_link(&port_dev->dev.kobj,
2533 &udev->dev.kobj, "device");
2535 sysfs_remove_link(&udev->dev.kobj, "port");
2539 if (!test_and_set_bit(port1, hub->child_usage_bits))
2540 pm_runtime_get_sync(&port_dev->dev);
2543 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
2544 usb_mark_last_busy(udev);
2545 pm_runtime_put_sync_autosuspend(&udev->dev);
2549 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2550 pm_runtime_disable(&udev->dev);
2551 pm_runtime_set_suspended(&udev->dev);
2557 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2558 * @usb_dev: USB device
2560 * Move the USB device to a very basic state where interfaces are disabled
2561 * and the device is in fact unconfigured and unusable.
2563 * We share a lock (that we have) with device_del(), so we need to
2568 int usb_deauthorize_device(struct usb_device *usb_dev)
2570 usb_lock_device(usb_dev);
2571 if (usb_dev->authorized == 0)
2572 goto out_unauthorized;
2574 usb_dev->authorized = 0;
2575 usb_set_configuration(usb_dev, -1);
2578 usb_unlock_device(usb_dev);
2583 int usb_authorize_device(struct usb_device *usb_dev)
2587 usb_lock_device(usb_dev);
2588 if (usb_dev->authorized == 1)
2589 goto out_authorized;
2591 result = usb_autoresume_device(usb_dev);
2593 dev_err(&usb_dev->dev,
2594 "can't autoresume for authorization: %d\n", result);
2595 goto error_autoresume;
2598 if (usb_dev->wusb) {
2599 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2601 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2602 "authorization: %d\n", result);
2603 goto error_device_descriptor;
2607 usb_dev->authorized = 1;
2608 /* Choose and set the configuration. This registers the interfaces
2609 * with the driver core and lets interface drivers bind to them.
2611 c = usb_choose_configuration(usb_dev);
2613 result = usb_set_configuration(usb_dev, c);
2615 dev_err(&usb_dev->dev,
2616 "can't set config #%d, error %d\n", c, result);
2617 /* This need not be fatal. The user can try to
2618 * set other configurations. */
2621 dev_info(&usb_dev->dev, "authorized to connect\n");
2623 error_device_descriptor:
2624 usb_autosuspend_device(usb_dev);
2627 usb_unlock_device(usb_dev); /* complements locktree */
2632 * Return 1 if port speed is SuperSpeedPlus, 0 otherwise or if the
2633 * capability couldn't be checked.
2634 * check it from the link protocol field of the current speed ID attribute.
2635 * current speed ID is got from ext port status request. Sublink speed attribute
2636 * table is returned with the hub BOS SSP device capability descriptor
2638 static int port_speed_is_ssp(struct usb_device *hdev, int speed_id)
2643 struct usb_ssp_cap_descriptor *ssp_cap;
2648 ssp_cap = hdev->bos->ssp_cap;
2652 ssa_count = le32_to_cpu(ssp_cap->bmAttributes) &
2653 USB_SSP_SUBLINK_SPEED_ATTRIBS;
2655 for (i = 0; i <= ssa_count; i++) {
2656 ss_attr = le32_to_cpu(ssp_cap->bmSublinkSpeedAttr[i]);
2657 if (speed_id == (ss_attr & USB_SSP_SUBLINK_SPEED_SSID))
2658 return !!(ss_attr & USB_SSP_SUBLINK_SPEED_LP);
2663 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2664 static unsigned hub_is_wusb(struct usb_hub *hub)
2666 struct usb_hcd *hcd;
2667 if (hub->hdev->parent != NULL) /* not a root hub? */
2669 hcd = bus_to_hcd(hub->hdev->bus);
2670 return hcd->wireless;
2674 #define PORT_RESET_TRIES 5
2675 #define SET_ADDRESS_TRIES 2
2676 #define GET_DESCRIPTOR_TRIES 2
2677 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2678 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2680 #define HUB_ROOT_RESET_TIME 60 /* times are in msec */
2681 #define HUB_SHORT_RESET_TIME 10
2682 #define HUB_BH_RESET_TIME 50
2683 #define HUB_LONG_RESET_TIME 200
2684 #define HUB_RESET_TIMEOUT 800
2687 * "New scheme" enumeration causes an extra state transition to be
2688 * exposed to an xhci host and causes USB3 devices to receive control
2689 * commands in the default state. This has been seen to cause
2690 * enumeration failures, so disable this enumeration scheme for USB3
2693 static bool use_new_scheme(struct usb_device *udev, int retry)
2695 if (udev->speed >= USB_SPEED_SUPER)
2698 return USE_NEW_SCHEME(retry);
2701 /* Is a USB 3.0 port in the Inactive or Compliance Mode state?
2702 * Port worm reset is required to recover
2704 static bool hub_port_warm_reset_required(struct usb_hub *hub, int port1,
2709 if (!hub_is_superspeed(hub->hdev))
2712 if (test_bit(port1, hub->warm_reset_bits))
2715 link_state = portstatus & USB_PORT_STAT_LINK_STATE;
2716 return link_state == USB_SS_PORT_LS_SS_INACTIVE
2717 || link_state == USB_SS_PORT_LS_COMP_MOD;
2720 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2721 struct usb_device *udev, unsigned int delay, bool warm)
2723 int delay_time, ret;
2726 u32 ext_portstatus = 0;
2728 for (delay_time = 0;
2729 delay_time < HUB_RESET_TIMEOUT;
2730 delay_time += delay) {
2731 /* wait to give the device a chance to reset */
2734 /* read and decode port status */
2735 if (hub_is_superspeedplus(hub->hdev))
2736 ret = hub_ext_port_status(hub, port1,
2737 HUB_EXT_PORT_STATUS,
2738 &portstatus, &portchange,
2741 ret = hub_port_status(hub, port1, &portstatus,
2747 * The port state is unknown until the reset completes.
2749 * On top of that, some chips may require additional time
2750 * to re-establish a connection after the reset is complete,
2751 * so also wait for the connection to be re-established.
2753 if (!(portstatus & USB_PORT_STAT_RESET) &&
2754 (portstatus & USB_PORT_STAT_CONNECTION))
2757 /* switch to the long delay after two short delay failures */
2758 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2759 delay = HUB_LONG_RESET_TIME;
2761 dev_dbg(&hub->ports[port1 - 1]->dev,
2762 "not %sreset yet, waiting %dms\n",
2763 warm ? "warm " : "", delay);
2766 if ((portstatus & USB_PORT_STAT_RESET))
2769 if (hub_port_warm_reset_required(hub, port1, portstatus))
2772 /* Device went away? */
2773 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2776 /* Retry if connect change is set but status is still connected.
2777 * A USB 3.0 connection may bounce if multiple warm resets were issued,
2778 * but the device may have successfully re-connected. Ignore it.
2780 if (!hub_is_superspeed(hub->hdev) &&
2781 (portchange & USB_PORT_STAT_C_CONNECTION)) {
2782 usb_clear_port_feature(hub->hdev, port1,
2783 USB_PORT_FEAT_C_CONNECTION);
2787 if (!(portstatus & USB_PORT_STAT_ENABLE))
2793 if (hub_is_wusb(hub))
2794 udev->speed = USB_SPEED_WIRELESS;
2795 else if (hub_is_superspeedplus(hub->hdev) &&
2796 port_speed_is_ssp(hub->hdev, ext_portstatus &
2797 USB_EXT_PORT_STAT_RX_SPEED_ID))
2798 udev->speed = USB_SPEED_SUPER_PLUS;
2799 else if (hub_is_superspeed(hub->hdev))
2800 udev->speed = USB_SPEED_SUPER;
2801 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2802 udev->speed = USB_SPEED_HIGH;
2803 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2804 udev->speed = USB_SPEED_LOW;
2806 udev->speed = USB_SPEED_FULL;
2810 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2811 static int hub_port_reset(struct usb_hub *hub, int port1,
2812 struct usb_device *udev, unsigned int delay, bool warm)
2815 u16 portchange, portstatus;
2816 struct usb_port *port_dev = hub->ports[port1 - 1];
2818 if (!hub_is_superspeed(hub->hdev)) {
2820 dev_err(hub->intfdev, "only USB3 hub support "
2824 /* Block EHCI CF initialization during the port reset.
2825 * Some companion controllers don't like it when they mix.
2827 down_read(&ehci_cf_port_reset_rwsem);
2830 * If the caller hasn't explicitly requested a warm reset,
2831 * double check and see if one is needed.
2833 if (hub_port_status(hub, port1, &portstatus, &portchange) == 0)
2834 if (hub_port_warm_reset_required(hub, port1,
2838 clear_bit(port1, hub->warm_reset_bits);
2840 /* Reset the port */
2841 for (i = 0; i < PORT_RESET_TRIES; i++) {
2842 status = set_port_feature(hub->hdev, port1, (warm ?
2843 USB_PORT_FEAT_BH_PORT_RESET :
2844 USB_PORT_FEAT_RESET));
2845 if (status == -ENODEV) {
2846 ; /* The hub is gone */
2847 } else if (status) {
2848 dev_err(&port_dev->dev,
2849 "cannot %sreset (err = %d)\n",
2850 warm ? "warm " : "", status);
2852 status = hub_port_wait_reset(hub, port1, udev, delay,
2854 if (status && status != -ENOTCONN && status != -ENODEV)
2855 dev_dbg(hub->intfdev,
2856 "port_wait_reset: err = %d\n",
2860 /* Check for disconnect or reset */
2861 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2862 usb_clear_port_feature(hub->hdev, port1,
2863 USB_PORT_FEAT_C_RESET);
2865 if (!hub_is_superspeed(hub->hdev))
2868 usb_clear_port_feature(hub->hdev, port1,
2869 USB_PORT_FEAT_C_BH_PORT_RESET);
2870 usb_clear_port_feature(hub->hdev, port1,
2871 USB_PORT_FEAT_C_PORT_LINK_STATE);
2874 usb_clear_port_feature(hub->hdev, port1,
2875 USB_PORT_FEAT_C_CONNECTION);
2878 * If a USB 3.0 device migrates from reset to an error
2879 * state, re-issue the warm reset.
2881 if (hub_port_status(hub, port1,
2882 &portstatus, &portchange) < 0)
2885 if (!hub_port_warm_reset_required(hub, port1,
2890 * If the port is in SS.Inactive or Compliance Mode, the
2891 * hot or warm reset failed. Try another warm reset.
2894 dev_dbg(&port_dev->dev,
2895 "hot reset failed, warm reset\n");
2900 dev_dbg(&port_dev->dev,
2901 "not enabled, trying %sreset again...\n",
2902 warm ? "warm " : "");
2903 delay = HUB_LONG_RESET_TIME;
2906 dev_err(&port_dev->dev, "Cannot enable. Maybe the USB cable is bad?\n");
2910 /* TRSTRCY = 10 ms; plus some extra */
2913 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2915 update_devnum(udev, 0);
2916 /* The xHC may think the device is already reset,
2917 * so ignore the status.
2919 if (hcd->driver->reset_device)
2920 hcd->driver->reset_device(hcd, udev);
2922 usb_set_device_state(udev, USB_STATE_DEFAULT);
2926 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2929 if (!hub_is_superspeed(hub->hdev))
2930 up_read(&ehci_cf_port_reset_rwsem);
2935 /* Check if a port is power on */
2936 static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2940 if (hub_is_superspeed(hub->hdev)) {
2941 if (portstatus & USB_SS_PORT_STAT_POWER)
2944 if (portstatus & USB_PORT_STAT_POWER)
2951 static void usb_lock_port(struct usb_port *port_dev)
2952 __acquires(&port_dev->status_lock)
2954 mutex_lock(&port_dev->status_lock);
2955 __acquire(&port_dev->status_lock);
2958 static void usb_unlock_port(struct usb_port *port_dev)
2959 __releases(&port_dev->status_lock)
2961 mutex_unlock(&port_dev->status_lock);
2962 __release(&port_dev->status_lock);
2967 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2968 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
2972 if (hub_is_superspeed(hub->hdev)) {
2973 if ((portstatus & USB_PORT_STAT_LINK_STATE)
2974 == USB_SS_PORT_LS_U3)
2977 if (portstatus & USB_PORT_STAT_SUSPEND)
2984 /* Determine whether the device on a port is ready for a normal resume,
2985 * is ready for a reset-resume, or should be disconnected.
2987 static int check_port_resume_type(struct usb_device *udev,
2988 struct usb_hub *hub, int port1,
2989 int status, u16 portchange, u16 portstatus)
2991 struct usb_port *port_dev = hub->ports[port1 - 1];
2995 /* Is a warm reset needed to recover the connection? */
2996 if (status == 0 && udev->reset_resume
2997 && hub_port_warm_reset_required(hub, port1, portstatus)) {
3000 /* Is the device still present? */
3001 else if (status || port_is_suspended(hub, portstatus) ||
3002 !port_is_power_on(hub, portstatus)) {
3005 } else if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
3007 usleep_range(200, 300);
3008 status = hub_port_status(hub, port1, &portstatus,
3015 /* Can't do a normal resume if the port isn't enabled,
3016 * so try a reset-resume instead.
3018 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
3019 if (udev->persist_enabled)
3020 udev->reset_resume = 1;
3026 dev_dbg(&port_dev->dev, "status %04x.%04x after resume, %d\n",
3027 portchange, portstatus, status);
3028 } else if (udev->reset_resume) {
3030 /* Late port handoff can set status-change bits */
3031 if (portchange & USB_PORT_STAT_C_CONNECTION)
3032 usb_clear_port_feature(hub->hdev, port1,
3033 USB_PORT_FEAT_C_CONNECTION);
3034 if (portchange & USB_PORT_STAT_C_ENABLE)
3035 usb_clear_port_feature(hub->hdev, port1,
3036 USB_PORT_FEAT_C_ENABLE);
3039 * Whatever made this reset-resume necessary may have
3040 * turned on the port1 bit in hub->change_bits. But after
3041 * a successful reset-resume we want the bit to be clear;
3042 * if it was on it would indicate that something happened
3043 * following the reset-resume.
3045 clear_bit(port1, hub->change_bits);
3051 int usb_disable_ltm(struct usb_device *udev)
3053 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3055 /* Check if the roothub and device supports LTM. */
3056 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
3057 !usb_device_supports_ltm(udev))
3060 /* Clear Feature LTM Enable can only be sent if the device is
3063 if (!udev->actconfig)
3066 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3067 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
3068 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
3069 USB_CTRL_SET_TIMEOUT);
3071 EXPORT_SYMBOL_GPL(usb_disable_ltm);
3073 void usb_enable_ltm(struct usb_device *udev)
3075 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3077 /* Check if the roothub and device supports LTM. */
3078 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
3079 !usb_device_supports_ltm(udev))
3082 /* Set Feature LTM Enable can only be sent if the device is
3085 if (!udev->actconfig)
3088 usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3089 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
3090 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
3091 USB_CTRL_SET_TIMEOUT);
3093 EXPORT_SYMBOL_GPL(usb_enable_ltm);
3096 * usb_enable_remote_wakeup - enable remote wakeup for a device
3097 * @udev: target device
3099 * For USB-2 devices: Set the device's remote wakeup feature.
3101 * For USB-3 devices: Assume there's only one function on the device and
3102 * enable remote wake for the first interface. FIXME if the interface
3103 * association descriptor shows there's more than one function.
3105 static int usb_enable_remote_wakeup(struct usb_device *udev)
3107 if (udev->speed < USB_SPEED_SUPER)
3108 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3109 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
3110 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
3111 USB_CTRL_SET_TIMEOUT);
3113 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3114 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
3115 USB_INTRF_FUNC_SUSPEND,
3116 USB_INTRF_FUNC_SUSPEND_RW |
3117 USB_INTRF_FUNC_SUSPEND_LP,
3118 NULL, 0, USB_CTRL_SET_TIMEOUT);
3122 * usb_disable_remote_wakeup - disable remote wakeup for a device
3123 * @udev: target device
3125 * For USB-2 devices: Clear the device's remote wakeup feature.
3127 * For USB-3 devices: Assume there's only one function on the device and
3128 * disable remote wake for the first interface. FIXME if the interface
3129 * association descriptor shows there's more than one function.
3131 static int usb_disable_remote_wakeup(struct usb_device *udev)
3133 if (udev->speed < USB_SPEED_SUPER)
3134 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3135 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
3136 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
3137 USB_CTRL_SET_TIMEOUT);
3139 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3140 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
3141 USB_INTRF_FUNC_SUSPEND, 0, NULL, 0,
3142 USB_CTRL_SET_TIMEOUT);
3145 /* Count of wakeup-enabled devices at or below udev */
3146 static unsigned wakeup_enabled_descendants(struct usb_device *udev)
3148 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
3150 return udev->do_remote_wakeup +
3151 (hub ? hub->wakeup_enabled_descendants : 0);
3155 * usb_port_suspend - suspend a usb device's upstream port
3156 * @udev: device that's no longer in active use, not a root hub
3157 * Context: must be able to sleep; device not locked; pm locks held
3159 * Suspends a USB device that isn't in active use, conserving power.
3160 * Devices may wake out of a suspend, if anything important happens,
3161 * using the remote wakeup mechanism. They may also be taken out of
3162 * suspend by the host, using usb_port_resume(). It's also routine
3163 * to disconnect devices while they are suspended.
3165 * This only affects the USB hardware for a device; its interfaces
3166 * (and, for hubs, child devices) must already have been suspended.
3168 * Selective port suspend reduces power; most suspended devices draw
3169 * less than 500 uA. It's also used in OTG, along with remote wakeup.
3170 * All devices below the suspended port are also suspended.
3172 * Devices leave suspend state when the host wakes them up. Some devices
3173 * also support "remote wakeup", where the device can activate the USB
3174 * tree above them to deliver data, such as a keypress or packet. In
3175 * some cases, this wakes the USB host.
3177 * Suspending OTG devices may trigger HNP, if that's been enabled
3178 * between a pair of dual-role devices. That will change roles, such
3179 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
3181 * Devices on USB hub ports have only one "suspend" state, corresponding
3182 * to ACPI D2, "may cause the device to lose some context".
3183 * State transitions include:
3185 * - suspend, resume ... when the VBUS power link stays live
3186 * - suspend, disconnect ... VBUS lost
3188 * Once VBUS drop breaks the circuit, the port it's using has to go through
3189 * normal re-enumeration procedures, starting with enabling VBUS power.
3190 * Other than re-initializing the hub (plug/unplug, except for root hubs),
3191 * Linux (2.6) currently has NO mechanisms to initiate that: no hub_wq
3192 * timer, no SRP, no requests through sysfs.
3194 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
3195 * suspended until their bus goes into global suspend (i.e., the root
3196 * hub is suspended). Nevertheless, we change @udev->state to
3197 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
3198 * upstream port setting is stored in @udev->port_is_suspended.
3200 * Returns 0 on success, else negative errno.
3202 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
3204 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3205 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3206 int port1 = udev->portnum;
3208 bool really_suspend = true;
3210 usb_lock_port(port_dev);
3212 /* enable remote wakeup when appropriate; this lets the device
3213 * wake up the upstream hub (including maybe the root hub).
3215 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
3216 * we don't explicitly enable it here.
3218 if (udev->do_remote_wakeup) {
3219 status = usb_enable_remote_wakeup(udev);
3221 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
3223 /* bail if autosuspend is requested */
3224 if (PMSG_IS_AUTO(msg))
3229 /* disable USB2 hardware LPM */
3230 usb_disable_usb2_hardware_lpm(udev);
3232 if (usb_disable_ltm(udev)) {
3233 dev_err(&udev->dev, "Failed to disable LTM before suspend\n.");
3235 if (PMSG_IS_AUTO(msg))
3240 if (hub_is_superspeed(hub->hdev))
3241 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U3);
3244 * For system suspend, we do not need to enable the suspend feature
3245 * on individual USB-2 ports. The devices will automatically go
3246 * into suspend a few ms after the root hub stops sending packets.
3247 * The USB 2.0 spec calls this "global suspend".
3249 * However, many USB hubs have a bug: They don't relay wakeup requests
3250 * from a downstream port if the port's suspend feature isn't on.
3251 * Therefore we will turn on the suspend feature if udev or any of its
3252 * descendants is enabled for remote wakeup.
3254 else if (PMSG_IS_AUTO(msg) || wakeup_enabled_descendants(udev) > 0)
3255 status = set_port_feature(hub->hdev, port1,
3256 USB_PORT_FEAT_SUSPEND);
3258 really_suspend = false;
3262 dev_dbg(&port_dev->dev, "can't suspend, status %d\n", status);
3264 /* Try to enable USB3 LTM again */
3265 usb_enable_ltm(udev);
3267 /* Try to enable USB2 hardware LPM again */
3268 usb_enable_usb2_hardware_lpm(udev);
3270 if (udev->do_remote_wakeup)
3271 (void) usb_disable_remote_wakeup(udev);
3274 /* System sleep transitions should never fail */
3275 if (!PMSG_IS_AUTO(msg))
3278 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
3279 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
3280 udev->do_remote_wakeup);
3281 if (really_suspend) {
3282 udev->port_is_suspended = 1;
3284 /* device has up to 10 msec to fully suspend */
3287 usb_set_device_state(udev, USB_STATE_SUSPENDED);
3290 if (status == 0 && !udev->do_remote_wakeup && udev->persist_enabled
3291 && test_and_clear_bit(port1, hub->child_usage_bits))
3292 pm_runtime_put_sync(&port_dev->dev);
3294 usb_mark_last_busy(hub->hdev);
3296 usb_unlock_port(port_dev);
3301 * If the USB "suspend" state is in use (rather than "global suspend"),
3302 * many devices will be individually taken out of suspend state using
3303 * special "resume" signaling. This routine kicks in shortly after
3304 * hardware resume signaling is finished, either because of selective
3305 * resume (by host) or remote wakeup (by device) ... now see what changed
3306 * in the tree that's rooted at this device.
3308 * If @udev->reset_resume is set then the device is reset before the
3309 * status check is done.
3311 static int finish_port_resume(struct usb_device *udev)
3316 /* caller owns the udev device lock */
3317 dev_dbg(&udev->dev, "%s\n",
3318 udev->reset_resume ? "finish reset-resume" : "finish resume");
3320 /* usb ch9 identifies four variants of SUSPENDED, based on what
3321 * state the device resumes to. Linux currently won't see the
3322 * first two on the host side; they'd be inside hub_port_init()
3323 * during many timeouts, but hub_wq can't suspend until later.
3325 usb_set_device_state(udev, udev->actconfig
3326 ? USB_STATE_CONFIGURED
3327 : USB_STATE_ADDRESS);
3329 /* 10.5.4.5 says not to reset a suspended port if the attached
3330 * device is enabled for remote wakeup. Hence the reset
3331 * operation is carried out here, after the port has been
3334 if (udev->reset_resume) {
3336 * If the device morphs or switches modes when it is reset,
3337 * we don't want to perform a reset-resume. We'll fail the
3338 * resume, which will cause a logical disconnect, and then
3339 * the device will be rediscovered.
3342 if (udev->quirks & USB_QUIRK_RESET)
3345 status = usb_reset_and_verify_device(udev);
3348 /* 10.5.4.5 says be sure devices in the tree are still there.
3349 * For now let's assume the device didn't go crazy on resume,
3350 * and device drivers will know about any resume quirks.
3354 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
3356 /* If a normal resume failed, try doing a reset-resume */
3357 if (status && !udev->reset_resume && udev->persist_enabled) {
3358 dev_dbg(&udev->dev, "retry with reset-resume\n");
3359 udev->reset_resume = 1;
3360 goto retry_reset_resume;
3365 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
3368 * There are a few quirky devices which violate the standard
3369 * by claiming to have remote wakeup enabled after a reset,
3370 * which crash if the feature is cleared, hence check for
3371 * udev->reset_resume
3373 } else if (udev->actconfig && !udev->reset_resume) {
3374 if (udev->speed < USB_SPEED_SUPER) {
3375 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
3376 status = usb_disable_remote_wakeup(udev);
3378 status = usb_get_status(udev, USB_RECIP_INTERFACE, 0,
3380 if (!status && devstatus & (USB_INTRF_STAT_FUNC_RW_CAP
3381 | USB_INTRF_STAT_FUNC_RW))
3382 status = usb_disable_remote_wakeup(udev);
3387 "disable remote wakeup, status %d\n",
3395 * There are some SS USB devices which take longer time for link training.
3396 * XHCI specs 4.19.4 says that when Link training is successful, port
3397 * sets CCS bit to 1. So if SW reads port status before successful link
3398 * training, then it will not find device to be present.
3399 * USB Analyzer log with such buggy devices show that in some cases
3400 * device switch on the RX termination after long delay of host enabling
3401 * the VBUS. In few other cases it has been seen that device fails to
3402 * negotiate link training in first attempt. It has been
3403 * reported till now that few devices take as long as 2000 ms to train
3404 * the link after host enabling its VBUS and termination. Following
3405 * routine implements a 2000 ms timeout for link training. If in a case
3406 * link trains before timeout, loop will exit earlier.
3408 * There are also some 2.0 hard drive based devices and 3.0 thumb
3409 * drives that, when plugged into a 2.0 only port, take a long
3410 * time to set CCS after VBUS enable.
3412 * FIXME: If a device was connected before suspend, but was removed
3413 * while system was asleep, then the loop in the following routine will
3414 * only exit at timeout.
3416 * This routine should only be called when persist is enabled.
3418 static int wait_for_connected(struct usb_device *udev,
3419 struct usb_hub *hub, int *port1,
3420 u16 *portchange, u16 *portstatus)
3422 int status = 0, delay_ms = 0;
3424 while (delay_ms < 2000) {
3425 if (status || *portstatus & USB_PORT_STAT_CONNECTION)
3427 if (!port_is_power_on(hub, *portstatus)) {
3433 status = hub_port_status(hub, *port1, portstatus, portchange);
3435 dev_dbg(&udev->dev, "Waited %dms for CONNECT\n", delay_ms);
3440 * usb_port_resume - re-activate a suspended usb device's upstream port
3441 * @udev: device to re-activate, not a root hub
3442 * Context: must be able to sleep; device not locked; pm locks held
3444 * This will re-activate the suspended device, increasing power usage
3445 * while letting drivers communicate again with its endpoints.
3446 * USB resume explicitly guarantees that the power session between
3447 * the host and the device is the same as it was when the device
3450 * If @udev->reset_resume is set then this routine won't check that the
3451 * port is still enabled. Furthermore, finish_port_resume() above will
3452 * reset @udev. The end result is that a broken power session can be
3453 * recovered and @udev will appear to persist across a loss of VBUS power.
3455 * For example, if a host controller doesn't maintain VBUS suspend current
3456 * during a system sleep or is reset when the system wakes up, all the USB
3457 * power sessions below it will be broken. This is especially troublesome
3458 * for mass-storage devices containing mounted filesystems, since the
3459 * device will appear to have disconnected and all the memory mappings
3460 * to it will be lost. Using the USB_PERSIST facility, the device can be
3461 * made to appear as if it had not disconnected.
3463 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3464 * every effort to insure that the same device is present after the
3465 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3466 * quite possible for a device to remain unaltered but its media to be
3467 * changed. If the user replaces a flash memory card while the system is
3468 * asleep, he will have only himself to blame when the filesystem on the
3469 * new card is corrupted and the system crashes.
3471 * Returns 0 on success, else negative errno.
3473 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
3475 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3476 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3477 int port1 = udev->portnum;
3479 u16 portchange, portstatus;
3481 if (!test_and_set_bit(port1, hub->child_usage_bits)) {
3482 status = pm_runtime_get_sync(&port_dev->dev);
3484 dev_dbg(&udev->dev, "can't resume usb port, status %d\n",
3490 usb_lock_port(port_dev);
3492 /* Skip the initial Clear-Suspend step for a remote wakeup */
3493 status = hub_port_status(hub, port1, &portstatus, &portchange);
3494 if (status == 0 && !port_is_suspended(hub, portstatus)) {
3495 if (portchange & USB_PORT_STAT_C_SUSPEND)
3496 pm_wakeup_event(&udev->dev, 0);
3497 goto SuspendCleared;
3500 /* see 7.1.7.7; affects power usage, but not budgeting */
3501 if (hub_is_superspeed(hub->hdev))
3502 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U0);
3504 status = usb_clear_port_feature(hub->hdev,
3505 port1, USB_PORT_FEAT_SUSPEND);
3507 dev_dbg(&port_dev->dev, "can't resume, status %d\n", status);
3509 /* drive resume for USB_RESUME_TIMEOUT msec */
3510 dev_dbg(&udev->dev, "usb %sresume\n",
3511 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
3512 msleep(USB_RESUME_TIMEOUT);
3514 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3515 * stop resume signaling. Then finish the resume
3518 status = hub_port_status(hub, port1, &portstatus, &portchange);
3523 udev->port_is_suspended = 0;
3524 if (hub_is_superspeed(hub->hdev)) {
3525 if (portchange & USB_PORT_STAT_C_LINK_STATE)
3526 usb_clear_port_feature(hub->hdev, port1,
3527 USB_PORT_FEAT_C_PORT_LINK_STATE);
3529 if (portchange & USB_PORT_STAT_C_SUSPEND)
3530 usb_clear_port_feature(hub->hdev, port1,
3531 USB_PORT_FEAT_C_SUSPEND);
3534 /* TRSMRCY = 10 msec */
3538 if (udev->persist_enabled)
3539 status = wait_for_connected(udev, hub, &port1, &portchange,
3542 status = check_port_resume_type(udev,
3543 hub, port1, status, portchange, portstatus);
3545 status = finish_port_resume(udev);
3547 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
3548 hub_port_logical_disconnect(hub, port1);
3550 /* Try to enable USB2 hardware LPM */
3551 usb_enable_usb2_hardware_lpm(udev);
3553 /* Try to enable USB3 LTM */
3554 usb_enable_ltm(udev);
3557 usb_unlock_port(port_dev);
3562 int usb_remote_wakeup(struct usb_device *udev)
3566 usb_lock_device(udev);
3567 if (udev->state == USB_STATE_SUSPENDED) {
3568 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
3569 status = usb_autoresume_device(udev);
3571 /* Let the drivers do their thing, then... */
3572 usb_autosuspend_device(udev);
3575 usb_unlock_device(udev);
3579 /* Returns 1 if there was a remote wakeup and a connect status change. */
3580 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
3581 u16 portstatus, u16 portchange)
3582 __must_hold(&port_dev->status_lock)
3584 struct usb_port *port_dev = hub->ports[port - 1];
3585 struct usb_device *hdev;
3586 struct usb_device *udev;
3587 int connect_change = 0;
3592 udev = port_dev->child;
3593 if (!hub_is_superspeed(hdev)) {
3594 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
3596 usb_clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
3598 link_state = portstatus & USB_PORT_STAT_LINK_STATE;
3599 if (!udev || udev->state != USB_STATE_SUSPENDED ||
3600 (link_state != USB_SS_PORT_LS_U0 &&
3601 link_state != USB_SS_PORT_LS_U1 &&
3602 link_state != USB_SS_PORT_LS_U2))
3607 /* TRSMRCY = 10 msec */
3610 usb_unlock_port(port_dev);
3611 ret = usb_remote_wakeup(udev);
3612 usb_lock_port(port_dev);
3617 hub_port_disable(hub, port, 1);
3619 dev_dbg(&port_dev->dev, "resume, status %d\n", ret);
3620 return connect_change;
3623 static int check_ports_changed(struct usb_hub *hub)
3627 for (port1 = 1; port1 <= hub->hdev->maxchild; ++port1) {
3628 u16 portstatus, portchange;
3631 status = hub_port_status(hub, port1, &portstatus, &portchange);
3632 if (!status && portchange)
3638 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
3640 struct usb_hub *hub = usb_get_intfdata(intf);
3641 struct usb_device *hdev = hub->hdev;
3646 * Warn if children aren't already suspended.
3647 * Also, add up the number of wakeup-enabled descendants.
3649 hub->wakeup_enabled_descendants = 0;
3650 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3651 struct usb_port *port_dev = hub->ports[port1 - 1];
3652 struct usb_device *udev = port_dev->child;
3654 if (udev && udev->can_submit) {
3655 dev_warn(&port_dev->dev, "device %s not suspended yet\n",
3656 dev_name(&udev->dev));
3657 if (PMSG_IS_AUTO(msg))
3661 hub->wakeup_enabled_descendants +=
3662 wakeup_enabled_descendants(udev);
3665 if (hdev->do_remote_wakeup && hub->quirk_check_port_auto_suspend) {
3666 /* check if there are changes pending on hub ports */
3667 if (check_ports_changed(hub)) {
3668 if (PMSG_IS_AUTO(msg))
3670 pm_wakeup_event(&hdev->dev, 2000);
3674 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
3675 /* Enable hub to send remote wakeup for all ports. */
3676 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3677 status = set_port_feature(hdev,
3679 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
3680 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
3681 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
3682 USB_PORT_FEAT_REMOTE_WAKE_MASK);
3686 dev_dbg(&intf->dev, "%s\n", __func__);
3688 /* stop hub_wq and related activity */
3689 hub_quiesce(hub, HUB_SUSPEND);
3693 static int hub_resume(struct usb_interface *intf)
3695 struct usb_hub *hub = usb_get_intfdata(intf);
3697 dev_dbg(&intf->dev, "%s\n", __func__);
3698 hub_activate(hub, HUB_RESUME);
3702 static int hub_reset_resume(struct usb_interface *intf)
3704 struct usb_hub *hub = usb_get_intfdata(intf);
3706 dev_dbg(&intf->dev, "%s\n", __func__);
3707 hub_activate(hub, HUB_RESET_RESUME);
3712 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3713 * @rhdev: struct usb_device for the root hub
3715 * The USB host controller driver calls this function when its root hub
3716 * is resumed and Vbus power has been interrupted or the controller
3717 * has been reset. The routine marks @rhdev as having lost power.
3718 * When the hub driver is resumed it will take notice and carry out
3719 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3720 * the others will be disconnected.
3722 void usb_root_hub_lost_power(struct usb_device *rhdev)
3724 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
3725 rhdev->reset_resume = 1;
3727 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
3729 static const char * const usb3_lpm_names[] = {
3737 * Send a Set SEL control transfer to the device, prior to enabling
3738 * device-initiated U1 or U2. This lets the device know the exit latencies from
3739 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3740 * packet from the host.
3742 * This function will fail if the SEL or PEL values for udev are greater than
3743 * the maximum allowed values for the link state to be enabled.
3745 static int usb_req_set_sel(struct usb_device *udev, enum usb3_link_state state)
3747 struct usb_set_sel_req *sel_values;
3748 unsigned long long u1_sel;
3749 unsigned long long u1_pel;
3750 unsigned long long u2_sel;
3751 unsigned long long u2_pel;
3754 if (udev->state != USB_STATE_CONFIGURED)
3757 /* Convert SEL and PEL stored in ns to us */
3758 u1_sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
3759 u1_pel = DIV_ROUND_UP(udev->u1_params.pel, 1000);
3760 u2_sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
3761 u2_pel = DIV_ROUND_UP(udev->u2_params.pel, 1000);
3764 * Make sure that the calculated SEL and PEL values for the link
3765 * state we're enabling aren't bigger than the max SEL/PEL
3766 * value that will fit in the SET SEL control transfer.
3767 * Otherwise the device would get an incorrect idea of the exit
3768 * latency for the link state, and could start a device-initiated
3769 * U1/U2 when the exit latencies are too high.
3771 if ((state == USB3_LPM_U1 &&
3772 (u1_sel > USB3_LPM_MAX_U1_SEL_PEL ||
3773 u1_pel > USB3_LPM_MAX_U1_SEL_PEL)) ||
3774 (state == USB3_LPM_U2 &&
3775 (u2_sel > USB3_LPM_MAX_U2_SEL_PEL ||
3776 u2_pel > USB3_LPM_MAX_U2_SEL_PEL))) {
3777 dev_dbg(&udev->dev, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3778 usb3_lpm_names[state], u1_sel, u1_pel);
3783 * If we're enabling device-initiated LPM for one link state,
3784 * but the other link state has a too high SEL or PEL value,
3785 * just set those values to the max in the Set SEL request.
3787 if (u1_sel > USB3_LPM_MAX_U1_SEL_PEL)
3788 u1_sel = USB3_LPM_MAX_U1_SEL_PEL;
3790 if (u1_pel > USB3_LPM_MAX_U1_SEL_PEL)
3791 u1_pel = USB3_LPM_MAX_U1_SEL_PEL;
3793 if (u2_sel > USB3_LPM_MAX_U2_SEL_PEL)
3794 u2_sel = USB3_LPM_MAX_U2_SEL_PEL;
3796 if (u2_pel > USB3_LPM_MAX_U2_SEL_PEL)
3797 u2_pel = USB3_LPM_MAX_U2_SEL_PEL;
3800 * usb_enable_lpm() can be called as part of a failed device reset,
3801 * which may be initiated by an error path of a mass storage driver.
3802 * Therefore, use GFP_NOIO.
3804 sel_values = kmalloc(sizeof *(sel_values), GFP_NOIO);
3808 sel_values->u1_sel = u1_sel;
3809 sel_values->u1_pel = u1_pel;
3810 sel_values->u2_sel = cpu_to_le16(u2_sel);
3811 sel_values->u2_pel = cpu_to_le16(u2_pel);
3813 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3817 sel_values, sizeof *(sel_values),
3818 USB_CTRL_SET_TIMEOUT);
3824 * Enable or disable device-initiated U1 or U2 transitions.
3826 static int usb_set_device_initiated_lpm(struct usb_device *udev,
3827 enum usb3_link_state state, bool enable)
3834 feature = USB_DEVICE_U1_ENABLE;
3837 feature = USB_DEVICE_U2_ENABLE;
3840 dev_warn(&udev->dev, "%s: Can't %s non-U1 or U2 state.\n",
3841 __func__, enable ? "enable" : "disable");
3845 if (udev->state != USB_STATE_CONFIGURED) {
3846 dev_dbg(&udev->dev, "%s: Can't %s %s state "
3847 "for unconfigured device.\n",
3848 __func__, enable ? "enable" : "disable",
3849 usb3_lpm_names[state]);
3855 * Now send the control transfer to enable device-initiated LPM
3856 * for either U1 or U2.
3858 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3859 USB_REQ_SET_FEATURE,
3863 USB_CTRL_SET_TIMEOUT);
3865 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3866 USB_REQ_CLEAR_FEATURE,
3870 USB_CTRL_SET_TIMEOUT);
3873 dev_warn(&udev->dev, "%s of device-initiated %s failed.\n",
3874 enable ? "Enable" : "Disable",
3875 usb3_lpm_names[state]);
3881 static int usb_set_lpm_timeout(struct usb_device *udev,
3882 enum usb3_link_state state, int timeout)
3889 feature = USB_PORT_FEAT_U1_TIMEOUT;
3892 feature = USB_PORT_FEAT_U2_TIMEOUT;
3895 dev_warn(&udev->dev, "%s: Can't set timeout for non-U1 or U2 state.\n",
3900 if (state == USB3_LPM_U1 && timeout > USB3_LPM_U1_MAX_TIMEOUT &&
3901 timeout != USB3_LPM_DEVICE_INITIATED) {
3902 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x, "
3903 "which is a reserved value.\n",
3904 usb3_lpm_names[state], timeout);
3908 ret = set_port_feature(udev->parent,
3909 USB_PORT_LPM_TIMEOUT(timeout) | udev->portnum,
3912 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x,"
3913 "error code %i\n", usb3_lpm_names[state],
3917 if (state == USB3_LPM_U1)
3918 udev->u1_params.timeout = timeout;
3920 udev->u2_params.timeout = timeout;
3925 * Don't allow device intiated U1/U2 if the system exit latency + one bus
3926 * interval is greater than the minimum service interval of any active
3927 * periodic endpoint. See USB 3.2 section 9.4.9
3929 static bool usb_device_may_initiate_lpm(struct usb_device *udev,
3930 enum usb3_link_state state)
3932 unsigned int sel; /* us */
3935 if (state == USB3_LPM_U1)
3936 sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
3937 else if (state == USB3_LPM_U2)
3938 sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
3942 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
3943 struct usb_interface *intf;
3944 struct usb_endpoint_descriptor *desc;
3945 unsigned int interval;
3947 intf = udev->actconfig->interface[i];
3951 for (j = 0; j < intf->cur_altsetting->desc.bNumEndpoints; j++) {
3952 desc = &intf->cur_altsetting->endpoint[j].desc;
3954 if (usb_endpoint_xfer_int(desc) ||
3955 usb_endpoint_xfer_isoc(desc)) {
3956 interval = (1 << (desc->bInterval - 1)) * 125;
3957 if (sel + 125 > interval)
3966 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3969 * We will attempt to enable U1 or U2, but there are no guarantees that the
3970 * control transfers to set the hub timeout or enable device-initiated U1/U2
3971 * will be successful.
3973 * If the control transfer to enable device-initiated U1/U2 entry fails, then
3974 * hub-initiated U1/U2 will be disabled.
3976 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3977 * driver know about it. If that call fails, it should be harmless, and just
3978 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3980 static void usb_enable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3981 enum usb3_link_state state)
3987 /* Skip if the device BOS descriptor couldn't be read */
3991 u1_mel = udev->bos->ss_cap->bU1devExitLat;
3992 u2_mel = udev->bos->ss_cap->bU2DevExitLat;
3994 /* If the device says it doesn't have *any* exit latency to come out of
3995 * U1 or U2, it's probably lying. Assume it doesn't implement that link
3998 if ((state == USB3_LPM_U1 && u1_mel == 0) ||
3999 (state == USB3_LPM_U2 && u2_mel == 0))
4003 * First, let the device know about the exit latencies
4004 * associated with the link state we're about to enable.
4006 ret = usb_req_set_sel(udev, state);
4008 dev_warn(&udev->dev, "Set SEL for device-initiated %s failed.\n",
4009 usb3_lpm_names[state]);
4013 /* We allow the host controller to set the U1/U2 timeout internally
4014 * first, so that it can change its schedule to account for the
4015 * additional latency to send data to a device in a lower power
4018 timeout = hcd->driver->enable_usb3_lpm_timeout(hcd, udev, state);
4020 /* xHCI host controller doesn't want to enable this LPM state. */
4025 dev_warn(&udev->dev, "Could not enable %s link state, "
4026 "xHCI error %i.\n", usb3_lpm_names[state],
4031 if (usb_set_lpm_timeout(udev, state, timeout)) {
4032 /* If we can't set the parent hub U1/U2 timeout,
4033 * device-initiated LPM won't be allowed either, so let the xHCI
4034 * host know that this link state won't be enabled.
4036 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
4040 /* Only a configured device will accept the Set Feature
4043 if (udev->actconfig &&
4044 usb_device_may_initiate_lpm(udev, state)) {
4045 if (usb_set_device_initiated_lpm(udev, state, true)) {
4047 * Request to enable device initiated U1/U2 failed,
4048 * better to turn off lpm in this case.
4050 usb_set_lpm_timeout(udev, state, 0);
4051 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
4056 if (state == USB3_LPM_U1)
4057 udev->usb3_lpm_u1_enabled = 1;
4058 else if (state == USB3_LPM_U2)
4059 udev->usb3_lpm_u2_enabled = 1;
4062 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
4065 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
4066 * If zero is returned, the parent will not allow the link to go into U1/U2.
4068 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
4069 * it won't have an effect on the bus link state because the parent hub will
4070 * still disallow device-initiated U1/U2 entry.
4072 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
4073 * possible. The result will be slightly more bus bandwidth will be taken up
4074 * (to account for U1/U2 exit latency), but it should be harmless.
4076 static int usb_disable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
4077 enum usb3_link_state state)
4084 dev_warn(&udev->dev, "%s: Can't disable non-U1 or U2 state.\n",
4089 if (usb_set_lpm_timeout(udev, state, 0))
4092 usb_set_device_initiated_lpm(udev, state, false);
4094 if (hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state))
4095 dev_warn(&udev->dev, "Could not disable xHCI %s timeout, "
4096 "bus schedule bandwidth may be impacted.\n",
4097 usb3_lpm_names[state]);
4099 /* As soon as usb_set_lpm_timeout(0) return 0, hub initiated LPM
4100 * is disabled. Hub will disallows link to enter U1/U2 as well,
4101 * even device is initiating LPM. Hence LPM is disabled if hub LPM
4102 * timeout set to 0, no matter device-initiated LPM is disabled or
4105 if (state == USB3_LPM_U1)
4106 udev->usb3_lpm_u1_enabled = 0;
4107 else if (state == USB3_LPM_U2)
4108 udev->usb3_lpm_u2_enabled = 0;
4114 * Disable hub-initiated and device-initiated U1 and U2 entry.
4115 * Caller must own the bandwidth_mutex.
4117 * This will call usb_enable_lpm() on failure, which will decrement
4118 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
4120 int usb_disable_lpm(struct usb_device *udev)
4122 struct usb_hcd *hcd;
4124 if (!udev || !udev->parent ||
4125 udev->speed < USB_SPEED_SUPER ||
4126 !udev->lpm_capable ||
4127 udev->state < USB_STATE_DEFAULT)
4130 hcd = bus_to_hcd(udev->bus);
4131 if (!hcd || !hcd->driver->disable_usb3_lpm_timeout)
4134 udev->lpm_disable_count++;
4135 if ((udev->u1_params.timeout == 0 && udev->u2_params.timeout == 0))
4138 /* If LPM is enabled, attempt to disable it. */
4139 if (usb_disable_link_state(hcd, udev, USB3_LPM_U1))
4141 if (usb_disable_link_state(hcd, udev, USB3_LPM_U2))
4147 usb_enable_lpm(udev);
4150 EXPORT_SYMBOL_GPL(usb_disable_lpm);
4152 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
4153 int usb_unlocked_disable_lpm(struct usb_device *udev)
4155 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4161 mutex_lock(hcd->bandwidth_mutex);
4162 ret = usb_disable_lpm(udev);
4163 mutex_unlock(hcd->bandwidth_mutex);
4167 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
4170 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
4171 * xHCI host policy may prevent U1 or U2 from being enabled.
4173 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
4174 * until the lpm_disable_count drops to zero. Caller must own the
4177 void usb_enable_lpm(struct usb_device *udev)
4179 struct usb_hcd *hcd;
4180 struct usb_hub *hub;
4181 struct usb_port *port_dev;
4183 if (!udev || !udev->parent ||
4184 udev->speed < USB_SPEED_SUPER ||
4185 !udev->lpm_capable ||
4186 udev->state < USB_STATE_DEFAULT)
4189 udev->lpm_disable_count--;
4190 hcd = bus_to_hcd(udev->bus);
4191 /* Double check that we can both enable and disable LPM.
4192 * Device must be configured to accept set feature U1/U2 timeout.
4194 if (!hcd || !hcd->driver->enable_usb3_lpm_timeout ||
4195 !hcd->driver->disable_usb3_lpm_timeout)
4198 if (udev->lpm_disable_count > 0)
4201 hub = usb_hub_to_struct_hub(udev->parent);
4205 port_dev = hub->ports[udev->portnum - 1];
4207 if (port_dev->usb3_lpm_u1_permit)
4208 usb_enable_link_state(hcd, udev, USB3_LPM_U1);
4210 if (port_dev->usb3_lpm_u2_permit)
4211 usb_enable_link_state(hcd, udev, USB3_LPM_U2);
4213 EXPORT_SYMBOL_GPL(usb_enable_lpm);
4215 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
4216 void usb_unlocked_enable_lpm(struct usb_device *udev)
4218 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4223 mutex_lock(hcd->bandwidth_mutex);
4224 usb_enable_lpm(udev);
4225 mutex_unlock(hcd->bandwidth_mutex);
4227 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
4229 /* usb3 devices use U3 for disabled, make sure remote wakeup is disabled */
4230 static void hub_usb3_port_prepare_disable(struct usb_hub *hub,
4231 struct usb_port *port_dev)
4233 struct usb_device *udev = port_dev->child;
4236 if (udev && udev->port_is_suspended && udev->do_remote_wakeup) {
4237 ret = hub_set_port_link_state(hub, port_dev->portnum,
4240 msleep(USB_RESUME_TIMEOUT);
4241 ret = usb_disable_remote_wakeup(udev);
4244 dev_warn(&udev->dev,
4245 "Port disable: can't disable remote wake\n");
4246 udev->do_remote_wakeup = 0;
4250 #else /* CONFIG_PM */
4252 #define hub_suspend NULL
4253 #define hub_resume NULL
4254 #define hub_reset_resume NULL
4256 static inline void hub_usb3_port_prepare_disable(struct usb_hub *hub,
4257 struct usb_port *port_dev) { }
4259 int usb_disable_lpm(struct usb_device *udev)
4263 EXPORT_SYMBOL_GPL(usb_disable_lpm);
4265 void usb_enable_lpm(struct usb_device *udev) { }
4266 EXPORT_SYMBOL_GPL(usb_enable_lpm);
4268 int usb_unlocked_disable_lpm(struct usb_device *udev)
4272 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
4274 void usb_unlocked_enable_lpm(struct usb_device *udev) { }
4275 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
4277 int usb_disable_ltm(struct usb_device *udev)
4281 EXPORT_SYMBOL_GPL(usb_disable_ltm);
4283 void usb_enable_ltm(struct usb_device *udev) { }
4284 EXPORT_SYMBOL_GPL(usb_enable_ltm);
4286 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
4287 u16 portstatus, u16 portchange)
4292 #endif /* CONFIG_PM */
4295 * USB-3 does not have a similar link state as USB-2 that will avoid negotiating
4296 * a connection with a plugged-in cable but will signal the host when the cable
4297 * is unplugged. Disable remote wake and set link state to U3 for USB-3 devices
4299 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
4301 struct usb_port *port_dev = hub->ports[port1 - 1];
4302 struct usb_device *hdev = hub->hdev;
4306 if (hub_is_superspeed(hub->hdev)) {
4307 hub_usb3_port_prepare_disable(hub, port_dev);
4308 ret = hub_set_port_link_state(hub, port_dev->portnum,
4311 ret = usb_clear_port_feature(hdev, port1,
4312 USB_PORT_FEAT_ENABLE);
4315 if (port_dev->child && set_state)
4316 usb_set_device_state(port_dev->child, USB_STATE_NOTATTACHED);
4317 if (ret && ret != -ENODEV)
4318 dev_err(&port_dev->dev, "cannot disable (err = %d)\n", ret);
4323 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
4325 * Between connect detection and reset signaling there must be a delay
4326 * of 100ms at least for debounce and power-settling. The corresponding
4327 * timer shall restart whenever the downstream port detects a disconnect.
4329 * Apparently there are some bluetooth and irda-dongles and a number of
4330 * low-speed devices for which this debounce period may last over a second.
4331 * Not covered by the spec - but easy to deal with.
4333 * This implementation uses a 1500ms total debounce timeout; if the
4334 * connection isn't stable by then it returns -ETIMEDOUT. It checks
4335 * every 25ms for transient disconnects. When the port status has been
4336 * unchanged for 100ms it returns the port status.
4338 int hub_port_debounce(struct usb_hub *hub, int port1, bool must_be_connected)
4341 u16 portchange, portstatus;
4342 unsigned connection = 0xffff;
4343 int total_time, stable_time = 0;
4344 struct usb_port *port_dev = hub->ports[port1 - 1];
4346 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
4347 ret = hub_port_status(hub, port1, &portstatus, &portchange);
4351 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
4352 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
4353 if (!must_be_connected ||
4354 (connection == USB_PORT_STAT_CONNECTION))
4355 stable_time += HUB_DEBOUNCE_STEP;
4356 if (stable_time >= HUB_DEBOUNCE_STABLE)
4360 connection = portstatus & USB_PORT_STAT_CONNECTION;
4363 if (portchange & USB_PORT_STAT_C_CONNECTION) {
4364 usb_clear_port_feature(hub->hdev, port1,
4365 USB_PORT_FEAT_C_CONNECTION);
4368 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
4370 msleep(HUB_DEBOUNCE_STEP);
4373 dev_dbg(&port_dev->dev, "debounce total %dms stable %dms status 0x%x\n",
4374 total_time, stable_time, portstatus);
4376 if (stable_time < HUB_DEBOUNCE_STABLE)
4381 void usb_ep0_reinit(struct usb_device *udev)
4383 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
4384 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
4385 usb_enable_endpoint(udev, &udev->ep0, true);
4387 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
4389 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
4390 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
4392 static int hub_set_address(struct usb_device *udev, int devnum)
4395 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4398 * The host controller will choose the device address,
4399 * instead of the core having chosen it earlier
4401 if (!hcd->driver->address_device && devnum <= 1)
4403 if (udev->state == USB_STATE_ADDRESS)
4405 if (udev->state != USB_STATE_DEFAULT)
4407 if (hcd->driver->address_device)
4408 retval = hcd->driver->address_device(hcd, udev);
4410 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
4411 USB_REQ_SET_ADDRESS, 0, devnum, 0,
4412 NULL, 0, USB_CTRL_SET_TIMEOUT);
4414 update_devnum(udev, devnum);
4415 /* Device now using proper address. */
4416 usb_set_device_state(udev, USB_STATE_ADDRESS);
4417 usb_ep0_reinit(udev);
4423 * There are reports of USB 3.0 devices that say they support USB 2.0 Link PM
4424 * when they're plugged into a USB 2.0 port, but they don't work when LPM is
4427 * Only enable USB 2.0 Link PM if the port is internal (hardwired), or the
4428 * device says it supports the new USB 2.0 Link PM errata by setting the BESL
4429 * support bit in the BOS descriptor.
4431 static void hub_set_initial_usb2_lpm_policy(struct usb_device *udev)
4433 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
4434 int connect_type = USB_PORT_CONNECT_TYPE_UNKNOWN;
4436 if (!udev->usb2_hw_lpm_capable || !udev->bos)
4440 connect_type = hub->ports[udev->portnum - 1]->connect_type;
4442 if ((udev->bos->ext_cap->bmAttributes & cpu_to_le32(USB_BESL_SUPPORT)) ||
4443 connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
4444 udev->usb2_hw_lpm_allowed = 1;
4445 usb_enable_usb2_hardware_lpm(udev);
4449 static int hub_enable_device(struct usb_device *udev)
4451 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4453 if (!hcd->driver->enable_device)
4455 if (udev->state == USB_STATE_ADDRESS)
4457 if (udev->state != USB_STATE_DEFAULT)
4460 return hcd->driver->enable_device(hcd, udev);
4463 /* Reset device, (re)assign address, get device descriptor.
4464 * Device connection must be stable, no more debouncing needed.
4465 * Returns device in USB_STATE_ADDRESS, except on error.
4467 * If this is called for an already-existing device (as part of
4468 * usb_reset_and_verify_device), the caller must own the device lock and
4469 * the port lock. For a newly detected device that is not accessible
4470 * through any global pointers, it's not necessary to lock the device,
4471 * but it is still necessary to lock the port.
4474 hub_port_init(struct usb_hub *hub, struct usb_device *udev, int port1,
4477 struct usb_device *hdev = hub->hdev;
4478 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4479 int retries, operations, retval, i;
4480 unsigned delay = HUB_SHORT_RESET_TIME;
4481 enum usb_device_speed oldspeed = udev->speed;
4483 int devnum = udev->devnum;
4484 const char *driver_name;
4486 /* root hub ports have a slightly longer reset period
4487 * (from USB 2.0 spec, section 7.1.7.5)
4489 if (!hdev->parent) {
4490 delay = HUB_ROOT_RESET_TIME;
4491 if (port1 == hdev->bus->otg_port)
4492 hdev->bus->b_hnp_enable = 0;
4495 /* Some low speed devices have problems with the quick delay, so */
4496 /* be a bit pessimistic with those devices. RHbug #23670 */
4497 if (oldspeed == USB_SPEED_LOW)
4498 delay = HUB_LONG_RESET_TIME;
4500 /* Reset the device; full speed may morph to high speed */
4501 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
4502 retval = hub_port_reset(hub, port1, udev, delay, false);
4503 if (retval < 0) /* error or disconnect */
4505 /* success, speed is known */
4509 /* Don't allow speed changes at reset, except usb 3.0 to faster */
4510 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed &&
4511 !(oldspeed == USB_SPEED_SUPER && udev->speed > oldspeed)) {
4512 dev_dbg(&udev->dev, "device reset changed speed!\n");
4515 oldspeed = udev->speed;
4517 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4518 * it's fixed size except for full speed devices.
4519 * For Wireless USB devices, ep0 max packet is always 512 (tho
4520 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4522 switch (udev->speed) {
4523 case USB_SPEED_SUPER_PLUS:
4524 case USB_SPEED_SUPER:
4525 case USB_SPEED_WIRELESS: /* fixed at 512 */
4526 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
4528 case USB_SPEED_HIGH: /* fixed at 64 */
4529 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4531 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
4532 /* to determine the ep0 maxpacket size, try to read
4533 * the device descriptor to get bMaxPacketSize0 and
4534 * then correct our initial guess.
4536 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4538 case USB_SPEED_LOW: /* fixed at 8 */
4539 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
4545 if (udev->speed == USB_SPEED_WIRELESS)
4546 speed = "variable speed Wireless";
4548 speed = usb_speed_string(udev->speed);
4551 * The controller driver may be NULL if the controller device
4552 * is the middle device between platform device and roothub.
4553 * This middle device may not need a device driver due to
4554 * all hardware control can be at platform device driver, this
4555 * platform device is usually a dual-role USB controller device.
4557 if (udev->bus->controller->driver)
4558 driver_name = udev->bus->controller->driver->name;
4560 driver_name = udev->bus->sysdev->driver->name;
4562 if (udev->speed < USB_SPEED_SUPER)
4563 dev_info(&udev->dev,
4564 "%s %s USB device number %d using %s\n",
4565 (udev->config) ? "reset" : "new", speed,
4566 devnum, driver_name);
4568 /* Set up TT records, if needed */
4570 udev->tt = hdev->tt;
4571 udev->ttport = hdev->ttport;
4572 } else if (udev->speed != USB_SPEED_HIGH
4573 && hdev->speed == USB_SPEED_HIGH) {
4575 dev_err(&udev->dev, "parent hub has no TT\n");
4579 udev->tt = &hub->tt;
4580 udev->ttport = port1;
4583 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4584 * Because device hardware and firmware is sometimes buggy in
4585 * this area, and this is how Linux has done it for ages.
4586 * Change it cautiously.
4588 * NOTE: If use_new_scheme() is true we will start by issuing
4589 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4590 * so it may help with some non-standards-compliant devices.
4591 * Otherwise we start with SET_ADDRESS and then try to read the
4592 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4595 for (retries = 0; retries < GET_DESCRIPTOR_TRIES; (++retries, msleep(100))) {
4596 bool did_new_scheme = false;
4598 if (use_new_scheme(udev, retry_counter)) {
4599 struct usb_device_descriptor *buf;
4602 did_new_scheme = true;
4603 retval = hub_enable_device(udev);
4606 "hub failed to enable device, error %d\n",
4611 #define GET_DESCRIPTOR_BUFSIZE 64
4612 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
4618 /* Retry on all errors; some devices are flakey.
4619 * 255 is for WUSB devices, we actually need to use
4620 * 512 (WUSB1.0[4.8.1]).
4622 for (operations = 0; operations < 3; ++operations) {
4623 buf->bMaxPacketSize0 = 0;
4624 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
4625 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
4626 USB_DT_DEVICE << 8, 0,
4627 buf, GET_DESCRIPTOR_BUFSIZE,
4628 initial_descriptor_timeout);
4629 switch (buf->bMaxPacketSize0) {
4630 case 8: case 16: case 32: case 64: case 255:
4631 if (buf->bDescriptorType ==
4643 * Some devices time out if they are powered on
4644 * when already connected. They need a second
4645 * reset. But only on the first attempt,
4646 * lest we get into a time out/reset loop
4648 if (r == 0 || (r == -ETIMEDOUT &&
4650 udev->speed > USB_SPEED_FULL))
4653 udev->descriptor.bMaxPacketSize0 =
4654 buf->bMaxPacketSize0;
4657 retval = hub_port_reset(hub, port1, udev, delay, false);
4658 if (retval < 0) /* error or disconnect */
4660 if (oldspeed != udev->speed) {
4662 "device reset changed speed!\n");
4668 dev_err(&udev->dev, "device descriptor read/64, error %d\n",
4673 #undef GET_DESCRIPTOR_BUFSIZE
4677 * If device is WUSB, we already assigned an
4678 * unauthorized address in the Connect Ack sequence;
4679 * authorization will assign the final address.
4681 if (udev->wusb == 0) {
4682 for (operations = 0; operations < SET_ADDRESS_TRIES; ++operations) {
4683 retval = hub_set_address(udev, devnum);
4689 if (retval != -ENODEV)
4690 dev_err(&udev->dev, "device not accepting address %d, error %d\n",
4694 if (udev->speed >= USB_SPEED_SUPER) {
4695 devnum = udev->devnum;
4696 dev_info(&udev->dev,
4697 "%s SuperSpeed%s USB device number %d using %s\n",
4698 (udev->config) ? "reset" : "new",
4699 (udev->speed == USB_SPEED_SUPER_PLUS) ? "Plus" : "",
4700 devnum, driver_name);
4703 /* cope with hardware quirkiness:
4704 * - let SET_ADDRESS settle, some device hardware wants it
4705 * - read ep0 maxpacket even for high and low speed,
4708 /* use_new_scheme() checks the speed which may have
4709 * changed since the initial look so we cache the result
4716 retval = usb_get_device_descriptor(udev, 8);
4718 if (retval != -ENODEV)
4720 "device descriptor read/8, error %d\n",
4733 * Some superspeed devices have finished the link training process
4734 * and attached to a superspeed hub port, but the device descriptor
4735 * got from those devices show they aren't superspeed devices. Warm
4736 * reset the port attached by the devices can fix them.
4738 if ((udev->speed >= USB_SPEED_SUPER) &&
4739 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
4740 dev_err(&udev->dev, "got a wrong device descriptor, "
4741 "warm reset device\n");
4742 hub_port_reset(hub, port1, udev,
4743 HUB_BH_RESET_TIME, true);
4748 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
4749 udev->speed >= USB_SPEED_SUPER)
4752 i = udev->descriptor.bMaxPacketSize0;
4753 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
4754 if (udev->speed == USB_SPEED_LOW ||
4755 !(i == 8 || i == 16 || i == 32 || i == 64)) {
4756 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
4760 if (udev->speed == USB_SPEED_FULL)
4761 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
4763 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
4764 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
4765 usb_ep0_reinit(udev);
4768 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
4769 if (retval < (signed)sizeof(udev->descriptor)) {
4770 if (retval != -ENODEV)
4771 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
4778 usb_detect_quirks(udev);
4780 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
4781 retval = usb_get_bos_descriptor(udev);
4783 udev->lpm_capable = usb_device_supports_lpm(udev);
4784 usb_set_lpm_parameters(udev);
4789 /* notify HCD that we have a device connected and addressed */
4790 if (hcd->driver->update_device)
4791 hcd->driver->update_device(hcd, udev);
4792 hub_set_initial_usb2_lpm_policy(udev);
4795 hub_port_disable(hub, port1, 0);
4796 update_devnum(udev, devnum); /* for disconnect processing */
4802 check_highspeed(struct usb_hub *hub, struct usb_device *udev, int port1)
4804 struct usb_qualifier_descriptor *qual;
4807 if (udev->quirks & USB_QUIRK_DEVICE_QUALIFIER)
4810 qual = kmalloc(sizeof *qual, GFP_KERNEL);
4814 status = usb_get_descriptor(udev, USB_DT_DEVICE_QUALIFIER, 0,
4815 qual, sizeof *qual);
4816 if (status == sizeof *qual) {
4817 dev_info(&udev->dev, "not running at top speed; "
4818 "connect to a high speed hub\n");
4819 /* hub LEDs are probably harder to miss than syslog */
4820 if (hub->has_indicators) {
4821 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
4822 queue_delayed_work(system_power_efficient_wq,
4830 hub_power_remaining(struct usb_hub *hub)
4832 struct usb_device *hdev = hub->hdev;
4836 if (!hub->limited_power)
4839 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
4840 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
4841 struct usb_port *port_dev = hub->ports[port1 - 1];
4842 struct usb_device *udev = port_dev->child;
4848 if (hub_is_superspeed(udev))
4854 * Unconfigured devices may not use more than one unit load,
4855 * or 8mA for OTG ports
4857 if (udev->actconfig)
4858 delta = usb_get_max_power(udev, udev->actconfig);
4859 else if (port1 != udev->bus->otg_port || hdev->parent)
4863 if (delta > hub->mA_per_port)
4864 dev_warn(&port_dev->dev, "%dmA is over %umA budget!\n",
4865 delta, hub->mA_per_port);
4868 if (remaining < 0) {
4869 dev_warn(hub->intfdev, "%dmA over power budget!\n",
4876 static void hub_port_connect(struct usb_hub *hub, int port1, u16 portstatus,
4879 int status = -ENODEV;
4882 struct usb_device *hdev = hub->hdev;
4883 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4884 struct usb_port *port_dev = hub->ports[port1 - 1];
4885 struct usb_device *udev = port_dev->child;
4886 static int unreliable_port = -1;
4889 /* Disconnect any existing devices under this port */
4891 if (hcd->usb_phy && !hdev->parent)
4892 usb_phy_notify_disconnect(hcd->usb_phy, udev->speed);
4893 usb_disconnect(&port_dev->child);
4896 /* We can forget about a "removed" device when there's a physical
4897 * disconnect or the connect status changes.
4899 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4900 (portchange & USB_PORT_STAT_C_CONNECTION))
4901 clear_bit(port1, hub->removed_bits);
4903 if (portchange & (USB_PORT_STAT_C_CONNECTION |
4904 USB_PORT_STAT_C_ENABLE)) {
4905 status = hub_port_debounce_be_stable(hub, port1);
4907 if (status != -ENODEV &&
4908 port1 != unreliable_port &&
4910 dev_err(&port_dev->dev, "connect-debounce failed\n");
4911 portstatus &= ~USB_PORT_STAT_CONNECTION;
4912 unreliable_port = port1;
4914 portstatus = status;
4918 /* Return now if debouncing failed or nothing is connected or
4919 * the device was "removed".
4921 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4922 test_bit(port1, hub->removed_bits)) {
4925 * maybe switch power back on (e.g. root hub was reset)
4926 * but only if the port isn't owned by someone else.
4928 if (hub_is_port_power_switchable(hub)
4929 && !port_is_power_on(hub, portstatus)
4930 && !port_dev->port_owner)
4931 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
4933 if (portstatus & USB_PORT_STAT_ENABLE)
4937 if (hub_is_superspeed(hub->hdev))
4944 for (i = 0; i < SET_CONFIG_TRIES; i++) {
4945 usb_lock_port(port_dev);
4946 mutex_lock(hcd->address0_mutex);
4947 retry_locked = true;
4949 /* reallocate for each attempt, since references
4950 * to the previous one can escape in various ways
4952 udev = usb_alloc_dev(hdev, hdev->bus, port1);
4954 dev_err(&port_dev->dev,
4955 "couldn't allocate usb_device\n");
4956 mutex_unlock(hcd->address0_mutex);
4957 usb_unlock_port(port_dev);
4961 usb_set_device_state(udev, USB_STATE_POWERED);
4962 udev->bus_mA = hub->mA_per_port;
4963 udev->level = hdev->level + 1;
4964 udev->wusb = hub_is_wusb(hub);
4966 /* Devices connected to SuperSpeed hubs are USB 3.0 or later */
4967 if (hub_is_superspeed(hub->hdev))
4968 udev->speed = USB_SPEED_SUPER;
4970 udev->speed = USB_SPEED_UNKNOWN;
4972 choose_devnum(udev);
4973 if (udev->devnum <= 0) {
4974 status = -ENOTCONN; /* Don't retry */
4978 /* reset (non-USB 3.0 devices) and get descriptor */
4979 status = hub_port_init(hub, udev, port1, i);
4983 mutex_unlock(hcd->address0_mutex);
4984 usb_unlock_port(port_dev);
4985 retry_locked = false;
4987 if (udev->quirks & USB_QUIRK_DELAY_INIT)
4990 /* consecutive bus-powered hubs aren't reliable; they can
4991 * violate the voltage drop budget. if the new child has
4992 * a "powered" LED, users should notice we didn't enable it
4993 * (without reading syslog), even without per-port LEDs
4996 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
4997 && udev->bus_mA <= unit_load) {
5000 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
5003 dev_dbg(&udev->dev, "get status %d ?\n", status);
5006 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
5008 "can't connect bus-powered hub "
5010 if (hub->has_indicators) {
5011 hub->indicator[port1-1] =
5012 INDICATOR_AMBER_BLINK;
5014 system_power_efficient_wq,
5017 status = -ENOTCONN; /* Don't retry */
5022 /* check for devices running slower than they could */
5023 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
5024 && udev->speed == USB_SPEED_FULL
5025 && highspeed_hubs != 0)
5026 check_highspeed(hub, udev, port1);
5028 /* Store the parent's children[] pointer. At this point
5029 * udev becomes globally accessible, although presumably
5030 * no one will look at it until hdev is unlocked.
5034 mutex_lock(&usb_port_peer_mutex);
5036 /* We mustn't add new devices if the parent hub has
5037 * been disconnected; we would race with the
5038 * recursively_mark_NOTATTACHED() routine.
5040 spin_lock_irq(&device_state_lock);
5041 if (hdev->state == USB_STATE_NOTATTACHED)
5044 port_dev->child = udev;
5045 spin_unlock_irq(&device_state_lock);
5046 mutex_unlock(&usb_port_peer_mutex);
5048 /* Run it through the hoops (find a driver, etc) */
5050 status = usb_new_device(udev);
5052 mutex_lock(&usb_port_peer_mutex);
5053 spin_lock_irq(&device_state_lock);
5054 port_dev->child = NULL;
5055 spin_unlock_irq(&device_state_lock);
5056 mutex_unlock(&usb_port_peer_mutex);
5058 if (hcd->usb_phy && !hdev->parent)
5059 usb_phy_notify_connect(hcd->usb_phy,
5067 status = hub_power_remaining(hub);
5069 dev_dbg(hub->intfdev, "%dmA power budget left\n", status);
5074 hub_port_disable(hub, port1, 1);
5076 usb_ep0_reinit(udev);
5077 release_devnum(udev);
5080 mutex_unlock(hcd->address0_mutex);
5081 usb_unlock_port(port_dev);
5084 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
5087 /* When halfway through our retry count, power-cycle the port */
5088 if (i == (SET_CONFIG_TRIES / 2) - 1) {
5089 dev_info(&port_dev->dev, "attempt power cycle\n");
5090 usb_hub_set_port_power(hdev, hub, port1, false);
5091 msleep(2 * hub_power_on_good_delay(hub));
5092 usb_hub_set_port_power(hdev, hub, port1, true);
5093 msleep(hub_power_on_good_delay(hub));
5096 if (hub->hdev->parent ||
5097 !hcd->driver->port_handed_over ||
5098 !(hcd->driver->port_handed_over)(hcd, port1)) {
5099 if (status != -ENOTCONN && status != -ENODEV)
5100 dev_err(&port_dev->dev,
5101 "unable to enumerate USB device\n");
5105 hub_port_disable(hub, port1, 1);
5106 if (hcd->driver->relinquish_port && !hub->hdev->parent) {
5107 if (status != -ENOTCONN && status != -ENODEV)
5108 hcd->driver->relinquish_port(hcd, port1);
5112 /* Handle physical or logical connection change events.
5113 * This routine is called when:
5114 * a port connection-change occurs;
5115 * a port enable-change occurs (often caused by EMI);
5116 * usb_reset_and_verify_device() encounters changed descriptors (as from
5117 * a firmware download)
5118 * caller already locked the hub
5120 static void hub_port_connect_change(struct usb_hub *hub, int port1,
5121 u16 portstatus, u16 portchange)
5122 __must_hold(&port_dev->status_lock)
5124 struct usb_port *port_dev = hub->ports[port1 - 1];
5125 struct usb_device *udev = port_dev->child;
5126 int status = -ENODEV;
5128 dev_dbg(&port_dev->dev, "status %04x, change %04x, %s\n", portstatus,
5129 portchange, portspeed(hub, portstatus));
5131 if (hub->has_indicators) {
5132 set_port_led(hub, port1, HUB_LED_AUTO);
5133 hub->indicator[port1-1] = INDICATOR_AUTO;
5136 #ifdef CONFIG_USB_OTG
5137 /* during HNP, don't repeat the debounce */
5138 if (hub->hdev->bus->is_b_host)
5139 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
5140 USB_PORT_STAT_C_ENABLE);
5143 /* Try to resuscitate an existing device */
5144 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
5145 udev->state != USB_STATE_NOTATTACHED) {
5146 if (portstatus & USB_PORT_STAT_ENABLE) {
5147 status = 0; /* Nothing to do */
5149 } else if (udev->state == USB_STATE_SUSPENDED &&
5150 udev->persist_enabled) {
5151 /* For a suspended device, treat this as a
5152 * remote wakeup event.
5154 usb_unlock_port(port_dev);
5155 status = usb_remote_wakeup(udev);
5156 usb_lock_port(port_dev);
5159 /* Don't resuscitate */;
5162 clear_bit(port1, hub->change_bits);
5164 /* successfully revalidated the connection */
5168 usb_unlock_port(port_dev);
5169 hub_port_connect(hub, port1, portstatus, portchange);
5170 usb_lock_port(port_dev);
5173 static void port_event(struct usb_hub *hub, int port1)
5174 __must_hold(&port_dev->status_lock)
5177 struct usb_port *port_dev = hub->ports[port1 - 1];
5178 struct usb_device *udev = port_dev->child;
5179 struct usb_device *hdev = hub->hdev;
5180 u16 portstatus, portchange;
5182 connect_change = test_bit(port1, hub->change_bits);
5183 clear_bit(port1, hub->event_bits);
5184 clear_bit(port1, hub->wakeup_bits);
5186 if (hub_port_status(hub, port1, &portstatus, &portchange) < 0)
5189 if (portchange & USB_PORT_STAT_C_CONNECTION) {
5190 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_CONNECTION);
5194 if (portchange & USB_PORT_STAT_C_ENABLE) {
5195 if (!connect_change)
5196 dev_dbg(&port_dev->dev, "enable change, status %08x\n",
5198 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_ENABLE);
5201 * EM interference sometimes causes badly shielded USB devices
5202 * to be shutdown by the hub, this hack enables them again.
5203 * Works at least with mouse driver.
5205 if (!(portstatus & USB_PORT_STAT_ENABLE)
5206 && !connect_change && udev) {
5207 dev_err(&port_dev->dev, "disabled by hub (EMI?), re-enabling...\n");
5212 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
5213 u16 status = 0, unused;
5215 dev_dbg(&port_dev->dev, "over-current change\n");
5216 usb_clear_port_feature(hdev, port1,
5217 USB_PORT_FEAT_C_OVER_CURRENT);
5218 msleep(100); /* Cool down */
5219 hub_power_on(hub, true);
5220 hub_port_status(hub, port1, &status, &unused);
5221 if (status & USB_PORT_STAT_OVERCURRENT)
5222 dev_err(&port_dev->dev, "over-current condition\n");
5225 if (portchange & USB_PORT_STAT_C_RESET) {
5226 dev_dbg(&port_dev->dev, "reset change\n");
5227 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_RESET);
5229 if ((portchange & USB_PORT_STAT_C_BH_RESET)
5230 && hub_is_superspeed(hdev)) {
5231 dev_dbg(&port_dev->dev, "warm reset change\n");
5232 usb_clear_port_feature(hdev, port1,
5233 USB_PORT_FEAT_C_BH_PORT_RESET);
5235 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
5236 dev_dbg(&port_dev->dev, "link state change\n");
5237 usb_clear_port_feature(hdev, port1,
5238 USB_PORT_FEAT_C_PORT_LINK_STATE);
5240 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
5241 dev_warn(&port_dev->dev, "config error\n");
5242 usb_clear_port_feature(hdev, port1,
5243 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
5246 /* skip port actions that require the port to be powered on */
5247 if (!pm_runtime_active(&port_dev->dev))
5250 if (hub_handle_remote_wakeup(hub, port1, portstatus, portchange))
5254 * Warm reset a USB3 protocol port if it's in
5255 * SS.Inactive state.
5257 if (hub_port_warm_reset_required(hub, port1, portstatus)) {
5258 dev_dbg(&port_dev->dev, "do warm reset\n");
5259 if (!udev || !(portstatus & USB_PORT_STAT_CONNECTION)
5260 || udev->state == USB_STATE_NOTATTACHED) {
5261 if (hub_port_reset(hub, port1, NULL,
5262 HUB_BH_RESET_TIME, true) < 0)
5263 hub_port_disable(hub, port1, 1);
5265 usb_unlock_port(port_dev);
5266 usb_lock_device(udev);
5267 usb_reset_device(udev);
5268 usb_unlock_device(udev);
5269 usb_lock_port(port_dev);
5275 hub_port_connect_change(hub, port1, portstatus, portchange);
5278 static void hub_event(struct work_struct *work)
5280 struct usb_device *hdev;
5281 struct usb_interface *intf;
5282 struct usb_hub *hub;
5283 struct device *hub_dev;
5288 hub = container_of(work, struct usb_hub, events);
5290 hub_dev = hub->intfdev;
5291 intf = to_usb_interface(hub_dev);
5293 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
5294 hdev->state, hdev->maxchild,
5295 /* NOTE: expects max 15 ports... */
5296 (u16) hub->change_bits[0],
5297 (u16) hub->event_bits[0]);
5299 /* Lock the device, then check to see if we were
5300 * disconnected while waiting for the lock to succeed. */
5301 usb_lock_device(hdev);
5302 if (unlikely(hub->disconnected))
5305 /* If the hub has died, clean up after it */
5306 if (hdev->state == USB_STATE_NOTATTACHED) {
5307 hub->error = -ENODEV;
5308 hub_quiesce(hub, HUB_DISCONNECT);
5313 ret = usb_autopm_get_interface(intf);
5315 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
5319 /* If this is an inactive hub, do nothing */
5324 dev_dbg(hub_dev, "resetting for error %d\n", hub->error);
5326 ret = usb_reset_device(hdev);
5328 dev_dbg(hub_dev, "error resetting hub: %d\n", ret);
5336 /* deal with port status changes */
5337 for (i = 1; i <= hdev->maxchild; i++) {
5338 struct usb_port *port_dev = hub->ports[i - 1];
5340 if (test_bit(i, hub->event_bits)
5341 || test_bit(i, hub->change_bits)
5342 || test_bit(i, hub->wakeup_bits)) {
5344 * The get_noresume and barrier ensure that if
5345 * the port was in the process of resuming, we
5346 * flush that work and keep the port active for
5347 * the duration of the port_event(). However,
5348 * if the port is runtime pm suspended
5349 * (powered-off), we leave it in that state, run
5350 * an abbreviated port_event(), and move on.
5352 pm_runtime_get_noresume(&port_dev->dev);
5353 pm_runtime_barrier(&port_dev->dev);
5354 usb_lock_port(port_dev);
5356 usb_unlock_port(port_dev);
5357 pm_runtime_put_sync(&port_dev->dev);
5361 /* deal with hub status changes */
5362 if (test_and_clear_bit(0, hub->event_bits) == 0)
5364 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
5365 dev_err(hub_dev, "get_hub_status failed\n");
5367 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
5368 dev_dbg(hub_dev, "power change\n");
5369 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
5370 if (hubstatus & HUB_STATUS_LOCAL_POWER)
5371 /* FIXME: Is this always true? */
5372 hub->limited_power = 1;
5374 hub->limited_power = 0;
5376 if (hubchange & HUB_CHANGE_OVERCURRENT) {
5380 dev_dbg(hub_dev, "over-current change\n");
5381 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
5382 msleep(500); /* Cool down */
5383 hub_power_on(hub, true);
5384 hub_hub_status(hub, &status, &unused);
5385 if (status & HUB_STATUS_OVERCURRENT)
5386 dev_err(hub_dev, "over-current condition\n");
5391 /* Balance the usb_autopm_get_interface() above */
5392 usb_autopm_put_interface_no_suspend(intf);
5394 usb_unlock_device(hdev);
5396 /* Balance the stuff in kick_hub_wq() and allow autosuspend */
5397 usb_autopm_put_interface(intf);
5398 kref_put(&hub->kref, hub_release);
5401 static const struct usb_device_id hub_id_table[] = {
5402 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5403 | USB_DEVICE_ID_MATCH_PRODUCT
5404 | USB_DEVICE_ID_MATCH_INT_CLASS,
5405 .idVendor = USB_VENDOR_SMSC,
5406 .idProduct = USB_PRODUCT_USB5534B,
5407 .bInterfaceClass = USB_CLASS_HUB,
5408 .driver_info = HUB_QUIRK_DISABLE_AUTOSUSPEND},
5409 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5410 | USB_DEVICE_ID_MATCH_PRODUCT,
5411 .idVendor = USB_VENDOR_CYPRESS,
5412 .idProduct = USB_PRODUCT_CY7C65632,
5413 .driver_info = HUB_QUIRK_DISABLE_AUTOSUSPEND},
5414 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5415 | USB_DEVICE_ID_MATCH_INT_CLASS,
5416 .idVendor = USB_VENDOR_GENESYS_LOGIC,
5417 .bInterfaceClass = USB_CLASS_HUB,
5418 .driver_info = HUB_QUIRK_CHECK_PORT_AUTOSUSPEND},
5419 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5420 | USB_DEVICE_ID_MATCH_PRODUCT,
5421 .idVendor = USB_VENDOR_TEXAS_INSTRUMENTS,
5422 .idProduct = USB_PRODUCT_TUSB8041_USB2,
5423 .driver_info = HUB_QUIRK_DISABLE_AUTOSUSPEND},
5424 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5425 | USB_DEVICE_ID_MATCH_PRODUCT,
5426 .idVendor = USB_VENDOR_TEXAS_INSTRUMENTS,
5427 .idProduct = USB_PRODUCT_TUSB8041_USB3,
5428 .driver_info = HUB_QUIRK_DISABLE_AUTOSUSPEND},
5429 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
5430 .bDeviceClass = USB_CLASS_HUB},
5431 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
5432 .bInterfaceClass = USB_CLASS_HUB},
5433 { } /* Terminating entry */
5436 MODULE_DEVICE_TABLE(usb, hub_id_table);
5438 static struct usb_driver hub_driver = {
5441 .disconnect = hub_disconnect,
5442 .suspend = hub_suspend,
5443 .resume = hub_resume,
5444 .reset_resume = hub_reset_resume,
5445 .pre_reset = hub_pre_reset,
5446 .post_reset = hub_post_reset,
5447 .unlocked_ioctl = hub_ioctl,
5448 .id_table = hub_id_table,
5449 .supports_autosuspend = 1,
5452 int usb_hub_init(void)
5454 if (usb_register(&hub_driver) < 0) {
5455 printk(KERN_ERR "%s: can't register hub driver\n",
5461 * The workqueue needs to be freezable to avoid interfering with
5462 * USB-PERSIST port handover. Otherwise it might see that a full-speed
5463 * device was gone before the EHCI controller had handed its port
5464 * over to the companion full-speed controller.
5466 hub_wq = alloc_workqueue("usb_hub_wq", WQ_FREEZABLE, 0);
5470 /* Fall through if kernel_thread failed */
5471 usb_deregister(&hub_driver);
5472 pr_err("%s: can't allocate workqueue for usb hub\n", usbcore_name);
5477 void usb_hub_cleanup(void)
5479 destroy_workqueue(hub_wq);
5482 * Hub resources are freed for us by usb_deregister. It calls
5483 * usb_driver_purge on every device which in turn calls that
5484 * devices disconnect function if it is using this driver.
5485 * The hub_disconnect function takes care of releasing the
5486 * individual hub resources. -greg
5488 usb_deregister(&hub_driver);
5489 } /* usb_hub_cleanup() */
5491 static int descriptors_changed(struct usb_device *udev,
5492 struct usb_device_descriptor *old_device_descriptor,
5493 struct usb_host_bos *old_bos)
5497 unsigned serial_len = 0;
5499 unsigned old_length;
5503 if (memcmp(&udev->descriptor, old_device_descriptor,
5504 sizeof(*old_device_descriptor)) != 0)
5507 if ((old_bos && !udev->bos) || (!old_bos && udev->bos))
5510 len = le16_to_cpu(udev->bos->desc->wTotalLength);
5511 if (len != le16_to_cpu(old_bos->desc->wTotalLength))
5513 if (memcmp(udev->bos->desc, old_bos->desc, len))
5517 /* Since the idVendor, idProduct, and bcdDevice values in the
5518 * device descriptor haven't changed, we will assume the
5519 * Manufacturer and Product strings haven't changed either.
5520 * But the SerialNumber string could be different (e.g., a
5521 * different flash card of the same brand).
5524 serial_len = strlen(udev->serial) + 1;
5527 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5528 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5529 len = max(len, old_length);
5532 buf = kmalloc(len, GFP_NOIO);
5534 /* assume the worst */
5537 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5538 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5539 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
5541 if (length != old_length) {
5542 dev_dbg(&udev->dev, "config index %d, error %d\n",
5547 if (memcmp(buf, udev->rawdescriptors[index], old_length)
5549 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
5551 ((struct usb_config_descriptor *) buf)->
5552 bConfigurationValue);
5558 if (!changed && serial_len) {
5559 length = usb_string(udev, udev->descriptor.iSerialNumber,
5561 if (length + 1 != serial_len) {
5562 dev_dbg(&udev->dev, "serial string error %d\n",
5565 } else if (memcmp(buf, udev->serial, length) != 0) {
5566 dev_dbg(&udev->dev, "serial string changed\n");
5576 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5577 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5579 * WARNING - don't use this routine to reset a composite device
5580 * (one with multiple interfaces owned by separate drivers)!
5581 * Use usb_reset_device() instead.
5583 * Do a port reset, reassign the device's address, and establish its
5584 * former operating configuration. If the reset fails, or the device's
5585 * descriptors change from their values before the reset, or the original
5586 * configuration and altsettings cannot be restored, a flag will be set
5587 * telling hub_wq to pretend the device has been disconnected and then
5588 * re-connected. All drivers will be unbound, and the device will be
5589 * re-enumerated and probed all over again.
5591 * Return: 0 if the reset succeeded, -ENODEV if the device has been
5592 * flagged for logical disconnection, or some other negative error code
5593 * if the reset wasn't even attempted.
5596 * The caller must own the device lock and the port lock, the latter is
5597 * taken by usb_reset_device(). For example, it's safe to use
5598 * usb_reset_device() from a driver probe() routine after downloading
5599 * new firmware. For calls that might not occur during probe(), drivers
5600 * should lock the device using usb_lock_device_for_reset().
5602 * Locking exception: This routine may also be called from within an
5603 * autoresume handler. Such usage won't conflict with other tasks
5604 * holding the device lock because these tasks should always call
5605 * usb_autopm_resume_device(), thereby preventing any unwanted
5606 * autoresume. The autoresume handler is expected to have already
5607 * acquired the port lock before calling this routine.
5609 static int usb_reset_and_verify_device(struct usb_device *udev)
5611 struct usb_device *parent_hdev = udev->parent;
5612 struct usb_hub *parent_hub;
5613 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
5614 struct usb_device_descriptor descriptor = udev->descriptor;
5615 struct usb_host_bos *bos;
5617 int port1 = udev->portnum;
5619 if (udev->state == USB_STATE_NOTATTACHED ||
5620 udev->state == USB_STATE_SUSPENDED) {
5621 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5629 parent_hub = usb_hub_to_struct_hub(parent_hdev);
5631 /* Disable USB2 hardware LPM.
5632 * It will be re-enabled by the enumeration process.
5634 usb_disable_usb2_hardware_lpm(udev);
5636 /* Disable LPM and LTM while we reset the device and reinstall the alt
5637 * settings. Device-initiated LPM settings, and system exit latency
5638 * settings are cleared when the device is reset, so we have to set
5641 ret = usb_unlocked_disable_lpm(udev);
5643 dev_err(&udev->dev, "%s Failed to disable LPM\n.", __func__);
5644 goto re_enumerate_no_bos;
5646 ret = usb_disable_ltm(udev);
5648 dev_err(&udev->dev, "%s Failed to disable LTM\n.",
5650 goto re_enumerate_no_bos;
5656 mutex_lock(hcd->address0_mutex);
5658 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
5660 /* ep0 maxpacket size may change; let the HCD know about it.
5661 * Other endpoints will be handled by re-enumeration. */
5662 usb_ep0_reinit(udev);
5663 ret = hub_port_init(parent_hub, udev, port1, i);
5664 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
5667 mutex_unlock(hcd->address0_mutex);
5672 /* Device might have changed firmware (DFU or similar) */
5673 if (descriptors_changed(udev, &descriptor, bos)) {
5674 dev_info(&udev->dev, "device firmware changed\n");
5675 udev->descriptor = descriptor; /* for disconnect() calls */
5679 /* Restore the device's previous configuration */
5680 if (!udev->actconfig)
5683 mutex_lock(hcd->bandwidth_mutex);
5684 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
5686 dev_warn(&udev->dev,
5687 "Busted HC? Not enough HCD resources for "
5688 "old configuration.\n");
5689 mutex_unlock(hcd->bandwidth_mutex);
5692 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
5693 USB_REQ_SET_CONFIGURATION, 0,
5694 udev->actconfig->desc.bConfigurationValue, 0,
5695 NULL, 0, USB_CTRL_SET_TIMEOUT);
5698 "can't restore configuration #%d (error=%d)\n",
5699 udev->actconfig->desc.bConfigurationValue, ret);
5700 mutex_unlock(hcd->bandwidth_mutex);
5703 mutex_unlock(hcd->bandwidth_mutex);
5704 usb_set_device_state(udev, USB_STATE_CONFIGURED);
5706 /* Put interfaces back into the same altsettings as before.
5707 * Don't bother to send the Set-Interface request for interfaces
5708 * that were already in altsetting 0; besides being unnecessary,
5709 * many devices can't handle it. Instead just reset the host-side
5712 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
5713 struct usb_host_config *config = udev->actconfig;
5714 struct usb_interface *intf = config->interface[i];
5715 struct usb_interface_descriptor *desc;
5717 desc = &intf->cur_altsetting->desc;
5718 if (desc->bAlternateSetting == 0) {
5719 usb_disable_interface(udev, intf, true);
5720 usb_enable_interface(udev, intf, true);
5723 /* Let the bandwidth allocation function know that this
5724 * device has been reset, and it will have to use
5725 * alternate setting 0 as the current alternate setting.
5727 intf->resetting_device = 1;
5728 ret = usb_set_interface(udev, desc->bInterfaceNumber,
5729 desc->bAlternateSetting);
5730 intf->resetting_device = 0;
5733 dev_err(&udev->dev, "failed to restore interface %d "
5734 "altsetting %d (error=%d)\n",
5735 desc->bInterfaceNumber,
5736 desc->bAlternateSetting,
5740 /* Resetting also frees any allocated streams */
5741 for (j = 0; j < intf->cur_altsetting->desc.bNumEndpoints; j++)
5742 intf->cur_altsetting->endpoint[j].streams = 0;
5746 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5747 usb_enable_usb2_hardware_lpm(udev);
5748 usb_unlocked_enable_lpm(udev);
5749 usb_enable_ltm(udev);
5750 usb_release_bos_descriptor(udev);
5755 usb_release_bos_descriptor(udev);
5757 re_enumerate_no_bos:
5758 /* LPM state doesn't matter when we're about to destroy the device. */
5759 hub_port_logical_disconnect(parent_hub, port1);
5764 * usb_reset_device - warn interface drivers and perform a USB port reset
5765 * @udev: device to reset (not in NOTATTACHED state)
5767 * Warns all drivers bound to registered interfaces (using their pre_reset
5768 * method), performs the port reset, and then lets the drivers know that
5769 * the reset is over (using their post_reset method).
5771 * Return: The same as for usb_reset_and_verify_device().
5772 * However, if a reset is already in progress (for instance, if a
5773 * driver doesn't have pre_reset() or post_reset() callbacks, and while
5774 * being unbound or re-bound during the ongoing reset its disconnect()
5775 * or probe() routine tries to perform a second, nested reset), the
5776 * routine returns -EINPROGRESS.
5779 * The caller must own the device lock. For example, it's safe to use
5780 * this from a driver probe() routine after downloading new firmware.
5781 * For calls that might not occur during probe(), drivers should lock
5782 * the device using usb_lock_device_for_reset().
5784 * If an interface is currently being probed or disconnected, we assume
5785 * its driver knows how to handle resets. For all other interfaces,
5786 * if the driver doesn't have pre_reset and post_reset methods then
5787 * we attempt to unbind it and rebind afterward.
5789 int usb_reset_device(struct usb_device *udev)
5793 unsigned int noio_flag;
5794 struct usb_port *port_dev;
5795 struct usb_host_config *config = udev->actconfig;
5796 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
5798 if (udev->state == USB_STATE_NOTATTACHED) {
5799 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5804 if (!udev->parent) {
5805 /* this requires hcd-specific logic; see ohci_restart() */
5806 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
5810 if (udev->reset_in_progress)
5811 return -EINPROGRESS;
5812 udev->reset_in_progress = 1;
5814 port_dev = hub->ports[udev->portnum - 1];
5817 * Don't allocate memory with GFP_KERNEL in current
5818 * context to avoid possible deadlock if usb mass
5819 * storage interface or usbnet interface(iSCSI case)
5820 * is included in current configuration. The easist
5821 * approach is to do it for every device reset,
5822 * because the device 'memalloc_noio' flag may have
5823 * not been set before reseting the usb device.
5825 noio_flag = memalloc_noio_save();
5827 /* Prevent autosuspend during the reset */
5828 usb_autoresume_device(udev);
5831 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
5832 struct usb_interface *cintf = config->interface[i];
5833 struct usb_driver *drv;
5836 if (cintf->dev.driver) {
5837 drv = to_usb_driver(cintf->dev.driver);
5838 if (drv->pre_reset && drv->post_reset)
5839 unbind = (drv->pre_reset)(cintf);
5840 else if (cintf->condition ==
5841 USB_INTERFACE_BOUND)
5844 usb_forced_unbind_intf(cintf);
5849 usb_lock_port(port_dev);
5850 ret = usb_reset_and_verify_device(udev);
5851 usb_unlock_port(port_dev);
5854 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
5855 struct usb_interface *cintf = config->interface[i];
5856 struct usb_driver *drv;
5857 int rebind = cintf->needs_binding;
5859 if (!rebind && cintf->dev.driver) {
5860 drv = to_usb_driver(cintf->dev.driver);
5861 if (drv->post_reset)
5862 rebind = (drv->post_reset)(cintf);
5863 else if (cintf->condition ==
5864 USB_INTERFACE_BOUND)
5867 cintf->needs_binding = 1;
5871 /* If the reset failed, hub_wq will unbind drivers later */
5873 usb_unbind_and_rebind_marked_interfaces(udev);
5876 usb_autosuspend_device(udev);
5877 memalloc_noio_restore(noio_flag);
5878 udev->reset_in_progress = 0;
5881 EXPORT_SYMBOL_GPL(usb_reset_device);
5885 * usb_queue_reset_device - Reset a USB device from an atomic context
5886 * @iface: USB interface belonging to the device to reset
5888 * This function can be used to reset a USB device from an atomic
5889 * context, where usb_reset_device() won't work (as it blocks).
5891 * Doing a reset via this method is functionally equivalent to calling
5892 * usb_reset_device(), except for the fact that it is delayed to a
5893 * workqueue. This means that any drivers bound to other interfaces
5894 * might be unbound, as well as users from usbfs in user space.
5898 * - Scheduling two resets at the same time from two different drivers
5899 * attached to two different interfaces of the same device is
5900 * possible; depending on how the driver attached to each interface
5901 * handles ->pre_reset(), the second reset might happen or not.
5903 * - If the reset is delayed so long that the interface is unbound from
5904 * its driver, the reset will be skipped.
5906 * - This function can be called during .probe(). It can also be called
5907 * during .disconnect(), but doing so is pointless because the reset
5908 * will not occur. If you really want to reset the device during
5909 * .disconnect(), call usb_reset_device() directly -- but watch out
5910 * for nested unbinding issues!
5912 void usb_queue_reset_device(struct usb_interface *iface)
5914 if (schedule_work(&iface->reset_ws))
5915 usb_get_intf(iface);
5917 EXPORT_SYMBOL_GPL(usb_queue_reset_device);
5920 * usb_hub_find_child - Get the pointer of child device
5921 * attached to the port which is specified by @port1.
5922 * @hdev: USB device belonging to the usb hub
5923 * @port1: port num to indicate which port the child device
5926 * USB drivers call this function to get hub's child device
5929 * Return: %NULL if input param is invalid and
5930 * child's usb_device pointer if non-NULL.
5932 struct usb_device *usb_hub_find_child(struct usb_device *hdev,
5935 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5937 if (port1 < 1 || port1 > hdev->maxchild)
5939 return hub->ports[port1 - 1]->child;
5941 EXPORT_SYMBOL_GPL(usb_hub_find_child);
5943 void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
5944 struct usb_hub_descriptor *desc)
5946 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5947 enum usb_port_connect_type connect_type;
5953 if (!hub_is_superspeed(hdev)) {
5954 for (i = 1; i <= hdev->maxchild; i++) {
5955 struct usb_port *port_dev = hub->ports[i - 1];
5957 connect_type = port_dev->connect_type;
5958 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5959 u8 mask = 1 << (i%8);
5961 if (!(desc->u.hs.DeviceRemovable[i/8] & mask)) {
5962 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
5963 desc->u.hs.DeviceRemovable[i/8] |= mask;
5968 u16 port_removable = le16_to_cpu(desc->u.ss.DeviceRemovable);
5970 for (i = 1; i <= hdev->maxchild; i++) {
5971 struct usb_port *port_dev = hub->ports[i - 1];
5973 connect_type = port_dev->connect_type;
5974 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5977 if (!(port_removable & mask)) {
5978 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
5979 port_removable |= mask;
5984 desc->u.ss.DeviceRemovable = cpu_to_le16(port_removable);
5990 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5991 * @hdev: USB device belonging to the usb hub
5992 * @port1: port num of the port
5994 * Return: Port's acpi handle if successful, %NULL if params are
5997 acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
6000 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
6005 return ACPI_HANDLE(&hub->ports[port1 - 1]->dev);