1 // SPDX-License-Identifier: GPL-2.0
5 * (C) Copyright 1999 Linus Torvalds
6 * (C) Copyright 1999 Johannes Erdfelt
7 * (C) Copyright 1999 Gregory P. Smith
8 * (C) Copyright 2001 Brad Hards (bhards@bigpond.net.au)
10 * Released under the GPLv2 only.
13 #include <linux/kernel.h>
14 #include <linux/errno.h>
15 #include <linux/module.h>
16 #include <linux/moduleparam.h>
17 #include <linux/completion.h>
18 #include <linux/sched/mm.h>
19 #include <linux/list.h>
20 #include <linux/slab.h>
21 #include <linux/ioctl.h>
22 #include <linux/usb.h>
23 #include <linux/usbdevice_fs.h>
24 #include <linux/usb/hcd.h>
25 #include <linux/usb/otg.h>
26 #include <linux/usb/quirks.h>
27 #include <linux/workqueue.h>
28 #include <linux/mutex.h>
29 #include <linux/random.h>
30 #include <linux/pm_qos.h>
32 #include <linux/uaccess.h>
33 #include <asm/byteorder.h>
36 #include "otg_whitelist.h"
38 #define USB_VENDOR_GENESYS_LOGIC 0x05e3
39 #define HUB_QUIRK_CHECK_PORT_AUTOSUSPEND 0x01
41 #define USB_TP_TRANSMISSION_DELAY 40 /* ns */
42 #define USB_TP_TRANSMISSION_DELAY_MAX 65535 /* ns */
44 /* Protect struct usb_device->state and ->children members
45 * Note: Both are also protected by ->dev.sem, except that ->state can
46 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
47 static DEFINE_SPINLOCK(device_state_lock);
49 /* workqueue to process hub events */
50 static struct workqueue_struct *hub_wq;
51 static void hub_event(struct work_struct *work);
53 /* synchronize hub-port add/remove and peering operations */
54 DEFINE_MUTEX(usb_port_peer_mutex);
56 /* cycle leds on hubs that aren't blinking for attention */
57 static bool blinkenlights;
58 module_param(blinkenlights, bool, S_IRUGO);
59 MODULE_PARM_DESC(blinkenlights, "true to cycle leds on hubs");
62 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
63 * 10 seconds to send reply for the initial 64-byte descriptor request.
65 /* define initial 64-byte descriptor request timeout in milliseconds */
66 static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
67 module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
68 MODULE_PARM_DESC(initial_descriptor_timeout,
69 "initial 64-byte descriptor request timeout in milliseconds "
70 "(default 5000 - 5.0 seconds)");
73 * As of 2.6.10 we introduce a new USB device initialization scheme which
74 * closely resembles the way Windows works. Hopefully it will be compatible
75 * with a wider range of devices than the old scheme. However some previously
76 * working devices may start giving rise to "device not accepting address"
77 * errors; if that happens the user can try the old scheme by adjusting the
78 * following module parameters.
80 * For maximum flexibility there are two boolean parameters to control the
81 * hub driver's behavior. On the first initialization attempt, if the
82 * "old_scheme_first" parameter is set then the old scheme will be used,
83 * otherwise the new scheme is used. If that fails and "use_both_schemes"
84 * is set, then the driver will make another attempt, using the other scheme.
86 static bool old_scheme_first;
87 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
88 MODULE_PARM_DESC(old_scheme_first,
89 "start with the old device initialization scheme");
91 static bool use_both_schemes = 1;
92 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
93 MODULE_PARM_DESC(use_both_schemes,
94 "try the other device initialization scheme if the "
97 /* Mutual exclusion for EHCI CF initialization. This interferes with
98 * port reset on some companion controllers.
100 DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
101 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
103 #define HUB_DEBOUNCE_TIMEOUT 2000
104 #define HUB_DEBOUNCE_STEP 25
105 #define HUB_DEBOUNCE_STABLE 100
107 static void hub_release(struct kref *kref);
108 static int usb_reset_and_verify_device(struct usb_device *udev);
109 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state);
110 static bool hub_port_warm_reset_required(struct usb_hub *hub, int port1,
113 static inline char *portspeed(struct usb_hub *hub, int portstatus)
115 if (hub_is_superspeedplus(hub->hdev))
117 if (hub_is_superspeed(hub->hdev))
119 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
121 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
127 /* Note that hdev or one of its children must be locked! */
128 struct usb_hub *usb_hub_to_struct_hub(struct usb_device *hdev)
130 if (!hdev || !hdev->actconfig || !hdev->maxchild)
132 return usb_get_intfdata(hdev->actconfig->interface[0]);
135 int usb_device_supports_lpm(struct usb_device *udev)
137 /* Some devices have trouble with LPM */
138 if (udev->quirks & USB_QUIRK_NO_LPM)
141 /* USB 2.1 (and greater) devices indicate LPM support through
142 * their USB 2.0 Extended Capabilities BOS descriptor.
144 if (udev->speed == USB_SPEED_HIGH || udev->speed == USB_SPEED_FULL) {
145 if (udev->bos->ext_cap &&
147 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
153 * According to the USB 3.0 spec, all USB 3.0 devices must support LPM.
154 * However, there are some that don't, and they set the U1/U2 exit
157 if (!udev->bos->ss_cap) {
158 dev_info(&udev->dev, "No LPM exit latency info found, disabling LPM.\n");
162 if (udev->bos->ss_cap->bU1devExitLat == 0 &&
163 udev->bos->ss_cap->bU2DevExitLat == 0) {
165 dev_info(&udev->dev, "LPM exit latency is zeroed, disabling LPM.\n");
167 dev_info(&udev->dev, "We don't know the algorithms for LPM for this host, disabling LPM.\n");
171 if (!udev->parent || udev->parent->lpm_capable)
177 * Set the Maximum Exit Latency (MEL) for the host to initiate a transition from
180 static void usb_set_lpm_mel(struct usb_device *udev,
181 struct usb3_lpm_parameters *udev_lpm_params,
182 unsigned int udev_exit_latency,
184 struct usb3_lpm_parameters *hub_lpm_params,
185 unsigned int hub_exit_latency)
187 unsigned int total_mel;
188 unsigned int device_mel;
189 unsigned int hub_mel;
192 * Calculate the time it takes to transition all links from the roothub
193 * to the parent hub into U0. The parent hub must then decode the
194 * packet (hub header decode latency) to figure out which port it was
197 * The Hub Header decode latency is expressed in 0.1us intervals (0x1
198 * means 0.1us). Multiply that by 100 to get nanoseconds.
200 total_mel = hub_lpm_params->mel +
201 (hub->descriptor->u.ss.bHubHdrDecLat * 100);
204 * How long will it take to transition the downstream hub's port into
205 * U0? The greater of either the hub exit latency or the device exit
208 * The BOS U1/U2 exit latencies are expressed in 1us intervals.
209 * Multiply that by 1000 to get nanoseconds.
211 device_mel = udev_exit_latency * 1000;
212 hub_mel = hub_exit_latency * 1000;
213 if (device_mel > hub_mel)
214 total_mel += device_mel;
216 total_mel += hub_mel;
218 udev_lpm_params->mel = total_mel;
222 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
223 * a transition from either U1 or U2.
225 static void usb_set_lpm_pel(struct usb_device *udev,
226 struct usb3_lpm_parameters *udev_lpm_params,
227 unsigned int udev_exit_latency,
229 struct usb3_lpm_parameters *hub_lpm_params,
230 unsigned int hub_exit_latency,
231 unsigned int port_to_port_exit_latency)
233 unsigned int first_link_pel;
234 unsigned int hub_pel;
237 * First, the device sends an LFPS to transition the link between the
238 * device and the parent hub into U0. The exit latency is the bigger of
239 * the device exit latency or the hub exit latency.
241 if (udev_exit_latency > hub_exit_latency)
242 first_link_pel = udev_exit_latency * 1000;
244 first_link_pel = hub_exit_latency * 1000;
247 * When the hub starts to receive the LFPS, there is a slight delay for
248 * it to figure out that one of the ports is sending an LFPS. Then it
249 * will forward the LFPS to its upstream link. The exit latency is the
250 * delay, plus the PEL that we calculated for this hub.
252 hub_pel = port_to_port_exit_latency * 1000 + hub_lpm_params->pel;
255 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
256 * is the greater of the two exit latencies.
258 if (first_link_pel > hub_pel)
259 udev_lpm_params->pel = first_link_pel;
261 udev_lpm_params->pel = hub_pel;
265 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
266 * when a device initiates a transition to U0, until when it will receive the
267 * first packet from the host controller.
269 * Section C.1.5.1 describes the four components to this:
271 * - t2: time for the ERDY to make it from the device to the host.
272 * - t3: a host-specific delay to process the ERDY.
273 * - t4: time for the packet to make it from the host to the device.
275 * t3 is specific to both the xHCI host and the platform the host is integrated
276 * into. The Intel HW folks have said it's negligible, FIXME if a different
277 * vendor says otherwise.
279 static void usb_set_lpm_sel(struct usb_device *udev,
280 struct usb3_lpm_parameters *udev_lpm_params)
282 struct usb_device *parent;
283 unsigned int num_hubs;
284 unsigned int total_sel;
286 /* t1 = device PEL */
287 total_sel = udev_lpm_params->pel;
288 /* How many external hubs are in between the device & the root port. */
289 for (parent = udev->parent, num_hubs = 0; parent->parent;
290 parent = parent->parent)
292 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
294 total_sel += 2100 + 250 * (num_hubs - 1);
296 /* t4 = 250ns * num_hubs */
297 total_sel += 250 * num_hubs;
299 udev_lpm_params->sel = total_sel;
302 static void usb_set_lpm_parameters(struct usb_device *udev)
305 unsigned int port_to_port_delay;
306 unsigned int udev_u1_del;
307 unsigned int udev_u2_del;
308 unsigned int hub_u1_del;
309 unsigned int hub_u2_del;
311 if (!udev->lpm_capable || udev->speed < USB_SPEED_SUPER)
314 hub = usb_hub_to_struct_hub(udev->parent);
315 /* It doesn't take time to transition the roothub into U0, since it
316 * doesn't have an upstream link.
321 udev_u1_del = udev->bos->ss_cap->bU1devExitLat;
322 udev_u2_del = le16_to_cpu(udev->bos->ss_cap->bU2DevExitLat);
323 hub_u1_del = udev->parent->bos->ss_cap->bU1devExitLat;
324 hub_u2_del = le16_to_cpu(udev->parent->bos->ss_cap->bU2DevExitLat);
326 usb_set_lpm_mel(udev, &udev->u1_params, udev_u1_del,
327 hub, &udev->parent->u1_params, hub_u1_del);
329 usb_set_lpm_mel(udev, &udev->u2_params, udev_u2_del,
330 hub, &udev->parent->u2_params, hub_u2_del);
333 * Appendix C, section C.2.2.2, says that there is a slight delay from
334 * when the parent hub notices the downstream port is trying to
335 * transition to U0 to when the hub initiates a U0 transition on its
336 * upstream port. The section says the delays are tPort2PortU1EL and
337 * tPort2PortU2EL, but it doesn't define what they are.
339 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
340 * about the same delays. Use the maximum delay calculations from those
341 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
342 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
343 * assume the device exit latencies they are talking about are the hub
346 * What do we do if the U2 exit latency is less than the U1 exit
347 * latency? It's possible, although not likely...
349 port_to_port_delay = 1;
351 usb_set_lpm_pel(udev, &udev->u1_params, udev_u1_del,
352 hub, &udev->parent->u1_params, hub_u1_del,
355 if (hub_u2_del > hub_u1_del)
356 port_to_port_delay = 1 + hub_u2_del - hub_u1_del;
358 port_to_port_delay = 1 + hub_u1_del;
360 usb_set_lpm_pel(udev, &udev->u2_params, udev_u2_del,
361 hub, &udev->parent->u2_params, hub_u2_del,
364 /* Now that we've got PEL, calculate SEL. */
365 usb_set_lpm_sel(udev, &udev->u1_params);
366 usb_set_lpm_sel(udev, &udev->u2_params);
369 /* USB 2.0 spec Section 11.24.4.5 */
370 static int get_hub_descriptor(struct usb_device *hdev,
371 struct usb_hub_descriptor *desc)
376 if (hub_is_superspeed(hdev)) {
377 dtype = USB_DT_SS_HUB;
378 size = USB_DT_SS_HUB_SIZE;
381 size = sizeof(struct usb_hub_descriptor);
384 for (i = 0; i < 3; i++) {
385 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
386 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
387 dtype << 8, 0, desc, size,
388 USB_CTRL_GET_TIMEOUT);
389 if (hub_is_superspeed(hdev)) {
392 } else if (ret >= USB_DT_HUB_NONVAR_SIZE + 2) {
393 /* Make sure we have the DeviceRemovable field. */
394 size = USB_DT_HUB_NONVAR_SIZE + desc->bNbrPorts / 8 + 1;
404 * USB 2.0 spec Section 11.24.2.1
406 static int clear_hub_feature(struct usb_device *hdev, int feature)
408 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
409 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
413 * USB 2.0 spec Section 11.24.2.2
415 int usb_clear_port_feature(struct usb_device *hdev, int port1, int feature)
417 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
418 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
423 * USB 2.0 spec Section 11.24.2.13
425 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
427 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
428 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
432 static char *to_led_name(int selector)
449 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
450 * for info about using port indicators
452 static void set_port_led(struct usb_hub *hub, int port1, int selector)
454 struct usb_port *port_dev = hub->ports[port1 - 1];
457 status = set_port_feature(hub->hdev, (selector << 8) | port1,
458 USB_PORT_FEAT_INDICATOR);
459 dev_dbg(&port_dev->dev, "indicator %s status %d\n",
460 to_led_name(selector), status);
463 #define LED_CYCLE_PERIOD ((2*HZ)/3)
465 static void led_work(struct work_struct *work)
467 struct usb_hub *hub =
468 container_of(work, struct usb_hub, leds.work);
469 struct usb_device *hdev = hub->hdev;
471 unsigned changed = 0;
474 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
477 for (i = 0; i < hdev->maxchild; i++) {
478 unsigned selector, mode;
480 /* 30%-50% duty cycle */
482 switch (hub->indicator[i]) {
484 case INDICATOR_CYCLE:
486 selector = HUB_LED_AUTO;
487 mode = INDICATOR_AUTO;
489 /* blinking green = sw attention */
490 case INDICATOR_GREEN_BLINK:
491 selector = HUB_LED_GREEN;
492 mode = INDICATOR_GREEN_BLINK_OFF;
494 case INDICATOR_GREEN_BLINK_OFF:
495 selector = HUB_LED_OFF;
496 mode = INDICATOR_GREEN_BLINK;
498 /* blinking amber = hw attention */
499 case INDICATOR_AMBER_BLINK:
500 selector = HUB_LED_AMBER;
501 mode = INDICATOR_AMBER_BLINK_OFF;
503 case INDICATOR_AMBER_BLINK_OFF:
504 selector = HUB_LED_OFF;
505 mode = INDICATOR_AMBER_BLINK;
507 /* blink green/amber = reserved */
508 case INDICATOR_ALT_BLINK:
509 selector = HUB_LED_GREEN;
510 mode = INDICATOR_ALT_BLINK_OFF;
512 case INDICATOR_ALT_BLINK_OFF:
513 selector = HUB_LED_AMBER;
514 mode = INDICATOR_ALT_BLINK;
519 if (selector != HUB_LED_AUTO)
521 set_port_led(hub, i + 1, selector);
522 hub->indicator[i] = mode;
524 if (!changed && blinkenlights) {
526 cursor %= hdev->maxchild;
527 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
528 hub->indicator[cursor] = INDICATOR_CYCLE;
532 queue_delayed_work(system_power_efficient_wq,
533 &hub->leds, LED_CYCLE_PERIOD);
536 /* use a short timeout for hub/port status fetches */
537 #define USB_STS_TIMEOUT 1000
538 #define USB_STS_RETRIES 5
541 * USB 2.0 spec Section 11.24.2.6
543 static int get_hub_status(struct usb_device *hdev,
544 struct usb_hub_status *data)
546 int i, status = -ETIMEDOUT;
548 for (i = 0; i < USB_STS_RETRIES &&
549 (status == -ETIMEDOUT || status == -EPIPE); i++) {
550 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
551 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
552 data, sizeof(*data), USB_STS_TIMEOUT);
558 * USB 2.0 spec Section 11.24.2.7
559 * USB 3.1 takes into use the wValue and wLength fields, spec Section 10.16.2.6
561 static int get_port_status(struct usb_device *hdev, int port1,
562 void *data, u16 value, u16 length)
564 int i, status = -ETIMEDOUT;
566 for (i = 0; i < USB_STS_RETRIES &&
567 (status == -ETIMEDOUT || status == -EPIPE); i++) {
568 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
569 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, value,
570 port1, data, length, USB_STS_TIMEOUT);
575 static int hub_ext_port_status(struct usb_hub *hub, int port1, int type,
576 u16 *status, u16 *change, u32 *ext_status)
581 if (type != HUB_PORT_STATUS)
584 mutex_lock(&hub->status_mutex);
585 ret = get_port_status(hub->hdev, port1, &hub->status->port, type, len);
588 dev_err(hub->intfdev,
589 "%s failed (err = %d)\n", __func__, ret);
593 *status = le16_to_cpu(hub->status->port.wPortStatus);
594 *change = le16_to_cpu(hub->status->port.wPortChange);
595 if (type != HUB_PORT_STATUS && ext_status)
596 *ext_status = le32_to_cpu(
597 hub->status->port.dwExtPortStatus);
600 mutex_unlock(&hub->status_mutex);
604 static int hub_port_status(struct usb_hub *hub, int port1,
605 u16 *status, u16 *change)
607 return hub_ext_port_status(hub, port1, HUB_PORT_STATUS,
608 status, change, NULL);
611 static void kick_hub_wq(struct usb_hub *hub)
613 struct usb_interface *intf;
615 if (hub->disconnected || work_pending(&hub->events))
619 * Suppress autosuspend until the event is proceed.
621 * Be careful and make sure that the symmetric operation is
622 * always called. We are here only when there is no pending
623 * work for this hub. Therefore put the interface either when
624 * the new work is called or when it is canceled.
626 intf = to_usb_interface(hub->intfdev);
627 usb_autopm_get_interface_no_resume(intf);
628 kref_get(&hub->kref);
630 if (queue_work(hub_wq, &hub->events))
633 /* the work has already been scheduled */
634 usb_autopm_put_interface_async(intf);
635 kref_put(&hub->kref, hub_release);
638 void usb_kick_hub_wq(struct usb_device *hdev)
640 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
647 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
648 * Notification, which indicates it had initiated remote wakeup.
650 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
651 * device initiates resume, so the USB core will not receive notice of the
652 * resume through the normal hub interrupt URB.
654 void usb_wakeup_notification(struct usb_device *hdev,
655 unsigned int portnum)
658 struct usb_port *port_dev;
663 hub = usb_hub_to_struct_hub(hdev);
665 port_dev = hub->ports[portnum - 1];
666 if (port_dev && port_dev->child)
667 pm_wakeup_event(&port_dev->child->dev, 0);
669 set_bit(portnum, hub->wakeup_bits);
673 EXPORT_SYMBOL_GPL(usb_wakeup_notification);
675 /* completion function, fires on port status changes and various faults */
676 static void hub_irq(struct urb *urb)
678 struct usb_hub *hub = urb->context;
679 int status = urb->status;
684 case -ENOENT: /* synchronous unlink */
685 case -ECONNRESET: /* async unlink */
686 case -ESHUTDOWN: /* hardware going away */
689 default: /* presumably an error */
690 /* Cause a hub reset after 10 consecutive errors */
691 dev_dbg(hub->intfdev, "transfer --> %d\n", status);
692 if ((++hub->nerrors < 10) || hub->error)
697 /* let hub_wq handle things */
698 case 0: /* we got data: port status changed */
700 for (i = 0; i < urb->actual_length; ++i)
701 bits |= ((unsigned long) ((*hub->buffer)[i]))
703 hub->event_bits[0] = bits;
709 /* Something happened, let hub_wq figure it out */
716 status = usb_submit_urb(hub->urb, GFP_ATOMIC);
717 if (status != 0 && status != -ENODEV && status != -EPERM)
718 dev_err(hub->intfdev, "resubmit --> %d\n", status);
721 /* USB 2.0 spec Section 11.24.2.3 */
723 hub_clear_tt_buffer(struct usb_device *hdev, u16 devinfo, u16 tt)
725 /* Need to clear both directions for control ep */
726 if (((devinfo >> 11) & USB_ENDPOINT_XFERTYPE_MASK) ==
727 USB_ENDPOINT_XFER_CONTROL) {
728 int status = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
729 HUB_CLEAR_TT_BUFFER, USB_RT_PORT,
730 devinfo ^ 0x8000, tt, NULL, 0, 1000);
734 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
735 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
740 * enumeration blocks hub_wq for a long time. we use keventd instead, since
741 * long blocking there is the exception, not the rule. accordingly, HCDs
742 * talking to TTs must queue control transfers (not just bulk and iso), so
743 * both can talk to the same hub concurrently.
745 static void hub_tt_work(struct work_struct *work)
747 struct usb_hub *hub =
748 container_of(work, struct usb_hub, tt.clear_work);
751 spin_lock_irqsave(&hub->tt.lock, flags);
752 while (!list_empty(&hub->tt.clear_list)) {
753 struct list_head *next;
754 struct usb_tt_clear *clear;
755 struct usb_device *hdev = hub->hdev;
756 const struct hc_driver *drv;
759 next = hub->tt.clear_list.next;
760 clear = list_entry(next, struct usb_tt_clear, clear_list);
761 list_del(&clear->clear_list);
763 /* drop lock so HCD can concurrently report other TT errors */
764 spin_unlock_irqrestore(&hub->tt.lock, flags);
765 status = hub_clear_tt_buffer(hdev, clear->devinfo, clear->tt);
766 if (status && status != -ENODEV)
768 "clear tt %d (%04x) error %d\n",
769 clear->tt, clear->devinfo, status);
771 /* Tell the HCD, even if the operation failed */
772 drv = clear->hcd->driver;
773 if (drv->clear_tt_buffer_complete)
774 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
777 spin_lock_irqsave(&hub->tt.lock, flags);
779 spin_unlock_irqrestore(&hub->tt.lock, flags);
783 * usb_hub_set_port_power - control hub port's power state
784 * @hdev: USB device belonging to the usb hub
787 * @set: expected status
789 * call this function to control port's power via setting or
790 * clearing the port's PORT_POWER feature.
792 * Return: 0 if successful. A negative error code otherwise.
794 int usb_hub_set_port_power(struct usb_device *hdev, struct usb_hub *hub,
800 ret = set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
802 ret = usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
808 set_bit(port1, hub->power_bits);
810 clear_bit(port1, hub->power_bits);
815 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
816 * @urb: an URB associated with the failed or incomplete split transaction
818 * High speed HCDs use this to tell the hub driver that some split control or
819 * bulk transaction failed in a way that requires clearing internal state of
820 * a transaction translator. This is normally detected (and reported) from
823 * It may not be possible for that hub to handle additional full (or low)
824 * speed transactions until that state is fully cleared out.
826 * Return: 0 if successful. A negative error code otherwise.
828 int usb_hub_clear_tt_buffer(struct urb *urb)
830 struct usb_device *udev = urb->dev;
831 int pipe = urb->pipe;
832 struct usb_tt *tt = udev->tt;
834 struct usb_tt_clear *clear;
836 /* we've got to cope with an arbitrary number of pending TT clears,
837 * since each TT has "at least two" buffers that can need it (and
838 * there can be many TTs per hub). even if they're uncommon.
840 clear = kmalloc(sizeof *clear, GFP_ATOMIC);
842 dev_err(&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
843 /* FIXME recover somehow ... RESET_TT? */
847 /* info that CLEAR_TT_BUFFER needs */
848 clear->tt = tt->multi ? udev->ttport : 1;
849 clear->devinfo = usb_pipeendpoint (pipe);
850 clear->devinfo |= udev->devnum << 4;
851 clear->devinfo |= usb_pipecontrol(pipe)
852 ? (USB_ENDPOINT_XFER_CONTROL << 11)
853 : (USB_ENDPOINT_XFER_BULK << 11);
854 if (usb_pipein(pipe))
855 clear->devinfo |= 1 << 15;
857 /* info for completion callback */
858 clear->hcd = bus_to_hcd(udev->bus);
861 /* tell keventd to clear state for this TT */
862 spin_lock_irqsave(&tt->lock, flags);
863 list_add_tail(&clear->clear_list, &tt->clear_list);
864 schedule_work(&tt->clear_work);
865 spin_unlock_irqrestore(&tt->lock, flags);
868 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
870 static void hub_power_on(struct usb_hub *hub, bool do_delay)
874 /* Enable power on each port. Some hubs have reserved values
875 * of LPSM (> 2) in their descriptors, even though they are
876 * USB 2.0 hubs. Some hubs do not implement port-power switching
877 * but only emulate it. In all cases, the ports won't work
878 * unless we send these messages to the hub.
880 if (hub_is_port_power_switchable(hub))
881 dev_dbg(hub->intfdev, "enabling power on all ports\n");
883 dev_dbg(hub->intfdev, "trying to enable port power on "
884 "non-switchable hub\n");
885 for (port1 = 1; port1 <= hub->hdev->maxchild; port1++)
886 if (test_bit(port1, hub->power_bits))
887 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
889 usb_clear_port_feature(hub->hdev, port1,
890 USB_PORT_FEAT_POWER);
892 msleep(hub_power_on_good_delay(hub));
895 static int hub_hub_status(struct usb_hub *hub,
896 u16 *status, u16 *change)
900 mutex_lock(&hub->status_mutex);
901 ret = get_hub_status(hub->hdev, &hub->status->hub);
904 dev_err(hub->intfdev,
905 "%s failed (err = %d)\n", __func__, ret);
907 *status = le16_to_cpu(hub->status->hub.wHubStatus);
908 *change = le16_to_cpu(hub->status->hub.wHubChange);
911 mutex_unlock(&hub->status_mutex);
915 static int hub_set_port_link_state(struct usb_hub *hub, int port1,
916 unsigned int link_status)
918 return set_port_feature(hub->hdev,
919 port1 | (link_status << 3),
920 USB_PORT_FEAT_LINK_STATE);
924 * Disable a port and mark a logical connect-change event, so that some
925 * time later hub_wq will disconnect() any existing usb_device on the port
926 * and will re-enumerate if there actually is a device attached.
928 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
930 dev_dbg(&hub->ports[port1 - 1]->dev, "logical disconnect\n");
931 hub_port_disable(hub, port1, 1);
933 /* FIXME let caller ask to power down the port:
934 * - some devices won't enumerate without a VBUS power cycle
935 * - SRP saves power that way
936 * - ... new call, TBD ...
937 * That's easy if this hub can switch power per-port, and
938 * hub_wq reactivates the port later (timer, SRP, etc).
939 * Powerdown must be optional, because of reset/DFU.
942 set_bit(port1, hub->change_bits);
947 * usb_remove_device - disable a device's port on its parent hub
948 * @udev: device to be disabled and removed
949 * Context: @udev locked, must be able to sleep.
951 * After @udev's port has been disabled, hub_wq is notified and it will
952 * see that the device has been disconnected. When the device is
953 * physically unplugged and something is plugged in, the events will
954 * be received and processed normally.
956 * Return: 0 if successful. A negative error code otherwise.
958 int usb_remove_device(struct usb_device *udev)
961 struct usb_interface *intf;
963 if (!udev->parent) /* Can't remove a root hub */
965 hub = usb_hub_to_struct_hub(udev->parent);
966 intf = to_usb_interface(hub->intfdev);
968 usb_autopm_get_interface(intf);
969 set_bit(udev->portnum, hub->removed_bits);
970 hub_port_logical_disconnect(hub, udev->portnum);
971 usb_autopm_put_interface(intf);
975 enum hub_activation_type {
976 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
977 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
980 static void hub_init_func2(struct work_struct *ws);
981 static void hub_init_func3(struct work_struct *ws);
983 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
985 struct usb_device *hdev = hub->hdev;
990 bool need_debounce_delay = false;
993 /* Continue a partial initialization */
994 if (type == HUB_INIT2 || type == HUB_INIT3) {
995 device_lock(&hdev->dev);
997 /* Was the hub disconnected while we were waiting? */
998 if (hub->disconnected)
1000 if (type == HUB_INIT2)
1004 kref_get(&hub->kref);
1006 /* The superspeed hub except for root hub has to use Hub Depth
1007 * value as an offset into the route string to locate the bits
1008 * it uses to determine the downstream port number. So hub driver
1009 * should send a set hub depth request to superspeed hub after
1010 * the superspeed hub is set configuration in initialization or
1013 * After a resume, port power should still be on.
1014 * For any other type of activation, turn it on.
1016 if (type != HUB_RESUME) {
1017 if (hdev->parent && hub_is_superspeed(hdev)) {
1018 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
1019 HUB_SET_DEPTH, USB_RT_HUB,
1020 hdev->level - 1, 0, NULL, 0,
1021 USB_CTRL_SET_TIMEOUT);
1023 dev_err(hub->intfdev,
1024 "set hub depth failed\n");
1027 /* Speed up system boot by using a delayed_work for the
1028 * hub's initial power-up delays. This is pretty awkward
1029 * and the implementation looks like a home-brewed sort of
1030 * setjmp/longjmp, but it saves at least 100 ms for each
1031 * root hub (assuming usbcore is compiled into the kernel
1032 * rather than as a module). It adds up.
1034 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1035 * because for those activation types the ports have to be
1036 * operational when we return. In theory this could be done
1037 * for HUB_POST_RESET, but it's easier not to.
1039 if (type == HUB_INIT) {
1040 delay = hub_power_on_good_delay(hub);
1042 hub_power_on(hub, false);
1043 INIT_DELAYED_WORK(&hub->init_work, hub_init_func2);
1044 queue_delayed_work(system_power_efficient_wq,
1046 msecs_to_jiffies(delay));
1048 /* Suppress autosuspend until init is done */
1049 usb_autopm_get_interface_no_resume(
1050 to_usb_interface(hub->intfdev));
1051 return; /* Continues at init2: below */
1052 } else if (type == HUB_RESET_RESUME) {
1053 /* The internal host controller state for the hub device
1054 * may be gone after a host power loss on system resume.
1055 * Update the device's info so the HW knows it's a hub.
1057 hcd = bus_to_hcd(hdev->bus);
1058 if (hcd->driver->update_hub_device) {
1059 ret = hcd->driver->update_hub_device(hcd, hdev,
1060 &hub->tt, GFP_NOIO);
1062 dev_err(hub->intfdev,
1063 "Host not accepting hub info update\n");
1064 dev_err(hub->intfdev,
1065 "LS/FS devices and hubs may not work under this hub\n");
1068 hub_power_on(hub, true);
1070 hub_power_on(hub, true);
1076 * Check each port and set hub->change_bits to let hub_wq know
1077 * which ports need attention.
1079 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
1080 struct usb_port *port_dev = hub->ports[port1 - 1];
1081 struct usb_device *udev = port_dev->child;
1082 u16 portstatus, portchange;
1084 portstatus = portchange = 0;
1085 status = hub_port_status(hub, port1, &portstatus, &portchange);
1089 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1090 dev_dbg(&port_dev->dev, "status %04x change %04x\n",
1091 portstatus, portchange);
1094 * After anything other than HUB_RESUME (i.e., initialization
1095 * or any sort of reset), every port should be disabled.
1096 * Unconnected ports should likewise be disabled (paranoia),
1097 * and so should ports for which we have no usb_device.
1099 if ((portstatus & USB_PORT_STAT_ENABLE) && (
1100 type != HUB_RESUME ||
1101 !(portstatus & USB_PORT_STAT_CONNECTION) ||
1103 udev->state == USB_STATE_NOTATTACHED)) {
1105 * USB3 protocol ports will automatically transition
1106 * to Enabled state when detect an USB3.0 device attach.
1107 * Do not disable USB3 protocol ports, just pretend
1110 portstatus &= ~USB_PORT_STAT_ENABLE;
1111 if (!hub_is_superspeed(hdev))
1112 usb_clear_port_feature(hdev, port1,
1113 USB_PORT_FEAT_ENABLE);
1116 /* Make sure a warm-reset request is handled by port_event */
1117 if (type == HUB_RESUME &&
1118 hub_port_warm_reset_required(hub, port1, portstatus))
1119 set_bit(port1, hub->event_bits);
1122 * Add debounce if USB3 link is in polling/link training state.
1123 * Link will automatically transition to Enabled state after
1124 * link training completes.
1126 if (hub_is_superspeed(hdev) &&
1127 ((portstatus & USB_PORT_STAT_LINK_STATE) ==
1128 USB_SS_PORT_LS_POLLING))
1129 need_debounce_delay = true;
1131 /* Clear status-change flags; we'll debounce later */
1132 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1133 need_debounce_delay = true;
1134 usb_clear_port_feature(hub->hdev, port1,
1135 USB_PORT_FEAT_C_CONNECTION);
1137 if (portchange & USB_PORT_STAT_C_ENABLE) {
1138 need_debounce_delay = true;
1139 usb_clear_port_feature(hub->hdev, port1,
1140 USB_PORT_FEAT_C_ENABLE);
1142 if (portchange & USB_PORT_STAT_C_RESET) {
1143 need_debounce_delay = true;
1144 usb_clear_port_feature(hub->hdev, port1,
1145 USB_PORT_FEAT_C_RESET);
1147 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
1148 hub_is_superspeed(hub->hdev)) {
1149 need_debounce_delay = true;
1150 usb_clear_port_feature(hub->hdev, port1,
1151 USB_PORT_FEAT_C_BH_PORT_RESET);
1153 /* We can forget about a "removed" device when there's a
1154 * physical disconnect or the connect status changes.
1156 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
1157 (portchange & USB_PORT_STAT_C_CONNECTION))
1158 clear_bit(port1, hub->removed_bits);
1160 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
1161 /* Tell hub_wq to disconnect the device or
1162 * check for a new connection or over current condition.
1163 * Based on USB2.0 Spec Section 11.12.5,
1164 * C_PORT_OVER_CURRENT could be set while
1165 * PORT_OVER_CURRENT is not. So check for any of them.
1167 if (udev || (portstatus & USB_PORT_STAT_CONNECTION) ||
1168 (portstatus & USB_PORT_STAT_OVERCURRENT) ||
1169 (portchange & USB_PORT_STAT_C_OVERCURRENT))
1170 set_bit(port1, hub->change_bits);
1172 } else if (portstatus & USB_PORT_STAT_ENABLE) {
1173 bool port_resumed = (portstatus &
1174 USB_PORT_STAT_LINK_STATE) ==
1176 /* The power session apparently survived the resume.
1177 * If there was an overcurrent or suspend change
1178 * (i.e., remote wakeup request), have hub_wq
1179 * take care of it. Look at the port link state
1180 * for USB 3.0 hubs, since they don't have a suspend
1181 * change bit, and they don't set the port link change
1182 * bit on device-initiated resume.
1184 if (portchange || (hub_is_superspeed(hub->hdev) &&
1186 set_bit(port1, hub->change_bits);
1188 } else if (udev->persist_enabled) {
1190 udev->reset_resume = 1;
1192 /* Don't set the change_bits when the device
1195 if (test_bit(port1, hub->power_bits))
1196 set_bit(port1, hub->change_bits);
1199 /* The power session is gone; tell hub_wq */
1200 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1201 set_bit(port1, hub->change_bits);
1205 /* If no port-status-change flags were set, we don't need any
1206 * debouncing. If flags were set we can try to debounce the
1207 * ports all at once right now, instead of letting hub_wq do them
1208 * one at a time later on.
1210 * If any port-status changes do occur during this delay, hub_wq
1211 * will see them later and handle them normally.
1213 if (need_debounce_delay) {
1214 delay = HUB_DEBOUNCE_STABLE;
1216 /* Don't do a long sleep inside a workqueue routine */
1217 if (type == HUB_INIT2) {
1218 INIT_DELAYED_WORK(&hub->init_work, hub_init_func3);
1219 queue_delayed_work(system_power_efficient_wq,
1221 msecs_to_jiffies(delay));
1222 device_unlock(&hdev->dev);
1223 return; /* Continues at init3: below */
1231 status = usb_submit_urb(hub->urb, GFP_NOIO);
1233 dev_err(hub->intfdev, "activate --> %d\n", status);
1234 if (hub->has_indicators && blinkenlights)
1235 queue_delayed_work(system_power_efficient_wq,
1236 &hub->leds, LED_CYCLE_PERIOD);
1238 /* Scan all ports that need attention */
1241 if (type == HUB_INIT2 || type == HUB_INIT3) {
1242 /* Allow autosuspend if it was suppressed */
1244 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
1245 device_unlock(&hdev->dev);
1248 kref_put(&hub->kref, hub_release);
1251 /* Implement the continuations for the delays above */
1252 static void hub_init_func2(struct work_struct *ws)
1254 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1256 hub_activate(hub, HUB_INIT2);
1259 static void hub_init_func3(struct work_struct *ws)
1261 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1263 hub_activate(hub, HUB_INIT3);
1266 enum hub_quiescing_type {
1267 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
1270 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
1272 struct usb_device *hdev = hub->hdev;
1275 /* hub_wq and related activity won't re-trigger */
1278 if (type != HUB_SUSPEND) {
1279 /* Disconnect all the children */
1280 for (i = 0; i < hdev->maxchild; ++i) {
1281 if (hub->ports[i]->child)
1282 usb_disconnect(&hub->ports[i]->child);
1286 /* Stop hub_wq and related activity */
1287 usb_kill_urb(hub->urb);
1288 if (hub->has_indicators)
1289 cancel_delayed_work_sync(&hub->leds);
1291 flush_work(&hub->tt.clear_work);
1294 static void hub_pm_barrier_for_all_ports(struct usb_hub *hub)
1298 for (i = 0; i < hub->hdev->maxchild; ++i)
1299 pm_runtime_barrier(&hub->ports[i]->dev);
1302 /* caller has locked the hub device */
1303 static int hub_pre_reset(struct usb_interface *intf)
1305 struct usb_hub *hub = usb_get_intfdata(intf);
1307 hub_quiesce(hub, HUB_PRE_RESET);
1309 hub_pm_barrier_for_all_ports(hub);
1313 /* caller has locked the hub device */
1314 static int hub_post_reset(struct usb_interface *intf)
1316 struct usb_hub *hub = usb_get_intfdata(intf);
1319 hub_pm_barrier_for_all_ports(hub);
1320 hub_activate(hub, HUB_POST_RESET);
1324 static int hub_configure(struct usb_hub *hub,
1325 struct usb_endpoint_descriptor *endpoint)
1327 struct usb_hcd *hcd;
1328 struct usb_device *hdev = hub->hdev;
1329 struct device *hub_dev = hub->intfdev;
1330 u16 hubstatus, hubchange;
1331 u16 wHubCharacteristics;
1334 char *message = "out of memory";
1339 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
1345 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1350 mutex_init(&hub->status_mutex);
1352 hub->descriptor = kzalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1353 if (!hub->descriptor) {
1358 /* Request the entire hub descriptor.
1359 * hub->descriptor can handle USB_MAXCHILDREN ports,
1360 * but a (non-SS) hub can/will return fewer bytes here.
1362 ret = get_hub_descriptor(hdev, hub->descriptor);
1364 message = "can't read hub descriptor";
1368 maxchild = USB_MAXCHILDREN;
1369 if (hub_is_superspeed(hdev))
1370 maxchild = min_t(unsigned, maxchild, USB_SS_MAXPORTS);
1372 if (hub->descriptor->bNbrPorts > maxchild) {
1373 message = "hub has too many ports!";
1376 } else if (hub->descriptor->bNbrPorts == 0) {
1377 message = "hub doesn't have any ports!";
1383 * Accumulate wHubDelay + 40ns for every hub in the tree of devices.
1384 * The resulting value will be used for SetIsochDelay() request.
1386 if (hub_is_superspeed(hdev) || hub_is_superspeedplus(hdev)) {
1387 u32 delay = __le16_to_cpu(hub->descriptor->u.ss.wHubDelay);
1390 delay += hdev->parent->hub_delay;
1392 delay += USB_TP_TRANSMISSION_DELAY;
1393 hdev->hub_delay = min_t(u32, delay, USB_TP_TRANSMISSION_DELAY_MAX);
1396 maxchild = hub->descriptor->bNbrPorts;
1397 dev_info(hub_dev, "%d port%s detected\n", maxchild,
1398 (maxchild == 1) ? "" : "s");
1400 hub->ports = kcalloc(maxchild, sizeof(struct usb_port *), GFP_KERNEL);
1406 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1407 if (hub_is_superspeed(hdev)) {
1415 /* FIXME for USB 3.0, skip for now */
1416 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1417 !(hub_is_superspeed(hdev))) {
1418 char portstr[USB_MAXCHILDREN + 1];
1420 for (i = 0; i < maxchild; i++)
1421 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1422 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1424 portstr[maxchild] = 0;
1425 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1427 dev_dbg(hub_dev, "standalone hub\n");
1429 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1430 case HUB_CHAR_COMMON_LPSM:
1431 dev_dbg(hub_dev, "ganged power switching\n");
1433 case HUB_CHAR_INDV_PORT_LPSM:
1434 dev_dbg(hub_dev, "individual port power switching\n");
1436 case HUB_CHAR_NO_LPSM:
1438 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1442 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1443 case HUB_CHAR_COMMON_OCPM:
1444 dev_dbg(hub_dev, "global over-current protection\n");
1446 case HUB_CHAR_INDV_PORT_OCPM:
1447 dev_dbg(hub_dev, "individual port over-current protection\n");
1449 case HUB_CHAR_NO_OCPM:
1451 dev_dbg(hub_dev, "no over-current protection\n");
1455 spin_lock_init(&hub->tt.lock);
1456 INIT_LIST_HEAD(&hub->tt.clear_list);
1457 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1458 switch (hdev->descriptor.bDeviceProtocol) {
1461 case USB_HUB_PR_HS_SINGLE_TT:
1462 dev_dbg(hub_dev, "Single TT\n");
1465 case USB_HUB_PR_HS_MULTI_TT:
1466 ret = usb_set_interface(hdev, 0, 1);
1468 dev_dbg(hub_dev, "TT per port\n");
1471 dev_err(hub_dev, "Using single TT (err %d)\n",
1476 /* USB 3.0 hubs don't have a TT */
1479 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1480 hdev->descriptor.bDeviceProtocol);
1484 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1485 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1486 case HUB_TTTT_8_BITS:
1487 if (hdev->descriptor.bDeviceProtocol != 0) {
1488 hub->tt.think_time = 666;
1489 dev_dbg(hub_dev, "TT requires at most %d "
1490 "FS bit times (%d ns)\n",
1491 8, hub->tt.think_time);
1494 case HUB_TTTT_16_BITS:
1495 hub->tt.think_time = 666 * 2;
1496 dev_dbg(hub_dev, "TT requires at most %d "
1497 "FS bit times (%d ns)\n",
1498 16, hub->tt.think_time);
1500 case HUB_TTTT_24_BITS:
1501 hub->tt.think_time = 666 * 3;
1502 dev_dbg(hub_dev, "TT requires at most %d "
1503 "FS bit times (%d ns)\n",
1504 24, hub->tt.think_time);
1506 case HUB_TTTT_32_BITS:
1507 hub->tt.think_time = 666 * 4;
1508 dev_dbg(hub_dev, "TT requires at most %d "
1509 "FS bit times (%d ns)\n",
1510 32, hub->tt.think_time);
1514 /* probe() zeroes hub->indicator[] */
1515 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1516 hub->has_indicators = 1;
1517 dev_dbg(hub_dev, "Port indicators are supported\n");
1520 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1521 hub->descriptor->bPwrOn2PwrGood * 2);
1523 /* power budgeting mostly matters with bus-powered hubs,
1524 * and battery-powered root hubs (may provide just 8 mA).
1526 ret = usb_get_std_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1528 message = "can't get hub status";
1531 hcd = bus_to_hcd(hdev->bus);
1532 if (hdev == hdev->bus->root_hub) {
1533 if (hcd->power_budget > 0)
1534 hdev->bus_mA = hcd->power_budget;
1536 hdev->bus_mA = full_load * maxchild;
1537 if (hdev->bus_mA >= full_load)
1538 hub->mA_per_port = full_load;
1540 hub->mA_per_port = hdev->bus_mA;
1541 hub->limited_power = 1;
1543 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1544 int remaining = hdev->bus_mA -
1545 hub->descriptor->bHubContrCurrent;
1547 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1548 hub->descriptor->bHubContrCurrent);
1549 hub->limited_power = 1;
1551 if (remaining < maxchild * unit_load)
1553 "insufficient power available "
1554 "to use all downstream ports\n");
1555 hub->mA_per_port = unit_load; /* 7.2.1 */
1557 } else { /* Self-powered external hub */
1558 /* FIXME: What about battery-powered external hubs that
1559 * provide less current per port? */
1560 hub->mA_per_port = full_load;
1562 if (hub->mA_per_port < full_load)
1563 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1566 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1568 message = "can't get hub status";
1572 /* local power status reports aren't always correct */
1573 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1574 dev_dbg(hub_dev, "local power source is %s\n",
1575 (hubstatus & HUB_STATUS_LOCAL_POWER)
1576 ? "lost (inactive)" : "good");
1578 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1579 dev_dbg(hub_dev, "%sover-current condition exists\n",
1580 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1582 /* set up the interrupt endpoint
1583 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1584 * bytes as USB2.0[11.12.3] says because some hubs are known
1585 * to send more data (and thus cause overflow). For root hubs,
1586 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1587 * to be big enough for at least USB_MAXCHILDREN ports. */
1588 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1589 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1591 if (maxp > sizeof(*hub->buffer))
1592 maxp = sizeof(*hub->buffer);
1594 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1600 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1601 hub, endpoint->bInterval);
1603 /* maybe cycle the hub leds */
1604 if (hub->has_indicators && blinkenlights)
1605 hub->indicator[0] = INDICATOR_CYCLE;
1607 mutex_lock(&usb_port_peer_mutex);
1608 for (i = 0; i < maxchild; i++) {
1609 ret = usb_hub_create_port_device(hub, i + 1);
1611 dev_err(hub->intfdev,
1612 "couldn't create port%d device.\n", i + 1);
1617 for (i = 0; i < hdev->maxchild; i++) {
1618 struct usb_port *port_dev = hub->ports[i];
1620 pm_runtime_put(&port_dev->dev);
1623 mutex_unlock(&usb_port_peer_mutex);
1627 /* Update the HCD's internal representation of this hub before hub_wq
1628 * starts getting port status changes for devices under the hub.
1630 if (hcd->driver->update_hub_device) {
1631 ret = hcd->driver->update_hub_device(hcd, hdev,
1632 &hub->tt, GFP_KERNEL);
1634 message = "can't update HCD hub info";
1639 usb_hub_adjust_deviceremovable(hdev, hub->descriptor);
1641 hub_activate(hub, HUB_INIT);
1645 dev_err(hub_dev, "config failed, %s (err %d)\n",
1647 /* hub_disconnect() frees urb and descriptor */
1651 static void hub_release(struct kref *kref)
1653 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1655 usb_put_dev(hub->hdev);
1656 usb_put_intf(to_usb_interface(hub->intfdev));
1660 static unsigned highspeed_hubs;
1662 static void hub_disconnect(struct usb_interface *intf)
1664 struct usb_hub *hub = usb_get_intfdata(intf);
1665 struct usb_device *hdev = interface_to_usbdev(intf);
1669 * Stop adding new hub events. We do not want to block here and thus
1670 * will not try to remove any pending work item.
1672 hub->disconnected = 1;
1674 /* Disconnect all children and quiesce the hub */
1676 hub_quiesce(hub, HUB_DISCONNECT);
1678 mutex_lock(&usb_port_peer_mutex);
1680 /* Avoid races with recursively_mark_NOTATTACHED() */
1681 spin_lock_irq(&device_state_lock);
1682 port1 = hdev->maxchild;
1684 usb_set_intfdata(intf, NULL);
1685 spin_unlock_irq(&device_state_lock);
1687 for (; port1 > 0; --port1)
1688 usb_hub_remove_port_device(hub, port1);
1690 mutex_unlock(&usb_port_peer_mutex);
1692 if (hub->hdev->speed == USB_SPEED_HIGH)
1695 usb_free_urb(hub->urb);
1697 kfree(hub->descriptor);
1701 pm_suspend_ignore_children(&intf->dev, false);
1702 kref_put(&hub->kref, hub_release);
1705 static bool hub_descriptor_is_sane(struct usb_host_interface *desc)
1707 /* Some hubs have a subclass of 1, which AFAICT according to the */
1708 /* specs is not defined, but it works */
1709 if (desc->desc.bInterfaceSubClass != 0 &&
1710 desc->desc.bInterfaceSubClass != 1)
1713 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1714 if (desc->desc.bNumEndpoints != 1)
1717 /* If the first endpoint is not interrupt IN, we'd better punt! */
1718 if (!usb_endpoint_is_int_in(&desc->endpoint[0].desc))
1724 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1726 struct usb_host_interface *desc;
1727 struct usb_device *hdev;
1728 struct usb_hub *hub;
1730 desc = intf->cur_altsetting;
1731 hdev = interface_to_usbdev(intf);
1734 * Set default autosuspend delay as 0 to speedup bus suspend,
1735 * based on the below considerations:
1737 * - Unlike other drivers, the hub driver does not rely on the
1738 * autosuspend delay to provide enough time to handle a wakeup
1739 * event, and the submitted status URB is just to check future
1740 * change on hub downstream ports, so it is safe to do it.
1742 * - The patch might cause one or more auto supend/resume for
1743 * below very rare devices when they are plugged into hub
1746 * devices having trouble initializing, and disconnect
1747 * themselves from the bus and then reconnect a second
1750 * devices just for downloading firmware, and disconnects
1751 * themselves after completing it
1753 * For these quite rare devices, their drivers may change the
1754 * autosuspend delay of their parent hub in the probe() to one
1755 * appropriate value to avoid the subtle problem if someone
1758 * - The patch may cause one or more auto suspend/resume on
1759 * hub during running 'lsusb', but it is probably too
1760 * infrequent to worry about.
1762 * - Change autosuspend delay of hub can avoid unnecessary auto
1763 * suspend timer for hub, also may decrease power consumption
1766 * - If user has indicated to prevent autosuspend by passing
1767 * usbcore.autosuspend = -1 then keep autosuspend disabled.
1770 if (hdev->dev.power.autosuspend_delay >= 0)
1771 pm_runtime_set_autosuspend_delay(&hdev->dev, 0);
1775 * Hubs have proper suspend/resume support, except for root hubs
1776 * where the controller driver doesn't have bus_suspend and
1777 * bus_resume methods.
1779 if (hdev->parent) { /* normal device */
1780 usb_enable_autosuspend(hdev);
1781 } else { /* root hub */
1782 const struct hc_driver *drv = bus_to_hcd(hdev->bus)->driver;
1784 if (drv->bus_suspend && drv->bus_resume)
1785 usb_enable_autosuspend(hdev);
1788 if (hdev->level == MAX_TOPO_LEVEL) {
1790 "Unsupported bus topology: hub nested too deep\n");
1794 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1796 dev_warn(&intf->dev, "ignoring external hub\n");
1801 if (!hub_descriptor_is_sane(desc)) {
1802 dev_err(&intf->dev, "bad descriptor, ignoring hub\n");
1806 /* We found a hub */
1807 dev_info(&intf->dev, "USB hub found\n");
1809 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1813 kref_init(&hub->kref);
1814 hub->intfdev = &intf->dev;
1816 INIT_DELAYED_WORK(&hub->leds, led_work);
1817 INIT_DELAYED_WORK(&hub->init_work, NULL);
1818 INIT_WORK(&hub->events, hub_event);
1822 usb_set_intfdata(intf, hub);
1823 intf->needs_remote_wakeup = 1;
1824 pm_suspend_ignore_children(&intf->dev, true);
1826 if (hdev->speed == USB_SPEED_HIGH)
1829 if (id->driver_info & HUB_QUIRK_CHECK_PORT_AUTOSUSPEND)
1830 hub->quirk_check_port_auto_suspend = 1;
1832 if (hub_configure(hub, &desc->endpoint[0].desc) >= 0)
1835 hub_disconnect(intf);
1840 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1842 struct usb_device *hdev = interface_to_usbdev(intf);
1843 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1845 /* assert ifno == 0 (part of hub spec) */
1847 case USBDEVFS_HUB_PORTINFO: {
1848 struct usbdevfs_hub_portinfo *info = user_data;
1851 spin_lock_irq(&device_state_lock);
1852 if (hdev->devnum <= 0)
1855 info->nports = hdev->maxchild;
1856 for (i = 0; i < info->nports; i++) {
1857 if (hub->ports[i]->child == NULL)
1861 hub->ports[i]->child->devnum;
1864 spin_unlock_irq(&device_state_lock);
1866 return info->nports + 1;
1875 * Allow user programs to claim ports on a hub. When a device is attached
1876 * to one of these "claimed" ports, the program will "own" the device.
1878 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1879 struct usb_dev_state ***ppowner)
1881 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1883 if (hdev->state == USB_STATE_NOTATTACHED)
1885 if (port1 == 0 || port1 > hdev->maxchild)
1888 /* Devices not managed by the hub driver
1889 * will always have maxchild equal to 0.
1891 *ppowner = &(hub->ports[port1 - 1]->port_owner);
1895 /* In the following three functions, the caller must hold hdev's lock */
1896 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
1897 struct usb_dev_state *owner)
1900 struct usb_dev_state **powner;
1902 rc = find_port_owner(hdev, port1, &powner);
1910 EXPORT_SYMBOL_GPL(usb_hub_claim_port);
1912 int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
1913 struct usb_dev_state *owner)
1916 struct usb_dev_state **powner;
1918 rc = find_port_owner(hdev, port1, &powner);
1921 if (*powner != owner)
1926 EXPORT_SYMBOL_GPL(usb_hub_release_port);
1928 void usb_hub_release_all_ports(struct usb_device *hdev, struct usb_dev_state *owner)
1930 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1933 for (n = 0; n < hdev->maxchild; n++) {
1934 if (hub->ports[n]->port_owner == owner)
1935 hub->ports[n]->port_owner = NULL;
1940 /* The caller must hold udev's lock */
1941 bool usb_device_is_owned(struct usb_device *udev)
1943 struct usb_hub *hub;
1945 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1947 hub = usb_hub_to_struct_hub(udev->parent);
1948 return !!hub->ports[udev->portnum - 1]->port_owner;
1951 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1953 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
1956 for (i = 0; i < udev->maxchild; ++i) {
1957 if (hub->ports[i]->child)
1958 recursively_mark_NOTATTACHED(hub->ports[i]->child);
1960 if (udev->state == USB_STATE_SUSPENDED)
1961 udev->active_duration -= jiffies;
1962 udev->state = USB_STATE_NOTATTACHED;
1966 * usb_set_device_state - change a device's current state (usbcore, hcds)
1967 * @udev: pointer to device whose state should be changed
1968 * @new_state: new state value to be stored
1970 * udev->state is _not_ fully protected by the device lock. Although
1971 * most transitions are made only while holding the lock, the state can
1972 * can change to USB_STATE_NOTATTACHED at almost any time. This
1973 * is so that devices can be marked as disconnected as soon as possible,
1974 * without having to wait for any semaphores to be released. As a result,
1975 * all changes to any device's state must be protected by the
1976 * device_state_lock spinlock.
1978 * Once a device has been added to the device tree, all changes to its state
1979 * should be made using this routine. The state should _not_ be set directly.
1981 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1982 * Otherwise udev->state is set to new_state, and if new_state is
1983 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1984 * to USB_STATE_NOTATTACHED.
1986 void usb_set_device_state(struct usb_device *udev,
1987 enum usb_device_state new_state)
1989 unsigned long flags;
1992 spin_lock_irqsave(&device_state_lock, flags);
1993 if (udev->state == USB_STATE_NOTATTACHED)
1995 else if (new_state != USB_STATE_NOTATTACHED) {
1997 /* root hub wakeup capabilities are managed out-of-band
1998 * and may involve silicon errata ... ignore them here.
2001 if (udev->state == USB_STATE_SUSPENDED
2002 || new_state == USB_STATE_SUSPENDED)
2003 ; /* No change to wakeup settings */
2004 else if (new_state == USB_STATE_CONFIGURED)
2005 wakeup = (udev->quirks &
2006 USB_QUIRK_IGNORE_REMOTE_WAKEUP) ? 0 :
2007 udev->actconfig->desc.bmAttributes &
2008 USB_CONFIG_ATT_WAKEUP;
2012 if (udev->state == USB_STATE_SUSPENDED &&
2013 new_state != USB_STATE_SUSPENDED)
2014 udev->active_duration -= jiffies;
2015 else if (new_state == USB_STATE_SUSPENDED &&
2016 udev->state != USB_STATE_SUSPENDED)
2017 udev->active_duration += jiffies;
2018 udev->state = new_state;
2020 recursively_mark_NOTATTACHED(udev);
2021 spin_unlock_irqrestore(&device_state_lock, flags);
2023 device_set_wakeup_capable(&udev->dev, wakeup);
2025 EXPORT_SYMBOL_GPL(usb_set_device_state);
2028 * Choose a device number.
2030 * Device numbers are used as filenames in usbfs. On USB-1.1 and
2031 * USB-2.0 buses they are also used as device addresses, however on
2032 * USB-3.0 buses the address is assigned by the controller hardware
2033 * and it usually is not the same as the device number.
2035 * WUSB devices are simple: they have no hubs behind, so the mapping
2036 * device <-> virtual port number becomes 1:1. Why? to simplify the
2037 * life of the device connection logic in
2038 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
2039 * handshake we need to assign a temporary address in the unauthorized
2040 * space. For simplicity we use the first virtual port number found to
2041 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
2042 * and that becomes it's address [X < 128] or its unauthorized address
2045 * We add 1 as an offset to the one-based USB-stack port number
2046 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
2047 * 0 is reserved by USB for default address; (b) Linux's USB stack
2048 * uses always #1 for the root hub of the controller. So USB stack's
2049 * port #1, which is wusb virtual-port #0 has address #2.
2051 * Devices connected under xHCI are not as simple. The host controller
2052 * supports virtualization, so the hardware assigns device addresses and
2053 * the HCD must setup data structures before issuing a set address
2054 * command to the hardware.
2056 static void choose_devnum(struct usb_device *udev)
2059 struct usb_bus *bus = udev->bus;
2061 /* be safe when more hub events are proceed in parallel */
2062 mutex_lock(&bus->devnum_next_mutex);
2064 devnum = udev->portnum + 1;
2065 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
2067 /* Try to allocate the next devnum beginning at
2068 * bus->devnum_next. */
2069 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
2072 devnum = find_next_zero_bit(bus->devmap.devicemap,
2074 bus->devnum_next = (devnum >= 127 ? 1 : devnum + 1);
2077 set_bit(devnum, bus->devmap.devicemap);
2078 udev->devnum = devnum;
2080 mutex_unlock(&bus->devnum_next_mutex);
2083 static void release_devnum(struct usb_device *udev)
2085 if (udev->devnum > 0) {
2086 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
2091 static void update_devnum(struct usb_device *udev, int devnum)
2093 /* The address for a WUSB device is managed by wusbcore. */
2095 udev->devnum = devnum;
2098 static void hub_free_dev(struct usb_device *udev)
2100 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2102 /* Root hubs aren't real devices, so don't free HCD resources */
2103 if (hcd->driver->free_dev && udev->parent)
2104 hcd->driver->free_dev(hcd, udev);
2107 static void hub_disconnect_children(struct usb_device *udev)
2109 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2112 /* Free up all the children before we remove this device */
2113 for (i = 0; i < udev->maxchild; i++) {
2114 if (hub->ports[i]->child)
2115 usb_disconnect(&hub->ports[i]->child);
2120 * usb_disconnect - disconnect a device (usbcore-internal)
2121 * @pdev: pointer to device being disconnected
2122 * Context: !in_interrupt ()
2124 * Something got disconnected. Get rid of it and all of its children.
2126 * If *pdev is a normal device then the parent hub must already be locked.
2127 * If *pdev is a root hub then the caller must hold the usb_bus_idr_lock,
2128 * which protects the set of root hubs as well as the list of buses.
2130 * Only hub drivers (including virtual root hub drivers for host
2131 * controllers) should ever call this.
2133 * This call is synchronous, and may not be used in an interrupt context.
2135 void usb_disconnect(struct usb_device **pdev)
2137 struct usb_port *port_dev = NULL;
2138 struct usb_device *udev = *pdev;
2139 struct usb_hub *hub = NULL;
2142 /* mark the device as inactive, so any further urb submissions for
2143 * this device (and any of its children) will fail immediately.
2144 * this quiesces everything except pending urbs.
2146 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2147 dev_info(&udev->dev, "USB disconnect, device number %d\n",
2151 * Ensure that the pm runtime code knows that the USB device
2152 * is in the process of being disconnected.
2154 pm_runtime_barrier(&udev->dev);
2156 usb_lock_device(udev);
2158 hub_disconnect_children(udev);
2160 /* deallocate hcd/hardware state ... nuking all pending urbs and
2161 * cleaning up all state associated with the current configuration
2162 * so that the hardware is now fully quiesced.
2164 dev_dbg(&udev->dev, "unregistering device\n");
2165 usb_disable_device(udev, 0);
2166 usb_hcd_synchronize_unlinks(udev);
2169 port1 = udev->portnum;
2170 hub = usb_hub_to_struct_hub(udev->parent);
2171 port_dev = hub->ports[port1 - 1];
2173 sysfs_remove_link(&udev->dev.kobj, "port");
2174 sysfs_remove_link(&port_dev->dev.kobj, "device");
2177 * As usb_port_runtime_resume() de-references udev, make
2178 * sure no resumes occur during removal
2180 if (!test_and_set_bit(port1, hub->child_usage_bits))
2181 pm_runtime_get_sync(&port_dev->dev);
2184 usb_remove_ep_devs(&udev->ep0);
2185 usb_unlock_device(udev);
2187 /* Unregister the device. The device driver is responsible
2188 * for de-configuring the device and invoking the remove-device
2189 * notifier chain (used by usbfs and possibly others).
2191 device_del(&udev->dev);
2193 /* Free the device number and delete the parent's children[]
2194 * (or root_hub) pointer.
2196 release_devnum(udev);
2198 /* Avoid races with recursively_mark_NOTATTACHED() */
2199 spin_lock_irq(&device_state_lock);
2201 spin_unlock_irq(&device_state_lock);
2203 if (port_dev && test_and_clear_bit(port1, hub->child_usage_bits))
2204 pm_runtime_put(&port_dev->dev);
2208 put_device(&udev->dev);
2211 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2212 static void show_string(struct usb_device *udev, char *id, char *string)
2216 dev_info(&udev->dev, "%s: %s\n", id, string);
2219 static void announce_device(struct usb_device *udev)
2221 u16 bcdDevice = le16_to_cpu(udev->descriptor.bcdDevice);
2223 dev_info(&udev->dev,
2224 "New USB device found, idVendor=%04x, idProduct=%04x, bcdDevice=%2x.%02x\n",
2225 le16_to_cpu(udev->descriptor.idVendor),
2226 le16_to_cpu(udev->descriptor.idProduct),
2227 bcdDevice >> 8, bcdDevice & 0xff);
2228 dev_info(&udev->dev,
2229 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2230 udev->descriptor.iManufacturer,
2231 udev->descriptor.iProduct,
2232 udev->descriptor.iSerialNumber);
2233 show_string(udev, "Product", udev->product);
2234 show_string(udev, "Manufacturer", udev->manufacturer);
2235 show_string(udev, "SerialNumber", udev->serial);
2238 static inline void announce_device(struct usb_device *udev) { }
2243 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2244 * @udev: newly addressed device (in ADDRESS state)
2246 * Finish enumeration for On-The-Go devices
2248 * Return: 0 if successful. A negative error code otherwise.
2250 static int usb_enumerate_device_otg(struct usb_device *udev)
2254 #ifdef CONFIG_USB_OTG
2256 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2257 * to wake us after we've powered off VBUS; and HNP, switching roles
2258 * "host" to "peripheral". The OTG descriptor helps figure this out.
2260 if (!udev->bus->is_b_host
2262 && udev->parent == udev->bus->root_hub) {
2263 struct usb_otg_descriptor *desc = NULL;
2264 struct usb_bus *bus = udev->bus;
2265 unsigned port1 = udev->portnum;
2267 /* descriptor may appear anywhere in config */
2268 err = __usb_get_extra_descriptor(udev->rawdescriptors[0],
2269 le16_to_cpu(udev->config[0].desc.wTotalLength),
2270 USB_DT_OTG, (void **) &desc, sizeof(*desc));
2271 if (err || !(desc->bmAttributes & USB_OTG_HNP))
2274 dev_info(&udev->dev, "Dual-Role OTG device on %sHNP port\n",
2275 (port1 == bus->otg_port) ? "" : "non-");
2277 /* enable HNP before suspend, it's simpler */
2278 if (port1 == bus->otg_port) {
2279 bus->b_hnp_enable = 1;
2280 err = usb_control_msg(udev,
2281 usb_sndctrlpipe(udev, 0),
2282 USB_REQ_SET_FEATURE, 0,
2283 USB_DEVICE_B_HNP_ENABLE,
2285 USB_CTRL_SET_TIMEOUT);
2288 * OTG MESSAGE: report errors here,
2289 * customize to match your product.
2291 dev_err(&udev->dev, "can't set HNP mode: %d\n",
2293 bus->b_hnp_enable = 0;
2295 } else if (desc->bLength == sizeof
2296 (struct usb_otg_descriptor)) {
2297 /* Set a_alt_hnp_support for legacy otg device */
2298 err = usb_control_msg(udev,
2299 usb_sndctrlpipe(udev, 0),
2300 USB_REQ_SET_FEATURE, 0,
2301 USB_DEVICE_A_ALT_HNP_SUPPORT,
2303 USB_CTRL_SET_TIMEOUT);
2306 "set a_alt_hnp_support failed: %d\n",
2316 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2317 * @udev: newly addressed device (in ADDRESS state)
2319 * This is only called by usb_new_device() and usb_authorize_device()
2320 * and FIXME -- all comments that apply to them apply here wrt to
2323 * If the device is WUSB and not authorized, we don't attempt to read
2324 * the string descriptors, as they will be errored out by the device
2325 * until it has been authorized.
2327 * Return: 0 if successful. A negative error code otherwise.
2329 static int usb_enumerate_device(struct usb_device *udev)
2332 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2334 if (udev->config == NULL) {
2335 err = usb_get_configuration(udev);
2338 dev_err(&udev->dev, "can't read configurations, error %d\n",
2344 /* read the standard strings and cache them if present */
2345 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
2346 udev->manufacturer = usb_cache_string(udev,
2347 udev->descriptor.iManufacturer);
2348 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
2350 err = usb_enumerate_device_otg(udev);
2354 if (IS_ENABLED(CONFIG_USB_OTG_WHITELIST) && hcd->tpl_support &&
2355 !is_targeted(udev)) {
2356 /* Maybe it can talk to us, though we can't talk to it.
2357 * (Includes HNP test device.)
2359 if (IS_ENABLED(CONFIG_USB_OTG) && (udev->bus->b_hnp_enable
2360 || udev->bus->is_b_host)) {
2361 err = usb_port_suspend(udev, PMSG_AUTO_SUSPEND);
2363 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
2368 usb_detect_interface_quirks(udev);
2373 static void set_usb_port_removable(struct usb_device *udev)
2375 struct usb_device *hdev = udev->parent;
2376 struct usb_hub *hub;
2377 u8 port = udev->portnum;
2378 u16 wHubCharacteristics;
2379 bool removable = true;
2384 hub = usb_hub_to_struct_hub(udev->parent);
2387 * If the platform firmware has provided information about a port,
2388 * use that to determine whether it's removable.
2390 switch (hub->ports[udev->portnum - 1]->connect_type) {
2391 case USB_PORT_CONNECT_TYPE_HOT_PLUG:
2392 udev->removable = USB_DEVICE_REMOVABLE;
2394 case USB_PORT_CONNECT_TYPE_HARD_WIRED:
2395 case USB_PORT_NOT_USED:
2396 udev->removable = USB_DEVICE_FIXED;
2403 * Otherwise, check whether the hub knows whether a port is removable
2406 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2408 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
2411 if (hub_is_superspeed(hdev)) {
2412 if (le16_to_cpu(hub->descriptor->u.ss.DeviceRemovable)
2416 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
2421 udev->removable = USB_DEVICE_REMOVABLE;
2423 udev->removable = USB_DEVICE_FIXED;
2428 * usb_new_device - perform initial device setup (usbcore-internal)
2429 * @udev: newly addressed device (in ADDRESS state)
2431 * This is called with devices which have been detected but not fully
2432 * enumerated. The device descriptor is available, but not descriptors
2433 * for any device configuration. The caller must have locked either
2434 * the parent hub (if udev is a normal device) or else the
2435 * usb_bus_idr_lock (if udev is a root hub). The parent's pointer to
2436 * udev has already been installed, but udev is not yet visible through
2437 * sysfs or other filesystem code.
2439 * This call is synchronous, and may not be used in an interrupt context.
2441 * Only the hub driver or root-hub registrar should ever call this.
2443 * Return: Whether the device is configured properly or not. Zero if the
2444 * interface was registered with the driver core; else a negative errno
2448 int usb_new_device(struct usb_device *udev)
2453 /* Initialize non-root-hub device wakeup to disabled;
2454 * device (un)configuration controls wakeup capable
2455 * sysfs power/wakeup controls wakeup enabled/disabled
2457 device_init_wakeup(&udev->dev, 0);
2460 /* Tell the runtime-PM framework the device is active */
2461 pm_runtime_set_active(&udev->dev);
2462 pm_runtime_get_noresume(&udev->dev);
2463 pm_runtime_use_autosuspend(&udev->dev);
2464 pm_runtime_enable(&udev->dev);
2466 /* By default, forbid autosuspend for all devices. It will be
2467 * allowed for hubs during binding.
2469 usb_disable_autosuspend(udev);
2471 err = usb_enumerate_device(udev); /* Read descriptors */
2474 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
2475 udev->devnum, udev->bus->busnum,
2476 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2477 /* export the usbdev device-node for libusb */
2478 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
2479 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2481 /* Tell the world! */
2482 announce_device(udev);
2485 add_device_randomness(udev->serial, strlen(udev->serial));
2487 add_device_randomness(udev->product, strlen(udev->product));
2488 if (udev->manufacturer)
2489 add_device_randomness(udev->manufacturer,
2490 strlen(udev->manufacturer));
2492 device_enable_async_suspend(&udev->dev);
2494 /* check whether the hub or firmware marks this port as non-removable */
2496 set_usb_port_removable(udev);
2498 /* Register the device. The device driver is responsible
2499 * for configuring the device and invoking the add-device
2500 * notifier chain (used by usbfs and possibly others).
2502 err = device_add(&udev->dev);
2504 dev_err(&udev->dev, "can't device_add, error %d\n", err);
2508 /* Create link files between child device and usb port device. */
2510 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2511 int port1 = udev->portnum;
2512 struct usb_port *port_dev = hub->ports[port1 - 1];
2514 err = sysfs_create_link(&udev->dev.kobj,
2515 &port_dev->dev.kobj, "port");
2519 err = sysfs_create_link(&port_dev->dev.kobj,
2520 &udev->dev.kobj, "device");
2522 sysfs_remove_link(&udev->dev.kobj, "port");
2526 if (!test_and_set_bit(port1, hub->child_usage_bits))
2527 pm_runtime_get_sync(&port_dev->dev);
2530 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
2531 usb_mark_last_busy(udev);
2532 pm_runtime_put_sync_autosuspend(&udev->dev);
2536 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2537 pm_runtime_disable(&udev->dev);
2538 pm_runtime_set_suspended(&udev->dev);
2544 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2545 * @usb_dev: USB device
2547 * Move the USB device to a very basic state where interfaces are disabled
2548 * and the device is in fact unconfigured and unusable.
2550 * We share a lock (that we have) with device_del(), so we need to
2555 int usb_deauthorize_device(struct usb_device *usb_dev)
2557 usb_lock_device(usb_dev);
2558 if (usb_dev->authorized == 0)
2559 goto out_unauthorized;
2561 usb_dev->authorized = 0;
2562 usb_set_configuration(usb_dev, -1);
2565 usb_unlock_device(usb_dev);
2570 int usb_authorize_device(struct usb_device *usb_dev)
2574 usb_lock_device(usb_dev);
2575 if (usb_dev->authorized == 1)
2576 goto out_authorized;
2578 result = usb_autoresume_device(usb_dev);
2580 dev_err(&usb_dev->dev,
2581 "can't autoresume for authorization: %d\n", result);
2582 goto error_autoresume;
2585 if (usb_dev->wusb) {
2586 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2588 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2589 "authorization: %d\n", result);
2590 goto error_device_descriptor;
2594 usb_dev->authorized = 1;
2595 /* Choose and set the configuration. This registers the interfaces
2596 * with the driver core and lets interface drivers bind to them.
2598 c = usb_choose_configuration(usb_dev);
2600 result = usb_set_configuration(usb_dev, c);
2602 dev_err(&usb_dev->dev,
2603 "can't set config #%d, error %d\n", c, result);
2604 /* This need not be fatal. The user can try to
2605 * set other configurations. */
2608 dev_info(&usb_dev->dev, "authorized to connect\n");
2610 error_device_descriptor:
2611 usb_autosuspend_device(usb_dev);
2614 usb_unlock_device(usb_dev); /* complements locktree */
2619 * Return 1 if port speed is SuperSpeedPlus, 0 otherwise
2620 * check it from the link protocol field of the current speed ID attribute.
2621 * current speed ID is got from ext port status request. Sublink speed attribute
2622 * table is returned with the hub BOS SSP device capability descriptor
2624 static int port_speed_is_ssp(struct usb_device *hdev, int speed_id)
2629 struct usb_ssp_cap_descriptor *ssp_cap = hdev->bos->ssp_cap;
2634 ssa_count = le32_to_cpu(ssp_cap->bmAttributes) &
2635 USB_SSP_SUBLINK_SPEED_ATTRIBS;
2637 for (i = 0; i <= ssa_count; i++) {
2638 ss_attr = le32_to_cpu(ssp_cap->bmSublinkSpeedAttr[i]);
2639 if (speed_id == (ss_attr & USB_SSP_SUBLINK_SPEED_SSID))
2640 return !!(ss_attr & USB_SSP_SUBLINK_SPEED_LP);
2645 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2646 static unsigned hub_is_wusb(struct usb_hub *hub)
2648 struct usb_hcd *hcd;
2649 if (hub->hdev->parent != NULL) /* not a root hub? */
2651 hcd = bus_to_hcd(hub->hdev->bus);
2652 return hcd->wireless;
2656 #define PORT_RESET_TRIES 5
2657 #define SET_ADDRESS_TRIES 2
2658 #define GET_DESCRIPTOR_TRIES 2
2659 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2660 #define USE_NEW_SCHEME(i, scheme) ((i) / 2 == (int)scheme)
2662 #define HUB_ROOT_RESET_TIME 60 /* times are in msec */
2663 #define HUB_SHORT_RESET_TIME 10
2664 #define HUB_BH_RESET_TIME 50
2665 #define HUB_LONG_RESET_TIME 200
2666 #define HUB_RESET_TIMEOUT 800
2669 * "New scheme" enumeration causes an extra state transition to be
2670 * exposed to an xhci host and causes USB3 devices to receive control
2671 * commands in the default state. This has been seen to cause
2672 * enumeration failures, so disable this enumeration scheme for USB3
2675 static bool use_new_scheme(struct usb_device *udev, int retry,
2676 struct usb_port *port_dev)
2678 int old_scheme_first_port =
2679 port_dev->quirks & USB_PORT_QUIRK_OLD_SCHEME;
2681 if (udev->speed >= USB_SPEED_SUPER)
2684 return USE_NEW_SCHEME(retry, old_scheme_first_port || old_scheme_first);
2687 /* Is a USB 3.0 port in the Inactive or Compliance Mode state?
2688 * Port worm reset is required to recover
2690 static bool hub_port_warm_reset_required(struct usb_hub *hub, int port1,
2695 if (!hub_is_superspeed(hub->hdev))
2698 if (test_bit(port1, hub->warm_reset_bits))
2701 link_state = portstatus & USB_PORT_STAT_LINK_STATE;
2702 return link_state == USB_SS_PORT_LS_SS_INACTIVE
2703 || link_state == USB_SS_PORT_LS_COMP_MOD;
2706 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2707 struct usb_device *udev, unsigned int delay, bool warm)
2709 int delay_time, ret;
2712 u32 ext_portstatus = 0;
2714 for (delay_time = 0;
2715 delay_time < HUB_RESET_TIMEOUT;
2716 delay_time += delay) {
2717 /* wait to give the device a chance to reset */
2720 /* read and decode port status */
2721 if (hub_is_superspeedplus(hub->hdev))
2722 ret = hub_ext_port_status(hub, port1,
2723 HUB_EXT_PORT_STATUS,
2724 &portstatus, &portchange,
2727 ret = hub_port_status(hub, port1, &portstatus,
2733 * The port state is unknown until the reset completes.
2735 * On top of that, some chips may require additional time
2736 * to re-establish a connection after the reset is complete,
2737 * so also wait for the connection to be re-established.
2739 if (!(portstatus & USB_PORT_STAT_RESET) &&
2740 (portstatus & USB_PORT_STAT_CONNECTION))
2743 /* switch to the long delay after two short delay failures */
2744 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2745 delay = HUB_LONG_RESET_TIME;
2747 dev_dbg(&hub->ports[port1 - 1]->dev,
2748 "not %sreset yet, waiting %dms\n",
2749 warm ? "warm " : "", delay);
2752 if ((portstatus & USB_PORT_STAT_RESET))
2755 if (hub_port_warm_reset_required(hub, port1, portstatus))
2758 /* Device went away? */
2759 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2762 /* Retry if connect change is set but status is still connected.
2763 * A USB 3.0 connection may bounce if multiple warm resets were issued,
2764 * but the device may have successfully re-connected. Ignore it.
2766 if (!hub_is_superspeed(hub->hdev) &&
2767 (portchange & USB_PORT_STAT_C_CONNECTION)) {
2768 usb_clear_port_feature(hub->hdev, port1,
2769 USB_PORT_FEAT_C_CONNECTION);
2773 if (!(portstatus & USB_PORT_STAT_ENABLE))
2779 if (hub_is_superspeedplus(hub->hdev)) {
2780 /* extended portstatus Rx and Tx lane count are zero based */
2781 udev->rx_lanes = USB_EXT_PORT_RX_LANES(ext_portstatus) + 1;
2782 udev->tx_lanes = USB_EXT_PORT_TX_LANES(ext_portstatus) + 1;
2787 if (hub_is_wusb(hub))
2788 udev->speed = USB_SPEED_WIRELESS;
2789 else if (hub_is_superspeedplus(hub->hdev) &&
2790 port_speed_is_ssp(hub->hdev, ext_portstatus &
2791 USB_EXT_PORT_STAT_RX_SPEED_ID))
2792 udev->speed = USB_SPEED_SUPER_PLUS;
2793 else if (hub_is_superspeed(hub->hdev))
2794 udev->speed = USB_SPEED_SUPER;
2795 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2796 udev->speed = USB_SPEED_HIGH;
2797 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2798 udev->speed = USB_SPEED_LOW;
2800 udev->speed = USB_SPEED_FULL;
2804 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2805 static int hub_port_reset(struct usb_hub *hub, int port1,
2806 struct usb_device *udev, unsigned int delay, bool warm)
2809 u16 portchange, portstatus;
2810 struct usb_port *port_dev = hub->ports[port1 - 1];
2811 int reset_recovery_time;
2813 if (!hub_is_superspeed(hub->hdev)) {
2815 dev_err(hub->intfdev, "only USB3 hub support "
2819 /* Block EHCI CF initialization during the port reset.
2820 * Some companion controllers don't like it when they mix.
2822 down_read(&ehci_cf_port_reset_rwsem);
2825 * If the caller hasn't explicitly requested a warm reset,
2826 * double check and see if one is needed.
2828 if (hub_port_status(hub, port1, &portstatus, &portchange) == 0)
2829 if (hub_port_warm_reset_required(hub, port1,
2833 clear_bit(port1, hub->warm_reset_bits);
2835 /* Reset the port */
2836 for (i = 0; i < PORT_RESET_TRIES; i++) {
2837 status = set_port_feature(hub->hdev, port1, (warm ?
2838 USB_PORT_FEAT_BH_PORT_RESET :
2839 USB_PORT_FEAT_RESET));
2840 if (status == -ENODEV) {
2841 ; /* The hub is gone */
2842 } else if (status) {
2843 dev_err(&port_dev->dev,
2844 "cannot %sreset (err = %d)\n",
2845 warm ? "warm " : "", status);
2847 status = hub_port_wait_reset(hub, port1, udev, delay,
2849 if (status && status != -ENOTCONN && status != -ENODEV)
2850 dev_dbg(hub->intfdev,
2851 "port_wait_reset: err = %d\n",
2855 /* Check for disconnect or reset */
2856 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2857 usb_clear_port_feature(hub->hdev, port1,
2858 USB_PORT_FEAT_C_RESET);
2860 if (!hub_is_superspeed(hub->hdev))
2863 usb_clear_port_feature(hub->hdev, port1,
2864 USB_PORT_FEAT_C_BH_PORT_RESET);
2865 usb_clear_port_feature(hub->hdev, port1,
2866 USB_PORT_FEAT_C_PORT_LINK_STATE);
2869 usb_clear_port_feature(hub->hdev, port1,
2870 USB_PORT_FEAT_C_CONNECTION);
2873 * If a USB 3.0 device migrates from reset to an error
2874 * state, re-issue the warm reset.
2876 if (hub_port_status(hub, port1,
2877 &portstatus, &portchange) < 0)
2880 if (!hub_port_warm_reset_required(hub, port1,
2885 * If the port is in SS.Inactive or Compliance Mode, the
2886 * hot or warm reset failed. Try another warm reset.
2889 dev_dbg(&port_dev->dev,
2890 "hot reset failed, warm reset\n");
2895 dev_dbg(&port_dev->dev,
2896 "not enabled, trying %sreset again...\n",
2897 warm ? "warm " : "");
2898 delay = HUB_LONG_RESET_TIME;
2901 dev_err(&port_dev->dev, "Cannot enable. Maybe the USB cable is bad?\n");
2905 if (port_dev->quirks & USB_PORT_QUIRK_FAST_ENUM)
2906 usleep_range(10000, 12000);
2908 /* TRSTRCY = 10 ms; plus some extra */
2909 reset_recovery_time = 10 + 40;
2911 /* Hub needs extra delay after resetting its port. */
2912 if (hub->hdev->quirks & USB_QUIRK_HUB_SLOW_RESET)
2913 reset_recovery_time += 100;
2915 msleep(reset_recovery_time);
2919 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2921 update_devnum(udev, 0);
2922 /* The xHC may think the device is already reset,
2923 * so ignore the status.
2925 if (hcd->driver->reset_device)
2926 hcd->driver->reset_device(hcd, udev);
2928 usb_set_device_state(udev, USB_STATE_DEFAULT);
2932 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2935 if (!hub_is_superspeed(hub->hdev))
2936 up_read(&ehci_cf_port_reset_rwsem);
2941 /* Check if a port is power on */
2942 static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2946 if (hub_is_superspeed(hub->hdev)) {
2947 if (portstatus & USB_SS_PORT_STAT_POWER)
2950 if (portstatus & USB_PORT_STAT_POWER)
2957 static void usb_lock_port(struct usb_port *port_dev)
2958 __acquires(&port_dev->status_lock)
2960 mutex_lock(&port_dev->status_lock);
2961 __acquire(&port_dev->status_lock);
2964 static void usb_unlock_port(struct usb_port *port_dev)
2965 __releases(&port_dev->status_lock)
2967 mutex_unlock(&port_dev->status_lock);
2968 __release(&port_dev->status_lock);
2973 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2974 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
2978 if (hub_is_superspeed(hub->hdev)) {
2979 if ((portstatus & USB_PORT_STAT_LINK_STATE)
2980 == USB_SS_PORT_LS_U3)
2983 if (portstatus & USB_PORT_STAT_SUSPEND)
2990 /* Determine whether the device on a port is ready for a normal resume,
2991 * is ready for a reset-resume, or should be disconnected.
2993 static int check_port_resume_type(struct usb_device *udev,
2994 struct usb_hub *hub, int port1,
2995 int status, u16 portchange, u16 portstatus)
2997 struct usb_port *port_dev = hub->ports[port1 - 1];
3001 /* Is a warm reset needed to recover the connection? */
3002 if (status == 0 && udev->reset_resume
3003 && hub_port_warm_reset_required(hub, port1, portstatus)) {
3006 /* Is the device still present? */
3007 else if (status || port_is_suspended(hub, portstatus) ||
3008 !port_is_power_on(hub, portstatus)) {
3011 } else if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
3013 usleep_range(200, 300);
3014 status = hub_port_status(hub, port1, &portstatus,
3021 /* Can't do a normal resume if the port isn't enabled,
3022 * so try a reset-resume instead.
3024 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
3025 if (udev->persist_enabled)
3026 udev->reset_resume = 1;
3032 dev_dbg(&port_dev->dev, "status %04x.%04x after resume, %d\n",
3033 portchange, portstatus, status);
3034 } else if (udev->reset_resume) {
3036 /* Late port handoff can set status-change bits */
3037 if (portchange & USB_PORT_STAT_C_CONNECTION)
3038 usb_clear_port_feature(hub->hdev, port1,
3039 USB_PORT_FEAT_C_CONNECTION);
3040 if (portchange & USB_PORT_STAT_C_ENABLE)
3041 usb_clear_port_feature(hub->hdev, port1,
3042 USB_PORT_FEAT_C_ENABLE);
3048 int usb_disable_ltm(struct usb_device *udev)
3050 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3052 /* Check if the roothub and device supports LTM. */
3053 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
3054 !usb_device_supports_ltm(udev))
3057 /* Clear Feature LTM Enable can only be sent if the device is
3060 if (!udev->actconfig)
3063 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3064 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
3065 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
3066 USB_CTRL_SET_TIMEOUT);
3068 EXPORT_SYMBOL_GPL(usb_disable_ltm);
3070 void usb_enable_ltm(struct usb_device *udev)
3072 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3074 /* Check if the roothub and device supports LTM. */
3075 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
3076 !usb_device_supports_ltm(udev))
3079 /* Set Feature LTM Enable can only be sent if the device is
3082 if (!udev->actconfig)
3085 usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3086 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
3087 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
3088 USB_CTRL_SET_TIMEOUT);
3090 EXPORT_SYMBOL_GPL(usb_enable_ltm);
3093 * usb_enable_remote_wakeup - enable remote wakeup for a device
3094 * @udev: target device
3096 * For USB-2 devices: Set the device's remote wakeup feature.
3098 * For USB-3 devices: Assume there's only one function on the device and
3099 * enable remote wake for the first interface. FIXME if the interface
3100 * association descriptor shows there's more than one function.
3102 static int usb_enable_remote_wakeup(struct usb_device *udev)
3104 if (udev->speed < USB_SPEED_SUPER)
3105 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3106 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
3107 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
3108 USB_CTRL_SET_TIMEOUT);
3110 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3111 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
3112 USB_INTRF_FUNC_SUSPEND,
3113 USB_INTRF_FUNC_SUSPEND_RW |
3114 USB_INTRF_FUNC_SUSPEND_LP,
3115 NULL, 0, USB_CTRL_SET_TIMEOUT);
3119 * usb_disable_remote_wakeup - disable remote wakeup for a device
3120 * @udev: target device
3122 * For USB-2 devices: Clear the device's remote wakeup feature.
3124 * For USB-3 devices: Assume there's only one function on the device and
3125 * disable remote wake for the first interface. FIXME if the interface
3126 * association descriptor shows there's more than one function.
3128 static int usb_disable_remote_wakeup(struct usb_device *udev)
3130 if (udev->speed < USB_SPEED_SUPER)
3131 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3132 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
3133 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
3134 USB_CTRL_SET_TIMEOUT);
3136 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3137 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
3138 USB_INTRF_FUNC_SUSPEND, 0, NULL, 0,
3139 USB_CTRL_SET_TIMEOUT);
3142 /* Count of wakeup-enabled devices at or below udev */
3143 static unsigned wakeup_enabled_descendants(struct usb_device *udev)
3145 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
3147 return udev->do_remote_wakeup +
3148 (hub ? hub->wakeup_enabled_descendants : 0);
3152 * usb_port_suspend - suspend a usb device's upstream port
3153 * @udev: device that's no longer in active use, not a root hub
3154 * Context: must be able to sleep; device not locked; pm locks held
3156 * Suspends a USB device that isn't in active use, conserving power.
3157 * Devices may wake out of a suspend, if anything important happens,
3158 * using the remote wakeup mechanism. They may also be taken out of
3159 * suspend by the host, using usb_port_resume(). It's also routine
3160 * to disconnect devices while they are suspended.
3162 * This only affects the USB hardware for a device; its interfaces
3163 * (and, for hubs, child devices) must already have been suspended.
3165 * Selective port suspend reduces power; most suspended devices draw
3166 * less than 500 uA. It's also used in OTG, along with remote wakeup.
3167 * All devices below the suspended port are also suspended.
3169 * Devices leave suspend state when the host wakes them up. Some devices
3170 * also support "remote wakeup", where the device can activate the USB
3171 * tree above them to deliver data, such as a keypress or packet. In
3172 * some cases, this wakes the USB host.
3174 * Suspending OTG devices may trigger HNP, if that's been enabled
3175 * between a pair of dual-role devices. That will change roles, such
3176 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
3178 * Devices on USB hub ports have only one "suspend" state, corresponding
3179 * to ACPI D2, "may cause the device to lose some context".
3180 * State transitions include:
3182 * - suspend, resume ... when the VBUS power link stays live
3183 * - suspend, disconnect ... VBUS lost
3185 * Once VBUS drop breaks the circuit, the port it's using has to go through
3186 * normal re-enumeration procedures, starting with enabling VBUS power.
3187 * Other than re-initializing the hub (plug/unplug, except for root hubs),
3188 * Linux (2.6) currently has NO mechanisms to initiate that: no hub_wq
3189 * timer, no SRP, no requests through sysfs.
3191 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
3192 * suspended until their bus goes into global suspend (i.e., the root
3193 * hub is suspended). Nevertheless, we change @udev->state to
3194 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
3195 * upstream port setting is stored in @udev->port_is_suspended.
3197 * Returns 0 on success, else negative errno.
3199 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
3201 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3202 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3203 int port1 = udev->portnum;
3205 bool really_suspend = true;
3207 usb_lock_port(port_dev);
3209 /* enable remote wakeup when appropriate; this lets the device
3210 * wake up the upstream hub (including maybe the root hub).
3212 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
3213 * we don't explicitly enable it here.
3215 if (udev->do_remote_wakeup) {
3216 status = usb_enable_remote_wakeup(udev);
3218 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
3220 /* bail if autosuspend is requested */
3221 if (PMSG_IS_AUTO(msg))
3226 /* disable USB2 hardware LPM */
3227 usb_disable_usb2_hardware_lpm(udev);
3229 if (usb_disable_ltm(udev)) {
3230 dev_err(&udev->dev, "Failed to disable LTM before suspend\n");
3232 if (PMSG_IS_AUTO(msg))
3237 if (hub_is_superspeed(hub->hdev))
3238 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U3);
3241 * For system suspend, we do not need to enable the suspend feature
3242 * on individual USB-2 ports. The devices will automatically go
3243 * into suspend a few ms after the root hub stops sending packets.
3244 * The USB 2.0 spec calls this "global suspend".
3246 * However, many USB hubs have a bug: They don't relay wakeup requests
3247 * from a downstream port if the port's suspend feature isn't on.
3248 * Therefore we will turn on the suspend feature if udev or any of its
3249 * descendants is enabled for remote wakeup.
3251 else if (PMSG_IS_AUTO(msg) || wakeup_enabled_descendants(udev) > 0)
3252 status = set_port_feature(hub->hdev, port1,
3253 USB_PORT_FEAT_SUSPEND);
3255 really_suspend = false;
3259 dev_dbg(&port_dev->dev, "can't suspend, status %d\n", status);
3261 /* Try to enable USB3 LTM again */
3262 usb_enable_ltm(udev);
3264 /* Try to enable USB2 hardware LPM again */
3265 usb_enable_usb2_hardware_lpm(udev);
3267 if (udev->do_remote_wakeup)
3268 (void) usb_disable_remote_wakeup(udev);
3271 /* System sleep transitions should never fail */
3272 if (!PMSG_IS_AUTO(msg))
3275 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
3276 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
3277 udev->do_remote_wakeup);
3278 if (really_suspend) {
3279 udev->port_is_suspended = 1;
3281 /* device has up to 10 msec to fully suspend */
3284 usb_set_device_state(udev, USB_STATE_SUSPENDED);
3287 if (status == 0 && !udev->do_remote_wakeup && udev->persist_enabled
3288 && test_and_clear_bit(port1, hub->child_usage_bits))
3289 pm_runtime_put_sync(&port_dev->dev);
3291 usb_mark_last_busy(hub->hdev);
3293 usb_unlock_port(port_dev);
3298 * If the USB "suspend" state is in use (rather than "global suspend"),
3299 * many devices will be individually taken out of suspend state using
3300 * special "resume" signaling. This routine kicks in shortly after
3301 * hardware resume signaling is finished, either because of selective
3302 * resume (by host) or remote wakeup (by device) ... now see what changed
3303 * in the tree that's rooted at this device.
3305 * If @udev->reset_resume is set then the device is reset before the
3306 * status check is done.
3308 static int finish_port_resume(struct usb_device *udev)
3313 /* caller owns the udev device lock */
3314 dev_dbg(&udev->dev, "%s\n",
3315 udev->reset_resume ? "finish reset-resume" : "finish resume");
3317 /* usb ch9 identifies four variants of SUSPENDED, based on what
3318 * state the device resumes to. Linux currently won't see the
3319 * first two on the host side; they'd be inside hub_port_init()
3320 * during many timeouts, but hub_wq can't suspend until later.
3322 usb_set_device_state(udev, udev->actconfig
3323 ? USB_STATE_CONFIGURED
3324 : USB_STATE_ADDRESS);
3326 /* 10.5.4.5 says not to reset a suspended port if the attached
3327 * device is enabled for remote wakeup. Hence the reset
3328 * operation is carried out here, after the port has been
3331 if (udev->reset_resume) {
3333 * If the device morphs or switches modes when it is reset,
3334 * we don't want to perform a reset-resume. We'll fail the
3335 * resume, which will cause a logical disconnect, and then
3336 * the device will be rediscovered.
3339 if (udev->quirks & USB_QUIRK_RESET)
3342 status = usb_reset_and_verify_device(udev);
3345 /* 10.5.4.5 says be sure devices in the tree are still there.
3346 * For now let's assume the device didn't go crazy on resume,
3347 * and device drivers will know about any resume quirks.
3351 status = usb_get_std_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
3353 /* If a normal resume failed, try doing a reset-resume */
3354 if (status && !udev->reset_resume && udev->persist_enabled) {
3355 dev_dbg(&udev->dev, "retry with reset-resume\n");
3356 udev->reset_resume = 1;
3357 goto retry_reset_resume;
3362 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
3365 * There are a few quirky devices which violate the standard
3366 * by claiming to have remote wakeup enabled after a reset,
3367 * which crash if the feature is cleared, hence check for
3368 * udev->reset_resume
3370 } else if (udev->actconfig && !udev->reset_resume) {
3371 if (udev->speed < USB_SPEED_SUPER) {
3372 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
3373 status = usb_disable_remote_wakeup(udev);
3375 status = usb_get_std_status(udev, USB_RECIP_INTERFACE, 0,
3377 if (!status && devstatus & (USB_INTRF_STAT_FUNC_RW_CAP
3378 | USB_INTRF_STAT_FUNC_RW))
3379 status = usb_disable_remote_wakeup(udev);
3384 "disable remote wakeup, status %d\n",
3392 * There are some SS USB devices which take longer time for link training.
3393 * XHCI specs 4.19.4 says that when Link training is successful, port
3394 * sets CCS bit to 1. So if SW reads port status before successful link
3395 * training, then it will not find device to be present.
3396 * USB Analyzer log with such buggy devices show that in some cases
3397 * device switch on the RX termination after long delay of host enabling
3398 * the VBUS. In few other cases it has been seen that device fails to
3399 * negotiate link training in first attempt. It has been
3400 * reported till now that few devices take as long as 2000 ms to train
3401 * the link after host enabling its VBUS and termination. Following
3402 * routine implements a 2000 ms timeout for link training. If in a case
3403 * link trains before timeout, loop will exit earlier.
3405 * There are also some 2.0 hard drive based devices and 3.0 thumb
3406 * drives that, when plugged into a 2.0 only port, take a long
3407 * time to set CCS after VBUS enable.
3409 * FIXME: If a device was connected before suspend, but was removed
3410 * while system was asleep, then the loop in the following routine will
3411 * only exit at timeout.
3413 * This routine should only be called when persist is enabled.
3415 static int wait_for_connected(struct usb_device *udev,
3416 struct usb_hub *hub, int *port1,
3417 u16 *portchange, u16 *portstatus)
3419 int status = 0, delay_ms = 0;
3421 while (delay_ms < 2000) {
3422 if (status || *portstatus & USB_PORT_STAT_CONNECTION)
3424 if (!port_is_power_on(hub, *portstatus)) {
3430 status = hub_port_status(hub, *port1, portstatus, portchange);
3432 dev_dbg(&udev->dev, "Waited %dms for CONNECT\n", delay_ms);
3437 * usb_port_resume - re-activate a suspended usb device's upstream port
3438 * @udev: device to re-activate, not a root hub
3439 * Context: must be able to sleep; device not locked; pm locks held
3441 * This will re-activate the suspended device, increasing power usage
3442 * while letting drivers communicate again with its endpoints.
3443 * USB resume explicitly guarantees that the power session between
3444 * the host and the device is the same as it was when the device
3447 * If @udev->reset_resume is set then this routine won't check that the
3448 * port is still enabled. Furthermore, finish_port_resume() above will
3449 * reset @udev. The end result is that a broken power session can be
3450 * recovered and @udev will appear to persist across a loss of VBUS power.
3452 * For example, if a host controller doesn't maintain VBUS suspend current
3453 * during a system sleep or is reset when the system wakes up, all the USB
3454 * power sessions below it will be broken. This is especially troublesome
3455 * for mass-storage devices containing mounted filesystems, since the
3456 * device will appear to have disconnected and all the memory mappings
3457 * to it will be lost. Using the USB_PERSIST facility, the device can be
3458 * made to appear as if it had not disconnected.
3460 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3461 * every effort to insure that the same device is present after the
3462 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3463 * quite possible for a device to remain unaltered but its media to be
3464 * changed. If the user replaces a flash memory card while the system is
3465 * asleep, he will have only himself to blame when the filesystem on the
3466 * new card is corrupted and the system crashes.
3468 * Returns 0 on success, else negative errno.
3470 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
3472 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3473 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3474 int port1 = udev->portnum;
3476 u16 portchange, portstatus;
3478 if (!test_and_set_bit(port1, hub->child_usage_bits)) {
3479 status = pm_runtime_get_sync(&port_dev->dev);
3481 dev_dbg(&udev->dev, "can't resume usb port, status %d\n",
3487 usb_lock_port(port_dev);
3489 /* Skip the initial Clear-Suspend step for a remote wakeup */
3490 status = hub_port_status(hub, port1, &portstatus, &portchange);
3491 if (status == 0 && !port_is_suspended(hub, portstatus)) {
3492 if (portchange & USB_PORT_STAT_C_SUSPEND)
3493 pm_wakeup_event(&udev->dev, 0);
3494 goto SuspendCleared;
3497 /* see 7.1.7.7; affects power usage, but not budgeting */
3498 if (hub_is_superspeed(hub->hdev))
3499 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U0);
3501 status = usb_clear_port_feature(hub->hdev,
3502 port1, USB_PORT_FEAT_SUSPEND);
3504 dev_dbg(&port_dev->dev, "can't resume, status %d\n", status);
3506 /* drive resume for USB_RESUME_TIMEOUT msec */
3507 dev_dbg(&udev->dev, "usb %sresume\n",
3508 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
3509 msleep(USB_RESUME_TIMEOUT);
3511 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3512 * stop resume signaling. Then finish the resume
3515 status = hub_port_status(hub, port1, &portstatus, &portchange);
3517 /* TRSMRCY = 10 msec */
3523 udev->port_is_suspended = 0;
3524 if (hub_is_superspeed(hub->hdev)) {
3525 if (portchange & USB_PORT_STAT_C_LINK_STATE)
3526 usb_clear_port_feature(hub->hdev, port1,
3527 USB_PORT_FEAT_C_PORT_LINK_STATE);
3529 if (portchange & USB_PORT_STAT_C_SUSPEND)
3530 usb_clear_port_feature(hub->hdev, port1,
3531 USB_PORT_FEAT_C_SUSPEND);
3535 if (udev->persist_enabled)
3536 status = wait_for_connected(udev, hub, &port1, &portchange,
3539 status = check_port_resume_type(udev,
3540 hub, port1, status, portchange, portstatus);
3542 status = finish_port_resume(udev);
3544 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
3545 hub_port_logical_disconnect(hub, port1);
3547 /* Try to enable USB2 hardware LPM */
3548 usb_enable_usb2_hardware_lpm(udev);
3550 /* Try to enable USB3 LTM */
3551 usb_enable_ltm(udev);
3554 usb_unlock_port(port_dev);
3559 int usb_remote_wakeup(struct usb_device *udev)
3563 usb_lock_device(udev);
3564 if (udev->state == USB_STATE_SUSPENDED) {
3565 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
3566 status = usb_autoresume_device(udev);
3568 /* Let the drivers do their thing, then... */
3569 usb_autosuspend_device(udev);
3572 usb_unlock_device(udev);
3576 /* Returns 1 if there was a remote wakeup and a connect status change. */
3577 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
3578 u16 portstatus, u16 portchange)
3579 __must_hold(&port_dev->status_lock)
3581 struct usb_port *port_dev = hub->ports[port - 1];
3582 struct usb_device *hdev;
3583 struct usb_device *udev;
3584 int connect_change = 0;
3589 udev = port_dev->child;
3590 if (!hub_is_superspeed(hdev)) {
3591 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
3593 usb_clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
3595 link_state = portstatus & USB_PORT_STAT_LINK_STATE;
3596 if (!udev || udev->state != USB_STATE_SUSPENDED ||
3597 (link_state != USB_SS_PORT_LS_U0 &&
3598 link_state != USB_SS_PORT_LS_U1 &&
3599 link_state != USB_SS_PORT_LS_U2))
3604 /* TRSMRCY = 10 msec */
3607 usb_unlock_port(port_dev);
3608 ret = usb_remote_wakeup(udev);
3609 usb_lock_port(port_dev);
3614 hub_port_disable(hub, port, 1);
3616 dev_dbg(&port_dev->dev, "resume, status %d\n", ret);
3617 return connect_change;
3620 static int check_ports_changed(struct usb_hub *hub)
3624 for (port1 = 1; port1 <= hub->hdev->maxchild; ++port1) {
3625 u16 portstatus, portchange;
3628 status = hub_port_status(hub, port1, &portstatus, &portchange);
3629 if (!status && portchange)
3635 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
3637 struct usb_hub *hub = usb_get_intfdata(intf);
3638 struct usb_device *hdev = hub->hdev;
3643 * Warn if children aren't already suspended.
3644 * Also, add up the number of wakeup-enabled descendants.
3646 hub->wakeup_enabled_descendants = 0;
3647 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3648 struct usb_port *port_dev = hub->ports[port1 - 1];
3649 struct usb_device *udev = port_dev->child;
3651 if (udev && udev->can_submit) {
3652 dev_warn(&port_dev->dev, "device %s not suspended yet\n",
3653 dev_name(&udev->dev));
3654 if (PMSG_IS_AUTO(msg))
3658 hub->wakeup_enabled_descendants +=
3659 wakeup_enabled_descendants(udev);
3662 if (hdev->do_remote_wakeup && hub->quirk_check_port_auto_suspend) {
3663 /* check if there are changes pending on hub ports */
3664 if (check_ports_changed(hub)) {
3665 if (PMSG_IS_AUTO(msg))
3667 pm_wakeup_event(&hdev->dev, 2000);
3671 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
3672 /* Enable hub to send remote wakeup for all ports. */
3673 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3674 status = set_port_feature(hdev,
3676 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
3677 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
3678 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
3679 USB_PORT_FEAT_REMOTE_WAKE_MASK);
3683 dev_dbg(&intf->dev, "%s\n", __func__);
3685 /* stop hub_wq and related activity */
3686 hub_quiesce(hub, HUB_SUSPEND);
3690 /* Report wakeup requests from the ports of a resuming root hub */
3691 static void report_wakeup_requests(struct usb_hub *hub)
3693 struct usb_device *hdev = hub->hdev;
3694 struct usb_device *udev;
3695 struct usb_hcd *hcd;
3696 unsigned long resuming_ports;
3700 return; /* Not a root hub */
3702 hcd = bus_to_hcd(hdev->bus);
3703 if (hcd->driver->get_resuming_ports) {
3706 * The get_resuming_ports() method returns a bitmap (origin 0)
3707 * of ports which have started wakeup signaling but have not
3708 * yet finished resuming. During system resume we will
3709 * resume all the enabled ports, regardless of any wakeup
3710 * signals, which means the wakeup requests would be lost.
3711 * To prevent this, report them to the PM core here.
3713 resuming_ports = hcd->driver->get_resuming_ports(hcd);
3714 for (i = 0; i < hdev->maxchild; ++i) {
3715 if (test_bit(i, &resuming_ports)) {
3716 udev = hub->ports[i]->child;
3718 pm_wakeup_event(&udev->dev, 0);
3724 static int hub_resume(struct usb_interface *intf)
3726 struct usb_hub *hub = usb_get_intfdata(intf);
3728 dev_dbg(&intf->dev, "%s\n", __func__);
3729 hub_activate(hub, HUB_RESUME);
3732 * This should be called only for system resume, not runtime resume.
3733 * We can't tell the difference here, so some wakeup requests will be
3734 * reported at the wrong time or more than once. This shouldn't
3735 * matter much, so long as they do get reported.
3737 report_wakeup_requests(hub);
3741 static int hub_reset_resume(struct usb_interface *intf)
3743 struct usb_hub *hub = usb_get_intfdata(intf);
3745 dev_dbg(&intf->dev, "%s\n", __func__);
3746 hub_activate(hub, HUB_RESET_RESUME);
3751 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3752 * @rhdev: struct usb_device for the root hub
3754 * The USB host controller driver calls this function when its root hub
3755 * is resumed and Vbus power has been interrupted or the controller
3756 * has been reset. The routine marks @rhdev as having lost power.
3757 * When the hub driver is resumed it will take notice and carry out
3758 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3759 * the others will be disconnected.
3761 void usb_root_hub_lost_power(struct usb_device *rhdev)
3763 dev_notice(&rhdev->dev, "root hub lost power or was reset\n");
3764 rhdev->reset_resume = 1;
3766 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
3768 static const char * const usb3_lpm_names[] = {
3776 * Send a Set SEL control transfer to the device, prior to enabling
3777 * device-initiated U1 or U2. This lets the device know the exit latencies from
3778 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3779 * packet from the host.
3781 * This function will fail if the SEL or PEL values for udev are greater than
3782 * the maximum allowed values for the link state to be enabled.
3784 static int usb_req_set_sel(struct usb_device *udev, enum usb3_link_state state)
3786 struct usb_set_sel_req *sel_values;
3787 unsigned long long u1_sel;
3788 unsigned long long u1_pel;
3789 unsigned long long u2_sel;
3790 unsigned long long u2_pel;
3793 if (udev->state != USB_STATE_CONFIGURED)
3796 /* Convert SEL and PEL stored in ns to us */
3797 u1_sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
3798 u1_pel = DIV_ROUND_UP(udev->u1_params.pel, 1000);
3799 u2_sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
3800 u2_pel = DIV_ROUND_UP(udev->u2_params.pel, 1000);
3803 * Make sure that the calculated SEL and PEL values for the link
3804 * state we're enabling aren't bigger than the max SEL/PEL
3805 * value that will fit in the SET SEL control transfer.
3806 * Otherwise the device would get an incorrect idea of the exit
3807 * latency for the link state, and could start a device-initiated
3808 * U1/U2 when the exit latencies are too high.
3810 if ((state == USB3_LPM_U1 &&
3811 (u1_sel > USB3_LPM_MAX_U1_SEL_PEL ||
3812 u1_pel > USB3_LPM_MAX_U1_SEL_PEL)) ||
3813 (state == USB3_LPM_U2 &&
3814 (u2_sel > USB3_LPM_MAX_U2_SEL_PEL ||
3815 u2_pel > USB3_LPM_MAX_U2_SEL_PEL))) {
3816 dev_dbg(&udev->dev, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3817 usb3_lpm_names[state], u1_sel, u1_pel);
3822 * If we're enabling device-initiated LPM for one link state,
3823 * but the other link state has a too high SEL or PEL value,
3824 * just set those values to the max in the Set SEL request.
3826 if (u1_sel > USB3_LPM_MAX_U1_SEL_PEL)
3827 u1_sel = USB3_LPM_MAX_U1_SEL_PEL;
3829 if (u1_pel > USB3_LPM_MAX_U1_SEL_PEL)
3830 u1_pel = USB3_LPM_MAX_U1_SEL_PEL;
3832 if (u2_sel > USB3_LPM_MAX_U2_SEL_PEL)
3833 u2_sel = USB3_LPM_MAX_U2_SEL_PEL;
3835 if (u2_pel > USB3_LPM_MAX_U2_SEL_PEL)
3836 u2_pel = USB3_LPM_MAX_U2_SEL_PEL;
3839 * usb_enable_lpm() can be called as part of a failed device reset,
3840 * which may be initiated by an error path of a mass storage driver.
3841 * Therefore, use GFP_NOIO.
3843 sel_values = kmalloc(sizeof *(sel_values), GFP_NOIO);
3847 sel_values->u1_sel = u1_sel;
3848 sel_values->u1_pel = u1_pel;
3849 sel_values->u2_sel = cpu_to_le16(u2_sel);
3850 sel_values->u2_pel = cpu_to_le16(u2_pel);
3852 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3856 sel_values, sizeof *(sel_values),
3857 USB_CTRL_SET_TIMEOUT);
3863 * Enable or disable device-initiated U1 or U2 transitions.
3865 static int usb_set_device_initiated_lpm(struct usb_device *udev,
3866 enum usb3_link_state state, bool enable)
3873 feature = USB_DEVICE_U1_ENABLE;
3876 feature = USB_DEVICE_U2_ENABLE;
3879 dev_warn(&udev->dev, "%s: Can't %s non-U1 or U2 state.\n",
3880 __func__, enable ? "enable" : "disable");
3884 if (udev->state != USB_STATE_CONFIGURED) {
3885 dev_dbg(&udev->dev, "%s: Can't %s %s state "
3886 "for unconfigured device.\n",
3887 __func__, enable ? "enable" : "disable",
3888 usb3_lpm_names[state]);
3894 * Now send the control transfer to enable device-initiated LPM
3895 * for either U1 or U2.
3897 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3898 USB_REQ_SET_FEATURE,
3902 USB_CTRL_SET_TIMEOUT);
3904 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3905 USB_REQ_CLEAR_FEATURE,
3909 USB_CTRL_SET_TIMEOUT);
3912 dev_warn(&udev->dev, "%s of device-initiated %s failed.\n",
3913 enable ? "Enable" : "Disable",
3914 usb3_lpm_names[state]);
3920 static int usb_set_lpm_timeout(struct usb_device *udev,
3921 enum usb3_link_state state, int timeout)
3928 feature = USB_PORT_FEAT_U1_TIMEOUT;
3931 feature = USB_PORT_FEAT_U2_TIMEOUT;
3934 dev_warn(&udev->dev, "%s: Can't set timeout for non-U1 or U2 state.\n",
3939 if (state == USB3_LPM_U1 && timeout > USB3_LPM_U1_MAX_TIMEOUT &&
3940 timeout != USB3_LPM_DEVICE_INITIATED) {
3941 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x, "
3942 "which is a reserved value.\n",
3943 usb3_lpm_names[state], timeout);
3947 ret = set_port_feature(udev->parent,
3948 USB_PORT_LPM_TIMEOUT(timeout) | udev->portnum,
3951 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x,"
3952 "error code %i\n", usb3_lpm_names[state],
3956 if (state == USB3_LPM_U1)
3957 udev->u1_params.timeout = timeout;
3959 udev->u2_params.timeout = timeout;
3964 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3967 * We will attempt to enable U1 or U2, but there are no guarantees that the
3968 * control transfers to set the hub timeout or enable device-initiated U1/U2
3969 * will be successful.
3971 * If the control transfer to enable device-initiated U1/U2 entry fails, then
3972 * hub-initiated U1/U2 will be disabled.
3974 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3975 * driver know about it. If that call fails, it should be harmless, and just
3976 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3978 static void usb_enable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3979 enum usb3_link_state state)
3982 __u8 u1_mel = udev->bos->ss_cap->bU1devExitLat;
3983 __le16 u2_mel = udev->bos->ss_cap->bU2DevExitLat;
3985 /* If the device says it doesn't have *any* exit latency to come out of
3986 * U1 or U2, it's probably lying. Assume it doesn't implement that link
3989 if ((state == USB3_LPM_U1 && u1_mel == 0) ||
3990 (state == USB3_LPM_U2 && u2_mel == 0))
3994 * First, let the device know about the exit latencies
3995 * associated with the link state we're about to enable.
3997 ret = usb_req_set_sel(udev, state);
3999 dev_warn(&udev->dev, "Set SEL for device-initiated %s failed.\n",
4000 usb3_lpm_names[state]);
4004 /* We allow the host controller to set the U1/U2 timeout internally
4005 * first, so that it can change its schedule to account for the
4006 * additional latency to send data to a device in a lower power
4009 timeout = hcd->driver->enable_usb3_lpm_timeout(hcd, udev, state);
4011 /* xHCI host controller doesn't want to enable this LPM state. */
4016 dev_warn(&udev->dev, "Could not enable %s link state, "
4017 "xHCI error %i.\n", usb3_lpm_names[state],
4022 if (usb_set_lpm_timeout(udev, state, timeout)) {
4023 /* If we can't set the parent hub U1/U2 timeout,
4024 * device-initiated LPM won't be allowed either, so let the xHCI
4025 * host know that this link state won't be enabled.
4027 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
4031 /* Only a configured device will accept the Set Feature
4034 if (udev->actconfig &&
4035 usb_set_device_initiated_lpm(udev, state, true) == 0) {
4036 if (state == USB3_LPM_U1)
4037 udev->usb3_lpm_u1_enabled = 1;
4038 else if (state == USB3_LPM_U2)
4039 udev->usb3_lpm_u2_enabled = 1;
4041 /* Don't request U1/U2 entry if the device
4042 * cannot transition to U1/U2.
4044 usb_set_lpm_timeout(udev, state, 0);
4045 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
4050 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
4053 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
4054 * If zero is returned, the parent will not allow the link to go into U1/U2.
4056 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
4057 * it won't have an effect on the bus link state because the parent hub will
4058 * still disallow device-initiated U1/U2 entry.
4060 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
4061 * possible. The result will be slightly more bus bandwidth will be taken up
4062 * (to account for U1/U2 exit latency), but it should be harmless.
4064 static int usb_disable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
4065 enum usb3_link_state state)
4072 dev_warn(&udev->dev, "%s: Can't disable non-U1 or U2 state.\n",
4077 if (usb_set_lpm_timeout(udev, state, 0))
4080 usb_set_device_initiated_lpm(udev, state, false);
4082 if (hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state))
4083 dev_warn(&udev->dev, "Could not disable xHCI %s timeout, "
4084 "bus schedule bandwidth may be impacted.\n",
4085 usb3_lpm_names[state]);
4087 /* As soon as usb_set_lpm_timeout(0) return 0, hub initiated LPM
4088 * is disabled. Hub will disallows link to enter U1/U2 as well,
4089 * even device is initiating LPM. Hence LPM is disabled if hub LPM
4090 * timeout set to 0, no matter device-initiated LPM is disabled or
4093 if (state == USB3_LPM_U1)
4094 udev->usb3_lpm_u1_enabled = 0;
4095 else if (state == USB3_LPM_U2)
4096 udev->usb3_lpm_u2_enabled = 0;
4102 * Disable hub-initiated and device-initiated U1 and U2 entry.
4103 * Caller must own the bandwidth_mutex.
4105 * This will call usb_enable_lpm() on failure, which will decrement
4106 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
4108 int usb_disable_lpm(struct usb_device *udev)
4110 struct usb_hcd *hcd;
4112 if (!udev || !udev->parent ||
4113 udev->speed < USB_SPEED_SUPER ||
4114 !udev->lpm_capable ||
4115 udev->state < USB_STATE_DEFAULT)
4118 hcd = bus_to_hcd(udev->bus);
4119 if (!hcd || !hcd->driver->disable_usb3_lpm_timeout)
4122 udev->lpm_disable_count++;
4123 if ((udev->u1_params.timeout == 0 && udev->u2_params.timeout == 0))
4126 /* If LPM is enabled, attempt to disable it. */
4127 if (usb_disable_link_state(hcd, udev, USB3_LPM_U1))
4129 if (usb_disable_link_state(hcd, udev, USB3_LPM_U2))
4135 usb_enable_lpm(udev);
4138 EXPORT_SYMBOL_GPL(usb_disable_lpm);
4140 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
4141 int usb_unlocked_disable_lpm(struct usb_device *udev)
4143 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4149 mutex_lock(hcd->bandwidth_mutex);
4150 ret = usb_disable_lpm(udev);
4151 mutex_unlock(hcd->bandwidth_mutex);
4155 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
4158 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
4159 * xHCI host policy may prevent U1 or U2 from being enabled.
4161 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
4162 * until the lpm_disable_count drops to zero. Caller must own the
4165 void usb_enable_lpm(struct usb_device *udev)
4167 struct usb_hcd *hcd;
4168 struct usb_hub *hub;
4169 struct usb_port *port_dev;
4171 if (!udev || !udev->parent ||
4172 udev->speed < USB_SPEED_SUPER ||
4173 !udev->lpm_capable ||
4174 udev->state < USB_STATE_DEFAULT)
4177 udev->lpm_disable_count--;
4178 hcd = bus_to_hcd(udev->bus);
4179 /* Double check that we can both enable and disable LPM.
4180 * Device must be configured to accept set feature U1/U2 timeout.
4182 if (!hcd || !hcd->driver->enable_usb3_lpm_timeout ||
4183 !hcd->driver->disable_usb3_lpm_timeout)
4186 if (udev->lpm_disable_count > 0)
4189 hub = usb_hub_to_struct_hub(udev->parent);
4193 port_dev = hub->ports[udev->portnum - 1];
4195 if (port_dev->usb3_lpm_u1_permit)
4196 usb_enable_link_state(hcd, udev, USB3_LPM_U1);
4198 if (port_dev->usb3_lpm_u2_permit)
4199 usb_enable_link_state(hcd, udev, USB3_LPM_U2);
4201 EXPORT_SYMBOL_GPL(usb_enable_lpm);
4203 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
4204 void usb_unlocked_enable_lpm(struct usb_device *udev)
4206 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4211 mutex_lock(hcd->bandwidth_mutex);
4212 usb_enable_lpm(udev);
4213 mutex_unlock(hcd->bandwidth_mutex);
4215 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
4217 /* usb3 devices use U3 for disabled, make sure remote wakeup is disabled */
4218 static void hub_usb3_port_prepare_disable(struct usb_hub *hub,
4219 struct usb_port *port_dev)
4221 struct usb_device *udev = port_dev->child;
4224 if (udev && udev->port_is_suspended && udev->do_remote_wakeup) {
4225 ret = hub_set_port_link_state(hub, port_dev->portnum,
4228 msleep(USB_RESUME_TIMEOUT);
4229 ret = usb_disable_remote_wakeup(udev);
4232 dev_warn(&udev->dev,
4233 "Port disable: can't disable remote wake\n");
4234 udev->do_remote_wakeup = 0;
4238 #else /* CONFIG_PM */
4240 #define hub_suspend NULL
4241 #define hub_resume NULL
4242 #define hub_reset_resume NULL
4244 static inline void hub_usb3_port_prepare_disable(struct usb_hub *hub,
4245 struct usb_port *port_dev) { }
4247 int usb_disable_lpm(struct usb_device *udev)
4251 EXPORT_SYMBOL_GPL(usb_disable_lpm);
4253 void usb_enable_lpm(struct usb_device *udev) { }
4254 EXPORT_SYMBOL_GPL(usb_enable_lpm);
4256 int usb_unlocked_disable_lpm(struct usb_device *udev)
4260 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
4262 void usb_unlocked_enable_lpm(struct usb_device *udev) { }
4263 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
4265 int usb_disable_ltm(struct usb_device *udev)
4269 EXPORT_SYMBOL_GPL(usb_disable_ltm);
4271 void usb_enable_ltm(struct usb_device *udev) { }
4272 EXPORT_SYMBOL_GPL(usb_enable_ltm);
4274 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
4275 u16 portstatus, u16 portchange)
4280 #endif /* CONFIG_PM */
4283 * USB-3 does not have a similar link state as USB-2 that will avoid negotiating
4284 * a connection with a plugged-in cable but will signal the host when the cable
4285 * is unplugged. Disable remote wake and set link state to U3 for USB-3 devices
4287 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
4289 struct usb_port *port_dev = hub->ports[port1 - 1];
4290 struct usb_device *hdev = hub->hdev;
4294 if (hub_is_superspeed(hub->hdev)) {
4295 hub_usb3_port_prepare_disable(hub, port_dev);
4296 ret = hub_set_port_link_state(hub, port_dev->portnum,
4299 ret = usb_clear_port_feature(hdev, port1,
4300 USB_PORT_FEAT_ENABLE);
4303 if (port_dev->child && set_state)
4304 usb_set_device_state(port_dev->child, USB_STATE_NOTATTACHED);
4305 if (ret && ret != -ENODEV)
4306 dev_err(&port_dev->dev, "cannot disable (err = %d)\n", ret);
4311 * usb_port_disable - disable a usb device's upstream port
4312 * @udev: device to disable
4313 * Context: @udev locked, must be able to sleep.
4315 * Disables a USB device that isn't in active use.
4317 int usb_port_disable(struct usb_device *udev)
4319 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
4321 return hub_port_disable(hub, udev->portnum, 0);
4324 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
4326 * Between connect detection and reset signaling there must be a delay
4327 * of 100ms at least for debounce and power-settling. The corresponding
4328 * timer shall restart whenever the downstream port detects a disconnect.
4330 * Apparently there are some bluetooth and irda-dongles and a number of
4331 * low-speed devices for which this debounce period may last over a second.
4332 * Not covered by the spec - but easy to deal with.
4334 * This implementation uses a 1500ms total debounce timeout; if the
4335 * connection isn't stable by then it returns -ETIMEDOUT. It checks
4336 * every 25ms for transient disconnects. When the port status has been
4337 * unchanged for 100ms it returns the port status.
4339 int hub_port_debounce(struct usb_hub *hub, int port1, bool must_be_connected)
4342 u16 portchange, portstatus;
4343 unsigned connection = 0xffff;
4344 int total_time, stable_time = 0;
4345 struct usb_port *port_dev = hub->ports[port1 - 1];
4347 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
4348 ret = hub_port_status(hub, port1, &portstatus, &portchange);
4352 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
4353 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
4354 if (!must_be_connected ||
4355 (connection == USB_PORT_STAT_CONNECTION))
4356 stable_time += HUB_DEBOUNCE_STEP;
4357 if (stable_time >= HUB_DEBOUNCE_STABLE)
4361 connection = portstatus & USB_PORT_STAT_CONNECTION;
4364 if (portchange & USB_PORT_STAT_C_CONNECTION) {
4365 usb_clear_port_feature(hub->hdev, port1,
4366 USB_PORT_FEAT_C_CONNECTION);
4369 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
4371 msleep(HUB_DEBOUNCE_STEP);
4374 dev_dbg(&port_dev->dev, "debounce total %dms stable %dms status 0x%x\n",
4375 total_time, stable_time, portstatus);
4377 if (stable_time < HUB_DEBOUNCE_STABLE)
4382 void usb_ep0_reinit(struct usb_device *udev)
4384 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
4385 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
4386 usb_enable_endpoint(udev, &udev->ep0, true);
4388 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
4390 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
4391 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
4393 static int hub_set_address(struct usb_device *udev, int devnum)
4396 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4399 * The host controller will choose the device address,
4400 * instead of the core having chosen it earlier
4402 if (!hcd->driver->address_device && devnum <= 1)
4404 if (udev->state == USB_STATE_ADDRESS)
4406 if (udev->state != USB_STATE_DEFAULT)
4408 if (hcd->driver->address_device)
4409 retval = hcd->driver->address_device(hcd, udev);
4411 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
4412 USB_REQ_SET_ADDRESS, 0, devnum, 0,
4413 NULL, 0, USB_CTRL_SET_TIMEOUT);
4415 update_devnum(udev, devnum);
4416 /* Device now using proper address. */
4417 usb_set_device_state(udev, USB_STATE_ADDRESS);
4418 usb_ep0_reinit(udev);
4424 * There are reports of USB 3.0 devices that say they support USB 2.0 Link PM
4425 * when they're plugged into a USB 2.0 port, but they don't work when LPM is
4428 * Only enable USB 2.0 Link PM if the port is internal (hardwired), or the
4429 * device says it supports the new USB 2.0 Link PM errata by setting the BESL
4430 * support bit in the BOS descriptor.
4432 static void hub_set_initial_usb2_lpm_policy(struct usb_device *udev)
4434 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
4435 int connect_type = USB_PORT_CONNECT_TYPE_UNKNOWN;
4437 if (!udev->usb2_hw_lpm_capable || !udev->bos)
4441 connect_type = hub->ports[udev->portnum - 1]->connect_type;
4443 if ((udev->bos->ext_cap->bmAttributes & cpu_to_le32(USB_BESL_SUPPORT)) ||
4444 connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
4445 udev->usb2_hw_lpm_allowed = 1;
4446 usb_enable_usb2_hardware_lpm(udev);
4450 static int hub_enable_device(struct usb_device *udev)
4452 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4454 if (!hcd->driver->enable_device)
4456 if (udev->state == USB_STATE_ADDRESS)
4458 if (udev->state != USB_STATE_DEFAULT)
4461 return hcd->driver->enable_device(hcd, udev);
4464 /* Reset device, (re)assign address, get device descriptor.
4465 * Device connection must be stable, no more debouncing needed.
4466 * Returns device in USB_STATE_ADDRESS, except on error.
4468 * If this is called for an already-existing device (as part of
4469 * usb_reset_and_verify_device), the caller must own the device lock and
4470 * the port lock. For a newly detected device that is not accessible
4471 * through any global pointers, it's not necessary to lock the device,
4472 * but it is still necessary to lock the port.
4475 hub_port_init(struct usb_hub *hub, struct usb_device *udev, int port1,
4478 struct usb_device *hdev = hub->hdev;
4479 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4480 struct usb_port *port_dev = hub->ports[port1 - 1];
4481 int retries, operations, retval, i;
4482 unsigned delay = HUB_SHORT_RESET_TIME;
4483 enum usb_device_speed oldspeed = udev->speed;
4485 int devnum = udev->devnum;
4486 const char *driver_name;
4488 /* root hub ports have a slightly longer reset period
4489 * (from USB 2.0 spec, section 7.1.7.5)
4491 if (!hdev->parent) {
4492 delay = HUB_ROOT_RESET_TIME;
4493 if (port1 == hdev->bus->otg_port)
4494 hdev->bus->b_hnp_enable = 0;
4497 /* Some low speed devices have problems with the quick delay, so */
4498 /* be a bit pessimistic with those devices. RHbug #23670 */
4499 if (oldspeed == USB_SPEED_LOW)
4500 delay = HUB_LONG_RESET_TIME;
4502 mutex_lock(hcd->address0_mutex);
4504 /* Reset the device; full speed may morph to high speed */
4505 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
4506 retval = hub_port_reset(hub, port1, udev, delay, false);
4507 if (retval < 0) /* error or disconnect */
4509 /* success, speed is known */
4513 /* Don't allow speed changes at reset, except usb 3.0 to faster */
4514 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed &&
4515 !(oldspeed == USB_SPEED_SUPER && udev->speed > oldspeed)) {
4516 dev_dbg(&udev->dev, "device reset changed speed!\n");
4519 oldspeed = udev->speed;
4521 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4522 * it's fixed size except for full speed devices.
4523 * For Wireless USB devices, ep0 max packet is always 512 (tho
4524 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4526 switch (udev->speed) {
4527 case USB_SPEED_SUPER_PLUS:
4528 case USB_SPEED_SUPER:
4529 case USB_SPEED_WIRELESS: /* fixed at 512 */
4530 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
4532 case USB_SPEED_HIGH: /* fixed at 64 */
4533 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4535 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
4536 /* to determine the ep0 maxpacket size, try to read
4537 * the device descriptor to get bMaxPacketSize0 and
4538 * then correct our initial guess.
4540 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4542 case USB_SPEED_LOW: /* fixed at 8 */
4543 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
4549 if (udev->speed == USB_SPEED_WIRELESS)
4550 speed = "variable speed Wireless";
4552 speed = usb_speed_string(udev->speed);
4555 * The controller driver may be NULL if the controller device
4556 * is the middle device between platform device and roothub.
4557 * This middle device may not need a device driver due to
4558 * all hardware control can be at platform device driver, this
4559 * platform device is usually a dual-role USB controller device.
4561 if (udev->bus->controller->driver)
4562 driver_name = udev->bus->controller->driver->name;
4564 driver_name = udev->bus->sysdev->driver->name;
4566 if (udev->speed < USB_SPEED_SUPER)
4567 dev_info(&udev->dev,
4568 "%s %s USB device number %d using %s\n",
4569 (udev->config) ? "reset" : "new", speed,
4570 devnum, driver_name);
4572 /* Set up TT records, if needed */
4574 udev->tt = hdev->tt;
4575 udev->ttport = hdev->ttport;
4576 } else if (udev->speed != USB_SPEED_HIGH
4577 && hdev->speed == USB_SPEED_HIGH) {
4579 dev_err(&udev->dev, "parent hub has no TT\n");
4583 udev->tt = &hub->tt;
4584 udev->ttport = port1;
4587 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4588 * Because device hardware and firmware is sometimes buggy in
4589 * this area, and this is how Linux has done it for ages.
4590 * Change it cautiously.
4592 * NOTE: If use_new_scheme() is true we will start by issuing
4593 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4594 * so it may help with some non-standards-compliant devices.
4595 * Otherwise we start with SET_ADDRESS and then try to read the
4596 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4599 for (retries = 0; retries < GET_DESCRIPTOR_TRIES; (++retries, msleep(100))) {
4600 bool did_new_scheme = false;
4602 if (use_new_scheme(udev, retry_counter, port_dev)) {
4603 struct usb_device_descriptor *buf;
4606 did_new_scheme = true;
4607 retval = hub_enable_device(udev);
4610 "hub failed to enable device, error %d\n",
4615 #define GET_DESCRIPTOR_BUFSIZE 64
4616 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
4622 /* Retry on all errors; some devices are flakey.
4623 * 255 is for WUSB devices, we actually need to use
4624 * 512 (WUSB1.0[4.8.1]).
4626 for (operations = 0; operations < 3; ++operations) {
4627 buf->bMaxPacketSize0 = 0;
4628 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
4629 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
4630 USB_DT_DEVICE << 8, 0,
4631 buf, GET_DESCRIPTOR_BUFSIZE,
4632 initial_descriptor_timeout);
4633 switch (buf->bMaxPacketSize0) {
4634 case 8: case 16: case 32: case 64: case 255:
4635 if (buf->bDescriptorType ==
4647 * Some devices time out if they are powered on
4648 * when already connected. They need a second
4649 * reset. But only on the first attempt,
4650 * lest we get into a time out/reset loop
4652 if (r == 0 || (r == -ETIMEDOUT &&
4654 udev->speed > USB_SPEED_FULL))
4657 udev->descriptor.bMaxPacketSize0 =
4658 buf->bMaxPacketSize0;
4661 retval = hub_port_reset(hub, port1, udev, delay, false);
4662 if (retval < 0) /* error or disconnect */
4664 if (oldspeed != udev->speed) {
4666 "device reset changed speed!\n");
4672 dev_err(&udev->dev, "device descriptor read/64, error %d\n",
4677 #undef GET_DESCRIPTOR_BUFSIZE
4681 * If device is WUSB, we already assigned an
4682 * unauthorized address in the Connect Ack sequence;
4683 * authorization will assign the final address.
4685 if (udev->wusb == 0) {
4686 for (operations = 0; operations < SET_ADDRESS_TRIES; ++operations) {
4687 retval = hub_set_address(udev, devnum);
4693 if (retval != -ENODEV)
4694 dev_err(&udev->dev, "device not accepting address %d, error %d\n",
4698 if (udev->speed >= USB_SPEED_SUPER) {
4699 devnum = udev->devnum;
4700 dev_info(&udev->dev,
4701 "%s SuperSpeed%s%s USB device number %d using %s\n",
4702 (udev->config) ? "reset" : "new",
4703 (udev->speed == USB_SPEED_SUPER_PLUS) ?
4704 "Plus Gen 2" : " Gen 1",
4705 (udev->rx_lanes == 2 && udev->tx_lanes == 2) ?
4707 devnum, driver_name);
4710 /* cope with hardware quirkiness:
4711 * - let SET_ADDRESS settle, some device hardware wants it
4712 * - read ep0 maxpacket even for high and low speed,
4715 /* use_new_scheme() checks the speed which may have
4716 * changed since the initial look so we cache the result
4723 retval = usb_get_device_descriptor(udev, 8);
4725 if (retval != -ENODEV)
4727 "device descriptor read/8, error %d\n",
4736 delay = udev->parent->hub_delay;
4737 udev->hub_delay = min_t(u32, delay,
4738 USB_TP_TRANSMISSION_DELAY_MAX);
4739 retval = usb_set_isoch_delay(udev);
4742 "Failed set isoch delay, error %d\n",
4753 * Some superspeed devices have finished the link training process
4754 * and attached to a superspeed hub port, but the device descriptor
4755 * got from those devices show they aren't superspeed devices. Warm
4756 * reset the port attached by the devices can fix them.
4758 if ((udev->speed >= USB_SPEED_SUPER) &&
4759 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
4760 dev_err(&udev->dev, "got a wrong device descriptor, "
4761 "warm reset device\n");
4762 hub_port_reset(hub, port1, udev,
4763 HUB_BH_RESET_TIME, true);
4768 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
4769 udev->speed >= USB_SPEED_SUPER)
4772 i = udev->descriptor.bMaxPacketSize0;
4773 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
4774 if (udev->speed == USB_SPEED_LOW ||
4775 !(i == 8 || i == 16 || i == 32 || i == 64)) {
4776 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
4780 if (udev->speed == USB_SPEED_FULL)
4781 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
4783 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
4784 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
4785 usb_ep0_reinit(udev);
4788 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
4789 if (retval < (signed)sizeof(udev->descriptor)) {
4790 if (retval != -ENODEV)
4791 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
4798 usb_detect_quirks(udev);
4800 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
4801 retval = usb_get_bos_descriptor(udev);
4803 udev->lpm_capable = usb_device_supports_lpm(udev);
4804 usb_set_lpm_parameters(udev);
4809 /* notify HCD that we have a device connected and addressed */
4810 if (hcd->driver->update_device)
4811 hcd->driver->update_device(hcd, udev);
4812 hub_set_initial_usb2_lpm_policy(udev);
4815 hub_port_disable(hub, port1, 0);
4816 update_devnum(udev, devnum); /* for disconnect processing */
4818 mutex_unlock(hcd->address0_mutex);
4823 check_highspeed(struct usb_hub *hub, struct usb_device *udev, int port1)
4825 struct usb_qualifier_descriptor *qual;
4828 if (udev->quirks & USB_QUIRK_DEVICE_QUALIFIER)
4831 qual = kmalloc(sizeof *qual, GFP_KERNEL);
4835 status = usb_get_descriptor(udev, USB_DT_DEVICE_QUALIFIER, 0,
4836 qual, sizeof *qual);
4837 if (status == sizeof *qual) {
4838 dev_info(&udev->dev, "not running at top speed; "
4839 "connect to a high speed hub\n");
4840 /* hub LEDs are probably harder to miss than syslog */
4841 if (hub->has_indicators) {
4842 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
4843 queue_delayed_work(system_power_efficient_wq,
4851 hub_power_remaining(struct usb_hub *hub)
4853 struct usb_device *hdev = hub->hdev;
4857 if (!hub->limited_power)
4860 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
4861 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
4862 struct usb_port *port_dev = hub->ports[port1 - 1];
4863 struct usb_device *udev = port_dev->child;
4869 if (hub_is_superspeed(udev))
4875 * Unconfigured devices may not use more than one unit load,
4876 * or 8mA for OTG ports
4878 if (udev->actconfig)
4879 delta = usb_get_max_power(udev, udev->actconfig);
4880 else if (port1 != udev->bus->otg_port || hdev->parent)
4884 if (delta > hub->mA_per_port)
4885 dev_warn(&port_dev->dev, "%dmA is over %umA budget!\n",
4886 delta, hub->mA_per_port);
4889 if (remaining < 0) {
4890 dev_warn(hub->intfdev, "%dmA over power budget!\n",
4897 static void hub_port_connect(struct usb_hub *hub, int port1, u16 portstatus,
4900 int status = -ENODEV;
4903 struct usb_device *hdev = hub->hdev;
4904 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4905 struct usb_port *port_dev = hub->ports[port1 - 1];
4906 struct usb_device *udev = port_dev->child;
4907 static int unreliable_port = -1;
4909 /* Disconnect any existing devices under this port */
4911 if (hcd->usb_phy && !hdev->parent)
4912 usb_phy_notify_disconnect(hcd->usb_phy, udev->speed);
4913 usb_disconnect(&port_dev->child);
4916 /* We can forget about a "removed" device when there's a physical
4917 * disconnect or the connect status changes.
4919 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4920 (portchange & USB_PORT_STAT_C_CONNECTION))
4921 clear_bit(port1, hub->removed_bits);
4923 if (portchange & (USB_PORT_STAT_C_CONNECTION |
4924 USB_PORT_STAT_C_ENABLE)) {
4925 status = hub_port_debounce_be_stable(hub, port1);
4927 if (status != -ENODEV &&
4928 port1 != unreliable_port &&
4930 dev_err(&port_dev->dev, "connect-debounce failed\n");
4931 portstatus &= ~USB_PORT_STAT_CONNECTION;
4932 unreliable_port = port1;
4934 portstatus = status;
4938 /* Return now if debouncing failed or nothing is connected or
4939 * the device was "removed".
4941 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4942 test_bit(port1, hub->removed_bits)) {
4945 * maybe switch power back on (e.g. root hub was reset)
4946 * but only if the port isn't owned by someone else.
4948 if (hub_is_port_power_switchable(hub)
4949 && !port_is_power_on(hub, portstatus)
4950 && !port_dev->port_owner)
4951 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
4953 if (portstatus & USB_PORT_STAT_ENABLE)
4957 if (hub_is_superspeed(hub->hdev))
4963 for (i = 0; i < SET_CONFIG_TRIES; i++) {
4965 /* reallocate for each attempt, since references
4966 * to the previous one can escape in various ways
4968 udev = usb_alloc_dev(hdev, hdev->bus, port1);
4970 dev_err(&port_dev->dev,
4971 "couldn't allocate usb_device\n");
4975 usb_set_device_state(udev, USB_STATE_POWERED);
4976 udev->bus_mA = hub->mA_per_port;
4977 udev->level = hdev->level + 1;
4978 udev->wusb = hub_is_wusb(hub);
4980 /* Devices connected to SuperSpeed hubs are USB 3.0 or later */
4981 if (hub_is_superspeed(hub->hdev))
4982 udev->speed = USB_SPEED_SUPER;
4984 udev->speed = USB_SPEED_UNKNOWN;
4986 choose_devnum(udev);
4987 if (udev->devnum <= 0) {
4988 status = -ENOTCONN; /* Don't retry */
4992 /* reset (non-USB 3.0 devices) and get descriptor */
4993 usb_lock_port(port_dev);
4994 status = hub_port_init(hub, udev, port1, i);
4995 usb_unlock_port(port_dev);
4999 if (udev->quirks & USB_QUIRK_DELAY_INIT)
5002 /* consecutive bus-powered hubs aren't reliable; they can
5003 * violate the voltage drop budget. if the new child has
5004 * a "powered" LED, users should notice we didn't enable it
5005 * (without reading syslog), even without per-port LEDs
5008 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
5009 && udev->bus_mA <= unit_load) {
5012 status = usb_get_std_status(udev, USB_RECIP_DEVICE, 0,
5015 dev_dbg(&udev->dev, "get status %d ?\n", status);
5018 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
5020 "can't connect bus-powered hub "
5022 if (hub->has_indicators) {
5023 hub->indicator[port1-1] =
5024 INDICATOR_AMBER_BLINK;
5026 system_power_efficient_wq,
5029 status = -ENOTCONN; /* Don't retry */
5034 /* check for devices running slower than they could */
5035 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
5036 && udev->speed == USB_SPEED_FULL
5037 && highspeed_hubs != 0)
5038 check_highspeed(hub, udev, port1);
5040 /* Store the parent's children[] pointer. At this point
5041 * udev becomes globally accessible, although presumably
5042 * no one will look at it until hdev is unlocked.
5046 mutex_lock(&usb_port_peer_mutex);
5048 /* We mustn't add new devices if the parent hub has
5049 * been disconnected; we would race with the
5050 * recursively_mark_NOTATTACHED() routine.
5052 spin_lock_irq(&device_state_lock);
5053 if (hdev->state == USB_STATE_NOTATTACHED)
5056 port_dev->child = udev;
5057 spin_unlock_irq(&device_state_lock);
5058 mutex_unlock(&usb_port_peer_mutex);
5060 /* Run it through the hoops (find a driver, etc) */
5062 status = usb_new_device(udev);
5064 mutex_lock(&usb_port_peer_mutex);
5065 spin_lock_irq(&device_state_lock);
5066 port_dev->child = NULL;
5067 spin_unlock_irq(&device_state_lock);
5068 mutex_unlock(&usb_port_peer_mutex);
5070 if (hcd->usb_phy && !hdev->parent)
5071 usb_phy_notify_connect(hcd->usb_phy,
5079 status = hub_power_remaining(hub);
5081 dev_dbg(hub->intfdev, "%dmA power budget left\n", status);
5086 hub_port_disable(hub, port1, 1);
5088 usb_ep0_reinit(udev);
5089 release_devnum(udev);
5092 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
5095 /* When halfway through our retry count, power-cycle the port */
5096 if (i == (SET_CONFIG_TRIES / 2) - 1) {
5097 dev_info(&port_dev->dev, "attempt power cycle\n");
5098 usb_hub_set_port_power(hdev, hub, port1, false);
5099 msleep(2 * hub_power_on_good_delay(hub));
5100 usb_hub_set_port_power(hdev, hub, port1, true);
5101 msleep(hub_power_on_good_delay(hub));
5104 if (hub->hdev->parent ||
5105 !hcd->driver->port_handed_over ||
5106 !(hcd->driver->port_handed_over)(hcd, port1)) {
5107 if (status != -ENOTCONN && status != -ENODEV)
5108 dev_err(&port_dev->dev,
5109 "unable to enumerate USB device\n");
5113 hub_port_disable(hub, port1, 1);
5114 if (hcd->driver->relinquish_port && !hub->hdev->parent) {
5115 if (status != -ENOTCONN && status != -ENODEV)
5116 hcd->driver->relinquish_port(hcd, port1);
5120 /* Handle physical or logical connection change events.
5121 * This routine is called when:
5122 * a port connection-change occurs;
5123 * a port enable-change occurs (often caused by EMI);
5124 * usb_reset_and_verify_device() encounters changed descriptors (as from
5125 * a firmware download)
5126 * caller already locked the hub
5128 static void hub_port_connect_change(struct usb_hub *hub, int port1,
5129 u16 portstatus, u16 portchange)
5130 __must_hold(&port_dev->status_lock)
5132 struct usb_port *port_dev = hub->ports[port1 - 1];
5133 struct usb_device *udev = port_dev->child;
5134 int status = -ENODEV;
5136 dev_dbg(&port_dev->dev, "status %04x, change %04x, %s\n", portstatus,
5137 portchange, portspeed(hub, portstatus));
5139 if (hub->has_indicators) {
5140 set_port_led(hub, port1, HUB_LED_AUTO);
5141 hub->indicator[port1-1] = INDICATOR_AUTO;
5144 #ifdef CONFIG_USB_OTG
5145 /* during HNP, don't repeat the debounce */
5146 if (hub->hdev->bus->is_b_host)
5147 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
5148 USB_PORT_STAT_C_ENABLE);
5151 /* Try to resuscitate an existing device */
5152 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
5153 udev->state != USB_STATE_NOTATTACHED) {
5154 if (portstatus & USB_PORT_STAT_ENABLE) {
5155 status = 0; /* Nothing to do */
5157 } else if (udev->state == USB_STATE_SUSPENDED &&
5158 udev->persist_enabled) {
5159 /* For a suspended device, treat this as a
5160 * remote wakeup event.
5162 usb_unlock_port(port_dev);
5163 status = usb_remote_wakeup(udev);
5164 usb_lock_port(port_dev);
5167 /* Don't resuscitate */;
5170 clear_bit(port1, hub->change_bits);
5172 /* successfully revalidated the connection */
5176 usb_unlock_port(port_dev);
5177 hub_port_connect(hub, port1, portstatus, portchange);
5178 usb_lock_port(port_dev);
5181 static void port_event(struct usb_hub *hub, int port1)
5182 __must_hold(&port_dev->status_lock)
5185 struct usb_port *port_dev = hub->ports[port1 - 1];
5186 struct usb_device *udev = port_dev->child;
5187 struct usb_device *hdev = hub->hdev;
5188 u16 portstatus, portchange;
5190 connect_change = test_bit(port1, hub->change_bits);
5191 clear_bit(port1, hub->event_bits);
5192 clear_bit(port1, hub->wakeup_bits);
5194 if (hub_port_status(hub, port1, &portstatus, &portchange) < 0)
5197 if (portchange & USB_PORT_STAT_C_CONNECTION) {
5198 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_CONNECTION);
5202 if (portchange & USB_PORT_STAT_C_ENABLE) {
5203 if (!connect_change)
5204 dev_dbg(&port_dev->dev, "enable change, status %08x\n",
5206 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_ENABLE);
5209 * EM interference sometimes causes badly shielded USB devices
5210 * to be shutdown by the hub, this hack enables them again.
5211 * Works at least with mouse driver.
5213 if (!(portstatus & USB_PORT_STAT_ENABLE)
5214 && !connect_change && udev) {
5215 dev_err(&port_dev->dev, "disabled by hub (EMI?), re-enabling...\n");
5220 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
5221 u16 status = 0, unused;
5222 port_dev->over_current_count++;
5224 dev_notice(&port_dev->dev, "over-current change #%u\n",
5225 port_dev->over_current_count);
5226 usb_clear_port_feature(hdev, port1,
5227 USB_PORT_FEAT_C_OVER_CURRENT);
5228 msleep(100); /* Cool down */
5229 hub_power_on(hub, true);
5230 hub_port_status(hub, port1, &status, &unused);
5231 if (status & USB_PORT_STAT_OVERCURRENT)
5232 dev_err(&port_dev->dev, "over-current condition\n");
5235 if (portchange & USB_PORT_STAT_C_RESET) {
5236 dev_dbg(&port_dev->dev, "reset change\n");
5237 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_RESET);
5239 if ((portchange & USB_PORT_STAT_C_BH_RESET)
5240 && hub_is_superspeed(hdev)) {
5241 dev_dbg(&port_dev->dev, "warm reset change\n");
5242 usb_clear_port_feature(hdev, port1,
5243 USB_PORT_FEAT_C_BH_PORT_RESET);
5245 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
5246 dev_dbg(&port_dev->dev, "link state change\n");
5247 usb_clear_port_feature(hdev, port1,
5248 USB_PORT_FEAT_C_PORT_LINK_STATE);
5250 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
5251 dev_warn(&port_dev->dev, "config error\n");
5252 usb_clear_port_feature(hdev, port1,
5253 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
5256 /* skip port actions that require the port to be powered on */
5257 if (!pm_runtime_active(&port_dev->dev))
5260 if (hub_handle_remote_wakeup(hub, port1, portstatus, portchange))
5264 * Warm reset a USB3 protocol port if it's in
5265 * SS.Inactive state.
5267 if (hub_port_warm_reset_required(hub, port1, portstatus)) {
5268 dev_dbg(&port_dev->dev, "do warm reset\n");
5269 if (!udev || !(portstatus & USB_PORT_STAT_CONNECTION)
5270 || udev->state == USB_STATE_NOTATTACHED) {
5271 if (hub_port_reset(hub, port1, NULL,
5272 HUB_BH_RESET_TIME, true) < 0)
5273 hub_port_disable(hub, port1, 1);
5275 usb_unlock_port(port_dev);
5276 usb_lock_device(udev);
5277 usb_reset_device(udev);
5278 usb_unlock_device(udev);
5279 usb_lock_port(port_dev);
5285 hub_port_connect_change(hub, port1, portstatus, portchange);
5288 static void hub_event(struct work_struct *work)
5290 struct usb_device *hdev;
5291 struct usb_interface *intf;
5292 struct usb_hub *hub;
5293 struct device *hub_dev;
5298 hub = container_of(work, struct usb_hub, events);
5300 hub_dev = hub->intfdev;
5301 intf = to_usb_interface(hub_dev);
5303 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
5304 hdev->state, hdev->maxchild,
5305 /* NOTE: expects max 15 ports... */
5306 (u16) hub->change_bits[0],
5307 (u16) hub->event_bits[0]);
5309 /* Lock the device, then check to see if we were
5310 * disconnected while waiting for the lock to succeed. */
5311 usb_lock_device(hdev);
5312 if (unlikely(hub->disconnected))
5315 /* If the hub has died, clean up after it */
5316 if (hdev->state == USB_STATE_NOTATTACHED) {
5317 hub->error = -ENODEV;
5318 hub_quiesce(hub, HUB_DISCONNECT);
5323 ret = usb_autopm_get_interface(intf);
5325 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
5329 /* If this is an inactive hub, do nothing */
5334 dev_dbg(hub_dev, "resetting for error %d\n", hub->error);
5336 ret = usb_reset_device(hdev);
5338 dev_dbg(hub_dev, "error resetting hub: %d\n", ret);
5346 /* deal with port status changes */
5347 for (i = 1; i <= hdev->maxchild; i++) {
5348 struct usb_port *port_dev = hub->ports[i - 1];
5350 if (test_bit(i, hub->event_bits)
5351 || test_bit(i, hub->change_bits)
5352 || test_bit(i, hub->wakeup_bits)) {
5354 * The get_noresume and barrier ensure that if
5355 * the port was in the process of resuming, we
5356 * flush that work and keep the port active for
5357 * the duration of the port_event(). However,
5358 * if the port is runtime pm suspended
5359 * (powered-off), we leave it in that state, run
5360 * an abbreviated port_event(), and move on.
5362 pm_runtime_get_noresume(&port_dev->dev);
5363 pm_runtime_barrier(&port_dev->dev);
5364 usb_lock_port(port_dev);
5366 usb_unlock_port(port_dev);
5367 pm_runtime_put_sync(&port_dev->dev);
5371 /* deal with hub status changes */
5372 if (test_and_clear_bit(0, hub->event_bits) == 0)
5374 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
5375 dev_err(hub_dev, "get_hub_status failed\n");
5377 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
5378 dev_dbg(hub_dev, "power change\n");
5379 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
5380 if (hubstatus & HUB_STATUS_LOCAL_POWER)
5381 /* FIXME: Is this always true? */
5382 hub->limited_power = 1;
5384 hub->limited_power = 0;
5386 if (hubchange & HUB_CHANGE_OVERCURRENT) {
5390 dev_dbg(hub_dev, "over-current change\n");
5391 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
5392 msleep(500); /* Cool down */
5393 hub_power_on(hub, true);
5394 hub_hub_status(hub, &status, &unused);
5395 if (status & HUB_STATUS_OVERCURRENT)
5396 dev_err(hub_dev, "over-current condition\n");
5401 /* Balance the usb_autopm_get_interface() above */
5402 usb_autopm_put_interface_no_suspend(intf);
5404 usb_unlock_device(hdev);
5406 /* Balance the stuff in kick_hub_wq() and allow autosuspend */
5407 usb_autopm_put_interface(intf);
5408 kref_put(&hub->kref, hub_release);
5411 static const struct usb_device_id hub_id_table[] = {
5412 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5413 | USB_DEVICE_ID_MATCH_INT_CLASS,
5414 .idVendor = USB_VENDOR_GENESYS_LOGIC,
5415 .bInterfaceClass = USB_CLASS_HUB,
5416 .driver_info = HUB_QUIRK_CHECK_PORT_AUTOSUSPEND},
5417 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
5418 .bDeviceClass = USB_CLASS_HUB},
5419 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
5420 .bInterfaceClass = USB_CLASS_HUB},
5421 { } /* Terminating entry */
5424 MODULE_DEVICE_TABLE(usb, hub_id_table);
5426 static struct usb_driver hub_driver = {
5429 .disconnect = hub_disconnect,
5430 .suspend = hub_suspend,
5431 .resume = hub_resume,
5432 .reset_resume = hub_reset_resume,
5433 .pre_reset = hub_pre_reset,
5434 .post_reset = hub_post_reset,
5435 .unlocked_ioctl = hub_ioctl,
5436 .id_table = hub_id_table,
5437 .supports_autosuspend = 1,
5440 int usb_hub_init(void)
5442 if (usb_register(&hub_driver) < 0) {
5443 printk(KERN_ERR "%s: can't register hub driver\n",
5449 * The workqueue needs to be freezable to avoid interfering with
5450 * USB-PERSIST port handover. Otherwise it might see that a full-speed
5451 * device was gone before the EHCI controller had handed its port
5452 * over to the companion full-speed controller.
5454 hub_wq = alloc_workqueue("usb_hub_wq", WQ_FREEZABLE, 0);
5458 /* Fall through if kernel_thread failed */
5459 usb_deregister(&hub_driver);
5460 pr_err("%s: can't allocate workqueue for usb hub\n", usbcore_name);
5465 void usb_hub_cleanup(void)
5467 destroy_workqueue(hub_wq);
5470 * Hub resources are freed for us by usb_deregister. It calls
5471 * usb_driver_purge on every device which in turn calls that
5472 * devices disconnect function if it is using this driver.
5473 * The hub_disconnect function takes care of releasing the
5474 * individual hub resources. -greg
5476 usb_deregister(&hub_driver);
5477 } /* usb_hub_cleanup() */
5479 static int descriptors_changed(struct usb_device *udev,
5480 struct usb_device_descriptor *old_device_descriptor,
5481 struct usb_host_bos *old_bos)
5485 unsigned serial_len = 0;
5487 unsigned old_length;
5491 if (memcmp(&udev->descriptor, old_device_descriptor,
5492 sizeof(*old_device_descriptor)) != 0)
5495 if ((old_bos && !udev->bos) || (!old_bos && udev->bos))
5498 len = le16_to_cpu(udev->bos->desc->wTotalLength);
5499 if (len != le16_to_cpu(old_bos->desc->wTotalLength))
5501 if (memcmp(udev->bos->desc, old_bos->desc, len))
5505 /* Since the idVendor, idProduct, and bcdDevice values in the
5506 * device descriptor haven't changed, we will assume the
5507 * Manufacturer and Product strings haven't changed either.
5508 * But the SerialNumber string could be different (e.g., a
5509 * different flash card of the same brand).
5512 serial_len = strlen(udev->serial) + 1;
5515 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5516 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5517 len = max(len, old_length);
5520 buf = kmalloc(len, GFP_NOIO);
5522 /* assume the worst */
5525 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5526 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5527 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
5529 if (length != old_length) {
5530 dev_dbg(&udev->dev, "config index %d, error %d\n",
5535 if (memcmp(buf, udev->rawdescriptors[index], old_length)
5537 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
5539 ((struct usb_config_descriptor *) buf)->
5540 bConfigurationValue);
5546 if (!changed && serial_len) {
5547 length = usb_string(udev, udev->descriptor.iSerialNumber,
5549 if (length + 1 != serial_len) {
5550 dev_dbg(&udev->dev, "serial string error %d\n",
5553 } else if (memcmp(buf, udev->serial, length) != 0) {
5554 dev_dbg(&udev->dev, "serial string changed\n");
5564 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5565 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5567 * WARNING - don't use this routine to reset a composite device
5568 * (one with multiple interfaces owned by separate drivers)!
5569 * Use usb_reset_device() instead.
5571 * Do a port reset, reassign the device's address, and establish its
5572 * former operating configuration. If the reset fails, or the device's
5573 * descriptors change from their values before the reset, or the original
5574 * configuration and altsettings cannot be restored, a flag will be set
5575 * telling hub_wq to pretend the device has been disconnected and then
5576 * re-connected. All drivers will be unbound, and the device will be
5577 * re-enumerated and probed all over again.
5579 * Return: 0 if the reset succeeded, -ENODEV if the device has been
5580 * flagged for logical disconnection, or some other negative error code
5581 * if the reset wasn't even attempted.
5584 * The caller must own the device lock and the port lock, the latter is
5585 * taken by usb_reset_device(). For example, it's safe to use
5586 * usb_reset_device() from a driver probe() routine after downloading
5587 * new firmware. For calls that might not occur during probe(), drivers
5588 * should lock the device using usb_lock_device_for_reset().
5590 * Locking exception: This routine may also be called from within an
5591 * autoresume handler. Such usage won't conflict with other tasks
5592 * holding the device lock because these tasks should always call
5593 * usb_autopm_resume_device(), thereby preventing any unwanted
5594 * autoresume. The autoresume handler is expected to have already
5595 * acquired the port lock before calling this routine.
5597 static int usb_reset_and_verify_device(struct usb_device *udev)
5599 struct usb_device *parent_hdev = udev->parent;
5600 struct usb_hub *parent_hub;
5601 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
5602 struct usb_device_descriptor descriptor = udev->descriptor;
5603 struct usb_host_bos *bos;
5605 int port1 = udev->portnum;
5607 if (udev->state == USB_STATE_NOTATTACHED ||
5608 udev->state == USB_STATE_SUSPENDED) {
5609 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5617 parent_hub = usb_hub_to_struct_hub(parent_hdev);
5619 /* Disable USB2 hardware LPM.
5620 * It will be re-enabled by the enumeration process.
5622 usb_disable_usb2_hardware_lpm(udev);
5624 /* Disable LPM while we reset the device and reinstall the alt settings.
5625 * Device-initiated LPM, and system exit latency settings are cleared
5626 * when the device is reset, so we have to set them up again.
5628 ret = usb_unlocked_disable_lpm(udev);
5630 dev_err(&udev->dev, "%s Failed to disable LPM\n", __func__);
5631 goto re_enumerate_no_bos;
5637 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
5639 /* ep0 maxpacket size may change; let the HCD know about it.
5640 * Other endpoints will be handled by re-enumeration. */
5641 usb_ep0_reinit(udev);
5642 ret = hub_port_init(parent_hub, udev, port1, i);
5643 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
5650 /* Device might have changed firmware (DFU or similar) */
5651 if (descriptors_changed(udev, &descriptor, bos)) {
5652 dev_info(&udev->dev, "device firmware changed\n");
5653 udev->descriptor = descriptor; /* for disconnect() calls */
5657 /* Restore the device's previous configuration */
5658 if (!udev->actconfig)
5661 mutex_lock(hcd->bandwidth_mutex);
5662 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
5664 dev_warn(&udev->dev,
5665 "Busted HC? Not enough HCD resources for "
5666 "old configuration.\n");
5667 mutex_unlock(hcd->bandwidth_mutex);
5670 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
5671 USB_REQ_SET_CONFIGURATION, 0,
5672 udev->actconfig->desc.bConfigurationValue, 0,
5673 NULL, 0, USB_CTRL_SET_TIMEOUT);
5676 "can't restore configuration #%d (error=%d)\n",
5677 udev->actconfig->desc.bConfigurationValue, ret);
5678 mutex_unlock(hcd->bandwidth_mutex);
5681 mutex_unlock(hcd->bandwidth_mutex);
5682 usb_set_device_state(udev, USB_STATE_CONFIGURED);
5684 /* Put interfaces back into the same altsettings as before.
5685 * Don't bother to send the Set-Interface request for interfaces
5686 * that were already in altsetting 0; besides being unnecessary,
5687 * many devices can't handle it. Instead just reset the host-side
5690 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
5691 struct usb_host_config *config = udev->actconfig;
5692 struct usb_interface *intf = config->interface[i];
5693 struct usb_interface_descriptor *desc;
5695 desc = &intf->cur_altsetting->desc;
5696 if (desc->bAlternateSetting == 0) {
5697 usb_disable_interface(udev, intf, true);
5698 usb_enable_interface(udev, intf, true);
5701 /* Let the bandwidth allocation function know that this
5702 * device has been reset, and it will have to use
5703 * alternate setting 0 as the current alternate setting.
5705 intf->resetting_device = 1;
5706 ret = usb_set_interface(udev, desc->bInterfaceNumber,
5707 desc->bAlternateSetting);
5708 intf->resetting_device = 0;
5711 dev_err(&udev->dev, "failed to restore interface %d "
5712 "altsetting %d (error=%d)\n",
5713 desc->bInterfaceNumber,
5714 desc->bAlternateSetting,
5718 /* Resetting also frees any allocated streams */
5719 for (j = 0; j < intf->cur_altsetting->desc.bNumEndpoints; j++)
5720 intf->cur_altsetting->endpoint[j].streams = 0;
5724 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5725 usb_enable_usb2_hardware_lpm(udev);
5726 usb_unlocked_enable_lpm(udev);
5727 usb_enable_ltm(udev);
5728 usb_release_bos_descriptor(udev);
5733 usb_release_bos_descriptor(udev);
5735 re_enumerate_no_bos:
5736 /* LPM state doesn't matter when we're about to destroy the device. */
5737 hub_port_logical_disconnect(parent_hub, port1);
5742 * usb_reset_device - warn interface drivers and perform a USB port reset
5743 * @udev: device to reset (not in NOTATTACHED state)
5745 * Warns all drivers bound to registered interfaces (using their pre_reset
5746 * method), performs the port reset, and then lets the drivers know that
5747 * the reset is over (using their post_reset method).
5749 * Return: The same as for usb_reset_and_verify_device().
5752 * The caller must own the device lock. For example, it's safe to use
5753 * this from a driver probe() routine after downloading new firmware.
5754 * For calls that might not occur during probe(), drivers should lock
5755 * the device using usb_lock_device_for_reset().
5757 * If an interface is currently being probed or disconnected, we assume
5758 * its driver knows how to handle resets. For all other interfaces,
5759 * if the driver doesn't have pre_reset and post_reset methods then
5760 * we attempt to unbind it and rebind afterward.
5762 int usb_reset_device(struct usb_device *udev)
5766 unsigned int noio_flag;
5767 struct usb_port *port_dev;
5768 struct usb_host_config *config = udev->actconfig;
5769 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
5771 if (udev->state == USB_STATE_NOTATTACHED) {
5772 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5777 if (!udev->parent) {
5778 /* this requires hcd-specific logic; see ohci_restart() */
5779 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
5783 port_dev = hub->ports[udev->portnum - 1];
5786 * Don't allocate memory with GFP_KERNEL in current
5787 * context to avoid possible deadlock if usb mass
5788 * storage interface or usbnet interface(iSCSI case)
5789 * is included in current configuration. The easist
5790 * approach is to do it for every device reset,
5791 * because the device 'memalloc_noio' flag may have
5792 * not been set before reseting the usb device.
5794 noio_flag = memalloc_noio_save();
5796 /* Prevent autosuspend during the reset */
5797 usb_autoresume_device(udev);
5800 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
5801 struct usb_interface *cintf = config->interface[i];
5802 struct usb_driver *drv;
5805 if (cintf->dev.driver) {
5806 drv = to_usb_driver(cintf->dev.driver);
5807 if (drv->pre_reset && drv->post_reset)
5808 unbind = (drv->pre_reset)(cintf);
5809 else if (cintf->condition ==
5810 USB_INTERFACE_BOUND)
5813 usb_forced_unbind_intf(cintf);
5818 usb_lock_port(port_dev);
5819 ret = usb_reset_and_verify_device(udev);
5820 usb_unlock_port(port_dev);
5823 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
5824 struct usb_interface *cintf = config->interface[i];
5825 struct usb_driver *drv;
5826 int rebind = cintf->needs_binding;
5828 if (!rebind && cintf->dev.driver) {
5829 drv = to_usb_driver(cintf->dev.driver);
5830 if (drv->post_reset)
5831 rebind = (drv->post_reset)(cintf);
5832 else if (cintf->condition ==
5833 USB_INTERFACE_BOUND)
5836 cintf->needs_binding = 1;
5840 /* If the reset failed, hub_wq will unbind drivers later */
5842 usb_unbind_and_rebind_marked_interfaces(udev);
5845 usb_autosuspend_device(udev);
5846 memalloc_noio_restore(noio_flag);
5849 EXPORT_SYMBOL_GPL(usb_reset_device);
5853 * usb_queue_reset_device - Reset a USB device from an atomic context
5854 * @iface: USB interface belonging to the device to reset
5856 * This function can be used to reset a USB device from an atomic
5857 * context, where usb_reset_device() won't work (as it blocks).
5859 * Doing a reset via this method is functionally equivalent to calling
5860 * usb_reset_device(), except for the fact that it is delayed to a
5861 * workqueue. This means that any drivers bound to other interfaces
5862 * might be unbound, as well as users from usbfs in user space.
5866 * - Scheduling two resets at the same time from two different drivers
5867 * attached to two different interfaces of the same device is
5868 * possible; depending on how the driver attached to each interface
5869 * handles ->pre_reset(), the second reset might happen or not.
5871 * - If the reset is delayed so long that the interface is unbound from
5872 * its driver, the reset will be skipped.
5874 * - This function can be called during .probe(). It can also be called
5875 * during .disconnect(), but doing so is pointless because the reset
5876 * will not occur. If you really want to reset the device during
5877 * .disconnect(), call usb_reset_device() directly -- but watch out
5878 * for nested unbinding issues!
5880 void usb_queue_reset_device(struct usb_interface *iface)
5882 if (schedule_work(&iface->reset_ws))
5883 usb_get_intf(iface);
5885 EXPORT_SYMBOL_GPL(usb_queue_reset_device);
5888 * usb_hub_find_child - Get the pointer of child device
5889 * attached to the port which is specified by @port1.
5890 * @hdev: USB device belonging to the usb hub
5891 * @port1: port num to indicate which port the child device
5894 * USB drivers call this function to get hub's child device
5897 * Return: %NULL if input param is invalid and
5898 * child's usb_device pointer if non-NULL.
5900 struct usb_device *usb_hub_find_child(struct usb_device *hdev,
5903 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5905 if (port1 < 1 || port1 > hdev->maxchild)
5907 return hub->ports[port1 - 1]->child;
5909 EXPORT_SYMBOL_GPL(usb_hub_find_child);
5911 void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
5912 struct usb_hub_descriptor *desc)
5914 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5915 enum usb_port_connect_type connect_type;
5921 if (!hub_is_superspeed(hdev)) {
5922 for (i = 1; i <= hdev->maxchild; i++) {
5923 struct usb_port *port_dev = hub->ports[i - 1];
5925 connect_type = port_dev->connect_type;
5926 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5927 u8 mask = 1 << (i%8);
5929 if (!(desc->u.hs.DeviceRemovable[i/8] & mask)) {
5930 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
5931 desc->u.hs.DeviceRemovable[i/8] |= mask;
5936 u16 port_removable = le16_to_cpu(desc->u.ss.DeviceRemovable);
5938 for (i = 1; i <= hdev->maxchild; i++) {
5939 struct usb_port *port_dev = hub->ports[i - 1];
5941 connect_type = port_dev->connect_type;
5942 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5945 if (!(port_removable & mask)) {
5946 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
5947 port_removable |= mask;
5952 desc->u.ss.DeviceRemovable = cpu_to_le16(port_removable);
5958 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5959 * @hdev: USB device belonging to the usb hub
5960 * @port1: port num of the port
5962 * Return: Port's acpi handle if successful, %NULL if params are
5965 acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
5968 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5973 return ACPI_HANDLE(&hub->ports[port1 - 1]->dev);