4 * (C) Copyright 1999 Linus Torvalds
5 * (C) Copyright 1999 Johannes Erdfelt
6 * (C) Copyright 1999 Gregory P. Smith
7 * (C) Copyright 2001 Brad Hards (bhards@bigpond.net.au)
11 #include <linux/kernel.h>
12 #include <linux/errno.h>
13 #include <linux/module.h>
14 #include <linux/moduleparam.h>
15 #include <linux/completion.h>
16 #include <linux/sched.h>
17 #include <linux/list.h>
18 #include <linux/slab.h>
19 #include <linux/ioctl.h>
20 #include <linux/usb.h>
21 #include <linux/usbdevice_fs.h>
22 #include <linux/usb/hcd.h>
23 #include <linux/usb/otg.h>
24 #include <linux/usb/quirks.h>
25 #include <linux/kthread.h>
26 #include <linux/mutex.h>
27 #include <linux/freezer.h>
28 #include <linux/random.h>
30 #include <asm/uaccess.h>
31 #include <asm/byteorder.h>
35 /* if we are in debug mode, always announce new devices */
37 #ifndef CONFIG_USB_ANNOUNCE_NEW_DEVICES
38 #define CONFIG_USB_ANNOUNCE_NEW_DEVICES
43 struct usb_device *child;
45 struct dev_state *port_owner;
46 enum usb_port_connect_type connect_type;
50 struct device *intfdev; /* the "interface" device */
51 struct usb_device *hdev;
53 struct urb *urb; /* for interrupt polling pipe */
55 /* buffer for urb ... with extra space in case of babble */
58 struct usb_hub_status hub;
59 struct usb_port_status port;
60 } *status; /* buffer for status reports */
61 struct mutex status_mutex; /* for the status buffer */
63 int error; /* last reported error */
64 int nerrors; /* track consecutive errors */
66 struct list_head event_list; /* hubs w/data or errs ready */
67 unsigned long event_bits[1]; /* status change bitmask */
68 unsigned long change_bits[1]; /* ports with logical connect
70 unsigned long busy_bits[1]; /* ports being reset or
72 unsigned long removed_bits[1]; /* ports with a "removed"
74 unsigned long wakeup_bits[1]; /* ports that have signaled
76 #if USB_MAXCHILDREN > 31 /* 8*sizeof(unsigned long) - 1 */
77 #error event_bits[] is too short!
80 struct usb_hub_descriptor *descriptor; /* class descriptor */
81 struct usb_tt tt; /* Transaction Translator */
83 unsigned mA_per_port; /* current for each child */
85 unsigned limited_power:1;
87 unsigned disconnected:1;
89 unsigned has_indicators:1;
90 u8 indicator[USB_MAXCHILDREN];
91 struct delayed_work leds;
92 struct delayed_work init_work;
93 struct usb_port **ports;
96 static inline int hub_is_superspeed(struct usb_device *hdev)
98 return (hdev->descriptor.bDeviceProtocol == USB_HUB_PR_SS);
101 /* Protect struct usb_device->state and ->children members
102 * Note: Both are also protected by ->dev.sem, except that ->state can
103 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
104 static DEFINE_SPINLOCK(device_state_lock);
106 /* khubd's worklist and its lock */
107 static DEFINE_SPINLOCK(hub_event_lock);
108 static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
111 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
113 static struct task_struct *khubd_task;
115 /* cycle leds on hubs that aren't blinking for attention */
116 static bool blinkenlights = 0;
117 module_param (blinkenlights, bool, S_IRUGO);
118 MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
121 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
122 * 10 seconds to send reply for the initial 64-byte descriptor request.
124 /* define initial 64-byte descriptor request timeout in milliseconds */
125 static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
126 module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
127 MODULE_PARM_DESC(initial_descriptor_timeout,
128 "initial 64-byte descriptor request timeout in milliseconds "
129 "(default 5000 - 5.0 seconds)");
132 * As of 2.6.10 we introduce a new USB device initialization scheme which
133 * closely resembles the way Windows works. Hopefully it will be compatible
134 * with a wider range of devices than the old scheme. However some previously
135 * working devices may start giving rise to "device not accepting address"
136 * errors; if that happens the user can try the old scheme by adjusting the
137 * following module parameters.
139 * For maximum flexibility there are two boolean parameters to control the
140 * hub driver's behavior. On the first initialization attempt, if the
141 * "old_scheme_first" parameter is set then the old scheme will be used,
142 * otherwise the new scheme is used. If that fails and "use_both_schemes"
143 * is set, then the driver will make another attempt, using the other scheme.
145 static bool old_scheme_first = 0;
146 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
147 MODULE_PARM_DESC(old_scheme_first,
148 "start with the old device initialization scheme");
150 static bool use_both_schemes = 1;
151 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
152 MODULE_PARM_DESC(use_both_schemes,
153 "try the other device initialization scheme if the "
156 /* Mutual exclusion for EHCI CF initialization. This interferes with
157 * port reset on some companion controllers.
159 DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
160 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
162 #define HUB_DEBOUNCE_TIMEOUT 1500
163 #define HUB_DEBOUNCE_STEP 25
164 #define HUB_DEBOUNCE_STABLE 100
166 #define to_usb_port(_dev) \
167 container_of(_dev, struct usb_port, dev)
169 static int usb_reset_and_verify_device(struct usb_device *udev);
171 static inline char *portspeed(struct usb_hub *hub, int portstatus)
173 if (hub_is_superspeed(hub->hdev))
175 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
177 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
183 /* Note that hdev or one of its children must be locked! */
184 static struct usb_hub *hdev_to_hub(struct usb_device *hdev)
186 if (!hdev || !hdev->actconfig || !hdev->maxchild)
188 return usb_get_intfdata(hdev->actconfig->interface[0]);
191 static int usb_device_supports_lpm(struct usb_device *udev)
193 /* USB 2.1 (and greater) devices indicate LPM support through
194 * their USB 2.0 Extended Capabilities BOS descriptor.
196 if (udev->speed == USB_SPEED_HIGH) {
197 if (udev->bos->ext_cap &&
199 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
204 /* All USB 3.0 must support LPM, but we need their max exit latency
205 * information from the SuperSpeed Extended Capabilities BOS descriptor.
207 if (!udev->bos->ss_cap) {
208 dev_warn(&udev->dev, "No LPM exit latency info found. "
209 "Power management will be impacted.\n");
212 if (udev->parent->lpm_capable)
215 dev_warn(&udev->dev, "Parent hub missing LPM exit latency info. "
216 "Power management will be impacted.\n");
221 * Set the Maximum Exit Latency (MEL) for the host to initiate a transition from
224 static void usb_set_lpm_mel(struct usb_device *udev,
225 struct usb3_lpm_parameters *udev_lpm_params,
226 unsigned int udev_exit_latency,
228 struct usb3_lpm_parameters *hub_lpm_params,
229 unsigned int hub_exit_latency)
231 unsigned int total_mel;
232 unsigned int device_mel;
233 unsigned int hub_mel;
236 * Calculate the time it takes to transition all links from the roothub
237 * to the parent hub into U0. The parent hub must then decode the
238 * packet (hub header decode latency) to figure out which port it was
241 * The Hub Header decode latency is expressed in 0.1us intervals (0x1
242 * means 0.1us). Multiply that by 100 to get nanoseconds.
244 total_mel = hub_lpm_params->mel +
245 (hub->descriptor->u.ss.bHubHdrDecLat * 100);
248 * How long will it take to transition the downstream hub's port into
249 * U0? The greater of either the hub exit latency or the device exit
252 * The BOS U1/U2 exit latencies are expressed in 1us intervals.
253 * Multiply that by 1000 to get nanoseconds.
255 device_mel = udev_exit_latency * 1000;
256 hub_mel = hub_exit_latency * 1000;
257 if (device_mel > hub_mel)
258 total_mel += device_mel;
260 total_mel += hub_mel;
262 udev_lpm_params->mel = total_mel;
266 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
267 * a transition from either U1 or U2.
269 static void usb_set_lpm_pel(struct usb_device *udev,
270 struct usb3_lpm_parameters *udev_lpm_params,
271 unsigned int udev_exit_latency,
273 struct usb3_lpm_parameters *hub_lpm_params,
274 unsigned int hub_exit_latency,
275 unsigned int port_to_port_exit_latency)
277 unsigned int first_link_pel;
278 unsigned int hub_pel;
281 * First, the device sends an LFPS to transition the link between the
282 * device and the parent hub into U0. The exit latency is the bigger of
283 * the device exit latency or the hub exit latency.
285 if (udev_exit_latency > hub_exit_latency)
286 first_link_pel = udev_exit_latency * 1000;
288 first_link_pel = hub_exit_latency * 1000;
291 * When the hub starts to receive the LFPS, there is a slight delay for
292 * it to figure out that one of the ports is sending an LFPS. Then it
293 * will forward the LFPS to its upstream link. The exit latency is the
294 * delay, plus the PEL that we calculated for this hub.
296 hub_pel = port_to_port_exit_latency * 1000 + hub_lpm_params->pel;
299 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
300 * is the greater of the two exit latencies.
302 if (first_link_pel > hub_pel)
303 udev_lpm_params->pel = first_link_pel;
305 udev_lpm_params->pel = hub_pel;
309 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
310 * when a device initiates a transition to U0, until when it will receive the
311 * first packet from the host controller.
313 * Section C.1.5.1 describes the four components to this:
315 * - t2: time for the ERDY to make it from the device to the host.
316 * - t3: a host-specific delay to process the ERDY.
317 * - t4: time for the packet to make it from the host to the device.
319 * t3 is specific to both the xHCI host and the platform the host is integrated
320 * into. The Intel HW folks have said it's negligible, FIXME if a different
321 * vendor says otherwise.
323 static void usb_set_lpm_sel(struct usb_device *udev,
324 struct usb3_lpm_parameters *udev_lpm_params)
326 struct usb_device *parent;
327 unsigned int num_hubs;
328 unsigned int total_sel;
330 /* t1 = device PEL */
331 total_sel = udev_lpm_params->pel;
332 /* How many external hubs are in between the device & the root port. */
333 for (parent = udev->parent, num_hubs = 0; parent->parent;
334 parent = parent->parent)
336 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
338 total_sel += 2100 + 250 * (num_hubs - 1);
340 /* t4 = 250ns * num_hubs */
341 total_sel += 250 * num_hubs;
343 udev_lpm_params->sel = total_sel;
346 static void usb_set_lpm_parameters(struct usb_device *udev)
349 unsigned int port_to_port_delay;
350 unsigned int udev_u1_del;
351 unsigned int udev_u2_del;
352 unsigned int hub_u1_del;
353 unsigned int hub_u2_del;
355 if (!udev->lpm_capable || udev->speed != USB_SPEED_SUPER)
358 hub = hdev_to_hub(udev->parent);
359 /* It doesn't take time to transition the roothub into U0, since it
360 * doesn't have an upstream link.
365 udev_u1_del = udev->bos->ss_cap->bU1devExitLat;
366 udev_u2_del = udev->bos->ss_cap->bU2DevExitLat;
367 hub_u1_del = udev->parent->bos->ss_cap->bU1devExitLat;
368 hub_u2_del = udev->parent->bos->ss_cap->bU2DevExitLat;
370 usb_set_lpm_mel(udev, &udev->u1_params, udev_u1_del,
371 hub, &udev->parent->u1_params, hub_u1_del);
373 usb_set_lpm_mel(udev, &udev->u2_params, udev_u2_del,
374 hub, &udev->parent->u2_params, hub_u2_del);
377 * Appendix C, section C.2.2.2, says that there is a slight delay from
378 * when the parent hub notices the downstream port is trying to
379 * transition to U0 to when the hub initiates a U0 transition on its
380 * upstream port. The section says the delays are tPort2PortU1EL and
381 * tPort2PortU2EL, but it doesn't define what they are.
383 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
384 * about the same delays. Use the maximum delay calculations from those
385 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
386 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
387 * assume the device exit latencies they are talking about are the hub
390 * What do we do if the U2 exit latency is less than the U1 exit
391 * latency? It's possible, although not likely...
393 port_to_port_delay = 1;
395 usb_set_lpm_pel(udev, &udev->u1_params, udev_u1_del,
396 hub, &udev->parent->u1_params, hub_u1_del,
399 if (hub_u2_del > hub_u1_del)
400 port_to_port_delay = 1 + hub_u2_del - hub_u1_del;
402 port_to_port_delay = 1 + hub_u1_del;
404 usb_set_lpm_pel(udev, &udev->u2_params, udev_u2_del,
405 hub, &udev->parent->u2_params, hub_u2_del,
408 /* Now that we've got PEL, calculate SEL. */
409 usb_set_lpm_sel(udev, &udev->u1_params);
410 usb_set_lpm_sel(udev, &udev->u2_params);
413 /* USB 2.0 spec Section 11.24.4.5 */
414 static int get_hub_descriptor(struct usb_device *hdev, void *data)
419 if (hub_is_superspeed(hdev)) {
420 dtype = USB_DT_SS_HUB;
421 size = USB_DT_SS_HUB_SIZE;
424 size = sizeof(struct usb_hub_descriptor);
427 for (i = 0; i < 3; i++) {
428 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
429 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
430 dtype << 8, 0, data, size,
431 USB_CTRL_GET_TIMEOUT);
432 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
439 * USB 2.0 spec Section 11.24.2.1
441 static int clear_hub_feature(struct usb_device *hdev, int feature)
443 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
444 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
448 * USB 2.0 spec Section 11.24.2.2
450 static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
452 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
453 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
458 * USB 2.0 spec Section 11.24.2.13
460 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
462 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
463 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
468 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
469 * for info about using port indicators
471 static void set_port_led(
477 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
478 USB_PORT_FEAT_INDICATOR);
480 dev_dbg (hub->intfdev,
481 "port %d indicator %s status %d\n",
483 ({ char *s; switch (selector) {
484 case HUB_LED_AMBER: s = "amber"; break;
485 case HUB_LED_GREEN: s = "green"; break;
486 case HUB_LED_OFF: s = "off"; break;
487 case HUB_LED_AUTO: s = "auto"; break;
488 default: s = "??"; break;
493 #define LED_CYCLE_PERIOD ((2*HZ)/3)
495 static void led_work (struct work_struct *work)
497 struct usb_hub *hub =
498 container_of(work, struct usb_hub, leds.work);
499 struct usb_device *hdev = hub->hdev;
501 unsigned changed = 0;
504 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
507 for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
508 unsigned selector, mode;
510 /* 30%-50% duty cycle */
512 switch (hub->indicator[i]) {
514 case INDICATOR_CYCLE:
516 selector = HUB_LED_AUTO;
517 mode = INDICATOR_AUTO;
519 /* blinking green = sw attention */
520 case INDICATOR_GREEN_BLINK:
521 selector = HUB_LED_GREEN;
522 mode = INDICATOR_GREEN_BLINK_OFF;
524 case INDICATOR_GREEN_BLINK_OFF:
525 selector = HUB_LED_OFF;
526 mode = INDICATOR_GREEN_BLINK;
528 /* blinking amber = hw attention */
529 case INDICATOR_AMBER_BLINK:
530 selector = HUB_LED_AMBER;
531 mode = INDICATOR_AMBER_BLINK_OFF;
533 case INDICATOR_AMBER_BLINK_OFF:
534 selector = HUB_LED_OFF;
535 mode = INDICATOR_AMBER_BLINK;
537 /* blink green/amber = reserved */
538 case INDICATOR_ALT_BLINK:
539 selector = HUB_LED_GREEN;
540 mode = INDICATOR_ALT_BLINK_OFF;
542 case INDICATOR_ALT_BLINK_OFF:
543 selector = HUB_LED_AMBER;
544 mode = INDICATOR_ALT_BLINK;
549 if (selector != HUB_LED_AUTO)
551 set_port_led(hub, i + 1, selector);
552 hub->indicator[i] = mode;
554 if (!changed && blinkenlights) {
556 cursor %= hub->descriptor->bNbrPorts;
557 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
558 hub->indicator[cursor] = INDICATOR_CYCLE;
562 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
565 /* use a short timeout for hub/port status fetches */
566 #define USB_STS_TIMEOUT 1000
567 #define USB_STS_RETRIES 5
570 * USB 2.0 spec Section 11.24.2.6
572 static int get_hub_status(struct usb_device *hdev,
573 struct usb_hub_status *data)
575 int i, status = -ETIMEDOUT;
577 for (i = 0; i < USB_STS_RETRIES &&
578 (status == -ETIMEDOUT || status == -EPIPE); i++) {
579 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
580 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
581 data, sizeof(*data), USB_STS_TIMEOUT);
587 * USB 2.0 spec Section 11.24.2.7
589 static int get_port_status(struct usb_device *hdev, int port1,
590 struct usb_port_status *data)
592 int i, status = -ETIMEDOUT;
594 for (i = 0; i < USB_STS_RETRIES &&
595 (status == -ETIMEDOUT || status == -EPIPE); i++) {
596 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
597 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
598 data, sizeof(*data), USB_STS_TIMEOUT);
603 static int hub_port_status(struct usb_hub *hub, int port1,
604 u16 *status, u16 *change)
608 mutex_lock(&hub->status_mutex);
609 ret = get_port_status(hub->hdev, port1, &hub->status->port);
611 dev_err(hub->intfdev,
612 "%s failed (err = %d)\n", __func__, ret);
616 *status = le16_to_cpu(hub->status->port.wPortStatus);
617 *change = le16_to_cpu(hub->status->port.wPortChange);
621 mutex_unlock(&hub->status_mutex);
625 static void kick_khubd(struct usb_hub *hub)
629 spin_lock_irqsave(&hub_event_lock, flags);
630 if (!hub->disconnected && list_empty(&hub->event_list)) {
631 list_add_tail(&hub->event_list, &hub_event_list);
633 /* Suppress autosuspend until khubd runs */
634 usb_autopm_get_interface_no_resume(
635 to_usb_interface(hub->intfdev));
636 wake_up(&khubd_wait);
638 spin_unlock_irqrestore(&hub_event_lock, flags);
641 void usb_kick_khubd(struct usb_device *hdev)
643 struct usb_hub *hub = hdev_to_hub(hdev);
650 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
651 * Notification, which indicates it had initiated remote wakeup.
653 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
654 * device initiates resume, so the USB core will not receive notice of the
655 * resume through the normal hub interrupt URB.
657 void usb_wakeup_notification(struct usb_device *hdev,
658 unsigned int portnum)
665 hub = hdev_to_hub(hdev);
667 set_bit(portnum, hub->wakeup_bits);
671 EXPORT_SYMBOL_GPL(usb_wakeup_notification);
673 /* completion function, fires on port status changes and various faults */
674 static void hub_irq(struct urb *urb)
676 struct usb_hub *hub = urb->context;
677 int status = urb->status;
682 case -ENOENT: /* synchronous unlink */
683 case -ECONNRESET: /* async unlink */
684 case -ESHUTDOWN: /* hardware going away */
687 default: /* presumably an error */
688 /* Cause a hub reset after 10 consecutive errors */
689 dev_dbg (hub->intfdev, "transfer --> %d\n", status);
690 if ((++hub->nerrors < 10) || hub->error)
695 /* let khubd handle things */
696 case 0: /* we got data: port status changed */
698 for (i = 0; i < urb->actual_length; ++i)
699 bits |= ((unsigned long) ((*hub->buffer)[i]))
701 hub->event_bits[0] = bits;
707 /* Something happened, let khubd figure it out */
714 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
715 && status != -ENODEV && status != -EPERM)
716 dev_err (hub->intfdev, "resubmit --> %d\n", status);
719 /* USB 2.0 spec Section 11.24.2.3 */
721 hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
723 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
724 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
729 * enumeration blocks khubd for a long time. we use keventd instead, since
730 * long blocking there is the exception, not the rule. accordingly, HCDs
731 * talking to TTs must queue control transfers (not just bulk and iso), so
732 * both can talk to the same hub concurrently.
734 static void hub_tt_work(struct work_struct *work)
736 struct usb_hub *hub =
737 container_of(work, struct usb_hub, tt.clear_work);
741 spin_lock_irqsave (&hub->tt.lock, flags);
742 while (--limit && !list_empty (&hub->tt.clear_list)) {
743 struct list_head *next;
744 struct usb_tt_clear *clear;
745 struct usb_device *hdev = hub->hdev;
746 const struct hc_driver *drv;
749 next = hub->tt.clear_list.next;
750 clear = list_entry (next, struct usb_tt_clear, clear_list);
751 list_del (&clear->clear_list);
753 /* drop lock so HCD can concurrently report other TT errors */
754 spin_unlock_irqrestore (&hub->tt.lock, flags);
755 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
758 "clear tt %d (%04x) error %d\n",
759 clear->tt, clear->devinfo, status);
761 /* Tell the HCD, even if the operation failed */
762 drv = clear->hcd->driver;
763 if (drv->clear_tt_buffer_complete)
764 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
767 spin_lock_irqsave(&hub->tt.lock, flags);
769 spin_unlock_irqrestore (&hub->tt.lock, flags);
773 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
774 * @urb: an URB associated with the failed or incomplete split transaction
776 * High speed HCDs use this to tell the hub driver that some split control or
777 * bulk transaction failed in a way that requires clearing internal state of
778 * a transaction translator. This is normally detected (and reported) from
781 * It may not be possible for that hub to handle additional full (or low)
782 * speed transactions until that state is fully cleared out.
784 int usb_hub_clear_tt_buffer(struct urb *urb)
786 struct usb_device *udev = urb->dev;
787 int pipe = urb->pipe;
788 struct usb_tt *tt = udev->tt;
790 struct usb_tt_clear *clear;
792 /* we've got to cope with an arbitrary number of pending TT clears,
793 * since each TT has "at least two" buffers that can need it (and
794 * there can be many TTs per hub). even if they're uncommon.
796 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
797 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
798 /* FIXME recover somehow ... RESET_TT? */
802 /* info that CLEAR_TT_BUFFER needs */
803 clear->tt = tt->multi ? udev->ttport : 1;
804 clear->devinfo = usb_pipeendpoint (pipe);
805 clear->devinfo |= udev->devnum << 4;
806 clear->devinfo |= usb_pipecontrol (pipe)
807 ? (USB_ENDPOINT_XFER_CONTROL << 11)
808 : (USB_ENDPOINT_XFER_BULK << 11);
809 if (usb_pipein (pipe))
810 clear->devinfo |= 1 << 15;
812 /* info for completion callback */
813 clear->hcd = bus_to_hcd(udev->bus);
816 /* tell keventd to clear state for this TT */
817 spin_lock_irqsave (&tt->lock, flags);
818 list_add_tail (&clear->clear_list, &tt->clear_list);
819 schedule_work(&tt->clear_work);
820 spin_unlock_irqrestore (&tt->lock, flags);
823 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
825 /* If do_delay is false, return the number of milliseconds the caller
828 static unsigned hub_power_on(struct usb_hub *hub, bool do_delay)
831 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
833 u16 wHubCharacteristics =
834 le16_to_cpu(hub->descriptor->wHubCharacteristics);
836 /* Enable power on each port. Some hubs have reserved values
837 * of LPSM (> 2) in their descriptors, even though they are
838 * USB 2.0 hubs. Some hubs do not implement port-power switching
839 * but only emulate it. In all cases, the ports won't work
840 * unless we send these messages to the hub.
842 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
843 dev_dbg(hub->intfdev, "enabling power on all ports\n");
845 dev_dbg(hub->intfdev, "trying to enable port power on "
846 "non-switchable hub\n");
847 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
848 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
850 /* Wait at least 100 msec for power to become stable */
851 delay = max(pgood_delay, (unsigned) 100);
857 static int hub_hub_status(struct usb_hub *hub,
858 u16 *status, u16 *change)
862 mutex_lock(&hub->status_mutex);
863 ret = get_hub_status(hub->hdev, &hub->status->hub);
865 dev_err (hub->intfdev,
866 "%s failed (err = %d)\n", __func__, ret);
868 *status = le16_to_cpu(hub->status->hub.wHubStatus);
869 *change = le16_to_cpu(hub->status->hub.wHubChange);
872 mutex_unlock(&hub->status_mutex);
876 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
878 struct usb_device *hdev = hub->hdev;
881 if (hub->ports[port1 - 1]->child && set_state)
882 usb_set_device_state(hub->ports[port1 - 1]->child,
883 USB_STATE_NOTATTACHED);
884 if (!hub->error && !hub_is_superspeed(hub->hdev))
885 ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
887 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
893 * Disable a port and mark a logical connect-change event, so that some
894 * time later khubd will disconnect() any existing usb_device on the port
895 * and will re-enumerate if there actually is a device attached.
897 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
899 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
900 hub_port_disable(hub, port1, 1);
902 /* FIXME let caller ask to power down the port:
903 * - some devices won't enumerate without a VBUS power cycle
904 * - SRP saves power that way
905 * - ... new call, TBD ...
906 * That's easy if this hub can switch power per-port, and
907 * khubd reactivates the port later (timer, SRP, etc).
908 * Powerdown must be optional, because of reset/DFU.
911 set_bit(port1, hub->change_bits);
916 * usb_remove_device - disable a device's port on its parent hub
917 * @udev: device to be disabled and removed
918 * Context: @udev locked, must be able to sleep.
920 * After @udev's port has been disabled, khubd is notified and it will
921 * see that the device has been disconnected. When the device is
922 * physically unplugged and something is plugged in, the events will
923 * be received and processed normally.
925 int usb_remove_device(struct usb_device *udev)
928 struct usb_interface *intf;
930 if (!udev->parent) /* Can't remove a root hub */
932 hub = hdev_to_hub(udev->parent);
933 intf = to_usb_interface(hub->intfdev);
935 usb_autopm_get_interface(intf);
936 set_bit(udev->portnum, hub->removed_bits);
937 hub_port_logical_disconnect(hub, udev->portnum);
938 usb_autopm_put_interface(intf);
942 enum hub_activation_type {
943 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
944 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
947 static void hub_init_func2(struct work_struct *ws);
948 static void hub_init_func3(struct work_struct *ws);
950 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
952 struct usb_device *hdev = hub->hdev;
957 bool need_debounce_delay = false;
960 /* Continue a partial initialization */
961 if (type == HUB_INIT2)
963 if (type == HUB_INIT3)
966 /* The superspeed hub except for root hub has to use Hub Depth
967 * value as an offset into the route string to locate the bits
968 * it uses to determine the downstream port number. So hub driver
969 * should send a set hub depth request to superspeed hub after
970 * the superspeed hub is set configuration in initialization or
973 * After a resume, port power should still be on.
974 * For any other type of activation, turn it on.
976 if (type != HUB_RESUME) {
977 if (hdev->parent && hub_is_superspeed(hdev)) {
978 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
979 HUB_SET_DEPTH, USB_RT_HUB,
980 hdev->level - 1, 0, NULL, 0,
981 USB_CTRL_SET_TIMEOUT);
983 dev_err(hub->intfdev,
984 "set hub depth failed\n");
987 /* Speed up system boot by using a delayed_work for the
988 * hub's initial power-up delays. This is pretty awkward
989 * and the implementation looks like a home-brewed sort of
990 * setjmp/longjmp, but it saves at least 100 ms for each
991 * root hub (assuming usbcore is compiled into the kernel
992 * rather than as a module). It adds up.
994 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
995 * because for those activation types the ports have to be
996 * operational when we return. In theory this could be done
997 * for HUB_POST_RESET, but it's easier not to.
999 if (type == HUB_INIT) {
1000 delay = hub_power_on(hub, false);
1001 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func2);
1002 schedule_delayed_work(&hub->init_work,
1003 msecs_to_jiffies(delay));
1005 /* Suppress autosuspend until init is done */
1006 usb_autopm_get_interface_no_resume(
1007 to_usb_interface(hub->intfdev));
1008 return; /* Continues at init2: below */
1009 } else if (type == HUB_RESET_RESUME) {
1010 /* The internal host controller state for the hub device
1011 * may be gone after a host power loss on system resume.
1012 * Update the device's info so the HW knows it's a hub.
1014 hcd = bus_to_hcd(hdev->bus);
1015 if (hcd->driver->update_hub_device) {
1016 ret = hcd->driver->update_hub_device(hcd, hdev,
1017 &hub->tt, GFP_NOIO);
1019 dev_err(hub->intfdev, "Host not "
1020 "accepting hub info "
1022 dev_err(hub->intfdev, "LS/FS devices "
1023 "and hubs may not work "
1024 "under this hub\n.");
1027 hub_power_on(hub, true);
1029 hub_power_on(hub, true);
1034 /* Check each port and set hub->change_bits to let khubd know
1035 * which ports need attention.
1037 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
1038 struct usb_device *udev = hub->ports[port1 - 1]->child;
1039 u16 portstatus, portchange;
1041 portstatus = portchange = 0;
1042 status = hub_port_status(hub, port1, &portstatus, &portchange);
1043 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1044 dev_dbg(hub->intfdev,
1045 "port %d: status %04x change %04x\n",
1046 port1, portstatus, portchange);
1048 /* After anything other than HUB_RESUME (i.e., initialization
1049 * or any sort of reset), every port should be disabled.
1050 * Unconnected ports should likewise be disabled (paranoia),
1051 * and so should ports for which we have no usb_device.
1053 if ((portstatus & USB_PORT_STAT_ENABLE) && (
1054 type != HUB_RESUME ||
1055 !(portstatus & USB_PORT_STAT_CONNECTION) ||
1057 udev->state == USB_STATE_NOTATTACHED)) {
1059 * USB3 protocol ports will automatically transition
1060 * to Enabled state when detect an USB3.0 device attach.
1061 * Do not disable USB3 protocol ports.
1063 if (!hub_is_superspeed(hdev)) {
1064 clear_port_feature(hdev, port1,
1065 USB_PORT_FEAT_ENABLE);
1066 portstatus &= ~USB_PORT_STAT_ENABLE;
1068 /* Pretend that power was lost for USB3 devs */
1069 portstatus &= ~USB_PORT_STAT_ENABLE;
1073 /* Clear status-change flags; we'll debounce later */
1074 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1075 need_debounce_delay = true;
1076 clear_port_feature(hub->hdev, port1,
1077 USB_PORT_FEAT_C_CONNECTION);
1079 if (portchange & USB_PORT_STAT_C_ENABLE) {
1080 need_debounce_delay = true;
1081 clear_port_feature(hub->hdev, port1,
1082 USB_PORT_FEAT_C_ENABLE);
1084 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
1085 hub_is_superspeed(hub->hdev)) {
1086 need_debounce_delay = true;
1087 clear_port_feature(hub->hdev, port1,
1088 USB_PORT_FEAT_C_BH_PORT_RESET);
1090 /* We can forget about a "removed" device when there's a
1091 * physical disconnect or the connect status changes.
1093 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
1094 (portchange & USB_PORT_STAT_C_CONNECTION))
1095 clear_bit(port1, hub->removed_bits);
1097 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
1098 /* Tell khubd to disconnect the device or
1099 * check for a new connection
1101 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1102 set_bit(port1, hub->change_bits);
1104 } else if (portstatus & USB_PORT_STAT_ENABLE) {
1105 bool port_resumed = (portstatus &
1106 USB_PORT_STAT_LINK_STATE) ==
1108 /* The power session apparently survived the resume.
1109 * If there was an overcurrent or suspend change
1110 * (i.e., remote wakeup request), have khubd
1111 * take care of it. Look at the port link state
1112 * for USB 3.0 hubs, since they don't have a suspend
1113 * change bit, and they don't set the port link change
1114 * bit on device-initiated resume.
1116 if (portchange || (hub_is_superspeed(hub->hdev) &&
1118 set_bit(port1, hub->change_bits);
1120 } else if (udev->persist_enabled) {
1122 udev->reset_resume = 1;
1124 set_bit(port1, hub->change_bits);
1127 /* The power session is gone; tell khubd */
1128 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1129 set_bit(port1, hub->change_bits);
1133 /* If no port-status-change flags were set, we don't need any
1134 * debouncing. If flags were set we can try to debounce the
1135 * ports all at once right now, instead of letting khubd do them
1136 * one at a time later on.
1138 * If any port-status changes do occur during this delay, khubd
1139 * will see them later and handle them normally.
1141 if (need_debounce_delay) {
1142 delay = HUB_DEBOUNCE_STABLE;
1144 /* Don't do a long sleep inside a workqueue routine */
1145 if (type == HUB_INIT2) {
1146 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func3);
1147 schedule_delayed_work(&hub->init_work,
1148 msecs_to_jiffies(delay));
1149 return; /* Continues at init3: below */
1157 status = usb_submit_urb(hub->urb, GFP_NOIO);
1159 dev_err(hub->intfdev, "activate --> %d\n", status);
1160 if (hub->has_indicators && blinkenlights)
1161 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
1163 /* Scan all ports that need attention */
1166 /* Allow autosuspend if it was suppressed */
1167 if (type <= HUB_INIT3)
1168 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
1171 /* Implement the continuations for the delays above */
1172 static void hub_init_func2(struct work_struct *ws)
1174 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1176 hub_activate(hub, HUB_INIT2);
1179 static void hub_init_func3(struct work_struct *ws)
1181 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1183 hub_activate(hub, HUB_INIT3);
1186 enum hub_quiescing_type {
1187 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
1190 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
1192 struct usb_device *hdev = hub->hdev;
1195 cancel_delayed_work_sync(&hub->init_work);
1197 /* khubd and related activity won't re-trigger */
1200 if (type != HUB_SUSPEND) {
1201 /* Disconnect all the children */
1202 for (i = 0; i < hdev->maxchild; ++i) {
1203 if (hub->ports[i]->child)
1204 usb_disconnect(&hub->ports[i]->child);
1208 /* Stop khubd and related activity */
1209 usb_kill_urb(hub->urb);
1210 if (hub->has_indicators)
1211 cancel_delayed_work_sync(&hub->leds);
1213 cancel_work_sync(&hub->tt.clear_work);
1216 /* caller has locked the hub device */
1217 static int hub_pre_reset(struct usb_interface *intf)
1219 struct usb_hub *hub = usb_get_intfdata(intf);
1221 hub_quiesce(hub, HUB_PRE_RESET);
1225 /* caller has locked the hub device */
1226 static int hub_post_reset(struct usb_interface *intf)
1228 struct usb_hub *hub = usb_get_intfdata(intf);
1230 hub_activate(hub, HUB_POST_RESET);
1234 static void usb_port_device_release(struct device *dev)
1236 struct usb_port *port_dev = to_usb_port(dev);
1241 static void usb_hub_remove_port_device(struct usb_hub *hub,
1244 device_unregister(&hub->ports[port1 - 1]->dev);
1247 struct device_type usb_port_device_type = {
1249 .release = usb_port_device_release,
1252 static int usb_hub_create_port_device(struct usb_hub *hub,
1255 struct usb_port *port_dev = NULL;
1258 port_dev = kzalloc(sizeof(*port_dev), GFP_KERNEL);
1264 hub->ports[port1 - 1] = port_dev;
1265 port_dev->dev.parent = hub->intfdev;
1266 port_dev->dev.type = &usb_port_device_type;
1267 dev_set_name(&port_dev->dev, "port%d", port1);
1269 retval = device_register(&port_dev->dev);
1271 goto error_register;
1275 put_device(&port_dev->dev);
1280 static int hub_configure(struct usb_hub *hub,
1281 struct usb_endpoint_descriptor *endpoint)
1283 struct usb_hcd *hcd;
1284 struct usb_device *hdev = hub->hdev;
1285 struct device *hub_dev = hub->intfdev;
1286 u16 hubstatus, hubchange;
1287 u16 wHubCharacteristics;
1290 char *message = "out of memory";
1292 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
1298 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1303 mutex_init(&hub->status_mutex);
1305 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1306 if (!hub->descriptor) {
1311 /* Request the entire hub descriptor.
1312 * hub->descriptor can handle USB_MAXCHILDREN ports,
1313 * but the hub can/will return fewer bytes here.
1315 ret = get_hub_descriptor(hdev, hub->descriptor);
1317 message = "can't read hub descriptor";
1319 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
1320 message = "hub has too many ports!";
1325 hdev->maxchild = hub->descriptor->bNbrPorts;
1326 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
1327 (hdev->maxchild == 1) ? "" : "s");
1329 hub->ports = kzalloc(hdev->maxchild * sizeof(struct usb_port *),
1336 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1338 /* FIXME for USB 3.0, skip for now */
1339 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1340 !(hub_is_superspeed(hdev))) {
1342 char portstr [USB_MAXCHILDREN + 1];
1344 for (i = 0; i < hdev->maxchild; i++)
1345 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1346 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1348 portstr[hdev->maxchild] = 0;
1349 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1351 dev_dbg(hub_dev, "standalone hub\n");
1353 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1354 case HUB_CHAR_COMMON_LPSM:
1355 dev_dbg(hub_dev, "ganged power switching\n");
1357 case HUB_CHAR_INDV_PORT_LPSM:
1358 dev_dbg(hub_dev, "individual port power switching\n");
1360 case HUB_CHAR_NO_LPSM:
1362 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1366 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1367 case HUB_CHAR_COMMON_OCPM:
1368 dev_dbg(hub_dev, "global over-current protection\n");
1370 case HUB_CHAR_INDV_PORT_OCPM:
1371 dev_dbg(hub_dev, "individual port over-current protection\n");
1373 case HUB_CHAR_NO_OCPM:
1375 dev_dbg(hub_dev, "no over-current protection\n");
1379 spin_lock_init (&hub->tt.lock);
1380 INIT_LIST_HEAD (&hub->tt.clear_list);
1381 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1382 switch (hdev->descriptor.bDeviceProtocol) {
1385 case USB_HUB_PR_HS_SINGLE_TT:
1386 dev_dbg(hub_dev, "Single TT\n");
1389 case USB_HUB_PR_HS_MULTI_TT:
1390 ret = usb_set_interface(hdev, 0, 1);
1392 dev_dbg(hub_dev, "TT per port\n");
1395 dev_err(hub_dev, "Using single TT (err %d)\n",
1400 /* USB 3.0 hubs don't have a TT */
1403 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1404 hdev->descriptor.bDeviceProtocol);
1408 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1409 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1410 case HUB_TTTT_8_BITS:
1411 if (hdev->descriptor.bDeviceProtocol != 0) {
1412 hub->tt.think_time = 666;
1413 dev_dbg(hub_dev, "TT requires at most %d "
1414 "FS bit times (%d ns)\n",
1415 8, hub->tt.think_time);
1418 case HUB_TTTT_16_BITS:
1419 hub->tt.think_time = 666 * 2;
1420 dev_dbg(hub_dev, "TT requires at most %d "
1421 "FS bit times (%d ns)\n",
1422 16, hub->tt.think_time);
1424 case HUB_TTTT_24_BITS:
1425 hub->tt.think_time = 666 * 3;
1426 dev_dbg(hub_dev, "TT requires at most %d "
1427 "FS bit times (%d ns)\n",
1428 24, hub->tt.think_time);
1430 case HUB_TTTT_32_BITS:
1431 hub->tt.think_time = 666 * 4;
1432 dev_dbg(hub_dev, "TT requires at most %d "
1433 "FS bit times (%d ns)\n",
1434 32, hub->tt.think_time);
1438 /* probe() zeroes hub->indicator[] */
1439 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1440 hub->has_indicators = 1;
1441 dev_dbg(hub_dev, "Port indicators are supported\n");
1444 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1445 hub->descriptor->bPwrOn2PwrGood * 2);
1447 /* power budgeting mostly matters with bus-powered hubs,
1448 * and battery-powered root hubs (may provide just 8 mA).
1450 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1452 message = "can't get hub status";
1455 le16_to_cpus(&hubstatus);
1456 if (hdev == hdev->bus->root_hub) {
1457 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
1458 hub->mA_per_port = 500;
1460 hub->mA_per_port = hdev->bus_mA;
1461 hub->limited_power = 1;
1463 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1464 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1465 hub->descriptor->bHubContrCurrent);
1466 hub->limited_power = 1;
1467 if (hdev->maxchild > 0) {
1468 int remaining = hdev->bus_mA -
1469 hub->descriptor->bHubContrCurrent;
1471 if (remaining < hdev->maxchild * 100)
1473 "insufficient power available "
1474 "to use all downstream ports\n");
1475 hub->mA_per_port = 100; /* 7.2.1.1 */
1477 } else { /* Self-powered external hub */
1478 /* FIXME: What about battery-powered external hubs that
1479 * provide less current per port? */
1480 hub->mA_per_port = 500;
1482 if (hub->mA_per_port < 500)
1483 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1486 /* Update the HCD's internal representation of this hub before khubd
1487 * starts getting port status changes for devices under the hub.
1489 hcd = bus_to_hcd(hdev->bus);
1490 if (hcd->driver->update_hub_device) {
1491 ret = hcd->driver->update_hub_device(hcd, hdev,
1492 &hub->tt, GFP_KERNEL);
1494 message = "can't update HCD hub info";
1499 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1501 message = "can't get hub status";
1505 /* local power status reports aren't always correct */
1506 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1507 dev_dbg(hub_dev, "local power source is %s\n",
1508 (hubstatus & HUB_STATUS_LOCAL_POWER)
1509 ? "lost (inactive)" : "good");
1511 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1512 dev_dbg(hub_dev, "%sover-current condition exists\n",
1513 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1515 /* set up the interrupt endpoint
1516 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1517 * bytes as USB2.0[11.12.3] says because some hubs are known
1518 * to send more data (and thus cause overflow). For root hubs,
1519 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1520 * to be big enough for at least USB_MAXCHILDREN ports. */
1521 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1522 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1524 if (maxp > sizeof(*hub->buffer))
1525 maxp = sizeof(*hub->buffer);
1527 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1533 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1534 hub, endpoint->bInterval);
1536 /* maybe cycle the hub leds */
1537 if (hub->has_indicators && blinkenlights)
1538 hub->indicator [0] = INDICATOR_CYCLE;
1540 for (i = 0; i < hdev->maxchild; i++)
1541 if (usb_hub_create_port_device(hub, i + 1) < 0)
1542 dev_err(hub->intfdev,
1543 "couldn't create port%d device.\n", i + 1);
1545 hub_activate(hub, HUB_INIT);
1549 dev_err (hub_dev, "config failed, %s (err %d)\n",
1551 /* hub_disconnect() frees urb and descriptor */
1555 static void hub_release(struct kref *kref)
1557 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1559 usb_put_intf(to_usb_interface(hub->intfdev));
1563 static unsigned highspeed_hubs;
1565 static void hub_disconnect(struct usb_interface *intf)
1567 struct usb_hub *hub = usb_get_intfdata(intf);
1568 struct usb_device *hdev = interface_to_usbdev(intf);
1571 /* Take the hub off the event list and don't let it be added again */
1572 spin_lock_irq(&hub_event_lock);
1573 if (!list_empty(&hub->event_list)) {
1574 list_del_init(&hub->event_list);
1575 usb_autopm_put_interface_no_suspend(intf);
1577 hub->disconnected = 1;
1578 spin_unlock_irq(&hub_event_lock);
1580 /* Disconnect all children and quiesce the hub */
1582 hub_quiesce(hub, HUB_DISCONNECT);
1584 usb_set_intfdata (intf, NULL);
1586 for (i = 0; i < hdev->maxchild; i++)
1587 usb_hub_remove_port_device(hub, i + 1);
1588 hub->hdev->maxchild = 0;
1590 if (hub->hdev->speed == USB_SPEED_HIGH)
1593 usb_free_urb(hub->urb);
1595 kfree(hub->descriptor);
1599 kref_put(&hub->kref, hub_release);
1602 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1604 struct usb_host_interface *desc;
1605 struct usb_endpoint_descriptor *endpoint;
1606 struct usb_device *hdev;
1607 struct usb_hub *hub;
1609 desc = intf->cur_altsetting;
1610 hdev = interface_to_usbdev(intf);
1612 /* Hubs have proper suspend/resume support. */
1613 usb_enable_autosuspend(hdev);
1615 if (hdev->level == MAX_TOPO_LEVEL) {
1617 "Unsupported bus topology: hub nested too deep\n");
1621 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1623 dev_warn(&intf->dev, "ignoring external hub\n");
1628 /* Some hubs have a subclass of 1, which AFAICT according to the */
1629 /* specs is not defined, but it works */
1630 if ((desc->desc.bInterfaceSubClass != 0) &&
1631 (desc->desc.bInterfaceSubClass != 1)) {
1633 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1637 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1638 if (desc->desc.bNumEndpoints != 1)
1639 goto descriptor_error;
1641 endpoint = &desc->endpoint[0].desc;
1643 /* If it's not an interrupt in endpoint, we'd better punt! */
1644 if (!usb_endpoint_is_int_in(endpoint))
1645 goto descriptor_error;
1647 /* We found a hub */
1648 dev_info (&intf->dev, "USB hub found\n");
1650 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1652 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1656 kref_init(&hub->kref);
1657 INIT_LIST_HEAD(&hub->event_list);
1658 hub->intfdev = &intf->dev;
1660 INIT_DELAYED_WORK(&hub->leds, led_work);
1661 INIT_DELAYED_WORK(&hub->init_work, NULL);
1664 usb_set_intfdata (intf, hub);
1665 intf->needs_remote_wakeup = 1;
1667 if (hdev->speed == USB_SPEED_HIGH)
1670 if (hub_configure(hub, endpoint) >= 0)
1673 hub_disconnect (intf);
1678 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1680 struct usb_device *hdev = interface_to_usbdev (intf);
1681 struct usb_hub *hub = hdev_to_hub(hdev);
1683 /* assert ifno == 0 (part of hub spec) */
1685 case USBDEVFS_HUB_PORTINFO: {
1686 struct usbdevfs_hub_portinfo *info = user_data;
1689 spin_lock_irq(&device_state_lock);
1690 if (hdev->devnum <= 0)
1693 info->nports = hdev->maxchild;
1694 for (i = 0; i < info->nports; i++) {
1695 if (hub->ports[i]->child == NULL)
1699 hub->ports[i]->child->devnum;
1702 spin_unlock_irq(&device_state_lock);
1704 return info->nports + 1;
1713 * Allow user programs to claim ports on a hub. When a device is attached
1714 * to one of these "claimed" ports, the program will "own" the device.
1716 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1717 struct dev_state ***ppowner)
1719 if (hdev->state == USB_STATE_NOTATTACHED)
1721 if (port1 == 0 || port1 > hdev->maxchild)
1724 /* This assumes that devices not managed by the hub driver
1725 * will always have maxchild equal to 0.
1727 *ppowner = &(hdev_to_hub(hdev)->ports[port1 - 1]->port_owner);
1731 /* In the following three functions, the caller must hold hdev's lock */
1732 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
1733 struct dev_state *owner)
1736 struct dev_state **powner;
1738 rc = find_port_owner(hdev, port1, &powner);
1747 int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
1748 struct dev_state *owner)
1751 struct dev_state **powner;
1753 rc = find_port_owner(hdev, port1, &powner);
1756 if (*powner != owner)
1762 void usb_hub_release_all_ports(struct usb_device *hdev, struct dev_state *owner)
1764 struct usb_hub *hub = hdev_to_hub(hdev);
1767 for (n = 0; n < hdev->maxchild; n++) {
1768 if (hub->ports[n]->port_owner == owner)
1769 hub->ports[n]->port_owner = NULL;
1774 /* The caller must hold udev's lock */
1775 bool usb_device_is_owned(struct usb_device *udev)
1777 struct usb_hub *hub;
1779 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1781 hub = hdev_to_hub(udev->parent);
1782 return !!hub->ports[udev->portnum - 1]->port_owner;
1785 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1787 struct usb_hub *hub = hdev_to_hub(udev);
1790 for (i = 0; i < udev->maxchild; ++i) {
1791 if (hub->ports[i]->child)
1792 recursively_mark_NOTATTACHED(hub->ports[i]->child);
1794 if (udev->state == USB_STATE_SUSPENDED)
1795 udev->active_duration -= jiffies;
1796 udev->state = USB_STATE_NOTATTACHED;
1800 * usb_set_device_state - change a device's current state (usbcore, hcds)
1801 * @udev: pointer to device whose state should be changed
1802 * @new_state: new state value to be stored
1804 * udev->state is _not_ fully protected by the device lock. Although
1805 * most transitions are made only while holding the lock, the state can
1806 * can change to USB_STATE_NOTATTACHED at almost any time. This
1807 * is so that devices can be marked as disconnected as soon as possible,
1808 * without having to wait for any semaphores to be released. As a result,
1809 * all changes to any device's state must be protected by the
1810 * device_state_lock spinlock.
1812 * Once a device has been added to the device tree, all changes to its state
1813 * should be made using this routine. The state should _not_ be set directly.
1815 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1816 * Otherwise udev->state is set to new_state, and if new_state is
1817 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1818 * to USB_STATE_NOTATTACHED.
1820 void usb_set_device_state(struct usb_device *udev,
1821 enum usb_device_state new_state)
1823 unsigned long flags;
1826 spin_lock_irqsave(&device_state_lock, flags);
1827 if (udev->state == USB_STATE_NOTATTACHED)
1829 else if (new_state != USB_STATE_NOTATTACHED) {
1831 /* root hub wakeup capabilities are managed out-of-band
1832 * and may involve silicon errata ... ignore them here.
1835 if (udev->state == USB_STATE_SUSPENDED
1836 || new_state == USB_STATE_SUSPENDED)
1837 ; /* No change to wakeup settings */
1838 else if (new_state == USB_STATE_CONFIGURED)
1839 wakeup = udev->actconfig->desc.bmAttributes
1840 & USB_CONFIG_ATT_WAKEUP;
1844 if (udev->state == USB_STATE_SUSPENDED &&
1845 new_state != USB_STATE_SUSPENDED)
1846 udev->active_duration -= jiffies;
1847 else if (new_state == USB_STATE_SUSPENDED &&
1848 udev->state != USB_STATE_SUSPENDED)
1849 udev->active_duration += jiffies;
1850 udev->state = new_state;
1852 recursively_mark_NOTATTACHED(udev);
1853 spin_unlock_irqrestore(&device_state_lock, flags);
1855 device_set_wakeup_capable(&udev->dev, wakeup);
1857 EXPORT_SYMBOL_GPL(usb_set_device_state);
1860 * Choose a device number.
1862 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1863 * USB-2.0 buses they are also used as device addresses, however on
1864 * USB-3.0 buses the address is assigned by the controller hardware
1865 * and it usually is not the same as the device number.
1867 * WUSB devices are simple: they have no hubs behind, so the mapping
1868 * device <-> virtual port number becomes 1:1. Why? to simplify the
1869 * life of the device connection logic in
1870 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1871 * handshake we need to assign a temporary address in the unauthorized
1872 * space. For simplicity we use the first virtual port number found to
1873 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1874 * and that becomes it's address [X < 128] or its unauthorized address
1877 * We add 1 as an offset to the one-based USB-stack port number
1878 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1879 * 0 is reserved by USB for default address; (b) Linux's USB stack
1880 * uses always #1 for the root hub of the controller. So USB stack's
1881 * port #1, which is wusb virtual-port #0 has address #2.
1883 * Devices connected under xHCI are not as simple. The host controller
1884 * supports virtualization, so the hardware assigns device addresses and
1885 * the HCD must setup data structures before issuing a set address
1886 * command to the hardware.
1888 static void choose_devnum(struct usb_device *udev)
1891 struct usb_bus *bus = udev->bus;
1893 /* If khubd ever becomes multithreaded, this will need a lock */
1895 devnum = udev->portnum + 1;
1896 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
1898 /* Try to allocate the next devnum beginning at
1899 * bus->devnum_next. */
1900 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1903 devnum = find_next_zero_bit(bus->devmap.devicemap,
1905 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1908 set_bit(devnum, bus->devmap.devicemap);
1909 udev->devnum = devnum;
1913 static void release_devnum(struct usb_device *udev)
1915 if (udev->devnum > 0) {
1916 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1921 static void update_devnum(struct usb_device *udev, int devnum)
1923 /* The address for a WUSB device is managed by wusbcore. */
1925 udev->devnum = devnum;
1928 static void hub_free_dev(struct usb_device *udev)
1930 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1932 /* Root hubs aren't real devices, so don't free HCD resources */
1933 if (hcd->driver->free_dev && udev->parent)
1934 hcd->driver->free_dev(hcd, udev);
1938 * usb_disconnect - disconnect a device (usbcore-internal)
1939 * @pdev: pointer to device being disconnected
1940 * Context: !in_interrupt ()
1942 * Something got disconnected. Get rid of it and all of its children.
1944 * If *pdev is a normal device then the parent hub must already be locked.
1945 * If *pdev is a root hub then this routine will acquire the
1946 * usb_bus_list_lock on behalf of the caller.
1948 * Only hub drivers (including virtual root hub drivers for host
1949 * controllers) should ever call this.
1951 * This call is synchronous, and may not be used in an interrupt context.
1953 void usb_disconnect(struct usb_device **pdev)
1955 struct usb_device *udev = *pdev;
1956 struct usb_hub *hub = hdev_to_hub(udev);
1959 /* mark the device as inactive, so any further urb submissions for
1960 * this device (and any of its children) will fail immediately.
1961 * this quiesces everything except pending urbs.
1963 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1964 dev_info(&udev->dev, "USB disconnect, device number %d\n",
1967 usb_lock_device(udev);
1969 /* Free up all the children before we remove this device */
1970 for (i = 0; i < udev->maxchild; i++) {
1971 if (hub->ports[i]->child)
1972 usb_disconnect(&hub->ports[i]->child);
1975 /* deallocate hcd/hardware state ... nuking all pending urbs and
1976 * cleaning up all state associated with the current configuration
1977 * so that the hardware is now fully quiesced.
1979 dev_dbg (&udev->dev, "unregistering device\n");
1980 usb_disable_device(udev, 0);
1981 usb_hcd_synchronize_unlinks(udev);
1983 usb_remove_ep_devs(&udev->ep0);
1984 usb_unlock_device(udev);
1986 /* Unregister the device. The device driver is responsible
1987 * for de-configuring the device and invoking the remove-device
1988 * notifier chain (used by usbfs and possibly others).
1990 device_del(&udev->dev);
1992 /* Free the device number and delete the parent's children[]
1993 * (or root_hub) pointer.
1995 release_devnum(udev);
1997 /* Avoid races with recursively_mark_NOTATTACHED() */
1998 spin_lock_irq(&device_state_lock);
2000 spin_unlock_irq(&device_state_lock);
2004 put_device(&udev->dev);
2007 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2008 static void show_string(struct usb_device *udev, char *id, char *string)
2012 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
2015 static void announce_device(struct usb_device *udev)
2017 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2018 le16_to_cpu(udev->descriptor.idVendor),
2019 le16_to_cpu(udev->descriptor.idProduct));
2020 dev_info(&udev->dev,
2021 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2022 udev->descriptor.iManufacturer,
2023 udev->descriptor.iProduct,
2024 udev->descriptor.iSerialNumber);
2025 show_string(udev, "Product", udev->product);
2026 show_string(udev, "Manufacturer", udev->manufacturer);
2027 show_string(udev, "SerialNumber", udev->serial);
2030 static inline void announce_device(struct usb_device *udev) { }
2033 #ifdef CONFIG_USB_OTG
2034 #include "otg_whitelist.h"
2038 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2039 * @udev: newly addressed device (in ADDRESS state)
2041 * Finish enumeration for On-The-Go devices
2043 static int usb_enumerate_device_otg(struct usb_device *udev)
2047 #ifdef CONFIG_USB_OTG
2049 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2050 * to wake us after we've powered off VBUS; and HNP, switching roles
2051 * "host" to "peripheral". The OTG descriptor helps figure this out.
2053 if (!udev->bus->is_b_host
2055 && udev->parent == udev->bus->root_hub) {
2056 struct usb_otg_descriptor *desc = NULL;
2057 struct usb_bus *bus = udev->bus;
2059 /* descriptor may appear anywhere in config */
2060 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
2061 le16_to_cpu(udev->config[0].desc.wTotalLength),
2062 USB_DT_OTG, (void **) &desc) == 0) {
2063 if (desc->bmAttributes & USB_OTG_HNP) {
2064 unsigned port1 = udev->portnum;
2066 dev_info(&udev->dev,
2067 "Dual-Role OTG device on %sHNP port\n",
2068 (port1 == bus->otg_port)
2071 /* enable HNP before suspend, it's simpler */
2072 if (port1 == bus->otg_port)
2073 bus->b_hnp_enable = 1;
2074 err = usb_control_msg(udev,
2075 usb_sndctrlpipe(udev, 0),
2076 USB_REQ_SET_FEATURE, 0,
2078 ? USB_DEVICE_B_HNP_ENABLE
2079 : USB_DEVICE_A_ALT_HNP_SUPPORT,
2080 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
2082 /* OTG MESSAGE: report errors here,
2083 * customize to match your product.
2085 dev_info(&udev->dev,
2086 "can't set HNP mode: %d\n",
2088 bus->b_hnp_enable = 0;
2094 if (!is_targeted(udev)) {
2096 /* Maybe it can talk to us, though we can't talk to it.
2097 * (Includes HNP test device.)
2099 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
2100 err = usb_port_suspend(udev, PMSG_SUSPEND);
2102 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
2114 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2115 * @udev: newly addressed device (in ADDRESS state)
2117 * This is only called by usb_new_device() and usb_authorize_device()
2118 * and FIXME -- all comments that apply to them apply here wrt to
2121 * If the device is WUSB and not authorized, we don't attempt to read
2122 * the string descriptors, as they will be errored out by the device
2123 * until it has been authorized.
2125 static int usb_enumerate_device(struct usb_device *udev)
2129 if (udev->config == NULL) {
2130 err = usb_get_configuration(udev);
2132 dev_err(&udev->dev, "can't read configurations, error %d\n",
2137 if (udev->wusb == 1 && udev->authorized == 0) {
2138 udev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2139 udev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2140 udev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2143 /* read the standard strings and cache them if present */
2144 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
2145 udev->manufacturer = usb_cache_string(udev,
2146 udev->descriptor.iManufacturer);
2147 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
2149 err = usb_enumerate_device_otg(udev);
2153 usb_detect_interface_quirks(udev);
2158 static void set_usb_port_removable(struct usb_device *udev)
2160 struct usb_device *hdev = udev->parent;
2161 struct usb_hub *hub;
2162 u8 port = udev->portnum;
2163 u16 wHubCharacteristics;
2164 bool removable = true;
2169 hub = hdev_to_hub(udev->parent);
2171 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2173 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
2176 if (hub_is_superspeed(hdev)) {
2177 if (le16_to_cpu(hub->descriptor->u.ss.DeviceRemovable)
2181 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
2186 udev->removable = USB_DEVICE_REMOVABLE;
2188 udev->removable = USB_DEVICE_FIXED;
2192 * usb_new_device - perform initial device setup (usbcore-internal)
2193 * @udev: newly addressed device (in ADDRESS state)
2195 * This is called with devices which have been detected but not fully
2196 * enumerated. The device descriptor is available, but not descriptors
2197 * for any device configuration. The caller must have locked either
2198 * the parent hub (if udev is a normal device) or else the
2199 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
2200 * udev has already been installed, but udev is not yet visible through
2201 * sysfs or other filesystem code.
2203 * It will return if the device is configured properly or not. Zero if
2204 * the interface was registered with the driver core; else a negative
2207 * This call is synchronous, and may not be used in an interrupt context.
2209 * Only the hub driver or root-hub registrar should ever call this.
2211 int usb_new_device(struct usb_device *udev)
2216 /* Initialize non-root-hub device wakeup to disabled;
2217 * device (un)configuration controls wakeup capable
2218 * sysfs power/wakeup controls wakeup enabled/disabled
2220 device_init_wakeup(&udev->dev, 0);
2223 /* Tell the runtime-PM framework the device is active */
2224 pm_runtime_set_active(&udev->dev);
2225 pm_runtime_get_noresume(&udev->dev);
2226 pm_runtime_use_autosuspend(&udev->dev);
2227 pm_runtime_enable(&udev->dev);
2229 /* By default, forbid autosuspend for all devices. It will be
2230 * allowed for hubs during binding.
2232 usb_disable_autosuspend(udev);
2234 err = usb_enumerate_device(udev); /* Read descriptors */
2237 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
2238 udev->devnum, udev->bus->busnum,
2239 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2240 /* export the usbdev device-node for libusb */
2241 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
2242 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2244 /* Tell the world! */
2245 announce_device(udev);
2248 add_device_randomness(udev->serial, strlen(udev->serial));
2250 add_device_randomness(udev->product, strlen(udev->product));
2251 if (udev->manufacturer)
2252 add_device_randomness(udev->manufacturer,
2253 strlen(udev->manufacturer));
2255 device_enable_async_suspend(&udev->dev);
2258 * check whether the hub marks this port as non-removable. Do it
2259 * now so that platform-specific data can override it in
2263 set_usb_port_removable(udev);
2265 /* Register the device. The device driver is responsible
2266 * for configuring the device and invoking the add-device
2267 * notifier chain (used by usbfs and possibly others).
2269 err = device_add(&udev->dev);
2271 dev_err(&udev->dev, "can't device_add, error %d\n", err);
2275 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
2276 usb_mark_last_busy(udev);
2277 pm_runtime_put_sync_autosuspend(&udev->dev);
2281 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2282 pm_runtime_disable(&udev->dev);
2283 pm_runtime_set_suspended(&udev->dev);
2289 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2290 * @usb_dev: USB device
2292 * Move the USB device to a very basic state where interfaces are disabled
2293 * and the device is in fact unconfigured and unusable.
2295 * We share a lock (that we have) with device_del(), so we need to
2298 int usb_deauthorize_device(struct usb_device *usb_dev)
2300 usb_lock_device(usb_dev);
2301 if (usb_dev->authorized == 0)
2302 goto out_unauthorized;
2304 usb_dev->authorized = 0;
2305 usb_set_configuration(usb_dev, -1);
2307 kfree(usb_dev->product);
2308 usb_dev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2309 kfree(usb_dev->manufacturer);
2310 usb_dev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2311 kfree(usb_dev->serial);
2312 usb_dev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2314 usb_destroy_configuration(usb_dev);
2315 usb_dev->descriptor.bNumConfigurations = 0;
2318 usb_unlock_device(usb_dev);
2323 int usb_authorize_device(struct usb_device *usb_dev)
2327 usb_lock_device(usb_dev);
2328 if (usb_dev->authorized == 1)
2329 goto out_authorized;
2331 result = usb_autoresume_device(usb_dev);
2333 dev_err(&usb_dev->dev,
2334 "can't autoresume for authorization: %d\n", result);
2335 goto error_autoresume;
2337 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2339 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2340 "authorization: %d\n", result);
2341 goto error_device_descriptor;
2344 kfree(usb_dev->product);
2345 usb_dev->product = NULL;
2346 kfree(usb_dev->manufacturer);
2347 usb_dev->manufacturer = NULL;
2348 kfree(usb_dev->serial);
2349 usb_dev->serial = NULL;
2351 usb_dev->authorized = 1;
2352 result = usb_enumerate_device(usb_dev);
2354 goto error_enumerate;
2355 /* Choose and set the configuration. This registers the interfaces
2356 * with the driver core and lets interface drivers bind to them.
2358 c = usb_choose_configuration(usb_dev);
2360 result = usb_set_configuration(usb_dev, c);
2362 dev_err(&usb_dev->dev,
2363 "can't set config #%d, error %d\n", c, result);
2364 /* This need not be fatal. The user can try to
2365 * set other configurations. */
2368 dev_info(&usb_dev->dev, "authorized to connect\n");
2371 error_device_descriptor:
2372 usb_autosuspend_device(usb_dev);
2375 usb_unlock_device(usb_dev); // complements locktree
2380 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2381 static unsigned hub_is_wusb(struct usb_hub *hub)
2383 struct usb_hcd *hcd;
2384 if (hub->hdev->parent != NULL) /* not a root hub? */
2386 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
2387 return hcd->wireless;
2391 #define PORT_RESET_TRIES 5
2392 #define SET_ADDRESS_TRIES 2
2393 #define GET_DESCRIPTOR_TRIES 2
2394 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2395 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2397 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2398 #define HUB_SHORT_RESET_TIME 10
2399 #define HUB_BH_RESET_TIME 50
2400 #define HUB_LONG_RESET_TIME 200
2401 #define HUB_RESET_TIMEOUT 500
2403 static int hub_port_reset(struct usb_hub *hub, int port1,
2404 struct usb_device *udev, unsigned int delay, bool warm);
2406 /* Is a USB 3.0 port in the Inactive or Complinance Mode state?
2407 * Port worm reset is required to recover
2409 static bool hub_port_warm_reset_required(struct usb_hub *hub, u16 portstatus)
2411 return hub_is_superspeed(hub->hdev) &&
2412 (((portstatus & USB_PORT_STAT_LINK_STATE) ==
2413 USB_SS_PORT_LS_SS_INACTIVE) ||
2414 ((portstatus & USB_PORT_STAT_LINK_STATE) ==
2415 USB_SS_PORT_LS_COMP_MOD)) ;
2418 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2419 struct usb_device *udev, unsigned int delay, bool warm)
2421 int delay_time, ret;
2425 for (delay_time = 0;
2426 delay_time < HUB_RESET_TIMEOUT;
2427 delay_time += delay) {
2428 /* wait to give the device a chance to reset */
2431 /* read and decode port status */
2432 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2437 * Some buggy devices require a warm reset to be issued even
2438 * when the port appears not to be connected.
2442 * Some buggy devices can cause an NEC host controller
2443 * to transition to the "Error" state after a hot port
2444 * reset. This will show up as the port state in
2445 * "Inactive", and the port may also report a
2446 * disconnect. Forcing a warm port reset seems to make
2449 * See https://bugzilla.kernel.org/show_bug.cgi?id=41752
2451 if (hub_port_warm_reset_required(hub, portstatus)) {
2454 if ((portchange & USB_PORT_STAT_C_CONNECTION))
2455 clear_port_feature(hub->hdev, port1,
2456 USB_PORT_FEAT_C_CONNECTION);
2457 if (portchange & USB_PORT_STAT_C_LINK_STATE)
2458 clear_port_feature(hub->hdev, port1,
2459 USB_PORT_FEAT_C_PORT_LINK_STATE);
2460 if (portchange & USB_PORT_STAT_C_RESET)
2461 clear_port_feature(hub->hdev, port1,
2462 USB_PORT_FEAT_C_RESET);
2463 dev_dbg(hub->intfdev, "hot reset failed, warm reset port %d\n",
2465 ret = hub_port_reset(hub, port1,
2466 udev, HUB_BH_RESET_TIME,
2468 if ((portchange & USB_PORT_STAT_C_CONNECTION))
2469 clear_port_feature(hub->hdev, port1,
2470 USB_PORT_FEAT_C_CONNECTION);
2473 /* Device went away? */
2474 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2477 /* bomb out completely if the connection bounced */
2478 if ((portchange & USB_PORT_STAT_C_CONNECTION))
2481 /* if we`ve finished resetting, then break out of
2484 if (!(portstatus & USB_PORT_STAT_RESET) &&
2485 (portstatus & USB_PORT_STAT_ENABLE)) {
2486 if (hub_is_wusb(hub))
2487 udev->speed = USB_SPEED_WIRELESS;
2488 else if (hub_is_superspeed(hub->hdev))
2489 udev->speed = USB_SPEED_SUPER;
2490 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2491 udev->speed = USB_SPEED_HIGH;
2492 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2493 udev->speed = USB_SPEED_LOW;
2495 udev->speed = USB_SPEED_FULL;
2499 if (portchange & USB_PORT_STAT_C_BH_RESET)
2503 /* switch to the long delay after two short delay failures */
2504 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2505 delay = HUB_LONG_RESET_TIME;
2507 dev_dbg (hub->intfdev,
2508 "port %d not %sreset yet, waiting %dms\n",
2509 port1, warm ? "warm " : "", delay);
2515 static void hub_port_finish_reset(struct usb_hub *hub, int port1,
2516 struct usb_device *udev, int *status, bool warm)
2521 struct usb_hcd *hcd;
2522 /* TRSTRCY = 10 ms; plus some extra */
2524 update_devnum(udev, 0);
2525 hcd = bus_to_hcd(udev->bus);
2526 if (hcd->driver->reset_device) {
2527 *status = hcd->driver->reset_device(hcd, udev);
2529 dev_err(&udev->dev, "Cannot reset "
2530 "HCD device state\n");
2538 clear_port_feature(hub->hdev,
2539 port1, USB_PORT_FEAT_C_RESET);
2540 /* FIXME need disconnect() for NOTATTACHED device */
2542 clear_port_feature(hub->hdev, port1,
2543 USB_PORT_FEAT_C_BH_PORT_RESET);
2544 clear_port_feature(hub->hdev, port1,
2545 USB_PORT_FEAT_C_PORT_LINK_STATE);
2547 usb_set_device_state(udev, *status
2548 ? USB_STATE_NOTATTACHED
2549 : USB_STATE_DEFAULT);
2555 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2556 static int hub_port_reset(struct usb_hub *hub, int port1,
2557 struct usb_device *udev, unsigned int delay, bool warm)
2562 /* Block EHCI CF initialization during the port reset.
2563 * Some companion controllers don't like it when they mix.
2565 down_read(&ehci_cf_port_reset_rwsem);
2567 if (!hub_is_superspeed(hub->hdev)) {
2568 dev_err(hub->intfdev, "only USB3 hub support "
2574 /* Reset the port */
2575 for (i = 0; i < PORT_RESET_TRIES; i++) {
2576 status = set_port_feature(hub->hdev, port1, (warm ?
2577 USB_PORT_FEAT_BH_PORT_RESET :
2578 USB_PORT_FEAT_RESET));
2580 dev_err(hub->intfdev,
2581 "cannot %sreset port %d (err = %d)\n",
2582 warm ? "warm " : "", port1, status);
2584 status = hub_port_wait_reset(hub, port1, udev, delay,
2586 if (status && status != -ENOTCONN)
2587 dev_dbg(hub->intfdev,
2588 "port_wait_reset: err = %d\n",
2592 /* return on disconnect or reset */
2593 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2594 hub_port_finish_reset(hub, port1, udev, &status, warm);
2598 dev_dbg (hub->intfdev,
2599 "port %d not enabled, trying %sreset again...\n",
2600 port1, warm ? "warm " : "");
2601 delay = HUB_LONG_RESET_TIME;
2604 dev_err (hub->intfdev,
2605 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2610 up_read(&ehci_cf_port_reset_rwsem);
2615 /* Check if a port is power on */
2616 static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2620 if (hub_is_superspeed(hub->hdev)) {
2621 if (portstatus & USB_SS_PORT_STAT_POWER)
2624 if (portstatus & USB_PORT_STAT_POWER)
2633 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2634 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
2638 if (hub_is_superspeed(hub->hdev)) {
2639 if ((portstatus & USB_PORT_STAT_LINK_STATE)
2640 == USB_SS_PORT_LS_U3)
2643 if (portstatus & USB_PORT_STAT_SUSPEND)
2650 /* Determine whether the device on a port is ready for a normal resume,
2651 * is ready for a reset-resume, or should be disconnected.
2653 static int check_port_resume_type(struct usb_device *udev,
2654 struct usb_hub *hub, int port1,
2655 int status, unsigned portchange, unsigned portstatus)
2657 /* Is the device still present? */
2658 if (status || port_is_suspended(hub, portstatus) ||
2659 !port_is_power_on(hub, portstatus) ||
2660 !(portstatus & USB_PORT_STAT_CONNECTION)) {
2665 /* Can't do a normal resume if the port isn't enabled,
2666 * so try a reset-resume instead.
2668 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2669 if (udev->persist_enabled)
2670 udev->reset_resume = 1;
2676 dev_dbg(hub->intfdev,
2677 "port %d status %04x.%04x after resume, %d\n",
2678 port1, portchange, portstatus, status);
2679 } else if (udev->reset_resume) {
2681 /* Late port handoff can set status-change bits */
2682 if (portchange & USB_PORT_STAT_C_CONNECTION)
2683 clear_port_feature(hub->hdev, port1,
2684 USB_PORT_FEAT_C_CONNECTION);
2685 if (portchange & USB_PORT_STAT_C_ENABLE)
2686 clear_port_feature(hub->hdev, port1,
2687 USB_PORT_FEAT_C_ENABLE);
2693 int usb_disable_ltm(struct usb_device *udev)
2695 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2697 /* Check if the roothub and device supports LTM. */
2698 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
2699 !usb_device_supports_ltm(udev))
2702 /* Clear Feature LTM Enable can only be sent if the device is
2705 if (!udev->actconfig)
2708 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2709 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2710 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
2711 USB_CTRL_SET_TIMEOUT);
2713 EXPORT_SYMBOL_GPL(usb_disable_ltm);
2715 void usb_enable_ltm(struct usb_device *udev)
2717 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2719 /* Check if the roothub and device supports LTM. */
2720 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
2721 !usb_device_supports_ltm(udev))
2724 /* Set Feature LTM Enable can only be sent if the device is
2727 if (!udev->actconfig)
2730 usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2731 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2732 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
2733 USB_CTRL_SET_TIMEOUT);
2735 EXPORT_SYMBOL_GPL(usb_enable_ltm);
2737 #ifdef CONFIG_USB_SUSPEND
2740 * usb_port_suspend - suspend a usb device's upstream port
2741 * @udev: device that's no longer in active use, not a root hub
2742 * Context: must be able to sleep; device not locked; pm locks held
2744 * Suspends a USB device that isn't in active use, conserving power.
2745 * Devices may wake out of a suspend, if anything important happens,
2746 * using the remote wakeup mechanism. They may also be taken out of
2747 * suspend by the host, using usb_port_resume(). It's also routine
2748 * to disconnect devices while they are suspended.
2750 * This only affects the USB hardware for a device; its interfaces
2751 * (and, for hubs, child devices) must already have been suspended.
2753 * Selective port suspend reduces power; most suspended devices draw
2754 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2755 * All devices below the suspended port are also suspended.
2757 * Devices leave suspend state when the host wakes them up. Some devices
2758 * also support "remote wakeup", where the device can activate the USB
2759 * tree above them to deliver data, such as a keypress or packet. In
2760 * some cases, this wakes the USB host.
2762 * Suspending OTG devices may trigger HNP, if that's been enabled
2763 * between a pair of dual-role devices. That will change roles, such
2764 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2766 * Devices on USB hub ports have only one "suspend" state, corresponding
2767 * to ACPI D2, "may cause the device to lose some context".
2768 * State transitions include:
2770 * - suspend, resume ... when the VBUS power link stays live
2771 * - suspend, disconnect ... VBUS lost
2773 * Once VBUS drop breaks the circuit, the port it's using has to go through
2774 * normal re-enumeration procedures, starting with enabling VBUS power.
2775 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2776 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2777 * timer, no SRP, no requests through sysfs.
2779 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
2780 * the root hub for their bus goes into global suspend ... so we don't
2781 * (falsely) update the device power state to say it suspended.
2783 * Returns 0 on success, else negative errno.
2785 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2787 struct usb_hub *hub = hdev_to_hub(udev->parent);
2788 int port1 = udev->portnum;
2791 /* enable remote wakeup when appropriate; this lets the device
2792 * wake up the upstream hub (including maybe the root hub).
2794 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2795 * we don't explicitly enable it here.
2797 if (udev->do_remote_wakeup) {
2798 if (!hub_is_superspeed(hub->hdev)) {
2799 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2800 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2801 USB_DEVICE_REMOTE_WAKEUP, 0,
2803 USB_CTRL_SET_TIMEOUT);
2805 /* Assume there's only one function on the USB 3.0
2806 * device and enable remote wake for the first
2807 * interface. FIXME if the interface association
2808 * descriptor shows there's more than one function.
2810 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2811 USB_REQ_SET_FEATURE,
2812 USB_RECIP_INTERFACE,
2813 USB_INTRF_FUNC_SUSPEND,
2814 USB_INTRF_FUNC_SUSPEND_RW |
2815 USB_INTRF_FUNC_SUSPEND_LP,
2817 USB_CTRL_SET_TIMEOUT);
2820 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
2822 /* bail if autosuspend is requested */
2823 if (PMSG_IS_AUTO(msg))
2828 /* disable USB2 hardware LPM */
2829 if (udev->usb2_hw_lpm_enabled == 1)
2830 usb_set_usb2_hardware_lpm(udev, 0);
2832 if (usb_disable_ltm(udev)) {
2833 dev_err(&udev->dev, "%s Failed to disable LTM before suspend\n.",
2837 if (usb_unlocked_disable_lpm(udev)) {
2838 dev_err(&udev->dev, "%s Failed to disable LPM before suspend\n.",
2844 if (hub_is_superspeed(hub->hdev))
2845 status = set_port_feature(hub->hdev,
2846 port1 | (USB_SS_PORT_LS_U3 << 3),
2847 USB_PORT_FEAT_LINK_STATE);
2849 status = set_port_feature(hub->hdev, port1,
2850 USB_PORT_FEAT_SUSPEND);
2852 dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
2854 /* paranoia: "should not happen" */
2855 if (udev->do_remote_wakeup)
2856 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2857 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2858 USB_DEVICE_REMOTE_WAKEUP, 0,
2860 USB_CTRL_SET_TIMEOUT);
2862 /* Try to enable USB2 hardware LPM again */
2863 if (udev->usb2_hw_lpm_capable == 1)
2864 usb_set_usb2_hardware_lpm(udev, 1);
2866 /* Try to enable USB3 LTM and LPM again */
2867 usb_enable_ltm(udev);
2868 usb_unlocked_enable_lpm(udev);
2870 /* System sleep transitions should never fail */
2871 if (!PMSG_IS_AUTO(msg))
2874 /* device has up to 10 msec to fully suspend */
2875 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
2876 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
2877 udev->do_remote_wakeup);
2878 usb_set_device_state(udev, USB_STATE_SUSPENDED);
2881 usb_mark_last_busy(hub->hdev);
2886 * If the USB "suspend" state is in use (rather than "global suspend"),
2887 * many devices will be individually taken out of suspend state using
2888 * special "resume" signaling. This routine kicks in shortly after
2889 * hardware resume signaling is finished, either because of selective
2890 * resume (by host) or remote wakeup (by device) ... now see what changed
2891 * in the tree that's rooted at this device.
2893 * If @udev->reset_resume is set then the device is reset before the
2894 * status check is done.
2896 static int finish_port_resume(struct usb_device *udev)
2901 /* caller owns the udev device lock */
2902 dev_dbg(&udev->dev, "%s\n",
2903 udev->reset_resume ? "finish reset-resume" : "finish resume");
2905 /* usb ch9 identifies four variants of SUSPENDED, based on what
2906 * state the device resumes to. Linux currently won't see the
2907 * first two on the host side; they'd be inside hub_port_init()
2908 * during many timeouts, but khubd can't suspend until later.
2910 usb_set_device_state(udev, udev->actconfig
2911 ? USB_STATE_CONFIGURED
2912 : USB_STATE_ADDRESS);
2914 /* 10.5.4.5 says not to reset a suspended port if the attached
2915 * device is enabled for remote wakeup. Hence the reset
2916 * operation is carried out here, after the port has been
2919 if (udev->reset_resume)
2921 status = usb_reset_and_verify_device(udev);
2923 /* 10.5.4.5 says be sure devices in the tree are still there.
2924 * For now let's assume the device didn't go crazy on resume,
2925 * and device drivers will know about any resume quirks.
2929 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
2931 status = (status > 0 ? 0 : -ENODEV);
2933 /* If a normal resume failed, try doing a reset-resume */
2934 if (status && !udev->reset_resume && udev->persist_enabled) {
2935 dev_dbg(&udev->dev, "retry with reset-resume\n");
2936 udev->reset_resume = 1;
2937 goto retry_reset_resume;
2942 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
2944 } else if (udev->actconfig) {
2945 le16_to_cpus(&devstatus);
2946 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) {
2947 status = usb_control_msg(udev,
2948 usb_sndctrlpipe(udev, 0),
2949 USB_REQ_CLEAR_FEATURE,
2951 USB_DEVICE_REMOTE_WAKEUP, 0,
2953 USB_CTRL_SET_TIMEOUT);
2956 "disable remote wakeup, status %d\n",
2965 * usb_port_resume - re-activate a suspended usb device's upstream port
2966 * @udev: device to re-activate, not a root hub
2967 * Context: must be able to sleep; device not locked; pm locks held
2969 * This will re-activate the suspended device, increasing power usage
2970 * while letting drivers communicate again with its endpoints.
2971 * USB resume explicitly guarantees that the power session between
2972 * the host and the device is the same as it was when the device
2975 * If @udev->reset_resume is set then this routine won't check that the
2976 * port is still enabled. Furthermore, finish_port_resume() above will
2977 * reset @udev. The end result is that a broken power session can be
2978 * recovered and @udev will appear to persist across a loss of VBUS power.
2980 * For example, if a host controller doesn't maintain VBUS suspend current
2981 * during a system sleep or is reset when the system wakes up, all the USB
2982 * power sessions below it will be broken. This is especially troublesome
2983 * for mass-storage devices containing mounted filesystems, since the
2984 * device will appear to have disconnected and all the memory mappings
2985 * to it will be lost. Using the USB_PERSIST facility, the device can be
2986 * made to appear as if it had not disconnected.
2988 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
2989 * every effort to insure that the same device is present after the
2990 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
2991 * quite possible for a device to remain unaltered but its media to be
2992 * changed. If the user replaces a flash memory card while the system is
2993 * asleep, he will have only himself to blame when the filesystem on the
2994 * new card is corrupted and the system crashes.
2996 * Returns 0 on success, else negative errno.
2998 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
3000 struct usb_hub *hub = hdev_to_hub(udev->parent);
3001 int port1 = udev->portnum;
3003 u16 portchange, portstatus;
3005 /* Skip the initial Clear-Suspend step for a remote wakeup */
3006 status = hub_port_status(hub, port1, &portstatus, &portchange);
3007 if (status == 0 && !port_is_suspended(hub, portstatus))
3008 goto SuspendCleared;
3010 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
3012 set_bit(port1, hub->busy_bits);
3014 /* see 7.1.7.7; affects power usage, but not budgeting */
3015 if (hub_is_superspeed(hub->hdev))
3016 status = set_port_feature(hub->hdev,
3017 port1 | (USB_SS_PORT_LS_U0 << 3),
3018 USB_PORT_FEAT_LINK_STATE);
3020 status = clear_port_feature(hub->hdev,
3021 port1, USB_PORT_FEAT_SUSPEND);
3023 dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
3026 /* drive resume for at least 20 msec */
3027 dev_dbg(&udev->dev, "usb %sresume\n",
3028 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
3031 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3032 * stop resume signaling. Then finish the resume
3035 status = hub_port_status(hub, port1, &portstatus, &portchange);
3037 /* TRSMRCY = 10 msec */
3043 if (hub_is_superspeed(hub->hdev)) {
3044 if (portchange & USB_PORT_STAT_C_LINK_STATE)
3045 clear_port_feature(hub->hdev, port1,
3046 USB_PORT_FEAT_C_PORT_LINK_STATE);
3048 if (portchange & USB_PORT_STAT_C_SUSPEND)
3049 clear_port_feature(hub->hdev, port1,
3050 USB_PORT_FEAT_C_SUSPEND);
3054 clear_bit(port1, hub->busy_bits);
3056 status = check_port_resume_type(udev,
3057 hub, port1, status, portchange, portstatus);
3059 status = finish_port_resume(udev);
3061 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
3062 hub_port_logical_disconnect(hub, port1);
3064 /* Try to enable USB2 hardware LPM */
3065 if (udev->usb2_hw_lpm_capable == 1)
3066 usb_set_usb2_hardware_lpm(udev, 1);
3068 /* Try to enable USB3 LTM and LPM */
3069 usb_enable_ltm(udev);
3070 usb_unlocked_enable_lpm(udev);
3076 /* caller has locked udev */
3077 int usb_remote_wakeup(struct usb_device *udev)
3081 if (udev->state == USB_STATE_SUSPENDED) {
3082 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
3083 status = usb_autoresume_device(udev);
3085 /* Let the drivers do their thing, then... */
3086 usb_autosuspend_device(udev);
3092 #else /* CONFIG_USB_SUSPEND */
3094 /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
3096 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
3101 /* However we may need to do a reset-resume */
3103 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
3105 struct usb_hub *hub = hdev_to_hub(udev->parent);
3106 int port1 = udev->portnum;
3108 u16 portchange, portstatus;
3110 status = hub_port_status(hub, port1, &portstatus, &portchange);
3111 status = check_port_resume_type(udev,
3112 hub, port1, status, portchange, portstatus);
3115 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
3116 hub_port_logical_disconnect(hub, port1);
3117 } else if (udev->reset_resume) {
3118 dev_dbg(&udev->dev, "reset-resume\n");
3119 status = usb_reset_and_verify_device(udev);
3126 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
3128 struct usb_hub *hub = usb_get_intfdata (intf);
3129 struct usb_device *hdev = hub->hdev;
3133 /* Warn if children aren't already suspended */
3134 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3135 struct usb_device *udev;
3137 udev = hub->ports[port1 - 1]->child;
3138 if (udev && udev->can_submit) {
3139 dev_warn(&intf->dev, "port %d nyet suspended\n", port1);
3140 if (PMSG_IS_AUTO(msg))
3144 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
3145 /* Enable hub to send remote wakeup for all ports. */
3146 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3147 status = set_port_feature(hdev,
3149 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
3150 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
3151 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
3152 USB_PORT_FEAT_REMOTE_WAKE_MASK);
3156 dev_dbg(&intf->dev, "%s\n", __func__);
3158 /* stop khubd and related activity */
3159 hub_quiesce(hub, HUB_SUSPEND);
3163 static int hub_resume(struct usb_interface *intf)
3165 struct usb_hub *hub = usb_get_intfdata(intf);
3167 dev_dbg(&intf->dev, "%s\n", __func__);
3168 hub_activate(hub, HUB_RESUME);
3172 static int hub_reset_resume(struct usb_interface *intf)
3174 struct usb_hub *hub = usb_get_intfdata(intf);
3176 dev_dbg(&intf->dev, "%s\n", __func__);
3177 hub_activate(hub, HUB_RESET_RESUME);
3182 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3183 * @rhdev: struct usb_device for the root hub
3185 * The USB host controller driver calls this function when its root hub
3186 * is resumed and Vbus power has been interrupted or the controller
3187 * has been reset. The routine marks @rhdev as having lost power.
3188 * When the hub driver is resumed it will take notice and carry out
3189 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3190 * the others will be disconnected.
3192 void usb_root_hub_lost_power(struct usb_device *rhdev)
3194 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
3195 rhdev->reset_resume = 1;
3197 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
3199 static const char * const usb3_lpm_names[] = {
3207 * Send a Set SEL control transfer to the device, prior to enabling
3208 * device-initiated U1 or U2. This lets the device know the exit latencies from
3209 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3210 * packet from the host.
3212 * This function will fail if the SEL or PEL values for udev are greater than
3213 * the maximum allowed values for the link state to be enabled.
3215 static int usb_req_set_sel(struct usb_device *udev, enum usb3_link_state state)
3217 struct usb_set_sel_req *sel_values;
3218 unsigned long long u1_sel;
3219 unsigned long long u1_pel;
3220 unsigned long long u2_sel;
3221 unsigned long long u2_pel;
3224 /* Convert SEL and PEL stored in ns to us */
3225 u1_sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
3226 u1_pel = DIV_ROUND_UP(udev->u1_params.pel, 1000);
3227 u2_sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
3228 u2_pel = DIV_ROUND_UP(udev->u2_params.pel, 1000);
3231 * Make sure that the calculated SEL and PEL values for the link
3232 * state we're enabling aren't bigger than the max SEL/PEL
3233 * value that will fit in the SET SEL control transfer.
3234 * Otherwise the device would get an incorrect idea of the exit
3235 * latency for the link state, and could start a device-initiated
3236 * U1/U2 when the exit latencies are too high.
3238 if ((state == USB3_LPM_U1 &&
3239 (u1_sel > USB3_LPM_MAX_U1_SEL_PEL ||
3240 u1_pel > USB3_LPM_MAX_U1_SEL_PEL)) ||
3241 (state == USB3_LPM_U2 &&
3242 (u2_sel > USB3_LPM_MAX_U2_SEL_PEL ||
3243 u2_pel > USB3_LPM_MAX_U2_SEL_PEL))) {
3244 dev_dbg(&udev->dev, "Device-initiated %s disabled due "
3245 "to long SEL %llu ms or PEL %llu ms\n",
3246 usb3_lpm_names[state], u1_sel, u1_pel);
3251 * If we're enabling device-initiated LPM for one link state,
3252 * but the other link state has a too high SEL or PEL value,
3253 * just set those values to the max in the Set SEL request.
3255 if (u1_sel > USB3_LPM_MAX_U1_SEL_PEL)
3256 u1_sel = USB3_LPM_MAX_U1_SEL_PEL;
3258 if (u1_pel > USB3_LPM_MAX_U1_SEL_PEL)
3259 u1_pel = USB3_LPM_MAX_U1_SEL_PEL;
3261 if (u2_sel > USB3_LPM_MAX_U2_SEL_PEL)
3262 u2_sel = USB3_LPM_MAX_U2_SEL_PEL;
3264 if (u2_pel > USB3_LPM_MAX_U2_SEL_PEL)
3265 u2_pel = USB3_LPM_MAX_U2_SEL_PEL;
3268 * usb_enable_lpm() can be called as part of a failed device reset,
3269 * which may be initiated by an error path of a mass storage driver.
3270 * Therefore, use GFP_NOIO.
3272 sel_values = kmalloc(sizeof *(sel_values), GFP_NOIO);
3276 sel_values->u1_sel = u1_sel;
3277 sel_values->u1_pel = u1_pel;
3278 sel_values->u2_sel = cpu_to_le16(u2_sel);
3279 sel_values->u2_pel = cpu_to_le16(u2_pel);
3281 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3285 sel_values, sizeof *(sel_values),
3286 USB_CTRL_SET_TIMEOUT);
3292 * Enable or disable device-initiated U1 or U2 transitions.
3294 static int usb_set_device_initiated_lpm(struct usb_device *udev,
3295 enum usb3_link_state state, bool enable)
3302 feature = USB_DEVICE_U1_ENABLE;
3305 feature = USB_DEVICE_U2_ENABLE;
3308 dev_warn(&udev->dev, "%s: Can't %s non-U1 or U2 state.\n",
3309 __func__, enable ? "enable" : "disable");
3313 if (udev->state != USB_STATE_CONFIGURED) {
3314 dev_dbg(&udev->dev, "%s: Can't %s %s state "
3315 "for unconfigured device.\n",
3316 __func__, enable ? "enable" : "disable",
3317 usb3_lpm_names[state]);
3323 * First, let the device know about the exit latencies
3324 * associated with the link state we're about to enable.
3326 ret = usb_req_set_sel(udev, state);
3328 dev_warn(&udev->dev, "Set SEL for device-initiated "
3329 "%s failed.\n", usb3_lpm_names[state]);
3333 * Now send the control transfer to enable device-initiated LPM
3334 * for either U1 or U2.
3336 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3337 USB_REQ_SET_FEATURE,
3341 USB_CTRL_SET_TIMEOUT);
3343 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3344 USB_REQ_CLEAR_FEATURE,
3348 USB_CTRL_SET_TIMEOUT);
3351 dev_warn(&udev->dev, "%s of device-initiated %s failed.\n",
3352 enable ? "Enable" : "Disable",
3353 usb3_lpm_names[state]);
3359 static int usb_set_lpm_timeout(struct usb_device *udev,
3360 enum usb3_link_state state, int timeout)
3367 feature = USB_PORT_FEAT_U1_TIMEOUT;
3370 feature = USB_PORT_FEAT_U2_TIMEOUT;
3373 dev_warn(&udev->dev, "%s: Can't set timeout for non-U1 or U2 state.\n",
3378 if (state == USB3_LPM_U1 && timeout > USB3_LPM_U1_MAX_TIMEOUT &&
3379 timeout != USB3_LPM_DEVICE_INITIATED) {
3380 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x, "
3381 "which is a reserved value.\n",
3382 usb3_lpm_names[state], timeout);
3386 ret = set_port_feature(udev->parent,
3387 USB_PORT_LPM_TIMEOUT(timeout) | udev->portnum,
3390 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x,"
3391 "error code %i\n", usb3_lpm_names[state],
3395 if (state == USB3_LPM_U1)
3396 udev->u1_params.timeout = timeout;
3398 udev->u2_params.timeout = timeout;
3403 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3406 * We will attempt to enable U1 or U2, but there are no guarantees that the
3407 * control transfers to set the hub timeout or enable device-initiated U1/U2
3408 * will be successful.
3410 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3411 * driver know about it. If that call fails, it should be harmless, and just
3412 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3414 static void usb_enable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3415 enum usb3_link_state state)
3419 /* We allow the host controller to set the U1/U2 timeout internally
3420 * first, so that it can change its schedule to account for the
3421 * additional latency to send data to a device in a lower power
3424 timeout = hcd->driver->enable_usb3_lpm_timeout(hcd, udev, state);
3426 /* xHCI host controller doesn't want to enable this LPM state. */
3431 dev_warn(&udev->dev, "Could not enable %s link state, "
3432 "xHCI error %i.\n", usb3_lpm_names[state],
3437 if (usb_set_lpm_timeout(udev, state, timeout))
3438 /* If we can't set the parent hub U1/U2 timeout,
3439 * device-initiated LPM won't be allowed either, so let the xHCI
3440 * host know that this link state won't be enabled.
3442 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
3444 /* Only a configured device will accept the Set Feature U1/U2_ENABLE */
3445 else if (udev->actconfig)
3446 usb_set_device_initiated_lpm(udev, state, true);
3451 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
3454 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
3455 * If zero is returned, the parent will not allow the link to go into U1/U2.
3457 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
3458 * it won't have an effect on the bus link state because the parent hub will
3459 * still disallow device-initiated U1/U2 entry.
3461 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
3462 * possible. The result will be slightly more bus bandwidth will be taken up
3463 * (to account for U1/U2 exit latency), but it should be harmless.
3465 static int usb_disable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3466 enum usb3_link_state state)
3472 feature = USB_PORT_FEAT_U1_TIMEOUT;
3475 feature = USB_PORT_FEAT_U2_TIMEOUT;
3478 dev_warn(&udev->dev, "%s: Can't disable non-U1 or U2 state.\n",
3483 if (usb_set_lpm_timeout(udev, state, 0))
3486 usb_set_device_initiated_lpm(udev, state, false);
3488 if (hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state))
3489 dev_warn(&udev->dev, "Could not disable xHCI %s timeout, "
3490 "bus schedule bandwidth may be impacted.\n",
3491 usb3_lpm_names[state]);
3496 * Disable hub-initiated and device-initiated U1 and U2 entry.
3497 * Caller must own the bandwidth_mutex.
3499 * This will call usb_enable_lpm() on failure, which will decrement
3500 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
3502 int usb_disable_lpm(struct usb_device *udev)
3504 struct usb_hcd *hcd;
3506 if (!udev || !udev->parent ||
3507 udev->speed != USB_SPEED_SUPER ||
3511 hcd = bus_to_hcd(udev->bus);
3512 if (!hcd || !hcd->driver->disable_usb3_lpm_timeout)
3515 udev->lpm_disable_count++;
3516 if ((udev->u1_params.timeout == 0 && udev->u2_params.timeout == 0))
3519 /* If LPM is enabled, attempt to disable it. */
3520 if (usb_disable_link_state(hcd, udev, USB3_LPM_U1))
3522 if (usb_disable_link_state(hcd, udev, USB3_LPM_U2))
3528 usb_enable_lpm(udev);
3531 EXPORT_SYMBOL_GPL(usb_disable_lpm);
3533 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
3534 int usb_unlocked_disable_lpm(struct usb_device *udev)
3536 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3542 mutex_lock(hcd->bandwidth_mutex);
3543 ret = usb_disable_lpm(udev);
3544 mutex_unlock(hcd->bandwidth_mutex);
3548 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
3551 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
3552 * xHCI host policy may prevent U1 or U2 from being enabled.
3554 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
3555 * until the lpm_disable_count drops to zero. Caller must own the
3558 void usb_enable_lpm(struct usb_device *udev)
3560 struct usb_hcd *hcd;
3562 if (!udev || !udev->parent ||
3563 udev->speed != USB_SPEED_SUPER ||
3567 udev->lpm_disable_count--;
3568 hcd = bus_to_hcd(udev->bus);
3569 /* Double check that we can both enable and disable LPM.
3570 * Device must be configured to accept set feature U1/U2 timeout.
3572 if (!hcd || !hcd->driver->enable_usb3_lpm_timeout ||
3573 !hcd->driver->disable_usb3_lpm_timeout)
3576 if (udev->lpm_disable_count > 0)
3579 usb_enable_link_state(hcd, udev, USB3_LPM_U1);
3580 usb_enable_link_state(hcd, udev, USB3_LPM_U2);
3582 EXPORT_SYMBOL_GPL(usb_enable_lpm);
3584 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
3585 void usb_unlocked_enable_lpm(struct usb_device *udev)
3587 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3592 mutex_lock(hcd->bandwidth_mutex);
3593 usb_enable_lpm(udev);
3594 mutex_unlock(hcd->bandwidth_mutex);
3596 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
3599 #else /* CONFIG_PM */
3601 #define hub_suspend NULL
3602 #define hub_resume NULL
3603 #define hub_reset_resume NULL
3605 int usb_disable_lpm(struct usb_device *udev)
3609 EXPORT_SYMBOL_GPL(usb_disable_lpm);
3611 void usb_enable_lpm(struct usb_device *udev) { }
3612 EXPORT_SYMBOL_GPL(usb_enable_lpm);
3614 int usb_unlocked_disable_lpm(struct usb_device *udev)
3618 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
3620 void usb_unlocked_enable_lpm(struct usb_device *udev) { }
3621 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
3623 int usb_disable_ltm(struct usb_device *udev)
3627 EXPORT_SYMBOL_GPL(usb_disable_ltm);
3629 void usb_enable_ltm(struct usb_device *udev) { }
3630 EXPORT_SYMBOL_GPL(usb_enable_ltm);
3634 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
3636 * Between connect detection and reset signaling there must be a delay
3637 * of 100ms at least for debounce and power-settling. The corresponding
3638 * timer shall restart whenever the downstream port detects a disconnect.
3640 * Apparently there are some bluetooth and irda-dongles and a number of
3641 * low-speed devices for which this debounce period may last over a second.
3642 * Not covered by the spec - but easy to deal with.
3644 * This implementation uses a 1500ms total debounce timeout; if the
3645 * connection isn't stable by then it returns -ETIMEDOUT. It checks
3646 * every 25ms for transient disconnects. When the port status has been
3647 * unchanged for 100ms it returns the port status.
3649 static int hub_port_debounce(struct usb_hub *hub, int port1)
3652 int total_time, stable_time = 0;
3653 u16 portchange, portstatus;
3654 unsigned connection = 0xffff;
3656 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
3657 ret = hub_port_status(hub, port1, &portstatus, &portchange);
3661 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
3662 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
3663 stable_time += HUB_DEBOUNCE_STEP;
3664 if (stable_time >= HUB_DEBOUNCE_STABLE)
3668 connection = portstatus & USB_PORT_STAT_CONNECTION;
3671 if (portchange & USB_PORT_STAT_C_CONNECTION) {
3672 clear_port_feature(hub->hdev, port1,
3673 USB_PORT_FEAT_C_CONNECTION);
3676 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
3678 msleep(HUB_DEBOUNCE_STEP);
3681 dev_dbg (hub->intfdev,
3682 "debounce: port %d: total %dms stable %dms status 0x%x\n",
3683 port1, total_time, stable_time, portstatus);
3685 if (stable_time < HUB_DEBOUNCE_STABLE)
3690 void usb_ep0_reinit(struct usb_device *udev)
3692 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
3693 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
3694 usb_enable_endpoint(udev, &udev->ep0, true);
3696 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
3698 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
3699 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
3701 static int hub_set_address(struct usb_device *udev, int devnum)
3704 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3707 * The host controller will choose the device address,
3708 * instead of the core having chosen it earlier
3710 if (!hcd->driver->address_device && devnum <= 1)
3712 if (udev->state == USB_STATE_ADDRESS)
3714 if (udev->state != USB_STATE_DEFAULT)
3716 if (hcd->driver->address_device)
3717 retval = hcd->driver->address_device(hcd, udev);
3719 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
3720 USB_REQ_SET_ADDRESS, 0, devnum, 0,
3721 NULL, 0, USB_CTRL_SET_TIMEOUT);
3723 update_devnum(udev, devnum);
3724 /* Device now using proper address. */
3725 usb_set_device_state(udev, USB_STATE_ADDRESS);
3726 usb_ep0_reinit(udev);
3731 /* Reset device, (re)assign address, get device descriptor.
3732 * Device connection must be stable, no more debouncing needed.
3733 * Returns device in USB_STATE_ADDRESS, except on error.
3735 * If this is called for an already-existing device (as part of
3736 * usb_reset_and_verify_device), the caller must own the device lock. For a
3737 * newly detected device that is not accessible through any global
3738 * pointers, it's not necessary to lock the device.
3741 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
3744 static DEFINE_MUTEX(usb_address0_mutex);
3746 struct usb_device *hdev = hub->hdev;
3747 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
3749 unsigned delay = HUB_SHORT_RESET_TIME;
3750 enum usb_device_speed oldspeed = udev->speed;
3752 int devnum = udev->devnum;
3754 /* root hub ports have a slightly longer reset period
3755 * (from USB 2.0 spec, section 7.1.7.5)
3757 if (!hdev->parent) {
3758 delay = HUB_ROOT_RESET_TIME;
3759 if (port1 == hdev->bus->otg_port)
3760 hdev->bus->b_hnp_enable = 0;
3763 /* Some low speed devices have problems with the quick delay, so */
3764 /* be a bit pessimistic with those devices. RHbug #23670 */
3765 if (oldspeed == USB_SPEED_LOW)
3766 delay = HUB_LONG_RESET_TIME;
3768 mutex_lock(&usb_address0_mutex);
3770 /* Reset the device; full speed may morph to high speed */
3771 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
3772 retval = hub_port_reset(hub, port1, udev, delay, false);
3773 if (retval < 0) /* error or disconnect */
3775 /* success, speed is known */
3779 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
3780 dev_dbg(&udev->dev, "device reset changed speed!\n");
3783 oldspeed = udev->speed;
3785 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
3786 * it's fixed size except for full speed devices.
3787 * For Wireless USB devices, ep0 max packet is always 512 (tho
3788 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
3790 switch (udev->speed) {
3791 case USB_SPEED_SUPER:
3792 case USB_SPEED_WIRELESS: /* fixed at 512 */
3793 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
3795 case USB_SPEED_HIGH: /* fixed at 64 */
3796 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
3798 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
3799 /* to determine the ep0 maxpacket size, try to read
3800 * the device descriptor to get bMaxPacketSize0 and
3801 * then correct our initial guess.
3803 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
3805 case USB_SPEED_LOW: /* fixed at 8 */
3806 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
3812 if (udev->speed == USB_SPEED_WIRELESS)
3813 speed = "variable speed Wireless";
3815 speed = usb_speed_string(udev->speed);
3817 if (udev->speed != USB_SPEED_SUPER)
3818 dev_info(&udev->dev,
3819 "%s %s USB device number %d using %s\n",
3820 (udev->config) ? "reset" : "new", speed,
3821 devnum, udev->bus->controller->driver->name);
3823 /* Set up TT records, if needed */
3825 udev->tt = hdev->tt;
3826 udev->ttport = hdev->ttport;
3827 } else if (udev->speed != USB_SPEED_HIGH
3828 && hdev->speed == USB_SPEED_HIGH) {
3830 dev_err(&udev->dev, "parent hub has no TT\n");
3834 udev->tt = &hub->tt;
3835 udev->ttport = port1;
3838 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
3839 * Because device hardware and firmware is sometimes buggy in
3840 * this area, and this is how Linux has done it for ages.
3841 * Change it cautiously.
3843 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
3844 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
3845 * so it may help with some non-standards-compliant devices.
3846 * Otherwise we start with SET_ADDRESS and then try to read the
3847 * first 8 bytes of the device descriptor to get the ep0 maxpacket
3850 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
3851 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3)) {
3852 struct usb_device_descriptor *buf;
3855 #define GET_DESCRIPTOR_BUFSIZE 64
3856 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
3862 /* Retry on all errors; some devices are flakey.
3863 * 255 is for WUSB devices, we actually need to use
3864 * 512 (WUSB1.0[4.8.1]).
3866 for (j = 0; j < 3; ++j) {
3867 buf->bMaxPacketSize0 = 0;
3868 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
3869 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
3870 USB_DT_DEVICE << 8, 0,
3871 buf, GET_DESCRIPTOR_BUFSIZE,
3872 initial_descriptor_timeout);
3873 switch (buf->bMaxPacketSize0) {
3874 case 8: case 16: case 32: case 64: case 255:
3875 if (buf->bDescriptorType ==
3889 udev->descriptor.bMaxPacketSize0 =
3890 buf->bMaxPacketSize0;
3893 retval = hub_port_reset(hub, port1, udev, delay, false);
3894 if (retval < 0) /* error or disconnect */
3896 if (oldspeed != udev->speed) {
3898 "device reset changed speed!\n");
3904 "device descriptor read/64, error %d\n",
3909 #undef GET_DESCRIPTOR_BUFSIZE
3913 * If device is WUSB, we already assigned an
3914 * unauthorized address in the Connect Ack sequence;
3915 * authorization will assign the final address.
3917 if (udev->wusb == 0) {
3918 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
3919 retval = hub_set_address(udev, devnum);
3926 "device not accepting address %d, error %d\n",
3930 if (udev->speed == USB_SPEED_SUPER) {
3931 devnum = udev->devnum;
3932 dev_info(&udev->dev,
3933 "%s SuperSpeed USB device number %d using %s\n",
3934 (udev->config) ? "reset" : "new",
3935 devnum, udev->bus->controller->driver->name);
3938 /* cope with hardware quirkiness:
3939 * - let SET_ADDRESS settle, some device hardware wants it
3940 * - read ep0 maxpacket even for high and low speed,
3943 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3))
3947 retval = usb_get_device_descriptor(udev, 8);
3950 "device descriptor read/8, error %d\n",
3963 * Some superspeed devices have finished the link training process
3964 * and attached to a superspeed hub port, but the device descriptor
3965 * got from those devices show they aren't superspeed devices. Warm
3966 * reset the port attached by the devices can fix them.
3968 if ((udev->speed == USB_SPEED_SUPER) &&
3969 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
3970 dev_err(&udev->dev, "got a wrong device descriptor, "
3971 "warm reset device\n");
3972 hub_port_reset(hub, port1, udev,
3973 HUB_BH_RESET_TIME, true);
3978 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
3979 udev->speed == USB_SPEED_SUPER)
3982 i = udev->descriptor.bMaxPacketSize0;
3983 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
3984 if (udev->speed == USB_SPEED_LOW ||
3985 !(i == 8 || i == 16 || i == 32 || i == 64)) {
3986 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
3990 if (udev->speed == USB_SPEED_FULL)
3991 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
3993 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
3994 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
3995 usb_ep0_reinit(udev);
3998 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
3999 if (retval < (signed)sizeof(udev->descriptor)) {
4000 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
4007 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
4008 retval = usb_get_bos_descriptor(udev);
4010 udev->lpm_capable = usb_device_supports_lpm(udev);
4011 usb_set_lpm_parameters(udev);
4016 /* notify HCD that we have a device connected and addressed */
4017 if (hcd->driver->update_device)
4018 hcd->driver->update_device(hcd, udev);
4021 hub_port_disable(hub, port1, 0);
4022 update_devnum(udev, devnum); /* for disconnect processing */
4024 mutex_unlock(&usb_address0_mutex);
4029 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
4031 struct usb_qualifier_descriptor *qual;
4034 qual = kmalloc (sizeof *qual, GFP_KERNEL);
4038 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
4039 qual, sizeof *qual);
4040 if (status == sizeof *qual) {
4041 dev_info(&udev->dev, "not running at top speed; "
4042 "connect to a high speed hub\n");
4043 /* hub LEDs are probably harder to miss than syslog */
4044 if (hub->has_indicators) {
4045 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
4046 schedule_delayed_work (&hub->leds, 0);
4053 hub_power_remaining (struct usb_hub *hub)
4055 struct usb_device *hdev = hub->hdev;
4059 if (!hub->limited_power)
4062 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
4063 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
4064 struct usb_device *udev = hub->ports[port1 - 1]->child;
4070 /* Unconfigured devices may not use more than 100mA,
4071 * or 8mA for OTG ports */
4072 if (udev->actconfig)
4073 delta = udev->actconfig->desc.bMaxPower * 2;
4074 else if (port1 != udev->bus->otg_port || hdev->parent)
4078 if (delta > hub->mA_per_port)
4079 dev_warn(&udev->dev,
4080 "%dmA is over %umA budget for port %d!\n",
4081 delta, hub->mA_per_port, port1);
4084 if (remaining < 0) {
4085 dev_warn(hub->intfdev, "%dmA over power budget!\n",
4092 /* Handle physical or logical connection change events.
4093 * This routine is called when:
4094 * a port connection-change occurs;
4095 * a port enable-change occurs (often caused by EMI);
4096 * usb_reset_and_verify_device() encounters changed descriptors (as from
4097 * a firmware download)
4098 * caller already locked the hub
4100 static void hub_port_connect_change(struct usb_hub *hub, int port1,
4101 u16 portstatus, u16 portchange)
4103 struct usb_device *hdev = hub->hdev;
4104 struct device *hub_dev = hub->intfdev;
4105 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4106 unsigned wHubCharacteristics =
4107 le16_to_cpu(hub->descriptor->wHubCharacteristics);
4108 struct usb_device *udev;
4112 "port %d, status %04x, change %04x, %s\n",
4113 port1, portstatus, portchange, portspeed(hub, portstatus));
4115 if (hub->has_indicators) {
4116 set_port_led(hub, port1, HUB_LED_AUTO);
4117 hub->indicator[port1-1] = INDICATOR_AUTO;
4120 #ifdef CONFIG_USB_OTG
4121 /* during HNP, don't repeat the debounce */
4122 if (hdev->bus->is_b_host)
4123 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
4124 USB_PORT_STAT_C_ENABLE);
4127 /* Try to resuscitate an existing device */
4128 udev = hub->ports[port1 - 1]->child;
4129 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
4130 udev->state != USB_STATE_NOTATTACHED) {
4131 usb_lock_device(udev);
4132 if (portstatus & USB_PORT_STAT_ENABLE) {
4133 status = 0; /* Nothing to do */
4135 #ifdef CONFIG_USB_SUSPEND
4136 } else if (udev->state == USB_STATE_SUSPENDED &&
4137 udev->persist_enabled) {
4138 /* For a suspended device, treat this as a
4139 * remote wakeup event.
4141 status = usb_remote_wakeup(udev);
4145 status = -ENODEV; /* Don't resuscitate */
4147 usb_unlock_device(udev);
4150 clear_bit(port1, hub->change_bits);
4155 /* Disconnect any existing devices under this port */
4157 usb_disconnect(&hub->ports[port1 - 1]->child);
4158 clear_bit(port1, hub->change_bits);
4160 /* We can forget about a "removed" device when there's a physical
4161 * disconnect or the connect status changes.
4163 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4164 (portchange & USB_PORT_STAT_C_CONNECTION))
4165 clear_bit(port1, hub->removed_bits);
4167 if (portchange & (USB_PORT_STAT_C_CONNECTION |
4168 USB_PORT_STAT_C_ENABLE)) {
4169 status = hub_port_debounce(hub, port1);
4171 if (printk_ratelimit())
4172 dev_err(hub_dev, "connect-debounce failed, "
4173 "port %d disabled\n", port1);
4174 portstatus &= ~USB_PORT_STAT_CONNECTION;
4176 portstatus = status;
4180 if (hcd->phy && !hdev->parent) {
4181 if (portstatus & USB_PORT_STAT_CONNECTION)
4182 usb_phy_notify_connect(hcd->phy, port1);
4184 usb_phy_notify_disconnect(hcd->phy, port1);
4187 /* Return now if debouncing failed or nothing is connected or
4188 * the device was "removed".
4190 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4191 test_bit(port1, hub->removed_bits)) {
4193 /* maybe switch power back on (e.g. root hub was reset) */
4194 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
4195 && !port_is_power_on(hub, portstatus))
4196 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
4198 if (portstatus & USB_PORT_STAT_ENABLE)
4203 for (i = 0; i < SET_CONFIG_TRIES; i++) {
4205 /* reallocate for each attempt, since references
4206 * to the previous one can escape in various ways
4208 udev = usb_alloc_dev(hdev, hdev->bus, port1);
4211 "couldn't allocate port %d usb_device\n",
4216 usb_set_device_state(udev, USB_STATE_POWERED);
4217 udev->bus_mA = hub->mA_per_port;
4218 udev->level = hdev->level + 1;
4219 udev->wusb = hub_is_wusb(hub);
4221 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
4222 if (hub_is_superspeed(hub->hdev))
4223 udev->speed = USB_SPEED_SUPER;
4225 udev->speed = USB_SPEED_UNKNOWN;
4227 choose_devnum(udev);
4228 if (udev->devnum <= 0) {
4229 status = -ENOTCONN; /* Don't retry */
4233 /* reset (non-USB 3.0 devices) and get descriptor */
4234 status = hub_port_init(hub, udev, port1, i);
4238 usb_detect_quirks(udev);
4239 if (udev->quirks & USB_QUIRK_DELAY_INIT)
4242 /* consecutive bus-powered hubs aren't reliable; they can
4243 * violate the voltage drop budget. if the new child has
4244 * a "powered" LED, users should notice we didn't enable it
4245 * (without reading syslog), even without per-port LEDs
4248 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
4249 && udev->bus_mA <= 100) {
4252 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
4255 dev_dbg(&udev->dev, "get status %d ?\n", status);
4258 le16_to_cpus(&devstat);
4259 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
4261 "can't connect bus-powered hub "
4263 if (hub->has_indicators) {
4264 hub->indicator[port1-1] =
4265 INDICATOR_AMBER_BLINK;
4266 schedule_delayed_work (&hub->leds, 0);
4268 status = -ENOTCONN; /* Don't retry */
4273 /* check for devices running slower than they could */
4274 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
4275 && udev->speed == USB_SPEED_FULL
4276 && highspeed_hubs != 0)
4277 check_highspeed (hub, udev, port1);
4279 /* Store the parent's children[] pointer. At this point
4280 * udev becomes globally accessible, although presumably
4281 * no one will look at it until hdev is unlocked.
4285 /* We mustn't add new devices if the parent hub has
4286 * been disconnected; we would race with the
4287 * recursively_mark_NOTATTACHED() routine.
4289 spin_lock_irq(&device_state_lock);
4290 if (hdev->state == USB_STATE_NOTATTACHED)
4293 hub->ports[port1 - 1]->child = udev;
4294 spin_unlock_irq(&device_state_lock);
4296 /* Run it through the hoops (find a driver, etc) */
4298 status = usb_new_device(udev);
4300 spin_lock_irq(&device_state_lock);
4301 hub->ports[port1 - 1]->child = NULL;
4302 spin_unlock_irq(&device_state_lock);
4309 status = hub_power_remaining(hub);
4311 dev_dbg(hub_dev, "%dmA power budget left\n", status);
4316 hub_port_disable(hub, port1, 1);
4318 usb_ep0_reinit(udev);
4319 release_devnum(udev);
4322 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
4325 if (hub->hdev->parent ||
4326 !hcd->driver->port_handed_over ||
4327 !(hcd->driver->port_handed_over)(hcd, port1))
4328 dev_err(hub_dev, "unable to enumerate USB device on port %d\n",
4332 hub_port_disable(hub, port1, 1);
4333 if (hcd->driver->relinquish_port && !hub->hdev->parent)
4334 hcd->driver->relinquish_port(hcd, port1);
4337 /* Returns 1 if there was a remote wakeup and a connect status change. */
4338 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
4339 u16 portstatus, u16 portchange)
4341 struct usb_device *hdev;
4342 struct usb_device *udev;
4343 int connect_change = 0;
4347 udev = hub->ports[port - 1]->child;
4348 if (!hub_is_superspeed(hdev)) {
4349 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
4351 clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
4353 if (!udev || udev->state != USB_STATE_SUSPENDED ||
4354 (portstatus & USB_PORT_STAT_LINK_STATE) !=
4360 /* TRSMRCY = 10 msec */
4363 usb_lock_device(udev);
4364 ret = usb_remote_wakeup(udev);
4365 usb_unlock_device(udev);
4370 hub_port_disable(hub, port, 1);
4372 dev_dbg(hub->intfdev, "resume on port %d, status %d\n",
4374 return connect_change;
4377 static void hub_events(void)
4379 struct list_head *tmp;
4380 struct usb_device *hdev;
4381 struct usb_interface *intf;
4382 struct usb_hub *hub;
4383 struct device *hub_dev;
4389 int connect_change, wakeup_change;
4392 * We restart the list every time to avoid a deadlock with
4393 * deleting hubs downstream from this one. This should be
4394 * safe since we delete the hub from the event list.
4395 * Not the most efficient, but avoids deadlocks.
4399 /* Grab the first entry at the beginning of the list */
4400 spin_lock_irq(&hub_event_lock);
4401 if (list_empty(&hub_event_list)) {
4402 spin_unlock_irq(&hub_event_lock);
4406 tmp = hub_event_list.next;
4409 hub = list_entry(tmp, struct usb_hub, event_list);
4410 kref_get(&hub->kref);
4411 spin_unlock_irq(&hub_event_lock);
4414 hub_dev = hub->intfdev;
4415 intf = to_usb_interface(hub_dev);
4416 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
4417 hdev->state, hub->descriptor
4418 ? hub->descriptor->bNbrPorts
4420 /* NOTE: expects max 15 ports... */
4421 (u16) hub->change_bits[0],
4422 (u16) hub->event_bits[0]);
4424 /* Lock the device, then check to see if we were
4425 * disconnected while waiting for the lock to succeed. */
4426 usb_lock_device(hdev);
4427 if (unlikely(hub->disconnected))
4428 goto loop_disconnected;
4430 /* If the hub has died, clean up after it */
4431 if (hdev->state == USB_STATE_NOTATTACHED) {
4432 hub->error = -ENODEV;
4433 hub_quiesce(hub, HUB_DISCONNECT);
4438 ret = usb_autopm_get_interface(intf);
4440 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
4444 /* If this is an inactive hub, do nothing */
4449 dev_dbg (hub_dev, "resetting for error %d\n",
4452 ret = usb_reset_device(hdev);
4455 "error resetting hub: %d\n", ret);
4463 /* deal with port status changes */
4464 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
4465 if (test_bit(i, hub->busy_bits))
4467 connect_change = test_bit(i, hub->change_bits);
4468 wakeup_change = test_and_clear_bit(i, hub->wakeup_bits);
4469 if (!test_and_clear_bit(i, hub->event_bits) &&
4470 !connect_change && !wakeup_change)
4473 ret = hub_port_status(hub, i,
4474 &portstatus, &portchange);
4478 if (portchange & USB_PORT_STAT_C_CONNECTION) {
4479 clear_port_feature(hdev, i,
4480 USB_PORT_FEAT_C_CONNECTION);
4484 if (portchange & USB_PORT_STAT_C_ENABLE) {
4485 if (!connect_change)
4487 "port %d enable change, "
4490 clear_port_feature(hdev, i,
4491 USB_PORT_FEAT_C_ENABLE);
4494 * EM interference sometimes causes badly
4495 * shielded USB devices to be shutdown by
4496 * the hub, this hack enables them again.
4497 * Works at least with mouse driver.
4499 if (!(portstatus & USB_PORT_STAT_ENABLE)
4501 && hub->ports[i - 1]->child) {
4504 "disabled by hub (EMI?), "
4511 if (hub_handle_remote_wakeup(hub, i,
4512 portstatus, portchange))
4515 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
4519 dev_dbg(hub_dev, "over-current change on port "
4521 clear_port_feature(hdev, i,
4522 USB_PORT_FEAT_C_OVER_CURRENT);
4523 msleep(100); /* Cool down */
4524 hub_power_on(hub, true);
4525 hub_port_status(hub, i, &status, &unused);
4526 if (status & USB_PORT_STAT_OVERCURRENT)
4527 dev_err(hub_dev, "over-current "
4528 "condition on port %d\n", i);
4531 if (portchange & USB_PORT_STAT_C_RESET) {
4533 "reset change on port %d\n",
4535 clear_port_feature(hdev, i,
4536 USB_PORT_FEAT_C_RESET);
4538 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
4539 hub_is_superspeed(hub->hdev)) {
4541 "warm reset change on port %d\n",
4543 clear_port_feature(hdev, i,
4544 USB_PORT_FEAT_C_BH_PORT_RESET);
4546 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
4547 clear_port_feature(hub->hdev, i,
4548 USB_PORT_FEAT_C_PORT_LINK_STATE);
4550 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
4552 "config error on port %d\n",
4554 clear_port_feature(hub->hdev, i,
4555 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
4558 /* Warm reset a USB3 protocol port if it's in
4559 * SS.Inactive state.
4561 if (hub_port_warm_reset_required(hub, portstatus)) {
4562 dev_dbg(hub_dev, "warm reset port %d\n", i);
4563 hub_port_reset(hub, i, NULL,
4564 HUB_BH_RESET_TIME, true);
4568 hub_port_connect_change(hub, i,
4569 portstatus, portchange);
4572 /* deal with hub status changes */
4573 if (test_and_clear_bit(0, hub->event_bits) == 0)
4575 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
4576 dev_err (hub_dev, "get_hub_status failed\n");
4578 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
4579 dev_dbg (hub_dev, "power change\n");
4580 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
4581 if (hubstatus & HUB_STATUS_LOCAL_POWER)
4582 /* FIXME: Is this always true? */
4583 hub->limited_power = 1;
4585 hub->limited_power = 0;
4587 if (hubchange & HUB_CHANGE_OVERCURRENT) {
4591 dev_dbg(hub_dev, "over-current change\n");
4592 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
4593 msleep(500); /* Cool down */
4594 hub_power_on(hub, true);
4595 hub_hub_status(hub, &status, &unused);
4596 if (status & HUB_STATUS_OVERCURRENT)
4597 dev_err(hub_dev, "over-current "
4603 /* Balance the usb_autopm_get_interface() above */
4604 usb_autopm_put_interface_no_suspend(intf);
4606 /* Balance the usb_autopm_get_interface_no_resume() in
4607 * kick_khubd() and allow autosuspend.
4609 usb_autopm_put_interface(intf);
4611 usb_unlock_device(hdev);
4612 kref_put(&hub->kref, hub_release);
4614 } /* end while (1) */
4617 static int hub_thread(void *__unused)
4619 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
4620 * port handover. Otherwise it might see that a full-speed device
4621 * was gone before the EHCI controller had handed its port over to
4622 * the companion full-speed controller.
4628 wait_event_freezable(khubd_wait,
4629 !list_empty(&hub_event_list) ||
4630 kthread_should_stop());
4631 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
4633 pr_debug("%s: khubd exiting\n", usbcore_name);
4637 static const struct usb_device_id hub_id_table[] = {
4638 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
4639 .bDeviceClass = USB_CLASS_HUB},
4640 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
4641 .bInterfaceClass = USB_CLASS_HUB},
4642 { } /* Terminating entry */
4645 MODULE_DEVICE_TABLE (usb, hub_id_table);
4647 static struct usb_driver hub_driver = {
4650 .disconnect = hub_disconnect,
4651 .suspend = hub_suspend,
4652 .resume = hub_resume,
4653 .reset_resume = hub_reset_resume,
4654 .pre_reset = hub_pre_reset,
4655 .post_reset = hub_post_reset,
4656 .unlocked_ioctl = hub_ioctl,
4657 .id_table = hub_id_table,
4658 .supports_autosuspend = 1,
4661 int usb_hub_init(void)
4663 if (usb_register(&hub_driver) < 0) {
4664 printk(KERN_ERR "%s: can't register hub driver\n",
4669 khubd_task = kthread_run(hub_thread, NULL, "khubd");
4670 if (!IS_ERR(khubd_task))
4673 /* Fall through if kernel_thread failed */
4674 usb_deregister(&hub_driver);
4675 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
4680 void usb_hub_cleanup(void)
4682 kthread_stop(khubd_task);
4685 * Hub resources are freed for us by usb_deregister. It calls
4686 * usb_driver_purge on every device which in turn calls that
4687 * devices disconnect function if it is using this driver.
4688 * The hub_disconnect function takes care of releasing the
4689 * individual hub resources. -greg
4691 usb_deregister(&hub_driver);
4692 } /* usb_hub_cleanup() */
4694 static int descriptors_changed(struct usb_device *udev,
4695 struct usb_device_descriptor *old_device_descriptor)
4699 unsigned serial_len = 0;
4701 unsigned old_length;
4705 if (memcmp(&udev->descriptor, old_device_descriptor,
4706 sizeof(*old_device_descriptor)) != 0)
4709 /* Since the idVendor, idProduct, and bcdDevice values in the
4710 * device descriptor haven't changed, we will assume the
4711 * Manufacturer and Product strings haven't changed either.
4712 * But the SerialNumber string could be different (e.g., a
4713 * different flash card of the same brand).
4716 serial_len = strlen(udev->serial) + 1;
4719 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
4720 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
4721 len = max(len, old_length);
4724 buf = kmalloc(len, GFP_NOIO);
4726 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
4727 /* assume the worst */
4730 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
4731 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
4732 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
4734 if (length != old_length) {
4735 dev_dbg(&udev->dev, "config index %d, error %d\n",
4740 if (memcmp (buf, udev->rawdescriptors[index], old_length)
4742 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
4744 ((struct usb_config_descriptor *) buf)->
4745 bConfigurationValue);
4751 if (!changed && serial_len) {
4752 length = usb_string(udev, udev->descriptor.iSerialNumber,
4754 if (length + 1 != serial_len) {
4755 dev_dbg(&udev->dev, "serial string error %d\n",
4758 } else if (memcmp(buf, udev->serial, length) != 0) {
4759 dev_dbg(&udev->dev, "serial string changed\n");
4769 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
4770 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
4772 * WARNING - don't use this routine to reset a composite device
4773 * (one with multiple interfaces owned by separate drivers)!
4774 * Use usb_reset_device() instead.
4776 * Do a port reset, reassign the device's address, and establish its
4777 * former operating configuration. If the reset fails, or the device's
4778 * descriptors change from their values before the reset, or the original
4779 * configuration and altsettings cannot be restored, a flag will be set
4780 * telling khubd to pretend the device has been disconnected and then
4781 * re-connected. All drivers will be unbound, and the device will be
4782 * re-enumerated and probed all over again.
4784 * Returns 0 if the reset succeeded, -ENODEV if the device has been
4785 * flagged for logical disconnection, or some other negative error code
4786 * if the reset wasn't even attempted.
4788 * The caller must own the device lock. For example, it's safe to use
4789 * this from a driver probe() routine after downloading new firmware.
4790 * For calls that might not occur during probe(), drivers should lock
4791 * the device using usb_lock_device_for_reset().
4793 * Locking exception: This routine may also be called from within an
4794 * autoresume handler. Such usage won't conflict with other tasks
4795 * holding the device lock because these tasks should always call
4796 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
4798 static int usb_reset_and_verify_device(struct usb_device *udev)
4800 struct usb_device *parent_hdev = udev->parent;
4801 struct usb_hub *parent_hub;
4802 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4803 struct usb_device_descriptor descriptor = udev->descriptor;
4805 int port1 = udev->portnum;
4807 if (udev->state == USB_STATE_NOTATTACHED ||
4808 udev->state == USB_STATE_SUSPENDED) {
4809 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
4815 /* this requires hcd-specific logic; see ohci_restart() */
4816 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
4819 parent_hub = hdev_to_hub(parent_hdev);
4821 /* Disable LPM and LTM while we reset the device and reinstall the alt
4822 * settings. Device-initiated LPM settings, and system exit latency
4823 * settings are cleared when the device is reset, so we have to set
4826 ret = usb_unlocked_disable_lpm(udev);
4828 dev_err(&udev->dev, "%s Failed to disable LPM\n.", __func__);
4831 ret = usb_disable_ltm(udev);
4833 dev_err(&udev->dev, "%s Failed to disable LTM\n.",
4838 set_bit(port1, parent_hub->busy_bits);
4839 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
4841 /* ep0 maxpacket size may change; let the HCD know about it.
4842 * Other endpoints will be handled by re-enumeration. */
4843 usb_ep0_reinit(udev);
4844 ret = hub_port_init(parent_hub, udev, port1, i);
4845 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
4848 clear_bit(port1, parent_hub->busy_bits);
4853 /* Device might have changed firmware (DFU or similar) */
4854 if (descriptors_changed(udev, &descriptor)) {
4855 dev_info(&udev->dev, "device firmware changed\n");
4856 udev->descriptor = descriptor; /* for disconnect() calls */
4860 /* Restore the device's previous configuration */
4861 if (!udev->actconfig)
4864 mutex_lock(hcd->bandwidth_mutex);
4865 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
4867 dev_warn(&udev->dev,
4868 "Busted HC? Not enough HCD resources for "
4869 "old configuration.\n");
4870 mutex_unlock(hcd->bandwidth_mutex);
4873 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
4874 USB_REQ_SET_CONFIGURATION, 0,
4875 udev->actconfig->desc.bConfigurationValue, 0,
4876 NULL, 0, USB_CTRL_SET_TIMEOUT);
4879 "can't restore configuration #%d (error=%d)\n",
4880 udev->actconfig->desc.bConfigurationValue, ret);
4881 mutex_unlock(hcd->bandwidth_mutex);
4884 mutex_unlock(hcd->bandwidth_mutex);
4885 usb_set_device_state(udev, USB_STATE_CONFIGURED);
4887 /* Put interfaces back into the same altsettings as before.
4888 * Don't bother to send the Set-Interface request for interfaces
4889 * that were already in altsetting 0; besides being unnecessary,
4890 * many devices can't handle it. Instead just reset the host-side
4893 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
4894 struct usb_host_config *config = udev->actconfig;
4895 struct usb_interface *intf = config->interface[i];
4896 struct usb_interface_descriptor *desc;
4898 desc = &intf->cur_altsetting->desc;
4899 if (desc->bAlternateSetting == 0) {
4900 usb_disable_interface(udev, intf, true);
4901 usb_enable_interface(udev, intf, true);
4904 /* Let the bandwidth allocation function know that this
4905 * device has been reset, and it will have to use
4906 * alternate setting 0 as the current alternate setting.
4908 intf->resetting_device = 1;
4909 ret = usb_set_interface(udev, desc->bInterfaceNumber,
4910 desc->bAlternateSetting);
4911 intf->resetting_device = 0;
4914 dev_err(&udev->dev, "failed to restore interface %d "
4915 "altsetting %d (error=%d)\n",
4916 desc->bInterfaceNumber,
4917 desc->bAlternateSetting,
4924 /* Now that the alt settings are re-installed, enable LTM and LPM. */
4925 usb_unlocked_enable_lpm(udev);
4926 usb_enable_ltm(udev);
4930 /* LPM state doesn't matter when we're about to destroy the device. */
4931 hub_port_logical_disconnect(parent_hub, port1);
4936 * usb_reset_device - warn interface drivers and perform a USB port reset
4937 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
4939 * Warns all drivers bound to registered interfaces (using their pre_reset
4940 * method), performs the port reset, and then lets the drivers know that
4941 * the reset is over (using their post_reset method).
4943 * Return value is the same as for usb_reset_and_verify_device().
4945 * The caller must own the device lock. For example, it's safe to use
4946 * this from a driver probe() routine after downloading new firmware.
4947 * For calls that might not occur during probe(), drivers should lock
4948 * the device using usb_lock_device_for_reset().
4950 * If an interface is currently being probed or disconnected, we assume
4951 * its driver knows how to handle resets. For all other interfaces,
4952 * if the driver doesn't have pre_reset and post_reset methods then
4953 * we attempt to unbind it and rebind afterward.
4955 int usb_reset_device(struct usb_device *udev)
4959 struct usb_host_config *config = udev->actconfig;
4961 if (udev->state == USB_STATE_NOTATTACHED ||
4962 udev->state == USB_STATE_SUSPENDED) {
4963 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
4968 /* Prevent autosuspend during the reset */
4969 usb_autoresume_device(udev);
4972 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
4973 struct usb_interface *cintf = config->interface[i];
4974 struct usb_driver *drv;
4977 if (cintf->dev.driver) {
4978 drv = to_usb_driver(cintf->dev.driver);
4979 if (drv->pre_reset && drv->post_reset)
4980 unbind = (drv->pre_reset)(cintf);
4981 else if (cintf->condition ==
4982 USB_INTERFACE_BOUND)
4985 usb_forced_unbind_intf(cintf);
4990 ret = usb_reset_and_verify_device(udev);
4993 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
4994 struct usb_interface *cintf = config->interface[i];
4995 struct usb_driver *drv;
4996 int rebind = cintf->needs_binding;
4998 if (!rebind && cintf->dev.driver) {
4999 drv = to_usb_driver(cintf->dev.driver);
5000 if (drv->post_reset)
5001 rebind = (drv->post_reset)(cintf);
5002 else if (cintf->condition ==
5003 USB_INTERFACE_BOUND)
5006 if (ret == 0 && rebind)
5007 usb_rebind_intf(cintf);
5011 usb_autosuspend_device(udev);
5014 EXPORT_SYMBOL_GPL(usb_reset_device);
5018 * usb_queue_reset_device - Reset a USB device from an atomic context
5019 * @iface: USB interface belonging to the device to reset
5021 * This function can be used to reset a USB device from an atomic
5022 * context, where usb_reset_device() won't work (as it blocks).
5024 * Doing a reset via this method is functionally equivalent to calling
5025 * usb_reset_device(), except for the fact that it is delayed to a
5026 * workqueue. This means that any drivers bound to other interfaces
5027 * might be unbound, as well as users from usbfs in user space.
5031 * - Scheduling two resets at the same time from two different drivers
5032 * attached to two different interfaces of the same device is
5033 * possible; depending on how the driver attached to each interface
5034 * handles ->pre_reset(), the second reset might happen or not.
5036 * - If a driver is unbound and it had a pending reset, the reset will
5039 * - This function can be called during .probe() or .disconnect()
5040 * times. On return from .disconnect(), any pending resets will be
5043 * There is no no need to lock/unlock the @reset_ws as schedule_work()
5046 * NOTE: We don't do any reference count tracking because it is not
5047 * needed. The lifecycle of the work_struct is tied to the
5048 * usb_interface. Before destroying the interface we cancel the
5049 * work_struct, so the fact that work_struct is queued and or
5050 * running means the interface (and thus, the device) exist and
5053 void usb_queue_reset_device(struct usb_interface *iface)
5055 schedule_work(&iface->reset_ws);
5057 EXPORT_SYMBOL_GPL(usb_queue_reset_device);
5060 * usb_hub_find_child - Get the pointer of child device
5061 * attached to the port which is specified by @port1.
5062 * @hdev: USB device belonging to the usb hub
5063 * @port1: port num to indicate which port the child device
5066 * USB drivers call this function to get hub's child device
5069 * Return NULL if input param is invalid and
5070 * child's usb_device pointer if non-NULL.
5072 struct usb_device *usb_hub_find_child(struct usb_device *hdev,
5075 struct usb_hub *hub = hdev_to_hub(hdev);
5077 if (port1 < 1 || port1 > hdev->maxchild)
5079 return hub->ports[port1 - 1]->child;
5081 EXPORT_SYMBOL_GPL(usb_hub_find_child);
5084 * usb_set_hub_port_connect_type - set hub port connect type.
5085 * @hdev: USB device belonging to the usb hub
5086 * @port1: port num of the port
5087 * @type: connect type of the port
5089 void usb_set_hub_port_connect_type(struct usb_device *hdev, int port1,
5090 enum usb_port_connect_type type)
5092 struct usb_hub *hub = hdev_to_hub(hdev);
5094 hub->ports[port1 - 1]->connect_type = type;
5098 * usb_get_hub_port_connect_type - Get the port's connect type
5099 * @hdev: USB device belonging to the usb hub
5100 * @port1: port num of the port
5102 * Return connect type of the port and if input params are
5103 * invalid, return USB_PORT_CONNECT_TYPE_UNKNOWN.
5105 enum usb_port_connect_type
5106 usb_get_hub_port_connect_type(struct usb_device *hdev, int port1)
5108 struct usb_hub *hub = hdev_to_hub(hdev);
5110 return hub->ports[port1 - 1]->connect_type;
5115 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5116 * @hdev: USB device belonging to the usb hub
5117 * @port1: port num of the port
5119 * Return port's acpi handle if successful, NULL if params are
5122 acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
5125 struct usb_hub *hub = hdev_to_hub(hdev);
5127 return DEVICE_ACPI_HANDLE(&hub->ports[port1 - 1]->dev);