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);
1080 /* Give some time on remote wakeup to let links to transit to U0 */
1081 } else if (hub_is_superspeed(hub->hdev))
1087 * Check each port and set hub->change_bits to let hub_wq know
1088 * which ports need attention.
1090 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
1091 struct usb_port *port_dev = hub->ports[port1 - 1];
1092 struct usb_device *udev = port_dev->child;
1093 u16 portstatus, portchange;
1095 portstatus = portchange = 0;
1096 status = hub_port_status(hub, port1, &portstatus, &portchange);
1100 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1101 dev_dbg(&port_dev->dev, "status %04x change %04x\n",
1102 portstatus, portchange);
1105 * After anything other than HUB_RESUME (i.e., initialization
1106 * or any sort of reset), every port should be disabled.
1107 * Unconnected ports should likewise be disabled (paranoia),
1108 * and so should ports for which we have no usb_device.
1110 if ((portstatus & USB_PORT_STAT_ENABLE) && (
1111 type != HUB_RESUME ||
1112 !(portstatus & USB_PORT_STAT_CONNECTION) ||
1114 udev->state == USB_STATE_NOTATTACHED)) {
1116 * USB3 protocol ports will automatically transition
1117 * to Enabled state when detect an USB3.0 device attach.
1118 * Do not disable USB3 protocol ports, just pretend
1121 portstatus &= ~USB_PORT_STAT_ENABLE;
1122 if (!hub_is_superspeed(hdev))
1123 usb_clear_port_feature(hdev, port1,
1124 USB_PORT_FEAT_ENABLE);
1127 /* Make sure a warm-reset request is handled by port_event */
1128 if (type == HUB_RESUME &&
1129 hub_port_warm_reset_required(hub, port1, portstatus))
1130 set_bit(port1, hub->event_bits);
1133 * Add debounce if USB3 link is in polling/link training state.
1134 * Link will automatically transition to Enabled state after
1135 * link training completes.
1137 if (hub_is_superspeed(hdev) &&
1138 ((portstatus & USB_PORT_STAT_LINK_STATE) ==
1139 USB_SS_PORT_LS_POLLING))
1140 need_debounce_delay = true;
1142 /* Clear status-change flags; we'll debounce later */
1143 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1144 need_debounce_delay = true;
1145 usb_clear_port_feature(hub->hdev, port1,
1146 USB_PORT_FEAT_C_CONNECTION);
1148 if (portchange & USB_PORT_STAT_C_ENABLE) {
1149 need_debounce_delay = true;
1150 usb_clear_port_feature(hub->hdev, port1,
1151 USB_PORT_FEAT_C_ENABLE);
1153 if (portchange & USB_PORT_STAT_C_RESET) {
1154 need_debounce_delay = true;
1155 usb_clear_port_feature(hub->hdev, port1,
1156 USB_PORT_FEAT_C_RESET);
1158 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
1159 hub_is_superspeed(hub->hdev)) {
1160 need_debounce_delay = true;
1161 usb_clear_port_feature(hub->hdev, port1,
1162 USB_PORT_FEAT_C_BH_PORT_RESET);
1164 /* We can forget about a "removed" device when there's a
1165 * physical disconnect or the connect status changes.
1167 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
1168 (portchange & USB_PORT_STAT_C_CONNECTION))
1169 clear_bit(port1, hub->removed_bits);
1171 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
1172 /* Tell hub_wq to disconnect the device or
1173 * check for a new connection or over current condition.
1174 * Based on USB2.0 Spec Section 11.12.5,
1175 * C_PORT_OVER_CURRENT could be set while
1176 * PORT_OVER_CURRENT is not. So check for any of them.
1178 if (udev || (portstatus & USB_PORT_STAT_CONNECTION) ||
1179 (portchange & USB_PORT_STAT_C_CONNECTION) ||
1180 (portstatus & USB_PORT_STAT_OVERCURRENT) ||
1181 (portchange & USB_PORT_STAT_C_OVERCURRENT))
1182 set_bit(port1, hub->change_bits);
1184 } else if (portstatus & USB_PORT_STAT_ENABLE) {
1185 bool port_resumed = (portstatus &
1186 USB_PORT_STAT_LINK_STATE) ==
1188 /* The power session apparently survived the resume.
1189 * If there was an overcurrent or suspend change
1190 * (i.e., remote wakeup request), have hub_wq
1191 * take care of it. Look at the port link state
1192 * for USB 3.0 hubs, since they don't have a suspend
1193 * change bit, and they don't set the port link change
1194 * bit on device-initiated resume.
1196 if (portchange || (hub_is_superspeed(hub->hdev) &&
1198 set_bit(port1, hub->event_bits);
1200 } else if (udev->persist_enabled) {
1202 udev->reset_resume = 1;
1204 /* Don't set the change_bits when the device
1207 if (test_bit(port1, hub->power_bits))
1208 set_bit(port1, hub->change_bits);
1211 /* The power session is gone; tell hub_wq */
1212 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1213 set_bit(port1, hub->change_bits);
1217 /* If no port-status-change flags were set, we don't need any
1218 * debouncing. If flags were set we can try to debounce the
1219 * ports all at once right now, instead of letting hub_wq do them
1220 * one at a time later on.
1222 * If any port-status changes do occur during this delay, hub_wq
1223 * will see them later and handle them normally.
1225 if (need_debounce_delay) {
1226 delay = HUB_DEBOUNCE_STABLE;
1228 /* Don't do a long sleep inside a workqueue routine */
1229 if (type == HUB_INIT2) {
1230 INIT_DELAYED_WORK(&hub->init_work, hub_init_func3);
1231 queue_delayed_work(system_power_efficient_wq,
1233 msecs_to_jiffies(delay));
1234 device_unlock(&hdev->dev);
1235 return; /* Continues at init3: below */
1243 status = usb_submit_urb(hub->urb, GFP_NOIO);
1245 dev_err(hub->intfdev, "activate --> %d\n", status);
1246 if (hub->has_indicators && blinkenlights)
1247 queue_delayed_work(system_power_efficient_wq,
1248 &hub->leds, LED_CYCLE_PERIOD);
1250 /* Scan all ports that need attention */
1253 if (type == HUB_INIT2 || type == HUB_INIT3) {
1254 /* Allow autosuspend if it was suppressed */
1256 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
1257 device_unlock(&hdev->dev);
1260 kref_put(&hub->kref, hub_release);
1263 /* Implement the continuations for the delays above */
1264 static void hub_init_func2(struct work_struct *ws)
1266 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1268 hub_activate(hub, HUB_INIT2);
1271 static void hub_init_func3(struct work_struct *ws)
1273 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1275 hub_activate(hub, HUB_INIT3);
1278 enum hub_quiescing_type {
1279 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
1282 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
1284 struct usb_device *hdev = hub->hdev;
1287 /* hub_wq and related activity won't re-trigger */
1290 if (type != HUB_SUSPEND) {
1291 /* Disconnect all the children */
1292 for (i = 0; i < hdev->maxchild; ++i) {
1293 if (hub->ports[i]->child)
1294 usb_disconnect(&hub->ports[i]->child);
1298 /* Stop hub_wq and related activity */
1299 usb_kill_urb(hub->urb);
1300 if (hub->has_indicators)
1301 cancel_delayed_work_sync(&hub->leds);
1303 flush_work(&hub->tt.clear_work);
1306 static void hub_pm_barrier_for_all_ports(struct usb_hub *hub)
1310 for (i = 0; i < hub->hdev->maxchild; ++i)
1311 pm_runtime_barrier(&hub->ports[i]->dev);
1314 /* caller has locked the hub device */
1315 static int hub_pre_reset(struct usb_interface *intf)
1317 struct usb_hub *hub = usb_get_intfdata(intf);
1319 hub_quiesce(hub, HUB_PRE_RESET);
1321 hub_pm_barrier_for_all_ports(hub);
1325 /* caller has locked the hub device */
1326 static int hub_post_reset(struct usb_interface *intf)
1328 struct usb_hub *hub = usb_get_intfdata(intf);
1331 hub_pm_barrier_for_all_ports(hub);
1332 hub_activate(hub, HUB_POST_RESET);
1336 static int hub_configure(struct usb_hub *hub,
1337 struct usb_endpoint_descriptor *endpoint)
1339 struct usb_hcd *hcd;
1340 struct usb_device *hdev = hub->hdev;
1341 struct device *hub_dev = hub->intfdev;
1342 u16 hubstatus, hubchange;
1343 u16 wHubCharacteristics;
1346 char *message = "out of memory";
1351 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
1357 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1362 mutex_init(&hub->status_mutex);
1364 hub->descriptor = kzalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1365 if (!hub->descriptor) {
1370 /* Request the entire hub descriptor.
1371 * hub->descriptor can handle USB_MAXCHILDREN ports,
1372 * but a (non-SS) hub can/will return fewer bytes here.
1374 ret = get_hub_descriptor(hdev, hub->descriptor);
1376 message = "can't read hub descriptor";
1380 maxchild = USB_MAXCHILDREN;
1381 if (hub_is_superspeed(hdev))
1382 maxchild = min_t(unsigned, maxchild, USB_SS_MAXPORTS);
1384 if (hub->descriptor->bNbrPorts > maxchild) {
1385 message = "hub has too many ports!";
1388 } else if (hub->descriptor->bNbrPorts == 0) {
1389 message = "hub doesn't have any ports!";
1394 maxchild = hub->descriptor->bNbrPorts;
1395 dev_info(hub_dev, "%d port%s detected\n", maxchild,
1396 (maxchild == 1) ? "" : "s");
1398 hub->ports = kzalloc(maxchild * sizeof(struct usb_port *), GFP_KERNEL);
1404 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1405 if (hub_is_superspeed(hdev)) {
1413 /* FIXME for USB 3.0, skip for now */
1414 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1415 !(hub_is_superspeed(hdev))) {
1416 char portstr[USB_MAXCHILDREN + 1];
1418 for (i = 0; i < maxchild; i++)
1419 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1420 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1422 portstr[maxchild] = 0;
1423 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1425 dev_dbg(hub_dev, "standalone hub\n");
1427 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1428 case HUB_CHAR_COMMON_LPSM:
1429 dev_dbg(hub_dev, "ganged power switching\n");
1431 case HUB_CHAR_INDV_PORT_LPSM:
1432 dev_dbg(hub_dev, "individual port power switching\n");
1434 case HUB_CHAR_NO_LPSM:
1436 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1440 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1441 case HUB_CHAR_COMMON_OCPM:
1442 dev_dbg(hub_dev, "global over-current protection\n");
1444 case HUB_CHAR_INDV_PORT_OCPM:
1445 dev_dbg(hub_dev, "individual port over-current protection\n");
1447 case HUB_CHAR_NO_OCPM:
1449 dev_dbg(hub_dev, "no over-current protection\n");
1453 spin_lock_init(&hub->tt.lock);
1454 INIT_LIST_HEAD(&hub->tt.clear_list);
1455 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1456 switch (hdev->descriptor.bDeviceProtocol) {
1459 case USB_HUB_PR_HS_SINGLE_TT:
1460 dev_dbg(hub_dev, "Single TT\n");
1463 case USB_HUB_PR_HS_MULTI_TT:
1464 ret = usb_set_interface(hdev, 0, 1);
1466 dev_dbg(hub_dev, "TT per port\n");
1469 dev_err(hub_dev, "Using single TT (err %d)\n",
1474 /* USB 3.0 hubs don't have a TT */
1477 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1478 hdev->descriptor.bDeviceProtocol);
1482 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1483 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1484 case HUB_TTTT_8_BITS:
1485 if (hdev->descriptor.bDeviceProtocol != 0) {
1486 hub->tt.think_time = 666;
1487 dev_dbg(hub_dev, "TT requires at most %d "
1488 "FS bit times (%d ns)\n",
1489 8, hub->tt.think_time);
1492 case HUB_TTTT_16_BITS:
1493 hub->tt.think_time = 666 * 2;
1494 dev_dbg(hub_dev, "TT requires at most %d "
1495 "FS bit times (%d ns)\n",
1496 16, hub->tt.think_time);
1498 case HUB_TTTT_24_BITS:
1499 hub->tt.think_time = 666 * 3;
1500 dev_dbg(hub_dev, "TT requires at most %d "
1501 "FS bit times (%d ns)\n",
1502 24, hub->tt.think_time);
1504 case HUB_TTTT_32_BITS:
1505 hub->tt.think_time = 666 * 4;
1506 dev_dbg(hub_dev, "TT requires at most %d "
1507 "FS bit times (%d ns)\n",
1508 32, hub->tt.think_time);
1512 /* probe() zeroes hub->indicator[] */
1513 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1514 hub->has_indicators = 1;
1515 dev_dbg(hub_dev, "Port indicators are supported\n");
1518 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1519 hub->descriptor->bPwrOn2PwrGood * 2);
1521 /* power budgeting mostly matters with bus-powered hubs,
1522 * and battery-powered root hubs (may provide just 8 mA).
1524 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1526 message = "can't get hub status";
1529 hcd = bus_to_hcd(hdev->bus);
1530 if (hdev == hdev->bus->root_hub) {
1531 if (hcd->power_budget > 0)
1532 hdev->bus_mA = hcd->power_budget;
1534 hdev->bus_mA = full_load * maxchild;
1535 if (hdev->bus_mA >= full_load)
1536 hub->mA_per_port = full_load;
1538 hub->mA_per_port = hdev->bus_mA;
1539 hub->limited_power = 1;
1541 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1542 int remaining = hdev->bus_mA -
1543 hub->descriptor->bHubContrCurrent;
1545 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1546 hub->descriptor->bHubContrCurrent);
1547 hub->limited_power = 1;
1549 if (remaining < maxchild * unit_load)
1551 "insufficient power available "
1552 "to use all downstream ports\n");
1553 hub->mA_per_port = unit_load; /* 7.2.1 */
1555 } else { /* Self-powered external hub */
1556 /* FIXME: What about battery-powered external hubs that
1557 * provide less current per port? */
1558 hub->mA_per_port = full_load;
1560 if (hub->mA_per_port < full_load)
1561 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1564 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1566 message = "can't get hub status";
1570 /* local power status reports aren't always correct */
1571 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1572 dev_dbg(hub_dev, "local power source is %s\n",
1573 (hubstatus & HUB_STATUS_LOCAL_POWER)
1574 ? "lost (inactive)" : "good");
1576 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1577 dev_dbg(hub_dev, "%sover-current condition exists\n",
1578 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1580 /* set up the interrupt endpoint
1581 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1582 * bytes as USB2.0[11.12.3] says because some hubs are known
1583 * to send more data (and thus cause overflow). For root hubs,
1584 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1585 * to be big enough for at least USB_MAXCHILDREN ports. */
1586 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1587 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1589 if (maxp > sizeof(*hub->buffer))
1590 maxp = sizeof(*hub->buffer);
1592 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1598 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1599 hub, endpoint->bInterval);
1601 /* maybe cycle the hub leds */
1602 if (hub->has_indicators && blinkenlights)
1603 hub->indicator[0] = INDICATOR_CYCLE;
1605 mutex_lock(&usb_port_peer_mutex);
1606 for (i = 0; i < maxchild; i++) {
1607 ret = usb_hub_create_port_device(hub, i + 1);
1609 dev_err(hub->intfdev,
1610 "couldn't create port%d device.\n", i + 1);
1615 for (i = 0; i < hdev->maxchild; i++) {
1616 struct usb_port *port_dev = hub->ports[i];
1618 pm_runtime_put(&port_dev->dev);
1621 mutex_unlock(&usb_port_peer_mutex);
1625 /* Update the HCD's internal representation of this hub before hub_wq
1626 * starts getting port status changes for devices under the hub.
1628 if (hcd->driver->update_hub_device) {
1629 ret = hcd->driver->update_hub_device(hcd, hdev,
1630 &hub->tt, GFP_KERNEL);
1632 message = "can't update HCD hub info";
1637 usb_hub_adjust_deviceremovable(hdev, hub->descriptor);
1639 hub_activate(hub, HUB_INIT);
1643 dev_err(hub_dev, "config failed, %s (err %d)\n",
1645 /* hub_disconnect() frees urb and descriptor */
1649 static void hub_release(struct kref *kref)
1651 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1653 usb_put_dev(hub->hdev);
1654 usb_put_intf(to_usb_interface(hub->intfdev));
1658 static unsigned highspeed_hubs;
1660 static void hub_disconnect(struct usb_interface *intf)
1662 struct usb_hub *hub = usb_get_intfdata(intf);
1663 struct usb_device *hdev = interface_to_usbdev(intf);
1667 * Stop adding new hub events. We do not want to block here and thus
1668 * will not try to remove any pending work item.
1670 hub->disconnected = 1;
1672 /* Disconnect all children and quiesce the hub */
1674 hub_quiesce(hub, HUB_DISCONNECT);
1676 mutex_lock(&usb_port_peer_mutex);
1678 /* Avoid races with recursively_mark_NOTATTACHED() */
1679 spin_lock_irq(&device_state_lock);
1680 port1 = hdev->maxchild;
1682 usb_set_intfdata(intf, NULL);
1683 spin_unlock_irq(&device_state_lock);
1685 for (; port1 > 0; --port1)
1686 usb_hub_remove_port_device(hub, port1);
1688 mutex_unlock(&usb_port_peer_mutex);
1690 if (hub->hdev->speed == USB_SPEED_HIGH)
1693 usb_free_urb(hub->urb);
1695 kfree(hub->descriptor);
1699 pm_suspend_ignore_children(&intf->dev, false);
1701 if (hub->quirk_disable_autosuspend)
1702 usb_autopm_put_interface(intf);
1704 kref_put(&hub->kref, hub_release);
1707 static bool hub_descriptor_is_sane(struct usb_host_interface *desc)
1709 /* Some hubs have a subclass of 1, which AFAICT according to the */
1710 /* specs is not defined, but it works */
1711 if (desc->desc.bInterfaceSubClass != 0 &&
1712 desc->desc.bInterfaceSubClass != 1)
1715 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1716 if (desc->desc.bNumEndpoints != 1)
1719 /* If the first endpoint is not interrupt IN, we'd better punt! */
1720 if (!usb_endpoint_is_int_in(&desc->endpoint[0].desc))
1726 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1728 struct usb_host_interface *desc;
1729 struct usb_device *hdev;
1730 struct usb_hub *hub;
1732 desc = intf->cur_altsetting;
1733 hdev = interface_to_usbdev(intf);
1736 * Set default autosuspend delay as 0 to speedup bus suspend,
1737 * based on the below considerations:
1739 * - Unlike other drivers, the hub driver does not rely on the
1740 * autosuspend delay to provide enough time to handle a wakeup
1741 * event, and the submitted status URB is just to check future
1742 * change on hub downstream ports, so it is safe to do it.
1744 * - The patch might cause one or more auto supend/resume for
1745 * below very rare devices when they are plugged into hub
1748 * devices having trouble initializing, and disconnect
1749 * themselves from the bus and then reconnect a second
1752 * devices just for downloading firmware, and disconnects
1753 * themselves after completing it
1755 * For these quite rare devices, their drivers may change the
1756 * autosuspend delay of their parent hub in the probe() to one
1757 * appropriate value to avoid the subtle problem if someone
1760 * - The patch may cause one or more auto suspend/resume on
1761 * hub during running 'lsusb', but it is probably too
1762 * infrequent to worry about.
1764 * - Change autosuspend delay of hub can avoid unnecessary auto
1765 * suspend timer for hub, also may decrease power consumption
1768 * - If user has indicated to prevent autosuspend by passing
1769 * usbcore.autosuspend = -1 then keep autosuspend disabled.
1772 if (hdev->dev.power.autosuspend_delay >= 0)
1773 pm_runtime_set_autosuspend_delay(&hdev->dev, 0);
1777 * Hubs have proper suspend/resume support, except for root hubs
1778 * where the controller driver doesn't have bus_suspend and
1779 * bus_resume methods.
1781 if (hdev->parent) { /* normal device */
1782 usb_enable_autosuspend(hdev);
1783 } else { /* root hub */
1784 const struct hc_driver *drv = bus_to_hcd(hdev->bus)->driver;
1786 if (drv->bus_suspend && drv->bus_resume)
1787 usb_enable_autosuspend(hdev);
1790 if (hdev->level == MAX_TOPO_LEVEL) {
1792 "Unsupported bus topology: hub nested too deep\n");
1796 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1798 dev_warn(&intf->dev, "ignoring external hub\n");
1803 if (!hub_descriptor_is_sane(desc)) {
1804 dev_err(&intf->dev, "bad descriptor, ignoring hub\n");
1808 /* We found a hub */
1809 dev_info(&intf->dev, "USB hub found\n");
1811 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1815 kref_init(&hub->kref);
1816 hub->intfdev = &intf->dev;
1818 INIT_DELAYED_WORK(&hub->leds, led_work);
1819 INIT_DELAYED_WORK(&hub->init_work, NULL);
1820 INIT_WORK(&hub->events, hub_event);
1824 usb_set_intfdata(intf, hub);
1825 intf->needs_remote_wakeup = 1;
1826 pm_suspend_ignore_children(&intf->dev, true);
1828 if (hdev->speed == USB_SPEED_HIGH)
1831 if (id->driver_info & HUB_QUIRK_CHECK_PORT_AUTOSUSPEND)
1832 hub->quirk_check_port_auto_suspend = 1;
1834 if (id->driver_info & HUB_QUIRK_DISABLE_AUTOSUSPEND) {
1835 hub->quirk_disable_autosuspend = 1;
1836 usb_autopm_get_interface_no_resume(intf);
1839 if (hub_configure(hub, &desc->endpoint[0].desc) >= 0)
1842 hub_disconnect(intf);
1847 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1849 struct usb_device *hdev = interface_to_usbdev(intf);
1850 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1852 /* assert ifno == 0 (part of hub spec) */
1854 case USBDEVFS_HUB_PORTINFO: {
1855 struct usbdevfs_hub_portinfo *info = user_data;
1858 spin_lock_irq(&device_state_lock);
1859 if (hdev->devnum <= 0)
1862 info->nports = hdev->maxchild;
1863 for (i = 0; i < info->nports; i++) {
1864 if (hub->ports[i]->child == NULL)
1868 hub->ports[i]->child->devnum;
1871 spin_unlock_irq(&device_state_lock);
1873 return info->nports + 1;
1882 * Allow user programs to claim ports on a hub. When a device is attached
1883 * to one of these "claimed" ports, the program will "own" the device.
1885 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1886 struct usb_dev_state ***ppowner)
1888 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1890 if (hdev->state == USB_STATE_NOTATTACHED)
1892 if (port1 == 0 || port1 > hdev->maxchild)
1895 /* Devices not managed by the hub driver
1896 * will always have maxchild equal to 0.
1898 *ppowner = &(hub->ports[port1 - 1]->port_owner);
1902 /* In the following three functions, the caller must hold hdev's lock */
1903 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
1904 struct usb_dev_state *owner)
1907 struct usb_dev_state **powner;
1909 rc = find_port_owner(hdev, port1, &powner);
1917 EXPORT_SYMBOL_GPL(usb_hub_claim_port);
1919 int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
1920 struct usb_dev_state *owner)
1923 struct usb_dev_state **powner;
1925 rc = find_port_owner(hdev, port1, &powner);
1928 if (*powner != owner)
1933 EXPORT_SYMBOL_GPL(usb_hub_release_port);
1935 void usb_hub_release_all_ports(struct usb_device *hdev, struct usb_dev_state *owner)
1937 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1940 for (n = 0; n < hdev->maxchild; n++) {
1941 if (hub->ports[n]->port_owner == owner)
1942 hub->ports[n]->port_owner = NULL;
1947 /* The caller must hold udev's lock */
1948 bool usb_device_is_owned(struct usb_device *udev)
1950 struct usb_hub *hub;
1952 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1954 hub = usb_hub_to_struct_hub(udev->parent);
1955 return !!hub->ports[udev->portnum - 1]->port_owner;
1958 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1960 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
1963 for (i = 0; i < udev->maxchild; ++i) {
1964 if (hub->ports[i]->child)
1965 recursively_mark_NOTATTACHED(hub->ports[i]->child);
1967 if (udev->state == USB_STATE_SUSPENDED)
1968 udev->active_duration -= jiffies;
1969 udev->state = USB_STATE_NOTATTACHED;
1973 * usb_set_device_state - change a device's current state (usbcore, hcds)
1974 * @udev: pointer to device whose state should be changed
1975 * @new_state: new state value to be stored
1977 * udev->state is _not_ fully protected by the device lock. Although
1978 * most transitions are made only while holding the lock, the state can
1979 * can change to USB_STATE_NOTATTACHED at almost any time. This
1980 * is so that devices can be marked as disconnected as soon as possible,
1981 * without having to wait for any semaphores to be released. As a result,
1982 * all changes to any device's state must be protected by the
1983 * device_state_lock spinlock.
1985 * Once a device has been added to the device tree, all changes to its state
1986 * should be made using this routine. The state should _not_ be set directly.
1988 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1989 * Otherwise udev->state is set to new_state, and if new_state is
1990 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1991 * to USB_STATE_NOTATTACHED.
1993 void usb_set_device_state(struct usb_device *udev,
1994 enum usb_device_state new_state)
1996 unsigned long flags;
1999 spin_lock_irqsave(&device_state_lock, flags);
2000 if (udev->state == USB_STATE_NOTATTACHED)
2002 else if (new_state != USB_STATE_NOTATTACHED) {
2004 /* root hub wakeup capabilities are managed out-of-band
2005 * and may involve silicon errata ... ignore them here.
2008 if (udev->state == USB_STATE_SUSPENDED
2009 || new_state == USB_STATE_SUSPENDED)
2010 ; /* No change to wakeup settings */
2011 else if (new_state == USB_STATE_CONFIGURED)
2012 wakeup = (udev->quirks &
2013 USB_QUIRK_IGNORE_REMOTE_WAKEUP) ? 0 :
2014 udev->actconfig->desc.bmAttributes &
2015 USB_CONFIG_ATT_WAKEUP;
2019 if (udev->state == USB_STATE_SUSPENDED &&
2020 new_state != USB_STATE_SUSPENDED)
2021 udev->active_duration -= jiffies;
2022 else if (new_state == USB_STATE_SUSPENDED &&
2023 udev->state != USB_STATE_SUSPENDED)
2024 udev->active_duration += jiffies;
2025 udev->state = new_state;
2027 recursively_mark_NOTATTACHED(udev);
2028 spin_unlock_irqrestore(&device_state_lock, flags);
2030 device_set_wakeup_capable(&udev->dev, wakeup);
2032 EXPORT_SYMBOL_GPL(usb_set_device_state);
2035 * Choose a device number.
2037 * Device numbers are used as filenames in usbfs. On USB-1.1 and
2038 * USB-2.0 buses they are also used as device addresses, however on
2039 * USB-3.0 buses the address is assigned by the controller hardware
2040 * and it usually is not the same as the device number.
2042 * WUSB devices are simple: they have no hubs behind, so the mapping
2043 * device <-> virtual port number becomes 1:1. Why? to simplify the
2044 * life of the device connection logic in
2045 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
2046 * handshake we need to assign a temporary address in the unauthorized
2047 * space. For simplicity we use the first virtual port number found to
2048 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
2049 * and that becomes it's address [X < 128] or its unauthorized address
2052 * We add 1 as an offset to the one-based USB-stack port number
2053 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
2054 * 0 is reserved by USB for default address; (b) Linux's USB stack
2055 * uses always #1 for the root hub of the controller. So USB stack's
2056 * port #1, which is wusb virtual-port #0 has address #2.
2058 * Devices connected under xHCI are not as simple. The host controller
2059 * supports virtualization, so the hardware assigns device addresses and
2060 * the HCD must setup data structures before issuing a set address
2061 * command to the hardware.
2063 static void choose_devnum(struct usb_device *udev)
2066 struct usb_bus *bus = udev->bus;
2068 /* be safe when more hub events are proceed in parallel */
2069 mutex_lock(&bus->devnum_next_mutex);
2071 devnum = udev->portnum + 1;
2072 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
2074 /* Try to allocate the next devnum beginning at
2075 * bus->devnum_next. */
2076 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
2079 devnum = find_next_zero_bit(bus->devmap.devicemap,
2081 bus->devnum_next = (devnum >= 127 ? 1 : devnum + 1);
2084 set_bit(devnum, bus->devmap.devicemap);
2085 udev->devnum = devnum;
2087 mutex_unlock(&bus->devnum_next_mutex);
2090 static void release_devnum(struct usb_device *udev)
2092 if (udev->devnum > 0) {
2093 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
2098 static void update_devnum(struct usb_device *udev, int devnum)
2100 /* The address for a WUSB device is managed by wusbcore. */
2102 udev->devnum = devnum;
2105 static void hub_free_dev(struct usb_device *udev)
2107 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2109 /* Root hubs aren't real devices, so don't free HCD resources */
2110 if (hcd->driver->free_dev && udev->parent)
2111 hcd->driver->free_dev(hcd, udev);
2114 static void hub_disconnect_children(struct usb_device *udev)
2116 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2119 /* Free up all the children before we remove this device */
2120 for (i = 0; i < udev->maxchild; i++) {
2121 if (hub->ports[i]->child)
2122 usb_disconnect(&hub->ports[i]->child);
2127 * usb_disconnect - disconnect a device (usbcore-internal)
2128 * @pdev: pointer to device being disconnected
2129 * Context: !in_interrupt ()
2131 * Something got disconnected. Get rid of it and all of its children.
2133 * If *pdev is a normal device then the parent hub must already be locked.
2134 * If *pdev is a root hub then the caller must hold the usb_bus_idr_lock,
2135 * which protects the set of root hubs as well as the list of buses.
2137 * Only hub drivers (including virtual root hub drivers for host
2138 * controllers) should ever call this.
2140 * This call is synchronous, and may not be used in an interrupt context.
2142 void usb_disconnect(struct usb_device **pdev)
2144 struct usb_port *port_dev = NULL;
2145 struct usb_device *udev = *pdev;
2146 struct usb_hub *hub = NULL;
2149 /* mark the device as inactive, so any further urb submissions for
2150 * this device (and any of its children) will fail immediately.
2151 * this quiesces everything except pending urbs.
2153 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2154 dev_info(&udev->dev, "USB disconnect, device number %d\n",
2158 * Ensure that the pm runtime code knows that the USB device
2159 * is in the process of being disconnected.
2161 pm_runtime_barrier(&udev->dev);
2163 usb_lock_device(udev);
2165 hub_disconnect_children(udev);
2167 /* deallocate hcd/hardware state ... nuking all pending urbs and
2168 * cleaning up all state associated with the current configuration
2169 * so that the hardware is now fully quiesced.
2171 dev_dbg(&udev->dev, "unregistering device\n");
2172 usb_disable_device(udev, 0);
2173 usb_hcd_synchronize_unlinks(udev);
2176 port1 = udev->portnum;
2177 hub = usb_hub_to_struct_hub(udev->parent);
2178 port_dev = hub->ports[port1 - 1];
2180 sysfs_remove_link(&udev->dev.kobj, "port");
2181 sysfs_remove_link(&port_dev->dev.kobj, "device");
2184 * As usb_port_runtime_resume() de-references udev, make
2185 * sure no resumes occur during removal
2187 if (!test_and_set_bit(port1, hub->child_usage_bits))
2188 pm_runtime_get_sync(&port_dev->dev);
2191 usb_remove_ep_devs(&udev->ep0);
2192 usb_unlock_device(udev);
2194 /* Unregister the device. The device driver is responsible
2195 * for de-configuring the device and invoking the remove-device
2196 * notifier chain (used by usbfs and possibly others).
2198 device_del(&udev->dev);
2200 /* Free the device number and delete the parent's children[]
2201 * (or root_hub) pointer.
2203 release_devnum(udev);
2205 /* Avoid races with recursively_mark_NOTATTACHED() */
2206 spin_lock_irq(&device_state_lock);
2208 spin_unlock_irq(&device_state_lock);
2210 if (port_dev && test_and_clear_bit(port1, hub->child_usage_bits))
2211 pm_runtime_put(&port_dev->dev);
2215 put_device(&udev->dev);
2218 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2219 static void show_string(struct usb_device *udev, char *id, char *string)
2223 dev_info(&udev->dev, "%s: %s\n", id, string);
2226 static void announce_device(struct usb_device *udev)
2228 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2229 le16_to_cpu(udev->descriptor.idVendor),
2230 le16_to_cpu(udev->descriptor.idProduct));
2231 dev_info(&udev->dev,
2232 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2233 udev->descriptor.iManufacturer,
2234 udev->descriptor.iProduct,
2235 udev->descriptor.iSerialNumber);
2236 show_string(udev, "Product", udev->product);
2237 show_string(udev, "Manufacturer", udev->manufacturer);
2238 show_string(udev, "SerialNumber", udev->serial);
2241 static inline void announce_device(struct usb_device *udev) { }
2246 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2247 * @udev: newly addressed device (in ADDRESS state)
2249 * Finish enumeration for On-The-Go devices
2251 * Return: 0 if successful. A negative error code otherwise.
2253 static int usb_enumerate_device_otg(struct usb_device *udev)
2257 #ifdef CONFIG_USB_OTG
2259 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2260 * to wake us after we've powered off VBUS; and HNP, switching roles
2261 * "host" to "peripheral". The OTG descriptor helps figure this out.
2263 if (!udev->bus->is_b_host
2265 && udev->parent == udev->bus->root_hub) {
2266 struct usb_otg_descriptor *desc = NULL;
2267 struct usb_bus *bus = udev->bus;
2268 unsigned port1 = udev->portnum;
2270 /* descriptor may appear anywhere in config */
2271 err = __usb_get_extra_descriptor(udev->rawdescriptors[0],
2272 le16_to_cpu(udev->config[0].desc.wTotalLength),
2273 USB_DT_OTG, (void **) &desc, sizeof(*desc));
2274 if (err || !(desc->bmAttributes & USB_OTG_HNP))
2277 dev_info(&udev->dev, "Dual-Role OTG device on %sHNP port\n",
2278 (port1 == bus->otg_port) ? "" : "non-");
2280 /* enable HNP before suspend, it's simpler */
2281 if (port1 == bus->otg_port) {
2282 bus->b_hnp_enable = 1;
2283 err = usb_control_msg(udev,
2284 usb_sndctrlpipe(udev, 0),
2285 USB_REQ_SET_FEATURE, 0,
2286 USB_DEVICE_B_HNP_ENABLE,
2288 USB_CTRL_SET_TIMEOUT);
2291 * OTG MESSAGE: report errors here,
2292 * customize to match your product.
2294 dev_err(&udev->dev, "can't set HNP mode: %d\n",
2296 bus->b_hnp_enable = 0;
2298 } else if (desc->bLength == sizeof
2299 (struct usb_otg_descriptor)) {
2300 /* Set a_alt_hnp_support for legacy otg device */
2301 err = usb_control_msg(udev,
2302 usb_sndctrlpipe(udev, 0),
2303 USB_REQ_SET_FEATURE, 0,
2304 USB_DEVICE_A_ALT_HNP_SUPPORT,
2306 USB_CTRL_SET_TIMEOUT);
2309 "set a_alt_hnp_support failed: %d\n",
2319 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2320 * @udev: newly addressed device (in ADDRESS state)
2322 * This is only called by usb_new_device() and usb_authorize_device()
2323 * and FIXME -- all comments that apply to them apply here wrt to
2326 * If the device is WUSB and not authorized, we don't attempt to read
2327 * the string descriptors, as they will be errored out by the device
2328 * until it has been authorized.
2330 * Return: 0 if successful. A negative error code otherwise.
2332 static int usb_enumerate_device(struct usb_device *udev)
2335 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2337 if (udev->config == NULL) {
2338 err = usb_get_configuration(udev);
2341 dev_err(&udev->dev, "can't read configurations, error %d\n",
2347 /* read the standard strings and cache them if present */
2348 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
2349 udev->manufacturer = usb_cache_string(udev,
2350 udev->descriptor.iManufacturer);
2351 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
2353 err = usb_enumerate_device_otg(udev);
2357 if (IS_ENABLED(CONFIG_USB_OTG_WHITELIST) && hcd->tpl_support &&
2358 !is_targeted(udev)) {
2359 /* Maybe it can talk to us, though we can't talk to it.
2360 * (Includes HNP test device.)
2362 if (IS_ENABLED(CONFIG_USB_OTG) && (udev->bus->b_hnp_enable
2363 || udev->bus->is_b_host)) {
2364 err = usb_port_suspend(udev, PMSG_AUTO_SUSPEND);
2366 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
2371 usb_detect_interface_quirks(udev);
2376 static void set_usb_port_removable(struct usb_device *udev)
2378 struct usb_device *hdev = udev->parent;
2379 struct usb_hub *hub;
2380 u8 port = udev->portnum;
2381 u16 wHubCharacteristics;
2382 bool removable = true;
2387 hub = usb_hub_to_struct_hub(udev->parent);
2390 * If the platform firmware has provided information about a port,
2391 * use that to determine whether it's removable.
2393 switch (hub->ports[udev->portnum - 1]->connect_type) {
2394 case USB_PORT_CONNECT_TYPE_HOT_PLUG:
2395 udev->removable = USB_DEVICE_REMOVABLE;
2397 case USB_PORT_CONNECT_TYPE_HARD_WIRED:
2398 case USB_PORT_NOT_USED:
2399 udev->removable = USB_DEVICE_FIXED;
2406 * Otherwise, check whether the hub knows whether a port is removable
2409 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2411 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
2414 if (hub_is_superspeed(hdev)) {
2415 if (le16_to_cpu(hub->descriptor->u.ss.DeviceRemovable)
2419 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
2424 udev->removable = USB_DEVICE_REMOVABLE;
2426 udev->removable = USB_DEVICE_FIXED;
2431 * usb_new_device - perform initial device setup (usbcore-internal)
2432 * @udev: newly addressed device (in ADDRESS state)
2434 * This is called with devices which have been detected but not fully
2435 * enumerated. The device descriptor is available, but not descriptors
2436 * for any device configuration. The caller must have locked either
2437 * the parent hub (if udev is a normal device) or else the
2438 * usb_bus_idr_lock (if udev is a root hub). The parent's pointer to
2439 * udev has already been installed, but udev is not yet visible through
2440 * sysfs or other filesystem code.
2442 * This call is synchronous, and may not be used in an interrupt context.
2444 * Only the hub driver or root-hub registrar should ever call this.
2446 * Return: Whether the device is configured properly or not. Zero if the
2447 * interface was registered with the driver core; else a negative errno
2451 int usb_new_device(struct usb_device *udev)
2456 /* Initialize non-root-hub device wakeup to disabled;
2457 * device (un)configuration controls wakeup capable
2458 * sysfs power/wakeup controls wakeup enabled/disabled
2460 device_init_wakeup(&udev->dev, 0);
2463 /* Tell the runtime-PM framework the device is active */
2464 pm_runtime_set_active(&udev->dev);
2465 pm_runtime_get_noresume(&udev->dev);
2466 pm_runtime_use_autosuspend(&udev->dev);
2467 pm_runtime_enable(&udev->dev);
2469 /* By default, forbid autosuspend for all devices. It will be
2470 * allowed for hubs during binding.
2472 usb_disable_autosuspend(udev);
2474 err = usb_enumerate_device(udev); /* Read descriptors */
2477 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
2478 udev->devnum, udev->bus->busnum,
2479 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2480 /* export the usbdev device-node for libusb */
2481 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
2482 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2484 /* Tell the world! */
2485 announce_device(udev);
2488 add_device_randomness(udev->serial, strlen(udev->serial));
2490 add_device_randomness(udev->product, strlen(udev->product));
2491 if (udev->manufacturer)
2492 add_device_randomness(udev->manufacturer,
2493 strlen(udev->manufacturer));
2495 device_enable_async_suspend(&udev->dev);
2497 /* check whether the hub or firmware marks this port as non-removable */
2499 set_usb_port_removable(udev);
2501 /* Register the device. The device driver is responsible
2502 * for configuring the device and invoking the add-device
2503 * notifier chain (used by usbfs and possibly others).
2505 err = device_add(&udev->dev);
2507 dev_err(&udev->dev, "can't device_add, error %d\n", err);
2511 /* Create link files between child device and usb port device. */
2513 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2514 int port1 = udev->portnum;
2515 struct usb_port *port_dev = hub->ports[port1 - 1];
2517 err = sysfs_create_link(&udev->dev.kobj,
2518 &port_dev->dev.kobj, "port");
2522 err = sysfs_create_link(&port_dev->dev.kobj,
2523 &udev->dev.kobj, "device");
2525 sysfs_remove_link(&udev->dev.kobj, "port");
2529 if (!test_and_set_bit(port1, hub->child_usage_bits))
2530 pm_runtime_get_sync(&port_dev->dev);
2533 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
2534 usb_mark_last_busy(udev);
2535 pm_runtime_put_sync_autosuspend(&udev->dev);
2539 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2540 pm_runtime_disable(&udev->dev);
2541 pm_runtime_set_suspended(&udev->dev);
2547 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2548 * @usb_dev: USB device
2550 * Move the USB device to a very basic state where interfaces are disabled
2551 * and the device is in fact unconfigured and unusable.
2553 * We share a lock (that we have) with device_del(), so we need to
2558 int usb_deauthorize_device(struct usb_device *usb_dev)
2560 usb_lock_device(usb_dev);
2561 if (usb_dev->authorized == 0)
2562 goto out_unauthorized;
2564 usb_dev->authorized = 0;
2565 usb_set_configuration(usb_dev, -1);
2568 usb_unlock_device(usb_dev);
2573 int usb_authorize_device(struct usb_device *usb_dev)
2577 usb_lock_device(usb_dev);
2578 if (usb_dev->authorized == 1)
2579 goto out_authorized;
2581 result = usb_autoresume_device(usb_dev);
2583 dev_err(&usb_dev->dev,
2584 "can't autoresume for authorization: %d\n", result);
2585 goto error_autoresume;
2588 if (usb_dev->wusb) {
2589 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2591 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2592 "authorization: %d\n", result);
2593 goto error_device_descriptor;
2597 usb_dev->authorized = 1;
2598 /* Choose and set the configuration. This registers the interfaces
2599 * with the driver core and lets interface drivers bind to them.
2601 c = usb_choose_configuration(usb_dev);
2603 result = usb_set_configuration(usb_dev, c);
2605 dev_err(&usb_dev->dev,
2606 "can't set config #%d, error %d\n", c, result);
2607 /* This need not be fatal. The user can try to
2608 * set other configurations. */
2611 dev_info(&usb_dev->dev, "authorized to connect\n");
2613 error_device_descriptor:
2614 usb_autosuspend_device(usb_dev);
2617 usb_unlock_device(usb_dev); /* complements locktree */
2622 * Return 1 if port speed is SuperSpeedPlus, 0 otherwise
2623 * check it from the link protocol field of the current speed ID attribute.
2624 * current speed ID is got from ext port status request. Sublink speed attribute
2625 * table is returned with the hub BOS SSP device capability descriptor
2627 static int port_speed_is_ssp(struct usb_device *hdev, int speed_id)
2632 struct usb_ssp_cap_descriptor *ssp_cap = hdev->bos->ssp_cap;
2637 ssa_count = le32_to_cpu(ssp_cap->bmAttributes) &
2638 USB_SSP_SUBLINK_SPEED_ATTRIBS;
2640 for (i = 0; i <= ssa_count; i++) {
2641 ss_attr = le32_to_cpu(ssp_cap->bmSublinkSpeedAttr[i]);
2642 if (speed_id == (ss_attr & USB_SSP_SUBLINK_SPEED_SSID))
2643 return !!(ss_attr & USB_SSP_SUBLINK_SPEED_LP);
2648 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2649 static unsigned hub_is_wusb(struct usb_hub *hub)
2651 struct usb_hcd *hcd;
2652 if (hub->hdev->parent != NULL) /* not a root hub? */
2654 hcd = bus_to_hcd(hub->hdev->bus);
2655 return hcd->wireless;
2659 #define PORT_RESET_TRIES 5
2660 #define SET_ADDRESS_TRIES 2
2661 #define GET_DESCRIPTOR_TRIES 2
2662 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2663 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2665 #define HUB_ROOT_RESET_TIME 60 /* times are in msec */
2666 #define HUB_SHORT_RESET_TIME 10
2667 #define HUB_BH_RESET_TIME 50
2668 #define HUB_LONG_RESET_TIME 200
2669 #define HUB_RESET_TIMEOUT 800
2672 * "New scheme" enumeration causes an extra state transition to be
2673 * exposed to an xhci host and causes USB3 devices to receive control
2674 * commands in the default state. This has been seen to cause
2675 * enumeration failures, so disable this enumeration scheme for USB3
2678 static bool use_new_scheme(struct usb_device *udev, int retry)
2680 if (udev->speed >= USB_SPEED_SUPER)
2683 return USE_NEW_SCHEME(retry);
2686 /* Is a USB 3.0 port in the Inactive or Compliance Mode state?
2687 * Port worm reset is required to recover
2689 static bool hub_port_warm_reset_required(struct usb_hub *hub, int port1,
2694 if (!hub_is_superspeed(hub->hdev))
2697 if (test_bit(port1, hub->warm_reset_bits))
2700 link_state = portstatus & USB_PORT_STAT_LINK_STATE;
2701 return link_state == USB_SS_PORT_LS_SS_INACTIVE
2702 || link_state == USB_SS_PORT_LS_COMP_MOD;
2705 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2706 struct usb_device *udev, unsigned int delay, bool warm)
2708 int delay_time, ret;
2711 u32 ext_portstatus = 0;
2713 for (delay_time = 0;
2714 delay_time < HUB_RESET_TIMEOUT;
2715 delay_time += delay) {
2716 /* wait to give the device a chance to reset */
2719 /* read and decode port status */
2720 if (hub_is_superspeedplus(hub->hdev))
2721 ret = hub_ext_port_status(hub, port1,
2722 HUB_EXT_PORT_STATUS,
2723 &portstatus, &portchange,
2726 ret = hub_port_status(hub, port1, &portstatus,
2732 * The port state is unknown until the reset completes.
2734 * On top of that, some chips may require additional time
2735 * to re-establish a connection after the reset is complete,
2736 * so also wait for the connection to be re-established.
2738 if (!(portstatus & USB_PORT_STAT_RESET) &&
2739 (portstatus & USB_PORT_STAT_CONNECTION))
2742 /* switch to the long delay after two short delay failures */
2743 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2744 delay = HUB_LONG_RESET_TIME;
2746 dev_dbg(&hub->ports[port1 - 1]->dev,
2747 "not %sreset yet, waiting %dms\n",
2748 warm ? "warm " : "", delay);
2751 if ((portstatus & USB_PORT_STAT_RESET))
2754 if (hub_port_warm_reset_required(hub, port1, portstatus))
2757 /* Device went away? */
2758 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2761 /* Retry if connect change is set but status is still connected.
2762 * A USB 3.0 connection may bounce if multiple warm resets were issued,
2763 * but the device may have successfully re-connected. Ignore it.
2765 if (!hub_is_superspeed(hub->hdev) &&
2766 (portchange & USB_PORT_STAT_C_CONNECTION)) {
2767 usb_clear_port_feature(hub->hdev, port1,
2768 USB_PORT_FEAT_C_CONNECTION);
2772 if (!(portstatus & USB_PORT_STAT_ENABLE))
2778 if (hub_is_wusb(hub))
2779 udev->speed = USB_SPEED_WIRELESS;
2780 else if (hub_is_superspeedplus(hub->hdev) &&
2781 port_speed_is_ssp(hub->hdev, ext_portstatus &
2782 USB_EXT_PORT_STAT_RX_SPEED_ID))
2783 udev->speed = USB_SPEED_SUPER_PLUS;
2784 else if (hub_is_superspeed(hub->hdev))
2785 udev->speed = USB_SPEED_SUPER;
2786 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2787 udev->speed = USB_SPEED_HIGH;
2788 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2789 udev->speed = USB_SPEED_LOW;
2791 udev->speed = USB_SPEED_FULL;
2795 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2796 static int hub_port_reset(struct usb_hub *hub, int port1,
2797 struct usb_device *udev, unsigned int delay, bool warm)
2800 u16 portchange, portstatus;
2801 struct usb_port *port_dev = hub->ports[port1 - 1];
2803 if (!hub_is_superspeed(hub->hdev)) {
2805 dev_err(hub->intfdev, "only USB3 hub support "
2809 /* Block EHCI CF initialization during the port reset.
2810 * Some companion controllers don't like it when they mix.
2812 down_read(&ehci_cf_port_reset_rwsem);
2815 * If the caller hasn't explicitly requested a warm reset,
2816 * double check and see if one is needed.
2818 if (hub_port_status(hub, port1, &portstatus, &portchange) == 0)
2819 if (hub_port_warm_reset_required(hub, port1,
2823 clear_bit(port1, hub->warm_reset_bits);
2825 /* Reset the port */
2826 for (i = 0; i < PORT_RESET_TRIES; i++) {
2827 status = set_port_feature(hub->hdev, port1, (warm ?
2828 USB_PORT_FEAT_BH_PORT_RESET :
2829 USB_PORT_FEAT_RESET));
2830 if (status == -ENODEV) {
2831 ; /* The hub is gone */
2832 } else if (status) {
2833 dev_err(&port_dev->dev,
2834 "cannot %sreset (err = %d)\n",
2835 warm ? "warm " : "", status);
2837 status = hub_port_wait_reset(hub, port1, udev, delay,
2839 if (status && status != -ENOTCONN && status != -ENODEV)
2840 dev_dbg(hub->intfdev,
2841 "port_wait_reset: err = %d\n",
2845 /* Check for disconnect or reset */
2846 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2847 usb_clear_port_feature(hub->hdev, port1,
2848 USB_PORT_FEAT_C_RESET);
2850 if (!hub_is_superspeed(hub->hdev))
2853 usb_clear_port_feature(hub->hdev, port1,
2854 USB_PORT_FEAT_C_BH_PORT_RESET);
2855 usb_clear_port_feature(hub->hdev, port1,
2856 USB_PORT_FEAT_C_PORT_LINK_STATE);
2859 usb_clear_port_feature(hub->hdev, port1,
2860 USB_PORT_FEAT_C_CONNECTION);
2863 * If a USB 3.0 device migrates from reset to an error
2864 * state, re-issue the warm reset.
2866 if (hub_port_status(hub, port1,
2867 &portstatus, &portchange) < 0)
2870 if (!hub_port_warm_reset_required(hub, port1,
2875 * If the port is in SS.Inactive or Compliance Mode, the
2876 * hot or warm reset failed. Try another warm reset.
2879 dev_dbg(&port_dev->dev,
2880 "hot reset failed, warm reset\n");
2885 dev_dbg(&port_dev->dev,
2886 "not enabled, trying %sreset again...\n",
2887 warm ? "warm " : "");
2888 delay = HUB_LONG_RESET_TIME;
2891 dev_err(&port_dev->dev, "Cannot enable. Maybe the USB cable is bad?\n");
2895 /* TRSTRCY = 10 ms; plus some extra */
2898 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2900 update_devnum(udev, 0);
2901 /* The xHC may think the device is already reset,
2902 * so ignore the status.
2904 if (hcd->driver->reset_device)
2905 hcd->driver->reset_device(hcd, udev);
2907 usb_set_device_state(udev, USB_STATE_DEFAULT);
2911 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2914 if (!hub_is_superspeed(hub->hdev))
2915 up_read(&ehci_cf_port_reset_rwsem);
2920 /* Check if a port is power on */
2921 static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2925 if (hub_is_superspeed(hub->hdev)) {
2926 if (portstatus & USB_SS_PORT_STAT_POWER)
2929 if (portstatus & USB_PORT_STAT_POWER)
2936 static void usb_lock_port(struct usb_port *port_dev)
2937 __acquires(&port_dev->status_lock)
2939 mutex_lock(&port_dev->status_lock);
2940 __acquire(&port_dev->status_lock);
2943 static void usb_unlock_port(struct usb_port *port_dev)
2944 __releases(&port_dev->status_lock)
2946 mutex_unlock(&port_dev->status_lock);
2947 __release(&port_dev->status_lock);
2952 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2953 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
2957 if (hub_is_superspeed(hub->hdev)) {
2958 if ((portstatus & USB_PORT_STAT_LINK_STATE)
2959 == USB_SS_PORT_LS_U3)
2962 if (portstatus & USB_PORT_STAT_SUSPEND)
2969 /* Determine whether the device on a port is ready for a normal resume,
2970 * is ready for a reset-resume, or should be disconnected.
2972 static int check_port_resume_type(struct usb_device *udev,
2973 struct usb_hub *hub, int port1,
2974 int status, u16 portchange, u16 portstatus)
2976 struct usb_port *port_dev = hub->ports[port1 - 1];
2980 /* Is a warm reset needed to recover the connection? */
2981 if (status == 0 && udev->reset_resume
2982 && hub_port_warm_reset_required(hub, port1, portstatus)) {
2985 /* Is the device still present? */
2986 else if (status || port_is_suspended(hub, portstatus) ||
2987 !port_is_power_on(hub, portstatus)) {
2990 } else if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
2992 usleep_range(200, 300);
2993 status = hub_port_status(hub, port1, &portstatus,
3000 /* Can't do a normal resume if the port isn't enabled,
3001 * so try a reset-resume instead.
3003 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
3004 if (udev->persist_enabled)
3005 udev->reset_resume = 1;
3011 dev_dbg(&port_dev->dev, "status %04x.%04x after resume, %d\n",
3012 portchange, portstatus, status);
3013 } else if (udev->reset_resume) {
3015 /* Late port handoff can set status-change bits */
3016 if (portchange & USB_PORT_STAT_C_CONNECTION)
3017 usb_clear_port_feature(hub->hdev, port1,
3018 USB_PORT_FEAT_C_CONNECTION);
3019 if (portchange & USB_PORT_STAT_C_ENABLE)
3020 usb_clear_port_feature(hub->hdev, port1,
3021 USB_PORT_FEAT_C_ENABLE);
3024 * Whatever made this reset-resume necessary may have
3025 * turned on the port1 bit in hub->change_bits. But after
3026 * a successful reset-resume we want the bit to be clear;
3027 * if it was on it would indicate that something happened
3028 * following the reset-resume.
3030 clear_bit(port1, hub->change_bits);
3036 int usb_disable_ltm(struct usb_device *udev)
3038 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3040 /* Check if the roothub and device supports LTM. */
3041 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
3042 !usb_device_supports_ltm(udev))
3045 /* Clear Feature LTM Enable can only be sent if the device is
3048 if (!udev->actconfig)
3051 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3052 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
3053 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
3054 USB_CTRL_SET_TIMEOUT);
3056 EXPORT_SYMBOL_GPL(usb_disable_ltm);
3058 void usb_enable_ltm(struct usb_device *udev)
3060 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3062 /* Check if the roothub and device supports LTM. */
3063 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
3064 !usb_device_supports_ltm(udev))
3067 /* Set Feature LTM Enable can only be sent if the device is
3070 if (!udev->actconfig)
3073 usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3074 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
3075 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
3076 USB_CTRL_SET_TIMEOUT);
3078 EXPORT_SYMBOL_GPL(usb_enable_ltm);
3081 * usb_enable_remote_wakeup - enable remote wakeup for a device
3082 * @udev: target device
3084 * For USB-2 devices: Set the device's remote wakeup feature.
3086 * For USB-3 devices: Assume there's only one function on the device and
3087 * enable remote wake for the first interface. FIXME if the interface
3088 * association descriptor shows there's more than one function.
3090 static int usb_enable_remote_wakeup(struct usb_device *udev)
3092 if (udev->speed < USB_SPEED_SUPER)
3093 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3094 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
3095 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
3096 USB_CTRL_SET_TIMEOUT);
3098 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3099 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
3100 USB_INTRF_FUNC_SUSPEND,
3101 USB_INTRF_FUNC_SUSPEND_RW |
3102 USB_INTRF_FUNC_SUSPEND_LP,
3103 NULL, 0, USB_CTRL_SET_TIMEOUT);
3107 * usb_disable_remote_wakeup - disable remote wakeup for a device
3108 * @udev: target device
3110 * For USB-2 devices: Clear the device's remote wakeup feature.
3112 * For USB-3 devices: Assume there's only one function on the device and
3113 * disable remote wake for the first interface. FIXME if the interface
3114 * association descriptor shows there's more than one function.
3116 static int usb_disable_remote_wakeup(struct usb_device *udev)
3118 if (udev->speed < USB_SPEED_SUPER)
3119 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3120 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
3121 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
3122 USB_CTRL_SET_TIMEOUT);
3124 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3125 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
3126 USB_INTRF_FUNC_SUSPEND, 0, NULL, 0,
3127 USB_CTRL_SET_TIMEOUT);
3130 /* Count of wakeup-enabled devices at or below udev */
3131 static unsigned wakeup_enabled_descendants(struct usb_device *udev)
3133 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
3135 return udev->do_remote_wakeup +
3136 (hub ? hub->wakeup_enabled_descendants : 0);
3140 * usb_port_suspend - suspend a usb device's upstream port
3141 * @udev: device that's no longer in active use, not a root hub
3142 * Context: must be able to sleep; device not locked; pm locks held
3144 * Suspends a USB device that isn't in active use, conserving power.
3145 * Devices may wake out of a suspend, if anything important happens,
3146 * using the remote wakeup mechanism. They may also be taken out of
3147 * suspend by the host, using usb_port_resume(). It's also routine
3148 * to disconnect devices while they are suspended.
3150 * This only affects the USB hardware for a device; its interfaces
3151 * (and, for hubs, child devices) must already have been suspended.
3153 * Selective port suspend reduces power; most suspended devices draw
3154 * less than 500 uA. It's also used in OTG, along with remote wakeup.
3155 * All devices below the suspended port are also suspended.
3157 * Devices leave suspend state when the host wakes them up. Some devices
3158 * also support "remote wakeup", where the device can activate the USB
3159 * tree above them to deliver data, such as a keypress or packet. In
3160 * some cases, this wakes the USB host.
3162 * Suspending OTG devices may trigger HNP, if that's been enabled
3163 * between a pair of dual-role devices. That will change roles, such
3164 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
3166 * Devices on USB hub ports have only one "suspend" state, corresponding
3167 * to ACPI D2, "may cause the device to lose some context".
3168 * State transitions include:
3170 * - suspend, resume ... when the VBUS power link stays live
3171 * - suspend, disconnect ... VBUS lost
3173 * Once VBUS drop breaks the circuit, the port it's using has to go through
3174 * normal re-enumeration procedures, starting with enabling VBUS power.
3175 * Other than re-initializing the hub (plug/unplug, except for root hubs),
3176 * Linux (2.6) currently has NO mechanisms to initiate that: no hub_wq
3177 * timer, no SRP, no requests through sysfs.
3179 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
3180 * suspended until their bus goes into global suspend (i.e., the root
3181 * hub is suspended). Nevertheless, we change @udev->state to
3182 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
3183 * upstream port setting is stored in @udev->port_is_suspended.
3185 * Returns 0 on success, else negative errno.
3187 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
3189 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3190 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3191 int port1 = udev->portnum;
3193 bool really_suspend = true;
3195 usb_lock_port(port_dev);
3197 /* enable remote wakeup when appropriate; this lets the device
3198 * wake up the upstream hub (including maybe the root hub).
3200 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
3201 * we don't explicitly enable it here.
3203 if (udev->do_remote_wakeup) {
3204 status = usb_enable_remote_wakeup(udev);
3206 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
3208 /* bail if autosuspend is requested */
3209 if (PMSG_IS_AUTO(msg))
3214 /* disable USB2 hardware LPM */
3215 usb_disable_usb2_hardware_lpm(udev);
3217 if (usb_disable_ltm(udev)) {
3218 dev_err(&udev->dev, "Failed to disable LTM before suspend\n.");
3220 if (PMSG_IS_AUTO(msg))
3225 if (hub_is_superspeed(hub->hdev))
3226 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U3);
3229 * For system suspend, we do not need to enable the suspend feature
3230 * on individual USB-2 ports. The devices will automatically go
3231 * into suspend a few ms after the root hub stops sending packets.
3232 * The USB 2.0 spec calls this "global suspend".
3234 * However, many USB hubs have a bug: They don't relay wakeup requests
3235 * from a downstream port if the port's suspend feature isn't on.
3236 * Therefore we will turn on the suspend feature if udev or any of its
3237 * descendants is enabled for remote wakeup.
3239 else if (PMSG_IS_AUTO(msg) || wakeup_enabled_descendants(udev) > 0)
3240 status = set_port_feature(hub->hdev, port1,
3241 USB_PORT_FEAT_SUSPEND);
3243 really_suspend = false;
3247 dev_dbg(&port_dev->dev, "can't suspend, status %d\n", status);
3249 /* Try to enable USB3 LTM again */
3250 usb_enable_ltm(udev);
3252 /* Try to enable USB2 hardware LPM again */
3253 usb_enable_usb2_hardware_lpm(udev);
3255 if (udev->do_remote_wakeup)
3256 (void) usb_disable_remote_wakeup(udev);
3259 /* System sleep transitions should never fail */
3260 if (!PMSG_IS_AUTO(msg))
3263 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
3264 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
3265 udev->do_remote_wakeup);
3266 if (really_suspend) {
3267 udev->port_is_suspended = 1;
3269 /* device has up to 10 msec to fully suspend */
3272 usb_set_device_state(udev, USB_STATE_SUSPENDED);
3275 if (status == 0 && !udev->do_remote_wakeup && udev->persist_enabled
3276 && test_and_clear_bit(port1, hub->child_usage_bits))
3277 pm_runtime_put_sync(&port_dev->dev);
3279 usb_mark_last_busy(hub->hdev);
3281 usb_unlock_port(port_dev);
3286 * If the USB "suspend" state is in use (rather than "global suspend"),
3287 * many devices will be individually taken out of suspend state using
3288 * special "resume" signaling. This routine kicks in shortly after
3289 * hardware resume signaling is finished, either because of selective
3290 * resume (by host) or remote wakeup (by device) ... now see what changed
3291 * in the tree that's rooted at this device.
3293 * If @udev->reset_resume is set then the device is reset before the
3294 * status check is done.
3296 static int finish_port_resume(struct usb_device *udev)
3301 /* caller owns the udev device lock */
3302 dev_dbg(&udev->dev, "%s\n",
3303 udev->reset_resume ? "finish reset-resume" : "finish resume");
3305 /* usb ch9 identifies four variants of SUSPENDED, based on what
3306 * state the device resumes to. Linux currently won't see the
3307 * first two on the host side; they'd be inside hub_port_init()
3308 * during many timeouts, but hub_wq can't suspend until later.
3310 usb_set_device_state(udev, udev->actconfig
3311 ? USB_STATE_CONFIGURED
3312 : USB_STATE_ADDRESS);
3314 /* 10.5.4.5 says not to reset a suspended port if the attached
3315 * device is enabled for remote wakeup. Hence the reset
3316 * operation is carried out here, after the port has been
3319 if (udev->reset_resume) {
3321 * If the device morphs or switches modes when it is reset,
3322 * we don't want to perform a reset-resume. We'll fail the
3323 * resume, which will cause a logical disconnect, and then
3324 * the device will be rediscovered.
3327 if (udev->quirks & USB_QUIRK_RESET)
3330 status = usb_reset_and_verify_device(udev);
3333 /* 10.5.4.5 says be sure devices in the tree are still there.
3334 * For now let's assume the device didn't go crazy on resume,
3335 * and device drivers will know about any resume quirks.
3339 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
3341 /* If a normal resume failed, try doing a reset-resume */
3342 if (status && !udev->reset_resume && udev->persist_enabled) {
3343 dev_dbg(&udev->dev, "retry with reset-resume\n");
3344 udev->reset_resume = 1;
3345 goto retry_reset_resume;
3350 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
3353 * There are a few quirky devices which violate the standard
3354 * by claiming to have remote wakeup enabled after a reset,
3355 * which crash if the feature is cleared, hence check for
3356 * udev->reset_resume
3358 } else if (udev->actconfig && !udev->reset_resume) {
3359 if (udev->speed < USB_SPEED_SUPER) {
3360 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
3361 status = usb_disable_remote_wakeup(udev);
3363 status = usb_get_status(udev, USB_RECIP_INTERFACE, 0,
3365 if (!status && devstatus & (USB_INTRF_STAT_FUNC_RW_CAP
3366 | USB_INTRF_STAT_FUNC_RW))
3367 status = usb_disable_remote_wakeup(udev);
3372 "disable remote wakeup, status %d\n",
3380 * There are some SS USB devices which take longer time for link training.
3381 * XHCI specs 4.19.4 says that when Link training is successful, port
3382 * sets CCS bit to 1. So if SW reads port status before successful link
3383 * training, then it will not find device to be present.
3384 * USB Analyzer log with such buggy devices show that in some cases
3385 * device switch on the RX termination after long delay of host enabling
3386 * the VBUS. In few other cases it has been seen that device fails to
3387 * negotiate link training in first attempt. It has been
3388 * reported till now that few devices take as long as 2000 ms to train
3389 * the link after host enabling its VBUS and termination. Following
3390 * routine implements a 2000 ms timeout for link training. If in a case
3391 * link trains before timeout, loop will exit earlier.
3393 * There are also some 2.0 hard drive based devices and 3.0 thumb
3394 * drives that, when plugged into a 2.0 only port, take a long
3395 * time to set CCS after VBUS enable.
3397 * FIXME: If a device was connected before suspend, but was removed
3398 * while system was asleep, then the loop in the following routine will
3399 * only exit at timeout.
3401 * This routine should only be called when persist is enabled.
3403 static int wait_for_connected(struct usb_device *udev,
3404 struct usb_hub *hub, int *port1,
3405 u16 *portchange, u16 *portstatus)
3407 int status = 0, delay_ms = 0;
3409 while (delay_ms < 2000) {
3410 if (status || *portstatus & USB_PORT_STAT_CONNECTION)
3412 if (!port_is_power_on(hub, *portstatus)) {
3418 status = hub_port_status(hub, *port1, portstatus, portchange);
3420 dev_dbg(&udev->dev, "Waited %dms for CONNECT\n", delay_ms);
3425 * usb_port_resume - re-activate a suspended usb device's upstream port
3426 * @udev: device to re-activate, not a root hub
3427 * Context: must be able to sleep; device not locked; pm locks held
3429 * This will re-activate the suspended device, increasing power usage
3430 * while letting drivers communicate again with its endpoints.
3431 * USB resume explicitly guarantees that the power session between
3432 * the host and the device is the same as it was when the device
3435 * If @udev->reset_resume is set then this routine won't check that the
3436 * port is still enabled. Furthermore, finish_port_resume() above will
3437 * reset @udev. The end result is that a broken power session can be
3438 * recovered and @udev will appear to persist across a loss of VBUS power.
3440 * For example, if a host controller doesn't maintain VBUS suspend current
3441 * during a system sleep or is reset when the system wakes up, all the USB
3442 * power sessions below it will be broken. This is especially troublesome
3443 * for mass-storage devices containing mounted filesystems, since the
3444 * device will appear to have disconnected and all the memory mappings
3445 * to it will be lost. Using the USB_PERSIST facility, the device can be
3446 * made to appear as if it had not disconnected.
3448 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3449 * every effort to insure that the same device is present after the
3450 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3451 * quite possible for a device to remain unaltered but its media to be
3452 * changed. If the user replaces a flash memory card while the system is
3453 * asleep, he will have only himself to blame when the filesystem on the
3454 * new card is corrupted and the system crashes.
3456 * Returns 0 on success, else negative errno.
3458 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
3460 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3461 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3462 int port1 = udev->portnum;
3464 u16 portchange, portstatus;
3466 if (!test_and_set_bit(port1, hub->child_usage_bits)) {
3467 status = pm_runtime_get_sync(&port_dev->dev);
3469 dev_dbg(&udev->dev, "can't resume usb port, status %d\n",
3475 usb_lock_port(port_dev);
3477 /* Skip the initial Clear-Suspend step for a remote wakeup */
3478 status = hub_port_status(hub, port1, &portstatus, &portchange);
3479 if (status == 0 && !port_is_suspended(hub, portstatus)) {
3480 if (portchange & USB_PORT_STAT_C_SUSPEND)
3481 pm_wakeup_event(&udev->dev, 0);
3482 goto SuspendCleared;
3485 /* see 7.1.7.7; affects power usage, but not budgeting */
3486 if (hub_is_superspeed(hub->hdev))
3487 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U0);
3489 status = usb_clear_port_feature(hub->hdev,
3490 port1, USB_PORT_FEAT_SUSPEND);
3492 dev_dbg(&port_dev->dev, "can't resume, status %d\n", status);
3494 /* drive resume for USB_RESUME_TIMEOUT msec */
3495 dev_dbg(&udev->dev, "usb %sresume\n",
3496 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
3497 msleep(USB_RESUME_TIMEOUT);
3499 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3500 * stop resume signaling. Then finish the resume
3503 status = hub_port_status(hub, port1, &portstatus, &portchange);
3508 udev->port_is_suspended = 0;
3509 if (hub_is_superspeed(hub->hdev)) {
3510 if (portchange & USB_PORT_STAT_C_LINK_STATE)
3511 usb_clear_port_feature(hub->hdev, port1,
3512 USB_PORT_FEAT_C_PORT_LINK_STATE);
3514 if (portchange & USB_PORT_STAT_C_SUSPEND)
3515 usb_clear_port_feature(hub->hdev, port1,
3516 USB_PORT_FEAT_C_SUSPEND);
3519 /* TRSMRCY = 10 msec */
3523 if (udev->persist_enabled)
3524 status = wait_for_connected(udev, hub, &port1, &portchange,
3527 status = check_port_resume_type(udev,
3528 hub, port1, status, portchange, portstatus);
3530 status = finish_port_resume(udev);
3532 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
3533 hub_port_logical_disconnect(hub, port1);
3535 /* Try to enable USB2 hardware LPM */
3536 usb_enable_usb2_hardware_lpm(udev);
3538 /* Try to enable USB3 LTM */
3539 usb_enable_ltm(udev);
3542 usb_unlock_port(port_dev);
3547 int usb_remote_wakeup(struct usb_device *udev)
3551 usb_lock_device(udev);
3552 if (udev->state == USB_STATE_SUSPENDED) {
3553 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
3554 status = usb_autoresume_device(udev);
3556 /* Let the drivers do their thing, then... */
3557 usb_autosuspend_device(udev);
3560 usb_unlock_device(udev);
3564 /* Returns 1 if there was a remote wakeup and a connect status change. */
3565 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
3566 u16 portstatus, u16 portchange)
3567 __must_hold(&port_dev->status_lock)
3569 struct usb_port *port_dev = hub->ports[port - 1];
3570 struct usb_device *hdev;
3571 struct usb_device *udev;
3572 int connect_change = 0;
3577 udev = port_dev->child;
3578 if (!hub_is_superspeed(hdev)) {
3579 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
3581 usb_clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
3583 link_state = portstatus & USB_PORT_STAT_LINK_STATE;
3584 if (!udev || udev->state != USB_STATE_SUSPENDED ||
3585 (link_state != USB_SS_PORT_LS_U0 &&
3586 link_state != USB_SS_PORT_LS_U1 &&
3587 link_state != USB_SS_PORT_LS_U2))
3592 /* TRSMRCY = 10 msec */
3595 usb_unlock_port(port_dev);
3596 ret = usb_remote_wakeup(udev);
3597 usb_lock_port(port_dev);
3602 hub_port_disable(hub, port, 1);
3604 dev_dbg(&port_dev->dev, "resume, status %d\n", ret);
3605 return connect_change;
3608 static int check_ports_changed(struct usb_hub *hub)
3612 for (port1 = 1; port1 <= hub->hdev->maxchild; ++port1) {
3613 u16 portstatus, portchange;
3616 status = hub_port_status(hub, port1, &portstatus, &portchange);
3617 if (!status && portchange)
3623 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
3625 struct usb_hub *hub = usb_get_intfdata(intf);
3626 struct usb_device *hdev = hub->hdev;
3631 * Warn if children aren't already suspended.
3632 * Also, add up the number of wakeup-enabled descendants.
3634 hub->wakeup_enabled_descendants = 0;
3635 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3636 struct usb_port *port_dev = hub->ports[port1 - 1];
3637 struct usb_device *udev = port_dev->child;
3639 if (udev && udev->can_submit) {
3640 dev_warn(&port_dev->dev, "device %s not suspended yet\n",
3641 dev_name(&udev->dev));
3642 if (PMSG_IS_AUTO(msg))
3646 hub->wakeup_enabled_descendants +=
3647 wakeup_enabled_descendants(udev);
3650 if (hdev->do_remote_wakeup && hub->quirk_check_port_auto_suspend) {
3651 /* check if there are changes pending on hub ports */
3652 if (check_ports_changed(hub)) {
3653 if (PMSG_IS_AUTO(msg))
3655 pm_wakeup_event(&hdev->dev, 2000);
3659 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
3660 /* Enable hub to send remote wakeup for all ports. */
3661 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3662 status = set_port_feature(hdev,
3664 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
3665 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
3666 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
3667 USB_PORT_FEAT_REMOTE_WAKE_MASK);
3671 dev_dbg(&intf->dev, "%s\n", __func__);
3673 /* stop hub_wq and related activity */
3674 hub_quiesce(hub, HUB_SUSPEND);
3678 static int hub_resume(struct usb_interface *intf)
3680 struct usb_hub *hub = usb_get_intfdata(intf);
3682 dev_dbg(&intf->dev, "%s\n", __func__);
3683 hub_activate(hub, HUB_RESUME);
3687 static int hub_reset_resume(struct usb_interface *intf)
3689 struct usb_hub *hub = usb_get_intfdata(intf);
3691 dev_dbg(&intf->dev, "%s\n", __func__);
3692 hub_activate(hub, HUB_RESET_RESUME);
3697 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3698 * @rhdev: struct usb_device for the root hub
3700 * The USB host controller driver calls this function when its root hub
3701 * is resumed and Vbus power has been interrupted or the controller
3702 * has been reset. The routine marks @rhdev as having lost power.
3703 * When the hub driver is resumed it will take notice and carry out
3704 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3705 * the others will be disconnected.
3707 void usb_root_hub_lost_power(struct usb_device *rhdev)
3709 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
3710 rhdev->reset_resume = 1;
3712 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
3714 static const char * const usb3_lpm_names[] = {
3722 * Send a Set SEL control transfer to the device, prior to enabling
3723 * device-initiated U1 or U2. This lets the device know the exit latencies from
3724 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3725 * packet from the host.
3727 * This function will fail if the SEL or PEL values for udev are greater than
3728 * the maximum allowed values for the link state to be enabled.
3730 static int usb_req_set_sel(struct usb_device *udev, enum usb3_link_state state)
3732 struct usb_set_sel_req *sel_values;
3733 unsigned long long u1_sel;
3734 unsigned long long u1_pel;
3735 unsigned long long u2_sel;
3736 unsigned long long u2_pel;
3739 if (udev->state != USB_STATE_CONFIGURED)
3742 /* Convert SEL and PEL stored in ns to us */
3743 u1_sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
3744 u1_pel = DIV_ROUND_UP(udev->u1_params.pel, 1000);
3745 u2_sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
3746 u2_pel = DIV_ROUND_UP(udev->u2_params.pel, 1000);
3749 * Make sure that the calculated SEL and PEL values for the link
3750 * state we're enabling aren't bigger than the max SEL/PEL
3751 * value that will fit in the SET SEL control transfer.
3752 * Otherwise the device would get an incorrect idea of the exit
3753 * latency for the link state, and could start a device-initiated
3754 * U1/U2 when the exit latencies are too high.
3756 if ((state == USB3_LPM_U1 &&
3757 (u1_sel > USB3_LPM_MAX_U1_SEL_PEL ||
3758 u1_pel > USB3_LPM_MAX_U1_SEL_PEL)) ||
3759 (state == USB3_LPM_U2 &&
3760 (u2_sel > USB3_LPM_MAX_U2_SEL_PEL ||
3761 u2_pel > USB3_LPM_MAX_U2_SEL_PEL))) {
3762 dev_dbg(&udev->dev, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3763 usb3_lpm_names[state], u1_sel, u1_pel);
3768 * If we're enabling device-initiated LPM for one link state,
3769 * but the other link state has a too high SEL or PEL value,
3770 * just set those values to the max in the Set SEL request.
3772 if (u1_sel > USB3_LPM_MAX_U1_SEL_PEL)
3773 u1_sel = USB3_LPM_MAX_U1_SEL_PEL;
3775 if (u1_pel > USB3_LPM_MAX_U1_SEL_PEL)
3776 u1_pel = USB3_LPM_MAX_U1_SEL_PEL;
3778 if (u2_sel > USB3_LPM_MAX_U2_SEL_PEL)
3779 u2_sel = USB3_LPM_MAX_U2_SEL_PEL;
3781 if (u2_pel > USB3_LPM_MAX_U2_SEL_PEL)
3782 u2_pel = USB3_LPM_MAX_U2_SEL_PEL;
3785 * usb_enable_lpm() can be called as part of a failed device reset,
3786 * which may be initiated by an error path of a mass storage driver.
3787 * Therefore, use GFP_NOIO.
3789 sel_values = kmalloc(sizeof *(sel_values), GFP_NOIO);
3793 sel_values->u1_sel = u1_sel;
3794 sel_values->u1_pel = u1_pel;
3795 sel_values->u2_sel = cpu_to_le16(u2_sel);
3796 sel_values->u2_pel = cpu_to_le16(u2_pel);
3798 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3802 sel_values, sizeof *(sel_values),
3803 USB_CTRL_SET_TIMEOUT);
3809 * Enable or disable device-initiated U1 or U2 transitions.
3811 static int usb_set_device_initiated_lpm(struct usb_device *udev,
3812 enum usb3_link_state state, bool enable)
3819 feature = USB_DEVICE_U1_ENABLE;
3822 feature = USB_DEVICE_U2_ENABLE;
3825 dev_warn(&udev->dev, "%s: Can't %s non-U1 or U2 state.\n",
3826 __func__, enable ? "enable" : "disable");
3830 if (udev->state != USB_STATE_CONFIGURED) {
3831 dev_dbg(&udev->dev, "%s: Can't %s %s state "
3832 "for unconfigured device.\n",
3833 __func__, enable ? "enable" : "disable",
3834 usb3_lpm_names[state]);
3840 * Now send the control transfer to enable device-initiated LPM
3841 * for either U1 or U2.
3843 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3844 USB_REQ_SET_FEATURE,
3848 USB_CTRL_SET_TIMEOUT);
3850 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3851 USB_REQ_CLEAR_FEATURE,
3855 USB_CTRL_SET_TIMEOUT);
3858 dev_warn(&udev->dev, "%s of device-initiated %s failed.\n",
3859 enable ? "Enable" : "Disable",
3860 usb3_lpm_names[state]);
3866 static int usb_set_lpm_timeout(struct usb_device *udev,
3867 enum usb3_link_state state, int timeout)
3874 feature = USB_PORT_FEAT_U1_TIMEOUT;
3877 feature = USB_PORT_FEAT_U2_TIMEOUT;
3880 dev_warn(&udev->dev, "%s: Can't set timeout for non-U1 or U2 state.\n",
3885 if (state == USB3_LPM_U1 && timeout > USB3_LPM_U1_MAX_TIMEOUT &&
3886 timeout != USB3_LPM_DEVICE_INITIATED) {
3887 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x, "
3888 "which is a reserved value.\n",
3889 usb3_lpm_names[state], timeout);
3893 ret = set_port_feature(udev->parent,
3894 USB_PORT_LPM_TIMEOUT(timeout) | udev->portnum,
3897 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x,"
3898 "error code %i\n", usb3_lpm_names[state],
3902 if (state == USB3_LPM_U1)
3903 udev->u1_params.timeout = timeout;
3905 udev->u2_params.timeout = timeout;
3910 * Don't allow device intiated U1/U2 if the system exit latency + one bus
3911 * interval is greater than the minimum service interval of any active
3912 * periodic endpoint. See USB 3.2 section 9.4.9
3914 static bool usb_device_may_initiate_lpm(struct usb_device *udev,
3915 enum usb3_link_state state)
3917 unsigned int sel; /* us */
3920 if (state == USB3_LPM_U1)
3921 sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
3922 else if (state == USB3_LPM_U2)
3923 sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
3927 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
3928 struct usb_interface *intf;
3929 struct usb_endpoint_descriptor *desc;
3930 unsigned int interval;
3932 intf = udev->actconfig->interface[i];
3936 for (j = 0; j < intf->cur_altsetting->desc.bNumEndpoints; j++) {
3937 desc = &intf->cur_altsetting->endpoint[j].desc;
3939 if (usb_endpoint_xfer_int(desc) ||
3940 usb_endpoint_xfer_isoc(desc)) {
3941 interval = (1 << (desc->bInterval - 1)) * 125;
3942 if (sel + 125 > interval)
3951 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3954 * We will attempt to enable U1 or U2, but there are no guarantees that the
3955 * control transfers to set the hub timeout or enable device-initiated U1/U2
3956 * will be successful.
3958 * If the control transfer to enable device-initiated U1/U2 entry fails, then
3959 * hub-initiated U1/U2 will be disabled.
3961 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3962 * driver know about it. If that call fails, it should be harmless, and just
3963 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3965 static void usb_enable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3966 enum usb3_link_state state)
3969 __u8 u1_mel = udev->bos->ss_cap->bU1devExitLat;
3970 __le16 u2_mel = udev->bos->ss_cap->bU2DevExitLat;
3972 /* If the device says it doesn't have *any* exit latency to come out of
3973 * U1 or U2, it's probably lying. Assume it doesn't implement that link
3976 if ((state == USB3_LPM_U1 && u1_mel == 0) ||
3977 (state == USB3_LPM_U2 && u2_mel == 0))
3981 * First, let the device know about the exit latencies
3982 * associated with the link state we're about to enable.
3984 ret = usb_req_set_sel(udev, state);
3986 dev_warn(&udev->dev, "Set SEL for device-initiated %s failed.\n",
3987 usb3_lpm_names[state]);
3991 /* We allow the host controller to set the U1/U2 timeout internally
3992 * first, so that it can change its schedule to account for the
3993 * additional latency to send data to a device in a lower power
3996 timeout = hcd->driver->enable_usb3_lpm_timeout(hcd, udev, state);
3998 /* xHCI host controller doesn't want to enable this LPM state. */
4003 dev_warn(&udev->dev, "Could not enable %s link state, "
4004 "xHCI error %i.\n", usb3_lpm_names[state],
4009 if (usb_set_lpm_timeout(udev, state, timeout)) {
4010 /* If we can't set the parent hub U1/U2 timeout,
4011 * device-initiated LPM won't be allowed either, so let the xHCI
4012 * host know that this link state won't be enabled.
4014 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
4018 /* Only a configured device will accept the Set Feature
4021 if (udev->actconfig &&
4022 usb_device_may_initiate_lpm(udev, state)) {
4023 if (usb_set_device_initiated_lpm(udev, state, true)) {
4025 * Request to enable device initiated U1/U2 failed,
4026 * better to turn off lpm in this case.
4028 usb_set_lpm_timeout(udev, state, 0);
4029 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
4034 if (state == USB3_LPM_U1)
4035 udev->usb3_lpm_u1_enabled = 1;
4036 else if (state == USB3_LPM_U2)
4037 udev->usb3_lpm_u2_enabled = 1;
4040 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
4043 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
4044 * If zero is returned, the parent will not allow the link to go into U1/U2.
4046 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
4047 * it won't have an effect on the bus link state because the parent hub will
4048 * still disallow device-initiated U1/U2 entry.
4050 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
4051 * possible. The result will be slightly more bus bandwidth will be taken up
4052 * (to account for U1/U2 exit latency), but it should be harmless.
4054 static int usb_disable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
4055 enum usb3_link_state state)
4062 dev_warn(&udev->dev, "%s: Can't disable non-U1 or U2 state.\n",
4067 if (usb_set_lpm_timeout(udev, state, 0))
4070 usb_set_device_initiated_lpm(udev, state, false);
4072 if (hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state))
4073 dev_warn(&udev->dev, "Could not disable xHCI %s timeout, "
4074 "bus schedule bandwidth may be impacted.\n",
4075 usb3_lpm_names[state]);
4077 /* As soon as usb_set_lpm_timeout(0) return 0, hub initiated LPM
4078 * is disabled. Hub will disallows link to enter U1/U2 as well,
4079 * even device is initiating LPM. Hence LPM is disabled if hub LPM
4080 * timeout set to 0, no matter device-initiated LPM is disabled or
4083 if (state == USB3_LPM_U1)
4084 udev->usb3_lpm_u1_enabled = 0;
4085 else if (state == USB3_LPM_U2)
4086 udev->usb3_lpm_u2_enabled = 0;
4092 * Disable hub-initiated and device-initiated U1 and U2 entry.
4093 * Caller must own the bandwidth_mutex.
4095 * This will call usb_enable_lpm() on failure, which will decrement
4096 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
4098 int usb_disable_lpm(struct usb_device *udev)
4100 struct usb_hcd *hcd;
4102 if (!udev || !udev->parent ||
4103 udev->speed < USB_SPEED_SUPER ||
4104 !udev->lpm_capable ||
4105 udev->state < USB_STATE_DEFAULT)
4108 hcd = bus_to_hcd(udev->bus);
4109 if (!hcd || !hcd->driver->disable_usb3_lpm_timeout)
4112 udev->lpm_disable_count++;
4113 if ((udev->u1_params.timeout == 0 && udev->u2_params.timeout == 0))
4116 /* If LPM is enabled, attempt to disable it. */
4117 if (usb_disable_link_state(hcd, udev, USB3_LPM_U1))
4119 if (usb_disable_link_state(hcd, udev, USB3_LPM_U2))
4125 usb_enable_lpm(udev);
4128 EXPORT_SYMBOL_GPL(usb_disable_lpm);
4130 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
4131 int usb_unlocked_disable_lpm(struct usb_device *udev)
4133 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4139 mutex_lock(hcd->bandwidth_mutex);
4140 ret = usb_disable_lpm(udev);
4141 mutex_unlock(hcd->bandwidth_mutex);
4145 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
4148 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
4149 * xHCI host policy may prevent U1 or U2 from being enabled.
4151 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
4152 * until the lpm_disable_count drops to zero. Caller must own the
4155 void usb_enable_lpm(struct usb_device *udev)
4157 struct usb_hcd *hcd;
4158 struct usb_hub *hub;
4159 struct usb_port *port_dev;
4161 if (!udev || !udev->parent ||
4162 udev->speed < USB_SPEED_SUPER ||
4163 !udev->lpm_capable ||
4164 udev->state < USB_STATE_DEFAULT)
4167 udev->lpm_disable_count--;
4168 hcd = bus_to_hcd(udev->bus);
4169 /* Double check that we can both enable and disable LPM.
4170 * Device must be configured to accept set feature U1/U2 timeout.
4172 if (!hcd || !hcd->driver->enable_usb3_lpm_timeout ||
4173 !hcd->driver->disable_usb3_lpm_timeout)
4176 if (udev->lpm_disable_count > 0)
4179 hub = usb_hub_to_struct_hub(udev->parent);
4183 port_dev = hub->ports[udev->portnum - 1];
4185 if (port_dev->usb3_lpm_u1_permit)
4186 usb_enable_link_state(hcd, udev, USB3_LPM_U1);
4188 if (port_dev->usb3_lpm_u2_permit)
4189 usb_enable_link_state(hcd, udev, USB3_LPM_U2);
4191 EXPORT_SYMBOL_GPL(usb_enable_lpm);
4193 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
4194 void usb_unlocked_enable_lpm(struct usb_device *udev)
4196 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4201 mutex_lock(hcd->bandwidth_mutex);
4202 usb_enable_lpm(udev);
4203 mutex_unlock(hcd->bandwidth_mutex);
4205 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
4207 /* usb3 devices use U3 for disabled, make sure remote wakeup is disabled */
4208 static void hub_usb3_port_prepare_disable(struct usb_hub *hub,
4209 struct usb_port *port_dev)
4211 struct usb_device *udev = port_dev->child;
4214 if (udev && udev->port_is_suspended && udev->do_remote_wakeup) {
4215 ret = hub_set_port_link_state(hub, port_dev->portnum,
4218 msleep(USB_RESUME_TIMEOUT);
4219 ret = usb_disable_remote_wakeup(udev);
4222 dev_warn(&udev->dev,
4223 "Port disable: can't disable remote wake\n");
4224 udev->do_remote_wakeup = 0;
4228 #else /* CONFIG_PM */
4230 #define hub_suspend NULL
4231 #define hub_resume NULL
4232 #define hub_reset_resume NULL
4234 static inline void hub_usb3_port_prepare_disable(struct usb_hub *hub,
4235 struct usb_port *port_dev) { }
4237 int usb_disable_lpm(struct usb_device *udev)
4241 EXPORT_SYMBOL_GPL(usb_disable_lpm);
4243 void usb_enable_lpm(struct usb_device *udev) { }
4244 EXPORT_SYMBOL_GPL(usb_enable_lpm);
4246 int usb_unlocked_disable_lpm(struct usb_device *udev)
4250 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
4252 void usb_unlocked_enable_lpm(struct usb_device *udev) { }
4253 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
4255 int usb_disable_ltm(struct usb_device *udev)
4259 EXPORT_SYMBOL_GPL(usb_disable_ltm);
4261 void usb_enable_ltm(struct usb_device *udev) { }
4262 EXPORT_SYMBOL_GPL(usb_enable_ltm);
4264 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
4265 u16 portstatus, u16 portchange)
4270 #endif /* CONFIG_PM */
4273 * USB-3 does not have a similar link state as USB-2 that will avoid negotiating
4274 * a connection with a plugged-in cable but will signal the host when the cable
4275 * is unplugged. Disable remote wake and set link state to U3 for USB-3 devices
4277 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
4279 struct usb_port *port_dev = hub->ports[port1 - 1];
4280 struct usb_device *hdev = hub->hdev;
4284 if (hub_is_superspeed(hub->hdev)) {
4285 hub_usb3_port_prepare_disable(hub, port_dev);
4286 ret = hub_set_port_link_state(hub, port_dev->portnum,
4289 ret = usb_clear_port_feature(hdev, port1,
4290 USB_PORT_FEAT_ENABLE);
4293 if (port_dev->child && set_state)
4294 usb_set_device_state(port_dev->child, USB_STATE_NOTATTACHED);
4295 if (ret && ret != -ENODEV)
4296 dev_err(&port_dev->dev, "cannot disable (err = %d)\n", ret);
4301 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
4303 * Between connect detection and reset signaling there must be a delay
4304 * of 100ms at least for debounce and power-settling. The corresponding
4305 * timer shall restart whenever the downstream port detects a disconnect.
4307 * Apparently there are some bluetooth and irda-dongles and a number of
4308 * low-speed devices for which this debounce period may last over a second.
4309 * Not covered by the spec - but easy to deal with.
4311 * This implementation uses a 1500ms total debounce timeout; if the
4312 * connection isn't stable by then it returns -ETIMEDOUT. It checks
4313 * every 25ms for transient disconnects. When the port status has been
4314 * unchanged for 100ms it returns the port status.
4316 int hub_port_debounce(struct usb_hub *hub, int port1, bool must_be_connected)
4319 u16 portchange, portstatus;
4320 unsigned connection = 0xffff;
4321 int total_time, stable_time = 0;
4322 struct usb_port *port_dev = hub->ports[port1 - 1];
4324 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
4325 ret = hub_port_status(hub, port1, &portstatus, &portchange);
4329 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
4330 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
4331 if (!must_be_connected ||
4332 (connection == USB_PORT_STAT_CONNECTION))
4333 stable_time += HUB_DEBOUNCE_STEP;
4334 if (stable_time >= HUB_DEBOUNCE_STABLE)
4338 connection = portstatus & USB_PORT_STAT_CONNECTION;
4341 if (portchange & USB_PORT_STAT_C_CONNECTION) {
4342 usb_clear_port_feature(hub->hdev, port1,
4343 USB_PORT_FEAT_C_CONNECTION);
4346 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
4348 msleep(HUB_DEBOUNCE_STEP);
4351 dev_dbg(&port_dev->dev, "debounce total %dms stable %dms status 0x%x\n",
4352 total_time, stable_time, portstatus);
4354 if (stable_time < HUB_DEBOUNCE_STABLE)
4359 void usb_ep0_reinit(struct usb_device *udev)
4361 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
4362 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
4363 usb_enable_endpoint(udev, &udev->ep0, true);
4365 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
4367 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
4368 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
4370 static int hub_set_address(struct usb_device *udev, int devnum)
4373 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4376 * The host controller will choose the device address,
4377 * instead of the core having chosen it earlier
4379 if (!hcd->driver->address_device && devnum <= 1)
4381 if (udev->state == USB_STATE_ADDRESS)
4383 if (udev->state != USB_STATE_DEFAULT)
4385 if (hcd->driver->address_device)
4386 retval = hcd->driver->address_device(hcd, udev);
4388 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
4389 USB_REQ_SET_ADDRESS, 0, devnum, 0,
4390 NULL, 0, USB_CTRL_SET_TIMEOUT);
4392 update_devnum(udev, devnum);
4393 /* Device now using proper address. */
4394 usb_set_device_state(udev, USB_STATE_ADDRESS);
4395 usb_ep0_reinit(udev);
4401 * There are reports of USB 3.0 devices that say they support USB 2.0 Link PM
4402 * when they're plugged into a USB 2.0 port, but they don't work when LPM is
4405 * Only enable USB 2.0 Link PM if the port is internal (hardwired), or the
4406 * device says it supports the new USB 2.0 Link PM errata by setting the BESL
4407 * support bit in the BOS descriptor.
4409 static void hub_set_initial_usb2_lpm_policy(struct usb_device *udev)
4411 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
4412 int connect_type = USB_PORT_CONNECT_TYPE_UNKNOWN;
4414 if (!udev->usb2_hw_lpm_capable || !udev->bos)
4418 connect_type = hub->ports[udev->portnum - 1]->connect_type;
4420 if ((udev->bos->ext_cap->bmAttributes & cpu_to_le32(USB_BESL_SUPPORT)) ||
4421 connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
4422 udev->usb2_hw_lpm_allowed = 1;
4423 usb_enable_usb2_hardware_lpm(udev);
4427 static int hub_enable_device(struct usb_device *udev)
4429 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4431 if (!hcd->driver->enable_device)
4433 if (udev->state == USB_STATE_ADDRESS)
4435 if (udev->state != USB_STATE_DEFAULT)
4438 return hcd->driver->enable_device(hcd, udev);
4441 /* Reset device, (re)assign address, get device descriptor.
4442 * Device connection must be stable, no more debouncing needed.
4443 * Returns device in USB_STATE_ADDRESS, except on error.
4445 * If this is called for an already-existing device (as part of
4446 * usb_reset_and_verify_device), the caller must own the device lock and
4447 * the port lock. For a newly detected device that is not accessible
4448 * through any global pointers, it's not necessary to lock the device,
4449 * but it is still necessary to lock the port.
4452 hub_port_init(struct usb_hub *hub, struct usb_device *udev, int port1,
4455 struct usb_device *hdev = hub->hdev;
4456 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4457 int retries, operations, retval, i;
4458 unsigned delay = HUB_SHORT_RESET_TIME;
4459 enum usb_device_speed oldspeed = udev->speed;
4461 int devnum = udev->devnum;
4462 const char *driver_name;
4464 /* root hub ports have a slightly longer reset period
4465 * (from USB 2.0 spec, section 7.1.7.5)
4467 if (!hdev->parent) {
4468 delay = HUB_ROOT_RESET_TIME;
4469 if (port1 == hdev->bus->otg_port)
4470 hdev->bus->b_hnp_enable = 0;
4473 /* Some low speed devices have problems with the quick delay, so */
4474 /* be a bit pessimistic with those devices. RHbug #23670 */
4475 if (oldspeed == USB_SPEED_LOW)
4476 delay = HUB_LONG_RESET_TIME;
4478 /* Reset the device; full speed may morph to high speed */
4479 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
4480 retval = hub_port_reset(hub, port1, udev, delay, false);
4481 if (retval < 0) /* error or disconnect */
4483 /* success, speed is known */
4487 /* Don't allow speed changes at reset, except usb 3.0 to faster */
4488 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed &&
4489 !(oldspeed == USB_SPEED_SUPER && udev->speed > oldspeed)) {
4490 dev_dbg(&udev->dev, "device reset changed speed!\n");
4493 oldspeed = udev->speed;
4495 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4496 * it's fixed size except for full speed devices.
4497 * For Wireless USB devices, ep0 max packet is always 512 (tho
4498 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4500 switch (udev->speed) {
4501 case USB_SPEED_SUPER_PLUS:
4502 case USB_SPEED_SUPER:
4503 case USB_SPEED_WIRELESS: /* fixed at 512 */
4504 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
4506 case USB_SPEED_HIGH: /* fixed at 64 */
4507 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4509 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
4510 /* to determine the ep0 maxpacket size, try to read
4511 * the device descriptor to get bMaxPacketSize0 and
4512 * then correct our initial guess.
4514 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4516 case USB_SPEED_LOW: /* fixed at 8 */
4517 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
4523 if (udev->speed == USB_SPEED_WIRELESS)
4524 speed = "variable speed Wireless";
4526 speed = usb_speed_string(udev->speed);
4529 * The controller driver may be NULL if the controller device
4530 * is the middle device between platform device and roothub.
4531 * This middle device may not need a device driver due to
4532 * all hardware control can be at platform device driver, this
4533 * platform device is usually a dual-role USB controller device.
4535 if (udev->bus->controller->driver)
4536 driver_name = udev->bus->controller->driver->name;
4538 driver_name = udev->bus->sysdev->driver->name;
4540 if (udev->speed < USB_SPEED_SUPER)
4541 dev_info(&udev->dev,
4542 "%s %s USB device number %d using %s\n",
4543 (udev->config) ? "reset" : "new", speed,
4544 devnum, driver_name);
4546 /* Set up TT records, if needed */
4548 udev->tt = hdev->tt;
4549 udev->ttport = hdev->ttport;
4550 } else if (udev->speed != USB_SPEED_HIGH
4551 && hdev->speed == USB_SPEED_HIGH) {
4553 dev_err(&udev->dev, "parent hub has no TT\n");
4557 udev->tt = &hub->tt;
4558 udev->ttport = port1;
4561 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4562 * Because device hardware and firmware is sometimes buggy in
4563 * this area, and this is how Linux has done it for ages.
4564 * Change it cautiously.
4566 * NOTE: If use_new_scheme() is true we will start by issuing
4567 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4568 * so it may help with some non-standards-compliant devices.
4569 * Otherwise we start with SET_ADDRESS and then try to read the
4570 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4573 for (retries = 0; retries < GET_DESCRIPTOR_TRIES; (++retries, msleep(100))) {
4574 bool did_new_scheme = false;
4576 if (use_new_scheme(udev, retry_counter)) {
4577 struct usb_device_descriptor *buf;
4580 did_new_scheme = true;
4581 retval = hub_enable_device(udev);
4584 "hub failed to enable device, error %d\n",
4589 #define GET_DESCRIPTOR_BUFSIZE 64
4590 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
4596 /* Retry on all errors; some devices are flakey.
4597 * 255 is for WUSB devices, we actually need to use
4598 * 512 (WUSB1.0[4.8.1]).
4600 for (operations = 0; operations < 3; ++operations) {
4601 buf->bMaxPacketSize0 = 0;
4602 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
4603 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
4604 USB_DT_DEVICE << 8, 0,
4605 buf, GET_DESCRIPTOR_BUFSIZE,
4606 initial_descriptor_timeout);
4607 switch (buf->bMaxPacketSize0) {
4608 case 8: case 16: case 32: case 64: case 255:
4609 if (buf->bDescriptorType ==
4621 * Some devices time out if they are powered on
4622 * when already connected. They need a second
4623 * reset. But only on the first attempt,
4624 * lest we get into a time out/reset loop
4626 if (r == 0 || (r == -ETIMEDOUT &&
4628 udev->speed > USB_SPEED_FULL))
4631 udev->descriptor.bMaxPacketSize0 =
4632 buf->bMaxPacketSize0;
4635 retval = hub_port_reset(hub, port1, udev, delay, false);
4636 if (retval < 0) /* error or disconnect */
4638 if (oldspeed != udev->speed) {
4640 "device reset changed speed!\n");
4646 dev_err(&udev->dev, "device descriptor read/64, error %d\n",
4651 #undef GET_DESCRIPTOR_BUFSIZE
4655 * If device is WUSB, we already assigned an
4656 * unauthorized address in the Connect Ack sequence;
4657 * authorization will assign the final address.
4659 if (udev->wusb == 0) {
4660 for (operations = 0; operations < SET_ADDRESS_TRIES; ++operations) {
4661 retval = hub_set_address(udev, devnum);
4667 if (retval != -ENODEV)
4668 dev_err(&udev->dev, "device not accepting address %d, error %d\n",
4672 if (udev->speed >= USB_SPEED_SUPER) {
4673 devnum = udev->devnum;
4674 dev_info(&udev->dev,
4675 "%s SuperSpeed%s USB device number %d using %s\n",
4676 (udev->config) ? "reset" : "new",
4677 (udev->speed == USB_SPEED_SUPER_PLUS) ? "Plus" : "",
4678 devnum, driver_name);
4681 /* cope with hardware quirkiness:
4682 * - let SET_ADDRESS settle, some device hardware wants it
4683 * - read ep0 maxpacket even for high and low speed,
4686 /* use_new_scheme() checks the speed which may have
4687 * changed since the initial look so we cache the result
4694 retval = usb_get_device_descriptor(udev, 8);
4696 if (retval != -ENODEV)
4698 "device descriptor read/8, error %d\n",
4711 * Some superspeed devices have finished the link training process
4712 * and attached to a superspeed hub port, but the device descriptor
4713 * got from those devices show they aren't superspeed devices. Warm
4714 * reset the port attached by the devices can fix them.
4716 if ((udev->speed >= USB_SPEED_SUPER) &&
4717 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
4718 dev_err(&udev->dev, "got a wrong device descriptor, "
4719 "warm reset device\n");
4720 hub_port_reset(hub, port1, udev,
4721 HUB_BH_RESET_TIME, true);
4726 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
4727 udev->speed >= USB_SPEED_SUPER)
4730 i = udev->descriptor.bMaxPacketSize0;
4731 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
4732 if (udev->speed == USB_SPEED_LOW ||
4733 !(i == 8 || i == 16 || i == 32 || i == 64)) {
4734 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
4738 if (udev->speed == USB_SPEED_FULL)
4739 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
4741 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
4742 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
4743 usb_ep0_reinit(udev);
4746 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
4747 if (retval < (signed)sizeof(udev->descriptor)) {
4748 if (retval != -ENODEV)
4749 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
4756 usb_detect_quirks(udev);
4758 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
4759 retval = usb_get_bos_descriptor(udev);
4761 udev->lpm_capable = usb_device_supports_lpm(udev);
4762 usb_set_lpm_parameters(udev);
4767 /* notify HCD that we have a device connected and addressed */
4768 if (hcd->driver->update_device)
4769 hcd->driver->update_device(hcd, udev);
4770 hub_set_initial_usb2_lpm_policy(udev);
4773 hub_port_disable(hub, port1, 0);
4774 update_devnum(udev, devnum); /* for disconnect processing */
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;
4867 /* Disconnect any existing devices under this port */
4869 if (hcd->usb_phy && !hdev->parent)
4870 usb_phy_notify_disconnect(hcd->usb_phy, udev->speed);
4871 usb_disconnect(&port_dev->child);
4874 /* We can forget about a "removed" device when there's a physical
4875 * disconnect or the connect status changes.
4877 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4878 (portchange & USB_PORT_STAT_C_CONNECTION))
4879 clear_bit(port1, hub->removed_bits);
4881 if (portchange & (USB_PORT_STAT_C_CONNECTION |
4882 USB_PORT_STAT_C_ENABLE)) {
4883 status = hub_port_debounce_be_stable(hub, port1);
4885 if (status != -ENODEV &&
4886 port1 != unreliable_port &&
4888 dev_err(&port_dev->dev, "connect-debounce failed\n");
4889 portstatus &= ~USB_PORT_STAT_CONNECTION;
4890 unreliable_port = port1;
4892 portstatus = status;
4896 /* Return now if debouncing failed or nothing is connected or
4897 * the device was "removed".
4899 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4900 test_bit(port1, hub->removed_bits)) {
4903 * maybe switch power back on (e.g. root hub was reset)
4904 * but only if the port isn't owned by someone else.
4906 if (hub_is_port_power_switchable(hub)
4907 && !port_is_power_on(hub, portstatus)
4908 && !port_dev->port_owner)
4909 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
4911 if (portstatus & USB_PORT_STAT_ENABLE)
4915 if (hub_is_superspeed(hub->hdev))
4922 for (i = 0; i < SET_CONFIG_TRIES; i++) {
4923 usb_lock_port(port_dev);
4924 mutex_lock(hcd->address0_mutex);
4925 retry_locked = true;
4927 /* reallocate for each attempt, since references
4928 * to the previous one can escape in various ways
4930 udev = usb_alloc_dev(hdev, hdev->bus, port1);
4932 dev_err(&port_dev->dev,
4933 "couldn't allocate usb_device\n");
4934 mutex_unlock(hcd->address0_mutex);
4935 usb_unlock_port(port_dev);
4939 usb_set_device_state(udev, USB_STATE_POWERED);
4940 udev->bus_mA = hub->mA_per_port;
4941 udev->level = hdev->level + 1;
4942 udev->wusb = hub_is_wusb(hub);
4944 /* Devices connected to SuperSpeed hubs are USB 3.0 or later */
4945 if (hub_is_superspeed(hub->hdev))
4946 udev->speed = USB_SPEED_SUPER;
4948 udev->speed = USB_SPEED_UNKNOWN;
4950 choose_devnum(udev);
4951 if (udev->devnum <= 0) {
4952 status = -ENOTCONN; /* Don't retry */
4956 /* reset (non-USB 3.0 devices) and get descriptor */
4957 status = hub_port_init(hub, udev, port1, i);
4961 mutex_unlock(hcd->address0_mutex);
4962 usb_unlock_port(port_dev);
4963 retry_locked = false;
4965 if (udev->quirks & USB_QUIRK_DELAY_INIT)
4968 /* consecutive bus-powered hubs aren't reliable; they can
4969 * violate the voltage drop budget. if the new child has
4970 * a "powered" LED, users should notice we didn't enable it
4971 * (without reading syslog), even without per-port LEDs
4974 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
4975 && udev->bus_mA <= unit_load) {
4978 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
4981 dev_dbg(&udev->dev, "get status %d ?\n", status);
4984 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
4986 "can't connect bus-powered hub "
4988 if (hub->has_indicators) {
4989 hub->indicator[port1-1] =
4990 INDICATOR_AMBER_BLINK;
4992 system_power_efficient_wq,
4995 status = -ENOTCONN; /* Don't retry */
5000 /* check for devices running slower than they could */
5001 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
5002 && udev->speed == USB_SPEED_FULL
5003 && highspeed_hubs != 0)
5004 check_highspeed(hub, udev, port1);
5006 /* Store the parent's children[] pointer. At this point
5007 * udev becomes globally accessible, although presumably
5008 * no one will look at it until hdev is unlocked.
5012 mutex_lock(&usb_port_peer_mutex);
5014 /* We mustn't add new devices if the parent hub has
5015 * been disconnected; we would race with the
5016 * recursively_mark_NOTATTACHED() routine.
5018 spin_lock_irq(&device_state_lock);
5019 if (hdev->state == USB_STATE_NOTATTACHED)
5022 port_dev->child = udev;
5023 spin_unlock_irq(&device_state_lock);
5024 mutex_unlock(&usb_port_peer_mutex);
5026 /* Run it through the hoops (find a driver, etc) */
5028 status = usb_new_device(udev);
5030 mutex_lock(&usb_port_peer_mutex);
5031 spin_lock_irq(&device_state_lock);
5032 port_dev->child = NULL;
5033 spin_unlock_irq(&device_state_lock);
5034 mutex_unlock(&usb_port_peer_mutex);
5036 if (hcd->usb_phy && !hdev->parent)
5037 usb_phy_notify_connect(hcd->usb_phy,
5045 status = hub_power_remaining(hub);
5047 dev_dbg(hub->intfdev, "%dmA power budget left\n", status);
5052 hub_port_disable(hub, port1, 1);
5054 usb_ep0_reinit(udev);
5055 release_devnum(udev);
5058 mutex_unlock(hcd->address0_mutex);
5059 usb_unlock_port(port_dev);
5062 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
5065 /* When halfway through our retry count, power-cycle the port */
5066 if (i == (SET_CONFIG_TRIES / 2) - 1) {
5067 dev_info(&port_dev->dev, "attempt power cycle\n");
5068 usb_hub_set_port_power(hdev, hub, port1, false);
5069 msleep(2 * hub_power_on_good_delay(hub));
5070 usb_hub_set_port_power(hdev, hub, port1, true);
5071 msleep(hub_power_on_good_delay(hub));
5074 if (hub->hdev->parent ||
5075 !hcd->driver->port_handed_over ||
5076 !(hcd->driver->port_handed_over)(hcd, port1)) {
5077 if (status != -ENOTCONN && status != -ENODEV)
5078 dev_err(&port_dev->dev,
5079 "unable to enumerate USB device\n");
5083 hub_port_disable(hub, port1, 1);
5084 if (hcd->driver->relinquish_port && !hub->hdev->parent) {
5085 if (status != -ENOTCONN && status != -ENODEV)
5086 hcd->driver->relinquish_port(hcd, port1);
5090 /* Handle physical or logical connection change events.
5091 * This routine is called when:
5092 * a port connection-change occurs;
5093 * a port enable-change occurs (often caused by EMI);
5094 * usb_reset_and_verify_device() encounters changed descriptors (as from
5095 * a firmware download)
5096 * caller already locked the hub
5098 static void hub_port_connect_change(struct usb_hub *hub, int port1,
5099 u16 portstatus, u16 portchange)
5100 __must_hold(&port_dev->status_lock)
5102 struct usb_port *port_dev = hub->ports[port1 - 1];
5103 struct usb_device *udev = port_dev->child;
5104 int status = -ENODEV;
5106 dev_dbg(&port_dev->dev, "status %04x, change %04x, %s\n", portstatus,
5107 portchange, portspeed(hub, portstatus));
5109 if (hub->has_indicators) {
5110 set_port_led(hub, port1, HUB_LED_AUTO);
5111 hub->indicator[port1-1] = INDICATOR_AUTO;
5114 #ifdef CONFIG_USB_OTG
5115 /* during HNP, don't repeat the debounce */
5116 if (hub->hdev->bus->is_b_host)
5117 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
5118 USB_PORT_STAT_C_ENABLE);
5121 /* Try to resuscitate an existing device */
5122 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
5123 udev->state != USB_STATE_NOTATTACHED) {
5124 if (portstatus & USB_PORT_STAT_ENABLE) {
5125 status = 0; /* Nothing to do */
5127 } else if (udev->state == USB_STATE_SUSPENDED &&
5128 udev->persist_enabled) {
5129 /* For a suspended device, treat this as a
5130 * remote wakeup event.
5132 usb_unlock_port(port_dev);
5133 status = usb_remote_wakeup(udev);
5134 usb_lock_port(port_dev);
5137 /* Don't resuscitate */;
5140 clear_bit(port1, hub->change_bits);
5142 /* successfully revalidated the connection */
5146 usb_unlock_port(port_dev);
5147 hub_port_connect(hub, port1, portstatus, portchange);
5148 usb_lock_port(port_dev);
5151 static void port_event(struct usb_hub *hub, int port1)
5152 __must_hold(&port_dev->status_lock)
5155 struct usb_port *port_dev = hub->ports[port1 - 1];
5156 struct usb_device *udev = port_dev->child;
5157 struct usb_device *hdev = hub->hdev;
5158 u16 portstatus, portchange;
5160 connect_change = test_bit(port1, hub->change_bits);
5161 clear_bit(port1, hub->event_bits);
5162 clear_bit(port1, hub->wakeup_bits);
5164 if (hub_port_status(hub, port1, &portstatus, &portchange) < 0)
5167 if (portchange & USB_PORT_STAT_C_CONNECTION) {
5168 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_CONNECTION);
5172 if (portchange & USB_PORT_STAT_C_ENABLE) {
5173 if (!connect_change)
5174 dev_dbg(&port_dev->dev, "enable change, status %08x\n",
5176 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_ENABLE);
5179 * EM interference sometimes causes badly shielded USB devices
5180 * to be shutdown by the hub, this hack enables them again.
5181 * Works at least with mouse driver.
5183 if (!(portstatus & USB_PORT_STAT_ENABLE)
5184 && !connect_change && udev) {
5185 dev_err(&port_dev->dev, "disabled by hub (EMI?), re-enabling...\n");
5190 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
5191 u16 status = 0, unused;
5193 dev_dbg(&port_dev->dev, "over-current change\n");
5194 usb_clear_port_feature(hdev, port1,
5195 USB_PORT_FEAT_C_OVER_CURRENT);
5196 msleep(100); /* Cool down */
5197 hub_power_on(hub, true);
5198 hub_port_status(hub, port1, &status, &unused);
5199 if (status & USB_PORT_STAT_OVERCURRENT)
5200 dev_err(&port_dev->dev, "over-current condition\n");
5203 if (portchange & USB_PORT_STAT_C_RESET) {
5204 dev_dbg(&port_dev->dev, "reset change\n");
5205 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_RESET);
5207 if ((portchange & USB_PORT_STAT_C_BH_RESET)
5208 && hub_is_superspeed(hdev)) {
5209 dev_dbg(&port_dev->dev, "warm reset change\n");
5210 usb_clear_port_feature(hdev, port1,
5211 USB_PORT_FEAT_C_BH_PORT_RESET);
5213 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
5214 dev_dbg(&port_dev->dev, "link state change\n");
5215 usb_clear_port_feature(hdev, port1,
5216 USB_PORT_FEAT_C_PORT_LINK_STATE);
5218 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
5219 dev_warn(&port_dev->dev, "config error\n");
5220 usb_clear_port_feature(hdev, port1,
5221 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
5224 /* skip port actions that require the port to be powered on */
5225 if (!pm_runtime_active(&port_dev->dev))
5228 if (hub_handle_remote_wakeup(hub, port1, portstatus, portchange))
5232 * Warm reset a USB3 protocol port if it's in
5233 * SS.Inactive state.
5235 if (hub_port_warm_reset_required(hub, port1, portstatus)) {
5236 dev_dbg(&port_dev->dev, "do warm reset\n");
5237 if (!udev || !(portstatus & USB_PORT_STAT_CONNECTION)
5238 || udev->state == USB_STATE_NOTATTACHED) {
5239 if (hub_port_reset(hub, port1, NULL,
5240 HUB_BH_RESET_TIME, true) < 0)
5241 hub_port_disable(hub, port1, 1);
5243 usb_unlock_port(port_dev);
5244 usb_lock_device(udev);
5245 usb_reset_device(udev);
5246 usb_unlock_device(udev);
5247 usb_lock_port(port_dev);
5253 hub_port_connect_change(hub, port1, portstatus, portchange);
5256 static void hub_event(struct work_struct *work)
5258 struct usb_device *hdev;
5259 struct usb_interface *intf;
5260 struct usb_hub *hub;
5261 struct device *hub_dev;
5266 hub = container_of(work, struct usb_hub, events);
5268 hub_dev = hub->intfdev;
5269 intf = to_usb_interface(hub_dev);
5271 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
5272 hdev->state, hdev->maxchild,
5273 /* NOTE: expects max 15 ports... */
5274 (u16) hub->change_bits[0],
5275 (u16) hub->event_bits[0]);
5277 /* Lock the device, then check to see if we were
5278 * disconnected while waiting for the lock to succeed. */
5279 usb_lock_device(hdev);
5280 if (unlikely(hub->disconnected))
5283 /* If the hub has died, clean up after it */
5284 if (hdev->state == USB_STATE_NOTATTACHED) {
5285 hub->error = -ENODEV;
5286 hub_quiesce(hub, HUB_DISCONNECT);
5291 ret = usb_autopm_get_interface(intf);
5293 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
5297 /* If this is an inactive hub, do nothing */
5302 dev_dbg(hub_dev, "resetting for error %d\n", hub->error);
5304 ret = usb_reset_device(hdev);
5306 dev_dbg(hub_dev, "error resetting hub: %d\n", ret);
5314 /* deal with port status changes */
5315 for (i = 1; i <= hdev->maxchild; i++) {
5316 struct usb_port *port_dev = hub->ports[i - 1];
5318 if (test_bit(i, hub->event_bits)
5319 || test_bit(i, hub->change_bits)
5320 || test_bit(i, hub->wakeup_bits)) {
5322 * The get_noresume and barrier ensure that if
5323 * the port was in the process of resuming, we
5324 * flush that work and keep the port active for
5325 * the duration of the port_event(). However,
5326 * if the port is runtime pm suspended
5327 * (powered-off), we leave it in that state, run
5328 * an abbreviated port_event(), and move on.
5330 pm_runtime_get_noresume(&port_dev->dev);
5331 pm_runtime_barrier(&port_dev->dev);
5332 usb_lock_port(port_dev);
5334 usb_unlock_port(port_dev);
5335 pm_runtime_put_sync(&port_dev->dev);
5339 /* deal with hub status changes */
5340 if (test_and_clear_bit(0, hub->event_bits) == 0)
5342 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
5343 dev_err(hub_dev, "get_hub_status failed\n");
5345 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
5346 dev_dbg(hub_dev, "power change\n");
5347 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
5348 if (hubstatus & HUB_STATUS_LOCAL_POWER)
5349 /* FIXME: Is this always true? */
5350 hub->limited_power = 1;
5352 hub->limited_power = 0;
5354 if (hubchange & HUB_CHANGE_OVERCURRENT) {
5358 dev_dbg(hub_dev, "over-current change\n");
5359 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
5360 msleep(500); /* Cool down */
5361 hub_power_on(hub, true);
5362 hub_hub_status(hub, &status, &unused);
5363 if (status & HUB_STATUS_OVERCURRENT)
5364 dev_err(hub_dev, "over-current condition\n");
5369 /* Balance the usb_autopm_get_interface() above */
5370 usb_autopm_put_interface_no_suspend(intf);
5372 usb_unlock_device(hdev);
5374 /* Balance the stuff in kick_hub_wq() and allow autosuspend */
5375 usb_autopm_put_interface(intf);
5376 kref_put(&hub->kref, hub_release);
5379 static const struct usb_device_id hub_id_table[] = {
5380 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5381 | USB_DEVICE_ID_MATCH_PRODUCT
5382 | USB_DEVICE_ID_MATCH_INT_CLASS,
5383 .idVendor = USB_VENDOR_SMSC,
5384 .idProduct = USB_PRODUCT_USB5534B,
5385 .bInterfaceClass = USB_CLASS_HUB,
5386 .driver_info = HUB_QUIRK_DISABLE_AUTOSUSPEND},
5387 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5388 | USB_DEVICE_ID_MATCH_PRODUCT,
5389 .idVendor = USB_VENDOR_CYPRESS,
5390 .idProduct = USB_PRODUCT_CY7C65632,
5391 .driver_info = HUB_QUIRK_DISABLE_AUTOSUSPEND},
5392 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5393 | USB_DEVICE_ID_MATCH_INT_CLASS,
5394 .idVendor = USB_VENDOR_GENESYS_LOGIC,
5395 .bInterfaceClass = USB_CLASS_HUB,
5396 .driver_info = HUB_QUIRK_CHECK_PORT_AUTOSUSPEND},
5397 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
5398 .bDeviceClass = USB_CLASS_HUB},
5399 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
5400 .bInterfaceClass = USB_CLASS_HUB},
5401 { } /* Terminating entry */
5404 MODULE_DEVICE_TABLE(usb, hub_id_table);
5406 static struct usb_driver hub_driver = {
5409 .disconnect = hub_disconnect,
5410 .suspend = hub_suspend,
5411 .resume = hub_resume,
5412 .reset_resume = hub_reset_resume,
5413 .pre_reset = hub_pre_reset,
5414 .post_reset = hub_post_reset,
5415 .unlocked_ioctl = hub_ioctl,
5416 .id_table = hub_id_table,
5417 .supports_autosuspend = 1,
5420 int usb_hub_init(void)
5422 if (usb_register(&hub_driver) < 0) {
5423 printk(KERN_ERR "%s: can't register hub driver\n",
5429 * The workqueue needs to be freezable to avoid interfering with
5430 * USB-PERSIST port handover. Otherwise it might see that a full-speed
5431 * device was gone before the EHCI controller had handed its port
5432 * over to the companion full-speed controller.
5434 hub_wq = alloc_workqueue("usb_hub_wq", WQ_FREEZABLE, 0);
5438 /* Fall through if kernel_thread failed */
5439 usb_deregister(&hub_driver);
5440 pr_err("%s: can't allocate workqueue for usb hub\n", usbcore_name);
5445 void usb_hub_cleanup(void)
5447 destroy_workqueue(hub_wq);
5450 * Hub resources are freed for us by usb_deregister. It calls
5451 * usb_driver_purge on every device which in turn calls that
5452 * devices disconnect function if it is using this driver.
5453 * The hub_disconnect function takes care of releasing the
5454 * individual hub resources. -greg
5456 usb_deregister(&hub_driver);
5457 } /* usb_hub_cleanup() */
5459 static int descriptors_changed(struct usb_device *udev,
5460 struct usb_device_descriptor *old_device_descriptor,
5461 struct usb_host_bos *old_bos)
5465 unsigned serial_len = 0;
5467 unsigned old_length;
5471 if (memcmp(&udev->descriptor, old_device_descriptor,
5472 sizeof(*old_device_descriptor)) != 0)
5475 if ((old_bos && !udev->bos) || (!old_bos && udev->bos))
5478 len = le16_to_cpu(udev->bos->desc->wTotalLength);
5479 if (len != le16_to_cpu(old_bos->desc->wTotalLength))
5481 if (memcmp(udev->bos->desc, old_bos->desc, len))
5485 /* Since the idVendor, idProduct, and bcdDevice values in the
5486 * device descriptor haven't changed, we will assume the
5487 * Manufacturer and Product strings haven't changed either.
5488 * But the SerialNumber string could be different (e.g., a
5489 * different flash card of the same brand).
5492 serial_len = strlen(udev->serial) + 1;
5495 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5496 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5497 len = max(len, old_length);
5500 buf = kmalloc(len, GFP_NOIO);
5502 /* assume the worst */
5505 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5506 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5507 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
5509 if (length != old_length) {
5510 dev_dbg(&udev->dev, "config index %d, error %d\n",
5515 if (memcmp(buf, udev->rawdescriptors[index], old_length)
5517 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
5519 ((struct usb_config_descriptor *) buf)->
5520 bConfigurationValue);
5526 if (!changed && serial_len) {
5527 length = usb_string(udev, udev->descriptor.iSerialNumber,
5529 if (length + 1 != serial_len) {
5530 dev_dbg(&udev->dev, "serial string error %d\n",
5533 } else if (memcmp(buf, udev->serial, length) != 0) {
5534 dev_dbg(&udev->dev, "serial string changed\n");
5544 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5545 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5547 * WARNING - don't use this routine to reset a composite device
5548 * (one with multiple interfaces owned by separate drivers)!
5549 * Use usb_reset_device() instead.
5551 * Do a port reset, reassign the device's address, and establish its
5552 * former operating configuration. If the reset fails, or the device's
5553 * descriptors change from their values before the reset, or the original
5554 * configuration and altsettings cannot be restored, a flag will be set
5555 * telling hub_wq to pretend the device has been disconnected and then
5556 * re-connected. All drivers will be unbound, and the device will be
5557 * re-enumerated and probed all over again.
5559 * Return: 0 if the reset succeeded, -ENODEV if the device has been
5560 * flagged for logical disconnection, or some other negative error code
5561 * if the reset wasn't even attempted.
5564 * The caller must own the device lock and the port lock, the latter is
5565 * taken by usb_reset_device(). For example, it's safe to use
5566 * usb_reset_device() from a driver probe() routine after downloading
5567 * new firmware. For calls that might not occur during probe(), drivers
5568 * should lock the device using usb_lock_device_for_reset().
5570 * Locking exception: This routine may also be called from within an
5571 * autoresume handler. Such usage won't conflict with other tasks
5572 * holding the device lock because these tasks should always call
5573 * usb_autopm_resume_device(), thereby preventing any unwanted
5574 * autoresume. The autoresume handler is expected to have already
5575 * acquired the port lock before calling this routine.
5577 static int usb_reset_and_verify_device(struct usb_device *udev)
5579 struct usb_device *parent_hdev = udev->parent;
5580 struct usb_hub *parent_hub;
5581 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
5582 struct usb_device_descriptor descriptor = udev->descriptor;
5583 struct usb_host_bos *bos;
5585 int port1 = udev->portnum;
5587 if (udev->state == USB_STATE_NOTATTACHED ||
5588 udev->state == USB_STATE_SUSPENDED) {
5589 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5597 parent_hub = usb_hub_to_struct_hub(parent_hdev);
5599 /* Disable USB2 hardware LPM.
5600 * It will be re-enabled by the enumeration process.
5602 usb_disable_usb2_hardware_lpm(udev);
5604 /* Disable LPM and LTM while we reset the device and reinstall the alt
5605 * settings. Device-initiated LPM settings, and system exit latency
5606 * settings are cleared when the device is reset, so we have to set
5609 ret = usb_unlocked_disable_lpm(udev);
5611 dev_err(&udev->dev, "%s Failed to disable LPM\n.", __func__);
5612 goto re_enumerate_no_bos;
5614 ret = usb_disable_ltm(udev);
5616 dev_err(&udev->dev, "%s Failed to disable LTM\n.",
5618 goto re_enumerate_no_bos;
5624 mutex_lock(hcd->address0_mutex);
5626 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
5628 /* ep0 maxpacket size may change; let the HCD know about it.
5629 * Other endpoints will be handled by re-enumeration. */
5630 usb_ep0_reinit(udev);
5631 ret = hub_port_init(parent_hub, udev, port1, i);
5632 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
5635 mutex_unlock(hcd->address0_mutex);
5640 /* Device might have changed firmware (DFU or similar) */
5641 if (descriptors_changed(udev, &descriptor, bos)) {
5642 dev_info(&udev->dev, "device firmware changed\n");
5643 udev->descriptor = descriptor; /* for disconnect() calls */
5647 /* Restore the device's previous configuration */
5648 if (!udev->actconfig)
5651 mutex_lock(hcd->bandwidth_mutex);
5652 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
5654 dev_warn(&udev->dev,
5655 "Busted HC? Not enough HCD resources for "
5656 "old configuration.\n");
5657 mutex_unlock(hcd->bandwidth_mutex);
5660 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
5661 USB_REQ_SET_CONFIGURATION, 0,
5662 udev->actconfig->desc.bConfigurationValue, 0,
5663 NULL, 0, USB_CTRL_SET_TIMEOUT);
5666 "can't restore configuration #%d (error=%d)\n",
5667 udev->actconfig->desc.bConfigurationValue, ret);
5668 mutex_unlock(hcd->bandwidth_mutex);
5671 mutex_unlock(hcd->bandwidth_mutex);
5672 usb_set_device_state(udev, USB_STATE_CONFIGURED);
5674 /* Put interfaces back into the same altsettings as before.
5675 * Don't bother to send the Set-Interface request for interfaces
5676 * that were already in altsetting 0; besides being unnecessary,
5677 * many devices can't handle it. Instead just reset the host-side
5680 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
5681 struct usb_host_config *config = udev->actconfig;
5682 struct usb_interface *intf = config->interface[i];
5683 struct usb_interface_descriptor *desc;
5685 desc = &intf->cur_altsetting->desc;
5686 if (desc->bAlternateSetting == 0) {
5687 usb_disable_interface(udev, intf, true);
5688 usb_enable_interface(udev, intf, true);
5691 /* Let the bandwidth allocation function know that this
5692 * device has been reset, and it will have to use
5693 * alternate setting 0 as the current alternate setting.
5695 intf->resetting_device = 1;
5696 ret = usb_set_interface(udev, desc->bInterfaceNumber,
5697 desc->bAlternateSetting);
5698 intf->resetting_device = 0;
5701 dev_err(&udev->dev, "failed to restore interface %d "
5702 "altsetting %d (error=%d)\n",
5703 desc->bInterfaceNumber,
5704 desc->bAlternateSetting,
5708 /* Resetting also frees any allocated streams */
5709 for (j = 0; j < intf->cur_altsetting->desc.bNumEndpoints; j++)
5710 intf->cur_altsetting->endpoint[j].streams = 0;
5714 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5715 usb_enable_usb2_hardware_lpm(udev);
5716 usb_unlocked_enable_lpm(udev);
5717 usb_enable_ltm(udev);
5718 usb_release_bos_descriptor(udev);
5723 usb_release_bos_descriptor(udev);
5725 re_enumerate_no_bos:
5726 /* LPM state doesn't matter when we're about to destroy the device. */
5727 hub_port_logical_disconnect(parent_hub, port1);
5732 * usb_reset_device - warn interface drivers and perform a USB port reset
5733 * @udev: device to reset (not in NOTATTACHED state)
5735 * Warns all drivers bound to registered interfaces (using their pre_reset
5736 * method), performs the port reset, and then lets the drivers know that
5737 * the reset is over (using their post_reset method).
5739 * Return: The same as for usb_reset_and_verify_device().
5742 * The caller must own the device lock. For example, it's safe to use
5743 * this from a driver probe() routine after downloading new firmware.
5744 * For calls that might not occur during probe(), drivers should lock
5745 * the device using usb_lock_device_for_reset().
5747 * If an interface is currently being probed or disconnected, we assume
5748 * its driver knows how to handle resets. For all other interfaces,
5749 * if the driver doesn't have pre_reset and post_reset methods then
5750 * we attempt to unbind it and rebind afterward.
5752 int usb_reset_device(struct usb_device *udev)
5756 unsigned int noio_flag;
5757 struct usb_port *port_dev;
5758 struct usb_host_config *config = udev->actconfig;
5759 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
5761 if (udev->state == USB_STATE_NOTATTACHED) {
5762 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5767 if (!udev->parent) {
5768 /* this requires hcd-specific logic; see ohci_restart() */
5769 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
5773 port_dev = hub->ports[udev->portnum - 1];
5776 * Don't allocate memory with GFP_KERNEL in current
5777 * context to avoid possible deadlock if usb mass
5778 * storage interface or usbnet interface(iSCSI case)
5779 * is included in current configuration. The easist
5780 * approach is to do it for every device reset,
5781 * because the device 'memalloc_noio' flag may have
5782 * not been set before reseting the usb device.
5784 noio_flag = memalloc_noio_save();
5786 /* Prevent autosuspend during the reset */
5787 usb_autoresume_device(udev);
5790 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
5791 struct usb_interface *cintf = config->interface[i];
5792 struct usb_driver *drv;
5795 if (cintf->dev.driver) {
5796 drv = to_usb_driver(cintf->dev.driver);
5797 if (drv->pre_reset && drv->post_reset)
5798 unbind = (drv->pre_reset)(cintf);
5799 else if (cintf->condition ==
5800 USB_INTERFACE_BOUND)
5803 usb_forced_unbind_intf(cintf);
5808 usb_lock_port(port_dev);
5809 ret = usb_reset_and_verify_device(udev);
5810 usb_unlock_port(port_dev);
5813 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
5814 struct usb_interface *cintf = config->interface[i];
5815 struct usb_driver *drv;
5816 int rebind = cintf->needs_binding;
5818 if (!rebind && cintf->dev.driver) {
5819 drv = to_usb_driver(cintf->dev.driver);
5820 if (drv->post_reset)
5821 rebind = (drv->post_reset)(cintf);
5822 else if (cintf->condition ==
5823 USB_INTERFACE_BOUND)
5826 cintf->needs_binding = 1;
5830 /* If the reset failed, hub_wq will unbind drivers later */
5832 usb_unbind_and_rebind_marked_interfaces(udev);
5835 usb_autosuspend_device(udev);
5836 memalloc_noio_restore(noio_flag);
5839 EXPORT_SYMBOL_GPL(usb_reset_device);
5843 * usb_queue_reset_device - Reset a USB device from an atomic context
5844 * @iface: USB interface belonging to the device to reset
5846 * This function can be used to reset a USB device from an atomic
5847 * context, where usb_reset_device() won't work (as it blocks).
5849 * Doing a reset via this method is functionally equivalent to calling
5850 * usb_reset_device(), except for the fact that it is delayed to a
5851 * workqueue. This means that any drivers bound to other interfaces
5852 * might be unbound, as well as users from usbfs in user space.
5856 * - Scheduling two resets at the same time from two different drivers
5857 * attached to two different interfaces of the same device is
5858 * possible; depending on how the driver attached to each interface
5859 * handles ->pre_reset(), the second reset might happen or not.
5861 * - If the reset is delayed so long that the interface is unbound from
5862 * its driver, the reset will be skipped.
5864 * - This function can be called during .probe(). It can also be called
5865 * during .disconnect(), but doing so is pointless because the reset
5866 * will not occur. If you really want to reset the device during
5867 * .disconnect(), call usb_reset_device() directly -- but watch out
5868 * for nested unbinding issues!
5870 void usb_queue_reset_device(struct usb_interface *iface)
5872 if (schedule_work(&iface->reset_ws))
5873 usb_get_intf(iface);
5875 EXPORT_SYMBOL_GPL(usb_queue_reset_device);
5878 * usb_hub_find_child - Get the pointer of child device
5879 * attached to the port which is specified by @port1.
5880 * @hdev: USB device belonging to the usb hub
5881 * @port1: port num to indicate which port the child device
5884 * USB drivers call this function to get hub's child device
5887 * Return: %NULL if input param is invalid and
5888 * child's usb_device pointer if non-NULL.
5890 struct usb_device *usb_hub_find_child(struct usb_device *hdev,
5893 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5895 if (port1 < 1 || port1 > hdev->maxchild)
5897 return hub->ports[port1 - 1]->child;
5899 EXPORT_SYMBOL_GPL(usb_hub_find_child);
5901 void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
5902 struct usb_hub_descriptor *desc)
5904 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5905 enum usb_port_connect_type connect_type;
5911 if (!hub_is_superspeed(hdev)) {
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) {
5917 u8 mask = 1 << (i%8);
5919 if (!(desc->u.hs.DeviceRemovable[i/8] & mask)) {
5920 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
5921 desc->u.hs.DeviceRemovable[i/8] |= mask;
5926 u16 port_removable = le16_to_cpu(desc->u.ss.DeviceRemovable);
5928 for (i = 1; i <= hdev->maxchild; i++) {
5929 struct usb_port *port_dev = hub->ports[i - 1];
5931 connect_type = port_dev->connect_type;
5932 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5935 if (!(port_removable & mask)) {
5936 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
5937 port_removable |= mask;
5942 desc->u.ss.DeviceRemovable = cpu_to_le16(port_removable);
5948 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5949 * @hdev: USB device belonging to the usb hub
5950 * @port1: port num of the port
5952 * Return: Port's acpi handle if successful, %NULL if params are
5955 acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
5958 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5963 return ACPI_HANDLE(&hub->ports[port1 - 1]->dev);