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>
30 #include <asm/uaccess.h>
31 #include <asm/byteorder.h>
35 /* if we are in debug mode, always announce new devices */
37 #ifndef CONFIG_USB_ANNOUNCE_NEW_DEVICES
38 #define CONFIG_USB_ANNOUNCE_NEW_DEVICES
42 #define USB_VENDOR_GENESYS_LOGIC 0x05e3
43 #define HUB_QUIRK_CHECK_PORT_AUTOSUSPEND 0x01
45 static inline int hub_is_superspeed(struct usb_device *hdev)
47 return (hdev->descriptor.bDeviceProtocol == USB_HUB_PR_SS);
50 /* Protect struct usb_device->state and ->children members
51 * Note: Both are also protected by ->dev.sem, except that ->state can
52 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
53 static DEFINE_SPINLOCK(device_state_lock);
55 /* khubd's worklist and its lock */
56 static DEFINE_SPINLOCK(hub_event_lock);
57 static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
60 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
62 static struct task_struct *khubd_task;
64 /* cycle leds on hubs that aren't blinking for attention */
65 static bool blinkenlights = 0;
66 module_param (blinkenlights, bool, S_IRUGO);
67 MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
70 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
71 * 10 seconds to send reply for the initial 64-byte descriptor request.
73 /* define initial 64-byte descriptor request timeout in milliseconds */
74 static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
75 module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
76 MODULE_PARM_DESC(initial_descriptor_timeout,
77 "initial 64-byte descriptor request timeout in milliseconds "
78 "(default 5000 - 5.0 seconds)");
81 * As of 2.6.10 we introduce a new USB device initialization scheme which
82 * closely resembles the way Windows works. Hopefully it will be compatible
83 * with a wider range of devices than the old scheme. However some previously
84 * working devices may start giving rise to "device not accepting address"
85 * errors; if that happens the user can try the old scheme by adjusting the
86 * following module parameters.
88 * For maximum flexibility there are two boolean parameters to control the
89 * hub driver's behavior. On the first initialization attempt, if the
90 * "old_scheme_first" parameter is set then the old scheme will be used,
91 * otherwise the new scheme is used. If that fails and "use_both_schemes"
92 * is set, then the driver will make another attempt, using the other scheme.
94 static bool old_scheme_first = 0;
95 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
96 MODULE_PARM_DESC(old_scheme_first,
97 "start with the old device initialization scheme");
99 static bool use_both_schemes = 1;
100 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
101 MODULE_PARM_DESC(use_both_schemes,
102 "try the other device initialization scheme if the "
105 /* Mutual exclusion for EHCI CF initialization. This interferes with
106 * port reset on some companion controllers.
108 DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
109 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
111 #define HUB_DEBOUNCE_TIMEOUT 1500
112 #define HUB_DEBOUNCE_STEP 25
113 #define HUB_DEBOUNCE_STABLE 100
115 static int usb_reset_and_verify_device(struct usb_device *udev);
117 static inline char *portspeed(struct usb_hub *hub, int portstatus)
119 if (hub_is_superspeed(hub->hdev))
121 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
123 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
129 /* Note that hdev or one of its children must be locked! */
130 static struct usb_hub *hdev_to_hub(struct usb_device *hdev)
132 if (!hdev || !hdev->actconfig || !hdev->maxchild)
134 return usb_get_intfdata(hdev->actconfig->interface[0]);
137 static int usb_device_supports_lpm(struct usb_device *udev)
139 /* USB 2.1 (and greater) devices indicate LPM support through
140 * their USB 2.0 Extended Capabilities BOS descriptor.
142 if (udev->speed == USB_SPEED_HIGH) {
143 if (udev->bos->ext_cap &&
145 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
150 /* All USB 3.0 must support LPM, but we need their max exit latency
151 * information from the SuperSpeed Extended Capabilities BOS descriptor.
153 if (!udev->bos->ss_cap) {
154 dev_warn(&udev->dev, "No LPM exit latency info found. "
155 "Power management will be impacted.\n");
158 if (udev->parent->lpm_capable)
161 dev_warn(&udev->dev, "Parent hub missing LPM exit latency info. "
162 "Power management will be impacted.\n");
167 * Set the Maximum Exit Latency (MEL) for the host to initiate a transition from
170 static void usb_set_lpm_mel(struct usb_device *udev,
171 struct usb3_lpm_parameters *udev_lpm_params,
172 unsigned int udev_exit_latency,
174 struct usb3_lpm_parameters *hub_lpm_params,
175 unsigned int hub_exit_latency)
177 unsigned int total_mel;
178 unsigned int device_mel;
179 unsigned int hub_mel;
182 * Calculate the time it takes to transition all links from the roothub
183 * to the parent hub into U0. The parent hub must then decode the
184 * packet (hub header decode latency) to figure out which port it was
187 * The Hub Header decode latency is expressed in 0.1us intervals (0x1
188 * means 0.1us). Multiply that by 100 to get nanoseconds.
190 total_mel = hub_lpm_params->mel +
191 (hub->descriptor->u.ss.bHubHdrDecLat * 100);
194 * How long will it take to transition the downstream hub's port into
195 * U0? The greater of either the hub exit latency or the device exit
198 * The BOS U1/U2 exit latencies are expressed in 1us intervals.
199 * Multiply that by 1000 to get nanoseconds.
201 device_mel = udev_exit_latency * 1000;
202 hub_mel = hub_exit_latency * 1000;
203 if (device_mel > hub_mel)
204 total_mel += device_mel;
206 total_mel += hub_mel;
208 udev_lpm_params->mel = total_mel;
212 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
213 * a transition from either U1 or U2.
215 static void usb_set_lpm_pel(struct usb_device *udev,
216 struct usb3_lpm_parameters *udev_lpm_params,
217 unsigned int udev_exit_latency,
219 struct usb3_lpm_parameters *hub_lpm_params,
220 unsigned int hub_exit_latency,
221 unsigned int port_to_port_exit_latency)
223 unsigned int first_link_pel;
224 unsigned int hub_pel;
227 * First, the device sends an LFPS to transition the link between the
228 * device and the parent hub into U0. The exit latency is the bigger of
229 * the device exit latency or the hub exit latency.
231 if (udev_exit_latency > hub_exit_latency)
232 first_link_pel = udev_exit_latency * 1000;
234 first_link_pel = hub_exit_latency * 1000;
237 * When the hub starts to receive the LFPS, there is a slight delay for
238 * it to figure out that one of the ports is sending an LFPS. Then it
239 * will forward the LFPS to its upstream link. The exit latency is the
240 * delay, plus the PEL that we calculated for this hub.
242 hub_pel = port_to_port_exit_latency * 1000 + hub_lpm_params->pel;
245 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
246 * is the greater of the two exit latencies.
248 if (first_link_pel > hub_pel)
249 udev_lpm_params->pel = first_link_pel;
251 udev_lpm_params->pel = hub_pel;
255 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
256 * when a device initiates a transition to U0, until when it will receive the
257 * first packet from the host controller.
259 * Section C.1.5.1 describes the four components to this:
261 * - t2: time for the ERDY to make it from the device to the host.
262 * - t3: a host-specific delay to process the ERDY.
263 * - t4: time for the packet to make it from the host to the device.
265 * t3 is specific to both the xHCI host and the platform the host is integrated
266 * into. The Intel HW folks have said it's negligible, FIXME if a different
267 * vendor says otherwise.
269 static void usb_set_lpm_sel(struct usb_device *udev,
270 struct usb3_lpm_parameters *udev_lpm_params)
272 struct usb_device *parent;
273 unsigned int num_hubs;
274 unsigned int total_sel;
276 /* t1 = device PEL */
277 total_sel = udev_lpm_params->pel;
278 /* How many external hubs are in between the device & the root port. */
279 for (parent = udev->parent, num_hubs = 0; parent->parent;
280 parent = parent->parent)
282 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
284 total_sel += 2100 + 250 * (num_hubs - 1);
286 /* t4 = 250ns * num_hubs */
287 total_sel += 250 * num_hubs;
289 udev_lpm_params->sel = total_sel;
292 static void usb_set_lpm_parameters(struct usb_device *udev)
295 unsigned int port_to_port_delay;
296 unsigned int udev_u1_del;
297 unsigned int udev_u2_del;
298 unsigned int hub_u1_del;
299 unsigned int hub_u2_del;
301 if (!udev->lpm_capable || udev->speed != USB_SPEED_SUPER)
304 hub = hdev_to_hub(udev->parent);
305 /* It doesn't take time to transition the roothub into U0, since it
306 * doesn't have an upstream link.
311 udev_u1_del = udev->bos->ss_cap->bU1devExitLat;
312 udev_u2_del = udev->bos->ss_cap->bU2DevExitLat;
313 hub_u1_del = udev->parent->bos->ss_cap->bU1devExitLat;
314 hub_u2_del = udev->parent->bos->ss_cap->bU2DevExitLat;
316 usb_set_lpm_mel(udev, &udev->u1_params, udev_u1_del,
317 hub, &udev->parent->u1_params, hub_u1_del);
319 usb_set_lpm_mel(udev, &udev->u2_params, udev_u2_del,
320 hub, &udev->parent->u2_params, hub_u2_del);
323 * Appendix C, section C.2.2.2, says that there is a slight delay from
324 * when the parent hub notices the downstream port is trying to
325 * transition to U0 to when the hub initiates a U0 transition on its
326 * upstream port. The section says the delays are tPort2PortU1EL and
327 * tPort2PortU2EL, but it doesn't define what they are.
329 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
330 * about the same delays. Use the maximum delay calculations from those
331 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
332 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
333 * assume the device exit latencies they are talking about are the hub
336 * What do we do if the U2 exit latency is less than the U1 exit
337 * latency? It's possible, although not likely...
339 port_to_port_delay = 1;
341 usb_set_lpm_pel(udev, &udev->u1_params, udev_u1_del,
342 hub, &udev->parent->u1_params, hub_u1_del,
345 if (hub_u2_del > hub_u1_del)
346 port_to_port_delay = 1 + hub_u2_del - hub_u1_del;
348 port_to_port_delay = 1 + hub_u1_del;
350 usb_set_lpm_pel(udev, &udev->u2_params, udev_u2_del,
351 hub, &udev->parent->u2_params, hub_u2_del,
354 /* Now that we've got PEL, calculate SEL. */
355 usb_set_lpm_sel(udev, &udev->u1_params);
356 usb_set_lpm_sel(udev, &udev->u2_params);
359 /* USB 2.0 spec Section 11.24.4.5 */
360 static int get_hub_descriptor(struct usb_device *hdev, void *data)
365 if (hub_is_superspeed(hdev)) {
366 dtype = USB_DT_SS_HUB;
367 size = USB_DT_SS_HUB_SIZE;
370 size = sizeof(struct usb_hub_descriptor);
373 for (i = 0; i < 3; i++) {
374 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
375 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
376 dtype << 8, 0, data, size,
377 USB_CTRL_GET_TIMEOUT);
378 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
385 * USB 2.0 spec Section 11.24.2.1
387 static int clear_hub_feature(struct usb_device *hdev, int feature)
389 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
390 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
394 * USB 2.0 spec Section 11.24.2.2
396 static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
398 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
399 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
404 * USB 2.0 spec Section 11.24.2.13
406 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
408 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
409 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
414 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
415 * for info about using port indicators
417 static void set_port_led(
423 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
424 USB_PORT_FEAT_INDICATOR);
426 dev_dbg (hub->intfdev,
427 "port %d indicator %s status %d\n",
429 ({ char *s; switch (selector) {
430 case HUB_LED_AMBER: s = "amber"; break;
431 case HUB_LED_GREEN: s = "green"; break;
432 case HUB_LED_OFF: s = "off"; break;
433 case HUB_LED_AUTO: s = "auto"; break;
434 default: s = "??"; break;
439 #define LED_CYCLE_PERIOD ((2*HZ)/3)
441 static void led_work (struct work_struct *work)
443 struct usb_hub *hub =
444 container_of(work, struct usb_hub, leds.work);
445 struct usb_device *hdev = hub->hdev;
447 unsigned changed = 0;
450 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
453 for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
454 unsigned selector, mode;
456 /* 30%-50% duty cycle */
458 switch (hub->indicator[i]) {
460 case INDICATOR_CYCLE:
462 selector = HUB_LED_AUTO;
463 mode = INDICATOR_AUTO;
465 /* blinking green = sw attention */
466 case INDICATOR_GREEN_BLINK:
467 selector = HUB_LED_GREEN;
468 mode = INDICATOR_GREEN_BLINK_OFF;
470 case INDICATOR_GREEN_BLINK_OFF:
471 selector = HUB_LED_OFF;
472 mode = INDICATOR_GREEN_BLINK;
474 /* blinking amber = hw attention */
475 case INDICATOR_AMBER_BLINK:
476 selector = HUB_LED_AMBER;
477 mode = INDICATOR_AMBER_BLINK_OFF;
479 case INDICATOR_AMBER_BLINK_OFF:
480 selector = HUB_LED_OFF;
481 mode = INDICATOR_AMBER_BLINK;
483 /* blink green/amber = reserved */
484 case INDICATOR_ALT_BLINK:
485 selector = HUB_LED_GREEN;
486 mode = INDICATOR_ALT_BLINK_OFF;
488 case INDICATOR_ALT_BLINK_OFF:
489 selector = HUB_LED_AMBER;
490 mode = INDICATOR_ALT_BLINK;
495 if (selector != HUB_LED_AUTO)
497 set_port_led(hub, i + 1, selector);
498 hub->indicator[i] = mode;
500 if (!changed && blinkenlights) {
502 cursor %= hub->descriptor->bNbrPorts;
503 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
504 hub->indicator[cursor] = INDICATOR_CYCLE;
508 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
511 /* use a short timeout for hub/port status fetches */
512 #define USB_STS_TIMEOUT 1000
513 #define USB_STS_RETRIES 5
516 * USB 2.0 spec Section 11.24.2.6
518 static int get_hub_status(struct usb_device *hdev,
519 struct usb_hub_status *data)
521 int i, status = -ETIMEDOUT;
523 for (i = 0; i < USB_STS_RETRIES &&
524 (status == -ETIMEDOUT || status == -EPIPE); i++) {
525 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
526 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
527 data, sizeof(*data), USB_STS_TIMEOUT);
533 * USB 2.0 spec Section 11.24.2.7
535 static int get_port_status(struct usb_device *hdev, int port1,
536 struct usb_port_status *data)
538 int i, status = -ETIMEDOUT;
540 for (i = 0; i < USB_STS_RETRIES &&
541 (status == -ETIMEDOUT || status == -EPIPE); i++) {
542 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
543 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
544 data, sizeof(*data), USB_STS_TIMEOUT);
549 static int hub_port_status(struct usb_hub *hub, int port1,
550 u16 *status, u16 *change)
554 mutex_lock(&hub->status_mutex);
555 ret = get_port_status(hub->hdev, port1, &hub->status->port);
557 dev_err(hub->intfdev,
558 "%s failed (err = %d)\n", __func__, ret);
562 *status = le16_to_cpu(hub->status->port.wPortStatus);
563 *change = le16_to_cpu(hub->status->port.wPortChange);
567 mutex_unlock(&hub->status_mutex);
571 static void kick_khubd(struct usb_hub *hub)
575 spin_lock_irqsave(&hub_event_lock, flags);
576 if (!hub->disconnected && list_empty(&hub->event_list)) {
577 list_add_tail(&hub->event_list, &hub_event_list);
579 /* Suppress autosuspend until khubd runs */
580 usb_autopm_get_interface_no_resume(
581 to_usb_interface(hub->intfdev));
582 wake_up(&khubd_wait);
584 spin_unlock_irqrestore(&hub_event_lock, flags);
587 void usb_kick_khubd(struct usb_device *hdev)
589 struct usb_hub *hub = hdev_to_hub(hdev);
596 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
597 * Notification, which indicates it had initiated remote wakeup.
599 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
600 * device initiates resume, so the USB core will not receive notice of the
601 * resume through the normal hub interrupt URB.
603 void usb_wakeup_notification(struct usb_device *hdev,
604 unsigned int portnum)
611 hub = hdev_to_hub(hdev);
613 set_bit(portnum, hub->wakeup_bits);
617 EXPORT_SYMBOL_GPL(usb_wakeup_notification);
619 /* completion function, fires on port status changes and various faults */
620 static void hub_irq(struct urb *urb)
622 struct usb_hub *hub = urb->context;
623 int status = urb->status;
628 case -ENOENT: /* synchronous unlink */
629 case -ECONNRESET: /* async unlink */
630 case -ESHUTDOWN: /* hardware going away */
633 default: /* presumably an error */
634 /* Cause a hub reset after 10 consecutive errors */
635 dev_dbg (hub->intfdev, "transfer --> %d\n", status);
636 if ((++hub->nerrors < 10) || hub->error)
641 /* let khubd handle things */
642 case 0: /* we got data: port status changed */
644 for (i = 0; i < urb->actual_length; ++i)
645 bits |= ((unsigned long) ((*hub->buffer)[i]))
647 hub->event_bits[0] = bits;
653 /* Something happened, let khubd figure it out */
660 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
661 && status != -ENODEV && status != -EPERM)
662 dev_err (hub->intfdev, "resubmit --> %d\n", status);
665 /* USB 2.0 spec Section 11.24.2.3 */
667 hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
669 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
670 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
675 * enumeration blocks khubd for a long time. we use keventd instead, since
676 * long blocking there is the exception, not the rule. accordingly, HCDs
677 * talking to TTs must queue control transfers (not just bulk and iso), so
678 * both can talk to the same hub concurrently.
680 static void hub_tt_work(struct work_struct *work)
682 struct usb_hub *hub =
683 container_of(work, struct usb_hub, tt.clear_work);
686 spin_lock_irqsave (&hub->tt.lock, flags);
687 while (!list_empty(&hub->tt.clear_list)) {
688 struct list_head *next;
689 struct usb_tt_clear *clear;
690 struct usb_device *hdev = hub->hdev;
691 const struct hc_driver *drv;
694 next = hub->tt.clear_list.next;
695 clear = list_entry (next, struct usb_tt_clear, clear_list);
696 list_del (&clear->clear_list);
698 /* drop lock so HCD can concurrently report other TT errors */
699 spin_unlock_irqrestore (&hub->tt.lock, flags);
700 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
703 "clear tt %d (%04x) error %d\n",
704 clear->tt, clear->devinfo, status);
706 /* Tell the HCD, even if the operation failed */
707 drv = clear->hcd->driver;
708 if (drv->clear_tt_buffer_complete)
709 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
712 spin_lock_irqsave(&hub->tt.lock, flags);
714 spin_unlock_irqrestore (&hub->tt.lock, flags);
718 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
719 * @urb: an URB associated with the failed or incomplete split transaction
721 * High speed HCDs use this to tell the hub driver that some split control or
722 * bulk transaction failed in a way that requires clearing internal state of
723 * a transaction translator. This is normally detected (and reported) from
726 * It may not be possible for that hub to handle additional full (or low)
727 * speed transactions until that state is fully cleared out.
729 int usb_hub_clear_tt_buffer(struct urb *urb)
731 struct usb_device *udev = urb->dev;
732 int pipe = urb->pipe;
733 struct usb_tt *tt = udev->tt;
735 struct usb_tt_clear *clear;
737 /* we've got to cope with an arbitrary number of pending TT clears,
738 * since each TT has "at least two" buffers that can need it (and
739 * there can be many TTs per hub). even if they're uncommon.
741 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
742 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
743 /* FIXME recover somehow ... RESET_TT? */
747 /* info that CLEAR_TT_BUFFER needs */
748 clear->tt = tt->multi ? udev->ttport : 1;
749 clear->devinfo = usb_pipeendpoint (pipe);
750 clear->devinfo |= udev->devnum << 4;
751 clear->devinfo |= usb_pipecontrol (pipe)
752 ? (USB_ENDPOINT_XFER_CONTROL << 11)
753 : (USB_ENDPOINT_XFER_BULK << 11);
754 if (usb_pipein (pipe))
755 clear->devinfo |= 1 << 15;
757 /* info for completion callback */
758 clear->hcd = bus_to_hcd(udev->bus);
761 /* tell keventd to clear state for this TT */
762 spin_lock_irqsave (&tt->lock, flags);
763 list_add_tail (&clear->clear_list, &tt->clear_list);
764 schedule_work(&tt->clear_work);
765 spin_unlock_irqrestore (&tt->lock, flags);
768 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
770 /* If do_delay is false, return the number of milliseconds the caller
773 static unsigned hub_power_on(struct usb_hub *hub, bool do_delay)
776 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
778 u16 wHubCharacteristics =
779 le16_to_cpu(hub->descriptor->wHubCharacteristics);
781 /* Enable power on each port. Some hubs have reserved values
782 * of LPSM (> 2) in their descriptors, even though they are
783 * USB 2.0 hubs. Some hubs do not implement port-power switching
784 * but only emulate it. In all cases, the ports won't work
785 * unless we send these messages to the hub.
787 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
788 dev_dbg(hub->intfdev, "enabling power on all ports\n");
790 dev_dbg(hub->intfdev, "trying to enable port power on "
791 "non-switchable hub\n");
792 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
793 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
795 /* Wait at least 100 msec for power to become stable */
796 delay = max(pgood_delay, (unsigned) 100);
802 static int hub_hub_status(struct usb_hub *hub,
803 u16 *status, u16 *change)
807 mutex_lock(&hub->status_mutex);
808 ret = get_hub_status(hub->hdev, &hub->status->hub);
810 dev_err (hub->intfdev,
811 "%s failed (err = %d)\n", __func__, ret);
813 *status = le16_to_cpu(hub->status->hub.wHubStatus);
814 *change = le16_to_cpu(hub->status->hub.wHubChange);
817 mutex_unlock(&hub->status_mutex);
821 static int hub_set_port_link_state(struct usb_hub *hub, int port1,
822 unsigned int link_status)
824 return set_port_feature(hub->hdev,
825 port1 | (link_status << 3),
826 USB_PORT_FEAT_LINK_STATE);
830 * If USB 3.0 ports are placed into the Disabled state, they will no longer
831 * detect any device connects or disconnects. This is generally not what the
832 * USB core wants, since it expects a disabled port to produce a port status
833 * change event when a new device connects.
835 * Instead, set the link state to Disabled, wait for the link to settle into
836 * that state, clear any change bits, and then put the port into the RxDetect
839 static int hub_usb3_port_disable(struct usb_hub *hub, int port1)
843 u16 portchange, portstatus;
845 if (!hub_is_superspeed(hub->hdev))
848 ret = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_SS_DISABLED);
850 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
855 /* Wait for the link to enter the disabled state. */
856 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
857 ret = hub_port_status(hub, port1, &portstatus, &portchange);
861 if ((portstatus & USB_PORT_STAT_LINK_STATE) ==
862 USB_SS_PORT_LS_SS_DISABLED)
864 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
866 msleep(HUB_DEBOUNCE_STEP);
868 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
869 dev_warn(hub->intfdev, "Could not disable port %d after %d ms\n",
872 return hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_RX_DETECT);
875 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
877 struct usb_device *hdev = hub->hdev;
880 if (hub->ports[port1 - 1]->child && set_state)
881 usb_set_device_state(hub->ports[port1 - 1]->child,
882 USB_STATE_NOTATTACHED);
884 if (hub_is_superspeed(hub->hdev))
885 ret = hub_usb3_port_disable(hub, port1);
887 ret = clear_port_feature(hdev, port1,
888 USB_PORT_FEAT_ENABLE);
891 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
897 * Disable a port and mark a logical connect-change event, so that some
898 * time later khubd will disconnect() any existing usb_device on the port
899 * and will re-enumerate if there actually is a device attached.
901 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
903 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
904 hub_port_disable(hub, port1, 1);
906 /* FIXME let caller ask to power down the port:
907 * - some devices won't enumerate without a VBUS power cycle
908 * - SRP saves power that way
909 * - ... new call, TBD ...
910 * That's easy if this hub can switch power per-port, and
911 * khubd reactivates the port later (timer, SRP, etc).
912 * Powerdown must be optional, because of reset/DFU.
915 set_bit(port1, hub->change_bits);
920 * usb_remove_device - disable a device's port on its parent hub
921 * @udev: device to be disabled and removed
922 * Context: @udev locked, must be able to sleep.
924 * After @udev's port has been disabled, khubd is notified and it will
925 * see that the device has been disconnected. When the device is
926 * physically unplugged and something is plugged in, the events will
927 * be received and processed normally.
929 int usb_remove_device(struct usb_device *udev)
932 struct usb_interface *intf;
934 if (!udev->parent) /* Can't remove a root hub */
936 hub = hdev_to_hub(udev->parent);
937 intf = to_usb_interface(hub->intfdev);
939 usb_autopm_get_interface(intf);
940 set_bit(udev->portnum, hub->removed_bits);
941 hub_port_logical_disconnect(hub, udev->portnum);
942 usb_autopm_put_interface(intf);
946 enum hub_activation_type {
947 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
948 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
951 static void hub_init_func2(struct work_struct *ws);
952 static void hub_init_func3(struct work_struct *ws);
954 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
956 struct usb_device *hdev = hub->hdev;
961 bool need_debounce_delay = false;
964 /* Continue a partial initialization */
965 if (type == HUB_INIT2)
967 if (type == HUB_INIT3)
970 /* The superspeed hub except for root hub has to use Hub Depth
971 * value as an offset into the route string to locate the bits
972 * it uses to determine the downstream port number. So hub driver
973 * should send a set hub depth request to superspeed hub after
974 * the superspeed hub is set configuration in initialization or
977 * After a resume, port power should still be on.
978 * For any other type of activation, turn it on.
980 if (type != HUB_RESUME) {
981 if (hdev->parent && hub_is_superspeed(hdev)) {
982 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
983 HUB_SET_DEPTH, USB_RT_HUB,
984 hdev->level - 1, 0, NULL, 0,
985 USB_CTRL_SET_TIMEOUT);
987 dev_err(hub->intfdev,
988 "set hub depth failed\n");
991 /* Speed up system boot by using a delayed_work for the
992 * hub's initial power-up delays. This is pretty awkward
993 * and the implementation looks like a home-brewed sort of
994 * setjmp/longjmp, but it saves at least 100 ms for each
995 * root hub (assuming usbcore is compiled into the kernel
996 * rather than as a module). It adds up.
998 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
999 * because for those activation types the ports have to be
1000 * operational when we return. In theory this could be done
1001 * for HUB_POST_RESET, but it's easier not to.
1003 if (type == HUB_INIT) {
1004 delay = hub_power_on(hub, false);
1005 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func2);
1006 schedule_delayed_work(&hub->init_work,
1007 msecs_to_jiffies(delay));
1009 /* Suppress autosuspend until init is done */
1010 usb_autopm_get_interface_no_resume(
1011 to_usb_interface(hub->intfdev));
1012 return; /* Continues at init2: below */
1013 } else if (type == HUB_RESET_RESUME) {
1014 /* The internal host controller state for the hub device
1015 * may be gone after a host power loss on system resume.
1016 * Update the device's info so the HW knows it's a hub.
1018 hcd = bus_to_hcd(hdev->bus);
1019 if (hcd->driver->update_hub_device) {
1020 ret = hcd->driver->update_hub_device(hcd, hdev,
1021 &hub->tt, GFP_NOIO);
1023 dev_err(hub->intfdev, "Host not "
1024 "accepting hub info "
1026 dev_err(hub->intfdev, "LS/FS devices "
1027 "and hubs may not work "
1028 "under this hub\n.");
1031 hub_power_on(hub, true);
1033 hub_power_on(hub, true);
1038 /* Check each port and set hub->change_bits to let khubd know
1039 * which ports need attention.
1041 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
1042 struct usb_device *udev = hub->ports[port1 - 1]->child;
1043 u16 portstatus, portchange;
1045 portstatus = portchange = 0;
1046 status = hub_port_status(hub, port1, &portstatus, &portchange);
1047 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1048 dev_dbg(hub->intfdev,
1049 "port %d: status %04x change %04x\n",
1050 port1, portstatus, portchange);
1052 /* After anything other than HUB_RESUME (i.e., initialization
1053 * or any sort of reset), every port should be disabled.
1054 * Unconnected ports should likewise be disabled (paranoia),
1055 * and so should ports for which we have no usb_device.
1057 if ((portstatus & USB_PORT_STAT_ENABLE) && (
1058 type != HUB_RESUME ||
1059 !(portstatus & USB_PORT_STAT_CONNECTION) ||
1061 udev->state == USB_STATE_NOTATTACHED)) {
1063 * USB3 protocol ports will automatically transition
1064 * to Enabled state when detect an USB3.0 device attach.
1065 * Do not disable USB3 protocol ports.
1067 if (!hub_is_superspeed(hdev)) {
1068 clear_port_feature(hdev, port1,
1069 USB_PORT_FEAT_ENABLE);
1070 portstatus &= ~USB_PORT_STAT_ENABLE;
1072 /* Pretend that power was lost for USB3 devs */
1073 portstatus &= ~USB_PORT_STAT_ENABLE;
1077 /* Clear status-change flags; we'll debounce later */
1078 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1079 need_debounce_delay = true;
1080 clear_port_feature(hub->hdev, port1,
1081 USB_PORT_FEAT_C_CONNECTION);
1083 if (portchange & USB_PORT_STAT_C_ENABLE) {
1084 need_debounce_delay = true;
1085 clear_port_feature(hub->hdev, port1,
1086 USB_PORT_FEAT_C_ENABLE);
1088 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
1089 hub_is_superspeed(hub->hdev)) {
1090 need_debounce_delay = true;
1091 clear_port_feature(hub->hdev, port1,
1092 USB_PORT_FEAT_C_BH_PORT_RESET);
1094 /* We can forget about a "removed" device when there's a
1095 * physical disconnect or the connect status changes.
1097 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
1098 (portchange & USB_PORT_STAT_C_CONNECTION))
1099 clear_bit(port1, hub->removed_bits);
1101 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
1102 /* Tell khubd to disconnect the device or
1103 * check for a new connection
1105 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1106 set_bit(port1, hub->change_bits);
1108 } else if (portstatus & USB_PORT_STAT_ENABLE) {
1109 bool port_resumed = (portstatus &
1110 USB_PORT_STAT_LINK_STATE) ==
1112 /* The power session apparently survived the resume.
1113 * If there was an overcurrent or suspend change
1114 * (i.e., remote wakeup request), have khubd
1115 * take care of it. Look at the port link state
1116 * for USB 3.0 hubs, since they don't have a suspend
1117 * change bit, and they don't set the port link change
1118 * bit on device-initiated resume.
1120 if (portchange || (hub_is_superspeed(hub->hdev) &&
1122 set_bit(port1, hub->change_bits);
1124 } else if (udev->persist_enabled) {
1126 udev->reset_resume = 1;
1128 set_bit(port1, hub->change_bits);
1131 /* The power session is gone; tell khubd */
1132 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1133 set_bit(port1, hub->change_bits);
1137 /* If no port-status-change flags were set, we don't need any
1138 * debouncing. If flags were set we can try to debounce the
1139 * ports all at once right now, instead of letting khubd do them
1140 * one at a time later on.
1142 * If any port-status changes do occur during this delay, khubd
1143 * will see them later and handle them normally.
1145 if (need_debounce_delay) {
1146 delay = HUB_DEBOUNCE_STABLE;
1148 /* Don't do a long sleep inside a workqueue routine */
1149 if (type == HUB_INIT2) {
1150 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func3);
1151 schedule_delayed_work(&hub->init_work,
1152 msecs_to_jiffies(delay));
1153 return; /* Continues at init3: below */
1161 status = usb_submit_urb(hub->urb, GFP_NOIO);
1163 dev_err(hub->intfdev, "activate --> %d\n", status);
1164 if (hub->has_indicators && blinkenlights)
1165 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
1167 /* Scan all ports that need attention */
1170 /* Allow autosuspend if it was suppressed */
1171 if (type <= HUB_INIT3)
1172 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
1175 /* Implement the continuations for the delays above */
1176 static void hub_init_func2(struct work_struct *ws)
1178 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1180 hub_activate(hub, HUB_INIT2);
1183 static void hub_init_func3(struct work_struct *ws)
1185 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1187 hub_activate(hub, HUB_INIT3);
1190 enum hub_quiescing_type {
1191 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
1194 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
1196 struct usb_device *hdev = hub->hdev;
1199 cancel_delayed_work_sync(&hub->init_work);
1201 /* khubd and related activity won't re-trigger */
1204 if (type != HUB_SUSPEND) {
1205 /* Disconnect all the children */
1206 for (i = 0; i < hdev->maxchild; ++i) {
1207 if (hub->ports[i]->child)
1208 usb_disconnect(&hub->ports[i]->child);
1212 /* Stop khubd and related activity */
1213 usb_kill_urb(hub->urb);
1214 if (hub->has_indicators)
1215 cancel_delayed_work_sync(&hub->leds);
1217 flush_work(&hub->tt.clear_work);
1220 /* caller has locked the hub device */
1221 static int hub_pre_reset(struct usb_interface *intf)
1223 struct usb_hub *hub = usb_get_intfdata(intf);
1225 hub_quiesce(hub, HUB_PRE_RESET);
1229 /* caller has locked the hub device */
1230 static int hub_post_reset(struct usb_interface *intf)
1232 struct usb_hub *hub = usb_get_intfdata(intf);
1234 hub_activate(hub, HUB_POST_RESET);
1238 static int hub_configure(struct usb_hub *hub,
1239 struct usb_endpoint_descriptor *endpoint)
1241 struct usb_hcd *hcd;
1242 struct usb_device *hdev = hub->hdev;
1243 struct device *hub_dev = hub->intfdev;
1244 u16 hubstatus, hubchange;
1245 u16 wHubCharacteristics;
1248 char *message = "out of memory";
1252 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
1258 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1263 mutex_init(&hub->status_mutex);
1265 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1266 if (!hub->descriptor) {
1271 /* Request the entire hub descriptor.
1272 * hub->descriptor can handle USB_MAXCHILDREN ports,
1273 * but the hub can/will return fewer bytes here.
1275 ret = get_hub_descriptor(hdev, hub->descriptor);
1277 message = "can't read hub descriptor";
1279 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
1280 message = "hub has too many ports!";
1285 hdev->maxchild = hub->descriptor->bNbrPorts;
1286 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
1287 (hdev->maxchild == 1) ? "" : "s");
1289 hub->ports = kzalloc(hdev->maxchild * sizeof(struct usb_port *),
1296 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1297 if (hub_is_superspeed(hdev)) {
1305 /* FIXME for USB 3.0, skip for now */
1306 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1307 !(hub_is_superspeed(hdev))) {
1309 char portstr [USB_MAXCHILDREN + 1];
1311 for (i = 0; i < hdev->maxchild; i++)
1312 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1313 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1315 portstr[hdev->maxchild] = 0;
1316 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1318 dev_dbg(hub_dev, "standalone hub\n");
1320 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1321 case HUB_CHAR_COMMON_LPSM:
1322 dev_dbg(hub_dev, "ganged power switching\n");
1324 case HUB_CHAR_INDV_PORT_LPSM:
1325 dev_dbg(hub_dev, "individual port power switching\n");
1327 case HUB_CHAR_NO_LPSM:
1329 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1333 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1334 case HUB_CHAR_COMMON_OCPM:
1335 dev_dbg(hub_dev, "global over-current protection\n");
1337 case HUB_CHAR_INDV_PORT_OCPM:
1338 dev_dbg(hub_dev, "individual port over-current protection\n");
1340 case HUB_CHAR_NO_OCPM:
1342 dev_dbg(hub_dev, "no over-current protection\n");
1346 spin_lock_init (&hub->tt.lock);
1347 INIT_LIST_HEAD (&hub->tt.clear_list);
1348 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1349 switch (hdev->descriptor.bDeviceProtocol) {
1352 case USB_HUB_PR_HS_SINGLE_TT:
1353 dev_dbg(hub_dev, "Single TT\n");
1356 case USB_HUB_PR_HS_MULTI_TT:
1357 ret = usb_set_interface(hdev, 0, 1);
1359 dev_dbg(hub_dev, "TT per port\n");
1362 dev_err(hub_dev, "Using single TT (err %d)\n",
1367 /* USB 3.0 hubs don't have a TT */
1370 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1371 hdev->descriptor.bDeviceProtocol);
1375 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1376 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1377 case HUB_TTTT_8_BITS:
1378 if (hdev->descriptor.bDeviceProtocol != 0) {
1379 hub->tt.think_time = 666;
1380 dev_dbg(hub_dev, "TT requires at most %d "
1381 "FS bit times (%d ns)\n",
1382 8, hub->tt.think_time);
1385 case HUB_TTTT_16_BITS:
1386 hub->tt.think_time = 666 * 2;
1387 dev_dbg(hub_dev, "TT requires at most %d "
1388 "FS bit times (%d ns)\n",
1389 16, hub->tt.think_time);
1391 case HUB_TTTT_24_BITS:
1392 hub->tt.think_time = 666 * 3;
1393 dev_dbg(hub_dev, "TT requires at most %d "
1394 "FS bit times (%d ns)\n",
1395 24, hub->tt.think_time);
1397 case HUB_TTTT_32_BITS:
1398 hub->tt.think_time = 666 * 4;
1399 dev_dbg(hub_dev, "TT requires at most %d "
1400 "FS bit times (%d ns)\n",
1401 32, hub->tt.think_time);
1405 /* probe() zeroes hub->indicator[] */
1406 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1407 hub->has_indicators = 1;
1408 dev_dbg(hub_dev, "Port indicators are supported\n");
1411 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1412 hub->descriptor->bPwrOn2PwrGood * 2);
1414 /* power budgeting mostly matters with bus-powered hubs,
1415 * and battery-powered root hubs (may provide just 8 mA).
1417 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1419 message = "can't get hub status";
1422 le16_to_cpus(&hubstatus);
1423 hcd = bus_to_hcd(hdev->bus);
1424 if (hdev == hdev->bus->root_hub) {
1425 if (hcd->power_budget > 0)
1426 hdev->bus_mA = hcd->power_budget;
1428 hdev->bus_mA = full_load * hdev->maxchild;
1429 if (hdev->bus_mA >= full_load)
1430 hub->mA_per_port = full_load;
1432 hub->mA_per_port = hdev->bus_mA;
1433 hub->limited_power = 1;
1435 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1436 int remaining = hdev->bus_mA -
1437 hub->descriptor->bHubContrCurrent;
1439 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1440 hub->descriptor->bHubContrCurrent);
1441 hub->limited_power = 1;
1443 if (remaining < hdev->maxchild * unit_load)
1445 "insufficient power available "
1446 "to use all downstream ports\n");
1447 hub->mA_per_port = unit_load; /* 7.2.1 */
1449 } else { /* Self-powered external hub */
1450 /* FIXME: What about battery-powered external hubs that
1451 * provide less current per port? */
1452 hub->mA_per_port = full_load;
1454 if (hub->mA_per_port < full_load)
1455 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1458 /* Update the HCD's internal representation of this hub before khubd
1459 * starts getting port status changes for devices under the hub.
1461 if (hcd->driver->update_hub_device) {
1462 ret = hcd->driver->update_hub_device(hcd, hdev,
1463 &hub->tt, GFP_KERNEL);
1465 message = "can't update HCD hub info";
1470 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1472 message = "can't get hub status";
1476 /* local power status reports aren't always correct */
1477 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1478 dev_dbg(hub_dev, "local power source is %s\n",
1479 (hubstatus & HUB_STATUS_LOCAL_POWER)
1480 ? "lost (inactive)" : "good");
1482 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1483 dev_dbg(hub_dev, "%sover-current condition exists\n",
1484 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1486 /* set up the interrupt endpoint
1487 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1488 * bytes as USB2.0[11.12.3] says because some hubs are known
1489 * to send more data (and thus cause overflow). For root hubs,
1490 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1491 * to be big enough for at least USB_MAXCHILDREN ports. */
1492 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1493 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1495 if (maxp > sizeof(*hub->buffer))
1496 maxp = sizeof(*hub->buffer);
1498 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1504 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1505 hub, endpoint->bInterval);
1507 /* maybe cycle the hub leds */
1508 if (hub->has_indicators && blinkenlights)
1509 hub->indicator [0] = INDICATOR_CYCLE;
1511 for (i = 0; i < hdev->maxchild; i++)
1512 if (usb_hub_create_port_device(hub, i + 1) < 0)
1513 dev_err(hub->intfdev,
1514 "couldn't create port%d device.\n", i + 1);
1516 usb_hub_adjust_deviceremovable(hdev, hub->descriptor);
1518 hub_activate(hub, HUB_INIT);
1522 dev_err (hub_dev, "config failed, %s (err %d)\n",
1524 /* hub_disconnect() frees urb and descriptor */
1528 static void hub_release(struct kref *kref)
1530 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1532 usb_put_intf(to_usb_interface(hub->intfdev));
1536 static unsigned highspeed_hubs;
1538 static void hub_disconnect(struct usb_interface *intf)
1540 struct usb_hub *hub = usb_get_intfdata(intf);
1541 struct usb_device *hdev = interface_to_usbdev(intf);
1544 /* Take the hub off the event list and don't let it be added again */
1545 spin_lock_irq(&hub_event_lock);
1546 if (!list_empty(&hub->event_list)) {
1547 list_del_init(&hub->event_list);
1548 usb_autopm_put_interface_no_suspend(intf);
1550 hub->disconnected = 1;
1551 spin_unlock_irq(&hub_event_lock);
1553 /* Disconnect all children and quiesce the hub */
1555 hub_quiesce(hub, HUB_DISCONNECT);
1557 usb_set_intfdata (intf, NULL);
1559 for (i = 0; i < hdev->maxchild; i++)
1560 usb_hub_remove_port_device(hub, i + 1);
1561 hub->hdev->maxchild = 0;
1563 if (hub->hdev->speed == USB_SPEED_HIGH)
1566 usb_free_urb(hub->urb);
1568 kfree(hub->descriptor);
1572 kref_put(&hub->kref, hub_release);
1575 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1577 struct usb_host_interface *desc;
1578 struct usb_endpoint_descriptor *endpoint;
1579 struct usb_device *hdev;
1580 struct usb_hub *hub;
1582 desc = intf->cur_altsetting;
1583 hdev = interface_to_usbdev(intf);
1586 * Set default autosuspend delay as 0 to speedup bus suspend,
1587 * based on the below considerations:
1589 * - Unlike other drivers, the hub driver does not rely on the
1590 * autosuspend delay to provide enough time to handle a wakeup
1591 * event, and the submitted status URB is just to check future
1592 * change on hub downstream ports, so it is safe to do it.
1594 * - The patch might cause one or more auto supend/resume for
1595 * below very rare devices when they are plugged into hub
1598 * devices having trouble initializing, and disconnect
1599 * themselves from the bus and then reconnect a second
1602 * devices just for downloading firmware, and disconnects
1603 * themselves after completing it
1605 * For these quite rare devices, their drivers may change the
1606 * autosuspend delay of their parent hub in the probe() to one
1607 * appropriate value to avoid the subtle problem if someone
1610 * - The patch may cause one or more auto suspend/resume on
1611 * hub during running 'lsusb', but it is probably too
1612 * infrequent to worry about.
1614 * - Change autosuspend delay of hub can avoid unnecessary auto
1615 * suspend timer for hub, also may decrease power consumption
1618 pm_runtime_set_autosuspend_delay(&hdev->dev, 0);
1620 /* Hubs have proper suspend/resume support. */
1621 usb_enable_autosuspend(hdev);
1623 if (hdev->level == MAX_TOPO_LEVEL) {
1625 "Unsupported bus topology: hub nested too deep\n");
1629 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1631 dev_warn(&intf->dev, "ignoring external hub\n");
1636 /* Some hubs have a subclass of 1, which AFAICT according to the */
1637 /* specs is not defined, but it works */
1638 if ((desc->desc.bInterfaceSubClass != 0) &&
1639 (desc->desc.bInterfaceSubClass != 1)) {
1641 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1645 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1646 if (desc->desc.bNumEndpoints != 1)
1647 goto descriptor_error;
1649 endpoint = &desc->endpoint[0].desc;
1651 /* If it's not an interrupt in endpoint, we'd better punt! */
1652 if (!usb_endpoint_is_int_in(endpoint))
1653 goto descriptor_error;
1655 /* We found a hub */
1656 dev_info (&intf->dev, "USB hub found\n");
1658 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1660 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1664 kref_init(&hub->kref);
1665 INIT_LIST_HEAD(&hub->event_list);
1666 hub->intfdev = &intf->dev;
1668 INIT_DELAYED_WORK(&hub->leds, led_work);
1669 INIT_DELAYED_WORK(&hub->init_work, NULL);
1672 usb_set_intfdata (intf, hub);
1673 intf->needs_remote_wakeup = 1;
1675 if (hdev->speed == USB_SPEED_HIGH)
1678 if (id->driver_info & HUB_QUIRK_CHECK_PORT_AUTOSUSPEND)
1679 hub->quirk_check_port_auto_suspend = 1;
1681 if (hub_configure(hub, endpoint) >= 0)
1684 hub_disconnect (intf);
1689 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1691 struct usb_device *hdev = interface_to_usbdev (intf);
1692 struct usb_hub *hub = hdev_to_hub(hdev);
1694 /* assert ifno == 0 (part of hub spec) */
1696 case USBDEVFS_HUB_PORTINFO: {
1697 struct usbdevfs_hub_portinfo *info = user_data;
1700 spin_lock_irq(&device_state_lock);
1701 if (hdev->devnum <= 0)
1704 info->nports = hdev->maxchild;
1705 for (i = 0; i < info->nports; i++) {
1706 if (hub->ports[i]->child == NULL)
1710 hub->ports[i]->child->devnum;
1713 spin_unlock_irq(&device_state_lock);
1715 return info->nports + 1;
1724 * Allow user programs to claim ports on a hub. When a device is attached
1725 * to one of these "claimed" ports, the program will "own" the device.
1727 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1728 struct dev_state ***ppowner)
1730 if (hdev->state == USB_STATE_NOTATTACHED)
1732 if (port1 == 0 || port1 > hdev->maxchild)
1735 /* This assumes that devices not managed by the hub driver
1736 * will always have maxchild equal to 0.
1738 *ppowner = &(hdev_to_hub(hdev)->ports[port1 - 1]->port_owner);
1742 /* In the following three functions, the caller must hold hdev's lock */
1743 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
1744 struct dev_state *owner)
1747 struct dev_state **powner;
1749 rc = find_port_owner(hdev, port1, &powner);
1758 int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
1759 struct dev_state *owner)
1762 struct dev_state **powner;
1764 rc = find_port_owner(hdev, port1, &powner);
1767 if (*powner != owner)
1773 void usb_hub_release_all_ports(struct usb_device *hdev, struct dev_state *owner)
1775 struct usb_hub *hub = hdev_to_hub(hdev);
1778 for (n = 0; n < hdev->maxchild; n++) {
1779 if (hub->ports[n]->port_owner == owner)
1780 hub->ports[n]->port_owner = NULL;
1785 /* The caller must hold udev's lock */
1786 bool usb_device_is_owned(struct usb_device *udev)
1788 struct usb_hub *hub;
1790 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1792 hub = hdev_to_hub(udev->parent);
1793 return !!hub->ports[udev->portnum - 1]->port_owner;
1796 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1798 struct usb_hub *hub = hdev_to_hub(udev);
1801 for (i = 0; i < udev->maxchild; ++i) {
1802 if (hub->ports[i]->child)
1803 recursively_mark_NOTATTACHED(hub->ports[i]->child);
1805 if (udev->state == USB_STATE_SUSPENDED)
1806 udev->active_duration -= jiffies;
1807 udev->state = USB_STATE_NOTATTACHED;
1811 * usb_set_device_state - change a device's current state (usbcore, hcds)
1812 * @udev: pointer to device whose state should be changed
1813 * @new_state: new state value to be stored
1815 * udev->state is _not_ fully protected by the device lock. Although
1816 * most transitions are made only while holding the lock, the state can
1817 * can change to USB_STATE_NOTATTACHED at almost any time. This
1818 * is so that devices can be marked as disconnected as soon as possible,
1819 * without having to wait for any semaphores to be released. As a result,
1820 * all changes to any device's state must be protected by the
1821 * device_state_lock spinlock.
1823 * Once a device has been added to the device tree, all changes to its state
1824 * should be made using this routine. The state should _not_ be set directly.
1826 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1827 * Otherwise udev->state is set to new_state, and if new_state is
1828 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1829 * to USB_STATE_NOTATTACHED.
1831 void usb_set_device_state(struct usb_device *udev,
1832 enum usb_device_state new_state)
1834 unsigned long flags;
1837 spin_lock_irqsave(&device_state_lock, flags);
1838 if (udev->state == USB_STATE_NOTATTACHED)
1840 else if (new_state != USB_STATE_NOTATTACHED) {
1842 /* root hub wakeup capabilities are managed out-of-band
1843 * and may involve silicon errata ... ignore them here.
1846 if (udev->state == USB_STATE_SUSPENDED
1847 || new_state == USB_STATE_SUSPENDED)
1848 ; /* No change to wakeup settings */
1849 else if (new_state == USB_STATE_CONFIGURED)
1850 wakeup = udev->actconfig->desc.bmAttributes
1851 & USB_CONFIG_ATT_WAKEUP;
1855 if (udev->state == USB_STATE_SUSPENDED &&
1856 new_state != USB_STATE_SUSPENDED)
1857 udev->active_duration -= jiffies;
1858 else if (new_state == USB_STATE_SUSPENDED &&
1859 udev->state != USB_STATE_SUSPENDED)
1860 udev->active_duration += jiffies;
1861 udev->state = new_state;
1863 recursively_mark_NOTATTACHED(udev);
1864 spin_unlock_irqrestore(&device_state_lock, flags);
1866 device_set_wakeup_capable(&udev->dev, wakeup);
1868 EXPORT_SYMBOL_GPL(usb_set_device_state);
1871 * Choose a device number.
1873 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1874 * USB-2.0 buses they are also used as device addresses, however on
1875 * USB-3.0 buses the address is assigned by the controller hardware
1876 * and it usually is not the same as the device number.
1878 * WUSB devices are simple: they have no hubs behind, so the mapping
1879 * device <-> virtual port number becomes 1:1. Why? to simplify the
1880 * life of the device connection logic in
1881 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1882 * handshake we need to assign a temporary address in the unauthorized
1883 * space. For simplicity we use the first virtual port number found to
1884 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1885 * and that becomes it's address [X < 128] or its unauthorized address
1888 * We add 1 as an offset to the one-based USB-stack port number
1889 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1890 * 0 is reserved by USB for default address; (b) Linux's USB stack
1891 * uses always #1 for the root hub of the controller. So USB stack's
1892 * port #1, which is wusb virtual-port #0 has address #2.
1894 * Devices connected under xHCI are not as simple. The host controller
1895 * supports virtualization, so the hardware assigns device addresses and
1896 * the HCD must setup data structures before issuing a set address
1897 * command to the hardware.
1899 static void choose_devnum(struct usb_device *udev)
1902 struct usb_bus *bus = udev->bus;
1904 /* If khubd ever becomes multithreaded, this will need a lock */
1906 devnum = udev->portnum + 1;
1907 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
1909 /* Try to allocate the next devnum beginning at
1910 * bus->devnum_next. */
1911 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1914 devnum = find_next_zero_bit(bus->devmap.devicemap,
1916 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1919 set_bit(devnum, bus->devmap.devicemap);
1920 udev->devnum = devnum;
1924 static void release_devnum(struct usb_device *udev)
1926 if (udev->devnum > 0) {
1927 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1932 static void update_devnum(struct usb_device *udev, int devnum)
1934 /* The address for a WUSB device is managed by wusbcore. */
1936 udev->devnum = devnum;
1939 static void hub_free_dev(struct usb_device *udev)
1941 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1943 /* Root hubs aren't real devices, so don't free HCD resources */
1944 if (hcd->driver->free_dev && udev->parent)
1945 hcd->driver->free_dev(hcd, udev);
1949 * usb_disconnect - disconnect a device (usbcore-internal)
1950 * @pdev: pointer to device being disconnected
1951 * Context: !in_interrupt ()
1953 * Something got disconnected. Get rid of it and all of its children.
1955 * If *pdev is a normal device then the parent hub must already be locked.
1956 * If *pdev is a root hub then this routine will acquire the
1957 * usb_bus_list_lock on behalf of the caller.
1959 * Only hub drivers (including virtual root hub drivers for host
1960 * controllers) should ever call this.
1962 * This call is synchronous, and may not be used in an interrupt context.
1964 void usb_disconnect(struct usb_device **pdev)
1966 struct usb_device *udev = *pdev;
1967 struct usb_hub *hub = hdev_to_hub(udev);
1970 /* mark the device as inactive, so any further urb submissions for
1971 * this device (and any of its children) will fail immediately.
1972 * this quiesces everything except pending urbs.
1974 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1975 dev_info(&udev->dev, "USB disconnect, device number %d\n",
1978 usb_lock_device(udev);
1980 /* Free up all the children before we remove this device */
1981 for (i = 0; i < udev->maxchild; i++) {
1982 if (hub->ports[i]->child)
1983 usb_disconnect(&hub->ports[i]->child);
1986 /* deallocate hcd/hardware state ... nuking all pending urbs and
1987 * cleaning up all state associated with the current configuration
1988 * so that the hardware is now fully quiesced.
1990 dev_dbg (&udev->dev, "unregistering device\n");
1991 usb_disable_device(udev, 0);
1992 usb_hcd_synchronize_unlinks(udev);
1995 struct usb_port *port_dev =
1996 hdev_to_hub(udev->parent)->ports[udev->portnum - 1];
1998 sysfs_remove_link(&udev->dev.kobj, "port");
1999 sysfs_remove_link(&port_dev->dev.kobj, "device");
2002 usb_remove_ep_devs(&udev->ep0);
2003 usb_unlock_device(udev);
2005 /* Unregister the device. The device driver is responsible
2006 * for de-configuring the device and invoking the remove-device
2007 * notifier chain (used by usbfs and possibly others).
2009 device_del(&udev->dev);
2011 /* Free the device number and delete the parent's children[]
2012 * (or root_hub) pointer.
2014 release_devnum(udev);
2016 /* Avoid races with recursively_mark_NOTATTACHED() */
2017 spin_lock_irq(&device_state_lock);
2019 spin_unlock_irq(&device_state_lock);
2023 put_device(&udev->dev);
2026 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2027 static void show_string(struct usb_device *udev, char *id, char *string)
2031 dev_info(&udev->dev, "%s: %s\n", id, string);
2034 static void announce_device(struct usb_device *udev)
2036 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2037 le16_to_cpu(udev->descriptor.idVendor),
2038 le16_to_cpu(udev->descriptor.idProduct));
2039 dev_info(&udev->dev,
2040 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2041 udev->descriptor.iManufacturer,
2042 udev->descriptor.iProduct,
2043 udev->descriptor.iSerialNumber);
2044 show_string(udev, "Product", udev->product);
2045 show_string(udev, "Manufacturer", udev->manufacturer);
2046 show_string(udev, "SerialNumber", udev->serial);
2049 static inline void announce_device(struct usb_device *udev) { }
2052 #ifdef CONFIG_USB_OTG
2053 #include "otg_whitelist.h"
2057 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2058 * @udev: newly addressed device (in ADDRESS state)
2060 * Finish enumeration for On-The-Go devices
2062 static int usb_enumerate_device_otg(struct usb_device *udev)
2066 #ifdef CONFIG_USB_OTG
2068 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2069 * to wake us after we've powered off VBUS; and HNP, switching roles
2070 * "host" to "peripheral". The OTG descriptor helps figure this out.
2072 if (!udev->bus->is_b_host
2074 && udev->parent == udev->bus->root_hub) {
2075 struct usb_otg_descriptor *desc = NULL;
2076 struct usb_bus *bus = udev->bus;
2078 /* descriptor may appear anywhere in config */
2079 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
2080 le16_to_cpu(udev->config[0].desc.wTotalLength),
2081 USB_DT_OTG, (void **) &desc) == 0) {
2082 if (desc->bmAttributes & USB_OTG_HNP) {
2083 unsigned port1 = udev->portnum;
2085 dev_info(&udev->dev,
2086 "Dual-Role OTG device on %sHNP port\n",
2087 (port1 == bus->otg_port)
2090 /* enable HNP before suspend, it's simpler */
2091 if (port1 == bus->otg_port)
2092 bus->b_hnp_enable = 1;
2093 err = usb_control_msg(udev,
2094 usb_sndctrlpipe(udev, 0),
2095 USB_REQ_SET_FEATURE, 0,
2097 ? USB_DEVICE_B_HNP_ENABLE
2098 : USB_DEVICE_A_ALT_HNP_SUPPORT,
2099 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
2101 /* OTG MESSAGE: report errors here,
2102 * customize to match your product.
2104 dev_info(&udev->dev,
2105 "can't set HNP mode: %d\n",
2107 bus->b_hnp_enable = 0;
2113 if (!is_targeted(udev)) {
2115 /* Maybe it can talk to us, though we can't talk to it.
2116 * (Includes HNP test device.)
2118 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
2119 err = usb_port_suspend(udev, PMSG_SUSPEND);
2121 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
2133 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2134 * @udev: newly addressed device (in ADDRESS state)
2136 * This is only called by usb_new_device() and usb_authorize_device()
2137 * and FIXME -- all comments that apply to them apply here wrt to
2140 * If the device is WUSB and not authorized, we don't attempt to read
2141 * the string descriptors, as they will be errored out by the device
2142 * until it has been authorized.
2144 static int usb_enumerate_device(struct usb_device *udev)
2148 if (udev->config == NULL) {
2149 err = usb_get_configuration(udev);
2151 dev_err(&udev->dev, "can't read configurations, error %d\n",
2156 if (udev->wusb == 1 && udev->authorized == 0) {
2157 udev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2158 udev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2159 udev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2162 /* read the standard strings and cache them if present */
2163 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
2164 udev->manufacturer = usb_cache_string(udev,
2165 udev->descriptor.iManufacturer);
2166 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
2168 err = usb_enumerate_device_otg(udev);
2172 usb_detect_interface_quirks(udev);
2177 static void set_usb_port_removable(struct usb_device *udev)
2179 struct usb_device *hdev = udev->parent;
2180 struct usb_hub *hub;
2181 u8 port = udev->portnum;
2182 u16 wHubCharacteristics;
2183 bool removable = true;
2188 hub = hdev_to_hub(udev->parent);
2190 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2192 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
2195 if (hub_is_superspeed(hdev)) {
2196 if (le16_to_cpu(hub->descriptor->u.ss.DeviceRemovable)
2200 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
2205 udev->removable = USB_DEVICE_REMOVABLE;
2207 udev->removable = USB_DEVICE_FIXED;
2211 * usb_new_device - perform initial device setup (usbcore-internal)
2212 * @udev: newly addressed device (in ADDRESS state)
2214 * This is called with devices which have been detected but not fully
2215 * enumerated. The device descriptor is available, but not descriptors
2216 * for any device configuration. The caller must have locked either
2217 * the parent hub (if udev is a normal device) or else the
2218 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
2219 * udev has already been installed, but udev is not yet visible through
2220 * sysfs or other filesystem code.
2222 * It will return if the device is configured properly or not. Zero if
2223 * the interface was registered with the driver core; else a negative
2226 * This call is synchronous, and may not be used in an interrupt context.
2228 * Only the hub driver or root-hub registrar should ever call this.
2230 int usb_new_device(struct usb_device *udev)
2235 /* Initialize non-root-hub device wakeup to disabled;
2236 * device (un)configuration controls wakeup capable
2237 * sysfs power/wakeup controls wakeup enabled/disabled
2239 device_init_wakeup(&udev->dev, 0);
2242 /* Tell the runtime-PM framework the device is active */
2243 pm_runtime_set_active(&udev->dev);
2244 pm_runtime_get_noresume(&udev->dev);
2245 pm_runtime_use_autosuspend(&udev->dev);
2246 pm_runtime_enable(&udev->dev);
2248 /* By default, forbid autosuspend for all devices. It will be
2249 * allowed for hubs during binding.
2251 usb_disable_autosuspend(udev);
2253 err = usb_enumerate_device(udev); /* Read descriptors */
2256 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
2257 udev->devnum, udev->bus->busnum,
2258 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2259 /* export the usbdev device-node for libusb */
2260 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
2261 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2263 /* Tell the world! */
2264 announce_device(udev);
2267 add_device_randomness(udev->serial, strlen(udev->serial));
2269 add_device_randomness(udev->product, strlen(udev->product));
2270 if (udev->manufacturer)
2271 add_device_randomness(udev->manufacturer,
2272 strlen(udev->manufacturer));
2274 device_enable_async_suspend(&udev->dev);
2277 * check whether the hub marks this port as non-removable. Do it
2278 * now so that platform-specific data can override it in
2282 set_usb_port_removable(udev);
2284 /* Register the device. The device driver is responsible
2285 * for configuring the device and invoking the add-device
2286 * notifier chain (used by usbfs and possibly others).
2288 err = device_add(&udev->dev);
2290 dev_err(&udev->dev, "can't device_add, error %d\n", err);
2294 /* Create link files between child device and usb port device. */
2296 struct usb_port *port_dev =
2297 hdev_to_hub(udev->parent)->ports[udev->portnum - 1];
2299 err = sysfs_create_link(&udev->dev.kobj,
2300 &port_dev->dev.kobj, "port");
2304 err = sysfs_create_link(&port_dev->dev.kobj,
2305 &udev->dev.kobj, "device");
2307 sysfs_remove_link(&udev->dev.kobj, "port");
2312 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
2313 usb_mark_last_busy(udev);
2314 pm_runtime_put_sync_autosuspend(&udev->dev);
2318 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2319 pm_runtime_disable(&udev->dev);
2320 pm_runtime_set_suspended(&udev->dev);
2326 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2327 * @usb_dev: USB device
2329 * Move the USB device to a very basic state where interfaces are disabled
2330 * and the device is in fact unconfigured and unusable.
2332 * We share a lock (that we have) with device_del(), so we need to
2335 int usb_deauthorize_device(struct usb_device *usb_dev)
2337 usb_lock_device(usb_dev);
2338 if (usb_dev->authorized == 0)
2339 goto out_unauthorized;
2341 usb_dev->authorized = 0;
2342 usb_set_configuration(usb_dev, -1);
2344 kfree(usb_dev->product);
2345 usb_dev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2346 kfree(usb_dev->manufacturer);
2347 usb_dev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2348 kfree(usb_dev->serial);
2349 usb_dev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2351 usb_destroy_configuration(usb_dev);
2352 usb_dev->descriptor.bNumConfigurations = 0;
2355 usb_unlock_device(usb_dev);
2360 int usb_authorize_device(struct usb_device *usb_dev)
2364 usb_lock_device(usb_dev);
2365 if (usb_dev->authorized == 1)
2366 goto out_authorized;
2368 result = usb_autoresume_device(usb_dev);
2370 dev_err(&usb_dev->dev,
2371 "can't autoresume for authorization: %d\n", result);
2372 goto error_autoresume;
2374 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2376 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2377 "authorization: %d\n", result);
2378 goto error_device_descriptor;
2381 kfree(usb_dev->product);
2382 usb_dev->product = NULL;
2383 kfree(usb_dev->manufacturer);
2384 usb_dev->manufacturer = NULL;
2385 kfree(usb_dev->serial);
2386 usb_dev->serial = NULL;
2388 usb_dev->authorized = 1;
2389 result = usb_enumerate_device(usb_dev);
2391 goto error_enumerate;
2392 /* Choose and set the configuration. This registers the interfaces
2393 * with the driver core and lets interface drivers bind to them.
2395 c = usb_choose_configuration(usb_dev);
2397 result = usb_set_configuration(usb_dev, c);
2399 dev_err(&usb_dev->dev,
2400 "can't set config #%d, error %d\n", c, result);
2401 /* This need not be fatal. The user can try to
2402 * set other configurations. */
2405 dev_info(&usb_dev->dev, "authorized to connect\n");
2408 error_device_descriptor:
2409 usb_autosuspend_device(usb_dev);
2412 usb_unlock_device(usb_dev); // complements locktree
2417 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2418 static unsigned hub_is_wusb(struct usb_hub *hub)
2420 struct usb_hcd *hcd;
2421 if (hub->hdev->parent != NULL) /* not a root hub? */
2423 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
2424 return hcd->wireless;
2428 #define PORT_RESET_TRIES 5
2429 #define SET_ADDRESS_TRIES 2
2430 #define GET_DESCRIPTOR_TRIES 2
2431 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2432 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2434 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2435 #define HUB_SHORT_RESET_TIME 10
2436 #define HUB_BH_RESET_TIME 50
2437 #define HUB_LONG_RESET_TIME 200
2438 #define HUB_RESET_TIMEOUT 800
2440 static int hub_port_reset(struct usb_hub *hub, int port1,
2441 struct usb_device *udev, unsigned int delay, bool warm);
2443 /* Is a USB 3.0 port in the Inactive or Complinance Mode state?
2444 * Port worm reset is required to recover
2446 static bool hub_port_warm_reset_required(struct usb_hub *hub, u16 portstatus)
2448 return hub_is_superspeed(hub->hdev) &&
2449 (((portstatus & USB_PORT_STAT_LINK_STATE) ==
2450 USB_SS_PORT_LS_SS_INACTIVE) ||
2451 ((portstatus & USB_PORT_STAT_LINK_STATE) ==
2452 USB_SS_PORT_LS_COMP_MOD)) ;
2455 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2456 struct usb_device *udev, unsigned int delay, bool warm)
2458 int delay_time, ret;
2462 for (delay_time = 0;
2463 delay_time < HUB_RESET_TIMEOUT;
2464 delay_time += delay) {
2465 /* wait to give the device a chance to reset */
2468 /* read and decode port status */
2469 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2473 /* The port state is unknown until the reset completes. */
2474 if (!(portstatus & USB_PORT_STAT_RESET))
2477 /* switch to the long delay after two short delay failures */
2478 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2479 delay = HUB_LONG_RESET_TIME;
2481 dev_dbg (hub->intfdev,
2482 "port %d not %sreset yet, waiting %dms\n",
2483 port1, warm ? "warm " : "", delay);
2486 if ((portstatus & USB_PORT_STAT_RESET))
2489 if (hub_port_warm_reset_required(hub, portstatus))
2492 /* Device went away? */
2493 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2496 /* bomb out completely if the connection bounced. A USB 3.0
2497 * connection may bounce if multiple warm resets were issued,
2498 * but the device may have successfully re-connected. Ignore it.
2500 if (!hub_is_superspeed(hub->hdev) &&
2501 (portchange & USB_PORT_STAT_C_CONNECTION))
2504 if (!(portstatus & USB_PORT_STAT_ENABLE))
2510 if (hub_is_wusb(hub))
2511 udev->speed = USB_SPEED_WIRELESS;
2512 else if (hub_is_superspeed(hub->hdev))
2513 udev->speed = USB_SPEED_SUPER;
2514 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2515 udev->speed = USB_SPEED_HIGH;
2516 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2517 udev->speed = USB_SPEED_LOW;
2519 udev->speed = USB_SPEED_FULL;
2523 static void hub_port_finish_reset(struct usb_hub *hub, int port1,
2524 struct usb_device *udev, int *status)
2528 /* TRSTRCY = 10 ms; plus some extra */
2531 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2533 update_devnum(udev, 0);
2534 /* The xHC may think the device is already reset,
2535 * so ignore the status.
2537 if (hcd->driver->reset_device)
2538 hcd->driver->reset_device(hcd, udev);
2543 clear_port_feature(hub->hdev,
2544 port1, USB_PORT_FEAT_C_RESET);
2545 if (hub_is_superspeed(hub->hdev)) {
2546 clear_port_feature(hub->hdev, port1,
2547 USB_PORT_FEAT_C_BH_PORT_RESET);
2548 clear_port_feature(hub->hdev, port1,
2549 USB_PORT_FEAT_C_PORT_LINK_STATE);
2550 clear_port_feature(hub->hdev, port1,
2551 USB_PORT_FEAT_C_CONNECTION);
2554 usb_set_device_state(udev, *status
2555 ? USB_STATE_NOTATTACHED
2556 : USB_STATE_DEFAULT);
2561 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2562 static int hub_port_reset(struct usb_hub *hub, int port1,
2563 struct usb_device *udev, unsigned int delay, bool warm)
2566 u16 portchange, portstatus;
2568 if (!hub_is_superspeed(hub->hdev)) {
2570 dev_err(hub->intfdev, "only USB3 hub support "
2574 /* Block EHCI CF initialization during the port reset.
2575 * Some companion controllers don't like it when they mix.
2577 down_read(&ehci_cf_port_reset_rwsem);
2580 * If the caller hasn't explicitly requested a warm reset,
2581 * double check and see if one is needed.
2583 status = hub_port_status(hub, port1,
2584 &portstatus, &portchange);
2588 if (hub_port_warm_reset_required(hub, portstatus))
2592 /* Reset the port */
2593 for (i = 0; i < PORT_RESET_TRIES; i++) {
2594 status = set_port_feature(hub->hdev, port1, (warm ?
2595 USB_PORT_FEAT_BH_PORT_RESET :
2596 USB_PORT_FEAT_RESET));
2598 dev_err(hub->intfdev,
2599 "cannot %sreset port %d (err = %d)\n",
2600 warm ? "warm " : "", port1, status);
2602 status = hub_port_wait_reset(hub, port1, udev, delay,
2604 if (status && status != -ENOTCONN)
2605 dev_dbg(hub->intfdev,
2606 "port_wait_reset: err = %d\n",
2610 /* Check for disconnect or reset */
2611 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2612 hub_port_finish_reset(hub, port1, udev, &status);
2614 if (!hub_is_superspeed(hub->hdev))
2618 * If a USB 3.0 device migrates from reset to an error
2619 * state, re-issue the warm reset.
2621 if (hub_port_status(hub, port1,
2622 &portstatus, &portchange) < 0)
2625 if (!hub_port_warm_reset_required(hub, portstatus))
2629 * If the port is in SS.Inactive or Compliance Mode, the
2630 * hot or warm reset failed. Try another warm reset.
2633 dev_dbg(hub->intfdev, "hot reset failed, warm reset port %d\n",
2639 dev_dbg (hub->intfdev,
2640 "port %d not enabled, trying %sreset again...\n",
2641 port1, warm ? "warm " : "");
2642 delay = HUB_LONG_RESET_TIME;
2645 dev_err (hub->intfdev,
2646 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2650 if (!hub_is_superspeed(hub->hdev))
2651 up_read(&ehci_cf_port_reset_rwsem);
2656 /* Check if a port is power on */
2657 static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2661 if (hub_is_superspeed(hub->hdev)) {
2662 if (portstatus & USB_SS_PORT_STAT_POWER)
2665 if (portstatus & USB_PORT_STAT_POWER)
2674 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2675 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
2679 if (hub_is_superspeed(hub->hdev)) {
2680 if ((portstatus & USB_PORT_STAT_LINK_STATE)
2681 == USB_SS_PORT_LS_U3)
2684 if (portstatus & USB_PORT_STAT_SUSPEND)
2691 /* Determine whether the device on a port is ready for a normal resume,
2692 * is ready for a reset-resume, or should be disconnected.
2694 static int check_port_resume_type(struct usb_device *udev,
2695 struct usb_hub *hub, int port1,
2696 int status, unsigned portchange, unsigned portstatus)
2698 /* Is the device still present? */
2699 if (status || port_is_suspended(hub, portstatus) ||
2700 !port_is_power_on(hub, portstatus) ||
2701 !(portstatus & USB_PORT_STAT_CONNECTION)) {
2706 /* Can't do a normal resume if the port isn't enabled,
2707 * so try a reset-resume instead.
2709 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2710 if (udev->persist_enabled)
2711 udev->reset_resume = 1;
2717 dev_dbg(hub->intfdev,
2718 "port %d status %04x.%04x after resume, %d\n",
2719 port1, portchange, portstatus, status);
2720 } else if (udev->reset_resume) {
2722 /* Late port handoff can set status-change bits */
2723 if (portchange & USB_PORT_STAT_C_CONNECTION)
2724 clear_port_feature(hub->hdev, port1,
2725 USB_PORT_FEAT_C_CONNECTION);
2726 if (portchange & USB_PORT_STAT_C_ENABLE)
2727 clear_port_feature(hub->hdev, port1,
2728 USB_PORT_FEAT_C_ENABLE);
2734 int usb_disable_ltm(struct usb_device *udev)
2736 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2738 /* Check if the roothub and device supports LTM. */
2739 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
2740 !usb_device_supports_ltm(udev))
2743 /* Clear Feature LTM Enable can only be sent if the device is
2746 if (!udev->actconfig)
2749 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2750 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2751 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
2752 USB_CTRL_SET_TIMEOUT);
2754 EXPORT_SYMBOL_GPL(usb_disable_ltm);
2756 void usb_enable_ltm(struct usb_device *udev)
2758 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2760 /* Check if the roothub and device supports LTM. */
2761 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
2762 !usb_device_supports_ltm(udev))
2765 /* Set Feature LTM Enable can only be sent if the device is
2768 if (!udev->actconfig)
2771 usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2772 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2773 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
2774 USB_CTRL_SET_TIMEOUT);
2776 EXPORT_SYMBOL_GPL(usb_enable_ltm);
2778 #ifdef CONFIG_USB_SUSPEND
2781 * usb_port_suspend - suspend a usb device's upstream port
2782 * @udev: device that's no longer in active use, not a root hub
2783 * Context: must be able to sleep; device not locked; pm locks held
2785 * Suspends a USB device that isn't in active use, conserving power.
2786 * Devices may wake out of a suspend, if anything important happens,
2787 * using the remote wakeup mechanism. They may also be taken out of
2788 * suspend by the host, using usb_port_resume(). It's also routine
2789 * to disconnect devices while they are suspended.
2791 * This only affects the USB hardware for a device; its interfaces
2792 * (and, for hubs, child devices) must already have been suspended.
2794 * Selective port suspend reduces power; most suspended devices draw
2795 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2796 * All devices below the suspended port are also suspended.
2798 * Devices leave suspend state when the host wakes them up. Some devices
2799 * also support "remote wakeup", where the device can activate the USB
2800 * tree above them to deliver data, such as a keypress or packet. In
2801 * some cases, this wakes the USB host.
2803 * Suspending OTG devices may trigger HNP, if that's been enabled
2804 * between a pair of dual-role devices. That will change roles, such
2805 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2807 * Devices on USB hub ports have only one "suspend" state, corresponding
2808 * to ACPI D2, "may cause the device to lose some context".
2809 * State transitions include:
2811 * - suspend, resume ... when the VBUS power link stays live
2812 * - suspend, disconnect ... VBUS lost
2814 * Once VBUS drop breaks the circuit, the port it's using has to go through
2815 * normal re-enumeration procedures, starting with enabling VBUS power.
2816 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2817 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2818 * timer, no SRP, no requests through sysfs.
2820 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
2821 * the root hub for their bus goes into global suspend ... so we don't
2822 * (falsely) update the device power state to say it suspended.
2824 * Returns 0 on success, else negative errno.
2826 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2828 struct usb_hub *hub = hdev_to_hub(udev->parent);
2829 int port1 = udev->portnum;
2832 /* enable remote wakeup when appropriate; this lets the device
2833 * wake up the upstream hub (including maybe the root hub).
2835 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2836 * we don't explicitly enable it here.
2838 if (udev->do_remote_wakeup) {
2839 if (!hub_is_superspeed(hub->hdev)) {
2840 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2841 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2842 USB_DEVICE_REMOTE_WAKEUP, 0,
2844 USB_CTRL_SET_TIMEOUT);
2846 /* Assume there's only one function on the USB 3.0
2847 * device and enable remote wake for the first
2848 * interface. FIXME if the interface association
2849 * descriptor shows there's more than one function.
2851 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2852 USB_REQ_SET_FEATURE,
2853 USB_RECIP_INTERFACE,
2854 USB_INTRF_FUNC_SUSPEND,
2855 USB_INTRF_FUNC_SUSPEND_RW |
2856 USB_INTRF_FUNC_SUSPEND_LP,
2858 USB_CTRL_SET_TIMEOUT);
2861 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
2863 /* bail if autosuspend is requested */
2864 if (PMSG_IS_AUTO(msg))
2869 /* disable USB2 hardware LPM */
2870 if (udev->usb2_hw_lpm_enabled == 1)
2871 usb_set_usb2_hardware_lpm(udev, 0);
2873 if (usb_disable_ltm(udev)) {
2874 dev_err(&udev->dev, "%s Failed to disable LTM before suspend\n.",
2878 if (usb_unlocked_disable_lpm(udev)) {
2879 dev_err(&udev->dev, "%s Failed to disable LPM before suspend\n.",
2885 if (hub_is_superspeed(hub->hdev))
2886 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U3);
2888 status = set_port_feature(hub->hdev, port1,
2889 USB_PORT_FEAT_SUSPEND);
2891 dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
2893 /* paranoia: "should not happen" */
2894 if (udev->do_remote_wakeup)
2895 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2896 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2897 USB_DEVICE_REMOTE_WAKEUP, 0,
2899 USB_CTRL_SET_TIMEOUT);
2901 /* Try to enable USB2 hardware LPM again */
2902 if (udev->usb2_hw_lpm_capable == 1)
2903 usb_set_usb2_hardware_lpm(udev, 1);
2905 /* Try to enable USB3 LTM and LPM again */
2906 usb_enable_ltm(udev);
2907 usb_unlocked_enable_lpm(udev);
2909 /* System sleep transitions should never fail */
2910 if (!PMSG_IS_AUTO(msg))
2913 /* device has up to 10 msec to fully suspend */
2914 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
2915 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
2916 udev->do_remote_wakeup);
2917 usb_set_device_state(udev, USB_STATE_SUSPENDED);
2918 udev->port_is_suspended = 1;
2921 usb_mark_last_busy(hub->hdev);
2926 * If the USB "suspend" state is in use (rather than "global suspend"),
2927 * many devices will be individually taken out of suspend state using
2928 * special "resume" signaling. This routine kicks in shortly after
2929 * hardware resume signaling is finished, either because of selective
2930 * resume (by host) or remote wakeup (by device) ... now see what changed
2931 * in the tree that's rooted at this device.
2933 * If @udev->reset_resume is set then the device is reset before the
2934 * status check is done.
2936 static int finish_port_resume(struct usb_device *udev)
2941 /* caller owns the udev device lock */
2942 dev_dbg(&udev->dev, "%s\n",
2943 udev->reset_resume ? "finish reset-resume" : "finish resume");
2945 /* usb ch9 identifies four variants of SUSPENDED, based on what
2946 * state the device resumes to. Linux currently won't see the
2947 * first two on the host side; they'd be inside hub_port_init()
2948 * during many timeouts, but khubd can't suspend until later.
2950 usb_set_device_state(udev, udev->actconfig
2951 ? USB_STATE_CONFIGURED
2952 : USB_STATE_ADDRESS);
2954 /* 10.5.4.5 says not to reset a suspended port if the attached
2955 * device is enabled for remote wakeup. Hence the reset
2956 * operation is carried out here, after the port has been
2959 if (udev->reset_resume)
2961 status = usb_reset_and_verify_device(udev);
2963 /* 10.5.4.5 says be sure devices in the tree are still there.
2964 * For now let's assume the device didn't go crazy on resume,
2965 * and device drivers will know about any resume quirks.
2969 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
2971 status = (status > 0 ? 0 : -ENODEV);
2973 /* If a normal resume failed, try doing a reset-resume */
2974 if (status && !udev->reset_resume && udev->persist_enabled) {
2975 dev_dbg(&udev->dev, "retry with reset-resume\n");
2976 udev->reset_resume = 1;
2977 goto retry_reset_resume;
2982 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
2985 * There are a few quirky devices which violate the standard
2986 * by claiming to have remote wakeup enabled after a reset,
2987 * which crash if the feature is cleared, hence check for
2988 * udev->reset_resume
2990 } else if (udev->actconfig && !udev->reset_resume) {
2991 le16_to_cpus(&devstatus);
2992 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) {
2993 status = usb_control_msg(udev,
2994 usb_sndctrlpipe(udev, 0),
2995 USB_REQ_CLEAR_FEATURE,
2997 USB_DEVICE_REMOTE_WAKEUP, 0,
2999 USB_CTRL_SET_TIMEOUT);
3002 "disable remote wakeup, status %d\n",
3011 * usb_port_resume - re-activate a suspended usb device's upstream port
3012 * @udev: device to re-activate, not a root hub
3013 * Context: must be able to sleep; device not locked; pm locks held
3015 * This will re-activate the suspended device, increasing power usage
3016 * while letting drivers communicate again with its endpoints.
3017 * USB resume explicitly guarantees that the power session between
3018 * the host and the device is the same as it was when the device
3021 * If @udev->reset_resume is set then this routine won't check that the
3022 * port is still enabled. Furthermore, finish_port_resume() above will
3023 * reset @udev. The end result is that a broken power session can be
3024 * recovered and @udev will appear to persist across a loss of VBUS power.
3026 * For example, if a host controller doesn't maintain VBUS suspend current
3027 * during a system sleep or is reset when the system wakes up, all the USB
3028 * power sessions below it will be broken. This is especially troublesome
3029 * for mass-storage devices containing mounted filesystems, since the
3030 * device will appear to have disconnected and all the memory mappings
3031 * to it will be lost. Using the USB_PERSIST facility, the device can be
3032 * made to appear as if it had not disconnected.
3034 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3035 * every effort to insure that the same device is present after the
3036 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3037 * quite possible for a device to remain unaltered but its media to be
3038 * changed. If the user replaces a flash memory card while the system is
3039 * asleep, he will have only himself to blame when the filesystem on the
3040 * new card is corrupted and the system crashes.
3042 * Returns 0 on success, else negative errno.
3044 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
3046 struct usb_hub *hub = hdev_to_hub(udev->parent);
3047 int port1 = udev->portnum;
3049 u16 portchange, portstatus;
3051 /* Skip the initial Clear-Suspend step for a remote wakeup */
3052 status = hub_port_status(hub, port1, &portstatus, &portchange);
3053 if (status == 0 && !port_is_suspended(hub, portstatus))
3054 goto SuspendCleared;
3056 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
3058 set_bit(port1, hub->busy_bits);
3060 /* see 7.1.7.7; affects power usage, but not budgeting */
3061 if (hub_is_superspeed(hub->hdev))
3062 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U0);
3064 status = clear_port_feature(hub->hdev,
3065 port1, USB_PORT_FEAT_SUSPEND);
3067 dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
3070 /* drive resume for at least 20 msec */
3071 dev_dbg(&udev->dev, "usb %sresume\n",
3072 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
3075 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3076 * stop resume signaling. Then finish the resume
3079 status = hub_port_status(hub, port1, &portstatus, &portchange);
3081 /* TRSMRCY = 10 msec */
3087 udev->port_is_suspended = 0;
3088 if (hub_is_superspeed(hub->hdev)) {
3089 if (portchange & USB_PORT_STAT_C_LINK_STATE)
3090 clear_port_feature(hub->hdev, port1,
3091 USB_PORT_FEAT_C_PORT_LINK_STATE);
3093 if (portchange & USB_PORT_STAT_C_SUSPEND)
3094 clear_port_feature(hub->hdev, port1,
3095 USB_PORT_FEAT_C_SUSPEND);
3099 clear_bit(port1, hub->busy_bits);
3101 status = check_port_resume_type(udev,
3102 hub, port1, status, portchange, portstatus);
3104 status = finish_port_resume(udev);
3106 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
3107 hub_port_logical_disconnect(hub, port1);
3109 /* Try to enable USB2 hardware LPM */
3110 if (udev->usb2_hw_lpm_capable == 1)
3111 usb_set_usb2_hardware_lpm(udev, 1);
3113 /* Try to enable USB3 LTM and LPM */
3114 usb_enable_ltm(udev);
3115 usb_unlocked_enable_lpm(udev);
3121 /* caller has locked udev */
3122 int usb_remote_wakeup(struct usb_device *udev)
3126 if (udev->state == USB_STATE_SUSPENDED) {
3127 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
3128 status = usb_autoresume_device(udev);
3130 /* Let the drivers do their thing, then... */
3131 usb_autosuspend_device(udev);
3137 #else /* CONFIG_USB_SUSPEND */
3139 /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
3141 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
3146 /* However we may need to do a reset-resume */
3148 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
3150 struct usb_hub *hub = hdev_to_hub(udev->parent);
3151 int port1 = udev->portnum;
3153 u16 portchange, portstatus;
3155 status = hub_port_status(hub, port1, &portstatus, &portchange);
3156 status = check_port_resume_type(udev,
3157 hub, port1, status, portchange, portstatus);
3160 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
3161 hub_port_logical_disconnect(hub, port1);
3162 } else if (udev->reset_resume) {
3163 dev_dbg(&udev->dev, "reset-resume\n");
3164 status = usb_reset_and_verify_device(udev);
3171 static int check_ports_changed(struct usb_hub *hub)
3175 for (port1 = 1; port1 <= hub->hdev->maxchild; ++port1) {
3176 u16 portstatus, portchange;
3179 status = hub_port_status(hub, port1, &portstatus, &portchange);
3180 if (!status && portchange)
3186 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
3188 struct usb_hub *hub = usb_get_intfdata (intf);
3189 struct usb_device *hdev = hub->hdev;
3193 /* Warn if children aren't already suspended */
3194 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3195 struct usb_device *udev;
3197 udev = hub->ports[port1 - 1]->child;
3198 if (udev && udev->can_submit) {
3199 dev_warn(&intf->dev, "port %d nyet suspended\n", port1);
3200 if (PMSG_IS_AUTO(msg))
3205 if (hdev->do_remote_wakeup && hub->quirk_check_port_auto_suspend) {
3206 /* check if there are changes pending on hub ports */
3207 if (check_ports_changed(hub)) {
3208 if (PMSG_IS_AUTO(msg))
3210 pm_wakeup_event(&hdev->dev, 2000);
3214 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
3215 /* Enable hub to send remote wakeup for all ports. */
3216 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3217 status = set_port_feature(hdev,
3219 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
3220 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
3221 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
3222 USB_PORT_FEAT_REMOTE_WAKE_MASK);
3226 dev_dbg(&intf->dev, "%s\n", __func__);
3228 /* stop khubd and related activity */
3229 hub_quiesce(hub, HUB_SUSPEND);
3233 static int hub_resume(struct usb_interface *intf)
3235 struct usb_hub *hub = usb_get_intfdata(intf);
3237 dev_dbg(&intf->dev, "%s\n", __func__);
3238 hub_activate(hub, HUB_RESUME);
3242 static int hub_reset_resume(struct usb_interface *intf)
3244 struct usb_hub *hub = usb_get_intfdata(intf);
3246 dev_dbg(&intf->dev, "%s\n", __func__);
3247 hub_activate(hub, HUB_RESET_RESUME);
3252 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3253 * @rhdev: struct usb_device for the root hub
3255 * The USB host controller driver calls this function when its root hub
3256 * is resumed and Vbus power has been interrupted or the controller
3257 * has been reset. The routine marks @rhdev as having lost power.
3258 * When the hub driver is resumed it will take notice and carry out
3259 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3260 * the others will be disconnected.
3262 void usb_root_hub_lost_power(struct usb_device *rhdev)
3264 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
3265 rhdev->reset_resume = 1;
3267 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
3269 static const char * const usb3_lpm_names[] = {
3277 * Send a Set SEL control transfer to the device, prior to enabling
3278 * device-initiated U1 or U2. This lets the device know the exit latencies from
3279 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3280 * packet from the host.
3282 * This function will fail if the SEL or PEL values for udev are greater than
3283 * the maximum allowed values for the link state to be enabled.
3285 static int usb_req_set_sel(struct usb_device *udev, enum usb3_link_state state)
3287 struct usb_set_sel_req *sel_values;
3288 unsigned long long u1_sel;
3289 unsigned long long u1_pel;
3290 unsigned long long u2_sel;
3291 unsigned long long u2_pel;
3294 /* Convert SEL and PEL stored in ns to us */
3295 u1_sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
3296 u1_pel = DIV_ROUND_UP(udev->u1_params.pel, 1000);
3297 u2_sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
3298 u2_pel = DIV_ROUND_UP(udev->u2_params.pel, 1000);
3301 * Make sure that the calculated SEL and PEL values for the link
3302 * state we're enabling aren't bigger than the max SEL/PEL
3303 * value that will fit in the SET SEL control transfer.
3304 * Otherwise the device would get an incorrect idea of the exit
3305 * latency for the link state, and could start a device-initiated
3306 * U1/U2 when the exit latencies are too high.
3308 if ((state == USB3_LPM_U1 &&
3309 (u1_sel > USB3_LPM_MAX_U1_SEL_PEL ||
3310 u1_pel > USB3_LPM_MAX_U1_SEL_PEL)) ||
3311 (state == USB3_LPM_U2 &&
3312 (u2_sel > USB3_LPM_MAX_U2_SEL_PEL ||
3313 u2_pel > USB3_LPM_MAX_U2_SEL_PEL))) {
3314 dev_dbg(&udev->dev, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3315 usb3_lpm_names[state], u1_sel, u1_pel);
3320 * If we're enabling device-initiated LPM for one link state,
3321 * but the other link state has a too high SEL or PEL value,
3322 * just set those values to the max in the Set SEL request.
3324 if (u1_sel > USB3_LPM_MAX_U1_SEL_PEL)
3325 u1_sel = USB3_LPM_MAX_U1_SEL_PEL;
3327 if (u1_pel > USB3_LPM_MAX_U1_SEL_PEL)
3328 u1_pel = USB3_LPM_MAX_U1_SEL_PEL;
3330 if (u2_sel > USB3_LPM_MAX_U2_SEL_PEL)
3331 u2_sel = USB3_LPM_MAX_U2_SEL_PEL;
3333 if (u2_pel > USB3_LPM_MAX_U2_SEL_PEL)
3334 u2_pel = USB3_LPM_MAX_U2_SEL_PEL;
3337 * usb_enable_lpm() can be called as part of a failed device reset,
3338 * which may be initiated by an error path of a mass storage driver.
3339 * Therefore, use GFP_NOIO.
3341 sel_values = kmalloc(sizeof *(sel_values), GFP_NOIO);
3345 sel_values->u1_sel = u1_sel;
3346 sel_values->u1_pel = u1_pel;
3347 sel_values->u2_sel = cpu_to_le16(u2_sel);
3348 sel_values->u2_pel = cpu_to_le16(u2_pel);
3350 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3354 sel_values, sizeof *(sel_values),
3355 USB_CTRL_SET_TIMEOUT);
3361 * Enable or disable device-initiated U1 or U2 transitions.
3363 static int usb_set_device_initiated_lpm(struct usb_device *udev,
3364 enum usb3_link_state state, bool enable)
3371 feature = USB_DEVICE_U1_ENABLE;
3374 feature = USB_DEVICE_U2_ENABLE;
3377 dev_warn(&udev->dev, "%s: Can't %s non-U1 or U2 state.\n",
3378 __func__, enable ? "enable" : "disable");
3382 if (udev->state != USB_STATE_CONFIGURED) {
3383 dev_dbg(&udev->dev, "%s: Can't %s %s state "
3384 "for unconfigured device.\n",
3385 __func__, enable ? "enable" : "disable",
3386 usb3_lpm_names[state]);
3392 * Now send the control transfer to enable device-initiated LPM
3393 * for either U1 or U2.
3395 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3396 USB_REQ_SET_FEATURE,
3400 USB_CTRL_SET_TIMEOUT);
3402 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3403 USB_REQ_CLEAR_FEATURE,
3407 USB_CTRL_SET_TIMEOUT);
3410 dev_warn(&udev->dev, "%s of device-initiated %s failed.\n",
3411 enable ? "Enable" : "Disable",
3412 usb3_lpm_names[state]);
3418 static int usb_set_lpm_timeout(struct usb_device *udev,
3419 enum usb3_link_state state, int timeout)
3426 feature = USB_PORT_FEAT_U1_TIMEOUT;
3429 feature = USB_PORT_FEAT_U2_TIMEOUT;
3432 dev_warn(&udev->dev, "%s: Can't set timeout for non-U1 or U2 state.\n",
3437 if (state == USB3_LPM_U1 && timeout > USB3_LPM_U1_MAX_TIMEOUT &&
3438 timeout != USB3_LPM_DEVICE_INITIATED) {
3439 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x, "
3440 "which is a reserved value.\n",
3441 usb3_lpm_names[state], timeout);
3445 ret = set_port_feature(udev->parent,
3446 USB_PORT_LPM_TIMEOUT(timeout) | udev->portnum,
3449 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x,"
3450 "error code %i\n", usb3_lpm_names[state],
3454 if (state == USB3_LPM_U1)
3455 udev->u1_params.timeout = timeout;
3457 udev->u2_params.timeout = timeout;
3462 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3465 * We will attempt to enable U1 or U2, but there are no guarantees that the
3466 * control transfers to set the hub timeout or enable device-initiated U1/U2
3467 * will be successful.
3469 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3470 * driver know about it. If that call fails, it should be harmless, and just
3471 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3473 static void usb_enable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3474 enum usb3_link_state state)
3477 __u8 u1_mel = udev->bos->ss_cap->bU1devExitLat;
3478 __le16 u2_mel = udev->bos->ss_cap->bU2DevExitLat;
3480 /* If the device says it doesn't have *any* exit latency to come out of
3481 * U1 or U2, it's probably lying. Assume it doesn't implement that link
3484 if ((state == USB3_LPM_U1 && u1_mel == 0) ||
3485 (state == USB3_LPM_U2 && u2_mel == 0))
3489 * First, let the device know about the exit latencies
3490 * associated with the link state we're about to enable.
3492 ret = usb_req_set_sel(udev, state);
3494 dev_warn(&udev->dev, "Set SEL for device-initiated %s failed.\n",
3495 usb3_lpm_names[state]);
3499 /* We allow the host controller to set the U1/U2 timeout internally
3500 * first, so that it can change its schedule to account for the
3501 * additional latency to send data to a device in a lower power
3504 timeout = hcd->driver->enable_usb3_lpm_timeout(hcd, udev, state);
3506 /* xHCI host controller doesn't want to enable this LPM state. */
3511 dev_warn(&udev->dev, "Could not enable %s link state, "
3512 "xHCI error %i.\n", usb3_lpm_names[state],
3517 if (usb_set_lpm_timeout(udev, state, timeout))
3518 /* If we can't set the parent hub U1/U2 timeout,
3519 * device-initiated LPM won't be allowed either, so let the xHCI
3520 * host know that this link state won't be enabled.
3522 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
3524 /* Only a configured device will accept the Set Feature U1/U2_ENABLE */
3525 else if (udev->actconfig)
3526 usb_set_device_initiated_lpm(udev, state, true);
3531 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
3534 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
3535 * If zero is returned, the parent will not allow the link to go into U1/U2.
3537 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
3538 * it won't have an effect on the bus link state because the parent hub will
3539 * still disallow device-initiated U1/U2 entry.
3541 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
3542 * possible. The result will be slightly more bus bandwidth will be taken up
3543 * (to account for U1/U2 exit latency), but it should be harmless.
3545 static int usb_disable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3546 enum usb3_link_state state)
3552 feature = USB_PORT_FEAT_U1_TIMEOUT;
3555 feature = USB_PORT_FEAT_U2_TIMEOUT;
3558 dev_warn(&udev->dev, "%s: Can't disable non-U1 or U2 state.\n",
3563 if (usb_set_lpm_timeout(udev, state, 0))
3566 usb_set_device_initiated_lpm(udev, state, false);
3568 if (hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state))
3569 dev_warn(&udev->dev, "Could not disable xHCI %s timeout, "
3570 "bus schedule bandwidth may be impacted.\n",
3571 usb3_lpm_names[state]);
3576 * Disable hub-initiated and device-initiated U1 and U2 entry.
3577 * Caller must own the bandwidth_mutex.
3579 * This will call usb_enable_lpm() on failure, which will decrement
3580 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
3582 int usb_disable_lpm(struct usb_device *udev)
3584 struct usb_hcd *hcd;
3586 if (!udev || !udev->parent ||
3587 udev->speed != USB_SPEED_SUPER ||
3591 hcd = bus_to_hcd(udev->bus);
3592 if (!hcd || !hcd->driver->disable_usb3_lpm_timeout)
3595 udev->lpm_disable_count++;
3596 if ((udev->u1_params.timeout == 0 && udev->u2_params.timeout == 0))
3599 /* If LPM is enabled, attempt to disable it. */
3600 if (usb_disable_link_state(hcd, udev, USB3_LPM_U1))
3602 if (usb_disable_link_state(hcd, udev, USB3_LPM_U2))
3608 usb_enable_lpm(udev);
3611 EXPORT_SYMBOL_GPL(usb_disable_lpm);
3613 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
3614 int usb_unlocked_disable_lpm(struct usb_device *udev)
3616 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3622 mutex_lock(hcd->bandwidth_mutex);
3623 ret = usb_disable_lpm(udev);
3624 mutex_unlock(hcd->bandwidth_mutex);
3628 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
3631 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
3632 * xHCI host policy may prevent U1 or U2 from being enabled.
3634 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
3635 * until the lpm_disable_count drops to zero. Caller must own the
3638 void usb_enable_lpm(struct usb_device *udev)
3640 struct usb_hcd *hcd;
3642 if (!udev || !udev->parent ||
3643 udev->speed != USB_SPEED_SUPER ||
3647 udev->lpm_disable_count--;
3648 hcd = bus_to_hcd(udev->bus);
3649 /* Double check that we can both enable and disable LPM.
3650 * Device must be configured to accept set feature U1/U2 timeout.
3652 if (!hcd || !hcd->driver->enable_usb3_lpm_timeout ||
3653 !hcd->driver->disable_usb3_lpm_timeout)
3656 if (udev->lpm_disable_count > 0)
3659 usb_enable_link_state(hcd, udev, USB3_LPM_U1);
3660 usb_enable_link_state(hcd, udev, USB3_LPM_U2);
3662 EXPORT_SYMBOL_GPL(usb_enable_lpm);
3664 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
3665 void usb_unlocked_enable_lpm(struct usb_device *udev)
3667 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3672 mutex_lock(hcd->bandwidth_mutex);
3673 usb_enable_lpm(udev);
3674 mutex_unlock(hcd->bandwidth_mutex);
3676 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
3679 #else /* CONFIG_PM */
3681 #define hub_suspend NULL
3682 #define hub_resume NULL
3683 #define hub_reset_resume NULL
3685 int usb_disable_lpm(struct usb_device *udev)
3689 EXPORT_SYMBOL_GPL(usb_disable_lpm);
3691 void usb_enable_lpm(struct usb_device *udev) { }
3692 EXPORT_SYMBOL_GPL(usb_enable_lpm);
3694 int usb_unlocked_disable_lpm(struct usb_device *udev)
3698 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
3700 void usb_unlocked_enable_lpm(struct usb_device *udev) { }
3701 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
3703 int usb_disable_ltm(struct usb_device *udev)
3707 EXPORT_SYMBOL_GPL(usb_disable_ltm);
3709 void usb_enable_ltm(struct usb_device *udev) { }
3710 EXPORT_SYMBOL_GPL(usb_enable_ltm);
3714 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
3716 * Between connect detection and reset signaling there must be a delay
3717 * of 100ms at least for debounce and power-settling. The corresponding
3718 * timer shall restart whenever the downstream port detects a disconnect.
3720 * Apparently there are some bluetooth and irda-dongles and a number of
3721 * low-speed devices for which this debounce period may last over a second.
3722 * Not covered by the spec - but easy to deal with.
3724 * This implementation uses a 1500ms total debounce timeout; if the
3725 * connection isn't stable by then it returns -ETIMEDOUT. It checks
3726 * every 25ms for transient disconnects. When the port status has been
3727 * unchanged for 100ms it returns the port status.
3729 static int hub_port_debounce(struct usb_hub *hub, int port1)
3732 int total_time, stable_time = 0;
3733 u16 portchange, portstatus;
3734 unsigned connection = 0xffff;
3736 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
3737 ret = hub_port_status(hub, port1, &portstatus, &portchange);
3741 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
3742 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
3743 stable_time += HUB_DEBOUNCE_STEP;
3744 if (stable_time >= HUB_DEBOUNCE_STABLE)
3748 connection = portstatus & USB_PORT_STAT_CONNECTION;
3751 if (portchange & USB_PORT_STAT_C_CONNECTION) {
3752 clear_port_feature(hub->hdev, port1,
3753 USB_PORT_FEAT_C_CONNECTION);
3756 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
3758 msleep(HUB_DEBOUNCE_STEP);
3761 dev_dbg (hub->intfdev,
3762 "debounce: port %d: total %dms stable %dms status 0x%x\n",
3763 port1, total_time, stable_time, portstatus);
3765 if (stable_time < HUB_DEBOUNCE_STABLE)
3770 void usb_ep0_reinit(struct usb_device *udev)
3772 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
3773 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
3774 usb_enable_endpoint(udev, &udev->ep0, true);
3776 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
3778 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
3779 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
3781 static int hub_set_address(struct usb_device *udev, int devnum)
3784 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3787 * The host controller will choose the device address,
3788 * instead of the core having chosen it earlier
3790 if (!hcd->driver->address_device && devnum <= 1)
3792 if (udev->state == USB_STATE_ADDRESS)
3794 if (udev->state != USB_STATE_DEFAULT)
3796 if (hcd->driver->address_device)
3797 retval = hcd->driver->address_device(hcd, udev);
3799 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
3800 USB_REQ_SET_ADDRESS, 0, devnum, 0,
3801 NULL, 0, USB_CTRL_SET_TIMEOUT);
3803 update_devnum(udev, devnum);
3804 /* Device now using proper address. */
3805 usb_set_device_state(udev, USB_STATE_ADDRESS);
3806 usb_ep0_reinit(udev);
3811 /* Reset device, (re)assign address, get device descriptor.
3812 * Device connection must be stable, no more debouncing needed.
3813 * Returns device in USB_STATE_ADDRESS, except on error.
3815 * If this is called for an already-existing device (as part of
3816 * usb_reset_and_verify_device), the caller must own the device lock. For a
3817 * newly detected device that is not accessible through any global
3818 * pointers, it's not necessary to lock the device.
3821 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
3824 static DEFINE_MUTEX(usb_address0_mutex);
3826 struct usb_device *hdev = hub->hdev;
3827 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
3829 unsigned delay = HUB_SHORT_RESET_TIME;
3830 enum usb_device_speed oldspeed = udev->speed;
3832 int devnum = udev->devnum;
3834 /* root hub ports have a slightly longer reset period
3835 * (from USB 2.0 spec, section 7.1.7.5)
3837 if (!hdev->parent) {
3838 delay = HUB_ROOT_RESET_TIME;
3839 if (port1 == hdev->bus->otg_port)
3840 hdev->bus->b_hnp_enable = 0;
3843 /* Some low speed devices have problems with the quick delay, so */
3844 /* be a bit pessimistic with those devices. RHbug #23670 */
3845 if (oldspeed == USB_SPEED_LOW)
3846 delay = HUB_LONG_RESET_TIME;
3848 mutex_lock(&usb_address0_mutex);
3850 /* Reset the device; full speed may morph to high speed */
3851 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
3852 retval = hub_port_reset(hub, port1, udev, delay, false);
3853 if (retval < 0) /* error or disconnect */
3855 /* success, speed is known */
3859 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
3860 dev_dbg(&udev->dev, "device reset changed speed!\n");
3863 oldspeed = udev->speed;
3865 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
3866 * it's fixed size except for full speed devices.
3867 * For Wireless USB devices, ep0 max packet is always 512 (tho
3868 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
3870 switch (udev->speed) {
3871 case USB_SPEED_SUPER:
3872 case USB_SPEED_WIRELESS: /* fixed at 512 */
3873 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
3875 case USB_SPEED_HIGH: /* fixed at 64 */
3876 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
3878 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
3879 /* to determine the ep0 maxpacket size, try to read
3880 * the device descriptor to get bMaxPacketSize0 and
3881 * then correct our initial guess.
3883 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
3885 case USB_SPEED_LOW: /* fixed at 8 */
3886 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
3892 if (udev->speed == USB_SPEED_WIRELESS)
3893 speed = "variable speed Wireless";
3895 speed = usb_speed_string(udev->speed);
3897 if (udev->speed != USB_SPEED_SUPER)
3898 dev_info(&udev->dev,
3899 "%s %s USB device number %d using %s\n",
3900 (udev->config) ? "reset" : "new", speed,
3901 devnum, udev->bus->controller->driver->name);
3903 /* Set up TT records, if needed */
3905 udev->tt = hdev->tt;
3906 udev->ttport = hdev->ttport;
3907 } else if (udev->speed != USB_SPEED_HIGH
3908 && hdev->speed == USB_SPEED_HIGH) {
3910 dev_err(&udev->dev, "parent hub has no TT\n");
3914 udev->tt = &hub->tt;
3915 udev->ttport = port1;
3918 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
3919 * Because device hardware and firmware is sometimes buggy in
3920 * this area, and this is how Linux has done it for ages.
3921 * Change it cautiously.
3923 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
3924 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
3925 * so it may help with some non-standards-compliant devices.
3926 * Otherwise we start with SET_ADDRESS and then try to read the
3927 * first 8 bytes of the device descriptor to get the ep0 maxpacket
3930 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
3931 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3)) {
3932 struct usb_device_descriptor *buf;
3935 #define GET_DESCRIPTOR_BUFSIZE 64
3936 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
3942 /* Retry on all errors; some devices are flakey.
3943 * 255 is for WUSB devices, we actually need to use
3944 * 512 (WUSB1.0[4.8.1]).
3946 for (j = 0; j < 3; ++j) {
3947 buf->bMaxPacketSize0 = 0;
3948 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
3949 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
3950 USB_DT_DEVICE << 8, 0,
3951 buf, GET_DESCRIPTOR_BUFSIZE,
3952 initial_descriptor_timeout);
3953 switch (buf->bMaxPacketSize0) {
3954 case 8: case 16: case 32: case 64: case 255:
3955 if (buf->bDescriptorType ==
3969 udev->descriptor.bMaxPacketSize0 =
3970 buf->bMaxPacketSize0;
3973 retval = hub_port_reset(hub, port1, udev, delay, false);
3974 if (retval < 0) /* error or disconnect */
3976 if (oldspeed != udev->speed) {
3978 "device reset changed speed!\n");
3984 "device descriptor read/64, error %d\n",
3989 #undef GET_DESCRIPTOR_BUFSIZE
3993 * If device is WUSB, we already assigned an
3994 * unauthorized address in the Connect Ack sequence;
3995 * authorization will assign the final address.
3997 if (udev->wusb == 0) {
3998 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
3999 retval = hub_set_address(udev, devnum);
4006 "device not accepting address %d, error %d\n",
4010 if (udev->speed == USB_SPEED_SUPER) {
4011 devnum = udev->devnum;
4012 dev_info(&udev->dev,
4013 "%s SuperSpeed USB device number %d using %s\n",
4014 (udev->config) ? "reset" : "new",
4015 devnum, udev->bus->controller->driver->name);
4018 /* cope with hardware quirkiness:
4019 * - let SET_ADDRESS settle, some device hardware wants it
4020 * - read ep0 maxpacket even for high and low speed,
4023 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3))
4027 retval = usb_get_device_descriptor(udev, 8);
4030 "device descriptor read/8, error %d\n",
4042 if (hcd->phy && !hdev->parent)
4043 usb_phy_notify_connect(hcd->phy, udev->speed);
4046 * Some superspeed devices have finished the link training process
4047 * and attached to a superspeed hub port, but the device descriptor
4048 * got from those devices show they aren't superspeed devices. Warm
4049 * reset the port attached by the devices can fix them.
4051 if ((udev->speed == USB_SPEED_SUPER) &&
4052 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
4053 dev_err(&udev->dev, "got a wrong device descriptor, "
4054 "warm reset device\n");
4055 hub_port_reset(hub, port1, udev,
4056 HUB_BH_RESET_TIME, true);
4061 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
4062 udev->speed == USB_SPEED_SUPER)
4065 i = udev->descriptor.bMaxPacketSize0;
4066 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
4067 if (udev->speed == USB_SPEED_LOW ||
4068 !(i == 8 || i == 16 || i == 32 || i == 64)) {
4069 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
4073 if (udev->speed == USB_SPEED_FULL)
4074 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
4076 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
4077 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
4078 usb_ep0_reinit(udev);
4081 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
4082 if (retval < (signed)sizeof(udev->descriptor)) {
4083 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
4090 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
4091 retval = usb_get_bos_descriptor(udev);
4093 udev->lpm_capable = usb_device_supports_lpm(udev);
4094 usb_set_lpm_parameters(udev);
4099 /* notify HCD that we have a device connected and addressed */
4100 if (hcd->driver->update_device)
4101 hcd->driver->update_device(hcd, udev);
4104 hub_port_disable(hub, port1, 0);
4105 update_devnum(udev, devnum); /* for disconnect processing */
4107 mutex_unlock(&usb_address0_mutex);
4112 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
4114 struct usb_qualifier_descriptor *qual;
4117 qual = kmalloc (sizeof *qual, GFP_KERNEL);
4121 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
4122 qual, sizeof *qual);
4123 if (status == sizeof *qual) {
4124 dev_info(&udev->dev, "not running at top speed; "
4125 "connect to a high speed hub\n");
4126 /* hub LEDs are probably harder to miss than syslog */
4127 if (hub->has_indicators) {
4128 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
4129 schedule_delayed_work (&hub->leds, 0);
4136 hub_power_remaining (struct usb_hub *hub)
4138 struct usb_device *hdev = hub->hdev;
4142 if (!hub->limited_power)
4145 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
4146 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
4147 struct usb_device *udev = hub->ports[port1 - 1]->child;
4153 if (hub_is_superspeed(udev))
4159 * Unconfigured devices may not use more than one unit load,
4160 * or 8mA for OTG ports
4162 if (udev->actconfig)
4163 delta = usb_get_max_power(udev, udev->actconfig);
4164 else if (port1 != udev->bus->otg_port || hdev->parent)
4168 if (delta > hub->mA_per_port)
4169 dev_warn(&udev->dev,
4170 "%dmA is over %umA budget for port %d!\n",
4171 delta, hub->mA_per_port, port1);
4174 if (remaining < 0) {
4175 dev_warn(hub->intfdev, "%dmA over power budget!\n",
4182 /* Handle physical or logical connection change events.
4183 * This routine is called when:
4184 * a port connection-change occurs;
4185 * a port enable-change occurs (often caused by EMI);
4186 * usb_reset_and_verify_device() encounters changed descriptors (as from
4187 * a firmware download)
4188 * caller already locked the hub
4190 static void hub_port_connect_change(struct usb_hub *hub, int port1,
4191 u16 portstatus, u16 portchange)
4193 struct usb_device *hdev = hub->hdev;
4194 struct device *hub_dev = hub->intfdev;
4195 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4196 unsigned wHubCharacteristics =
4197 le16_to_cpu(hub->descriptor->wHubCharacteristics);
4198 struct usb_device *udev;
4203 "port %d, status %04x, change %04x, %s\n",
4204 port1, portstatus, portchange, portspeed(hub, portstatus));
4206 if (hub->has_indicators) {
4207 set_port_led(hub, port1, HUB_LED_AUTO);
4208 hub->indicator[port1-1] = INDICATOR_AUTO;
4211 #ifdef CONFIG_USB_OTG
4212 /* during HNP, don't repeat the debounce */
4213 if (hdev->bus->is_b_host)
4214 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
4215 USB_PORT_STAT_C_ENABLE);
4218 /* Try to resuscitate an existing device */
4219 udev = hub->ports[port1 - 1]->child;
4220 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
4221 udev->state != USB_STATE_NOTATTACHED) {
4222 usb_lock_device(udev);
4223 if (portstatus & USB_PORT_STAT_ENABLE) {
4224 status = 0; /* Nothing to do */
4226 #ifdef CONFIG_USB_SUSPEND
4227 } else if (udev->state == USB_STATE_SUSPENDED &&
4228 udev->persist_enabled) {
4229 /* For a suspended device, treat this as a
4230 * remote wakeup event.
4232 status = usb_remote_wakeup(udev);
4236 status = -ENODEV; /* Don't resuscitate */
4238 usb_unlock_device(udev);
4241 clear_bit(port1, hub->change_bits);
4246 /* Disconnect any existing devices under this port */
4248 if (hcd->phy && !hdev->parent &&
4249 !(portstatus & USB_PORT_STAT_CONNECTION))
4250 usb_phy_notify_disconnect(hcd->phy, udev->speed);
4251 usb_disconnect(&hub->ports[port1 - 1]->child);
4253 clear_bit(port1, hub->change_bits);
4255 /* We can forget about a "removed" device when there's a physical
4256 * disconnect or the connect status changes.
4258 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4259 (portchange & USB_PORT_STAT_C_CONNECTION))
4260 clear_bit(port1, hub->removed_bits);
4262 if (portchange & (USB_PORT_STAT_C_CONNECTION |
4263 USB_PORT_STAT_C_ENABLE)) {
4264 status = hub_port_debounce(hub, port1);
4266 if (printk_ratelimit())
4267 dev_err(hub_dev, "connect-debounce failed, "
4268 "port %d disabled\n", port1);
4269 portstatus &= ~USB_PORT_STAT_CONNECTION;
4271 portstatus = status;
4275 /* Return now if debouncing failed or nothing is connected or
4276 * the device was "removed".
4278 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4279 test_bit(port1, hub->removed_bits)) {
4281 /* maybe switch power back on (e.g. root hub was reset) */
4282 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
4283 && !port_is_power_on(hub, portstatus))
4284 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
4286 if (portstatus & USB_PORT_STAT_ENABLE)
4290 if (hub_is_superspeed(hub->hdev))
4295 for (i = 0; i < SET_CONFIG_TRIES; i++) {
4297 /* reallocate for each attempt, since references
4298 * to the previous one can escape in various ways
4300 udev = usb_alloc_dev(hdev, hdev->bus, port1);
4303 "couldn't allocate port %d usb_device\n",
4308 usb_set_device_state(udev, USB_STATE_POWERED);
4309 udev->bus_mA = hub->mA_per_port;
4310 udev->level = hdev->level + 1;
4311 udev->wusb = hub_is_wusb(hub);
4313 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
4314 if (hub_is_superspeed(hub->hdev))
4315 udev->speed = USB_SPEED_SUPER;
4317 udev->speed = USB_SPEED_UNKNOWN;
4319 choose_devnum(udev);
4320 if (udev->devnum <= 0) {
4321 status = -ENOTCONN; /* Don't retry */
4325 /* reset (non-USB 3.0 devices) and get descriptor */
4326 status = hub_port_init(hub, udev, port1, i);
4330 usb_detect_quirks(udev);
4331 if (udev->quirks & USB_QUIRK_DELAY_INIT)
4334 /* consecutive bus-powered hubs aren't reliable; they can
4335 * violate the voltage drop budget. if the new child has
4336 * a "powered" LED, users should notice we didn't enable it
4337 * (without reading syslog), even without per-port LEDs
4340 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
4341 && udev->bus_mA <= unit_load) {
4344 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
4347 dev_dbg(&udev->dev, "get status %d ?\n", status);
4350 le16_to_cpus(&devstat);
4351 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
4353 "can't connect bus-powered hub "
4355 if (hub->has_indicators) {
4356 hub->indicator[port1-1] =
4357 INDICATOR_AMBER_BLINK;
4358 schedule_delayed_work (&hub->leds, 0);
4360 status = -ENOTCONN; /* Don't retry */
4365 /* check for devices running slower than they could */
4366 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
4367 && udev->speed == USB_SPEED_FULL
4368 && highspeed_hubs != 0)
4369 check_highspeed (hub, udev, port1);
4371 /* Store the parent's children[] pointer. At this point
4372 * udev becomes globally accessible, although presumably
4373 * no one will look at it until hdev is unlocked.
4377 /* We mustn't add new devices if the parent hub has
4378 * been disconnected; we would race with the
4379 * recursively_mark_NOTATTACHED() routine.
4381 spin_lock_irq(&device_state_lock);
4382 if (hdev->state == USB_STATE_NOTATTACHED)
4385 hub->ports[port1 - 1]->child = udev;
4386 spin_unlock_irq(&device_state_lock);
4388 /* Run it through the hoops (find a driver, etc) */
4390 status = usb_new_device(udev);
4392 spin_lock_irq(&device_state_lock);
4393 hub->ports[port1 - 1]->child = NULL;
4394 spin_unlock_irq(&device_state_lock);
4401 status = hub_power_remaining(hub);
4403 dev_dbg(hub_dev, "%dmA power budget left\n", status);
4408 hub_port_disable(hub, port1, 1);
4410 usb_ep0_reinit(udev);
4411 release_devnum(udev);
4414 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
4417 if (hub->hdev->parent ||
4418 !hcd->driver->port_handed_over ||
4419 !(hcd->driver->port_handed_over)(hcd, port1))
4420 dev_err(hub_dev, "unable to enumerate USB device on port %d\n",
4424 hub_port_disable(hub, port1, 1);
4425 if (hcd->driver->relinquish_port && !hub->hdev->parent)
4426 hcd->driver->relinquish_port(hcd, port1);
4429 /* Returns 1 if there was a remote wakeup and a connect status change. */
4430 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
4431 u16 portstatus, u16 portchange)
4433 struct usb_device *hdev;
4434 struct usb_device *udev;
4435 int connect_change = 0;
4439 udev = hub->ports[port - 1]->child;
4440 if (!hub_is_superspeed(hdev)) {
4441 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
4443 clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
4445 if (!udev || udev->state != USB_STATE_SUSPENDED ||
4446 (portstatus & USB_PORT_STAT_LINK_STATE) !=
4452 /* TRSMRCY = 10 msec */
4455 usb_lock_device(udev);
4456 ret = usb_remote_wakeup(udev);
4457 usb_unlock_device(udev);
4462 hub_port_disable(hub, port, 1);
4464 dev_dbg(hub->intfdev, "resume on port %d, status %d\n",
4466 return connect_change;
4469 static void hub_events(void)
4471 struct list_head *tmp;
4472 struct usb_device *hdev;
4473 struct usb_interface *intf;
4474 struct usb_hub *hub;
4475 struct device *hub_dev;
4481 int connect_change, wakeup_change;
4484 * We restart the list every time to avoid a deadlock with
4485 * deleting hubs downstream from this one. This should be
4486 * safe since we delete the hub from the event list.
4487 * Not the most efficient, but avoids deadlocks.
4491 /* Grab the first entry at the beginning of the list */
4492 spin_lock_irq(&hub_event_lock);
4493 if (list_empty(&hub_event_list)) {
4494 spin_unlock_irq(&hub_event_lock);
4498 tmp = hub_event_list.next;
4501 hub = list_entry(tmp, struct usb_hub, event_list);
4502 kref_get(&hub->kref);
4503 spin_unlock_irq(&hub_event_lock);
4506 hub_dev = hub->intfdev;
4507 intf = to_usb_interface(hub_dev);
4508 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
4509 hdev->state, hub->descriptor
4510 ? hub->descriptor->bNbrPorts
4512 /* NOTE: expects max 15 ports... */
4513 (u16) hub->change_bits[0],
4514 (u16) hub->event_bits[0]);
4516 /* Lock the device, then check to see if we were
4517 * disconnected while waiting for the lock to succeed. */
4518 usb_lock_device(hdev);
4519 if (unlikely(hub->disconnected))
4520 goto loop_disconnected;
4522 /* If the hub has died, clean up after it */
4523 if (hdev->state == USB_STATE_NOTATTACHED) {
4524 hub->error = -ENODEV;
4525 hub_quiesce(hub, HUB_DISCONNECT);
4530 ret = usb_autopm_get_interface(intf);
4532 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
4536 /* If this is an inactive hub, do nothing */
4541 dev_dbg (hub_dev, "resetting for error %d\n",
4544 ret = usb_reset_device(hdev);
4547 "error resetting hub: %d\n", ret);
4555 /* deal with port status changes */
4556 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
4557 if (test_bit(i, hub->busy_bits))
4559 connect_change = test_bit(i, hub->change_bits);
4560 wakeup_change = test_and_clear_bit(i, hub->wakeup_bits);
4561 if (!test_and_clear_bit(i, hub->event_bits) &&
4562 !connect_change && !wakeup_change)
4565 ret = hub_port_status(hub, i,
4566 &portstatus, &portchange);
4570 if (portchange & USB_PORT_STAT_C_CONNECTION) {
4571 clear_port_feature(hdev, i,
4572 USB_PORT_FEAT_C_CONNECTION);
4576 if (portchange & USB_PORT_STAT_C_ENABLE) {
4577 if (!connect_change)
4579 "port %d enable change, "
4582 clear_port_feature(hdev, i,
4583 USB_PORT_FEAT_C_ENABLE);
4586 * EM interference sometimes causes badly
4587 * shielded USB devices to be shutdown by
4588 * the hub, this hack enables them again.
4589 * Works at least with mouse driver.
4591 if (!(portstatus & USB_PORT_STAT_ENABLE)
4593 && hub->ports[i - 1]->child) {
4596 "disabled by hub (EMI?), "
4603 if (hub_handle_remote_wakeup(hub, i,
4604 portstatus, portchange))
4607 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
4611 dev_dbg(hub_dev, "over-current change on port "
4613 clear_port_feature(hdev, i,
4614 USB_PORT_FEAT_C_OVER_CURRENT);
4615 msleep(100); /* Cool down */
4616 hub_power_on(hub, true);
4617 hub_port_status(hub, i, &status, &unused);
4618 if (status & USB_PORT_STAT_OVERCURRENT)
4619 dev_err(hub_dev, "over-current "
4620 "condition on port %d\n", i);
4623 if (portchange & USB_PORT_STAT_C_RESET) {
4625 "reset change on port %d\n",
4627 clear_port_feature(hdev, i,
4628 USB_PORT_FEAT_C_RESET);
4630 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
4631 hub_is_superspeed(hub->hdev)) {
4633 "warm reset change on port %d\n",
4635 clear_port_feature(hdev, i,
4636 USB_PORT_FEAT_C_BH_PORT_RESET);
4638 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
4639 clear_port_feature(hub->hdev, i,
4640 USB_PORT_FEAT_C_PORT_LINK_STATE);
4642 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
4644 "config error on port %d\n",
4646 clear_port_feature(hub->hdev, i,
4647 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
4650 /* Warm reset a USB3 protocol port if it's in
4651 * SS.Inactive state.
4653 if (hub_port_warm_reset_required(hub, portstatus)) {
4655 struct usb_device *udev =
4656 hub->ports[i - 1]->child;
4658 dev_dbg(hub_dev, "warm reset port %d\n", i);
4660 status = hub_port_reset(hub, i,
4661 NULL, HUB_BH_RESET_TIME,
4664 hub_port_disable(hub, i, 1);
4666 usb_lock_device(udev);
4667 status = usb_reset_device(udev);
4668 usb_unlock_device(udev);
4674 hub_port_connect_change(hub, i,
4675 portstatus, portchange);
4678 /* deal with hub status changes */
4679 if (test_and_clear_bit(0, hub->event_bits) == 0)
4681 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
4682 dev_err (hub_dev, "get_hub_status failed\n");
4684 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
4685 dev_dbg (hub_dev, "power change\n");
4686 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
4687 if (hubstatus & HUB_STATUS_LOCAL_POWER)
4688 /* FIXME: Is this always true? */
4689 hub->limited_power = 1;
4691 hub->limited_power = 0;
4693 if (hubchange & HUB_CHANGE_OVERCURRENT) {
4697 dev_dbg(hub_dev, "over-current change\n");
4698 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
4699 msleep(500); /* Cool down */
4700 hub_power_on(hub, true);
4701 hub_hub_status(hub, &status, &unused);
4702 if (status & HUB_STATUS_OVERCURRENT)
4703 dev_err(hub_dev, "over-current "
4709 /* Balance the usb_autopm_get_interface() above */
4710 usb_autopm_put_interface_no_suspend(intf);
4712 /* Balance the usb_autopm_get_interface_no_resume() in
4713 * kick_khubd() and allow autosuspend.
4715 usb_autopm_put_interface(intf);
4717 usb_unlock_device(hdev);
4718 kref_put(&hub->kref, hub_release);
4720 } /* end while (1) */
4723 static int hub_thread(void *__unused)
4725 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
4726 * port handover. Otherwise it might see that a full-speed device
4727 * was gone before the EHCI controller had handed its port over to
4728 * the companion full-speed controller.
4734 wait_event_freezable(khubd_wait,
4735 !list_empty(&hub_event_list) ||
4736 kthread_should_stop());
4737 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
4739 pr_debug("%s: khubd exiting\n", usbcore_name);
4743 static const struct usb_device_id hub_id_table[] = {
4744 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
4745 | USB_DEVICE_ID_MATCH_INT_CLASS,
4746 .idVendor = USB_VENDOR_GENESYS_LOGIC,
4747 .bInterfaceClass = USB_CLASS_HUB,
4748 .driver_info = HUB_QUIRK_CHECK_PORT_AUTOSUSPEND},
4749 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
4750 .bDeviceClass = USB_CLASS_HUB},
4751 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
4752 .bInterfaceClass = USB_CLASS_HUB},
4753 { } /* Terminating entry */
4756 MODULE_DEVICE_TABLE (usb, hub_id_table);
4758 static struct usb_driver hub_driver = {
4761 .disconnect = hub_disconnect,
4762 .suspend = hub_suspend,
4763 .resume = hub_resume,
4764 .reset_resume = hub_reset_resume,
4765 .pre_reset = hub_pre_reset,
4766 .post_reset = hub_post_reset,
4767 .unlocked_ioctl = hub_ioctl,
4768 .id_table = hub_id_table,
4769 .supports_autosuspend = 1,
4772 int usb_hub_init(void)
4774 if (usb_register(&hub_driver) < 0) {
4775 printk(KERN_ERR "%s: can't register hub driver\n",
4780 khubd_task = kthread_run(hub_thread, NULL, "khubd");
4781 if (!IS_ERR(khubd_task))
4784 /* Fall through if kernel_thread failed */
4785 usb_deregister(&hub_driver);
4786 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
4791 void usb_hub_cleanup(void)
4793 kthread_stop(khubd_task);
4796 * Hub resources are freed for us by usb_deregister. It calls
4797 * usb_driver_purge on every device which in turn calls that
4798 * devices disconnect function if it is using this driver.
4799 * The hub_disconnect function takes care of releasing the
4800 * individual hub resources. -greg
4802 usb_deregister(&hub_driver);
4803 } /* usb_hub_cleanup() */
4805 static int descriptors_changed(struct usb_device *udev,
4806 struct usb_device_descriptor *old_device_descriptor)
4810 unsigned serial_len = 0;
4812 unsigned old_length;
4816 if (memcmp(&udev->descriptor, old_device_descriptor,
4817 sizeof(*old_device_descriptor)) != 0)
4820 /* Since the idVendor, idProduct, and bcdDevice values in the
4821 * device descriptor haven't changed, we will assume the
4822 * Manufacturer and Product strings haven't changed either.
4823 * But the SerialNumber string could be different (e.g., a
4824 * different flash card of the same brand).
4827 serial_len = strlen(udev->serial) + 1;
4830 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
4831 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
4832 len = max(len, old_length);
4835 buf = kmalloc(len, GFP_NOIO);
4837 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
4838 /* assume the worst */
4841 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
4842 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
4843 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
4845 if (length != old_length) {
4846 dev_dbg(&udev->dev, "config index %d, error %d\n",
4851 if (memcmp (buf, udev->rawdescriptors[index], old_length)
4853 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
4855 ((struct usb_config_descriptor *) buf)->
4856 bConfigurationValue);
4862 if (!changed && serial_len) {
4863 length = usb_string(udev, udev->descriptor.iSerialNumber,
4865 if (length + 1 != serial_len) {
4866 dev_dbg(&udev->dev, "serial string error %d\n",
4869 } else if (memcmp(buf, udev->serial, length) != 0) {
4870 dev_dbg(&udev->dev, "serial string changed\n");
4880 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
4881 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
4883 * WARNING - don't use this routine to reset a composite device
4884 * (one with multiple interfaces owned by separate drivers)!
4885 * Use usb_reset_device() instead.
4887 * Do a port reset, reassign the device's address, and establish its
4888 * former operating configuration. If the reset fails, or the device's
4889 * descriptors change from their values before the reset, or the original
4890 * configuration and altsettings cannot be restored, a flag will be set
4891 * telling khubd to pretend the device has been disconnected and then
4892 * re-connected. All drivers will be unbound, and the device will be
4893 * re-enumerated and probed all over again.
4895 * Returns 0 if the reset succeeded, -ENODEV if the device has been
4896 * flagged for logical disconnection, or some other negative error code
4897 * if the reset wasn't even attempted.
4899 * The caller must own the device lock. For example, it's safe to use
4900 * this from a driver probe() routine after downloading new firmware.
4901 * For calls that might not occur during probe(), drivers should lock
4902 * the device using usb_lock_device_for_reset().
4904 * Locking exception: This routine may also be called from within an
4905 * autoresume handler. Such usage won't conflict with other tasks
4906 * holding the device lock because these tasks should always call
4907 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
4909 static int usb_reset_and_verify_device(struct usb_device *udev)
4911 struct usb_device *parent_hdev = udev->parent;
4912 struct usb_hub *parent_hub;
4913 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4914 struct usb_device_descriptor descriptor = udev->descriptor;
4916 int port1 = udev->portnum;
4918 if (udev->state == USB_STATE_NOTATTACHED ||
4919 udev->state == USB_STATE_SUSPENDED) {
4920 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
4926 /* this requires hcd-specific logic; see ohci_restart() */
4927 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
4930 parent_hub = hdev_to_hub(parent_hdev);
4932 /* Disable LPM and LTM while we reset the device and reinstall the alt
4933 * settings. Device-initiated LPM settings, and system exit latency
4934 * settings are cleared when the device is reset, so we have to set
4937 ret = usb_unlocked_disable_lpm(udev);
4939 dev_err(&udev->dev, "%s Failed to disable LPM\n.", __func__);
4942 ret = usb_disable_ltm(udev);
4944 dev_err(&udev->dev, "%s Failed to disable LTM\n.",
4949 set_bit(port1, parent_hub->busy_bits);
4950 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
4952 /* ep0 maxpacket size may change; let the HCD know about it.
4953 * Other endpoints will be handled by re-enumeration. */
4954 usb_ep0_reinit(udev);
4955 ret = hub_port_init(parent_hub, udev, port1, i);
4956 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
4959 clear_bit(port1, parent_hub->busy_bits);
4964 /* Device might have changed firmware (DFU or similar) */
4965 if (descriptors_changed(udev, &descriptor)) {
4966 dev_info(&udev->dev, "device firmware changed\n");
4967 udev->descriptor = descriptor; /* for disconnect() calls */
4971 /* Restore the device's previous configuration */
4972 if (!udev->actconfig)
4975 mutex_lock(hcd->bandwidth_mutex);
4976 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
4978 dev_warn(&udev->dev,
4979 "Busted HC? Not enough HCD resources for "
4980 "old configuration.\n");
4981 mutex_unlock(hcd->bandwidth_mutex);
4984 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
4985 USB_REQ_SET_CONFIGURATION, 0,
4986 udev->actconfig->desc.bConfigurationValue, 0,
4987 NULL, 0, USB_CTRL_SET_TIMEOUT);
4990 "can't restore configuration #%d (error=%d)\n",
4991 udev->actconfig->desc.bConfigurationValue, ret);
4992 mutex_unlock(hcd->bandwidth_mutex);
4995 mutex_unlock(hcd->bandwidth_mutex);
4996 usb_set_device_state(udev, USB_STATE_CONFIGURED);
4998 /* Put interfaces back into the same altsettings as before.
4999 * Don't bother to send the Set-Interface request for interfaces
5000 * that were already in altsetting 0; besides being unnecessary,
5001 * many devices can't handle it. Instead just reset the host-side
5004 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
5005 struct usb_host_config *config = udev->actconfig;
5006 struct usb_interface *intf = config->interface[i];
5007 struct usb_interface_descriptor *desc;
5009 desc = &intf->cur_altsetting->desc;
5010 if (desc->bAlternateSetting == 0) {
5011 usb_disable_interface(udev, intf, true);
5012 usb_enable_interface(udev, intf, true);
5015 /* Let the bandwidth allocation function know that this
5016 * device has been reset, and it will have to use
5017 * alternate setting 0 as the current alternate setting.
5019 intf->resetting_device = 1;
5020 ret = usb_set_interface(udev, desc->bInterfaceNumber,
5021 desc->bAlternateSetting);
5022 intf->resetting_device = 0;
5025 dev_err(&udev->dev, "failed to restore interface %d "
5026 "altsetting %d (error=%d)\n",
5027 desc->bInterfaceNumber,
5028 desc->bAlternateSetting,
5035 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5036 usb_unlocked_enable_lpm(udev);
5037 usb_enable_ltm(udev);
5041 /* LPM state doesn't matter when we're about to destroy the device. */
5042 hub_port_logical_disconnect(parent_hub, port1);
5047 * usb_reset_device - warn interface drivers and perform a USB port reset
5048 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5050 * Warns all drivers bound to registered interfaces (using their pre_reset
5051 * method), performs the port reset, and then lets the drivers know that
5052 * the reset is over (using their post_reset method).
5054 * Return value is the same as for usb_reset_and_verify_device().
5056 * The caller must own the device lock. For example, it's safe to use
5057 * this from a driver probe() routine after downloading new firmware.
5058 * For calls that might not occur during probe(), drivers should lock
5059 * the device using usb_lock_device_for_reset().
5061 * If an interface is currently being probed or disconnected, we assume
5062 * its driver knows how to handle resets. For all other interfaces,
5063 * if the driver doesn't have pre_reset and post_reset methods then
5064 * we attempt to unbind it and rebind afterward.
5066 int usb_reset_device(struct usb_device *udev)
5070 struct usb_host_config *config = udev->actconfig;
5072 if (udev->state == USB_STATE_NOTATTACHED ||
5073 udev->state == USB_STATE_SUSPENDED) {
5074 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5079 /* Prevent autosuspend during the reset */
5080 usb_autoresume_device(udev);
5083 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
5084 struct usb_interface *cintf = config->interface[i];
5085 struct usb_driver *drv;
5088 if (cintf->dev.driver) {
5089 drv = to_usb_driver(cintf->dev.driver);
5090 if (drv->pre_reset && drv->post_reset)
5091 unbind = (drv->pre_reset)(cintf);
5092 else if (cintf->condition ==
5093 USB_INTERFACE_BOUND)
5096 usb_forced_unbind_intf(cintf);
5101 ret = usb_reset_and_verify_device(udev);
5104 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
5105 struct usb_interface *cintf = config->interface[i];
5106 struct usb_driver *drv;
5107 int rebind = cintf->needs_binding;
5109 if (!rebind && cintf->dev.driver) {
5110 drv = to_usb_driver(cintf->dev.driver);
5111 if (drv->post_reset)
5112 rebind = (drv->post_reset)(cintf);
5113 else if (cintf->condition ==
5114 USB_INTERFACE_BOUND)
5117 if (ret == 0 && rebind)
5118 usb_rebind_intf(cintf);
5122 usb_autosuspend_device(udev);
5125 EXPORT_SYMBOL_GPL(usb_reset_device);
5129 * usb_queue_reset_device - Reset a USB device from an atomic context
5130 * @iface: USB interface belonging to the device to reset
5132 * This function can be used to reset a USB device from an atomic
5133 * context, where usb_reset_device() won't work (as it blocks).
5135 * Doing a reset via this method is functionally equivalent to calling
5136 * usb_reset_device(), except for the fact that it is delayed to a
5137 * workqueue. This means that any drivers bound to other interfaces
5138 * might be unbound, as well as users from usbfs in user space.
5142 * - Scheduling two resets at the same time from two different drivers
5143 * attached to two different interfaces of the same device is
5144 * possible; depending on how the driver attached to each interface
5145 * handles ->pre_reset(), the second reset might happen or not.
5147 * - If a driver is unbound and it had a pending reset, the reset will
5150 * - This function can be called during .probe() or .disconnect()
5151 * times. On return from .disconnect(), any pending resets will be
5154 * There is no no need to lock/unlock the @reset_ws as schedule_work()
5157 * NOTE: We don't do any reference count tracking because it is not
5158 * needed. The lifecycle of the work_struct is tied to the
5159 * usb_interface. Before destroying the interface we cancel the
5160 * work_struct, so the fact that work_struct is queued and or
5161 * running means the interface (and thus, the device) exist and
5164 void usb_queue_reset_device(struct usb_interface *iface)
5166 schedule_work(&iface->reset_ws);
5168 EXPORT_SYMBOL_GPL(usb_queue_reset_device);
5171 * usb_hub_find_child - Get the pointer of child device
5172 * attached to the port which is specified by @port1.
5173 * @hdev: USB device belonging to the usb hub
5174 * @port1: port num to indicate which port the child device
5177 * USB drivers call this function to get hub's child device
5180 * Return NULL if input param is invalid and
5181 * child's usb_device pointer if non-NULL.
5183 struct usb_device *usb_hub_find_child(struct usb_device *hdev,
5186 struct usb_hub *hub = hdev_to_hub(hdev);
5188 if (port1 < 1 || port1 > hdev->maxchild)
5190 return hub->ports[port1 - 1]->child;
5192 EXPORT_SYMBOL_GPL(usb_hub_find_child);
5195 * usb_set_hub_port_connect_type - set hub port connect type.
5196 * @hdev: USB device belonging to the usb hub
5197 * @port1: port num of the port
5198 * @type: connect type of the port
5200 void usb_set_hub_port_connect_type(struct usb_device *hdev, int port1,
5201 enum usb_port_connect_type type)
5203 struct usb_hub *hub = hdev_to_hub(hdev);
5205 hub->ports[port1 - 1]->connect_type = type;
5209 * usb_get_hub_port_connect_type - Get the port's connect type
5210 * @hdev: USB device belonging to the usb hub
5211 * @port1: port num of the port
5213 * Return connect type of the port and if input params are
5214 * invalid, return USB_PORT_CONNECT_TYPE_UNKNOWN.
5216 enum usb_port_connect_type
5217 usb_get_hub_port_connect_type(struct usb_device *hdev, int port1)
5219 struct usb_hub *hub = hdev_to_hub(hdev);
5221 return hub->ports[port1 - 1]->connect_type;
5224 void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
5225 struct usb_hub_descriptor *desc)
5227 enum usb_port_connect_type connect_type;
5230 if (!hub_is_superspeed(hdev)) {
5231 for (i = 1; i <= hdev->maxchild; i++) {
5232 connect_type = usb_get_hub_port_connect_type(hdev, i);
5234 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5235 u8 mask = 1 << (i%8);
5237 if (!(desc->u.hs.DeviceRemovable[i/8] & mask)) {
5238 dev_dbg(&hdev->dev, "usb port%d's DeviceRemovable is changed to 1 according to platform information.\n",
5240 desc->u.hs.DeviceRemovable[i/8] |= mask;
5245 u16 port_removable = le16_to_cpu(desc->u.ss.DeviceRemovable);
5247 for (i = 1; i <= hdev->maxchild; i++) {
5248 connect_type = usb_get_hub_port_connect_type(hdev, i);
5250 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5253 if (!(port_removable & mask)) {
5254 dev_dbg(&hdev->dev, "usb port%d's DeviceRemovable is changed to 1 according to platform information.\n",
5256 port_removable |= mask;
5261 desc->u.ss.DeviceRemovable = cpu_to_le16(port_removable);
5267 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5268 * @hdev: USB device belonging to the usb hub
5269 * @port1: port num of the port
5271 * Return port's acpi handle if successful, NULL if params are
5274 acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
5277 struct usb_hub *hub = hdev_to_hub(hdev);
5279 return DEVICE_ACPI_HANDLE(&hub->ports[port1 - 1]->dev);