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 #if USB_MAXCHILDREN > 31 /* 8*sizeof(unsigned long) - 1 */
66 #error event_bits[] is too short!
69 struct usb_hub_descriptor *descriptor; /* class descriptor */
70 struct usb_tt tt; /* Transaction Translator */
72 unsigned mA_per_port; /* current for each child */
74 unsigned limited_power:1;
76 unsigned disconnected:1;
78 unsigned has_indicators:1;
79 u8 indicator[USB_MAXCHILDREN];
80 struct delayed_work leds;
81 struct delayed_work init_work;
86 /* Protect struct usb_device->state and ->children members
87 * Note: Both are also protected by ->dev.sem, except that ->state can
88 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
89 static DEFINE_SPINLOCK(device_state_lock);
91 /* khubd's worklist and its lock */
92 static DEFINE_SPINLOCK(hub_event_lock);
93 static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
96 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
98 static struct task_struct *khubd_task;
100 /* cycle leds on hubs that aren't blinking for attention */
101 static int blinkenlights = 0;
102 module_param (blinkenlights, bool, S_IRUGO);
103 MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
106 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
107 * 10 seconds to send reply for the initial 64-byte descriptor request.
109 /* define initial 64-byte descriptor request timeout in milliseconds */
110 static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
111 module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
112 MODULE_PARM_DESC(initial_descriptor_timeout,
113 "initial 64-byte descriptor request timeout in milliseconds "
114 "(default 5000 - 5.0 seconds)");
117 * As of 2.6.10 we introduce a new USB device initialization scheme which
118 * closely resembles the way Windows works. Hopefully it will be compatible
119 * with a wider range of devices than the old scheme. However some previously
120 * working devices may start giving rise to "device not accepting address"
121 * errors; if that happens the user can try the old scheme by adjusting the
122 * following module parameters.
124 * For maximum flexibility there are two boolean parameters to control the
125 * hub driver's behavior. On the first initialization attempt, if the
126 * "old_scheme_first" parameter is set then the old scheme will be used,
127 * otherwise the new scheme is used. If that fails and "use_both_schemes"
128 * is set, then the driver will make another attempt, using the other scheme.
130 static int old_scheme_first = 0;
131 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
132 MODULE_PARM_DESC(old_scheme_first,
133 "start with the old device initialization scheme");
135 static int use_both_schemes = 1;
136 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
137 MODULE_PARM_DESC(use_both_schemes,
138 "try the other device initialization scheme if the "
141 /* Mutual exclusion for EHCI CF initialization. This interferes with
142 * port reset on some companion controllers.
144 DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
145 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
147 #define HUB_DEBOUNCE_TIMEOUT 1500
148 #define HUB_DEBOUNCE_STEP 25
149 #define HUB_DEBOUNCE_STABLE 100
152 static int usb_reset_and_verify_device(struct usb_device *udev);
154 static inline char *portspeed(int portstatus)
156 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
158 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
160 else if (portstatus & USB_PORT_STAT_SUPER_SPEED)
166 /* Note that hdev or one of its children must be locked! */
167 static struct usb_hub *hdev_to_hub(struct usb_device *hdev)
169 if (!hdev || !hdev->actconfig)
171 return usb_get_intfdata(hdev->actconfig->interface[0]);
174 /* USB 2.0 spec Section 11.24.4.5 */
175 static int get_hub_descriptor(struct usb_device *hdev, void *data, int size)
179 for (i = 0; i < 3; i++) {
180 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
181 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
182 USB_DT_HUB << 8, 0, data, size,
183 USB_CTRL_GET_TIMEOUT);
184 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
191 * USB 2.0 spec Section 11.24.2.1
193 static int clear_hub_feature(struct usb_device *hdev, int feature)
195 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
196 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
200 * USB 2.0 spec Section 11.24.2.2
202 static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
204 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
205 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
210 * USB 2.0 spec Section 11.24.2.13
212 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
214 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
215 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
220 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
221 * for info about using port indicators
223 static void set_port_led(
229 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
230 USB_PORT_FEAT_INDICATOR);
232 dev_dbg (hub->intfdev,
233 "port %d indicator %s status %d\n",
235 ({ char *s; switch (selector) {
236 case HUB_LED_AMBER: s = "amber"; break;
237 case HUB_LED_GREEN: s = "green"; break;
238 case HUB_LED_OFF: s = "off"; break;
239 case HUB_LED_AUTO: s = "auto"; break;
240 default: s = "??"; break;
245 #define LED_CYCLE_PERIOD ((2*HZ)/3)
247 static void led_work (struct work_struct *work)
249 struct usb_hub *hub =
250 container_of(work, struct usb_hub, leds.work);
251 struct usb_device *hdev = hub->hdev;
253 unsigned changed = 0;
256 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
259 for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
260 unsigned selector, mode;
262 /* 30%-50% duty cycle */
264 switch (hub->indicator[i]) {
266 case INDICATOR_CYCLE:
268 selector = HUB_LED_AUTO;
269 mode = INDICATOR_AUTO;
271 /* blinking green = sw attention */
272 case INDICATOR_GREEN_BLINK:
273 selector = HUB_LED_GREEN;
274 mode = INDICATOR_GREEN_BLINK_OFF;
276 case INDICATOR_GREEN_BLINK_OFF:
277 selector = HUB_LED_OFF;
278 mode = INDICATOR_GREEN_BLINK;
280 /* blinking amber = hw attention */
281 case INDICATOR_AMBER_BLINK:
282 selector = HUB_LED_AMBER;
283 mode = INDICATOR_AMBER_BLINK_OFF;
285 case INDICATOR_AMBER_BLINK_OFF:
286 selector = HUB_LED_OFF;
287 mode = INDICATOR_AMBER_BLINK;
289 /* blink green/amber = reserved */
290 case INDICATOR_ALT_BLINK:
291 selector = HUB_LED_GREEN;
292 mode = INDICATOR_ALT_BLINK_OFF;
294 case INDICATOR_ALT_BLINK_OFF:
295 selector = HUB_LED_AMBER;
296 mode = INDICATOR_ALT_BLINK;
301 if (selector != HUB_LED_AUTO)
303 set_port_led(hub, i + 1, selector);
304 hub->indicator[i] = mode;
306 if (!changed && blinkenlights) {
308 cursor %= hub->descriptor->bNbrPorts;
309 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
310 hub->indicator[cursor] = INDICATOR_CYCLE;
314 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
317 /* use a short timeout for hub/port status fetches */
318 #define USB_STS_TIMEOUT 1000
319 #define USB_STS_RETRIES 5
322 * USB 2.0 spec Section 11.24.2.6
324 static int get_hub_status(struct usb_device *hdev,
325 struct usb_hub_status *data)
327 int i, status = -ETIMEDOUT;
329 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
330 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
331 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
332 data, sizeof(*data), USB_STS_TIMEOUT);
338 * USB 2.0 spec Section 11.24.2.7
340 static int get_port_status(struct usb_device *hdev, int port1,
341 struct usb_port_status *data)
343 int i, status = -ETIMEDOUT;
345 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
346 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
347 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
348 data, sizeof(*data), USB_STS_TIMEOUT);
353 static int hub_port_status(struct usb_hub *hub, int port1,
354 u16 *status, u16 *change)
358 mutex_lock(&hub->status_mutex);
359 ret = get_port_status(hub->hdev, port1, &hub->status->port);
361 dev_err(hub->intfdev,
362 "%s failed (err = %d)\n", __func__, ret);
366 *status = le16_to_cpu(hub->status->port.wPortStatus);
367 *change = le16_to_cpu(hub->status->port.wPortChange);
370 mutex_unlock(&hub->status_mutex);
374 static void kick_khubd(struct usb_hub *hub)
378 spin_lock_irqsave(&hub_event_lock, flags);
379 if (!hub->disconnected && list_empty(&hub->event_list)) {
380 list_add_tail(&hub->event_list, &hub_event_list);
382 /* Suppress autosuspend until khubd runs */
383 usb_autopm_get_interface_no_resume(
384 to_usb_interface(hub->intfdev));
385 wake_up(&khubd_wait);
387 spin_unlock_irqrestore(&hub_event_lock, flags);
390 void usb_kick_khubd(struct usb_device *hdev)
392 struct usb_hub *hub = hdev_to_hub(hdev);
399 /* completion function, fires on port status changes and various faults */
400 static void hub_irq(struct urb *urb)
402 struct usb_hub *hub = urb->context;
403 int status = urb->status;
408 case -ENOENT: /* synchronous unlink */
409 case -ECONNRESET: /* async unlink */
410 case -ESHUTDOWN: /* hardware going away */
413 default: /* presumably an error */
414 /* Cause a hub reset after 10 consecutive errors */
415 dev_dbg (hub->intfdev, "transfer --> %d\n", status);
416 if ((++hub->nerrors < 10) || hub->error)
421 /* let khubd handle things */
422 case 0: /* we got data: port status changed */
424 for (i = 0; i < urb->actual_length; ++i)
425 bits |= ((unsigned long) ((*hub->buffer)[i]))
427 hub->event_bits[0] = bits;
433 /* Something happened, let khubd figure it out */
440 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
441 && status != -ENODEV && status != -EPERM)
442 dev_err (hub->intfdev, "resubmit --> %d\n", status);
445 /* USB 2.0 spec Section 11.24.2.3 */
447 hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
449 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
450 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
455 * enumeration blocks khubd for a long time. we use keventd instead, since
456 * long blocking there is the exception, not the rule. accordingly, HCDs
457 * talking to TTs must queue control transfers (not just bulk and iso), so
458 * both can talk to the same hub concurrently.
460 static void hub_tt_work(struct work_struct *work)
462 struct usb_hub *hub =
463 container_of(work, struct usb_hub, tt.clear_work);
467 spin_lock_irqsave (&hub->tt.lock, flags);
468 while (--limit && !list_empty (&hub->tt.clear_list)) {
469 struct list_head *next;
470 struct usb_tt_clear *clear;
471 struct usb_device *hdev = hub->hdev;
472 const struct hc_driver *drv;
475 next = hub->tt.clear_list.next;
476 clear = list_entry (next, struct usb_tt_clear, clear_list);
477 list_del (&clear->clear_list);
479 /* drop lock so HCD can concurrently report other TT errors */
480 spin_unlock_irqrestore (&hub->tt.lock, flags);
481 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
484 "clear tt %d (%04x) error %d\n",
485 clear->tt, clear->devinfo, status);
487 /* Tell the HCD, even if the operation failed */
488 drv = clear->hcd->driver;
489 if (drv->clear_tt_buffer_complete)
490 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
493 spin_lock_irqsave(&hub->tt.lock, flags);
495 spin_unlock_irqrestore (&hub->tt.lock, flags);
499 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
500 * @urb: an URB associated with the failed or incomplete split transaction
502 * High speed HCDs use this to tell the hub driver that some split control or
503 * bulk transaction failed in a way that requires clearing internal state of
504 * a transaction translator. This is normally detected (and reported) from
507 * It may not be possible for that hub to handle additional full (or low)
508 * speed transactions until that state is fully cleared out.
510 int usb_hub_clear_tt_buffer(struct urb *urb)
512 struct usb_device *udev = urb->dev;
513 int pipe = urb->pipe;
514 struct usb_tt *tt = udev->tt;
516 struct usb_tt_clear *clear;
518 /* we've got to cope with an arbitrary number of pending TT clears,
519 * since each TT has "at least two" buffers that can need it (and
520 * there can be many TTs per hub). even if they're uncommon.
522 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
523 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
524 /* FIXME recover somehow ... RESET_TT? */
528 /* info that CLEAR_TT_BUFFER needs */
529 clear->tt = tt->multi ? udev->ttport : 1;
530 clear->devinfo = usb_pipeendpoint (pipe);
531 clear->devinfo |= udev->devnum << 4;
532 clear->devinfo |= usb_pipecontrol (pipe)
533 ? (USB_ENDPOINT_XFER_CONTROL << 11)
534 : (USB_ENDPOINT_XFER_BULK << 11);
535 if (usb_pipein (pipe))
536 clear->devinfo |= 1 << 15;
538 /* info for completion callback */
539 clear->hcd = bus_to_hcd(udev->bus);
542 /* tell keventd to clear state for this TT */
543 spin_lock_irqsave (&tt->lock, flags);
544 list_add_tail (&clear->clear_list, &tt->clear_list);
545 schedule_work(&tt->clear_work);
546 spin_unlock_irqrestore (&tt->lock, flags);
549 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
551 /* If do_delay is false, return the number of milliseconds the caller
554 static unsigned hub_power_on(struct usb_hub *hub, bool do_delay)
557 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
559 u16 wHubCharacteristics =
560 le16_to_cpu(hub->descriptor->wHubCharacteristics);
562 /* Enable power on each port. Some hubs have reserved values
563 * of LPSM (> 2) in their descriptors, even though they are
564 * USB 2.0 hubs. Some hubs do not implement port-power switching
565 * but only emulate it. In all cases, the ports won't work
566 * unless we send these messages to the hub.
568 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
569 dev_dbg(hub->intfdev, "enabling power on all ports\n");
571 dev_dbg(hub->intfdev, "trying to enable port power on "
572 "non-switchable hub\n");
573 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
574 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
576 /* Wait at least 100 msec for power to become stable */
577 delay = max(pgood_delay, (unsigned) 100);
583 static int hub_hub_status(struct usb_hub *hub,
584 u16 *status, u16 *change)
588 mutex_lock(&hub->status_mutex);
589 ret = get_hub_status(hub->hdev, &hub->status->hub);
591 dev_err (hub->intfdev,
592 "%s failed (err = %d)\n", __func__, ret);
594 *status = le16_to_cpu(hub->status->hub.wHubStatus);
595 *change = le16_to_cpu(hub->status->hub.wHubChange);
598 mutex_unlock(&hub->status_mutex);
602 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
604 struct usb_device *hdev = hub->hdev;
607 if (hdev->children[port1-1] && set_state)
608 usb_set_device_state(hdev->children[port1-1],
609 USB_STATE_NOTATTACHED);
611 ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
613 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
619 * Disable a port and mark a logical connnect-change event, so that some
620 * time later khubd will disconnect() any existing usb_device on the port
621 * and will re-enumerate if there actually is a device attached.
623 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
625 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
626 hub_port_disable(hub, port1, 1);
628 /* FIXME let caller ask to power down the port:
629 * - some devices won't enumerate without a VBUS power cycle
630 * - SRP saves power that way
631 * - ... new call, TBD ...
632 * That's easy if this hub can switch power per-port, and
633 * khubd reactivates the port later (timer, SRP, etc).
634 * Powerdown must be optional, because of reset/DFU.
637 set_bit(port1, hub->change_bits);
642 * usb_remove_device - disable a device's port on its parent hub
643 * @udev: device to be disabled and removed
644 * Context: @udev locked, must be able to sleep.
646 * After @udev's port has been disabled, khubd is notified and it will
647 * see that the device has been disconnected. When the device is
648 * physically unplugged and something is plugged in, the events will
649 * be received and processed normally.
651 int usb_remove_device(struct usb_device *udev)
654 struct usb_interface *intf;
656 if (!udev->parent) /* Can't remove a root hub */
658 hub = hdev_to_hub(udev->parent);
659 intf = to_usb_interface(hub->intfdev);
661 usb_autopm_get_interface(intf);
662 set_bit(udev->portnum, hub->removed_bits);
663 hub_port_logical_disconnect(hub, udev->portnum);
664 usb_autopm_put_interface(intf);
668 enum hub_activation_type {
669 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
670 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
673 static void hub_init_func2(struct work_struct *ws);
674 static void hub_init_func3(struct work_struct *ws);
676 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
678 struct usb_device *hdev = hub->hdev;
683 bool need_debounce_delay = false;
686 /* Continue a partial initialization */
687 if (type == HUB_INIT2)
689 if (type == HUB_INIT3)
692 /* After a resume, port power should still be on.
693 * For any other type of activation, turn it on.
695 if (type != HUB_RESUME) {
697 /* Speed up system boot by using a delayed_work for the
698 * hub's initial power-up delays. This is pretty awkward
699 * and the implementation looks like a home-brewed sort of
700 * setjmp/longjmp, but it saves at least 100 ms for each
701 * root hub (assuming usbcore is compiled into the kernel
702 * rather than as a module). It adds up.
704 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
705 * because for those activation types the ports have to be
706 * operational when we return. In theory this could be done
707 * for HUB_POST_RESET, but it's easier not to.
709 if (type == HUB_INIT) {
710 delay = hub_power_on(hub, false);
711 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func2);
712 schedule_delayed_work(&hub->init_work,
713 msecs_to_jiffies(delay));
715 /* Suppress autosuspend until init is done */
716 usb_autopm_get_interface_no_resume(
717 to_usb_interface(hub->intfdev));
718 return; /* Continues at init2: below */
719 } else if (type == HUB_RESET_RESUME) {
720 /* The internal host controller state for the hub device
721 * may be gone after a host power loss on system resume.
722 * Update the device's info so the HW knows it's a hub.
724 hcd = bus_to_hcd(hdev->bus);
725 if (hcd->driver->update_hub_device) {
726 ret = hcd->driver->update_hub_device(hcd, hdev,
729 dev_err(hub->intfdev, "Host not "
730 "accepting hub info "
732 dev_err(hub->intfdev, "LS/FS devices "
733 "and hubs may not work "
734 "under this hub\n.");
737 hub_power_on(hub, true);
739 hub_power_on(hub, true);
744 /* Check each port and set hub->change_bits to let khubd know
745 * which ports need attention.
747 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
748 struct usb_device *udev = hdev->children[port1-1];
749 u16 portstatus, portchange;
751 portstatus = portchange = 0;
752 status = hub_port_status(hub, port1, &portstatus, &portchange);
753 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
754 dev_dbg(hub->intfdev,
755 "port %d: status %04x change %04x\n",
756 port1, portstatus, portchange);
758 /* After anything other than HUB_RESUME (i.e., initialization
759 * or any sort of reset), every port should be disabled.
760 * Unconnected ports should likewise be disabled (paranoia),
761 * and so should ports for which we have no usb_device.
763 if ((portstatus & USB_PORT_STAT_ENABLE) && (
764 type != HUB_RESUME ||
765 !(portstatus & USB_PORT_STAT_CONNECTION) ||
767 udev->state == USB_STATE_NOTATTACHED)) {
769 * USB3 protocol ports will automatically transition
770 * to Enabled state when detect an USB3.0 device attach.
771 * Do not disable USB3 protocol ports.
772 * FIXME: USB3 root hub and external hubs are treated
775 if (hdev->descriptor.bDeviceProtocol != 3 ||
777 !(portstatus & USB_PORT_STAT_SUPER_SPEED))) {
778 clear_port_feature(hdev, port1,
779 USB_PORT_FEAT_ENABLE);
780 portstatus &= ~USB_PORT_STAT_ENABLE;
782 /* Pretend that power was lost for USB3 devs */
783 portstatus &= ~USB_PORT_STAT_ENABLE;
787 /* Clear status-change flags; we'll debounce later */
788 if (portchange & USB_PORT_STAT_C_CONNECTION) {
789 need_debounce_delay = true;
790 clear_port_feature(hub->hdev, port1,
791 USB_PORT_FEAT_C_CONNECTION);
793 if (portchange & USB_PORT_STAT_C_ENABLE) {
794 need_debounce_delay = true;
795 clear_port_feature(hub->hdev, port1,
796 USB_PORT_FEAT_C_ENABLE);
799 /* We can forget about a "removed" device when there's a
800 * physical disconnect or the connect status changes.
802 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
803 (portchange & USB_PORT_STAT_C_CONNECTION))
804 clear_bit(port1, hub->removed_bits);
806 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
807 /* Tell khubd to disconnect the device or
808 * check for a new connection
810 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
811 set_bit(port1, hub->change_bits);
813 } else if (portstatus & USB_PORT_STAT_ENABLE) {
814 /* The power session apparently survived the resume.
815 * If there was an overcurrent or suspend change
816 * (i.e., remote wakeup request), have khubd
820 set_bit(port1, hub->change_bits);
822 } else if (udev->persist_enabled) {
824 udev->reset_resume = 1;
826 set_bit(port1, hub->change_bits);
829 /* The power session is gone; tell khubd */
830 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
831 set_bit(port1, hub->change_bits);
835 /* If no port-status-change flags were set, we don't need any
836 * debouncing. If flags were set we can try to debounce the
837 * ports all at once right now, instead of letting khubd do them
838 * one at a time later on.
840 * If any port-status changes do occur during this delay, khubd
841 * will see them later and handle them normally.
843 if (need_debounce_delay) {
844 delay = HUB_DEBOUNCE_STABLE;
846 /* Don't do a long sleep inside a workqueue routine */
847 if (type == HUB_INIT2) {
848 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func3);
849 schedule_delayed_work(&hub->init_work,
850 msecs_to_jiffies(delay));
851 return; /* Continues at init3: below */
859 status = usb_submit_urb(hub->urb, GFP_NOIO);
861 dev_err(hub->intfdev, "activate --> %d\n", status);
862 if (hub->has_indicators && blinkenlights)
863 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
865 /* Scan all ports that need attention */
868 /* Allow autosuspend if it was suppressed */
869 if (type <= HUB_INIT3)
870 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
873 /* Implement the continuations for the delays above */
874 static void hub_init_func2(struct work_struct *ws)
876 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
878 hub_activate(hub, HUB_INIT2);
881 static void hub_init_func3(struct work_struct *ws)
883 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
885 hub_activate(hub, HUB_INIT3);
888 enum hub_quiescing_type {
889 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
892 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
894 struct usb_device *hdev = hub->hdev;
897 cancel_delayed_work_sync(&hub->init_work);
899 /* khubd and related activity won't re-trigger */
902 if (type != HUB_SUSPEND) {
903 /* Disconnect all the children */
904 for (i = 0; i < hdev->maxchild; ++i) {
905 if (hdev->children[i])
906 usb_disconnect(&hdev->children[i]);
910 /* Stop khubd and related activity */
911 usb_kill_urb(hub->urb);
912 if (hub->has_indicators)
913 cancel_delayed_work_sync(&hub->leds);
915 cancel_work_sync(&hub->tt.clear_work);
918 /* caller has locked the hub device */
919 static int hub_pre_reset(struct usb_interface *intf)
921 struct usb_hub *hub = usb_get_intfdata(intf);
923 hub_quiesce(hub, HUB_PRE_RESET);
927 /* caller has locked the hub device */
928 static int hub_post_reset(struct usb_interface *intf)
930 struct usb_hub *hub = usb_get_intfdata(intf);
932 hub_activate(hub, HUB_POST_RESET);
936 static int hub_configure(struct usb_hub *hub,
937 struct usb_endpoint_descriptor *endpoint)
940 struct usb_device *hdev = hub->hdev;
941 struct device *hub_dev = hub->intfdev;
942 u16 hubstatus, hubchange;
943 u16 wHubCharacteristics;
946 char *message = "out of memory";
948 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
954 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
959 mutex_init(&hub->status_mutex);
961 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
962 if (!hub->descriptor) {
967 /* Request the entire hub descriptor.
968 * hub->descriptor can handle USB_MAXCHILDREN ports,
969 * but the hub can/will return fewer bytes here.
971 ret = get_hub_descriptor(hdev, hub->descriptor,
972 sizeof(*hub->descriptor));
974 message = "can't read hub descriptor";
976 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
977 message = "hub has too many ports!";
982 hdev->maxchild = hub->descriptor->bNbrPorts;
983 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
984 (hdev->maxchild == 1) ? "" : "s");
986 hub->port_owners = kzalloc(hdev->maxchild * sizeof(void *), GFP_KERNEL);
987 if (!hub->port_owners) {
992 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
994 if (wHubCharacteristics & HUB_CHAR_COMPOUND) {
996 char portstr [USB_MAXCHILDREN + 1];
998 for (i = 0; i < hdev->maxchild; i++)
999 portstr[i] = hub->descriptor->DeviceRemovable
1000 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1002 portstr[hdev->maxchild] = 0;
1003 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1005 dev_dbg(hub_dev, "standalone hub\n");
1007 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1009 dev_dbg(hub_dev, "ganged power switching\n");
1012 dev_dbg(hub_dev, "individual port power switching\n");
1016 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1020 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1022 dev_dbg(hub_dev, "global over-current protection\n");
1025 dev_dbg(hub_dev, "individual port over-current protection\n");
1029 dev_dbg(hub_dev, "no over-current protection\n");
1033 spin_lock_init (&hub->tt.lock);
1034 INIT_LIST_HEAD (&hub->tt.clear_list);
1035 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1036 switch (hdev->descriptor.bDeviceProtocol) {
1040 dev_dbg(hub_dev, "Single TT\n");
1044 ret = usb_set_interface(hdev, 0, 1);
1046 dev_dbg(hub_dev, "TT per port\n");
1049 dev_err(hub_dev, "Using single TT (err %d)\n",
1054 /* USB 3.0 hubs don't have a TT */
1057 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1058 hdev->descriptor.bDeviceProtocol);
1062 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1063 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1064 case HUB_TTTT_8_BITS:
1065 if (hdev->descriptor.bDeviceProtocol != 0) {
1066 hub->tt.think_time = 666;
1067 dev_dbg(hub_dev, "TT requires at most %d "
1068 "FS bit times (%d ns)\n",
1069 8, hub->tt.think_time);
1072 case HUB_TTTT_16_BITS:
1073 hub->tt.think_time = 666 * 2;
1074 dev_dbg(hub_dev, "TT requires at most %d "
1075 "FS bit times (%d ns)\n",
1076 16, hub->tt.think_time);
1078 case HUB_TTTT_24_BITS:
1079 hub->tt.think_time = 666 * 3;
1080 dev_dbg(hub_dev, "TT requires at most %d "
1081 "FS bit times (%d ns)\n",
1082 24, hub->tt.think_time);
1084 case HUB_TTTT_32_BITS:
1085 hub->tt.think_time = 666 * 4;
1086 dev_dbg(hub_dev, "TT requires at most %d "
1087 "FS bit times (%d ns)\n",
1088 32, hub->tt.think_time);
1092 /* probe() zeroes hub->indicator[] */
1093 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1094 hub->has_indicators = 1;
1095 dev_dbg(hub_dev, "Port indicators are supported\n");
1098 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1099 hub->descriptor->bPwrOn2PwrGood * 2);
1101 /* power budgeting mostly matters with bus-powered hubs,
1102 * and battery-powered root hubs (may provide just 8 mA).
1104 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1106 message = "can't get hub status";
1109 le16_to_cpus(&hubstatus);
1110 if (hdev == hdev->bus->root_hub) {
1111 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
1112 hub->mA_per_port = 500;
1114 hub->mA_per_port = hdev->bus_mA;
1115 hub->limited_power = 1;
1117 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1118 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1119 hub->descriptor->bHubContrCurrent);
1120 hub->limited_power = 1;
1121 if (hdev->maxchild > 0) {
1122 int remaining = hdev->bus_mA -
1123 hub->descriptor->bHubContrCurrent;
1125 if (remaining < hdev->maxchild * 100)
1127 "insufficient power available "
1128 "to use all downstream ports\n");
1129 hub->mA_per_port = 100; /* 7.2.1.1 */
1131 } else { /* Self-powered external hub */
1132 /* FIXME: What about battery-powered external hubs that
1133 * provide less current per port? */
1134 hub->mA_per_port = 500;
1136 if (hub->mA_per_port < 500)
1137 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1140 /* Update the HCD's internal representation of this hub before khubd
1141 * starts getting port status changes for devices under the hub.
1143 hcd = bus_to_hcd(hdev->bus);
1144 if (hcd->driver->update_hub_device) {
1145 ret = hcd->driver->update_hub_device(hcd, hdev,
1146 &hub->tt, GFP_KERNEL);
1148 message = "can't update HCD hub info";
1153 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1155 message = "can't get hub status";
1159 /* local power status reports aren't always correct */
1160 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1161 dev_dbg(hub_dev, "local power source is %s\n",
1162 (hubstatus & HUB_STATUS_LOCAL_POWER)
1163 ? "lost (inactive)" : "good");
1165 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1166 dev_dbg(hub_dev, "%sover-current condition exists\n",
1167 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1169 /* set up the interrupt endpoint
1170 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1171 * bytes as USB2.0[11.12.3] says because some hubs are known
1172 * to send more data (and thus cause overflow). For root hubs,
1173 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1174 * to be big enough for at least USB_MAXCHILDREN ports. */
1175 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1176 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1178 if (maxp > sizeof(*hub->buffer))
1179 maxp = sizeof(*hub->buffer);
1181 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1187 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1188 hub, endpoint->bInterval);
1190 /* maybe cycle the hub leds */
1191 if (hub->has_indicators && blinkenlights)
1192 hub->indicator [0] = INDICATOR_CYCLE;
1194 hub_activate(hub, HUB_INIT);
1198 dev_err (hub_dev, "config failed, %s (err %d)\n",
1200 /* hub_disconnect() frees urb and descriptor */
1204 static void hub_release(struct kref *kref)
1206 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1208 usb_put_intf(to_usb_interface(hub->intfdev));
1212 static unsigned highspeed_hubs;
1214 static void hub_disconnect(struct usb_interface *intf)
1216 struct usb_hub *hub = usb_get_intfdata (intf);
1218 /* Take the hub off the event list and don't let it be added again */
1219 spin_lock_irq(&hub_event_lock);
1220 if (!list_empty(&hub->event_list)) {
1221 list_del_init(&hub->event_list);
1222 usb_autopm_put_interface_no_suspend(intf);
1224 hub->disconnected = 1;
1225 spin_unlock_irq(&hub_event_lock);
1227 /* Disconnect all children and quiesce the hub */
1229 hub_quiesce(hub, HUB_DISCONNECT);
1231 usb_set_intfdata (intf, NULL);
1232 hub->hdev->maxchild = 0;
1234 if (hub->hdev->speed == USB_SPEED_HIGH)
1237 usb_free_urb(hub->urb);
1238 kfree(hub->port_owners);
1239 kfree(hub->descriptor);
1243 kref_put(&hub->kref, hub_release);
1246 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1248 struct usb_host_interface *desc;
1249 struct usb_endpoint_descriptor *endpoint;
1250 struct usb_device *hdev;
1251 struct usb_hub *hub;
1253 desc = intf->cur_altsetting;
1254 hdev = interface_to_usbdev(intf);
1256 /* Hubs have proper suspend/resume support */
1257 usb_enable_autosuspend(hdev);
1259 if (hdev->level == MAX_TOPO_LEVEL) {
1261 "Unsupported bus topology: hub nested too deep\n");
1265 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1267 dev_warn(&intf->dev, "ignoring external hub\n");
1272 /* Some hubs have a subclass of 1, which AFAICT according to the */
1273 /* specs is not defined, but it works */
1274 if ((desc->desc.bInterfaceSubClass != 0) &&
1275 (desc->desc.bInterfaceSubClass != 1)) {
1277 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1281 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1282 if (desc->desc.bNumEndpoints != 1)
1283 goto descriptor_error;
1285 endpoint = &desc->endpoint[0].desc;
1287 /* If it's not an interrupt in endpoint, we'd better punt! */
1288 if (!usb_endpoint_is_int_in(endpoint))
1289 goto descriptor_error;
1291 /* We found a hub */
1292 dev_info (&intf->dev, "USB hub found\n");
1294 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1296 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1300 kref_init(&hub->kref);
1301 INIT_LIST_HEAD(&hub->event_list);
1302 hub->intfdev = &intf->dev;
1304 INIT_DELAYED_WORK(&hub->leds, led_work);
1305 INIT_DELAYED_WORK(&hub->init_work, NULL);
1308 usb_set_intfdata (intf, hub);
1309 intf->needs_remote_wakeup = 1;
1311 if (hdev->speed == USB_SPEED_HIGH)
1314 if (hub_configure(hub, endpoint) >= 0)
1317 hub_disconnect (intf);
1323 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1325 struct usb_device *hdev = interface_to_usbdev (intf);
1327 /* assert ifno == 0 (part of hub spec) */
1329 case USBDEVFS_HUB_PORTINFO: {
1330 struct usbdevfs_hub_portinfo *info = user_data;
1333 spin_lock_irq(&device_state_lock);
1334 if (hdev->devnum <= 0)
1337 info->nports = hdev->maxchild;
1338 for (i = 0; i < info->nports; i++) {
1339 if (hdev->children[i] == NULL)
1343 hdev->children[i]->devnum;
1346 spin_unlock_irq(&device_state_lock);
1348 return info->nports + 1;
1357 * Allow user programs to claim ports on a hub. When a device is attached
1358 * to one of these "claimed" ports, the program will "own" the device.
1360 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1363 if (hdev->state == USB_STATE_NOTATTACHED)
1365 if (port1 == 0 || port1 > hdev->maxchild)
1368 /* This assumes that devices not managed by the hub driver
1369 * will always have maxchild equal to 0.
1371 *ppowner = &(hdev_to_hub(hdev)->port_owners[port1 - 1]);
1375 /* In the following three functions, the caller must hold hdev's lock */
1376 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1, void *owner)
1381 rc = find_port_owner(hdev, port1, &powner);
1390 int usb_hub_release_port(struct usb_device *hdev, unsigned port1, void *owner)
1395 rc = find_port_owner(hdev, port1, &powner);
1398 if (*powner != owner)
1404 void usb_hub_release_all_ports(struct usb_device *hdev, void *owner)
1409 n = find_port_owner(hdev, 1, &powner);
1411 for (; n < hdev->maxchild; (++n, ++powner)) {
1412 if (*powner == owner)
1418 /* The caller must hold udev's lock */
1419 bool usb_device_is_owned(struct usb_device *udev)
1421 struct usb_hub *hub;
1423 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1425 hub = hdev_to_hub(udev->parent);
1426 return !!hub->port_owners[udev->portnum - 1];
1430 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1434 for (i = 0; i < udev->maxchild; ++i) {
1435 if (udev->children[i])
1436 recursively_mark_NOTATTACHED(udev->children[i]);
1438 if (udev->state == USB_STATE_SUSPENDED)
1439 udev->active_duration -= jiffies;
1440 udev->state = USB_STATE_NOTATTACHED;
1444 * usb_set_device_state - change a device's current state (usbcore, hcds)
1445 * @udev: pointer to device whose state should be changed
1446 * @new_state: new state value to be stored
1448 * udev->state is _not_ fully protected by the device lock. Although
1449 * most transitions are made only while holding the lock, the state can
1450 * can change to USB_STATE_NOTATTACHED at almost any time. This
1451 * is so that devices can be marked as disconnected as soon as possible,
1452 * without having to wait for any semaphores to be released. As a result,
1453 * all changes to any device's state must be protected by the
1454 * device_state_lock spinlock.
1456 * Once a device has been added to the device tree, all changes to its state
1457 * should be made using this routine. The state should _not_ be set directly.
1459 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1460 * Otherwise udev->state is set to new_state, and if new_state is
1461 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1462 * to USB_STATE_NOTATTACHED.
1464 void usb_set_device_state(struct usb_device *udev,
1465 enum usb_device_state new_state)
1467 unsigned long flags;
1469 spin_lock_irqsave(&device_state_lock, flags);
1470 if (udev->state == USB_STATE_NOTATTACHED)
1472 else if (new_state != USB_STATE_NOTATTACHED) {
1474 /* root hub wakeup capabilities are managed out-of-band
1475 * and may involve silicon errata ... ignore them here.
1478 if (udev->state == USB_STATE_SUSPENDED
1479 || new_state == USB_STATE_SUSPENDED)
1480 ; /* No change to wakeup settings */
1481 else if (new_state == USB_STATE_CONFIGURED)
1482 device_set_wakeup_capable(&udev->dev,
1483 (udev->actconfig->desc.bmAttributes
1484 & USB_CONFIG_ATT_WAKEUP));
1486 device_set_wakeup_capable(&udev->dev, 0);
1488 if (udev->state == USB_STATE_SUSPENDED &&
1489 new_state != USB_STATE_SUSPENDED)
1490 udev->active_duration -= jiffies;
1491 else if (new_state == USB_STATE_SUSPENDED &&
1492 udev->state != USB_STATE_SUSPENDED)
1493 udev->active_duration += jiffies;
1494 udev->state = new_state;
1496 recursively_mark_NOTATTACHED(udev);
1497 spin_unlock_irqrestore(&device_state_lock, flags);
1499 EXPORT_SYMBOL_GPL(usb_set_device_state);
1502 * WUSB devices are simple: they have no hubs behind, so the mapping
1503 * device <-> virtual port number becomes 1:1. Why? to simplify the
1504 * life of the device connection logic in
1505 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1506 * handshake we need to assign a temporary address in the unauthorized
1507 * space. For simplicity we use the first virtual port number found to
1508 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1509 * and that becomes it's address [X < 128] or its unauthorized address
1512 * We add 1 as an offset to the one-based USB-stack port number
1513 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1514 * 0 is reserved by USB for default address; (b) Linux's USB stack
1515 * uses always #1 for the root hub of the controller. So USB stack's
1516 * port #1, which is wusb virtual-port #0 has address #2.
1518 * Devices connected under xHCI are not as simple. The host controller
1519 * supports virtualization, so the hardware assigns device addresses and
1520 * the HCD must setup data structures before issuing a set address
1521 * command to the hardware.
1523 static void choose_address(struct usb_device *udev)
1526 struct usb_bus *bus = udev->bus;
1528 /* If khubd ever becomes multithreaded, this will need a lock */
1530 devnum = udev->portnum + 1;
1531 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
1533 /* Try to allocate the next devnum beginning at
1534 * bus->devnum_next. */
1535 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1538 devnum = find_next_zero_bit(bus->devmap.devicemap,
1540 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1543 set_bit(devnum, bus->devmap.devicemap);
1544 udev->devnum = devnum;
1548 static void release_address(struct usb_device *udev)
1550 if (udev->devnum > 0) {
1551 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1556 static void update_address(struct usb_device *udev, int devnum)
1558 /* The address for a WUSB device is managed by wusbcore. */
1560 udev->devnum = devnum;
1563 static void hub_free_dev(struct usb_device *udev)
1565 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1567 /* Root hubs aren't real devices, so don't free HCD resources */
1568 if (hcd->driver->free_dev && udev->parent)
1569 hcd->driver->free_dev(hcd, udev);
1573 * usb_disconnect - disconnect a device (usbcore-internal)
1574 * @pdev: pointer to device being disconnected
1575 * Context: !in_interrupt ()
1577 * Something got disconnected. Get rid of it and all of its children.
1579 * If *pdev is a normal device then the parent hub must already be locked.
1580 * If *pdev is a root hub then this routine will acquire the
1581 * usb_bus_list_lock on behalf of the caller.
1583 * Only hub drivers (including virtual root hub drivers for host
1584 * controllers) should ever call this.
1586 * This call is synchronous, and may not be used in an interrupt context.
1588 void usb_disconnect(struct usb_device **pdev)
1590 struct usb_device *udev = *pdev;
1594 pr_debug ("%s nodev\n", __func__);
1598 /* mark the device as inactive, so any further urb submissions for
1599 * this device (and any of its children) will fail immediately.
1600 * this quiesces everyting except pending urbs.
1602 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1603 dev_info (&udev->dev, "USB disconnect, address %d\n", udev->devnum);
1605 usb_lock_device(udev);
1607 /* Free up all the children before we remove this device */
1608 for (i = 0; i < USB_MAXCHILDREN; i++) {
1609 if (udev->children[i])
1610 usb_disconnect(&udev->children[i]);
1613 /* deallocate hcd/hardware state ... nuking all pending urbs and
1614 * cleaning up all state associated with the current configuration
1615 * so that the hardware is now fully quiesced.
1617 dev_dbg (&udev->dev, "unregistering device\n");
1618 usb_disable_device(udev, 0);
1619 usb_hcd_synchronize_unlinks(udev);
1621 usb_remove_ep_devs(&udev->ep0);
1622 usb_unlock_device(udev);
1624 /* Unregister the device. The device driver is responsible
1625 * for de-configuring the device and invoking the remove-device
1626 * notifier chain (used by usbfs and possibly others).
1628 device_del(&udev->dev);
1630 /* Free the device number and delete the parent's children[]
1631 * (or root_hub) pointer.
1633 release_address(udev);
1635 /* Avoid races with recursively_mark_NOTATTACHED() */
1636 spin_lock_irq(&device_state_lock);
1638 spin_unlock_irq(&device_state_lock);
1642 put_device(&udev->dev);
1645 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
1646 static void show_string(struct usb_device *udev, char *id, char *string)
1650 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1653 static void announce_device(struct usb_device *udev)
1655 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
1656 le16_to_cpu(udev->descriptor.idVendor),
1657 le16_to_cpu(udev->descriptor.idProduct));
1658 dev_info(&udev->dev,
1659 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
1660 udev->descriptor.iManufacturer,
1661 udev->descriptor.iProduct,
1662 udev->descriptor.iSerialNumber);
1663 show_string(udev, "Product", udev->product);
1664 show_string(udev, "Manufacturer", udev->manufacturer);
1665 show_string(udev, "SerialNumber", udev->serial);
1668 static inline void announce_device(struct usb_device *udev) { }
1671 #ifdef CONFIG_USB_OTG
1672 #include "otg_whitelist.h"
1676 * usb_enumerate_device_otg - FIXME (usbcore-internal)
1677 * @udev: newly addressed device (in ADDRESS state)
1679 * Finish enumeration for On-The-Go devices
1681 static int usb_enumerate_device_otg(struct usb_device *udev)
1685 #ifdef CONFIG_USB_OTG
1687 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1688 * to wake us after we've powered off VBUS; and HNP, switching roles
1689 * "host" to "peripheral". The OTG descriptor helps figure this out.
1691 if (!udev->bus->is_b_host
1693 && udev->parent == udev->bus->root_hub) {
1694 struct usb_otg_descriptor *desc = NULL;
1695 struct usb_bus *bus = udev->bus;
1697 /* descriptor may appear anywhere in config */
1698 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1699 le16_to_cpu(udev->config[0].desc.wTotalLength),
1700 USB_DT_OTG, (void **) &desc) == 0) {
1701 if (desc->bmAttributes & USB_OTG_HNP) {
1702 unsigned port1 = udev->portnum;
1704 dev_info(&udev->dev,
1705 "Dual-Role OTG device on %sHNP port\n",
1706 (port1 == bus->otg_port)
1709 /* enable HNP before suspend, it's simpler */
1710 if (port1 == bus->otg_port)
1711 bus->b_hnp_enable = 1;
1712 err = usb_control_msg(udev,
1713 usb_sndctrlpipe(udev, 0),
1714 USB_REQ_SET_FEATURE, 0,
1716 ? USB_DEVICE_B_HNP_ENABLE
1717 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1718 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1720 /* OTG MESSAGE: report errors here,
1721 * customize to match your product.
1723 dev_info(&udev->dev,
1724 "can't set HNP mode: %d\n",
1726 bus->b_hnp_enable = 0;
1732 if (!is_targeted(udev)) {
1734 /* Maybe it can talk to us, though we can't talk to it.
1735 * (Includes HNP test device.)
1737 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
1738 err = usb_port_suspend(udev, PMSG_SUSPEND);
1740 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1752 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
1753 * @udev: newly addressed device (in ADDRESS state)
1755 * This is only called by usb_new_device() and usb_authorize_device()
1756 * and FIXME -- all comments that apply to them apply here wrt to
1759 * If the device is WUSB and not authorized, we don't attempt to read
1760 * the string descriptors, as they will be errored out by the device
1761 * until it has been authorized.
1763 static int usb_enumerate_device(struct usb_device *udev)
1767 if (udev->config == NULL) {
1768 err = usb_get_configuration(udev);
1770 dev_err(&udev->dev, "can't read configurations, error %d\n",
1775 if (udev->wusb == 1 && udev->authorized == 0) {
1776 udev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1777 udev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1778 udev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1781 /* read the standard strings and cache them if present */
1782 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1783 udev->manufacturer = usb_cache_string(udev,
1784 udev->descriptor.iManufacturer);
1785 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
1787 err = usb_enumerate_device_otg(udev);
1794 * usb_new_device - perform initial device setup (usbcore-internal)
1795 * @udev: newly addressed device (in ADDRESS state)
1797 * This is called with devices which have been detected but not fully
1798 * enumerated. The device descriptor is available, but not descriptors
1799 * for any device configuration. The caller must have locked either
1800 * the parent hub (if udev is a normal device) or else the
1801 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1802 * udev has already been installed, but udev is not yet visible through
1803 * sysfs or other filesystem code.
1805 * It will return if the device is configured properly or not. Zero if
1806 * the interface was registered with the driver core; else a negative
1809 * This call is synchronous, and may not be used in an interrupt context.
1811 * Only the hub driver or root-hub registrar should ever call this.
1813 int usb_new_device(struct usb_device *udev)
1818 /* Initialize non-root-hub device wakeup to disabled;
1819 * device (un)configuration controls wakeup capable
1820 * sysfs power/wakeup controls wakeup enabled/disabled
1822 device_init_wakeup(&udev->dev, 0);
1825 /* Tell the runtime-PM framework the device is active */
1826 pm_runtime_set_active(&udev->dev);
1827 pm_runtime_get_noresume(&udev->dev);
1828 pm_runtime_use_autosuspend(&udev->dev);
1829 pm_runtime_enable(&udev->dev);
1831 /* By default, forbid autosuspend for all devices. It will be
1832 * allowed for hubs during binding.
1834 usb_disable_autosuspend(udev);
1836 err = usb_enumerate_device(udev); /* Read descriptors */
1839 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
1840 udev->devnum, udev->bus->busnum,
1841 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1842 /* export the usbdev device-node for libusb */
1843 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
1844 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1846 /* Tell the world! */
1847 announce_device(udev);
1849 device_enable_async_suspend(&udev->dev);
1850 /* Register the device. The device driver is responsible
1851 * for configuring the device and invoking the add-device
1852 * notifier chain (used by usbfs and possibly others).
1854 err = device_add(&udev->dev);
1856 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1860 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
1861 usb_mark_last_busy(udev);
1862 pm_runtime_put_sync_autosuspend(&udev->dev);
1866 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1867 pm_runtime_disable(&udev->dev);
1868 pm_runtime_set_suspended(&udev->dev);
1874 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
1875 * @usb_dev: USB device
1877 * Move the USB device to a very basic state where interfaces are disabled
1878 * and the device is in fact unconfigured and unusable.
1880 * We share a lock (that we have) with device_del(), so we need to
1883 int usb_deauthorize_device(struct usb_device *usb_dev)
1885 usb_lock_device(usb_dev);
1886 if (usb_dev->authorized == 0)
1887 goto out_unauthorized;
1889 usb_dev->authorized = 0;
1890 usb_set_configuration(usb_dev, -1);
1892 kfree(usb_dev->product);
1893 usb_dev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1894 kfree(usb_dev->manufacturer);
1895 usb_dev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1896 kfree(usb_dev->serial);
1897 usb_dev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1899 usb_destroy_configuration(usb_dev);
1900 usb_dev->descriptor.bNumConfigurations = 0;
1903 usb_unlock_device(usb_dev);
1908 int usb_authorize_device(struct usb_device *usb_dev)
1912 usb_lock_device(usb_dev);
1913 if (usb_dev->authorized == 1)
1914 goto out_authorized;
1916 result = usb_autoresume_device(usb_dev);
1918 dev_err(&usb_dev->dev,
1919 "can't autoresume for authorization: %d\n", result);
1920 goto error_autoresume;
1922 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
1924 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
1925 "authorization: %d\n", result);
1926 goto error_device_descriptor;
1929 kfree(usb_dev->product);
1930 usb_dev->product = NULL;
1931 kfree(usb_dev->manufacturer);
1932 usb_dev->manufacturer = NULL;
1933 kfree(usb_dev->serial);
1934 usb_dev->serial = NULL;
1936 usb_dev->authorized = 1;
1937 result = usb_enumerate_device(usb_dev);
1939 goto error_enumerate;
1940 /* Choose and set the configuration. This registers the interfaces
1941 * with the driver core and lets interface drivers bind to them.
1943 c = usb_choose_configuration(usb_dev);
1945 result = usb_set_configuration(usb_dev, c);
1947 dev_err(&usb_dev->dev,
1948 "can't set config #%d, error %d\n", c, result);
1949 /* This need not be fatal. The user can try to
1950 * set other configurations. */
1953 dev_info(&usb_dev->dev, "authorized to connect\n");
1956 error_device_descriptor:
1957 usb_autosuspend_device(usb_dev);
1960 usb_unlock_device(usb_dev); // complements locktree
1965 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
1966 static unsigned hub_is_wusb(struct usb_hub *hub)
1968 struct usb_hcd *hcd;
1969 if (hub->hdev->parent != NULL) /* not a root hub? */
1971 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
1972 return hcd->wireless;
1976 #define PORT_RESET_TRIES 5
1977 #define SET_ADDRESS_TRIES 2
1978 #define GET_DESCRIPTOR_TRIES 2
1979 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1980 #define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1982 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1983 #define HUB_SHORT_RESET_TIME 10
1984 #define HUB_LONG_RESET_TIME 200
1985 #define HUB_RESET_TIMEOUT 500
1987 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
1988 struct usb_device *udev, unsigned int delay)
1990 int delay_time, ret;
1994 for (delay_time = 0;
1995 delay_time < HUB_RESET_TIMEOUT;
1996 delay_time += delay) {
1997 /* wait to give the device a chance to reset */
2000 /* read and decode port status */
2001 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2005 /* Device went away? */
2006 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2009 /* bomb out completely if the connection bounced */
2010 if ((portchange & USB_PORT_STAT_C_CONNECTION))
2013 /* if we`ve finished resetting, then break out of the loop */
2014 if (!(portstatus & USB_PORT_STAT_RESET) &&
2015 (portstatus & USB_PORT_STAT_ENABLE)) {
2016 if (hub_is_wusb(hub))
2017 udev->speed = USB_SPEED_WIRELESS;
2018 else if (portstatus & USB_PORT_STAT_SUPER_SPEED)
2019 udev->speed = USB_SPEED_SUPER;
2020 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2021 udev->speed = USB_SPEED_HIGH;
2022 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2023 udev->speed = USB_SPEED_LOW;
2025 udev->speed = USB_SPEED_FULL;
2029 /* switch to the long delay after two short delay failures */
2030 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2031 delay = HUB_LONG_RESET_TIME;
2033 dev_dbg (hub->intfdev,
2034 "port %d not reset yet, waiting %dms\n",
2041 static int hub_port_reset(struct usb_hub *hub, int port1,
2042 struct usb_device *udev, unsigned int delay)
2045 struct usb_hcd *hcd;
2047 hcd = bus_to_hcd(udev->bus);
2048 /* Block EHCI CF initialization during the port reset.
2049 * Some companion controllers don't like it when they mix.
2051 down_read(&ehci_cf_port_reset_rwsem);
2053 /* Reset the port */
2054 for (i = 0; i < PORT_RESET_TRIES; i++) {
2055 status = set_port_feature(hub->hdev,
2056 port1, USB_PORT_FEAT_RESET);
2058 dev_err(hub->intfdev,
2059 "cannot reset port %d (err = %d)\n",
2062 status = hub_port_wait_reset(hub, port1, udev, delay);
2063 if (status && status != -ENOTCONN)
2064 dev_dbg(hub->intfdev,
2065 "port_wait_reset: err = %d\n",
2069 /* return on disconnect or reset */
2072 /* TRSTRCY = 10 ms; plus some extra */
2074 update_address(udev, 0);
2075 if (hcd->driver->reset_device) {
2076 status = hcd->driver->reset_device(hcd, udev);
2078 dev_err(&udev->dev, "Cannot reset "
2079 "HCD device state\n");
2086 clear_port_feature(hub->hdev,
2087 port1, USB_PORT_FEAT_C_RESET);
2088 /* FIXME need disconnect() for NOTATTACHED device */
2089 usb_set_device_state(udev, status
2090 ? USB_STATE_NOTATTACHED
2091 : USB_STATE_DEFAULT);
2095 dev_dbg (hub->intfdev,
2096 "port %d not enabled, trying reset again...\n",
2098 delay = HUB_LONG_RESET_TIME;
2101 dev_err (hub->intfdev,
2102 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2106 up_read(&ehci_cf_port_reset_rwsem);
2112 #define MASK_BITS (USB_PORT_STAT_POWER | USB_PORT_STAT_CONNECTION | \
2113 USB_PORT_STAT_SUSPEND)
2114 #define WANT_BITS (USB_PORT_STAT_POWER | USB_PORT_STAT_CONNECTION)
2116 /* Determine whether the device on a port is ready for a normal resume,
2117 * is ready for a reset-resume, or should be disconnected.
2119 static int check_port_resume_type(struct usb_device *udev,
2120 struct usb_hub *hub, int port1,
2121 int status, unsigned portchange, unsigned portstatus)
2123 /* Is the device still present? */
2124 if (status || (portstatus & MASK_BITS) != WANT_BITS) {
2129 /* Can't do a normal resume if the port isn't enabled,
2130 * so try a reset-resume instead.
2132 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2133 if (udev->persist_enabled)
2134 udev->reset_resume = 1;
2140 dev_dbg(hub->intfdev,
2141 "port %d status %04x.%04x after resume, %d\n",
2142 port1, portchange, portstatus, status);
2143 } else if (udev->reset_resume) {
2145 /* Late port handoff can set status-change bits */
2146 if (portchange & USB_PORT_STAT_C_CONNECTION)
2147 clear_port_feature(hub->hdev, port1,
2148 USB_PORT_FEAT_C_CONNECTION);
2149 if (portchange & USB_PORT_STAT_C_ENABLE)
2150 clear_port_feature(hub->hdev, port1,
2151 USB_PORT_FEAT_C_ENABLE);
2157 #ifdef CONFIG_USB_SUSPEND
2160 * usb_port_suspend - suspend a usb device's upstream port
2161 * @udev: device that's no longer in active use, not a root hub
2162 * Context: must be able to sleep; device not locked; pm locks held
2164 * Suspends a USB device that isn't in active use, conserving power.
2165 * Devices may wake out of a suspend, if anything important happens,
2166 * using the remote wakeup mechanism. They may also be taken out of
2167 * suspend by the host, using usb_port_resume(). It's also routine
2168 * to disconnect devices while they are suspended.
2170 * This only affects the USB hardware for a device; its interfaces
2171 * (and, for hubs, child devices) must already have been suspended.
2173 * Selective port suspend reduces power; most suspended devices draw
2174 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2175 * All devices below the suspended port are also suspended.
2177 * Devices leave suspend state when the host wakes them up. Some devices
2178 * also support "remote wakeup", where the device can activate the USB
2179 * tree above them to deliver data, such as a keypress or packet. In
2180 * some cases, this wakes the USB host.
2182 * Suspending OTG devices may trigger HNP, if that's been enabled
2183 * between a pair of dual-role devices. That will change roles, such
2184 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2186 * Devices on USB hub ports have only one "suspend" state, corresponding
2187 * to ACPI D2, "may cause the device to lose some context".
2188 * State transitions include:
2190 * - suspend, resume ... when the VBUS power link stays live
2191 * - suspend, disconnect ... VBUS lost
2193 * Once VBUS drop breaks the circuit, the port it's using has to go through
2194 * normal re-enumeration procedures, starting with enabling VBUS power.
2195 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2196 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2197 * timer, no SRP, no requests through sysfs.
2199 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
2200 * the root hub for their bus goes into global suspend ... so we don't
2201 * (falsely) update the device power state to say it suspended.
2203 * Returns 0 on success, else negative errno.
2205 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2207 struct usb_hub *hub = hdev_to_hub(udev->parent);
2208 int port1 = udev->portnum;
2211 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
2213 /* enable remote wakeup when appropriate; this lets the device
2214 * wake up the upstream hub (including maybe the root hub).
2216 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2217 * we don't explicitly enable it here.
2219 if (udev->do_remote_wakeup) {
2220 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2221 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2222 USB_DEVICE_REMOTE_WAKEUP, 0,
2224 USB_CTRL_SET_TIMEOUT);
2226 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
2228 /* bail if autosuspend is requested */
2229 if (msg.event & PM_EVENT_AUTO)
2235 status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
2237 dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
2239 /* paranoia: "should not happen" */
2240 if (udev->do_remote_wakeup)
2241 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2242 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2243 USB_DEVICE_REMOTE_WAKEUP, 0,
2245 USB_CTRL_SET_TIMEOUT);
2247 /* device has up to 10 msec to fully suspend */
2248 dev_dbg(&udev->dev, "usb %ssuspend\n",
2249 (msg.event & PM_EVENT_AUTO ? "auto-" : ""));
2250 usb_set_device_state(udev, USB_STATE_SUSPENDED);
2253 usb_mark_last_busy(hub->hdev);
2258 * If the USB "suspend" state is in use (rather than "global suspend"),
2259 * many devices will be individually taken out of suspend state using
2260 * special "resume" signaling. This routine kicks in shortly after
2261 * hardware resume signaling is finished, either because of selective
2262 * resume (by host) or remote wakeup (by device) ... now see what changed
2263 * in the tree that's rooted at this device.
2265 * If @udev->reset_resume is set then the device is reset before the
2266 * status check is done.
2268 static int finish_port_resume(struct usb_device *udev)
2273 /* caller owns the udev device lock */
2274 dev_dbg(&udev->dev, "%s\n",
2275 udev->reset_resume ? "finish reset-resume" : "finish resume");
2277 /* usb ch9 identifies four variants of SUSPENDED, based on what
2278 * state the device resumes to. Linux currently won't see the
2279 * first two on the host side; they'd be inside hub_port_init()
2280 * during many timeouts, but khubd can't suspend until later.
2282 usb_set_device_state(udev, udev->actconfig
2283 ? USB_STATE_CONFIGURED
2284 : USB_STATE_ADDRESS);
2286 /* 10.5.4.5 says not to reset a suspended port if the attached
2287 * device is enabled for remote wakeup. Hence the reset
2288 * operation is carried out here, after the port has been
2291 if (udev->reset_resume)
2293 status = usb_reset_and_verify_device(udev);
2295 /* 10.5.4.5 says be sure devices in the tree are still there.
2296 * For now let's assume the device didn't go crazy on resume,
2297 * and device drivers will know about any resume quirks.
2301 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
2303 status = (status > 0 ? 0 : -ENODEV);
2305 /* If a normal resume failed, try doing a reset-resume */
2306 if (status && !udev->reset_resume && udev->persist_enabled) {
2307 dev_dbg(&udev->dev, "retry with reset-resume\n");
2308 udev->reset_resume = 1;
2309 goto retry_reset_resume;
2314 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
2316 } else if (udev->actconfig) {
2317 le16_to_cpus(&devstatus);
2318 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) {
2319 status = usb_control_msg(udev,
2320 usb_sndctrlpipe(udev, 0),
2321 USB_REQ_CLEAR_FEATURE,
2323 USB_DEVICE_REMOTE_WAKEUP, 0,
2325 USB_CTRL_SET_TIMEOUT);
2328 "disable remote wakeup, status %d\n",
2337 * usb_port_resume - re-activate a suspended usb device's upstream port
2338 * @udev: device to re-activate, not a root hub
2339 * Context: must be able to sleep; device not locked; pm locks held
2341 * This will re-activate the suspended device, increasing power usage
2342 * while letting drivers communicate again with its endpoints.
2343 * USB resume explicitly guarantees that the power session between
2344 * the host and the device is the same as it was when the device
2347 * If @udev->reset_resume is set then this routine won't check that the
2348 * port is still enabled. Furthermore, finish_port_resume() above will
2349 * reset @udev. The end result is that a broken power session can be
2350 * recovered and @udev will appear to persist across a loss of VBUS power.
2352 * For example, if a host controller doesn't maintain VBUS suspend current
2353 * during a system sleep or is reset when the system wakes up, all the USB
2354 * power sessions below it will be broken. This is especially troublesome
2355 * for mass-storage devices containing mounted filesystems, since the
2356 * device will appear to have disconnected and all the memory mappings
2357 * to it will be lost. Using the USB_PERSIST facility, the device can be
2358 * made to appear as if it had not disconnected.
2360 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
2361 * every effort to insure that the same device is present after the
2362 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
2363 * quite possible for a device to remain unaltered but its media to be
2364 * changed. If the user replaces a flash memory card while the system is
2365 * asleep, he will have only himself to blame when the filesystem on the
2366 * new card is corrupted and the system crashes.
2368 * Returns 0 on success, else negative errno.
2370 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
2372 struct usb_hub *hub = hdev_to_hub(udev->parent);
2373 int port1 = udev->portnum;
2375 u16 portchange, portstatus;
2377 /* Skip the initial Clear-Suspend step for a remote wakeup */
2378 status = hub_port_status(hub, port1, &portstatus, &portchange);
2379 if (status == 0 && !(portstatus & USB_PORT_STAT_SUSPEND))
2380 goto SuspendCleared;
2382 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
2384 set_bit(port1, hub->busy_bits);
2386 /* see 7.1.7.7; affects power usage, but not budgeting */
2387 status = clear_port_feature(hub->hdev,
2388 port1, USB_PORT_FEAT_SUSPEND);
2390 dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
2393 /* drive resume for at least 20 msec */
2394 dev_dbg(&udev->dev, "usb %sresume\n",
2395 (msg.event & PM_EVENT_AUTO ? "auto-" : ""));
2398 /* Virtual root hubs can trigger on GET_PORT_STATUS to
2399 * stop resume signaling. Then finish the resume
2402 status = hub_port_status(hub, port1, &portstatus, &portchange);
2404 /* TRSMRCY = 10 msec */
2410 if (portchange & USB_PORT_STAT_C_SUSPEND)
2411 clear_port_feature(hub->hdev, port1,
2412 USB_PORT_FEAT_C_SUSPEND);
2415 clear_bit(port1, hub->busy_bits);
2417 status = check_port_resume_type(udev,
2418 hub, port1, status, portchange, portstatus);
2420 status = finish_port_resume(udev);
2422 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2423 hub_port_logical_disconnect(hub, port1);
2428 /* caller has locked udev */
2429 int usb_remote_wakeup(struct usb_device *udev)
2433 if (udev->state == USB_STATE_SUSPENDED) {
2434 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
2435 status = usb_autoresume_device(udev);
2437 /* Let the drivers do their thing, then... */
2438 usb_autosuspend_device(udev);
2444 #else /* CONFIG_USB_SUSPEND */
2446 /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
2448 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2453 /* However we may need to do a reset-resume */
2455 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
2457 struct usb_hub *hub = hdev_to_hub(udev->parent);
2458 int port1 = udev->portnum;
2460 u16 portchange, portstatus;
2462 status = hub_port_status(hub, port1, &portstatus, &portchange);
2463 status = check_port_resume_type(udev,
2464 hub, port1, status, portchange, portstatus);
2467 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2468 hub_port_logical_disconnect(hub, port1);
2469 } else if (udev->reset_resume) {
2470 dev_dbg(&udev->dev, "reset-resume\n");
2471 status = usb_reset_and_verify_device(udev);
2478 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
2480 struct usb_hub *hub = usb_get_intfdata (intf);
2481 struct usb_device *hdev = hub->hdev;
2484 /* fail if children aren't already suspended */
2485 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
2486 struct usb_device *udev;
2488 udev = hdev->children [port1-1];
2489 if (udev && udev->can_submit) {
2490 if (!(msg.event & PM_EVENT_AUTO))
2491 dev_dbg(&intf->dev, "port %d nyet suspended\n",
2497 dev_dbg(&intf->dev, "%s\n", __func__);
2499 /* stop khubd and related activity */
2500 hub_quiesce(hub, HUB_SUSPEND);
2504 static int hub_resume(struct usb_interface *intf)
2506 struct usb_hub *hub = usb_get_intfdata(intf);
2508 dev_dbg(&intf->dev, "%s\n", __func__);
2509 hub_activate(hub, HUB_RESUME);
2513 static int hub_reset_resume(struct usb_interface *intf)
2515 struct usb_hub *hub = usb_get_intfdata(intf);
2517 dev_dbg(&intf->dev, "%s\n", __func__);
2518 hub_activate(hub, HUB_RESET_RESUME);
2523 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
2524 * @rhdev: struct usb_device for the root hub
2526 * The USB host controller driver calls this function when its root hub
2527 * is resumed and Vbus power has been interrupted or the controller
2528 * has been reset. The routine marks @rhdev as having lost power.
2529 * When the hub driver is resumed it will take notice and carry out
2530 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
2531 * the others will be disconnected.
2533 void usb_root_hub_lost_power(struct usb_device *rhdev)
2535 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
2536 rhdev->reset_resume = 1;
2538 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
2540 #else /* CONFIG_PM */
2542 #define hub_suspend NULL
2543 #define hub_resume NULL
2544 #define hub_reset_resume NULL
2548 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2550 * Between connect detection and reset signaling there must be a delay
2551 * of 100ms at least for debounce and power-settling. The corresponding
2552 * timer shall restart whenever the downstream port detects a disconnect.
2554 * Apparently there are some bluetooth and irda-dongles and a number of
2555 * low-speed devices for which this debounce period may last over a second.
2556 * Not covered by the spec - but easy to deal with.
2558 * This implementation uses a 1500ms total debounce timeout; if the
2559 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2560 * every 25ms for transient disconnects. When the port status has been
2561 * unchanged for 100ms it returns the port status.
2563 static int hub_port_debounce(struct usb_hub *hub, int port1)
2566 int total_time, stable_time = 0;
2567 u16 portchange, portstatus;
2568 unsigned connection = 0xffff;
2570 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2571 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2575 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2576 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2577 stable_time += HUB_DEBOUNCE_STEP;
2578 if (stable_time >= HUB_DEBOUNCE_STABLE)
2582 connection = portstatus & USB_PORT_STAT_CONNECTION;
2585 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2586 clear_port_feature(hub->hdev, port1,
2587 USB_PORT_FEAT_C_CONNECTION);
2590 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2592 msleep(HUB_DEBOUNCE_STEP);
2595 dev_dbg (hub->intfdev,
2596 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2597 port1, total_time, stable_time, portstatus);
2599 if (stable_time < HUB_DEBOUNCE_STABLE)
2604 void usb_ep0_reinit(struct usb_device *udev)
2606 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
2607 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
2608 usb_enable_endpoint(udev, &udev->ep0, true);
2610 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
2612 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2613 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2615 static int hub_set_address(struct usb_device *udev, int devnum)
2618 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2621 * The host controller will choose the device address,
2622 * instead of the core having chosen it earlier
2624 if (!hcd->driver->address_device && devnum <= 1)
2626 if (udev->state == USB_STATE_ADDRESS)
2628 if (udev->state != USB_STATE_DEFAULT)
2630 if (hcd->driver->address_device)
2631 retval = hcd->driver->address_device(hcd, udev);
2633 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2634 USB_REQ_SET_ADDRESS, 0, devnum, 0,
2635 NULL, 0, USB_CTRL_SET_TIMEOUT);
2637 update_address(udev, devnum);
2638 /* Device now using proper address. */
2639 usb_set_device_state(udev, USB_STATE_ADDRESS);
2640 usb_ep0_reinit(udev);
2645 /* Reset device, (re)assign address, get device descriptor.
2646 * Device connection must be stable, no more debouncing needed.
2647 * Returns device in USB_STATE_ADDRESS, except on error.
2649 * If this is called for an already-existing device (as part of
2650 * usb_reset_and_verify_device), the caller must own the device lock. For a
2651 * newly detected device that is not accessible through any global
2652 * pointers, it's not necessary to lock the device.
2655 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2658 static DEFINE_MUTEX(usb_address0_mutex);
2660 struct usb_device *hdev = hub->hdev;
2661 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
2663 unsigned delay = HUB_SHORT_RESET_TIME;
2664 enum usb_device_speed oldspeed = udev->speed;
2666 int devnum = udev->devnum;
2668 /* root hub ports have a slightly longer reset period
2669 * (from USB 2.0 spec, section 7.1.7.5)
2671 if (!hdev->parent) {
2672 delay = HUB_ROOT_RESET_TIME;
2673 if (port1 == hdev->bus->otg_port)
2674 hdev->bus->b_hnp_enable = 0;
2677 /* Some low speed devices have problems with the quick delay, so */
2678 /* be a bit pessimistic with those devices. RHbug #23670 */
2679 if (oldspeed == USB_SPEED_LOW)
2680 delay = HUB_LONG_RESET_TIME;
2682 mutex_lock(&usb_address0_mutex);
2684 if (!udev->config && oldspeed == USB_SPEED_SUPER) {
2685 /* Don't reset USB 3.0 devices during an initial setup */
2686 usb_set_device_state(udev, USB_STATE_DEFAULT);
2688 /* Reset the device; full speed may morph to high speed */
2689 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
2690 retval = hub_port_reset(hub, port1, udev, delay);
2691 if (retval < 0) /* error or disconnect */
2693 /* success, speed is known */
2697 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2698 dev_dbg(&udev->dev, "device reset changed speed!\n");
2701 oldspeed = udev->speed;
2703 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2704 * it's fixed size except for full speed devices.
2705 * For Wireless USB devices, ep0 max packet is always 512 (tho
2706 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
2708 switch (udev->speed) {
2709 case USB_SPEED_SUPER:
2710 case USB_SPEED_WIRELESS: /* fixed at 512 */
2711 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
2713 case USB_SPEED_HIGH: /* fixed at 64 */
2714 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
2716 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
2717 /* to determine the ep0 maxpacket size, try to read
2718 * the device descriptor to get bMaxPacketSize0 and
2719 * then correct our initial guess.
2721 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
2723 case USB_SPEED_LOW: /* fixed at 8 */
2724 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
2731 switch (udev->speed) {
2732 case USB_SPEED_LOW: speed = "low"; break;
2733 case USB_SPEED_FULL: speed = "full"; break;
2734 case USB_SPEED_HIGH: speed = "high"; break;
2735 case USB_SPEED_SUPER:
2738 case USB_SPEED_WIRELESS:
2742 default: speed = "?"; break;
2744 if (udev->speed != USB_SPEED_SUPER)
2745 dev_info(&udev->dev,
2746 "%s %s speed %sUSB device using %s and address %d\n",
2747 (udev->config) ? "reset" : "new", speed, type,
2748 udev->bus->controller->driver->name, devnum);
2750 /* Set up TT records, if needed */
2752 udev->tt = hdev->tt;
2753 udev->ttport = hdev->ttport;
2754 } else if (udev->speed != USB_SPEED_HIGH
2755 && hdev->speed == USB_SPEED_HIGH) {
2757 dev_err(&udev->dev, "parent hub has no TT\n");
2761 udev->tt = &hub->tt;
2762 udev->ttport = port1;
2765 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2766 * Because device hardware and firmware is sometimes buggy in
2767 * this area, and this is how Linux has done it for ages.
2768 * Change it cautiously.
2770 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2771 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2772 * so it may help with some non-standards-compliant devices.
2773 * Otherwise we start with SET_ADDRESS and then try to read the
2774 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2777 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
2779 * An xHCI controller cannot send any packets to a device until
2780 * a set address command successfully completes.
2782 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3)) {
2783 struct usb_device_descriptor *buf;
2786 #define GET_DESCRIPTOR_BUFSIZE 64
2787 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2793 /* Retry on all errors; some devices are flakey.
2794 * 255 is for WUSB devices, we actually need to use
2795 * 512 (WUSB1.0[4.8.1]).
2797 for (j = 0; j < 3; ++j) {
2798 buf->bMaxPacketSize0 = 0;
2799 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2800 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2801 USB_DT_DEVICE << 8, 0,
2802 buf, GET_DESCRIPTOR_BUFSIZE,
2803 initial_descriptor_timeout);
2804 switch (buf->bMaxPacketSize0) {
2805 case 8: case 16: case 32: case 64: case 255:
2806 if (buf->bDescriptorType ==
2820 udev->descriptor.bMaxPacketSize0 =
2821 buf->bMaxPacketSize0;
2824 retval = hub_port_reset(hub, port1, udev, delay);
2825 if (retval < 0) /* error or disconnect */
2827 if (oldspeed != udev->speed) {
2829 "device reset changed speed!\n");
2835 "device descriptor read/64, error %d\n",
2840 #undef GET_DESCRIPTOR_BUFSIZE
2844 * If device is WUSB, we already assigned an
2845 * unauthorized address in the Connect Ack sequence;
2846 * authorization will assign the final address.
2848 if (udev->wusb == 0) {
2849 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
2850 retval = hub_set_address(udev, devnum);
2857 "device not accepting address %d, error %d\n",
2861 if (udev->speed == USB_SPEED_SUPER) {
2862 devnum = udev->devnum;
2863 dev_info(&udev->dev,
2864 "%s SuperSpeed USB device using %s and address %d\n",
2865 (udev->config) ? "reset" : "new",
2866 udev->bus->controller->driver->name, devnum);
2869 /* cope with hardware quirkiness:
2870 * - let SET_ADDRESS settle, some device hardware wants it
2871 * - read ep0 maxpacket even for high and low speed,
2874 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3))
2878 retval = usb_get_device_descriptor(udev, 8);
2881 "device descriptor read/8, error %d\n",
2893 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
2894 udev->speed == USB_SPEED_SUPER)
2897 i = udev->descriptor.bMaxPacketSize0;
2898 if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
2899 if (udev->speed == USB_SPEED_LOW ||
2900 !(i == 8 || i == 16 || i == 32 || i == 64)) {
2901 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
2905 if (udev->speed == USB_SPEED_FULL)
2906 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
2908 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
2909 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
2910 usb_ep0_reinit(udev);
2913 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
2914 if (retval < (signed)sizeof(udev->descriptor)) {
2915 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
2923 /* notify HCD that we have a device connected and addressed */
2924 if (hcd->driver->update_device)
2925 hcd->driver->update_device(hcd, udev);
2928 hub_port_disable(hub, port1, 0);
2929 update_address(udev, devnum); /* for disconnect processing */
2931 mutex_unlock(&usb_address0_mutex);
2936 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
2938 struct usb_qualifier_descriptor *qual;
2941 qual = kmalloc (sizeof *qual, GFP_KERNEL);
2945 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
2946 qual, sizeof *qual);
2947 if (status == sizeof *qual) {
2948 dev_info(&udev->dev, "not running at top speed; "
2949 "connect to a high speed hub\n");
2950 /* hub LEDs are probably harder to miss than syslog */
2951 if (hub->has_indicators) {
2952 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
2953 schedule_delayed_work (&hub->leds, 0);
2960 hub_power_remaining (struct usb_hub *hub)
2962 struct usb_device *hdev = hub->hdev;
2966 if (!hub->limited_power)
2969 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
2970 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
2971 struct usb_device *udev = hdev->children[port1 - 1];
2977 /* Unconfigured devices may not use more than 100mA,
2978 * or 8mA for OTG ports */
2979 if (udev->actconfig)
2980 delta = udev->actconfig->desc.bMaxPower * 2;
2981 else if (port1 != udev->bus->otg_port || hdev->parent)
2985 if (delta > hub->mA_per_port)
2986 dev_warn(&udev->dev,
2987 "%dmA is over %umA budget for port %d!\n",
2988 delta, hub->mA_per_port, port1);
2991 if (remaining < 0) {
2992 dev_warn(hub->intfdev, "%dmA over power budget!\n",
2999 /* Handle physical or logical connection change events.
3000 * This routine is called when:
3001 * a port connection-change occurs;
3002 * a port enable-change occurs (often caused by EMI);
3003 * usb_reset_and_verify_device() encounters changed descriptors (as from
3004 * a firmware download)
3005 * caller already locked the hub
3007 static void hub_port_connect_change(struct usb_hub *hub, int port1,
3008 u16 portstatus, u16 portchange)
3010 struct usb_device *hdev = hub->hdev;
3011 struct device *hub_dev = hub->intfdev;
3012 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
3013 unsigned wHubCharacteristics =
3014 le16_to_cpu(hub->descriptor->wHubCharacteristics);
3015 struct usb_device *udev;
3019 "port %d, status %04x, change %04x, %s\n",
3020 port1, portstatus, portchange, portspeed (portstatus));
3022 if (hub->has_indicators) {
3023 set_port_led(hub, port1, HUB_LED_AUTO);
3024 hub->indicator[port1-1] = INDICATOR_AUTO;
3027 #ifdef CONFIG_USB_OTG
3028 /* during HNP, don't repeat the debounce */
3029 if (hdev->bus->is_b_host)
3030 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
3031 USB_PORT_STAT_C_ENABLE);
3034 /* Try to resuscitate an existing device */
3035 udev = hdev->children[port1-1];
3036 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
3037 udev->state != USB_STATE_NOTATTACHED) {
3038 usb_lock_device(udev);
3039 if (portstatus & USB_PORT_STAT_ENABLE) {
3040 status = 0; /* Nothing to do */
3042 #ifdef CONFIG_USB_SUSPEND
3043 } else if (udev->state == USB_STATE_SUSPENDED &&
3044 udev->persist_enabled) {
3045 /* For a suspended device, treat this as a
3046 * remote wakeup event.
3048 status = usb_remote_wakeup(udev);
3052 status = -ENODEV; /* Don't resuscitate */
3054 usb_unlock_device(udev);
3057 clear_bit(port1, hub->change_bits);
3062 /* Disconnect any existing devices under this port */
3064 usb_disconnect(&hdev->children[port1-1]);
3065 clear_bit(port1, hub->change_bits);
3067 /* We can forget about a "removed" device when there's a physical
3068 * disconnect or the connect status changes.
3070 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
3071 (portchange & USB_PORT_STAT_C_CONNECTION))
3072 clear_bit(port1, hub->removed_bits);
3074 if (portchange & (USB_PORT_STAT_C_CONNECTION |
3075 USB_PORT_STAT_C_ENABLE)) {
3076 status = hub_port_debounce(hub, port1);
3078 if (printk_ratelimit())
3079 dev_err(hub_dev, "connect-debounce failed, "
3080 "port %d disabled\n", port1);
3081 portstatus &= ~USB_PORT_STAT_CONNECTION;
3083 portstatus = status;
3087 /* Return now if debouncing failed or nothing is connected or
3088 * the device was "removed".
3090 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
3091 test_bit(port1, hub->removed_bits)) {
3093 /* maybe switch power back on (e.g. root hub was reset) */
3094 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
3095 && !(portstatus & USB_PORT_STAT_POWER))
3096 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
3098 if (portstatus & USB_PORT_STAT_ENABLE)
3103 for (i = 0; i < SET_CONFIG_TRIES; i++) {
3105 /* reallocate for each attempt, since references
3106 * to the previous one can escape in various ways
3108 udev = usb_alloc_dev(hdev, hdev->bus, port1);
3111 "couldn't allocate port %d usb_device\n",
3116 usb_set_device_state(udev, USB_STATE_POWERED);
3117 udev->bus_mA = hub->mA_per_port;
3118 udev->level = hdev->level + 1;
3119 udev->wusb = hub_is_wusb(hub);
3122 * USB 3.0 devices are reset automatically before the connect
3123 * port status change appears, and the root hub port status
3124 * shows the correct speed. We also get port change
3125 * notifications for USB 3.0 devices from the USB 3.0 portion of
3126 * an external USB 3.0 hub, but this isn't handled correctly yet
3130 if (!(hcd->driver->flags & HCD_USB3))
3131 udev->speed = USB_SPEED_UNKNOWN;
3132 else if ((hdev->parent == NULL) &&
3133 (portstatus & USB_PORT_STAT_SUPER_SPEED))
3134 udev->speed = USB_SPEED_SUPER;
3136 udev->speed = USB_SPEED_UNKNOWN;
3140 * Note xHCI needs to issue an address device command later
3141 * in the hub_port_init sequence for SS/HS/FS/LS devices,
3142 * and xHC will assign an address to the device. But use
3143 * kernel assigned address here, to avoid any address conflict
3146 choose_address(udev);
3147 if (udev->devnum <= 0) {
3148 status = -ENOTCONN; /* Don't retry */
3152 /* reset (non-USB 3.0 devices) and get descriptor */
3153 status = hub_port_init(hub, udev, port1, i);
3157 usb_detect_quirks(udev);
3158 if (udev->quirks & USB_QUIRK_DELAY_INIT)
3161 /* consecutive bus-powered hubs aren't reliable; they can
3162 * violate the voltage drop budget. if the new child has
3163 * a "powered" LED, users should notice we didn't enable it
3164 * (without reading syslog), even without per-port LEDs
3167 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
3168 && udev->bus_mA <= 100) {
3171 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
3174 dev_dbg(&udev->dev, "get status %d ?\n", status);
3177 le16_to_cpus(&devstat);
3178 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
3180 "can't connect bus-powered hub "
3182 if (hub->has_indicators) {
3183 hub->indicator[port1-1] =
3184 INDICATOR_AMBER_BLINK;
3185 schedule_delayed_work (&hub->leds, 0);
3187 status = -ENOTCONN; /* Don't retry */
3192 /* check for devices running slower than they could */
3193 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
3194 && udev->speed == USB_SPEED_FULL
3195 && highspeed_hubs != 0)
3196 check_highspeed (hub, udev, port1);
3198 /* Store the parent's children[] pointer. At this point
3199 * udev becomes globally accessible, although presumably
3200 * no one will look at it until hdev is unlocked.
3204 /* We mustn't add new devices if the parent hub has
3205 * been disconnected; we would race with the
3206 * recursively_mark_NOTATTACHED() routine.
3208 spin_lock_irq(&device_state_lock);
3209 if (hdev->state == USB_STATE_NOTATTACHED)
3212 hdev->children[port1-1] = udev;
3213 spin_unlock_irq(&device_state_lock);
3215 /* Run it through the hoops (find a driver, etc) */
3217 status = usb_new_device(udev);
3219 spin_lock_irq(&device_state_lock);
3220 hdev->children[port1-1] = NULL;
3221 spin_unlock_irq(&device_state_lock);
3228 status = hub_power_remaining(hub);
3230 dev_dbg(hub_dev, "%dmA power budget left\n", status);
3235 hub_port_disable(hub, port1, 1);
3237 usb_ep0_reinit(udev);
3238 release_address(udev);
3241 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
3244 if (hub->hdev->parent ||
3245 !hcd->driver->port_handed_over ||
3246 !(hcd->driver->port_handed_over)(hcd, port1))
3247 dev_err(hub_dev, "unable to enumerate USB device on port %d\n",
3251 hub_port_disable(hub, port1, 1);
3252 if (hcd->driver->relinquish_port && !hub->hdev->parent)
3253 hcd->driver->relinquish_port(hcd, port1);
3256 static void hub_events(void)
3258 struct list_head *tmp;
3259 struct usb_device *hdev;
3260 struct usb_interface *intf;
3261 struct usb_hub *hub;
3262 struct device *hub_dev;
3271 * We restart the list every time to avoid a deadlock with
3272 * deleting hubs downstream from this one. This should be
3273 * safe since we delete the hub from the event list.
3274 * Not the most efficient, but avoids deadlocks.
3278 /* Grab the first entry at the beginning of the list */
3279 spin_lock_irq(&hub_event_lock);
3280 if (list_empty(&hub_event_list)) {
3281 spin_unlock_irq(&hub_event_lock);
3285 tmp = hub_event_list.next;
3288 hub = list_entry(tmp, struct usb_hub, event_list);
3289 kref_get(&hub->kref);
3290 spin_unlock_irq(&hub_event_lock);
3293 hub_dev = hub->intfdev;
3294 intf = to_usb_interface(hub_dev);
3295 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
3296 hdev->state, hub->descriptor
3297 ? hub->descriptor->bNbrPorts
3299 /* NOTE: expects max 15 ports... */
3300 (u16) hub->change_bits[0],
3301 (u16) hub->event_bits[0]);
3303 /* Lock the device, then check to see if we were
3304 * disconnected while waiting for the lock to succeed. */
3305 usb_lock_device(hdev);
3306 if (unlikely(hub->disconnected))
3307 goto loop_disconnected;
3309 /* If the hub has died, clean up after it */
3310 if (hdev->state == USB_STATE_NOTATTACHED) {
3311 hub->error = -ENODEV;
3312 hub_quiesce(hub, HUB_DISCONNECT);
3317 ret = usb_autopm_get_interface(intf);
3319 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
3323 /* If this is an inactive hub, do nothing */
3328 dev_dbg (hub_dev, "resetting for error %d\n",
3331 ret = usb_reset_device(hdev);
3334 "error resetting hub: %d\n", ret);
3342 /* deal with port status changes */
3343 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
3344 if (test_bit(i, hub->busy_bits))
3346 connect_change = test_bit(i, hub->change_bits);
3347 if (!test_and_clear_bit(i, hub->event_bits) &&
3351 ret = hub_port_status(hub, i,
3352 &portstatus, &portchange);
3356 if (portchange & USB_PORT_STAT_C_CONNECTION) {
3357 clear_port_feature(hdev, i,
3358 USB_PORT_FEAT_C_CONNECTION);
3362 if (portchange & USB_PORT_STAT_C_ENABLE) {
3363 if (!connect_change)
3365 "port %d enable change, "
3368 clear_port_feature(hdev, i,
3369 USB_PORT_FEAT_C_ENABLE);
3372 * EM interference sometimes causes badly
3373 * shielded USB devices to be shutdown by
3374 * the hub, this hack enables them again.
3375 * Works at least with mouse driver.
3377 if (!(portstatus & USB_PORT_STAT_ENABLE)
3379 && hdev->children[i-1]) {
3382 "disabled by hub (EMI?), "
3389 if (portchange & USB_PORT_STAT_C_SUSPEND) {
3390 struct usb_device *udev;
3392 clear_port_feature(hdev, i,
3393 USB_PORT_FEAT_C_SUSPEND);
3394 udev = hdev->children[i-1];
3396 /* TRSMRCY = 10 msec */
3399 usb_lock_device(udev);
3400 ret = usb_remote_wakeup(hdev->
3402 usb_unlock_device(udev);
3407 hub_port_disable(hub, i, 1);
3410 "resume on port %d, status %d\n",
3414 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
3416 "over-current change on port %d\n",
3418 clear_port_feature(hdev, i,
3419 USB_PORT_FEAT_C_OVER_CURRENT);
3420 hub_power_on(hub, true);
3423 if (portchange & USB_PORT_STAT_C_RESET) {
3425 "reset change on port %d\n",
3427 clear_port_feature(hdev, i,
3428 USB_PORT_FEAT_C_RESET);
3432 hub_port_connect_change(hub, i,
3433 portstatus, portchange);
3436 /* deal with hub status changes */
3437 if (test_and_clear_bit(0, hub->event_bits) == 0)
3439 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
3440 dev_err (hub_dev, "get_hub_status failed\n");
3442 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
3443 dev_dbg (hub_dev, "power change\n");
3444 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
3445 if (hubstatus & HUB_STATUS_LOCAL_POWER)
3446 /* FIXME: Is this always true? */
3447 hub->limited_power = 1;
3449 hub->limited_power = 0;
3451 if (hubchange & HUB_CHANGE_OVERCURRENT) {
3452 dev_dbg (hub_dev, "overcurrent change\n");
3453 msleep(500); /* Cool down */
3454 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
3455 hub_power_on(hub, true);
3460 /* Balance the usb_autopm_get_interface() above */
3461 usb_autopm_put_interface_no_suspend(intf);
3463 /* Balance the usb_autopm_get_interface_no_resume() in
3464 * kick_khubd() and allow autosuspend.
3466 usb_autopm_put_interface(intf);
3468 usb_unlock_device(hdev);
3469 kref_put(&hub->kref, hub_release);
3471 } /* end while (1) */
3474 static int hub_thread(void *__unused)
3476 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
3477 * port handover. Otherwise it might see that a full-speed device
3478 * was gone before the EHCI controller had handed its port over to
3479 * the companion full-speed controller.
3485 wait_event_freezable(khubd_wait,
3486 !list_empty(&hub_event_list) ||
3487 kthread_should_stop());
3488 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
3490 pr_debug("%s: khubd exiting\n", usbcore_name);
3494 static const struct usb_device_id hub_id_table[] = {
3495 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
3496 .bDeviceClass = USB_CLASS_HUB},
3497 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
3498 .bInterfaceClass = USB_CLASS_HUB},
3499 { } /* Terminating entry */
3502 MODULE_DEVICE_TABLE (usb, hub_id_table);
3504 static struct usb_driver hub_driver = {
3507 .disconnect = hub_disconnect,
3508 .suspend = hub_suspend,
3509 .resume = hub_resume,
3510 .reset_resume = hub_reset_resume,
3511 .pre_reset = hub_pre_reset,
3512 .post_reset = hub_post_reset,
3513 .unlocked_ioctl = hub_ioctl,
3514 .id_table = hub_id_table,
3515 .supports_autosuspend = 1,
3518 int usb_hub_init(void)
3520 if (usb_register(&hub_driver) < 0) {
3521 printk(KERN_ERR "%s: can't register hub driver\n",
3526 khubd_task = kthread_run(hub_thread, NULL, "khubd");
3527 if (!IS_ERR(khubd_task))
3530 /* Fall through if kernel_thread failed */
3531 usb_deregister(&hub_driver);
3532 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
3537 void usb_hub_cleanup(void)
3539 kthread_stop(khubd_task);
3542 * Hub resources are freed for us by usb_deregister. It calls
3543 * usb_driver_purge on every device which in turn calls that
3544 * devices disconnect function if it is using this driver.
3545 * The hub_disconnect function takes care of releasing the
3546 * individual hub resources. -greg
3548 usb_deregister(&hub_driver);
3549 } /* usb_hub_cleanup() */
3551 static int descriptors_changed(struct usb_device *udev,
3552 struct usb_device_descriptor *old_device_descriptor)
3556 unsigned serial_len = 0;
3558 unsigned old_length;
3562 if (memcmp(&udev->descriptor, old_device_descriptor,
3563 sizeof(*old_device_descriptor)) != 0)
3566 /* Since the idVendor, idProduct, and bcdDevice values in the
3567 * device descriptor haven't changed, we will assume the
3568 * Manufacturer and Product strings haven't changed either.
3569 * But the SerialNumber string could be different (e.g., a
3570 * different flash card of the same brand).
3573 serial_len = strlen(udev->serial) + 1;
3576 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3577 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3578 len = max(len, old_length);
3581 buf = kmalloc(len, GFP_NOIO);
3583 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
3584 /* assume the worst */
3587 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3588 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3589 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
3591 if (length != old_length) {
3592 dev_dbg(&udev->dev, "config index %d, error %d\n",
3597 if (memcmp (buf, udev->rawdescriptors[index], old_length)
3599 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
3601 ((struct usb_config_descriptor *) buf)->
3602 bConfigurationValue);
3608 if (!changed && serial_len) {
3609 length = usb_string(udev, udev->descriptor.iSerialNumber,
3611 if (length + 1 != serial_len) {
3612 dev_dbg(&udev->dev, "serial string error %d\n",
3615 } else if (memcmp(buf, udev->serial, length) != 0) {
3616 dev_dbg(&udev->dev, "serial string changed\n");
3626 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
3627 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3629 * WARNING - don't use this routine to reset a composite device
3630 * (one with multiple interfaces owned by separate drivers)!
3631 * Use usb_reset_device() instead.
3633 * Do a port reset, reassign the device's address, and establish its
3634 * former operating configuration. If the reset fails, or the device's
3635 * descriptors change from their values before the reset, or the original
3636 * configuration and altsettings cannot be restored, a flag will be set
3637 * telling khubd to pretend the device has been disconnected and then
3638 * re-connected. All drivers will be unbound, and the device will be
3639 * re-enumerated and probed all over again.
3641 * Returns 0 if the reset succeeded, -ENODEV if the device has been
3642 * flagged for logical disconnection, or some other negative error code
3643 * if the reset wasn't even attempted.
3645 * The caller must own the device lock. For example, it's safe to use
3646 * this from a driver probe() routine after downloading new firmware.
3647 * For calls that might not occur during probe(), drivers should lock
3648 * the device using usb_lock_device_for_reset().
3650 * Locking exception: This routine may also be called from within an
3651 * autoresume handler. Such usage won't conflict with other tasks
3652 * holding the device lock because these tasks should always call
3653 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
3655 static int usb_reset_and_verify_device(struct usb_device *udev)
3657 struct usb_device *parent_hdev = udev->parent;
3658 struct usb_hub *parent_hub;
3659 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3660 struct usb_device_descriptor descriptor = udev->descriptor;
3662 int port1 = udev->portnum;
3664 if (udev->state == USB_STATE_NOTATTACHED ||
3665 udev->state == USB_STATE_SUSPENDED) {
3666 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3672 /* this requires hcd-specific logic; see ohci_restart() */
3673 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
3676 parent_hub = hdev_to_hub(parent_hdev);
3678 set_bit(port1, parent_hub->busy_bits);
3679 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
3681 /* ep0 maxpacket size may change; let the HCD know about it.
3682 * Other endpoints will be handled by re-enumeration. */
3683 usb_ep0_reinit(udev);
3684 ret = hub_port_init(parent_hub, udev, port1, i);
3685 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
3688 clear_bit(port1, parent_hub->busy_bits);
3693 /* Device might have changed firmware (DFU or similar) */
3694 if (descriptors_changed(udev, &descriptor)) {
3695 dev_info(&udev->dev, "device firmware changed\n");
3696 udev->descriptor = descriptor; /* for disconnect() calls */
3700 /* Restore the device's previous configuration */
3701 if (!udev->actconfig)
3704 mutex_lock(&hcd->bandwidth_mutex);
3705 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
3707 dev_warn(&udev->dev,
3708 "Busted HC? Not enough HCD resources for "
3709 "old configuration.\n");
3710 mutex_unlock(&hcd->bandwidth_mutex);
3713 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3714 USB_REQ_SET_CONFIGURATION, 0,
3715 udev->actconfig->desc.bConfigurationValue, 0,
3716 NULL, 0, USB_CTRL_SET_TIMEOUT);
3719 "can't restore configuration #%d (error=%d)\n",
3720 udev->actconfig->desc.bConfigurationValue, ret);
3721 mutex_unlock(&hcd->bandwidth_mutex);
3724 mutex_unlock(&hcd->bandwidth_mutex);
3725 usb_set_device_state(udev, USB_STATE_CONFIGURED);
3727 /* Put interfaces back into the same altsettings as before.
3728 * Don't bother to send the Set-Interface request for interfaces
3729 * that were already in altsetting 0; besides being unnecessary,
3730 * many devices can't handle it. Instead just reset the host-side
3733 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
3734 struct usb_host_config *config = udev->actconfig;
3735 struct usb_interface *intf = config->interface[i];
3736 struct usb_interface_descriptor *desc;
3738 desc = &intf->cur_altsetting->desc;
3739 if (desc->bAlternateSetting == 0) {
3740 usb_disable_interface(udev, intf, true);
3741 usb_enable_interface(udev, intf, true);
3744 /* Let the bandwidth allocation function know that this
3745 * device has been reset, and it will have to use
3746 * alternate setting 0 as the current alternate setting.
3748 intf->resetting_device = 1;
3749 ret = usb_set_interface(udev, desc->bInterfaceNumber,
3750 desc->bAlternateSetting);
3751 intf->resetting_device = 0;
3754 dev_err(&udev->dev, "failed to restore interface %d "
3755 "altsetting %d (error=%d)\n",
3756 desc->bInterfaceNumber,
3757 desc->bAlternateSetting,
3767 hub_port_logical_disconnect(parent_hub, port1);
3772 * usb_reset_device - warn interface drivers and perform a USB port reset
3773 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3775 * Warns all drivers bound to registered interfaces (using their pre_reset
3776 * method), performs the port reset, and then lets the drivers know that
3777 * the reset is over (using their post_reset method).
3779 * Return value is the same as for usb_reset_and_verify_device().
3781 * The caller must own the device lock. For example, it's safe to use
3782 * this from a driver probe() routine after downloading new firmware.
3783 * For calls that might not occur during probe(), drivers should lock
3784 * the device using usb_lock_device_for_reset().
3786 * If an interface is currently being probed or disconnected, we assume
3787 * its driver knows how to handle resets. For all other interfaces,
3788 * if the driver doesn't have pre_reset and post_reset methods then
3789 * we attempt to unbind it and rebind afterward.
3791 int usb_reset_device(struct usb_device *udev)
3795 struct usb_host_config *config = udev->actconfig;
3797 if (udev->state == USB_STATE_NOTATTACHED ||
3798 udev->state == USB_STATE_SUSPENDED) {
3799 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3804 /* Prevent autosuspend during the reset */
3805 usb_autoresume_device(udev);
3808 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
3809 struct usb_interface *cintf = config->interface[i];
3810 struct usb_driver *drv;
3813 if (cintf->dev.driver) {
3814 drv = to_usb_driver(cintf->dev.driver);
3815 if (drv->pre_reset && drv->post_reset)
3816 unbind = (drv->pre_reset)(cintf);
3817 else if (cintf->condition ==
3818 USB_INTERFACE_BOUND)
3821 usb_forced_unbind_intf(cintf);
3826 ret = usb_reset_and_verify_device(udev);
3829 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
3830 struct usb_interface *cintf = config->interface[i];
3831 struct usb_driver *drv;
3832 int rebind = cintf->needs_binding;
3834 if (!rebind && cintf->dev.driver) {
3835 drv = to_usb_driver(cintf->dev.driver);
3836 if (drv->post_reset)
3837 rebind = (drv->post_reset)(cintf);
3838 else if (cintf->condition ==
3839 USB_INTERFACE_BOUND)
3842 if (ret == 0 && rebind)
3843 usb_rebind_intf(cintf);
3847 usb_autosuspend_device(udev);
3850 EXPORT_SYMBOL_GPL(usb_reset_device);
3854 * usb_queue_reset_device - Reset a USB device from an atomic context
3855 * @iface: USB interface belonging to the device to reset
3857 * This function can be used to reset a USB device from an atomic
3858 * context, where usb_reset_device() won't work (as it blocks).
3860 * Doing a reset via this method is functionally equivalent to calling
3861 * usb_reset_device(), except for the fact that it is delayed to a
3862 * workqueue. This means that any drivers bound to other interfaces
3863 * might be unbound, as well as users from usbfs in user space.
3867 * - Scheduling two resets at the same time from two different drivers
3868 * attached to two different interfaces of the same device is
3869 * possible; depending on how the driver attached to each interface
3870 * handles ->pre_reset(), the second reset might happen or not.
3872 * - If a driver is unbound and it had a pending reset, the reset will
3875 * - This function can be called during .probe() or .disconnect()
3876 * times. On return from .disconnect(), any pending resets will be
3879 * There is no no need to lock/unlock the @reset_ws as schedule_work()
3882 * NOTE: We don't do any reference count tracking because it is not
3883 * needed. The lifecycle of the work_struct is tied to the
3884 * usb_interface. Before destroying the interface we cancel the
3885 * work_struct, so the fact that work_struct is queued and or
3886 * running means the interface (and thus, the device) exist and
3889 void usb_queue_reset_device(struct usb_interface *iface)
3891 schedule_work(&iface->reset_ws);
3893 EXPORT_SYMBOL_GPL(usb_queue_reset_device);