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 /* Protect struct usb_device->state and ->children members
40 * Note: Both are also protected by ->dev.sem, except that ->state can
41 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
42 static DEFINE_SPINLOCK(device_state_lock);
44 /* khubd's worklist and its lock */
45 static DEFINE_SPINLOCK(hub_event_lock);
46 static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
49 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
51 static struct task_struct *khubd_task;
53 /* synchronize hub-port add/remove and peering operations */
54 DEFINE_MUTEX(usb_port_peer_mutex);
56 /* cycle leds on hubs that aren't blinking for attention */
57 static bool blinkenlights = 0;
58 module_param (blinkenlights, bool, S_IRUGO);
59 MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
62 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
63 * 10 seconds to send reply for the initial 64-byte descriptor request.
65 /* define initial 64-byte descriptor request timeout in milliseconds */
66 static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
67 module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
68 MODULE_PARM_DESC(initial_descriptor_timeout,
69 "initial 64-byte descriptor request timeout in milliseconds "
70 "(default 5000 - 5.0 seconds)");
73 * As of 2.6.10 we introduce a new USB device initialization scheme which
74 * closely resembles the way Windows works. Hopefully it will be compatible
75 * with a wider range of devices than the old scheme. However some previously
76 * working devices may start giving rise to "device not accepting address"
77 * errors; if that happens the user can try the old scheme by adjusting the
78 * following module parameters.
80 * For maximum flexibility there are two boolean parameters to control the
81 * hub driver's behavior. On the first initialization attempt, if the
82 * "old_scheme_first" parameter is set then the old scheme will be used,
83 * otherwise the new scheme is used. If that fails and "use_both_schemes"
84 * is set, then the driver will make another attempt, using the other scheme.
86 static bool old_scheme_first = 0;
87 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
88 MODULE_PARM_DESC(old_scheme_first,
89 "start with the old device initialization scheme");
91 static bool use_both_schemes = 1;
92 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
93 MODULE_PARM_DESC(use_both_schemes,
94 "try the other device initialization scheme if the "
97 /* Mutual exclusion for EHCI CF initialization. This interferes with
98 * port reset on some companion controllers.
100 DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
101 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
103 #define HUB_DEBOUNCE_TIMEOUT 2000
104 #define HUB_DEBOUNCE_STEP 25
105 #define HUB_DEBOUNCE_STABLE 100
107 static int usb_reset_and_verify_device(struct usb_device *udev);
109 static inline char *portspeed(struct usb_hub *hub, int portstatus)
111 if (hub_is_superspeed(hub->hdev))
113 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
115 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
121 /* Note that hdev or one of its children must be locked! */
122 struct usb_hub *usb_hub_to_struct_hub(struct usb_device *hdev)
124 if (!hdev || !hdev->actconfig || !hdev->maxchild)
126 return usb_get_intfdata(hdev->actconfig->interface[0]);
129 static int usb_device_supports_lpm(struct usb_device *udev)
131 /* USB 2.1 (and greater) devices indicate LPM support through
132 * their USB 2.0 Extended Capabilities BOS descriptor.
134 if (udev->speed == USB_SPEED_HIGH) {
135 if (udev->bos->ext_cap &&
137 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
143 * According to the USB 3.0 spec, all USB 3.0 devices must support LPM.
144 * However, there are some that don't, and they set the U1/U2 exit
147 if (!udev->bos->ss_cap) {
148 dev_info(&udev->dev, "No LPM exit latency info found, disabling LPM.\n");
152 if (udev->bos->ss_cap->bU1devExitLat == 0 &&
153 udev->bos->ss_cap->bU2DevExitLat == 0) {
155 dev_info(&udev->dev, "LPM exit latency is zeroed, disabling LPM.\n");
157 dev_info(&udev->dev, "We don't know the algorithms for LPM for this host, disabling LPM.\n");
161 if (!udev->parent || udev->parent->lpm_capable)
167 * Set the Maximum Exit Latency (MEL) for the host to initiate a transition from
170 static void usb_set_lpm_mel(struct usb_device *udev,
171 struct usb3_lpm_parameters *udev_lpm_params,
172 unsigned int udev_exit_latency,
174 struct usb3_lpm_parameters *hub_lpm_params,
175 unsigned int hub_exit_latency)
177 unsigned int total_mel;
178 unsigned int device_mel;
179 unsigned int hub_mel;
182 * Calculate the time it takes to transition all links from the roothub
183 * to the parent hub into U0. The parent hub must then decode the
184 * packet (hub header decode latency) to figure out which port it was
187 * The Hub Header decode latency is expressed in 0.1us intervals (0x1
188 * means 0.1us). Multiply that by 100 to get nanoseconds.
190 total_mel = hub_lpm_params->mel +
191 (hub->descriptor->u.ss.bHubHdrDecLat * 100);
194 * How long will it take to transition the downstream hub's port into
195 * U0? The greater of either the hub exit latency or the device exit
198 * The BOS U1/U2 exit latencies are expressed in 1us intervals.
199 * Multiply that by 1000 to get nanoseconds.
201 device_mel = udev_exit_latency * 1000;
202 hub_mel = hub_exit_latency * 1000;
203 if (device_mel > hub_mel)
204 total_mel += device_mel;
206 total_mel += hub_mel;
208 udev_lpm_params->mel = total_mel;
212 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
213 * a transition from either U1 or U2.
215 static void usb_set_lpm_pel(struct usb_device *udev,
216 struct usb3_lpm_parameters *udev_lpm_params,
217 unsigned int udev_exit_latency,
219 struct usb3_lpm_parameters *hub_lpm_params,
220 unsigned int hub_exit_latency,
221 unsigned int port_to_port_exit_latency)
223 unsigned int first_link_pel;
224 unsigned int hub_pel;
227 * First, the device sends an LFPS to transition the link between the
228 * device and the parent hub into U0. The exit latency is the bigger of
229 * the device exit latency or the hub exit latency.
231 if (udev_exit_latency > hub_exit_latency)
232 first_link_pel = udev_exit_latency * 1000;
234 first_link_pel = hub_exit_latency * 1000;
237 * When the hub starts to receive the LFPS, there is a slight delay for
238 * it to figure out that one of the ports is sending an LFPS. Then it
239 * will forward the LFPS to its upstream link. The exit latency is the
240 * delay, plus the PEL that we calculated for this hub.
242 hub_pel = port_to_port_exit_latency * 1000 + hub_lpm_params->pel;
245 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
246 * is the greater of the two exit latencies.
248 if (first_link_pel > hub_pel)
249 udev_lpm_params->pel = first_link_pel;
251 udev_lpm_params->pel = hub_pel;
255 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
256 * when a device initiates a transition to U0, until when it will receive the
257 * first packet from the host controller.
259 * Section C.1.5.1 describes the four components to this:
261 * - t2: time for the ERDY to make it from the device to the host.
262 * - t3: a host-specific delay to process the ERDY.
263 * - t4: time for the packet to make it from the host to the device.
265 * t3 is specific to both the xHCI host and the platform the host is integrated
266 * into. The Intel HW folks have said it's negligible, FIXME if a different
267 * vendor says otherwise.
269 static void usb_set_lpm_sel(struct usb_device *udev,
270 struct usb3_lpm_parameters *udev_lpm_params)
272 struct usb_device *parent;
273 unsigned int num_hubs;
274 unsigned int total_sel;
276 /* t1 = device PEL */
277 total_sel = udev_lpm_params->pel;
278 /* How many external hubs are in between the device & the root port. */
279 for (parent = udev->parent, num_hubs = 0; parent->parent;
280 parent = parent->parent)
282 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
284 total_sel += 2100 + 250 * (num_hubs - 1);
286 /* t4 = 250ns * num_hubs */
287 total_sel += 250 * num_hubs;
289 udev_lpm_params->sel = total_sel;
292 static void usb_set_lpm_parameters(struct usb_device *udev)
295 unsigned int port_to_port_delay;
296 unsigned int udev_u1_del;
297 unsigned int udev_u2_del;
298 unsigned int hub_u1_del;
299 unsigned int hub_u2_del;
301 if (!udev->lpm_capable || udev->speed != USB_SPEED_SUPER)
304 hub = usb_hub_to_struct_hub(udev->parent);
305 /* It doesn't take time to transition the roothub into U0, since it
306 * doesn't have an upstream link.
311 udev_u1_del = udev->bos->ss_cap->bU1devExitLat;
312 udev_u2_del = le16_to_cpu(udev->bos->ss_cap->bU2DevExitLat);
313 hub_u1_del = udev->parent->bos->ss_cap->bU1devExitLat;
314 hub_u2_del = le16_to_cpu(udev->parent->bos->ss_cap->bU2DevExitLat);
316 usb_set_lpm_mel(udev, &udev->u1_params, udev_u1_del,
317 hub, &udev->parent->u1_params, hub_u1_del);
319 usb_set_lpm_mel(udev, &udev->u2_params, udev_u2_del,
320 hub, &udev->parent->u2_params, hub_u2_del);
323 * Appendix C, section C.2.2.2, says that there is a slight delay from
324 * when the parent hub notices the downstream port is trying to
325 * transition to U0 to when the hub initiates a U0 transition on its
326 * upstream port. The section says the delays are tPort2PortU1EL and
327 * tPort2PortU2EL, but it doesn't define what they are.
329 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
330 * about the same delays. Use the maximum delay calculations from those
331 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
332 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
333 * assume the device exit latencies they are talking about are the hub
336 * What do we do if the U2 exit latency is less than the U1 exit
337 * latency? It's possible, although not likely...
339 port_to_port_delay = 1;
341 usb_set_lpm_pel(udev, &udev->u1_params, udev_u1_del,
342 hub, &udev->parent->u1_params, hub_u1_del,
345 if (hub_u2_del > hub_u1_del)
346 port_to_port_delay = 1 + hub_u2_del - hub_u1_del;
348 port_to_port_delay = 1 + hub_u1_del;
350 usb_set_lpm_pel(udev, &udev->u2_params, udev_u2_del,
351 hub, &udev->parent->u2_params, hub_u2_del,
354 /* Now that we've got PEL, calculate SEL. */
355 usb_set_lpm_sel(udev, &udev->u1_params);
356 usb_set_lpm_sel(udev, &udev->u2_params);
359 /* USB 2.0 spec Section 11.24.4.5 */
360 static int get_hub_descriptor(struct usb_device *hdev, void *data)
365 if (hub_is_superspeed(hdev)) {
366 dtype = USB_DT_SS_HUB;
367 size = USB_DT_SS_HUB_SIZE;
370 size = sizeof(struct usb_hub_descriptor);
373 for (i = 0; i < 3; i++) {
374 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
375 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
376 dtype << 8, 0, data, size,
377 USB_CTRL_GET_TIMEOUT);
378 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
385 * USB 2.0 spec Section 11.24.2.1
387 static int clear_hub_feature(struct usb_device *hdev, int feature)
389 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
390 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
394 * USB 2.0 spec Section 11.24.2.2
396 int usb_clear_port_feature(struct usb_device *hdev, int port1, int feature)
398 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
399 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
404 * USB 2.0 spec Section 11.24.2.13
406 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
408 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
409 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
413 static char *to_led_name(int selector)
430 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
431 * for info about using port indicators
433 static void set_port_led(struct usb_hub *hub, int port1, int selector)
435 struct usb_port *port_dev = hub->ports[port1 - 1];
438 status = set_port_feature(hub->hdev, (selector << 8) | port1,
439 USB_PORT_FEAT_INDICATOR);
440 dev_dbg(&port_dev->dev, "indicator %s status %d\n",
441 to_led_name(selector), status);
444 #define LED_CYCLE_PERIOD ((2*HZ)/3)
446 static void led_work (struct work_struct *work)
448 struct usb_hub *hub =
449 container_of(work, struct usb_hub, leds.work);
450 struct usb_device *hdev = hub->hdev;
452 unsigned changed = 0;
455 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
458 for (i = 0; i < hdev->maxchild; i++) {
459 unsigned selector, mode;
461 /* 30%-50% duty cycle */
463 switch (hub->indicator[i]) {
465 case INDICATOR_CYCLE:
467 selector = HUB_LED_AUTO;
468 mode = INDICATOR_AUTO;
470 /* blinking green = sw attention */
471 case INDICATOR_GREEN_BLINK:
472 selector = HUB_LED_GREEN;
473 mode = INDICATOR_GREEN_BLINK_OFF;
475 case INDICATOR_GREEN_BLINK_OFF:
476 selector = HUB_LED_OFF;
477 mode = INDICATOR_GREEN_BLINK;
479 /* blinking amber = hw attention */
480 case INDICATOR_AMBER_BLINK:
481 selector = HUB_LED_AMBER;
482 mode = INDICATOR_AMBER_BLINK_OFF;
484 case INDICATOR_AMBER_BLINK_OFF:
485 selector = HUB_LED_OFF;
486 mode = INDICATOR_AMBER_BLINK;
488 /* blink green/amber = reserved */
489 case INDICATOR_ALT_BLINK:
490 selector = HUB_LED_GREEN;
491 mode = INDICATOR_ALT_BLINK_OFF;
493 case INDICATOR_ALT_BLINK_OFF:
494 selector = HUB_LED_AMBER;
495 mode = INDICATOR_ALT_BLINK;
500 if (selector != HUB_LED_AUTO)
502 set_port_led(hub, i + 1, selector);
503 hub->indicator[i] = mode;
505 if (!changed && blinkenlights) {
507 cursor %= hdev->maxchild;
508 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
509 hub->indicator[cursor] = INDICATOR_CYCLE;
513 queue_delayed_work(system_power_efficient_wq,
514 &hub->leds, LED_CYCLE_PERIOD);
517 /* use a short timeout for hub/port status fetches */
518 #define USB_STS_TIMEOUT 1000
519 #define USB_STS_RETRIES 5
522 * USB 2.0 spec Section 11.24.2.6
524 static int get_hub_status(struct usb_device *hdev,
525 struct usb_hub_status *data)
527 int i, status = -ETIMEDOUT;
529 for (i = 0; i < USB_STS_RETRIES &&
530 (status == -ETIMEDOUT || status == -EPIPE); i++) {
531 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
532 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
533 data, sizeof(*data), USB_STS_TIMEOUT);
539 * USB 2.0 spec Section 11.24.2.7
541 static int get_port_status(struct usb_device *hdev, int port1,
542 struct usb_port_status *data)
544 int i, status = -ETIMEDOUT;
546 for (i = 0; i < USB_STS_RETRIES &&
547 (status == -ETIMEDOUT || status == -EPIPE); i++) {
548 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
549 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
550 data, sizeof(*data), USB_STS_TIMEOUT);
555 static int hub_port_status(struct usb_hub *hub, int port1,
556 u16 *status, u16 *change)
560 mutex_lock(&hub->status_mutex);
561 ret = get_port_status(hub->hdev, port1, &hub->status->port);
564 dev_err(hub->intfdev,
565 "%s failed (err = %d)\n", __func__, ret);
569 *status = le16_to_cpu(hub->status->port.wPortStatus);
570 *change = le16_to_cpu(hub->status->port.wPortChange);
574 mutex_unlock(&hub->status_mutex);
578 static void kick_khubd(struct usb_hub *hub)
582 spin_lock_irqsave(&hub_event_lock, flags);
583 if (!hub->disconnected && list_empty(&hub->event_list)) {
584 list_add_tail(&hub->event_list, &hub_event_list);
586 /* Suppress autosuspend until khubd runs */
587 usb_autopm_get_interface_no_resume(
588 to_usb_interface(hub->intfdev));
589 wake_up(&khubd_wait);
591 spin_unlock_irqrestore(&hub_event_lock, flags);
594 void usb_kick_khubd(struct usb_device *hdev)
596 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
603 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
604 * Notification, which indicates it had initiated remote wakeup.
606 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
607 * device initiates resume, so the USB core will not receive notice of the
608 * resume through the normal hub interrupt URB.
610 void usb_wakeup_notification(struct usb_device *hdev,
611 unsigned int portnum)
618 hub = usb_hub_to_struct_hub(hdev);
620 set_bit(portnum, hub->wakeup_bits);
624 EXPORT_SYMBOL_GPL(usb_wakeup_notification);
626 /* completion function, fires on port status changes and various faults */
627 static void hub_irq(struct urb *urb)
629 struct usb_hub *hub = urb->context;
630 int status = urb->status;
635 case -ENOENT: /* synchronous unlink */
636 case -ECONNRESET: /* async unlink */
637 case -ESHUTDOWN: /* hardware going away */
640 default: /* presumably an error */
641 /* Cause a hub reset after 10 consecutive errors */
642 dev_dbg (hub->intfdev, "transfer --> %d\n", status);
643 if ((++hub->nerrors < 10) || hub->error)
648 /* let khubd handle things */
649 case 0: /* we got data: port status changed */
651 for (i = 0; i < urb->actual_length; ++i)
652 bits |= ((unsigned long) ((*hub->buffer)[i]))
654 hub->event_bits[0] = bits;
660 /* Something happened, let khubd figure it out */
667 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
668 && status != -ENODEV && status != -EPERM)
669 dev_err (hub->intfdev, "resubmit --> %d\n", status);
672 /* USB 2.0 spec Section 11.24.2.3 */
674 hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
676 /* Need to clear both directions for control ep */
677 if (((devinfo >> 11) & USB_ENDPOINT_XFERTYPE_MASK) ==
678 USB_ENDPOINT_XFER_CONTROL) {
679 int status = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
680 HUB_CLEAR_TT_BUFFER, USB_RT_PORT,
681 devinfo ^ 0x8000, tt, NULL, 0, 1000);
685 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
686 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
691 * enumeration blocks khubd for a long time. we use keventd instead, since
692 * long blocking there is the exception, not the rule. accordingly, HCDs
693 * talking to TTs must queue control transfers (not just bulk and iso), so
694 * both can talk to the same hub concurrently.
696 static void hub_tt_work(struct work_struct *work)
698 struct usb_hub *hub =
699 container_of(work, struct usb_hub, tt.clear_work);
702 spin_lock_irqsave (&hub->tt.lock, flags);
703 while (!list_empty(&hub->tt.clear_list)) {
704 struct list_head *next;
705 struct usb_tt_clear *clear;
706 struct usb_device *hdev = hub->hdev;
707 const struct hc_driver *drv;
710 next = hub->tt.clear_list.next;
711 clear = list_entry (next, struct usb_tt_clear, clear_list);
712 list_del (&clear->clear_list);
714 /* drop lock so HCD can concurrently report other TT errors */
715 spin_unlock_irqrestore (&hub->tt.lock, flags);
716 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
717 if (status && status != -ENODEV)
719 "clear tt %d (%04x) error %d\n",
720 clear->tt, clear->devinfo, status);
722 /* Tell the HCD, even if the operation failed */
723 drv = clear->hcd->driver;
724 if (drv->clear_tt_buffer_complete)
725 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
728 spin_lock_irqsave(&hub->tt.lock, flags);
730 spin_unlock_irqrestore (&hub->tt.lock, flags);
734 * usb_hub_set_port_power - control hub port's power state
735 * @hdev: USB device belonging to the usb hub
738 * @set: expected status
740 * call this function to control port's power via setting or
741 * clearing the port's PORT_POWER feature.
743 * Return: 0 if successful. A negative error code otherwise.
745 int usb_hub_set_port_power(struct usb_device *hdev, struct usb_hub *hub,
751 ret = set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
753 ret = usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
759 set_bit(port1, hub->power_bits);
761 clear_bit(port1, hub->power_bits);
766 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
767 * @urb: an URB associated with the failed or incomplete split transaction
769 * High speed HCDs use this to tell the hub driver that some split control or
770 * bulk transaction failed in a way that requires clearing internal state of
771 * a transaction translator. This is normally detected (and reported) from
774 * It may not be possible for that hub to handle additional full (or low)
775 * speed transactions until that state is fully cleared out.
777 * Return: 0 if successful. A negative error code otherwise.
779 int usb_hub_clear_tt_buffer(struct urb *urb)
781 struct usb_device *udev = urb->dev;
782 int pipe = urb->pipe;
783 struct usb_tt *tt = udev->tt;
785 struct usb_tt_clear *clear;
787 /* we've got to cope with an arbitrary number of pending TT clears,
788 * since each TT has "at least two" buffers that can need it (and
789 * there can be many TTs per hub). even if they're uncommon.
791 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
792 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
793 /* FIXME recover somehow ... RESET_TT? */
797 /* info that CLEAR_TT_BUFFER needs */
798 clear->tt = tt->multi ? udev->ttport : 1;
799 clear->devinfo = usb_pipeendpoint (pipe);
800 clear->devinfo |= udev->devnum << 4;
801 clear->devinfo |= usb_pipecontrol (pipe)
802 ? (USB_ENDPOINT_XFER_CONTROL << 11)
803 : (USB_ENDPOINT_XFER_BULK << 11);
804 if (usb_pipein (pipe))
805 clear->devinfo |= 1 << 15;
807 /* info for completion callback */
808 clear->hcd = bus_to_hcd(udev->bus);
811 /* tell keventd to clear state for this TT */
812 spin_lock_irqsave (&tt->lock, flags);
813 list_add_tail (&clear->clear_list, &tt->clear_list);
814 schedule_work(&tt->clear_work);
815 spin_unlock_irqrestore (&tt->lock, flags);
818 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
820 static void hub_power_on(struct usb_hub *hub, bool do_delay)
824 /* Enable power on each port. Some hubs have reserved values
825 * of LPSM (> 2) in their descriptors, even though they are
826 * USB 2.0 hubs. Some hubs do not implement port-power switching
827 * but only emulate it. In all cases, the ports won't work
828 * unless we send these messages to the hub.
830 if (hub_is_port_power_switchable(hub))
831 dev_dbg(hub->intfdev, "enabling power on all ports\n");
833 dev_dbg(hub->intfdev, "trying to enable port power on "
834 "non-switchable hub\n");
835 for (port1 = 1; port1 <= hub->hdev->maxchild; port1++)
836 if (test_bit(port1, hub->power_bits))
837 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
839 usb_clear_port_feature(hub->hdev, port1,
840 USB_PORT_FEAT_POWER);
842 msleep(hub_power_on_good_delay(hub));
845 static int hub_hub_status(struct usb_hub *hub,
846 u16 *status, u16 *change)
850 mutex_lock(&hub->status_mutex);
851 ret = get_hub_status(hub->hdev, &hub->status->hub);
854 dev_err(hub->intfdev,
855 "%s failed (err = %d)\n", __func__, ret);
857 *status = le16_to_cpu(hub->status->hub.wHubStatus);
858 *change = le16_to_cpu(hub->status->hub.wHubChange);
861 mutex_unlock(&hub->status_mutex);
865 static int hub_set_port_link_state(struct usb_hub *hub, int port1,
866 unsigned int link_status)
868 return set_port_feature(hub->hdev,
869 port1 | (link_status << 3),
870 USB_PORT_FEAT_LINK_STATE);
874 * If USB 3.0 ports are placed into the Disabled state, they will no longer
875 * detect any device connects or disconnects. This is generally not what the
876 * USB core wants, since it expects a disabled port to produce a port status
877 * change event when a new device connects.
879 * Instead, set the link state to Disabled, wait for the link to settle into
880 * that state, clear any change bits, and then put the port into the RxDetect
883 static int hub_usb3_port_disable(struct usb_hub *hub, int port1)
887 u16 portchange, portstatus;
889 if (!hub_is_superspeed(hub->hdev))
892 ret = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_SS_DISABLED);
896 /* Wait for the link to enter the disabled state. */
897 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
898 ret = hub_port_status(hub, port1, &portstatus, &portchange);
902 if ((portstatus & USB_PORT_STAT_LINK_STATE) ==
903 USB_SS_PORT_LS_SS_DISABLED)
905 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
907 msleep(HUB_DEBOUNCE_STEP);
909 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
910 dev_warn(&hub->ports[port1 - 1]->dev,
911 "Could not disable after %d ms\n", total_time);
913 return hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_RX_DETECT);
916 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
918 struct usb_port *port_dev = hub->ports[port1 - 1];
919 struct usb_device *hdev = hub->hdev;
922 if (port_dev->child && set_state)
923 usb_set_device_state(port_dev->child, USB_STATE_NOTATTACHED);
925 if (hub_is_superspeed(hub->hdev))
926 ret = hub_usb3_port_disable(hub, port1);
928 ret = usb_clear_port_feature(hdev, port1,
929 USB_PORT_FEAT_ENABLE);
931 if (ret && ret != -ENODEV)
932 dev_err(&port_dev->dev, "cannot disable (err = %d)\n", ret);
937 * Disable a port and mark a logical connect-change event, so that some
938 * time later khubd will disconnect() any existing usb_device on the port
939 * and will re-enumerate if there actually is a device attached.
941 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
943 dev_dbg(&hub->ports[port1 - 1]->dev, "logical disconnect\n");
944 hub_port_disable(hub, port1, 1);
946 /* FIXME let caller ask to power down the port:
947 * - some devices won't enumerate without a VBUS power cycle
948 * - SRP saves power that way
949 * - ... new call, TBD ...
950 * That's easy if this hub can switch power per-port, and
951 * khubd reactivates the port later (timer, SRP, etc).
952 * Powerdown must be optional, because of reset/DFU.
955 set_bit(port1, hub->change_bits);
960 * usb_remove_device - disable a device's port on its parent hub
961 * @udev: device to be disabled and removed
962 * Context: @udev locked, must be able to sleep.
964 * After @udev's port has been disabled, khubd is notified and it will
965 * see that the device has been disconnected. When the device is
966 * physically unplugged and something is plugged in, the events will
967 * be received and processed normally.
969 * Return: 0 if successful. A negative error code otherwise.
971 int usb_remove_device(struct usb_device *udev)
974 struct usb_interface *intf;
976 if (!udev->parent) /* Can't remove a root hub */
978 hub = usb_hub_to_struct_hub(udev->parent);
979 intf = to_usb_interface(hub->intfdev);
981 usb_autopm_get_interface(intf);
982 set_bit(udev->portnum, hub->removed_bits);
983 hub_port_logical_disconnect(hub, udev->portnum);
984 usb_autopm_put_interface(intf);
988 enum hub_activation_type {
989 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
990 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
993 static void hub_init_func2(struct work_struct *ws);
994 static void hub_init_func3(struct work_struct *ws);
996 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
998 struct usb_device *hdev = hub->hdev;
1003 bool need_debounce_delay = false;
1006 /* Continue a partial initialization */
1007 if (type == HUB_INIT2)
1009 if (type == HUB_INIT3)
1012 /* The superspeed hub except for root hub has to use Hub Depth
1013 * value as an offset into the route string to locate the bits
1014 * it uses to determine the downstream port number. So hub driver
1015 * should send a set hub depth request to superspeed hub after
1016 * the superspeed hub is set configuration in initialization or
1019 * After a resume, port power should still be on.
1020 * For any other type of activation, turn it on.
1022 if (type != HUB_RESUME) {
1023 if (hdev->parent && hub_is_superspeed(hdev)) {
1024 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
1025 HUB_SET_DEPTH, USB_RT_HUB,
1026 hdev->level - 1, 0, NULL, 0,
1027 USB_CTRL_SET_TIMEOUT);
1029 dev_err(hub->intfdev,
1030 "set hub depth failed\n");
1033 /* Speed up system boot by using a delayed_work for the
1034 * hub's initial power-up delays. This is pretty awkward
1035 * and the implementation looks like a home-brewed sort of
1036 * setjmp/longjmp, but it saves at least 100 ms for each
1037 * root hub (assuming usbcore is compiled into the kernel
1038 * rather than as a module). It adds up.
1040 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1041 * because for those activation types the ports have to be
1042 * operational when we return. In theory this could be done
1043 * for HUB_POST_RESET, but it's easier not to.
1045 if (type == HUB_INIT) {
1046 unsigned delay = hub_power_on_good_delay(hub);
1048 hub_power_on(hub, false);
1049 INIT_DELAYED_WORK(&hub->init_work, hub_init_func2);
1050 queue_delayed_work(system_power_efficient_wq,
1052 msecs_to_jiffies(delay));
1054 /* Suppress autosuspend until init is done */
1055 usb_autopm_get_interface_no_resume(
1056 to_usb_interface(hub->intfdev));
1057 return; /* Continues at init2: below */
1058 } else if (type == HUB_RESET_RESUME) {
1059 /* The internal host controller state for the hub device
1060 * may be gone after a host power loss on system resume.
1061 * Update the device's info so the HW knows it's a hub.
1063 hcd = bus_to_hcd(hdev->bus);
1064 if (hcd->driver->update_hub_device) {
1065 ret = hcd->driver->update_hub_device(hcd, hdev,
1066 &hub->tt, GFP_NOIO);
1068 dev_err(hub->intfdev, "Host not "
1069 "accepting hub info "
1071 dev_err(hub->intfdev, "LS/FS devices "
1072 "and hubs may not work "
1073 "under this hub\n.");
1076 hub_power_on(hub, true);
1078 hub_power_on(hub, true);
1084 * Check each port and set hub->change_bits to let khubd know
1085 * which ports need attention.
1087 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
1088 struct usb_port *port_dev = hub->ports[port1 - 1];
1089 struct usb_device *udev = port_dev->child;
1090 u16 portstatus, portchange;
1092 portstatus = portchange = 0;
1093 status = hub_port_status(hub, port1, &portstatus, &portchange);
1094 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1095 dev_dbg(&port_dev->dev, "status %04x change %04x\n",
1096 portstatus, portchange);
1099 * After anything other than HUB_RESUME (i.e., initialization
1100 * or any sort of reset), every port should be disabled.
1101 * Unconnected ports should likewise be disabled (paranoia),
1102 * and so should ports for which we have no usb_device.
1104 if ((portstatus & USB_PORT_STAT_ENABLE) && (
1105 type != HUB_RESUME ||
1106 !(portstatus & USB_PORT_STAT_CONNECTION) ||
1108 udev->state == USB_STATE_NOTATTACHED)) {
1110 * USB3 protocol ports will automatically transition
1111 * to Enabled state when detect an USB3.0 device attach.
1112 * Do not disable USB3 protocol ports, just pretend
1115 portstatus &= ~USB_PORT_STAT_ENABLE;
1116 if (!hub_is_superspeed(hdev))
1117 usb_clear_port_feature(hdev, port1,
1118 USB_PORT_FEAT_ENABLE);
1121 /* Clear status-change flags; we'll debounce later */
1122 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1123 need_debounce_delay = true;
1124 usb_clear_port_feature(hub->hdev, port1,
1125 USB_PORT_FEAT_C_CONNECTION);
1127 if (portchange & USB_PORT_STAT_C_ENABLE) {
1128 need_debounce_delay = true;
1129 usb_clear_port_feature(hub->hdev, port1,
1130 USB_PORT_FEAT_C_ENABLE);
1132 if (portchange & USB_PORT_STAT_C_RESET) {
1133 need_debounce_delay = true;
1134 usb_clear_port_feature(hub->hdev, port1,
1135 USB_PORT_FEAT_C_RESET);
1137 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
1138 hub_is_superspeed(hub->hdev)) {
1139 need_debounce_delay = true;
1140 usb_clear_port_feature(hub->hdev, port1,
1141 USB_PORT_FEAT_C_BH_PORT_RESET);
1143 /* We can forget about a "removed" device when there's a
1144 * physical disconnect or the connect status changes.
1146 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
1147 (portchange & USB_PORT_STAT_C_CONNECTION))
1148 clear_bit(port1, hub->removed_bits);
1150 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
1151 /* Tell khubd to disconnect the device or
1152 * check for a new connection
1154 if (udev || (portstatus & USB_PORT_STAT_CONNECTION) ||
1155 (portstatus & USB_PORT_STAT_OVERCURRENT))
1156 set_bit(port1, hub->change_bits);
1158 } else if (portstatus & USB_PORT_STAT_ENABLE) {
1159 bool port_resumed = (portstatus &
1160 USB_PORT_STAT_LINK_STATE) ==
1162 /* The power session apparently survived the resume.
1163 * If there was an overcurrent or suspend change
1164 * (i.e., remote wakeup request), have khubd
1165 * take care of it. Look at the port link state
1166 * for USB 3.0 hubs, since they don't have a suspend
1167 * change bit, and they don't set the port link change
1168 * bit on device-initiated resume.
1170 if (portchange || (hub_is_superspeed(hub->hdev) &&
1172 set_bit(port1, hub->change_bits);
1174 } else if (udev->persist_enabled) {
1176 udev->reset_resume = 1;
1178 /* Don't set the change_bits when the device
1181 if (test_bit(port1, hub->power_bits))
1182 set_bit(port1, hub->change_bits);
1185 /* The power session is gone; tell khubd */
1186 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1187 set_bit(port1, hub->change_bits);
1191 /* If no port-status-change flags were set, we don't need any
1192 * debouncing. If flags were set we can try to debounce the
1193 * ports all at once right now, instead of letting khubd do them
1194 * one at a time later on.
1196 * If any port-status changes do occur during this delay, khubd
1197 * will see them later and handle them normally.
1199 if (need_debounce_delay) {
1200 delay = HUB_DEBOUNCE_STABLE;
1202 /* Don't do a long sleep inside a workqueue routine */
1203 if (type == HUB_INIT2) {
1204 INIT_DELAYED_WORK(&hub->init_work, hub_init_func3);
1205 queue_delayed_work(system_power_efficient_wq,
1207 msecs_to_jiffies(delay));
1208 return; /* Continues at init3: below */
1216 status = usb_submit_urb(hub->urb, GFP_NOIO);
1218 dev_err(hub->intfdev, "activate --> %d\n", status);
1219 if (hub->has_indicators && blinkenlights)
1220 queue_delayed_work(system_power_efficient_wq,
1221 &hub->leds, LED_CYCLE_PERIOD);
1223 /* Scan all ports that need attention */
1226 /* Allow autosuspend if it was suppressed */
1227 if (type <= HUB_INIT3)
1228 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
1231 /* Implement the continuations for the delays above */
1232 static void hub_init_func2(struct work_struct *ws)
1234 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1236 hub_activate(hub, HUB_INIT2);
1239 static void hub_init_func3(struct work_struct *ws)
1241 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1243 hub_activate(hub, HUB_INIT3);
1246 enum hub_quiescing_type {
1247 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
1250 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
1252 struct usb_device *hdev = hub->hdev;
1255 cancel_delayed_work_sync(&hub->init_work);
1257 /* khubd and related activity won't re-trigger */
1260 if (type != HUB_SUSPEND) {
1261 /* Disconnect all the children */
1262 for (i = 0; i < hdev->maxchild; ++i) {
1263 if (hub->ports[i]->child)
1264 usb_disconnect(&hub->ports[i]->child);
1268 /* Stop khubd and related activity */
1269 usb_kill_urb(hub->urb);
1270 if (hub->has_indicators)
1271 cancel_delayed_work_sync(&hub->leds);
1273 flush_work(&hub->tt.clear_work);
1276 static void hub_pm_barrier_for_all_ports(struct usb_hub *hub)
1280 for (i = 0; i < hub->hdev->maxchild; ++i)
1281 pm_runtime_barrier(&hub->ports[i]->dev);
1284 /* caller has locked the hub device */
1285 static int hub_pre_reset(struct usb_interface *intf)
1287 struct usb_hub *hub = usb_get_intfdata(intf);
1289 hub_quiesce(hub, HUB_PRE_RESET);
1291 hub_pm_barrier_for_all_ports(hub);
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);
1301 hub_pm_barrier_for_all_ports(hub);
1302 hub_activate(hub, HUB_POST_RESET);
1306 static int hub_configure(struct usb_hub *hub,
1307 struct usb_endpoint_descriptor *endpoint)
1309 struct usb_hcd *hcd;
1310 struct usb_device *hdev = hub->hdev;
1311 struct device *hub_dev = hub->intfdev;
1312 u16 hubstatus, hubchange;
1313 u16 wHubCharacteristics;
1316 char *message = "out of memory";
1321 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
1327 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1332 mutex_init(&hub->status_mutex);
1334 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1335 if (!hub->descriptor) {
1340 /* Request the entire hub descriptor.
1341 * hub->descriptor can handle USB_MAXCHILDREN ports,
1342 * but the hub can/will return fewer bytes here.
1344 ret = get_hub_descriptor(hdev, hub->descriptor);
1346 message = "can't read hub descriptor";
1348 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
1349 message = "hub has too many ports!";
1352 } else if (hub->descriptor->bNbrPorts == 0) {
1353 message = "hub doesn't have any ports!";
1358 maxchild = hub->descriptor->bNbrPorts;
1359 dev_info(hub_dev, "%d port%s detected\n", maxchild,
1360 (maxchild == 1) ? "" : "s");
1362 hub->ports = kzalloc(maxchild * sizeof(struct usb_port *), GFP_KERNEL);
1368 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1369 if (hub_is_superspeed(hdev)) {
1377 /* FIXME for USB 3.0, skip for now */
1378 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1379 !(hub_is_superspeed(hdev))) {
1381 char portstr[USB_MAXCHILDREN + 1];
1383 for (i = 0; i < maxchild; i++)
1384 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1385 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1387 portstr[maxchild] = 0;
1388 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1390 dev_dbg(hub_dev, "standalone hub\n");
1392 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1393 case HUB_CHAR_COMMON_LPSM:
1394 dev_dbg(hub_dev, "ganged power switching\n");
1396 case HUB_CHAR_INDV_PORT_LPSM:
1397 dev_dbg(hub_dev, "individual port power switching\n");
1399 case HUB_CHAR_NO_LPSM:
1401 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1405 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1406 case HUB_CHAR_COMMON_OCPM:
1407 dev_dbg(hub_dev, "global over-current protection\n");
1409 case HUB_CHAR_INDV_PORT_OCPM:
1410 dev_dbg(hub_dev, "individual port over-current protection\n");
1412 case HUB_CHAR_NO_OCPM:
1414 dev_dbg(hub_dev, "no over-current protection\n");
1418 spin_lock_init (&hub->tt.lock);
1419 INIT_LIST_HEAD (&hub->tt.clear_list);
1420 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1421 switch (hdev->descriptor.bDeviceProtocol) {
1424 case USB_HUB_PR_HS_SINGLE_TT:
1425 dev_dbg(hub_dev, "Single TT\n");
1428 case USB_HUB_PR_HS_MULTI_TT:
1429 ret = usb_set_interface(hdev, 0, 1);
1431 dev_dbg(hub_dev, "TT per port\n");
1434 dev_err(hub_dev, "Using single TT (err %d)\n",
1439 /* USB 3.0 hubs don't have a TT */
1442 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1443 hdev->descriptor.bDeviceProtocol);
1447 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1448 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1449 case HUB_TTTT_8_BITS:
1450 if (hdev->descriptor.bDeviceProtocol != 0) {
1451 hub->tt.think_time = 666;
1452 dev_dbg(hub_dev, "TT requires at most %d "
1453 "FS bit times (%d ns)\n",
1454 8, hub->tt.think_time);
1457 case HUB_TTTT_16_BITS:
1458 hub->tt.think_time = 666 * 2;
1459 dev_dbg(hub_dev, "TT requires at most %d "
1460 "FS bit times (%d ns)\n",
1461 16, hub->tt.think_time);
1463 case HUB_TTTT_24_BITS:
1464 hub->tt.think_time = 666 * 3;
1465 dev_dbg(hub_dev, "TT requires at most %d "
1466 "FS bit times (%d ns)\n",
1467 24, hub->tt.think_time);
1469 case HUB_TTTT_32_BITS:
1470 hub->tt.think_time = 666 * 4;
1471 dev_dbg(hub_dev, "TT requires at most %d "
1472 "FS bit times (%d ns)\n",
1473 32, hub->tt.think_time);
1477 /* probe() zeroes hub->indicator[] */
1478 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1479 hub->has_indicators = 1;
1480 dev_dbg(hub_dev, "Port indicators are supported\n");
1483 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1484 hub->descriptor->bPwrOn2PwrGood * 2);
1486 /* power budgeting mostly matters with bus-powered hubs,
1487 * and battery-powered root hubs (may provide just 8 mA).
1489 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1491 message = "can't get hub status";
1494 hcd = bus_to_hcd(hdev->bus);
1495 if (hdev == hdev->bus->root_hub) {
1496 if (hcd->power_budget > 0)
1497 hdev->bus_mA = hcd->power_budget;
1499 hdev->bus_mA = full_load * maxchild;
1500 if (hdev->bus_mA >= full_load)
1501 hub->mA_per_port = full_load;
1503 hub->mA_per_port = hdev->bus_mA;
1504 hub->limited_power = 1;
1506 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1507 int remaining = hdev->bus_mA -
1508 hub->descriptor->bHubContrCurrent;
1510 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1511 hub->descriptor->bHubContrCurrent);
1512 hub->limited_power = 1;
1514 if (remaining < maxchild * unit_load)
1516 "insufficient power available "
1517 "to use all downstream ports\n");
1518 hub->mA_per_port = unit_load; /* 7.2.1 */
1520 } else { /* Self-powered external hub */
1521 /* FIXME: What about battery-powered external hubs that
1522 * provide less current per port? */
1523 hub->mA_per_port = full_load;
1525 if (hub->mA_per_port < full_load)
1526 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1529 /* Update the HCD's internal representation of this hub before khubd
1530 * starts getting port status changes for devices under the hub.
1532 if (hcd->driver->update_hub_device) {
1533 ret = hcd->driver->update_hub_device(hcd, hdev,
1534 &hub->tt, GFP_KERNEL);
1536 message = "can't update HCD hub info";
1541 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1543 message = "can't get hub status";
1547 /* local power status reports aren't always correct */
1548 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1549 dev_dbg(hub_dev, "local power source is %s\n",
1550 (hubstatus & HUB_STATUS_LOCAL_POWER)
1551 ? "lost (inactive)" : "good");
1553 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1554 dev_dbg(hub_dev, "%sover-current condition exists\n",
1555 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1557 /* set up the interrupt endpoint
1558 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1559 * bytes as USB2.0[11.12.3] says because some hubs are known
1560 * to send more data (and thus cause overflow). For root hubs,
1561 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1562 * to be big enough for at least USB_MAXCHILDREN ports. */
1563 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1564 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1566 if (maxp > sizeof(*hub->buffer))
1567 maxp = sizeof(*hub->buffer);
1569 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1575 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1576 hub, endpoint->bInterval);
1578 /* maybe cycle the hub leds */
1579 if (hub->has_indicators && blinkenlights)
1580 hub->indicator[0] = INDICATOR_CYCLE;
1582 mutex_lock(&usb_port_peer_mutex);
1583 for (i = 0; i < maxchild; i++) {
1584 ret = usb_hub_create_port_device(hub, i + 1);
1586 dev_err(hub->intfdev,
1587 "couldn't create port%d device.\n", i + 1);
1592 mutex_unlock(&usb_port_peer_mutex);
1596 usb_hub_adjust_deviceremovable(hdev, hub->descriptor);
1598 hub_activate(hub, HUB_INIT);
1602 dev_err (hub_dev, "config failed, %s (err %d)\n",
1604 /* hub_disconnect() frees urb and descriptor */
1608 static void hub_release(struct kref *kref)
1610 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1612 usb_put_intf(to_usb_interface(hub->intfdev));
1616 static unsigned highspeed_hubs;
1618 static void hub_disconnect(struct usb_interface *intf)
1620 struct usb_hub *hub = usb_get_intfdata(intf);
1621 struct usb_device *hdev = interface_to_usbdev(intf);
1624 /* Take the hub off the event list and don't let it be added again */
1625 spin_lock_irq(&hub_event_lock);
1626 if (!list_empty(&hub->event_list)) {
1627 list_del_init(&hub->event_list);
1628 usb_autopm_put_interface_no_suspend(intf);
1630 hub->disconnected = 1;
1631 spin_unlock_irq(&hub_event_lock);
1633 /* Disconnect all children and quiesce the hub */
1635 hub_quiesce(hub, HUB_DISCONNECT);
1637 mutex_lock(&usb_port_peer_mutex);
1639 /* Avoid races with recursively_mark_NOTATTACHED() */
1640 spin_lock_irq(&device_state_lock);
1641 port1 = hdev->maxchild;
1643 usb_set_intfdata(intf, NULL);
1644 spin_unlock_irq(&device_state_lock);
1646 for (; port1 > 0; --port1)
1647 usb_hub_remove_port_device(hub, port1);
1649 mutex_unlock(&usb_port_peer_mutex);
1651 if (hub->hdev->speed == USB_SPEED_HIGH)
1654 usb_free_urb(hub->urb);
1656 kfree(hub->descriptor);
1660 pm_suspend_ignore_children(&intf->dev, false);
1661 kref_put(&hub->kref, hub_release);
1664 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1666 struct usb_host_interface *desc;
1667 struct usb_endpoint_descriptor *endpoint;
1668 struct usb_device *hdev;
1669 struct usb_hub *hub;
1671 desc = intf->cur_altsetting;
1672 hdev = interface_to_usbdev(intf);
1675 * Set default autosuspend delay as 0 to speedup bus suspend,
1676 * based on the below considerations:
1678 * - Unlike other drivers, the hub driver does not rely on the
1679 * autosuspend delay to provide enough time to handle a wakeup
1680 * event, and the submitted status URB is just to check future
1681 * change on hub downstream ports, so it is safe to do it.
1683 * - The patch might cause one or more auto supend/resume for
1684 * below very rare devices when they are plugged into hub
1687 * devices having trouble initializing, and disconnect
1688 * themselves from the bus and then reconnect a second
1691 * devices just for downloading firmware, and disconnects
1692 * themselves after completing it
1694 * For these quite rare devices, their drivers may change the
1695 * autosuspend delay of their parent hub in the probe() to one
1696 * appropriate value to avoid the subtle problem if someone
1699 * - The patch may cause one or more auto suspend/resume on
1700 * hub during running 'lsusb', but it is probably too
1701 * infrequent to worry about.
1703 * - Change autosuspend delay of hub can avoid unnecessary auto
1704 * suspend timer for hub, also may decrease power consumption
1707 pm_runtime_set_autosuspend_delay(&hdev->dev, 0);
1709 /* Hubs have proper suspend/resume support. */
1710 usb_enable_autosuspend(hdev);
1712 if (hdev->level == MAX_TOPO_LEVEL) {
1714 "Unsupported bus topology: hub nested too deep\n");
1718 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1720 dev_warn(&intf->dev, "ignoring external hub\n");
1725 /* Some hubs have a subclass of 1, which AFAICT according to the */
1726 /* specs is not defined, but it works */
1727 if ((desc->desc.bInterfaceSubClass != 0) &&
1728 (desc->desc.bInterfaceSubClass != 1)) {
1730 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1734 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1735 if (desc->desc.bNumEndpoints != 1)
1736 goto descriptor_error;
1738 endpoint = &desc->endpoint[0].desc;
1740 /* If it's not an interrupt in endpoint, we'd better punt! */
1741 if (!usb_endpoint_is_int_in(endpoint))
1742 goto descriptor_error;
1744 /* We found a hub */
1745 dev_info (&intf->dev, "USB hub found\n");
1747 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1749 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1753 kref_init(&hub->kref);
1754 INIT_LIST_HEAD(&hub->event_list);
1755 hub->intfdev = &intf->dev;
1757 INIT_DELAYED_WORK(&hub->leds, led_work);
1758 INIT_DELAYED_WORK(&hub->init_work, NULL);
1761 usb_set_intfdata (intf, hub);
1762 intf->needs_remote_wakeup = 1;
1763 pm_suspend_ignore_children(&intf->dev, true);
1765 if (hdev->speed == USB_SPEED_HIGH)
1768 if (id->driver_info & HUB_QUIRK_CHECK_PORT_AUTOSUSPEND)
1769 hub->quirk_check_port_auto_suspend = 1;
1771 if (hub_configure(hub, endpoint) >= 0)
1774 hub_disconnect (intf);
1779 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1781 struct usb_device *hdev = interface_to_usbdev (intf);
1782 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1784 /* assert ifno == 0 (part of hub spec) */
1786 case USBDEVFS_HUB_PORTINFO: {
1787 struct usbdevfs_hub_portinfo *info = user_data;
1790 spin_lock_irq(&device_state_lock);
1791 if (hdev->devnum <= 0)
1794 info->nports = hdev->maxchild;
1795 for (i = 0; i < info->nports; i++) {
1796 if (hub->ports[i]->child == NULL)
1800 hub->ports[i]->child->devnum;
1803 spin_unlock_irq(&device_state_lock);
1805 return info->nports + 1;
1814 * Allow user programs to claim ports on a hub. When a device is attached
1815 * to one of these "claimed" ports, the program will "own" the device.
1817 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1818 struct usb_dev_state ***ppowner)
1820 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1822 if (hdev->state == USB_STATE_NOTATTACHED)
1824 if (port1 == 0 || port1 > hdev->maxchild)
1827 /* Devices not managed by the hub driver
1828 * will always have maxchild equal to 0.
1830 *ppowner = &(hub->ports[port1 - 1]->port_owner);
1834 /* In the following three functions, the caller must hold hdev's lock */
1835 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
1836 struct usb_dev_state *owner)
1839 struct usb_dev_state **powner;
1841 rc = find_port_owner(hdev, port1, &powner);
1849 EXPORT_SYMBOL_GPL(usb_hub_claim_port);
1851 int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
1852 struct usb_dev_state *owner)
1855 struct usb_dev_state **powner;
1857 rc = find_port_owner(hdev, port1, &powner);
1860 if (*powner != owner)
1865 EXPORT_SYMBOL_GPL(usb_hub_release_port);
1867 void usb_hub_release_all_ports(struct usb_device *hdev, struct usb_dev_state *owner)
1869 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1872 for (n = 0; n < hdev->maxchild; n++) {
1873 if (hub->ports[n]->port_owner == owner)
1874 hub->ports[n]->port_owner = NULL;
1879 /* The caller must hold udev's lock */
1880 bool usb_device_is_owned(struct usb_device *udev)
1882 struct usb_hub *hub;
1884 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1886 hub = usb_hub_to_struct_hub(udev->parent);
1887 return !!hub->ports[udev->portnum - 1]->port_owner;
1890 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1892 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
1895 for (i = 0; i < udev->maxchild; ++i) {
1896 if (hub->ports[i]->child)
1897 recursively_mark_NOTATTACHED(hub->ports[i]->child);
1899 if (udev->state == USB_STATE_SUSPENDED)
1900 udev->active_duration -= jiffies;
1901 udev->state = USB_STATE_NOTATTACHED;
1905 * usb_set_device_state - change a device's current state (usbcore, hcds)
1906 * @udev: pointer to device whose state should be changed
1907 * @new_state: new state value to be stored
1909 * udev->state is _not_ fully protected by the device lock. Although
1910 * most transitions are made only while holding the lock, the state can
1911 * can change to USB_STATE_NOTATTACHED at almost any time. This
1912 * is so that devices can be marked as disconnected as soon as possible,
1913 * without having to wait for any semaphores to be released. As a result,
1914 * all changes to any device's state must be protected by the
1915 * device_state_lock spinlock.
1917 * Once a device has been added to the device tree, all changes to its state
1918 * should be made using this routine. The state should _not_ be set directly.
1920 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1921 * Otherwise udev->state is set to new_state, and if new_state is
1922 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1923 * to USB_STATE_NOTATTACHED.
1925 void usb_set_device_state(struct usb_device *udev,
1926 enum usb_device_state new_state)
1928 unsigned long flags;
1931 spin_lock_irqsave(&device_state_lock, flags);
1932 if (udev->state == USB_STATE_NOTATTACHED)
1934 else if (new_state != USB_STATE_NOTATTACHED) {
1936 /* root hub wakeup capabilities are managed out-of-band
1937 * and may involve silicon errata ... ignore them here.
1940 if (udev->state == USB_STATE_SUSPENDED
1941 || new_state == USB_STATE_SUSPENDED)
1942 ; /* No change to wakeup settings */
1943 else if (new_state == USB_STATE_CONFIGURED)
1944 wakeup = udev->actconfig->desc.bmAttributes
1945 & USB_CONFIG_ATT_WAKEUP;
1949 if (udev->state == USB_STATE_SUSPENDED &&
1950 new_state != USB_STATE_SUSPENDED)
1951 udev->active_duration -= jiffies;
1952 else if (new_state == USB_STATE_SUSPENDED &&
1953 udev->state != USB_STATE_SUSPENDED)
1954 udev->active_duration += jiffies;
1955 udev->state = new_state;
1957 recursively_mark_NOTATTACHED(udev);
1958 spin_unlock_irqrestore(&device_state_lock, flags);
1960 device_set_wakeup_capable(&udev->dev, wakeup);
1962 EXPORT_SYMBOL_GPL(usb_set_device_state);
1965 * Choose a device number.
1967 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1968 * USB-2.0 buses they are also used as device addresses, however on
1969 * USB-3.0 buses the address is assigned by the controller hardware
1970 * and it usually is not the same as the device number.
1972 * WUSB devices are simple: they have no hubs behind, so the mapping
1973 * device <-> virtual port number becomes 1:1. Why? to simplify the
1974 * life of the device connection logic in
1975 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1976 * handshake we need to assign a temporary address in the unauthorized
1977 * space. For simplicity we use the first virtual port number found to
1978 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1979 * and that becomes it's address [X < 128] or its unauthorized address
1982 * We add 1 as an offset to the one-based USB-stack port number
1983 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1984 * 0 is reserved by USB for default address; (b) Linux's USB stack
1985 * uses always #1 for the root hub of the controller. So USB stack's
1986 * port #1, which is wusb virtual-port #0 has address #2.
1988 * Devices connected under xHCI are not as simple. The host controller
1989 * supports virtualization, so the hardware assigns device addresses and
1990 * the HCD must setup data structures before issuing a set address
1991 * command to the hardware.
1993 static void choose_devnum(struct usb_device *udev)
1996 struct usb_bus *bus = udev->bus;
1998 /* If khubd ever becomes multithreaded, this will need a lock */
2000 devnum = udev->portnum + 1;
2001 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
2003 /* Try to allocate the next devnum beginning at
2004 * bus->devnum_next. */
2005 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
2008 devnum = find_next_zero_bit(bus->devmap.devicemap,
2010 bus->devnum_next = (devnum >= 127 ? 1 : devnum + 1);
2013 set_bit(devnum, bus->devmap.devicemap);
2014 udev->devnum = devnum;
2018 static void release_devnum(struct usb_device *udev)
2020 if (udev->devnum > 0) {
2021 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
2026 static void update_devnum(struct usb_device *udev, int devnum)
2028 /* The address for a WUSB device is managed by wusbcore. */
2030 udev->devnum = devnum;
2033 static void hub_free_dev(struct usb_device *udev)
2035 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2037 /* Root hubs aren't real devices, so don't free HCD resources */
2038 if (hcd->driver->free_dev && udev->parent)
2039 hcd->driver->free_dev(hcd, udev);
2043 * usb_disconnect - disconnect a device (usbcore-internal)
2044 * @pdev: pointer to device being disconnected
2045 * Context: !in_interrupt ()
2047 * Something got disconnected. Get rid of it and all of its children.
2049 * If *pdev is a normal device then the parent hub must already be locked.
2050 * If *pdev is a root hub then the caller must hold the usb_bus_list_lock,
2051 * which protects the set of root hubs as well as the list of buses.
2053 * Only hub drivers (including virtual root hub drivers for host
2054 * controllers) should ever call this.
2056 * This call is synchronous, and may not be used in an interrupt context.
2058 void usb_disconnect(struct usb_device **pdev)
2060 struct usb_device *udev = *pdev;
2061 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2064 /* mark the device as inactive, so any further urb submissions for
2065 * this device (and any of its children) will fail immediately.
2066 * this quiesces everything except pending urbs.
2068 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2069 dev_info(&udev->dev, "USB disconnect, device number %d\n",
2072 usb_lock_device(udev);
2074 /* Free up all the children before we remove this device */
2075 for (i = 0; i < udev->maxchild; i++) {
2076 if (hub->ports[i]->child)
2077 usb_disconnect(&hub->ports[i]->child);
2080 /* deallocate hcd/hardware state ... nuking all pending urbs and
2081 * cleaning up all state associated with the current configuration
2082 * so that the hardware is now fully quiesced.
2084 dev_dbg (&udev->dev, "unregistering device\n");
2085 usb_disable_device(udev, 0);
2086 usb_hcd_synchronize_unlinks(udev);
2089 int port1 = udev->portnum;
2090 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2091 struct usb_port *port_dev = hub->ports[port1 - 1];
2093 sysfs_remove_link(&udev->dev.kobj, "port");
2094 sysfs_remove_link(&port_dev->dev.kobj, "device");
2096 if (test_and_clear_bit(port1, hub->child_usage_bits))
2097 pm_runtime_put(&port_dev->dev);
2100 usb_remove_ep_devs(&udev->ep0);
2101 usb_unlock_device(udev);
2103 /* Unregister the device. The device driver is responsible
2104 * for de-configuring the device and invoking the remove-device
2105 * notifier chain (used by usbfs and possibly others).
2107 device_del(&udev->dev);
2109 /* Free the device number and delete the parent's children[]
2110 * (or root_hub) pointer.
2112 release_devnum(udev);
2114 /* Avoid races with recursively_mark_NOTATTACHED() */
2115 spin_lock_irq(&device_state_lock);
2117 spin_unlock_irq(&device_state_lock);
2121 put_device(&udev->dev);
2124 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2125 static void show_string(struct usb_device *udev, char *id, char *string)
2129 dev_info(&udev->dev, "%s: %s\n", id, string);
2132 static void announce_device(struct usb_device *udev)
2134 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2135 le16_to_cpu(udev->descriptor.idVendor),
2136 le16_to_cpu(udev->descriptor.idProduct));
2137 dev_info(&udev->dev,
2138 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2139 udev->descriptor.iManufacturer,
2140 udev->descriptor.iProduct,
2141 udev->descriptor.iSerialNumber);
2142 show_string(udev, "Product", udev->product);
2143 show_string(udev, "Manufacturer", udev->manufacturer);
2144 show_string(udev, "SerialNumber", udev->serial);
2147 static inline void announce_device(struct usb_device *udev) { }
2150 #ifdef CONFIG_USB_OTG
2151 #include "otg_whitelist.h"
2155 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2156 * @udev: newly addressed device (in ADDRESS state)
2158 * Finish enumeration for On-The-Go devices
2160 * Return: 0 if successful. A negative error code otherwise.
2162 static int usb_enumerate_device_otg(struct usb_device *udev)
2166 #ifdef CONFIG_USB_OTG
2168 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2169 * to wake us after we've powered off VBUS; and HNP, switching roles
2170 * "host" to "peripheral". The OTG descriptor helps figure this out.
2172 if (!udev->bus->is_b_host
2174 && udev->parent == udev->bus->root_hub) {
2175 struct usb_otg_descriptor *desc = NULL;
2176 struct usb_bus *bus = udev->bus;
2178 /* descriptor may appear anywhere in config */
2179 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
2180 le16_to_cpu(udev->config[0].desc.wTotalLength),
2181 USB_DT_OTG, (void **) &desc) == 0) {
2182 if (desc->bmAttributes & USB_OTG_HNP) {
2183 unsigned port1 = udev->portnum;
2185 dev_info(&udev->dev,
2186 "Dual-Role OTG device on %sHNP port\n",
2187 (port1 == bus->otg_port)
2190 /* enable HNP before suspend, it's simpler */
2191 if (port1 == bus->otg_port)
2192 bus->b_hnp_enable = 1;
2193 err = usb_control_msg(udev,
2194 usb_sndctrlpipe(udev, 0),
2195 USB_REQ_SET_FEATURE, 0,
2197 ? USB_DEVICE_B_HNP_ENABLE
2198 : USB_DEVICE_A_ALT_HNP_SUPPORT,
2199 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
2201 /* OTG MESSAGE: report errors here,
2202 * customize to match your product.
2204 dev_info(&udev->dev,
2205 "can't set HNP mode: %d\n",
2207 bus->b_hnp_enable = 0;
2213 if (!is_targeted(udev)) {
2215 /* Maybe it can talk to us, though we can't talk to it.
2216 * (Includes HNP test device.)
2218 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
2219 err = usb_port_suspend(udev, PMSG_SUSPEND);
2221 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
2233 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2234 * @udev: newly addressed device (in ADDRESS state)
2236 * This is only called by usb_new_device() and usb_authorize_device()
2237 * and FIXME -- all comments that apply to them apply here wrt to
2240 * If the device is WUSB and not authorized, we don't attempt to read
2241 * the string descriptors, as they will be errored out by the device
2242 * until it has been authorized.
2244 * Return: 0 if successful. A negative error code otherwise.
2246 static int usb_enumerate_device(struct usb_device *udev)
2250 if (udev->config == NULL) {
2251 err = usb_get_configuration(udev);
2254 dev_err(&udev->dev, "can't read configurations, error %d\n",
2260 /* read the standard strings and cache them if present */
2261 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
2262 udev->manufacturer = usb_cache_string(udev,
2263 udev->descriptor.iManufacturer);
2264 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
2266 err = usb_enumerate_device_otg(udev);
2270 usb_detect_interface_quirks(udev);
2275 static void set_usb_port_removable(struct usb_device *udev)
2277 struct usb_device *hdev = udev->parent;
2278 struct usb_hub *hub;
2279 u8 port = udev->portnum;
2280 u16 wHubCharacteristics;
2281 bool removable = true;
2286 hub = usb_hub_to_struct_hub(udev->parent);
2288 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2290 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
2293 if (hub_is_superspeed(hdev)) {
2294 if (le16_to_cpu(hub->descriptor->u.ss.DeviceRemovable)
2298 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
2303 udev->removable = USB_DEVICE_REMOVABLE;
2305 udev->removable = USB_DEVICE_FIXED;
2308 * Platform firmware may have populated an alternative value for
2309 * removable. If the parent port has a known connect_type use
2312 switch (hub->ports[udev->portnum - 1]->connect_type) {
2313 case USB_PORT_CONNECT_TYPE_HOT_PLUG:
2314 udev->removable = USB_DEVICE_REMOVABLE;
2316 case USB_PORT_CONNECT_TYPE_HARD_WIRED:
2317 udev->removable = USB_DEVICE_FIXED;
2319 default: /* use what was set above */
2325 * usb_new_device - perform initial device setup (usbcore-internal)
2326 * @udev: newly addressed device (in ADDRESS state)
2328 * This is called with devices which have been detected but not fully
2329 * enumerated. The device descriptor is available, but not descriptors
2330 * for any device configuration. The caller must have locked either
2331 * the parent hub (if udev is a normal device) or else the
2332 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
2333 * udev has already been installed, but udev is not yet visible through
2334 * sysfs or other filesystem code.
2336 * This call is synchronous, and may not be used in an interrupt context.
2338 * Only the hub driver or root-hub registrar should ever call this.
2340 * Return: Whether the device is configured properly or not. Zero if the
2341 * interface was registered with the driver core; else a negative errno
2345 int usb_new_device(struct usb_device *udev)
2350 /* Initialize non-root-hub device wakeup to disabled;
2351 * device (un)configuration controls wakeup capable
2352 * sysfs power/wakeup controls wakeup enabled/disabled
2354 device_init_wakeup(&udev->dev, 0);
2357 /* Tell the runtime-PM framework the device is active */
2358 pm_runtime_set_active(&udev->dev);
2359 pm_runtime_get_noresume(&udev->dev);
2360 pm_runtime_use_autosuspend(&udev->dev);
2361 pm_runtime_enable(&udev->dev);
2363 /* By default, forbid autosuspend for all devices. It will be
2364 * allowed for hubs during binding.
2366 usb_disable_autosuspend(udev);
2368 err = usb_enumerate_device(udev); /* Read descriptors */
2371 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
2372 udev->devnum, udev->bus->busnum,
2373 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2374 /* export the usbdev device-node for libusb */
2375 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
2376 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2378 /* Tell the world! */
2379 announce_device(udev);
2382 add_device_randomness(udev->serial, strlen(udev->serial));
2384 add_device_randomness(udev->product, strlen(udev->product));
2385 if (udev->manufacturer)
2386 add_device_randomness(udev->manufacturer,
2387 strlen(udev->manufacturer));
2389 device_enable_async_suspend(&udev->dev);
2391 /* check whether the hub or firmware marks this port as non-removable */
2393 set_usb_port_removable(udev);
2395 /* Register the device. The device driver is responsible
2396 * for configuring the device and invoking the add-device
2397 * notifier chain (used by usbfs and possibly others).
2399 err = device_add(&udev->dev);
2401 dev_err(&udev->dev, "can't device_add, error %d\n", err);
2405 /* Create link files between child device and usb port device. */
2407 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2408 int port1 = udev->portnum;
2409 struct usb_port *port_dev = hub->ports[port1 - 1];
2411 err = sysfs_create_link(&udev->dev.kobj,
2412 &port_dev->dev.kobj, "port");
2416 err = sysfs_create_link(&port_dev->dev.kobj,
2417 &udev->dev.kobj, "device");
2419 sysfs_remove_link(&udev->dev.kobj, "port");
2423 if (!test_and_set_bit(port1, hub->child_usage_bits))
2424 pm_runtime_get_sync(&port_dev->dev);
2427 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
2428 usb_mark_last_busy(udev);
2429 pm_runtime_put_sync_autosuspend(&udev->dev);
2433 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2434 pm_runtime_disable(&udev->dev);
2435 pm_runtime_set_suspended(&udev->dev);
2441 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2442 * @usb_dev: USB device
2444 * Move the USB device to a very basic state where interfaces are disabled
2445 * and the device is in fact unconfigured and unusable.
2447 * We share a lock (that we have) with device_del(), so we need to
2452 int usb_deauthorize_device(struct usb_device *usb_dev)
2454 usb_lock_device(usb_dev);
2455 if (usb_dev->authorized == 0)
2456 goto out_unauthorized;
2458 usb_dev->authorized = 0;
2459 usb_set_configuration(usb_dev, -1);
2462 usb_unlock_device(usb_dev);
2467 int usb_authorize_device(struct usb_device *usb_dev)
2471 usb_lock_device(usb_dev);
2472 if (usb_dev->authorized == 1)
2473 goto out_authorized;
2475 result = usb_autoresume_device(usb_dev);
2477 dev_err(&usb_dev->dev,
2478 "can't autoresume for authorization: %d\n", result);
2479 goto error_autoresume;
2481 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2483 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2484 "authorization: %d\n", result);
2485 goto error_device_descriptor;
2488 usb_dev->authorized = 1;
2489 /* Choose and set the configuration. This registers the interfaces
2490 * with the driver core and lets interface drivers bind to them.
2492 c = usb_choose_configuration(usb_dev);
2494 result = usb_set_configuration(usb_dev, c);
2496 dev_err(&usb_dev->dev,
2497 "can't set config #%d, error %d\n", c, result);
2498 /* This need not be fatal. The user can try to
2499 * set other configurations. */
2502 dev_info(&usb_dev->dev, "authorized to connect\n");
2504 error_device_descriptor:
2505 usb_autosuspend_device(usb_dev);
2508 usb_unlock_device(usb_dev); /* complements locktree */
2513 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2514 static unsigned hub_is_wusb(struct usb_hub *hub)
2516 struct usb_hcd *hcd;
2517 if (hub->hdev->parent != NULL) /* not a root hub? */
2519 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
2520 return hcd->wireless;
2524 #define PORT_RESET_TRIES 5
2525 #define SET_ADDRESS_TRIES 2
2526 #define GET_DESCRIPTOR_TRIES 2
2527 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2528 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2530 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2531 #define HUB_SHORT_RESET_TIME 10
2532 #define HUB_BH_RESET_TIME 50
2533 #define HUB_LONG_RESET_TIME 200
2534 #define HUB_RESET_TIMEOUT 800
2537 * "New scheme" enumeration causes an extra state transition to be
2538 * exposed to an xhci host and causes USB3 devices to receive control
2539 * commands in the default state. This has been seen to cause
2540 * enumeration failures, so disable this enumeration scheme for USB3
2543 static bool use_new_scheme(struct usb_device *udev, int retry)
2545 if (udev->speed == USB_SPEED_SUPER)
2548 return USE_NEW_SCHEME(retry);
2551 static int hub_port_reset(struct usb_hub *hub, int port1,
2552 struct usb_device *udev, unsigned int delay, bool warm);
2554 /* Is a USB 3.0 port in the Inactive or Compliance Mode state?
2555 * Port worm reset is required to recover
2557 static bool hub_port_warm_reset_required(struct usb_hub *hub, u16 portstatus)
2559 return hub_is_superspeed(hub->hdev) &&
2560 (((portstatus & USB_PORT_STAT_LINK_STATE) ==
2561 USB_SS_PORT_LS_SS_INACTIVE) ||
2562 ((portstatus & USB_PORT_STAT_LINK_STATE) ==
2563 USB_SS_PORT_LS_COMP_MOD)) ;
2566 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2567 struct usb_device *udev, unsigned int delay, bool warm)
2569 int delay_time, ret;
2573 for (delay_time = 0;
2574 delay_time < HUB_RESET_TIMEOUT;
2575 delay_time += delay) {
2576 /* wait to give the device a chance to reset */
2579 /* read and decode port status */
2580 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2584 /* The port state is unknown until the reset completes. */
2585 if (!(portstatus & USB_PORT_STAT_RESET))
2588 /* switch to the long delay after two short delay failures */
2589 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2590 delay = HUB_LONG_RESET_TIME;
2592 dev_dbg(&hub->ports[port1 - 1]->dev,
2593 "not %sreset yet, waiting %dms\n",
2594 warm ? "warm " : "", delay);
2597 if ((portstatus & USB_PORT_STAT_RESET))
2600 if (hub_port_warm_reset_required(hub, portstatus))
2603 /* Device went away? */
2604 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2607 /* bomb out completely if the connection bounced. A USB 3.0
2608 * connection may bounce if multiple warm resets were issued,
2609 * but the device may have successfully re-connected. Ignore it.
2611 if (!hub_is_superspeed(hub->hdev) &&
2612 (portchange & USB_PORT_STAT_C_CONNECTION))
2615 if (!(portstatus & USB_PORT_STAT_ENABLE))
2621 if (hub_is_wusb(hub))
2622 udev->speed = USB_SPEED_WIRELESS;
2623 else if (hub_is_superspeed(hub->hdev))
2624 udev->speed = USB_SPEED_SUPER;
2625 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2626 udev->speed = USB_SPEED_HIGH;
2627 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2628 udev->speed = USB_SPEED_LOW;
2630 udev->speed = USB_SPEED_FULL;
2634 static void hub_port_finish_reset(struct usb_hub *hub, int port1,
2635 struct usb_device *udev, int *status)
2639 /* TRSTRCY = 10 ms; plus some extra */
2642 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2644 update_devnum(udev, 0);
2645 /* The xHC may think the device is already reset,
2646 * so ignore the status.
2648 if (hcd->driver->reset_device)
2649 hcd->driver->reset_device(hcd, udev);
2654 usb_clear_port_feature(hub->hdev,
2655 port1, USB_PORT_FEAT_C_RESET);
2656 if (hub_is_superspeed(hub->hdev)) {
2657 usb_clear_port_feature(hub->hdev, port1,
2658 USB_PORT_FEAT_C_BH_PORT_RESET);
2659 usb_clear_port_feature(hub->hdev, port1,
2660 USB_PORT_FEAT_C_PORT_LINK_STATE);
2661 usb_clear_port_feature(hub->hdev, port1,
2662 USB_PORT_FEAT_C_CONNECTION);
2665 usb_set_device_state(udev, *status
2666 ? USB_STATE_NOTATTACHED
2667 : USB_STATE_DEFAULT);
2672 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2673 static int hub_port_reset(struct usb_hub *hub, int port1,
2674 struct usb_device *udev, unsigned int delay, bool warm)
2677 u16 portchange, portstatus;
2678 struct usb_port *port_dev = hub->ports[port1 - 1];
2680 if (!hub_is_superspeed(hub->hdev)) {
2682 dev_err(hub->intfdev, "only USB3 hub support "
2686 /* Block EHCI CF initialization during the port reset.
2687 * Some companion controllers don't like it when they mix.
2689 down_read(&ehci_cf_port_reset_rwsem);
2692 * If the caller hasn't explicitly requested a warm reset,
2693 * double check and see if one is needed.
2695 status = hub_port_status(hub, port1,
2696 &portstatus, &portchange);
2700 if (hub_port_warm_reset_required(hub, portstatus))
2704 /* Reset the port */
2705 for (i = 0; i < PORT_RESET_TRIES; i++) {
2706 status = set_port_feature(hub->hdev, port1, (warm ?
2707 USB_PORT_FEAT_BH_PORT_RESET :
2708 USB_PORT_FEAT_RESET));
2709 if (status == -ENODEV) {
2710 ; /* The hub is gone */
2711 } else if (status) {
2712 dev_err(&port_dev->dev,
2713 "cannot %sreset (err = %d)\n",
2714 warm ? "warm " : "", status);
2716 status = hub_port_wait_reset(hub, port1, udev, delay,
2718 if (status && status != -ENOTCONN && status != -ENODEV)
2719 dev_dbg(hub->intfdev,
2720 "port_wait_reset: err = %d\n",
2724 /* Check for disconnect or reset */
2725 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2726 hub_port_finish_reset(hub, port1, udev, &status);
2728 if (!hub_is_superspeed(hub->hdev))
2732 * If a USB 3.0 device migrates from reset to an error
2733 * state, re-issue the warm reset.
2735 if (hub_port_status(hub, port1,
2736 &portstatus, &portchange) < 0)
2739 if (!hub_port_warm_reset_required(hub, portstatus))
2743 * If the port is in SS.Inactive or Compliance Mode, the
2744 * hot or warm reset failed. Try another warm reset.
2747 dev_dbg(&port_dev->dev,
2748 "hot reset failed, warm reset\n");
2753 dev_dbg(&port_dev->dev,
2754 "not enabled, trying %sreset again...\n",
2755 warm ? "warm " : "");
2756 delay = HUB_LONG_RESET_TIME;
2759 dev_err(&port_dev->dev, "Cannot enable. Maybe the USB cable is bad?\n");
2762 if (!hub_is_superspeed(hub->hdev))
2763 up_read(&ehci_cf_port_reset_rwsem);
2768 /* Check if a port is power on */
2769 static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2773 if (hub_is_superspeed(hub->hdev)) {
2774 if (portstatus & USB_SS_PORT_STAT_POWER)
2777 if (portstatus & USB_PORT_STAT_POWER)
2786 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2787 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
2791 if (hub_is_superspeed(hub->hdev)) {
2792 if ((portstatus & USB_PORT_STAT_LINK_STATE)
2793 == USB_SS_PORT_LS_U3)
2796 if (portstatus & USB_PORT_STAT_SUSPEND)
2803 /* Determine whether the device on a port is ready for a normal resume,
2804 * is ready for a reset-resume, or should be disconnected.
2806 static int check_port_resume_type(struct usb_device *udev,
2807 struct usb_hub *hub, int port1,
2808 int status, unsigned portchange, unsigned portstatus)
2810 struct usb_port *port_dev = hub->ports[port1 - 1];
2812 /* Is the device still present? */
2813 if (status || port_is_suspended(hub, portstatus) ||
2814 !port_is_power_on(hub, portstatus) ||
2815 !(portstatus & USB_PORT_STAT_CONNECTION)) {
2820 /* Can't do a normal resume if the port isn't enabled,
2821 * so try a reset-resume instead.
2823 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2824 if (udev->persist_enabled)
2825 udev->reset_resume = 1;
2831 dev_dbg(&port_dev->dev, "status %04x.%04x after resume, %d\n",
2832 portchange, portstatus, status);
2833 } else if (udev->reset_resume) {
2835 /* Late port handoff can set status-change bits */
2836 if (portchange & USB_PORT_STAT_C_CONNECTION)
2837 usb_clear_port_feature(hub->hdev, port1,
2838 USB_PORT_FEAT_C_CONNECTION);
2839 if (portchange & USB_PORT_STAT_C_ENABLE)
2840 usb_clear_port_feature(hub->hdev, port1,
2841 USB_PORT_FEAT_C_ENABLE);
2847 int usb_disable_ltm(struct usb_device *udev)
2849 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2851 /* Check if the roothub and device supports LTM. */
2852 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
2853 !usb_device_supports_ltm(udev))
2856 /* Clear Feature LTM Enable can only be sent if the device is
2859 if (!udev->actconfig)
2862 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2863 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2864 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
2865 USB_CTRL_SET_TIMEOUT);
2867 EXPORT_SYMBOL_GPL(usb_disable_ltm);
2869 void usb_enable_ltm(struct usb_device *udev)
2871 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2873 /* Check if the roothub and device supports LTM. */
2874 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
2875 !usb_device_supports_ltm(udev))
2878 /* Set Feature LTM Enable can only be sent if the device is
2881 if (!udev->actconfig)
2884 usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2885 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2886 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
2887 USB_CTRL_SET_TIMEOUT);
2889 EXPORT_SYMBOL_GPL(usb_enable_ltm);
2892 * usb_enable_remote_wakeup - enable remote wakeup for a device
2893 * @udev: target device
2895 * For USB-2 devices: Set the device's remote wakeup feature.
2897 * For USB-3 devices: Assume there's only one function on the device and
2898 * enable remote wake for the first interface. FIXME if the interface
2899 * association descriptor shows there's more than one function.
2901 static int usb_enable_remote_wakeup(struct usb_device *udev)
2903 if (udev->speed < USB_SPEED_SUPER)
2904 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2905 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2906 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
2907 USB_CTRL_SET_TIMEOUT);
2909 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2910 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
2911 USB_INTRF_FUNC_SUSPEND,
2912 USB_INTRF_FUNC_SUSPEND_RW |
2913 USB_INTRF_FUNC_SUSPEND_LP,
2914 NULL, 0, USB_CTRL_SET_TIMEOUT);
2918 * usb_disable_remote_wakeup - disable remote wakeup for a device
2919 * @udev: target device
2921 * For USB-2 devices: Clear the device's remote wakeup feature.
2923 * For USB-3 devices: Assume there's only one function on the device and
2924 * disable remote wake for the first interface. FIXME if the interface
2925 * association descriptor shows there's more than one function.
2927 static int usb_disable_remote_wakeup(struct usb_device *udev)
2929 if (udev->speed < USB_SPEED_SUPER)
2930 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2931 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2932 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
2933 USB_CTRL_SET_TIMEOUT);
2935 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2936 USB_REQ_CLEAR_FEATURE, USB_RECIP_INTERFACE,
2937 USB_INTRF_FUNC_SUSPEND, 0, NULL, 0,
2938 USB_CTRL_SET_TIMEOUT);
2941 /* Count of wakeup-enabled devices at or below udev */
2942 static unsigned wakeup_enabled_descendants(struct usb_device *udev)
2944 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2946 return udev->do_remote_wakeup +
2947 (hub ? hub->wakeup_enabled_descendants : 0);
2951 * usb_port_suspend - suspend a usb device's upstream port
2952 * @udev: device that's no longer in active use, not a root hub
2953 * Context: must be able to sleep; device not locked; pm locks held
2955 * Suspends a USB device that isn't in active use, conserving power.
2956 * Devices may wake out of a suspend, if anything important happens,
2957 * using the remote wakeup mechanism. They may also be taken out of
2958 * suspend by the host, using usb_port_resume(). It's also routine
2959 * to disconnect devices while they are suspended.
2961 * This only affects the USB hardware for a device; its interfaces
2962 * (and, for hubs, child devices) must already have been suspended.
2964 * Selective port suspend reduces power; most suspended devices draw
2965 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2966 * All devices below the suspended port are also suspended.
2968 * Devices leave suspend state when the host wakes them up. Some devices
2969 * also support "remote wakeup", where the device can activate the USB
2970 * tree above them to deliver data, such as a keypress or packet. In
2971 * some cases, this wakes the USB host.
2973 * Suspending OTG devices may trigger HNP, if that's been enabled
2974 * between a pair of dual-role devices. That will change roles, such
2975 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2977 * Devices on USB hub ports have only one "suspend" state, corresponding
2978 * to ACPI D2, "may cause the device to lose some context".
2979 * State transitions include:
2981 * - suspend, resume ... when the VBUS power link stays live
2982 * - suspend, disconnect ... VBUS lost
2984 * Once VBUS drop breaks the circuit, the port it's using has to go through
2985 * normal re-enumeration procedures, starting with enabling VBUS power.
2986 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2987 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2988 * timer, no SRP, no requests through sysfs.
2990 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
2991 * suspended until their bus goes into global suspend (i.e., the root
2992 * hub is suspended). Nevertheless, we change @udev->state to
2993 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
2994 * upstream port setting is stored in @udev->port_is_suspended.
2996 * Returns 0 on success, else negative errno.
2998 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
3000 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3001 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3002 int port1 = udev->portnum;
3004 bool really_suspend = true;
3006 /* enable remote wakeup when appropriate; this lets the device
3007 * wake up the upstream hub (including maybe the root hub).
3009 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
3010 * we don't explicitly enable it here.
3012 if (udev->do_remote_wakeup) {
3013 status = usb_enable_remote_wakeup(udev);
3015 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
3017 /* bail if autosuspend is requested */
3018 if (PMSG_IS_AUTO(msg))
3023 /* disable USB2 hardware LPM */
3024 if (udev->usb2_hw_lpm_enabled == 1)
3025 usb_set_usb2_hardware_lpm(udev, 0);
3027 if (usb_disable_ltm(udev)) {
3028 dev_err(&udev->dev, "Failed to disable LTM before suspend\n.");
3030 if (PMSG_IS_AUTO(msg))
3033 if (usb_unlocked_disable_lpm(udev)) {
3034 dev_err(&udev->dev, "Failed to disable LPM before suspend\n.");
3036 if (PMSG_IS_AUTO(msg))
3041 if (hub_is_superspeed(hub->hdev))
3042 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U3);
3045 * For system suspend, we do not need to enable the suspend feature
3046 * on individual USB-2 ports. The devices will automatically go
3047 * into suspend a few ms after the root hub stops sending packets.
3048 * The USB 2.0 spec calls this "global suspend".
3050 * However, many USB hubs have a bug: They don't relay wakeup requests
3051 * from a downstream port if the port's suspend feature isn't on.
3052 * Therefore we will turn on the suspend feature if udev or any of its
3053 * descendants is enabled for remote wakeup.
3055 else if (PMSG_IS_AUTO(msg) || wakeup_enabled_descendants(udev) > 0)
3056 status = set_port_feature(hub->hdev, port1,
3057 USB_PORT_FEAT_SUSPEND);
3059 really_suspend = false;
3063 dev_dbg(&port_dev->dev, "can't suspend, status %d\n", status);
3065 /* Try to enable USB3 LPM and LTM again */
3066 usb_unlocked_enable_lpm(udev);
3068 usb_enable_ltm(udev);
3070 /* Try to enable USB2 hardware LPM again */
3071 if (udev->usb2_hw_lpm_capable == 1)
3072 usb_set_usb2_hardware_lpm(udev, 1);
3074 if (udev->do_remote_wakeup)
3075 (void) usb_disable_remote_wakeup(udev);
3078 /* System sleep transitions should never fail */
3079 if (!PMSG_IS_AUTO(msg))
3082 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
3083 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
3084 udev->do_remote_wakeup);
3085 if (really_suspend) {
3086 udev->port_is_suspended = 1;
3088 /* device has up to 10 msec to fully suspend */
3091 usb_set_device_state(udev, USB_STATE_SUSPENDED);
3094 if (status == 0 && !udev->do_remote_wakeup && udev->persist_enabled
3095 && test_and_clear_bit(port1, hub->child_usage_bits))
3096 pm_runtime_put_sync(&port_dev->dev);
3098 usb_mark_last_busy(hub->hdev);
3103 * If the USB "suspend" state is in use (rather than "global suspend"),
3104 * many devices will be individually taken out of suspend state using
3105 * special "resume" signaling. This routine kicks in shortly after
3106 * hardware resume signaling is finished, either because of selective
3107 * resume (by host) or remote wakeup (by device) ... now see what changed
3108 * in the tree that's rooted at this device.
3110 * If @udev->reset_resume is set then the device is reset before the
3111 * status check is done.
3113 static int finish_port_resume(struct usb_device *udev)
3118 /* caller owns the udev device lock */
3119 dev_dbg(&udev->dev, "%s\n",
3120 udev->reset_resume ? "finish reset-resume" : "finish resume");
3122 /* usb ch9 identifies four variants of SUSPENDED, based on what
3123 * state the device resumes to. Linux currently won't see the
3124 * first two on the host side; they'd be inside hub_port_init()
3125 * during many timeouts, but khubd can't suspend until later.
3127 usb_set_device_state(udev, udev->actconfig
3128 ? USB_STATE_CONFIGURED
3129 : USB_STATE_ADDRESS);
3131 /* 10.5.4.5 says not to reset a suspended port if the attached
3132 * device is enabled for remote wakeup. Hence the reset
3133 * operation is carried out here, after the port has been
3136 if (udev->reset_resume) {
3138 * If the device morphs or switches modes when it is reset,
3139 * we don't want to perform a reset-resume. We'll fail the
3140 * resume, which will cause a logical disconnect, and then
3141 * the device will be rediscovered.
3144 if (udev->quirks & USB_QUIRK_RESET)
3147 status = usb_reset_and_verify_device(udev);
3150 /* 10.5.4.5 says be sure devices in the tree are still there.
3151 * For now let's assume the device didn't go crazy on resume,
3152 * and device drivers will know about any resume quirks.
3156 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
3158 /* If a normal resume failed, try doing a reset-resume */
3159 if (status && !udev->reset_resume && udev->persist_enabled) {
3160 dev_dbg(&udev->dev, "retry with reset-resume\n");
3161 udev->reset_resume = 1;
3162 goto retry_reset_resume;
3167 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
3170 * There are a few quirky devices which violate the standard
3171 * by claiming to have remote wakeup enabled after a reset,
3172 * which crash if the feature is cleared, hence check for
3173 * udev->reset_resume
3175 } else if (udev->actconfig && !udev->reset_resume) {
3176 if (udev->speed < USB_SPEED_SUPER) {
3177 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
3178 status = usb_disable_remote_wakeup(udev);
3180 status = usb_get_status(udev, USB_RECIP_INTERFACE, 0,
3182 if (!status && devstatus & (USB_INTRF_STAT_FUNC_RW_CAP
3183 | USB_INTRF_STAT_FUNC_RW))
3184 status = usb_disable_remote_wakeup(udev);
3189 "disable remote wakeup, status %d\n",
3197 * usb_port_resume - re-activate a suspended usb device's upstream port
3198 * @udev: device to re-activate, not a root hub
3199 * Context: must be able to sleep; device not locked; pm locks held
3201 * This will re-activate the suspended device, increasing power usage
3202 * while letting drivers communicate again with its endpoints.
3203 * USB resume explicitly guarantees that the power session between
3204 * the host and the device is the same as it was when the device
3207 * If @udev->reset_resume is set then this routine won't check that the
3208 * port is still enabled. Furthermore, finish_port_resume() above will
3209 * reset @udev. The end result is that a broken power session can be
3210 * recovered and @udev will appear to persist across a loss of VBUS power.
3212 * For example, if a host controller doesn't maintain VBUS suspend current
3213 * during a system sleep or is reset when the system wakes up, all the USB
3214 * power sessions below it will be broken. This is especially troublesome
3215 * for mass-storage devices containing mounted filesystems, since the
3216 * device will appear to have disconnected and all the memory mappings
3217 * to it will be lost. Using the USB_PERSIST facility, the device can be
3218 * made to appear as if it had not disconnected.
3220 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3221 * every effort to insure that the same device is present after the
3222 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3223 * quite possible for a device to remain unaltered but its media to be
3224 * changed. If the user replaces a flash memory card while the system is
3225 * asleep, he will have only himself to blame when the filesystem on the
3226 * new card is corrupted and the system crashes.
3228 * Returns 0 on success, else negative errno.
3230 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
3232 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3233 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3234 int port1 = udev->portnum;
3236 u16 portchange, portstatus;
3238 if (!test_and_set_bit(port1, hub->child_usage_bits)) {
3239 status = pm_runtime_get_sync(&port_dev->dev);
3241 dev_dbg(&udev->dev, "can't resume usb port, status %d\n",
3247 /* Skip the initial Clear-Suspend step for a remote wakeup */
3248 status = hub_port_status(hub, port1, &portstatus, &portchange);
3249 if (status == 0 && !port_is_suspended(hub, portstatus))
3250 goto SuspendCleared;
3252 set_bit(port1, hub->busy_bits);
3254 /* see 7.1.7.7; affects power usage, but not budgeting */
3255 if (hub_is_superspeed(hub->hdev))
3256 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U0);
3258 status = usb_clear_port_feature(hub->hdev,
3259 port1, USB_PORT_FEAT_SUSPEND);
3261 dev_dbg(&port_dev->dev, "can't resume, status %d\n", status);
3263 /* drive resume for at least 20 msec */
3264 dev_dbg(&udev->dev, "usb %sresume\n",
3265 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
3268 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3269 * stop resume signaling. Then finish the resume
3272 status = hub_port_status(hub, port1, &portstatus, &portchange);
3274 /* TRSMRCY = 10 msec */
3280 udev->port_is_suspended = 0;
3281 if (hub_is_superspeed(hub->hdev)) {
3282 if (portchange & USB_PORT_STAT_C_LINK_STATE)
3283 usb_clear_port_feature(hub->hdev, port1,
3284 USB_PORT_FEAT_C_PORT_LINK_STATE);
3286 if (portchange & USB_PORT_STAT_C_SUSPEND)
3287 usb_clear_port_feature(hub->hdev, port1,
3288 USB_PORT_FEAT_C_SUSPEND);
3292 clear_bit(port1, hub->busy_bits);
3294 status = check_port_resume_type(udev,
3295 hub, port1, status, portchange, portstatus);
3297 status = finish_port_resume(udev);
3299 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
3300 hub_port_logical_disconnect(hub, port1);
3302 /* Try to enable USB2 hardware LPM */
3303 if (udev->usb2_hw_lpm_capable == 1)
3304 usb_set_usb2_hardware_lpm(udev, 1);
3306 /* Try to enable USB3 LTM and LPM */
3307 usb_enable_ltm(udev);
3308 usb_unlocked_enable_lpm(udev);
3314 #ifdef CONFIG_PM_RUNTIME
3316 /* caller has locked udev */
3317 int usb_remote_wakeup(struct usb_device *udev)
3321 if (udev->state == USB_STATE_SUSPENDED) {
3322 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
3323 status = usb_autoresume_device(udev);
3325 /* Let the drivers do their thing, then... */
3326 usb_autosuspend_device(udev);
3334 static int check_ports_changed(struct usb_hub *hub)
3338 for (port1 = 1; port1 <= hub->hdev->maxchild; ++port1) {
3339 u16 portstatus, portchange;
3342 status = hub_port_status(hub, port1, &portstatus, &portchange);
3343 if (!status && portchange)
3349 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
3351 struct usb_hub *hub = usb_get_intfdata (intf);
3352 struct usb_device *hdev = hub->hdev;
3357 * Warn if children aren't already suspended.
3358 * Also, add up the number of wakeup-enabled descendants.
3360 hub->wakeup_enabled_descendants = 0;
3361 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3362 struct usb_port *port_dev = hub->ports[port1 - 1];
3363 struct usb_device *udev = port_dev->child;
3365 if (udev && udev->can_submit) {
3366 dev_warn(&port_dev->dev, "not suspended yet\n");
3367 if (PMSG_IS_AUTO(msg))
3371 hub->wakeup_enabled_descendants +=
3372 wakeup_enabled_descendants(udev);
3375 if (hdev->do_remote_wakeup && hub->quirk_check_port_auto_suspend) {
3376 /* check if there are changes pending on hub ports */
3377 if (check_ports_changed(hub)) {
3378 if (PMSG_IS_AUTO(msg))
3380 pm_wakeup_event(&hdev->dev, 2000);
3384 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
3385 /* Enable hub to send remote wakeup for all ports. */
3386 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3387 status = set_port_feature(hdev,
3389 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
3390 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
3391 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
3392 USB_PORT_FEAT_REMOTE_WAKE_MASK);
3396 dev_dbg(&intf->dev, "%s\n", __func__);
3398 /* stop khubd and related activity */
3399 hub_quiesce(hub, HUB_SUSPEND);
3403 static int hub_resume(struct usb_interface *intf)
3405 struct usb_hub *hub = usb_get_intfdata(intf);
3407 dev_dbg(&intf->dev, "%s\n", __func__);
3408 hub_activate(hub, HUB_RESUME);
3412 static int hub_reset_resume(struct usb_interface *intf)
3414 struct usb_hub *hub = usb_get_intfdata(intf);
3416 dev_dbg(&intf->dev, "%s\n", __func__);
3417 hub_activate(hub, HUB_RESET_RESUME);
3422 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3423 * @rhdev: struct usb_device for the root hub
3425 * The USB host controller driver calls this function when its root hub
3426 * is resumed and Vbus power has been interrupted or the controller
3427 * has been reset. The routine marks @rhdev as having lost power.
3428 * When the hub driver is resumed it will take notice and carry out
3429 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3430 * the others will be disconnected.
3432 void usb_root_hub_lost_power(struct usb_device *rhdev)
3434 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
3435 rhdev->reset_resume = 1;
3437 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
3439 static const char * const usb3_lpm_names[] = {
3447 * Send a Set SEL control transfer to the device, prior to enabling
3448 * device-initiated U1 or U2. This lets the device know the exit latencies from
3449 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3450 * packet from the host.
3452 * This function will fail if the SEL or PEL values for udev are greater than
3453 * the maximum allowed values for the link state to be enabled.
3455 static int usb_req_set_sel(struct usb_device *udev, enum usb3_link_state state)
3457 struct usb_set_sel_req *sel_values;
3458 unsigned long long u1_sel;
3459 unsigned long long u1_pel;
3460 unsigned long long u2_sel;
3461 unsigned long long u2_pel;
3464 if (udev->state != USB_STATE_CONFIGURED)
3467 /* Convert SEL and PEL stored in ns to us */
3468 u1_sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
3469 u1_pel = DIV_ROUND_UP(udev->u1_params.pel, 1000);
3470 u2_sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
3471 u2_pel = DIV_ROUND_UP(udev->u2_params.pel, 1000);
3474 * Make sure that the calculated SEL and PEL values for the link
3475 * state we're enabling aren't bigger than the max SEL/PEL
3476 * value that will fit in the SET SEL control transfer.
3477 * Otherwise the device would get an incorrect idea of the exit
3478 * latency for the link state, and could start a device-initiated
3479 * U1/U2 when the exit latencies are too high.
3481 if ((state == USB3_LPM_U1 &&
3482 (u1_sel > USB3_LPM_MAX_U1_SEL_PEL ||
3483 u1_pel > USB3_LPM_MAX_U1_SEL_PEL)) ||
3484 (state == USB3_LPM_U2 &&
3485 (u2_sel > USB3_LPM_MAX_U2_SEL_PEL ||
3486 u2_pel > USB3_LPM_MAX_U2_SEL_PEL))) {
3487 dev_dbg(&udev->dev, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3488 usb3_lpm_names[state], u1_sel, u1_pel);
3493 * If we're enabling device-initiated LPM for one link state,
3494 * but the other link state has a too high SEL or PEL value,
3495 * just set those values to the max in the Set SEL request.
3497 if (u1_sel > USB3_LPM_MAX_U1_SEL_PEL)
3498 u1_sel = USB3_LPM_MAX_U1_SEL_PEL;
3500 if (u1_pel > USB3_LPM_MAX_U1_SEL_PEL)
3501 u1_pel = USB3_LPM_MAX_U1_SEL_PEL;
3503 if (u2_sel > USB3_LPM_MAX_U2_SEL_PEL)
3504 u2_sel = USB3_LPM_MAX_U2_SEL_PEL;
3506 if (u2_pel > USB3_LPM_MAX_U2_SEL_PEL)
3507 u2_pel = USB3_LPM_MAX_U2_SEL_PEL;
3510 * usb_enable_lpm() can be called as part of a failed device reset,
3511 * which may be initiated by an error path of a mass storage driver.
3512 * Therefore, use GFP_NOIO.
3514 sel_values = kmalloc(sizeof *(sel_values), GFP_NOIO);
3518 sel_values->u1_sel = u1_sel;
3519 sel_values->u1_pel = u1_pel;
3520 sel_values->u2_sel = cpu_to_le16(u2_sel);
3521 sel_values->u2_pel = cpu_to_le16(u2_pel);
3523 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3527 sel_values, sizeof *(sel_values),
3528 USB_CTRL_SET_TIMEOUT);
3534 * Enable or disable device-initiated U1 or U2 transitions.
3536 static int usb_set_device_initiated_lpm(struct usb_device *udev,
3537 enum usb3_link_state state, bool enable)
3544 feature = USB_DEVICE_U1_ENABLE;
3547 feature = USB_DEVICE_U2_ENABLE;
3550 dev_warn(&udev->dev, "%s: Can't %s non-U1 or U2 state.\n",
3551 __func__, enable ? "enable" : "disable");
3555 if (udev->state != USB_STATE_CONFIGURED) {
3556 dev_dbg(&udev->dev, "%s: Can't %s %s state "
3557 "for unconfigured device.\n",
3558 __func__, enable ? "enable" : "disable",
3559 usb3_lpm_names[state]);
3565 * Now send the control transfer to enable device-initiated LPM
3566 * for either U1 or U2.
3568 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3569 USB_REQ_SET_FEATURE,
3573 USB_CTRL_SET_TIMEOUT);
3575 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3576 USB_REQ_CLEAR_FEATURE,
3580 USB_CTRL_SET_TIMEOUT);
3583 dev_warn(&udev->dev, "%s of device-initiated %s failed.\n",
3584 enable ? "Enable" : "Disable",
3585 usb3_lpm_names[state]);
3591 static int usb_set_lpm_timeout(struct usb_device *udev,
3592 enum usb3_link_state state, int timeout)
3599 feature = USB_PORT_FEAT_U1_TIMEOUT;
3602 feature = USB_PORT_FEAT_U2_TIMEOUT;
3605 dev_warn(&udev->dev, "%s: Can't set timeout for non-U1 or U2 state.\n",
3610 if (state == USB3_LPM_U1 && timeout > USB3_LPM_U1_MAX_TIMEOUT &&
3611 timeout != USB3_LPM_DEVICE_INITIATED) {
3612 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x, "
3613 "which is a reserved value.\n",
3614 usb3_lpm_names[state], timeout);
3618 ret = set_port_feature(udev->parent,
3619 USB_PORT_LPM_TIMEOUT(timeout) | udev->portnum,
3622 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x,"
3623 "error code %i\n", usb3_lpm_names[state],
3627 if (state == USB3_LPM_U1)
3628 udev->u1_params.timeout = timeout;
3630 udev->u2_params.timeout = timeout;
3635 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3638 * We will attempt to enable U1 or U2, but there are no guarantees that the
3639 * control transfers to set the hub timeout or enable device-initiated U1/U2
3640 * will be successful.
3642 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3643 * driver know about it. If that call fails, it should be harmless, and just
3644 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3646 static void usb_enable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3647 enum usb3_link_state state)
3650 __u8 u1_mel = udev->bos->ss_cap->bU1devExitLat;
3651 __le16 u2_mel = udev->bos->ss_cap->bU2DevExitLat;
3653 /* If the device says it doesn't have *any* exit latency to come out of
3654 * U1 or U2, it's probably lying. Assume it doesn't implement that link
3657 if ((state == USB3_LPM_U1 && u1_mel == 0) ||
3658 (state == USB3_LPM_U2 && u2_mel == 0))
3662 * First, let the device know about the exit latencies
3663 * associated with the link state we're about to enable.
3665 ret = usb_req_set_sel(udev, state);
3667 dev_warn(&udev->dev, "Set SEL for device-initiated %s failed.\n",
3668 usb3_lpm_names[state]);
3672 /* We allow the host controller to set the U1/U2 timeout internally
3673 * first, so that it can change its schedule to account for the
3674 * additional latency to send data to a device in a lower power
3677 timeout = hcd->driver->enable_usb3_lpm_timeout(hcd, udev, state);
3679 /* xHCI host controller doesn't want to enable this LPM state. */
3684 dev_warn(&udev->dev, "Could not enable %s link state, "
3685 "xHCI error %i.\n", usb3_lpm_names[state],
3690 if (usb_set_lpm_timeout(udev, state, timeout))
3691 /* If we can't set the parent hub U1/U2 timeout,
3692 * device-initiated LPM won't be allowed either, so let the xHCI
3693 * host know that this link state won't be enabled.
3695 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
3697 /* Only a configured device will accept the Set Feature U1/U2_ENABLE */
3698 else if (udev->actconfig)
3699 usb_set_device_initiated_lpm(udev, state, true);
3704 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
3707 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
3708 * If zero is returned, the parent will not allow the link to go into U1/U2.
3710 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
3711 * it won't have an effect on the bus link state because the parent hub will
3712 * still disallow device-initiated U1/U2 entry.
3714 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
3715 * possible. The result will be slightly more bus bandwidth will be taken up
3716 * (to account for U1/U2 exit latency), but it should be harmless.
3718 static int usb_disable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3719 enum usb3_link_state state)
3725 feature = USB_PORT_FEAT_U1_TIMEOUT;
3728 feature = USB_PORT_FEAT_U2_TIMEOUT;
3731 dev_warn(&udev->dev, "%s: Can't disable non-U1 or U2 state.\n",
3736 if (usb_set_lpm_timeout(udev, state, 0))
3739 usb_set_device_initiated_lpm(udev, state, false);
3741 if (hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state))
3742 dev_warn(&udev->dev, "Could not disable xHCI %s timeout, "
3743 "bus schedule bandwidth may be impacted.\n",
3744 usb3_lpm_names[state]);
3749 * Disable hub-initiated and device-initiated U1 and U2 entry.
3750 * Caller must own the bandwidth_mutex.
3752 * This will call usb_enable_lpm() on failure, which will decrement
3753 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
3755 int usb_disable_lpm(struct usb_device *udev)
3757 struct usb_hcd *hcd;
3759 if (!udev || !udev->parent ||
3760 udev->speed != USB_SPEED_SUPER ||
3764 hcd = bus_to_hcd(udev->bus);
3765 if (!hcd || !hcd->driver->disable_usb3_lpm_timeout)
3768 udev->lpm_disable_count++;
3769 if ((udev->u1_params.timeout == 0 && udev->u2_params.timeout == 0))
3772 /* If LPM is enabled, attempt to disable it. */
3773 if (usb_disable_link_state(hcd, udev, USB3_LPM_U1))
3775 if (usb_disable_link_state(hcd, udev, USB3_LPM_U2))
3781 usb_enable_lpm(udev);
3784 EXPORT_SYMBOL_GPL(usb_disable_lpm);
3786 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
3787 int usb_unlocked_disable_lpm(struct usb_device *udev)
3789 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3795 mutex_lock(hcd->bandwidth_mutex);
3796 ret = usb_disable_lpm(udev);
3797 mutex_unlock(hcd->bandwidth_mutex);
3801 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
3804 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
3805 * xHCI host policy may prevent U1 or U2 from being enabled.
3807 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
3808 * until the lpm_disable_count drops to zero. Caller must own the
3811 void usb_enable_lpm(struct usb_device *udev)
3813 struct usb_hcd *hcd;
3815 if (!udev || !udev->parent ||
3816 udev->speed != USB_SPEED_SUPER ||
3820 udev->lpm_disable_count--;
3821 hcd = bus_to_hcd(udev->bus);
3822 /* Double check that we can both enable and disable LPM.
3823 * Device must be configured to accept set feature U1/U2 timeout.
3825 if (!hcd || !hcd->driver->enable_usb3_lpm_timeout ||
3826 !hcd->driver->disable_usb3_lpm_timeout)
3829 if (udev->lpm_disable_count > 0)
3832 usb_enable_link_state(hcd, udev, USB3_LPM_U1);
3833 usb_enable_link_state(hcd, udev, USB3_LPM_U2);
3835 EXPORT_SYMBOL_GPL(usb_enable_lpm);
3837 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
3838 void usb_unlocked_enable_lpm(struct usb_device *udev)
3840 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3845 mutex_lock(hcd->bandwidth_mutex);
3846 usb_enable_lpm(udev);
3847 mutex_unlock(hcd->bandwidth_mutex);
3849 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
3852 #else /* CONFIG_PM */
3854 #define hub_suspend NULL
3855 #define hub_resume NULL
3856 #define hub_reset_resume NULL
3858 int usb_disable_lpm(struct usb_device *udev)
3862 EXPORT_SYMBOL_GPL(usb_disable_lpm);
3864 void usb_enable_lpm(struct usb_device *udev) { }
3865 EXPORT_SYMBOL_GPL(usb_enable_lpm);
3867 int usb_unlocked_disable_lpm(struct usb_device *udev)
3871 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
3873 void usb_unlocked_enable_lpm(struct usb_device *udev) { }
3874 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
3876 int usb_disable_ltm(struct usb_device *udev)
3880 EXPORT_SYMBOL_GPL(usb_disable_ltm);
3882 void usb_enable_ltm(struct usb_device *udev) { }
3883 EXPORT_SYMBOL_GPL(usb_enable_ltm);
3885 #endif /* CONFIG_PM */
3888 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
3890 * Between connect detection and reset signaling there must be a delay
3891 * of 100ms at least for debounce and power-settling. The corresponding
3892 * timer shall restart whenever the downstream port detects a disconnect.
3894 * Apparently there are some bluetooth and irda-dongles and a number of
3895 * low-speed devices for which this debounce period may last over a second.
3896 * Not covered by the spec - but easy to deal with.
3898 * This implementation uses a 1500ms total debounce timeout; if the
3899 * connection isn't stable by then it returns -ETIMEDOUT. It checks
3900 * every 25ms for transient disconnects. When the port status has been
3901 * unchanged for 100ms it returns the port status.
3903 int hub_port_debounce(struct usb_hub *hub, int port1, bool must_be_connected)
3906 u16 portchange, portstatus;
3907 unsigned connection = 0xffff;
3908 int total_time, stable_time = 0;
3909 struct usb_port *port_dev = hub->ports[port1 - 1];
3911 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
3912 ret = hub_port_status(hub, port1, &portstatus, &portchange);
3916 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
3917 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
3918 if (!must_be_connected ||
3919 (connection == USB_PORT_STAT_CONNECTION))
3920 stable_time += HUB_DEBOUNCE_STEP;
3921 if (stable_time >= HUB_DEBOUNCE_STABLE)
3925 connection = portstatus & USB_PORT_STAT_CONNECTION;
3928 if (portchange & USB_PORT_STAT_C_CONNECTION) {
3929 usb_clear_port_feature(hub->hdev, port1,
3930 USB_PORT_FEAT_C_CONNECTION);
3933 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
3935 msleep(HUB_DEBOUNCE_STEP);
3938 dev_dbg(&port_dev->dev, "debounce total %dms stable %dms status 0x%x\n",
3939 total_time, stable_time, portstatus);
3941 if (stable_time < HUB_DEBOUNCE_STABLE)
3946 void usb_ep0_reinit(struct usb_device *udev)
3948 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
3949 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
3950 usb_enable_endpoint(udev, &udev->ep0, true);
3952 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
3954 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
3955 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
3957 static int hub_set_address(struct usb_device *udev, int devnum)
3960 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3963 * The host controller will choose the device address,
3964 * instead of the core having chosen it earlier
3966 if (!hcd->driver->address_device && devnum <= 1)
3968 if (udev->state == USB_STATE_ADDRESS)
3970 if (udev->state != USB_STATE_DEFAULT)
3972 if (hcd->driver->address_device)
3973 retval = hcd->driver->address_device(hcd, udev);
3975 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
3976 USB_REQ_SET_ADDRESS, 0, devnum, 0,
3977 NULL, 0, USB_CTRL_SET_TIMEOUT);
3979 update_devnum(udev, devnum);
3980 /* Device now using proper address. */
3981 usb_set_device_state(udev, USB_STATE_ADDRESS);
3982 usb_ep0_reinit(udev);
3988 * There are reports of USB 3.0 devices that say they support USB 2.0 Link PM
3989 * when they're plugged into a USB 2.0 port, but they don't work when LPM is
3992 * Only enable USB 2.0 Link PM if the port is internal (hardwired), or the
3993 * device says it supports the new USB 2.0 Link PM errata by setting the BESL
3994 * support bit in the BOS descriptor.
3996 static void hub_set_initial_usb2_lpm_policy(struct usb_device *udev)
3998 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3999 int connect_type = USB_PORT_CONNECT_TYPE_UNKNOWN;
4001 if (!udev->usb2_hw_lpm_capable)
4005 connect_type = hub->ports[udev->portnum - 1]->connect_type;
4007 if ((udev->bos->ext_cap->bmAttributes & cpu_to_le32(USB_BESL_SUPPORT)) ||
4008 connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
4009 udev->usb2_hw_lpm_allowed = 1;
4010 usb_set_usb2_hardware_lpm(udev, 1);
4014 static int hub_enable_device(struct usb_device *udev)
4016 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4018 if (!hcd->driver->enable_device)
4020 if (udev->state == USB_STATE_ADDRESS)
4022 if (udev->state != USB_STATE_DEFAULT)
4025 return hcd->driver->enable_device(hcd, udev);
4028 /* Reset device, (re)assign address, get device descriptor.
4029 * Device connection must be stable, no more debouncing needed.
4030 * Returns device in USB_STATE_ADDRESS, except on error.
4032 * If this is called for an already-existing device (as part of
4033 * usb_reset_and_verify_device), the caller must own the device lock. For a
4034 * newly detected device that is not accessible through any global
4035 * pointers, it's not necessary to lock the device.
4038 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
4041 struct usb_device *hdev = hub->hdev;
4042 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4044 unsigned delay = HUB_SHORT_RESET_TIME;
4045 enum usb_device_speed oldspeed = udev->speed;
4047 int devnum = udev->devnum;
4049 /* root hub ports have a slightly longer reset period
4050 * (from USB 2.0 spec, section 7.1.7.5)
4052 if (!hdev->parent) {
4053 delay = HUB_ROOT_RESET_TIME;
4054 if (port1 == hdev->bus->otg_port)
4055 hdev->bus->b_hnp_enable = 0;
4058 /* Some low speed devices have problems with the quick delay, so */
4059 /* be a bit pessimistic with those devices. RHbug #23670 */
4060 if (oldspeed == USB_SPEED_LOW)
4061 delay = HUB_LONG_RESET_TIME;
4063 mutex_lock(&hdev->bus->usb_address0_mutex);
4065 /* Reset the device; full speed may morph to high speed */
4066 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
4067 retval = hub_port_reset(hub, port1, udev, delay, false);
4068 if (retval < 0) /* error or disconnect */
4070 /* success, speed is known */
4074 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
4075 dev_dbg(&udev->dev, "device reset changed speed!\n");
4078 oldspeed = udev->speed;
4080 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4081 * it's fixed size except for full speed devices.
4082 * For Wireless USB devices, ep0 max packet is always 512 (tho
4083 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4085 switch (udev->speed) {
4086 case USB_SPEED_SUPER:
4087 case USB_SPEED_WIRELESS: /* fixed at 512 */
4088 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
4090 case USB_SPEED_HIGH: /* fixed at 64 */
4091 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4093 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
4094 /* to determine the ep0 maxpacket size, try to read
4095 * the device descriptor to get bMaxPacketSize0 and
4096 * then correct our initial guess.
4098 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4100 case USB_SPEED_LOW: /* fixed at 8 */
4101 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
4107 if (udev->speed == USB_SPEED_WIRELESS)
4108 speed = "variable speed Wireless";
4110 speed = usb_speed_string(udev->speed);
4112 if (udev->speed != USB_SPEED_SUPER)
4113 dev_info(&udev->dev,
4114 "%s %s USB device number %d using %s\n",
4115 (udev->config) ? "reset" : "new", speed,
4116 devnum, udev->bus->controller->driver->name);
4118 /* Set up TT records, if needed */
4120 udev->tt = hdev->tt;
4121 udev->ttport = hdev->ttport;
4122 } else if (udev->speed != USB_SPEED_HIGH
4123 && hdev->speed == USB_SPEED_HIGH) {
4125 dev_err(&udev->dev, "parent hub has no TT\n");
4129 udev->tt = &hub->tt;
4130 udev->ttport = port1;
4133 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4134 * Because device hardware and firmware is sometimes buggy in
4135 * this area, and this is how Linux has done it for ages.
4136 * Change it cautiously.
4138 * NOTE: If use_new_scheme() is true we will start by issuing
4139 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4140 * so it may help with some non-standards-compliant devices.
4141 * Otherwise we start with SET_ADDRESS and then try to read the
4142 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4145 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
4146 bool did_new_scheme = false;
4148 if (use_new_scheme(udev, retry_counter)) {
4149 struct usb_device_descriptor *buf;
4152 did_new_scheme = true;
4153 retval = hub_enable_device(udev);
4156 "hub failed to enable device, error %d\n",
4161 #define GET_DESCRIPTOR_BUFSIZE 64
4162 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
4168 /* Retry on all errors; some devices are flakey.
4169 * 255 is for WUSB devices, we actually need to use
4170 * 512 (WUSB1.0[4.8.1]).
4172 for (j = 0; j < 3; ++j) {
4173 buf->bMaxPacketSize0 = 0;
4174 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
4175 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
4176 USB_DT_DEVICE << 8, 0,
4177 buf, GET_DESCRIPTOR_BUFSIZE,
4178 initial_descriptor_timeout);
4179 switch (buf->bMaxPacketSize0) {
4180 case 8: case 16: case 32: case 64: case 255:
4181 if (buf->bDescriptorType ==
4195 udev->descriptor.bMaxPacketSize0 =
4196 buf->bMaxPacketSize0;
4199 retval = hub_port_reset(hub, port1, udev, delay, false);
4200 if (retval < 0) /* error or disconnect */
4202 if (oldspeed != udev->speed) {
4204 "device reset changed speed!\n");
4210 dev_err(&udev->dev, "device descriptor read/64, error %d\n",
4215 #undef GET_DESCRIPTOR_BUFSIZE
4219 * If device is WUSB, we already assigned an
4220 * unauthorized address in the Connect Ack sequence;
4221 * authorization will assign the final address.
4223 if (udev->wusb == 0) {
4224 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
4225 retval = hub_set_address(udev, devnum);
4231 if (retval != -ENODEV)
4232 dev_err(&udev->dev, "device not accepting address %d, error %d\n",
4236 if (udev->speed == USB_SPEED_SUPER) {
4237 devnum = udev->devnum;
4238 dev_info(&udev->dev,
4239 "%s SuperSpeed USB device number %d using %s\n",
4240 (udev->config) ? "reset" : "new",
4241 devnum, udev->bus->controller->driver->name);
4244 /* cope with hardware quirkiness:
4245 * - let SET_ADDRESS settle, some device hardware wants it
4246 * - read ep0 maxpacket even for high and low speed,
4249 /* use_new_scheme() checks the speed which may have
4250 * changed since the initial look so we cache the result
4257 retval = usb_get_device_descriptor(udev, 8);
4259 if (retval != -ENODEV)
4261 "device descriptor read/8, error %d\n",
4273 if (hcd->phy && !hdev->parent)
4274 usb_phy_notify_connect(hcd->phy, udev->speed);
4277 * Some superspeed devices have finished the link training process
4278 * and attached to a superspeed hub port, but the device descriptor
4279 * got from those devices show they aren't superspeed devices. Warm
4280 * reset the port attached by the devices can fix them.
4282 if ((udev->speed == USB_SPEED_SUPER) &&
4283 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
4284 dev_err(&udev->dev, "got a wrong device descriptor, "
4285 "warm reset device\n");
4286 hub_port_reset(hub, port1, udev,
4287 HUB_BH_RESET_TIME, true);
4292 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
4293 udev->speed == USB_SPEED_SUPER)
4296 i = udev->descriptor.bMaxPacketSize0;
4297 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
4298 if (udev->speed == USB_SPEED_LOW ||
4299 !(i == 8 || i == 16 || i == 32 || i == 64)) {
4300 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
4304 if (udev->speed == USB_SPEED_FULL)
4305 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
4307 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
4308 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
4309 usb_ep0_reinit(udev);
4312 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
4313 if (retval < (signed)sizeof(udev->descriptor)) {
4314 if (retval != -ENODEV)
4315 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
4322 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
4323 retval = usb_get_bos_descriptor(udev);
4325 udev->lpm_capable = usb_device_supports_lpm(udev);
4326 usb_set_lpm_parameters(udev);
4331 /* notify HCD that we have a device connected and addressed */
4332 if (hcd->driver->update_device)
4333 hcd->driver->update_device(hcd, udev);
4334 hub_set_initial_usb2_lpm_policy(udev);
4337 hub_port_disable(hub, port1, 0);
4338 update_devnum(udev, devnum); /* for disconnect processing */
4340 mutex_unlock(&hdev->bus->usb_address0_mutex);
4345 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
4347 struct usb_qualifier_descriptor *qual;
4350 qual = kmalloc (sizeof *qual, GFP_KERNEL);
4354 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
4355 qual, sizeof *qual);
4356 if (status == sizeof *qual) {
4357 dev_info(&udev->dev, "not running at top speed; "
4358 "connect to a high speed hub\n");
4359 /* hub LEDs are probably harder to miss than syslog */
4360 if (hub->has_indicators) {
4361 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
4362 queue_delayed_work(system_power_efficient_wq,
4370 hub_power_remaining (struct usb_hub *hub)
4372 struct usb_device *hdev = hub->hdev;
4376 if (!hub->limited_power)
4379 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
4380 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
4381 struct usb_port *port_dev = hub->ports[port1 - 1];
4382 struct usb_device *udev = port_dev->child;
4388 if (hub_is_superspeed(udev))
4394 * Unconfigured devices may not use more than one unit load,
4395 * or 8mA for OTG ports
4397 if (udev->actconfig)
4398 delta = usb_get_max_power(udev, udev->actconfig);
4399 else if (port1 != udev->bus->otg_port || hdev->parent)
4403 if (delta > hub->mA_per_port)
4404 dev_warn(&port_dev->dev, "%dmA is over %umA budget!\n",
4405 delta, hub->mA_per_port);
4408 if (remaining < 0) {
4409 dev_warn(hub->intfdev, "%dmA over power budget!\n",
4416 static void hub_port_connect(struct usb_hub *hub, int port1, u16 portstatus,
4421 struct usb_device *hdev = hub->hdev;
4422 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4423 struct usb_port *port_dev = hub->ports[port1 - 1];
4424 struct usb_device *udev = port_dev->child;
4426 /* Disconnect any existing devices under this port */
4428 if (hcd->phy && !hdev->parent &&
4429 !(portstatus & USB_PORT_STAT_CONNECTION))
4430 usb_phy_notify_disconnect(hcd->phy, udev->speed);
4431 usb_disconnect(&port_dev->child);
4434 /* We can forget about a "removed" device when there's a physical
4435 * disconnect or the connect status changes.
4437 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4438 (portchange & USB_PORT_STAT_C_CONNECTION))
4439 clear_bit(port1, hub->removed_bits);
4441 if (portchange & (USB_PORT_STAT_C_CONNECTION |
4442 USB_PORT_STAT_C_ENABLE)) {
4443 status = hub_port_debounce_be_stable(hub, port1);
4445 if (status != -ENODEV && printk_ratelimit())
4446 dev_err(&port_dev->dev,
4447 "connect-debounce failed\n");
4448 portstatus &= ~USB_PORT_STAT_CONNECTION;
4450 portstatus = status;
4454 /* Return now if debouncing failed or nothing is connected or
4455 * the device was "removed".
4457 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4458 test_bit(port1, hub->removed_bits)) {
4460 /* maybe switch power back on (e.g. root hub was reset) */
4461 if (hub_is_port_power_switchable(hub)
4462 && !port_is_power_on(hub, portstatus))
4463 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
4465 if (portstatus & USB_PORT_STAT_ENABLE)
4469 if (hub_is_superspeed(hub->hdev))
4475 for (i = 0; i < SET_CONFIG_TRIES; i++) {
4477 /* reallocate for each attempt, since references
4478 * to the previous one can escape in various ways
4480 udev = usb_alloc_dev(hdev, hdev->bus, port1);
4482 dev_err(&port_dev->dev,
4483 "couldn't allocate usb_device\n");
4487 usb_set_device_state(udev, USB_STATE_POWERED);
4488 udev->bus_mA = hub->mA_per_port;
4489 udev->level = hdev->level + 1;
4490 udev->wusb = hub_is_wusb(hub);
4492 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
4493 if (hub_is_superspeed(hub->hdev))
4494 udev->speed = USB_SPEED_SUPER;
4496 udev->speed = USB_SPEED_UNKNOWN;
4498 choose_devnum(udev);
4499 if (udev->devnum <= 0) {
4500 status = -ENOTCONN; /* Don't retry */
4504 /* reset (non-USB 3.0 devices) and get descriptor */
4505 status = hub_port_init(hub, udev, port1, i);
4509 usb_detect_quirks(udev);
4510 if (udev->quirks & USB_QUIRK_DELAY_INIT)
4513 /* consecutive bus-powered hubs aren't reliable; they can
4514 * violate the voltage drop budget. if the new child has
4515 * a "powered" LED, users should notice we didn't enable it
4516 * (without reading syslog), even without per-port LEDs
4519 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
4520 && udev->bus_mA <= unit_load) {
4523 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
4526 dev_dbg(&udev->dev, "get status %d ?\n", status);
4529 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
4531 "can't connect bus-powered hub "
4533 if (hub->has_indicators) {
4534 hub->indicator[port1-1] =
4535 INDICATOR_AMBER_BLINK;
4537 system_power_efficient_wq,
4540 status = -ENOTCONN; /* Don't retry */
4545 /* check for devices running slower than they could */
4546 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
4547 && udev->speed == USB_SPEED_FULL
4548 && highspeed_hubs != 0)
4549 check_highspeed (hub, udev, port1);
4551 /* Store the parent's children[] pointer. At this point
4552 * udev becomes globally accessible, although presumably
4553 * no one will look at it until hdev is unlocked.
4557 mutex_lock(&usb_port_peer_mutex);
4559 /* We mustn't add new devices if the parent hub has
4560 * been disconnected; we would race with the
4561 * recursively_mark_NOTATTACHED() routine.
4563 spin_lock_irq(&device_state_lock);
4564 if (hdev->state == USB_STATE_NOTATTACHED)
4567 port_dev->child = udev;
4568 spin_unlock_irq(&device_state_lock);
4569 mutex_unlock(&usb_port_peer_mutex);
4571 /* Run it through the hoops (find a driver, etc) */
4573 status = usb_new_device(udev);
4575 mutex_lock(&usb_port_peer_mutex);
4576 spin_lock_irq(&device_state_lock);
4577 port_dev->child = NULL;
4578 spin_unlock_irq(&device_state_lock);
4579 mutex_unlock(&usb_port_peer_mutex);
4586 status = hub_power_remaining(hub);
4588 dev_dbg(hub->intfdev, "%dmA power budget left\n", status);
4593 hub_port_disable(hub, port1, 1);
4595 usb_ep0_reinit(udev);
4596 release_devnum(udev);
4599 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
4602 if (hub->hdev->parent ||
4603 !hcd->driver->port_handed_over ||
4604 !(hcd->driver->port_handed_over)(hcd, port1)) {
4605 if (status != -ENOTCONN && status != -ENODEV)
4606 dev_err(&port_dev->dev,
4607 "unable to enumerate USB device\n");
4611 hub_port_disable(hub, port1, 1);
4612 if (hcd->driver->relinquish_port && !hub->hdev->parent)
4613 hcd->driver->relinquish_port(hcd, port1);
4617 /* Handle physical or logical connection change events.
4618 * This routine is called when:
4619 * a port connection-change occurs;
4620 * a port enable-change occurs (often caused by EMI);
4621 * usb_reset_and_verify_device() encounters changed descriptors (as from
4622 * a firmware download)
4623 * caller already locked the hub
4625 static void hub_port_connect_change(struct usb_hub *hub, int port1,
4626 u16 portstatus, u16 portchange)
4628 struct usb_port *port_dev = hub->ports[port1 - 1];
4629 struct usb_device *udev = port_dev->child;
4630 int status = -ENODEV;
4632 dev_dbg(&port_dev->dev, "status %04x, change %04x, %s\n", portstatus,
4633 portchange, portspeed(hub, portstatus));
4635 if (hub->has_indicators) {
4636 set_port_led(hub, port1, HUB_LED_AUTO);
4637 hub->indicator[port1-1] = INDICATOR_AUTO;
4640 #ifdef CONFIG_USB_OTG
4641 /* during HNP, don't repeat the debounce */
4642 if (hub->hdev->bus->is_b_host)
4643 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
4644 USB_PORT_STAT_C_ENABLE);
4647 /* Try to resuscitate an existing device */
4648 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
4649 udev->state != USB_STATE_NOTATTACHED) {
4650 if (portstatus & USB_PORT_STAT_ENABLE) {
4651 status = 0; /* Nothing to do */
4652 #ifdef CONFIG_PM_RUNTIME
4653 } else if (udev->state == USB_STATE_SUSPENDED &&
4654 udev->persist_enabled) {
4655 /* For a suspended device, treat this as a
4656 * remote wakeup event.
4658 usb_lock_device(udev);
4659 status = usb_remote_wakeup(udev);
4660 usb_unlock_device(udev);
4663 /* Don't resuscitate */;
4667 clear_bit(port1, hub->change_bits);
4672 hub_port_connect(hub, port1, portstatus, portchange);
4675 /* Returns 1 if there was a remote wakeup and a connect status change. */
4676 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
4677 u16 portstatus, u16 portchange)
4679 struct usb_port *port_dev = hub->ports[port - 1];
4680 struct usb_device *hdev;
4681 struct usb_device *udev;
4682 int connect_change = 0;
4686 udev = port_dev->child;
4687 if (!hub_is_superspeed(hdev)) {
4688 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
4690 usb_clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
4692 if (!udev || udev->state != USB_STATE_SUSPENDED ||
4693 (portstatus & USB_PORT_STAT_LINK_STATE) !=
4699 /* TRSMRCY = 10 msec */
4702 usb_lock_device(udev);
4703 ret = usb_remote_wakeup(udev);
4704 usb_unlock_device(udev);
4709 hub_port_disable(hub, port, 1);
4711 dev_dbg(&port_dev->dev, "resume, status %d\n", ret);
4712 return connect_change;
4715 static void port_event(struct usb_hub *hub, int port1)
4717 int connect_change, reset_device = 0;
4718 struct usb_port *port_dev = hub->ports[port1 - 1];
4719 struct usb_device *udev = port_dev->child;
4720 struct usb_device *hdev = hub->hdev;
4721 u16 portstatus, portchange;
4723 connect_change = test_bit(port1, hub->change_bits);
4724 clear_bit(port1, hub->event_bits);
4725 clear_bit(port1, hub->wakeup_bits);
4727 if (hub_port_status(hub, port1, &portstatus, &portchange) < 0)
4730 if (portchange & USB_PORT_STAT_C_CONNECTION) {
4731 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_CONNECTION);
4735 if (portchange & USB_PORT_STAT_C_ENABLE) {
4736 if (!connect_change)
4737 dev_dbg(&port_dev->dev, "enable change, status %08x\n",
4739 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_ENABLE);
4742 * EM interference sometimes causes badly shielded USB devices
4743 * to be shutdown by the hub, this hack enables them again.
4744 * Works at least with mouse driver.
4746 if (!(portstatus & USB_PORT_STAT_ENABLE)
4747 && !connect_change && udev) {
4748 dev_err(&port_dev->dev, "disabled by hub (EMI?), re-enabling...\n");
4753 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
4754 u16 status = 0, unused;
4756 dev_dbg(&port_dev->dev, "over-current change\n");
4757 usb_clear_port_feature(hdev, port1,
4758 USB_PORT_FEAT_C_OVER_CURRENT);
4759 msleep(100); /* Cool down */
4760 hub_power_on(hub, true);
4761 hub_port_status(hub, port1, &status, &unused);
4762 if (status & USB_PORT_STAT_OVERCURRENT)
4763 dev_err(&port_dev->dev, "over-current condition\n");
4766 if (portchange & USB_PORT_STAT_C_RESET) {
4767 dev_dbg(&port_dev->dev, "reset change\n");
4768 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_RESET);
4770 if ((portchange & USB_PORT_STAT_C_BH_RESET)
4771 && hub_is_superspeed(hdev)) {
4772 dev_dbg(&port_dev->dev, "warm reset change\n");
4773 usb_clear_port_feature(hdev, port1,
4774 USB_PORT_FEAT_C_BH_PORT_RESET);
4776 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
4777 dev_dbg(&port_dev->dev, "link state change\n");
4778 usb_clear_port_feature(hdev, port1,
4779 USB_PORT_FEAT_C_PORT_LINK_STATE);
4781 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
4782 dev_warn(&port_dev->dev, "config error\n");
4783 usb_clear_port_feature(hdev, port1,
4784 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
4787 /* skip port actions that require the port to be powered on */
4788 if (!pm_runtime_active(&port_dev->dev))
4791 if (hub_handle_remote_wakeup(hub, port1, portstatus, portchange))
4795 * Warm reset a USB3 protocol port if it's in
4796 * SS.Inactive state.
4798 if (hub_port_warm_reset_required(hub, portstatus)) {
4799 dev_dbg(&port_dev->dev, "do warm reset\n");
4800 if (!udev || !(portstatus & USB_PORT_STAT_CONNECTION)
4801 || udev->state == USB_STATE_NOTATTACHED) {
4802 if (hub_port_reset(hub, port1, NULL,
4803 HUB_BH_RESET_TIME, true) < 0)
4804 hub_port_disable(hub, port1, 1);
4810 * On disconnect USB3 protocol ports transit from U0 to
4811 * SS.Inactive to Rx.Detect. If this happens a warm-
4812 * reset is not needed, but a (re)connect may happen
4813 * before khubd runs and sees the disconnect, and the
4814 * device may be an unknown state.
4816 * If the port went through SS.Inactive without khubd
4817 * seeing it the C_LINK_STATE change flag will be set,
4818 * and we reset the dev to put it in a known state.
4820 if (reset_device || (udev && hub_is_superspeed(hub->hdev)
4821 && (portchange & USB_PORT_STAT_C_LINK_STATE)
4822 && (portstatus & USB_PORT_STAT_CONNECTION))) {
4823 usb_lock_device(udev);
4824 usb_reset_device(udev);
4825 usb_unlock_device(udev);
4830 hub_port_connect_change(hub, port1, portstatus, portchange);
4834 static void hub_events(void)
4836 struct list_head *tmp;
4837 struct usb_device *hdev;
4838 struct usb_interface *intf;
4839 struct usb_hub *hub;
4840 struct device *hub_dev;
4846 * We restart the list every time to avoid a deadlock with
4847 * deleting hubs downstream from this one. This should be
4848 * safe since we delete the hub from the event list.
4849 * Not the most efficient, but avoids deadlocks.
4853 /* Grab the first entry at the beginning of the list */
4854 spin_lock_irq(&hub_event_lock);
4855 if (list_empty(&hub_event_list)) {
4856 spin_unlock_irq(&hub_event_lock);
4860 tmp = hub_event_list.next;
4863 hub = list_entry(tmp, struct usb_hub, event_list);
4864 kref_get(&hub->kref);
4865 spin_unlock_irq(&hub_event_lock);
4868 hub_dev = hub->intfdev;
4869 intf = to_usb_interface(hub_dev);
4870 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
4871 hdev->state, hdev->maxchild,
4872 /* NOTE: expects max 15 ports... */
4873 (u16) hub->change_bits[0],
4874 (u16) hub->event_bits[0]);
4876 /* Lock the device, then check to see if we were
4877 * disconnected while waiting for the lock to succeed. */
4878 usb_lock_device(hdev);
4879 if (unlikely(hub->disconnected))
4880 goto loop_disconnected;
4882 /* If the hub has died, clean up after it */
4883 if (hdev->state == USB_STATE_NOTATTACHED) {
4884 hub->error = -ENODEV;
4885 hub_quiesce(hub, HUB_DISCONNECT);
4890 ret = usb_autopm_get_interface(intf);
4892 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
4896 /* If this is an inactive hub, do nothing */
4901 dev_dbg (hub_dev, "resetting for error %d\n",
4904 ret = usb_reset_device(hdev);
4907 "error resetting hub: %d\n", ret);
4915 /* deal with port status changes */
4916 for (i = 1; i <= hdev->maxchild; i++) {
4917 struct usb_port *port_dev = hub->ports[i - 1];
4919 if (!test_bit(i, hub->busy_bits)
4920 && (test_bit(i, hub->event_bits)
4921 || test_bit(i, hub->change_bits)
4922 || test_bit(i, hub->wakeup_bits))) {
4924 * The get_noresume and barrier ensure that if
4925 * the port was in the process of resuming, we
4926 * flush that work and keep the port active for
4927 * the duration of the port_event(). However,
4928 * if the port is runtime pm suspended
4929 * (powered-off), we leave it in that state, run
4930 * an abbreviated port_event(), and move on.
4932 pm_runtime_get_noresume(&port_dev->dev);
4933 pm_runtime_barrier(&port_dev->dev);
4935 pm_runtime_put_sync(&port_dev->dev);
4939 /* deal with hub status changes */
4940 if (test_and_clear_bit(0, hub->event_bits) == 0)
4942 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
4943 dev_err (hub_dev, "get_hub_status failed\n");
4945 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
4946 dev_dbg (hub_dev, "power change\n");
4947 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
4948 if (hubstatus & HUB_STATUS_LOCAL_POWER)
4949 /* FIXME: Is this always true? */
4950 hub->limited_power = 1;
4952 hub->limited_power = 0;
4954 if (hubchange & HUB_CHANGE_OVERCURRENT) {
4958 dev_dbg(hub_dev, "over-current change\n");
4959 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
4960 msleep(500); /* Cool down */
4961 hub_power_on(hub, true);
4962 hub_hub_status(hub, &status, &unused);
4963 if (status & HUB_STATUS_OVERCURRENT)
4964 dev_err(hub_dev, "over-current "
4970 /* Balance the usb_autopm_get_interface() above */
4971 usb_autopm_put_interface_no_suspend(intf);
4973 /* Balance the usb_autopm_get_interface_no_resume() in
4974 * kick_khubd() and allow autosuspend.
4976 usb_autopm_put_interface(intf);
4978 usb_unlock_device(hdev);
4979 kref_put(&hub->kref, hub_release);
4981 } /* end while (1) */
4984 static int hub_thread(void *__unused)
4986 /* khubd needs to be freezable to avoid interfering with USB-PERSIST
4987 * port handover. Otherwise it might see that a full-speed device
4988 * was gone before the EHCI controller had handed its port over to
4989 * the companion full-speed controller.
4995 wait_event_freezable(khubd_wait,
4996 !list_empty(&hub_event_list) ||
4997 kthread_should_stop());
4998 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
5000 pr_debug("%s: khubd exiting\n", usbcore_name);
5004 static const struct usb_device_id hub_id_table[] = {
5005 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5006 | USB_DEVICE_ID_MATCH_INT_CLASS,
5007 .idVendor = USB_VENDOR_GENESYS_LOGIC,
5008 .bInterfaceClass = USB_CLASS_HUB,
5009 .driver_info = HUB_QUIRK_CHECK_PORT_AUTOSUSPEND},
5010 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
5011 .bDeviceClass = USB_CLASS_HUB},
5012 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
5013 .bInterfaceClass = USB_CLASS_HUB},
5014 { } /* Terminating entry */
5017 MODULE_DEVICE_TABLE (usb, hub_id_table);
5019 static struct usb_driver hub_driver = {
5022 .disconnect = hub_disconnect,
5023 .suspend = hub_suspend,
5024 .resume = hub_resume,
5025 .reset_resume = hub_reset_resume,
5026 .pre_reset = hub_pre_reset,
5027 .post_reset = hub_post_reset,
5028 .unlocked_ioctl = hub_ioctl,
5029 .id_table = hub_id_table,
5030 .supports_autosuspend = 1,
5033 int usb_hub_init(void)
5035 if (usb_register(&hub_driver) < 0) {
5036 printk(KERN_ERR "%s: can't register hub driver\n",
5041 khubd_task = kthread_run(hub_thread, NULL, "khubd");
5042 if (!IS_ERR(khubd_task))
5045 /* Fall through if kernel_thread failed */
5046 usb_deregister(&hub_driver);
5047 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
5052 void usb_hub_cleanup(void)
5054 kthread_stop(khubd_task);
5057 * Hub resources are freed for us by usb_deregister. It calls
5058 * usb_driver_purge on every device which in turn calls that
5059 * devices disconnect function if it is using this driver.
5060 * The hub_disconnect function takes care of releasing the
5061 * individual hub resources. -greg
5063 usb_deregister(&hub_driver);
5064 } /* usb_hub_cleanup() */
5066 static int descriptors_changed(struct usb_device *udev,
5067 struct usb_device_descriptor *old_device_descriptor,
5068 struct usb_host_bos *old_bos)
5072 unsigned serial_len = 0;
5074 unsigned old_length;
5078 if (memcmp(&udev->descriptor, old_device_descriptor,
5079 sizeof(*old_device_descriptor)) != 0)
5082 if ((old_bos && !udev->bos) || (!old_bos && udev->bos))
5085 len = le16_to_cpu(udev->bos->desc->wTotalLength);
5086 if (len != le16_to_cpu(old_bos->desc->wTotalLength))
5088 if (memcmp(udev->bos->desc, old_bos->desc, len))
5092 /* Since the idVendor, idProduct, and bcdDevice values in the
5093 * device descriptor haven't changed, we will assume the
5094 * Manufacturer and Product strings haven't changed either.
5095 * But the SerialNumber string could be different (e.g., a
5096 * different flash card of the same brand).
5099 serial_len = strlen(udev->serial) + 1;
5102 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5103 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5104 len = max(len, old_length);
5107 buf = kmalloc(len, GFP_NOIO);
5109 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
5110 /* assume the worst */
5113 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5114 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5115 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
5117 if (length != old_length) {
5118 dev_dbg(&udev->dev, "config index %d, error %d\n",
5123 if (memcmp (buf, udev->rawdescriptors[index], old_length)
5125 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
5127 ((struct usb_config_descriptor *) buf)->
5128 bConfigurationValue);
5134 if (!changed && serial_len) {
5135 length = usb_string(udev, udev->descriptor.iSerialNumber,
5137 if (length + 1 != serial_len) {
5138 dev_dbg(&udev->dev, "serial string error %d\n",
5141 } else if (memcmp(buf, udev->serial, length) != 0) {
5142 dev_dbg(&udev->dev, "serial string changed\n");
5152 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5153 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5155 * WARNING - don't use this routine to reset a composite device
5156 * (one with multiple interfaces owned by separate drivers)!
5157 * Use usb_reset_device() instead.
5159 * Do a port reset, reassign the device's address, and establish its
5160 * former operating configuration. If the reset fails, or the device's
5161 * descriptors change from their values before the reset, or the original
5162 * configuration and altsettings cannot be restored, a flag will be set
5163 * telling khubd to pretend the device has been disconnected and then
5164 * re-connected. All drivers will be unbound, and the device will be
5165 * re-enumerated and probed all over again.
5167 * Return: 0 if the reset succeeded, -ENODEV if the device has been
5168 * flagged for logical disconnection, or some other negative error code
5169 * if the reset wasn't even attempted.
5172 * The caller must own the device lock. For example, it's safe to use
5173 * this from a driver probe() routine after downloading new firmware.
5174 * For calls that might not occur during probe(), drivers should lock
5175 * the device using usb_lock_device_for_reset().
5177 * Locking exception: This routine may also be called from within an
5178 * autoresume handler. Such usage won't conflict with other tasks
5179 * holding the device lock because these tasks should always call
5180 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
5182 static int usb_reset_and_verify_device(struct usb_device *udev)
5184 struct usb_device *parent_hdev = udev->parent;
5185 struct usb_hub *parent_hub;
5186 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
5187 struct usb_device_descriptor descriptor = udev->descriptor;
5188 struct usb_host_bos *bos;
5190 int port1 = udev->portnum;
5192 if (udev->state == USB_STATE_NOTATTACHED ||
5193 udev->state == USB_STATE_SUSPENDED) {
5194 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5200 /* this requires hcd-specific logic; see ohci_restart() */
5201 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
5204 parent_hub = usb_hub_to_struct_hub(parent_hdev);
5206 /* Disable USB2 hardware LPM.
5207 * It will be re-enabled by the enumeration process.
5209 if (udev->usb2_hw_lpm_enabled == 1)
5210 usb_set_usb2_hardware_lpm(udev, 0);
5215 /* Disable LPM and LTM while we reset the device and reinstall the alt
5216 * settings. Device-initiated LPM settings, and system exit latency
5217 * settings are cleared when the device is reset, so we have to set
5220 ret = usb_unlocked_disable_lpm(udev);
5222 dev_err(&udev->dev, "%s Failed to disable LPM\n.", __func__);
5225 ret = usb_disable_ltm(udev);
5227 dev_err(&udev->dev, "%s Failed to disable LTM\n.",
5232 set_bit(port1, parent_hub->busy_bits);
5233 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
5235 /* ep0 maxpacket size may change; let the HCD know about it.
5236 * Other endpoints will be handled by re-enumeration. */
5237 usb_ep0_reinit(udev);
5238 ret = hub_port_init(parent_hub, udev, port1, i);
5239 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
5242 clear_bit(port1, parent_hub->busy_bits);
5247 /* Device might have changed firmware (DFU or similar) */
5248 if (descriptors_changed(udev, &descriptor, bos)) {
5249 dev_info(&udev->dev, "device firmware changed\n");
5250 udev->descriptor = descriptor; /* for disconnect() calls */
5254 /* Restore the device's previous configuration */
5255 if (!udev->actconfig)
5258 mutex_lock(hcd->bandwidth_mutex);
5259 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
5261 dev_warn(&udev->dev,
5262 "Busted HC? Not enough HCD resources for "
5263 "old configuration.\n");
5264 mutex_unlock(hcd->bandwidth_mutex);
5267 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
5268 USB_REQ_SET_CONFIGURATION, 0,
5269 udev->actconfig->desc.bConfigurationValue, 0,
5270 NULL, 0, USB_CTRL_SET_TIMEOUT);
5273 "can't restore configuration #%d (error=%d)\n",
5274 udev->actconfig->desc.bConfigurationValue, ret);
5275 mutex_unlock(hcd->bandwidth_mutex);
5278 mutex_unlock(hcd->bandwidth_mutex);
5279 usb_set_device_state(udev, USB_STATE_CONFIGURED);
5281 /* Put interfaces back into the same altsettings as before.
5282 * Don't bother to send the Set-Interface request for interfaces
5283 * that were already in altsetting 0; besides being unnecessary,
5284 * many devices can't handle it. Instead just reset the host-side
5287 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
5288 struct usb_host_config *config = udev->actconfig;
5289 struct usb_interface *intf = config->interface[i];
5290 struct usb_interface_descriptor *desc;
5292 desc = &intf->cur_altsetting->desc;
5293 if (desc->bAlternateSetting == 0) {
5294 usb_disable_interface(udev, intf, true);
5295 usb_enable_interface(udev, intf, true);
5298 /* Let the bandwidth allocation function know that this
5299 * device has been reset, and it will have to use
5300 * alternate setting 0 as the current alternate setting.
5302 intf->resetting_device = 1;
5303 ret = usb_set_interface(udev, desc->bInterfaceNumber,
5304 desc->bAlternateSetting);
5305 intf->resetting_device = 0;
5308 dev_err(&udev->dev, "failed to restore interface %d "
5309 "altsetting %d (error=%d)\n",
5310 desc->bInterfaceNumber,
5311 desc->bAlternateSetting,
5315 /* Resetting also frees any allocated streams */
5316 for (j = 0; j < intf->cur_altsetting->desc.bNumEndpoints; j++)
5317 intf->cur_altsetting->endpoint[j].streams = 0;
5321 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5322 usb_set_usb2_hardware_lpm(udev, 1);
5323 usb_unlocked_enable_lpm(udev);
5324 usb_enable_ltm(udev);
5325 usb_release_bos_descriptor(udev);
5330 /* LPM state doesn't matter when we're about to destroy the device. */
5331 hub_port_logical_disconnect(parent_hub, port1);
5332 usb_release_bos_descriptor(udev);
5338 * usb_reset_device - warn interface drivers and perform a USB port reset
5339 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5341 * Warns all drivers bound to registered interfaces (using their pre_reset
5342 * method), performs the port reset, and then lets the drivers know that
5343 * the reset is over (using their post_reset method).
5345 * Return: The same as for usb_reset_and_verify_device().
5348 * The caller must own the device lock. For example, it's safe to use
5349 * this from a driver probe() routine after downloading new firmware.
5350 * For calls that might not occur during probe(), drivers should lock
5351 * the device using usb_lock_device_for_reset().
5353 * If an interface is currently being probed or disconnected, we assume
5354 * its driver knows how to handle resets. For all other interfaces,
5355 * if the driver doesn't have pre_reset and post_reset methods then
5356 * we attempt to unbind it and rebind afterward.
5358 int usb_reset_device(struct usb_device *udev)
5362 unsigned int noio_flag;
5363 struct usb_host_config *config = udev->actconfig;
5365 if (udev->state == USB_STATE_NOTATTACHED ||
5366 udev->state == USB_STATE_SUSPENDED) {
5367 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5373 * Don't allocate memory with GFP_KERNEL in current
5374 * context to avoid possible deadlock if usb mass
5375 * storage interface or usbnet interface(iSCSI case)
5376 * is included in current configuration. The easist
5377 * approach is to do it for every device reset,
5378 * because the device 'memalloc_noio' flag may have
5379 * not been set before reseting the usb device.
5381 noio_flag = memalloc_noio_save();
5383 /* Prevent autosuspend during the reset */
5384 usb_autoresume_device(udev);
5387 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
5388 struct usb_interface *cintf = config->interface[i];
5389 struct usb_driver *drv;
5392 if (cintf->dev.driver) {
5393 drv = to_usb_driver(cintf->dev.driver);
5394 if (drv->pre_reset && drv->post_reset)
5395 unbind = (drv->pre_reset)(cintf);
5396 else if (cintf->condition ==
5397 USB_INTERFACE_BOUND)
5400 usb_forced_unbind_intf(cintf);
5405 ret = usb_reset_and_verify_device(udev);
5408 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
5409 struct usb_interface *cintf = config->interface[i];
5410 struct usb_driver *drv;
5411 int rebind = cintf->needs_binding;
5413 if (!rebind && cintf->dev.driver) {
5414 drv = to_usb_driver(cintf->dev.driver);
5415 if (drv->post_reset)
5416 rebind = (drv->post_reset)(cintf);
5417 else if (cintf->condition ==
5418 USB_INTERFACE_BOUND)
5421 cintf->needs_binding = 1;
5424 usb_unbind_and_rebind_marked_interfaces(udev);
5427 usb_autosuspend_device(udev);
5428 memalloc_noio_restore(noio_flag);
5431 EXPORT_SYMBOL_GPL(usb_reset_device);
5435 * usb_queue_reset_device - Reset a USB device from an atomic context
5436 * @iface: USB interface belonging to the device to reset
5438 * This function can be used to reset a USB device from an atomic
5439 * context, where usb_reset_device() won't work (as it blocks).
5441 * Doing a reset via this method is functionally equivalent to calling
5442 * usb_reset_device(), except for the fact that it is delayed to a
5443 * workqueue. This means that any drivers bound to other interfaces
5444 * might be unbound, as well as users from usbfs in user space.
5448 * - Scheduling two resets at the same time from two different drivers
5449 * attached to two different interfaces of the same device is
5450 * possible; depending on how the driver attached to each interface
5451 * handles ->pre_reset(), the second reset might happen or not.
5453 * - If a driver is unbound and it had a pending reset, the reset will
5456 * - This function can be called during .probe() or .disconnect()
5457 * times. On return from .disconnect(), any pending resets will be
5460 * There is no no need to lock/unlock the @reset_ws as schedule_work()
5463 * NOTE: We don't do any reference count tracking because it is not
5464 * needed. The lifecycle of the work_struct is tied to the
5465 * usb_interface. Before destroying the interface we cancel the
5466 * work_struct, so the fact that work_struct is queued and or
5467 * running means the interface (and thus, the device) exist and
5470 void usb_queue_reset_device(struct usb_interface *iface)
5472 schedule_work(&iface->reset_ws);
5474 EXPORT_SYMBOL_GPL(usb_queue_reset_device);
5477 * usb_hub_find_child - Get the pointer of child device
5478 * attached to the port which is specified by @port1.
5479 * @hdev: USB device belonging to the usb hub
5480 * @port1: port num to indicate which port the child device
5483 * USB drivers call this function to get hub's child device
5486 * Return: %NULL if input param is invalid and
5487 * child's usb_device pointer if non-NULL.
5489 struct usb_device *usb_hub_find_child(struct usb_device *hdev,
5492 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5494 if (port1 < 1 || port1 > hdev->maxchild)
5496 return hub->ports[port1 - 1]->child;
5498 EXPORT_SYMBOL_GPL(usb_hub_find_child);
5500 void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
5501 struct usb_hub_descriptor *desc)
5503 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5504 enum usb_port_connect_type connect_type;
5510 if (!hub_is_superspeed(hdev)) {
5511 for (i = 1; i <= hdev->maxchild; i++) {
5512 struct usb_port *port_dev = hub->ports[i - 1];
5514 connect_type = port_dev->connect_type;
5515 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5516 u8 mask = 1 << (i%8);
5518 if (!(desc->u.hs.DeviceRemovable[i/8] & mask)) {
5519 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
5520 desc->u.hs.DeviceRemovable[i/8] |= mask;
5525 u16 port_removable = le16_to_cpu(desc->u.ss.DeviceRemovable);
5527 for (i = 1; i <= hdev->maxchild; i++) {
5528 struct usb_port *port_dev = hub->ports[i - 1];
5530 connect_type = port_dev->connect_type;
5531 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5534 if (!(port_removable & mask)) {
5535 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
5536 port_removable |= mask;
5541 desc->u.ss.DeviceRemovable = cpu_to_le16(port_removable);
5547 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5548 * @hdev: USB device belonging to the usb hub
5549 * @port1: port num of the port
5551 * Return: Port's acpi handle if successful, %NULL if params are
5554 acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
5557 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5562 return ACPI_HANDLE(&hub->ports[port1 - 1]->dev);