4 * (C) Copyright 1999 Linus Torvalds
5 * (C) Copyright 1999 Johannes Erdfelt
6 * (C) Copyright 1999 Gregory P. Smith
7 * (C) Copyright 2001 Brad Hards (bhards@bigpond.net.au)
11 #include <linux/kernel.h>
12 #include <linux/errno.h>
13 #include <linux/module.h>
14 #include <linux/moduleparam.h>
15 #include <linux/completion.h>
16 #include <linux/sched.h>
17 #include <linux/list.h>
18 #include <linux/slab.h>
19 #include <linux/ioctl.h>
20 #include <linux/usb.h>
21 #include <linux/usbdevice_fs.h>
22 #include <linux/usb/hcd.h>
23 #include <linux/usb/otg.h>
24 #include <linux/usb/quirks.h>
25 #include <linux/kthread.h>
26 #include <linux/mutex.h>
27 #include <linux/freezer.h>
28 #include <linux/random.h>
29 #include <linux/pm_qos.h>
31 #include <asm/uaccess.h>
32 #include <asm/byteorder.h>
36 #define USB_VENDOR_GENESYS_LOGIC 0x05e3
37 #define HUB_QUIRK_CHECK_PORT_AUTOSUSPEND 0x01
39 static inline int hub_is_superspeed(struct usb_device *hdev)
41 return (hdev->descriptor.bDeviceProtocol == USB_HUB_PR_SS);
44 /* Protect struct usb_device->state and ->children members
45 * Note: Both are also protected by ->dev.sem, except that ->state can
46 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
47 static DEFINE_SPINLOCK(device_state_lock);
49 /* khubd's worklist and its lock */
50 static DEFINE_SPINLOCK(hub_event_lock);
51 static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
54 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
56 static struct task_struct *khubd_task;
58 /* cycle leds on hubs that aren't blinking for attention */
59 static bool blinkenlights = 0;
60 module_param (blinkenlights, bool, S_IRUGO);
61 MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
64 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
65 * 10 seconds to send reply for the initial 64-byte descriptor request.
67 /* define initial 64-byte descriptor request timeout in milliseconds */
68 static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
69 module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
70 MODULE_PARM_DESC(initial_descriptor_timeout,
71 "initial 64-byte descriptor request timeout in milliseconds "
72 "(default 5000 - 5.0 seconds)");
75 * As of 2.6.10 we introduce a new USB device initialization scheme which
76 * closely resembles the way Windows works. Hopefully it will be compatible
77 * with a wider range of devices than the old scheme. However some previously
78 * working devices may start giving rise to "device not accepting address"
79 * errors; if that happens the user can try the old scheme by adjusting the
80 * following module parameters.
82 * For maximum flexibility there are two boolean parameters to control the
83 * hub driver's behavior. On the first initialization attempt, if the
84 * "old_scheme_first" parameter is set then the old scheme will be used,
85 * otherwise the new scheme is used. If that fails and "use_both_schemes"
86 * is set, then the driver will make another attempt, using the other scheme.
88 static bool old_scheme_first = 0;
89 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
90 MODULE_PARM_DESC(old_scheme_first,
91 "start with the old device initialization scheme");
93 static bool use_both_schemes = 1;
94 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
95 MODULE_PARM_DESC(use_both_schemes,
96 "try the other device initialization scheme if the "
99 /* Mutual exclusion for EHCI CF initialization. This interferes with
100 * port reset on some companion controllers.
102 DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
103 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
105 #define HUB_DEBOUNCE_TIMEOUT 2000
106 #define HUB_DEBOUNCE_STEP 25
107 #define HUB_DEBOUNCE_STABLE 100
109 static int usb_reset_and_verify_device(struct usb_device *udev);
111 static inline char *portspeed(struct usb_hub *hub, int portstatus)
113 if (hub_is_superspeed(hub->hdev))
115 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
117 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
123 /* Note that hdev or one of its children must be locked! */
124 struct usb_hub *usb_hub_to_struct_hub(struct usb_device *hdev)
126 if (!hdev || !hdev->actconfig || !hdev->maxchild)
128 return usb_get_intfdata(hdev->actconfig->interface[0]);
131 static int usb_device_supports_lpm(struct usb_device *udev)
133 /* USB 2.1 (and greater) devices indicate LPM support through
134 * their USB 2.0 Extended Capabilities BOS descriptor.
136 if (udev->speed == USB_SPEED_HIGH) {
137 if (udev->bos->ext_cap &&
139 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
144 /* All USB 3.0 must support LPM, but we need their max exit latency
145 * information from the SuperSpeed Extended Capabilities BOS descriptor.
147 if (!udev->bos->ss_cap) {
148 dev_warn(&udev->dev, "No LPM exit latency info found. "
149 "Power management will be impacted.\n");
152 if (udev->parent->lpm_capable)
155 dev_warn(&udev->dev, "Parent hub missing LPM exit latency info. "
156 "Power management will be impacted.\n");
161 * Set the Maximum Exit Latency (MEL) for the host to initiate a transition from
164 static void usb_set_lpm_mel(struct usb_device *udev,
165 struct usb3_lpm_parameters *udev_lpm_params,
166 unsigned int udev_exit_latency,
168 struct usb3_lpm_parameters *hub_lpm_params,
169 unsigned int hub_exit_latency)
171 unsigned int total_mel;
172 unsigned int device_mel;
173 unsigned int hub_mel;
176 * Calculate the time it takes to transition all links from the roothub
177 * to the parent hub into U0. The parent hub must then decode the
178 * packet (hub header decode latency) to figure out which port it was
181 * The Hub Header decode latency is expressed in 0.1us intervals (0x1
182 * means 0.1us). Multiply that by 100 to get nanoseconds.
184 total_mel = hub_lpm_params->mel +
185 (hub->descriptor->u.ss.bHubHdrDecLat * 100);
188 * How long will it take to transition the downstream hub's port into
189 * U0? The greater of either the hub exit latency or the device exit
192 * The BOS U1/U2 exit latencies are expressed in 1us intervals.
193 * Multiply that by 1000 to get nanoseconds.
195 device_mel = udev_exit_latency * 1000;
196 hub_mel = hub_exit_latency * 1000;
197 if (device_mel > hub_mel)
198 total_mel += device_mel;
200 total_mel += hub_mel;
202 udev_lpm_params->mel = total_mel;
206 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
207 * a transition from either U1 or U2.
209 static void usb_set_lpm_pel(struct usb_device *udev,
210 struct usb3_lpm_parameters *udev_lpm_params,
211 unsigned int udev_exit_latency,
213 struct usb3_lpm_parameters *hub_lpm_params,
214 unsigned int hub_exit_latency,
215 unsigned int port_to_port_exit_latency)
217 unsigned int first_link_pel;
218 unsigned int hub_pel;
221 * First, the device sends an LFPS to transition the link between the
222 * device and the parent hub into U0. The exit latency is the bigger of
223 * the device exit latency or the hub exit latency.
225 if (udev_exit_latency > hub_exit_latency)
226 first_link_pel = udev_exit_latency * 1000;
228 first_link_pel = hub_exit_latency * 1000;
231 * When the hub starts to receive the LFPS, there is a slight delay for
232 * it to figure out that one of the ports is sending an LFPS. Then it
233 * will forward the LFPS to its upstream link. The exit latency is the
234 * delay, plus the PEL that we calculated for this hub.
236 hub_pel = port_to_port_exit_latency * 1000 + hub_lpm_params->pel;
239 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
240 * is the greater of the two exit latencies.
242 if (first_link_pel > hub_pel)
243 udev_lpm_params->pel = first_link_pel;
245 udev_lpm_params->pel = hub_pel;
249 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
250 * when a device initiates a transition to U0, until when it will receive the
251 * first packet from the host controller.
253 * Section C.1.5.1 describes the four components to this:
255 * - t2: time for the ERDY to make it from the device to the host.
256 * - t3: a host-specific delay to process the ERDY.
257 * - t4: time for the packet to make it from the host to the device.
259 * t3 is specific to both the xHCI host and the platform the host is integrated
260 * into. The Intel HW folks have said it's negligible, FIXME if a different
261 * vendor says otherwise.
263 static void usb_set_lpm_sel(struct usb_device *udev,
264 struct usb3_lpm_parameters *udev_lpm_params)
266 struct usb_device *parent;
267 unsigned int num_hubs;
268 unsigned int total_sel;
270 /* t1 = device PEL */
271 total_sel = udev_lpm_params->pel;
272 /* How many external hubs are in between the device & the root port. */
273 for (parent = udev->parent, num_hubs = 0; parent->parent;
274 parent = parent->parent)
276 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
278 total_sel += 2100 + 250 * (num_hubs - 1);
280 /* t4 = 250ns * num_hubs */
281 total_sel += 250 * num_hubs;
283 udev_lpm_params->sel = total_sel;
286 static void usb_set_lpm_parameters(struct usb_device *udev)
289 unsigned int port_to_port_delay;
290 unsigned int udev_u1_del;
291 unsigned int udev_u2_del;
292 unsigned int hub_u1_del;
293 unsigned int hub_u2_del;
295 if (!udev->lpm_capable || udev->speed != USB_SPEED_SUPER)
298 hub = usb_hub_to_struct_hub(udev->parent);
299 /* It doesn't take time to transition the roothub into U0, since it
300 * doesn't have an upstream link.
305 udev_u1_del = udev->bos->ss_cap->bU1devExitLat;
306 udev_u2_del = le16_to_cpu(udev->bos->ss_cap->bU2DevExitLat);
307 hub_u1_del = udev->parent->bos->ss_cap->bU1devExitLat;
308 hub_u2_del = le16_to_cpu(udev->parent->bos->ss_cap->bU2DevExitLat);
310 usb_set_lpm_mel(udev, &udev->u1_params, udev_u1_del,
311 hub, &udev->parent->u1_params, hub_u1_del);
313 usb_set_lpm_mel(udev, &udev->u2_params, udev_u2_del,
314 hub, &udev->parent->u2_params, hub_u2_del);
317 * Appendix C, section C.2.2.2, says that there is a slight delay from
318 * when the parent hub notices the downstream port is trying to
319 * transition to U0 to when the hub initiates a U0 transition on its
320 * upstream port. The section says the delays are tPort2PortU1EL and
321 * tPort2PortU2EL, but it doesn't define what they are.
323 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
324 * about the same delays. Use the maximum delay calculations from those
325 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
326 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
327 * assume the device exit latencies they are talking about are the hub
330 * What do we do if the U2 exit latency is less than the U1 exit
331 * latency? It's possible, although not likely...
333 port_to_port_delay = 1;
335 usb_set_lpm_pel(udev, &udev->u1_params, udev_u1_del,
336 hub, &udev->parent->u1_params, hub_u1_del,
339 if (hub_u2_del > hub_u1_del)
340 port_to_port_delay = 1 + hub_u2_del - hub_u1_del;
342 port_to_port_delay = 1 + hub_u1_del;
344 usb_set_lpm_pel(udev, &udev->u2_params, udev_u2_del,
345 hub, &udev->parent->u2_params, hub_u2_del,
348 /* Now that we've got PEL, calculate SEL. */
349 usb_set_lpm_sel(udev, &udev->u1_params);
350 usb_set_lpm_sel(udev, &udev->u2_params);
353 /* USB 2.0 spec Section 11.24.4.5 */
354 static int get_hub_descriptor(struct usb_device *hdev, void *data)
359 if (hub_is_superspeed(hdev)) {
360 dtype = USB_DT_SS_HUB;
361 size = USB_DT_SS_HUB_SIZE;
364 size = sizeof(struct usb_hub_descriptor);
367 for (i = 0; i < 3; i++) {
368 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
369 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
370 dtype << 8, 0, data, size,
371 USB_CTRL_GET_TIMEOUT);
372 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
379 * USB 2.0 spec Section 11.24.2.1
381 static int clear_hub_feature(struct usb_device *hdev, int feature)
383 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
384 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
388 * USB 2.0 spec Section 11.24.2.2
390 int usb_clear_port_feature(struct usb_device *hdev, int port1, int feature)
392 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
393 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
398 * USB 2.0 spec Section 11.24.2.13
400 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
402 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
403 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
408 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
409 * for info about using port indicators
411 static void set_port_led(
417 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
418 USB_PORT_FEAT_INDICATOR);
420 dev_dbg (hub->intfdev,
421 "port %d indicator %s status %d\n",
423 ({ char *s; switch (selector) {
424 case HUB_LED_AMBER: s = "amber"; break;
425 case HUB_LED_GREEN: s = "green"; break;
426 case HUB_LED_OFF: s = "off"; break;
427 case HUB_LED_AUTO: s = "auto"; break;
428 default: s = "??"; break;
433 #define LED_CYCLE_PERIOD ((2*HZ)/3)
435 static void led_work (struct work_struct *work)
437 struct usb_hub *hub =
438 container_of(work, struct usb_hub, leds.work);
439 struct usb_device *hdev = hub->hdev;
441 unsigned changed = 0;
444 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
447 for (i = 0; i < hdev->maxchild; i++) {
448 unsigned selector, mode;
450 /* 30%-50% duty cycle */
452 switch (hub->indicator[i]) {
454 case INDICATOR_CYCLE:
456 selector = HUB_LED_AUTO;
457 mode = INDICATOR_AUTO;
459 /* blinking green = sw attention */
460 case INDICATOR_GREEN_BLINK:
461 selector = HUB_LED_GREEN;
462 mode = INDICATOR_GREEN_BLINK_OFF;
464 case INDICATOR_GREEN_BLINK_OFF:
465 selector = HUB_LED_OFF;
466 mode = INDICATOR_GREEN_BLINK;
468 /* blinking amber = hw attention */
469 case INDICATOR_AMBER_BLINK:
470 selector = HUB_LED_AMBER;
471 mode = INDICATOR_AMBER_BLINK_OFF;
473 case INDICATOR_AMBER_BLINK_OFF:
474 selector = HUB_LED_OFF;
475 mode = INDICATOR_AMBER_BLINK;
477 /* blink green/amber = reserved */
478 case INDICATOR_ALT_BLINK:
479 selector = HUB_LED_GREEN;
480 mode = INDICATOR_ALT_BLINK_OFF;
482 case INDICATOR_ALT_BLINK_OFF:
483 selector = HUB_LED_AMBER;
484 mode = INDICATOR_ALT_BLINK;
489 if (selector != HUB_LED_AUTO)
491 set_port_led(hub, i + 1, selector);
492 hub->indicator[i] = mode;
494 if (!changed && blinkenlights) {
496 cursor %= hdev->maxchild;
497 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
498 hub->indicator[cursor] = INDICATOR_CYCLE;
502 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
505 /* use a short timeout for hub/port status fetches */
506 #define USB_STS_TIMEOUT 1000
507 #define USB_STS_RETRIES 5
510 * USB 2.0 spec Section 11.24.2.6
512 static int get_hub_status(struct usb_device *hdev,
513 struct usb_hub_status *data)
515 int i, status = -ETIMEDOUT;
517 for (i = 0; i < USB_STS_RETRIES &&
518 (status == -ETIMEDOUT || status == -EPIPE); i++) {
519 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
520 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
521 data, sizeof(*data), USB_STS_TIMEOUT);
527 * USB 2.0 spec Section 11.24.2.7
529 static int get_port_status(struct usb_device *hdev, int port1,
530 struct usb_port_status *data)
532 int i, status = -ETIMEDOUT;
534 for (i = 0; i < USB_STS_RETRIES &&
535 (status == -ETIMEDOUT || status == -EPIPE); i++) {
536 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
537 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
538 data, sizeof(*data), USB_STS_TIMEOUT);
543 static int hub_port_status(struct usb_hub *hub, int port1,
544 u16 *status, u16 *change)
548 mutex_lock(&hub->status_mutex);
549 ret = get_port_status(hub->hdev, port1, &hub->status->port);
552 dev_err(hub->intfdev,
553 "%s failed (err = %d)\n", __func__, ret);
557 *status = le16_to_cpu(hub->status->port.wPortStatus);
558 *change = le16_to_cpu(hub->status->port.wPortChange);
562 mutex_unlock(&hub->status_mutex);
566 static void kick_khubd(struct usb_hub *hub)
570 spin_lock_irqsave(&hub_event_lock, flags);
571 if (!hub->disconnected && list_empty(&hub->event_list)) {
572 list_add_tail(&hub->event_list, &hub_event_list);
574 /* Suppress autosuspend until khubd runs */
575 usb_autopm_get_interface_no_resume(
576 to_usb_interface(hub->intfdev));
577 wake_up(&khubd_wait);
579 spin_unlock_irqrestore(&hub_event_lock, flags);
582 void usb_kick_khubd(struct usb_device *hdev)
584 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
591 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
592 * Notification, which indicates it had initiated remote wakeup.
594 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
595 * device initiates resume, so the USB core will not receive notice of the
596 * resume through the normal hub interrupt URB.
598 void usb_wakeup_notification(struct usb_device *hdev,
599 unsigned int portnum)
606 hub = usb_hub_to_struct_hub(hdev);
608 set_bit(portnum, hub->wakeup_bits);
612 EXPORT_SYMBOL_GPL(usb_wakeup_notification);
614 /* completion function, fires on port status changes and various faults */
615 static void hub_irq(struct urb *urb)
617 struct usb_hub *hub = urb->context;
618 int status = urb->status;
623 case -ENOENT: /* synchronous unlink */
624 case -ECONNRESET: /* async unlink */
625 case -ESHUTDOWN: /* hardware going away */
628 default: /* presumably an error */
629 /* Cause a hub reset after 10 consecutive errors */
630 dev_dbg (hub->intfdev, "transfer --> %d\n", status);
631 if ((++hub->nerrors < 10) || hub->error)
636 /* let khubd handle things */
637 case 0: /* we got data: port status changed */
639 for (i = 0; i < urb->actual_length; ++i)
640 bits |= ((unsigned long) ((*hub->buffer)[i]))
642 hub->event_bits[0] = bits;
648 /* Something happened, let khubd figure it out */
655 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
656 && status != -ENODEV && status != -EPERM)
657 dev_err (hub->intfdev, "resubmit --> %d\n", status);
660 /* USB 2.0 spec Section 11.24.2.3 */
662 hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
664 /* Need to clear both directions for control ep */
665 if (((devinfo >> 11) & USB_ENDPOINT_XFERTYPE_MASK) ==
666 USB_ENDPOINT_XFER_CONTROL) {
667 int status = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
668 HUB_CLEAR_TT_BUFFER, USB_RT_PORT,
669 devinfo ^ 0x8000, tt, NULL, 0, 1000);
673 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
674 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
679 * enumeration blocks khubd for a long time. we use keventd instead, since
680 * long blocking there is the exception, not the rule. accordingly, HCDs
681 * talking to TTs must queue control transfers (not just bulk and iso), so
682 * both can talk to the same hub concurrently.
684 static void hub_tt_work(struct work_struct *work)
686 struct usb_hub *hub =
687 container_of(work, struct usb_hub, tt.clear_work);
690 spin_lock_irqsave (&hub->tt.lock, flags);
691 while (!list_empty(&hub->tt.clear_list)) {
692 struct list_head *next;
693 struct usb_tt_clear *clear;
694 struct usb_device *hdev = hub->hdev;
695 const struct hc_driver *drv;
698 next = hub->tt.clear_list.next;
699 clear = list_entry (next, struct usb_tt_clear, clear_list);
700 list_del (&clear->clear_list);
702 /* drop lock so HCD can concurrently report other TT errors */
703 spin_unlock_irqrestore (&hub->tt.lock, flags);
704 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
705 if (status && status != -ENODEV)
707 "clear tt %d (%04x) error %d\n",
708 clear->tt, clear->devinfo, status);
710 /* Tell the HCD, even if the operation failed */
711 drv = clear->hcd->driver;
712 if (drv->clear_tt_buffer_complete)
713 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
716 spin_lock_irqsave(&hub->tt.lock, flags);
718 spin_unlock_irqrestore (&hub->tt.lock, flags);
722 * usb_hub_set_port_power - control hub port's power state
723 * @hdev: USB device belonging to the usb hub
726 * @set: expected status
728 * call this function to control port's power via setting or
729 * clearing the port's PORT_POWER feature.
731 * Return: 0 if successful. A negative error code otherwise.
733 int usb_hub_set_port_power(struct usb_device *hdev, struct usb_hub *hub,
737 struct usb_port *port_dev = hub->ports[port1 - 1];
740 ret = set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
742 ret = usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
745 port_dev->power_is_on = set;
750 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
751 * @urb: an URB associated with the failed or incomplete split transaction
753 * High speed HCDs use this to tell the hub driver that some split control or
754 * bulk transaction failed in a way that requires clearing internal state of
755 * a transaction translator. This is normally detected (and reported) from
758 * It may not be possible for that hub to handle additional full (or low)
759 * speed transactions until that state is fully cleared out.
761 * Return: 0 if successful. A negative error code otherwise.
763 int usb_hub_clear_tt_buffer(struct urb *urb)
765 struct usb_device *udev = urb->dev;
766 int pipe = urb->pipe;
767 struct usb_tt *tt = udev->tt;
769 struct usb_tt_clear *clear;
771 /* we've got to cope with an arbitrary number of pending TT clears,
772 * since each TT has "at least two" buffers that can need it (and
773 * there can be many TTs per hub). even if they're uncommon.
775 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
776 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
777 /* FIXME recover somehow ... RESET_TT? */
781 /* info that CLEAR_TT_BUFFER needs */
782 clear->tt = tt->multi ? udev->ttport : 1;
783 clear->devinfo = usb_pipeendpoint (pipe);
784 clear->devinfo |= udev->devnum << 4;
785 clear->devinfo |= usb_pipecontrol (pipe)
786 ? (USB_ENDPOINT_XFER_CONTROL << 11)
787 : (USB_ENDPOINT_XFER_BULK << 11);
788 if (usb_pipein (pipe))
789 clear->devinfo |= 1 << 15;
791 /* info for completion callback */
792 clear->hcd = bus_to_hcd(udev->bus);
795 /* tell keventd to clear state for this TT */
796 spin_lock_irqsave (&tt->lock, flags);
797 list_add_tail (&clear->clear_list, &tt->clear_list);
798 schedule_work(&tt->clear_work);
799 spin_unlock_irqrestore (&tt->lock, flags);
802 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
804 /* If do_delay is false, return the number of milliseconds the caller
807 static unsigned hub_power_on(struct usb_hub *hub, bool do_delay)
810 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
812 u16 wHubCharacteristics =
813 le16_to_cpu(hub->descriptor->wHubCharacteristics);
815 /* Enable power on each port. Some hubs have reserved values
816 * of LPSM (> 2) in their descriptors, even though they are
817 * USB 2.0 hubs. Some hubs do not implement port-power switching
818 * but only emulate it. In all cases, the ports won't work
819 * unless we send these messages to the hub.
821 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
822 dev_dbg(hub->intfdev, "enabling power on all ports\n");
824 dev_dbg(hub->intfdev, "trying to enable port power on "
825 "non-switchable hub\n");
826 for (port1 = 1; port1 <= hub->hdev->maxchild; port1++)
827 if (hub->ports[port1 - 1]->power_is_on)
828 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
830 usb_clear_port_feature(hub->hdev, port1,
831 USB_PORT_FEAT_POWER);
833 /* Wait at least 100 msec for power to become stable */
834 delay = max(pgood_delay, (unsigned) 100);
840 static int hub_hub_status(struct usb_hub *hub,
841 u16 *status, u16 *change)
845 mutex_lock(&hub->status_mutex);
846 ret = get_hub_status(hub->hdev, &hub->status->hub);
849 dev_err(hub->intfdev,
850 "%s failed (err = %d)\n", __func__, ret);
852 *status = le16_to_cpu(hub->status->hub.wHubStatus);
853 *change = le16_to_cpu(hub->status->hub.wHubChange);
856 mutex_unlock(&hub->status_mutex);
860 static int hub_set_port_link_state(struct usb_hub *hub, int port1,
861 unsigned int link_status)
863 return set_port_feature(hub->hdev,
864 port1 | (link_status << 3),
865 USB_PORT_FEAT_LINK_STATE);
869 * If USB 3.0 ports are placed into the Disabled state, they will no longer
870 * detect any device connects or disconnects. This is generally not what the
871 * USB core wants, since it expects a disabled port to produce a port status
872 * change event when a new device connects.
874 * Instead, set the link state to Disabled, wait for the link to settle into
875 * that state, clear any change bits, and then put the port into the RxDetect
878 static int hub_usb3_port_disable(struct usb_hub *hub, int port1)
882 u16 portchange, portstatus;
884 if (!hub_is_superspeed(hub->hdev))
887 ret = hub_port_status(hub, port1, &portstatus, &portchange);
892 * USB controller Advanced Micro Devices, Inc. [AMD] FCH USB XHCI
893 * Controller [1022:7814] will have spurious result making the following
894 * usb 3.0 device hotplugging route to the 2.0 root hub and recognized
895 * as high-speed device if we set the usb 3.0 port link state to
896 * Disabled. Since it's already in USB_SS_PORT_LS_RX_DETECT state, we
897 * check the state here to avoid the bug.
899 if ((portstatus & USB_PORT_STAT_LINK_STATE) ==
900 USB_SS_PORT_LS_RX_DETECT) {
901 dev_dbg(&hub->ports[port1 - 1]->dev,
902 "Not disabling port; link state is RxDetect\n");
906 ret = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_SS_DISABLED);
910 /* Wait for the link to enter the disabled state. */
911 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
912 ret = hub_port_status(hub, port1, &portstatus, &portchange);
916 if ((portstatus & USB_PORT_STAT_LINK_STATE) ==
917 USB_SS_PORT_LS_SS_DISABLED)
919 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
921 msleep(HUB_DEBOUNCE_STEP);
923 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
924 dev_warn(hub->intfdev, "Could not disable port %d after %d ms\n",
927 return hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_RX_DETECT);
930 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
932 struct usb_device *hdev = hub->hdev;
935 if (hub->ports[port1 - 1]->child && set_state)
936 usb_set_device_state(hub->ports[port1 - 1]->child,
937 USB_STATE_NOTATTACHED);
939 if (hub_is_superspeed(hub->hdev))
940 ret = hub_usb3_port_disable(hub, port1);
942 ret = usb_clear_port_feature(hdev, port1,
943 USB_PORT_FEAT_ENABLE);
945 if (ret && ret != -ENODEV)
946 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
952 * Disable a port and mark a logical connect-change event, so that some
953 * time later khubd will disconnect() any existing usb_device on the port
954 * and will re-enumerate if there actually is a device attached.
956 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
958 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
959 hub_port_disable(hub, port1, 1);
961 /* FIXME let caller ask to power down the port:
962 * - some devices won't enumerate without a VBUS power cycle
963 * - SRP saves power that way
964 * - ... new call, TBD ...
965 * That's easy if this hub can switch power per-port, and
966 * khubd reactivates the port later (timer, SRP, etc).
967 * Powerdown must be optional, because of reset/DFU.
970 set_bit(port1, hub->change_bits);
975 * usb_remove_device - disable a device's port on its parent hub
976 * @udev: device to be disabled and removed
977 * Context: @udev locked, must be able to sleep.
979 * After @udev's port has been disabled, khubd is notified and it will
980 * see that the device has been disconnected. When the device is
981 * physically unplugged and something is plugged in, the events will
982 * be received and processed normally.
984 * Return: 0 if successful. A negative error code otherwise.
986 int usb_remove_device(struct usb_device *udev)
989 struct usb_interface *intf;
991 if (!udev->parent) /* Can't remove a root hub */
993 hub = usb_hub_to_struct_hub(udev->parent);
994 intf = to_usb_interface(hub->intfdev);
996 usb_autopm_get_interface(intf);
997 set_bit(udev->portnum, hub->removed_bits);
998 hub_port_logical_disconnect(hub, udev->portnum);
999 usb_autopm_put_interface(intf);
1003 enum hub_activation_type {
1004 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
1005 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
1008 static void hub_init_func2(struct work_struct *ws);
1009 static void hub_init_func3(struct work_struct *ws);
1011 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
1013 struct usb_device *hdev = hub->hdev;
1014 struct usb_hcd *hcd;
1018 bool need_debounce_delay = false;
1021 /* Continue a partial initialization */
1022 if (type == HUB_INIT2)
1024 if (type == HUB_INIT3)
1027 /* The superspeed hub except for root hub has to use Hub Depth
1028 * value as an offset into the route string to locate the bits
1029 * it uses to determine the downstream port number. So hub driver
1030 * should send a set hub depth request to superspeed hub after
1031 * the superspeed hub is set configuration in initialization or
1034 * After a resume, port power should still be on.
1035 * For any other type of activation, turn it on.
1037 if (type != HUB_RESUME) {
1038 if (hdev->parent && hub_is_superspeed(hdev)) {
1039 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
1040 HUB_SET_DEPTH, USB_RT_HUB,
1041 hdev->level - 1, 0, NULL, 0,
1042 USB_CTRL_SET_TIMEOUT);
1044 dev_err(hub->intfdev,
1045 "set hub depth failed\n");
1048 /* Speed up system boot by using a delayed_work for the
1049 * hub's initial power-up delays. This is pretty awkward
1050 * and the implementation looks like a home-brewed sort of
1051 * setjmp/longjmp, but it saves at least 100 ms for each
1052 * root hub (assuming usbcore is compiled into the kernel
1053 * rather than as a module). It adds up.
1055 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1056 * because for those activation types the ports have to be
1057 * operational when we return. In theory this could be done
1058 * for HUB_POST_RESET, but it's easier not to.
1060 if (type == HUB_INIT) {
1061 delay = hub_power_on(hub, false);
1062 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func2);
1063 schedule_delayed_work(&hub->init_work,
1064 msecs_to_jiffies(delay));
1066 /* Suppress autosuspend until init is done */
1067 usb_autopm_get_interface_no_resume(
1068 to_usb_interface(hub->intfdev));
1069 return; /* Continues at init2: below */
1070 } else if (type == HUB_RESET_RESUME) {
1071 /* The internal host controller state for the hub device
1072 * may be gone after a host power loss on system resume.
1073 * Update the device's info so the HW knows it's a hub.
1075 hcd = bus_to_hcd(hdev->bus);
1076 if (hcd->driver->update_hub_device) {
1077 ret = hcd->driver->update_hub_device(hcd, hdev,
1078 &hub->tt, GFP_NOIO);
1080 dev_err(hub->intfdev, "Host not "
1081 "accepting hub info "
1083 dev_err(hub->intfdev, "LS/FS devices "
1084 "and hubs may not work "
1085 "under this hub\n.");
1088 hub_power_on(hub, true);
1090 hub_power_on(hub, true);
1095 /* Check each port and set hub->change_bits to let khubd know
1096 * which ports need attention.
1098 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
1099 struct usb_device *udev = hub->ports[port1 - 1]->child;
1100 u16 portstatus, portchange;
1102 portstatus = portchange = 0;
1103 status = hub_port_status(hub, port1, &portstatus, &portchange);
1104 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1105 dev_dbg(hub->intfdev,
1106 "port %d: status %04x change %04x\n",
1107 port1, portstatus, portchange);
1109 /* After anything other than HUB_RESUME (i.e., initialization
1110 * or any sort of reset), every port should be disabled.
1111 * Unconnected ports should likewise be disabled (paranoia),
1112 * and so should ports for which we have no usb_device.
1114 if ((portstatus & USB_PORT_STAT_ENABLE) && (
1115 type != HUB_RESUME ||
1116 !(portstatus & USB_PORT_STAT_CONNECTION) ||
1118 udev->state == USB_STATE_NOTATTACHED)) {
1120 * USB3 protocol ports will automatically transition
1121 * to Enabled state when detect an USB3.0 device attach.
1122 * Do not disable USB3 protocol ports, just pretend
1125 portstatus &= ~USB_PORT_STAT_ENABLE;
1126 if (!hub_is_superspeed(hdev))
1127 usb_clear_port_feature(hdev, port1,
1128 USB_PORT_FEAT_ENABLE);
1131 /* Clear status-change flags; we'll debounce later */
1132 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1133 need_debounce_delay = true;
1134 usb_clear_port_feature(hub->hdev, port1,
1135 USB_PORT_FEAT_C_CONNECTION);
1137 if (portchange & USB_PORT_STAT_C_ENABLE) {
1138 need_debounce_delay = true;
1139 usb_clear_port_feature(hub->hdev, port1,
1140 USB_PORT_FEAT_C_ENABLE);
1142 if (portchange & USB_PORT_STAT_C_RESET) {
1143 need_debounce_delay = true;
1144 usb_clear_port_feature(hub->hdev, port1,
1145 USB_PORT_FEAT_C_RESET);
1147 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
1148 hub_is_superspeed(hub->hdev)) {
1149 need_debounce_delay = true;
1150 usb_clear_port_feature(hub->hdev, port1,
1151 USB_PORT_FEAT_C_BH_PORT_RESET);
1153 /* We can forget about a "removed" device when there's a
1154 * physical disconnect or the connect status changes.
1156 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
1157 (portchange & USB_PORT_STAT_C_CONNECTION))
1158 clear_bit(port1, hub->removed_bits);
1160 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
1161 /* Tell khubd to disconnect the device or
1162 * check for a new connection
1164 if (udev || (portstatus & USB_PORT_STAT_CONNECTION) ||
1165 (portstatus & USB_PORT_STAT_OVERCURRENT))
1166 set_bit(port1, hub->change_bits);
1168 } else if (portstatus & USB_PORT_STAT_ENABLE) {
1169 bool port_resumed = (portstatus &
1170 USB_PORT_STAT_LINK_STATE) ==
1172 /* The power session apparently survived the resume.
1173 * If there was an overcurrent or suspend change
1174 * (i.e., remote wakeup request), have khubd
1175 * take care of it. Look at the port link state
1176 * for USB 3.0 hubs, since they don't have a suspend
1177 * change bit, and they don't set the port link change
1178 * bit on device-initiated resume.
1180 if (portchange || (hub_is_superspeed(hub->hdev) &&
1182 set_bit(port1, hub->change_bits);
1184 } else if (udev->persist_enabled) {
1185 struct usb_port *port_dev = hub->ports[port1 - 1];
1188 udev->reset_resume = 1;
1190 /* Don't set the change_bits when the device
1193 if (port_dev->power_is_on)
1194 set_bit(port1, hub->change_bits);
1197 /* The power session is gone; tell khubd */
1198 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1199 set_bit(port1, hub->change_bits);
1203 /* If no port-status-change flags were set, we don't need any
1204 * debouncing. If flags were set we can try to debounce the
1205 * ports all at once right now, instead of letting khubd do them
1206 * one at a time later on.
1208 * If any port-status changes do occur during this delay, khubd
1209 * will see them later and handle them normally.
1211 if (need_debounce_delay) {
1212 delay = HUB_DEBOUNCE_STABLE;
1214 /* Don't do a long sleep inside a workqueue routine */
1215 if (type == HUB_INIT2) {
1216 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func3);
1217 schedule_delayed_work(&hub->init_work,
1218 msecs_to_jiffies(delay));
1219 return; /* Continues at init3: below */
1227 status = usb_submit_urb(hub->urb, GFP_NOIO);
1229 dev_err(hub->intfdev, "activate --> %d\n", status);
1230 if (hub->has_indicators && blinkenlights)
1231 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
1233 /* Scan all ports that need attention */
1236 /* Allow autosuspend if it was suppressed */
1237 if (type <= HUB_INIT3)
1238 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
1241 /* Implement the continuations for the delays above */
1242 static void hub_init_func2(struct work_struct *ws)
1244 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1246 hub_activate(hub, HUB_INIT2);
1249 static void hub_init_func3(struct work_struct *ws)
1251 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1253 hub_activate(hub, HUB_INIT3);
1256 enum hub_quiescing_type {
1257 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
1260 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
1262 struct usb_device *hdev = hub->hdev;
1265 cancel_delayed_work_sync(&hub->init_work);
1267 /* khubd and related activity won't re-trigger */
1270 if (type != HUB_SUSPEND) {
1271 /* Disconnect all the children */
1272 for (i = 0; i < hdev->maxchild; ++i) {
1273 if (hub->ports[i]->child)
1274 usb_disconnect(&hub->ports[i]->child);
1278 /* Stop khubd and related activity */
1279 usb_kill_urb(hub->urb);
1280 if (hub->has_indicators)
1281 cancel_delayed_work_sync(&hub->leds);
1283 flush_work(&hub->tt.clear_work);
1286 /* caller has locked the hub device */
1287 static int hub_pre_reset(struct usb_interface *intf)
1289 struct usb_hub *hub = usb_get_intfdata(intf);
1291 hub_quiesce(hub, HUB_PRE_RESET);
1295 /* caller has locked the hub device */
1296 static int hub_post_reset(struct usb_interface *intf)
1298 struct usb_hub *hub = usb_get_intfdata(intf);
1300 hub_activate(hub, HUB_POST_RESET);
1304 static int hub_configure(struct usb_hub *hub,
1305 struct usb_endpoint_descriptor *endpoint)
1307 struct usb_hcd *hcd;
1308 struct usb_device *hdev = hub->hdev;
1309 struct device *hub_dev = hub->intfdev;
1310 u16 hubstatus, hubchange;
1311 u16 wHubCharacteristics;
1314 char *message = "out of memory";
1318 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
1324 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1329 mutex_init(&hub->status_mutex);
1331 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1332 if (!hub->descriptor) {
1337 /* Request the entire hub descriptor.
1338 * hub->descriptor can handle USB_MAXCHILDREN ports,
1339 * but the hub can/will return fewer bytes here.
1341 ret = get_hub_descriptor(hdev, hub->descriptor);
1343 message = "can't read hub descriptor";
1345 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
1346 message = "hub has too many ports!";
1349 } else if (hub->descriptor->bNbrPorts == 0) {
1350 message = "hub doesn't have any ports!";
1355 hdev->maxchild = hub->descriptor->bNbrPorts;
1356 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
1357 (hdev->maxchild == 1) ? "" : "s");
1359 hub->ports = kzalloc(hdev->maxchild * sizeof(struct usb_port *),
1366 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1367 if (hub_is_superspeed(hdev)) {
1375 /* FIXME for USB 3.0, skip for now */
1376 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1377 !(hub_is_superspeed(hdev))) {
1379 char portstr[USB_MAXCHILDREN + 1];
1381 for (i = 0; i < hdev->maxchild; i++)
1382 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1383 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1385 portstr[hdev->maxchild] = 0;
1386 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1388 dev_dbg(hub_dev, "standalone hub\n");
1390 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1391 case HUB_CHAR_COMMON_LPSM:
1392 dev_dbg(hub_dev, "ganged power switching\n");
1394 case HUB_CHAR_INDV_PORT_LPSM:
1395 dev_dbg(hub_dev, "individual port power switching\n");
1397 case HUB_CHAR_NO_LPSM:
1399 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1403 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1404 case HUB_CHAR_COMMON_OCPM:
1405 dev_dbg(hub_dev, "global over-current protection\n");
1407 case HUB_CHAR_INDV_PORT_OCPM:
1408 dev_dbg(hub_dev, "individual port over-current protection\n");
1410 case HUB_CHAR_NO_OCPM:
1412 dev_dbg(hub_dev, "no over-current protection\n");
1416 spin_lock_init (&hub->tt.lock);
1417 INIT_LIST_HEAD (&hub->tt.clear_list);
1418 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1419 switch (hdev->descriptor.bDeviceProtocol) {
1422 case USB_HUB_PR_HS_SINGLE_TT:
1423 dev_dbg(hub_dev, "Single TT\n");
1426 case USB_HUB_PR_HS_MULTI_TT:
1427 ret = usb_set_interface(hdev, 0, 1);
1429 dev_dbg(hub_dev, "TT per port\n");
1432 dev_err(hub_dev, "Using single TT (err %d)\n",
1437 /* USB 3.0 hubs don't have a TT */
1440 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1441 hdev->descriptor.bDeviceProtocol);
1445 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1446 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1447 case HUB_TTTT_8_BITS:
1448 if (hdev->descriptor.bDeviceProtocol != 0) {
1449 hub->tt.think_time = 666;
1450 dev_dbg(hub_dev, "TT requires at most %d "
1451 "FS bit times (%d ns)\n",
1452 8, hub->tt.think_time);
1455 case HUB_TTTT_16_BITS:
1456 hub->tt.think_time = 666 * 2;
1457 dev_dbg(hub_dev, "TT requires at most %d "
1458 "FS bit times (%d ns)\n",
1459 16, hub->tt.think_time);
1461 case HUB_TTTT_24_BITS:
1462 hub->tt.think_time = 666 * 3;
1463 dev_dbg(hub_dev, "TT requires at most %d "
1464 "FS bit times (%d ns)\n",
1465 24, hub->tt.think_time);
1467 case HUB_TTTT_32_BITS:
1468 hub->tt.think_time = 666 * 4;
1469 dev_dbg(hub_dev, "TT requires at most %d "
1470 "FS bit times (%d ns)\n",
1471 32, hub->tt.think_time);
1475 /* probe() zeroes hub->indicator[] */
1476 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1477 hub->has_indicators = 1;
1478 dev_dbg(hub_dev, "Port indicators are supported\n");
1481 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1482 hub->descriptor->bPwrOn2PwrGood * 2);
1484 /* power budgeting mostly matters with bus-powered hubs,
1485 * and battery-powered root hubs (may provide just 8 mA).
1487 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1489 message = "can't get hub status";
1492 hcd = bus_to_hcd(hdev->bus);
1493 if (hdev == hdev->bus->root_hub) {
1494 if (hcd->power_budget > 0)
1495 hdev->bus_mA = hcd->power_budget;
1497 hdev->bus_mA = full_load * hdev->maxchild;
1498 if (hdev->bus_mA >= full_load)
1499 hub->mA_per_port = full_load;
1501 hub->mA_per_port = hdev->bus_mA;
1502 hub->limited_power = 1;
1504 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1505 int remaining = hdev->bus_mA -
1506 hub->descriptor->bHubContrCurrent;
1508 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1509 hub->descriptor->bHubContrCurrent);
1510 hub->limited_power = 1;
1512 if (remaining < hdev->maxchild * unit_load)
1514 "insufficient power available "
1515 "to use all downstream ports\n");
1516 hub->mA_per_port = unit_load; /* 7.2.1 */
1518 } else { /* Self-powered external hub */
1519 /* FIXME: What about battery-powered external hubs that
1520 * provide less current per port? */
1521 hub->mA_per_port = full_load;
1523 if (hub->mA_per_port < full_load)
1524 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1527 /* Update the HCD's internal representation of this hub before khubd
1528 * starts getting port status changes for devices under the hub.
1530 if (hcd->driver->update_hub_device) {
1531 ret = hcd->driver->update_hub_device(hcd, hdev,
1532 &hub->tt, GFP_KERNEL);
1534 message = "can't update HCD hub info";
1539 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1541 message = "can't get hub status";
1545 /* local power status reports aren't always correct */
1546 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1547 dev_dbg(hub_dev, "local power source is %s\n",
1548 (hubstatus & HUB_STATUS_LOCAL_POWER)
1549 ? "lost (inactive)" : "good");
1551 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1552 dev_dbg(hub_dev, "%sover-current condition exists\n",
1553 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1555 /* set up the interrupt endpoint
1556 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1557 * bytes as USB2.0[11.12.3] says because some hubs are known
1558 * to send more data (and thus cause overflow). For root hubs,
1559 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1560 * to be big enough for at least USB_MAXCHILDREN ports. */
1561 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1562 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1564 if (maxp > sizeof(*hub->buffer))
1565 maxp = sizeof(*hub->buffer);
1567 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1573 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1574 hub, endpoint->bInterval);
1576 /* maybe cycle the hub leds */
1577 if (hub->has_indicators && blinkenlights)
1578 hub->indicator[0] = INDICATOR_CYCLE;
1580 for (i = 0; i < hdev->maxchild; i++) {
1581 ret = usb_hub_create_port_device(hub, i + 1);
1583 dev_err(hub->intfdev,
1584 "couldn't create port%d device.\n", i + 1);
1586 goto fail_keep_maxchild;
1590 usb_hub_adjust_deviceremovable(hdev, hub->descriptor);
1592 hub_activate(hub, HUB_INIT);
1598 dev_err (hub_dev, "config failed, %s (err %d)\n",
1600 /* hub_disconnect() frees urb and descriptor */
1604 static void hub_release(struct kref *kref)
1606 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1608 usb_put_intf(to_usb_interface(hub->intfdev));
1612 static unsigned highspeed_hubs;
1614 static void hub_disconnect(struct usb_interface *intf)
1616 struct usb_hub *hub = usb_get_intfdata(intf);
1617 struct usb_device *hdev = interface_to_usbdev(intf);
1620 /* Take the hub off the event list and don't let it be added again */
1621 spin_lock_irq(&hub_event_lock);
1622 if (!list_empty(&hub->event_list)) {
1623 list_del_init(&hub->event_list);
1624 usb_autopm_put_interface_no_suspend(intf);
1626 hub->disconnected = 1;
1627 spin_unlock_irq(&hub_event_lock);
1629 /* Disconnect all children and quiesce the hub */
1631 hub_quiesce(hub, HUB_DISCONNECT);
1633 /* Avoid races with recursively_mark_NOTATTACHED() */
1634 spin_lock_irq(&device_state_lock);
1635 port1 = hdev->maxchild;
1637 usb_set_intfdata(intf, NULL);
1638 spin_unlock_irq(&device_state_lock);
1640 for (; port1 > 0; --port1)
1641 usb_hub_remove_port_device(hub, port1);
1643 if (hub->hdev->speed == USB_SPEED_HIGH)
1646 usb_free_urb(hub->urb);
1648 kfree(hub->descriptor);
1652 pm_suspend_ignore_children(&intf->dev, false);
1653 kref_put(&hub->kref, hub_release);
1656 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1658 struct usb_host_interface *desc;
1659 struct usb_endpoint_descriptor *endpoint;
1660 struct usb_device *hdev;
1661 struct usb_hub *hub;
1663 desc = intf->cur_altsetting;
1664 hdev = interface_to_usbdev(intf);
1667 * Set default autosuspend delay as 0 to speedup bus suspend,
1668 * based on the below considerations:
1670 * - Unlike other drivers, the hub driver does not rely on the
1671 * autosuspend delay to provide enough time to handle a wakeup
1672 * event, and the submitted status URB is just to check future
1673 * change on hub downstream ports, so it is safe to do it.
1675 * - The patch might cause one or more auto supend/resume for
1676 * below very rare devices when they are plugged into hub
1679 * devices having trouble initializing, and disconnect
1680 * themselves from the bus and then reconnect a second
1683 * devices just for downloading firmware, and disconnects
1684 * themselves after completing it
1686 * For these quite rare devices, their drivers may change the
1687 * autosuspend delay of their parent hub in the probe() to one
1688 * appropriate value to avoid the subtle problem if someone
1691 * - The patch may cause one or more auto suspend/resume on
1692 * hub during running 'lsusb', but it is probably too
1693 * infrequent to worry about.
1695 * - Change autosuspend delay of hub can avoid unnecessary auto
1696 * suspend timer for hub, also may decrease power consumption
1699 pm_runtime_set_autosuspend_delay(&hdev->dev, 0);
1702 * Hubs have proper suspend/resume support, except for root hubs
1703 * where the controller driver doesn't have bus_suspend and
1704 * bus_resume methods.
1706 if (hdev->parent) { /* normal device */
1707 usb_enable_autosuspend(hdev);
1708 } else { /* root hub */
1709 const struct hc_driver *drv = bus_to_hcd(hdev->bus)->driver;
1711 if (drv->bus_suspend && drv->bus_resume)
1712 usb_enable_autosuspend(hdev);
1715 if (hdev->level == MAX_TOPO_LEVEL) {
1717 "Unsupported bus topology: hub nested too deep\n");
1721 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1723 dev_warn(&intf->dev, "ignoring external hub\n");
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)) {
1733 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1737 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1738 if (desc->desc.bNumEndpoints != 1)
1739 goto descriptor_error;
1741 endpoint = &desc->endpoint[0].desc;
1743 /* If it's not an interrupt in endpoint, we'd better punt! */
1744 if (!usb_endpoint_is_int_in(endpoint))
1745 goto descriptor_error;
1747 /* We found a hub */
1748 dev_info (&intf->dev, "USB hub found\n");
1750 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1752 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1756 kref_init(&hub->kref);
1757 INIT_LIST_HEAD(&hub->event_list);
1758 hub->intfdev = &intf->dev;
1760 INIT_DELAYED_WORK(&hub->leds, led_work);
1761 INIT_DELAYED_WORK(&hub->init_work, NULL);
1764 usb_set_intfdata (intf, hub);
1765 intf->needs_remote_wakeup = 1;
1766 pm_suspend_ignore_children(&intf->dev, true);
1768 if (hdev->speed == USB_SPEED_HIGH)
1771 if (id->driver_info & HUB_QUIRK_CHECK_PORT_AUTOSUSPEND)
1772 hub->quirk_check_port_auto_suspend = 1;
1774 if (hub_configure(hub, endpoint) >= 0)
1777 hub_disconnect (intf);
1782 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1784 struct usb_device *hdev = interface_to_usbdev (intf);
1785 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1787 /* assert ifno == 0 (part of hub spec) */
1789 case USBDEVFS_HUB_PORTINFO: {
1790 struct usbdevfs_hub_portinfo *info = user_data;
1793 spin_lock_irq(&device_state_lock);
1794 if (hdev->devnum <= 0)
1797 info->nports = hdev->maxchild;
1798 for (i = 0; i < info->nports; i++) {
1799 if (hub->ports[i]->child == NULL)
1803 hub->ports[i]->child->devnum;
1806 spin_unlock_irq(&device_state_lock);
1808 return info->nports + 1;
1817 * Allow user programs to claim ports on a hub. When a device is attached
1818 * to one of these "claimed" ports, the program will "own" the device.
1820 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1821 struct dev_state ***ppowner)
1823 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1825 if (hdev->state == USB_STATE_NOTATTACHED)
1827 if (port1 == 0 || port1 > hdev->maxchild)
1830 /* Devices not managed by the hub driver
1831 * will always have maxchild equal to 0.
1833 *ppowner = &(hub->ports[port1 - 1]->port_owner);
1837 /* In the following three functions, the caller must hold hdev's lock */
1838 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
1839 struct dev_state *owner)
1842 struct dev_state **powner;
1844 rc = find_port_owner(hdev, port1, &powner);
1853 int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
1854 struct dev_state *owner)
1857 struct dev_state **powner;
1859 rc = find_port_owner(hdev, port1, &powner);
1862 if (*powner != owner)
1868 void usb_hub_release_all_ports(struct usb_device *hdev, struct dev_state *owner)
1870 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1873 for (n = 0; n < hdev->maxchild; n++) {
1874 if (hub->ports[n]->port_owner == owner)
1875 hub->ports[n]->port_owner = NULL;
1880 /* The caller must hold udev's lock */
1881 bool usb_device_is_owned(struct usb_device *udev)
1883 struct usb_hub *hub;
1885 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1887 hub = usb_hub_to_struct_hub(udev->parent);
1888 return !!hub->ports[udev->portnum - 1]->port_owner;
1891 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1893 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
1896 for (i = 0; i < udev->maxchild; ++i) {
1897 if (hub->ports[i]->child)
1898 recursively_mark_NOTATTACHED(hub->ports[i]->child);
1900 if (udev->state == USB_STATE_SUSPENDED)
1901 udev->active_duration -= jiffies;
1902 udev->state = USB_STATE_NOTATTACHED;
1906 * usb_set_device_state - change a device's current state (usbcore, hcds)
1907 * @udev: pointer to device whose state should be changed
1908 * @new_state: new state value to be stored
1910 * udev->state is _not_ fully protected by the device lock. Although
1911 * most transitions are made only while holding the lock, the state can
1912 * can change to USB_STATE_NOTATTACHED at almost any time. This
1913 * is so that devices can be marked as disconnected as soon as possible,
1914 * without having to wait for any semaphores to be released. As a result,
1915 * all changes to any device's state must be protected by the
1916 * device_state_lock spinlock.
1918 * Once a device has been added to the device tree, all changes to its state
1919 * should be made using this routine. The state should _not_ be set directly.
1921 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1922 * Otherwise udev->state is set to new_state, and if new_state is
1923 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1924 * to USB_STATE_NOTATTACHED.
1926 void usb_set_device_state(struct usb_device *udev,
1927 enum usb_device_state new_state)
1929 unsigned long flags;
1932 spin_lock_irqsave(&device_state_lock, flags);
1933 if (udev->state == USB_STATE_NOTATTACHED)
1935 else if (new_state != USB_STATE_NOTATTACHED) {
1937 /* root hub wakeup capabilities are managed out-of-band
1938 * and may involve silicon errata ... ignore them here.
1941 if (udev->state == USB_STATE_SUSPENDED
1942 || new_state == USB_STATE_SUSPENDED)
1943 ; /* No change to wakeup settings */
1944 else if (new_state == USB_STATE_CONFIGURED)
1945 wakeup = udev->actconfig->desc.bmAttributes
1946 & USB_CONFIG_ATT_WAKEUP;
1950 if (udev->state == USB_STATE_SUSPENDED &&
1951 new_state != USB_STATE_SUSPENDED)
1952 udev->active_duration -= jiffies;
1953 else if (new_state == USB_STATE_SUSPENDED &&
1954 udev->state != USB_STATE_SUSPENDED)
1955 udev->active_duration += jiffies;
1956 udev->state = new_state;
1958 recursively_mark_NOTATTACHED(udev);
1959 spin_unlock_irqrestore(&device_state_lock, flags);
1961 device_set_wakeup_capable(&udev->dev, wakeup);
1963 EXPORT_SYMBOL_GPL(usb_set_device_state);
1966 * Choose a device number.
1968 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1969 * USB-2.0 buses they are also used as device addresses, however on
1970 * USB-3.0 buses the address is assigned by the controller hardware
1971 * and it usually is not the same as the device number.
1973 * WUSB devices are simple: they have no hubs behind, so the mapping
1974 * device <-> virtual port number becomes 1:1. Why? to simplify the
1975 * life of the device connection logic in
1976 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1977 * handshake we need to assign a temporary address in the unauthorized
1978 * space. For simplicity we use the first virtual port number found to
1979 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1980 * and that becomes it's address [X < 128] or its unauthorized address
1983 * We add 1 as an offset to the one-based USB-stack port number
1984 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1985 * 0 is reserved by USB for default address; (b) Linux's USB stack
1986 * uses always #1 for the root hub of the controller. So USB stack's
1987 * port #1, which is wusb virtual-port #0 has address #2.
1989 * Devices connected under xHCI are not as simple. The host controller
1990 * supports virtualization, so the hardware assigns device addresses and
1991 * the HCD must setup data structures before issuing a set address
1992 * command to the hardware.
1994 static void choose_devnum(struct usb_device *udev)
1997 struct usb_bus *bus = udev->bus;
1999 /* If khubd ever becomes multithreaded, this will need a lock */
2001 devnum = udev->portnum + 1;
2002 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
2004 /* Try to allocate the next devnum beginning at
2005 * bus->devnum_next. */
2006 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
2009 devnum = find_next_zero_bit(bus->devmap.devicemap,
2011 bus->devnum_next = (devnum >= 127 ? 1 : devnum + 1);
2014 set_bit(devnum, bus->devmap.devicemap);
2015 udev->devnum = devnum;
2019 static void release_devnum(struct usb_device *udev)
2021 if (udev->devnum > 0) {
2022 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
2027 static void update_devnum(struct usb_device *udev, int devnum)
2029 /* The address for a WUSB device is managed by wusbcore. */
2031 udev->devnum = devnum;
2034 static void hub_free_dev(struct usb_device *udev)
2036 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2038 /* Root hubs aren't real devices, so don't free HCD resources */
2039 if (hcd->driver->free_dev && udev->parent)
2040 hcd->driver->free_dev(hcd, udev);
2044 * usb_disconnect - disconnect a device (usbcore-internal)
2045 * @pdev: pointer to device being disconnected
2046 * Context: !in_interrupt ()
2048 * Something got disconnected. Get rid of it and all of its children.
2050 * If *pdev is a normal device then the parent hub must already be locked.
2051 * If *pdev is a root hub then the caller must hold the usb_bus_list_lock,
2052 * which protects the set of root hubs as well as the list of buses.
2054 * Only hub drivers (including virtual root hub drivers for host
2055 * controllers) should ever call this.
2057 * This call is synchronous, and may not be used in an interrupt context.
2059 void usb_disconnect(struct usb_device **pdev)
2061 struct usb_device *udev = *pdev;
2062 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2065 /* mark the device as inactive, so any further urb submissions for
2066 * this device (and any of its children) will fail immediately.
2067 * this quiesces everything except pending urbs.
2069 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2070 dev_info(&udev->dev, "USB disconnect, device number %d\n",
2073 usb_lock_device(udev);
2075 /* Free up all the children before we remove this device */
2076 for (i = 0; i < udev->maxchild; i++) {
2077 if (hub->ports[i]->child)
2078 usb_disconnect(&hub->ports[i]->child);
2081 /* deallocate hcd/hardware state ... nuking all pending urbs and
2082 * cleaning up all state associated with the current configuration
2083 * so that the hardware is now fully quiesced.
2085 dev_dbg (&udev->dev, "unregistering device\n");
2086 usb_disable_device(udev, 0);
2087 usb_hcd_synchronize_unlinks(udev);
2090 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2091 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
2093 sysfs_remove_link(&udev->dev.kobj, "port");
2094 sysfs_remove_link(&port_dev->dev.kobj, "device");
2096 if (!port_dev->did_runtime_put)
2097 pm_runtime_put(&port_dev->dev);
2099 port_dev->did_runtime_put = false;
2102 usb_remove_ep_devs(&udev->ep0);
2103 usb_unlock_device(udev);
2105 /* Unregister the device. The device driver is responsible
2106 * for de-configuring the device and invoking the remove-device
2107 * notifier chain (used by usbfs and possibly others).
2109 device_del(&udev->dev);
2111 /* Free the device number and delete the parent's children[]
2112 * (or root_hub) pointer.
2114 release_devnum(udev);
2116 /* Avoid races with recursively_mark_NOTATTACHED() */
2117 spin_lock_irq(&device_state_lock);
2119 spin_unlock_irq(&device_state_lock);
2123 put_device(&udev->dev);
2126 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2127 static void show_string(struct usb_device *udev, char *id, char *string)
2131 dev_info(&udev->dev, "%s: %s\n", id, string);
2134 static void announce_device(struct usb_device *udev)
2136 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2137 le16_to_cpu(udev->descriptor.idVendor),
2138 le16_to_cpu(udev->descriptor.idProduct));
2139 dev_info(&udev->dev,
2140 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2141 udev->descriptor.iManufacturer,
2142 udev->descriptor.iProduct,
2143 udev->descriptor.iSerialNumber);
2144 show_string(udev, "Product", udev->product);
2145 show_string(udev, "Manufacturer", udev->manufacturer);
2146 show_string(udev, "SerialNumber", udev->serial);
2149 static inline void announce_device(struct usb_device *udev) { }
2152 #ifdef CONFIG_USB_OTG
2153 #include "otg_whitelist.h"
2157 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2158 * @udev: newly addressed device (in ADDRESS state)
2160 * Finish enumeration for On-The-Go devices
2162 * Return: 0 if successful. A negative error code otherwise.
2164 static int usb_enumerate_device_otg(struct usb_device *udev)
2168 #ifdef CONFIG_USB_OTG
2170 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2171 * to wake us after we've powered off VBUS; and HNP, switching roles
2172 * "host" to "peripheral". The OTG descriptor helps figure this out.
2174 if (!udev->bus->is_b_host
2176 && udev->parent == udev->bus->root_hub) {
2177 struct usb_otg_descriptor *desc = NULL;
2178 struct usb_bus *bus = udev->bus;
2180 /* descriptor may appear anywhere in config */
2181 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
2182 le16_to_cpu(udev->config[0].desc.wTotalLength),
2183 USB_DT_OTG, (void **) &desc) == 0) {
2184 if (desc->bmAttributes & USB_OTG_HNP) {
2185 unsigned port1 = udev->portnum;
2187 dev_info(&udev->dev,
2188 "Dual-Role OTG device on %sHNP port\n",
2189 (port1 == bus->otg_port)
2192 /* enable HNP before suspend, it's simpler */
2193 if (port1 == bus->otg_port)
2194 bus->b_hnp_enable = 1;
2195 err = usb_control_msg(udev,
2196 usb_sndctrlpipe(udev, 0),
2197 USB_REQ_SET_FEATURE, 0,
2199 ? USB_DEVICE_B_HNP_ENABLE
2200 : USB_DEVICE_A_ALT_HNP_SUPPORT,
2201 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
2203 /* OTG MESSAGE: report errors here,
2204 * customize to match your product.
2206 dev_info(&udev->dev,
2207 "can't set HNP mode: %d\n",
2209 bus->b_hnp_enable = 0;
2215 if (!is_targeted(udev)) {
2217 /* Maybe it can talk to us, though we can't talk to it.
2218 * (Includes HNP test device.)
2220 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
2221 err = usb_port_suspend(udev, PMSG_SUSPEND);
2223 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
2235 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2236 * @udev: newly addressed device (in ADDRESS state)
2238 * This is only called by usb_new_device() and usb_authorize_device()
2239 * and FIXME -- all comments that apply to them apply here wrt to
2242 * If the device is WUSB and not authorized, we don't attempt to read
2243 * the string descriptors, as they will be errored out by the device
2244 * until it has been authorized.
2246 * Return: 0 if successful. A negative error code otherwise.
2248 static int usb_enumerate_device(struct usb_device *udev)
2252 if (udev->config == NULL) {
2253 err = usb_get_configuration(udev);
2256 dev_err(&udev->dev, "can't read configurations, error %d\n",
2262 /* read the standard strings and cache them if present */
2263 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
2264 udev->manufacturer = usb_cache_string(udev,
2265 udev->descriptor.iManufacturer);
2266 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
2268 err = usb_enumerate_device_otg(udev);
2272 usb_detect_interface_quirks(udev);
2277 static void set_usb_port_removable(struct usb_device *udev)
2279 struct usb_device *hdev = udev->parent;
2280 struct usb_hub *hub;
2281 u8 port = udev->portnum;
2282 u16 wHubCharacteristics;
2283 bool removable = true;
2288 hub = usb_hub_to_struct_hub(udev->parent);
2290 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2292 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
2295 if (hub_is_superspeed(hdev)) {
2296 if (le16_to_cpu(hub->descriptor->u.ss.DeviceRemovable)
2300 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
2305 udev->removable = USB_DEVICE_REMOVABLE;
2307 udev->removable = USB_DEVICE_FIXED;
2311 * usb_new_device - perform initial device setup (usbcore-internal)
2312 * @udev: newly addressed device (in ADDRESS state)
2314 * This is called with devices which have been detected but not fully
2315 * enumerated. The device descriptor is available, but not descriptors
2316 * for any device configuration. The caller must have locked either
2317 * the parent hub (if udev is a normal device) or else the
2318 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
2319 * udev has already been installed, but udev is not yet visible through
2320 * sysfs or other filesystem code.
2322 * This call is synchronous, and may not be used in an interrupt context.
2324 * Only the hub driver or root-hub registrar should ever call this.
2326 * Return: Whether the device is configured properly or not. Zero if the
2327 * interface was registered with the driver core; else a negative errno
2331 int usb_new_device(struct usb_device *udev)
2336 /* Initialize non-root-hub device wakeup to disabled;
2337 * device (un)configuration controls wakeup capable
2338 * sysfs power/wakeup controls wakeup enabled/disabled
2340 device_init_wakeup(&udev->dev, 0);
2343 /* Tell the runtime-PM framework the device is active */
2344 pm_runtime_set_active(&udev->dev);
2345 pm_runtime_get_noresume(&udev->dev);
2346 pm_runtime_use_autosuspend(&udev->dev);
2347 pm_runtime_enable(&udev->dev);
2349 /* By default, forbid autosuspend for all devices. It will be
2350 * allowed for hubs during binding.
2352 usb_disable_autosuspend(udev);
2354 err = usb_enumerate_device(udev); /* Read descriptors */
2357 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
2358 udev->devnum, udev->bus->busnum,
2359 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2360 /* export the usbdev device-node for libusb */
2361 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
2362 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2364 /* Tell the world! */
2365 announce_device(udev);
2368 add_device_randomness(udev->serial, strlen(udev->serial));
2370 add_device_randomness(udev->product, strlen(udev->product));
2371 if (udev->manufacturer)
2372 add_device_randomness(udev->manufacturer,
2373 strlen(udev->manufacturer));
2375 device_enable_async_suspend(&udev->dev);
2378 * check whether the hub marks this port as non-removable. Do it
2379 * now so that platform-specific data can override it in
2383 set_usb_port_removable(udev);
2385 /* Register the device. The device driver is responsible
2386 * for configuring the device and invoking the add-device
2387 * notifier chain (used by usbfs and possibly others).
2389 err = device_add(&udev->dev);
2391 dev_err(&udev->dev, "can't device_add, error %d\n", err);
2395 /* Create link files between child device and usb port device. */
2397 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2398 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
2400 err = sysfs_create_link(&udev->dev.kobj,
2401 &port_dev->dev.kobj, "port");
2405 err = sysfs_create_link(&port_dev->dev.kobj,
2406 &udev->dev.kobj, "device");
2408 sysfs_remove_link(&udev->dev.kobj, "port");
2412 pm_runtime_get_sync(&port_dev->dev);
2415 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
2416 usb_mark_last_busy(udev);
2417 pm_runtime_put_sync_autosuspend(&udev->dev);
2421 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2422 pm_runtime_disable(&udev->dev);
2423 pm_runtime_set_suspended(&udev->dev);
2429 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2430 * @usb_dev: USB device
2432 * Move the USB device to a very basic state where interfaces are disabled
2433 * and the device is in fact unconfigured and unusable.
2435 * We share a lock (that we have) with device_del(), so we need to
2440 int usb_deauthorize_device(struct usb_device *usb_dev)
2442 usb_lock_device(usb_dev);
2443 if (usb_dev->authorized == 0)
2444 goto out_unauthorized;
2446 usb_dev->authorized = 0;
2447 usb_set_configuration(usb_dev, -1);
2450 usb_unlock_device(usb_dev);
2455 int usb_authorize_device(struct usb_device *usb_dev)
2459 usb_lock_device(usb_dev);
2460 if (usb_dev->authorized == 1)
2461 goto out_authorized;
2463 result = usb_autoresume_device(usb_dev);
2465 dev_err(&usb_dev->dev,
2466 "can't autoresume for authorization: %d\n", result);
2467 goto error_autoresume;
2469 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2471 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2472 "authorization: %d\n", result);
2473 goto error_device_descriptor;
2476 usb_dev->authorized = 1;
2477 /* Choose and set the configuration. This registers the interfaces
2478 * with the driver core and lets interface drivers bind to them.
2480 c = usb_choose_configuration(usb_dev);
2482 result = usb_set_configuration(usb_dev, c);
2484 dev_err(&usb_dev->dev,
2485 "can't set config #%d, error %d\n", c, result);
2486 /* This need not be fatal. The user can try to
2487 * set other configurations. */
2490 dev_info(&usb_dev->dev, "authorized to connect\n");
2492 error_device_descriptor:
2493 usb_autosuspend_device(usb_dev);
2496 usb_unlock_device(usb_dev); /* complements locktree */
2501 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2502 static unsigned hub_is_wusb(struct usb_hub *hub)
2504 struct usb_hcd *hcd;
2505 if (hub->hdev->parent != NULL) /* not a root hub? */
2507 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
2508 return hcd->wireless;
2512 #define PORT_RESET_TRIES 5
2513 #define SET_ADDRESS_TRIES 2
2514 #define GET_DESCRIPTOR_TRIES 2
2515 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2516 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2518 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2519 #define HUB_SHORT_RESET_TIME 10
2520 #define HUB_BH_RESET_TIME 50
2521 #define HUB_LONG_RESET_TIME 200
2522 #define HUB_RESET_TIMEOUT 800
2525 * "New scheme" enumeration causes an extra state transition to be
2526 * exposed to an xhci host and causes USB3 devices to receive control
2527 * commands in the default state. This has been seen to cause
2528 * enumeration failures, so disable this enumeration scheme for USB3
2531 static bool use_new_scheme(struct usb_device *udev, int retry)
2533 if (udev->speed == USB_SPEED_SUPER)
2536 return USE_NEW_SCHEME(retry);
2539 static int hub_port_reset(struct usb_hub *hub, int port1,
2540 struct usb_device *udev, unsigned int delay, bool warm);
2542 /* Is a USB 3.0 port in the Inactive or Compliance Mode state?
2543 * Port worm reset is required to recover
2545 static bool hub_port_warm_reset_required(struct usb_hub *hub, u16 portstatus)
2547 return hub_is_superspeed(hub->hdev) &&
2548 (((portstatus & USB_PORT_STAT_LINK_STATE) ==
2549 USB_SS_PORT_LS_SS_INACTIVE) ||
2550 ((portstatus & USB_PORT_STAT_LINK_STATE) ==
2551 USB_SS_PORT_LS_COMP_MOD)) ;
2554 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2555 struct usb_device *udev, unsigned int delay, bool warm)
2557 int delay_time, ret;
2561 for (delay_time = 0;
2562 delay_time < HUB_RESET_TIMEOUT;
2563 delay_time += delay) {
2564 /* wait to give the device a chance to reset */
2567 /* read and decode port status */
2568 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2572 /* The port state is unknown until the reset completes. */
2573 if (!(portstatus & USB_PORT_STAT_RESET))
2576 /* switch to the long delay after two short delay failures */
2577 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2578 delay = HUB_LONG_RESET_TIME;
2580 dev_dbg (hub->intfdev,
2581 "port %d not %sreset yet, waiting %dms\n",
2582 port1, warm ? "warm " : "", delay);
2585 if ((portstatus & USB_PORT_STAT_RESET))
2588 if (hub_port_warm_reset_required(hub, portstatus))
2591 /* Device went away? */
2592 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2595 /* bomb out completely if the connection bounced. A USB 3.0
2596 * connection may bounce if multiple warm resets were issued,
2597 * but the device may have successfully re-connected. Ignore it.
2599 if (!hub_is_superspeed(hub->hdev) &&
2600 (portchange & USB_PORT_STAT_C_CONNECTION))
2603 if (!(portstatus & USB_PORT_STAT_ENABLE))
2609 if (hub_is_wusb(hub))
2610 udev->speed = USB_SPEED_WIRELESS;
2611 else if (hub_is_superspeed(hub->hdev))
2612 udev->speed = USB_SPEED_SUPER;
2613 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2614 udev->speed = USB_SPEED_HIGH;
2615 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2616 udev->speed = USB_SPEED_LOW;
2618 udev->speed = USB_SPEED_FULL;
2622 static void hub_port_finish_reset(struct usb_hub *hub, int port1,
2623 struct usb_device *udev, int *status)
2627 /* TRSTRCY = 10 ms; plus some extra */
2630 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2632 update_devnum(udev, 0);
2633 /* The xHC may think the device is already reset,
2634 * so ignore the status.
2636 if (hcd->driver->reset_device)
2637 hcd->driver->reset_device(hcd, udev);
2642 usb_clear_port_feature(hub->hdev,
2643 port1, USB_PORT_FEAT_C_RESET);
2644 if (hub_is_superspeed(hub->hdev)) {
2645 usb_clear_port_feature(hub->hdev, port1,
2646 USB_PORT_FEAT_C_BH_PORT_RESET);
2647 usb_clear_port_feature(hub->hdev, port1,
2648 USB_PORT_FEAT_C_PORT_LINK_STATE);
2649 usb_clear_port_feature(hub->hdev, port1,
2650 USB_PORT_FEAT_C_CONNECTION);
2653 usb_set_device_state(udev, *status
2654 ? USB_STATE_NOTATTACHED
2655 : USB_STATE_DEFAULT);
2660 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2661 static int hub_port_reset(struct usb_hub *hub, int port1,
2662 struct usb_device *udev, unsigned int delay, bool warm)
2665 u16 portchange, portstatus;
2667 if (!hub_is_superspeed(hub->hdev)) {
2669 dev_err(hub->intfdev, "only USB3 hub support "
2673 /* Block EHCI CF initialization during the port reset.
2674 * Some companion controllers don't like it when they mix.
2676 down_read(&ehci_cf_port_reset_rwsem);
2679 * If the caller hasn't explicitly requested a warm reset,
2680 * double check and see if one is needed.
2682 status = hub_port_status(hub, port1,
2683 &portstatus, &portchange);
2687 if (hub_port_warm_reset_required(hub, portstatus))
2691 /* Reset the port */
2692 for (i = 0; i < PORT_RESET_TRIES; i++) {
2693 status = set_port_feature(hub->hdev, port1, (warm ?
2694 USB_PORT_FEAT_BH_PORT_RESET :
2695 USB_PORT_FEAT_RESET));
2696 if (status == -ENODEV) {
2697 ; /* The hub is gone */
2698 } else if (status) {
2699 dev_err(hub->intfdev,
2700 "cannot %sreset port %d (err = %d)\n",
2701 warm ? "warm " : "", port1, status);
2703 status = hub_port_wait_reset(hub, port1, udev, delay,
2705 if (status && status != -ENOTCONN && status != -ENODEV)
2706 dev_dbg(hub->intfdev,
2707 "port_wait_reset: err = %d\n",
2711 /* Check for disconnect or reset */
2712 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2713 hub_port_finish_reset(hub, port1, udev, &status);
2715 if (!hub_is_superspeed(hub->hdev))
2719 * If a USB 3.0 device migrates from reset to an error
2720 * state, re-issue the warm reset.
2722 if (hub_port_status(hub, port1,
2723 &portstatus, &portchange) < 0)
2726 if (!hub_port_warm_reset_required(hub, portstatus))
2730 * If the port is in SS.Inactive or Compliance Mode, the
2731 * hot or warm reset failed. Try another warm reset.
2734 dev_dbg(hub->intfdev, "hot reset failed, warm reset port %d\n",
2740 dev_dbg (hub->intfdev,
2741 "port %d not enabled, trying %sreset again...\n",
2742 port1, warm ? "warm " : "");
2743 delay = HUB_LONG_RESET_TIME;
2746 dev_err (hub->intfdev,
2747 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2751 if (!hub_is_superspeed(hub->hdev))
2752 up_read(&ehci_cf_port_reset_rwsem);
2757 /* Check if a port is power on */
2758 static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2762 if (hub_is_superspeed(hub->hdev)) {
2763 if (portstatus & USB_SS_PORT_STAT_POWER)
2766 if (portstatus & USB_PORT_STAT_POWER)
2775 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2776 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
2780 if (hub_is_superspeed(hub->hdev)) {
2781 if ((portstatus & USB_PORT_STAT_LINK_STATE)
2782 == USB_SS_PORT_LS_U3)
2785 if (portstatus & USB_PORT_STAT_SUSPEND)
2792 /* Determine whether the device on a port is ready for a normal resume,
2793 * is ready for a reset-resume, or should be disconnected.
2795 static int check_port_resume_type(struct usb_device *udev,
2796 struct usb_hub *hub, int port1,
2797 int status, unsigned portchange, unsigned portstatus)
2799 /* Is the device still present? */
2800 if (status || port_is_suspended(hub, portstatus) ||
2801 !port_is_power_on(hub, portstatus) ||
2802 !(portstatus & USB_PORT_STAT_CONNECTION)) {
2807 /* Can't do a normal resume if the port isn't enabled,
2808 * so try a reset-resume instead.
2810 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2811 if (udev->persist_enabled)
2812 udev->reset_resume = 1;
2818 dev_dbg(hub->intfdev,
2819 "port %d status %04x.%04x after resume, %d\n",
2820 port1, portchange, portstatus, status);
2821 } else if (udev->reset_resume) {
2823 /* Late port handoff can set status-change bits */
2824 if (portchange & USB_PORT_STAT_C_CONNECTION)
2825 usb_clear_port_feature(hub->hdev, port1,
2826 USB_PORT_FEAT_C_CONNECTION);
2827 if (portchange & USB_PORT_STAT_C_ENABLE)
2828 usb_clear_port_feature(hub->hdev, port1,
2829 USB_PORT_FEAT_C_ENABLE);
2835 int usb_disable_ltm(struct usb_device *udev)
2837 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2839 /* Check if the roothub and device supports LTM. */
2840 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
2841 !usb_device_supports_ltm(udev))
2844 /* Clear Feature LTM Enable can only be sent if the device is
2847 if (!udev->actconfig)
2850 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2851 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2852 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
2853 USB_CTRL_SET_TIMEOUT);
2855 EXPORT_SYMBOL_GPL(usb_disable_ltm);
2857 void usb_enable_ltm(struct usb_device *udev)
2859 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2861 /* Check if the roothub and device supports LTM. */
2862 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
2863 !usb_device_supports_ltm(udev))
2866 /* Set Feature LTM Enable can only be sent if the device is
2869 if (!udev->actconfig)
2872 usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2873 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2874 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
2875 USB_CTRL_SET_TIMEOUT);
2877 EXPORT_SYMBOL_GPL(usb_enable_ltm);
2880 * usb_enable_remote_wakeup - enable remote wakeup for a device
2881 * @udev: target device
2883 * For USB-2 devices: Set the device's remote wakeup feature.
2885 * For USB-3 devices: Assume there's only one function on the device and
2886 * enable remote wake for the first interface. FIXME if the interface
2887 * association descriptor shows there's more than one function.
2889 static int usb_enable_remote_wakeup(struct usb_device *udev)
2891 if (udev->speed < USB_SPEED_SUPER)
2892 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2893 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2894 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
2895 USB_CTRL_SET_TIMEOUT);
2897 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2898 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
2899 USB_INTRF_FUNC_SUSPEND,
2900 USB_INTRF_FUNC_SUSPEND_RW |
2901 USB_INTRF_FUNC_SUSPEND_LP,
2902 NULL, 0, USB_CTRL_SET_TIMEOUT);
2906 * usb_disable_remote_wakeup - disable remote wakeup for a device
2907 * @udev: target device
2909 * For USB-2 devices: Clear the device's remote wakeup feature.
2911 * For USB-3 devices: Assume there's only one function on the device and
2912 * disable remote wake for the first interface. FIXME if the interface
2913 * association descriptor shows there's more than one function.
2915 static int usb_disable_remote_wakeup(struct usb_device *udev)
2917 if (udev->speed < USB_SPEED_SUPER)
2918 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2919 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2920 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
2921 USB_CTRL_SET_TIMEOUT);
2923 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2924 USB_REQ_CLEAR_FEATURE, USB_RECIP_INTERFACE,
2925 USB_INTRF_FUNC_SUSPEND, 0, NULL, 0,
2926 USB_CTRL_SET_TIMEOUT);
2929 /* Count of wakeup-enabled devices at or below udev */
2930 static unsigned wakeup_enabled_descendants(struct usb_device *udev)
2932 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2934 return udev->do_remote_wakeup +
2935 (hub ? hub->wakeup_enabled_descendants : 0);
2939 * usb_port_suspend - suspend a usb device's upstream port
2940 * @udev: device that's no longer in active use, not a root hub
2941 * Context: must be able to sleep; device not locked; pm locks held
2943 * Suspends a USB device that isn't in active use, conserving power.
2944 * Devices may wake out of a suspend, if anything important happens,
2945 * using the remote wakeup mechanism. They may also be taken out of
2946 * suspend by the host, using usb_port_resume(). It's also routine
2947 * to disconnect devices while they are suspended.
2949 * This only affects the USB hardware for a device; its interfaces
2950 * (and, for hubs, child devices) must already have been suspended.
2952 * Selective port suspend reduces power; most suspended devices draw
2953 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2954 * All devices below the suspended port are also suspended.
2956 * Devices leave suspend state when the host wakes them up. Some devices
2957 * also support "remote wakeup", where the device can activate the USB
2958 * tree above them to deliver data, such as a keypress or packet. In
2959 * some cases, this wakes the USB host.
2961 * Suspending OTG devices may trigger HNP, if that's been enabled
2962 * between a pair of dual-role devices. That will change roles, such
2963 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2965 * Devices on USB hub ports have only one "suspend" state, corresponding
2966 * to ACPI D2, "may cause the device to lose some context".
2967 * State transitions include:
2969 * - suspend, resume ... when the VBUS power link stays live
2970 * - suspend, disconnect ... VBUS lost
2972 * Once VBUS drop breaks the circuit, the port it's using has to go through
2973 * normal re-enumeration procedures, starting with enabling VBUS power.
2974 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2975 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2976 * timer, no SRP, no requests through sysfs.
2978 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
2979 * suspended until their bus goes into global suspend (i.e., the root
2980 * hub is suspended). Nevertheless, we change @udev->state to
2981 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
2982 * upstream port setting is stored in @udev->port_is_suspended.
2984 * Returns 0 on success, else negative errno.
2986 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2988 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2989 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
2990 int port1 = udev->portnum;
2992 bool really_suspend = true;
2994 /* enable remote wakeup when appropriate; this lets the device
2995 * wake up the upstream hub (including maybe the root hub).
2997 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2998 * we don't explicitly enable it here.
3000 if (udev->do_remote_wakeup) {
3001 status = usb_enable_remote_wakeup(udev);
3003 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
3005 /* bail if autosuspend is requested */
3006 if (PMSG_IS_AUTO(msg))
3011 /* disable USB2 hardware LPM */
3012 if (udev->usb2_hw_lpm_enabled == 1)
3013 usb_set_usb2_hardware_lpm(udev, 0);
3015 if (usb_disable_ltm(udev)) {
3016 dev_err(&udev->dev, "Failed to disable LTM before suspend\n.");
3018 if (PMSG_IS_AUTO(msg))
3021 if (usb_unlocked_disable_lpm(udev)) {
3022 dev_err(&udev->dev, "Failed to disable LPM before suspend\n.");
3024 if (PMSG_IS_AUTO(msg))
3029 if (hub_is_superspeed(hub->hdev))
3030 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U3);
3033 * For system suspend, we do not need to enable the suspend feature
3034 * on individual USB-2 ports. The devices will automatically go
3035 * into suspend a few ms after the root hub stops sending packets.
3036 * The USB 2.0 spec calls this "global suspend".
3038 * However, many USB hubs have a bug: They don't relay wakeup requests
3039 * from a downstream port if the port's suspend feature isn't on.
3040 * Therefore we will turn on the suspend feature if udev or any of its
3041 * descendants is enabled for remote wakeup.
3043 else if (PMSG_IS_AUTO(msg) || wakeup_enabled_descendants(udev) > 0)
3044 status = set_port_feature(hub->hdev, port1,
3045 USB_PORT_FEAT_SUSPEND);
3047 really_suspend = false;
3051 dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
3054 /* Try to enable USB3 LPM and LTM again */
3055 usb_unlocked_enable_lpm(udev);
3057 usb_enable_ltm(udev);
3059 /* Try to enable USB2 hardware LPM again */
3060 if (udev->usb2_hw_lpm_capable == 1)
3061 usb_set_usb2_hardware_lpm(udev, 1);
3063 if (udev->do_remote_wakeup)
3064 (void) usb_disable_remote_wakeup(udev);
3067 /* System sleep transitions should never fail */
3068 if (!PMSG_IS_AUTO(msg))
3071 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
3072 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
3073 udev->do_remote_wakeup);
3074 if (really_suspend) {
3075 udev->port_is_suspended = 1;
3077 /* device has up to 10 msec to fully suspend */
3080 usb_set_device_state(udev, USB_STATE_SUSPENDED);
3083 if (status == 0 && !udev->do_remote_wakeup && udev->persist_enabled) {
3084 pm_runtime_put_sync(&port_dev->dev);
3085 port_dev->did_runtime_put = true;
3088 usb_mark_last_busy(hub->hdev);
3093 * If the USB "suspend" state is in use (rather than "global suspend"),
3094 * many devices will be individually taken out of suspend state using
3095 * special "resume" signaling. This routine kicks in shortly after
3096 * hardware resume signaling is finished, either because of selective
3097 * resume (by host) or remote wakeup (by device) ... now see what changed
3098 * in the tree that's rooted at this device.
3100 * If @udev->reset_resume is set then the device is reset before the
3101 * status check is done.
3103 static int finish_port_resume(struct usb_device *udev)
3108 /* caller owns the udev device lock */
3109 dev_dbg(&udev->dev, "%s\n",
3110 udev->reset_resume ? "finish reset-resume" : "finish resume");
3112 /* usb ch9 identifies four variants of SUSPENDED, based on what
3113 * state the device resumes to. Linux currently won't see the
3114 * first two on the host side; they'd be inside hub_port_init()
3115 * during many timeouts, but khubd can't suspend until later.
3117 usb_set_device_state(udev, udev->actconfig
3118 ? USB_STATE_CONFIGURED
3119 : USB_STATE_ADDRESS);
3121 /* 10.5.4.5 says not to reset a suspended port if the attached
3122 * device is enabled for remote wakeup. Hence the reset
3123 * operation is carried out here, after the port has been
3126 if (udev->reset_resume)
3128 status = usb_reset_and_verify_device(udev);
3130 /* 10.5.4.5 says be sure devices in the tree are still there.
3131 * For now let's assume the device didn't go crazy on resume,
3132 * and device drivers will know about any resume quirks.
3136 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
3138 /* If a normal resume failed, try doing a reset-resume */
3139 if (status && !udev->reset_resume && udev->persist_enabled) {
3140 dev_dbg(&udev->dev, "retry with reset-resume\n");
3141 udev->reset_resume = 1;
3142 goto retry_reset_resume;
3147 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
3150 * There are a few quirky devices which violate the standard
3151 * by claiming to have remote wakeup enabled after a reset,
3152 * which crash if the feature is cleared, hence check for
3153 * udev->reset_resume
3155 } else if (udev->actconfig && !udev->reset_resume) {
3156 if (udev->speed < USB_SPEED_SUPER) {
3157 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
3158 status = usb_disable_remote_wakeup(udev);
3160 status = usb_get_status(udev, USB_RECIP_INTERFACE, 0,
3162 if (!status && devstatus & (USB_INTRF_STAT_FUNC_RW_CAP
3163 | USB_INTRF_STAT_FUNC_RW))
3164 status = usb_disable_remote_wakeup(udev);
3169 "disable remote wakeup, status %d\n",
3177 * There are some SS USB devices which take longer time for link training.
3178 * XHCI specs 4.19.4 says that when Link training is successful, port
3179 * sets CSC bit to 1. So if SW reads port status before successful link
3180 * training, then it will not find device to be present.
3181 * USB Analyzer log with such buggy devices show that in some cases
3182 * device switch on the RX termination after long delay of host enabling
3183 * the VBUS. In few other cases it has been seen that device fails to
3184 * negotiate link training in first attempt. It has been
3185 * reported till now that few devices take as long as 2000 ms to train
3186 * the link after host enabling its VBUS and termination. Following
3187 * routine implements a 2000 ms timeout for link training. If in a case
3188 * link trains before timeout, loop will exit earlier.
3190 * FIXME: If a device was connected before suspend, but was removed
3191 * while system was asleep, then the loop in the following routine will
3192 * only exit at timeout.
3194 * This routine should only be called when persist is enabled for a SS
3197 static int wait_for_ss_port_enable(struct usb_device *udev,
3198 struct usb_hub *hub, int *port1,
3199 u16 *portchange, u16 *portstatus)
3201 int status = 0, delay_ms = 0;
3203 while (delay_ms < 2000) {
3204 if (status || *portstatus & USB_PORT_STAT_CONNECTION)
3208 status = hub_port_status(hub, *port1, portstatus, portchange);
3214 * usb_port_resume - re-activate a suspended usb device's upstream port
3215 * @udev: device to re-activate, not a root hub
3216 * Context: must be able to sleep; device not locked; pm locks held
3218 * This will re-activate the suspended device, increasing power usage
3219 * while letting drivers communicate again with its endpoints.
3220 * USB resume explicitly guarantees that the power session between
3221 * the host and the device is the same as it was when the device
3224 * If @udev->reset_resume is set then this routine won't check that the
3225 * port is still enabled. Furthermore, finish_port_resume() above will
3226 * reset @udev. The end result is that a broken power session can be
3227 * recovered and @udev will appear to persist across a loss of VBUS power.
3229 * For example, if a host controller doesn't maintain VBUS suspend current
3230 * during a system sleep or is reset when the system wakes up, all the USB
3231 * power sessions below it will be broken. This is especially troublesome
3232 * for mass-storage devices containing mounted filesystems, since the
3233 * device will appear to have disconnected and all the memory mappings
3234 * to it will be lost. Using the USB_PERSIST facility, the device can be
3235 * made to appear as if it had not disconnected.
3237 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3238 * every effort to insure that the same device is present after the
3239 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3240 * quite possible for a device to remain unaltered but its media to be
3241 * changed. If the user replaces a flash memory card while the system is
3242 * asleep, he will have only himself to blame when the filesystem on the
3243 * new card is corrupted and the system crashes.
3245 * Returns 0 on success, else negative errno.
3247 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
3249 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3250 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3251 int port1 = udev->portnum;
3253 u16 portchange, portstatus;
3255 if (port_dev->did_runtime_put) {
3256 status = pm_runtime_get_sync(&port_dev->dev);
3257 port_dev->did_runtime_put = false;
3259 dev_dbg(&udev->dev, "can't resume usb port, status %d\n",
3265 /* Skip the initial Clear-Suspend step for a remote wakeup */
3266 status = hub_port_status(hub, port1, &portstatus, &portchange);
3267 if (status == 0 && !port_is_suspended(hub, portstatus))
3268 goto SuspendCleared;
3270 /* dev_dbg(hub->intfdev, "resume port %d\n", port1); */
3272 set_bit(port1, hub->busy_bits);
3274 /* see 7.1.7.7; affects power usage, but not budgeting */
3275 if (hub_is_superspeed(hub->hdev))
3276 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U0);
3278 status = usb_clear_port_feature(hub->hdev,
3279 port1, USB_PORT_FEAT_SUSPEND);
3281 dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
3284 /* drive resume for at least 20 msec */
3285 dev_dbg(&udev->dev, "usb %sresume\n",
3286 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
3289 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3290 * stop resume signaling. Then finish the resume
3293 status = hub_port_status(hub, port1, &portstatus, &portchange);
3295 /* TRSMRCY = 10 msec */
3301 udev->port_is_suspended = 0;
3302 if (hub_is_superspeed(hub->hdev)) {
3303 if (portchange & USB_PORT_STAT_C_LINK_STATE)
3304 usb_clear_port_feature(hub->hdev, port1,
3305 USB_PORT_FEAT_C_PORT_LINK_STATE);
3307 if (portchange & USB_PORT_STAT_C_SUSPEND)
3308 usb_clear_port_feature(hub->hdev, port1,
3309 USB_PORT_FEAT_C_SUSPEND);
3313 clear_bit(port1, hub->busy_bits);
3315 if (udev->persist_enabled && hub_is_superspeed(hub->hdev))
3316 status = wait_for_ss_port_enable(udev, hub, &port1, &portchange,
3319 status = check_port_resume_type(udev,
3320 hub, port1, status, portchange, portstatus);
3322 status = finish_port_resume(udev);
3324 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
3325 hub_port_logical_disconnect(hub, port1);
3327 /* Try to enable USB2 hardware LPM */
3328 if (udev->usb2_hw_lpm_capable == 1)
3329 usb_set_usb2_hardware_lpm(udev, 1);
3331 /* Try to enable USB3 LTM and LPM */
3332 usb_enable_ltm(udev);
3333 usb_unlocked_enable_lpm(udev);
3339 #ifdef CONFIG_PM_RUNTIME
3341 /* caller has locked udev */
3342 int usb_remote_wakeup(struct usb_device *udev)
3346 if (udev->state == USB_STATE_SUSPENDED) {
3347 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
3348 status = usb_autoresume_device(udev);
3350 /* Let the drivers do their thing, then... */
3351 usb_autosuspend_device(udev);
3359 static int check_ports_changed(struct usb_hub *hub)
3363 for (port1 = 1; port1 <= hub->hdev->maxchild; ++port1) {
3364 u16 portstatus, portchange;
3367 status = hub_port_status(hub, port1, &portstatus, &portchange);
3368 if (!status && portchange)
3374 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
3376 struct usb_hub *hub = usb_get_intfdata (intf);
3377 struct usb_device *hdev = hub->hdev;
3382 * Warn if children aren't already suspended.
3383 * Also, add up the number of wakeup-enabled descendants.
3385 hub->wakeup_enabled_descendants = 0;
3386 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3387 struct usb_device *udev;
3389 udev = hub->ports[port1 - 1]->child;
3390 if (udev && udev->can_submit) {
3391 dev_warn(&intf->dev, "port %d not suspended yet\n",
3393 if (PMSG_IS_AUTO(msg))
3397 hub->wakeup_enabled_descendants +=
3398 wakeup_enabled_descendants(udev);
3401 if (hdev->do_remote_wakeup && hub->quirk_check_port_auto_suspend) {
3402 /* check if there are changes pending on hub ports */
3403 if (check_ports_changed(hub)) {
3404 if (PMSG_IS_AUTO(msg))
3406 pm_wakeup_event(&hdev->dev, 2000);
3410 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
3411 /* Enable hub to send remote wakeup for all ports. */
3412 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3413 status = set_port_feature(hdev,
3415 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
3416 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
3417 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
3418 USB_PORT_FEAT_REMOTE_WAKE_MASK);
3422 dev_dbg(&intf->dev, "%s\n", __func__);
3424 /* stop khubd and related activity */
3425 hub_quiesce(hub, HUB_SUSPEND);
3429 static int hub_resume(struct usb_interface *intf)
3431 struct usb_hub *hub = usb_get_intfdata(intf);
3433 dev_dbg(&intf->dev, "%s\n", __func__);
3434 hub_activate(hub, HUB_RESUME);
3438 static int hub_reset_resume(struct usb_interface *intf)
3440 struct usb_hub *hub = usb_get_intfdata(intf);
3442 dev_dbg(&intf->dev, "%s\n", __func__);
3443 hub_activate(hub, HUB_RESET_RESUME);
3448 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3449 * @rhdev: struct usb_device for the root hub
3451 * The USB host controller driver calls this function when its root hub
3452 * is resumed and Vbus power has been interrupted or the controller
3453 * has been reset. The routine marks @rhdev as having lost power.
3454 * When the hub driver is resumed it will take notice and carry out
3455 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3456 * the others will be disconnected.
3458 void usb_root_hub_lost_power(struct usb_device *rhdev)
3460 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
3461 rhdev->reset_resume = 1;
3463 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
3465 static const char * const usb3_lpm_names[] = {
3473 * Send a Set SEL control transfer to the device, prior to enabling
3474 * device-initiated U1 or U2. This lets the device know the exit latencies from
3475 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3476 * packet from the host.
3478 * This function will fail if the SEL or PEL values for udev are greater than
3479 * the maximum allowed values for the link state to be enabled.
3481 static int usb_req_set_sel(struct usb_device *udev, enum usb3_link_state state)
3483 struct usb_set_sel_req *sel_values;
3484 unsigned long long u1_sel;
3485 unsigned long long u1_pel;
3486 unsigned long long u2_sel;
3487 unsigned long long u2_pel;
3490 if (udev->state != USB_STATE_CONFIGURED)
3493 /* Convert SEL and PEL stored in ns to us */
3494 u1_sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
3495 u1_pel = DIV_ROUND_UP(udev->u1_params.pel, 1000);
3496 u2_sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
3497 u2_pel = DIV_ROUND_UP(udev->u2_params.pel, 1000);
3500 * Make sure that the calculated SEL and PEL values for the link
3501 * state we're enabling aren't bigger than the max SEL/PEL
3502 * value that will fit in the SET SEL control transfer.
3503 * Otherwise the device would get an incorrect idea of the exit
3504 * latency for the link state, and could start a device-initiated
3505 * U1/U2 when the exit latencies are too high.
3507 if ((state == USB3_LPM_U1 &&
3508 (u1_sel > USB3_LPM_MAX_U1_SEL_PEL ||
3509 u1_pel > USB3_LPM_MAX_U1_SEL_PEL)) ||
3510 (state == USB3_LPM_U2 &&
3511 (u2_sel > USB3_LPM_MAX_U2_SEL_PEL ||
3512 u2_pel > USB3_LPM_MAX_U2_SEL_PEL))) {
3513 dev_dbg(&udev->dev, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3514 usb3_lpm_names[state], u1_sel, u1_pel);
3519 * If we're enabling device-initiated LPM for one link state,
3520 * but the other link state has a too high SEL or PEL value,
3521 * just set those values to the max in the Set SEL request.
3523 if (u1_sel > USB3_LPM_MAX_U1_SEL_PEL)
3524 u1_sel = USB3_LPM_MAX_U1_SEL_PEL;
3526 if (u1_pel > USB3_LPM_MAX_U1_SEL_PEL)
3527 u1_pel = USB3_LPM_MAX_U1_SEL_PEL;
3529 if (u2_sel > USB3_LPM_MAX_U2_SEL_PEL)
3530 u2_sel = USB3_LPM_MAX_U2_SEL_PEL;
3532 if (u2_pel > USB3_LPM_MAX_U2_SEL_PEL)
3533 u2_pel = USB3_LPM_MAX_U2_SEL_PEL;
3536 * usb_enable_lpm() can be called as part of a failed device reset,
3537 * which may be initiated by an error path of a mass storage driver.
3538 * Therefore, use GFP_NOIO.
3540 sel_values = kmalloc(sizeof *(sel_values), GFP_NOIO);
3544 sel_values->u1_sel = u1_sel;
3545 sel_values->u1_pel = u1_pel;
3546 sel_values->u2_sel = cpu_to_le16(u2_sel);
3547 sel_values->u2_pel = cpu_to_le16(u2_pel);
3549 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3553 sel_values, sizeof *(sel_values),
3554 USB_CTRL_SET_TIMEOUT);
3560 * Enable or disable device-initiated U1 or U2 transitions.
3562 static int usb_set_device_initiated_lpm(struct usb_device *udev,
3563 enum usb3_link_state state, bool enable)
3570 feature = USB_DEVICE_U1_ENABLE;
3573 feature = USB_DEVICE_U2_ENABLE;
3576 dev_warn(&udev->dev, "%s: Can't %s non-U1 or U2 state.\n",
3577 __func__, enable ? "enable" : "disable");
3581 if (udev->state != USB_STATE_CONFIGURED) {
3582 dev_dbg(&udev->dev, "%s: Can't %s %s state "
3583 "for unconfigured device.\n",
3584 __func__, enable ? "enable" : "disable",
3585 usb3_lpm_names[state]);
3591 * Now send the control transfer to enable device-initiated LPM
3592 * for either U1 or U2.
3594 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3595 USB_REQ_SET_FEATURE,
3599 USB_CTRL_SET_TIMEOUT);
3601 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3602 USB_REQ_CLEAR_FEATURE,
3606 USB_CTRL_SET_TIMEOUT);
3609 dev_warn(&udev->dev, "%s of device-initiated %s failed.\n",
3610 enable ? "Enable" : "Disable",
3611 usb3_lpm_names[state]);
3617 static int usb_set_lpm_timeout(struct usb_device *udev,
3618 enum usb3_link_state state, int timeout)
3625 feature = USB_PORT_FEAT_U1_TIMEOUT;
3628 feature = USB_PORT_FEAT_U2_TIMEOUT;
3631 dev_warn(&udev->dev, "%s: Can't set timeout for non-U1 or U2 state.\n",
3636 if (state == USB3_LPM_U1 && timeout > USB3_LPM_U1_MAX_TIMEOUT &&
3637 timeout != USB3_LPM_DEVICE_INITIATED) {
3638 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x, "
3639 "which is a reserved value.\n",
3640 usb3_lpm_names[state], timeout);
3644 ret = set_port_feature(udev->parent,
3645 USB_PORT_LPM_TIMEOUT(timeout) | udev->portnum,
3648 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x,"
3649 "error code %i\n", usb3_lpm_names[state],
3653 if (state == USB3_LPM_U1)
3654 udev->u1_params.timeout = timeout;
3656 udev->u2_params.timeout = timeout;
3661 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3664 * We will attempt to enable U1 or U2, but there are no guarantees that the
3665 * control transfers to set the hub timeout or enable device-initiated U1/U2
3666 * will be successful.
3668 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3669 * driver know about it. If that call fails, it should be harmless, and just
3670 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3672 static void usb_enable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3673 enum usb3_link_state state)
3676 __u8 u1_mel = udev->bos->ss_cap->bU1devExitLat;
3677 __le16 u2_mel = udev->bos->ss_cap->bU2DevExitLat;
3679 /* If the device says it doesn't have *any* exit latency to come out of
3680 * U1 or U2, it's probably lying. Assume it doesn't implement that link
3683 if ((state == USB3_LPM_U1 && u1_mel == 0) ||
3684 (state == USB3_LPM_U2 && u2_mel == 0))
3688 * First, let the device know about the exit latencies
3689 * associated with the link state we're about to enable.
3691 ret = usb_req_set_sel(udev, state);
3693 dev_warn(&udev->dev, "Set SEL for device-initiated %s failed.\n",
3694 usb3_lpm_names[state]);
3698 /* We allow the host controller to set the U1/U2 timeout internally
3699 * first, so that it can change its schedule to account for the
3700 * additional latency to send data to a device in a lower power
3703 timeout = hcd->driver->enable_usb3_lpm_timeout(hcd, udev, state);
3705 /* xHCI host controller doesn't want to enable this LPM state. */
3710 dev_warn(&udev->dev, "Could not enable %s link state, "
3711 "xHCI error %i.\n", usb3_lpm_names[state],
3716 if (usb_set_lpm_timeout(udev, state, timeout))
3717 /* If we can't set the parent hub U1/U2 timeout,
3718 * device-initiated LPM won't be allowed either, so let the xHCI
3719 * host know that this link state won't be enabled.
3721 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
3723 /* Only a configured device will accept the Set Feature U1/U2_ENABLE */
3724 else if (udev->actconfig)
3725 usb_set_device_initiated_lpm(udev, state, true);
3730 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
3733 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
3734 * If zero is returned, the parent will not allow the link to go into U1/U2.
3736 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
3737 * it won't have an effect on the bus link state because the parent hub will
3738 * still disallow device-initiated U1/U2 entry.
3740 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
3741 * possible. The result will be slightly more bus bandwidth will be taken up
3742 * (to account for U1/U2 exit latency), but it should be harmless.
3744 static int usb_disable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3745 enum usb3_link_state state)
3751 feature = USB_PORT_FEAT_U1_TIMEOUT;
3754 feature = USB_PORT_FEAT_U2_TIMEOUT;
3757 dev_warn(&udev->dev, "%s: Can't disable non-U1 or U2 state.\n",
3762 if (usb_set_lpm_timeout(udev, state, 0))
3765 usb_set_device_initiated_lpm(udev, state, false);
3767 if (hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state))
3768 dev_warn(&udev->dev, "Could not disable xHCI %s timeout, "
3769 "bus schedule bandwidth may be impacted.\n",
3770 usb3_lpm_names[state]);
3775 * Disable hub-initiated and device-initiated U1 and U2 entry.
3776 * Caller must own the bandwidth_mutex.
3778 * This will call usb_enable_lpm() on failure, which will decrement
3779 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
3781 int usb_disable_lpm(struct usb_device *udev)
3783 struct usb_hcd *hcd;
3785 if (!udev || !udev->parent ||
3786 udev->speed != USB_SPEED_SUPER ||
3790 hcd = bus_to_hcd(udev->bus);
3791 if (!hcd || !hcd->driver->disable_usb3_lpm_timeout)
3794 udev->lpm_disable_count++;
3795 if ((udev->u1_params.timeout == 0 && udev->u2_params.timeout == 0))
3798 /* If LPM is enabled, attempt to disable it. */
3799 if (usb_disable_link_state(hcd, udev, USB3_LPM_U1))
3801 if (usb_disable_link_state(hcd, udev, USB3_LPM_U2))
3807 usb_enable_lpm(udev);
3810 EXPORT_SYMBOL_GPL(usb_disable_lpm);
3812 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
3813 int usb_unlocked_disable_lpm(struct usb_device *udev)
3815 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3821 mutex_lock(hcd->bandwidth_mutex);
3822 ret = usb_disable_lpm(udev);
3823 mutex_unlock(hcd->bandwidth_mutex);
3827 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
3830 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
3831 * xHCI host policy may prevent U1 or U2 from being enabled.
3833 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
3834 * until the lpm_disable_count drops to zero. Caller must own the
3837 void usb_enable_lpm(struct usb_device *udev)
3839 struct usb_hcd *hcd;
3841 if (!udev || !udev->parent ||
3842 udev->speed != USB_SPEED_SUPER ||
3846 udev->lpm_disable_count--;
3847 hcd = bus_to_hcd(udev->bus);
3848 /* Double check that we can both enable and disable LPM.
3849 * Device must be configured to accept set feature U1/U2 timeout.
3851 if (!hcd || !hcd->driver->enable_usb3_lpm_timeout ||
3852 !hcd->driver->disable_usb3_lpm_timeout)
3855 if (udev->lpm_disable_count > 0)
3858 usb_enable_link_state(hcd, udev, USB3_LPM_U1);
3859 usb_enable_link_state(hcd, udev, USB3_LPM_U2);
3861 EXPORT_SYMBOL_GPL(usb_enable_lpm);
3863 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
3864 void usb_unlocked_enable_lpm(struct usb_device *udev)
3866 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3871 mutex_lock(hcd->bandwidth_mutex);
3872 usb_enable_lpm(udev);
3873 mutex_unlock(hcd->bandwidth_mutex);
3875 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
3878 #else /* CONFIG_PM */
3880 #define hub_suspend NULL
3881 #define hub_resume NULL
3882 #define hub_reset_resume NULL
3884 int usb_disable_lpm(struct usb_device *udev)
3888 EXPORT_SYMBOL_GPL(usb_disable_lpm);
3890 void usb_enable_lpm(struct usb_device *udev) { }
3891 EXPORT_SYMBOL_GPL(usb_enable_lpm);
3893 int usb_unlocked_disable_lpm(struct usb_device *udev)
3897 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
3899 void usb_unlocked_enable_lpm(struct usb_device *udev) { }
3900 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
3902 int usb_disable_ltm(struct usb_device *udev)
3906 EXPORT_SYMBOL_GPL(usb_disable_ltm);
3908 void usb_enable_ltm(struct usb_device *udev) { }
3909 EXPORT_SYMBOL_GPL(usb_enable_ltm);
3911 #endif /* CONFIG_PM */
3914 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
3916 * Between connect detection and reset signaling there must be a delay
3917 * of 100ms at least for debounce and power-settling. The corresponding
3918 * timer shall restart whenever the downstream port detects a disconnect.
3920 * Apparently there are some bluetooth and irda-dongles and a number of
3921 * low-speed devices for which this debounce period may last over a second.
3922 * Not covered by the spec - but easy to deal with.
3924 * This implementation uses a 1500ms total debounce timeout; if the
3925 * connection isn't stable by then it returns -ETIMEDOUT. It checks
3926 * every 25ms for transient disconnects. When the port status has been
3927 * unchanged for 100ms it returns the port status.
3929 int hub_port_debounce(struct usb_hub *hub, int port1, bool must_be_connected)
3932 int total_time, stable_time = 0;
3933 u16 portchange, portstatus;
3934 unsigned connection = 0xffff;
3936 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
3937 ret = hub_port_status(hub, port1, &portstatus, &portchange);
3941 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
3942 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
3943 if (!must_be_connected ||
3944 (connection == USB_PORT_STAT_CONNECTION))
3945 stable_time += HUB_DEBOUNCE_STEP;
3946 if (stable_time >= HUB_DEBOUNCE_STABLE)
3950 connection = portstatus & USB_PORT_STAT_CONNECTION;
3953 if (portchange & USB_PORT_STAT_C_CONNECTION) {
3954 usb_clear_port_feature(hub->hdev, port1,
3955 USB_PORT_FEAT_C_CONNECTION);
3958 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
3960 msleep(HUB_DEBOUNCE_STEP);
3963 dev_dbg (hub->intfdev,
3964 "debounce: port %d: total %dms stable %dms status 0x%x\n",
3965 port1, total_time, stable_time, portstatus);
3967 if (stable_time < HUB_DEBOUNCE_STABLE)
3972 void usb_ep0_reinit(struct usb_device *udev)
3974 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
3975 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
3976 usb_enable_endpoint(udev, &udev->ep0, true);
3978 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
3980 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
3981 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
3983 static int hub_set_address(struct usb_device *udev, int devnum)
3986 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3989 * The host controller will choose the device address,
3990 * instead of the core having chosen it earlier
3992 if (!hcd->driver->address_device && devnum <= 1)
3994 if (udev->state == USB_STATE_ADDRESS)
3996 if (udev->state != USB_STATE_DEFAULT)
3998 if (hcd->driver->address_device)
3999 retval = hcd->driver->address_device(hcd, udev);
4001 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
4002 USB_REQ_SET_ADDRESS, 0, devnum, 0,
4003 NULL, 0, USB_CTRL_SET_TIMEOUT);
4005 update_devnum(udev, devnum);
4006 /* Device now using proper address. */
4007 usb_set_device_state(udev, USB_STATE_ADDRESS);
4008 usb_ep0_reinit(udev);
4014 * There are reports of USB 3.0 devices that say they support USB 2.0 Link PM
4015 * when they're plugged into a USB 2.0 port, but they don't work when LPM is
4018 * Only enable USB 2.0 Link PM if the port is internal (hardwired), or the
4019 * device says it supports the new USB 2.0 Link PM errata by setting the BESL
4020 * support bit in the BOS descriptor.
4022 static void hub_set_initial_usb2_lpm_policy(struct usb_device *udev)
4026 if (!udev->usb2_hw_lpm_capable)
4029 connect_type = usb_get_hub_port_connect_type(udev->parent,
4032 if ((udev->bos->ext_cap->bmAttributes & USB_BESL_SUPPORT) ||
4033 connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
4034 udev->usb2_hw_lpm_allowed = 1;
4035 usb_set_usb2_hardware_lpm(udev, 1);
4039 static int hub_enable_device(struct usb_device *udev)
4041 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4043 if (!hcd->driver->enable_device)
4045 if (udev->state == USB_STATE_ADDRESS)
4047 if (udev->state != USB_STATE_DEFAULT)
4050 return hcd->driver->enable_device(hcd, udev);
4053 /* Reset device, (re)assign address, get device descriptor.
4054 * Device connection must be stable, no more debouncing needed.
4055 * Returns device in USB_STATE_ADDRESS, except on error.
4057 * If this is called for an already-existing device (as part of
4058 * usb_reset_and_verify_device), the caller must own the device lock. For a
4059 * newly detected device that is not accessible through any global
4060 * pointers, it's not necessary to lock the device.
4063 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
4066 static DEFINE_MUTEX(usb_address0_mutex);
4068 struct usb_device *hdev = hub->hdev;
4069 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4071 unsigned delay = HUB_SHORT_RESET_TIME;
4072 enum usb_device_speed oldspeed = udev->speed;
4074 int devnum = udev->devnum;
4076 /* root hub ports have a slightly longer reset period
4077 * (from USB 2.0 spec, section 7.1.7.5)
4079 if (!hdev->parent) {
4080 delay = HUB_ROOT_RESET_TIME;
4081 if (port1 == hdev->bus->otg_port)
4082 hdev->bus->b_hnp_enable = 0;
4085 /* Some low speed devices have problems with the quick delay, so */
4086 /* be a bit pessimistic with those devices. RHbug #23670 */
4087 if (oldspeed == USB_SPEED_LOW)
4088 delay = HUB_LONG_RESET_TIME;
4090 mutex_lock(&usb_address0_mutex);
4092 /* Reset the device; full speed may morph to high speed */
4093 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
4094 retval = hub_port_reset(hub, port1, udev, delay, false);
4095 if (retval < 0) /* error or disconnect */
4097 /* success, speed is known */
4101 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
4102 dev_dbg(&udev->dev, "device reset changed speed!\n");
4105 oldspeed = udev->speed;
4107 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4108 * it's fixed size except for full speed devices.
4109 * For Wireless USB devices, ep0 max packet is always 512 (tho
4110 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4112 switch (udev->speed) {
4113 case USB_SPEED_SUPER:
4114 case USB_SPEED_WIRELESS: /* fixed at 512 */
4115 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
4117 case USB_SPEED_HIGH: /* fixed at 64 */
4118 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4120 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
4121 /* to determine the ep0 maxpacket size, try to read
4122 * the device descriptor to get bMaxPacketSize0 and
4123 * then correct our initial guess.
4125 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4127 case USB_SPEED_LOW: /* fixed at 8 */
4128 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
4134 if (udev->speed == USB_SPEED_WIRELESS)
4135 speed = "variable speed Wireless";
4137 speed = usb_speed_string(udev->speed);
4139 if (udev->speed != USB_SPEED_SUPER)
4140 dev_info(&udev->dev,
4141 "%s %s USB device number %d using %s\n",
4142 (udev->config) ? "reset" : "new", speed,
4143 devnum, udev->bus->controller->driver->name);
4145 /* Set up TT records, if needed */
4147 udev->tt = hdev->tt;
4148 udev->ttport = hdev->ttport;
4149 } else if (udev->speed != USB_SPEED_HIGH
4150 && hdev->speed == USB_SPEED_HIGH) {
4152 dev_err(&udev->dev, "parent hub has no TT\n");
4156 udev->tt = &hub->tt;
4157 udev->ttport = port1;
4160 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4161 * Because device hardware and firmware is sometimes buggy in
4162 * this area, and this is how Linux has done it for ages.
4163 * Change it cautiously.
4165 * NOTE: If use_new_scheme() is true we will start by issuing
4166 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4167 * so it may help with some non-standards-compliant devices.
4168 * Otherwise we start with SET_ADDRESS and then try to read the
4169 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4172 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
4173 bool did_new_scheme = false;
4175 if (use_new_scheme(udev, retry_counter)) {
4176 struct usb_device_descriptor *buf;
4179 did_new_scheme = true;
4180 retval = hub_enable_device(udev);
4184 #define GET_DESCRIPTOR_BUFSIZE 64
4185 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
4191 /* Retry on all errors; some devices are flakey.
4192 * 255 is for WUSB devices, we actually need to use
4193 * 512 (WUSB1.0[4.8.1]).
4195 for (j = 0; j < 3; ++j) {
4196 buf->bMaxPacketSize0 = 0;
4197 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
4198 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
4199 USB_DT_DEVICE << 8, 0,
4200 buf, GET_DESCRIPTOR_BUFSIZE,
4201 initial_descriptor_timeout);
4202 switch (buf->bMaxPacketSize0) {
4203 case 8: case 16: case 32: case 64: case 255:
4204 if (buf->bDescriptorType ==
4218 udev->descriptor.bMaxPacketSize0 =
4219 buf->bMaxPacketSize0;
4222 retval = hub_port_reset(hub, port1, udev, delay, false);
4223 if (retval < 0) /* error or disconnect */
4225 if (oldspeed != udev->speed) {
4227 "device reset changed speed!\n");
4233 dev_err(&udev->dev, "device descriptor read/64, error %d\n",
4238 #undef GET_DESCRIPTOR_BUFSIZE
4242 * If device is WUSB, we already assigned an
4243 * unauthorized address in the Connect Ack sequence;
4244 * authorization will assign the final address.
4246 if (udev->wusb == 0) {
4247 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
4248 retval = hub_set_address(udev, devnum);
4254 if (retval != -ENODEV)
4255 dev_err(&udev->dev, "device not accepting address %d, error %d\n",
4259 if (udev->speed == USB_SPEED_SUPER) {
4260 devnum = udev->devnum;
4261 dev_info(&udev->dev,
4262 "%s SuperSpeed USB device number %d using %s\n",
4263 (udev->config) ? "reset" : "new",
4264 devnum, udev->bus->controller->driver->name);
4267 /* cope with hardware quirkiness:
4268 * - let SET_ADDRESS settle, some device hardware wants it
4269 * - read ep0 maxpacket even for high and low speed,
4272 /* use_new_scheme() checks the speed which may have
4273 * changed since the initial look so we cache the result
4280 retval = usb_get_device_descriptor(udev, 8);
4282 if (retval != -ENODEV)
4284 "device descriptor read/8, error %d\n",
4296 if (hcd->phy && !hdev->parent)
4297 usb_phy_notify_connect(hcd->phy, udev->speed);
4300 * Some superspeed devices have finished the link training process
4301 * and attached to a superspeed hub port, but the device descriptor
4302 * got from those devices show they aren't superspeed devices. Warm
4303 * reset the port attached by the devices can fix them.
4305 if ((udev->speed == USB_SPEED_SUPER) &&
4306 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
4307 dev_err(&udev->dev, "got a wrong device descriptor, "
4308 "warm reset device\n");
4309 hub_port_reset(hub, port1, udev,
4310 HUB_BH_RESET_TIME, true);
4315 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
4316 udev->speed == USB_SPEED_SUPER)
4319 i = udev->descriptor.bMaxPacketSize0;
4320 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
4321 if (udev->speed == USB_SPEED_LOW ||
4322 !(i == 8 || i == 16 || i == 32 || i == 64)) {
4323 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
4327 if (udev->speed == USB_SPEED_FULL)
4328 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
4330 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
4331 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
4332 usb_ep0_reinit(udev);
4335 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
4336 if (retval < (signed)sizeof(udev->descriptor)) {
4337 if (retval != -ENODEV)
4338 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
4345 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
4346 retval = usb_get_bos_descriptor(udev);
4348 udev->lpm_capable = usb_device_supports_lpm(udev);
4349 usb_set_lpm_parameters(udev);
4354 /* notify HCD that we have a device connected and addressed */
4355 if (hcd->driver->update_device)
4356 hcd->driver->update_device(hcd, udev);
4357 hub_set_initial_usb2_lpm_policy(udev);
4360 hub_port_disable(hub, port1, 0);
4361 update_devnum(udev, devnum); /* for disconnect processing */
4363 mutex_unlock(&usb_address0_mutex);
4368 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
4370 struct usb_qualifier_descriptor *qual;
4373 qual = kmalloc (sizeof *qual, GFP_KERNEL);
4377 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
4378 qual, sizeof *qual);
4379 if (status == sizeof *qual) {
4380 dev_info(&udev->dev, "not running at top speed; "
4381 "connect to a high speed hub\n");
4382 /* hub LEDs are probably harder to miss than syslog */
4383 if (hub->has_indicators) {
4384 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
4385 schedule_delayed_work (&hub->leds, 0);
4392 hub_power_remaining (struct usb_hub *hub)
4394 struct usb_device *hdev = hub->hdev;
4398 if (!hub->limited_power)
4401 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
4402 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
4403 struct usb_device *udev = hub->ports[port1 - 1]->child;
4409 if (hub_is_superspeed(udev))
4415 * Unconfigured devices may not use more than one unit load,
4416 * or 8mA for OTG ports
4418 if (udev->actconfig)
4419 delta = usb_get_max_power(udev, udev->actconfig);
4420 else if (port1 != udev->bus->otg_port || hdev->parent)
4424 if (delta > hub->mA_per_port)
4425 dev_warn(&udev->dev,
4426 "%dmA is over %umA budget for port %d!\n",
4427 delta, hub->mA_per_port, port1);
4430 if (remaining < 0) {
4431 dev_warn(hub->intfdev, "%dmA over power budget!\n",
4438 /* Handle physical or logical connection change events.
4439 * This routine is called when:
4440 * a port connection-change occurs;
4441 * a port enable-change occurs (often caused by EMI);
4442 * usb_reset_and_verify_device() encounters changed descriptors (as from
4443 * a firmware download)
4444 * caller already locked the hub
4446 static void hub_port_connect_change(struct usb_hub *hub, int port1,
4447 u16 portstatus, u16 portchange)
4449 struct usb_device *hdev = hub->hdev;
4450 struct device *hub_dev = hub->intfdev;
4451 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4452 unsigned wHubCharacteristics =
4453 le16_to_cpu(hub->descriptor->wHubCharacteristics);
4454 struct usb_device *udev;
4459 "port %d, status %04x, change %04x, %s\n",
4460 port1, portstatus, portchange, portspeed(hub, portstatus));
4462 if (hub->has_indicators) {
4463 set_port_led(hub, port1, HUB_LED_AUTO);
4464 hub->indicator[port1-1] = INDICATOR_AUTO;
4467 #ifdef CONFIG_USB_OTG
4468 /* during HNP, don't repeat the debounce */
4469 if (hdev->bus->is_b_host)
4470 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
4471 USB_PORT_STAT_C_ENABLE);
4474 /* Try to resuscitate an existing device */
4475 udev = hub->ports[port1 - 1]->child;
4476 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
4477 udev->state != USB_STATE_NOTATTACHED) {
4478 usb_lock_device(udev);
4479 if (portstatus & USB_PORT_STAT_ENABLE) {
4480 status = 0; /* Nothing to do */
4482 #ifdef CONFIG_PM_RUNTIME
4483 } else if (udev->state == USB_STATE_SUSPENDED &&
4484 udev->persist_enabled) {
4485 /* For a suspended device, treat this as a
4486 * remote wakeup event.
4488 status = usb_remote_wakeup(udev);
4492 status = -ENODEV; /* Don't resuscitate */
4494 usb_unlock_device(udev);
4497 clear_bit(port1, hub->change_bits);
4502 /* Disconnect any existing devices under this port */
4504 if (hcd->phy && !hdev->parent &&
4505 !(portstatus & USB_PORT_STAT_CONNECTION))
4506 usb_phy_notify_disconnect(hcd->phy, udev->speed);
4507 usb_disconnect(&hub->ports[port1 - 1]->child);
4509 clear_bit(port1, hub->change_bits);
4511 /* We can forget about a "removed" device when there's a physical
4512 * disconnect or the connect status changes.
4514 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4515 (portchange & USB_PORT_STAT_C_CONNECTION))
4516 clear_bit(port1, hub->removed_bits);
4518 if (portchange & (USB_PORT_STAT_C_CONNECTION |
4519 USB_PORT_STAT_C_ENABLE)) {
4520 status = hub_port_debounce_be_stable(hub, port1);
4522 if (status != -ENODEV && printk_ratelimit())
4523 dev_err(hub_dev, "connect-debounce failed, "
4524 "port %d disabled\n", port1);
4525 portstatus &= ~USB_PORT_STAT_CONNECTION;
4527 portstatus = status;
4531 /* Return now if debouncing failed or nothing is connected or
4532 * the device was "removed".
4534 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4535 test_bit(port1, hub->removed_bits)) {
4537 /* maybe switch power back on (e.g. root hub was reset) */
4538 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
4539 && !port_is_power_on(hub, portstatus))
4540 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
4542 if (portstatus & USB_PORT_STAT_ENABLE)
4546 if (hub_is_superspeed(hub->hdev))
4552 for (i = 0; i < SET_CONFIG_TRIES; i++) {
4554 /* reallocate for each attempt, since references
4555 * to the previous one can escape in various ways
4557 udev = usb_alloc_dev(hdev, hdev->bus, port1);
4560 "couldn't allocate port %d usb_device\n",
4565 usb_set_device_state(udev, USB_STATE_POWERED);
4566 udev->bus_mA = hub->mA_per_port;
4567 udev->level = hdev->level + 1;
4568 udev->wusb = hub_is_wusb(hub);
4570 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
4571 if (hub_is_superspeed(hub->hdev))
4572 udev->speed = USB_SPEED_SUPER;
4574 udev->speed = USB_SPEED_UNKNOWN;
4576 choose_devnum(udev);
4577 if (udev->devnum <= 0) {
4578 status = -ENOTCONN; /* Don't retry */
4582 /* reset (non-USB 3.0 devices) and get descriptor */
4583 status = hub_port_init(hub, udev, port1, i);
4587 usb_detect_quirks(udev);
4588 if (udev->quirks & USB_QUIRK_DELAY_INIT)
4591 /* consecutive bus-powered hubs aren't reliable; they can
4592 * violate the voltage drop budget. if the new child has
4593 * a "powered" LED, users should notice we didn't enable it
4594 * (without reading syslog), even without per-port LEDs
4597 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
4598 && udev->bus_mA <= unit_load) {
4601 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
4604 dev_dbg(&udev->dev, "get status %d ?\n", status);
4607 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
4609 "can't connect bus-powered hub "
4611 if (hub->has_indicators) {
4612 hub->indicator[port1-1] =
4613 INDICATOR_AMBER_BLINK;
4614 schedule_delayed_work (&hub->leds, 0);
4616 status = -ENOTCONN; /* Don't retry */
4621 /* check for devices running slower than they could */
4622 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
4623 && udev->speed == USB_SPEED_FULL
4624 && highspeed_hubs != 0)
4625 check_highspeed (hub, udev, port1);
4627 /* Store the parent's children[] pointer. At this point
4628 * udev becomes globally accessible, although presumably
4629 * no one will look at it until hdev is unlocked.
4633 /* We mustn't add new devices if the parent hub has
4634 * been disconnected; we would race with the
4635 * recursively_mark_NOTATTACHED() routine.
4637 spin_lock_irq(&device_state_lock);
4638 if (hdev->state == USB_STATE_NOTATTACHED)
4641 hub->ports[port1 - 1]->child = udev;
4642 spin_unlock_irq(&device_state_lock);
4644 /* Run it through the hoops (find a driver, etc) */
4646 status = usb_new_device(udev);
4648 spin_lock_irq(&device_state_lock);
4649 hub->ports[port1 - 1]->child = NULL;
4650 spin_unlock_irq(&device_state_lock);
4657 status = hub_power_remaining(hub);
4659 dev_dbg(hub_dev, "%dmA power budget left\n", status);
4664 hub_port_disable(hub, port1, 1);
4666 usb_ep0_reinit(udev);
4667 release_devnum(udev);
4670 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
4673 if (hub->hdev->parent ||
4674 !hcd->driver->port_handed_over ||
4675 !(hcd->driver->port_handed_over)(hcd, port1)) {
4676 if (status != -ENOTCONN && status != -ENODEV)
4677 dev_err(hub_dev, "unable to enumerate USB device on port %d\n",
4682 hub_port_disable(hub, port1, 1);
4683 if (hcd->driver->relinquish_port && !hub->hdev->parent)
4684 hcd->driver->relinquish_port(hcd, port1);
4687 /* Returns 1 if there was a remote wakeup and a connect status change. */
4688 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
4689 u16 portstatus, u16 portchange)
4691 struct usb_device *hdev;
4692 struct usb_device *udev;
4693 int connect_change = 0;
4697 udev = hub->ports[port - 1]->child;
4698 if (!hub_is_superspeed(hdev)) {
4699 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
4701 usb_clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
4703 if (!udev || udev->state != USB_STATE_SUSPENDED ||
4704 (portstatus & USB_PORT_STAT_LINK_STATE) !=
4710 /* TRSMRCY = 10 msec */
4713 usb_lock_device(udev);
4714 ret = usb_remote_wakeup(udev);
4715 usb_unlock_device(udev);
4720 hub_port_disable(hub, port, 1);
4722 dev_dbg(hub->intfdev, "resume on port %d, status %d\n",
4724 return connect_change;
4727 static void hub_events(void)
4729 struct list_head *tmp;
4730 struct usb_device *hdev;
4731 struct usb_interface *intf;
4732 struct usb_hub *hub;
4733 struct device *hub_dev;
4739 int connect_change, wakeup_change;
4742 * We restart the list every time to avoid a deadlock with
4743 * deleting hubs downstream from this one. This should be
4744 * safe since we delete the hub from the event list.
4745 * Not the most efficient, but avoids deadlocks.
4749 /* Grab the first entry at the beginning of the list */
4750 spin_lock_irq(&hub_event_lock);
4751 if (list_empty(&hub_event_list)) {
4752 spin_unlock_irq(&hub_event_lock);
4756 tmp = hub_event_list.next;
4759 hub = list_entry(tmp, struct usb_hub, event_list);
4760 kref_get(&hub->kref);
4761 spin_unlock_irq(&hub_event_lock);
4764 hub_dev = hub->intfdev;
4765 intf = to_usb_interface(hub_dev);
4766 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
4767 hdev->state, hdev->maxchild,
4768 /* NOTE: expects max 15 ports... */
4769 (u16) hub->change_bits[0],
4770 (u16) hub->event_bits[0]);
4772 /* Lock the device, then check to see if we were
4773 * disconnected while waiting for the lock to succeed. */
4774 usb_lock_device(hdev);
4775 if (unlikely(hub->disconnected))
4776 goto loop_disconnected;
4778 /* If the hub has died, clean up after it */
4779 if (hdev->state == USB_STATE_NOTATTACHED) {
4780 hub->error = -ENODEV;
4781 hub_quiesce(hub, HUB_DISCONNECT);
4786 ret = usb_autopm_get_interface(intf);
4788 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
4792 /* If this is an inactive hub, do nothing */
4797 dev_dbg (hub_dev, "resetting for error %d\n",
4800 ret = usb_reset_device(hdev);
4803 "error resetting hub: %d\n", ret);
4811 /* deal with port status changes */
4812 for (i = 1; i <= hdev->maxchild; i++) {
4813 if (test_bit(i, hub->busy_bits))
4815 connect_change = test_bit(i, hub->change_bits);
4816 wakeup_change = test_and_clear_bit(i, hub->wakeup_bits);
4817 if (!test_and_clear_bit(i, hub->event_bits) &&
4818 !connect_change && !wakeup_change)
4821 ret = hub_port_status(hub, i,
4822 &portstatus, &portchange);
4826 if (portchange & USB_PORT_STAT_C_CONNECTION) {
4827 usb_clear_port_feature(hdev, i,
4828 USB_PORT_FEAT_C_CONNECTION);
4832 if (portchange & USB_PORT_STAT_C_ENABLE) {
4833 if (!connect_change)
4835 "port %d enable change, "
4838 usb_clear_port_feature(hdev, i,
4839 USB_PORT_FEAT_C_ENABLE);
4842 * EM interference sometimes causes badly
4843 * shielded USB devices to be shutdown by
4844 * the hub, this hack enables them again.
4845 * Works at least with mouse driver.
4847 if (!(portstatus & USB_PORT_STAT_ENABLE)
4849 && hub->ports[i - 1]->child) {
4852 "disabled by hub (EMI?), "
4859 if (hub_handle_remote_wakeup(hub, i,
4860 portstatus, portchange))
4863 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
4867 dev_dbg(hub_dev, "over-current change on port "
4869 usb_clear_port_feature(hdev, i,
4870 USB_PORT_FEAT_C_OVER_CURRENT);
4871 msleep(100); /* Cool down */
4872 hub_power_on(hub, true);
4873 hub_port_status(hub, i, &status, &unused);
4874 if (status & USB_PORT_STAT_OVERCURRENT)
4875 dev_err(hub_dev, "over-current "
4876 "condition on port %d\n", i);
4879 if (portchange & USB_PORT_STAT_C_RESET) {
4881 "reset change on port %d\n",
4883 usb_clear_port_feature(hdev, i,
4884 USB_PORT_FEAT_C_RESET);
4886 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
4887 hub_is_superspeed(hub->hdev)) {
4889 "warm reset change on port %d\n",
4891 usb_clear_port_feature(hdev, i,
4892 USB_PORT_FEAT_C_BH_PORT_RESET);
4894 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
4895 usb_clear_port_feature(hub->hdev, i,
4896 USB_PORT_FEAT_C_PORT_LINK_STATE);
4898 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
4900 "config error on port %d\n",
4902 usb_clear_port_feature(hub->hdev, i,
4903 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
4906 /* Warm reset a USB3 protocol port if it's in
4907 * SS.Inactive state.
4909 if (hub_port_warm_reset_required(hub, portstatus)) {
4911 struct usb_device *udev =
4912 hub->ports[i - 1]->child;
4914 dev_dbg(hub_dev, "warm reset port %d\n", i);
4916 !(portstatus & USB_PORT_STAT_CONNECTION) ||
4917 udev->state == USB_STATE_NOTATTACHED) {
4918 status = hub_port_reset(hub, i,
4919 NULL, HUB_BH_RESET_TIME,
4922 hub_port_disable(hub, i, 1);
4924 usb_lock_device(udev);
4925 status = usb_reset_device(udev);
4926 usb_unlock_device(udev);
4932 hub_port_connect_change(hub, i,
4933 portstatus, portchange);
4936 /* deal with hub status changes */
4937 if (test_and_clear_bit(0, hub->event_bits) == 0)
4939 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
4940 dev_err (hub_dev, "get_hub_status failed\n");
4942 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
4943 dev_dbg (hub_dev, "power change\n");
4944 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
4945 if (hubstatus & HUB_STATUS_LOCAL_POWER)
4946 /* FIXME: Is this always true? */
4947 hub->limited_power = 1;
4949 hub->limited_power = 0;
4951 if (hubchange & HUB_CHANGE_OVERCURRENT) {
4955 dev_dbg(hub_dev, "over-current change\n");
4956 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
4957 msleep(500); /* Cool down */
4958 hub_power_on(hub, true);
4959 hub_hub_status(hub, &status, &unused);
4960 if (status & HUB_STATUS_OVERCURRENT)
4961 dev_err(hub_dev, "over-current "
4967 /* Balance the usb_autopm_get_interface() above */
4968 usb_autopm_put_interface_no_suspend(intf);
4970 /* Balance the usb_autopm_get_interface_no_resume() in
4971 * kick_khubd() and allow autosuspend.
4973 usb_autopm_put_interface(intf);
4975 usb_unlock_device(hdev);
4976 kref_put(&hub->kref, hub_release);
4978 } /* end while (1) */
4981 static int hub_thread(void *__unused)
4983 /* khubd needs to be freezable to avoid interfering with USB-PERSIST
4984 * port handover. Otherwise it might see that a full-speed device
4985 * was gone before the EHCI controller had handed its port over to
4986 * the companion full-speed controller.
4992 wait_event_freezable(khubd_wait,
4993 !list_empty(&hub_event_list) ||
4994 kthread_should_stop());
4995 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
4997 pr_debug("%s: khubd exiting\n", usbcore_name);
5001 static const struct usb_device_id hub_id_table[] = {
5002 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5003 | USB_DEVICE_ID_MATCH_INT_CLASS,
5004 .idVendor = USB_VENDOR_GENESYS_LOGIC,
5005 .bInterfaceClass = USB_CLASS_HUB,
5006 .driver_info = HUB_QUIRK_CHECK_PORT_AUTOSUSPEND},
5007 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
5008 .bDeviceClass = USB_CLASS_HUB},
5009 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
5010 .bInterfaceClass = USB_CLASS_HUB},
5011 { } /* Terminating entry */
5014 MODULE_DEVICE_TABLE (usb, hub_id_table);
5016 static struct usb_driver hub_driver = {
5019 .disconnect = hub_disconnect,
5020 .suspend = hub_suspend,
5021 .resume = hub_resume,
5022 .reset_resume = hub_reset_resume,
5023 .pre_reset = hub_pre_reset,
5024 .post_reset = hub_post_reset,
5025 .unlocked_ioctl = hub_ioctl,
5026 .id_table = hub_id_table,
5027 .supports_autosuspend = 1,
5030 int usb_hub_init(void)
5032 if (usb_register(&hub_driver) < 0) {
5033 printk(KERN_ERR "%s: can't register hub driver\n",
5038 khubd_task = kthread_run(hub_thread, NULL, "khubd");
5039 if (!IS_ERR(khubd_task))
5042 /* Fall through if kernel_thread failed */
5043 usb_deregister(&hub_driver);
5044 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
5049 void usb_hub_cleanup(void)
5051 kthread_stop(khubd_task);
5054 * Hub resources are freed for us by usb_deregister. It calls
5055 * usb_driver_purge on every device which in turn calls that
5056 * devices disconnect function if it is using this driver.
5057 * The hub_disconnect function takes care of releasing the
5058 * individual hub resources. -greg
5060 usb_deregister(&hub_driver);
5061 } /* usb_hub_cleanup() */
5063 static int descriptors_changed(struct usb_device *udev,
5064 struct usb_device_descriptor *old_device_descriptor,
5065 struct usb_host_bos *old_bos)
5069 unsigned serial_len = 0;
5071 unsigned old_length;
5075 if (memcmp(&udev->descriptor, old_device_descriptor,
5076 sizeof(*old_device_descriptor)) != 0)
5079 if ((old_bos && !udev->bos) || (!old_bos && udev->bos))
5082 len = le16_to_cpu(udev->bos->desc->wTotalLength);
5083 if (len != le16_to_cpu(old_bos->desc->wTotalLength))
5085 if (memcmp(udev->bos->desc, old_bos->desc, len))
5089 /* Since the idVendor, idProduct, and bcdDevice values in the
5090 * device descriptor haven't changed, we will assume the
5091 * Manufacturer and Product strings haven't changed either.
5092 * But the SerialNumber string could be different (e.g., a
5093 * different flash card of the same brand).
5096 serial_len = strlen(udev->serial) + 1;
5099 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5100 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5101 len = max(len, old_length);
5104 buf = kmalloc(len, GFP_NOIO);
5106 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
5107 /* assume the worst */
5110 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5111 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5112 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
5114 if (length != old_length) {
5115 dev_dbg(&udev->dev, "config index %d, error %d\n",
5120 if (memcmp (buf, udev->rawdescriptors[index], old_length)
5122 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
5124 ((struct usb_config_descriptor *) buf)->
5125 bConfigurationValue);
5131 if (!changed && serial_len) {
5132 length = usb_string(udev, udev->descriptor.iSerialNumber,
5134 if (length + 1 != serial_len) {
5135 dev_dbg(&udev->dev, "serial string error %d\n",
5138 } else if (memcmp(buf, udev->serial, length) != 0) {
5139 dev_dbg(&udev->dev, "serial string changed\n");
5149 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5150 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5152 * WARNING - don't use this routine to reset a composite device
5153 * (one with multiple interfaces owned by separate drivers)!
5154 * Use usb_reset_device() instead.
5156 * Do a port reset, reassign the device's address, and establish its
5157 * former operating configuration. If the reset fails, or the device's
5158 * descriptors change from their values before the reset, or the original
5159 * configuration and altsettings cannot be restored, a flag will be set
5160 * telling khubd to pretend the device has been disconnected and then
5161 * re-connected. All drivers will be unbound, and the device will be
5162 * re-enumerated and probed all over again.
5164 * Return: 0 if the reset succeeded, -ENODEV if the device has been
5165 * flagged for logical disconnection, or some other negative error code
5166 * if the reset wasn't even attempted.
5169 * The caller must own the device lock. For example, it's safe to use
5170 * this from a driver probe() routine after downloading new firmware.
5171 * For calls that might not occur during probe(), drivers should lock
5172 * the device using usb_lock_device_for_reset().
5174 * Locking exception: This routine may also be called from within an
5175 * autoresume handler. Such usage won't conflict with other tasks
5176 * holding the device lock because these tasks should always call
5177 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
5179 static int usb_reset_and_verify_device(struct usb_device *udev)
5181 struct usb_device *parent_hdev = udev->parent;
5182 struct usb_hub *parent_hub;
5183 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
5184 struct usb_device_descriptor descriptor = udev->descriptor;
5185 struct usb_host_bos *bos;
5187 int port1 = udev->portnum;
5189 if (udev->state == USB_STATE_NOTATTACHED ||
5190 udev->state == USB_STATE_SUSPENDED) {
5191 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5197 /* this requires hcd-specific logic; see ohci_restart() */
5198 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
5201 parent_hub = usb_hub_to_struct_hub(parent_hdev);
5203 /* Disable USB2 hardware LPM.
5204 * It will be re-enabled by the enumeration process.
5206 if (udev->usb2_hw_lpm_enabled == 1)
5207 usb_set_usb2_hardware_lpm(udev, 0);
5212 /* Disable LPM and LTM while we reset the device and reinstall the alt
5213 * settings. Device-initiated LPM settings, and system exit latency
5214 * settings are cleared when the device is reset, so we have to set
5217 ret = usb_unlocked_disable_lpm(udev);
5219 dev_err(&udev->dev, "%s Failed to disable LPM\n.", __func__);
5222 ret = usb_disable_ltm(udev);
5224 dev_err(&udev->dev, "%s Failed to disable LTM\n.",
5229 set_bit(port1, parent_hub->busy_bits);
5230 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
5232 /* ep0 maxpacket size may change; let the HCD know about it.
5233 * Other endpoints will be handled by re-enumeration. */
5234 usb_ep0_reinit(udev);
5235 ret = hub_port_init(parent_hub, udev, port1, i);
5236 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
5239 clear_bit(port1, parent_hub->busy_bits);
5244 /* Device might have changed firmware (DFU or similar) */
5245 if (descriptors_changed(udev, &descriptor, bos)) {
5246 dev_info(&udev->dev, "device firmware changed\n");
5247 udev->descriptor = descriptor; /* for disconnect() calls */
5251 /* Restore the device's previous configuration */
5252 if (!udev->actconfig)
5255 mutex_lock(hcd->bandwidth_mutex);
5256 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
5258 dev_warn(&udev->dev,
5259 "Busted HC? Not enough HCD resources for "
5260 "old configuration.\n");
5261 mutex_unlock(hcd->bandwidth_mutex);
5264 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
5265 USB_REQ_SET_CONFIGURATION, 0,
5266 udev->actconfig->desc.bConfigurationValue, 0,
5267 NULL, 0, USB_CTRL_SET_TIMEOUT);
5270 "can't restore configuration #%d (error=%d)\n",
5271 udev->actconfig->desc.bConfigurationValue, ret);
5272 mutex_unlock(hcd->bandwidth_mutex);
5275 mutex_unlock(hcd->bandwidth_mutex);
5276 usb_set_device_state(udev, USB_STATE_CONFIGURED);
5278 /* Put interfaces back into the same altsettings as before.
5279 * Don't bother to send the Set-Interface request for interfaces
5280 * that were already in altsetting 0; besides being unnecessary,
5281 * many devices can't handle it. Instead just reset the host-side
5284 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
5285 struct usb_host_config *config = udev->actconfig;
5286 struct usb_interface *intf = config->interface[i];
5287 struct usb_interface_descriptor *desc;
5289 desc = &intf->cur_altsetting->desc;
5290 if (desc->bAlternateSetting == 0) {
5291 usb_disable_interface(udev, intf, true);
5292 usb_enable_interface(udev, intf, true);
5295 /* Let the bandwidth allocation function know that this
5296 * device has been reset, and it will have to use
5297 * alternate setting 0 as the current alternate setting.
5299 intf->resetting_device = 1;
5300 ret = usb_set_interface(udev, desc->bInterfaceNumber,
5301 desc->bAlternateSetting);
5302 intf->resetting_device = 0;
5305 dev_err(&udev->dev, "failed to restore interface %d "
5306 "altsetting %d (error=%d)\n",
5307 desc->bInterfaceNumber,
5308 desc->bAlternateSetting,
5315 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5316 usb_set_usb2_hardware_lpm(udev, 1);
5317 usb_unlocked_enable_lpm(udev);
5318 usb_enable_ltm(udev);
5319 usb_release_bos_descriptor(udev);
5324 /* LPM state doesn't matter when we're about to destroy the device. */
5325 hub_port_logical_disconnect(parent_hub, port1);
5326 usb_release_bos_descriptor(udev);
5332 * usb_reset_device - warn interface drivers and perform a USB port reset
5333 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5335 * Warns all drivers bound to registered interfaces (using their pre_reset
5336 * method), performs the port reset, and then lets the drivers know that
5337 * the reset is over (using their post_reset method).
5339 * Return: The same as for usb_reset_and_verify_device().
5342 * The caller must own the device lock. For example, it's safe to use
5343 * this from a driver probe() routine after downloading new firmware.
5344 * For calls that might not occur during probe(), drivers should lock
5345 * the device using usb_lock_device_for_reset().
5347 * If an interface is currently being probed or disconnected, we assume
5348 * its driver knows how to handle resets. For all other interfaces,
5349 * if the driver doesn't have pre_reset and post_reset methods then
5350 * we attempt to unbind it and rebind afterward.
5352 int usb_reset_device(struct usb_device *udev)
5356 unsigned int noio_flag;
5357 struct usb_host_config *config = udev->actconfig;
5359 if (udev->state == USB_STATE_NOTATTACHED ||
5360 udev->state == USB_STATE_SUSPENDED) {
5361 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5367 * Don't allocate memory with GFP_KERNEL in current
5368 * context to avoid possible deadlock if usb mass
5369 * storage interface or usbnet interface(iSCSI case)
5370 * is included in current configuration. The easist
5371 * approach is to do it for every device reset,
5372 * because the device 'memalloc_noio' flag may have
5373 * not been set before reseting the usb device.
5375 noio_flag = memalloc_noio_save();
5377 /* Prevent autosuspend during the reset */
5378 usb_autoresume_device(udev);
5381 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
5382 struct usb_interface *cintf = config->interface[i];
5383 struct usb_driver *drv;
5386 if (cintf->dev.driver) {
5387 drv = to_usb_driver(cintf->dev.driver);
5388 if (drv->pre_reset && drv->post_reset)
5389 unbind = (drv->pre_reset)(cintf);
5390 else if (cintf->condition ==
5391 USB_INTERFACE_BOUND)
5394 usb_forced_unbind_intf(cintf);
5399 ret = usb_reset_and_verify_device(udev);
5402 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
5403 struct usb_interface *cintf = config->interface[i];
5404 struct usb_driver *drv;
5405 int rebind = cintf->needs_binding;
5407 if (!rebind && cintf->dev.driver) {
5408 drv = to_usb_driver(cintf->dev.driver);
5409 if (drv->post_reset)
5410 rebind = (drv->post_reset)(cintf);
5411 else if (cintf->condition ==
5412 USB_INTERFACE_BOUND)
5415 cintf->needs_binding = 1;
5418 usb_unbind_and_rebind_marked_interfaces(udev);
5421 usb_autosuspend_device(udev);
5422 memalloc_noio_restore(noio_flag);
5425 EXPORT_SYMBOL_GPL(usb_reset_device);
5429 * usb_queue_reset_device - Reset a USB device from an atomic context
5430 * @iface: USB interface belonging to the device to reset
5432 * This function can be used to reset a USB device from an atomic
5433 * context, where usb_reset_device() won't work (as it blocks).
5435 * Doing a reset via this method is functionally equivalent to calling
5436 * usb_reset_device(), except for the fact that it is delayed to a
5437 * workqueue. This means that any drivers bound to other interfaces
5438 * might be unbound, as well as users from usbfs in user space.
5442 * - Scheduling two resets at the same time from two different drivers
5443 * attached to two different interfaces of the same device is
5444 * possible; depending on how the driver attached to each interface
5445 * handles ->pre_reset(), the second reset might happen or not.
5447 * - If a driver is unbound and it had a pending reset, the reset will
5450 * - This function can be called during .probe() or .disconnect()
5451 * times. On return from .disconnect(), any pending resets will be
5454 * There is no no need to lock/unlock the @reset_ws as schedule_work()
5457 * NOTE: We don't do any reference count tracking because it is not
5458 * needed. The lifecycle of the work_struct is tied to the
5459 * usb_interface. Before destroying the interface we cancel the
5460 * work_struct, so the fact that work_struct is queued and or
5461 * running means the interface (and thus, the device) exist and
5464 void usb_queue_reset_device(struct usb_interface *iface)
5466 schedule_work(&iface->reset_ws);
5468 EXPORT_SYMBOL_GPL(usb_queue_reset_device);
5471 * usb_hub_find_child - Get the pointer of child device
5472 * attached to the port which is specified by @port1.
5473 * @hdev: USB device belonging to the usb hub
5474 * @port1: port num to indicate which port the child device
5477 * USB drivers call this function to get hub's child device
5480 * Return: %NULL if input param is invalid and
5481 * child's usb_device pointer if non-NULL.
5483 struct usb_device *usb_hub_find_child(struct usb_device *hdev,
5486 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5488 if (port1 < 1 || port1 > hdev->maxchild)
5490 return hub->ports[port1 - 1]->child;
5492 EXPORT_SYMBOL_GPL(usb_hub_find_child);
5495 * usb_set_hub_port_connect_type - set hub port connect type.
5496 * @hdev: USB device belonging to the usb hub
5497 * @port1: port num of the port
5498 * @type: connect type of the port
5500 void usb_set_hub_port_connect_type(struct usb_device *hdev, int port1,
5501 enum usb_port_connect_type type)
5503 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5506 hub->ports[port1 - 1]->connect_type = type;
5510 * usb_get_hub_port_connect_type - Get the port's connect type
5511 * @hdev: USB device belonging to the usb hub
5512 * @port1: port num of the port
5514 * Return: The connect type of the port if successful. Or
5515 * USB_PORT_CONNECT_TYPE_UNKNOWN if input params are invalid.
5517 enum usb_port_connect_type
5518 usb_get_hub_port_connect_type(struct usb_device *hdev, int port1)
5520 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5523 return USB_PORT_CONNECT_TYPE_UNKNOWN;
5525 return hub->ports[port1 - 1]->connect_type;
5528 void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
5529 struct usb_hub_descriptor *desc)
5531 enum usb_port_connect_type connect_type;
5534 if (!hub_is_superspeed(hdev)) {
5535 for (i = 1; i <= hdev->maxchild; i++) {
5536 connect_type = usb_get_hub_port_connect_type(hdev, i);
5538 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5539 u8 mask = 1 << (i%8);
5541 if (!(desc->u.hs.DeviceRemovable[i/8] & mask)) {
5542 dev_dbg(&hdev->dev, "usb port%d's DeviceRemovable is changed to 1 according to platform information.\n",
5544 desc->u.hs.DeviceRemovable[i/8] |= mask;
5549 u16 port_removable = le16_to_cpu(desc->u.ss.DeviceRemovable);
5551 for (i = 1; i <= hdev->maxchild; i++) {
5552 connect_type = usb_get_hub_port_connect_type(hdev, i);
5554 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5557 if (!(port_removable & mask)) {
5558 dev_dbg(&hdev->dev, "usb port%d's DeviceRemovable is changed to 1 according to platform information.\n",
5560 port_removable |= mask;
5565 desc->u.ss.DeviceRemovable = cpu_to_le16(port_removable);
5571 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5572 * @hdev: USB device belonging to the usb hub
5573 * @port1: port num of the port
5575 * Return: Port's acpi handle if successful, %NULL if params are
5578 acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
5581 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5586 return ACPI_HANDLE(&hub->ports[port1 - 1]->dev);