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/kthread.h>
23 #include <linux/mutex.h>
24 #include <linux/freezer.h>
26 #include <asm/uaccess.h>
27 #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 */
75 unsigned limited_power:1;
77 unsigned disconnected:1;
79 unsigned has_indicators:1;
80 u8 indicator[USB_MAXCHILDREN];
81 struct delayed_work leds;
82 struct delayed_work init_work;
87 /* Protect struct usb_device->state and ->children members
88 * Note: Both are also protected by ->dev.sem, except that ->state can
89 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
90 static DEFINE_SPINLOCK(device_state_lock);
92 /* khubd's worklist and its lock */
93 static DEFINE_SPINLOCK(hub_event_lock);
94 static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
97 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
99 static struct task_struct *khubd_task;
101 /* cycle leds on hubs that aren't blinking for attention */
102 static int blinkenlights = 0;
103 module_param (blinkenlights, bool, S_IRUGO);
104 MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
107 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
108 * 10 seconds to send reply for the initial 64-byte descriptor request.
110 /* define initial 64-byte descriptor request timeout in milliseconds */
111 static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
112 module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
113 MODULE_PARM_DESC(initial_descriptor_timeout,
114 "initial 64-byte descriptor request timeout in milliseconds "
115 "(default 5000 - 5.0 seconds)");
118 * As of 2.6.10 we introduce a new USB device initialization scheme which
119 * closely resembles the way Windows works. Hopefully it will be compatible
120 * with a wider range of devices than the old scheme. However some previously
121 * working devices may start giving rise to "device not accepting address"
122 * errors; if that happens the user can try the old scheme by adjusting the
123 * following module parameters.
125 * For maximum flexibility there are two boolean parameters to control the
126 * hub driver's behavior. On the first initialization attempt, if the
127 * "old_scheme_first" parameter is set then the old scheme will be used,
128 * otherwise the new scheme is used. If that fails and "use_both_schemes"
129 * is set, then the driver will make another attempt, using the other scheme.
131 static int old_scheme_first = 0;
132 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
133 MODULE_PARM_DESC(old_scheme_first,
134 "start with the old device initialization scheme");
136 static int use_both_schemes = 1;
137 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
138 MODULE_PARM_DESC(use_both_schemes,
139 "try the other device initialization scheme if the "
142 /* Mutual exclusion for EHCI CF initialization. This interferes with
143 * port reset on some companion controllers.
145 DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
146 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
148 #define HUB_DEBOUNCE_TIMEOUT 1500
149 #define HUB_DEBOUNCE_STEP 25
150 #define HUB_DEBOUNCE_STABLE 100
153 static int usb_reset_and_verify_device(struct usb_device *udev);
155 static inline char *portspeed(int portstatus)
157 if (portstatus & (1 << USB_PORT_FEAT_HIGHSPEED))
159 else if (portstatus & (1 << USB_PORT_FEAT_LOWSPEED))
161 else if (portstatus & (1 << USB_PORT_FEAT_SUPERSPEED))
167 /* Note that hdev or one of its children must be locked! */
168 static struct usb_hub *hdev_to_hub(struct usb_device *hdev)
170 if (!hdev || !hdev->actconfig)
172 return usb_get_intfdata(hdev->actconfig->interface[0]);
175 /* USB 2.0 spec Section 11.24.4.5 */
176 static int get_hub_descriptor(struct usb_device *hdev, void *data, int size)
180 for (i = 0; i < 3; i++) {
181 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
182 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
183 USB_DT_HUB << 8, 0, data, size,
184 USB_CTRL_GET_TIMEOUT);
185 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
192 * USB 2.0 spec Section 11.24.2.1
194 static int clear_hub_feature(struct usb_device *hdev, int feature)
196 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
197 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
201 * USB 2.0 spec Section 11.24.2.2
203 static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
205 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
206 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
211 * USB 2.0 spec Section 11.24.2.13
213 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
215 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
216 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
221 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
222 * for info about using port indicators
224 static void set_port_led(
230 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
231 USB_PORT_FEAT_INDICATOR);
233 dev_dbg (hub->intfdev,
234 "port %d indicator %s status %d\n",
236 ({ char *s; switch (selector) {
237 case HUB_LED_AMBER: s = "amber"; break;
238 case HUB_LED_GREEN: s = "green"; break;
239 case HUB_LED_OFF: s = "off"; break;
240 case HUB_LED_AUTO: s = "auto"; break;
241 default: s = "??"; break;
246 #define LED_CYCLE_PERIOD ((2*HZ)/3)
248 static void led_work (struct work_struct *work)
250 struct usb_hub *hub =
251 container_of(work, struct usb_hub, leds.work);
252 struct usb_device *hdev = hub->hdev;
254 unsigned changed = 0;
257 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
260 for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
261 unsigned selector, mode;
263 /* 30%-50% duty cycle */
265 switch (hub->indicator[i]) {
267 case INDICATOR_CYCLE:
269 selector = HUB_LED_AUTO;
270 mode = INDICATOR_AUTO;
272 /* blinking green = sw attention */
273 case INDICATOR_GREEN_BLINK:
274 selector = HUB_LED_GREEN;
275 mode = INDICATOR_GREEN_BLINK_OFF;
277 case INDICATOR_GREEN_BLINK_OFF:
278 selector = HUB_LED_OFF;
279 mode = INDICATOR_GREEN_BLINK;
281 /* blinking amber = hw attention */
282 case INDICATOR_AMBER_BLINK:
283 selector = HUB_LED_AMBER;
284 mode = INDICATOR_AMBER_BLINK_OFF;
286 case INDICATOR_AMBER_BLINK_OFF:
287 selector = HUB_LED_OFF;
288 mode = INDICATOR_AMBER_BLINK;
290 /* blink green/amber = reserved */
291 case INDICATOR_ALT_BLINK:
292 selector = HUB_LED_GREEN;
293 mode = INDICATOR_ALT_BLINK_OFF;
295 case INDICATOR_ALT_BLINK_OFF:
296 selector = HUB_LED_AMBER;
297 mode = INDICATOR_ALT_BLINK;
302 if (selector != HUB_LED_AUTO)
304 set_port_led(hub, i + 1, selector);
305 hub->indicator[i] = mode;
307 if (!changed && blinkenlights) {
309 cursor %= hub->descriptor->bNbrPorts;
310 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
311 hub->indicator[cursor] = INDICATOR_CYCLE;
315 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
318 /* use a short timeout for hub/port status fetches */
319 #define USB_STS_TIMEOUT 1000
320 #define USB_STS_RETRIES 5
323 * USB 2.0 spec Section 11.24.2.6
325 static int get_hub_status(struct usb_device *hdev,
326 struct usb_hub_status *data)
328 int i, status = -ETIMEDOUT;
330 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
331 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
332 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
333 data, sizeof(*data), USB_STS_TIMEOUT);
339 * USB 2.0 spec Section 11.24.2.7
341 static int get_port_status(struct usb_device *hdev, int port1,
342 struct usb_port_status *data)
344 int i, status = -ETIMEDOUT;
346 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
347 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
348 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
349 data, sizeof(*data), USB_STS_TIMEOUT);
354 static int hub_port_status(struct usb_hub *hub, int port1,
355 u16 *status, u16 *change)
359 mutex_lock(&hub->status_mutex);
360 ret = get_port_status(hub->hdev, port1, &hub->status->port);
362 dev_err(hub->intfdev,
363 "%s failed (err = %d)\n", __func__, ret);
367 *status = le16_to_cpu(hub->status->port.wPortStatus);
368 *change = le16_to_cpu(hub->status->port.wPortChange);
371 mutex_unlock(&hub->status_mutex);
375 static void kick_khubd(struct usb_hub *hub)
379 spin_lock_irqsave(&hub_event_lock, flags);
380 if (!hub->disconnected && list_empty(&hub->event_list)) {
381 list_add_tail(&hub->event_list, &hub_event_list);
383 /* Suppress autosuspend until khubd runs */
384 usb_autopm_get_interface_no_resume(
385 to_usb_interface(hub->intfdev));
386 wake_up(&khubd_wait);
388 spin_unlock_irqrestore(&hub_event_lock, flags);
391 void usb_kick_khubd(struct usb_device *hdev)
393 struct usb_hub *hub = hdev_to_hub(hdev);
400 /* completion function, fires on port status changes and various faults */
401 static void hub_irq(struct urb *urb)
403 struct usb_hub *hub = urb->context;
404 int status = urb->status;
409 case -ENOENT: /* synchronous unlink */
410 case -ECONNRESET: /* async unlink */
411 case -ESHUTDOWN: /* hardware going away */
414 default: /* presumably an error */
415 /* Cause a hub reset after 10 consecutive errors */
416 dev_dbg (hub->intfdev, "transfer --> %d\n", status);
417 if ((++hub->nerrors < 10) || hub->error)
422 /* let khubd handle things */
423 case 0: /* we got data: port status changed */
425 for (i = 0; i < urb->actual_length; ++i)
426 bits |= ((unsigned long) ((*hub->buffer)[i]))
428 hub->event_bits[0] = bits;
434 /* Something happened, let khubd figure it out */
441 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
442 && status != -ENODEV && status != -EPERM)
443 dev_err (hub->intfdev, "resubmit --> %d\n", status);
446 /* USB 2.0 spec Section 11.24.2.3 */
448 hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
450 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
451 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
456 * enumeration blocks khubd for a long time. we use keventd instead, since
457 * long blocking there is the exception, not the rule. accordingly, HCDs
458 * talking to TTs must queue control transfers (not just bulk and iso), so
459 * both can talk to the same hub concurrently.
461 static void hub_tt_work(struct work_struct *work)
463 struct usb_hub *hub =
464 container_of(work, struct usb_hub, tt.clear_work);
468 spin_lock_irqsave (&hub->tt.lock, flags);
469 while (--limit && !list_empty (&hub->tt.clear_list)) {
470 struct list_head *next;
471 struct usb_tt_clear *clear;
472 struct usb_device *hdev = hub->hdev;
473 const struct hc_driver *drv;
476 next = hub->tt.clear_list.next;
477 clear = list_entry (next, struct usb_tt_clear, clear_list);
478 list_del (&clear->clear_list);
480 /* drop lock so HCD can concurrently report other TT errors */
481 spin_unlock_irqrestore (&hub->tt.lock, flags);
482 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
485 "clear tt %d (%04x) error %d\n",
486 clear->tt, clear->devinfo, status);
488 /* Tell the HCD, even if the operation failed */
489 drv = clear->hcd->driver;
490 if (drv->clear_tt_buffer_complete)
491 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
494 spin_lock_irqsave(&hub->tt.lock, flags);
496 spin_unlock_irqrestore (&hub->tt.lock, flags);
500 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
501 * @urb: an URB associated with the failed or incomplete split transaction
503 * High speed HCDs use this to tell the hub driver that some split control or
504 * bulk transaction failed in a way that requires clearing internal state of
505 * a transaction translator. This is normally detected (and reported) from
508 * It may not be possible for that hub to handle additional full (or low)
509 * speed transactions until that state is fully cleared out.
511 int usb_hub_clear_tt_buffer(struct urb *urb)
513 struct usb_device *udev = urb->dev;
514 int pipe = urb->pipe;
515 struct usb_tt *tt = udev->tt;
517 struct usb_tt_clear *clear;
519 /* we've got to cope with an arbitrary number of pending TT clears,
520 * since each TT has "at least two" buffers that can need it (and
521 * there can be many TTs per hub). even if they're uncommon.
523 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
524 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
525 /* FIXME recover somehow ... RESET_TT? */
529 /* info that CLEAR_TT_BUFFER needs */
530 clear->tt = tt->multi ? udev->ttport : 1;
531 clear->devinfo = usb_pipeendpoint (pipe);
532 clear->devinfo |= udev->devnum << 4;
533 clear->devinfo |= usb_pipecontrol (pipe)
534 ? (USB_ENDPOINT_XFER_CONTROL << 11)
535 : (USB_ENDPOINT_XFER_BULK << 11);
536 if (usb_pipein (pipe))
537 clear->devinfo |= 1 << 15;
539 /* info for completion callback */
540 clear->hcd = bus_to_hcd(udev->bus);
543 /* tell keventd to clear state for this TT */
544 spin_lock_irqsave (&tt->lock, flags);
545 list_add_tail (&clear->clear_list, &tt->clear_list);
546 schedule_work(&tt->clear_work);
547 spin_unlock_irqrestore (&tt->lock, flags);
550 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
552 /* If do_delay is false, return the number of milliseconds the caller
555 static unsigned hub_power_on(struct usb_hub *hub, bool do_delay)
558 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
560 u16 wHubCharacteristics =
561 le16_to_cpu(hub->descriptor->wHubCharacteristics);
563 /* Enable power on each port. Some hubs have reserved values
564 * of LPSM (> 2) in their descriptors, even though they are
565 * USB 2.0 hubs. Some hubs do not implement port-power switching
566 * but only emulate it. In all cases, the ports won't work
567 * unless we send these messages to the hub.
569 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
570 dev_dbg(hub->intfdev, "enabling power on all ports\n");
572 dev_dbg(hub->intfdev, "trying to enable port power on "
573 "non-switchable hub\n");
574 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
575 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
577 /* Wait at least 100 msec for power to become stable */
578 delay = max(pgood_delay, (unsigned) 100);
584 static int hub_hub_status(struct usb_hub *hub,
585 u16 *status, u16 *change)
589 mutex_lock(&hub->status_mutex);
590 ret = get_hub_status(hub->hdev, &hub->status->hub);
592 dev_err (hub->intfdev,
593 "%s failed (err = %d)\n", __func__, ret);
595 *status = le16_to_cpu(hub->status->hub.wHubStatus);
596 *change = le16_to_cpu(hub->status->hub.wHubChange);
599 mutex_unlock(&hub->status_mutex);
603 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
605 struct usb_device *hdev = hub->hdev;
608 if (hdev->children[port1-1] && set_state)
609 usb_set_device_state(hdev->children[port1-1],
610 USB_STATE_NOTATTACHED);
612 ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
614 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
620 * Disable a port and mark a logical connnect-change event, so that some
621 * time later khubd will disconnect() any existing usb_device on the port
622 * and will re-enumerate if there actually is a device attached.
624 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
626 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
627 hub_port_disable(hub, port1, 1);
629 /* FIXME let caller ask to power down the port:
630 * - some devices won't enumerate without a VBUS power cycle
631 * - SRP saves power that way
632 * - ... new call, TBD ...
633 * That's easy if this hub can switch power per-port, and
634 * khubd reactivates the port later (timer, SRP, etc).
635 * Powerdown must be optional, because of reset/DFU.
638 set_bit(port1, hub->change_bits);
643 * usb_remove_device - disable a device's port on its parent hub
644 * @udev: device to be disabled and removed
645 * Context: @udev locked, must be able to sleep.
647 * After @udev's port has been disabled, khubd is notified and it will
648 * see that the device has been disconnected. When the device is
649 * physically unplugged and something is plugged in, the events will
650 * be received and processed normally.
652 int usb_remove_device(struct usb_device *udev)
655 struct usb_interface *intf;
657 if (!udev->parent) /* Can't remove a root hub */
659 hub = hdev_to_hub(udev->parent);
660 intf = to_usb_interface(hub->intfdev);
662 usb_autopm_get_interface(intf);
663 set_bit(udev->portnum, hub->removed_bits);
664 hub_port_logical_disconnect(hub, udev->portnum);
665 usb_autopm_put_interface(intf);
669 enum hub_activation_type {
670 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
671 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
674 static void hub_init_func2(struct work_struct *ws);
675 static void hub_init_func3(struct work_struct *ws);
677 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
679 struct usb_device *hdev = hub->hdev;
682 bool need_debounce_delay = false;
685 /* Continue a partial initialization */
686 if (type == HUB_INIT2)
688 if (type == HUB_INIT3)
691 /* After a resume, port power should still be on.
692 * For any other type of activation, turn it on.
694 if (type != HUB_RESUME) {
696 /* Speed up system boot by using a delayed_work for the
697 * hub's initial power-up delays. This is pretty awkward
698 * and the implementation looks like a home-brewed sort of
699 * setjmp/longjmp, but it saves at least 100 ms for each
700 * root hub (assuming usbcore is compiled into the kernel
701 * rather than as a module). It adds up.
703 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
704 * because for those activation types the ports have to be
705 * operational when we return. In theory this could be done
706 * for HUB_POST_RESET, but it's easier not to.
708 if (type == HUB_INIT) {
709 delay = hub_power_on(hub, false);
710 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func2);
711 schedule_delayed_work(&hub->init_work,
712 msecs_to_jiffies(delay));
714 /* Suppress autosuspend until init is done */
715 usb_autopm_get_interface_no_resume(
716 to_usb_interface(hub->intfdev));
717 return; /* Continues at init2: below */
719 hub_power_on(hub, true);
724 /* Check each port and set hub->change_bits to let khubd know
725 * which ports need attention.
727 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
728 struct usb_device *udev = hdev->children[port1-1];
729 u16 portstatus, portchange;
731 portstatus = portchange = 0;
732 status = hub_port_status(hub, port1, &portstatus, &portchange);
733 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
734 dev_dbg(hub->intfdev,
735 "port %d: status %04x change %04x\n",
736 port1, portstatus, portchange);
738 /* After anything other than HUB_RESUME (i.e., initialization
739 * or any sort of reset), every port should be disabled.
740 * Unconnected ports should likewise be disabled (paranoia),
741 * and so should ports for which we have no usb_device.
743 if ((portstatus & USB_PORT_STAT_ENABLE) && (
744 type != HUB_RESUME ||
745 !(portstatus & USB_PORT_STAT_CONNECTION) ||
747 udev->state == USB_STATE_NOTATTACHED)) {
748 clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
749 portstatus &= ~USB_PORT_STAT_ENABLE;
752 /* Clear status-change flags; we'll debounce later */
753 if (portchange & USB_PORT_STAT_C_CONNECTION) {
754 need_debounce_delay = true;
755 clear_port_feature(hub->hdev, port1,
756 USB_PORT_FEAT_C_CONNECTION);
758 if (portchange & USB_PORT_STAT_C_ENABLE) {
759 need_debounce_delay = true;
760 clear_port_feature(hub->hdev, port1,
761 USB_PORT_FEAT_C_ENABLE);
764 /* We can forget about a "removed" device when there's a
765 * physical disconnect or the connect status changes.
767 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
768 (portchange & USB_PORT_STAT_C_CONNECTION))
769 clear_bit(port1, hub->removed_bits);
771 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
772 /* Tell khubd to disconnect the device or
773 * check for a new connection
775 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
776 set_bit(port1, hub->change_bits);
778 } else if (portstatus & USB_PORT_STAT_ENABLE) {
779 /* The power session apparently survived the resume.
780 * If there was an overcurrent or suspend change
781 * (i.e., remote wakeup request), have khubd
785 set_bit(port1, hub->change_bits);
787 } else if (udev->persist_enabled) {
789 udev->reset_resume = 1;
791 set_bit(port1, hub->change_bits);
794 /* The power session is gone; tell khubd */
795 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
796 set_bit(port1, hub->change_bits);
800 /* If no port-status-change flags were set, we don't need any
801 * debouncing. If flags were set we can try to debounce the
802 * ports all at once right now, instead of letting khubd do them
803 * one at a time later on.
805 * If any port-status changes do occur during this delay, khubd
806 * will see them later and handle them normally.
808 if (need_debounce_delay) {
809 delay = HUB_DEBOUNCE_STABLE;
811 /* Don't do a long sleep inside a workqueue routine */
812 if (type == HUB_INIT2) {
813 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func3);
814 schedule_delayed_work(&hub->init_work,
815 msecs_to_jiffies(delay));
816 return; /* Continues at init3: below */
825 status = usb_submit_urb(hub->urb, GFP_NOIO);
827 dev_err(hub->intfdev, "activate --> %d\n", status);
828 if (hub->has_indicators && blinkenlights)
829 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
831 /* Scan all ports that need attention */
834 /* Allow autosuspend if it was suppressed */
835 if (type <= HUB_INIT3)
836 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
839 /* Implement the continuations for the delays above */
840 static void hub_init_func2(struct work_struct *ws)
842 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
844 hub_activate(hub, HUB_INIT2);
847 static void hub_init_func3(struct work_struct *ws)
849 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
851 hub_activate(hub, HUB_INIT3);
854 enum hub_quiescing_type {
855 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
858 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
860 struct usb_device *hdev = hub->hdev;
863 cancel_delayed_work_sync(&hub->init_work);
864 if (!hub->init_done) {
866 usb_autopm_put_interface_no_suspend(
867 to_usb_interface(hub->intfdev));
870 /* khubd and related activity won't re-trigger */
873 if (type != HUB_SUSPEND) {
874 /* Disconnect all the children */
875 for (i = 0; i < hdev->maxchild; ++i) {
876 if (hdev->children[i])
877 usb_disconnect(&hdev->children[i]);
881 /* Stop khubd and related activity */
882 usb_kill_urb(hub->urb);
883 if (hub->has_indicators)
884 cancel_delayed_work_sync(&hub->leds);
886 cancel_work_sync(&hub->tt.clear_work);
889 /* caller has locked the hub device */
890 static int hub_pre_reset(struct usb_interface *intf)
892 struct usb_hub *hub = usb_get_intfdata(intf);
894 hub_quiesce(hub, HUB_PRE_RESET);
898 /* caller has locked the hub device */
899 static int hub_post_reset(struct usb_interface *intf)
901 struct usb_hub *hub = usb_get_intfdata(intf);
903 hub_activate(hub, HUB_POST_RESET);
907 static int hub_configure(struct usb_hub *hub,
908 struct usb_endpoint_descriptor *endpoint)
911 struct usb_device *hdev = hub->hdev;
912 struct device *hub_dev = hub->intfdev;
913 u16 hubstatus, hubchange;
914 u16 wHubCharacteristics;
917 char *message = "out of memory";
919 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
925 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
930 mutex_init(&hub->status_mutex);
932 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
933 if (!hub->descriptor) {
938 /* Request the entire hub descriptor.
939 * hub->descriptor can handle USB_MAXCHILDREN ports,
940 * but the hub can/will return fewer bytes here.
942 ret = get_hub_descriptor(hdev, hub->descriptor,
943 sizeof(*hub->descriptor));
945 message = "can't read hub descriptor";
947 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
948 message = "hub has too many ports!";
953 hdev->maxchild = hub->descriptor->bNbrPorts;
954 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
955 (hdev->maxchild == 1) ? "" : "s");
957 hub->port_owners = kzalloc(hdev->maxchild * sizeof(void *), GFP_KERNEL);
958 if (!hub->port_owners) {
963 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
965 if (wHubCharacteristics & HUB_CHAR_COMPOUND) {
967 char portstr [USB_MAXCHILDREN + 1];
969 for (i = 0; i < hdev->maxchild; i++)
970 portstr[i] = hub->descriptor->DeviceRemovable
971 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
973 portstr[hdev->maxchild] = 0;
974 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
976 dev_dbg(hub_dev, "standalone hub\n");
978 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
980 dev_dbg(hub_dev, "ganged power switching\n");
983 dev_dbg(hub_dev, "individual port power switching\n");
987 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
991 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
993 dev_dbg(hub_dev, "global over-current protection\n");
996 dev_dbg(hub_dev, "individual port over-current protection\n");
1000 dev_dbg(hub_dev, "no over-current protection\n");
1004 spin_lock_init (&hub->tt.lock);
1005 INIT_LIST_HEAD (&hub->tt.clear_list);
1006 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1007 switch (hdev->descriptor.bDeviceProtocol) {
1011 dev_dbg(hub_dev, "Single TT\n");
1015 ret = usb_set_interface(hdev, 0, 1);
1017 dev_dbg(hub_dev, "TT per port\n");
1020 dev_err(hub_dev, "Using single TT (err %d)\n",
1025 /* USB 3.0 hubs don't have a TT */
1028 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1029 hdev->descriptor.bDeviceProtocol);
1033 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1034 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1035 case HUB_TTTT_8_BITS:
1036 if (hdev->descriptor.bDeviceProtocol != 0) {
1037 hub->tt.think_time = 666;
1038 dev_dbg(hub_dev, "TT requires at most %d "
1039 "FS bit times (%d ns)\n",
1040 8, hub->tt.think_time);
1043 case HUB_TTTT_16_BITS:
1044 hub->tt.think_time = 666 * 2;
1045 dev_dbg(hub_dev, "TT requires at most %d "
1046 "FS bit times (%d ns)\n",
1047 16, hub->tt.think_time);
1049 case HUB_TTTT_24_BITS:
1050 hub->tt.think_time = 666 * 3;
1051 dev_dbg(hub_dev, "TT requires at most %d "
1052 "FS bit times (%d ns)\n",
1053 24, hub->tt.think_time);
1055 case HUB_TTTT_32_BITS:
1056 hub->tt.think_time = 666 * 4;
1057 dev_dbg(hub_dev, "TT requires at most %d "
1058 "FS bit times (%d ns)\n",
1059 32, hub->tt.think_time);
1063 /* probe() zeroes hub->indicator[] */
1064 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1065 hub->has_indicators = 1;
1066 dev_dbg(hub_dev, "Port indicators are supported\n");
1069 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1070 hub->descriptor->bPwrOn2PwrGood * 2);
1072 /* power budgeting mostly matters with bus-powered hubs,
1073 * and battery-powered root hubs (may provide just 8 mA).
1075 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1077 message = "can't get hub status";
1080 le16_to_cpus(&hubstatus);
1081 if (hdev == hdev->bus->root_hub) {
1082 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
1083 hub->mA_per_port = 500;
1085 hub->mA_per_port = hdev->bus_mA;
1086 hub->limited_power = 1;
1088 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1089 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1090 hub->descriptor->bHubContrCurrent);
1091 hub->limited_power = 1;
1092 if (hdev->maxchild > 0) {
1093 int remaining = hdev->bus_mA -
1094 hub->descriptor->bHubContrCurrent;
1096 if (remaining < hdev->maxchild * 100)
1098 "insufficient power available "
1099 "to use all downstream ports\n");
1100 hub->mA_per_port = 100; /* 7.2.1.1 */
1102 } else { /* Self-powered external hub */
1103 /* FIXME: What about battery-powered external hubs that
1104 * provide less current per port? */
1105 hub->mA_per_port = 500;
1107 if (hub->mA_per_port < 500)
1108 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1111 /* Update the HCD's internal representation of this hub before khubd
1112 * starts getting port status changes for devices under the hub.
1114 hcd = bus_to_hcd(hdev->bus);
1115 if (hcd->driver->update_hub_device) {
1116 ret = hcd->driver->update_hub_device(hcd, hdev,
1117 &hub->tt, GFP_KERNEL);
1119 message = "can't update HCD hub info";
1124 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1126 message = "can't get hub status";
1130 /* local power status reports aren't always correct */
1131 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1132 dev_dbg(hub_dev, "local power source is %s\n",
1133 (hubstatus & HUB_STATUS_LOCAL_POWER)
1134 ? "lost (inactive)" : "good");
1136 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1137 dev_dbg(hub_dev, "%sover-current condition exists\n",
1138 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1140 /* set up the interrupt endpoint
1141 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1142 * bytes as USB2.0[11.12.3] says because some hubs are known
1143 * to send more data (and thus cause overflow). For root hubs,
1144 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1145 * to be big enough for at least USB_MAXCHILDREN ports. */
1146 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1147 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1149 if (maxp > sizeof(*hub->buffer))
1150 maxp = sizeof(*hub->buffer);
1152 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1158 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1159 hub, endpoint->bInterval);
1161 /* maybe cycle the hub leds */
1162 if (hub->has_indicators && blinkenlights)
1163 hub->indicator [0] = INDICATOR_CYCLE;
1165 hub_activate(hub, HUB_INIT);
1169 dev_err (hub_dev, "config failed, %s (err %d)\n",
1171 /* hub_disconnect() frees urb and descriptor */
1175 static void hub_release(struct kref *kref)
1177 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1179 usb_put_intf(to_usb_interface(hub->intfdev));
1183 static unsigned highspeed_hubs;
1185 static void hub_disconnect(struct usb_interface *intf)
1187 struct usb_hub *hub = usb_get_intfdata (intf);
1189 /* Take the hub off the event list and don't let it be added again */
1190 spin_lock_irq(&hub_event_lock);
1191 if (!list_empty(&hub->event_list)) {
1192 list_del_init(&hub->event_list);
1193 usb_autopm_put_interface_no_suspend(intf);
1195 hub->disconnected = 1;
1196 spin_unlock_irq(&hub_event_lock);
1198 /* Disconnect all children and quiesce the hub */
1200 hub_quiesce(hub, HUB_DISCONNECT);
1202 usb_set_intfdata (intf, NULL);
1203 hub->hdev->maxchild = 0;
1205 if (hub->hdev->speed == USB_SPEED_HIGH)
1208 usb_free_urb(hub->urb);
1209 kfree(hub->port_owners);
1210 kfree(hub->descriptor);
1214 kref_put(&hub->kref, hub_release);
1217 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1219 struct usb_host_interface *desc;
1220 struct usb_endpoint_descriptor *endpoint;
1221 struct usb_device *hdev;
1222 struct usb_hub *hub;
1224 desc = intf->cur_altsetting;
1225 hdev = interface_to_usbdev(intf);
1227 if (hdev->level == MAX_TOPO_LEVEL) {
1229 "Unsupported bus topology: hub nested too deep\n");
1233 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1235 dev_warn(&intf->dev, "ignoring external hub\n");
1240 /* Some hubs have a subclass of 1, which AFAICT according to the */
1241 /* specs is not defined, but it works */
1242 if ((desc->desc.bInterfaceSubClass != 0) &&
1243 (desc->desc.bInterfaceSubClass != 1)) {
1245 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1249 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1250 if (desc->desc.bNumEndpoints != 1)
1251 goto descriptor_error;
1253 endpoint = &desc->endpoint[0].desc;
1255 /* If it's not an interrupt in endpoint, we'd better punt! */
1256 if (!usb_endpoint_is_int_in(endpoint))
1257 goto descriptor_error;
1259 /* We found a hub */
1260 dev_info (&intf->dev, "USB hub found\n");
1262 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1264 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1268 kref_init(&hub->kref);
1269 INIT_LIST_HEAD(&hub->event_list);
1270 hub->intfdev = &intf->dev;
1272 INIT_DELAYED_WORK(&hub->leds, led_work);
1273 INIT_DELAYED_WORK(&hub->init_work, NULL);
1276 usb_set_intfdata (intf, hub);
1277 intf->needs_remote_wakeup = 1;
1279 if (hdev->speed == USB_SPEED_HIGH)
1282 if (hub_configure(hub, endpoint) >= 0)
1285 hub_disconnect (intf);
1290 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1292 struct usb_device *hdev = interface_to_usbdev (intf);
1294 /* assert ifno == 0 (part of hub spec) */
1296 case USBDEVFS_HUB_PORTINFO: {
1297 struct usbdevfs_hub_portinfo *info = user_data;
1300 spin_lock_irq(&device_state_lock);
1301 if (hdev->devnum <= 0)
1304 info->nports = hdev->maxchild;
1305 for (i = 0; i < info->nports; i++) {
1306 if (hdev->children[i] == NULL)
1310 hdev->children[i]->devnum;
1313 spin_unlock_irq(&device_state_lock);
1315 return info->nports + 1;
1324 * Allow user programs to claim ports on a hub. When a device is attached
1325 * to one of these "claimed" ports, the program will "own" the device.
1327 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1330 if (hdev->state == USB_STATE_NOTATTACHED)
1332 if (port1 == 0 || port1 > hdev->maxchild)
1335 /* This assumes that devices not managed by the hub driver
1336 * will always have maxchild equal to 0.
1338 *ppowner = &(hdev_to_hub(hdev)->port_owners[port1 - 1]);
1342 /* In the following three functions, the caller must hold hdev's lock */
1343 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1, void *owner)
1348 rc = find_port_owner(hdev, port1, &powner);
1357 int usb_hub_release_port(struct usb_device *hdev, unsigned port1, void *owner)
1362 rc = find_port_owner(hdev, port1, &powner);
1365 if (*powner != owner)
1371 void usb_hub_release_all_ports(struct usb_device *hdev, void *owner)
1376 n = find_port_owner(hdev, 1, &powner);
1378 for (; n < hdev->maxchild; (++n, ++powner)) {
1379 if (*powner == owner)
1385 /* The caller must hold udev's lock */
1386 bool usb_device_is_owned(struct usb_device *udev)
1388 struct usb_hub *hub;
1390 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1392 hub = hdev_to_hub(udev->parent);
1393 return !!hub->port_owners[udev->portnum - 1];
1397 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1401 for (i = 0; i < udev->maxchild; ++i) {
1402 if (udev->children[i])
1403 recursively_mark_NOTATTACHED(udev->children[i]);
1405 if (udev->state == USB_STATE_SUSPENDED) {
1406 udev->discon_suspended = 1;
1407 udev->active_duration -= jiffies;
1409 udev->state = USB_STATE_NOTATTACHED;
1413 * usb_set_device_state - change a device's current state (usbcore, hcds)
1414 * @udev: pointer to device whose state should be changed
1415 * @new_state: new state value to be stored
1417 * udev->state is _not_ fully protected by the device lock. Although
1418 * most transitions are made only while holding the lock, the state can
1419 * can change to USB_STATE_NOTATTACHED at almost any time. This
1420 * is so that devices can be marked as disconnected as soon as possible,
1421 * without having to wait for any semaphores to be released. As a result,
1422 * all changes to any device's state must be protected by the
1423 * device_state_lock spinlock.
1425 * Once a device has been added to the device tree, all changes to its state
1426 * should be made using this routine. The state should _not_ be set directly.
1428 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1429 * Otherwise udev->state is set to new_state, and if new_state is
1430 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1431 * to USB_STATE_NOTATTACHED.
1433 void usb_set_device_state(struct usb_device *udev,
1434 enum usb_device_state new_state)
1436 unsigned long flags;
1438 spin_lock_irqsave(&device_state_lock, flags);
1439 if (udev->state == USB_STATE_NOTATTACHED)
1441 else if (new_state != USB_STATE_NOTATTACHED) {
1443 /* root hub wakeup capabilities are managed out-of-band
1444 * and may involve silicon errata ... ignore them here.
1447 if (udev->state == USB_STATE_SUSPENDED
1448 || new_state == USB_STATE_SUSPENDED)
1449 ; /* No change to wakeup settings */
1450 else if (new_state == USB_STATE_CONFIGURED)
1451 device_set_wakeup_capable(&udev->dev,
1452 (udev->actconfig->desc.bmAttributes
1453 & USB_CONFIG_ATT_WAKEUP));
1455 device_set_wakeup_capable(&udev->dev, 0);
1457 if (udev->state == USB_STATE_SUSPENDED &&
1458 new_state != USB_STATE_SUSPENDED)
1459 udev->active_duration -= jiffies;
1460 else if (new_state == USB_STATE_SUSPENDED &&
1461 udev->state != USB_STATE_SUSPENDED)
1462 udev->active_duration += jiffies;
1463 udev->state = new_state;
1465 recursively_mark_NOTATTACHED(udev);
1466 spin_unlock_irqrestore(&device_state_lock, flags);
1468 EXPORT_SYMBOL_GPL(usb_set_device_state);
1471 * WUSB devices are simple: they have no hubs behind, so the mapping
1472 * device <-> virtual port number becomes 1:1. Why? to simplify the
1473 * life of the device connection logic in
1474 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1475 * handshake we need to assign a temporary address in the unauthorized
1476 * space. For simplicity we use the first virtual port number found to
1477 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1478 * and that becomes it's address [X < 128] or its unauthorized address
1481 * We add 1 as an offset to the one-based USB-stack port number
1482 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1483 * 0 is reserved by USB for default address; (b) Linux's USB stack
1484 * uses always #1 for the root hub of the controller. So USB stack's
1485 * port #1, which is wusb virtual-port #0 has address #2.
1487 * Devices connected under xHCI are not as simple. The host controller
1488 * supports virtualization, so the hardware assigns device addresses and
1489 * the HCD must setup data structures before issuing a set address
1490 * command to the hardware.
1492 static void choose_address(struct usb_device *udev)
1495 struct usb_bus *bus = udev->bus;
1497 /* If khubd ever becomes multithreaded, this will need a lock */
1499 devnum = udev->portnum + 1;
1500 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
1502 /* Try to allocate the next devnum beginning at
1503 * bus->devnum_next. */
1504 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1507 devnum = find_next_zero_bit(bus->devmap.devicemap,
1509 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1512 set_bit(devnum, bus->devmap.devicemap);
1513 udev->devnum = devnum;
1517 static void release_address(struct usb_device *udev)
1519 if (udev->devnum > 0) {
1520 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1525 static void update_address(struct usb_device *udev, int devnum)
1527 /* The address for a WUSB device is managed by wusbcore. */
1529 udev->devnum = devnum;
1532 #ifdef CONFIG_USB_SUSPEND
1534 static void usb_stop_pm(struct usb_device *udev)
1536 /* Synchronize with the ksuspend thread to prevent any more
1537 * autosuspend requests from being submitted, and decrement
1538 * the parent's count of unsuspended children.
1541 if (udev->parent && !udev->discon_suspended)
1542 usb_autosuspend_device(udev->parent);
1543 usb_pm_unlock(udev);
1545 /* Stop any autosuspend or autoresume requests already submitted */
1546 cancel_delayed_work_sync(&udev->autosuspend);
1547 cancel_work_sync(&udev->autoresume);
1552 static inline void usb_stop_pm(struct usb_device *udev)
1558 * usb_disconnect - disconnect a device (usbcore-internal)
1559 * @pdev: pointer to device being disconnected
1560 * Context: !in_interrupt ()
1562 * Something got disconnected. Get rid of it and all of its children.
1564 * If *pdev is a normal device then the parent hub must already be locked.
1565 * If *pdev is a root hub then this routine will acquire the
1566 * usb_bus_list_lock on behalf of the caller.
1568 * Only hub drivers (including virtual root hub drivers for host
1569 * controllers) should ever call this.
1571 * This call is synchronous, and may not be used in an interrupt context.
1573 void usb_disconnect(struct usb_device **pdev)
1575 struct usb_device *udev = *pdev;
1579 pr_debug ("%s nodev\n", __func__);
1583 /* mark the device as inactive, so any further urb submissions for
1584 * this device (and any of its children) will fail immediately.
1585 * this quiesces everyting except pending urbs.
1587 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1588 dev_info (&udev->dev, "USB disconnect, address %d\n", udev->devnum);
1590 usb_lock_device(udev);
1592 /* Free up all the children before we remove this device */
1593 for (i = 0; i < USB_MAXCHILDREN; i++) {
1594 if (udev->children[i])
1595 usb_disconnect(&udev->children[i]);
1598 /* deallocate hcd/hardware state ... nuking all pending urbs and
1599 * cleaning up all state associated with the current configuration
1600 * so that the hardware is now fully quiesced.
1602 dev_dbg (&udev->dev, "unregistering device\n");
1603 usb_disable_device(udev, 0);
1604 usb_hcd_synchronize_unlinks(udev);
1606 usb_remove_ep_devs(&udev->ep0);
1607 usb_unlock_device(udev);
1609 /* Unregister the device. The device driver is responsible
1610 * for de-configuring the device and invoking the remove-device
1611 * notifier chain (used by usbfs and possibly others).
1613 device_del(&udev->dev);
1615 /* Free the device number and delete the parent's children[]
1616 * (or root_hub) pointer.
1618 release_address(udev);
1620 /* Avoid races with recursively_mark_NOTATTACHED() */
1621 spin_lock_irq(&device_state_lock);
1623 spin_unlock_irq(&device_state_lock);
1627 put_device(&udev->dev);
1630 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
1631 static void show_string(struct usb_device *udev, char *id, char *string)
1635 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1638 static void announce_device(struct usb_device *udev)
1640 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
1641 le16_to_cpu(udev->descriptor.idVendor),
1642 le16_to_cpu(udev->descriptor.idProduct));
1643 dev_info(&udev->dev,
1644 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
1645 udev->descriptor.iManufacturer,
1646 udev->descriptor.iProduct,
1647 udev->descriptor.iSerialNumber);
1648 show_string(udev, "Product", udev->product);
1649 show_string(udev, "Manufacturer", udev->manufacturer);
1650 show_string(udev, "SerialNumber", udev->serial);
1653 static inline void announce_device(struct usb_device *udev) { }
1656 #ifdef CONFIG_USB_OTG
1657 #include "otg_whitelist.h"
1661 * usb_enumerate_device_otg - FIXME (usbcore-internal)
1662 * @udev: newly addressed device (in ADDRESS state)
1664 * Finish enumeration for On-The-Go devices
1666 static int usb_enumerate_device_otg(struct usb_device *udev)
1670 #ifdef CONFIG_USB_OTG
1672 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1673 * to wake us after we've powered off VBUS; and HNP, switching roles
1674 * "host" to "peripheral". The OTG descriptor helps figure this out.
1676 if (!udev->bus->is_b_host
1678 && udev->parent == udev->bus->root_hub) {
1679 struct usb_otg_descriptor *desc = NULL;
1680 struct usb_bus *bus = udev->bus;
1682 /* descriptor may appear anywhere in config */
1683 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1684 le16_to_cpu(udev->config[0].desc.wTotalLength),
1685 USB_DT_OTG, (void **) &desc) == 0) {
1686 if (desc->bmAttributes & USB_OTG_HNP) {
1687 unsigned port1 = udev->portnum;
1689 dev_info(&udev->dev,
1690 "Dual-Role OTG device on %sHNP port\n",
1691 (port1 == bus->otg_port)
1694 /* enable HNP before suspend, it's simpler */
1695 if (port1 == bus->otg_port)
1696 bus->b_hnp_enable = 1;
1697 err = usb_control_msg(udev,
1698 usb_sndctrlpipe(udev, 0),
1699 USB_REQ_SET_FEATURE, 0,
1701 ? USB_DEVICE_B_HNP_ENABLE
1702 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1703 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1705 /* OTG MESSAGE: report errors here,
1706 * customize to match your product.
1708 dev_info(&udev->dev,
1709 "can't set HNP mode: %d\n",
1711 bus->b_hnp_enable = 0;
1717 if (!is_targeted(udev)) {
1719 /* Maybe it can talk to us, though we can't talk to it.
1720 * (Includes HNP test device.)
1722 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
1723 err = usb_port_suspend(udev, PMSG_SUSPEND);
1725 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1737 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
1738 * @udev: newly addressed device (in ADDRESS state)
1740 * This is only called by usb_new_device() and usb_authorize_device()
1741 * and FIXME -- all comments that apply to them apply here wrt to
1744 * If the device is WUSB and not authorized, we don't attempt to read
1745 * the string descriptors, as they will be errored out by the device
1746 * until it has been authorized.
1748 static int usb_enumerate_device(struct usb_device *udev)
1752 if (udev->config == NULL) {
1753 err = usb_get_configuration(udev);
1755 dev_err(&udev->dev, "can't read configurations, error %d\n",
1760 if (udev->wusb == 1 && udev->authorized == 0) {
1761 udev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1762 udev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1763 udev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1766 /* read the standard strings and cache them if present */
1767 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1768 udev->manufacturer = usb_cache_string(udev,
1769 udev->descriptor.iManufacturer);
1770 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
1772 err = usb_enumerate_device_otg(udev);
1779 * usb_new_device - perform initial device setup (usbcore-internal)
1780 * @udev: newly addressed device (in ADDRESS state)
1782 * This is called with devices which have been detected but not fully
1783 * enumerated. The device descriptor is available, but not descriptors
1784 * for any device configuration. The caller must have locked either
1785 * the parent hub (if udev is a normal device) or else the
1786 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1787 * udev has already been installed, but udev is not yet visible through
1788 * sysfs or other filesystem code.
1790 * It will return if the device is configured properly or not. Zero if
1791 * the interface was registered with the driver core; else a negative
1794 * This call is synchronous, and may not be used in an interrupt context.
1796 * Only the hub driver or root-hub registrar should ever call this.
1798 int usb_new_device(struct usb_device *udev)
1803 /* Increment the parent's count of unsuspended children */
1804 usb_autoresume_device(udev->parent);
1806 /* Initialize non-root-hub device wakeup to disabled;
1807 * device (un)configuration controls wakeup capable
1808 * sysfs power/wakeup controls wakeup enabled/disabled
1810 device_init_wakeup(&udev->dev, 0);
1811 device_set_wakeup_enable(&udev->dev, 1);
1814 usb_detect_quirks(udev);
1815 err = usb_enumerate_device(udev); /* Read descriptors */
1818 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
1819 udev->devnum, udev->bus->busnum,
1820 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1821 /* export the usbdev device-node for libusb */
1822 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
1823 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1825 /* Tell the world! */
1826 announce_device(udev);
1828 device_enable_async_suspend(&udev->dev);
1829 /* Register the device. The device driver is responsible
1830 * for configuring the device and invoking the add-device
1831 * notifier chain (used by usbfs and possibly others).
1833 err = device_add(&udev->dev);
1835 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1839 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
1843 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1850 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
1851 * @usb_dev: USB device
1853 * Move the USB device to a very basic state where interfaces are disabled
1854 * and the device is in fact unconfigured and unusable.
1856 * We share a lock (that we have) with device_del(), so we need to
1859 int usb_deauthorize_device(struct usb_device *usb_dev)
1861 usb_lock_device(usb_dev);
1862 if (usb_dev->authorized == 0)
1863 goto out_unauthorized;
1865 usb_dev->authorized = 0;
1866 usb_set_configuration(usb_dev, -1);
1868 kfree(usb_dev->product);
1869 usb_dev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1870 kfree(usb_dev->manufacturer);
1871 usb_dev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1872 kfree(usb_dev->serial);
1873 usb_dev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1875 usb_destroy_configuration(usb_dev);
1876 usb_dev->descriptor.bNumConfigurations = 0;
1879 usb_unlock_device(usb_dev);
1884 int usb_authorize_device(struct usb_device *usb_dev)
1888 usb_lock_device(usb_dev);
1889 if (usb_dev->authorized == 1)
1890 goto out_authorized;
1892 result = usb_autoresume_device(usb_dev);
1894 dev_err(&usb_dev->dev,
1895 "can't autoresume for authorization: %d\n", result);
1896 goto error_autoresume;
1898 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
1900 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
1901 "authorization: %d\n", result);
1902 goto error_device_descriptor;
1905 kfree(usb_dev->product);
1906 usb_dev->product = NULL;
1907 kfree(usb_dev->manufacturer);
1908 usb_dev->manufacturer = NULL;
1909 kfree(usb_dev->serial);
1910 usb_dev->serial = NULL;
1912 usb_dev->authorized = 1;
1913 result = usb_enumerate_device(usb_dev);
1915 goto error_enumerate;
1916 /* Choose and set the configuration. This registers the interfaces
1917 * with the driver core and lets interface drivers bind to them.
1919 c = usb_choose_configuration(usb_dev);
1921 result = usb_set_configuration(usb_dev, c);
1923 dev_err(&usb_dev->dev,
1924 "can't set config #%d, error %d\n", c, result);
1925 /* This need not be fatal. The user can try to
1926 * set other configurations. */
1929 dev_info(&usb_dev->dev, "authorized to connect\n");
1932 error_device_descriptor:
1933 usb_autosuspend_device(usb_dev);
1936 usb_unlock_device(usb_dev); // complements locktree
1941 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
1942 static unsigned hub_is_wusb(struct usb_hub *hub)
1944 struct usb_hcd *hcd;
1945 if (hub->hdev->parent != NULL) /* not a root hub? */
1947 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
1948 return hcd->wireless;
1952 #define PORT_RESET_TRIES 5
1953 #define SET_ADDRESS_TRIES 2
1954 #define GET_DESCRIPTOR_TRIES 2
1955 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1956 #define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1958 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1959 #define HUB_SHORT_RESET_TIME 10
1960 #define HUB_LONG_RESET_TIME 200
1961 #define HUB_RESET_TIMEOUT 500
1963 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
1964 struct usb_device *udev, unsigned int delay)
1966 int delay_time, ret;
1970 for (delay_time = 0;
1971 delay_time < HUB_RESET_TIMEOUT;
1972 delay_time += delay) {
1973 /* wait to give the device a chance to reset */
1976 /* read and decode port status */
1977 ret = hub_port_status(hub, port1, &portstatus, &portchange);
1981 /* Device went away? */
1982 if (!(portstatus & USB_PORT_STAT_CONNECTION))
1985 /* bomb out completely if the connection bounced */
1986 if ((portchange & USB_PORT_STAT_C_CONNECTION))
1989 /* if we`ve finished resetting, then break out of the loop */
1990 if (!(portstatus & USB_PORT_STAT_RESET) &&
1991 (portstatus & USB_PORT_STAT_ENABLE)) {
1992 if (hub_is_wusb(hub))
1993 udev->speed = USB_SPEED_WIRELESS;
1994 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
1995 udev->speed = USB_SPEED_HIGH;
1996 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
1997 udev->speed = USB_SPEED_LOW;
1999 udev->speed = USB_SPEED_FULL;
2003 /* switch to the long delay after two short delay failures */
2004 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2005 delay = HUB_LONG_RESET_TIME;
2007 dev_dbg (hub->intfdev,
2008 "port %d not reset yet, waiting %dms\n",
2015 static int hub_port_reset(struct usb_hub *hub, int port1,
2016 struct usb_device *udev, unsigned int delay)
2019 struct usb_hcd *hcd;
2021 hcd = bus_to_hcd(udev->bus);
2022 /* Block EHCI CF initialization during the port reset.
2023 * Some companion controllers don't like it when they mix.
2025 down_read(&ehci_cf_port_reset_rwsem);
2027 /* Reset the port */
2028 for (i = 0; i < PORT_RESET_TRIES; i++) {
2029 status = set_port_feature(hub->hdev,
2030 port1, USB_PORT_FEAT_RESET);
2032 dev_err(hub->intfdev,
2033 "cannot reset port %d (err = %d)\n",
2036 status = hub_port_wait_reset(hub, port1, udev, delay);
2037 if (status && status != -ENOTCONN)
2038 dev_dbg(hub->intfdev,
2039 "port_wait_reset: err = %d\n",
2043 /* return on disconnect or reset */
2046 /* TRSTRCY = 10 ms; plus some extra */
2048 update_address(udev, 0);
2049 if (hcd->driver->reset_device) {
2050 status = hcd->driver->reset_device(hcd, udev);
2052 dev_err(&udev->dev, "Cannot reset "
2053 "HCD device state\n");
2060 clear_port_feature(hub->hdev,
2061 port1, USB_PORT_FEAT_C_RESET);
2062 /* FIXME need disconnect() for NOTATTACHED device */
2063 usb_set_device_state(udev, status
2064 ? USB_STATE_NOTATTACHED
2065 : USB_STATE_DEFAULT);
2069 dev_dbg (hub->intfdev,
2070 "port %d not enabled, trying reset again...\n",
2072 delay = HUB_LONG_RESET_TIME;
2075 dev_err (hub->intfdev,
2076 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2080 up_read(&ehci_cf_port_reset_rwsem);
2086 #define MASK_BITS (USB_PORT_STAT_POWER | USB_PORT_STAT_CONNECTION | \
2087 USB_PORT_STAT_SUSPEND)
2088 #define WANT_BITS (USB_PORT_STAT_POWER | USB_PORT_STAT_CONNECTION)
2090 /* Determine whether the device on a port is ready for a normal resume,
2091 * is ready for a reset-resume, or should be disconnected.
2093 static int check_port_resume_type(struct usb_device *udev,
2094 struct usb_hub *hub, int port1,
2095 int status, unsigned portchange, unsigned portstatus)
2097 /* Is the device still present? */
2098 if (status || (portstatus & MASK_BITS) != WANT_BITS) {
2103 /* Can't do a normal resume if the port isn't enabled,
2104 * so try a reset-resume instead.
2106 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2107 if (udev->persist_enabled)
2108 udev->reset_resume = 1;
2114 dev_dbg(hub->intfdev,
2115 "port %d status %04x.%04x after resume, %d\n",
2116 port1, portchange, portstatus, status);
2117 } else if (udev->reset_resume) {
2119 /* Late port handoff can set status-change bits */
2120 if (portchange & USB_PORT_STAT_C_CONNECTION)
2121 clear_port_feature(hub->hdev, port1,
2122 USB_PORT_FEAT_C_CONNECTION);
2123 if (portchange & USB_PORT_STAT_C_ENABLE)
2124 clear_port_feature(hub->hdev, port1,
2125 USB_PORT_FEAT_C_ENABLE);
2131 #ifdef CONFIG_USB_SUSPEND
2134 * usb_port_suspend - suspend a usb device's upstream port
2135 * @udev: device that's no longer in active use, not a root hub
2136 * Context: must be able to sleep; device not locked; pm locks held
2138 * Suspends a USB device that isn't in active use, conserving power.
2139 * Devices may wake out of a suspend, if anything important happens,
2140 * using the remote wakeup mechanism. They may also be taken out of
2141 * suspend by the host, using usb_port_resume(). It's also routine
2142 * to disconnect devices while they are suspended.
2144 * This only affects the USB hardware for a device; its interfaces
2145 * (and, for hubs, child devices) must already have been suspended.
2147 * Selective port suspend reduces power; most suspended devices draw
2148 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2149 * All devices below the suspended port are also suspended.
2151 * Devices leave suspend state when the host wakes them up. Some devices
2152 * also support "remote wakeup", where the device can activate the USB
2153 * tree above them to deliver data, such as a keypress or packet. In
2154 * some cases, this wakes the USB host.
2156 * Suspending OTG devices may trigger HNP, if that's been enabled
2157 * between a pair of dual-role devices. That will change roles, such
2158 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2160 * Devices on USB hub ports have only one "suspend" state, corresponding
2161 * to ACPI D2, "may cause the device to lose some context".
2162 * State transitions include:
2164 * - suspend, resume ... when the VBUS power link stays live
2165 * - suspend, disconnect ... VBUS lost
2167 * Once VBUS drop breaks the circuit, the port it's using has to go through
2168 * normal re-enumeration procedures, starting with enabling VBUS power.
2169 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2170 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2171 * timer, no SRP, no requests through sysfs.
2173 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
2174 * the root hub for their bus goes into global suspend ... so we don't
2175 * (falsely) update the device power state to say it suspended.
2177 * Returns 0 on success, else negative errno.
2179 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2181 struct usb_hub *hub = hdev_to_hub(udev->parent);
2182 int port1 = udev->portnum;
2185 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
2187 /* enable remote wakeup when appropriate; this lets the device
2188 * wake up the upstream hub (including maybe the root hub).
2190 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2191 * we don't explicitly enable it here.
2193 if (udev->do_remote_wakeup) {
2194 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2195 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2196 USB_DEVICE_REMOTE_WAKEUP, 0,
2198 USB_CTRL_SET_TIMEOUT);
2200 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
2202 /* bail if autosuspend is requested */
2203 if (msg.event & PM_EVENT_AUTO)
2209 status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
2211 dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
2213 /* paranoia: "should not happen" */
2214 if (udev->do_remote_wakeup)
2215 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2216 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2217 USB_DEVICE_REMOTE_WAKEUP, 0,
2219 USB_CTRL_SET_TIMEOUT);
2221 /* device has up to 10 msec to fully suspend */
2222 dev_dbg(&udev->dev, "usb %ssuspend\n",
2223 (msg.event & PM_EVENT_AUTO ? "auto-" : ""));
2224 usb_set_device_state(udev, USB_STATE_SUSPENDED);
2231 * If the USB "suspend" state is in use (rather than "global suspend"),
2232 * many devices will be individually taken out of suspend state using
2233 * special "resume" signaling. This routine kicks in shortly after
2234 * hardware resume signaling is finished, either because of selective
2235 * resume (by host) or remote wakeup (by device) ... now see what changed
2236 * in the tree that's rooted at this device.
2238 * If @udev->reset_resume is set then the device is reset before the
2239 * status check is done.
2241 static int finish_port_resume(struct usb_device *udev)
2246 /* caller owns the udev device lock */
2247 dev_dbg(&udev->dev, "%s\n",
2248 udev->reset_resume ? "finish reset-resume" : "finish resume");
2250 /* usb ch9 identifies four variants of SUSPENDED, based on what
2251 * state the device resumes to. Linux currently won't see the
2252 * first two on the host side; they'd be inside hub_port_init()
2253 * during many timeouts, but khubd can't suspend until later.
2255 usb_set_device_state(udev, udev->actconfig
2256 ? USB_STATE_CONFIGURED
2257 : USB_STATE_ADDRESS);
2259 /* 10.5.4.5 says not to reset a suspended port if the attached
2260 * device is enabled for remote wakeup. Hence the reset
2261 * operation is carried out here, after the port has been
2264 if (udev->reset_resume)
2266 status = usb_reset_and_verify_device(udev);
2268 /* 10.5.4.5 says be sure devices in the tree are still there.
2269 * For now let's assume the device didn't go crazy on resume,
2270 * and device drivers will know about any resume quirks.
2274 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
2276 status = (status > 0 ? 0 : -ENODEV);
2278 /* If a normal resume failed, try doing a reset-resume */
2279 if (status && !udev->reset_resume && udev->persist_enabled) {
2280 dev_dbg(&udev->dev, "retry with reset-resume\n");
2281 udev->reset_resume = 1;
2282 goto retry_reset_resume;
2287 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
2289 } else if (udev->actconfig) {
2290 le16_to_cpus(&devstatus);
2291 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) {
2292 status = usb_control_msg(udev,
2293 usb_sndctrlpipe(udev, 0),
2294 USB_REQ_CLEAR_FEATURE,
2296 USB_DEVICE_REMOTE_WAKEUP, 0,
2298 USB_CTRL_SET_TIMEOUT);
2301 "disable remote wakeup, status %d\n",
2310 * usb_port_resume - re-activate a suspended usb device's upstream port
2311 * @udev: device to re-activate, not a root hub
2312 * Context: must be able to sleep; device not locked; pm locks held
2314 * This will re-activate the suspended device, increasing power usage
2315 * while letting drivers communicate again with its endpoints.
2316 * USB resume explicitly guarantees that the power session between
2317 * the host and the device is the same as it was when the device
2320 * If @udev->reset_resume is set then this routine won't check that the
2321 * port is still enabled. Furthermore, finish_port_resume() above will
2322 * reset @udev. The end result is that a broken power session can be
2323 * recovered and @udev will appear to persist across a loss of VBUS power.
2325 * For example, if a host controller doesn't maintain VBUS suspend current
2326 * during a system sleep or is reset when the system wakes up, all the USB
2327 * power sessions below it will be broken. This is especially troublesome
2328 * for mass-storage devices containing mounted filesystems, since the
2329 * device will appear to have disconnected and all the memory mappings
2330 * to it will be lost. Using the USB_PERSIST facility, the device can be
2331 * made to appear as if it had not disconnected.
2333 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
2334 * every effort to insure that the same device is present after the
2335 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
2336 * quite possible for a device to remain unaltered but its media to be
2337 * changed. If the user replaces a flash memory card while the system is
2338 * asleep, he will have only himself to blame when the filesystem on the
2339 * new card is corrupted and the system crashes.
2341 * Returns 0 on success, else negative errno.
2343 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
2345 struct usb_hub *hub = hdev_to_hub(udev->parent);
2346 int port1 = udev->portnum;
2348 u16 portchange, portstatus;
2350 /* Skip the initial Clear-Suspend step for a remote wakeup */
2351 status = hub_port_status(hub, port1, &portstatus, &portchange);
2352 if (status == 0 && !(portstatus & USB_PORT_STAT_SUSPEND))
2353 goto SuspendCleared;
2355 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
2357 set_bit(port1, hub->busy_bits);
2359 /* see 7.1.7.7; affects power usage, but not budgeting */
2360 status = clear_port_feature(hub->hdev,
2361 port1, USB_PORT_FEAT_SUSPEND);
2363 dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
2366 /* drive resume for at least 20 msec */
2367 dev_dbg(&udev->dev, "usb %sresume\n",
2368 (msg.event & PM_EVENT_AUTO ? "auto-" : ""));
2371 /* Virtual root hubs can trigger on GET_PORT_STATUS to
2372 * stop resume signaling. Then finish the resume
2375 status = hub_port_status(hub, port1, &portstatus, &portchange);
2377 /* TRSMRCY = 10 msec */
2383 if (portchange & USB_PORT_STAT_C_SUSPEND)
2384 clear_port_feature(hub->hdev, port1,
2385 USB_PORT_FEAT_C_SUSPEND);
2388 clear_bit(port1, hub->busy_bits);
2390 status = check_port_resume_type(udev,
2391 hub, port1, status, portchange, portstatus);
2393 status = finish_port_resume(udev);
2395 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2396 hub_port_logical_disconnect(hub, port1);
2401 /* caller has locked udev */
2402 int usb_remote_wakeup(struct usb_device *udev)
2406 if (udev->state == USB_STATE_SUSPENDED) {
2407 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
2408 usb_mark_last_busy(udev);
2409 status = usb_external_resume_device(udev, PMSG_REMOTE_RESUME);
2414 #else /* CONFIG_USB_SUSPEND */
2416 /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
2418 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2423 /* However we may need to do a reset-resume */
2425 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
2427 struct usb_hub *hub = hdev_to_hub(udev->parent);
2428 int port1 = udev->portnum;
2430 u16 portchange, portstatus;
2432 status = hub_port_status(hub, port1, &portstatus, &portchange);
2433 status = check_port_resume_type(udev,
2434 hub, port1, status, portchange, portstatus);
2437 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2438 hub_port_logical_disconnect(hub, port1);
2439 } else if (udev->reset_resume) {
2440 dev_dbg(&udev->dev, "reset-resume\n");
2441 status = usb_reset_and_verify_device(udev);
2446 int usb_remote_wakeup(struct usb_device *udev)
2453 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
2455 struct usb_hub *hub = usb_get_intfdata (intf);
2456 struct usb_device *hdev = hub->hdev;
2459 /* fail if children aren't already suspended */
2460 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
2461 struct usb_device *udev;
2463 udev = hdev->children [port1-1];
2464 if (udev && udev->can_submit) {
2465 if (!(msg.event & PM_EVENT_AUTO))
2466 dev_dbg(&intf->dev, "port %d nyet suspended\n",
2472 dev_dbg(&intf->dev, "%s\n", __func__);
2474 /* stop khubd and related activity */
2475 hub_quiesce(hub, HUB_SUSPEND);
2479 static int hub_resume(struct usb_interface *intf)
2481 struct usb_hub *hub = usb_get_intfdata(intf);
2483 dev_dbg(&intf->dev, "%s\n", __func__);
2484 hub_activate(hub, HUB_RESUME);
2488 static int hub_reset_resume(struct usb_interface *intf)
2490 struct usb_hub *hub = usb_get_intfdata(intf);
2492 dev_dbg(&intf->dev, "%s\n", __func__);
2493 hub_activate(hub, HUB_RESET_RESUME);
2498 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
2499 * @rhdev: struct usb_device for the root hub
2501 * The USB host controller driver calls this function when its root hub
2502 * is resumed and Vbus power has been interrupted or the controller
2503 * has been reset. The routine marks @rhdev as having lost power.
2504 * When the hub driver is resumed it will take notice and carry out
2505 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
2506 * the others will be disconnected.
2508 void usb_root_hub_lost_power(struct usb_device *rhdev)
2510 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
2511 rhdev->reset_resume = 1;
2513 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
2515 #else /* CONFIG_PM */
2517 #define hub_suspend NULL
2518 #define hub_resume NULL
2519 #define hub_reset_resume NULL
2523 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2525 * Between connect detection and reset signaling there must be a delay
2526 * of 100ms at least for debounce and power-settling. The corresponding
2527 * timer shall restart whenever the downstream port detects a disconnect.
2529 * Apparently there are some bluetooth and irda-dongles and a number of
2530 * low-speed devices for which this debounce period may last over a second.
2531 * Not covered by the spec - but easy to deal with.
2533 * This implementation uses a 1500ms total debounce timeout; if the
2534 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2535 * every 25ms for transient disconnects. When the port status has been
2536 * unchanged for 100ms it returns the port status.
2538 static int hub_port_debounce(struct usb_hub *hub, int port1)
2541 int total_time, stable_time = 0;
2542 u16 portchange, portstatus;
2543 unsigned connection = 0xffff;
2545 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2546 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2550 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2551 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2552 stable_time += HUB_DEBOUNCE_STEP;
2553 if (stable_time >= HUB_DEBOUNCE_STABLE)
2557 connection = portstatus & USB_PORT_STAT_CONNECTION;
2560 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2561 clear_port_feature(hub->hdev, port1,
2562 USB_PORT_FEAT_C_CONNECTION);
2565 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2567 msleep(HUB_DEBOUNCE_STEP);
2570 dev_dbg (hub->intfdev,
2571 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2572 port1, total_time, stable_time, portstatus);
2574 if (stable_time < HUB_DEBOUNCE_STABLE)
2579 void usb_ep0_reinit(struct usb_device *udev)
2581 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
2582 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
2583 usb_enable_endpoint(udev, &udev->ep0, true);
2585 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
2587 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2588 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2590 static int hub_set_address(struct usb_device *udev, int devnum)
2593 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2596 * The host controller will choose the device address,
2597 * instead of the core having chosen it earlier
2599 if (!hcd->driver->address_device && devnum <= 1)
2601 if (udev->state == USB_STATE_ADDRESS)
2603 if (udev->state != USB_STATE_DEFAULT)
2605 if (hcd->driver->address_device) {
2606 retval = hcd->driver->address_device(hcd, udev);
2608 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2609 USB_REQ_SET_ADDRESS, 0, devnum, 0,
2610 NULL, 0, USB_CTRL_SET_TIMEOUT);
2612 update_address(udev, devnum);
2615 /* Device now using proper address. */
2616 usb_set_device_state(udev, USB_STATE_ADDRESS);
2617 usb_ep0_reinit(udev);
2622 /* Reset device, (re)assign address, get device descriptor.
2623 * Device connection must be stable, no more debouncing needed.
2624 * Returns device in USB_STATE_ADDRESS, except on error.
2626 * If this is called for an already-existing device (as part of
2627 * usb_reset_and_verify_device), the caller must own the device lock. For a
2628 * newly detected device that is not accessible through any global
2629 * pointers, it's not necessary to lock the device.
2632 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2635 static DEFINE_MUTEX(usb_address0_mutex);
2637 struct usb_device *hdev = hub->hdev;
2638 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
2640 unsigned delay = HUB_SHORT_RESET_TIME;
2641 enum usb_device_speed oldspeed = udev->speed;
2643 int devnum = udev->devnum;
2645 /* root hub ports have a slightly longer reset period
2646 * (from USB 2.0 spec, section 7.1.7.5)
2648 if (!hdev->parent) {
2649 delay = HUB_ROOT_RESET_TIME;
2650 if (port1 == hdev->bus->otg_port)
2651 hdev->bus->b_hnp_enable = 0;
2654 /* Some low speed devices have problems with the quick delay, so */
2655 /* be a bit pessimistic with those devices. RHbug #23670 */
2656 if (oldspeed == USB_SPEED_LOW)
2657 delay = HUB_LONG_RESET_TIME;
2659 mutex_lock(&usb_address0_mutex);
2661 if (!udev->config && oldspeed == USB_SPEED_SUPER) {
2662 /* Don't reset USB 3.0 devices during an initial setup */
2663 usb_set_device_state(udev, USB_STATE_DEFAULT);
2665 /* Reset the device; full speed may morph to high speed */
2666 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
2667 retval = hub_port_reset(hub, port1, udev, delay);
2668 if (retval < 0) /* error or disconnect */
2670 /* success, speed is known */
2674 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2675 dev_dbg(&udev->dev, "device reset changed speed!\n");
2678 oldspeed = udev->speed;
2680 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2681 * it's fixed size except for full speed devices.
2682 * For Wireless USB devices, ep0 max packet is always 512 (tho
2683 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
2685 switch (udev->speed) {
2686 case USB_SPEED_SUPER:
2687 case USB_SPEED_WIRELESS: /* fixed at 512 */
2688 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
2690 case USB_SPEED_HIGH: /* fixed at 64 */
2691 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
2693 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
2694 /* to determine the ep0 maxpacket size, try to read
2695 * the device descriptor to get bMaxPacketSize0 and
2696 * then correct our initial guess.
2698 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
2700 case USB_SPEED_LOW: /* fixed at 8 */
2701 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
2708 switch (udev->speed) {
2709 case USB_SPEED_LOW: speed = "low"; break;
2710 case USB_SPEED_FULL: speed = "full"; break;
2711 case USB_SPEED_HIGH: speed = "high"; break;
2712 case USB_SPEED_SUPER:
2715 case USB_SPEED_WIRELESS:
2719 default: speed = "?"; break;
2721 if (udev->speed != USB_SPEED_SUPER)
2722 dev_info(&udev->dev,
2723 "%s %s speed %sUSB device using %s and address %d\n",
2724 (udev->config) ? "reset" : "new", speed, type,
2725 udev->bus->controller->driver->name, devnum);
2727 /* Set up TT records, if needed */
2729 udev->tt = hdev->tt;
2730 udev->ttport = hdev->ttport;
2731 } else if (udev->speed != USB_SPEED_HIGH
2732 && hdev->speed == USB_SPEED_HIGH) {
2733 udev->tt = &hub->tt;
2734 udev->ttport = port1;
2737 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2738 * Because device hardware and firmware is sometimes buggy in
2739 * this area, and this is how Linux has done it for ages.
2740 * Change it cautiously.
2742 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2743 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2744 * so it may help with some non-standards-compliant devices.
2745 * Otherwise we start with SET_ADDRESS and then try to read the
2746 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2749 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
2751 * An xHCI controller cannot send any packets to a device until
2752 * a set address command successfully completes.
2754 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3)) {
2755 struct usb_device_descriptor *buf;
2758 #define GET_DESCRIPTOR_BUFSIZE 64
2759 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2765 /* Retry on all errors; some devices are flakey.
2766 * 255 is for WUSB devices, we actually need to use
2767 * 512 (WUSB1.0[4.8.1]).
2769 for (j = 0; j < 3; ++j) {
2770 buf->bMaxPacketSize0 = 0;
2771 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2772 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2773 USB_DT_DEVICE << 8, 0,
2774 buf, GET_DESCRIPTOR_BUFSIZE,
2775 initial_descriptor_timeout);
2776 switch (buf->bMaxPacketSize0) {
2777 case 8: case 16: case 32: case 64: case 255:
2778 if (buf->bDescriptorType ==
2792 udev->descriptor.bMaxPacketSize0 =
2793 buf->bMaxPacketSize0;
2796 retval = hub_port_reset(hub, port1, udev, delay);
2797 if (retval < 0) /* error or disconnect */
2799 if (oldspeed != udev->speed) {
2801 "device reset changed speed!\n");
2807 "device descriptor read/64, error %d\n",
2812 #undef GET_DESCRIPTOR_BUFSIZE
2816 * If device is WUSB, we already assigned an
2817 * unauthorized address in the Connect Ack sequence;
2818 * authorization will assign the final address.
2820 if (udev->wusb == 0) {
2821 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
2822 retval = hub_set_address(udev, devnum);
2829 "device not accepting address %d, error %d\n",
2833 if (udev->speed == USB_SPEED_SUPER) {
2834 devnum = udev->devnum;
2835 dev_info(&udev->dev,
2836 "%s SuperSpeed USB device using %s and address %d\n",
2837 (udev->config) ? "reset" : "new",
2838 udev->bus->controller->driver->name, devnum);
2841 /* cope with hardware quirkiness:
2842 * - let SET_ADDRESS settle, some device hardware wants it
2843 * - read ep0 maxpacket even for high and low speed,
2846 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3))
2850 retval = usb_get_device_descriptor(udev, 8);
2853 "device descriptor read/8, error %d\n",
2865 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
2866 udev->speed == USB_SPEED_SUPER)
2869 i = udev->descriptor.bMaxPacketSize0;
2870 if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
2871 if (udev->speed != USB_SPEED_FULL ||
2872 !(i == 8 || i == 16 || i == 32 || i == 64)) {
2873 dev_err(&udev->dev, "ep0 maxpacket = %d\n", i);
2877 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
2878 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
2879 usb_ep0_reinit(udev);
2882 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
2883 if (retval < (signed)sizeof(udev->descriptor)) {
2884 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
2895 hub_port_disable(hub, port1, 0);
2896 update_address(udev, devnum); /* for disconnect processing */
2898 mutex_unlock(&usb_address0_mutex);
2903 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
2905 struct usb_qualifier_descriptor *qual;
2908 qual = kmalloc (sizeof *qual, GFP_KERNEL);
2912 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
2913 qual, sizeof *qual);
2914 if (status == sizeof *qual) {
2915 dev_info(&udev->dev, "not running at top speed; "
2916 "connect to a high speed hub\n");
2917 /* hub LEDs are probably harder to miss than syslog */
2918 if (hub->has_indicators) {
2919 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
2920 schedule_delayed_work (&hub->leds, 0);
2927 hub_power_remaining (struct usb_hub *hub)
2929 struct usb_device *hdev = hub->hdev;
2933 if (!hub->limited_power)
2936 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
2937 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
2938 struct usb_device *udev = hdev->children[port1 - 1];
2944 /* Unconfigured devices may not use more than 100mA,
2945 * or 8mA for OTG ports */
2946 if (udev->actconfig)
2947 delta = udev->actconfig->desc.bMaxPower * 2;
2948 else if (port1 != udev->bus->otg_port || hdev->parent)
2952 if (delta > hub->mA_per_port)
2953 dev_warn(&udev->dev,
2954 "%dmA is over %umA budget for port %d!\n",
2955 delta, hub->mA_per_port, port1);
2958 if (remaining < 0) {
2959 dev_warn(hub->intfdev, "%dmA over power budget!\n",
2966 /* Handle physical or logical connection change events.
2967 * This routine is called when:
2968 * a port connection-change occurs;
2969 * a port enable-change occurs (often caused by EMI);
2970 * usb_reset_and_verify_device() encounters changed descriptors (as from
2971 * a firmware download)
2972 * caller already locked the hub
2974 static void hub_port_connect_change(struct usb_hub *hub, int port1,
2975 u16 portstatus, u16 portchange)
2977 struct usb_device *hdev = hub->hdev;
2978 struct device *hub_dev = hub->intfdev;
2979 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
2980 unsigned wHubCharacteristics =
2981 le16_to_cpu(hub->descriptor->wHubCharacteristics);
2982 struct usb_device *udev;
2986 "port %d, status %04x, change %04x, %s\n",
2987 port1, portstatus, portchange, portspeed (portstatus));
2989 if (hub->has_indicators) {
2990 set_port_led(hub, port1, HUB_LED_AUTO);
2991 hub->indicator[port1-1] = INDICATOR_AUTO;
2994 #ifdef CONFIG_USB_OTG
2995 /* during HNP, don't repeat the debounce */
2996 if (hdev->bus->is_b_host)
2997 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
2998 USB_PORT_STAT_C_ENABLE);
3001 /* Try to resuscitate an existing device */
3002 udev = hdev->children[port1-1];
3003 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
3004 udev->state != USB_STATE_NOTATTACHED) {
3005 usb_lock_device(udev);
3006 if (portstatus & USB_PORT_STAT_ENABLE) {
3007 status = 0; /* Nothing to do */
3009 #ifdef CONFIG_USB_SUSPEND
3010 } else if (udev->state == USB_STATE_SUSPENDED &&
3011 udev->persist_enabled) {
3012 /* For a suspended device, treat this as a
3013 * remote wakeup event.
3015 status = usb_remote_wakeup(udev);
3019 status = -ENODEV; /* Don't resuscitate */
3021 usb_unlock_device(udev);
3024 clear_bit(port1, hub->change_bits);
3029 /* Disconnect any existing devices under this port */
3031 usb_disconnect(&hdev->children[port1-1]);
3032 clear_bit(port1, hub->change_bits);
3034 /* We can forget about a "removed" device when there's a physical
3035 * disconnect or the connect status changes.
3037 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
3038 (portchange & USB_PORT_STAT_C_CONNECTION))
3039 clear_bit(port1, hub->removed_bits);
3041 if (portchange & (USB_PORT_STAT_C_CONNECTION |
3042 USB_PORT_STAT_C_ENABLE)) {
3043 status = hub_port_debounce(hub, port1);
3045 if (printk_ratelimit())
3046 dev_err(hub_dev, "connect-debounce failed, "
3047 "port %d disabled\n", port1);
3048 portstatus &= ~USB_PORT_STAT_CONNECTION;
3050 portstatus = status;
3054 /* Return now if debouncing failed or nothing is connected or
3055 * the device was "removed".
3057 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
3058 test_bit(port1, hub->removed_bits)) {
3060 /* maybe switch power back on (e.g. root hub was reset) */
3061 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
3062 && !(portstatus & (1 << USB_PORT_FEAT_POWER)))
3063 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
3065 if (portstatus & USB_PORT_STAT_ENABLE)
3070 for (i = 0; i < SET_CONFIG_TRIES; i++) {
3072 /* reallocate for each attempt, since references
3073 * to the previous one can escape in various ways
3075 udev = usb_alloc_dev(hdev, hdev->bus, port1);
3078 "couldn't allocate port %d usb_device\n",
3083 usb_set_device_state(udev, USB_STATE_POWERED);
3084 udev->bus_mA = hub->mA_per_port;
3085 udev->level = hdev->level + 1;
3086 udev->wusb = hub_is_wusb(hub);
3089 * USB 3.0 devices are reset automatically before the connect
3090 * port status change appears, and the root hub port status
3091 * shows the correct speed. We also get port change
3092 * notifications for USB 3.0 devices from the USB 3.0 portion of
3093 * an external USB 3.0 hub, but this isn't handled correctly yet
3097 if (!(hcd->driver->flags & HCD_USB3))
3098 udev->speed = USB_SPEED_UNKNOWN;
3099 else if ((hdev->parent == NULL) &&
3100 (portstatus & (1 << USB_PORT_FEAT_SUPERSPEED)))
3101 udev->speed = USB_SPEED_SUPER;
3103 udev->speed = USB_SPEED_UNKNOWN;
3106 * xHCI needs to issue an address device command later
3107 * in the hub_port_init sequence for SS/HS/FS/LS devices.
3109 if (!(hcd->driver->flags & HCD_USB3)) {
3110 /* set the address */
3111 choose_address(udev);
3112 if (udev->devnum <= 0) {
3113 status = -ENOTCONN; /* Don't retry */
3118 /* reset (non-USB 3.0 devices) and get descriptor */
3119 status = hub_port_init(hub, udev, port1, i);
3123 /* consecutive bus-powered hubs aren't reliable; they can
3124 * violate the voltage drop budget. if the new child has
3125 * a "powered" LED, users should notice we didn't enable it
3126 * (without reading syslog), even without per-port LEDs
3129 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
3130 && udev->bus_mA <= 100) {
3133 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
3136 dev_dbg(&udev->dev, "get status %d ?\n", status);
3139 le16_to_cpus(&devstat);
3140 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
3142 "can't connect bus-powered hub "
3144 if (hub->has_indicators) {
3145 hub->indicator[port1-1] =
3146 INDICATOR_AMBER_BLINK;
3147 schedule_delayed_work (&hub->leds, 0);
3149 status = -ENOTCONN; /* Don't retry */
3154 /* check for devices running slower than they could */
3155 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
3156 && udev->speed == USB_SPEED_FULL
3157 && highspeed_hubs != 0)
3158 check_highspeed (hub, udev, port1);
3160 /* Store the parent's children[] pointer. At this point
3161 * udev becomes globally accessible, although presumably
3162 * no one will look at it until hdev is unlocked.
3166 /* We mustn't add new devices if the parent hub has
3167 * been disconnected; we would race with the
3168 * recursively_mark_NOTATTACHED() routine.
3170 spin_lock_irq(&device_state_lock);
3171 if (hdev->state == USB_STATE_NOTATTACHED)
3174 hdev->children[port1-1] = udev;
3175 spin_unlock_irq(&device_state_lock);
3177 /* Run it through the hoops (find a driver, etc) */
3179 status = usb_new_device(udev);
3181 spin_lock_irq(&device_state_lock);
3182 hdev->children[port1-1] = NULL;
3183 spin_unlock_irq(&device_state_lock);
3190 status = hub_power_remaining(hub);
3192 dev_dbg(hub_dev, "%dmA power budget left\n", status);
3197 hub_port_disable(hub, port1, 1);
3199 usb_ep0_reinit(udev);
3200 release_address(udev);
3202 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
3205 if (hub->hdev->parent ||
3206 !hcd->driver->port_handed_over ||
3207 !(hcd->driver->port_handed_over)(hcd, port1))
3208 dev_err(hub_dev, "unable to enumerate USB device on port %d\n",
3212 hub_port_disable(hub, port1, 1);
3213 if (hcd->driver->relinquish_port && !hub->hdev->parent)
3214 hcd->driver->relinquish_port(hcd, port1);
3217 static void hub_events(void)
3219 struct list_head *tmp;
3220 struct usb_device *hdev;
3221 struct usb_interface *intf;
3222 struct usb_hub *hub;
3223 struct device *hub_dev;
3232 * We restart the list every time to avoid a deadlock with
3233 * deleting hubs downstream from this one. This should be
3234 * safe since we delete the hub from the event list.
3235 * Not the most efficient, but avoids deadlocks.
3239 /* Grab the first entry at the beginning of the list */
3240 spin_lock_irq(&hub_event_lock);
3241 if (list_empty(&hub_event_list)) {
3242 spin_unlock_irq(&hub_event_lock);
3246 tmp = hub_event_list.next;
3249 hub = list_entry(tmp, struct usb_hub, event_list);
3250 kref_get(&hub->kref);
3251 spin_unlock_irq(&hub_event_lock);
3254 hub_dev = hub->intfdev;
3255 intf = to_usb_interface(hub_dev);
3256 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
3257 hdev->state, hub->descriptor
3258 ? hub->descriptor->bNbrPorts
3260 /* NOTE: expects max 15 ports... */
3261 (u16) hub->change_bits[0],
3262 (u16) hub->event_bits[0]);
3264 /* Lock the device, then check to see if we were
3265 * disconnected while waiting for the lock to succeed. */
3266 usb_lock_device(hdev);
3267 if (unlikely(hub->disconnected))
3270 /* If the hub has died, clean up after it */
3271 if (hdev->state == USB_STATE_NOTATTACHED) {
3272 hub->error = -ENODEV;
3273 hub_quiesce(hub, HUB_DISCONNECT);
3278 ret = usb_autopm_get_interface(intf);
3280 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
3284 /* If this is an inactive hub, do nothing */
3289 dev_dbg (hub_dev, "resetting for error %d\n",
3292 ret = usb_reset_device(hdev);
3295 "error resetting hub: %d\n", ret);
3303 /* deal with port status changes */
3304 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
3305 if (test_bit(i, hub->busy_bits))
3307 connect_change = test_bit(i, hub->change_bits);
3308 if (!test_and_clear_bit(i, hub->event_bits) &&
3312 ret = hub_port_status(hub, i,
3313 &portstatus, &portchange);
3317 if (portchange & USB_PORT_STAT_C_CONNECTION) {
3318 clear_port_feature(hdev, i,
3319 USB_PORT_FEAT_C_CONNECTION);
3323 if (portchange & USB_PORT_STAT_C_ENABLE) {
3324 if (!connect_change)
3326 "port %d enable change, "
3329 clear_port_feature(hdev, i,
3330 USB_PORT_FEAT_C_ENABLE);
3333 * EM interference sometimes causes badly
3334 * shielded USB devices to be shutdown by
3335 * the hub, this hack enables them again.
3336 * Works at least with mouse driver.
3338 if (!(portstatus & USB_PORT_STAT_ENABLE)
3340 && hdev->children[i-1]) {
3343 "disabled by hub (EMI?), "
3350 if (portchange & USB_PORT_STAT_C_SUSPEND) {
3351 struct usb_device *udev;
3353 clear_port_feature(hdev, i,
3354 USB_PORT_FEAT_C_SUSPEND);
3355 udev = hdev->children[i-1];
3357 /* TRSMRCY = 10 msec */
3360 usb_lock_device(udev);
3361 ret = usb_remote_wakeup(hdev->
3363 usb_unlock_device(udev);
3368 hub_port_disable(hub, i, 1);
3371 "resume on port %d, status %d\n",
3375 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
3377 "over-current change on port %d\n",
3379 clear_port_feature(hdev, i,
3380 USB_PORT_FEAT_C_OVER_CURRENT);
3381 hub_power_on(hub, true);
3384 if (portchange & USB_PORT_STAT_C_RESET) {
3386 "reset change on port %d\n",
3388 clear_port_feature(hdev, i,
3389 USB_PORT_FEAT_C_RESET);
3393 hub_port_connect_change(hub, i,
3394 portstatus, portchange);
3397 /* deal with hub status changes */
3398 if (test_and_clear_bit(0, hub->event_bits) == 0)
3400 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
3401 dev_err (hub_dev, "get_hub_status failed\n");
3403 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
3404 dev_dbg (hub_dev, "power change\n");
3405 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
3406 if (hubstatus & HUB_STATUS_LOCAL_POWER)
3407 /* FIXME: Is this always true? */
3408 hub->limited_power = 1;
3410 hub->limited_power = 0;
3412 if (hubchange & HUB_CHANGE_OVERCURRENT) {
3413 dev_dbg (hub_dev, "overcurrent change\n");
3414 msleep(500); /* Cool down */
3415 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
3416 hub_power_on(hub, true);
3421 /* Balance the usb_autopm_get_interface() above */
3422 usb_autopm_put_interface_no_suspend(intf);
3424 /* Balance the usb_autopm_get_interface_no_resume() in
3425 * kick_khubd() and allow autosuspend.
3427 usb_autopm_put_interface(intf);
3429 usb_unlock_device(hdev);
3430 kref_put(&hub->kref, hub_release);
3432 } /* end while (1) */
3435 static int hub_thread(void *__unused)
3437 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
3438 * port handover. Otherwise it might see that a full-speed device
3439 * was gone before the EHCI controller had handed its port over to
3440 * the companion full-speed controller.
3446 wait_event_freezable(khubd_wait,
3447 !list_empty(&hub_event_list) ||
3448 kthread_should_stop());
3449 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
3451 pr_debug("%s: khubd exiting\n", usbcore_name);
3455 static struct usb_device_id hub_id_table [] = {
3456 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
3457 .bDeviceClass = USB_CLASS_HUB},
3458 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
3459 .bInterfaceClass = USB_CLASS_HUB},
3460 { } /* Terminating entry */
3463 MODULE_DEVICE_TABLE (usb, hub_id_table);
3465 static struct usb_driver hub_driver = {
3468 .disconnect = hub_disconnect,
3469 .suspend = hub_suspend,
3470 .resume = hub_resume,
3471 .reset_resume = hub_reset_resume,
3472 .pre_reset = hub_pre_reset,
3473 .post_reset = hub_post_reset,
3475 .id_table = hub_id_table,
3476 .supports_autosuspend = 1,
3479 int usb_hub_init(void)
3481 if (usb_register(&hub_driver) < 0) {
3482 printk(KERN_ERR "%s: can't register hub driver\n",
3487 khubd_task = kthread_run(hub_thread, NULL, "khubd");
3488 if (!IS_ERR(khubd_task))
3491 /* Fall through if kernel_thread failed */
3492 usb_deregister(&hub_driver);
3493 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
3498 void usb_hub_cleanup(void)
3500 kthread_stop(khubd_task);
3503 * Hub resources are freed for us by usb_deregister. It calls
3504 * usb_driver_purge on every device which in turn calls that
3505 * devices disconnect function if it is using this driver.
3506 * The hub_disconnect function takes care of releasing the
3507 * individual hub resources. -greg
3509 usb_deregister(&hub_driver);
3510 } /* usb_hub_cleanup() */
3512 static int descriptors_changed(struct usb_device *udev,
3513 struct usb_device_descriptor *old_device_descriptor)
3517 unsigned serial_len = 0;
3519 unsigned old_length;
3523 if (memcmp(&udev->descriptor, old_device_descriptor,
3524 sizeof(*old_device_descriptor)) != 0)
3527 /* Since the idVendor, idProduct, and bcdDevice values in the
3528 * device descriptor haven't changed, we will assume the
3529 * Manufacturer and Product strings haven't changed either.
3530 * But the SerialNumber string could be different (e.g., a
3531 * different flash card of the same brand).
3534 serial_len = strlen(udev->serial) + 1;
3537 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3538 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3539 len = max(len, old_length);
3542 buf = kmalloc(len, GFP_NOIO);
3544 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
3545 /* assume the worst */
3548 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3549 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3550 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
3552 if (length != old_length) {
3553 dev_dbg(&udev->dev, "config index %d, error %d\n",
3558 if (memcmp (buf, udev->rawdescriptors[index], old_length)
3560 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
3562 ((struct usb_config_descriptor *) buf)->
3563 bConfigurationValue);
3569 if (!changed && serial_len) {
3570 length = usb_string(udev, udev->descriptor.iSerialNumber,
3572 if (length + 1 != serial_len) {
3573 dev_dbg(&udev->dev, "serial string error %d\n",
3576 } else if (memcmp(buf, udev->serial, length) != 0) {
3577 dev_dbg(&udev->dev, "serial string changed\n");
3587 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
3588 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3590 * WARNING - don't use this routine to reset a composite device
3591 * (one with multiple interfaces owned by separate drivers)!
3592 * Use usb_reset_device() instead.
3594 * Do a port reset, reassign the device's address, and establish its
3595 * former operating configuration. If the reset fails, or the device's
3596 * descriptors change from their values before the reset, or the original
3597 * configuration and altsettings cannot be restored, a flag will be set
3598 * telling khubd to pretend the device has been disconnected and then
3599 * re-connected. All drivers will be unbound, and the device will be
3600 * re-enumerated and probed all over again.
3602 * Returns 0 if the reset succeeded, -ENODEV if the device has been
3603 * flagged for logical disconnection, or some other negative error code
3604 * if the reset wasn't even attempted.
3606 * The caller must own the device lock. For example, it's safe to use
3607 * this from a driver probe() routine after downloading new firmware.
3608 * For calls that might not occur during probe(), drivers should lock
3609 * the device using usb_lock_device_for_reset().
3611 * Locking exception: This routine may also be called from within an
3612 * autoresume handler. Such usage won't conflict with other tasks
3613 * holding the device lock because these tasks should always call
3614 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
3616 static int usb_reset_and_verify_device(struct usb_device *udev)
3618 struct usb_device *parent_hdev = udev->parent;
3619 struct usb_hub *parent_hub;
3620 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3621 struct usb_device_descriptor descriptor = udev->descriptor;
3623 int port1 = udev->portnum;
3625 if (udev->state == USB_STATE_NOTATTACHED ||
3626 udev->state == USB_STATE_SUSPENDED) {
3627 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3633 /* this requires hcd-specific logic; see OHCI hc_restart() */
3634 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
3637 parent_hub = hdev_to_hub(parent_hdev);
3639 set_bit(port1, parent_hub->busy_bits);
3640 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
3642 /* ep0 maxpacket size may change; let the HCD know about it.
3643 * Other endpoints will be handled by re-enumeration. */
3644 usb_ep0_reinit(udev);
3645 ret = hub_port_init(parent_hub, udev, port1, i);
3646 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
3649 clear_bit(port1, parent_hub->busy_bits);
3654 /* Device might have changed firmware (DFU or similar) */
3655 if (descriptors_changed(udev, &descriptor)) {
3656 dev_info(&udev->dev, "device firmware changed\n");
3657 udev->descriptor = descriptor; /* for disconnect() calls */
3661 /* Restore the device's previous configuration */
3662 if (!udev->actconfig)
3665 mutex_lock(&hcd->bandwidth_mutex);
3666 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
3668 dev_warn(&udev->dev,
3669 "Busted HC? Not enough HCD resources for "
3670 "old configuration.\n");
3671 mutex_unlock(&hcd->bandwidth_mutex);
3674 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3675 USB_REQ_SET_CONFIGURATION, 0,
3676 udev->actconfig->desc.bConfigurationValue, 0,
3677 NULL, 0, USB_CTRL_SET_TIMEOUT);
3680 "can't restore configuration #%d (error=%d)\n",
3681 udev->actconfig->desc.bConfigurationValue, ret);
3682 mutex_unlock(&hcd->bandwidth_mutex);
3685 mutex_unlock(&hcd->bandwidth_mutex);
3686 usb_set_device_state(udev, USB_STATE_CONFIGURED);
3688 /* Put interfaces back into the same altsettings as before.
3689 * Don't bother to send the Set-Interface request for interfaces
3690 * that were already in altsetting 0; besides being unnecessary,
3691 * many devices can't handle it. Instead just reset the host-side
3694 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
3695 struct usb_host_config *config = udev->actconfig;
3696 struct usb_interface *intf = config->interface[i];
3697 struct usb_interface_descriptor *desc;
3699 desc = &intf->cur_altsetting->desc;
3700 if (desc->bAlternateSetting == 0) {
3701 usb_disable_interface(udev, intf, true);
3702 usb_enable_interface(udev, intf, true);
3705 /* Let the bandwidth allocation function know that this
3706 * device has been reset, and it will have to use
3707 * alternate setting 0 as the current alternate setting.
3709 intf->resetting_device = 1;
3710 ret = usb_set_interface(udev, desc->bInterfaceNumber,
3711 desc->bAlternateSetting);
3712 intf->resetting_device = 0;
3715 dev_err(&udev->dev, "failed to restore interface %d "
3716 "altsetting %d (error=%d)\n",
3717 desc->bInterfaceNumber,
3718 desc->bAlternateSetting,
3728 hub_port_logical_disconnect(parent_hub, port1);
3733 * usb_reset_device - warn interface drivers and perform a USB port reset
3734 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3736 * Warns all drivers bound to registered interfaces (using their pre_reset
3737 * method), performs the port reset, and then lets the drivers know that
3738 * the reset is over (using their post_reset method).
3740 * Return value is the same as for usb_reset_and_verify_device().
3742 * The caller must own the device lock. For example, it's safe to use
3743 * this from a driver probe() routine after downloading new firmware.
3744 * For calls that might not occur during probe(), drivers should lock
3745 * the device using usb_lock_device_for_reset().
3747 * If an interface is currently being probed or disconnected, we assume
3748 * its driver knows how to handle resets. For all other interfaces,
3749 * if the driver doesn't have pre_reset and post_reset methods then
3750 * we attempt to unbind it and rebind afterward.
3752 int usb_reset_device(struct usb_device *udev)
3756 struct usb_host_config *config = udev->actconfig;
3758 if (udev->state == USB_STATE_NOTATTACHED ||
3759 udev->state == USB_STATE_SUSPENDED) {
3760 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3765 /* Prevent autosuspend during the reset */
3766 usb_autoresume_device(udev);
3769 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
3770 struct usb_interface *cintf = config->interface[i];
3771 struct usb_driver *drv;
3774 if (cintf->dev.driver) {
3775 drv = to_usb_driver(cintf->dev.driver);
3776 if (drv->pre_reset && drv->post_reset)
3777 unbind = (drv->pre_reset)(cintf);
3778 else if (cintf->condition ==
3779 USB_INTERFACE_BOUND)
3782 usb_forced_unbind_intf(cintf);
3787 ret = usb_reset_and_verify_device(udev);
3790 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
3791 struct usb_interface *cintf = config->interface[i];
3792 struct usb_driver *drv;
3793 int rebind = cintf->needs_binding;
3795 if (!rebind && cintf->dev.driver) {
3796 drv = to_usb_driver(cintf->dev.driver);
3797 if (drv->post_reset)
3798 rebind = (drv->post_reset)(cintf);
3799 else if (cintf->condition ==
3800 USB_INTERFACE_BOUND)
3803 if (ret == 0 && rebind)
3804 usb_rebind_intf(cintf);
3808 usb_autosuspend_device(udev);
3811 EXPORT_SYMBOL_GPL(usb_reset_device);
3815 * usb_queue_reset_device - Reset a USB device from an atomic context
3816 * @iface: USB interface belonging to the device to reset
3818 * This function can be used to reset a USB device from an atomic
3819 * context, where usb_reset_device() won't work (as it blocks).
3821 * Doing a reset via this method is functionally equivalent to calling
3822 * usb_reset_device(), except for the fact that it is delayed to a
3823 * workqueue. This means that any drivers bound to other interfaces
3824 * might be unbound, as well as users from usbfs in user space.
3828 * - Scheduling two resets at the same time from two different drivers
3829 * attached to two different interfaces of the same device is
3830 * possible; depending on how the driver attached to each interface
3831 * handles ->pre_reset(), the second reset might happen or not.
3833 * - If a driver is unbound and it had a pending reset, the reset will
3836 * - This function can be called during .probe() or .disconnect()
3837 * times. On return from .disconnect(), any pending resets will be
3840 * There is no no need to lock/unlock the @reset_ws as schedule_work()
3843 * NOTE: We don't do any reference count tracking because it is not
3844 * needed. The lifecycle of the work_struct is tied to the
3845 * usb_interface. Before destroying the interface we cancel the
3846 * work_struct, so the fact that work_struct is queued and or
3847 * running means the interface (and thus, the device) exist and
3850 void usb_queue_reset_device(struct usb_interface *iface)
3852 schedule_work(&iface->reset_ws);
3854 EXPORT_SYMBOL_GPL(usb_queue_reset_device);