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 HUB_QUIRK_CHECK_PORT_AUTOSUSPEND 0x01
44 #define HUB_QUIRK_DISABLE_AUTOSUSPEND 0x02
46 /* Protect struct usb_device->state and ->children members
47 * Note: Both are also protected by ->dev.sem, except that ->state can
48 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
49 static DEFINE_SPINLOCK(device_state_lock);
51 /* workqueue to process hub events */
52 static struct workqueue_struct *hub_wq;
53 static void hub_event(struct work_struct *work);
55 /* synchronize hub-port add/remove and peering operations */
56 DEFINE_MUTEX(usb_port_peer_mutex);
58 /* cycle leds on hubs that aren't blinking for attention */
59 static bool blinkenlights;
60 module_param(blinkenlights, bool, S_IRUGO);
61 MODULE_PARM_DESC(blinkenlights, "true to cycle leds on hubs");
64 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
65 * 10 seconds to send reply for the initial 64-byte descriptor request.
67 /* define initial 64-byte descriptor request timeout in milliseconds */
68 static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
69 module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
70 MODULE_PARM_DESC(initial_descriptor_timeout,
71 "initial 64-byte descriptor request timeout in milliseconds "
72 "(default 5000 - 5.0 seconds)");
75 * As of 2.6.10 we introduce a new USB device initialization scheme which
76 * closely resembles the way Windows works. Hopefully it will be compatible
77 * with a wider range of devices than the old scheme. However some previously
78 * working devices may start giving rise to "device not accepting address"
79 * errors; if that happens the user can try the old scheme by adjusting the
80 * following module parameters.
82 * For maximum flexibility there are two boolean parameters to control the
83 * hub driver's behavior. On the first initialization attempt, if the
84 * "old_scheme_first" parameter is set then the old scheme will be used,
85 * otherwise the new scheme is used. If that fails and "use_both_schemes"
86 * is set, then the driver will make another attempt, using the other scheme.
88 static bool old_scheme_first;
89 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
90 MODULE_PARM_DESC(old_scheme_first,
91 "start with the old device initialization scheme");
93 static bool use_both_schemes = 1;
94 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
95 MODULE_PARM_DESC(use_both_schemes,
96 "try the other device initialization scheme if the "
99 /* Mutual exclusion for EHCI CF initialization. This interferes with
100 * port reset on some companion controllers.
102 DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
103 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
105 #define HUB_DEBOUNCE_TIMEOUT 2000
106 #define HUB_DEBOUNCE_STEP 25
107 #define HUB_DEBOUNCE_STABLE 100
109 static void hub_release(struct kref *kref);
110 static int usb_reset_and_verify_device(struct usb_device *udev);
111 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state);
112 static bool hub_port_warm_reset_required(struct usb_hub *hub, int port1,
115 static inline char *portspeed(struct usb_hub *hub, int portstatus)
117 if (hub_is_superspeedplus(hub->hdev))
119 if (hub_is_superspeed(hub->hdev))
121 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
123 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
129 /* Note that hdev or one of its children must be locked! */
130 struct usb_hub *usb_hub_to_struct_hub(struct usb_device *hdev)
132 if (!hdev || !hdev->actconfig || !hdev->maxchild)
134 return usb_get_intfdata(hdev->actconfig->interface[0]);
137 int usb_device_supports_lpm(struct usb_device *udev)
139 /* Some devices have trouble with LPM */
140 if (udev->quirks & USB_QUIRK_NO_LPM)
143 /* USB 2.1 (and greater) devices indicate LPM support through
144 * their USB 2.0 Extended Capabilities BOS descriptor.
146 if (udev->speed == USB_SPEED_HIGH || udev->speed == USB_SPEED_FULL) {
147 if (udev->bos->ext_cap &&
149 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
155 * According to the USB 3.0 spec, all USB 3.0 devices must support LPM.
156 * However, there are some that don't, and they set the U1/U2 exit
159 if (!udev->bos->ss_cap) {
160 dev_info(&udev->dev, "No LPM exit latency info found, disabling LPM.\n");
164 if (udev->bos->ss_cap->bU1devExitLat == 0 &&
165 udev->bos->ss_cap->bU2DevExitLat == 0) {
167 dev_info(&udev->dev, "LPM exit latency is zeroed, disabling LPM.\n");
169 dev_info(&udev->dev, "We don't know the algorithms for LPM for this host, disabling LPM.\n");
173 if (!udev->parent || udev->parent->lpm_capable)
179 * Set the Maximum Exit Latency (MEL) for the host to initiate a transition from
182 static void usb_set_lpm_mel(struct usb_device *udev,
183 struct usb3_lpm_parameters *udev_lpm_params,
184 unsigned int udev_exit_latency,
186 struct usb3_lpm_parameters *hub_lpm_params,
187 unsigned int hub_exit_latency)
189 unsigned int total_mel;
190 unsigned int device_mel;
191 unsigned int hub_mel;
194 * Calculate the time it takes to transition all links from the roothub
195 * to the parent hub into U0. The parent hub must then decode the
196 * packet (hub header decode latency) to figure out which port it was
199 * The Hub Header decode latency is expressed in 0.1us intervals (0x1
200 * means 0.1us). Multiply that by 100 to get nanoseconds.
202 total_mel = hub_lpm_params->mel +
203 (hub->descriptor->u.ss.bHubHdrDecLat * 100);
206 * How long will it take to transition the downstream hub's port into
207 * U0? The greater of either the hub exit latency or the device exit
210 * The BOS U1/U2 exit latencies are expressed in 1us intervals.
211 * Multiply that by 1000 to get nanoseconds.
213 device_mel = udev_exit_latency * 1000;
214 hub_mel = hub_exit_latency * 1000;
215 if (device_mel > hub_mel)
216 total_mel += device_mel;
218 total_mel += hub_mel;
220 udev_lpm_params->mel = total_mel;
224 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
225 * a transition from either U1 or U2.
227 static void usb_set_lpm_pel(struct usb_device *udev,
228 struct usb3_lpm_parameters *udev_lpm_params,
229 unsigned int udev_exit_latency,
231 struct usb3_lpm_parameters *hub_lpm_params,
232 unsigned int hub_exit_latency,
233 unsigned int port_to_port_exit_latency)
235 unsigned int first_link_pel;
236 unsigned int hub_pel;
239 * First, the device sends an LFPS to transition the link between the
240 * device and the parent hub into U0. The exit latency is the bigger of
241 * the device exit latency or the hub exit latency.
243 if (udev_exit_latency > hub_exit_latency)
244 first_link_pel = udev_exit_latency * 1000;
246 first_link_pel = hub_exit_latency * 1000;
249 * When the hub starts to receive the LFPS, there is a slight delay for
250 * it to figure out that one of the ports is sending an LFPS. Then it
251 * will forward the LFPS to its upstream link. The exit latency is the
252 * delay, plus the PEL that we calculated for this hub.
254 hub_pel = port_to_port_exit_latency * 1000 + hub_lpm_params->pel;
257 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
258 * is the greater of the two exit latencies.
260 if (first_link_pel > hub_pel)
261 udev_lpm_params->pel = first_link_pel;
263 udev_lpm_params->pel = hub_pel;
267 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
268 * when a device initiates a transition to U0, until when it will receive the
269 * first packet from the host controller.
271 * Section C.1.5.1 describes the four components to this:
273 * - t2: time for the ERDY to make it from the device to the host.
274 * - t3: a host-specific delay to process the ERDY.
275 * - t4: time for the packet to make it from the host to the device.
277 * t3 is specific to both the xHCI host and the platform the host is integrated
278 * into. The Intel HW folks have said it's negligible, FIXME if a different
279 * vendor says otherwise.
281 static void usb_set_lpm_sel(struct usb_device *udev,
282 struct usb3_lpm_parameters *udev_lpm_params)
284 struct usb_device *parent;
285 unsigned int num_hubs;
286 unsigned int total_sel;
288 /* t1 = device PEL */
289 total_sel = udev_lpm_params->pel;
290 /* How many external hubs are in between the device & the root port. */
291 for (parent = udev->parent, num_hubs = 0; parent->parent;
292 parent = parent->parent)
294 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
296 total_sel += 2100 + 250 * (num_hubs - 1);
298 /* t4 = 250ns * num_hubs */
299 total_sel += 250 * num_hubs;
301 udev_lpm_params->sel = total_sel;
304 static void usb_set_lpm_parameters(struct usb_device *udev)
307 unsigned int port_to_port_delay;
308 unsigned int udev_u1_del;
309 unsigned int udev_u2_del;
310 unsigned int hub_u1_del;
311 unsigned int hub_u2_del;
313 if (!udev->lpm_capable || udev->speed < USB_SPEED_SUPER)
316 hub = usb_hub_to_struct_hub(udev->parent);
317 /* It doesn't take time to transition the roothub into U0, since it
318 * doesn't have an upstream link.
323 udev_u1_del = udev->bos->ss_cap->bU1devExitLat;
324 udev_u2_del = le16_to_cpu(udev->bos->ss_cap->bU2DevExitLat);
325 hub_u1_del = udev->parent->bos->ss_cap->bU1devExitLat;
326 hub_u2_del = le16_to_cpu(udev->parent->bos->ss_cap->bU2DevExitLat);
328 usb_set_lpm_mel(udev, &udev->u1_params, udev_u1_del,
329 hub, &udev->parent->u1_params, hub_u1_del);
331 usb_set_lpm_mel(udev, &udev->u2_params, udev_u2_del,
332 hub, &udev->parent->u2_params, hub_u2_del);
335 * Appendix C, section C.2.2.2, says that there is a slight delay from
336 * when the parent hub notices the downstream port is trying to
337 * transition to U0 to when the hub initiates a U0 transition on its
338 * upstream port. The section says the delays are tPort2PortU1EL and
339 * tPort2PortU2EL, but it doesn't define what they are.
341 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
342 * about the same delays. Use the maximum delay calculations from those
343 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
344 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
345 * assume the device exit latencies they are talking about are the hub
348 * What do we do if the U2 exit latency is less than the U1 exit
349 * latency? It's possible, although not likely...
351 port_to_port_delay = 1;
353 usb_set_lpm_pel(udev, &udev->u1_params, udev_u1_del,
354 hub, &udev->parent->u1_params, hub_u1_del,
357 if (hub_u2_del > hub_u1_del)
358 port_to_port_delay = 1 + hub_u2_del - hub_u1_del;
360 port_to_port_delay = 1 + hub_u1_del;
362 usb_set_lpm_pel(udev, &udev->u2_params, udev_u2_del,
363 hub, &udev->parent->u2_params, hub_u2_del,
366 /* Now that we've got PEL, calculate SEL. */
367 usb_set_lpm_sel(udev, &udev->u1_params);
368 usb_set_lpm_sel(udev, &udev->u2_params);
371 /* USB 2.0 spec Section 11.24.4.5 */
372 static int get_hub_descriptor(struct usb_device *hdev,
373 struct usb_hub_descriptor *desc)
378 if (hub_is_superspeed(hdev)) {
379 dtype = USB_DT_SS_HUB;
380 size = USB_DT_SS_HUB_SIZE;
383 size = sizeof(struct usb_hub_descriptor);
386 for (i = 0; i < 3; i++) {
387 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
388 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
389 dtype << 8, 0, desc, size,
390 USB_CTRL_GET_TIMEOUT);
391 if (hub_is_superspeed(hdev)) {
394 } else if (ret >= USB_DT_HUB_NONVAR_SIZE + 2) {
395 /* Make sure we have the DeviceRemovable field. */
396 size = USB_DT_HUB_NONVAR_SIZE + desc->bNbrPorts / 8 + 1;
406 * USB 2.0 spec Section 11.24.2.1
408 static int clear_hub_feature(struct usb_device *hdev, int feature)
410 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
411 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
415 * USB 2.0 spec Section 11.24.2.2
417 int usb_clear_port_feature(struct usb_device *hdev, int port1, int feature)
419 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
420 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
425 * USB 2.0 spec Section 11.24.2.13
427 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
429 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
430 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
434 static char *to_led_name(int selector)
451 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
452 * for info about using port indicators
454 static void set_port_led(struct usb_hub *hub, int port1, int selector)
456 struct usb_port *port_dev = hub->ports[port1 - 1];
459 status = set_port_feature(hub->hdev, (selector << 8) | port1,
460 USB_PORT_FEAT_INDICATOR);
461 dev_dbg(&port_dev->dev, "indicator %s status %d\n",
462 to_led_name(selector), status);
465 #define LED_CYCLE_PERIOD ((2*HZ)/3)
467 static void led_work(struct work_struct *work)
469 struct usb_hub *hub =
470 container_of(work, struct usb_hub, leds.work);
471 struct usb_device *hdev = hub->hdev;
473 unsigned changed = 0;
476 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
479 for (i = 0; i < hdev->maxchild; i++) {
480 unsigned selector, mode;
482 /* 30%-50% duty cycle */
484 switch (hub->indicator[i]) {
486 case INDICATOR_CYCLE:
488 selector = HUB_LED_AUTO;
489 mode = INDICATOR_AUTO;
491 /* blinking green = sw attention */
492 case INDICATOR_GREEN_BLINK:
493 selector = HUB_LED_GREEN;
494 mode = INDICATOR_GREEN_BLINK_OFF;
496 case INDICATOR_GREEN_BLINK_OFF:
497 selector = HUB_LED_OFF;
498 mode = INDICATOR_GREEN_BLINK;
500 /* blinking amber = hw attention */
501 case INDICATOR_AMBER_BLINK:
502 selector = HUB_LED_AMBER;
503 mode = INDICATOR_AMBER_BLINK_OFF;
505 case INDICATOR_AMBER_BLINK_OFF:
506 selector = HUB_LED_OFF;
507 mode = INDICATOR_AMBER_BLINK;
509 /* blink green/amber = reserved */
510 case INDICATOR_ALT_BLINK:
511 selector = HUB_LED_GREEN;
512 mode = INDICATOR_ALT_BLINK_OFF;
514 case INDICATOR_ALT_BLINK_OFF:
515 selector = HUB_LED_AMBER;
516 mode = INDICATOR_ALT_BLINK;
521 if (selector != HUB_LED_AUTO)
523 set_port_led(hub, i + 1, selector);
524 hub->indicator[i] = mode;
526 if (!changed && blinkenlights) {
528 cursor %= hdev->maxchild;
529 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
530 hub->indicator[cursor] = INDICATOR_CYCLE;
534 queue_delayed_work(system_power_efficient_wq,
535 &hub->leds, LED_CYCLE_PERIOD);
538 /* use a short timeout for hub/port status fetches */
539 #define USB_STS_TIMEOUT 1000
540 #define USB_STS_RETRIES 5
543 * USB 2.0 spec Section 11.24.2.6
545 static int get_hub_status(struct usb_device *hdev,
546 struct usb_hub_status *data)
548 int i, status = -ETIMEDOUT;
550 for (i = 0; i < USB_STS_RETRIES &&
551 (status == -ETIMEDOUT || status == -EPIPE); i++) {
552 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
553 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
554 data, sizeof(*data), USB_STS_TIMEOUT);
560 * USB 2.0 spec Section 11.24.2.7
561 * USB 3.1 takes into use the wValue and wLength fields, spec Section 10.16.2.6
563 static int get_port_status(struct usb_device *hdev, int port1,
564 void *data, u16 value, u16 length)
566 int i, status = -ETIMEDOUT;
568 for (i = 0; i < USB_STS_RETRIES &&
569 (status == -ETIMEDOUT || status == -EPIPE); i++) {
570 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
571 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, value,
572 port1, data, length, USB_STS_TIMEOUT);
577 static int hub_ext_port_status(struct usb_hub *hub, int port1, int type,
578 u16 *status, u16 *change, u32 *ext_status)
583 if (type != HUB_PORT_STATUS)
586 mutex_lock(&hub->status_mutex);
587 ret = get_port_status(hub->hdev, port1, &hub->status->port, type, len);
590 dev_err(hub->intfdev,
591 "%s failed (err = %d)\n", __func__, ret);
595 *status = le16_to_cpu(hub->status->port.wPortStatus);
596 *change = le16_to_cpu(hub->status->port.wPortChange);
597 if (type != HUB_PORT_STATUS && ext_status)
598 *ext_status = le32_to_cpu(
599 hub->status->port.dwExtPortStatus);
602 mutex_unlock(&hub->status_mutex);
606 static int hub_port_status(struct usb_hub *hub, int port1,
607 u16 *status, u16 *change)
609 return hub_ext_port_status(hub, port1, HUB_PORT_STATUS,
610 status, change, NULL);
613 static void kick_hub_wq(struct usb_hub *hub)
615 struct usb_interface *intf;
617 if (hub->disconnected || work_pending(&hub->events))
621 * Suppress autosuspend until the event is proceed.
623 * Be careful and make sure that the symmetric operation is
624 * always called. We are here only when there is no pending
625 * work for this hub. Therefore put the interface either when
626 * the new work is called or when it is canceled.
628 intf = to_usb_interface(hub->intfdev);
629 usb_autopm_get_interface_no_resume(intf);
630 kref_get(&hub->kref);
632 if (queue_work(hub_wq, &hub->events))
635 /* the work has already been scheduled */
636 usb_autopm_put_interface_async(intf);
637 kref_put(&hub->kref, hub_release);
640 void usb_kick_hub_wq(struct usb_device *hdev)
642 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
649 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
650 * Notification, which indicates it had initiated remote wakeup.
652 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
653 * device initiates resume, so the USB core will not receive notice of the
654 * resume through the normal hub interrupt URB.
656 void usb_wakeup_notification(struct usb_device *hdev,
657 unsigned int portnum)
660 struct usb_port *port_dev;
665 hub = usb_hub_to_struct_hub(hdev);
667 port_dev = hub->ports[portnum - 1];
668 if (port_dev && port_dev->child)
669 pm_wakeup_event(&port_dev->child->dev, 0);
671 set_bit(portnum, hub->wakeup_bits);
675 EXPORT_SYMBOL_GPL(usb_wakeup_notification);
677 /* completion function, fires on port status changes and various faults */
678 static void hub_irq(struct urb *urb)
680 struct usb_hub *hub = urb->context;
681 int status = urb->status;
686 case -ENOENT: /* synchronous unlink */
687 case -ECONNRESET: /* async unlink */
688 case -ESHUTDOWN: /* hardware going away */
691 default: /* presumably an error */
692 /* Cause a hub reset after 10 consecutive errors */
693 dev_dbg(hub->intfdev, "transfer --> %d\n", status);
694 if ((++hub->nerrors < 10) || hub->error)
699 /* let hub_wq handle things */
700 case 0: /* we got data: port status changed */
702 for (i = 0; i < urb->actual_length; ++i)
703 bits |= ((unsigned long) ((*hub->buffer)[i]))
705 hub->event_bits[0] = bits;
711 /* Something happened, let hub_wq figure it out */
718 status = usb_submit_urb(hub->urb, GFP_ATOMIC);
719 if (status != 0 && status != -ENODEV && status != -EPERM)
720 dev_err(hub->intfdev, "resubmit --> %d\n", status);
723 /* USB 2.0 spec Section 11.24.2.3 */
725 hub_clear_tt_buffer(struct usb_device *hdev, u16 devinfo, u16 tt)
727 /* Need to clear both directions for control ep */
728 if (((devinfo >> 11) & USB_ENDPOINT_XFERTYPE_MASK) ==
729 USB_ENDPOINT_XFER_CONTROL) {
730 int status = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
731 HUB_CLEAR_TT_BUFFER, USB_RT_PORT,
732 devinfo ^ 0x8000, tt, NULL, 0, 1000);
736 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
737 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
742 * enumeration blocks hub_wq for a long time. we use keventd instead, since
743 * long blocking there is the exception, not the rule. accordingly, HCDs
744 * talking to TTs must queue control transfers (not just bulk and iso), so
745 * both can talk to the same hub concurrently.
747 static void hub_tt_work(struct work_struct *work)
749 struct usb_hub *hub =
750 container_of(work, struct usb_hub, tt.clear_work);
753 spin_lock_irqsave(&hub->tt.lock, flags);
754 while (!list_empty(&hub->tt.clear_list)) {
755 struct list_head *next;
756 struct usb_tt_clear *clear;
757 struct usb_device *hdev = hub->hdev;
758 const struct hc_driver *drv;
761 next = hub->tt.clear_list.next;
762 clear = list_entry(next, struct usb_tt_clear, clear_list);
763 list_del(&clear->clear_list);
765 /* drop lock so HCD can concurrently report other TT errors */
766 spin_unlock_irqrestore(&hub->tt.lock, flags);
767 status = hub_clear_tt_buffer(hdev, clear->devinfo, clear->tt);
768 if (status && status != -ENODEV)
770 "clear tt %d (%04x) error %d\n",
771 clear->tt, clear->devinfo, status);
773 /* Tell the HCD, even if the operation failed */
774 drv = clear->hcd->driver;
775 if (drv->clear_tt_buffer_complete)
776 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
779 spin_lock_irqsave(&hub->tt.lock, flags);
781 spin_unlock_irqrestore(&hub->tt.lock, flags);
785 * usb_hub_set_port_power - control hub port's power state
786 * @hdev: USB device belonging to the usb hub
789 * @set: expected status
791 * call this function to control port's power via setting or
792 * clearing the port's PORT_POWER feature.
794 * Return: 0 if successful. A negative error code otherwise.
796 int usb_hub_set_port_power(struct usb_device *hdev, struct usb_hub *hub,
802 ret = set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
804 ret = usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
810 set_bit(port1, hub->power_bits);
812 clear_bit(port1, hub->power_bits);
817 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
818 * @urb: an URB associated with the failed or incomplete split transaction
820 * High speed HCDs use this to tell the hub driver that some split control or
821 * bulk transaction failed in a way that requires clearing internal state of
822 * a transaction translator. This is normally detected (and reported) from
825 * It may not be possible for that hub to handle additional full (or low)
826 * speed transactions until that state is fully cleared out.
828 * Return: 0 if successful. A negative error code otherwise.
830 int usb_hub_clear_tt_buffer(struct urb *urb)
832 struct usb_device *udev = urb->dev;
833 int pipe = urb->pipe;
834 struct usb_tt *tt = udev->tt;
836 struct usb_tt_clear *clear;
838 /* we've got to cope with an arbitrary number of pending TT clears,
839 * since each TT has "at least two" buffers that can need it (and
840 * there can be many TTs per hub). even if they're uncommon.
842 clear = kmalloc(sizeof *clear, GFP_ATOMIC);
844 dev_err(&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
845 /* FIXME recover somehow ... RESET_TT? */
849 /* info that CLEAR_TT_BUFFER needs */
850 clear->tt = tt->multi ? udev->ttport : 1;
851 clear->devinfo = usb_pipeendpoint (pipe);
852 clear->devinfo |= udev->devnum << 4;
853 clear->devinfo |= usb_pipecontrol(pipe)
854 ? (USB_ENDPOINT_XFER_CONTROL << 11)
855 : (USB_ENDPOINT_XFER_BULK << 11);
856 if (usb_pipein(pipe))
857 clear->devinfo |= 1 << 15;
859 /* info for completion callback */
860 clear->hcd = bus_to_hcd(udev->bus);
863 /* tell keventd to clear state for this TT */
864 spin_lock_irqsave(&tt->lock, flags);
865 list_add_tail(&clear->clear_list, &tt->clear_list);
866 schedule_work(&tt->clear_work);
867 spin_unlock_irqrestore(&tt->lock, flags);
870 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
872 static void hub_power_on(struct usb_hub *hub, bool do_delay)
876 /* Enable power on each port. Some hubs have reserved values
877 * of LPSM (> 2) in their descriptors, even though they are
878 * USB 2.0 hubs. Some hubs do not implement port-power switching
879 * but only emulate it. In all cases, the ports won't work
880 * unless we send these messages to the hub.
882 if (hub_is_port_power_switchable(hub))
883 dev_dbg(hub->intfdev, "enabling power on all ports\n");
885 dev_dbg(hub->intfdev, "trying to enable port power on "
886 "non-switchable hub\n");
887 for (port1 = 1; port1 <= hub->hdev->maxchild; port1++)
888 if (test_bit(port1, hub->power_bits))
889 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
891 usb_clear_port_feature(hub->hdev, port1,
892 USB_PORT_FEAT_POWER);
894 msleep(hub_power_on_good_delay(hub));
897 static int hub_hub_status(struct usb_hub *hub,
898 u16 *status, u16 *change)
902 mutex_lock(&hub->status_mutex);
903 ret = get_hub_status(hub->hdev, &hub->status->hub);
906 dev_err(hub->intfdev,
907 "%s failed (err = %d)\n", __func__, ret);
909 *status = le16_to_cpu(hub->status->hub.wHubStatus);
910 *change = le16_to_cpu(hub->status->hub.wHubChange);
913 mutex_unlock(&hub->status_mutex);
917 static int hub_set_port_link_state(struct usb_hub *hub, int port1,
918 unsigned int link_status)
920 return set_port_feature(hub->hdev,
921 port1 | (link_status << 3),
922 USB_PORT_FEAT_LINK_STATE);
926 * Disable a port and mark a logical connect-change event, so that some
927 * time later hub_wq will disconnect() any existing usb_device on the port
928 * and will re-enumerate if there actually is a device attached.
930 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
932 dev_dbg(&hub->ports[port1 - 1]->dev, "logical disconnect\n");
933 hub_port_disable(hub, port1, 1);
935 /* FIXME let caller ask to power down the port:
936 * - some devices won't enumerate without a VBUS power cycle
937 * - SRP saves power that way
938 * - ... new call, TBD ...
939 * That's easy if this hub can switch power per-port, and
940 * hub_wq reactivates the port later (timer, SRP, etc).
941 * Powerdown must be optional, because of reset/DFU.
944 set_bit(port1, hub->change_bits);
949 * usb_remove_device - disable a device's port on its parent hub
950 * @udev: device to be disabled and removed
951 * Context: @udev locked, must be able to sleep.
953 * After @udev's port has been disabled, hub_wq is notified and it will
954 * see that the device has been disconnected. When the device is
955 * physically unplugged and something is plugged in, the events will
956 * be received and processed normally.
958 * Return: 0 if successful. A negative error code otherwise.
960 int usb_remove_device(struct usb_device *udev)
963 struct usb_interface *intf;
966 if (!udev->parent) /* Can't remove a root hub */
968 hub = usb_hub_to_struct_hub(udev->parent);
969 intf = to_usb_interface(hub->intfdev);
971 ret = usb_autopm_get_interface(intf);
975 set_bit(udev->portnum, hub->removed_bits);
976 hub_port_logical_disconnect(hub, udev->portnum);
977 usb_autopm_put_interface(intf);
981 enum hub_activation_type {
982 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
983 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
986 static void hub_init_func2(struct work_struct *ws);
987 static void hub_init_func3(struct work_struct *ws);
989 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
991 struct usb_device *hdev = hub->hdev;
996 bool need_debounce_delay = false;
999 /* Continue a partial initialization */
1000 if (type == HUB_INIT2 || type == HUB_INIT3) {
1001 device_lock(&hdev->dev);
1003 /* Was the hub disconnected while we were waiting? */
1004 if (hub->disconnected)
1006 if (type == HUB_INIT2)
1010 kref_get(&hub->kref);
1012 /* The superspeed hub except for root hub has to use Hub Depth
1013 * value as an offset into the route string to locate the bits
1014 * it uses to determine the downstream port number. So hub driver
1015 * should send a set hub depth request to superspeed hub after
1016 * the superspeed hub is set configuration in initialization or
1019 * After a resume, port power should still be on.
1020 * For any other type of activation, turn it on.
1022 if (type != HUB_RESUME) {
1023 if (hdev->parent && hub_is_superspeed(hdev)) {
1024 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
1025 HUB_SET_DEPTH, USB_RT_HUB,
1026 hdev->level - 1, 0, NULL, 0,
1027 USB_CTRL_SET_TIMEOUT);
1029 dev_err(hub->intfdev,
1030 "set hub depth failed\n");
1033 /* Speed up system boot by using a delayed_work for the
1034 * hub's initial power-up delays. This is pretty awkward
1035 * and the implementation looks like a home-brewed sort of
1036 * setjmp/longjmp, but it saves at least 100 ms for each
1037 * root hub (assuming usbcore is compiled into the kernel
1038 * rather than as a module). It adds up.
1040 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1041 * because for those activation types the ports have to be
1042 * operational when we return. In theory this could be done
1043 * for HUB_POST_RESET, but it's easier not to.
1045 if (type == HUB_INIT) {
1046 delay = hub_power_on_good_delay(hub);
1048 hub_power_on(hub, false);
1049 INIT_DELAYED_WORK(&hub->init_work, hub_init_func2);
1050 queue_delayed_work(system_power_efficient_wq,
1052 msecs_to_jiffies(delay));
1054 /* Suppress autosuspend until init is done */
1055 usb_autopm_get_interface_no_resume(
1056 to_usb_interface(hub->intfdev));
1057 return; /* Continues at init2: below */
1058 } else if (type == HUB_RESET_RESUME) {
1059 /* The internal host controller state for the hub device
1060 * may be gone after a host power loss on system resume.
1061 * Update the device's info so the HW knows it's a hub.
1063 hcd = bus_to_hcd(hdev->bus);
1064 if (hcd->driver->update_hub_device) {
1065 ret = hcd->driver->update_hub_device(hcd, hdev,
1066 &hub->tt, GFP_NOIO);
1068 dev_err(hub->intfdev, "Host not "
1069 "accepting hub info "
1071 dev_err(hub->intfdev, "LS/FS devices "
1072 "and hubs may not work "
1073 "under this hub\n.");
1076 hub_power_on(hub, true);
1078 hub_power_on(hub, true);
1084 * Check each port and set hub->change_bits to let hub_wq know
1085 * which ports need attention.
1087 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
1088 struct usb_port *port_dev = hub->ports[port1 - 1];
1089 struct usb_device *udev = port_dev->child;
1090 u16 portstatus, portchange;
1092 portstatus = portchange = 0;
1093 status = hub_port_status(hub, port1, &portstatus, &portchange);
1097 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1098 dev_dbg(&port_dev->dev, "status %04x change %04x\n",
1099 portstatus, portchange);
1102 * After anything other than HUB_RESUME (i.e., initialization
1103 * or any sort of reset), every port should be disabled.
1104 * Unconnected ports should likewise be disabled (paranoia),
1105 * and so should ports for which we have no usb_device.
1107 if ((portstatus & USB_PORT_STAT_ENABLE) && (
1108 type != HUB_RESUME ||
1109 !(portstatus & USB_PORT_STAT_CONNECTION) ||
1111 udev->state == USB_STATE_NOTATTACHED)) {
1113 * USB3 protocol ports will automatically transition
1114 * to Enabled state when detect an USB3.0 device attach.
1115 * Do not disable USB3 protocol ports, just pretend
1118 portstatus &= ~USB_PORT_STAT_ENABLE;
1119 if (!hub_is_superspeed(hdev))
1120 usb_clear_port_feature(hdev, port1,
1121 USB_PORT_FEAT_ENABLE);
1124 /* Make sure a warm-reset request is handled by port_event */
1125 if (type == HUB_RESUME &&
1126 hub_port_warm_reset_required(hub, port1, portstatus))
1127 set_bit(port1, hub->event_bits);
1130 * Add debounce if USB3 link is in polling/link training state.
1131 * Link will automatically transition to Enabled state after
1132 * link training completes.
1134 if (hub_is_superspeed(hdev) &&
1135 ((portstatus & USB_PORT_STAT_LINK_STATE) ==
1136 USB_SS_PORT_LS_POLLING))
1137 need_debounce_delay = true;
1139 /* Clear status-change flags; we'll debounce later */
1140 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1141 need_debounce_delay = true;
1142 usb_clear_port_feature(hub->hdev, port1,
1143 USB_PORT_FEAT_C_CONNECTION);
1145 if (portchange & USB_PORT_STAT_C_ENABLE) {
1146 need_debounce_delay = true;
1147 usb_clear_port_feature(hub->hdev, port1,
1148 USB_PORT_FEAT_C_ENABLE);
1150 if (portchange & USB_PORT_STAT_C_RESET) {
1151 need_debounce_delay = true;
1152 usb_clear_port_feature(hub->hdev, port1,
1153 USB_PORT_FEAT_C_RESET);
1155 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
1156 hub_is_superspeed(hub->hdev)) {
1157 need_debounce_delay = true;
1158 usb_clear_port_feature(hub->hdev, port1,
1159 USB_PORT_FEAT_C_BH_PORT_RESET);
1161 /* We can forget about a "removed" device when there's a
1162 * physical disconnect or the connect status changes.
1164 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
1165 (portchange & USB_PORT_STAT_C_CONNECTION))
1166 clear_bit(port1, hub->removed_bits);
1168 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
1169 /* Tell hub_wq to disconnect the device or
1170 * check for a new connection or over current condition.
1171 * Based on USB2.0 Spec Section 11.12.5,
1172 * C_PORT_OVER_CURRENT could be set while
1173 * PORT_OVER_CURRENT is not. So check for any of them.
1175 if (udev || (portstatus & USB_PORT_STAT_CONNECTION) ||
1176 (portchange & USB_PORT_STAT_C_CONNECTION) ||
1177 (portstatus & USB_PORT_STAT_OVERCURRENT) ||
1178 (portchange & USB_PORT_STAT_C_OVERCURRENT))
1179 set_bit(port1, hub->change_bits);
1181 } else if (portstatus & USB_PORT_STAT_ENABLE) {
1182 bool port_resumed = (portstatus &
1183 USB_PORT_STAT_LINK_STATE) ==
1185 /* The power session apparently survived the resume.
1186 * If there was an overcurrent or suspend change
1187 * (i.e., remote wakeup request), have hub_wq
1188 * take care of it. Look at the port link state
1189 * for USB 3.0 hubs, since they don't have a suspend
1190 * change bit, and they don't set the port link change
1191 * bit on device-initiated resume.
1193 if (portchange || (hub_is_superspeed(hub->hdev) &&
1195 set_bit(port1, hub->change_bits);
1197 } else if (udev->persist_enabled) {
1199 udev->reset_resume = 1;
1201 /* Don't set the change_bits when the device
1204 if (test_bit(port1, hub->power_bits))
1205 set_bit(port1, hub->change_bits);
1208 /* The power session is gone; tell hub_wq */
1209 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1210 set_bit(port1, hub->change_bits);
1214 /* If no port-status-change flags were set, we don't need any
1215 * debouncing. If flags were set we can try to debounce the
1216 * ports all at once right now, instead of letting hub_wq do them
1217 * one at a time later on.
1219 * If any port-status changes do occur during this delay, hub_wq
1220 * will see them later and handle them normally.
1222 if (need_debounce_delay) {
1223 delay = HUB_DEBOUNCE_STABLE;
1225 /* Don't do a long sleep inside a workqueue routine */
1226 if (type == HUB_INIT2) {
1227 INIT_DELAYED_WORK(&hub->init_work, hub_init_func3);
1228 queue_delayed_work(system_power_efficient_wq,
1230 msecs_to_jiffies(delay));
1231 device_unlock(&hdev->dev);
1232 return; /* Continues at init3: below */
1240 status = usb_submit_urb(hub->urb, GFP_NOIO);
1242 dev_err(hub->intfdev, "activate --> %d\n", status);
1243 if (hub->has_indicators && blinkenlights)
1244 queue_delayed_work(system_power_efficient_wq,
1245 &hub->leds, LED_CYCLE_PERIOD);
1247 /* Scan all ports that need attention */
1250 if (type == HUB_INIT2 || type == HUB_INIT3) {
1251 /* Allow autosuspend if it was suppressed */
1253 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
1254 device_unlock(&hdev->dev);
1257 kref_put(&hub->kref, hub_release);
1260 /* Implement the continuations for the delays above */
1261 static void hub_init_func2(struct work_struct *ws)
1263 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1265 hub_activate(hub, HUB_INIT2);
1268 static void hub_init_func3(struct work_struct *ws)
1270 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1272 hub_activate(hub, HUB_INIT3);
1275 enum hub_quiescing_type {
1276 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
1279 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
1281 struct usb_device *hdev = hub->hdev;
1284 /* hub_wq and related activity won't re-trigger */
1287 if (type != HUB_SUSPEND) {
1288 /* Disconnect all the children */
1289 for (i = 0; i < hdev->maxchild; ++i) {
1290 if (hub->ports[i]->child)
1291 usb_disconnect(&hub->ports[i]->child);
1295 /* Stop hub_wq and related activity */
1296 usb_kill_urb(hub->urb);
1297 if (hub->has_indicators)
1298 cancel_delayed_work_sync(&hub->leds);
1300 flush_work(&hub->tt.clear_work);
1303 static void hub_pm_barrier_for_all_ports(struct usb_hub *hub)
1307 for (i = 0; i < hub->hdev->maxchild; ++i)
1308 pm_runtime_barrier(&hub->ports[i]->dev);
1311 /* caller has locked the hub device */
1312 static int hub_pre_reset(struct usb_interface *intf)
1314 struct usb_hub *hub = usb_get_intfdata(intf);
1316 hub_quiesce(hub, HUB_PRE_RESET);
1318 hub_pm_barrier_for_all_ports(hub);
1322 /* caller has locked the hub device */
1323 static int hub_post_reset(struct usb_interface *intf)
1325 struct usb_hub *hub = usb_get_intfdata(intf);
1328 hub_pm_barrier_for_all_ports(hub);
1329 hub_activate(hub, HUB_POST_RESET);
1333 static int hub_configure(struct usb_hub *hub,
1334 struct usb_endpoint_descriptor *endpoint)
1336 struct usb_hcd *hcd;
1337 struct usb_device *hdev = hub->hdev;
1338 struct device *hub_dev = hub->intfdev;
1339 u16 hubstatus, hubchange;
1340 u16 wHubCharacteristics;
1343 char *message = "out of memory";
1348 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
1354 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1359 mutex_init(&hub->status_mutex);
1361 hub->descriptor = kzalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1362 if (!hub->descriptor) {
1367 /* Request the entire hub descriptor.
1368 * hub->descriptor can handle USB_MAXCHILDREN ports,
1369 * but a (non-SS) hub can/will return fewer bytes here.
1371 ret = get_hub_descriptor(hdev, hub->descriptor);
1373 message = "can't read hub descriptor";
1377 maxchild = USB_MAXCHILDREN;
1378 if (hub_is_superspeed(hdev))
1379 maxchild = min_t(unsigned, maxchild, USB_SS_MAXPORTS);
1381 if (hub->descriptor->bNbrPorts > maxchild) {
1382 message = "hub has too many ports!";
1385 } else if (hub->descriptor->bNbrPorts == 0) {
1386 message = "hub doesn't have any ports!";
1391 maxchild = hub->descriptor->bNbrPorts;
1392 dev_info(hub_dev, "%d port%s detected\n", maxchild,
1393 (maxchild == 1) ? "" : "s");
1395 hub->ports = kzalloc(maxchild * sizeof(struct usb_port *), GFP_KERNEL);
1401 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1402 if (hub_is_superspeed(hdev)) {
1410 /* FIXME for USB 3.0, skip for now */
1411 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1412 !(hub_is_superspeed(hdev))) {
1413 char portstr[USB_MAXCHILDREN + 1];
1415 for (i = 0; i < maxchild; i++)
1416 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1417 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1419 portstr[maxchild] = 0;
1420 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1422 dev_dbg(hub_dev, "standalone hub\n");
1424 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1425 case HUB_CHAR_COMMON_LPSM:
1426 dev_dbg(hub_dev, "ganged power switching\n");
1428 case HUB_CHAR_INDV_PORT_LPSM:
1429 dev_dbg(hub_dev, "individual port power switching\n");
1431 case HUB_CHAR_NO_LPSM:
1433 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1437 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1438 case HUB_CHAR_COMMON_OCPM:
1439 dev_dbg(hub_dev, "global over-current protection\n");
1441 case HUB_CHAR_INDV_PORT_OCPM:
1442 dev_dbg(hub_dev, "individual port over-current protection\n");
1444 case HUB_CHAR_NO_OCPM:
1446 dev_dbg(hub_dev, "no over-current protection\n");
1450 spin_lock_init(&hub->tt.lock);
1451 INIT_LIST_HEAD(&hub->tt.clear_list);
1452 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1453 switch (hdev->descriptor.bDeviceProtocol) {
1456 case USB_HUB_PR_HS_SINGLE_TT:
1457 dev_dbg(hub_dev, "Single TT\n");
1460 case USB_HUB_PR_HS_MULTI_TT:
1461 ret = usb_set_interface(hdev, 0, 1);
1463 dev_dbg(hub_dev, "TT per port\n");
1466 dev_err(hub_dev, "Using single TT (err %d)\n",
1471 /* USB 3.0 hubs don't have a TT */
1474 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1475 hdev->descriptor.bDeviceProtocol);
1479 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1480 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1481 case HUB_TTTT_8_BITS:
1482 if (hdev->descriptor.bDeviceProtocol != 0) {
1483 hub->tt.think_time = 666;
1484 dev_dbg(hub_dev, "TT requires at most %d "
1485 "FS bit times (%d ns)\n",
1486 8, hub->tt.think_time);
1489 case HUB_TTTT_16_BITS:
1490 hub->tt.think_time = 666 * 2;
1491 dev_dbg(hub_dev, "TT requires at most %d "
1492 "FS bit times (%d ns)\n",
1493 16, hub->tt.think_time);
1495 case HUB_TTTT_24_BITS:
1496 hub->tt.think_time = 666 * 3;
1497 dev_dbg(hub_dev, "TT requires at most %d "
1498 "FS bit times (%d ns)\n",
1499 24, hub->tt.think_time);
1501 case HUB_TTTT_32_BITS:
1502 hub->tt.think_time = 666 * 4;
1503 dev_dbg(hub_dev, "TT requires at most %d "
1504 "FS bit times (%d ns)\n",
1505 32, hub->tt.think_time);
1509 /* probe() zeroes hub->indicator[] */
1510 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1511 hub->has_indicators = 1;
1512 dev_dbg(hub_dev, "Port indicators are supported\n");
1515 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1516 hub->descriptor->bPwrOn2PwrGood * 2);
1518 /* power budgeting mostly matters with bus-powered hubs,
1519 * and battery-powered root hubs (may provide just 8 mA).
1521 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1523 message = "can't get hub status";
1526 hcd = bus_to_hcd(hdev->bus);
1527 if (hdev == hdev->bus->root_hub) {
1528 if (hcd->power_budget > 0)
1529 hdev->bus_mA = hcd->power_budget;
1531 hdev->bus_mA = full_load * maxchild;
1532 if (hdev->bus_mA >= full_load)
1533 hub->mA_per_port = full_load;
1535 hub->mA_per_port = hdev->bus_mA;
1536 hub->limited_power = 1;
1538 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1539 int remaining = hdev->bus_mA -
1540 hub->descriptor->bHubContrCurrent;
1542 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1543 hub->descriptor->bHubContrCurrent);
1544 hub->limited_power = 1;
1546 if (remaining < maxchild * unit_load)
1548 "insufficient power available "
1549 "to use all downstream ports\n");
1550 hub->mA_per_port = unit_load; /* 7.2.1 */
1552 } else { /* Self-powered external hub */
1553 /* FIXME: What about battery-powered external hubs that
1554 * provide less current per port? */
1555 hub->mA_per_port = full_load;
1557 if (hub->mA_per_port < full_load)
1558 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1561 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1563 message = "can't get hub status";
1567 /* local power status reports aren't always correct */
1568 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1569 dev_dbg(hub_dev, "local power source is %s\n",
1570 (hubstatus & HUB_STATUS_LOCAL_POWER)
1571 ? "lost (inactive)" : "good");
1573 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1574 dev_dbg(hub_dev, "%sover-current condition exists\n",
1575 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1577 /* set up the interrupt endpoint
1578 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1579 * bytes as USB2.0[11.12.3] says because some hubs are known
1580 * to send more data (and thus cause overflow). For root hubs,
1581 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1582 * to be big enough for at least USB_MAXCHILDREN ports. */
1583 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1584 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1586 if (maxp > sizeof(*hub->buffer))
1587 maxp = sizeof(*hub->buffer);
1589 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1595 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1596 hub, endpoint->bInterval);
1598 /* maybe cycle the hub leds */
1599 if (hub->has_indicators && blinkenlights)
1600 hub->indicator[0] = INDICATOR_CYCLE;
1602 mutex_lock(&usb_port_peer_mutex);
1603 for (i = 0; i < maxchild; i++) {
1604 ret = usb_hub_create_port_device(hub, i + 1);
1606 dev_err(hub->intfdev,
1607 "couldn't create port%d device.\n", i + 1);
1612 for (i = 0; i < hdev->maxchild; i++) {
1613 struct usb_port *port_dev = hub->ports[i];
1615 pm_runtime_put(&port_dev->dev);
1618 mutex_unlock(&usb_port_peer_mutex);
1622 /* Update the HCD's internal representation of this hub before hub_wq
1623 * starts getting port status changes for devices under the hub.
1625 if (hcd->driver->update_hub_device) {
1626 ret = hcd->driver->update_hub_device(hcd, hdev,
1627 &hub->tt, GFP_KERNEL);
1629 message = "can't update HCD hub info";
1634 usb_hub_adjust_deviceremovable(hdev, hub->descriptor);
1636 hub_activate(hub, HUB_INIT);
1640 dev_err(hub_dev, "config failed, %s (err %d)\n",
1642 /* hub_disconnect() frees urb and descriptor */
1646 static void hub_release(struct kref *kref)
1648 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1650 usb_put_dev(hub->hdev);
1651 usb_put_intf(to_usb_interface(hub->intfdev));
1655 static unsigned highspeed_hubs;
1657 static void hub_disconnect(struct usb_interface *intf)
1659 struct usb_hub *hub = usb_get_intfdata(intf);
1660 struct usb_device *hdev = interface_to_usbdev(intf);
1664 * Stop adding new hub events. We do not want to block here and thus
1665 * will not try to remove any pending work item.
1667 hub->disconnected = 1;
1669 /* Disconnect all children and quiesce the hub */
1671 hub_quiesce(hub, HUB_DISCONNECT);
1673 mutex_lock(&usb_port_peer_mutex);
1675 /* Avoid races with recursively_mark_NOTATTACHED() */
1676 spin_lock_irq(&device_state_lock);
1677 port1 = hdev->maxchild;
1679 usb_set_intfdata(intf, NULL);
1680 spin_unlock_irq(&device_state_lock);
1682 for (; port1 > 0; --port1)
1683 usb_hub_remove_port_device(hub, port1);
1685 mutex_unlock(&usb_port_peer_mutex);
1687 if (hub->hdev->speed == USB_SPEED_HIGH)
1690 usb_free_urb(hub->urb);
1692 kfree(hub->descriptor);
1696 pm_suspend_ignore_children(&intf->dev, false);
1698 if (hub->quirk_disable_autosuspend)
1699 usb_autopm_put_interface(intf);
1701 kref_put(&hub->kref, hub_release);
1704 static bool hub_descriptor_is_sane(struct usb_host_interface *desc)
1706 /* Some hubs have a subclass of 1, which AFAICT according to the */
1707 /* specs is not defined, but it works */
1708 if (desc->desc.bInterfaceSubClass != 0 &&
1709 desc->desc.bInterfaceSubClass != 1)
1712 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1713 if (desc->desc.bNumEndpoints != 1)
1716 /* If the first endpoint is not interrupt IN, we'd better punt! */
1717 if (!usb_endpoint_is_int_in(&desc->endpoint[0].desc))
1723 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1725 struct usb_host_interface *desc;
1726 struct usb_device *hdev;
1727 struct usb_hub *hub;
1729 desc = intf->cur_altsetting;
1730 hdev = interface_to_usbdev(intf);
1733 * Set default autosuspend delay as 0 to speedup bus suspend,
1734 * based on the below considerations:
1736 * - Unlike other drivers, the hub driver does not rely on the
1737 * autosuspend delay to provide enough time to handle a wakeup
1738 * event, and the submitted status URB is just to check future
1739 * change on hub downstream ports, so it is safe to do it.
1741 * - The patch might cause one or more auto supend/resume for
1742 * below very rare devices when they are plugged into hub
1745 * devices having trouble initializing, and disconnect
1746 * themselves from the bus and then reconnect a second
1749 * devices just for downloading firmware, and disconnects
1750 * themselves after completing it
1752 * For these quite rare devices, their drivers may change the
1753 * autosuspend delay of their parent hub in the probe() to one
1754 * appropriate value to avoid the subtle problem if someone
1757 * - The patch may cause one or more auto suspend/resume on
1758 * hub during running 'lsusb', but it is probably too
1759 * infrequent to worry about.
1761 * - Change autosuspend delay of hub can avoid unnecessary auto
1762 * suspend timer for hub, also may decrease power consumption
1765 * - If user has indicated to prevent autosuspend by passing
1766 * usbcore.autosuspend = -1 then keep autosuspend disabled.
1769 if (hdev->dev.power.autosuspend_delay >= 0)
1770 pm_runtime_set_autosuspend_delay(&hdev->dev, 0);
1774 * Hubs have proper suspend/resume support, except for root hubs
1775 * where the controller driver doesn't have bus_suspend and
1776 * bus_resume methods.
1778 if (hdev->parent) { /* normal device */
1779 usb_enable_autosuspend(hdev);
1780 } else { /* root hub */
1781 const struct hc_driver *drv = bus_to_hcd(hdev->bus)->driver;
1783 if (drv->bus_suspend && drv->bus_resume)
1784 usb_enable_autosuspend(hdev);
1787 if (hdev->level == MAX_TOPO_LEVEL) {
1789 "Unsupported bus topology: hub nested too deep\n");
1793 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1795 dev_warn(&intf->dev, "ignoring external hub\n");
1800 if (!hub_descriptor_is_sane(desc)) {
1801 dev_err(&intf->dev, "bad descriptor, ignoring hub\n");
1805 /* We found a hub */
1806 dev_info(&intf->dev, "USB hub found\n");
1808 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1812 kref_init(&hub->kref);
1813 hub->intfdev = &intf->dev;
1815 INIT_DELAYED_WORK(&hub->leds, led_work);
1816 INIT_DELAYED_WORK(&hub->init_work, NULL);
1817 INIT_WORK(&hub->events, hub_event);
1821 usb_set_intfdata(intf, hub);
1822 intf->needs_remote_wakeup = 1;
1823 pm_suspend_ignore_children(&intf->dev, true);
1825 if (hdev->speed == USB_SPEED_HIGH)
1828 if (id->driver_info & HUB_QUIRK_CHECK_PORT_AUTOSUSPEND)
1829 hub->quirk_check_port_auto_suspend = 1;
1831 if (id->driver_info & HUB_QUIRK_DISABLE_AUTOSUSPEND) {
1832 hub->quirk_disable_autosuspend = 1;
1833 usb_autopm_get_interface_no_resume(intf);
1836 if (hub_configure(hub, &desc->endpoint[0].desc) >= 0)
1839 hub_disconnect(intf);
1844 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1846 struct usb_device *hdev = interface_to_usbdev(intf);
1847 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1849 /* assert ifno == 0 (part of hub spec) */
1851 case USBDEVFS_HUB_PORTINFO: {
1852 struct usbdevfs_hub_portinfo *info = user_data;
1855 spin_lock_irq(&device_state_lock);
1856 if (hdev->devnum <= 0)
1859 info->nports = hdev->maxchild;
1860 for (i = 0; i < info->nports; i++) {
1861 if (hub->ports[i]->child == NULL)
1865 hub->ports[i]->child->devnum;
1868 spin_unlock_irq(&device_state_lock);
1870 return info->nports + 1;
1879 * Allow user programs to claim ports on a hub. When a device is attached
1880 * to one of these "claimed" ports, the program will "own" the device.
1882 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1883 struct usb_dev_state ***ppowner)
1885 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1887 if (hdev->state == USB_STATE_NOTATTACHED)
1889 if (port1 == 0 || port1 > hdev->maxchild)
1892 /* Devices not managed by the hub driver
1893 * will always have maxchild equal to 0.
1895 *ppowner = &(hub->ports[port1 - 1]->port_owner);
1899 /* In the following three functions, the caller must hold hdev's lock */
1900 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
1901 struct usb_dev_state *owner)
1904 struct usb_dev_state **powner;
1906 rc = find_port_owner(hdev, port1, &powner);
1914 EXPORT_SYMBOL_GPL(usb_hub_claim_port);
1916 int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
1917 struct usb_dev_state *owner)
1920 struct usb_dev_state **powner;
1922 rc = find_port_owner(hdev, port1, &powner);
1925 if (*powner != owner)
1930 EXPORT_SYMBOL_GPL(usb_hub_release_port);
1932 void usb_hub_release_all_ports(struct usb_device *hdev, struct usb_dev_state *owner)
1934 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1937 for (n = 0; n < hdev->maxchild; n++) {
1938 if (hub->ports[n]->port_owner == owner)
1939 hub->ports[n]->port_owner = NULL;
1944 /* The caller must hold udev's lock */
1945 bool usb_device_is_owned(struct usb_device *udev)
1947 struct usb_hub *hub;
1949 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1951 hub = usb_hub_to_struct_hub(udev->parent);
1952 return !!hub->ports[udev->portnum - 1]->port_owner;
1955 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1957 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
1960 for (i = 0; i < udev->maxchild; ++i) {
1961 if (hub->ports[i]->child)
1962 recursively_mark_NOTATTACHED(hub->ports[i]->child);
1964 if (udev->state == USB_STATE_SUSPENDED)
1965 udev->active_duration -= jiffies;
1966 udev->state = USB_STATE_NOTATTACHED;
1970 * usb_set_device_state - change a device's current state (usbcore, hcds)
1971 * @udev: pointer to device whose state should be changed
1972 * @new_state: new state value to be stored
1974 * udev->state is _not_ fully protected by the device lock. Although
1975 * most transitions are made only while holding the lock, the state can
1976 * can change to USB_STATE_NOTATTACHED at almost any time. This
1977 * is so that devices can be marked as disconnected as soon as possible,
1978 * without having to wait for any semaphores to be released. As a result,
1979 * all changes to any device's state must be protected by the
1980 * device_state_lock spinlock.
1982 * Once a device has been added to the device tree, all changes to its state
1983 * should be made using this routine. The state should _not_ be set directly.
1985 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1986 * Otherwise udev->state is set to new_state, and if new_state is
1987 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1988 * to USB_STATE_NOTATTACHED.
1990 void usb_set_device_state(struct usb_device *udev,
1991 enum usb_device_state new_state)
1993 unsigned long flags;
1996 spin_lock_irqsave(&device_state_lock, flags);
1997 if (udev->state == USB_STATE_NOTATTACHED)
1999 else if (new_state != USB_STATE_NOTATTACHED) {
2001 /* root hub wakeup capabilities are managed out-of-band
2002 * and may involve silicon errata ... ignore them here.
2005 if (udev->state == USB_STATE_SUSPENDED
2006 || new_state == USB_STATE_SUSPENDED)
2007 ; /* No change to wakeup settings */
2008 else if (new_state == USB_STATE_CONFIGURED)
2009 wakeup = (udev->quirks &
2010 USB_QUIRK_IGNORE_REMOTE_WAKEUP) ? 0 :
2011 udev->actconfig->desc.bmAttributes &
2012 USB_CONFIG_ATT_WAKEUP;
2016 if (udev->state == USB_STATE_SUSPENDED &&
2017 new_state != USB_STATE_SUSPENDED)
2018 udev->active_duration -= jiffies;
2019 else if (new_state == USB_STATE_SUSPENDED &&
2020 udev->state != USB_STATE_SUSPENDED)
2021 udev->active_duration += jiffies;
2022 udev->state = new_state;
2024 recursively_mark_NOTATTACHED(udev);
2025 spin_unlock_irqrestore(&device_state_lock, flags);
2027 device_set_wakeup_capable(&udev->dev, wakeup);
2029 EXPORT_SYMBOL_GPL(usb_set_device_state);
2032 * Choose a device number.
2034 * Device numbers are used as filenames in usbfs. On USB-1.1 and
2035 * USB-2.0 buses they are also used as device addresses, however on
2036 * USB-3.0 buses the address is assigned by the controller hardware
2037 * and it usually is not the same as the device number.
2039 * WUSB devices are simple: they have no hubs behind, so the mapping
2040 * device <-> virtual port number becomes 1:1. Why? to simplify the
2041 * life of the device connection logic in
2042 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
2043 * handshake we need to assign a temporary address in the unauthorized
2044 * space. For simplicity we use the first virtual port number found to
2045 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
2046 * and that becomes it's address [X < 128] or its unauthorized address
2049 * We add 1 as an offset to the one-based USB-stack port number
2050 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
2051 * 0 is reserved by USB for default address; (b) Linux's USB stack
2052 * uses always #1 for the root hub of the controller. So USB stack's
2053 * port #1, which is wusb virtual-port #0 has address #2.
2055 * Devices connected under xHCI are not as simple. The host controller
2056 * supports virtualization, so the hardware assigns device addresses and
2057 * the HCD must setup data structures before issuing a set address
2058 * command to the hardware.
2060 static void choose_devnum(struct usb_device *udev)
2063 struct usb_bus *bus = udev->bus;
2065 /* be safe when more hub events are proceed in parallel */
2066 mutex_lock(&bus->devnum_next_mutex);
2068 devnum = udev->portnum + 1;
2069 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
2071 /* Try to allocate the next devnum beginning at
2072 * bus->devnum_next. */
2073 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
2076 devnum = find_next_zero_bit(bus->devmap.devicemap,
2078 bus->devnum_next = (devnum >= 127 ? 1 : devnum + 1);
2081 set_bit(devnum, bus->devmap.devicemap);
2082 udev->devnum = devnum;
2084 mutex_unlock(&bus->devnum_next_mutex);
2087 static void release_devnum(struct usb_device *udev)
2089 if (udev->devnum > 0) {
2090 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
2095 static void update_devnum(struct usb_device *udev, int devnum)
2097 /* The address for a WUSB device is managed by wusbcore. */
2099 udev->devnum = devnum;
2102 static void hub_free_dev(struct usb_device *udev)
2104 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2106 /* Root hubs aren't real devices, so don't free HCD resources */
2107 if (hcd->driver->free_dev && udev->parent)
2108 hcd->driver->free_dev(hcd, udev);
2111 static void hub_disconnect_children(struct usb_device *udev)
2113 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2116 /* Free up all the children before we remove this device */
2117 for (i = 0; i < udev->maxchild; i++) {
2118 if (hub->ports[i]->child)
2119 usb_disconnect(&hub->ports[i]->child);
2124 * usb_disconnect - disconnect a device (usbcore-internal)
2125 * @pdev: pointer to device being disconnected
2126 * Context: !in_interrupt ()
2128 * Something got disconnected. Get rid of it and all of its children.
2130 * If *pdev is a normal device then the parent hub must already be locked.
2131 * If *pdev is a root hub then the caller must hold the usb_bus_idr_lock,
2132 * which protects the set of root hubs as well as the list of buses.
2134 * Only hub drivers (including virtual root hub drivers for host
2135 * controllers) should ever call this.
2137 * This call is synchronous, and may not be used in an interrupt context.
2139 void usb_disconnect(struct usb_device **pdev)
2141 struct usb_port *port_dev = NULL;
2142 struct usb_device *udev = *pdev;
2143 struct usb_hub *hub = NULL;
2146 /* mark the device as inactive, so any further urb submissions for
2147 * this device (and any of its children) will fail immediately.
2148 * this quiesces everything except pending urbs.
2150 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2151 dev_info(&udev->dev, "USB disconnect, device number %d\n",
2155 * Ensure that the pm runtime code knows that the USB device
2156 * is in the process of being disconnected.
2158 pm_runtime_barrier(&udev->dev);
2160 usb_lock_device(udev);
2162 hub_disconnect_children(udev);
2164 /* deallocate hcd/hardware state ... nuking all pending urbs and
2165 * cleaning up all state associated with the current configuration
2166 * so that the hardware is now fully quiesced.
2168 dev_dbg(&udev->dev, "unregistering device\n");
2169 usb_disable_device(udev, 0);
2170 usb_hcd_synchronize_unlinks(udev);
2173 port1 = udev->portnum;
2174 hub = usb_hub_to_struct_hub(udev->parent);
2175 port_dev = hub->ports[port1 - 1];
2177 sysfs_remove_link(&udev->dev.kobj, "port");
2178 sysfs_remove_link(&port_dev->dev.kobj, "device");
2181 * As usb_port_runtime_resume() de-references udev, make
2182 * sure no resumes occur during removal
2184 if (!test_and_set_bit(port1, hub->child_usage_bits))
2185 pm_runtime_get_sync(&port_dev->dev);
2188 usb_remove_ep_devs(&udev->ep0);
2189 usb_unlock_device(udev);
2191 /* Unregister the device. The device driver is responsible
2192 * for de-configuring the device and invoking the remove-device
2193 * notifier chain (used by usbfs and possibly others).
2195 device_del(&udev->dev);
2197 /* Free the device number and delete the parent's children[]
2198 * (or root_hub) pointer.
2200 release_devnum(udev);
2202 /* Avoid races with recursively_mark_NOTATTACHED() */
2203 spin_lock_irq(&device_state_lock);
2205 spin_unlock_irq(&device_state_lock);
2207 if (port_dev && test_and_clear_bit(port1, hub->child_usage_bits))
2208 pm_runtime_put(&port_dev->dev);
2212 put_device(&udev->dev);
2215 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2216 static void show_string(struct usb_device *udev, char *id, char *string)
2220 dev_info(&udev->dev, "%s: %s\n", id, string);
2223 static void announce_device(struct usb_device *udev)
2225 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2226 le16_to_cpu(udev->descriptor.idVendor),
2227 le16_to_cpu(udev->descriptor.idProduct));
2228 dev_info(&udev->dev,
2229 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2230 udev->descriptor.iManufacturer,
2231 udev->descriptor.iProduct,
2232 udev->descriptor.iSerialNumber);
2233 show_string(udev, "Product", udev->product);
2234 show_string(udev, "Manufacturer", udev->manufacturer);
2235 show_string(udev, "SerialNumber", udev->serial);
2238 static inline void announce_device(struct usb_device *udev) { }
2243 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2244 * @udev: newly addressed device (in ADDRESS state)
2246 * Finish enumeration for On-The-Go devices
2248 * Return: 0 if successful. A negative error code otherwise.
2250 static int usb_enumerate_device_otg(struct usb_device *udev)
2254 #ifdef CONFIG_USB_OTG
2256 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2257 * to wake us after we've powered off VBUS; and HNP, switching roles
2258 * "host" to "peripheral". The OTG descriptor helps figure this out.
2260 if (!udev->bus->is_b_host
2262 && udev->parent == udev->bus->root_hub) {
2263 struct usb_otg_descriptor *desc = NULL;
2264 struct usb_bus *bus = udev->bus;
2265 unsigned port1 = udev->portnum;
2267 /* descriptor may appear anywhere in config */
2268 err = __usb_get_extra_descriptor(udev->rawdescriptors[0],
2269 le16_to_cpu(udev->config[0].desc.wTotalLength),
2270 USB_DT_OTG, (void **) &desc, sizeof(*desc));
2271 if (err || !(desc->bmAttributes & USB_OTG_HNP))
2274 dev_info(&udev->dev, "Dual-Role OTG device on %sHNP port\n",
2275 (port1 == bus->otg_port) ? "" : "non-");
2277 /* enable HNP before suspend, it's simpler */
2278 if (port1 == bus->otg_port) {
2279 bus->b_hnp_enable = 1;
2280 err = usb_control_msg(udev,
2281 usb_sndctrlpipe(udev, 0),
2282 USB_REQ_SET_FEATURE, 0,
2283 USB_DEVICE_B_HNP_ENABLE,
2285 USB_CTRL_SET_TIMEOUT);
2288 * OTG MESSAGE: report errors here,
2289 * customize to match your product.
2291 dev_err(&udev->dev, "can't set HNP mode: %d\n",
2293 bus->b_hnp_enable = 0;
2295 } else if (desc->bLength == sizeof
2296 (struct usb_otg_descriptor)) {
2297 /* Set a_alt_hnp_support for legacy otg device */
2298 err = usb_control_msg(udev,
2299 usb_sndctrlpipe(udev, 0),
2300 USB_REQ_SET_FEATURE, 0,
2301 USB_DEVICE_A_ALT_HNP_SUPPORT,
2303 USB_CTRL_SET_TIMEOUT);
2306 "set a_alt_hnp_support failed: %d\n",
2316 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2317 * @udev: newly addressed device (in ADDRESS state)
2319 * This is only called by usb_new_device() and usb_authorize_device()
2320 * and FIXME -- all comments that apply to them apply here wrt to
2323 * If the device is WUSB and not authorized, we don't attempt to read
2324 * the string descriptors, as they will be errored out by the device
2325 * until it has been authorized.
2327 * Return: 0 if successful. A negative error code otherwise.
2329 static int usb_enumerate_device(struct usb_device *udev)
2332 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2334 if (udev->config == NULL) {
2335 err = usb_get_configuration(udev);
2338 dev_err(&udev->dev, "can't read configurations, error %d\n",
2344 /* read the standard strings and cache them if present */
2345 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
2346 udev->manufacturer = usb_cache_string(udev,
2347 udev->descriptor.iManufacturer);
2348 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
2350 err = usb_enumerate_device_otg(udev);
2354 if (IS_ENABLED(CONFIG_USB_OTG_WHITELIST) && hcd->tpl_support &&
2355 !is_targeted(udev)) {
2356 /* Maybe it can talk to us, though we can't talk to it.
2357 * (Includes HNP test device.)
2359 if (IS_ENABLED(CONFIG_USB_OTG) && (udev->bus->b_hnp_enable
2360 || udev->bus->is_b_host)) {
2361 err = usb_port_suspend(udev, PMSG_AUTO_SUSPEND);
2363 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
2368 usb_detect_interface_quirks(udev);
2373 static void set_usb_port_removable(struct usb_device *udev)
2375 struct usb_device *hdev = udev->parent;
2376 struct usb_hub *hub;
2377 u8 port = udev->portnum;
2378 u16 wHubCharacteristics;
2379 bool removable = true;
2384 hub = usb_hub_to_struct_hub(udev->parent);
2387 * If the platform firmware has provided information about a port,
2388 * use that to determine whether it's removable.
2390 switch (hub->ports[udev->portnum - 1]->connect_type) {
2391 case USB_PORT_CONNECT_TYPE_HOT_PLUG:
2392 udev->removable = USB_DEVICE_REMOVABLE;
2394 case USB_PORT_CONNECT_TYPE_HARD_WIRED:
2395 case USB_PORT_NOT_USED:
2396 udev->removable = USB_DEVICE_FIXED;
2403 * Otherwise, check whether the hub knows whether a port is removable
2406 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2408 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
2411 if (hub_is_superspeed(hdev)) {
2412 if (le16_to_cpu(hub->descriptor->u.ss.DeviceRemovable)
2416 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
2421 udev->removable = USB_DEVICE_REMOVABLE;
2423 udev->removable = USB_DEVICE_FIXED;
2428 * usb_new_device - perform initial device setup (usbcore-internal)
2429 * @udev: newly addressed device (in ADDRESS state)
2431 * This is called with devices which have been detected but not fully
2432 * enumerated. The device descriptor is available, but not descriptors
2433 * for any device configuration. The caller must have locked either
2434 * the parent hub (if udev is a normal device) or else the
2435 * usb_bus_idr_lock (if udev is a root hub). The parent's pointer to
2436 * udev has already been installed, but udev is not yet visible through
2437 * sysfs or other filesystem code.
2439 * This call is synchronous, and may not be used in an interrupt context.
2441 * Only the hub driver or root-hub registrar should ever call this.
2443 * Return: Whether the device is configured properly or not. Zero if the
2444 * interface was registered with the driver core; else a negative errno
2448 int usb_new_device(struct usb_device *udev)
2453 /* Initialize non-root-hub device wakeup to disabled;
2454 * device (un)configuration controls wakeup capable
2455 * sysfs power/wakeup controls wakeup enabled/disabled
2457 device_init_wakeup(&udev->dev, 0);
2460 /* Tell the runtime-PM framework the device is active */
2461 pm_runtime_set_active(&udev->dev);
2462 pm_runtime_get_noresume(&udev->dev);
2463 pm_runtime_use_autosuspend(&udev->dev);
2464 pm_runtime_enable(&udev->dev);
2466 /* By default, forbid autosuspend for all devices. It will be
2467 * allowed for hubs during binding.
2469 usb_disable_autosuspend(udev);
2471 err = usb_enumerate_device(udev); /* Read descriptors */
2474 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
2475 udev->devnum, udev->bus->busnum,
2476 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2477 /* export the usbdev device-node for libusb */
2478 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
2479 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2481 /* Tell the world! */
2482 announce_device(udev);
2485 add_device_randomness(udev->serial, strlen(udev->serial));
2487 add_device_randomness(udev->product, strlen(udev->product));
2488 if (udev->manufacturer)
2489 add_device_randomness(udev->manufacturer,
2490 strlen(udev->manufacturer));
2492 device_enable_async_suspend(&udev->dev);
2494 /* check whether the hub or firmware marks this port as non-removable */
2496 set_usb_port_removable(udev);
2498 /* Register the device. The device driver is responsible
2499 * for configuring the device and invoking the add-device
2500 * notifier chain (used by usbfs and possibly others).
2502 err = device_add(&udev->dev);
2504 dev_err(&udev->dev, "can't device_add, error %d\n", err);
2508 /* Create link files between child device and usb port device. */
2510 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2511 int port1 = udev->portnum;
2512 struct usb_port *port_dev = hub->ports[port1 - 1];
2514 err = sysfs_create_link(&udev->dev.kobj,
2515 &port_dev->dev.kobj, "port");
2519 err = sysfs_create_link(&port_dev->dev.kobj,
2520 &udev->dev.kobj, "device");
2522 sysfs_remove_link(&udev->dev.kobj, "port");
2526 if (!test_and_set_bit(port1, hub->child_usage_bits))
2527 pm_runtime_get_sync(&port_dev->dev);
2530 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
2531 usb_mark_last_busy(udev);
2532 pm_runtime_put_sync_autosuspend(&udev->dev);
2536 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2537 pm_runtime_disable(&udev->dev);
2538 pm_runtime_set_suspended(&udev->dev);
2544 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2545 * @usb_dev: USB device
2547 * Move the USB device to a very basic state where interfaces are disabled
2548 * and the device is in fact unconfigured and unusable.
2550 * We share a lock (that we have) with device_del(), so we need to
2555 int usb_deauthorize_device(struct usb_device *usb_dev)
2557 usb_lock_device(usb_dev);
2558 if (usb_dev->authorized == 0)
2559 goto out_unauthorized;
2561 usb_dev->authorized = 0;
2562 usb_set_configuration(usb_dev, -1);
2565 usb_unlock_device(usb_dev);
2570 int usb_authorize_device(struct usb_device *usb_dev)
2574 usb_lock_device(usb_dev);
2575 if (usb_dev->authorized == 1)
2576 goto out_authorized;
2578 result = usb_autoresume_device(usb_dev);
2580 dev_err(&usb_dev->dev,
2581 "can't autoresume for authorization: %d\n", result);
2582 goto error_autoresume;
2585 if (usb_dev->wusb) {
2586 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2588 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2589 "authorization: %d\n", result);
2590 goto error_device_descriptor;
2594 usb_dev->authorized = 1;
2595 /* Choose and set the configuration. This registers the interfaces
2596 * with the driver core and lets interface drivers bind to them.
2598 c = usb_choose_configuration(usb_dev);
2600 result = usb_set_configuration(usb_dev, c);
2602 dev_err(&usb_dev->dev,
2603 "can't set config #%d, error %d\n", c, result);
2604 /* This need not be fatal. The user can try to
2605 * set other configurations. */
2608 dev_info(&usb_dev->dev, "authorized to connect\n");
2610 error_device_descriptor:
2611 usb_autosuspend_device(usb_dev);
2614 usb_unlock_device(usb_dev); /* complements locktree */
2619 * Return 1 if port speed is SuperSpeedPlus, 0 otherwise
2620 * check it from the link protocol field of the current speed ID attribute.
2621 * current speed ID is got from ext port status request. Sublink speed attribute
2622 * table is returned with the hub BOS SSP device capability descriptor
2624 static int port_speed_is_ssp(struct usb_device *hdev, int speed_id)
2629 struct usb_ssp_cap_descriptor *ssp_cap = hdev->bos->ssp_cap;
2634 ssa_count = le32_to_cpu(ssp_cap->bmAttributes) &
2635 USB_SSP_SUBLINK_SPEED_ATTRIBS;
2637 for (i = 0; i <= ssa_count; i++) {
2638 ss_attr = le32_to_cpu(ssp_cap->bmSublinkSpeedAttr[i]);
2639 if (speed_id == (ss_attr & USB_SSP_SUBLINK_SPEED_SSID))
2640 return !!(ss_attr & USB_SSP_SUBLINK_SPEED_LP);
2645 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2646 static unsigned hub_is_wusb(struct usb_hub *hub)
2648 struct usb_hcd *hcd;
2649 if (hub->hdev->parent != NULL) /* not a root hub? */
2651 hcd = bus_to_hcd(hub->hdev->bus);
2652 return hcd->wireless;
2656 #define PORT_RESET_TRIES 5
2657 #define SET_ADDRESS_TRIES 2
2658 #define GET_DESCRIPTOR_TRIES 2
2659 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2660 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2662 #define HUB_ROOT_RESET_TIME 60 /* times are in msec */
2663 #define HUB_SHORT_RESET_TIME 10
2664 #define HUB_BH_RESET_TIME 50
2665 #define HUB_LONG_RESET_TIME 200
2666 #define HUB_RESET_TIMEOUT 800
2669 * "New scheme" enumeration causes an extra state transition to be
2670 * exposed to an xhci host and causes USB3 devices to receive control
2671 * commands in the default state. This has been seen to cause
2672 * enumeration failures, so disable this enumeration scheme for USB3
2675 static bool use_new_scheme(struct usb_device *udev, int retry)
2677 if (udev->speed >= USB_SPEED_SUPER)
2680 return USE_NEW_SCHEME(retry);
2683 /* Is a USB 3.0 port in the Inactive or Compliance Mode state?
2684 * Port worm reset is required to recover
2686 static bool hub_port_warm_reset_required(struct usb_hub *hub, int port1,
2691 if (!hub_is_superspeed(hub->hdev))
2694 if (test_bit(port1, hub->warm_reset_bits))
2697 link_state = portstatus & USB_PORT_STAT_LINK_STATE;
2698 return link_state == USB_SS_PORT_LS_SS_INACTIVE
2699 || link_state == USB_SS_PORT_LS_COMP_MOD;
2702 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2703 struct usb_device *udev, unsigned int delay, bool warm)
2705 int delay_time, ret;
2708 u32 ext_portstatus = 0;
2710 for (delay_time = 0;
2711 delay_time < HUB_RESET_TIMEOUT;
2712 delay_time += delay) {
2713 /* wait to give the device a chance to reset */
2716 /* read and decode port status */
2717 if (hub_is_superspeedplus(hub->hdev))
2718 ret = hub_ext_port_status(hub, port1,
2719 HUB_EXT_PORT_STATUS,
2720 &portstatus, &portchange,
2723 ret = hub_port_status(hub, port1, &portstatus,
2729 * The port state is unknown until the reset completes.
2731 * On top of that, some chips may require additional time
2732 * to re-establish a connection after the reset is complete,
2733 * so also wait for the connection to be re-established.
2735 if (!(portstatus & USB_PORT_STAT_RESET) &&
2736 (portstatus & USB_PORT_STAT_CONNECTION))
2739 /* switch to the long delay after two short delay failures */
2740 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2741 delay = HUB_LONG_RESET_TIME;
2743 dev_dbg(&hub->ports[port1 - 1]->dev,
2744 "not %sreset yet, waiting %dms\n",
2745 warm ? "warm " : "", delay);
2748 if ((portstatus & USB_PORT_STAT_RESET))
2751 if (hub_port_warm_reset_required(hub, port1, portstatus))
2754 /* Device went away? */
2755 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2758 /* Retry if connect change is set but status is still connected.
2759 * A USB 3.0 connection may bounce if multiple warm resets were issued,
2760 * but the device may have successfully re-connected. Ignore it.
2762 if (!hub_is_superspeed(hub->hdev) &&
2763 (portchange & USB_PORT_STAT_C_CONNECTION)) {
2764 usb_clear_port_feature(hub->hdev, port1,
2765 USB_PORT_FEAT_C_CONNECTION);
2769 if (!(portstatus & USB_PORT_STAT_ENABLE))
2775 if (hub_is_wusb(hub))
2776 udev->speed = USB_SPEED_WIRELESS;
2777 else if (hub_is_superspeedplus(hub->hdev) &&
2778 port_speed_is_ssp(hub->hdev, ext_portstatus &
2779 USB_EXT_PORT_STAT_RX_SPEED_ID))
2780 udev->speed = USB_SPEED_SUPER_PLUS;
2781 else if (hub_is_superspeed(hub->hdev))
2782 udev->speed = USB_SPEED_SUPER;
2783 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2784 udev->speed = USB_SPEED_HIGH;
2785 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2786 udev->speed = USB_SPEED_LOW;
2788 udev->speed = USB_SPEED_FULL;
2792 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2793 static int hub_port_reset(struct usb_hub *hub, int port1,
2794 struct usb_device *udev, unsigned int delay, bool warm)
2797 u16 portchange, portstatus;
2798 struct usb_port *port_dev = hub->ports[port1 - 1];
2800 if (!hub_is_superspeed(hub->hdev)) {
2802 dev_err(hub->intfdev, "only USB3 hub support "
2806 /* Block EHCI CF initialization during the port reset.
2807 * Some companion controllers don't like it when they mix.
2809 down_read(&ehci_cf_port_reset_rwsem);
2812 * If the caller hasn't explicitly requested a warm reset,
2813 * double check and see if one is needed.
2815 if (hub_port_status(hub, port1, &portstatus, &portchange) == 0)
2816 if (hub_port_warm_reset_required(hub, port1,
2820 clear_bit(port1, hub->warm_reset_bits);
2822 /* Reset the port */
2823 for (i = 0; i < PORT_RESET_TRIES; i++) {
2824 status = set_port_feature(hub->hdev, port1, (warm ?
2825 USB_PORT_FEAT_BH_PORT_RESET :
2826 USB_PORT_FEAT_RESET));
2827 if (status == -ENODEV) {
2828 ; /* The hub is gone */
2829 } else if (status) {
2830 dev_err(&port_dev->dev,
2831 "cannot %sreset (err = %d)\n",
2832 warm ? "warm " : "", status);
2834 status = hub_port_wait_reset(hub, port1, udev, delay,
2836 if (status && status != -ENOTCONN && status != -ENODEV)
2837 dev_dbg(hub->intfdev,
2838 "port_wait_reset: err = %d\n",
2842 /* Check for disconnect or reset */
2843 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2844 usb_clear_port_feature(hub->hdev, port1,
2845 USB_PORT_FEAT_C_RESET);
2847 if (!hub_is_superspeed(hub->hdev))
2850 usb_clear_port_feature(hub->hdev, port1,
2851 USB_PORT_FEAT_C_BH_PORT_RESET);
2852 usb_clear_port_feature(hub->hdev, port1,
2853 USB_PORT_FEAT_C_PORT_LINK_STATE);
2856 usb_clear_port_feature(hub->hdev, port1,
2857 USB_PORT_FEAT_C_CONNECTION);
2860 * If a USB 3.0 device migrates from reset to an error
2861 * state, re-issue the warm reset.
2863 if (hub_port_status(hub, port1,
2864 &portstatus, &portchange) < 0)
2867 if (!hub_port_warm_reset_required(hub, port1,
2872 * If the port is in SS.Inactive or Compliance Mode, the
2873 * hot or warm reset failed. Try another warm reset.
2876 dev_dbg(&port_dev->dev,
2877 "hot reset failed, warm reset\n");
2882 dev_dbg(&port_dev->dev,
2883 "not enabled, trying %sreset again...\n",
2884 warm ? "warm " : "");
2885 delay = HUB_LONG_RESET_TIME;
2888 dev_err(&port_dev->dev, "Cannot enable. Maybe the USB cable is bad?\n");
2892 /* TRSTRCY = 10 ms; plus some extra */
2895 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2897 update_devnum(udev, 0);
2898 /* The xHC may think the device is already reset,
2899 * so ignore the status.
2901 if (hcd->driver->reset_device)
2902 hcd->driver->reset_device(hcd, udev);
2904 usb_set_device_state(udev, USB_STATE_DEFAULT);
2908 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2911 if (!hub_is_superspeed(hub->hdev))
2912 up_read(&ehci_cf_port_reset_rwsem);
2917 /* Check if a port is power on */
2918 static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2922 if (hub_is_superspeed(hub->hdev)) {
2923 if (portstatus & USB_SS_PORT_STAT_POWER)
2926 if (portstatus & USB_PORT_STAT_POWER)
2933 static void usb_lock_port(struct usb_port *port_dev)
2934 __acquires(&port_dev->status_lock)
2936 mutex_lock(&port_dev->status_lock);
2937 __acquire(&port_dev->status_lock);
2940 static void usb_unlock_port(struct usb_port *port_dev)
2941 __releases(&port_dev->status_lock)
2943 mutex_unlock(&port_dev->status_lock);
2944 __release(&port_dev->status_lock);
2949 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2950 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
2954 if (hub_is_superspeed(hub->hdev)) {
2955 if ((portstatus & USB_PORT_STAT_LINK_STATE)
2956 == USB_SS_PORT_LS_U3)
2959 if (portstatus & USB_PORT_STAT_SUSPEND)
2966 /* Determine whether the device on a port is ready for a normal resume,
2967 * is ready for a reset-resume, or should be disconnected.
2969 static int check_port_resume_type(struct usb_device *udev,
2970 struct usb_hub *hub, int port1,
2971 int status, u16 portchange, u16 portstatus)
2973 struct usb_port *port_dev = hub->ports[port1 - 1];
2977 /* Is a warm reset needed to recover the connection? */
2978 if (status == 0 && udev->reset_resume
2979 && hub_port_warm_reset_required(hub, port1, portstatus)) {
2982 /* Is the device still present? */
2983 else if (status || port_is_suspended(hub, portstatus) ||
2984 !port_is_power_on(hub, portstatus)) {
2987 } else if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
2989 usleep_range(200, 300);
2990 status = hub_port_status(hub, port1, &portstatus,
2997 /* Can't do a normal resume if the port isn't enabled,
2998 * so try a reset-resume instead.
3000 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
3001 if (udev->persist_enabled)
3002 udev->reset_resume = 1;
3008 dev_dbg(&port_dev->dev, "status %04x.%04x after resume, %d\n",
3009 portchange, portstatus, status);
3010 } else if (udev->reset_resume) {
3012 /* Late port handoff can set status-change bits */
3013 if (portchange & USB_PORT_STAT_C_CONNECTION)
3014 usb_clear_port_feature(hub->hdev, port1,
3015 USB_PORT_FEAT_C_CONNECTION);
3016 if (portchange & USB_PORT_STAT_C_ENABLE)
3017 usb_clear_port_feature(hub->hdev, port1,
3018 USB_PORT_FEAT_C_ENABLE);
3021 * Whatever made this reset-resume necessary may have
3022 * turned on the port1 bit in hub->change_bits. But after
3023 * a successful reset-resume we want the bit to be clear;
3024 * if it was on it would indicate that something happened
3025 * following the reset-resume.
3027 clear_bit(port1, hub->change_bits);
3033 int usb_disable_ltm(struct usb_device *udev)
3035 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3037 /* Check if the roothub and device supports LTM. */
3038 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
3039 !usb_device_supports_ltm(udev))
3042 /* Clear Feature LTM Enable can only be sent if the device is
3045 if (!udev->actconfig)
3048 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3049 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
3050 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
3051 USB_CTRL_SET_TIMEOUT);
3053 EXPORT_SYMBOL_GPL(usb_disable_ltm);
3055 void usb_enable_ltm(struct usb_device *udev)
3057 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3059 /* Check if the roothub and device supports LTM. */
3060 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
3061 !usb_device_supports_ltm(udev))
3064 /* Set Feature LTM Enable can only be sent if the device is
3067 if (!udev->actconfig)
3070 usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3071 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
3072 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
3073 USB_CTRL_SET_TIMEOUT);
3075 EXPORT_SYMBOL_GPL(usb_enable_ltm);
3078 * usb_enable_remote_wakeup - enable remote wakeup for a device
3079 * @udev: target device
3081 * For USB-2 devices: Set the device's remote wakeup feature.
3083 * For USB-3 devices: Assume there's only one function on the device and
3084 * enable remote wake for the first interface. FIXME if the interface
3085 * association descriptor shows there's more than one function.
3087 static int usb_enable_remote_wakeup(struct usb_device *udev)
3089 if (udev->speed < USB_SPEED_SUPER)
3090 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3091 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
3092 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
3093 USB_CTRL_SET_TIMEOUT);
3095 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3096 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
3097 USB_INTRF_FUNC_SUSPEND,
3098 USB_INTRF_FUNC_SUSPEND_RW |
3099 USB_INTRF_FUNC_SUSPEND_LP,
3100 NULL, 0, USB_CTRL_SET_TIMEOUT);
3104 * usb_disable_remote_wakeup - disable remote wakeup for a device
3105 * @udev: target device
3107 * For USB-2 devices: Clear the device's remote wakeup feature.
3109 * For USB-3 devices: Assume there's only one function on the device and
3110 * disable remote wake for the first interface. FIXME if the interface
3111 * association descriptor shows there's more than one function.
3113 static int usb_disable_remote_wakeup(struct usb_device *udev)
3115 if (udev->speed < USB_SPEED_SUPER)
3116 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3117 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
3118 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
3119 USB_CTRL_SET_TIMEOUT);
3121 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3122 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
3123 USB_INTRF_FUNC_SUSPEND, 0, NULL, 0,
3124 USB_CTRL_SET_TIMEOUT);
3127 /* Count of wakeup-enabled devices at or below udev */
3128 static unsigned wakeup_enabled_descendants(struct usb_device *udev)
3130 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
3132 return udev->do_remote_wakeup +
3133 (hub ? hub->wakeup_enabled_descendants : 0);
3137 * usb_port_suspend - suspend a usb device's upstream port
3138 * @udev: device that's no longer in active use, not a root hub
3139 * Context: must be able to sleep; device not locked; pm locks held
3141 * Suspends a USB device that isn't in active use, conserving power.
3142 * Devices may wake out of a suspend, if anything important happens,
3143 * using the remote wakeup mechanism. They may also be taken out of
3144 * suspend by the host, using usb_port_resume(). It's also routine
3145 * to disconnect devices while they are suspended.
3147 * This only affects the USB hardware for a device; its interfaces
3148 * (and, for hubs, child devices) must already have been suspended.
3150 * Selective port suspend reduces power; most suspended devices draw
3151 * less than 500 uA. It's also used in OTG, along with remote wakeup.
3152 * All devices below the suspended port are also suspended.
3154 * Devices leave suspend state when the host wakes them up. Some devices
3155 * also support "remote wakeup", where the device can activate the USB
3156 * tree above them to deliver data, such as a keypress or packet. In
3157 * some cases, this wakes the USB host.
3159 * Suspending OTG devices may trigger HNP, if that's been enabled
3160 * between a pair of dual-role devices. That will change roles, such
3161 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
3163 * Devices on USB hub ports have only one "suspend" state, corresponding
3164 * to ACPI D2, "may cause the device to lose some context".
3165 * State transitions include:
3167 * - suspend, resume ... when the VBUS power link stays live
3168 * - suspend, disconnect ... VBUS lost
3170 * Once VBUS drop breaks the circuit, the port it's using has to go through
3171 * normal re-enumeration procedures, starting with enabling VBUS power.
3172 * Other than re-initializing the hub (plug/unplug, except for root hubs),
3173 * Linux (2.6) currently has NO mechanisms to initiate that: no hub_wq
3174 * timer, no SRP, no requests through sysfs.
3176 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
3177 * suspended until their bus goes into global suspend (i.e., the root
3178 * hub is suspended). Nevertheless, we change @udev->state to
3179 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
3180 * upstream port setting is stored in @udev->port_is_suspended.
3182 * Returns 0 on success, else negative errno.
3184 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
3186 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3187 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3188 int port1 = udev->portnum;
3190 bool really_suspend = true;
3192 usb_lock_port(port_dev);
3194 /* enable remote wakeup when appropriate; this lets the device
3195 * wake up the upstream hub (including maybe the root hub).
3197 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
3198 * we don't explicitly enable it here.
3200 if (udev->do_remote_wakeup) {
3201 status = usb_enable_remote_wakeup(udev);
3203 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
3205 /* bail if autosuspend is requested */
3206 if (PMSG_IS_AUTO(msg))
3211 /* disable USB2 hardware LPM */
3212 usb_disable_usb2_hardware_lpm(udev);
3214 if (usb_disable_ltm(udev)) {
3215 dev_err(&udev->dev, "Failed to disable LTM before suspend\n.");
3217 if (PMSG_IS_AUTO(msg))
3222 if (hub_is_superspeed(hub->hdev))
3223 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U3);
3226 * For system suspend, we do not need to enable the suspend feature
3227 * on individual USB-2 ports. The devices will automatically go
3228 * into suspend a few ms after the root hub stops sending packets.
3229 * The USB 2.0 spec calls this "global suspend".
3231 * However, many USB hubs have a bug: They don't relay wakeup requests
3232 * from a downstream port if the port's suspend feature isn't on.
3233 * Therefore we will turn on the suspend feature if udev or any of its
3234 * descendants is enabled for remote wakeup.
3236 else if (PMSG_IS_AUTO(msg) || wakeup_enabled_descendants(udev) > 0)
3237 status = set_port_feature(hub->hdev, port1,
3238 USB_PORT_FEAT_SUSPEND);
3240 really_suspend = false;
3244 dev_dbg(&port_dev->dev, "can't suspend, status %d\n", status);
3246 /* Try to enable USB3 LTM again */
3247 usb_enable_ltm(udev);
3249 /* Try to enable USB2 hardware LPM again */
3250 usb_enable_usb2_hardware_lpm(udev);
3252 if (udev->do_remote_wakeup)
3253 (void) usb_disable_remote_wakeup(udev);
3256 /* System sleep transitions should never fail */
3257 if (!PMSG_IS_AUTO(msg))
3260 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
3261 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
3262 udev->do_remote_wakeup);
3263 if (really_suspend) {
3264 udev->port_is_suspended = 1;
3266 /* device has up to 10 msec to fully suspend */
3269 usb_set_device_state(udev, USB_STATE_SUSPENDED);
3272 if (status == 0 && !udev->do_remote_wakeup && udev->persist_enabled
3273 && test_and_clear_bit(port1, hub->child_usage_bits))
3274 pm_runtime_put_sync(&port_dev->dev);
3276 usb_mark_last_busy(hub->hdev);
3278 usb_unlock_port(port_dev);
3283 * If the USB "suspend" state is in use (rather than "global suspend"),
3284 * many devices will be individually taken out of suspend state using
3285 * special "resume" signaling. This routine kicks in shortly after
3286 * hardware resume signaling is finished, either because of selective
3287 * resume (by host) or remote wakeup (by device) ... now see what changed
3288 * in the tree that's rooted at this device.
3290 * If @udev->reset_resume is set then the device is reset before the
3291 * status check is done.
3293 static int finish_port_resume(struct usb_device *udev)
3298 /* caller owns the udev device lock */
3299 dev_dbg(&udev->dev, "%s\n",
3300 udev->reset_resume ? "finish reset-resume" : "finish resume");
3302 /* usb ch9 identifies four variants of SUSPENDED, based on what
3303 * state the device resumes to. Linux currently won't see the
3304 * first two on the host side; they'd be inside hub_port_init()
3305 * during many timeouts, but hub_wq can't suspend until later.
3307 usb_set_device_state(udev, udev->actconfig
3308 ? USB_STATE_CONFIGURED
3309 : USB_STATE_ADDRESS);
3311 /* 10.5.4.5 says not to reset a suspended port if the attached
3312 * device is enabled for remote wakeup. Hence the reset
3313 * operation is carried out here, after the port has been
3316 if (udev->reset_resume) {
3318 * If the device morphs or switches modes when it is reset,
3319 * we don't want to perform a reset-resume. We'll fail the
3320 * resume, which will cause a logical disconnect, and then
3321 * the device will be rediscovered.
3324 if (udev->quirks & USB_QUIRK_RESET)
3327 status = usb_reset_and_verify_device(udev);
3330 /* 10.5.4.5 says be sure devices in the tree are still there.
3331 * For now let's assume the device didn't go crazy on resume,
3332 * and device drivers will know about any resume quirks.
3336 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
3338 /* If a normal resume failed, try doing a reset-resume */
3339 if (status && !udev->reset_resume && udev->persist_enabled) {
3340 dev_dbg(&udev->dev, "retry with reset-resume\n");
3341 udev->reset_resume = 1;
3342 goto retry_reset_resume;
3347 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
3350 * There are a few quirky devices which violate the standard
3351 * by claiming to have remote wakeup enabled after a reset,
3352 * which crash if the feature is cleared, hence check for
3353 * udev->reset_resume
3355 } else if (udev->actconfig && !udev->reset_resume) {
3356 if (udev->speed < USB_SPEED_SUPER) {
3357 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
3358 status = usb_disable_remote_wakeup(udev);
3360 status = usb_get_status(udev, USB_RECIP_INTERFACE, 0,
3362 if (!status && devstatus & (USB_INTRF_STAT_FUNC_RW_CAP
3363 | USB_INTRF_STAT_FUNC_RW))
3364 status = usb_disable_remote_wakeup(udev);
3369 "disable remote wakeup, status %d\n",
3377 * There are some SS USB devices which take longer time for link training.
3378 * XHCI specs 4.19.4 says that when Link training is successful, port
3379 * sets CCS bit to 1. So if SW reads port status before successful link
3380 * training, then it will not find device to be present.
3381 * USB Analyzer log with such buggy devices show that in some cases
3382 * device switch on the RX termination after long delay of host enabling
3383 * the VBUS. In few other cases it has been seen that device fails to
3384 * negotiate link training in first attempt. It has been
3385 * reported till now that few devices take as long as 2000 ms to train
3386 * the link after host enabling its VBUS and termination. Following
3387 * routine implements a 2000 ms timeout for link training. If in a case
3388 * link trains before timeout, loop will exit earlier.
3390 * There are also some 2.0 hard drive based devices and 3.0 thumb
3391 * drives that, when plugged into a 2.0 only port, take a long
3392 * time to set CCS after VBUS enable.
3394 * FIXME: If a device was connected before suspend, but was removed
3395 * while system was asleep, then the loop in the following routine will
3396 * only exit at timeout.
3398 * This routine should only be called when persist is enabled.
3400 static int wait_for_connected(struct usb_device *udev,
3401 struct usb_hub *hub, int *port1,
3402 u16 *portchange, u16 *portstatus)
3404 int status = 0, delay_ms = 0;
3406 while (delay_ms < 2000) {
3407 if (status || *portstatus & USB_PORT_STAT_CONNECTION)
3409 if (!port_is_power_on(hub, *portstatus)) {
3415 status = hub_port_status(hub, *port1, portstatus, portchange);
3417 dev_dbg(&udev->dev, "Waited %dms for CONNECT\n", delay_ms);
3422 * usb_port_resume - re-activate a suspended usb device's upstream port
3423 * @udev: device to re-activate, not a root hub
3424 * Context: must be able to sleep; device not locked; pm locks held
3426 * This will re-activate the suspended device, increasing power usage
3427 * while letting drivers communicate again with its endpoints.
3428 * USB resume explicitly guarantees that the power session between
3429 * the host and the device is the same as it was when the device
3432 * If @udev->reset_resume is set then this routine won't check that the
3433 * port is still enabled. Furthermore, finish_port_resume() above will
3434 * reset @udev. The end result is that a broken power session can be
3435 * recovered and @udev will appear to persist across a loss of VBUS power.
3437 * For example, if a host controller doesn't maintain VBUS suspend current
3438 * during a system sleep or is reset when the system wakes up, all the USB
3439 * power sessions below it will be broken. This is especially troublesome
3440 * for mass-storage devices containing mounted filesystems, since the
3441 * device will appear to have disconnected and all the memory mappings
3442 * to it will be lost. Using the USB_PERSIST facility, the device can be
3443 * made to appear as if it had not disconnected.
3445 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3446 * every effort to insure that the same device is present after the
3447 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3448 * quite possible for a device to remain unaltered but its media to be
3449 * changed. If the user replaces a flash memory card while the system is
3450 * asleep, he will have only himself to blame when the filesystem on the
3451 * new card is corrupted and the system crashes.
3453 * Returns 0 on success, else negative errno.
3455 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
3457 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3458 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3459 int port1 = udev->portnum;
3461 u16 portchange, portstatus;
3463 if (!test_and_set_bit(port1, hub->child_usage_bits)) {
3464 status = pm_runtime_get_sync(&port_dev->dev);
3466 dev_dbg(&udev->dev, "can't resume usb port, status %d\n",
3472 usb_lock_port(port_dev);
3474 /* Skip the initial Clear-Suspend step for a remote wakeup */
3475 status = hub_port_status(hub, port1, &portstatus, &portchange);
3476 if (status == 0 && !port_is_suspended(hub, portstatus)) {
3477 if (portchange & USB_PORT_STAT_C_SUSPEND)
3478 pm_wakeup_event(&udev->dev, 0);
3479 goto SuspendCleared;
3482 /* see 7.1.7.7; affects power usage, but not budgeting */
3483 if (hub_is_superspeed(hub->hdev))
3484 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U0);
3486 status = usb_clear_port_feature(hub->hdev,
3487 port1, USB_PORT_FEAT_SUSPEND);
3489 dev_dbg(&port_dev->dev, "can't resume, status %d\n", status);
3491 /* drive resume for USB_RESUME_TIMEOUT msec */
3492 dev_dbg(&udev->dev, "usb %sresume\n",
3493 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
3494 msleep(USB_RESUME_TIMEOUT);
3496 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3497 * stop resume signaling. Then finish the resume
3500 status = hub_port_status(hub, port1, &portstatus, &portchange);
3505 udev->port_is_suspended = 0;
3506 if (hub_is_superspeed(hub->hdev)) {
3507 if (portchange & USB_PORT_STAT_C_LINK_STATE)
3508 usb_clear_port_feature(hub->hdev, port1,
3509 USB_PORT_FEAT_C_PORT_LINK_STATE);
3511 if (portchange & USB_PORT_STAT_C_SUSPEND)
3512 usb_clear_port_feature(hub->hdev, port1,
3513 USB_PORT_FEAT_C_SUSPEND);
3516 /* TRSMRCY = 10 msec */
3520 if (udev->persist_enabled)
3521 status = wait_for_connected(udev, hub, &port1, &portchange,
3524 status = check_port_resume_type(udev,
3525 hub, port1, status, portchange, portstatus);
3527 status = finish_port_resume(udev);
3529 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
3530 hub_port_logical_disconnect(hub, port1);
3532 /* Try to enable USB2 hardware LPM */
3533 usb_enable_usb2_hardware_lpm(udev);
3535 /* Try to enable USB3 LTM */
3536 usb_enable_ltm(udev);
3539 usb_unlock_port(port_dev);
3544 int usb_remote_wakeup(struct usb_device *udev)
3548 usb_lock_device(udev);
3549 if (udev->state == USB_STATE_SUSPENDED) {
3550 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
3551 status = usb_autoresume_device(udev);
3553 /* Let the drivers do their thing, then... */
3554 usb_autosuspend_device(udev);
3557 usb_unlock_device(udev);
3561 /* Returns 1 if there was a remote wakeup and a connect status change. */
3562 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
3563 u16 portstatus, u16 portchange)
3564 __must_hold(&port_dev->status_lock)
3566 struct usb_port *port_dev = hub->ports[port - 1];
3567 struct usb_device *hdev;
3568 struct usb_device *udev;
3569 int connect_change = 0;
3574 udev = port_dev->child;
3575 if (!hub_is_superspeed(hdev)) {
3576 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
3578 usb_clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
3580 link_state = portstatus & USB_PORT_STAT_LINK_STATE;
3581 if (!udev || udev->state != USB_STATE_SUSPENDED ||
3582 (link_state != USB_SS_PORT_LS_U0 &&
3583 link_state != USB_SS_PORT_LS_U1 &&
3584 link_state != USB_SS_PORT_LS_U2))
3589 /* TRSMRCY = 10 msec */
3592 usb_unlock_port(port_dev);
3593 ret = usb_remote_wakeup(udev);
3594 usb_lock_port(port_dev);
3599 hub_port_disable(hub, port, 1);
3601 dev_dbg(&port_dev->dev, "resume, status %d\n", ret);
3602 return connect_change;
3605 static int check_ports_changed(struct usb_hub *hub)
3609 for (port1 = 1; port1 <= hub->hdev->maxchild; ++port1) {
3610 u16 portstatus, portchange;
3613 status = hub_port_status(hub, port1, &portstatus, &portchange);
3614 if (!status && portchange)
3620 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
3622 struct usb_hub *hub = usb_get_intfdata(intf);
3623 struct usb_device *hdev = hub->hdev;
3628 * Warn if children aren't already suspended.
3629 * Also, add up the number of wakeup-enabled descendants.
3631 hub->wakeup_enabled_descendants = 0;
3632 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3633 struct usb_port *port_dev = hub->ports[port1 - 1];
3634 struct usb_device *udev = port_dev->child;
3636 if (udev && udev->can_submit) {
3637 dev_warn(&port_dev->dev, "device %s not suspended yet\n",
3638 dev_name(&udev->dev));
3639 if (PMSG_IS_AUTO(msg))
3643 hub->wakeup_enabled_descendants +=
3644 wakeup_enabled_descendants(udev);
3647 if (hdev->do_remote_wakeup && hub->quirk_check_port_auto_suspend) {
3648 /* check if there are changes pending on hub ports */
3649 if (check_ports_changed(hub)) {
3650 if (PMSG_IS_AUTO(msg))
3652 pm_wakeup_event(&hdev->dev, 2000);
3656 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
3657 /* Enable hub to send remote wakeup for all ports. */
3658 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3659 status = set_port_feature(hdev,
3661 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
3662 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
3663 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
3664 USB_PORT_FEAT_REMOTE_WAKE_MASK);
3668 dev_dbg(&intf->dev, "%s\n", __func__);
3670 /* stop hub_wq and related activity */
3671 hub_quiesce(hub, HUB_SUSPEND);
3675 static int hub_resume(struct usb_interface *intf)
3677 struct usb_hub *hub = usb_get_intfdata(intf);
3679 dev_dbg(&intf->dev, "%s\n", __func__);
3680 hub_activate(hub, HUB_RESUME);
3684 static int hub_reset_resume(struct usb_interface *intf)
3686 struct usb_hub *hub = usb_get_intfdata(intf);
3688 dev_dbg(&intf->dev, "%s\n", __func__);
3689 hub_activate(hub, HUB_RESET_RESUME);
3694 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3695 * @rhdev: struct usb_device for the root hub
3697 * The USB host controller driver calls this function when its root hub
3698 * is resumed and Vbus power has been interrupted or the controller
3699 * has been reset. The routine marks @rhdev as having lost power.
3700 * When the hub driver is resumed it will take notice and carry out
3701 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3702 * the others will be disconnected.
3704 void usb_root_hub_lost_power(struct usb_device *rhdev)
3706 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
3707 rhdev->reset_resume = 1;
3709 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
3711 static const char * const usb3_lpm_names[] = {
3719 * Send a Set SEL control transfer to the device, prior to enabling
3720 * device-initiated U1 or U2. This lets the device know the exit latencies from
3721 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3722 * packet from the host.
3724 * This function will fail if the SEL or PEL values for udev are greater than
3725 * the maximum allowed values for the link state to be enabled.
3727 static int usb_req_set_sel(struct usb_device *udev, enum usb3_link_state state)
3729 struct usb_set_sel_req *sel_values;
3730 unsigned long long u1_sel;
3731 unsigned long long u1_pel;
3732 unsigned long long u2_sel;
3733 unsigned long long u2_pel;
3736 if (udev->state != USB_STATE_CONFIGURED)
3739 /* Convert SEL and PEL stored in ns to us */
3740 u1_sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
3741 u1_pel = DIV_ROUND_UP(udev->u1_params.pel, 1000);
3742 u2_sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
3743 u2_pel = DIV_ROUND_UP(udev->u2_params.pel, 1000);
3746 * Make sure that the calculated SEL and PEL values for the link
3747 * state we're enabling aren't bigger than the max SEL/PEL
3748 * value that will fit in the SET SEL control transfer.
3749 * Otherwise the device would get an incorrect idea of the exit
3750 * latency for the link state, and could start a device-initiated
3751 * U1/U2 when the exit latencies are too high.
3753 if ((state == USB3_LPM_U1 &&
3754 (u1_sel > USB3_LPM_MAX_U1_SEL_PEL ||
3755 u1_pel > USB3_LPM_MAX_U1_SEL_PEL)) ||
3756 (state == USB3_LPM_U2 &&
3757 (u2_sel > USB3_LPM_MAX_U2_SEL_PEL ||
3758 u2_pel > USB3_LPM_MAX_U2_SEL_PEL))) {
3759 dev_dbg(&udev->dev, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3760 usb3_lpm_names[state], u1_sel, u1_pel);
3765 * If we're enabling device-initiated LPM for one link state,
3766 * but the other link state has a too high SEL or PEL value,
3767 * just set those values to the max in the Set SEL request.
3769 if (u1_sel > USB3_LPM_MAX_U1_SEL_PEL)
3770 u1_sel = USB3_LPM_MAX_U1_SEL_PEL;
3772 if (u1_pel > USB3_LPM_MAX_U1_SEL_PEL)
3773 u1_pel = USB3_LPM_MAX_U1_SEL_PEL;
3775 if (u2_sel > USB3_LPM_MAX_U2_SEL_PEL)
3776 u2_sel = USB3_LPM_MAX_U2_SEL_PEL;
3778 if (u2_pel > USB3_LPM_MAX_U2_SEL_PEL)
3779 u2_pel = USB3_LPM_MAX_U2_SEL_PEL;
3782 * usb_enable_lpm() can be called as part of a failed device reset,
3783 * which may be initiated by an error path of a mass storage driver.
3784 * Therefore, use GFP_NOIO.
3786 sel_values = kmalloc(sizeof *(sel_values), GFP_NOIO);
3790 sel_values->u1_sel = u1_sel;
3791 sel_values->u1_pel = u1_pel;
3792 sel_values->u2_sel = cpu_to_le16(u2_sel);
3793 sel_values->u2_pel = cpu_to_le16(u2_pel);
3795 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3799 sel_values, sizeof *(sel_values),
3800 USB_CTRL_SET_TIMEOUT);
3806 * Enable or disable device-initiated U1 or U2 transitions.
3808 static int usb_set_device_initiated_lpm(struct usb_device *udev,
3809 enum usb3_link_state state, bool enable)
3816 feature = USB_DEVICE_U1_ENABLE;
3819 feature = USB_DEVICE_U2_ENABLE;
3822 dev_warn(&udev->dev, "%s: Can't %s non-U1 or U2 state.\n",
3823 __func__, enable ? "enable" : "disable");
3827 if (udev->state != USB_STATE_CONFIGURED) {
3828 dev_dbg(&udev->dev, "%s: Can't %s %s state "
3829 "for unconfigured device.\n",
3830 __func__, enable ? "enable" : "disable",
3831 usb3_lpm_names[state]);
3837 * Now send the control transfer to enable device-initiated LPM
3838 * for either U1 or U2.
3840 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3841 USB_REQ_SET_FEATURE,
3845 USB_CTRL_SET_TIMEOUT);
3847 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3848 USB_REQ_CLEAR_FEATURE,
3852 USB_CTRL_SET_TIMEOUT);
3855 dev_warn(&udev->dev, "%s of device-initiated %s failed.\n",
3856 enable ? "Enable" : "Disable",
3857 usb3_lpm_names[state]);
3863 static int usb_set_lpm_timeout(struct usb_device *udev,
3864 enum usb3_link_state state, int timeout)
3871 feature = USB_PORT_FEAT_U1_TIMEOUT;
3874 feature = USB_PORT_FEAT_U2_TIMEOUT;
3877 dev_warn(&udev->dev, "%s: Can't set timeout for non-U1 or U2 state.\n",
3882 if (state == USB3_LPM_U1 && timeout > USB3_LPM_U1_MAX_TIMEOUT &&
3883 timeout != USB3_LPM_DEVICE_INITIATED) {
3884 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x, "
3885 "which is a reserved value.\n",
3886 usb3_lpm_names[state], timeout);
3890 ret = set_port_feature(udev->parent,
3891 USB_PORT_LPM_TIMEOUT(timeout) | udev->portnum,
3894 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x,"
3895 "error code %i\n", usb3_lpm_names[state],
3899 if (state == USB3_LPM_U1)
3900 udev->u1_params.timeout = timeout;
3902 udev->u2_params.timeout = timeout;
3907 * Don't allow device intiated U1/U2 if the system exit latency + one bus
3908 * interval is greater than the minimum service interval of any active
3909 * periodic endpoint. See USB 3.2 section 9.4.9
3911 static bool usb_device_may_initiate_lpm(struct usb_device *udev,
3912 enum usb3_link_state state)
3914 unsigned int sel; /* us */
3917 if (state == USB3_LPM_U1)
3918 sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
3919 else if (state == USB3_LPM_U2)
3920 sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
3924 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
3925 struct usb_interface *intf;
3926 struct usb_endpoint_descriptor *desc;
3927 unsigned int interval;
3929 intf = udev->actconfig->interface[i];
3933 for (j = 0; j < intf->cur_altsetting->desc.bNumEndpoints; j++) {
3934 desc = &intf->cur_altsetting->endpoint[j].desc;
3936 if (usb_endpoint_xfer_int(desc) ||
3937 usb_endpoint_xfer_isoc(desc)) {
3938 interval = (1 << (desc->bInterval - 1)) * 125;
3939 if (sel + 125 > interval)
3948 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3951 * We will attempt to enable U1 or U2, but there are no guarantees that the
3952 * control transfers to set the hub timeout or enable device-initiated U1/U2
3953 * will be successful.
3955 * If the control transfer to enable device-initiated U1/U2 entry fails, then
3956 * hub-initiated U1/U2 will be disabled.
3958 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3959 * driver know about it. If that call fails, it should be harmless, and just
3960 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3962 static void usb_enable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3963 enum usb3_link_state state)
3966 __u8 u1_mel = udev->bos->ss_cap->bU1devExitLat;
3967 __le16 u2_mel = udev->bos->ss_cap->bU2DevExitLat;
3969 /* If the device says it doesn't have *any* exit latency to come out of
3970 * U1 or U2, it's probably lying. Assume it doesn't implement that link
3973 if ((state == USB3_LPM_U1 && u1_mel == 0) ||
3974 (state == USB3_LPM_U2 && u2_mel == 0))
3978 * First, let the device know about the exit latencies
3979 * associated with the link state we're about to enable.
3981 ret = usb_req_set_sel(udev, state);
3983 dev_warn(&udev->dev, "Set SEL for device-initiated %s failed.\n",
3984 usb3_lpm_names[state]);
3988 /* We allow the host controller to set the U1/U2 timeout internally
3989 * first, so that it can change its schedule to account for the
3990 * additional latency to send data to a device in a lower power
3993 timeout = hcd->driver->enable_usb3_lpm_timeout(hcd, udev, state);
3995 /* xHCI host controller doesn't want to enable this LPM state. */
4000 dev_warn(&udev->dev, "Could not enable %s link state, "
4001 "xHCI error %i.\n", usb3_lpm_names[state],
4006 if (usb_set_lpm_timeout(udev, state, timeout)) {
4007 /* If we can't set the parent hub U1/U2 timeout,
4008 * device-initiated LPM won't be allowed either, so let the xHCI
4009 * host know that this link state won't be enabled.
4011 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
4015 /* Only a configured device will accept the Set Feature
4018 if (udev->actconfig &&
4019 usb_device_may_initiate_lpm(udev, state)) {
4020 if (usb_set_device_initiated_lpm(udev, state, true)) {
4022 * Request to enable device initiated U1/U2 failed,
4023 * better to turn off lpm in this case.
4025 usb_set_lpm_timeout(udev, state, 0);
4026 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
4031 if (state == USB3_LPM_U1)
4032 udev->usb3_lpm_u1_enabled = 1;
4033 else if (state == USB3_LPM_U2)
4034 udev->usb3_lpm_u2_enabled = 1;
4037 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
4040 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
4041 * If zero is returned, the parent will not allow the link to go into U1/U2.
4043 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
4044 * it won't have an effect on the bus link state because the parent hub will
4045 * still disallow device-initiated U1/U2 entry.
4047 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
4048 * possible. The result will be slightly more bus bandwidth will be taken up
4049 * (to account for U1/U2 exit latency), but it should be harmless.
4051 static int usb_disable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
4052 enum usb3_link_state state)
4059 dev_warn(&udev->dev, "%s: Can't disable non-U1 or U2 state.\n",
4064 if (usb_set_lpm_timeout(udev, state, 0))
4067 usb_set_device_initiated_lpm(udev, state, false);
4069 if (hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state))
4070 dev_warn(&udev->dev, "Could not disable xHCI %s timeout, "
4071 "bus schedule bandwidth may be impacted.\n",
4072 usb3_lpm_names[state]);
4074 /* As soon as usb_set_lpm_timeout(0) return 0, hub initiated LPM
4075 * is disabled. Hub will disallows link to enter U1/U2 as well,
4076 * even device is initiating LPM. Hence LPM is disabled if hub LPM
4077 * timeout set to 0, no matter device-initiated LPM is disabled or
4080 if (state == USB3_LPM_U1)
4081 udev->usb3_lpm_u1_enabled = 0;
4082 else if (state == USB3_LPM_U2)
4083 udev->usb3_lpm_u2_enabled = 0;
4089 * Disable hub-initiated and device-initiated U1 and U2 entry.
4090 * Caller must own the bandwidth_mutex.
4092 * This will call usb_enable_lpm() on failure, which will decrement
4093 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
4095 int usb_disable_lpm(struct usb_device *udev)
4097 struct usb_hcd *hcd;
4099 if (!udev || !udev->parent ||
4100 udev->speed < USB_SPEED_SUPER ||
4101 !udev->lpm_capable ||
4102 udev->state < USB_STATE_DEFAULT)
4105 hcd = bus_to_hcd(udev->bus);
4106 if (!hcd || !hcd->driver->disable_usb3_lpm_timeout)
4109 udev->lpm_disable_count++;
4110 if ((udev->u1_params.timeout == 0 && udev->u2_params.timeout == 0))
4113 /* If LPM is enabled, attempt to disable it. */
4114 if (usb_disable_link_state(hcd, udev, USB3_LPM_U1))
4116 if (usb_disable_link_state(hcd, udev, USB3_LPM_U2))
4122 usb_enable_lpm(udev);
4125 EXPORT_SYMBOL_GPL(usb_disable_lpm);
4127 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
4128 int usb_unlocked_disable_lpm(struct usb_device *udev)
4130 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4136 mutex_lock(hcd->bandwidth_mutex);
4137 ret = usb_disable_lpm(udev);
4138 mutex_unlock(hcd->bandwidth_mutex);
4142 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
4145 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
4146 * xHCI host policy may prevent U1 or U2 from being enabled.
4148 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
4149 * until the lpm_disable_count drops to zero. Caller must own the
4152 void usb_enable_lpm(struct usb_device *udev)
4154 struct usb_hcd *hcd;
4155 struct usb_hub *hub;
4156 struct usb_port *port_dev;
4158 if (!udev || !udev->parent ||
4159 udev->speed < USB_SPEED_SUPER ||
4160 !udev->lpm_capable ||
4161 udev->state < USB_STATE_DEFAULT)
4164 udev->lpm_disable_count--;
4165 hcd = bus_to_hcd(udev->bus);
4166 /* Double check that we can both enable and disable LPM.
4167 * Device must be configured to accept set feature U1/U2 timeout.
4169 if (!hcd || !hcd->driver->enable_usb3_lpm_timeout ||
4170 !hcd->driver->disable_usb3_lpm_timeout)
4173 if (udev->lpm_disable_count > 0)
4176 hub = usb_hub_to_struct_hub(udev->parent);
4180 port_dev = hub->ports[udev->portnum - 1];
4182 if (port_dev->usb3_lpm_u1_permit)
4183 usb_enable_link_state(hcd, udev, USB3_LPM_U1);
4185 if (port_dev->usb3_lpm_u2_permit)
4186 usb_enable_link_state(hcd, udev, USB3_LPM_U2);
4188 EXPORT_SYMBOL_GPL(usb_enable_lpm);
4190 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
4191 void usb_unlocked_enable_lpm(struct usb_device *udev)
4193 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4198 mutex_lock(hcd->bandwidth_mutex);
4199 usb_enable_lpm(udev);
4200 mutex_unlock(hcd->bandwidth_mutex);
4202 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
4204 /* usb3 devices use U3 for disabled, make sure remote wakeup is disabled */
4205 static void hub_usb3_port_prepare_disable(struct usb_hub *hub,
4206 struct usb_port *port_dev)
4208 struct usb_device *udev = port_dev->child;
4211 if (udev && udev->port_is_suspended && udev->do_remote_wakeup) {
4212 ret = hub_set_port_link_state(hub, port_dev->portnum,
4215 msleep(USB_RESUME_TIMEOUT);
4216 ret = usb_disable_remote_wakeup(udev);
4219 dev_warn(&udev->dev,
4220 "Port disable: can't disable remote wake\n");
4221 udev->do_remote_wakeup = 0;
4225 #else /* CONFIG_PM */
4227 #define hub_suspend NULL
4228 #define hub_resume NULL
4229 #define hub_reset_resume NULL
4231 static inline void hub_usb3_port_prepare_disable(struct usb_hub *hub,
4232 struct usb_port *port_dev) { }
4234 int usb_disable_lpm(struct usb_device *udev)
4238 EXPORT_SYMBOL_GPL(usb_disable_lpm);
4240 void usb_enable_lpm(struct usb_device *udev) { }
4241 EXPORT_SYMBOL_GPL(usb_enable_lpm);
4243 int usb_unlocked_disable_lpm(struct usb_device *udev)
4247 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
4249 void usb_unlocked_enable_lpm(struct usb_device *udev) { }
4250 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
4252 int usb_disable_ltm(struct usb_device *udev)
4256 EXPORT_SYMBOL_GPL(usb_disable_ltm);
4258 void usb_enable_ltm(struct usb_device *udev) { }
4259 EXPORT_SYMBOL_GPL(usb_enable_ltm);
4261 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
4262 u16 portstatus, u16 portchange)
4267 #endif /* CONFIG_PM */
4270 * USB-3 does not have a similar link state as USB-2 that will avoid negotiating
4271 * a connection with a plugged-in cable but will signal the host when the cable
4272 * is unplugged. Disable remote wake and set link state to U3 for USB-3 devices
4274 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
4276 struct usb_port *port_dev = hub->ports[port1 - 1];
4277 struct usb_device *hdev = hub->hdev;
4281 if (hub_is_superspeed(hub->hdev)) {
4282 hub_usb3_port_prepare_disable(hub, port_dev);
4283 ret = hub_set_port_link_state(hub, port_dev->portnum,
4286 ret = usb_clear_port_feature(hdev, port1,
4287 USB_PORT_FEAT_ENABLE);
4290 if (port_dev->child && set_state)
4291 usb_set_device_state(port_dev->child, USB_STATE_NOTATTACHED);
4292 if (ret && ret != -ENODEV)
4293 dev_err(&port_dev->dev, "cannot disable (err = %d)\n", ret);
4298 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
4300 * Between connect detection and reset signaling there must be a delay
4301 * of 100ms at least for debounce and power-settling. The corresponding
4302 * timer shall restart whenever the downstream port detects a disconnect.
4304 * Apparently there are some bluetooth and irda-dongles and a number of
4305 * low-speed devices for which this debounce period may last over a second.
4306 * Not covered by the spec - but easy to deal with.
4308 * This implementation uses a 1500ms total debounce timeout; if the
4309 * connection isn't stable by then it returns -ETIMEDOUT. It checks
4310 * every 25ms for transient disconnects. When the port status has been
4311 * unchanged for 100ms it returns the port status.
4313 int hub_port_debounce(struct usb_hub *hub, int port1, bool must_be_connected)
4316 u16 portchange, portstatus;
4317 unsigned connection = 0xffff;
4318 int total_time, stable_time = 0;
4319 struct usb_port *port_dev = hub->ports[port1 - 1];
4321 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
4322 ret = hub_port_status(hub, port1, &portstatus, &portchange);
4326 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
4327 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
4328 if (!must_be_connected ||
4329 (connection == USB_PORT_STAT_CONNECTION))
4330 stable_time += HUB_DEBOUNCE_STEP;
4331 if (stable_time >= HUB_DEBOUNCE_STABLE)
4335 connection = portstatus & USB_PORT_STAT_CONNECTION;
4338 if (portchange & USB_PORT_STAT_C_CONNECTION) {
4339 usb_clear_port_feature(hub->hdev, port1,
4340 USB_PORT_FEAT_C_CONNECTION);
4343 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
4345 msleep(HUB_DEBOUNCE_STEP);
4348 dev_dbg(&port_dev->dev, "debounce total %dms stable %dms status 0x%x\n",
4349 total_time, stable_time, portstatus);
4351 if (stable_time < HUB_DEBOUNCE_STABLE)
4356 void usb_ep0_reinit(struct usb_device *udev)
4358 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
4359 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
4360 usb_enable_endpoint(udev, &udev->ep0, true);
4362 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
4364 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
4365 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
4367 static int hub_set_address(struct usb_device *udev, int devnum)
4370 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4373 * The host controller will choose the device address,
4374 * instead of the core having chosen it earlier
4376 if (!hcd->driver->address_device && devnum <= 1)
4378 if (udev->state == USB_STATE_ADDRESS)
4380 if (udev->state != USB_STATE_DEFAULT)
4382 if (hcd->driver->address_device)
4383 retval = hcd->driver->address_device(hcd, udev);
4385 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
4386 USB_REQ_SET_ADDRESS, 0, devnum, 0,
4387 NULL, 0, USB_CTRL_SET_TIMEOUT);
4389 update_devnum(udev, devnum);
4390 /* Device now using proper address. */
4391 usb_set_device_state(udev, USB_STATE_ADDRESS);
4392 usb_ep0_reinit(udev);
4398 * There are reports of USB 3.0 devices that say they support USB 2.0 Link PM
4399 * when they're plugged into a USB 2.0 port, but they don't work when LPM is
4402 * Only enable USB 2.0 Link PM if the port is internal (hardwired), or the
4403 * device says it supports the new USB 2.0 Link PM errata by setting the BESL
4404 * support bit in the BOS descriptor.
4406 static void hub_set_initial_usb2_lpm_policy(struct usb_device *udev)
4408 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
4409 int connect_type = USB_PORT_CONNECT_TYPE_UNKNOWN;
4411 if (!udev->usb2_hw_lpm_capable || !udev->bos)
4415 connect_type = hub->ports[udev->portnum - 1]->connect_type;
4417 if ((udev->bos->ext_cap->bmAttributes & cpu_to_le32(USB_BESL_SUPPORT)) ||
4418 connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
4419 udev->usb2_hw_lpm_allowed = 1;
4420 usb_enable_usb2_hardware_lpm(udev);
4424 static int hub_enable_device(struct usb_device *udev)
4426 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4428 if (!hcd->driver->enable_device)
4430 if (udev->state == USB_STATE_ADDRESS)
4432 if (udev->state != USB_STATE_DEFAULT)
4435 return hcd->driver->enable_device(hcd, udev);
4438 /* Reset device, (re)assign address, get device descriptor.
4439 * Device connection must be stable, no more debouncing needed.
4440 * Returns device in USB_STATE_ADDRESS, except on error.
4442 * If this is called for an already-existing device (as part of
4443 * usb_reset_and_verify_device), the caller must own the device lock and
4444 * the port lock. For a newly detected device that is not accessible
4445 * through any global pointers, it's not necessary to lock the device,
4446 * but it is still necessary to lock the port.
4449 hub_port_init(struct usb_hub *hub, struct usb_device *udev, int port1,
4452 struct usb_device *hdev = hub->hdev;
4453 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4454 int retries, operations, retval, i;
4455 unsigned delay = HUB_SHORT_RESET_TIME;
4456 enum usb_device_speed oldspeed = udev->speed;
4458 int devnum = udev->devnum;
4459 const char *driver_name;
4461 /* root hub ports have a slightly longer reset period
4462 * (from USB 2.0 spec, section 7.1.7.5)
4464 if (!hdev->parent) {
4465 delay = HUB_ROOT_RESET_TIME;
4466 if (port1 == hdev->bus->otg_port)
4467 hdev->bus->b_hnp_enable = 0;
4470 /* Some low speed devices have problems with the quick delay, so */
4471 /* be a bit pessimistic with those devices. RHbug #23670 */
4472 if (oldspeed == USB_SPEED_LOW)
4473 delay = HUB_LONG_RESET_TIME;
4475 mutex_lock(hcd->address0_mutex);
4477 /* Reset the device; full speed may morph to high speed */
4478 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
4479 retval = hub_port_reset(hub, port1, udev, delay, false);
4480 if (retval < 0) /* error or disconnect */
4482 /* success, speed is known */
4486 /* Don't allow speed changes at reset, except usb 3.0 to faster */
4487 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed &&
4488 !(oldspeed == USB_SPEED_SUPER && udev->speed > oldspeed)) {
4489 dev_dbg(&udev->dev, "device reset changed speed!\n");
4492 oldspeed = udev->speed;
4494 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4495 * it's fixed size except for full speed devices.
4496 * For Wireless USB devices, ep0 max packet is always 512 (tho
4497 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4499 switch (udev->speed) {
4500 case USB_SPEED_SUPER_PLUS:
4501 case USB_SPEED_SUPER:
4502 case USB_SPEED_WIRELESS: /* fixed at 512 */
4503 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
4505 case USB_SPEED_HIGH: /* fixed at 64 */
4506 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4508 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
4509 /* to determine the ep0 maxpacket size, try to read
4510 * the device descriptor to get bMaxPacketSize0 and
4511 * then correct our initial guess.
4513 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4515 case USB_SPEED_LOW: /* fixed at 8 */
4516 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
4522 if (udev->speed == USB_SPEED_WIRELESS)
4523 speed = "variable speed Wireless";
4525 speed = usb_speed_string(udev->speed);
4528 * The controller driver may be NULL if the controller device
4529 * is the middle device between platform device and roothub.
4530 * This middle device may not need a device driver due to
4531 * all hardware control can be at platform device driver, this
4532 * platform device is usually a dual-role USB controller device.
4534 if (udev->bus->controller->driver)
4535 driver_name = udev->bus->controller->driver->name;
4537 driver_name = udev->bus->sysdev->driver->name;
4539 if (udev->speed < USB_SPEED_SUPER)
4540 dev_info(&udev->dev,
4541 "%s %s USB device number %d using %s\n",
4542 (udev->config) ? "reset" : "new", speed,
4543 devnum, driver_name);
4545 /* Set up TT records, if needed */
4547 udev->tt = hdev->tt;
4548 udev->ttport = hdev->ttport;
4549 } else if (udev->speed != USB_SPEED_HIGH
4550 && hdev->speed == USB_SPEED_HIGH) {
4552 dev_err(&udev->dev, "parent hub has no TT\n");
4556 udev->tt = &hub->tt;
4557 udev->ttport = port1;
4560 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4561 * Because device hardware and firmware is sometimes buggy in
4562 * this area, and this is how Linux has done it for ages.
4563 * Change it cautiously.
4565 * NOTE: If use_new_scheme() is true we will start by issuing
4566 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4567 * so it may help with some non-standards-compliant devices.
4568 * Otherwise we start with SET_ADDRESS and then try to read the
4569 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4572 for (retries = 0; retries < GET_DESCRIPTOR_TRIES; (++retries, msleep(100))) {
4573 bool did_new_scheme = false;
4575 if (use_new_scheme(udev, retry_counter)) {
4576 struct usb_device_descriptor *buf;
4579 did_new_scheme = true;
4580 retval = hub_enable_device(udev);
4583 "hub failed to enable device, error %d\n",
4588 #define GET_DESCRIPTOR_BUFSIZE 64
4589 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
4595 /* Retry on all errors; some devices are flakey.
4596 * 255 is for WUSB devices, we actually need to use
4597 * 512 (WUSB1.0[4.8.1]).
4599 for (operations = 0; operations < 3; ++operations) {
4600 buf->bMaxPacketSize0 = 0;
4601 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
4602 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
4603 USB_DT_DEVICE << 8, 0,
4604 buf, GET_DESCRIPTOR_BUFSIZE,
4605 initial_descriptor_timeout);
4606 switch (buf->bMaxPacketSize0) {
4607 case 8: case 16: case 32: case 64: case 255:
4608 if (buf->bDescriptorType ==
4620 * Some devices time out if they are powered on
4621 * when already connected. They need a second
4622 * reset. But only on the first attempt,
4623 * lest we get into a time out/reset loop
4625 if (r == 0 || (r == -ETIMEDOUT &&
4627 udev->speed > USB_SPEED_FULL))
4630 udev->descriptor.bMaxPacketSize0 =
4631 buf->bMaxPacketSize0;
4634 retval = hub_port_reset(hub, port1, udev, delay, false);
4635 if (retval < 0) /* error or disconnect */
4637 if (oldspeed != udev->speed) {
4639 "device reset changed speed!\n");
4645 dev_err(&udev->dev, "device descriptor read/64, error %d\n",
4650 #undef GET_DESCRIPTOR_BUFSIZE
4654 * If device is WUSB, we already assigned an
4655 * unauthorized address in the Connect Ack sequence;
4656 * authorization will assign the final address.
4658 if (udev->wusb == 0) {
4659 for (operations = 0; operations < SET_ADDRESS_TRIES; ++operations) {
4660 retval = hub_set_address(udev, devnum);
4666 if (retval != -ENODEV)
4667 dev_err(&udev->dev, "device not accepting address %d, error %d\n",
4671 if (udev->speed >= USB_SPEED_SUPER) {
4672 devnum = udev->devnum;
4673 dev_info(&udev->dev,
4674 "%s SuperSpeed%s USB device number %d using %s\n",
4675 (udev->config) ? "reset" : "new",
4676 (udev->speed == USB_SPEED_SUPER_PLUS) ? "Plus" : "",
4677 devnum, driver_name);
4680 /* cope with hardware quirkiness:
4681 * - let SET_ADDRESS settle, some device hardware wants it
4682 * - read ep0 maxpacket even for high and low speed,
4685 /* use_new_scheme() checks the speed which may have
4686 * changed since the initial look so we cache the result
4693 retval = usb_get_device_descriptor(udev, 8);
4695 if (retval != -ENODEV)
4697 "device descriptor read/8, error %d\n",
4710 * Some superspeed devices have finished the link training process
4711 * and attached to a superspeed hub port, but the device descriptor
4712 * got from those devices show they aren't superspeed devices. Warm
4713 * reset the port attached by the devices can fix them.
4715 if ((udev->speed >= USB_SPEED_SUPER) &&
4716 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
4717 dev_err(&udev->dev, "got a wrong device descriptor, "
4718 "warm reset device\n");
4719 hub_port_reset(hub, port1, udev,
4720 HUB_BH_RESET_TIME, true);
4725 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
4726 udev->speed >= USB_SPEED_SUPER)
4729 i = udev->descriptor.bMaxPacketSize0;
4730 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
4731 if (udev->speed == USB_SPEED_LOW ||
4732 !(i == 8 || i == 16 || i == 32 || i == 64)) {
4733 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
4737 if (udev->speed == USB_SPEED_FULL)
4738 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
4740 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
4741 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
4742 usb_ep0_reinit(udev);
4745 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
4746 if (retval < (signed)sizeof(udev->descriptor)) {
4747 if (retval != -ENODEV)
4748 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
4755 usb_detect_quirks(udev);
4757 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
4758 retval = usb_get_bos_descriptor(udev);
4760 udev->lpm_capable = usb_device_supports_lpm(udev);
4761 usb_set_lpm_parameters(udev);
4766 /* notify HCD that we have a device connected and addressed */
4767 if (hcd->driver->update_device)
4768 hcd->driver->update_device(hcd, udev);
4769 hub_set_initial_usb2_lpm_policy(udev);
4772 hub_port_disable(hub, port1, 0);
4773 update_devnum(udev, devnum); /* for disconnect processing */
4775 mutex_unlock(hcd->address0_mutex);
4780 check_highspeed(struct usb_hub *hub, struct usb_device *udev, int port1)
4782 struct usb_qualifier_descriptor *qual;
4785 if (udev->quirks & USB_QUIRK_DEVICE_QUALIFIER)
4788 qual = kmalloc(sizeof *qual, GFP_KERNEL);
4792 status = usb_get_descriptor(udev, USB_DT_DEVICE_QUALIFIER, 0,
4793 qual, sizeof *qual);
4794 if (status == sizeof *qual) {
4795 dev_info(&udev->dev, "not running at top speed; "
4796 "connect to a high speed hub\n");
4797 /* hub LEDs are probably harder to miss than syslog */
4798 if (hub->has_indicators) {
4799 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
4800 queue_delayed_work(system_power_efficient_wq,
4808 hub_power_remaining(struct usb_hub *hub)
4810 struct usb_device *hdev = hub->hdev;
4814 if (!hub->limited_power)
4817 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
4818 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
4819 struct usb_port *port_dev = hub->ports[port1 - 1];
4820 struct usb_device *udev = port_dev->child;
4826 if (hub_is_superspeed(udev))
4832 * Unconfigured devices may not use more than one unit load,
4833 * or 8mA for OTG ports
4835 if (udev->actconfig)
4836 delta = usb_get_max_power(udev, udev->actconfig);
4837 else if (port1 != udev->bus->otg_port || hdev->parent)
4841 if (delta > hub->mA_per_port)
4842 dev_warn(&port_dev->dev, "%dmA is over %umA budget!\n",
4843 delta, hub->mA_per_port);
4846 if (remaining < 0) {
4847 dev_warn(hub->intfdev, "%dmA over power budget!\n",
4854 static void hub_port_connect(struct usb_hub *hub, int port1, u16 portstatus,
4857 int status = -ENODEV;
4860 struct usb_device *hdev = hub->hdev;
4861 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4862 struct usb_port *port_dev = hub->ports[port1 - 1];
4863 struct usb_device *udev = port_dev->child;
4864 static int unreliable_port = -1;
4866 /* Disconnect any existing devices under this port */
4868 if (hcd->usb_phy && !hdev->parent)
4869 usb_phy_notify_disconnect(hcd->usb_phy, udev->speed);
4870 usb_disconnect(&port_dev->child);
4873 /* We can forget about a "removed" device when there's a physical
4874 * disconnect or the connect status changes.
4876 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4877 (portchange & USB_PORT_STAT_C_CONNECTION))
4878 clear_bit(port1, hub->removed_bits);
4880 if (portchange & (USB_PORT_STAT_C_CONNECTION |
4881 USB_PORT_STAT_C_ENABLE)) {
4882 status = hub_port_debounce_be_stable(hub, port1);
4884 if (status != -ENODEV &&
4885 port1 != unreliable_port &&
4887 dev_err(&port_dev->dev, "connect-debounce failed\n");
4888 portstatus &= ~USB_PORT_STAT_CONNECTION;
4889 unreliable_port = port1;
4891 portstatus = status;
4895 /* Return now if debouncing failed or nothing is connected or
4896 * the device was "removed".
4898 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4899 test_bit(port1, hub->removed_bits)) {
4902 * maybe switch power back on (e.g. root hub was reset)
4903 * but only if the port isn't owned by someone else.
4905 if (hub_is_port_power_switchable(hub)
4906 && !port_is_power_on(hub, portstatus)
4907 && !port_dev->port_owner)
4908 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
4910 if (portstatus & USB_PORT_STAT_ENABLE)
4914 if (hub_is_superspeed(hub->hdev))
4920 for (i = 0; i < SET_CONFIG_TRIES; i++) {
4922 /* reallocate for each attempt, since references
4923 * to the previous one can escape in various ways
4925 udev = usb_alloc_dev(hdev, hdev->bus, port1);
4927 dev_err(&port_dev->dev,
4928 "couldn't allocate usb_device\n");
4932 usb_set_device_state(udev, USB_STATE_POWERED);
4933 udev->bus_mA = hub->mA_per_port;
4934 udev->level = hdev->level + 1;
4935 udev->wusb = hub_is_wusb(hub);
4937 /* Devices connected to SuperSpeed hubs are USB 3.0 or later */
4938 if (hub_is_superspeed(hub->hdev))
4939 udev->speed = USB_SPEED_SUPER;
4941 udev->speed = USB_SPEED_UNKNOWN;
4943 choose_devnum(udev);
4944 if (udev->devnum <= 0) {
4945 status = -ENOTCONN; /* Don't retry */
4949 /* reset (non-USB 3.0 devices) and get descriptor */
4950 usb_lock_port(port_dev);
4951 status = hub_port_init(hub, udev, port1, i);
4952 usb_unlock_port(port_dev);
4956 if (udev->quirks & USB_QUIRK_DELAY_INIT)
4959 /* consecutive bus-powered hubs aren't reliable; they can
4960 * violate the voltage drop budget. if the new child has
4961 * a "powered" LED, users should notice we didn't enable it
4962 * (without reading syslog), even without per-port LEDs
4965 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
4966 && udev->bus_mA <= unit_load) {
4969 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
4972 dev_dbg(&udev->dev, "get status %d ?\n", status);
4975 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
4977 "can't connect bus-powered hub "
4979 if (hub->has_indicators) {
4980 hub->indicator[port1-1] =
4981 INDICATOR_AMBER_BLINK;
4983 system_power_efficient_wq,
4986 status = -ENOTCONN; /* Don't retry */
4991 /* check for devices running slower than they could */
4992 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
4993 && udev->speed == USB_SPEED_FULL
4994 && highspeed_hubs != 0)
4995 check_highspeed(hub, udev, port1);
4997 /* Store the parent's children[] pointer. At this point
4998 * udev becomes globally accessible, although presumably
4999 * no one will look at it until hdev is unlocked.
5003 mutex_lock(&usb_port_peer_mutex);
5005 /* We mustn't add new devices if the parent hub has
5006 * been disconnected; we would race with the
5007 * recursively_mark_NOTATTACHED() routine.
5009 spin_lock_irq(&device_state_lock);
5010 if (hdev->state == USB_STATE_NOTATTACHED)
5013 port_dev->child = udev;
5014 spin_unlock_irq(&device_state_lock);
5015 mutex_unlock(&usb_port_peer_mutex);
5017 /* Run it through the hoops (find a driver, etc) */
5019 status = usb_new_device(udev);
5021 mutex_lock(&usb_port_peer_mutex);
5022 spin_lock_irq(&device_state_lock);
5023 port_dev->child = NULL;
5024 spin_unlock_irq(&device_state_lock);
5025 mutex_unlock(&usb_port_peer_mutex);
5027 if (hcd->usb_phy && !hdev->parent)
5028 usb_phy_notify_connect(hcd->usb_phy,
5036 status = hub_power_remaining(hub);
5038 dev_dbg(hub->intfdev, "%dmA power budget left\n", status);
5043 hub_port_disable(hub, port1, 1);
5045 usb_ep0_reinit(udev);
5046 release_devnum(udev);
5049 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
5052 /* When halfway through our retry count, power-cycle the port */
5053 if (i == (SET_CONFIG_TRIES / 2) - 1) {
5054 dev_info(&port_dev->dev, "attempt power cycle\n");
5055 usb_hub_set_port_power(hdev, hub, port1, false);
5056 msleep(2 * hub_power_on_good_delay(hub));
5057 usb_hub_set_port_power(hdev, hub, port1, true);
5058 msleep(hub_power_on_good_delay(hub));
5061 if (hub->hdev->parent ||
5062 !hcd->driver->port_handed_over ||
5063 !(hcd->driver->port_handed_over)(hcd, port1)) {
5064 if (status != -ENOTCONN && status != -ENODEV)
5065 dev_err(&port_dev->dev,
5066 "unable to enumerate USB device\n");
5070 hub_port_disable(hub, port1, 1);
5071 if (hcd->driver->relinquish_port && !hub->hdev->parent) {
5072 if (status != -ENOTCONN && status != -ENODEV)
5073 hcd->driver->relinquish_port(hcd, port1);
5077 /* Handle physical or logical connection change events.
5078 * This routine is called when:
5079 * a port connection-change occurs;
5080 * a port enable-change occurs (often caused by EMI);
5081 * usb_reset_and_verify_device() encounters changed descriptors (as from
5082 * a firmware download)
5083 * caller already locked the hub
5085 static void hub_port_connect_change(struct usb_hub *hub, int port1,
5086 u16 portstatus, u16 portchange)
5087 __must_hold(&port_dev->status_lock)
5089 struct usb_port *port_dev = hub->ports[port1 - 1];
5090 struct usb_device *udev = port_dev->child;
5091 int status = -ENODEV;
5093 dev_dbg(&port_dev->dev, "status %04x, change %04x, %s\n", portstatus,
5094 portchange, portspeed(hub, portstatus));
5096 if (hub->has_indicators) {
5097 set_port_led(hub, port1, HUB_LED_AUTO);
5098 hub->indicator[port1-1] = INDICATOR_AUTO;
5101 #ifdef CONFIG_USB_OTG
5102 /* during HNP, don't repeat the debounce */
5103 if (hub->hdev->bus->is_b_host)
5104 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
5105 USB_PORT_STAT_C_ENABLE);
5108 /* Try to resuscitate an existing device */
5109 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
5110 udev->state != USB_STATE_NOTATTACHED) {
5111 if (portstatus & USB_PORT_STAT_ENABLE) {
5112 status = 0; /* Nothing to do */
5114 } else if (udev->state == USB_STATE_SUSPENDED &&
5115 udev->persist_enabled) {
5116 /* For a suspended device, treat this as a
5117 * remote wakeup event.
5119 usb_unlock_port(port_dev);
5120 status = usb_remote_wakeup(udev);
5121 usb_lock_port(port_dev);
5124 /* Don't resuscitate */;
5127 clear_bit(port1, hub->change_bits);
5129 /* successfully revalidated the connection */
5133 usb_unlock_port(port_dev);
5134 hub_port_connect(hub, port1, portstatus, portchange);
5135 usb_lock_port(port_dev);
5138 static void port_event(struct usb_hub *hub, int port1)
5139 __must_hold(&port_dev->status_lock)
5142 struct usb_port *port_dev = hub->ports[port1 - 1];
5143 struct usb_device *udev = port_dev->child;
5144 struct usb_device *hdev = hub->hdev;
5145 u16 portstatus, portchange;
5147 connect_change = test_bit(port1, hub->change_bits);
5148 clear_bit(port1, hub->event_bits);
5149 clear_bit(port1, hub->wakeup_bits);
5151 if (hub_port_status(hub, port1, &portstatus, &portchange) < 0)
5154 if (portchange & USB_PORT_STAT_C_CONNECTION) {
5155 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_CONNECTION);
5159 if (portchange & USB_PORT_STAT_C_ENABLE) {
5160 if (!connect_change)
5161 dev_dbg(&port_dev->dev, "enable change, status %08x\n",
5163 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_ENABLE);
5166 * EM interference sometimes causes badly shielded USB devices
5167 * to be shutdown by the hub, this hack enables them again.
5168 * Works at least with mouse driver.
5170 if (!(portstatus & USB_PORT_STAT_ENABLE)
5171 && !connect_change && udev) {
5172 dev_err(&port_dev->dev, "disabled by hub (EMI?), re-enabling...\n");
5177 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
5178 u16 status = 0, unused;
5180 dev_dbg(&port_dev->dev, "over-current change\n");
5181 usb_clear_port_feature(hdev, port1,
5182 USB_PORT_FEAT_C_OVER_CURRENT);
5183 msleep(100); /* Cool down */
5184 hub_power_on(hub, true);
5185 hub_port_status(hub, port1, &status, &unused);
5186 if (status & USB_PORT_STAT_OVERCURRENT)
5187 dev_err(&port_dev->dev, "over-current condition\n");
5190 if (portchange & USB_PORT_STAT_C_RESET) {
5191 dev_dbg(&port_dev->dev, "reset change\n");
5192 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_RESET);
5194 if ((portchange & USB_PORT_STAT_C_BH_RESET)
5195 && hub_is_superspeed(hdev)) {
5196 dev_dbg(&port_dev->dev, "warm reset change\n");
5197 usb_clear_port_feature(hdev, port1,
5198 USB_PORT_FEAT_C_BH_PORT_RESET);
5200 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
5201 dev_dbg(&port_dev->dev, "link state change\n");
5202 usb_clear_port_feature(hdev, port1,
5203 USB_PORT_FEAT_C_PORT_LINK_STATE);
5205 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
5206 dev_warn(&port_dev->dev, "config error\n");
5207 usb_clear_port_feature(hdev, port1,
5208 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
5211 /* skip port actions that require the port to be powered on */
5212 if (!pm_runtime_active(&port_dev->dev))
5215 if (hub_handle_remote_wakeup(hub, port1, portstatus, portchange))
5219 * Warm reset a USB3 protocol port if it's in
5220 * SS.Inactive state.
5222 if (hub_port_warm_reset_required(hub, port1, portstatus)) {
5223 dev_dbg(&port_dev->dev, "do warm reset\n");
5224 if (!udev || !(portstatus & USB_PORT_STAT_CONNECTION)
5225 || udev->state == USB_STATE_NOTATTACHED) {
5226 if (hub_port_reset(hub, port1, NULL,
5227 HUB_BH_RESET_TIME, true) < 0)
5228 hub_port_disable(hub, port1, 1);
5230 usb_unlock_port(port_dev);
5231 usb_lock_device(udev);
5232 usb_reset_device(udev);
5233 usb_unlock_device(udev);
5234 usb_lock_port(port_dev);
5240 hub_port_connect_change(hub, port1, portstatus, portchange);
5243 static void hub_event(struct work_struct *work)
5245 struct usb_device *hdev;
5246 struct usb_interface *intf;
5247 struct usb_hub *hub;
5248 struct device *hub_dev;
5253 hub = container_of(work, struct usb_hub, events);
5255 hub_dev = hub->intfdev;
5256 intf = to_usb_interface(hub_dev);
5258 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
5259 hdev->state, hdev->maxchild,
5260 /* NOTE: expects max 15 ports... */
5261 (u16) hub->change_bits[0],
5262 (u16) hub->event_bits[0]);
5264 /* Lock the device, then check to see if we were
5265 * disconnected while waiting for the lock to succeed. */
5266 usb_lock_device(hdev);
5267 if (unlikely(hub->disconnected))
5270 /* If the hub has died, clean up after it */
5271 if (hdev->state == USB_STATE_NOTATTACHED) {
5272 hub->error = -ENODEV;
5273 hub_quiesce(hub, HUB_DISCONNECT);
5278 ret = usb_autopm_get_interface(intf);
5280 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
5284 /* If this is an inactive hub, do nothing */
5289 dev_dbg(hub_dev, "resetting for error %d\n", hub->error);
5291 ret = usb_reset_device(hdev);
5293 dev_dbg(hub_dev, "error resetting hub: %d\n", ret);
5301 /* deal with port status changes */
5302 for (i = 1; i <= hdev->maxchild; i++) {
5303 struct usb_port *port_dev = hub->ports[i - 1];
5305 if (test_bit(i, hub->event_bits)
5306 || test_bit(i, hub->change_bits)
5307 || test_bit(i, hub->wakeup_bits)) {
5309 * The get_noresume and barrier ensure that if
5310 * the port was in the process of resuming, we
5311 * flush that work and keep the port active for
5312 * the duration of the port_event(). However,
5313 * if the port is runtime pm suspended
5314 * (powered-off), we leave it in that state, run
5315 * an abbreviated port_event(), and move on.
5317 pm_runtime_get_noresume(&port_dev->dev);
5318 pm_runtime_barrier(&port_dev->dev);
5319 usb_lock_port(port_dev);
5321 usb_unlock_port(port_dev);
5322 pm_runtime_put_sync(&port_dev->dev);
5326 /* deal with hub status changes */
5327 if (test_and_clear_bit(0, hub->event_bits) == 0)
5329 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
5330 dev_err(hub_dev, "get_hub_status failed\n");
5332 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
5333 dev_dbg(hub_dev, "power change\n");
5334 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
5335 if (hubstatus & HUB_STATUS_LOCAL_POWER)
5336 /* FIXME: Is this always true? */
5337 hub->limited_power = 1;
5339 hub->limited_power = 0;
5341 if (hubchange & HUB_CHANGE_OVERCURRENT) {
5345 dev_dbg(hub_dev, "over-current change\n");
5346 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
5347 msleep(500); /* Cool down */
5348 hub_power_on(hub, true);
5349 hub_hub_status(hub, &status, &unused);
5350 if (status & HUB_STATUS_OVERCURRENT)
5351 dev_err(hub_dev, "over-current condition\n");
5356 /* Balance the usb_autopm_get_interface() above */
5357 usb_autopm_put_interface_no_suspend(intf);
5359 usb_unlock_device(hdev);
5361 /* Balance the stuff in kick_hub_wq() and allow autosuspend */
5362 usb_autopm_put_interface(intf);
5363 kref_put(&hub->kref, hub_release);
5366 static const struct usb_device_id hub_id_table[] = {
5367 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5368 | USB_DEVICE_ID_MATCH_PRODUCT
5369 | USB_DEVICE_ID_MATCH_INT_CLASS,
5370 .idVendor = USB_VENDOR_SMSC,
5371 .idProduct = USB_PRODUCT_USB5534B,
5372 .bInterfaceClass = USB_CLASS_HUB,
5373 .driver_info = HUB_QUIRK_DISABLE_AUTOSUSPEND},
5374 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5375 | USB_DEVICE_ID_MATCH_PRODUCT,
5376 .idVendor = USB_VENDOR_CYPRESS,
5377 .idProduct = USB_PRODUCT_CY7C65632,
5378 .driver_info = HUB_QUIRK_DISABLE_AUTOSUSPEND},
5379 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5380 | USB_DEVICE_ID_MATCH_INT_CLASS,
5381 .idVendor = USB_VENDOR_GENESYS_LOGIC,
5382 .bInterfaceClass = USB_CLASS_HUB,
5383 .driver_info = HUB_QUIRK_CHECK_PORT_AUTOSUSPEND},
5384 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
5385 .bDeviceClass = USB_CLASS_HUB},
5386 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
5387 .bInterfaceClass = USB_CLASS_HUB},
5388 { } /* Terminating entry */
5391 MODULE_DEVICE_TABLE(usb, hub_id_table);
5393 static struct usb_driver hub_driver = {
5396 .disconnect = hub_disconnect,
5397 .suspend = hub_suspend,
5398 .resume = hub_resume,
5399 .reset_resume = hub_reset_resume,
5400 .pre_reset = hub_pre_reset,
5401 .post_reset = hub_post_reset,
5402 .unlocked_ioctl = hub_ioctl,
5403 .id_table = hub_id_table,
5404 .supports_autosuspend = 1,
5407 int usb_hub_init(void)
5409 if (usb_register(&hub_driver) < 0) {
5410 printk(KERN_ERR "%s: can't register hub driver\n",
5416 * The workqueue needs to be freezable to avoid interfering with
5417 * USB-PERSIST port handover. Otherwise it might see that a full-speed
5418 * device was gone before the EHCI controller had handed its port
5419 * over to the companion full-speed controller.
5421 hub_wq = alloc_workqueue("usb_hub_wq", WQ_FREEZABLE, 0);
5425 /* Fall through if kernel_thread failed */
5426 usb_deregister(&hub_driver);
5427 pr_err("%s: can't allocate workqueue for usb hub\n", usbcore_name);
5432 void usb_hub_cleanup(void)
5434 destroy_workqueue(hub_wq);
5437 * Hub resources are freed for us by usb_deregister. It calls
5438 * usb_driver_purge on every device which in turn calls that
5439 * devices disconnect function if it is using this driver.
5440 * The hub_disconnect function takes care of releasing the
5441 * individual hub resources. -greg
5443 usb_deregister(&hub_driver);
5444 } /* usb_hub_cleanup() */
5446 static int descriptors_changed(struct usb_device *udev,
5447 struct usb_device_descriptor *old_device_descriptor,
5448 struct usb_host_bos *old_bos)
5452 unsigned serial_len = 0;
5454 unsigned old_length;
5458 if (memcmp(&udev->descriptor, old_device_descriptor,
5459 sizeof(*old_device_descriptor)) != 0)
5462 if ((old_bos && !udev->bos) || (!old_bos && udev->bos))
5465 len = le16_to_cpu(udev->bos->desc->wTotalLength);
5466 if (len != le16_to_cpu(old_bos->desc->wTotalLength))
5468 if (memcmp(udev->bos->desc, old_bos->desc, len))
5472 /* Since the idVendor, idProduct, and bcdDevice values in the
5473 * device descriptor haven't changed, we will assume the
5474 * Manufacturer and Product strings haven't changed either.
5475 * But the SerialNumber string could be different (e.g., a
5476 * different flash card of the same brand).
5479 serial_len = strlen(udev->serial) + 1;
5482 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5483 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5484 len = max(len, old_length);
5487 buf = kmalloc(len, GFP_NOIO);
5489 /* assume the worst */
5492 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5493 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5494 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
5496 if (length != old_length) {
5497 dev_dbg(&udev->dev, "config index %d, error %d\n",
5502 if (memcmp(buf, udev->rawdescriptors[index], old_length)
5504 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
5506 ((struct usb_config_descriptor *) buf)->
5507 bConfigurationValue);
5513 if (!changed && serial_len) {
5514 length = usb_string(udev, udev->descriptor.iSerialNumber,
5516 if (length + 1 != serial_len) {
5517 dev_dbg(&udev->dev, "serial string error %d\n",
5520 } else if (memcmp(buf, udev->serial, length) != 0) {
5521 dev_dbg(&udev->dev, "serial string changed\n");
5531 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5532 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5534 * WARNING - don't use this routine to reset a composite device
5535 * (one with multiple interfaces owned by separate drivers)!
5536 * Use usb_reset_device() instead.
5538 * Do a port reset, reassign the device's address, and establish its
5539 * former operating configuration. If the reset fails, or the device's
5540 * descriptors change from their values before the reset, or the original
5541 * configuration and altsettings cannot be restored, a flag will be set
5542 * telling hub_wq to pretend the device has been disconnected and then
5543 * re-connected. All drivers will be unbound, and the device will be
5544 * re-enumerated and probed all over again.
5546 * Return: 0 if the reset succeeded, -ENODEV if the device has been
5547 * flagged for logical disconnection, or some other negative error code
5548 * if the reset wasn't even attempted.
5551 * The caller must own the device lock and the port lock, the latter is
5552 * taken by usb_reset_device(). For example, it's safe to use
5553 * usb_reset_device() from a driver probe() routine after downloading
5554 * new firmware. For calls that might not occur during probe(), drivers
5555 * should lock the device using usb_lock_device_for_reset().
5557 * Locking exception: This routine may also be called from within an
5558 * autoresume handler. Such usage won't conflict with other tasks
5559 * holding the device lock because these tasks should always call
5560 * usb_autopm_resume_device(), thereby preventing any unwanted
5561 * autoresume. The autoresume handler is expected to have already
5562 * acquired the port lock before calling this routine.
5564 static int usb_reset_and_verify_device(struct usb_device *udev)
5566 struct usb_device *parent_hdev = udev->parent;
5567 struct usb_hub *parent_hub;
5568 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
5569 struct usb_device_descriptor descriptor = udev->descriptor;
5570 struct usb_host_bos *bos;
5572 int port1 = udev->portnum;
5574 if (udev->state == USB_STATE_NOTATTACHED ||
5575 udev->state == USB_STATE_SUSPENDED) {
5576 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5584 parent_hub = usb_hub_to_struct_hub(parent_hdev);
5586 /* Disable USB2 hardware LPM.
5587 * It will be re-enabled by the enumeration process.
5589 usb_disable_usb2_hardware_lpm(udev);
5591 /* Disable LPM and LTM while we reset the device and reinstall the alt
5592 * settings. Device-initiated LPM settings, and system exit latency
5593 * settings are cleared when the device is reset, so we have to set
5596 ret = usb_unlocked_disable_lpm(udev);
5598 dev_err(&udev->dev, "%s Failed to disable LPM\n.", __func__);
5599 goto re_enumerate_no_bos;
5601 ret = usb_disable_ltm(udev);
5603 dev_err(&udev->dev, "%s Failed to disable LTM\n.",
5605 goto re_enumerate_no_bos;
5611 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
5613 /* ep0 maxpacket size may change; let the HCD know about it.
5614 * Other endpoints will be handled by re-enumeration. */
5615 usb_ep0_reinit(udev);
5616 ret = hub_port_init(parent_hub, udev, port1, i);
5617 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
5624 /* Device might have changed firmware (DFU or similar) */
5625 if (descriptors_changed(udev, &descriptor, bos)) {
5626 dev_info(&udev->dev, "device firmware changed\n");
5627 udev->descriptor = descriptor; /* for disconnect() calls */
5631 /* Restore the device's previous configuration */
5632 if (!udev->actconfig)
5635 mutex_lock(hcd->bandwidth_mutex);
5636 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
5638 dev_warn(&udev->dev,
5639 "Busted HC? Not enough HCD resources for "
5640 "old configuration.\n");
5641 mutex_unlock(hcd->bandwidth_mutex);
5644 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
5645 USB_REQ_SET_CONFIGURATION, 0,
5646 udev->actconfig->desc.bConfigurationValue, 0,
5647 NULL, 0, USB_CTRL_SET_TIMEOUT);
5650 "can't restore configuration #%d (error=%d)\n",
5651 udev->actconfig->desc.bConfigurationValue, ret);
5652 mutex_unlock(hcd->bandwidth_mutex);
5655 mutex_unlock(hcd->bandwidth_mutex);
5656 usb_set_device_state(udev, USB_STATE_CONFIGURED);
5658 /* Put interfaces back into the same altsettings as before.
5659 * Don't bother to send the Set-Interface request for interfaces
5660 * that were already in altsetting 0; besides being unnecessary,
5661 * many devices can't handle it. Instead just reset the host-side
5664 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
5665 struct usb_host_config *config = udev->actconfig;
5666 struct usb_interface *intf = config->interface[i];
5667 struct usb_interface_descriptor *desc;
5669 desc = &intf->cur_altsetting->desc;
5670 if (desc->bAlternateSetting == 0) {
5671 usb_disable_interface(udev, intf, true);
5672 usb_enable_interface(udev, intf, true);
5675 /* Let the bandwidth allocation function know that this
5676 * device has been reset, and it will have to use
5677 * alternate setting 0 as the current alternate setting.
5679 intf->resetting_device = 1;
5680 ret = usb_set_interface(udev, desc->bInterfaceNumber,
5681 desc->bAlternateSetting);
5682 intf->resetting_device = 0;
5685 dev_err(&udev->dev, "failed to restore interface %d "
5686 "altsetting %d (error=%d)\n",
5687 desc->bInterfaceNumber,
5688 desc->bAlternateSetting,
5692 /* Resetting also frees any allocated streams */
5693 for (j = 0; j < intf->cur_altsetting->desc.bNumEndpoints; j++)
5694 intf->cur_altsetting->endpoint[j].streams = 0;
5698 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5699 usb_enable_usb2_hardware_lpm(udev);
5700 usb_unlocked_enable_lpm(udev);
5701 usb_enable_ltm(udev);
5702 usb_release_bos_descriptor(udev);
5707 usb_release_bos_descriptor(udev);
5709 re_enumerate_no_bos:
5710 /* LPM state doesn't matter when we're about to destroy the device. */
5711 hub_port_logical_disconnect(parent_hub, port1);
5716 * usb_reset_device - warn interface drivers and perform a USB port reset
5717 * @udev: device to reset (not in NOTATTACHED state)
5719 * Warns all drivers bound to registered interfaces (using their pre_reset
5720 * method), performs the port reset, and then lets the drivers know that
5721 * the reset is over (using their post_reset method).
5723 * Return: The same as for usb_reset_and_verify_device().
5726 * The caller must own the device lock. For example, it's safe to use
5727 * this from a driver probe() routine after downloading new firmware.
5728 * For calls that might not occur during probe(), drivers should lock
5729 * the device using usb_lock_device_for_reset().
5731 * If an interface is currently being probed or disconnected, we assume
5732 * its driver knows how to handle resets. For all other interfaces,
5733 * if the driver doesn't have pre_reset and post_reset methods then
5734 * we attempt to unbind it and rebind afterward.
5736 int usb_reset_device(struct usb_device *udev)
5740 unsigned int noio_flag;
5741 struct usb_port *port_dev;
5742 struct usb_host_config *config = udev->actconfig;
5743 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
5745 if (udev->state == USB_STATE_NOTATTACHED) {
5746 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5751 if (!udev->parent) {
5752 /* this requires hcd-specific logic; see ohci_restart() */
5753 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
5757 port_dev = hub->ports[udev->portnum - 1];
5760 * Don't allocate memory with GFP_KERNEL in current
5761 * context to avoid possible deadlock if usb mass
5762 * storage interface or usbnet interface(iSCSI case)
5763 * is included in current configuration. The easist
5764 * approach is to do it for every device reset,
5765 * because the device 'memalloc_noio' flag may have
5766 * not been set before reseting the usb device.
5768 noio_flag = memalloc_noio_save();
5770 /* Prevent autosuspend during the reset */
5771 usb_autoresume_device(udev);
5774 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
5775 struct usb_interface *cintf = config->interface[i];
5776 struct usb_driver *drv;
5779 if (cintf->dev.driver) {
5780 drv = to_usb_driver(cintf->dev.driver);
5781 if (drv->pre_reset && drv->post_reset)
5782 unbind = (drv->pre_reset)(cintf);
5783 else if (cintf->condition ==
5784 USB_INTERFACE_BOUND)
5787 usb_forced_unbind_intf(cintf);
5792 usb_lock_port(port_dev);
5793 ret = usb_reset_and_verify_device(udev);
5794 usb_unlock_port(port_dev);
5797 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
5798 struct usb_interface *cintf = config->interface[i];
5799 struct usb_driver *drv;
5800 int rebind = cintf->needs_binding;
5802 if (!rebind && cintf->dev.driver) {
5803 drv = to_usb_driver(cintf->dev.driver);
5804 if (drv->post_reset)
5805 rebind = (drv->post_reset)(cintf);
5806 else if (cintf->condition ==
5807 USB_INTERFACE_BOUND)
5810 cintf->needs_binding = 1;
5814 /* If the reset failed, hub_wq will unbind drivers later */
5816 usb_unbind_and_rebind_marked_interfaces(udev);
5819 usb_autosuspend_device(udev);
5820 memalloc_noio_restore(noio_flag);
5823 EXPORT_SYMBOL_GPL(usb_reset_device);
5827 * usb_queue_reset_device - Reset a USB device from an atomic context
5828 * @iface: USB interface belonging to the device to reset
5830 * This function can be used to reset a USB device from an atomic
5831 * context, where usb_reset_device() won't work (as it blocks).
5833 * Doing a reset via this method is functionally equivalent to calling
5834 * usb_reset_device(), except for the fact that it is delayed to a
5835 * workqueue. This means that any drivers bound to other interfaces
5836 * might be unbound, as well as users from usbfs in user space.
5840 * - Scheduling two resets at the same time from two different drivers
5841 * attached to two different interfaces of the same device is
5842 * possible; depending on how the driver attached to each interface
5843 * handles ->pre_reset(), the second reset might happen or not.
5845 * - If the reset is delayed so long that the interface is unbound from
5846 * its driver, the reset will be skipped.
5848 * - This function can be called during .probe(). It can also be called
5849 * during .disconnect(), but doing so is pointless because the reset
5850 * will not occur. If you really want to reset the device during
5851 * .disconnect(), call usb_reset_device() directly -- but watch out
5852 * for nested unbinding issues!
5854 void usb_queue_reset_device(struct usb_interface *iface)
5856 if (schedule_work(&iface->reset_ws))
5857 usb_get_intf(iface);
5859 EXPORT_SYMBOL_GPL(usb_queue_reset_device);
5862 * usb_hub_find_child - Get the pointer of child device
5863 * attached to the port which is specified by @port1.
5864 * @hdev: USB device belonging to the usb hub
5865 * @port1: port num to indicate which port the child device
5868 * USB drivers call this function to get hub's child device
5871 * Return: %NULL if input param is invalid and
5872 * child's usb_device pointer if non-NULL.
5874 struct usb_device *usb_hub_find_child(struct usb_device *hdev,
5877 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5879 if (port1 < 1 || port1 > hdev->maxchild)
5881 return hub->ports[port1 - 1]->child;
5883 EXPORT_SYMBOL_GPL(usb_hub_find_child);
5885 void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
5886 struct usb_hub_descriptor *desc)
5888 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5889 enum usb_port_connect_type connect_type;
5895 if (!hub_is_superspeed(hdev)) {
5896 for (i = 1; i <= hdev->maxchild; i++) {
5897 struct usb_port *port_dev = hub->ports[i - 1];
5899 connect_type = port_dev->connect_type;
5900 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5901 u8 mask = 1 << (i%8);
5903 if (!(desc->u.hs.DeviceRemovable[i/8] & mask)) {
5904 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
5905 desc->u.hs.DeviceRemovable[i/8] |= mask;
5910 u16 port_removable = le16_to_cpu(desc->u.ss.DeviceRemovable);
5912 for (i = 1; i <= hdev->maxchild; i++) {
5913 struct usb_port *port_dev = hub->ports[i - 1];
5915 connect_type = port_dev->connect_type;
5916 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5919 if (!(port_removable & mask)) {
5920 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
5921 port_removable |= mask;
5926 desc->u.ss.DeviceRemovable = cpu_to_le16(port_removable);
5932 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5933 * @hdev: USB device belonging to the usb hub
5934 * @port1: port num of the port
5936 * Return: Port's acpi handle if successful, %NULL if params are
5939 acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
5942 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5947 return ACPI_HANDLE(&hub->ports[port1 - 1]->dev);