1 // SPDX-License-Identifier: GPL-2.0
5 * (C) Copyright 1999 Linus Torvalds
6 * (C) Copyright 1999 Johannes Erdfelt
7 * (C) Copyright 1999 Gregory P. Smith
8 * (C) Copyright 2001 Brad Hards (bhards@bigpond.net.au)
10 * Released under the GPLv2 only.
13 #include <linux/kernel.h>
14 #include <linux/errno.h>
15 #include <linux/module.h>
16 #include <linux/moduleparam.h>
17 #include <linux/completion.h>
18 #include <linux/sched/mm.h>
19 #include <linux/list.h>
20 #include <linux/slab.h>
21 #include <linux/ioctl.h>
22 #include <linux/usb.h>
23 #include <linux/usbdevice_fs.h>
24 #include <linux/usb/hcd.h>
25 #include <linux/usb/otg.h>
26 #include <linux/usb/quirks.h>
27 #include <linux/workqueue.h>
28 #include <linux/mutex.h>
29 #include <linux/random.h>
30 #include <linux/pm_qos.h>
32 #include <linux/uaccess.h>
33 #include <asm/byteorder.h>
36 #include "otg_whitelist.h"
38 #define USB_VENDOR_GENESYS_LOGIC 0x05e3
39 #define USB_VENDOR_SMSC 0x0424
40 #define USB_PRODUCT_USB5534B 0x5534
41 #define USB_VENDOR_CYPRESS 0x04b4
42 #define USB_PRODUCT_CY7C65632 0x6570
43 #define HUB_QUIRK_CHECK_PORT_AUTOSUSPEND 0x01
44 #define HUB_QUIRK_DISABLE_AUTOSUSPEND 0x02
46 #define USB_TP_TRANSMISSION_DELAY 40 /* ns */
47 #define USB_TP_TRANSMISSION_DELAY_MAX 65535 /* ns */
48 #define USB_PING_RESPONSE_TIME 400 /* ns */
50 /* Protect struct usb_device->state and ->children members
51 * Note: Both are also protected by ->dev.sem, except that ->state can
52 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
53 static DEFINE_SPINLOCK(device_state_lock);
55 /* workqueue to process hub events */
56 static struct workqueue_struct *hub_wq;
57 static void hub_event(struct work_struct *work);
59 /* synchronize hub-port add/remove and peering operations */
60 DEFINE_MUTEX(usb_port_peer_mutex);
62 /* cycle leds on hubs that aren't blinking for attention */
63 static bool blinkenlights;
64 module_param(blinkenlights, bool, S_IRUGO);
65 MODULE_PARM_DESC(blinkenlights, "true to cycle leds on hubs");
68 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
69 * 10 seconds to send reply for the initial 64-byte descriptor request.
71 /* define initial 64-byte descriptor request timeout in milliseconds */
72 static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
73 module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
74 MODULE_PARM_DESC(initial_descriptor_timeout,
75 "initial 64-byte descriptor request timeout in milliseconds "
76 "(default 5000 - 5.0 seconds)");
79 * As of 2.6.10 we introduce a new USB device initialization scheme which
80 * closely resembles the way Windows works. Hopefully it will be compatible
81 * with a wider range of devices than the old scheme. However some previously
82 * working devices may start giving rise to "device not accepting address"
83 * errors; if that happens the user can try the old scheme by adjusting the
84 * following module parameters.
86 * For maximum flexibility there are two boolean parameters to control the
87 * hub driver's behavior. On the first initialization attempt, if the
88 * "old_scheme_first" parameter is set then the old scheme will be used,
89 * otherwise the new scheme is used. If that fails and "use_both_schemes"
90 * is set, then the driver will make another attempt, using the other scheme.
92 static bool old_scheme_first;
93 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
94 MODULE_PARM_DESC(old_scheme_first,
95 "start with the old device initialization scheme");
97 static bool use_both_schemes = 1;
98 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
99 MODULE_PARM_DESC(use_both_schemes,
100 "try the other device initialization scheme if the "
103 /* Mutual exclusion for EHCI CF initialization. This interferes with
104 * port reset on some companion controllers.
106 DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
107 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
109 #define HUB_DEBOUNCE_TIMEOUT 2000
110 #define HUB_DEBOUNCE_STEP 25
111 #define HUB_DEBOUNCE_STABLE 100
113 static void hub_release(struct kref *kref);
114 static int usb_reset_and_verify_device(struct usb_device *udev);
115 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state);
116 static bool hub_port_warm_reset_required(struct usb_hub *hub, int port1,
119 static inline char *portspeed(struct usb_hub *hub, int portstatus)
121 if (hub_is_superspeedplus(hub->hdev))
123 if (hub_is_superspeed(hub->hdev))
125 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
127 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
133 /* Note that hdev or one of its children must be locked! */
134 struct usb_hub *usb_hub_to_struct_hub(struct usb_device *hdev)
136 if (!hdev || !hdev->actconfig || !hdev->maxchild)
138 return usb_get_intfdata(hdev->actconfig->interface[0]);
141 int usb_device_supports_lpm(struct usb_device *udev)
143 /* Some devices have trouble with LPM */
144 if (udev->quirks & USB_QUIRK_NO_LPM)
147 /* USB 2.1 (and greater) devices indicate LPM support through
148 * their USB 2.0 Extended Capabilities BOS descriptor.
150 if (udev->speed == USB_SPEED_HIGH || udev->speed == USB_SPEED_FULL) {
151 if (udev->bos->ext_cap &&
153 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
159 * According to the USB 3.0 spec, all USB 3.0 devices must support LPM.
160 * However, there are some that don't, and they set the U1/U2 exit
163 if (!udev->bos->ss_cap) {
164 dev_info(&udev->dev, "No LPM exit latency info found, disabling LPM.\n");
168 if (udev->bos->ss_cap->bU1devExitLat == 0 &&
169 udev->bos->ss_cap->bU2DevExitLat == 0) {
171 dev_info(&udev->dev, "LPM exit latency is zeroed, disabling LPM.\n");
173 dev_info(&udev->dev, "We don't know the algorithms for LPM for this host, disabling LPM.\n");
177 if (!udev->parent || udev->parent->lpm_capable)
183 * Set the Maximum Exit Latency (MEL) for the host to wakup up the path from
184 * U1/U2, send a PING to the device and receive a PING_RESPONSE.
185 * See USB 3.1 section C.1.5.2
187 static void usb_set_lpm_mel(struct usb_device *udev,
188 struct usb3_lpm_parameters *udev_lpm_params,
189 unsigned int udev_exit_latency,
191 struct usb3_lpm_parameters *hub_lpm_params,
192 unsigned int hub_exit_latency)
194 unsigned int total_mel;
197 * tMEL1. time to transition path from host to device into U0.
198 * MEL for parent already contains the delay up to parent, so only add
199 * the exit latency for the last link (pick the slower exit latency),
200 * and the hub header decode latency. See USB 3.1 section C 2.2.1
201 * Store MEL in nanoseconds
203 total_mel = hub_lpm_params->mel +
204 max(udev_exit_latency, hub_exit_latency) * 1000 +
205 hub->descriptor->u.ss.bHubHdrDecLat * 100;
208 * tMEL2. Time to submit PING packet. Sum of tTPTransmissionDelay for
209 * each link + wHubDelay for each hub. Add only for last link.
210 * tMEL4, the time for PING_RESPONSE to traverse upstream is similar.
211 * Multiply by 2 to include it as well.
213 total_mel += (__le16_to_cpu(hub->descriptor->u.ss.wHubDelay) +
214 USB_TP_TRANSMISSION_DELAY) * 2;
217 * tMEL3, tPingResponse. Time taken by device to generate PING_RESPONSE
218 * after receiving PING. Also add 2100ns as stated in USB 3.1 C 1.5.2.4
219 * to cover the delay if the PING_RESPONSE is queued behind a Max Packet
221 * Note these delays should be added only once for the entire path, so
222 * add them to the MEL of the device connected to the roothub.
224 if (!hub->hdev->parent)
225 total_mel += USB_PING_RESPONSE_TIME + 2100;
227 udev_lpm_params->mel = total_mel;
231 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
232 * a transition from either U1 or U2.
234 static void usb_set_lpm_pel(struct usb_device *udev,
235 struct usb3_lpm_parameters *udev_lpm_params,
236 unsigned int udev_exit_latency,
238 struct usb3_lpm_parameters *hub_lpm_params,
239 unsigned int hub_exit_latency,
240 unsigned int port_to_port_exit_latency)
242 unsigned int first_link_pel;
243 unsigned int hub_pel;
246 * First, the device sends an LFPS to transition the link between the
247 * device and the parent hub into U0. The exit latency is the bigger of
248 * the device exit latency or the hub exit latency.
250 if (udev_exit_latency > hub_exit_latency)
251 first_link_pel = udev_exit_latency * 1000;
253 first_link_pel = hub_exit_latency * 1000;
256 * When the hub starts to receive the LFPS, there is a slight delay for
257 * it to figure out that one of the ports is sending an LFPS. Then it
258 * will forward the LFPS to its upstream link. The exit latency is the
259 * delay, plus the PEL that we calculated for this hub.
261 hub_pel = port_to_port_exit_latency * 1000 + hub_lpm_params->pel;
264 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
265 * is the greater of the two exit latencies.
267 if (first_link_pel > hub_pel)
268 udev_lpm_params->pel = first_link_pel;
270 udev_lpm_params->pel = hub_pel;
274 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
275 * when a device initiates a transition to U0, until when it will receive the
276 * first packet from the host controller.
278 * Section C.1.5.1 describes the four components to this:
280 * - t2: time for the ERDY to make it from the device to the host.
281 * - t3: a host-specific delay to process the ERDY.
282 * - t4: time for the packet to make it from the host to the device.
284 * t3 is specific to both the xHCI host and the platform the host is integrated
285 * into. The Intel HW folks have said it's negligible, FIXME if a different
286 * vendor says otherwise.
288 static void usb_set_lpm_sel(struct usb_device *udev,
289 struct usb3_lpm_parameters *udev_lpm_params)
291 struct usb_device *parent;
292 unsigned int num_hubs;
293 unsigned int total_sel;
295 /* t1 = device PEL */
296 total_sel = udev_lpm_params->pel;
297 /* How many external hubs are in between the device & the root port. */
298 for (parent = udev->parent, num_hubs = 0; parent->parent;
299 parent = parent->parent)
301 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
303 total_sel += 2100 + 250 * (num_hubs - 1);
305 /* t4 = 250ns * num_hubs */
306 total_sel += 250 * num_hubs;
308 udev_lpm_params->sel = total_sel;
311 static void usb_set_lpm_parameters(struct usb_device *udev)
314 unsigned int port_to_port_delay;
315 unsigned int udev_u1_del;
316 unsigned int udev_u2_del;
317 unsigned int hub_u1_del;
318 unsigned int hub_u2_del;
320 if (!udev->lpm_capable || udev->speed < USB_SPEED_SUPER)
323 hub = usb_hub_to_struct_hub(udev->parent);
324 /* It doesn't take time to transition the roothub into U0, since it
325 * doesn't have an upstream link.
330 udev_u1_del = udev->bos->ss_cap->bU1devExitLat;
331 udev_u2_del = le16_to_cpu(udev->bos->ss_cap->bU2DevExitLat);
332 hub_u1_del = udev->parent->bos->ss_cap->bU1devExitLat;
333 hub_u2_del = le16_to_cpu(udev->parent->bos->ss_cap->bU2DevExitLat);
335 usb_set_lpm_mel(udev, &udev->u1_params, udev_u1_del,
336 hub, &udev->parent->u1_params, hub_u1_del);
338 usb_set_lpm_mel(udev, &udev->u2_params, udev_u2_del,
339 hub, &udev->parent->u2_params, hub_u2_del);
342 * Appendix C, section C.2.2.2, says that there is a slight delay from
343 * when the parent hub notices the downstream port is trying to
344 * transition to U0 to when the hub initiates a U0 transition on its
345 * upstream port. The section says the delays are tPort2PortU1EL and
346 * tPort2PortU2EL, but it doesn't define what they are.
348 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
349 * about the same delays. Use the maximum delay calculations from those
350 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
351 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
352 * assume the device exit latencies they are talking about are the hub
355 * What do we do if the U2 exit latency is less than the U1 exit
356 * latency? It's possible, although not likely...
358 port_to_port_delay = 1;
360 usb_set_lpm_pel(udev, &udev->u1_params, udev_u1_del,
361 hub, &udev->parent->u1_params, hub_u1_del,
364 if (hub_u2_del > hub_u1_del)
365 port_to_port_delay = 1 + hub_u2_del - hub_u1_del;
367 port_to_port_delay = 1 + hub_u1_del;
369 usb_set_lpm_pel(udev, &udev->u2_params, udev_u2_del,
370 hub, &udev->parent->u2_params, hub_u2_del,
373 /* Now that we've got PEL, calculate SEL. */
374 usb_set_lpm_sel(udev, &udev->u1_params);
375 usb_set_lpm_sel(udev, &udev->u2_params);
378 /* USB 2.0 spec Section 11.24.4.5 */
379 static int get_hub_descriptor(struct usb_device *hdev,
380 struct usb_hub_descriptor *desc)
385 if (hub_is_superspeed(hdev)) {
386 dtype = USB_DT_SS_HUB;
387 size = USB_DT_SS_HUB_SIZE;
390 size = sizeof(struct usb_hub_descriptor);
393 for (i = 0; i < 3; i++) {
394 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
395 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
396 dtype << 8, 0, desc, size,
397 USB_CTRL_GET_TIMEOUT);
398 if (hub_is_superspeed(hdev)) {
401 } else if (ret >= USB_DT_HUB_NONVAR_SIZE + 2) {
402 /* Make sure we have the DeviceRemovable field. */
403 size = USB_DT_HUB_NONVAR_SIZE + desc->bNbrPorts / 8 + 1;
413 * USB 2.0 spec Section 11.24.2.1
415 static int clear_hub_feature(struct usb_device *hdev, int feature)
417 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
418 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
422 * USB 2.0 spec Section 11.24.2.2
424 int usb_clear_port_feature(struct usb_device *hdev, int port1, int feature)
426 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
427 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
432 * USB 2.0 spec Section 11.24.2.13
434 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
436 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
437 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
441 static char *to_led_name(int selector)
458 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
459 * for info about using port indicators
461 static void set_port_led(struct usb_hub *hub, int port1, int selector)
463 struct usb_port *port_dev = hub->ports[port1 - 1];
466 status = set_port_feature(hub->hdev, (selector << 8) | port1,
467 USB_PORT_FEAT_INDICATOR);
468 dev_dbg(&port_dev->dev, "indicator %s status %d\n",
469 to_led_name(selector), status);
472 #define LED_CYCLE_PERIOD ((2*HZ)/3)
474 static void led_work(struct work_struct *work)
476 struct usb_hub *hub =
477 container_of(work, struct usb_hub, leds.work);
478 struct usb_device *hdev = hub->hdev;
480 unsigned changed = 0;
483 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
486 for (i = 0; i < hdev->maxchild; i++) {
487 unsigned selector, mode;
489 /* 30%-50% duty cycle */
491 switch (hub->indicator[i]) {
493 case INDICATOR_CYCLE:
495 selector = HUB_LED_AUTO;
496 mode = INDICATOR_AUTO;
498 /* blinking green = sw attention */
499 case INDICATOR_GREEN_BLINK:
500 selector = HUB_LED_GREEN;
501 mode = INDICATOR_GREEN_BLINK_OFF;
503 case INDICATOR_GREEN_BLINK_OFF:
504 selector = HUB_LED_OFF;
505 mode = INDICATOR_GREEN_BLINK;
507 /* blinking amber = hw attention */
508 case INDICATOR_AMBER_BLINK:
509 selector = HUB_LED_AMBER;
510 mode = INDICATOR_AMBER_BLINK_OFF;
512 case INDICATOR_AMBER_BLINK_OFF:
513 selector = HUB_LED_OFF;
514 mode = INDICATOR_AMBER_BLINK;
516 /* blink green/amber = reserved */
517 case INDICATOR_ALT_BLINK:
518 selector = HUB_LED_GREEN;
519 mode = INDICATOR_ALT_BLINK_OFF;
521 case INDICATOR_ALT_BLINK_OFF:
522 selector = HUB_LED_AMBER;
523 mode = INDICATOR_ALT_BLINK;
528 if (selector != HUB_LED_AUTO)
530 set_port_led(hub, i + 1, selector);
531 hub->indicator[i] = mode;
533 if (!changed && blinkenlights) {
535 cursor %= hdev->maxchild;
536 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
537 hub->indicator[cursor] = INDICATOR_CYCLE;
541 queue_delayed_work(system_power_efficient_wq,
542 &hub->leds, LED_CYCLE_PERIOD);
545 /* use a short timeout for hub/port status fetches */
546 #define USB_STS_TIMEOUT 1000
547 #define USB_STS_RETRIES 5
550 * USB 2.0 spec Section 11.24.2.6
552 static int get_hub_status(struct usb_device *hdev,
553 struct usb_hub_status *data)
555 int i, status = -ETIMEDOUT;
557 for (i = 0; i < USB_STS_RETRIES &&
558 (status == -ETIMEDOUT || status == -EPIPE); i++) {
559 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
560 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
561 data, sizeof(*data), USB_STS_TIMEOUT);
567 * USB 2.0 spec Section 11.24.2.7
568 * USB 3.1 takes into use the wValue and wLength fields, spec Section 10.16.2.6
570 static int get_port_status(struct usb_device *hdev, int port1,
571 void *data, u16 value, u16 length)
573 int i, status = -ETIMEDOUT;
575 for (i = 0; i < USB_STS_RETRIES &&
576 (status == -ETIMEDOUT || status == -EPIPE); i++) {
577 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
578 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, value,
579 port1, data, length, USB_STS_TIMEOUT);
584 static int hub_ext_port_status(struct usb_hub *hub, int port1, int type,
585 u16 *status, u16 *change, u32 *ext_status)
590 if (type != HUB_PORT_STATUS)
593 mutex_lock(&hub->status_mutex);
594 ret = get_port_status(hub->hdev, port1, &hub->status->port, type, len);
597 dev_err(hub->intfdev,
598 "%s failed (err = %d)\n", __func__, ret);
602 *status = le16_to_cpu(hub->status->port.wPortStatus);
603 *change = le16_to_cpu(hub->status->port.wPortChange);
604 if (type != HUB_PORT_STATUS && ext_status)
605 *ext_status = le32_to_cpu(
606 hub->status->port.dwExtPortStatus);
609 mutex_unlock(&hub->status_mutex);
613 static int hub_port_status(struct usb_hub *hub, int port1,
614 u16 *status, u16 *change)
616 return hub_ext_port_status(hub, port1, HUB_PORT_STATUS,
617 status, change, NULL);
620 static void kick_hub_wq(struct usb_hub *hub)
622 struct usb_interface *intf;
624 if (hub->disconnected || work_pending(&hub->events))
628 * Suppress autosuspend until the event is proceed.
630 * Be careful and make sure that the symmetric operation is
631 * always called. We are here only when there is no pending
632 * work for this hub. Therefore put the interface either when
633 * the new work is called or when it is canceled.
635 intf = to_usb_interface(hub->intfdev);
636 usb_autopm_get_interface_no_resume(intf);
637 kref_get(&hub->kref);
639 if (queue_work(hub_wq, &hub->events))
642 /* the work has already been scheduled */
643 usb_autopm_put_interface_async(intf);
644 kref_put(&hub->kref, hub_release);
647 void usb_kick_hub_wq(struct usb_device *hdev)
649 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
656 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
657 * Notification, which indicates it had initiated remote wakeup.
659 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
660 * device initiates resume, so the USB core will not receive notice of the
661 * resume through the normal hub interrupt URB.
663 void usb_wakeup_notification(struct usb_device *hdev,
664 unsigned int portnum)
667 struct usb_port *port_dev;
672 hub = usb_hub_to_struct_hub(hdev);
674 port_dev = hub->ports[portnum - 1];
675 if (port_dev && port_dev->child)
676 pm_wakeup_event(&port_dev->child->dev, 0);
678 set_bit(portnum, hub->wakeup_bits);
682 EXPORT_SYMBOL_GPL(usb_wakeup_notification);
684 /* completion function, fires on port status changes and various faults */
685 static void hub_irq(struct urb *urb)
687 struct usb_hub *hub = urb->context;
688 int status = urb->status;
693 case -ENOENT: /* synchronous unlink */
694 case -ECONNRESET: /* async unlink */
695 case -ESHUTDOWN: /* hardware going away */
698 default: /* presumably an error */
699 /* Cause a hub reset after 10 consecutive errors */
700 dev_dbg(hub->intfdev, "transfer --> %d\n", status);
701 if ((++hub->nerrors < 10) || hub->error)
706 /* let hub_wq handle things */
707 case 0: /* we got data: port status changed */
709 for (i = 0; i < urb->actual_length; ++i)
710 bits |= ((unsigned long) ((*hub->buffer)[i]))
712 hub->event_bits[0] = bits;
718 /* Something happened, let hub_wq figure it out */
725 status = usb_submit_urb(hub->urb, GFP_ATOMIC);
726 if (status != 0 && status != -ENODEV && status != -EPERM)
727 dev_err(hub->intfdev, "resubmit --> %d\n", status);
730 /* USB 2.0 spec Section 11.24.2.3 */
732 hub_clear_tt_buffer(struct usb_device *hdev, u16 devinfo, u16 tt)
734 /* Need to clear both directions for control ep */
735 if (((devinfo >> 11) & USB_ENDPOINT_XFERTYPE_MASK) ==
736 USB_ENDPOINT_XFER_CONTROL) {
737 int status = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
738 HUB_CLEAR_TT_BUFFER, USB_RT_PORT,
739 devinfo ^ 0x8000, tt, NULL, 0, 1000);
743 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
744 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
749 * enumeration blocks hub_wq for a long time. we use keventd instead, since
750 * long blocking there is the exception, not the rule. accordingly, HCDs
751 * talking to TTs must queue control transfers (not just bulk and iso), so
752 * both can talk to the same hub concurrently.
754 static void hub_tt_work(struct work_struct *work)
756 struct usb_hub *hub =
757 container_of(work, struct usb_hub, tt.clear_work);
760 spin_lock_irqsave(&hub->tt.lock, flags);
761 while (!list_empty(&hub->tt.clear_list)) {
762 struct list_head *next;
763 struct usb_tt_clear *clear;
764 struct usb_device *hdev = hub->hdev;
765 const struct hc_driver *drv;
768 next = hub->tt.clear_list.next;
769 clear = list_entry(next, struct usb_tt_clear, clear_list);
770 list_del(&clear->clear_list);
772 /* drop lock so HCD can concurrently report other TT errors */
773 spin_unlock_irqrestore(&hub->tt.lock, flags);
774 status = hub_clear_tt_buffer(hdev, clear->devinfo, clear->tt);
775 if (status && status != -ENODEV)
777 "clear tt %d (%04x) error %d\n",
778 clear->tt, clear->devinfo, status);
780 /* Tell the HCD, even if the operation failed */
781 drv = clear->hcd->driver;
782 if (drv->clear_tt_buffer_complete)
783 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
786 spin_lock_irqsave(&hub->tt.lock, flags);
788 spin_unlock_irqrestore(&hub->tt.lock, flags);
792 * usb_hub_set_port_power - control hub port's power state
793 * @hdev: USB device belonging to the usb hub
796 * @set: expected status
798 * call this function to control port's power via setting or
799 * clearing the port's PORT_POWER feature.
801 * Return: 0 if successful. A negative error code otherwise.
803 int usb_hub_set_port_power(struct usb_device *hdev, struct usb_hub *hub,
809 ret = set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
811 ret = usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
817 set_bit(port1, hub->power_bits);
819 clear_bit(port1, hub->power_bits);
824 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
825 * @urb: an URB associated with the failed or incomplete split transaction
827 * High speed HCDs use this to tell the hub driver that some split control or
828 * bulk transaction failed in a way that requires clearing internal state of
829 * a transaction translator. This is normally detected (and reported) from
832 * It may not be possible for that hub to handle additional full (or low)
833 * speed transactions until that state is fully cleared out.
835 * Return: 0 if successful. A negative error code otherwise.
837 int usb_hub_clear_tt_buffer(struct urb *urb)
839 struct usb_device *udev = urb->dev;
840 int pipe = urb->pipe;
841 struct usb_tt *tt = udev->tt;
843 struct usb_tt_clear *clear;
845 /* we've got to cope with an arbitrary number of pending TT clears,
846 * since each TT has "at least two" buffers that can need it (and
847 * there can be many TTs per hub). even if they're uncommon.
849 clear = kmalloc(sizeof *clear, GFP_ATOMIC);
851 dev_err(&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
852 /* FIXME recover somehow ... RESET_TT? */
856 /* info that CLEAR_TT_BUFFER needs */
857 clear->tt = tt->multi ? udev->ttport : 1;
858 clear->devinfo = usb_pipeendpoint (pipe);
859 clear->devinfo |= udev->devnum << 4;
860 clear->devinfo |= usb_pipecontrol(pipe)
861 ? (USB_ENDPOINT_XFER_CONTROL << 11)
862 : (USB_ENDPOINT_XFER_BULK << 11);
863 if (usb_pipein(pipe))
864 clear->devinfo |= 1 << 15;
866 /* info for completion callback */
867 clear->hcd = bus_to_hcd(udev->bus);
870 /* tell keventd to clear state for this TT */
871 spin_lock_irqsave(&tt->lock, flags);
872 list_add_tail(&clear->clear_list, &tt->clear_list);
873 schedule_work(&tt->clear_work);
874 spin_unlock_irqrestore(&tt->lock, flags);
877 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
879 static void hub_power_on(struct usb_hub *hub, bool do_delay)
883 /* Enable power on each port. Some hubs have reserved values
884 * of LPSM (> 2) in their descriptors, even though they are
885 * USB 2.0 hubs. Some hubs do not implement port-power switching
886 * but only emulate it. In all cases, the ports won't work
887 * unless we send these messages to the hub.
889 if (hub_is_port_power_switchable(hub))
890 dev_dbg(hub->intfdev, "enabling power on all ports\n");
892 dev_dbg(hub->intfdev, "trying to enable port power on "
893 "non-switchable hub\n");
894 for (port1 = 1; port1 <= hub->hdev->maxchild; port1++)
895 if (test_bit(port1, hub->power_bits))
896 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
898 usb_clear_port_feature(hub->hdev, port1,
899 USB_PORT_FEAT_POWER);
901 msleep(hub_power_on_good_delay(hub));
904 static int hub_hub_status(struct usb_hub *hub,
905 u16 *status, u16 *change)
909 mutex_lock(&hub->status_mutex);
910 ret = get_hub_status(hub->hdev, &hub->status->hub);
913 dev_err(hub->intfdev,
914 "%s failed (err = %d)\n", __func__, ret);
916 *status = le16_to_cpu(hub->status->hub.wHubStatus);
917 *change = le16_to_cpu(hub->status->hub.wHubChange);
920 mutex_unlock(&hub->status_mutex);
924 static int hub_set_port_link_state(struct usb_hub *hub, int port1,
925 unsigned int link_status)
927 return set_port_feature(hub->hdev,
928 port1 | (link_status << 3),
929 USB_PORT_FEAT_LINK_STATE);
933 * Disable a port and mark a logical connect-change event, so that some
934 * time later hub_wq will disconnect() any existing usb_device on the port
935 * and will re-enumerate if there actually is a device attached.
937 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
939 dev_dbg(&hub->ports[port1 - 1]->dev, "logical disconnect\n");
940 hub_port_disable(hub, port1, 1);
942 /* FIXME let caller ask to power down the port:
943 * - some devices won't enumerate without a VBUS power cycle
944 * - SRP saves power that way
945 * - ... new call, TBD ...
946 * That's easy if this hub can switch power per-port, and
947 * hub_wq reactivates the port later (timer, SRP, etc).
948 * Powerdown must be optional, because of reset/DFU.
951 set_bit(port1, hub->change_bits);
956 * usb_remove_device - disable a device's port on its parent hub
957 * @udev: device to be disabled and removed
958 * Context: @udev locked, must be able to sleep.
960 * After @udev's port has been disabled, hub_wq is notified and it will
961 * see that the device has been disconnected. When the device is
962 * physically unplugged and something is plugged in, the events will
963 * be received and processed normally.
965 * Return: 0 if successful. A negative error code otherwise.
967 int usb_remove_device(struct usb_device *udev)
970 struct usb_interface *intf;
973 if (!udev->parent) /* Can't remove a root hub */
975 hub = usb_hub_to_struct_hub(udev->parent);
976 intf = to_usb_interface(hub->intfdev);
978 ret = usb_autopm_get_interface(intf);
982 set_bit(udev->portnum, hub->removed_bits);
983 hub_port_logical_disconnect(hub, udev->portnum);
984 usb_autopm_put_interface(intf);
988 enum hub_activation_type {
989 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
990 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
993 static void hub_init_func2(struct work_struct *ws);
994 static void hub_init_func3(struct work_struct *ws);
996 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
998 struct usb_device *hdev = hub->hdev;
1003 bool need_debounce_delay = false;
1006 /* Continue a partial initialization */
1007 if (type == HUB_INIT2 || type == HUB_INIT3) {
1008 device_lock(&hdev->dev);
1010 /* Was the hub disconnected while we were waiting? */
1011 if (hub->disconnected)
1013 if (type == HUB_INIT2)
1017 kref_get(&hub->kref);
1019 /* The superspeed hub except for root hub has to use Hub Depth
1020 * value as an offset into the route string to locate the bits
1021 * it uses to determine the downstream port number. So hub driver
1022 * should send a set hub depth request to superspeed hub after
1023 * the superspeed hub is set configuration in initialization or
1026 * After a resume, port power should still be on.
1027 * For any other type of activation, turn it on.
1029 if (type != HUB_RESUME) {
1030 if (hdev->parent && hub_is_superspeed(hdev)) {
1031 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
1032 HUB_SET_DEPTH, USB_RT_HUB,
1033 hdev->level - 1, 0, NULL, 0,
1034 USB_CTRL_SET_TIMEOUT);
1036 dev_err(hub->intfdev,
1037 "set hub depth failed\n");
1040 /* Speed up system boot by using a delayed_work for the
1041 * hub's initial power-up delays. This is pretty awkward
1042 * and the implementation looks like a home-brewed sort of
1043 * setjmp/longjmp, but it saves at least 100 ms for each
1044 * root hub (assuming usbcore is compiled into the kernel
1045 * rather than as a module). It adds up.
1047 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1048 * because for those activation types the ports have to be
1049 * operational when we return. In theory this could be done
1050 * for HUB_POST_RESET, but it's easier not to.
1052 if (type == HUB_INIT) {
1053 delay = hub_power_on_good_delay(hub);
1055 hub_power_on(hub, false);
1056 INIT_DELAYED_WORK(&hub->init_work, hub_init_func2);
1057 queue_delayed_work(system_power_efficient_wq,
1059 msecs_to_jiffies(delay));
1061 /* Suppress autosuspend until init is done */
1062 usb_autopm_get_interface_no_resume(
1063 to_usb_interface(hub->intfdev));
1064 return; /* Continues at init2: below */
1065 } else if (type == HUB_RESET_RESUME) {
1066 /* The internal host controller state for the hub device
1067 * may be gone after a host power loss on system resume.
1068 * Update the device's info so the HW knows it's a hub.
1070 hcd = bus_to_hcd(hdev->bus);
1071 if (hcd->driver->update_hub_device) {
1072 ret = hcd->driver->update_hub_device(hcd, hdev,
1073 &hub->tt, GFP_NOIO);
1075 dev_err(hub->intfdev,
1076 "Host not accepting hub info update\n");
1077 dev_err(hub->intfdev,
1078 "LS/FS devices and hubs may not work under this hub\n");
1081 hub_power_on(hub, true);
1083 hub_power_on(hub, true);
1085 /* Give some time on remote wakeup to let links to transit to U0 */
1086 } else if (hub_is_superspeed(hub->hdev))
1092 * Check each port and set hub->change_bits to let hub_wq know
1093 * which ports need attention.
1095 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
1096 struct usb_port *port_dev = hub->ports[port1 - 1];
1097 struct usb_device *udev = port_dev->child;
1098 u16 portstatus, portchange;
1100 portstatus = portchange = 0;
1101 status = hub_port_status(hub, port1, &portstatus, &portchange);
1105 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1106 dev_dbg(&port_dev->dev, "status %04x change %04x\n",
1107 portstatus, portchange);
1110 * After anything other than HUB_RESUME (i.e., initialization
1111 * or any sort of reset), every port should be disabled.
1112 * Unconnected ports should likewise be disabled (paranoia),
1113 * and so should ports for which we have no usb_device.
1115 if ((portstatus & USB_PORT_STAT_ENABLE) && (
1116 type != HUB_RESUME ||
1117 !(portstatus & USB_PORT_STAT_CONNECTION) ||
1119 udev->state == USB_STATE_NOTATTACHED)) {
1121 * USB3 protocol ports will automatically transition
1122 * to Enabled state when detect an USB3.0 device attach.
1123 * Do not disable USB3 protocol ports, just pretend
1126 portstatus &= ~USB_PORT_STAT_ENABLE;
1127 if (!hub_is_superspeed(hdev))
1128 usb_clear_port_feature(hdev, port1,
1129 USB_PORT_FEAT_ENABLE);
1132 /* Make sure a warm-reset request is handled by port_event */
1133 if (type == HUB_RESUME &&
1134 hub_port_warm_reset_required(hub, port1, portstatus))
1135 set_bit(port1, hub->event_bits);
1138 * Add debounce if USB3 link is in polling/link training state.
1139 * Link will automatically transition to Enabled state after
1140 * link training completes.
1142 if (hub_is_superspeed(hdev) &&
1143 ((portstatus & USB_PORT_STAT_LINK_STATE) ==
1144 USB_SS_PORT_LS_POLLING))
1145 need_debounce_delay = true;
1147 /* Clear status-change flags; we'll debounce later */
1148 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1149 need_debounce_delay = true;
1150 usb_clear_port_feature(hub->hdev, port1,
1151 USB_PORT_FEAT_C_CONNECTION);
1153 if (portchange & USB_PORT_STAT_C_ENABLE) {
1154 need_debounce_delay = true;
1155 usb_clear_port_feature(hub->hdev, port1,
1156 USB_PORT_FEAT_C_ENABLE);
1158 if (portchange & USB_PORT_STAT_C_RESET) {
1159 need_debounce_delay = true;
1160 usb_clear_port_feature(hub->hdev, port1,
1161 USB_PORT_FEAT_C_RESET);
1163 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
1164 hub_is_superspeed(hub->hdev)) {
1165 need_debounce_delay = true;
1166 usb_clear_port_feature(hub->hdev, port1,
1167 USB_PORT_FEAT_C_BH_PORT_RESET);
1169 /* We can forget about a "removed" device when there's a
1170 * physical disconnect or the connect status changes.
1172 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
1173 (portchange & USB_PORT_STAT_C_CONNECTION))
1174 clear_bit(port1, hub->removed_bits);
1176 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
1177 /* Tell hub_wq to disconnect the device or
1178 * check for a new connection or over current condition.
1179 * Based on USB2.0 Spec Section 11.12.5,
1180 * C_PORT_OVER_CURRENT could be set while
1181 * PORT_OVER_CURRENT is not. So check for any of them.
1183 if (udev || (portstatus & USB_PORT_STAT_CONNECTION) ||
1184 (portchange & USB_PORT_STAT_C_CONNECTION) ||
1185 (portstatus & USB_PORT_STAT_OVERCURRENT) ||
1186 (portchange & USB_PORT_STAT_C_OVERCURRENT))
1187 set_bit(port1, hub->change_bits);
1189 } else if (portstatus & USB_PORT_STAT_ENABLE) {
1190 bool port_resumed = (portstatus &
1191 USB_PORT_STAT_LINK_STATE) ==
1193 /* The power session apparently survived the resume.
1194 * If there was an overcurrent or suspend change
1195 * (i.e., remote wakeup request), have hub_wq
1196 * take care of it. Look at the port link state
1197 * for USB 3.0 hubs, since they don't have a suspend
1198 * change bit, and they don't set the port link change
1199 * bit on device-initiated resume.
1201 if (portchange || (hub_is_superspeed(hub->hdev) &&
1203 set_bit(port1, hub->event_bits);
1205 } else if (udev->persist_enabled) {
1207 udev->reset_resume = 1;
1209 /* Don't set the change_bits when the device
1212 if (test_bit(port1, hub->power_bits))
1213 set_bit(port1, hub->change_bits);
1216 /* The power session is gone; tell hub_wq */
1217 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1218 set_bit(port1, hub->change_bits);
1222 /* If no port-status-change flags were set, we don't need any
1223 * debouncing. If flags were set we can try to debounce the
1224 * ports all at once right now, instead of letting hub_wq do them
1225 * one at a time later on.
1227 * If any port-status changes do occur during this delay, hub_wq
1228 * will see them later and handle them normally.
1230 if (need_debounce_delay) {
1231 delay = HUB_DEBOUNCE_STABLE;
1233 /* Don't do a long sleep inside a workqueue routine */
1234 if (type == HUB_INIT2) {
1235 INIT_DELAYED_WORK(&hub->init_work, hub_init_func3);
1236 queue_delayed_work(system_power_efficient_wq,
1238 msecs_to_jiffies(delay));
1239 device_unlock(&hdev->dev);
1240 return; /* Continues at init3: below */
1248 status = usb_submit_urb(hub->urb, GFP_NOIO);
1250 dev_err(hub->intfdev, "activate --> %d\n", status);
1251 if (hub->has_indicators && blinkenlights)
1252 queue_delayed_work(system_power_efficient_wq,
1253 &hub->leds, LED_CYCLE_PERIOD);
1255 /* Scan all ports that need attention */
1258 if (type == HUB_INIT2 || type == HUB_INIT3) {
1259 /* Allow autosuspend if it was suppressed */
1261 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
1262 device_unlock(&hdev->dev);
1265 kref_put(&hub->kref, hub_release);
1268 /* Implement the continuations for the delays above */
1269 static void hub_init_func2(struct work_struct *ws)
1271 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1273 hub_activate(hub, HUB_INIT2);
1276 static void hub_init_func3(struct work_struct *ws)
1278 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1280 hub_activate(hub, HUB_INIT3);
1283 enum hub_quiescing_type {
1284 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
1287 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
1289 struct usb_device *hdev = hub->hdev;
1292 /* hub_wq and related activity won't re-trigger */
1295 if (type != HUB_SUSPEND) {
1296 /* Disconnect all the children */
1297 for (i = 0; i < hdev->maxchild; ++i) {
1298 if (hub->ports[i]->child)
1299 usb_disconnect(&hub->ports[i]->child);
1303 /* Stop hub_wq and related activity */
1304 usb_kill_urb(hub->urb);
1305 if (hub->has_indicators)
1306 cancel_delayed_work_sync(&hub->leds);
1308 flush_work(&hub->tt.clear_work);
1311 static void hub_pm_barrier_for_all_ports(struct usb_hub *hub)
1315 for (i = 0; i < hub->hdev->maxchild; ++i)
1316 pm_runtime_barrier(&hub->ports[i]->dev);
1319 /* caller has locked the hub device */
1320 static int hub_pre_reset(struct usb_interface *intf)
1322 struct usb_hub *hub = usb_get_intfdata(intf);
1324 hub_quiesce(hub, HUB_PRE_RESET);
1326 hub_pm_barrier_for_all_ports(hub);
1330 /* caller has locked the hub device */
1331 static int hub_post_reset(struct usb_interface *intf)
1333 struct usb_hub *hub = usb_get_intfdata(intf);
1336 hub_pm_barrier_for_all_ports(hub);
1337 hub_activate(hub, HUB_POST_RESET);
1341 static int hub_configure(struct usb_hub *hub,
1342 struct usb_endpoint_descriptor *endpoint)
1344 struct usb_hcd *hcd;
1345 struct usb_device *hdev = hub->hdev;
1346 struct device *hub_dev = hub->intfdev;
1347 u16 hubstatus, hubchange;
1348 u16 wHubCharacteristics;
1351 char *message = "out of memory";
1356 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
1362 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1367 mutex_init(&hub->status_mutex);
1369 hub->descriptor = kzalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1370 if (!hub->descriptor) {
1375 /* Request the entire hub descriptor.
1376 * hub->descriptor can handle USB_MAXCHILDREN ports,
1377 * but a (non-SS) hub can/will return fewer bytes here.
1379 ret = get_hub_descriptor(hdev, hub->descriptor);
1381 message = "can't read hub descriptor";
1385 maxchild = USB_MAXCHILDREN;
1386 if (hub_is_superspeed(hdev))
1387 maxchild = min_t(unsigned, maxchild, USB_SS_MAXPORTS);
1389 if (hub->descriptor->bNbrPorts > maxchild) {
1390 message = "hub has too many ports!";
1393 } else if (hub->descriptor->bNbrPorts == 0) {
1394 message = "hub doesn't have any ports!";
1400 * Accumulate wHubDelay + 40ns for every hub in the tree of devices.
1401 * The resulting value will be used for SetIsochDelay() request.
1403 if (hub_is_superspeed(hdev) || hub_is_superspeedplus(hdev)) {
1404 u32 delay = __le16_to_cpu(hub->descriptor->u.ss.wHubDelay);
1407 delay += hdev->parent->hub_delay;
1409 delay += USB_TP_TRANSMISSION_DELAY;
1410 hdev->hub_delay = min_t(u32, delay, USB_TP_TRANSMISSION_DELAY_MAX);
1413 maxchild = hub->descriptor->bNbrPorts;
1414 dev_info(hub_dev, "%d port%s detected\n", maxchild,
1415 (maxchild == 1) ? "" : "s");
1417 hub->ports = kcalloc(maxchild, sizeof(struct usb_port *), GFP_KERNEL);
1423 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1424 if (hub_is_superspeed(hdev)) {
1432 /* FIXME for USB 3.0, skip for now */
1433 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1434 !(hub_is_superspeed(hdev))) {
1435 char portstr[USB_MAXCHILDREN + 1];
1437 for (i = 0; i < maxchild; i++)
1438 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1439 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1441 portstr[maxchild] = 0;
1442 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1444 dev_dbg(hub_dev, "standalone hub\n");
1446 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1447 case HUB_CHAR_COMMON_LPSM:
1448 dev_dbg(hub_dev, "ganged power switching\n");
1450 case HUB_CHAR_INDV_PORT_LPSM:
1451 dev_dbg(hub_dev, "individual port power switching\n");
1453 case HUB_CHAR_NO_LPSM:
1455 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1459 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1460 case HUB_CHAR_COMMON_OCPM:
1461 dev_dbg(hub_dev, "global over-current protection\n");
1463 case HUB_CHAR_INDV_PORT_OCPM:
1464 dev_dbg(hub_dev, "individual port over-current protection\n");
1466 case HUB_CHAR_NO_OCPM:
1468 dev_dbg(hub_dev, "no over-current protection\n");
1472 spin_lock_init(&hub->tt.lock);
1473 INIT_LIST_HEAD(&hub->tt.clear_list);
1474 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1475 switch (hdev->descriptor.bDeviceProtocol) {
1478 case USB_HUB_PR_HS_SINGLE_TT:
1479 dev_dbg(hub_dev, "Single TT\n");
1482 case USB_HUB_PR_HS_MULTI_TT:
1483 ret = usb_set_interface(hdev, 0, 1);
1485 dev_dbg(hub_dev, "TT per port\n");
1488 dev_err(hub_dev, "Using single TT (err %d)\n",
1493 /* USB 3.0 hubs don't have a TT */
1496 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1497 hdev->descriptor.bDeviceProtocol);
1501 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1502 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1503 case HUB_TTTT_8_BITS:
1504 if (hdev->descriptor.bDeviceProtocol != 0) {
1505 hub->tt.think_time = 666;
1506 dev_dbg(hub_dev, "TT requires at most %d "
1507 "FS bit times (%d ns)\n",
1508 8, hub->tt.think_time);
1511 case HUB_TTTT_16_BITS:
1512 hub->tt.think_time = 666 * 2;
1513 dev_dbg(hub_dev, "TT requires at most %d "
1514 "FS bit times (%d ns)\n",
1515 16, hub->tt.think_time);
1517 case HUB_TTTT_24_BITS:
1518 hub->tt.think_time = 666 * 3;
1519 dev_dbg(hub_dev, "TT requires at most %d "
1520 "FS bit times (%d ns)\n",
1521 24, hub->tt.think_time);
1523 case HUB_TTTT_32_BITS:
1524 hub->tt.think_time = 666 * 4;
1525 dev_dbg(hub_dev, "TT requires at most %d "
1526 "FS bit times (%d ns)\n",
1527 32, hub->tt.think_time);
1531 /* probe() zeroes hub->indicator[] */
1532 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1533 hub->has_indicators = 1;
1534 dev_dbg(hub_dev, "Port indicators are supported\n");
1537 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1538 hub->descriptor->bPwrOn2PwrGood * 2);
1540 /* power budgeting mostly matters with bus-powered hubs,
1541 * and battery-powered root hubs (may provide just 8 mA).
1543 ret = usb_get_std_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1545 message = "can't get hub status";
1548 hcd = bus_to_hcd(hdev->bus);
1549 if (hdev == hdev->bus->root_hub) {
1550 if (hcd->power_budget > 0)
1551 hdev->bus_mA = hcd->power_budget;
1553 hdev->bus_mA = full_load * maxchild;
1554 if (hdev->bus_mA >= full_load)
1555 hub->mA_per_port = full_load;
1557 hub->mA_per_port = hdev->bus_mA;
1558 hub->limited_power = 1;
1560 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1561 int remaining = hdev->bus_mA -
1562 hub->descriptor->bHubContrCurrent;
1564 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1565 hub->descriptor->bHubContrCurrent);
1566 hub->limited_power = 1;
1568 if (remaining < maxchild * unit_load)
1570 "insufficient power available "
1571 "to use all downstream ports\n");
1572 hub->mA_per_port = unit_load; /* 7.2.1 */
1574 } else { /* Self-powered external hub */
1575 /* FIXME: What about battery-powered external hubs that
1576 * provide less current per port? */
1577 hub->mA_per_port = full_load;
1579 if (hub->mA_per_port < full_load)
1580 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1583 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1585 message = "can't get hub status";
1589 /* local power status reports aren't always correct */
1590 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1591 dev_dbg(hub_dev, "local power source is %s\n",
1592 (hubstatus & HUB_STATUS_LOCAL_POWER)
1593 ? "lost (inactive)" : "good");
1595 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1596 dev_dbg(hub_dev, "%sover-current condition exists\n",
1597 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1599 /* set up the interrupt endpoint
1600 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1601 * bytes as USB2.0[11.12.3] says because some hubs are known
1602 * to send more data (and thus cause overflow). For root hubs,
1603 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1604 * to be big enough for at least USB_MAXCHILDREN ports. */
1605 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1606 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1608 if (maxp > sizeof(*hub->buffer))
1609 maxp = sizeof(*hub->buffer);
1611 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1617 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1618 hub, endpoint->bInterval);
1620 /* maybe cycle the hub leds */
1621 if (hub->has_indicators && blinkenlights)
1622 hub->indicator[0] = INDICATOR_CYCLE;
1624 mutex_lock(&usb_port_peer_mutex);
1625 for (i = 0; i < maxchild; i++) {
1626 ret = usb_hub_create_port_device(hub, i + 1);
1628 dev_err(hub->intfdev,
1629 "couldn't create port%d device.\n", i + 1);
1634 for (i = 0; i < hdev->maxchild; i++) {
1635 struct usb_port *port_dev = hub->ports[i];
1637 pm_runtime_put(&port_dev->dev);
1640 mutex_unlock(&usb_port_peer_mutex);
1644 /* Update the HCD's internal representation of this hub before hub_wq
1645 * starts getting port status changes for devices under the hub.
1647 if (hcd->driver->update_hub_device) {
1648 ret = hcd->driver->update_hub_device(hcd, hdev,
1649 &hub->tt, GFP_KERNEL);
1651 message = "can't update HCD hub info";
1656 usb_hub_adjust_deviceremovable(hdev, hub->descriptor);
1658 hub_activate(hub, HUB_INIT);
1662 dev_err(hub_dev, "config failed, %s (err %d)\n",
1664 /* hub_disconnect() frees urb and descriptor */
1668 static void hub_release(struct kref *kref)
1670 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1672 usb_put_dev(hub->hdev);
1673 usb_put_intf(to_usb_interface(hub->intfdev));
1677 static unsigned highspeed_hubs;
1679 static void hub_disconnect(struct usb_interface *intf)
1681 struct usb_hub *hub = usb_get_intfdata(intf);
1682 struct usb_device *hdev = interface_to_usbdev(intf);
1686 * Stop adding new hub events. We do not want to block here and thus
1687 * will not try to remove any pending work item.
1689 hub->disconnected = 1;
1691 /* Disconnect all children and quiesce the hub */
1693 hub_quiesce(hub, HUB_DISCONNECT);
1695 mutex_lock(&usb_port_peer_mutex);
1697 /* Avoid races with recursively_mark_NOTATTACHED() */
1698 spin_lock_irq(&device_state_lock);
1699 port1 = hdev->maxchild;
1701 usb_set_intfdata(intf, NULL);
1702 spin_unlock_irq(&device_state_lock);
1704 for (; port1 > 0; --port1)
1705 usb_hub_remove_port_device(hub, port1);
1707 mutex_unlock(&usb_port_peer_mutex);
1709 if (hub->hdev->speed == USB_SPEED_HIGH)
1712 usb_free_urb(hub->urb);
1714 kfree(hub->descriptor);
1718 pm_suspend_ignore_children(&intf->dev, false);
1720 if (hub->quirk_disable_autosuspend)
1721 usb_autopm_put_interface(intf);
1723 kref_put(&hub->kref, hub_release);
1726 static bool hub_descriptor_is_sane(struct usb_host_interface *desc)
1728 /* Some hubs have a subclass of 1, which AFAICT according to the */
1729 /* specs is not defined, but it works */
1730 if (desc->desc.bInterfaceSubClass != 0 &&
1731 desc->desc.bInterfaceSubClass != 1)
1734 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1735 if (desc->desc.bNumEndpoints != 1)
1738 /* If the first endpoint is not interrupt IN, we'd better punt! */
1739 if (!usb_endpoint_is_int_in(&desc->endpoint[0].desc))
1745 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1747 struct usb_host_interface *desc;
1748 struct usb_device *hdev;
1749 struct usb_hub *hub;
1751 desc = intf->cur_altsetting;
1752 hdev = interface_to_usbdev(intf);
1755 * Set default autosuspend delay as 0 to speedup bus suspend,
1756 * based on the below considerations:
1758 * - Unlike other drivers, the hub driver does not rely on the
1759 * autosuspend delay to provide enough time to handle a wakeup
1760 * event, and the submitted status URB is just to check future
1761 * change on hub downstream ports, so it is safe to do it.
1763 * - The patch might cause one or more auto supend/resume for
1764 * below very rare devices when they are plugged into hub
1767 * devices having trouble initializing, and disconnect
1768 * themselves from the bus and then reconnect a second
1771 * devices just for downloading firmware, and disconnects
1772 * themselves after completing it
1774 * For these quite rare devices, their drivers may change the
1775 * autosuspend delay of their parent hub in the probe() to one
1776 * appropriate value to avoid the subtle problem if someone
1779 * - The patch may cause one or more auto suspend/resume on
1780 * hub during running 'lsusb', but it is probably too
1781 * infrequent to worry about.
1783 * - Change autosuspend delay of hub can avoid unnecessary auto
1784 * suspend timer for hub, also may decrease power consumption
1787 * - If user has indicated to prevent autosuspend by passing
1788 * usbcore.autosuspend = -1 then keep autosuspend disabled.
1791 if (hdev->dev.power.autosuspend_delay >= 0)
1792 pm_runtime_set_autosuspend_delay(&hdev->dev, 0);
1796 * Hubs have proper suspend/resume support, except for root hubs
1797 * where the controller driver doesn't have bus_suspend and
1798 * bus_resume methods.
1800 if (hdev->parent) { /* normal device */
1801 usb_enable_autosuspend(hdev);
1802 } else { /* root hub */
1803 const struct hc_driver *drv = bus_to_hcd(hdev->bus)->driver;
1805 if (drv->bus_suspend && drv->bus_resume)
1806 usb_enable_autosuspend(hdev);
1809 if (hdev->level == MAX_TOPO_LEVEL) {
1811 "Unsupported bus topology: hub nested too deep\n");
1815 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1817 dev_warn(&intf->dev, "ignoring external hub\n");
1822 if (!hub_descriptor_is_sane(desc)) {
1823 dev_err(&intf->dev, "bad descriptor, ignoring hub\n");
1827 /* We found a hub */
1828 dev_info(&intf->dev, "USB hub found\n");
1830 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1834 kref_init(&hub->kref);
1835 hub->intfdev = &intf->dev;
1837 INIT_DELAYED_WORK(&hub->leds, led_work);
1838 INIT_DELAYED_WORK(&hub->init_work, NULL);
1839 INIT_WORK(&hub->events, hub_event);
1843 usb_set_intfdata(intf, hub);
1844 intf->needs_remote_wakeup = 1;
1845 pm_suspend_ignore_children(&intf->dev, true);
1847 if (hdev->speed == USB_SPEED_HIGH)
1850 if (id->driver_info & HUB_QUIRK_CHECK_PORT_AUTOSUSPEND)
1851 hub->quirk_check_port_auto_suspend = 1;
1853 if (id->driver_info & HUB_QUIRK_DISABLE_AUTOSUSPEND) {
1854 hub->quirk_disable_autosuspend = 1;
1855 usb_autopm_get_interface_no_resume(intf);
1858 if (hub_configure(hub, &desc->endpoint[0].desc) >= 0)
1861 hub_disconnect(intf);
1866 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1868 struct usb_device *hdev = interface_to_usbdev(intf);
1869 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1871 /* assert ifno == 0 (part of hub spec) */
1873 case USBDEVFS_HUB_PORTINFO: {
1874 struct usbdevfs_hub_portinfo *info = user_data;
1877 spin_lock_irq(&device_state_lock);
1878 if (hdev->devnum <= 0)
1881 info->nports = hdev->maxchild;
1882 for (i = 0; i < info->nports; i++) {
1883 if (hub->ports[i]->child == NULL)
1887 hub->ports[i]->child->devnum;
1890 spin_unlock_irq(&device_state_lock);
1892 return info->nports + 1;
1901 * Allow user programs to claim ports on a hub. When a device is attached
1902 * to one of these "claimed" ports, the program will "own" the device.
1904 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1905 struct usb_dev_state ***ppowner)
1907 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1909 if (hdev->state == USB_STATE_NOTATTACHED)
1911 if (port1 == 0 || port1 > hdev->maxchild)
1914 /* Devices not managed by the hub driver
1915 * will always have maxchild equal to 0.
1917 *ppowner = &(hub->ports[port1 - 1]->port_owner);
1921 /* In the following three functions, the caller must hold hdev's lock */
1922 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
1923 struct usb_dev_state *owner)
1926 struct usb_dev_state **powner;
1928 rc = find_port_owner(hdev, port1, &powner);
1936 EXPORT_SYMBOL_GPL(usb_hub_claim_port);
1938 int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
1939 struct usb_dev_state *owner)
1942 struct usb_dev_state **powner;
1944 rc = find_port_owner(hdev, port1, &powner);
1947 if (*powner != owner)
1952 EXPORT_SYMBOL_GPL(usb_hub_release_port);
1954 void usb_hub_release_all_ports(struct usb_device *hdev, struct usb_dev_state *owner)
1956 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1959 for (n = 0; n < hdev->maxchild; n++) {
1960 if (hub->ports[n]->port_owner == owner)
1961 hub->ports[n]->port_owner = NULL;
1966 /* The caller must hold udev's lock */
1967 bool usb_device_is_owned(struct usb_device *udev)
1969 struct usb_hub *hub;
1971 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1973 hub = usb_hub_to_struct_hub(udev->parent);
1974 return !!hub->ports[udev->portnum - 1]->port_owner;
1977 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1979 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
1982 for (i = 0; i < udev->maxchild; ++i) {
1983 if (hub->ports[i]->child)
1984 recursively_mark_NOTATTACHED(hub->ports[i]->child);
1986 if (udev->state == USB_STATE_SUSPENDED)
1987 udev->active_duration -= jiffies;
1988 udev->state = USB_STATE_NOTATTACHED;
1992 * usb_set_device_state - change a device's current state (usbcore, hcds)
1993 * @udev: pointer to device whose state should be changed
1994 * @new_state: new state value to be stored
1996 * udev->state is _not_ fully protected by the device lock. Although
1997 * most transitions are made only while holding the lock, the state can
1998 * can change to USB_STATE_NOTATTACHED at almost any time. This
1999 * is so that devices can be marked as disconnected as soon as possible,
2000 * without having to wait for any semaphores to be released. As a result,
2001 * all changes to any device's state must be protected by the
2002 * device_state_lock spinlock.
2004 * Once a device has been added to the device tree, all changes to its state
2005 * should be made using this routine. The state should _not_ be set directly.
2007 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
2008 * Otherwise udev->state is set to new_state, and if new_state is
2009 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
2010 * to USB_STATE_NOTATTACHED.
2012 void usb_set_device_state(struct usb_device *udev,
2013 enum usb_device_state new_state)
2015 unsigned long flags;
2018 spin_lock_irqsave(&device_state_lock, flags);
2019 if (udev->state == USB_STATE_NOTATTACHED)
2021 else if (new_state != USB_STATE_NOTATTACHED) {
2023 /* root hub wakeup capabilities are managed out-of-band
2024 * and may involve silicon errata ... ignore them here.
2027 if (udev->state == USB_STATE_SUSPENDED
2028 || new_state == USB_STATE_SUSPENDED)
2029 ; /* No change to wakeup settings */
2030 else if (new_state == USB_STATE_CONFIGURED)
2031 wakeup = (udev->quirks &
2032 USB_QUIRK_IGNORE_REMOTE_WAKEUP) ? 0 :
2033 udev->actconfig->desc.bmAttributes &
2034 USB_CONFIG_ATT_WAKEUP;
2038 if (udev->state == USB_STATE_SUSPENDED &&
2039 new_state != USB_STATE_SUSPENDED)
2040 udev->active_duration -= jiffies;
2041 else if (new_state == USB_STATE_SUSPENDED &&
2042 udev->state != USB_STATE_SUSPENDED)
2043 udev->active_duration += jiffies;
2044 udev->state = new_state;
2046 recursively_mark_NOTATTACHED(udev);
2047 spin_unlock_irqrestore(&device_state_lock, flags);
2049 device_set_wakeup_capable(&udev->dev, wakeup);
2051 EXPORT_SYMBOL_GPL(usb_set_device_state);
2054 * Choose a device number.
2056 * Device numbers are used as filenames in usbfs. On USB-1.1 and
2057 * USB-2.0 buses they are also used as device addresses, however on
2058 * USB-3.0 buses the address is assigned by the controller hardware
2059 * and it usually is not the same as the device number.
2061 * WUSB devices are simple: they have no hubs behind, so the mapping
2062 * device <-> virtual port number becomes 1:1. Why? to simplify the
2063 * life of the device connection logic in
2064 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
2065 * handshake we need to assign a temporary address in the unauthorized
2066 * space. For simplicity we use the first virtual port number found to
2067 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
2068 * and that becomes it's address [X < 128] or its unauthorized address
2071 * We add 1 as an offset to the one-based USB-stack port number
2072 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
2073 * 0 is reserved by USB for default address; (b) Linux's USB stack
2074 * uses always #1 for the root hub of the controller. So USB stack's
2075 * port #1, which is wusb virtual-port #0 has address #2.
2077 * Devices connected under xHCI are not as simple. The host controller
2078 * supports virtualization, so the hardware assigns device addresses and
2079 * the HCD must setup data structures before issuing a set address
2080 * command to the hardware.
2082 static void choose_devnum(struct usb_device *udev)
2085 struct usb_bus *bus = udev->bus;
2087 /* be safe when more hub events are proceed in parallel */
2088 mutex_lock(&bus->devnum_next_mutex);
2090 devnum = udev->portnum + 1;
2091 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
2093 /* Try to allocate the next devnum beginning at
2094 * bus->devnum_next. */
2095 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
2098 devnum = find_next_zero_bit(bus->devmap.devicemap,
2100 bus->devnum_next = (devnum >= 127 ? 1 : devnum + 1);
2103 set_bit(devnum, bus->devmap.devicemap);
2104 udev->devnum = devnum;
2106 mutex_unlock(&bus->devnum_next_mutex);
2109 static void release_devnum(struct usb_device *udev)
2111 if (udev->devnum > 0) {
2112 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
2117 static void update_devnum(struct usb_device *udev, int devnum)
2119 /* The address for a WUSB device is managed by wusbcore. */
2121 udev->devnum = devnum;
2124 static void hub_free_dev(struct usb_device *udev)
2126 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2128 /* Root hubs aren't real devices, so don't free HCD resources */
2129 if (hcd->driver->free_dev && udev->parent)
2130 hcd->driver->free_dev(hcd, udev);
2133 static void hub_disconnect_children(struct usb_device *udev)
2135 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2138 /* Free up all the children before we remove this device */
2139 for (i = 0; i < udev->maxchild; i++) {
2140 if (hub->ports[i]->child)
2141 usb_disconnect(&hub->ports[i]->child);
2146 * usb_disconnect - disconnect a device (usbcore-internal)
2147 * @pdev: pointer to device being disconnected
2148 * Context: !in_interrupt ()
2150 * Something got disconnected. Get rid of it and all of its children.
2152 * If *pdev is a normal device then the parent hub must already be locked.
2153 * If *pdev is a root hub then the caller must hold the usb_bus_idr_lock,
2154 * which protects the set of root hubs as well as the list of buses.
2156 * Only hub drivers (including virtual root hub drivers for host
2157 * controllers) should ever call this.
2159 * This call is synchronous, and may not be used in an interrupt context.
2161 void usb_disconnect(struct usb_device **pdev)
2163 struct usb_port *port_dev = NULL;
2164 struct usb_device *udev = *pdev;
2165 struct usb_hub *hub = NULL;
2168 /* mark the device as inactive, so any further urb submissions for
2169 * this device (and any of its children) will fail immediately.
2170 * this quiesces everything except pending urbs.
2172 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2173 dev_info(&udev->dev, "USB disconnect, device number %d\n",
2177 * Ensure that the pm runtime code knows that the USB device
2178 * is in the process of being disconnected.
2180 pm_runtime_barrier(&udev->dev);
2182 usb_lock_device(udev);
2184 hub_disconnect_children(udev);
2186 /* deallocate hcd/hardware state ... nuking all pending urbs and
2187 * cleaning up all state associated with the current configuration
2188 * so that the hardware is now fully quiesced.
2190 dev_dbg(&udev->dev, "unregistering device\n");
2191 usb_disable_device(udev, 0);
2192 usb_hcd_synchronize_unlinks(udev);
2195 port1 = udev->portnum;
2196 hub = usb_hub_to_struct_hub(udev->parent);
2197 port_dev = hub->ports[port1 - 1];
2199 sysfs_remove_link(&udev->dev.kobj, "port");
2200 sysfs_remove_link(&port_dev->dev.kobj, "device");
2203 * As usb_port_runtime_resume() de-references udev, make
2204 * sure no resumes occur during removal
2206 if (!test_and_set_bit(port1, hub->child_usage_bits))
2207 pm_runtime_get_sync(&port_dev->dev);
2210 usb_remove_ep_devs(&udev->ep0);
2211 usb_unlock_device(udev);
2213 /* Unregister the device. The device driver is responsible
2214 * for de-configuring the device and invoking the remove-device
2215 * notifier chain (used by usbfs and possibly others).
2217 device_del(&udev->dev);
2219 /* Free the device number and delete the parent's children[]
2220 * (or root_hub) pointer.
2222 release_devnum(udev);
2224 /* Avoid races with recursively_mark_NOTATTACHED() */
2225 spin_lock_irq(&device_state_lock);
2227 spin_unlock_irq(&device_state_lock);
2229 if (port_dev && test_and_clear_bit(port1, hub->child_usage_bits))
2230 pm_runtime_put(&port_dev->dev);
2234 put_device(&udev->dev);
2237 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2238 static void show_string(struct usb_device *udev, char *id, char *string)
2242 dev_info(&udev->dev, "%s: %s\n", id, string);
2245 static void announce_device(struct usb_device *udev)
2247 u16 bcdDevice = le16_to_cpu(udev->descriptor.bcdDevice);
2249 dev_info(&udev->dev,
2250 "New USB device found, idVendor=%04x, idProduct=%04x, bcdDevice=%2x.%02x\n",
2251 le16_to_cpu(udev->descriptor.idVendor),
2252 le16_to_cpu(udev->descriptor.idProduct),
2253 bcdDevice >> 8, bcdDevice & 0xff);
2254 dev_info(&udev->dev,
2255 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2256 udev->descriptor.iManufacturer,
2257 udev->descriptor.iProduct,
2258 udev->descriptor.iSerialNumber);
2259 show_string(udev, "Product", udev->product);
2260 show_string(udev, "Manufacturer", udev->manufacturer);
2261 show_string(udev, "SerialNumber", udev->serial);
2264 static inline void announce_device(struct usb_device *udev) { }
2269 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2270 * @udev: newly addressed device (in ADDRESS state)
2272 * Finish enumeration for On-The-Go devices
2274 * Return: 0 if successful. A negative error code otherwise.
2276 static int usb_enumerate_device_otg(struct usb_device *udev)
2280 #ifdef CONFIG_USB_OTG
2282 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2283 * to wake us after we've powered off VBUS; and HNP, switching roles
2284 * "host" to "peripheral". The OTG descriptor helps figure this out.
2286 if (!udev->bus->is_b_host
2288 && udev->parent == udev->bus->root_hub) {
2289 struct usb_otg_descriptor *desc = NULL;
2290 struct usb_bus *bus = udev->bus;
2291 unsigned port1 = udev->portnum;
2293 /* descriptor may appear anywhere in config */
2294 err = __usb_get_extra_descriptor(udev->rawdescriptors[0],
2295 le16_to_cpu(udev->config[0].desc.wTotalLength),
2296 USB_DT_OTG, (void **) &desc, sizeof(*desc));
2297 if (err || !(desc->bmAttributes & USB_OTG_HNP))
2300 dev_info(&udev->dev, "Dual-Role OTG device on %sHNP port\n",
2301 (port1 == bus->otg_port) ? "" : "non-");
2303 /* enable HNP before suspend, it's simpler */
2304 if (port1 == bus->otg_port) {
2305 bus->b_hnp_enable = 1;
2306 err = usb_control_msg(udev,
2307 usb_sndctrlpipe(udev, 0),
2308 USB_REQ_SET_FEATURE, 0,
2309 USB_DEVICE_B_HNP_ENABLE,
2311 USB_CTRL_SET_TIMEOUT);
2314 * OTG MESSAGE: report errors here,
2315 * customize to match your product.
2317 dev_err(&udev->dev, "can't set HNP mode: %d\n",
2319 bus->b_hnp_enable = 0;
2321 } else if (desc->bLength == sizeof
2322 (struct usb_otg_descriptor)) {
2323 /* Set a_alt_hnp_support for legacy otg device */
2324 err = usb_control_msg(udev,
2325 usb_sndctrlpipe(udev, 0),
2326 USB_REQ_SET_FEATURE, 0,
2327 USB_DEVICE_A_ALT_HNP_SUPPORT,
2329 USB_CTRL_SET_TIMEOUT);
2332 "set a_alt_hnp_support failed: %d\n",
2342 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2343 * @udev: newly addressed device (in ADDRESS state)
2345 * This is only called by usb_new_device() and usb_authorize_device()
2346 * and FIXME -- all comments that apply to them apply here wrt to
2349 * If the device is WUSB and not authorized, we don't attempt to read
2350 * the string descriptors, as they will be errored out by the device
2351 * until it has been authorized.
2353 * Return: 0 if successful. A negative error code otherwise.
2355 static int usb_enumerate_device(struct usb_device *udev)
2358 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2360 if (udev->config == NULL) {
2361 err = usb_get_configuration(udev);
2364 dev_err(&udev->dev, "can't read configurations, error %d\n",
2370 /* read the standard strings and cache them if present */
2371 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
2372 udev->manufacturer = usb_cache_string(udev,
2373 udev->descriptor.iManufacturer);
2374 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
2376 err = usb_enumerate_device_otg(udev);
2380 if (IS_ENABLED(CONFIG_USB_OTG_WHITELIST) && hcd->tpl_support &&
2381 !is_targeted(udev)) {
2382 /* Maybe it can talk to us, though we can't talk to it.
2383 * (Includes HNP test device.)
2385 if (IS_ENABLED(CONFIG_USB_OTG) && (udev->bus->b_hnp_enable
2386 || udev->bus->is_b_host)) {
2387 err = usb_port_suspend(udev, PMSG_AUTO_SUSPEND);
2389 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
2394 usb_detect_interface_quirks(udev);
2399 static void set_usb_port_removable(struct usb_device *udev)
2401 struct usb_device *hdev = udev->parent;
2402 struct usb_hub *hub;
2403 u8 port = udev->portnum;
2404 u16 wHubCharacteristics;
2405 bool removable = true;
2410 hub = usb_hub_to_struct_hub(udev->parent);
2413 * If the platform firmware has provided information about a port,
2414 * use that to determine whether it's removable.
2416 switch (hub->ports[udev->portnum - 1]->connect_type) {
2417 case USB_PORT_CONNECT_TYPE_HOT_PLUG:
2418 udev->removable = USB_DEVICE_REMOVABLE;
2420 case USB_PORT_CONNECT_TYPE_HARD_WIRED:
2421 case USB_PORT_NOT_USED:
2422 udev->removable = USB_DEVICE_FIXED;
2429 * Otherwise, check whether the hub knows whether a port is removable
2432 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2434 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
2437 if (hub_is_superspeed(hdev)) {
2438 if (le16_to_cpu(hub->descriptor->u.ss.DeviceRemovable)
2442 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
2447 udev->removable = USB_DEVICE_REMOVABLE;
2449 udev->removable = USB_DEVICE_FIXED;
2454 * usb_new_device - perform initial device setup (usbcore-internal)
2455 * @udev: newly addressed device (in ADDRESS state)
2457 * This is called with devices which have been detected but not fully
2458 * enumerated. The device descriptor is available, but not descriptors
2459 * for any device configuration. The caller must have locked either
2460 * the parent hub (if udev is a normal device) or else the
2461 * usb_bus_idr_lock (if udev is a root hub). The parent's pointer to
2462 * udev has already been installed, but udev is not yet visible through
2463 * sysfs or other filesystem code.
2465 * This call is synchronous, and may not be used in an interrupt context.
2467 * Only the hub driver or root-hub registrar should ever call this.
2469 * Return: Whether the device is configured properly or not. Zero if the
2470 * interface was registered with the driver core; else a negative errno
2474 int usb_new_device(struct usb_device *udev)
2479 /* Initialize non-root-hub device wakeup to disabled;
2480 * device (un)configuration controls wakeup capable
2481 * sysfs power/wakeup controls wakeup enabled/disabled
2483 device_init_wakeup(&udev->dev, 0);
2486 /* Tell the runtime-PM framework the device is active */
2487 pm_runtime_set_active(&udev->dev);
2488 pm_runtime_get_noresume(&udev->dev);
2489 pm_runtime_use_autosuspend(&udev->dev);
2490 pm_runtime_enable(&udev->dev);
2492 /* By default, forbid autosuspend for all devices. It will be
2493 * allowed for hubs during binding.
2495 usb_disable_autosuspend(udev);
2497 err = usb_enumerate_device(udev); /* Read descriptors */
2500 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
2501 udev->devnum, udev->bus->busnum,
2502 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2503 /* export the usbdev device-node for libusb */
2504 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
2505 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2507 /* Tell the world! */
2508 announce_device(udev);
2511 add_device_randomness(udev->serial, strlen(udev->serial));
2513 add_device_randomness(udev->product, strlen(udev->product));
2514 if (udev->manufacturer)
2515 add_device_randomness(udev->manufacturer,
2516 strlen(udev->manufacturer));
2518 device_enable_async_suspend(&udev->dev);
2520 /* check whether the hub or firmware marks this port as non-removable */
2522 set_usb_port_removable(udev);
2524 /* Register the device. The device driver is responsible
2525 * for configuring the device and invoking the add-device
2526 * notifier chain (used by usbfs and possibly others).
2528 err = device_add(&udev->dev);
2530 dev_err(&udev->dev, "can't device_add, error %d\n", err);
2534 /* Create link files between child device and usb port device. */
2536 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2537 int port1 = udev->portnum;
2538 struct usb_port *port_dev = hub->ports[port1 - 1];
2540 err = sysfs_create_link(&udev->dev.kobj,
2541 &port_dev->dev.kobj, "port");
2545 err = sysfs_create_link(&port_dev->dev.kobj,
2546 &udev->dev.kobj, "device");
2548 sysfs_remove_link(&udev->dev.kobj, "port");
2552 if (!test_and_set_bit(port1, hub->child_usage_bits))
2553 pm_runtime_get_sync(&port_dev->dev);
2556 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
2557 usb_mark_last_busy(udev);
2558 pm_runtime_put_sync_autosuspend(&udev->dev);
2562 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2563 pm_runtime_disable(&udev->dev);
2564 pm_runtime_set_suspended(&udev->dev);
2570 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2571 * @usb_dev: USB device
2573 * Move the USB device to a very basic state where interfaces are disabled
2574 * and the device is in fact unconfigured and unusable.
2576 * We share a lock (that we have) with device_del(), so we need to
2581 int usb_deauthorize_device(struct usb_device *usb_dev)
2583 usb_lock_device(usb_dev);
2584 if (usb_dev->authorized == 0)
2585 goto out_unauthorized;
2587 usb_dev->authorized = 0;
2588 usb_set_configuration(usb_dev, -1);
2591 usb_unlock_device(usb_dev);
2596 int usb_authorize_device(struct usb_device *usb_dev)
2600 usb_lock_device(usb_dev);
2601 if (usb_dev->authorized == 1)
2602 goto out_authorized;
2604 result = usb_autoresume_device(usb_dev);
2606 dev_err(&usb_dev->dev,
2607 "can't autoresume for authorization: %d\n", result);
2608 goto error_autoresume;
2611 if (usb_dev->wusb) {
2612 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2614 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2615 "authorization: %d\n", result);
2616 goto error_device_descriptor;
2620 usb_dev->authorized = 1;
2621 /* Choose and set the configuration. This registers the interfaces
2622 * with the driver core and lets interface drivers bind to them.
2624 c = usb_choose_configuration(usb_dev);
2626 result = usb_set_configuration(usb_dev, c);
2628 dev_err(&usb_dev->dev,
2629 "can't set config #%d, error %d\n", c, result);
2630 /* This need not be fatal. The user can try to
2631 * set other configurations. */
2634 dev_info(&usb_dev->dev, "authorized to connect\n");
2636 error_device_descriptor:
2637 usb_autosuspend_device(usb_dev);
2640 usb_unlock_device(usb_dev); /* complements locktree */
2645 * Return 1 if port speed is SuperSpeedPlus, 0 otherwise
2646 * check it from the link protocol field of the current speed ID attribute.
2647 * current speed ID is got from ext port status request. Sublink speed attribute
2648 * table is returned with the hub BOS SSP device capability descriptor
2650 static int port_speed_is_ssp(struct usb_device *hdev, int speed_id)
2655 struct usb_ssp_cap_descriptor *ssp_cap = hdev->bos->ssp_cap;
2660 ssa_count = le32_to_cpu(ssp_cap->bmAttributes) &
2661 USB_SSP_SUBLINK_SPEED_ATTRIBS;
2663 for (i = 0; i <= ssa_count; i++) {
2664 ss_attr = le32_to_cpu(ssp_cap->bmSublinkSpeedAttr[i]);
2665 if (speed_id == (ss_attr & USB_SSP_SUBLINK_SPEED_SSID))
2666 return !!(ss_attr & USB_SSP_SUBLINK_SPEED_LP);
2671 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2672 static unsigned hub_is_wusb(struct usb_hub *hub)
2674 struct usb_hcd *hcd;
2675 if (hub->hdev->parent != NULL) /* not a root hub? */
2677 hcd = bus_to_hcd(hub->hdev->bus);
2678 return hcd->wireless;
2682 #define PORT_RESET_TRIES 5
2683 #define SET_ADDRESS_TRIES 2
2684 #define GET_DESCRIPTOR_TRIES 2
2685 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2686 #define USE_NEW_SCHEME(i, scheme) ((i) / 2 == (int)(scheme))
2688 #define HUB_ROOT_RESET_TIME 60 /* times are in msec */
2689 #define HUB_SHORT_RESET_TIME 10
2690 #define HUB_BH_RESET_TIME 50
2691 #define HUB_LONG_RESET_TIME 200
2692 #define HUB_RESET_TIMEOUT 800
2695 * "New scheme" enumeration causes an extra state transition to be
2696 * exposed to an xhci host and causes USB3 devices to receive control
2697 * commands in the default state. This has been seen to cause
2698 * enumeration failures, so disable this enumeration scheme for USB3
2701 static bool use_new_scheme(struct usb_device *udev, int retry,
2702 struct usb_port *port_dev)
2704 int old_scheme_first_port =
2705 port_dev->quirks & USB_PORT_QUIRK_OLD_SCHEME;
2707 if (udev->speed >= USB_SPEED_SUPER)
2710 return USE_NEW_SCHEME(retry, old_scheme_first_port || old_scheme_first);
2713 /* Is a USB 3.0 port in the Inactive or Compliance Mode state?
2714 * Port worm reset is required to recover
2716 static bool hub_port_warm_reset_required(struct usb_hub *hub, int port1,
2721 if (!hub_is_superspeed(hub->hdev))
2724 if (test_bit(port1, hub->warm_reset_bits))
2727 link_state = portstatus & USB_PORT_STAT_LINK_STATE;
2728 return link_state == USB_SS_PORT_LS_SS_INACTIVE
2729 || link_state == USB_SS_PORT_LS_COMP_MOD;
2732 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2733 struct usb_device *udev, unsigned int delay, bool warm)
2735 int delay_time, ret;
2738 u32 ext_portstatus = 0;
2740 for (delay_time = 0;
2741 delay_time < HUB_RESET_TIMEOUT;
2742 delay_time += delay) {
2743 /* wait to give the device a chance to reset */
2746 /* read and decode port status */
2747 if (hub_is_superspeedplus(hub->hdev))
2748 ret = hub_ext_port_status(hub, port1,
2749 HUB_EXT_PORT_STATUS,
2750 &portstatus, &portchange,
2753 ret = hub_port_status(hub, port1, &portstatus,
2759 * The port state is unknown until the reset completes.
2761 * On top of that, some chips may require additional time
2762 * to re-establish a connection after the reset is complete,
2763 * so also wait for the connection to be re-established.
2765 if (!(portstatus & USB_PORT_STAT_RESET) &&
2766 (portstatus & USB_PORT_STAT_CONNECTION))
2769 /* switch to the long delay after two short delay failures */
2770 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2771 delay = HUB_LONG_RESET_TIME;
2773 dev_dbg(&hub->ports[port1 - 1]->dev,
2774 "not %sreset yet, waiting %dms\n",
2775 warm ? "warm " : "", delay);
2778 if ((portstatus & USB_PORT_STAT_RESET))
2781 if (hub_port_warm_reset_required(hub, port1, portstatus))
2784 /* Device went away? */
2785 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2788 /* Retry if connect change is set but status is still connected.
2789 * A USB 3.0 connection may bounce if multiple warm resets were issued,
2790 * but the device may have successfully re-connected. Ignore it.
2792 if (!hub_is_superspeed(hub->hdev) &&
2793 (portchange & USB_PORT_STAT_C_CONNECTION)) {
2794 usb_clear_port_feature(hub->hdev, port1,
2795 USB_PORT_FEAT_C_CONNECTION);
2799 if (!(portstatus & USB_PORT_STAT_ENABLE))
2805 if (hub_is_superspeedplus(hub->hdev)) {
2806 /* extended portstatus Rx and Tx lane count are zero based */
2807 udev->rx_lanes = USB_EXT_PORT_RX_LANES(ext_portstatus) + 1;
2808 udev->tx_lanes = USB_EXT_PORT_TX_LANES(ext_portstatus) + 1;
2813 if (hub_is_wusb(hub))
2814 udev->speed = USB_SPEED_WIRELESS;
2815 else if (hub_is_superspeedplus(hub->hdev) &&
2816 port_speed_is_ssp(hub->hdev, ext_portstatus &
2817 USB_EXT_PORT_STAT_RX_SPEED_ID))
2818 udev->speed = USB_SPEED_SUPER_PLUS;
2819 else if (hub_is_superspeed(hub->hdev))
2820 udev->speed = USB_SPEED_SUPER;
2821 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2822 udev->speed = USB_SPEED_HIGH;
2823 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2824 udev->speed = USB_SPEED_LOW;
2826 udev->speed = USB_SPEED_FULL;
2830 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2831 static int hub_port_reset(struct usb_hub *hub, int port1,
2832 struct usb_device *udev, unsigned int delay, bool warm)
2835 u16 portchange, portstatus;
2836 struct usb_port *port_dev = hub->ports[port1 - 1];
2837 int reset_recovery_time;
2839 if (!hub_is_superspeed(hub->hdev)) {
2841 dev_err(hub->intfdev, "only USB3 hub support "
2845 /* Block EHCI CF initialization during the port reset.
2846 * Some companion controllers don't like it when they mix.
2848 down_read(&ehci_cf_port_reset_rwsem);
2851 * If the caller hasn't explicitly requested a warm reset,
2852 * double check and see if one is needed.
2854 if (hub_port_status(hub, port1, &portstatus, &portchange) == 0)
2855 if (hub_port_warm_reset_required(hub, port1,
2859 clear_bit(port1, hub->warm_reset_bits);
2861 /* Reset the port */
2862 for (i = 0; i < PORT_RESET_TRIES; i++) {
2863 status = set_port_feature(hub->hdev, port1, (warm ?
2864 USB_PORT_FEAT_BH_PORT_RESET :
2865 USB_PORT_FEAT_RESET));
2866 if (status == -ENODEV) {
2867 ; /* The hub is gone */
2868 } else if (status) {
2869 dev_err(&port_dev->dev,
2870 "cannot %sreset (err = %d)\n",
2871 warm ? "warm " : "", status);
2873 status = hub_port_wait_reset(hub, port1, udev, delay,
2875 if (status && status != -ENOTCONN && status != -ENODEV)
2876 dev_dbg(hub->intfdev,
2877 "port_wait_reset: err = %d\n",
2881 /* Check for disconnect or reset */
2882 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2883 usb_clear_port_feature(hub->hdev, port1,
2884 USB_PORT_FEAT_C_RESET);
2886 if (!hub_is_superspeed(hub->hdev))
2889 usb_clear_port_feature(hub->hdev, port1,
2890 USB_PORT_FEAT_C_BH_PORT_RESET);
2891 usb_clear_port_feature(hub->hdev, port1,
2892 USB_PORT_FEAT_C_PORT_LINK_STATE);
2895 usb_clear_port_feature(hub->hdev, port1,
2896 USB_PORT_FEAT_C_CONNECTION);
2899 * If a USB 3.0 device migrates from reset to an error
2900 * state, re-issue the warm reset.
2902 if (hub_port_status(hub, port1,
2903 &portstatus, &portchange) < 0)
2906 if (!hub_port_warm_reset_required(hub, port1,
2911 * If the port is in SS.Inactive or Compliance Mode, the
2912 * hot or warm reset failed. Try another warm reset.
2915 dev_dbg(&port_dev->dev,
2916 "hot reset failed, warm reset\n");
2921 dev_dbg(&port_dev->dev,
2922 "not enabled, trying %sreset again...\n",
2923 warm ? "warm " : "");
2924 delay = HUB_LONG_RESET_TIME;
2927 dev_err(&port_dev->dev, "Cannot enable. Maybe the USB cable is bad?\n");
2931 if (port_dev->quirks & USB_PORT_QUIRK_FAST_ENUM)
2932 usleep_range(10000, 12000);
2934 /* TRSTRCY = 10 ms; plus some extra */
2935 reset_recovery_time = 10 + 40;
2937 /* Hub needs extra delay after resetting its port. */
2938 if (hub->hdev->quirks & USB_QUIRK_HUB_SLOW_RESET)
2939 reset_recovery_time += 100;
2941 msleep(reset_recovery_time);
2945 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2947 update_devnum(udev, 0);
2948 /* The xHC may think the device is already reset,
2949 * so ignore the status.
2951 if (hcd->driver->reset_device)
2952 hcd->driver->reset_device(hcd, udev);
2954 usb_set_device_state(udev, USB_STATE_DEFAULT);
2958 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2961 if (!hub_is_superspeed(hub->hdev))
2962 up_read(&ehci_cf_port_reset_rwsem);
2967 /* Check if a port is power on */
2968 static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2972 if (hub_is_superspeed(hub->hdev)) {
2973 if (portstatus & USB_SS_PORT_STAT_POWER)
2976 if (portstatus & USB_PORT_STAT_POWER)
2983 static void usb_lock_port(struct usb_port *port_dev)
2984 __acquires(&port_dev->status_lock)
2986 mutex_lock(&port_dev->status_lock);
2987 __acquire(&port_dev->status_lock);
2990 static void usb_unlock_port(struct usb_port *port_dev)
2991 __releases(&port_dev->status_lock)
2993 mutex_unlock(&port_dev->status_lock);
2994 __release(&port_dev->status_lock);
2999 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
3000 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
3004 if (hub_is_superspeed(hub->hdev)) {
3005 if ((portstatus & USB_PORT_STAT_LINK_STATE)
3006 == USB_SS_PORT_LS_U3)
3009 if (portstatus & USB_PORT_STAT_SUSPEND)
3016 /* Determine whether the device on a port is ready for a normal resume,
3017 * is ready for a reset-resume, or should be disconnected.
3019 static int check_port_resume_type(struct usb_device *udev,
3020 struct usb_hub *hub, int port1,
3021 int status, u16 portchange, u16 portstatus)
3023 struct usb_port *port_dev = hub->ports[port1 - 1];
3027 /* Is a warm reset needed to recover the connection? */
3028 if (status == 0 && udev->reset_resume
3029 && hub_port_warm_reset_required(hub, port1, portstatus)) {
3032 /* Is the device still present? */
3033 else if (status || port_is_suspended(hub, portstatus) ||
3034 !port_is_power_on(hub, portstatus)) {
3037 } else if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
3039 usleep_range(200, 300);
3040 status = hub_port_status(hub, port1, &portstatus,
3047 /* Can't do a normal resume if the port isn't enabled,
3048 * so try a reset-resume instead.
3050 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
3051 if (udev->persist_enabled)
3052 udev->reset_resume = 1;
3058 dev_dbg(&port_dev->dev, "status %04x.%04x after resume, %d\n",
3059 portchange, portstatus, status);
3060 } else if (udev->reset_resume) {
3062 /* Late port handoff can set status-change bits */
3063 if (portchange & USB_PORT_STAT_C_CONNECTION)
3064 usb_clear_port_feature(hub->hdev, port1,
3065 USB_PORT_FEAT_C_CONNECTION);
3066 if (portchange & USB_PORT_STAT_C_ENABLE)
3067 usb_clear_port_feature(hub->hdev, port1,
3068 USB_PORT_FEAT_C_ENABLE);
3071 * Whatever made this reset-resume necessary may have
3072 * turned on the port1 bit in hub->change_bits. But after
3073 * a successful reset-resume we want the bit to be clear;
3074 * if it was on it would indicate that something happened
3075 * following the reset-resume.
3077 clear_bit(port1, hub->change_bits);
3083 int usb_disable_ltm(struct usb_device *udev)
3085 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3087 /* Check if the roothub and device supports LTM. */
3088 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
3089 !usb_device_supports_ltm(udev))
3092 /* Clear Feature LTM Enable can only be sent if the device is
3095 if (!udev->actconfig)
3098 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3099 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
3100 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
3101 USB_CTRL_SET_TIMEOUT);
3103 EXPORT_SYMBOL_GPL(usb_disable_ltm);
3105 void usb_enable_ltm(struct usb_device *udev)
3107 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3109 /* Check if the roothub and device supports LTM. */
3110 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
3111 !usb_device_supports_ltm(udev))
3114 /* Set Feature LTM Enable can only be sent if the device is
3117 if (!udev->actconfig)
3120 usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3121 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
3122 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
3123 USB_CTRL_SET_TIMEOUT);
3125 EXPORT_SYMBOL_GPL(usb_enable_ltm);
3128 * usb_enable_remote_wakeup - enable remote wakeup for a device
3129 * @udev: target device
3131 * For USB-2 devices: Set the device's remote wakeup feature.
3133 * For USB-3 devices: Assume there's only one function on the device and
3134 * enable remote wake for the first interface. FIXME if the interface
3135 * association descriptor shows there's more than one function.
3137 static int usb_enable_remote_wakeup(struct usb_device *udev)
3139 if (udev->speed < USB_SPEED_SUPER)
3140 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3141 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
3142 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
3143 USB_CTRL_SET_TIMEOUT);
3145 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3146 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
3147 USB_INTRF_FUNC_SUSPEND,
3148 USB_INTRF_FUNC_SUSPEND_RW |
3149 USB_INTRF_FUNC_SUSPEND_LP,
3150 NULL, 0, USB_CTRL_SET_TIMEOUT);
3154 * usb_disable_remote_wakeup - disable remote wakeup for a device
3155 * @udev: target device
3157 * For USB-2 devices: Clear the device's remote wakeup feature.
3159 * For USB-3 devices: Assume there's only one function on the device and
3160 * disable remote wake for the first interface. FIXME if the interface
3161 * association descriptor shows there's more than one function.
3163 static int usb_disable_remote_wakeup(struct usb_device *udev)
3165 if (udev->speed < USB_SPEED_SUPER)
3166 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3167 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
3168 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
3169 USB_CTRL_SET_TIMEOUT);
3171 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3172 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
3173 USB_INTRF_FUNC_SUSPEND, 0, NULL, 0,
3174 USB_CTRL_SET_TIMEOUT);
3177 /* Count of wakeup-enabled devices at or below udev */
3178 static unsigned wakeup_enabled_descendants(struct usb_device *udev)
3180 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
3182 return udev->do_remote_wakeup +
3183 (hub ? hub->wakeup_enabled_descendants : 0);
3187 * usb_port_suspend - suspend a usb device's upstream port
3188 * @udev: device that's no longer in active use, not a root hub
3189 * Context: must be able to sleep; device not locked; pm locks held
3191 * Suspends a USB device that isn't in active use, conserving power.
3192 * Devices may wake out of a suspend, if anything important happens,
3193 * using the remote wakeup mechanism. They may also be taken out of
3194 * suspend by the host, using usb_port_resume(). It's also routine
3195 * to disconnect devices while they are suspended.
3197 * This only affects the USB hardware for a device; its interfaces
3198 * (and, for hubs, child devices) must already have been suspended.
3200 * Selective port suspend reduces power; most suspended devices draw
3201 * less than 500 uA. It's also used in OTG, along with remote wakeup.
3202 * All devices below the suspended port are also suspended.
3204 * Devices leave suspend state when the host wakes them up. Some devices
3205 * also support "remote wakeup", where the device can activate the USB
3206 * tree above them to deliver data, such as a keypress or packet. In
3207 * some cases, this wakes the USB host.
3209 * Suspending OTG devices may trigger HNP, if that's been enabled
3210 * between a pair of dual-role devices. That will change roles, such
3211 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
3213 * Devices on USB hub ports have only one "suspend" state, corresponding
3214 * to ACPI D2, "may cause the device to lose some context".
3215 * State transitions include:
3217 * - suspend, resume ... when the VBUS power link stays live
3218 * - suspend, disconnect ... VBUS lost
3220 * Once VBUS drop breaks the circuit, the port it's using has to go through
3221 * normal re-enumeration procedures, starting with enabling VBUS power.
3222 * Other than re-initializing the hub (plug/unplug, except for root hubs),
3223 * Linux (2.6) currently has NO mechanisms to initiate that: no hub_wq
3224 * timer, no SRP, no requests through sysfs.
3226 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
3227 * suspended until their bus goes into global suspend (i.e., the root
3228 * hub is suspended). Nevertheless, we change @udev->state to
3229 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
3230 * upstream port setting is stored in @udev->port_is_suspended.
3232 * Returns 0 on success, else negative errno.
3234 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
3236 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3237 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3238 int port1 = udev->portnum;
3240 bool really_suspend = true;
3242 usb_lock_port(port_dev);
3244 /* enable remote wakeup when appropriate; this lets the device
3245 * wake up the upstream hub (including maybe the root hub).
3247 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
3248 * we don't explicitly enable it here.
3250 if (udev->do_remote_wakeup) {
3251 status = usb_enable_remote_wakeup(udev);
3253 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
3255 /* bail if autosuspend is requested */
3256 if (PMSG_IS_AUTO(msg))
3261 /* disable USB2 hardware LPM */
3262 usb_disable_usb2_hardware_lpm(udev);
3264 if (usb_disable_ltm(udev)) {
3265 dev_err(&udev->dev, "Failed to disable LTM before suspend\n");
3267 if (PMSG_IS_AUTO(msg))
3272 if (hub_is_superspeed(hub->hdev))
3273 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U3);
3276 * For system suspend, we do not need to enable the suspend feature
3277 * on individual USB-2 ports. The devices will automatically go
3278 * into suspend a few ms after the root hub stops sending packets.
3279 * The USB 2.0 spec calls this "global suspend".
3281 * However, many USB hubs have a bug: They don't relay wakeup requests
3282 * from a downstream port if the port's suspend feature isn't on.
3283 * Therefore we will turn on the suspend feature if udev or any of its
3284 * descendants is enabled for remote wakeup.
3286 else if (PMSG_IS_AUTO(msg) || wakeup_enabled_descendants(udev) > 0)
3287 status = set_port_feature(hub->hdev, port1,
3288 USB_PORT_FEAT_SUSPEND);
3290 really_suspend = false;
3294 dev_dbg(&port_dev->dev, "can't suspend, status %d\n", status);
3296 /* Try to enable USB3 LTM again */
3297 usb_enable_ltm(udev);
3299 /* Try to enable USB2 hardware LPM again */
3300 usb_enable_usb2_hardware_lpm(udev);
3302 if (udev->do_remote_wakeup)
3303 (void) usb_disable_remote_wakeup(udev);
3306 /* System sleep transitions should never fail */
3307 if (!PMSG_IS_AUTO(msg))
3310 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
3311 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
3312 udev->do_remote_wakeup);
3313 if (really_suspend) {
3314 udev->port_is_suspended = 1;
3316 /* device has up to 10 msec to fully suspend */
3319 usb_set_device_state(udev, USB_STATE_SUSPENDED);
3322 if (status == 0 && !udev->do_remote_wakeup && udev->persist_enabled
3323 && test_and_clear_bit(port1, hub->child_usage_bits))
3324 pm_runtime_put_sync(&port_dev->dev);
3326 usb_mark_last_busy(hub->hdev);
3328 usb_unlock_port(port_dev);
3333 * If the USB "suspend" state is in use (rather than "global suspend"),
3334 * many devices will be individually taken out of suspend state using
3335 * special "resume" signaling. This routine kicks in shortly after
3336 * hardware resume signaling is finished, either because of selective
3337 * resume (by host) or remote wakeup (by device) ... now see what changed
3338 * in the tree that's rooted at this device.
3340 * If @udev->reset_resume is set then the device is reset before the
3341 * status check is done.
3343 static int finish_port_resume(struct usb_device *udev)
3348 /* caller owns the udev device lock */
3349 dev_dbg(&udev->dev, "%s\n",
3350 udev->reset_resume ? "finish reset-resume" : "finish resume");
3352 /* usb ch9 identifies four variants of SUSPENDED, based on what
3353 * state the device resumes to. Linux currently won't see the
3354 * first two on the host side; they'd be inside hub_port_init()
3355 * during many timeouts, but hub_wq can't suspend until later.
3357 usb_set_device_state(udev, udev->actconfig
3358 ? USB_STATE_CONFIGURED
3359 : USB_STATE_ADDRESS);
3361 /* 10.5.4.5 says not to reset a suspended port if the attached
3362 * device is enabled for remote wakeup. Hence the reset
3363 * operation is carried out here, after the port has been
3366 if (udev->reset_resume) {
3368 * If the device morphs or switches modes when it is reset,
3369 * we don't want to perform a reset-resume. We'll fail the
3370 * resume, which will cause a logical disconnect, and then
3371 * the device will be rediscovered.
3374 if (udev->quirks & USB_QUIRK_RESET)
3377 status = usb_reset_and_verify_device(udev);
3380 /* 10.5.4.5 says be sure devices in the tree are still there.
3381 * For now let's assume the device didn't go crazy on resume,
3382 * and device drivers will know about any resume quirks.
3386 status = usb_get_std_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
3388 /* If a normal resume failed, try doing a reset-resume */
3389 if (status && !udev->reset_resume && udev->persist_enabled) {
3390 dev_dbg(&udev->dev, "retry with reset-resume\n");
3391 udev->reset_resume = 1;
3392 goto retry_reset_resume;
3397 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
3400 * There are a few quirky devices which violate the standard
3401 * by claiming to have remote wakeup enabled after a reset,
3402 * which crash if the feature is cleared, hence check for
3403 * udev->reset_resume
3405 } else if (udev->actconfig && !udev->reset_resume) {
3406 if (udev->speed < USB_SPEED_SUPER) {
3407 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
3408 status = usb_disable_remote_wakeup(udev);
3410 status = usb_get_std_status(udev, USB_RECIP_INTERFACE, 0,
3412 if (!status && devstatus & (USB_INTRF_STAT_FUNC_RW_CAP
3413 | USB_INTRF_STAT_FUNC_RW))
3414 status = usb_disable_remote_wakeup(udev);
3419 "disable remote wakeup, status %d\n",
3427 * There are some SS USB devices which take longer time for link training.
3428 * XHCI specs 4.19.4 says that when Link training is successful, port
3429 * sets CCS bit to 1. So if SW reads port status before successful link
3430 * training, then it will not find device to be present.
3431 * USB Analyzer log with such buggy devices show that in some cases
3432 * device switch on the RX termination after long delay of host enabling
3433 * the VBUS. In few other cases it has been seen that device fails to
3434 * negotiate link training in first attempt. It has been
3435 * reported till now that few devices take as long as 2000 ms to train
3436 * the link after host enabling its VBUS and termination. Following
3437 * routine implements a 2000 ms timeout for link training. If in a case
3438 * link trains before timeout, loop will exit earlier.
3440 * There are also some 2.0 hard drive based devices and 3.0 thumb
3441 * drives that, when plugged into a 2.0 only port, take a long
3442 * time to set CCS after VBUS enable.
3444 * FIXME: If a device was connected before suspend, but was removed
3445 * while system was asleep, then the loop in the following routine will
3446 * only exit at timeout.
3448 * This routine should only be called when persist is enabled.
3450 static int wait_for_connected(struct usb_device *udev,
3451 struct usb_hub *hub, int *port1,
3452 u16 *portchange, u16 *portstatus)
3454 int status = 0, delay_ms = 0;
3456 while (delay_ms < 2000) {
3457 if (status || *portstatus & USB_PORT_STAT_CONNECTION)
3459 if (!port_is_power_on(hub, *portstatus)) {
3465 status = hub_port_status(hub, *port1, portstatus, portchange);
3467 dev_dbg(&udev->dev, "Waited %dms for CONNECT\n", delay_ms);
3472 * usb_port_resume - re-activate a suspended usb device's upstream port
3473 * @udev: device to re-activate, not a root hub
3474 * Context: must be able to sleep; device not locked; pm locks held
3476 * This will re-activate the suspended device, increasing power usage
3477 * while letting drivers communicate again with its endpoints.
3478 * USB resume explicitly guarantees that the power session between
3479 * the host and the device is the same as it was when the device
3482 * If @udev->reset_resume is set then this routine won't check that the
3483 * port is still enabled. Furthermore, finish_port_resume() above will
3484 * reset @udev. The end result is that a broken power session can be
3485 * recovered and @udev will appear to persist across a loss of VBUS power.
3487 * For example, if a host controller doesn't maintain VBUS suspend current
3488 * during a system sleep or is reset when the system wakes up, all the USB
3489 * power sessions below it will be broken. This is especially troublesome
3490 * for mass-storage devices containing mounted filesystems, since the
3491 * device will appear to have disconnected and all the memory mappings
3492 * to it will be lost. Using the USB_PERSIST facility, the device can be
3493 * made to appear as if it had not disconnected.
3495 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3496 * every effort to insure that the same device is present after the
3497 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3498 * quite possible for a device to remain unaltered but its media to be
3499 * changed. If the user replaces a flash memory card while the system is
3500 * asleep, he will have only himself to blame when the filesystem on the
3501 * new card is corrupted and the system crashes.
3503 * Returns 0 on success, else negative errno.
3505 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
3507 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3508 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3509 int port1 = udev->portnum;
3511 u16 portchange, portstatus;
3513 if (!test_and_set_bit(port1, hub->child_usage_bits)) {
3514 status = pm_runtime_get_sync(&port_dev->dev);
3516 dev_dbg(&udev->dev, "can't resume usb port, status %d\n",
3522 usb_lock_port(port_dev);
3524 /* Skip the initial Clear-Suspend step for a remote wakeup */
3525 status = hub_port_status(hub, port1, &portstatus, &portchange);
3526 if (status == 0 && !port_is_suspended(hub, portstatus)) {
3527 if (portchange & USB_PORT_STAT_C_SUSPEND)
3528 pm_wakeup_event(&udev->dev, 0);
3529 goto SuspendCleared;
3532 /* see 7.1.7.7; affects power usage, but not budgeting */
3533 if (hub_is_superspeed(hub->hdev))
3534 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U0);
3536 status = usb_clear_port_feature(hub->hdev,
3537 port1, USB_PORT_FEAT_SUSPEND);
3539 dev_dbg(&port_dev->dev, "can't resume, status %d\n", status);
3541 /* drive resume for USB_RESUME_TIMEOUT msec */
3542 dev_dbg(&udev->dev, "usb %sresume\n",
3543 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
3544 msleep(USB_RESUME_TIMEOUT);
3546 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3547 * stop resume signaling. Then finish the resume
3550 status = hub_port_status(hub, port1, &portstatus, &portchange);
3555 udev->port_is_suspended = 0;
3556 if (hub_is_superspeed(hub->hdev)) {
3557 if (portchange & USB_PORT_STAT_C_LINK_STATE)
3558 usb_clear_port_feature(hub->hdev, port1,
3559 USB_PORT_FEAT_C_PORT_LINK_STATE);
3561 if (portchange & USB_PORT_STAT_C_SUSPEND)
3562 usb_clear_port_feature(hub->hdev, port1,
3563 USB_PORT_FEAT_C_SUSPEND);
3566 /* TRSMRCY = 10 msec */
3570 if (udev->persist_enabled)
3571 status = wait_for_connected(udev, hub, &port1, &portchange,
3574 status = check_port_resume_type(udev,
3575 hub, port1, status, portchange, portstatus);
3577 status = finish_port_resume(udev);
3579 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
3580 hub_port_logical_disconnect(hub, port1);
3582 /* Try to enable USB2 hardware LPM */
3583 usb_enable_usb2_hardware_lpm(udev);
3585 /* Try to enable USB3 LTM */
3586 usb_enable_ltm(udev);
3589 usb_unlock_port(port_dev);
3594 int usb_remote_wakeup(struct usb_device *udev)
3598 usb_lock_device(udev);
3599 if (udev->state == USB_STATE_SUSPENDED) {
3600 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
3601 status = usb_autoresume_device(udev);
3603 /* Let the drivers do their thing, then... */
3604 usb_autosuspend_device(udev);
3607 usb_unlock_device(udev);
3611 /* Returns 1 if there was a remote wakeup and a connect status change. */
3612 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
3613 u16 portstatus, u16 portchange)
3614 __must_hold(&port_dev->status_lock)
3616 struct usb_port *port_dev = hub->ports[port - 1];
3617 struct usb_device *hdev;
3618 struct usb_device *udev;
3619 int connect_change = 0;
3624 udev = port_dev->child;
3625 if (!hub_is_superspeed(hdev)) {
3626 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
3628 usb_clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
3630 link_state = portstatus & USB_PORT_STAT_LINK_STATE;
3631 if (!udev || udev->state != USB_STATE_SUSPENDED ||
3632 (link_state != USB_SS_PORT_LS_U0 &&
3633 link_state != USB_SS_PORT_LS_U1 &&
3634 link_state != USB_SS_PORT_LS_U2))
3639 /* TRSMRCY = 10 msec */
3642 usb_unlock_port(port_dev);
3643 ret = usb_remote_wakeup(udev);
3644 usb_lock_port(port_dev);
3649 hub_port_disable(hub, port, 1);
3651 dev_dbg(&port_dev->dev, "resume, status %d\n", ret);
3652 return connect_change;
3655 static int check_ports_changed(struct usb_hub *hub)
3659 for (port1 = 1; port1 <= hub->hdev->maxchild; ++port1) {
3660 u16 portstatus, portchange;
3663 status = hub_port_status(hub, port1, &portstatus, &portchange);
3664 if (!status && portchange)
3670 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
3672 struct usb_hub *hub = usb_get_intfdata(intf);
3673 struct usb_device *hdev = hub->hdev;
3678 * Warn if children aren't already suspended.
3679 * Also, add up the number of wakeup-enabled descendants.
3681 hub->wakeup_enabled_descendants = 0;
3682 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3683 struct usb_port *port_dev = hub->ports[port1 - 1];
3684 struct usb_device *udev = port_dev->child;
3686 if (udev && udev->can_submit) {
3687 dev_warn(&port_dev->dev, "device %s not suspended yet\n",
3688 dev_name(&udev->dev));
3689 if (PMSG_IS_AUTO(msg))
3693 hub->wakeup_enabled_descendants +=
3694 wakeup_enabled_descendants(udev);
3697 if (hdev->do_remote_wakeup && hub->quirk_check_port_auto_suspend) {
3698 /* check if there are changes pending on hub ports */
3699 if (check_ports_changed(hub)) {
3700 if (PMSG_IS_AUTO(msg))
3702 pm_wakeup_event(&hdev->dev, 2000);
3706 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
3707 /* Enable hub to send remote wakeup for all ports. */
3708 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3709 status = set_port_feature(hdev,
3711 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
3712 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
3713 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
3714 USB_PORT_FEAT_REMOTE_WAKE_MASK);
3718 dev_dbg(&intf->dev, "%s\n", __func__);
3720 /* stop hub_wq and related activity */
3721 hub_quiesce(hub, HUB_SUSPEND);
3725 /* Report wakeup requests from the ports of a resuming root hub */
3726 static void report_wakeup_requests(struct usb_hub *hub)
3728 struct usb_device *hdev = hub->hdev;
3729 struct usb_device *udev;
3730 struct usb_hcd *hcd;
3731 unsigned long resuming_ports;
3735 return; /* Not a root hub */
3737 hcd = bus_to_hcd(hdev->bus);
3738 if (hcd->driver->get_resuming_ports) {
3741 * The get_resuming_ports() method returns a bitmap (origin 0)
3742 * of ports which have started wakeup signaling but have not
3743 * yet finished resuming. During system resume we will
3744 * resume all the enabled ports, regardless of any wakeup
3745 * signals, which means the wakeup requests would be lost.
3746 * To prevent this, report them to the PM core here.
3748 resuming_ports = hcd->driver->get_resuming_ports(hcd);
3749 for (i = 0; i < hdev->maxchild; ++i) {
3750 if (test_bit(i, &resuming_ports)) {
3751 udev = hub->ports[i]->child;
3753 pm_wakeup_event(&udev->dev, 0);
3759 static int hub_resume(struct usb_interface *intf)
3761 struct usb_hub *hub = usb_get_intfdata(intf);
3763 dev_dbg(&intf->dev, "%s\n", __func__);
3764 hub_activate(hub, HUB_RESUME);
3767 * This should be called only for system resume, not runtime resume.
3768 * We can't tell the difference here, so some wakeup requests will be
3769 * reported at the wrong time or more than once. This shouldn't
3770 * matter much, so long as they do get reported.
3772 report_wakeup_requests(hub);
3776 static int hub_reset_resume(struct usb_interface *intf)
3778 struct usb_hub *hub = usb_get_intfdata(intf);
3780 dev_dbg(&intf->dev, "%s\n", __func__);
3781 hub_activate(hub, HUB_RESET_RESUME);
3786 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3787 * @rhdev: struct usb_device for the root hub
3789 * The USB host controller driver calls this function when its root hub
3790 * is resumed and Vbus power has been interrupted or the controller
3791 * has been reset. The routine marks @rhdev as having lost power.
3792 * When the hub driver is resumed it will take notice and carry out
3793 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3794 * the others will be disconnected.
3796 void usb_root_hub_lost_power(struct usb_device *rhdev)
3798 dev_notice(&rhdev->dev, "root hub lost power or was reset\n");
3799 rhdev->reset_resume = 1;
3801 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
3803 static const char * const usb3_lpm_names[] = {
3811 * Send a Set SEL control transfer to the device, prior to enabling
3812 * device-initiated U1 or U2. This lets the device know the exit latencies from
3813 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3814 * packet from the host.
3816 * This function will fail if the SEL or PEL values for udev are greater than
3817 * the maximum allowed values for the link state to be enabled.
3819 static int usb_req_set_sel(struct usb_device *udev, enum usb3_link_state state)
3821 struct usb_set_sel_req *sel_values;
3822 unsigned long long u1_sel;
3823 unsigned long long u1_pel;
3824 unsigned long long u2_sel;
3825 unsigned long long u2_pel;
3828 if (udev->state != USB_STATE_CONFIGURED)
3831 /* Convert SEL and PEL stored in ns to us */
3832 u1_sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
3833 u1_pel = DIV_ROUND_UP(udev->u1_params.pel, 1000);
3834 u2_sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
3835 u2_pel = DIV_ROUND_UP(udev->u2_params.pel, 1000);
3838 * Make sure that the calculated SEL and PEL values for the link
3839 * state we're enabling aren't bigger than the max SEL/PEL
3840 * value that will fit in the SET SEL control transfer.
3841 * Otherwise the device would get an incorrect idea of the exit
3842 * latency for the link state, and could start a device-initiated
3843 * U1/U2 when the exit latencies are too high.
3845 if ((state == USB3_LPM_U1 &&
3846 (u1_sel > USB3_LPM_MAX_U1_SEL_PEL ||
3847 u1_pel > USB3_LPM_MAX_U1_SEL_PEL)) ||
3848 (state == USB3_LPM_U2 &&
3849 (u2_sel > USB3_LPM_MAX_U2_SEL_PEL ||
3850 u2_pel > USB3_LPM_MAX_U2_SEL_PEL))) {
3851 dev_dbg(&udev->dev, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3852 usb3_lpm_names[state], u1_sel, u1_pel);
3857 * If we're enabling device-initiated LPM for one link state,
3858 * but the other link state has a too high SEL or PEL value,
3859 * just set those values to the max in the Set SEL request.
3861 if (u1_sel > USB3_LPM_MAX_U1_SEL_PEL)
3862 u1_sel = USB3_LPM_MAX_U1_SEL_PEL;
3864 if (u1_pel > USB3_LPM_MAX_U1_SEL_PEL)
3865 u1_pel = USB3_LPM_MAX_U1_SEL_PEL;
3867 if (u2_sel > USB3_LPM_MAX_U2_SEL_PEL)
3868 u2_sel = USB3_LPM_MAX_U2_SEL_PEL;
3870 if (u2_pel > USB3_LPM_MAX_U2_SEL_PEL)
3871 u2_pel = USB3_LPM_MAX_U2_SEL_PEL;
3874 * usb_enable_lpm() can be called as part of a failed device reset,
3875 * which may be initiated by an error path of a mass storage driver.
3876 * Therefore, use GFP_NOIO.
3878 sel_values = kmalloc(sizeof *(sel_values), GFP_NOIO);
3882 sel_values->u1_sel = u1_sel;
3883 sel_values->u1_pel = u1_pel;
3884 sel_values->u2_sel = cpu_to_le16(u2_sel);
3885 sel_values->u2_pel = cpu_to_le16(u2_pel);
3887 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3891 sel_values, sizeof *(sel_values),
3892 USB_CTRL_SET_TIMEOUT);
3898 * Enable or disable device-initiated U1 or U2 transitions.
3900 static int usb_set_device_initiated_lpm(struct usb_device *udev,
3901 enum usb3_link_state state, bool enable)
3908 feature = USB_DEVICE_U1_ENABLE;
3911 feature = USB_DEVICE_U2_ENABLE;
3914 dev_warn(&udev->dev, "%s: Can't %s non-U1 or U2 state.\n",
3915 __func__, enable ? "enable" : "disable");
3919 if (udev->state != USB_STATE_CONFIGURED) {
3920 dev_dbg(&udev->dev, "%s: Can't %s %s state "
3921 "for unconfigured device.\n",
3922 __func__, enable ? "enable" : "disable",
3923 usb3_lpm_names[state]);
3929 * Now send the control transfer to enable device-initiated LPM
3930 * for either U1 or U2.
3932 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3933 USB_REQ_SET_FEATURE,
3937 USB_CTRL_SET_TIMEOUT);
3939 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3940 USB_REQ_CLEAR_FEATURE,
3944 USB_CTRL_SET_TIMEOUT);
3947 dev_warn(&udev->dev, "%s of device-initiated %s failed.\n",
3948 enable ? "Enable" : "Disable",
3949 usb3_lpm_names[state]);
3955 static int usb_set_lpm_timeout(struct usb_device *udev,
3956 enum usb3_link_state state, int timeout)
3963 feature = USB_PORT_FEAT_U1_TIMEOUT;
3966 feature = USB_PORT_FEAT_U2_TIMEOUT;
3969 dev_warn(&udev->dev, "%s: Can't set timeout for non-U1 or U2 state.\n",
3974 if (state == USB3_LPM_U1 && timeout > USB3_LPM_U1_MAX_TIMEOUT &&
3975 timeout != USB3_LPM_DEVICE_INITIATED) {
3976 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x, "
3977 "which is a reserved value.\n",
3978 usb3_lpm_names[state], timeout);
3982 ret = set_port_feature(udev->parent,
3983 USB_PORT_LPM_TIMEOUT(timeout) | udev->portnum,
3986 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x,"
3987 "error code %i\n", usb3_lpm_names[state],
3991 if (state == USB3_LPM_U1)
3992 udev->u1_params.timeout = timeout;
3994 udev->u2_params.timeout = timeout;
3999 * Don't allow device intiated U1/U2 if the system exit latency + one bus
4000 * interval is greater than the minimum service interval of any active
4001 * periodic endpoint. See USB 3.2 section 9.4.9
4003 static bool usb_device_may_initiate_lpm(struct usb_device *udev,
4004 enum usb3_link_state state)
4006 unsigned int sel; /* us */
4009 if (state == USB3_LPM_U1)
4010 sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
4011 else if (state == USB3_LPM_U2)
4012 sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
4016 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
4017 struct usb_interface *intf;
4018 struct usb_endpoint_descriptor *desc;
4019 unsigned int interval;
4021 intf = udev->actconfig->interface[i];
4025 for (j = 0; j < intf->cur_altsetting->desc.bNumEndpoints; j++) {
4026 desc = &intf->cur_altsetting->endpoint[j].desc;
4028 if (usb_endpoint_xfer_int(desc) ||
4029 usb_endpoint_xfer_isoc(desc)) {
4030 interval = (1 << (desc->bInterval - 1)) * 125;
4031 if (sel + 125 > interval)
4040 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
4043 * We will attempt to enable U1 or U2, but there are no guarantees that the
4044 * control transfers to set the hub timeout or enable device-initiated U1/U2
4045 * will be successful.
4047 * If the control transfer to enable device-initiated U1/U2 entry fails, then
4048 * hub-initiated U1/U2 will be disabled.
4050 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
4051 * driver know about it. If that call fails, it should be harmless, and just
4052 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
4054 static void usb_enable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
4055 enum usb3_link_state state)
4058 __u8 u1_mel = udev->bos->ss_cap->bU1devExitLat;
4059 __le16 u2_mel = udev->bos->ss_cap->bU2DevExitLat;
4061 /* If the device says it doesn't have *any* exit latency to come out of
4062 * U1 or U2, it's probably lying. Assume it doesn't implement that link
4065 if ((state == USB3_LPM_U1 && u1_mel == 0) ||
4066 (state == USB3_LPM_U2 && u2_mel == 0))
4070 * First, let the device know about the exit latencies
4071 * associated with the link state we're about to enable.
4073 ret = usb_req_set_sel(udev, state);
4075 dev_warn(&udev->dev, "Set SEL for device-initiated %s failed.\n",
4076 usb3_lpm_names[state]);
4080 /* We allow the host controller to set the U1/U2 timeout internally
4081 * first, so that it can change its schedule to account for the
4082 * additional latency to send data to a device in a lower power
4085 timeout = hcd->driver->enable_usb3_lpm_timeout(hcd, udev, state);
4087 /* xHCI host controller doesn't want to enable this LPM state. */
4092 dev_warn(&udev->dev, "Could not enable %s link state, "
4093 "xHCI error %i.\n", usb3_lpm_names[state],
4098 if (usb_set_lpm_timeout(udev, state, timeout)) {
4099 /* If we can't set the parent hub U1/U2 timeout,
4100 * device-initiated LPM won't be allowed either, so let the xHCI
4101 * host know that this link state won't be enabled.
4103 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
4107 /* Only a configured device will accept the Set Feature
4110 if (udev->actconfig &&
4111 usb_device_may_initiate_lpm(udev, state)) {
4112 if (usb_set_device_initiated_lpm(udev, state, true)) {
4114 * Request to enable device initiated U1/U2 failed,
4115 * better to turn off lpm in this case.
4117 usb_set_lpm_timeout(udev, state, 0);
4118 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
4123 if (state == USB3_LPM_U1)
4124 udev->usb3_lpm_u1_enabled = 1;
4125 else if (state == USB3_LPM_U2)
4126 udev->usb3_lpm_u2_enabled = 1;
4129 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
4132 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
4133 * If zero is returned, the parent will not allow the link to go into U1/U2.
4135 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
4136 * it won't have an effect on the bus link state because the parent hub will
4137 * still disallow device-initiated U1/U2 entry.
4139 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
4140 * possible. The result will be slightly more bus bandwidth will be taken up
4141 * (to account for U1/U2 exit latency), but it should be harmless.
4143 static int usb_disable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
4144 enum usb3_link_state state)
4151 dev_warn(&udev->dev, "%s: Can't disable non-U1 or U2 state.\n",
4156 if (usb_set_lpm_timeout(udev, state, 0))
4159 usb_set_device_initiated_lpm(udev, state, false);
4161 if (hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state))
4162 dev_warn(&udev->dev, "Could not disable xHCI %s timeout, "
4163 "bus schedule bandwidth may be impacted.\n",
4164 usb3_lpm_names[state]);
4166 /* As soon as usb_set_lpm_timeout(0) return 0, hub initiated LPM
4167 * is disabled. Hub will disallows link to enter U1/U2 as well,
4168 * even device is initiating LPM. Hence LPM is disabled if hub LPM
4169 * timeout set to 0, no matter device-initiated LPM is disabled or
4172 if (state == USB3_LPM_U1)
4173 udev->usb3_lpm_u1_enabled = 0;
4174 else if (state == USB3_LPM_U2)
4175 udev->usb3_lpm_u2_enabled = 0;
4181 * Disable hub-initiated and device-initiated U1 and U2 entry.
4182 * Caller must own the bandwidth_mutex.
4184 * This will call usb_enable_lpm() on failure, which will decrement
4185 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
4187 int usb_disable_lpm(struct usb_device *udev)
4189 struct usb_hcd *hcd;
4191 if (!udev || !udev->parent ||
4192 udev->speed < USB_SPEED_SUPER ||
4193 !udev->lpm_capable ||
4194 udev->state < USB_STATE_DEFAULT)
4197 hcd = bus_to_hcd(udev->bus);
4198 if (!hcd || !hcd->driver->disable_usb3_lpm_timeout)
4201 udev->lpm_disable_count++;
4202 if ((udev->u1_params.timeout == 0 && udev->u2_params.timeout == 0))
4205 /* If LPM is enabled, attempt to disable it. */
4206 if (usb_disable_link_state(hcd, udev, USB3_LPM_U1))
4208 if (usb_disable_link_state(hcd, udev, USB3_LPM_U2))
4214 usb_enable_lpm(udev);
4217 EXPORT_SYMBOL_GPL(usb_disable_lpm);
4219 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
4220 int usb_unlocked_disable_lpm(struct usb_device *udev)
4222 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4228 mutex_lock(hcd->bandwidth_mutex);
4229 ret = usb_disable_lpm(udev);
4230 mutex_unlock(hcd->bandwidth_mutex);
4234 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
4237 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
4238 * xHCI host policy may prevent U1 or U2 from being enabled.
4240 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
4241 * until the lpm_disable_count drops to zero. Caller must own the
4244 void usb_enable_lpm(struct usb_device *udev)
4246 struct usb_hcd *hcd;
4247 struct usb_hub *hub;
4248 struct usb_port *port_dev;
4250 if (!udev || !udev->parent ||
4251 udev->speed < USB_SPEED_SUPER ||
4252 !udev->lpm_capable ||
4253 udev->state < USB_STATE_DEFAULT)
4256 udev->lpm_disable_count--;
4257 hcd = bus_to_hcd(udev->bus);
4258 /* Double check that we can both enable and disable LPM.
4259 * Device must be configured to accept set feature U1/U2 timeout.
4261 if (!hcd || !hcd->driver->enable_usb3_lpm_timeout ||
4262 !hcd->driver->disable_usb3_lpm_timeout)
4265 if (udev->lpm_disable_count > 0)
4268 hub = usb_hub_to_struct_hub(udev->parent);
4272 port_dev = hub->ports[udev->portnum - 1];
4274 if (port_dev->usb3_lpm_u1_permit)
4275 usb_enable_link_state(hcd, udev, USB3_LPM_U1);
4277 if (port_dev->usb3_lpm_u2_permit)
4278 usb_enable_link_state(hcd, udev, USB3_LPM_U2);
4280 EXPORT_SYMBOL_GPL(usb_enable_lpm);
4282 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
4283 void usb_unlocked_enable_lpm(struct usb_device *udev)
4285 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4290 mutex_lock(hcd->bandwidth_mutex);
4291 usb_enable_lpm(udev);
4292 mutex_unlock(hcd->bandwidth_mutex);
4294 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
4296 /* usb3 devices use U3 for disabled, make sure remote wakeup is disabled */
4297 static void hub_usb3_port_prepare_disable(struct usb_hub *hub,
4298 struct usb_port *port_dev)
4300 struct usb_device *udev = port_dev->child;
4303 if (udev && udev->port_is_suspended && udev->do_remote_wakeup) {
4304 ret = hub_set_port_link_state(hub, port_dev->portnum,
4307 msleep(USB_RESUME_TIMEOUT);
4308 ret = usb_disable_remote_wakeup(udev);
4311 dev_warn(&udev->dev,
4312 "Port disable: can't disable remote wake\n");
4313 udev->do_remote_wakeup = 0;
4317 #else /* CONFIG_PM */
4319 #define hub_suspend NULL
4320 #define hub_resume NULL
4321 #define hub_reset_resume NULL
4323 static inline void hub_usb3_port_prepare_disable(struct usb_hub *hub,
4324 struct usb_port *port_dev) { }
4326 int usb_disable_lpm(struct usb_device *udev)
4330 EXPORT_SYMBOL_GPL(usb_disable_lpm);
4332 void usb_enable_lpm(struct usb_device *udev) { }
4333 EXPORT_SYMBOL_GPL(usb_enable_lpm);
4335 int usb_unlocked_disable_lpm(struct usb_device *udev)
4339 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
4341 void usb_unlocked_enable_lpm(struct usb_device *udev) { }
4342 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
4344 int usb_disable_ltm(struct usb_device *udev)
4348 EXPORT_SYMBOL_GPL(usb_disable_ltm);
4350 void usb_enable_ltm(struct usb_device *udev) { }
4351 EXPORT_SYMBOL_GPL(usb_enable_ltm);
4353 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
4354 u16 portstatus, u16 portchange)
4359 #endif /* CONFIG_PM */
4362 * USB-3 does not have a similar link state as USB-2 that will avoid negotiating
4363 * a connection with a plugged-in cable but will signal the host when the cable
4364 * is unplugged. Disable remote wake and set link state to U3 for USB-3 devices
4366 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
4368 struct usb_port *port_dev = hub->ports[port1 - 1];
4369 struct usb_device *hdev = hub->hdev;
4373 if (hub_is_superspeed(hub->hdev)) {
4374 hub_usb3_port_prepare_disable(hub, port_dev);
4375 ret = hub_set_port_link_state(hub, port_dev->portnum,
4378 ret = usb_clear_port_feature(hdev, port1,
4379 USB_PORT_FEAT_ENABLE);
4382 if (port_dev->child && set_state)
4383 usb_set_device_state(port_dev->child, USB_STATE_NOTATTACHED);
4384 if (ret && ret != -ENODEV)
4385 dev_err(&port_dev->dev, "cannot disable (err = %d)\n", ret);
4390 * usb_port_disable - disable a usb device's upstream port
4391 * @udev: device to disable
4392 * Context: @udev locked, must be able to sleep.
4394 * Disables a USB device that isn't in active use.
4396 int usb_port_disable(struct usb_device *udev)
4398 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
4400 return hub_port_disable(hub, udev->portnum, 0);
4403 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
4405 * Between connect detection and reset signaling there must be a delay
4406 * of 100ms at least for debounce and power-settling. The corresponding
4407 * timer shall restart whenever the downstream port detects a disconnect.
4409 * Apparently there are some bluetooth and irda-dongles and a number of
4410 * low-speed devices for which this debounce period may last over a second.
4411 * Not covered by the spec - but easy to deal with.
4413 * This implementation uses a 1500ms total debounce timeout; if the
4414 * connection isn't stable by then it returns -ETIMEDOUT. It checks
4415 * every 25ms for transient disconnects. When the port status has been
4416 * unchanged for 100ms it returns the port status.
4418 int hub_port_debounce(struct usb_hub *hub, int port1, bool must_be_connected)
4421 u16 portchange, portstatus;
4422 unsigned connection = 0xffff;
4423 int total_time, stable_time = 0;
4424 struct usb_port *port_dev = hub->ports[port1 - 1];
4426 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
4427 ret = hub_port_status(hub, port1, &portstatus, &portchange);
4431 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
4432 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
4433 if (!must_be_connected ||
4434 (connection == USB_PORT_STAT_CONNECTION))
4435 stable_time += HUB_DEBOUNCE_STEP;
4436 if (stable_time >= HUB_DEBOUNCE_STABLE)
4440 connection = portstatus & USB_PORT_STAT_CONNECTION;
4443 if (portchange & USB_PORT_STAT_C_CONNECTION) {
4444 usb_clear_port_feature(hub->hdev, port1,
4445 USB_PORT_FEAT_C_CONNECTION);
4448 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
4450 msleep(HUB_DEBOUNCE_STEP);
4453 dev_dbg(&port_dev->dev, "debounce total %dms stable %dms status 0x%x\n",
4454 total_time, stable_time, portstatus);
4456 if (stable_time < HUB_DEBOUNCE_STABLE)
4461 void usb_ep0_reinit(struct usb_device *udev)
4463 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
4464 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
4465 usb_enable_endpoint(udev, &udev->ep0, true);
4467 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
4469 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
4470 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
4472 static int hub_set_address(struct usb_device *udev, int devnum)
4475 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4478 * The host controller will choose the device address,
4479 * instead of the core having chosen it earlier
4481 if (!hcd->driver->address_device && devnum <= 1)
4483 if (udev->state == USB_STATE_ADDRESS)
4485 if (udev->state != USB_STATE_DEFAULT)
4487 if (hcd->driver->address_device)
4488 retval = hcd->driver->address_device(hcd, udev);
4490 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
4491 USB_REQ_SET_ADDRESS, 0, devnum, 0,
4492 NULL, 0, USB_CTRL_SET_TIMEOUT);
4494 update_devnum(udev, devnum);
4495 /* Device now using proper address. */
4496 usb_set_device_state(udev, USB_STATE_ADDRESS);
4497 usb_ep0_reinit(udev);
4503 * There are reports of USB 3.0 devices that say they support USB 2.0 Link PM
4504 * when they're plugged into a USB 2.0 port, but they don't work when LPM is
4507 * Only enable USB 2.0 Link PM if the port is internal (hardwired), or the
4508 * device says it supports the new USB 2.0 Link PM errata by setting the BESL
4509 * support bit in the BOS descriptor.
4511 static void hub_set_initial_usb2_lpm_policy(struct usb_device *udev)
4513 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
4514 int connect_type = USB_PORT_CONNECT_TYPE_UNKNOWN;
4516 if (!udev->usb2_hw_lpm_capable || !udev->bos)
4520 connect_type = hub->ports[udev->portnum - 1]->connect_type;
4522 if ((udev->bos->ext_cap->bmAttributes & cpu_to_le32(USB_BESL_SUPPORT)) ||
4523 connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
4524 udev->usb2_hw_lpm_allowed = 1;
4525 usb_enable_usb2_hardware_lpm(udev);
4529 static int hub_enable_device(struct usb_device *udev)
4531 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4533 if (!hcd->driver->enable_device)
4535 if (udev->state == USB_STATE_ADDRESS)
4537 if (udev->state != USB_STATE_DEFAULT)
4540 return hcd->driver->enable_device(hcd, udev);
4543 /* Reset device, (re)assign address, get device descriptor.
4544 * Device connection must be stable, no more debouncing needed.
4545 * Returns device in USB_STATE_ADDRESS, except on error.
4547 * If this is called for an already-existing device (as part of
4548 * usb_reset_and_verify_device), the caller must own the device lock and
4549 * the port lock. For a newly detected device that is not accessible
4550 * through any global pointers, it's not necessary to lock the device,
4551 * but it is still necessary to lock the port.
4554 hub_port_init(struct usb_hub *hub, struct usb_device *udev, int port1,
4557 struct usb_device *hdev = hub->hdev;
4558 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4559 struct usb_port *port_dev = hub->ports[port1 - 1];
4560 int retries, operations, retval, i;
4561 unsigned delay = HUB_SHORT_RESET_TIME;
4562 enum usb_device_speed oldspeed = udev->speed;
4564 int devnum = udev->devnum;
4565 const char *driver_name;
4567 /* root hub ports have a slightly longer reset period
4568 * (from USB 2.0 spec, section 7.1.7.5)
4570 if (!hdev->parent) {
4571 delay = HUB_ROOT_RESET_TIME;
4572 if (port1 == hdev->bus->otg_port)
4573 hdev->bus->b_hnp_enable = 0;
4576 /* Some low speed devices have problems with the quick delay, so */
4577 /* be a bit pessimistic with those devices. RHbug #23670 */
4578 if (oldspeed == USB_SPEED_LOW)
4579 delay = HUB_LONG_RESET_TIME;
4581 /* Reset the device; full speed may morph to high speed */
4582 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
4583 retval = hub_port_reset(hub, port1, udev, delay, false);
4584 if (retval < 0) /* error or disconnect */
4586 /* success, speed is known */
4590 /* Don't allow speed changes at reset, except usb 3.0 to faster */
4591 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed &&
4592 !(oldspeed == USB_SPEED_SUPER && udev->speed > oldspeed)) {
4593 dev_dbg(&udev->dev, "device reset changed speed!\n");
4596 oldspeed = udev->speed;
4598 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4599 * it's fixed size except for full speed devices.
4600 * For Wireless USB devices, ep0 max packet is always 512 (tho
4601 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4603 switch (udev->speed) {
4604 case USB_SPEED_SUPER_PLUS:
4605 case USB_SPEED_SUPER:
4606 case USB_SPEED_WIRELESS: /* fixed at 512 */
4607 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
4609 case USB_SPEED_HIGH: /* fixed at 64 */
4610 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4612 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
4613 /* to determine the ep0 maxpacket size, try to read
4614 * the device descriptor to get bMaxPacketSize0 and
4615 * then correct our initial guess.
4617 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4619 case USB_SPEED_LOW: /* fixed at 8 */
4620 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
4626 if (udev->speed == USB_SPEED_WIRELESS)
4627 speed = "variable speed Wireless";
4629 speed = usb_speed_string(udev->speed);
4632 * The controller driver may be NULL if the controller device
4633 * is the middle device between platform device and roothub.
4634 * This middle device may not need a device driver due to
4635 * all hardware control can be at platform device driver, this
4636 * platform device is usually a dual-role USB controller device.
4638 if (udev->bus->controller->driver)
4639 driver_name = udev->bus->controller->driver->name;
4641 driver_name = udev->bus->sysdev->driver->name;
4643 if (udev->speed < USB_SPEED_SUPER)
4644 dev_info(&udev->dev,
4645 "%s %s USB device number %d using %s\n",
4646 (udev->config) ? "reset" : "new", speed,
4647 devnum, driver_name);
4649 /* Set up TT records, if needed */
4651 udev->tt = hdev->tt;
4652 udev->ttport = hdev->ttport;
4653 } else if (udev->speed != USB_SPEED_HIGH
4654 && hdev->speed == USB_SPEED_HIGH) {
4656 dev_err(&udev->dev, "parent hub has no TT\n");
4660 udev->tt = &hub->tt;
4661 udev->ttport = port1;
4664 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4665 * Because device hardware and firmware is sometimes buggy in
4666 * this area, and this is how Linux has done it for ages.
4667 * Change it cautiously.
4669 * NOTE: If use_new_scheme() is true we will start by issuing
4670 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4671 * so it may help with some non-standards-compliant devices.
4672 * Otherwise we start with SET_ADDRESS and then try to read the
4673 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4676 for (retries = 0; retries < GET_DESCRIPTOR_TRIES; (++retries, msleep(100))) {
4677 bool did_new_scheme = false;
4679 if (use_new_scheme(udev, retry_counter, port_dev)) {
4680 struct usb_device_descriptor *buf;
4683 did_new_scheme = true;
4684 retval = hub_enable_device(udev);
4687 "hub failed to enable device, error %d\n",
4692 #define GET_DESCRIPTOR_BUFSIZE 64
4693 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
4699 /* Retry on all errors; some devices are flakey.
4700 * 255 is for WUSB devices, we actually need to use
4701 * 512 (WUSB1.0[4.8.1]).
4703 for (operations = 0; operations < 3; ++operations) {
4704 buf->bMaxPacketSize0 = 0;
4705 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
4706 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
4707 USB_DT_DEVICE << 8, 0,
4708 buf, GET_DESCRIPTOR_BUFSIZE,
4709 initial_descriptor_timeout);
4710 switch (buf->bMaxPacketSize0) {
4711 case 8: case 16: case 32: case 64: case 255:
4712 if (buf->bDescriptorType ==
4724 * Some devices time out if they are powered on
4725 * when already connected. They need a second
4726 * reset. But only on the first attempt,
4727 * lest we get into a time out/reset loop
4729 if (r == 0 || (r == -ETIMEDOUT &&
4731 udev->speed > USB_SPEED_FULL))
4734 udev->descriptor.bMaxPacketSize0 =
4735 buf->bMaxPacketSize0;
4738 retval = hub_port_reset(hub, port1, udev, delay, false);
4739 if (retval < 0) /* error or disconnect */
4741 if (oldspeed != udev->speed) {
4743 "device reset changed speed!\n");
4749 dev_err(&udev->dev, "device descriptor read/64, error %d\n",
4754 #undef GET_DESCRIPTOR_BUFSIZE
4758 * If device is WUSB, we already assigned an
4759 * unauthorized address in the Connect Ack sequence;
4760 * authorization will assign the final address.
4762 if (udev->wusb == 0) {
4763 for (operations = 0; operations < SET_ADDRESS_TRIES; ++operations) {
4764 retval = hub_set_address(udev, devnum);
4770 if (retval != -ENODEV)
4771 dev_err(&udev->dev, "device not accepting address %d, error %d\n",
4775 if (udev->speed >= USB_SPEED_SUPER) {
4776 devnum = udev->devnum;
4777 dev_info(&udev->dev,
4778 "%s SuperSpeed%s%s USB device number %d using %s\n",
4779 (udev->config) ? "reset" : "new",
4780 (udev->speed == USB_SPEED_SUPER_PLUS) ?
4781 "Plus Gen 2" : " Gen 1",
4782 (udev->rx_lanes == 2 && udev->tx_lanes == 2) ?
4784 devnum, driver_name);
4787 /* cope with hardware quirkiness:
4788 * - let SET_ADDRESS settle, some device hardware wants it
4789 * - read ep0 maxpacket even for high and low speed,
4792 /* use_new_scheme() checks the speed which may have
4793 * changed since the initial look so we cache the result
4800 retval = usb_get_device_descriptor(udev, 8);
4802 if (retval != -ENODEV)
4804 "device descriptor read/8, error %d\n",
4813 delay = udev->parent->hub_delay;
4814 udev->hub_delay = min_t(u32, delay,
4815 USB_TP_TRANSMISSION_DELAY_MAX);
4816 retval = usb_set_isoch_delay(udev);
4819 "Failed set isoch delay, error %d\n",
4830 * Some superspeed devices have finished the link training process
4831 * and attached to a superspeed hub port, but the device descriptor
4832 * got from those devices show they aren't superspeed devices. Warm
4833 * reset the port attached by the devices can fix them.
4835 if ((udev->speed >= USB_SPEED_SUPER) &&
4836 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
4837 dev_err(&udev->dev, "got a wrong device descriptor, "
4838 "warm reset device\n");
4839 hub_port_reset(hub, port1, udev,
4840 HUB_BH_RESET_TIME, true);
4845 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
4846 udev->speed >= USB_SPEED_SUPER)
4849 i = udev->descriptor.bMaxPacketSize0;
4850 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
4851 if (udev->speed == USB_SPEED_LOW ||
4852 !(i == 8 || i == 16 || i == 32 || i == 64)) {
4853 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
4857 if (udev->speed == USB_SPEED_FULL)
4858 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
4860 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
4861 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
4862 usb_ep0_reinit(udev);
4865 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
4866 if (retval < (signed)sizeof(udev->descriptor)) {
4867 if (retval != -ENODEV)
4868 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
4875 usb_detect_quirks(udev);
4877 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
4878 retval = usb_get_bos_descriptor(udev);
4880 udev->lpm_capable = usb_device_supports_lpm(udev);
4881 usb_set_lpm_parameters(udev);
4886 /* notify HCD that we have a device connected and addressed */
4887 if (hcd->driver->update_device)
4888 hcd->driver->update_device(hcd, udev);
4889 hub_set_initial_usb2_lpm_policy(udev);
4892 hub_port_disable(hub, port1, 0);
4893 update_devnum(udev, devnum); /* for disconnect processing */
4899 check_highspeed(struct usb_hub *hub, struct usb_device *udev, int port1)
4901 struct usb_qualifier_descriptor *qual;
4904 if (udev->quirks & USB_QUIRK_DEVICE_QUALIFIER)
4907 qual = kmalloc(sizeof *qual, GFP_KERNEL);
4911 status = usb_get_descriptor(udev, USB_DT_DEVICE_QUALIFIER, 0,
4912 qual, sizeof *qual);
4913 if (status == sizeof *qual) {
4914 dev_info(&udev->dev, "not running at top speed; "
4915 "connect to a high speed hub\n");
4916 /* hub LEDs are probably harder to miss than syslog */
4917 if (hub->has_indicators) {
4918 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
4919 queue_delayed_work(system_power_efficient_wq,
4927 hub_power_remaining(struct usb_hub *hub)
4929 struct usb_device *hdev = hub->hdev;
4933 if (!hub->limited_power)
4936 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
4937 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
4938 struct usb_port *port_dev = hub->ports[port1 - 1];
4939 struct usb_device *udev = port_dev->child;
4945 if (hub_is_superspeed(udev))
4951 * Unconfigured devices may not use more than one unit load,
4952 * or 8mA for OTG ports
4954 if (udev->actconfig)
4955 delta = usb_get_max_power(udev, udev->actconfig);
4956 else if (port1 != udev->bus->otg_port || hdev->parent)
4960 if (delta > hub->mA_per_port)
4961 dev_warn(&port_dev->dev, "%dmA is over %umA budget!\n",
4962 delta, hub->mA_per_port);
4965 if (remaining < 0) {
4966 dev_warn(hub->intfdev, "%dmA over power budget!\n",
4973 static void hub_port_connect(struct usb_hub *hub, int port1, u16 portstatus,
4976 int status = -ENODEV;
4979 struct usb_device *hdev = hub->hdev;
4980 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4981 struct usb_port *port_dev = hub->ports[port1 - 1];
4982 struct usb_device *udev = port_dev->child;
4983 static int unreliable_port = -1;
4986 /* Disconnect any existing devices under this port */
4988 if (hcd->usb_phy && !hdev->parent)
4989 usb_phy_notify_disconnect(hcd->usb_phy, udev->speed);
4990 usb_disconnect(&port_dev->child);
4993 /* We can forget about a "removed" device when there's a physical
4994 * disconnect or the connect status changes.
4996 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4997 (portchange & USB_PORT_STAT_C_CONNECTION))
4998 clear_bit(port1, hub->removed_bits);
5000 if (portchange & (USB_PORT_STAT_C_CONNECTION |
5001 USB_PORT_STAT_C_ENABLE)) {
5002 status = hub_port_debounce_be_stable(hub, port1);
5004 if (status != -ENODEV &&
5005 port1 != unreliable_port &&
5007 dev_err(&port_dev->dev, "connect-debounce failed\n");
5008 portstatus &= ~USB_PORT_STAT_CONNECTION;
5009 unreliable_port = port1;
5011 portstatus = status;
5015 /* Return now if debouncing failed or nothing is connected or
5016 * the device was "removed".
5018 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
5019 test_bit(port1, hub->removed_bits)) {
5022 * maybe switch power back on (e.g. root hub was reset)
5023 * but only if the port isn't owned by someone else.
5025 if (hub_is_port_power_switchable(hub)
5026 && !port_is_power_on(hub, portstatus)
5027 && !port_dev->port_owner)
5028 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
5030 if (portstatus & USB_PORT_STAT_ENABLE)
5034 if (hub_is_superspeed(hub->hdev))
5041 for (i = 0; i < SET_CONFIG_TRIES; i++) {
5042 usb_lock_port(port_dev);
5043 mutex_lock(hcd->address0_mutex);
5044 retry_locked = true;
5046 /* reallocate for each attempt, since references
5047 * to the previous one can escape in various ways
5049 udev = usb_alloc_dev(hdev, hdev->bus, port1);
5051 dev_err(&port_dev->dev,
5052 "couldn't allocate usb_device\n");
5053 mutex_unlock(hcd->address0_mutex);
5054 usb_unlock_port(port_dev);
5058 usb_set_device_state(udev, USB_STATE_POWERED);
5059 udev->bus_mA = hub->mA_per_port;
5060 udev->level = hdev->level + 1;
5061 udev->wusb = hub_is_wusb(hub);
5063 /* Devices connected to SuperSpeed hubs are USB 3.0 or later */
5064 if (hub_is_superspeed(hub->hdev))
5065 udev->speed = USB_SPEED_SUPER;
5067 udev->speed = USB_SPEED_UNKNOWN;
5069 choose_devnum(udev);
5070 if (udev->devnum <= 0) {
5071 status = -ENOTCONN; /* Don't retry */
5075 /* reset (non-USB 3.0 devices) and get descriptor */
5076 status = hub_port_init(hub, udev, port1, i);
5080 mutex_unlock(hcd->address0_mutex);
5081 usb_unlock_port(port_dev);
5082 retry_locked = false;
5084 if (udev->quirks & USB_QUIRK_DELAY_INIT)
5087 /* consecutive bus-powered hubs aren't reliable; they can
5088 * violate the voltage drop budget. if the new child has
5089 * a "powered" LED, users should notice we didn't enable it
5090 * (without reading syslog), even without per-port LEDs
5093 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
5094 && udev->bus_mA <= unit_load) {
5097 status = usb_get_std_status(udev, USB_RECIP_DEVICE, 0,
5100 dev_dbg(&udev->dev, "get status %d ?\n", status);
5103 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
5105 "can't connect bus-powered hub "
5107 if (hub->has_indicators) {
5108 hub->indicator[port1-1] =
5109 INDICATOR_AMBER_BLINK;
5111 system_power_efficient_wq,
5114 status = -ENOTCONN; /* Don't retry */
5119 /* check for devices running slower than they could */
5120 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
5121 && udev->speed == USB_SPEED_FULL
5122 && highspeed_hubs != 0)
5123 check_highspeed(hub, udev, port1);
5125 /* Store the parent's children[] pointer. At this point
5126 * udev becomes globally accessible, although presumably
5127 * no one will look at it until hdev is unlocked.
5131 mutex_lock(&usb_port_peer_mutex);
5133 /* We mustn't add new devices if the parent hub has
5134 * been disconnected; we would race with the
5135 * recursively_mark_NOTATTACHED() routine.
5137 spin_lock_irq(&device_state_lock);
5138 if (hdev->state == USB_STATE_NOTATTACHED)
5141 port_dev->child = udev;
5142 spin_unlock_irq(&device_state_lock);
5143 mutex_unlock(&usb_port_peer_mutex);
5145 /* Run it through the hoops (find a driver, etc) */
5147 status = usb_new_device(udev);
5149 mutex_lock(&usb_port_peer_mutex);
5150 spin_lock_irq(&device_state_lock);
5151 port_dev->child = NULL;
5152 spin_unlock_irq(&device_state_lock);
5153 mutex_unlock(&usb_port_peer_mutex);
5155 if (hcd->usb_phy && !hdev->parent)
5156 usb_phy_notify_connect(hcd->usb_phy,
5164 status = hub_power_remaining(hub);
5166 dev_dbg(hub->intfdev, "%dmA power budget left\n", status);
5171 hub_port_disable(hub, port1, 1);
5173 usb_ep0_reinit(udev);
5174 release_devnum(udev);
5177 mutex_unlock(hcd->address0_mutex);
5178 usb_unlock_port(port_dev);
5181 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
5184 /* When halfway through our retry count, power-cycle the port */
5185 if (i == (SET_CONFIG_TRIES / 2) - 1) {
5186 dev_info(&port_dev->dev, "attempt power cycle\n");
5187 usb_hub_set_port_power(hdev, hub, port1, false);
5188 msleep(2 * hub_power_on_good_delay(hub));
5189 usb_hub_set_port_power(hdev, hub, port1, true);
5190 msleep(hub_power_on_good_delay(hub));
5193 if (hub->hdev->parent ||
5194 !hcd->driver->port_handed_over ||
5195 !(hcd->driver->port_handed_over)(hcd, port1)) {
5196 if (status != -ENOTCONN && status != -ENODEV)
5197 dev_err(&port_dev->dev,
5198 "unable to enumerate USB device\n");
5202 hub_port_disable(hub, port1, 1);
5203 if (hcd->driver->relinquish_port && !hub->hdev->parent) {
5204 if (status != -ENOTCONN && status != -ENODEV)
5205 hcd->driver->relinquish_port(hcd, port1);
5209 /* Handle physical or logical connection change events.
5210 * This routine is called when:
5211 * a port connection-change occurs;
5212 * a port enable-change occurs (often caused by EMI);
5213 * usb_reset_and_verify_device() encounters changed descriptors (as from
5214 * a firmware download)
5215 * caller already locked the hub
5217 static void hub_port_connect_change(struct usb_hub *hub, int port1,
5218 u16 portstatus, u16 portchange)
5219 __must_hold(&port_dev->status_lock)
5221 struct usb_port *port_dev = hub->ports[port1 - 1];
5222 struct usb_device *udev = port_dev->child;
5223 int status = -ENODEV;
5225 dev_dbg(&port_dev->dev, "status %04x, change %04x, %s\n", portstatus,
5226 portchange, portspeed(hub, portstatus));
5228 if (hub->has_indicators) {
5229 set_port_led(hub, port1, HUB_LED_AUTO);
5230 hub->indicator[port1-1] = INDICATOR_AUTO;
5233 #ifdef CONFIG_USB_OTG
5234 /* during HNP, don't repeat the debounce */
5235 if (hub->hdev->bus->is_b_host)
5236 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
5237 USB_PORT_STAT_C_ENABLE);
5240 /* Try to resuscitate an existing device */
5241 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
5242 udev->state != USB_STATE_NOTATTACHED) {
5243 if (portstatus & USB_PORT_STAT_ENABLE) {
5244 status = 0; /* Nothing to do */
5246 } else if (udev->state == USB_STATE_SUSPENDED &&
5247 udev->persist_enabled) {
5248 /* For a suspended device, treat this as a
5249 * remote wakeup event.
5251 usb_unlock_port(port_dev);
5252 status = usb_remote_wakeup(udev);
5253 usb_lock_port(port_dev);
5256 /* Don't resuscitate */;
5259 clear_bit(port1, hub->change_bits);
5261 /* successfully revalidated the connection */
5265 usb_unlock_port(port_dev);
5266 hub_port_connect(hub, port1, portstatus, portchange);
5267 usb_lock_port(port_dev);
5270 static void port_event(struct usb_hub *hub, int port1)
5271 __must_hold(&port_dev->status_lock)
5274 struct usb_port *port_dev = hub->ports[port1 - 1];
5275 struct usb_device *udev = port_dev->child;
5276 struct usb_device *hdev = hub->hdev;
5277 u16 portstatus, portchange;
5279 connect_change = test_bit(port1, hub->change_bits);
5280 clear_bit(port1, hub->event_bits);
5281 clear_bit(port1, hub->wakeup_bits);
5283 if (hub_port_status(hub, port1, &portstatus, &portchange) < 0)
5286 if (portchange & USB_PORT_STAT_C_CONNECTION) {
5287 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_CONNECTION);
5291 if (portchange & USB_PORT_STAT_C_ENABLE) {
5292 if (!connect_change)
5293 dev_dbg(&port_dev->dev, "enable change, status %08x\n",
5295 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_ENABLE);
5298 * EM interference sometimes causes badly shielded USB devices
5299 * to be shutdown by the hub, this hack enables them again.
5300 * Works at least with mouse driver.
5302 if (!(portstatus & USB_PORT_STAT_ENABLE)
5303 && !connect_change && udev) {
5304 dev_err(&port_dev->dev, "disabled by hub (EMI?), re-enabling...\n");
5309 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
5310 u16 status = 0, unused;
5311 port_dev->over_current_count++;
5313 dev_dbg(&port_dev->dev, "over-current change #%u\n",
5314 port_dev->over_current_count);
5315 usb_clear_port_feature(hdev, port1,
5316 USB_PORT_FEAT_C_OVER_CURRENT);
5317 msleep(100); /* Cool down */
5318 hub_power_on(hub, true);
5319 hub_port_status(hub, port1, &status, &unused);
5320 if (status & USB_PORT_STAT_OVERCURRENT)
5321 dev_err(&port_dev->dev, "over-current condition\n");
5324 if (portchange & USB_PORT_STAT_C_RESET) {
5325 dev_dbg(&port_dev->dev, "reset change\n");
5326 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_RESET);
5328 if ((portchange & USB_PORT_STAT_C_BH_RESET)
5329 && hub_is_superspeed(hdev)) {
5330 dev_dbg(&port_dev->dev, "warm reset change\n");
5331 usb_clear_port_feature(hdev, port1,
5332 USB_PORT_FEAT_C_BH_PORT_RESET);
5334 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
5335 dev_dbg(&port_dev->dev, "link state change\n");
5336 usb_clear_port_feature(hdev, port1,
5337 USB_PORT_FEAT_C_PORT_LINK_STATE);
5339 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
5340 dev_warn(&port_dev->dev, "config error\n");
5341 usb_clear_port_feature(hdev, port1,
5342 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
5345 /* skip port actions that require the port to be powered on */
5346 if (!pm_runtime_active(&port_dev->dev))
5349 if (hub_handle_remote_wakeup(hub, port1, portstatus, portchange))
5353 * Warm reset a USB3 protocol port if it's in
5354 * SS.Inactive state.
5356 if (hub_port_warm_reset_required(hub, port1, portstatus)) {
5357 dev_dbg(&port_dev->dev, "do warm reset\n");
5358 if (!udev || !(portstatus & USB_PORT_STAT_CONNECTION)
5359 || udev->state == USB_STATE_NOTATTACHED) {
5360 if (hub_port_reset(hub, port1, NULL,
5361 HUB_BH_RESET_TIME, true) < 0)
5362 hub_port_disable(hub, port1, 1);
5364 usb_unlock_port(port_dev);
5365 usb_lock_device(udev);
5366 usb_reset_device(udev);
5367 usb_unlock_device(udev);
5368 usb_lock_port(port_dev);
5374 hub_port_connect_change(hub, port1, portstatus, portchange);
5377 static void hub_event(struct work_struct *work)
5379 struct usb_device *hdev;
5380 struct usb_interface *intf;
5381 struct usb_hub *hub;
5382 struct device *hub_dev;
5387 hub = container_of(work, struct usb_hub, events);
5389 hub_dev = hub->intfdev;
5390 intf = to_usb_interface(hub_dev);
5392 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
5393 hdev->state, hdev->maxchild,
5394 /* NOTE: expects max 15 ports... */
5395 (u16) hub->change_bits[0],
5396 (u16) hub->event_bits[0]);
5398 /* Lock the device, then check to see if we were
5399 * disconnected while waiting for the lock to succeed. */
5400 usb_lock_device(hdev);
5401 if (unlikely(hub->disconnected))
5404 /* If the hub has died, clean up after it */
5405 if (hdev->state == USB_STATE_NOTATTACHED) {
5406 hub->error = -ENODEV;
5407 hub_quiesce(hub, HUB_DISCONNECT);
5412 ret = usb_autopm_get_interface(intf);
5414 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
5418 /* If this is an inactive hub, do nothing */
5423 dev_dbg(hub_dev, "resetting for error %d\n", hub->error);
5425 ret = usb_reset_device(hdev);
5427 dev_dbg(hub_dev, "error resetting hub: %d\n", ret);
5435 /* deal with port status changes */
5436 for (i = 1; i <= hdev->maxchild; i++) {
5437 struct usb_port *port_dev = hub->ports[i - 1];
5439 if (test_bit(i, hub->event_bits)
5440 || test_bit(i, hub->change_bits)
5441 || test_bit(i, hub->wakeup_bits)) {
5443 * The get_noresume and barrier ensure that if
5444 * the port was in the process of resuming, we
5445 * flush that work and keep the port active for
5446 * the duration of the port_event(). However,
5447 * if the port is runtime pm suspended
5448 * (powered-off), we leave it in that state, run
5449 * an abbreviated port_event(), and move on.
5451 pm_runtime_get_noresume(&port_dev->dev);
5452 pm_runtime_barrier(&port_dev->dev);
5453 usb_lock_port(port_dev);
5455 usb_unlock_port(port_dev);
5456 pm_runtime_put_sync(&port_dev->dev);
5460 /* deal with hub status changes */
5461 if (test_and_clear_bit(0, hub->event_bits) == 0)
5463 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
5464 dev_err(hub_dev, "get_hub_status failed\n");
5466 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
5467 dev_dbg(hub_dev, "power change\n");
5468 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
5469 if (hubstatus & HUB_STATUS_LOCAL_POWER)
5470 /* FIXME: Is this always true? */
5471 hub->limited_power = 1;
5473 hub->limited_power = 0;
5475 if (hubchange & HUB_CHANGE_OVERCURRENT) {
5479 dev_dbg(hub_dev, "over-current change\n");
5480 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
5481 msleep(500); /* Cool down */
5482 hub_power_on(hub, true);
5483 hub_hub_status(hub, &status, &unused);
5484 if (status & HUB_STATUS_OVERCURRENT)
5485 dev_err(hub_dev, "over-current condition\n");
5490 /* Balance the usb_autopm_get_interface() above */
5491 usb_autopm_put_interface_no_suspend(intf);
5493 usb_unlock_device(hdev);
5495 /* Balance the stuff in kick_hub_wq() and allow autosuspend */
5496 usb_autopm_put_interface(intf);
5497 kref_put(&hub->kref, hub_release);
5500 static const struct usb_device_id hub_id_table[] = {
5501 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5502 | USB_DEVICE_ID_MATCH_PRODUCT
5503 | USB_DEVICE_ID_MATCH_INT_CLASS,
5504 .idVendor = USB_VENDOR_SMSC,
5505 .idProduct = USB_PRODUCT_USB5534B,
5506 .bInterfaceClass = USB_CLASS_HUB,
5507 .driver_info = HUB_QUIRK_DISABLE_AUTOSUSPEND},
5508 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5509 | USB_DEVICE_ID_MATCH_PRODUCT,
5510 .idVendor = USB_VENDOR_CYPRESS,
5511 .idProduct = USB_PRODUCT_CY7C65632,
5512 .driver_info = HUB_QUIRK_DISABLE_AUTOSUSPEND},
5513 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5514 | USB_DEVICE_ID_MATCH_INT_CLASS,
5515 .idVendor = USB_VENDOR_GENESYS_LOGIC,
5516 .bInterfaceClass = USB_CLASS_HUB,
5517 .driver_info = HUB_QUIRK_CHECK_PORT_AUTOSUSPEND},
5518 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
5519 .bDeviceClass = USB_CLASS_HUB},
5520 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
5521 .bInterfaceClass = USB_CLASS_HUB},
5522 { } /* Terminating entry */
5525 MODULE_DEVICE_TABLE(usb, hub_id_table);
5527 static struct usb_driver hub_driver = {
5530 .disconnect = hub_disconnect,
5531 .suspend = hub_suspend,
5532 .resume = hub_resume,
5533 .reset_resume = hub_reset_resume,
5534 .pre_reset = hub_pre_reset,
5535 .post_reset = hub_post_reset,
5536 .unlocked_ioctl = hub_ioctl,
5537 .id_table = hub_id_table,
5538 .supports_autosuspend = 1,
5541 int usb_hub_init(void)
5543 if (usb_register(&hub_driver) < 0) {
5544 printk(KERN_ERR "%s: can't register hub driver\n",
5550 * The workqueue needs to be freezable to avoid interfering with
5551 * USB-PERSIST port handover. Otherwise it might see that a full-speed
5552 * device was gone before the EHCI controller had handed its port
5553 * over to the companion full-speed controller.
5555 hub_wq = alloc_workqueue("usb_hub_wq", WQ_FREEZABLE, 0);
5559 /* Fall through if kernel_thread failed */
5560 usb_deregister(&hub_driver);
5561 pr_err("%s: can't allocate workqueue for usb hub\n", usbcore_name);
5566 void usb_hub_cleanup(void)
5568 destroy_workqueue(hub_wq);
5571 * Hub resources are freed for us by usb_deregister. It calls
5572 * usb_driver_purge on every device which in turn calls that
5573 * devices disconnect function if it is using this driver.
5574 * The hub_disconnect function takes care of releasing the
5575 * individual hub resources. -greg
5577 usb_deregister(&hub_driver);
5578 } /* usb_hub_cleanup() */
5580 static int descriptors_changed(struct usb_device *udev,
5581 struct usb_device_descriptor *old_device_descriptor,
5582 struct usb_host_bos *old_bos)
5586 unsigned serial_len = 0;
5588 unsigned old_length;
5592 if (memcmp(&udev->descriptor, old_device_descriptor,
5593 sizeof(*old_device_descriptor)) != 0)
5596 if ((old_bos && !udev->bos) || (!old_bos && udev->bos))
5599 len = le16_to_cpu(udev->bos->desc->wTotalLength);
5600 if (len != le16_to_cpu(old_bos->desc->wTotalLength))
5602 if (memcmp(udev->bos->desc, old_bos->desc, len))
5606 /* Since the idVendor, idProduct, and bcdDevice values in the
5607 * device descriptor haven't changed, we will assume the
5608 * Manufacturer and Product strings haven't changed either.
5609 * But the SerialNumber string could be different (e.g., a
5610 * different flash card of the same brand).
5613 serial_len = strlen(udev->serial) + 1;
5616 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5617 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5618 len = max(len, old_length);
5621 buf = kmalloc(len, GFP_NOIO);
5623 /* assume the worst */
5626 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5627 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5628 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
5630 if (length != old_length) {
5631 dev_dbg(&udev->dev, "config index %d, error %d\n",
5636 if (memcmp(buf, udev->rawdescriptors[index], old_length)
5638 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
5640 ((struct usb_config_descriptor *) buf)->
5641 bConfigurationValue);
5647 if (!changed && serial_len) {
5648 length = usb_string(udev, udev->descriptor.iSerialNumber,
5650 if (length + 1 != serial_len) {
5651 dev_dbg(&udev->dev, "serial string error %d\n",
5654 } else if (memcmp(buf, udev->serial, length) != 0) {
5655 dev_dbg(&udev->dev, "serial string changed\n");
5665 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5666 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5668 * WARNING - don't use this routine to reset a composite device
5669 * (one with multiple interfaces owned by separate drivers)!
5670 * Use usb_reset_device() instead.
5672 * Do a port reset, reassign the device's address, and establish its
5673 * former operating configuration. If the reset fails, or the device's
5674 * descriptors change from their values before the reset, or the original
5675 * configuration and altsettings cannot be restored, a flag will be set
5676 * telling hub_wq to pretend the device has been disconnected and then
5677 * re-connected. All drivers will be unbound, and the device will be
5678 * re-enumerated and probed all over again.
5680 * Return: 0 if the reset succeeded, -ENODEV if the device has been
5681 * flagged for logical disconnection, or some other negative error code
5682 * if the reset wasn't even attempted.
5685 * The caller must own the device lock and the port lock, the latter is
5686 * taken by usb_reset_device(). For example, it's safe to use
5687 * usb_reset_device() from a driver probe() routine after downloading
5688 * new firmware. For calls that might not occur during probe(), drivers
5689 * should lock the device using usb_lock_device_for_reset().
5691 * Locking exception: This routine may also be called from within an
5692 * autoresume handler. Such usage won't conflict with other tasks
5693 * holding the device lock because these tasks should always call
5694 * usb_autopm_resume_device(), thereby preventing any unwanted
5695 * autoresume. The autoresume handler is expected to have already
5696 * acquired the port lock before calling this routine.
5698 static int usb_reset_and_verify_device(struct usb_device *udev)
5700 struct usb_device *parent_hdev = udev->parent;
5701 struct usb_hub *parent_hub;
5702 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
5703 struct usb_device_descriptor descriptor = udev->descriptor;
5704 struct usb_host_bos *bos;
5706 int port1 = udev->portnum;
5708 if (udev->state == USB_STATE_NOTATTACHED ||
5709 udev->state == USB_STATE_SUSPENDED) {
5710 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5718 parent_hub = usb_hub_to_struct_hub(parent_hdev);
5720 /* Disable USB2 hardware LPM.
5721 * It will be re-enabled by the enumeration process.
5723 usb_disable_usb2_hardware_lpm(udev);
5725 /* Disable LPM while we reset the device and reinstall the alt settings.
5726 * Device-initiated LPM, and system exit latency settings are cleared
5727 * when the device is reset, so we have to set them up again.
5729 ret = usb_unlocked_disable_lpm(udev);
5731 dev_err(&udev->dev, "%s Failed to disable LPM\n", __func__);
5732 goto re_enumerate_no_bos;
5738 mutex_lock(hcd->address0_mutex);
5740 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
5742 /* ep0 maxpacket size may change; let the HCD know about it.
5743 * Other endpoints will be handled by re-enumeration. */
5744 usb_ep0_reinit(udev);
5745 ret = hub_port_init(parent_hub, udev, port1, i);
5746 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
5749 mutex_unlock(hcd->address0_mutex);
5754 /* Device might have changed firmware (DFU or similar) */
5755 if (descriptors_changed(udev, &descriptor, bos)) {
5756 dev_info(&udev->dev, "device firmware changed\n");
5757 udev->descriptor = descriptor; /* for disconnect() calls */
5761 /* Restore the device's previous configuration */
5762 if (!udev->actconfig)
5765 mutex_lock(hcd->bandwidth_mutex);
5766 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
5768 dev_warn(&udev->dev,
5769 "Busted HC? Not enough HCD resources for "
5770 "old configuration.\n");
5771 mutex_unlock(hcd->bandwidth_mutex);
5774 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
5775 USB_REQ_SET_CONFIGURATION, 0,
5776 udev->actconfig->desc.bConfigurationValue, 0,
5777 NULL, 0, USB_CTRL_SET_TIMEOUT);
5780 "can't restore configuration #%d (error=%d)\n",
5781 udev->actconfig->desc.bConfigurationValue, ret);
5782 mutex_unlock(hcd->bandwidth_mutex);
5785 mutex_unlock(hcd->bandwidth_mutex);
5786 usb_set_device_state(udev, USB_STATE_CONFIGURED);
5788 /* Put interfaces back into the same altsettings as before.
5789 * Don't bother to send the Set-Interface request for interfaces
5790 * that were already in altsetting 0; besides being unnecessary,
5791 * many devices can't handle it. Instead just reset the host-side
5794 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
5795 struct usb_host_config *config = udev->actconfig;
5796 struct usb_interface *intf = config->interface[i];
5797 struct usb_interface_descriptor *desc;
5799 desc = &intf->cur_altsetting->desc;
5800 if (desc->bAlternateSetting == 0) {
5801 usb_disable_interface(udev, intf, true);
5802 usb_enable_interface(udev, intf, true);
5805 /* Let the bandwidth allocation function know that this
5806 * device has been reset, and it will have to use
5807 * alternate setting 0 as the current alternate setting.
5809 intf->resetting_device = 1;
5810 ret = usb_set_interface(udev, desc->bInterfaceNumber,
5811 desc->bAlternateSetting);
5812 intf->resetting_device = 0;
5815 dev_err(&udev->dev, "failed to restore interface %d "
5816 "altsetting %d (error=%d)\n",
5817 desc->bInterfaceNumber,
5818 desc->bAlternateSetting,
5822 /* Resetting also frees any allocated streams */
5823 for (j = 0; j < intf->cur_altsetting->desc.bNumEndpoints; j++)
5824 intf->cur_altsetting->endpoint[j].streams = 0;
5828 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5829 usb_enable_usb2_hardware_lpm(udev);
5830 usb_unlocked_enable_lpm(udev);
5831 usb_enable_ltm(udev);
5832 usb_release_bos_descriptor(udev);
5837 usb_release_bos_descriptor(udev);
5839 re_enumerate_no_bos:
5840 /* LPM state doesn't matter when we're about to destroy the device. */
5841 hub_port_logical_disconnect(parent_hub, port1);
5846 * usb_reset_device - warn interface drivers and perform a USB port reset
5847 * @udev: device to reset (not in NOTATTACHED state)
5849 * Warns all drivers bound to registered interfaces (using their pre_reset
5850 * method), performs the port reset, and then lets the drivers know that
5851 * the reset is over (using their post_reset method).
5853 * Return: The same as for usb_reset_and_verify_device().
5854 * However, if a reset is already in progress (for instance, if a
5855 * driver doesn't have pre_reset() or post_reset() callbacks, and while
5856 * being unbound or re-bound during the ongoing reset its disconnect()
5857 * or probe() routine tries to perform a second, nested reset), the
5858 * routine returns -EINPROGRESS.
5861 * The caller must own the device lock. For example, it's safe to use
5862 * this from a driver probe() routine after downloading new firmware.
5863 * For calls that might not occur during probe(), drivers should lock
5864 * the device using usb_lock_device_for_reset().
5866 * If an interface is currently being probed or disconnected, we assume
5867 * its driver knows how to handle resets. For all other interfaces,
5868 * if the driver doesn't have pre_reset and post_reset methods then
5869 * we attempt to unbind it and rebind afterward.
5871 int usb_reset_device(struct usb_device *udev)
5875 unsigned int noio_flag;
5876 struct usb_port *port_dev;
5877 struct usb_host_config *config = udev->actconfig;
5878 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
5880 if (udev->state == USB_STATE_NOTATTACHED) {
5881 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5886 if (!udev->parent) {
5887 /* this requires hcd-specific logic; see ohci_restart() */
5888 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
5892 if (udev->reset_in_progress)
5893 return -EINPROGRESS;
5894 udev->reset_in_progress = 1;
5896 port_dev = hub->ports[udev->portnum - 1];
5899 * Don't allocate memory with GFP_KERNEL in current
5900 * context to avoid possible deadlock if usb mass
5901 * storage interface or usbnet interface(iSCSI case)
5902 * is included in current configuration. The easist
5903 * approach is to do it for every device reset,
5904 * because the device 'memalloc_noio' flag may have
5905 * not been set before reseting the usb device.
5907 noio_flag = memalloc_noio_save();
5909 /* Prevent autosuspend during the reset */
5910 usb_autoresume_device(udev);
5913 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
5914 struct usb_interface *cintf = config->interface[i];
5915 struct usb_driver *drv;
5918 if (cintf->dev.driver) {
5919 drv = to_usb_driver(cintf->dev.driver);
5920 if (drv->pre_reset && drv->post_reset)
5921 unbind = (drv->pre_reset)(cintf);
5922 else if (cintf->condition ==
5923 USB_INTERFACE_BOUND)
5926 usb_forced_unbind_intf(cintf);
5931 usb_lock_port(port_dev);
5932 ret = usb_reset_and_verify_device(udev);
5933 usb_unlock_port(port_dev);
5936 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
5937 struct usb_interface *cintf = config->interface[i];
5938 struct usb_driver *drv;
5939 int rebind = cintf->needs_binding;
5941 if (!rebind && cintf->dev.driver) {
5942 drv = to_usb_driver(cintf->dev.driver);
5943 if (drv->post_reset)
5944 rebind = (drv->post_reset)(cintf);
5945 else if (cintf->condition ==
5946 USB_INTERFACE_BOUND)
5949 cintf->needs_binding = 1;
5953 /* If the reset failed, hub_wq will unbind drivers later */
5955 usb_unbind_and_rebind_marked_interfaces(udev);
5958 usb_autosuspend_device(udev);
5959 memalloc_noio_restore(noio_flag);
5960 udev->reset_in_progress = 0;
5963 EXPORT_SYMBOL_GPL(usb_reset_device);
5967 * usb_queue_reset_device - Reset a USB device from an atomic context
5968 * @iface: USB interface belonging to the device to reset
5970 * This function can be used to reset a USB device from an atomic
5971 * context, where usb_reset_device() won't work (as it blocks).
5973 * Doing a reset via this method is functionally equivalent to calling
5974 * usb_reset_device(), except for the fact that it is delayed to a
5975 * workqueue. This means that any drivers bound to other interfaces
5976 * might be unbound, as well as users from usbfs in user space.
5980 * - Scheduling two resets at the same time from two different drivers
5981 * attached to two different interfaces of the same device is
5982 * possible; depending on how the driver attached to each interface
5983 * handles ->pre_reset(), the second reset might happen or not.
5985 * - If the reset is delayed so long that the interface is unbound from
5986 * its driver, the reset will be skipped.
5988 * - This function can be called during .probe(). It can also be called
5989 * during .disconnect(), but doing so is pointless because the reset
5990 * will not occur. If you really want to reset the device during
5991 * .disconnect(), call usb_reset_device() directly -- but watch out
5992 * for nested unbinding issues!
5994 void usb_queue_reset_device(struct usb_interface *iface)
5996 if (schedule_work(&iface->reset_ws))
5997 usb_get_intf(iface);
5999 EXPORT_SYMBOL_GPL(usb_queue_reset_device);
6002 * usb_hub_find_child - Get the pointer of child device
6003 * attached to the port which is specified by @port1.
6004 * @hdev: USB device belonging to the usb hub
6005 * @port1: port num to indicate which port the child device
6008 * USB drivers call this function to get hub's child device
6011 * Return: %NULL if input param is invalid and
6012 * child's usb_device pointer if non-NULL.
6014 struct usb_device *usb_hub_find_child(struct usb_device *hdev,
6017 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
6019 if (port1 < 1 || port1 > hdev->maxchild)
6021 return hub->ports[port1 - 1]->child;
6023 EXPORT_SYMBOL_GPL(usb_hub_find_child);
6025 void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
6026 struct usb_hub_descriptor *desc)
6028 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
6029 enum usb_port_connect_type connect_type;
6035 if (!hub_is_superspeed(hdev)) {
6036 for (i = 1; i <= hdev->maxchild; i++) {
6037 struct usb_port *port_dev = hub->ports[i - 1];
6039 connect_type = port_dev->connect_type;
6040 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
6041 u8 mask = 1 << (i%8);
6043 if (!(desc->u.hs.DeviceRemovable[i/8] & mask)) {
6044 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
6045 desc->u.hs.DeviceRemovable[i/8] |= mask;
6050 u16 port_removable = le16_to_cpu(desc->u.ss.DeviceRemovable);
6052 for (i = 1; i <= hdev->maxchild; i++) {
6053 struct usb_port *port_dev = hub->ports[i - 1];
6055 connect_type = port_dev->connect_type;
6056 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
6059 if (!(port_removable & mask)) {
6060 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
6061 port_removable |= mask;
6066 desc->u.ss.DeviceRemovable = cpu_to_le16(port_removable);
6072 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
6073 * @hdev: USB device belonging to the usb hub
6074 * @port1: port num of the port
6076 * Return: Port's acpi handle if successful, %NULL if params are
6079 acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
6082 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
6087 return ACPI_HANDLE(&hub->ports[port1 - 1]->dev);