4 * (C) Copyright 1999 Linus Torvalds
5 * (C) Copyright 1999 Johannes Erdfelt
6 * (C) Copyright 1999 Gregory P. Smith
7 * (C) Copyright 2001 Brad Hards (bhards@bigpond.net.au)
11 #include <linux/kernel.h>
12 #include <linux/errno.h>
13 #include <linux/module.h>
14 #include <linux/moduleparam.h>
15 #include <linux/completion.h>
16 #include <linux/sched.h>
17 #include <linux/list.h>
18 #include <linux/slab.h>
19 #include <linux/ioctl.h>
20 #include <linux/usb.h>
21 #include <linux/usbdevice_fs.h>
22 #include <linux/usb/hcd.h>
23 #include <linux/usb/otg.h>
24 #include <linux/usb/quirks.h>
25 #include <linux/kthread.h>
26 #include <linux/mutex.h>
27 #include <linux/freezer.h>
28 #include <linux/random.h>
29 #include <linux/pm_qos.h>
31 #include <asm/uaccess.h>
32 #include <asm/byteorder.h>
36 #define USB_VENDOR_GENESYS_LOGIC 0x05e3
37 #define HUB_QUIRK_CHECK_PORT_AUTOSUSPEND 0x01
39 static inline int hub_is_superspeed(struct usb_device *hdev)
41 return (hdev->descriptor.bDeviceProtocol == USB_HUB_PR_SS);
44 /* Protect struct usb_device->state and ->children members
45 * Note: Both are also protected by ->dev.sem, except that ->state can
46 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
47 static DEFINE_SPINLOCK(device_state_lock);
49 /* khubd's worklist and its lock */
50 static DEFINE_SPINLOCK(hub_event_lock);
51 static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
54 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
56 static struct task_struct *khubd_task;
58 /* synchronize hub-port add/remove and peering operations */
59 DEFINE_MUTEX(usb_port_peer_mutex);
61 /* cycle leds on hubs that aren't blinking for attention */
62 static bool blinkenlights = 0;
63 module_param (blinkenlights, bool, S_IRUGO);
64 MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
67 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
68 * 10 seconds to send reply for the initial 64-byte descriptor request.
70 /* define initial 64-byte descriptor request timeout in milliseconds */
71 static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
72 module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
73 MODULE_PARM_DESC(initial_descriptor_timeout,
74 "initial 64-byte descriptor request timeout in milliseconds "
75 "(default 5000 - 5.0 seconds)");
78 * As of 2.6.10 we introduce a new USB device initialization scheme which
79 * closely resembles the way Windows works. Hopefully it will be compatible
80 * with a wider range of devices than the old scheme. However some previously
81 * working devices may start giving rise to "device not accepting address"
82 * errors; if that happens the user can try the old scheme by adjusting the
83 * following module parameters.
85 * For maximum flexibility there are two boolean parameters to control the
86 * hub driver's behavior. On the first initialization attempt, if the
87 * "old_scheme_first" parameter is set then the old scheme will be used,
88 * otherwise the new scheme is used. If that fails and "use_both_schemes"
89 * is set, then the driver will make another attempt, using the other scheme.
91 static bool old_scheme_first = 0;
92 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
93 MODULE_PARM_DESC(old_scheme_first,
94 "start with the old device initialization scheme");
96 static bool use_both_schemes = 1;
97 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
98 MODULE_PARM_DESC(use_both_schemes,
99 "try the other device initialization scheme if the "
102 /* Mutual exclusion for EHCI CF initialization. This interferes with
103 * port reset on some companion controllers.
105 DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
106 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
108 #define HUB_DEBOUNCE_TIMEOUT 2000
109 #define HUB_DEBOUNCE_STEP 25
110 #define HUB_DEBOUNCE_STABLE 100
112 static int usb_reset_and_verify_device(struct usb_device *udev);
114 static inline char *portspeed(struct usb_hub *hub, int portstatus)
116 if (hub_is_superspeed(hub->hdev))
118 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
120 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
126 /* Note that hdev or one of its children must be locked! */
127 struct usb_hub *usb_hub_to_struct_hub(struct usb_device *hdev)
129 if (!hdev || !hdev->actconfig || !hdev->maxchild)
131 return usb_get_intfdata(hdev->actconfig->interface[0]);
134 static int usb_device_supports_lpm(struct usb_device *udev)
136 /* USB 2.1 (and greater) devices indicate LPM support through
137 * their USB 2.0 Extended Capabilities BOS descriptor.
139 if (udev->speed == USB_SPEED_HIGH) {
140 if (udev->bos->ext_cap &&
142 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
148 * According to the USB 3.0 spec, all USB 3.0 devices must support LPM.
149 * However, there are some that don't, and they set the U1/U2 exit
152 if (!udev->bos->ss_cap) {
153 dev_info(&udev->dev, "No LPM exit latency info found, disabling LPM.\n");
157 if (udev->bos->ss_cap->bU1devExitLat == 0 &&
158 udev->bos->ss_cap->bU2DevExitLat == 0) {
160 dev_info(&udev->dev, "LPM exit latency is zeroed, disabling LPM.\n");
162 dev_info(&udev->dev, "We don't know the algorithms for LPM for this host, disabling LPM.\n");
166 if (!udev->parent || udev->parent->lpm_capable)
172 * Set the Maximum Exit Latency (MEL) for the host to initiate a transition from
175 static void usb_set_lpm_mel(struct usb_device *udev,
176 struct usb3_lpm_parameters *udev_lpm_params,
177 unsigned int udev_exit_latency,
179 struct usb3_lpm_parameters *hub_lpm_params,
180 unsigned int hub_exit_latency)
182 unsigned int total_mel;
183 unsigned int device_mel;
184 unsigned int hub_mel;
187 * Calculate the time it takes to transition all links from the roothub
188 * to the parent hub into U0. The parent hub must then decode the
189 * packet (hub header decode latency) to figure out which port it was
192 * The Hub Header decode latency is expressed in 0.1us intervals (0x1
193 * means 0.1us). Multiply that by 100 to get nanoseconds.
195 total_mel = hub_lpm_params->mel +
196 (hub->descriptor->u.ss.bHubHdrDecLat * 100);
199 * How long will it take to transition the downstream hub's port into
200 * U0? The greater of either the hub exit latency or the device exit
203 * The BOS U1/U2 exit latencies are expressed in 1us intervals.
204 * Multiply that by 1000 to get nanoseconds.
206 device_mel = udev_exit_latency * 1000;
207 hub_mel = hub_exit_latency * 1000;
208 if (device_mel > hub_mel)
209 total_mel += device_mel;
211 total_mel += hub_mel;
213 udev_lpm_params->mel = total_mel;
217 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
218 * a transition from either U1 or U2.
220 static void usb_set_lpm_pel(struct usb_device *udev,
221 struct usb3_lpm_parameters *udev_lpm_params,
222 unsigned int udev_exit_latency,
224 struct usb3_lpm_parameters *hub_lpm_params,
225 unsigned int hub_exit_latency,
226 unsigned int port_to_port_exit_latency)
228 unsigned int first_link_pel;
229 unsigned int hub_pel;
232 * First, the device sends an LFPS to transition the link between the
233 * device and the parent hub into U0. The exit latency is the bigger of
234 * the device exit latency or the hub exit latency.
236 if (udev_exit_latency > hub_exit_latency)
237 first_link_pel = udev_exit_latency * 1000;
239 first_link_pel = hub_exit_latency * 1000;
242 * When the hub starts to receive the LFPS, there is a slight delay for
243 * it to figure out that one of the ports is sending an LFPS. Then it
244 * will forward the LFPS to its upstream link. The exit latency is the
245 * delay, plus the PEL that we calculated for this hub.
247 hub_pel = port_to_port_exit_latency * 1000 + hub_lpm_params->pel;
250 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
251 * is the greater of the two exit latencies.
253 if (first_link_pel > hub_pel)
254 udev_lpm_params->pel = first_link_pel;
256 udev_lpm_params->pel = hub_pel;
260 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
261 * when a device initiates a transition to U0, until when it will receive the
262 * first packet from the host controller.
264 * Section C.1.5.1 describes the four components to this:
266 * - t2: time for the ERDY to make it from the device to the host.
267 * - t3: a host-specific delay to process the ERDY.
268 * - t4: time for the packet to make it from the host to the device.
270 * t3 is specific to both the xHCI host and the platform the host is integrated
271 * into. The Intel HW folks have said it's negligible, FIXME if a different
272 * vendor says otherwise.
274 static void usb_set_lpm_sel(struct usb_device *udev,
275 struct usb3_lpm_parameters *udev_lpm_params)
277 struct usb_device *parent;
278 unsigned int num_hubs;
279 unsigned int total_sel;
281 /* t1 = device PEL */
282 total_sel = udev_lpm_params->pel;
283 /* How many external hubs are in between the device & the root port. */
284 for (parent = udev->parent, num_hubs = 0; parent->parent;
285 parent = parent->parent)
287 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
289 total_sel += 2100 + 250 * (num_hubs - 1);
291 /* t4 = 250ns * num_hubs */
292 total_sel += 250 * num_hubs;
294 udev_lpm_params->sel = total_sel;
297 static void usb_set_lpm_parameters(struct usb_device *udev)
300 unsigned int port_to_port_delay;
301 unsigned int udev_u1_del;
302 unsigned int udev_u2_del;
303 unsigned int hub_u1_del;
304 unsigned int hub_u2_del;
306 if (!udev->lpm_capable || udev->speed != USB_SPEED_SUPER)
309 hub = usb_hub_to_struct_hub(udev->parent);
310 /* It doesn't take time to transition the roothub into U0, since it
311 * doesn't have an upstream link.
316 udev_u1_del = udev->bos->ss_cap->bU1devExitLat;
317 udev_u2_del = le16_to_cpu(udev->bos->ss_cap->bU2DevExitLat);
318 hub_u1_del = udev->parent->bos->ss_cap->bU1devExitLat;
319 hub_u2_del = le16_to_cpu(udev->parent->bos->ss_cap->bU2DevExitLat);
321 usb_set_lpm_mel(udev, &udev->u1_params, udev_u1_del,
322 hub, &udev->parent->u1_params, hub_u1_del);
324 usb_set_lpm_mel(udev, &udev->u2_params, udev_u2_del,
325 hub, &udev->parent->u2_params, hub_u2_del);
328 * Appendix C, section C.2.2.2, says that there is a slight delay from
329 * when the parent hub notices the downstream port is trying to
330 * transition to U0 to when the hub initiates a U0 transition on its
331 * upstream port. The section says the delays are tPort2PortU1EL and
332 * tPort2PortU2EL, but it doesn't define what they are.
334 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
335 * about the same delays. Use the maximum delay calculations from those
336 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
337 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
338 * assume the device exit latencies they are talking about are the hub
341 * What do we do if the U2 exit latency is less than the U1 exit
342 * latency? It's possible, although not likely...
344 port_to_port_delay = 1;
346 usb_set_lpm_pel(udev, &udev->u1_params, udev_u1_del,
347 hub, &udev->parent->u1_params, hub_u1_del,
350 if (hub_u2_del > hub_u1_del)
351 port_to_port_delay = 1 + hub_u2_del - hub_u1_del;
353 port_to_port_delay = 1 + hub_u1_del;
355 usb_set_lpm_pel(udev, &udev->u2_params, udev_u2_del,
356 hub, &udev->parent->u2_params, hub_u2_del,
359 /* Now that we've got PEL, calculate SEL. */
360 usb_set_lpm_sel(udev, &udev->u1_params);
361 usb_set_lpm_sel(udev, &udev->u2_params);
364 /* USB 2.0 spec Section 11.24.4.5 */
365 static int get_hub_descriptor(struct usb_device *hdev, void *data)
370 if (hub_is_superspeed(hdev)) {
371 dtype = USB_DT_SS_HUB;
372 size = USB_DT_SS_HUB_SIZE;
375 size = sizeof(struct usb_hub_descriptor);
378 for (i = 0; i < 3; i++) {
379 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
380 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
381 dtype << 8, 0, data, size,
382 USB_CTRL_GET_TIMEOUT);
383 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
390 * USB 2.0 spec Section 11.24.2.1
392 static int clear_hub_feature(struct usb_device *hdev, int feature)
394 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
395 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
399 * USB 2.0 spec Section 11.24.2.2
401 int usb_clear_port_feature(struct usb_device *hdev, int port1, int feature)
403 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
404 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
409 * USB 2.0 spec Section 11.24.2.13
411 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
413 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
414 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
418 static char *to_led_name(int selector)
435 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
436 * for info about using port indicators
438 static void set_port_led(struct usb_hub *hub, int port1, int selector)
440 struct usb_port *port_dev = hub->ports[port1 - 1];
443 status = set_port_feature(hub->hdev, (selector << 8) | port1,
444 USB_PORT_FEAT_INDICATOR);
445 dev_dbg(&port_dev->dev, "indicator %s status %d\n",
446 to_led_name(selector), status);
449 #define LED_CYCLE_PERIOD ((2*HZ)/3)
451 static void led_work (struct work_struct *work)
453 struct usb_hub *hub =
454 container_of(work, struct usb_hub, leds.work);
455 struct usb_device *hdev = hub->hdev;
457 unsigned changed = 0;
460 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
463 for (i = 0; i < hdev->maxchild; i++) {
464 unsigned selector, mode;
466 /* 30%-50% duty cycle */
468 switch (hub->indicator[i]) {
470 case INDICATOR_CYCLE:
472 selector = HUB_LED_AUTO;
473 mode = INDICATOR_AUTO;
475 /* blinking green = sw attention */
476 case INDICATOR_GREEN_BLINK:
477 selector = HUB_LED_GREEN;
478 mode = INDICATOR_GREEN_BLINK_OFF;
480 case INDICATOR_GREEN_BLINK_OFF:
481 selector = HUB_LED_OFF;
482 mode = INDICATOR_GREEN_BLINK;
484 /* blinking amber = hw attention */
485 case INDICATOR_AMBER_BLINK:
486 selector = HUB_LED_AMBER;
487 mode = INDICATOR_AMBER_BLINK_OFF;
489 case INDICATOR_AMBER_BLINK_OFF:
490 selector = HUB_LED_OFF;
491 mode = INDICATOR_AMBER_BLINK;
493 /* blink green/amber = reserved */
494 case INDICATOR_ALT_BLINK:
495 selector = HUB_LED_GREEN;
496 mode = INDICATOR_ALT_BLINK_OFF;
498 case INDICATOR_ALT_BLINK_OFF:
499 selector = HUB_LED_AMBER;
500 mode = INDICATOR_ALT_BLINK;
505 if (selector != HUB_LED_AUTO)
507 set_port_led(hub, i + 1, selector);
508 hub->indicator[i] = mode;
510 if (!changed && blinkenlights) {
512 cursor %= hdev->maxchild;
513 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
514 hub->indicator[cursor] = INDICATOR_CYCLE;
518 queue_delayed_work(system_power_efficient_wq,
519 &hub->leds, LED_CYCLE_PERIOD);
522 /* use a short timeout for hub/port status fetches */
523 #define USB_STS_TIMEOUT 1000
524 #define USB_STS_RETRIES 5
527 * USB 2.0 spec Section 11.24.2.6
529 static int get_hub_status(struct usb_device *hdev,
530 struct usb_hub_status *data)
532 int i, status = -ETIMEDOUT;
534 for (i = 0; i < USB_STS_RETRIES &&
535 (status == -ETIMEDOUT || status == -EPIPE); i++) {
536 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
537 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
538 data, sizeof(*data), USB_STS_TIMEOUT);
544 * USB 2.0 spec Section 11.24.2.7
546 static int get_port_status(struct usb_device *hdev, int port1,
547 struct usb_port_status *data)
549 int i, status = -ETIMEDOUT;
551 for (i = 0; i < USB_STS_RETRIES &&
552 (status == -ETIMEDOUT || status == -EPIPE); i++) {
553 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
554 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
555 data, sizeof(*data), USB_STS_TIMEOUT);
560 static int hub_port_status(struct usb_hub *hub, int port1,
561 u16 *status, u16 *change)
565 mutex_lock(&hub->status_mutex);
566 ret = get_port_status(hub->hdev, port1, &hub->status->port);
569 dev_err(hub->intfdev,
570 "%s failed (err = %d)\n", __func__, ret);
574 *status = le16_to_cpu(hub->status->port.wPortStatus);
575 *change = le16_to_cpu(hub->status->port.wPortChange);
579 mutex_unlock(&hub->status_mutex);
583 static void kick_khubd(struct usb_hub *hub)
587 spin_lock_irqsave(&hub_event_lock, flags);
588 if (!hub->disconnected && list_empty(&hub->event_list)) {
589 list_add_tail(&hub->event_list, &hub_event_list);
591 /* Suppress autosuspend until khubd runs */
592 usb_autopm_get_interface_no_resume(
593 to_usb_interface(hub->intfdev));
594 wake_up(&khubd_wait);
596 spin_unlock_irqrestore(&hub_event_lock, flags);
599 void usb_kick_khubd(struct usb_device *hdev)
601 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
608 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
609 * Notification, which indicates it had initiated remote wakeup.
611 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
612 * device initiates resume, so the USB core will not receive notice of the
613 * resume through the normal hub interrupt URB.
615 void usb_wakeup_notification(struct usb_device *hdev,
616 unsigned int portnum)
623 hub = usb_hub_to_struct_hub(hdev);
625 set_bit(portnum, hub->wakeup_bits);
629 EXPORT_SYMBOL_GPL(usb_wakeup_notification);
631 /* completion function, fires on port status changes and various faults */
632 static void hub_irq(struct urb *urb)
634 struct usb_hub *hub = urb->context;
635 int status = urb->status;
640 case -ENOENT: /* synchronous unlink */
641 case -ECONNRESET: /* async unlink */
642 case -ESHUTDOWN: /* hardware going away */
645 default: /* presumably an error */
646 /* Cause a hub reset after 10 consecutive errors */
647 dev_dbg (hub->intfdev, "transfer --> %d\n", status);
648 if ((++hub->nerrors < 10) || hub->error)
653 /* let khubd handle things */
654 case 0: /* we got data: port status changed */
656 for (i = 0; i < urb->actual_length; ++i)
657 bits |= ((unsigned long) ((*hub->buffer)[i]))
659 hub->event_bits[0] = bits;
665 /* Something happened, let khubd figure it out */
672 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
673 && status != -ENODEV && status != -EPERM)
674 dev_err (hub->intfdev, "resubmit --> %d\n", status);
677 /* USB 2.0 spec Section 11.24.2.3 */
679 hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
681 /* Need to clear both directions for control ep */
682 if (((devinfo >> 11) & USB_ENDPOINT_XFERTYPE_MASK) ==
683 USB_ENDPOINT_XFER_CONTROL) {
684 int status = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
685 HUB_CLEAR_TT_BUFFER, USB_RT_PORT,
686 devinfo ^ 0x8000, tt, NULL, 0, 1000);
690 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
691 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
696 * enumeration blocks khubd for a long time. we use keventd instead, since
697 * long blocking there is the exception, not the rule. accordingly, HCDs
698 * talking to TTs must queue control transfers (not just bulk and iso), so
699 * both can talk to the same hub concurrently.
701 static void hub_tt_work(struct work_struct *work)
703 struct usb_hub *hub =
704 container_of(work, struct usb_hub, tt.clear_work);
707 spin_lock_irqsave (&hub->tt.lock, flags);
708 while (!list_empty(&hub->tt.clear_list)) {
709 struct list_head *next;
710 struct usb_tt_clear *clear;
711 struct usb_device *hdev = hub->hdev;
712 const struct hc_driver *drv;
715 next = hub->tt.clear_list.next;
716 clear = list_entry (next, struct usb_tt_clear, clear_list);
717 list_del (&clear->clear_list);
719 /* drop lock so HCD can concurrently report other TT errors */
720 spin_unlock_irqrestore (&hub->tt.lock, flags);
721 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
722 if (status && status != -ENODEV)
724 "clear tt %d (%04x) error %d\n",
725 clear->tt, clear->devinfo, status);
727 /* Tell the HCD, even if the operation failed */
728 drv = clear->hcd->driver;
729 if (drv->clear_tt_buffer_complete)
730 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
733 spin_lock_irqsave(&hub->tt.lock, flags);
735 spin_unlock_irqrestore (&hub->tt.lock, flags);
739 * usb_hub_set_port_power - control hub port's power state
740 * @hdev: USB device belonging to the usb hub
743 * @set: expected status
745 * call this function to control port's power via setting or
746 * clearing the port's PORT_POWER feature.
748 * Return: 0 if successful. A negative error code otherwise.
750 int usb_hub_set_port_power(struct usb_device *hdev, struct usb_hub *hub,
754 struct usb_port *port_dev = hub->ports[port1 - 1];
757 ret = set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
759 ret = usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
762 port_dev->power_is_on = set;
767 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
768 * @urb: an URB associated with the failed or incomplete split transaction
770 * High speed HCDs use this to tell the hub driver that some split control or
771 * bulk transaction failed in a way that requires clearing internal state of
772 * a transaction translator. This is normally detected (and reported) from
775 * It may not be possible for that hub to handle additional full (or low)
776 * speed transactions until that state is fully cleared out.
778 * Return: 0 if successful. A negative error code otherwise.
780 int usb_hub_clear_tt_buffer(struct urb *urb)
782 struct usb_device *udev = urb->dev;
783 int pipe = urb->pipe;
784 struct usb_tt *tt = udev->tt;
786 struct usb_tt_clear *clear;
788 /* we've got to cope with an arbitrary number of pending TT clears,
789 * since each TT has "at least two" buffers that can need it (and
790 * there can be many TTs per hub). even if they're uncommon.
792 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
793 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
794 /* FIXME recover somehow ... RESET_TT? */
798 /* info that CLEAR_TT_BUFFER needs */
799 clear->tt = tt->multi ? udev->ttport : 1;
800 clear->devinfo = usb_pipeendpoint (pipe);
801 clear->devinfo |= udev->devnum << 4;
802 clear->devinfo |= usb_pipecontrol (pipe)
803 ? (USB_ENDPOINT_XFER_CONTROL << 11)
804 : (USB_ENDPOINT_XFER_BULK << 11);
805 if (usb_pipein (pipe))
806 clear->devinfo |= 1 << 15;
808 /* info for completion callback */
809 clear->hcd = bus_to_hcd(udev->bus);
812 /* tell keventd to clear state for this TT */
813 spin_lock_irqsave (&tt->lock, flags);
814 list_add_tail (&clear->clear_list, &tt->clear_list);
815 schedule_work(&tt->clear_work);
816 spin_unlock_irqrestore (&tt->lock, flags);
819 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
821 /* If do_delay is false, return the number of milliseconds the caller
824 static unsigned hub_power_on(struct usb_hub *hub, bool do_delay)
827 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
830 /* Enable power on each port. Some hubs have reserved values
831 * of LPSM (> 2) in their descriptors, even though they are
832 * USB 2.0 hubs. Some hubs do not implement port-power switching
833 * but only emulate it. In all cases, the ports won't work
834 * unless we send these messages to the hub.
836 if (hub_is_port_power_switchable(hub))
837 dev_dbg(hub->intfdev, "enabling power on all ports\n");
839 dev_dbg(hub->intfdev, "trying to enable port power on "
840 "non-switchable hub\n");
841 for (port1 = 1; port1 <= hub->hdev->maxchild; port1++)
842 if (hub->ports[port1 - 1]->power_is_on)
843 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
845 usb_clear_port_feature(hub->hdev, port1,
846 USB_PORT_FEAT_POWER);
848 /* Wait at least 100 msec for power to become stable */
849 delay = max(pgood_delay, (unsigned) 100);
855 static int hub_hub_status(struct usb_hub *hub,
856 u16 *status, u16 *change)
860 mutex_lock(&hub->status_mutex);
861 ret = get_hub_status(hub->hdev, &hub->status->hub);
864 dev_err(hub->intfdev,
865 "%s failed (err = %d)\n", __func__, ret);
867 *status = le16_to_cpu(hub->status->hub.wHubStatus);
868 *change = le16_to_cpu(hub->status->hub.wHubChange);
871 mutex_unlock(&hub->status_mutex);
875 static int hub_set_port_link_state(struct usb_hub *hub, int port1,
876 unsigned int link_status)
878 return set_port_feature(hub->hdev,
879 port1 | (link_status << 3),
880 USB_PORT_FEAT_LINK_STATE);
884 * If USB 3.0 ports are placed into the Disabled state, they will no longer
885 * detect any device connects or disconnects. This is generally not what the
886 * USB core wants, since it expects a disabled port to produce a port status
887 * change event when a new device connects.
889 * Instead, set the link state to Disabled, wait for the link to settle into
890 * that state, clear any change bits, and then put the port into the RxDetect
893 static int hub_usb3_port_disable(struct usb_hub *hub, int port1)
897 u16 portchange, portstatus;
899 if (!hub_is_superspeed(hub->hdev))
902 ret = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_SS_DISABLED);
906 /* Wait for the link to enter the disabled state. */
907 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
908 ret = hub_port_status(hub, port1, &portstatus, &portchange);
912 if ((portstatus & USB_PORT_STAT_LINK_STATE) ==
913 USB_SS_PORT_LS_SS_DISABLED)
915 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
917 msleep(HUB_DEBOUNCE_STEP);
919 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
920 dev_warn(&hub->ports[port1 - 1]->dev,
921 "Could not disable after %d ms\n", total_time);
923 return hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_RX_DETECT);
926 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
928 struct usb_port *port_dev = hub->ports[port1 - 1];
929 struct usb_device *hdev = hub->hdev;
932 if (port_dev->child && set_state)
933 usb_set_device_state(port_dev->child, USB_STATE_NOTATTACHED);
935 if (hub_is_superspeed(hub->hdev))
936 ret = hub_usb3_port_disable(hub, port1);
938 ret = usb_clear_port_feature(hdev, port1,
939 USB_PORT_FEAT_ENABLE);
941 if (ret && ret != -ENODEV)
942 dev_err(&port_dev->dev, "cannot disable (err = %d)\n", ret);
947 * Disable a port and mark a logical connect-change event, so that some
948 * time later khubd will disconnect() any existing usb_device on the port
949 * and will re-enumerate if there actually is a device attached.
951 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
953 dev_dbg(&hub->ports[port1 - 1]->dev, "logical disconnect\n");
954 hub_port_disable(hub, port1, 1);
956 /* FIXME let caller ask to power down the port:
957 * - some devices won't enumerate without a VBUS power cycle
958 * - SRP saves power that way
959 * - ... new call, TBD ...
960 * That's easy if this hub can switch power per-port, and
961 * khubd reactivates the port later (timer, SRP, etc).
962 * Powerdown must be optional, because of reset/DFU.
965 set_bit(port1, hub->change_bits);
970 * usb_remove_device - disable a device's port on its parent hub
971 * @udev: device to be disabled and removed
972 * Context: @udev locked, must be able to sleep.
974 * After @udev's port has been disabled, khubd is notified and it will
975 * see that the device has been disconnected. When the device is
976 * physically unplugged and something is plugged in, the events will
977 * be received and processed normally.
979 * Return: 0 if successful. A negative error code otherwise.
981 int usb_remove_device(struct usb_device *udev)
984 struct usb_interface *intf;
986 if (!udev->parent) /* Can't remove a root hub */
988 hub = usb_hub_to_struct_hub(udev->parent);
989 intf = to_usb_interface(hub->intfdev);
991 usb_autopm_get_interface(intf);
992 set_bit(udev->portnum, hub->removed_bits);
993 hub_port_logical_disconnect(hub, udev->portnum);
994 usb_autopm_put_interface(intf);
998 enum hub_activation_type {
999 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
1000 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
1003 static void hub_init_func2(struct work_struct *ws);
1004 static void hub_init_func3(struct work_struct *ws);
1006 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
1008 struct usb_device *hdev = hub->hdev;
1009 struct usb_hcd *hcd;
1013 bool need_debounce_delay = false;
1016 /* Continue a partial initialization */
1017 if (type == HUB_INIT2)
1019 if (type == HUB_INIT3)
1022 /* The superspeed hub except for root hub has to use Hub Depth
1023 * value as an offset into the route string to locate the bits
1024 * it uses to determine the downstream port number. So hub driver
1025 * should send a set hub depth request to superspeed hub after
1026 * the superspeed hub is set configuration in initialization or
1029 * After a resume, port power should still be on.
1030 * For any other type of activation, turn it on.
1032 if (type != HUB_RESUME) {
1033 if (hdev->parent && hub_is_superspeed(hdev)) {
1034 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
1035 HUB_SET_DEPTH, USB_RT_HUB,
1036 hdev->level - 1, 0, NULL, 0,
1037 USB_CTRL_SET_TIMEOUT);
1039 dev_err(hub->intfdev,
1040 "set hub depth failed\n");
1043 /* Speed up system boot by using a delayed_work for the
1044 * hub's initial power-up delays. This is pretty awkward
1045 * and the implementation looks like a home-brewed sort of
1046 * setjmp/longjmp, but it saves at least 100 ms for each
1047 * root hub (assuming usbcore is compiled into the kernel
1048 * rather than as a module). It adds up.
1050 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1051 * because for those activation types the ports have to be
1052 * operational when we return. In theory this could be done
1053 * for HUB_POST_RESET, but it's easier not to.
1055 if (type == HUB_INIT) {
1056 delay = hub_power_on(hub, false);
1057 INIT_DELAYED_WORK(&hub->init_work, hub_init_func2);
1058 queue_delayed_work(system_power_efficient_wq,
1060 msecs_to_jiffies(delay));
1062 /* Suppress autosuspend until init is done */
1063 usb_autopm_get_interface_no_resume(
1064 to_usb_interface(hub->intfdev));
1065 return; /* Continues at init2: below */
1066 } else if (type == HUB_RESET_RESUME) {
1067 /* The internal host controller state for the hub device
1068 * may be gone after a host power loss on system resume.
1069 * Update the device's info so the HW knows it's a hub.
1071 hcd = bus_to_hcd(hdev->bus);
1072 if (hcd->driver->update_hub_device) {
1073 ret = hcd->driver->update_hub_device(hcd, hdev,
1074 &hub->tt, GFP_NOIO);
1076 dev_err(hub->intfdev, "Host not "
1077 "accepting hub info "
1079 dev_err(hub->intfdev, "LS/FS devices "
1080 "and hubs may not work "
1081 "under this hub\n.");
1084 hub_power_on(hub, true);
1086 hub_power_on(hub, true);
1092 * Check each port and set hub->change_bits to let khubd know
1093 * which ports need attention.
1095 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
1096 struct usb_port *port_dev = hub->ports[port1 - 1];
1097 struct usb_device *udev = port_dev->child;
1098 u16 portstatus, portchange;
1100 portstatus = portchange = 0;
1101 status = hub_port_status(hub, port1, &portstatus, &portchange);
1102 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1103 dev_dbg(&port_dev->dev, "status %04x change %04x\n",
1104 portstatus, portchange);
1107 * After anything other than HUB_RESUME (i.e., initialization
1108 * or any sort of reset), every port should be disabled.
1109 * Unconnected ports should likewise be disabled (paranoia),
1110 * and so should ports for which we have no usb_device.
1112 if ((portstatus & USB_PORT_STAT_ENABLE) && (
1113 type != HUB_RESUME ||
1114 !(portstatus & USB_PORT_STAT_CONNECTION) ||
1116 udev->state == USB_STATE_NOTATTACHED)) {
1118 * USB3 protocol ports will automatically transition
1119 * to Enabled state when detect an USB3.0 device attach.
1120 * Do not disable USB3 protocol ports, just pretend
1123 portstatus &= ~USB_PORT_STAT_ENABLE;
1124 if (!hub_is_superspeed(hdev))
1125 usb_clear_port_feature(hdev, port1,
1126 USB_PORT_FEAT_ENABLE);
1129 /* Clear status-change flags; we'll debounce later */
1130 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1131 need_debounce_delay = true;
1132 usb_clear_port_feature(hub->hdev, port1,
1133 USB_PORT_FEAT_C_CONNECTION);
1135 if (portchange & USB_PORT_STAT_C_ENABLE) {
1136 need_debounce_delay = true;
1137 usb_clear_port_feature(hub->hdev, port1,
1138 USB_PORT_FEAT_C_ENABLE);
1140 if (portchange & USB_PORT_STAT_C_RESET) {
1141 need_debounce_delay = true;
1142 usb_clear_port_feature(hub->hdev, port1,
1143 USB_PORT_FEAT_C_RESET);
1145 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
1146 hub_is_superspeed(hub->hdev)) {
1147 need_debounce_delay = true;
1148 usb_clear_port_feature(hub->hdev, port1,
1149 USB_PORT_FEAT_C_BH_PORT_RESET);
1151 /* We can forget about a "removed" device when there's a
1152 * physical disconnect or the connect status changes.
1154 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
1155 (portchange & USB_PORT_STAT_C_CONNECTION))
1156 clear_bit(port1, hub->removed_bits);
1158 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
1159 /* Tell khubd to disconnect the device or
1160 * check for a new connection
1162 if (udev || (portstatus & USB_PORT_STAT_CONNECTION) ||
1163 (portstatus & USB_PORT_STAT_OVERCURRENT))
1164 set_bit(port1, hub->change_bits);
1166 } else if (portstatus & USB_PORT_STAT_ENABLE) {
1167 bool port_resumed = (portstatus &
1168 USB_PORT_STAT_LINK_STATE) ==
1170 /* The power session apparently survived the resume.
1171 * If there was an overcurrent or suspend change
1172 * (i.e., remote wakeup request), have khubd
1173 * take care of it. Look at the port link state
1174 * for USB 3.0 hubs, since they don't have a suspend
1175 * change bit, and they don't set the port link change
1176 * bit on device-initiated resume.
1178 if (portchange || (hub_is_superspeed(hub->hdev) &&
1180 set_bit(port1, hub->change_bits);
1182 } else if (udev->persist_enabled) {
1183 struct usb_port *port_dev = hub->ports[port1 - 1];
1186 udev->reset_resume = 1;
1188 /* Don't set the change_bits when the device
1191 if (port_dev->power_is_on)
1192 set_bit(port1, hub->change_bits);
1195 /* The power session is gone; tell khubd */
1196 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1197 set_bit(port1, hub->change_bits);
1201 /* If no port-status-change flags were set, we don't need any
1202 * debouncing. If flags were set we can try to debounce the
1203 * ports all at once right now, instead of letting khubd do them
1204 * one at a time later on.
1206 * If any port-status changes do occur during this delay, khubd
1207 * will see them later and handle them normally.
1209 if (need_debounce_delay) {
1210 delay = HUB_DEBOUNCE_STABLE;
1212 /* Don't do a long sleep inside a workqueue routine */
1213 if (type == HUB_INIT2) {
1214 INIT_DELAYED_WORK(&hub->init_work, hub_init_func3);
1215 queue_delayed_work(system_power_efficient_wq,
1217 msecs_to_jiffies(delay));
1218 return; /* Continues at init3: below */
1226 status = usb_submit_urb(hub->urb, GFP_NOIO);
1228 dev_err(hub->intfdev, "activate --> %d\n", status);
1229 if (hub->has_indicators && blinkenlights)
1230 queue_delayed_work(system_power_efficient_wq,
1231 &hub->leds, LED_CYCLE_PERIOD);
1233 /* Scan all ports that need attention */
1236 /* Allow autosuspend if it was suppressed */
1237 if (type <= HUB_INIT3)
1238 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
1241 /* Implement the continuations for the delays above */
1242 static void hub_init_func2(struct work_struct *ws)
1244 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1246 hub_activate(hub, HUB_INIT2);
1249 static void hub_init_func3(struct work_struct *ws)
1251 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1253 hub_activate(hub, HUB_INIT3);
1256 enum hub_quiescing_type {
1257 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
1260 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
1262 struct usb_device *hdev = hub->hdev;
1265 cancel_delayed_work_sync(&hub->init_work);
1267 /* khubd and related activity won't re-trigger */
1270 if (type != HUB_SUSPEND) {
1271 /* Disconnect all the children */
1272 for (i = 0; i < hdev->maxchild; ++i) {
1273 if (hub->ports[i]->child)
1274 usb_disconnect(&hub->ports[i]->child);
1278 /* Stop khubd and related activity */
1279 usb_kill_urb(hub->urb);
1280 if (hub->has_indicators)
1281 cancel_delayed_work_sync(&hub->leds);
1283 flush_work(&hub->tt.clear_work);
1286 static void hub_pm_barrier_for_all_ports(struct usb_hub *hub)
1290 for (i = 0; i < hub->hdev->maxchild; ++i)
1291 pm_runtime_barrier(&hub->ports[i]->dev);
1294 /* caller has locked the hub device */
1295 static int hub_pre_reset(struct usb_interface *intf)
1297 struct usb_hub *hub = usb_get_intfdata(intf);
1299 hub_quiesce(hub, HUB_PRE_RESET);
1301 hub_pm_barrier_for_all_ports(hub);
1305 /* caller has locked the hub device */
1306 static int hub_post_reset(struct usb_interface *intf)
1308 struct usb_hub *hub = usb_get_intfdata(intf);
1311 hub_pm_barrier_for_all_ports(hub);
1312 hub_activate(hub, HUB_POST_RESET);
1316 static int hub_configure(struct usb_hub *hub,
1317 struct usb_endpoint_descriptor *endpoint)
1319 struct usb_hcd *hcd;
1320 struct usb_device *hdev = hub->hdev;
1321 struct device *hub_dev = hub->intfdev;
1322 u16 hubstatus, hubchange;
1323 u16 wHubCharacteristics;
1326 char *message = "out of memory";
1331 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
1337 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1342 mutex_init(&hub->status_mutex);
1344 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1345 if (!hub->descriptor) {
1350 /* Request the entire hub descriptor.
1351 * hub->descriptor can handle USB_MAXCHILDREN ports,
1352 * but the hub can/will return fewer bytes here.
1354 ret = get_hub_descriptor(hdev, hub->descriptor);
1356 message = "can't read hub descriptor";
1358 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
1359 message = "hub has too many ports!";
1362 } else if (hub->descriptor->bNbrPorts == 0) {
1363 message = "hub doesn't have any ports!";
1368 maxchild = hub->descriptor->bNbrPorts;
1369 dev_info(hub_dev, "%d port%s detected\n", maxchild,
1370 (maxchild == 1) ? "" : "s");
1372 hub->ports = kzalloc(maxchild * sizeof(struct usb_port *), GFP_KERNEL);
1378 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1379 if (hub_is_superspeed(hdev)) {
1387 /* FIXME for USB 3.0, skip for now */
1388 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1389 !(hub_is_superspeed(hdev))) {
1391 char portstr[USB_MAXCHILDREN + 1];
1393 for (i = 0; i < maxchild; i++)
1394 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1395 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1397 portstr[maxchild] = 0;
1398 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1400 dev_dbg(hub_dev, "standalone hub\n");
1402 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1403 case HUB_CHAR_COMMON_LPSM:
1404 dev_dbg(hub_dev, "ganged power switching\n");
1406 case HUB_CHAR_INDV_PORT_LPSM:
1407 dev_dbg(hub_dev, "individual port power switching\n");
1409 case HUB_CHAR_NO_LPSM:
1411 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1415 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1416 case HUB_CHAR_COMMON_OCPM:
1417 dev_dbg(hub_dev, "global over-current protection\n");
1419 case HUB_CHAR_INDV_PORT_OCPM:
1420 dev_dbg(hub_dev, "individual port over-current protection\n");
1422 case HUB_CHAR_NO_OCPM:
1424 dev_dbg(hub_dev, "no over-current protection\n");
1428 spin_lock_init (&hub->tt.lock);
1429 INIT_LIST_HEAD (&hub->tt.clear_list);
1430 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1431 switch (hdev->descriptor.bDeviceProtocol) {
1434 case USB_HUB_PR_HS_SINGLE_TT:
1435 dev_dbg(hub_dev, "Single TT\n");
1438 case USB_HUB_PR_HS_MULTI_TT:
1439 ret = usb_set_interface(hdev, 0, 1);
1441 dev_dbg(hub_dev, "TT per port\n");
1444 dev_err(hub_dev, "Using single TT (err %d)\n",
1449 /* USB 3.0 hubs don't have a TT */
1452 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1453 hdev->descriptor.bDeviceProtocol);
1457 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1458 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1459 case HUB_TTTT_8_BITS:
1460 if (hdev->descriptor.bDeviceProtocol != 0) {
1461 hub->tt.think_time = 666;
1462 dev_dbg(hub_dev, "TT requires at most %d "
1463 "FS bit times (%d ns)\n",
1464 8, hub->tt.think_time);
1467 case HUB_TTTT_16_BITS:
1468 hub->tt.think_time = 666 * 2;
1469 dev_dbg(hub_dev, "TT requires at most %d "
1470 "FS bit times (%d ns)\n",
1471 16, hub->tt.think_time);
1473 case HUB_TTTT_24_BITS:
1474 hub->tt.think_time = 666 * 3;
1475 dev_dbg(hub_dev, "TT requires at most %d "
1476 "FS bit times (%d ns)\n",
1477 24, hub->tt.think_time);
1479 case HUB_TTTT_32_BITS:
1480 hub->tt.think_time = 666 * 4;
1481 dev_dbg(hub_dev, "TT requires at most %d "
1482 "FS bit times (%d ns)\n",
1483 32, hub->tt.think_time);
1487 /* probe() zeroes hub->indicator[] */
1488 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1489 hub->has_indicators = 1;
1490 dev_dbg(hub_dev, "Port indicators are supported\n");
1493 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1494 hub->descriptor->bPwrOn2PwrGood * 2);
1496 /* power budgeting mostly matters with bus-powered hubs,
1497 * and battery-powered root hubs (may provide just 8 mA).
1499 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1501 message = "can't get hub status";
1504 hcd = bus_to_hcd(hdev->bus);
1505 if (hdev == hdev->bus->root_hub) {
1506 if (hcd->power_budget > 0)
1507 hdev->bus_mA = hcd->power_budget;
1509 hdev->bus_mA = full_load * maxchild;
1510 if (hdev->bus_mA >= full_load)
1511 hub->mA_per_port = full_load;
1513 hub->mA_per_port = hdev->bus_mA;
1514 hub->limited_power = 1;
1516 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1517 int remaining = hdev->bus_mA -
1518 hub->descriptor->bHubContrCurrent;
1520 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1521 hub->descriptor->bHubContrCurrent);
1522 hub->limited_power = 1;
1524 if (remaining < maxchild * unit_load)
1526 "insufficient power available "
1527 "to use all downstream ports\n");
1528 hub->mA_per_port = unit_load; /* 7.2.1 */
1530 } else { /* Self-powered external hub */
1531 /* FIXME: What about battery-powered external hubs that
1532 * provide less current per port? */
1533 hub->mA_per_port = full_load;
1535 if (hub->mA_per_port < full_load)
1536 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1539 /* Update the HCD's internal representation of this hub before khubd
1540 * starts getting port status changes for devices under the hub.
1542 if (hcd->driver->update_hub_device) {
1543 ret = hcd->driver->update_hub_device(hcd, hdev,
1544 &hub->tt, GFP_KERNEL);
1546 message = "can't update HCD hub info";
1551 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1553 message = "can't get hub status";
1557 /* local power status reports aren't always correct */
1558 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1559 dev_dbg(hub_dev, "local power source is %s\n",
1560 (hubstatus & HUB_STATUS_LOCAL_POWER)
1561 ? "lost (inactive)" : "good");
1563 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1564 dev_dbg(hub_dev, "%sover-current condition exists\n",
1565 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1567 /* set up the interrupt endpoint
1568 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1569 * bytes as USB2.0[11.12.3] says because some hubs are known
1570 * to send more data (and thus cause overflow). For root hubs,
1571 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1572 * to be big enough for at least USB_MAXCHILDREN ports. */
1573 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1574 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1576 if (maxp > sizeof(*hub->buffer))
1577 maxp = sizeof(*hub->buffer);
1579 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1585 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1586 hub, endpoint->bInterval);
1588 /* maybe cycle the hub leds */
1589 if (hub->has_indicators && blinkenlights)
1590 hub->indicator[0] = INDICATOR_CYCLE;
1592 mutex_lock(&usb_port_peer_mutex);
1593 for (i = 0; i < maxchild; i++) {
1594 ret = usb_hub_create_port_device(hub, i + 1);
1596 dev_err(hub->intfdev,
1597 "couldn't create port%d device.\n", i + 1);
1602 mutex_unlock(&usb_port_peer_mutex);
1606 usb_hub_adjust_deviceremovable(hdev, hub->descriptor);
1608 hub_activate(hub, HUB_INIT);
1612 dev_err (hub_dev, "config failed, %s (err %d)\n",
1614 /* hub_disconnect() frees urb and descriptor */
1618 static void hub_release(struct kref *kref)
1620 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1622 usb_put_intf(to_usb_interface(hub->intfdev));
1626 static unsigned highspeed_hubs;
1628 static void hub_disconnect(struct usb_interface *intf)
1630 struct usb_hub *hub = usb_get_intfdata(intf);
1631 struct usb_device *hdev = interface_to_usbdev(intf);
1634 /* Take the hub off the event list and don't let it be added again */
1635 spin_lock_irq(&hub_event_lock);
1636 if (!list_empty(&hub->event_list)) {
1637 list_del_init(&hub->event_list);
1638 usb_autopm_put_interface_no_suspend(intf);
1640 hub->disconnected = 1;
1641 spin_unlock_irq(&hub_event_lock);
1643 /* Disconnect all children and quiesce the hub */
1645 hub_quiesce(hub, HUB_DISCONNECT);
1647 mutex_lock(&usb_port_peer_mutex);
1649 /* Avoid races with recursively_mark_NOTATTACHED() */
1650 spin_lock_irq(&device_state_lock);
1651 port1 = hdev->maxchild;
1653 usb_set_intfdata(intf, NULL);
1654 spin_unlock_irq(&device_state_lock);
1656 for (; port1 > 0; --port1)
1657 usb_hub_remove_port_device(hub, port1);
1659 mutex_unlock(&usb_port_peer_mutex);
1661 if (hub->hdev->speed == USB_SPEED_HIGH)
1664 usb_free_urb(hub->urb);
1666 kfree(hub->descriptor);
1670 pm_suspend_ignore_children(&intf->dev, false);
1671 kref_put(&hub->kref, hub_release);
1674 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1676 struct usb_host_interface *desc;
1677 struct usb_endpoint_descriptor *endpoint;
1678 struct usb_device *hdev;
1679 struct usb_hub *hub;
1681 desc = intf->cur_altsetting;
1682 hdev = interface_to_usbdev(intf);
1685 * Set default autosuspend delay as 0 to speedup bus suspend,
1686 * based on the below considerations:
1688 * - Unlike other drivers, the hub driver does not rely on the
1689 * autosuspend delay to provide enough time to handle a wakeup
1690 * event, and the submitted status URB is just to check future
1691 * change on hub downstream ports, so it is safe to do it.
1693 * - The patch might cause one or more auto supend/resume for
1694 * below very rare devices when they are plugged into hub
1697 * devices having trouble initializing, and disconnect
1698 * themselves from the bus and then reconnect a second
1701 * devices just for downloading firmware, and disconnects
1702 * themselves after completing it
1704 * For these quite rare devices, their drivers may change the
1705 * autosuspend delay of their parent hub in the probe() to one
1706 * appropriate value to avoid the subtle problem if someone
1709 * - The patch may cause one or more auto suspend/resume on
1710 * hub during running 'lsusb', but it is probably too
1711 * infrequent to worry about.
1713 * - Change autosuspend delay of hub can avoid unnecessary auto
1714 * suspend timer for hub, also may decrease power consumption
1717 pm_runtime_set_autosuspend_delay(&hdev->dev, 0);
1719 /* Hubs have proper suspend/resume support. */
1720 usb_enable_autosuspend(hdev);
1722 if (hdev->level == MAX_TOPO_LEVEL) {
1724 "Unsupported bus topology: hub nested too deep\n");
1728 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1730 dev_warn(&intf->dev, "ignoring external hub\n");
1735 /* Some hubs have a subclass of 1, which AFAICT according to the */
1736 /* specs is not defined, but it works */
1737 if ((desc->desc.bInterfaceSubClass != 0) &&
1738 (desc->desc.bInterfaceSubClass != 1)) {
1740 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1744 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1745 if (desc->desc.bNumEndpoints != 1)
1746 goto descriptor_error;
1748 endpoint = &desc->endpoint[0].desc;
1750 /* If it's not an interrupt in endpoint, we'd better punt! */
1751 if (!usb_endpoint_is_int_in(endpoint))
1752 goto descriptor_error;
1754 /* We found a hub */
1755 dev_info (&intf->dev, "USB hub found\n");
1757 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1759 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1763 kref_init(&hub->kref);
1764 INIT_LIST_HEAD(&hub->event_list);
1765 hub->intfdev = &intf->dev;
1767 INIT_DELAYED_WORK(&hub->leds, led_work);
1768 INIT_DELAYED_WORK(&hub->init_work, NULL);
1771 usb_set_intfdata (intf, hub);
1772 intf->needs_remote_wakeup = 1;
1773 pm_suspend_ignore_children(&intf->dev, true);
1775 if (hdev->speed == USB_SPEED_HIGH)
1778 if (id->driver_info & HUB_QUIRK_CHECK_PORT_AUTOSUSPEND)
1779 hub->quirk_check_port_auto_suspend = 1;
1781 if (hub_configure(hub, endpoint) >= 0)
1784 hub_disconnect (intf);
1789 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1791 struct usb_device *hdev = interface_to_usbdev (intf);
1792 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1794 /* assert ifno == 0 (part of hub spec) */
1796 case USBDEVFS_HUB_PORTINFO: {
1797 struct usbdevfs_hub_portinfo *info = user_data;
1800 spin_lock_irq(&device_state_lock);
1801 if (hdev->devnum <= 0)
1804 info->nports = hdev->maxchild;
1805 for (i = 0; i < info->nports; i++) {
1806 if (hub->ports[i]->child == NULL)
1810 hub->ports[i]->child->devnum;
1813 spin_unlock_irq(&device_state_lock);
1815 return info->nports + 1;
1824 * Allow user programs to claim ports on a hub. When a device is attached
1825 * to one of these "claimed" ports, the program will "own" the device.
1827 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1828 struct usb_dev_state ***ppowner)
1830 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1832 if (hdev->state == USB_STATE_NOTATTACHED)
1834 if (port1 == 0 || port1 > hdev->maxchild)
1837 /* Devices not managed by the hub driver
1838 * will always have maxchild equal to 0.
1840 *ppowner = &(hub->ports[port1 - 1]->port_owner);
1844 /* In the following three functions, the caller must hold hdev's lock */
1845 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
1846 struct usb_dev_state *owner)
1849 struct usb_dev_state **powner;
1851 rc = find_port_owner(hdev, port1, &powner);
1859 EXPORT_SYMBOL_GPL(usb_hub_claim_port);
1861 int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
1862 struct usb_dev_state *owner)
1865 struct usb_dev_state **powner;
1867 rc = find_port_owner(hdev, port1, &powner);
1870 if (*powner != owner)
1875 EXPORT_SYMBOL_GPL(usb_hub_release_port);
1877 void usb_hub_release_all_ports(struct usb_device *hdev, struct usb_dev_state *owner)
1879 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1882 for (n = 0; n < hdev->maxchild; n++) {
1883 if (hub->ports[n]->port_owner == owner)
1884 hub->ports[n]->port_owner = NULL;
1889 /* The caller must hold udev's lock */
1890 bool usb_device_is_owned(struct usb_device *udev)
1892 struct usb_hub *hub;
1894 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1896 hub = usb_hub_to_struct_hub(udev->parent);
1897 return !!hub->ports[udev->portnum - 1]->port_owner;
1900 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1902 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
1905 for (i = 0; i < udev->maxchild; ++i) {
1906 if (hub->ports[i]->child)
1907 recursively_mark_NOTATTACHED(hub->ports[i]->child);
1909 if (udev->state == USB_STATE_SUSPENDED)
1910 udev->active_duration -= jiffies;
1911 udev->state = USB_STATE_NOTATTACHED;
1915 * usb_set_device_state - change a device's current state (usbcore, hcds)
1916 * @udev: pointer to device whose state should be changed
1917 * @new_state: new state value to be stored
1919 * udev->state is _not_ fully protected by the device lock. Although
1920 * most transitions are made only while holding the lock, the state can
1921 * can change to USB_STATE_NOTATTACHED at almost any time. This
1922 * is so that devices can be marked as disconnected as soon as possible,
1923 * without having to wait for any semaphores to be released. As a result,
1924 * all changes to any device's state must be protected by the
1925 * device_state_lock spinlock.
1927 * Once a device has been added to the device tree, all changes to its state
1928 * should be made using this routine. The state should _not_ be set directly.
1930 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1931 * Otherwise udev->state is set to new_state, and if new_state is
1932 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1933 * to USB_STATE_NOTATTACHED.
1935 void usb_set_device_state(struct usb_device *udev,
1936 enum usb_device_state new_state)
1938 unsigned long flags;
1941 spin_lock_irqsave(&device_state_lock, flags);
1942 if (udev->state == USB_STATE_NOTATTACHED)
1944 else if (new_state != USB_STATE_NOTATTACHED) {
1946 /* root hub wakeup capabilities are managed out-of-band
1947 * and may involve silicon errata ... ignore them here.
1950 if (udev->state == USB_STATE_SUSPENDED
1951 || new_state == USB_STATE_SUSPENDED)
1952 ; /* No change to wakeup settings */
1953 else if (new_state == USB_STATE_CONFIGURED)
1954 wakeup = udev->actconfig->desc.bmAttributes
1955 & USB_CONFIG_ATT_WAKEUP;
1959 if (udev->state == USB_STATE_SUSPENDED &&
1960 new_state != USB_STATE_SUSPENDED)
1961 udev->active_duration -= jiffies;
1962 else if (new_state == USB_STATE_SUSPENDED &&
1963 udev->state != USB_STATE_SUSPENDED)
1964 udev->active_duration += jiffies;
1965 udev->state = new_state;
1967 recursively_mark_NOTATTACHED(udev);
1968 spin_unlock_irqrestore(&device_state_lock, flags);
1970 device_set_wakeup_capable(&udev->dev, wakeup);
1972 EXPORT_SYMBOL_GPL(usb_set_device_state);
1975 * Choose a device number.
1977 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1978 * USB-2.0 buses they are also used as device addresses, however on
1979 * USB-3.0 buses the address is assigned by the controller hardware
1980 * and it usually is not the same as the device number.
1982 * WUSB devices are simple: they have no hubs behind, so the mapping
1983 * device <-> virtual port number becomes 1:1. Why? to simplify the
1984 * life of the device connection logic in
1985 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1986 * handshake we need to assign a temporary address in the unauthorized
1987 * space. For simplicity we use the first virtual port number found to
1988 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1989 * and that becomes it's address [X < 128] or its unauthorized address
1992 * We add 1 as an offset to the one-based USB-stack port number
1993 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1994 * 0 is reserved by USB for default address; (b) Linux's USB stack
1995 * uses always #1 for the root hub of the controller. So USB stack's
1996 * port #1, which is wusb virtual-port #0 has address #2.
1998 * Devices connected under xHCI are not as simple. The host controller
1999 * supports virtualization, so the hardware assigns device addresses and
2000 * the HCD must setup data structures before issuing a set address
2001 * command to the hardware.
2003 static void choose_devnum(struct usb_device *udev)
2006 struct usb_bus *bus = udev->bus;
2008 /* If khubd ever becomes multithreaded, this will need a lock */
2010 devnum = udev->portnum + 1;
2011 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
2013 /* Try to allocate the next devnum beginning at
2014 * bus->devnum_next. */
2015 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
2018 devnum = find_next_zero_bit(bus->devmap.devicemap,
2020 bus->devnum_next = (devnum >= 127 ? 1 : devnum + 1);
2023 set_bit(devnum, bus->devmap.devicemap);
2024 udev->devnum = devnum;
2028 static void release_devnum(struct usb_device *udev)
2030 if (udev->devnum > 0) {
2031 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
2036 static void update_devnum(struct usb_device *udev, int devnum)
2038 /* The address for a WUSB device is managed by wusbcore. */
2040 udev->devnum = devnum;
2043 static void hub_free_dev(struct usb_device *udev)
2045 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2047 /* Root hubs aren't real devices, so don't free HCD resources */
2048 if (hcd->driver->free_dev && udev->parent)
2049 hcd->driver->free_dev(hcd, udev);
2053 * usb_disconnect - disconnect a device (usbcore-internal)
2054 * @pdev: pointer to device being disconnected
2055 * Context: !in_interrupt ()
2057 * Something got disconnected. Get rid of it and all of its children.
2059 * If *pdev is a normal device then the parent hub must already be locked.
2060 * If *pdev is a root hub then the caller must hold the usb_bus_list_lock,
2061 * which protects the set of root hubs as well as the list of buses.
2063 * Only hub drivers (including virtual root hub drivers for host
2064 * controllers) should ever call this.
2066 * This call is synchronous, and may not be used in an interrupt context.
2068 void usb_disconnect(struct usb_device **pdev)
2070 struct usb_device *udev = *pdev;
2071 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2074 /* mark the device as inactive, so any further urb submissions for
2075 * this device (and any of its children) will fail immediately.
2076 * this quiesces everything except pending urbs.
2078 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2079 dev_info(&udev->dev, "USB disconnect, device number %d\n",
2082 usb_lock_device(udev);
2084 /* Free up all the children before we remove this device */
2085 for (i = 0; i < udev->maxchild; i++) {
2086 if (hub->ports[i]->child)
2087 usb_disconnect(&hub->ports[i]->child);
2090 /* deallocate hcd/hardware state ... nuking all pending urbs and
2091 * cleaning up all state associated with the current configuration
2092 * so that the hardware is now fully quiesced.
2094 dev_dbg (&udev->dev, "unregistering device\n");
2095 usb_disable_device(udev, 0);
2096 usb_hcd_synchronize_unlinks(udev);
2099 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2100 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
2102 sysfs_remove_link(&udev->dev.kobj, "port");
2103 sysfs_remove_link(&port_dev->dev.kobj, "device");
2105 if (!port_dev->did_runtime_put)
2106 pm_runtime_put(&port_dev->dev);
2108 port_dev->did_runtime_put = false;
2111 usb_remove_ep_devs(&udev->ep0);
2112 usb_unlock_device(udev);
2114 /* Unregister the device. The device driver is responsible
2115 * for de-configuring the device and invoking the remove-device
2116 * notifier chain (used by usbfs and possibly others).
2118 device_del(&udev->dev);
2120 /* Free the device number and delete the parent's children[]
2121 * (or root_hub) pointer.
2123 release_devnum(udev);
2125 /* Avoid races with recursively_mark_NOTATTACHED() */
2126 spin_lock_irq(&device_state_lock);
2128 spin_unlock_irq(&device_state_lock);
2132 put_device(&udev->dev);
2135 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2136 static void show_string(struct usb_device *udev, char *id, char *string)
2140 dev_info(&udev->dev, "%s: %s\n", id, string);
2143 static void announce_device(struct usb_device *udev)
2145 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2146 le16_to_cpu(udev->descriptor.idVendor),
2147 le16_to_cpu(udev->descriptor.idProduct));
2148 dev_info(&udev->dev,
2149 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2150 udev->descriptor.iManufacturer,
2151 udev->descriptor.iProduct,
2152 udev->descriptor.iSerialNumber);
2153 show_string(udev, "Product", udev->product);
2154 show_string(udev, "Manufacturer", udev->manufacturer);
2155 show_string(udev, "SerialNumber", udev->serial);
2158 static inline void announce_device(struct usb_device *udev) { }
2161 #ifdef CONFIG_USB_OTG
2162 #include "otg_whitelist.h"
2166 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2167 * @udev: newly addressed device (in ADDRESS state)
2169 * Finish enumeration for On-The-Go devices
2171 * Return: 0 if successful. A negative error code otherwise.
2173 static int usb_enumerate_device_otg(struct usb_device *udev)
2177 #ifdef CONFIG_USB_OTG
2179 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2180 * to wake us after we've powered off VBUS; and HNP, switching roles
2181 * "host" to "peripheral". The OTG descriptor helps figure this out.
2183 if (!udev->bus->is_b_host
2185 && udev->parent == udev->bus->root_hub) {
2186 struct usb_otg_descriptor *desc = NULL;
2187 struct usb_bus *bus = udev->bus;
2189 /* descriptor may appear anywhere in config */
2190 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
2191 le16_to_cpu(udev->config[0].desc.wTotalLength),
2192 USB_DT_OTG, (void **) &desc) == 0) {
2193 if (desc->bmAttributes & USB_OTG_HNP) {
2194 unsigned port1 = udev->portnum;
2196 dev_info(&udev->dev,
2197 "Dual-Role OTG device on %sHNP port\n",
2198 (port1 == bus->otg_port)
2201 /* enable HNP before suspend, it's simpler */
2202 if (port1 == bus->otg_port)
2203 bus->b_hnp_enable = 1;
2204 err = usb_control_msg(udev,
2205 usb_sndctrlpipe(udev, 0),
2206 USB_REQ_SET_FEATURE, 0,
2208 ? USB_DEVICE_B_HNP_ENABLE
2209 : USB_DEVICE_A_ALT_HNP_SUPPORT,
2210 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
2212 /* OTG MESSAGE: report errors here,
2213 * customize to match your product.
2215 dev_info(&udev->dev,
2216 "can't set HNP mode: %d\n",
2218 bus->b_hnp_enable = 0;
2224 if (!is_targeted(udev)) {
2226 /* Maybe it can talk to us, though we can't talk to it.
2227 * (Includes HNP test device.)
2229 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
2230 err = usb_port_suspend(udev, PMSG_SUSPEND);
2232 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
2244 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2245 * @udev: newly addressed device (in ADDRESS state)
2247 * This is only called by usb_new_device() and usb_authorize_device()
2248 * and FIXME -- all comments that apply to them apply here wrt to
2251 * If the device is WUSB and not authorized, we don't attempt to read
2252 * the string descriptors, as they will be errored out by the device
2253 * until it has been authorized.
2255 * Return: 0 if successful. A negative error code otherwise.
2257 static int usb_enumerate_device(struct usb_device *udev)
2261 if (udev->config == NULL) {
2262 err = usb_get_configuration(udev);
2265 dev_err(&udev->dev, "can't read configurations, error %d\n",
2271 /* read the standard strings and cache them if present */
2272 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
2273 udev->manufacturer = usb_cache_string(udev,
2274 udev->descriptor.iManufacturer);
2275 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
2277 err = usb_enumerate_device_otg(udev);
2281 usb_detect_interface_quirks(udev);
2286 static void set_usb_port_removable(struct usb_device *udev)
2288 struct usb_device *hdev = udev->parent;
2289 struct usb_hub *hub;
2290 u8 port = udev->portnum;
2291 u16 wHubCharacteristics;
2292 bool removable = true;
2297 hub = usb_hub_to_struct_hub(udev->parent);
2299 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2301 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
2304 if (hub_is_superspeed(hdev)) {
2305 if (le16_to_cpu(hub->descriptor->u.ss.DeviceRemovable)
2309 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
2314 udev->removable = USB_DEVICE_REMOVABLE;
2316 udev->removable = USB_DEVICE_FIXED;
2319 * Platform firmware may have populated an alternative value for
2320 * removable. If the parent port has a known connect_type use
2323 switch (hub->ports[udev->portnum - 1]->connect_type) {
2324 case USB_PORT_CONNECT_TYPE_HOT_PLUG:
2325 udev->removable = USB_DEVICE_REMOVABLE;
2327 case USB_PORT_CONNECT_TYPE_HARD_WIRED:
2328 udev->removable = USB_DEVICE_FIXED;
2330 default: /* use what was set above */
2336 * usb_new_device - perform initial device setup (usbcore-internal)
2337 * @udev: newly addressed device (in ADDRESS state)
2339 * This is called with devices which have been detected but not fully
2340 * enumerated. The device descriptor is available, but not descriptors
2341 * for any device configuration. The caller must have locked either
2342 * the parent hub (if udev is a normal device) or else the
2343 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
2344 * udev has already been installed, but udev is not yet visible through
2345 * sysfs or other filesystem code.
2347 * This call is synchronous, and may not be used in an interrupt context.
2349 * Only the hub driver or root-hub registrar should ever call this.
2351 * Return: Whether the device is configured properly or not. Zero if the
2352 * interface was registered with the driver core; else a negative errno
2356 int usb_new_device(struct usb_device *udev)
2361 /* Initialize non-root-hub device wakeup to disabled;
2362 * device (un)configuration controls wakeup capable
2363 * sysfs power/wakeup controls wakeup enabled/disabled
2365 device_init_wakeup(&udev->dev, 0);
2368 /* Tell the runtime-PM framework the device is active */
2369 pm_runtime_set_active(&udev->dev);
2370 pm_runtime_get_noresume(&udev->dev);
2371 pm_runtime_use_autosuspend(&udev->dev);
2372 pm_runtime_enable(&udev->dev);
2374 /* By default, forbid autosuspend for all devices. It will be
2375 * allowed for hubs during binding.
2377 usb_disable_autosuspend(udev);
2379 err = usb_enumerate_device(udev); /* Read descriptors */
2382 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
2383 udev->devnum, udev->bus->busnum,
2384 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2385 /* export the usbdev device-node for libusb */
2386 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
2387 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2389 /* Tell the world! */
2390 announce_device(udev);
2393 add_device_randomness(udev->serial, strlen(udev->serial));
2395 add_device_randomness(udev->product, strlen(udev->product));
2396 if (udev->manufacturer)
2397 add_device_randomness(udev->manufacturer,
2398 strlen(udev->manufacturer));
2400 device_enable_async_suspend(&udev->dev);
2402 /* check whether the hub or firmware marks this port as non-removable */
2404 set_usb_port_removable(udev);
2406 /* Register the device. The device driver is responsible
2407 * for configuring the device and invoking the add-device
2408 * notifier chain (used by usbfs and possibly others).
2410 err = device_add(&udev->dev);
2412 dev_err(&udev->dev, "can't device_add, error %d\n", err);
2416 /* Create link files between child device and usb port device. */
2418 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2419 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
2421 err = sysfs_create_link(&udev->dev.kobj,
2422 &port_dev->dev.kobj, "port");
2426 err = sysfs_create_link(&port_dev->dev.kobj,
2427 &udev->dev.kobj, "device");
2429 sysfs_remove_link(&udev->dev.kobj, "port");
2433 pm_runtime_get_sync(&port_dev->dev);
2436 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
2437 usb_mark_last_busy(udev);
2438 pm_runtime_put_sync_autosuspend(&udev->dev);
2442 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2443 pm_runtime_disable(&udev->dev);
2444 pm_runtime_set_suspended(&udev->dev);
2450 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2451 * @usb_dev: USB device
2453 * Move the USB device to a very basic state where interfaces are disabled
2454 * and the device is in fact unconfigured and unusable.
2456 * We share a lock (that we have) with device_del(), so we need to
2461 int usb_deauthorize_device(struct usb_device *usb_dev)
2463 usb_lock_device(usb_dev);
2464 if (usb_dev->authorized == 0)
2465 goto out_unauthorized;
2467 usb_dev->authorized = 0;
2468 usb_set_configuration(usb_dev, -1);
2471 usb_unlock_device(usb_dev);
2476 int usb_authorize_device(struct usb_device *usb_dev)
2480 usb_lock_device(usb_dev);
2481 if (usb_dev->authorized == 1)
2482 goto out_authorized;
2484 result = usb_autoresume_device(usb_dev);
2486 dev_err(&usb_dev->dev,
2487 "can't autoresume for authorization: %d\n", result);
2488 goto error_autoresume;
2490 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2492 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2493 "authorization: %d\n", result);
2494 goto error_device_descriptor;
2497 usb_dev->authorized = 1;
2498 /* Choose and set the configuration. This registers the interfaces
2499 * with the driver core and lets interface drivers bind to them.
2501 c = usb_choose_configuration(usb_dev);
2503 result = usb_set_configuration(usb_dev, c);
2505 dev_err(&usb_dev->dev,
2506 "can't set config #%d, error %d\n", c, result);
2507 /* This need not be fatal. The user can try to
2508 * set other configurations. */
2511 dev_info(&usb_dev->dev, "authorized to connect\n");
2513 error_device_descriptor:
2514 usb_autosuspend_device(usb_dev);
2517 usb_unlock_device(usb_dev); /* complements locktree */
2522 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2523 static unsigned hub_is_wusb(struct usb_hub *hub)
2525 struct usb_hcd *hcd;
2526 if (hub->hdev->parent != NULL) /* not a root hub? */
2528 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
2529 return hcd->wireless;
2533 #define PORT_RESET_TRIES 5
2534 #define SET_ADDRESS_TRIES 2
2535 #define GET_DESCRIPTOR_TRIES 2
2536 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2537 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2539 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2540 #define HUB_SHORT_RESET_TIME 10
2541 #define HUB_BH_RESET_TIME 50
2542 #define HUB_LONG_RESET_TIME 200
2543 #define HUB_RESET_TIMEOUT 800
2546 * "New scheme" enumeration causes an extra state transition to be
2547 * exposed to an xhci host and causes USB3 devices to receive control
2548 * commands in the default state. This has been seen to cause
2549 * enumeration failures, so disable this enumeration scheme for USB3
2552 static bool use_new_scheme(struct usb_device *udev, int retry)
2554 if (udev->speed == USB_SPEED_SUPER)
2557 return USE_NEW_SCHEME(retry);
2560 static int hub_port_reset(struct usb_hub *hub, int port1,
2561 struct usb_device *udev, unsigned int delay, bool warm);
2563 /* Is a USB 3.0 port in the Inactive or Compliance Mode state?
2564 * Port worm reset is required to recover
2566 static bool hub_port_warm_reset_required(struct usb_hub *hub, u16 portstatus)
2568 return hub_is_superspeed(hub->hdev) &&
2569 (((portstatus & USB_PORT_STAT_LINK_STATE) ==
2570 USB_SS_PORT_LS_SS_INACTIVE) ||
2571 ((portstatus & USB_PORT_STAT_LINK_STATE) ==
2572 USB_SS_PORT_LS_COMP_MOD)) ;
2575 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2576 struct usb_device *udev, unsigned int delay, bool warm)
2578 int delay_time, ret;
2582 for (delay_time = 0;
2583 delay_time < HUB_RESET_TIMEOUT;
2584 delay_time += delay) {
2585 /* wait to give the device a chance to reset */
2588 /* read and decode port status */
2589 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2593 /* The port state is unknown until the reset completes. */
2594 if (!(portstatus & USB_PORT_STAT_RESET))
2597 /* switch to the long delay after two short delay failures */
2598 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2599 delay = HUB_LONG_RESET_TIME;
2601 dev_dbg(&hub->ports[port1 - 1]->dev,
2602 "not %sreset yet, waiting %dms\n",
2603 warm ? "warm " : "", delay);
2606 if ((portstatus & USB_PORT_STAT_RESET))
2609 if (hub_port_warm_reset_required(hub, portstatus))
2612 /* Device went away? */
2613 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2616 /* bomb out completely if the connection bounced. A USB 3.0
2617 * connection may bounce if multiple warm resets were issued,
2618 * but the device may have successfully re-connected. Ignore it.
2620 if (!hub_is_superspeed(hub->hdev) &&
2621 (portchange & USB_PORT_STAT_C_CONNECTION))
2624 if (!(portstatus & USB_PORT_STAT_ENABLE))
2630 if (hub_is_wusb(hub))
2631 udev->speed = USB_SPEED_WIRELESS;
2632 else if (hub_is_superspeed(hub->hdev))
2633 udev->speed = USB_SPEED_SUPER;
2634 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2635 udev->speed = USB_SPEED_HIGH;
2636 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2637 udev->speed = USB_SPEED_LOW;
2639 udev->speed = USB_SPEED_FULL;
2643 static void hub_port_finish_reset(struct usb_hub *hub, int port1,
2644 struct usb_device *udev, int *status)
2648 /* TRSTRCY = 10 ms; plus some extra */
2651 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2653 update_devnum(udev, 0);
2654 /* The xHC may think the device is already reset,
2655 * so ignore the status.
2657 if (hcd->driver->reset_device)
2658 hcd->driver->reset_device(hcd, udev);
2663 usb_clear_port_feature(hub->hdev,
2664 port1, USB_PORT_FEAT_C_RESET);
2665 if (hub_is_superspeed(hub->hdev)) {
2666 usb_clear_port_feature(hub->hdev, port1,
2667 USB_PORT_FEAT_C_BH_PORT_RESET);
2668 usb_clear_port_feature(hub->hdev, port1,
2669 USB_PORT_FEAT_C_PORT_LINK_STATE);
2670 usb_clear_port_feature(hub->hdev, port1,
2671 USB_PORT_FEAT_C_CONNECTION);
2674 usb_set_device_state(udev, *status
2675 ? USB_STATE_NOTATTACHED
2676 : USB_STATE_DEFAULT);
2681 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2682 static int hub_port_reset(struct usb_hub *hub, int port1,
2683 struct usb_device *udev, unsigned int delay, bool warm)
2686 u16 portchange, portstatus;
2687 struct usb_port *port_dev = hub->ports[port1 - 1];
2689 if (!hub_is_superspeed(hub->hdev)) {
2691 dev_err(hub->intfdev, "only USB3 hub support "
2695 /* Block EHCI CF initialization during the port reset.
2696 * Some companion controllers don't like it when they mix.
2698 down_read(&ehci_cf_port_reset_rwsem);
2701 * If the caller hasn't explicitly requested a warm reset,
2702 * double check and see if one is needed.
2704 status = hub_port_status(hub, port1,
2705 &portstatus, &portchange);
2709 if (hub_port_warm_reset_required(hub, portstatus))
2713 /* Reset the port */
2714 for (i = 0; i < PORT_RESET_TRIES; i++) {
2715 status = set_port_feature(hub->hdev, port1, (warm ?
2716 USB_PORT_FEAT_BH_PORT_RESET :
2717 USB_PORT_FEAT_RESET));
2718 if (status == -ENODEV) {
2719 ; /* The hub is gone */
2720 } else if (status) {
2721 dev_err(&port_dev->dev,
2722 "cannot %sreset (err = %d)\n",
2723 warm ? "warm " : "", status);
2725 status = hub_port_wait_reset(hub, port1, udev, delay,
2727 if (status && status != -ENOTCONN && status != -ENODEV)
2728 dev_dbg(hub->intfdev,
2729 "port_wait_reset: err = %d\n",
2733 /* Check for disconnect or reset */
2734 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2735 hub_port_finish_reset(hub, port1, udev, &status);
2737 if (!hub_is_superspeed(hub->hdev))
2741 * If a USB 3.0 device migrates from reset to an error
2742 * state, re-issue the warm reset.
2744 if (hub_port_status(hub, port1,
2745 &portstatus, &portchange) < 0)
2748 if (!hub_port_warm_reset_required(hub, portstatus))
2752 * If the port is in SS.Inactive or Compliance Mode, the
2753 * hot or warm reset failed. Try another warm reset.
2756 dev_dbg(&port_dev->dev,
2757 "hot reset failed, warm reset\n");
2762 dev_dbg(&port_dev->dev,
2763 "not enabled, trying %sreset again...\n",
2764 warm ? "warm " : "");
2765 delay = HUB_LONG_RESET_TIME;
2768 dev_err(&port_dev->dev, "Cannot enable. Maybe the USB cable is bad?\n");
2771 if (!hub_is_superspeed(hub->hdev))
2772 up_read(&ehci_cf_port_reset_rwsem);
2777 /* Check if a port is power on */
2778 static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2782 if (hub_is_superspeed(hub->hdev)) {
2783 if (portstatus & USB_SS_PORT_STAT_POWER)
2786 if (portstatus & USB_PORT_STAT_POWER)
2795 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2796 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
2800 if (hub_is_superspeed(hub->hdev)) {
2801 if ((portstatus & USB_PORT_STAT_LINK_STATE)
2802 == USB_SS_PORT_LS_U3)
2805 if (portstatus & USB_PORT_STAT_SUSPEND)
2812 /* Determine whether the device on a port is ready for a normal resume,
2813 * is ready for a reset-resume, or should be disconnected.
2815 static int check_port_resume_type(struct usb_device *udev,
2816 struct usb_hub *hub, int port1,
2817 int status, unsigned portchange, unsigned portstatus)
2819 struct usb_port *port_dev = hub->ports[port1 - 1];
2821 /* Is the device still present? */
2822 if (status || port_is_suspended(hub, portstatus) ||
2823 !port_is_power_on(hub, portstatus) ||
2824 !(portstatus & USB_PORT_STAT_CONNECTION)) {
2829 /* Can't do a normal resume if the port isn't enabled,
2830 * so try a reset-resume instead.
2832 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2833 if (udev->persist_enabled)
2834 udev->reset_resume = 1;
2840 dev_dbg(&port_dev->dev, "status %04x.%04x after resume, %d\n",
2841 portchange, portstatus, status);
2842 } else if (udev->reset_resume) {
2844 /* Late port handoff can set status-change bits */
2845 if (portchange & USB_PORT_STAT_C_CONNECTION)
2846 usb_clear_port_feature(hub->hdev, port1,
2847 USB_PORT_FEAT_C_CONNECTION);
2848 if (portchange & USB_PORT_STAT_C_ENABLE)
2849 usb_clear_port_feature(hub->hdev, port1,
2850 USB_PORT_FEAT_C_ENABLE);
2856 int usb_disable_ltm(struct usb_device *udev)
2858 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2860 /* Check if the roothub and device supports LTM. */
2861 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
2862 !usb_device_supports_ltm(udev))
2865 /* Clear Feature LTM Enable can only be sent if the device is
2868 if (!udev->actconfig)
2871 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2872 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2873 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
2874 USB_CTRL_SET_TIMEOUT);
2876 EXPORT_SYMBOL_GPL(usb_disable_ltm);
2878 void usb_enable_ltm(struct usb_device *udev)
2880 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2882 /* Check if the roothub and device supports LTM. */
2883 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
2884 !usb_device_supports_ltm(udev))
2887 /* Set Feature LTM Enable can only be sent if the device is
2890 if (!udev->actconfig)
2893 usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2894 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2895 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
2896 USB_CTRL_SET_TIMEOUT);
2898 EXPORT_SYMBOL_GPL(usb_enable_ltm);
2901 * usb_enable_remote_wakeup - enable remote wakeup for a device
2902 * @udev: target device
2904 * For USB-2 devices: Set the device's remote wakeup feature.
2906 * For USB-3 devices: Assume there's only one function on the device and
2907 * enable remote wake for the first interface. FIXME if the interface
2908 * association descriptor shows there's more than one function.
2910 static int usb_enable_remote_wakeup(struct usb_device *udev)
2912 if (udev->speed < USB_SPEED_SUPER)
2913 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2914 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2915 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
2916 USB_CTRL_SET_TIMEOUT);
2918 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2919 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
2920 USB_INTRF_FUNC_SUSPEND,
2921 USB_INTRF_FUNC_SUSPEND_RW |
2922 USB_INTRF_FUNC_SUSPEND_LP,
2923 NULL, 0, USB_CTRL_SET_TIMEOUT);
2927 * usb_disable_remote_wakeup - disable remote wakeup for a device
2928 * @udev: target device
2930 * For USB-2 devices: Clear the device's remote wakeup feature.
2932 * For USB-3 devices: Assume there's only one function on the device and
2933 * disable remote wake for the first interface. FIXME if the interface
2934 * association descriptor shows there's more than one function.
2936 static int usb_disable_remote_wakeup(struct usb_device *udev)
2938 if (udev->speed < USB_SPEED_SUPER)
2939 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2940 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2941 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
2942 USB_CTRL_SET_TIMEOUT);
2944 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2945 USB_REQ_CLEAR_FEATURE, USB_RECIP_INTERFACE,
2946 USB_INTRF_FUNC_SUSPEND, 0, NULL, 0,
2947 USB_CTRL_SET_TIMEOUT);
2950 /* Count of wakeup-enabled devices at or below udev */
2951 static unsigned wakeup_enabled_descendants(struct usb_device *udev)
2953 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2955 return udev->do_remote_wakeup +
2956 (hub ? hub->wakeup_enabled_descendants : 0);
2960 * usb_port_suspend - suspend a usb device's upstream port
2961 * @udev: device that's no longer in active use, not a root hub
2962 * Context: must be able to sleep; device not locked; pm locks held
2964 * Suspends a USB device that isn't in active use, conserving power.
2965 * Devices may wake out of a suspend, if anything important happens,
2966 * using the remote wakeup mechanism. They may also be taken out of
2967 * suspend by the host, using usb_port_resume(). It's also routine
2968 * to disconnect devices while they are suspended.
2970 * This only affects the USB hardware for a device; its interfaces
2971 * (and, for hubs, child devices) must already have been suspended.
2973 * Selective port suspend reduces power; most suspended devices draw
2974 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2975 * All devices below the suspended port are also suspended.
2977 * Devices leave suspend state when the host wakes them up. Some devices
2978 * also support "remote wakeup", where the device can activate the USB
2979 * tree above them to deliver data, such as a keypress or packet. In
2980 * some cases, this wakes the USB host.
2982 * Suspending OTG devices may trigger HNP, if that's been enabled
2983 * between a pair of dual-role devices. That will change roles, such
2984 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2986 * Devices on USB hub ports have only one "suspend" state, corresponding
2987 * to ACPI D2, "may cause the device to lose some context".
2988 * State transitions include:
2990 * - suspend, resume ... when the VBUS power link stays live
2991 * - suspend, disconnect ... VBUS lost
2993 * Once VBUS drop breaks the circuit, the port it's using has to go through
2994 * normal re-enumeration procedures, starting with enabling VBUS power.
2995 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2996 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2997 * timer, no SRP, no requests through sysfs.
2999 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
3000 * suspended until their bus goes into global suspend (i.e., the root
3001 * hub is suspended). Nevertheless, we change @udev->state to
3002 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
3003 * upstream port setting is stored in @udev->port_is_suspended.
3005 * Returns 0 on success, else negative errno.
3007 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
3009 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3010 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3011 int port1 = udev->portnum;
3013 bool really_suspend = true;
3015 /* enable remote wakeup when appropriate; this lets the device
3016 * wake up the upstream hub (including maybe the root hub).
3018 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
3019 * we don't explicitly enable it here.
3021 if (udev->do_remote_wakeup) {
3022 status = usb_enable_remote_wakeup(udev);
3024 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
3026 /* bail if autosuspend is requested */
3027 if (PMSG_IS_AUTO(msg))
3032 /* disable USB2 hardware LPM */
3033 if (udev->usb2_hw_lpm_enabled == 1)
3034 usb_set_usb2_hardware_lpm(udev, 0);
3036 if (usb_disable_ltm(udev)) {
3037 dev_err(&udev->dev, "Failed to disable LTM before suspend\n.");
3039 if (PMSG_IS_AUTO(msg))
3042 if (usb_unlocked_disable_lpm(udev)) {
3043 dev_err(&udev->dev, "Failed to disable LPM before suspend\n.");
3045 if (PMSG_IS_AUTO(msg))
3050 if (hub_is_superspeed(hub->hdev))
3051 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U3);
3054 * For system suspend, we do not need to enable the suspend feature
3055 * on individual USB-2 ports. The devices will automatically go
3056 * into suspend a few ms after the root hub stops sending packets.
3057 * The USB 2.0 spec calls this "global suspend".
3059 * However, many USB hubs have a bug: They don't relay wakeup requests
3060 * from a downstream port if the port's suspend feature isn't on.
3061 * Therefore we will turn on the suspend feature if udev or any of its
3062 * descendants is enabled for remote wakeup.
3064 else if (PMSG_IS_AUTO(msg) || wakeup_enabled_descendants(udev) > 0)
3065 status = set_port_feature(hub->hdev, port1,
3066 USB_PORT_FEAT_SUSPEND);
3068 really_suspend = false;
3072 dev_dbg(&port_dev->dev, "can't suspend, status %d\n", status);
3074 /* Try to enable USB3 LPM and LTM again */
3075 usb_unlocked_enable_lpm(udev);
3077 usb_enable_ltm(udev);
3079 /* Try to enable USB2 hardware LPM again */
3080 if (udev->usb2_hw_lpm_capable == 1)
3081 usb_set_usb2_hardware_lpm(udev, 1);
3083 if (udev->do_remote_wakeup)
3084 (void) usb_disable_remote_wakeup(udev);
3087 /* System sleep transitions should never fail */
3088 if (!PMSG_IS_AUTO(msg))
3091 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
3092 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
3093 udev->do_remote_wakeup);
3094 if (really_suspend) {
3095 udev->port_is_suspended = 1;
3097 /* device has up to 10 msec to fully suspend */
3100 usb_set_device_state(udev, USB_STATE_SUSPENDED);
3103 if (status == 0 && !udev->do_remote_wakeup && udev->persist_enabled) {
3104 pm_runtime_put_sync(&port_dev->dev);
3105 port_dev->did_runtime_put = true;
3108 usb_mark_last_busy(hub->hdev);
3113 * If the USB "suspend" state is in use (rather than "global suspend"),
3114 * many devices will be individually taken out of suspend state using
3115 * special "resume" signaling. This routine kicks in shortly after
3116 * hardware resume signaling is finished, either because of selective
3117 * resume (by host) or remote wakeup (by device) ... now see what changed
3118 * in the tree that's rooted at this device.
3120 * If @udev->reset_resume is set then the device is reset before the
3121 * status check is done.
3123 static int finish_port_resume(struct usb_device *udev)
3128 /* caller owns the udev device lock */
3129 dev_dbg(&udev->dev, "%s\n",
3130 udev->reset_resume ? "finish reset-resume" : "finish resume");
3132 /* usb ch9 identifies four variants of SUSPENDED, based on what
3133 * state the device resumes to. Linux currently won't see the
3134 * first two on the host side; they'd be inside hub_port_init()
3135 * during many timeouts, but khubd can't suspend until later.
3137 usb_set_device_state(udev, udev->actconfig
3138 ? USB_STATE_CONFIGURED
3139 : USB_STATE_ADDRESS);
3141 /* 10.5.4.5 says not to reset a suspended port if the attached
3142 * device is enabled for remote wakeup. Hence the reset
3143 * operation is carried out here, after the port has been
3146 if (udev->reset_resume) {
3148 * If the device morphs or switches modes when it is reset,
3149 * we don't want to perform a reset-resume. We'll fail the
3150 * resume, which will cause a logical disconnect, and then
3151 * the device will be rediscovered.
3154 if (udev->quirks & USB_QUIRK_RESET)
3157 status = usb_reset_and_verify_device(udev);
3160 /* 10.5.4.5 says be sure devices in the tree are still there.
3161 * For now let's assume the device didn't go crazy on resume,
3162 * and device drivers will know about any resume quirks.
3166 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
3168 /* If a normal resume failed, try doing a reset-resume */
3169 if (status && !udev->reset_resume && udev->persist_enabled) {
3170 dev_dbg(&udev->dev, "retry with reset-resume\n");
3171 udev->reset_resume = 1;
3172 goto retry_reset_resume;
3177 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
3180 * There are a few quirky devices which violate the standard
3181 * by claiming to have remote wakeup enabled after a reset,
3182 * which crash if the feature is cleared, hence check for
3183 * udev->reset_resume
3185 } else if (udev->actconfig && !udev->reset_resume) {
3186 if (udev->speed < USB_SPEED_SUPER) {
3187 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
3188 status = usb_disable_remote_wakeup(udev);
3190 status = usb_get_status(udev, USB_RECIP_INTERFACE, 0,
3192 if (!status && devstatus & (USB_INTRF_STAT_FUNC_RW_CAP
3193 | USB_INTRF_STAT_FUNC_RW))
3194 status = usb_disable_remote_wakeup(udev);
3199 "disable remote wakeup, status %d\n",
3207 * usb_port_resume - re-activate a suspended usb device's upstream port
3208 * @udev: device to re-activate, not a root hub
3209 * Context: must be able to sleep; device not locked; pm locks held
3211 * This will re-activate the suspended device, increasing power usage
3212 * while letting drivers communicate again with its endpoints.
3213 * USB resume explicitly guarantees that the power session between
3214 * the host and the device is the same as it was when the device
3217 * If @udev->reset_resume is set then this routine won't check that the
3218 * port is still enabled. Furthermore, finish_port_resume() above will
3219 * reset @udev. The end result is that a broken power session can be
3220 * recovered and @udev will appear to persist across a loss of VBUS power.
3222 * For example, if a host controller doesn't maintain VBUS suspend current
3223 * during a system sleep or is reset when the system wakes up, all the USB
3224 * power sessions below it will be broken. This is especially troublesome
3225 * for mass-storage devices containing mounted filesystems, since the
3226 * device will appear to have disconnected and all the memory mappings
3227 * to it will be lost. Using the USB_PERSIST facility, the device can be
3228 * made to appear as if it had not disconnected.
3230 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3231 * every effort to insure that the same device is present after the
3232 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3233 * quite possible for a device to remain unaltered but its media to be
3234 * changed. If the user replaces a flash memory card while the system is
3235 * asleep, he will have only himself to blame when the filesystem on the
3236 * new card is corrupted and the system crashes.
3238 * Returns 0 on success, else negative errno.
3240 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
3242 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3243 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3244 int port1 = udev->portnum;
3246 u16 portchange, portstatus;
3248 if (port_dev->did_runtime_put) {
3249 status = pm_runtime_get_sync(&port_dev->dev);
3250 port_dev->did_runtime_put = false;
3252 dev_dbg(&udev->dev, "can't resume usb port, status %d\n",
3258 /* Skip the initial Clear-Suspend step for a remote wakeup */
3259 status = hub_port_status(hub, port1, &portstatus, &portchange);
3260 if (status == 0 && !port_is_suspended(hub, portstatus))
3261 goto SuspendCleared;
3263 set_bit(port1, hub->busy_bits);
3265 /* see 7.1.7.7; affects power usage, but not budgeting */
3266 if (hub_is_superspeed(hub->hdev))
3267 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U0);
3269 status = usb_clear_port_feature(hub->hdev,
3270 port1, USB_PORT_FEAT_SUSPEND);
3272 dev_dbg(&port_dev->dev, "can't resume, status %d\n", status);
3274 /* drive resume for at least 20 msec */
3275 dev_dbg(&udev->dev, "usb %sresume\n",
3276 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
3279 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3280 * stop resume signaling. Then finish the resume
3283 status = hub_port_status(hub, port1, &portstatus, &portchange);
3285 /* TRSMRCY = 10 msec */
3291 udev->port_is_suspended = 0;
3292 if (hub_is_superspeed(hub->hdev)) {
3293 if (portchange & USB_PORT_STAT_C_LINK_STATE)
3294 usb_clear_port_feature(hub->hdev, port1,
3295 USB_PORT_FEAT_C_PORT_LINK_STATE);
3297 if (portchange & USB_PORT_STAT_C_SUSPEND)
3298 usb_clear_port_feature(hub->hdev, port1,
3299 USB_PORT_FEAT_C_SUSPEND);
3303 clear_bit(port1, hub->busy_bits);
3305 status = check_port_resume_type(udev,
3306 hub, port1, status, portchange, portstatus);
3308 status = finish_port_resume(udev);
3310 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
3311 hub_port_logical_disconnect(hub, port1);
3313 /* Try to enable USB2 hardware LPM */
3314 if (udev->usb2_hw_lpm_capable == 1)
3315 usb_set_usb2_hardware_lpm(udev, 1);
3317 /* Try to enable USB3 LTM and LPM */
3318 usb_enable_ltm(udev);
3319 usb_unlocked_enable_lpm(udev);
3325 #ifdef CONFIG_PM_RUNTIME
3327 /* caller has locked udev */
3328 int usb_remote_wakeup(struct usb_device *udev)
3332 if (udev->state == USB_STATE_SUSPENDED) {
3333 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
3334 status = usb_autoresume_device(udev);
3336 /* Let the drivers do their thing, then... */
3337 usb_autosuspend_device(udev);
3345 static int check_ports_changed(struct usb_hub *hub)
3349 for (port1 = 1; port1 <= hub->hdev->maxchild; ++port1) {
3350 u16 portstatus, portchange;
3353 status = hub_port_status(hub, port1, &portstatus, &portchange);
3354 if (!status && portchange)
3360 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
3362 struct usb_hub *hub = usb_get_intfdata (intf);
3363 struct usb_device *hdev = hub->hdev;
3368 * Warn if children aren't already suspended.
3369 * Also, add up the number of wakeup-enabled descendants.
3371 hub->wakeup_enabled_descendants = 0;
3372 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3373 struct usb_port *port_dev = hub->ports[port1 - 1];
3374 struct usb_device *udev = port_dev->child;
3376 if (udev && udev->can_submit) {
3377 dev_warn(&port_dev->dev, "not suspended yet\n");
3378 if (PMSG_IS_AUTO(msg))
3382 hub->wakeup_enabled_descendants +=
3383 wakeup_enabled_descendants(udev);
3386 if (hdev->do_remote_wakeup && hub->quirk_check_port_auto_suspend) {
3387 /* check if there are changes pending on hub ports */
3388 if (check_ports_changed(hub)) {
3389 if (PMSG_IS_AUTO(msg))
3391 pm_wakeup_event(&hdev->dev, 2000);
3395 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
3396 /* Enable hub to send remote wakeup for all ports. */
3397 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3398 status = set_port_feature(hdev,
3400 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
3401 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
3402 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
3403 USB_PORT_FEAT_REMOTE_WAKE_MASK);
3407 dev_dbg(&intf->dev, "%s\n", __func__);
3409 /* stop khubd and related activity */
3410 hub_quiesce(hub, HUB_SUSPEND);
3414 static int hub_resume(struct usb_interface *intf)
3416 struct usb_hub *hub = usb_get_intfdata(intf);
3418 dev_dbg(&intf->dev, "%s\n", __func__);
3419 hub_activate(hub, HUB_RESUME);
3423 static int hub_reset_resume(struct usb_interface *intf)
3425 struct usb_hub *hub = usb_get_intfdata(intf);
3427 dev_dbg(&intf->dev, "%s\n", __func__);
3428 hub_activate(hub, HUB_RESET_RESUME);
3433 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3434 * @rhdev: struct usb_device for the root hub
3436 * The USB host controller driver calls this function when its root hub
3437 * is resumed and Vbus power has been interrupted or the controller
3438 * has been reset. The routine marks @rhdev as having lost power.
3439 * When the hub driver is resumed it will take notice and carry out
3440 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3441 * the others will be disconnected.
3443 void usb_root_hub_lost_power(struct usb_device *rhdev)
3445 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
3446 rhdev->reset_resume = 1;
3448 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
3450 static const char * const usb3_lpm_names[] = {
3458 * Send a Set SEL control transfer to the device, prior to enabling
3459 * device-initiated U1 or U2. This lets the device know the exit latencies from
3460 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3461 * packet from the host.
3463 * This function will fail if the SEL or PEL values for udev are greater than
3464 * the maximum allowed values for the link state to be enabled.
3466 static int usb_req_set_sel(struct usb_device *udev, enum usb3_link_state state)
3468 struct usb_set_sel_req *sel_values;
3469 unsigned long long u1_sel;
3470 unsigned long long u1_pel;
3471 unsigned long long u2_sel;
3472 unsigned long long u2_pel;
3475 if (udev->state != USB_STATE_CONFIGURED)
3478 /* Convert SEL and PEL stored in ns to us */
3479 u1_sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
3480 u1_pel = DIV_ROUND_UP(udev->u1_params.pel, 1000);
3481 u2_sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
3482 u2_pel = DIV_ROUND_UP(udev->u2_params.pel, 1000);
3485 * Make sure that the calculated SEL and PEL values for the link
3486 * state we're enabling aren't bigger than the max SEL/PEL
3487 * value that will fit in the SET SEL control transfer.
3488 * Otherwise the device would get an incorrect idea of the exit
3489 * latency for the link state, and could start a device-initiated
3490 * U1/U2 when the exit latencies are too high.
3492 if ((state == USB3_LPM_U1 &&
3493 (u1_sel > USB3_LPM_MAX_U1_SEL_PEL ||
3494 u1_pel > USB3_LPM_MAX_U1_SEL_PEL)) ||
3495 (state == USB3_LPM_U2 &&
3496 (u2_sel > USB3_LPM_MAX_U2_SEL_PEL ||
3497 u2_pel > USB3_LPM_MAX_U2_SEL_PEL))) {
3498 dev_dbg(&udev->dev, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3499 usb3_lpm_names[state], u1_sel, u1_pel);
3504 * If we're enabling device-initiated LPM for one link state,
3505 * but the other link state has a too high SEL or PEL value,
3506 * just set those values to the max in the Set SEL request.
3508 if (u1_sel > USB3_LPM_MAX_U1_SEL_PEL)
3509 u1_sel = USB3_LPM_MAX_U1_SEL_PEL;
3511 if (u1_pel > USB3_LPM_MAX_U1_SEL_PEL)
3512 u1_pel = USB3_LPM_MAX_U1_SEL_PEL;
3514 if (u2_sel > USB3_LPM_MAX_U2_SEL_PEL)
3515 u2_sel = USB3_LPM_MAX_U2_SEL_PEL;
3517 if (u2_pel > USB3_LPM_MAX_U2_SEL_PEL)
3518 u2_pel = USB3_LPM_MAX_U2_SEL_PEL;
3521 * usb_enable_lpm() can be called as part of a failed device reset,
3522 * which may be initiated by an error path of a mass storage driver.
3523 * Therefore, use GFP_NOIO.
3525 sel_values = kmalloc(sizeof *(sel_values), GFP_NOIO);
3529 sel_values->u1_sel = u1_sel;
3530 sel_values->u1_pel = u1_pel;
3531 sel_values->u2_sel = cpu_to_le16(u2_sel);
3532 sel_values->u2_pel = cpu_to_le16(u2_pel);
3534 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3538 sel_values, sizeof *(sel_values),
3539 USB_CTRL_SET_TIMEOUT);
3545 * Enable or disable device-initiated U1 or U2 transitions.
3547 static int usb_set_device_initiated_lpm(struct usb_device *udev,
3548 enum usb3_link_state state, bool enable)
3555 feature = USB_DEVICE_U1_ENABLE;
3558 feature = USB_DEVICE_U2_ENABLE;
3561 dev_warn(&udev->dev, "%s: Can't %s non-U1 or U2 state.\n",
3562 __func__, enable ? "enable" : "disable");
3566 if (udev->state != USB_STATE_CONFIGURED) {
3567 dev_dbg(&udev->dev, "%s: Can't %s %s state "
3568 "for unconfigured device.\n",
3569 __func__, enable ? "enable" : "disable",
3570 usb3_lpm_names[state]);
3576 * Now send the control transfer to enable device-initiated LPM
3577 * for either U1 or U2.
3579 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3580 USB_REQ_SET_FEATURE,
3584 USB_CTRL_SET_TIMEOUT);
3586 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3587 USB_REQ_CLEAR_FEATURE,
3591 USB_CTRL_SET_TIMEOUT);
3594 dev_warn(&udev->dev, "%s of device-initiated %s failed.\n",
3595 enable ? "Enable" : "Disable",
3596 usb3_lpm_names[state]);
3602 static int usb_set_lpm_timeout(struct usb_device *udev,
3603 enum usb3_link_state state, int timeout)
3610 feature = USB_PORT_FEAT_U1_TIMEOUT;
3613 feature = USB_PORT_FEAT_U2_TIMEOUT;
3616 dev_warn(&udev->dev, "%s: Can't set timeout for non-U1 or U2 state.\n",
3621 if (state == USB3_LPM_U1 && timeout > USB3_LPM_U1_MAX_TIMEOUT &&
3622 timeout != USB3_LPM_DEVICE_INITIATED) {
3623 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x, "
3624 "which is a reserved value.\n",
3625 usb3_lpm_names[state], timeout);
3629 ret = set_port_feature(udev->parent,
3630 USB_PORT_LPM_TIMEOUT(timeout) | udev->portnum,
3633 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x,"
3634 "error code %i\n", usb3_lpm_names[state],
3638 if (state == USB3_LPM_U1)
3639 udev->u1_params.timeout = timeout;
3641 udev->u2_params.timeout = timeout;
3646 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3649 * We will attempt to enable U1 or U2, but there are no guarantees that the
3650 * control transfers to set the hub timeout or enable device-initiated U1/U2
3651 * will be successful.
3653 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3654 * driver know about it. If that call fails, it should be harmless, and just
3655 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3657 static void usb_enable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3658 enum usb3_link_state state)
3661 __u8 u1_mel = udev->bos->ss_cap->bU1devExitLat;
3662 __le16 u2_mel = udev->bos->ss_cap->bU2DevExitLat;
3664 /* If the device says it doesn't have *any* exit latency to come out of
3665 * U1 or U2, it's probably lying. Assume it doesn't implement that link
3668 if ((state == USB3_LPM_U1 && u1_mel == 0) ||
3669 (state == USB3_LPM_U2 && u2_mel == 0))
3673 * First, let the device know about the exit latencies
3674 * associated with the link state we're about to enable.
3676 ret = usb_req_set_sel(udev, state);
3678 dev_warn(&udev->dev, "Set SEL for device-initiated %s failed.\n",
3679 usb3_lpm_names[state]);
3683 /* We allow the host controller to set the U1/U2 timeout internally
3684 * first, so that it can change its schedule to account for the
3685 * additional latency to send data to a device in a lower power
3688 timeout = hcd->driver->enable_usb3_lpm_timeout(hcd, udev, state);
3690 /* xHCI host controller doesn't want to enable this LPM state. */
3695 dev_warn(&udev->dev, "Could not enable %s link state, "
3696 "xHCI error %i.\n", usb3_lpm_names[state],
3701 if (usb_set_lpm_timeout(udev, state, timeout))
3702 /* If we can't set the parent hub U1/U2 timeout,
3703 * device-initiated LPM won't be allowed either, so let the xHCI
3704 * host know that this link state won't be enabled.
3706 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
3708 /* Only a configured device will accept the Set Feature U1/U2_ENABLE */
3709 else if (udev->actconfig)
3710 usb_set_device_initiated_lpm(udev, state, true);
3715 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
3718 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
3719 * If zero is returned, the parent will not allow the link to go into U1/U2.
3721 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
3722 * it won't have an effect on the bus link state because the parent hub will
3723 * still disallow device-initiated U1/U2 entry.
3725 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
3726 * possible. The result will be slightly more bus bandwidth will be taken up
3727 * (to account for U1/U2 exit latency), but it should be harmless.
3729 static int usb_disable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3730 enum usb3_link_state state)
3736 feature = USB_PORT_FEAT_U1_TIMEOUT;
3739 feature = USB_PORT_FEAT_U2_TIMEOUT;
3742 dev_warn(&udev->dev, "%s: Can't disable non-U1 or U2 state.\n",
3747 if (usb_set_lpm_timeout(udev, state, 0))
3750 usb_set_device_initiated_lpm(udev, state, false);
3752 if (hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state))
3753 dev_warn(&udev->dev, "Could not disable xHCI %s timeout, "
3754 "bus schedule bandwidth may be impacted.\n",
3755 usb3_lpm_names[state]);
3760 * Disable hub-initiated and device-initiated U1 and U2 entry.
3761 * Caller must own the bandwidth_mutex.
3763 * This will call usb_enable_lpm() on failure, which will decrement
3764 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
3766 int usb_disable_lpm(struct usb_device *udev)
3768 struct usb_hcd *hcd;
3770 if (!udev || !udev->parent ||
3771 udev->speed != USB_SPEED_SUPER ||
3775 hcd = bus_to_hcd(udev->bus);
3776 if (!hcd || !hcd->driver->disable_usb3_lpm_timeout)
3779 udev->lpm_disable_count++;
3780 if ((udev->u1_params.timeout == 0 && udev->u2_params.timeout == 0))
3783 /* If LPM is enabled, attempt to disable it. */
3784 if (usb_disable_link_state(hcd, udev, USB3_LPM_U1))
3786 if (usb_disable_link_state(hcd, udev, USB3_LPM_U2))
3792 usb_enable_lpm(udev);
3795 EXPORT_SYMBOL_GPL(usb_disable_lpm);
3797 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
3798 int usb_unlocked_disable_lpm(struct usb_device *udev)
3800 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3806 mutex_lock(hcd->bandwidth_mutex);
3807 ret = usb_disable_lpm(udev);
3808 mutex_unlock(hcd->bandwidth_mutex);
3812 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
3815 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
3816 * xHCI host policy may prevent U1 or U2 from being enabled.
3818 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
3819 * until the lpm_disable_count drops to zero. Caller must own the
3822 void usb_enable_lpm(struct usb_device *udev)
3824 struct usb_hcd *hcd;
3826 if (!udev || !udev->parent ||
3827 udev->speed != USB_SPEED_SUPER ||
3831 udev->lpm_disable_count--;
3832 hcd = bus_to_hcd(udev->bus);
3833 /* Double check that we can both enable and disable LPM.
3834 * Device must be configured to accept set feature U1/U2 timeout.
3836 if (!hcd || !hcd->driver->enable_usb3_lpm_timeout ||
3837 !hcd->driver->disable_usb3_lpm_timeout)
3840 if (udev->lpm_disable_count > 0)
3843 usb_enable_link_state(hcd, udev, USB3_LPM_U1);
3844 usb_enable_link_state(hcd, udev, USB3_LPM_U2);
3846 EXPORT_SYMBOL_GPL(usb_enable_lpm);
3848 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
3849 void usb_unlocked_enable_lpm(struct usb_device *udev)
3851 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3856 mutex_lock(hcd->bandwidth_mutex);
3857 usb_enable_lpm(udev);
3858 mutex_unlock(hcd->bandwidth_mutex);
3860 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
3863 #else /* CONFIG_PM */
3865 #define hub_suspend NULL
3866 #define hub_resume NULL
3867 #define hub_reset_resume NULL
3869 int usb_disable_lpm(struct usb_device *udev)
3873 EXPORT_SYMBOL_GPL(usb_disable_lpm);
3875 void usb_enable_lpm(struct usb_device *udev) { }
3876 EXPORT_SYMBOL_GPL(usb_enable_lpm);
3878 int usb_unlocked_disable_lpm(struct usb_device *udev)
3882 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
3884 void usb_unlocked_enable_lpm(struct usb_device *udev) { }
3885 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
3887 int usb_disable_ltm(struct usb_device *udev)
3891 EXPORT_SYMBOL_GPL(usb_disable_ltm);
3893 void usb_enable_ltm(struct usb_device *udev) { }
3894 EXPORT_SYMBOL_GPL(usb_enable_ltm);
3896 #endif /* CONFIG_PM */
3899 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
3901 * Between connect detection and reset signaling there must be a delay
3902 * of 100ms at least for debounce and power-settling. The corresponding
3903 * timer shall restart whenever the downstream port detects a disconnect.
3905 * Apparently there are some bluetooth and irda-dongles and a number of
3906 * low-speed devices for which this debounce period may last over a second.
3907 * Not covered by the spec - but easy to deal with.
3909 * This implementation uses a 1500ms total debounce timeout; if the
3910 * connection isn't stable by then it returns -ETIMEDOUT. It checks
3911 * every 25ms for transient disconnects. When the port status has been
3912 * unchanged for 100ms it returns the port status.
3914 int hub_port_debounce(struct usb_hub *hub, int port1, bool must_be_connected)
3917 u16 portchange, portstatus;
3918 unsigned connection = 0xffff;
3919 int total_time, stable_time = 0;
3920 struct usb_port *port_dev = hub->ports[port1 - 1];
3922 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
3923 ret = hub_port_status(hub, port1, &portstatus, &portchange);
3927 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
3928 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
3929 if (!must_be_connected ||
3930 (connection == USB_PORT_STAT_CONNECTION))
3931 stable_time += HUB_DEBOUNCE_STEP;
3932 if (stable_time >= HUB_DEBOUNCE_STABLE)
3936 connection = portstatus & USB_PORT_STAT_CONNECTION;
3939 if (portchange & USB_PORT_STAT_C_CONNECTION) {
3940 usb_clear_port_feature(hub->hdev, port1,
3941 USB_PORT_FEAT_C_CONNECTION);
3944 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
3946 msleep(HUB_DEBOUNCE_STEP);
3949 dev_dbg(&port_dev->dev, "debounce total %dms stable %dms status 0x%x\n",
3950 total_time, stable_time, portstatus);
3952 if (stable_time < HUB_DEBOUNCE_STABLE)
3957 void usb_ep0_reinit(struct usb_device *udev)
3959 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
3960 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
3961 usb_enable_endpoint(udev, &udev->ep0, true);
3963 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
3965 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
3966 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
3968 static int hub_set_address(struct usb_device *udev, int devnum)
3971 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3974 * The host controller will choose the device address,
3975 * instead of the core having chosen it earlier
3977 if (!hcd->driver->address_device && devnum <= 1)
3979 if (udev->state == USB_STATE_ADDRESS)
3981 if (udev->state != USB_STATE_DEFAULT)
3983 if (hcd->driver->address_device)
3984 retval = hcd->driver->address_device(hcd, udev);
3986 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
3987 USB_REQ_SET_ADDRESS, 0, devnum, 0,
3988 NULL, 0, USB_CTRL_SET_TIMEOUT);
3990 update_devnum(udev, devnum);
3991 /* Device now using proper address. */
3992 usb_set_device_state(udev, USB_STATE_ADDRESS);
3993 usb_ep0_reinit(udev);
3999 * There are reports of USB 3.0 devices that say they support USB 2.0 Link PM
4000 * when they're plugged into a USB 2.0 port, but they don't work when LPM is
4003 * Only enable USB 2.0 Link PM if the port is internal (hardwired), or the
4004 * device says it supports the new USB 2.0 Link PM errata by setting the BESL
4005 * support bit in the BOS descriptor.
4007 static void hub_set_initial_usb2_lpm_policy(struct usb_device *udev)
4009 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
4010 int connect_type = USB_PORT_CONNECT_TYPE_UNKNOWN;
4012 if (!udev->usb2_hw_lpm_capable)
4016 connect_type = hub->ports[udev->portnum - 1]->connect_type;
4018 if ((udev->bos->ext_cap->bmAttributes & cpu_to_le32(USB_BESL_SUPPORT)) ||
4019 connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
4020 udev->usb2_hw_lpm_allowed = 1;
4021 usb_set_usb2_hardware_lpm(udev, 1);
4025 static int hub_enable_device(struct usb_device *udev)
4027 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4029 if (!hcd->driver->enable_device)
4031 if (udev->state == USB_STATE_ADDRESS)
4033 if (udev->state != USB_STATE_DEFAULT)
4036 return hcd->driver->enable_device(hcd, udev);
4039 /* Reset device, (re)assign address, get device descriptor.
4040 * Device connection must be stable, no more debouncing needed.
4041 * Returns device in USB_STATE_ADDRESS, except on error.
4043 * If this is called for an already-existing device (as part of
4044 * usb_reset_and_verify_device), the caller must own the device lock. For a
4045 * newly detected device that is not accessible through any global
4046 * pointers, it's not necessary to lock the device.
4049 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
4052 struct usb_device *hdev = hub->hdev;
4053 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4055 unsigned delay = HUB_SHORT_RESET_TIME;
4056 enum usb_device_speed oldspeed = udev->speed;
4058 int devnum = udev->devnum;
4060 /* root hub ports have a slightly longer reset period
4061 * (from USB 2.0 spec, section 7.1.7.5)
4063 if (!hdev->parent) {
4064 delay = HUB_ROOT_RESET_TIME;
4065 if (port1 == hdev->bus->otg_port)
4066 hdev->bus->b_hnp_enable = 0;
4069 /* Some low speed devices have problems with the quick delay, so */
4070 /* be a bit pessimistic with those devices. RHbug #23670 */
4071 if (oldspeed == USB_SPEED_LOW)
4072 delay = HUB_LONG_RESET_TIME;
4074 mutex_lock(&hdev->bus->usb_address0_mutex);
4076 /* Reset the device; full speed may morph to high speed */
4077 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
4078 retval = hub_port_reset(hub, port1, udev, delay, false);
4079 if (retval < 0) /* error or disconnect */
4081 /* success, speed is known */
4085 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
4086 dev_dbg(&udev->dev, "device reset changed speed!\n");
4089 oldspeed = udev->speed;
4091 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4092 * it's fixed size except for full speed devices.
4093 * For Wireless USB devices, ep0 max packet is always 512 (tho
4094 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4096 switch (udev->speed) {
4097 case USB_SPEED_SUPER:
4098 case USB_SPEED_WIRELESS: /* fixed at 512 */
4099 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
4101 case USB_SPEED_HIGH: /* fixed at 64 */
4102 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4104 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
4105 /* to determine the ep0 maxpacket size, try to read
4106 * the device descriptor to get bMaxPacketSize0 and
4107 * then correct our initial guess.
4109 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4111 case USB_SPEED_LOW: /* fixed at 8 */
4112 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
4118 if (udev->speed == USB_SPEED_WIRELESS)
4119 speed = "variable speed Wireless";
4121 speed = usb_speed_string(udev->speed);
4123 if (udev->speed != USB_SPEED_SUPER)
4124 dev_info(&udev->dev,
4125 "%s %s USB device number %d using %s\n",
4126 (udev->config) ? "reset" : "new", speed,
4127 devnum, udev->bus->controller->driver->name);
4129 /* Set up TT records, if needed */
4131 udev->tt = hdev->tt;
4132 udev->ttport = hdev->ttport;
4133 } else if (udev->speed != USB_SPEED_HIGH
4134 && hdev->speed == USB_SPEED_HIGH) {
4136 dev_err(&udev->dev, "parent hub has no TT\n");
4140 udev->tt = &hub->tt;
4141 udev->ttport = port1;
4144 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4145 * Because device hardware and firmware is sometimes buggy in
4146 * this area, and this is how Linux has done it for ages.
4147 * Change it cautiously.
4149 * NOTE: If use_new_scheme() is true we will start by issuing
4150 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4151 * so it may help with some non-standards-compliant devices.
4152 * Otherwise we start with SET_ADDRESS and then try to read the
4153 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4156 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
4157 bool did_new_scheme = false;
4159 if (use_new_scheme(udev, retry_counter)) {
4160 struct usb_device_descriptor *buf;
4163 did_new_scheme = true;
4164 retval = hub_enable_device(udev);
4167 "hub failed to enable device, error %d\n",
4172 #define GET_DESCRIPTOR_BUFSIZE 64
4173 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
4179 /* Retry on all errors; some devices are flakey.
4180 * 255 is for WUSB devices, we actually need to use
4181 * 512 (WUSB1.0[4.8.1]).
4183 for (j = 0; j < 3; ++j) {
4184 buf->bMaxPacketSize0 = 0;
4185 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
4186 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
4187 USB_DT_DEVICE << 8, 0,
4188 buf, GET_DESCRIPTOR_BUFSIZE,
4189 initial_descriptor_timeout);
4190 switch (buf->bMaxPacketSize0) {
4191 case 8: case 16: case 32: case 64: case 255:
4192 if (buf->bDescriptorType ==
4206 udev->descriptor.bMaxPacketSize0 =
4207 buf->bMaxPacketSize0;
4210 retval = hub_port_reset(hub, port1, udev, delay, false);
4211 if (retval < 0) /* error or disconnect */
4213 if (oldspeed != udev->speed) {
4215 "device reset changed speed!\n");
4221 dev_err(&udev->dev, "device descriptor read/64, error %d\n",
4226 #undef GET_DESCRIPTOR_BUFSIZE
4230 * If device is WUSB, we already assigned an
4231 * unauthorized address in the Connect Ack sequence;
4232 * authorization will assign the final address.
4234 if (udev->wusb == 0) {
4235 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
4236 retval = hub_set_address(udev, devnum);
4242 if (retval != -ENODEV)
4243 dev_err(&udev->dev, "device not accepting address %d, error %d\n",
4247 if (udev->speed == USB_SPEED_SUPER) {
4248 devnum = udev->devnum;
4249 dev_info(&udev->dev,
4250 "%s SuperSpeed USB device number %d using %s\n",
4251 (udev->config) ? "reset" : "new",
4252 devnum, udev->bus->controller->driver->name);
4255 /* cope with hardware quirkiness:
4256 * - let SET_ADDRESS settle, some device hardware wants it
4257 * - read ep0 maxpacket even for high and low speed,
4260 /* use_new_scheme() checks the speed which may have
4261 * changed since the initial look so we cache the result
4268 retval = usb_get_device_descriptor(udev, 8);
4270 if (retval != -ENODEV)
4272 "device descriptor read/8, error %d\n",
4284 if (hcd->phy && !hdev->parent)
4285 usb_phy_notify_connect(hcd->phy, udev->speed);
4288 * Some superspeed devices have finished the link training process
4289 * and attached to a superspeed hub port, but the device descriptor
4290 * got from those devices show they aren't superspeed devices. Warm
4291 * reset the port attached by the devices can fix them.
4293 if ((udev->speed == USB_SPEED_SUPER) &&
4294 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
4295 dev_err(&udev->dev, "got a wrong device descriptor, "
4296 "warm reset device\n");
4297 hub_port_reset(hub, port1, udev,
4298 HUB_BH_RESET_TIME, true);
4303 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
4304 udev->speed == USB_SPEED_SUPER)
4307 i = udev->descriptor.bMaxPacketSize0;
4308 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
4309 if (udev->speed == USB_SPEED_LOW ||
4310 !(i == 8 || i == 16 || i == 32 || i == 64)) {
4311 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
4315 if (udev->speed == USB_SPEED_FULL)
4316 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
4318 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
4319 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
4320 usb_ep0_reinit(udev);
4323 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
4324 if (retval < (signed)sizeof(udev->descriptor)) {
4325 if (retval != -ENODEV)
4326 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
4333 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
4334 retval = usb_get_bos_descriptor(udev);
4336 udev->lpm_capable = usb_device_supports_lpm(udev);
4337 usb_set_lpm_parameters(udev);
4342 /* notify HCD that we have a device connected and addressed */
4343 if (hcd->driver->update_device)
4344 hcd->driver->update_device(hcd, udev);
4345 hub_set_initial_usb2_lpm_policy(udev);
4348 hub_port_disable(hub, port1, 0);
4349 update_devnum(udev, devnum); /* for disconnect processing */
4351 mutex_unlock(&hdev->bus->usb_address0_mutex);
4356 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
4358 struct usb_qualifier_descriptor *qual;
4361 qual = kmalloc (sizeof *qual, GFP_KERNEL);
4365 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
4366 qual, sizeof *qual);
4367 if (status == sizeof *qual) {
4368 dev_info(&udev->dev, "not running at top speed; "
4369 "connect to a high speed hub\n");
4370 /* hub LEDs are probably harder to miss than syslog */
4371 if (hub->has_indicators) {
4372 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
4373 queue_delayed_work(system_power_efficient_wq,
4381 hub_power_remaining (struct usb_hub *hub)
4383 struct usb_device *hdev = hub->hdev;
4387 if (!hub->limited_power)
4390 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
4391 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
4392 struct usb_port *port_dev = hub->ports[port1 - 1];
4393 struct usb_device *udev = port_dev->child;
4399 if (hub_is_superspeed(udev))
4405 * Unconfigured devices may not use more than one unit load,
4406 * or 8mA for OTG ports
4408 if (udev->actconfig)
4409 delta = usb_get_max_power(udev, udev->actconfig);
4410 else if (port1 != udev->bus->otg_port || hdev->parent)
4414 if (delta > hub->mA_per_port)
4415 dev_warn(&port_dev->dev, "%dmA is over %umA budget!\n",
4416 delta, hub->mA_per_port);
4419 if (remaining < 0) {
4420 dev_warn(hub->intfdev, "%dmA over power budget!\n",
4427 /* Handle physical or logical connection change events.
4428 * This routine is called when:
4429 * a port connection-change occurs;
4430 * a port enable-change occurs (often caused by EMI);
4431 * usb_reset_and_verify_device() encounters changed descriptors (as from
4432 * a firmware download)
4433 * caller already locked the hub
4435 static void hub_port_connect_change(struct usb_hub *hub, int port1,
4436 u16 portstatus, u16 portchange)
4438 struct usb_device *hdev = hub->hdev;
4439 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4440 struct usb_port *port_dev = hub->ports[port1 - 1];
4441 struct usb_device *udev;
4445 dev_dbg(&port_dev->dev, "status %04x, change %04x, %s\n",
4446 portstatus, portchange, portspeed(hub, portstatus));
4448 if (hub->has_indicators) {
4449 set_port_led(hub, port1, HUB_LED_AUTO);
4450 hub->indicator[port1-1] = INDICATOR_AUTO;
4453 #ifdef CONFIG_USB_OTG
4454 /* during HNP, don't repeat the debounce */
4455 if (hdev->bus->is_b_host)
4456 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
4457 USB_PORT_STAT_C_ENABLE);
4460 /* Try to resuscitate an existing device */
4461 udev = port_dev->child;
4462 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
4463 udev->state != USB_STATE_NOTATTACHED) {
4464 usb_lock_device(udev);
4465 if (portstatus & USB_PORT_STAT_ENABLE) {
4466 status = 0; /* Nothing to do */
4468 #ifdef CONFIG_PM_RUNTIME
4469 } else if (udev->state == USB_STATE_SUSPENDED &&
4470 udev->persist_enabled) {
4471 /* For a suspended device, treat this as a
4472 * remote wakeup event.
4474 status = usb_remote_wakeup(udev);
4478 status = -ENODEV; /* Don't resuscitate */
4480 usb_unlock_device(udev);
4483 clear_bit(port1, hub->change_bits);
4488 /* Disconnect any existing devices under this port */
4490 if (hcd->phy && !hdev->parent &&
4491 !(portstatus & USB_PORT_STAT_CONNECTION))
4492 usb_phy_notify_disconnect(hcd->phy, udev->speed);
4493 usb_disconnect(&port_dev->child);
4495 clear_bit(port1, hub->change_bits);
4497 /* We can forget about a "removed" device when there's a physical
4498 * disconnect or the connect status changes.
4500 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4501 (portchange & USB_PORT_STAT_C_CONNECTION))
4502 clear_bit(port1, hub->removed_bits);
4504 if (portchange & (USB_PORT_STAT_C_CONNECTION |
4505 USB_PORT_STAT_C_ENABLE)) {
4506 status = hub_port_debounce_be_stable(hub, port1);
4508 if (status != -ENODEV && printk_ratelimit())
4509 dev_err(&port_dev->dev,
4510 "connect-debounce failed\n");
4511 portstatus &= ~USB_PORT_STAT_CONNECTION;
4513 portstatus = status;
4517 /* Return now if debouncing failed or nothing is connected or
4518 * the device was "removed".
4520 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4521 test_bit(port1, hub->removed_bits)) {
4523 /* maybe switch power back on (e.g. root hub was reset) */
4524 if (hub_is_port_power_switchable(hub)
4525 && !port_is_power_on(hub, portstatus))
4526 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
4528 if (portstatus & USB_PORT_STAT_ENABLE)
4532 if (hub_is_superspeed(hub->hdev))
4538 for (i = 0; i < SET_CONFIG_TRIES; i++) {
4540 /* reallocate for each attempt, since references
4541 * to the previous one can escape in various ways
4543 udev = usb_alloc_dev(hdev, hdev->bus, port1);
4545 dev_err(&port_dev->dev,
4546 "couldn't allocate usb_device\n");
4550 usb_set_device_state(udev, USB_STATE_POWERED);
4551 udev->bus_mA = hub->mA_per_port;
4552 udev->level = hdev->level + 1;
4553 udev->wusb = hub_is_wusb(hub);
4555 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
4556 if (hub_is_superspeed(hub->hdev))
4557 udev->speed = USB_SPEED_SUPER;
4559 udev->speed = USB_SPEED_UNKNOWN;
4561 choose_devnum(udev);
4562 if (udev->devnum <= 0) {
4563 status = -ENOTCONN; /* Don't retry */
4567 /* reset (non-USB 3.0 devices) and get descriptor */
4568 status = hub_port_init(hub, udev, port1, i);
4572 usb_detect_quirks(udev);
4573 if (udev->quirks & USB_QUIRK_DELAY_INIT)
4576 /* consecutive bus-powered hubs aren't reliable; they can
4577 * violate the voltage drop budget. if the new child has
4578 * a "powered" LED, users should notice we didn't enable it
4579 * (without reading syslog), even without per-port LEDs
4582 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
4583 && udev->bus_mA <= unit_load) {
4586 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
4589 dev_dbg(&udev->dev, "get status %d ?\n", status);
4592 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
4594 "can't connect bus-powered hub "
4596 if (hub->has_indicators) {
4597 hub->indicator[port1-1] =
4598 INDICATOR_AMBER_BLINK;
4600 system_power_efficient_wq,
4603 status = -ENOTCONN; /* Don't retry */
4608 /* check for devices running slower than they could */
4609 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
4610 && udev->speed == USB_SPEED_FULL
4611 && highspeed_hubs != 0)
4612 check_highspeed (hub, udev, port1);
4614 /* Store the parent's children[] pointer. At this point
4615 * udev becomes globally accessible, although presumably
4616 * no one will look at it until hdev is unlocked.
4620 mutex_lock(&usb_port_peer_mutex);
4622 /* We mustn't add new devices if the parent hub has
4623 * been disconnected; we would race with the
4624 * recursively_mark_NOTATTACHED() routine.
4626 spin_lock_irq(&device_state_lock);
4627 if (hdev->state == USB_STATE_NOTATTACHED)
4630 port_dev->child = udev;
4631 spin_unlock_irq(&device_state_lock);
4632 mutex_unlock(&usb_port_peer_mutex);
4634 /* Run it through the hoops (find a driver, etc) */
4636 status = usb_new_device(udev);
4638 mutex_lock(&usb_port_peer_mutex);
4639 spin_lock_irq(&device_state_lock);
4640 port_dev->child = NULL;
4641 spin_unlock_irq(&device_state_lock);
4642 mutex_unlock(&usb_port_peer_mutex);
4649 status = hub_power_remaining(hub);
4651 dev_dbg(hub->intfdev, "%dmA power budget left\n", status);
4656 hub_port_disable(hub, port1, 1);
4658 usb_ep0_reinit(udev);
4659 release_devnum(udev);
4662 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
4665 if (hub->hdev->parent ||
4666 !hcd->driver->port_handed_over ||
4667 !(hcd->driver->port_handed_over)(hcd, port1)) {
4668 if (status != -ENOTCONN && status != -ENODEV)
4669 dev_err(&port_dev->dev,
4670 "unable to enumerate USB device\n");
4674 hub_port_disable(hub, port1, 1);
4675 if (hcd->driver->relinquish_port && !hub->hdev->parent)
4676 hcd->driver->relinquish_port(hcd, port1);
4679 /* Returns 1 if there was a remote wakeup and a connect status change. */
4680 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
4681 u16 portstatus, u16 portchange)
4683 struct usb_port *port_dev = hub->ports[port - 1];
4684 struct usb_device *hdev;
4685 struct usb_device *udev;
4686 int connect_change = 0;
4690 udev = port_dev->child;
4691 if (!hub_is_superspeed(hdev)) {
4692 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
4694 usb_clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
4696 if (!udev || udev->state != USB_STATE_SUSPENDED ||
4697 (portstatus & USB_PORT_STAT_LINK_STATE) !=
4703 /* TRSMRCY = 10 msec */
4706 usb_lock_device(udev);
4707 ret = usb_remote_wakeup(udev);
4708 usb_unlock_device(udev);
4713 hub_port_disable(hub, port, 1);
4715 dev_dbg(&port_dev->dev, "resume, status %d\n", ret);
4716 return connect_change;
4719 static void hub_events(void)
4721 struct list_head *tmp;
4722 struct usb_device *hdev;
4723 struct usb_interface *intf;
4724 struct usb_hub *hub;
4725 struct device *hub_dev;
4731 int connect_change, wakeup_change;
4734 * We restart the list every time to avoid a deadlock with
4735 * deleting hubs downstream from this one. This should be
4736 * safe since we delete the hub from the event list.
4737 * Not the most efficient, but avoids deadlocks.
4741 /* Grab the first entry at the beginning of the list */
4742 spin_lock_irq(&hub_event_lock);
4743 if (list_empty(&hub_event_list)) {
4744 spin_unlock_irq(&hub_event_lock);
4748 tmp = hub_event_list.next;
4751 hub = list_entry(tmp, struct usb_hub, event_list);
4752 kref_get(&hub->kref);
4753 spin_unlock_irq(&hub_event_lock);
4756 hub_dev = hub->intfdev;
4757 intf = to_usb_interface(hub_dev);
4758 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
4759 hdev->state, hdev->maxchild,
4760 /* NOTE: expects max 15 ports... */
4761 (u16) hub->change_bits[0],
4762 (u16) hub->event_bits[0]);
4764 /* Lock the device, then check to see if we were
4765 * disconnected while waiting for the lock to succeed. */
4766 usb_lock_device(hdev);
4767 if (unlikely(hub->disconnected))
4768 goto loop_disconnected;
4770 /* If the hub has died, clean up after it */
4771 if (hdev->state == USB_STATE_NOTATTACHED) {
4772 hub->error = -ENODEV;
4773 hub_quiesce(hub, HUB_DISCONNECT);
4778 ret = usb_autopm_get_interface(intf);
4780 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
4784 /* If this is an inactive hub, do nothing */
4789 dev_dbg (hub_dev, "resetting for error %d\n",
4792 ret = usb_reset_device(hdev);
4795 "error resetting hub: %d\n", ret);
4803 /* deal with port status changes */
4804 for (i = 1; i <= hdev->maxchild; i++) {
4805 struct usb_port *port_dev = hub->ports[i - 1];
4806 struct usb_device *udev = port_dev->child;
4808 if (test_bit(i, hub->busy_bits))
4810 connect_change = test_bit(i, hub->change_bits);
4811 wakeup_change = test_and_clear_bit(i, hub->wakeup_bits);
4812 if (!test_and_clear_bit(i, hub->event_bits) &&
4813 !connect_change && !wakeup_change)
4816 ret = hub_port_status(hub, i,
4817 &portstatus, &portchange);
4821 if (portchange & USB_PORT_STAT_C_CONNECTION) {
4822 usb_clear_port_feature(hdev, i,
4823 USB_PORT_FEAT_C_CONNECTION);
4827 if (portchange & USB_PORT_STAT_C_ENABLE) {
4828 if (!connect_change)
4829 dev_dbg(&port_dev->dev,
4830 "enable change, status %08x\n",
4832 usb_clear_port_feature(hdev, i,
4833 USB_PORT_FEAT_C_ENABLE);
4836 * EM interference sometimes causes badly
4837 * shielded USB devices to be shutdown by
4838 * the hub, this hack enables them again.
4839 * Works at least with mouse driver.
4841 if (!(portstatus & USB_PORT_STAT_ENABLE)
4842 && !connect_change && udev) {
4843 dev_err(&port_dev->dev,
4844 "disabled by hub (EMI?), re-enabling...\n");
4849 if (hub_handle_remote_wakeup(hub, i,
4850 portstatus, portchange))
4853 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
4857 dev_dbg(&port_dev->dev, "over-current change\n");
4858 usb_clear_port_feature(hdev, i,
4859 USB_PORT_FEAT_C_OVER_CURRENT);
4860 msleep(100); /* Cool down */
4861 hub_power_on(hub, true);
4862 hub_port_status(hub, i, &status, &unused);
4863 if (status & USB_PORT_STAT_OVERCURRENT)
4864 dev_err(&port_dev->dev,
4865 "over-current condition\n");
4868 if (portchange & USB_PORT_STAT_C_RESET) {
4869 dev_dbg(&port_dev->dev, "reset change\n");
4870 usb_clear_port_feature(hdev, i,
4871 USB_PORT_FEAT_C_RESET);
4873 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
4874 hub_is_superspeed(hub->hdev)) {
4875 dev_dbg(&port_dev->dev, "warm reset change\n");
4876 usb_clear_port_feature(hdev, i,
4877 USB_PORT_FEAT_C_BH_PORT_RESET);
4879 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
4880 usb_clear_port_feature(hub->hdev, i,
4881 USB_PORT_FEAT_C_PORT_LINK_STATE);
4883 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
4884 dev_warn(&port_dev->dev, "config error\n");
4885 usb_clear_port_feature(hub->hdev, i,
4886 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
4889 /* Warm reset a USB3 protocol port if it's in
4890 * SS.Inactive state.
4892 if (hub_port_warm_reset_required(hub, portstatus)) {
4895 dev_dbg(&port_dev->dev, "warm reset\n");
4897 !(portstatus & USB_PORT_STAT_CONNECTION) ||
4898 udev->state == USB_STATE_NOTATTACHED) {
4899 status = hub_port_reset(hub, i,
4900 NULL, HUB_BH_RESET_TIME,
4903 hub_port_disable(hub, i, 1);
4905 usb_lock_device(udev);
4906 status = usb_reset_device(udev);
4907 usb_unlock_device(udev);
4911 * On disconnect USB3 protocol ports transit from U0 to
4912 * SS.Inactive to Rx.Detect. If this happens a warm-
4913 * reset is not needed, but a (re)connect may happen
4914 * before khubd runs and sees the disconnect, and the
4915 * device may be an unknown state.
4917 * If the port went through SS.Inactive without khubd
4918 * seeing it the C_LINK_STATE change flag will be set,
4919 * and we reset the dev to put it in a known state.
4921 } else if (udev && hub_is_superspeed(hub->hdev) &&
4922 (portchange & USB_PORT_STAT_C_LINK_STATE) &&
4923 (portstatus & USB_PORT_STAT_CONNECTION)) {
4924 usb_lock_device(udev);
4925 usb_reset_device(udev);
4926 usb_unlock_device(udev);
4931 hub_port_connect_change(hub, i,
4932 portstatus, portchange);
4935 /* deal with hub status changes */
4936 if (test_and_clear_bit(0, hub->event_bits) == 0)
4938 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
4939 dev_err (hub_dev, "get_hub_status failed\n");
4941 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
4942 dev_dbg (hub_dev, "power change\n");
4943 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
4944 if (hubstatus & HUB_STATUS_LOCAL_POWER)
4945 /* FIXME: Is this always true? */
4946 hub->limited_power = 1;
4948 hub->limited_power = 0;
4950 if (hubchange & HUB_CHANGE_OVERCURRENT) {
4954 dev_dbg(hub_dev, "over-current change\n");
4955 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
4956 msleep(500); /* Cool down */
4957 hub_power_on(hub, true);
4958 hub_hub_status(hub, &status, &unused);
4959 if (status & HUB_STATUS_OVERCURRENT)
4960 dev_err(hub_dev, "over-current "
4966 /* Balance the usb_autopm_get_interface() above */
4967 usb_autopm_put_interface_no_suspend(intf);
4969 /* Balance the usb_autopm_get_interface_no_resume() in
4970 * kick_khubd() and allow autosuspend.
4972 usb_autopm_put_interface(intf);
4974 usb_unlock_device(hdev);
4975 kref_put(&hub->kref, hub_release);
4977 } /* end while (1) */
4980 static int hub_thread(void *__unused)
4982 /* khubd needs to be freezable to avoid interfering with USB-PERSIST
4983 * port handover. Otherwise it might see that a full-speed device
4984 * was gone before the EHCI controller had handed its port over to
4985 * the companion full-speed controller.
4991 wait_event_freezable(khubd_wait,
4992 !list_empty(&hub_event_list) ||
4993 kthread_should_stop());
4994 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
4996 pr_debug("%s: khubd exiting\n", usbcore_name);
5000 static const struct usb_device_id hub_id_table[] = {
5001 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5002 | USB_DEVICE_ID_MATCH_INT_CLASS,
5003 .idVendor = USB_VENDOR_GENESYS_LOGIC,
5004 .bInterfaceClass = USB_CLASS_HUB,
5005 .driver_info = HUB_QUIRK_CHECK_PORT_AUTOSUSPEND},
5006 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
5007 .bDeviceClass = USB_CLASS_HUB},
5008 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
5009 .bInterfaceClass = USB_CLASS_HUB},
5010 { } /* Terminating entry */
5013 MODULE_DEVICE_TABLE (usb, hub_id_table);
5015 static struct usb_driver hub_driver = {
5018 .disconnect = hub_disconnect,
5019 .suspend = hub_suspend,
5020 .resume = hub_resume,
5021 .reset_resume = hub_reset_resume,
5022 .pre_reset = hub_pre_reset,
5023 .post_reset = hub_post_reset,
5024 .unlocked_ioctl = hub_ioctl,
5025 .id_table = hub_id_table,
5026 .supports_autosuspend = 1,
5029 int usb_hub_init(void)
5031 if (usb_register(&hub_driver) < 0) {
5032 printk(KERN_ERR "%s: can't register hub driver\n",
5037 khubd_task = kthread_run(hub_thread, NULL, "khubd");
5038 if (!IS_ERR(khubd_task))
5041 /* Fall through if kernel_thread failed */
5042 usb_deregister(&hub_driver);
5043 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
5048 void usb_hub_cleanup(void)
5050 kthread_stop(khubd_task);
5053 * Hub resources are freed for us by usb_deregister. It calls
5054 * usb_driver_purge on every device which in turn calls that
5055 * devices disconnect function if it is using this driver.
5056 * The hub_disconnect function takes care of releasing the
5057 * individual hub resources. -greg
5059 usb_deregister(&hub_driver);
5060 } /* usb_hub_cleanup() */
5062 static int descriptors_changed(struct usb_device *udev,
5063 struct usb_device_descriptor *old_device_descriptor,
5064 struct usb_host_bos *old_bos)
5068 unsigned serial_len = 0;
5070 unsigned old_length;
5074 if (memcmp(&udev->descriptor, old_device_descriptor,
5075 sizeof(*old_device_descriptor)) != 0)
5078 if ((old_bos && !udev->bos) || (!old_bos && udev->bos))
5081 len = le16_to_cpu(udev->bos->desc->wTotalLength);
5082 if (len != le16_to_cpu(old_bos->desc->wTotalLength))
5084 if (memcmp(udev->bos->desc, old_bos->desc, len))
5088 /* Since the idVendor, idProduct, and bcdDevice values in the
5089 * device descriptor haven't changed, we will assume the
5090 * Manufacturer and Product strings haven't changed either.
5091 * But the SerialNumber string could be different (e.g., a
5092 * different flash card of the same brand).
5095 serial_len = strlen(udev->serial) + 1;
5098 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5099 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5100 len = max(len, old_length);
5103 buf = kmalloc(len, GFP_NOIO);
5105 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
5106 /* assume the worst */
5109 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5110 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5111 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
5113 if (length != old_length) {
5114 dev_dbg(&udev->dev, "config index %d, error %d\n",
5119 if (memcmp (buf, udev->rawdescriptors[index], old_length)
5121 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
5123 ((struct usb_config_descriptor *) buf)->
5124 bConfigurationValue);
5130 if (!changed && serial_len) {
5131 length = usb_string(udev, udev->descriptor.iSerialNumber,
5133 if (length + 1 != serial_len) {
5134 dev_dbg(&udev->dev, "serial string error %d\n",
5137 } else if (memcmp(buf, udev->serial, length) != 0) {
5138 dev_dbg(&udev->dev, "serial string changed\n");
5148 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5149 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5151 * WARNING - don't use this routine to reset a composite device
5152 * (one with multiple interfaces owned by separate drivers)!
5153 * Use usb_reset_device() instead.
5155 * Do a port reset, reassign the device's address, and establish its
5156 * former operating configuration. If the reset fails, or the device's
5157 * descriptors change from their values before the reset, or the original
5158 * configuration and altsettings cannot be restored, a flag will be set
5159 * telling khubd to pretend the device has been disconnected and then
5160 * re-connected. All drivers will be unbound, and the device will be
5161 * re-enumerated and probed all over again.
5163 * Return: 0 if the reset succeeded, -ENODEV if the device has been
5164 * flagged for logical disconnection, or some other negative error code
5165 * if the reset wasn't even attempted.
5168 * The caller must own the device lock. For example, it's safe to use
5169 * this from a driver probe() routine after downloading new firmware.
5170 * For calls that might not occur during probe(), drivers should lock
5171 * the device using usb_lock_device_for_reset().
5173 * Locking exception: This routine may also be called from within an
5174 * autoresume handler. Such usage won't conflict with other tasks
5175 * holding the device lock because these tasks should always call
5176 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
5178 static int usb_reset_and_verify_device(struct usb_device *udev)
5180 struct usb_device *parent_hdev = udev->parent;
5181 struct usb_hub *parent_hub;
5182 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
5183 struct usb_device_descriptor descriptor = udev->descriptor;
5184 struct usb_host_bos *bos;
5186 int port1 = udev->portnum;
5188 if (udev->state == USB_STATE_NOTATTACHED ||
5189 udev->state == USB_STATE_SUSPENDED) {
5190 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5196 /* this requires hcd-specific logic; see ohci_restart() */
5197 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
5200 parent_hub = usb_hub_to_struct_hub(parent_hdev);
5202 /* Disable USB2 hardware LPM.
5203 * It will be re-enabled by the enumeration process.
5205 if (udev->usb2_hw_lpm_enabled == 1)
5206 usb_set_usb2_hardware_lpm(udev, 0);
5211 /* Disable LPM and LTM while we reset the device and reinstall the alt
5212 * settings. Device-initiated LPM settings, and system exit latency
5213 * settings are cleared when the device is reset, so we have to set
5216 ret = usb_unlocked_disable_lpm(udev);
5218 dev_err(&udev->dev, "%s Failed to disable LPM\n.", __func__);
5221 ret = usb_disable_ltm(udev);
5223 dev_err(&udev->dev, "%s Failed to disable LTM\n.",
5228 set_bit(port1, parent_hub->busy_bits);
5229 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
5231 /* ep0 maxpacket size may change; let the HCD know about it.
5232 * Other endpoints will be handled by re-enumeration. */
5233 usb_ep0_reinit(udev);
5234 ret = hub_port_init(parent_hub, udev, port1, i);
5235 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
5238 clear_bit(port1, parent_hub->busy_bits);
5243 /* Device might have changed firmware (DFU or similar) */
5244 if (descriptors_changed(udev, &descriptor, bos)) {
5245 dev_info(&udev->dev, "device firmware changed\n");
5246 udev->descriptor = descriptor; /* for disconnect() calls */
5250 /* Restore the device's previous configuration */
5251 if (!udev->actconfig)
5254 mutex_lock(hcd->bandwidth_mutex);
5255 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
5257 dev_warn(&udev->dev,
5258 "Busted HC? Not enough HCD resources for "
5259 "old configuration.\n");
5260 mutex_unlock(hcd->bandwidth_mutex);
5263 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
5264 USB_REQ_SET_CONFIGURATION, 0,
5265 udev->actconfig->desc.bConfigurationValue, 0,
5266 NULL, 0, USB_CTRL_SET_TIMEOUT);
5269 "can't restore configuration #%d (error=%d)\n",
5270 udev->actconfig->desc.bConfigurationValue, ret);
5271 mutex_unlock(hcd->bandwidth_mutex);
5274 mutex_unlock(hcd->bandwidth_mutex);
5275 usb_set_device_state(udev, USB_STATE_CONFIGURED);
5277 /* Put interfaces back into the same altsettings as before.
5278 * Don't bother to send the Set-Interface request for interfaces
5279 * that were already in altsetting 0; besides being unnecessary,
5280 * many devices can't handle it. Instead just reset the host-side
5283 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
5284 struct usb_host_config *config = udev->actconfig;
5285 struct usb_interface *intf = config->interface[i];
5286 struct usb_interface_descriptor *desc;
5288 desc = &intf->cur_altsetting->desc;
5289 if (desc->bAlternateSetting == 0) {
5290 usb_disable_interface(udev, intf, true);
5291 usb_enable_interface(udev, intf, true);
5294 /* Let the bandwidth allocation function know that this
5295 * device has been reset, and it will have to use
5296 * alternate setting 0 as the current alternate setting.
5298 intf->resetting_device = 1;
5299 ret = usb_set_interface(udev, desc->bInterfaceNumber,
5300 desc->bAlternateSetting);
5301 intf->resetting_device = 0;
5304 dev_err(&udev->dev, "failed to restore interface %d "
5305 "altsetting %d (error=%d)\n",
5306 desc->bInterfaceNumber,
5307 desc->bAlternateSetting,
5311 /* Resetting also frees any allocated streams */
5312 for (j = 0; j < intf->cur_altsetting->desc.bNumEndpoints; j++)
5313 intf->cur_altsetting->endpoint[j].streams = 0;
5317 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5318 usb_set_usb2_hardware_lpm(udev, 1);
5319 usb_unlocked_enable_lpm(udev);
5320 usb_enable_ltm(udev);
5321 usb_release_bos_descriptor(udev);
5326 /* LPM state doesn't matter when we're about to destroy the device. */
5327 hub_port_logical_disconnect(parent_hub, port1);
5328 usb_release_bos_descriptor(udev);
5334 * usb_reset_device - warn interface drivers and perform a USB port reset
5335 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5337 * Warns all drivers bound to registered interfaces (using their pre_reset
5338 * method), performs the port reset, and then lets the drivers know that
5339 * the reset is over (using their post_reset method).
5341 * Return: The same as for usb_reset_and_verify_device().
5344 * The caller must own the device lock. For example, it's safe to use
5345 * this from a driver probe() routine after downloading new firmware.
5346 * For calls that might not occur during probe(), drivers should lock
5347 * the device using usb_lock_device_for_reset().
5349 * If an interface is currently being probed or disconnected, we assume
5350 * its driver knows how to handle resets. For all other interfaces,
5351 * if the driver doesn't have pre_reset and post_reset methods then
5352 * we attempt to unbind it and rebind afterward.
5354 int usb_reset_device(struct usb_device *udev)
5358 unsigned int noio_flag;
5359 struct usb_host_config *config = udev->actconfig;
5361 if (udev->state == USB_STATE_NOTATTACHED ||
5362 udev->state == USB_STATE_SUSPENDED) {
5363 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5369 * Don't allocate memory with GFP_KERNEL in current
5370 * context to avoid possible deadlock if usb mass
5371 * storage interface or usbnet interface(iSCSI case)
5372 * is included in current configuration. The easist
5373 * approach is to do it for every device reset,
5374 * because the device 'memalloc_noio' flag may have
5375 * not been set before reseting the usb device.
5377 noio_flag = memalloc_noio_save();
5379 /* Prevent autosuspend during the reset */
5380 usb_autoresume_device(udev);
5383 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
5384 struct usb_interface *cintf = config->interface[i];
5385 struct usb_driver *drv;
5388 if (cintf->dev.driver) {
5389 drv = to_usb_driver(cintf->dev.driver);
5390 if (drv->pre_reset && drv->post_reset)
5391 unbind = (drv->pre_reset)(cintf);
5392 else if (cintf->condition ==
5393 USB_INTERFACE_BOUND)
5396 usb_forced_unbind_intf(cintf);
5401 ret = usb_reset_and_verify_device(udev);
5404 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
5405 struct usb_interface *cintf = config->interface[i];
5406 struct usb_driver *drv;
5407 int rebind = cintf->needs_binding;
5409 if (!rebind && cintf->dev.driver) {
5410 drv = to_usb_driver(cintf->dev.driver);
5411 if (drv->post_reset)
5412 rebind = (drv->post_reset)(cintf);
5413 else if (cintf->condition ==
5414 USB_INTERFACE_BOUND)
5417 cintf->needs_binding = 1;
5420 usb_unbind_and_rebind_marked_interfaces(udev);
5423 usb_autosuspend_device(udev);
5424 memalloc_noio_restore(noio_flag);
5427 EXPORT_SYMBOL_GPL(usb_reset_device);
5431 * usb_queue_reset_device - Reset a USB device from an atomic context
5432 * @iface: USB interface belonging to the device to reset
5434 * This function can be used to reset a USB device from an atomic
5435 * context, where usb_reset_device() won't work (as it blocks).
5437 * Doing a reset via this method is functionally equivalent to calling
5438 * usb_reset_device(), except for the fact that it is delayed to a
5439 * workqueue. This means that any drivers bound to other interfaces
5440 * might be unbound, as well as users from usbfs in user space.
5444 * - Scheduling two resets at the same time from two different drivers
5445 * attached to two different interfaces of the same device is
5446 * possible; depending on how the driver attached to each interface
5447 * handles ->pre_reset(), the second reset might happen or not.
5449 * - If a driver is unbound and it had a pending reset, the reset will
5452 * - This function can be called during .probe() or .disconnect()
5453 * times. On return from .disconnect(), any pending resets will be
5456 * There is no no need to lock/unlock the @reset_ws as schedule_work()
5459 * NOTE: We don't do any reference count tracking because it is not
5460 * needed. The lifecycle of the work_struct is tied to the
5461 * usb_interface. Before destroying the interface we cancel the
5462 * work_struct, so the fact that work_struct is queued and or
5463 * running means the interface (and thus, the device) exist and
5466 void usb_queue_reset_device(struct usb_interface *iface)
5468 schedule_work(&iface->reset_ws);
5470 EXPORT_SYMBOL_GPL(usb_queue_reset_device);
5473 * usb_hub_find_child - Get the pointer of child device
5474 * attached to the port which is specified by @port1.
5475 * @hdev: USB device belonging to the usb hub
5476 * @port1: port num to indicate which port the child device
5479 * USB drivers call this function to get hub's child device
5482 * Return: %NULL if input param is invalid and
5483 * child's usb_device pointer if non-NULL.
5485 struct usb_device *usb_hub_find_child(struct usb_device *hdev,
5488 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5490 if (port1 < 1 || port1 > hdev->maxchild)
5492 return hub->ports[port1 - 1]->child;
5494 EXPORT_SYMBOL_GPL(usb_hub_find_child);
5496 void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
5497 struct usb_hub_descriptor *desc)
5499 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5500 enum usb_port_connect_type connect_type;
5506 if (!hub_is_superspeed(hdev)) {
5507 for (i = 1; i <= hdev->maxchild; i++) {
5508 struct usb_port *port_dev = hub->ports[i - 1];
5510 connect_type = port_dev->connect_type;
5511 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5512 u8 mask = 1 << (i%8);
5514 if (!(desc->u.hs.DeviceRemovable[i/8] & mask)) {
5515 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
5516 desc->u.hs.DeviceRemovable[i/8] |= mask;
5521 u16 port_removable = le16_to_cpu(desc->u.ss.DeviceRemovable);
5523 for (i = 1; i <= hdev->maxchild; i++) {
5524 struct usb_port *port_dev = hub->ports[i - 1];
5526 connect_type = port_dev->connect_type;
5527 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5530 if (!(port_removable & mask)) {
5531 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
5532 port_removable |= mask;
5537 desc->u.ss.DeviceRemovable = cpu_to_le16(port_removable);
5543 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5544 * @hdev: USB device belonging to the usb hub
5545 * @port1: port num of the port
5547 * Return: Port's acpi handle if successful, %NULL if params are
5550 acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
5553 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5558 return ACPI_HANDLE(&hub->ports[port1 - 1]->dev);