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;
681 bool need_debounce_delay = false;
684 /* Continue a partial initialization */
685 if (type == HUB_INIT2)
687 if (type == HUB_INIT3)
690 /* After a resume, port power should still be on.
691 * For any other type of activation, turn it on.
693 if (type != HUB_RESUME) {
695 /* Speed up system boot by using a delayed_work for the
696 * hub's initial power-up delays. This is pretty awkward
697 * and the implementation looks like a home-brewed sort of
698 * setjmp/longjmp, but it saves at least 100 ms for each
699 * root hub (assuming usbcore is compiled into the kernel
700 * rather than as a module). It adds up.
702 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
703 * because for those activation types the ports have to be
704 * operational when we return. In theory this could be done
705 * for HUB_POST_RESET, but it's easier not to.
707 if (type == HUB_INIT) {
708 delay = hub_power_on(hub, false);
709 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func2);
710 schedule_delayed_work(&hub->init_work,
711 msecs_to_jiffies(delay));
713 /* Suppress autosuspend until init is done */
714 usb_autopm_get_interface_no_resume(
715 to_usb_interface(hub->intfdev));
716 return; /* Continues at init2: below */
718 hub_power_on(hub, true);
723 /* Check each port and set hub->change_bits to let khubd know
724 * which ports need attention.
726 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
727 struct usb_device *udev = hdev->children[port1-1];
728 u16 portstatus, portchange;
730 portstatus = portchange = 0;
731 status = hub_port_status(hub, port1, &portstatus, &portchange);
732 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
733 dev_dbg(hub->intfdev,
734 "port %d: status %04x change %04x\n",
735 port1, portstatus, portchange);
737 /* After anything other than HUB_RESUME (i.e., initialization
738 * or any sort of reset), every port should be disabled.
739 * Unconnected ports should likewise be disabled (paranoia),
740 * and so should ports for which we have no usb_device.
742 if ((portstatus & USB_PORT_STAT_ENABLE) && (
743 type != HUB_RESUME ||
744 !(portstatus & USB_PORT_STAT_CONNECTION) ||
746 udev->state == USB_STATE_NOTATTACHED)) {
748 * USB3 protocol ports will automatically transition
749 * to Enabled state when detect an USB3.0 device attach.
750 * Do not disable USB3 protocol ports.
751 * FIXME: USB3 root hub and external hubs are treated
754 if (hdev->descriptor.bDeviceProtocol != 3 ||
756 !(portstatus & USB_PORT_STAT_SUPER_SPEED))) {
757 clear_port_feature(hdev, port1,
758 USB_PORT_FEAT_ENABLE);
759 portstatus &= ~USB_PORT_STAT_ENABLE;
761 /* Pretend that power was lost for USB3 devs */
762 portstatus &= ~USB_PORT_STAT_ENABLE;
766 /* Clear status-change flags; we'll debounce later */
767 if (portchange & USB_PORT_STAT_C_CONNECTION) {
768 need_debounce_delay = true;
769 clear_port_feature(hub->hdev, port1,
770 USB_PORT_FEAT_C_CONNECTION);
772 if (portchange & USB_PORT_STAT_C_ENABLE) {
773 need_debounce_delay = true;
774 clear_port_feature(hub->hdev, port1,
775 USB_PORT_FEAT_C_ENABLE);
778 /* We can forget about a "removed" device when there's a
779 * physical disconnect or the connect status changes.
781 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
782 (portchange & USB_PORT_STAT_C_CONNECTION))
783 clear_bit(port1, hub->removed_bits);
785 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
786 /* Tell khubd to disconnect the device or
787 * check for a new connection
789 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
790 set_bit(port1, hub->change_bits);
792 } else if (portstatus & USB_PORT_STAT_ENABLE) {
793 /* The power session apparently survived the resume.
794 * If there was an overcurrent or suspend change
795 * (i.e., remote wakeup request), have khubd
799 set_bit(port1, hub->change_bits);
801 } else if (udev->persist_enabled) {
803 udev->reset_resume = 1;
805 set_bit(port1, hub->change_bits);
808 /* The power session is gone; tell khubd */
809 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
810 set_bit(port1, hub->change_bits);
814 /* If no port-status-change flags were set, we don't need any
815 * debouncing. If flags were set we can try to debounce the
816 * ports all at once right now, instead of letting khubd do them
817 * one at a time later on.
819 * If any port-status changes do occur during this delay, khubd
820 * will see them later and handle them normally.
822 if (need_debounce_delay) {
823 delay = HUB_DEBOUNCE_STABLE;
825 /* Don't do a long sleep inside a workqueue routine */
826 if (type == HUB_INIT2) {
827 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func3);
828 schedule_delayed_work(&hub->init_work,
829 msecs_to_jiffies(delay));
830 return; /* Continues at init3: below */
838 status = usb_submit_urb(hub->urb, GFP_NOIO);
840 dev_err(hub->intfdev, "activate --> %d\n", status);
841 if (hub->has_indicators && blinkenlights)
842 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
844 /* Scan all ports that need attention */
847 /* Allow autosuspend if it was suppressed */
848 if (type <= HUB_INIT3)
849 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
852 /* Implement the continuations for the delays above */
853 static void hub_init_func2(struct work_struct *ws)
855 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
857 hub_activate(hub, HUB_INIT2);
860 static void hub_init_func3(struct work_struct *ws)
862 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
864 hub_activate(hub, HUB_INIT3);
867 enum hub_quiescing_type {
868 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
871 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
873 struct usb_device *hdev = hub->hdev;
876 cancel_delayed_work_sync(&hub->init_work);
878 /* khubd and related activity won't re-trigger */
881 if (type != HUB_SUSPEND) {
882 /* Disconnect all the children */
883 for (i = 0; i < hdev->maxchild; ++i) {
884 if (hdev->children[i])
885 usb_disconnect(&hdev->children[i]);
889 /* Stop khubd and related activity */
890 usb_kill_urb(hub->urb);
891 if (hub->has_indicators)
892 cancel_delayed_work_sync(&hub->leds);
894 cancel_work_sync(&hub->tt.clear_work);
897 /* caller has locked the hub device */
898 static int hub_pre_reset(struct usb_interface *intf)
900 struct usb_hub *hub = usb_get_intfdata(intf);
902 hub_quiesce(hub, HUB_PRE_RESET);
906 /* caller has locked the hub device */
907 static int hub_post_reset(struct usb_interface *intf)
909 struct usb_hub *hub = usb_get_intfdata(intf);
911 hub_activate(hub, HUB_POST_RESET);
915 static int hub_configure(struct usb_hub *hub,
916 struct usb_endpoint_descriptor *endpoint)
919 struct usb_device *hdev = hub->hdev;
920 struct device *hub_dev = hub->intfdev;
921 u16 hubstatus, hubchange;
922 u16 wHubCharacteristics;
925 char *message = "out of memory";
927 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
933 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
938 mutex_init(&hub->status_mutex);
940 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
941 if (!hub->descriptor) {
946 /* Request the entire hub descriptor.
947 * hub->descriptor can handle USB_MAXCHILDREN ports,
948 * but the hub can/will return fewer bytes here.
950 ret = get_hub_descriptor(hdev, hub->descriptor,
951 sizeof(*hub->descriptor));
953 message = "can't read hub descriptor";
955 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
956 message = "hub has too many ports!";
961 hdev->maxchild = hub->descriptor->bNbrPorts;
962 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
963 (hdev->maxchild == 1) ? "" : "s");
965 hub->port_owners = kzalloc(hdev->maxchild * sizeof(void *), GFP_KERNEL);
966 if (!hub->port_owners) {
971 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
973 if (wHubCharacteristics & HUB_CHAR_COMPOUND) {
975 char portstr [USB_MAXCHILDREN + 1];
977 for (i = 0; i < hdev->maxchild; i++)
978 portstr[i] = hub->descriptor->DeviceRemovable
979 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
981 portstr[hdev->maxchild] = 0;
982 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
984 dev_dbg(hub_dev, "standalone hub\n");
986 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
988 dev_dbg(hub_dev, "ganged power switching\n");
991 dev_dbg(hub_dev, "individual port power switching\n");
995 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
999 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1001 dev_dbg(hub_dev, "global over-current protection\n");
1004 dev_dbg(hub_dev, "individual port over-current protection\n");
1008 dev_dbg(hub_dev, "no over-current protection\n");
1012 spin_lock_init (&hub->tt.lock);
1013 INIT_LIST_HEAD (&hub->tt.clear_list);
1014 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1015 switch (hdev->descriptor.bDeviceProtocol) {
1019 dev_dbg(hub_dev, "Single TT\n");
1023 ret = usb_set_interface(hdev, 0, 1);
1025 dev_dbg(hub_dev, "TT per port\n");
1028 dev_err(hub_dev, "Using single TT (err %d)\n",
1033 /* USB 3.0 hubs don't have a TT */
1036 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1037 hdev->descriptor.bDeviceProtocol);
1041 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1042 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1043 case HUB_TTTT_8_BITS:
1044 if (hdev->descriptor.bDeviceProtocol != 0) {
1045 hub->tt.think_time = 666;
1046 dev_dbg(hub_dev, "TT requires at most %d "
1047 "FS bit times (%d ns)\n",
1048 8, hub->tt.think_time);
1051 case HUB_TTTT_16_BITS:
1052 hub->tt.think_time = 666 * 2;
1053 dev_dbg(hub_dev, "TT requires at most %d "
1054 "FS bit times (%d ns)\n",
1055 16, hub->tt.think_time);
1057 case HUB_TTTT_24_BITS:
1058 hub->tt.think_time = 666 * 3;
1059 dev_dbg(hub_dev, "TT requires at most %d "
1060 "FS bit times (%d ns)\n",
1061 24, hub->tt.think_time);
1063 case HUB_TTTT_32_BITS:
1064 hub->tt.think_time = 666 * 4;
1065 dev_dbg(hub_dev, "TT requires at most %d "
1066 "FS bit times (%d ns)\n",
1067 32, hub->tt.think_time);
1071 /* probe() zeroes hub->indicator[] */
1072 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1073 hub->has_indicators = 1;
1074 dev_dbg(hub_dev, "Port indicators are supported\n");
1077 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1078 hub->descriptor->bPwrOn2PwrGood * 2);
1080 /* power budgeting mostly matters with bus-powered hubs,
1081 * and battery-powered root hubs (may provide just 8 mA).
1083 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1085 message = "can't get hub status";
1088 le16_to_cpus(&hubstatus);
1089 if (hdev == hdev->bus->root_hub) {
1090 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
1091 hub->mA_per_port = 500;
1093 hub->mA_per_port = hdev->bus_mA;
1094 hub->limited_power = 1;
1096 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1097 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1098 hub->descriptor->bHubContrCurrent);
1099 hub->limited_power = 1;
1100 if (hdev->maxchild > 0) {
1101 int remaining = hdev->bus_mA -
1102 hub->descriptor->bHubContrCurrent;
1104 if (remaining < hdev->maxchild * 100)
1106 "insufficient power available "
1107 "to use all downstream ports\n");
1108 hub->mA_per_port = 100; /* 7.2.1.1 */
1110 } else { /* Self-powered external hub */
1111 /* FIXME: What about battery-powered external hubs that
1112 * provide less current per port? */
1113 hub->mA_per_port = 500;
1115 if (hub->mA_per_port < 500)
1116 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1119 /* Update the HCD's internal representation of this hub before khubd
1120 * starts getting port status changes for devices under the hub.
1122 hcd = bus_to_hcd(hdev->bus);
1123 if (hcd->driver->update_hub_device) {
1124 ret = hcd->driver->update_hub_device(hcd, hdev,
1125 &hub->tt, GFP_KERNEL);
1127 message = "can't update HCD hub info";
1132 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1134 message = "can't get hub status";
1138 /* local power status reports aren't always correct */
1139 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1140 dev_dbg(hub_dev, "local power source is %s\n",
1141 (hubstatus & HUB_STATUS_LOCAL_POWER)
1142 ? "lost (inactive)" : "good");
1144 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1145 dev_dbg(hub_dev, "%sover-current condition exists\n",
1146 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1148 /* set up the interrupt endpoint
1149 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1150 * bytes as USB2.0[11.12.3] says because some hubs are known
1151 * to send more data (and thus cause overflow). For root hubs,
1152 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1153 * to be big enough for at least USB_MAXCHILDREN ports. */
1154 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1155 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1157 if (maxp > sizeof(*hub->buffer))
1158 maxp = sizeof(*hub->buffer);
1160 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1166 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1167 hub, endpoint->bInterval);
1169 /* maybe cycle the hub leds */
1170 if (hub->has_indicators && blinkenlights)
1171 hub->indicator [0] = INDICATOR_CYCLE;
1173 hub_activate(hub, HUB_INIT);
1177 dev_err (hub_dev, "config failed, %s (err %d)\n",
1179 /* hub_disconnect() frees urb and descriptor */
1183 static void hub_release(struct kref *kref)
1185 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1187 usb_put_intf(to_usb_interface(hub->intfdev));
1191 static unsigned highspeed_hubs;
1193 static void hub_disconnect(struct usb_interface *intf)
1195 struct usb_hub *hub = usb_get_intfdata (intf);
1197 /* Take the hub off the event list and don't let it be added again */
1198 spin_lock_irq(&hub_event_lock);
1199 if (!list_empty(&hub->event_list)) {
1200 list_del_init(&hub->event_list);
1201 usb_autopm_put_interface_no_suspend(intf);
1203 hub->disconnected = 1;
1204 spin_unlock_irq(&hub_event_lock);
1206 /* Disconnect all children and quiesce the hub */
1208 hub_quiesce(hub, HUB_DISCONNECT);
1210 usb_set_intfdata (intf, NULL);
1211 hub->hdev->maxchild = 0;
1213 if (hub->hdev->speed == USB_SPEED_HIGH)
1216 usb_free_urb(hub->urb);
1217 kfree(hub->port_owners);
1218 kfree(hub->descriptor);
1222 kref_put(&hub->kref, hub_release);
1225 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1227 struct usb_host_interface *desc;
1228 struct usb_endpoint_descriptor *endpoint;
1229 struct usb_device *hdev;
1230 struct usb_hub *hub;
1232 desc = intf->cur_altsetting;
1233 hdev = interface_to_usbdev(intf);
1235 /* Hubs have proper suspend/resume support */
1236 usb_enable_autosuspend(hdev);
1238 if (hdev->level == MAX_TOPO_LEVEL) {
1240 "Unsupported bus topology: hub nested too deep\n");
1244 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1246 dev_warn(&intf->dev, "ignoring external hub\n");
1251 /* Some hubs have a subclass of 1, which AFAICT according to the */
1252 /* specs is not defined, but it works */
1253 if ((desc->desc.bInterfaceSubClass != 0) &&
1254 (desc->desc.bInterfaceSubClass != 1)) {
1256 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1260 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1261 if (desc->desc.bNumEndpoints != 1)
1262 goto descriptor_error;
1264 endpoint = &desc->endpoint[0].desc;
1266 /* If it's not an interrupt in endpoint, we'd better punt! */
1267 if (!usb_endpoint_is_int_in(endpoint))
1268 goto descriptor_error;
1270 /* We found a hub */
1271 dev_info (&intf->dev, "USB hub found\n");
1273 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1275 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1279 kref_init(&hub->kref);
1280 INIT_LIST_HEAD(&hub->event_list);
1281 hub->intfdev = &intf->dev;
1283 INIT_DELAYED_WORK(&hub->leds, led_work);
1284 INIT_DELAYED_WORK(&hub->init_work, NULL);
1287 usb_set_intfdata (intf, hub);
1288 intf->needs_remote_wakeup = 1;
1290 if (hdev->speed == USB_SPEED_HIGH)
1293 if (hub_configure(hub, endpoint) >= 0)
1296 hub_disconnect (intf);
1302 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1304 struct usb_device *hdev = interface_to_usbdev (intf);
1306 /* assert ifno == 0 (part of hub spec) */
1308 case USBDEVFS_HUB_PORTINFO: {
1309 struct usbdevfs_hub_portinfo *info = user_data;
1312 spin_lock_irq(&device_state_lock);
1313 if (hdev->devnum <= 0)
1316 info->nports = hdev->maxchild;
1317 for (i = 0; i < info->nports; i++) {
1318 if (hdev->children[i] == NULL)
1322 hdev->children[i]->devnum;
1325 spin_unlock_irq(&device_state_lock);
1327 return info->nports + 1;
1336 * Allow user programs to claim ports on a hub. When a device is attached
1337 * to one of these "claimed" ports, the program will "own" the device.
1339 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1342 if (hdev->state == USB_STATE_NOTATTACHED)
1344 if (port1 == 0 || port1 > hdev->maxchild)
1347 /* This assumes that devices not managed by the hub driver
1348 * will always have maxchild equal to 0.
1350 *ppowner = &(hdev_to_hub(hdev)->port_owners[port1 - 1]);
1354 /* In the following three functions, the caller must hold hdev's lock */
1355 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1, void *owner)
1360 rc = find_port_owner(hdev, port1, &powner);
1369 int usb_hub_release_port(struct usb_device *hdev, unsigned port1, void *owner)
1374 rc = find_port_owner(hdev, port1, &powner);
1377 if (*powner != owner)
1383 void usb_hub_release_all_ports(struct usb_device *hdev, void *owner)
1388 n = find_port_owner(hdev, 1, &powner);
1390 for (; n < hdev->maxchild; (++n, ++powner)) {
1391 if (*powner == owner)
1397 /* The caller must hold udev's lock */
1398 bool usb_device_is_owned(struct usb_device *udev)
1400 struct usb_hub *hub;
1402 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1404 hub = hdev_to_hub(udev->parent);
1405 return !!hub->port_owners[udev->portnum - 1];
1409 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1413 for (i = 0; i < udev->maxchild; ++i) {
1414 if (udev->children[i])
1415 recursively_mark_NOTATTACHED(udev->children[i]);
1417 if (udev->state == USB_STATE_SUSPENDED)
1418 udev->active_duration -= jiffies;
1419 udev->state = USB_STATE_NOTATTACHED;
1423 * usb_set_device_state - change a device's current state (usbcore, hcds)
1424 * @udev: pointer to device whose state should be changed
1425 * @new_state: new state value to be stored
1427 * udev->state is _not_ fully protected by the device lock. Although
1428 * most transitions are made only while holding the lock, the state can
1429 * can change to USB_STATE_NOTATTACHED at almost any time. This
1430 * is so that devices can be marked as disconnected as soon as possible,
1431 * without having to wait for any semaphores to be released. As a result,
1432 * all changes to any device's state must be protected by the
1433 * device_state_lock spinlock.
1435 * Once a device has been added to the device tree, all changes to its state
1436 * should be made using this routine. The state should _not_ be set directly.
1438 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1439 * Otherwise udev->state is set to new_state, and if new_state is
1440 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1441 * to USB_STATE_NOTATTACHED.
1443 void usb_set_device_state(struct usb_device *udev,
1444 enum usb_device_state new_state)
1446 unsigned long flags;
1448 spin_lock_irqsave(&device_state_lock, flags);
1449 if (udev->state == USB_STATE_NOTATTACHED)
1451 else if (new_state != USB_STATE_NOTATTACHED) {
1453 /* root hub wakeup capabilities are managed out-of-band
1454 * and may involve silicon errata ... ignore them here.
1457 if (udev->state == USB_STATE_SUSPENDED
1458 || new_state == USB_STATE_SUSPENDED)
1459 ; /* No change to wakeup settings */
1460 else if (new_state == USB_STATE_CONFIGURED)
1461 device_set_wakeup_capable(&udev->dev,
1462 (udev->actconfig->desc.bmAttributes
1463 & USB_CONFIG_ATT_WAKEUP));
1465 device_set_wakeup_capable(&udev->dev, 0);
1467 if (udev->state == USB_STATE_SUSPENDED &&
1468 new_state != USB_STATE_SUSPENDED)
1469 udev->active_duration -= jiffies;
1470 else if (new_state == USB_STATE_SUSPENDED &&
1471 udev->state != USB_STATE_SUSPENDED)
1472 udev->active_duration += jiffies;
1473 udev->state = new_state;
1475 recursively_mark_NOTATTACHED(udev);
1476 spin_unlock_irqrestore(&device_state_lock, flags);
1478 EXPORT_SYMBOL_GPL(usb_set_device_state);
1481 * WUSB devices are simple: they have no hubs behind, so the mapping
1482 * device <-> virtual port number becomes 1:1. Why? to simplify the
1483 * life of the device connection logic in
1484 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1485 * handshake we need to assign a temporary address in the unauthorized
1486 * space. For simplicity we use the first virtual port number found to
1487 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1488 * and that becomes it's address [X < 128] or its unauthorized address
1491 * We add 1 as an offset to the one-based USB-stack port number
1492 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1493 * 0 is reserved by USB for default address; (b) Linux's USB stack
1494 * uses always #1 for the root hub of the controller. So USB stack's
1495 * port #1, which is wusb virtual-port #0 has address #2.
1497 * Devices connected under xHCI are not as simple. The host controller
1498 * supports virtualization, so the hardware assigns device addresses and
1499 * the HCD must setup data structures before issuing a set address
1500 * command to the hardware.
1502 static void choose_address(struct usb_device *udev)
1505 struct usb_bus *bus = udev->bus;
1507 /* If khubd ever becomes multithreaded, this will need a lock */
1509 devnum = udev->portnum + 1;
1510 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
1512 /* Try to allocate the next devnum beginning at
1513 * bus->devnum_next. */
1514 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1517 devnum = find_next_zero_bit(bus->devmap.devicemap,
1519 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1522 set_bit(devnum, bus->devmap.devicemap);
1523 udev->devnum = devnum;
1527 static void release_address(struct usb_device *udev)
1529 if (udev->devnum > 0) {
1530 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1535 static void update_address(struct usb_device *udev, int devnum)
1537 /* The address for a WUSB device is managed by wusbcore. */
1539 udev->devnum = devnum;
1542 static void hub_free_dev(struct usb_device *udev)
1544 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1546 /* Root hubs aren't real devices, so don't free HCD resources */
1547 if (hcd->driver->free_dev && udev->parent)
1548 hcd->driver->free_dev(hcd, udev);
1552 * usb_disconnect - disconnect a device (usbcore-internal)
1553 * @pdev: pointer to device being disconnected
1554 * Context: !in_interrupt ()
1556 * Something got disconnected. Get rid of it and all of its children.
1558 * If *pdev is a normal device then the parent hub must already be locked.
1559 * If *pdev is a root hub then this routine will acquire the
1560 * usb_bus_list_lock on behalf of the caller.
1562 * Only hub drivers (including virtual root hub drivers for host
1563 * controllers) should ever call this.
1565 * This call is synchronous, and may not be used in an interrupt context.
1567 void usb_disconnect(struct usb_device **pdev)
1569 struct usb_device *udev = *pdev;
1573 pr_debug ("%s nodev\n", __func__);
1577 /* mark the device as inactive, so any further urb submissions for
1578 * this device (and any of its children) will fail immediately.
1579 * this quiesces everyting except pending urbs.
1581 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1582 dev_info (&udev->dev, "USB disconnect, address %d\n", udev->devnum);
1584 usb_lock_device(udev);
1586 /* Free up all the children before we remove this device */
1587 for (i = 0; i < USB_MAXCHILDREN; i++) {
1588 if (udev->children[i])
1589 usb_disconnect(&udev->children[i]);
1592 /* deallocate hcd/hardware state ... nuking all pending urbs and
1593 * cleaning up all state associated with the current configuration
1594 * so that the hardware is now fully quiesced.
1596 dev_dbg (&udev->dev, "unregistering device\n");
1597 usb_disable_device(udev, 0);
1598 usb_hcd_synchronize_unlinks(udev);
1600 usb_remove_ep_devs(&udev->ep0);
1601 usb_unlock_device(udev);
1603 /* Unregister the device. The device driver is responsible
1604 * for de-configuring the device and invoking the remove-device
1605 * notifier chain (used by usbfs and possibly others).
1607 device_del(&udev->dev);
1609 /* Free the device number and delete the parent's children[]
1610 * (or root_hub) pointer.
1612 release_address(udev);
1614 /* Avoid races with recursively_mark_NOTATTACHED() */
1615 spin_lock_irq(&device_state_lock);
1617 spin_unlock_irq(&device_state_lock);
1621 put_device(&udev->dev);
1624 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
1625 static void show_string(struct usb_device *udev, char *id, char *string)
1629 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1632 static void announce_device(struct usb_device *udev)
1634 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
1635 le16_to_cpu(udev->descriptor.idVendor),
1636 le16_to_cpu(udev->descriptor.idProduct));
1637 dev_info(&udev->dev,
1638 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
1639 udev->descriptor.iManufacturer,
1640 udev->descriptor.iProduct,
1641 udev->descriptor.iSerialNumber);
1642 show_string(udev, "Product", udev->product);
1643 show_string(udev, "Manufacturer", udev->manufacturer);
1644 show_string(udev, "SerialNumber", udev->serial);
1647 static inline void announce_device(struct usb_device *udev) { }
1650 #ifdef CONFIG_USB_OTG
1651 #include "otg_whitelist.h"
1655 * usb_enumerate_device_otg - FIXME (usbcore-internal)
1656 * @udev: newly addressed device (in ADDRESS state)
1658 * Finish enumeration for On-The-Go devices
1660 static int usb_enumerate_device_otg(struct usb_device *udev)
1664 #ifdef CONFIG_USB_OTG
1666 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1667 * to wake us after we've powered off VBUS; and HNP, switching roles
1668 * "host" to "peripheral". The OTG descriptor helps figure this out.
1670 if (!udev->bus->is_b_host
1672 && udev->parent == udev->bus->root_hub) {
1673 struct usb_otg_descriptor *desc = NULL;
1674 struct usb_bus *bus = udev->bus;
1676 /* descriptor may appear anywhere in config */
1677 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1678 le16_to_cpu(udev->config[0].desc.wTotalLength),
1679 USB_DT_OTG, (void **) &desc) == 0) {
1680 if (desc->bmAttributes & USB_OTG_HNP) {
1681 unsigned port1 = udev->portnum;
1683 dev_info(&udev->dev,
1684 "Dual-Role OTG device on %sHNP port\n",
1685 (port1 == bus->otg_port)
1688 /* enable HNP before suspend, it's simpler */
1689 if (port1 == bus->otg_port)
1690 bus->b_hnp_enable = 1;
1691 err = usb_control_msg(udev,
1692 usb_sndctrlpipe(udev, 0),
1693 USB_REQ_SET_FEATURE, 0,
1695 ? USB_DEVICE_B_HNP_ENABLE
1696 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1697 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1699 /* OTG MESSAGE: report errors here,
1700 * customize to match your product.
1702 dev_info(&udev->dev,
1703 "can't set HNP mode: %d\n",
1705 bus->b_hnp_enable = 0;
1711 if (!is_targeted(udev)) {
1713 /* Maybe it can talk to us, though we can't talk to it.
1714 * (Includes HNP test device.)
1716 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
1717 err = usb_port_suspend(udev, PMSG_SUSPEND);
1719 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1731 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
1732 * @udev: newly addressed device (in ADDRESS state)
1734 * This is only called by usb_new_device() and usb_authorize_device()
1735 * and FIXME -- all comments that apply to them apply here wrt to
1738 * If the device is WUSB and not authorized, we don't attempt to read
1739 * the string descriptors, as they will be errored out by the device
1740 * until it has been authorized.
1742 static int usb_enumerate_device(struct usb_device *udev)
1746 if (udev->config == NULL) {
1747 err = usb_get_configuration(udev);
1749 dev_err(&udev->dev, "can't read configurations, error %d\n",
1754 if (udev->wusb == 1 && udev->authorized == 0) {
1755 udev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1756 udev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1757 udev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1760 /* read the standard strings and cache them if present */
1761 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1762 udev->manufacturer = usb_cache_string(udev,
1763 udev->descriptor.iManufacturer);
1764 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
1766 err = usb_enumerate_device_otg(udev);
1773 * usb_new_device - perform initial device setup (usbcore-internal)
1774 * @udev: newly addressed device (in ADDRESS state)
1776 * This is called with devices which have been detected but not fully
1777 * enumerated. The device descriptor is available, but not descriptors
1778 * for any device configuration. The caller must have locked either
1779 * the parent hub (if udev is a normal device) or else the
1780 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1781 * udev has already been installed, but udev is not yet visible through
1782 * sysfs or other filesystem code.
1784 * It will return if the device is configured properly or not. Zero if
1785 * the interface was registered with the driver core; else a negative
1788 * This call is synchronous, and may not be used in an interrupt context.
1790 * Only the hub driver or root-hub registrar should ever call this.
1792 int usb_new_device(struct usb_device *udev)
1797 /* Initialize non-root-hub device wakeup to disabled;
1798 * device (un)configuration controls wakeup capable
1799 * sysfs power/wakeup controls wakeup enabled/disabled
1801 device_init_wakeup(&udev->dev, 0);
1804 /* Tell the runtime-PM framework the device is active */
1805 pm_runtime_set_active(&udev->dev);
1806 pm_runtime_enable(&udev->dev);
1808 err = usb_enumerate_device(udev); /* Read descriptors */
1811 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
1812 udev->devnum, udev->bus->busnum,
1813 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1814 /* export the usbdev device-node for libusb */
1815 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
1816 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1818 /* Tell the world! */
1819 announce_device(udev);
1821 device_enable_async_suspend(&udev->dev);
1822 /* Register the device. The device driver is responsible
1823 * for configuring the device and invoking the add-device
1824 * notifier chain (used by usbfs and possibly others).
1826 err = device_add(&udev->dev);
1828 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1832 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
1836 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1837 pm_runtime_disable(&udev->dev);
1838 pm_runtime_set_suspended(&udev->dev);
1844 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
1845 * @usb_dev: USB device
1847 * Move the USB device to a very basic state where interfaces are disabled
1848 * and the device is in fact unconfigured and unusable.
1850 * We share a lock (that we have) with device_del(), so we need to
1853 int usb_deauthorize_device(struct usb_device *usb_dev)
1855 usb_lock_device(usb_dev);
1856 if (usb_dev->authorized == 0)
1857 goto out_unauthorized;
1859 usb_dev->authorized = 0;
1860 usb_set_configuration(usb_dev, -1);
1862 kfree(usb_dev->product);
1863 usb_dev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1864 kfree(usb_dev->manufacturer);
1865 usb_dev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1866 kfree(usb_dev->serial);
1867 usb_dev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1869 usb_destroy_configuration(usb_dev);
1870 usb_dev->descriptor.bNumConfigurations = 0;
1873 usb_unlock_device(usb_dev);
1878 int usb_authorize_device(struct usb_device *usb_dev)
1882 usb_lock_device(usb_dev);
1883 if (usb_dev->authorized == 1)
1884 goto out_authorized;
1886 result = usb_autoresume_device(usb_dev);
1888 dev_err(&usb_dev->dev,
1889 "can't autoresume for authorization: %d\n", result);
1890 goto error_autoresume;
1892 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
1894 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
1895 "authorization: %d\n", result);
1896 goto error_device_descriptor;
1899 kfree(usb_dev->product);
1900 usb_dev->product = NULL;
1901 kfree(usb_dev->manufacturer);
1902 usb_dev->manufacturer = NULL;
1903 kfree(usb_dev->serial);
1904 usb_dev->serial = NULL;
1906 usb_dev->authorized = 1;
1907 result = usb_enumerate_device(usb_dev);
1909 goto error_enumerate;
1910 /* Choose and set the configuration. This registers the interfaces
1911 * with the driver core and lets interface drivers bind to them.
1913 c = usb_choose_configuration(usb_dev);
1915 result = usb_set_configuration(usb_dev, c);
1917 dev_err(&usb_dev->dev,
1918 "can't set config #%d, error %d\n", c, result);
1919 /* This need not be fatal. The user can try to
1920 * set other configurations. */
1923 dev_info(&usb_dev->dev, "authorized to connect\n");
1926 error_device_descriptor:
1927 usb_autosuspend_device(usb_dev);
1930 usb_unlock_device(usb_dev); // complements locktree
1935 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
1936 static unsigned hub_is_wusb(struct usb_hub *hub)
1938 struct usb_hcd *hcd;
1939 if (hub->hdev->parent != NULL) /* not a root hub? */
1941 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
1942 return hcd->wireless;
1946 #define PORT_RESET_TRIES 5
1947 #define SET_ADDRESS_TRIES 2
1948 #define GET_DESCRIPTOR_TRIES 2
1949 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1950 #define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1952 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1953 #define HUB_SHORT_RESET_TIME 10
1954 #define HUB_LONG_RESET_TIME 200
1955 #define HUB_RESET_TIMEOUT 500
1957 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
1958 struct usb_device *udev, unsigned int delay)
1960 int delay_time, ret;
1964 for (delay_time = 0;
1965 delay_time < HUB_RESET_TIMEOUT;
1966 delay_time += delay) {
1967 /* wait to give the device a chance to reset */
1970 /* read and decode port status */
1971 ret = hub_port_status(hub, port1, &portstatus, &portchange);
1975 /* Device went away? */
1976 if (!(portstatus & USB_PORT_STAT_CONNECTION))
1979 /* bomb out completely if the connection bounced */
1980 if ((portchange & USB_PORT_STAT_C_CONNECTION))
1983 /* if we`ve finished resetting, then break out of the loop */
1984 if (!(portstatus & USB_PORT_STAT_RESET) &&
1985 (portstatus & USB_PORT_STAT_ENABLE)) {
1986 if (hub_is_wusb(hub))
1987 udev->speed = USB_SPEED_WIRELESS;
1988 else if (portstatus & USB_PORT_STAT_SUPER_SPEED)
1989 udev->speed = USB_SPEED_SUPER;
1990 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
1991 udev->speed = USB_SPEED_HIGH;
1992 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
1993 udev->speed = USB_SPEED_LOW;
1995 udev->speed = USB_SPEED_FULL;
1999 /* switch to the long delay after two short delay failures */
2000 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2001 delay = HUB_LONG_RESET_TIME;
2003 dev_dbg (hub->intfdev,
2004 "port %d not reset yet, waiting %dms\n",
2011 static int hub_port_reset(struct usb_hub *hub, int port1,
2012 struct usb_device *udev, unsigned int delay)
2015 struct usb_hcd *hcd;
2017 hcd = bus_to_hcd(udev->bus);
2018 /* Block EHCI CF initialization during the port reset.
2019 * Some companion controllers don't like it when they mix.
2021 down_read(&ehci_cf_port_reset_rwsem);
2023 /* Reset the port */
2024 for (i = 0; i < PORT_RESET_TRIES; i++) {
2025 status = set_port_feature(hub->hdev,
2026 port1, USB_PORT_FEAT_RESET);
2028 dev_err(hub->intfdev,
2029 "cannot reset port %d (err = %d)\n",
2032 status = hub_port_wait_reset(hub, port1, udev, delay);
2033 if (status && status != -ENOTCONN)
2034 dev_dbg(hub->intfdev,
2035 "port_wait_reset: err = %d\n",
2039 /* return on disconnect or reset */
2042 /* TRSTRCY = 10 ms; plus some extra */
2044 update_address(udev, 0);
2045 if (hcd->driver->reset_device) {
2046 status = hcd->driver->reset_device(hcd, udev);
2048 dev_err(&udev->dev, "Cannot reset "
2049 "HCD device state\n");
2056 clear_port_feature(hub->hdev,
2057 port1, USB_PORT_FEAT_C_RESET);
2058 /* FIXME need disconnect() for NOTATTACHED device */
2059 usb_set_device_state(udev, status
2060 ? USB_STATE_NOTATTACHED
2061 : USB_STATE_DEFAULT);
2065 dev_dbg (hub->intfdev,
2066 "port %d not enabled, trying reset again...\n",
2068 delay = HUB_LONG_RESET_TIME;
2071 dev_err (hub->intfdev,
2072 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2076 up_read(&ehci_cf_port_reset_rwsem);
2082 #define MASK_BITS (USB_PORT_STAT_POWER | USB_PORT_STAT_CONNECTION | \
2083 USB_PORT_STAT_SUSPEND)
2084 #define WANT_BITS (USB_PORT_STAT_POWER | USB_PORT_STAT_CONNECTION)
2086 /* Determine whether the device on a port is ready for a normal resume,
2087 * is ready for a reset-resume, or should be disconnected.
2089 static int check_port_resume_type(struct usb_device *udev,
2090 struct usb_hub *hub, int port1,
2091 int status, unsigned portchange, unsigned portstatus)
2093 /* Is the device still present? */
2094 if (status || (portstatus & MASK_BITS) != WANT_BITS) {
2099 /* Can't do a normal resume if the port isn't enabled,
2100 * so try a reset-resume instead.
2102 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2103 if (udev->persist_enabled)
2104 udev->reset_resume = 1;
2110 dev_dbg(hub->intfdev,
2111 "port %d status %04x.%04x after resume, %d\n",
2112 port1, portchange, portstatus, status);
2113 } else if (udev->reset_resume) {
2115 /* Late port handoff can set status-change bits */
2116 if (portchange & USB_PORT_STAT_C_CONNECTION)
2117 clear_port_feature(hub->hdev, port1,
2118 USB_PORT_FEAT_C_CONNECTION);
2119 if (portchange & USB_PORT_STAT_C_ENABLE)
2120 clear_port_feature(hub->hdev, port1,
2121 USB_PORT_FEAT_C_ENABLE);
2127 #ifdef CONFIG_USB_SUSPEND
2130 * usb_port_suspend - suspend a usb device's upstream port
2131 * @udev: device that's no longer in active use, not a root hub
2132 * Context: must be able to sleep; device not locked; pm locks held
2134 * Suspends a USB device that isn't in active use, conserving power.
2135 * Devices may wake out of a suspend, if anything important happens,
2136 * using the remote wakeup mechanism. They may also be taken out of
2137 * suspend by the host, using usb_port_resume(). It's also routine
2138 * to disconnect devices while they are suspended.
2140 * This only affects the USB hardware for a device; its interfaces
2141 * (and, for hubs, child devices) must already have been suspended.
2143 * Selective port suspend reduces power; most suspended devices draw
2144 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2145 * All devices below the suspended port are also suspended.
2147 * Devices leave suspend state when the host wakes them up. Some devices
2148 * also support "remote wakeup", where the device can activate the USB
2149 * tree above them to deliver data, such as a keypress or packet. In
2150 * some cases, this wakes the USB host.
2152 * Suspending OTG devices may trigger HNP, if that's been enabled
2153 * between a pair of dual-role devices. That will change roles, such
2154 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2156 * Devices on USB hub ports have only one "suspend" state, corresponding
2157 * to ACPI D2, "may cause the device to lose some context".
2158 * State transitions include:
2160 * - suspend, resume ... when the VBUS power link stays live
2161 * - suspend, disconnect ... VBUS lost
2163 * Once VBUS drop breaks the circuit, the port it's using has to go through
2164 * normal re-enumeration procedures, starting with enabling VBUS power.
2165 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2166 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2167 * timer, no SRP, no requests through sysfs.
2169 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
2170 * the root hub for their bus goes into global suspend ... so we don't
2171 * (falsely) update the device power state to say it suspended.
2173 * Returns 0 on success, else negative errno.
2175 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2177 struct usb_hub *hub = hdev_to_hub(udev->parent);
2178 int port1 = udev->portnum;
2181 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
2183 /* enable remote wakeup when appropriate; this lets the device
2184 * wake up the upstream hub (including maybe the root hub).
2186 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2187 * we don't explicitly enable it here.
2189 if (udev->do_remote_wakeup) {
2190 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2191 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2192 USB_DEVICE_REMOTE_WAKEUP, 0,
2194 USB_CTRL_SET_TIMEOUT);
2196 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
2198 /* bail if autosuspend is requested */
2199 if (msg.event & PM_EVENT_AUTO)
2205 status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
2207 dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
2209 /* paranoia: "should not happen" */
2210 if (udev->do_remote_wakeup)
2211 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2212 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2213 USB_DEVICE_REMOTE_WAKEUP, 0,
2215 USB_CTRL_SET_TIMEOUT);
2217 /* device has up to 10 msec to fully suspend */
2218 dev_dbg(&udev->dev, "usb %ssuspend\n",
2219 (msg.event & PM_EVENT_AUTO ? "auto-" : ""));
2220 usb_set_device_state(udev, USB_STATE_SUSPENDED);
2227 * If the USB "suspend" state is in use (rather than "global suspend"),
2228 * many devices will be individually taken out of suspend state using
2229 * special "resume" signaling. This routine kicks in shortly after
2230 * hardware resume signaling is finished, either because of selective
2231 * resume (by host) or remote wakeup (by device) ... now see what changed
2232 * in the tree that's rooted at this device.
2234 * If @udev->reset_resume is set then the device is reset before the
2235 * status check is done.
2237 static int finish_port_resume(struct usb_device *udev)
2242 /* caller owns the udev device lock */
2243 dev_dbg(&udev->dev, "%s\n",
2244 udev->reset_resume ? "finish reset-resume" : "finish resume");
2246 /* usb ch9 identifies four variants of SUSPENDED, based on what
2247 * state the device resumes to. Linux currently won't see the
2248 * first two on the host side; they'd be inside hub_port_init()
2249 * during many timeouts, but khubd can't suspend until later.
2251 usb_set_device_state(udev, udev->actconfig
2252 ? USB_STATE_CONFIGURED
2253 : USB_STATE_ADDRESS);
2255 /* 10.5.4.5 says not to reset a suspended port if the attached
2256 * device is enabled for remote wakeup. Hence the reset
2257 * operation is carried out here, after the port has been
2260 if (udev->reset_resume)
2262 status = usb_reset_and_verify_device(udev);
2264 /* 10.5.4.5 says be sure devices in the tree are still there.
2265 * For now let's assume the device didn't go crazy on resume,
2266 * and device drivers will know about any resume quirks.
2270 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
2272 status = (status > 0 ? 0 : -ENODEV);
2274 /* If a normal resume failed, try doing a reset-resume */
2275 if (status && !udev->reset_resume && udev->persist_enabled) {
2276 dev_dbg(&udev->dev, "retry with reset-resume\n");
2277 udev->reset_resume = 1;
2278 goto retry_reset_resume;
2283 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
2285 } else if (udev->actconfig) {
2286 le16_to_cpus(&devstatus);
2287 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) {
2288 status = usb_control_msg(udev,
2289 usb_sndctrlpipe(udev, 0),
2290 USB_REQ_CLEAR_FEATURE,
2292 USB_DEVICE_REMOTE_WAKEUP, 0,
2294 USB_CTRL_SET_TIMEOUT);
2297 "disable remote wakeup, status %d\n",
2306 * usb_port_resume - re-activate a suspended usb device's upstream port
2307 * @udev: device to re-activate, not a root hub
2308 * Context: must be able to sleep; device not locked; pm locks held
2310 * This will re-activate the suspended device, increasing power usage
2311 * while letting drivers communicate again with its endpoints.
2312 * USB resume explicitly guarantees that the power session between
2313 * the host and the device is the same as it was when the device
2316 * If @udev->reset_resume is set then this routine won't check that the
2317 * port is still enabled. Furthermore, finish_port_resume() above will
2318 * reset @udev. The end result is that a broken power session can be
2319 * recovered and @udev will appear to persist across a loss of VBUS power.
2321 * For example, if a host controller doesn't maintain VBUS suspend current
2322 * during a system sleep or is reset when the system wakes up, all the USB
2323 * power sessions below it will be broken. This is especially troublesome
2324 * for mass-storage devices containing mounted filesystems, since the
2325 * device will appear to have disconnected and all the memory mappings
2326 * to it will be lost. Using the USB_PERSIST facility, the device can be
2327 * made to appear as if it had not disconnected.
2329 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
2330 * every effort to insure that the same device is present after the
2331 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
2332 * quite possible for a device to remain unaltered but its media to be
2333 * changed. If the user replaces a flash memory card while the system is
2334 * asleep, he will have only himself to blame when the filesystem on the
2335 * new card is corrupted and the system crashes.
2337 * Returns 0 on success, else negative errno.
2339 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
2341 struct usb_hub *hub = hdev_to_hub(udev->parent);
2342 int port1 = udev->portnum;
2344 u16 portchange, portstatus;
2346 /* Skip the initial Clear-Suspend step for a remote wakeup */
2347 status = hub_port_status(hub, port1, &portstatus, &portchange);
2348 if (status == 0 && !(portstatus & USB_PORT_STAT_SUSPEND))
2349 goto SuspendCleared;
2351 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
2353 set_bit(port1, hub->busy_bits);
2355 /* see 7.1.7.7; affects power usage, but not budgeting */
2356 status = clear_port_feature(hub->hdev,
2357 port1, USB_PORT_FEAT_SUSPEND);
2359 dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
2362 /* drive resume for at least 20 msec */
2363 dev_dbg(&udev->dev, "usb %sresume\n",
2364 (msg.event & PM_EVENT_AUTO ? "auto-" : ""));
2367 /* Virtual root hubs can trigger on GET_PORT_STATUS to
2368 * stop resume signaling. Then finish the resume
2371 status = hub_port_status(hub, port1, &portstatus, &portchange);
2373 /* TRSMRCY = 10 msec */
2379 if (portchange & USB_PORT_STAT_C_SUSPEND)
2380 clear_port_feature(hub->hdev, port1,
2381 USB_PORT_FEAT_C_SUSPEND);
2384 clear_bit(port1, hub->busy_bits);
2386 status = check_port_resume_type(udev,
2387 hub, port1, status, portchange, portstatus);
2389 status = finish_port_resume(udev);
2391 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2392 hub_port_logical_disconnect(hub, port1);
2397 /* caller has locked udev */
2398 int usb_remote_wakeup(struct usb_device *udev)
2402 if (udev->state == USB_STATE_SUSPENDED) {
2403 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
2404 status = usb_autoresume_device(udev);
2406 /* Let the drivers do their thing, then... */
2407 usb_autosuspend_device(udev);
2413 #else /* CONFIG_USB_SUSPEND */
2415 /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
2417 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2422 /* However we may need to do a reset-resume */
2424 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
2426 struct usb_hub *hub = hdev_to_hub(udev->parent);
2427 int port1 = udev->portnum;
2429 u16 portchange, portstatus;
2431 status = hub_port_status(hub, port1, &portstatus, &portchange);
2432 status = check_port_resume_type(udev,
2433 hub, port1, status, portchange, portstatus);
2436 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2437 hub_port_logical_disconnect(hub, port1);
2438 } else if (udev->reset_resume) {
2439 dev_dbg(&udev->dev, "reset-resume\n");
2440 status = usb_reset_and_verify_device(udev);
2447 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
2449 struct usb_hub *hub = usb_get_intfdata (intf);
2450 struct usb_device *hdev = hub->hdev;
2453 /* fail if children aren't already suspended */
2454 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
2455 struct usb_device *udev;
2457 udev = hdev->children [port1-1];
2458 if (udev && udev->can_submit) {
2459 if (!(msg.event & PM_EVENT_AUTO))
2460 dev_dbg(&intf->dev, "port %d nyet suspended\n",
2466 dev_dbg(&intf->dev, "%s\n", __func__);
2468 /* stop khubd and related activity */
2469 hub_quiesce(hub, HUB_SUSPEND);
2473 static int hub_resume(struct usb_interface *intf)
2475 struct usb_hub *hub = usb_get_intfdata(intf);
2477 dev_dbg(&intf->dev, "%s\n", __func__);
2478 hub_activate(hub, HUB_RESUME);
2482 static int hub_reset_resume(struct usb_interface *intf)
2484 struct usb_hub *hub = usb_get_intfdata(intf);
2486 dev_dbg(&intf->dev, "%s\n", __func__);
2487 hub_activate(hub, HUB_RESET_RESUME);
2492 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
2493 * @rhdev: struct usb_device for the root hub
2495 * The USB host controller driver calls this function when its root hub
2496 * is resumed and Vbus power has been interrupted or the controller
2497 * has been reset. The routine marks @rhdev as having lost power.
2498 * When the hub driver is resumed it will take notice and carry out
2499 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
2500 * the others will be disconnected.
2502 void usb_root_hub_lost_power(struct usb_device *rhdev)
2504 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
2505 rhdev->reset_resume = 1;
2507 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
2509 #else /* CONFIG_PM */
2511 #define hub_suspend NULL
2512 #define hub_resume NULL
2513 #define hub_reset_resume NULL
2517 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2519 * Between connect detection and reset signaling there must be a delay
2520 * of 100ms at least for debounce and power-settling. The corresponding
2521 * timer shall restart whenever the downstream port detects a disconnect.
2523 * Apparently there are some bluetooth and irda-dongles and a number of
2524 * low-speed devices for which this debounce period may last over a second.
2525 * Not covered by the spec - but easy to deal with.
2527 * This implementation uses a 1500ms total debounce timeout; if the
2528 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2529 * every 25ms for transient disconnects. When the port status has been
2530 * unchanged for 100ms it returns the port status.
2532 static int hub_port_debounce(struct usb_hub *hub, int port1)
2535 int total_time, stable_time = 0;
2536 u16 portchange, portstatus;
2537 unsigned connection = 0xffff;
2539 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2540 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2544 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2545 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2546 stable_time += HUB_DEBOUNCE_STEP;
2547 if (stable_time >= HUB_DEBOUNCE_STABLE)
2551 connection = portstatus & USB_PORT_STAT_CONNECTION;
2554 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2555 clear_port_feature(hub->hdev, port1,
2556 USB_PORT_FEAT_C_CONNECTION);
2559 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2561 msleep(HUB_DEBOUNCE_STEP);
2564 dev_dbg (hub->intfdev,
2565 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2566 port1, total_time, stable_time, portstatus);
2568 if (stable_time < HUB_DEBOUNCE_STABLE)
2573 void usb_ep0_reinit(struct usb_device *udev)
2575 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
2576 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
2577 usb_enable_endpoint(udev, &udev->ep0, true);
2579 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
2581 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2582 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2584 static int hub_set_address(struct usb_device *udev, int devnum)
2587 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2590 * The host controller will choose the device address,
2591 * instead of the core having chosen it earlier
2593 if (!hcd->driver->address_device && devnum <= 1)
2595 if (udev->state == USB_STATE_ADDRESS)
2597 if (udev->state != USB_STATE_DEFAULT)
2599 if (hcd->driver->address_device)
2600 retval = hcd->driver->address_device(hcd, udev);
2602 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2603 USB_REQ_SET_ADDRESS, 0, devnum, 0,
2604 NULL, 0, USB_CTRL_SET_TIMEOUT);
2606 update_address(udev, devnum);
2607 /* Device now using proper address. */
2608 usb_set_device_state(udev, USB_STATE_ADDRESS);
2609 usb_ep0_reinit(udev);
2614 /* Reset device, (re)assign address, get device descriptor.
2615 * Device connection must be stable, no more debouncing needed.
2616 * Returns device in USB_STATE_ADDRESS, except on error.
2618 * If this is called for an already-existing device (as part of
2619 * usb_reset_and_verify_device), the caller must own the device lock. For a
2620 * newly detected device that is not accessible through any global
2621 * pointers, it's not necessary to lock the device.
2624 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2627 static DEFINE_MUTEX(usb_address0_mutex);
2629 struct usb_device *hdev = hub->hdev;
2630 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
2632 unsigned delay = HUB_SHORT_RESET_TIME;
2633 enum usb_device_speed oldspeed = udev->speed;
2635 int devnum = udev->devnum;
2637 /* root hub ports have a slightly longer reset period
2638 * (from USB 2.0 spec, section 7.1.7.5)
2640 if (!hdev->parent) {
2641 delay = HUB_ROOT_RESET_TIME;
2642 if (port1 == hdev->bus->otg_port)
2643 hdev->bus->b_hnp_enable = 0;
2646 /* Some low speed devices have problems with the quick delay, so */
2647 /* be a bit pessimistic with those devices. RHbug #23670 */
2648 if (oldspeed == USB_SPEED_LOW)
2649 delay = HUB_LONG_RESET_TIME;
2651 mutex_lock(&usb_address0_mutex);
2653 if (!udev->config && oldspeed == USB_SPEED_SUPER) {
2654 /* Don't reset USB 3.0 devices during an initial setup */
2655 usb_set_device_state(udev, USB_STATE_DEFAULT);
2657 /* Reset the device; full speed may morph to high speed */
2658 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
2659 retval = hub_port_reset(hub, port1, udev, delay);
2660 if (retval < 0) /* error or disconnect */
2662 /* success, speed is known */
2666 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2667 dev_dbg(&udev->dev, "device reset changed speed!\n");
2670 oldspeed = udev->speed;
2672 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2673 * it's fixed size except for full speed devices.
2674 * For Wireless USB devices, ep0 max packet is always 512 (tho
2675 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
2677 switch (udev->speed) {
2678 case USB_SPEED_SUPER:
2679 case USB_SPEED_WIRELESS: /* fixed at 512 */
2680 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
2682 case USB_SPEED_HIGH: /* fixed at 64 */
2683 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
2685 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
2686 /* to determine the ep0 maxpacket size, try to read
2687 * the device descriptor to get bMaxPacketSize0 and
2688 * then correct our initial guess.
2690 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
2692 case USB_SPEED_LOW: /* fixed at 8 */
2693 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
2700 switch (udev->speed) {
2701 case USB_SPEED_LOW: speed = "low"; break;
2702 case USB_SPEED_FULL: speed = "full"; break;
2703 case USB_SPEED_HIGH: speed = "high"; break;
2704 case USB_SPEED_SUPER:
2707 case USB_SPEED_WIRELESS:
2711 default: speed = "?"; break;
2713 if (udev->speed != USB_SPEED_SUPER)
2714 dev_info(&udev->dev,
2715 "%s %s speed %sUSB device using %s and address %d\n",
2716 (udev->config) ? "reset" : "new", speed, type,
2717 udev->bus->controller->driver->name, devnum);
2719 /* Set up TT records, if needed */
2721 udev->tt = hdev->tt;
2722 udev->ttport = hdev->ttport;
2723 } else if (udev->speed != USB_SPEED_HIGH
2724 && hdev->speed == USB_SPEED_HIGH) {
2725 udev->tt = &hub->tt;
2726 udev->ttport = port1;
2729 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2730 * Because device hardware and firmware is sometimes buggy in
2731 * this area, and this is how Linux has done it for ages.
2732 * Change it cautiously.
2734 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2735 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2736 * so it may help with some non-standards-compliant devices.
2737 * Otherwise we start with SET_ADDRESS and then try to read the
2738 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2741 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
2743 * An xHCI controller cannot send any packets to a device until
2744 * a set address command successfully completes.
2746 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3)) {
2747 struct usb_device_descriptor *buf;
2750 #define GET_DESCRIPTOR_BUFSIZE 64
2751 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2757 /* Retry on all errors; some devices are flakey.
2758 * 255 is for WUSB devices, we actually need to use
2759 * 512 (WUSB1.0[4.8.1]).
2761 for (j = 0; j < 3; ++j) {
2762 buf->bMaxPacketSize0 = 0;
2763 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2764 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2765 USB_DT_DEVICE << 8, 0,
2766 buf, GET_DESCRIPTOR_BUFSIZE,
2767 initial_descriptor_timeout);
2768 switch (buf->bMaxPacketSize0) {
2769 case 8: case 16: case 32: case 64: case 255:
2770 if (buf->bDescriptorType ==
2784 udev->descriptor.bMaxPacketSize0 =
2785 buf->bMaxPacketSize0;
2788 retval = hub_port_reset(hub, port1, udev, delay);
2789 if (retval < 0) /* error or disconnect */
2791 if (oldspeed != udev->speed) {
2793 "device reset changed speed!\n");
2799 "device descriptor read/64, error %d\n",
2804 #undef GET_DESCRIPTOR_BUFSIZE
2808 * If device is WUSB, we already assigned an
2809 * unauthorized address in the Connect Ack sequence;
2810 * authorization will assign the final address.
2812 if (udev->wusb == 0) {
2813 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
2814 retval = hub_set_address(udev, devnum);
2821 "device not accepting address %d, error %d\n",
2825 if (udev->speed == USB_SPEED_SUPER) {
2826 devnum = udev->devnum;
2827 dev_info(&udev->dev,
2828 "%s SuperSpeed USB device using %s and address %d\n",
2829 (udev->config) ? "reset" : "new",
2830 udev->bus->controller->driver->name, devnum);
2833 /* cope with hardware quirkiness:
2834 * - let SET_ADDRESS settle, some device hardware wants it
2835 * - read ep0 maxpacket even for high and low speed,
2838 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3))
2842 retval = usb_get_device_descriptor(udev, 8);
2845 "device descriptor read/8, error %d\n",
2857 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
2858 udev->speed == USB_SPEED_SUPER)
2861 i = udev->descriptor.bMaxPacketSize0;
2862 if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
2863 if (udev->speed == USB_SPEED_LOW ||
2864 !(i == 8 || i == 16 || i == 32 || i == 64)) {
2865 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
2869 if (udev->speed == USB_SPEED_FULL)
2870 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
2872 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
2873 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
2874 usb_ep0_reinit(udev);
2877 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
2878 if (retval < (signed)sizeof(udev->descriptor)) {
2879 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
2887 /* notify HCD that we have a device connected and addressed */
2888 if (hcd->driver->update_device)
2889 hcd->driver->update_device(hcd, udev);
2892 hub_port_disable(hub, port1, 0);
2893 update_address(udev, devnum); /* for disconnect processing */
2895 mutex_unlock(&usb_address0_mutex);
2900 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
2902 struct usb_qualifier_descriptor *qual;
2905 qual = kmalloc (sizeof *qual, GFP_KERNEL);
2909 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
2910 qual, sizeof *qual);
2911 if (status == sizeof *qual) {
2912 dev_info(&udev->dev, "not running at top speed; "
2913 "connect to a high speed hub\n");
2914 /* hub LEDs are probably harder to miss than syslog */
2915 if (hub->has_indicators) {
2916 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
2917 schedule_delayed_work (&hub->leds, 0);
2924 hub_power_remaining (struct usb_hub *hub)
2926 struct usb_device *hdev = hub->hdev;
2930 if (!hub->limited_power)
2933 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
2934 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
2935 struct usb_device *udev = hdev->children[port1 - 1];
2941 /* Unconfigured devices may not use more than 100mA,
2942 * or 8mA for OTG ports */
2943 if (udev->actconfig)
2944 delta = udev->actconfig->desc.bMaxPower * 2;
2945 else if (port1 != udev->bus->otg_port || hdev->parent)
2949 if (delta > hub->mA_per_port)
2950 dev_warn(&udev->dev,
2951 "%dmA is over %umA budget for port %d!\n",
2952 delta, hub->mA_per_port, port1);
2955 if (remaining < 0) {
2956 dev_warn(hub->intfdev, "%dmA over power budget!\n",
2963 /* Handle physical or logical connection change events.
2964 * This routine is called when:
2965 * a port connection-change occurs;
2966 * a port enable-change occurs (often caused by EMI);
2967 * usb_reset_and_verify_device() encounters changed descriptors (as from
2968 * a firmware download)
2969 * caller already locked the hub
2971 static void hub_port_connect_change(struct usb_hub *hub, int port1,
2972 u16 portstatus, u16 portchange)
2974 struct usb_device *hdev = hub->hdev;
2975 struct device *hub_dev = hub->intfdev;
2976 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
2977 unsigned wHubCharacteristics =
2978 le16_to_cpu(hub->descriptor->wHubCharacteristics);
2979 struct usb_device *udev;
2983 "port %d, status %04x, change %04x, %s\n",
2984 port1, portstatus, portchange, portspeed (portstatus));
2986 if (hub->has_indicators) {
2987 set_port_led(hub, port1, HUB_LED_AUTO);
2988 hub->indicator[port1-1] = INDICATOR_AUTO;
2991 #ifdef CONFIG_USB_OTG
2992 /* during HNP, don't repeat the debounce */
2993 if (hdev->bus->is_b_host)
2994 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
2995 USB_PORT_STAT_C_ENABLE);
2998 /* Try to resuscitate an existing device */
2999 udev = hdev->children[port1-1];
3000 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
3001 udev->state != USB_STATE_NOTATTACHED) {
3002 usb_lock_device(udev);
3003 if (portstatus & USB_PORT_STAT_ENABLE) {
3004 status = 0; /* Nothing to do */
3006 #ifdef CONFIG_USB_SUSPEND
3007 } else if (udev->state == USB_STATE_SUSPENDED &&
3008 udev->persist_enabled) {
3009 /* For a suspended device, treat this as a
3010 * remote wakeup event.
3012 status = usb_remote_wakeup(udev);
3016 status = -ENODEV; /* Don't resuscitate */
3018 usb_unlock_device(udev);
3021 clear_bit(port1, hub->change_bits);
3026 /* Disconnect any existing devices under this port */
3028 usb_disconnect(&hdev->children[port1-1]);
3029 clear_bit(port1, hub->change_bits);
3031 /* We can forget about a "removed" device when there's a physical
3032 * disconnect or the connect status changes.
3034 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
3035 (portchange & USB_PORT_STAT_C_CONNECTION))
3036 clear_bit(port1, hub->removed_bits);
3038 if (portchange & (USB_PORT_STAT_C_CONNECTION |
3039 USB_PORT_STAT_C_ENABLE)) {
3040 status = hub_port_debounce(hub, port1);
3042 if (printk_ratelimit())
3043 dev_err(hub_dev, "connect-debounce failed, "
3044 "port %d disabled\n", port1);
3045 portstatus &= ~USB_PORT_STAT_CONNECTION;
3047 portstatus = status;
3051 /* Return now if debouncing failed or nothing is connected or
3052 * the device was "removed".
3054 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
3055 test_bit(port1, hub->removed_bits)) {
3057 /* maybe switch power back on (e.g. root hub was reset) */
3058 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
3059 && !(portstatus & USB_PORT_STAT_POWER))
3060 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
3062 if (portstatus & USB_PORT_STAT_ENABLE)
3067 for (i = 0; i < SET_CONFIG_TRIES; i++) {
3069 /* reallocate for each attempt, since references
3070 * to the previous one can escape in various ways
3072 udev = usb_alloc_dev(hdev, hdev->bus, port1);
3075 "couldn't allocate port %d usb_device\n",
3080 usb_set_device_state(udev, USB_STATE_POWERED);
3081 udev->bus_mA = hub->mA_per_port;
3082 udev->level = hdev->level + 1;
3083 udev->wusb = hub_is_wusb(hub);
3086 * USB 3.0 devices are reset automatically before the connect
3087 * port status change appears, and the root hub port status
3088 * shows the correct speed. We also get port change
3089 * notifications for USB 3.0 devices from the USB 3.0 portion of
3090 * an external USB 3.0 hub, but this isn't handled correctly yet
3094 if (!(hcd->driver->flags & HCD_USB3))
3095 udev->speed = USB_SPEED_UNKNOWN;
3096 else if ((hdev->parent == NULL) &&
3097 (portstatus & USB_PORT_STAT_SUPER_SPEED))
3098 udev->speed = USB_SPEED_SUPER;
3100 udev->speed = USB_SPEED_UNKNOWN;
3104 * Note xHCI needs to issue an address device command later
3105 * in the hub_port_init sequence for SS/HS/FS/LS devices,
3106 * and xHC will assign an address to the device. But use
3107 * kernel assigned address here, to avoid any address conflict
3110 choose_address(udev);
3111 if (udev->devnum <= 0) {
3112 status = -ENOTCONN; /* Don't retry */
3116 /* reset (non-USB 3.0 devices) and get descriptor */
3117 status = hub_port_init(hub, udev, port1, i);
3121 usb_detect_quirks(udev);
3122 if (udev->quirks & USB_QUIRK_DELAY_INIT)
3125 /* consecutive bus-powered hubs aren't reliable; they can
3126 * violate the voltage drop budget. if the new child has
3127 * a "powered" LED, users should notice we didn't enable it
3128 * (without reading syslog), even without per-port LEDs
3131 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
3132 && udev->bus_mA <= 100) {
3135 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
3138 dev_dbg(&udev->dev, "get status %d ?\n", status);
3141 le16_to_cpus(&devstat);
3142 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
3144 "can't connect bus-powered hub "
3146 if (hub->has_indicators) {
3147 hub->indicator[port1-1] =
3148 INDICATOR_AMBER_BLINK;
3149 schedule_delayed_work (&hub->leds, 0);
3151 status = -ENOTCONN; /* Don't retry */
3156 /* check for devices running slower than they could */
3157 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
3158 && udev->speed == USB_SPEED_FULL
3159 && highspeed_hubs != 0)
3160 check_highspeed (hub, udev, port1);
3162 /* Store the parent's children[] pointer. At this point
3163 * udev becomes globally accessible, although presumably
3164 * no one will look at it until hdev is unlocked.
3168 /* We mustn't add new devices if the parent hub has
3169 * been disconnected; we would race with the
3170 * recursively_mark_NOTATTACHED() routine.
3172 spin_lock_irq(&device_state_lock);
3173 if (hdev->state == USB_STATE_NOTATTACHED)
3176 hdev->children[port1-1] = udev;
3177 spin_unlock_irq(&device_state_lock);
3179 /* Run it through the hoops (find a driver, etc) */
3181 status = usb_new_device(udev);
3183 spin_lock_irq(&device_state_lock);
3184 hdev->children[port1-1] = NULL;
3185 spin_unlock_irq(&device_state_lock);
3192 status = hub_power_remaining(hub);
3194 dev_dbg(hub_dev, "%dmA power budget left\n", status);
3199 hub_port_disable(hub, port1, 1);
3201 usb_ep0_reinit(udev);
3202 release_address(udev);
3205 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
3208 if (hub->hdev->parent ||
3209 !hcd->driver->port_handed_over ||
3210 !(hcd->driver->port_handed_over)(hcd, port1))
3211 dev_err(hub_dev, "unable to enumerate USB device on port %d\n",
3215 hub_port_disable(hub, port1, 1);
3216 if (hcd->driver->relinquish_port && !hub->hdev->parent)
3217 hcd->driver->relinquish_port(hcd, port1);
3220 static void hub_events(void)
3222 struct list_head *tmp;
3223 struct usb_device *hdev;
3224 struct usb_interface *intf;
3225 struct usb_hub *hub;
3226 struct device *hub_dev;
3235 * We restart the list every time to avoid a deadlock with
3236 * deleting hubs downstream from this one. This should be
3237 * safe since we delete the hub from the event list.
3238 * Not the most efficient, but avoids deadlocks.
3242 /* Grab the first entry at the beginning of the list */
3243 spin_lock_irq(&hub_event_lock);
3244 if (list_empty(&hub_event_list)) {
3245 spin_unlock_irq(&hub_event_lock);
3249 tmp = hub_event_list.next;
3252 hub = list_entry(tmp, struct usb_hub, event_list);
3253 kref_get(&hub->kref);
3254 spin_unlock_irq(&hub_event_lock);
3257 hub_dev = hub->intfdev;
3258 intf = to_usb_interface(hub_dev);
3259 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
3260 hdev->state, hub->descriptor
3261 ? hub->descriptor->bNbrPorts
3263 /* NOTE: expects max 15 ports... */
3264 (u16) hub->change_bits[0],
3265 (u16) hub->event_bits[0]);
3267 /* Lock the device, then check to see if we were
3268 * disconnected while waiting for the lock to succeed. */
3269 usb_lock_device(hdev);
3270 if (unlikely(hub->disconnected))
3271 goto loop_disconnected;
3273 /* If the hub has died, clean up after it */
3274 if (hdev->state == USB_STATE_NOTATTACHED) {
3275 hub->error = -ENODEV;
3276 hub_quiesce(hub, HUB_DISCONNECT);
3281 ret = usb_autopm_get_interface(intf);
3283 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
3287 /* If this is an inactive hub, do nothing */
3292 dev_dbg (hub_dev, "resetting for error %d\n",
3295 ret = usb_reset_device(hdev);
3298 "error resetting hub: %d\n", ret);
3306 /* deal with port status changes */
3307 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
3308 if (test_bit(i, hub->busy_bits))
3310 connect_change = test_bit(i, hub->change_bits);
3311 if (!test_and_clear_bit(i, hub->event_bits) &&
3315 ret = hub_port_status(hub, i,
3316 &portstatus, &portchange);
3320 if (portchange & USB_PORT_STAT_C_CONNECTION) {
3321 clear_port_feature(hdev, i,
3322 USB_PORT_FEAT_C_CONNECTION);
3326 if (portchange & USB_PORT_STAT_C_ENABLE) {
3327 if (!connect_change)
3329 "port %d enable change, "
3332 clear_port_feature(hdev, i,
3333 USB_PORT_FEAT_C_ENABLE);
3336 * EM interference sometimes causes badly
3337 * shielded USB devices to be shutdown by
3338 * the hub, this hack enables them again.
3339 * Works at least with mouse driver.
3341 if (!(portstatus & USB_PORT_STAT_ENABLE)
3343 && hdev->children[i-1]) {
3346 "disabled by hub (EMI?), "
3353 if (portchange & USB_PORT_STAT_C_SUSPEND) {
3354 struct usb_device *udev;
3356 clear_port_feature(hdev, i,
3357 USB_PORT_FEAT_C_SUSPEND);
3358 udev = hdev->children[i-1];
3360 /* TRSMRCY = 10 msec */
3363 usb_lock_device(udev);
3364 ret = usb_remote_wakeup(hdev->
3366 usb_unlock_device(udev);
3371 hub_port_disable(hub, i, 1);
3374 "resume on port %d, status %d\n",
3378 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
3380 "over-current change on port %d\n",
3382 clear_port_feature(hdev, i,
3383 USB_PORT_FEAT_C_OVER_CURRENT);
3384 hub_power_on(hub, true);
3387 if (portchange & USB_PORT_STAT_C_RESET) {
3389 "reset change on port %d\n",
3391 clear_port_feature(hdev, i,
3392 USB_PORT_FEAT_C_RESET);
3396 hub_port_connect_change(hub, i,
3397 portstatus, portchange);
3400 /* deal with hub status changes */
3401 if (test_and_clear_bit(0, hub->event_bits) == 0)
3403 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
3404 dev_err (hub_dev, "get_hub_status failed\n");
3406 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
3407 dev_dbg (hub_dev, "power change\n");
3408 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
3409 if (hubstatus & HUB_STATUS_LOCAL_POWER)
3410 /* FIXME: Is this always true? */
3411 hub->limited_power = 1;
3413 hub->limited_power = 0;
3415 if (hubchange & HUB_CHANGE_OVERCURRENT) {
3416 dev_dbg (hub_dev, "overcurrent change\n");
3417 msleep(500); /* Cool down */
3418 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
3419 hub_power_on(hub, true);
3424 /* Balance the usb_autopm_get_interface() above */
3425 usb_autopm_put_interface_no_suspend(intf);
3427 /* Balance the usb_autopm_get_interface_no_resume() in
3428 * kick_khubd() and allow autosuspend.
3430 usb_autopm_put_interface(intf);
3432 usb_unlock_device(hdev);
3433 kref_put(&hub->kref, hub_release);
3435 } /* end while (1) */
3438 static int hub_thread(void *__unused)
3440 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
3441 * port handover. Otherwise it might see that a full-speed device
3442 * was gone before the EHCI controller had handed its port over to
3443 * the companion full-speed controller.
3449 wait_event_freezable(khubd_wait,
3450 !list_empty(&hub_event_list) ||
3451 kthread_should_stop());
3452 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
3454 pr_debug("%s: khubd exiting\n", usbcore_name);
3458 static const struct usb_device_id hub_id_table[] = {
3459 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
3460 .bDeviceClass = USB_CLASS_HUB},
3461 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
3462 .bInterfaceClass = USB_CLASS_HUB},
3463 { } /* Terminating entry */
3466 MODULE_DEVICE_TABLE (usb, hub_id_table);
3468 static struct usb_driver hub_driver = {
3471 .disconnect = hub_disconnect,
3472 .suspend = hub_suspend,
3473 .resume = hub_resume,
3474 .reset_resume = hub_reset_resume,
3475 .pre_reset = hub_pre_reset,
3476 .post_reset = hub_post_reset,
3477 .unlocked_ioctl = hub_ioctl,
3478 .id_table = hub_id_table,
3479 .supports_autosuspend = 1,
3482 int usb_hub_init(void)
3484 if (usb_register(&hub_driver) < 0) {
3485 printk(KERN_ERR "%s: can't register hub driver\n",
3490 khubd_task = kthread_run(hub_thread, NULL, "khubd");
3491 if (!IS_ERR(khubd_task))
3494 /* Fall through if kernel_thread failed */
3495 usb_deregister(&hub_driver);
3496 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
3501 void usb_hub_cleanup(void)
3503 kthread_stop(khubd_task);
3506 * Hub resources are freed for us by usb_deregister. It calls
3507 * usb_driver_purge on every device which in turn calls that
3508 * devices disconnect function if it is using this driver.
3509 * The hub_disconnect function takes care of releasing the
3510 * individual hub resources. -greg
3512 usb_deregister(&hub_driver);
3513 } /* usb_hub_cleanup() */
3515 static int descriptors_changed(struct usb_device *udev,
3516 struct usb_device_descriptor *old_device_descriptor)
3520 unsigned serial_len = 0;
3522 unsigned old_length;
3526 if (memcmp(&udev->descriptor, old_device_descriptor,
3527 sizeof(*old_device_descriptor)) != 0)
3530 /* Since the idVendor, idProduct, and bcdDevice values in the
3531 * device descriptor haven't changed, we will assume the
3532 * Manufacturer and Product strings haven't changed either.
3533 * But the SerialNumber string could be different (e.g., a
3534 * different flash card of the same brand).
3537 serial_len = strlen(udev->serial) + 1;
3540 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3541 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3542 len = max(len, old_length);
3545 buf = kmalloc(len, GFP_NOIO);
3547 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
3548 /* assume the worst */
3551 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3552 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3553 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
3555 if (length != old_length) {
3556 dev_dbg(&udev->dev, "config index %d, error %d\n",
3561 if (memcmp (buf, udev->rawdescriptors[index], old_length)
3563 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
3565 ((struct usb_config_descriptor *) buf)->
3566 bConfigurationValue);
3572 if (!changed && serial_len) {
3573 length = usb_string(udev, udev->descriptor.iSerialNumber,
3575 if (length + 1 != serial_len) {
3576 dev_dbg(&udev->dev, "serial string error %d\n",
3579 } else if (memcmp(buf, udev->serial, length) != 0) {
3580 dev_dbg(&udev->dev, "serial string changed\n");
3590 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
3591 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3593 * WARNING - don't use this routine to reset a composite device
3594 * (one with multiple interfaces owned by separate drivers)!
3595 * Use usb_reset_device() instead.
3597 * Do a port reset, reassign the device's address, and establish its
3598 * former operating configuration. If the reset fails, or the device's
3599 * descriptors change from their values before the reset, or the original
3600 * configuration and altsettings cannot be restored, a flag will be set
3601 * telling khubd to pretend the device has been disconnected and then
3602 * re-connected. All drivers will be unbound, and the device will be
3603 * re-enumerated and probed all over again.
3605 * Returns 0 if the reset succeeded, -ENODEV if the device has been
3606 * flagged for logical disconnection, or some other negative error code
3607 * if the reset wasn't even attempted.
3609 * The caller must own the device lock. For example, it's safe to use
3610 * this from a driver probe() routine after downloading new firmware.
3611 * For calls that might not occur during probe(), drivers should lock
3612 * the device using usb_lock_device_for_reset().
3614 * Locking exception: This routine may also be called from within an
3615 * autoresume handler. Such usage won't conflict with other tasks
3616 * holding the device lock because these tasks should always call
3617 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
3619 static int usb_reset_and_verify_device(struct usb_device *udev)
3621 struct usb_device *parent_hdev = udev->parent;
3622 struct usb_hub *parent_hub;
3623 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3624 struct usb_device_descriptor descriptor = udev->descriptor;
3626 int port1 = udev->portnum;
3628 if (udev->state == USB_STATE_NOTATTACHED ||
3629 udev->state == USB_STATE_SUSPENDED) {
3630 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3636 /* this requires hcd-specific logic; see ohci_restart() */
3637 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
3640 parent_hub = hdev_to_hub(parent_hdev);
3642 set_bit(port1, parent_hub->busy_bits);
3643 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
3645 /* ep0 maxpacket size may change; let the HCD know about it.
3646 * Other endpoints will be handled by re-enumeration. */
3647 usb_ep0_reinit(udev);
3648 ret = hub_port_init(parent_hub, udev, port1, i);
3649 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
3652 clear_bit(port1, parent_hub->busy_bits);
3657 /* Device might have changed firmware (DFU or similar) */
3658 if (descriptors_changed(udev, &descriptor)) {
3659 dev_info(&udev->dev, "device firmware changed\n");
3660 udev->descriptor = descriptor; /* for disconnect() calls */
3664 /* Restore the device's previous configuration */
3665 if (!udev->actconfig)
3668 mutex_lock(&hcd->bandwidth_mutex);
3669 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
3671 dev_warn(&udev->dev,
3672 "Busted HC? Not enough HCD resources for "
3673 "old configuration.\n");
3674 mutex_unlock(&hcd->bandwidth_mutex);
3677 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3678 USB_REQ_SET_CONFIGURATION, 0,
3679 udev->actconfig->desc.bConfigurationValue, 0,
3680 NULL, 0, USB_CTRL_SET_TIMEOUT);
3683 "can't restore configuration #%d (error=%d)\n",
3684 udev->actconfig->desc.bConfigurationValue, ret);
3685 mutex_unlock(&hcd->bandwidth_mutex);
3688 mutex_unlock(&hcd->bandwidth_mutex);
3689 usb_set_device_state(udev, USB_STATE_CONFIGURED);
3691 /* Put interfaces back into the same altsettings as before.
3692 * Don't bother to send the Set-Interface request for interfaces
3693 * that were already in altsetting 0; besides being unnecessary,
3694 * many devices can't handle it. Instead just reset the host-side
3697 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
3698 struct usb_host_config *config = udev->actconfig;
3699 struct usb_interface *intf = config->interface[i];
3700 struct usb_interface_descriptor *desc;
3702 desc = &intf->cur_altsetting->desc;
3703 if (desc->bAlternateSetting == 0) {
3704 usb_disable_interface(udev, intf, true);
3705 usb_enable_interface(udev, intf, true);
3708 /* Let the bandwidth allocation function know that this
3709 * device has been reset, and it will have to use
3710 * alternate setting 0 as the current alternate setting.
3712 intf->resetting_device = 1;
3713 ret = usb_set_interface(udev, desc->bInterfaceNumber,
3714 desc->bAlternateSetting);
3715 intf->resetting_device = 0;
3718 dev_err(&udev->dev, "failed to restore interface %d "
3719 "altsetting %d (error=%d)\n",
3720 desc->bInterfaceNumber,
3721 desc->bAlternateSetting,
3731 hub_port_logical_disconnect(parent_hub, port1);
3736 * usb_reset_device - warn interface drivers and perform a USB port reset
3737 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3739 * Warns all drivers bound to registered interfaces (using their pre_reset
3740 * method), performs the port reset, and then lets the drivers know that
3741 * the reset is over (using their post_reset method).
3743 * Return value is the same as for usb_reset_and_verify_device().
3745 * The caller must own the device lock. For example, it's safe to use
3746 * this from a driver probe() routine after downloading new firmware.
3747 * For calls that might not occur during probe(), drivers should lock
3748 * the device using usb_lock_device_for_reset().
3750 * If an interface is currently being probed or disconnected, we assume
3751 * its driver knows how to handle resets. For all other interfaces,
3752 * if the driver doesn't have pre_reset and post_reset methods then
3753 * we attempt to unbind it and rebind afterward.
3755 int usb_reset_device(struct usb_device *udev)
3759 struct usb_host_config *config = udev->actconfig;
3761 if (udev->state == USB_STATE_NOTATTACHED ||
3762 udev->state == USB_STATE_SUSPENDED) {
3763 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3768 /* Prevent autosuspend during the reset */
3769 usb_autoresume_device(udev);
3772 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
3773 struct usb_interface *cintf = config->interface[i];
3774 struct usb_driver *drv;
3777 if (cintf->dev.driver) {
3778 drv = to_usb_driver(cintf->dev.driver);
3779 if (drv->pre_reset && drv->post_reset)
3780 unbind = (drv->pre_reset)(cintf);
3781 else if (cintf->condition ==
3782 USB_INTERFACE_BOUND)
3785 usb_forced_unbind_intf(cintf);
3790 ret = usb_reset_and_verify_device(udev);
3793 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
3794 struct usb_interface *cintf = config->interface[i];
3795 struct usb_driver *drv;
3796 int rebind = cintf->needs_binding;
3798 if (!rebind && cintf->dev.driver) {
3799 drv = to_usb_driver(cintf->dev.driver);
3800 if (drv->post_reset)
3801 rebind = (drv->post_reset)(cintf);
3802 else if (cintf->condition ==
3803 USB_INTERFACE_BOUND)
3806 if (ret == 0 && rebind)
3807 usb_rebind_intf(cintf);
3811 usb_autosuspend_device(udev);
3814 EXPORT_SYMBOL_GPL(usb_reset_device);
3818 * usb_queue_reset_device - Reset a USB device from an atomic context
3819 * @iface: USB interface belonging to the device to reset
3821 * This function can be used to reset a USB device from an atomic
3822 * context, where usb_reset_device() won't work (as it blocks).
3824 * Doing a reset via this method is functionally equivalent to calling
3825 * usb_reset_device(), except for the fact that it is delayed to a
3826 * workqueue. This means that any drivers bound to other interfaces
3827 * might be unbound, as well as users from usbfs in user space.
3831 * - Scheduling two resets at the same time from two different drivers
3832 * attached to two different interfaces of the same device is
3833 * possible; depending on how the driver attached to each interface
3834 * handles ->pre_reset(), the second reset might happen or not.
3836 * - If a driver is unbound and it had a pending reset, the reset will
3839 * - This function can be called during .probe() or .disconnect()
3840 * times. On return from .disconnect(), any pending resets will be
3843 * There is no no need to lock/unlock the @reset_ws as schedule_work()
3846 * NOTE: We don't do any reference count tracking because it is not
3847 * needed. The lifecycle of the work_struct is tied to the
3848 * usb_interface. Before destroying the interface we cancel the
3849 * work_struct, so the fact that work_struct is queued and or
3850 * running means the interface (and thus, the device) exist and
3853 void usb_queue_reset_device(struct usb_interface *iface)
3855 schedule_work(&iface->reset_ws);
3857 EXPORT_SYMBOL_GPL(usb_queue_reset_device);