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/uaccess.h>
35 #include <asm/byteorder.h>
38 #include "otg_productlist.h"
40 #define USB_VENDOR_GENESYS_LOGIC 0x05e3
41 #define USB_VENDOR_SMSC 0x0424
42 #define USB_PRODUCT_USB5534B 0x5534
43 #define USB_VENDOR_CYPRESS 0x04b4
44 #define USB_PRODUCT_CY7C65632 0x6570
45 #define HUB_QUIRK_CHECK_PORT_AUTOSUSPEND 0x01
46 #define HUB_QUIRK_DISABLE_AUTOSUSPEND 0x02
48 #define USB_TP_TRANSMISSION_DELAY 40 /* ns */
49 #define USB_TP_TRANSMISSION_DELAY_MAX 65535 /* ns */
50 #define USB_PING_RESPONSE_TIME 400 /* ns */
52 /* Protect struct usb_device->state and ->children members
53 * Note: Both are also protected by ->dev.sem, except that ->state can
54 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
55 static DEFINE_SPINLOCK(device_state_lock);
57 /* workqueue to process hub events */
58 static struct workqueue_struct *hub_wq;
59 static void hub_event(struct work_struct *work);
61 /* synchronize hub-port add/remove and peering operations */
62 DEFINE_MUTEX(usb_port_peer_mutex);
64 /* cycle leds on hubs that aren't blinking for attention */
65 static bool blinkenlights;
66 module_param(blinkenlights, bool, S_IRUGO);
67 MODULE_PARM_DESC(blinkenlights, "true to cycle leds on hubs");
70 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
71 * 10 seconds to send reply for the initial 64-byte descriptor request.
73 /* define initial 64-byte descriptor request timeout in milliseconds */
74 static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
75 module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
76 MODULE_PARM_DESC(initial_descriptor_timeout,
77 "initial 64-byte descriptor request timeout in milliseconds "
78 "(default 5000 - 5.0 seconds)");
81 * As of 2.6.10 we introduce a new USB device initialization scheme which
82 * closely resembles the way Windows works. Hopefully it will be compatible
83 * with a wider range of devices than the old scheme. However some previously
84 * working devices may start giving rise to "device not accepting address"
85 * errors; if that happens the user can try the old scheme by adjusting the
86 * following module parameters.
88 * For maximum flexibility there are two boolean parameters to control the
89 * hub driver's behavior. On the first initialization attempt, if the
90 * "old_scheme_first" parameter is set then the old scheme will be used,
91 * otherwise the new scheme is used. If that fails and "use_both_schemes"
92 * is set, then the driver will make another attempt, using the other scheme.
94 static bool old_scheme_first;
95 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
96 MODULE_PARM_DESC(old_scheme_first,
97 "start with the old device initialization scheme");
99 static bool use_both_schemes = true;
100 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
101 MODULE_PARM_DESC(use_both_schemes,
102 "try the other device initialization scheme if the "
105 /* Mutual exclusion for EHCI CF initialization. This interferes with
106 * port reset on some companion controllers.
108 DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
109 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
111 #define HUB_DEBOUNCE_TIMEOUT 2000
112 #define HUB_DEBOUNCE_STEP 25
113 #define HUB_DEBOUNCE_STABLE 100
115 static void hub_release(struct kref *kref);
116 static int usb_reset_and_verify_device(struct usb_device *udev);
117 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state);
118 static bool hub_port_warm_reset_required(struct usb_hub *hub, int port1,
121 static inline char *portspeed(struct usb_hub *hub, int portstatus)
123 if (hub_is_superspeedplus(hub->hdev))
125 if (hub_is_superspeed(hub->hdev))
127 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
129 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
135 /* Note that hdev or one of its children must be locked! */
136 struct usb_hub *usb_hub_to_struct_hub(struct usb_device *hdev)
138 if (!hdev || !hdev->actconfig || !hdev->maxchild)
140 return usb_get_intfdata(hdev->actconfig->interface[0]);
143 int usb_device_supports_lpm(struct usb_device *udev)
145 /* Some devices have trouble with LPM */
146 if (udev->quirks & USB_QUIRK_NO_LPM)
149 /* USB 2.1 (and greater) devices indicate LPM support through
150 * their USB 2.0 Extended Capabilities BOS descriptor.
152 if (udev->speed == USB_SPEED_HIGH || udev->speed == USB_SPEED_FULL) {
153 if (udev->bos->ext_cap &&
155 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
161 * According to the USB 3.0 spec, all USB 3.0 devices must support LPM.
162 * However, there are some that don't, and they set the U1/U2 exit
165 if (!udev->bos->ss_cap) {
166 dev_info(&udev->dev, "No LPM exit latency info found, disabling LPM.\n");
170 if (udev->bos->ss_cap->bU1devExitLat == 0 &&
171 udev->bos->ss_cap->bU2DevExitLat == 0) {
173 dev_info(&udev->dev, "LPM exit latency is zeroed, disabling LPM.\n");
175 dev_info(&udev->dev, "We don't know the algorithms for LPM for this host, disabling LPM.\n");
179 if (!udev->parent || udev->parent->lpm_capable)
185 * Set the Maximum Exit Latency (MEL) for the host to wakup up the path from
186 * U1/U2, send a PING to the device and receive a PING_RESPONSE.
187 * See USB 3.1 section C.1.5.2
189 static void usb_set_lpm_mel(struct usb_device *udev,
190 struct usb3_lpm_parameters *udev_lpm_params,
191 unsigned int udev_exit_latency,
193 struct usb3_lpm_parameters *hub_lpm_params,
194 unsigned int hub_exit_latency)
196 unsigned int total_mel;
199 * tMEL1. time to transition path from host to device into U0.
200 * MEL for parent already contains the delay up to parent, so only add
201 * the exit latency for the last link (pick the slower exit latency),
202 * and the hub header decode latency. See USB 3.1 section C 2.2.1
203 * Store MEL in nanoseconds
205 total_mel = hub_lpm_params->mel +
206 max(udev_exit_latency, hub_exit_latency) * 1000 +
207 hub->descriptor->u.ss.bHubHdrDecLat * 100;
210 * tMEL2. Time to submit PING packet. Sum of tTPTransmissionDelay for
211 * each link + wHubDelay for each hub. Add only for last link.
212 * tMEL4, the time for PING_RESPONSE to traverse upstream is similar.
213 * Multiply by 2 to include it as well.
215 total_mel += (__le16_to_cpu(hub->descriptor->u.ss.wHubDelay) +
216 USB_TP_TRANSMISSION_DELAY) * 2;
219 * tMEL3, tPingResponse. Time taken by device to generate PING_RESPONSE
220 * after receiving PING. Also add 2100ns as stated in USB 3.1 C 1.5.2.4
221 * to cover the delay if the PING_RESPONSE is queued behind a Max Packet
223 * Note these delays should be added only once for the entire path, so
224 * add them to the MEL of the device connected to the roothub.
226 if (!hub->hdev->parent)
227 total_mel += USB_PING_RESPONSE_TIME + 2100;
229 udev_lpm_params->mel = total_mel;
233 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
234 * a transition from either U1 or U2.
236 static void usb_set_lpm_pel(struct usb_device *udev,
237 struct usb3_lpm_parameters *udev_lpm_params,
238 unsigned int udev_exit_latency,
240 struct usb3_lpm_parameters *hub_lpm_params,
241 unsigned int hub_exit_latency,
242 unsigned int port_to_port_exit_latency)
244 unsigned int first_link_pel;
245 unsigned int hub_pel;
248 * First, the device sends an LFPS to transition the link between the
249 * device and the parent hub into U0. The exit latency is the bigger of
250 * the device exit latency or the hub exit latency.
252 if (udev_exit_latency > hub_exit_latency)
253 first_link_pel = udev_exit_latency * 1000;
255 first_link_pel = hub_exit_latency * 1000;
258 * When the hub starts to receive the LFPS, there is a slight delay for
259 * it to figure out that one of the ports is sending an LFPS. Then it
260 * will forward the LFPS to its upstream link. The exit latency is the
261 * delay, plus the PEL that we calculated for this hub.
263 hub_pel = port_to_port_exit_latency * 1000 + hub_lpm_params->pel;
266 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
267 * is the greater of the two exit latencies.
269 if (first_link_pel > hub_pel)
270 udev_lpm_params->pel = first_link_pel;
272 udev_lpm_params->pel = hub_pel;
276 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
277 * when a device initiates a transition to U0, until when it will receive the
278 * first packet from the host controller.
280 * Section C.1.5.1 describes the four components to this:
282 * - t2: time for the ERDY to make it from the device to the host.
283 * - t3: a host-specific delay to process the ERDY.
284 * - t4: time for the packet to make it from the host to the device.
286 * t3 is specific to both the xHCI host and the platform the host is integrated
287 * into. The Intel HW folks have said it's negligible, FIXME if a different
288 * vendor says otherwise.
290 static void usb_set_lpm_sel(struct usb_device *udev,
291 struct usb3_lpm_parameters *udev_lpm_params)
293 struct usb_device *parent;
294 unsigned int num_hubs;
295 unsigned int total_sel;
297 /* t1 = device PEL */
298 total_sel = udev_lpm_params->pel;
299 /* How many external hubs are in between the device & the root port. */
300 for (parent = udev->parent, num_hubs = 0; parent->parent;
301 parent = parent->parent)
303 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
305 total_sel += 2100 + 250 * (num_hubs - 1);
307 /* t4 = 250ns * num_hubs */
308 total_sel += 250 * num_hubs;
310 udev_lpm_params->sel = total_sel;
313 static void usb_set_lpm_parameters(struct usb_device *udev)
316 unsigned int port_to_port_delay;
317 unsigned int udev_u1_del;
318 unsigned int udev_u2_del;
319 unsigned int hub_u1_del;
320 unsigned int hub_u2_del;
322 if (!udev->lpm_capable || udev->speed < USB_SPEED_SUPER)
325 hub = usb_hub_to_struct_hub(udev->parent);
326 /* It doesn't take time to transition the roothub into U0, since it
327 * doesn't have an upstream link.
332 udev_u1_del = udev->bos->ss_cap->bU1devExitLat;
333 udev_u2_del = le16_to_cpu(udev->bos->ss_cap->bU2DevExitLat);
334 hub_u1_del = udev->parent->bos->ss_cap->bU1devExitLat;
335 hub_u2_del = le16_to_cpu(udev->parent->bos->ss_cap->bU2DevExitLat);
337 usb_set_lpm_mel(udev, &udev->u1_params, udev_u1_del,
338 hub, &udev->parent->u1_params, hub_u1_del);
340 usb_set_lpm_mel(udev, &udev->u2_params, udev_u2_del,
341 hub, &udev->parent->u2_params, hub_u2_del);
344 * Appendix C, section C.2.2.2, says that there is a slight delay from
345 * when the parent hub notices the downstream port is trying to
346 * transition to U0 to when the hub initiates a U0 transition on its
347 * upstream port. The section says the delays are tPort2PortU1EL and
348 * tPort2PortU2EL, but it doesn't define what they are.
350 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
351 * about the same delays. Use the maximum delay calculations from those
352 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
353 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
354 * assume the device exit latencies they are talking about are the hub
357 * What do we do if the U2 exit latency is less than the U1 exit
358 * latency? It's possible, although not likely...
360 port_to_port_delay = 1;
362 usb_set_lpm_pel(udev, &udev->u1_params, udev_u1_del,
363 hub, &udev->parent->u1_params, hub_u1_del,
366 if (hub_u2_del > hub_u1_del)
367 port_to_port_delay = 1 + hub_u2_del - hub_u1_del;
369 port_to_port_delay = 1 + hub_u1_del;
371 usb_set_lpm_pel(udev, &udev->u2_params, udev_u2_del,
372 hub, &udev->parent->u2_params, hub_u2_del,
375 /* Now that we've got PEL, calculate SEL. */
376 usb_set_lpm_sel(udev, &udev->u1_params);
377 usb_set_lpm_sel(udev, &udev->u2_params);
380 /* USB 2.0 spec Section 11.24.4.5 */
381 static int get_hub_descriptor(struct usb_device *hdev,
382 struct usb_hub_descriptor *desc)
387 if (hub_is_superspeed(hdev)) {
388 dtype = USB_DT_SS_HUB;
389 size = USB_DT_SS_HUB_SIZE;
392 size = sizeof(struct usb_hub_descriptor);
395 for (i = 0; i < 3; i++) {
396 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
397 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
398 dtype << 8, 0, desc, size,
399 USB_CTRL_GET_TIMEOUT);
400 if (hub_is_superspeed(hdev)) {
403 } else if (ret >= USB_DT_HUB_NONVAR_SIZE + 2) {
404 /* Make sure we have the DeviceRemovable field. */
405 size = USB_DT_HUB_NONVAR_SIZE + desc->bNbrPorts / 8 + 1;
415 * USB 2.0 spec Section 11.24.2.1
417 static int clear_hub_feature(struct usb_device *hdev, int feature)
419 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
420 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
424 * USB 2.0 spec Section 11.24.2.2
426 int usb_clear_port_feature(struct usb_device *hdev, int port1, int feature)
428 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
429 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
434 * USB 2.0 spec Section 11.24.2.13
436 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
438 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
439 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
443 static char *to_led_name(int selector)
460 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
461 * for info about using port indicators
463 static void set_port_led(struct usb_hub *hub, int port1, int selector)
465 struct usb_port *port_dev = hub->ports[port1 - 1];
468 status = set_port_feature(hub->hdev, (selector << 8) | port1,
469 USB_PORT_FEAT_INDICATOR);
470 dev_dbg(&port_dev->dev, "indicator %s status %d\n",
471 to_led_name(selector), status);
474 #define LED_CYCLE_PERIOD ((2*HZ)/3)
476 static void led_work(struct work_struct *work)
478 struct usb_hub *hub =
479 container_of(work, struct usb_hub, leds.work);
480 struct usb_device *hdev = hub->hdev;
482 unsigned changed = 0;
485 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
488 for (i = 0; i < hdev->maxchild; i++) {
489 unsigned selector, mode;
491 /* 30%-50% duty cycle */
493 switch (hub->indicator[i]) {
495 case INDICATOR_CYCLE:
497 selector = HUB_LED_AUTO;
498 mode = INDICATOR_AUTO;
500 /* blinking green = sw attention */
501 case INDICATOR_GREEN_BLINK:
502 selector = HUB_LED_GREEN;
503 mode = INDICATOR_GREEN_BLINK_OFF;
505 case INDICATOR_GREEN_BLINK_OFF:
506 selector = HUB_LED_OFF;
507 mode = INDICATOR_GREEN_BLINK;
509 /* blinking amber = hw attention */
510 case INDICATOR_AMBER_BLINK:
511 selector = HUB_LED_AMBER;
512 mode = INDICATOR_AMBER_BLINK_OFF;
514 case INDICATOR_AMBER_BLINK_OFF:
515 selector = HUB_LED_OFF;
516 mode = INDICATOR_AMBER_BLINK;
518 /* blink green/amber = reserved */
519 case INDICATOR_ALT_BLINK:
520 selector = HUB_LED_GREEN;
521 mode = INDICATOR_ALT_BLINK_OFF;
523 case INDICATOR_ALT_BLINK_OFF:
524 selector = HUB_LED_AMBER;
525 mode = INDICATOR_ALT_BLINK;
530 if (selector != HUB_LED_AUTO)
532 set_port_led(hub, i + 1, selector);
533 hub->indicator[i] = mode;
535 if (!changed && blinkenlights) {
537 cursor %= hdev->maxchild;
538 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
539 hub->indicator[cursor] = INDICATOR_CYCLE;
543 queue_delayed_work(system_power_efficient_wq,
544 &hub->leds, LED_CYCLE_PERIOD);
547 /* use a short timeout for hub/port status fetches */
548 #define USB_STS_TIMEOUT 1000
549 #define USB_STS_RETRIES 5
552 * USB 2.0 spec Section 11.24.2.6
554 static int get_hub_status(struct usb_device *hdev,
555 struct usb_hub_status *data)
557 int i, status = -ETIMEDOUT;
559 for (i = 0; i < USB_STS_RETRIES &&
560 (status == -ETIMEDOUT || status == -EPIPE); i++) {
561 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
562 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
563 data, sizeof(*data), USB_STS_TIMEOUT);
569 * USB 2.0 spec Section 11.24.2.7
570 * USB 3.1 takes into use the wValue and wLength fields, spec Section 10.16.2.6
572 static int get_port_status(struct usb_device *hdev, int port1,
573 void *data, u16 value, u16 length)
575 int i, status = -ETIMEDOUT;
577 for (i = 0; i < USB_STS_RETRIES &&
578 (status == -ETIMEDOUT || status == -EPIPE); i++) {
579 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
580 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, value,
581 port1, data, length, USB_STS_TIMEOUT);
586 static int hub_ext_port_status(struct usb_hub *hub, int port1, int type,
587 u16 *status, u16 *change, u32 *ext_status)
592 if (type != HUB_PORT_STATUS)
595 mutex_lock(&hub->status_mutex);
596 ret = get_port_status(hub->hdev, port1, &hub->status->port, type, len);
599 dev_err(hub->intfdev,
600 "%s failed (err = %d)\n", __func__, ret);
604 *status = le16_to_cpu(hub->status->port.wPortStatus);
605 *change = le16_to_cpu(hub->status->port.wPortChange);
606 if (type != HUB_PORT_STATUS && ext_status)
607 *ext_status = le32_to_cpu(
608 hub->status->port.dwExtPortStatus);
611 mutex_unlock(&hub->status_mutex);
615 static int hub_port_status(struct usb_hub *hub, int port1,
616 u16 *status, u16 *change)
618 return hub_ext_port_status(hub, port1, HUB_PORT_STATUS,
619 status, change, NULL);
622 static void hub_resubmit_irq_urb(struct usb_hub *hub)
627 spin_lock_irqsave(&hub->irq_urb_lock, flags);
629 if (hub->quiescing) {
630 spin_unlock_irqrestore(&hub->irq_urb_lock, flags);
634 status = usb_submit_urb(hub->urb, GFP_ATOMIC);
635 if (status && status != -ENODEV && status != -EPERM &&
636 status != -ESHUTDOWN) {
637 dev_err(hub->intfdev, "resubmit --> %d\n", status);
638 mod_timer(&hub->irq_urb_retry, jiffies + HZ);
641 spin_unlock_irqrestore(&hub->irq_urb_lock, flags);
644 static void hub_retry_irq_urb(struct timer_list *t)
646 struct usb_hub *hub = from_timer(hub, t, irq_urb_retry);
648 hub_resubmit_irq_urb(hub);
652 static void kick_hub_wq(struct usb_hub *hub)
654 struct usb_interface *intf;
656 if (hub->disconnected || work_pending(&hub->events))
660 * Suppress autosuspend until the event is proceed.
662 * Be careful and make sure that the symmetric operation is
663 * always called. We are here only when there is no pending
664 * work for this hub. Therefore put the interface either when
665 * the new work is called or when it is canceled.
667 intf = to_usb_interface(hub->intfdev);
668 usb_autopm_get_interface_no_resume(intf);
669 kref_get(&hub->kref);
671 if (queue_work(hub_wq, &hub->events))
674 /* the work has already been scheduled */
675 usb_autopm_put_interface_async(intf);
676 kref_put(&hub->kref, hub_release);
679 void usb_kick_hub_wq(struct usb_device *hdev)
681 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
688 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
689 * Notification, which indicates it had initiated remote wakeup.
691 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
692 * device initiates resume, so the USB core will not receive notice of the
693 * resume through the normal hub interrupt URB.
695 void usb_wakeup_notification(struct usb_device *hdev,
696 unsigned int portnum)
699 struct usb_port *port_dev;
704 hub = usb_hub_to_struct_hub(hdev);
706 port_dev = hub->ports[portnum - 1];
707 if (port_dev && port_dev->child)
708 pm_wakeup_event(&port_dev->child->dev, 0);
710 set_bit(portnum, hub->wakeup_bits);
714 EXPORT_SYMBOL_GPL(usb_wakeup_notification);
716 /* completion function, fires on port status changes and various faults */
717 static void hub_irq(struct urb *urb)
719 struct usb_hub *hub = urb->context;
720 int status = urb->status;
725 case -ENOENT: /* synchronous unlink */
726 case -ECONNRESET: /* async unlink */
727 case -ESHUTDOWN: /* hardware going away */
730 default: /* presumably an error */
731 /* Cause a hub reset after 10 consecutive errors */
732 dev_dbg(hub->intfdev, "transfer --> %d\n", status);
733 if ((++hub->nerrors < 10) || hub->error)
738 /* let hub_wq handle things */
739 case 0: /* we got data: port status changed */
741 for (i = 0; i < urb->actual_length; ++i)
742 bits |= ((unsigned long) ((*hub->buffer)[i]))
744 hub->event_bits[0] = bits;
750 /* Something happened, let hub_wq figure it out */
754 hub_resubmit_irq_urb(hub);
757 /* USB 2.0 spec Section 11.24.2.3 */
759 hub_clear_tt_buffer(struct usb_device *hdev, u16 devinfo, u16 tt)
761 /* Need to clear both directions for control ep */
762 if (((devinfo >> 11) & USB_ENDPOINT_XFERTYPE_MASK) ==
763 USB_ENDPOINT_XFER_CONTROL) {
764 int status = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
765 HUB_CLEAR_TT_BUFFER, USB_RT_PORT,
766 devinfo ^ 0x8000, tt, NULL, 0, 1000);
770 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
771 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
776 * enumeration blocks hub_wq for a long time. we use keventd instead, since
777 * long blocking there is the exception, not the rule. accordingly, HCDs
778 * talking to TTs must queue control transfers (not just bulk and iso), so
779 * both can talk to the same hub concurrently.
781 static void hub_tt_work(struct work_struct *work)
783 struct usb_hub *hub =
784 container_of(work, struct usb_hub, tt.clear_work);
787 spin_lock_irqsave(&hub->tt.lock, flags);
788 while (!list_empty(&hub->tt.clear_list)) {
789 struct list_head *next;
790 struct usb_tt_clear *clear;
791 struct usb_device *hdev = hub->hdev;
792 const struct hc_driver *drv;
795 next = hub->tt.clear_list.next;
796 clear = list_entry(next, struct usb_tt_clear, clear_list);
797 list_del(&clear->clear_list);
799 /* drop lock so HCD can concurrently report other TT errors */
800 spin_unlock_irqrestore(&hub->tt.lock, flags);
801 status = hub_clear_tt_buffer(hdev, clear->devinfo, clear->tt);
802 if (status && status != -ENODEV)
804 "clear tt %d (%04x) error %d\n",
805 clear->tt, clear->devinfo, status);
807 /* Tell the HCD, even if the operation failed */
808 drv = clear->hcd->driver;
809 if (drv->clear_tt_buffer_complete)
810 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
813 spin_lock_irqsave(&hub->tt.lock, flags);
815 spin_unlock_irqrestore(&hub->tt.lock, flags);
819 * usb_hub_set_port_power - control hub port's power state
820 * @hdev: USB device belonging to the usb hub
823 * @set: expected status
825 * call this function to control port's power via setting or
826 * clearing the port's PORT_POWER feature.
828 * Return: 0 if successful. A negative error code otherwise.
830 int usb_hub_set_port_power(struct usb_device *hdev, struct usb_hub *hub,
836 ret = set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
838 ret = usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
844 set_bit(port1, hub->power_bits);
846 clear_bit(port1, hub->power_bits);
851 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
852 * @urb: an URB associated with the failed or incomplete split transaction
854 * High speed HCDs use this to tell the hub driver that some split control or
855 * bulk transaction failed in a way that requires clearing internal state of
856 * a transaction translator. This is normally detected (and reported) from
859 * It may not be possible for that hub to handle additional full (or low)
860 * speed transactions until that state is fully cleared out.
862 * Return: 0 if successful. A negative error code otherwise.
864 int usb_hub_clear_tt_buffer(struct urb *urb)
866 struct usb_device *udev = urb->dev;
867 int pipe = urb->pipe;
868 struct usb_tt *tt = udev->tt;
870 struct usb_tt_clear *clear;
872 /* we've got to cope with an arbitrary number of pending TT clears,
873 * since each TT has "at least two" buffers that can need it (and
874 * there can be many TTs per hub). even if they're uncommon.
876 clear = kmalloc(sizeof *clear, GFP_ATOMIC);
878 dev_err(&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
879 /* FIXME recover somehow ... RESET_TT? */
883 /* info that CLEAR_TT_BUFFER needs */
884 clear->tt = tt->multi ? udev->ttport : 1;
885 clear->devinfo = usb_pipeendpoint (pipe);
886 clear->devinfo |= ((u16)udev->devaddr) << 4;
887 clear->devinfo |= usb_pipecontrol(pipe)
888 ? (USB_ENDPOINT_XFER_CONTROL << 11)
889 : (USB_ENDPOINT_XFER_BULK << 11);
890 if (usb_pipein(pipe))
891 clear->devinfo |= 1 << 15;
893 /* info for completion callback */
894 clear->hcd = bus_to_hcd(udev->bus);
897 /* tell keventd to clear state for this TT */
898 spin_lock_irqsave(&tt->lock, flags);
899 list_add_tail(&clear->clear_list, &tt->clear_list);
900 schedule_work(&tt->clear_work);
901 spin_unlock_irqrestore(&tt->lock, flags);
904 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
906 static void hub_power_on(struct usb_hub *hub, bool do_delay)
910 /* Enable power on each port. Some hubs have reserved values
911 * of LPSM (> 2) in their descriptors, even though they are
912 * USB 2.0 hubs. Some hubs do not implement port-power switching
913 * but only emulate it. In all cases, the ports won't work
914 * unless we send these messages to the hub.
916 if (hub_is_port_power_switchable(hub))
917 dev_dbg(hub->intfdev, "enabling power on all ports\n");
919 dev_dbg(hub->intfdev, "trying to enable port power on "
920 "non-switchable hub\n");
921 for (port1 = 1; port1 <= hub->hdev->maxchild; port1++)
922 if (test_bit(port1, hub->power_bits))
923 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
925 usb_clear_port_feature(hub->hdev, port1,
926 USB_PORT_FEAT_POWER);
928 msleep(hub_power_on_good_delay(hub));
931 static int hub_hub_status(struct usb_hub *hub,
932 u16 *status, u16 *change)
936 mutex_lock(&hub->status_mutex);
937 ret = get_hub_status(hub->hdev, &hub->status->hub);
940 dev_err(hub->intfdev,
941 "%s failed (err = %d)\n", __func__, ret);
943 *status = le16_to_cpu(hub->status->hub.wHubStatus);
944 *change = le16_to_cpu(hub->status->hub.wHubChange);
947 mutex_unlock(&hub->status_mutex);
951 static int hub_set_port_link_state(struct usb_hub *hub, int port1,
952 unsigned int link_status)
954 return set_port_feature(hub->hdev,
955 port1 | (link_status << 3),
956 USB_PORT_FEAT_LINK_STATE);
960 * Disable a port and mark a logical connect-change event, so that some
961 * time later hub_wq will disconnect() any existing usb_device on the port
962 * and will re-enumerate if there actually is a device attached.
964 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
966 dev_dbg(&hub->ports[port1 - 1]->dev, "logical disconnect\n");
967 hub_port_disable(hub, port1, 1);
969 /* FIXME let caller ask to power down the port:
970 * - some devices won't enumerate without a VBUS power cycle
971 * - SRP saves power that way
972 * - ... new call, TBD ...
973 * That's easy if this hub can switch power per-port, and
974 * hub_wq reactivates the port later (timer, SRP, etc).
975 * Powerdown must be optional, because of reset/DFU.
978 set_bit(port1, hub->change_bits);
983 * usb_remove_device - disable a device's port on its parent hub
984 * @udev: device to be disabled and removed
985 * Context: @udev locked, must be able to sleep.
987 * After @udev's port has been disabled, hub_wq is notified and it will
988 * see that the device has been disconnected. When the device is
989 * physically unplugged and something is plugged in, the events will
990 * be received and processed normally.
992 * Return: 0 if successful. A negative error code otherwise.
994 int usb_remove_device(struct usb_device *udev)
997 struct usb_interface *intf;
1000 if (!udev->parent) /* Can't remove a root hub */
1002 hub = usb_hub_to_struct_hub(udev->parent);
1003 intf = to_usb_interface(hub->intfdev);
1005 ret = usb_autopm_get_interface(intf);
1009 set_bit(udev->portnum, hub->removed_bits);
1010 hub_port_logical_disconnect(hub, udev->portnum);
1011 usb_autopm_put_interface(intf);
1015 enum hub_activation_type {
1016 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
1017 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
1020 static void hub_init_func2(struct work_struct *ws);
1021 static void hub_init_func3(struct work_struct *ws);
1023 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
1025 struct usb_device *hdev = hub->hdev;
1026 struct usb_hcd *hcd;
1030 bool need_debounce_delay = false;
1033 /* Continue a partial initialization */
1034 if (type == HUB_INIT2 || type == HUB_INIT3) {
1035 device_lock(&hdev->dev);
1037 /* Was the hub disconnected while we were waiting? */
1038 if (hub->disconnected)
1040 if (type == HUB_INIT2)
1044 kref_get(&hub->kref);
1046 /* The superspeed hub except for root hub has to use Hub Depth
1047 * value as an offset into the route string to locate the bits
1048 * it uses to determine the downstream port number. So hub driver
1049 * should send a set hub depth request to superspeed hub after
1050 * the superspeed hub is set configuration in initialization or
1053 * After a resume, port power should still be on.
1054 * For any other type of activation, turn it on.
1056 if (type != HUB_RESUME) {
1057 if (hdev->parent && hub_is_superspeed(hdev)) {
1058 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
1059 HUB_SET_DEPTH, USB_RT_HUB,
1060 hdev->level - 1, 0, NULL, 0,
1061 USB_CTRL_SET_TIMEOUT);
1063 dev_err(hub->intfdev,
1064 "set hub depth failed\n");
1067 /* Speed up system boot by using a delayed_work for the
1068 * hub's initial power-up delays. This is pretty awkward
1069 * and the implementation looks like a home-brewed sort of
1070 * setjmp/longjmp, but it saves at least 100 ms for each
1071 * root hub (assuming usbcore is compiled into the kernel
1072 * rather than as a module). It adds up.
1074 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1075 * because for those activation types the ports have to be
1076 * operational when we return. In theory this could be done
1077 * for HUB_POST_RESET, but it's easier not to.
1079 if (type == HUB_INIT) {
1080 delay = hub_power_on_good_delay(hub);
1082 hub_power_on(hub, false);
1083 INIT_DELAYED_WORK(&hub->init_work, hub_init_func2);
1084 queue_delayed_work(system_power_efficient_wq,
1086 msecs_to_jiffies(delay));
1088 /* Suppress autosuspend until init is done */
1089 usb_autopm_get_interface_no_resume(
1090 to_usb_interface(hub->intfdev));
1091 return; /* Continues at init2: below */
1092 } else if (type == HUB_RESET_RESUME) {
1093 /* The internal host controller state for the hub device
1094 * may be gone after a host power loss on system resume.
1095 * Update the device's info so the HW knows it's a hub.
1097 hcd = bus_to_hcd(hdev->bus);
1098 if (hcd->driver->update_hub_device) {
1099 ret = hcd->driver->update_hub_device(hcd, hdev,
1100 &hub->tt, GFP_NOIO);
1102 dev_err(hub->intfdev,
1103 "Host not accepting hub info update\n");
1104 dev_err(hub->intfdev,
1105 "LS/FS devices and hubs may not work under this hub\n");
1108 hub_power_on(hub, true);
1110 hub_power_on(hub, true);
1112 /* Give some time on remote wakeup to let links to transit to U0 */
1113 } else if (hub_is_superspeed(hub->hdev))
1119 * Check each port and set hub->change_bits to let hub_wq know
1120 * which ports need attention.
1122 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
1123 struct usb_port *port_dev = hub->ports[port1 - 1];
1124 struct usb_device *udev = port_dev->child;
1125 u16 portstatus, portchange;
1127 portstatus = portchange = 0;
1128 status = hub_port_status(hub, port1, &portstatus, &portchange);
1132 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1133 dev_dbg(&port_dev->dev, "status %04x change %04x\n",
1134 portstatus, portchange);
1137 * After anything other than HUB_RESUME (i.e., initialization
1138 * or any sort of reset), every port should be disabled.
1139 * Unconnected ports should likewise be disabled (paranoia),
1140 * and so should ports for which we have no usb_device.
1142 if ((portstatus & USB_PORT_STAT_ENABLE) && (
1143 type != HUB_RESUME ||
1144 !(portstatus & USB_PORT_STAT_CONNECTION) ||
1146 udev->state == USB_STATE_NOTATTACHED)) {
1148 * USB3 protocol ports will automatically transition
1149 * to Enabled state when detect an USB3.0 device attach.
1150 * Do not disable USB3 protocol ports, just pretend
1153 portstatus &= ~USB_PORT_STAT_ENABLE;
1154 if (!hub_is_superspeed(hdev))
1155 usb_clear_port_feature(hdev, port1,
1156 USB_PORT_FEAT_ENABLE);
1159 /* Make sure a warm-reset request is handled by port_event */
1160 if (type == HUB_RESUME &&
1161 hub_port_warm_reset_required(hub, port1, portstatus))
1162 set_bit(port1, hub->event_bits);
1165 * Add debounce if USB3 link is in polling/link training state.
1166 * Link will automatically transition to Enabled state after
1167 * link training completes.
1169 if (hub_is_superspeed(hdev) &&
1170 ((portstatus & USB_PORT_STAT_LINK_STATE) ==
1171 USB_SS_PORT_LS_POLLING))
1172 need_debounce_delay = true;
1174 /* Clear status-change flags; we'll debounce later */
1175 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1176 need_debounce_delay = true;
1177 usb_clear_port_feature(hub->hdev, port1,
1178 USB_PORT_FEAT_C_CONNECTION);
1180 if (portchange & USB_PORT_STAT_C_ENABLE) {
1181 need_debounce_delay = true;
1182 usb_clear_port_feature(hub->hdev, port1,
1183 USB_PORT_FEAT_C_ENABLE);
1185 if (portchange & USB_PORT_STAT_C_RESET) {
1186 need_debounce_delay = true;
1187 usb_clear_port_feature(hub->hdev, port1,
1188 USB_PORT_FEAT_C_RESET);
1190 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
1191 hub_is_superspeed(hub->hdev)) {
1192 need_debounce_delay = true;
1193 usb_clear_port_feature(hub->hdev, port1,
1194 USB_PORT_FEAT_C_BH_PORT_RESET);
1196 /* We can forget about a "removed" device when there's a
1197 * physical disconnect or the connect status changes.
1199 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
1200 (portchange & USB_PORT_STAT_C_CONNECTION))
1201 clear_bit(port1, hub->removed_bits);
1203 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
1204 /* Tell hub_wq to disconnect the device or
1205 * check for a new connection or over current condition.
1206 * Based on USB2.0 Spec Section 11.12.5,
1207 * C_PORT_OVER_CURRENT could be set while
1208 * PORT_OVER_CURRENT is not. So check for any of them.
1210 if (udev || (portstatus & USB_PORT_STAT_CONNECTION) ||
1211 (portchange & USB_PORT_STAT_C_CONNECTION) ||
1212 (portstatus & USB_PORT_STAT_OVERCURRENT) ||
1213 (portchange & USB_PORT_STAT_C_OVERCURRENT))
1214 set_bit(port1, hub->change_bits);
1216 } else if (portstatus & USB_PORT_STAT_ENABLE) {
1217 bool port_resumed = (portstatus &
1218 USB_PORT_STAT_LINK_STATE) ==
1220 /* The power session apparently survived the resume.
1221 * If there was an overcurrent or suspend change
1222 * (i.e., remote wakeup request), have hub_wq
1223 * take care of it. Look at the port link state
1224 * for USB 3.0 hubs, since they don't have a suspend
1225 * change bit, and they don't set the port link change
1226 * bit on device-initiated resume.
1228 if (portchange || (hub_is_superspeed(hub->hdev) &&
1230 set_bit(port1, hub->event_bits);
1232 } else if (udev->persist_enabled) {
1234 udev->reset_resume = 1;
1236 /* Don't set the change_bits when the device
1239 if (test_bit(port1, hub->power_bits))
1240 set_bit(port1, hub->change_bits);
1243 /* The power session is gone; tell hub_wq */
1244 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1245 set_bit(port1, hub->change_bits);
1249 /* If no port-status-change flags were set, we don't need any
1250 * debouncing. If flags were set we can try to debounce the
1251 * ports all at once right now, instead of letting hub_wq do them
1252 * one at a time later on.
1254 * If any port-status changes do occur during this delay, hub_wq
1255 * will see them later and handle them normally.
1257 if (need_debounce_delay) {
1258 delay = HUB_DEBOUNCE_STABLE;
1260 /* Don't do a long sleep inside a workqueue routine */
1261 if (type == HUB_INIT2) {
1262 INIT_DELAYED_WORK(&hub->init_work, hub_init_func3);
1263 queue_delayed_work(system_power_efficient_wq,
1265 msecs_to_jiffies(delay));
1266 device_unlock(&hdev->dev);
1267 return; /* Continues at init3: below */
1275 status = usb_submit_urb(hub->urb, GFP_NOIO);
1277 dev_err(hub->intfdev, "activate --> %d\n", status);
1278 if (hub->has_indicators && blinkenlights)
1279 queue_delayed_work(system_power_efficient_wq,
1280 &hub->leds, LED_CYCLE_PERIOD);
1282 /* Scan all ports that need attention */
1285 if (type == HUB_INIT2 || type == HUB_INIT3) {
1286 /* Allow autosuspend if it was suppressed */
1288 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
1289 device_unlock(&hdev->dev);
1292 kref_put(&hub->kref, hub_release);
1295 /* Implement the continuations for the delays above */
1296 static void hub_init_func2(struct work_struct *ws)
1298 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1300 hub_activate(hub, HUB_INIT2);
1303 static void hub_init_func3(struct work_struct *ws)
1305 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1307 hub_activate(hub, HUB_INIT3);
1310 enum hub_quiescing_type {
1311 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
1314 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
1316 struct usb_device *hdev = hub->hdev;
1317 unsigned long flags;
1320 /* hub_wq and related activity won't re-trigger */
1321 spin_lock_irqsave(&hub->irq_urb_lock, flags);
1323 spin_unlock_irqrestore(&hub->irq_urb_lock, flags);
1325 if (type != HUB_SUSPEND) {
1326 /* Disconnect all the children */
1327 for (i = 0; i < hdev->maxchild; ++i) {
1328 if (hub->ports[i]->child)
1329 usb_disconnect(&hub->ports[i]->child);
1333 /* Stop hub_wq and related activity */
1334 del_timer_sync(&hub->irq_urb_retry);
1335 usb_kill_urb(hub->urb);
1336 if (hub->has_indicators)
1337 cancel_delayed_work_sync(&hub->leds);
1339 flush_work(&hub->tt.clear_work);
1342 static void hub_pm_barrier_for_all_ports(struct usb_hub *hub)
1346 for (i = 0; i < hub->hdev->maxchild; ++i)
1347 pm_runtime_barrier(&hub->ports[i]->dev);
1350 /* caller has locked the hub device */
1351 static int hub_pre_reset(struct usb_interface *intf)
1353 struct usb_hub *hub = usb_get_intfdata(intf);
1355 hub_quiesce(hub, HUB_PRE_RESET);
1357 hub_pm_barrier_for_all_ports(hub);
1361 /* caller has locked the hub device */
1362 static int hub_post_reset(struct usb_interface *intf)
1364 struct usb_hub *hub = usb_get_intfdata(intf);
1367 hub_pm_barrier_for_all_ports(hub);
1368 hub_activate(hub, HUB_POST_RESET);
1372 static int hub_configure(struct usb_hub *hub,
1373 struct usb_endpoint_descriptor *endpoint)
1375 struct usb_hcd *hcd;
1376 struct usb_device *hdev = hub->hdev;
1377 struct device *hub_dev = hub->intfdev;
1378 u16 hubstatus, hubchange;
1379 u16 wHubCharacteristics;
1382 char *message = "out of memory";
1387 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
1393 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1398 mutex_init(&hub->status_mutex);
1400 hub->descriptor = kzalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1401 if (!hub->descriptor) {
1406 /* Request the entire hub descriptor.
1407 * hub->descriptor can handle USB_MAXCHILDREN ports,
1408 * but a (non-SS) hub can/will return fewer bytes here.
1410 ret = get_hub_descriptor(hdev, hub->descriptor);
1412 message = "can't read hub descriptor";
1416 maxchild = USB_MAXCHILDREN;
1417 if (hub_is_superspeed(hdev))
1418 maxchild = min_t(unsigned, maxchild, USB_SS_MAXPORTS);
1420 if (hub->descriptor->bNbrPorts > maxchild) {
1421 message = "hub has too many ports!";
1424 } else if (hub->descriptor->bNbrPorts == 0) {
1425 message = "hub doesn't have any ports!";
1431 * Accumulate wHubDelay + 40ns for every hub in the tree of devices.
1432 * The resulting value will be used for SetIsochDelay() request.
1434 if (hub_is_superspeed(hdev) || hub_is_superspeedplus(hdev)) {
1435 u32 delay = __le16_to_cpu(hub->descriptor->u.ss.wHubDelay);
1438 delay += hdev->parent->hub_delay;
1440 delay += USB_TP_TRANSMISSION_DELAY;
1441 hdev->hub_delay = min_t(u32, delay, USB_TP_TRANSMISSION_DELAY_MAX);
1444 maxchild = hub->descriptor->bNbrPorts;
1445 dev_info(hub_dev, "%d port%s detected\n", maxchild,
1446 (maxchild == 1) ? "" : "s");
1448 hub->ports = kcalloc(maxchild, sizeof(struct usb_port *), GFP_KERNEL);
1454 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1455 if (hub_is_superspeed(hdev)) {
1463 /* FIXME for USB 3.0, skip for now */
1464 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1465 !(hub_is_superspeed(hdev))) {
1466 char portstr[USB_MAXCHILDREN + 1];
1468 for (i = 0; i < maxchild; i++)
1469 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1470 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1472 portstr[maxchild] = 0;
1473 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1475 dev_dbg(hub_dev, "standalone hub\n");
1477 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1478 case HUB_CHAR_COMMON_LPSM:
1479 dev_dbg(hub_dev, "ganged power switching\n");
1481 case HUB_CHAR_INDV_PORT_LPSM:
1482 dev_dbg(hub_dev, "individual port power switching\n");
1484 case HUB_CHAR_NO_LPSM:
1486 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1490 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1491 case HUB_CHAR_COMMON_OCPM:
1492 dev_dbg(hub_dev, "global over-current protection\n");
1494 case HUB_CHAR_INDV_PORT_OCPM:
1495 dev_dbg(hub_dev, "individual port over-current protection\n");
1497 case HUB_CHAR_NO_OCPM:
1499 dev_dbg(hub_dev, "no over-current protection\n");
1503 spin_lock_init(&hub->tt.lock);
1504 INIT_LIST_HEAD(&hub->tt.clear_list);
1505 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1506 switch (hdev->descriptor.bDeviceProtocol) {
1509 case USB_HUB_PR_HS_SINGLE_TT:
1510 dev_dbg(hub_dev, "Single TT\n");
1513 case USB_HUB_PR_HS_MULTI_TT:
1514 ret = usb_set_interface(hdev, 0, 1);
1516 dev_dbg(hub_dev, "TT per port\n");
1519 dev_err(hub_dev, "Using single TT (err %d)\n",
1524 /* USB 3.0 hubs don't have a TT */
1527 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1528 hdev->descriptor.bDeviceProtocol);
1532 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1533 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1534 case HUB_TTTT_8_BITS:
1535 if (hdev->descriptor.bDeviceProtocol != 0) {
1536 hub->tt.think_time = 666;
1537 dev_dbg(hub_dev, "TT requires at most %d "
1538 "FS bit times (%d ns)\n",
1539 8, hub->tt.think_time);
1542 case HUB_TTTT_16_BITS:
1543 hub->tt.think_time = 666 * 2;
1544 dev_dbg(hub_dev, "TT requires at most %d "
1545 "FS bit times (%d ns)\n",
1546 16, hub->tt.think_time);
1548 case HUB_TTTT_24_BITS:
1549 hub->tt.think_time = 666 * 3;
1550 dev_dbg(hub_dev, "TT requires at most %d "
1551 "FS bit times (%d ns)\n",
1552 24, hub->tt.think_time);
1554 case HUB_TTTT_32_BITS:
1555 hub->tt.think_time = 666 * 4;
1556 dev_dbg(hub_dev, "TT requires at most %d "
1557 "FS bit times (%d ns)\n",
1558 32, hub->tt.think_time);
1562 /* probe() zeroes hub->indicator[] */
1563 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1564 hub->has_indicators = 1;
1565 dev_dbg(hub_dev, "Port indicators are supported\n");
1568 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1569 hub->descriptor->bPwrOn2PwrGood * 2);
1571 /* power budgeting mostly matters with bus-powered hubs,
1572 * and battery-powered root hubs (may provide just 8 mA).
1574 ret = usb_get_std_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1576 message = "can't get hub status";
1579 hcd = bus_to_hcd(hdev->bus);
1580 if (hdev == hdev->bus->root_hub) {
1581 if (hcd->power_budget > 0)
1582 hdev->bus_mA = hcd->power_budget;
1584 hdev->bus_mA = full_load * maxchild;
1585 if (hdev->bus_mA >= full_load)
1586 hub->mA_per_port = full_load;
1588 hub->mA_per_port = hdev->bus_mA;
1589 hub->limited_power = 1;
1591 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1592 int remaining = hdev->bus_mA -
1593 hub->descriptor->bHubContrCurrent;
1595 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1596 hub->descriptor->bHubContrCurrent);
1597 hub->limited_power = 1;
1599 if (remaining < maxchild * unit_load)
1601 "insufficient power available "
1602 "to use all downstream ports\n");
1603 hub->mA_per_port = unit_load; /* 7.2.1 */
1605 } else { /* Self-powered external hub */
1606 /* FIXME: What about battery-powered external hubs that
1607 * provide less current per port? */
1608 hub->mA_per_port = full_load;
1610 if (hub->mA_per_port < full_load)
1611 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1614 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1616 message = "can't get hub status";
1620 /* local power status reports aren't always correct */
1621 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1622 dev_dbg(hub_dev, "local power source is %s\n",
1623 (hubstatus & HUB_STATUS_LOCAL_POWER)
1624 ? "lost (inactive)" : "good");
1626 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1627 dev_dbg(hub_dev, "%sover-current condition exists\n",
1628 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1630 /* set up the interrupt endpoint
1631 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1632 * bytes as USB2.0[11.12.3] says because some hubs are known
1633 * to send more data (and thus cause overflow). For root hubs,
1634 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1635 * to be big enough for at least USB_MAXCHILDREN ports. */
1636 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1637 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1639 if (maxp > sizeof(*hub->buffer))
1640 maxp = sizeof(*hub->buffer);
1642 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1648 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1649 hub, endpoint->bInterval);
1651 /* maybe cycle the hub leds */
1652 if (hub->has_indicators && blinkenlights)
1653 hub->indicator[0] = INDICATOR_CYCLE;
1655 mutex_lock(&usb_port_peer_mutex);
1656 for (i = 0; i < maxchild; i++) {
1657 ret = usb_hub_create_port_device(hub, i + 1);
1659 dev_err(hub->intfdev,
1660 "couldn't create port%d device.\n", i + 1);
1665 for (i = 0; i < hdev->maxchild; i++) {
1666 struct usb_port *port_dev = hub->ports[i];
1668 pm_runtime_put(&port_dev->dev);
1671 mutex_unlock(&usb_port_peer_mutex);
1675 /* Update the HCD's internal representation of this hub before hub_wq
1676 * starts getting port status changes for devices under the hub.
1678 if (hcd->driver->update_hub_device) {
1679 ret = hcd->driver->update_hub_device(hcd, hdev,
1680 &hub->tt, GFP_KERNEL);
1682 message = "can't update HCD hub info";
1687 usb_hub_adjust_deviceremovable(hdev, hub->descriptor);
1689 hub_activate(hub, HUB_INIT);
1693 dev_err(hub_dev, "config failed, %s (err %d)\n",
1695 /* hub_disconnect() frees urb and descriptor */
1699 static void hub_release(struct kref *kref)
1701 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1703 usb_put_dev(hub->hdev);
1704 usb_put_intf(to_usb_interface(hub->intfdev));
1708 static unsigned highspeed_hubs;
1710 static void hub_disconnect(struct usb_interface *intf)
1712 struct usb_hub *hub = usb_get_intfdata(intf);
1713 struct usb_device *hdev = interface_to_usbdev(intf);
1717 * Stop adding new hub events. We do not want to block here and thus
1718 * will not try to remove any pending work item.
1720 hub->disconnected = 1;
1722 /* Disconnect all children and quiesce the hub */
1724 hub_quiesce(hub, HUB_DISCONNECT);
1726 mutex_lock(&usb_port_peer_mutex);
1728 /* Avoid races with recursively_mark_NOTATTACHED() */
1729 spin_lock_irq(&device_state_lock);
1730 port1 = hdev->maxchild;
1732 usb_set_intfdata(intf, NULL);
1733 spin_unlock_irq(&device_state_lock);
1735 for (; port1 > 0; --port1)
1736 usb_hub_remove_port_device(hub, port1);
1738 mutex_unlock(&usb_port_peer_mutex);
1740 if (hub->hdev->speed == USB_SPEED_HIGH)
1743 usb_free_urb(hub->urb);
1745 kfree(hub->descriptor);
1749 pm_suspend_ignore_children(&intf->dev, false);
1751 if (hub->quirk_disable_autosuspend)
1752 usb_autopm_put_interface(intf);
1754 kref_put(&hub->kref, hub_release);
1757 static bool hub_descriptor_is_sane(struct usb_host_interface *desc)
1759 /* Some hubs have a subclass of 1, which AFAICT according to the */
1760 /* specs is not defined, but it works */
1761 if (desc->desc.bInterfaceSubClass != 0 &&
1762 desc->desc.bInterfaceSubClass != 1)
1765 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1766 if (desc->desc.bNumEndpoints != 1)
1769 /* If the first endpoint is not interrupt IN, we'd better punt! */
1770 if (!usb_endpoint_is_int_in(&desc->endpoint[0].desc))
1776 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1778 struct usb_host_interface *desc;
1779 struct usb_device *hdev;
1780 struct usb_hub *hub;
1782 desc = intf->cur_altsetting;
1783 hdev = interface_to_usbdev(intf);
1786 * Set default autosuspend delay as 0 to speedup bus suspend,
1787 * based on the below considerations:
1789 * - Unlike other drivers, the hub driver does not rely on the
1790 * autosuspend delay to provide enough time to handle a wakeup
1791 * event, and the submitted status URB is just to check future
1792 * change on hub downstream ports, so it is safe to do it.
1794 * - The patch might cause one or more auto supend/resume for
1795 * below very rare devices when they are plugged into hub
1798 * devices having trouble initializing, and disconnect
1799 * themselves from the bus and then reconnect a second
1802 * devices just for downloading firmware, and disconnects
1803 * themselves after completing it
1805 * For these quite rare devices, their drivers may change the
1806 * autosuspend delay of their parent hub in the probe() to one
1807 * appropriate value to avoid the subtle problem if someone
1810 * - The patch may cause one or more auto suspend/resume on
1811 * hub during running 'lsusb', but it is probably too
1812 * infrequent to worry about.
1814 * - Change autosuspend delay of hub can avoid unnecessary auto
1815 * suspend timer for hub, also may decrease power consumption
1818 * - If user has indicated to prevent autosuspend by passing
1819 * usbcore.autosuspend = -1 then keep autosuspend disabled.
1822 if (hdev->dev.power.autosuspend_delay >= 0)
1823 pm_runtime_set_autosuspend_delay(&hdev->dev, 0);
1827 * Hubs have proper suspend/resume support, except for root hubs
1828 * where the controller driver doesn't have bus_suspend and
1829 * bus_resume methods.
1831 if (hdev->parent) { /* normal device */
1832 usb_enable_autosuspend(hdev);
1833 } else { /* root hub */
1834 const struct hc_driver *drv = bus_to_hcd(hdev->bus)->driver;
1836 if (drv->bus_suspend && drv->bus_resume)
1837 usb_enable_autosuspend(hdev);
1840 if (hdev->level == MAX_TOPO_LEVEL) {
1842 "Unsupported bus topology: hub nested too deep\n");
1846 #ifdef CONFIG_USB_OTG_DISABLE_EXTERNAL_HUB
1848 dev_warn(&intf->dev, "ignoring external hub\n");
1853 if (!hub_descriptor_is_sane(desc)) {
1854 dev_err(&intf->dev, "bad descriptor, ignoring hub\n");
1858 /* We found a hub */
1859 dev_info(&intf->dev, "USB hub found\n");
1861 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1865 kref_init(&hub->kref);
1866 hub->intfdev = &intf->dev;
1868 INIT_DELAYED_WORK(&hub->leds, led_work);
1869 INIT_DELAYED_WORK(&hub->init_work, NULL);
1870 INIT_WORK(&hub->events, hub_event);
1871 spin_lock_init(&hub->irq_urb_lock);
1872 timer_setup(&hub->irq_urb_retry, hub_retry_irq_urb, 0);
1876 usb_set_intfdata(intf, hub);
1877 intf->needs_remote_wakeup = 1;
1878 pm_suspend_ignore_children(&intf->dev, true);
1880 if (hdev->speed == USB_SPEED_HIGH)
1883 if (id->driver_info & HUB_QUIRK_CHECK_PORT_AUTOSUSPEND)
1884 hub->quirk_check_port_auto_suspend = 1;
1886 if (id->driver_info & HUB_QUIRK_DISABLE_AUTOSUSPEND) {
1887 hub->quirk_disable_autosuspend = 1;
1888 usb_autopm_get_interface_no_resume(intf);
1891 if (hub_configure(hub, &desc->endpoint[0].desc) >= 0)
1894 hub_disconnect(intf);
1899 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1901 struct usb_device *hdev = interface_to_usbdev(intf);
1902 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1904 /* assert ifno == 0 (part of hub spec) */
1906 case USBDEVFS_HUB_PORTINFO: {
1907 struct usbdevfs_hub_portinfo *info = user_data;
1910 spin_lock_irq(&device_state_lock);
1911 if (hdev->devnum <= 0)
1914 info->nports = hdev->maxchild;
1915 for (i = 0; i < info->nports; i++) {
1916 if (hub->ports[i]->child == NULL)
1920 hub->ports[i]->child->devnum;
1923 spin_unlock_irq(&device_state_lock);
1925 return info->nports + 1;
1934 * Allow user programs to claim ports on a hub. When a device is attached
1935 * to one of these "claimed" ports, the program will "own" the device.
1937 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1938 struct usb_dev_state ***ppowner)
1940 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1942 if (hdev->state == USB_STATE_NOTATTACHED)
1944 if (port1 == 0 || port1 > hdev->maxchild)
1947 /* Devices not managed by the hub driver
1948 * will always have maxchild equal to 0.
1950 *ppowner = &(hub->ports[port1 - 1]->port_owner);
1954 /* In the following three functions, the caller must hold hdev's lock */
1955 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
1956 struct usb_dev_state *owner)
1959 struct usb_dev_state **powner;
1961 rc = find_port_owner(hdev, port1, &powner);
1969 EXPORT_SYMBOL_GPL(usb_hub_claim_port);
1971 int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
1972 struct usb_dev_state *owner)
1975 struct usb_dev_state **powner;
1977 rc = find_port_owner(hdev, port1, &powner);
1980 if (*powner != owner)
1985 EXPORT_SYMBOL_GPL(usb_hub_release_port);
1987 void usb_hub_release_all_ports(struct usb_device *hdev, struct usb_dev_state *owner)
1989 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1992 for (n = 0; n < hdev->maxchild; n++) {
1993 if (hub->ports[n]->port_owner == owner)
1994 hub->ports[n]->port_owner = NULL;
1999 /* The caller must hold udev's lock */
2000 bool usb_device_is_owned(struct usb_device *udev)
2002 struct usb_hub *hub;
2004 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
2006 hub = usb_hub_to_struct_hub(udev->parent);
2007 return !!hub->ports[udev->portnum - 1]->port_owner;
2010 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
2012 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2015 for (i = 0; i < udev->maxchild; ++i) {
2016 if (hub->ports[i]->child)
2017 recursively_mark_NOTATTACHED(hub->ports[i]->child);
2019 if (udev->state == USB_STATE_SUSPENDED)
2020 udev->active_duration -= jiffies;
2021 udev->state = USB_STATE_NOTATTACHED;
2025 * usb_set_device_state - change a device's current state (usbcore, hcds)
2026 * @udev: pointer to device whose state should be changed
2027 * @new_state: new state value to be stored
2029 * udev->state is _not_ fully protected by the device lock. Although
2030 * most transitions are made only while holding the lock, the state can
2031 * can change to USB_STATE_NOTATTACHED at almost any time. This
2032 * is so that devices can be marked as disconnected as soon as possible,
2033 * without having to wait for any semaphores to be released. As a result,
2034 * all changes to any device's state must be protected by the
2035 * device_state_lock spinlock.
2037 * Once a device has been added to the device tree, all changes to its state
2038 * should be made using this routine. The state should _not_ be set directly.
2040 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
2041 * Otherwise udev->state is set to new_state, and if new_state is
2042 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
2043 * to USB_STATE_NOTATTACHED.
2045 void usb_set_device_state(struct usb_device *udev,
2046 enum usb_device_state new_state)
2048 unsigned long flags;
2051 spin_lock_irqsave(&device_state_lock, flags);
2052 if (udev->state == USB_STATE_NOTATTACHED)
2054 else if (new_state != USB_STATE_NOTATTACHED) {
2056 /* root hub wakeup capabilities are managed out-of-band
2057 * and may involve silicon errata ... ignore them here.
2060 if (udev->state == USB_STATE_SUSPENDED
2061 || new_state == USB_STATE_SUSPENDED)
2062 ; /* No change to wakeup settings */
2063 else if (new_state == USB_STATE_CONFIGURED)
2064 wakeup = (udev->quirks &
2065 USB_QUIRK_IGNORE_REMOTE_WAKEUP) ? 0 :
2066 udev->actconfig->desc.bmAttributes &
2067 USB_CONFIG_ATT_WAKEUP;
2071 if (udev->state == USB_STATE_SUSPENDED &&
2072 new_state != USB_STATE_SUSPENDED)
2073 udev->active_duration -= jiffies;
2074 else if (new_state == USB_STATE_SUSPENDED &&
2075 udev->state != USB_STATE_SUSPENDED)
2076 udev->active_duration += jiffies;
2077 udev->state = new_state;
2079 recursively_mark_NOTATTACHED(udev);
2080 spin_unlock_irqrestore(&device_state_lock, flags);
2082 device_set_wakeup_capable(&udev->dev, wakeup);
2084 EXPORT_SYMBOL_GPL(usb_set_device_state);
2087 * Choose a device number.
2089 * Device numbers are used as filenames in usbfs. On USB-1.1 and
2090 * USB-2.0 buses they are also used as device addresses, however on
2091 * USB-3.0 buses the address is assigned by the controller hardware
2092 * and it usually is not the same as the device number.
2094 * WUSB devices are simple: they have no hubs behind, so the mapping
2095 * device <-> virtual port number becomes 1:1. Why? to simplify the
2096 * life of the device connection logic in
2097 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
2098 * handshake we need to assign a temporary address in the unauthorized
2099 * space. For simplicity we use the first virtual port number found to
2100 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
2101 * and that becomes it's address [X < 128] or its unauthorized address
2104 * We add 1 as an offset to the one-based USB-stack port number
2105 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
2106 * 0 is reserved by USB for default address; (b) Linux's USB stack
2107 * uses always #1 for the root hub of the controller. So USB stack's
2108 * port #1, which is wusb virtual-port #0 has address #2.
2110 * Devices connected under xHCI are not as simple. The host controller
2111 * supports virtualization, so the hardware assigns device addresses and
2112 * the HCD must setup data structures before issuing a set address
2113 * command to the hardware.
2115 static void choose_devnum(struct usb_device *udev)
2118 struct usb_bus *bus = udev->bus;
2120 /* be safe when more hub events are proceed in parallel */
2121 mutex_lock(&bus->devnum_next_mutex);
2123 devnum = udev->portnum + 1;
2124 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
2126 /* Try to allocate the next devnum beginning at
2127 * bus->devnum_next. */
2128 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
2131 devnum = find_next_zero_bit(bus->devmap.devicemap,
2133 bus->devnum_next = (devnum >= 127 ? 1 : devnum + 1);
2136 set_bit(devnum, bus->devmap.devicemap);
2137 udev->devnum = devnum;
2139 mutex_unlock(&bus->devnum_next_mutex);
2142 static void release_devnum(struct usb_device *udev)
2144 if (udev->devnum > 0) {
2145 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
2150 static void update_devnum(struct usb_device *udev, int devnum)
2152 /* The address for a WUSB device is managed by wusbcore. */
2154 udev->devnum = devnum;
2156 udev->devaddr = (u8)devnum;
2159 static void hub_free_dev(struct usb_device *udev)
2161 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2163 /* Root hubs aren't real devices, so don't free HCD resources */
2164 if (hcd->driver->free_dev && udev->parent)
2165 hcd->driver->free_dev(hcd, udev);
2168 static void hub_disconnect_children(struct usb_device *udev)
2170 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2173 /* Free up all the children before we remove this device */
2174 for (i = 0; i < udev->maxchild; i++) {
2175 if (hub->ports[i]->child)
2176 usb_disconnect(&hub->ports[i]->child);
2181 * usb_disconnect - disconnect a device (usbcore-internal)
2182 * @pdev: pointer to device being disconnected
2183 * Context: !in_interrupt ()
2185 * Something got disconnected. Get rid of it and all of its children.
2187 * If *pdev is a normal device then the parent hub must already be locked.
2188 * If *pdev is a root hub then the caller must hold the usb_bus_idr_lock,
2189 * which protects the set of root hubs as well as the list of buses.
2191 * Only hub drivers (including virtual root hub drivers for host
2192 * controllers) should ever call this.
2194 * This call is synchronous, and may not be used in an interrupt context.
2196 void usb_disconnect(struct usb_device **pdev)
2198 struct usb_port *port_dev = NULL;
2199 struct usb_device *udev = *pdev;
2200 struct usb_hub *hub = NULL;
2203 /* mark the device as inactive, so any further urb submissions for
2204 * this device (and any of its children) will fail immediately.
2205 * this quiesces everything except pending urbs.
2207 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2208 dev_info(&udev->dev, "USB disconnect, device number %d\n",
2212 * Ensure that the pm runtime code knows that the USB device
2213 * is in the process of being disconnected.
2215 pm_runtime_barrier(&udev->dev);
2217 usb_lock_device(udev);
2219 hub_disconnect_children(udev);
2221 /* deallocate hcd/hardware state ... nuking all pending urbs and
2222 * cleaning up all state associated with the current configuration
2223 * so that the hardware is now fully quiesced.
2225 dev_dbg(&udev->dev, "unregistering device\n");
2226 usb_disable_device(udev, 0);
2227 usb_hcd_synchronize_unlinks(udev);
2230 port1 = udev->portnum;
2231 hub = usb_hub_to_struct_hub(udev->parent);
2232 port_dev = hub->ports[port1 - 1];
2234 sysfs_remove_link(&udev->dev.kobj, "port");
2235 sysfs_remove_link(&port_dev->dev.kobj, "device");
2238 * As usb_port_runtime_resume() de-references udev, make
2239 * sure no resumes occur during removal
2241 if (!test_and_set_bit(port1, hub->child_usage_bits))
2242 pm_runtime_get_sync(&port_dev->dev);
2245 usb_remove_ep_devs(&udev->ep0);
2246 usb_unlock_device(udev);
2248 /* Unregister the device. The device driver is responsible
2249 * for de-configuring the device and invoking the remove-device
2250 * notifier chain (used by usbfs and possibly others).
2252 device_del(&udev->dev);
2254 /* Free the device number and delete the parent's children[]
2255 * (or root_hub) pointer.
2257 release_devnum(udev);
2259 /* Avoid races with recursively_mark_NOTATTACHED() */
2260 spin_lock_irq(&device_state_lock);
2262 spin_unlock_irq(&device_state_lock);
2264 if (port_dev && test_and_clear_bit(port1, hub->child_usage_bits))
2265 pm_runtime_put(&port_dev->dev);
2269 put_device(&udev->dev);
2272 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2273 static void show_string(struct usb_device *udev, char *id, char *string)
2277 dev_info(&udev->dev, "%s: %s\n", id, string);
2280 static void announce_device(struct usb_device *udev)
2282 u16 bcdDevice = le16_to_cpu(udev->descriptor.bcdDevice);
2284 dev_info(&udev->dev,
2285 "New USB device found, idVendor=%04x, idProduct=%04x, bcdDevice=%2x.%02x\n",
2286 le16_to_cpu(udev->descriptor.idVendor),
2287 le16_to_cpu(udev->descriptor.idProduct),
2288 bcdDevice >> 8, bcdDevice & 0xff);
2289 dev_info(&udev->dev,
2290 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2291 udev->descriptor.iManufacturer,
2292 udev->descriptor.iProduct,
2293 udev->descriptor.iSerialNumber);
2294 show_string(udev, "Product", udev->product);
2295 show_string(udev, "Manufacturer", udev->manufacturer);
2296 show_string(udev, "SerialNumber", udev->serial);
2299 static inline void announce_device(struct usb_device *udev) { }
2304 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2305 * @udev: newly addressed device (in ADDRESS state)
2307 * Finish enumeration for On-The-Go devices
2309 * Return: 0 if successful. A negative error code otherwise.
2311 static int usb_enumerate_device_otg(struct usb_device *udev)
2315 #ifdef CONFIG_USB_OTG
2317 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2318 * to wake us after we've powered off VBUS; and HNP, switching roles
2319 * "host" to "peripheral". The OTG descriptor helps figure this out.
2321 if (!udev->bus->is_b_host
2323 && udev->parent == udev->bus->root_hub) {
2324 struct usb_otg_descriptor *desc = NULL;
2325 struct usb_bus *bus = udev->bus;
2326 unsigned port1 = udev->portnum;
2328 /* descriptor may appear anywhere in config */
2329 err = __usb_get_extra_descriptor(udev->rawdescriptors[0],
2330 le16_to_cpu(udev->config[0].desc.wTotalLength),
2331 USB_DT_OTG, (void **) &desc, sizeof(*desc));
2332 if (err || !(desc->bmAttributes & USB_OTG_HNP))
2335 dev_info(&udev->dev, "Dual-Role OTG device on %sHNP port\n",
2336 (port1 == bus->otg_port) ? "" : "non-");
2338 /* enable HNP before suspend, it's simpler */
2339 if (port1 == bus->otg_port) {
2340 bus->b_hnp_enable = 1;
2341 err = usb_control_msg(udev,
2342 usb_sndctrlpipe(udev, 0),
2343 USB_REQ_SET_FEATURE, 0,
2344 USB_DEVICE_B_HNP_ENABLE,
2346 USB_CTRL_SET_TIMEOUT);
2349 * OTG MESSAGE: report errors here,
2350 * customize to match your product.
2352 dev_err(&udev->dev, "can't set HNP mode: %d\n",
2354 bus->b_hnp_enable = 0;
2356 } else if (desc->bLength == sizeof
2357 (struct usb_otg_descriptor)) {
2358 /* Set a_alt_hnp_support for legacy otg device */
2359 err = usb_control_msg(udev,
2360 usb_sndctrlpipe(udev, 0),
2361 USB_REQ_SET_FEATURE, 0,
2362 USB_DEVICE_A_ALT_HNP_SUPPORT,
2364 USB_CTRL_SET_TIMEOUT);
2367 "set a_alt_hnp_support failed: %d\n",
2377 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2378 * @udev: newly addressed device (in ADDRESS state)
2380 * This is only called by usb_new_device() and usb_authorize_device()
2381 * and FIXME -- all comments that apply to them apply here wrt to
2384 * If the device is WUSB and not authorized, we don't attempt to read
2385 * the string descriptors, as they will be errored out by the device
2386 * until it has been authorized.
2388 * Return: 0 if successful. A negative error code otherwise.
2390 static int usb_enumerate_device(struct usb_device *udev)
2393 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2395 if (udev->config == NULL) {
2396 err = usb_get_configuration(udev);
2399 dev_err(&udev->dev, "can't read configurations, error %d\n",
2405 /* read the standard strings and cache them if present */
2406 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
2407 udev->manufacturer = usb_cache_string(udev,
2408 udev->descriptor.iManufacturer);
2409 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
2411 err = usb_enumerate_device_otg(udev);
2415 if (IS_ENABLED(CONFIG_USB_OTG_PRODUCTLIST) && hcd->tpl_support &&
2416 !is_targeted(udev)) {
2417 /* Maybe it can talk to us, though we can't talk to it.
2418 * (Includes HNP test device.)
2420 if (IS_ENABLED(CONFIG_USB_OTG) && (udev->bus->b_hnp_enable
2421 || udev->bus->is_b_host)) {
2422 err = usb_port_suspend(udev, PMSG_AUTO_SUSPEND);
2424 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
2429 usb_detect_interface_quirks(udev);
2434 static void set_usb_port_removable(struct usb_device *udev)
2436 struct usb_device *hdev = udev->parent;
2437 struct usb_hub *hub;
2438 u8 port = udev->portnum;
2439 u16 wHubCharacteristics;
2440 bool removable = true;
2445 hub = usb_hub_to_struct_hub(udev->parent);
2448 * If the platform firmware has provided information about a port,
2449 * use that to determine whether it's removable.
2451 switch (hub->ports[udev->portnum - 1]->connect_type) {
2452 case USB_PORT_CONNECT_TYPE_HOT_PLUG:
2453 udev->removable = USB_DEVICE_REMOVABLE;
2455 case USB_PORT_CONNECT_TYPE_HARD_WIRED:
2456 case USB_PORT_NOT_USED:
2457 udev->removable = USB_DEVICE_FIXED;
2464 * Otherwise, check whether the hub knows whether a port is removable
2467 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2469 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
2472 if (hub_is_superspeed(hdev)) {
2473 if (le16_to_cpu(hub->descriptor->u.ss.DeviceRemovable)
2477 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
2482 udev->removable = USB_DEVICE_REMOVABLE;
2484 udev->removable = USB_DEVICE_FIXED;
2489 * usb_new_device - perform initial device setup (usbcore-internal)
2490 * @udev: newly addressed device (in ADDRESS state)
2492 * This is called with devices which have been detected but not fully
2493 * enumerated. The device descriptor is available, but not descriptors
2494 * for any device configuration. The caller must have locked either
2495 * the parent hub (if udev is a normal device) or else the
2496 * usb_bus_idr_lock (if udev is a root hub). The parent's pointer to
2497 * udev has already been installed, but udev is not yet visible through
2498 * sysfs or other filesystem code.
2500 * This call is synchronous, and may not be used in an interrupt context.
2502 * Only the hub driver or root-hub registrar should ever call this.
2504 * Return: Whether the device is configured properly or not. Zero if the
2505 * interface was registered with the driver core; else a negative errno
2509 int usb_new_device(struct usb_device *udev)
2514 /* Initialize non-root-hub device wakeup to disabled;
2515 * device (un)configuration controls wakeup capable
2516 * sysfs power/wakeup controls wakeup enabled/disabled
2518 device_init_wakeup(&udev->dev, 0);
2521 /* Tell the runtime-PM framework the device is active */
2522 pm_runtime_set_active(&udev->dev);
2523 pm_runtime_get_noresume(&udev->dev);
2524 pm_runtime_use_autosuspend(&udev->dev);
2525 pm_runtime_enable(&udev->dev);
2527 /* By default, forbid autosuspend for all devices. It will be
2528 * allowed for hubs during binding.
2530 usb_disable_autosuspend(udev);
2532 err = usb_enumerate_device(udev); /* Read descriptors */
2535 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
2536 udev->devnum, udev->bus->busnum,
2537 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2538 /* export the usbdev device-node for libusb */
2539 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
2540 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2542 /* Tell the world! */
2543 announce_device(udev);
2546 add_device_randomness(udev->serial, strlen(udev->serial));
2548 add_device_randomness(udev->product, strlen(udev->product));
2549 if (udev->manufacturer)
2550 add_device_randomness(udev->manufacturer,
2551 strlen(udev->manufacturer));
2553 device_enable_async_suspend(&udev->dev);
2555 /* check whether the hub or firmware marks this port as non-removable */
2557 set_usb_port_removable(udev);
2559 /* Register the device. The device driver is responsible
2560 * for configuring the device and invoking the add-device
2561 * notifier chain (used by usbfs and possibly others).
2563 err = device_add(&udev->dev);
2565 dev_err(&udev->dev, "can't device_add, error %d\n", err);
2569 /* Create link files between child device and usb port device. */
2571 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2572 int port1 = udev->portnum;
2573 struct usb_port *port_dev = hub->ports[port1 - 1];
2575 err = sysfs_create_link(&udev->dev.kobj,
2576 &port_dev->dev.kobj, "port");
2580 err = sysfs_create_link(&port_dev->dev.kobj,
2581 &udev->dev.kobj, "device");
2583 sysfs_remove_link(&udev->dev.kobj, "port");
2587 if (!test_and_set_bit(port1, hub->child_usage_bits))
2588 pm_runtime_get_sync(&port_dev->dev);
2591 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
2592 usb_mark_last_busy(udev);
2593 pm_runtime_put_sync_autosuspend(&udev->dev);
2597 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2598 pm_runtime_disable(&udev->dev);
2599 pm_runtime_set_suspended(&udev->dev);
2605 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2606 * @usb_dev: USB device
2608 * Move the USB device to a very basic state where interfaces are disabled
2609 * and the device is in fact unconfigured and unusable.
2611 * We share a lock (that we have) with device_del(), so we need to
2616 int usb_deauthorize_device(struct usb_device *usb_dev)
2618 usb_lock_device(usb_dev);
2619 if (usb_dev->authorized == 0)
2620 goto out_unauthorized;
2622 usb_dev->authorized = 0;
2623 usb_set_configuration(usb_dev, -1);
2626 usb_unlock_device(usb_dev);
2631 int usb_authorize_device(struct usb_device *usb_dev)
2635 usb_lock_device(usb_dev);
2636 if (usb_dev->authorized == 1)
2637 goto out_authorized;
2639 result = usb_autoresume_device(usb_dev);
2641 dev_err(&usb_dev->dev,
2642 "can't autoresume for authorization: %d\n", result);
2643 goto error_autoresume;
2646 if (usb_dev->wusb) {
2647 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2649 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2650 "authorization: %d\n", result);
2651 goto error_device_descriptor;
2655 usb_dev->authorized = 1;
2656 /* Choose and set the configuration. This registers the interfaces
2657 * with the driver core and lets interface drivers bind to them.
2659 c = usb_choose_configuration(usb_dev);
2661 result = usb_set_configuration(usb_dev, c);
2663 dev_err(&usb_dev->dev,
2664 "can't set config #%d, error %d\n", c, result);
2665 /* This need not be fatal. The user can try to
2666 * set other configurations. */
2669 dev_info(&usb_dev->dev, "authorized to connect\n");
2671 error_device_descriptor:
2672 usb_autosuspend_device(usb_dev);
2675 usb_unlock_device(usb_dev); /* complements locktree */
2680 * Return 1 if port speed is SuperSpeedPlus, 0 otherwise
2681 * check it from the link protocol field of the current speed ID attribute.
2682 * current speed ID is got from ext port status request. Sublink speed attribute
2683 * table is returned with the hub BOS SSP device capability descriptor
2685 static int port_speed_is_ssp(struct usb_device *hdev, int speed_id)
2690 struct usb_ssp_cap_descriptor *ssp_cap = hdev->bos->ssp_cap;
2695 ssa_count = le32_to_cpu(ssp_cap->bmAttributes) &
2696 USB_SSP_SUBLINK_SPEED_ATTRIBS;
2698 for (i = 0; i <= ssa_count; i++) {
2699 ss_attr = le32_to_cpu(ssp_cap->bmSublinkSpeedAttr[i]);
2700 if (speed_id == (ss_attr & USB_SSP_SUBLINK_SPEED_SSID))
2701 return !!(ss_attr & USB_SSP_SUBLINK_SPEED_LP);
2706 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2707 static unsigned hub_is_wusb(struct usb_hub *hub)
2709 struct usb_hcd *hcd;
2710 if (hub->hdev->parent != NULL) /* not a root hub? */
2712 hcd = bus_to_hcd(hub->hdev->bus);
2713 return hcd->wireless;
2717 #ifdef CONFIG_USB_FEW_INIT_RETRIES
2718 #define PORT_RESET_TRIES 2
2719 #define SET_ADDRESS_TRIES 1
2720 #define GET_DESCRIPTOR_TRIES 1
2721 #define GET_MAXPACKET0_TRIES 1
2722 #define PORT_INIT_TRIES 4
2725 #define PORT_RESET_TRIES 5
2726 #define SET_ADDRESS_TRIES 2
2727 #define GET_DESCRIPTOR_TRIES 2
2728 #define GET_MAXPACKET0_TRIES 3
2729 #define PORT_INIT_TRIES 4
2730 #endif /* CONFIG_USB_FEW_INIT_RETRIES */
2732 #define HUB_ROOT_RESET_TIME 60 /* times are in msec */
2733 #define HUB_SHORT_RESET_TIME 10
2734 #define HUB_BH_RESET_TIME 50
2735 #define HUB_LONG_RESET_TIME 200
2736 #define HUB_RESET_TIMEOUT 800
2738 static bool use_new_scheme(struct usb_device *udev, int retry,
2739 struct usb_port *port_dev)
2741 int old_scheme_first_port =
2742 (port_dev->quirks & USB_PORT_QUIRK_OLD_SCHEME) ||
2746 * "New scheme" enumeration causes an extra state transition to be
2747 * exposed to an xhci host and causes USB3 devices to receive control
2748 * commands in the default state. This has been seen to cause
2749 * enumeration failures, so disable this enumeration scheme for USB3
2752 if (udev->speed >= USB_SPEED_SUPER)
2756 * If use_both_schemes is set, use the first scheme (whichever
2757 * it is) for the larger half of the retries, then use the other
2758 * scheme. Otherwise, use the first scheme for all the retries.
2760 if (use_both_schemes && retry >= (PORT_INIT_TRIES + 1) / 2)
2761 return old_scheme_first_port; /* Second half */
2762 return !old_scheme_first_port; /* First half or all */
2765 /* Is a USB 3.0 port in the Inactive or Compliance Mode state?
2766 * Port warm reset is required to recover
2768 static bool hub_port_warm_reset_required(struct usb_hub *hub, int port1,
2773 if (!hub_is_superspeed(hub->hdev))
2776 if (test_bit(port1, hub->warm_reset_bits))
2779 link_state = portstatus & USB_PORT_STAT_LINK_STATE;
2780 return link_state == USB_SS_PORT_LS_SS_INACTIVE
2781 || link_state == USB_SS_PORT_LS_COMP_MOD;
2784 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2785 struct usb_device *udev, unsigned int delay, bool warm)
2787 int delay_time, ret;
2790 u32 ext_portstatus = 0;
2792 for (delay_time = 0;
2793 delay_time < HUB_RESET_TIMEOUT;
2794 delay_time += delay) {
2795 /* wait to give the device a chance to reset */
2798 /* read and decode port status */
2799 if (hub_is_superspeedplus(hub->hdev))
2800 ret = hub_ext_port_status(hub, port1,
2801 HUB_EXT_PORT_STATUS,
2802 &portstatus, &portchange,
2805 ret = hub_port_status(hub, port1, &portstatus,
2811 * The port state is unknown until the reset completes.
2813 * On top of that, some chips may require additional time
2814 * to re-establish a connection after the reset is complete,
2815 * so also wait for the connection to be re-established.
2817 if (!(portstatus & USB_PORT_STAT_RESET) &&
2818 (portstatus & USB_PORT_STAT_CONNECTION))
2821 /* switch to the long delay after two short delay failures */
2822 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2823 delay = HUB_LONG_RESET_TIME;
2825 dev_dbg(&hub->ports[port1 - 1]->dev,
2826 "not %sreset yet, waiting %dms\n",
2827 warm ? "warm " : "", delay);
2830 if ((portstatus & USB_PORT_STAT_RESET))
2833 if (hub_port_warm_reset_required(hub, port1, portstatus))
2836 /* Device went away? */
2837 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2840 /* Retry if connect change is set but status is still connected.
2841 * A USB 3.0 connection may bounce if multiple warm resets were issued,
2842 * but the device may have successfully re-connected. Ignore it.
2844 if (!hub_is_superspeed(hub->hdev) &&
2845 (portchange & USB_PORT_STAT_C_CONNECTION)) {
2846 usb_clear_port_feature(hub->hdev, port1,
2847 USB_PORT_FEAT_C_CONNECTION);
2851 if (!(portstatus & USB_PORT_STAT_ENABLE))
2857 if (hub_is_superspeedplus(hub->hdev)) {
2858 /* extended portstatus Rx and Tx lane count are zero based */
2859 udev->rx_lanes = USB_EXT_PORT_RX_LANES(ext_portstatus) + 1;
2860 udev->tx_lanes = USB_EXT_PORT_TX_LANES(ext_portstatus) + 1;
2865 if (hub_is_wusb(hub))
2866 udev->speed = USB_SPEED_WIRELESS;
2867 else if (hub_is_superspeedplus(hub->hdev) &&
2868 port_speed_is_ssp(hub->hdev, ext_portstatus &
2869 USB_EXT_PORT_STAT_RX_SPEED_ID))
2870 udev->speed = USB_SPEED_SUPER_PLUS;
2871 else if (hub_is_superspeed(hub->hdev))
2872 udev->speed = USB_SPEED_SUPER;
2873 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2874 udev->speed = USB_SPEED_HIGH;
2875 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2876 udev->speed = USB_SPEED_LOW;
2878 udev->speed = USB_SPEED_FULL;
2882 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2883 static int hub_port_reset(struct usb_hub *hub, int port1,
2884 struct usb_device *udev, unsigned int delay, bool warm)
2887 u16 portchange, portstatus;
2888 struct usb_port *port_dev = hub->ports[port1 - 1];
2889 int reset_recovery_time;
2891 if (!hub_is_superspeed(hub->hdev)) {
2893 dev_err(hub->intfdev, "only USB3 hub support "
2897 /* Block EHCI CF initialization during the port reset.
2898 * Some companion controllers don't like it when they mix.
2900 down_read(&ehci_cf_port_reset_rwsem);
2903 * If the caller hasn't explicitly requested a warm reset,
2904 * double check and see if one is needed.
2906 if (hub_port_status(hub, port1, &portstatus, &portchange) == 0)
2907 if (hub_port_warm_reset_required(hub, port1,
2911 clear_bit(port1, hub->warm_reset_bits);
2913 /* Reset the port */
2914 for (i = 0; i < PORT_RESET_TRIES; i++) {
2915 status = set_port_feature(hub->hdev, port1, (warm ?
2916 USB_PORT_FEAT_BH_PORT_RESET :
2917 USB_PORT_FEAT_RESET));
2918 if (status == -ENODEV) {
2919 ; /* The hub is gone */
2920 } else if (status) {
2921 dev_err(&port_dev->dev,
2922 "cannot %sreset (err = %d)\n",
2923 warm ? "warm " : "", status);
2925 status = hub_port_wait_reset(hub, port1, udev, delay,
2927 if (status && status != -ENOTCONN && status != -ENODEV)
2928 dev_dbg(hub->intfdev,
2929 "port_wait_reset: err = %d\n",
2933 /* Check for disconnect or reset */
2934 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2935 usb_clear_port_feature(hub->hdev, port1,
2936 USB_PORT_FEAT_C_RESET);
2938 if (!hub_is_superspeed(hub->hdev))
2941 usb_clear_port_feature(hub->hdev, port1,
2942 USB_PORT_FEAT_C_BH_PORT_RESET);
2943 usb_clear_port_feature(hub->hdev, port1,
2944 USB_PORT_FEAT_C_PORT_LINK_STATE);
2947 usb_clear_port_feature(hub->hdev, port1,
2948 USB_PORT_FEAT_C_CONNECTION);
2951 * If a USB 3.0 device migrates from reset to an error
2952 * state, re-issue the warm reset.
2954 if (hub_port_status(hub, port1,
2955 &portstatus, &portchange) < 0)
2958 if (!hub_port_warm_reset_required(hub, port1,
2963 * If the port is in SS.Inactive or Compliance Mode, the
2964 * hot or warm reset failed. Try another warm reset.
2967 dev_dbg(&port_dev->dev,
2968 "hot reset failed, warm reset\n");
2973 dev_dbg(&port_dev->dev,
2974 "not enabled, trying %sreset again...\n",
2975 warm ? "warm " : "");
2976 delay = HUB_LONG_RESET_TIME;
2979 dev_err(&port_dev->dev, "Cannot enable. Maybe the USB cable is bad?\n");
2983 if (port_dev->quirks & USB_PORT_QUIRK_FAST_ENUM)
2984 usleep_range(10000, 12000);
2986 /* TRSTRCY = 10 ms; plus some extra */
2987 reset_recovery_time = 10 + 40;
2989 /* Hub needs extra delay after resetting its port. */
2990 if (hub->hdev->quirks & USB_QUIRK_HUB_SLOW_RESET)
2991 reset_recovery_time += 100;
2993 msleep(reset_recovery_time);
2997 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2999 update_devnum(udev, 0);
3000 /* The xHC may think the device is already reset,
3001 * so ignore the status.
3003 if (hcd->driver->reset_device)
3004 hcd->driver->reset_device(hcd, udev);
3006 usb_set_device_state(udev, USB_STATE_DEFAULT);
3010 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
3013 if (!hub_is_superspeed(hub->hdev))
3014 up_read(&ehci_cf_port_reset_rwsem);
3019 /* Check if a port is power on */
3020 static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
3024 if (hub_is_superspeed(hub->hdev)) {
3025 if (portstatus & USB_SS_PORT_STAT_POWER)
3028 if (portstatus & USB_PORT_STAT_POWER)
3035 static void usb_lock_port(struct usb_port *port_dev)
3036 __acquires(&port_dev->status_lock)
3038 mutex_lock(&port_dev->status_lock);
3039 __acquire(&port_dev->status_lock);
3042 static void usb_unlock_port(struct usb_port *port_dev)
3043 __releases(&port_dev->status_lock)
3045 mutex_unlock(&port_dev->status_lock);
3046 __release(&port_dev->status_lock);
3051 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
3052 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
3056 if (hub_is_superspeed(hub->hdev)) {
3057 if ((portstatus & USB_PORT_STAT_LINK_STATE)
3058 == USB_SS_PORT_LS_U3)
3061 if (portstatus & USB_PORT_STAT_SUSPEND)
3068 /* Determine whether the device on a port is ready for a normal resume,
3069 * is ready for a reset-resume, or should be disconnected.
3071 static int check_port_resume_type(struct usb_device *udev,
3072 struct usb_hub *hub, int port1,
3073 int status, u16 portchange, u16 portstatus)
3075 struct usb_port *port_dev = hub->ports[port1 - 1];
3079 /* Is a warm reset needed to recover the connection? */
3080 if (status == 0 && udev->reset_resume
3081 && hub_port_warm_reset_required(hub, port1, portstatus)) {
3084 /* Is the device still present? */
3085 else if (status || port_is_suspended(hub, portstatus) ||
3086 !port_is_power_on(hub, portstatus)) {
3089 } else if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
3091 usleep_range(200, 300);
3092 status = hub_port_status(hub, port1, &portstatus,
3099 /* Can't do a normal resume if the port isn't enabled,
3100 * so try a reset-resume instead.
3102 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
3103 if (udev->persist_enabled)
3104 udev->reset_resume = 1;
3110 dev_dbg(&port_dev->dev, "status %04x.%04x after resume, %d\n",
3111 portchange, portstatus, status);
3112 } else if (udev->reset_resume) {
3114 /* Late port handoff can set status-change bits */
3115 if (portchange & USB_PORT_STAT_C_CONNECTION)
3116 usb_clear_port_feature(hub->hdev, port1,
3117 USB_PORT_FEAT_C_CONNECTION);
3118 if (portchange & USB_PORT_STAT_C_ENABLE)
3119 usb_clear_port_feature(hub->hdev, port1,
3120 USB_PORT_FEAT_C_ENABLE);
3123 * Whatever made this reset-resume necessary may have
3124 * turned on the port1 bit in hub->change_bits. But after
3125 * a successful reset-resume we want the bit to be clear;
3126 * if it was on it would indicate that something happened
3127 * following the reset-resume.
3129 clear_bit(port1, hub->change_bits);
3135 int usb_disable_ltm(struct usb_device *udev)
3137 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3139 /* Check if the roothub and device supports LTM. */
3140 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
3141 !usb_device_supports_ltm(udev))
3144 /* Clear Feature LTM Enable can only be sent if the device is
3147 if (!udev->actconfig)
3150 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3151 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
3152 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
3153 USB_CTRL_SET_TIMEOUT);
3155 EXPORT_SYMBOL_GPL(usb_disable_ltm);
3157 void usb_enable_ltm(struct usb_device *udev)
3159 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3161 /* Check if the roothub and device supports LTM. */
3162 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
3163 !usb_device_supports_ltm(udev))
3166 /* Set Feature LTM Enable can only be sent if the device is
3169 if (!udev->actconfig)
3172 usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3173 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
3174 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
3175 USB_CTRL_SET_TIMEOUT);
3177 EXPORT_SYMBOL_GPL(usb_enable_ltm);
3180 * usb_enable_remote_wakeup - enable remote wakeup for a device
3181 * @udev: target device
3183 * For USB-2 devices: Set the device's remote wakeup feature.
3185 * For USB-3 devices: Assume there's only one function on the device and
3186 * enable remote wake for the first interface. FIXME if the interface
3187 * association descriptor shows there's more than one function.
3189 static int usb_enable_remote_wakeup(struct usb_device *udev)
3191 if (udev->speed < USB_SPEED_SUPER)
3192 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3193 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
3194 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
3195 USB_CTRL_SET_TIMEOUT);
3197 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3198 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
3199 USB_INTRF_FUNC_SUSPEND,
3200 USB_INTRF_FUNC_SUSPEND_RW |
3201 USB_INTRF_FUNC_SUSPEND_LP,
3202 NULL, 0, USB_CTRL_SET_TIMEOUT);
3206 * usb_disable_remote_wakeup - disable remote wakeup for a device
3207 * @udev: target device
3209 * For USB-2 devices: Clear the device's remote wakeup feature.
3211 * For USB-3 devices: Assume there's only one function on the device and
3212 * disable remote wake for the first interface. FIXME if the interface
3213 * association descriptor shows there's more than one function.
3215 static int usb_disable_remote_wakeup(struct usb_device *udev)
3217 if (udev->speed < USB_SPEED_SUPER)
3218 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3219 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
3220 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
3221 USB_CTRL_SET_TIMEOUT);
3223 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3224 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
3225 USB_INTRF_FUNC_SUSPEND, 0, NULL, 0,
3226 USB_CTRL_SET_TIMEOUT);
3229 /* Count of wakeup-enabled devices at or below udev */
3230 unsigned usb_wakeup_enabled_descendants(struct usb_device *udev)
3232 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
3234 return udev->do_remote_wakeup +
3235 (hub ? hub->wakeup_enabled_descendants : 0);
3237 EXPORT_SYMBOL_GPL(usb_wakeup_enabled_descendants);
3240 * usb_port_suspend - suspend a usb device's upstream port
3241 * @udev: device that's no longer in active use, not a root hub
3242 * Context: must be able to sleep; device not locked; pm locks held
3244 * Suspends a USB device that isn't in active use, conserving power.
3245 * Devices may wake out of a suspend, if anything important happens,
3246 * using the remote wakeup mechanism. They may also be taken out of
3247 * suspend by the host, using usb_port_resume(). It's also routine
3248 * to disconnect devices while they are suspended.
3250 * This only affects the USB hardware for a device; its interfaces
3251 * (and, for hubs, child devices) must already have been suspended.
3253 * Selective port suspend reduces power; most suspended devices draw
3254 * less than 500 uA. It's also used in OTG, along with remote wakeup.
3255 * All devices below the suspended port are also suspended.
3257 * Devices leave suspend state when the host wakes them up. Some devices
3258 * also support "remote wakeup", where the device can activate the USB
3259 * tree above them to deliver data, such as a keypress or packet. In
3260 * some cases, this wakes the USB host.
3262 * Suspending OTG devices may trigger HNP, if that's been enabled
3263 * between a pair of dual-role devices. That will change roles, such
3264 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
3266 * Devices on USB hub ports have only one "suspend" state, corresponding
3267 * to ACPI D2, "may cause the device to lose some context".
3268 * State transitions include:
3270 * - suspend, resume ... when the VBUS power link stays live
3271 * - suspend, disconnect ... VBUS lost
3273 * Once VBUS drop breaks the circuit, the port it's using has to go through
3274 * normal re-enumeration procedures, starting with enabling VBUS power.
3275 * Other than re-initializing the hub (plug/unplug, except for root hubs),
3276 * Linux (2.6) currently has NO mechanisms to initiate that: no hub_wq
3277 * timer, no SRP, no requests through sysfs.
3279 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
3280 * suspended until their bus goes into global suspend (i.e., the root
3281 * hub is suspended). Nevertheless, we change @udev->state to
3282 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
3283 * upstream port setting is stored in @udev->port_is_suspended.
3285 * Returns 0 on success, else negative errno.
3287 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
3289 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3290 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3291 int port1 = udev->portnum;
3293 bool really_suspend = true;
3295 usb_lock_port(port_dev);
3297 /* enable remote wakeup when appropriate; this lets the device
3298 * wake up the upstream hub (including maybe the root hub).
3300 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
3301 * we don't explicitly enable it here.
3303 if (udev->do_remote_wakeup) {
3304 status = usb_enable_remote_wakeup(udev);
3306 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
3308 /* bail if autosuspend is requested */
3309 if (PMSG_IS_AUTO(msg))
3314 /* disable USB2 hardware LPM */
3315 usb_disable_usb2_hardware_lpm(udev);
3317 if (usb_disable_ltm(udev)) {
3318 dev_err(&udev->dev, "Failed to disable LTM before suspend\n");
3320 if (PMSG_IS_AUTO(msg))
3325 if (hub_is_superspeed(hub->hdev))
3326 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U3);
3329 * For system suspend, we do not need to enable the suspend feature
3330 * on individual USB-2 ports. The devices will automatically go
3331 * into suspend a few ms after the root hub stops sending packets.
3332 * The USB 2.0 spec calls this "global suspend".
3334 * However, many USB hubs have a bug: They don't relay wakeup requests
3335 * from a downstream port if the port's suspend feature isn't on.
3336 * Therefore we will turn on the suspend feature if udev or any of its
3337 * descendants is enabled for remote wakeup.
3339 else if (PMSG_IS_AUTO(msg) || usb_wakeup_enabled_descendants(udev) > 0)
3340 status = set_port_feature(hub->hdev, port1,
3341 USB_PORT_FEAT_SUSPEND);
3343 really_suspend = false;
3347 dev_dbg(&port_dev->dev, "can't suspend, status %d\n", status);
3349 /* Try to enable USB3 LTM again */
3350 usb_enable_ltm(udev);
3352 /* Try to enable USB2 hardware LPM again */
3353 usb_enable_usb2_hardware_lpm(udev);
3355 if (udev->do_remote_wakeup)
3356 (void) usb_disable_remote_wakeup(udev);
3359 /* System sleep transitions should never fail */
3360 if (!PMSG_IS_AUTO(msg))
3363 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
3364 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
3365 udev->do_remote_wakeup);
3366 if (really_suspend) {
3367 udev->port_is_suspended = 1;
3369 /* device has up to 10 msec to fully suspend */
3372 usb_set_device_state(udev, USB_STATE_SUSPENDED);
3375 if (status == 0 && !udev->do_remote_wakeup && udev->persist_enabled
3376 && test_and_clear_bit(port1, hub->child_usage_bits))
3377 pm_runtime_put_sync(&port_dev->dev);
3379 usb_mark_last_busy(hub->hdev);
3381 usb_unlock_port(port_dev);
3386 * If the USB "suspend" state is in use (rather than "global suspend"),
3387 * many devices will be individually taken out of suspend state using
3388 * special "resume" signaling. This routine kicks in shortly after
3389 * hardware resume signaling is finished, either because of selective
3390 * resume (by host) or remote wakeup (by device) ... now see what changed
3391 * in the tree that's rooted at this device.
3393 * If @udev->reset_resume is set then the device is reset before the
3394 * status check is done.
3396 static int finish_port_resume(struct usb_device *udev)
3401 /* caller owns the udev device lock */
3402 dev_dbg(&udev->dev, "%s\n",
3403 udev->reset_resume ? "finish reset-resume" : "finish resume");
3405 /* usb ch9 identifies four variants of SUSPENDED, based on what
3406 * state the device resumes to. Linux currently won't see the
3407 * first two on the host side; they'd be inside hub_port_init()
3408 * during many timeouts, but hub_wq can't suspend until later.
3410 usb_set_device_state(udev, udev->actconfig
3411 ? USB_STATE_CONFIGURED
3412 : USB_STATE_ADDRESS);
3414 /* 10.5.4.5 says not to reset a suspended port if the attached
3415 * device is enabled for remote wakeup. Hence the reset
3416 * operation is carried out here, after the port has been
3419 if (udev->reset_resume) {
3421 * If the device morphs or switches modes when it is reset,
3422 * we don't want to perform a reset-resume. We'll fail the
3423 * resume, which will cause a logical disconnect, and then
3424 * the device will be rediscovered.
3427 if (udev->quirks & USB_QUIRK_RESET)
3430 status = usb_reset_and_verify_device(udev);
3433 /* 10.5.4.5 says be sure devices in the tree are still there.
3434 * For now let's assume the device didn't go crazy on resume,
3435 * and device drivers will know about any resume quirks.
3439 status = usb_get_std_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
3441 /* If a normal resume failed, try doing a reset-resume */
3442 if (status && !udev->reset_resume && udev->persist_enabled) {
3443 dev_dbg(&udev->dev, "retry with reset-resume\n");
3444 udev->reset_resume = 1;
3445 goto retry_reset_resume;
3450 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
3453 * There are a few quirky devices which violate the standard
3454 * by claiming to have remote wakeup enabled after a reset,
3455 * which crash if the feature is cleared, hence check for
3456 * udev->reset_resume
3458 } else if (udev->actconfig && !udev->reset_resume) {
3459 if (udev->speed < USB_SPEED_SUPER) {
3460 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
3461 status = usb_disable_remote_wakeup(udev);
3463 status = usb_get_std_status(udev, USB_RECIP_INTERFACE, 0,
3465 if (!status && devstatus & (USB_INTRF_STAT_FUNC_RW_CAP
3466 | USB_INTRF_STAT_FUNC_RW))
3467 status = usb_disable_remote_wakeup(udev);
3472 "disable remote wakeup, status %d\n",
3480 * There are some SS USB devices which take longer time for link training.
3481 * XHCI specs 4.19.4 says that when Link training is successful, port
3482 * sets CCS bit to 1. So if SW reads port status before successful link
3483 * training, then it will not find device to be present.
3484 * USB Analyzer log with such buggy devices show that in some cases
3485 * device switch on the RX termination after long delay of host enabling
3486 * the VBUS. In few other cases it has been seen that device fails to
3487 * negotiate link training in first attempt. It has been
3488 * reported till now that few devices take as long as 2000 ms to train
3489 * the link after host enabling its VBUS and termination. Following
3490 * routine implements a 2000 ms timeout for link training. If in a case
3491 * link trains before timeout, loop will exit earlier.
3493 * There are also some 2.0 hard drive based devices and 3.0 thumb
3494 * drives that, when plugged into a 2.0 only port, take a long
3495 * time to set CCS after VBUS enable.
3497 * FIXME: If a device was connected before suspend, but was removed
3498 * while system was asleep, then the loop in the following routine will
3499 * only exit at timeout.
3501 * This routine should only be called when persist is enabled.
3503 static int wait_for_connected(struct usb_device *udev,
3504 struct usb_hub *hub, int *port1,
3505 u16 *portchange, u16 *portstatus)
3507 int status = 0, delay_ms = 0;
3509 while (delay_ms < 2000) {
3510 if (status || *portstatus & USB_PORT_STAT_CONNECTION)
3512 if (!port_is_power_on(hub, *portstatus)) {
3518 status = hub_port_status(hub, *port1, portstatus, portchange);
3520 dev_dbg(&udev->dev, "Waited %dms for CONNECT\n", delay_ms);
3525 * usb_port_resume - re-activate a suspended usb device's upstream port
3526 * @udev: device to re-activate, not a root hub
3527 * Context: must be able to sleep; device not locked; pm locks held
3529 * This will re-activate the suspended device, increasing power usage
3530 * while letting drivers communicate again with its endpoints.
3531 * USB resume explicitly guarantees that the power session between
3532 * the host and the device is the same as it was when the device
3535 * If @udev->reset_resume is set then this routine won't check that the
3536 * port is still enabled. Furthermore, finish_port_resume() above will
3537 * reset @udev. The end result is that a broken power session can be
3538 * recovered and @udev will appear to persist across a loss of VBUS power.
3540 * For example, if a host controller doesn't maintain VBUS suspend current
3541 * during a system sleep or is reset when the system wakes up, all the USB
3542 * power sessions below it will be broken. This is especially troublesome
3543 * for mass-storage devices containing mounted filesystems, since the
3544 * device will appear to have disconnected and all the memory mappings
3545 * to it will be lost. Using the USB_PERSIST facility, the device can be
3546 * made to appear as if it had not disconnected.
3548 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3549 * every effort to insure that the same device is present after the
3550 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3551 * quite possible for a device to remain unaltered but its media to be
3552 * changed. If the user replaces a flash memory card while the system is
3553 * asleep, he will have only himself to blame when the filesystem on the
3554 * new card is corrupted and the system crashes.
3556 * Returns 0 on success, else negative errno.
3558 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
3560 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3561 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3562 int port1 = udev->portnum;
3564 u16 portchange, portstatus;
3566 if (!test_and_set_bit(port1, hub->child_usage_bits)) {
3567 status = pm_runtime_resume_and_get(&port_dev->dev);
3569 dev_dbg(&udev->dev, "can't resume usb port, status %d\n",
3575 usb_lock_port(port_dev);
3577 /* Skip the initial Clear-Suspend step for a remote wakeup */
3578 status = hub_port_status(hub, port1, &portstatus, &portchange);
3579 if (status == 0 && !port_is_suspended(hub, portstatus)) {
3580 if (portchange & USB_PORT_STAT_C_SUSPEND)
3581 pm_wakeup_event(&udev->dev, 0);
3582 goto SuspendCleared;
3585 /* see 7.1.7.7; affects power usage, but not budgeting */
3586 if (hub_is_superspeed(hub->hdev))
3587 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U0);
3589 status = usb_clear_port_feature(hub->hdev,
3590 port1, USB_PORT_FEAT_SUSPEND);
3592 dev_dbg(&port_dev->dev, "can't resume, status %d\n", status);
3594 /* drive resume for USB_RESUME_TIMEOUT msec */
3595 dev_dbg(&udev->dev, "usb %sresume\n",
3596 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
3597 msleep(USB_RESUME_TIMEOUT);
3599 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3600 * stop resume signaling. Then finish the resume
3603 status = hub_port_status(hub, port1, &portstatus, &portchange);
3608 udev->port_is_suspended = 0;
3609 if (hub_is_superspeed(hub->hdev)) {
3610 if (portchange & USB_PORT_STAT_C_LINK_STATE)
3611 usb_clear_port_feature(hub->hdev, port1,
3612 USB_PORT_FEAT_C_PORT_LINK_STATE);
3614 if (portchange & USB_PORT_STAT_C_SUSPEND)
3615 usb_clear_port_feature(hub->hdev, port1,
3616 USB_PORT_FEAT_C_SUSPEND);
3619 /* TRSMRCY = 10 msec */
3623 if (udev->persist_enabled)
3624 status = wait_for_connected(udev, hub, &port1, &portchange,
3627 status = check_port_resume_type(udev,
3628 hub, port1, status, portchange, portstatus);
3630 status = finish_port_resume(udev);
3632 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
3633 hub_port_logical_disconnect(hub, port1);
3635 /* Try to enable USB2 hardware LPM */
3636 usb_enable_usb2_hardware_lpm(udev);
3638 /* Try to enable USB3 LTM */
3639 usb_enable_ltm(udev);
3642 usb_unlock_port(port_dev);
3647 int usb_remote_wakeup(struct usb_device *udev)
3651 usb_lock_device(udev);
3652 if (udev->state == USB_STATE_SUSPENDED) {
3653 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
3654 status = usb_autoresume_device(udev);
3656 /* Let the drivers do their thing, then... */
3657 usb_autosuspend_device(udev);
3660 usb_unlock_device(udev);
3664 /* Returns 1 if there was a remote wakeup and a connect status change. */
3665 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
3666 u16 portstatus, u16 portchange)
3667 __must_hold(&port_dev->status_lock)
3669 struct usb_port *port_dev = hub->ports[port - 1];
3670 struct usb_device *hdev;
3671 struct usb_device *udev;
3672 int connect_change = 0;
3677 udev = port_dev->child;
3678 if (!hub_is_superspeed(hdev)) {
3679 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
3681 usb_clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
3683 link_state = portstatus & USB_PORT_STAT_LINK_STATE;
3684 if (!udev || udev->state != USB_STATE_SUSPENDED ||
3685 (link_state != USB_SS_PORT_LS_U0 &&
3686 link_state != USB_SS_PORT_LS_U1 &&
3687 link_state != USB_SS_PORT_LS_U2))
3692 /* TRSMRCY = 10 msec */
3695 usb_unlock_port(port_dev);
3696 ret = usb_remote_wakeup(udev);
3697 usb_lock_port(port_dev);
3702 hub_port_disable(hub, port, 1);
3704 dev_dbg(&port_dev->dev, "resume, status %d\n", ret);
3705 return connect_change;
3708 static int check_ports_changed(struct usb_hub *hub)
3712 for (port1 = 1; port1 <= hub->hdev->maxchild; ++port1) {
3713 u16 portstatus, portchange;
3716 status = hub_port_status(hub, port1, &portstatus, &portchange);
3717 if (!status && portchange)
3723 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
3725 struct usb_hub *hub = usb_get_intfdata(intf);
3726 struct usb_device *hdev = hub->hdev;
3730 * Warn if children aren't already suspended.
3731 * Also, add up the number of wakeup-enabled descendants.
3733 hub->wakeup_enabled_descendants = 0;
3734 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3735 struct usb_port *port_dev = hub->ports[port1 - 1];
3736 struct usb_device *udev = port_dev->child;
3738 if (udev && udev->can_submit) {
3739 dev_warn(&port_dev->dev, "device %s not suspended yet\n",
3740 dev_name(&udev->dev));
3741 if (PMSG_IS_AUTO(msg))
3745 hub->wakeup_enabled_descendants +=
3746 usb_wakeup_enabled_descendants(udev);
3749 if (hdev->do_remote_wakeup && hub->quirk_check_port_auto_suspend) {
3750 /* check if there are changes pending on hub ports */
3751 if (check_ports_changed(hub)) {
3752 if (PMSG_IS_AUTO(msg))
3754 pm_wakeup_event(&hdev->dev, 2000);
3758 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
3759 /* Enable hub to send remote wakeup for all ports. */
3760 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3761 set_port_feature(hdev,
3763 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
3764 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
3765 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
3766 USB_PORT_FEAT_REMOTE_WAKE_MASK);
3770 dev_dbg(&intf->dev, "%s\n", __func__);
3772 /* stop hub_wq and related activity */
3773 hub_quiesce(hub, HUB_SUSPEND);
3777 /* Report wakeup requests from the ports of a resuming root hub */
3778 static void report_wakeup_requests(struct usb_hub *hub)
3780 struct usb_device *hdev = hub->hdev;
3781 struct usb_device *udev;
3782 struct usb_hcd *hcd;
3783 unsigned long resuming_ports;
3787 return; /* Not a root hub */
3789 hcd = bus_to_hcd(hdev->bus);
3790 if (hcd->driver->get_resuming_ports) {
3793 * The get_resuming_ports() method returns a bitmap (origin 0)
3794 * of ports which have started wakeup signaling but have not
3795 * yet finished resuming. During system resume we will
3796 * resume all the enabled ports, regardless of any wakeup
3797 * signals, which means the wakeup requests would be lost.
3798 * To prevent this, report them to the PM core here.
3800 resuming_ports = hcd->driver->get_resuming_ports(hcd);
3801 for (i = 0; i < hdev->maxchild; ++i) {
3802 if (test_bit(i, &resuming_ports)) {
3803 udev = hub->ports[i]->child;
3805 pm_wakeup_event(&udev->dev, 0);
3811 static int hub_resume(struct usb_interface *intf)
3813 struct usb_hub *hub = usb_get_intfdata(intf);
3815 dev_dbg(&intf->dev, "%s\n", __func__);
3816 hub_activate(hub, HUB_RESUME);
3819 * This should be called only for system resume, not runtime resume.
3820 * We can't tell the difference here, so some wakeup requests will be
3821 * reported at the wrong time or more than once. This shouldn't
3822 * matter much, so long as they do get reported.
3824 report_wakeup_requests(hub);
3828 static int hub_reset_resume(struct usb_interface *intf)
3830 struct usb_hub *hub = usb_get_intfdata(intf);
3832 dev_dbg(&intf->dev, "%s\n", __func__);
3833 hub_activate(hub, HUB_RESET_RESUME);
3838 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3839 * @rhdev: struct usb_device for the root hub
3841 * The USB host controller driver calls this function when its root hub
3842 * is resumed and Vbus power has been interrupted or the controller
3843 * has been reset. The routine marks @rhdev as having lost power.
3844 * When the hub driver is resumed it will take notice and carry out
3845 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3846 * the others will be disconnected.
3848 void usb_root_hub_lost_power(struct usb_device *rhdev)
3850 dev_notice(&rhdev->dev, "root hub lost power or was reset\n");
3851 rhdev->reset_resume = 1;
3853 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
3855 static const char * const usb3_lpm_names[] = {
3863 * Send a Set SEL control transfer to the device, prior to enabling
3864 * device-initiated U1 or U2. This lets the device know the exit latencies from
3865 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3866 * packet from the host.
3868 * This function will fail if the SEL or PEL values for udev are greater than
3869 * the maximum allowed values for the link state to be enabled.
3871 static int usb_req_set_sel(struct usb_device *udev, enum usb3_link_state state)
3873 struct usb_set_sel_req *sel_values;
3874 unsigned long long u1_sel;
3875 unsigned long long u1_pel;
3876 unsigned long long u2_sel;
3877 unsigned long long u2_pel;
3880 if (udev->state != USB_STATE_CONFIGURED)
3883 /* Convert SEL and PEL stored in ns to us */
3884 u1_sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
3885 u1_pel = DIV_ROUND_UP(udev->u1_params.pel, 1000);
3886 u2_sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
3887 u2_pel = DIV_ROUND_UP(udev->u2_params.pel, 1000);
3890 * Make sure that the calculated SEL and PEL values for the link
3891 * state we're enabling aren't bigger than the max SEL/PEL
3892 * value that will fit in the SET SEL control transfer.
3893 * Otherwise the device would get an incorrect idea of the exit
3894 * latency for the link state, and could start a device-initiated
3895 * U1/U2 when the exit latencies are too high.
3897 if ((state == USB3_LPM_U1 &&
3898 (u1_sel > USB3_LPM_MAX_U1_SEL_PEL ||
3899 u1_pel > USB3_LPM_MAX_U1_SEL_PEL)) ||
3900 (state == USB3_LPM_U2 &&
3901 (u2_sel > USB3_LPM_MAX_U2_SEL_PEL ||
3902 u2_pel > USB3_LPM_MAX_U2_SEL_PEL))) {
3903 dev_dbg(&udev->dev, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3904 usb3_lpm_names[state], u1_sel, u1_pel);
3909 * If we're enabling device-initiated LPM for one link state,
3910 * but the other link state has a too high SEL or PEL value,
3911 * just set those values to the max in the Set SEL request.
3913 if (u1_sel > USB3_LPM_MAX_U1_SEL_PEL)
3914 u1_sel = USB3_LPM_MAX_U1_SEL_PEL;
3916 if (u1_pel > USB3_LPM_MAX_U1_SEL_PEL)
3917 u1_pel = USB3_LPM_MAX_U1_SEL_PEL;
3919 if (u2_sel > USB3_LPM_MAX_U2_SEL_PEL)
3920 u2_sel = USB3_LPM_MAX_U2_SEL_PEL;
3922 if (u2_pel > USB3_LPM_MAX_U2_SEL_PEL)
3923 u2_pel = USB3_LPM_MAX_U2_SEL_PEL;
3926 * usb_enable_lpm() can be called as part of a failed device reset,
3927 * which may be initiated by an error path of a mass storage driver.
3928 * Therefore, use GFP_NOIO.
3930 sel_values = kmalloc(sizeof *(sel_values), GFP_NOIO);
3934 sel_values->u1_sel = u1_sel;
3935 sel_values->u1_pel = u1_pel;
3936 sel_values->u2_sel = cpu_to_le16(u2_sel);
3937 sel_values->u2_pel = cpu_to_le16(u2_pel);
3939 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3943 sel_values, sizeof *(sel_values),
3944 USB_CTRL_SET_TIMEOUT);
3950 * Enable or disable device-initiated U1 or U2 transitions.
3952 static int usb_set_device_initiated_lpm(struct usb_device *udev,
3953 enum usb3_link_state state, bool enable)
3960 feature = USB_DEVICE_U1_ENABLE;
3963 feature = USB_DEVICE_U2_ENABLE;
3966 dev_warn(&udev->dev, "%s: Can't %s non-U1 or U2 state.\n",
3967 __func__, enable ? "enable" : "disable");
3971 if (udev->state != USB_STATE_CONFIGURED) {
3972 dev_dbg(&udev->dev, "%s: Can't %s %s state "
3973 "for unconfigured device.\n",
3974 __func__, enable ? "enable" : "disable",
3975 usb3_lpm_names[state]);
3981 * Now send the control transfer to enable device-initiated LPM
3982 * for either U1 or U2.
3984 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3985 USB_REQ_SET_FEATURE,
3989 USB_CTRL_SET_TIMEOUT);
3991 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3992 USB_REQ_CLEAR_FEATURE,
3996 USB_CTRL_SET_TIMEOUT);
3999 dev_warn(&udev->dev, "%s of device-initiated %s failed.\n",
4000 enable ? "Enable" : "Disable",
4001 usb3_lpm_names[state]);
4007 static int usb_set_lpm_timeout(struct usb_device *udev,
4008 enum usb3_link_state state, int timeout)
4015 feature = USB_PORT_FEAT_U1_TIMEOUT;
4018 feature = USB_PORT_FEAT_U2_TIMEOUT;
4021 dev_warn(&udev->dev, "%s: Can't set timeout for non-U1 or U2 state.\n",
4026 if (state == USB3_LPM_U1 && timeout > USB3_LPM_U1_MAX_TIMEOUT &&
4027 timeout != USB3_LPM_DEVICE_INITIATED) {
4028 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x, "
4029 "which is a reserved value.\n",
4030 usb3_lpm_names[state], timeout);
4034 ret = set_port_feature(udev->parent,
4035 USB_PORT_LPM_TIMEOUT(timeout) | udev->portnum,
4038 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x,"
4039 "error code %i\n", usb3_lpm_names[state],
4043 if (state == USB3_LPM_U1)
4044 udev->u1_params.timeout = timeout;
4046 udev->u2_params.timeout = timeout;
4051 * Don't allow device intiated U1/U2 if the system exit latency + one bus
4052 * interval is greater than the minimum service interval of any active
4053 * periodic endpoint. See USB 3.2 section 9.4.9
4055 static bool usb_device_may_initiate_lpm(struct usb_device *udev,
4056 enum usb3_link_state state)
4058 unsigned int sel; /* us */
4061 if (state == USB3_LPM_U1)
4062 sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
4063 else if (state == USB3_LPM_U2)
4064 sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
4068 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
4069 struct usb_interface *intf;
4070 struct usb_endpoint_descriptor *desc;
4071 unsigned int interval;
4073 intf = udev->actconfig->interface[i];
4077 for (j = 0; j < intf->cur_altsetting->desc.bNumEndpoints; j++) {
4078 desc = &intf->cur_altsetting->endpoint[j].desc;
4080 if (usb_endpoint_xfer_int(desc) ||
4081 usb_endpoint_xfer_isoc(desc)) {
4082 interval = (1 << (desc->bInterval - 1)) * 125;
4083 if (sel + 125 > interval)
4092 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
4095 * We will attempt to enable U1 or U2, but there are no guarantees that the
4096 * control transfers to set the hub timeout or enable device-initiated U1/U2
4097 * will be successful.
4099 * If the control transfer to enable device-initiated U1/U2 entry fails, then
4100 * hub-initiated U1/U2 will be disabled.
4102 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
4103 * driver know about it. If that call fails, it should be harmless, and just
4104 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
4106 static void usb_enable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
4107 enum usb3_link_state state)
4110 __u8 u1_mel = udev->bos->ss_cap->bU1devExitLat;
4111 __le16 u2_mel = udev->bos->ss_cap->bU2DevExitLat;
4113 /* If the device says it doesn't have *any* exit latency to come out of
4114 * U1 or U2, it's probably lying. Assume it doesn't implement that link
4117 if ((state == USB3_LPM_U1 && u1_mel == 0) ||
4118 (state == USB3_LPM_U2 && u2_mel == 0))
4122 * First, let the device know about the exit latencies
4123 * associated with the link state we're about to enable.
4125 ret = usb_req_set_sel(udev, state);
4127 dev_warn(&udev->dev, "Set SEL for device-initiated %s failed.\n",
4128 usb3_lpm_names[state]);
4132 /* We allow the host controller to set the U1/U2 timeout internally
4133 * first, so that it can change its schedule to account for the
4134 * additional latency to send data to a device in a lower power
4137 timeout = hcd->driver->enable_usb3_lpm_timeout(hcd, udev, state);
4139 /* xHCI host controller doesn't want to enable this LPM state. */
4144 dev_warn(&udev->dev, "Could not enable %s link state, "
4145 "xHCI error %i.\n", usb3_lpm_names[state],
4150 if (usb_set_lpm_timeout(udev, state, timeout)) {
4151 /* If we can't set the parent hub U1/U2 timeout,
4152 * device-initiated LPM won't be allowed either, so let the xHCI
4153 * host know that this link state won't be enabled.
4155 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
4159 /* Only a configured device will accept the Set Feature
4162 if (udev->actconfig &&
4163 usb_device_may_initiate_lpm(udev, state)) {
4164 if (usb_set_device_initiated_lpm(udev, state, true)) {
4166 * Request to enable device initiated U1/U2 failed,
4167 * better to turn off lpm in this case.
4169 usb_set_lpm_timeout(udev, state, 0);
4170 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
4175 if (state == USB3_LPM_U1)
4176 udev->usb3_lpm_u1_enabled = 1;
4177 else if (state == USB3_LPM_U2)
4178 udev->usb3_lpm_u2_enabled = 1;
4181 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
4184 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
4185 * If zero is returned, the parent will not allow the link to go into U1/U2.
4187 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
4188 * it won't have an effect on the bus link state because the parent hub will
4189 * still disallow device-initiated U1/U2 entry.
4191 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
4192 * possible. The result will be slightly more bus bandwidth will be taken up
4193 * (to account for U1/U2 exit latency), but it should be harmless.
4195 static int usb_disable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
4196 enum usb3_link_state state)
4203 dev_warn(&udev->dev, "%s: Can't disable non-U1 or U2 state.\n",
4208 if (usb_set_lpm_timeout(udev, state, 0))
4211 usb_set_device_initiated_lpm(udev, state, false);
4213 if (hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state))
4214 dev_warn(&udev->dev, "Could not disable xHCI %s timeout, "
4215 "bus schedule bandwidth may be impacted.\n",
4216 usb3_lpm_names[state]);
4218 /* As soon as usb_set_lpm_timeout(0) return 0, hub initiated LPM
4219 * is disabled. Hub will disallows link to enter U1/U2 as well,
4220 * even device is initiating LPM. Hence LPM is disabled if hub LPM
4221 * timeout set to 0, no matter device-initiated LPM is disabled or
4224 if (state == USB3_LPM_U1)
4225 udev->usb3_lpm_u1_enabled = 0;
4226 else if (state == USB3_LPM_U2)
4227 udev->usb3_lpm_u2_enabled = 0;
4233 * Disable hub-initiated and device-initiated U1 and U2 entry.
4234 * Caller must own the bandwidth_mutex.
4236 * This will call usb_enable_lpm() on failure, which will decrement
4237 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
4239 int usb_disable_lpm(struct usb_device *udev)
4241 struct usb_hcd *hcd;
4243 if (!udev || !udev->parent ||
4244 udev->speed < USB_SPEED_SUPER ||
4245 !udev->lpm_capable ||
4246 udev->state < USB_STATE_CONFIGURED)
4249 hcd = bus_to_hcd(udev->bus);
4250 if (!hcd || !hcd->driver->disable_usb3_lpm_timeout)
4253 udev->lpm_disable_count++;
4254 if ((udev->u1_params.timeout == 0 && udev->u2_params.timeout == 0))
4257 /* If LPM is enabled, attempt to disable it. */
4258 if (usb_disable_link_state(hcd, udev, USB3_LPM_U1))
4260 if (usb_disable_link_state(hcd, udev, USB3_LPM_U2))
4266 usb_enable_lpm(udev);
4269 EXPORT_SYMBOL_GPL(usb_disable_lpm);
4271 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
4272 int usb_unlocked_disable_lpm(struct usb_device *udev)
4274 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4280 mutex_lock(hcd->bandwidth_mutex);
4281 ret = usb_disable_lpm(udev);
4282 mutex_unlock(hcd->bandwidth_mutex);
4286 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
4289 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
4290 * xHCI host policy may prevent U1 or U2 from being enabled.
4292 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
4293 * until the lpm_disable_count drops to zero. Caller must own the
4296 void usb_enable_lpm(struct usb_device *udev)
4298 struct usb_hcd *hcd;
4299 struct usb_hub *hub;
4300 struct usb_port *port_dev;
4302 if (!udev || !udev->parent ||
4303 udev->speed < USB_SPEED_SUPER ||
4304 !udev->lpm_capable ||
4305 udev->state < USB_STATE_CONFIGURED)
4308 udev->lpm_disable_count--;
4309 hcd = bus_to_hcd(udev->bus);
4310 /* Double check that we can both enable and disable LPM.
4311 * Device must be configured to accept set feature U1/U2 timeout.
4313 if (!hcd || !hcd->driver->enable_usb3_lpm_timeout ||
4314 !hcd->driver->disable_usb3_lpm_timeout)
4317 if (udev->lpm_disable_count > 0)
4320 hub = usb_hub_to_struct_hub(udev->parent);
4324 port_dev = hub->ports[udev->portnum - 1];
4326 if (port_dev->usb3_lpm_u1_permit)
4327 usb_enable_link_state(hcd, udev, USB3_LPM_U1);
4329 if (port_dev->usb3_lpm_u2_permit)
4330 usb_enable_link_state(hcd, udev, USB3_LPM_U2);
4332 EXPORT_SYMBOL_GPL(usb_enable_lpm);
4334 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
4335 void usb_unlocked_enable_lpm(struct usb_device *udev)
4337 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4342 mutex_lock(hcd->bandwidth_mutex);
4343 usb_enable_lpm(udev);
4344 mutex_unlock(hcd->bandwidth_mutex);
4346 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
4348 /* usb3 devices use U3 for disabled, make sure remote wakeup is disabled */
4349 static void hub_usb3_port_prepare_disable(struct usb_hub *hub,
4350 struct usb_port *port_dev)
4352 struct usb_device *udev = port_dev->child;
4355 if (udev && udev->port_is_suspended && udev->do_remote_wakeup) {
4356 ret = hub_set_port_link_state(hub, port_dev->portnum,
4359 msleep(USB_RESUME_TIMEOUT);
4360 ret = usb_disable_remote_wakeup(udev);
4363 dev_warn(&udev->dev,
4364 "Port disable: can't disable remote wake\n");
4365 udev->do_remote_wakeup = 0;
4369 #else /* CONFIG_PM */
4371 #define hub_suspend NULL
4372 #define hub_resume NULL
4373 #define hub_reset_resume NULL
4375 static inline void hub_usb3_port_prepare_disable(struct usb_hub *hub,
4376 struct usb_port *port_dev) { }
4378 int usb_disable_lpm(struct usb_device *udev)
4382 EXPORT_SYMBOL_GPL(usb_disable_lpm);
4384 void usb_enable_lpm(struct usb_device *udev) { }
4385 EXPORT_SYMBOL_GPL(usb_enable_lpm);
4387 int usb_unlocked_disable_lpm(struct usb_device *udev)
4391 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
4393 void usb_unlocked_enable_lpm(struct usb_device *udev) { }
4394 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
4396 int usb_disable_ltm(struct usb_device *udev)
4400 EXPORT_SYMBOL_GPL(usb_disable_ltm);
4402 void usb_enable_ltm(struct usb_device *udev) { }
4403 EXPORT_SYMBOL_GPL(usb_enable_ltm);
4405 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
4406 u16 portstatus, u16 portchange)
4411 #endif /* CONFIG_PM */
4414 * USB-3 does not have a similar link state as USB-2 that will avoid negotiating
4415 * a connection with a plugged-in cable but will signal the host when the cable
4416 * is unplugged. Disable remote wake and set link state to U3 for USB-3 devices
4418 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
4420 struct usb_port *port_dev = hub->ports[port1 - 1];
4421 struct usb_device *hdev = hub->hdev;
4425 if (hub_is_superspeed(hub->hdev)) {
4426 hub_usb3_port_prepare_disable(hub, port_dev);
4427 ret = hub_set_port_link_state(hub, port_dev->portnum,
4430 ret = usb_clear_port_feature(hdev, port1,
4431 USB_PORT_FEAT_ENABLE);
4434 if (port_dev->child && set_state)
4435 usb_set_device_state(port_dev->child, USB_STATE_NOTATTACHED);
4436 if (ret && ret != -ENODEV)
4437 dev_err(&port_dev->dev, "cannot disable (err = %d)\n", ret);
4442 * usb_port_disable - disable a usb device's upstream port
4443 * @udev: device to disable
4444 * Context: @udev locked, must be able to sleep.
4446 * Disables a USB device that isn't in active use.
4448 int usb_port_disable(struct usb_device *udev)
4450 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
4452 return hub_port_disable(hub, udev->portnum, 0);
4455 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
4457 * Between connect detection and reset signaling there must be a delay
4458 * of 100ms at least for debounce and power-settling. The corresponding
4459 * timer shall restart whenever the downstream port detects a disconnect.
4461 * Apparently there are some bluetooth and irda-dongles and a number of
4462 * low-speed devices for which this debounce period may last over a second.
4463 * Not covered by the spec - but easy to deal with.
4465 * This implementation uses a 1500ms total debounce timeout; if the
4466 * connection isn't stable by then it returns -ETIMEDOUT. It checks
4467 * every 25ms for transient disconnects. When the port status has been
4468 * unchanged for 100ms it returns the port status.
4470 int hub_port_debounce(struct usb_hub *hub, int port1, bool must_be_connected)
4473 u16 portchange, portstatus;
4474 unsigned connection = 0xffff;
4475 int total_time, stable_time = 0;
4476 struct usb_port *port_dev = hub->ports[port1 - 1];
4478 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
4479 ret = hub_port_status(hub, port1, &portstatus, &portchange);
4483 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
4484 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
4485 if (!must_be_connected ||
4486 (connection == USB_PORT_STAT_CONNECTION))
4487 stable_time += HUB_DEBOUNCE_STEP;
4488 if (stable_time >= HUB_DEBOUNCE_STABLE)
4492 connection = portstatus & USB_PORT_STAT_CONNECTION;
4495 if (portchange & USB_PORT_STAT_C_CONNECTION) {
4496 usb_clear_port_feature(hub->hdev, port1,
4497 USB_PORT_FEAT_C_CONNECTION);
4500 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
4502 msleep(HUB_DEBOUNCE_STEP);
4505 dev_dbg(&port_dev->dev, "debounce total %dms stable %dms status 0x%x\n",
4506 total_time, stable_time, portstatus);
4508 if (stable_time < HUB_DEBOUNCE_STABLE)
4513 void usb_ep0_reinit(struct usb_device *udev)
4515 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
4516 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
4517 usb_enable_endpoint(udev, &udev->ep0, true);
4519 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
4521 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
4522 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
4524 static int hub_set_address(struct usb_device *udev, int devnum)
4527 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4530 * The host controller will choose the device address,
4531 * instead of the core having chosen it earlier
4533 if (!hcd->driver->address_device && devnum <= 1)
4535 if (udev->state == USB_STATE_ADDRESS)
4537 if (udev->state != USB_STATE_DEFAULT)
4539 if (hcd->driver->address_device)
4540 retval = hcd->driver->address_device(hcd, udev);
4542 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
4543 USB_REQ_SET_ADDRESS, 0, devnum, 0,
4544 NULL, 0, USB_CTRL_SET_TIMEOUT);
4546 update_devnum(udev, devnum);
4547 /* Device now using proper address. */
4548 usb_set_device_state(udev, USB_STATE_ADDRESS);
4549 usb_ep0_reinit(udev);
4555 * There are reports of USB 3.0 devices that say they support USB 2.0 Link PM
4556 * when they're plugged into a USB 2.0 port, but they don't work when LPM is
4559 * Only enable USB 2.0 Link PM if the port is internal (hardwired), or the
4560 * device says it supports the new USB 2.0 Link PM errata by setting the BESL
4561 * support bit in the BOS descriptor.
4563 static void hub_set_initial_usb2_lpm_policy(struct usb_device *udev)
4565 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
4566 int connect_type = USB_PORT_CONNECT_TYPE_UNKNOWN;
4568 if (!udev->usb2_hw_lpm_capable || !udev->bos)
4572 connect_type = hub->ports[udev->portnum - 1]->connect_type;
4574 if ((udev->bos->ext_cap->bmAttributes & cpu_to_le32(USB_BESL_SUPPORT)) ||
4575 connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
4576 udev->usb2_hw_lpm_allowed = 1;
4577 usb_enable_usb2_hardware_lpm(udev);
4581 static int hub_enable_device(struct usb_device *udev)
4583 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4585 if (!hcd->driver->enable_device)
4587 if (udev->state == USB_STATE_ADDRESS)
4589 if (udev->state != USB_STATE_DEFAULT)
4592 return hcd->driver->enable_device(hcd, udev);
4595 /* Reset device, (re)assign address, get device descriptor.
4596 * Device connection must be stable, no more debouncing needed.
4597 * Returns device in USB_STATE_ADDRESS, except on error.
4599 * If this is called for an already-existing device (as part of
4600 * usb_reset_and_verify_device), the caller must own the device lock and
4601 * the port lock. For a newly detected device that is not accessible
4602 * through any global pointers, it's not necessary to lock the device,
4603 * but it is still necessary to lock the port.
4606 hub_port_init(struct usb_hub *hub, struct usb_device *udev, int port1,
4609 struct usb_device *hdev = hub->hdev;
4610 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4611 struct usb_port *port_dev = hub->ports[port1 - 1];
4612 int retries, operations, retval, i;
4613 unsigned delay = HUB_SHORT_RESET_TIME;
4614 enum usb_device_speed oldspeed = udev->speed;
4616 int devnum = udev->devnum;
4617 const char *driver_name;
4620 /* root hub ports have a slightly longer reset period
4621 * (from USB 2.0 spec, section 7.1.7.5)
4623 if (!hdev->parent) {
4624 delay = HUB_ROOT_RESET_TIME;
4625 if (port1 == hdev->bus->otg_port)
4626 hdev->bus->b_hnp_enable = 0;
4629 /* Some low speed devices have problems with the quick delay, so */
4630 /* be a bit pessimistic with those devices. RHbug #23670 */
4631 if (oldspeed == USB_SPEED_LOW)
4632 delay = HUB_LONG_RESET_TIME;
4634 /* Reset the device; full speed may morph to high speed */
4635 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
4636 retval = hub_port_reset(hub, port1, udev, delay, false);
4637 if (retval < 0) /* error or disconnect */
4639 /* success, speed is known */
4643 /* Don't allow speed changes at reset, except usb 3.0 to faster */
4644 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed &&
4645 !(oldspeed == USB_SPEED_SUPER && udev->speed > oldspeed)) {
4646 dev_dbg(&udev->dev, "device reset changed speed!\n");
4649 oldspeed = udev->speed;
4651 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4652 * it's fixed size except for full speed devices.
4653 * For Wireless USB devices, ep0 max packet is always 512 (tho
4654 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4656 switch (udev->speed) {
4657 case USB_SPEED_SUPER_PLUS:
4658 case USB_SPEED_SUPER:
4659 case USB_SPEED_WIRELESS: /* fixed at 512 */
4660 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
4662 case USB_SPEED_HIGH: /* fixed at 64 */
4663 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4665 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
4666 /* to determine the ep0 maxpacket size, try to read
4667 * the device descriptor to get bMaxPacketSize0 and
4668 * then correct our initial guess.
4670 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4672 case USB_SPEED_LOW: /* fixed at 8 */
4673 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
4679 if (udev->speed == USB_SPEED_WIRELESS)
4680 speed = "variable speed Wireless";
4682 speed = usb_speed_string(udev->speed);
4685 * The controller driver may be NULL if the controller device
4686 * is the middle device between platform device and roothub.
4687 * This middle device may not need a device driver due to
4688 * all hardware control can be at platform device driver, this
4689 * platform device is usually a dual-role USB controller device.
4691 if (udev->bus->controller->driver)
4692 driver_name = udev->bus->controller->driver->name;
4694 driver_name = udev->bus->sysdev->driver->name;
4696 if (udev->speed < USB_SPEED_SUPER)
4697 dev_info(&udev->dev,
4698 "%s %s USB device number %d using %s\n",
4699 (udev->config) ? "reset" : "new", speed,
4700 devnum, driver_name);
4702 /* Set up TT records, if needed */
4704 udev->tt = hdev->tt;
4705 udev->ttport = hdev->ttport;
4706 } else if (udev->speed != USB_SPEED_HIGH
4707 && hdev->speed == USB_SPEED_HIGH) {
4709 dev_err(&udev->dev, "parent hub has no TT\n");
4713 udev->tt = &hub->tt;
4714 udev->ttport = port1;
4717 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4718 * Because device hardware and firmware is sometimes buggy in
4719 * this area, and this is how Linux has done it for ages.
4720 * Change it cautiously.
4722 * NOTE: If use_new_scheme() is true we will start by issuing
4723 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4724 * so it may help with some non-standards-compliant devices.
4725 * Otherwise we start with SET_ADDRESS and then try to read the
4726 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4729 do_new_scheme = use_new_scheme(udev, retry_counter, port_dev);
4731 for (retries = 0; retries < GET_DESCRIPTOR_TRIES; (++retries, msleep(100))) {
4732 if (do_new_scheme) {
4733 struct usb_device_descriptor *buf;
4736 retval = hub_enable_device(udev);
4739 "hub failed to enable device, error %d\n",
4744 #define GET_DESCRIPTOR_BUFSIZE 64
4745 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
4751 /* Retry on all errors; some devices are flakey.
4752 * 255 is for WUSB devices, we actually need to use
4753 * 512 (WUSB1.0[4.8.1]).
4755 for (operations = 0; operations < GET_MAXPACKET0_TRIES;
4757 buf->bMaxPacketSize0 = 0;
4758 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
4759 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
4760 USB_DT_DEVICE << 8, 0,
4761 buf, GET_DESCRIPTOR_BUFSIZE,
4762 initial_descriptor_timeout);
4763 switch (buf->bMaxPacketSize0) {
4764 case 8: case 16: case 32: case 64: case 255:
4765 if (buf->bDescriptorType ==
4777 * Some devices time out if they are powered on
4778 * when already connected. They need a second
4779 * reset. But only on the first attempt,
4780 * lest we get into a time out/reset loop
4782 if (r == 0 || (r == -ETIMEDOUT &&
4784 udev->speed > USB_SPEED_FULL))
4787 udev->descriptor.bMaxPacketSize0 =
4788 buf->bMaxPacketSize0;
4791 retval = hub_port_reset(hub, port1, udev, delay, false);
4792 if (retval < 0) /* error or disconnect */
4794 if (oldspeed != udev->speed) {
4796 "device reset changed speed!\n");
4802 dev_err(&udev->dev, "device descriptor read/64, error %d\n",
4807 #undef GET_DESCRIPTOR_BUFSIZE
4811 * If device is WUSB, we already assigned an
4812 * unauthorized address in the Connect Ack sequence;
4813 * authorization will assign the final address.
4815 if (udev->wusb == 0) {
4816 for (operations = 0; operations < SET_ADDRESS_TRIES; ++operations) {
4817 retval = hub_set_address(udev, devnum);
4823 if (retval != -ENODEV)
4824 dev_err(&udev->dev, "device not accepting address %d, error %d\n",
4828 if (udev->speed >= USB_SPEED_SUPER) {
4829 devnum = udev->devnum;
4830 dev_info(&udev->dev,
4831 "%s SuperSpeed%s%s USB device number %d using %s\n",
4832 (udev->config) ? "reset" : "new",
4833 (udev->speed == USB_SPEED_SUPER_PLUS) ?
4834 "Plus Gen 2" : " Gen 1",
4835 (udev->rx_lanes == 2 && udev->tx_lanes == 2) ?
4837 devnum, driver_name);
4840 /* cope with hardware quirkiness:
4841 * - let SET_ADDRESS settle, some device hardware wants it
4842 * - read ep0 maxpacket even for high and low speed,
4849 retval = usb_get_device_descriptor(udev, 8);
4851 if (retval != -ENODEV)
4853 "device descriptor read/8, error %d\n",
4862 delay = udev->parent->hub_delay;
4863 udev->hub_delay = min_t(u32, delay,
4864 USB_TP_TRANSMISSION_DELAY_MAX);
4865 retval = usb_set_isoch_delay(udev);
4868 "Failed set isoch delay, error %d\n",
4879 * Some superspeed devices have finished the link training process
4880 * and attached to a superspeed hub port, but the device descriptor
4881 * got from those devices show they aren't superspeed devices. Warm
4882 * reset the port attached by the devices can fix them.
4884 if ((udev->speed >= USB_SPEED_SUPER) &&
4885 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
4886 dev_err(&udev->dev, "got a wrong device descriptor, "
4887 "warm reset device\n");
4888 hub_port_reset(hub, port1, udev,
4889 HUB_BH_RESET_TIME, true);
4894 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
4895 udev->speed >= USB_SPEED_SUPER)
4898 i = udev->descriptor.bMaxPacketSize0;
4899 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
4900 if (udev->speed == USB_SPEED_LOW ||
4901 !(i == 8 || i == 16 || i == 32 || i == 64)) {
4902 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
4906 if (udev->speed == USB_SPEED_FULL)
4907 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
4909 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
4910 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
4911 usb_ep0_reinit(udev);
4914 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
4915 if (retval < (signed)sizeof(udev->descriptor)) {
4916 if (retval != -ENODEV)
4917 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
4924 usb_detect_quirks(udev);
4926 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
4927 retval = usb_get_bos_descriptor(udev);
4929 udev->lpm_capable = usb_device_supports_lpm(udev);
4930 usb_set_lpm_parameters(udev);
4935 /* notify HCD that we have a device connected and addressed */
4936 if (hcd->driver->update_device)
4937 hcd->driver->update_device(hcd, udev);
4938 hub_set_initial_usb2_lpm_policy(udev);
4941 hub_port_disable(hub, port1, 0);
4942 update_devnum(udev, devnum); /* for disconnect processing */
4948 check_highspeed(struct usb_hub *hub, struct usb_device *udev, int port1)
4950 struct usb_qualifier_descriptor *qual;
4953 if (udev->quirks & USB_QUIRK_DEVICE_QUALIFIER)
4956 qual = kmalloc(sizeof *qual, GFP_KERNEL);
4960 status = usb_get_descriptor(udev, USB_DT_DEVICE_QUALIFIER, 0,
4961 qual, sizeof *qual);
4962 if (status == sizeof *qual) {
4963 dev_info(&udev->dev, "not running at top speed; "
4964 "connect to a high speed hub\n");
4965 /* hub LEDs are probably harder to miss than syslog */
4966 if (hub->has_indicators) {
4967 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
4968 queue_delayed_work(system_power_efficient_wq,
4976 hub_power_remaining(struct usb_hub *hub)
4978 struct usb_device *hdev = hub->hdev;
4982 if (!hub->limited_power)
4985 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
4986 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
4987 struct usb_port *port_dev = hub->ports[port1 - 1];
4988 struct usb_device *udev = port_dev->child;
4994 if (hub_is_superspeed(udev))
5000 * Unconfigured devices may not use more than one unit load,
5001 * or 8mA for OTG ports
5003 if (udev->actconfig)
5004 delta = usb_get_max_power(udev, udev->actconfig);
5005 else if (port1 != udev->bus->otg_port || hdev->parent)
5009 if (delta > hub->mA_per_port)
5010 dev_warn(&port_dev->dev, "%dmA is over %umA budget!\n",
5011 delta, hub->mA_per_port);
5014 if (remaining < 0) {
5015 dev_warn(hub->intfdev, "%dmA over power budget!\n",
5023 static int descriptors_changed(struct usb_device *udev,
5024 struct usb_device_descriptor *old_device_descriptor,
5025 struct usb_host_bos *old_bos)
5029 unsigned serial_len = 0;
5031 unsigned old_length;
5035 if (memcmp(&udev->descriptor, old_device_descriptor,
5036 sizeof(*old_device_descriptor)) != 0)
5039 if ((old_bos && !udev->bos) || (!old_bos && udev->bos))
5042 len = le16_to_cpu(udev->bos->desc->wTotalLength);
5043 if (len != le16_to_cpu(old_bos->desc->wTotalLength))
5045 if (memcmp(udev->bos->desc, old_bos->desc, len))
5049 /* Since the idVendor, idProduct, and bcdDevice values in the
5050 * device descriptor haven't changed, we will assume the
5051 * Manufacturer and Product strings haven't changed either.
5052 * But the SerialNumber string could be different (e.g., a
5053 * different flash card of the same brand).
5056 serial_len = strlen(udev->serial) + 1;
5059 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5060 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5061 len = max(len, old_length);
5064 buf = kmalloc(len, GFP_NOIO);
5066 /* assume the worst */
5069 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5070 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5071 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
5073 if (length != old_length) {
5074 dev_dbg(&udev->dev, "config index %d, error %d\n",
5079 if (memcmp(buf, udev->rawdescriptors[index], old_length)
5081 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
5083 ((struct usb_config_descriptor *) buf)->
5084 bConfigurationValue);
5090 if (!changed && serial_len) {
5091 length = usb_string(udev, udev->descriptor.iSerialNumber,
5093 if (length + 1 != serial_len) {
5094 dev_dbg(&udev->dev, "serial string error %d\n",
5097 } else if (memcmp(buf, udev->serial, length) != 0) {
5098 dev_dbg(&udev->dev, "serial string changed\n");
5107 static void hub_port_connect(struct usb_hub *hub, int port1, u16 portstatus,
5110 int status = -ENODEV;
5113 struct usb_device *hdev = hub->hdev;
5114 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
5115 struct usb_port *port_dev = hub->ports[port1 - 1];
5116 struct usb_device *udev = port_dev->child;
5117 static int unreliable_port = -1;
5120 /* Disconnect any existing devices under this port */
5122 if (hcd->usb_phy && !hdev->parent)
5123 usb_phy_notify_disconnect(hcd->usb_phy, udev->speed);
5124 usb_disconnect(&port_dev->child);
5127 /* We can forget about a "removed" device when there's a physical
5128 * disconnect or the connect status changes.
5130 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
5131 (portchange & USB_PORT_STAT_C_CONNECTION))
5132 clear_bit(port1, hub->removed_bits);
5134 if (portchange & (USB_PORT_STAT_C_CONNECTION |
5135 USB_PORT_STAT_C_ENABLE)) {
5136 status = hub_port_debounce_be_stable(hub, port1);
5138 if (status != -ENODEV &&
5139 port1 != unreliable_port &&
5141 dev_err(&port_dev->dev, "connect-debounce failed\n");
5142 portstatus &= ~USB_PORT_STAT_CONNECTION;
5143 unreliable_port = port1;
5145 portstatus = status;
5149 /* Return now if debouncing failed or nothing is connected or
5150 * the device was "removed".
5152 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
5153 test_bit(port1, hub->removed_bits)) {
5156 * maybe switch power back on (e.g. root hub was reset)
5157 * but only if the port isn't owned by someone else.
5159 if (hub_is_port_power_switchable(hub)
5160 && !port_is_power_on(hub, portstatus)
5161 && !port_dev->port_owner)
5162 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
5164 if (portstatus & USB_PORT_STAT_ENABLE)
5168 if (hub_is_superspeed(hub->hdev))
5175 for (i = 0; i < PORT_INIT_TRIES; i++) {
5176 usb_lock_port(port_dev);
5177 mutex_lock(hcd->address0_mutex);
5178 retry_locked = true;
5179 /* reallocate for each attempt, since references
5180 * to the previous one can escape in various ways
5182 udev = usb_alloc_dev(hdev, hdev->bus, port1);
5184 dev_err(&port_dev->dev,
5185 "couldn't allocate usb_device\n");
5186 mutex_unlock(hcd->address0_mutex);
5187 usb_unlock_port(port_dev);
5191 usb_set_device_state(udev, USB_STATE_POWERED);
5192 udev->bus_mA = hub->mA_per_port;
5193 udev->level = hdev->level + 1;
5194 udev->wusb = hub_is_wusb(hub);
5196 /* Devices connected to SuperSpeed hubs are USB 3.0 or later */
5197 if (hub_is_superspeed(hub->hdev))
5198 udev->speed = USB_SPEED_SUPER;
5200 udev->speed = USB_SPEED_UNKNOWN;
5202 choose_devnum(udev);
5203 if (udev->devnum <= 0) {
5204 status = -ENOTCONN; /* Don't retry */
5208 /* reset (non-USB 3.0 devices) and get descriptor */
5209 status = hub_port_init(hub, udev, port1, i);
5213 mutex_unlock(hcd->address0_mutex);
5214 usb_unlock_port(port_dev);
5215 retry_locked = false;
5217 if (udev->quirks & USB_QUIRK_DELAY_INIT)
5220 /* consecutive bus-powered hubs aren't reliable; they can
5221 * violate the voltage drop budget. if the new child has
5222 * a "powered" LED, users should notice we didn't enable it
5223 * (without reading syslog), even without per-port LEDs
5226 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
5227 && udev->bus_mA <= unit_load) {
5230 status = usb_get_std_status(udev, USB_RECIP_DEVICE, 0,
5233 dev_dbg(&udev->dev, "get status %d ?\n", status);
5236 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
5238 "can't connect bus-powered hub "
5240 if (hub->has_indicators) {
5241 hub->indicator[port1-1] =
5242 INDICATOR_AMBER_BLINK;
5244 system_power_efficient_wq,
5247 status = -ENOTCONN; /* Don't retry */
5252 /* check for devices running slower than they could */
5253 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
5254 && udev->speed == USB_SPEED_FULL
5255 && highspeed_hubs != 0)
5256 check_highspeed(hub, udev, port1);
5258 /* Store the parent's children[] pointer. At this point
5259 * udev becomes globally accessible, although presumably
5260 * no one will look at it until hdev is unlocked.
5264 mutex_lock(&usb_port_peer_mutex);
5266 /* We mustn't add new devices if the parent hub has
5267 * been disconnected; we would race with the
5268 * recursively_mark_NOTATTACHED() routine.
5270 spin_lock_irq(&device_state_lock);
5271 if (hdev->state == USB_STATE_NOTATTACHED)
5274 port_dev->child = udev;
5275 spin_unlock_irq(&device_state_lock);
5276 mutex_unlock(&usb_port_peer_mutex);
5278 /* Run it through the hoops (find a driver, etc) */
5280 status = usb_new_device(udev);
5282 mutex_lock(&usb_port_peer_mutex);
5283 spin_lock_irq(&device_state_lock);
5284 port_dev->child = NULL;
5285 spin_unlock_irq(&device_state_lock);
5286 mutex_unlock(&usb_port_peer_mutex);
5288 if (hcd->usb_phy && !hdev->parent)
5289 usb_phy_notify_connect(hcd->usb_phy,
5297 status = hub_power_remaining(hub);
5299 dev_dbg(hub->intfdev, "%dmA power budget left\n", status);
5304 hub_port_disable(hub, port1, 1);
5306 usb_ep0_reinit(udev);
5307 release_devnum(udev);
5310 mutex_unlock(hcd->address0_mutex);
5311 usb_unlock_port(port_dev);
5314 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
5317 /* When halfway through our retry count, power-cycle the port */
5318 if (i == (PORT_INIT_TRIES - 1) / 2) {
5319 dev_info(&port_dev->dev, "attempt power cycle\n");
5320 usb_hub_set_port_power(hdev, hub, port1, false);
5321 msleep(2 * hub_power_on_good_delay(hub));
5322 usb_hub_set_port_power(hdev, hub, port1, true);
5323 msleep(hub_power_on_good_delay(hub));
5326 if (hub->hdev->parent ||
5327 !hcd->driver->port_handed_over ||
5328 !(hcd->driver->port_handed_over)(hcd, port1)) {
5329 if (status != -ENOTCONN && status != -ENODEV)
5330 dev_err(&port_dev->dev,
5331 "unable to enumerate USB device\n");
5335 hub_port_disable(hub, port1, 1);
5336 if (hcd->driver->relinquish_port && !hub->hdev->parent) {
5337 if (status != -ENOTCONN && status != -ENODEV)
5338 hcd->driver->relinquish_port(hcd, port1);
5342 /* Handle physical or logical connection change events.
5343 * This routine is called when:
5344 * a port connection-change occurs;
5345 * a port enable-change occurs (often caused by EMI);
5346 * usb_reset_and_verify_device() encounters changed descriptors (as from
5347 * a firmware download)
5348 * caller already locked the hub
5350 static void hub_port_connect_change(struct usb_hub *hub, int port1,
5351 u16 portstatus, u16 portchange)
5352 __must_hold(&port_dev->status_lock)
5354 struct usb_port *port_dev = hub->ports[port1 - 1];
5355 struct usb_device *udev = port_dev->child;
5356 struct usb_device_descriptor descriptor;
5357 int status = -ENODEV;
5360 dev_dbg(&port_dev->dev, "status %04x, change %04x, %s\n", portstatus,
5361 portchange, portspeed(hub, portstatus));
5363 if (hub->has_indicators) {
5364 set_port_led(hub, port1, HUB_LED_AUTO);
5365 hub->indicator[port1-1] = INDICATOR_AUTO;
5368 #ifdef CONFIG_USB_OTG
5369 /* during HNP, don't repeat the debounce */
5370 if (hub->hdev->bus->is_b_host)
5371 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
5372 USB_PORT_STAT_C_ENABLE);
5375 /* Try to resuscitate an existing device */
5376 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
5377 udev->state != USB_STATE_NOTATTACHED) {
5378 if (portstatus & USB_PORT_STAT_ENABLE) {
5380 * USB-3 connections are initialized automatically by
5381 * the hostcontroller hardware. Therefore check for
5382 * changed device descriptors before resuscitating the
5385 descriptor = udev->descriptor;
5386 retval = usb_get_device_descriptor(udev,
5387 sizeof(udev->descriptor));
5390 "can't read device descriptor %d\n",
5393 if (descriptors_changed(udev, &descriptor,
5396 "device descriptor has changed\n");
5397 /* for disconnect() calls */
5398 udev->descriptor = descriptor;
5400 status = 0; /* Nothing to do */
5404 } else if (udev->state == USB_STATE_SUSPENDED &&
5405 udev->persist_enabled) {
5406 /* For a suspended device, treat this as a
5407 * remote wakeup event.
5409 usb_unlock_port(port_dev);
5410 status = usb_remote_wakeup(udev);
5411 usb_lock_port(port_dev);
5414 /* Don't resuscitate */;
5417 clear_bit(port1, hub->change_bits);
5419 /* successfully revalidated the connection */
5423 usb_unlock_port(port_dev);
5424 hub_port_connect(hub, port1, portstatus, portchange);
5425 usb_lock_port(port_dev);
5428 /* Handle notifying userspace about hub over-current events */
5429 static void port_over_current_notify(struct usb_port *port_dev)
5432 struct device *hub_dev;
5433 char *port_dev_path;
5435 sysfs_notify(&port_dev->dev.kobj, NULL, "over_current_count");
5437 hub_dev = port_dev->dev.parent;
5442 port_dev_path = kobject_get_path(&port_dev->dev.kobj, GFP_KERNEL);
5446 envp[0] = kasprintf(GFP_KERNEL, "OVER_CURRENT_PORT=%s", port_dev_path);
5450 envp[1] = kasprintf(GFP_KERNEL, "OVER_CURRENT_COUNT=%u",
5451 port_dev->over_current_count);
5456 kobject_uevent_env(&hub_dev->kobj, KOBJ_CHANGE, envp);
5462 kfree(port_dev_path);
5465 static void port_event(struct usb_hub *hub, int port1)
5466 __must_hold(&port_dev->status_lock)
5469 struct usb_port *port_dev = hub->ports[port1 - 1];
5470 struct usb_device *udev = port_dev->child;
5471 struct usb_device *hdev = hub->hdev;
5472 u16 portstatus, portchange;
5474 connect_change = test_bit(port1, hub->change_bits);
5475 clear_bit(port1, hub->event_bits);
5476 clear_bit(port1, hub->wakeup_bits);
5478 if (hub_port_status(hub, port1, &portstatus, &portchange) < 0)
5481 if (portchange & USB_PORT_STAT_C_CONNECTION) {
5482 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_CONNECTION);
5486 if (portchange & USB_PORT_STAT_C_ENABLE) {
5487 if (!connect_change)
5488 dev_dbg(&port_dev->dev, "enable change, status %08x\n",
5490 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_ENABLE);
5493 * EM interference sometimes causes badly shielded USB devices
5494 * to be shutdown by the hub, this hack enables them again.
5495 * Works at least with mouse driver.
5497 if (!(portstatus & USB_PORT_STAT_ENABLE)
5498 && !connect_change && udev) {
5499 dev_err(&port_dev->dev, "disabled by hub (EMI?), re-enabling...\n");
5504 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
5505 u16 status = 0, unused;
5506 port_dev->over_current_count++;
5507 port_over_current_notify(port_dev);
5509 dev_dbg(&port_dev->dev, "over-current change #%u\n",
5510 port_dev->over_current_count);
5511 usb_clear_port_feature(hdev, port1,
5512 USB_PORT_FEAT_C_OVER_CURRENT);
5513 msleep(100); /* Cool down */
5514 hub_power_on(hub, true);
5515 hub_port_status(hub, port1, &status, &unused);
5516 if (status & USB_PORT_STAT_OVERCURRENT)
5517 dev_err(&port_dev->dev, "over-current condition\n");
5520 if (portchange & USB_PORT_STAT_C_RESET) {
5521 dev_dbg(&port_dev->dev, "reset change\n");
5522 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_RESET);
5524 if ((portchange & USB_PORT_STAT_C_BH_RESET)
5525 && hub_is_superspeed(hdev)) {
5526 dev_dbg(&port_dev->dev, "warm reset change\n");
5527 usb_clear_port_feature(hdev, port1,
5528 USB_PORT_FEAT_C_BH_PORT_RESET);
5530 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
5531 dev_dbg(&port_dev->dev, "link state change\n");
5532 usb_clear_port_feature(hdev, port1,
5533 USB_PORT_FEAT_C_PORT_LINK_STATE);
5535 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
5536 dev_warn(&port_dev->dev, "config error\n");
5537 usb_clear_port_feature(hdev, port1,
5538 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
5541 /* skip port actions that require the port to be powered on */
5542 if (!pm_runtime_active(&port_dev->dev))
5545 if (hub_handle_remote_wakeup(hub, port1, portstatus, portchange))
5549 * Warm reset a USB3 protocol port if it's in
5550 * SS.Inactive state.
5552 if (hub_port_warm_reset_required(hub, port1, portstatus)) {
5553 dev_dbg(&port_dev->dev, "do warm reset\n");
5554 if (!udev || !(portstatus & USB_PORT_STAT_CONNECTION)
5555 || udev->state == USB_STATE_NOTATTACHED) {
5556 if (hub_port_reset(hub, port1, NULL,
5557 HUB_BH_RESET_TIME, true) < 0)
5558 hub_port_disable(hub, port1, 1);
5560 usb_unlock_port(port_dev);
5561 usb_lock_device(udev);
5562 usb_reset_device(udev);
5563 usb_unlock_device(udev);
5564 usb_lock_port(port_dev);
5570 hub_port_connect_change(hub, port1, portstatus, portchange);
5573 static void hub_event(struct work_struct *work)
5575 struct usb_device *hdev;
5576 struct usb_interface *intf;
5577 struct usb_hub *hub;
5578 struct device *hub_dev;
5583 hub = container_of(work, struct usb_hub, events);
5585 hub_dev = hub->intfdev;
5586 intf = to_usb_interface(hub_dev);
5588 kcov_remote_start_usb((u64)hdev->bus->busnum);
5590 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
5591 hdev->state, hdev->maxchild,
5592 /* NOTE: expects max 15 ports... */
5593 (u16) hub->change_bits[0],
5594 (u16) hub->event_bits[0]);
5596 /* Lock the device, then check to see if we were
5597 * disconnected while waiting for the lock to succeed. */
5598 usb_lock_device(hdev);
5599 if (unlikely(hub->disconnected))
5602 /* If the hub has died, clean up after it */
5603 if (hdev->state == USB_STATE_NOTATTACHED) {
5604 hub->error = -ENODEV;
5605 hub_quiesce(hub, HUB_DISCONNECT);
5610 ret = usb_autopm_get_interface(intf);
5612 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
5616 /* If this is an inactive hub, do nothing */
5621 dev_dbg(hub_dev, "resetting for error %d\n", hub->error);
5623 ret = usb_reset_device(hdev);
5625 dev_dbg(hub_dev, "error resetting hub: %d\n", ret);
5633 /* deal with port status changes */
5634 for (i = 1; i <= hdev->maxchild; i++) {
5635 struct usb_port *port_dev = hub->ports[i - 1];
5637 if (test_bit(i, hub->event_bits)
5638 || test_bit(i, hub->change_bits)
5639 || test_bit(i, hub->wakeup_bits)) {
5641 * The get_noresume and barrier ensure that if
5642 * the port was in the process of resuming, we
5643 * flush that work and keep the port active for
5644 * the duration of the port_event(). However,
5645 * if the port is runtime pm suspended
5646 * (powered-off), we leave it in that state, run
5647 * an abbreviated port_event(), and move on.
5649 pm_runtime_get_noresume(&port_dev->dev);
5650 pm_runtime_barrier(&port_dev->dev);
5651 usb_lock_port(port_dev);
5653 usb_unlock_port(port_dev);
5654 pm_runtime_put_sync(&port_dev->dev);
5658 /* deal with hub status changes */
5659 if (test_and_clear_bit(0, hub->event_bits) == 0)
5661 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
5662 dev_err(hub_dev, "get_hub_status failed\n");
5664 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
5665 dev_dbg(hub_dev, "power change\n");
5666 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
5667 if (hubstatus & HUB_STATUS_LOCAL_POWER)
5668 /* FIXME: Is this always true? */
5669 hub->limited_power = 1;
5671 hub->limited_power = 0;
5673 if (hubchange & HUB_CHANGE_OVERCURRENT) {
5677 dev_dbg(hub_dev, "over-current change\n");
5678 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
5679 msleep(500); /* Cool down */
5680 hub_power_on(hub, true);
5681 hub_hub_status(hub, &status, &unused);
5682 if (status & HUB_STATUS_OVERCURRENT)
5683 dev_err(hub_dev, "over-current condition\n");
5688 /* Balance the usb_autopm_get_interface() above */
5689 usb_autopm_put_interface_no_suspend(intf);
5691 usb_unlock_device(hdev);
5693 /* Balance the stuff in kick_hub_wq() and allow autosuspend */
5694 usb_autopm_put_interface(intf);
5695 kref_put(&hub->kref, hub_release);
5700 static const struct usb_device_id hub_id_table[] = {
5701 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5702 | USB_DEVICE_ID_MATCH_PRODUCT
5703 | USB_DEVICE_ID_MATCH_INT_CLASS,
5704 .idVendor = USB_VENDOR_SMSC,
5705 .idProduct = USB_PRODUCT_USB5534B,
5706 .bInterfaceClass = USB_CLASS_HUB,
5707 .driver_info = HUB_QUIRK_DISABLE_AUTOSUSPEND},
5708 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5709 | USB_DEVICE_ID_MATCH_PRODUCT,
5710 .idVendor = USB_VENDOR_CYPRESS,
5711 .idProduct = USB_PRODUCT_CY7C65632,
5712 .driver_info = HUB_QUIRK_DISABLE_AUTOSUSPEND},
5713 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5714 | USB_DEVICE_ID_MATCH_INT_CLASS,
5715 .idVendor = USB_VENDOR_GENESYS_LOGIC,
5716 .bInterfaceClass = USB_CLASS_HUB,
5717 .driver_info = HUB_QUIRK_CHECK_PORT_AUTOSUSPEND},
5718 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
5719 .bDeviceClass = USB_CLASS_HUB},
5720 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
5721 .bInterfaceClass = USB_CLASS_HUB},
5722 { } /* Terminating entry */
5725 MODULE_DEVICE_TABLE(usb, hub_id_table);
5727 static struct usb_driver hub_driver = {
5730 .disconnect = hub_disconnect,
5731 .suspend = hub_suspend,
5732 .resume = hub_resume,
5733 .reset_resume = hub_reset_resume,
5734 .pre_reset = hub_pre_reset,
5735 .post_reset = hub_post_reset,
5736 .unlocked_ioctl = hub_ioctl,
5737 .id_table = hub_id_table,
5738 .supports_autosuspend = 1,
5741 int usb_hub_init(void)
5743 if (usb_register(&hub_driver) < 0) {
5744 printk(KERN_ERR "%s: can't register hub driver\n",
5750 * The workqueue needs to be freezable to avoid interfering with
5751 * USB-PERSIST port handover. Otherwise it might see that a full-speed
5752 * device was gone before the EHCI controller had handed its port
5753 * over to the companion full-speed controller.
5755 hub_wq = alloc_workqueue("usb_hub_wq", WQ_FREEZABLE, 0);
5759 /* Fall through if kernel_thread failed */
5760 usb_deregister(&hub_driver);
5761 pr_err("%s: can't allocate workqueue for usb hub\n", usbcore_name);
5766 void usb_hub_cleanup(void)
5768 destroy_workqueue(hub_wq);
5771 * Hub resources are freed for us by usb_deregister. It calls
5772 * usb_driver_purge on every device which in turn calls that
5773 * devices disconnect function if it is using this driver.
5774 * The hub_disconnect function takes care of releasing the
5775 * individual hub resources. -greg
5777 usb_deregister(&hub_driver);
5778 } /* usb_hub_cleanup() */
5781 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5782 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5784 * WARNING - don't use this routine to reset a composite device
5785 * (one with multiple interfaces owned by separate drivers)!
5786 * Use usb_reset_device() instead.
5788 * Do a port reset, reassign the device's address, and establish its
5789 * former operating configuration. If the reset fails, or the device's
5790 * descriptors change from their values before the reset, or the original
5791 * configuration and altsettings cannot be restored, a flag will be set
5792 * telling hub_wq to pretend the device has been disconnected and then
5793 * re-connected. All drivers will be unbound, and the device will be
5794 * re-enumerated and probed all over again.
5796 * Return: 0 if the reset succeeded, -ENODEV if the device has been
5797 * flagged for logical disconnection, or some other negative error code
5798 * if the reset wasn't even attempted.
5801 * The caller must own the device lock and the port lock, the latter is
5802 * taken by usb_reset_device(). For example, it's safe to use
5803 * usb_reset_device() from a driver probe() routine after downloading
5804 * new firmware. For calls that might not occur during probe(), drivers
5805 * should lock the device using usb_lock_device_for_reset().
5807 * Locking exception: This routine may also be called from within an
5808 * autoresume handler. Such usage won't conflict with other tasks
5809 * holding the device lock because these tasks should always call
5810 * usb_autopm_resume_device(), thereby preventing any unwanted
5811 * autoresume. The autoresume handler is expected to have already
5812 * acquired the port lock before calling this routine.
5814 static int usb_reset_and_verify_device(struct usb_device *udev)
5816 struct usb_device *parent_hdev = udev->parent;
5817 struct usb_hub *parent_hub;
5818 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
5819 struct usb_device_descriptor descriptor = udev->descriptor;
5820 struct usb_host_bos *bos;
5822 int port1 = udev->portnum;
5824 if (udev->state == USB_STATE_NOTATTACHED ||
5825 udev->state == USB_STATE_SUSPENDED) {
5826 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5834 parent_hub = usb_hub_to_struct_hub(parent_hdev);
5836 /* Disable USB2 hardware LPM.
5837 * It will be re-enabled by the enumeration process.
5839 usb_disable_usb2_hardware_lpm(udev);
5841 /* Disable LPM while we reset the device and reinstall the alt settings.
5842 * Device-initiated LPM, and system exit latency settings are cleared
5843 * when the device is reset, so we have to set them up again.
5845 ret = usb_unlocked_disable_lpm(udev);
5847 dev_err(&udev->dev, "%s Failed to disable LPM\n", __func__);
5848 goto re_enumerate_no_bos;
5854 mutex_lock(hcd->address0_mutex);
5856 for (i = 0; i < PORT_INIT_TRIES; ++i) {
5858 /* ep0 maxpacket size may change; let the HCD know about it.
5859 * Other endpoints will be handled by re-enumeration. */
5860 usb_ep0_reinit(udev);
5861 ret = hub_port_init(parent_hub, udev, port1, i);
5862 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
5865 mutex_unlock(hcd->address0_mutex);
5870 /* Device might have changed firmware (DFU or similar) */
5871 if (descriptors_changed(udev, &descriptor, bos)) {
5872 dev_info(&udev->dev, "device firmware changed\n");
5873 udev->descriptor = descriptor; /* for disconnect() calls */
5877 /* Restore the device's previous configuration */
5878 if (!udev->actconfig)
5881 mutex_lock(hcd->bandwidth_mutex);
5882 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
5884 dev_warn(&udev->dev,
5885 "Busted HC? Not enough HCD resources for "
5886 "old configuration.\n");
5887 mutex_unlock(hcd->bandwidth_mutex);
5890 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
5891 USB_REQ_SET_CONFIGURATION, 0,
5892 udev->actconfig->desc.bConfigurationValue, 0,
5893 NULL, 0, USB_CTRL_SET_TIMEOUT);
5896 "can't restore configuration #%d (error=%d)\n",
5897 udev->actconfig->desc.bConfigurationValue, ret);
5898 mutex_unlock(hcd->bandwidth_mutex);
5901 mutex_unlock(hcd->bandwidth_mutex);
5902 usb_set_device_state(udev, USB_STATE_CONFIGURED);
5904 /* Put interfaces back into the same altsettings as before.
5905 * Don't bother to send the Set-Interface request for interfaces
5906 * that were already in altsetting 0; besides being unnecessary,
5907 * many devices can't handle it. Instead just reset the host-side
5910 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
5911 struct usb_host_config *config = udev->actconfig;
5912 struct usb_interface *intf = config->interface[i];
5913 struct usb_interface_descriptor *desc;
5915 desc = &intf->cur_altsetting->desc;
5916 if (desc->bAlternateSetting == 0) {
5917 usb_disable_interface(udev, intf, true);
5918 usb_enable_interface(udev, intf, true);
5921 /* Let the bandwidth allocation function know that this
5922 * device has been reset, and it will have to use
5923 * alternate setting 0 as the current alternate setting.
5925 intf->resetting_device = 1;
5926 ret = usb_set_interface(udev, desc->bInterfaceNumber,
5927 desc->bAlternateSetting);
5928 intf->resetting_device = 0;
5931 dev_err(&udev->dev, "failed to restore interface %d "
5932 "altsetting %d (error=%d)\n",
5933 desc->bInterfaceNumber,
5934 desc->bAlternateSetting,
5938 /* Resetting also frees any allocated streams */
5939 for (j = 0; j < intf->cur_altsetting->desc.bNumEndpoints; j++)
5940 intf->cur_altsetting->endpoint[j].streams = 0;
5944 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5945 usb_enable_usb2_hardware_lpm(udev);
5946 usb_unlocked_enable_lpm(udev);
5947 usb_enable_ltm(udev);
5948 usb_release_bos_descriptor(udev);
5953 usb_release_bos_descriptor(udev);
5955 re_enumerate_no_bos:
5956 /* LPM state doesn't matter when we're about to destroy the device. */
5957 hub_port_logical_disconnect(parent_hub, port1);
5962 * usb_reset_device - warn interface drivers and perform a USB port reset
5963 * @udev: device to reset (not in NOTATTACHED state)
5965 * Warns all drivers bound to registered interfaces (using their pre_reset
5966 * method), performs the port reset, and then lets the drivers know that
5967 * the reset is over (using their post_reset method).
5969 * Return: The same as for usb_reset_and_verify_device().
5970 * However, if a reset is already in progress (for instance, if a
5971 * driver doesn't have pre_reset() or post_reset() callbacks, and while
5972 * being unbound or re-bound during the ongoing reset its disconnect()
5973 * or probe() routine tries to perform a second, nested reset), the
5974 * routine returns -EINPROGRESS.
5977 * The caller must own the device lock. For example, it's safe to use
5978 * this from a driver probe() routine after downloading new firmware.
5979 * For calls that might not occur during probe(), drivers should lock
5980 * the device using usb_lock_device_for_reset().
5982 * If an interface is currently being probed or disconnected, we assume
5983 * its driver knows how to handle resets. For all other interfaces,
5984 * if the driver doesn't have pre_reset and post_reset methods then
5985 * we attempt to unbind it and rebind afterward.
5987 int usb_reset_device(struct usb_device *udev)
5991 unsigned int noio_flag;
5992 struct usb_port *port_dev;
5993 struct usb_host_config *config = udev->actconfig;
5994 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
5996 if (udev->state == USB_STATE_NOTATTACHED) {
5997 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
6002 if (!udev->parent) {
6003 /* this requires hcd-specific logic; see ohci_restart() */
6004 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
6008 if (udev->reset_in_progress)
6009 return -EINPROGRESS;
6010 udev->reset_in_progress = 1;
6012 port_dev = hub->ports[udev->portnum - 1];
6015 * Don't allocate memory with GFP_KERNEL in current
6016 * context to avoid possible deadlock if usb mass
6017 * storage interface or usbnet interface(iSCSI case)
6018 * is included in current configuration. The easist
6019 * approach is to do it for every device reset,
6020 * because the device 'memalloc_noio' flag may have
6021 * not been set before reseting the usb device.
6023 noio_flag = memalloc_noio_save();
6025 /* Prevent autosuspend during the reset */
6026 usb_autoresume_device(udev);
6029 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
6030 struct usb_interface *cintf = config->interface[i];
6031 struct usb_driver *drv;
6034 if (cintf->dev.driver) {
6035 drv = to_usb_driver(cintf->dev.driver);
6036 if (drv->pre_reset && drv->post_reset)
6037 unbind = (drv->pre_reset)(cintf);
6038 else if (cintf->condition ==
6039 USB_INTERFACE_BOUND)
6042 usb_forced_unbind_intf(cintf);
6047 usb_lock_port(port_dev);
6048 ret = usb_reset_and_verify_device(udev);
6049 usb_unlock_port(port_dev);
6052 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
6053 struct usb_interface *cintf = config->interface[i];
6054 struct usb_driver *drv;
6055 int rebind = cintf->needs_binding;
6057 if (!rebind && cintf->dev.driver) {
6058 drv = to_usb_driver(cintf->dev.driver);
6059 if (drv->post_reset)
6060 rebind = (drv->post_reset)(cintf);
6061 else if (cintf->condition ==
6062 USB_INTERFACE_BOUND)
6065 cintf->needs_binding = 1;
6069 /* If the reset failed, hub_wq will unbind drivers later */
6071 usb_unbind_and_rebind_marked_interfaces(udev);
6074 usb_autosuspend_device(udev);
6075 memalloc_noio_restore(noio_flag);
6076 udev->reset_in_progress = 0;
6079 EXPORT_SYMBOL_GPL(usb_reset_device);
6083 * usb_queue_reset_device - Reset a USB device from an atomic context
6084 * @iface: USB interface belonging to the device to reset
6086 * This function can be used to reset a USB device from an atomic
6087 * context, where usb_reset_device() won't work (as it blocks).
6089 * Doing a reset via this method is functionally equivalent to calling
6090 * usb_reset_device(), except for the fact that it is delayed to a
6091 * workqueue. This means that any drivers bound to other interfaces
6092 * might be unbound, as well as users from usbfs in user space.
6096 * - Scheduling two resets at the same time from two different drivers
6097 * attached to two different interfaces of the same device is
6098 * possible; depending on how the driver attached to each interface
6099 * handles ->pre_reset(), the second reset might happen or not.
6101 * - If the reset is delayed so long that the interface is unbound from
6102 * its driver, the reset will be skipped.
6104 * - This function can be called during .probe(). It can also be called
6105 * during .disconnect(), but doing so is pointless because the reset
6106 * will not occur. If you really want to reset the device during
6107 * .disconnect(), call usb_reset_device() directly -- but watch out
6108 * for nested unbinding issues!
6110 void usb_queue_reset_device(struct usb_interface *iface)
6112 if (schedule_work(&iface->reset_ws))
6113 usb_get_intf(iface);
6115 EXPORT_SYMBOL_GPL(usb_queue_reset_device);
6118 * usb_hub_find_child - Get the pointer of child device
6119 * attached to the port which is specified by @port1.
6120 * @hdev: USB device belonging to the usb hub
6121 * @port1: port num to indicate which port the child device
6124 * USB drivers call this function to get hub's child device
6127 * Return: %NULL if input param is invalid and
6128 * child's usb_device pointer if non-NULL.
6130 struct usb_device *usb_hub_find_child(struct usb_device *hdev,
6133 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
6135 if (port1 < 1 || port1 > hdev->maxchild)
6137 return hub->ports[port1 - 1]->child;
6139 EXPORT_SYMBOL_GPL(usb_hub_find_child);
6141 void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
6142 struct usb_hub_descriptor *desc)
6144 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
6145 enum usb_port_connect_type connect_type;
6151 if (!hub_is_superspeed(hdev)) {
6152 for (i = 1; i <= hdev->maxchild; i++) {
6153 struct usb_port *port_dev = hub->ports[i - 1];
6155 connect_type = port_dev->connect_type;
6156 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
6157 u8 mask = 1 << (i%8);
6159 if (!(desc->u.hs.DeviceRemovable[i/8] & mask)) {
6160 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
6161 desc->u.hs.DeviceRemovable[i/8] |= mask;
6166 u16 port_removable = le16_to_cpu(desc->u.ss.DeviceRemovable);
6168 for (i = 1; i <= hdev->maxchild; i++) {
6169 struct usb_port *port_dev = hub->ports[i - 1];
6171 connect_type = port_dev->connect_type;
6172 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
6175 if (!(port_removable & mask)) {
6176 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
6177 port_removable |= mask;
6182 desc->u.ss.DeviceRemovable = cpu_to_le16(port_removable);
6188 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
6189 * @hdev: USB device belonging to the usb hub
6190 * @port1: port num of the port
6192 * Return: Port's acpi handle if successful, %NULL if params are
6195 acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
6198 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
6203 return ACPI_HANDLE(&hub->ports[port1 - 1]->dev);