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>
25 #include <linux/usb/quirks.h>
27 #include <asm/uaccess.h>
28 #include <asm/byteorder.h>
34 /* if we are in debug mode, always announce new devices */
36 #ifndef CONFIG_USB_ANNOUNCE_NEW_DEVICES
37 #define CONFIG_USB_ANNOUNCE_NEW_DEVICES
42 struct device *intfdev; /* the "interface" device */
43 struct usb_device *hdev;
45 struct urb *urb; /* for interrupt polling pipe */
47 /* buffer for urb ... with extra space in case of babble */
49 dma_addr_t buffer_dma; /* DMA address for buffer */
51 struct usb_hub_status hub;
52 struct usb_port_status port;
53 } *status; /* buffer for status reports */
54 struct mutex status_mutex; /* for the status buffer */
56 int error; /* last reported error */
57 int nerrors; /* track consecutive errors */
59 struct list_head event_list; /* hubs w/data or errs ready */
60 unsigned long event_bits[1]; /* status change bitmask */
61 unsigned long change_bits[1]; /* ports with logical connect
63 unsigned long busy_bits[1]; /* ports being reset or
65 #if USB_MAXCHILDREN > 31 /* 8*sizeof(unsigned long) - 1 */
66 #error event_bits[] is too short!
69 struct usb_hub_descriptor *descriptor; /* class descriptor */
70 struct usb_tt tt; /* Transaction Translator */
72 unsigned mA_per_port; /* current for each child */
74 unsigned limited_power:1;
76 unsigned disconnected:1;
78 unsigned has_indicators:1;
79 u8 indicator[USB_MAXCHILDREN];
80 struct delayed_work leds;
81 struct delayed_work init_work;
86 /* Protect struct usb_device->state and ->children members
87 * Note: Both are also protected by ->dev.sem, except that ->state can
88 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
89 static DEFINE_SPINLOCK(device_state_lock);
91 /* khubd's worklist and its lock */
92 static DEFINE_SPINLOCK(hub_event_lock);
93 static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
96 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
98 static struct task_struct *khubd_task;
100 /* cycle leds on hubs that aren't blinking for attention */
101 static int blinkenlights = 0;
102 module_param (blinkenlights, bool, S_IRUGO);
103 MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
106 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
107 * 10 seconds to send reply for the initial 64-byte descriptor request.
109 /* define initial 64-byte descriptor request timeout in milliseconds */
110 static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
111 module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
112 MODULE_PARM_DESC(initial_descriptor_timeout,
113 "initial 64-byte descriptor request timeout in milliseconds "
114 "(default 5000 - 5.0 seconds)");
117 * As of 2.6.10 we introduce a new USB device initialization scheme which
118 * closely resembles the way Windows works. Hopefully it will be compatible
119 * with a wider range of devices than the old scheme. However some previously
120 * working devices may start giving rise to "device not accepting address"
121 * errors; if that happens the user can try the old scheme by adjusting the
122 * following module parameters.
124 * For maximum flexibility there are two boolean parameters to control the
125 * hub driver's behavior. On the first initialization attempt, if the
126 * "old_scheme_first" parameter is set then the old scheme will be used,
127 * otherwise the new scheme is used. If that fails and "use_both_schemes"
128 * is set, then the driver will make another attempt, using the other scheme.
130 static int old_scheme_first = 0;
131 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
132 MODULE_PARM_DESC(old_scheme_first,
133 "start with the old device initialization scheme");
135 static int use_both_schemes = 1;
136 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
137 MODULE_PARM_DESC(use_both_schemes,
138 "try the other device initialization scheme if the "
141 /* Mutual exclusion for EHCI CF initialization. This interferes with
142 * port reset on some companion controllers.
144 DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
145 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
147 #define HUB_DEBOUNCE_TIMEOUT 1500
148 #define HUB_DEBOUNCE_STEP 25
149 #define HUB_DEBOUNCE_STABLE 100
152 static int usb_reset_and_verify_device(struct usb_device *udev);
154 static inline char *portspeed(int portstatus)
156 if (portstatus & (1 << USB_PORT_FEAT_HIGHSPEED))
158 else if (portstatus & (1 << USB_PORT_FEAT_LOWSPEED))
160 else if (portstatus & (1 << USB_PORT_FEAT_SUPERSPEED))
166 /* Note that hdev or one of its children must be locked! */
167 static struct usb_hub *hdev_to_hub(struct usb_device *hdev)
169 if (!hdev || !hdev->actconfig)
171 return usb_get_intfdata(hdev->actconfig->interface[0]);
174 /* USB 2.0 spec Section 11.24.4.5 */
175 static int get_hub_descriptor(struct usb_device *hdev, void *data, int size)
179 for (i = 0; i < 3; i++) {
180 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
181 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
182 USB_DT_HUB << 8, 0, data, size,
183 USB_CTRL_GET_TIMEOUT);
184 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
191 * USB 2.0 spec Section 11.24.2.1
193 static int clear_hub_feature(struct usb_device *hdev, int feature)
195 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
196 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
200 * USB 2.0 spec Section 11.24.2.2
202 static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
204 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
205 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
210 * USB 2.0 spec Section 11.24.2.13
212 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
214 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
215 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
220 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
221 * for info about using port indicators
223 static void set_port_led(
229 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
230 USB_PORT_FEAT_INDICATOR);
232 dev_dbg (hub->intfdev,
233 "port %d indicator %s status %d\n",
235 ({ char *s; switch (selector) {
236 case HUB_LED_AMBER: s = "amber"; break;
237 case HUB_LED_GREEN: s = "green"; break;
238 case HUB_LED_OFF: s = "off"; break;
239 case HUB_LED_AUTO: s = "auto"; break;
240 default: s = "??"; break;
245 #define LED_CYCLE_PERIOD ((2*HZ)/3)
247 static void led_work (struct work_struct *work)
249 struct usb_hub *hub =
250 container_of(work, struct usb_hub, leds.work);
251 struct usb_device *hdev = hub->hdev;
253 unsigned changed = 0;
256 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
259 for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
260 unsigned selector, mode;
262 /* 30%-50% duty cycle */
264 switch (hub->indicator[i]) {
266 case INDICATOR_CYCLE:
268 selector = HUB_LED_AUTO;
269 mode = INDICATOR_AUTO;
271 /* blinking green = sw attention */
272 case INDICATOR_GREEN_BLINK:
273 selector = HUB_LED_GREEN;
274 mode = INDICATOR_GREEN_BLINK_OFF;
276 case INDICATOR_GREEN_BLINK_OFF:
277 selector = HUB_LED_OFF;
278 mode = INDICATOR_GREEN_BLINK;
280 /* blinking amber = hw attention */
281 case INDICATOR_AMBER_BLINK:
282 selector = HUB_LED_AMBER;
283 mode = INDICATOR_AMBER_BLINK_OFF;
285 case INDICATOR_AMBER_BLINK_OFF:
286 selector = HUB_LED_OFF;
287 mode = INDICATOR_AMBER_BLINK;
289 /* blink green/amber = reserved */
290 case INDICATOR_ALT_BLINK:
291 selector = HUB_LED_GREEN;
292 mode = INDICATOR_ALT_BLINK_OFF;
294 case INDICATOR_ALT_BLINK_OFF:
295 selector = HUB_LED_AMBER;
296 mode = INDICATOR_ALT_BLINK;
301 if (selector != HUB_LED_AUTO)
303 set_port_led(hub, i + 1, selector);
304 hub->indicator[i] = mode;
306 if (!changed && blinkenlights) {
308 cursor %= hub->descriptor->bNbrPorts;
309 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
310 hub->indicator[cursor] = INDICATOR_CYCLE;
314 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
317 /* use a short timeout for hub/port status fetches */
318 #define USB_STS_TIMEOUT 1000
319 #define USB_STS_RETRIES 5
322 * USB 2.0 spec Section 11.24.2.6
324 static int get_hub_status(struct usb_device *hdev,
325 struct usb_hub_status *data)
327 int i, status = -ETIMEDOUT;
329 for (i = 0; i < USB_STS_RETRIES &&
330 (status == -ETIMEDOUT || status == -EPIPE); 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 &&
347 (status == -ETIMEDOUT || status == -EPIPE); i++) {
348 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
349 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
350 data, sizeof(*data), USB_STS_TIMEOUT);
355 static int hub_port_status(struct usb_hub *hub, int port1,
356 u16 *status, u16 *change)
360 mutex_lock(&hub->status_mutex);
361 ret = get_port_status(hub->hdev, port1, &hub->status->port);
363 dev_err(hub->intfdev,
364 "%s failed (err = %d)\n", __func__, ret);
368 *status = le16_to_cpu(hub->status->port.wPortStatus);
369 *change = le16_to_cpu(hub->status->port.wPortChange);
372 mutex_unlock(&hub->status_mutex);
376 static void kick_khubd(struct usb_hub *hub)
380 /* Suppress autosuspend until khubd runs */
381 atomic_set(&to_usb_interface(hub->intfdev)->pm_usage_cnt, 1);
383 spin_lock_irqsave(&hub_event_lock, flags);
384 if (!hub->disconnected && list_empty(&hub->event_list)) {
385 list_add_tail(&hub->event_list, &hub_event_list);
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);
642 enum hub_activation_type {
643 HUB_INIT, HUB_INIT2, HUB_INIT3,
644 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
647 static void hub_init_func2(struct work_struct *ws);
648 static void hub_init_func3(struct work_struct *ws);
650 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
652 struct usb_device *hdev = hub->hdev;
657 bool need_debounce_delay = false;
660 /* Continue a partial initialization */
661 if (type == HUB_INIT2)
663 if (type == HUB_INIT3)
666 /* After a resume, port power should still be on.
667 * For any other type of activation, turn it on.
669 if (type != HUB_RESUME) {
671 /* Speed up system boot by using a delayed_work for the
672 * hub's initial power-up delays. This is pretty awkward
673 * and the implementation looks like a home-brewed sort of
674 * setjmp/longjmp, but it saves at least 100 ms for each
675 * root hub (assuming usbcore is compiled into the kernel
676 * rather than as a module). It adds up.
678 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
679 * because for those activation types the ports have to be
680 * operational when we return. In theory this could be done
681 * for HUB_POST_RESET, but it's easier not to.
683 if (type == HUB_INIT) {
684 delay = hub_power_on(hub, false);
685 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func2);
686 schedule_delayed_work(&hub->init_work,
687 msecs_to_jiffies(delay));
689 /* Suppress autosuspend until init is done */
690 atomic_set(&to_usb_interface(hub->intfdev)->
692 return; /* Continues at init2: below */
693 } else if (type == HUB_RESET_RESUME) {
694 /* The internal host controller state for the hub device
695 * may be gone after a host power loss on system resume.
696 * Update the device's info so the HW knows it's a hub.
698 hcd = bus_to_hcd(hdev->bus);
699 if (hcd->driver->update_hub_device) {
700 ret = hcd->driver->update_hub_device(hcd, hdev,
703 dev_err(hub->intfdev, "Host not "
704 "accepting hub info "
706 dev_err(hub->intfdev, "LS/FS devices "
707 "and hubs may not work "
708 "under this hub\n.");
711 hub_power_on(hub, true);
713 hub_power_on(hub, true);
718 /* Check each port and set hub->change_bits to let khubd know
719 * which ports need attention.
721 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
722 struct usb_device *udev = hdev->children[port1-1];
723 u16 portstatus, portchange;
725 portstatus = portchange = 0;
726 status = hub_port_status(hub, port1, &portstatus, &portchange);
727 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
728 dev_dbg(hub->intfdev,
729 "port %d: status %04x change %04x\n",
730 port1, portstatus, portchange);
732 /* After anything other than HUB_RESUME (i.e., initialization
733 * or any sort of reset), every port should be disabled.
734 * Unconnected ports should likewise be disabled (paranoia),
735 * and so should ports for which we have no usb_device.
737 if ((portstatus & USB_PORT_STAT_ENABLE) && (
738 type != HUB_RESUME ||
739 !(portstatus & USB_PORT_STAT_CONNECTION) ||
741 udev->state == USB_STATE_NOTATTACHED)) {
742 clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
743 portstatus &= ~USB_PORT_STAT_ENABLE;
746 /* Clear status-change flags; we'll debounce later */
747 if (portchange & USB_PORT_STAT_C_CONNECTION) {
748 need_debounce_delay = true;
749 clear_port_feature(hub->hdev, port1,
750 USB_PORT_FEAT_C_CONNECTION);
752 if (portchange & USB_PORT_STAT_C_ENABLE) {
753 need_debounce_delay = true;
754 clear_port_feature(hub->hdev, port1,
755 USB_PORT_FEAT_C_ENABLE);
758 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
759 /* Tell khubd to disconnect the device or
760 * check for a new connection
762 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
763 set_bit(port1, hub->change_bits);
765 } else if (portstatus & USB_PORT_STAT_ENABLE) {
766 /* The power session apparently survived the resume.
767 * If there was an overcurrent or suspend change
768 * (i.e., remote wakeup request), have khubd
772 set_bit(port1, hub->change_bits);
774 } else if (udev->persist_enabled) {
776 udev->reset_resume = 1;
778 set_bit(port1, hub->change_bits);
781 /* The power session is gone; tell khubd */
782 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
783 set_bit(port1, hub->change_bits);
787 /* If no port-status-change flags were set, we don't need any
788 * debouncing. If flags were set we can try to debounce the
789 * ports all at once right now, instead of letting khubd do them
790 * one at a time later on.
792 * If any port-status changes do occur during this delay, khubd
793 * will see them later and handle them normally.
795 if (need_debounce_delay) {
796 delay = HUB_DEBOUNCE_STABLE;
798 /* Don't do a long sleep inside a workqueue routine */
799 if (type == HUB_INIT2) {
800 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func3);
801 schedule_delayed_work(&hub->init_work,
802 msecs_to_jiffies(delay));
803 return; /* Continues at init3: below */
811 status = usb_submit_urb(hub->urb, GFP_NOIO);
813 dev_err(hub->intfdev, "activate --> %d\n", status);
814 if (hub->has_indicators && blinkenlights)
815 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
817 /* Scan all ports that need attention */
821 /* Implement the continuations for the delays above */
822 static void hub_init_func2(struct work_struct *ws)
824 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
826 hub_activate(hub, HUB_INIT2);
829 static void hub_init_func3(struct work_struct *ws)
831 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
833 hub_activate(hub, HUB_INIT3);
836 enum hub_quiescing_type {
837 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
840 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
842 struct usb_device *hdev = hub->hdev;
845 cancel_delayed_work_sync(&hub->init_work);
847 /* khubd and related activity won't re-trigger */
850 if (type != HUB_SUSPEND) {
851 /* Disconnect all the children */
852 for (i = 0; i < hdev->maxchild; ++i) {
853 if (hdev->children[i])
854 usb_disconnect(&hdev->children[i]);
858 /* Stop khubd and related activity */
859 usb_kill_urb(hub->urb);
860 if (hub->has_indicators)
861 cancel_delayed_work_sync(&hub->leds);
863 cancel_work_sync(&hub->tt.clear_work);
866 /* caller has locked the hub device */
867 static int hub_pre_reset(struct usb_interface *intf)
869 struct usb_hub *hub = usb_get_intfdata(intf);
871 hub_quiesce(hub, HUB_PRE_RESET);
875 /* caller has locked the hub device */
876 static int hub_post_reset(struct usb_interface *intf)
878 struct usb_hub *hub = usb_get_intfdata(intf);
880 hub_activate(hub, HUB_POST_RESET);
884 static int hub_configure(struct usb_hub *hub,
885 struct usb_endpoint_descriptor *endpoint)
888 struct usb_device *hdev = hub->hdev;
889 struct device *hub_dev = hub->intfdev;
890 u16 hubstatus, hubchange;
891 u16 wHubCharacteristics;
894 char *message = "out of memory";
896 hub->buffer = usb_buffer_alloc(hdev, sizeof(*hub->buffer), GFP_KERNEL,
903 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
908 mutex_init(&hub->status_mutex);
910 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
911 if (!hub->descriptor) {
916 /* Request the entire hub descriptor.
917 * hub->descriptor can handle USB_MAXCHILDREN ports,
918 * but the hub can/will return fewer bytes here.
920 ret = get_hub_descriptor(hdev, hub->descriptor,
921 sizeof(*hub->descriptor));
923 message = "can't read hub descriptor";
925 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
926 message = "hub has too many ports!";
931 hdev->maxchild = hub->descriptor->bNbrPorts;
932 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
933 (hdev->maxchild == 1) ? "" : "s");
935 hub->port_owners = kzalloc(hdev->maxchild * sizeof(void *), GFP_KERNEL);
936 if (!hub->port_owners) {
941 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
943 if (wHubCharacteristics & HUB_CHAR_COMPOUND) {
945 char portstr [USB_MAXCHILDREN + 1];
947 for (i = 0; i < hdev->maxchild; i++)
948 portstr[i] = hub->descriptor->DeviceRemovable
949 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
951 portstr[hdev->maxchild] = 0;
952 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
954 dev_dbg(hub_dev, "standalone hub\n");
956 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
958 dev_dbg(hub_dev, "ganged power switching\n");
961 dev_dbg(hub_dev, "individual port power switching\n");
965 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
969 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
971 dev_dbg(hub_dev, "global over-current protection\n");
974 dev_dbg(hub_dev, "individual port over-current protection\n");
978 dev_dbg(hub_dev, "no over-current protection\n");
982 spin_lock_init (&hub->tt.lock);
983 INIT_LIST_HEAD (&hub->tt.clear_list);
984 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
985 switch (hdev->descriptor.bDeviceProtocol) {
989 dev_dbg(hub_dev, "Single TT\n");
993 ret = usb_set_interface(hdev, 0, 1);
995 dev_dbg(hub_dev, "TT per port\n");
998 dev_err(hub_dev, "Using single TT (err %d)\n",
1003 /* USB 3.0 hubs don't have a TT */
1006 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1007 hdev->descriptor.bDeviceProtocol);
1011 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1012 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1013 case HUB_TTTT_8_BITS:
1014 if (hdev->descriptor.bDeviceProtocol != 0) {
1015 hub->tt.think_time = 666;
1016 dev_dbg(hub_dev, "TT requires at most %d "
1017 "FS bit times (%d ns)\n",
1018 8, hub->tt.think_time);
1021 case HUB_TTTT_16_BITS:
1022 hub->tt.think_time = 666 * 2;
1023 dev_dbg(hub_dev, "TT requires at most %d "
1024 "FS bit times (%d ns)\n",
1025 16, hub->tt.think_time);
1027 case HUB_TTTT_24_BITS:
1028 hub->tt.think_time = 666 * 3;
1029 dev_dbg(hub_dev, "TT requires at most %d "
1030 "FS bit times (%d ns)\n",
1031 24, hub->tt.think_time);
1033 case HUB_TTTT_32_BITS:
1034 hub->tt.think_time = 666 * 4;
1035 dev_dbg(hub_dev, "TT requires at most %d "
1036 "FS bit times (%d ns)\n",
1037 32, hub->tt.think_time);
1041 /* probe() zeroes hub->indicator[] */
1042 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1043 hub->has_indicators = 1;
1044 dev_dbg(hub_dev, "Port indicators are supported\n");
1047 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1048 hub->descriptor->bPwrOn2PwrGood * 2);
1050 /* power budgeting mostly matters with bus-powered hubs,
1051 * and battery-powered root hubs (may provide just 8 mA).
1053 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1055 message = "can't get hub status";
1058 le16_to_cpus(&hubstatus);
1059 if (hdev == hdev->bus->root_hub) {
1060 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
1061 hub->mA_per_port = 500;
1063 hub->mA_per_port = hdev->bus_mA;
1064 hub->limited_power = 1;
1066 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1067 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1068 hub->descriptor->bHubContrCurrent);
1069 hub->limited_power = 1;
1070 if (hdev->maxchild > 0) {
1071 int remaining = hdev->bus_mA -
1072 hub->descriptor->bHubContrCurrent;
1074 if (remaining < hdev->maxchild * 100)
1076 "insufficient power available "
1077 "to use all downstream ports\n");
1078 hub->mA_per_port = 100; /* 7.2.1.1 */
1080 } else { /* Self-powered external hub */
1081 /* FIXME: What about battery-powered external hubs that
1082 * provide less current per port? */
1083 hub->mA_per_port = 500;
1085 if (hub->mA_per_port < 500)
1086 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1089 /* Update the HCD's internal representation of this hub before khubd
1090 * starts getting port status changes for devices under the hub.
1092 hcd = bus_to_hcd(hdev->bus);
1093 if (hcd->driver->update_hub_device) {
1094 ret = hcd->driver->update_hub_device(hcd, hdev,
1095 &hub->tt, GFP_KERNEL);
1097 message = "can't update HCD hub info";
1102 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1104 message = "can't get hub status";
1108 /* local power status reports aren't always correct */
1109 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1110 dev_dbg(hub_dev, "local power source is %s\n",
1111 (hubstatus & HUB_STATUS_LOCAL_POWER)
1112 ? "lost (inactive)" : "good");
1114 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1115 dev_dbg(hub_dev, "%sover-current condition exists\n",
1116 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1118 /* set up the interrupt endpoint
1119 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1120 * bytes as USB2.0[11.12.3] says because some hubs are known
1121 * to send more data (and thus cause overflow). For root hubs,
1122 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1123 * to be big enough for at least USB_MAXCHILDREN ports. */
1124 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1125 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1127 if (maxp > sizeof(*hub->buffer))
1128 maxp = sizeof(*hub->buffer);
1130 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1136 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1137 hub, endpoint->bInterval);
1138 hub->urb->transfer_dma = hub->buffer_dma;
1139 hub->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1141 /* maybe cycle the hub leds */
1142 if (hub->has_indicators && blinkenlights)
1143 hub->indicator [0] = INDICATOR_CYCLE;
1145 hub_activate(hub, HUB_INIT);
1149 dev_err (hub_dev, "config failed, %s (err %d)\n",
1151 /* hub_disconnect() frees urb and descriptor */
1155 static void hub_release(struct kref *kref)
1157 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1159 usb_put_intf(to_usb_interface(hub->intfdev));
1163 static unsigned highspeed_hubs;
1165 static void hub_disconnect(struct usb_interface *intf)
1167 struct usb_hub *hub = usb_get_intfdata (intf);
1169 /* Take the hub off the event list and don't let it be added again */
1170 spin_lock_irq(&hub_event_lock);
1171 list_del_init(&hub->event_list);
1172 hub->disconnected = 1;
1173 spin_unlock_irq(&hub_event_lock);
1175 /* Disconnect all children and quiesce the hub */
1177 hub_quiesce(hub, HUB_DISCONNECT);
1179 usb_set_intfdata (intf, NULL);
1180 hub->hdev->maxchild = 0;
1182 if (hub->hdev->speed == USB_SPEED_HIGH)
1185 usb_free_urb(hub->urb);
1186 kfree(hub->port_owners);
1187 kfree(hub->descriptor);
1189 usb_buffer_free(hub->hdev, sizeof(*hub->buffer), hub->buffer,
1192 kref_put(&hub->kref, hub_release);
1195 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1197 struct usb_host_interface *desc;
1198 struct usb_endpoint_descriptor *endpoint;
1199 struct usb_device *hdev;
1200 struct usb_hub *hub;
1202 desc = intf->cur_altsetting;
1203 hdev = interface_to_usbdev(intf);
1205 if (hdev->level == MAX_TOPO_LEVEL) {
1207 "Unsupported bus topology: hub nested too deep\n");
1211 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1213 dev_warn(&intf->dev, "ignoring external hub\n");
1218 /* Some hubs have a subclass of 1, which AFAICT according to the */
1219 /* specs is not defined, but it works */
1220 if ((desc->desc.bInterfaceSubClass != 0) &&
1221 (desc->desc.bInterfaceSubClass != 1)) {
1223 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1227 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1228 if (desc->desc.bNumEndpoints != 1)
1229 goto descriptor_error;
1231 endpoint = &desc->endpoint[0].desc;
1233 /* If it's not an interrupt in endpoint, we'd better punt! */
1234 if (!usb_endpoint_is_int_in(endpoint))
1235 goto descriptor_error;
1237 /* We found a hub */
1238 dev_info (&intf->dev, "USB hub found\n");
1240 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1242 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1246 kref_init(&hub->kref);
1247 INIT_LIST_HEAD(&hub->event_list);
1248 hub->intfdev = &intf->dev;
1250 INIT_DELAYED_WORK(&hub->leds, led_work);
1251 INIT_DELAYED_WORK(&hub->init_work, NULL);
1254 usb_set_intfdata (intf, hub);
1255 intf->needs_remote_wakeup = 1;
1257 if (hdev->speed == USB_SPEED_HIGH)
1260 if (hub_configure(hub, endpoint) >= 0)
1263 hub_disconnect (intf);
1268 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1270 struct usb_device *hdev = interface_to_usbdev (intf);
1272 /* assert ifno == 0 (part of hub spec) */
1274 case USBDEVFS_HUB_PORTINFO: {
1275 struct usbdevfs_hub_portinfo *info = user_data;
1278 spin_lock_irq(&device_state_lock);
1279 if (hdev->devnum <= 0)
1282 info->nports = hdev->maxchild;
1283 for (i = 0; i < info->nports; i++) {
1284 if (hdev->children[i] == NULL)
1288 hdev->children[i]->devnum;
1291 spin_unlock_irq(&device_state_lock);
1293 return info->nports + 1;
1302 * Allow user programs to claim ports on a hub. When a device is attached
1303 * to one of these "claimed" ports, the program will "own" the device.
1305 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1308 if (hdev->state == USB_STATE_NOTATTACHED)
1310 if (port1 == 0 || port1 > hdev->maxchild)
1313 /* This assumes that devices not managed by the hub driver
1314 * will always have maxchild equal to 0.
1316 *ppowner = &(hdev_to_hub(hdev)->port_owners[port1 - 1]);
1320 /* In the following three functions, the caller must hold hdev's lock */
1321 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1, void *owner)
1326 rc = find_port_owner(hdev, port1, &powner);
1335 int usb_hub_release_port(struct usb_device *hdev, unsigned port1, void *owner)
1340 rc = find_port_owner(hdev, port1, &powner);
1343 if (*powner != owner)
1349 void usb_hub_release_all_ports(struct usb_device *hdev, void *owner)
1354 n = find_port_owner(hdev, 1, &powner);
1356 for (; n < hdev->maxchild; (++n, ++powner)) {
1357 if (*powner == owner)
1363 /* The caller must hold udev's lock */
1364 bool usb_device_is_owned(struct usb_device *udev)
1366 struct usb_hub *hub;
1368 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1370 hub = hdev_to_hub(udev->parent);
1371 return !!hub->port_owners[udev->portnum - 1];
1375 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1379 for (i = 0; i < udev->maxchild; ++i) {
1380 if (udev->children[i])
1381 recursively_mark_NOTATTACHED(udev->children[i]);
1383 if (udev->state == USB_STATE_SUSPENDED) {
1384 udev->discon_suspended = 1;
1385 udev->active_duration -= jiffies;
1387 udev->state = USB_STATE_NOTATTACHED;
1391 * usb_set_device_state - change a device's current state (usbcore, hcds)
1392 * @udev: pointer to device whose state should be changed
1393 * @new_state: new state value to be stored
1395 * udev->state is _not_ fully protected by the device lock. Although
1396 * most transitions are made only while holding the lock, the state can
1397 * can change to USB_STATE_NOTATTACHED at almost any time. This
1398 * is so that devices can be marked as disconnected as soon as possible,
1399 * without having to wait for any semaphores to be released. As a result,
1400 * all changes to any device's state must be protected by the
1401 * device_state_lock spinlock.
1403 * Once a device has been added to the device tree, all changes to its state
1404 * should be made using this routine. The state should _not_ be set directly.
1406 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1407 * Otherwise udev->state is set to new_state, and if new_state is
1408 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1409 * to USB_STATE_NOTATTACHED.
1411 void usb_set_device_state(struct usb_device *udev,
1412 enum usb_device_state new_state)
1414 unsigned long flags;
1416 spin_lock_irqsave(&device_state_lock, flags);
1417 if (udev->state == USB_STATE_NOTATTACHED)
1419 else if (new_state != USB_STATE_NOTATTACHED) {
1421 /* root hub wakeup capabilities are managed out-of-band
1422 * and may involve silicon errata ... ignore them here.
1425 if (udev->state == USB_STATE_SUSPENDED
1426 || new_state == USB_STATE_SUSPENDED)
1427 ; /* No change to wakeup settings */
1428 else if (new_state == USB_STATE_CONFIGURED)
1429 device_set_wakeup_capable(&udev->dev,
1430 (udev->actconfig->desc.bmAttributes
1431 & USB_CONFIG_ATT_WAKEUP));
1433 device_set_wakeup_capable(&udev->dev, 0);
1435 if (udev->state == USB_STATE_SUSPENDED &&
1436 new_state != USB_STATE_SUSPENDED)
1437 udev->active_duration -= jiffies;
1438 else if (new_state == USB_STATE_SUSPENDED &&
1439 udev->state != USB_STATE_SUSPENDED)
1440 udev->active_duration += jiffies;
1441 udev->state = new_state;
1443 recursively_mark_NOTATTACHED(udev);
1444 spin_unlock_irqrestore(&device_state_lock, flags);
1446 EXPORT_SYMBOL_GPL(usb_set_device_state);
1449 * WUSB devices are simple: they have no hubs behind, so the mapping
1450 * device <-> virtual port number becomes 1:1. Why? to simplify the
1451 * life of the device connection logic in
1452 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1453 * handshake we need to assign a temporary address in the unauthorized
1454 * space. For simplicity we use the first virtual port number found to
1455 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1456 * and that becomes it's address [X < 128] or its unauthorized address
1459 * We add 1 as an offset to the one-based USB-stack port number
1460 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1461 * 0 is reserved by USB for default address; (b) Linux's USB stack
1462 * uses always #1 for the root hub of the controller. So USB stack's
1463 * port #1, which is wusb virtual-port #0 has address #2.
1465 * Devices connected under xHCI are not as simple. The host controller
1466 * supports virtualization, so the hardware assigns device addresses and
1467 * the HCD must setup data structures before issuing a set address
1468 * command to the hardware.
1470 static void choose_address(struct usb_device *udev)
1473 struct usb_bus *bus = udev->bus;
1475 /* If khubd ever becomes multithreaded, this will need a lock */
1477 devnum = udev->portnum + 1;
1478 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
1480 /* Try to allocate the next devnum beginning at
1481 * bus->devnum_next. */
1482 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1485 devnum = find_next_zero_bit(bus->devmap.devicemap,
1487 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1490 set_bit(devnum, bus->devmap.devicemap);
1491 udev->devnum = devnum;
1495 static void release_address(struct usb_device *udev)
1497 if (udev->devnum > 0) {
1498 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1503 static void update_address(struct usb_device *udev, int devnum)
1505 /* The address for a WUSB device is managed by wusbcore. */
1507 udev->devnum = devnum;
1510 #ifdef CONFIG_USB_SUSPEND
1512 static void usb_stop_pm(struct usb_device *udev)
1514 /* Synchronize with the ksuspend thread to prevent any more
1515 * autosuspend requests from being submitted, and decrement
1516 * the parent's count of unsuspended children.
1519 if (udev->parent && !udev->discon_suspended)
1520 usb_autosuspend_device(udev->parent);
1521 usb_pm_unlock(udev);
1523 /* Stop any autosuspend or autoresume requests already submitted */
1524 cancel_delayed_work_sync(&udev->autosuspend);
1525 cancel_work_sync(&udev->autoresume);
1530 static inline void usb_stop_pm(struct usb_device *udev)
1535 static void hub_free_dev(struct usb_device *udev)
1537 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1539 /* Root hubs aren't real devices, so don't free HCD resources */
1540 if (hcd->driver->free_dev && udev->parent)
1541 hcd->driver->free_dev(hcd, udev);
1545 * usb_disconnect - disconnect a device (usbcore-internal)
1546 * @pdev: pointer to device being disconnected
1547 * Context: !in_interrupt ()
1549 * Something got disconnected. Get rid of it and all of its children.
1551 * If *pdev is a normal device then the parent hub must already be locked.
1552 * If *pdev is a root hub then this routine will acquire the
1553 * usb_bus_list_lock on behalf of the caller.
1555 * Only hub drivers (including virtual root hub drivers for host
1556 * controllers) should ever call this.
1558 * This call is synchronous, and may not be used in an interrupt context.
1560 void usb_disconnect(struct usb_device **pdev)
1562 struct usb_device *udev = *pdev;
1566 pr_debug ("%s nodev\n", __func__);
1570 /* mark the device as inactive, so any further urb submissions for
1571 * this device (and any of its children) will fail immediately.
1572 * this quiesces everyting except pending urbs.
1574 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1575 dev_info (&udev->dev, "USB disconnect, address %d\n", udev->devnum);
1577 usb_lock_device(udev);
1579 /* Free up all the children before we remove this device */
1580 for (i = 0; i < USB_MAXCHILDREN; i++) {
1581 if (udev->children[i])
1582 usb_disconnect(&udev->children[i]);
1585 /* deallocate hcd/hardware state ... nuking all pending urbs and
1586 * cleaning up all state associated with the current configuration
1587 * so that the hardware is now fully quiesced.
1589 dev_dbg (&udev->dev, "unregistering device\n");
1590 usb_disable_device(udev, 0);
1591 usb_hcd_synchronize_unlinks(udev);
1593 usb_remove_ep_devs(&udev->ep0);
1594 usb_unlock_device(udev);
1596 /* Unregister the device. The device driver is responsible
1597 * for de-configuring the device and invoking the remove-device
1598 * notifier chain (used by usbfs and possibly others).
1600 device_del(&udev->dev);
1602 /* Free the device number and delete the parent's children[]
1603 * (or root_hub) pointer.
1605 release_address(udev);
1607 /* Avoid races with recursively_mark_NOTATTACHED() */
1608 spin_lock_irq(&device_state_lock);
1610 spin_unlock_irq(&device_state_lock);
1616 put_device(&udev->dev);
1619 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
1620 static void show_string(struct usb_device *udev, char *id, char *string)
1624 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1627 static void announce_device(struct usb_device *udev)
1629 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
1630 le16_to_cpu(udev->descriptor.idVendor),
1631 le16_to_cpu(udev->descriptor.idProduct));
1632 dev_info(&udev->dev,
1633 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
1634 udev->descriptor.iManufacturer,
1635 udev->descriptor.iProduct,
1636 udev->descriptor.iSerialNumber);
1637 show_string(udev, "Product", udev->product);
1638 show_string(udev, "Manufacturer", udev->manufacturer);
1639 show_string(udev, "SerialNumber", udev->serial);
1642 static inline void announce_device(struct usb_device *udev) { }
1645 #ifdef CONFIG_USB_OTG
1646 #include "otg_whitelist.h"
1650 * usb_enumerate_device_otg - FIXME (usbcore-internal)
1651 * @udev: newly addressed device (in ADDRESS state)
1653 * Finish enumeration for On-The-Go devices
1655 static int usb_enumerate_device_otg(struct usb_device *udev)
1659 #ifdef CONFIG_USB_OTG
1661 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1662 * to wake us after we've powered off VBUS; and HNP, switching roles
1663 * "host" to "peripheral". The OTG descriptor helps figure this out.
1665 if (!udev->bus->is_b_host
1667 && udev->parent == udev->bus->root_hub) {
1668 struct usb_otg_descriptor *desc = 0;
1669 struct usb_bus *bus = udev->bus;
1671 /* descriptor may appear anywhere in config */
1672 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1673 le16_to_cpu(udev->config[0].desc.wTotalLength),
1674 USB_DT_OTG, (void **) &desc) == 0) {
1675 if (desc->bmAttributes & USB_OTG_HNP) {
1676 unsigned port1 = udev->portnum;
1678 dev_info(&udev->dev,
1679 "Dual-Role OTG device on %sHNP port\n",
1680 (port1 == bus->otg_port)
1683 /* enable HNP before suspend, it's simpler */
1684 if (port1 == bus->otg_port)
1685 bus->b_hnp_enable = 1;
1686 err = usb_control_msg(udev,
1687 usb_sndctrlpipe(udev, 0),
1688 USB_REQ_SET_FEATURE, 0,
1690 ? USB_DEVICE_B_HNP_ENABLE
1691 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1692 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1694 /* OTG MESSAGE: report errors here,
1695 * customize to match your product.
1697 dev_info(&udev->dev,
1698 "can't set HNP mode: %d\n",
1700 bus->b_hnp_enable = 0;
1706 if (!is_targeted(udev)) {
1708 /* Maybe it can talk to us, though we can't talk to it.
1709 * (Includes HNP test device.)
1711 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
1712 err = usb_port_suspend(udev, PMSG_SUSPEND);
1714 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1726 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
1727 * @udev: newly addressed device (in ADDRESS state)
1729 * This is only called by usb_new_device() and usb_authorize_device()
1730 * and FIXME -- all comments that apply to them apply here wrt to
1733 * If the device is WUSB and not authorized, we don't attempt to read
1734 * the string descriptors, as they will be errored out by the device
1735 * until it has been authorized.
1737 static int usb_enumerate_device(struct usb_device *udev)
1741 if (udev->config == NULL) {
1742 err = usb_get_configuration(udev);
1744 dev_err(&udev->dev, "can't read configurations, error %d\n",
1749 if (udev->wusb == 1 && udev->authorized == 0) {
1750 udev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1751 udev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1752 udev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1755 /* read the standard strings and cache them if present */
1756 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1757 udev->manufacturer = usb_cache_string(udev,
1758 udev->descriptor.iManufacturer);
1759 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
1761 err = usb_enumerate_device_otg(udev);
1768 * usb_new_device - perform initial device setup (usbcore-internal)
1769 * @udev: newly addressed device (in ADDRESS state)
1771 * This is called with devices which have been detected but not fully
1772 * enumerated. The device descriptor is available, but not descriptors
1773 * for any device configuration. The caller must have locked either
1774 * the parent hub (if udev is a normal device) or else the
1775 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1776 * udev has already been installed, but udev is not yet visible through
1777 * sysfs or other filesystem code.
1779 * It will return if the device is configured properly or not. Zero if
1780 * the interface was registered with the driver core; else a negative
1783 * This call is synchronous, and may not be used in an interrupt context.
1785 * Only the hub driver or root-hub registrar should ever call this.
1787 int usb_new_device(struct usb_device *udev)
1792 /* Increment the parent's count of unsuspended children */
1793 usb_autoresume_device(udev->parent);
1795 /* Initialize non-root-hub device wakeup to disabled;
1796 * device (un)configuration controls wakeup capable
1797 * sysfs power/wakeup controls wakeup enabled/disabled
1799 device_init_wakeup(&udev->dev, 0);
1802 err = usb_enumerate_device(udev); /* Read descriptors */
1805 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
1806 udev->devnum, udev->bus->busnum,
1807 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1808 /* export the usbdev device-node for libusb */
1809 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
1810 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1812 /* Tell the world! */
1813 announce_device(udev);
1815 /* Register the device. The device driver is responsible
1816 * for configuring the device and invoking the add-device
1817 * notifier chain (used by usbfs and possibly others).
1819 err = device_add(&udev->dev);
1821 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1825 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
1829 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1836 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
1837 * @usb_dev: USB device
1839 * Move the USB device to a very basic state where interfaces are disabled
1840 * and the device is in fact unconfigured and unusable.
1842 * We share a lock (that we have) with device_del(), so we need to
1845 int usb_deauthorize_device(struct usb_device *usb_dev)
1847 usb_lock_device(usb_dev);
1848 if (usb_dev->authorized == 0)
1849 goto out_unauthorized;
1851 usb_dev->authorized = 0;
1852 usb_set_configuration(usb_dev, -1);
1854 kfree(usb_dev->product);
1855 usb_dev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1856 kfree(usb_dev->manufacturer);
1857 usb_dev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1858 kfree(usb_dev->serial);
1859 usb_dev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1861 usb_destroy_configuration(usb_dev);
1862 usb_dev->descriptor.bNumConfigurations = 0;
1865 usb_unlock_device(usb_dev);
1870 int usb_authorize_device(struct usb_device *usb_dev)
1874 usb_lock_device(usb_dev);
1875 if (usb_dev->authorized == 1)
1876 goto out_authorized;
1878 result = usb_autoresume_device(usb_dev);
1880 dev_err(&usb_dev->dev,
1881 "can't autoresume for authorization: %d\n", result);
1882 goto error_autoresume;
1884 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
1886 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
1887 "authorization: %d\n", result);
1888 goto error_device_descriptor;
1891 kfree(usb_dev->product);
1892 usb_dev->product = NULL;
1893 kfree(usb_dev->manufacturer);
1894 usb_dev->manufacturer = NULL;
1895 kfree(usb_dev->serial);
1896 usb_dev->serial = NULL;
1898 usb_dev->authorized = 1;
1899 result = usb_enumerate_device(usb_dev);
1901 goto error_enumerate;
1902 /* Choose and set the configuration. This registers the interfaces
1903 * with the driver core and lets interface drivers bind to them.
1905 c = usb_choose_configuration(usb_dev);
1907 result = usb_set_configuration(usb_dev, c);
1909 dev_err(&usb_dev->dev,
1910 "can't set config #%d, error %d\n", c, result);
1911 /* This need not be fatal. The user can try to
1912 * set other configurations. */
1915 dev_info(&usb_dev->dev, "authorized to connect\n");
1918 error_device_descriptor:
1919 usb_autosuspend_device(usb_dev);
1922 usb_unlock_device(usb_dev); // complements locktree
1927 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
1928 static unsigned hub_is_wusb(struct usb_hub *hub)
1930 struct usb_hcd *hcd;
1931 if (hub->hdev->parent != NULL) /* not a root hub? */
1933 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
1934 return hcd->wireless;
1938 #define PORT_RESET_TRIES 5
1939 #define SET_ADDRESS_TRIES 2
1940 #define GET_DESCRIPTOR_TRIES 2
1941 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1942 #define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1944 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1945 #define HUB_SHORT_RESET_TIME 10
1946 #define HUB_LONG_RESET_TIME 200
1947 #define HUB_RESET_TIMEOUT 500
1949 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
1950 struct usb_device *udev, unsigned int delay)
1952 int delay_time, ret;
1956 for (delay_time = 0;
1957 delay_time < HUB_RESET_TIMEOUT;
1958 delay_time += delay) {
1959 /* wait to give the device a chance to reset */
1962 /* read and decode port status */
1963 ret = hub_port_status(hub, port1, &portstatus, &portchange);
1967 /* Device went away? */
1968 if (!(portstatus & USB_PORT_STAT_CONNECTION))
1971 /* bomb out completely if the connection bounced */
1972 if ((portchange & USB_PORT_STAT_C_CONNECTION))
1975 /* if we`ve finished resetting, then break out of the loop */
1976 if (!(portstatus & USB_PORT_STAT_RESET) &&
1977 (portstatus & USB_PORT_STAT_ENABLE)) {
1978 if (hub_is_wusb(hub))
1979 udev->speed = USB_SPEED_VARIABLE;
1980 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
1981 udev->speed = USB_SPEED_HIGH;
1982 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
1983 udev->speed = USB_SPEED_LOW;
1985 udev->speed = USB_SPEED_FULL;
1989 /* switch to the long delay after two short delay failures */
1990 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
1991 delay = HUB_LONG_RESET_TIME;
1993 dev_dbg (hub->intfdev,
1994 "port %d not reset yet, waiting %dms\n",
2001 static int hub_port_reset(struct usb_hub *hub, int port1,
2002 struct usb_device *udev, unsigned int delay)
2006 /* Block EHCI CF initialization during the port reset.
2007 * Some companion controllers don't like it when they mix.
2009 down_read(&ehci_cf_port_reset_rwsem);
2011 /* Reset the port */
2012 for (i = 0; i < PORT_RESET_TRIES; i++) {
2013 status = set_port_feature(hub->hdev,
2014 port1, USB_PORT_FEAT_RESET);
2016 dev_err(hub->intfdev,
2017 "cannot reset port %d (err = %d)\n",
2020 status = hub_port_wait_reset(hub, port1, udev, delay);
2021 if (status && status != -ENOTCONN)
2022 dev_dbg(hub->intfdev,
2023 "port_wait_reset: err = %d\n",
2027 /* return on disconnect or reset */
2030 /* TRSTRCY = 10 ms; plus some extra */
2032 update_address(udev, 0);
2036 clear_port_feature(hub->hdev,
2037 port1, USB_PORT_FEAT_C_RESET);
2038 /* FIXME need disconnect() for NOTATTACHED device */
2039 usb_set_device_state(udev, status
2040 ? USB_STATE_NOTATTACHED
2041 : USB_STATE_DEFAULT);
2045 dev_dbg (hub->intfdev,
2046 "port %d not enabled, trying reset again...\n",
2048 delay = HUB_LONG_RESET_TIME;
2051 dev_err (hub->intfdev,
2052 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2056 up_read(&ehci_cf_port_reset_rwsem);
2062 #define MASK_BITS (USB_PORT_STAT_POWER | USB_PORT_STAT_CONNECTION | \
2063 USB_PORT_STAT_SUSPEND)
2064 #define WANT_BITS (USB_PORT_STAT_POWER | USB_PORT_STAT_CONNECTION)
2066 /* Determine whether the device on a port is ready for a normal resume,
2067 * is ready for a reset-resume, or should be disconnected.
2069 static int check_port_resume_type(struct usb_device *udev,
2070 struct usb_hub *hub, int port1,
2071 int status, unsigned portchange, unsigned portstatus)
2073 /* Is the device still present? */
2074 if (status || (portstatus & MASK_BITS) != WANT_BITS) {
2079 /* Can't do a normal resume if the port isn't enabled,
2080 * so try a reset-resume instead.
2082 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2083 if (udev->persist_enabled)
2084 udev->reset_resume = 1;
2090 dev_dbg(hub->intfdev,
2091 "port %d status %04x.%04x after resume, %d\n",
2092 port1, portchange, portstatus, status);
2093 } else if (udev->reset_resume) {
2095 /* Late port handoff can set status-change bits */
2096 if (portchange & USB_PORT_STAT_C_CONNECTION)
2097 clear_port_feature(hub->hdev, port1,
2098 USB_PORT_FEAT_C_CONNECTION);
2099 if (portchange & USB_PORT_STAT_C_ENABLE)
2100 clear_port_feature(hub->hdev, port1,
2101 USB_PORT_FEAT_C_ENABLE);
2107 #ifdef CONFIG_USB_SUSPEND
2110 * usb_port_suspend - suspend a usb device's upstream port
2111 * @udev: device that's no longer in active use, not a root hub
2112 * Context: must be able to sleep; device not locked; pm locks held
2114 * Suspends a USB device that isn't in active use, conserving power.
2115 * Devices may wake out of a suspend, if anything important happens,
2116 * using the remote wakeup mechanism. They may also be taken out of
2117 * suspend by the host, using usb_port_resume(). It's also routine
2118 * to disconnect devices while they are suspended.
2120 * This only affects the USB hardware for a device; its interfaces
2121 * (and, for hubs, child devices) must already have been suspended.
2123 * Selective port suspend reduces power; most suspended devices draw
2124 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2125 * All devices below the suspended port are also suspended.
2127 * Devices leave suspend state when the host wakes them up. Some devices
2128 * also support "remote wakeup", where the device can activate the USB
2129 * tree above them to deliver data, such as a keypress or packet. In
2130 * some cases, this wakes the USB host.
2132 * Suspending OTG devices may trigger HNP, if that's been enabled
2133 * between a pair of dual-role devices. That will change roles, such
2134 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2136 * Devices on USB hub ports have only one "suspend" state, corresponding
2137 * to ACPI D2, "may cause the device to lose some context".
2138 * State transitions include:
2140 * - suspend, resume ... when the VBUS power link stays live
2141 * - suspend, disconnect ... VBUS lost
2143 * Once VBUS drop breaks the circuit, the port it's using has to go through
2144 * normal re-enumeration procedures, starting with enabling VBUS power.
2145 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2146 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2147 * timer, no SRP, no requests through sysfs.
2149 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
2150 * the root hub for their bus goes into global suspend ... so we don't
2151 * (falsely) update the device power state to say it suspended.
2153 * Returns 0 on success, else negative errno.
2155 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2157 struct usb_hub *hub = hdev_to_hub(udev->parent);
2158 int port1 = udev->portnum;
2161 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
2163 /* enable remote wakeup when appropriate; this lets the device
2164 * wake up the upstream hub (including maybe the root hub).
2166 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2167 * we don't explicitly enable it here.
2169 if (udev->do_remote_wakeup) {
2170 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2171 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2172 USB_DEVICE_REMOTE_WAKEUP, 0,
2174 USB_CTRL_SET_TIMEOUT);
2176 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
2181 status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
2183 dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
2185 /* paranoia: "should not happen" */
2186 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2187 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2188 USB_DEVICE_REMOTE_WAKEUP, 0,
2190 USB_CTRL_SET_TIMEOUT);
2192 /* device has up to 10 msec to fully suspend */
2193 dev_dbg(&udev->dev, "usb %ssuspend\n",
2194 (msg.event & PM_EVENT_AUTO ? "auto-" : ""));
2195 usb_set_device_state(udev, USB_STATE_SUSPENDED);
2202 * If the USB "suspend" state is in use (rather than "global suspend"),
2203 * many devices will be individually taken out of suspend state using
2204 * special "resume" signaling. This routine kicks in shortly after
2205 * hardware resume signaling is finished, either because of selective
2206 * resume (by host) or remote wakeup (by device) ... now see what changed
2207 * in the tree that's rooted at this device.
2209 * If @udev->reset_resume is set then the device is reset before the
2210 * status check is done.
2212 static int finish_port_resume(struct usb_device *udev)
2217 /* caller owns the udev device lock */
2218 dev_dbg(&udev->dev, "%s\n",
2219 udev->reset_resume ? "finish reset-resume" : "finish resume");
2221 /* usb ch9 identifies four variants of SUSPENDED, based on what
2222 * state the device resumes to. Linux currently won't see the
2223 * first two on the host side; they'd be inside hub_port_init()
2224 * during many timeouts, but khubd can't suspend until later.
2226 usb_set_device_state(udev, udev->actconfig
2227 ? USB_STATE_CONFIGURED
2228 : USB_STATE_ADDRESS);
2230 /* 10.5.4.5 says not to reset a suspended port if the attached
2231 * device is enabled for remote wakeup. Hence the reset
2232 * operation is carried out here, after the port has been
2235 if (udev->reset_resume)
2237 status = usb_reset_and_verify_device(udev);
2239 /* 10.5.4.5 says be sure devices in the tree are still there.
2240 * For now let's assume the device didn't go crazy on resume,
2241 * and device drivers will know about any resume quirks.
2245 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
2247 status = (status > 0 ? 0 : -ENODEV);
2249 /* If a normal resume failed, try doing a reset-resume */
2250 if (status && !udev->reset_resume && udev->persist_enabled) {
2251 dev_dbg(&udev->dev, "retry with reset-resume\n");
2252 udev->reset_resume = 1;
2253 goto retry_reset_resume;
2258 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
2260 } else if (udev->actconfig) {
2261 le16_to_cpus(&devstatus);
2262 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) {
2263 status = usb_control_msg(udev,
2264 usb_sndctrlpipe(udev, 0),
2265 USB_REQ_CLEAR_FEATURE,
2267 USB_DEVICE_REMOTE_WAKEUP, 0,
2269 USB_CTRL_SET_TIMEOUT);
2272 "disable remote wakeup, status %d\n",
2281 * usb_port_resume - re-activate a suspended usb device's upstream port
2282 * @udev: device to re-activate, not a root hub
2283 * Context: must be able to sleep; device not locked; pm locks held
2285 * This will re-activate the suspended device, increasing power usage
2286 * while letting drivers communicate again with its endpoints.
2287 * USB resume explicitly guarantees that the power session between
2288 * the host and the device is the same as it was when the device
2291 * If @udev->reset_resume is set then this routine won't check that the
2292 * port is still enabled. Furthermore, finish_port_resume() above will
2293 * reset @udev. The end result is that a broken power session can be
2294 * recovered and @udev will appear to persist across a loss of VBUS power.
2296 * For example, if a host controller doesn't maintain VBUS suspend current
2297 * during a system sleep or is reset when the system wakes up, all the USB
2298 * power sessions below it will be broken. This is especially troublesome
2299 * for mass-storage devices containing mounted filesystems, since the
2300 * device will appear to have disconnected and all the memory mappings
2301 * to it will be lost. Using the USB_PERSIST facility, the device can be
2302 * made to appear as if it had not disconnected.
2304 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
2305 * every effort to insure that the same device is present after the
2306 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
2307 * quite possible for a device to remain unaltered but its media to be
2308 * changed. If the user replaces a flash memory card while the system is
2309 * asleep, he will have only himself to blame when the filesystem on the
2310 * new card is corrupted and the system crashes.
2312 * Returns 0 on success, else negative errno.
2314 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
2316 struct usb_hub *hub = hdev_to_hub(udev->parent);
2317 int port1 = udev->portnum;
2319 u16 portchange, portstatus;
2321 /* Skip the initial Clear-Suspend step for a remote wakeup */
2322 status = hub_port_status(hub, port1, &portstatus, &portchange);
2323 if (status == 0 && !(portstatus & USB_PORT_STAT_SUSPEND))
2324 goto SuspendCleared;
2326 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
2328 set_bit(port1, hub->busy_bits);
2330 /* see 7.1.7.7; affects power usage, but not budgeting */
2331 status = clear_port_feature(hub->hdev,
2332 port1, USB_PORT_FEAT_SUSPEND);
2334 dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
2337 /* drive resume for at least 20 msec */
2338 dev_dbg(&udev->dev, "usb %sresume\n",
2339 (msg.event & PM_EVENT_AUTO ? "auto-" : ""));
2342 /* Virtual root hubs can trigger on GET_PORT_STATUS to
2343 * stop resume signaling. Then finish the resume
2346 status = hub_port_status(hub, port1, &portstatus, &portchange);
2348 /* TRSMRCY = 10 msec */
2354 if (portchange & USB_PORT_STAT_C_SUSPEND)
2355 clear_port_feature(hub->hdev, port1,
2356 USB_PORT_FEAT_C_SUSPEND);
2359 clear_bit(port1, hub->busy_bits);
2361 status = check_port_resume_type(udev,
2362 hub, port1, status, portchange, portstatus);
2364 status = finish_port_resume(udev);
2366 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2367 hub_port_logical_disconnect(hub, port1);
2372 /* caller has locked udev */
2373 static int remote_wakeup(struct usb_device *udev)
2377 if (udev->state == USB_STATE_SUSPENDED) {
2378 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
2379 usb_mark_last_busy(udev);
2380 status = usb_external_resume_device(udev, PMSG_REMOTE_RESUME);
2385 #else /* CONFIG_USB_SUSPEND */
2387 /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
2389 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2394 /* However we may need to do a reset-resume */
2396 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
2398 struct usb_hub *hub = hdev_to_hub(udev->parent);
2399 int port1 = udev->portnum;
2401 u16 portchange, portstatus;
2403 status = hub_port_status(hub, port1, &portstatus, &portchange);
2404 status = check_port_resume_type(udev,
2405 hub, port1, status, portchange, portstatus);
2408 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2409 hub_port_logical_disconnect(hub, port1);
2410 } else if (udev->reset_resume) {
2411 dev_dbg(&udev->dev, "reset-resume\n");
2412 status = usb_reset_and_verify_device(udev);
2417 static inline int remote_wakeup(struct usb_device *udev)
2424 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
2426 struct usb_hub *hub = usb_get_intfdata (intf);
2427 struct usb_device *hdev = hub->hdev;
2430 /* fail if children aren't already suspended */
2431 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
2432 struct usb_device *udev;
2434 udev = hdev->children [port1-1];
2435 if (udev && udev->can_submit) {
2436 if (!(msg.event & PM_EVENT_AUTO))
2437 dev_dbg(&intf->dev, "port %d nyet suspended\n",
2443 dev_dbg(&intf->dev, "%s\n", __func__);
2445 /* stop khubd and related activity */
2446 hub_quiesce(hub, HUB_SUSPEND);
2450 static int hub_resume(struct usb_interface *intf)
2452 struct usb_hub *hub = usb_get_intfdata(intf);
2454 dev_dbg(&intf->dev, "%s\n", __func__);
2455 hub_activate(hub, HUB_RESUME);
2459 static int hub_reset_resume(struct usb_interface *intf)
2461 struct usb_hub *hub = usb_get_intfdata(intf);
2463 dev_dbg(&intf->dev, "%s\n", __func__);
2464 hub_activate(hub, HUB_RESET_RESUME);
2469 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
2470 * @rhdev: struct usb_device for the root hub
2472 * The USB host controller driver calls this function when its root hub
2473 * is resumed and Vbus power has been interrupted or the controller
2474 * has been reset. The routine marks @rhdev as having lost power.
2475 * When the hub driver is resumed it will take notice and carry out
2476 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
2477 * the others will be disconnected.
2479 void usb_root_hub_lost_power(struct usb_device *rhdev)
2481 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
2482 rhdev->reset_resume = 1;
2484 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
2486 #else /* CONFIG_PM */
2488 static inline int remote_wakeup(struct usb_device *udev)
2493 #define hub_suspend NULL
2494 #define hub_resume NULL
2495 #define hub_reset_resume NULL
2499 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2501 * Between connect detection and reset signaling there must be a delay
2502 * of 100ms at least for debounce and power-settling. The corresponding
2503 * timer shall restart whenever the downstream port detects a disconnect.
2505 * Apparently there are some bluetooth and irda-dongles and a number of
2506 * low-speed devices for which this debounce period may last over a second.
2507 * Not covered by the spec - but easy to deal with.
2509 * This implementation uses a 1500ms total debounce timeout; if the
2510 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2511 * every 25ms for transient disconnects. When the port status has been
2512 * unchanged for 100ms it returns the port status.
2514 static int hub_port_debounce(struct usb_hub *hub, int port1)
2517 int total_time, stable_time = 0;
2518 u16 portchange, portstatus;
2519 unsigned connection = 0xffff;
2521 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2522 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2526 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2527 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2528 stable_time += HUB_DEBOUNCE_STEP;
2529 if (stable_time >= HUB_DEBOUNCE_STABLE)
2533 connection = portstatus & USB_PORT_STAT_CONNECTION;
2536 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2537 clear_port_feature(hub->hdev, port1,
2538 USB_PORT_FEAT_C_CONNECTION);
2541 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2543 msleep(HUB_DEBOUNCE_STEP);
2546 dev_dbg (hub->intfdev,
2547 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2548 port1, total_time, stable_time, portstatus);
2550 if (stable_time < HUB_DEBOUNCE_STABLE)
2555 void usb_ep0_reinit(struct usb_device *udev)
2557 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
2558 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
2559 usb_enable_endpoint(udev, &udev->ep0, true);
2561 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
2563 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2564 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2566 static int hub_set_address(struct usb_device *udev, int devnum)
2569 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2572 * The host controller will choose the device address,
2573 * instead of the core having chosen it earlier
2575 if (!hcd->driver->address_device && devnum <= 1)
2577 if (udev->state == USB_STATE_ADDRESS)
2579 if (udev->state != USB_STATE_DEFAULT)
2581 if (hcd->driver->address_device) {
2582 retval = hcd->driver->address_device(hcd, udev);
2584 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2585 USB_REQ_SET_ADDRESS, 0, devnum, 0,
2586 NULL, 0, USB_CTRL_SET_TIMEOUT);
2588 update_address(udev, devnum);
2591 /* Device now using proper address. */
2592 usb_set_device_state(udev, USB_STATE_ADDRESS);
2593 usb_ep0_reinit(udev);
2598 /* Reset device, (re)assign address, get device descriptor.
2599 * Device connection must be stable, no more debouncing needed.
2600 * Returns device in USB_STATE_ADDRESS, except on error.
2602 * If this is called for an already-existing device (as part of
2603 * usb_reset_and_verify_device), the caller must own the device lock. For a
2604 * newly detected device that is not accessible through any global
2605 * pointers, it's not necessary to lock the device.
2608 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2611 static DEFINE_MUTEX(usb_address0_mutex);
2613 struct usb_device *hdev = hub->hdev;
2614 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
2616 unsigned delay = HUB_SHORT_RESET_TIME;
2617 enum usb_device_speed oldspeed = udev->speed;
2619 int devnum = udev->devnum;
2621 /* root hub ports have a slightly longer reset period
2622 * (from USB 2.0 spec, section 7.1.7.5)
2624 if (!hdev->parent) {
2625 delay = HUB_ROOT_RESET_TIME;
2626 if (port1 == hdev->bus->otg_port)
2627 hdev->bus->b_hnp_enable = 0;
2630 /* Some low speed devices have problems with the quick delay, so */
2631 /* be a bit pessimistic with those devices. RHbug #23670 */
2632 if (oldspeed == USB_SPEED_LOW)
2633 delay = HUB_LONG_RESET_TIME;
2635 mutex_lock(&usb_address0_mutex);
2637 if ((hcd->driver->flags & HCD_USB3) && udev->config) {
2638 /* FIXME this will need special handling by the xHCI driver. */
2640 "xHCI reset of configured device "
2641 "not supported yet.\n");
2644 } else if (!udev->config && oldspeed == USB_SPEED_SUPER) {
2645 /* Don't reset USB 3.0 devices during an initial setup */
2646 usb_set_device_state(udev, USB_STATE_DEFAULT);
2648 /* Reset the device; full speed may morph to high speed */
2649 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
2650 retval = hub_port_reset(hub, port1, udev, delay);
2651 if (retval < 0) /* error or disconnect */
2653 /* success, speed is known */
2657 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2658 dev_dbg(&udev->dev, "device reset changed speed!\n");
2661 oldspeed = udev->speed;
2663 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2664 * it's fixed size except for full speed devices.
2665 * For Wireless USB devices, ep0 max packet is always 512 (tho
2666 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
2668 switch (udev->speed) {
2669 case USB_SPEED_SUPER:
2670 case USB_SPEED_VARIABLE: /* fixed at 512 */
2671 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
2673 case USB_SPEED_HIGH: /* fixed at 64 */
2674 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
2676 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
2677 /* to determine the ep0 maxpacket size, try to read
2678 * the device descriptor to get bMaxPacketSize0 and
2679 * then correct our initial guess.
2681 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
2683 case USB_SPEED_LOW: /* fixed at 8 */
2684 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
2691 switch (udev->speed) {
2692 case USB_SPEED_LOW: speed = "low"; break;
2693 case USB_SPEED_FULL: speed = "full"; break;
2694 case USB_SPEED_HIGH: speed = "high"; break;
2695 case USB_SPEED_SUPER:
2698 case USB_SPEED_VARIABLE:
2702 default: speed = "?"; break;
2704 if (udev->speed != USB_SPEED_SUPER)
2705 dev_info(&udev->dev,
2706 "%s %s speed %sUSB device using %s and address %d\n",
2707 (udev->config) ? "reset" : "new", speed, type,
2708 udev->bus->controller->driver->name, devnum);
2710 /* Set up TT records, if needed */
2712 udev->tt = hdev->tt;
2713 udev->ttport = hdev->ttport;
2714 } else if (udev->speed != USB_SPEED_HIGH
2715 && hdev->speed == USB_SPEED_HIGH) {
2717 dev_err(&udev->dev, "parent hub has no TT\n");
2721 udev->tt = &hub->tt;
2722 udev->ttport = port1;
2725 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2726 * Because device hardware and firmware is sometimes buggy in
2727 * this area, and this is how Linux has done it for ages.
2728 * Change it cautiously.
2730 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2731 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2732 * so it may help with some non-standards-compliant devices.
2733 * Otherwise we start with SET_ADDRESS and then try to read the
2734 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2737 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
2739 * An xHCI controller cannot send any packets to a device until
2740 * a set address command successfully completes.
2742 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3)) {
2743 struct usb_device_descriptor *buf;
2746 #define GET_DESCRIPTOR_BUFSIZE 64
2747 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2753 /* Retry on all errors; some devices are flakey.
2754 * 255 is for WUSB devices, we actually need to use
2755 * 512 (WUSB1.0[4.8.1]).
2757 for (j = 0; j < 3; ++j) {
2758 buf->bMaxPacketSize0 = 0;
2759 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2760 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2761 USB_DT_DEVICE << 8, 0,
2762 buf, GET_DESCRIPTOR_BUFSIZE,
2763 initial_descriptor_timeout);
2764 switch (buf->bMaxPacketSize0) {
2765 case 8: case 16: case 32: case 64: case 255:
2766 if (buf->bDescriptorType ==
2780 udev->descriptor.bMaxPacketSize0 =
2781 buf->bMaxPacketSize0;
2784 retval = hub_port_reset(hub, port1, udev, delay);
2785 if (retval < 0) /* error or disconnect */
2787 if (oldspeed != udev->speed) {
2789 "device reset changed speed!\n");
2795 "device descriptor read/64, error %d\n",
2800 #undef GET_DESCRIPTOR_BUFSIZE
2804 * If device is WUSB, we already assigned an
2805 * unauthorized address in the Connect Ack sequence;
2806 * authorization will assign the final address.
2808 if (udev->wusb == 0) {
2809 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
2810 retval = hub_set_address(udev, devnum);
2817 "device not accepting address %d, error %d\n",
2821 if (udev->speed == USB_SPEED_SUPER) {
2822 devnum = udev->devnum;
2823 dev_info(&udev->dev,
2824 "%s SuperSpeed USB device using %s and address %d\n",
2825 (udev->config) ? "reset" : "new",
2826 udev->bus->controller->driver->name, devnum);
2829 /* cope with hardware quirkiness:
2830 * - let SET_ADDRESS settle, some device hardware wants it
2831 * - read ep0 maxpacket even for high and low speed,
2834 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3))
2838 retval = usb_get_device_descriptor(udev, 8);
2841 "device descriptor read/8, error %d\n",
2853 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
2854 udev->speed == USB_SPEED_SUPER)
2857 i = udev->descriptor.bMaxPacketSize0;
2858 if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
2859 if (udev->speed == USB_SPEED_LOW ||
2860 !(i == 8 || i == 16 || i == 32 || i == 64)) {
2861 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
2865 if (udev->speed == USB_SPEED_FULL)
2866 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
2868 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
2869 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
2870 usb_ep0_reinit(udev);
2873 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
2874 if (retval < (signed)sizeof(udev->descriptor)) {
2875 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
2886 hub_port_disable(hub, port1, 0);
2887 update_address(udev, devnum); /* for disconnect processing */
2889 mutex_unlock(&usb_address0_mutex);
2894 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
2896 struct usb_qualifier_descriptor *qual;
2899 qual = kmalloc (sizeof *qual, GFP_KERNEL);
2903 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
2904 qual, sizeof *qual);
2905 if (status == sizeof *qual) {
2906 dev_info(&udev->dev, "not running at top speed; "
2907 "connect to a high speed hub\n");
2908 /* hub LEDs are probably harder to miss than syslog */
2909 if (hub->has_indicators) {
2910 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
2911 schedule_delayed_work (&hub->leds, 0);
2918 hub_power_remaining (struct usb_hub *hub)
2920 struct usb_device *hdev = hub->hdev;
2924 if (!hub->limited_power)
2927 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
2928 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
2929 struct usb_device *udev = hdev->children[port1 - 1];
2935 /* Unconfigured devices may not use more than 100mA,
2936 * or 8mA for OTG ports */
2937 if (udev->actconfig)
2938 delta = udev->actconfig->desc.bMaxPower * 2;
2939 else if (port1 != udev->bus->otg_port || hdev->parent)
2943 if (delta > hub->mA_per_port)
2944 dev_warn(&udev->dev,
2945 "%dmA is over %umA budget for port %d!\n",
2946 delta, hub->mA_per_port, port1);
2949 if (remaining < 0) {
2950 dev_warn(hub->intfdev, "%dmA over power budget!\n",
2957 /* Handle physical or logical connection change events.
2958 * This routine is called when:
2959 * a port connection-change occurs;
2960 * a port enable-change occurs (often caused by EMI);
2961 * usb_reset_and_verify_device() encounters changed descriptors (as from
2962 * a firmware download)
2963 * caller already locked the hub
2965 static void hub_port_connect_change(struct usb_hub *hub, int port1,
2966 u16 portstatus, u16 portchange)
2968 struct usb_device *hdev = hub->hdev;
2969 struct device *hub_dev = hub->intfdev;
2970 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
2971 unsigned wHubCharacteristics =
2972 le16_to_cpu(hub->descriptor->wHubCharacteristics);
2973 struct usb_device *udev;
2977 "port %d, status %04x, change %04x, %s\n",
2978 port1, portstatus, portchange, portspeed (portstatus));
2980 if (hub->has_indicators) {
2981 set_port_led(hub, port1, HUB_LED_AUTO);
2982 hub->indicator[port1-1] = INDICATOR_AUTO;
2985 #ifdef CONFIG_USB_OTG
2986 /* during HNP, don't repeat the debounce */
2987 if (hdev->bus->is_b_host)
2988 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
2989 USB_PORT_STAT_C_ENABLE);
2992 /* Try to resuscitate an existing device */
2993 udev = hdev->children[port1-1];
2994 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
2995 udev->state != USB_STATE_NOTATTACHED) {
2996 usb_lock_device(udev);
2997 if (portstatus & USB_PORT_STAT_ENABLE) {
2998 status = 0; /* Nothing to do */
3000 #ifdef CONFIG_USB_SUSPEND
3001 } else if (udev->state == USB_STATE_SUSPENDED &&
3002 udev->persist_enabled) {
3003 /* For a suspended device, treat this as a
3004 * remote wakeup event.
3006 status = remote_wakeup(udev);
3010 status = -ENODEV; /* Don't resuscitate */
3012 usb_unlock_device(udev);
3015 clear_bit(port1, hub->change_bits);
3020 /* Disconnect any existing devices under this port */
3022 usb_disconnect(&hdev->children[port1-1]);
3023 clear_bit(port1, hub->change_bits);
3025 if (portchange & (USB_PORT_STAT_C_CONNECTION |
3026 USB_PORT_STAT_C_ENABLE)) {
3027 status = hub_port_debounce(hub, port1);
3029 if (printk_ratelimit())
3030 dev_err(hub_dev, "connect-debounce failed, "
3031 "port %d disabled\n", port1);
3032 portstatus &= ~USB_PORT_STAT_CONNECTION;
3034 portstatus = status;
3038 /* Return now if debouncing failed or nothing is connected */
3039 if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
3041 /* maybe switch power back on (e.g. root hub was reset) */
3042 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
3043 && !(portstatus & (1 << USB_PORT_FEAT_POWER)))
3044 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
3046 if (portstatus & USB_PORT_STAT_ENABLE)
3051 for (i = 0; i < SET_CONFIG_TRIES; i++) {
3053 /* reallocate for each attempt, since references
3054 * to the previous one can escape in various ways
3056 udev = usb_alloc_dev(hdev, hdev->bus, port1);
3059 "couldn't allocate port %d usb_device\n",
3064 usb_set_device_state(udev, USB_STATE_POWERED);
3065 udev->bus_mA = hub->mA_per_port;
3066 udev->level = hdev->level + 1;
3067 udev->wusb = hub_is_wusb(hub);
3070 * USB 3.0 devices are reset automatically before the connect
3071 * port status change appears, and the root hub port status
3072 * shows the correct speed. We also get port change
3073 * notifications for USB 3.0 devices from the USB 3.0 portion of
3074 * an external USB 3.0 hub, but this isn't handled correctly yet
3078 if (!(hcd->driver->flags & HCD_USB3))
3079 udev->speed = USB_SPEED_UNKNOWN;
3080 else if ((hdev->parent == NULL) &&
3081 (portstatus & (1 << USB_PORT_FEAT_SUPERSPEED)))
3082 udev->speed = USB_SPEED_SUPER;
3084 udev->speed = USB_SPEED_UNKNOWN;
3087 * xHCI needs to issue an address device command later
3088 * in the hub_port_init sequence for SS/HS/FS/LS devices.
3090 if (!(hcd->driver->flags & HCD_USB3)) {
3091 /* set the address */
3092 choose_address(udev);
3093 if (udev->devnum <= 0) {
3094 status = -ENOTCONN; /* Don't retry */
3099 /* reset (non-USB 3.0 devices) and get descriptor */
3100 status = hub_port_init(hub, udev, port1, i);
3104 usb_detect_quirks(udev);
3105 if (udev->quirks & USB_QUIRK_DELAY_INIT)
3108 /* consecutive bus-powered hubs aren't reliable; they can
3109 * violate the voltage drop budget. if the new child has
3110 * a "powered" LED, users should notice we didn't enable it
3111 * (without reading syslog), even without per-port LEDs
3114 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
3115 && udev->bus_mA <= 100) {
3118 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
3121 dev_dbg(&udev->dev, "get status %d ?\n", status);
3124 le16_to_cpus(&devstat);
3125 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
3127 "can't connect bus-powered hub "
3129 if (hub->has_indicators) {
3130 hub->indicator[port1-1] =
3131 INDICATOR_AMBER_BLINK;
3132 schedule_delayed_work (&hub->leds, 0);
3134 status = -ENOTCONN; /* Don't retry */
3139 /* check for devices running slower than they could */
3140 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
3141 && udev->speed == USB_SPEED_FULL
3142 && highspeed_hubs != 0)
3143 check_highspeed (hub, udev, port1);
3145 /* Store the parent's children[] pointer. At this point
3146 * udev becomes globally accessible, although presumably
3147 * no one will look at it until hdev is unlocked.
3151 /* We mustn't add new devices if the parent hub has
3152 * been disconnected; we would race with the
3153 * recursively_mark_NOTATTACHED() routine.
3155 spin_lock_irq(&device_state_lock);
3156 if (hdev->state == USB_STATE_NOTATTACHED)
3159 hdev->children[port1-1] = udev;
3160 spin_unlock_irq(&device_state_lock);
3162 /* Run it through the hoops (find a driver, etc) */
3164 status = usb_new_device(udev);
3166 spin_lock_irq(&device_state_lock);
3167 hdev->children[port1-1] = NULL;
3168 spin_unlock_irq(&device_state_lock);
3175 status = hub_power_remaining(hub);
3177 dev_dbg(hub_dev, "%dmA power budget left\n", status);
3182 hub_port_disable(hub, port1, 1);
3184 usb_ep0_reinit(udev);
3185 release_address(udev);
3188 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
3191 if (hub->hdev->parent ||
3192 !hcd->driver->port_handed_over ||
3193 !(hcd->driver->port_handed_over)(hcd, port1))
3194 dev_err(hub_dev, "unable to enumerate USB device on port %d\n",
3198 hub_port_disable(hub, port1, 1);
3199 if (hcd->driver->relinquish_port && !hub->hdev->parent)
3200 hcd->driver->relinquish_port(hcd, port1);
3203 static void hub_events(void)
3205 struct list_head *tmp;
3206 struct usb_device *hdev;
3207 struct usb_interface *intf;
3208 struct usb_hub *hub;
3209 struct device *hub_dev;
3218 * We restart the list every time to avoid a deadlock with
3219 * deleting hubs downstream from this one. This should be
3220 * safe since we delete the hub from the event list.
3221 * Not the most efficient, but avoids deadlocks.
3225 /* Grab the first entry at the beginning of the list */
3226 spin_lock_irq(&hub_event_lock);
3227 if (list_empty(&hub_event_list)) {
3228 spin_unlock_irq(&hub_event_lock);
3232 tmp = hub_event_list.next;
3235 hub = list_entry(tmp, struct usb_hub, event_list);
3236 kref_get(&hub->kref);
3237 spin_unlock_irq(&hub_event_lock);
3240 hub_dev = hub->intfdev;
3241 intf = to_usb_interface(hub_dev);
3242 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
3243 hdev->state, hub->descriptor
3244 ? hub->descriptor->bNbrPorts
3246 /* NOTE: expects max 15 ports... */
3247 (u16) hub->change_bits[0],
3248 (u16) hub->event_bits[0]);
3250 /* Lock the device, then check to see if we were
3251 * disconnected while waiting for the lock to succeed. */
3252 usb_lock_device(hdev);
3253 if (unlikely(hub->disconnected))
3256 /* If the hub has died, clean up after it */
3257 if (hdev->state == USB_STATE_NOTATTACHED) {
3258 hub->error = -ENODEV;
3259 hub_quiesce(hub, HUB_DISCONNECT);
3264 ret = usb_autopm_get_interface(intf);
3266 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
3270 /* If this is an inactive hub, do nothing */
3275 dev_dbg (hub_dev, "resetting for error %d\n",
3278 ret = usb_reset_device(hdev);
3281 "error resetting hub: %d\n", ret);
3289 /* deal with port status changes */
3290 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
3291 if (test_bit(i, hub->busy_bits))
3293 connect_change = test_bit(i, hub->change_bits);
3294 if (!test_and_clear_bit(i, hub->event_bits) &&
3298 ret = hub_port_status(hub, i,
3299 &portstatus, &portchange);
3303 if (portchange & USB_PORT_STAT_C_CONNECTION) {
3304 clear_port_feature(hdev, i,
3305 USB_PORT_FEAT_C_CONNECTION);
3309 if (portchange & USB_PORT_STAT_C_ENABLE) {
3310 if (!connect_change)
3312 "port %d enable change, "
3315 clear_port_feature(hdev, i,
3316 USB_PORT_FEAT_C_ENABLE);
3319 * EM interference sometimes causes badly
3320 * shielded USB devices to be shutdown by
3321 * the hub, this hack enables them again.
3322 * Works at least with mouse driver.
3324 if (!(portstatus & USB_PORT_STAT_ENABLE)
3326 && hdev->children[i-1]) {
3329 "disabled by hub (EMI?), "
3336 if (portchange & USB_PORT_STAT_C_SUSPEND) {
3337 struct usb_device *udev;
3339 clear_port_feature(hdev, i,
3340 USB_PORT_FEAT_C_SUSPEND);
3341 udev = hdev->children[i-1];
3343 /* TRSMRCY = 10 msec */
3346 usb_lock_device(udev);
3347 ret = remote_wakeup(hdev->
3349 usb_unlock_device(udev);
3354 hub_port_disable(hub, i, 1);
3357 "resume on port %d, status %d\n",
3361 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
3363 "over-current change on port %d\n",
3365 clear_port_feature(hdev, i,
3366 USB_PORT_FEAT_C_OVER_CURRENT);
3367 hub_power_on(hub, true);
3370 if (portchange & USB_PORT_STAT_C_RESET) {
3372 "reset change on port %d\n",
3374 clear_port_feature(hdev, i,
3375 USB_PORT_FEAT_C_RESET);
3379 hub_port_connect_change(hub, i,
3380 portstatus, portchange);
3383 /* deal with hub status changes */
3384 if (test_and_clear_bit(0, hub->event_bits) == 0)
3386 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
3387 dev_err (hub_dev, "get_hub_status failed\n");
3389 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
3390 dev_dbg (hub_dev, "power change\n");
3391 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
3392 if (hubstatus & HUB_STATUS_LOCAL_POWER)
3393 /* FIXME: Is this always true? */
3394 hub->limited_power = 1;
3396 hub->limited_power = 0;
3398 if (hubchange & HUB_CHANGE_OVERCURRENT) {
3399 dev_dbg (hub_dev, "overcurrent change\n");
3400 msleep(500); /* Cool down */
3401 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
3402 hub_power_on(hub, true);
3407 /* Allow autosuspend if we're not going to run again */
3408 if (list_empty(&hub->event_list))
3409 usb_autopm_enable(intf);
3411 usb_unlock_device(hdev);
3412 kref_put(&hub->kref, hub_release);
3414 } /* end while (1) */
3417 static int hub_thread(void *__unused)
3419 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
3420 * port handover. Otherwise it might see that a full-speed device
3421 * was gone before the EHCI controller had handed its port over to
3422 * the companion full-speed controller.
3428 wait_event_freezable(khubd_wait,
3429 !list_empty(&hub_event_list) ||
3430 kthread_should_stop());
3431 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
3433 pr_debug("%s: khubd exiting\n", usbcore_name);
3437 static struct usb_device_id hub_id_table [] = {
3438 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
3439 .bDeviceClass = USB_CLASS_HUB},
3440 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
3441 .bInterfaceClass = USB_CLASS_HUB},
3442 { } /* Terminating entry */
3445 MODULE_DEVICE_TABLE (usb, hub_id_table);
3447 static struct usb_driver hub_driver = {
3450 .disconnect = hub_disconnect,
3451 .suspend = hub_suspend,
3452 .resume = hub_resume,
3453 .reset_resume = hub_reset_resume,
3454 .pre_reset = hub_pre_reset,
3455 .post_reset = hub_post_reset,
3457 .id_table = hub_id_table,
3458 .supports_autosuspend = 1,
3461 int usb_hub_init(void)
3463 if (usb_register(&hub_driver) < 0) {
3464 printk(KERN_ERR "%s: can't register hub driver\n",
3469 khubd_task = kthread_run(hub_thread, NULL, "khubd");
3470 if (!IS_ERR(khubd_task))
3473 /* Fall through if kernel_thread failed */
3474 usb_deregister(&hub_driver);
3475 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
3480 void usb_hub_cleanup(void)
3482 kthread_stop(khubd_task);
3485 * Hub resources are freed for us by usb_deregister. It calls
3486 * usb_driver_purge on every device which in turn calls that
3487 * devices disconnect function if it is using this driver.
3488 * The hub_disconnect function takes care of releasing the
3489 * individual hub resources. -greg
3491 usb_deregister(&hub_driver);
3492 } /* usb_hub_cleanup() */
3494 static int descriptors_changed(struct usb_device *udev,
3495 struct usb_device_descriptor *old_device_descriptor)
3499 unsigned serial_len = 0;
3501 unsigned old_length;
3505 if (memcmp(&udev->descriptor, old_device_descriptor,
3506 sizeof(*old_device_descriptor)) != 0)
3509 /* Since the idVendor, idProduct, and bcdDevice values in the
3510 * device descriptor haven't changed, we will assume the
3511 * Manufacturer and Product strings haven't changed either.
3512 * But the SerialNumber string could be different (e.g., a
3513 * different flash card of the same brand).
3516 serial_len = strlen(udev->serial) + 1;
3519 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3520 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3521 len = max(len, old_length);
3524 buf = kmalloc(len, GFP_NOIO);
3526 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
3527 /* assume the worst */
3530 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3531 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3532 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
3534 if (length != old_length) {
3535 dev_dbg(&udev->dev, "config index %d, error %d\n",
3540 if (memcmp (buf, udev->rawdescriptors[index], old_length)
3542 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
3544 ((struct usb_config_descriptor *) buf)->
3545 bConfigurationValue);
3551 if (!changed && serial_len) {
3552 length = usb_string(udev, udev->descriptor.iSerialNumber,
3554 if (length + 1 != serial_len) {
3555 dev_dbg(&udev->dev, "serial string error %d\n",
3558 } else if (memcmp(buf, udev->serial, length) != 0) {
3559 dev_dbg(&udev->dev, "serial string changed\n");
3569 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
3570 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3572 * WARNING - don't use this routine to reset a composite device
3573 * (one with multiple interfaces owned by separate drivers)!
3574 * Use usb_reset_device() instead.
3576 * Do a port reset, reassign the device's address, and establish its
3577 * former operating configuration. If the reset fails, or the device's
3578 * descriptors change from their values before the reset, or the original
3579 * configuration and altsettings cannot be restored, a flag will be set
3580 * telling khubd to pretend the device has been disconnected and then
3581 * re-connected. All drivers will be unbound, and the device will be
3582 * re-enumerated and probed all over again.
3584 * Returns 0 if the reset succeeded, -ENODEV if the device has been
3585 * flagged for logical disconnection, or some other negative error code
3586 * if the reset wasn't even attempted.
3588 * The caller must own the device lock. For example, it's safe to use
3589 * this from a driver probe() routine after downloading new firmware.
3590 * For calls that might not occur during probe(), drivers should lock
3591 * the device using usb_lock_device_for_reset().
3593 * Locking exception: This routine may also be called from within an
3594 * autoresume handler. Such usage won't conflict with other tasks
3595 * holding the device lock because these tasks should always call
3596 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
3598 static int usb_reset_and_verify_device(struct usb_device *udev)
3600 struct usb_device *parent_hdev = udev->parent;
3601 struct usb_hub *parent_hub;
3602 struct usb_device_descriptor descriptor = udev->descriptor;
3604 int port1 = udev->portnum;
3606 if (udev->state == USB_STATE_NOTATTACHED ||
3607 udev->state == USB_STATE_SUSPENDED) {
3608 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3614 /* this requires hcd-specific logic; see OHCI hc_restart() */
3615 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
3618 parent_hub = hdev_to_hub(parent_hdev);
3620 set_bit(port1, parent_hub->busy_bits);
3621 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
3623 /* ep0 maxpacket size may change; let the HCD know about it.
3624 * Other endpoints will be handled by re-enumeration. */
3625 usb_ep0_reinit(udev);
3626 ret = hub_port_init(parent_hub, udev, port1, i);
3627 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
3630 clear_bit(port1, parent_hub->busy_bits);
3635 /* Device might have changed firmware (DFU or similar) */
3636 if (descriptors_changed(udev, &descriptor)) {
3637 dev_info(&udev->dev, "device firmware changed\n");
3638 udev->descriptor = descriptor; /* for disconnect() calls */
3642 /* Restore the device's previous configuration */
3643 if (!udev->actconfig)
3645 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3646 USB_REQ_SET_CONFIGURATION, 0,
3647 udev->actconfig->desc.bConfigurationValue, 0,
3648 NULL, 0, USB_CTRL_SET_TIMEOUT);
3651 "can't restore configuration #%d (error=%d)\n",
3652 udev->actconfig->desc.bConfigurationValue, ret);
3655 usb_set_device_state(udev, USB_STATE_CONFIGURED);
3657 /* Put interfaces back into the same altsettings as before.
3658 * Don't bother to send the Set-Interface request for interfaces
3659 * that were already in altsetting 0; besides being unnecessary,
3660 * many devices can't handle it. Instead just reset the host-side
3663 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
3664 struct usb_interface *intf = udev->actconfig->interface[i];
3665 struct usb_interface_descriptor *desc;
3667 desc = &intf->cur_altsetting->desc;
3668 if (desc->bAlternateSetting == 0) {
3669 usb_disable_interface(udev, intf, true);
3670 usb_enable_interface(udev, intf, true);
3673 ret = usb_set_interface(udev, desc->bInterfaceNumber,
3674 desc->bAlternateSetting);
3677 dev_err(&udev->dev, "failed to restore interface %d "
3678 "altsetting %d (error=%d)\n",
3679 desc->bInterfaceNumber,
3680 desc->bAlternateSetting,
3690 hub_port_logical_disconnect(parent_hub, port1);
3695 * usb_reset_device - warn interface drivers and perform a USB port reset
3696 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3698 * Warns all drivers bound to registered interfaces (using their pre_reset
3699 * method), performs the port reset, and then lets the drivers know that
3700 * the reset is over (using their post_reset method).
3702 * Return value is the same as for usb_reset_and_verify_device().
3704 * The caller must own the device lock. For example, it's safe to use
3705 * this from a driver probe() routine after downloading new firmware.
3706 * For calls that might not occur during probe(), drivers should lock
3707 * the device using usb_lock_device_for_reset().
3709 * If an interface is currently being probed or disconnected, we assume
3710 * its driver knows how to handle resets. For all other interfaces,
3711 * if the driver doesn't have pre_reset and post_reset methods then
3712 * we attempt to unbind it and rebind afterward.
3714 int usb_reset_device(struct usb_device *udev)
3718 struct usb_host_config *config = udev->actconfig;
3720 if (udev->state == USB_STATE_NOTATTACHED ||
3721 udev->state == USB_STATE_SUSPENDED) {
3722 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3727 /* Prevent autosuspend during the reset */
3728 usb_autoresume_device(udev);
3731 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
3732 struct usb_interface *cintf = config->interface[i];
3733 struct usb_driver *drv;
3736 if (cintf->dev.driver) {
3737 drv = to_usb_driver(cintf->dev.driver);
3738 if (drv->pre_reset && drv->post_reset)
3739 unbind = (drv->pre_reset)(cintf);
3740 else if (cintf->condition ==
3741 USB_INTERFACE_BOUND)
3744 usb_forced_unbind_intf(cintf);
3749 ret = usb_reset_and_verify_device(udev);
3752 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
3753 struct usb_interface *cintf = config->interface[i];
3754 struct usb_driver *drv;
3755 int rebind = cintf->needs_binding;
3757 if (!rebind && cintf->dev.driver) {
3758 drv = to_usb_driver(cintf->dev.driver);
3759 if (drv->post_reset)
3760 rebind = (drv->post_reset)(cintf);
3761 else if (cintf->condition ==
3762 USB_INTERFACE_BOUND)
3765 if (ret == 0 && rebind)
3766 usb_rebind_intf(cintf);
3770 usb_autosuspend_device(udev);
3773 EXPORT_SYMBOL_GPL(usb_reset_device);
3777 * usb_queue_reset_device - Reset a USB device from an atomic context
3778 * @iface: USB interface belonging to the device to reset
3780 * This function can be used to reset a USB device from an atomic
3781 * context, where usb_reset_device() won't work (as it blocks).
3783 * Doing a reset via this method is functionally equivalent to calling
3784 * usb_reset_device(), except for the fact that it is delayed to a
3785 * workqueue. This means that any drivers bound to other interfaces
3786 * might be unbound, as well as users from usbfs in user space.
3790 * - Scheduling two resets at the same time from two different drivers
3791 * attached to two different interfaces of the same device is
3792 * possible; depending on how the driver attached to each interface
3793 * handles ->pre_reset(), the second reset might happen or not.
3795 * - If a driver is unbound and it had a pending reset, the reset will
3798 * - This function can be called during .probe() or .disconnect()
3799 * times. On return from .disconnect(), any pending resets will be
3802 * There is no no need to lock/unlock the @reset_ws as schedule_work()
3805 * NOTE: We don't do any reference count tracking because it is not
3806 * needed. The lifecycle of the work_struct is tied to the
3807 * usb_interface. Before destroying the interface we cancel the
3808 * work_struct, so the fact that work_struct is queued and or
3809 * running means the interface (and thus, the device) exist and
3812 void usb_queue_reset_device(struct usb_interface *iface)
3814 schedule_work(&iface->reset_ws);
3816 EXPORT_SYMBOL_GPL(usb_queue_reset_device);