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/smp_lock.h>
20 #include <linux/ioctl.h>
21 #include <linux/usb.h>
22 #include <linux/usbdevice_fs.h>
23 #include <linux/kthread.h>
24 #include <linux/mutex.h>
26 #include <asm/semaphore.h>
27 #include <asm/uaccess.h>
28 #include <asm/byteorder.h>
35 struct device *intfdev; /* the "interface" device */
36 struct usb_device *hdev;
37 struct urb *urb; /* for interrupt polling pipe */
39 /* buffer for urb ... with extra space in case of babble */
41 dma_addr_t buffer_dma; /* DMA address for buffer */
43 struct usb_hub_status hub;
44 struct usb_port_status port;
45 } *status; /* buffer for status reports */
47 int error; /* last reported error */
48 int nerrors; /* track consecutive errors */
50 struct list_head event_list; /* hubs w/data or errs ready */
51 unsigned long event_bits[1]; /* status change bitmask */
52 unsigned long change_bits[1]; /* ports with logical connect
54 unsigned long busy_bits[1]; /* ports being reset or
56 #if USB_MAXCHILDREN > 31 /* 8*sizeof(unsigned long) - 1 */
57 #error event_bits[] is too short!
60 struct usb_hub_descriptor *descriptor; /* class descriptor */
61 struct usb_tt tt; /* Transaction Translator */
63 unsigned mA_per_port; /* current for each child */
65 unsigned limited_power:1;
67 unsigned activating:1;
68 unsigned resume_root_hub:1;
70 unsigned has_indicators:1;
71 u8 indicator[USB_MAXCHILDREN];
72 struct work_struct leds;
76 /* Protect struct usb_device->state and ->children members
77 * Note: Both are also protected by ->dev.sem, except that ->state can
78 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
79 static DEFINE_SPINLOCK(device_state_lock);
81 /* khubd's worklist and its lock */
82 static DEFINE_SPINLOCK(hub_event_lock);
83 static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
86 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
88 static struct task_struct *khubd_task;
90 /* multithreaded probe logic */
91 static int multithread_probe =
92 #ifdef CONFIG_USB_MULTITHREAD_PROBE
97 module_param(multithread_probe, bool, S_IRUGO);
98 MODULE_PARM_DESC(multithread_probe, "Run each USB device probe in a new thread");
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 * As of 2.6.10 we introduce a new USB device initialization scheme which
107 * closely resembles the way Windows works. Hopefully it will be compatible
108 * with a wider range of devices than the old scheme. However some previously
109 * working devices may start giving rise to "device not accepting address"
110 * errors; if that happens the user can try the old scheme by adjusting the
111 * following module parameters.
113 * For maximum flexibility there are two boolean parameters to control the
114 * hub driver's behavior. On the first initialization attempt, if the
115 * "old_scheme_first" parameter is set then the old scheme will be used,
116 * otherwise the new scheme is used. If that fails and "use_both_schemes"
117 * is set, then the driver will make another attempt, using the other scheme.
119 static int old_scheme_first = 0;
120 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
121 MODULE_PARM_DESC(old_scheme_first,
122 "start with the old device initialization scheme");
124 static int use_both_schemes = 1;
125 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
126 MODULE_PARM_DESC(use_both_schemes,
127 "try the other device initialization scheme if the "
132 static inline char *portspeed (int portstatus)
134 if (portstatus & (1 << USB_PORT_FEAT_HIGHSPEED))
136 else if (portstatus & (1 << USB_PORT_FEAT_LOWSPEED))
143 /* Note that hdev or one of its children must be locked! */
144 static inline struct usb_hub *hdev_to_hub(struct usb_device *hdev)
146 return usb_get_intfdata(hdev->actconfig->interface[0]);
149 /* USB 2.0 spec Section 11.24.4.5 */
150 static int get_hub_descriptor(struct usb_device *hdev, void *data, int size)
154 for (i = 0; i < 3; i++) {
155 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
156 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
157 USB_DT_HUB << 8, 0, data, size,
158 USB_CTRL_GET_TIMEOUT);
159 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
166 * USB 2.0 spec Section 11.24.2.1
168 static int clear_hub_feature(struct usb_device *hdev, int feature)
170 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
171 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
175 * USB 2.0 spec Section 11.24.2.2
177 static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
179 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
180 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
185 * USB 2.0 spec Section 11.24.2.13
187 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
189 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
190 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
195 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
196 * for info about using port indicators
198 static void set_port_led(
204 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
205 USB_PORT_FEAT_INDICATOR);
207 dev_dbg (hub->intfdev,
208 "port %d indicator %s status %d\n",
210 ({ char *s; switch (selector) {
211 case HUB_LED_AMBER: s = "amber"; break;
212 case HUB_LED_GREEN: s = "green"; break;
213 case HUB_LED_OFF: s = "off"; break;
214 case HUB_LED_AUTO: s = "auto"; break;
215 default: s = "??"; break;
220 #define LED_CYCLE_PERIOD ((2*HZ)/3)
222 static void led_work (void *__hub)
224 struct usb_hub *hub = __hub;
225 struct usb_device *hdev = hub->hdev;
227 unsigned changed = 0;
230 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
233 for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
234 unsigned selector, mode;
236 /* 30%-50% duty cycle */
238 switch (hub->indicator[i]) {
240 case INDICATOR_CYCLE:
242 selector = HUB_LED_AUTO;
243 mode = INDICATOR_AUTO;
245 /* blinking green = sw attention */
246 case INDICATOR_GREEN_BLINK:
247 selector = HUB_LED_GREEN;
248 mode = INDICATOR_GREEN_BLINK_OFF;
250 case INDICATOR_GREEN_BLINK_OFF:
251 selector = HUB_LED_OFF;
252 mode = INDICATOR_GREEN_BLINK;
254 /* blinking amber = hw attention */
255 case INDICATOR_AMBER_BLINK:
256 selector = HUB_LED_AMBER;
257 mode = INDICATOR_AMBER_BLINK_OFF;
259 case INDICATOR_AMBER_BLINK_OFF:
260 selector = HUB_LED_OFF;
261 mode = INDICATOR_AMBER_BLINK;
263 /* blink green/amber = reserved */
264 case INDICATOR_ALT_BLINK:
265 selector = HUB_LED_GREEN;
266 mode = INDICATOR_ALT_BLINK_OFF;
268 case INDICATOR_ALT_BLINK_OFF:
269 selector = HUB_LED_AMBER;
270 mode = INDICATOR_ALT_BLINK;
275 if (selector != HUB_LED_AUTO)
277 set_port_led(hub, i + 1, selector);
278 hub->indicator[i] = mode;
280 if (!changed && blinkenlights) {
282 cursor %= hub->descriptor->bNbrPorts;
283 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
284 hub->indicator[cursor] = INDICATOR_CYCLE;
288 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
291 /* use a short timeout for hub/port status fetches */
292 #define USB_STS_TIMEOUT 1000
293 #define USB_STS_RETRIES 5
296 * USB 2.0 spec Section 11.24.2.6
298 static int get_hub_status(struct usb_device *hdev,
299 struct usb_hub_status *data)
301 int i, status = -ETIMEDOUT;
303 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
304 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
305 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
306 data, sizeof(*data), USB_STS_TIMEOUT);
312 * USB 2.0 spec Section 11.24.2.7
314 static int get_port_status(struct usb_device *hdev, int port1,
315 struct usb_port_status *data)
317 int i, status = -ETIMEDOUT;
319 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
320 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
321 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
322 data, sizeof(*data), USB_STS_TIMEOUT);
327 static void kick_khubd(struct usb_hub *hub)
331 spin_lock_irqsave(&hub_event_lock, flags);
332 if (list_empty(&hub->event_list)) {
333 list_add_tail(&hub->event_list, &hub_event_list);
334 wake_up(&khubd_wait);
336 spin_unlock_irqrestore(&hub_event_lock, flags);
339 void usb_kick_khubd(struct usb_device *hdev)
341 kick_khubd(hdev_to_hub(hdev));
345 /* completion function, fires on port status changes and various faults */
346 static void hub_irq(struct urb *urb)
348 struct usb_hub *hub = urb->context;
353 switch (urb->status) {
354 case -ENOENT: /* synchronous unlink */
355 case -ECONNRESET: /* async unlink */
356 case -ESHUTDOWN: /* hardware going away */
359 default: /* presumably an error */
360 /* Cause a hub reset after 10 consecutive errors */
361 dev_dbg (hub->intfdev, "transfer --> %d\n", urb->status);
362 if ((++hub->nerrors < 10) || hub->error)
364 hub->error = urb->status;
367 /* let khubd handle things */
368 case 0: /* we got data: port status changed */
370 for (i = 0; i < urb->actual_length; ++i)
371 bits |= ((unsigned long) ((*hub->buffer)[i]))
373 hub->event_bits[0] = bits;
379 /* Something happened, let khubd figure it out */
386 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
387 && status != -ENODEV && status != -EPERM)
388 dev_err (hub->intfdev, "resubmit --> %d\n", status);
391 /* USB 2.0 spec Section 11.24.2.3 */
393 hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
395 return usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
396 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
401 * enumeration blocks khubd for a long time. we use keventd instead, since
402 * long blocking there is the exception, not the rule. accordingly, HCDs
403 * talking to TTs must queue control transfers (not just bulk and iso), so
404 * both can talk to the same hub concurrently.
406 static void hub_tt_kevent (void *arg)
408 struct usb_hub *hub = arg;
411 spin_lock_irqsave (&hub->tt.lock, flags);
412 while (!list_empty (&hub->tt.clear_list)) {
413 struct list_head *temp;
414 struct usb_tt_clear *clear;
415 struct usb_device *hdev = hub->hdev;
418 temp = hub->tt.clear_list.next;
419 clear = list_entry (temp, struct usb_tt_clear, clear_list);
420 list_del (&clear->clear_list);
422 /* drop lock so HCD can concurrently report other TT errors */
423 spin_unlock_irqrestore (&hub->tt.lock, flags);
424 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
425 spin_lock_irqsave (&hub->tt.lock, flags);
429 "clear tt %d (%04x) error %d\n",
430 clear->tt, clear->devinfo, status);
433 spin_unlock_irqrestore (&hub->tt.lock, flags);
437 * usb_hub_tt_clear_buffer - clear control/bulk TT state in high speed hub
438 * @udev: the device whose split transaction failed
439 * @pipe: identifies the endpoint of the failed transaction
441 * High speed HCDs use this to tell the hub driver that some split control or
442 * bulk transaction failed in a way that requires clearing internal state of
443 * a transaction translator. This is normally detected (and reported) from
446 * It may not be possible for that hub to handle additional full (or low)
447 * speed transactions until that state is fully cleared out.
449 void usb_hub_tt_clear_buffer (struct usb_device *udev, int pipe)
451 struct usb_tt *tt = udev->tt;
453 struct usb_tt_clear *clear;
455 /* we've got to cope with an arbitrary number of pending TT clears,
456 * since each TT has "at least two" buffers that can need it (and
457 * there can be many TTs per hub). even if they're uncommon.
459 if ((clear = kmalloc (sizeof *clear, SLAB_ATOMIC)) == NULL) {
460 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
461 /* FIXME recover somehow ... RESET_TT? */
465 /* info that CLEAR_TT_BUFFER needs */
466 clear->tt = tt->multi ? udev->ttport : 1;
467 clear->devinfo = usb_pipeendpoint (pipe);
468 clear->devinfo |= udev->devnum << 4;
469 clear->devinfo |= usb_pipecontrol (pipe)
470 ? (USB_ENDPOINT_XFER_CONTROL << 11)
471 : (USB_ENDPOINT_XFER_BULK << 11);
472 if (usb_pipein (pipe))
473 clear->devinfo |= 1 << 15;
475 /* tell keventd to clear state for this TT */
476 spin_lock_irqsave (&tt->lock, flags);
477 list_add_tail (&clear->clear_list, &tt->clear_list);
478 schedule_work (&tt->kevent);
479 spin_unlock_irqrestore (&tt->lock, flags);
482 static void hub_power_on(struct usb_hub *hub)
485 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
486 u16 wHubCharacteristics =
487 le16_to_cpu(hub->descriptor->wHubCharacteristics);
489 /* Enable power on each port. Some hubs have reserved values
490 * of LPSM (> 2) in their descriptors, even though they are
491 * USB 2.0 hubs. Some hubs do not implement port-power switching
492 * but only emulate it. In all cases, the ports won't work
493 * unless we send these messages to the hub.
495 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
496 dev_dbg(hub->intfdev, "enabling power on all ports\n");
498 dev_dbg(hub->intfdev, "trying to enable port power on "
499 "non-switchable hub\n");
500 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
501 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
503 /* Wait at least 100 msec for power to become stable */
504 msleep(max(pgood_delay, (unsigned) 100));
507 static void hub_quiesce(struct usb_hub *hub)
509 /* (nonblocking) khubd and related activity won't re-trigger */
512 hub->resume_root_hub = 0;
514 /* (blocking) stop khubd and related activity */
515 usb_kill_urb(hub->urb);
516 if (hub->has_indicators)
517 cancel_delayed_work(&hub->leds);
518 if (hub->has_indicators || hub->tt.hub)
519 flush_scheduled_work();
522 static void hub_activate(struct usb_hub *hub)
528 hub->resume_root_hub = 0;
529 status = usb_submit_urb(hub->urb, GFP_NOIO);
531 dev_err(hub->intfdev, "activate --> %d\n", status);
532 if (hub->has_indicators && blinkenlights)
533 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
535 /* scan all ports ASAP */
539 static int hub_hub_status(struct usb_hub *hub,
540 u16 *status, u16 *change)
544 ret = get_hub_status(hub->hdev, &hub->status->hub);
546 dev_err (hub->intfdev,
547 "%s failed (err = %d)\n", __FUNCTION__, ret);
549 *status = le16_to_cpu(hub->status->hub.wHubStatus);
550 *change = le16_to_cpu(hub->status->hub.wHubChange);
556 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
558 struct usb_device *hdev = hub->hdev;
561 if (hdev->children[port1-1] && set_state) {
562 usb_set_device_state(hdev->children[port1-1],
563 USB_STATE_NOTATTACHED);
565 ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
567 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
574 /* caller has locked the hub device */
575 static void hub_pre_reset(struct usb_interface *intf)
577 struct usb_hub *hub = usb_get_intfdata(intf);
578 struct usb_device *hdev = hub->hdev;
581 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
582 if (hdev->children[port1 - 1]) {
583 usb_disconnect(&hdev->children[port1 - 1]);
585 hub_port_disable(hub, port1, 0);
591 /* caller has locked the hub device */
592 static void hub_post_reset(struct usb_interface *intf)
594 struct usb_hub *hub = usb_get_intfdata(intf);
601 static int hub_configure(struct usb_hub *hub,
602 struct usb_endpoint_descriptor *endpoint)
604 struct usb_device *hdev = hub->hdev;
605 struct device *hub_dev = hub->intfdev;
606 u16 hubstatus, hubchange;
607 u16 wHubCharacteristics;
612 hub->buffer = usb_buffer_alloc(hdev, sizeof(*hub->buffer), GFP_KERNEL,
615 message = "can't allocate hub irq buffer";
620 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
622 message = "can't kmalloc hub status buffer";
627 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
628 if (!hub->descriptor) {
629 message = "can't kmalloc hub descriptor";
634 /* Request the entire hub descriptor.
635 * hub->descriptor can handle USB_MAXCHILDREN ports,
636 * but the hub can/will return fewer bytes here.
638 ret = get_hub_descriptor(hdev, hub->descriptor,
639 sizeof(*hub->descriptor));
641 message = "can't read hub descriptor";
643 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
644 message = "hub has too many ports!";
649 hdev->maxchild = hub->descriptor->bNbrPorts;
650 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
651 (hdev->maxchild == 1) ? "" : "s");
653 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
655 if (wHubCharacteristics & HUB_CHAR_COMPOUND) {
657 char portstr [USB_MAXCHILDREN + 1];
659 for (i = 0; i < hdev->maxchild; i++)
660 portstr[i] = hub->descriptor->DeviceRemovable
661 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
663 portstr[hdev->maxchild] = 0;
664 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
666 dev_dbg(hub_dev, "standalone hub\n");
668 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
670 dev_dbg(hub_dev, "ganged power switching\n");
673 dev_dbg(hub_dev, "individual port power switching\n");
677 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
681 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
683 dev_dbg(hub_dev, "global over-current protection\n");
686 dev_dbg(hub_dev, "individual port over-current protection\n");
690 dev_dbg(hub_dev, "no over-current protection\n");
694 spin_lock_init (&hub->tt.lock);
695 INIT_LIST_HEAD (&hub->tt.clear_list);
696 INIT_WORK (&hub->tt.kevent, hub_tt_kevent, hub);
697 switch (hdev->descriptor.bDeviceProtocol) {
701 dev_dbg(hub_dev, "Single TT\n");
705 ret = usb_set_interface(hdev, 0, 1);
707 dev_dbg(hub_dev, "TT per port\n");
710 dev_err(hub_dev, "Using single TT (err %d)\n",
715 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
716 hdev->descriptor.bDeviceProtocol);
720 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
721 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
722 case HUB_TTTT_8_BITS:
723 if (hdev->descriptor.bDeviceProtocol != 0) {
724 hub->tt.think_time = 666;
725 dev_dbg(hub_dev, "TT requires at most %d "
726 "FS bit times (%d ns)\n",
727 8, hub->tt.think_time);
730 case HUB_TTTT_16_BITS:
731 hub->tt.think_time = 666 * 2;
732 dev_dbg(hub_dev, "TT requires at most %d "
733 "FS bit times (%d ns)\n",
734 16, hub->tt.think_time);
736 case HUB_TTTT_24_BITS:
737 hub->tt.think_time = 666 * 3;
738 dev_dbg(hub_dev, "TT requires at most %d "
739 "FS bit times (%d ns)\n",
740 24, hub->tt.think_time);
742 case HUB_TTTT_32_BITS:
743 hub->tt.think_time = 666 * 4;
744 dev_dbg(hub_dev, "TT requires at most %d "
745 "FS bit times (%d ns)\n",
746 32, hub->tt.think_time);
750 /* probe() zeroes hub->indicator[] */
751 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
752 hub->has_indicators = 1;
753 dev_dbg(hub_dev, "Port indicators are supported\n");
756 dev_dbg(hub_dev, "power on to power good time: %dms\n",
757 hub->descriptor->bPwrOn2PwrGood * 2);
759 /* power budgeting mostly matters with bus-powered hubs,
760 * and battery-powered root hubs (may provide just 8 mA).
762 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
764 message = "can't get hub status";
767 le16_to_cpus(&hubstatus);
768 if (hdev == hdev->bus->root_hub) {
769 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
770 hub->mA_per_port = 500;
772 hub->mA_per_port = hdev->bus_mA;
773 hub->limited_power = 1;
775 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
776 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
777 hub->descriptor->bHubContrCurrent);
778 hub->limited_power = 1;
779 if (hdev->maxchild > 0) {
780 int remaining = hdev->bus_mA -
781 hub->descriptor->bHubContrCurrent;
783 if (remaining < hdev->maxchild * 100)
785 "insufficient power available "
786 "to use all downstream ports\n");
787 hub->mA_per_port = 100; /* 7.2.1.1 */
789 } else { /* Self-powered external hub */
790 /* FIXME: What about battery-powered external hubs that
791 * provide less current per port? */
792 hub->mA_per_port = 500;
794 if (hub->mA_per_port < 500)
795 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
798 ret = hub_hub_status(hub, &hubstatus, &hubchange);
800 message = "can't get hub status";
804 /* local power status reports aren't always correct */
805 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
806 dev_dbg(hub_dev, "local power source is %s\n",
807 (hubstatus & HUB_STATUS_LOCAL_POWER)
808 ? "lost (inactive)" : "good");
810 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
811 dev_dbg(hub_dev, "%sover-current condition exists\n",
812 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
814 /* set up the interrupt endpoint
815 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
816 * bytes as USB2.0[11.12.3] says because some hubs are known
817 * to send more data (and thus cause overflow). For root hubs,
818 * maxpktsize is defined in hcd.c's fake endpoint descriptors
819 * to be big enough for at least USB_MAXCHILDREN ports. */
820 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
821 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
823 if (maxp > sizeof(*hub->buffer))
824 maxp = sizeof(*hub->buffer);
826 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
828 message = "couldn't allocate interrupt urb";
833 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
834 hub, endpoint->bInterval);
835 hub->urb->transfer_dma = hub->buffer_dma;
836 hub->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
838 /* maybe cycle the hub leds */
839 if (hub->has_indicators && blinkenlights)
840 hub->indicator [0] = INDICATOR_CYCLE;
847 dev_err (hub_dev, "config failed, %s (err %d)\n",
849 /* hub_disconnect() frees urb and descriptor */
853 static unsigned highspeed_hubs;
855 static void hub_disconnect(struct usb_interface *intf)
857 struct usb_hub *hub = usb_get_intfdata (intf);
858 struct usb_device *hdev;
860 /* Disconnect all children and quiesce the hub */
864 usb_set_intfdata (intf, NULL);
867 if (hdev->speed == USB_SPEED_HIGH)
870 usb_free_urb(hub->urb);
873 spin_lock_irq(&hub_event_lock);
874 list_del_init(&hub->event_list);
875 spin_unlock_irq(&hub_event_lock);
877 kfree(hub->descriptor);
878 hub->descriptor = NULL;
884 usb_buffer_free(hdev, sizeof(*hub->buffer), hub->buffer,
892 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
894 struct usb_host_interface *desc;
895 struct usb_endpoint_descriptor *endpoint;
896 struct usb_device *hdev;
899 desc = intf->cur_altsetting;
900 hdev = interface_to_usbdev(intf);
902 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
904 dev_warn(&intf->dev, "ignoring external hub\n");
909 /* Some hubs have a subclass of 1, which AFAICT according to the */
910 /* specs is not defined, but it works */
911 if ((desc->desc.bInterfaceSubClass != 0) &&
912 (desc->desc.bInterfaceSubClass != 1)) {
914 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
918 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
919 if (desc->desc.bNumEndpoints != 1)
920 goto descriptor_error;
922 endpoint = &desc->endpoint[0].desc;
924 /* If it's not an interrupt in endpoint, we'd better punt! */
925 if (!usb_endpoint_is_int_in(endpoint))
926 goto descriptor_error;
929 dev_info (&intf->dev, "USB hub found\n");
931 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
933 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
937 INIT_LIST_HEAD(&hub->event_list);
938 hub->intfdev = &intf->dev;
940 INIT_WORK(&hub->leds, led_work, hub);
942 usb_set_intfdata (intf, hub);
944 if (hdev->speed == USB_SPEED_HIGH)
947 if (hub_configure(hub, endpoint) >= 0)
950 hub_disconnect (intf);
955 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
957 struct usb_device *hdev = interface_to_usbdev (intf);
959 /* assert ifno == 0 (part of hub spec) */
961 case USBDEVFS_HUB_PORTINFO: {
962 struct usbdevfs_hub_portinfo *info = user_data;
965 spin_lock_irq(&device_state_lock);
966 if (hdev->devnum <= 0)
969 info->nports = hdev->maxchild;
970 for (i = 0; i < info->nports; i++) {
971 if (hdev->children[i] == NULL)
975 hdev->children[i]->devnum;
978 spin_unlock_irq(&device_state_lock);
980 return info->nports + 1;
989 /* grab device/port lock, returning index of that port (zero based).
990 * protects the upstream link used by this device from concurrent
991 * tree operations like suspend, resume, reset, and disconnect, which
992 * apply to everything downstream of a given port.
994 static int locktree(struct usb_device *udev)
997 struct usb_device *hdev;
1002 /* root hub is always the first lock in the series */
1003 hdev = udev->parent;
1005 usb_lock_device(udev);
1009 /* on the path from root to us, lock everything from
1010 * top down, dropping parent locks when not needed
1016 /* everything is fail-fast once disconnect
1019 if (udev->state == USB_STATE_NOTATTACHED) {
1020 usb_unlock_device(hdev);
1024 /* when everyone grabs locks top->bottom,
1025 * non-overlapping work may be concurrent
1027 usb_lock_device(udev);
1028 usb_unlock_device(hdev);
1029 return udev->portnum;
1032 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1036 for (i = 0; i < udev->maxchild; ++i) {
1037 if (udev->children[i])
1038 recursively_mark_NOTATTACHED(udev->children[i]);
1040 udev->state = USB_STATE_NOTATTACHED;
1044 * usb_set_device_state - change a device's current state (usbcore, hcds)
1045 * @udev: pointer to device whose state should be changed
1046 * @new_state: new state value to be stored
1048 * udev->state is _not_ fully protected by the device lock. Although
1049 * most transitions are made only while holding the lock, the state can
1050 * can change to USB_STATE_NOTATTACHED at almost any time. This
1051 * is so that devices can be marked as disconnected as soon as possible,
1052 * without having to wait for any semaphores to be released. As a result,
1053 * all changes to any device's state must be protected by the
1054 * device_state_lock spinlock.
1056 * Once a device has been added to the device tree, all changes to its state
1057 * should be made using this routine. The state should _not_ be set directly.
1059 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1060 * Otherwise udev->state is set to new_state, and if new_state is
1061 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1062 * to USB_STATE_NOTATTACHED.
1064 void usb_set_device_state(struct usb_device *udev,
1065 enum usb_device_state new_state)
1067 unsigned long flags;
1069 spin_lock_irqsave(&device_state_lock, flags);
1070 if (udev->state == USB_STATE_NOTATTACHED)
1072 else if (new_state != USB_STATE_NOTATTACHED) {
1074 /* root hub wakeup capabilities are managed out-of-band
1075 * and may involve silicon errata ... ignore them here.
1078 if (udev->state == USB_STATE_SUSPENDED
1079 || new_state == USB_STATE_SUSPENDED)
1080 ; /* No change to wakeup settings */
1081 else if (new_state == USB_STATE_CONFIGURED)
1082 device_init_wakeup(&udev->dev,
1083 (udev->actconfig->desc.bmAttributes
1084 & USB_CONFIG_ATT_WAKEUP));
1086 device_init_wakeup(&udev->dev, 0);
1088 udev->state = new_state;
1090 recursively_mark_NOTATTACHED(udev);
1091 spin_unlock_irqrestore(&device_state_lock, flags);
1098 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
1099 * @rhdev: struct usb_device for the root hub
1101 * The USB host controller driver calls this function when its root hub
1102 * is resumed and Vbus power has been interrupted or the controller
1103 * has been reset. The routine marks all the children of the root hub
1104 * as NOTATTACHED and marks logical connect-change events on their ports.
1106 void usb_root_hub_lost_power(struct usb_device *rhdev)
1108 struct usb_hub *hub;
1110 unsigned long flags;
1112 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
1114 /* Make sure no potential wakeup events get lost,
1115 * by forcing the root hub to be resumed.
1117 rhdev->dev.power.prev_state.event = PM_EVENT_ON;
1119 spin_lock_irqsave(&device_state_lock, flags);
1120 hub = hdev_to_hub(rhdev);
1121 for (port1 = 1; port1 <= rhdev->maxchild; ++port1) {
1122 if (rhdev->children[port1 - 1]) {
1123 recursively_mark_NOTATTACHED(
1124 rhdev->children[port1 - 1]);
1125 set_bit(port1, hub->change_bits);
1128 spin_unlock_irqrestore(&device_state_lock, flags);
1130 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
1132 #endif /* CONFIG_PM */
1134 static void choose_address(struct usb_device *udev)
1137 struct usb_bus *bus = udev->bus;
1139 /* If khubd ever becomes multithreaded, this will need a lock */
1141 /* Try to allocate the next devnum beginning at bus->devnum_next. */
1142 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1145 devnum = find_next_zero_bit(bus->devmap.devicemap, 128, 1);
1147 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1150 set_bit(devnum, bus->devmap.devicemap);
1151 udev->devnum = devnum;
1155 static void release_address(struct usb_device *udev)
1157 if (udev->devnum > 0) {
1158 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1164 * usb_disconnect - disconnect a device (usbcore-internal)
1165 * @pdev: pointer to device being disconnected
1166 * Context: !in_interrupt ()
1168 * Something got disconnected. Get rid of it and all of its children.
1170 * If *pdev is a normal device then the parent hub must already be locked.
1171 * If *pdev is a root hub then this routine will acquire the
1172 * usb_bus_list_lock on behalf of the caller.
1174 * Only hub drivers (including virtual root hub drivers for host
1175 * controllers) should ever call this.
1177 * This call is synchronous, and may not be used in an interrupt context.
1179 void usb_disconnect(struct usb_device **pdev)
1181 struct usb_device *udev = *pdev;
1185 pr_debug ("%s nodev\n", __FUNCTION__);
1189 /* mark the device as inactive, so any further urb submissions for
1190 * this device (and any of its children) will fail immediately.
1191 * this quiesces everyting except pending urbs.
1193 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1194 dev_info (&udev->dev, "USB disconnect, address %d\n", udev->devnum);
1196 usb_lock_device(udev);
1198 /* Free up all the children before we remove this device */
1199 for (i = 0; i < USB_MAXCHILDREN; i++) {
1200 if (udev->children[i])
1201 usb_disconnect(&udev->children[i]);
1204 /* deallocate hcd/hardware state ... nuking all pending urbs and
1205 * cleaning up all state associated with the current configuration
1206 * so that the hardware is now fully quiesced.
1208 dev_dbg (&udev->dev, "unregistering device\n");
1209 usb_disable_device(udev, 0);
1211 usb_unlock_device(udev);
1213 /* Unregister the device. The device driver is responsible
1214 * for removing the device files from usbfs and sysfs and for
1215 * de-configuring the device.
1217 device_del(&udev->dev);
1219 /* Free the device number and delete the parent's children[]
1220 * (or root_hub) pointer.
1222 release_address(udev);
1224 /* Avoid races with recursively_mark_NOTATTACHED() */
1225 spin_lock_irq(&device_state_lock);
1227 spin_unlock_irq(&device_state_lock);
1229 put_device(&udev->dev);
1233 static void show_string(struct usb_device *udev, char *id, char *string)
1237 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1241 static inline void show_string(struct usb_device *udev, char *id, char *string)
1246 #ifdef CONFIG_USB_OTG
1247 #include "otg_whitelist.h"
1248 static int __usb_port_suspend(struct usb_device *, int port1);
1251 static int __usb_new_device(void *void_data)
1253 struct usb_device *udev = void_data;
1256 /* Lock ourself into memory in order to keep a probe sequence
1257 * sleeping in a new thread from allowing us to be unloaded.
1259 if (!try_module_get(THIS_MODULE))
1262 err = usb_get_configuration(udev);
1264 dev_err(&udev->dev, "can't read configurations, error %d\n",
1269 /* read the standard strings and cache them if present */
1270 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1271 udev->manufacturer = usb_cache_string(udev,
1272 udev->descriptor.iManufacturer);
1273 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
1275 /* Tell the world! */
1276 dev_dbg(&udev->dev, "new device strings: Mfr=%d, Product=%d, "
1277 "SerialNumber=%d\n",
1278 udev->descriptor.iManufacturer,
1279 udev->descriptor.iProduct,
1280 udev->descriptor.iSerialNumber);
1281 show_string(udev, "Product", udev->product);
1282 show_string(udev, "Manufacturer", udev->manufacturer);
1283 show_string(udev, "SerialNumber", udev->serial);
1285 #ifdef CONFIG_USB_OTG
1287 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1288 * to wake us after we've powered off VBUS; and HNP, switching roles
1289 * "host" to "peripheral". The OTG descriptor helps figure this out.
1291 if (!udev->bus->is_b_host
1293 && udev->parent == udev->bus->root_hub) {
1294 struct usb_otg_descriptor *desc = 0;
1295 struct usb_bus *bus = udev->bus;
1297 /* descriptor may appear anywhere in config */
1298 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1299 le16_to_cpu(udev->config[0].desc.wTotalLength),
1300 USB_DT_OTG, (void **) &desc) == 0) {
1301 if (desc->bmAttributes & USB_OTG_HNP) {
1302 unsigned port1 = udev->portnum;
1304 dev_info(&udev->dev,
1305 "Dual-Role OTG device on %sHNP port\n",
1306 (port1 == bus->otg_port)
1309 /* enable HNP before suspend, it's simpler */
1310 if (port1 == bus->otg_port)
1311 bus->b_hnp_enable = 1;
1312 err = usb_control_msg(udev,
1313 usb_sndctrlpipe(udev, 0),
1314 USB_REQ_SET_FEATURE, 0,
1316 ? USB_DEVICE_B_HNP_ENABLE
1317 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1318 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1320 /* OTG MESSAGE: report errors here,
1321 * customize to match your product.
1323 dev_info(&udev->dev,
1324 "can't set HNP mode; %d\n",
1326 bus->b_hnp_enable = 0;
1332 if (!is_targeted(udev)) {
1334 /* Maybe it can talk to us, though we can't talk to it.
1335 * (Includes HNP test device.)
1337 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
1338 err = __usb_port_suspend(udev, udev->bus->otg_port);
1340 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1347 /* Register the device. The device driver is responsible
1348 * for adding the device files to usbfs and sysfs and for
1349 * configuring the device.
1351 err = device_add (&udev->dev);
1353 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1358 module_put(THIS_MODULE);
1362 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1367 * usb_new_device - perform initial device setup (usbcore-internal)
1368 * @udev: newly addressed device (in ADDRESS state)
1370 * This is called with devices which have been enumerated, but not yet
1371 * configured. The device descriptor is available, but not descriptors
1372 * for any device configuration. The caller must have locked either
1373 * the parent hub (if udev is a normal device) or else the
1374 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1375 * udev has already been installed, but udev is not yet visible through
1376 * sysfs or other filesystem code.
1378 * The return value for this function depends on if the
1379 * multithread_probe variable is set or not. If it's set, it will
1380 * return a if the probe thread was successfully created or not. If the
1381 * variable is not set, it will return if the device is configured
1382 * properly or not. interfaces, in sysfs); else a negative errno value.
1384 * This call is synchronous, and may not be used in an interrupt context.
1386 * Only the hub driver or root-hub registrar should ever call this.
1388 int usb_new_device(struct usb_device *udev)
1390 struct task_struct *probe_task;
1393 if (multithread_probe) {
1394 probe_task = kthread_run(__usb_new_device, udev,
1395 "usb-probe-%s", udev->devnum);
1396 if (IS_ERR(probe_task))
1397 ret = PTR_ERR(probe_task);
1399 ret = __usb_new_device(udev);
1404 static int hub_port_status(struct usb_hub *hub, int port1,
1405 u16 *status, u16 *change)
1409 ret = get_port_status(hub->hdev, port1, &hub->status->port);
1411 dev_err (hub->intfdev,
1412 "%s failed (err = %d)\n", __FUNCTION__, ret);
1414 *status = le16_to_cpu(hub->status->port.wPortStatus);
1415 *change = le16_to_cpu(hub->status->port.wPortChange);
1422 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
1423 static unsigned hub_is_wusb(struct usb_hub *hub)
1425 struct usb_hcd *hcd;
1426 if (hub->hdev->parent != NULL) /* not a root hub? */
1428 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
1429 return hcd->wireless;
1433 #define PORT_RESET_TRIES 5
1434 #define SET_ADDRESS_TRIES 2
1435 #define GET_DESCRIPTOR_TRIES 2
1436 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1437 #define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1439 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1440 #define HUB_SHORT_RESET_TIME 10
1441 #define HUB_LONG_RESET_TIME 200
1442 #define HUB_RESET_TIMEOUT 500
1444 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
1445 struct usb_device *udev, unsigned int delay)
1447 int delay_time, ret;
1451 for (delay_time = 0;
1452 delay_time < HUB_RESET_TIMEOUT;
1453 delay_time += delay) {
1454 /* wait to give the device a chance to reset */
1457 /* read and decode port status */
1458 ret = hub_port_status(hub, port1, &portstatus, &portchange);
1462 /* Device went away? */
1463 if (!(portstatus & USB_PORT_STAT_CONNECTION))
1466 /* bomb out completely if something weird happened */
1467 if ((portchange & USB_PORT_STAT_C_CONNECTION))
1470 /* if we`ve finished resetting, then break out of the loop */
1471 if (!(portstatus & USB_PORT_STAT_RESET) &&
1472 (portstatus & USB_PORT_STAT_ENABLE)) {
1473 if (hub_is_wusb(hub))
1474 udev->speed = USB_SPEED_VARIABLE;
1475 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
1476 udev->speed = USB_SPEED_HIGH;
1477 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
1478 udev->speed = USB_SPEED_LOW;
1480 udev->speed = USB_SPEED_FULL;
1484 /* switch to the long delay after two short delay failures */
1485 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
1486 delay = HUB_LONG_RESET_TIME;
1488 dev_dbg (hub->intfdev,
1489 "port %d not reset yet, waiting %dms\n",
1496 static int hub_port_reset(struct usb_hub *hub, int port1,
1497 struct usb_device *udev, unsigned int delay)
1501 /* Reset the port */
1502 for (i = 0; i < PORT_RESET_TRIES; i++) {
1503 status = set_port_feature(hub->hdev,
1504 port1, USB_PORT_FEAT_RESET);
1506 dev_err(hub->intfdev,
1507 "cannot reset port %d (err = %d)\n",
1510 status = hub_port_wait_reset(hub, port1, udev, delay);
1511 if (status && status != -ENOTCONN)
1512 dev_dbg(hub->intfdev,
1513 "port_wait_reset: err = %d\n",
1517 /* return on disconnect or reset */
1520 /* TRSTRCY = 10 ms; plus some extra */
1525 clear_port_feature(hub->hdev,
1526 port1, USB_PORT_FEAT_C_RESET);
1527 /* FIXME need disconnect() for NOTATTACHED device */
1528 usb_set_device_state(udev, status
1529 ? USB_STATE_NOTATTACHED
1530 : USB_STATE_DEFAULT);
1534 dev_dbg (hub->intfdev,
1535 "port %d not enabled, trying reset again...\n",
1537 delay = HUB_LONG_RESET_TIME;
1540 dev_err (hub->intfdev,
1541 "Cannot enable port %i. Maybe the USB cable is bad?\n",
1548 * Disable a port and mark a logical connnect-change event, so that some
1549 * time later khubd will disconnect() any existing usb_device on the port
1550 * and will re-enumerate if there actually is a device attached.
1552 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
1554 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
1555 hub_port_disable(hub, port1, 1);
1557 /* FIXME let caller ask to power down the port:
1558 * - some devices won't enumerate without a VBUS power cycle
1559 * - SRP saves power that way
1560 * - ... new call, TBD ...
1561 * That's easy if this hub can switch power per-port, and
1562 * khubd reactivates the port later (timer, SRP, etc).
1563 * Powerdown must be optional, because of reset/DFU.
1566 set_bit(port1, hub->change_bits);
1572 #ifdef CONFIG_USB_SUSPEND
1575 * Selective port suspend reduces power; most suspended devices draw
1576 * less than 500 uA. It's also used in OTG, along with remote wakeup.
1577 * All devices below the suspended port are also suspended.
1579 * Devices leave suspend state when the host wakes them up. Some devices
1580 * also support "remote wakeup", where the device can activate the USB
1581 * tree above them to deliver data, such as a keypress or packet. In
1582 * some cases, this wakes the USB host.
1584 static int hub_port_suspend(struct usb_hub *hub, int port1,
1585 struct usb_device *udev)
1589 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
1591 /* enable remote wakeup when appropriate; this lets the device
1592 * wake up the upstream hub (including maybe the root hub).
1594 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
1595 * we don't explicitly enable it here.
1597 if (udev->do_remote_wakeup) {
1598 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1599 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
1600 USB_DEVICE_REMOTE_WAKEUP, 0,
1602 USB_CTRL_SET_TIMEOUT);
1605 "won't remote wakeup, status %d\n",
1610 status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
1612 dev_dbg(hub->intfdev,
1613 "can't suspend port %d, status %d\n",
1615 /* paranoia: "should not happen" */
1616 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1617 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
1618 USB_DEVICE_REMOTE_WAKEUP, 0,
1620 USB_CTRL_SET_TIMEOUT);
1622 /* device has up to 10 msec to fully suspend */
1623 dev_dbg(&udev->dev, "usb %ssuspend\n",
1624 udev->auto_pm ? "auto-" : "");
1625 usb_set_device_state(udev, USB_STATE_SUSPENDED);
1632 * Devices on USB hub ports have only one "suspend" state, corresponding
1633 * to ACPI D2, "may cause the device to lose some context".
1634 * State transitions include:
1636 * - suspend, resume ... when the VBUS power link stays live
1637 * - suspend, disconnect ... VBUS lost
1639 * Once VBUS drop breaks the circuit, the port it's using has to go through
1640 * normal re-enumeration procedures, starting with enabling VBUS power.
1641 * Other than re-initializing the hub (plug/unplug, except for root hubs),
1642 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
1643 * timer, no SRP, no requests through sysfs.
1645 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
1646 * the root hub for their bus goes into global suspend ... so we don't
1647 * (falsely) update the device power state to say it suspended.
1649 static int __usb_port_suspend (struct usb_device *udev, int port1)
1653 /* caller owns the udev device lock */
1657 /* we change the device's upstream USB link,
1658 * but root hubs have no upstream USB link.
1661 status = hub_port_suspend(hdev_to_hub(udev->parent), port1,
1664 dev_dbg(&udev->dev, "usb %ssuspend\n",
1665 udev->auto_pm ? "auto-" : "");
1666 usb_set_device_state(udev, USB_STATE_SUSPENDED);
1672 * usb_port_suspend - suspend a usb device's upstream port
1673 * @udev: device that's no longer in active use
1674 * Context: must be able to sleep; device not locked; pm locks held
1676 * Suspends a USB device that isn't in active use, conserving power.
1677 * Devices may wake out of a suspend, if anything important happens,
1678 * using the remote wakeup mechanism. They may also be taken out of
1679 * suspend by the host, using usb_port_resume(). It's also routine
1680 * to disconnect devices while they are suspended.
1682 * This only affects the USB hardware for a device; its interfaces
1683 * (and, for hubs, child devices) must already have been suspended.
1685 * Suspending OTG devices may trigger HNP, if that's been enabled
1686 * between a pair of dual-role devices. That will change roles, such
1687 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
1689 * Returns 0 on success, else negative errno.
1691 int usb_port_suspend(struct usb_device *udev)
1693 return __usb_port_suspend(udev, udev->portnum);
1697 * If the USB "suspend" state is in use (rather than "global suspend"),
1698 * many devices will be individually taken out of suspend state using
1699 * special" resume" signaling. These routines kick in shortly after
1700 * hardware resume signaling is finished, either because of selective
1701 * resume (by host) or remote wakeup (by device) ... now see what changed
1702 * in the tree that's rooted at this device.
1704 static int finish_port_resume(struct usb_device *udev)
1709 /* caller owns the udev device lock */
1710 dev_dbg(&udev->dev, "finish resume\n");
1712 /* usb ch9 identifies four variants of SUSPENDED, based on what
1713 * state the device resumes to. Linux currently won't see the
1714 * first two on the host side; they'd be inside hub_port_init()
1715 * during many timeouts, but khubd can't suspend until later.
1717 usb_set_device_state(udev, udev->actconfig
1718 ? USB_STATE_CONFIGURED
1719 : USB_STATE_ADDRESS);
1721 /* 10.5.4.5 says be sure devices in the tree are still there.
1722 * For now let's assume the device didn't go crazy on resume,
1723 * and device drivers will know about any resume quirks.
1725 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
1727 status = (status == 2 ? 0 : -ENODEV);
1731 "gone after usb resume? status %d\n",
1733 else if (udev->actconfig) {
1734 le16_to_cpus(&devstatus);
1735 if ((devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
1737 status = usb_control_msg(udev,
1738 usb_sndctrlpipe(udev, 0),
1739 USB_REQ_CLEAR_FEATURE,
1741 USB_DEVICE_REMOTE_WAKEUP, 0,
1743 USB_CTRL_SET_TIMEOUT);
1745 dev_dbg(&udev->dev, "disable remote "
1746 "wakeup, status %d\n", status);
1750 } else if (udev->devnum <= 0) {
1751 dev_dbg(&udev->dev, "bogus resume!\n");
1758 hub_port_resume(struct usb_hub *hub, int port1, struct usb_device *udev)
1762 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
1764 set_bit(port1, hub->busy_bits);
1766 /* see 7.1.7.7; affects power usage, but not budgeting */
1767 status = clear_port_feature(hub->hdev,
1768 port1, USB_PORT_FEAT_SUSPEND);
1770 dev_dbg(hub->intfdev,
1771 "can't resume port %d, status %d\n",
1777 /* drive resume for at least 20 msec */
1779 dev_dbg(&udev->dev, "usb %sresume\n",
1780 udev->auto_pm ? "auto-" : "");
1783 #define LIVE_FLAGS ( USB_PORT_STAT_POWER \
1784 | USB_PORT_STAT_ENABLE \
1785 | USB_PORT_STAT_CONNECTION)
1787 /* Virtual root hubs can trigger on GET_PORT_STATUS to
1788 * stop resume signaling. Then finish the resume
1791 devstatus = portchange = 0;
1792 status = hub_port_status(hub, port1,
1793 &devstatus, &portchange);
1795 || (devstatus & LIVE_FLAGS) != LIVE_FLAGS
1796 || (devstatus & USB_PORT_STAT_SUSPEND) != 0
1798 dev_dbg(hub->intfdev,
1799 "port %d status %04x.%04x after resume, %d\n",
1800 port1, portchange, devstatus, status);
1804 if (portchange & USB_PORT_STAT_C_SUSPEND)
1805 clear_port_feature(hub->hdev, port1,
1806 USB_PORT_FEAT_C_SUSPEND);
1807 /* TRSMRCY = 10 msec */
1810 status = finish_port_resume(udev);
1814 hub_port_logical_disconnect(hub, port1);
1816 clear_bit(port1, hub->busy_bits);
1817 if (!hub->hdev->parent && !hub->busy_bits[0])
1818 usb_enable_root_hub_irq(hub->hdev->bus);
1824 * usb_port_resume - re-activate a suspended usb device's upstream port
1825 * @udev: device to re-activate
1826 * Context: must be able to sleep; device not locked; pm locks held
1828 * This will re-activate the suspended device, increasing power usage
1829 * while letting drivers communicate again with its endpoints.
1830 * USB resume explicitly guarantees that the power session between
1831 * the host and the device is the same as it was when the device
1834 * Returns 0 on success, else negative errno.
1836 int usb_port_resume(struct usb_device *udev)
1840 /* we change the device's upstream USB link,
1841 * but root hubs have no upstream USB link.
1844 // NOTE this fails if parent is also suspended...
1845 status = hub_port_resume(hdev_to_hub(udev->parent),
1846 udev->portnum, udev);
1848 dev_dbg(&udev->dev, "usb %sresume\n",
1849 udev->auto_pm ? "auto-" : "");
1850 status = finish_port_resume(udev);
1853 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
1857 static int remote_wakeup(struct usb_device *udev)
1861 /* All this just to avoid sending a port-resume message
1862 * to the parent hub! */
1864 usb_lock_device(udev);
1866 if (udev->state == USB_STATE_SUSPENDED) {
1867 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
1868 /* TRSMRCY = 10 msec */
1870 status = finish_port_resume(udev);
1872 udev->dev.power.power_state.event = PM_EVENT_ON;
1874 usb_pm_unlock(udev);
1877 usb_autoresume_device(udev, 0);
1878 usb_unlock_device(udev);
1882 #else /* CONFIG_USB_SUSPEND */
1884 /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
1886 int usb_port_suspend(struct usb_device *udev)
1892 finish_port_resume(struct usb_device *udev)
1898 hub_port_resume(struct usb_hub *hub, int port1, struct usb_device *udev)
1903 int usb_port_resume(struct usb_device *udev)
1908 static inline int remote_wakeup(struct usb_device *udev)
1915 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
1917 struct usb_hub *hub = usb_get_intfdata (intf);
1918 struct usb_device *hdev = hub->hdev;
1921 /* fail if children aren't already suspended */
1922 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
1923 struct usb_device *udev;
1925 udev = hdev->children [port1-1];
1926 if (udev && msg.event == PM_EVENT_SUSPEND &&
1927 #ifdef CONFIG_USB_SUSPEND
1928 udev->state != USB_STATE_SUSPENDED
1930 udev->dev.power.power_state.event
1935 dev_dbg(&intf->dev, "port %d nyet suspended\n",
1941 /* "global suspend" of the downstream HC-to-USB interface */
1942 if (!hdev->parent) {
1943 struct usb_bus *bus = hdev->bus;
1945 int status = hcd_bus_suspend (bus);
1948 dev_dbg(&hdev->dev, "'global' suspend %d\n",
1956 /* stop khubd and related activity */
1961 static int hub_resume(struct usb_interface *intf)
1963 struct usb_device *hdev = interface_to_usbdev(intf);
1964 struct usb_hub *hub = usb_get_intfdata (intf);
1967 /* "global resume" of the downstream HC-to-USB interface */
1968 if (!hdev->parent) {
1969 struct usb_bus *bus = hdev->bus;
1971 status = hcd_bus_resume (bus);
1973 dev_dbg(&intf->dev, "'global' resume %d\n",
1980 /* TRSMRCY = 10 msec */
1985 /* tell khubd to look for changes on this hub */
1990 #else /* CONFIG_PM */
1992 static inline int remote_wakeup(struct usb_device *udev)
1997 #define hub_suspend NULL
1998 #define hub_resume NULL
2001 void usb_resume_root_hub(struct usb_device *hdev)
2003 struct usb_hub *hub = hdev_to_hub(hdev);
2005 hub->resume_root_hub = 1;
2010 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2012 * Between connect detection and reset signaling there must be a delay
2013 * of 100ms at least for debounce and power-settling. The corresponding
2014 * timer shall restart whenever the downstream port detects a disconnect.
2016 * Apparently there are some bluetooth and irda-dongles and a number of
2017 * low-speed devices for which this debounce period may last over a second.
2018 * Not covered by the spec - but easy to deal with.
2020 * This implementation uses a 1500ms total debounce timeout; if the
2021 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2022 * every 25ms for transient disconnects. When the port status has been
2023 * unchanged for 100ms it returns the port status.
2026 #define HUB_DEBOUNCE_TIMEOUT 1500
2027 #define HUB_DEBOUNCE_STEP 25
2028 #define HUB_DEBOUNCE_STABLE 100
2030 static int hub_port_debounce(struct usb_hub *hub, int port1)
2033 int total_time, stable_time = 0;
2034 u16 portchange, portstatus;
2035 unsigned connection = 0xffff;
2037 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2038 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2042 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2043 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2044 stable_time += HUB_DEBOUNCE_STEP;
2045 if (stable_time >= HUB_DEBOUNCE_STABLE)
2049 connection = portstatus & USB_PORT_STAT_CONNECTION;
2052 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2053 clear_port_feature(hub->hdev, port1,
2054 USB_PORT_FEAT_C_CONNECTION);
2057 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2059 msleep(HUB_DEBOUNCE_STEP);
2062 dev_dbg (hub->intfdev,
2063 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2064 port1, total_time, stable_time, portstatus);
2066 if (stable_time < HUB_DEBOUNCE_STABLE)
2071 static void ep0_reinit(struct usb_device *udev)
2073 usb_disable_endpoint(udev, 0 + USB_DIR_IN);
2074 usb_disable_endpoint(udev, 0 + USB_DIR_OUT);
2075 udev->ep_in[0] = udev->ep_out[0] = &udev->ep0;
2078 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2079 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2081 static int hub_set_address(struct usb_device *udev)
2085 if (udev->devnum == 0)
2087 if (udev->state == USB_STATE_ADDRESS)
2089 if (udev->state != USB_STATE_DEFAULT)
2091 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2092 USB_REQ_SET_ADDRESS, 0, udev->devnum, 0,
2093 NULL, 0, USB_CTRL_SET_TIMEOUT);
2095 usb_set_device_state(udev, USB_STATE_ADDRESS);
2101 /* Reset device, (re)assign address, get device descriptor.
2102 * Device connection must be stable, no more debouncing needed.
2103 * Returns device in USB_STATE_ADDRESS, except on error.
2105 * If this is called for an already-existing device (as part of
2106 * usb_reset_device), the caller must own the device lock. For a
2107 * newly detected device that is not accessible through any global
2108 * pointers, it's not necessary to lock the device.
2111 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2114 static DEFINE_MUTEX(usb_address0_mutex);
2116 struct usb_device *hdev = hub->hdev;
2118 unsigned delay = HUB_SHORT_RESET_TIME;
2119 enum usb_device_speed oldspeed = udev->speed;
2122 /* root hub ports have a slightly longer reset period
2123 * (from USB 2.0 spec, section 7.1.7.5)
2125 if (!hdev->parent) {
2126 delay = HUB_ROOT_RESET_TIME;
2127 if (port1 == hdev->bus->otg_port)
2128 hdev->bus->b_hnp_enable = 0;
2131 /* Some low speed devices have problems with the quick delay, so */
2132 /* be a bit pessimistic with those devices. RHbug #23670 */
2133 if (oldspeed == USB_SPEED_LOW)
2134 delay = HUB_LONG_RESET_TIME;
2136 mutex_lock(&usb_address0_mutex);
2138 /* Reset the device; full speed may morph to high speed */
2139 retval = hub_port_reset(hub, port1, udev, delay);
2140 if (retval < 0) /* error or disconnect */
2142 /* success, speed is known */
2145 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2146 dev_dbg(&udev->dev, "device reset changed speed!\n");
2149 oldspeed = udev->speed;
2151 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2152 * it's fixed size except for full speed devices.
2153 * For Wireless USB devices, ep0 max packet is always 512 (tho
2154 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
2156 switch (udev->speed) {
2157 case USB_SPEED_VARIABLE: /* fixed at 512 */
2158 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(512);
2160 case USB_SPEED_HIGH: /* fixed at 64 */
2161 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2163 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
2164 /* to determine the ep0 maxpacket size, try to read
2165 * the device descriptor to get bMaxPacketSize0 and
2166 * then correct our initial guess.
2168 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2170 case USB_SPEED_LOW: /* fixed at 8 */
2171 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(8);
2178 switch (udev->speed) {
2179 case USB_SPEED_LOW: speed = "low"; break;
2180 case USB_SPEED_FULL: speed = "full"; break;
2181 case USB_SPEED_HIGH: speed = "high"; break;
2182 case USB_SPEED_VARIABLE:
2186 default: speed = "?"; break;
2188 dev_info (&udev->dev,
2189 "%s %s speed %sUSB device using %s and address %d\n",
2190 (udev->config) ? "reset" : "new", speed, type,
2191 udev->bus->controller->driver->name, udev->devnum);
2193 /* Set up TT records, if needed */
2195 udev->tt = hdev->tt;
2196 udev->ttport = hdev->ttport;
2197 } else if (udev->speed != USB_SPEED_HIGH
2198 && hdev->speed == USB_SPEED_HIGH) {
2199 udev->tt = &hub->tt;
2200 udev->ttport = port1;
2203 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2204 * Because device hardware and firmware is sometimes buggy in
2205 * this area, and this is how Linux has done it for ages.
2206 * Change it cautiously.
2208 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2209 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2210 * so it may help with some non-standards-compliant devices.
2211 * Otherwise we start with SET_ADDRESS and then try to read the
2212 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2215 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
2216 if (USE_NEW_SCHEME(retry_counter)) {
2217 struct usb_device_descriptor *buf;
2220 #define GET_DESCRIPTOR_BUFSIZE 64
2221 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2227 /* Use a short timeout the first time through,
2228 * so that recalcitrant full-speed devices with
2229 * 8- or 16-byte ep0-maxpackets won't slow things
2230 * down tremendously by NAKing the unexpectedly
2231 * early status stage. Also, retry on all errors;
2232 * some devices are flakey.
2233 * 255 is for WUSB devices, we actually need to use 512.
2236 for (j = 0; j < 3; ++j) {
2237 buf->bMaxPacketSize0 = 0;
2238 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2239 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2240 USB_DT_DEVICE << 8, 0,
2241 buf, GET_DESCRIPTOR_BUFSIZE,
2242 (i ? USB_CTRL_GET_TIMEOUT : 1000));
2243 switch (buf->bMaxPacketSize0) {
2244 case 8: case 16: case 32: case 64: case 255:
2245 if (buf->bDescriptorType ==
2259 udev->descriptor.bMaxPacketSize0 =
2260 buf->bMaxPacketSize0;
2263 retval = hub_port_reset(hub, port1, udev, delay);
2264 if (retval < 0) /* error or disconnect */
2266 if (oldspeed != udev->speed) {
2268 "device reset changed speed!\n");
2273 dev_err(&udev->dev, "device descriptor "
2274 "read/%s, error %d\n",
2279 #undef GET_DESCRIPTOR_BUFSIZE
2282 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
2283 retval = hub_set_address(udev);
2290 "device not accepting address %d, error %d\n",
2291 udev->devnum, retval);
2295 /* cope with hardware quirkiness:
2296 * - let SET_ADDRESS settle, some device hardware wants it
2297 * - read ep0 maxpacket even for high and low speed,
2300 if (USE_NEW_SCHEME(retry_counter))
2303 retval = usb_get_device_descriptor(udev, 8);
2305 dev_err(&udev->dev, "device descriptor "
2306 "read/%s, error %d\n",
2318 i = udev->descriptor.bMaxPacketSize0 == 0xff?
2319 512 : udev->descriptor.bMaxPacketSize0;
2320 if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
2321 if (udev->speed != USB_SPEED_FULL ||
2322 !(i == 8 || i == 16 || i == 32 || i == 64)) {
2323 dev_err(&udev->dev, "ep0 maxpacket = %d\n", i);
2327 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
2328 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
2332 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
2333 if (retval < (signed)sizeof(udev->descriptor)) {
2334 dev_err(&udev->dev, "device descriptor read/%s, error %d\n",
2345 hub_port_disable(hub, port1, 0);
2346 mutex_unlock(&usb_address0_mutex);
2351 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
2353 struct usb_qualifier_descriptor *qual;
2356 qual = kmalloc (sizeof *qual, SLAB_KERNEL);
2360 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
2361 qual, sizeof *qual);
2362 if (status == sizeof *qual) {
2363 dev_info(&udev->dev, "not running at top speed; "
2364 "connect to a high speed hub\n");
2365 /* hub LEDs are probably harder to miss than syslog */
2366 if (hub->has_indicators) {
2367 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
2368 schedule_work (&hub->leds);
2375 hub_power_remaining (struct usb_hub *hub)
2377 struct usb_device *hdev = hub->hdev;
2381 if (!hub->limited_power)
2384 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
2385 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
2386 struct usb_device *udev = hdev->children[port1 - 1];
2392 /* Unconfigured devices may not use more than 100mA,
2393 * or 8mA for OTG ports */
2394 if (udev->actconfig)
2395 delta = udev->actconfig->desc.bMaxPower * 2;
2396 else if (port1 != udev->bus->otg_port || hdev->parent)
2400 if (delta > hub->mA_per_port)
2401 dev_warn(&udev->dev, "%dmA is over %umA budget "
2403 delta, hub->mA_per_port, port1);
2406 if (remaining < 0) {
2407 dev_warn(hub->intfdev, "%dmA over power budget!\n",
2414 /* Handle physical or logical connection change events.
2415 * This routine is called when:
2416 * a port connection-change occurs;
2417 * a port enable-change occurs (often caused by EMI);
2418 * usb_reset_device() encounters changed descriptors (as from
2419 * a firmware download)
2420 * caller already locked the hub
2422 static void hub_port_connect_change(struct usb_hub *hub, int port1,
2423 u16 portstatus, u16 portchange)
2425 struct usb_device *hdev = hub->hdev;
2426 struct device *hub_dev = hub->intfdev;
2427 u16 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2431 "port %d, status %04x, change %04x, %s\n",
2432 port1, portstatus, portchange, portspeed (portstatus));
2434 if (hub->has_indicators) {
2435 set_port_led(hub, port1, HUB_LED_AUTO);
2436 hub->indicator[port1-1] = INDICATOR_AUTO;
2439 /* Disconnect any existing devices under this port */
2440 if (hdev->children[port1-1])
2441 usb_disconnect(&hdev->children[port1-1]);
2442 clear_bit(port1, hub->change_bits);
2444 #ifdef CONFIG_USB_OTG
2445 /* during HNP, don't repeat the debounce */
2446 if (hdev->bus->is_b_host)
2447 portchange &= ~USB_PORT_STAT_C_CONNECTION;
2450 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2451 status = hub_port_debounce(hub, port1);
2454 "connect-debounce failed, port %d disabled\n",
2458 portstatus = status;
2461 /* Return now if nothing is connected */
2462 if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
2464 /* maybe switch power back on (e.g. root hub was reset) */
2465 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
2466 && !(portstatus & (1 << USB_PORT_FEAT_POWER)))
2467 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
2469 if (portstatus & USB_PORT_STAT_ENABLE)
2474 #ifdef CONFIG_USB_SUSPEND
2475 /* If something is connected, but the port is suspended, wake it up. */
2476 if (portstatus & USB_PORT_STAT_SUSPEND) {
2477 status = hub_port_resume(hub, port1, NULL);
2480 "can't clear suspend on port %d; %d\n",
2487 for (i = 0; i < SET_CONFIG_TRIES; i++) {
2488 struct usb_device *udev;
2490 /* reallocate for each attempt, since references
2491 * to the previous one can escape in various ways
2493 udev = usb_alloc_dev(hdev, hdev->bus, port1);
2496 "couldn't allocate port %d usb_device\n",
2501 usb_set_device_state(udev, USB_STATE_POWERED);
2502 udev->speed = USB_SPEED_UNKNOWN;
2503 udev->bus_mA = hub->mA_per_port;
2504 udev->level = hdev->level + 1;
2506 /* set the address */
2507 choose_address(udev);
2508 if (udev->devnum <= 0) {
2509 status = -ENOTCONN; /* Don't retry */
2513 /* reset and get descriptor */
2514 status = hub_port_init(hub, udev, port1, i);
2518 /* consecutive bus-powered hubs aren't reliable; they can
2519 * violate the voltage drop budget. if the new child has
2520 * a "powered" LED, users should notice we didn't enable it
2521 * (without reading syslog), even without per-port LEDs
2524 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
2525 && udev->bus_mA <= 100) {
2528 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
2531 dev_dbg(&udev->dev, "get status %d ?\n", status);
2534 le16_to_cpus(&devstat);
2535 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
2537 "can't connect bus-powered hub "
2539 if (hub->has_indicators) {
2540 hub->indicator[port1-1] =
2541 INDICATOR_AMBER_BLINK;
2542 schedule_work (&hub->leds);
2544 status = -ENOTCONN; /* Don't retry */
2549 /* check for devices running slower than they could */
2550 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
2551 && udev->speed == USB_SPEED_FULL
2552 && highspeed_hubs != 0)
2553 check_highspeed (hub, udev, port1);
2555 /* Store the parent's children[] pointer. At this point
2556 * udev becomes globally accessible, although presumably
2557 * no one will look at it until hdev is unlocked.
2561 /* We mustn't add new devices if the parent hub has
2562 * been disconnected; we would race with the
2563 * recursively_mark_NOTATTACHED() routine.
2565 spin_lock_irq(&device_state_lock);
2566 if (hdev->state == USB_STATE_NOTATTACHED)
2569 hdev->children[port1-1] = udev;
2570 spin_unlock_irq(&device_state_lock);
2572 /* Run it through the hoops (find a driver, etc) */
2574 status = usb_new_device(udev);
2576 spin_lock_irq(&device_state_lock);
2577 hdev->children[port1-1] = NULL;
2578 spin_unlock_irq(&device_state_lock);
2585 status = hub_power_remaining(hub);
2587 dev_dbg(hub_dev, "%dmA power budget left\n", status);
2592 hub_port_disable(hub, port1, 1);
2595 release_address(udev);
2597 if (status == -ENOTCONN)
2602 hub_port_disable(hub, port1, 1);
2605 static void hub_events(void)
2607 struct list_head *tmp;
2608 struct usb_device *hdev;
2609 struct usb_interface *intf;
2610 struct usb_hub *hub;
2611 struct device *hub_dev;
2620 * We restart the list every time to avoid a deadlock with
2621 * deleting hubs downstream from this one. This should be
2622 * safe since we delete the hub from the event list.
2623 * Not the most efficient, but avoids deadlocks.
2627 /* Grab the first entry at the beginning of the list */
2628 spin_lock_irq(&hub_event_lock);
2629 if (list_empty(&hub_event_list)) {
2630 spin_unlock_irq(&hub_event_lock);
2634 tmp = hub_event_list.next;
2637 hub = list_entry(tmp, struct usb_hub, event_list);
2639 intf = to_usb_interface(hub->intfdev);
2640 hub_dev = &intf->dev;
2642 i = hub->resume_root_hub;
2644 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x%s\n",
2645 hdev->state, hub->descriptor
2646 ? hub->descriptor->bNbrPorts
2648 /* NOTE: expects max 15 ports... */
2649 (u16) hub->change_bits[0],
2650 (u16) hub->event_bits[0],
2651 i ? ", resume root" : "");
2654 spin_unlock_irq(&hub_event_lock);
2656 /* Lock the device, then check to see if we were
2657 * disconnected while waiting for the lock to succeed. */
2658 if (locktree(hdev) < 0) {
2662 if (hub != usb_get_intfdata(intf))
2665 /* If the hub has died, clean up after it */
2666 if (hdev->state == USB_STATE_NOTATTACHED) {
2667 hub->error = -ENODEV;
2668 hub_pre_reset(intf);
2672 /* Is this is a root hub wanting to reactivate the downstream
2673 * ports? If so, be sure the interface resumes even if its
2674 * stub "device" node was never suspended.
2677 usb_autoresume_device(hdev, 0);
2679 /* If this is an inactive or suspended hub, do nothing */
2684 dev_dbg (hub_dev, "resetting for error %d\n",
2687 ret = usb_reset_composite_device(hdev, intf);
2690 "error resetting hub: %d\n", ret);
2698 /* deal with port status changes */
2699 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
2700 if (test_bit(i, hub->busy_bits))
2702 connect_change = test_bit(i, hub->change_bits);
2703 if (!test_and_clear_bit(i, hub->event_bits) &&
2704 !connect_change && !hub->activating)
2707 ret = hub_port_status(hub, i,
2708 &portstatus, &portchange);
2712 if (hub->activating && !hdev->children[i-1] &&
2714 USB_PORT_STAT_CONNECTION))
2717 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2718 clear_port_feature(hdev, i,
2719 USB_PORT_FEAT_C_CONNECTION);
2723 if (portchange & USB_PORT_STAT_C_ENABLE) {
2724 if (!connect_change)
2726 "port %d enable change, "
2729 clear_port_feature(hdev, i,
2730 USB_PORT_FEAT_C_ENABLE);
2733 * EM interference sometimes causes badly
2734 * shielded USB devices to be shutdown by
2735 * the hub, this hack enables them again.
2736 * Works at least with mouse driver.
2738 if (!(portstatus & USB_PORT_STAT_ENABLE)
2740 && hdev->children[i-1]) {
2743 "disabled by hub (EMI?), "
2750 if (portchange & USB_PORT_STAT_C_SUSPEND) {
2751 clear_port_feature(hdev, i,
2752 USB_PORT_FEAT_C_SUSPEND);
2753 if (hdev->children[i-1]) {
2754 ret = remote_wakeup(hdev->
2760 hub_port_disable(hub, i, 1);
2763 "resume on port %d, status %d\n",
2767 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
2769 "over-current change on port %d\n",
2771 clear_port_feature(hdev, i,
2772 USB_PORT_FEAT_C_OVER_CURRENT);
2776 if (portchange & USB_PORT_STAT_C_RESET) {
2778 "reset change on port %d\n",
2780 clear_port_feature(hdev, i,
2781 USB_PORT_FEAT_C_RESET);
2785 hub_port_connect_change(hub, i,
2786 portstatus, portchange);
2789 /* deal with hub status changes */
2790 if (test_and_clear_bit(0, hub->event_bits) == 0)
2792 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
2793 dev_err (hub_dev, "get_hub_status failed\n");
2795 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
2796 dev_dbg (hub_dev, "power change\n");
2797 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
2798 if (hubstatus & HUB_STATUS_LOCAL_POWER)
2799 /* FIXME: Is this always true? */
2800 hub->limited_power = 0;
2802 hub->limited_power = 1;
2804 if (hubchange & HUB_CHANGE_OVERCURRENT) {
2805 dev_dbg (hub_dev, "overcurrent change\n");
2806 msleep(500); /* Cool down */
2807 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
2812 hub->activating = 0;
2814 /* If this is a root hub, tell the HCD it's okay to
2815 * re-enable port-change interrupts now. */
2816 if (!hdev->parent && !hub->busy_bits[0])
2817 usb_enable_root_hub_irq(hdev->bus);
2820 usb_unlock_device(hdev);
2823 } /* end while (1) */
2826 static int hub_thread(void *__unused)
2830 wait_event_interruptible(khubd_wait,
2831 !list_empty(&hub_event_list) ||
2832 kthread_should_stop());
2834 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
2836 pr_debug("%s: khubd exiting\n", usbcore_name);
2840 static struct usb_device_id hub_id_table [] = {
2841 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
2842 .bDeviceClass = USB_CLASS_HUB},
2843 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
2844 .bInterfaceClass = USB_CLASS_HUB},
2845 { } /* Terminating entry */
2848 MODULE_DEVICE_TABLE (usb, hub_id_table);
2850 static struct usb_driver hub_driver = {
2853 .disconnect = hub_disconnect,
2854 .suspend = hub_suspend,
2855 .resume = hub_resume,
2856 .pre_reset = hub_pre_reset,
2857 .post_reset = hub_post_reset,
2859 .id_table = hub_id_table,
2862 int usb_hub_init(void)
2864 if (usb_register(&hub_driver) < 0) {
2865 printk(KERN_ERR "%s: can't register hub driver\n",
2870 khubd_task = kthread_run(hub_thread, NULL, "khubd");
2871 if (!IS_ERR(khubd_task))
2874 /* Fall through if kernel_thread failed */
2875 usb_deregister(&hub_driver);
2876 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
2881 void usb_hub_cleanup(void)
2883 kthread_stop(khubd_task);
2886 * Hub resources are freed for us by usb_deregister. It calls
2887 * usb_driver_purge on every device which in turn calls that
2888 * devices disconnect function if it is using this driver.
2889 * The hub_disconnect function takes care of releasing the
2890 * individual hub resources. -greg
2892 usb_deregister(&hub_driver);
2893 } /* usb_hub_cleanup() */
2895 static int config_descriptors_changed(struct usb_device *udev)
2899 struct usb_config_descriptor *buf;
2901 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2902 if (len < le16_to_cpu(udev->config[index].desc.wTotalLength))
2903 len = le16_to_cpu(udev->config[index].desc.wTotalLength);
2905 buf = kmalloc (len, SLAB_KERNEL);
2907 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
2908 /* assume the worst */
2911 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2913 int old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
2915 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
2917 if (length < old_length) {
2918 dev_dbg(&udev->dev, "config index %d, error %d\n",
2922 if (memcmp (buf, udev->rawdescriptors[index], old_length)
2924 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
2925 index, buf->bConfigurationValue);
2930 return index != udev->descriptor.bNumConfigurations;
2934 * usb_reset_device - perform a USB port reset to reinitialize a device
2935 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
2937 * WARNING - don't use this routine to reset a composite device
2938 * (one with multiple interfaces owned by separate drivers)!
2939 * Use usb_reset_composite_device() instead.
2941 * Do a port reset, reassign the device's address, and establish its
2942 * former operating configuration. If the reset fails, or the device's
2943 * descriptors change from their values before the reset, or the original
2944 * configuration and altsettings cannot be restored, a flag will be set
2945 * telling khubd to pretend the device has been disconnected and then
2946 * re-connected. All drivers will be unbound, and the device will be
2947 * re-enumerated and probed all over again.
2949 * Returns 0 if the reset succeeded, -ENODEV if the device has been
2950 * flagged for logical disconnection, or some other negative error code
2951 * if the reset wasn't even attempted.
2953 * The caller must own the device lock. For example, it's safe to use
2954 * this from a driver probe() routine after downloading new firmware.
2955 * For calls that might not occur during probe(), drivers should lock
2956 * the device using usb_lock_device_for_reset().
2958 int usb_reset_device(struct usb_device *udev)
2960 struct usb_device *parent_hdev = udev->parent;
2961 struct usb_hub *parent_hub;
2962 struct usb_device_descriptor descriptor = udev->descriptor;
2964 int port1 = udev->portnum;
2966 if (udev->state == USB_STATE_NOTATTACHED ||
2967 udev->state == USB_STATE_SUSPENDED) {
2968 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
2974 /* this requires hcd-specific logic; see OHCI hc_restart() */
2975 dev_dbg(&udev->dev, "%s for root hub!\n", __FUNCTION__);
2978 parent_hub = hdev_to_hub(parent_hdev);
2980 set_bit(port1, parent_hub->busy_bits);
2981 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
2983 /* ep0 maxpacket size may change; let the HCD know about it.
2984 * Other endpoints will be handled by re-enumeration. */
2986 ret = hub_port_init(parent_hub, udev, port1, i);
2990 clear_bit(port1, parent_hub->busy_bits);
2991 if (!parent_hdev->parent && !parent_hub->busy_bits[0])
2992 usb_enable_root_hub_irq(parent_hdev->bus);
2997 /* Device might have changed firmware (DFU or similar) */
2998 if (memcmp(&udev->descriptor, &descriptor, sizeof descriptor)
2999 || config_descriptors_changed (udev)) {
3000 dev_info(&udev->dev, "device firmware changed\n");
3001 udev->descriptor = descriptor; /* for disconnect() calls */
3005 if (!udev->actconfig)
3008 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3009 USB_REQ_SET_CONFIGURATION, 0,
3010 udev->actconfig->desc.bConfigurationValue, 0,
3011 NULL, 0, USB_CTRL_SET_TIMEOUT);
3014 "can't restore configuration #%d (error=%d)\n",
3015 udev->actconfig->desc.bConfigurationValue, ret);
3018 usb_set_device_state(udev, USB_STATE_CONFIGURED);
3020 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
3021 struct usb_interface *intf = udev->actconfig->interface[i];
3022 struct usb_interface_descriptor *desc;
3024 /* set_interface resets host side toggle even
3025 * for altsetting zero. the interface may have no driver.
3027 desc = &intf->cur_altsetting->desc;
3028 ret = usb_set_interface(udev, desc->bInterfaceNumber,
3029 desc->bAlternateSetting);
3031 dev_err(&udev->dev, "failed to restore interface %d "
3032 "altsetting %d (error=%d)\n",
3033 desc->bInterfaceNumber,
3034 desc->bAlternateSetting,
3044 hub_port_logical_disconnect(parent_hub, port1);
3047 EXPORT_SYMBOL(usb_reset_device);
3050 * usb_reset_composite_device - warn interface drivers and perform a USB port reset
3051 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3052 * @iface: interface bound to the driver making the request (optional)
3054 * Warns all drivers bound to registered interfaces (using their pre_reset
3055 * method), performs the port reset, and then lets the drivers know that
3056 * the reset is over (using their post_reset method).
3058 * Return value is the same as for usb_reset_device().
3060 * The caller must own the device lock. For example, it's safe to use
3061 * this from a driver probe() routine after downloading new firmware.
3062 * For calls that might not occur during probe(), drivers should lock
3063 * the device using usb_lock_device_for_reset().
3065 * The interface locks are acquired during the pre_reset stage and released
3066 * during the post_reset stage. However if iface is not NULL and is
3067 * currently being probed, we assume that the caller already owns its
3070 int usb_reset_composite_device(struct usb_device *udev,
3071 struct usb_interface *iface)
3074 struct usb_host_config *config = udev->actconfig;
3076 if (udev->state == USB_STATE_NOTATTACHED ||
3077 udev->state == USB_STATE_SUSPENDED) {
3078 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3083 /* Prevent autosuspend during the reset */
3084 usb_autoresume_device(udev, 1);
3086 if (iface && iface->condition != USB_INTERFACE_BINDING)
3091 struct usb_interface *cintf;
3092 struct usb_driver *drv;
3094 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
3095 cintf = config->interface[i];
3097 down(&cintf->dev.sem);
3098 if (device_is_registered(&cintf->dev) &&
3099 cintf->dev.driver) {
3100 drv = to_usb_driver(cintf->dev.driver);
3102 (drv->pre_reset)(cintf);
3107 ret = usb_reset_device(udev);
3111 struct usb_interface *cintf;
3112 struct usb_driver *drv;
3114 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
3115 cintf = config->interface[i];
3116 if (device_is_registered(&cintf->dev) &&
3117 cintf->dev.driver) {
3118 drv = to_usb_driver(cintf->dev.driver);
3119 if (drv->post_reset)
3120 (drv->post_reset)(cintf);
3123 up(&cintf->dev.sem);
3127 usb_autosuspend_device(udev, 1);
3130 EXPORT_SYMBOL(usb_reset_composite_device);