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/kcov.h>
22 #include <linux/ioctl.h>
23 #include <linux/usb.h>
24 #include <linux/usbdevice_fs.h>
25 #include <linux/usb/hcd.h>
26 #include <linux/usb/otg.h>
27 #include <linux/usb/quirks.h>
28 #include <linux/workqueue.h>
29 #include <linux/mutex.h>
30 #include <linux/random.h>
31 #include <linux/pm_qos.h>
32 #include <linux/kobject.h>
34 #include <linux/bitfield.h>
35 #include <linux/uaccess.h>
36 #include <asm/byteorder.h>
39 #include "otg_productlist.h"
41 #define USB_VENDOR_GENESYS_LOGIC 0x05e3
42 #define USB_VENDOR_SMSC 0x0424
43 #define USB_PRODUCT_USB5534B 0x5534
44 #define USB_VENDOR_CYPRESS 0x04b4
45 #define USB_PRODUCT_CY7C65632 0x6570
46 #define HUB_QUIRK_CHECK_PORT_AUTOSUSPEND 0x01
47 #define HUB_QUIRK_DISABLE_AUTOSUSPEND 0x02
49 #define USB_TP_TRANSMISSION_DELAY 40 /* ns */
50 #define USB_TP_TRANSMISSION_DELAY_MAX 65535 /* ns */
51 #define USB_PING_RESPONSE_TIME 400 /* ns */
53 /* Protect struct usb_device->state and ->children members
54 * Note: Both are also protected by ->dev.sem, except that ->state can
55 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
56 static DEFINE_SPINLOCK(device_state_lock);
58 /* workqueue to process hub events */
59 static struct workqueue_struct *hub_wq;
60 static void hub_event(struct work_struct *work);
62 /* synchronize hub-port add/remove and peering operations */
63 DEFINE_MUTEX(usb_port_peer_mutex);
65 /* cycle leds on hubs that aren't blinking for attention */
66 static bool blinkenlights;
67 module_param(blinkenlights, bool, S_IRUGO);
68 MODULE_PARM_DESC(blinkenlights, "true to cycle leds on hubs");
71 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
72 * 10 seconds to send reply for the initial 64-byte descriptor request.
74 /* define initial 64-byte descriptor request timeout in milliseconds */
75 static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
76 module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
77 MODULE_PARM_DESC(initial_descriptor_timeout,
78 "initial 64-byte descriptor request timeout in milliseconds "
79 "(default 5000 - 5.0 seconds)");
82 * As of 2.6.10 we introduce a new USB device initialization scheme which
83 * closely resembles the way Windows works. Hopefully it will be compatible
84 * with a wider range of devices than the old scheme. However some previously
85 * working devices may start giving rise to "device not accepting address"
86 * errors; if that happens the user can try the old scheme by adjusting the
87 * following module parameters.
89 * For maximum flexibility there are two boolean parameters to control the
90 * hub driver's behavior. On the first initialization attempt, if the
91 * "old_scheme_first" parameter is set then the old scheme will be used,
92 * otherwise the new scheme is used. If that fails and "use_both_schemes"
93 * is set, then the driver will make another attempt, using the other scheme.
95 static bool old_scheme_first;
96 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
97 MODULE_PARM_DESC(old_scheme_first,
98 "start with the old device initialization scheme");
100 static bool use_both_schemes = true;
101 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
102 MODULE_PARM_DESC(use_both_schemes,
103 "try the other device initialization scheme if the "
106 /* Mutual exclusion for EHCI CF initialization. This interferes with
107 * port reset on some companion controllers.
109 DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
110 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
112 #define HUB_DEBOUNCE_TIMEOUT 2000
113 #define HUB_DEBOUNCE_STEP 25
114 #define HUB_DEBOUNCE_STABLE 100
116 static void hub_release(struct kref *kref);
117 static int usb_reset_and_verify_device(struct usb_device *udev);
118 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state);
119 static bool hub_port_warm_reset_required(struct usb_hub *hub, int port1,
122 static inline char *portspeed(struct usb_hub *hub, int portstatus)
124 if (hub_is_superspeedplus(hub->hdev))
126 if (hub_is_superspeed(hub->hdev))
128 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
130 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
136 /* Note that hdev or one of its children must be locked! */
137 struct usb_hub *usb_hub_to_struct_hub(struct usb_device *hdev)
139 if (!hdev || !hdev->actconfig || !hdev->maxchild)
141 return usb_get_intfdata(hdev->actconfig->interface[0]);
144 int usb_device_supports_lpm(struct usb_device *udev)
146 /* Some devices have trouble with LPM */
147 if (udev->quirks & USB_QUIRK_NO_LPM)
150 /* USB 2.1 (and greater) devices indicate LPM support through
151 * their USB 2.0 Extended Capabilities BOS descriptor.
153 if (udev->speed == USB_SPEED_HIGH || udev->speed == USB_SPEED_FULL) {
154 if (udev->bos->ext_cap &&
156 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
162 * According to the USB 3.0 spec, all USB 3.0 devices must support LPM.
163 * However, there are some that don't, and they set the U1/U2 exit
166 if (!udev->bos->ss_cap) {
167 dev_info(&udev->dev, "No LPM exit latency info found, disabling LPM.\n");
171 if (udev->bos->ss_cap->bU1devExitLat == 0 &&
172 udev->bos->ss_cap->bU2DevExitLat == 0) {
174 dev_info(&udev->dev, "LPM exit latency is zeroed, disabling LPM.\n");
176 dev_info(&udev->dev, "We don't know the algorithms for LPM for this host, disabling LPM.\n");
180 if (!udev->parent || udev->parent->lpm_capable)
186 * Set the Maximum Exit Latency (MEL) for the host to wakup up the path from
187 * U1/U2, send a PING to the device and receive a PING_RESPONSE.
188 * See USB 3.1 section C.1.5.2
190 static void usb_set_lpm_mel(struct usb_device *udev,
191 struct usb3_lpm_parameters *udev_lpm_params,
192 unsigned int udev_exit_latency,
194 struct usb3_lpm_parameters *hub_lpm_params,
195 unsigned int hub_exit_latency)
197 unsigned int total_mel;
200 * tMEL1. time to transition path from host to device into U0.
201 * MEL for parent already contains the delay up to parent, so only add
202 * the exit latency for the last link (pick the slower exit latency),
203 * and the hub header decode latency. See USB 3.1 section C 2.2.1
204 * Store MEL in nanoseconds
206 total_mel = hub_lpm_params->mel +
207 max(udev_exit_latency, hub_exit_latency) * 1000 +
208 hub->descriptor->u.ss.bHubHdrDecLat * 100;
211 * tMEL2. Time to submit PING packet. Sum of tTPTransmissionDelay for
212 * each link + wHubDelay for each hub. Add only for last link.
213 * tMEL4, the time for PING_RESPONSE to traverse upstream is similar.
214 * Multiply by 2 to include it as well.
216 total_mel += (__le16_to_cpu(hub->descriptor->u.ss.wHubDelay) +
217 USB_TP_TRANSMISSION_DELAY) * 2;
220 * tMEL3, tPingResponse. Time taken by device to generate PING_RESPONSE
221 * after receiving PING. Also add 2100ns as stated in USB 3.1 C 1.5.2.4
222 * to cover the delay if the PING_RESPONSE is queued behind a Max Packet
224 * Note these delays should be added only once for the entire path, so
225 * add them to the MEL of the device connected to the roothub.
227 if (!hub->hdev->parent)
228 total_mel += USB_PING_RESPONSE_TIME + 2100;
230 udev_lpm_params->mel = total_mel;
234 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
235 * a transition from either U1 or U2.
237 static void usb_set_lpm_pel(struct usb_device *udev,
238 struct usb3_lpm_parameters *udev_lpm_params,
239 unsigned int udev_exit_latency,
241 struct usb3_lpm_parameters *hub_lpm_params,
242 unsigned int hub_exit_latency,
243 unsigned int port_to_port_exit_latency)
245 unsigned int first_link_pel;
246 unsigned int hub_pel;
249 * First, the device sends an LFPS to transition the link between the
250 * device and the parent hub into U0. The exit latency is the bigger of
251 * the device exit latency or the hub exit latency.
253 if (udev_exit_latency > hub_exit_latency)
254 first_link_pel = udev_exit_latency * 1000;
256 first_link_pel = hub_exit_latency * 1000;
259 * When the hub starts to receive the LFPS, there is a slight delay for
260 * it to figure out that one of the ports is sending an LFPS. Then it
261 * will forward the LFPS to its upstream link. The exit latency is the
262 * delay, plus the PEL that we calculated for this hub.
264 hub_pel = port_to_port_exit_latency * 1000 + hub_lpm_params->pel;
267 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
268 * is the greater of the two exit latencies.
270 if (first_link_pel > hub_pel)
271 udev_lpm_params->pel = first_link_pel;
273 udev_lpm_params->pel = hub_pel;
277 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
278 * when a device initiates a transition to U0, until when it will receive the
279 * first packet from the host controller.
281 * Section C.1.5.1 describes the four components to this:
283 * - t2: time for the ERDY to make it from the device to the host.
284 * - t3: a host-specific delay to process the ERDY.
285 * - t4: time for the packet to make it from the host to the device.
287 * t3 is specific to both the xHCI host and the platform the host is integrated
288 * into. The Intel HW folks have said it's negligible, FIXME if a different
289 * vendor says otherwise.
291 static void usb_set_lpm_sel(struct usb_device *udev,
292 struct usb3_lpm_parameters *udev_lpm_params)
294 struct usb_device *parent;
295 unsigned int num_hubs;
296 unsigned int total_sel;
298 /* t1 = device PEL */
299 total_sel = udev_lpm_params->pel;
300 /* How many external hubs are in between the device & the root port. */
301 for (parent = udev->parent, num_hubs = 0; parent->parent;
302 parent = parent->parent)
304 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
306 total_sel += 2100 + 250 * (num_hubs - 1);
308 /* t4 = 250ns * num_hubs */
309 total_sel += 250 * num_hubs;
311 udev_lpm_params->sel = total_sel;
314 static void usb_set_lpm_parameters(struct usb_device *udev)
317 unsigned int port_to_port_delay;
318 unsigned int udev_u1_del;
319 unsigned int udev_u2_del;
320 unsigned int hub_u1_del;
321 unsigned int hub_u2_del;
323 if (!udev->lpm_capable || udev->speed < USB_SPEED_SUPER)
326 hub = usb_hub_to_struct_hub(udev->parent);
327 /* It doesn't take time to transition the roothub into U0, since it
328 * doesn't have an upstream link.
333 udev_u1_del = udev->bos->ss_cap->bU1devExitLat;
334 udev_u2_del = le16_to_cpu(udev->bos->ss_cap->bU2DevExitLat);
335 hub_u1_del = udev->parent->bos->ss_cap->bU1devExitLat;
336 hub_u2_del = le16_to_cpu(udev->parent->bos->ss_cap->bU2DevExitLat);
338 usb_set_lpm_mel(udev, &udev->u1_params, udev_u1_del,
339 hub, &udev->parent->u1_params, hub_u1_del);
341 usb_set_lpm_mel(udev, &udev->u2_params, udev_u2_del,
342 hub, &udev->parent->u2_params, hub_u2_del);
345 * Appendix C, section C.2.2.2, says that there is a slight delay from
346 * when the parent hub notices the downstream port is trying to
347 * transition to U0 to when the hub initiates a U0 transition on its
348 * upstream port. The section says the delays are tPort2PortU1EL and
349 * tPort2PortU2EL, but it doesn't define what they are.
351 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
352 * about the same delays. Use the maximum delay calculations from those
353 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
354 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
355 * assume the device exit latencies they are talking about are the hub
358 * What do we do if the U2 exit latency is less than the U1 exit
359 * latency? It's possible, although not likely...
361 port_to_port_delay = 1;
363 usb_set_lpm_pel(udev, &udev->u1_params, udev_u1_del,
364 hub, &udev->parent->u1_params, hub_u1_del,
367 if (hub_u2_del > hub_u1_del)
368 port_to_port_delay = 1 + hub_u2_del - hub_u1_del;
370 port_to_port_delay = 1 + hub_u1_del;
372 usb_set_lpm_pel(udev, &udev->u2_params, udev_u2_del,
373 hub, &udev->parent->u2_params, hub_u2_del,
376 /* Now that we've got PEL, calculate SEL. */
377 usb_set_lpm_sel(udev, &udev->u1_params);
378 usb_set_lpm_sel(udev, &udev->u2_params);
381 /* USB 2.0 spec Section 11.24.4.5 */
382 static int get_hub_descriptor(struct usb_device *hdev,
383 struct usb_hub_descriptor *desc)
388 if (hub_is_superspeed(hdev)) {
389 dtype = USB_DT_SS_HUB;
390 size = USB_DT_SS_HUB_SIZE;
393 size = sizeof(struct usb_hub_descriptor);
396 for (i = 0; i < 3; i++) {
397 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
398 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
399 dtype << 8, 0, desc, size,
400 USB_CTRL_GET_TIMEOUT);
401 if (hub_is_superspeed(hdev)) {
404 } else if (ret >= USB_DT_HUB_NONVAR_SIZE + 2) {
405 /* Make sure we have the DeviceRemovable field. */
406 size = USB_DT_HUB_NONVAR_SIZE + desc->bNbrPorts / 8 + 1;
416 * USB 2.0 spec Section 11.24.2.1
418 static int clear_hub_feature(struct usb_device *hdev, int feature)
420 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
421 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
425 * USB 2.0 spec Section 11.24.2.2
427 int usb_clear_port_feature(struct usb_device *hdev, int port1, int feature)
429 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
430 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
435 * USB 2.0 spec Section 11.24.2.13
437 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
439 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
440 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
444 static char *to_led_name(int selector)
461 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
462 * for info about using port indicators
464 static void set_port_led(struct usb_hub *hub, int port1, int selector)
466 struct usb_port *port_dev = hub->ports[port1 - 1];
469 status = set_port_feature(hub->hdev, (selector << 8) | port1,
470 USB_PORT_FEAT_INDICATOR);
471 dev_dbg(&port_dev->dev, "indicator %s status %d\n",
472 to_led_name(selector), status);
475 #define LED_CYCLE_PERIOD ((2*HZ)/3)
477 static void led_work(struct work_struct *work)
479 struct usb_hub *hub =
480 container_of(work, struct usb_hub, leds.work);
481 struct usb_device *hdev = hub->hdev;
483 unsigned changed = 0;
486 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
489 for (i = 0; i < hdev->maxchild; i++) {
490 unsigned selector, mode;
492 /* 30%-50% duty cycle */
494 switch (hub->indicator[i]) {
496 case INDICATOR_CYCLE:
498 selector = HUB_LED_AUTO;
499 mode = INDICATOR_AUTO;
501 /* blinking green = sw attention */
502 case INDICATOR_GREEN_BLINK:
503 selector = HUB_LED_GREEN;
504 mode = INDICATOR_GREEN_BLINK_OFF;
506 case INDICATOR_GREEN_BLINK_OFF:
507 selector = HUB_LED_OFF;
508 mode = INDICATOR_GREEN_BLINK;
510 /* blinking amber = hw attention */
511 case INDICATOR_AMBER_BLINK:
512 selector = HUB_LED_AMBER;
513 mode = INDICATOR_AMBER_BLINK_OFF;
515 case INDICATOR_AMBER_BLINK_OFF:
516 selector = HUB_LED_OFF;
517 mode = INDICATOR_AMBER_BLINK;
519 /* blink green/amber = reserved */
520 case INDICATOR_ALT_BLINK:
521 selector = HUB_LED_GREEN;
522 mode = INDICATOR_ALT_BLINK_OFF;
524 case INDICATOR_ALT_BLINK_OFF:
525 selector = HUB_LED_AMBER;
526 mode = INDICATOR_ALT_BLINK;
531 if (selector != HUB_LED_AUTO)
533 set_port_led(hub, i + 1, selector);
534 hub->indicator[i] = mode;
536 if (!changed && blinkenlights) {
538 cursor %= hdev->maxchild;
539 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
540 hub->indicator[cursor] = INDICATOR_CYCLE;
544 queue_delayed_work(system_power_efficient_wq,
545 &hub->leds, LED_CYCLE_PERIOD);
548 /* use a short timeout for hub/port status fetches */
549 #define USB_STS_TIMEOUT 1000
550 #define USB_STS_RETRIES 5
553 * USB 2.0 spec Section 11.24.2.6
555 static int get_hub_status(struct usb_device *hdev,
556 struct usb_hub_status *data)
558 int i, status = -ETIMEDOUT;
560 for (i = 0; i < USB_STS_RETRIES &&
561 (status == -ETIMEDOUT || status == -EPIPE); i++) {
562 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
563 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
564 data, sizeof(*data), USB_STS_TIMEOUT);
570 * USB 2.0 spec Section 11.24.2.7
571 * USB 3.1 takes into use the wValue and wLength fields, spec Section 10.16.2.6
573 static int get_port_status(struct usb_device *hdev, int port1,
574 void *data, u16 value, u16 length)
576 int i, status = -ETIMEDOUT;
578 for (i = 0; i < USB_STS_RETRIES &&
579 (status == -ETIMEDOUT || status == -EPIPE); i++) {
580 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
581 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, value,
582 port1, data, length, USB_STS_TIMEOUT);
587 static int hub_ext_port_status(struct usb_hub *hub, int port1, int type,
588 u16 *status, u16 *change, u32 *ext_status)
593 if (type != HUB_PORT_STATUS)
596 mutex_lock(&hub->status_mutex);
597 ret = get_port_status(hub->hdev, port1, &hub->status->port, type, len);
600 dev_err(hub->intfdev,
601 "%s failed (err = %d)\n", __func__, ret);
605 *status = le16_to_cpu(hub->status->port.wPortStatus);
606 *change = le16_to_cpu(hub->status->port.wPortChange);
607 if (type != HUB_PORT_STATUS && ext_status)
608 *ext_status = le32_to_cpu(
609 hub->status->port.dwExtPortStatus);
612 mutex_unlock(&hub->status_mutex);
616 static int hub_port_status(struct usb_hub *hub, int port1,
617 u16 *status, u16 *change)
619 return hub_ext_port_status(hub, port1, HUB_PORT_STATUS,
620 status, change, NULL);
623 static void hub_resubmit_irq_urb(struct usb_hub *hub)
628 spin_lock_irqsave(&hub->irq_urb_lock, flags);
630 if (hub->quiescing) {
631 spin_unlock_irqrestore(&hub->irq_urb_lock, flags);
635 status = usb_submit_urb(hub->urb, GFP_ATOMIC);
636 if (status && status != -ENODEV && status != -EPERM &&
637 status != -ESHUTDOWN) {
638 dev_err(hub->intfdev, "resubmit --> %d\n", status);
639 mod_timer(&hub->irq_urb_retry, jiffies + HZ);
642 spin_unlock_irqrestore(&hub->irq_urb_lock, flags);
645 static void hub_retry_irq_urb(struct timer_list *t)
647 struct usb_hub *hub = from_timer(hub, t, irq_urb_retry);
649 hub_resubmit_irq_urb(hub);
653 static void kick_hub_wq(struct usb_hub *hub)
655 struct usb_interface *intf;
657 if (hub->disconnected || work_pending(&hub->events))
661 * Suppress autosuspend until the event is proceed.
663 * Be careful and make sure that the symmetric operation is
664 * always called. We are here only when there is no pending
665 * work for this hub. Therefore put the interface either when
666 * the new work is called or when it is canceled.
668 intf = to_usb_interface(hub->intfdev);
669 usb_autopm_get_interface_no_resume(intf);
670 kref_get(&hub->kref);
672 if (queue_work(hub_wq, &hub->events))
675 /* the work has already been scheduled */
676 usb_autopm_put_interface_async(intf);
677 kref_put(&hub->kref, hub_release);
680 void usb_kick_hub_wq(struct usb_device *hdev)
682 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
689 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
690 * Notification, which indicates it had initiated remote wakeup.
692 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
693 * device initiates resume, so the USB core will not receive notice of the
694 * resume through the normal hub interrupt URB.
696 void usb_wakeup_notification(struct usb_device *hdev,
697 unsigned int portnum)
700 struct usb_port *port_dev;
705 hub = usb_hub_to_struct_hub(hdev);
707 port_dev = hub->ports[portnum - 1];
708 if (port_dev && port_dev->child)
709 pm_wakeup_event(&port_dev->child->dev, 0);
711 set_bit(portnum, hub->wakeup_bits);
715 EXPORT_SYMBOL_GPL(usb_wakeup_notification);
717 /* completion function, fires on port status changes and various faults */
718 static void hub_irq(struct urb *urb)
720 struct usb_hub *hub = urb->context;
721 int status = urb->status;
726 case -ENOENT: /* synchronous unlink */
727 case -ECONNRESET: /* async unlink */
728 case -ESHUTDOWN: /* hardware going away */
731 default: /* presumably an error */
732 /* Cause a hub reset after 10 consecutive errors */
733 dev_dbg(hub->intfdev, "transfer --> %d\n", status);
734 if ((++hub->nerrors < 10) || hub->error)
739 /* let hub_wq handle things */
740 case 0: /* we got data: port status changed */
742 for (i = 0; i < urb->actual_length; ++i)
743 bits |= ((unsigned long) ((*hub->buffer)[i]))
745 hub->event_bits[0] = bits;
751 /* Something happened, let hub_wq figure it out */
755 hub_resubmit_irq_urb(hub);
758 /* USB 2.0 spec Section 11.24.2.3 */
760 hub_clear_tt_buffer(struct usb_device *hdev, u16 devinfo, u16 tt)
762 /* Need to clear both directions for control ep */
763 if (((devinfo >> 11) & USB_ENDPOINT_XFERTYPE_MASK) ==
764 USB_ENDPOINT_XFER_CONTROL) {
765 int status = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
766 HUB_CLEAR_TT_BUFFER, USB_RT_PORT,
767 devinfo ^ 0x8000, tt, NULL, 0, 1000);
771 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
772 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
777 * enumeration blocks hub_wq for a long time. we use keventd instead, since
778 * long blocking there is the exception, not the rule. accordingly, HCDs
779 * talking to TTs must queue control transfers (not just bulk and iso), so
780 * both can talk to the same hub concurrently.
782 static void hub_tt_work(struct work_struct *work)
784 struct usb_hub *hub =
785 container_of(work, struct usb_hub, tt.clear_work);
788 spin_lock_irqsave(&hub->tt.lock, flags);
789 while (!list_empty(&hub->tt.clear_list)) {
790 struct list_head *next;
791 struct usb_tt_clear *clear;
792 struct usb_device *hdev = hub->hdev;
793 const struct hc_driver *drv;
796 next = hub->tt.clear_list.next;
797 clear = list_entry(next, struct usb_tt_clear, clear_list);
798 list_del(&clear->clear_list);
800 /* drop lock so HCD can concurrently report other TT errors */
801 spin_unlock_irqrestore(&hub->tt.lock, flags);
802 status = hub_clear_tt_buffer(hdev, clear->devinfo, clear->tt);
803 if (status && status != -ENODEV)
805 "clear tt %d (%04x) error %d\n",
806 clear->tt, clear->devinfo, status);
808 /* Tell the HCD, even if the operation failed */
809 drv = clear->hcd->driver;
810 if (drv->clear_tt_buffer_complete)
811 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
814 spin_lock_irqsave(&hub->tt.lock, flags);
816 spin_unlock_irqrestore(&hub->tt.lock, flags);
820 * usb_hub_set_port_power - control hub port's power state
821 * @hdev: USB device belonging to the usb hub
824 * @set: expected status
826 * call this function to control port's power via setting or
827 * clearing the port's PORT_POWER feature.
829 * Return: 0 if successful. A negative error code otherwise.
831 int usb_hub_set_port_power(struct usb_device *hdev, struct usb_hub *hub,
837 ret = set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
839 ret = usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
845 set_bit(port1, hub->power_bits);
847 clear_bit(port1, hub->power_bits);
852 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
853 * @urb: an URB associated with the failed or incomplete split transaction
855 * High speed HCDs use this to tell the hub driver that some split control or
856 * bulk transaction failed in a way that requires clearing internal state of
857 * a transaction translator. This is normally detected (and reported) from
860 * It may not be possible for that hub to handle additional full (or low)
861 * speed transactions until that state is fully cleared out.
863 * Return: 0 if successful. A negative error code otherwise.
865 int usb_hub_clear_tt_buffer(struct urb *urb)
867 struct usb_device *udev = urb->dev;
868 int pipe = urb->pipe;
869 struct usb_tt *tt = udev->tt;
871 struct usb_tt_clear *clear;
873 /* we've got to cope with an arbitrary number of pending TT clears,
874 * since each TT has "at least two" buffers that can need it (and
875 * there can be many TTs per hub). even if they're uncommon.
877 clear = kmalloc(sizeof *clear, GFP_ATOMIC);
879 dev_err(&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
880 /* FIXME recover somehow ... RESET_TT? */
884 /* info that CLEAR_TT_BUFFER needs */
885 clear->tt = tt->multi ? udev->ttport : 1;
886 clear->devinfo = usb_pipeendpoint (pipe);
887 clear->devinfo |= ((u16)udev->devaddr) << 4;
888 clear->devinfo |= usb_pipecontrol(pipe)
889 ? (USB_ENDPOINT_XFER_CONTROL << 11)
890 : (USB_ENDPOINT_XFER_BULK << 11);
891 if (usb_pipein(pipe))
892 clear->devinfo |= 1 << 15;
894 /* info for completion callback */
895 clear->hcd = bus_to_hcd(udev->bus);
898 /* tell keventd to clear state for this TT */
899 spin_lock_irqsave(&tt->lock, flags);
900 list_add_tail(&clear->clear_list, &tt->clear_list);
901 schedule_work(&tt->clear_work);
902 spin_unlock_irqrestore(&tt->lock, flags);
905 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
907 static void hub_power_on(struct usb_hub *hub, bool do_delay)
911 /* Enable power on each port. Some hubs have reserved values
912 * of LPSM (> 2) in their descriptors, even though they are
913 * USB 2.0 hubs. Some hubs do not implement port-power switching
914 * but only emulate it. In all cases, the ports won't work
915 * unless we send these messages to the hub.
917 if (hub_is_port_power_switchable(hub))
918 dev_dbg(hub->intfdev, "enabling power on all ports\n");
920 dev_dbg(hub->intfdev, "trying to enable port power on "
921 "non-switchable hub\n");
922 for (port1 = 1; port1 <= hub->hdev->maxchild; port1++)
923 if (test_bit(port1, hub->power_bits))
924 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
926 usb_clear_port_feature(hub->hdev, port1,
927 USB_PORT_FEAT_POWER);
929 msleep(hub_power_on_good_delay(hub));
932 static int hub_hub_status(struct usb_hub *hub,
933 u16 *status, u16 *change)
937 mutex_lock(&hub->status_mutex);
938 ret = get_hub_status(hub->hdev, &hub->status->hub);
941 dev_err(hub->intfdev,
942 "%s failed (err = %d)\n", __func__, ret);
944 *status = le16_to_cpu(hub->status->hub.wHubStatus);
945 *change = le16_to_cpu(hub->status->hub.wHubChange);
948 mutex_unlock(&hub->status_mutex);
952 static int hub_set_port_link_state(struct usb_hub *hub, int port1,
953 unsigned int link_status)
955 return set_port_feature(hub->hdev,
956 port1 | (link_status << 3),
957 USB_PORT_FEAT_LINK_STATE);
961 * Disable a port and mark a logical connect-change event, so that some
962 * time later hub_wq will disconnect() any existing usb_device on the port
963 * and will re-enumerate if there actually is a device attached.
965 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
967 dev_dbg(&hub->ports[port1 - 1]->dev, "logical disconnect\n");
968 hub_port_disable(hub, port1, 1);
970 /* FIXME let caller ask to power down the port:
971 * - some devices won't enumerate without a VBUS power cycle
972 * - SRP saves power that way
973 * - ... new call, TBD ...
974 * That's easy if this hub can switch power per-port, and
975 * hub_wq reactivates the port later (timer, SRP, etc).
976 * Powerdown must be optional, because of reset/DFU.
979 set_bit(port1, hub->change_bits);
984 * usb_remove_device - disable a device's port on its parent hub
985 * @udev: device to be disabled and removed
986 * Context: @udev locked, must be able to sleep.
988 * After @udev's port has been disabled, hub_wq is notified and it will
989 * see that the device has been disconnected. When the device is
990 * physically unplugged and something is plugged in, the events will
991 * be received and processed normally.
993 * Return: 0 if successful. A negative error code otherwise.
995 int usb_remove_device(struct usb_device *udev)
998 struct usb_interface *intf;
1001 if (!udev->parent) /* Can't remove a root hub */
1003 hub = usb_hub_to_struct_hub(udev->parent);
1004 intf = to_usb_interface(hub->intfdev);
1006 ret = usb_autopm_get_interface(intf);
1010 set_bit(udev->portnum, hub->removed_bits);
1011 hub_port_logical_disconnect(hub, udev->portnum);
1012 usb_autopm_put_interface(intf);
1016 enum hub_activation_type {
1017 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
1018 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
1021 static void hub_init_func2(struct work_struct *ws);
1022 static void hub_init_func3(struct work_struct *ws);
1024 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
1026 struct usb_device *hdev = hub->hdev;
1027 struct usb_hcd *hcd;
1031 bool need_debounce_delay = false;
1034 /* Continue a partial initialization */
1035 if (type == HUB_INIT2 || type == HUB_INIT3) {
1036 device_lock(&hdev->dev);
1038 /* Was the hub disconnected while we were waiting? */
1039 if (hub->disconnected)
1041 if (type == HUB_INIT2)
1045 kref_get(&hub->kref);
1047 /* The superspeed hub except for root hub has to use Hub Depth
1048 * value as an offset into the route string to locate the bits
1049 * it uses to determine the downstream port number. So hub driver
1050 * should send a set hub depth request to superspeed hub after
1051 * the superspeed hub is set configuration in initialization or
1054 * After a resume, port power should still be on.
1055 * For any other type of activation, turn it on.
1057 if (type != HUB_RESUME) {
1058 if (hdev->parent && hub_is_superspeed(hdev)) {
1059 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
1060 HUB_SET_DEPTH, USB_RT_HUB,
1061 hdev->level - 1, 0, NULL, 0,
1062 USB_CTRL_SET_TIMEOUT);
1064 dev_err(hub->intfdev,
1065 "set hub depth failed\n");
1068 /* Speed up system boot by using a delayed_work for the
1069 * hub's initial power-up delays. This is pretty awkward
1070 * and the implementation looks like a home-brewed sort of
1071 * setjmp/longjmp, but it saves at least 100 ms for each
1072 * root hub (assuming usbcore is compiled into the kernel
1073 * rather than as a module). It adds up.
1075 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1076 * because for those activation types the ports have to be
1077 * operational when we return. In theory this could be done
1078 * for HUB_POST_RESET, but it's easier not to.
1080 if (type == HUB_INIT) {
1081 delay = hub_power_on_good_delay(hub);
1083 hub_power_on(hub, false);
1084 INIT_DELAYED_WORK(&hub->init_work, hub_init_func2);
1085 queue_delayed_work(system_power_efficient_wq,
1087 msecs_to_jiffies(delay));
1089 /* Suppress autosuspend until init is done */
1090 usb_autopm_get_interface_no_resume(
1091 to_usb_interface(hub->intfdev));
1092 return; /* Continues at init2: below */
1093 } else if (type == HUB_RESET_RESUME) {
1094 /* The internal host controller state for the hub device
1095 * may be gone after a host power loss on system resume.
1096 * Update the device's info so the HW knows it's a hub.
1098 hcd = bus_to_hcd(hdev->bus);
1099 if (hcd->driver->update_hub_device) {
1100 ret = hcd->driver->update_hub_device(hcd, hdev,
1101 &hub->tt, GFP_NOIO);
1103 dev_err(hub->intfdev,
1104 "Host not accepting hub info update\n");
1105 dev_err(hub->intfdev,
1106 "LS/FS devices and hubs may not work under this hub\n");
1109 hub_power_on(hub, true);
1111 hub_power_on(hub, true);
1113 /* Give some time on remote wakeup to let links to transit to U0 */
1114 } else if (hub_is_superspeed(hub->hdev))
1120 * Check each port and set hub->change_bits to let hub_wq know
1121 * which ports need attention.
1123 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
1124 struct usb_port *port_dev = hub->ports[port1 - 1];
1125 struct usb_device *udev = port_dev->child;
1126 u16 portstatus, portchange;
1128 portstatus = portchange = 0;
1129 status = hub_port_status(hub, port1, &portstatus, &portchange);
1133 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1134 dev_dbg(&port_dev->dev, "status %04x change %04x\n",
1135 portstatus, portchange);
1138 * After anything other than HUB_RESUME (i.e., initialization
1139 * or any sort of reset), every port should be disabled.
1140 * Unconnected ports should likewise be disabled (paranoia),
1141 * and so should ports for which we have no usb_device.
1143 if ((portstatus & USB_PORT_STAT_ENABLE) && (
1144 type != HUB_RESUME ||
1145 !(portstatus & USB_PORT_STAT_CONNECTION) ||
1147 udev->state == USB_STATE_NOTATTACHED)) {
1149 * USB3 protocol ports will automatically transition
1150 * to Enabled state when detect an USB3.0 device attach.
1151 * Do not disable USB3 protocol ports, just pretend
1154 portstatus &= ~USB_PORT_STAT_ENABLE;
1155 if (!hub_is_superspeed(hdev))
1156 usb_clear_port_feature(hdev, port1,
1157 USB_PORT_FEAT_ENABLE);
1160 /* Make sure a warm-reset request is handled by port_event */
1161 if (type == HUB_RESUME &&
1162 hub_port_warm_reset_required(hub, port1, portstatus))
1163 set_bit(port1, hub->event_bits);
1166 * Add debounce if USB3 link is in polling/link training state.
1167 * Link will automatically transition to Enabled state after
1168 * link training completes.
1170 if (hub_is_superspeed(hdev) &&
1171 ((portstatus & USB_PORT_STAT_LINK_STATE) ==
1172 USB_SS_PORT_LS_POLLING))
1173 need_debounce_delay = true;
1175 /* Clear status-change flags; we'll debounce later */
1176 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1177 need_debounce_delay = true;
1178 usb_clear_port_feature(hub->hdev, port1,
1179 USB_PORT_FEAT_C_CONNECTION);
1181 if (portchange & USB_PORT_STAT_C_ENABLE) {
1182 need_debounce_delay = true;
1183 usb_clear_port_feature(hub->hdev, port1,
1184 USB_PORT_FEAT_C_ENABLE);
1186 if (portchange & USB_PORT_STAT_C_RESET) {
1187 need_debounce_delay = true;
1188 usb_clear_port_feature(hub->hdev, port1,
1189 USB_PORT_FEAT_C_RESET);
1191 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
1192 hub_is_superspeed(hub->hdev)) {
1193 need_debounce_delay = true;
1194 usb_clear_port_feature(hub->hdev, port1,
1195 USB_PORT_FEAT_C_BH_PORT_RESET);
1197 /* We can forget about a "removed" device when there's a
1198 * physical disconnect or the connect status changes.
1200 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
1201 (portchange & USB_PORT_STAT_C_CONNECTION))
1202 clear_bit(port1, hub->removed_bits);
1204 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
1205 /* Tell hub_wq to disconnect the device or
1206 * check for a new connection or over current condition.
1207 * Based on USB2.0 Spec Section 11.12.5,
1208 * C_PORT_OVER_CURRENT could be set while
1209 * PORT_OVER_CURRENT is not. So check for any of them.
1211 if (udev || (portstatus & USB_PORT_STAT_CONNECTION) ||
1212 (portchange & USB_PORT_STAT_C_CONNECTION) ||
1213 (portstatus & USB_PORT_STAT_OVERCURRENT) ||
1214 (portchange & USB_PORT_STAT_C_OVERCURRENT))
1215 set_bit(port1, hub->change_bits);
1217 } else if (portstatus & USB_PORT_STAT_ENABLE) {
1218 bool port_resumed = (portstatus &
1219 USB_PORT_STAT_LINK_STATE) ==
1221 /* The power session apparently survived the resume.
1222 * If there was an overcurrent or suspend change
1223 * (i.e., remote wakeup request), have hub_wq
1224 * take care of it. Look at the port link state
1225 * for USB 3.0 hubs, since they don't have a suspend
1226 * change bit, and they don't set the port link change
1227 * bit on device-initiated resume.
1229 if (portchange || (hub_is_superspeed(hub->hdev) &&
1231 set_bit(port1, hub->event_bits);
1233 } else if (udev->persist_enabled) {
1235 udev->reset_resume = 1;
1237 /* Don't set the change_bits when the device
1240 if (test_bit(port1, hub->power_bits))
1241 set_bit(port1, hub->change_bits);
1244 /* The power session is gone; tell hub_wq */
1245 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1246 set_bit(port1, hub->change_bits);
1250 /* If no port-status-change flags were set, we don't need any
1251 * debouncing. If flags were set we can try to debounce the
1252 * ports all at once right now, instead of letting hub_wq do them
1253 * one at a time later on.
1255 * If any port-status changes do occur during this delay, hub_wq
1256 * will see them later and handle them normally.
1258 if (need_debounce_delay) {
1259 delay = HUB_DEBOUNCE_STABLE;
1261 /* Don't do a long sleep inside a workqueue routine */
1262 if (type == HUB_INIT2) {
1263 INIT_DELAYED_WORK(&hub->init_work, hub_init_func3);
1264 queue_delayed_work(system_power_efficient_wq,
1266 msecs_to_jiffies(delay));
1267 device_unlock(&hdev->dev);
1268 return; /* Continues at init3: below */
1276 status = usb_submit_urb(hub->urb, GFP_NOIO);
1278 dev_err(hub->intfdev, "activate --> %d\n", status);
1279 if (hub->has_indicators && blinkenlights)
1280 queue_delayed_work(system_power_efficient_wq,
1281 &hub->leds, LED_CYCLE_PERIOD);
1283 /* Scan all ports that need attention */
1286 if (type == HUB_INIT2 || type == HUB_INIT3) {
1287 /* Allow autosuspend if it was suppressed */
1289 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
1290 device_unlock(&hdev->dev);
1293 kref_put(&hub->kref, hub_release);
1296 /* Implement the continuations for the delays above */
1297 static void hub_init_func2(struct work_struct *ws)
1299 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1301 hub_activate(hub, HUB_INIT2);
1304 static void hub_init_func3(struct work_struct *ws)
1306 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1308 hub_activate(hub, HUB_INIT3);
1311 enum hub_quiescing_type {
1312 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
1315 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
1317 struct usb_device *hdev = hub->hdev;
1318 unsigned long flags;
1321 /* hub_wq and related activity won't re-trigger */
1322 spin_lock_irqsave(&hub->irq_urb_lock, flags);
1324 spin_unlock_irqrestore(&hub->irq_urb_lock, flags);
1326 if (type != HUB_SUSPEND) {
1327 /* Disconnect all the children */
1328 for (i = 0; i < hdev->maxchild; ++i) {
1329 if (hub->ports[i]->child)
1330 usb_disconnect(&hub->ports[i]->child);
1334 /* Stop hub_wq and related activity */
1335 del_timer_sync(&hub->irq_urb_retry);
1336 usb_kill_urb(hub->urb);
1337 if (hub->has_indicators)
1338 cancel_delayed_work_sync(&hub->leds);
1340 flush_work(&hub->tt.clear_work);
1343 static void hub_pm_barrier_for_all_ports(struct usb_hub *hub)
1347 for (i = 0; i < hub->hdev->maxchild; ++i)
1348 pm_runtime_barrier(&hub->ports[i]->dev);
1351 /* caller has locked the hub device */
1352 static int hub_pre_reset(struct usb_interface *intf)
1354 struct usb_hub *hub = usb_get_intfdata(intf);
1356 hub_quiesce(hub, HUB_PRE_RESET);
1358 hub_pm_barrier_for_all_ports(hub);
1362 /* caller has locked the hub device */
1363 static int hub_post_reset(struct usb_interface *intf)
1365 struct usb_hub *hub = usb_get_intfdata(intf);
1368 hub_pm_barrier_for_all_ports(hub);
1369 hub_activate(hub, HUB_POST_RESET);
1373 static int hub_configure(struct usb_hub *hub,
1374 struct usb_endpoint_descriptor *endpoint)
1376 struct usb_hcd *hcd;
1377 struct usb_device *hdev = hub->hdev;
1378 struct device *hub_dev = hub->intfdev;
1379 u16 hubstatus, hubchange;
1380 u16 wHubCharacteristics;
1383 char *message = "out of memory";
1388 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
1394 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1399 mutex_init(&hub->status_mutex);
1401 hub->descriptor = kzalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1402 if (!hub->descriptor) {
1407 /* Request the entire hub descriptor.
1408 * hub->descriptor can handle USB_MAXCHILDREN ports,
1409 * but a (non-SS) hub can/will return fewer bytes here.
1411 ret = get_hub_descriptor(hdev, hub->descriptor);
1413 message = "can't read hub descriptor";
1417 maxchild = USB_MAXCHILDREN;
1418 if (hub_is_superspeed(hdev))
1419 maxchild = min_t(unsigned, maxchild, USB_SS_MAXPORTS);
1421 if (hub->descriptor->bNbrPorts > maxchild) {
1422 message = "hub has too many ports!";
1425 } else if (hub->descriptor->bNbrPorts == 0) {
1426 message = "hub doesn't have any ports!";
1432 * Accumulate wHubDelay + 40ns for every hub in the tree of devices.
1433 * The resulting value will be used for SetIsochDelay() request.
1435 if (hub_is_superspeed(hdev) || hub_is_superspeedplus(hdev)) {
1436 u32 delay = __le16_to_cpu(hub->descriptor->u.ss.wHubDelay);
1439 delay += hdev->parent->hub_delay;
1441 delay += USB_TP_TRANSMISSION_DELAY;
1442 hdev->hub_delay = min_t(u32, delay, USB_TP_TRANSMISSION_DELAY_MAX);
1445 maxchild = hub->descriptor->bNbrPorts;
1446 dev_info(hub_dev, "%d port%s detected\n", maxchild,
1447 (maxchild == 1) ? "" : "s");
1449 hub->ports = kcalloc(maxchild, sizeof(struct usb_port *), GFP_KERNEL);
1455 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1456 if (hub_is_superspeed(hdev)) {
1464 /* FIXME for USB 3.0, skip for now */
1465 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1466 !(hub_is_superspeed(hdev))) {
1467 char portstr[USB_MAXCHILDREN + 1];
1469 for (i = 0; i < maxchild; i++)
1470 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1471 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1473 portstr[maxchild] = 0;
1474 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1476 dev_dbg(hub_dev, "standalone hub\n");
1478 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1479 case HUB_CHAR_COMMON_LPSM:
1480 dev_dbg(hub_dev, "ganged power switching\n");
1482 case HUB_CHAR_INDV_PORT_LPSM:
1483 dev_dbg(hub_dev, "individual port power switching\n");
1485 case HUB_CHAR_NO_LPSM:
1487 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1491 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1492 case HUB_CHAR_COMMON_OCPM:
1493 dev_dbg(hub_dev, "global over-current protection\n");
1495 case HUB_CHAR_INDV_PORT_OCPM:
1496 dev_dbg(hub_dev, "individual port over-current protection\n");
1498 case HUB_CHAR_NO_OCPM:
1500 dev_dbg(hub_dev, "no over-current protection\n");
1504 spin_lock_init(&hub->tt.lock);
1505 INIT_LIST_HEAD(&hub->tt.clear_list);
1506 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1507 switch (hdev->descriptor.bDeviceProtocol) {
1510 case USB_HUB_PR_HS_SINGLE_TT:
1511 dev_dbg(hub_dev, "Single TT\n");
1514 case USB_HUB_PR_HS_MULTI_TT:
1515 ret = usb_set_interface(hdev, 0, 1);
1517 dev_dbg(hub_dev, "TT per port\n");
1520 dev_err(hub_dev, "Using single TT (err %d)\n",
1525 /* USB 3.0 hubs don't have a TT */
1528 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1529 hdev->descriptor.bDeviceProtocol);
1533 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1534 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1535 case HUB_TTTT_8_BITS:
1536 if (hdev->descriptor.bDeviceProtocol != 0) {
1537 hub->tt.think_time = 666;
1538 dev_dbg(hub_dev, "TT requires at most %d "
1539 "FS bit times (%d ns)\n",
1540 8, hub->tt.think_time);
1543 case HUB_TTTT_16_BITS:
1544 hub->tt.think_time = 666 * 2;
1545 dev_dbg(hub_dev, "TT requires at most %d "
1546 "FS bit times (%d ns)\n",
1547 16, hub->tt.think_time);
1549 case HUB_TTTT_24_BITS:
1550 hub->tt.think_time = 666 * 3;
1551 dev_dbg(hub_dev, "TT requires at most %d "
1552 "FS bit times (%d ns)\n",
1553 24, hub->tt.think_time);
1555 case HUB_TTTT_32_BITS:
1556 hub->tt.think_time = 666 * 4;
1557 dev_dbg(hub_dev, "TT requires at most %d "
1558 "FS bit times (%d ns)\n",
1559 32, hub->tt.think_time);
1563 /* probe() zeroes hub->indicator[] */
1564 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1565 hub->has_indicators = 1;
1566 dev_dbg(hub_dev, "Port indicators are supported\n");
1569 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1570 hub->descriptor->bPwrOn2PwrGood * 2);
1572 /* power budgeting mostly matters with bus-powered hubs,
1573 * and battery-powered root hubs (may provide just 8 mA).
1575 ret = usb_get_std_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1577 message = "can't get hub status";
1580 hcd = bus_to_hcd(hdev->bus);
1581 if (hdev == hdev->bus->root_hub) {
1582 if (hcd->power_budget > 0)
1583 hdev->bus_mA = hcd->power_budget;
1585 hdev->bus_mA = full_load * maxchild;
1586 if (hdev->bus_mA >= full_load)
1587 hub->mA_per_port = full_load;
1589 hub->mA_per_port = hdev->bus_mA;
1590 hub->limited_power = 1;
1592 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1593 int remaining = hdev->bus_mA -
1594 hub->descriptor->bHubContrCurrent;
1596 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1597 hub->descriptor->bHubContrCurrent);
1598 hub->limited_power = 1;
1600 if (remaining < maxchild * unit_load)
1602 "insufficient power available "
1603 "to use all downstream ports\n");
1604 hub->mA_per_port = unit_load; /* 7.2.1 */
1606 } else { /* Self-powered external hub */
1607 /* FIXME: What about battery-powered external hubs that
1608 * provide less current per port? */
1609 hub->mA_per_port = full_load;
1611 if (hub->mA_per_port < full_load)
1612 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1615 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1617 message = "can't get hub status";
1621 /* local power status reports aren't always correct */
1622 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1623 dev_dbg(hub_dev, "local power source is %s\n",
1624 (hubstatus & HUB_STATUS_LOCAL_POWER)
1625 ? "lost (inactive)" : "good");
1627 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1628 dev_dbg(hub_dev, "%sover-current condition exists\n",
1629 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1631 /* set up the interrupt endpoint
1632 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1633 * bytes as USB2.0[11.12.3] says because some hubs are known
1634 * to send more data (and thus cause overflow). For root hubs,
1635 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1636 * to be big enough for at least USB_MAXCHILDREN ports. */
1637 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1638 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1640 if (maxp > sizeof(*hub->buffer))
1641 maxp = sizeof(*hub->buffer);
1643 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1649 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1650 hub, endpoint->bInterval);
1652 /* maybe cycle the hub leds */
1653 if (hub->has_indicators && blinkenlights)
1654 hub->indicator[0] = INDICATOR_CYCLE;
1656 mutex_lock(&usb_port_peer_mutex);
1657 for (i = 0; i < maxchild; i++) {
1658 ret = usb_hub_create_port_device(hub, i + 1);
1660 dev_err(hub->intfdev,
1661 "couldn't create port%d device.\n", i + 1);
1666 for (i = 0; i < hdev->maxchild; i++) {
1667 struct usb_port *port_dev = hub->ports[i];
1669 pm_runtime_put(&port_dev->dev);
1672 mutex_unlock(&usb_port_peer_mutex);
1676 /* Update the HCD's internal representation of this hub before hub_wq
1677 * starts getting port status changes for devices under the hub.
1679 if (hcd->driver->update_hub_device) {
1680 ret = hcd->driver->update_hub_device(hcd, hdev,
1681 &hub->tt, GFP_KERNEL);
1683 message = "can't update HCD hub info";
1688 usb_hub_adjust_deviceremovable(hdev, hub->descriptor);
1690 hub_activate(hub, HUB_INIT);
1694 dev_err(hub_dev, "config failed, %s (err %d)\n",
1696 /* hub_disconnect() frees urb and descriptor */
1700 static void hub_release(struct kref *kref)
1702 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1704 usb_put_dev(hub->hdev);
1705 usb_put_intf(to_usb_interface(hub->intfdev));
1709 static unsigned highspeed_hubs;
1711 static void hub_disconnect(struct usb_interface *intf)
1713 struct usb_hub *hub = usb_get_intfdata(intf);
1714 struct usb_device *hdev = interface_to_usbdev(intf);
1718 * Stop adding new hub events. We do not want to block here and thus
1719 * will not try to remove any pending work item.
1721 hub->disconnected = 1;
1723 /* Disconnect all children and quiesce the hub */
1725 hub_quiesce(hub, HUB_DISCONNECT);
1727 mutex_lock(&usb_port_peer_mutex);
1729 /* Avoid races with recursively_mark_NOTATTACHED() */
1730 spin_lock_irq(&device_state_lock);
1731 port1 = hdev->maxchild;
1733 usb_set_intfdata(intf, NULL);
1734 spin_unlock_irq(&device_state_lock);
1736 for (; port1 > 0; --port1)
1737 usb_hub_remove_port_device(hub, port1);
1739 mutex_unlock(&usb_port_peer_mutex);
1741 if (hub->hdev->speed == USB_SPEED_HIGH)
1744 usb_free_urb(hub->urb);
1746 kfree(hub->descriptor);
1750 pm_suspend_ignore_children(&intf->dev, false);
1752 if (hub->quirk_disable_autosuspend)
1753 usb_autopm_put_interface(intf);
1755 kref_put(&hub->kref, hub_release);
1758 static bool hub_descriptor_is_sane(struct usb_host_interface *desc)
1760 /* Some hubs have a subclass of 1, which AFAICT according to the */
1761 /* specs is not defined, but it works */
1762 if (desc->desc.bInterfaceSubClass != 0 &&
1763 desc->desc.bInterfaceSubClass != 1)
1766 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1767 if (desc->desc.bNumEndpoints != 1)
1770 /* If the first endpoint is not interrupt IN, we'd better punt! */
1771 if (!usb_endpoint_is_int_in(&desc->endpoint[0].desc))
1777 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1779 struct usb_host_interface *desc;
1780 struct usb_device *hdev;
1781 struct usb_hub *hub;
1783 desc = intf->cur_altsetting;
1784 hdev = interface_to_usbdev(intf);
1787 * Set default autosuspend delay as 0 to speedup bus suspend,
1788 * based on the below considerations:
1790 * - Unlike other drivers, the hub driver does not rely on the
1791 * autosuspend delay to provide enough time to handle a wakeup
1792 * event, and the submitted status URB is just to check future
1793 * change on hub downstream ports, so it is safe to do it.
1795 * - The patch might cause one or more auto supend/resume for
1796 * below very rare devices when they are plugged into hub
1799 * devices having trouble initializing, and disconnect
1800 * themselves from the bus and then reconnect a second
1803 * devices just for downloading firmware, and disconnects
1804 * themselves after completing it
1806 * For these quite rare devices, their drivers may change the
1807 * autosuspend delay of their parent hub in the probe() to one
1808 * appropriate value to avoid the subtle problem if someone
1811 * - The patch may cause one or more auto suspend/resume on
1812 * hub during running 'lsusb', but it is probably too
1813 * infrequent to worry about.
1815 * - Change autosuspend delay of hub can avoid unnecessary auto
1816 * suspend timer for hub, also may decrease power consumption
1819 * - If user has indicated to prevent autosuspend by passing
1820 * usbcore.autosuspend = -1 then keep autosuspend disabled.
1823 if (hdev->dev.power.autosuspend_delay >= 0)
1824 pm_runtime_set_autosuspend_delay(&hdev->dev, 0);
1828 * Hubs have proper suspend/resume support, except for root hubs
1829 * where the controller driver doesn't have bus_suspend and
1830 * bus_resume methods.
1832 if (hdev->parent) { /* normal device */
1833 usb_enable_autosuspend(hdev);
1834 } else { /* root hub */
1835 const struct hc_driver *drv = bus_to_hcd(hdev->bus)->driver;
1837 if (drv->bus_suspend && drv->bus_resume)
1838 usb_enable_autosuspend(hdev);
1841 if (hdev->level == MAX_TOPO_LEVEL) {
1843 "Unsupported bus topology: hub nested too deep\n");
1847 #ifdef CONFIG_USB_OTG_DISABLE_EXTERNAL_HUB
1849 dev_warn(&intf->dev, "ignoring external hub\n");
1854 if (!hub_descriptor_is_sane(desc)) {
1855 dev_err(&intf->dev, "bad descriptor, ignoring hub\n");
1859 /* We found a hub */
1860 dev_info(&intf->dev, "USB hub found\n");
1862 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1866 kref_init(&hub->kref);
1867 hub->intfdev = &intf->dev;
1869 INIT_DELAYED_WORK(&hub->leds, led_work);
1870 INIT_DELAYED_WORK(&hub->init_work, NULL);
1871 INIT_WORK(&hub->events, hub_event);
1872 spin_lock_init(&hub->irq_urb_lock);
1873 timer_setup(&hub->irq_urb_retry, hub_retry_irq_urb, 0);
1877 usb_set_intfdata(intf, hub);
1878 intf->needs_remote_wakeup = 1;
1879 pm_suspend_ignore_children(&intf->dev, true);
1881 if (hdev->speed == USB_SPEED_HIGH)
1884 if (id->driver_info & HUB_QUIRK_CHECK_PORT_AUTOSUSPEND)
1885 hub->quirk_check_port_auto_suspend = 1;
1887 if (id->driver_info & HUB_QUIRK_DISABLE_AUTOSUSPEND) {
1888 hub->quirk_disable_autosuspend = 1;
1889 usb_autopm_get_interface_no_resume(intf);
1892 if (hub_configure(hub, &desc->endpoint[0].desc) >= 0)
1895 hub_disconnect(intf);
1900 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1902 struct usb_device *hdev = interface_to_usbdev(intf);
1903 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1905 /* assert ifno == 0 (part of hub spec) */
1907 case USBDEVFS_HUB_PORTINFO: {
1908 struct usbdevfs_hub_portinfo *info = user_data;
1911 spin_lock_irq(&device_state_lock);
1912 if (hdev->devnum <= 0)
1915 info->nports = hdev->maxchild;
1916 for (i = 0; i < info->nports; i++) {
1917 if (hub->ports[i]->child == NULL)
1921 hub->ports[i]->child->devnum;
1924 spin_unlock_irq(&device_state_lock);
1926 return info->nports + 1;
1935 * Allow user programs to claim ports on a hub. When a device is attached
1936 * to one of these "claimed" ports, the program will "own" the device.
1938 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1939 struct usb_dev_state ***ppowner)
1941 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1943 if (hdev->state == USB_STATE_NOTATTACHED)
1945 if (port1 == 0 || port1 > hdev->maxchild)
1948 /* Devices not managed by the hub driver
1949 * will always have maxchild equal to 0.
1951 *ppowner = &(hub->ports[port1 - 1]->port_owner);
1955 /* In the following three functions, the caller must hold hdev's lock */
1956 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
1957 struct usb_dev_state *owner)
1960 struct usb_dev_state **powner;
1962 rc = find_port_owner(hdev, port1, &powner);
1970 EXPORT_SYMBOL_GPL(usb_hub_claim_port);
1972 int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
1973 struct usb_dev_state *owner)
1976 struct usb_dev_state **powner;
1978 rc = find_port_owner(hdev, port1, &powner);
1981 if (*powner != owner)
1986 EXPORT_SYMBOL_GPL(usb_hub_release_port);
1988 void usb_hub_release_all_ports(struct usb_device *hdev, struct usb_dev_state *owner)
1990 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1993 for (n = 0; n < hdev->maxchild; n++) {
1994 if (hub->ports[n]->port_owner == owner)
1995 hub->ports[n]->port_owner = NULL;
2000 /* The caller must hold udev's lock */
2001 bool usb_device_is_owned(struct usb_device *udev)
2003 struct usb_hub *hub;
2005 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
2007 hub = usb_hub_to_struct_hub(udev->parent);
2008 return !!hub->ports[udev->portnum - 1]->port_owner;
2011 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
2013 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2016 for (i = 0; i < udev->maxchild; ++i) {
2017 if (hub->ports[i]->child)
2018 recursively_mark_NOTATTACHED(hub->ports[i]->child);
2020 if (udev->state == USB_STATE_SUSPENDED)
2021 udev->active_duration -= jiffies;
2022 udev->state = USB_STATE_NOTATTACHED;
2026 * usb_set_device_state - change a device's current state (usbcore, hcds)
2027 * @udev: pointer to device whose state should be changed
2028 * @new_state: new state value to be stored
2030 * udev->state is _not_ fully protected by the device lock. Although
2031 * most transitions are made only while holding the lock, the state can
2032 * can change to USB_STATE_NOTATTACHED at almost any time. This
2033 * is so that devices can be marked as disconnected as soon as possible,
2034 * without having to wait for any semaphores to be released. As a result,
2035 * all changes to any device's state must be protected by the
2036 * device_state_lock spinlock.
2038 * Once a device has been added to the device tree, all changes to its state
2039 * should be made using this routine. The state should _not_ be set directly.
2041 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
2042 * Otherwise udev->state is set to new_state, and if new_state is
2043 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
2044 * to USB_STATE_NOTATTACHED.
2046 void usb_set_device_state(struct usb_device *udev,
2047 enum usb_device_state new_state)
2049 unsigned long flags;
2052 spin_lock_irqsave(&device_state_lock, flags);
2053 if (udev->state == USB_STATE_NOTATTACHED)
2055 else if (new_state != USB_STATE_NOTATTACHED) {
2057 /* root hub wakeup capabilities are managed out-of-band
2058 * and may involve silicon errata ... ignore them here.
2061 if (udev->state == USB_STATE_SUSPENDED
2062 || new_state == USB_STATE_SUSPENDED)
2063 ; /* No change to wakeup settings */
2064 else if (new_state == USB_STATE_CONFIGURED)
2065 wakeup = (udev->quirks &
2066 USB_QUIRK_IGNORE_REMOTE_WAKEUP) ? 0 :
2067 udev->actconfig->desc.bmAttributes &
2068 USB_CONFIG_ATT_WAKEUP;
2072 if (udev->state == USB_STATE_SUSPENDED &&
2073 new_state != USB_STATE_SUSPENDED)
2074 udev->active_duration -= jiffies;
2075 else if (new_state == USB_STATE_SUSPENDED &&
2076 udev->state != USB_STATE_SUSPENDED)
2077 udev->active_duration += jiffies;
2078 udev->state = new_state;
2080 recursively_mark_NOTATTACHED(udev);
2081 spin_unlock_irqrestore(&device_state_lock, flags);
2083 device_set_wakeup_capable(&udev->dev, wakeup);
2085 EXPORT_SYMBOL_GPL(usb_set_device_state);
2088 * Choose a device number.
2090 * Device numbers are used as filenames in usbfs. On USB-1.1 and
2091 * USB-2.0 buses they are also used as device addresses, however on
2092 * USB-3.0 buses the address is assigned by the controller hardware
2093 * and it usually is not the same as the device number.
2095 * WUSB devices are simple: they have no hubs behind, so the mapping
2096 * device <-> virtual port number becomes 1:1. Why? to simplify the
2097 * life of the device connection logic in
2098 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
2099 * handshake we need to assign a temporary address in the unauthorized
2100 * space. For simplicity we use the first virtual port number found to
2101 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
2102 * and that becomes it's address [X < 128] or its unauthorized address
2105 * We add 1 as an offset to the one-based USB-stack port number
2106 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
2107 * 0 is reserved by USB for default address; (b) Linux's USB stack
2108 * uses always #1 for the root hub of the controller. So USB stack's
2109 * port #1, which is wusb virtual-port #0 has address #2.
2111 * Devices connected under xHCI are not as simple. The host controller
2112 * supports virtualization, so the hardware assigns device addresses and
2113 * the HCD must setup data structures before issuing a set address
2114 * command to the hardware.
2116 static void choose_devnum(struct usb_device *udev)
2119 struct usb_bus *bus = udev->bus;
2121 /* be safe when more hub events are proceed in parallel */
2122 mutex_lock(&bus->devnum_next_mutex);
2124 devnum = udev->portnum + 1;
2125 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
2127 /* Try to allocate the next devnum beginning at
2128 * bus->devnum_next. */
2129 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
2132 devnum = find_next_zero_bit(bus->devmap.devicemap,
2134 bus->devnum_next = (devnum >= 127 ? 1 : devnum + 1);
2137 set_bit(devnum, bus->devmap.devicemap);
2138 udev->devnum = devnum;
2140 mutex_unlock(&bus->devnum_next_mutex);
2143 static void release_devnum(struct usb_device *udev)
2145 if (udev->devnum > 0) {
2146 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
2151 static void update_devnum(struct usb_device *udev, int devnum)
2153 /* The address for a WUSB device is managed by wusbcore. */
2155 udev->devnum = devnum;
2157 udev->devaddr = (u8)devnum;
2160 static void hub_free_dev(struct usb_device *udev)
2162 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2164 /* Root hubs aren't real devices, so don't free HCD resources */
2165 if (hcd->driver->free_dev && udev->parent)
2166 hcd->driver->free_dev(hcd, udev);
2169 static void hub_disconnect_children(struct usb_device *udev)
2171 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2174 /* Free up all the children before we remove this device */
2175 for (i = 0; i < udev->maxchild; i++) {
2176 if (hub->ports[i]->child)
2177 usb_disconnect(&hub->ports[i]->child);
2182 * usb_disconnect - disconnect a device (usbcore-internal)
2183 * @pdev: pointer to device being disconnected
2185 * Context: task context, might sleep
2187 * Something got disconnected. Get rid of it and all of its children.
2189 * If *pdev is a normal device then the parent hub must already be locked.
2190 * If *pdev is a root hub then the caller must hold the usb_bus_idr_lock,
2191 * which protects the set of root hubs as well as the list of buses.
2193 * Only hub drivers (including virtual root hub drivers for host
2194 * controllers) should ever call this.
2196 * This call is synchronous, and may not be used in an interrupt context.
2198 void usb_disconnect(struct usb_device **pdev)
2200 struct usb_port *port_dev = NULL;
2201 struct usb_device *udev = *pdev;
2202 struct usb_hub *hub = NULL;
2205 /* mark the device as inactive, so any further urb submissions for
2206 * this device (and any of its children) will fail immediately.
2207 * this quiesces everything except pending urbs.
2209 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2210 dev_info(&udev->dev, "USB disconnect, device number %d\n",
2214 * Ensure that the pm runtime code knows that the USB device
2215 * is in the process of being disconnected.
2217 pm_runtime_barrier(&udev->dev);
2219 usb_lock_device(udev);
2221 hub_disconnect_children(udev);
2223 /* deallocate hcd/hardware state ... nuking all pending urbs and
2224 * cleaning up all state associated with the current configuration
2225 * so that the hardware is now fully quiesced.
2227 dev_dbg(&udev->dev, "unregistering device\n");
2228 usb_disable_device(udev, 0);
2229 usb_hcd_synchronize_unlinks(udev);
2232 port1 = udev->portnum;
2233 hub = usb_hub_to_struct_hub(udev->parent);
2234 port_dev = hub->ports[port1 - 1];
2236 sysfs_remove_link(&udev->dev.kobj, "port");
2237 sysfs_remove_link(&port_dev->dev.kobj, "device");
2240 * As usb_port_runtime_resume() de-references udev, make
2241 * sure no resumes occur during removal
2243 if (!test_and_set_bit(port1, hub->child_usage_bits))
2244 pm_runtime_get_sync(&port_dev->dev);
2247 usb_remove_ep_devs(&udev->ep0);
2248 usb_unlock_device(udev);
2250 /* Unregister the device. The device driver is responsible
2251 * for de-configuring the device and invoking the remove-device
2252 * notifier chain (used by usbfs and possibly others).
2254 device_del(&udev->dev);
2256 /* Free the device number and delete the parent's children[]
2257 * (or root_hub) pointer.
2259 release_devnum(udev);
2261 /* Avoid races with recursively_mark_NOTATTACHED() */
2262 spin_lock_irq(&device_state_lock);
2264 spin_unlock_irq(&device_state_lock);
2266 if (port_dev && test_and_clear_bit(port1, hub->child_usage_bits))
2267 pm_runtime_put(&port_dev->dev);
2271 put_device(&udev->dev);
2274 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2275 static void show_string(struct usb_device *udev, char *id, char *string)
2279 dev_info(&udev->dev, "%s: %s\n", id, string);
2282 static void announce_device(struct usb_device *udev)
2284 u16 bcdDevice = le16_to_cpu(udev->descriptor.bcdDevice);
2286 dev_info(&udev->dev,
2287 "New USB device found, idVendor=%04x, idProduct=%04x, bcdDevice=%2x.%02x\n",
2288 le16_to_cpu(udev->descriptor.idVendor),
2289 le16_to_cpu(udev->descriptor.idProduct),
2290 bcdDevice >> 8, bcdDevice & 0xff);
2291 dev_info(&udev->dev,
2292 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2293 udev->descriptor.iManufacturer,
2294 udev->descriptor.iProduct,
2295 udev->descriptor.iSerialNumber);
2296 show_string(udev, "Product", udev->product);
2297 show_string(udev, "Manufacturer", udev->manufacturer);
2298 show_string(udev, "SerialNumber", udev->serial);
2301 static inline void announce_device(struct usb_device *udev) { }
2306 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2307 * @udev: newly addressed device (in ADDRESS state)
2309 * Finish enumeration for On-The-Go devices
2311 * Return: 0 if successful. A negative error code otherwise.
2313 static int usb_enumerate_device_otg(struct usb_device *udev)
2317 #ifdef CONFIG_USB_OTG
2319 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2320 * to wake us after we've powered off VBUS; and HNP, switching roles
2321 * "host" to "peripheral". The OTG descriptor helps figure this out.
2323 if (!udev->bus->is_b_host
2325 && udev->parent == udev->bus->root_hub) {
2326 struct usb_otg_descriptor *desc = NULL;
2327 struct usb_bus *bus = udev->bus;
2328 unsigned port1 = udev->portnum;
2330 /* descriptor may appear anywhere in config */
2331 err = __usb_get_extra_descriptor(udev->rawdescriptors[0],
2332 le16_to_cpu(udev->config[0].desc.wTotalLength),
2333 USB_DT_OTG, (void **) &desc, sizeof(*desc));
2334 if (err || !(desc->bmAttributes & USB_OTG_HNP))
2337 dev_info(&udev->dev, "Dual-Role OTG device on %sHNP port\n",
2338 (port1 == bus->otg_port) ? "" : "non-");
2340 /* enable HNP before suspend, it's simpler */
2341 if (port1 == bus->otg_port) {
2342 bus->b_hnp_enable = 1;
2343 err = usb_control_msg(udev,
2344 usb_sndctrlpipe(udev, 0),
2345 USB_REQ_SET_FEATURE, 0,
2346 USB_DEVICE_B_HNP_ENABLE,
2348 USB_CTRL_SET_TIMEOUT);
2351 * OTG MESSAGE: report errors here,
2352 * customize to match your product.
2354 dev_err(&udev->dev, "can't set HNP mode: %d\n",
2356 bus->b_hnp_enable = 0;
2358 } else if (desc->bLength == sizeof
2359 (struct usb_otg_descriptor)) {
2360 /* Set a_alt_hnp_support for legacy otg device */
2361 err = usb_control_msg(udev,
2362 usb_sndctrlpipe(udev, 0),
2363 USB_REQ_SET_FEATURE, 0,
2364 USB_DEVICE_A_ALT_HNP_SUPPORT,
2366 USB_CTRL_SET_TIMEOUT);
2369 "set a_alt_hnp_support failed: %d\n",
2379 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2380 * @udev: newly addressed device (in ADDRESS state)
2382 * This is only called by usb_new_device() and usb_authorize_device()
2383 * and FIXME -- all comments that apply to them apply here wrt to
2386 * If the device is WUSB and not authorized, we don't attempt to read
2387 * the string descriptors, as they will be errored out by the device
2388 * until it has been authorized.
2390 * Return: 0 if successful. A negative error code otherwise.
2392 static int usb_enumerate_device(struct usb_device *udev)
2395 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2397 if (udev->config == NULL) {
2398 err = usb_get_configuration(udev);
2401 dev_err(&udev->dev, "can't read configurations, error %d\n",
2407 /* read the standard strings and cache them if present */
2408 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
2409 udev->manufacturer = usb_cache_string(udev,
2410 udev->descriptor.iManufacturer);
2411 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
2413 err = usb_enumerate_device_otg(udev);
2417 if (IS_ENABLED(CONFIG_USB_OTG_PRODUCTLIST) && hcd->tpl_support &&
2418 !is_targeted(udev)) {
2419 /* Maybe it can talk to us, though we can't talk to it.
2420 * (Includes HNP test device.)
2422 if (IS_ENABLED(CONFIG_USB_OTG) && (udev->bus->b_hnp_enable
2423 || udev->bus->is_b_host)) {
2424 err = usb_port_suspend(udev, PMSG_AUTO_SUSPEND);
2426 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
2431 usb_detect_interface_quirks(udev);
2436 static void set_usb_port_removable(struct usb_device *udev)
2438 struct usb_device *hdev = udev->parent;
2439 struct usb_hub *hub;
2440 u8 port = udev->portnum;
2441 u16 wHubCharacteristics;
2442 bool removable = true;
2444 dev_set_removable(&udev->dev, DEVICE_REMOVABLE_UNKNOWN);
2449 hub = usb_hub_to_struct_hub(udev->parent);
2452 * If the platform firmware has provided information about a port,
2453 * use that to determine whether it's removable.
2455 switch (hub->ports[udev->portnum - 1]->connect_type) {
2456 case USB_PORT_CONNECT_TYPE_HOT_PLUG:
2457 dev_set_removable(&udev->dev, DEVICE_REMOVABLE);
2459 case USB_PORT_CONNECT_TYPE_HARD_WIRED:
2460 case USB_PORT_NOT_USED:
2461 dev_set_removable(&udev->dev, DEVICE_FIXED);
2468 * Otherwise, check whether the hub knows whether a port is removable
2471 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2473 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
2476 if (hub_is_superspeed(hdev)) {
2477 if (le16_to_cpu(hub->descriptor->u.ss.DeviceRemovable)
2481 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
2486 dev_set_removable(&udev->dev, DEVICE_REMOVABLE);
2488 dev_set_removable(&udev->dev, DEVICE_FIXED);
2493 * usb_new_device - perform initial device setup (usbcore-internal)
2494 * @udev: newly addressed device (in ADDRESS state)
2496 * This is called with devices which have been detected but not fully
2497 * enumerated. The device descriptor is available, but not descriptors
2498 * for any device configuration. The caller must have locked either
2499 * the parent hub (if udev is a normal device) or else the
2500 * usb_bus_idr_lock (if udev is a root hub). The parent's pointer to
2501 * udev has already been installed, but udev is not yet visible through
2502 * sysfs or other filesystem code.
2504 * This call is synchronous, and may not be used in an interrupt context.
2506 * Only the hub driver or root-hub registrar should ever call this.
2508 * Return: Whether the device is configured properly or not. Zero if the
2509 * interface was registered with the driver core; else a negative errno
2513 int usb_new_device(struct usb_device *udev)
2518 /* Initialize non-root-hub device wakeup to disabled;
2519 * device (un)configuration controls wakeup capable
2520 * sysfs power/wakeup controls wakeup enabled/disabled
2522 device_init_wakeup(&udev->dev, 0);
2525 /* Tell the runtime-PM framework the device is active */
2526 pm_runtime_set_active(&udev->dev);
2527 pm_runtime_get_noresume(&udev->dev);
2528 pm_runtime_use_autosuspend(&udev->dev);
2529 pm_runtime_enable(&udev->dev);
2531 /* By default, forbid autosuspend for all devices. It will be
2532 * allowed for hubs during binding.
2534 usb_disable_autosuspend(udev);
2536 err = usb_enumerate_device(udev); /* Read descriptors */
2539 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
2540 udev->devnum, udev->bus->busnum,
2541 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2542 /* export the usbdev device-node for libusb */
2543 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
2544 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2546 /* Tell the world! */
2547 announce_device(udev);
2550 add_device_randomness(udev->serial, strlen(udev->serial));
2552 add_device_randomness(udev->product, strlen(udev->product));
2553 if (udev->manufacturer)
2554 add_device_randomness(udev->manufacturer,
2555 strlen(udev->manufacturer));
2557 device_enable_async_suspend(&udev->dev);
2559 /* check whether the hub or firmware marks this port as non-removable */
2560 set_usb_port_removable(udev);
2562 /* Register the device. The device driver is responsible
2563 * for configuring the device and invoking the add-device
2564 * notifier chain (used by usbfs and possibly others).
2566 err = device_add(&udev->dev);
2568 dev_err(&udev->dev, "can't device_add, error %d\n", err);
2572 /* Create link files between child device and usb port device. */
2574 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2575 int port1 = udev->portnum;
2576 struct usb_port *port_dev = hub->ports[port1 - 1];
2578 err = sysfs_create_link(&udev->dev.kobj,
2579 &port_dev->dev.kobj, "port");
2583 err = sysfs_create_link(&port_dev->dev.kobj,
2584 &udev->dev.kobj, "device");
2586 sysfs_remove_link(&udev->dev.kobj, "port");
2590 if (!test_and_set_bit(port1, hub->child_usage_bits))
2591 pm_runtime_get_sync(&port_dev->dev);
2594 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
2595 usb_mark_last_busy(udev);
2596 pm_runtime_put_sync_autosuspend(&udev->dev);
2600 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2601 pm_runtime_disable(&udev->dev);
2602 pm_runtime_set_suspended(&udev->dev);
2608 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2609 * @usb_dev: USB device
2611 * Move the USB device to a very basic state where interfaces are disabled
2612 * and the device is in fact unconfigured and unusable.
2614 * We share a lock (that we have) with device_del(), so we need to
2619 int usb_deauthorize_device(struct usb_device *usb_dev)
2621 usb_lock_device(usb_dev);
2622 if (usb_dev->authorized == 0)
2623 goto out_unauthorized;
2625 usb_dev->authorized = 0;
2626 usb_set_configuration(usb_dev, -1);
2629 usb_unlock_device(usb_dev);
2634 int usb_authorize_device(struct usb_device *usb_dev)
2638 usb_lock_device(usb_dev);
2639 if (usb_dev->authorized == 1)
2640 goto out_authorized;
2642 result = usb_autoresume_device(usb_dev);
2644 dev_err(&usb_dev->dev,
2645 "can't autoresume for authorization: %d\n", result);
2646 goto error_autoresume;
2649 if (usb_dev->wusb) {
2650 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2652 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2653 "authorization: %d\n", result);
2654 goto error_device_descriptor;
2658 usb_dev->authorized = 1;
2659 /* Choose and set the configuration. This registers the interfaces
2660 * with the driver core and lets interface drivers bind to them.
2662 c = usb_choose_configuration(usb_dev);
2664 result = usb_set_configuration(usb_dev, c);
2666 dev_err(&usb_dev->dev,
2667 "can't set config #%d, error %d\n", c, result);
2668 /* This need not be fatal. The user can try to
2669 * set other configurations. */
2672 dev_info(&usb_dev->dev, "authorized to connect\n");
2674 error_device_descriptor:
2675 usb_autosuspend_device(usb_dev);
2678 usb_unlock_device(usb_dev); /* complements locktree */
2683 * get_port_ssp_rate - Match the extended port status to SSP rate
2684 * @hdev: The hub device
2685 * @ext_portstatus: extended port status
2687 * Match the extended port status speed id to the SuperSpeed Plus sublink speed
2688 * capability attributes. Base on the number of connected lanes and speed,
2689 * return the corresponding enum usb_ssp_rate.
2691 static enum usb_ssp_rate get_port_ssp_rate(struct usb_device *hdev,
2694 struct usb_ssp_cap_descriptor *ssp_cap = hdev->bos->ssp_cap;
2704 speed_id = ext_portstatus & USB_EXT_PORT_STAT_RX_SPEED_ID;
2705 lanes = USB_EXT_PORT_RX_LANES(ext_portstatus) + 1;
2707 ssac = le32_to_cpu(ssp_cap->bmAttributes) &
2708 USB_SSP_SUBLINK_SPEED_ATTRIBS;
2710 for (i = 0; i <= ssac; i++) {
2713 attr = le32_to_cpu(ssp_cap->bmSublinkSpeedAttr[i]);
2714 ssid = FIELD_GET(USB_SSP_SUBLINK_SPEED_SSID, attr);
2715 if (speed_id == ssid) {
2721 * Note: currently asymmetric lane types are only
2722 * applicable for SSIC operate in SuperSpeed protocol
2724 type = FIELD_GET(USB_SSP_SUBLINK_SPEED_ST, attr);
2725 if (type == USB_SSP_SUBLINK_SPEED_ST_ASYM_RX ||
2726 type == USB_SSP_SUBLINK_SPEED_ST_ASYM_TX)
2729 if (FIELD_GET(USB_SSP_SUBLINK_SPEED_LP, attr) !=
2730 USB_SSP_SUBLINK_SPEED_LP_SSP)
2733 lse = FIELD_GET(USB_SSP_SUBLINK_SPEED_LSE, attr);
2734 mantissa = FIELD_GET(USB_SSP_SUBLINK_SPEED_LSM, attr);
2736 /* Convert to Gbps */
2737 for (; lse < USB_SSP_SUBLINK_SPEED_LSE_GBPS; lse++)
2740 if (mantissa >= 10 && lanes == 1)
2741 return USB_SSP_GEN_2x1;
2743 if (mantissa >= 10 && lanes == 2)
2744 return USB_SSP_GEN_2x2;
2746 if (mantissa >= 5 && lanes == 2)
2747 return USB_SSP_GEN_1x2;
2754 return USB_SSP_GEN_UNKNOWN;
2757 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2758 static unsigned hub_is_wusb(struct usb_hub *hub)
2760 struct usb_hcd *hcd;
2761 if (hub->hdev->parent != NULL) /* not a root hub? */
2763 hcd = bus_to_hcd(hub->hdev->bus);
2764 return hcd->wireless;
2768 #ifdef CONFIG_USB_FEW_INIT_RETRIES
2769 #define PORT_RESET_TRIES 2
2770 #define SET_ADDRESS_TRIES 1
2771 #define GET_DESCRIPTOR_TRIES 1
2772 #define GET_MAXPACKET0_TRIES 1
2773 #define PORT_INIT_TRIES 4
2776 #define PORT_RESET_TRIES 5
2777 #define SET_ADDRESS_TRIES 2
2778 #define GET_DESCRIPTOR_TRIES 2
2779 #define GET_MAXPACKET0_TRIES 3
2780 #define PORT_INIT_TRIES 4
2781 #endif /* CONFIG_USB_FEW_INIT_RETRIES */
2783 #define HUB_ROOT_RESET_TIME 60 /* times are in msec */
2784 #define HUB_SHORT_RESET_TIME 10
2785 #define HUB_BH_RESET_TIME 50
2786 #define HUB_LONG_RESET_TIME 200
2787 #define HUB_RESET_TIMEOUT 800
2789 static bool use_new_scheme(struct usb_device *udev, int retry,
2790 struct usb_port *port_dev)
2792 int old_scheme_first_port =
2793 (port_dev->quirks & USB_PORT_QUIRK_OLD_SCHEME) ||
2797 * "New scheme" enumeration causes an extra state transition to be
2798 * exposed to an xhci host and causes USB3 devices to receive control
2799 * commands in the default state. This has been seen to cause
2800 * enumeration failures, so disable this enumeration scheme for USB3
2803 if (udev->speed >= USB_SPEED_SUPER)
2807 * If use_both_schemes is set, use the first scheme (whichever
2808 * it is) for the larger half of the retries, then use the other
2809 * scheme. Otherwise, use the first scheme for all the retries.
2811 if (use_both_schemes && retry >= (PORT_INIT_TRIES + 1) / 2)
2812 return old_scheme_first_port; /* Second half */
2813 return !old_scheme_first_port; /* First half or all */
2816 /* Is a USB 3.0 port in the Inactive or Compliance Mode state?
2817 * Port warm reset is required to recover
2819 static bool hub_port_warm_reset_required(struct usb_hub *hub, int port1,
2824 if (!hub_is_superspeed(hub->hdev))
2827 if (test_bit(port1, hub->warm_reset_bits))
2830 link_state = portstatus & USB_PORT_STAT_LINK_STATE;
2831 return link_state == USB_SS_PORT_LS_SS_INACTIVE
2832 || link_state == USB_SS_PORT_LS_COMP_MOD;
2835 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2836 struct usb_device *udev, unsigned int delay, bool warm)
2838 int delay_time, ret;
2841 u32 ext_portstatus = 0;
2843 for (delay_time = 0;
2844 delay_time < HUB_RESET_TIMEOUT;
2845 delay_time += delay) {
2846 /* wait to give the device a chance to reset */
2849 /* read and decode port status */
2850 if (hub_is_superspeedplus(hub->hdev))
2851 ret = hub_ext_port_status(hub, port1,
2852 HUB_EXT_PORT_STATUS,
2853 &portstatus, &portchange,
2856 ret = hub_port_status(hub, port1, &portstatus,
2862 * The port state is unknown until the reset completes.
2864 * On top of that, some chips may require additional time
2865 * to re-establish a connection after the reset is complete,
2866 * so also wait for the connection to be re-established.
2868 if (!(portstatus & USB_PORT_STAT_RESET) &&
2869 (portstatus & USB_PORT_STAT_CONNECTION))
2872 /* switch to the long delay after two short delay failures */
2873 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2874 delay = HUB_LONG_RESET_TIME;
2876 dev_dbg(&hub->ports[port1 - 1]->dev,
2877 "not %sreset yet, waiting %dms\n",
2878 warm ? "warm " : "", delay);
2881 if ((portstatus & USB_PORT_STAT_RESET))
2884 if (hub_port_warm_reset_required(hub, port1, portstatus))
2887 /* Device went away? */
2888 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2891 /* Retry if connect change is set but status is still connected.
2892 * A USB 3.0 connection may bounce if multiple warm resets were issued,
2893 * but the device may have successfully re-connected. Ignore it.
2895 if (!hub_is_superspeed(hub->hdev) &&
2896 (portchange & USB_PORT_STAT_C_CONNECTION)) {
2897 usb_clear_port_feature(hub->hdev, port1,
2898 USB_PORT_FEAT_C_CONNECTION);
2902 if (!(portstatus & USB_PORT_STAT_ENABLE))
2908 if (hub_is_superspeedplus(hub->hdev)) {
2909 /* extended portstatus Rx and Tx lane count are zero based */
2910 udev->rx_lanes = USB_EXT_PORT_RX_LANES(ext_portstatus) + 1;
2911 udev->tx_lanes = USB_EXT_PORT_TX_LANES(ext_portstatus) + 1;
2912 udev->ssp_rate = get_port_ssp_rate(hub->hdev, ext_portstatus);
2916 udev->ssp_rate = USB_SSP_GEN_UNKNOWN;
2918 if (hub_is_wusb(hub))
2919 udev->speed = USB_SPEED_WIRELESS;
2920 else if (udev->ssp_rate != USB_SSP_GEN_UNKNOWN)
2921 udev->speed = USB_SPEED_SUPER_PLUS;
2922 else if (hub_is_superspeed(hub->hdev))
2923 udev->speed = USB_SPEED_SUPER;
2924 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2925 udev->speed = USB_SPEED_HIGH;
2926 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2927 udev->speed = USB_SPEED_LOW;
2929 udev->speed = USB_SPEED_FULL;
2933 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2934 static int hub_port_reset(struct usb_hub *hub, int port1,
2935 struct usb_device *udev, unsigned int delay, bool warm)
2938 u16 portchange, portstatus;
2939 struct usb_port *port_dev = hub->ports[port1 - 1];
2940 int reset_recovery_time;
2942 if (!hub_is_superspeed(hub->hdev)) {
2944 dev_err(hub->intfdev, "only USB3 hub support "
2948 /* Block EHCI CF initialization during the port reset.
2949 * Some companion controllers don't like it when they mix.
2951 down_read(&ehci_cf_port_reset_rwsem);
2954 * If the caller hasn't explicitly requested a warm reset,
2955 * double check and see if one is needed.
2957 if (hub_port_status(hub, port1, &portstatus, &portchange) == 0)
2958 if (hub_port_warm_reset_required(hub, port1,
2962 clear_bit(port1, hub->warm_reset_bits);
2964 /* Reset the port */
2965 for (i = 0; i < PORT_RESET_TRIES; i++) {
2966 status = set_port_feature(hub->hdev, port1, (warm ?
2967 USB_PORT_FEAT_BH_PORT_RESET :
2968 USB_PORT_FEAT_RESET));
2969 if (status == -ENODEV) {
2970 ; /* The hub is gone */
2971 } else if (status) {
2972 dev_err(&port_dev->dev,
2973 "cannot %sreset (err = %d)\n",
2974 warm ? "warm " : "", status);
2976 status = hub_port_wait_reset(hub, port1, udev, delay,
2978 if (status && status != -ENOTCONN && status != -ENODEV)
2979 dev_dbg(hub->intfdev,
2980 "port_wait_reset: err = %d\n",
2984 /* Check for disconnect or reset */
2985 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2986 usb_clear_port_feature(hub->hdev, port1,
2987 USB_PORT_FEAT_C_RESET);
2989 if (!hub_is_superspeed(hub->hdev))
2992 usb_clear_port_feature(hub->hdev, port1,
2993 USB_PORT_FEAT_C_BH_PORT_RESET);
2994 usb_clear_port_feature(hub->hdev, port1,
2995 USB_PORT_FEAT_C_PORT_LINK_STATE);
2998 usb_clear_port_feature(hub->hdev, port1,
2999 USB_PORT_FEAT_C_CONNECTION);
3002 * If a USB 3.0 device migrates from reset to an error
3003 * state, re-issue the warm reset.
3005 if (hub_port_status(hub, port1,
3006 &portstatus, &portchange) < 0)
3009 if (!hub_port_warm_reset_required(hub, port1,
3014 * If the port is in SS.Inactive or Compliance Mode, the
3015 * hot or warm reset failed. Try another warm reset.
3018 dev_dbg(&port_dev->dev,
3019 "hot reset failed, warm reset\n");
3024 dev_dbg(&port_dev->dev,
3025 "not enabled, trying %sreset again...\n",
3026 warm ? "warm " : "");
3027 delay = HUB_LONG_RESET_TIME;
3030 dev_err(&port_dev->dev, "Cannot enable. Maybe the USB cable is bad?\n");
3034 if (port_dev->quirks & USB_PORT_QUIRK_FAST_ENUM)
3035 usleep_range(10000, 12000);
3037 /* TRSTRCY = 10 ms; plus some extra */
3038 reset_recovery_time = 10 + 40;
3040 /* Hub needs extra delay after resetting its port. */
3041 if (hub->hdev->quirks & USB_QUIRK_HUB_SLOW_RESET)
3042 reset_recovery_time += 100;
3044 msleep(reset_recovery_time);
3048 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3050 update_devnum(udev, 0);
3051 /* The xHC may think the device is already reset,
3052 * so ignore the status.
3054 if (hcd->driver->reset_device)
3055 hcd->driver->reset_device(hcd, udev);
3057 usb_set_device_state(udev, USB_STATE_DEFAULT);
3061 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
3064 if (!hub_is_superspeed(hub->hdev))
3065 up_read(&ehci_cf_port_reset_rwsem);
3070 /* Check if a port is power on */
3071 static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
3075 if (hub_is_superspeed(hub->hdev)) {
3076 if (portstatus & USB_SS_PORT_STAT_POWER)
3079 if (portstatus & USB_PORT_STAT_POWER)
3086 static void usb_lock_port(struct usb_port *port_dev)
3087 __acquires(&port_dev->status_lock)
3089 mutex_lock(&port_dev->status_lock);
3090 __acquire(&port_dev->status_lock);
3093 static void usb_unlock_port(struct usb_port *port_dev)
3094 __releases(&port_dev->status_lock)
3096 mutex_unlock(&port_dev->status_lock);
3097 __release(&port_dev->status_lock);
3102 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
3103 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
3107 if (hub_is_superspeed(hub->hdev)) {
3108 if ((portstatus & USB_PORT_STAT_LINK_STATE)
3109 == USB_SS_PORT_LS_U3)
3112 if (portstatus & USB_PORT_STAT_SUSPEND)
3119 /* Determine whether the device on a port is ready for a normal resume,
3120 * is ready for a reset-resume, or should be disconnected.
3122 static int check_port_resume_type(struct usb_device *udev,
3123 struct usb_hub *hub, int port1,
3124 int status, u16 portchange, u16 portstatus)
3126 struct usb_port *port_dev = hub->ports[port1 - 1];
3130 /* Is a warm reset needed to recover the connection? */
3131 if (status == 0 && udev->reset_resume
3132 && hub_port_warm_reset_required(hub, port1, portstatus)) {
3135 /* Is the device still present? */
3136 else if (status || port_is_suspended(hub, portstatus) ||
3137 !port_is_power_on(hub, portstatus)) {
3140 } else if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
3142 usleep_range(200, 300);
3143 status = hub_port_status(hub, port1, &portstatus,
3150 /* Can't do a normal resume if the port isn't enabled,
3151 * so try a reset-resume instead.
3153 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
3154 if (udev->persist_enabled)
3155 udev->reset_resume = 1;
3161 dev_dbg(&port_dev->dev, "status %04x.%04x after resume, %d\n",
3162 portchange, portstatus, status);
3163 } else if (udev->reset_resume) {
3165 /* Late port handoff can set status-change bits */
3166 if (portchange & USB_PORT_STAT_C_CONNECTION)
3167 usb_clear_port_feature(hub->hdev, port1,
3168 USB_PORT_FEAT_C_CONNECTION);
3169 if (portchange & USB_PORT_STAT_C_ENABLE)
3170 usb_clear_port_feature(hub->hdev, port1,
3171 USB_PORT_FEAT_C_ENABLE);
3174 * Whatever made this reset-resume necessary may have
3175 * turned on the port1 bit in hub->change_bits. But after
3176 * a successful reset-resume we want the bit to be clear;
3177 * if it was on it would indicate that something happened
3178 * following the reset-resume.
3180 clear_bit(port1, hub->change_bits);
3186 int usb_disable_ltm(struct usb_device *udev)
3188 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3190 /* Check if the roothub and device supports LTM. */
3191 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
3192 !usb_device_supports_ltm(udev))
3195 /* Clear Feature LTM Enable can only be sent if the device is
3198 if (!udev->actconfig)
3201 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3202 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
3203 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
3204 USB_CTRL_SET_TIMEOUT);
3206 EXPORT_SYMBOL_GPL(usb_disable_ltm);
3208 void usb_enable_ltm(struct usb_device *udev)
3210 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3212 /* Check if the roothub and device supports LTM. */
3213 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
3214 !usb_device_supports_ltm(udev))
3217 /* Set Feature LTM Enable can only be sent if the device is
3220 if (!udev->actconfig)
3223 usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3224 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
3225 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
3226 USB_CTRL_SET_TIMEOUT);
3228 EXPORT_SYMBOL_GPL(usb_enable_ltm);
3231 * usb_enable_remote_wakeup - enable remote wakeup for a device
3232 * @udev: target device
3234 * For USB-2 devices: Set the device's remote wakeup feature.
3236 * For USB-3 devices: Assume there's only one function on the device and
3237 * enable remote wake for the first interface. FIXME if the interface
3238 * association descriptor shows there's more than one function.
3240 static int usb_enable_remote_wakeup(struct usb_device *udev)
3242 if (udev->speed < USB_SPEED_SUPER)
3243 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3244 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
3245 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
3246 USB_CTRL_SET_TIMEOUT);
3248 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3249 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
3250 USB_INTRF_FUNC_SUSPEND,
3251 USB_INTRF_FUNC_SUSPEND_RW |
3252 USB_INTRF_FUNC_SUSPEND_LP,
3253 NULL, 0, USB_CTRL_SET_TIMEOUT);
3257 * usb_disable_remote_wakeup - disable remote wakeup for a device
3258 * @udev: target device
3260 * For USB-2 devices: Clear the device's remote wakeup feature.
3262 * For USB-3 devices: Assume there's only one function on the device and
3263 * disable remote wake for the first interface. FIXME if the interface
3264 * association descriptor shows there's more than one function.
3266 static int usb_disable_remote_wakeup(struct usb_device *udev)
3268 if (udev->speed < USB_SPEED_SUPER)
3269 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3270 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
3271 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
3272 USB_CTRL_SET_TIMEOUT);
3274 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3275 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
3276 USB_INTRF_FUNC_SUSPEND, 0, NULL, 0,
3277 USB_CTRL_SET_TIMEOUT);
3280 /* Count of wakeup-enabled devices at or below udev */
3281 unsigned usb_wakeup_enabled_descendants(struct usb_device *udev)
3283 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
3285 return udev->do_remote_wakeup +
3286 (hub ? hub->wakeup_enabled_descendants : 0);
3288 EXPORT_SYMBOL_GPL(usb_wakeup_enabled_descendants);
3291 * usb_port_suspend - suspend a usb device's upstream port
3292 * @udev: device that's no longer in active use, not a root hub
3293 * Context: must be able to sleep; device not locked; pm locks held
3295 * Suspends a USB device that isn't in active use, conserving power.
3296 * Devices may wake out of a suspend, if anything important happens,
3297 * using the remote wakeup mechanism. They may also be taken out of
3298 * suspend by the host, using usb_port_resume(). It's also routine
3299 * to disconnect devices while they are suspended.
3301 * This only affects the USB hardware for a device; its interfaces
3302 * (and, for hubs, child devices) must already have been suspended.
3304 * Selective port suspend reduces power; most suspended devices draw
3305 * less than 500 uA. It's also used in OTG, along with remote wakeup.
3306 * All devices below the suspended port are also suspended.
3308 * Devices leave suspend state when the host wakes them up. Some devices
3309 * also support "remote wakeup", where the device can activate the USB
3310 * tree above them to deliver data, such as a keypress or packet. In
3311 * some cases, this wakes the USB host.
3313 * Suspending OTG devices may trigger HNP, if that's been enabled
3314 * between a pair of dual-role devices. That will change roles, such
3315 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
3317 * Devices on USB hub ports have only one "suspend" state, corresponding
3318 * to ACPI D2, "may cause the device to lose some context".
3319 * State transitions include:
3321 * - suspend, resume ... when the VBUS power link stays live
3322 * - suspend, disconnect ... VBUS lost
3324 * Once VBUS drop breaks the circuit, the port it's using has to go through
3325 * normal re-enumeration procedures, starting with enabling VBUS power.
3326 * Other than re-initializing the hub (plug/unplug, except for root hubs),
3327 * Linux (2.6) currently has NO mechanisms to initiate that: no hub_wq
3328 * timer, no SRP, no requests through sysfs.
3330 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
3331 * suspended until their bus goes into global suspend (i.e., the root
3332 * hub is suspended). Nevertheless, we change @udev->state to
3333 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
3334 * upstream port setting is stored in @udev->port_is_suspended.
3336 * Returns 0 on success, else negative errno.
3338 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
3340 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3341 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3342 int port1 = udev->portnum;
3344 bool really_suspend = true;
3346 usb_lock_port(port_dev);
3348 /* enable remote wakeup when appropriate; this lets the device
3349 * wake up the upstream hub (including maybe the root hub).
3351 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
3352 * we don't explicitly enable it here.
3354 if (udev->do_remote_wakeup) {
3355 status = usb_enable_remote_wakeup(udev);
3357 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
3359 /* bail if autosuspend is requested */
3360 if (PMSG_IS_AUTO(msg))
3365 /* disable USB2 hardware LPM */
3366 usb_disable_usb2_hardware_lpm(udev);
3368 if (usb_disable_ltm(udev)) {
3369 dev_err(&udev->dev, "Failed to disable LTM before suspend\n");
3371 if (PMSG_IS_AUTO(msg))
3376 if (hub_is_superspeed(hub->hdev))
3377 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U3);
3380 * For system suspend, we do not need to enable the suspend feature
3381 * on individual USB-2 ports. The devices will automatically go
3382 * into suspend a few ms after the root hub stops sending packets.
3383 * The USB 2.0 spec calls this "global suspend".
3385 * However, many USB hubs have a bug: They don't relay wakeup requests
3386 * from a downstream port if the port's suspend feature isn't on.
3387 * Therefore we will turn on the suspend feature if udev or any of its
3388 * descendants is enabled for remote wakeup.
3390 else if (PMSG_IS_AUTO(msg) || usb_wakeup_enabled_descendants(udev) > 0)
3391 status = set_port_feature(hub->hdev, port1,
3392 USB_PORT_FEAT_SUSPEND);
3394 really_suspend = false;
3398 /* Check if the port has been suspended for the timeout case
3399 * to prevent the suspended port from incorrect handling.
3401 if (status == -ETIMEDOUT) {
3403 u16 portstatus, portchange;
3405 portstatus = portchange = 0;
3406 ret = hub_port_status(hub, port1, &portstatus,
3409 dev_dbg(&port_dev->dev,
3410 "suspend timeout, status %04x\n", portstatus);
3412 if (ret == 0 && port_is_suspended(hub, portstatus)) {
3418 dev_dbg(&port_dev->dev, "can't suspend, status %d\n", status);
3420 /* Try to enable USB3 LTM again */
3421 usb_enable_ltm(udev);
3423 /* Try to enable USB2 hardware LPM again */
3424 usb_enable_usb2_hardware_lpm(udev);
3426 if (udev->do_remote_wakeup)
3427 (void) usb_disable_remote_wakeup(udev);
3430 /* System sleep transitions should never fail */
3431 if (!PMSG_IS_AUTO(msg))
3435 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
3436 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
3437 udev->do_remote_wakeup);
3438 if (really_suspend) {
3439 udev->port_is_suspended = 1;
3441 /* device has up to 10 msec to fully suspend */
3444 usb_set_device_state(udev, USB_STATE_SUSPENDED);
3447 if (status == 0 && !udev->do_remote_wakeup && udev->persist_enabled
3448 && test_and_clear_bit(port1, hub->child_usage_bits))
3449 pm_runtime_put_sync(&port_dev->dev);
3451 usb_mark_last_busy(hub->hdev);
3453 usb_unlock_port(port_dev);
3458 * If the USB "suspend" state is in use (rather than "global suspend"),
3459 * many devices will be individually taken out of suspend state using
3460 * special "resume" signaling. This routine kicks in shortly after
3461 * hardware resume signaling is finished, either because of selective
3462 * resume (by host) or remote wakeup (by device) ... now see what changed
3463 * in the tree that's rooted at this device.
3465 * If @udev->reset_resume is set then the device is reset before the
3466 * status check is done.
3468 static int finish_port_resume(struct usb_device *udev)
3473 /* caller owns the udev device lock */
3474 dev_dbg(&udev->dev, "%s\n",
3475 udev->reset_resume ? "finish reset-resume" : "finish resume");
3477 /* usb ch9 identifies four variants of SUSPENDED, based on what
3478 * state the device resumes to. Linux currently won't see the
3479 * first two on the host side; they'd be inside hub_port_init()
3480 * during many timeouts, but hub_wq can't suspend until later.
3482 usb_set_device_state(udev, udev->actconfig
3483 ? USB_STATE_CONFIGURED
3484 : USB_STATE_ADDRESS);
3486 /* 10.5.4.5 says not to reset a suspended port if the attached
3487 * device is enabled for remote wakeup. Hence the reset
3488 * operation is carried out here, after the port has been
3491 if (udev->reset_resume) {
3493 * If the device morphs or switches modes when it is reset,
3494 * we don't want to perform a reset-resume. We'll fail the
3495 * resume, which will cause a logical disconnect, and then
3496 * the device will be rediscovered.
3499 if (udev->quirks & USB_QUIRK_RESET)
3502 status = usb_reset_and_verify_device(udev);
3505 /* 10.5.4.5 says be sure devices in the tree are still there.
3506 * For now let's assume the device didn't go crazy on resume,
3507 * and device drivers will know about any resume quirks.
3511 status = usb_get_std_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
3513 /* If a normal resume failed, try doing a reset-resume */
3514 if (status && !udev->reset_resume && udev->persist_enabled) {
3515 dev_dbg(&udev->dev, "retry with reset-resume\n");
3516 udev->reset_resume = 1;
3517 goto retry_reset_resume;
3522 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
3525 * There are a few quirky devices which violate the standard
3526 * by claiming to have remote wakeup enabled after a reset,
3527 * which crash if the feature is cleared, hence check for
3528 * udev->reset_resume
3530 } else if (udev->actconfig && !udev->reset_resume) {
3531 if (udev->speed < USB_SPEED_SUPER) {
3532 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
3533 status = usb_disable_remote_wakeup(udev);
3535 status = usb_get_std_status(udev, USB_RECIP_INTERFACE, 0,
3537 if (!status && devstatus & (USB_INTRF_STAT_FUNC_RW_CAP
3538 | USB_INTRF_STAT_FUNC_RW))
3539 status = usb_disable_remote_wakeup(udev);
3544 "disable remote wakeup, status %d\n",
3552 * There are some SS USB devices which take longer time for link training.
3553 * XHCI specs 4.19.4 says that when Link training is successful, port
3554 * sets CCS bit to 1. So if SW reads port status before successful link
3555 * training, then it will not find device to be present.
3556 * USB Analyzer log with such buggy devices show that in some cases
3557 * device switch on the RX termination after long delay of host enabling
3558 * the VBUS. In few other cases it has been seen that device fails to
3559 * negotiate link training in first attempt. It has been
3560 * reported till now that few devices take as long as 2000 ms to train
3561 * the link after host enabling its VBUS and termination. Following
3562 * routine implements a 2000 ms timeout for link training. If in a case
3563 * link trains before timeout, loop will exit earlier.
3565 * There are also some 2.0 hard drive based devices and 3.0 thumb
3566 * drives that, when plugged into a 2.0 only port, take a long
3567 * time to set CCS after VBUS enable.
3569 * FIXME: If a device was connected before suspend, but was removed
3570 * while system was asleep, then the loop in the following routine will
3571 * only exit at timeout.
3573 * This routine should only be called when persist is enabled.
3575 static int wait_for_connected(struct usb_device *udev,
3576 struct usb_hub *hub, int *port1,
3577 u16 *portchange, u16 *portstatus)
3579 int status = 0, delay_ms = 0;
3581 while (delay_ms < 2000) {
3582 if (status || *portstatus & USB_PORT_STAT_CONNECTION)
3584 if (!port_is_power_on(hub, *portstatus)) {
3590 status = hub_port_status(hub, *port1, portstatus, portchange);
3592 dev_dbg(&udev->dev, "Waited %dms for CONNECT\n", delay_ms);
3597 * usb_port_resume - re-activate a suspended usb device's upstream port
3598 * @udev: device to re-activate, not a root hub
3599 * Context: must be able to sleep; device not locked; pm locks held
3601 * This will re-activate the suspended device, increasing power usage
3602 * while letting drivers communicate again with its endpoints.
3603 * USB resume explicitly guarantees that the power session between
3604 * the host and the device is the same as it was when the device
3607 * If @udev->reset_resume is set then this routine won't check that the
3608 * port is still enabled. Furthermore, finish_port_resume() above will
3609 * reset @udev. The end result is that a broken power session can be
3610 * recovered and @udev will appear to persist across a loss of VBUS power.
3612 * For example, if a host controller doesn't maintain VBUS suspend current
3613 * during a system sleep or is reset when the system wakes up, all the USB
3614 * power sessions below it will be broken. This is especially troublesome
3615 * for mass-storage devices containing mounted filesystems, since the
3616 * device will appear to have disconnected and all the memory mappings
3617 * to it will be lost. Using the USB_PERSIST facility, the device can be
3618 * made to appear as if it had not disconnected.
3620 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3621 * every effort to insure that the same device is present after the
3622 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3623 * quite possible for a device to remain unaltered but its media to be
3624 * changed. If the user replaces a flash memory card while the system is
3625 * asleep, he will have only himself to blame when the filesystem on the
3626 * new card is corrupted and the system crashes.
3628 * Returns 0 on success, else negative errno.
3630 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
3632 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3633 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3634 int port1 = udev->portnum;
3636 u16 portchange, portstatus;
3638 if (!test_and_set_bit(port1, hub->child_usage_bits)) {
3639 status = pm_runtime_resume_and_get(&port_dev->dev);
3641 dev_dbg(&udev->dev, "can't resume usb port, status %d\n",
3647 usb_lock_port(port_dev);
3649 /* Skip the initial Clear-Suspend step for a remote wakeup */
3650 status = hub_port_status(hub, port1, &portstatus, &portchange);
3651 if (status == 0 && !port_is_suspended(hub, portstatus)) {
3652 if (portchange & USB_PORT_STAT_C_SUSPEND)
3653 pm_wakeup_event(&udev->dev, 0);
3654 goto SuspendCleared;
3657 /* see 7.1.7.7; affects power usage, but not budgeting */
3658 if (hub_is_superspeed(hub->hdev))
3659 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U0);
3661 status = usb_clear_port_feature(hub->hdev,
3662 port1, USB_PORT_FEAT_SUSPEND);
3664 dev_dbg(&port_dev->dev, "can't resume, status %d\n", status);
3666 /* drive resume for USB_RESUME_TIMEOUT msec */
3667 dev_dbg(&udev->dev, "usb %sresume\n",
3668 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
3669 msleep(USB_RESUME_TIMEOUT);
3671 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3672 * stop resume signaling. Then finish the resume
3675 status = hub_port_status(hub, port1, &portstatus, &portchange);
3680 udev->port_is_suspended = 0;
3681 if (hub_is_superspeed(hub->hdev)) {
3682 if (portchange & USB_PORT_STAT_C_LINK_STATE)
3683 usb_clear_port_feature(hub->hdev, port1,
3684 USB_PORT_FEAT_C_PORT_LINK_STATE);
3686 if (portchange & USB_PORT_STAT_C_SUSPEND)
3687 usb_clear_port_feature(hub->hdev, port1,
3688 USB_PORT_FEAT_C_SUSPEND);
3691 /* TRSMRCY = 10 msec */
3695 if (udev->persist_enabled)
3696 status = wait_for_connected(udev, hub, &port1, &portchange,
3699 status = check_port_resume_type(udev,
3700 hub, port1, status, portchange, portstatus);
3702 status = finish_port_resume(udev);
3704 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
3705 hub_port_logical_disconnect(hub, port1);
3707 /* Try to enable USB2 hardware LPM */
3708 usb_enable_usb2_hardware_lpm(udev);
3710 /* Try to enable USB3 LTM */
3711 usb_enable_ltm(udev);
3714 usb_unlock_port(port_dev);
3719 int usb_remote_wakeup(struct usb_device *udev)
3723 usb_lock_device(udev);
3724 if (udev->state == USB_STATE_SUSPENDED) {
3725 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
3726 status = usb_autoresume_device(udev);
3728 /* Let the drivers do their thing, then... */
3729 usb_autosuspend_device(udev);
3732 usb_unlock_device(udev);
3736 /* Returns 1 if there was a remote wakeup and a connect status change. */
3737 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
3738 u16 portstatus, u16 portchange)
3739 __must_hold(&port_dev->status_lock)
3741 struct usb_port *port_dev = hub->ports[port - 1];
3742 struct usb_device *hdev;
3743 struct usb_device *udev;
3744 int connect_change = 0;
3749 udev = port_dev->child;
3750 if (!hub_is_superspeed(hdev)) {
3751 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
3753 usb_clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
3755 link_state = portstatus & USB_PORT_STAT_LINK_STATE;
3756 if (!udev || udev->state != USB_STATE_SUSPENDED ||
3757 (link_state != USB_SS_PORT_LS_U0 &&
3758 link_state != USB_SS_PORT_LS_U1 &&
3759 link_state != USB_SS_PORT_LS_U2))
3764 /* TRSMRCY = 10 msec */
3767 usb_unlock_port(port_dev);
3768 ret = usb_remote_wakeup(udev);
3769 usb_lock_port(port_dev);
3774 hub_port_disable(hub, port, 1);
3776 dev_dbg(&port_dev->dev, "resume, status %d\n", ret);
3777 return connect_change;
3780 static int check_ports_changed(struct usb_hub *hub)
3784 for (port1 = 1; port1 <= hub->hdev->maxchild; ++port1) {
3785 u16 portstatus, portchange;
3788 status = hub_port_status(hub, port1, &portstatus, &portchange);
3789 if (!status && portchange)
3795 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
3797 struct usb_hub *hub = usb_get_intfdata(intf);
3798 struct usb_device *hdev = hub->hdev;
3802 * Warn if children aren't already suspended.
3803 * Also, add up the number of wakeup-enabled descendants.
3805 hub->wakeup_enabled_descendants = 0;
3806 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3807 struct usb_port *port_dev = hub->ports[port1 - 1];
3808 struct usb_device *udev = port_dev->child;
3810 if (udev && udev->can_submit) {
3811 dev_warn(&port_dev->dev, "device %s not suspended yet\n",
3812 dev_name(&udev->dev));
3813 if (PMSG_IS_AUTO(msg))
3817 hub->wakeup_enabled_descendants +=
3818 usb_wakeup_enabled_descendants(udev);
3821 if (hdev->do_remote_wakeup && hub->quirk_check_port_auto_suspend) {
3822 /* check if there are changes pending on hub ports */
3823 if (check_ports_changed(hub)) {
3824 if (PMSG_IS_AUTO(msg))
3826 pm_wakeup_event(&hdev->dev, 2000);
3830 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
3831 /* Enable hub to send remote wakeup for all ports. */
3832 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3833 set_port_feature(hdev,
3835 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
3836 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
3837 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
3838 USB_PORT_FEAT_REMOTE_WAKE_MASK);
3842 dev_dbg(&intf->dev, "%s\n", __func__);
3844 /* stop hub_wq and related activity */
3845 hub_quiesce(hub, HUB_SUSPEND);
3849 /* Report wakeup requests from the ports of a resuming root hub */
3850 static void report_wakeup_requests(struct usb_hub *hub)
3852 struct usb_device *hdev = hub->hdev;
3853 struct usb_device *udev;
3854 struct usb_hcd *hcd;
3855 unsigned long resuming_ports;
3859 return; /* Not a root hub */
3861 hcd = bus_to_hcd(hdev->bus);
3862 if (hcd->driver->get_resuming_ports) {
3865 * The get_resuming_ports() method returns a bitmap (origin 0)
3866 * of ports which have started wakeup signaling but have not
3867 * yet finished resuming. During system resume we will
3868 * resume all the enabled ports, regardless of any wakeup
3869 * signals, which means the wakeup requests would be lost.
3870 * To prevent this, report them to the PM core here.
3872 resuming_ports = hcd->driver->get_resuming_ports(hcd);
3873 for (i = 0; i < hdev->maxchild; ++i) {
3874 if (test_bit(i, &resuming_ports)) {
3875 udev = hub->ports[i]->child;
3877 pm_wakeup_event(&udev->dev, 0);
3883 static int hub_resume(struct usb_interface *intf)
3885 struct usb_hub *hub = usb_get_intfdata(intf);
3887 dev_dbg(&intf->dev, "%s\n", __func__);
3888 hub_activate(hub, HUB_RESUME);
3891 * This should be called only for system resume, not runtime resume.
3892 * We can't tell the difference here, so some wakeup requests will be
3893 * reported at the wrong time or more than once. This shouldn't
3894 * matter much, so long as they do get reported.
3896 report_wakeup_requests(hub);
3900 static int hub_reset_resume(struct usb_interface *intf)
3902 struct usb_hub *hub = usb_get_intfdata(intf);
3904 dev_dbg(&intf->dev, "%s\n", __func__);
3905 hub_activate(hub, HUB_RESET_RESUME);
3910 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3911 * @rhdev: struct usb_device for the root hub
3913 * The USB host controller driver calls this function when its root hub
3914 * is resumed and Vbus power has been interrupted or the controller
3915 * has been reset. The routine marks @rhdev as having lost power.
3916 * When the hub driver is resumed it will take notice and carry out
3917 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3918 * the others will be disconnected.
3920 void usb_root_hub_lost_power(struct usb_device *rhdev)
3922 dev_notice(&rhdev->dev, "root hub lost power or was reset\n");
3923 rhdev->reset_resume = 1;
3925 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
3927 static const char * const usb3_lpm_names[] = {
3935 * Send a Set SEL control transfer to the device, prior to enabling
3936 * device-initiated U1 or U2. This lets the device know the exit latencies from
3937 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3938 * packet from the host.
3940 * This function will fail if the SEL or PEL values for udev are greater than
3941 * the maximum allowed values for the link state to be enabled.
3943 static int usb_req_set_sel(struct usb_device *udev, enum usb3_link_state state)
3945 struct usb_set_sel_req *sel_values;
3946 unsigned long long u1_sel;
3947 unsigned long long u1_pel;
3948 unsigned long long u2_sel;
3949 unsigned long long u2_pel;
3952 if (udev->state != USB_STATE_CONFIGURED)
3955 /* Convert SEL and PEL stored in ns to us */
3956 u1_sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
3957 u1_pel = DIV_ROUND_UP(udev->u1_params.pel, 1000);
3958 u2_sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
3959 u2_pel = DIV_ROUND_UP(udev->u2_params.pel, 1000);
3962 * Make sure that the calculated SEL and PEL values for the link
3963 * state we're enabling aren't bigger than the max SEL/PEL
3964 * value that will fit in the SET SEL control transfer.
3965 * Otherwise the device would get an incorrect idea of the exit
3966 * latency for the link state, and could start a device-initiated
3967 * U1/U2 when the exit latencies are too high.
3969 if ((state == USB3_LPM_U1 &&
3970 (u1_sel > USB3_LPM_MAX_U1_SEL_PEL ||
3971 u1_pel > USB3_LPM_MAX_U1_SEL_PEL)) ||
3972 (state == USB3_LPM_U2 &&
3973 (u2_sel > USB3_LPM_MAX_U2_SEL_PEL ||
3974 u2_pel > USB3_LPM_MAX_U2_SEL_PEL))) {
3975 dev_dbg(&udev->dev, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3976 usb3_lpm_names[state], u1_sel, u1_pel);
3981 * If we're enabling device-initiated LPM for one link state,
3982 * but the other link state has a too high SEL or PEL value,
3983 * just set those values to the max in the Set SEL request.
3985 if (u1_sel > USB3_LPM_MAX_U1_SEL_PEL)
3986 u1_sel = USB3_LPM_MAX_U1_SEL_PEL;
3988 if (u1_pel > USB3_LPM_MAX_U1_SEL_PEL)
3989 u1_pel = USB3_LPM_MAX_U1_SEL_PEL;
3991 if (u2_sel > USB3_LPM_MAX_U2_SEL_PEL)
3992 u2_sel = USB3_LPM_MAX_U2_SEL_PEL;
3994 if (u2_pel > USB3_LPM_MAX_U2_SEL_PEL)
3995 u2_pel = USB3_LPM_MAX_U2_SEL_PEL;
3998 * usb_enable_lpm() can be called as part of a failed device reset,
3999 * which may be initiated by an error path of a mass storage driver.
4000 * Therefore, use GFP_NOIO.
4002 sel_values = kmalloc(sizeof *(sel_values), GFP_NOIO);
4006 sel_values->u1_sel = u1_sel;
4007 sel_values->u1_pel = u1_pel;
4008 sel_values->u2_sel = cpu_to_le16(u2_sel);
4009 sel_values->u2_pel = cpu_to_le16(u2_pel);
4011 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
4015 sel_values, sizeof *(sel_values),
4016 USB_CTRL_SET_TIMEOUT);
4022 * Enable or disable device-initiated U1 or U2 transitions.
4024 static int usb_set_device_initiated_lpm(struct usb_device *udev,
4025 enum usb3_link_state state, bool enable)
4032 feature = USB_DEVICE_U1_ENABLE;
4035 feature = USB_DEVICE_U2_ENABLE;
4038 dev_warn(&udev->dev, "%s: Can't %s non-U1 or U2 state.\n",
4039 __func__, enable ? "enable" : "disable");
4043 if (udev->state != USB_STATE_CONFIGURED) {
4044 dev_dbg(&udev->dev, "%s: Can't %s %s state "
4045 "for unconfigured device.\n",
4046 __func__, enable ? "enable" : "disable",
4047 usb3_lpm_names[state]);
4053 * Now send the control transfer to enable device-initiated LPM
4054 * for either U1 or U2.
4056 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
4057 USB_REQ_SET_FEATURE,
4061 USB_CTRL_SET_TIMEOUT);
4063 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
4064 USB_REQ_CLEAR_FEATURE,
4068 USB_CTRL_SET_TIMEOUT);
4071 dev_warn(&udev->dev, "%s of device-initiated %s failed.\n",
4072 enable ? "Enable" : "Disable",
4073 usb3_lpm_names[state]);
4079 static int usb_set_lpm_timeout(struct usb_device *udev,
4080 enum usb3_link_state state, int timeout)
4087 feature = USB_PORT_FEAT_U1_TIMEOUT;
4090 feature = USB_PORT_FEAT_U2_TIMEOUT;
4093 dev_warn(&udev->dev, "%s: Can't set timeout for non-U1 or U2 state.\n",
4098 if (state == USB3_LPM_U1 && timeout > USB3_LPM_U1_MAX_TIMEOUT &&
4099 timeout != USB3_LPM_DEVICE_INITIATED) {
4100 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x, "
4101 "which is a reserved value.\n",
4102 usb3_lpm_names[state], timeout);
4106 ret = set_port_feature(udev->parent,
4107 USB_PORT_LPM_TIMEOUT(timeout) | udev->portnum,
4110 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x,"
4111 "error code %i\n", usb3_lpm_names[state],
4115 if (state == USB3_LPM_U1)
4116 udev->u1_params.timeout = timeout;
4118 udev->u2_params.timeout = timeout;
4123 * Don't allow device intiated U1/U2 if the system exit latency + one bus
4124 * interval is greater than the minimum service interval of any active
4125 * periodic endpoint. See USB 3.2 section 9.4.9
4127 static bool usb_device_may_initiate_lpm(struct usb_device *udev,
4128 enum usb3_link_state state)
4130 unsigned int sel; /* us */
4133 if (state == USB3_LPM_U1)
4134 sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
4135 else if (state == USB3_LPM_U2)
4136 sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
4140 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
4141 struct usb_interface *intf;
4142 struct usb_endpoint_descriptor *desc;
4143 unsigned int interval;
4145 intf = udev->actconfig->interface[i];
4149 for (j = 0; j < intf->cur_altsetting->desc.bNumEndpoints; j++) {
4150 desc = &intf->cur_altsetting->endpoint[j].desc;
4152 if (usb_endpoint_xfer_int(desc) ||
4153 usb_endpoint_xfer_isoc(desc)) {
4154 interval = (1 << (desc->bInterval - 1)) * 125;
4155 if (sel + 125 > interval)
4164 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
4167 * We will attempt to enable U1 or U2, but there are no guarantees that the
4168 * control transfers to set the hub timeout or enable device-initiated U1/U2
4169 * will be successful.
4171 * If the control transfer to enable device-initiated U1/U2 entry fails, then
4172 * hub-initiated U1/U2 will be disabled.
4174 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
4175 * driver know about it. If that call fails, it should be harmless, and just
4176 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
4178 static void usb_enable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
4179 enum usb3_link_state state)
4182 __u8 u1_mel = udev->bos->ss_cap->bU1devExitLat;
4183 __le16 u2_mel = udev->bos->ss_cap->bU2DevExitLat;
4185 /* If the device says it doesn't have *any* exit latency to come out of
4186 * U1 or U2, it's probably lying. Assume it doesn't implement that link
4189 if ((state == USB3_LPM_U1 && u1_mel == 0) ||
4190 (state == USB3_LPM_U2 && u2_mel == 0))
4194 * First, let the device know about the exit latencies
4195 * associated with the link state we're about to enable.
4197 ret = usb_req_set_sel(udev, state);
4199 dev_warn(&udev->dev, "Set SEL for device-initiated %s failed.\n",
4200 usb3_lpm_names[state]);
4204 /* We allow the host controller to set the U1/U2 timeout internally
4205 * first, so that it can change its schedule to account for the
4206 * additional latency to send data to a device in a lower power
4209 timeout = hcd->driver->enable_usb3_lpm_timeout(hcd, udev, state);
4211 /* xHCI host controller doesn't want to enable this LPM state. */
4216 dev_warn(&udev->dev, "Could not enable %s link state, "
4217 "xHCI error %i.\n", usb3_lpm_names[state],
4222 if (usb_set_lpm_timeout(udev, state, timeout)) {
4223 /* If we can't set the parent hub U1/U2 timeout,
4224 * device-initiated LPM won't be allowed either, so let the xHCI
4225 * host know that this link state won't be enabled.
4227 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
4231 /* Only a configured device will accept the Set Feature
4234 if (udev->actconfig &&
4235 usb_device_may_initiate_lpm(udev, state)) {
4236 if (usb_set_device_initiated_lpm(udev, state, true)) {
4238 * Request to enable device initiated U1/U2 failed,
4239 * better to turn off lpm in this case.
4241 usb_set_lpm_timeout(udev, state, 0);
4242 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
4247 if (state == USB3_LPM_U1)
4248 udev->usb3_lpm_u1_enabled = 1;
4249 else if (state == USB3_LPM_U2)
4250 udev->usb3_lpm_u2_enabled = 1;
4253 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
4256 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
4257 * If zero is returned, the parent will not allow the link to go into U1/U2.
4259 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
4260 * it won't have an effect on the bus link state because the parent hub will
4261 * still disallow device-initiated U1/U2 entry.
4263 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
4264 * possible. The result will be slightly more bus bandwidth will be taken up
4265 * (to account for U1/U2 exit latency), but it should be harmless.
4267 static int usb_disable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
4268 enum usb3_link_state state)
4275 dev_warn(&udev->dev, "%s: Can't disable non-U1 or U2 state.\n",
4280 if (usb_set_lpm_timeout(udev, state, 0))
4283 usb_set_device_initiated_lpm(udev, state, false);
4285 if (hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state))
4286 dev_warn(&udev->dev, "Could not disable xHCI %s timeout, "
4287 "bus schedule bandwidth may be impacted.\n",
4288 usb3_lpm_names[state]);
4290 /* As soon as usb_set_lpm_timeout(0) return 0, hub initiated LPM
4291 * is disabled. Hub will disallows link to enter U1/U2 as well,
4292 * even device is initiating LPM. Hence LPM is disabled if hub LPM
4293 * timeout set to 0, no matter device-initiated LPM is disabled or
4296 if (state == USB3_LPM_U1)
4297 udev->usb3_lpm_u1_enabled = 0;
4298 else if (state == USB3_LPM_U2)
4299 udev->usb3_lpm_u2_enabled = 0;
4305 * Disable hub-initiated and device-initiated U1 and U2 entry.
4306 * Caller must own the bandwidth_mutex.
4308 * This will call usb_enable_lpm() on failure, which will decrement
4309 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
4311 int usb_disable_lpm(struct usb_device *udev)
4313 struct usb_hcd *hcd;
4315 if (!udev || !udev->parent ||
4316 udev->speed < USB_SPEED_SUPER ||
4317 !udev->lpm_capable ||
4318 udev->state < USB_STATE_CONFIGURED)
4321 hcd = bus_to_hcd(udev->bus);
4322 if (!hcd || !hcd->driver->disable_usb3_lpm_timeout)
4325 udev->lpm_disable_count++;
4326 if ((udev->u1_params.timeout == 0 && udev->u2_params.timeout == 0))
4329 /* If LPM is enabled, attempt to disable it. */
4330 if (usb_disable_link_state(hcd, udev, USB3_LPM_U1))
4332 if (usb_disable_link_state(hcd, udev, USB3_LPM_U2))
4338 usb_enable_lpm(udev);
4341 EXPORT_SYMBOL_GPL(usb_disable_lpm);
4343 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
4344 int usb_unlocked_disable_lpm(struct usb_device *udev)
4346 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4352 mutex_lock(hcd->bandwidth_mutex);
4353 ret = usb_disable_lpm(udev);
4354 mutex_unlock(hcd->bandwidth_mutex);
4358 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
4361 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
4362 * xHCI host policy may prevent U1 or U2 from being enabled.
4364 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
4365 * until the lpm_disable_count drops to zero. Caller must own the
4368 void usb_enable_lpm(struct usb_device *udev)
4370 struct usb_hcd *hcd;
4371 struct usb_hub *hub;
4372 struct usb_port *port_dev;
4374 if (!udev || !udev->parent ||
4375 udev->speed < USB_SPEED_SUPER ||
4376 !udev->lpm_capable ||
4377 udev->state < USB_STATE_CONFIGURED)
4380 udev->lpm_disable_count--;
4381 hcd = bus_to_hcd(udev->bus);
4382 /* Double check that we can both enable and disable LPM.
4383 * Device must be configured to accept set feature U1/U2 timeout.
4385 if (!hcd || !hcd->driver->enable_usb3_lpm_timeout ||
4386 !hcd->driver->disable_usb3_lpm_timeout)
4389 if (udev->lpm_disable_count > 0)
4392 hub = usb_hub_to_struct_hub(udev->parent);
4396 port_dev = hub->ports[udev->portnum - 1];
4398 if (port_dev->usb3_lpm_u1_permit)
4399 usb_enable_link_state(hcd, udev, USB3_LPM_U1);
4401 if (port_dev->usb3_lpm_u2_permit)
4402 usb_enable_link_state(hcd, udev, USB3_LPM_U2);
4404 EXPORT_SYMBOL_GPL(usb_enable_lpm);
4406 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
4407 void usb_unlocked_enable_lpm(struct usb_device *udev)
4409 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4414 mutex_lock(hcd->bandwidth_mutex);
4415 usb_enable_lpm(udev);
4416 mutex_unlock(hcd->bandwidth_mutex);
4418 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
4420 /* usb3 devices use U3 for disabled, make sure remote wakeup is disabled */
4421 static void hub_usb3_port_prepare_disable(struct usb_hub *hub,
4422 struct usb_port *port_dev)
4424 struct usb_device *udev = port_dev->child;
4427 if (udev && udev->port_is_suspended && udev->do_remote_wakeup) {
4428 ret = hub_set_port_link_state(hub, port_dev->portnum,
4431 msleep(USB_RESUME_TIMEOUT);
4432 ret = usb_disable_remote_wakeup(udev);
4435 dev_warn(&udev->dev,
4436 "Port disable: can't disable remote wake\n");
4437 udev->do_remote_wakeup = 0;
4441 #else /* CONFIG_PM */
4443 #define hub_suspend NULL
4444 #define hub_resume NULL
4445 #define hub_reset_resume NULL
4447 static inline void hub_usb3_port_prepare_disable(struct usb_hub *hub,
4448 struct usb_port *port_dev) { }
4450 int usb_disable_lpm(struct usb_device *udev)
4454 EXPORT_SYMBOL_GPL(usb_disable_lpm);
4456 void usb_enable_lpm(struct usb_device *udev) { }
4457 EXPORT_SYMBOL_GPL(usb_enable_lpm);
4459 int usb_unlocked_disable_lpm(struct usb_device *udev)
4463 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
4465 void usb_unlocked_enable_lpm(struct usb_device *udev) { }
4466 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
4468 int usb_disable_ltm(struct usb_device *udev)
4472 EXPORT_SYMBOL_GPL(usb_disable_ltm);
4474 void usb_enable_ltm(struct usb_device *udev) { }
4475 EXPORT_SYMBOL_GPL(usb_enable_ltm);
4477 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
4478 u16 portstatus, u16 portchange)
4483 #endif /* CONFIG_PM */
4486 * USB-3 does not have a similar link state as USB-2 that will avoid negotiating
4487 * a connection with a plugged-in cable but will signal the host when the cable
4488 * is unplugged. Disable remote wake and set link state to U3 for USB-3 devices
4490 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
4492 struct usb_port *port_dev = hub->ports[port1 - 1];
4493 struct usb_device *hdev = hub->hdev;
4497 if (hub_is_superspeed(hub->hdev)) {
4498 hub_usb3_port_prepare_disable(hub, port_dev);
4499 ret = hub_set_port_link_state(hub, port_dev->portnum,
4502 ret = usb_clear_port_feature(hdev, port1,
4503 USB_PORT_FEAT_ENABLE);
4506 if (port_dev->child && set_state)
4507 usb_set_device_state(port_dev->child, USB_STATE_NOTATTACHED);
4508 if (ret && ret != -ENODEV)
4509 dev_err(&port_dev->dev, "cannot disable (err = %d)\n", ret);
4514 * usb_port_disable - disable a usb device's upstream port
4515 * @udev: device to disable
4516 * Context: @udev locked, must be able to sleep.
4518 * Disables a USB device that isn't in active use.
4520 int usb_port_disable(struct usb_device *udev)
4522 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
4524 return hub_port_disable(hub, udev->portnum, 0);
4527 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
4529 * Between connect detection and reset signaling there must be a delay
4530 * of 100ms at least for debounce and power-settling. The corresponding
4531 * timer shall restart whenever the downstream port detects a disconnect.
4533 * Apparently there are some bluetooth and irda-dongles and a number of
4534 * low-speed devices for which this debounce period may last over a second.
4535 * Not covered by the spec - but easy to deal with.
4537 * This implementation uses a 1500ms total debounce timeout; if the
4538 * connection isn't stable by then it returns -ETIMEDOUT. It checks
4539 * every 25ms for transient disconnects. When the port status has been
4540 * unchanged for 100ms it returns the port status.
4542 int hub_port_debounce(struct usb_hub *hub, int port1, bool must_be_connected)
4545 u16 portchange, portstatus;
4546 unsigned connection = 0xffff;
4547 int total_time, stable_time = 0;
4548 struct usb_port *port_dev = hub->ports[port1 - 1];
4550 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
4551 ret = hub_port_status(hub, port1, &portstatus, &portchange);
4555 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
4556 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
4557 if (!must_be_connected ||
4558 (connection == USB_PORT_STAT_CONNECTION))
4559 stable_time += HUB_DEBOUNCE_STEP;
4560 if (stable_time >= HUB_DEBOUNCE_STABLE)
4564 connection = portstatus & USB_PORT_STAT_CONNECTION;
4567 if (portchange & USB_PORT_STAT_C_CONNECTION) {
4568 usb_clear_port_feature(hub->hdev, port1,
4569 USB_PORT_FEAT_C_CONNECTION);
4572 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
4574 msleep(HUB_DEBOUNCE_STEP);
4577 dev_dbg(&port_dev->dev, "debounce total %dms stable %dms status 0x%x\n",
4578 total_time, stable_time, portstatus);
4580 if (stable_time < HUB_DEBOUNCE_STABLE)
4585 void usb_ep0_reinit(struct usb_device *udev)
4587 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
4588 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
4589 usb_enable_endpoint(udev, &udev->ep0, true);
4591 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
4593 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
4594 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
4596 static int hub_set_address(struct usb_device *udev, int devnum)
4599 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4602 * The host controller will choose the device address,
4603 * instead of the core having chosen it earlier
4605 if (!hcd->driver->address_device && devnum <= 1)
4607 if (udev->state == USB_STATE_ADDRESS)
4609 if (udev->state != USB_STATE_DEFAULT)
4611 if (hcd->driver->address_device)
4612 retval = hcd->driver->address_device(hcd, udev);
4614 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
4615 USB_REQ_SET_ADDRESS, 0, devnum, 0,
4616 NULL, 0, USB_CTRL_SET_TIMEOUT);
4618 update_devnum(udev, devnum);
4619 /* Device now using proper address. */
4620 usb_set_device_state(udev, USB_STATE_ADDRESS);
4621 usb_ep0_reinit(udev);
4627 * There are reports of USB 3.0 devices that say they support USB 2.0 Link PM
4628 * when they're plugged into a USB 2.0 port, but they don't work when LPM is
4631 * Only enable USB 2.0 Link PM if the port is internal (hardwired), or the
4632 * device says it supports the new USB 2.0 Link PM errata by setting the BESL
4633 * support bit in the BOS descriptor.
4635 static void hub_set_initial_usb2_lpm_policy(struct usb_device *udev)
4637 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
4638 int connect_type = USB_PORT_CONNECT_TYPE_UNKNOWN;
4640 if (!udev->usb2_hw_lpm_capable || !udev->bos)
4644 connect_type = hub->ports[udev->portnum - 1]->connect_type;
4646 if ((udev->bos->ext_cap->bmAttributes & cpu_to_le32(USB_BESL_SUPPORT)) ||
4647 connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
4648 udev->usb2_hw_lpm_allowed = 1;
4649 usb_enable_usb2_hardware_lpm(udev);
4653 static int hub_enable_device(struct usb_device *udev)
4655 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4657 if (!hcd->driver->enable_device)
4659 if (udev->state == USB_STATE_ADDRESS)
4661 if (udev->state != USB_STATE_DEFAULT)
4664 return hcd->driver->enable_device(hcd, udev);
4667 /* Reset device, (re)assign address, get device descriptor.
4668 * Device connection must be stable, no more debouncing needed.
4669 * Returns device in USB_STATE_ADDRESS, except on error.
4671 * If this is called for an already-existing device (as part of
4672 * usb_reset_and_verify_device), the caller must own the device lock and
4673 * the port lock. For a newly detected device that is not accessible
4674 * through any global pointers, it's not necessary to lock the device,
4675 * but it is still necessary to lock the port.
4678 hub_port_init(struct usb_hub *hub, struct usb_device *udev, int port1,
4681 struct usb_device *hdev = hub->hdev;
4682 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4683 struct usb_port *port_dev = hub->ports[port1 - 1];
4684 int retries, operations, retval, i;
4685 unsigned delay = HUB_SHORT_RESET_TIME;
4686 enum usb_device_speed oldspeed = udev->speed;
4688 int devnum = udev->devnum;
4689 const char *driver_name;
4692 /* root hub ports have a slightly longer reset period
4693 * (from USB 2.0 spec, section 7.1.7.5)
4695 if (!hdev->parent) {
4696 delay = HUB_ROOT_RESET_TIME;
4697 if (port1 == hdev->bus->otg_port)
4698 hdev->bus->b_hnp_enable = 0;
4701 /* Some low speed devices have problems with the quick delay, so */
4702 /* be a bit pessimistic with those devices. RHbug #23670 */
4703 if (oldspeed == USB_SPEED_LOW)
4704 delay = HUB_LONG_RESET_TIME;
4706 /* Reset the device; full speed may morph to high speed */
4707 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
4708 retval = hub_port_reset(hub, port1, udev, delay, false);
4709 if (retval < 0) /* error or disconnect */
4711 /* success, speed is known */
4715 /* Don't allow speed changes at reset, except usb 3.0 to faster */
4716 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed &&
4717 !(oldspeed == USB_SPEED_SUPER && udev->speed > oldspeed)) {
4718 dev_dbg(&udev->dev, "device reset changed speed!\n");
4721 oldspeed = udev->speed;
4723 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4724 * it's fixed size except for full speed devices.
4725 * For Wireless USB devices, ep0 max packet is always 512 (tho
4726 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4728 switch (udev->speed) {
4729 case USB_SPEED_SUPER_PLUS:
4730 case USB_SPEED_SUPER:
4731 case USB_SPEED_WIRELESS: /* fixed at 512 */
4732 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
4734 case USB_SPEED_HIGH: /* fixed at 64 */
4735 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4737 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
4738 /* to determine the ep0 maxpacket size, try to read
4739 * the device descriptor to get bMaxPacketSize0 and
4740 * then correct our initial guess.
4742 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4744 case USB_SPEED_LOW: /* fixed at 8 */
4745 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
4751 if (udev->speed == USB_SPEED_WIRELESS)
4752 speed = "variable speed Wireless";
4754 speed = usb_speed_string(udev->speed);
4757 * The controller driver may be NULL if the controller device
4758 * is the middle device between platform device and roothub.
4759 * This middle device may not need a device driver due to
4760 * all hardware control can be at platform device driver, this
4761 * platform device is usually a dual-role USB controller device.
4763 if (udev->bus->controller->driver)
4764 driver_name = udev->bus->controller->driver->name;
4766 driver_name = udev->bus->sysdev->driver->name;
4768 if (udev->speed < USB_SPEED_SUPER)
4769 dev_info(&udev->dev,
4770 "%s %s USB device number %d using %s\n",
4771 (udev->config) ? "reset" : "new", speed,
4772 devnum, driver_name);
4774 /* Set up TT records, if needed */
4776 udev->tt = hdev->tt;
4777 udev->ttport = hdev->ttport;
4778 } else if (udev->speed != USB_SPEED_HIGH
4779 && hdev->speed == USB_SPEED_HIGH) {
4781 dev_err(&udev->dev, "parent hub has no TT\n");
4785 udev->tt = &hub->tt;
4786 udev->ttport = port1;
4789 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4790 * Because device hardware and firmware is sometimes buggy in
4791 * this area, and this is how Linux has done it for ages.
4792 * Change it cautiously.
4794 * NOTE: If use_new_scheme() is true we will start by issuing
4795 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4796 * so it may help with some non-standards-compliant devices.
4797 * Otherwise we start with SET_ADDRESS and then try to read the
4798 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4801 do_new_scheme = use_new_scheme(udev, retry_counter, port_dev);
4803 for (retries = 0; retries < GET_DESCRIPTOR_TRIES; (++retries, msleep(100))) {
4804 if (do_new_scheme) {
4805 struct usb_device_descriptor *buf;
4808 retval = hub_enable_device(udev);
4811 "hub failed to enable device, error %d\n",
4816 #define GET_DESCRIPTOR_BUFSIZE 64
4817 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
4823 /* Retry on all errors; some devices are flakey.
4824 * 255 is for WUSB devices, we actually need to use
4825 * 512 (WUSB1.0[4.8.1]).
4827 for (operations = 0; operations < GET_MAXPACKET0_TRIES;
4829 buf->bMaxPacketSize0 = 0;
4830 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
4831 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
4832 USB_DT_DEVICE << 8, 0,
4833 buf, GET_DESCRIPTOR_BUFSIZE,
4834 initial_descriptor_timeout);
4835 switch (buf->bMaxPacketSize0) {
4836 case 8: case 16: case 32: case 64: case 255:
4837 if (buf->bDescriptorType ==
4849 * Some devices time out if they are powered on
4850 * when already connected. They need a second
4851 * reset. But only on the first attempt,
4852 * lest we get into a time out/reset loop
4854 if (r == 0 || (r == -ETIMEDOUT &&
4856 udev->speed > USB_SPEED_FULL))
4859 udev->descriptor.bMaxPacketSize0 =
4860 buf->bMaxPacketSize0;
4863 retval = hub_port_reset(hub, port1, udev, delay, false);
4864 if (retval < 0) /* error or disconnect */
4866 if (oldspeed != udev->speed) {
4868 "device reset changed speed!\n");
4874 dev_err(&udev->dev, "device descriptor read/64, error %d\n",
4879 #undef GET_DESCRIPTOR_BUFSIZE
4883 * If device is WUSB, we already assigned an
4884 * unauthorized address in the Connect Ack sequence;
4885 * authorization will assign the final address.
4887 if (udev->wusb == 0) {
4888 for (operations = 0; operations < SET_ADDRESS_TRIES; ++operations) {
4889 retval = hub_set_address(udev, devnum);
4895 if (retval != -ENODEV)
4896 dev_err(&udev->dev, "device not accepting address %d, error %d\n",
4900 if (udev->speed >= USB_SPEED_SUPER) {
4901 devnum = udev->devnum;
4902 dev_info(&udev->dev,
4903 "%s SuperSpeed%s%s USB device number %d using %s\n",
4904 (udev->config) ? "reset" : "new",
4905 (udev->speed == USB_SPEED_SUPER_PLUS) ?
4907 (udev->ssp_rate == USB_SSP_GEN_2x2) ?
4909 (udev->ssp_rate == USB_SSP_GEN_2x1) ?
4911 (udev->ssp_rate == USB_SSP_GEN_1x2) ?
4913 devnum, driver_name);
4916 /* cope with hardware quirkiness:
4917 * - let SET_ADDRESS settle, some device hardware wants it
4918 * - read ep0 maxpacket even for high and low speed,
4925 retval = usb_get_device_descriptor(udev, 8);
4927 if (retval != -ENODEV)
4929 "device descriptor read/8, error %d\n",
4938 delay = udev->parent->hub_delay;
4939 udev->hub_delay = min_t(u32, delay,
4940 USB_TP_TRANSMISSION_DELAY_MAX);
4941 retval = usb_set_isoch_delay(udev);
4944 "Failed set isoch delay, error %d\n",
4955 * Some superspeed devices have finished the link training process
4956 * and attached to a superspeed hub port, but the device descriptor
4957 * got from those devices show they aren't superspeed devices. Warm
4958 * reset the port attached by the devices can fix them.
4960 if ((udev->speed >= USB_SPEED_SUPER) &&
4961 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
4962 dev_err(&udev->dev, "got a wrong device descriptor, "
4963 "warm reset device\n");
4964 hub_port_reset(hub, port1, udev,
4965 HUB_BH_RESET_TIME, true);
4970 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
4971 udev->speed >= USB_SPEED_SUPER)
4974 i = udev->descriptor.bMaxPacketSize0;
4975 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
4976 if (udev->speed == USB_SPEED_LOW ||
4977 !(i == 8 || i == 16 || i == 32 || i == 64)) {
4978 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
4982 if (udev->speed == USB_SPEED_FULL)
4983 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
4985 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
4986 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
4987 usb_ep0_reinit(udev);
4990 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
4991 if (retval < (signed)sizeof(udev->descriptor)) {
4992 if (retval != -ENODEV)
4993 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
5000 usb_detect_quirks(udev);
5002 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
5003 retval = usb_get_bos_descriptor(udev);
5005 udev->lpm_capable = usb_device_supports_lpm(udev);
5006 usb_set_lpm_parameters(udev);
5011 /* notify HCD that we have a device connected and addressed */
5012 if (hcd->driver->update_device)
5013 hcd->driver->update_device(hcd, udev);
5014 hub_set_initial_usb2_lpm_policy(udev);
5017 hub_port_disable(hub, port1, 0);
5018 update_devnum(udev, devnum); /* for disconnect processing */
5024 check_highspeed(struct usb_hub *hub, struct usb_device *udev, int port1)
5026 struct usb_qualifier_descriptor *qual;
5029 if (udev->quirks & USB_QUIRK_DEVICE_QUALIFIER)
5032 qual = kmalloc(sizeof *qual, GFP_KERNEL);
5036 status = usb_get_descriptor(udev, USB_DT_DEVICE_QUALIFIER, 0,
5037 qual, sizeof *qual);
5038 if (status == sizeof *qual) {
5039 dev_info(&udev->dev, "not running at top speed; "
5040 "connect to a high speed hub\n");
5041 /* hub LEDs are probably harder to miss than syslog */
5042 if (hub->has_indicators) {
5043 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
5044 queue_delayed_work(system_power_efficient_wq,
5052 hub_power_remaining(struct usb_hub *hub)
5054 struct usb_device *hdev = hub->hdev;
5058 if (!hub->limited_power)
5061 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
5062 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
5063 struct usb_port *port_dev = hub->ports[port1 - 1];
5064 struct usb_device *udev = port_dev->child;
5070 if (hub_is_superspeed(udev))
5076 * Unconfigured devices may not use more than one unit load,
5077 * or 8mA for OTG ports
5079 if (udev->actconfig)
5080 delta = usb_get_max_power(udev, udev->actconfig);
5081 else if (port1 != udev->bus->otg_port || hdev->parent)
5085 if (delta > hub->mA_per_port)
5086 dev_warn(&port_dev->dev, "%dmA is over %umA budget!\n",
5087 delta, hub->mA_per_port);
5090 if (remaining < 0) {
5091 dev_warn(hub->intfdev, "%dmA over power budget!\n",
5099 static int descriptors_changed(struct usb_device *udev,
5100 struct usb_device_descriptor *old_device_descriptor,
5101 struct usb_host_bos *old_bos)
5105 unsigned serial_len = 0;
5107 unsigned old_length;
5111 if (memcmp(&udev->descriptor, old_device_descriptor,
5112 sizeof(*old_device_descriptor)) != 0)
5115 if ((old_bos && !udev->bos) || (!old_bos && udev->bos))
5118 len = le16_to_cpu(udev->bos->desc->wTotalLength);
5119 if (len != le16_to_cpu(old_bos->desc->wTotalLength))
5121 if (memcmp(udev->bos->desc, old_bos->desc, len))
5125 /* Since the idVendor, idProduct, and bcdDevice values in the
5126 * device descriptor haven't changed, we will assume the
5127 * Manufacturer and Product strings haven't changed either.
5128 * But the SerialNumber string could be different (e.g., a
5129 * different flash card of the same brand).
5132 serial_len = strlen(udev->serial) + 1;
5135 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5136 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5137 len = max(len, old_length);
5140 buf = kmalloc(len, GFP_NOIO);
5142 /* assume the worst */
5145 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5146 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5147 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
5149 if (length != old_length) {
5150 dev_dbg(&udev->dev, "config index %d, error %d\n",
5155 if (memcmp(buf, udev->rawdescriptors[index], old_length)
5157 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
5159 ((struct usb_config_descriptor *) buf)->
5160 bConfigurationValue);
5166 if (!changed && serial_len) {
5167 length = usb_string(udev, udev->descriptor.iSerialNumber,
5169 if (length + 1 != serial_len) {
5170 dev_dbg(&udev->dev, "serial string error %d\n",
5173 } else if (memcmp(buf, udev->serial, length) != 0) {
5174 dev_dbg(&udev->dev, "serial string changed\n");
5183 static void hub_port_connect(struct usb_hub *hub, int port1, u16 portstatus,
5186 int status = -ENODEV;
5189 struct usb_device *hdev = hub->hdev;
5190 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
5191 struct usb_port *port_dev = hub->ports[port1 - 1];
5192 struct usb_device *udev = port_dev->child;
5193 static int unreliable_port = -1;
5196 /* Disconnect any existing devices under this port */
5198 if (hcd->usb_phy && !hdev->parent)
5199 usb_phy_notify_disconnect(hcd->usb_phy, udev->speed);
5200 usb_disconnect(&port_dev->child);
5203 /* We can forget about a "removed" device when there's a physical
5204 * disconnect or the connect status changes.
5206 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
5207 (portchange & USB_PORT_STAT_C_CONNECTION))
5208 clear_bit(port1, hub->removed_bits);
5210 if (portchange & (USB_PORT_STAT_C_CONNECTION |
5211 USB_PORT_STAT_C_ENABLE)) {
5212 status = hub_port_debounce_be_stable(hub, port1);
5214 if (status != -ENODEV &&
5215 port1 != unreliable_port &&
5217 dev_err(&port_dev->dev, "connect-debounce failed\n");
5218 portstatus &= ~USB_PORT_STAT_CONNECTION;
5219 unreliable_port = port1;
5221 portstatus = status;
5225 /* Return now if debouncing failed or nothing is connected or
5226 * the device was "removed".
5228 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
5229 test_bit(port1, hub->removed_bits)) {
5232 * maybe switch power back on (e.g. root hub was reset)
5233 * but only if the port isn't owned by someone else.
5235 if (hub_is_port_power_switchable(hub)
5236 && !port_is_power_on(hub, portstatus)
5237 && !port_dev->port_owner)
5238 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
5240 if (portstatus & USB_PORT_STAT_ENABLE)
5244 if (hub_is_superspeed(hub->hdev))
5251 for (i = 0; i < PORT_INIT_TRIES; i++) {
5252 usb_lock_port(port_dev);
5253 mutex_lock(hcd->address0_mutex);
5254 retry_locked = true;
5255 /* reallocate for each attempt, since references
5256 * to the previous one can escape in various ways
5258 udev = usb_alloc_dev(hdev, hdev->bus, port1);
5260 dev_err(&port_dev->dev,
5261 "couldn't allocate usb_device\n");
5262 mutex_unlock(hcd->address0_mutex);
5263 usb_unlock_port(port_dev);
5267 usb_set_device_state(udev, USB_STATE_POWERED);
5268 udev->bus_mA = hub->mA_per_port;
5269 udev->level = hdev->level + 1;
5270 udev->wusb = hub_is_wusb(hub);
5272 /* Devices connected to SuperSpeed hubs are USB 3.0 or later */
5273 if (hub_is_superspeed(hub->hdev))
5274 udev->speed = USB_SPEED_SUPER;
5276 udev->speed = USB_SPEED_UNKNOWN;
5278 choose_devnum(udev);
5279 if (udev->devnum <= 0) {
5280 status = -ENOTCONN; /* Don't retry */
5284 /* reset (non-USB 3.0 devices) and get descriptor */
5285 status = hub_port_init(hub, udev, port1, i);
5289 mutex_unlock(hcd->address0_mutex);
5290 usb_unlock_port(port_dev);
5291 retry_locked = false;
5293 if (udev->quirks & USB_QUIRK_DELAY_INIT)
5296 /* consecutive bus-powered hubs aren't reliable; they can
5297 * violate the voltage drop budget. if the new child has
5298 * a "powered" LED, users should notice we didn't enable it
5299 * (without reading syslog), even without per-port LEDs
5302 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
5303 && udev->bus_mA <= unit_load) {
5306 status = usb_get_std_status(udev, USB_RECIP_DEVICE, 0,
5309 dev_dbg(&udev->dev, "get status %d ?\n", status);
5312 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
5314 "can't connect bus-powered hub "
5316 if (hub->has_indicators) {
5317 hub->indicator[port1-1] =
5318 INDICATOR_AMBER_BLINK;
5320 system_power_efficient_wq,
5323 status = -ENOTCONN; /* Don't retry */
5328 /* check for devices running slower than they could */
5329 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
5330 && udev->speed == USB_SPEED_FULL
5331 && highspeed_hubs != 0)
5332 check_highspeed(hub, udev, port1);
5334 /* Store the parent's children[] pointer. At this point
5335 * udev becomes globally accessible, although presumably
5336 * no one will look at it until hdev is unlocked.
5340 mutex_lock(&usb_port_peer_mutex);
5342 /* We mustn't add new devices if the parent hub has
5343 * been disconnected; we would race with the
5344 * recursively_mark_NOTATTACHED() routine.
5346 spin_lock_irq(&device_state_lock);
5347 if (hdev->state == USB_STATE_NOTATTACHED)
5350 port_dev->child = udev;
5351 spin_unlock_irq(&device_state_lock);
5352 mutex_unlock(&usb_port_peer_mutex);
5354 /* Run it through the hoops (find a driver, etc) */
5356 status = usb_new_device(udev);
5358 mutex_lock(&usb_port_peer_mutex);
5359 spin_lock_irq(&device_state_lock);
5360 port_dev->child = NULL;
5361 spin_unlock_irq(&device_state_lock);
5362 mutex_unlock(&usb_port_peer_mutex);
5364 if (hcd->usb_phy && !hdev->parent)
5365 usb_phy_notify_connect(hcd->usb_phy,
5373 status = hub_power_remaining(hub);
5375 dev_dbg(hub->intfdev, "%dmA power budget left\n", status);
5380 hub_port_disable(hub, port1, 1);
5382 usb_ep0_reinit(udev);
5383 release_devnum(udev);
5386 mutex_unlock(hcd->address0_mutex);
5387 usb_unlock_port(port_dev);
5390 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
5393 /* When halfway through our retry count, power-cycle the port */
5394 if (i == (PORT_INIT_TRIES - 1) / 2) {
5395 dev_info(&port_dev->dev, "attempt power cycle\n");
5396 usb_hub_set_port_power(hdev, hub, port1, false);
5397 msleep(2 * hub_power_on_good_delay(hub));
5398 usb_hub_set_port_power(hdev, hub, port1, true);
5399 msleep(hub_power_on_good_delay(hub));
5402 if (hub->hdev->parent ||
5403 !hcd->driver->port_handed_over ||
5404 !(hcd->driver->port_handed_over)(hcd, port1)) {
5405 if (status != -ENOTCONN && status != -ENODEV)
5406 dev_err(&port_dev->dev,
5407 "unable to enumerate USB device\n");
5411 hub_port_disable(hub, port1, 1);
5412 if (hcd->driver->relinquish_port && !hub->hdev->parent) {
5413 if (status != -ENOTCONN && status != -ENODEV)
5414 hcd->driver->relinquish_port(hcd, port1);
5418 /* Handle physical or logical connection change events.
5419 * This routine is called when:
5420 * a port connection-change occurs;
5421 * a port enable-change occurs (often caused by EMI);
5422 * usb_reset_and_verify_device() encounters changed descriptors (as from
5423 * a firmware download)
5424 * caller already locked the hub
5426 static void hub_port_connect_change(struct usb_hub *hub, int port1,
5427 u16 portstatus, u16 portchange)
5428 __must_hold(&port_dev->status_lock)
5430 struct usb_port *port_dev = hub->ports[port1 - 1];
5431 struct usb_device *udev = port_dev->child;
5432 struct usb_device_descriptor descriptor;
5433 int status = -ENODEV;
5436 dev_dbg(&port_dev->dev, "status %04x, change %04x, %s\n", portstatus,
5437 portchange, portspeed(hub, portstatus));
5439 if (hub->has_indicators) {
5440 set_port_led(hub, port1, HUB_LED_AUTO);
5441 hub->indicator[port1-1] = INDICATOR_AUTO;
5444 #ifdef CONFIG_USB_OTG
5445 /* during HNP, don't repeat the debounce */
5446 if (hub->hdev->bus->is_b_host)
5447 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
5448 USB_PORT_STAT_C_ENABLE);
5451 /* Try to resuscitate an existing device */
5452 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
5453 udev->state != USB_STATE_NOTATTACHED) {
5454 if (portstatus & USB_PORT_STAT_ENABLE) {
5456 * USB-3 connections are initialized automatically by
5457 * the hostcontroller hardware. Therefore check for
5458 * changed device descriptors before resuscitating the
5461 descriptor = udev->descriptor;
5462 retval = usb_get_device_descriptor(udev,
5463 sizeof(udev->descriptor));
5466 "can't read device descriptor %d\n",
5469 if (descriptors_changed(udev, &descriptor,
5472 "device descriptor has changed\n");
5473 /* for disconnect() calls */
5474 udev->descriptor = descriptor;
5476 status = 0; /* Nothing to do */
5480 } else if (udev->state == USB_STATE_SUSPENDED &&
5481 udev->persist_enabled) {
5482 /* For a suspended device, treat this as a
5483 * remote wakeup event.
5485 usb_unlock_port(port_dev);
5486 status = usb_remote_wakeup(udev);
5487 usb_lock_port(port_dev);
5490 /* Don't resuscitate */;
5493 clear_bit(port1, hub->change_bits);
5495 /* successfully revalidated the connection */
5499 usb_unlock_port(port_dev);
5500 hub_port_connect(hub, port1, portstatus, portchange);
5501 usb_lock_port(port_dev);
5504 /* Handle notifying userspace about hub over-current events */
5505 static void port_over_current_notify(struct usb_port *port_dev)
5508 struct device *hub_dev;
5509 char *port_dev_path;
5511 sysfs_notify(&port_dev->dev.kobj, NULL, "over_current_count");
5513 hub_dev = port_dev->dev.parent;
5518 port_dev_path = kobject_get_path(&port_dev->dev.kobj, GFP_KERNEL);
5522 envp[0] = kasprintf(GFP_KERNEL, "OVER_CURRENT_PORT=%s", port_dev_path);
5526 envp[1] = kasprintf(GFP_KERNEL, "OVER_CURRENT_COUNT=%u",
5527 port_dev->over_current_count);
5532 kobject_uevent_env(&hub_dev->kobj, KOBJ_CHANGE, envp);
5538 kfree(port_dev_path);
5541 static void port_event(struct usb_hub *hub, int port1)
5542 __must_hold(&port_dev->status_lock)
5545 struct usb_port *port_dev = hub->ports[port1 - 1];
5546 struct usb_device *udev = port_dev->child;
5547 struct usb_device *hdev = hub->hdev;
5548 u16 portstatus, portchange;
5550 connect_change = test_bit(port1, hub->change_bits);
5551 clear_bit(port1, hub->event_bits);
5552 clear_bit(port1, hub->wakeup_bits);
5554 if (hub_port_status(hub, port1, &portstatus, &portchange) < 0)
5557 if (portchange & USB_PORT_STAT_C_CONNECTION) {
5558 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_CONNECTION);
5562 if (portchange & USB_PORT_STAT_C_ENABLE) {
5563 if (!connect_change)
5564 dev_dbg(&port_dev->dev, "enable change, status %08x\n",
5566 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_ENABLE);
5569 * EM interference sometimes causes badly shielded USB devices
5570 * to be shutdown by the hub, this hack enables them again.
5571 * Works at least with mouse driver.
5573 if (!(portstatus & USB_PORT_STAT_ENABLE)
5574 && !connect_change && udev) {
5575 dev_err(&port_dev->dev, "disabled by hub (EMI?), re-enabling...\n");
5580 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
5581 u16 status = 0, unused;
5582 port_dev->over_current_count++;
5583 port_over_current_notify(port_dev);
5585 dev_dbg(&port_dev->dev, "over-current change #%u\n",
5586 port_dev->over_current_count);
5587 usb_clear_port_feature(hdev, port1,
5588 USB_PORT_FEAT_C_OVER_CURRENT);
5589 msleep(100); /* Cool down */
5590 hub_power_on(hub, true);
5591 hub_port_status(hub, port1, &status, &unused);
5592 if (status & USB_PORT_STAT_OVERCURRENT)
5593 dev_err(&port_dev->dev, "over-current condition\n");
5596 if (portchange & USB_PORT_STAT_C_RESET) {
5597 dev_dbg(&port_dev->dev, "reset change\n");
5598 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_RESET);
5600 if ((portchange & USB_PORT_STAT_C_BH_RESET)
5601 && hub_is_superspeed(hdev)) {
5602 dev_dbg(&port_dev->dev, "warm reset change\n");
5603 usb_clear_port_feature(hdev, port1,
5604 USB_PORT_FEAT_C_BH_PORT_RESET);
5606 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
5607 dev_dbg(&port_dev->dev, "link state change\n");
5608 usb_clear_port_feature(hdev, port1,
5609 USB_PORT_FEAT_C_PORT_LINK_STATE);
5611 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
5612 dev_warn(&port_dev->dev, "config error\n");
5613 usb_clear_port_feature(hdev, port1,
5614 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
5617 /* skip port actions that require the port to be powered on */
5618 if (!pm_runtime_active(&port_dev->dev))
5621 if (hub_handle_remote_wakeup(hub, port1, portstatus, portchange))
5625 * Warm reset a USB3 protocol port if it's in
5626 * SS.Inactive state.
5628 if (hub_port_warm_reset_required(hub, port1, portstatus)) {
5629 dev_dbg(&port_dev->dev, "do warm reset\n");
5630 if (!udev || !(portstatus & USB_PORT_STAT_CONNECTION)
5631 || udev->state == USB_STATE_NOTATTACHED) {
5632 if (hub_port_reset(hub, port1, NULL,
5633 HUB_BH_RESET_TIME, true) < 0)
5634 hub_port_disable(hub, port1, 1);
5636 usb_unlock_port(port_dev);
5637 usb_lock_device(udev);
5638 usb_reset_device(udev);
5639 usb_unlock_device(udev);
5640 usb_lock_port(port_dev);
5646 hub_port_connect_change(hub, port1, portstatus, portchange);
5649 static void hub_event(struct work_struct *work)
5651 struct usb_device *hdev;
5652 struct usb_interface *intf;
5653 struct usb_hub *hub;
5654 struct device *hub_dev;
5659 hub = container_of(work, struct usb_hub, events);
5661 hub_dev = hub->intfdev;
5662 intf = to_usb_interface(hub_dev);
5664 kcov_remote_start_usb((u64)hdev->bus->busnum);
5666 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
5667 hdev->state, hdev->maxchild,
5668 /* NOTE: expects max 15 ports... */
5669 (u16) hub->change_bits[0],
5670 (u16) hub->event_bits[0]);
5672 /* Lock the device, then check to see if we were
5673 * disconnected while waiting for the lock to succeed. */
5674 usb_lock_device(hdev);
5675 if (unlikely(hub->disconnected))
5678 /* If the hub has died, clean up after it */
5679 if (hdev->state == USB_STATE_NOTATTACHED) {
5680 hub->error = -ENODEV;
5681 hub_quiesce(hub, HUB_DISCONNECT);
5686 ret = usb_autopm_get_interface(intf);
5688 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
5692 /* If this is an inactive hub, do nothing */
5697 dev_dbg(hub_dev, "resetting for error %d\n", hub->error);
5699 ret = usb_reset_device(hdev);
5701 dev_dbg(hub_dev, "error resetting hub: %d\n", ret);
5709 /* deal with port status changes */
5710 for (i = 1; i <= hdev->maxchild; i++) {
5711 struct usb_port *port_dev = hub->ports[i - 1];
5713 if (test_bit(i, hub->event_bits)
5714 || test_bit(i, hub->change_bits)
5715 || test_bit(i, hub->wakeup_bits)) {
5717 * The get_noresume and barrier ensure that if
5718 * the port was in the process of resuming, we
5719 * flush that work and keep the port active for
5720 * the duration of the port_event(). However,
5721 * if the port is runtime pm suspended
5722 * (powered-off), we leave it in that state, run
5723 * an abbreviated port_event(), and move on.
5725 pm_runtime_get_noresume(&port_dev->dev);
5726 pm_runtime_barrier(&port_dev->dev);
5727 usb_lock_port(port_dev);
5729 usb_unlock_port(port_dev);
5730 pm_runtime_put_sync(&port_dev->dev);
5734 /* deal with hub status changes */
5735 if (test_and_clear_bit(0, hub->event_bits) == 0)
5737 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
5738 dev_err(hub_dev, "get_hub_status failed\n");
5740 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
5741 dev_dbg(hub_dev, "power change\n");
5742 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
5743 if (hubstatus & HUB_STATUS_LOCAL_POWER)
5744 /* FIXME: Is this always true? */
5745 hub->limited_power = 1;
5747 hub->limited_power = 0;
5749 if (hubchange & HUB_CHANGE_OVERCURRENT) {
5753 dev_dbg(hub_dev, "over-current change\n");
5754 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
5755 msleep(500); /* Cool down */
5756 hub_power_on(hub, true);
5757 hub_hub_status(hub, &status, &unused);
5758 if (status & HUB_STATUS_OVERCURRENT)
5759 dev_err(hub_dev, "over-current condition\n");
5764 /* Balance the usb_autopm_get_interface() above */
5765 usb_autopm_put_interface_no_suspend(intf);
5767 usb_unlock_device(hdev);
5769 /* Balance the stuff in kick_hub_wq() and allow autosuspend */
5770 usb_autopm_put_interface(intf);
5771 kref_put(&hub->kref, hub_release);
5776 static const struct usb_device_id hub_id_table[] = {
5777 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5778 | USB_DEVICE_ID_MATCH_PRODUCT
5779 | USB_DEVICE_ID_MATCH_INT_CLASS,
5780 .idVendor = USB_VENDOR_SMSC,
5781 .idProduct = USB_PRODUCT_USB5534B,
5782 .bInterfaceClass = USB_CLASS_HUB,
5783 .driver_info = HUB_QUIRK_DISABLE_AUTOSUSPEND},
5784 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5785 | USB_DEVICE_ID_MATCH_PRODUCT,
5786 .idVendor = USB_VENDOR_CYPRESS,
5787 .idProduct = USB_PRODUCT_CY7C65632,
5788 .driver_info = HUB_QUIRK_DISABLE_AUTOSUSPEND},
5789 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5790 | USB_DEVICE_ID_MATCH_INT_CLASS,
5791 .idVendor = USB_VENDOR_GENESYS_LOGIC,
5792 .bInterfaceClass = USB_CLASS_HUB,
5793 .driver_info = HUB_QUIRK_CHECK_PORT_AUTOSUSPEND},
5794 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
5795 .bDeviceClass = USB_CLASS_HUB},
5796 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
5797 .bInterfaceClass = USB_CLASS_HUB},
5798 { } /* Terminating entry */
5801 MODULE_DEVICE_TABLE(usb, hub_id_table);
5803 static struct usb_driver hub_driver = {
5806 .disconnect = hub_disconnect,
5807 .suspend = hub_suspend,
5808 .resume = hub_resume,
5809 .reset_resume = hub_reset_resume,
5810 .pre_reset = hub_pre_reset,
5811 .post_reset = hub_post_reset,
5812 .unlocked_ioctl = hub_ioctl,
5813 .id_table = hub_id_table,
5814 .supports_autosuspend = 1,
5817 int usb_hub_init(void)
5819 if (usb_register(&hub_driver) < 0) {
5820 printk(KERN_ERR "%s: can't register hub driver\n",
5826 * The workqueue needs to be freezable to avoid interfering with
5827 * USB-PERSIST port handover. Otherwise it might see that a full-speed
5828 * device was gone before the EHCI controller had handed its port
5829 * over to the companion full-speed controller.
5831 hub_wq = alloc_workqueue("usb_hub_wq", WQ_FREEZABLE, 0);
5835 /* Fall through if kernel_thread failed */
5836 usb_deregister(&hub_driver);
5837 pr_err("%s: can't allocate workqueue for usb hub\n", usbcore_name);
5842 void usb_hub_cleanup(void)
5844 destroy_workqueue(hub_wq);
5847 * Hub resources are freed for us by usb_deregister. It calls
5848 * usb_driver_purge on every device which in turn calls that
5849 * devices disconnect function if it is using this driver.
5850 * The hub_disconnect function takes care of releasing the
5851 * individual hub resources. -greg
5853 usb_deregister(&hub_driver);
5854 } /* usb_hub_cleanup() */
5857 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5858 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5860 * WARNING - don't use this routine to reset a composite device
5861 * (one with multiple interfaces owned by separate drivers)!
5862 * Use usb_reset_device() instead.
5864 * Do a port reset, reassign the device's address, and establish its
5865 * former operating configuration. If the reset fails, or the device's
5866 * descriptors change from their values before the reset, or the original
5867 * configuration and altsettings cannot be restored, a flag will be set
5868 * telling hub_wq to pretend the device has been disconnected and then
5869 * re-connected. All drivers will be unbound, and the device will be
5870 * re-enumerated and probed all over again.
5872 * Return: 0 if the reset succeeded, -ENODEV if the device has been
5873 * flagged for logical disconnection, or some other negative error code
5874 * if the reset wasn't even attempted.
5877 * The caller must own the device lock and the port lock, the latter is
5878 * taken by usb_reset_device(). For example, it's safe to use
5879 * usb_reset_device() from a driver probe() routine after downloading
5880 * new firmware. For calls that might not occur during probe(), drivers
5881 * should lock the device using usb_lock_device_for_reset().
5883 * Locking exception: This routine may also be called from within an
5884 * autoresume handler. Such usage won't conflict with other tasks
5885 * holding the device lock because these tasks should always call
5886 * usb_autopm_resume_device(), thereby preventing any unwanted
5887 * autoresume. The autoresume handler is expected to have already
5888 * acquired the port lock before calling this routine.
5890 static int usb_reset_and_verify_device(struct usb_device *udev)
5892 struct usb_device *parent_hdev = udev->parent;
5893 struct usb_hub *parent_hub;
5894 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
5895 struct usb_device_descriptor descriptor = udev->descriptor;
5896 struct usb_host_bos *bos;
5898 int port1 = udev->portnum;
5900 if (udev->state == USB_STATE_NOTATTACHED ||
5901 udev->state == USB_STATE_SUSPENDED) {
5902 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5910 parent_hub = usb_hub_to_struct_hub(parent_hdev);
5912 /* Disable USB2 hardware LPM.
5913 * It will be re-enabled by the enumeration process.
5915 usb_disable_usb2_hardware_lpm(udev);
5917 /* Disable LPM while we reset the device and reinstall the alt settings.
5918 * Device-initiated LPM, and system exit latency settings are cleared
5919 * when the device is reset, so we have to set them up again.
5921 ret = usb_unlocked_disable_lpm(udev);
5923 dev_err(&udev->dev, "%s Failed to disable LPM\n", __func__);
5924 goto re_enumerate_no_bos;
5930 mutex_lock(hcd->address0_mutex);
5932 for (i = 0; i < PORT_INIT_TRIES; ++i) {
5934 /* ep0 maxpacket size may change; let the HCD know about it.
5935 * Other endpoints will be handled by re-enumeration. */
5936 usb_ep0_reinit(udev);
5937 ret = hub_port_init(parent_hub, udev, port1, i);
5938 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
5941 mutex_unlock(hcd->address0_mutex);
5946 /* Device might have changed firmware (DFU or similar) */
5947 if (descriptors_changed(udev, &descriptor, bos)) {
5948 dev_info(&udev->dev, "device firmware changed\n");
5949 udev->descriptor = descriptor; /* for disconnect() calls */
5953 /* Restore the device's previous configuration */
5954 if (!udev->actconfig)
5957 mutex_lock(hcd->bandwidth_mutex);
5958 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
5960 dev_warn(&udev->dev,
5961 "Busted HC? Not enough HCD resources for "
5962 "old configuration.\n");
5963 mutex_unlock(hcd->bandwidth_mutex);
5966 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
5967 USB_REQ_SET_CONFIGURATION, 0,
5968 udev->actconfig->desc.bConfigurationValue, 0,
5969 NULL, 0, USB_CTRL_SET_TIMEOUT);
5972 "can't restore configuration #%d (error=%d)\n",
5973 udev->actconfig->desc.bConfigurationValue, ret);
5974 mutex_unlock(hcd->bandwidth_mutex);
5977 mutex_unlock(hcd->bandwidth_mutex);
5978 usb_set_device_state(udev, USB_STATE_CONFIGURED);
5980 /* Put interfaces back into the same altsettings as before.
5981 * Don't bother to send the Set-Interface request for interfaces
5982 * that were already in altsetting 0; besides being unnecessary,
5983 * many devices can't handle it. Instead just reset the host-side
5986 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
5987 struct usb_host_config *config = udev->actconfig;
5988 struct usb_interface *intf = config->interface[i];
5989 struct usb_interface_descriptor *desc;
5991 desc = &intf->cur_altsetting->desc;
5992 if (desc->bAlternateSetting == 0) {
5993 usb_disable_interface(udev, intf, true);
5994 usb_enable_interface(udev, intf, true);
5997 /* Let the bandwidth allocation function know that this
5998 * device has been reset, and it will have to use
5999 * alternate setting 0 as the current alternate setting.
6001 intf->resetting_device = 1;
6002 ret = usb_set_interface(udev, desc->bInterfaceNumber,
6003 desc->bAlternateSetting);
6004 intf->resetting_device = 0;
6007 dev_err(&udev->dev, "failed to restore interface %d "
6008 "altsetting %d (error=%d)\n",
6009 desc->bInterfaceNumber,
6010 desc->bAlternateSetting,
6014 /* Resetting also frees any allocated streams */
6015 for (j = 0; j < intf->cur_altsetting->desc.bNumEndpoints; j++)
6016 intf->cur_altsetting->endpoint[j].streams = 0;
6020 /* Now that the alt settings are re-installed, enable LTM and LPM. */
6021 usb_enable_usb2_hardware_lpm(udev);
6022 usb_unlocked_enable_lpm(udev);
6023 usb_enable_ltm(udev);
6024 usb_release_bos_descriptor(udev);
6029 usb_release_bos_descriptor(udev);
6031 re_enumerate_no_bos:
6032 /* LPM state doesn't matter when we're about to destroy the device. */
6033 hub_port_logical_disconnect(parent_hub, port1);
6038 * usb_reset_device - warn interface drivers and perform a USB port reset
6039 * @udev: device to reset (not in NOTATTACHED state)
6041 * Warns all drivers bound to registered interfaces (using their pre_reset
6042 * method), performs the port reset, and then lets the drivers know that
6043 * the reset is over (using their post_reset method).
6045 * Return: The same as for usb_reset_and_verify_device().
6046 * However, if a reset is already in progress (for instance, if a
6047 * driver doesn't have pre_reset() or post_reset() callbacks, and while
6048 * being unbound or re-bound during the ongoing reset its disconnect()
6049 * or probe() routine tries to perform a second, nested reset), the
6050 * routine returns -EINPROGRESS.
6053 * The caller must own the device lock. For example, it's safe to use
6054 * this from a driver probe() routine after downloading new firmware.
6055 * For calls that might not occur during probe(), drivers should lock
6056 * the device using usb_lock_device_for_reset().
6058 * If an interface is currently being probed or disconnected, we assume
6059 * its driver knows how to handle resets. For all other interfaces,
6060 * if the driver doesn't have pre_reset and post_reset methods then
6061 * we attempt to unbind it and rebind afterward.
6063 int usb_reset_device(struct usb_device *udev)
6067 unsigned int noio_flag;
6068 struct usb_port *port_dev;
6069 struct usb_host_config *config = udev->actconfig;
6070 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
6072 if (udev->state == USB_STATE_NOTATTACHED) {
6073 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
6078 if (!udev->parent) {
6079 /* this requires hcd-specific logic; see ohci_restart() */
6080 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
6084 if (udev->reset_in_progress)
6085 return -EINPROGRESS;
6086 udev->reset_in_progress = 1;
6088 port_dev = hub->ports[udev->portnum - 1];
6091 * Don't allocate memory with GFP_KERNEL in current
6092 * context to avoid possible deadlock if usb mass
6093 * storage interface or usbnet interface(iSCSI case)
6094 * is included in current configuration. The easist
6095 * approach is to do it for every device reset,
6096 * because the device 'memalloc_noio' flag may have
6097 * not been set before reseting the usb device.
6099 noio_flag = memalloc_noio_save();
6101 /* Prevent autosuspend during the reset */
6102 usb_autoresume_device(udev);
6105 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
6106 struct usb_interface *cintf = config->interface[i];
6107 struct usb_driver *drv;
6110 if (cintf->dev.driver) {
6111 drv = to_usb_driver(cintf->dev.driver);
6112 if (drv->pre_reset && drv->post_reset)
6113 unbind = (drv->pre_reset)(cintf);
6114 else if (cintf->condition ==
6115 USB_INTERFACE_BOUND)
6118 usb_forced_unbind_intf(cintf);
6123 usb_lock_port(port_dev);
6124 ret = usb_reset_and_verify_device(udev);
6125 usb_unlock_port(port_dev);
6128 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
6129 struct usb_interface *cintf = config->interface[i];
6130 struct usb_driver *drv;
6131 int rebind = cintf->needs_binding;
6133 if (!rebind && cintf->dev.driver) {
6134 drv = to_usb_driver(cintf->dev.driver);
6135 if (drv->post_reset)
6136 rebind = (drv->post_reset)(cintf);
6137 else if (cintf->condition ==
6138 USB_INTERFACE_BOUND)
6141 cintf->needs_binding = 1;
6145 /* If the reset failed, hub_wq will unbind drivers later */
6147 usb_unbind_and_rebind_marked_interfaces(udev);
6150 usb_autosuspend_device(udev);
6151 memalloc_noio_restore(noio_flag);
6152 udev->reset_in_progress = 0;
6155 EXPORT_SYMBOL_GPL(usb_reset_device);
6159 * usb_queue_reset_device - Reset a USB device from an atomic context
6160 * @iface: USB interface belonging to the device to reset
6162 * This function can be used to reset a USB device from an atomic
6163 * context, where usb_reset_device() won't work (as it blocks).
6165 * Doing a reset via this method is functionally equivalent to calling
6166 * usb_reset_device(), except for the fact that it is delayed to a
6167 * workqueue. This means that any drivers bound to other interfaces
6168 * might be unbound, as well as users from usbfs in user space.
6172 * - Scheduling two resets at the same time from two different drivers
6173 * attached to two different interfaces of the same device is
6174 * possible; depending on how the driver attached to each interface
6175 * handles ->pre_reset(), the second reset might happen or not.
6177 * - If the reset is delayed so long that the interface is unbound from
6178 * its driver, the reset will be skipped.
6180 * - This function can be called during .probe(). It can also be called
6181 * during .disconnect(), but doing so is pointless because the reset
6182 * will not occur. If you really want to reset the device during
6183 * .disconnect(), call usb_reset_device() directly -- but watch out
6184 * for nested unbinding issues!
6186 void usb_queue_reset_device(struct usb_interface *iface)
6188 if (schedule_work(&iface->reset_ws))
6189 usb_get_intf(iface);
6191 EXPORT_SYMBOL_GPL(usb_queue_reset_device);
6194 * usb_hub_find_child - Get the pointer of child device
6195 * attached to the port which is specified by @port1.
6196 * @hdev: USB device belonging to the usb hub
6197 * @port1: port num to indicate which port the child device
6200 * USB drivers call this function to get hub's child device
6203 * Return: %NULL if input param is invalid and
6204 * child's usb_device pointer if non-NULL.
6206 struct usb_device *usb_hub_find_child(struct usb_device *hdev,
6209 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
6211 if (port1 < 1 || port1 > hdev->maxchild)
6213 return hub->ports[port1 - 1]->child;
6215 EXPORT_SYMBOL_GPL(usb_hub_find_child);
6217 void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
6218 struct usb_hub_descriptor *desc)
6220 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
6221 enum usb_port_connect_type connect_type;
6227 if (!hub_is_superspeed(hdev)) {
6228 for (i = 1; i <= hdev->maxchild; i++) {
6229 struct usb_port *port_dev = hub->ports[i - 1];
6231 connect_type = port_dev->connect_type;
6232 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
6233 u8 mask = 1 << (i%8);
6235 if (!(desc->u.hs.DeviceRemovable[i/8] & mask)) {
6236 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
6237 desc->u.hs.DeviceRemovable[i/8] |= mask;
6242 u16 port_removable = le16_to_cpu(desc->u.ss.DeviceRemovable);
6244 for (i = 1; i <= hdev->maxchild; i++) {
6245 struct usb_port *port_dev = hub->ports[i - 1];
6247 connect_type = port_dev->connect_type;
6248 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
6251 if (!(port_removable & mask)) {
6252 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
6253 port_removable |= mask;
6258 desc->u.ss.DeviceRemovable = cpu_to_le16(port_removable);
6264 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
6265 * @hdev: USB device belonging to the usb hub
6266 * @port1: port num of the port
6268 * Return: Port's acpi handle if successful, %NULL if params are
6271 acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
6274 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
6279 return ACPI_HANDLE(&hub->ports[port1 - 1]->dev);