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 (--limit && !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 next = hub->tt.clear_list.next;
517 clear = list_entry (next, struct usb_tt_clear, clear_list);
518 list_del (&clear->clear_list);
520 /* drop lock so HCD can concurrently report other TT errors */
521 spin_unlock_irqrestore (&hub->tt.lock, flags);
522 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
525 "clear tt %d (%04x) error %d\n",
526 clear->tt, clear->devinfo, status);
528 /* Tell the HCD, even if the operation failed */
529 drv = clear->hcd->driver;
530 if (drv->clear_tt_buffer_complete)
531 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
534 spin_lock_irqsave(&hub->tt.lock, flags);
536 spin_unlock_irqrestore (&hub->tt.lock, flags);
540 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
541 * @urb: an URB associated with the failed or incomplete split transaction
543 * High speed HCDs use this to tell the hub driver that some split control or
544 * bulk transaction failed in a way that requires clearing internal state of
545 * a transaction translator. This is normally detected (and reported) from
548 * It may not be possible for that hub to handle additional full (or low)
549 * speed transactions until that state is fully cleared out.
551 int usb_hub_clear_tt_buffer(struct urb *urb)
553 struct usb_device *udev = urb->dev;
554 int pipe = urb->pipe;
555 struct usb_tt *tt = udev->tt;
557 struct usb_tt_clear *clear;
559 /* we've got to cope with an arbitrary number of pending TT clears,
560 * since each TT has "at least two" buffers that can need it (and
561 * there can be many TTs per hub). even if they're uncommon.
563 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
564 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
565 /* FIXME recover somehow ... RESET_TT? */
569 /* info that CLEAR_TT_BUFFER needs */
570 clear->tt = tt->multi ? udev->ttport : 1;
571 clear->devinfo = usb_pipeendpoint (pipe);
572 clear->devinfo |= udev->devnum << 4;
573 clear->devinfo |= usb_pipecontrol (pipe)
574 ? (USB_ENDPOINT_XFER_CONTROL << 11)
575 : (USB_ENDPOINT_XFER_BULK << 11);
576 if (usb_pipein (pipe))
577 clear->devinfo |= 1 << 15;
579 /* info for completion callback */
580 clear->hcd = bus_to_hcd(udev->bus);
583 /* tell keventd to clear state for this TT */
584 spin_lock_irqsave (&tt->lock, flags);
585 list_add_tail (&clear->clear_list, &tt->clear_list);
586 schedule_work(&tt->clear_work);
587 spin_unlock_irqrestore (&tt->lock, flags);
590 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
592 /* If do_delay is false, return the number of milliseconds the caller
595 static unsigned hub_power_on(struct usb_hub *hub, bool do_delay)
598 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
600 u16 wHubCharacteristics =
601 le16_to_cpu(hub->descriptor->wHubCharacteristics);
603 /* Enable power on each port. Some hubs have reserved values
604 * of LPSM (> 2) in their descriptors, even though they are
605 * USB 2.0 hubs. Some hubs do not implement port-power switching
606 * but only emulate it. In all cases, the ports won't work
607 * unless we send these messages to the hub.
609 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
610 dev_dbg(hub->intfdev, "enabling power on all ports\n");
612 dev_dbg(hub->intfdev, "trying to enable port power on "
613 "non-switchable hub\n");
614 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
615 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
617 /* Wait at least 100 msec for power to become stable */
618 delay = max(pgood_delay, (unsigned) 100);
624 static int hub_hub_status(struct usb_hub *hub,
625 u16 *status, u16 *change)
629 mutex_lock(&hub->status_mutex);
630 ret = get_hub_status(hub->hdev, &hub->status->hub);
632 dev_err (hub->intfdev,
633 "%s failed (err = %d)\n", __func__, ret);
635 *status = le16_to_cpu(hub->status->hub.wHubStatus);
636 *change = le16_to_cpu(hub->status->hub.wHubChange);
639 mutex_unlock(&hub->status_mutex);
643 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
645 struct usb_device *hdev = hub->hdev;
648 if (hdev->children[port1-1] && set_state)
649 usb_set_device_state(hdev->children[port1-1],
650 USB_STATE_NOTATTACHED);
651 if (!hub->error && !hub_is_superspeed(hub->hdev))
652 ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
654 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
660 * Disable a port and mark a logical connect-change event, so that some
661 * time later khubd will disconnect() any existing usb_device on the port
662 * and will re-enumerate if there actually is a device attached.
664 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
666 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
667 hub_port_disable(hub, port1, 1);
669 /* FIXME let caller ask to power down the port:
670 * - some devices won't enumerate without a VBUS power cycle
671 * - SRP saves power that way
672 * - ... new call, TBD ...
673 * That's easy if this hub can switch power per-port, and
674 * khubd reactivates the port later (timer, SRP, etc).
675 * Powerdown must be optional, because of reset/DFU.
678 set_bit(port1, hub->change_bits);
683 * usb_remove_device - disable a device's port on its parent hub
684 * @udev: device to be disabled and removed
685 * Context: @udev locked, must be able to sleep.
687 * After @udev's port has been disabled, khubd is notified and it will
688 * see that the device has been disconnected. When the device is
689 * physically unplugged and something is plugged in, the events will
690 * be received and processed normally.
692 int usb_remove_device(struct usb_device *udev)
695 struct usb_interface *intf;
697 if (!udev->parent) /* Can't remove a root hub */
699 hub = hdev_to_hub(udev->parent);
700 intf = to_usb_interface(hub->intfdev);
702 usb_autopm_get_interface(intf);
703 set_bit(udev->portnum, hub->removed_bits);
704 hub_port_logical_disconnect(hub, udev->portnum);
705 usb_autopm_put_interface(intf);
709 enum hub_activation_type {
710 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
711 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
714 static void hub_init_func2(struct work_struct *ws);
715 static void hub_init_func3(struct work_struct *ws);
717 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
719 struct usb_device *hdev = hub->hdev;
724 bool need_debounce_delay = false;
727 /* Continue a partial initialization */
728 if (type == HUB_INIT2)
730 if (type == HUB_INIT3)
733 /* After a resume, port power should still be on.
734 * For any other type of activation, turn it on.
736 if (type != HUB_RESUME) {
738 /* Speed up system boot by using a delayed_work for the
739 * hub's initial power-up delays. This is pretty awkward
740 * and the implementation looks like a home-brewed sort of
741 * setjmp/longjmp, but it saves at least 100 ms for each
742 * root hub (assuming usbcore is compiled into the kernel
743 * rather than as a module). It adds up.
745 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
746 * because for those activation types the ports have to be
747 * operational when we return. In theory this could be done
748 * for HUB_POST_RESET, but it's easier not to.
750 if (type == HUB_INIT) {
751 delay = hub_power_on(hub, false);
752 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func2);
753 schedule_delayed_work(&hub->init_work,
754 msecs_to_jiffies(delay));
756 /* Suppress autosuspend until init is done */
757 usb_autopm_get_interface_no_resume(
758 to_usb_interface(hub->intfdev));
759 return; /* Continues at init2: below */
760 } else if (type == HUB_RESET_RESUME) {
761 /* The internal host controller state for the hub device
762 * may be gone after a host power loss on system resume.
763 * Update the device's info so the HW knows it's a hub.
765 hcd = bus_to_hcd(hdev->bus);
766 if (hcd->driver->update_hub_device) {
767 ret = hcd->driver->update_hub_device(hcd, hdev,
770 dev_err(hub->intfdev, "Host not "
771 "accepting hub info "
773 dev_err(hub->intfdev, "LS/FS devices "
774 "and hubs may not work "
775 "under this hub\n.");
778 hub_power_on(hub, true);
780 hub_power_on(hub, true);
785 /* Check each port and set hub->change_bits to let khubd know
786 * which ports need attention.
788 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
789 struct usb_device *udev = hdev->children[port1-1];
790 u16 portstatus, portchange;
792 portstatus = portchange = 0;
793 status = hub_port_status(hub, port1, &portstatus, &portchange);
794 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
795 dev_dbg(hub->intfdev,
796 "port %d: status %04x change %04x\n",
797 port1, portstatus, portchange);
799 /* After anything other than HUB_RESUME (i.e., initialization
800 * or any sort of reset), every port should be disabled.
801 * Unconnected ports should likewise be disabled (paranoia),
802 * and so should ports for which we have no usb_device.
804 if ((portstatus & USB_PORT_STAT_ENABLE) && (
805 type != HUB_RESUME ||
806 !(portstatus & USB_PORT_STAT_CONNECTION) ||
808 udev->state == USB_STATE_NOTATTACHED)) {
810 * USB3 protocol ports will automatically transition
811 * to Enabled state when detect an USB3.0 device attach.
812 * Do not disable USB3 protocol ports.
814 if (!hub_is_superspeed(hdev)) {
815 clear_port_feature(hdev, port1,
816 USB_PORT_FEAT_ENABLE);
817 portstatus &= ~USB_PORT_STAT_ENABLE;
819 /* Pretend that power was lost for USB3 devs */
820 portstatus &= ~USB_PORT_STAT_ENABLE;
824 /* Clear status-change flags; we'll debounce later */
825 if (portchange & USB_PORT_STAT_C_CONNECTION) {
826 need_debounce_delay = true;
827 clear_port_feature(hub->hdev, port1,
828 USB_PORT_FEAT_C_CONNECTION);
830 if (portchange & USB_PORT_STAT_C_ENABLE) {
831 need_debounce_delay = true;
832 clear_port_feature(hub->hdev, port1,
833 USB_PORT_FEAT_C_ENABLE);
835 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
836 hub_is_superspeed(hub->hdev)) {
837 need_debounce_delay = true;
838 clear_port_feature(hub->hdev, port1,
839 USB_PORT_FEAT_C_BH_PORT_RESET);
841 /* We can forget about a "removed" device when there's a
842 * physical disconnect or the connect status changes.
844 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
845 (portchange & USB_PORT_STAT_C_CONNECTION))
846 clear_bit(port1, hub->removed_bits);
848 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
849 /* Tell khubd to disconnect the device or
850 * check for a new connection
852 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
853 set_bit(port1, hub->change_bits);
855 } else if (portstatus & USB_PORT_STAT_ENABLE) {
856 bool port_resumed = (portstatus &
857 USB_PORT_STAT_LINK_STATE) ==
859 /* The power session apparently survived the resume.
860 * If there was an overcurrent or suspend change
861 * (i.e., remote wakeup request), have khubd
862 * take care of it. Look at the port link state
863 * for USB 3.0 hubs, since they don't have a suspend
864 * change bit, and they don't set the port link change
865 * bit on device-initiated resume.
867 if (portchange || (hub_is_superspeed(hub->hdev) &&
869 set_bit(port1, hub->change_bits);
871 } else if (udev->persist_enabled) {
873 udev->reset_resume = 1;
875 set_bit(port1, hub->change_bits);
878 /* The power session is gone; tell khubd */
879 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
880 set_bit(port1, hub->change_bits);
884 /* If no port-status-change flags were set, we don't need any
885 * debouncing. If flags were set we can try to debounce the
886 * ports all at once right now, instead of letting khubd do them
887 * one at a time later on.
889 * If any port-status changes do occur during this delay, khubd
890 * will see them later and handle them normally.
892 if (need_debounce_delay) {
893 delay = HUB_DEBOUNCE_STABLE;
895 /* Don't do a long sleep inside a workqueue routine */
896 if (type == HUB_INIT2) {
897 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func3);
898 schedule_delayed_work(&hub->init_work,
899 msecs_to_jiffies(delay));
900 return; /* Continues at init3: below */
908 status = usb_submit_urb(hub->urb, GFP_NOIO);
910 dev_err(hub->intfdev, "activate --> %d\n", status);
911 if (hub->has_indicators && blinkenlights)
912 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
914 /* Scan all ports that need attention */
917 /* Allow autosuspend if it was suppressed */
918 if (type <= HUB_INIT3)
919 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
922 /* Implement the continuations for the delays above */
923 static void hub_init_func2(struct work_struct *ws)
925 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
927 hub_activate(hub, HUB_INIT2);
930 static void hub_init_func3(struct work_struct *ws)
932 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
934 hub_activate(hub, HUB_INIT3);
937 enum hub_quiescing_type {
938 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
941 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
943 struct usb_device *hdev = hub->hdev;
946 cancel_delayed_work_sync(&hub->init_work);
948 /* khubd and related activity won't re-trigger */
951 if (type != HUB_SUSPEND) {
952 /* Disconnect all the children */
953 for (i = 0; i < hdev->maxchild; ++i) {
954 if (hdev->children[i])
955 usb_disconnect(&hdev->children[i]);
959 /* Stop khubd and related activity */
960 usb_kill_urb(hub->urb);
961 if (hub->has_indicators)
962 cancel_delayed_work_sync(&hub->leds);
964 cancel_work_sync(&hub->tt.clear_work);
967 /* caller has locked the hub device */
968 static int hub_pre_reset(struct usb_interface *intf)
970 struct usb_hub *hub = usb_get_intfdata(intf);
972 hub_quiesce(hub, HUB_PRE_RESET);
976 /* caller has locked the hub device */
977 static int hub_post_reset(struct usb_interface *intf)
979 struct usb_hub *hub = usb_get_intfdata(intf);
981 hub_activate(hub, HUB_POST_RESET);
985 static int hub_configure(struct usb_hub *hub,
986 struct usb_endpoint_descriptor *endpoint)
989 struct usb_device *hdev = hub->hdev;
990 struct device *hub_dev = hub->intfdev;
991 u16 hubstatus, hubchange;
992 u16 wHubCharacteristics;
995 char *message = "out of memory";
997 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
1003 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1008 mutex_init(&hub->status_mutex);
1010 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1011 if (!hub->descriptor) {
1016 if (hub_is_superspeed(hdev) && (hdev->parent != NULL)) {
1017 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
1018 HUB_SET_DEPTH, USB_RT_HUB,
1019 hdev->level - 1, 0, NULL, 0,
1020 USB_CTRL_SET_TIMEOUT);
1023 message = "can't set hub depth";
1028 /* Request the entire hub descriptor.
1029 * hub->descriptor can handle USB_MAXCHILDREN ports,
1030 * but the hub can/will return fewer bytes here.
1032 ret = get_hub_descriptor(hdev, hub->descriptor);
1034 message = "can't read hub descriptor";
1036 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
1037 message = "hub has too many ports!";
1042 hdev->maxchild = hub->descriptor->bNbrPorts;
1043 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
1044 (hdev->maxchild == 1) ? "" : "s");
1046 hub->port_owners = kzalloc(hdev->maxchild * sizeof(void *), GFP_KERNEL);
1047 if (!hub->port_owners) {
1052 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1054 /* FIXME for USB 3.0, skip for now */
1055 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1056 !(hub_is_superspeed(hdev))) {
1058 char portstr [USB_MAXCHILDREN + 1];
1060 for (i = 0; i < hdev->maxchild; i++)
1061 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1062 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1064 portstr[hdev->maxchild] = 0;
1065 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1067 dev_dbg(hub_dev, "standalone hub\n");
1069 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1070 case HUB_CHAR_COMMON_LPSM:
1071 dev_dbg(hub_dev, "ganged power switching\n");
1073 case HUB_CHAR_INDV_PORT_LPSM:
1074 dev_dbg(hub_dev, "individual port power switching\n");
1076 case HUB_CHAR_NO_LPSM:
1078 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1082 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1083 case HUB_CHAR_COMMON_OCPM:
1084 dev_dbg(hub_dev, "global over-current protection\n");
1086 case HUB_CHAR_INDV_PORT_OCPM:
1087 dev_dbg(hub_dev, "individual port over-current protection\n");
1089 case HUB_CHAR_NO_OCPM:
1091 dev_dbg(hub_dev, "no over-current protection\n");
1095 spin_lock_init (&hub->tt.lock);
1096 INIT_LIST_HEAD (&hub->tt.clear_list);
1097 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1098 switch (hdev->descriptor.bDeviceProtocol) {
1101 case USB_HUB_PR_HS_SINGLE_TT:
1102 dev_dbg(hub_dev, "Single TT\n");
1105 case USB_HUB_PR_HS_MULTI_TT:
1106 ret = usb_set_interface(hdev, 0, 1);
1108 dev_dbg(hub_dev, "TT per port\n");
1111 dev_err(hub_dev, "Using single TT (err %d)\n",
1116 /* USB 3.0 hubs don't have a TT */
1119 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1120 hdev->descriptor.bDeviceProtocol);
1124 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1125 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1126 case HUB_TTTT_8_BITS:
1127 if (hdev->descriptor.bDeviceProtocol != 0) {
1128 hub->tt.think_time = 666;
1129 dev_dbg(hub_dev, "TT requires at most %d "
1130 "FS bit times (%d ns)\n",
1131 8, hub->tt.think_time);
1134 case HUB_TTTT_16_BITS:
1135 hub->tt.think_time = 666 * 2;
1136 dev_dbg(hub_dev, "TT requires at most %d "
1137 "FS bit times (%d ns)\n",
1138 16, hub->tt.think_time);
1140 case HUB_TTTT_24_BITS:
1141 hub->tt.think_time = 666 * 3;
1142 dev_dbg(hub_dev, "TT requires at most %d "
1143 "FS bit times (%d ns)\n",
1144 24, hub->tt.think_time);
1146 case HUB_TTTT_32_BITS:
1147 hub->tt.think_time = 666 * 4;
1148 dev_dbg(hub_dev, "TT requires at most %d "
1149 "FS bit times (%d ns)\n",
1150 32, hub->tt.think_time);
1154 /* probe() zeroes hub->indicator[] */
1155 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1156 hub->has_indicators = 1;
1157 dev_dbg(hub_dev, "Port indicators are supported\n");
1160 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1161 hub->descriptor->bPwrOn2PwrGood * 2);
1163 /* power budgeting mostly matters with bus-powered hubs,
1164 * and battery-powered root hubs (may provide just 8 mA).
1166 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1168 message = "can't get hub status";
1171 le16_to_cpus(&hubstatus);
1172 if (hdev == hdev->bus->root_hub) {
1173 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
1174 hub->mA_per_port = 500;
1176 hub->mA_per_port = hdev->bus_mA;
1177 hub->limited_power = 1;
1179 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1180 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1181 hub->descriptor->bHubContrCurrent);
1182 hub->limited_power = 1;
1183 if (hdev->maxchild > 0) {
1184 int remaining = hdev->bus_mA -
1185 hub->descriptor->bHubContrCurrent;
1187 if (remaining < hdev->maxchild * 100)
1189 "insufficient power available "
1190 "to use all downstream ports\n");
1191 hub->mA_per_port = 100; /* 7.2.1.1 */
1193 } else { /* Self-powered external hub */
1194 /* FIXME: What about battery-powered external hubs that
1195 * provide less current per port? */
1196 hub->mA_per_port = 500;
1198 if (hub->mA_per_port < 500)
1199 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1202 /* Update the HCD's internal representation of this hub before khubd
1203 * starts getting port status changes for devices under the hub.
1205 hcd = bus_to_hcd(hdev->bus);
1206 if (hcd->driver->update_hub_device) {
1207 ret = hcd->driver->update_hub_device(hcd, hdev,
1208 &hub->tt, GFP_KERNEL);
1210 message = "can't update HCD hub info";
1215 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1217 message = "can't get hub status";
1221 /* local power status reports aren't always correct */
1222 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1223 dev_dbg(hub_dev, "local power source is %s\n",
1224 (hubstatus & HUB_STATUS_LOCAL_POWER)
1225 ? "lost (inactive)" : "good");
1227 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1228 dev_dbg(hub_dev, "%sover-current condition exists\n",
1229 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1231 /* set up the interrupt endpoint
1232 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1233 * bytes as USB2.0[11.12.3] says because some hubs are known
1234 * to send more data (and thus cause overflow). For root hubs,
1235 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1236 * to be big enough for at least USB_MAXCHILDREN ports. */
1237 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1238 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1240 if (maxp > sizeof(*hub->buffer))
1241 maxp = sizeof(*hub->buffer);
1243 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1249 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1250 hub, endpoint->bInterval);
1252 /* maybe cycle the hub leds */
1253 if (hub->has_indicators && blinkenlights)
1254 hub->indicator [0] = INDICATOR_CYCLE;
1256 hub_activate(hub, HUB_INIT);
1260 dev_err (hub_dev, "config failed, %s (err %d)\n",
1262 /* hub_disconnect() frees urb and descriptor */
1266 static void hub_release(struct kref *kref)
1268 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1270 usb_put_intf(to_usb_interface(hub->intfdev));
1274 static unsigned highspeed_hubs;
1276 static void hub_disconnect(struct usb_interface *intf)
1278 struct usb_hub *hub = usb_get_intfdata (intf);
1280 /* Take the hub off the event list and don't let it be added again */
1281 spin_lock_irq(&hub_event_lock);
1282 if (!list_empty(&hub->event_list)) {
1283 list_del_init(&hub->event_list);
1284 usb_autopm_put_interface_no_suspend(intf);
1286 hub->disconnected = 1;
1287 spin_unlock_irq(&hub_event_lock);
1289 /* Disconnect all children and quiesce the hub */
1291 hub_quiesce(hub, HUB_DISCONNECT);
1293 usb_set_intfdata (intf, NULL);
1294 hub->hdev->maxchild = 0;
1296 if (hub->hdev->speed == USB_SPEED_HIGH)
1299 usb_free_urb(hub->urb);
1300 kfree(hub->port_owners);
1301 kfree(hub->descriptor);
1305 kref_put(&hub->kref, hub_release);
1308 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1310 struct usb_host_interface *desc;
1311 struct usb_endpoint_descriptor *endpoint;
1312 struct usb_device *hdev;
1313 struct usb_hub *hub;
1315 desc = intf->cur_altsetting;
1316 hdev = interface_to_usbdev(intf);
1318 /* Hubs have proper suspend/resume support. USB 3.0 device suspend is
1319 * different from USB 2.0/1.1 device suspend, and unfortunately we
1320 * don't support it yet. So leave autosuspend disabled for USB 3.0
1321 * external hubs for now. Enable autosuspend for USB 3.0 roothubs,
1322 * since that isn't a "real" hub.
1324 if (!hub_is_superspeed(hdev) || !hdev->parent)
1325 usb_enable_autosuspend(hdev);
1327 if (hdev->level == MAX_TOPO_LEVEL) {
1329 "Unsupported bus topology: hub nested too deep\n");
1333 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1335 dev_warn(&intf->dev, "ignoring external hub\n");
1340 /* Some hubs have a subclass of 1, which AFAICT according to the */
1341 /* specs is not defined, but it works */
1342 if ((desc->desc.bInterfaceSubClass != 0) &&
1343 (desc->desc.bInterfaceSubClass != 1)) {
1345 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1349 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1350 if (desc->desc.bNumEndpoints != 1)
1351 goto descriptor_error;
1353 endpoint = &desc->endpoint[0].desc;
1355 /* If it's not an interrupt in endpoint, we'd better punt! */
1356 if (!usb_endpoint_is_int_in(endpoint))
1357 goto descriptor_error;
1359 /* We found a hub */
1360 dev_info (&intf->dev, "USB hub found\n");
1362 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1364 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1368 kref_init(&hub->kref);
1369 INIT_LIST_HEAD(&hub->event_list);
1370 hub->intfdev = &intf->dev;
1372 INIT_DELAYED_WORK(&hub->leds, led_work);
1373 INIT_DELAYED_WORK(&hub->init_work, NULL);
1376 usb_set_intfdata (intf, hub);
1377 intf->needs_remote_wakeup = 1;
1379 if (hdev->speed == USB_SPEED_HIGH)
1382 if (hub_configure(hub, endpoint) >= 0)
1385 hub_disconnect (intf);
1390 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1392 struct usb_device *hdev = interface_to_usbdev (intf);
1394 /* assert ifno == 0 (part of hub spec) */
1396 case USBDEVFS_HUB_PORTINFO: {
1397 struct usbdevfs_hub_portinfo *info = user_data;
1400 spin_lock_irq(&device_state_lock);
1401 if (hdev->devnum <= 0)
1404 info->nports = hdev->maxchild;
1405 for (i = 0; i < info->nports; i++) {
1406 if (hdev->children[i] == NULL)
1410 hdev->children[i]->devnum;
1413 spin_unlock_irq(&device_state_lock);
1415 return info->nports + 1;
1424 * Allow user programs to claim ports on a hub. When a device is attached
1425 * to one of these "claimed" ports, the program will "own" the device.
1427 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1430 if (hdev->state == USB_STATE_NOTATTACHED)
1432 if (port1 == 0 || port1 > hdev->maxchild)
1435 /* This assumes that devices not managed by the hub driver
1436 * will always have maxchild equal to 0.
1438 *ppowner = &(hdev_to_hub(hdev)->port_owners[port1 - 1]);
1442 /* In the following three functions, the caller must hold hdev's lock */
1443 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1, void *owner)
1448 rc = find_port_owner(hdev, port1, &powner);
1457 int usb_hub_release_port(struct usb_device *hdev, unsigned port1, void *owner)
1462 rc = find_port_owner(hdev, port1, &powner);
1465 if (*powner != owner)
1471 void usb_hub_release_all_ports(struct usb_device *hdev, void *owner)
1476 n = find_port_owner(hdev, 1, &powner);
1478 for (; n < hdev->maxchild; (++n, ++powner)) {
1479 if (*powner == owner)
1485 /* The caller must hold udev's lock */
1486 bool usb_device_is_owned(struct usb_device *udev)
1488 struct usb_hub *hub;
1490 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1492 hub = hdev_to_hub(udev->parent);
1493 return !!hub->port_owners[udev->portnum - 1];
1497 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1501 for (i = 0; i < udev->maxchild; ++i) {
1502 if (udev->children[i])
1503 recursively_mark_NOTATTACHED(udev->children[i]);
1505 if (udev->state == USB_STATE_SUSPENDED)
1506 udev->active_duration -= jiffies;
1507 udev->state = USB_STATE_NOTATTACHED;
1511 * usb_set_device_state - change a device's current state (usbcore, hcds)
1512 * @udev: pointer to device whose state should be changed
1513 * @new_state: new state value to be stored
1515 * udev->state is _not_ fully protected by the device lock. Although
1516 * most transitions are made only while holding the lock, the state can
1517 * can change to USB_STATE_NOTATTACHED at almost any time. This
1518 * is so that devices can be marked as disconnected as soon as possible,
1519 * without having to wait for any semaphores to be released. As a result,
1520 * all changes to any device's state must be protected by the
1521 * device_state_lock spinlock.
1523 * Once a device has been added to the device tree, all changes to its state
1524 * should be made using this routine. The state should _not_ be set directly.
1526 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1527 * Otherwise udev->state is set to new_state, and if new_state is
1528 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1529 * to USB_STATE_NOTATTACHED.
1531 void usb_set_device_state(struct usb_device *udev,
1532 enum usb_device_state new_state)
1534 unsigned long flags;
1537 spin_lock_irqsave(&device_state_lock, flags);
1538 if (udev->state == USB_STATE_NOTATTACHED)
1540 else if (new_state != USB_STATE_NOTATTACHED) {
1542 /* root hub wakeup capabilities are managed out-of-band
1543 * and may involve silicon errata ... ignore them here.
1546 if (udev->state == USB_STATE_SUSPENDED
1547 || new_state == USB_STATE_SUSPENDED)
1548 ; /* No change to wakeup settings */
1549 else if (new_state == USB_STATE_CONFIGURED)
1550 wakeup = udev->actconfig->desc.bmAttributes
1551 & USB_CONFIG_ATT_WAKEUP;
1555 if (udev->state == USB_STATE_SUSPENDED &&
1556 new_state != USB_STATE_SUSPENDED)
1557 udev->active_duration -= jiffies;
1558 else if (new_state == USB_STATE_SUSPENDED &&
1559 udev->state != USB_STATE_SUSPENDED)
1560 udev->active_duration += jiffies;
1561 udev->state = new_state;
1563 recursively_mark_NOTATTACHED(udev);
1564 spin_unlock_irqrestore(&device_state_lock, flags);
1566 device_set_wakeup_capable(&udev->dev, wakeup);
1568 EXPORT_SYMBOL_GPL(usb_set_device_state);
1571 * Choose a device number.
1573 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1574 * USB-2.0 buses they are also used as device addresses, however on
1575 * USB-3.0 buses the address is assigned by the controller hardware
1576 * and it usually is not the same as the device number.
1578 * WUSB devices are simple: they have no hubs behind, so the mapping
1579 * device <-> virtual port number becomes 1:1. Why? to simplify the
1580 * life of the device connection logic in
1581 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1582 * handshake we need to assign a temporary address in the unauthorized
1583 * space. For simplicity we use the first virtual port number found to
1584 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1585 * and that becomes it's address [X < 128] or its unauthorized address
1588 * We add 1 as an offset to the one-based USB-stack port number
1589 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1590 * 0 is reserved by USB for default address; (b) Linux's USB stack
1591 * uses always #1 for the root hub of the controller. So USB stack's
1592 * port #1, which is wusb virtual-port #0 has address #2.
1594 * Devices connected under xHCI are not as simple. The host controller
1595 * supports virtualization, so the hardware assigns device addresses and
1596 * the HCD must setup data structures before issuing a set address
1597 * command to the hardware.
1599 static void choose_devnum(struct usb_device *udev)
1602 struct usb_bus *bus = udev->bus;
1604 /* If khubd ever becomes multithreaded, this will need a lock */
1606 devnum = udev->portnum + 1;
1607 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
1609 /* Try to allocate the next devnum beginning at
1610 * bus->devnum_next. */
1611 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1614 devnum = find_next_zero_bit(bus->devmap.devicemap,
1616 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1619 set_bit(devnum, bus->devmap.devicemap);
1620 udev->devnum = devnum;
1624 static void release_devnum(struct usb_device *udev)
1626 if (udev->devnum > 0) {
1627 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1632 static void update_devnum(struct usb_device *udev, int devnum)
1634 /* The address for a WUSB device is managed by wusbcore. */
1636 udev->devnum = devnum;
1639 static void hub_free_dev(struct usb_device *udev)
1641 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1643 /* Root hubs aren't real devices, so don't free HCD resources */
1644 if (hcd->driver->free_dev && udev->parent)
1645 hcd->driver->free_dev(hcd, udev);
1649 * usb_disconnect - disconnect a device (usbcore-internal)
1650 * @pdev: pointer to device being disconnected
1651 * Context: !in_interrupt ()
1653 * Something got disconnected. Get rid of it and all of its children.
1655 * If *pdev is a normal device then the parent hub must already be locked.
1656 * If *pdev is a root hub then this routine will acquire the
1657 * usb_bus_list_lock on behalf of the caller.
1659 * Only hub drivers (including virtual root hub drivers for host
1660 * controllers) should ever call this.
1662 * This call is synchronous, and may not be used in an interrupt context.
1664 void usb_disconnect(struct usb_device **pdev)
1666 struct usb_device *udev = *pdev;
1668 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1670 /* mark the device as inactive, so any further urb submissions for
1671 * this device (and any of its children) will fail immediately.
1672 * this quiesces everything except pending urbs.
1674 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1675 dev_info(&udev->dev, "USB disconnect, device number %d\n",
1678 usb_lock_device(udev);
1680 /* Free up all the children before we remove this device */
1681 for (i = 0; i < USB_MAXCHILDREN; i++) {
1682 if (udev->children[i])
1683 usb_disconnect(&udev->children[i]);
1686 /* deallocate hcd/hardware state ... nuking all pending urbs and
1687 * cleaning up all state associated with the current configuration
1688 * so that the hardware is now fully quiesced.
1690 dev_dbg (&udev->dev, "unregistering device\n");
1691 mutex_lock(hcd->bandwidth_mutex);
1692 usb_disable_device(udev, 0);
1693 mutex_unlock(hcd->bandwidth_mutex);
1694 usb_hcd_synchronize_unlinks(udev);
1696 usb_remove_ep_devs(&udev->ep0);
1697 usb_unlock_device(udev);
1699 /* Unregister the device. The device driver is responsible
1700 * for de-configuring the device and invoking the remove-device
1701 * notifier chain (used by usbfs and possibly others).
1703 device_del(&udev->dev);
1705 /* Free the device number and delete the parent's children[]
1706 * (or root_hub) pointer.
1708 release_devnum(udev);
1710 /* Avoid races with recursively_mark_NOTATTACHED() */
1711 spin_lock_irq(&device_state_lock);
1713 spin_unlock_irq(&device_state_lock);
1717 put_device(&udev->dev);
1720 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
1721 static void show_string(struct usb_device *udev, char *id, char *string)
1725 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1728 static void announce_device(struct usb_device *udev)
1730 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
1731 le16_to_cpu(udev->descriptor.idVendor),
1732 le16_to_cpu(udev->descriptor.idProduct));
1733 dev_info(&udev->dev,
1734 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
1735 udev->descriptor.iManufacturer,
1736 udev->descriptor.iProduct,
1737 udev->descriptor.iSerialNumber);
1738 show_string(udev, "Product", udev->product);
1739 show_string(udev, "Manufacturer", udev->manufacturer);
1740 show_string(udev, "SerialNumber", udev->serial);
1743 static inline void announce_device(struct usb_device *udev) { }
1746 #ifdef CONFIG_USB_OTG
1747 #include "otg_whitelist.h"
1751 * usb_enumerate_device_otg - FIXME (usbcore-internal)
1752 * @udev: newly addressed device (in ADDRESS state)
1754 * Finish enumeration for On-The-Go devices
1756 static int usb_enumerate_device_otg(struct usb_device *udev)
1760 #ifdef CONFIG_USB_OTG
1762 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1763 * to wake us after we've powered off VBUS; and HNP, switching roles
1764 * "host" to "peripheral". The OTG descriptor helps figure this out.
1766 if (!udev->bus->is_b_host
1768 && udev->parent == udev->bus->root_hub) {
1769 struct usb_otg_descriptor *desc = NULL;
1770 struct usb_bus *bus = udev->bus;
1772 /* descriptor may appear anywhere in config */
1773 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1774 le16_to_cpu(udev->config[0].desc.wTotalLength),
1775 USB_DT_OTG, (void **) &desc) == 0) {
1776 if (desc->bmAttributes & USB_OTG_HNP) {
1777 unsigned port1 = udev->portnum;
1779 dev_info(&udev->dev,
1780 "Dual-Role OTG device on %sHNP port\n",
1781 (port1 == bus->otg_port)
1784 /* enable HNP before suspend, it's simpler */
1785 if (port1 == bus->otg_port)
1786 bus->b_hnp_enable = 1;
1787 err = usb_control_msg(udev,
1788 usb_sndctrlpipe(udev, 0),
1789 USB_REQ_SET_FEATURE, 0,
1791 ? USB_DEVICE_B_HNP_ENABLE
1792 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1793 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1795 /* OTG MESSAGE: report errors here,
1796 * customize to match your product.
1798 dev_info(&udev->dev,
1799 "can't set HNP mode: %d\n",
1801 bus->b_hnp_enable = 0;
1807 if (!is_targeted(udev)) {
1809 /* Maybe it can talk to us, though we can't talk to it.
1810 * (Includes HNP test device.)
1812 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
1813 err = usb_port_suspend(udev, PMSG_SUSPEND);
1815 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1827 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
1828 * @udev: newly addressed device (in ADDRESS state)
1830 * This is only called by usb_new_device() and usb_authorize_device()
1831 * and FIXME -- all comments that apply to them apply here wrt to
1834 * If the device is WUSB and not authorized, we don't attempt to read
1835 * the string descriptors, as they will be errored out by the device
1836 * until it has been authorized.
1838 static int usb_enumerate_device(struct usb_device *udev)
1842 if (udev->config == NULL) {
1843 err = usb_get_configuration(udev);
1845 dev_err(&udev->dev, "can't read configurations, error %d\n",
1850 if (udev->wusb == 1 && udev->authorized == 0) {
1851 udev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1852 udev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1853 udev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1856 /* read the standard strings and cache them if present */
1857 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1858 udev->manufacturer = usb_cache_string(udev,
1859 udev->descriptor.iManufacturer);
1860 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
1862 err = usb_enumerate_device_otg(udev);
1867 static void set_usb_port_removable(struct usb_device *udev)
1869 struct usb_device *hdev = udev->parent;
1870 struct usb_hub *hub;
1871 u8 port = udev->portnum;
1872 u16 wHubCharacteristics;
1873 bool removable = true;
1878 hub = hdev_to_hub(udev->parent);
1880 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1882 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
1885 if (hub_is_superspeed(hdev)) {
1886 if (hub->descriptor->u.ss.DeviceRemovable & (1 << port))
1889 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
1894 udev->removable = USB_DEVICE_REMOVABLE;
1896 udev->removable = USB_DEVICE_FIXED;
1900 * usb_new_device - perform initial device setup (usbcore-internal)
1901 * @udev: newly addressed device (in ADDRESS state)
1903 * This is called with devices which have been detected but not fully
1904 * enumerated. The device descriptor is available, but not descriptors
1905 * for any device configuration. The caller must have locked either
1906 * the parent hub (if udev is a normal device) or else the
1907 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1908 * udev has already been installed, but udev is not yet visible through
1909 * sysfs or other filesystem code.
1911 * It will return if the device is configured properly or not. Zero if
1912 * the interface was registered with the driver core; else a negative
1915 * This call is synchronous, and may not be used in an interrupt context.
1917 * Only the hub driver or root-hub registrar should ever call this.
1919 int usb_new_device(struct usb_device *udev)
1924 /* Initialize non-root-hub device wakeup to disabled;
1925 * device (un)configuration controls wakeup capable
1926 * sysfs power/wakeup controls wakeup enabled/disabled
1928 device_init_wakeup(&udev->dev, 0);
1931 /* Tell the runtime-PM framework the device is active */
1932 pm_runtime_set_active(&udev->dev);
1933 pm_runtime_get_noresume(&udev->dev);
1934 pm_runtime_use_autosuspend(&udev->dev);
1935 pm_runtime_enable(&udev->dev);
1937 /* By default, forbid autosuspend for all devices. It will be
1938 * allowed for hubs during binding.
1940 usb_disable_autosuspend(udev);
1942 err = usb_enumerate_device(udev); /* Read descriptors */
1945 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
1946 udev->devnum, udev->bus->busnum,
1947 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1948 /* export the usbdev device-node for libusb */
1949 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
1950 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1952 /* Tell the world! */
1953 announce_device(udev);
1955 device_enable_async_suspend(&udev->dev);
1958 * check whether the hub marks this port as non-removable. Do it
1959 * now so that platform-specific data can override it in
1963 set_usb_port_removable(udev);
1965 /* Register the device. The device driver is responsible
1966 * for configuring the device and invoking the add-device
1967 * notifier chain (used by usbfs and possibly others).
1969 err = device_add(&udev->dev);
1971 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1975 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
1976 usb_mark_last_busy(udev);
1977 pm_runtime_put_sync_autosuspend(&udev->dev);
1981 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1982 pm_runtime_disable(&udev->dev);
1983 pm_runtime_set_suspended(&udev->dev);
1989 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
1990 * @usb_dev: USB device
1992 * Move the USB device to a very basic state where interfaces are disabled
1993 * and the device is in fact unconfigured and unusable.
1995 * We share a lock (that we have) with device_del(), so we need to
1998 int usb_deauthorize_device(struct usb_device *usb_dev)
2000 usb_lock_device(usb_dev);
2001 if (usb_dev->authorized == 0)
2002 goto out_unauthorized;
2004 usb_dev->authorized = 0;
2005 usb_set_configuration(usb_dev, -1);
2007 kfree(usb_dev->product);
2008 usb_dev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2009 kfree(usb_dev->manufacturer);
2010 usb_dev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2011 kfree(usb_dev->serial);
2012 usb_dev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2014 usb_destroy_configuration(usb_dev);
2015 usb_dev->descriptor.bNumConfigurations = 0;
2018 usb_unlock_device(usb_dev);
2023 int usb_authorize_device(struct usb_device *usb_dev)
2027 usb_lock_device(usb_dev);
2028 if (usb_dev->authorized == 1)
2029 goto out_authorized;
2031 result = usb_autoresume_device(usb_dev);
2033 dev_err(&usb_dev->dev,
2034 "can't autoresume for authorization: %d\n", result);
2035 goto error_autoresume;
2037 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2039 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2040 "authorization: %d\n", result);
2041 goto error_device_descriptor;
2044 kfree(usb_dev->product);
2045 usb_dev->product = NULL;
2046 kfree(usb_dev->manufacturer);
2047 usb_dev->manufacturer = NULL;
2048 kfree(usb_dev->serial);
2049 usb_dev->serial = NULL;
2051 usb_dev->authorized = 1;
2052 result = usb_enumerate_device(usb_dev);
2054 goto error_enumerate;
2055 /* Choose and set the configuration. This registers the interfaces
2056 * with the driver core and lets interface drivers bind to them.
2058 c = usb_choose_configuration(usb_dev);
2060 result = usb_set_configuration(usb_dev, c);
2062 dev_err(&usb_dev->dev,
2063 "can't set config #%d, error %d\n", c, result);
2064 /* This need not be fatal. The user can try to
2065 * set other configurations. */
2068 dev_info(&usb_dev->dev, "authorized to connect\n");
2071 error_device_descriptor:
2072 usb_autosuspend_device(usb_dev);
2075 usb_unlock_device(usb_dev); // complements locktree
2080 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2081 static unsigned hub_is_wusb(struct usb_hub *hub)
2083 struct usb_hcd *hcd;
2084 if (hub->hdev->parent != NULL) /* not a root hub? */
2086 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
2087 return hcd->wireless;
2091 #define PORT_RESET_TRIES 5
2092 #define SET_ADDRESS_TRIES 2
2093 #define GET_DESCRIPTOR_TRIES 2
2094 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2095 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2097 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2098 #define HUB_SHORT_RESET_TIME 10
2099 #define HUB_BH_RESET_TIME 50
2100 #define HUB_LONG_RESET_TIME 200
2101 #define HUB_RESET_TIMEOUT 500
2103 static int hub_port_reset(struct usb_hub *hub, int port1,
2104 struct usb_device *udev, unsigned int delay, bool warm);
2106 /* Is a USB 3.0 port in the Inactive state? */
2107 static bool hub_port_inactive(struct usb_hub *hub, u16 portstatus)
2109 return hub_is_superspeed(hub->hdev) &&
2110 (portstatus & USB_PORT_STAT_LINK_STATE) ==
2111 USB_SS_PORT_LS_SS_INACTIVE;
2114 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2115 struct usb_device *udev, unsigned int delay, bool warm)
2117 int delay_time, ret;
2121 for (delay_time = 0;
2122 delay_time < HUB_RESET_TIMEOUT;
2123 delay_time += delay) {
2124 /* wait to give the device a chance to reset */
2127 /* read and decode port status */
2128 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2133 * Some buggy devices require a warm reset to be issued even
2134 * when the port appears not to be connected.
2138 * Some buggy devices can cause an NEC host controller
2139 * to transition to the "Error" state after a hot port
2140 * reset. This will show up as the port state in
2141 * "Inactive", and the port may also report a
2142 * disconnect. Forcing a warm port reset seems to make
2145 * See https://bugzilla.kernel.org/show_bug.cgi?id=41752
2147 if (hub_port_inactive(hub, portstatus)) {
2150 if ((portchange & USB_PORT_STAT_C_CONNECTION))
2151 clear_port_feature(hub->hdev, port1,
2152 USB_PORT_FEAT_C_CONNECTION);
2153 if (portchange & USB_PORT_STAT_C_LINK_STATE)
2154 clear_port_feature(hub->hdev, port1,
2155 USB_PORT_FEAT_C_PORT_LINK_STATE);
2156 if (portchange & USB_PORT_STAT_C_RESET)
2157 clear_port_feature(hub->hdev, port1,
2158 USB_PORT_FEAT_C_RESET);
2159 dev_dbg(hub->intfdev, "hot reset failed, warm reset port %d\n",
2161 ret = hub_port_reset(hub, port1,
2162 udev, HUB_BH_RESET_TIME,
2164 if ((portchange & USB_PORT_STAT_C_CONNECTION))
2165 clear_port_feature(hub->hdev, port1,
2166 USB_PORT_FEAT_C_CONNECTION);
2169 /* Device went away? */
2170 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2173 /* bomb out completely if the connection bounced */
2174 if ((portchange & USB_PORT_STAT_C_CONNECTION))
2177 /* if we`ve finished resetting, then break out of
2180 if (!(portstatus & USB_PORT_STAT_RESET) &&
2181 (portstatus & USB_PORT_STAT_ENABLE)) {
2182 if (hub_is_wusb(hub))
2183 udev->speed = USB_SPEED_WIRELESS;
2184 else if (hub_is_superspeed(hub->hdev))
2185 udev->speed = USB_SPEED_SUPER;
2186 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2187 udev->speed = USB_SPEED_HIGH;
2188 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2189 udev->speed = USB_SPEED_LOW;
2191 udev->speed = USB_SPEED_FULL;
2195 if (portchange & USB_PORT_STAT_C_BH_RESET)
2199 /* switch to the long delay after two short delay failures */
2200 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2201 delay = HUB_LONG_RESET_TIME;
2203 dev_dbg (hub->intfdev,
2204 "port %d not %sreset yet, waiting %dms\n",
2205 port1, warm ? "warm " : "", delay);
2211 static void hub_port_finish_reset(struct usb_hub *hub, int port1,
2212 struct usb_device *udev, int *status, bool warm)
2217 struct usb_hcd *hcd;
2218 /* TRSTRCY = 10 ms; plus some extra */
2220 update_devnum(udev, 0);
2221 hcd = bus_to_hcd(udev->bus);
2222 if (hcd->driver->reset_device) {
2223 *status = hcd->driver->reset_device(hcd, udev);
2225 dev_err(&udev->dev, "Cannot reset "
2226 "HCD device state\n");
2234 clear_port_feature(hub->hdev,
2235 port1, USB_PORT_FEAT_C_RESET);
2236 /* FIXME need disconnect() for NOTATTACHED device */
2238 clear_port_feature(hub->hdev, port1,
2239 USB_PORT_FEAT_C_BH_PORT_RESET);
2240 clear_port_feature(hub->hdev, port1,
2241 USB_PORT_FEAT_C_PORT_LINK_STATE);
2243 usb_set_device_state(udev, *status
2244 ? USB_STATE_NOTATTACHED
2245 : USB_STATE_DEFAULT);
2251 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2252 static int hub_port_reset(struct usb_hub *hub, int port1,
2253 struct usb_device *udev, unsigned int delay, bool warm)
2258 /* Block EHCI CF initialization during the port reset.
2259 * Some companion controllers don't like it when they mix.
2261 down_read(&ehci_cf_port_reset_rwsem);
2263 if (!hub_is_superspeed(hub->hdev)) {
2264 dev_err(hub->intfdev, "only USB3 hub support "
2270 /* Reset the port */
2271 for (i = 0; i < PORT_RESET_TRIES; i++) {
2272 status = set_port_feature(hub->hdev, port1, (warm ?
2273 USB_PORT_FEAT_BH_PORT_RESET :
2274 USB_PORT_FEAT_RESET));
2276 dev_err(hub->intfdev,
2277 "cannot %sreset port %d (err = %d)\n",
2278 warm ? "warm " : "", port1, status);
2280 status = hub_port_wait_reset(hub, port1, udev, delay,
2282 if (status && status != -ENOTCONN)
2283 dev_dbg(hub->intfdev,
2284 "port_wait_reset: err = %d\n",
2288 /* return on disconnect or reset */
2289 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2290 hub_port_finish_reset(hub, port1, udev, &status, warm);
2294 dev_dbg (hub->intfdev,
2295 "port %d not enabled, trying %sreset again...\n",
2296 port1, warm ? "warm " : "");
2297 delay = HUB_LONG_RESET_TIME;
2300 dev_err (hub->intfdev,
2301 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2306 up_read(&ehci_cf_port_reset_rwsem);
2311 /* Check if a port is power on */
2312 static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2316 if (hub_is_superspeed(hub->hdev)) {
2317 if (portstatus & USB_SS_PORT_STAT_POWER)
2320 if (portstatus & USB_PORT_STAT_POWER)
2329 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2330 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
2334 if (hub_is_superspeed(hub->hdev)) {
2335 if ((portstatus & USB_PORT_STAT_LINK_STATE)
2336 == USB_SS_PORT_LS_U3)
2339 if (portstatus & USB_PORT_STAT_SUSPEND)
2346 /* Determine whether the device on a port is ready for a normal resume,
2347 * is ready for a reset-resume, or should be disconnected.
2349 static int check_port_resume_type(struct usb_device *udev,
2350 struct usb_hub *hub, int port1,
2351 int status, unsigned portchange, unsigned portstatus)
2353 /* Is the device still present? */
2354 if (status || port_is_suspended(hub, portstatus) ||
2355 !port_is_power_on(hub, portstatus) ||
2356 !(portstatus & USB_PORT_STAT_CONNECTION)) {
2361 /* Can't do a normal resume if the port isn't enabled,
2362 * so try a reset-resume instead.
2364 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2365 if (udev->persist_enabled)
2366 udev->reset_resume = 1;
2372 dev_dbg(hub->intfdev,
2373 "port %d status %04x.%04x after resume, %d\n",
2374 port1, portchange, portstatus, status);
2375 } else if (udev->reset_resume) {
2377 /* Late port handoff can set status-change bits */
2378 if (portchange & USB_PORT_STAT_C_CONNECTION)
2379 clear_port_feature(hub->hdev, port1,
2380 USB_PORT_FEAT_C_CONNECTION);
2381 if (portchange & USB_PORT_STAT_C_ENABLE)
2382 clear_port_feature(hub->hdev, port1,
2383 USB_PORT_FEAT_C_ENABLE);
2389 #ifdef CONFIG_USB_SUSPEND
2392 * usb_port_suspend - suspend a usb device's upstream port
2393 * @udev: device that's no longer in active use, not a root hub
2394 * Context: must be able to sleep; device not locked; pm locks held
2396 * Suspends a USB device that isn't in active use, conserving power.
2397 * Devices may wake out of a suspend, if anything important happens,
2398 * using the remote wakeup mechanism. They may also be taken out of
2399 * suspend by the host, using usb_port_resume(). It's also routine
2400 * to disconnect devices while they are suspended.
2402 * This only affects the USB hardware for a device; its interfaces
2403 * (and, for hubs, child devices) must already have been suspended.
2405 * Selective port suspend reduces power; most suspended devices draw
2406 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2407 * All devices below the suspended port are also suspended.
2409 * Devices leave suspend state when the host wakes them up. Some devices
2410 * also support "remote wakeup", where the device can activate the USB
2411 * tree above them to deliver data, such as a keypress or packet. In
2412 * some cases, this wakes the USB host.
2414 * Suspending OTG devices may trigger HNP, if that's been enabled
2415 * between a pair of dual-role devices. That will change roles, such
2416 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2418 * Devices on USB hub ports have only one "suspend" state, corresponding
2419 * to ACPI D2, "may cause the device to lose some context".
2420 * State transitions include:
2422 * - suspend, resume ... when the VBUS power link stays live
2423 * - suspend, disconnect ... VBUS lost
2425 * Once VBUS drop breaks the circuit, the port it's using has to go through
2426 * normal re-enumeration procedures, starting with enabling VBUS power.
2427 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2428 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2429 * timer, no SRP, no requests through sysfs.
2431 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
2432 * the root hub for their bus goes into global suspend ... so we don't
2433 * (falsely) update the device power state to say it suspended.
2435 * Returns 0 on success, else negative errno.
2437 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2439 struct usb_hub *hub = hdev_to_hub(udev->parent);
2440 int port1 = udev->portnum;
2443 /* enable remote wakeup when appropriate; this lets the device
2444 * wake up the upstream hub (including maybe the root hub).
2446 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2447 * we don't explicitly enable it here.
2449 if (udev->do_remote_wakeup) {
2450 if (!hub_is_superspeed(hub->hdev)) {
2451 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2452 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2453 USB_DEVICE_REMOTE_WAKEUP, 0,
2455 USB_CTRL_SET_TIMEOUT);
2457 /* Assume there's only one function on the USB 3.0
2458 * device and enable remote wake for the first
2459 * interface. FIXME if the interface association
2460 * descriptor shows there's more than one function.
2462 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2463 USB_REQ_SET_FEATURE,
2464 USB_RECIP_INTERFACE,
2465 USB_INTRF_FUNC_SUSPEND,
2466 USB_INTRF_FUNC_SUSPEND_RW |
2467 USB_INTRF_FUNC_SUSPEND_LP,
2469 USB_CTRL_SET_TIMEOUT);
2472 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
2474 /* bail if autosuspend is requested */
2475 if (PMSG_IS_AUTO(msg))
2480 /* disable USB2 hardware LPM */
2481 if (udev->usb2_hw_lpm_enabled == 1)
2482 usb_set_usb2_hardware_lpm(udev, 0);
2485 if (hub_is_superspeed(hub->hdev))
2486 status = set_port_feature(hub->hdev,
2487 port1 | (USB_SS_PORT_LS_U3 << 3),
2488 USB_PORT_FEAT_LINK_STATE);
2490 status = set_port_feature(hub->hdev, port1,
2491 USB_PORT_FEAT_SUSPEND);
2493 dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
2495 /* paranoia: "should not happen" */
2496 if (udev->do_remote_wakeup)
2497 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2498 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2499 USB_DEVICE_REMOTE_WAKEUP, 0,
2501 USB_CTRL_SET_TIMEOUT);
2503 /* System sleep transitions should never fail */
2504 if (!PMSG_IS_AUTO(msg))
2507 /* device has up to 10 msec to fully suspend */
2508 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
2509 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
2510 udev->do_remote_wakeup);
2511 usb_set_device_state(udev, USB_STATE_SUSPENDED);
2514 usb_mark_last_busy(hub->hdev);
2519 * If the USB "suspend" state is in use (rather than "global suspend"),
2520 * many devices will be individually taken out of suspend state using
2521 * special "resume" signaling. This routine kicks in shortly after
2522 * hardware resume signaling is finished, either because of selective
2523 * resume (by host) or remote wakeup (by device) ... now see what changed
2524 * in the tree that's rooted at this device.
2526 * If @udev->reset_resume is set then the device is reset before the
2527 * status check is done.
2529 static int finish_port_resume(struct usb_device *udev)
2534 /* caller owns the udev device lock */
2535 dev_dbg(&udev->dev, "%s\n",
2536 udev->reset_resume ? "finish reset-resume" : "finish resume");
2538 /* usb ch9 identifies four variants of SUSPENDED, based on what
2539 * state the device resumes to. Linux currently won't see the
2540 * first two on the host side; they'd be inside hub_port_init()
2541 * during many timeouts, but khubd can't suspend until later.
2543 usb_set_device_state(udev, udev->actconfig
2544 ? USB_STATE_CONFIGURED
2545 : USB_STATE_ADDRESS);
2547 /* 10.5.4.5 says not to reset a suspended port if the attached
2548 * device is enabled for remote wakeup. Hence the reset
2549 * operation is carried out here, after the port has been
2552 if (udev->reset_resume)
2554 status = usb_reset_and_verify_device(udev);
2556 /* 10.5.4.5 says be sure devices in the tree are still there.
2557 * For now let's assume the device didn't go crazy on resume,
2558 * and device drivers will know about any resume quirks.
2562 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
2564 status = (status > 0 ? 0 : -ENODEV);
2566 /* If a normal resume failed, try doing a reset-resume */
2567 if (status && !udev->reset_resume && udev->persist_enabled) {
2568 dev_dbg(&udev->dev, "retry with reset-resume\n");
2569 udev->reset_resume = 1;
2570 goto retry_reset_resume;
2575 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
2577 } else if (udev->actconfig) {
2578 le16_to_cpus(&devstatus);
2579 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) {
2580 status = usb_control_msg(udev,
2581 usb_sndctrlpipe(udev, 0),
2582 USB_REQ_CLEAR_FEATURE,
2584 USB_DEVICE_REMOTE_WAKEUP, 0,
2586 USB_CTRL_SET_TIMEOUT);
2589 "disable remote wakeup, status %d\n",
2598 * usb_port_resume - re-activate a suspended usb device's upstream port
2599 * @udev: device to re-activate, not a root hub
2600 * Context: must be able to sleep; device not locked; pm locks held
2602 * This will re-activate the suspended device, increasing power usage
2603 * while letting drivers communicate again with its endpoints.
2604 * USB resume explicitly guarantees that the power session between
2605 * the host and the device is the same as it was when the device
2608 * If @udev->reset_resume is set then this routine won't check that the
2609 * port is still enabled. Furthermore, finish_port_resume() above will
2610 * reset @udev. The end result is that a broken power session can be
2611 * recovered and @udev will appear to persist across a loss of VBUS power.
2613 * For example, if a host controller doesn't maintain VBUS suspend current
2614 * during a system sleep or is reset when the system wakes up, all the USB
2615 * power sessions below it will be broken. This is especially troublesome
2616 * for mass-storage devices containing mounted filesystems, since the
2617 * device will appear to have disconnected and all the memory mappings
2618 * to it will be lost. Using the USB_PERSIST facility, the device can be
2619 * made to appear as if it had not disconnected.
2621 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
2622 * every effort to insure that the same device is present after the
2623 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
2624 * quite possible for a device to remain unaltered but its media to be
2625 * changed. If the user replaces a flash memory card while the system is
2626 * asleep, he will have only himself to blame when the filesystem on the
2627 * new card is corrupted and the system crashes.
2629 * Returns 0 on success, else negative errno.
2631 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
2633 struct usb_hub *hub = hdev_to_hub(udev->parent);
2634 int port1 = udev->portnum;
2636 u16 portchange, portstatus;
2638 /* Skip the initial Clear-Suspend step for a remote wakeup */
2639 status = hub_port_status(hub, port1, &portstatus, &portchange);
2640 if (status == 0 && !port_is_suspended(hub, portstatus))
2641 goto SuspendCleared;
2643 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
2645 set_bit(port1, hub->busy_bits);
2647 /* see 7.1.7.7; affects power usage, but not budgeting */
2648 if (hub_is_superspeed(hub->hdev))
2649 status = set_port_feature(hub->hdev,
2650 port1 | (USB_SS_PORT_LS_U0 << 3),
2651 USB_PORT_FEAT_LINK_STATE);
2653 status = clear_port_feature(hub->hdev,
2654 port1, USB_PORT_FEAT_SUSPEND);
2656 dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
2659 /* drive resume for at least 20 msec */
2660 dev_dbg(&udev->dev, "usb %sresume\n",
2661 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
2664 /* Virtual root hubs can trigger on GET_PORT_STATUS to
2665 * stop resume signaling. Then finish the resume
2668 status = hub_port_status(hub, port1, &portstatus, &portchange);
2670 /* TRSMRCY = 10 msec */
2676 if (hub_is_superspeed(hub->hdev)) {
2677 if (portchange & USB_PORT_STAT_C_LINK_STATE)
2678 clear_port_feature(hub->hdev, port1,
2679 USB_PORT_FEAT_C_PORT_LINK_STATE);
2681 if (portchange & USB_PORT_STAT_C_SUSPEND)
2682 clear_port_feature(hub->hdev, port1,
2683 USB_PORT_FEAT_C_SUSPEND);
2687 clear_bit(port1, hub->busy_bits);
2689 status = check_port_resume_type(udev,
2690 hub, port1, status, portchange, portstatus);
2692 status = finish_port_resume(udev);
2694 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2695 hub_port_logical_disconnect(hub, port1);
2697 /* Try to enable USB2 hardware LPM */
2698 if (udev->usb2_hw_lpm_capable == 1)
2699 usb_set_usb2_hardware_lpm(udev, 1);
2705 /* caller has locked udev */
2706 int usb_remote_wakeup(struct usb_device *udev)
2710 if (udev->state == USB_STATE_SUSPENDED) {
2711 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
2712 status = usb_autoresume_device(udev);
2714 /* Let the drivers do their thing, then... */
2715 usb_autosuspend_device(udev);
2721 #else /* CONFIG_USB_SUSPEND */
2723 /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
2725 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2730 /* However we may need to do a reset-resume */
2732 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
2734 struct usb_hub *hub = hdev_to_hub(udev->parent);
2735 int port1 = udev->portnum;
2737 u16 portchange, portstatus;
2739 status = hub_port_status(hub, port1, &portstatus, &portchange);
2740 status = check_port_resume_type(udev,
2741 hub, port1, status, portchange, portstatus);
2744 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2745 hub_port_logical_disconnect(hub, port1);
2746 } else if (udev->reset_resume) {
2747 dev_dbg(&udev->dev, "reset-resume\n");
2748 status = usb_reset_and_verify_device(udev);
2755 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
2757 struct usb_hub *hub = usb_get_intfdata (intf);
2758 struct usb_device *hdev = hub->hdev;
2762 /* Warn if children aren't already suspended */
2763 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
2764 struct usb_device *udev;
2766 udev = hdev->children [port1-1];
2767 if (udev && udev->can_submit) {
2768 dev_warn(&intf->dev, "port %d nyet suspended\n", port1);
2769 if (PMSG_IS_AUTO(msg))
2773 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
2774 /* Enable hub to send remote wakeup for all ports. */
2775 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
2776 status = set_port_feature(hdev,
2778 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
2779 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
2780 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
2781 USB_PORT_FEAT_REMOTE_WAKE_MASK);
2785 dev_dbg(&intf->dev, "%s\n", __func__);
2787 /* stop khubd and related activity */
2788 hub_quiesce(hub, HUB_SUSPEND);
2792 static int hub_resume(struct usb_interface *intf)
2794 struct usb_hub *hub = usb_get_intfdata(intf);
2796 dev_dbg(&intf->dev, "%s\n", __func__);
2797 hub_activate(hub, HUB_RESUME);
2801 static int hub_reset_resume(struct usb_interface *intf)
2803 struct usb_hub *hub = usb_get_intfdata(intf);
2805 dev_dbg(&intf->dev, "%s\n", __func__);
2806 hub_activate(hub, HUB_RESET_RESUME);
2811 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
2812 * @rhdev: struct usb_device for the root hub
2814 * The USB host controller driver calls this function when its root hub
2815 * is resumed and Vbus power has been interrupted or the controller
2816 * has been reset. The routine marks @rhdev as having lost power.
2817 * When the hub driver is resumed it will take notice and carry out
2818 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
2819 * the others will be disconnected.
2821 void usb_root_hub_lost_power(struct usb_device *rhdev)
2823 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
2824 rhdev->reset_resume = 1;
2826 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
2828 #else /* CONFIG_PM */
2830 #define hub_suspend NULL
2831 #define hub_resume NULL
2832 #define hub_reset_resume NULL
2836 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2838 * Between connect detection and reset signaling there must be a delay
2839 * of 100ms at least for debounce and power-settling. The corresponding
2840 * timer shall restart whenever the downstream port detects a disconnect.
2842 * Apparently there are some bluetooth and irda-dongles and a number of
2843 * low-speed devices for which this debounce period may last over a second.
2844 * Not covered by the spec - but easy to deal with.
2846 * This implementation uses a 1500ms total debounce timeout; if the
2847 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2848 * every 25ms for transient disconnects. When the port status has been
2849 * unchanged for 100ms it returns the port status.
2851 static int hub_port_debounce(struct usb_hub *hub, int port1)
2854 int total_time, stable_time = 0;
2855 u16 portchange, portstatus;
2856 unsigned connection = 0xffff;
2858 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2859 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2863 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2864 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2865 stable_time += HUB_DEBOUNCE_STEP;
2866 if (stable_time >= HUB_DEBOUNCE_STABLE)
2870 connection = portstatus & USB_PORT_STAT_CONNECTION;
2873 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2874 clear_port_feature(hub->hdev, port1,
2875 USB_PORT_FEAT_C_CONNECTION);
2878 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2880 msleep(HUB_DEBOUNCE_STEP);
2883 dev_dbg (hub->intfdev,
2884 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2885 port1, total_time, stable_time, portstatus);
2887 if (stable_time < HUB_DEBOUNCE_STABLE)
2892 void usb_ep0_reinit(struct usb_device *udev)
2894 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
2895 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
2896 usb_enable_endpoint(udev, &udev->ep0, true);
2898 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
2900 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2901 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2903 static int hub_set_address(struct usb_device *udev, int devnum)
2906 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2909 * The host controller will choose the device address,
2910 * instead of the core having chosen it earlier
2912 if (!hcd->driver->address_device && devnum <= 1)
2914 if (udev->state == USB_STATE_ADDRESS)
2916 if (udev->state != USB_STATE_DEFAULT)
2918 if (hcd->driver->address_device)
2919 retval = hcd->driver->address_device(hcd, udev);
2921 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2922 USB_REQ_SET_ADDRESS, 0, devnum, 0,
2923 NULL, 0, USB_CTRL_SET_TIMEOUT);
2925 update_devnum(udev, devnum);
2926 /* Device now using proper address. */
2927 usb_set_device_state(udev, USB_STATE_ADDRESS);
2928 usb_ep0_reinit(udev);
2933 /* Reset device, (re)assign address, get device descriptor.
2934 * Device connection must be stable, no more debouncing needed.
2935 * Returns device in USB_STATE_ADDRESS, except on error.
2937 * If this is called for an already-existing device (as part of
2938 * usb_reset_and_verify_device), the caller must own the device lock. For a
2939 * newly detected device that is not accessible through any global
2940 * pointers, it's not necessary to lock the device.
2943 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2946 static DEFINE_MUTEX(usb_address0_mutex);
2948 struct usb_device *hdev = hub->hdev;
2949 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
2951 unsigned delay = HUB_SHORT_RESET_TIME;
2952 enum usb_device_speed oldspeed = udev->speed;
2954 int devnum = udev->devnum;
2956 /* root hub ports have a slightly longer reset period
2957 * (from USB 2.0 spec, section 7.1.7.5)
2959 if (!hdev->parent) {
2960 delay = HUB_ROOT_RESET_TIME;
2961 if (port1 == hdev->bus->otg_port)
2962 hdev->bus->b_hnp_enable = 0;
2965 /* Some low speed devices have problems with the quick delay, so */
2966 /* be a bit pessimistic with those devices. RHbug #23670 */
2967 if (oldspeed == USB_SPEED_LOW)
2968 delay = HUB_LONG_RESET_TIME;
2970 mutex_lock(&usb_address0_mutex);
2972 /* Reset the device; full speed may morph to high speed */
2973 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
2974 retval = hub_port_reset(hub, port1, udev, delay, false);
2975 if (retval < 0) /* error or disconnect */
2977 /* success, speed is known */
2981 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2982 dev_dbg(&udev->dev, "device reset changed speed!\n");
2985 oldspeed = udev->speed;
2987 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2988 * it's fixed size except for full speed devices.
2989 * For Wireless USB devices, ep0 max packet is always 512 (tho
2990 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
2992 switch (udev->speed) {
2993 case USB_SPEED_SUPER:
2994 case USB_SPEED_WIRELESS: /* fixed at 512 */
2995 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
2997 case USB_SPEED_HIGH: /* fixed at 64 */
2998 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
3000 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
3001 /* to determine the ep0 maxpacket size, try to read
3002 * the device descriptor to get bMaxPacketSize0 and
3003 * then correct our initial guess.
3005 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
3007 case USB_SPEED_LOW: /* fixed at 8 */
3008 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
3014 if (udev->speed == USB_SPEED_WIRELESS)
3015 speed = "variable speed Wireless";
3017 speed = usb_speed_string(udev->speed);
3019 if (udev->speed != USB_SPEED_SUPER)
3020 dev_info(&udev->dev,
3021 "%s %s USB device number %d using %s\n",
3022 (udev->config) ? "reset" : "new", speed,
3023 devnum, udev->bus->controller->driver->name);
3025 /* Set up TT records, if needed */
3027 udev->tt = hdev->tt;
3028 udev->ttport = hdev->ttport;
3029 } else if (udev->speed != USB_SPEED_HIGH
3030 && hdev->speed == USB_SPEED_HIGH) {
3032 dev_err(&udev->dev, "parent hub has no TT\n");
3036 udev->tt = &hub->tt;
3037 udev->ttport = port1;
3040 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
3041 * Because device hardware and firmware is sometimes buggy in
3042 * this area, and this is how Linux has done it for ages.
3043 * Change it cautiously.
3045 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
3046 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
3047 * so it may help with some non-standards-compliant devices.
3048 * Otherwise we start with SET_ADDRESS and then try to read the
3049 * first 8 bytes of the device descriptor to get the ep0 maxpacket
3052 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
3053 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3)) {
3054 struct usb_device_descriptor *buf;
3057 #define GET_DESCRIPTOR_BUFSIZE 64
3058 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
3064 /* Retry on all errors; some devices are flakey.
3065 * 255 is for WUSB devices, we actually need to use
3066 * 512 (WUSB1.0[4.8.1]).
3068 for (j = 0; j < 3; ++j) {
3069 buf->bMaxPacketSize0 = 0;
3070 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
3071 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
3072 USB_DT_DEVICE << 8, 0,
3073 buf, GET_DESCRIPTOR_BUFSIZE,
3074 initial_descriptor_timeout);
3075 switch (buf->bMaxPacketSize0) {
3076 case 8: case 16: case 32: case 64: case 255:
3077 if (buf->bDescriptorType ==
3091 udev->descriptor.bMaxPacketSize0 =
3092 buf->bMaxPacketSize0;
3095 retval = hub_port_reset(hub, port1, udev, delay, false);
3096 if (retval < 0) /* error or disconnect */
3098 if (oldspeed != udev->speed) {
3100 "device reset changed speed!\n");
3106 "device descriptor read/64, error %d\n",
3111 #undef GET_DESCRIPTOR_BUFSIZE
3115 * If device is WUSB, we already assigned an
3116 * unauthorized address in the Connect Ack sequence;
3117 * authorization will assign the final address.
3119 if (udev->wusb == 0) {
3120 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
3121 retval = hub_set_address(udev, devnum);
3128 "device not accepting address %d, error %d\n",
3132 if (udev->speed == USB_SPEED_SUPER) {
3133 devnum = udev->devnum;
3134 dev_info(&udev->dev,
3135 "%s SuperSpeed USB device number %d using %s\n",
3136 (udev->config) ? "reset" : "new",
3137 devnum, udev->bus->controller->driver->name);
3140 /* cope with hardware quirkiness:
3141 * - let SET_ADDRESS settle, some device hardware wants it
3142 * - read ep0 maxpacket even for high and low speed,
3145 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3))
3149 retval = usb_get_device_descriptor(udev, 8);
3152 "device descriptor read/8, error %d\n",
3164 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
3165 udev->speed == USB_SPEED_SUPER)
3168 i = udev->descriptor.bMaxPacketSize0;
3169 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
3170 if (udev->speed == USB_SPEED_LOW ||
3171 !(i == 8 || i == 16 || i == 32 || i == 64)) {
3172 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
3176 if (udev->speed == USB_SPEED_FULL)
3177 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
3179 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
3180 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
3181 usb_ep0_reinit(udev);
3184 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
3185 if (retval < (signed)sizeof(udev->descriptor)) {
3186 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
3193 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
3194 retval = usb_get_bos_descriptor(udev);
3196 if (udev->bos->ext_cap && (USB_LPM_SUPPORT &
3197 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
3198 udev->lpm_capable = 1;
3203 /* notify HCD that we have a device connected and addressed */
3204 if (hcd->driver->update_device)
3205 hcd->driver->update_device(hcd, udev);
3208 hub_port_disable(hub, port1, 0);
3209 update_devnum(udev, devnum); /* for disconnect processing */
3211 mutex_unlock(&usb_address0_mutex);
3216 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
3218 struct usb_qualifier_descriptor *qual;
3221 qual = kmalloc (sizeof *qual, GFP_KERNEL);
3225 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
3226 qual, sizeof *qual);
3227 if (status == sizeof *qual) {
3228 dev_info(&udev->dev, "not running at top speed; "
3229 "connect to a high speed hub\n");
3230 /* hub LEDs are probably harder to miss than syslog */
3231 if (hub->has_indicators) {
3232 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
3233 schedule_delayed_work (&hub->leds, 0);
3240 hub_power_remaining (struct usb_hub *hub)
3242 struct usb_device *hdev = hub->hdev;
3246 if (!hub->limited_power)
3249 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
3250 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
3251 struct usb_device *udev = hdev->children[port1 - 1];
3257 /* Unconfigured devices may not use more than 100mA,
3258 * or 8mA for OTG ports */
3259 if (udev->actconfig)
3260 delta = udev->actconfig->desc.bMaxPower * 2;
3261 else if (port1 != udev->bus->otg_port || hdev->parent)
3265 if (delta > hub->mA_per_port)
3266 dev_warn(&udev->dev,
3267 "%dmA is over %umA budget for port %d!\n",
3268 delta, hub->mA_per_port, port1);
3271 if (remaining < 0) {
3272 dev_warn(hub->intfdev, "%dmA over power budget!\n",
3279 /* Handle physical or logical connection change events.
3280 * This routine is called when:
3281 * a port connection-change occurs;
3282 * a port enable-change occurs (often caused by EMI);
3283 * usb_reset_and_verify_device() encounters changed descriptors (as from
3284 * a firmware download)
3285 * caller already locked the hub
3287 static void hub_port_connect_change(struct usb_hub *hub, int port1,
3288 u16 portstatus, u16 portchange)
3290 struct usb_device *hdev = hub->hdev;
3291 struct device *hub_dev = hub->intfdev;
3292 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
3293 unsigned wHubCharacteristics =
3294 le16_to_cpu(hub->descriptor->wHubCharacteristics);
3295 struct usb_device *udev;
3299 "port %d, status %04x, change %04x, %s\n",
3300 port1, portstatus, portchange, portspeed(hub, portstatus));
3302 if (hub->has_indicators) {
3303 set_port_led(hub, port1, HUB_LED_AUTO);
3304 hub->indicator[port1-1] = INDICATOR_AUTO;
3307 #ifdef CONFIG_USB_OTG
3308 /* during HNP, don't repeat the debounce */
3309 if (hdev->bus->is_b_host)
3310 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
3311 USB_PORT_STAT_C_ENABLE);
3314 /* Try to resuscitate an existing device */
3315 udev = hdev->children[port1-1];
3316 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
3317 udev->state != USB_STATE_NOTATTACHED) {
3318 usb_lock_device(udev);
3319 if (portstatus & USB_PORT_STAT_ENABLE) {
3320 status = 0; /* Nothing to do */
3322 #ifdef CONFIG_USB_SUSPEND
3323 } else if (udev->state == USB_STATE_SUSPENDED &&
3324 udev->persist_enabled) {
3325 /* For a suspended device, treat this as a
3326 * remote wakeup event.
3328 status = usb_remote_wakeup(udev);
3332 status = -ENODEV; /* Don't resuscitate */
3334 usb_unlock_device(udev);
3337 clear_bit(port1, hub->change_bits);
3342 /* Disconnect any existing devices under this port */
3344 usb_disconnect(&hdev->children[port1-1]);
3345 clear_bit(port1, hub->change_bits);
3347 /* We can forget about a "removed" device when there's a physical
3348 * disconnect or the connect status changes.
3350 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
3351 (portchange & USB_PORT_STAT_C_CONNECTION))
3352 clear_bit(port1, hub->removed_bits);
3354 if (portchange & (USB_PORT_STAT_C_CONNECTION |
3355 USB_PORT_STAT_C_ENABLE)) {
3356 status = hub_port_debounce(hub, port1);
3358 if (printk_ratelimit())
3359 dev_err(hub_dev, "connect-debounce failed, "
3360 "port %d disabled\n", port1);
3361 portstatus &= ~USB_PORT_STAT_CONNECTION;
3363 portstatus = status;
3367 /* Return now if debouncing failed or nothing is connected or
3368 * the device was "removed".
3370 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
3371 test_bit(port1, hub->removed_bits)) {
3373 /* maybe switch power back on (e.g. root hub was reset) */
3374 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
3375 && !port_is_power_on(hub, portstatus))
3376 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
3378 if (portstatus & USB_PORT_STAT_ENABLE)
3383 for (i = 0; i < SET_CONFIG_TRIES; i++) {
3385 /* reallocate for each attempt, since references
3386 * to the previous one can escape in various ways
3388 udev = usb_alloc_dev(hdev, hdev->bus, port1);
3391 "couldn't allocate port %d usb_device\n",
3396 usb_set_device_state(udev, USB_STATE_POWERED);
3397 udev->bus_mA = hub->mA_per_port;
3398 udev->level = hdev->level + 1;
3399 udev->wusb = hub_is_wusb(hub);
3401 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
3402 if (hub_is_superspeed(hub->hdev))
3403 udev->speed = USB_SPEED_SUPER;
3405 udev->speed = USB_SPEED_UNKNOWN;
3407 choose_devnum(udev);
3408 if (udev->devnum <= 0) {
3409 status = -ENOTCONN; /* Don't retry */
3413 /* reset (non-USB 3.0 devices) and get descriptor */
3414 status = hub_port_init(hub, udev, port1, i);
3418 usb_detect_quirks(udev);
3419 if (udev->quirks & USB_QUIRK_DELAY_INIT)
3422 /* consecutive bus-powered hubs aren't reliable; they can
3423 * violate the voltage drop budget. if the new child has
3424 * a "powered" LED, users should notice we didn't enable it
3425 * (without reading syslog), even without per-port LEDs
3428 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
3429 && udev->bus_mA <= 100) {
3432 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
3435 dev_dbg(&udev->dev, "get status %d ?\n", status);
3438 le16_to_cpus(&devstat);
3439 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
3441 "can't connect bus-powered hub "
3443 if (hub->has_indicators) {
3444 hub->indicator[port1-1] =
3445 INDICATOR_AMBER_BLINK;
3446 schedule_delayed_work (&hub->leds, 0);
3448 status = -ENOTCONN; /* Don't retry */
3453 /* check for devices running slower than they could */
3454 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
3455 && udev->speed == USB_SPEED_FULL
3456 && highspeed_hubs != 0)
3457 check_highspeed (hub, udev, port1);
3459 /* Store the parent's children[] pointer. At this point
3460 * udev becomes globally accessible, although presumably
3461 * no one will look at it until hdev is unlocked.
3465 /* We mustn't add new devices if the parent hub has
3466 * been disconnected; we would race with the
3467 * recursively_mark_NOTATTACHED() routine.
3469 spin_lock_irq(&device_state_lock);
3470 if (hdev->state == USB_STATE_NOTATTACHED)
3473 hdev->children[port1-1] = udev;
3474 spin_unlock_irq(&device_state_lock);
3476 /* Run it through the hoops (find a driver, etc) */
3478 status = usb_new_device(udev);
3480 spin_lock_irq(&device_state_lock);
3481 hdev->children[port1-1] = NULL;
3482 spin_unlock_irq(&device_state_lock);
3489 status = hub_power_remaining(hub);
3491 dev_dbg(hub_dev, "%dmA power budget left\n", status);
3496 hub_port_disable(hub, port1, 1);
3498 usb_ep0_reinit(udev);
3499 release_devnum(udev);
3502 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
3505 if (hub->hdev->parent ||
3506 !hcd->driver->port_handed_over ||
3507 !(hcd->driver->port_handed_over)(hcd, port1))
3508 dev_err(hub_dev, "unable to enumerate USB device on port %d\n",
3512 hub_port_disable(hub, port1, 1);
3513 if (hcd->driver->relinquish_port && !hub->hdev->parent)
3514 hcd->driver->relinquish_port(hcd, port1);
3517 /* Returns 1 if there was a remote wakeup and a connect status change. */
3518 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
3519 u16 portstatus, u16 portchange)
3521 struct usb_device *hdev;
3522 struct usb_device *udev;
3523 int connect_change = 0;
3527 udev = hdev->children[port-1];
3528 if (!hub_is_superspeed(hdev)) {
3529 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
3531 clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
3533 if (!udev || udev->state != USB_STATE_SUSPENDED ||
3534 (portstatus & USB_PORT_STAT_LINK_STATE) !=
3540 /* TRSMRCY = 10 msec */
3543 usb_lock_device(udev);
3544 ret = usb_remote_wakeup(udev);
3545 usb_unlock_device(udev);
3550 hub_port_disable(hub, port, 1);
3552 dev_dbg(hub->intfdev, "resume on port %d, status %d\n",
3554 return connect_change;
3557 static void hub_events(void)
3559 struct list_head *tmp;
3560 struct usb_device *hdev;
3561 struct usb_interface *intf;
3562 struct usb_hub *hub;
3563 struct device *hub_dev;
3569 int connect_change, wakeup_change;
3572 * We restart the list every time to avoid a deadlock with
3573 * deleting hubs downstream from this one. This should be
3574 * safe since we delete the hub from the event list.
3575 * Not the most efficient, but avoids deadlocks.
3579 /* Grab the first entry at the beginning of the list */
3580 spin_lock_irq(&hub_event_lock);
3581 if (list_empty(&hub_event_list)) {
3582 spin_unlock_irq(&hub_event_lock);
3586 tmp = hub_event_list.next;
3589 hub = list_entry(tmp, struct usb_hub, event_list);
3590 kref_get(&hub->kref);
3591 spin_unlock_irq(&hub_event_lock);
3594 hub_dev = hub->intfdev;
3595 intf = to_usb_interface(hub_dev);
3596 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
3597 hdev->state, hub->descriptor
3598 ? hub->descriptor->bNbrPorts
3600 /* NOTE: expects max 15 ports... */
3601 (u16) hub->change_bits[0],
3602 (u16) hub->event_bits[0]);
3604 /* Lock the device, then check to see if we were
3605 * disconnected while waiting for the lock to succeed. */
3606 usb_lock_device(hdev);
3607 if (unlikely(hub->disconnected))
3608 goto loop_disconnected;
3610 /* If the hub has died, clean up after it */
3611 if (hdev->state == USB_STATE_NOTATTACHED) {
3612 hub->error = -ENODEV;
3613 hub_quiesce(hub, HUB_DISCONNECT);
3618 ret = usb_autopm_get_interface(intf);
3620 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
3624 /* If this is an inactive hub, do nothing */
3629 dev_dbg (hub_dev, "resetting for error %d\n",
3632 ret = usb_reset_device(hdev);
3635 "error resetting hub: %d\n", ret);
3643 /* deal with port status changes */
3644 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
3645 if (test_bit(i, hub->busy_bits))
3647 connect_change = test_bit(i, hub->change_bits);
3648 wakeup_change = test_and_clear_bit(i, hub->wakeup_bits);
3649 if (!test_and_clear_bit(i, hub->event_bits) &&
3650 !connect_change && !wakeup_change)
3653 ret = hub_port_status(hub, i,
3654 &portstatus, &portchange);
3658 if (portchange & USB_PORT_STAT_C_CONNECTION) {
3659 clear_port_feature(hdev, i,
3660 USB_PORT_FEAT_C_CONNECTION);
3664 if (portchange & USB_PORT_STAT_C_ENABLE) {
3665 if (!connect_change)
3667 "port %d enable change, "
3670 clear_port_feature(hdev, i,
3671 USB_PORT_FEAT_C_ENABLE);
3674 * EM interference sometimes causes badly
3675 * shielded USB devices to be shutdown by
3676 * the hub, this hack enables them again.
3677 * Works at least with mouse driver.
3679 if (!(portstatus & USB_PORT_STAT_ENABLE)
3681 && hdev->children[i-1]) {
3684 "disabled by hub (EMI?), "
3691 if (hub_handle_remote_wakeup(hub, i,
3692 portstatus, portchange))
3695 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
3699 dev_dbg(hub_dev, "over-current change on port "
3701 clear_port_feature(hdev, i,
3702 USB_PORT_FEAT_C_OVER_CURRENT);
3703 msleep(100); /* Cool down */
3704 hub_power_on(hub, true);
3705 hub_port_status(hub, i, &status, &unused);
3706 if (status & USB_PORT_STAT_OVERCURRENT)
3707 dev_err(hub_dev, "over-current "
3708 "condition on port %d\n", i);
3711 if (portchange & USB_PORT_STAT_C_RESET) {
3713 "reset change on port %d\n",
3715 clear_port_feature(hdev, i,
3716 USB_PORT_FEAT_C_RESET);
3718 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
3719 hub_is_superspeed(hub->hdev)) {
3721 "warm reset change on port %d\n",
3723 clear_port_feature(hdev, i,
3724 USB_PORT_FEAT_C_BH_PORT_RESET);
3726 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
3727 clear_port_feature(hub->hdev, i,
3728 USB_PORT_FEAT_C_PORT_LINK_STATE);
3730 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
3732 "config error on port %d\n",
3734 clear_port_feature(hub->hdev, i,
3735 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
3738 /* Warm reset a USB3 protocol port if it's in
3739 * SS.Inactive state.
3741 if (hub_is_superspeed(hub->hdev) &&
3742 (portstatus & USB_PORT_STAT_LINK_STATE)
3743 == USB_SS_PORT_LS_SS_INACTIVE) {
3744 dev_dbg(hub_dev, "warm reset port %d\n", i);
3745 hub_port_reset(hub, i, NULL,
3746 HUB_BH_RESET_TIME, true);
3750 hub_port_connect_change(hub, i,
3751 portstatus, portchange);
3754 /* deal with hub status changes */
3755 if (test_and_clear_bit(0, hub->event_bits) == 0)
3757 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
3758 dev_err (hub_dev, "get_hub_status failed\n");
3760 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
3761 dev_dbg (hub_dev, "power change\n");
3762 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
3763 if (hubstatus & HUB_STATUS_LOCAL_POWER)
3764 /* FIXME: Is this always true? */
3765 hub->limited_power = 1;
3767 hub->limited_power = 0;
3769 if (hubchange & HUB_CHANGE_OVERCURRENT) {
3773 dev_dbg(hub_dev, "over-current change\n");
3774 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
3775 msleep(500); /* Cool down */
3776 hub_power_on(hub, true);
3777 hub_hub_status(hub, &status, &unused);
3778 if (status & HUB_STATUS_OVERCURRENT)
3779 dev_err(hub_dev, "over-current "
3785 /* Balance the usb_autopm_get_interface() above */
3786 usb_autopm_put_interface_no_suspend(intf);
3788 /* Balance the usb_autopm_get_interface_no_resume() in
3789 * kick_khubd() and allow autosuspend.
3791 usb_autopm_put_interface(intf);
3793 usb_unlock_device(hdev);
3794 kref_put(&hub->kref, hub_release);
3796 } /* end while (1) */
3799 static int hub_thread(void *__unused)
3801 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
3802 * port handover. Otherwise it might see that a full-speed device
3803 * was gone before the EHCI controller had handed its port over to
3804 * the companion full-speed controller.
3810 wait_event_freezable(khubd_wait,
3811 !list_empty(&hub_event_list) ||
3812 kthread_should_stop());
3813 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
3815 pr_debug("%s: khubd exiting\n", usbcore_name);
3819 static const struct usb_device_id hub_id_table[] = {
3820 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
3821 .bDeviceClass = USB_CLASS_HUB},
3822 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
3823 .bInterfaceClass = USB_CLASS_HUB},
3824 { } /* Terminating entry */
3827 MODULE_DEVICE_TABLE (usb, hub_id_table);
3829 static struct usb_driver hub_driver = {
3832 .disconnect = hub_disconnect,
3833 .suspend = hub_suspend,
3834 .resume = hub_resume,
3835 .reset_resume = hub_reset_resume,
3836 .pre_reset = hub_pre_reset,
3837 .post_reset = hub_post_reset,
3838 .unlocked_ioctl = hub_ioctl,
3839 .id_table = hub_id_table,
3840 .supports_autosuspend = 1,
3843 int usb_hub_init(void)
3845 if (usb_register(&hub_driver) < 0) {
3846 printk(KERN_ERR "%s: can't register hub driver\n",
3851 khubd_task = kthread_run(hub_thread, NULL, "khubd");
3852 if (!IS_ERR(khubd_task))
3855 /* Fall through if kernel_thread failed */
3856 usb_deregister(&hub_driver);
3857 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
3862 void usb_hub_cleanup(void)
3864 kthread_stop(khubd_task);
3867 * Hub resources are freed for us by usb_deregister. It calls
3868 * usb_driver_purge on every device which in turn calls that
3869 * devices disconnect function if it is using this driver.
3870 * The hub_disconnect function takes care of releasing the
3871 * individual hub resources. -greg
3873 usb_deregister(&hub_driver);
3874 } /* usb_hub_cleanup() */
3876 static int descriptors_changed(struct usb_device *udev,
3877 struct usb_device_descriptor *old_device_descriptor)
3881 unsigned serial_len = 0;
3883 unsigned old_length;
3887 if (memcmp(&udev->descriptor, old_device_descriptor,
3888 sizeof(*old_device_descriptor)) != 0)
3891 /* Since the idVendor, idProduct, and bcdDevice values in the
3892 * device descriptor haven't changed, we will assume the
3893 * Manufacturer and Product strings haven't changed either.
3894 * But the SerialNumber string could be different (e.g., a
3895 * different flash card of the same brand).
3898 serial_len = strlen(udev->serial) + 1;
3901 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3902 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3903 len = max(len, old_length);
3906 buf = kmalloc(len, GFP_NOIO);
3908 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
3909 /* assume the worst */
3912 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3913 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3914 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
3916 if (length != old_length) {
3917 dev_dbg(&udev->dev, "config index %d, error %d\n",
3922 if (memcmp (buf, udev->rawdescriptors[index], old_length)
3924 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
3926 ((struct usb_config_descriptor *) buf)->
3927 bConfigurationValue);
3933 if (!changed && serial_len) {
3934 length = usb_string(udev, udev->descriptor.iSerialNumber,
3936 if (length + 1 != serial_len) {
3937 dev_dbg(&udev->dev, "serial string error %d\n",
3940 } else if (memcmp(buf, udev->serial, length) != 0) {
3941 dev_dbg(&udev->dev, "serial string changed\n");
3951 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
3952 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3954 * WARNING - don't use this routine to reset a composite device
3955 * (one with multiple interfaces owned by separate drivers)!
3956 * Use usb_reset_device() instead.
3958 * Do a port reset, reassign the device's address, and establish its
3959 * former operating configuration. If the reset fails, or the device's
3960 * descriptors change from their values before the reset, or the original
3961 * configuration and altsettings cannot be restored, a flag will be set
3962 * telling khubd to pretend the device has been disconnected and then
3963 * re-connected. All drivers will be unbound, and the device will be
3964 * re-enumerated and probed all over again.
3966 * Returns 0 if the reset succeeded, -ENODEV if the device has been
3967 * flagged for logical disconnection, or some other negative error code
3968 * if the reset wasn't even attempted.
3970 * The caller must own the device lock. For example, it's safe to use
3971 * this from a driver probe() routine after downloading new firmware.
3972 * For calls that might not occur during probe(), drivers should lock
3973 * the device using usb_lock_device_for_reset().
3975 * Locking exception: This routine may also be called from within an
3976 * autoresume handler. Such usage won't conflict with other tasks
3977 * holding the device lock because these tasks should always call
3978 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
3980 static int usb_reset_and_verify_device(struct usb_device *udev)
3982 struct usb_device *parent_hdev = udev->parent;
3983 struct usb_hub *parent_hub;
3984 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3985 struct usb_device_descriptor descriptor = udev->descriptor;
3987 int port1 = udev->portnum;
3989 if (udev->state == USB_STATE_NOTATTACHED ||
3990 udev->state == USB_STATE_SUSPENDED) {
3991 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3997 /* this requires hcd-specific logic; see ohci_restart() */
3998 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
4001 parent_hub = hdev_to_hub(parent_hdev);
4003 set_bit(port1, parent_hub->busy_bits);
4004 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
4006 /* ep0 maxpacket size may change; let the HCD know about it.
4007 * Other endpoints will be handled by re-enumeration. */
4008 usb_ep0_reinit(udev);
4009 ret = hub_port_init(parent_hub, udev, port1, i);
4010 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
4013 clear_bit(port1, parent_hub->busy_bits);
4018 /* Device might have changed firmware (DFU or similar) */
4019 if (descriptors_changed(udev, &descriptor)) {
4020 dev_info(&udev->dev, "device firmware changed\n");
4021 udev->descriptor = descriptor; /* for disconnect() calls */
4025 /* Restore the device's previous configuration */
4026 if (!udev->actconfig)
4029 mutex_lock(hcd->bandwidth_mutex);
4030 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
4032 dev_warn(&udev->dev,
4033 "Busted HC? Not enough HCD resources for "
4034 "old configuration.\n");
4035 mutex_unlock(hcd->bandwidth_mutex);
4038 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
4039 USB_REQ_SET_CONFIGURATION, 0,
4040 udev->actconfig->desc.bConfigurationValue, 0,
4041 NULL, 0, USB_CTRL_SET_TIMEOUT);
4044 "can't restore configuration #%d (error=%d)\n",
4045 udev->actconfig->desc.bConfigurationValue, ret);
4046 mutex_unlock(hcd->bandwidth_mutex);
4049 mutex_unlock(hcd->bandwidth_mutex);
4050 usb_set_device_state(udev, USB_STATE_CONFIGURED);
4052 /* Put interfaces back into the same altsettings as before.
4053 * Don't bother to send the Set-Interface request for interfaces
4054 * that were already in altsetting 0; besides being unnecessary,
4055 * many devices can't handle it. Instead just reset the host-side
4058 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
4059 struct usb_host_config *config = udev->actconfig;
4060 struct usb_interface *intf = config->interface[i];
4061 struct usb_interface_descriptor *desc;
4063 desc = &intf->cur_altsetting->desc;
4064 if (desc->bAlternateSetting == 0) {
4065 usb_disable_interface(udev, intf, true);
4066 usb_enable_interface(udev, intf, true);
4069 /* Let the bandwidth allocation function know that this
4070 * device has been reset, and it will have to use
4071 * alternate setting 0 as the current alternate setting.
4073 intf->resetting_device = 1;
4074 ret = usb_set_interface(udev, desc->bInterfaceNumber,
4075 desc->bAlternateSetting);
4076 intf->resetting_device = 0;
4079 dev_err(&udev->dev, "failed to restore interface %d "
4080 "altsetting %d (error=%d)\n",
4081 desc->bInterfaceNumber,
4082 desc->bAlternateSetting,
4092 hub_port_logical_disconnect(parent_hub, port1);
4097 * usb_reset_device - warn interface drivers and perform a USB port reset
4098 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
4100 * Warns all drivers bound to registered interfaces (using their pre_reset
4101 * method), performs the port reset, and then lets the drivers know that
4102 * the reset is over (using their post_reset method).
4104 * Return value is the same as for usb_reset_and_verify_device().
4106 * The caller must own the device lock. For example, it's safe to use
4107 * this from a driver probe() routine after downloading new firmware.
4108 * For calls that might not occur during probe(), drivers should lock
4109 * the device using usb_lock_device_for_reset().
4111 * If an interface is currently being probed or disconnected, we assume
4112 * its driver knows how to handle resets. For all other interfaces,
4113 * if the driver doesn't have pre_reset and post_reset methods then
4114 * we attempt to unbind it and rebind afterward.
4116 int usb_reset_device(struct usb_device *udev)
4120 struct usb_host_config *config = udev->actconfig;
4122 if (udev->state == USB_STATE_NOTATTACHED ||
4123 udev->state == USB_STATE_SUSPENDED) {
4124 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
4129 /* Prevent autosuspend during the reset */
4130 usb_autoresume_device(udev);
4133 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
4134 struct usb_interface *cintf = config->interface[i];
4135 struct usb_driver *drv;
4138 if (cintf->dev.driver) {
4139 drv = to_usb_driver(cintf->dev.driver);
4140 if (drv->pre_reset && drv->post_reset)
4141 unbind = (drv->pre_reset)(cintf);
4142 else if (cintf->condition ==
4143 USB_INTERFACE_BOUND)
4146 usb_forced_unbind_intf(cintf);
4151 ret = usb_reset_and_verify_device(udev);
4154 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
4155 struct usb_interface *cintf = config->interface[i];
4156 struct usb_driver *drv;
4157 int rebind = cintf->needs_binding;
4159 if (!rebind && cintf->dev.driver) {
4160 drv = to_usb_driver(cintf->dev.driver);
4161 if (drv->post_reset)
4162 rebind = (drv->post_reset)(cintf);
4163 else if (cintf->condition ==
4164 USB_INTERFACE_BOUND)
4167 if (ret == 0 && rebind)
4168 usb_rebind_intf(cintf);
4172 usb_autosuspend_device(udev);
4175 EXPORT_SYMBOL_GPL(usb_reset_device);
4179 * usb_queue_reset_device - Reset a USB device from an atomic context
4180 * @iface: USB interface belonging to the device to reset
4182 * This function can be used to reset a USB device from an atomic
4183 * context, where usb_reset_device() won't work (as it blocks).
4185 * Doing a reset via this method is functionally equivalent to calling
4186 * usb_reset_device(), except for the fact that it is delayed to a
4187 * workqueue. This means that any drivers bound to other interfaces
4188 * might be unbound, as well as users from usbfs in user space.
4192 * - Scheduling two resets at the same time from two different drivers
4193 * attached to two different interfaces of the same device is
4194 * possible; depending on how the driver attached to each interface
4195 * handles ->pre_reset(), the second reset might happen or not.
4197 * - If a driver is unbound and it had a pending reset, the reset will
4200 * - This function can be called during .probe() or .disconnect()
4201 * times. On return from .disconnect(), any pending resets will be
4204 * There is no no need to lock/unlock the @reset_ws as schedule_work()
4207 * NOTE: We don't do any reference count tracking because it is not
4208 * needed. The lifecycle of the work_struct is tied to the
4209 * usb_interface. Before destroying the interface we cancel the
4210 * work_struct, so the fact that work_struct is queued and or
4211 * running means the interface (and thus, the device) exist and
4214 void usb_queue_reset_device(struct usb_interface *iface)
4216 schedule_work(&iface->reset_ws);
4218 EXPORT_SYMBOL_GPL(usb_queue_reset_device);