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_port_disable(struct usb_hub *hub, int port1, int set_state)
648 struct usb_device *hdev = hub->hdev;
651 if (hdev->children[port1-1] && set_state)
652 usb_set_device_state(hdev->children[port1-1],
653 USB_STATE_NOTATTACHED);
654 if (!hub->error && !hub_is_superspeed(hub->hdev))
655 ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
657 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
663 * Disable a port and mark a logical connect-change event, so that some
664 * time later khubd will disconnect() any existing usb_device on the port
665 * and will re-enumerate if there actually is a device attached.
667 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
669 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
670 hub_port_disable(hub, port1, 1);
672 /* FIXME let caller ask to power down the port:
673 * - some devices won't enumerate without a VBUS power cycle
674 * - SRP saves power that way
675 * - ... new call, TBD ...
676 * That's easy if this hub can switch power per-port, and
677 * khubd reactivates the port later (timer, SRP, etc).
678 * Powerdown must be optional, because of reset/DFU.
681 set_bit(port1, hub->change_bits);
686 * usb_remove_device - disable a device's port on its parent hub
687 * @udev: device to be disabled and removed
688 * Context: @udev locked, must be able to sleep.
690 * After @udev's port has been disabled, khubd is notified and it will
691 * see that the device has been disconnected. When the device is
692 * physically unplugged and something is plugged in, the events will
693 * be received and processed normally.
695 int usb_remove_device(struct usb_device *udev)
698 struct usb_interface *intf;
700 if (!udev->parent) /* Can't remove a root hub */
702 hub = hdev_to_hub(udev->parent);
703 intf = to_usb_interface(hub->intfdev);
705 usb_autopm_get_interface(intf);
706 set_bit(udev->portnum, hub->removed_bits);
707 hub_port_logical_disconnect(hub, udev->portnum);
708 usb_autopm_put_interface(intf);
712 enum hub_activation_type {
713 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
714 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
717 static void hub_init_func2(struct work_struct *ws);
718 static void hub_init_func3(struct work_struct *ws);
720 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
722 struct usb_device *hdev = hub->hdev;
727 bool need_debounce_delay = false;
730 /* Continue a partial initialization */
731 if (type == HUB_INIT2)
733 if (type == HUB_INIT3)
736 /* The superspeed hub except for root hub has to use Hub Depth
737 * value as an offset into the route string to locate the bits
738 * it uses to determine the downstream port number. So hub driver
739 * should send a set hub depth request to superspeed hub after
740 * the superspeed hub is set configuration in initialization or
743 * After a resume, port power should still be on.
744 * For any other type of activation, turn it on.
746 if (type != HUB_RESUME) {
747 if (hdev->parent && hub_is_superspeed(hdev)) {
748 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
749 HUB_SET_DEPTH, USB_RT_HUB,
750 hdev->level - 1, 0, NULL, 0,
751 USB_CTRL_SET_TIMEOUT);
753 dev_err(hub->intfdev,
754 "set hub depth failed\n");
757 /* Speed up system boot by using a delayed_work for the
758 * hub's initial power-up delays. This is pretty awkward
759 * and the implementation looks like a home-brewed sort of
760 * setjmp/longjmp, but it saves at least 100 ms for each
761 * root hub (assuming usbcore is compiled into the kernel
762 * rather than as a module). It adds up.
764 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
765 * because for those activation types the ports have to be
766 * operational when we return. In theory this could be done
767 * for HUB_POST_RESET, but it's easier not to.
769 if (type == HUB_INIT) {
770 delay = hub_power_on(hub, false);
771 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func2);
772 schedule_delayed_work(&hub->init_work,
773 msecs_to_jiffies(delay));
775 /* Suppress autosuspend until init is done */
776 usb_autopm_get_interface_no_resume(
777 to_usb_interface(hub->intfdev));
778 return; /* Continues at init2: below */
779 } else if (type == HUB_RESET_RESUME) {
780 /* The internal host controller state for the hub device
781 * may be gone after a host power loss on system resume.
782 * Update the device's info so the HW knows it's a hub.
784 hcd = bus_to_hcd(hdev->bus);
785 if (hcd->driver->update_hub_device) {
786 ret = hcd->driver->update_hub_device(hcd, hdev,
789 dev_err(hub->intfdev, "Host not "
790 "accepting hub info "
792 dev_err(hub->intfdev, "LS/FS devices "
793 "and hubs may not work "
794 "under this hub\n.");
797 hub_power_on(hub, true);
799 hub_power_on(hub, true);
804 /* Check each port and set hub->change_bits to let khubd know
805 * which ports need attention.
807 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
808 struct usb_device *udev = hdev->children[port1-1];
809 u16 portstatus, portchange;
811 portstatus = portchange = 0;
812 status = hub_port_status(hub, port1, &portstatus, &portchange);
813 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
814 dev_dbg(hub->intfdev,
815 "port %d: status %04x change %04x\n",
816 port1, portstatus, portchange);
818 /* After anything other than HUB_RESUME (i.e., initialization
819 * or any sort of reset), every port should be disabled.
820 * Unconnected ports should likewise be disabled (paranoia),
821 * and so should ports for which we have no usb_device.
823 if ((portstatus & USB_PORT_STAT_ENABLE) && (
824 type != HUB_RESUME ||
825 !(portstatus & USB_PORT_STAT_CONNECTION) ||
827 udev->state == USB_STATE_NOTATTACHED)) {
829 * USB3 protocol ports will automatically transition
830 * to Enabled state when detect an USB3.0 device attach.
831 * Do not disable USB3 protocol ports.
833 if (!hub_is_superspeed(hdev)) {
834 clear_port_feature(hdev, port1,
835 USB_PORT_FEAT_ENABLE);
836 portstatus &= ~USB_PORT_STAT_ENABLE;
838 /* Pretend that power was lost for USB3 devs */
839 portstatus &= ~USB_PORT_STAT_ENABLE;
843 /* Clear status-change flags; we'll debounce later */
844 if (portchange & USB_PORT_STAT_C_CONNECTION) {
845 need_debounce_delay = true;
846 clear_port_feature(hub->hdev, port1,
847 USB_PORT_FEAT_C_CONNECTION);
849 if (portchange & USB_PORT_STAT_C_ENABLE) {
850 need_debounce_delay = true;
851 clear_port_feature(hub->hdev, port1,
852 USB_PORT_FEAT_C_ENABLE);
854 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
855 hub_is_superspeed(hub->hdev)) {
856 need_debounce_delay = true;
857 clear_port_feature(hub->hdev, port1,
858 USB_PORT_FEAT_C_BH_PORT_RESET);
860 /* We can forget about a "removed" device when there's a
861 * physical disconnect or the connect status changes.
863 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
864 (portchange & USB_PORT_STAT_C_CONNECTION))
865 clear_bit(port1, hub->removed_bits);
867 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
868 /* Tell khubd to disconnect the device or
869 * check for a new connection
871 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
872 set_bit(port1, hub->change_bits);
874 } else if (portstatus & USB_PORT_STAT_ENABLE) {
875 bool port_resumed = (portstatus &
876 USB_PORT_STAT_LINK_STATE) ==
878 /* The power session apparently survived the resume.
879 * If there was an overcurrent or suspend change
880 * (i.e., remote wakeup request), have khubd
881 * take care of it. Look at the port link state
882 * for USB 3.0 hubs, since they don't have a suspend
883 * change bit, and they don't set the port link change
884 * bit on device-initiated resume.
886 if (portchange || (hub_is_superspeed(hub->hdev) &&
888 set_bit(port1, hub->change_bits);
890 } else if (udev->persist_enabled) {
892 udev->reset_resume = 1;
894 set_bit(port1, hub->change_bits);
897 /* The power session is gone; tell khubd */
898 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
899 set_bit(port1, hub->change_bits);
903 /* If no port-status-change flags were set, we don't need any
904 * debouncing. If flags were set we can try to debounce the
905 * ports all at once right now, instead of letting khubd do them
906 * one at a time later on.
908 * If any port-status changes do occur during this delay, khubd
909 * will see them later and handle them normally.
911 if (need_debounce_delay) {
912 delay = HUB_DEBOUNCE_STABLE;
914 /* Don't do a long sleep inside a workqueue routine */
915 if (type == HUB_INIT2) {
916 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func3);
917 schedule_delayed_work(&hub->init_work,
918 msecs_to_jiffies(delay));
919 return; /* Continues at init3: below */
927 status = usb_submit_urb(hub->urb, GFP_NOIO);
929 dev_err(hub->intfdev, "activate --> %d\n", status);
930 if (hub->has_indicators && blinkenlights)
931 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
933 /* Scan all ports that need attention */
936 /* Allow autosuspend if it was suppressed */
937 if (type <= HUB_INIT3)
938 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
941 /* Implement the continuations for the delays above */
942 static void hub_init_func2(struct work_struct *ws)
944 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
946 hub_activate(hub, HUB_INIT2);
949 static void hub_init_func3(struct work_struct *ws)
951 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
953 hub_activate(hub, HUB_INIT3);
956 enum hub_quiescing_type {
957 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
960 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
962 struct usb_device *hdev = hub->hdev;
965 cancel_delayed_work_sync(&hub->init_work);
967 /* khubd and related activity won't re-trigger */
970 if (type != HUB_SUSPEND) {
971 /* Disconnect all the children */
972 for (i = 0; i < hdev->maxchild; ++i) {
973 if (hdev->children[i])
974 usb_disconnect(&hdev->children[i]);
978 /* Stop khubd and related activity */
979 usb_kill_urb(hub->urb);
980 if (hub->has_indicators)
981 cancel_delayed_work_sync(&hub->leds);
983 flush_work_sync(&hub->tt.clear_work);
986 /* caller has locked the hub device */
987 static int hub_pre_reset(struct usb_interface *intf)
989 struct usb_hub *hub = usb_get_intfdata(intf);
991 hub_quiesce(hub, HUB_PRE_RESET);
995 /* caller has locked the hub device */
996 static int hub_post_reset(struct usb_interface *intf)
998 struct usb_hub *hub = usb_get_intfdata(intf);
1000 hub_activate(hub, HUB_POST_RESET);
1004 static int hub_configure(struct usb_hub *hub,
1005 struct usb_endpoint_descriptor *endpoint)
1007 struct usb_hcd *hcd;
1008 struct usb_device *hdev = hub->hdev;
1009 struct device *hub_dev = hub->intfdev;
1010 u16 hubstatus, hubchange;
1011 u16 wHubCharacteristics;
1014 char *message = "out of memory";
1016 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
1022 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1027 mutex_init(&hub->status_mutex);
1029 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1030 if (!hub->descriptor) {
1035 /* Request the entire hub descriptor.
1036 * hub->descriptor can handle USB_MAXCHILDREN ports,
1037 * but the hub can/will return fewer bytes here.
1039 ret = get_hub_descriptor(hdev, hub->descriptor);
1041 message = "can't read hub descriptor";
1043 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
1044 message = "hub has too many ports!";
1049 hdev->maxchild = hub->descriptor->bNbrPorts;
1050 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
1051 (hdev->maxchild == 1) ? "" : "s");
1053 hdev->children = kzalloc(hdev->maxchild *
1054 sizeof(struct usb_device *), GFP_KERNEL);
1055 hub->port_owners = kzalloc(hdev->maxchild * sizeof(void *), GFP_KERNEL);
1056 if (!hdev->children || !hub->port_owners) {
1061 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1063 /* FIXME for USB 3.0, skip for now */
1064 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1065 !(hub_is_superspeed(hdev))) {
1067 char portstr [USB_MAXCHILDREN + 1];
1069 for (i = 0; i < hdev->maxchild; i++)
1070 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1071 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1073 portstr[hdev->maxchild] = 0;
1074 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1076 dev_dbg(hub_dev, "standalone hub\n");
1078 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1079 case HUB_CHAR_COMMON_LPSM:
1080 dev_dbg(hub_dev, "ganged power switching\n");
1082 case HUB_CHAR_INDV_PORT_LPSM:
1083 dev_dbg(hub_dev, "individual port power switching\n");
1085 case HUB_CHAR_NO_LPSM:
1087 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1091 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1092 case HUB_CHAR_COMMON_OCPM:
1093 dev_dbg(hub_dev, "global over-current protection\n");
1095 case HUB_CHAR_INDV_PORT_OCPM:
1096 dev_dbg(hub_dev, "individual port over-current protection\n");
1098 case HUB_CHAR_NO_OCPM:
1100 dev_dbg(hub_dev, "no over-current protection\n");
1104 spin_lock_init (&hub->tt.lock);
1105 INIT_LIST_HEAD (&hub->tt.clear_list);
1106 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1107 switch (hdev->descriptor.bDeviceProtocol) {
1110 case USB_HUB_PR_HS_SINGLE_TT:
1111 dev_dbg(hub_dev, "Single TT\n");
1114 case USB_HUB_PR_HS_MULTI_TT:
1115 ret = usb_set_interface(hdev, 0, 1);
1117 dev_dbg(hub_dev, "TT per port\n");
1120 dev_err(hub_dev, "Using single TT (err %d)\n",
1125 /* USB 3.0 hubs don't have a TT */
1128 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1129 hdev->descriptor.bDeviceProtocol);
1133 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1134 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1135 case HUB_TTTT_8_BITS:
1136 if (hdev->descriptor.bDeviceProtocol != 0) {
1137 hub->tt.think_time = 666;
1138 dev_dbg(hub_dev, "TT requires at most %d "
1139 "FS bit times (%d ns)\n",
1140 8, hub->tt.think_time);
1143 case HUB_TTTT_16_BITS:
1144 hub->tt.think_time = 666 * 2;
1145 dev_dbg(hub_dev, "TT requires at most %d "
1146 "FS bit times (%d ns)\n",
1147 16, hub->tt.think_time);
1149 case HUB_TTTT_24_BITS:
1150 hub->tt.think_time = 666 * 3;
1151 dev_dbg(hub_dev, "TT requires at most %d "
1152 "FS bit times (%d ns)\n",
1153 24, hub->tt.think_time);
1155 case HUB_TTTT_32_BITS:
1156 hub->tt.think_time = 666 * 4;
1157 dev_dbg(hub_dev, "TT requires at most %d "
1158 "FS bit times (%d ns)\n",
1159 32, hub->tt.think_time);
1163 /* probe() zeroes hub->indicator[] */
1164 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1165 hub->has_indicators = 1;
1166 dev_dbg(hub_dev, "Port indicators are supported\n");
1169 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1170 hub->descriptor->bPwrOn2PwrGood * 2);
1172 /* power budgeting mostly matters with bus-powered hubs,
1173 * and battery-powered root hubs (may provide just 8 mA).
1175 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1177 message = "can't get hub status";
1180 le16_to_cpus(&hubstatus);
1181 if (hdev == hdev->bus->root_hub) {
1182 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
1183 hub->mA_per_port = 500;
1185 hub->mA_per_port = hdev->bus_mA;
1186 hub->limited_power = 1;
1188 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1189 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1190 hub->descriptor->bHubContrCurrent);
1191 hub->limited_power = 1;
1192 if (hdev->maxchild > 0) {
1193 int remaining = hdev->bus_mA -
1194 hub->descriptor->bHubContrCurrent;
1196 if (remaining < hdev->maxchild * 100)
1198 "insufficient power available "
1199 "to use all downstream ports\n");
1200 hub->mA_per_port = 100; /* 7.2.1.1 */
1202 } else { /* Self-powered external hub */
1203 /* FIXME: What about battery-powered external hubs that
1204 * provide less current per port? */
1205 hub->mA_per_port = 500;
1207 if (hub->mA_per_port < 500)
1208 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1211 /* Update the HCD's internal representation of this hub before khubd
1212 * starts getting port status changes for devices under the hub.
1214 hcd = bus_to_hcd(hdev->bus);
1215 if (hcd->driver->update_hub_device) {
1216 ret = hcd->driver->update_hub_device(hcd, hdev,
1217 &hub->tt, GFP_KERNEL);
1219 message = "can't update HCD hub info";
1224 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1226 message = "can't get hub status";
1230 /* local power status reports aren't always correct */
1231 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1232 dev_dbg(hub_dev, "local power source is %s\n",
1233 (hubstatus & HUB_STATUS_LOCAL_POWER)
1234 ? "lost (inactive)" : "good");
1236 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1237 dev_dbg(hub_dev, "%sover-current condition exists\n",
1238 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1240 /* set up the interrupt endpoint
1241 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1242 * bytes as USB2.0[11.12.3] says because some hubs are known
1243 * to send more data (and thus cause overflow). For root hubs,
1244 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1245 * to be big enough for at least USB_MAXCHILDREN ports. */
1246 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1247 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1249 if (maxp > sizeof(*hub->buffer))
1250 maxp = sizeof(*hub->buffer);
1252 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1258 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1259 hub, endpoint->bInterval);
1261 /* maybe cycle the hub leds */
1262 if (hub->has_indicators && blinkenlights)
1263 hub->indicator [0] = INDICATOR_CYCLE;
1265 hub_activate(hub, HUB_INIT);
1269 dev_err (hub_dev, "config failed, %s (err %d)\n",
1271 /* hub_disconnect() frees urb and descriptor */
1275 static void hub_release(struct kref *kref)
1277 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1279 usb_put_intf(to_usb_interface(hub->intfdev));
1283 static unsigned highspeed_hubs;
1285 static void hub_disconnect(struct usb_interface *intf)
1287 struct usb_hub *hub = usb_get_intfdata(intf);
1288 struct usb_device *hdev = interface_to_usbdev(intf);
1290 /* Take the hub off the event list and don't let it be added again */
1291 spin_lock_irq(&hub_event_lock);
1292 if (!list_empty(&hub->event_list)) {
1293 list_del_init(&hub->event_list);
1294 usb_autopm_put_interface_no_suspend(intf);
1296 hub->disconnected = 1;
1297 spin_unlock_irq(&hub_event_lock);
1299 /* Disconnect all children and quiesce the hub */
1301 hub_quiesce(hub, HUB_DISCONNECT);
1303 usb_set_intfdata (intf, NULL);
1304 hub->hdev->maxchild = 0;
1306 if (hub->hdev->speed == USB_SPEED_HIGH)
1309 usb_free_urb(hub->urb);
1310 kfree(hdev->children);
1311 kfree(hub->port_owners);
1312 kfree(hub->descriptor);
1316 kref_put(&hub->kref, hub_release);
1319 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1321 struct usb_host_interface *desc;
1322 struct usb_endpoint_descriptor *endpoint;
1323 struct usb_device *hdev;
1324 struct usb_hub *hub;
1326 desc = intf->cur_altsetting;
1327 hdev = interface_to_usbdev(intf);
1329 /* Hubs have proper suspend/resume support. */
1330 usb_enable_autosuspend(hdev);
1332 if (hdev->level == MAX_TOPO_LEVEL) {
1334 "Unsupported bus topology: hub nested too deep\n");
1338 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1340 dev_warn(&intf->dev, "ignoring external hub\n");
1345 /* Some hubs have a subclass of 1, which AFAICT according to the */
1346 /* specs is not defined, but it works */
1347 if ((desc->desc.bInterfaceSubClass != 0) &&
1348 (desc->desc.bInterfaceSubClass != 1)) {
1350 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1354 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1355 if (desc->desc.bNumEndpoints != 1)
1356 goto descriptor_error;
1358 endpoint = &desc->endpoint[0].desc;
1360 /* If it's not an interrupt in endpoint, we'd better punt! */
1361 if (!usb_endpoint_is_int_in(endpoint))
1362 goto descriptor_error;
1364 /* We found a hub */
1365 dev_info (&intf->dev, "USB hub found\n");
1367 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1369 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1373 kref_init(&hub->kref);
1374 INIT_LIST_HEAD(&hub->event_list);
1375 hub->intfdev = &intf->dev;
1377 INIT_DELAYED_WORK(&hub->leds, led_work);
1378 INIT_DELAYED_WORK(&hub->init_work, NULL);
1381 usb_set_intfdata (intf, hub);
1382 intf->needs_remote_wakeup = 1;
1384 if (hdev->speed == USB_SPEED_HIGH)
1387 if (hub_configure(hub, endpoint) >= 0)
1390 hub_disconnect (intf);
1395 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1397 struct usb_device *hdev = interface_to_usbdev (intf);
1399 /* assert ifno == 0 (part of hub spec) */
1401 case USBDEVFS_HUB_PORTINFO: {
1402 struct usbdevfs_hub_portinfo *info = user_data;
1405 spin_lock_irq(&device_state_lock);
1406 if (hdev->devnum <= 0)
1409 info->nports = hdev->maxchild;
1410 for (i = 0; i < info->nports; i++) {
1411 if (hdev->children[i] == NULL)
1415 hdev->children[i]->devnum;
1418 spin_unlock_irq(&device_state_lock);
1420 return info->nports + 1;
1429 * Allow user programs to claim ports on a hub. When a device is attached
1430 * to one of these "claimed" ports, the program will "own" the device.
1432 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1435 if (hdev->state == USB_STATE_NOTATTACHED)
1437 if (port1 == 0 || port1 > hdev->maxchild)
1440 /* This assumes that devices not managed by the hub driver
1441 * will always have maxchild equal to 0.
1443 *ppowner = &(hdev_to_hub(hdev)->port_owners[port1 - 1]);
1447 /* In the following three functions, the caller must hold hdev's lock */
1448 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1, void *owner)
1453 rc = find_port_owner(hdev, port1, &powner);
1462 int usb_hub_release_port(struct usb_device *hdev, unsigned port1, void *owner)
1467 rc = find_port_owner(hdev, port1, &powner);
1470 if (*powner != owner)
1476 void usb_hub_release_all_ports(struct usb_device *hdev, void *owner)
1481 n = find_port_owner(hdev, 1, &powner);
1483 for (; n < hdev->maxchild; (++n, ++powner)) {
1484 if (*powner == owner)
1490 /* The caller must hold udev's lock */
1491 bool usb_device_is_owned(struct usb_device *udev)
1493 struct usb_hub *hub;
1495 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1497 hub = hdev_to_hub(udev->parent);
1498 return !!hub->port_owners[udev->portnum - 1];
1502 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1506 for (i = 0; i < udev->maxchild; ++i) {
1507 if (udev->children[i])
1508 recursively_mark_NOTATTACHED(udev->children[i]);
1510 if (udev->state == USB_STATE_SUSPENDED)
1511 udev->active_duration -= jiffies;
1512 udev->state = USB_STATE_NOTATTACHED;
1516 * usb_set_device_state - change a device's current state (usbcore, hcds)
1517 * @udev: pointer to device whose state should be changed
1518 * @new_state: new state value to be stored
1520 * udev->state is _not_ fully protected by the device lock. Although
1521 * most transitions are made only while holding the lock, the state can
1522 * can change to USB_STATE_NOTATTACHED at almost any time. This
1523 * is so that devices can be marked as disconnected as soon as possible,
1524 * without having to wait for any semaphores to be released. As a result,
1525 * all changes to any device's state must be protected by the
1526 * device_state_lock spinlock.
1528 * Once a device has been added to the device tree, all changes to its state
1529 * should be made using this routine. The state should _not_ be set directly.
1531 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1532 * Otherwise udev->state is set to new_state, and if new_state is
1533 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1534 * to USB_STATE_NOTATTACHED.
1536 void usb_set_device_state(struct usb_device *udev,
1537 enum usb_device_state new_state)
1539 unsigned long flags;
1542 spin_lock_irqsave(&device_state_lock, flags);
1543 if (udev->state == USB_STATE_NOTATTACHED)
1545 else if (new_state != USB_STATE_NOTATTACHED) {
1547 /* root hub wakeup capabilities are managed out-of-band
1548 * and may involve silicon errata ... ignore them here.
1551 if (udev->state == USB_STATE_SUSPENDED
1552 || new_state == USB_STATE_SUSPENDED)
1553 ; /* No change to wakeup settings */
1554 else if (new_state == USB_STATE_CONFIGURED)
1555 wakeup = udev->actconfig->desc.bmAttributes
1556 & USB_CONFIG_ATT_WAKEUP;
1560 if (udev->state == USB_STATE_SUSPENDED &&
1561 new_state != USB_STATE_SUSPENDED)
1562 udev->active_duration -= jiffies;
1563 else if (new_state == USB_STATE_SUSPENDED &&
1564 udev->state != USB_STATE_SUSPENDED)
1565 udev->active_duration += jiffies;
1566 udev->state = new_state;
1568 recursively_mark_NOTATTACHED(udev);
1569 spin_unlock_irqrestore(&device_state_lock, flags);
1571 device_set_wakeup_capable(&udev->dev, wakeup);
1573 EXPORT_SYMBOL_GPL(usb_set_device_state);
1576 * Choose a device number.
1578 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1579 * USB-2.0 buses they are also used as device addresses, however on
1580 * USB-3.0 buses the address is assigned by the controller hardware
1581 * and it usually is not the same as the device number.
1583 * WUSB devices are simple: they have no hubs behind, so the mapping
1584 * device <-> virtual port number becomes 1:1. Why? to simplify the
1585 * life of the device connection logic in
1586 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1587 * handshake we need to assign a temporary address in the unauthorized
1588 * space. For simplicity we use the first virtual port number found to
1589 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1590 * and that becomes it's address [X < 128] or its unauthorized address
1593 * We add 1 as an offset to the one-based USB-stack port number
1594 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1595 * 0 is reserved by USB for default address; (b) Linux's USB stack
1596 * uses always #1 for the root hub of the controller. So USB stack's
1597 * port #1, which is wusb virtual-port #0 has address #2.
1599 * Devices connected under xHCI are not as simple. The host controller
1600 * supports virtualization, so the hardware assigns device addresses and
1601 * the HCD must setup data structures before issuing a set address
1602 * command to the hardware.
1604 static void choose_devnum(struct usb_device *udev)
1607 struct usb_bus *bus = udev->bus;
1609 /* If khubd ever becomes multithreaded, this will need a lock */
1611 devnum = udev->portnum + 1;
1612 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
1614 /* Try to allocate the next devnum beginning at
1615 * bus->devnum_next. */
1616 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1619 devnum = find_next_zero_bit(bus->devmap.devicemap,
1621 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1624 set_bit(devnum, bus->devmap.devicemap);
1625 udev->devnum = devnum;
1629 static void release_devnum(struct usb_device *udev)
1631 if (udev->devnum > 0) {
1632 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1637 static void update_devnum(struct usb_device *udev, int devnum)
1639 /* The address for a WUSB device is managed by wusbcore. */
1641 udev->devnum = devnum;
1644 static void hub_free_dev(struct usb_device *udev)
1646 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1648 /* Root hubs aren't real devices, so don't free HCD resources */
1649 if (hcd->driver->free_dev && udev->parent)
1650 hcd->driver->free_dev(hcd, udev);
1654 * usb_disconnect - disconnect a device (usbcore-internal)
1655 * @pdev: pointer to device being disconnected
1656 * Context: !in_interrupt ()
1658 * Something got disconnected. Get rid of it and all of its children.
1660 * If *pdev is a normal device then the parent hub must already be locked.
1661 * If *pdev is a root hub then this routine will acquire the
1662 * usb_bus_list_lock on behalf of the caller.
1664 * Only hub drivers (including virtual root hub drivers for host
1665 * controllers) should ever call this.
1667 * This call is synchronous, and may not be used in an interrupt context.
1669 void usb_disconnect(struct usb_device **pdev)
1671 struct usb_device *udev = *pdev;
1674 /* mark the device as inactive, so any further urb submissions for
1675 * this device (and any of its children) will fail immediately.
1676 * this quiesces everything except pending urbs.
1678 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1679 dev_info(&udev->dev, "USB disconnect, device number %d\n",
1682 usb_lock_device(udev);
1684 /* Free up all the children before we remove this device */
1685 for (i = 0; i < udev->maxchild; i++) {
1686 if (udev->children[i])
1687 usb_disconnect(&udev->children[i]);
1690 /* deallocate hcd/hardware state ... nuking all pending urbs and
1691 * cleaning up all state associated with the current configuration
1692 * so that the hardware is now fully quiesced.
1694 dev_dbg (&udev->dev, "unregistering device\n");
1695 usb_disable_device(udev, 0);
1696 usb_hcd_synchronize_unlinks(udev);
1698 usb_remove_ep_devs(&udev->ep0);
1699 usb_unlock_device(udev);
1701 /* Unregister the device. The device driver is responsible
1702 * for de-configuring the device and invoking the remove-device
1703 * notifier chain (used by usbfs and possibly others).
1705 device_del(&udev->dev);
1707 /* Free the device number and delete the parent's children[]
1708 * (or root_hub) pointer.
1710 release_devnum(udev);
1712 /* Avoid races with recursively_mark_NOTATTACHED() */
1713 spin_lock_irq(&device_state_lock);
1715 spin_unlock_irq(&device_state_lock);
1719 put_device(&udev->dev);
1722 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
1723 static void show_string(struct usb_device *udev, char *id, char *string)
1727 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1730 static void announce_device(struct usb_device *udev)
1732 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
1733 le16_to_cpu(udev->descriptor.idVendor),
1734 le16_to_cpu(udev->descriptor.idProduct));
1735 dev_info(&udev->dev,
1736 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
1737 udev->descriptor.iManufacturer,
1738 udev->descriptor.iProduct,
1739 udev->descriptor.iSerialNumber);
1740 show_string(udev, "Product", udev->product);
1741 show_string(udev, "Manufacturer", udev->manufacturer);
1742 show_string(udev, "SerialNumber", udev->serial);
1745 static inline void announce_device(struct usb_device *udev) { }
1748 #ifdef CONFIG_USB_OTG
1749 #include "otg_whitelist.h"
1753 * usb_enumerate_device_otg - FIXME (usbcore-internal)
1754 * @udev: newly addressed device (in ADDRESS state)
1756 * Finish enumeration for On-The-Go devices
1758 static int usb_enumerate_device_otg(struct usb_device *udev)
1762 #ifdef CONFIG_USB_OTG
1764 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1765 * to wake us after we've powered off VBUS; and HNP, switching roles
1766 * "host" to "peripheral". The OTG descriptor helps figure this out.
1768 if (!udev->bus->is_b_host
1770 && udev->parent == udev->bus->root_hub) {
1771 struct usb_otg_descriptor *desc = NULL;
1772 struct usb_bus *bus = udev->bus;
1774 /* descriptor may appear anywhere in config */
1775 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1776 le16_to_cpu(udev->config[0].desc.wTotalLength),
1777 USB_DT_OTG, (void **) &desc) == 0) {
1778 if (desc->bmAttributes & USB_OTG_HNP) {
1779 unsigned port1 = udev->portnum;
1781 dev_info(&udev->dev,
1782 "Dual-Role OTG device on %sHNP port\n",
1783 (port1 == bus->otg_port)
1786 /* enable HNP before suspend, it's simpler */
1787 if (port1 == bus->otg_port)
1788 bus->b_hnp_enable = 1;
1789 err = usb_control_msg(udev,
1790 usb_sndctrlpipe(udev, 0),
1791 USB_REQ_SET_FEATURE, 0,
1793 ? USB_DEVICE_B_HNP_ENABLE
1794 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1795 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1797 /* OTG MESSAGE: report errors here,
1798 * customize to match your product.
1800 dev_info(&udev->dev,
1801 "can't set HNP mode: %d\n",
1803 bus->b_hnp_enable = 0;
1809 if (!is_targeted(udev)) {
1811 /* Maybe it can talk to us, though we can't talk to it.
1812 * (Includes HNP test device.)
1814 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
1815 err = usb_port_suspend(udev, PMSG_SUSPEND);
1817 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1829 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
1830 * @udev: newly addressed device (in ADDRESS state)
1832 * This is only called by usb_new_device() and usb_authorize_device()
1833 * and FIXME -- all comments that apply to them apply here wrt to
1836 * If the device is WUSB and not authorized, we don't attempt to read
1837 * the string descriptors, as they will be errored out by the device
1838 * until it has been authorized.
1840 static int usb_enumerate_device(struct usb_device *udev)
1844 if (udev->config == NULL) {
1845 err = usb_get_configuration(udev);
1847 dev_err(&udev->dev, "can't read configurations, error %d\n",
1852 if (udev->wusb == 1 && udev->authorized == 0) {
1853 udev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1854 udev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1855 udev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1858 /* read the standard strings and cache them if present */
1859 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1860 udev->manufacturer = usb_cache_string(udev,
1861 udev->descriptor.iManufacturer);
1862 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
1864 err = usb_enumerate_device_otg(udev);
1869 static void set_usb_port_removable(struct usb_device *udev)
1871 struct usb_device *hdev = udev->parent;
1872 struct usb_hub *hub;
1873 u8 port = udev->portnum;
1874 u16 wHubCharacteristics;
1875 bool removable = true;
1880 hub = hdev_to_hub(udev->parent);
1882 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1884 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
1887 if (hub_is_superspeed(hdev)) {
1888 if (hub->descriptor->u.ss.DeviceRemovable & (1 << port))
1891 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
1896 udev->removable = USB_DEVICE_REMOVABLE;
1898 udev->removable = USB_DEVICE_FIXED;
1902 * usb_new_device - perform initial device setup (usbcore-internal)
1903 * @udev: newly addressed device (in ADDRESS state)
1905 * This is called with devices which have been detected but not fully
1906 * enumerated. The device descriptor is available, but not descriptors
1907 * for any device configuration. The caller must have locked either
1908 * the parent hub (if udev is a normal device) or else the
1909 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1910 * udev has already been installed, but udev is not yet visible through
1911 * sysfs or other filesystem code.
1913 * It will return if the device is configured properly or not. Zero if
1914 * the interface was registered with the driver core; else a negative
1917 * This call is synchronous, and may not be used in an interrupt context.
1919 * Only the hub driver or root-hub registrar should ever call this.
1921 int usb_new_device(struct usb_device *udev)
1926 /* Initialize non-root-hub device wakeup to disabled;
1927 * device (un)configuration controls wakeup capable
1928 * sysfs power/wakeup controls wakeup enabled/disabled
1930 device_init_wakeup(&udev->dev, 0);
1933 /* Tell the runtime-PM framework the device is active */
1934 pm_runtime_set_active(&udev->dev);
1935 pm_runtime_get_noresume(&udev->dev);
1936 pm_runtime_use_autosuspend(&udev->dev);
1937 pm_runtime_enable(&udev->dev);
1939 /* By default, forbid autosuspend for all devices. It will be
1940 * allowed for hubs during binding.
1942 usb_disable_autosuspend(udev);
1944 err = usb_enumerate_device(udev); /* Read descriptors */
1947 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
1948 udev->devnum, udev->bus->busnum,
1949 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1950 /* export the usbdev device-node for libusb */
1951 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
1952 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1954 /* Tell the world! */
1955 announce_device(udev);
1957 device_enable_async_suspend(&udev->dev);
1960 * check whether the hub marks this port as non-removable. Do it
1961 * now so that platform-specific data can override it in
1965 set_usb_port_removable(udev);
1967 /* Register the device. The device driver is responsible
1968 * for configuring the device and invoking the add-device
1969 * notifier chain (used by usbfs and possibly others).
1971 err = device_add(&udev->dev);
1973 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1977 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
1978 usb_mark_last_busy(udev);
1979 pm_runtime_put_sync_autosuspend(&udev->dev);
1983 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1984 pm_runtime_disable(&udev->dev);
1985 pm_runtime_set_suspended(&udev->dev);
1991 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
1992 * @usb_dev: USB device
1994 * Move the USB device to a very basic state where interfaces are disabled
1995 * and the device is in fact unconfigured and unusable.
1997 * We share a lock (that we have) with device_del(), so we need to
2000 int usb_deauthorize_device(struct usb_device *usb_dev)
2002 usb_lock_device(usb_dev);
2003 if (usb_dev->authorized == 0)
2004 goto out_unauthorized;
2006 usb_dev->authorized = 0;
2007 usb_set_configuration(usb_dev, -1);
2009 kfree(usb_dev->product);
2010 usb_dev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2011 kfree(usb_dev->manufacturer);
2012 usb_dev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2013 kfree(usb_dev->serial);
2014 usb_dev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2016 usb_destroy_configuration(usb_dev);
2017 usb_dev->descriptor.bNumConfigurations = 0;
2020 usb_unlock_device(usb_dev);
2025 int usb_authorize_device(struct usb_device *usb_dev)
2029 usb_lock_device(usb_dev);
2030 if (usb_dev->authorized == 1)
2031 goto out_authorized;
2033 result = usb_autoresume_device(usb_dev);
2035 dev_err(&usb_dev->dev,
2036 "can't autoresume for authorization: %d\n", result);
2037 goto error_autoresume;
2039 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2041 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2042 "authorization: %d\n", result);
2043 goto error_device_descriptor;
2046 kfree(usb_dev->product);
2047 usb_dev->product = NULL;
2048 kfree(usb_dev->manufacturer);
2049 usb_dev->manufacturer = NULL;
2050 kfree(usb_dev->serial);
2051 usb_dev->serial = NULL;
2053 usb_dev->authorized = 1;
2054 result = usb_enumerate_device(usb_dev);
2056 goto error_enumerate;
2057 /* Choose and set the configuration. This registers the interfaces
2058 * with the driver core and lets interface drivers bind to them.
2060 c = usb_choose_configuration(usb_dev);
2062 result = usb_set_configuration(usb_dev, c);
2064 dev_err(&usb_dev->dev,
2065 "can't set config #%d, error %d\n", c, result);
2066 /* This need not be fatal. The user can try to
2067 * set other configurations. */
2070 dev_info(&usb_dev->dev, "authorized to connect\n");
2073 error_device_descriptor:
2074 usb_autosuspend_device(usb_dev);
2077 usb_unlock_device(usb_dev); // complements locktree
2082 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2083 static unsigned hub_is_wusb(struct usb_hub *hub)
2085 struct usb_hcd *hcd;
2086 if (hub->hdev->parent != NULL) /* not a root hub? */
2088 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
2089 return hcd->wireless;
2093 #define PORT_RESET_TRIES 5
2094 #define SET_ADDRESS_TRIES 2
2095 #define GET_DESCRIPTOR_TRIES 2
2096 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2097 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2099 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2100 #define HUB_SHORT_RESET_TIME 10
2101 #define HUB_BH_RESET_TIME 50
2102 #define HUB_LONG_RESET_TIME 200
2103 #define HUB_RESET_TIMEOUT 500
2105 static int hub_port_reset(struct usb_hub *hub, int port1,
2106 struct usb_device *udev, unsigned int delay, bool warm);
2108 /* Is a USB 3.0 port in the Inactive or Complinance Mode state?
2109 * Port worm reset is required to recover
2111 static bool hub_port_warm_reset_required(struct usb_hub *hub, u16 portstatus)
2113 return hub_is_superspeed(hub->hdev) &&
2114 (((portstatus & USB_PORT_STAT_LINK_STATE) ==
2115 USB_SS_PORT_LS_SS_INACTIVE) ||
2116 ((portstatus & USB_PORT_STAT_LINK_STATE) ==
2117 USB_SS_PORT_LS_COMP_MOD)) ;
2120 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2121 struct usb_device *udev, unsigned int delay, bool warm)
2123 int delay_time, ret;
2127 for (delay_time = 0;
2128 delay_time < HUB_RESET_TIMEOUT;
2129 delay_time += delay) {
2130 /* wait to give the device a chance to reset */
2133 /* read and decode port status */
2134 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2139 * Some buggy devices require a warm reset to be issued even
2140 * when the port appears not to be connected.
2144 * Some buggy devices can cause an NEC host controller
2145 * to transition to the "Error" state after a hot port
2146 * reset. This will show up as the port state in
2147 * "Inactive", and the port may also report a
2148 * disconnect. Forcing a warm port reset seems to make
2151 * See https://bugzilla.kernel.org/show_bug.cgi?id=41752
2153 if (hub_port_warm_reset_required(hub, portstatus)) {
2156 if ((portchange & USB_PORT_STAT_C_CONNECTION))
2157 clear_port_feature(hub->hdev, port1,
2158 USB_PORT_FEAT_C_CONNECTION);
2159 if (portchange & USB_PORT_STAT_C_LINK_STATE)
2160 clear_port_feature(hub->hdev, port1,
2161 USB_PORT_FEAT_C_PORT_LINK_STATE);
2162 if (portchange & USB_PORT_STAT_C_RESET)
2163 clear_port_feature(hub->hdev, port1,
2164 USB_PORT_FEAT_C_RESET);
2165 dev_dbg(hub->intfdev, "hot reset failed, warm reset port %d\n",
2167 ret = hub_port_reset(hub, port1,
2168 udev, HUB_BH_RESET_TIME,
2170 if ((portchange & USB_PORT_STAT_C_CONNECTION))
2171 clear_port_feature(hub->hdev, port1,
2172 USB_PORT_FEAT_C_CONNECTION);
2175 /* Device went away? */
2176 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2179 /* bomb out completely if the connection bounced */
2180 if ((portchange & USB_PORT_STAT_C_CONNECTION))
2183 /* if we`ve finished resetting, then break out of
2186 if (!(portstatus & USB_PORT_STAT_RESET) &&
2187 (portstatus & USB_PORT_STAT_ENABLE)) {
2188 if (hub_is_wusb(hub))
2189 udev->speed = USB_SPEED_WIRELESS;
2190 else if (hub_is_superspeed(hub->hdev))
2191 udev->speed = USB_SPEED_SUPER;
2192 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2193 udev->speed = USB_SPEED_HIGH;
2194 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2195 udev->speed = USB_SPEED_LOW;
2197 udev->speed = USB_SPEED_FULL;
2201 if (portchange & USB_PORT_STAT_C_BH_RESET)
2205 /* switch to the long delay after two short delay failures */
2206 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2207 delay = HUB_LONG_RESET_TIME;
2209 dev_dbg (hub->intfdev,
2210 "port %d not %sreset yet, waiting %dms\n",
2211 port1, warm ? "warm " : "", delay);
2217 static void hub_port_finish_reset(struct usb_hub *hub, int port1,
2218 struct usb_device *udev, int *status, bool warm)
2223 struct usb_hcd *hcd;
2224 /* TRSTRCY = 10 ms; plus some extra */
2226 update_devnum(udev, 0);
2227 hcd = bus_to_hcd(udev->bus);
2228 if (hcd->driver->reset_device) {
2229 *status = hcd->driver->reset_device(hcd, udev);
2231 dev_err(&udev->dev, "Cannot reset "
2232 "HCD device state\n");
2240 clear_port_feature(hub->hdev,
2241 port1, USB_PORT_FEAT_C_RESET);
2242 /* FIXME need disconnect() for NOTATTACHED device */
2244 clear_port_feature(hub->hdev, port1,
2245 USB_PORT_FEAT_C_BH_PORT_RESET);
2246 clear_port_feature(hub->hdev, port1,
2247 USB_PORT_FEAT_C_PORT_LINK_STATE);
2249 usb_set_device_state(udev, *status
2250 ? USB_STATE_NOTATTACHED
2251 : USB_STATE_DEFAULT);
2257 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2258 static int hub_port_reset(struct usb_hub *hub, int port1,
2259 struct usb_device *udev, unsigned int delay, bool warm)
2264 /* Block EHCI CF initialization during the port reset.
2265 * Some companion controllers don't like it when they mix.
2267 down_read(&ehci_cf_port_reset_rwsem);
2269 if (!hub_is_superspeed(hub->hdev)) {
2270 dev_err(hub->intfdev, "only USB3 hub support "
2276 /* Reset the port */
2277 for (i = 0; i < PORT_RESET_TRIES; i++) {
2278 status = set_port_feature(hub->hdev, port1, (warm ?
2279 USB_PORT_FEAT_BH_PORT_RESET :
2280 USB_PORT_FEAT_RESET));
2282 dev_err(hub->intfdev,
2283 "cannot %sreset port %d (err = %d)\n",
2284 warm ? "warm " : "", port1, status);
2286 status = hub_port_wait_reset(hub, port1, udev, delay,
2288 if (status && status != -ENOTCONN)
2289 dev_dbg(hub->intfdev,
2290 "port_wait_reset: err = %d\n",
2294 /* return on disconnect or reset */
2295 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2296 hub_port_finish_reset(hub, port1, udev, &status, warm);
2300 dev_dbg (hub->intfdev,
2301 "port %d not enabled, trying %sreset again...\n",
2302 port1, warm ? "warm " : "");
2303 delay = HUB_LONG_RESET_TIME;
2306 dev_err (hub->intfdev,
2307 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2312 up_read(&ehci_cf_port_reset_rwsem);
2317 /* Check if a port is power on */
2318 static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2322 if (hub_is_superspeed(hub->hdev)) {
2323 if (portstatus & USB_SS_PORT_STAT_POWER)
2326 if (portstatus & USB_PORT_STAT_POWER)
2335 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2336 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
2340 if (hub_is_superspeed(hub->hdev)) {
2341 if ((portstatus & USB_PORT_STAT_LINK_STATE)
2342 == USB_SS_PORT_LS_U3)
2345 if (portstatus & USB_PORT_STAT_SUSPEND)
2352 /* Determine whether the device on a port is ready for a normal resume,
2353 * is ready for a reset-resume, or should be disconnected.
2355 static int check_port_resume_type(struct usb_device *udev,
2356 struct usb_hub *hub, int port1,
2357 int status, unsigned portchange, unsigned portstatus)
2359 /* Is the device still present? */
2360 if (status || port_is_suspended(hub, portstatus) ||
2361 !port_is_power_on(hub, portstatus) ||
2362 !(portstatus & USB_PORT_STAT_CONNECTION)) {
2367 /* Can't do a normal resume if the port isn't enabled,
2368 * so try a reset-resume instead.
2370 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2371 if (udev->persist_enabled)
2372 udev->reset_resume = 1;
2378 dev_dbg(hub->intfdev,
2379 "port %d status %04x.%04x after resume, %d\n",
2380 port1, portchange, portstatus, status);
2381 } else if (udev->reset_resume) {
2383 /* Late port handoff can set status-change bits */
2384 if (portchange & USB_PORT_STAT_C_CONNECTION)
2385 clear_port_feature(hub->hdev, port1,
2386 USB_PORT_FEAT_C_CONNECTION);
2387 if (portchange & USB_PORT_STAT_C_ENABLE)
2388 clear_port_feature(hub->hdev, port1,
2389 USB_PORT_FEAT_C_ENABLE);
2395 #ifdef CONFIG_USB_SUSPEND
2398 * usb_port_suspend - suspend a usb device's upstream port
2399 * @udev: device that's no longer in active use, not a root hub
2400 * Context: must be able to sleep; device not locked; pm locks held
2402 * Suspends a USB device that isn't in active use, conserving power.
2403 * Devices may wake out of a suspend, if anything important happens,
2404 * using the remote wakeup mechanism. They may also be taken out of
2405 * suspend by the host, using usb_port_resume(). It's also routine
2406 * to disconnect devices while they are suspended.
2408 * This only affects the USB hardware for a device; its interfaces
2409 * (and, for hubs, child devices) must already have been suspended.
2411 * Selective port suspend reduces power; most suspended devices draw
2412 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2413 * All devices below the suspended port are also suspended.
2415 * Devices leave suspend state when the host wakes them up. Some devices
2416 * also support "remote wakeup", where the device can activate the USB
2417 * tree above them to deliver data, such as a keypress or packet. In
2418 * some cases, this wakes the USB host.
2420 * Suspending OTG devices may trigger HNP, if that's been enabled
2421 * between a pair of dual-role devices. That will change roles, such
2422 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2424 * Devices on USB hub ports have only one "suspend" state, corresponding
2425 * to ACPI D2, "may cause the device to lose some context".
2426 * State transitions include:
2428 * - suspend, resume ... when the VBUS power link stays live
2429 * - suspend, disconnect ... VBUS lost
2431 * Once VBUS drop breaks the circuit, the port it's using has to go through
2432 * normal re-enumeration procedures, starting with enabling VBUS power.
2433 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2434 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2435 * timer, no SRP, no requests through sysfs.
2437 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
2438 * the root hub for their bus goes into global suspend ... so we don't
2439 * (falsely) update the device power state to say it suspended.
2441 * Returns 0 on success, else negative errno.
2443 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2445 struct usb_hub *hub = hdev_to_hub(udev->parent);
2446 int port1 = udev->portnum;
2449 /* enable remote wakeup when appropriate; this lets the device
2450 * wake up the upstream hub (including maybe the root hub).
2452 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2453 * we don't explicitly enable it here.
2455 if (udev->do_remote_wakeup) {
2456 if (!hub_is_superspeed(hub->hdev)) {
2457 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2458 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2459 USB_DEVICE_REMOTE_WAKEUP, 0,
2461 USB_CTRL_SET_TIMEOUT);
2463 /* Assume there's only one function on the USB 3.0
2464 * device and enable remote wake for the first
2465 * interface. FIXME if the interface association
2466 * descriptor shows there's more than one function.
2468 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2469 USB_REQ_SET_FEATURE,
2470 USB_RECIP_INTERFACE,
2471 USB_INTRF_FUNC_SUSPEND,
2472 USB_INTRF_FUNC_SUSPEND_RW |
2473 USB_INTRF_FUNC_SUSPEND_LP,
2475 USB_CTRL_SET_TIMEOUT);
2478 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
2480 /* bail if autosuspend is requested */
2481 if (PMSG_IS_AUTO(msg))
2486 /* disable USB2 hardware LPM */
2487 if (udev->usb2_hw_lpm_enabled == 1)
2488 usb_set_usb2_hardware_lpm(udev, 0);
2491 if (hub_is_superspeed(hub->hdev))
2492 status = set_port_feature(hub->hdev,
2493 port1 | (USB_SS_PORT_LS_U3 << 3),
2494 USB_PORT_FEAT_LINK_STATE);
2496 status = set_port_feature(hub->hdev, port1,
2497 USB_PORT_FEAT_SUSPEND);
2499 dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
2501 /* paranoia: "should not happen" */
2502 if (udev->do_remote_wakeup)
2503 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2504 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2505 USB_DEVICE_REMOTE_WAKEUP, 0,
2507 USB_CTRL_SET_TIMEOUT);
2509 /* Try to enable USB2 hardware LPM again */
2510 if (udev->usb2_hw_lpm_capable == 1)
2511 usb_set_usb2_hardware_lpm(udev, 1);
2513 /* System sleep transitions should never fail */
2514 if (!PMSG_IS_AUTO(msg))
2517 /* device has up to 10 msec to fully suspend */
2518 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
2519 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
2520 udev->do_remote_wakeup);
2521 usb_set_device_state(udev, USB_STATE_SUSPENDED);
2524 usb_mark_last_busy(hub->hdev);
2529 * If the USB "suspend" state is in use (rather than "global suspend"),
2530 * many devices will be individually taken out of suspend state using
2531 * special "resume" signaling. This routine kicks in shortly after
2532 * hardware resume signaling is finished, either because of selective
2533 * resume (by host) or remote wakeup (by device) ... now see what changed
2534 * in the tree that's rooted at this device.
2536 * If @udev->reset_resume is set then the device is reset before the
2537 * status check is done.
2539 static int finish_port_resume(struct usb_device *udev)
2544 /* caller owns the udev device lock */
2545 dev_dbg(&udev->dev, "%s\n",
2546 udev->reset_resume ? "finish reset-resume" : "finish resume");
2548 /* usb ch9 identifies four variants of SUSPENDED, based on what
2549 * state the device resumes to. Linux currently won't see the
2550 * first two on the host side; they'd be inside hub_port_init()
2551 * during many timeouts, but khubd can't suspend until later.
2553 usb_set_device_state(udev, udev->actconfig
2554 ? USB_STATE_CONFIGURED
2555 : USB_STATE_ADDRESS);
2557 /* 10.5.4.5 says not to reset a suspended port if the attached
2558 * device is enabled for remote wakeup. Hence the reset
2559 * operation is carried out here, after the port has been
2562 if (udev->reset_resume)
2564 status = usb_reset_and_verify_device(udev);
2566 /* 10.5.4.5 says be sure devices in the tree are still there.
2567 * For now let's assume the device didn't go crazy on resume,
2568 * and device drivers will know about any resume quirks.
2572 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
2574 status = (status > 0 ? 0 : -ENODEV);
2576 /* If a normal resume failed, try doing a reset-resume */
2577 if (status && !udev->reset_resume && udev->persist_enabled) {
2578 dev_dbg(&udev->dev, "retry with reset-resume\n");
2579 udev->reset_resume = 1;
2580 goto retry_reset_resume;
2585 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
2587 } else if (udev->actconfig) {
2588 le16_to_cpus(&devstatus);
2589 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) {
2590 status = usb_control_msg(udev,
2591 usb_sndctrlpipe(udev, 0),
2592 USB_REQ_CLEAR_FEATURE,
2594 USB_DEVICE_REMOTE_WAKEUP, 0,
2596 USB_CTRL_SET_TIMEOUT);
2599 "disable remote wakeup, status %d\n",
2608 * usb_port_resume - re-activate a suspended usb device's upstream port
2609 * @udev: device to re-activate, not a root hub
2610 * Context: must be able to sleep; device not locked; pm locks held
2612 * This will re-activate the suspended device, increasing power usage
2613 * while letting drivers communicate again with its endpoints.
2614 * USB resume explicitly guarantees that the power session between
2615 * the host and the device is the same as it was when the device
2618 * If @udev->reset_resume is set then this routine won't check that the
2619 * port is still enabled. Furthermore, finish_port_resume() above will
2620 * reset @udev. The end result is that a broken power session can be
2621 * recovered and @udev will appear to persist across a loss of VBUS power.
2623 * For example, if a host controller doesn't maintain VBUS suspend current
2624 * during a system sleep or is reset when the system wakes up, all the USB
2625 * power sessions below it will be broken. This is especially troublesome
2626 * for mass-storage devices containing mounted filesystems, since the
2627 * device will appear to have disconnected and all the memory mappings
2628 * to it will be lost. Using the USB_PERSIST facility, the device can be
2629 * made to appear as if it had not disconnected.
2631 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
2632 * every effort to insure that the same device is present after the
2633 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
2634 * quite possible for a device to remain unaltered but its media to be
2635 * changed. If the user replaces a flash memory card while the system is
2636 * asleep, he will have only himself to blame when the filesystem on the
2637 * new card is corrupted and the system crashes.
2639 * Returns 0 on success, else negative errno.
2641 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
2643 struct usb_hub *hub = hdev_to_hub(udev->parent);
2644 int port1 = udev->portnum;
2646 u16 portchange, portstatus;
2648 /* Skip the initial Clear-Suspend step for a remote wakeup */
2649 status = hub_port_status(hub, port1, &portstatus, &portchange);
2650 if (status == 0 && !port_is_suspended(hub, portstatus))
2651 goto SuspendCleared;
2653 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
2655 set_bit(port1, hub->busy_bits);
2657 /* see 7.1.7.7; affects power usage, but not budgeting */
2658 if (hub_is_superspeed(hub->hdev))
2659 status = set_port_feature(hub->hdev,
2660 port1 | (USB_SS_PORT_LS_U0 << 3),
2661 USB_PORT_FEAT_LINK_STATE);
2663 status = clear_port_feature(hub->hdev,
2664 port1, USB_PORT_FEAT_SUSPEND);
2666 dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
2669 /* drive resume for at least 20 msec */
2670 dev_dbg(&udev->dev, "usb %sresume\n",
2671 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
2674 /* Virtual root hubs can trigger on GET_PORT_STATUS to
2675 * stop resume signaling. Then finish the resume
2678 status = hub_port_status(hub, port1, &portstatus, &portchange);
2680 /* TRSMRCY = 10 msec */
2686 if (hub_is_superspeed(hub->hdev)) {
2687 if (portchange & USB_PORT_STAT_C_LINK_STATE)
2688 clear_port_feature(hub->hdev, port1,
2689 USB_PORT_FEAT_C_PORT_LINK_STATE);
2691 if (portchange & USB_PORT_STAT_C_SUSPEND)
2692 clear_port_feature(hub->hdev, port1,
2693 USB_PORT_FEAT_C_SUSPEND);
2697 clear_bit(port1, hub->busy_bits);
2699 status = check_port_resume_type(udev,
2700 hub, port1, status, portchange, portstatus);
2702 status = finish_port_resume(udev);
2704 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2705 hub_port_logical_disconnect(hub, port1);
2707 /* Try to enable USB2 hardware LPM */
2708 if (udev->usb2_hw_lpm_capable == 1)
2709 usb_set_usb2_hardware_lpm(udev, 1);
2715 /* caller has locked udev */
2716 int usb_remote_wakeup(struct usb_device *udev)
2720 if (udev->state == USB_STATE_SUSPENDED) {
2721 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
2722 status = usb_autoresume_device(udev);
2724 /* Let the drivers do their thing, then... */
2725 usb_autosuspend_device(udev);
2731 #else /* CONFIG_USB_SUSPEND */
2733 /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
2735 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2740 /* However we may need to do a reset-resume */
2742 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
2744 struct usb_hub *hub = hdev_to_hub(udev->parent);
2745 int port1 = udev->portnum;
2747 u16 portchange, portstatus;
2749 status = hub_port_status(hub, port1, &portstatus, &portchange);
2750 status = check_port_resume_type(udev,
2751 hub, port1, status, portchange, portstatus);
2754 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2755 hub_port_logical_disconnect(hub, port1);
2756 } else if (udev->reset_resume) {
2757 dev_dbg(&udev->dev, "reset-resume\n");
2758 status = usb_reset_and_verify_device(udev);
2765 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
2767 struct usb_hub *hub = usb_get_intfdata (intf);
2768 struct usb_device *hdev = hub->hdev;
2772 /* Warn if children aren't already suspended */
2773 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
2774 struct usb_device *udev;
2776 udev = hdev->children [port1-1];
2777 if (udev && udev->can_submit) {
2778 dev_warn(&intf->dev, "port %d nyet suspended\n", port1);
2779 if (PMSG_IS_AUTO(msg))
2783 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
2784 /* Enable hub to send remote wakeup for all ports. */
2785 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
2786 status = set_port_feature(hdev,
2788 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
2789 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
2790 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
2791 USB_PORT_FEAT_REMOTE_WAKE_MASK);
2795 dev_dbg(&intf->dev, "%s\n", __func__);
2797 /* stop khubd and related activity */
2798 hub_quiesce(hub, HUB_SUSPEND);
2802 static int hub_resume(struct usb_interface *intf)
2804 struct usb_hub *hub = usb_get_intfdata(intf);
2806 dev_dbg(&intf->dev, "%s\n", __func__);
2807 hub_activate(hub, HUB_RESUME);
2811 static int hub_reset_resume(struct usb_interface *intf)
2813 struct usb_hub *hub = usb_get_intfdata(intf);
2815 dev_dbg(&intf->dev, "%s\n", __func__);
2816 hub_activate(hub, HUB_RESET_RESUME);
2821 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
2822 * @rhdev: struct usb_device for the root hub
2824 * The USB host controller driver calls this function when its root hub
2825 * is resumed and Vbus power has been interrupted or the controller
2826 * has been reset. The routine marks @rhdev as having lost power.
2827 * When the hub driver is resumed it will take notice and carry out
2828 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
2829 * the others will be disconnected.
2831 void usb_root_hub_lost_power(struct usb_device *rhdev)
2833 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
2834 rhdev->reset_resume = 1;
2836 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
2838 #else /* CONFIG_PM */
2840 #define hub_suspend NULL
2841 #define hub_resume NULL
2842 #define hub_reset_resume NULL
2846 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2848 * Between connect detection and reset signaling there must be a delay
2849 * of 100ms at least for debounce and power-settling. The corresponding
2850 * timer shall restart whenever the downstream port detects a disconnect.
2852 * Apparently there are some bluetooth and irda-dongles and a number of
2853 * low-speed devices for which this debounce period may last over a second.
2854 * Not covered by the spec - but easy to deal with.
2856 * This implementation uses a 1500ms total debounce timeout; if the
2857 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2858 * every 25ms for transient disconnects. When the port status has been
2859 * unchanged for 100ms it returns the port status.
2861 static int hub_port_debounce(struct usb_hub *hub, int port1)
2864 int total_time, stable_time = 0;
2865 u16 portchange, portstatus;
2866 unsigned connection = 0xffff;
2868 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2869 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2873 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2874 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2875 stable_time += HUB_DEBOUNCE_STEP;
2876 if (stable_time >= HUB_DEBOUNCE_STABLE)
2880 connection = portstatus & USB_PORT_STAT_CONNECTION;
2883 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2884 clear_port_feature(hub->hdev, port1,
2885 USB_PORT_FEAT_C_CONNECTION);
2888 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2890 msleep(HUB_DEBOUNCE_STEP);
2893 dev_dbg (hub->intfdev,
2894 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2895 port1, total_time, stable_time, portstatus);
2897 if (stable_time < HUB_DEBOUNCE_STABLE)
2902 void usb_ep0_reinit(struct usb_device *udev)
2904 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
2905 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
2906 usb_enable_endpoint(udev, &udev->ep0, true);
2908 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
2910 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2911 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2913 static int hub_set_address(struct usb_device *udev, int devnum)
2916 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2919 * The host controller will choose the device address,
2920 * instead of the core having chosen it earlier
2922 if (!hcd->driver->address_device && devnum <= 1)
2924 if (udev->state == USB_STATE_ADDRESS)
2926 if (udev->state != USB_STATE_DEFAULT)
2928 if (hcd->driver->address_device)
2929 retval = hcd->driver->address_device(hcd, udev);
2931 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2932 USB_REQ_SET_ADDRESS, 0, devnum, 0,
2933 NULL, 0, USB_CTRL_SET_TIMEOUT);
2935 update_devnum(udev, devnum);
2936 /* Device now using proper address. */
2937 usb_set_device_state(udev, USB_STATE_ADDRESS);
2938 usb_ep0_reinit(udev);
2943 /* Reset device, (re)assign address, get device descriptor.
2944 * Device connection must be stable, no more debouncing needed.
2945 * Returns device in USB_STATE_ADDRESS, except on error.
2947 * If this is called for an already-existing device (as part of
2948 * usb_reset_and_verify_device), the caller must own the device lock. For a
2949 * newly detected device that is not accessible through any global
2950 * pointers, it's not necessary to lock the device.
2953 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2956 static DEFINE_MUTEX(usb_address0_mutex);
2958 struct usb_device *hdev = hub->hdev;
2959 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
2961 unsigned delay = HUB_SHORT_RESET_TIME;
2962 enum usb_device_speed oldspeed = udev->speed;
2964 int devnum = udev->devnum;
2966 /* root hub ports have a slightly longer reset period
2967 * (from USB 2.0 spec, section 7.1.7.5)
2969 if (!hdev->parent) {
2970 delay = HUB_ROOT_RESET_TIME;
2971 if (port1 == hdev->bus->otg_port)
2972 hdev->bus->b_hnp_enable = 0;
2975 /* Some low speed devices have problems with the quick delay, so */
2976 /* be a bit pessimistic with those devices. RHbug #23670 */
2977 if (oldspeed == USB_SPEED_LOW)
2978 delay = HUB_LONG_RESET_TIME;
2980 mutex_lock(&usb_address0_mutex);
2982 /* Reset the device; full speed may morph to high speed */
2983 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
2984 retval = hub_port_reset(hub, port1, udev, delay, false);
2985 if (retval < 0) /* error or disconnect */
2987 /* success, speed is known */
2991 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2992 dev_dbg(&udev->dev, "device reset changed speed!\n");
2995 oldspeed = udev->speed;
2997 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2998 * it's fixed size except for full speed devices.
2999 * For Wireless USB devices, ep0 max packet is always 512 (tho
3000 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
3002 switch (udev->speed) {
3003 case USB_SPEED_SUPER:
3004 case USB_SPEED_WIRELESS: /* fixed at 512 */
3005 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
3007 case USB_SPEED_HIGH: /* fixed at 64 */
3008 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
3010 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
3011 /* to determine the ep0 maxpacket size, try to read
3012 * the device descriptor to get bMaxPacketSize0 and
3013 * then correct our initial guess.
3015 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
3017 case USB_SPEED_LOW: /* fixed at 8 */
3018 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
3024 if (udev->speed == USB_SPEED_WIRELESS)
3025 speed = "variable speed Wireless";
3027 speed = usb_speed_string(udev->speed);
3029 if (udev->speed != USB_SPEED_SUPER)
3030 dev_info(&udev->dev,
3031 "%s %s USB device number %d using %s\n",
3032 (udev->config) ? "reset" : "new", speed,
3033 devnum, udev->bus->controller->driver->name);
3035 /* Set up TT records, if needed */
3037 udev->tt = hdev->tt;
3038 udev->ttport = hdev->ttport;
3039 } else if (udev->speed != USB_SPEED_HIGH
3040 && hdev->speed == USB_SPEED_HIGH) {
3042 dev_err(&udev->dev, "parent hub has no TT\n");
3046 udev->tt = &hub->tt;
3047 udev->ttport = port1;
3050 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
3051 * Because device hardware and firmware is sometimes buggy in
3052 * this area, and this is how Linux has done it for ages.
3053 * Change it cautiously.
3055 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
3056 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
3057 * so it may help with some non-standards-compliant devices.
3058 * Otherwise we start with SET_ADDRESS and then try to read the
3059 * first 8 bytes of the device descriptor to get the ep0 maxpacket
3062 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
3063 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3)) {
3064 struct usb_device_descriptor *buf;
3067 #define GET_DESCRIPTOR_BUFSIZE 64
3068 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
3074 /* Retry on all errors; some devices are flakey.
3075 * 255 is for WUSB devices, we actually need to use
3076 * 512 (WUSB1.0[4.8.1]).
3078 for (j = 0; j < 3; ++j) {
3079 buf->bMaxPacketSize0 = 0;
3080 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
3081 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
3082 USB_DT_DEVICE << 8, 0,
3083 buf, GET_DESCRIPTOR_BUFSIZE,
3084 initial_descriptor_timeout);
3085 switch (buf->bMaxPacketSize0) {
3086 case 8: case 16: case 32: case 64: case 255:
3087 if (buf->bDescriptorType ==
3101 udev->descriptor.bMaxPacketSize0 =
3102 buf->bMaxPacketSize0;
3105 retval = hub_port_reset(hub, port1, udev, delay, false);
3106 if (retval < 0) /* error or disconnect */
3108 if (oldspeed != udev->speed) {
3110 "device reset changed speed!\n");
3116 "device descriptor read/64, error %d\n",
3121 #undef GET_DESCRIPTOR_BUFSIZE
3125 * If device is WUSB, we already assigned an
3126 * unauthorized address in the Connect Ack sequence;
3127 * authorization will assign the final address.
3129 if (udev->wusb == 0) {
3130 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
3131 retval = hub_set_address(udev, devnum);
3138 "device not accepting address %d, error %d\n",
3142 if (udev->speed == USB_SPEED_SUPER) {
3143 devnum = udev->devnum;
3144 dev_info(&udev->dev,
3145 "%s SuperSpeed USB device number %d using %s\n",
3146 (udev->config) ? "reset" : "new",
3147 devnum, udev->bus->controller->driver->name);
3150 /* cope with hardware quirkiness:
3151 * - let SET_ADDRESS settle, some device hardware wants it
3152 * - read ep0 maxpacket even for high and low speed,
3155 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3))
3159 retval = usb_get_device_descriptor(udev, 8);
3162 "device descriptor read/8, error %d\n",
3175 * Some superspeed devices have finished the link training process
3176 * and attached to a superspeed hub port, but the device descriptor
3177 * got from those devices show they aren't superspeed devices. Warm
3178 * reset the port attached by the devices can fix them.
3180 if ((udev->speed == USB_SPEED_SUPER) &&
3181 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
3182 dev_err(&udev->dev, "got a wrong device descriptor, "
3183 "warm reset device\n");
3184 hub_port_reset(hub, port1, udev,
3185 HUB_BH_RESET_TIME, true);
3190 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
3191 udev->speed == USB_SPEED_SUPER)
3194 i = udev->descriptor.bMaxPacketSize0;
3195 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
3196 if (udev->speed == USB_SPEED_LOW ||
3197 !(i == 8 || i == 16 || i == 32 || i == 64)) {
3198 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
3202 if (udev->speed == USB_SPEED_FULL)
3203 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
3205 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
3206 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
3207 usb_ep0_reinit(udev);
3210 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
3211 if (retval < (signed)sizeof(udev->descriptor)) {
3212 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
3219 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
3220 retval = usb_get_bos_descriptor(udev);
3222 if (udev->bos->ext_cap && (USB_LPM_SUPPORT &
3223 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
3224 udev->lpm_capable = 1;
3229 /* notify HCD that we have a device connected and addressed */
3230 if (hcd->driver->update_device)
3231 hcd->driver->update_device(hcd, udev);
3234 hub_port_disable(hub, port1, 0);
3235 update_devnum(udev, devnum); /* for disconnect processing */
3237 mutex_unlock(&usb_address0_mutex);
3242 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
3244 struct usb_qualifier_descriptor *qual;
3247 qual = kmalloc (sizeof *qual, GFP_KERNEL);
3251 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
3252 qual, sizeof *qual);
3253 if (status == sizeof *qual) {
3254 dev_info(&udev->dev, "not running at top speed; "
3255 "connect to a high speed hub\n");
3256 /* hub LEDs are probably harder to miss than syslog */
3257 if (hub->has_indicators) {
3258 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
3259 schedule_delayed_work (&hub->leds, 0);
3266 hub_power_remaining (struct usb_hub *hub)
3268 struct usb_device *hdev = hub->hdev;
3272 if (!hub->limited_power)
3275 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
3276 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
3277 struct usb_device *udev = hdev->children[port1 - 1];
3283 /* Unconfigured devices may not use more than 100mA,
3284 * or 8mA for OTG ports */
3285 if (udev->actconfig)
3286 delta = udev->actconfig->desc.bMaxPower * 2;
3287 else if (port1 != udev->bus->otg_port || hdev->parent)
3291 if (delta > hub->mA_per_port)
3292 dev_warn(&udev->dev,
3293 "%dmA is over %umA budget for port %d!\n",
3294 delta, hub->mA_per_port, port1);
3297 if (remaining < 0) {
3298 dev_warn(hub->intfdev, "%dmA over power budget!\n",
3305 /* Handle physical or logical connection change events.
3306 * This routine is called when:
3307 * a port connection-change occurs;
3308 * a port enable-change occurs (often caused by EMI);
3309 * usb_reset_and_verify_device() encounters changed descriptors (as from
3310 * a firmware download)
3311 * caller already locked the hub
3313 static void hub_port_connect_change(struct usb_hub *hub, int port1,
3314 u16 portstatus, u16 portchange)
3316 struct usb_device *hdev = hub->hdev;
3317 struct device *hub_dev = hub->intfdev;
3318 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
3319 unsigned wHubCharacteristics =
3320 le16_to_cpu(hub->descriptor->wHubCharacteristics);
3321 struct usb_device *udev;
3325 "port %d, status %04x, change %04x, %s\n",
3326 port1, portstatus, portchange, portspeed(hub, portstatus));
3328 if (hub->has_indicators) {
3329 set_port_led(hub, port1, HUB_LED_AUTO);
3330 hub->indicator[port1-1] = INDICATOR_AUTO;
3333 #ifdef CONFIG_USB_OTG
3334 /* during HNP, don't repeat the debounce */
3335 if (hdev->bus->is_b_host)
3336 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
3337 USB_PORT_STAT_C_ENABLE);
3340 /* Try to resuscitate an existing device */
3341 udev = hdev->children[port1-1];
3342 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
3343 udev->state != USB_STATE_NOTATTACHED) {
3344 usb_lock_device(udev);
3345 if (portstatus & USB_PORT_STAT_ENABLE) {
3346 status = 0; /* Nothing to do */
3348 #ifdef CONFIG_USB_SUSPEND
3349 } else if (udev->state == USB_STATE_SUSPENDED &&
3350 udev->persist_enabled) {
3351 /* For a suspended device, treat this as a
3352 * remote wakeup event.
3354 status = usb_remote_wakeup(udev);
3358 status = -ENODEV; /* Don't resuscitate */
3360 usb_unlock_device(udev);
3363 clear_bit(port1, hub->change_bits);
3368 /* Disconnect any existing devices under this port */
3370 usb_disconnect(&hdev->children[port1-1]);
3371 clear_bit(port1, hub->change_bits);
3373 /* We can forget about a "removed" device when there's a physical
3374 * disconnect or the connect status changes.
3376 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
3377 (portchange & USB_PORT_STAT_C_CONNECTION))
3378 clear_bit(port1, hub->removed_bits);
3380 if (portchange & (USB_PORT_STAT_C_CONNECTION |
3381 USB_PORT_STAT_C_ENABLE)) {
3382 status = hub_port_debounce(hub, port1);
3384 if (printk_ratelimit())
3385 dev_err(hub_dev, "connect-debounce failed, "
3386 "port %d disabled\n", port1);
3387 portstatus &= ~USB_PORT_STAT_CONNECTION;
3389 portstatus = status;
3393 /* Return now if debouncing failed or nothing is connected or
3394 * the device was "removed".
3396 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
3397 test_bit(port1, hub->removed_bits)) {
3399 /* maybe switch power back on (e.g. root hub was reset) */
3400 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
3401 && !port_is_power_on(hub, portstatus))
3402 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
3404 if (portstatus & USB_PORT_STAT_ENABLE)
3409 for (i = 0; i < SET_CONFIG_TRIES; i++) {
3411 /* reallocate for each attempt, since references
3412 * to the previous one can escape in various ways
3414 udev = usb_alloc_dev(hdev, hdev->bus, port1);
3417 "couldn't allocate port %d usb_device\n",
3422 usb_set_device_state(udev, USB_STATE_POWERED);
3423 udev->bus_mA = hub->mA_per_port;
3424 udev->level = hdev->level + 1;
3425 udev->wusb = hub_is_wusb(hub);
3427 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
3428 if (hub_is_superspeed(hub->hdev))
3429 udev->speed = USB_SPEED_SUPER;
3431 udev->speed = USB_SPEED_UNKNOWN;
3433 choose_devnum(udev);
3434 if (udev->devnum <= 0) {
3435 status = -ENOTCONN; /* Don't retry */
3439 /* reset (non-USB 3.0 devices) and get descriptor */
3440 status = hub_port_init(hub, udev, port1, i);
3444 usb_detect_quirks(udev);
3445 if (udev->quirks & USB_QUIRK_DELAY_INIT)
3448 /* consecutive bus-powered hubs aren't reliable; they can
3449 * violate the voltage drop budget. if the new child has
3450 * a "powered" LED, users should notice we didn't enable it
3451 * (without reading syslog), even without per-port LEDs
3454 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
3455 && udev->bus_mA <= 100) {
3458 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
3461 dev_dbg(&udev->dev, "get status %d ?\n", status);
3464 le16_to_cpus(&devstat);
3465 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
3467 "can't connect bus-powered hub "
3469 if (hub->has_indicators) {
3470 hub->indicator[port1-1] =
3471 INDICATOR_AMBER_BLINK;
3472 schedule_delayed_work (&hub->leds, 0);
3474 status = -ENOTCONN; /* Don't retry */
3479 /* check for devices running slower than they could */
3480 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
3481 && udev->speed == USB_SPEED_FULL
3482 && highspeed_hubs != 0)
3483 check_highspeed (hub, udev, port1);
3485 /* Store the parent's children[] pointer. At this point
3486 * udev becomes globally accessible, although presumably
3487 * no one will look at it until hdev is unlocked.
3491 /* We mustn't add new devices if the parent hub has
3492 * been disconnected; we would race with the
3493 * recursively_mark_NOTATTACHED() routine.
3495 spin_lock_irq(&device_state_lock);
3496 if (hdev->state == USB_STATE_NOTATTACHED)
3499 hdev->children[port1-1] = udev;
3500 spin_unlock_irq(&device_state_lock);
3502 /* Run it through the hoops (find a driver, etc) */
3504 status = usb_new_device(udev);
3506 spin_lock_irq(&device_state_lock);
3507 hdev->children[port1-1] = NULL;
3508 spin_unlock_irq(&device_state_lock);
3515 status = hub_power_remaining(hub);
3517 dev_dbg(hub_dev, "%dmA power budget left\n", status);
3522 hub_port_disable(hub, port1, 1);
3524 usb_ep0_reinit(udev);
3525 release_devnum(udev);
3528 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
3531 if (hub->hdev->parent ||
3532 !hcd->driver->port_handed_over ||
3533 !(hcd->driver->port_handed_over)(hcd, port1))
3534 dev_err(hub_dev, "unable to enumerate USB device on port %d\n",
3538 hub_port_disable(hub, port1, 1);
3539 if (hcd->driver->relinquish_port && !hub->hdev->parent)
3540 hcd->driver->relinquish_port(hcd, port1);
3543 /* Returns 1 if there was a remote wakeup and a connect status change. */
3544 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
3545 u16 portstatus, u16 portchange)
3547 struct usb_device *hdev;
3548 struct usb_device *udev;
3549 int connect_change = 0;
3553 udev = hdev->children[port-1];
3554 if (!hub_is_superspeed(hdev)) {
3555 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
3557 clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
3559 if (!udev || udev->state != USB_STATE_SUSPENDED ||
3560 (portstatus & USB_PORT_STAT_LINK_STATE) !=
3566 /* TRSMRCY = 10 msec */
3569 usb_lock_device(udev);
3570 ret = usb_remote_wakeup(udev);
3571 usb_unlock_device(udev);
3576 hub_port_disable(hub, port, 1);
3578 dev_dbg(hub->intfdev, "resume on port %d, status %d\n",
3580 return connect_change;
3583 static void hub_events(void)
3585 struct list_head *tmp;
3586 struct usb_device *hdev;
3587 struct usb_interface *intf;
3588 struct usb_hub *hub;
3589 struct device *hub_dev;
3595 int connect_change, wakeup_change;
3598 * We restart the list every time to avoid a deadlock with
3599 * deleting hubs downstream from this one. This should be
3600 * safe since we delete the hub from the event list.
3601 * Not the most efficient, but avoids deadlocks.
3605 /* Grab the first entry at the beginning of the list */
3606 spin_lock_irq(&hub_event_lock);
3607 if (list_empty(&hub_event_list)) {
3608 spin_unlock_irq(&hub_event_lock);
3612 tmp = hub_event_list.next;
3615 hub = list_entry(tmp, struct usb_hub, event_list);
3616 kref_get(&hub->kref);
3617 spin_unlock_irq(&hub_event_lock);
3620 hub_dev = hub->intfdev;
3621 intf = to_usb_interface(hub_dev);
3622 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
3623 hdev->state, hub->descriptor
3624 ? hub->descriptor->bNbrPorts
3626 /* NOTE: expects max 15 ports... */
3627 (u16) hub->change_bits[0],
3628 (u16) hub->event_bits[0]);
3630 /* Lock the device, then check to see if we were
3631 * disconnected while waiting for the lock to succeed. */
3632 usb_lock_device(hdev);
3633 if (unlikely(hub->disconnected))
3634 goto loop_disconnected;
3636 /* If the hub has died, clean up after it */
3637 if (hdev->state == USB_STATE_NOTATTACHED) {
3638 hub->error = -ENODEV;
3639 hub_quiesce(hub, HUB_DISCONNECT);
3644 ret = usb_autopm_get_interface(intf);
3646 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
3650 /* If this is an inactive hub, do nothing */
3655 dev_dbg (hub_dev, "resetting for error %d\n",
3658 ret = usb_reset_device(hdev);
3661 "error resetting hub: %d\n", ret);
3669 /* deal with port status changes */
3670 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
3671 if (test_bit(i, hub->busy_bits))
3673 connect_change = test_bit(i, hub->change_bits);
3674 wakeup_change = test_and_clear_bit(i, hub->wakeup_bits);
3675 if (!test_and_clear_bit(i, hub->event_bits) &&
3676 !connect_change && !wakeup_change)
3679 ret = hub_port_status(hub, i,
3680 &portstatus, &portchange);
3684 if (portchange & USB_PORT_STAT_C_CONNECTION) {
3685 clear_port_feature(hdev, i,
3686 USB_PORT_FEAT_C_CONNECTION);
3690 if (portchange & USB_PORT_STAT_C_ENABLE) {
3691 if (!connect_change)
3693 "port %d enable change, "
3696 clear_port_feature(hdev, i,
3697 USB_PORT_FEAT_C_ENABLE);
3700 * EM interference sometimes causes badly
3701 * shielded USB devices to be shutdown by
3702 * the hub, this hack enables them again.
3703 * Works at least with mouse driver.
3705 if (!(portstatus & USB_PORT_STAT_ENABLE)
3707 && hdev->children[i-1]) {
3710 "disabled by hub (EMI?), "
3717 if (hub_handle_remote_wakeup(hub, i,
3718 portstatus, portchange))
3721 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
3725 dev_dbg(hub_dev, "over-current change on port "
3727 clear_port_feature(hdev, i,
3728 USB_PORT_FEAT_C_OVER_CURRENT);
3729 msleep(100); /* Cool down */
3730 hub_power_on(hub, true);
3731 hub_port_status(hub, i, &status, &unused);
3732 if (status & USB_PORT_STAT_OVERCURRENT)
3733 dev_err(hub_dev, "over-current "
3734 "condition on port %d\n", i);
3737 if (portchange & USB_PORT_STAT_C_RESET) {
3739 "reset change on port %d\n",
3741 clear_port_feature(hdev, i,
3742 USB_PORT_FEAT_C_RESET);
3744 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
3745 hub_is_superspeed(hub->hdev)) {
3747 "warm reset change on port %d\n",
3749 clear_port_feature(hdev, i,
3750 USB_PORT_FEAT_C_BH_PORT_RESET);
3752 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
3753 clear_port_feature(hub->hdev, i,
3754 USB_PORT_FEAT_C_PORT_LINK_STATE);
3756 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
3758 "config error on port %d\n",
3760 clear_port_feature(hub->hdev, i,
3761 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
3764 /* Warm reset a USB3 protocol port if it's in
3765 * SS.Inactive state.
3767 if (hub_port_warm_reset_required(hub, portstatus)) {
3768 dev_dbg(hub_dev, "warm reset port %d\n", i);
3769 hub_port_reset(hub, i, NULL,
3770 HUB_BH_RESET_TIME, true);
3774 hub_port_connect_change(hub, i,
3775 portstatus, portchange);
3778 /* deal with hub status changes */
3779 if (test_and_clear_bit(0, hub->event_bits) == 0)
3781 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
3782 dev_err (hub_dev, "get_hub_status failed\n");
3784 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
3785 dev_dbg (hub_dev, "power change\n");
3786 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
3787 if (hubstatus & HUB_STATUS_LOCAL_POWER)
3788 /* FIXME: Is this always true? */
3789 hub->limited_power = 1;
3791 hub->limited_power = 0;
3793 if (hubchange & HUB_CHANGE_OVERCURRENT) {
3797 dev_dbg(hub_dev, "over-current change\n");
3798 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
3799 msleep(500); /* Cool down */
3800 hub_power_on(hub, true);
3801 hub_hub_status(hub, &status, &unused);
3802 if (status & HUB_STATUS_OVERCURRENT)
3803 dev_err(hub_dev, "over-current "
3809 /* Balance the usb_autopm_get_interface() above */
3810 usb_autopm_put_interface_no_suspend(intf);
3812 /* Balance the usb_autopm_get_interface_no_resume() in
3813 * kick_khubd() and allow autosuspend.
3815 usb_autopm_put_interface(intf);
3817 usb_unlock_device(hdev);
3818 kref_put(&hub->kref, hub_release);
3820 } /* end while (1) */
3823 static int hub_thread(void *__unused)
3825 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
3826 * port handover. Otherwise it might see that a full-speed device
3827 * was gone before the EHCI controller had handed its port over to
3828 * the companion full-speed controller.
3834 wait_event_freezable(khubd_wait,
3835 !list_empty(&hub_event_list) ||
3836 kthread_should_stop());
3837 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
3839 pr_debug("%s: khubd exiting\n", usbcore_name);
3843 static const struct usb_device_id hub_id_table[] = {
3844 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
3845 .bDeviceClass = USB_CLASS_HUB},
3846 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
3847 .bInterfaceClass = USB_CLASS_HUB},
3848 { } /* Terminating entry */
3851 MODULE_DEVICE_TABLE (usb, hub_id_table);
3853 static struct usb_driver hub_driver = {
3856 .disconnect = hub_disconnect,
3857 .suspend = hub_suspend,
3858 .resume = hub_resume,
3859 .reset_resume = hub_reset_resume,
3860 .pre_reset = hub_pre_reset,
3861 .post_reset = hub_post_reset,
3862 .unlocked_ioctl = hub_ioctl,
3863 .id_table = hub_id_table,
3864 .supports_autosuspend = 1,
3867 int usb_hub_init(void)
3869 if (usb_register(&hub_driver) < 0) {
3870 printk(KERN_ERR "%s: can't register hub driver\n",
3875 khubd_task = kthread_run(hub_thread, NULL, "khubd");
3876 if (!IS_ERR(khubd_task))
3879 /* Fall through if kernel_thread failed */
3880 usb_deregister(&hub_driver);
3881 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
3886 void usb_hub_cleanup(void)
3888 kthread_stop(khubd_task);
3891 * Hub resources are freed for us by usb_deregister. It calls
3892 * usb_driver_purge on every device which in turn calls that
3893 * devices disconnect function if it is using this driver.
3894 * The hub_disconnect function takes care of releasing the
3895 * individual hub resources. -greg
3897 usb_deregister(&hub_driver);
3898 } /* usb_hub_cleanup() */
3900 static int descriptors_changed(struct usb_device *udev,
3901 struct usb_device_descriptor *old_device_descriptor)
3905 unsigned serial_len = 0;
3907 unsigned old_length;
3911 if (memcmp(&udev->descriptor, old_device_descriptor,
3912 sizeof(*old_device_descriptor)) != 0)
3915 /* Since the idVendor, idProduct, and bcdDevice values in the
3916 * device descriptor haven't changed, we will assume the
3917 * Manufacturer and Product strings haven't changed either.
3918 * But the SerialNumber string could be different (e.g., a
3919 * different flash card of the same brand).
3922 serial_len = strlen(udev->serial) + 1;
3925 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3926 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3927 len = max(len, old_length);
3930 buf = kmalloc(len, GFP_NOIO);
3932 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
3933 /* assume the worst */
3936 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3937 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3938 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
3940 if (length != old_length) {
3941 dev_dbg(&udev->dev, "config index %d, error %d\n",
3946 if (memcmp (buf, udev->rawdescriptors[index], old_length)
3948 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
3950 ((struct usb_config_descriptor *) buf)->
3951 bConfigurationValue);
3957 if (!changed && serial_len) {
3958 length = usb_string(udev, udev->descriptor.iSerialNumber,
3960 if (length + 1 != serial_len) {
3961 dev_dbg(&udev->dev, "serial string error %d\n",
3964 } else if (memcmp(buf, udev->serial, length) != 0) {
3965 dev_dbg(&udev->dev, "serial string changed\n");
3975 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
3976 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3978 * WARNING - don't use this routine to reset a composite device
3979 * (one with multiple interfaces owned by separate drivers)!
3980 * Use usb_reset_device() instead.
3982 * Do a port reset, reassign the device's address, and establish its
3983 * former operating configuration. If the reset fails, or the device's
3984 * descriptors change from their values before the reset, or the original
3985 * configuration and altsettings cannot be restored, a flag will be set
3986 * telling khubd to pretend the device has been disconnected and then
3987 * re-connected. All drivers will be unbound, and the device will be
3988 * re-enumerated and probed all over again.
3990 * Returns 0 if the reset succeeded, -ENODEV if the device has been
3991 * flagged for logical disconnection, or some other negative error code
3992 * if the reset wasn't even attempted.
3994 * The caller must own the device lock. For example, it's safe to use
3995 * this from a driver probe() routine after downloading new firmware.
3996 * For calls that might not occur during probe(), drivers should lock
3997 * the device using usb_lock_device_for_reset().
3999 * Locking exception: This routine may also be called from within an
4000 * autoresume handler. Such usage won't conflict with other tasks
4001 * holding the device lock because these tasks should always call
4002 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
4004 static int usb_reset_and_verify_device(struct usb_device *udev)
4006 struct usb_device *parent_hdev = udev->parent;
4007 struct usb_hub *parent_hub;
4008 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4009 struct usb_device_descriptor descriptor = udev->descriptor;
4011 int port1 = udev->portnum;
4013 if (udev->state == USB_STATE_NOTATTACHED ||
4014 udev->state == USB_STATE_SUSPENDED) {
4015 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
4021 /* this requires hcd-specific logic; see ohci_restart() */
4022 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
4025 parent_hub = hdev_to_hub(parent_hdev);
4027 set_bit(port1, parent_hub->busy_bits);
4028 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
4030 /* ep0 maxpacket size may change; let the HCD know about it.
4031 * Other endpoints will be handled by re-enumeration. */
4032 usb_ep0_reinit(udev);
4033 ret = hub_port_init(parent_hub, udev, port1, i);
4034 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
4037 clear_bit(port1, parent_hub->busy_bits);
4042 /* Device might have changed firmware (DFU or similar) */
4043 if (descriptors_changed(udev, &descriptor)) {
4044 dev_info(&udev->dev, "device firmware changed\n");
4045 udev->descriptor = descriptor; /* for disconnect() calls */
4049 /* Restore the device's previous configuration */
4050 if (!udev->actconfig)
4053 mutex_lock(hcd->bandwidth_mutex);
4054 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
4056 dev_warn(&udev->dev,
4057 "Busted HC? Not enough HCD resources for "
4058 "old configuration.\n");
4059 mutex_unlock(hcd->bandwidth_mutex);
4062 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
4063 USB_REQ_SET_CONFIGURATION, 0,
4064 udev->actconfig->desc.bConfigurationValue, 0,
4065 NULL, 0, USB_CTRL_SET_TIMEOUT);
4068 "can't restore configuration #%d (error=%d)\n",
4069 udev->actconfig->desc.bConfigurationValue, ret);
4070 mutex_unlock(hcd->bandwidth_mutex);
4073 mutex_unlock(hcd->bandwidth_mutex);
4074 usb_set_device_state(udev, USB_STATE_CONFIGURED);
4076 /* Put interfaces back into the same altsettings as before.
4077 * Don't bother to send the Set-Interface request for interfaces
4078 * that were already in altsetting 0; besides being unnecessary,
4079 * many devices can't handle it. Instead just reset the host-side
4082 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
4083 struct usb_host_config *config = udev->actconfig;
4084 struct usb_interface *intf = config->interface[i];
4085 struct usb_interface_descriptor *desc;
4087 desc = &intf->cur_altsetting->desc;
4088 if (desc->bAlternateSetting == 0) {
4089 usb_disable_interface(udev, intf, true);
4090 usb_enable_interface(udev, intf, true);
4093 /* Let the bandwidth allocation function know that this
4094 * device has been reset, and it will have to use
4095 * alternate setting 0 as the current alternate setting.
4097 intf->resetting_device = 1;
4098 ret = usb_set_interface(udev, desc->bInterfaceNumber,
4099 desc->bAlternateSetting);
4100 intf->resetting_device = 0;
4103 dev_err(&udev->dev, "failed to restore interface %d "
4104 "altsetting %d (error=%d)\n",
4105 desc->bInterfaceNumber,
4106 desc->bAlternateSetting,
4116 hub_port_logical_disconnect(parent_hub, port1);
4121 * usb_reset_device - warn interface drivers and perform a USB port reset
4122 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
4124 * Warns all drivers bound to registered interfaces (using their pre_reset
4125 * method), performs the port reset, and then lets the drivers know that
4126 * the reset is over (using their post_reset method).
4128 * Return value is the same as for usb_reset_and_verify_device().
4130 * The caller must own the device lock. For example, it's safe to use
4131 * this from a driver probe() routine after downloading new firmware.
4132 * For calls that might not occur during probe(), drivers should lock
4133 * the device using usb_lock_device_for_reset().
4135 * If an interface is currently being probed or disconnected, we assume
4136 * its driver knows how to handle resets. For all other interfaces,
4137 * if the driver doesn't have pre_reset and post_reset methods then
4138 * we attempt to unbind it and rebind afterward.
4140 int usb_reset_device(struct usb_device *udev)
4144 struct usb_host_config *config = udev->actconfig;
4146 if (udev->state == USB_STATE_NOTATTACHED ||
4147 udev->state == USB_STATE_SUSPENDED) {
4148 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
4153 /* Prevent autosuspend during the reset */
4154 usb_autoresume_device(udev);
4157 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
4158 struct usb_interface *cintf = config->interface[i];
4159 struct usb_driver *drv;
4162 if (cintf->dev.driver) {
4163 drv = to_usb_driver(cintf->dev.driver);
4164 if (drv->pre_reset && drv->post_reset)
4165 unbind = (drv->pre_reset)(cintf);
4166 else if (cintf->condition ==
4167 USB_INTERFACE_BOUND)
4170 usb_forced_unbind_intf(cintf);
4175 ret = usb_reset_and_verify_device(udev);
4178 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
4179 struct usb_interface *cintf = config->interface[i];
4180 struct usb_driver *drv;
4181 int rebind = cintf->needs_binding;
4183 if (!rebind && cintf->dev.driver) {
4184 drv = to_usb_driver(cintf->dev.driver);
4185 if (drv->post_reset)
4186 rebind = (drv->post_reset)(cintf);
4187 else if (cintf->condition ==
4188 USB_INTERFACE_BOUND)
4191 if (ret == 0 && rebind)
4192 usb_rebind_intf(cintf);
4196 usb_autosuspend_device(udev);
4199 EXPORT_SYMBOL_GPL(usb_reset_device);
4203 * usb_queue_reset_device - Reset a USB device from an atomic context
4204 * @iface: USB interface belonging to the device to reset
4206 * This function can be used to reset a USB device from an atomic
4207 * context, where usb_reset_device() won't work (as it blocks).
4209 * Doing a reset via this method is functionally equivalent to calling
4210 * usb_reset_device(), except for the fact that it is delayed to a
4211 * workqueue. This means that any drivers bound to other interfaces
4212 * might be unbound, as well as users from usbfs in user space.
4216 * - Scheduling two resets at the same time from two different drivers
4217 * attached to two different interfaces of the same device is
4218 * possible; depending on how the driver attached to each interface
4219 * handles ->pre_reset(), the second reset might happen or not.
4221 * - If a driver is unbound and it had a pending reset, the reset will
4224 * - This function can be called during .probe() or .disconnect()
4225 * times. On return from .disconnect(), any pending resets will be
4228 * There is no no need to lock/unlock the @reset_ws as schedule_work()
4231 * NOTE: We don't do any reference count tracking because it is not
4232 * needed. The lifecycle of the work_struct is tied to the
4233 * usb_interface. Before destroying the interface we cancel the
4234 * work_struct, so the fact that work_struct is queued and or
4235 * running means the interface (and thus, the device) exist and
4238 void usb_queue_reset_device(struct usb_interface *iface)
4240 schedule_work(&iface->reset_ws);
4242 EXPORT_SYMBOL_GPL(usb_queue_reset_device);