4 * (C) Copyright 1999 Linus Torvalds
5 * (C) Copyright 1999 Johannes Erdfelt
6 * (C) Copyright 1999 Gregory P. Smith
7 * (C) Copyright 2001 Brad Hards (bhards@bigpond.net.au)
11 #include <linux/kernel.h>
12 #include <linux/errno.h>
13 #include <linux/module.h>
14 #include <linux/moduleparam.h>
15 #include <linux/completion.h>
16 #include <linux/sched.h>
17 #include <linux/list.h>
18 #include <linux/slab.h>
19 #include <linux/ioctl.h>
20 #include <linux/usb.h>
21 #include <linux/usbdevice_fs.h>
22 #include <linux/usb/hcd.h>
23 #include <linux/usb/quirks.h>
24 #include <linux/kthread.h>
25 #include <linux/mutex.h>
26 #include <linux/freezer.h>
28 #include <asm/uaccess.h>
29 #include <asm/byteorder.h>
33 /* if we are in debug mode, always announce new devices */
35 #ifndef CONFIG_USB_ANNOUNCE_NEW_DEVICES
36 #define CONFIG_USB_ANNOUNCE_NEW_DEVICES
41 struct device *intfdev; /* the "interface" device */
42 struct usb_device *hdev;
44 struct urb *urb; /* for interrupt polling pipe */
46 /* buffer for urb ... with extra space in case of babble */
49 struct usb_hub_status hub;
50 struct usb_port_status port;
51 } *status; /* buffer for status reports */
52 struct mutex status_mutex; /* for the status buffer */
54 int error; /* last reported error */
55 int nerrors; /* track consecutive errors */
57 struct list_head event_list; /* hubs w/data or errs ready */
58 unsigned long event_bits[1]; /* status change bitmask */
59 unsigned long change_bits[1]; /* ports with logical connect
61 unsigned long busy_bits[1]; /* ports being reset or
63 unsigned long removed_bits[1]; /* ports with a "removed"
65 unsigned long wakeup_bits[1]; /* ports that have signaled
67 #if USB_MAXCHILDREN > 31 /* 8*sizeof(unsigned long) - 1 */
68 #error event_bits[] is too short!
71 struct usb_hub_descriptor *descriptor; /* class descriptor */
72 struct usb_tt tt; /* Transaction Translator */
74 unsigned mA_per_port; /* current for each child */
76 unsigned limited_power:1;
78 unsigned disconnected:1;
80 unsigned has_indicators:1;
81 u8 indicator[USB_MAXCHILDREN];
82 struct delayed_work leds;
83 struct delayed_work init_work;
87 static inline int hub_is_superspeed(struct usb_device *hdev)
89 return (hdev->descriptor.bDeviceProtocol == USB_HUB_PR_SS);
92 /* Protect struct usb_device->state and ->children members
93 * Note: Both are also protected by ->dev.sem, except that ->state can
94 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
95 static DEFINE_SPINLOCK(device_state_lock);
97 /* khubd's worklist and its lock */
98 static DEFINE_SPINLOCK(hub_event_lock);
99 static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
102 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
104 static struct task_struct *khubd_task;
106 /* cycle leds on hubs that aren't blinking for attention */
107 static bool blinkenlights = 0;
108 module_param (blinkenlights, bool, S_IRUGO);
109 MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
112 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
113 * 10 seconds to send reply for the initial 64-byte descriptor request.
115 /* define initial 64-byte descriptor request timeout in milliseconds */
116 static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
117 module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
118 MODULE_PARM_DESC(initial_descriptor_timeout,
119 "initial 64-byte descriptor request timeout in milliseconds "
120 "(default 5000 - 5.0 seconds)");
123 * As of 2.6.10 we introduce a new USB device initialization scheme which
124 * closely resembles the way Windows works. Hopefully it will be compatible
125 * with a wider range of devices than the old scheme. However some previously
126 * working devices may start giving rise to "device not accepting address"
127 * errors; if that happens the user can try the old scheme by adjusting the
128 * following module parameters.
130 * For maximum flexibility there are two boolean parameters to control the
131 * hub driver's behavior. On the first initialization attempt, if the
132 * "old_scheme_first" parameter is set then the old scheme will be used,
133 * otherwise the new scheme is used. If that fails and "use_both_schemes"
134 * is set, then the driver will make another attempt, using the other scheme.
136 static bool old_scheme_first = 0;
137 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
138 MODULE_PARM_DESC(old_scheme_first,
139 "start with the old device initialization scheme");
141 static bool use_both_schemes = 1;
142 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
143 MODULE_PARM_DESC(use_both_schemes,
144 "try the other device initialization scheme if the "
147 /* Mutual exclusion for EHCI CF initialization. This interferes with
148 * port reset on some companion controllers.
150 DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
151 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
153 #define HUB_DEBOUNCE_TIMEOUT 1500
154 #define HUB_DEBOUNCE_STEP 25
155 #define HUB_DEBOUNCE_STABLE 100
158 static int usb_reset_and_verify_device(struct usb_device *udev);
160 static inline char *portspeed(struct usb_hub *hub, int portstatus)
162 if (hub_is_superspeed(hub->hdev))
164 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
166 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
172 /* Note that hdev or one of its children must be locked! */
173 static struct usb_hub *hdev_to_hub(struct usb_device *hdev)
175 if (!hdev || !hdev->actconfig)
177 return usb_get_intfdata(hdev->actconfig->interface[0]);
180 /* USB 2.0 spec Section 11.24.4.5 */
181 static int get_hub_descriptor(struct usb_device *hdev, void *data)
186 if (hub_is_superspeed(hdev)) {
187 dtype = USB_DT_SS_HUB;
188 size = USB_DT_SS_HUB_SIZE;
191 size = sizeof(struct usb_hub_descriptor);
194 for (i = 0; i < 3; i++) {
195 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
196 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
197 dtype << 8, 0, data, size,
198 USB_CTRL_GET_TIMEOUT);
199 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
206 * USB 2.0 spec Section 11.24.2.1
208 static int clear_hub_feature(struct usb_device *hdev, int feature)
210 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
211 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
215 * USB 2.0 spec Section 11.24.2.2
217 static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
219 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
220 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
225 * USB 2.0 spec Section 11.24.2.13
227 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
229 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
230 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
235 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
236 * for info about using port indicators
238 static void set_port_led(
244 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
245 USB_PORT_FEAT_INDICATOR);
247 dev_dbg (hub->intfdev,
248 "port %d indicator %s status %d\n",
250 ({ char *s; switch (selector) {
251 case HUB_LED_AMBER: s = "amber"; break;
252 case HUB_LED_GREEN: s = "green"; break;
253 case HUB_LED_OFF: s = "off"; break;
254 case HUB_LED_AUTO: s = "auto"; break;
255 default: s = "??"; break;
260 #define LED_CYCLE_PERIOD ((2*HZ)/3)
262 static void led_work (struct work_struct *work)
264 struct usb_hub *hub =
265 container_of(work, struct usb_hub, leds.work);
266 struct usb_device *hdev = hub->hdev;
268 unsigned changed = 0;
271 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
274 for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
275 unsigned selector, mode;
277 /* 30%-50% duty cycle */
279 switch (hub->indicator[i]) {
281 case INDICATOR_CYCLE:
283 selector = HUB_LED_AUTO;
284 mode = INDICATOR_AUTO;
286 /* blinking green = sw attention */
287 case INDICATOR_GREEN_BLINK:
288 selector = HUB_LED_GREEN;
289 mode = INDICATOR_GREEN_BLINK_OFF;
291 case INDICATOR_GREEN_BLINK_OFF:
292 selector = HUB_LED_OFF;
293 mode = INDICATOR_GREEN_BLINK;
295 /* blinking amber = hw attention */
296 case INDICATOR_AMBER_BLINK:
297 selector = HUB_LED_AMBER;
298 mode = INDICATOR_AMBER_BLINK_OFF;
300 case INDICATOR_AMBER_BLINK_OFF:
301 selector = HUB_LED_OFF;
302 mode = INDICATOR_AMBER_BLINK;
304 /* blink green/amber = reserved */
305 case INDICATOR_ALT_BLINK:
306 selector = HUB_LED_GREEN;
307 mode = INDICATOR_ALT_BLINK_OFF;
309 case INDICATOR_ALT_BLINK_OFF:
310 selector = HUB_LED_AMBER;
311 mode = INDICATOR_ALT_BLINK;
316 if (selector != HUB_LED_AUTO)
318 set_port_led(hub, i + 1, selector);
319 hub->indicator[i] = mode;
321 if (!changed && blinkenlights) {
323 cursor %= hub->descriptor->bNbrPorts;
324 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
325 hub->indicator[cursor] = INDICATOR_CYCLE;
329 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
332 /* use a short timeout for hub/port status fetches */
333 #define USB_STS_TIMEOUT 1000
334 #define USB_STS_RETRIES 5
337 * USB 2.0 spec Section 11.24.2.6
339 static int get_hub_status(struct usb_device *hdev,
340 struct usb_hub_status *data)
342 int i, status = -ETIMEDOUT;
344 for (i = 0; i < USB_STS_RETRIES &&
345 (status == -ETIMEDOUT || status == -EPIPE); i++) {
346 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
347 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
348 data, sizeof(*data), USB_STS_TIMEOUT);
354 * USB 2.0 spec Section 11.24.2.7
356 static int get_port_status(struct usb_device *hdev, int port1,
357 struct usb_port_status *data)
359 int i, status = -ETIMEDOUT;
361 for (i = 0; i < USB_STS_RETRIES &&
362 (status == -ETIMEDOUT || status == -EPIPE); i++) {
363 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
364 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
365 data, sizeof(*data), USB_STS_TIMEOUT);
370 static int hub_port_status(struct usb_hub *hub, int port1,
371 u16 *status, u16 *change)
375 mutex_lock(&hub->status_mutex);
376 ret = get_port_status(hub->hdev, port1, &hub->status->port);
378 dev_err(hub->intfdev,
379 "%s failed (err = %d)\n", __func__, ret);
383 *status = le16_to_cpu(hub->status->port.wPortStatus);
384 *change = le16_to_cpu(hub->status->port.wPortChange);
388 mutex_unlock(&hub->status_mutex);
392 static void kick_khubd(struct usb_hub *hub)
396 spin_lock_irqsave(&hub_event_lock, flags);
397 if (!hub->disconnected && list_empty(&hub->event_list)) {
398 list_add_tail(&hub->event_list, &hub_event_list);
400 /* Suppress autosuspend until khubd runs */
401 usb_autopm_get_interface_no_resume(
402 to_usb_interface(hub->intfdev));
403 wake_up(&khubd_wait);
405 spin_unlock_irqrestore(&hub_event_lock, flags);
408 void usb_kick_khubd(struct usb_device *hdev)
410 struct usb_hub *hub = hdev_to_hub(hdev);
417 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
418 * Notification, which indicates it had initiated remote wakeup.
420 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
421 * device initiates resume, so the USB core will not receive notice of the
422 * resume through the normal hub interrupt URB.
424 void usb_wakeup_notification(struct usb_device *hdev,
425 unsigned int portnum)
432 hub = hdev_to_hub(hdev);
434 set_bit(portnum, hub->wakeup_bits);
438 EXPORT_SYMBOL_GPL(usb_wakeup_notification);
440 /* completion function, fires on port status changes and various faults */
441 static void hub_irq(struct urb *urb)
443 struct usb_hub *hub = urb->context;
444 int status = urb->status;
449 case -ENOENT: /* synchronous unlink */
450 case -ECONNRESET: /* async unlink */
451 case -ESHUTDOWN: /* hardware going away */
454 default: /* presumably an error */
455 /* Cause a hub reset after 10 consecutive errors */
456 dev_dbg (hub->intfdev, "transfer --> %d\n", status);
457 if ((++hub->nerrors < 10) || hub->error)
462 /* let khubd handle things */
463 case 0: /* we got data: port status changed */
465 for (i = 0; i < urb->actual_length; ++i)
466 bits |= ((unsigned long) ((*hub->buffer)[i]))
468 hub->event_bits[0] = bits;
474 /* Something happened, let khubd figure it out */
481 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
482 && status != -ENODEV && status != -EPERM)
483 dev_err (hub->intfdev, "resubmit --> %d\n", status);
486 /* USB 2.0 spec Section 11.24.2.3 */
488 hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
490 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
491 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
496 * enumeration blocks khubd for a long time. we use keventd instead, since
497 * long blocking there is the exception, not the rule. accordingly, HCDs
498 * talking to TTs must queue control transfers (not just bulk and iso), so
499 * both can talk to the same hub concurrently.
501 static void hub_tt_work(struct work_struct *work)
503 struct usb_hub *hub =
504 container_of(work, struct usb_hub, tt.clear_work);
508 spin_lock_irqsave (&hub->tt.lock, flags);
509 while (!list_empty(&hub->tt.clear_list)) {
510 struct list_head *next;
511 struct usb_tt_clear *clear;
512 struct usb_device *hdev = hub->hdev;
513 const struct hc_driver *drv;
516 if (!hub->quiescing && --limit < 0)
519 next = hub->tt.clear_list.next;
520 clear = list_entry (next, struct usb_tt_clear, clear_list);
521 list_del (&clear->clear_list);
523 /* drop lock so HCD can concurrently report other TT errors */
524 spin_unlock_irqrestore (&hub->tt.lock, flags);
525 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
528 "clear tt %d (%04x) error %d\n",
529 clear->tt, clear->devinfo, status);
531 /* Tell the HCD, even if the operation failed */
532 drv = clear->hcd->driver;
533 if (drv->clear_tt_buffer_complete)
534 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
537 spin_lock_irqsave(&hub->tt.lock, flags);
539 spin_unlock_irqrestore (&hub->tt.lock, flags);
543 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
544 * @urb: an URB associated with the failed or incomplete split transaction
546 * High speed HCDs use this to tell the hub driver that some split control or
547 * bulk transaction failed in a way that requires clearing internal state of
548 * a transaction translator. This is normally detected (and reported) from
551 * It may not be possible for that hub to handle additional full (or low)
552 * speed transactions until that state is fully cleared out.
554 int usb_hub_clear_tt_buffer(struct urb *urb)
556 struct usb_device *udev = urb->dev;
557 int pipe = urb->pipe;
558 struct usb_tt *tt = udev->tt;
560 struct usb_tt_clear *clear;
562 /* we've got to cope with an arbitrary number of pending TT clears,
563 * since each TT has "at least two" buffers that can need it (and
564 * there can be many TTs per hub). even if they're uncommon.
566 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
567 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
568 /* FIXME recover somehow ... RESET_TT? */
572 /* info that CLEAR_TT_BUFFER needs */
573 clear->tt = tt->multi ? udev->ttport : 1;
574 clear->devinfo = usb_pipeendpoint (pipe);
575 clear->devinfo |= udev->devnum << 4;
576 clear->devinfo |= usb_pipecontrol (pipe)
577 ? (USB_ENDPOINT_XFER_CONTROL << 11)
578 : (USB_ENDPOINT_XFER_BULK << 11);
579 if (usb_pipein (pipe))
580 clear->devinfo |= 1 << 15;
582 /* info for completion callback */
583 clear->hcd = bus_to_hcd(udev->bus);
586 /* tell keventd to clear state for this TT */
587 spin_lock_irqsave (&tt->lock, flags);
588 list_add_tail (&clear->clear_list, &tt->clear_list);
589 schedule_work(&tt->clear_work);
590 spin_unlock_irqrestore (&tt->lock, flags);
593 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
595 /* If do_delay is false, return the number of milliseconds the caller
598 static unsigned hub_power_on(struct usb_hub *hub, bool do_delay)
601 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
603 u16 wHubCharacteristics =
604 le16_to_cpu(hub->descriptor->wHubCharacteristics);
606 /* Enable power on each port. Some hubs have reserved values
607 * of LPSM (> 2) in their descriptors, even though they are
608 * USB 2.0 hubs. Some hubs do not implement port-power switching
609 * but only emulate it. In all cases, the ports won't work
610 * unless we send these messages to the hub.
612 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
613 dev_dbg(hub->intfdev, "enabling power on all ports\n");
615 dev_dbg(hub->intfdev, "trying to enable port power on "
616 "non-switchable hub\n");
617 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
618 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
620 /* Wait at least 100 msec for power to become stable */
621 delay = max(pgood_delay, (unsigned) 100);
627 static int hub_hub_status(struct usb_hub *hub,
628 u16 *status, u16 *change)
632 mutex_lock(&hub->status_mutex);
633 ret = get_hub_status(hub->hdev, &hub->status->hub);
635 dev_err (hub->intfdev,
636 "%s failed (err = %d)\n", __func__, ret);
638 *status = le16_to_cpu(hub->status->hub.wHubStatus);
639 *change = le16_to_cpu(hub->status->hub.wHubChange);
642 mutex_unlock(&hub->status_mutex);
646 static int hub_set_port_link_state(struct usb_hub *hub, int port1,
647 unsigned int link_status)
649 return set_port_feature(hub->hdev,
650 port1 | (link_status << 3),
651 USB_PORT_FEAT_LINK_STATE);
655 * If USB 3.0 ports are placed into the Disabled state, they will no longer
656 * detect any device connects or disconnects. This is generally not what the
657 * USB core wants, since it expects a disabled port to produce a port status
658 * change event when a new device connects.
660 * Instead, set the link state to Disabled, wait for the link to settle into
661 * that state, clear any change bits, and then put the port into the RxDetect
664 static int hub_usb3_port_disable(struct usb_hub *hub, int port1)
668 u16 portchange, portstatus;
670 if (!hub_is_superspeed(hub->hdev))
673 ret = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_SS_DISABLED);
675 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
680 /* Wait for the link to enter the disabled state. */
681 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
682 ret = hub_port_status(hub, port1, &portstatus, &portchange);
686 if ((portstatus & USB_PORT_STAT_LINK_STATE) ==
687 USB_SS_PORT_LS_SS_DISABLED)
689 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
691 msleep(HUB_DEBOUNCE_STEP);
693 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
694 dev_warn(hub->intfdev, "Could not disable port %d after %d ms\n",
697 return hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_RX_DETECT);
700 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
702 struct usb_device *hdev = hub->hdev;
705 if (hdev->children[port1-1] && set_state)
706 usb_set_device_state(hdev->children[port1-1],
707 USB_STATE_NOTATTACHED);
709 if (hub_is_superspeed(hub->hdev))
710 ret = hub_usb3_port_disable(hub, port1);
712 ret = clear_port_feature(hdev, port1,
713 USB_PORT_FEAT_ENABLE);
716 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
722 * Disable a port and mark a logical connect-change event, so that some
723 * time later khubd will disconnect() any existing usb_device on the port
724 * and will re-enumerate if there actually is a device attached.
726 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
728 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
729 hub_port_disable(hub, port1, 1);
731 /* FIXME let caller ask to power down the port:
732 * - some devices won't enumerate without a VBUS power cycle
733 * - SRP saves power that way
734 * - ... new call, TBD ...
735 * That's easy if this hub can switch power per-port, and
736 * khubd reactivates the port later (timer, SRP, etc).
737 * Powerdown must be optional, because of reset/DFU.
740 set_bit(port1, hub->change_bits);
745 * usb_remove_device - disable a device's port on its parent hub
746 * @udev: device to be disabled and removed
747 * Context: @udev locked, must be able to sleep.
749 * After @udev's port has been disabled, khubd is notified and it will
750 * see that the device has been disconnected. When the device is
751 * physically unplugged and something is plugged in, the events will
752 * be received and processed normally.
754 int usb_remove_device(struct usb_device *udev)
757 struct usb_interface *intf;
759 if (!udev->parent) /* Can't remove a root hub */
761 hub = hdev_to_hub(udev->parent);
762 intf = to_usb_interface(hub->intfdev);
764 usb_autopm_get_interface(intf);
765 set_bit(udev->portnum, hub->removed_bits);
766 hub_port_logical_disconnect(hub, udev->portnum);
767 usb_autopm_put_interface(intf);
771 enum hub_activation_type {
772 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
773 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
776 static void hub_init_func2(struct work_struct *ws);
777 static void hub_init_func3(struct work_struct *ws);
779 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
781 struct usb_device *hdev = hub->hdev;
786 bool need_debounce_delay = false;
789 /* Continue a partial initialization */
790 if (type == HUB_INIT2)
792 if (type == HUB_INIT3)
795 /* The superspeed hub except for root hub has to use Hub Depth
796 * value as an offset into the route string to locate the bits
797 * it uses to determine the downstream port number. So hub driver
798 * should send a set hub depth request to superspeed hub after
799 * the superspeed hub is set configuration in initialization or
802 * After a resume, port power should still be on.
803 * For any other type of activation, turn it on.
805 if (type != HUB_RESUME) {
806 if (hdev->parent && hub_is_superspeed(hdev)) {
807 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
808 HUB_SET_DEPTH, USB_RT_HUB,
809 hdev->level - 1, 0, NULL, 0,
810 USB_CTRL_SET_TIMEOUT);
812 dev_err(hub->intfdev,
813 "set hub depth failed\n");
816 /* Speed up system boot by using a delayed_work for the
817 * hub's initial power-up delays. This is pretty awkward
818 * and the implementation looks like a home-brewed sort of
819 * setjmp/longjmp, but it saves at least 100 ms for each
820 * root hub (assuming usbcore is compiled into the kernel
821 * rather than as a module). It adds up.
823 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
824 * because for those activation types the ports have to be
825 * operational when we return. In theory this could be done
826 * for HUB_POST_RESET, but it's easier not to.
828 if (type == HUB_INIT) {
829 delay = hub_power_on(hub, false);
830 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func2);
831 schedule_delayed_work(&hub->init_work,
832 msecs_to_jiffies(delay));
834 /* Suppress autosuspend until init is done */
835 usb_autopm_get_interface_no_resume(
836 to_usb_interface(hub->intfdev));
837 return; /* Continues at init2: below */
838 } else if (type == HUB_RESET_RESUME) {
839 /* The internal host controller state for the hub device
840 * may be gone after a host power loss on system resume.
841 * Update the device's info so the HW knows it's a hub.
843 hcd = bus_to_hcd(hdev->bus);
844 if (hcd->driver->update_hub_device) {
845 ret = hcd->driver->update_hub_device(hcd, hdev,
848 dev_err(hub->intfdev, "Host not "
849 "accepting hub info "
851 dev_err(hub->intfdev, "LS/FS devices "
852 "and hubs may not work "
853 "under this hub\n.");
856 hub_power_on(hub, true);
858 hub_power_on(hub, true);
863 /* Check each port and set hub->change_bits to let khubd know
864 * which ports need attention.
866 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
867 struct usb_device *udev = hdev->children[port1-1];
868 u16 portstatus, portchange;
870 portstatus = portchange = 0;
871 status = hub_port_status(hub, port1, &portstatus, &portchange);
872 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
873 dev_dbg(hub->intfdev,
874 "port %d: status %04x change %04x\n",
875 port1, portstatus, portchange);
877 /* After anything other than HUB_RESUME (i.e., initialization
878 * or any sort of reset), every port should be disabled.
879 * Unconnected ports should likewise be disabled (paranoia),
880 * and so should ports for which we have no usb_device.
882 if ((portstatus & USB_PORT_STAT_ENABLE) && (
883 type != HUB_RESUME ||
884 !(portstatus & USB_PORT_STAT_CONNECTION) ||
886 udev->state == USB_STATE_NOTATTACHED)) {
888 * USB3 protocol ports will automatically transition
889 * to Enabled state when detect an USB3.0 device attach.
890 * Do not disable USB3 protocol ports.
892 if (!hub_is_superspeed(hdev)) {
893 clear_port_feature(hdev, port1,
894 USB_PORT_FEAT_ENABLE);
895 portstatus &= ~USB_PORT_STAT_ENABLE;
897 /* Pretend that power was lost for USB3 devs */
898 portstatus &= ~USB_PORT_STAT_ENABLE;
902 /* Clear status-change flags; we'll debounce later */
903 if (portchange & USB_PORT_STAT_C_CONNECTION) {
904 need_debounce_delay = true;
905 clear_port_feature(hub->hdev, port1,
906 USB_PORT_FEAT_C_CONNECTION);
908 if (portchange & USB_PORT_STAT_C_ENABLE) {
909 need_debounce_delay = true;
910 clear_port_feature(hub->hdev, port1,
911 USB_PORT_FEAT_C_ENABLE);
913 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
914 hub_is_superspeed(hub->hdev)) {
915 need_debounce_delay = true;
916 clear_port_feature(hub->hdev, port1,
917 USB_PORT_FEAT_C_BH_PORT_RESET);
919 /* We can forget about a "removed" device when there's a
920 * physical disconnect or the connect status changes.
922 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
923 (portchange & USB_PORT_STAT_C_CONNECTION))
924 clear_bit(port1, hub->removed_bits);
926 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
927 /* Tell khubd to disconnect the device or
928 * check for a new connection
930 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
931 set_bit(port1, hub->change_bits);
933 } else if (portstatus & USB_PORT_STAT_ENABLE) {
934 bool port_resumed = (portstatus &
935 USB_PORT_STAT_LINK_STATE) ==
937 /* The power session apparently survived the resume.
938 * If there was an overcurrent or suspend change
939 * (i.e., remote wakeup request), have khubd
940 * take care of it. Look at the port link state
941 * for USB 3.0 hubs, since they don't have a suspend
942 * change bit, and they don't set the port link change
943 * bit on device-initiated resume.
945 if (portchange || (hub_is_superspeed(hub->hdev) &&
947 set_bit(port1, hub->change_bits);
949 } else if (udev->persist_enabled) {
951 udev->reset_resume = 1;
953 set_bit(port1, hub->change_bits);
956 /* The power session is gone; tell khubd */
957 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
958 set_bit(port1, hub->change_bits);
962 /* If no port-status-change flags were set, we don't need any
963 * debouncing. If flags were set we can try to debounce the
964 * ports all at once right now, instead of letting khubd do them
965 * one at a time later on.
967 * If any port-status changes do occur during this delay, khubd
968 * will see them later and handle them normally.
970 if (need_debounce_delay) {
971 delay = HUB_DEBOUNCE_STABLE;
973 /* Don't do a long sleep inside a workqueue routine */
974 if (type == HUB_INIT2) {
975 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func3);
976 schedule_delayed_work(&hub->init_work,
977 msecs_to_jiffies(delay));
978 return; /* Continues at init3: below */
986 status = usb_submit_urb(hub->urb, GFP_NOIO);
988 dev_err(hub->intfdev, "activate --> %d\n", status);
989 if (hub->has_indicators && blinkenlights)
990 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
992 /* Scan all ports that need attention */
995 /* Allow autosuspend if it was suppressed */
996 if (type <= HUB_INIT3)
997 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
1000 /* Implement the continuations for the delays above */
1001 static void hub_init_func2(struct work_struct *ws)
1003 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1005 hub_activate(hub, HUB_INIT2);
1008 static void hub_init_func3(struct work_struct *ws)
1010 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1012 hub_activate(hub, HUB_INIT3);
1015 enum hub_quiescing_type {
1016 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
1019 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
1021 struct usb_device *hdev = hub->hdev;
1024 cancel_delayed_work_sync(&hub->init_work);
1026 /* khubd and related activity won't re-trigger */
1029 if (type != HUB_SUSPEND) {
1030 /* Disconnect all the children */
1031 for (i = 0; i < hdev->maxchild; ++i) {
1032 if (hdev->children[i])
1033 usb_disconnect(&hdev->children[i]);
1037 /* Stop khubd and related activity */
1038 usb_kill_urb(hub->urb);
1039 if (hub->has_indicators)
1040 cancel_delayed_work_sync(&hub->leds);
1042 flush_work_sync(&hub->tt.clear_work);
1045 /* caller has locked the hub device */
1046 static int hub_pre_reset(struct usb_interface *intf)
1048 struct usb_hub *hub = usb_get_intfdata(intf);
1050 hub_quiesce(hub, HUB_PRE_RESET);
1054 /* caller has locked the hub device */
1055 static int hub_post_reset(struct usb_interface *intf)
1057 struct usb_hub *hub = usb_get_intfdata(intf);
1059 hub_activate(hub, HUB_POST_RESET);
1063 static int hub_configure(struct usb_hub *hub,
1064 struct usb_endpoint_descriptor *endpoint)
1066 struct usb_hcd *hcd;
1067 struct usb_device *hdev = hub->hdev;
1068 struct device *hub_dev = hub->intfdev;
1069 u16 hubstatus, hubchange;
1070 u16 wHubCharacteristics;
1073 char *message = "out of memory";
1075 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
1081 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1086 mutex_init(&hub->status_mutex);
1088 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1089 if (!hub->descriptor) {
1094 /* Request the entire hub descriptor.
1095 * hub->descriptor can handle USB_MAXCHILDREN ports,
1096 * but the hub can/will return fewer bytes here.
1098 ret = get_hub_descriptor(hdev, hub->descriptor);
1100 message = "can't read hub descriptor";
1102 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
1103 message = "hub has too many ports!";
1108 hdev->maxchild = hub->descriptor->bNbrPorts;
1109 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
1110 (hdev->maxchild == 1) ? "" : "s");
1112 hdev->children = kzalloc(hdev->maxchild *
1113 sizeof(struct usb_device *), GFP_KERNEL);
1114 hub->port_owners = kzalloc(hdev->maxchild * sizeof(void *), GFP_KERNEL);
1115 if (!hdev->children || !hub->port_owners) {
1120 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1122 /* FIXME for USB 3.0, skip for now */
1123 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1124 !(hub_is_superspeed(hdev))) {
1126 char portstr [USB_MAXCHILDREN + 1];
1128 for (i = 0; i < hdev->maxchild; i++)
1129 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1130 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1132 portstr[hdev->maxchild] = 0;
1133 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1135 dev_dbg(hub_dev, "standalone hub\n");
1137 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1138 case HUB_CHAR_COMMON_LPSM:
1139 dev_dbg(hub_dev, "ganged power switching\n");
1141 case HUB_CHAR_INDV_PORT_LPSM:
1142 dev_dbg(hub_dev, "individual port power switching\n");
1144 case HUB_CHAR_NO_LPSM:
1146 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1150 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1151 case HUB_CHAR_COMMON_OCPM:
1152 dev_dbg(hub_dev, "global over-current protection\n");
1154 case HUB_CHAR_INDV_PORT_OCPM:
1155 dev_dbg(hub_dev, "individual port over-current protection\n");
1157 case HUB_CHAR_NO_OCPM:
1159 dev_dbg(hub_dev, "no over-current protection\n");
1163 spin_lock_init (&hub->tt.lock);
1164 INIT_LIST_HEAD (&hub->tt.clear_list);
1165 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1166 switch (hdev->descriptor.bDeviceProtocol) {
1169 case USB_HUB_PR_HS_SINGLE_TT:
1170 dev_dbg(hub_dev, "Single TT\n");
1173 case USB_HUB_PR_HS_MULTI_TT:
1174 ret = usb_set_interface(hdev, 0, 1);
1176 dev_dbg(hub_dev, "TT per port\n");
1179 dev_err(hub_dev, "Using single TT (err %d)\n",
1184 /* USB 3.0 hubs don't have a TT */
1187 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1188 hdev->descriptor.bDeviceProtocol);
1192 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1193 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1194 case HUB_TTTT_8_BITS:
1195 if (hdev->descriptor.bDeviceProtocol != 0) {
1196 hub->tt.think_time = 666;
1197 dev_dbg(hub_dev, "TT requires at most %d "
1198 "FS bit times (%d ns)\n",
1199 8, hub->tt.think_time);
1202 case HUB_TTTT_16_BITS:
1203 hub->tt.think_time = 666 * 2;
1204 dev_dbg(hub_dev, "TT requires at most %d "
1205 "FS bit times (%d ns)\n",
1206 16, hub->tt.think_time);
1208 case HUB_TTTT_24_BITS:
1209 hub->tt.think_time = 666 * 3;
1210 dev_dbg(hub_dev, "TT requires at most %d "
1211 "FS bit times (%d ns)\n",
1212 24, hub->tt.think_time);
1214 case HUB_TTTT_32_BITS:
1215 hub->tt.think_time = 666 * 4;
1216 dev_dbg(hub_dev, "TT requires at most %d "
1217 "FS bit times (%d ns)\n",
1218 32, hub->tt.think_time);
1222 /* probe() zeroes hub->indicator[] */
1223 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1224 hub->has_indicators = 1;
1225 dev_dbg(hub_dev, "Port indicators are supported\n");
1228 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1229 hub->descriptor->bPwrOn2PwrGood * 2);
1231 /* power budgeting mostly matters with bus-powered hubs,
1232 * and battery-powered root hubs (may provide just 8 mA).
1234 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1236 message = "can't get hub status";
1239 le16_to_cpus(&hubstatus);
1240 if (hdev == hdev->bus->root_hub) {
1241 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
1242 hub->mA_per_port = 500;
1244 hub->mA_per_port = hdev->bus_mA;
1245 hub->limited_power = 1;
1247 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1248 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1249 hub->descriptor->bHubContrCurrent);
1250 hub->limited_power = 1;
1251 if (hdev->maxchild > 0) {
1252 int remaining = hdev->bus_mA -
1253 hub->descriptor->bHubContrCurrent;
1255 if (remaining < hdev->maxchild * 100)
1257 "insufficient power available "
1258 "to use all downstream ports\n");
1259 hub->mA_per_port = 100; /* 7.2.1.1 */
1261 } else { /* Self-powered external hub */
1262 /* FIXME: What about battery-powered external hubs that
1263 * provide less current per port? */
1264 hub->mA_per_port = 500;
1266 if (hub->mA_per_port < 500)
1267 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1270 /* Update the HCD's internal representation of this hub before khubd
1271 * starts getting port status changes for devices under the hub.
1273 hcd = bus_to_hcd(hdev->bus);
1274 if (hcd->driver->update_hub_device) {
1275 ret = hcd->driver->update_hub_device(hcd, hdev,
1276 &hub->tt, GFP_KERNEL);
1278 message = "can't update HCD hub info";
1283 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1285 message = "can't get hub status";
1289 /* local power status reports aren't always correct */
1290 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1291 dev_dbg(hub_dev, "local power source is %s\n",
1292 (hubstatus & HUB_STATUS_LOCAL_POWER)
1293 ? "lost (inactive)" : "good");
1295 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1296 dev_dbg(hub_dev, "%sover-current condition exists\n",
1297 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1299 /* set up the interrupt endpoint
1300 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1301 * bytes as USB2.0[11.12.3] says because some hubs are known
1302 * to send more data (and thus cause overflow). For root hubs,
1303 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1304 * to be big enough for at least USB_MAXCHILDREN ports. */
1305 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1306 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1308 if (maxp > sizeof(*hub->buffer))
1309 maxp = sizeof(*hub->buffer);
1311 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1317 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1318 hub, endpoint->bInterval);
1320 /* maybe cycle the hub leds */
1321 if (hub->has_indicators && blinkenlights)
1322 hub->indicator [0] = INDICATOR_CYCLE;
1324 hub_activate(hub, HUB_INIT);
1328 dev_err (hub_dev, "config failed, %s (err %d)\n",
1330 /* hub_disconnect() frees urb and descriptor */
1334 static void hub_release(struct kref *kref)
1336 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1338 usb_put_intf(to_usb_interface(hub->intfdev));
1342 static unsigned highspeed_hubs;
1344 static void hub_disconnect(struct usb_interface *intf)
1346 struct usb_hub *hub = usb_get_intfdata(intf);
1347 struct usb_device *hdev = interface_to_usbdev(intf);
1349 /* Take the hub off the event list and don't let it be added again */
1350 spin_lock_irq(&hub_event_lock);
1351 if (!list_empty(&hub->event_list)) {
1352 list_del_init(&hub->event_list);
1353 usb_autopm_put_interface_no_suspend(intf);
1355 hub->disconnected = 1;
1356 spin_unlock_irq(&hub_event_lock);
1358 /* Disconnect all children and quiesce the hub */
1360 hub_quiesce(hub, HUB_DISCONNECT);
1362 usb_set_intfdata (intf, NULL);
1363 hub->hdev->maxchild = 0;
1365 if (hub->hdev->speed == USB_SPEED_HIGH)
1368 usb_free_urb(hub->urb);
1369 kfree(hdev->children);
1370 kfree(hub->port_owners);
1371 kfree(hub->descriptor);
1375 kref_put(&hub->kref, hub_release);
1378 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1380 struct usb_host_interface *desc;
1381 struct usb_endpoint_descriptor *endpoint;
1382 struct usb_device *hdev;
1383 struct usb_hub *hub;
1385 desc = intf->cur_altsetting;
1386 hdev = interface_to_usbdev(intf);
1388 /* Hubs have proper suspend/resume support. */
1389 usb_enable_autosuspend(hdev);
1391 if (hdev->level == MAX_TOPO_LEVEL) {
1393 "Unsupported bus topology: hub nested too deep\n");
1397 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1399 dev_warn(&intf->dev, "ignoring external hub\n");
1404 /* Some hubs have a subclass of 1, which AFAICT according to the */
1405 /* specs is not defined, but it works */
1406 if ((desc->desc.bInterfaceSubClass != 0) &&
1407 (desc->desc.bInterfaceSubClass != 1)) {
1409 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1413 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1414 if (desc->desc.bNumEndpoints != 1)
1415 goto descriptor_error;
1417 endpoint = &desc->endpoint[0].desc;
1419 /* If it's not an interrupt in endpoint, we'd better punt! */
1420 if (!usb_endpoint_is_int_in(endpoint))
1421 goto descriptor_error;
1423 /* We found a hub */
1424 dev_info (&intf->dev, "USB hub found\n");
1426 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1428 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1432 kref_init(&hub->kref);
1433 INIT_LIST_HEAD(&hub->event_list);
1434 hub->intfdev = &intf->dev;
1436 INIT_DELAYED_WORK(&hub->leds, led_work);
1437 INIT_DELAYED_WORK(&hub->init_work, NULL);
1440 usb_set_intfdata (intf, hub);
1441 intf->needs_remote_wakeup = 1;
1443 if (hdev->speed == USB_SPEED_HIGH)
1446 if (hub_configure(hub, endpoint) >= 0)
1449 hub_disconnect (intf);
1454 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1456 struct usb_device *hdev = interface_to_usbdev (intf);
1458 /* assert ifno == 0 (part of hub spec) */
1460 case USBDEVFS_HUB_PORTINFO: {
1461 struct usbdevfs_hub_portinfo *info = user_data;
1464 spin_lock_irq(&device_state_lock);
1465 if (hdev->devnum <= 0)
1468 info->nports = hdev->maxchild;
1469 for (i = 0; i < info->nports; i++) {
1470 if (hdev->children[i] == NULL)
1474 hdev->children[i]->devnum;
1477 spin_unlock_irq(&device_state_lock);
1479 return info->nports + 1;
1488 * Allow user programs to claim ports on a hub. When a device is attached
1489 * to one of these "claimed" ports, the program will "own" the device.
1491 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1494 if (hdev->state == USB_STATE_NOTATTACHED)
1496 if (port1 == 0 || port1 > hdev->maxchild)
1499 /* This assumes that devices not managed by the hub driver
1500 * will always have maxchild equal to 0.
1502 *ppowner = &(hdev_to_hub(hdev)->port_owners[port1 - 1]);
1506 /* In the following three functions, the caller must hold hdev's lock */
1507 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1, void *owner)
1512 rc = find_port_owner(hdev, port1, &powner);
1521 int usb_hub_release_port(struct usb_device *hdev, unsigned port1, void *owner)
1526 rc = find_port_owner(hdev, port1, &powner);
1529 if (*powner != owner)
1535 void usb_hub_release_all_ports(struct usb_device *hdev, void *owner)
1540 n = find_port_owner(hdev, 1, &powner);
1542 for (; n < hdev->maxchild; (++n, ++powner)) {
1543 if (*powner == owner)
1549 /* The caller must hold udev's lock */
1550 bool usb_device_is_owned(struct usb_device *udev)
1552 struct usb_hub *hub;
1554 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1556 hub = hdev_to_hub(udev->parent);
1557 return !!hub->port_owners[udev->portnum - 1];
1561 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1565 for (i = 0; i < udev->maxchild; ++i) {
1566 if (udev->children[i])
1567 recursively_mark_NOTATTACHED(udev->children[i]);
1569 if (udev->state == USB_STATE_SUSPENDED)
1570 udev->active_duration -= jiffies;
1571 udev->state = USB_STATE_NOTATTACHED;
1575 * usb_set_device_state - change a device's current state (usbcore, hcds)
1576 * @udev: pointer to device whose state should be changed
1577 * @new_state: new state value to be stored
1579 * udev->state is _not_ fully protected by the device lock. Although
1580 * most transitions are made only while holding the lock, the state can
1581 * can change to USB_STATE_NOTATTACHED at almost any time. This
1582 * is so that devices can be marked as disconnected as soon as possible,
1583 * without having to wait for any semaphores to be released. As a result,
1584 * all changes to any device's state must be protected by the
1585 * device_state_lock spinlock.
1587 * Once a device has been added to the device tree, all changes to its state
1588 * should be made using this routine. The state should _not_ be set directly.
1590 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1591 * Otherwise udev->state is set to new_state, and if new_state is
1592 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1593 * to USB_STATE_NOTATTACHED.
1595 void usb_set_device_state(struct usb_device *udev,
1596 enum usb_device_state new_state)
1598 unsigned long flags;
1601 spin_lock_irqsave(&device_state_lock, flags);
1602 if (udev->state == USB_STATE_NOTATTACHED)
1604 else if (new_state != USB_STATE_NOTATTACHED) {
1606 /* root hub wakeup capabilities are managed out-of-band
1607 * and may involve silicon errata ... ignore them here.
1610 if (udev->state == USB_STATE_SUSPENDED
1611 || new_state == USB_STATE_SUSPENDED)
1612 ; /* No change to wakeup settings */
1613 else if (new_state == USB_STATE_CONFIGURED)
1614 wakeup = udev->actconfig->desc.bmAttributes
1615 & USB_CONFIG_ATT_WAKEUP;
1619 if (udev->state == USB_STATE_SUSPENDED &&
1620 new_state != USB_STATE_SUSPENDED)
1621 udev->active_duration -= jiffies;
1622 else if (new_state == USB_STATE_SUSPENDED &&
1623 udev->state != USB_STATE_SUSPENDED)
1624 udev->active_duration += jiffies;
1625 udev->state = new_state;
1627 recursively_mark_NOTATTACHED(udev);
1628 spin_unlock_irqrestore(&device_state_lock, flags);
1630 device_set_wakeup_capable(&udev->dev, wakeup);
1632 EXPORT_SYMBOL_GPL(usb_set_device_state);
1635 * Choose a device number.
1637 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1638 * USB-2.0 buses they are also used as device addresses, however on
1639 * USB-3.0 buses the address is assigned by the controller hardware
1640 * and it usually is not the same as the device number.
1642 * WUSB devices are simple: they have no hubs behind, so the mapping
1643 * device <-> virtual port number becomes 1:1. Why? to simplify the
1644 * life of the device connection logic in
1645 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1646 * handshake we need to assign a temporary address in the unauthorized
1647 * space. For simplicity we use the first virtual port number found to
1648 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1649 * and that becomes it's address [X < 128] or its unauthorized address
1652 * We add 1 as an offset to the one-based USB-stack port number
1653 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1654 * 0 is reserved by USB for default address; (b) Linux's USB stack
1655 * uses always #1 for the root hub of the controller. So USB stack's
1656 * port #1, which is wusb virtual-port #0 has address #2.
1658 * Devices connected under xHCI are not as simple. The host controller
1659 * supports virtualization, so the hardware assigns device addresses and
1660 * the HCD must setup data structures before issuing a set address
1661 * command to the hardware.
1663 static void choose_devnum(struct usb_device *udev)
1666 struct usb_bus *bus = udev->bus;
1668 /* If khubd ever becomes multithreaded, this will need a lock */
1670 devnum = udev->portnum + 1;
1671 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
1673 /* Try to allocate the next devnum beginning at
1674 * bus->devnum_next. */
1675 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1678 devnum = find_next_zero_bit(bus->devmap.devicemap,
1680 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1683 set_bit(devnum, bus->devmap.devicemap);
1684 udev->devnum = devnum;
1688 static void release_devnum(struct usb_device *udev)
1690 if (udev->devnum > 0) {
1691 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1696 static void update_devnum(struct usb_device *udev, int devnum)
1698 /* The address for a WUSB device is managed by wusbcore. */
1700 udev->devnum = devnum;
1703 static void hub_free_dev(struct usb_device *udev)
1705 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1707 /* Root hubs aren't real devices, so don't free HCD resources */
1708 if (hcd->driver->free_dev && udev->parent)
1709 hcd->driver->free_dev(hcd, udev);
1713 * usb_disconnect - disconnect a device (usbcore-internal)
1714 * @pdev: pointer to device being disconnected
1715 * Context: !in_interrupt ()
1717 * Something got disconnected. Get rid of it and all of its children.
1719 * If *pdev is a normal device then the parent hub must already be locked.
1720 * If *pdev is a root hub then this routine will acquire the
1721 * usb_bus_list_lock on behalf of the caller.
1723 * Only hub drivers (including virtual root hub drivers for host
1724 * controllers) should ever call this.
1726 * This call is synchronous, and may not be used in an interrupt context.
1728 void usb_disconnect(struct usb_device **pdev)
1730 struct usb_device *udev = *pdev;
1733 /* mark the device as inactive, so any further urb submissions for
1734 * this device (and any of its children) will fail immediately.
1735 * this quiesces everything except pending urbs.
1737 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1738 dev_info(&udev->dev, "USB disconnect, device number %d\n",
1741 usb_lock_device(udev);
1743 /* Free up all the children before we remove this device */
1744 for (i = 0; i < udev->maxchild; i++) {
1745 if (udev->children[i])
1746 usb_disconnect(&udev->children[i]);
1749 /* deallocate hcd/hardware state ... nuking all pending urbs and
1750 * cleaning up all state associated with the current configuration
1751 * so that the hardware is now fully quiesced.
1753 dev_dbg (&udev->dev, "unregistering device\n");
1754 usb_disable_device(udev, 0);
1755 usb_hcd_synchronize_unlinks(udev);
1757 usb_remove_ep_devs(&udev->ep0);
1758 usb_unlock_device(udev);
1760 /* Unregister the device. The device driver is responsible
1761 * for de-configuring the device and invoking the remove-device
1762 * notifier chain (used by usbfs and possibly others).
1764 device_del(&udev->dev);
1766 /* Free the device number and delete the parent's children[]
1767 * (or root_hub) pointer.
1769 release_devnum(udev);
1771 /* Avoid races with recursively_mark_NOTATTACHED() */
1772 spin_lock_irq(&device_state_lock);
1774 spin_unlock_irq(&device_state_lock);
1778 put_device(&udev->dev);
1781 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
1782 static void show_string(struct usb_device *udev, char *id, char *string)
1786 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1789 static void announce_device(struct usb_device *udev)
1791 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
1792 le16_to_cpu(udev->descriptor.idVendor),
1793 le16_to_cpu(udev->descriptor.idProduct));
1794 dev_info(&udev->dev,
1795 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
1796 udev->descriptor.iManufacturer,
1797 udev->descriptor.iProduct,
1798 udev->descriptor.iSerialNumber);
1799 show_string(udev, "Product", udev->product);
1800 show_string(udev, "Manufacturer", udev->manufacturer);
1801 show_string(udev, "SerialNumber", udev->serial);
1804 static inline void announce_device(struct usb_device *udev) { }
1807 #ifdef CONFIG_USB_OTG
1808 #include "otg_whitelist.h"
1812 * usb_enumerate_device_otg - FIXME (usbcore-internal)
1813 * @udev: newly addressed device (in ADDRESS state)
1815 * Finish enumeration for On-The-Go devices
1817 static int usb_enumerate_device_otg(struct usb_device *udev)
1821 #ifdef CONFIG_USB_OTG
1823 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1824 * to wake us after we've powered off VBUS; and HNP, switching roles
1825 * "host" to "peripheral". The OTG descriptor helps figure this out.
1827 if (!udev->bus->is_b_host
1829 && udev->parent == udev->bus->root_hub) {
1830 struct usb_otg_descriptor *desc = NULL;
1831 struct usb_bus *bus = udev->bus;
1833 /* descriptor may appear anywhere in config */
1834 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1835 le16_to_cpu(udev->config[0].desc.wTotalLength),
1836 USB_DT_OTG, (void **) &desc) == 0) {
1837 if (desc->bmAttributes & USB_OTG_HNP) {
1838 unsigned port1 = udev->portnum;
1840 dev_info(&udev->dev,
1841 "Dual-Role OTG device on %sHNP port\n",
1842 (port1 == bus->otg_port)
1845 /* enable HNP before suspend, it's simpler */
1846 if (port1 == bus->otg_port)
1847 bus->b_hnp_enable = 1;
1848 err = usb_control_msg(udev,
1849 usb_sndctrlpipe(udev, 0),
1850 USB_REQ_SET_FEATURE, 0,
1852 ? USB_DEVICE_B_HNP_ENABLE
1853 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1854 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1856 /* OTG MESSAGE: report errors here,
1857 * customize to match your product.
1859 dev_info(&udev->dev,
1860 "can't set HNP mode: %d\n",
1862 bus->b_hnp_enable = 0;
1868 if (!is_targeted(udev)) {
1870 /* Maybe it can talk to us, though we can't talk to it.
1871 * (Includes HNP test device.)
1873 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
1874 err = usb_port_suspend(udev, PMSG_SUSPEND);
1876 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1888 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
1889 * @udev: newly addressed device (in ADDRESS state)
1891 * This is only called by usb_new_device() and usb_authorize_device()
1892 * and FIXME -- all comments that apply to them apply here wrt to
1895 * If the device is WUSB and not authorized, we don't attempt to read
1896 * the string descriptors, as they will be errored out by the device
1897 * until it has been authorized.
1899 static int usb_enumerate_device(struct usb_device *udev)
1903 if (udev->config == NULL) {
1904 err = usb_get_configuration(udev);
1906 dev_err(&udev->dev, "can't read configurations, error %d\n",
1911 if (udev->wusb == 1 && udev->authorized == 0) {
1912 udev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1913 udev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1914 udev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1917 /* read the standard strings and cache them if present */
1918 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1919 udev->manufacturer = usb_cache_string(udev,
1920 udev->descriptor.iManufacturer);
1921 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
1923 err = usb_enumerate_device_otg(udev);
1928 static void set_usb_port_removable(struct usb_device *udev)
1930 struct usb_device *hdev = udev->parent;
1931 struct usb_hub *hub;
1932 u8 port = udev->portnum;
1933 u16 wHubCharacteristics;
1934 bool removable = true;
1939 hub = hdev_to_hub(udev->parent);
1941 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1943 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
1946 if (hub_is_superspeed(hdev)) {
1947 if (hub->descriptor->u.ss.DeviceRemovable & (1 << port))
1950 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
1955 udev->removable = USB_DEVICE_REMOVABLE;
1957 udev->removable = USB_DEVICE_FIXED;
1961 * usb_new_device - perform initial device setup (usbcore-internal)
1962 * @udev: newly addressed device (in ADDRESS state)
1964 * This is called with devices which have been detected but not fully
1965 * enumerated. The device descriptor is available, but not descriptors
1966 * for any device configuration. The caller must have locked either
1967 * the parent hub (if udev is a normal device) or else the
1968 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1969 * udev has already been installed, but udev is not yet visible through
1970 * sysfs or other filesystem code.
1972 * It will return if the device is configured properly or not. Zero if
1973 * the interface was registered with the driver core; else a negative
1976 * This call is synchronous, and may not be used in an interrupt context.
1978 * Only the hub driver or root-hub registrar should ever call this.
1980 int usb_new_device(struct usb_device *udev)
1985 /* Initialize non-root-hub device wakeup to disabled;
1986 * device (un)configuration controls wakeup capable
1987 * sysfs power/wakeup controls wakeup enabled/disabled
1989 device_init_wakeup(&udev->dev, 0);
1992 /* Tell the runtime-PM framework the device is active */
1993 pm_runtime_set_active(&udev->dev);
1994 pm_runtime_get_noresume(&udev->dev);
1995 pm_runtime_use_autosuspend(&udev->dev);
1996 pm_runtime_enable(&udev->dev);
1998 /* By default, forbid autosuspend for all devices. It will be
1999 * allowed for hubs during binding.
2001 usb_disable_autosuspend(udev);
2003 err = usb_enumerate_device(udev); /* Read descriptors */
2006 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
2007 udev->devnum, udev->bus->busnum,
2008 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2009 /* export the usbdev device-node for libusb */
2010 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
2011 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2013 /* Tell the world! */
2014 announce_device(udev);
2016 device_enable_async_suspend(&udev->dev);
2019 * check whether the hub marks this port as non-removable. Do it
2020 * now so that platform-specific data can override it in
2024 set_usb_port_removable(udev);
2026 /* Register the device. The device driver is responsible
2027 * for configuring the device and invoking the add-device
2028 * notifier chain (used by usbfs and possibly others).
2030 err = device_add(&udev->dev);
2032 dev_err(&udev->dev, "can't device_add, error %d\n", err);
2036 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
2037 usb_mark_last_busy(udev);
2038 pm_runtime_put_sync_autosuspend(&udev->dev);
2042 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2043 pm_runtime_disable(&udev->dev);
2044 pm_runtime_set_suspended(&udev->dev);
2050 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2051 * @usb_dev: USB device
2053 * Move the USB device to a very basic state where interfaces are disabled
2054 * and the device is in fact unconfigured and unusable.
2056 * We share a lock (that we have) with device_del(), so we need to
2059 int usb_deauthorize_device(struct usb_device *usb_dev)
2061 usb_lock_device(usb_dev);
2062 if (usb_dev->authorized == 0)
2063 goto out_unauthorized;
2065 usb_dev->authorized = 0;
2066 usb_set_configuration(usb_dev, -1);
2068 kfree(usb_dev->product);
2069 usb_dev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2070 kfree(usb_dev->manufacturer);
2071 usb_dev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2072 kfree(usb_dev->serial);
2073 usb_dev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2075 usb_destroy_configuration(usb_dev);
2076 usb_dev->descriptor.bNumConfigurations = 0;
2079 usb_unlock_device(usb_dev);
2084 int usb_authorize_device(struct usb_device *usb_dev)
2088 usb_lock_device(usb_dev);
2089 if (usb_dev->authorized == 1)
2090 goto out_authorized;
2092 result = usb_autoresume_device(usb_dev);
2094 dev_err(&usb_dev->dev,
2095 "can't autoresume for authorization: %d\n", result);
2096 goto error_autoresume;
2098 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2100 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2101 "authorization: %d\n", result);
2102 goto error_device_descriptor;
2105 kfree(usb_dev->product);
2106 usb_dev->product = NULL;
2107 kfree(usb_dev->manufacturer);
2108 usb_dev->manufacturer = NULL;
2109 kfree(usb_dev->serial);
2110 usb_dev->serial = NULL;
2112 usb_dev->authorized = 1;
2113 result = usb_enumerate_device(usb_dev);
2115 goto error_enumerate;
2116 /* Choose and set the configuration. This registers the interfaces
2117 * with the driver core and lets interface drivers bind to them.
2119 c = usb_choose_configuration(usb_dev);
2121 result = usb_set_configuration(usb_dev, c);
2123 dev_err(&usb_dev->dev,
2124 "can't set config #%d, error %d\n", c, result);
2125 /* This need not be fatal. The user can try to
2126 * set other configurations. */
2129 dev_info(&usb_dev->dev, "authorized to connect\n");
2132 error_device_descriptor:
2133 usb_autosuspend_device(usb_dev);
2136 usb_unlock_device(usb_dev); // complements locktree
2141 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2142 static unsigned hub_is_wusb(struct usb_hub *hub)
2144 struct usb_hcd *hcd;
2145 if (hub->hdev->parent != NULL) /* not a root hub? */
2147 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
2148 return hcd->wireless;
2152 #define PORT_RESET_TRIES 5
2153 #define SET_ADDRESS_TRIES 2
2154 #define GET_DESCRIPTOR_TRIES 2
2155 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2156 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2158 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2159 #define HUB_SHORT_RESET_TIME 10
2160 #define HUB_BH_RESET_TIME 50
2161 #define HUB_LONG_RESET_TIME 200
2162 #define HUB_RESET_TIMEOUT 500
2164 static int hub_port_reset(struct usb_hub *hub, int port1,
2165 struct usb_device *udev, unsigned int delay, bool warm);
2167 /* Is a USB 3.0 port in the Inactive or Complinance Mode state?
2168 * Port worm reset is required to recover
2170 static bool hub_port_warm_reset_required(struct usb_hub *hub, u16 portstatus)
2172 return hub_is_superspeed(hub->hdev) &&
2173 (((portstatus & USB_PORT_STAT_LINK_STATE) ==
2174 USB_SS_PORT_LS_SS_INACTIVE) ||
2175 ((portstatus & USB_PORT_STAT_LINK_STATE) ==
2176 USB_SS_PORT_LS_COMP_MOD)) ;
2179 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2180 struct usb_device *udev, unsigned int delay, bool warm)
2182 int delay_time, ret;
2186 for (delay_time = 0;
2187 delay_time < HUB_RESET_TIMEOUT;
2188 delay_time += delay) {
2189 /* wait to give the device a chance to reset */
2192 /* read and decode port status */
2193 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2197 /* The port state is unknown until the reset completes. */
2198 if ((portstatus & USB_PORT_STAT_RESET))
2202 * Some buggy devices require a warm reset to be issued even
2203 * when the port appears not to be connected.
2207 * Some buggy devices can cause an NEC host controller
2208 * to transition to the "Error" state after a hot port
2209 * reset. This will show up as the port state in
2210 * "Inactive", and the port may also report a
2211 * disconnect. Forcing a warm port reset seems to make
2214 * See https://bugzilla.kernel.org/show_bug.cgi?id=41752
2216 if (hub_port_warm_reset_required(hub, portstatus)) {
2219 if ((portchange & USB_PORT_STAT_C_CONNECTION))
2220 clear_port_feature(hub->hdev, port1,
2221 USB_PORT_FEAT_C_CONNECTION);
2222 if (portchange & USB_PORT_STAT_C_LINK_STATE)
2223 clear_port_feature(hub->hdev, port1,
2224 USB_PORT_FEAT_C_PORT_LINK_STATE);
2225 if (portchange & USB_PORT_STAT_C_RESET)
2226 clear_port_feature(hub->hdev, port1,
2227 USB_PORT_FEAT_C_RESET);
2228 dev_dbg(hub->intfdev, "hot reset failed, warm reset port %d\n",
2230 ret = hub_port_reset(hub, port1,
2231 udev, HUB_BH_RESET_TIME,
2233 if ((portchange & USB_PORT_STAT_C_CONNECTION))
2234 clear_port_feature(hub->hdev, port1,
2235 USB_PORT_FEAT_C_CONNECTION);
2238 /* Device went away? */
2239 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2242 /* bomb out completely if the connection bounced */
2243 if ((portchange & USB_PORT_STAT_C_CONNECTION))
2246 if ((portstatus & USB_PORT_STAT_ENABLE)) {
2247 if (hub_is_wusb(hub))
2248 udev->speed = USB_SPEED_WIRELESS;
2249 else if (hub_is_superspeed(hub->hdev))
2250 udev->speed = USB_SPEED_SUPER;
2251 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2252 udev->speed = USB_SPEED_HIGH;
2253 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2254 udev->speed = USB_SPEED_LOW;
2256 udev->speed = USB_SPEED_FULL;
2264 /* switch to the long delay after two short delay failures */
2265 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2266 delay = HUB_LONG_RESET_TIME;
2268 dev_dbg (hub->intfdev,
2269 "port %d not %sreset yet, waiting %dms\n",
2270 port1, warm ? "warm " : "", delay);
2276 static void hub_port_finish_reset(struct usb_hub *hub, int port1,
2277 struct usb_device *udev, int *status, bool warm)
2282 struct usb_hcd *hcd;
2283 /* TRSTRCY = 10 ms; plus some extra */
2285 update_devnum(udev, 0);
2286 hcd = bus_to_hcd(udev->bus);
2287 /* The xHC may think the device is already reset,
2288 * so ignore the status.
2290 if (hcd->driver->reset_device)
2291 hcd->driver->reset_device(hcd, udev);
2296 clear_port_feature(hub->hdev,
2297 port1, USB_PORT_FEAT_C_RESET);
2298 /* FIXME need disconnect() for NOTATTACHED device */
2299 if (hub_is_superspeed(hub->hdev)) {
2300 clear_port_feature(hub->hdev, port1,
2301 USB_PORT_FEAT_C_BH_PORT_RESET);
2302 clear_port_feature(hub->hdev, port1,
2303 USB_PORT_FEAT_C_PORT_LINK_STATE);
2306 usb_set_device_state(udev, *status
2307 ? USB_STATE_NOTATTACHED
2308 : USB_STATE_DEFAULT);
2313 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2314 static int hub_port_reset(struct usb_hub *hub, int port1,
2315 struct usb_device *udev, unsigned int delay, bool warm)
2320 /* Block EHCI CF initialization during the port reset.
2321 * Some companion controllers don't like it when they mix.
2323 down_read(&ehci_cf_port_reset_rwsem);
2325 if (!hub_is_superspeed(hub->hdev)) {
2326 dev_err(hub->intfdev, "only USB3 hub support "
2332 /* Reset the port */
2333 for (i = 0; i < PORT_RESET_TRIES; i++) {
2334 status = set_port_feature(hub->hdev, port1, (warm ?
2335 USB_PORT_FEAT_BH_PORT_RESET :
2336 USB_PORT_FEAT_RESET));
2338 dev_err(hub->intfdev,
2339 "cannot %sreset port %d (err = %d)\n",
2340 warm ? "warm " : "", port1, status);
2342 status = hub_port_wait_reset(hub, port1, udev, delay,
2344 if (status && status != -ENOTCONN)
2345 dev_dbg(hub->intfdev,
2346 "port_wait_reset: err = %d\n",
2350 /* return on disconnect or reset */
2351 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2352 hub_port_finish_reset(hub, port1, udev, &status, warm);
2356 dev_dbg (hub->intfdev,
2357 "port %d not enabled, trying %sreset again...\n",
2358 port1, warm ? "warm " : "");
2359 delay = HUB_LONG_RESET_TIME;
2362 dev_err (hub->intfdev,
2363 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2368 up_read(&ehci_cf_port_reset_rwsem);
2373 /* Check if a port is power on */
2374 static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2378 if (hub_is_superspeed(hub->hdev)) {
2379 if (portstatus & USB_SS_PORT_STAT_POWER)
2382 if (portstatus & USB_PORT_STAT_POWER)
2391 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2392 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
2396 if (hub_is_superspeed(hub->hdev)) {
2397 if ((portstatus & USB_PORT_STAT_LINK_STATE)
2398 == USB_SS_PORT_LS_U3)
2401 if (portstatus & USB_PORT_STAT_SUSPEND)
2408 /* Determine whether the device on a port is ready for a normal resume,
2409 * is ready for a reset-resume, or should be disconnected.
2411 static int check_port_resume_type(struct usb_device *udev,
2412 struct usb_hub *hub, int port1,
2413 int status, unsigned portchange, unsigned portstatus)
2415 /* Is the device still present? */
2416 if (status || port_is_suspended(hub, portstatus) ||
2417 !port_is_power_on(hub, portstatus) ||
2418 !(portstatus & USB_PORT_STAT_CONNECTION)) {
2423 /* Can't do a normal resume if the port isn't enabled,
2424 * so try a reset-resume instead.
2426 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2427 if (udev->persist_enabled)
2428 udev->reset_resume = 1;
2434 dev_dbg(hub->intfdev,
2435 "port %d status %04x.%04x after resume, %d\n",
2436 port1, portchange, portstatus, status);
2437 } else if (udev->reset_resume) {
2439 /* Late port handoff can set status-change bits */
2440 if (portchange & USB_PORT_STAT_C_CONNECTION)
2441 clear_port_feature(hub->hdev, port1,
2442 USB_PORT_FEAT_C_CONNECTION);
2443 if (portchange & USB_PORT_STAT_C_ENABLE)
2444 clear_port_feature(hub->hdev, port1,
2445 USB_PORT_FEAT_C_ENABLE);
2451 #ifdef CONFIG_USB_SUSPEND
2454 * usb_port_suspend - suspend a usb device's upstream port
2455 * @udev: device that's no longer in active use, not a root hub
2456 * Context: must be able to sleep; device not locked; pm locks held
2458 * Suspends a USB device that isn't in active use, conserving power.
2459 * Devices may wake out of a suspend, if anything important happens,
2460 * using the remote wakeup mechanism. They may also be taken out of
2461 * suspend by the host, using usb_port_resume(). It's also routine
2462 * to disconnect devices while they are suspended.
2464 * This only affects the USB hardware for a device; its interfaces
2465 * (and, for hubs, child devices) must already have been suspended.
2467 * Selective port suspend reduces power; most suspended devices draw
2468 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2469 * All devices below the suspended port are also suspended.
2471 * Devices leave suspend state when the host wakes them up. Some devices
2472 * also support "remote wakeup", where the device can activate the USB
2473 * tree above them to deliver data, such as a keypress or packet. In
2474 * some cases, this wakes the USB host.
2476 * Suspending OTG devices may trigger HNP, if that's been enabled
2477 * between a pair of dual-role devices. That will change roles, such
2478 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2480 * Devices on USB hub ports have only one "suspend" state, corresponding
2481 * to ACPI D2, "may cause the device to lose some context".
2482 * State transitions include:
2484 * - suspend, resume ... when the VBUS power link stays live
2485 * - suspend, disconnect ... VBUS lost
2487 * Once VBUS drop breaks the circuit, the port it's using has to go through
2488 * normal re-enumeration procedures, starting with enabling VBUS power.
2489 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2490 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2491 * timer, no SRP, no requests through sysfs.
2493 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
2494 * the root hub for their bus goes into global suspend ... so we don't
2495 * (falsely) update the device power state to say it suspended.
2497 * Returns 0 on success, else negative errno.
2499 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2501 struct usb_hub *hub = hdev_to_hub(udev->parent);
2502 int port1 = udev->portnum;
2505 /* enable remote wakeup when appropriate; this lets the device
2506 * wake up the upstream hub (including maybe the root hub).
2508 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2509 * we don't explicitly enable it here.
2511 if (udev->do_remote_wakeup) {
2512 if (!hub_is_superspeed(hub->hdev)) {
2513 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2514 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2515 USB_DEVICE_REMOTE_WAKEUP, 0,
2517 USB_CTRL_SET_TIMEOUT);
2519 /* Assume there's only one function on the USB 3.0
2520 * device and enable remote wake for the first
2521 * interface. FIXME if the interface association
2522 * descriptor shows there's more than one function.
2524 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2525 USB_REQ_SET_FEATURE,
2526 USB_RECIP_INTERFACE,
2527 USB_INTRF_FUNC_SUSPEND,
2528 USB_INTRF_FUNC_SUSPEND_RW |
2529 USB_INTRF_FUNC_SUSPEND_LP,
2531 USB_CTRL_SET_TIMEOUT);
2534 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
2536 /* bail if autosuspend is requested */
2537 if (PMSG_IS_AUTO(msg))
2542 /* disable USB2 hardware LPM */
2543 if (udev->usb2_hw_lpm_enabled == 1)
2544 usb_set_usb2_hardware_lpm(udev, 0);
2547 if (hub_is_superspeed(hub->hdev))
2548 status = set_port_feature(hub->hdev,
2549 port1 | (USB_SS_PORT_LS_U3 << 3),
2550 USB_PORT_FEAT_LINK_STATE);
2552 status = set_port_feature(hub->hdev, port1,
2553 USB_PORT_FEAT_SUSPEND);
2555 dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
2557 /* paranoia: "should not happen" */
2558 if (udev->do_remote_wakeup)
2559 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2560 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2561 USB_DEVICE_REMOTE_WAKEUP, 0,
2563 USB_CTRL_SET_TIMEOUT);
2565 /* Try to enable USB2 hardware LPM again */
2566 if (udev->usb2_hw_lpm_capable == 1)
2567 usb_set_usb2_hardware_lpm(udev, 1);
2569 /* System sleep transitions should never fail */
2570 if (!PMSG_IS_AUTO(msg))
2573 /* device has up to 10 msec to fully suspend */
2574 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
2575 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
2576 udev->do_remote_wakeup);
2577 usb_set_device_state(udev, USB_STATE_SUSPENDED);
2580 usb_mark_last_busy(hub->hdev);
2585 * If the USB "suspend" state is in use (rather than "global suspend"),
2586 * many devices will be individually taken out of suspend state using
2587 * special "resume" signaling. This routine kicks in shortly after
2588 * hardware resume signaling is finished, either because of selective
2589 * resume (by host) or remote wakeup (by device) ... now see what changed
2590 * in the tree that's rooted at this device.
2592 * If @udev->reset_resume is set then the device is reset before the
2593 * status check is done.
2595 static int finish_port_resume(struct usb_device *udev)
2600 /* caller owns the udev device lock */
2601 dev_dbg(&udev->dev, "%s\n",
2602 udev->reset_resume ? "finish reset-resume" : "finish resume");
2604 /* usb ch9 identifies four variants of SUSPENDED, based on what
2605 * state the device resumes to. Linux currently won't see the
2606 * first two on the host side; they'd be inside hub_port_init()
2607 * during many timeouts, but khubd can't suspend until later.
2609 usb_set_device_state(udev, udev->actconfig
2610 ? USB_STATE_CONFIGURED
2611 : USB_STATE_ADDRESS);
2613 /* 10.5.4.5 says not to reset a suspended port if the attached
2614 * device is enabled for remote wakeup. Hence the reset
2615 * operation is carried out here, after the port has been
2618 if (udev->reset_resume)
2620 status = usb_reset_and_verify_device(udev);
2622 /* 10.5.4.5 says be sure devices in the tree are still there.
2623 * For now let's assume the device didn't go crazy on resume,
2624 * and device drivers will know about any resume quirks.
2628 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
2630 status = (status > 0 ? 0 : -ENODEV);
2632 /* If a normal resume failed, try doing a reset-resume */
2633 if (status && !udev->reset_resume && udev->persist_enabled) {
2634 dev_dbg(&udev->dev, "retry with reset-resume\n");
2635 udev->reset_resume = 1;
2636 goto retry_reset_resume;
2641 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
2644 * There are a few quirky devices which violate the standard
2645 * by claiming to have remote wakeup enabled after a reset,
2646 * which crash if the feature is cleared, hence check for
2647 * udev->reset_resume
2649 } else if (udev->actconfig && !udev->reset_resume) {
2650 le16_to_cpus(&devstatus);
2651 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) {
2652 status = usb_control_msg(udev,
2653 usb_sndctrlpipe(udev, 0),
2654 USB_REQ_CLEAR_FEATURE,
2656 USB_DEVICE_REMOTE_WAKEUP, 0,
2658 USB_CTRL_SET_TIMEOUT);
2661 "disable remote wakeup, status %d\n",
2670 * usb_port_resume - re-activate a suspended usb device's upstream port
2671 * @udev: device to re-activate, not a root hub
2672 * Context: must be able to sleep; device not locked; pm locks held
2674 * This will re-activate the suspended device, increasing power usage
2675 * while letting drivers communicate again with its endpoints.
2676 * USB resume explicitly guarantees that the power session between
2677 * the host and the device is the same as it was when the device
2680 * If @udev->reset_resume is set then this routine won't check that the
2681 * port is still enabled. Furthermore, finish_port_resume() above will
2682 * reset @udev. The end result is that a broken power session can be
2683 * recovered and @udev will appear to persist across a loss of VBUS power.
2685 * For example, if a host controller doesn't maintain VBUS suspend current
2686 * during a system sleep or is reset when the system wakes up, all the USB
2687 * power sessions below it will be broken. This is especially troublesome
2688 * for mass-storage devices containing mounted filesystems, since the
2689 * device will appear to have disconnected and all the memory mappings
2690 * to it will be lost. Using the USB_PERSIST facility, the device can be
2691 * made to appear as if it had not disconnected.
2693 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
2694 * every effort to insure that the same device is present after the
2695 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
2696 * quite possible for a device to remain unaltered but its media to be
2697 * changed. If the user replaces a flash memory card while the system is
2698 * asleep, he will have only himself to blame when the filesystem on the
2699 * new card is corrupted and the system crashes.
2701 * Returns 0 on success, else negative errno.
2703 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
2705 struct usb_hub *hub = hdev_to_hub(udev->parent);
2706 int port1 = udev->portnum;
2708 u16 portchange, portstatus;
2710 /* Skip the initial Clear-Suspend step for a remote wakeup */
2711 status = hub_port_status(hub, port1, &portstatus, &portchange);
2712 if (status == 0 && !port_is_suspended(hub, portstatus))
2713 goto SuspendCleared;
2715 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
2717 set_bit(port1, hub->busy_bits);
2719 /* see 7.1.7.7; affects power usage, but not budgeting */
2720 if (hub_is_superspeed(hub->hdev))
2721 status = set_port_feature(hub->hdev,
2722 port1 | (USB_SS_PORT_LS_U0 << 3),
2723 USB_PORT_FEAT_LINK_STATE);
2725 status = clear_port_feature(hub->hdev,
2726 port1, USB_PORT_FEAT_SUSPEND);
2728 dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
2731 /* drive resume for at least 20 msec */
2732 dev_dbg(&udev->dev, "usb %sresume\n",
2733 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
2736 /* Virtual root hubs can trigger on GET_PORT_STATUS to
2737 * stop resume signaling. Then finish the resume
2740 status = hub_port_status(hub, port1, &portstatus, &portchange);
2742 /* TRSMRCY = 10 msec */
2748 if (hub_is_superspeed(hub->hdev)) {
2749 if (portchange & USB_PORT_STAT_C_LINK_STATE)
2750 clear_port_feature(hub->hdev, port1,
2751 USB_PORT_FEAT_C_PORT_LINK_STATE);
2753 if (portchange & USB_PORT_STAT_C_SUSPEND)
2754 clear_port_feature(hub->hdev, port1,
2755 USB_PORT_FEAT_C_SUSPEND);
2759 clear_bit(port1, hub->busy_bits);
2761 status = check_port_resume_type(udev,
2762 hub, port1, status, portchange, portstatus);
2764 status = finish_port_resume(udev);
2766 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2767 hub_port_logical_disconnect(hub, port1);
2769 /* Try to enable USB2 hardware LPM */
2770 if (udev->usb2_hw_lpm_capable == 1)
2771 usb_set_usb2_hardware_lpm(udev, 1);
2777 /* caller has locked udev */
2778 int usb_remote_wakeup(struct usb_device *udev)
2782 if (udev->state == USB_STATE_SUSPENDED) {
2783 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
2784 status = usb_autoresume_device(udev);
2786 /* Let the drivers do their thing, then... */
2787 usb_autosuspend_device(udev);
2793 #else /* CONFIG_USB_SUSPEND */
2795 /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
2797 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2802 /* However we may need to do a reset-resume */
2804 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
2806 struct usb_hub *hub = hdev_to_hub(udev->parent);
2807 int port1 = udev->portnum;
2809 u16 portchange, portstatus;
2811 status = hub_port_status(hub, port1, &portstatus, &portchange);
2812 status = check_port_resume_type(udev,
2813 hub, port1, status, portchange, portstatus);
2816 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2817 hub_port_logical_disconnect(hub, port1);
2818 } else if (udev->reset_resume) {
2819 dev_dbg(&udev->dev, "reset-resume\n");
2820 status = usb_reset_and_verify_device(udev);
2827 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
2829 struct usb_hub *hub = usb_get_intfdata (intf);
2830 struct usb_device *hdev = hub->hdev;
2834 /* Warn if children aren't already suspended */
2835 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
2836 struct usb_device *udev;
2838 udev = hdev->children [port1-1];
2839 if (udev && udev->can_submit) {
2840 dev_warn(&intf->dev, "port %d nyet suspended\n", port1);
2841 if (PMSG_IS_AUTO(msg))
2845 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
2846 /* Enable hub to send remote wakeup for all ports. */
2847 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
2848 status = set_port_feature(hdev,
2850 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
2851 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
2852 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
2853 USB_PORT_FEAT_REMOTE_WAKE_MASK);
2857 dev_dbg(&intf->dev, "%s\n", __func__);
2859 /* stop khubd and related activity */
2860 hub_quiesce(hub, HUB_SUSPEND);
2864 static int hub_resume(struct usb_interface *intf)
2866 struct usb_hub *hub = usb_get_intfdata(intf);
2868 dev_dbg(&intf->dev, "%s\n", __func__);
2869 hub_activate(hub, HUB_RESUME);
2873 static int hub_reset_resume(struct usb_interface *intf)
2875 struct usb_hub *hub = usb_get_intfdata(intf);
2877 dev_dbg(&intf->dev, "%s\n", __func__);
2878 hub_activate(hub, HUB_RESET_RESUME);
2883 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
2884 * @rhdev: struct usb_device for the root hub
2886 * The USB host controller driver calls this function when its root hub
2887 * is resumed and Vbus power has been interrupted or the controller
2888 * has been reset. The routine marks @rhdev as having lost power.
2889 * When the hub driver is resumed it will take notice and carry out
2890 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
2891 * the others will be disconnected.
2893 void usb_root_hub_lost_power(struct usb_device *rhdev)
2895 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
2896 rhdev->reset_resume = 1;
2898 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
2900 #else /* CONFIG_PM */
2902 #define hub_suspend NULL
2903 #define hub_resume NULL
2904 #define hub_reset_resume NULL
2908 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2910 * Between connect detection and reset signaling there must be a delay
2911 * of 100ms at least for debounce and power-settling. The corresponding
2912 * timer shall restart whenever the downstream port detects a disconnect.
2914 * Apparently there are some bluetooth and irda-dongles and a number of
2915 * low-speed devices for which this debounce period may last over a second.
2916 * Not covered by the spec - but easy to deal with.
2918 * This implementation uses a 1500ms total debounce timeout; if the
2919 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2920 * every 25ms for transient disconnects. When the port status has been
2921 * unchanged for 100ms it returns the port status.
2923 static int hub_port_debounce(struct usb_hub *hub, int port1)
2926 int total_time, stable_time = 0;
2927 u16 portchange, portstatus;
2928 unsigned connection = 0xffff;
2930 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2931 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2935 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2936 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2937 stable_time += HUB_DEBOUNCE_STEP;
2938 if (stable_time >= HUB_DEBOUNCE_STABLE)
2942 connection = portstatus & USB_PORT_STAT_CONNECTION;
2945 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2946 clear_port_feature(hub->hdev, port1,
2947 USB_PORT_FEAT_C_CONNECTION);
2950 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2952 msleep(HUB_DEBOUNCE_STEP);
2955 dev_dbg (hub->intfdev,
2956 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2957 port1, total_time, stable_time, portstatus);
2959 if (stable_time < HUB_DEBOUNCE_STABLE)
2964 void usb_ep0_reinit(struct usb_device *udev)
2966 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
2967 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
2968 usb_enable_endpoint(udev, &udev->ep0, true);
2970 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
2972 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2973 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2975 static int hub_set_address(struct usb_device *udev, int devnum)
2978 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2981 * The host controller will choose the device address,
2982 * instead of the core having chosen it earlier
2984 if (!hcd->driver->address_device && devnum <= 1)
2986 if (udev->state == USB_STATE_ADDRESS)
2988 if (udev->state != USB_STATE_DEFAULT)
2990 if (hcd->driver->address_device)
2991 retval = hcd->driver->address_device(hcd, udev);
2993 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2994 USB_REQ_SET_ADDRESS, 0, devnum, 0,
2995 NULL, 0, USB_CTRL_SET_TIMEOUT);
2997 update_devnum(udev, devnum);
2998 /* Device now using proper address. */
2999 usb_set_device_state(udev, USB_STATE_ADDRESS);
3000 usb_ep0_reinit(udev);
3005 /* Reset device, (re)assign address, get device descriptor.
3006 * Device connection must be stable, no more debouncing needed.
3007 * Returns device in USB_STATE_ADDRESS, except on error.
3009 * If this is called for an already-existing device (as part of
3010 * usb_reset_and_verify_device), the caller must own the device lock. For a
3011 * newly detected device that is not accessible through any global
3012 * pointers, it's not necessary to lock the device.
3015 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
3018 static DEFINE_MUTEX(usb_address0_mutex);
3020 struct usb_device *hdev = hub->hdev;
3021 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
3023 unsigned delay = HUB_SHORT_RESET_TIME;
3024 enum usb_device_speed oldspeed = udev->speed;
3026 int devnum = udev->devnum;
3028 /* root hub ports have a slightly longer reset period
3029 * (from USB 2.0 spec, section 7.1.7.5)
3031 if (!hdev->parent) {
3032 delay = HUB_ROOT_RESET_TIME;
3033 if (port1 == hdev->bus->otg_port)
3034 hdev->bus->b_hnp_enable = 0;
3037 /* Some low speed devices have problems with the quick delay, so */
3038 /* be a bit pessimistic with those devices. RHbug #23670 */
3039 if (oldspeed == USB_SPEED_LOW)
3040 delay = HUB_LONG_RESET_TIME;
3042 mutex_lock(&usb_address0_mutex);
3044 /* Reset the device; full speed may morph to high speed */
3045 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
3046 retval = hub_port_reset(hub, port1, udev, delay, false);
3047 if (retval < 0) /* error or disconnect */
3049 /* success, speed is known */
3053 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
3054 dev_dbg(&udev->dev, "device reset changed speed!\n");
3057 oldspeed = udev->speed;
3059 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
3060 * it's fixed size except for full speed devices.
3061 * For Wireless USB devices, ep0 max packet is always 512 (tho
3062 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
3064 switch (udev->speed) {
3065 case USB_SPEED_SUPER:
3066 case USB_SPEED_WIRELESS: /* fixed at 512 */
3067 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
3069 case USB_SPEED_HIGH: /* fixed at 64 */
3070 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
3072 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
3073 /* to determine the ep0 maxpacket size, try to read
3074 * the device descriptor to get bMaxPacketSize0 and
3075 * then correct our initial guess.
3077 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
3079 case USB_SPEED_LOW: /* fixed at 8 */
3080 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
3086 if (udev->speed == USB_SPEED_WIRELESS)
3087 speed = "variable speed Wireless";
3089 speed = usb_speed_string(udev->speed);
3091 if (udev->speed != USB_SPEED_SUPER)
3092 dev_info(&udev->dev,
3093 "%s %s USB device number %d using %s\n",
3094 (udev->config) ? "reset" : "new", speed,
3095 devnum, udev->bus->controller->driver->name);
3097 /* Set up TT records, if needed */
3099 udev->tt = hdev->tt;
3100 udev->ttport = hdev->ttport;
3101 } else if (udev->speed != USB_SPEED_HIGH
3102 && hdev->speed == USB_SPEED_HIGH) {
3104 dev_err(&udev->dev, "parent hub has no TT\n");
3108 udev->tt = &hub->tt;
3109 udev->ttport = port1;
3112 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
3113 * Because device hardware and firmware is sometimes buggy in
3114 * this area, and this is how Linux has done it for ages.
3115 * Change it cautiously.
3117 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
3118 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
3119 * so it may help with some non-standards-compliant devices.
3120 * Otherwise we start with SET_ADDRESS and then try to read the
3121 * first 8 bytes of the device descriptor to get the ep0 maxpacket
3124 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
3125 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3)) {
3126 struct usb_device_descriptor *buf;
3129 #define GET_DESCRIPTOR_BUFSIZE 64
3130 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
3136 /* Retry on all errors; some devices are flakey.
3137 * 255 is for WUSB devices, we actually need to use
3138 * 512 (WUSB1.0[4.8.1]).
3140 for (j = 0; j < 3; ++j) {
3141 buf->bMaxPacketSize0 = 0;
3142 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
3143 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
3144 USB_DT_DEVICE << 8, 0,
3145 buf, GET_DESCRIPTOR_BUFSIZE,
3146 initial_descriptor_timeout);
3147 switch (buf->bMaxPacketSize0) {
3148 case 8: case 16: case 32: case 64: case 255:
3149 if (buf->bDescriptorType ==
3163 udev->descriptor.bMaxPacketSize0 =
3164 buf->bMaxPacketSize0;
3167 retval = hub_port_reset(hub, port1, udev, delay, false);
3168 if (retval < 0) /* error or disconnect */
3170 if (oldspeed != udev->speed) {
3172 "device reset changed speed!\n");
3178 "device descriptor read/64, error %d\n",
3183 #undef GET_DESCRIPTOR_BUFSIZE
3187 * If device is WUSB, we already assigned an
3188 * unauthorized address in the Connect Ack sequence;
3189 * authorization will assign the final address.
3191 if (udev->wusb == 0) {
3192 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
3193 retval = hub_set_address(udev, devnum);
3200 "device not accepting address %d, error %d\n",
3204 if (udev->speed == USB_SPEED_SUPER) {
3205 devnum = udev->devnum;
3206 dev_info(&udev->dev,
3207 "%s SuperSpeed USB device number %d using %s\n",
3208 (udev->config) ? "reset" : "new",
3209 devnum, udev->bus->controller->driver->name);
3212 /* cope with hardware quirkiness:
3213 * - let SET_ADDRESS settle, some device hardware wants it
3214 * - read ep0 maxpacket even for high and low speed,
3217 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3))
3221 retval = usb_get_device_descriptor(udev, 8);
3224 "device descriptor read/8, error %d\n",
3237 * Some superspeed devices have finished the link training process
3238 * and attached to a superspeed hub port, but the device descriptor
3239 * got from those devices show they aren't superspeed devices. Warm
3240 * reset the port attached by the devices can fix them.
3242 if ((udev->speed == USB_SPEED_SUPER) &&
3243 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
3244 dev_err(&udev->dev, "got a wrong device descriptor, "
3245 "warm reset device\n");
3246 hub_port_reset(hub, port1, udev,
3247 HUB_BH_RESET_TIME, true);
3252 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
3253 udev->speed == USB_SPEED_SUPER)
3256 i = udev->descriptor.bMaxPacketSize0;
3257 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
3258 if (udev->speed == USB_SPEED_LOW ||
3259 !(i == 8 || i == 16 || i == 32 || i == 64)) {
3260 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
3264 if (udev->speed == USB_SPEED_FULL)
3265 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
3267 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
3268 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
3269 usb_ep0_reinit(udev);
3272 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
3273 if (retval < (signed)sizeof(udev->descriptor)) {
3274 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
3281 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
3282 retval = usb_get_bos_descriptor(udev);
3284 if (udev->bos->ext_cap && (USB_LPM_SUPPORT &
3285 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
3286 udev->lpm_capable = 1;
3291 /* notify HCD that we have a device connected and addressed */
3292 if (hcd->driver->update_device)
3293 hcd->driver->update_device(hcd, udev);
3296 hub_port_disable(hub, port1, 0);
3297 update_devnum(udev, devnum); /* for disconnect processing */
3299 mutex_unlock(&usb_address0_mutex);
3304 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
3306 struct usb_qualifier_descriptor *qual;
3309 qual = kmalloc (sizeof *qual, GFP_KERNEL);
3313 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
3314 qual, sizeof *qual);
3315 if (status == sizeof *qual) {
3316 dev_info(&udev->dev, "not running at top speed; "
3317 "connect to a high speed hub\n");
3318 /* hub LEDs are probably harder to miss than syslog */
3319 if (hub->has_indicators) {
3320 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
3321 schedule_delayed_work (&hub->leds, 0);
3328 hub_power_remaining (struct usb_hub *hub)
3330 struct usb_device *hdev = hub->hdev;
3334 if (!hub->limited_power)
3337 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
3338 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
3339 struct usb_device *udev = hdev->children[port1 - 1];
3345 /* Unconfigured devices may not use more than 100mA,
3346 * or 8mA for OTG ports */
3347 if (udev->actconfig)
3348 delta = udev->actconfig->desc.bMaxPower * 2;
3349 else if (port1 != udev->bus->otg_port || hdev->parent)
3353 if (delta > hub->mA_per_port)
3354 dev_warn(&udev->dev,
3355 "%dmA is over %umA budget for port %d!\n",
3356 delta, hub->mA_per_port, port1);
3359 if (remaining < 0) {
3360 dev_warn(hub->intfdev, "%dmA over power budget!\n",
3367 /* Handle physical or logical connection change events.
3368 * This routine is called when:
3369 * a port connection-change occurs;
3370 * a port enable-change occurs (often caused by EMI);
3371 * usb_reset_and_verify_device() encounters changed descriptors (as from
3372 * a firmware download)
3373 * caller already locked the hub
3375 static void hub_port_connect_change(struct usb_hub *hub, int port1,
3376 u16 portstatus, u16 portchange)
3378 struct usb_device *hdev = hub->hdev;
3379 struct device *hub_dev = hub->intfdev;
3380 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
3381 unsigned wHubCharacteristics =
3382 le16_to_cpu(hub->descriptor->wHubCharacteristics);
3383 struct usb_device *udev;
3387 "port %d, status %04x, change %04x, %s\n",
3388 port1, portstatus, portchange, portspeed(hub, portstatus));
3390 if (hub->has_indicators) {
3391 set_port_led(hub, port1, HUB_LED_AUTO);
3392 hub->indicator[port1-1] = INDICATOR_AUTO;
3395 #ifdef CONFIG_USB_OTG
3396 /* during HNP, don't repeat the debounce */
3397 if (hdev->bus->is_b_host)
3398 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
3399 USB_PORT_STAT_C_ENABLE);
3402 /* Try to resuscitate an existing device */
3403 udev = hdev->children[port1-1];
3404 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
3405 udev->state != USB_STATE_NOTATTACHED) {
3406 usb_lock_device(udev);
3407 if (portstatus & USB_PORT_STAT_ENABLE) {
3408 status = 0; /* Nothing to do */
3410 #ifdef CONFIG_USB_SUSPEND
3411 } else if (udev->state == USB_STATE_SUSPENDED &&
3412 udev->persist_enabled) {
3413 /* For a suspended device, treat this as a
3414 * remote wakeup event.
3416 status = usb_remote_wakeup(udev);
3420 status = -ENODEV; /* Don't resuscitate */
3422 usb_unlock_device(udev);
3425 clear_bit(port1, hub->change_bits);
3430 /* Disconnect any existing devices under this port */
3432 usb_disconnect(&hdev->children[port1-1]);
3433 clear_bit(port1, hub->change_bits);
3435 /* We can forget about a "removed" device when there's a physical
3436 * disconnect or the connect status changes.
3438 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
3439 (portchange & USB_PORT_STAT_C_CONNECTION))
3440 clear_bit(port1, hub->removed_bits);
3442 if (portchange & (USB_PORT_STAT_C_CONNECTION |
3443 USB_PORT_STAT_C_ENABLE)) {
3444 status = hub_port_debounce(hub, port1);
3446 if (printk_ratelimit())
3447 dev_err(hub_dev, "connect-debounce failed, "
3448 "port %d disabled\n", port1);
3449 portstatus &= ~USB_PORT_STAT_CONNECTION;
3451 portstatus = status;
3455 /* Return now if debouncing failed or nothing is connected or
3456 * the device was "removed".
3458 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
3459 test_bit(port1, hub->removed_bits)) {
3461 /* maybe switch power back on (e.g. root hub was reset) */
3462 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
3463 && !port_is_power_on(hub, portstatus))
3464 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
3466 if (portstatus & USB_PORT_STAT_ENABLE)
3471 for (i = 0; i < SET_CONFIG_TRIES; i++) {
3473 /* reallocate for each attempt, since references
3474 * to the previous one can escape in various ways
3476 udev = usb_alloc_dev(hdev, hdev->bus, port1);
3479 "couldn't allocate port %d usb_device\n",
3484 usb_set_device_state(udev, USB_STATE_POWERED);
3485 udev->bus_mA = hub->mA_per_port;
3486 udev->level = hdev->level + 1;
3487 udev->wusb = hub_is_wusb(hub);
3489 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
3490 if (hub_is_superspeed(hub->hdev))
3491 udev->speed = USB_SPEED_SUPER;
3493 udev->speed = USB_SPEED_UNKNOWN;
3495 choose_devnum(udev);
3496 if (udev->devnum <= 0) {
3497 status = -ENOTCONN; /* Don't retry */
3501 /* reset (non-USB 3.0 devices) and get descriptor */
3502 status = hub_port_init(hub, udev, port1, i);
3506 usb_detect_quirks(udev);
3507 if (udev->quirks & USB_QUIRK_DELAY_INIT)
3510 /* consecutive bus-powered hubs aren't reliable; they can
3511 * violate the voltage drop budget. if the new child has
3512 * a "powered" LED, users should notice we didn't enable it
3513 * (without reading syslog), even without per-port LEDs
3516 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
3517 && udev->bus_mA <= 100) {
3520 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
3523 dev_dbg(&udev->dev, "get status %d ?\n", status);
3526 le16_to_cpus(&devstat);
3527 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
3529 "can't connect bus-powered hub "
3531 if (hub->has_indicators) {
3532 hub->indicator[port1-1] =
3533 INDICATOR_AMBER_BLINK;
3534 schedule_delayed_work (&hub->leds, 0);
3536 status = -ENOTCONN; /* Don't retry */
3541 /* check for devices running slower than they could */
3542 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
3543 && udev->speed == USB_SPEED_FULL
3544 && highspeed_hubs != 0)
3545 check_highspeed (hub, udev, port1);
3547 /* Store the parent's children[] pointer. At this point
3548 * udev becomes globally accessible, although presumably
3549 * no one will look at it until hdev is unlocked.
3553 /* We mustn't add new devices if the parent hub has
3554 * been disconnected; we would race with the
3555 * recursively_mark_NOTATTACHED() routine.
3557 spin_lock_irq(&device_state_lock);
3558 if (hdev->state == USB_STATE_NOTATTACHED)
3561 hdev->children[port1-1] = udev;
3562 spin_unlock_irq(&device_state_lock);
3564 /* Run it through the hoops (find a driver, etc) */
3566 status = usb_new_device(udev);
3568 spin_lock_irq(&device_state_lock);
3569 hdev->children[port1-1] = NULL;
3570 spin_unlock_irq(&device_state_lock);
3577 status = hub_power_remaining(hub);
3579 dev_dbg(hub_dev, "%dmA power budget left\n", status);
3584 hub_port_disable(hub, port1, 1);
3586 usb_ep0_reinit(udev);
3587 release_devnum(udev);
3590 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
3593 if (hub->hdev->parent ||
3594 !hcd->driver->port_handed_over ||
3595 !(hcd->driver->port_handed_over)(hcd, port1))
3596 dev_err(hub_dev, "unable to enumerate USB device on port %d\n",
3600 hub_port_disable(hub, port1, 1);
3601 if (hcd->driver->relinquish_port && !hub->hdev->parent)
3602 hcd->driver->relinquish_port(hcd, port1);
3605 /* Returns 1 if there was a remote wakeup and a connect status change. */
3606 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
3607 u16 portstatus, u16 portchange)
3609 struct usb_device *hdev;
3610 struct usb_device *udev;
3611 int connect_change = 0;
3615 udev = hdev->children[port-1];
3616 if (!hub_is_superspeed(hdev)) {
3617 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
3619 clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
3621 if (!udev || udev->state != USB_STATE_SUSPENDED ||
3622 (portstatus & USB_PORT_STAT_LINK_STATE) !=
3628 /* TRSMRCY = 10 msec */
3631 usb_lock_device(udev);
3632 ret = usb_remote_wakeup(udev);
3633 usb_unlock_device(udev);
3638 hub_port_disable(hub, port, 1);
3640 dev_dbg(hub->intfdev, "resume on port %d, status %d\n",
3642 return connect_change;
3645 static void hub_events(void)
3647 struct list_head *tmp;
3648 struct usb_device *hdev;
3649 struct usb_interface *intf;
3650 struct usb_hub *hub;
3651 struct device *hub_dev;
3657 int connect_change, wakeup_change;
3660 * We restart the list every time to avoid a deadlock with
3661 * deleting hubs downstream from this one. This should be
3662 * safe since we delete the hub from the event list.
3663 * Not the most efficient, but avoids deadlocks.
3667 /* Grab the first entry at the beginning of the list */
3668 spin_lock_irq(&hub_event_lock);
3669 if (list_empty(&hub_event_list)) {
3670 spin_unlock_irq(&hub_event_lock);
3674 tmp = hub_event_list.next;
3677 hub = list_entry(tmp, struct usb_hub, event_list);
3678 kref_get(&hub->kref);
3679 spin_unlock_irq(&hub_event_lock);
3682 hub_dev = hub->intfdev;
3683 intf = to_usb_interface(hub_dev);
3684 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
3685 hdev->state, hub->descriptor
3686 ? hub->descriptor->bNbrPorts
3688 /* NOTE: expects max 15 ports... */
3689 (u16) hub->change_bits[0],
3690 (u16) hub->event_bits[0]);
3692 /* Lock the device, then check to see if we were
3693 * disconnected while waiting for the lock to succeed. */
3694 usb_lock_device(hdev);
3695 if (unlikely(hub->disconnected))
3696 goto loop_disconnected;
3698 /* If the hub has died, clean up after it */
3699 if (hdev->state == USB_STATE_NOTATTACHED) {
3700 hub->error = -ENODEV;
3701 hub_quiesce(hub, HUB_DISCONNECT);
3706 ret = usb_autopm_get_interface(intf);
3708 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
3712 /* If this is an inactive hub, do nothing */
3717 dev_dbg (hub_dev, "resetting for error %d\n",
3720 ret = usb_reset_device(hdev);
3723 "error resetting hub: %d\n", ret);
3731 /* deal with port status changes */
3732 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
3733 if (test_bit(i, hub->busy_bits))
3735 connect_change = test_bit(i, hub->change_bits);
3736 wakeup_change = test_and_clear_bit(i, hub->wakeup_bits);
3737 if (!test_and_clear_bit(i, hub->event_bits) &&
3738 !connect_change && !wakeup_change)
3741 ret = hub_port_status(hub, i,
3742 &portstatus, &portchange);
3746 if (portchange & USB_PORT_STAT_C_CONNECTION) {
3747 clear_port_feature(hdev, i,
3748 USB_PORT_FEAT_C_CONNECTION);
3752 if (portchange & USB_PORT_STAT_C_ENABLE) {
3753 if (!connect_change)
3755 "port %d enable change, "
3758 clear_port_feature(hdev, i,
3759 USB_PORT_FEAT_C_ENABLE);
3762 * EM interference sometimes causes badly
3763 * shielded USB devices to be shutdown by
3764 * the hub, this hack enables them again.
3765 * Works at least with mouse driver.
3767 if (!(portstatus & USB_PORT_STAT_ENABLE)
3769 && hdev->children[i-1]) {
3772 "disabled by hub (EMI?), "
3779 if (hub_handle_remote_wakeup(hub, i,
3780 portstatus, portchange))
3783 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
3787 dev_dbg(hub_dev, "over-current change on port "
3789 clear_port_feature(hdev, i,
3790 USB_PORT_FEAT_C_OVER_CURRENT);
3791 msleep(100); /* Cool down */
3792 hub_power_on(hub, true);
3793 hub_port_status(hub, i, &status, &unused);
3794 if (status & USB_PORT_STAT_OVERCURRENT)
3795 dev_err(hub_dev, "over-current "
3796 "condition on port %d\n", i);
3799 if (portchange & USB_PORT_STAT_C_RESET) {
3801 "reset change on port %d\n",
3803 clear_port_feature(hdev, i,
3804 USB_PORT_FEAT_C_RESET);
3806 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
3807 hub_is_superspeed(hub->hdev)) {
3809 "warm reset change on port %d\n",
3811 clear_port_feature(hdev, i,
3812 USB_PORT_FEAT_C_BH_PORT_RESET);
3814 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
3815 clear_port_feature(hub->hdev, i,
3816 USB_PORT_FEAT_C_PORT_LINK_STATE);
3818 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
3820 "config error on port %d\n",
3822 clear_port_feature(hub->hdev, i,
3823 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
3826 /* Warm reset a USB3 protocol port if it's in
3827 * SS.Inactive state.
3829 if (hub_port_warm_reset_required(hub, portstatus)) {
3830 dev_dbg(hub_dev, "warm reset port %d\n", i);
3831 hub_port_reset(hub, i, NULL,
3832 HUB_BH_RESET_TIME, true);
3836 hub_port_connect_change(hub, i,
3837 portstatus, portchange);
3840 /* deal with hub status changes */
3841 if (test_and_clear_bit(0, hub->event_bits) == 0)
3843 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
3844 dev_err (hub_dev, "get_hub_status failed\n");
3846 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
3847 dev_dbg (hub_dev, "power change\n");
3848 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
3849 if (hubstatus & HUB_STATUS_LOCAL_POWER)
3850 /* FIXME: Is this always true? */
3851 hub->limited_power = 1;
3853 hub->limited_power = 0;
3855 if (hubchange & HUB_CHANGE_OVERCURRENT) {
3859 dev_dbg(hub_dev, "over-current change\n");
3860 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
3861 msleep(500); /* Cool down */
3862 hub_power_on(hub, true);
3863 hub_hub_status(hub, &status, &unused);
3864 if (status & HUB_STATUS_OVERCURRENT)
3865 dev_err(hub_dev, "over-current "
3871 /* Balance the usb_autopm_get_interface() above */
3872 usb_autopm_put_interface_no_suspend(intf);
3874 /* Balance the usb_autopm_get_interface_no_resume() in
3875 * kick_khubd() and allow autosuspend.
3877 usb_autopm_put_interface(intf);
3879 usb_unlock_device(hdev);
3880 kref_put(&hub->kref, hub_release);
3882 } /* end while (1) */
3885 static int hub_thread(void *__unused)
3887 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
3888 * port handover. Otherwise it might see that a full-speed device
3889 * was gone before the EHCI controller had handed its port over to
3890 * the companion full-speed controller.
3896 wait_event_freezable(khubd_wait,
3897 !list_empty(&hub_event_list) ||
3898 kthread_should_stop());
3899 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
3901 pr_debug("%s: khubd exiting\n", usbcore_name);
3905 static const struct usb_device_id hub_id_table[] = {
3906 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
3907 .bDeviceClass = USB_CLASS_HUB},
3908 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
3909 .bInterfaceClass = USB_CLASS_HUB},
3910 { } /* Terminating entry */
3913 MODULE_DEVICE_TABLE (usb, hub_id_table);
3915 static struct usb_driver hub_driver = {
3918 .disconnect = hub_disconnect,
3919 .suspend = hub_suspend,
3920 .resume = hub_resume,
3921 .reset_resume = hub_reset_resume,
3922 .pre_reset = hub_pre_reset,
3923 .post_reset = hub_post_reset,
3924 .unlocked_ioctl = hub_ioctl,
3925 .id_table = hub_id_table,
3926 .supports_autosuspend = 1,
3929 int usb_hub_init(void)
3931 if (usb_register(&hub_driver) < 0) {
3932 printk(KERN_ERR "%s: can't register hub driver\n",
3937 khubd_task = kthread_run(hub_thread, NULL, "khubd");
3938 if (!IS_ERR(khubd_task))
3941 /* Fall through if kernel_thread failed */
3942 usb_deregister(&hub_driver);
3943 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
3948 void usb_hub_cleanup(void)
3950 kthread_stop(khubd_task);
3953 * Hub resources are freed for us by usb_deregister. It calls
3954 * usb_driver_purge on every device which in turn calls that
3955 * devices disconnect function if it is using this driver.
3956 * The hub_disconnect function takes care of releasing the
3957 * individual hub resources. -greg
3959 usb_deregister(&hub_driver);
3960 } /* usb_hub_cleanup() */
3962 static int descriptors_changed(struct usb_device *udev,
3963 struct usb_device_descriptor *old_device_descriptor)
3967 unsigned serial_len = 0;
3969 unsigned old_length;
3973 if (memcmp(&udev->descriptor, old_device_descriptor,
3974 sizeof(*old_device_descriptor)) != 0)
3977 /* Since the idVendor, idProduct, and bcdDevice values in the
3978 * device descriptor haven't changed, we will assume the
3979 * Manufacturer and Product strings haven't changed either.
3980 * But the SerialNumber string could be different (e.g., a
3981 * different flash card of the same brand).
3984 serial_len = strlen(udev->serial) + 1;
3987 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3988 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3989 len = max(len, old_length);
3992 buf = kmalloc(len, GFP_NOIO);
3994 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
3995 /* assume the worst */
3998 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3999 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
4000 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
4002 if (length != old_length) {
4003 dev_dbg(&udev->dev, "config index %d, error %d\n",
4008 if (memcmp (buf, udev->rawdescriptors[index], old_length)
4010 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
4012 ((struct usb_config_descriptor *) buf)->
4013 bConfigurationValue);
4019 if (!changed && serial_len) {
4020 length = usb_string(udev, udev->descriptor.iSerialNumber,
4022 if (length + 1 != serial_len) {
4023 dev_dbg(&udev->dev, "serial string error %d\n",
4026 } else if (memcmp(buf, udev->serial, length) != 0) {
4027 dev_dbg(&udev->dev, "serial string changed\n");
4037 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
4038 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
4040 * WARNING - don't use this routine to reset a composite device
4041 * (one with multiple interfaces owned by separate drivers)!
4042 * Use usb_reset_device() instead.
4044 * Do a port reset, reassign the device's address, and establish its
4045 * former operating configuration. If the reset fails, or the device's
4046 * descriptors change from their values before the reset, or the original
4047 * configuration and altsettings cannot be restored, a flag will be set
4048 * telling khubd to pretend the device has been disconnected and then
4049 * re-connected. All drivers will be unbound, and the device will be
4050 * re-enumerated and probed all over again.
4052 * Returns 0 if the reset succeeded, -ENODEV if the device has been
4053 * flagged for logical disconnection, or some other negative error code
4054 * if the reset wasn't even attempted.
4056 * The caller must own the device lock. For example, it's safe to use
4057 * this from a driver probe() routine after downloading new firmware.
4058 * For calls that might not occur during probe(), drivers should lock
4059 * the device using usb_lock_device_for_reset().
4061 * Locking exception: This routine may also be called from within an
4062 * autoresume handler. Such usage won't conflict with other tasks
4063 * holding the device lock because these tasks should always call
4064 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
4066 static int usb_reset_and_verify_device(struct usb_device *udev)
4068 struct usb_device *parent_hdev = udev->parent;
4069 struct usb_hub *parent_hub;
4070 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4071 struct usb_device_descriptor descriptor = udev->descriptor;
4073 int port1 = udev->portnum;
4075 if (udev->state == USB_STATE_NOTATTACHED ||
4076 udev->state == USB_STATE_SUSPENDED) {
4077 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
4083 /* this requires hcd-specific logic; see ohci_restart() */
4084 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
4087 parent_hub = hdev_to_hub(parent_hdev);
4089 set_bit(port1, parent_hub->busy_bits);
4090 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
4092 /* ep0 maxpacket size may change; let the HCD know about it.
4093 * Other endpoints will be handled by re-enumeration. */
4094 usb_ep0_reinit(udev);
4095 ret = hub_port_init(parent_hub, udev, port1, i);
4096 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
4099 clear_bit(port1, parent_hub->busy_bits);
4104 /* Device might have changed firmware (DFU or similar) */
4105 if (descriptors_changed(udev, &descriptor)) {
4106 dev_info(&udev->dev, "device firmware changed\n");
4107 udev->descriptor = descriptor; /* for disconnect() calls */
4111 /* Restore the device's previous configuration */
4112 if (!udev->actconfig)
4115 mutex_lock(hcd->bandwidth_mutex);
4116 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
4118 dev_warn(&udev->dev,
4119 "Busted HC? Not enough HCD resources for "
4120 "old configuration.\n");
4121 mutex_unlock(hcd->bandwidth_mutex);
4124 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
4125 USB_REQ_SET_CONFIGURATION, 0,
4126 udev->actconfig->desc.bConfigurationValue, 0,
4127 NULL, 0, USB_CTRL_SET_TIMEOUT);
4130 "can't restore configuration #%d (error=%d)\n",
4131 udev->actconfig->desc.bConfigurationValue, ret);
4132 mutex_unlock(hcd->bandwidth_mutex);
4135 mutex_unlock(hcd->bandwidth_mutex);
4136 usb_set_device_state(udev, USB_STATE_CONFIGURED);
4138 /* Put interfaces back into the same altsettings as before.
4139 * Don't bother to send the Set-Interface request for interfaces
4140 * that were already in altsetting 0; besides being unnecessary,
4141 * many devices can't handle it. Instead just reset the host-side
4144 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
4145 struct usb_host_config *config = udev->actconfig;
4146 struct usb_interface *intf = config->interface[i];
4147 struct usb_interface_descriptor *desc;
4149 desc = &intf->cur_altsetting->desc;
4150 if (desc->bAlternateSetting == 0) {
4151 usb_disable_interface(udev, intf, true);
4152 usb_enable_interface(udev, intf, true);
4155 /* Let the bandwidth allocation function know that this
4156 * device has been reset, and it will have to use
4157 * alternate setting 0 as the current alternate setting.
4159 intf->resetting_device = 1;
4160 ret = usb_set_interface(udev, desc->bInterfaceNumber,
4161 desc->bAlternateSetting);
4162 intf->resetting_device = 0;
4165 dev_err(&udev->dev, "failed to restore interface %d "
4166 "altsetting %d (error=%d)\n",
4167 desc->bInterfaceNumber,
4168 desc->bAlternateSetting,
4178 hub_port_logical_disconnect(parent_hub, port1);
4183 * usb_reset_device - warn interface drivers and perform a USB port reset
4184 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
4186 * Warns all drivers bound to registered interfaces (using their pre_reset
4187 * method), performs the port reset, and then lets the drivers know that
4188 * the reset is over (using their post_reset method).
4190 * Return value is the same as for usb_reset_and_verify_device().
4192 * The caller must own the device lock. For example, it's safe to use
4193 * this from a driver probe() routine after downloading new firmware.
4194 * For calls that might not occur during probe(), drivers should lock
4195 * the device using usb_lock_device_for_reset().
4197 * If an interface is currently being probed or disconnected, we assume
4198 * its driver knows how to handle resets. For all other interfaces,
4199 * if the driver doesn't have pre_reset and post_reset methods then
4200 * we attempt to unbind it and rebind afterward.
4202 int usb_reset_device(struct usb_device *udev)
4206 struct usb_host_config *config = udev->actconfig;
4208 if (udev->state == USB_STATE_NOTATTACHED ||
4209 udev->state == USB_STATE_SUSPENDED) {
4210 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
4215 /* Prevent autosuspend during the reset */
4216 usb_autoresume_device(udev);
4219 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
4220 struct usb_interface *cintf = config->interface[i];
4221 struct usb_driver *drv;
4224 if (cintf->dev.driver) {
4225 drv = to_usb_driver(cintf->dev.driver);
4226 if (drv->pre_reset && drv->post_reset)
4227 unbind = (drv->pre_reset)(cintf);
4228 else if (cintf->condition ==
4229 USB_INTERFACE_BOUND)
4232 usb_forced_unbind_intf(cintf);
4237 ret = usb_reset_and_verify_device(udev);
4240 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
4241 struct usb_interface *cintf = config->interface[i];
4242 struct usb_driver *drv;
4243 int rebind = cintf->needs_binding;
4245 if (!rebind && cintf->dev.driver) {
4246 drv = to_usb_driver(cintf->dev.driver);
4247 if (drv->post_reset)
4248 rebind = (drv->post_reset)(cintf);
4249 else if (cintf->condition ==
4250 USB_INTERFACE_BOUND)
4253 if (ret == 0 && rebind)
4254 usb_rebind_intf(cintf);
4258 usb_autosuspend_device(udev);
4261 EXPORT_SYMBOL_GPL(usb_reset_device);
4265 * usb_queue_reset_device - Reset a USB device from an atomic context
4266 * @iface: USB interface belonging to the device to reset
4268 * This function can be used to reset a USB device from an atomic
4269 * context, where usb_reset_device() won't work (as it blocks).
4271 * Doing a reset via this method is functionally equivalent to calling
4272 * usb_reset_device(), except for the fact that it is delayed to a
4273 * workqueue. This means that any drivers bound to other interfaces
4274 * might be unbound, as well as users from usbfs in user space.
4278 * - Scheduling two resets at the same time from two different drivers
4279 * attached to two different interfaces of the same device is
4280 * possible; depending on how the driver attached to each interface
4281 * handles ->pre_reset(), the second reset might happen or not.
4283 * - If a driver is unbound and it had a pending reset, the reset will
4286 * - This function can be called during .probe() or .disconnect()
4287 * times. On return from .disconnect(), any pending resets will be
4290 * There is no no need to lock/unlock the @reset_ws as schedule_work()
4293 * NOTE: We don't do any reference count tracking because it is not
4294 * needed. The lifecycle of the work_struct is tied to the
4295 * usb_interface. Before destroying the interface we cancel the
4296 * work_struct, so the fact that work_struct is queued and or
4297 * running means the interface (and thus, the device) exist and
4300 void usb_queue_reset_device(struct usb_interface *iface)
4302 schedule_work(&iface->reset_ws);
4304 EXPORT_SYMBOL_GPL(usb_queue_reset_device);