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 && status == -ETIMEDOUT; i++) {
330 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
331 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
332 data, sizeof(*data), USB_STS_TIMEOUT);
338 * USB 2.0 spec Section 11.24.2.7
340 static int get_port_status(struct usb_device *hdev, int port1,
341 struct usb_port_status *data)
343 int i, status = -ETIMEDOUT;
345 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
346 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
347 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
348 data, sizeof(*data), USB_STS_TIMEOUT);
353 static int hub_port_status(struct usb_hub *hub, int port1,
354 u16 *status, u16 *change)
358 mutex_lock(&hub->status_mutex);
359 ret = get_port_status(hub->hdev, port1, &hub->status->port);
361 dev_err(hub->intfdev,
362 "%s failed (err = %d)\n", __func__, ret);
366 *status = le16_to_cpu(hub->status->port.wPortStatus);
367 *change = le16_to_cpu(hub->status->port.wPortChange);
370 mutex_unlock(&hub->status_mutex);
374 static void kick_khubd(struct usb_hub *hub)
378 /* Suppress autosuspend until khubd runs */
379 atomic_set(&to_usb_interface(hub->intfdev)->pm_usage_cnt, 1);
381 spin_lock_irqsave(&hub_event_lock, flags);
382 if (!hub->disconnected && list_empty(&hub->event_list)) {
383 list_add_tail(&hub->event_list, &hub_event_list);
384 wake_up(&khubd_wait);
386 spin_unlock_irqrestore(&hub_event_lock, flags);
389 void usb_kick_khubd(struct usb_device *hdev)
391 struct usb_hub *hub = hdev_to_hub(hdev);
398 /* completion function, fires on port status changes and various faults */
399 static void hub_irq(struct urb *urb)
401 struct usb_hub *hub = urb->context;
402 int status = urb->status;
407 case -ENOENT: /* synchronous unlink */
408 case -ECONNRESET: /* async unlink */
409 case -ESHUTDOWN: /* hardware going away */
412 default: /* presumably an error */
413 /* Cause a hub reset after 10 consecutive errors */
414 dev_dbg (hub->intfdev, "transfer --> %d\n", status);
415 if ((++hub->nerrors < 10) || hub->error)
420 /* let khubd handle things */
421 case 0: /* we got data: port status changed */
423 for (i = 0; i < urb->actual_length; ++i)
424 bits |= ((unsigned long) ((*hub->buffer)[i]))
426 hub->event_bits[0] = bits;
432 /* Something happened, let khubd figure it out */
439 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
440 && status != -ENODEV && status != -EPERM)
441 dev_err (hub->intfdev, "resubmit --> %d\n", status);
444 /* USB 2.0 spec Section 11.24.2.3 */
446 hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
448 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
449 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
454 * enumeration blocks khubd for a long time. we use keventd instead, since
455 * long blocking there is the exception, not the rule. accordingly, HCDs
456 * talking to TTs must queue control transfers (not just bulk and iso), so
457 * both can talk to the same hub concurrently.
459 static void hub_tt_work(struct work_struct *work)
461 struct usb_hub *hub =
462 container_of(work, struct usb_hub, tt.clear_work);
466 spin_lock_irqsave (&hub->tt.lock, flags);
467 while (--limit && !list_empty (&hub->tt.clear_list)) {
468 struct list_head *next;
469 struct usb_tt_clear *clear;
470 struct usb_device *hdev = hub->hdev;
471 const struct hc_driver *drv;
474 next = hub->tt.clear_list.next;
475 clear = list_entry (next, struct usb_tt_clear, clear_list);
476 list_del (&clear->clear_list);
478 /* drop lock so HCD can concurrently report other TT errors */
479 spin_unlock_irqrestore (&hub->tt.lock, flags);
480 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
483 "clear tt %d (%04x) error %d\n",
484 clear->tt, clear->devinfo, status);
486 /* Tell the HCD, even if the operation failed */
487 drv = clear->hcd->driver;
488 if (drv->clear_tt_buffer_complete)
489 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
492 spin_lock_irqsave(&hub->tt.lock, flags);
494 spin_unlock_irqrestore (&hub->tt.lock, flags);
498 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
499 * @urb: an URB associated with the failed or incomplete split transaction
501 * High speed HCDs use this to tell the hub driver that some split control or
502 * bulk transaction failed in a way that requires clearing internal state of
503 * a transaction translator. This is normally detected (and reported) from
506 * It may not be possible for that hub to handle additional full (or low)
507 * speed transactions until that state is fully cleared out.
509 int usb_hub_clear_tt_buffer(struct urb *urb)
511 struct usb_device *udev = urb->dev;
512 int pipe = urb->pipe;
513 struct usb_tt *tt = udev->tt;
515 struct usb_tt_clear *clear;
517 /* we've got to cope with an arbitrary number of pending TT clears,
518 * since each TT has "at least two" buffers that can need it (and
519 * there can be many TTs per hub). even if they're uncommon.
521 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
522 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
523 /* FIXME recover somehow ... RESET_TT? */
527 /* info that CLEAR_TT_BUFFER needs */
528 clear->tt = tt->multi ? udev->ttport : 1;
529 clear->devinfo = usb_pipeendpoint (pipe);
530 clear->devinfo |= udev->devnum << 4;
531 clear->devinfo |= usb_pipecontrol (pipe)
532 ? (USB_ENDPOINT_XFER_CONTROL << 11)
533 : (USB_ENDPOINT_XFER_BULK << 11);
534 if (usb_pipein (pipe))
535 clear->devinfo |= 1 << 15;
537 /* info for completion callback */
538 clear->hcd = bus_to_hcd(udev->bus);
541 /* tell keventd to clear state for this TT */
542 spin_lock_irqsave (&tt->lock, flags);
543 list_add_tail (&clear->clear_list, &tt->clear_list);
544 schedule_work(&tt->clear_work);
545 spin_unlock_irqrestore (&tt->lock, flags);
548 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
550 /* If do_delay is false, return the number of milliseconds the caller
553 static unsigned hub_power_on(struct usb_hub *hub, bool do_delay)
556 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
558 u16 wHubCharacteristics =
559 le16_to_cpu(hub->descriptor->wHubCharacteristics);
561 /* Enable power on each port. Some hubs have reserved values
562 * of LPSM (> 2) in their descriptors, even though they are
563 * USB 2.0 hubs. Some hubs do not implement port-power switching
564 * but only emulate it. In all cases, the ports won't work
565 * unless we send these messages to the hub.
567 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
568 dev_dbg(hub->intfdev, "enabling power on all ports\n");
570 dev_dbg(hub->intfdev, "trying to enable port power on "
571 "non-switchable hub\n");
572 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
573 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
575 /* Wait at least 100 msec for power to become stable */
576 delay = max(pgood_delay, (unsigned) 100);
582 static int hub_hub_status(struct usb_hub *hub,
583 u16 *status, u16 *change)
587 mutex_lock(&hub->status_mutex);
588 ret = get_hub_status(hub->hdev, &hub->status->hub);
590 dev_err (hub->intfdev,
591 "%s failed (err = %d)\n", __func__, ret);
593 *status = le16_to_cpu(hub->status->hub.wHubStatus);
594 *change = le16_to_cpu(hub->status->hub.wHubChange);
597 mutex_unlock(&hub->status_mutex);
601 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
603 struct usb_device *hdev = hub->hdev;
606 if (hdev->children[port1-1] && set_state)
607 usb_set_device_state(hdev->children[port1-1],
608 USB_STATE_NOTATTACHED);
610 ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
612 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
618 * Disable a port and mark a logical connnect-change event, so that some
619 * time later khubd will disconnect() any existing usb_device on the port
620 * and will re-enumerate if there actually is a device attached.
622 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
624 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
625 hub_port_disable(hub, port1, 1);
627 /* FIXME let caller ask to power down the port:
628 * - some devices won't enumerate without a VBUS power cycle
629 * - SRP saves power that way
630 * - ... new call, TBD ...
631 * That's easy if this hub can switch power per-port, and
632 * khubd reactivates the port later (timer, SRP, etc).
633 * Powerdown must be optional, because of reset/DFU.
636 set_bit(port1, hub->change_bits);
640 enum hub_activation_type {
641 HUB_INIT, HUB_INIT2, HUB_INIT3,
642 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
645 static void hub_init_func2(struct work_struct *ws);
646 static void hub_init_func3(struct work_struct *ws);
648 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
650 struct usb_device *hdev = hub->hdev;
653 bool need_debounce_delay = false;
656 /* Continue a partial initialization */
657 if (type == HUB_INIT2)
659 if (type == HUB_INIT3)
662 /* After a resume, port power should still be on.
663 * For any other type of activation, turn it on.
665 if (type != HUB_RESUME) {
667 /* Speed up system boot by using a delayed_work for the
668 * hub's initial power-up delays. This is pretty awkward
669 * and the implementation looks like a home-brewed sort of
670 * setjmp/longjmp, but it saves at least 100 ms for each
671 * root hub (assuming usbcore is compiled into the kernel
672 * rather than as a module). It adds up.
674 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
675 * because for those activation types the ports have to be
676 * operational when we return. In theory this could be done
677 * for HUB_POST_RESET, but it's easier not to.
679 if (type == HUB_INIT) {
680 delay = hub_power_on(hub, false);
681 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func2);
682 schedule_delayed_work(&hub->init_work,
683 msecs_to_jiffies(delay));
685 /* Suppress autosuspend until init is done */
686 atomic_set(&to_usb_interface(hub->intfdev)->
688 return; /* Continues at init2: below */
690 hub_power_on(hub, true);
695 /* Check each port and set hub->change_bits to let khubd know
696 * which ports need attention.
698 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
699 struct usb_device *udev = hdev->children[port1-1];
700 u16 portstatus, portchange;
702 portstatus = portchange = 0;
703 status = hub_port_status(hub, port1, &portstatus, &portchange);
704 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
705 dev_dbg(hub->intfdev,
706 "port %d: status %04x change %04x\n",
707 port1, portstatus, portchange);
709 /* After anything other than HUB_RESUME (i.e., initialization
710 * or any sort of reset), every port should be disabled.
711 * Unconnected ports should likewise be disabled (paranoia),
712 * and so should ports for which we have no usb_device.
714 if ((portstatus & USB_PORT_STAT_ENABLE) && (
715 type != HUB_RESUME ||
716 !(portstatus & USB_PORT_STAT_CONNECTION) ||
718 udev->state == USB_STATE_NOTATTACHED)) {
719 clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
720 portstatus &= ~USB_PORT_STAT_ENABLE;
723 /* Clear status-change flags; we'll debounce later */
724 if (portchange & USB_PORT_STAT_C_CONNECTION) {
725 need_debounce_delay = true;
726 clear_port_feature(hub->hdev, port1,
727 USB_PORT_FEAT_C_CONNECTION);
729 if (portchange & USB_PORT_STAT_C_ENABLE) {
730 need_debounce_delay = true;
731 clear_port_feature(hub->hdev, port1,
732 USB_PORT_FEAT_C_ENABLE);
735 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
736 /* Tell khubd to disconnect the device or
737 * check for a new connection
739 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
740 set_bit(port1, hub->change_bits);
742 } else if (portstatus & USB_PORT_STAT_ENABLE) {
743 /* The power session apparently survived the resume.
744 * If there was an overcurrent or suspend change
745 * (i.e., remote wakeup request), have khubd
749 set_bit(port1, hub->change_bits);
751 } else if (udev->persist_enabled) {
753 udev->reset_resume = 1;
755 set_bit(port1, hub->change_bits);
758 /* The power session is gone; tell khubd */
759 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
760 set_bit(port1, hub->change_bits);
764 /* If no port-status-change flags were set, we don't need any
765 * debouncing. If flags were set we can try to debounce the
766 * ports all at once right now, instead of letting khubd do them
767 * one at a time later on.
769 * If any port-status changes do occur during this delay, khubd
770 * will see them later and handle them normally.
772 if (need_debounce_delay) {
773 delay = HUB_DEBOUNCE_STABLE;
775 /* Don't do a long sleep inside a workqueue routine */
776 if (type == HUB_INIT2) {
777 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func3);
778 schedule_delayed_work(&hub->init_work,
779 msecs_to_jiffies(delay));
780 return; /* Continues at init3: below */
788 status = usb_submit_urb(hub->urb, GFP_NOIO);
790 dev_err(hub->intfdev, "activate --> %d\n", status);
791 if (hub->has_indicators && blinkenlights)
792 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
794 /* Scan all ports that need attention */
798 /* Implement the continuations for the delays above */
799 static void hub_init_func2(struct work_struct *ws)
801 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
803 hub_activate(hub, HUB_INIT2);
806 static void hub_init_func3(struct work_struct *ws)
808 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
810 hub_activate(hub, HUB_INIT3);
813 enum hub_quiescing_type {
814 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
817 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
819 struct usb_device *hdev = hub->hdev;
822 cancel_delayed_work_sync(&hub->init_work);
824 /* khubd and related activity won't re-trigger */
827 if (type != HUB_SUSPEND) {
828 /* Disconnect all the children */
829 for (i = 0; i < hdev->maxchild; ++i) {
830 if (hdev->children[i])
831 usb_disconnect(&hdev->children[i]);
835 /* Stop khubd and related activity */
836 usb_kill_urb(hub->urb);
837 if (hub->has_indicators)
838 cancel_delayed_work_sync(&hub->leds);
840 cancel_work_sync(&hub->tt.clear_work);
843 /* caller has locked the hub device */
844 static int hub_pre_reset(struct usb_interface *intf)
846 struct usb_hub *hub = usb_get_intfdata(intf);
848 hub_quiesce(hub, HUB_PRE_RESET);
852 /* caller has locked the hub device */
853 static int hub_post_reset(struct usb_interface *intf)
855 struct usb_hub *hub = usb_get_intfdata(intf);
857 hub_activate(hub, HUB_POST_RESET);
861 static int hub_configure(struct usb_hub *hub,
862 struct usb_endpoint_descriptor *endpoint)
865 struct usb_device *hdev = hub->hdev;
866 struct device *hub_dev = hub->intfdev;
867 u16 hubstatus, hubchange;
868 u16 wHubCharacteristics;
871 char *message = "out of memory";
873 hub->buffer = usb_buffer_alloc(hdev, sizeof(*hub->buffer), GFP_KERNEL,
880 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
885 mutex_init(&hub->status_mutex);
887 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
888 if (!hub->descriptor) {
893 /* Request the entire hub descriptor.
894 * hub->descriptor can handle USB_MAXCHILDREN ports,
895 * but the hub can/will return fewer bytes here.
897 ret = get_hub_descriptor(hdev, hub->descriptor,
898 sizeof(*hub->descriptor));
900 message = "can't read hub descriptor";
902 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
903 message = "hub has too many ports!";
908 hdev->maxchild = hub->descriptor->bNbrPorts;
909 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
910 (hdev->maxchild == 1) ? "" : "s");
912 hub->port_owners = kzalloc(hdev->maxchild * sizeof(void *), GFP_KERNEL);
913 if (!hub->port_owners) {
918 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
920 if (wHubCharacteristics & HUB_CHAR_COMPOUND) {
922 char portstr [USB_MAXCHILDREN + 1];
924 for (i = 0; i < hdev->maxchild; i++)
925 portstr[i] = hub->descriptor->DeviceRemovable
926 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
928 portstr[hdev->maxchild] = 0;
929 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
931 dev_dbg(hub_dev, "standalone hub\n");
933 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
935 dev_dbg(hub_dev, "ganged power switching\n");
938 dev_dbg(hub_dev, "individual port power switching\n");
942 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
946 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
948 dev_dbg(hub_dev, "global over-current protection\n");
951 dev_dbg(hub_dev, "individual port over-current protection\n");
955 dev_dbg(hub_dev, "no over-current protection\n");
959 spin_lock_init (&hub->tt.lock);
960 INIT_LIST_HEAD (&hub->tt.clear_list);
961 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
962 switch (hdev->descriptor.bDeviceProtocol) {
966 dev_dbg(hub_dev, "Single TT\n");
970 ret = usb_set_interface(hdev, 0, 1);
972 dev_dbg(hub_dev, "TT per port\n");
975 dev_err(hub_dev, "Using single TT (err %d)\n",
980 /* USB 3.0 hubs don't have a TT */
983 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
984 hdev->descriptor.bDeviceProtocol);
988 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
989 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
990 case HUB_TTTT_8_BITS:
991 if (hdev->descriptor.bDeviceProtocol != 0) {
992 hub->tt.think_time = 666;
993 dev_dbg(hub_dev, "TT requires at most %d "
994 "FS bit times (%d ns)\n",
995 8, hub->tt.think_time);
998 case HUB_TTTT_16_BITS:
999 hub->tt.think_time = 666 * 2;
1000 dev_dbg(hub_dev, "TT requires at most %d "
1001 "FS bit times (%d ns)\n",
1002 16, hub->tt.think_time);
1004 case HUB_TTTT_24_BITS:
1005 hub->tt.think_time = 666 * 3;
1006 dev_dbg(hub_dev, "TT requires at most %d "
1007 "FS bit times (%d ns)\n",
1008 24, hub->tt.think_time);
1010 case HUB_TTTT_32_BITS:
1011 hub->tt.think_time = 666 * 4;
1012 dev_dbg(hub_dev, "TT requires at most %d "
1013 "FS bit times (%d ns)\n",
1014 32, hub->tt.think_time);
1018 /* probe() zeroes hub->indicator[] */
1019 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1020 hub->has_indicators = 1;
1021 dev_dbg(hub_dev, "Port indicators are supported\n");
1024 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1025 hub->descriptor->bPwrOn2PwrGood * 2);
1027 /* power budgeting mostly matters with bus-powered hubs,
1028 * and battery-powered root hubs (may provide just 8 mA).
1030 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1032 message = "can't get hub status";
1035 le16_to_cpus(&hubstatus);
1036 if (hdev == hdev->bus->root_hub) {
1037 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
1038 hub->mA_per_port = 500;
1040 hub->mA_per_port = hdev->bus_mA;
1041 hub->limited_power = 1;
1043 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1044 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1045 hub->descriptor->bHubContrCurrent);
1046 hub->limited_power = 1;
1047 if (hdev->maxchild > 0) {
1048 int remaining = hdev->bus_mA -
1049 hub->descriptor->bHubContrCurrent;
1051 if (remaining < hdev->maxchild * 100)
1053 "insufficient power available "
1054 "to use all downstream ports\n");
1055 hub->mA_per_port = 100; /* 7.2.1.1 */
1057 } else { /* Self-powered external hub */
1058 /* FIXME: What about battery-powered external hubs that
1059 * provide less current per port? */
1060 hub->mA_per_port = 500;
1062 if (hub->mA_per_port < 500)
1063 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1066 /* Update the HCD's internal representation of this hub before khubd
1067 * starts getting port status changes for devices under the hub.
1069 hcd = bus_to_hcd(hdev->bus);
1070 if (hcd->driver->update_hub_device) {
1071 ret = hcd->driver->update_hub_device(hcd, hdev,
1072 &hub->tt, GFP_KERNEL);
1074 message = "can't update HCD hub info";
1079 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1081 message = "can't get hub status";
1085 /* local power status reports aren't always correct */
1086 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1087 dev_dbg(hub_dev, "local power source is %s\n",
1088 (hubstatus & HUB_STATUS_LOCAL_POWER)
1089 ? "lost (inactive)" : "good");
1091 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1092 dev_dbg(hub_dev, "%sover-current condition exists\n",
1093 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1095 /* set up the interrupt endpoint
1096 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1097 * bytes as USB2.0[11.12.3] says because some hubs are known
1098 * to send more data (and thus cause overflow). For root hubs,
1099 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1100 * to be big enough for at least USB_MAXCHILDREN ports. */
1101 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1102 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1104 if (maxp > sizeof(*hub->buffer))
1105 maxp = sizeof(*hub->buffer);
1107 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1113 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1114 hub, endpoint->bInterval);
1115 hub->urb->transfer_dma = hub->buffer_dma;
1116 hub->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1118 /* maybe cycle the hub leds */
1119 if (hub->has_indicators && blinkenlights)
1120 hub->indicator [0] = INDICATOR_CYCLE;
1122 hub_activate(hub, HUB_INIT);
1126 dev_err (hub_dev, "config failed, %s (err %d)\n",
1128 /* hub_disconnect() frees urb and descriptor */
1132 static void hub_release(struct kref *kref)
1134 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1136 usb_put_intf(to_usb_interface(hub->intfdev));
1140 static unsigned highspeed_hubs;
1142 static void hub_disconnect(struct usb_interface *intf)
1144 struct usb_hub *hub = usb_get_intfdata (intf);
1146 /* Take the hub off the event list and don't let it be added again */
1147 spin_lock_irq(&hub_event_lock);
1148 list_del_init(&hub->event_list);
1149 hub->disconnected = 1;
1150 spin_unlock_irq(&hub_event_lock);
1152 /* Disconnect all children and quiesce the hub */
1154 hub_quiesce(hub, HUB_DISCONNECT);
1156 usb_set_intfdata (intf, NULL);
1157 hub->hdev->maxchild = 0;
1159 if (hub->hdev->speed == USB_SPEED_HIGH)
1162 usb_free_urb(hub->urb);
1163 kfree(hub->port_owners);
1164 kfree(hub->descriptor);
1166 usb_buffer_free(hub->hdev, sizeof(*hub->buffer), hub->buffer,
1169 kref_put(&hub->kref, hub_release);
1172 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1174 struct usb_host_interface *desc;
1175 struct usb_endpoint_descriptor *endpoint;
1176 struct usb_device *hdev;
1177 struct usb_hub *hub;
1179 desc = intf->cur_altsetting;
1180 hdev = interface_to_usbdev(intf);
1182 if (hdev->level == MAX_TOPO_LEVEL) {
1184 "Unsupported bus topology: hub nested too deep\n");
1188 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1190 dev_warn(&intf->dev, "ignoring external hub\n");
1195 /* Some hubs have a subclass of 1, which AFAICT according to the */
1196 /* specs is not defined, but it works */
1197 if ((desc->desc.bInterfaceSubClass != 0) &&
1198 (desc->desc.bInterfaceSubClass != 1)) {
1200 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1204 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1205 if (desc->desc.bNumEndpoints != 1)
1206 goto descriptor_error;
1208 endpoint = &desc->endpoint[0].desc;
1210 /* If it's not an interrupt in endpoint, we'd better punt! */
1211 if (!usb_endpoint_is_int_in(endpoint))
1212 goto descriptor_error;
1214 /* We found a hub */
1215 dev_info (&intf->dev, "USB hub found\n");
1217 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1219 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1223 kref_init(&hub->kref);
1224 INIT_LIST_HEAD(&hub->event_list);
1225 hub->intfdev = &intf->dev;
1227 INIT_DELAYED_WORK(&hub->leds, led_work);
1228 INIT_DELAYED_WORK(&hub->init_work, NULL);
1231 usb_set_intfdata (intf, hub);
1232 intf->needs_remote_wakeup = 1;
1234 if (hdev->speed == USB_SPEED_HIGH)
1237 if (hub_configure(hub, endpoint) >= 0)
1240 hub_disconnect (intf);
1245 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1247 struct usb_device *hdev = interface_to_usbdev (intf);
1249 /* assert ifno == 0 (part of hub spec) */
1251 case USBDEVFS_HUB_PORTINFO: {
1252 struct usbdevfs_hub_portinfo *info = user_data;
1255 spin_lock_irq(&device_state_lock);
1256 if (hdev->devnum <= 0)
1259 info->nports = hdev->maxchild;
1260 for (i = 0; i < info->nports; i++) {
1261 if (hdev->children[i] == NULL)
1265 hdev->children[i]->devnum;
1268 spin_unlock_irq(&device_state_lock);
1270 return info->nports + 1;
1279 * Allow user programs to claim ports on a hub. When a device is attached
1280 * to one of these "claimed" ports, the program will "own" the device.
1282 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1285 if (hdev->state == USB_STATE_NOTATTACHED)
1287 if (port1 == 0 || port1 > hdev->maxchild)
1290 /* This assumes that devices not managed by the hub driver
1291 * will always have maxchild equal to 0.
1293 *ppowner = &(hdev_to_hub(hdev)->port_owners[port1 - 1]);
1297 /* In the following three functions, the caller must hold hdev's lock */
1298 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1, void *owner)
1303 rc = find_port_owner(hdev, port1, &powner);
1312 int usb_hub_release_port(struct usb_device *hdev, unsigned port1, void *owner)
1317 rc = find_port_owner(hdev, port1, &powner);
1320 if (*powner != owner)
1326 void usb_hub_release_all_ports(struct usb_device *hdev, void *owner)
1331 n = find_port_owner(hdev, 1, &powner);
1333 for (; n < hdev->maxchild; (++n, ++powner)) {
1334 if (*powner == owner)
1340 /* The caller must hold udev's lock */
1341 bool usb_device_is_owned(struct usb_device *udev)
1343 struct usb_hub *hub;
1345 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1347 hub = hdev_to_hub(udev->parent);
1348 return !!hub->port_owners[udev->portnum - 1];
1352 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1356 for (i = 0; i < udev->maxchild; ++i) {
1357 if (udev->children[i])
1358 recursively_mark_NOTATTACHED(udev->children[i]);
1360 if (udev->state == USB_STATE_SUSPENDED) {
1361 udev->discon_suspended = 1;
1362 udev->active_duration -= jiffies;
1364 udev->state = USB_STATE_NOTATTACHED;
1368 * usb_set_device_state - change a device's current state (usbcore, hcds)
1369 * @udev: pointer to device whose state should be changed
1370 * @new_state: new state value to be stored
1372 * udev->state is _not_ fully protected by the device lock. Although
1373 * most transitions are made only while holding the lock, the state can
1374 * can change to USB_STATE_NOTATTACHED at almost any time. This
1375 * is so that devices can be marked as disconnected as soon as possible,
1376 * without having to wait for any semaphores to be released. As a result,
1377 * all changes to any device's state must be protected by the
1378 * device_state_lock spinlock.
1380 * Once a device has been added to the device tree, all changes to its state
1381 * should be made using this routine. The state should _not_ be set directly.
1383 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1384 * Otherwise udev->state is set to new_state, and if new_state is
1385 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1386 * to USB_STATE_NOTATTACHED.
1388 void usb_set_device_state(struct usb_device *udev,
1389 enum usb_device_state new_state)
1391 unsigned long flags;
1393 spin_lock_irqsave(&device_state_lock, flags);
1394 if (udev->state == USB_STATE_NOTATTACHED)
1396 else if (new_state != USB_STATE_NOTATTACHED) {
1398 /* root hub wakeup capabilities are managed out-of-band
1399 * and may involve silicon errata ... ignore them here.
1402 if (udev->state == USB_STATE_SUSPENDED
1403 || new_state == USB_STATE_SUSPENDED)
1404 ; /* No change to wakeup settings */
1405 else if (new_state == USB_STATE_CONFIGURED)
1406 device_init_wakeup(&udev->dev,
1407 (udev->actconfig->desc.bmAttributes
1408 & USB_CONFIG_ATT_WAKEUP));
1410 device_init_wakeup(&udev->dev, 0);
1412 if (udev->state == USB_STATE_SUSPENDED &&
1413 new_state != USB_STATE_SUSPENDED)
1414 udev->active_duration -= jiffies;
1415 else if (new_state == USB_STATE_SUSPENDED &&
1416 udev->state != USB_STATE_SUSPENDED)
1417 udev->active_duration += jiffies;
1418 udev->state = new_state;
1420 recursively_mark_NOTATTACHED(udev);
1421 spin_unlock_irqrestore(&device_state_lock, flags);
1423 EXPORT_SYMBOL_GPL(usb_set_device_state);
1426 * WUSB devices are simple: they have no hubs behind, so the mapping
1427 * device <-> virtual port number becomes 1:1. Why? to simplify the
1428 * life of the device connection logic in
1429 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1430 * handshake we need to assign a temporary address in the unauthorized
1431 * space. For simplicity we use the first virtual port number found to
1432 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1433 * and that becomes it's address [X < 128] or its unauthorized address
1436 * We add 1 as an offset to the one-based USB-stack port number
1437 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1438 * 0 is reserved by USB for default address; (b) Linux's USB stack
1439 * uses always #1 for the root hub of the controller. So USB stack's
1440 * port #1, which is wusb virtual-port #0 has address #2.
1442 * Devices connected under xHCI are not as simple. The host controller
1443 * supports virtualization, so the hardware assigns device addresses and
1444 * the HCD must setup data structures before issuing a set address
1445 * command to the hardware.
1447 static void choose_address(struct usb_device *udev)
1450 struct usb_bus *bus = udev->bus;
1452 /* If khubd ever becomes multithreaded, this will need a lock */
1454 devnum = udev->portnum + 1;
1455 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
1457 /* Try to allocate the next devnum beginning at
1458 * bus->devnum_next. */
1459 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1462 devnum = find_next_zero_bit(bus->devmap.devicemap,
1464 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1467 set_bit(devnum, bus->devmap.devicemap);
1468 udev->devnum = devnum;
1472 static void release_address(struct usb_device *udev)
1474 if (udev->devnum > 0) {
1475 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1480 static void update_address(struct usb_device *udev, int devnum)
1482 /* The address for a WUSB device is managed by wusbcore. */
1484 udev->devnum = devnum;
1487 #ifdef CONFIG_USB_SUSPEND
1489 static void usb_stop_pm(struct usb_device *udev)
1491 /* Synchronize with the ksuspend thread to prevent any more
1492 * autosuspend requests from being submitted, and decrement
1493 * the parent's count of unsuspended children.
1496 if (udev->parent && !udev->discon_suspended)
1497 usb_autosuspend_device(udev->parent);
1498 usb_pm_unlock(udev);
1500 /* Stop any autosuspend or autoresume requests already submitted */
1501 cancel_delayed_work_sync(&udev->autosuspend);
1502 cancel_work_sync(&udev->autoresume);
1507 static inline void usb_stop_pm(struct usb_device *udev)
1512 static void hub_free_dev(struct usb_device *udev)
1514 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1516 /* Root hubs aren't real devices, so don't free HCD resources */
1517 if (hcd->driver->free_dev && udev->parent)
1518 hcd->driver->free_dev(hcd, udev);
1522 * usb_disconnect - disconnect a device (usbcore-internal)
1523 * @pdev: pointer to device being disconnected
1524 * Context: !in_interrupt ()
1526 * Something got disconnected. Get rid of it and all of its children.
1528 * If *pdev is a normal device then the parent hub must already be locked.
1529 * If *pdev is a root hub then this routine will acquire the
1530 * usb_bus_list_lock on behalf of the caller.
1532 * Only hub drivers (including virtual root hub drivers for host
1533 * controllers) should ever call this.
1535 * This call is synchronous, and may not be used in an interrupt context.
1537 void usb_disconnect(struct usb_device **pdev)
1539 struct usb_device *udev = *pdev;
1543 pr_debug ("%s nodev\n", __func__);
1547 /* mark the device as inactive, so any further urb submissions for
1548 * this device (and any of its children) will fail immediately.
1549 * this quiesces everyting except pending urbs.
1551 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1552 dev_info (&udev->dev, "USB disconnect, address %d\n", udev->devnum);
1554 usb_lock_device(udev);
1556 /* Free up all the children before we remove this device */
1557 for (i = 0; i < USB_MAXCHILDREN; i++) {
1558 if (udev->children[i])
1559 usb_disconnect(&udev->children[i]);
1562 /* deallocate hcd/hardware state ... nuking all pending urbs and
1563 * cleaning up all state associated with the current configuration
1564 * so that the hardware is now fully quiesced.
1566 dev_dbg (&udev->dev, "unregistering device\n");
1567 usb_disable_device(udev, 0);
1568 usb_hcd_synchronize_unlinks(udev);
1570 usb_remove_ep_devs(&udev->ep0);
1571 usb_unlock_device(udev);
1573 /* Unregister the device. The device driver is responsible
1574 * for de-configuring the device and invoking the remove-device
1575 * notifier chain (used by usbfs and possibly others).
1577 device_del(&udev->dev);
1579 /* Free the device number and delete the parent's children[]
1580 * (or root_hub) pointer.
1582 release_address(udev);
1584 /* Avoid races with recursively_mark_NOTATTACHED() */
1585 spin_lock_irq(&device_state_lock);
1587 spin_unlock_irq(&device_state_lock);
1593 put_device(&udev->dev);
1596 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
1597 static void show_string(struct usb_device *udev, char *id, char *string)
1601 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1604 static void announce_device(struct usb_device *udev)
1606 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
1607 le16_to_cpu(udev->descriptor.idVendor),
1608 le16_to_cpu(udev->descriptor.idProduct));
1609 dev_info(&udev->dev,
1610 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
1611 udev->descriptor.iManufacturer,
1612 udev->descriptor.iProduct,
1613 udev->descriptor.iSerialNumber);
1614 show_string(udev, "Product", udev->product);
1615 show_string(udev, "Manufacturer", udev->manufacturer);
1616 show_string(udev, "SerialNumber", udev->serial);
1619 static inline void announce_device(struct usb_device *udev) { }
1622 #ifdef CONFIG_USB_OTG
1623 #include "otg_whitelist.h"
1627 * usb_enumerate_device_otg - FIXME (usbcore-internal)
1628 * @udev: newly addressed device (in ADDRESS state)
1630 * Finish enumeration for On-The-Go devices
1632 static int usb_enumerate_device_otg(struct usb_device *udev)
1636 #ifdef CONFIG_USB_OTG
1638 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1639 * to wake us after we've powered off VBUS; and HNP, switching roles
1640 * "host" to "peripheral". The OTG descriptor helps figure this out.
1642 if (!udev->bus->is_b_host
1644 && udev->parent == udev->bus->root_hub) {
1645 struct usb_otg_descriptor *desc = 0;
1646 struct usb_bus *bus = udev->bus;
1648 /* descriptor may appear anywhere in config */
1649 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1650 le16_to_cpu(udev->config[0].desc.wTotalLength),
1651 USB_DT_OTG, (void **) &desc) == 0) {
1652 if (desc->bmAttributes & USB_OTG_HNP) {
1653 unsigned port1 = udev->portnum;
1655 dev_info(&udev->dev,
1656 "Dual-Role OTG device on %sHNP port\n",
1657 (port1 == bus->otg_port)
1660 /* enable HNP before suspend, it's simpler */
1661 if (port1 == bus->otg_port)
1662 bus->b_hnp_enable = 1;
1663 err = usb_control_msg(udev,
1664 usb_sndctrlpipe(udev, 0),
1665 USB_REQ_SET_FEATURE, 0,
1667 ? USB_DEVICE_B_HNP_ENABLE
1668 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1669 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1671 /* OTG MESSAGE: report errors here,
1672 * customize to match your product.
1674 dev_info(&udev->dev,
1675 "can't set HNP mode: %d\n",
1677 bus->b_hnp_enable = 0;
1683 if (!is_targeted(udev)) {
1685 /* Maybe it can talk to us, though we can't talk to it.
1686 * (Includes HNP test device.)
1688 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
1689 err = usb_port_suspend(udev, PMSG_SUSPEND);
1691 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1703 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
1704 * @udev: newly addressed device (in ADDRESS state)
1706 * This is only called by usb_new_device() and usb_authorize_device()
1707 * and FIXME -- all comments that apply to them apply here wrt to
1710 * If the device is WUSB and not authorized, we don't attempt to read
1711 * the string descriptors, as they will be errored out by the device
1712 * until it has been authorized.
1714 static int usb_enumerate_device(struct usb_device *udev)
1718 if (udev->config == NULL) {
1719 err = usb_get_configuration(udev);
1721 dev_err(&udev->dev, "can't read configurations, error %d\n",
1726 if (udev->wusb == 1 && udev->authorized == 0) {
1727 udev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1728 udev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1729 udev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1732 /* read the standard strings and cache them if present */
1733 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1734 udev->manufacturer = usb_cache_string(udev,
1735 udev->descriptor.iManufacturer);
1736 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
1738 err = usb_enumerate_device_otg(udev);
1745 * usb_new_device - perform initial device setup (usbcore-internal)
1746 * @udev: newly addressed device (in ADDRESS state)
1748 * This is called with devices which have been detected but not fully
1749 * enumerated. The device descriptor is available, but not descriptors
1750 * for any device configuration. The caller must have locked either
1751 * the parent hub (if udev is a normal device) or else the
1752 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1753 * udev has already been installed, but udev is not yet visible through
1754 * sysfs or other filesystem code.
1756 * It will return if the device is configured properly or not. Zero if
1757 * the interface was registered with the driver core; else a negative
1760 * This call is synchronous, and may not be used in an interrupt context.
1762 * Only the hub driver or root-hub registrar should ever call this.
1764 int usb_new_device(struct usb_device *udev)
1768 /* Increment the parent's count of unsuspended children */
1770 usb_autoresume_device(udev->parent);
1772 err = usb_enumerate_device(udev); /* Read descriptors */
1775 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
1776 udev->devnum, udev->bus->busnum,
1777 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1778 /* export the usbdev device-node for libusb */
1779 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
1780 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1782 /* Tell the world! */
1783 announce_device(udev);
1785 /* Register the device. The device driver is responsible
1786 * for configuring the device and invoking the add-device
1787 * notifier chain (used by usbfs and possibly others).
1789 err = device_add(&udev->dev);
1791 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1795 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
1799 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1806 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
1807 * @usb_dev: USB device
1809 * Move the USB device to a very basic state where interfaces are disabled
1810 * and the device is in fact unconfigured and unusable.
1812 * We share a lock (that we have) with device_del(), so we need to
1815 int usb_deauthorize_device(struct usb_device *usb_dev)
1817 usb_lock_device(usb_dev);
1818 if (usb_dev->authorized == 0)
1819 goto out_unauthorized;
1821 usb_dev->authorized = 0;
1822 usb_set_configuration(usb_dev, -1);
1824 kfree(usb_dev->product);
1825 usb_dev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1826 kfree(usb_dev->manufacturer);
1827 usb_dev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1828 kfree(usb_dev->serial);
1829 usb_dev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1831 usb_destroy_configuration(usb_dev);
1832 usb_dev->descriptor.bNumConfigurations = 0;
1835 usb_unlock_device(usb_dev);
1840 int usb_authorize_device(struct usb_device *usb_dev)
1844 usb_lock_device(usb_dev);
1845 if (usb_dev->authorized == 1)
1846 goto out_authorized;
1848 result = usb_autoresume_device(usb_dev);
1850 dev_err(&usb_dev->dev,
1851 "can't autoresume for authorization: %d\n", result);
1852 goto error_autoresume;
1854 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
1856 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
1857 "authorization: %d\n", result);
1858 goto error_device_descriptor;
1861 kfree(usb_dev->product);
1862 usb_dev->product = NULL;
1863 kfree(usb_dev->manufacturer);
1864 usb_dev->manufacturer = NULL;
1865 kfree(usb_dev->serial);
1866 usb_dev->serial = NULL;
1868 usb_dev->authorized = 1;
1869 result = usb_enumerate_device(usb_dev);
1871 goto error_enumerate;
1872 /* Choose and set the configuration. This registers the interfaces
1873 * with the driver core and lets interface drivers bind to them.
1875 c = usb_choose_configuration(usb_dev);
1877 result = usb_set_configuration(usb_dev, c);
1879 dev_err(&usb_dev->dev,
1880 "can't set config #%d, error %d\n", c, result);
1881 /* This need not be fatal. The user can try to
1882 * set other configurations. */
1885 dev_info(&usb_dev->dev, "authorized to connect\n");
1888 error_device_descriptor:
1889 usb_autosuspend_device(usb_dev);
1892 usb_unlock_device(usb_dev); // complements locktree
1897 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
1898 static unsigned hub_is_wusb(struct usb_hub *hub)
1900 struct usb_hcd *hcd;
1901 if (hub->hdev->parent != NULL) /* not a root hub? */
1903 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
1904 return hcd->wireless;
1908 #define PORT_RESET_TRIES 5
1909 #define SET_ADDRESS_TRIES 2
1910 #define GET_DESCRIPTOR_TRIES 2
1911 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1912 #define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1914 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1915 #define HUB_SHORT_RESET_TIME 10
1916 #define HUB_LONG_RESET_TIME 200
1917 #define HUB_RESET_TIMEOUT 500
1919 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
1920 struct usb_device *udev, unsigned int delay)
1922 int delay_time, ret;
1926 for (delay_time = 0;
1927 delay_time < HUB_RESET_TIMEOUT;
1928 delay_time += delay) {
1929 /* wait to give the device a chance to reset */
1932 /* read and decode port status */
1933 ret = hub_port_status(hub, port1, &portstatus, &portchange);
1937 /* Device went away? */
1938 if (!(portstatus & USB_PORT_STAT_CONNECTION))
1941 /* bomb out completely if the connection bounced */
1942 if ((portchange & USB_PORT_STAT_C_CONNECTION))
1945 /* if we`ve finished resetting, then break out of the loop */
1946 if (!(portstatus & USB_PORT_STAT_RESET) &&
1947 (portstatus & USB_PORT_STAT_ENABLE)) {
1948 if (hub_is_wusb(hub))
1949 udev->speed = USB_SPEED_VARIABLE;
1950 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
1951 udev->speed = USB_SPEED_HIGH;
1952 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
1953 udev->speed = USB_SPEED_LOW;
1955 udev->speed = USB_SPEED_FULL;
1959 /* switch to the long delay after two short delay failures */
1960 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
1961 delay = HUB_LONG_RESET_TIME;
1963 dev_dbg (hub->intfdev,
1964 "port %d not reset yet, waiting %dms\n",
1971 static int hub_port_reset(struct usb_hub *hub, int port1,
1972 struct usb_device *udev, unsigned int delay)
1976 /* Block EHCI CF initialization during the port reset.
1977 * Some companion controllers don't like it when they mix.
1979 down_read(&ehci_cf_port_reset_rwsem);
1981 /* Reset the port */
1982 for (i = 0; i < PORT_RESET_TRIES; i++) {
1983 status = set_port_feature(hub->hdev,
1984 port1, USB_PORT_FEAT_RESET);
1986 dev_err(hub->intfdev,
1987 "cannot reset port %d (err = %d)\n",
1990 status = hub_port_wait_reset(hub, port1, udev, delay);
1991 if (status && status != -ENOTCONN)
1992 dev_dbg(hub->intfdev,
1993 "port_wait_reset: err = %d\n",
1997 /* return on disconnect or reset */
2000 /* TRSTRCY = 10 ms; plus some extra */
2002 update_address(udev, 0);
2006 clear_port_feature(hub->hdev,
2007 port1, USB_PORT_FEAT_C_RESET);
2008 /* FIXME need disconnect() for NOTATTACHED device */
2009 usb_set_device_state(udev, status
2010 ? USB_STATE_NOTATTACHED
2011 : USB_STATE_DEFAULT);
2015 dev_dbg (hub->intfdev,
2016 "port %d not enabled, trying reset again...\n",
2018 delay = HUB_LONG_RESET_TIME;
2021 dev_err (hub->intfdev,
2022 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2026 up_read(&ehci_cf_port_reset_rwsem);
2032 #define MASK_BITS (USB_PORT_STAT_POWER | USB_PORT_STAT_CONNECTION | \
2033 USB_PORT_STAT_SUSPEND)
2034 #define WANT_BITS (USB_PORT_STAT_POWER | USB_PORT_STAT_CONNECTION)
2036 /* Determine whether the device on a port is ready for a normal resume,
2037 * is ready for a reset-resume, or should be disconnected.
2039 static int check_port_resume_type(struct usb_device *udev,
2040 struct usb_hub *hub, int port1,
2041 int status, unsigned portchange, unsigned portstatus)
2043 /* Is the device still present? */
2044 if (status || (portstatus & MASK_BITS) != WANT_BITS) {
2049 /* Can't do a normal resume if the port isn't enabled,
2050 * so try a reset-resume instead.
2052 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2053 if (udev->persist_enabled)
2054 udev->reset_resume = 1;
2060 dev_dbg(hub->intfdev,
2061 "port %d status %04x.%04x after resume, %d\n",
2062 port1, portchange, portstatus, status);
2063 } else if (udev->reset_resume) {
2065 /* Late port handoff can set status-change bits */
2066 if (portchange & USB_PORT_STAT_C_CONNECTION)
2067 clear_port_feature(hub->hdev, port1,
2068 USB_PORT_FEAT_C_CONNECTION);
2069 if (portchange & USB_PORT_STAT_C_ENABLE)
2070 clear_port_feature(hub->hdev, port1,
2071 USB_PORT_FEAT_C_ENABLE);
2077 #ifdef CONFIG_USB_SUSPEND
2080 * usb_port_suspend - suspend a usb device's upstream port
2081 * @udev: device that's no longer in active use, not a root hub
2082 * Context: must be able to sleep; device not locked; pm locks held
2084 * Suspends a USB device that isn't in active use, conserving power.
2085 * Devices may wake out of a suspend, if anything important happens,
2086 * using the remote wakeup mechanism. They may also be taken out of
2087 * suspend by the host, using usb_port_resume(). It's also routine
2088 * to disconnect devices while they are suspended.
2090 * This only affects the USB hardware for a device; its interfaces
2091 * (and, for hubs, child devices) must already have been suspended.
2093 * Selective port suspend reduces power; most suspended devices draw
2094 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2095 * All devices below the suspended port are also suspended.
2097 * Devices leave suspend state when the host wakes them up. Some devices
2098 * also support "remote wakeup", where the device can activate the USB
2099 * tree above them to deliver data, such as a keypress or packet. In
2100 * some cases, this wakes the USB host.
2102 * Suspending OTG devices may trigger HNP, if that's been enabled
2103 * between a pair of dual-role devices. That will change roles, such
2104 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2106 * Devices on USB hub ports have only one "suspend" state, corresponding
2107 * to ACPI D2, "may cause the device to lose some context".
2108 * State transitions include:
2110 * - suspend, resume ... when the VBUS power link stays live
2111 * - suspend, disconnect ... VBUS lost
2113 * Once VBUS drop breaks the circuit, the port it's using has to go through
2114 * normal re-enumeration procedures, starting with enabling VBUS power.
2115 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2116 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2117 * timer, no SRP, no requests through sysfs.
2119 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
2120 * the root hub for their bus goes into global suspend ... so we don't
2121 * (falsely) update the device power state to say it suspended.
2123 * Returns 0 on success, else negative errno.
2125 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2127 struct usb_hub *hub = hdev_to_hub(udev->parent);
2128 int port1 = udev->portnum;
2131 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
2133 /* enable remote wakeup when appropriate; this lets the device
2134 * wake up the upstream hub (including maybe the root hub).
2136 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2137 * we don't explicitly enable it here.
2139 if (udev->do_remote_wakeup) {
2140 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2141 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2142 USB_DEVICE_REMOTE_WAKEUP, 0,
2144 USB_CTRL_SET_TIMEOUT);
2146 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
2151 status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
2153 dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
2155 /* paranoia: "should not happen" */
2156 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2157 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2158 USB_DEVICE_REMOTE_WAKEUP, 0,
2160 USB_CTRL_SET_TIMEOUT);
2162 /* device has up to 10 msec to fully suspend */
2163 dev_dbg(&udev->dev, "usb %ssuspend\n",
2164 (msg.event & PM_EVENT_AUTO ? "auto-" : ""));
2165 usb_set_device_state(udev, USB_STATE_SUSPENDED);
2172 * If the USB "suspend" state is in use (rather than "global suspend"),
2173 * many devices will be individually taken out of suspend state using
2174 * special "resume" signaling. This routine kicks in shortly after
2175 * hardware resume signaling is finished, either because of selective
2176 * resume (by host) or remote wakeup (by device) ... now see what changed
2177 * in the tree that's rooted at this device.
2179 * If @udev->reset_resume is set then the device is reset before the
2180 * status check is done.
2182 static int finish_port_resume(struct usb_device *udev)
2187 /* caller owns the udev device lock */
2188 dev_dbg(&udev->dev, "%s\n",
2189 udev->reset_resume ? "finish reset-resume" : "finish resume");
2191 /* usb ch9 identifies four variants of SUSPENDED, based on what
2192 * state the device resumes to. Linux currently won't see the
2193 * first two on the host side; they'd be inside hub_port_init()
2194 * during many timeouts, but khubd can't suspend until later.
2196 usb_set_device_state(udev, udev->actconfig
2197 ? USB_STATE_CONFIGURED
2198 : USB_STATE_ADDRESS);
2200 /* 10.5.4.5 says not to reset a suspended port if the attached
2201 * device is enabled for remote wakeup. Hence the reset
2202 * operation is carried out here, after the port has been
2205 if (udev->reset_resume)
2207 status = usb_reset_and_verify_device(udev);
2209 /* 10.5.4.5 says be sure devices in the tree are still there.
2210 * For now let's assume the device didn't go crazy on resume,
2211 * and device drivers will know about any resume quirks.
2215 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
2217 status = (status > 0 ? 0 : -ENODEV);
2219 /* If a normal resume failed, try doing a reset-resume */
2220 if (status && !udev->reset_resume && udev->persist_enabled) {
2221 dev_dbg(&udev->dev, "retry with reset-resume\n");
2222 udev->reset_resume = 1;
2223 goto retry_reset_resume;
2228 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
2230 } else if (udev->actconfig) {
2231 le16_to_cpus(&devstatus);
2232 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) {
2233 status = usb_control_msg(udev,
2234 usb_sndctrlpipe(udev, 0),
2235 USB_REQ_CLEAR_FEATURE,
2237 USB_DEVICE_REMOTE_WAKEUP, 0,
2239 USB_CTRL_SET_TIMEOUT);
2242 "disable remote wakeup, status %d\n",
2251 * usb_port_resume - re-activate a suspended usb device's upstream port
2252 * @udev: device to re-activate, not a root hub
2253 * Context: must be able to sleep; device not locked; pm locks held
2255 * This will re-activate the suspended device, increasing power usage
2256 * while letting drivers communicate again with its endpoints.
2257 * USB resume explicitly guarantees that the power session between
2258 * the host and the device is the same as it was when the device
2261 * If @udev->reset_resume is set then this routine won't check that the
2262 * port is still enabled. Furthermore, finish_port_resume() above will
2263 * reset @udev. The end result is that a broken power session can be
2264 * recovered and @udev will appear to persist across a loss of VBUS power.
2266 * For example, if a host controller doesn't maintain VBUS suspend current
2267 * during a system sleep or is reset when the system wakes up, all the USB
2268 * power sessions below it will be broken. This is especially troublesome
2269 * for mass-storage devices containing mounted filesystems, since the
2270 * device will appear to have disconnected and all the memory mappings
2271 * to it will be lost. Using the USB_PERSIST facility, the device can be
2272 * made to appear as if it had not disconnected.
2274 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
2275 * every effort to insure that the same device is present after the
2276 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
2277 * quite possible for a device to remain unaltered but its media to be
2278 * changed. If the user replaces a flash memory card while the system is
2279 * asleep, he will have only himself to blame when the filesystem on the
2280 * new card is corrupted and the system crashes.
2282 * Returns 0 on success, else negative errno.
2284 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
2286 struct usb_hub *hub = hdev_to_hub(udev->parent);
2287 int port1 = udev->portnum;
2289 u16 portchange, portstatus;
2291 /* Skip the initial Clear-Suspend step for a remote wakeup */
2292 status = hub_port_status(hub, port1, &portstatus, &portchange);
2293 if (status == 0 && !(portstatus & USB_PORT_STAT_SUSPEND))
2294 goto SuspendCleared;
2296 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
2298 set_bit(port1, hub->busy_bits);
2300 /* see 7.1.7.7; affects power usage, but not budgeting */
2301 status = clear_port_feature(hub->hdev,
2302 port1, USB_PORT_FEAT_SUSPEND);
2304 dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
2307 /* drive resume for at least 20 msec */
2308 dev_dbg(&udev->dev, "usb %sresume\n",
2309 (msg.event & PM_EVENT_AUTO ? "auto-" : ""));
2312 /* Virtual root hubs can trigger on GET_PORT_STATUS to
2313 * stop resume signaling. Then finish the resume
2316 status = hub_port_status(hub, port1, &portstatus, &portchange);
2318 /* TRSMRCY = 10 msec */
2324 if (portchange & USB_PORT_STAT_C_SUSPEND)
2325 clear_port_feature(hub->hdev, port1,
2326 USB_PORT_FEAT_C_SUSPEND);
2329 clear_bit(port1, hub->busy_bits);
2331 status = check_port_resume_type(udev,
2332 hub, port1, status, portchange, portstatus);
2334 status = finish_port_resume(udev);
2336 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2337 hub_port_logical_disconnect(hub, port1);
2342 /* caller has locked udev */
2343 static int remote_wakeup(struct usb_device *udev)
2347 if (udev->state == USB_STATE_SUSPENDED) {
2348 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
2349 usb_mark_last_busy(udev);
2350 status = usb_external_resume_device(udev, PMSG_REMOTE_RESUME);
2355 #else /* CONFIG_USB_SUSPEND */
2357 /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
2359 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2364 /* However we may need to do a reset-resume */
2366 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
2368 struct usb_hub *hub = hdev_to_hub(udev->parent);
2369 int port1 = udev->portnum;
2371 u16 portchange, portstatus;
2373 status = hub_port_status(hub, port1, &portstatus, &portchange);
2374 status = check_port_resume_type(udev,
2375 hub, port1, status, portchange, portstatus);
2378 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2379 hub_port_logical_disconnect(hub, port1);
2380 } else if (udev->reset_resume) {
2381 dev_dbg(&udev->dev, "reset-resume\n");
2382 status = usb_reset_and_verify_device(udev);
2387 static inline int remote_wakeup(struct usb_device *udev)
2394 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
2396 struct usb_hub *hub = usb_get_intfdata (intf);
2397 struct usb_device *hdev = hub->hdev;
2400 /* fail if children aren't already suspended */
2401 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
2402 struct usb_device *udev;
2404 udev = hdev->children [port1-1];
2405 if (udev && udev->can_submit) {
2406 if (!(msg.event & PM_EVENT_AUTO))
2407 dev_dbg(&intf->dev, "port %d nyet suspended\n",
2413 dev_dbg(&intf->dev, "%s\n", __func__);
2415 /* stop khubd and related activity */
2416 hub_quiesce(hub, HUB_SUSPEND);
2420 static int hub_resume(struct usb_interface *intf)
2422 struct usb_hub *hub = usb_get_intfdata(intf);
2424 dev_dbg(&intf->dev, "%s\n", __func__);
2425 hub_activate(hub, HUB_RESUME);
2429 static int hub_reset_resume(struct usb_interface *intf)
2431 struct usb_hub *hub = usb_get_intfdata(intf);
2433 dev_dbg(&intf->dev, "%s\n", __func__);
2434 hub_activate(hub, HUB_RESET_RESUME);
2439 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
2440 * @rhdev: struct usb_device for the root hub
2442 * The USB host controller driver calls this function when its root hub
2443 * is resumed and Vbus power has been interrupted or the controller
2444 * has been reset. The routine marks @rhdev as having lost power.
2445 * When the hub driver is resumed it will take notice and carry out
2446 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
2447 * the others will be disconnected.
2449 void usb_root_hub_lost_power(struct usb_device *rhdev)
2451 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
2452 rhdev->reset_resume = 1;
2454 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
2456 #else /* CONFIG_PM */
2458 static inline int remote_wakeup(struct usb_device *udev)
2463 #define hub_suspend NULL
2464 #define hub_resume NULL
2465 #define hub_reset_resume NULL
2469 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2471 * Between connect detection and reset signaling there must be a delay
2472 * of 100ms at least for debounce and power-settling. The corresponding
2473 * timer shall restart whenever the downstream port detects a disconnect.
2475 * Apparently there are some bluetooth and irda-dongles and a number of
2476 * low-speed devices for which this debounce period may last over a second.
2477 * Not covered by the spec - but easy to deal with.
2479 * This implementation uses a 1500ms total debounce timeout; if the
2480 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2481 * every 25ms for transient disconnects. When the port status has been
2482 * unchanged for 100ms it returns the port status.
2484 static int hub_port_debounce(struct usb_hub *hub, int port1)
2487 int total_time, stable_time = 0;
2488 u16 portchange, portstatus;
2489 unsigned connection = 0xffff;
2491 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2492 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2496 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2497 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2498 stable_time += HUB_DEBOUNCE_STEP;
2499 if (stable_time >= HUB_DEBOUNCE_STABLE)
2503 connection = portstatus & USB_PORT_STAT_CONNECTION;
2506 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2507 clear_port_feature(hub->hdev, port1,
2508 USB_PORT_FEAT_C_CONNECTION);
2511 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2513 msleep(HUB_DEBOUNCE_STEP);
2516 dev_dbg (hub->intfdev,
2517 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2518 port1, total_time, stable_time, portstatus);
2520 if (stable_time < HUB_DEBOUNCE_STABLE)
2525 void usb_ep0_reinit(struct usb_device *udev)
2527 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
2528 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
2529 usb_enable_endpoint(udev, &udev->ep0, true);
2531 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
2533 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2534 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2536 static int hub_set_address(struct usb_device *udev, int devnum)
2539 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2542 * The host controller will choose the device address,
2543 * instead of the core having chosen it earlier
2545 if (!hcd->driver->address_device && devnum <= 1)
2547 if (udev->state == USB_STATE_ADDRESS)
2549 if (udev->state != USB_STATE_DEFAULT)
2551 if (hcd->driver->address_device) {
2552 retval = hcd->driver->address_device(hcd, udev);
2554 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2555 USB_REQ_SET_ADDRESS, 0, devnum, 0,
2556 NULL, 0, USB_CTRL_SET_TIMEOUT);
2558 update_address(udev, devnum);
2561 /* Device now using proper address. */
2562 usb_set_device_state(udev, USB_STATE_ADDRESS);
2563 usb_ep0_reinit(udev);
2568 /* Reset device, (re)assign address, get device descriptor.
2569 * Device connection must be stable, no more debouncing needed.
2570 * Returns device in USB_STATE_ADDRESS, except on error.
2572 * If this is called for an already-existing device (as part of
2573 * usb_reset_and_verify_device), the caller must own the device lock. For a
2574 * newly detected device that is not accessible through any global
2575 * pointers, it's not necessary to lock the device.
2578 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2581 static DEFINE_MUTEX(usb_address0_mutex);
2583 struct usb_device *hdev = hub->hdev;
2584 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
2586 unsigned delay = HUB_SHORT_RESET_TIME;
2587 enum usb_device_speed oldspeed = udev->speed;
2589 int devnum = udev->devnum;
2591 /* root hub ports have a slightly longer reset period
2592 * (from USB 2.0 spec, section 7.1.7.5)
2594 if (!hdev->parent) {
2595 delay = HUB_ROOT_RESET_TIME;
2596 if (port1 == hdev->bus->otg_port)
2597 hdev->bus->b_hnp_enable = 0;
2600 /* Some low speed devices have problems with the quick delay, so */
2601 /* be a bit pessimistic with those devices. RHbug #23670 */
2602 if (oldspeed == USB_SPEED_LOW)
2603 delay = HUB_LONG_RESET_TIME;
2605 mutex_lock(&usb_address0_mutex);
2607 if ((hcd->driver->flags & HCD_USB3) && udev->config) {
2608 /* FIXME this will need special handling by the xHCI driver. */
2610 "xHCI reset of configured device "
2611 "not supported yet.\n");
2614 } else if (!udev->config && oldspeed == USB_SPEED_SUPER) {
2615 /* Don't reset USB 3.0 devices during an initial setup */
2616 usb_set_device_state(udev, USB_STATE_DEFAULT);
2618 /* Reset the device; full speed may morph to high speed */
2619 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
2620 retval = hub_port_reset(hub, port1, udev, delay);
2621 if (retval < 0) /* error or disconnect */
2623 /* success, speed is known */
2627 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2628 dev_dbg(&udev->dev, "device reset changed speed!\n");
2631 oldspeed = udev->speed;
2633 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2634 * it's fixed size except for full speed devices.
2635 * For Wireless USB devices, ep0 max packet is always 512 (tho
2636 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
2638 switch (udev->speed) {
2639 case USB_SPEED_SUPER:
2640 case USB_SPEED_VARIABLE: /* fixed at 512 */
2641 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
2643 case USB_SPEED_HIGH: /* fixed at 64 */
2644 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
2646 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
2647 /* to determine the ep0 maxpacket size, try to read
2648 * the device descriptor to get bMaxPacketSize0 and
2649 * then correct our initial guess.
2651 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
2653 case USB_SPEED_LOW: /* fixed at 8 */
2654 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
2661 switch (udev->speed) {
2662 case USB_SPEED_LOW: speed = "low"; break;
2663 case USB_SPEED_FULL: speed = "full"; break;
2664 case USB_SPEED_HIGH: speed = "high"; break;
2665 case USB_SPEED_SUPER:
2668 case USB_SPEED_VARIABLE:
2672 default: speed = "?"; break;
2674 if (udev->speed != USB_SPEED_SUPER)
2675 dev_info(&udev->dev,
2676 "%s %s speed %sUSB device using %s and address %d\n",
2677 (udev->config) ? "reset" : "new", speed, type,
2678 udev->bus->controller->driver->name, devnum);
2680 /* Set up TT records, if needed */
2682 udev->tt = hdev->tt;
2683 udev->ttport = hdev->ttport;
2684 } else if (udev->speed != USB_SPEED_HIGH
2685 && hdev->speed == USB_SPEED_HIGH) {
2686 udev->tt = &hub->tt;
2687 udev->ttport = port1;
2690 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2691 * Because device hardware and firmware is sometimes buggy in
2692 * this area, and this is how Linux has done it for ages.
2693 * Change it cautiously.
2695 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2696 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2697 * so it may help with some non-standards-compliant devices.
2698 * Otherwise we start with SET_ADDRESS and then try to read the
2699 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2702 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
2704 * An xHCI controller cannot send any packets to a device until
2705 * a set address command successfully completes.
2707 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3)) {
2708 struct usb_device_descriptor *buf;
2711 #define GET_DESCRIPTOR_BUFSIZE 64
2712 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2718 /* Retry on all errors; some devices are flakey.
2719 * 255 is for WUSB devices, we actually need to use
2720 * 512 (WUSB1.0[4.8.1]).
2722 for (j = 0; j < 3; ++j) {
2723 buf->bMaxPacketSize0 = 0;
2724 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2725 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2726 USB_DT_DEVICE << 8, 0,
2727 buf, GET_DESCRIPTOR_BUFSIZE,
2728 initial_descriptor_timeout);
2729 switch (buf->bMaxPacketSize0) {
2730 case 8: case 16: case 32: case 64: case 255:
2731 if (buf->bDescriptorType ==
2745 udev->descriptor.bMaxPacketSize0 =
2746 buf->bMaxPacketSize0;
2749 retval = hub_port_reset(hub, port1, udev, delay);
2750 if (retval < 0) /* error or disconnect */
2752 if (oldspeed != udev->speed) {
2754 "device reset changed speed!\n");
2760 "device descriptor read/64, error %d\n",
2765 #undef GET_DESCRIPTOR_BUFSIZE
2769 * If device is WUSB, we already assigned an
2770 * unauthorized address in the Connect Ack sequence;
2771 * authorization will assign the final address.
2773 if (udev->wusb == 0) {
2774 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
2775 retval = hub_set_address(udev, devnum);
2782 "device not accepting address %d, error %d\n",
2786 if (udev->speed == USB_SPEED_SUPER) {
2787 devnum = udev->devnum;
2788 dev_info(&udev->dev,
2789 "%s SuperSpeed USB device using %s and address %d\n",
2790 (udev->config) ? "reset" : "new",
2791 udev->bus->controller->driver->name, devnum);
2794 /* cope with hardware quirkiness:
2795 * - let SET_ADDRESS settle, some device hardware wants it
2796 * - read ep0 maxpacket even for high and low speed,
2799 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3))
2803 retval = usb_get_device_descriptor(udev, 8);
2806 "device descriptor read/8, error %d\n",
2818 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
2819 udev->speed == USB_SPEED_SUPER)
2822 i = udev->descriptor.bMaxPacketSize0;
2823 if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
2824 if (udev->speed == USB_SPEED_LOW ||
2825 !(i == 8 || i == 16 || i == 32 || i == 64)) {
2826 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
2830 if (udev->speed == USB_SPEED_FULL)
2831 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
2833 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
2834 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
2835 usb_ep0_reinit(udev);
2838 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
2839 if (retval < (signed)sizeof(udev->descriptor)) {
2840 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
2851 hub_port_disable(hub, port1, 0);
2852 update_address(udev, devnum); /* for disconnect processing */
2854 mutex_unlock(&usb_address0_mutex);
2859 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
2861 struct usb_qualifier_descriptor *qual;
2864 qual = kmalloc (sizeof *qual, GFP_KERNEL);
2868 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
2869 qual, sizeof *qual);
2870 if (status == sizeof *qual) {
2871 dev_info(&udev->dev, "not running at top speed; "
2872 "connect to a high speed hub\n");
2873 /* hub LEDs are probably harder to miss than syslog */
2874 if (hub->has_indicators) {
2875 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
2876 schedule_delayed_work (&hub->leds, 0);
2883 hub_power_remaining (struct usb_hub *hub)
2885 struct usb_device *hdev = hub->hdev;
2889 if (!hub->limited_power)
2892 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
2893 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
2894 struct usb_device *udev = hdev->children[port1 - 1];
2900 /* Unconfigured devices may not use more than 100mA,
2901 * or 8mA for OTG ports */
2902 if (udev->actconfig)
2903 delta = udev->actconfig->desc.bMaxPower * 2;
2904 else if (port1 != udev->bus->otg_port || hdev->parent)
2908 if (delta > hub->mA_per_port)
2909 dev_warn(&udev->dev,
2910 "%dmA is over %umA budget for port %d!\n",
2911 delta, hub->mA_per_port, port1);
2914 if (remaining < 0) {
2915 dev_warn(hub->intfdev, "%dmA over power budget!\n",
2922 /* Handle physical or logical connection change events.
2923 * This routine is called when:
2924 * a port connection-change occurs;
2925 * a port enable-change occurs (often caused by EMI);
2926 * usb_reset_and_verify_device() encounters changed descriptors (as from
2927 * a firmware download)
2928 * caller already locked the hub
2930 static void hub_port_connect_change(struct usb_hub *hub, int port1,
2931 u16 portstatus, u16 portchange)
2933 struct usb_device *hdev = hub->hdev;
2934 struct device *hub_dev = hub->intfdev;
2935 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
2936 unsigned wHubCharacteristics =
2937 le16_to_cpu(hub->descriptor->wHubCharacteristics);
2938 struct usb_device *udev;
2942 "port %d, status %04x, change %04x, %s\n",
2943 port1, portstatus, portchange, portspeed (portstatus));
2945 if (hub->has_indicators) {
2946 set_port_led(hub, port1, HUB_LED_AUTO);
2947 hub->indicator[port1-1] = INDICATOR_AUTO;
2950 #ifdef CONFIG_USB_OTG
2951 /* during HNP, don't repeat the debounce */
2952 if (hdev->bus->is_b_host)
2953 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
2954 USB_PORT_STAT_C_ENABLE);
2957 /* Try to resuscitate an existing device */
2958 udev = hdev->children[port1-1];
2959 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
2960 udev->state != USB_STATE_NOTATTACHED) {
2961 usb_lock_device(udev);
2962 if (portstatus & USB_PORT_STAT_ENABLE) {
2963 status = 0; /* Nothing to do */
2965 #ifdef CONFIG_USB_SUSPEND
2966 } else if (udev->state == USB_STATE_SUSPENDED &&
2967 udev->persist_enabled) {
2968 /* For a suspended device, treat this as a
2969 * remote wakeup event.
2971 status = remote_wakeup(udev);
2975 status = -ENODEV; /* Don't resuscitate */
2977 usb_unlock_device(udev);
2980 clear_bit(port1, hub->change_bits);
2985 /* Disconnect any existing devices under this port */
2987 usb_disconnect(&hdev->children[port1-1]);
2988 clear_bit(port1, hub->change_bits);
2990 if (portchange & (USB_PORT_STAT_C_CONNECTION |
2991 USB_PORT_STAT_C_ENABLE)) {
2992 status = hub_port_debounce(hub, port1);
2994 if (printk_ratelimit())
2995 dev_err(hub_dev, "connect-debounce failed, "
2996 "port %d disabled\n", port1);
2997 portstatus &= ~USB_PORT_STAT_CONNECTION;
2999 portstatus = status;
3003 /* Return now if debouncing failed or nothing is connected */
3004 if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
3006 /* maybe switch power back on (e.g. root hub was reset) */
3007 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
3008 && !(portstatus & (1 << USB_PORT_FEAT_POWER)))
3009 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
3011 if (portstatus & USB_PORT_STAT_ENABLE)
3016 for (i = 0; i < SET_CONFIG_TRIES; i++) {
3018 /* reallocate for each attempt, since references
3019 * to the previous one can escape in various ways
3021 udev = usb_alloc_dev(hdev, hdev->bus, port1);
3024 "couldn't allocate port %d usb_device\n",
3029 usb_set_device_state(udev, USB_STATE_POWERED);
3030 udev->bus_mA = hub->mA_per_port;
3031 udev->level = hdev->level + 1;
3032 udev->wusb = hub_is_wusb(hub);
3035 * USB 3.0 devices are reset automatically before the connect
3036 * port status change appears, and the root hub port status
3037 * shows the correct speed. We also get port change
3038 * notifications for USB 3.0 devices from the USB 3.0 portion of
3039 * an external USB 3.0 hub, but this isn't handled correctly yet
3043 if (!(hcd->driver->flags & HCD_USB3))
3044 udev->speed = USB_SPEED_UNKNOWN;
3045 else if ((hdev->parent == NULL) &&
3046 (portstatus & (1 << USB_PORT_FEAT_SUPERSPEED)))
3047 udev->speed = USB_SPEED_SUPER;
3049 udev->speed = USB_SPEED_UNKNOWN;
3052 * xHCI needs to issue an address device command later
3053 * in the hub_port_init sequence for SS/HS/FS/LS devices.
3055 if (!(hcd->driver->flags & HCD_USB3)) {
3056 /* set the address */
3057 choose_address(udev);
3058 if (udev->devnum <= 0) {
3059 status = -ENOTCONN; /* Don't retry */
3064 /* reset (non-USB 3.0 devices) and get descriptor */
3065 status = hub_port_init(hub, udev, port1, i);
3069 usb_detect_quirks(udev);
3070 if (udev->quirks & USB_QUIRK_DELAY_INIT)
3073 /* consecutive bus-powered hubs aren't reliable; they can
3074 * violate the voltage drop budget. if the new child has
3075 * a "powered" LED, users should notice we didn't enable it
3076 * (without reading syslog), even without per-port LEDs
3079 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
3080 && udev->bus_mA <= 100) {
3083 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
3086 dev_dbg(&udev->dev, "get status %d ?\n", status);
3089 le16_to_cpus(&devstat);
3090 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
3092 "can't connect bus-powered hub "
3094 if (hub->has_indicators) {
3095 hub->indicator[port1-1] =
3096 INDICATOR_AMBER_BLINK;
3097 schedule_delayed_work (&hub->leds, 0);
3099 status = -ENOTCONN; /* Don't retry */
3104 /* check for devices running slower than they could */
3105 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
3106 && udev->speed == USB_SPEED_FULL
3107 && highspeed_hubs != 0)
3108 check_highspeed (hub, udev, port1);
3110 /* Store the parent's children[] pointer. At this point
3111 * udev becomes globally accessible, although presumably
3112 * no one will look at it until hdev is unlocked.
3116 /* We mustn't add new devices if the parent hub has
3117 * been disconnected; we would race with the
3118 * recursively_mark_NOTATTACHED() routine.
3120 spin_lock_irq(&device_state_lock);
3121 if (hdev->state == USB_STATE_NOTATTACHED)
3124 hdev->children[port1-1] = udev;
3125 spin_unlock_irq(&device_state_lock);
3127 /* Run it through the hoops (find a driver, etc) */
3129 status = usb_new_device(udev);
3131 spin_lock_irq(&device_state_lock);
3132 hdev->children[port1-1] = NULL;
3133 spin_unlock_irq(&device_state_lock);
3140 status = hub_power_remaining(hub);
3142 dev_dbg(hub_dev, "%dmA power budget left\n", status);
3147 hub_port_disable(hub, port1, 1);
3149 usb_ep0_reinit(udev);
3150 release_address(udev);
3153 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
3156 if (hub->hdev->parent ||
3157 !hcd->driver->port_handed_over ||
3158 !(hcd->driver->port_handed_over)(hcd, port1))
3159 dev_err(hub_dev, "unable to enumerate USB device on port %d\n",
3163 hub_port_disable(hub, port1, 1);
3164 if (hcd->driver->relinquish_port && !hub->hdev->parent)
3165 hcd->driver->relinquish_port(hcd, port1);
3168 static void hub_events(void)
3170 struct list_head *tmp;
3171 struct usb_device *hdev;
3172 struct usb_interface *intf;
3173 struct usb_hub *hub;
3174 struct device *hub_dev;
3183 * We restart the list every time to avoid a deadlock with
3184 * deleting hubs downstream from this one. This should be
3185 * safe since we delete the hub from the event list.
3186 * Not the most efficient, but avoids deadlocks.
3190 /* Grab the first entry at the beginning of the list */
3191 spin_lock_irq(&hub_event_lock);
3192 if (list_empty(&hub_event_list)) {
3193 spin_unlock_irq(&hub_event_lock);
3197 tmp = hub_event_list.next;
3200 hub = list_entry(tmp, struct usb_hub, event_list);
3201 kref_get(&hub->kref);
3202 spin_unlock_irq(&hub_event_lock);
3205 hub_dev = hub->intfdev;
3206 intf = to_usb_interface(hub_dev);
3207 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
3208 hdev->state, hub->descriptor
3209 ? hub->descriptor->bNbrPorts
3211 /* NOTE: expects max 15 ports... */
3212 (u16) hub->change_bits[0],
3213 (u16) hub->event_bits[0]);
3215 /* Lock the device, then check to see if we were
3216 * disconnected while waiting for the lock to succeed. */
3217 usb_lock_device(hdev);
3218 if (unlikely(hub->disconnected))
3221 /* If the hub has died, clean up after it */
3222 if (hdev->state == USB_STATE_NOTATTACHED) {
3223 hub->error = -ENODEV;
3224 hub_quiesce(hub, HUB_DISCONNECT);
3229 ret = usb_autopm_get_interface(intf);
3231 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
3235 /* If this is an inactive hub, do nothing */
3240 dev_dbg (hub_dev, "resetting for error %d\n",
3243 ret = usb_reset_device(hdev);
3246 "error resetting hub: %d\n", ret);
3254 /* deal with port status changes */
3255 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
3256 if (test_bit(i, hub->busy_bits))
3258 connect_change = test_bit(i, hub->change_bits);
3259 if (!test_and_clear_bit(i, hub->event_bits) &&
3263 ret = hub_port_status(hub, i,
3264 &portstatus, &portchange);
3268 if (portchange & USB_PORT_STAT_C_CONNECTION) {
3269 clear_port_feature(hdev, i,
3270 USB_PORT_FEAT_C_CONNECTION);
3274 if (portchange & USB_PORT_STAT_C_ENABLE) {
3275 if (!connect_change)
3277 "port %d enable change, "
3280 clear_port_feature(hdev, i,
3281 USB_PORT_FEAT_C_ENABLE);
3284 * EM interference sometimes causes badly
3285 * shielded USB devices to be shutdown by
3286 * the hub, this hack enables them again.
3287 * Works at least with mouse driver.
3289 if (!(portstatus & USB_PORT_STAT_ENABLE)
3291 && hdev->children[i-1]) {
3294 "disabled by hub (EMI?), "
3301 if (portchange & USB_PORT_STAT_C_SUSPEND) {
3302 struct usb_device *udev;
3304 clear_port_feature(hdev, i,
3305 USB_PORT_FEAT_C_SUSPEND);
3306 udev = hdev->children[i-1];
3308 /* TRSMRCY = 10 msec */
3311 usb_lock_device(udev);
3312 ret = remote_wakeup(hdev->
3314 usb_unlock_device(udev);
3319 hub_port_disable(hub, i, 1);
3322 "resume on port %d, status %d\n",
3326 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
3328 "over-current change on port %d\n",
3330 clear_port_feature(hdev, i,
3331 USB_PORT_FEAT_C_OVER_CURRENT);
3332 hub_power_on(hub, true);
3335 if (portchange & USB_PORT_STAT_C_RESET) {
3337 "reset change on port %d\n",
3339 clear_port_feature(hdev, i,
3340 USB_PORT_FEAT_C_RESET);
3344 hub_port_connect_change(hub, i,
3345 portstatus, portchange);
3348 /* deal with hub status changes */
3349 if (test_and_clear_bit(0, hub->event_bits) == 0)
3351 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
3352 dev_err (hub_dev, "get_hub_status failed\n");
3354 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
3355 dev_dbg (hub_dev, "power change\n");
3356 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
3357 if (hubstatus & HUB_STATUS_LOCAL_POWER)
3358 /* FIXME: Is this always true? */
3359 hub->limited_power = 1;
3361 hub->limited_power = 0;
3363 if (hubchange & HUB_CHANGE_OVERCURRENT) {
3364 dev_dbg (hub_dev, "overcurrent change\n");
3365 msleep(500); /* Cool down */
3366 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
3367 hub_power_on(hub, true);
3372 /* Allow autosuspend if we're not going to run again */
3373 if (list_empty(&hub->event_list))
3374 usb_autopm_enable(intf);
3376 usb_unlock_device(hdev);
3377 kref_put(&hub->kref, hub_release);
3379 } /* end while (1) */
3382 static int hub_thread(void *__unused)
3384 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
3385 * port handover. Otherwise it might see that a full-speed device
3386 * was gone before the EHCI controller had handed its port over to
3387 * the companion full-speed controller.
3393 wait_event_freezable(khubd_wait,
3394 !list_empty(&hub_event_list) ||
3395 kthread_should_stop());
3396 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
3398 pr_debug("%s: khubd exiting\n", usbcore_name);
3402 static struct usb_device_id hub_id_table [] = {
3403 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
3404 .bDeviceClass = USB_CLASS_HUB},
3405 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
3406 .bInterfaceClass = USB_CLASS_HUB},
3407 { } /* Terminating entry */
3410 MODULE_DEVICE_TABLE (usb, hub_id_table);
3412 static struct usb_driver hub_driver = {
3415 .disconnect = hub_disconnect,
3416 .suspend = hub_suspend,
3417 .resume = hub_resume,
3418 .reset_resume = hub_reset_resume,
3419 .pre_reset = hub_pre_reset,
3420 .post_reset = hub_post_reset,
3422 .id_table = hub_id_table,
3423 .supports_autosuspend = 1,
3426 int usb_hub_init(void)
3428 if (usb_register(&hub_driver) < 0) {
3429 printk(KERN_ERR "%s: can't register hub driver\n",
3434 khubd_task = kthread_run(hub_thread, NULL, "khubd");
3435 if (!IS_ERR(khubd_task))
3438 /* Fall through if kernel_thread failed */
3439 usb_deregister(&hub_driver);
3440 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
3445 void usb_hub_cleanup(void)
3447 kthread_stop(khubd_task);
3450 * Hub resources are freed for us by usb_deregister. It calls
3451 * usb_driver_purge on every device which in turn calls that
3452 * devices disconnect function if it is using this driver.
3453 * The hub_disconnect function takes care of releasing the
3454 * individual hub resources. -greg
3456 usb_deregister(&hub_driver);
3457 } /* usb_hub_cleanup() */
3459 static int descriptors_changed(struct usb_device *udev,
3460 struct usb_device_descriptor *old_device_descriptor)
3464 unsigned serial_len = 0;
3466 unsigned old_length;
3470 if (memcmp(&udev->descriptor, old_device_descriptor,
3471 sizeof(*old_device_descriptor)) != 0)
3474 /* Since the idVendor, idProduct, and bcdDevice values in the
3475 * device descriptor haven't changed, we will assume the
3476 * Manufacturer and Product strings haven't changed either.
3477 * But the SerialNumber string could be different (e.g., a
3478 * different flash card of the same brand).
3481 serial_len = strlen(udev->serial) + 1;
3484 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3485 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3486 len = max(len, old_length);
3489 buf = kmalloc(len, GFP_NOIO);
3491 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
3492 /* assume the worst */
3495 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3496 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3497 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
3499 if (length != old_length) {
3500 dev_dbg(&udev->dev, "config index %d, error %d\n",
3505 if (memcmp (buf, udev->rawdescriptors[index], old_length)
3507 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
3509 ((struct usb_config_descriptor *) buf)->
3510 bConfigurationValue);
3516 if (!changed && serial_len) {
3517 length = usb_string(udev, udev->descriptor.iSerialNumber,
3519 if (length + 1 != serial_len) {
3520 dev_dbg(&udev->dev, "serial string error %d\n",
3523 } else if (memcmp(buf, udev->serial, length) != 0) {
3524 dev_dbg(&udev->dev, "serial string changed\n");
3534 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
3535 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3537 * WARNING - don't use this routine to reset a composite device
3538 * (one with multiple interfaces owned by separate drivers)!
3539 * Use usb_reset_device() instead.
3541 * Do a port reset, reassign the device's address, and establish its
3542 * former operating configuration. If the reset fails, or the device's
3543 * descriptors change from their values before the reset, or the original
3544 * configuration and altsettings cannot be restored, a flag will be set
3545 * telling khubd to pretend the device has been disconnected and then
3546 * re-connected. All drivers will be unbound, and the device will be
3547 * re-enumerated and probed all over again.
3549 * Returns 0 if the reset succeeded, -ENODEV if the device has been
3550 * flagged for logical disconnection, or some other negative error code
3551 * if the reset wasn't even attempted.
3553 * The caller must own the device lock. For example, it's safe to use
3554 * this from a driver probe() routine after downloading new firmware.
3555 * For calls that might not occur during probe(), drivers should lock
3556 * the device using usb_lock_device_for_reset().
3558 * Locking exception: This routine may also be called from within an
3559 * autoresume handler. Such usage won't conflict with other tasks
3560 * holding the device lock because these tasks should always call
3561 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
3563 static int usb_reset_and_verify_device(struct usb_device *udev)
3565 struct usb_device *parent_hdev = udev->parent;
3566 struct usb_hub *parent_hub;
3567 struct usb_device_descriptor descriptor = udev->descriptor;
3569 int port1 = udev->portnum;
3571 if (udev->state == USB_STATE_NOTATTACHED ||
3572 udev->state == USB_STATE_SUSPENDED) {
3573 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3579 /* this requires hcd-specific logic; see OHCI hc_restart() */
3580 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
3583 parent_hub = hdev_to_hub(parent_hdev);
3585 set_bit(port1, parent_hub->busy_bits);
3586 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
3588 /* ep0 maxpacket size may change; let the HCD know about it.
3589 * Other endpoints will be handled by re-enumeration. */
3590 usb_ep0_reinit(udev);
3591 ret = hub_port_init(parent_hub, udev, port1, i);
3592 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
3595 clear_bit(port1, parent_hub->busy_bits);
3600 /* Device might have changed firmware (DFU or similar) */
3601 if (descriptors_changed(udev, &descriptor)) {
3602 dev_info(&udev->dev, "device firmware changed\n");
3603 udev->descriptor = descriptor; /* for disconnect() calls */
3607 /* Restore the device's previous configuration */
3608 if (!udev->actconfig)
3610 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3611 USB_REQ_SET_CONFIGURATION, 0,
3612 udev->actconfig->desc.bConfigurationValue, 0,
3613 NULL, 0, USB_CTRL_SET_TIMEOUT);
3616 "can't restore configuration #%d (error=%d)\n",
3617 udev->actconfig->desc.bConfigurationValue, ret);
3620 usb_set_device_state(udev, USB_STATE_CONFIGURED);
3622 /* Put interfaces back into the same altsettings as before.
3623 * Don't bother to send the Set-Interface request for interfaces
3624 * that were already in altsetting 0; besides being unnecessary,
3625 * many devices can't handle it. Instead just reset the host-side
3628 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
3629 struct usb_interface *intf = udev->actconfig->interface[i];
3630 struct usb_interface_descriptor *desc;
3632 desc = &intf->cur_altsetting->desc;
3633 if (desc->bAlternateSetting == 0) {
3634 usb_disable_interface(udev, intf, true);
3635 usb_enable_interface(udev, intf, true);
3638 ret = usb_set_interface(udev, desc->bInterfaceNumber,
3639 desc->bAlternateSetting);
3642 dev_err(&udev->dev, "failed to restore interface %d "
3643 "altsetting %d (error=%d)\n",
3644 desc->bInterfaceNumber,
3645 desc->bAlternateSetting,
3655 hub_port_logical_disconnect(parent_hub, port1);
3660 * usb_reset_device - warn interface drivers and perform a USB port reset
3661 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3663 * Warns all drivers bound to registered interfaces (using their pre_reset
3664 * method), performs the port reset, and then lets the drivers know that
3665 * the reset is over (using their post_reset method).
3667 * Return value is the same as for usb_reset_and_verify_device().
3669 * The caller must own the device lock. For example, it's safe to use
3670 * this from a driver probe() routine after downloading new firmware.
3671 * For calls that might not occur during probe(), drivers should lock
3672 * the device using usb_lock_device_for_reset().
3674 * If an interface is currently being probed or disconnected, we assume
3675 * its driver knows how to handle resets. For all other interfaces,
3676 * if the driver doesn't have pre_reset and post_reset methods then
3677 * we attempt to unbind it and rebind afterward.
3679 int usb_reset_device(struct usb_device *udev)
3683 struct usb_host_config *config = udev->actconfig;
3685 if (udev->state == USB_STATE_NOTATTACHED ||
3686 udev->state == USB_STATE_SUSPENDED) {
3687 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3692 /* Prevent autosuspend during the reset */
3693 usb_autoresume_device(udev);
3696 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
3697 struct usb_interface *cintf = config->interface[i];
3698 struct usb_driver *drv;
3701 if (cintf->dev.driver) {
3702 drv = to_usb_driver(cintf->dev.driver);
3703 if (drv->pre_reset && drv->post_reset)
3704 unbind = (drv->pre_reset)(cintf);
3705 else if (cintf->condition ==
3706 USB_INTERFACE_BOUND)
3709 usb_forced_unbind_intf(cintf);
3714 ret = usb_reset_and_verify_device(udev);
3717 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
3718 struct usb_interface *cintf = config->interface[i];
3719 struct usb_driver *drv;
3720 int rebind = cintf->needs_binding;
3722 if (!rebind && cintf->dev.driver) {
3723 drv = to_usb_driver(cintf->dev.driver);
3724 if (drv->post_reset)
3725 rebind = (drv->post_reset)(cintf);
3726 else if (cintf->condition ==
3727 USB_INTERFACE_BOUND)
3730 if (ret == 0 && rebind)
3731 usb_rebind_intf(cintf);
3735 usb_autosuspend_device(udev);
3738 EXPORT_SYMBOL_GPL(usb_reset_device);
3742 * usb_queue_reset_device - Reset a USB device from an atomic context
3743 * @iface: USB interface belonging to the device to reset
3745 * This function can be used to reset a USB device from an atomic
3746 * context, where usb_reset_device() won't work (as it blocks).
3748 * Doing a reset via this method is functionally equivalent to calling
3749 * usb_reset_device(), except for the fact that it is delayed to a
3750 * workqueue. This means that any drivers bound to other interfaces
3751 * might be unbound, as well as users from usbfs in user space.
3755 * - Scheduling two resets at the same time from two different drivers
3756 * attached to two different interfaces of the same device is
3757 * possible; depending on how the driver attached to each interface
3758 * handles ->pre_reset(), the second reset might happen or not.
3760 * - If a driver is unbound and it had a pending reset, the reset will
3763 * - This function can be called during .probe() or .disconnect()
3764 * times. On return from .disconnect(), any pending resets will be
3767 * There is no no need to lock/unlock the @reset_ws as schedule_work()
3770 * NOTE: We don't do any reference count tracking because it is not
3771 * needed. The lifecycle of the work_struct is tied to the
3772 * usb_interface. Before destroying the interface we cancel the
3773 * work_struct, so the fact that work_struct is queued and or
3774 * running means the interface (and thus, the device) exist and
3777 void usb_queue_reset_device(struct usb_interface *iface)
3779 schedule_work(&iface->reset_ws);
3781 EXPORT_SYMBOL_GPL(usb_queue_reset_device);