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/quirks.h>
24 #include <linux/kthread.h>
25 #include <linux/mutex.h>
26 #include <linux/freezer.h>
28 #include <asm/uaccess.h>
29 #include <asm/byteorder.h>
33 /* if we are in debug mode, always announce new devices */
35 #ifndef CONFIG_USB_ANNOUNCE_NEW_DEVICES
36 #define CONFIG_USB_ANNOUNCE_NEW_DEVICES
41 struct device *intfdev; /* the "interface" device */
42 struct usb_device *hdev;
44 struct urb *urb; /* for interrupt polling pipe */
46 /* buffer for urb ... with extra space in case of babble */
49 struct usb_hub_status hub;
50 struct usb_port_status port;
51 } *status; /* buffer for status reports */
52 struct mutex status_mutex; /* for the status buffer */
54 int error; /* last reported error */
55 int nerrors; /* track consecutive errors */
57 struct list_head event_list; /* hubs w/data or errs ready */
58 unsigned long event_bits[1]; /* status change bitmask */
59 unsigned long change_bits[1]; /* ports with logical connect
61 unsigned long busy_bits[1]; /* ports being reset or
63 unsigned long removed_bits[1]; /* ports with a "removed"
65 unsigned long wakeup_bits[1]; /* ports that have signaled
67 #if USB_MAXCHILDREN > 31 /* 8*sizeof(unsigned long) - 1 */
68 #error event_bits[] is too short!
71 struct usb_hub_descriptor *descriptor; /* class descriptor */
72 struct usb_tt tt; /* Transaction Translator */
74 unsigned mA_per_port; /* current for each child */
76 unsigned limited_power:1;
78 unsigned disconnected:1;
80 unsigned has_indicators:1;
81 u8 indicator[USB_MAXCHILDREN];
82 struct delayed_work leds;
83 struct delayed_work init_work;
84 struct dev_state **port_owners;
87 static inline int hub_is_superspeed(struct usb_device *hdev)
89 return (hdev->descriptor.bDeviceProtocol == USB_HUB_PR_SS);
92 /* Protect struct usb_device->state and ->children members
93 * Note: Both are also protected by ->dev.sem, except that ->state can
94 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
95 static DEFINE_SPINLOCK(device_state_lock);
97 /* khubd's worklist and its lock */
98 static DEFINE_SPINLOCK(hub_event_lock);
99 static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
102 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
104 static struct task_struct *khubd_task;
106 /* cycle leds on hubs that aren't blinking for attention */
107 static bool blinkenlights = 0;
108 module_param (blinkenlights, bool, S_IRUGO);
109 MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
112 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
113 * 10 seconds to send reply for the initial 64-byte descriptor request.
115 /* define initial 64-byte descriptor request timeout in milliseconds */
116 static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
117 module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
118 MODULE_PARM_DESC(initial_descriptor_timeout,
119 "initial 64-byte descriptor request timeout in milliseconds "
120 "(default 5000 - 5.0 seconds)");
123 * As of 2.6.10 we introduce a new USB device initialization scheme which
124 * closely resembles the way Windows works. Hopefully it will be compatible
125 * with a wider range of devices than the old scheme. However some previously
126 * working devices may start giving rise to "device not accepting address"
127 * errors; if that happens the user can try the old scheme by adjusting the
128 * following module parameters.
130 * For maximum flexibility there are two boolean parameters to control the
131 * hub driver's behavior. On the first initialization attempt, if the
132 * "old_scheme_first" parameter is set then the old scheme will be used,
133 * otherwise the new scheme is used. If that fails and "use_both_schemes"
134 * is set, then the driver will make another attempt, using the other scheme.
136 static bool old_scheme_first = 0;
137 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
138 MODULE_PARM_DESC(old_scheme_first,
139 "start with the old device initialization scheme");
141 static bool use_both_schemes = 1;
142 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
143 MODULE_PARM_DESC(use_both_schemes,
144 "try the other device initialization scheme if the "
147 /* Mutual exclusion for EHCI CF initialization. This interferes with
148 * port reset on some companion controllers.
150 DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
151 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
153 #define HUB_DEBOUNCE_TIMEOUT 1500
154 #define HUB_DEBOUNCE_STEP 25
155 #define HUB_DEBOUNCE_STABLE 100
158 static int usb_reset_and_verify_device(struct usb_device *udev);
160 static inline char *portspeed(struct usb_hub *hub, int portstatus)
162 if (hub_is_superspeed(hub->hdev))
164 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
166 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
172 /* Note that hdev or one of its children must be locked! */
173 static struct usb_hub *hdev_to_hub(struct usb_device *hdev)
175 if (!hdev || !hdev->actconfig)
177 return usb_get_intfdata(hdev->actconfig->interface[0]);
180 static int usb_device_supports_lpm(struct usb_device *udev)
182 /* USB 2.1 (and greater) devices indicate LPM support through
183 * their USB 2.0 Extended Capabilities BOS descriptor.
185 if (udev->speed == USB_SPEED_HIGH) {
186 if (udev->bos->ext_cap &&
188 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
193 /* All USB 3.0 must support LPM, but we need their max exit latency
194 * information from the SuperSpeed Extended Capabilities BOS descriptor.
196 if (!udev->bos->ss_cap) {
197 dev_warn(&udev->dev, "No LPM exit latency info found. "
198 "Power management will be impacted.\n");
201 if (udev->parent->lpm_capable)
204 dev_warn(&udev->dev, "Parent hub missing LPM exit latency info. "
205 "Power management will be impacted.\n");
210 * Set the Maximum Exit Latency (MEL) for the host to initiate a transition from
213 static void usb_set_lpm_mel(struct usb_device *udev,
214 struct usb3_lpm_parameters *udev_lpm_params,
215 unsigned int udev_exit_latency,
217 struct usb3_lpm_parameters *hub_lpm_params,
218 unsigned int hub_exit_latency)
220 unsigned int total_mel;
221 unsigned int device_mel;
222 unsigned int hub_mel;
225 * Calculate the time it takes to transition all links from the roothub
226 * to the parent hub into U0. The parent hub must then decode the
227 * packet (hub header decode latency) to figure out which port it was
230 * The Hub Header decode latency is expressed in 0.1us intervals (0x1
231 * means 0.1us). Multiply that by 100 to get nanoseconds.
233 total_mel = hub_lpm_params->mel +
234 (hub->descriptor->u.ss.bHubHdrDecLat * 100);
237 * How long will it take to transition the downstream hub's port into
238 * U0? The greater of either the hub exit latency or the device exit
241 * The BOS U1/U2 exit latencies are expressed in 1us intervals.
242 * Multiply that by 1000 to get nanoseconds.
244 device_mel = udev_exit_latency * 1000;
245 hub_mel = hub_exit_latency * 1000;
246 if (device_mel > hub_mel)
247 total_mel += device_mel;
249 total_mel += hub_mel;
251 udev_lpm_params->mel = total_mel;
255 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
256 * a transition from either U1 or U2.
258 static void usb_set_lpm_pel(struct usb_device *udev,
259 struct usb3_lpm_parameters *udev_lpm_params,
260 unsigned int udev_exit_latency,
262 struct usb3_lpm_parameters *hub_lpm_params,
263 unsigned int hub_exit_latency,
264 unsigned int port_to_port_exit_latency)
266 unsigned int first_link_pel;
267 unsigned int hub_pel;
270 * First, the device sends an LFPS to transition the link between the
271 * device and the parent hub into U0. The exit latency is the bigger of
272 * the device exit latency or the hub exit latency.
274 if (udev_exit_latency > hub_exit_latency)
275 first_link_pel = udev_exit_latency * 1000;
277 first_link_pel = hub_exit_latency * 1000;
280 * When the hub starts to receive the LFPS, there is a slight delay for
281 * it to figure out that one of the ports is sending an LFPS. Then it
282 * will forward the LFPS to its upstream link. The exit latency is the
283 * delay, plus the PEL that we calculated for this hub.
285 hub_pel = port_to_port_exit_latency * 1000 + hub_lpm_params->pel;
288 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
289 * is the greater of the two exit latencies.
291 if (first_link_pel > hub_pel)
292 udev_lpm_params->pel = first_link_pel;
294 udev_lpm_params->pel = hub_pel;
298 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
299 * when a device initiates a transition to U0, until when it will receive the
300 * first packet from the host controller.
302 * Section C.1.5.1 describes the four components to this:
304 * - t2: time for the ERDY to make it from the device to the host.
305 * - t3: a host-specific delay to process the ERDY.
306 * - t4: time for the packet to make it from the host to the device.
308 * t3 is specific to both the xHCI host and the platform the host is integrated
309 * into. The Intel HW folks have said it's negligible, FIXME if a different
310 * vendor says otherwise.
312 static void usb_set_lpm_sel(struct usb_device *udev,
313 struct usb3_lpm_parameters *udev_lpm_params)
315 struct usb_device *parent;
316 unsigned int num_hubs;
317 unsigned int total_sel;
319 /* t1 = device PEL */
320 total_sel = udev_lpm_params->pel;
321 /* How many external hubs are in between the device & the root port. */
322 for (parent = udev->parent, num_hubs = 0; parent->parent;
323 parent = parent->parent)
325 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
327 total_sel += 2100 + 250 * (num_hubs - 1);
329 /* t4 = 250ns * num_hubs */
330 total_sel += 250 * num_hubs;
332 udev_lpm_params->sel = total_sel;
335 static void usb_set_lpm_parameters(struct usb_device *udev)
338 unsigned int port_to_port_delay;
339 unsigned int udev_u1_del;
340 unsigned int udev_u2_del;
341 unsigned int hub_u1_del;
342 unsigned int hub_u2_del;
344 if (!udev->lpm_capable || udev->speed != USB_SPEED_SUPER)
347 hub = hdev_to_hub(udev->parent);
348 /* It doesn't take time to transition the roothub into U0, since it
349 * doesn't have an upstream link.
354 udev_u1_del = udev->bos->ss_cap->bU1devExitLat;
355 udev_u2_del = udev->bos->ss_cap->bU2DevExitLat;
356 hub_u1_del = udev->parent->bos->ss_cap->bU1devExitLat;
357 hub_u2_del = udev->parent->bos->ss_cap->bU2DevExitLat;
359 usb_set_lpm_mel(udev, &udev->u1_params, udev_u1_del,
360 hub, &udev->parent->u1_params, hub_u1_del);
362 usb_set_lpm_mel(udev, &udev->u2_params, udev_u2_del,
363 hub, &udev->parent->u2_params, hub_u2_del);
366 * Appendix C, section C.2.2.2, says that there is a slight delay from
367 * when the parent hub notices the downstream port is trying to
368 * transition to U0 to when the hub initiates a U0 transition on its
369 * upstream port. The section says the delays are tPort2PortU1EL and
370 * tPort2PortU2EL, but it doesn't define what they are.
372 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
373 * about the same delays. Use the maximum delay calculations from those
374 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
375 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
376 * assume the device exit latencies they are talking about are the hub
379 * What do we do if the U2 exit latency is less than the U1 exit
380 * latency? It's possible, although not likely...
382 port_to_port_delay = 1;
384 usb_set_lpm_pel(udev, &udev->u1_params, udev_u1_del,
385 hub, &udev->parent->u1_params, hub_u1_del,
388 if (hub_u2_del > hub_u1_del)
389 port_to_port_delay = 1 + hub_u2_del - hub_u1_del;
391 port_to_port_delay = 1 + hub_u1_del;
393 usb_set_lpm_pel(udev, &udev->u2_params, udev_u2_del,
394 hub, &udev->parent->u2_params, hub_u2_del,
397 /* Now that we've got PEL, calculate SEL. */
398 usb_set_lpm_sel(udev, &udev->u1_params);
399 usb_set_lpm_sel(udev, &udev->u2_params);
402 /* USB 2.0 spec Section 11.24.4.5 */
403 static int get_hub_descriptor(struct usb_device *hdev, void *data)
408 if (hub_is_superspeed(hdev)) {
409 dtype = USB_DT_SS_HUB;
410 size = USB_DT_SS_HUB_SIZE;
413 size = sizeof(struct usb_hub_descriptor);
416 for (i = 0; i < 3; i++) {
417 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
418 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
419 dtype << 8, 0, data, size,
420 USB_CTRL_GET_TIMEOUT);
421 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
428 * USB 2.0 spec Section 11.24.2.1
430 static int clear_hub_feature(struct usb_device *hdev, int feature)
432 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
433 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
437 * USB 2.0 spec Section 11.24.2.2
439 static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
441 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
442 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
447 * USB 2.0 spec Section 11.24.2.13
449 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
451 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
452 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
457 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
458 * for info about using port indicators
460 static void set_port_led(
466 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
467 USB_PORT_FEAT_INDICATOR);
469 dev_dbg (hub->intfdev,
470 "port %d indicator %s status %d\n",
472 ({ char *s; switch (selector) {
473 case HUB_LED_AMBER: s = "amber"; break;
474 case HUB_LED_GREEN: s = "green"; break;
475 case HUB_LED_OFF: s = "off"; break;
476 case HUB_LED_AUTO: s = "auto"; break;
477 default: s = "??"; break;
482 #define LED_CYCLE_PERIOD ((2*HZ)/3)
484 static void led_work (struct work_struct *work)
486 struct usb_hub *hub =
487 container_of(work, struct usb_hub, leds.work);
488 struct usb_device *hdev = hub->hdev;
490 unsigned changed = 0;
493 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
496 for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
497 unsigned selector, mode;
499 /* 30%-50% duty cycle */
501 switch (hub->indicator[i]) {
503 case INDICATOR_CYCLE:
505 selector = HUB_LED_AUTO;
506 mode = INDICATOR_AUTO;
508 /* blinking green = sw attention */
509 case INDICATOR_GREEN_BLINK:
510 selector = HUB_LED_GREEN;
511 mode = INDICATOR_GREEN_BLINK_OFF;
513 case INDICATOR_GREEN_BLINK_OFF:
514 selector = HUB_LED_OFF;
515 mode = INDICATOR_GREEN_BLINK;
517 /* blinking amber = hw attention */
518 case INDICATOR_AMBER_BLINK:
519 selector = HUB_LED_AMBER;
520 mode = INDICATOR_AMBER_BLINK_OFF;
522 case INDICATOR_AMBER_BLINK_OFF:
523 selector = HUB_LED_OFF;
524 mode = INDICATOR_AMBER_BLINK;
526 /* blink green/amber = reserved */
527 case INDICATOR_ALT_BLINK:
528 selector = HUB_LED_GREEN;
529 mode = INDICATOR_ALT_BLINK_OFF;
531 case INDICATOR_ALT_BLINK_OFF:
532 selector = HUB_LED_AMBER;
533 mode = INDICATOR_ALT_BLINK;
538 if (selector != HUB_LED_AUTO)
540 set_port_led(hub, i + 1, selector);
541 hub->indicator[i] = mode;
543 if (!changed && blinkenlights) {
545 cursor %= hub->descriptor->bNbrPorts;
546 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
547 hub->indicator[cursor] = INDICATOR_CYCLE;
551 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
554 /* use a short timeout for hub/port status fetches */
555 #define USB_STS_TIMEOUT 1000
556 #define USB_STS_RETRIES 5
559 * USB 2.0 spec Section 11.24.2.6
561 static int get_hub_status(struct usb_device *hdev,
562 struct usb_hub_status *data)
564 int i, status = -ETIMEDOUT;
566 for (i = 0; i < USB_STS_RETRIES &&
567 (status == -ETIMEDOUT || status == -EPIPE); i++) {
568 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
569 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
570 data, sizeof(*data), USB_STS_TIMEOUT);
576 * USB 2.0 spec Section 11.24.2.7
578 static int get_port_status(struct usb_device *hdev, int port1,
579 struct usb_port_status *data)
581 int i, status = -ETIMEDOUT;
583 for (i = 0; i < USB_STS_RETRIES &&
584 (status == -ETIMEDOUT || status == -EPIPE); i++) {
585 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
586 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
587 data, sizeof(*data), USB_STS_TIMEOUT);
592 static int hub_port_status(struct usb_hub *hub, int port1,
593 u16 *status, u16 *change)
597 mutex_lock(&hub->status_mutex);
598 ret = get_port_status(hub->hdev, port1, &hub->status->port);
600 dev_err(hub->intfdev,
601 "%s failed (err = %d)\n", __func__, ret);
605 *status = le16_to_cpu(hub->status->port.wPortStatus);
606 *change = le16_to_cpu(hub->status->port.wPortChange);
610 mutex_unlock(&hub->status_mutex);
614 static void kick_khubd(struct usb_hub *hub)
618 spin_lock_irqsave(&hub_event_lock, flags);
619 if (!hub->disconnected && list_empty(&hub->event_list)) {
620 list_add_tail(&hub->event_list, &hub_event_list);
622 /* Suppress autosuspend until khubd runs */
623 usb_autopm_get_interface_no_resume(
624 to_usb_interface(hub->intfdev));
625 wake_up(&khubd_wait);
627 spin_unlock_irqrestore(&hub_event_lock, flags);
630 void usb_kick_khubd(struct usb_device *hdev)
632 struct usb_hub *hub = hdev_to_hub(hdev);
639 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
640 * Notification, which indicates it had initiated remote wakeup.
642 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
643 * device initiates resume, so the USB core will not receive notice of the
644 * resume through the normal hub interrupt URB.
646 void usb_wakeup_notification(struct usb_device *hdev,
647 unsigned int portnum)
654 hub = hdev_to_hub(hdev);
656 set_bit(portnum, hub->wakeup_bits);
660 EXPORT_SYMBOL_GPL(usb_wakeup_notification);
662 /* completion function, fires on port status changes and various faults */
663 static void hub_irq(struct urb *urb)
665 struct usb_hub *hub = urb->context;
666 int status = urb->status;
671 case -ENOENT: /* synchronous unlink */
672 case -ECONNRESET: /* async unlink */
673 case -ESHUTDOWN: /* hardware going away */
676 default: /* presumably an error */
677 /* Cause a hub reset after 10 consecutive errors */
678 dev_dbg (hub->intfdev, "transfer --> %d\n", status);
679 if ((++hub->nerrors < 10) || hub->error)
684 /* let khubd handle things */
685 case 0: /* we got data: port status changed */
687 for (i = 0; i < urb->actual_length; ++i)
688 bits |= ((unsigned long) ((*hub->buffer)[i]))
690 hub->event_bits[0] = bits;
696 /* Something happened, let khubd figure it out */
703 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
704 && status != -ENODEV && status != -EPERM)
705 dev_err (hub->intfdev, "resubmit --> %d\n", status);
708 /* USB 2.0 spec Section 11.24.2.3 */
710 hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
712 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
713 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
718 * enumeration blocks khubd for a long time. we use keventd instead, since
719 * long blocking there is the exception, not the rule. accordingly, HCDs
720 * talking to TTs must queue control transfers (not just bulk and iso), so
721 * both can talk to the same hub concurrently.
723 static void hub_tt_work(struct work_struct *work)
725 struct usb_hub *hub =
726 container_of(work, struct usb_hub, tt.clear_work);
730 spin_lock_irqsave (&hub->tt.lock, flags);
731 while (--limit && !list_empty (&hub->tt.clear_list)) {
732 struct list_head *next;
733 struct usb_tt_clear *clear;
734 struct usb_device *hdev = hub->hdev;
735 const struct hc_driver *drv;
738 next = hub->tt.clear_list.next;
739 clear = list_entry (next, struct usb_tt_clear, clear_list);
740 list_del (&clear->clear_list);
742 /* drop lock so HCD can concurrently report other TT errors */
743 spin_unlock_irqrestore (&hub->tt.lock, flags);
744 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
747 "clear tt %d (%04x) error %d\n",
748 clear->tt, clear->devinfo, status);
750 /* Tell the HCD, even if the operation failed */
751 drv = clear->hcd->driver;
752 if (drv->clear_tt_buffer_complete)
753 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
756 spin_lock_irqsave(&hub->tt.lock, flags);
758 spin_unlock_irqrestore (&hub->tt.lock, flags);
762 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
763 * @urb: an URB associated with the failed or incomplete split transaction
765 * High speed HCDs use this to tell the hub driver that some split control or
766 * bulk transaction failed in a way that requires clearing internal state of
767 * a transaction translator. This is normally detected (and reported) from
770 * It may not be possible for that hub to handle additional full (or low)
771 * speed transactions until that state is fully cleared out.
773 int usb_hub_clear_tt_buffer(struct urb *urb)
775 struct usb_device *udev = urb->dev;
776 int pipe = urb->pipe;
777 struct usb_tt *tt = udev->tt;
779 struct usb_tt_clear *clear;
781 /* we've got to cope with an arbitrary number of pending TT clears,
782 * since each TT has "at least two" buffers that can need it (and
783 * there can be many TTs per hub). even if they're uncommon.
785 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
786 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
787 /* FIXME recover somehow ... RESET_TT? */
791 /* info that CLEAR_TT_BUFFER needs */
792 clear->tt = tt->multi ? udev->ttport : 1;
793 clear->devinfo = usb_pipeendpoint (pipe);
794 clear->devinfo |= udev->devnum << 4;
795 clear->devinfo |= usb_pipecontrol (pipe)
796 ? (USB_ENDPOINT_XFER_CONTROL << 11)
797 : (USB_ENDPOINT_XFER_BULK << 11);
798 if (usb_pipein (pipe))
799 clear->devinfo |= 1 << 15;
801 /* info for completion callback */
802 clear->hcd = bus_to_hcd(udev->bus);
805 /* tell keventd to clear state for this TT */
806 spin_lock_irqsave (&tt->lock, flags);
807 list_add_tail (&clear->clear_list, &tt->clear_list);
808 schedule_work(&tt->clear_work);
809 spin_unlock_irqrestore (&tt->lock, flags);
812 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
814 /* If do_delay is false, return the number of milliseconds the caller
817 static unsigned hub_power_on(struct usb_hub *hub, bool do_delay)
820 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
822 u16 wHubCharacteristics =
823 le16_to_cpu(hub->descriptor->wHubCharacteristics);
825 /* Enable power on each port. Some hubs have reserved values
826 * of LPSM (> 2) in their descriptors, even though they are
827 * USB 2.0 hubs. Some hubs do not implement port-power switching
828 * but only emulate it. In all cases, the ports won't work
829 * unless we send these messages to the hub.
831 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
832 dev_dbg(hub->intfdev, "enabling power on all ports\n");
834 dev_dbg(hub->intfdev, "trying to enable port power on "
835 "non-switchable hub\n");
836 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
837 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
839 /* Wait at least 100 msec for power to become stable */
840 delay = max(pgood_delay, (unsigned) 100);
846 static int hub_hub_status(struct usb_hub *hub,
847 u16 *status, u16 *change)
851 mutex_lock(&hub->status_mutex);
852 ret = get_hub_status(hub->hdev, &hub->status->hub);
854 dev_err (hub->intfdev,
855 "%s failed (err = %d)\n", __func__, ret);
857 *status = le16_to_cpu(hub->status->hub.wHubStatus);
858 *change = le16_to_cpu(hub->status->hub.wHubChange);
861 mutex_unlock(&hub->status_mutex);
865 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
867 struct usb_device *hdev = hub->hdev;
870 if (hdev->children[port1-1] && set_state)
871 usb_set_device_state(hdev->children[port1-1],
872 USB_STATE_NOTATTACHED);
873 if (!hub->error && !hub_is_superspeed(hub->hdev))
874 ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
876 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
882 * Disable a port and mark a logical connect-change event, so that some
883 * time later khubd will disconnect() any existing usb_device on the port
884 * and will re-enumerate if there actually is a device attached.
886 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
888 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
889 hub_port_disable(hub, port1, 1);
891 /* FIXME let caller ask to power down the port:
892 * - some devices won't enumerate without a VBUS power cycle
893 * - SRP saves power that way
894 * - ... new call, TBD ...
895 * That's easy if this hub can switch power per-port, and
896 * khubd reactivates the port later (timer, SRP, etc).
897 * Powerdown must be optional, because of reset/DFU.
900 set_bit(port1, hub->change_bits);
905 * usb_remove_device - disable a device's port on its parent hub
906 * @udev: device to be disabled and removed
907 * Context: @udev locked, must be able to sleep.
909 * After @udev's port has been disabled, khubd is notified and it will
910 * see that the device has been disconnected. When the device is
911 * physically unplugged and something is plugged in, the events will
912 * be received and processed normally.
914 int usb_remove_device(struct usb_device *udev)
917 struct usb_interface *intf;
919 if (!udev->parent) /* Can't remove a root hub */
921 hub = hdev_to_hub(udev->parent);
922 intf = to_usb_interface(hub->intfdev);
924 usb_autopm_get_interface(intf);
925 set_bit(udev->portnum, hub->removed_bits);
926 hub_port_logical_disconnect(hub, udev->portnum);
927 usb_autopm_put_interface(intf);
931 enum hub_activation_type {
932 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
933 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
936 static void hub_init_func2(struct work_struct *ws);
937 static void hub_init_func3(struct work_struct *ws);
939 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
941 struct usb_device *hdev = hub->hdev;
946 bool need_debounce_delay = false;
949 /* Continue a partial initialization */
950 if (type == HUB_INIT2)
952 if (type == HUB_INIT3)
955 /* The superspeed hub except for root hub has to use Hub Depth
956 * value as an offset into the route string to locate the bits
957 * it uses to determine the downstream port number. So hub driver
958 * should send a set hub depth request to superspeed hub after
959 * the superspeed hub is set configuration in initialization or
962 * After a resume, port power should still be on.
963 * For any other type of activation, turn it on.
965 if (type != HUB_RESUME) {
966 if (hdev->parent && hub_is_superspeed(hdev)) {
967 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
968 HUB_SET_DEPTH, USB_RT_HUB,
969 hdev->level - 1, 0, NULL, 0,
970 USB_CTRL_SET_TIMEOUT);
972 dev_err(hub->intfdev,
973 "set hub depth failed\n");
976 /* Speed up system boot by using a delayed_work for the
977 * hub's initial power-up delays. This is pretty awkward
978 * and the implementation looks like a home-brewed sort of
979 * setjmp/longjmp, but it saves at least 100 ms for each
980 * root hub (assuming usbcore is compiled into the kernel
981 * rather than as a module). It adds up.
983 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
984 * because for those activation types the ports have to be
985 * operational when we return. In theory this could be done
986 * for HUB_POST_RESET, but it's easier not to.
988 if (type == HUB_INIT) {
989 delay = hub_power_on(hub, false);
990 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func2);
991 schedule_delayed_work(&hub->init_work,
992 msecs_to_jiffies(delay));
994 /* Suppress autosuspend until init is done */
995 usb_autopm_get_interface_no_resume(
996 to_usb_interface(hub->intfdev));
997 return; /* Continues at init2: below */
998 } else if (type == HUB_RESET_RESUME) {
999 /* The internal host controller state for the hub device
1000 * may be gone after a host power loss on system resume.
1001 * Update the device's info so the HW knows it's a hub.
1003 hcd = bus_to_hcd(hdev->bus);
1004 if (hcd->driver->update_hub_device) {
1005 ret = hcd->driver->update_hub_device(hcd, hdev,
1006 &hub->tt, GFP_NOIO);
1008 dev_err(hub->intfdev, "Host not "
1009 "accepting hub info "
1011 dev_err(hub->intfdev, "LS/FS devices "
1012 "and hubs may not work "
1013 "under this hub\n.");
1016 hub_power_on(hub, true);
1018 hub_power_on(hub, true);
1023 /* Check each port and set hub->change_bits to let khubd know
1024 * which ports need attention.
1026 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
1027 struct usb_device *udev = hdev->children[port1-1];
1028 u16 portstatus, portchange;
1030 portstatus = portchange = 0;
1031 status = hub_port_status(hub, port1, &portstatus, &portchange);
1032 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1033 dev_dbg(hub->intfdev,
1034 "port %d: status %04x change %04x\n",
1035 port1, portstatus, portchange);
1037 /* After anything other than HUB_RESUME (i.e., initialization
1038 * or any sort of reset), every port should be disabled.
1039 * Unconnected ports should likewise be disabled (paranoia),
1040 * and so should ports for which we have no usb_device.
1042 if ((portstatus & USB_PORT_STAT_ENABLE) && (
1043 type != HUB_RESUME ||
1044 !(portstatus & USB_PORT_STAT_CONNECTION) ||
1046 udev->state == USB_STATE_NOTATTACHED)) {
1048 * USB3 protocol ports will automatically transition
1049 * to Enabled state when detect an USB3.0 device attach.
1050 * Do not disable USB3 protocol ports.
1052 if (!hub_is_superspeed(hdev)) {
1053 clear_port_feature(hdev, port1,
1054 USB_PORT_FEAT_ENABLE);
1055 portstatus &= ~USB_PORT_STAT_ENABLE;
1057 /* Pretend that power was lost for USB3 devs */
1058 portstatus &= ~USB_PORT_STAT_ENABLE;
1062 /* Clear status-change flags; we'll debounce later */
1063 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1064 need_debounce_delay = true;
1065 clear_port_feature(hub->hdev, port1,
1066 USB_PORT_FEAT_C_CONNECTION);
1068 if (portchange & USB_PORT_STAT_C_ENABLE) {
1069 need_debounce_delay = true;
1070 clear_port_feature(hub->hdev, port1,
1071 USB_PORT_FEAT_C_ENABLE);
1073 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
1074 hub_is_superspeed(hub->hdev)) {
1075 need_debounce_delay = true;
1076 clear_port_feature(hub->hdev, port1,
1077 USB_PORT_FEAT_C_BH_PORT_RESET);
1079 /* We can forget about a "removed" device when there's a
1080 * physical disconnect or the connect status changes.
1082 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
1083 (portchange & USB_PORT_STAT_C_CONNECTION))
1084 clear_bit(port1, hub->removed_bits);
1086 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
1087 /* Tell khubd to disconnect the device or
1088 * check for a new connection
1090 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1091 set_bit(port1, hub->change_bits);
1093 } else if (portstatus & USB_PORT_STAT_ENABLE) {
1094 bool port_resumed = (portstatus &
1095 USB_PORT_STAT_LINK_STATE) ==
1097 /* The power session apparently survived the resume.
1098 * If there was an overcurrent or suspend change
1099 * (i.e., remote wakeup request), have khubd
1100 * take care of it. Look at the port link state
1101 * for USB 3.0 hubs, since they don't have a suspend
1102 * change bit, and they don't set the port link change
1103 * bit on device-initiated resume.
1105 if (portchange || (hub_is_superspeed(hub->hdev) &&
1107 set_bit(port1, hub->change_bits);
1109 } else if (udev->persist_enabled) {
1111 udev->reset_resume = 1;
1113 set_bit(port1, hub->change_bits);
1116 /* The power session is gone; tell khubd */
1117 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1118 set_bit(port1, hub->change_bits);
1122 /* If no port-status-change flags were set, we don't need any
1123 * debouncing. If flags were set we can try to debounce the
1124 * ports all at once right now, instead of letting khubd do them
1125 * one at a time later on.
1127 * If any port-status changes do occur during this delay, khubd
1128 * will see them later and handle them normally.
1130 if (need_debounce_delay) {
1131 delay = HUB_DEBOUNCE_STABLE;
1133 /* Don't do a long sleep inside a workqueue routine */
1134 if (type == HUB_INIT2) {
1135 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func3);
1136 schedule_delayed_work(&hub->init_work,
1137 msecs_to_jiffies(delay));
1138 return; /* Continues at init3: below */
1146 status = usb_submit_urb(hub->urb, GFP_NOIO);
1148 dev_err(hub->intfdev, "activate --> %d\n", status);
1149 if (hub->has_indicators && blinkenlights)
1150 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
1152 /* Scan all ports that need attention */
1155 /* Allow autosuspend if it was suppressed */
1156 if (type <= HUB_INIT3)
1157 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
1160 /* Implement the continuations for the delays above */
1161 static void hub_init_func2(struct work_struct *ws)
1163 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1165 hub_activate(hub, HUB_INIT2);
1168 static void hub_init_func3(struct work_struct *ws)
1170 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1172 hub_activate(hub, HUB_INIT3);
1175 enum hub_quiescing_type {
1176 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
1179 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
1181 struct usb_device *hdev = hub->hdev;
1184 cancel_delayed_work_sync(&hub->init_work);
1186 /* khubd and related activity won't re-trigger */
1189 if (type != HUB_SUSPEND) {
1190 /* Disconnect all the children */
1191 for (i = 0; i < hdev->maxchild; ++i) {
1192 if (hdev->children[i])
1193 usb_disconnect(&hdev->children[i]);
1197 /* Stop khubd and related activity */
1198 usb_kill_urb(hub->urb);
1199 if (hub->has_indicators)
1200 cancel_delayed_work_sync(&hub->leds);
1202 cancel_work_sync(&hub->tt.clear_work);
1205 /* caller has locked the hub device */
1206 static int hub_pre_reset(struct usb_interface *intf)
1208 struct usb_hub *hub = usb_get_intfdata(intf);
1210 hub_quiesce(hub, HUB_PRE_RESET);
1214 /* caller has locked the hub device */
1215 static int hub_post_reset(struct usb_interface *intf)
1217 struct usb_hub *hub = usb_get_intfdata(intf);
1219 hub_activate(hub, HUB_POST_RESET);
1223 static int hub_configure(struct usb_hub *hub,
1224 struct usb_endpoint_descriptor *endpoint)
1226 struct usb_hcd *hcd;
1227 struct usb_device *hdev = hub->hdev;
1228 struct device *hub_dev = hub->intfdev;
1229 u16 hubstatus, hubchange;
1230 u16 wHubCharacteristics;
1233 char *message = "out of memory";
1235 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
1241 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1246 mutex_init(&hub->status_mutex);
1248 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1249 if (!hub->descriptor) {
1254 /* Request the entire hub descriptor.
1255 * hub->descriptor can handle USB_MAXCHILDREN ports,
1256 * but the hub can/will return fewer bytes here.
1258 ret = get_hub_descriptor(hdev, hub->descriptor);
1260 message = "can't read hub descriptor";
1262 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
1263 message = "hub has too many ports!";
1268 hdev->maxchild = hub->descriptor->bNbrPorts;
1269 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
1270 (hdev->maxchild == 1) ? "" : "s");
1272 hdev->children = kzalloc(hdev->maxchild *
1273 sizeof(struct usb_device *), GFP_KERNEL);
1274 hub->port_owners = kzalloc(hdev->maxchild * sizeof(struct dev_state *),
1276 if (!hdev->children || !hub->port_owners) {
1281 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1283 /* FIXME for USB 3.0, skip for now */
1284 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1285 !(hub_is_superspeed(hdev))) {
1287 char portstr [USB_MAXCHILDREN + 1];
1289 for (i = 0; i < hdev->maxchild; i++)
1290 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1291 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1293 portstr[hdev->maxchild] = 0;
1294 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1296 dev_dbg(hub_dev, "standalone hub\n");
1298 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1299 case HUB_CHAR_COMMON_LPSM:
1300 dev_dbg(hub_dev, "ganged power switching\n");
1302 case HUB_CHAR_INDV_PORT_LPSM:
1303 dev_dbg(hub_dev, "individual port power switching\n");
1305 case HUB_CHAR_NO_LPSM:
1307 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1311 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1312 case HUB_CHAR_COMMON_OCPM:
1313 dev_dbg(hub_dev, "global over-current protection\n");
1315 case HUB_CHAR_INDV_PORT_OCPM:
1316 dev_dbg(hub_dev, "individual port over-current protection\n");
1318 case HUB_CHAR_NO_OCPM:
1320 dev_dbg(hub_dev, "no over-current protection\n");
1324 spin_lock_init (&hub->tt.lock);
1325 INIT_LIST_HEAD (&hub->tt.clear_list);
1326 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1327 switch (hdev->descriptor.bDeviceProtocol) {
1330 case USB_HUB_PR_HS_SINGLE_TT:
1331 dev_dbg(hub_dev, "Single TT\n");
1334 case USB_HUB_PR_HS_MULTI_TT:
1335 ret = usb_set_interface(hdev, 0, 1);
1337 dev_dbg(hub_dev, "TT per port\n");
1340 dev_err(hub_dev, "Using single TT (err %d)\n",
1345 /* USB 3.0 hubs don't have a TT */
1348 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1349 hdev->descriptor.bDeviceProtocol);
1353 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1354 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1355 case HUB_TTTT_8_BITS:
1356 if (hdev->descriptor.bDeviceProtocol != 0) {
1357 hub->tt.think_time = 666;
1358 dev_dbg(hub_dev, "TT requires at most %d "
1359 "FS bit times (%d ns)\n",
1360 8, hub->tt.think_time);
1363 case HUB_TTTT_16_BITS:
1364 hub->tt.think_time = 666 * 2;
1365 dev_dbg(hub_dev, "TT requires at most %d "
1366 "FS bit times (%d ns)\n",
1367 16, hub->tt.think_time);
1369 case HUB_TTTT_24_BITS:
1370 hub->tt.think_time = 666 * 3;
1371 dev_dbg(hub_dev, "TT requires at most %d "
1372 "FS bit times (%d ns)\n",
1373 24, hub->tt.think_time);
1375 case HUB_TTTT_32_BITS:
1376 hub->tt.think_time = 666 * 4;
1377 dev_dbg(hub_dev, "TT requires at most %d "
1378 "FS bit times (%d ns)\n",
1379 32, hub->tt.think_time);
1383 /* probe() zeroes hub->indicator[] */
1384 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1385 hub->has_indicators = 1;
1386 dev_dbg(hub_dev, "Port indicators are supported\n");
1389 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1390 hub->descriptor->bPwrOn2PwrGood * 2);
1392 /* power budgeting mostly matters with bus-powered hubs,
1393 * and battery-powered root hubs (may provide just 8 mA).
1395 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1397 message = "can't get hub status";
1400 le16_to_cpus(&hubstatus);
1401 if (hdev == hdev->bus->root_hub) {
1402 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
1403 hub->mA_per_port = 500;
1405 hub->mA_per_port = hdev->bus_mA;
1406 hub->limited_power = 1;
1408 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1409 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1410 hub->descriptor->bHubContrCurrent);
1411 hub->limited_power = 1;
1412 if (hdev->maxchild > 0) {
1413 int remaining = hdev->bus_mA -
1414 hub->descriptor->bHubContrCurrent;
1416 if (remaining < hdev->maxchild * 100)
1418 "insufficient power available "
1419 "to use all downstream ports\n");
1420 hub->mA_per_port = 100; /* 7.2.1.1 */
1422 } else { /* Self-powered external hub */
1423 /* FIXME: What about battery-powered external hubs that
1424 * provide less current per port? */
1425 hub->mA_per_port = 500;
1427 if (hub->mA_per_port < 500)
1428 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1431 /* Update the HCD's internal representation of this hub before khubd
1432 * starts getting port status changes for devices under the hub.
1434 hcd = bus_to_hcd(hdev->bus);
1435 if (hcd->driver->update_hub_device) {
1436 ret = hcd->driver->update_hub_device(hcd, hdev,
1437 &hub->tt, GFP_KERNEL);
1439 message = "can't update HCD hub info";
1444 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1446 message = "can't get hub status";
1450 /* local power status reports aren't always correct */
1451 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1452 dev_dbg(hub_dev, "local power source is %s\n",
1453 (hubstatus & HUB_STATUS_LOCAL_POWER)
1454 ? "lost (inactive)" : "good");
1456 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1457 dev_dbg(hub_dev, "%sover-current condition exists\n",
1458 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1460 /* set up the interrupt endpoint
1461 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1462 * bytes as USB2.0[11.12.3] says because some hubs are known
1463 * to send more data (and thus cause overflow). For root hubs,
1464 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1465 * to be big enough for at least USB_MAXCHILDREN ports. */
1466 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1467 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1469 if (maxp > sizeof(*hub->buffer))
1470 maxp = sizeof(*hub->buffer);
1472 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1478 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1479 hub, endpoint->bInterval);
1481 /* maybe cycle the hub leds */
1482 if (hub->has_indicators && blinkenlights)
1483 hub->indicator [0] = INDICATOR_CYCLE;
1485 hub_activate(hub, HUB_INIT);
1489 dev_err (hub_dev, "config failed, %s (err %d)\n",
1491 /* hub_disconnect() frees urb and descriptor */
1495 static void hub_release(struct kref *kref)
1497 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1499 usb_put_intf(to_usb_interface(hub->intfdev));
1503 static unsigned highspeed_hubs;
1505 static void hub_disconnect(struct usb_interface *intf)
1507 struct usb_hub *hub = usb_get_intfdata(intf);
1508 struct usb_device *hdev = interface_to_usbdev(intf);
1510 /* Take the hub off the event list and don't let it be added again */
1511 spin_lock_irq(&hub_event_lock);
1512 if (!list_empty(&hub->event_list)) {
1513 list_del_init(&hub->event_list);
1514 usb_autopm_put_interface_no_suspend(intf);
1516 hub->disconnected = 1;
1517 spin_unlock_irq(&hub_event_lock);
1519 /* Disconnect all children and quiesce the hub */
1521 hub_quiesce(hub, HUB_DISCONNECT);
1523 usb_set_intfdata (intf, NULL);
1524 hub->hdev->maxchild = 0;
1526 if (hub->hdev->speed == USB_SPEED_HIGH)
1529 usb_free_urb(hub->urb);
1530 kfree(hdev->children);
1531 kfree(hub->port_owners);
1532 kfree(hub->descriptor);
1536 kref_put(&hub->kref, hub_release);
1539 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1541 struct usb_host_interface *desc;
1542 struct usb_endpoint_descriptor *endpoint;
1543 struct usb_device *hdev;
1544 struct usb_hub *hub;
1546 desc = intf->cur_altsetting;
1547 hdev = interface_to_usbdev(intf);
1549 /* Hubs have proper suspend/resume support. */
1550 usb_enable_autosuspend(hdev);
1552 if (hdev->level == MAX_TOPO_LEVEL) {
1554 "Unsupported bus topology: hub nested too deep\n");
1558 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1560 dev_warn(&intf->dev, "ignoring external hub\n");
1565 /* Some hubs have a subclass of 1, which AFAICT according to the */
1566 /* specs is not defined, but it works */
1567 if ((desc->desc.bInterfaceSubClass != 0) &&
1568 (desc->desc.bInterfaceSubClass != 1)) {
1570 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1574 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1575 if (desc->desc.bNumEndpoints != 1)
1576 goto descriptor_error;
1578 endpoint = &desc->endpoint[0].desc;
1580 /* If it's not an interrupt in endpoint, we'd better punt! */
1581 if (!usb_endpoint_is_int_in(endpoint))
1582 goto descriptor_error;
1584 /* We found a hub */
1585 dev_info (&intf->dev, "USB hub found\n");
1587 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1589 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1593 kref_init(&hub->kref);
1594 INIT_LIST_HEAD(&hub->event_list);
1595 hub->intfdev = &intf->dev;
1597 INIT_DELAYED_WORK(&hub->leds, led_work);
1598 INIT_DELAYED_WORK(&hub->init_work, NULL);
1601 usb_set_intfdata (intf, hub);
1602 intf->needs_remote_wakeup = 1;
1604 if (hdev->speed == USB_SPEED_HIGH)
1607 if (hub_configure(hub, endpoint) >= 0)
1610 hub_disconnect (intf);
1615 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1617 struct usb_device *hdev = interface_to_usbdev (intf);
1619 /* assert ifno == 0 (part of hub spec) */
1621 case USBDEVFS_HUB_PORTINFO: {
1622 struct usbdevfs_hub_portinfo *info = user_data;
1625 spin_lock_irq(&device_state_lock);
1626 if (hdev->devnum <= 0)
1629 info->nports = hdev->maxchild;
1630 for (i = 0; i < info->nports; i++) {
1631 if (hdev->children[i] == NULL)
1635 hdev->children[i]->devnum;
1638 spin_unlock_irq(&device_state_lock);
1640 return info->nports + 1;
1649 * Allow user programs to claim ports on a hub. When a device is attached
1650 * to one of these "claimed" ports, the program will "own" the device.
1652 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1653 struct dev_state ***ppowner)
1655 if (hdev->state == USB_STATE_NOTATTACHED)
1657 if (port1 == 0 || port1 > hdev->maxchild)
1660 /* This assumes that devices not managed by the hub driver
1661 * will always have maxchild equal to 0.
1663 *ppowner = &(hdev_to_hub(hdev)->port_owners[port1 - 1]);
1667 /* In the following three functions, the caller must hold hdev's lock */
1668 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
1669 struct dev_state *owner)
1672 struct dev_state **powner;
1674 rc = find_port_owner(hdev, port1, &powner);
1683 int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
1684 struct dev_state *owner)
1687 struct dev_state **powner;
1689 rc = find_port_owner(hdev, port1, &powner);
1692 if (*powner != owner)
1698 void usb_hub_release_all_ports(struct usb_device *hdev, struct dev_state *owner)
1701 struct dev_state **powner;
1703 n = find_port_owner(hdev, 1, &powner);
1705 for (; n < hdev->maxchild; (++n, ++powner)) {
1706 if (*powner == owner)
1712 /* The caller must hold udev's lock */
1713 bool usb_device_is_owned(struct usb_device *udev)
1715 struct usb_hub *hub;
1717 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1719 hub = hdev_to_hub(udev->parent);
1720 return !!hub->port_owners[udev->portnum - 1];
1724 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1728 for (i = 0; i < udev->maxchild; ++i) {
1729 if (udev->children[i])
1730 recursively_mark_NOTATTACHED(udev->children[i]);
1732 if (udev->state == USB_STATE_SUSPENDED)
1733 udev->active_duration -= jiffies;
1734 udev->state = USB_STATE_NOTATTACHED;
1738 * usb_set_device_state - change a device's current state (usbcore, hcds)
1739 * @udev: pointer to device whose state should be changed
1740 * @new_state: new state value to be stored
1742 * udev->state is _not_ fully protected by the device lock. Although
1743 * most transitions are made only while holding the lock, the state can
1744 * can change to USB_STATE_NOTATTACHED at almost any time. This
1745 * is so that devices can be marked as disconnected as soon as possible,
1746 * without having to wait for any semaphores to be released. As a result,
1747 * all changes to any device's state must be protected by the
1748 * device_state_lock spinlock.
1750 * Once a device has been added to the device tree, all changes to its state
1751 * should be made using this routine. The state should _not_ be set directly.
1753 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1754 * Otherwise udev->state is set to new_state, and if new_state is
1755 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1756 * to USB_STATE_NOTATTACHED.
1758 void usb_set_device_state(struct usb_device *udev,
1759 enum usb_device_state new_state)
1761 unsigned long flags;
1764 spin_lock_irqsave(&device_state_lock, flags);
1765 if (udev->state == USB_STATE_NOTATTACHED)
1767 else if (new_state != USB_STATE_NOTATTACHED) {
1769 /* root hub wakeup capabilities are managed out-of-band
1770 * and may involve silicon errata ... ignore them here.
1773 if (udev->state == USB_STATE_SUSPENDED
1774 || new_state == USB_STATE_SUSPENDED)
1775 ; /* No change to wakeup settings */
1776 else if (new_state == USB_STATE_CONFIGURED)
1777 wakeup = udev->actconfig->desc.bmAttributes
1778 & USB_CONFIG_ATT_WAKEUP;
1782 if (udev->state == USB_STATE_SUSPENDED &&
1783 new_state != USB_STATE_SUSPENDED)
1784 udev->active_duration -= jiffies;
1785 else if (new_state == USB_STATE_SUSPENDED &&
1786 udev->state != USB_STATE_SUSPENDED)
1787 udev->active_duration += jiffies;
1788 udev->state = new_state;
1790 recursively_mark_NOTATTACHED(udev);
1791 spin_unlock_irqrestore(&device_state_lock, flags);
1793 device_set_wakeup_capable(&udev->dev, wakeup);
1795 EXPORT_SYMBOL_GPL(usb_set_device_state);
1798 * Choose a device number.
1800 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1801 * USB-2.0 buses they are also used as device addresses, however on
1802 * USB-3.0 buses the address is assigned by the controller hardware
1803 * and it usually is not the same as the device number.
1805 * WUSB devices are simple: they have no hubs behind, so the mapping
1806 * device <-> virtual port number becomes 1:1. Why? to simplify the
1807 * life of the device connection logic in
1808 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1809 * handshake we need to assign a temporary address in the unauthorized
1810 * space. For simplicity we use the first virtual port number found to
1811 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1812 * and that becomes it's address [X < 128] or its unauthorized address
1815 * We add 1 as an offset to the one-based USB-stack port number
1816 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1817 * 0 is reserved by USB for default address; (b) Linux's USB stack
1818 * uses always #1 for the root hub of the controller. So USB stack's
1819 * port #1, which is wusb virtual-port #0 has address #2.
1821 * Devices connected under xHCI are not as simple. The host controller
1822 * supports virtualization, so the hardware assigns device addresses and
1823 * the HCD must setup data structures before issuing a set address
1824 * command to the hardware.
1826 static void choose_devnum(struct usb_device *udev)
1829 struct usb_bus *bus = udev->bus;
1831 /* If khubd ever becomes multithreaded, this will need a lock */
1833 devnum = udev->portnum + 1;
1834 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
1836 /* Try to allocate the next devnum beginning at
1837 * bus->devnum_next. */
1838 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1841 devnum = find_next_zero_bit(bus->devmap.devicemap,
1843 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1846 set_bit(devnum, bus->devmap.devicemap);
1847 udev->devnum = devnum;
1851 static void release_devnum(struct usb_device *udev)
1853 if (udev->devnum > 0) {
1854 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1859 static void update_devnum(struct usb_device *udev, int devnum)
1861 /* The address for a WUSB device is managed by wusbcore. */
1863 udev->devnum = devnum;
1866 static void hub_free_dev(struct usb_device *udev)
1868 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1870 /* Root hubs aren't real devices, so don't free HCD resources */
1871 if (hcd->driver->free_dev && udev->parent)
1872 hcd->driver->free_dev(hcd, udev);
1876 * usb_disconnect - disconnect a device (usbcore-internal)
1877 * @pdev: pointer to device being disconnected
1878 * Context: !in_interrupt ()
1880 * Something got disconnected. Get rid of it and all of its children.
1882 * If *pdev is a normal device then the parent hub must already be locked.
1883 * If *pdev is a root hub then this routine will acquire the
1884 * usb_bus_list_lock on behalf of the caller.
1886 * Only hub drivers (including virtual root hub drivers for host
1887 * controllers) should ever call this.
1889 * This call is synchronous, and may not be used in an interrupt context.
1891 void usb_disconnect(struct usb_device **pdev)
1893 struct usb_device *udev = *pdev;
1896 /* mark the device as inactive, so any further urb submissions for
1897 * this device (and any of its children) will fail immediately.
1898 * this quiesces everything except pending urbs.
1900 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1901 dev_info(&udev->dev, "USB disconnect, device number %d\n",
1904 usb_lock_device(udev);
1906 /* Free up all the children before we remove this device */
1907 for (i = 0; i < udev->maxchild; i++) {
1908 if (udev->children[i])
1909 usb_disconnect(&udev->children[i]);
1912 /* deallocate hcd/hardware state ... nuking all pending urbs and
1913 * cleaning up all state associated with the current configuration
1914 * so that the hardware is now fully quiesced.
1916 dev_dbg (&udev->dev, "unregistering device\n");
1917 usb_disable_device(udev, 0);
1918 usb_hcd_synchronize_unlinks(udev);
1920 usb_remove_ep_devs(&udev->ep0);
1921 usb_unlock_device(udev);
1923 /* Unregister the device. The device driver is responsible
1924 * for de-configuring the device and invoking the remove-device
1925 * notifier chain (used by usbfs and possibly others).
1927 device_del(&udev->dev);
1929 /* Free the device number and delete the parent's children[]
1930 * (or root_hub) pointer.
1932 release_devnum(udev);
1934 /* Avoid races with recursively_mark_NOTATTACHED() */
1935 spin_lock_irq(&device_state_lock);
1937 spin_unlock_irq(&device_state_lock);
1941 put_device(&udev->dev);
1944 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
1945 static void show_string(struct usb_device *udev, char *id, char *string)
1949 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1952 static void announce_device(struct usb_device *udev)
1954 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
1955 le16_to_cpu(udev->descriptor.idVendor),
1956 le16_to_cpu(udev->descriptor.idProduct));
1957 dev_info(&udev->dev,
1958 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
1959 udev->descriptor.iManufacturer,
1960 udev->descriptor.iProduct,
1961 udev->descriptor.iSerialNumber);
1962 show_string(udev, "Product", udev->product);
1963 show_string(udev, "Manufacturer", udev->manufacturer);
1964 show_string(udev, "SerialNumber", udev->serial);
1967 static inline void announce_device(struct usb_device *udev) { }
1970 #ifdef CONFIG_USB_OTG
1971 #include "otg_whitelist.h"
1975 * usb_enumerate_device_otg - FIXME (usbcore-internal)
1976 * @udev: newly addressed device (in ADDRESS state)
1978 * Finish enumeration for On-The-Go devices
1980 static int usb_enumerate_device_otg(struct usb_device *udev)
1984 #ifdef CONFIG_USB_OTG
1986 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1987 * to wake us after we've powered off VBUS; and HNP, switching roles
1988 * "host" to "peripheral". The OTG descriptor helps figure this out.
1990 if (!udev->bus->is_b_host
1992 && udev->parent == udev->bus->root_hub) {
1993 struct usb_otg_descriptor *desc = NULL;
1994 struct usb_bus *bus = udev->bus;
1996 /* descriptor may appear anywhere in config */
1997 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1998 le16_to_cpu(udev->config[0].desc.wTotalLength),
1999 USB_DT_OTG, (void **) &desc) == 0) {
2000 if (desc->bmAttributes & USB_OTG_HNP) {
2001 unsigned port1 = udev->portnum;
2003 dev_info(&udev->dev,
2004 "Dual-Role OTG device on %sHNP port\n",
2005 (port1 == bus->otg_port)
2008 /* enable HNP before suspend, it's simpler */
2009 if (port1 == bus->otg_port)
2010 bus->b_hnp_enable = 1;
2011 err = usb_control_msg(udev,
2012 usb_sndctrlpipe(udev, 0),
2013 USB_REQ_SET_FEATURE, 0,
2015 ? USB_DEVICE_B_HNP_ENABLE
2016 : USB_DEVICE_A_ALT_HNP_SUPPORT,
2017 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
2019 /* OTG MESSAGE: report errors here,
2020 * customize to match your product.
2022 dev_info(&udev->dev,
2023 "can't set HNP mode: %d\n",
2025 bus->b_hnp_enable = 0;
2031 if (!is_targeted(udev)) {
2033 /* Maybe it can talk to us, though we can't talk to it.
2034 * (Includes HNP test device.)
2036 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
2037 err = usb_port_suspend(udev, PMSG_SUSPEND);
2039 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
2051 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2052 * @udev: newly addressed device (in ADDRESS state)
2054 * This is only called by usb_new_device() and usb_authorize_device()
2055 * and FIXME -- all comments that apply to them apply here wrt to
2058 * If the device is WUSB and not authorized, we don't attempt to read
2059 * the string descriptors, as they will be errored out by the device
2060 * until it has been authorized.
2062 static int usb_enumerate_device(struct usb_device *udev)
2066 if (udev->config == NULL) {
2067 err = usb_get_configuration(udev);
2069 dev_err(&udev->dev, "can't read configurations, error %d\n",
2074 if (udev->wusb == 1 && udev->authorized == 0) {
2075 udev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2076 udev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2077 udev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2080 /* read the standard strings and cache them if present */
2081 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
2082 udev->manufacturer = usb_cache_string(udev,
2083 udev->descriptor.iManufacturer);
2084 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
2086 err = usb_enumerate_device_otg(udev);
2091 static void set_usb_port_removable(struct usb_device *udev)
2093 struct usb_device *hdev = udev->parent;
2094 struct usb_hub *hub;
2095 u8 port = udev->portnum;
2096 u16 wHubCharacteristics;
2097 bool removable = true;
2102 hub = hdev_to_hub(udev->parent);
2104 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2106 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
2109 if (hub_is_superspeed(hdev)) {
2110 if (hub->descriptor->u.ss.DeviceRemovable & (1 << port))
2113 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
2118 udev->removable = USB_DEVICE_REMOVABLE;
2120 udev->removable = USB_DEVICE_FIXED;
2124 * usb_new_device - perform initial device setup (usbcore-internal)
2125 * @udev: newly addressed device (in ADDRESS state)
2127 * This is called with devices which have been detected but not fully
2128 * enumerated. The device descriptor is available, but not descriptors
2129 * for any device configuration. The caller must have locked either
2130 * the parent hub (if udev is a normal device) or else the
2131 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
2132 * udev has already been installed, but udev is not yet visible through
2133 * sysfs or other filesystem code.
2135 * It will return if the device is configured properly or not. Zero if
2136 * the interface was registered with the driver core; else a negative
2139 * This call is synchronous, and may not be used in an interrupt context.
2141 * Only the hub driver or root-hub registrar should ever call this.
2143 int usb_new_device(struct usb_device *udev)
2148 /* Initialize non-root-hub device wakeup to disabled;
2149 * device (un)configuration controls wakeup capable
2150 * sysfs power/wakeup controls wakeup enabled/disabled
2152 device_init_wakeup(&udev->dev, 0);
2155 /* Tell the runtime-PM framework the device is active */
2156 pm_runtime_set_active(&udev->dev);
2157 pm_runtime_get_noresume(&udev->dev);
2158 pm_runtime_use_autosuspend(&udev->dev);
2159 pm_runtime_enable(&udev->dev);
2161 /* By default, forbid autosuspend for all devices. It will be
2162 * allowed for hubs during binding.
2164 usb_disable_autosuspend(udev);
2166 err = usb_enumerate_device(udev); /* Read descriptors */
2169 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
2170 udev->devnum, udev->bus->busnum,
2171 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2172 /* export the usbdev device-node for libusb */
2173 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
2174 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2176 /* Tell the world! */
2177 announce_device(udev);
2179 device_enable_async_suspend(&udev->dev);
2182 * check whether the hub marks this port as non-removable. Do it
2183 * now so that platform-specific data can override it in
2187 set_usb_port_removable(udev);
2189 /* Register the device. The device driver is responsible
2190 * for configuring the device and invoking the add-device
2191 * notifier chain (used by usbfs and possibly others).
2193 err = device_add(&udev->dev);
2195 dev_err(&udev->dev, "can't device_add, error %d\n", err);
2199 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
2200 usb_mark_last_busy(udev);
2201 pm_runtime_put_sync_autosuspend(&udev->dev);
2205 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2206 pm_runtime_disable(&udev->dev);
2207 pm_runtime_set_suspended(&udev->dev);
2213 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2214 * @usb_dev: USB device
2216 * Move the USB device to a very basic state where interfaces are disabled
2217 * and the device is in fact unconfigured and unusable.
2219 * We share a lock (that we have) with device_del(), so we need to
2222 int usb_deauthorize_device(struct usb_device *usb_dev)
2224 usb_lock_device(usb_dev);
2225 if (usb_dev->authorized == 0)
2226 goto out_unauthorized;
2228 usb_dev->authorized = 0;
2229 usb_set_configuration(usb_dev, -1);
2231 kfree(usb_dev->product);
2232 usb_dev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2233 kfree(usb_dev->manufacturer);
2234 usb_dev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2235 kfree(usb_dev->serial);
2236 usb_dev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2238 usb_destroy_configuration(usb_dev);
2239 usb_dev->descriptor.bNumConfigurations = 0;
2242 usb_unlock_device(usb_dev);
2247 int usb_authorize_device(struct usb_device *usb_dev)
2251 usb_lock_device(usb_dev);
2252 if (usb_dev->authorized == 1)
2253 goto out_authorized;
2255 result = usb_autoresume_device(usb_dev);
2257 dev_err(&usb_dev->dev,
2258 "can't autoresume for authorization: %d\n", result);
2259 goto error_autoresume;
2261 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2263 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2264 "authorization: %d\n", result);
2265 goto error_device_descriptor;
2268 kfree(usb_dev->product);
2269 usb_dev->product = NULL;
2270 kfree(usb_dev->manufacturer);
2271 usb_dev->manufacturer = NULL;
2272 kfree(usb_dev->serial);
2273 usb_dev->serial = NULL;
2275 usb_dev->authorized = 1;
2276 result = usb_enumerate_device(usb_dev);
2278 goto error_enumerate;
2279 /* Choose and set the configuration. This registers the interfaces
2280 * with the driver core and lets interface drivers bind to them.
2282 c = usb_choose_configuration(usb_dev);
2284 result = usb_set_configuration(usb_dev, c);
2286 dev_err(&usb_dev->dev,
2287 "can't set config #%d, error %d\n", c, result);
2288 /* This need not be fatal. The user can try to
2289 * set other configurations. */
2292 dev_info(&usb_dev->dev, "authorized to connect\n");
2295 error_device_descriptor:
2296 usb_autosuspend_device(usb_dev);
2299 usb_unlock_device(usb_dev); // complements locktree
2304 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2305 static unsigned hub_is_wusb(struct usb_hub *hub)
2307 struct usb_hcd *hcd;
2308 if (hub->hdev->parent != NULL) /* not a root hub? */
2310 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
2311 return hcd->wireless;
2315 #define PORT_RESET_TRIES 5
2316 #define SET_ADDRESS_TRIES 2
2317 #define GET_DESCRIPTOR_TRIES 2
2318 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2319 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2321 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2322 #define HUB_SHORT_RESET_TIME 10
2323 #define HUB_BH_RESET_TIME 50
2324 #define HUB_LONG_RESET_TIME 200
2325 #define HUB_RESET_TIMEOUT 500
2327 static int hub_port_reset(struct usb_hub *hub, int port1,
2328 struct usb_device *udev, unsigned int delay, bool warm);
2330 /* Is a USB 3.0 port in the Inactive state? */
2331 static bool hub_port_inactive(struct usb_hub *hub, u16 portstatus)
2333 return hub_is_superspeed(hub->hdev) &&
2334 (portstatus & USB_PORT_STAT_LINK_STATE) ==
2335 USB_SS_PORT_LS_SS_INACTIVE;
2338 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2339 struct usb_device *udev, unsigned int delay, bool warm)
2341 int delay_time, ret;
2345 for (delay_time = 0;
2346 delay_time < HUB_RESET_TIMEOUT;
2347 delay_time += delay) {
2348 /* wait to give the device a chance to reset */
2351 /* read and decode port status */
2352 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2357 * Some buggy devices require a warm reset to be issued even
2358 * when the port appears not to be connected.
2362 * Some buggy devices can cause an NEC host controller
2363 * to transition to the "Error" state after a hot port
2364 * reset. This will show up as the port state in
2365 * "Inactive", and the port may also report a
2366 * disconnect. Forcing a warm port reset seems to make
2369 * See https://bugzilla.kernel.org/show_bug.cgi?id=41752
2371 if (hub_port_inactive(hub, portstatus)) {
2374 if ((portchange & USB_PORT_STAT_C_CONNECTION))
2375 clear_port_feature(hub->hdev, port1,
2376 USB_PORT_FEAT_C_CONNECTION);
2377 if (portchange & USB_PORT_STAT_C_LINK_STATE)
2378 clear_port_feature(hub->hdev, port1,
2379 USB_PORT_FEAT_C_PORT_LINK_STATE);
2380 if (portchange & USB_PORT_STAT_C_RESET)
2381 clear_port_feature(hub->hdev, port1,
2382 USB_PORT_FEAT_C_RESET);
2383 dev_dbg(hub->intfdev, "hot reset failed, warm reset port %d\n",
2385 ret = hub_port_reset(hub, port1,
2386 udev, HUB_BH_RESET_TIME,
2388 if ((portchange & USB_PORT_STAT_C_CONNECTION))
2389 clear_port_feature(hub->hdev, port1,
2390 USB_PORT_FEAT_C_CONNECTION);
2393 /* Device went away? */
2394 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2397 /* bomb out completely if the connection bounced */
2398 if ((portchange & USB_PORT_STAT_C_CONNECTION))
2401 /* if we`ve finished resetting, then break out of
2404 if (!(portstatus & USB_PORT_STAT_RESET) &&
2405 (portstatus & USB_PORT_STAT_ENABLE)) {
2406 if (hub_is_wusb(hub))
2407 udev->speed = USB_SPEED_WIRELESS;
2408 else if (hub_is_superspeed(hub->hdev))
2409 udev->speed = USB_SPEED_SUPER;
2410 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2411 udev->speed = USB_SPEED_HIGH;
2412 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2413 udev->speed = USB_SPEED_LOW;
2415 udev->speed = USB_SPEED_FULL;
2419 if (portchange & USB_PORT_STAT_C_BH_RESET)
2423 /* switch to the long delay after two short delay failures */
2424 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2425 delay = HUB_LONG_RESET_TIME;
2427 dev_dbg (hub->intfdev,
2428 "port %d not %sreset yet, waiting %dms\n",
2429 port1, warm ? "warm " : "", delay);
2435 static void hub_port_finish_reset(struct usb_hub *hub, int port1,
2436 struct usb_device *udev, int *status, bool warm)
2441 struct usb_hcd *hcd;
2442 /* TRSTRCY = 10 ms; plus some extra */
2444 update_devnum(udev, 0);
2445 hcd = bus_to_hcd(udev->bus);
2446 if (hcd->driver->reset_device) {
2447 *status = hcd->driver->reset_device(hcd, udev);
2449 dev_err(&udev->dev, "Cannot reset "
2450 "HCD device state\n");
2458 clear_port_feature(hub->hdev,
2459 port1, USB_PORT_FEAT_C_RESET);
2460 /* FIXME need disconnect() for NOTATTACHED device */
2462 clear_port_feature(hub->hdev, port1,
2463 USB_PORT_FEAT_C_BH_PORT_RESET);
2464 clear_port_feature(hub->hdev, port1,
2465 USB_PORT_FEAT_C_PORT_LINK_STATE);
2467 usb_set_device_state(udev, *status
2468 ? USB_STATE_NOTATTACHED
2469 : USB_STATE_DEFAULT);
2475 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2476 static int hub_port_reset(struct usb_hub *hub, int port1,
2477 struct usb_device *udev, unsigned int delay, bool warm)
2482 /* Block EHCI CF initialization during the port reset.
2483 * Some companion controllers don't like it when they mix.
2485 down_read(&ehci_cf_port_reset_rwsem);
2487 if (!hub_is_superspeed(hub->hdev)) {
2488 dev_err(hub->intfdev, "only USB3 hub support "
2494 /* Reset the port */
2495 for (i = 0; i < PORT_RESET_TRIES; i++) {
2496 status = set_port_feature(hub->hdev, port1, (warm ?
2497 USB_PORT_FEAT_BH_PORT_RESET :
2498 USB_PORT_FEAT_RESET));
2500 dev_err(hub->intfdev,
2501 "cannot %sreset port %d (err = %d)\n",
2502 warm ? "warm " : "", port1, status);
2504 status = hub_port_wait_reset(hub, port1, udev, delay,
2506 if (status && status != -ENOTCONN)
2507 dev_dbg(hub->intfdev,
2508 "port_wait_reset: err = %d\n",
2512 /* return on disconnect or reset */
2513 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2514 hub_port_finish_reset(hub, port1, udev, &status, warm);
2518 dev_dbg (hub->intfdev,
2519 "port %d not enabled, trying %sreset again...\n",
2520 port1, warm ? "warm " : "");
2521 delay = HUB_LONG_RESET_TIME;
2524 dev_err (hub->intfdev,
2525 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2530 up_read(&ehci_cf_port_reset_rwsem);
2535 /* Check if a port is power on */
2536 static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2540 if (hub_is_superspeed(hub->hdev)) {
2541 if (portstatus & USB_SS_PORT_STAT_POWER)
2544 if (portstatus & USB_PORT_STAT_POWER)
2553 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2554 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
2558 if (hub_is_superspeed(hub->hdev)) {
2559 if ((portstatus & USB_PORT_STAT_LINK_STATE)
2560 == USB_SS_PORT_LS_U3)
2563 if (portstatus & USB_PORT_STAT_SUSPEND)
2570 /* Determine whether the device on a port is ready for a normal resume,
2571 * is ready for a reset-resume, or should be disconnected.
2573 static int check_port_resume_type(struct usb_device *udev,
2574 struct usb_hub *hub, int port1,
2575 int status, unsigned portchange, unsigned portstatus)
2577 /* Is the device still present? */
2578 if (status || port_is_suspended(hub, portstatus) ||
2579 !port_is_power_on(hub, portstatus) ||
2580 !(portstatus & USB_PORT_STAT_CONNECTION)) {
2585 /* Can't do a normal resume if the port isn't enabled,
2586 * so try a reset-resume instead.
2588 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2589 if (udev->persist_enabled)
2590 udev->reset_resume = 1;
2596 dev_dbg(hub->intfdev,
2597 "port %d status %04x.%04x after resume, %d\n",
2598 port1, portchange, portstatus, status);
2599 } else if (udev->reset_resume) {
2601 /* Late port handoff can set status-change bits */
2602 if (portchange & USB_PORT_STAT_C_CONNECTION)
2603 clear_port_feature(hub->hdev, port1,
2604 USB_PORT_FEAT_C_CONNECTION);
2605 if (portchange & USB_PORT_STAT_C_ENABLE)
2606 clear_port_feature(hub->hdev, port1,
2607 USB_PORT_FEAT_C_ENABLE);
2613 #ifdef CONFIG_USB_SUSPEND
2616 * usb_port_suspend - suspend a usb device's upstream port
2617 * @udev: device that's no longer in active use, not a root hub
2618 * Context: must be able to sleep; device not locked; pm locks held
2620 * Suspends a USB device that isn't in active use, conserving power.
2621 * Devices may wake out of a suspend, if anything important happens,
2622 * using the remote wakeup mechanism. They may also be taken out of
2623 * suspend by the host, using usb_port_resume(). It's also routine
2624 * to disconnect devices while they are suspended.
2626 * This only affects the USB hardware for a device; its interfaces
2627 * (and, for hubs, child devices) must already have been suspended.
2629 * Selective port suspend reduces power; most suspended devices draw
2630 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2631 * All devices below the suspended port are also suspended.
2633 * Devices leave suspend state when the host wakes them up. Some devices
2634 * also support "remote wakeup", where the device can activate the USB
2635 * tree above them to deliver data, such as a keypress or packet. In
2636 * some cases, this wakes the USB host.
2638 * Suspending OTG devices may trigger HNP, if that's been enabled
2639 * between a pair of dual-role devices. That will change roles, such
2640 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2642 * Devices on USB hub ports have only one "suspend" state, corresponding
2643 * to ACPI D2, "may cause the device to lose some context".
2644 * State transitions include:
2646 * - suspend, resume ... when the VBUS power link stays live
2647 * - suspend, disconnect ... VBUS lost
2649 * Once VBUS drop breaks the circuit, the port it's using has to go through
2650 * normal re-enumeration procedures, starting with enabling VBUS power.
2651 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2652 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2653 * timer, no SRP, no requests through sysfs.
2655 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
2656 * the root hub for their bus goes into global suspend ... so we don't
2657 * (falsely) update the device power state to say it suspended.
2659 * Returns 0 on success, else negative errno.
2661 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2663 struct usb_hub *hub = hdev_to_hub(udev->parent);
2664 int port1 = udev->portnum;
2667 /* enable remote wakeup when appropriate; this lets the device
2668 * wake up the upstream hub (including maybe the root hub).
2670 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2671 * we don't explicitly enable it here.
2673 if (udev->do_remote_wakeup) {
2674 if (!hub_is_superspeed(hub->hdev)) {
2675 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2676 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2677 USB_DEVICE_REMOTE_WAKEUP, 0,
2679 USB_CTRL_SET_TIMEOUT);
2681 /* Assume there's only one function on the USB 3.0
2682 * device and enable remote wake for the first
2683 * interface. FIXME if the interface association
2684 * descriptor shows there's more than one function.
2686 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2687 USB_REQ_SET_FEATURE,
2688 USB_RECIP_INTERFACE,
2689 USB_INTRF_FUNC_SUSPEND,
2690 USB_INTRF_FUNC_SUSPEND_RW |
2691 USB_INTRF_FUNC_SUSPEND_LP,
2693 USB_CTRL_SET_TIMEOUT);
2696 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
2698 /* bail if autosuspend is requested */
2699 if (PMSG_IS_AUTO(msg))
2704 /* disable USB2 hardware LPM */
2705 if (udev->usb2_hw_lpm_enabled == 1)
2706 usb_set_usb2_hardware_lpm(udev, 0);
2708 if (usb_unlocked_disable_lpm(udev)) {
2709 dev_err(&udev->dev, "%s Failed to disable LPM before suspend\n.",
2715 if (hub_is_superspeed(hub->hdev))
2716 status = set_port_feature(hub->hdev,
2717 port1 | (USB_SS_PORT_LS_U3 << 3),
2718 USB_PORT_FEAT_LINK_STATE);
2720 status = set_port_feature(hub->hdev, port1,
2721 USB_PORT_FEAT_SUSPEND);
2723 dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
2725 /* paranoia: "should not happen" */
2726 if (udev->do_remote_wakeup)
2727 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2728 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2729 USB_DEVICE_REMOTE_WAKEUP, 0,
2731 USB_CTRL_SET_TIMEOUT);
2733 /* Try to enable USB2 hardware LPM again */
2734 if (udev->usb2_hw_lpm_capable == 1)
2735 usb_set_usb2_hardware_lpm(udev, 1);
2737 /* Try to enable USB3 LPM again */
2738 usb_unlocked_enable_lpm(udev);
2740 /* System sleep transitions should never fail */
2741 if (!PMSG_IS_AUTO(msg))
2744 /* device has up to 10 msec to fully suspend */
2745 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
2746 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
2747 udev->do_remote_wakeup);
2748 usb_set_device_state(udev, USB_STATE_SUSPENDED);
2751 usb_mark_last_busy(hub->hdev);
2756 * If the USB "suspend" state is in use (rather than "global suspend"),
2757 * many devices will be individually taken out of suspend state using
2758 * special "resume" signaling. This routine kicks in shortly after
2759 * hardware resume signaling is finished, either because of selective
2760 * resume (by host) or remote wakeup (by device) ... now see what changed
2761 * in the tree that's rooted at this device.
2763 * If @udev->reset_resume is set then the device is reset before the
2764 * status check is done.
2766 static int finish_port_resume(struct usb_device *udev)
2771 /* caller owns the udev device lock */
2772 dev_dbg(&udev->dev, "%s\n",
2773 udev->reset_resume ? "finish reset-resume" : "finish resume");
2775 /* usb ch9 identifies four variants of SUSPENDED, based on what
2776 * state the device resumes to. Linux currently won't see the
2777 * first two on the host side; they'd be inside hub_port_init()
2778 * during many timeouts, but khubd can't suspend until later.
2780 usb_set_device_state(udev, udev->actconfig
2781 ? USB_STATE_CONFIGURED
2782 : USB_STATE_ADDRESS);
2784 /* 10.5.4.5 says not to reset a suspended port if the attached
2785 * device is enabled for remote wakeup. Hence the reset
2786 * operation is carried out here, after the port has been
2789 if (udev->reset_resume)
2791 status = usb_reset_and_verify_device(udev);
2793 /* 10.5.4.5 says be sure devices in the tree are still there.
2794 * For now let's assume the device didn't go crazy on resume,
2795 * and device drivers will know about any resume quirks.
2799 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
2801 status = (status > 0 ? 0 : -ENODEV);
2803 /* If a normal resume failed, try doing a reset-resume */
2804 if (status && !udev->reset_resume && udev->persist_enabled) {
2805 dev_dbg(&udev->dev, "retry with reset-resume\n");
2806 udev->reset_resume = 1;
2807 goto retry_reset_resume;
2812 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
2814 } else if (udev->actconfig) {
2815 le16_to_cpus(&devstatus);
2816 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) {
2817 status = usb_control_msg(udev,
2818 usb_sndctrlpipe(udev, 0),
2819 USB_REQ_CLEAR_FEATURE,
2821 USB_DEVICE_REMOTE_WAKEUP, 0,
2823 USB_CTRL_SET_TIMEOUT);
2826 "disable remote wakeup, status %d\n",
2835 * usb_port_resume - re-activate a suspended usb device's upstream port
2836 * @udev: device to re-activate, not a root hub
2837 * Context: must be able to sleep; device not locked; pm locks held
2839 * This will re-activate the suspended device, increasing power usage
2840 * while letting drivers communicate again with its endpoints.
2841 * USB resume explicitly guarantees that the power session between
2842 * the host and the device is the same as it was when the device
2845 * If @udev->reset_resume is set then this routine won't check that the
2846 * port is still enabled. Furthermore, finish_port_resume() above will
2847 * reset @udev. The end result is that a broken power session can be
2848 * recovered and @udev will appear to persist across a loss of VBUS power.
2850 * For example, if a host controller doesn't maintain VBUS suspend current
2851 * during a system sleep or is reset when the system wakes up, all the USB
2852 * power sessions below it will be broken. This is especially troublesome
2853 * for mass-storage devices containing mounted filesystems, since the
2854 * device will appear to have disconnected and all the memory mappings
2855 * to it will be lost. Using the USB_PERSIST facility, the device can be
2856 * made to appear as if it had not disconnected.
2858 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
2859 * every effort to insure that the same device is present after the
2860 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
2861 * quite possible for a device to remain unaltered but its media to be
2862 * changed. If the user replaces a flash memory card while the system is
2863 * asleep, he will have only himself to blame when the filesystem on the
2864 * new card is corrupted and the system crashes.
2866 * Returns 0 on success, else negative errno.
2868 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
2870 struct usb_hub *hub = hdev_to_hub(udev->parent);
2871 int port1 = udev->portnum;
2873 u16 portchange, portstatus;
2875 /* Skip the initial Clear-Suspend step for a remote wakeup */
2876 status = hub_port_status(hub, port1, &portstatus, &portchange);
2877 if (status == 0 && !port_is_suspended(hub, portstatus))
2878 goto SuspendCleared;
2880 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
2882 set_bit(port1, hub->busy_bits);
2884 /* see 7.1.7.7; affects power usage, but not budgeting */
2885 if (hub_is_superspeed(hub->hdev))
2886 status = set_port_feature(hub->hdev,
2887 port1 | (USB_SS_PORT_LS_U0 << 3),
2888 USB_PORT_FEAT_LINK_STATE);
2890 status = clear_port_feature(hub->hdev,
2891 port1, USB_PORT_FEAT_SUSPEND);
2893 dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
2896 /* drive resume for at least 20 msec */
2897 dev_dbg(&udev->dev, "usb %sresume\n",
2898 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
2901 /* Virtual root hubs can trigger on GET_PORT_STATUS to
2902 * stop resume signaling. Then finish the resume
2905 status = hub_port_status(hub, port1, &portstatus, &portchange);
2907 /* TRSMRCY = 10 msec */
2913 if (hub_is_superspeed(hub->hdev)) {
2914 if (portchange & USB_PORT_STAT_C_LINK_STATE)
2915 clear_port_feature(hub->hdev, port1,
2916 USB_PORT_FEAT_C_PORT_LINK_STATE);
2918 if (portchange & USB_PORT_STAT_C_SUSPEND)
2919 clear_port_feature(hub->hdev, port1,
2920 USB_PORT_FEAT_C_SUSPEND);
2924 clear_bit(port1, hub->busy_bits);
2926 status = check_port_resume_type(udev,
2927 hub, port1, status, portchange, portstatus);
2929 status = finish_port_resume(udev);
2931 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2932 hub_port_logical_disconnect(hub, port1);
2934 /* Try to enable USB2 hardware LPM */
2935 if (udev->usb2_hw_lpm_capable == 1)
2936 usb_set_usb2_hardware_lpm(udev, 1);
2938 /* Try to enable USB3 LPM */
2939 usb_unlocked_enable_lpm(udev);
2945 /* caller has locked udev */
2946 int usb_remote_wakeup(struct usb_device *udev)
2950 if (udev->state == USB_STATE_SUSPENDED) {
2951 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
2952 status = usb_autoresume_device(udev);
2954 /* Let the drivers do their thing, then... */
2955 usb_autosuspend_device(udev);
2961 #else /* CONFIG_USB_SUSPEND */
2963 /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
2965 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2970 /* However we may need to do a reset-resume */
2972 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
2974 struct usb_hub *hub = hdev_to_hub(udev->parent);
2975 int port1 = udev->portnum;
2977 u16 portchange, portstatus;
2979 status = hub_port_status(hub, port1, &portstatus, &portchange);
2980 status = check_port_resume_type(udev,
2981 hub, port1, status, portchange, portstatus);
2984 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2985 hub_port_logical_disconnect(hub, port1);
2986 } else if (udev->reset_resume) {
2987 dev_dbg(&udev->dev, "reset-resume\n");
2988 status = usb_reset_and_verify_device(udev);
2995 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
2997 struct usb_hub *hub = usb_get_intfdata (intf);
2998 struct usb_device *hdev = hub->hdev;
3002 /* Warn if children aren't already suspended */
3003 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3004 struct usb_device *udev;
3006 udev = hdev->children [port1-1];
3007 if (udev && udev->can_submit) {
3008 dev_warn(&intf->dev, "port %d nyet suspended\n", port1);
3009 if (PMSG_IS_AUTO(msg))
3013 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
3014 /* Enable hub to send remote wakeup for all ports. */
3015 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3016 status = set_port_feature(hdev,
3018 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
3019 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
3020 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
3021 USB_PORT_FEAT_REMOTE_WAKE_MASK);
3025 dev_dbg(&intf->dev, "%s\n", __func__);
3027 /* stop khubd and related activity */
3028 hub_quiesce(hub, HUB_SUSPEND);
3032 static int hub_resume(struct usb_interface *intf)
3034 struct usb_hub *hub = usb_get_intfdata(intf);
3036 dev_dbg(&intf->dev, "%s\n", __func__);
3037 hub_activate(hub, HUB_RESUME);
3041 static int hub_reset_resume(struct usb_interface *intf)
3043 struct usb_hub *hub = usb_get_intfdata(intf);
3045 dev_dbg(&intf->dev, "%s\n", __func__);
3046 hub_activate(hub, HUB_RESET_RESUME);
3051 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3052 * @rhdev: struct usb_device for the root hub
3054 * The USB host controller driver calls this function when its root hub
3055 * is resumed and Vbus power has been interrupted or the controller
3056 * has been reset. The routine marks @rhdev as having lost power.
3057 * When the hub driver is resumed it will take notice and carry out
3058 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3059 * the others will be disconnected.
3061 void usb_root_hub_lost_power(struct usb_device *rhdev)
3063 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
3064 rhdev->reset_resume = 1;
3066 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
3068 static const char * const usb3_lpm_names[] = {
3076 * Send a Set SEL control transfer to the device, prior to enabling
3077 * device-initiated U1 or U2. This lets the device know the exit latencies from
3078 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3079 * packet from the host.
3081 * This function will fail if the SEL or PEL values for udev are greater than
3082 * the maximum allowed values for the link state to be enabled.
3084 static int usb_req_set_sel(struct usb_device *udev, enum usb3_link_state state)
3086 struct usb_set_sel_req *sel_values;
3087 unsigned long long u1_sel;
3088 unsigned long long u1_pel;
3089 unsigned long long u2_sel;
3090 unsigned long long u2_pel;
3093 /* Convert SEL and PEL stored in ns to us */
3094 u1_sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
3095 u1_pel = DIV_ROUND_UP(udev->u1_params.pel, 1000);
3096 u2_sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
3097 u2_pel = DIV_ROUND_UP(udev->u2_params.pel, 1000);
3100 * Make sure that the calculated SEL and PEL values for the link
3101 * state we're enabling aren't bigger than the max SEL/PEL
3102 * value that will fit in the SET SEL control transfer.
3103 * Otherwise the device would get an incorrect idea of the exit
3104 * latency for the link state, and could start a device-initiated
3105 * U1/U2 when the exit latencies are too high.
3107 if ((state == USB3_LPM_U1 &&
3108 (u1_sel > USB3_LPM_MAX_U1_SEL_PEL ||
3109 u1_pel > USB3_LPM_MAX_U1_SEL_PEL)) ||
3110 (state == USB3_LPM_U2 &&
3111 (u2_sel > USB3_LPM_MAX_U2_SEL_PEL ||
3112 u2_pel > USB3_LPM_MAX_U2_SEL_PEL))) {
3113 dev_dbg(&udev->dev, "Device-initiated %s disabled due "
3114 "to long SEL %llu ms or PEL %llu ms\n",
3115 usb3_lpm_names[state], u1_sel, u1_pel);
3120 * If we're enabling device-initiated LPM for one link state,
3121 * but the other link state has a too high SEL or PEL value,
3122 * just set those values to the max in the Set SEL request.
3124 if (u1_sel > USB3_LPM_MAX_U1_SEL_PEL)
3125 u1_sel = USB3_LPM_MAX_U1_SEL_PEL;
3127 if (u1_pel > USB3_LPM_MAX_U1_SEL_PEL)
3128 u1_pel = USB3_LPM_MAX_U1_SEL_PEL;
3130 if (u2_sel > USB3_LPM_MAX_U2_SEL_PEL)
3131 u2_sel = USB3_LPM_MAX_U2_SEL_PEL;
3133 if (u2_pel > USB3_LPM_MAX_U2_SEL_PEL)
3134 u2_pel = USB3_LPM_MAX_U2_SEL_PEL;
3137 * usb_enable_lpm() can be called as part of a failed device reset,
3138 * which may be initiated by an error path of a mass storage driver.
3139 * Therefore, use GFP_NOIO.
3141 sel_values = kmalloc(sizeof *(sel_values), GFP_NOIO);
3145 sel_values->u1_sel = u1_sel;
3146 sel_values->u1_pel = u1_pel;
3147 sel_values->u2_sel = cpu_to_le16(u2_sel);
3148 sel_values->u2_pel = cpu_to_le16(u2_pel);
3150 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3154 sel_values, sizeof *(sel_values),
3155 USB_CTRL_SET_TIMEOUT);
3161 * Enable or disable device-initiated U1 or U2 transitions.
3163 static int usb_set_device_initiated_lpm(struct usb_device *udev,
3164 enum usb3_link_state state, bool enable)
3171 feature = USB_DEVICE_U1_ENABLE;
3174 feature = USB_DEVICE_U2_ENABLE;
3177 dev_warn(&udev->dev, "%s: Can't %s non-U1 or U2 state.\n",
3178 __func__, enable ? "enable" : "disable");
3182 if (udev->state != USB_STATE_CONFIGURED) {
3183 dev_dbg(&udev->dev, "%s: Can't %s %s state "
3184 "for unconfigured device.\n",
3185 __func__, enable ? "enable" : "disable",
3186 usb3_lpm_names[state]);
3192 * First, let the device know about the exit latencies
3193 * associated with the link state we're about to enable.
3195 ret = usb_req_set_sel(udev, state);
3197 dev_warn(&udev->dev, "Set SEL for device-initiated "
3198 "%s failed.\n", usb3_lpm_names[state]);
3202 * Now send the control transfer to enable device-initiated LPM
3203 * for either U1 or U2.
3205 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3206 USB_REQ_SET_FEATURE,
3210 USB_CTRL_SET_TIMEOUT);
3212 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3213 USB_REQ_CLEAR_FEATURE,
3217 USB_CTRL_SET_TIMEOUT);
3220 dev_warn(&udev->dev, "%s of device-initiated %s failed.\n",
3221 enable ? "Enable" : "Disable",
3222 usb3_lpm_names[state]);
3228 static int usb_set_lpm_timeout(struct usb_device *udev,
3229 enum usb3_link_state state, int timeout)
3236 feature = USB_PORT_FEAT_U1_TIMEOUT;
3239 feature = USB_PORT_FEAT_U2_TIMEOUT;
3242 dev_warn(&udev->dev, "%s: Can't set timeout for non-U1 or U2 state.\n",
3247 if (state == USB3_LPM_U1 && timeout > USB3_LPM_U1_MAX_TIMEOUT &&
3248 timeout != USB3_LPM_DEVICE_INITIATED) {
3249 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x, "
3250 "which is a reserved value.\n",
3251 usb3_lpm_names[state], timeout);
3255 ret = set_port_feature(udev->parent,
3256 USB_PORT_LPM_TIMEOUT(timeout) | udev->portnum,
3259 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x,"
3260 "error code %i\n", usb3_lpm_names[state],
3264 if (state == USB3_LPM_U1)
3265 udev->u1_params.timeout = timeout;
3267 udev->u2_params.timeout = timeout;
3272 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3275 * We will attempt to enable U1 or U2, but there are no guarantees that the
3276 * control transfers to set the hub timeout or enable device-initiated U1/U2
3277 * will be successful.
3279 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3280 * driver know about it. If that call fails, it should be harmless, and just
3281 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3283 static void usb_enable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3284 enum usb3_link_state state)
3288 /* We allow the host controller to set the U1/U2 timeout internally
3289 * first, so that it can change its schedule to account for the
3290 * additional latency to send data to a device in a lower power
3293 timeout = hcd->driver->enable_usb3_lpm_timeout(hcd, udev, state);
3295 /* xHCI host controller doesn't want to enable this LPM state. */
3300 dev_warn(&udev->dev, "Could not enable %s link state, "
3301 "xHCI error %i.\n", usb3_lpm_names[state],
3306 if (usb_set_lpm_timeout(udev, state, timeout))
3307 /* If we can't set the parent hub U1/U2 timeout,
3308 * device-initiated LPM won't be allowed either, so let the xHCI
3309 * host know that this link state won't be enabled.
3311 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
3313 /* Only a configured device will accept the Set Feature U1/U2_ENABLE */
3314 else if (udev->actconfig)
3315 usb_set_device_initiated_lpm(udev, state, true);
3320 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
3323 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
3324 * If zero is returned, the parent will not allow the link to go into U1/U2.
3326 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
3327 * it won't have an effect on the bus link state because the parent hub will
3328 * still disallow device-initiated U1/U2 entry.
3330 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
3331 * possible. The result will be slightly more bus bandwidth will be taken up
3332 * (to account for U1/U2 exit latency), but it should be harmless.
3334 static int usb_disable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3335 enum usb3_link_state state)
3341 feature = USB_PORT_FEAT_U1_TIMEOUT;
3344 feature = USB_PORT_FEAT_U2_TIMEOUT;
3347 dev_warn(&udev->dev, "%s: Can't disable non-U1 or U2 state.\n",
3352 if (usb_set_lpm_timeout(udev, state, 0))
3355 usb_set_device_initiated_lpm(udev, state, false);
3357 if (hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state))
3358 dev_warn(&udev->dev, "Could not disable xHCI %s timeout, "
3359 "bus schedule bandwidth may be impacted.\n",
3360 usb3_lpm_names[state]);
3365 * Disable hub-initiated and device-initiated U1 and U2 entry.
3366 * Caller must own the bandwidth_mutex.
3368 * This will call usb_enable_lpm() on failure, which will decrement
3369 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
3371 int usb_disable_lpm(struct usb_device *udev)
3373 struct usb_hcd *hcd;
3375 if (!udev || !udev->parent ||
3376 udev->speed != USB_SPEED_SUPER ||
3380 hcd = bus_to_hcd(udev->bus);
3381 if (!hcd || !hcd->driver->disable_usb3_lpm_timeout)
3384 udev->lpm_disable_count++;
3385 if ((udev->u1_params.timeout == 0 && udev->u2_params.timeout == 0))
3388 /* If LPM is enabled, attempt to disable it. */
3389 if (usb_disable_link_state(hcd, udev, USB3_LPM_U1))
3391 if (usb_disable_link_state(hcd, udev, USB3_LPM_U2))
3397 usb_enable_lpm(udev);
3400 EXPORT_SYMBOL_GPL(usb_disable_lpm);
3402 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
3403 int usb_unlocked_disable_lpm(struct usb_device *udev)
3405 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3411 mutex_lock(hcd->bandwidth_mutex);
3412 ret = usb_disable_lpm(udev);
3413 mutex_unlock(hcd->bandwidth_mutex);
3417 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
3420 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
3421 * xHCI host policy may prevent U1 or U2 from being enabled.
3423 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
3424 * until the lpm_disable_count drops to zero. Caller must own the
3427 void usb_enable_lpm(struct usb_device *udev)
3429 struct usb_hcd *hcd;
3431 if (!udev || !udev->parent ||
3432 udev->speed != USB_SPEED_SUPER ||
3436 udev->lpm_disable_count--;
3437 hcd = bus_to_hcd(udev->bus);
3438 /* Double check that we can both enable and disable LPM.
3439 * Device must be configured to accept set feature U1/U2 timeout.
3441 if (!hcd || !hcd->driver->enable_usb3_lpm_timeout ||
3442 !hcd->driver->disable_usb3_lpm_timeout)
3445 if (udev->lpm_disable_count > 0)
3448 usb_enable_link_state(hcd, udev, USB3_LPM_U1);
3449 usb_enable_link_state(hcd, udev, USB3_LPM_U2);
3451 EXPORT_SYMBOL_GPL(usb_enable_lpm);
3453 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
3454 void usb_unlocked_enable_lpm(struct usb_device *udev)
3456 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3461 mutex_lock(hcd->bandwidth_mutex);
3462 usb_enable_lpm(udev);
3463 mutex_unlock(hcd->bandwidth_mutex);
3465 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
3468 #else /* CONFIG_PM */
3470 #define hub_suspend NULL
3471 #define hub_resume NULL
3472 #define hub_reset_resume NULL
3474 int usb_disable_lpm(struct usb_device *udev)
3478 EXPORT_SYMBOL_GPL(usb_disable_lpm);
3480 void usb_enable_lpm(struct usb_device *udev) { }
3481 EXPORT_SYMBOL_GPL(usb_enable_lpm);
3483 int usb_unlocked_disable_lpm(struct usb_device *udev)
3487 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
3489 void usb_unlocked_enable_lpm(struct usb_device *udev) { }
3490 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
3494 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
3496 * Between connect detection and reset signaling there must be a delay
3497 * of 100ms at least for debounce and power-settling. The corresponding
3498 * timer shall restart whenever the downstream port detects a disconnect.
3500 * Apparently there are some bluetooth and irda-dongles and a number of
3501 * low-speed devices for which this debounce period may last over a second.
3502 * Not covered by the spec - but easy to deal with.
3504 * This implementation uses a 1500ms total debounce timeout; if the
3505 * connection isn't stable by then it returns -ETIMEDOUT. It checks
3506 * every 25ms for transient disconnects. When the port status has been
3507 * unchanged for 100ms it returns the port status.
3509 static int hub_port_debounce(struct usb_hub *hub, int port1)
3512 int total_time, stable_time = 0;
3513 u16 portchange, portstatus;
3514 unsigned connection = 0xffff;
3516 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
3517 ret = hub_port_status(hub, port1, &portstatus, &portchange);
3521 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
3522 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
3523 stable_time += HUB_DEBOUNCE_STEP;
3524 if (stable_time >= HUB_DEBOUNCE_STABLE)
3528 connection = portstatus & USB_PORT_STAT_CONNECTION;
3531 if (portchange & USB_PORT_STAT_C_CONNECTION) {
3532 clear_port_feature(hub->hdev, port1,
3533 USB_PORT_FEAT_C_CONNECTION);
3536 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
3538 msleep(HUB_DEBOUNCE_STEP);
3541 dev_dbg (hub->intfdev,
3542 "debounce: port %d: total %dms stable %dms status 0x%x\n",
3543 port1, total_time, stable_time, portstatus);
3545 if (stable_time < HUB_DEBOUNCE_STABLE)
3550 void usb_ep0_reinit(struct usb_device *udev)
3552 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
3553 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
3554 usb_enable_endpoint(udev, &udev->ep0, true);
3556 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
3558 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
3559 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
3561 static int hub_set_address(struct usb_device *udev, int devnum)
3564 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3567 * The host controller will choose the device address,
3568 * instead of the core having chosen it earlier
3570 if (!hcd->driver->address_device && devnum <= 1)
3572 if (udev->state == USB_STATE_ADDRESS)
3574 if (udev->state != USB_STATE_DEFAULT)
3576 if (hcd->driver->address_device)
3577 retval = hcd->driver->address_device(hcd, udev);
3579 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
3580 USB_REQ_SET_ADDRESS, 0, devnum, 0,
3581 NULL, 0, USB_CTRL_SET_TIMEOUT);
3583 update_devnum(udev, devnum);
3584 /* Device now using proper address. */
3585 usb_set_device_state(udev, USB_STATE_ADDRESS);
3586 usb_ep0_reinit(udev);
3591 /* Reset device, (re)assign address, get device descriptor.
3592 * Device connection must be stable, no more debouncing needed.
3593 * Returns device in USB_STATE_ADDRESS, except on error.
3595 * If this is called for an already-existing device (as part of
3596 * usb_reset_and_verify_device), the caller must own the device lock. For a
3597 * newly detected device that is not accessible through any global
3598 * pointers, it's not necessary to lock the device.
3601 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
3604 static DEFINE_MUTEX(usb_address0_mutex);
3606 struct usb_device *hdev = hub->hdev;
3607 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
3609 unsigned delay = HUB_SHORT_RESET_TIME;
3610 enum usb_device_speed oldspeed = udev->speed;
3612 int devnum = udev->devnum;
3614 /* root hub ports have a slightly longer reset period
3615 * (from USB 2.0 spec, section 7.1.7.5)
3617 if (!hdev->parent) {
3618 delay = HUB_ROOT_RESET_TIME;
3619 if (port1 == hdev->bus->otg_port)
3620 hdev->bus->b_hnp_enable = 0;
3623 /* Some low speed devices have problems with the quick delay, so */
3624 /* be a bit pessimistic with those devices. RHbug #23670 */
3625 if (oldspeed == USB_SPEED_LOW)
3626 delay = HUB_LONG_RESET_TIME;
3628 mutex_lock(&usb_address0_mutex);
3630 /* Reset the device; full speed may morph to high speed */
3631 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
3632 retval = hub_port_reset(hub, port1, udev, delay, false);
3633 if (retval < 0) /* error or disconnect */
3635 /* success, speed is known */
3639 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
3640 dev_dbg(&udev->dev, "device reset changed speed!\n");
3643 oldspeed = udev->speed;
3645 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
3646 * it's fixed size except for full speed devices.
3647 * For Wireless USB devices, ep0 max packet is always 512 (tho
3648 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
3650 switch (udev->speed) {
3651 case USB_SPEED_SUPER:
3652 case USB_SPEED_WIRELESS: /* fixed at 512 */
3653 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
3655 case USB_SPEED_HIGH: /* fixed at 64 */
3656 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
3658 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
3659 /* to determine the ep0 maxpacket size, try to read
3660 * the device descriptor to get bMaxPacketSize0 and
3661 * then correct our initial guess.
3663 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
3665 case USB_SPEED_LOW: /* fixed at 8 */
3666 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
3672 if (udev->speed == USB_SPEED_WIRELESS)
3673 speed = "variable speed Wireless";
3675 speed = usb_speed_string(udev->speed);
3677 if (udev->speed != USB_SPEED_SUPER)
3678 dev_info(&udev->dev,
3679 "%s %s USB device number %d using %s\n",
3680 (udev->config) ? "reset" : "new", speed,
3681 devnum, udev->bus->controller->driver->name);
3683 /* Set up TT records, if needed */
3685 udev->tt = hdev->tt;
3686 udev->ttport = hdev->ttport;
3687 } else if (udev->speed != USB_SPEED_HIGH
3688 && hdev->speed == USB_SPEED_HIGH) {
3690 dev_err(&udev->dev, "parent hub has no TT\n");
3694 udev->tt = &hub->tt;
3695 udev->ttport = port1;
3698 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
3699 * Because device hardware and firmware is sometimes buggy in
3700 * this area, and this is how Linux has done it for ages.
3701 * Change it cautiously.
3703 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
3704 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
3705 * so it may help with some non-standards-compliant devices.
3706 * Otherwise we start with SET_ADDRESS and then try to read the
3707 * first 8 bytes of the device descriptor to get the ep0 maxpacket
3710 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
3711 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3)) {
3712 struct usb_device_descriptor *buf;
3715 #define GET_DESCRIPTOR_BUFSIZE 64
3716 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
3722 /* Retry on all errors; some devices are flakey.
3723 * 255 is for WUSB devices, we actually need to use
3724 * 512 (WUSB1.0[4.8.1]).
3726 for (j = 0; j < 3; ++j) {
3727 buf->bMaxPacketSize0 = 0;
3728 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
3729 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
3730 USB_DT_DEVICE << 8, 0,
3731 buf, GET_DESCRIPTOR_BUFSIZE,
3732 initial_descriptor_timeout);
3733 switch (buf->bMaxPacketSize0) {
3734 case 8: case 16: case 32: case 64: case 255:
3735 if (buf->bDescriptorType ==
3749 udev->descriptor.bMaxPacketSize0 =
3750 buf->bMaxPacketSize0;
3753 retval = hub_port_reset(hub, port1, udev, delay, false);
3754 if (retval < 0) /* error or disconnect */
3756 if (oldspeed != udev->speed) {
3758 "device reset changed speed!\n");
3764 "device descriptor read/64, error %d\n",
3769 #undef GET_DESCRIPTOR_BUFSIZE
3773 * If device is WUSB, we already assigned an
3774 * unauthorized address in the Connect Ack sequence;
3775 * authorization will assign the final address.
3777 if (udev->wusb == 0) {
3778 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
3779 retval = hub_set_address(udev, devnum);
3786 "device not accepting address %d, error %d\n",
3790 if (udev->speed == USB_SPEED_SUPER) {
3791 devnum = udev->devnum;
3792 dev_info(&udev->dev,
3793 "%s SuperSpeed USB device number %d using %s\n",
3794 (udev->config) ? "reset" : "new",
3795 devnum, udev->bus->controller->driver->name);
3798 /* cope with hardware quirkiness:
3799 * - let SET_ADDRESS settle, some device hardware wants it
3800 * - read ep0 maxpacket even for high and low speed,
3803 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3))
3807 retval = usb_get_device_descriptor(udev, 8);
3810 "device descriptor read/8, error %d\n",
3823 * Some superspeed devices have finished the link training process
3824 * and attached to a superspeed hub port, but the device descriptor
3825 * got from those devices show they aren't superspeed devices. Warm
3826 * reset the port attached by the devices can fix them.
3828 if ((udev->speed == USB_SPEED_SUPER) &&
3829 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
3830 dev_err(&udev->dev, "got a wrong device descriptor, "
3831 "warm reset device\n");
3832 hub_port_reset(hub, port1, udev,
3833 HUB_BH_RESET_TIME, true);
3838 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
3839 udev->speed == USB_SPEED_SUPER)
3842 i = udev->descriptor.bMaxPacketSize0;
3843 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
3844 if (udev->speed == USB_SPEED_LOW ||
3845 !(i == 8 || i == 16 || i == 32 || i == 64)) {
3846 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
3850 if (udev->speed == USB_SPEED_FULL)
3851 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
3853 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
3854 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
3855 usb_ep0_reinit(udev);
3858 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
3859 if (retval < (signed)sizeof(udev->descriptor)) {
3860 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
3867 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
3868 retval = usb_get_bos_descriptor(udev);
3870 udev->lpm_capable = usb_device_supports_lpm(udev);
3871 usb_set_lpm_parameters(udev);
3876 /* notify HCD that we have a device connected and addressed */
3877 if (hcd->driver->update_device)
3878 hcd->driver->update_device(hcd, udev);
3881 hub_port_disable(hub, port1, 0);
3882 update_devnum(udev, devnum); /* for disconnect processing */
3884 mutex_unlock(&usb_address0_mutex);
3889 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
3891 struct usb_qualifier_descriptor *qual;
3894 qual = kmalloc (sizeof *qual, GFP_KERNEL);
3898 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
3899 qual, sizeof *qual);
3900 if (status == sizeof *qual) {
3901 dev_info(&udev->dev, "not running at top speed; "
3902 "connect to a high speed hub\n");
3903 /* hub LEDs are probably harder to miss than syslog */
3904 if (hub->has_indicators) {
3905 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
3906 schedule_delayed_work (&hub->leds, 0);
3913 hub_power_remaining (struct usb_hub *hub)
3915 struct usb_device *hdev = hub->hdev;
3919 if (!hub->limited_power)
3922 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
3923 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
3924 struct usb_device *udev = hdev->children[port1 - 1];
3930 /* Unconfigured devices may not use more than 100mA,
3931 * or 8mA for OTG ports */
3932 if (udev->actconfig)
3933 delta = udev->actconfig->desc.bMaxPower * 2;
3934 else if (port1 != udev->bus->otg_port || hdev->parent)
3938 if (delta > hub->mA_per_port)
3939 dev_warn(&udev->dev,
3940 "%dmA is over %umA budget for port %d!\n",
3941 delta, hub->mA_per_port, port1);
3944 if (remaining < 0) {
3945 dev_warn(hub->intfdev, "%dmA over power budget!\n",
3952 /* Handle physical or logical connection change events.
3953 * This routine is called when:
3954 * a port connection-change occurs;
3955 * a port enable-change occurs (often caused by EMI);
3956 * usb_reset_and_verify_device() encounters changed descriptors (as from
3957 * a firmware download)
3958 * caller already locked the hub
3960 static void hub_port_connect_change(struct usb_hub *hub, int port1,
3961 u16 portstatus, u16 portchange)
3963 struct usb_device *hdev = hub->hdev;
3964 struct device *hub_dev = hub->intfdev;
3965 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
3966 unsigned wHubCharacteristics =
3967 le16_to_cpu(hub->descriptor->wHubCharacteristics);
3968 struct usb_device *udev;
3972 "port %d, status %04x, change %04x, %s\n",
3973 port1, portstatus, portchange, portspeed(hub, portstatus));
3975 if (hub->has_indicators) {
3976 set_port_led(hub, port1, HUB_LED_AUTO);
3977 hub->indicator[port1-1] = INDICATOR_AUTO;
3980 #ifdef CONFIG_USB_OTG
3981 /* during HNP, don't repeat the debounce */
3982 if (hdev->bus->is_b_host)
3983 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
3984 USB_PORT_STAT_C_ENABLE);
3987 /* Try to resuscitate an existing device */
3988 udev = hdev->children[port1-1];
3989 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
3990 udev->state != USB_STATE_NOTATTACHED) {
3991 usb_lock_device(udev);
3992 if (portstatus & USB_PORT_STAT_ENABLE) {
3993 status = 0; /* Nothing to do */
3995 #ifdef CONFIG_USB_SUSPEND
3996 } else if (udev->state == USB_STATE_SUSPENDED &&
3997 udev->persist_enabled) {
3998 /* For a suspended device, treat this as a
3999 * remote wakeup event.
4001 status = usb_remote_wakeup(udev);
4005 status = -ENODEV; /* Don't resuscitate */
4007 usb_unlock_device(udev);
4010 clear_bit(port1, hub->change_bits);
4015 /* Disconnect any existing devices under this port */
4017 usb_disconnect(&hdev->children[port1-1]);
4018 clear_bit(port1, hub->change_bits);
4020 /* We can forget about a "removed" device when there's a physical
4021 * disconnect or the connect status changes.
4023 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4024 (portchange & USB_PORT_STAT_C_CONNECTION))
4025 clear_bit(port1, hub->removed_bits);
4027 if (portchange & (USB_PORT_STAT_C_CONNECTION |
4028 USB_PORT_STAT_C_ENABLE)) {
4029 status = hub_port_debounce(hub, port1);
4031 if (printk_ratelimit())
4032 dev_err(hub_dev, "connect-debounce failed, "
4033 "port %d disabled\n", port1);
4034 portstatus &= ~USB_PORT_STAT_CONNECTION;
4036 portstatus = status;
4040 /* Return now if debouncing failed or nothing is connected or
4041 * the device was "removed".
4043 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4044 test_bit(port1, hub->removed_bits)) {
4046 /* maybe switch power back on (e.g. root hub was reset) */
4047 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
4048 && !port_is_power_on(hub, portstatus))
4049 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
4051 if (portstatus & USB_PORT_STAT_ENABLE)
4056 for (i = 0; i < SET_CONFIG_TRIES; i++) {
4058 /* reallocate for each attempt, since references
4059 * to the previous one can escape in various ways
4061 udev = usb_alloc_dev(hdev, hdev->bus, port1);
4064 "couldn't allocate port %d usb_device\n",
4069 usb_set_device_state(udev, USB_STATE_POWERED);
4070 udev->bus_mA = hub->mA_per_port;
4071 udev->level = hdev->level + 1;
4072 udev->wusb = hub_is_wusb(hub);
4074 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
4075 if (hub_is_superspeed(hub->hdev))
4076 udev->speed = USB_SPEED_SUPER;
4078 udev->speed = USB_SPEED_UNKNOWN;
4080 choose_devnum(udev);
4081 if (udev->devnum <= 0) {
4082 status = -ENOTCONN; /* Don't retry */
4086 /* reset (non-USB 3.0 devices) and get descriptor */
4087 status = hub_port_init(hub, udev, port1, i);
4091 usb_detect_quirks(udev);
4092 if (udev->quirks & USB_QUIRK_DELAY_INIT)
4095 /* consecutive bus-powered hubs aren't reliable; they can
4096 * violate the voltage drop budget. if the new child has
4097 * a "powered" LED, users should notice we didn't enable it
4098 * (without reading syslog), even without per-port LEDs
4101 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
4102 && udev->bus_mA <= 100) {
4105 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
4108 dev_dbg(&udev->dev, "get status %d ?\n", status);
4111 le16_to_cpus(&devstat);
4112 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
4114 "can't connect bus-powered hub "
4116 if (hub->has_indicators) {
4117 hub->indicator[port1-1] =
4118 INDICATOR_AMBER_BLINK;
4119 schedule_delayed_work (&hub->leds, 0);
4121 status = -ENOTCONN; /* Don't retry */
4126 /* check for devices running slower than they could */
4127 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
4128 && udev->speed == USB_SPEED_FULL
4129 && highspeed_hubs != 0)
4130 check_highspeed (hub, udev, port1);
4132 /* Store the parent's children[] pointer. At this point
4133 * udev becomes globally accessible, although presumably
4134 * no one will look at it until hdev is unlocked.
4138 /* We mustn't add new devices if the parent hub has
4139 * been disconnected; we would race with the
4140 * recursively_mark_NOTATTACHED() routine.
4142 spin_lock_irq(&device_state_lock);
4143 if (hdev->state == USB_STATE_NOTATTACHED)
4146 hdev->children[port1-1] = udev;
4147 spin_unlock_irq(&device_state_lock);
4149 /* Run it through the hoops (find a driver, etc) */
4151 status = usb_new_device(udev);
4153 spin_lock_irq(&device_state_lock);
4154 hdev->children[port1-1] = NULL;
4155 spin_unlock_irq(&device_state_lock);
4162 status = hub_power_remaining(hub);
4164 dev_dbg(hub_dev, "%dmA power budget left\n", status);
4169 hub_port_disable(hub, port1, 1);
4171 usb_ep0_reinit(udev);
4172 release_devnum(udev);
4175 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
4178 if (hub->hdev->parent ||
4179 !hcd->driver->port_handed_over ||
4180 !(hcd->driver->port_handed_over)(hcd, port1))
4181 dev_err(hub_dev, "unable to enumerate USB device on port %d\n",
4185 hub_port_disable(hub, port1, 1);
4186 if (hcd->driver->relinquish_port && !hub->hdev->parent)
4187 hcd->driver->relinquish_port(hcd, port1);
4190 /* Returns 1 if there was a remote wakeup and a connect status change. */
4191 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
4192 u16 portstatus, u16 portchange)
4194 struct usb_device *hdev;
4195 struct usb_device *udev;
4196 int connect_change = 0;
4200 udev = hdev->children[port-1];
4201 if (!hub_is_superspeed(hdev)) {
4202 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
4204 clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
4206 if (!udev || udev->state != USB_STATE_SUSPENDED ||
4207 (portstatus & USB_PORT_STAT_LINK_STATE) !=
4213 /* TRSMRCY = 10 msec */
4216 usb_lock_device(udev);
4217 ret = usb_remote_wakeup(udev);
4218 usb_unlock_device(udev);
4223 hub_port_disable(hub, port, 1);
4225 dev_dbg(hub->intfdev, "resume on port %d, status %d\n",
4227 return connect_change;
4230 static void hub_events(void)
4232 struct list_head *tmp;
4233 struct usb_device *hdev;
4234 struct usb_interface *intf;
4235 struct usb_hub *hub;
4236 struct device *hub_dev;
4242 int connect_change, wakeup_change;
4245 * We restart the list every time to avoid a deadlock with
4246 * deleting hubs downstream from this one. This should be
4247 * safe since we delete the hub from the event list.
4248 * Not the most efficient, but avoids deadlocks.
4252 /* Grab the first entry at the beginning of the list */
4253 spin_lock_irq(&hub_event_lock);
4254 if (list_empty(&hub_event_list)) {
4255 spin_unlock_irq(&hub_event_lock);
4259 tmp = hub_event_list.next;
4262 hub = list_entry(tmp, struct usb_hub, event_list);
4263 kref_get(&hub->kref);
4264 spin_unlock_irq(&hub_event_lock);
4267 hub_dev = hub->intfdev;
4268 intf = to_usb_interface(hub_dev);
4269 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
4270 hdev->state, hub->descriptor
4271 ? hub->descriptor->bNbrPorts
4273 /* NOTE: expects max 15 ports... */
4274 (u16) hub->change_bits[0],
4275 (u16) hub->event_bits[0]);
4277 /* Lock the device, then check to see if we were
4278 * disconnected while waiting for the lock to succeed. */
4279 usb_lock_device(hdev);
4280 if (unlikely(hub->disconnected))
4281 goto loop_disconnected;
4283 /* If the hub has died, clean up after it */
4284 if (hdev->state == USB_STATE_NOTATTACHED) {
4285 hub->error = -ENODEV;
4286 hub_quiesce(hub, HUB_DISCONNECT);
4291 ret = usb_autopm_get_interface(intf);
4293 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
4297 /* If this is an inactive hub, do nothing */
4302 dev_dbg (hub_dev, "resetting for error %d\n",
4305 ret = usb_reset_device(hdev);
4308 "error resetting hub: %d\n", ret);
4316 /* deal with port status changes */
4317 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
4318 if (test_bit(i, hub->busy_bits))
4320 connect_change = test_bit(i, hub->change_bits);
4321 wakeup_change = test_and_clear_bit(i, hub->wakeup_bits);
4322 if (!test_and_clear_bit(i, hub->event_bits) &&
4323 !connect_change && !wakeup_change)
4326 ret = hub_port_status(hub, i,
4327 &portstatus, &portchange);
4331 if (portchange & USB_PORT_STAT_C_CONNECTION) {
4332 clear_port_feature(hdev, i,
4333 USB_PORT_FEAT_C_CONNECTION);
4337 if (portchange & USB_PORT_STAT_C_ENABLE) {
4338 if (!connect_change)
4340 "port %d enable change, "
4343 clear_port_feature(hdev, i,
4344 USB_PORT_FEAT_C_ENABLE);
4347 * EM interference sometimes causes badly
4348 * shielded USB devices to be shutdown by
4349 * the hub, this hack enables them again.
4350 * Works at least with mouse driver.
4352 if (!(portstatus & USB_PORT_STAT_ENABLE)
4354 && hdev->children[i-1]) {
4357 "disabled by hub (EMI?), "
4364 if (hub_handle_remote_wakeup(hub, i,
4365 portstatus, portchange))
4368 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
4372 dev_dbg(hub_dev, "over-current change on port "
4374 clear_port_feature(hdev, i,
4375 USB_PORT_FEAT_C_OVER_CURRENT);
4376 msleep(100); /* Cool down */
4377 hub_power_on(hub, true);
4378 hub_port_status(hub, i, &status, &unused);
4379 if (status & USB_PORT_STAT_OVERCURRENT)
4380 dev_err(hub_dev, "over-current "
4381 "condition on port %d\n", i);
4384 if (portchange & USB_PORT_STAT_C_RESET) {
4386 "reset change on port %d\n",
4388 clear_port_feature(hdev, i,
4389 USB_PORT_FEAT_C_RESET);
4391 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
4392 hub_is_superspeed(hub->hdev)) {
4394 "warm reset change on port %d\n",
4396 clear_port_feature(hdev, i,
4397 USB_PORT_FEAT_C_BH_PORT_RESET);
4399 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
4400 clear_port_feature(hub->hdev, i,
4401 USB_PORT_FEAT_C_PORT_LINK_STATE);
4403 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
4405 "config error on port %d\n",
4407 clear_port_feature(hub->hdev, i,
4408 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
4411 /* Warm reset a USB3 protocol port if it's in
4412 * SS.Inactive state.
4414 if (hub_is_superspeed(hub->hdev) &&
4415 (portstatus & USB_PORT_STAT_LINK_STATE)
4416 == USB_SS_PORT_LS_SS_INACTIVE) {
4417 dev_dbg(hub_dev, "warm reset port %d\n", i);
4418 hub_port_reset(hub, i, NULL,
4419 HUB_BH_RESET_TIME, true);
4423 hub_port_connect_change(hub, i,
4424 portstatus, portchange);
4427 /* deal with hub status changes */
4428 if (test_and_clear_bit(0, hub->event_bits) == 0)
4430 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
4431 dev_err (hub_dev, "get_hub_status failed\n");
4433 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
4434 dev_dbg (hub_dev, "power change\n");
4435 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
4436 if (hubstatus & HUB_STATUS_LOCAL_POWER)
4437 /* FIXME: Is this always true? */
4438 hub->limited_power = 1;
4440 hub->limited_power = 0;
4442 if (hubchange & HUB_CHANGE_OVERCURRENT) {
4446 dev_dbg(hub_dev, "over-current change\n");
4447 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
4448 msleep(500); /* Cool down */
4449 hub_power_on(hub, true);
4450 hub_hub_status(hub, &status, &unused);
4451 if (status & HUB_STATUS_OVERCURRENT)
4452 dev_err(hub_dev, "over-current "
4458 /* Balance the usb_autopm_get_interface() above */
4459 usb_autopm_put_interface_no_suspend(intf);
4461 /* Balance the usb_autopm_get_interface_no_resume() in
4462 * kick_khubd() and allow autosuspend.
4464 usb_autopm_put_interface(intf);
4466 usb_unlock_device(hdev);
4467 kref_put(&hub->kref, hub_release);
4469 } /* end while (1) */
4472 static int hub_thread(void *__unused)
4474 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
4475 * port handover. Otherwise it might see that a full-speed device
4476 * was gone before the EHCI controller had handed its port over to
4477 * the companion full-speed controller.
4483 wait_event_freezable(khubd_wait,
4484 !list_empty(&hub_event_list) ||
4485 kthread_should_stop());
4486 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
4488 pr_debug("%s: khubd exiting\n", usbcore_name);
4492 static const struct usb_device_id hub_id_table[] = {
4493 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
4494 .bDeviceClass = USB_CLASS_HUB},
4495 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
4496 .bInterfaceClass = USB_CLASS_HUB},
4497 { } /* Terminating entry */
4500 MODULE_DEVICE_TABLE (usb, hub_id_table);
4502 static struct usb_driver hub_driver = {
4505 .disconnect = hub_disconnect,
4506 .suspend = hub_suspend,
4507 .resume = hub_resume,
4508 .reset_resume = hub_reset_resume,
4509 .pre_reset = hub_pre_reset,
4510 .post_reset = hub_post_reset,
4511 .unlocked_ioctl = hub_ioctl,
4512 .id_table = hub_id_table,
4513 .supports_autosuspend = 1,
4516 int usb_hub_init(void)
4518 if (usb_register(&hub_driver) < 0) {
4519 printk(KERN_ERR "%s: can't register hub driver\n",
4524 khubd_task = kthread_run(hub_thread, NULL, "khubd");
4525 if (!IS_ERR(khubd_task))
4528 /* Fall through if kernel_thread failed */
4529 usb_deregister(&hub_driver);
4530 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
4535 void usb_hub_cleanup(void)
4537 kthread_stop(khubd_task);
4540 * Hub resources are freed for us by usb_deregister. It calls
4541 * usb_driver_purge on every device which in turn calls that
4542 * devices disconnect function if it is using this driver.
4543 * The hub_disconnect function takes care of releasing the
4544 * individual hub resources. -greg
4546 usb_deregister(&hub_driver);
4547 } /* usb_hub_cleanup() */
4549 static int descriptors_changed(struct usb_device *udev,
4550 struct usb_device_descriptor *old_device_descriptor)
4554 unsigned serial_len = 0;
4556 unsigned old_length;
4560 if (memcmp(&udev->descriptor, old_device_descriptor,
4561 sizeof(*old_device_descriptor)) != 0)
4564 /* Since the idVendor, idProduct, and bcdDevice values in the
4565 * device descriptor haven't changed, we will assume the
4566 * Manufacturer and Product strings haven't changed either.
4567 * But the SerialNumber string could be different (e.g., a
4568 * different flash card of the same brand).
4571 serial_len = strlen(udev->serial) + 1;
4574 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
4575 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
4576 len = max(len, old_length);
4579 buf = kmalloc(len, GFP_NOIO);
4581 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
4582 /* assume the worst */
4585 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
4586 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
4587 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
4589 if (length != old_length) {
4590 dev_dbg(&udev->dev, "config index %d, error %d\n",
4595 if (memcmp (buf, udev->rawdescriptors[index], old_length)
4597 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
4599 ((struct usb_config_descriptor *) buf)->
4600 bConfigurationValue);
4606 if (!changed && serial_len) {
4607 length = usb_string(udev, udev->descriptor.iSerialNumber,
4609 if (length + 1 != serial_len) {
4610 dev_dbg(&udev->dev, "serial string error %d\n",
4613 } else if (memcmp(buf, udev->serial, length) != 0) {
4614 dev_dbg(&udev->dev, "serial string changed\n");
4624 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
4625 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
4627 * WARNING - don't use this routine to reset a composite device
4628 * (one with multiple interfaces owned by separate drivers)!
4629 * Use usb_reset_device() instead.
4631 * Do a port reset, reassign the device's address, and establish its
4632 * former operating configuration. If the reset fails, or the device's
4633 * descriptors change from their values before the reset, or the original
4634 * configuration and altsettings cannot be restored, a flag will be set
4635 * telling khubd to pretend the device has been disconnected and then
4636 * re-connected. All drivers will be unbound, and the device will be
4637 * re-enumerated and probed all over again.
4639 * Returns 0 if the reset succeeded, -ENODEV if the device has been
4640 * flagged for logical disconnection, or some other negative error code
4641 * if the reset wasn't even attempted.
4643 * The caller must own the device lock. For example, it's safe to use
4644 * this from a driver probe() routine after downloading new firmware.
4645 * For calls that might not occur during probe(), drivers should lock
4646 * the device using usb_lock_device_for_reset().
4648 * Locking exception: This routine may also be called from within an
4649 * autoresume handler. Such usage won't conflict with other tasks
4650 * holding the device lock because these tasks should always call
4651 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
4653 static int usb_reset_and_verify_device(struct usb_device *udev)
4655 struct usb_device *parent_hdev = udev->parent;
4656 struct usb_hub *parent_hub;
4657 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4658 struct usb_device_descriptor descriptor = udev->descriptor;
4660 int port1 = udev->portnum;
4662 if (udev->state == USB_STATE_NOTATTACHED ||
4663 udev->state == USB_STATE_SUSPENDED) {
4664 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
4670 /* this requires hcd-specific logic; see ohci_restart() */
4671 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
4674 parent_hub = hdev_to_hub(parent_hdev);
4676 set_bit(port1, parent_hub->busy_bits);
4677 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
4679 /* ep0 maxpacket size may change; let the HCD know about it.
4680 * Other endpoints will be handled by re-enumeration. */
4681 usb_ep0_reinit(udev);
4682 ret = hub_port_init(parent_hub, udev, port1, i);
4683 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
4686 clear_bit(port1, parent_hub->busy_bits);
4691 /* Device might have changed firmware (DFU or similar) */
4692 if (descriptors_changed(udev, &descriptor)) {
4693 dev_info(&udev->dev, "device firmware changed\n");
4694 udev->descriptor = descriptor; /* for disconnect() calls */
4698 /* Restore the device's previous configuration */
4699 if (!udev->actconfig)
4702 mutex_lock(hcd->bandwidth_mutex);
4703 /* Disable LPM while we reset the device and reinstall the alt settings.
4704 * Device-initiated LPM settings, and system exit latency settings are
4705 * cleared when the device is reset, so we have to set them up again.
4707 ret = usb_disable_lpm(udev);
4709 dev_err(&udev->dev, "%s Failed to disable LPM\n.", __func__);
4710 mutex_unlock(hcd->bandwidth_mutex);
4713 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
4715 dev_warn(&udev->dev,
4716 "Busted HC? Not enough HCD resources for "
4717 "old configuration.\n");
4718 usb_enable_lpm(udev);
4719 mutex_unlock(hcd->bandwidth_mutex);
4722 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
4723 USB_REQ_SET_CONFIGURATION, 0,
4724 udev->actconfig->desc.bConfigurationValue, 0,
4725 NULL, 0, USB_CTRL_SET_TIMEOUT);
4728 "can't restore configuration #%d (error=%d)\n",
4729 udev->actconfig->desc.bConfigurationValue, ret);
4730 usb_enable_lpm(udev);
4731 mutex_unlock(hcd->bandwidth_mutex);
4734 mutex_unlock(hcd->bandwidth_mutex);
4735 usb_set_device_state(udev, USB_STATE_CONFIGURED);
4737 /* Put interfaces back into the same altsettings as before.
4738 * Don't bother to send the Set-Interface request for interfaces
4739 * that were already in altsetting 0; besides being unnecessary,
4740 * many devices can't handle it. Instead just reset the host-side
4743 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
4744 struct usb_host_config *config = udev->actconfig;
4745 struct usb_interface *intf = config->interface[i];
4746 struct usb_interface_descriptor *desc;
4748 desc = &intf->cur_altsetting->desc;
4749 if (desc->bAlternateSetting == 0) {
4750 usb_disable_interface(udev, intf, true);
4751 usb_enable_interface(udev, intf, true);
4754 /* Let the bandwidth allocation function know that this
4755 * device has been reset, and it will have to use
4756 * alternate setting 0 as the current alternate setting.
4758 intf->resetting_device = 1;
4759 ret = usb_set_interface(udev, desc->bInterfaceNumber,
4760 desc->bAlternateSetting);
4761 intf->resetting_device = 0;
4764 dev_err(&udev->dev, "failed to restore interface %d "
4765 "altsetting %d (error=%d)\n",
4766 desc->bInterfaceNumber,
4767 desc->bAlternateSetting,
4769 usb_unlocked_enable_lpm(udev);
4774 /* Now that the alt settings are re-installed, enable LPM. */
4775 usb_unlocked_enable_lpm(udev);
4780 hub_port_logical_disconnect(parent_hub, port1);
4785 * usb_reset_device - warn interface drivers and perform a USB port reset
4786 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
4788 * Warns all drivers bound to registered interfaces (using their pre_reset
4789 * method), performs the port reset, and then lets the drivers know that
4790 * the reset is over (using their post_reset method).
4792 * Return value is the same as for usb_reset_and_verify_device().
4794 * The caller must own the device lock. For example, it's safe to use
4795 * this from a driver probe() routine after downloading new firmware.
4796 * For calls that might not occur during probe(), drivers should lock
4797 * the device using usb_lock_device_for_reset().
4799 * If an interface is currently being probed or disconnected, we assume
4800 * its driver knows how to handle resets. For all other interfaces,
4801 * if the driver doesn't have pre_reset and post_reset methods then
4802 * we attempt to unbind it and rebind afterward.
4804 int usb_reset_device(struct usb_device *udev)
4808 struct usb_host_config *config = udev->actconfig;
4810 if (udev->state == USB_STATE_NOTATTACHED ||
4811 udev->state == USB_STATE_SUSPENDED) {
4812 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
4817 /* Prevent autosuspend during the reset */
4818 usb_autoresume_device(udev);
4821 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
4822 struct usb_interface *cintf = config->interface[i];
4823 struct usb_driver *drv;
4826 if (cintf->dev.driver) {
4827 drv = to_usb_driver(cintf->dev.driver);
4828 if (drv->pre_reset && drv->post_reset)
4829 unbind = (drv->pre_reset)(cintf);
4830 else if (cintf->condition ==
4831 USB_INTERFACE_BOUND)
4834 usb_forced_unbind_intf(cintf);
4839 ret = usb_reset_and_verify_device(udev);
4842 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
4843 struct usb_interface *cintf = config->interface[i];
4844 struct usb_driver *drv;
4845 int rebind = cintf->needs_binding;
4847 if (!rebind && cintf->dev.driver) {
4848 drv = to_usb_driver(cintf->dev.driver);
4849 if (drv->post_reset)
4850 rebind = (drv->post_reset)(cintf);
4851 else if (cintf->condition ==
4852 USB_INTERFACE_BOUND)
4855 if (ret == 0 && rebind)
4856 usb_rebind_intf(cintf);
4860 usb_autosuspend_device(udev);
4863 EXPORT_SYMBOL_GPL(usb_reset_device);
4867 * usb_queue_reset_device - Reset a USB device from an atomic context
4868 * @iface: USB interface belonging to the device to reset
4870 * This function can be used to reset a USB device from an atomic
4871 * context, where usb_reset_device() won't work (as it blocks).
4873 * Doing a reset via this method is functionally equivalent to calling
4874 * usb_reset_device(), except for the fact that it is delayed to a
4875 * workqueue. This means that any drivers bound to other interfaces
4876 * might be unbound, as well as users from usbfs in user space.
4880 * - Scheduling two resets at the same time from two different drivers
4881 * attached to two different interfaces of the same device is
4882 * possible; depending on how the driver attached to each interface
4883 * handles ->pre_reset(), the second reset might happen or not.
4885 * - If a driver is unbound and it had a pending reset, the reset will
4888 * - This function can be called during .probe() or .disconnect()
4889 * times. On return from .disconnect(), any pending resets will be
4892 * There is no no need to lock/unlock the @reset_ws as schedule_work()
4895 * NOTE: We don't do any reference count tracking because it is not
4896 * needed. The lifecycle of the work_struct is tied to the
4897 * usb_interface. Before destroying the interface we cancel the
4898 * work_struct, so the fact that work_struct is queued and or
4899 * running means the interface (and thus, the device) exist and
4902 void usb_queue_reset_device(struct usb_interface *iface)
4904 schedule_work(&iface->reset_ws);
4906 EXPORT_SYMBOL_GPL(usb_queue_reset_device);