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;
69 unsigned has_indicators:1;
70 u8 indicator[USB_MAXCHILDREN];
71 struct work_struct leds;
75 /* Protect struct usb_device->state and ->children members
76 * Note: Both are also protected by ->dev.sem, except that ->state can
77 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
78 static DEFINE_SPINLOCK(device_state_lock);
80 /* khubd's worklist and its lock */
81 static DEFINE_SPINLOCK(hub_event_lock);
82 static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
85 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
87 static struct task_struct *khubd_task;
89 /* multithreaded probe logic */
90 static int multithread_probe =
91 #ifdef CONFIG_USB_MULTITHREAD_PROBE
96 module_param(multithread_probe, bool, S_IRUGO);
97 MODULE_PARM_DESC(multithread_probe, "Run each USB device probe in a new thread");
99 /* cycle leds on hubs that aren't blinking for attention */
100 static int blinkenlights = 0;
101 module_param (blinkenlights, bool, S_IRUGO);
102 MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
105 * As of 2.6.10 we introduce a new USB device initialization scheme which
106 * closely resembles the way Windows works. Hopefully it will be compatible
107 * with a wider range of devices than the old scheme. However some previously
108 * working devices may start giving rise to "device not accepting address"
109 * errors; if that happens the user can try the old scheme by adjusting the
110 * following module parameters.
112 * For maximum flexibility there are two boolean parameters to control the
113 * hub driver's behavior. On the first initialization attempt, if the
114 * "old_scheme_first" parameter is set then the old scheme will be used,
115 * otherwise the new scheme is used. If that fails and "use_both_schemes"
116 * is set, then the driver will make another attempt, using the other scheme.
118 static int old_scheme_first = 0;
119 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
120 MODULE_PARM_DESC(old_scheme_first,
121 "start with the old device initialization scheme");
123 static int use_both_schemes = 1;
124 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
125 MODULE_PARM_DESC(use_both_schemes,
126 "try the other device initialization scheme if the "
131 static inline char *portspeed (int portstatus)
133 if (portstatus & (1 << USB_PORT_FEAT_HIGHSPEED))
135 else if (portstatus & (1 << USB_PORT_FEAT_LOWSPEED))
142 /* Note that hdev or one of its children must be locked! */
143 static inline struct usb_hub *hdev_to_hub(struct usb_device *hdev)
145 return usb_get_intfdata(hdev->actconfig->interface[0]);
148 /* USB 2.0 spec Section 11.24.4.5 */
149 static int get_hub_descriptor(struct usb_device *hdev, void *data, int size)
153 for (i = 0; i < 3; i++) {
154 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
155 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
156 USB_DT_HUB << 8, 0, data, size,
157 USB_CTRL_GET_TIMEOUT);
158 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
165 * USB 2.0 spec Section 11.24.2.1
167 static int clear_hub_feature(struct usb_device *hdev, int feature)
169 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
170 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
174 * USB 2.0 spec Section 11.24.2.2
176 static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
178 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
179 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
184 * USB 2.0 spec Section 11.24.2.13
186 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
188 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
189 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
194 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
195 * for info about using port indicators
197 static void set_port_led(
203 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
204 USB_PORT_FEAT_INDICATOR);
206 dev_dbg (hub->intfdev,
207 "port %d indicator %s status %d\n",
209 ({ char *s; switch (selector) {
210 case HUB_LED_AMBER: s = "amber"; break;
211 case HUB_LED_GREEN: s = "green"; break;
212 case HUB_LED_OFF: s = "off"; break;
213 case HUB_LED_AUTO: s = "auto"; break;
214 default: s = "??"; break;
219 #define LED_CYCLE_PERIOD ((2*HZ)/3)
221 static void led_work (void *__hub)
223 struct usb_hub *hub = __hub;
224 struct usb_device *hdev = hub->hdev;
226 unsigned changed = 0;
229 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
232 for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
233 unsigned selector, mode;
235 /* 30%-50% duty cycle */
237 switch (hub->indicator[i]) {
239 case INDICATOR_CYCLE:
241 selector = HUB_LED_AUTO;
242 mode = INDICATOR_AUTO;
244 /* blinking green = sw attention */
245 case INDICATOR_GREEN_BLINK:
246 selector = HUB_LED_GREEN;
247 mode = INDICATOR_GREEN_BLINK_OFF;
249 case INDICATOR_GREEN_BLINK_OFF:
250 selector = HUB_LED_OFF;
251 mode = INDICATOR_GREEN_BLINK;
253 /* blinking amber = hw attention */
254 case INDICATOR_AMBER_BLINK:
255 selector = HUB_LED_AMBER;
256 mode = INDICATOR_AMBER_BLINK_OFF;
258 case INDICATOR_AMBER_BLINK_OFF:
259 selector = HUB_LED_OFF;
260 mode = INDICATOR_AMBER_BLINK;
262 /* blink green/amber = reserved */
263 case INDICATOR_ALT_BLINK:
264 selector = HUB_LED_GREEN;
265 mode = INDICATOR_ALT_BLINK_OFF;
267 case INDICATOR_ALT_BLINK_OFF:
268 selector = HUB_LED_AMBER;
269 mode = INDICATOR_ALT_BLINK;
274 if (selector != HUB_LED_AUTO)
276 set_port_led(hub, i + 1, selector);
277 hub->indicator[i] = mode;
279 if (!changed && blinkenlights) {
281 cursor %= hub->descriptor->bNbrPorts;
282 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
283 hub->indicator[cursor] = INDICATOR_CYCLE;
287 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
290 /* use a short timeout for hub/port status fetches */
291 #define USB_STS_TIMEOUT 1000
292 #define USB_STS_RETRIES 5
295 * USB 2.0 spec Section 11.24.2.6
297 static int get_hub_status(struct usb_device *hdev,
298 struct usb_hub_status *data)
300 int i, status = -ETIMEDOUT;
302 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
303 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
304 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
305 data, sizeof(*data), USB_STS_TIMEOUT);
311 * USB 2.0 spec Section 11.24.2.7
313 static int get_port_status(struct usb_device *hdev, int port1,
314 struct usb_port_status *data)
316 int i, status = -ETIMEDOUT;
318 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
319 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
320 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
321 data, sizeof(*data), USB_STS_TIMEOUT);
326 static void kick_khubd(struct usb_hub *hub)
330 /* Suppress autosuspend until khubd runs */
331 to_usb_interface(hub->intfdev)->pm_usage_cnt = 1;
333 spin_lock_irqsave(&hub_event_lock, flags);
334 if (list_empty(&hub->event_list)) {
335 list_add_tail(&hub->event_list, &hub_event_list);
336 wake_up(&khubd_wait);
338 spin_unlock_irqrestore(&hub_event_lock, flags);
341 void usb_kick_khubd(struct usb_device *hdev)
343 kick_khubd(hdev_to_hub(hdev));
347 /* completion function, fires on port status changes and various faults */
348 static void hub_irq(struct urb *urb)
350 struct usb_hub *hub = urb->context;
355 switch (urb->status) {
356 case -ENOENT: /* synchronous unlink */
357 case -ECONNRESET: /* async unlink */
358 case -ESHUTDOWN: /* hardware going away */
361 default: /* presumably an error */
362 /* Cause a hub reset after 10 consecutive errors */
363 dev_dbg (hub->intfdev, "transfer --> %d\n", urb->status);
364 if ((++hub->nerrors < 10) || hub->error)
366 hub->error = urb->status;
369 /* let khubd handle things */
370 case 0: /* we got data: port status changed */
372 for (i = 0; i < urb->actual_length; ++i)
373 bits |= ((unsigned long) ((*hub->buffer)[i]))
375 hub->event_bits[0] = bits;
381 /* Something happened, let khubd figure it out */
388 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
389 && status != -ENODEV && status != -EPERM)
390 dev_err (hub->intfdev, "resubmit --> %d\n", status);
393 /* USB 2.0 spec Section 11.24.2.3 */
395 hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
397 return usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
398 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
403 * enumeration blocks khubd for a long time. we use keventd instead, since
404 * long blocking there is the exception, not the rule. accordingly, HCDs
405 * talking to TTs must queue control transfers (not just bulk and iso), so
406 * both can talk to the same hub concurrently.
408 static void hub_tt_kevent (void *arg)
410 struct usb_hub *hub = arg;
413 spin_lock_irqsave (&hub->tt.lock, flags);
414 while (!list_empty (&hub->tt.clear_list)) {
415 struct list_head *temp;
416 struct usb_tt_clear *clear;
417 struct usb_device *hdev = hub->hdev;
420 temp = hub->tt.clear_list.next;
421 clear = list_entry (temp, struct usb_tt_clear, clear_list);
422 list_del (&clear->clear_list);
424 /* drop lock so HCD can concurrently report other TT errors */
425 spin_unlock_irqrestore (&hub->tt.lock, flags);
426 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
427 spin_lock_irqsave (&hub->tt.lock, flags);
431 "clear tt %d (%04x) error %d\n",
432 clear->tt, clear->devinfo, status);
435 spin_unlock_irqrestore (&hub->tt.lock, flags);
439 * usb_hub_tt_clear_buffer - clear control/bulk TT state in high speed hub
440 * @udev: the device whose split transaction failed
441 * @pipe: identifies the endpoint of the failed transaction
443 * High speed HCDs use this to tell the hub driver that some split control or
444 * bulk transaction failed in a way that requires clearing internal state of
445 * a transaction translator. This is normally detected (and reported) from
448 * It may not be possible for that hub to handle additional full (or low)
449 * speed transactions until that state is fully cleared out.
451 void usb_hub_tt_clear_buffer (struct usb_device *udev, int pipe)
453 struct usb_tt *tt = udev->tt;
455 struct usb_tt_clear *clear;
457 /* we've got to cope with an arbitrary number of pending TT clears,
458 * since each TT has "at least two" buffers that can need it (and
459 * there can be many TTs per hub). even if they're uncommon.
461 if ((clear = kmalloc (sizeof *clear, SLAB_ATOMIC)) == NULL) {
462 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
463 /* FIXME recover somehow ... RESET_TT? */
467 /* info that CLEAR_TT_BUFFER needs */
468 clear->tt = tt->multi ? udev->ttport : 1;
469 clear->devinfo = usb_pipeendpoint (pipe);
470 clear->devinfo |= udev->devnum << 4;
471 clear->devinfo |= usb_pipecontrol (pipe)
472 ? (USB_ENDPOINT_XFER_CONTROL << 11)
473 : (USB_ENDPOINT_XFER_BULK << 11);
474 if (usb_pipein (pipe))
475 clear->devinfo |= 1 << 15;
477 /* tell keventd to clear state for this TT */
478 spin_lock_irqsave (&tt->lock, flags);
479 list_add_tail (&clear->clear_list, &tt->clear_list);
480 schedule_work (&tt->kevent);
481 spin_unlock_irqrestore (&tt->lock, flags);
484 static void hub_power_on(struct usb_hub *hub)
487 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
488 u16 wHubCharacteristics =
489 le16_to_cpu(hub->descriptor->wHubCharacteristics);
491 /* Enable power on each port. Some hubs have reserved values
492 * of LPSM (> 2) in their descriptors, even though they are
493 * USB 2.0 hubs. Some hubs do not implement port-power switching
494 * but only emulate it. In all cases, the ports won't work
495 * unless we send these messages to the hub.
497 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
498 dev_dbg(hub->intfdev, "enabling power on all ports\n");
500 dev_dbg(hub->intfdev, "trying to enable port power on "
501 "non-switchable hub\n");
502 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
503 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
505 /* Wait at least 100 msec for power to become stable */
506 msleep(max(pgood_delay, (unsigned) 100));
509 static void hub_quiesce(struct usb_hub *hub)
511 /* (nonblocking) khubd and related activity won't re-trigger */
515 /* (blocking) stop khubd and related activity */
516 usb_kill_urb(hub->urb);
517 if (hub->has_indicators)
518 cancel_delayed_work(&hub->leds);
519 if (hub->has_indicators || hub->tt.hub)
520 flush_scheduled_work();
523 static void hub_activate(struct usb_hub *hub)
530 status = usb_submit_urb(hub->urb, GFP_NOIO);
532 dev_err(hub->intfdev, "activate --> %d\n", status);
533 if (hub->has_indicators && blinkenlights)
534 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
536 /* scan all ports ASAP */
540 static int hub_hub_status(struct usb_hub *hub,
541 u16 *status, u16 *change)
545 ret = get_hub_status(hub->hdev, &hub->status->hub);
547 dev_err (hub->intfdev,
548 "%s failed (err = %d)\n", __FUNCTION__, ret);
550 *status = le16_to_cpu(hub->status->hub.wHubStatus);
551 *change = le16_to_cpu(hub->status->hub.wHubChange);
557 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
559 struct usb_device *hdev = hub->hdev;
562 if (hdev->children[port1-1] && set_state) {
563 usb_set_device_state(hdev->children[port1-1],
564 USB_STATE_NOTATTACHED);
566 ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
568 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
575 /* caller has locked the hub device */
576 static void hub_pre_reset(struct usb_interface *intf)
578 struct usb_hub *hub = usb_get_intfdata(intf);
579 struct usb_device *hdev = hub->hdev;
582 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
583 if (hdev->children[port1 - 1]) {
584 usb_disconnect(&hdev->children[port1 - 1]);
586 hub_port_disable(hub, port1, 0);
592 /* caller has locked the hub device */
593 static void hub_post_reset(struct usb_interface *intf)
595 struct usb_hub *hub = usb_get_intfdata(intf);
602 static int hub_configure(struct usb_hub *hub,
603 struct usb_endpoint_descriptor *endpoint)
605 struct usb_device *hdev = hub->hdev;
606 struct device *hub_dev = hub->intfdev;
607 u16 hubstatus, hubchange;
608 u16 wHubCharacteristics;
613 hub->buffer = usb_buffer_alloc(hdev, sizeof(*hub->buffer), GFP_KERNEL,
616 message = "can't allocate hub irq buffer";
621 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
623 message = "can't kmalloc hub status buffer";
628 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
629 if (!hub->descriptor) {
630 message = "can't kmalloc hub descriptor";
635 /* Request the entire hub descriptor.
636 * hub->descriptor can handle USB_MAXCHILDREN ports,
637 * but the hub can/will return fewer bytes here.
639 ret = get_hub_descriptor(hdev, hub->descriptor,
640 sizeof(*hub->descriptor));
642 message = "can't read hub descriptor";
644 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
645 message = "hub has too many ports!";
650 hdev->maxchild = hub->descriptor->bNbrPorts;
651 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
652 (hdev->maxchild == 1) ? "" : "s");
654 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
656 if (wHubCharacteristics & HUB_CHAR_COMPOUND) {
658 char portstr [USB_MAXCHILDREN + 1];
660 for (i = 0; i < hdev->maxchild; i++)
661 portstr[i] = hub->descriptor->DeviceRemovable
662 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
664 portstr[hdev->maxchild] = 0;
665 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
667 dev_dbg(hub_dev, "standalone hub\n");
669 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
671 dev_dbg(hub_dev, "ganged power switching\n");
674 dev_dbg(hub_dev, "individual port power switching\n");
678 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
682 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
684 dev_dbg(hub_dev, "global over-current protection\n");
687 dev_dbg(hub_dev, "individual port over-current protection\n");
691 dev_dbg(hub_dev, "no over-current protection\n");
695 spin_lock_init (&hub->tt.lock);
696 INIT_LIST_HEAD (&hub->tt.clear_list);
697 INIT_WORK (&hub->tt.kevent, hub_tt_kevent, hub);
698 switch (hdev->descriptor.bDeviceProtocol) {
702 dev_dbg(hub_dev, "Single TT\n");
706 ret = usb_set_interface(hdev, 0, 1);
708 dev_dbg(hub_dev, "TT per port\n");
711 dev_err(hub_dev, "Using single TT (err %d)\n",
716 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
717 hdev->descriptor.bDeviceProtocol);
721 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
722 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
723 case HUB_TTTT_8_BITS:
724 if (hdev->descriptor.bDeviceProtocol != 0) {
725 hub->tt.think_time = 666;
726 dev_dbg(hub_dev, "TT requires at most %d "
727 "FS bit times (%d ns)\n",
728 8, hub->tt.think_time);
731 case HUB_TTTT_16_BITS:
732 hub->tt.think_time = 666 * 2;
733 dev_dbg(hub_dev, "TT requires at most %d "
734 "FS bit times (%d ns)\n",
735 16, hub->tt.think_time);
737 case HUB_TTTT_24_BITS:
738 hub->tt.think_time = 666 * 3;
739 dev_dbg(hub_dev, "TT requires at most %d "
740 "FS bit times (%d ns)\n",
741 24, hub->tt.think_time);
743 case HUB_TTTT_32_BITS:
744 hub->tt.think_time = 666 * 4;
745 dev_dbg(hub_dev, "TT requires at most %d "
746 "FS bit times (%d ns)\n",
747 32, hub->tt.think_time);
751 /* probe() zeroes hub->indicator[] */
752 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
753 hub->has_indicators = 1;
754 dev_dbg(hub_dev, "Port indicators are supported\n");
757 dev_dbg(hub_dev, "power on to power good time: %dms\n",
758 hub->descriptor->bPwrOn2PwrGood * 2);
760 /* power budgeting mostly matters with bus-powered hubs,
761 * and battery-powered root hubs (may provide just 8 mA).
763 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
765 message = "can't get hub status";
768 le16_to_cpus(&hubstatus);
769 if (hdev == hdev->bus->root_hub) {
770 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
771 hub->mA_per_port = 500;
773 hub->mA_per_port = hdev->bus_mA;
774 hub->limited_power = 1;
776 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
777 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
778 hub->descriptor->bHubContrCurrent);
779 hub->limited_power = 1;
780 if (hdev->maxchild > 0) {
781 int remaining = hdev->bus_mA -
782 hub->descriptor->bHubContrCurrent;
784 if (remaining < hdev->maxchild * 100)
786 "insufficient power available "
787 "to use all downstream ports\n");
788 hub->mA_per_port = 100; /* 7.2.1.1 */
790 } else { /* Self-powered external hub */
791 /* FIXME: What about battery-powered external hubs that
792 * provide less current per port? */
793 hub->mA_per_port = 500;
795 if (hub->mA_per_port < 500)
796 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
799 ret = hub_hub_status(hub, &hubstatus, &hubchange);
801 message = "can't get hub status";
805 /* local power status reports aren't always correct */
806 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
807 dev_dbg(hub_dev, "local power source is %s\n",
808 (hubstatus & HUB_STATUS_LOCAL_POWER)
809 ? "lost (inactive)" : "good");
811 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
812 dev_dbg(hub_dev, "%sover-current condition exists\n",
813 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
815 /* set up the interrupt endpoint
816 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
817 * bytes as USB2.0[11.12.3] says because some hubs are known
818 * to send more data (and thus cause overflow). For root hubs,
819 * maxpktsize is defined in hcd.c's fake endpoint descriptors
820 * to be big enough for at least USB_MAXCHILDREN ports. */
821 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
822 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
824 if (maxp > sizeof(*hub->buffer))
825 maxp = sizeof(*hub->buffer);
827 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
829 message = "couldn't allocate interrupt urb";
834 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
835 hub, endpoint->bInterval);
836 hub->urb->transfer_dma = hub->buffer_dma;
837 hub->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
839 /* maybe cycle the hub leds */
840 if (hub->has_indicators && blinkenlights)
841 hub->indicator [0] = INDICATOR_CYCLE;
848 dev_err (hub_dev, "config failed, %s (err %d)\n",
850 /* hub_disconnect() frees urb and descriptor */
854 static unsigned highspeed_hubs;
856 static void hub_disconnect(struct usb_interface *intf)
858 struct usb_hub *hub = usb_get_intfdata (intf);
859 struct usb_device *hdev;
861 /* Disconnect all children and quiesce the hub */
865 usb_set_intfdata (intf, NULL);
868 if (hdev->speed == USB_SPEED_HIGH)
871 usb_free_urb(hub->urb);
874 spin_lock_irq(&hub_event_lock);
875 list_del_init(&hub->event_list);
876 spin_unlock_irq(&hub_event_lock);
878 kfree(hub->descriptor);
879 hub->descriptor = NULL;
885 usb_buffer_free(hdev, sizeof(*hub->buffer), hub->buffer,
893 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
895 struct usb_host_interface *desc;
896 struct usb_endpoint_descriptor *endpoint;
897 struct usb_device *hdev;
900 desc = intf->cur_altsetting;
901 hdev = interface_to_usbdev(intf);
903 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
905 dev_warn(&intf->dev, "ignoring external hub\n");
910 /* Some hubs have a subclass of 1, which AFAICT according to the */
911 /* specs is not defined, but it works */
912 if ((desc->desc.bInterfaceSubClass != 0) &&
913 (desc->desc.bInterfaceSubClass != 1)) {
915 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
919 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
920 if (desc->desc.bNumEndpoints != 1)
921 goto descriptor_error;
923 endpoint = &desc->endpoint[0].desc;
925 /* If it's not an interrupt in endpoint, we'd better punt! */
926 if (!usb_endpoint_is_int_in(endpoint))
927 goto descriptor_error;
930 dev_info (&intf->dev, "USB hub found\n");
932 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
934 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
938 INIT_LIST_HEAD(&hub->event_list);
939 hub->intfdev = &intf->dev;
941 INIT_WORK(&hub->leds, led_work, hub);
943 usb_set_intfdata (intf, hub);
944 intf->needs_remote_wakeup = 1;
946 if (hdev->speed == USB_SPEED_HIGH)
949 if (hub_configure(hub, endpoint) >= 0)
952 hub_disconnect (intf);
957 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
959 struct usb_device *hdev = interface_to_usbdev (intf);
961 /* assert ifno == 0 (part of hub spec) */
963 case USBDEVFS_HUB_PORTINFO: {
964 struct usbdevfs_hub_portinfo *info = user_data;
967 spin_lock_irq(&device_state_lock);
968 if (hdev->devnum <= 0)
971 info->nports = hdev->maxchild;
972 for (i = 0; i < info->nports; i++) {
973 if (hdev->children[i] == NULL)
977 hdev->children[i]->devnum;
980 spin_unlock_irq(&device_state_lock);
982 return info->nports + 1;
991 /* grab device/port lock, returning index of that port (zero based).
992 * protects the upstream link used by this device from concurrent
993 * tree operations like suspend, resume, reset, and disconnect, which
994 * apply to everything downstream of a given port.
996 static int locktree(struct usb_device *udev)
999 struct usb_device *hdev;
1004 /* root hub is always the first lock in the series */
1005 hdev = udev->parent;
1007 usb_lock_device(udev);
1011 /* on the path from root to us, lock everything from
1012 * top down, dropping parent locks when not needed
1018 /* everything is fail-fast once disconnect
1021 if (udev->state == USB_STATE_NOTATTACHED) {
1022 usb_unlock_device(hdev);
1026 /* when everyone grabs locks top->bottom,
1027 * non-overlapping work may be concurrent
1029 usb_lock_device(udev);
1030 usb_unlock_device(hdev);
1031 return udev->portnum;
1034 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1038 for (i = 0; i < udev->maxchild; ++i) {
1039 if (udev->children[i])
1040 recursively_mark_NOTATTACHED(udev->children[i]);
1042 udev->state = USB_STATE_NOTATTACHED;
1046 * usb_set_device_state - change a device's current state (usbcore, hcds)
1047 * @udev: pointer to device whose state should be changed
1048 * @new_state: new state value to be stored
1050 * udev->state is _not_ fully protected by the device lock. Although
1051 * most transitions are made only while holding the lock, the state can
1052 * can change to USB_STATE_NOTATTACHED at almost any time. This
1053 * is so that devices can be marked as disconnected as soon as possible,
1054 * without having to wait for any semaphores to be released. As a result,
1055 * all changes to any device's state must be protected by the
1056 * device_state_lock spinlock.
1058 * Once a device has been added to the device tree, all changes to its state
1059 * should be made using this routine. The state should _not_ be set directly.
1061 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1062 * Otherwise udev->state is set to new_state, and if new_state is
1063 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1064 * to USB_STATE_NOTATTACHED.
1066 void usb_set_device_state(struct usb_device *udev,
1067 enum usb_device_state new_state)
1069 unsigned long flags;
1071 spin_lock_irqsave(&device_state_lock, flags);
1072 if (udev->state == USB_STATE_NOTATTACHED)
1074 else if (new_state != USB_STATE_NOTATTACHED) {
1076 /* root hub wakeup capabilities are managed out-of-band
1077 * and may involve silicon errata ... ignore them here.
1080 if (udev->state == USB_STATE_SUSPENDED
1081 || new_state == USB_STATE_SUSPENDED)
1082 ; /* No change to wakeup settings */
1083 else if (new_state == USB_STATE_CONFIGURED)
1084 device_init_wakeup(&udev->dev,
1085 (udev->actconfig->desc.bmAttributes
1086 & USB_CONFIG_ATT_WAKEUP));
1088 device_init_wakeup(&udev->dev, 0);
1090 udev->state = new_state;
1092 recursively_mark_NOTATTACHED(udev);
1093 spin_unlock_irqrestore(&device_state_lock, flags);
1100 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
1101 * @rhdev: struct usb_device for the root hub
1103 * The USB host controller driver calls this function when its root hub
1104 * is resumed and Vbus power has been interrupted or the controller
1105 * has been reset. The routine marks all the children of the root hub
1106 * as NOTATTACHED and marks logical connect-change events on their ports.
1108 void usb_root_hub_lost_power(struct usb_device *rhdev)
1110 struct usb_hub *hub;
1112 unsigned long flags;
1114 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
1116 /* Make sure no potential wakeup events get lost,
1117 * by forcing the root hub to be resumed.
1119 rhdev->dev.power.prev_state.event = PM_EVENT_ON;
1121 spin_lock_irqsave(&device_state_lock, flags);
1122 hub = hdev_to_hub(rhdev);
1123 for (port1 = 1; port1 <= rhdev->maxchild; ++port1) {
1124 if (rhdev->children[port1 - 1]) {
1125 recursively_mark_NOTATTACHED(
1126 rhdev->children[port1 - 1]);
1127 set_bit(port1, hub->change_bits);
1130 spin_unlock_irqrestore(&device_state_lock, flags);
1132 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
1134 #endif /* CONFIG_PM */
1136 static void choose_address(struct usb_device *udev)
1139 struct usb_bus *bus = udev->bus;
1141 /* If khubd ever becomes multithreaded, this will need a lock */
1143 /* Try to allocate the next devnum beginning at bus->devnum_next. */
1144 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1147 devnum = find_next_zero_bit(bus->devmap.devicemap, 128, 1);
1149 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1152 set_bit(devnum, bus->devmap.devicemap);
1153 udev->devnum = devnum;
1157 static void release_address(struct usb_device *udev)
1159 if (udev->devnum > 0) {
1160 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1166 * usb_disconnect - disconnect a device (usbcore-internal)
1167 * @pdev: pointer to device being disconnected
1168 * Context: !in_interrupt ()
1170 * Something got disconnected. Get rid of it and all of its children.
1172 * If *pdev is a normal device then the parent hub must already be locked.
1173 * If *pdev is a root hub then this routine will acquire the
1174 * usb_bus_list_lock on behalf of the caller.
1176 * Only hub drivers (including virtual root hub drivers for host
1177 * controllers) should ever call this.
1179 * This call is synchronous, and may not be used in an interrupt context.
1181 void usb_disconnect(struct usb_device **pdev)
1183 struct usb_device *udev = *pdev;
1187 pr_debug ("%s nodev\n", __FUNCTION__);
1191 /* mark the device as inactive, so any further urb submissions for
1192 * this device (and any of its children) will fail immediately.
1193 * this quiesces everyting except pending urbs.
1195 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1196 dev_info (&udev->dev, "USB disconnect, address %d\n", udev->devnum);
1198 usb_lock_device(udev);
1200 /* Free up all the children before we remove this device */
1201 for (i = 0; i < USB_MAXCHILDREN; i++) {
1202 if (udev->children[i])
1203 usb_disconnect(&udev->children[i]);
1206 /* deallocate hcd/hardware state ... nuking all pending urbs and
1207 * cleaning up all state associated with the current configuration
1208 * so that the hardware is now fully quiesced.
1210 dev_dbg (&udev->dev, "unregistering device\n");
1211 usb_disable_device(udev, 0);
1213 usb_unlock_device(udev);
1215 /* Unregister the device. The device driver is responsible
1216 * for removing the device files from usbfs and sysfs and for
1217 * de-configuring the device.
1219 device_del(&udev->dev);
1221 /* Free the device number and delete the parent's children[]
1222 * (or root_hub) pointer.
1224 release_address(udev);
1226 /* Avoid races with recursively_mark_NOTATTACHED() */
1227 spin_lock_irq(&device_state_lock);
1229 spin_unlock_irq(&device_state_lock);
1231 put_device(&udev->dev);
1235 static void show_string(struct usb_device *udev, char *id, char *string)
1239 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1243 static inline void show_string(struct usb_device *udev, char *id, char *string)
1248 #ifdef CONFIG_USB_OTG
1249 #include "otg_whitelist.h"
1250 static int __usb_port_suspend(struct usb_device *, int port1);
1253 static int __usb_new_device(void *void_data)
1255 struct usb_device *udev = void_data;
1258 /* Lock ourself into memory in order to keep a probe sequence
1259 * sleeping in a new thread from allowing us to be unloaded.
1261 if (!try_module_get(THIS_MODULE))
1264 err = usb_get_configuration(udev);
1266 dev_err(&udev->dev, "can't read configurations, error %d\n",
1271 /* read the standard strings and cache them if present */
1272 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1273 udev->manufacturer = usb_cache_string(udev,
1274 udev->descriptor.iManufacturer);
1275 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
1277 /* Tell the world! */
1278 dev_dbg(&udev->dev, "new device strings: Mfr=%d, Product=%d, "
1279 "SerialNumber=%d\n",
1280 udev->descriptor.iManufacturer,
1281 udev->descriptor.iProduct,
1282 udev->descriptor.iSerialNumber);
1283 show_string(udev, "Product", udev->product);
1284 show_string(udev, "Manufacturer", udev->manufacturer);
1285 show_string(udev, "SerialNumber", udev->serial);
1287 #ifdef CONFIG_USB_OTG
1289 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1290 * to wake us after we've powered off VBUS; and HNP, switching roles
1291 * "host" to "peripheral". The OTG descriptor helps figure this out.
1293 if (!udev->bus->is_b_host
1295 && udev->parent == udev->bus->root_hub) {
1296 struct usb_otg_descriptor *desc = 0;
1297 struct usb_bus *bus = udev->bus;
1299 /* descriptor may appear anywhere in config */
1300 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1301 le16_to_cpu(udev->config[0].desc.wTotalLength),
1302 USB_DT_OTG, (void **) &desc) == 0) {
1303 if (desc->bmAttributes & USB_OTG_HNP) {
1304 unsigned port1 = udev->portnum;
1306 dev_info(&udev->dev,
1307 "Dual-Role OTG device on %sHNP port\n",
1308 (port1 == bus->otg_port)
1311 /* enable HNP before suspend, it's simpler */
1312 if (port1 == bus->otg_port)
1313 bus->b_hnp_enable = 1;
1314 err = usb_control_msg(udev,
1315 usb_sndctrlpipe(udev, 0),
1316 USB_REQ_SET_FEATURE, 0,
1318 ? USB_DEVICE_B_HNP_ENABLE
1319 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1320 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1322 /* OTG MESSAGE: report errors here,
1323 * customize to match your product.
1325 dev_info(&udev->dev,
1326 "can't set HNP mode; %d\n",
1328 bus->b_hnp_enable = 0;
1334 if (!is_targeted(udev)) {
1336 /* Maybe it can talk to us, though we can't talk to it.
1337 * (Includes HNP test device.)
1339 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
1340 err = __usb_port_suspend(udev, udev->bus->otg_port);
1342 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1349 /* Register the device. The device driver is responsible
1350 * for adding the device files to usbfs and sysfs and for
1351 * configuring the device.
1353 err = device_add (&udev->dev);
1355 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1360 module_put(THIS_MODULE);
1364 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1369 * usb_new_device - perform initial device setup (usbcore-internal)
1370 * @udev: newly addressed device (in ADDRESS state)
1372 * This is called with devices which have been enumerated, but not yet
1373 * configured. The device descriptor is available, but not descriptors
1374 * for any device configuration. The caller must have locked either
1375 * the parent hub (if udev is a normal device) or else the
1376 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1377 * udev has already been installed, but udev is not yet visible through
1378 * sysfs or other filesystem code.
1380 * The return value for this function depends on if the
1381 * multithread_probe variable is set or not. If it's set, it will
1382 * return a if the probe thread was successfully created or not. If the
1383 * variable is not set, it will return if the device is configured
1384 * properly or not. interfaces, in sysfs); else a negative errno value.
1386 * This call is synchronous, and may not be used in an interrupt context.
1388 * Only the hub driver or root-hub registrar should ever call this.
1390 int usb_new_device(struct usb_device *udev)
1392 struct task_struct *probe_task;
1395 if (multithread_probe) {
1396 probe_task = kthread_run(__usb_new_device, udev,
1397 "usb-probe-%s", udev->devnum);
1398 if (IS_ERR(probe_task))
1399 ret = PTR_ERR(probe_task);
1401 ret = __usb_new_device(udev);
1406 static int hub_port_status(struct usb_hub *hub, int port1,
1407 u16 *status, u16 *change)
1411 ret = get_port_status(hub->hdev, port1, &hub->status->port);
1413 dev_err (hub->intfdev,
1414 "%s failed (err = %d)\n", __FUNCTION__, ret);
1418 *status = le16_to_cpu(hub->status->port.wPortStatus);
1419 *change = le16_to_cpu(hub->status->port.wPortChange);
1426 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
1427 static unsigned hub_is_wusb(struct usb_hub *hub)
1429 struct usb_hcd *hcd;
1430 if (hub->hdev->parent != NULL) /* not a root hub? */
1432 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
1433 return hcd->wireless;
1437 #define PORT_RESET_TRIES 5
1438 #define SET_ADDRESS_TRIES 2
1439 #define GET_DESCRIPTOR_TRIES 2
1440 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1441 #define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1443 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1444 #define HUB_SHORT_RESET_TIME 10
1445 #define HUB_LONG_RESET_TIME 200
1446 #define HUB_RESET_TIMEOUT 500
1448 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
1449 struct usb_device *udev, unsigned int delay)
1451 int delay_time, ret;
1455 for (delay_time = 0;
1456 delay_time < HUB_RESET_TIMEOUT;
1457 delay_time += delay) {
1458 /* wait to give the device a chance to reset */
1461 /* read and decode port status */
1462 ret = hub_port_status(hub, port1, &portstatus, &portchange);
1466 /* Device went away? */
1467 if (!(portstatus & USB_PORT_STAT_CONNECTION))
1470 /* bomb out completely if something weird happened */
1471 if ((portchange & USB_PORT_STAT_C_CONNECTION))
1474 /* if we`ve finished resetting, then break out of the loop */
1475 if (!(portstatus & USB_PORT_STAT_RESET) &&
1476 (portstatus & USB_PORT_STAT_ENABLE)) {
1477 if (hub_is_wusb(hub))
1478 udev->speed = USB_SPEED_VARIABLE;
1479 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
1480 udev->speed = USB_SPEED_HIGH;
1481 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
1482 udev->speed = USB_SPEED_LOW;
1484 udev->speed = USB_SPEED_FULL;
1488 /* switch to the long delay after two short delay failures */
1489 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
1490 delay = HUB_LONG_RESET_TIME;
1492 dev_dbg (hub->intfdev,
1493 "port %d not reset yet, waiting %dms\n",
1500 static int hub_port_reset(struct usb_hub *hub, int port1,
1501 struct usb_device *udev, unsigned int delay)
1505 /* Reset the port */
1506 for (i = 0; i < PORT_RESET_TRIES; i++) {
1507 status = set_port_feature(hub->hdev,
1508 port1, USB_PORT_FEAT_RESET);
1510 dev_err(hub->intfdev,
1511 "cannot reset port %d (err = %d)\n",
1514 status = hub_port_wait_reset(hub, port1, udev, delay);
1515 if (status && status != -ENOTCONN)
1516 dev_dbg(hub->intfdev,
1517 "port_wait_reset: err = %d\n",
1521 /* return on disconnect or reset */
1524 /* TRSTRCY = 10 ms; plus some extra */
1529 clear_port_feature(hub->hdev,
1530 port1, USB_PORT_FEAT_C_RESET);
1531 /* FIXME need disconnect() for NOTATTACHED device */
1532 usb_set_device_state(udev, status
1533 ? USB_STATE_NOTATTACHED
1534 : USB_STATE_DEFAULT);
1538 dev_dbg (hub->intfdev,
1539 "port %d not enabled, trying reset again...\n",
1541 delay = HUB_LONG_RESET_TIME;
1544 dev_err (hub->intfdev,
1545 "Cannot enable port %i. Maybe the USB cable is bad?\n",
1552 * Disable a port and mark a logical connnect-change event, so that some
1553 * time later khubd will disconnect() any existing usb_device on the port
1554 * and will re-enumerate if there actually is a device attached.
1556 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
1558 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
1559 hub_port_disable(hub, port1, 1);
1561 /* FIXME let caller ask to power down the port:
1562 * - some devices won't enumerate without a VBUS power cycle
1563 * - SRP saves power that way
1564 * - ... new call, TBD ...
1565 * That's easy if this hub can switch power per-port, and
1566 * khubd reactivates the port later (timer, SRP, etc).
1567 * Powerdown must be optional, because of reset/DFU.
1570 set_bit(port1, hub->change_bits);
1576 #ifdef CONFIG_USB_SUSPEND
1579 * Selective port suspend reduces power; most suspended devices draw
1580 * less than 500 uA. It's also used in OTG, along with remote wakeup.
1581 * All devices below the suspended port are also suspended.
1583 * Devices leave suspend state when the host wakes them up. Some devices
1584 * also support "remote wakeup", where the device can activate the USB
1585 * tree above them to deliver data, such as a keypress or packet. In
1586 * some cases, this wakes the USB host.
1588 static int hub_port_suspend(struct usb_hub *hub, int port1,
1589 struct usb_device *udev)
1593 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
1595 /* enable remote wakeup when appropriate; this lets the device
1596 * wake up the upstream hub (including maybe the root hub).
1598 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
1599 * we don't explicitly enable it here.
1601 if (udev->do_remote_wakeup) {
1602 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1603 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
1604 USB_DEVICE_REMOTE_WAKEUP, 0,
1606 USB_CTRL_SET_TIMEOUT);
1609 "won't remote wakeup, status %d\n",
1614 status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
1616 dev_dbg(hub->intfdev,
1617 "can't suspend port %d, status %d\n",
1619 /* paranoia: "should not happen" */
1620 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1621 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
1622 USB_DEVICE_REMOTE_WAKEUP, 0,
1624 USB_CTRL_SET_TIMEOUT);
1626 /* device has up to 10 msec to fully suspend */
1627 dev_dbg(&udev->dev, "usb %ssuspend\n",
1628 udev->auto_pm ? "auto-" : "");
1629 usb_set_device_state(udev, USB_STATE_SUSPENDED);
1636 * Devices on USB hub ports have only one "suspend" state, corresponding
1637 * to ACPI D2, "may cause the device to lose some context".
1638 * State transitions include:
1640 * - suspend, resume ... when the VBUS power link stays live
1641 * - suspend, disconnect ... VBUS lost
1643 * Once VBUS drop breaks the circuit, the port it's using has to go through
1644 * normal re-enumeration procedures, starting with enabling VBUS power.
1645 * Other than re-initializing the hub (plug/unplug, except for root hubs),
1646 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
1647 * timer, no SRP, no requests through sysfs.
1649 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
1650 * the root hub for their bus goes into global suspend ... so we don't
1651 * (falsely) update the device power state to say it suspended.
1653 static int __usb_port_suspend (struct usb_device *udev, int port1)
1657 /* caller owns the udev device lock */
1661 /* we change the device's upstream USB link,
1662 * but root hubs have no upstream USB link.
1665 status = hub_port_suspend(hdev_to_hub(udev->parent), port1,
1668 dev_dbg(&udev->dev, "usb %ssuspend\n",
1669 udev->auto_pm ? "auto-" : "");
1670 usb_set_device_state(udev, USB_STATE_SUSPENDED);
1676 * usb_port_suspend - suspend a usb device's upstream port
1677 * @udev: device that's no longer in active use
1678 * Context: must be able to sleep; device not locked; pm locks held
1680 * Suspends a USB device that isn't in active use, conserving power.
1681 * Devices may wake out of a suspend, if anything important happens,
1682 * using the remote wakeup mechanism. They may also be taken out of
1683 * suspend by the host, using usb_port_resume(). It's also routine
1684 * to disconnect devices while they are suspended.
1686 * This only affects the USB hardware for a device; its interfaces
1687 * (and, for hubs, child devices) must already have been suspended.
1689 * Suspending OTG devices may trigger HNP, if that's been enabled
1690 * between a pair of dual-role devices. That will change roles, such
1691 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
1693 * Returns 0 on success, else negative errno.
1695 int usb_port_suspend(struct usb_device *udev)
1697 return __usb_port_suspend(udev, udev->portnum);
1701 * If the USB "suspend" state is in use (rather than "global suspend"),
1702 * many devices will be individually taken out of suspend state using
1703 * special" resume" signaling. These routines kick in shortly after
1704 * hardware resume signaling is finished, either because of selective
1705 * resume (by host) or remote wakeup (by device) ... now see what changed
1706 * in the tree that's rooted at this device.
1708 static int finish_port_resume(struct usb_device *udev)
1713 /* caller owns the udev device lock */
1714 dev_dbg(&udev->dev, "finish resume\n");
1716 /* usb ch9 identifies four variants of SUSPENDED, based on what
1717 * state the device resumes to. Linux currently won't see the
1718 * first two on the host side; they'd be inside hub_port_init()
1719 * during many timeouts, but khubd can't suspend until later.
1721 usb_set_device_state(udev, udev->actconfig
1722 ? USB_STATE_CONFIGURED
1723 : USB_STATE_ADDRESS);
1725 /* 10.5.4.5 says be sure devices in the tree are still there.
1726 * For now let's assume the device didn't go crazy on resume,
1727 * and device drivers will know about any resume quirks.
1729 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
1731 status = (status == 2 ? 0 : -ENODEV);
1735 "gone after usb resume? status %d\n",
1737 else if (udev->actconfig) {
1738 le16_to_cpus(&devstatus);
1739 if ((devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
1741 status = usb_control_msg(udev,
1742 usb_sndctrlpipe(udev, 0),
1743 USB_REQ_CLEAR_FEATURE,
1745 USB_DEVICE_REMOTE_WAKEUP, 0,
1747 USB_CTRL_SET_TIMEOUT);
1749 dev_dbg(&udev->dev, "disable remote "
1750 "wakeup, status %d\n", status);
1754 } else if (udev->devnum <= 0) {
1755 dev_dbg(&udev->dev, "bogus resume!\n");
1762 hub_port_resume(struct usb_hub *hub, int port1, struct usb_device *udev)
1765 u16 portchange, portstatus;
1767 /* Skip the initial Clear-Suspend step for a remote wakeup */
1768 status = hub_port_status(hub, port1, &portstatus, &portchange);
1769 if (status == 0 && !(portstatus & USB_PORT_STAT_SUSPEND))
1770 goto SuspendCleared;
1772 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
1774 set_bit(port1, hub->busy_bits);
1776 /* see 7.1.7.7; affects power usage, but not budgeting */
1777 status = clear_port_feature(hub->hdev,
1778 port1, USB_PORT_FEAT_SUSPEND);
1780 dev_dbg(hub->intfdev,
1781 "can't resume port %d, status %d\n",
1784 /* drive resume for at least 20 msec */
1786 dev_dbg(&udev->dev, "usb %sresume\n",
1787 udev->auto_pm ? "auto-" : "");
1790 #define LIVE_FLAGS ( USB_PORT_STAT_POWER \
1791 | USB_PORT_STAT_ENABLE \
1792 | USB_PORT_STAT_CONNECTION)
1794 /* Virtual root hubs can trigger on GET_PORT_STATUS to
1795 * stop resume signaling. Then finish the resume
1798 status = hub_port_status(hub, port1, &portstatus, &portchange);
1801 || (portstatus & LIVE_FLAGS) != LIVE_FLAGS
1802 || (portstatus & USB_PORT_STAT_SUSPEND) != 0
1804 dev_dbg(hub->intfdev,
1805 "port %d status %04x.%04x after resume, %d\n",
1806 port1, portchange, portstatus, status);
1810 if (portchange & USB_PORT_STAT_C_SUSPEND)
1811 clear_port_feature(hub->hdev, port1,
1812 USB_PORT_FEAT_C_SUSPEND);
1813 /* TRSMRCY = 10 msec */
1816 status = finish_port_resume(udev);
1820 hub_port_logical_disconnect(hub, port1);
1822 clear_bit(port1, hub->busy_bits);
1823 if (!hub->hdev->parent && !hub->busy_bits[0])
1824 usb_enable_root_hub_irq(hub->hdev->bus);
1830 * usb_port_resume - re-activate a suspended usb device's upstream port
1831 * @udev: device to re-activate
1832 * Context: must be able to sleep; device not locked; pm locks held
1834 * This will re-activate the suspended device, increasing power usage
1835 * while letting drivers communicate again with its endpoints.
1836 * USB resume explicitly guarantees that the power session between
1837 * the host and the device is the same as it was when the device
1840 * Returns 0 on success, else negative errno.
1842 int usb_port_resume(struct usb_device *udev)
1846 /* we change the device's upstream USB link,
1847 * but root hubs have no upstream USB link.
1850 // NOTE this fails if parent is also suspended...
1851 status = hub_port_resume(hdev_to_hub(udev->parent),
1852 udev->portnum, udev);
1854 dev_dbg(&udev->dev, "usb %sresume\n",
1855 udev->auto_pm ? "auto-" : "");
1856 status = finish_port_resume(udev);
1859 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
1863 static int remote_wakeup(struct usb_device *udev)
1867 usb_lock_device(udev);
1868 if (udev->state == USB_STATE_SUSPENDED) {
1869 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
1870 status = usb_autoresume_device(udev, 1);
1872 /* Give the interface drivers a chance to do something,
1873 * then autosuspend the device again. */
1875 usb_autosuspend_device(udev, 1);
1877 usb_unlock_device(udev);
1881 #else /* CONFIG_USB_SUSPEND */
1883 /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
1885 int usb_port_suspend(struct usb_device *udev)
1891 finish_port_resume(struct usb_device *udev)
1897 hub_port_resume(struct usb_hub *hub, int port1, struct usb_device *udev)
1902 int usb_port_resume(struct usb_device *udev)
1907 static inline int remote_wakeup(struct usb_device *udev)
1914 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
1916 struct usb_hub *hub = usb_get_intfdata (intf);
1917 struct usb_device *hdev = hub->hdev;
1920 /* fail if children aren't already suspended */
1921 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
1922 struct usb_device *udev;
1924 udev = hdev->children [port1-1];
1925 if (udev && msg.event == PM_EVENT_SUSPEND &&
1926 #ifdef CONFIG_USB_SUSPEND
1927 udev->state != USB_STATE_SUSPENDED
1929 udev->dev.power.power_state.event
1934 dev_dbg(&intf->dev, "port %d nyet suspended\n",
1940 dev_dbg(&intf->dev, "%s\n", __FUNCTION__);
1942 /* "global suspend" of the downstream HC-to-USB interface */
1943 if (!hdev->parent) {
1944 struct usb_bus *bus = hdev->bus;
1946 int status = hcd_bus_suspend (bus);
1949 dev_dbg(&hdev->dev, "'global' suspend %d\n",
1957 /* stop khubd and related activity */
1962 static int hub_resume(struct usb_interface *intf)
1964 struct usb_hub *hub = usb_get_intfdata (intf);
1965 struct usb_device *hdev = hub->hdev;
1968 dev_dbg(&intf->dev, "%s\n", __FUNCTION__);
1970 /* "global resume" of the downstream HC-to-USB interface */
1971 if (!hdev->parent) {
1972 struct usb_bus *bus = hdev->bus;
1974 status = hcd_bus_resume (bus);
1976 dev_dbg(&intf->dev, "'global' resume %d\n",
1983 /* TRSMRCY = 10 msec */
1988 /* tell khubd to look for changes on this hub */
1993 #else /* CONFIG_PM */
1995 static inline int remote_wakeup(struct usb_device *udev)
2000 #define hub_suspend NULL
2001 #define hub_resume NULL
2004 void usb_resume_root_hub(struct usb_device *hdev)
2006 struct usb_hub *hub = hdev_to_hub(hdev);
2012 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2014 * Between connect detection and reset signaling there must be a delay
2015 * of 100ms at least for debounce and power-settling. The corresponding
2016 * timer shall restart whenever the downstream port detects a disconnect.
2018 * Apparently there are some bluetooth and irda-dongles and a number of
2019 * low-speed devices for which this debounce period may last over a second.
2020 * Not covered by the spec - but easy to deal with.
2022 * This implementation uses a 1500ms total debounce timeout; if the
2023 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2024 * every 25ms for transient disconnects. When the port status has been
2025 * unchanged for 100ms it returns the port status.
2028 #define HUB_DEBOUNCE_TIMEOUT 1500
2029 #define HUB_DEBOUNCE_STEP 25
2030 #define HUB_DEBOUNCE_STABLE 100
2032 static int hub_port_debounce(struct usb_hub *hub, int port1)
2035 int total_time, stable_time = 0;
2036 u16 portchange, portstatus;
2037 unsigned connection = 0xffff;
2039 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2040 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2044 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2045 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2046 stable_time += HUB_DEBOUNCE_STEP;
2047 if (stable_time >= HUB_DEBOUNCE_STABLE)
2051 connection = portstatus & USB_PORT_STAT_CONNECTION;
2054 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2055 clear_port_feature(hub->hdev, port1,
2056 USB_PORT_FEAT_C_CONNECTION);
2059 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2061 msleep(HUB_DEBOUNCE_STEP);
2064 dev_dbg (hub->intfdev,
2065 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2066 port1, total_time, stable_time, portstatus);
2068 if (stable_time < HUB_DEBOUNCE_STABLE)
2073 static void ep0_reinit(struct usb_device *udev)
2075 usb_disable_endpoint(udev, 0 + USB_DIR_IN);
2076 usb_disable_endpoint(udev, 0 + USB_DIR_OUT);
2077 udev->ep_in[0] = udev->ep_out[0] = &udev->ep0;
2080 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2081 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2083 static int hub_set_address(struct usb_device *udev)
2087 if (udev->devnum == 0)
2089 if (udev->state == USB_STATE_ADDRESS)
2091 if (udev->state != USB_STATE_DEFAULT)
2093 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2094 USB_REQ_SET_ADDRESS, 0, udev->devnum, 0,
2095 NULL, 0, USB_CTRL_SET_TIMEOUT);
2097 usb_set_device_state(udev, USB_STATE_ADDRESS);
2103 /* Reset device, (re)assign address, get device descriptor.
2104 * Device connection must be stable, no more debouncing needed.
2105 * Returns device in USB_STATE_ADDRESS, except on error.
2107 * If this is called for an already-existing device (as part of
2108 * usb_reset_device), the caller must own the device lock. For a
2109 * newly detected device that is not accessible through any global
2110 * pointers, it's not necessary to lock the device.
2113 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2116 static DEFINE_MUTEX(usb_address0_mutex);
2118 struct usb_device *hdev = hub->hdev;
2120 unsigned delay = HUB_SHORT_RESET_TIME;
2121 enum usb_device_speed oldspeed = udev->speed;
2124 /* root hub ports have a slightly longer reset period
2125 * (from USB 2.0 spec, section 7.1.7.5)
2127 if (!hdev->parent) {
2128 delay = HUB_ROOT_RESET_TIME;
2129 if (port1 == hdev->bus->otg_port)
2130 hdev->bus->b_hnp_enable = 0;
2133 /* Some low speed devices have problems with the quick delay, so */
2134 /* be a bit pessimistic with those devices. RHbug #23670 */
2135 if (oldspeed == USB_SPEED_LOW)
2136 delay = HUB_LONG_RESET_TIME;
2138 mutex_lock(&usb_address0_mutex);
2140 /* Reset the device; full speed may morph to high speed */
2141 retval = hub_port_reset(hub, port1, udev, delay);
2142 if (retval < 0) /* error or disconnect */
2144 /* success, speed is known */
2147 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2148 dev_dbg(&udev->dev, "device reset changed speed!\n");
2151 oldspeed = udev->speed;
2153 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2154 * it's fixed size except for full speed devices.
2155 * For Wireless USB devices, ep0 max packet is always 512 (tho
2156 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
2158 switch (udev->speed) {
2159 case USB_SPEED_VARIABLE: /* fixed at 512 */
2160 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(512);
2162 case USB_SPEED_HIGH: /* fixed at 64 */
2163 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2165 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
2166 /* to determine the ep0 maxpacket size, try to read
2167 * the device descriptor to get bMaxPacketSize0 and
2168 * then correct our initial guess.
2170 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2172 case USB_SPEED_LOW: /* fixed at 8 */
2173 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(8);
2180 switch (udev->speed) {
2181 case USB_SPEED_LOW: speed = "low"; break;
2182 case USB_SPEED_FULL: speed = "full"; break;
2183 case USB_SPEED_HIGH: speed = "high"; break;
2184 case USB_SPEED_VARIABLE:
2188 default: speed = "?"; break;
2190 dev_info (&udev->dev,
2191 "%s %s speed %sUSB device using %s and address %d\n",
2192 (udev->config) ? "reset" : "new", speed, type,
2193 udev->bus->controller->driver->name, udev->devnum);
2195 /* Set up TT records, if needed */
2197 udev->tt = hdev->tt;
2198 udev->ttport = hdev->ttport;
2199 } else if (udev->speed != USB_SPEED_HIGH
2200 && hdev->speed == USB_SPEED_HIGH) {
2201 udev->tt = &hub->tt;
2202 udev->ttport = port1;
2205 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2206 * Because device hardware and firmware is sometimes buggy in
2207 * this area, and this is how Linux has done it for ages.
2208 * Change it cautiously.
2210 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2211 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2212 * so it may help with some non-standards-compliant devices.
2213 * Otherwise we start with SET_ADDRESS and then try to read the
2214 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2217 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
2218 if (USE_NEW_SCHEME(retry_counter)) {
2219 struct usb_device_descriptor *buf;
2222 #define GET_DESCRIPTOR_BUFSIZE 64
2223 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2229 /* Use a short timeout the first time through,
2230 * so that recalcitrant full-speed devices with
2231 * 8- or 16-byte ep0-maxpackets won't slow things
2232 * down tremendously by NAKing the unexpectedly
2233 * early status stage. Also, retry on all errors;
2234 * some devices are flakey.
2235 * 255 is for WUSB devices, we actually need to use 512.
2238 for (j = 0; j < 3; ++j) {
2239 buf->bMaxPacketSize0 = 0;
2240 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2241 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2242 USB_DT_DEVICE << 8, 0,
2243 buf, GET_DESCRIPTOR_BUFSIZE,
2244 (i ? USB_CTRL_GET_TIMEOUT : 1000));
2245 switch (buf->bMaxPacketSize0) {
2246 case 8: case 16: case 32: case 64: case 255:
2247 if (buf->bDescriptorType ==
2261 udev->descriptor.bMaxPacketSize0 =
2262 buf->bMaxPacketSize0;
2265 retval = hub_port_reset(hub, port1, udev, delay);
2266 if (retval < 0) /* error or disconnect */
2268 if (oldspeed != udev->speed) {
2270 "device reset changed speed!\n");
2275 dev_err(&udev->dev, "device descriptor "
2276 "read/%s, error %d\n",
2281 #undef GET_DESCRIPTOR_BUFSIZE
2284 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
2285 retval = hub_set_address(udev);
2292 "device not accepting address %d, error %d\n",
2293 udev->devnum, retval);
2297 /* cope with hardware quirkiness:
2298 * - let SET_ADDRESS settle, some device hardware wants it
2299 * - read ep0 maxpacket even for high and low speed,
2302 if (USE_NEW_SCHEME(retry_counter))
2305 retval = usb_get_device_descriptor(udev, 8);
2307 dev_err(&udev->dev, "device descriptor "
2308 "read/%s, error %d\n",
2320 i = udev->descriptor.bMaxPacketSize0 == 0xff?
2321 512 : udev->descriptor.bMaxPacketSize0;
2322 if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
2323 if (udev->speed != USB_SPEED_FULL ||
2324 !(i == 8 || i == 16 || i == 32 || i == 64)) {
2325 dev_err(&udev->dev, "ep0 maxpacket = %d\n", i);
2329 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
2330 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
2334 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
2335 if (retval < (signed)sizeof(udev->descriptor)) {
2336 dev_err(&udev->dev, "device descriptor read/%s, error %d\n",
2347 hub_port_disable(hub, port1, 0);
2348 mutex_unlock(&usb_address0_mutex);
2353 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
2355 struct usb_qualifier_descriptor *qual;
2358 qual = kmalloc (sizeof *qual, SLAB_KERNEL);
2362 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
2363 qual, sizeof *qual);
2364 if (status == sizeof *qual) {
2365 dev_info(&udev->dev, "not running at top speed; "
2366 "connect to a high speed hub\n");
2367 /* hub LEDs are probably harder to miss than syslog */
2368 if (hub->has_indicators) {
2369 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
2370 schedule_work (&hub->leds);
2377 hub_power_remaining (struct usb_hub *hub)
2379 struct usb_device *hdev = hub->hdev;
2383 if (!hub->limited_power)
2386 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
2387 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
2388 struct usb_device *udev = hdev->children[port1 - 1];
2394 /* Unconfigured devices may not use more than 100mA,
2395 * or 8mA for OTG ports */
2396 if (udev->actconfig)
2397 delta = udev->actconfig->desc.bMaxPower * 2;
2398 else if (port1 != udev->bus->otg_port || hdev->parent)
2402 if (delta > hub->mA_per_port)
2403 dev_warn(&udev->dev, "%dmA is over %umA budget "
2405 delta, hub->mA_per_port, port1);
2408 if (remaining < 0) {
2409 dev_warn(hub->intfdev, "%dmA over power budget!\n",
2416 /* Handle physical or logical connection change events.
2417 * This routine is called when:
2418 * a port connection-change occurs;
2419 * a port enable-change occurs (often caused by EMI);
2420 * usb_reset_device() encounters changed descriptors (as from
2421 * a firmware download)
2422 * caller already locked the hub
2424 static void hub_port_connect_change(struct usb_hub *hub, int port1,
2425 u16 portstatus, u16 portchange)
2427 struct usb_device *hdev = hub->hdev;
2428 struct device *hub_dev = hub->intfdev;
2429 u16 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2433 "port %d, status %04x, change %04x, %s\n",
2434 port1, portstatus, portchange, portspeed (portstatus));
2436 if (hub->has_indicators) {
2437 set_port_led(hub, port1, HUB_LED_AUTO);
2438 hub->indicator[port1-1] = INDICATOR_AUTO;
2441 /* Disconnect any existing devices under this port */
2442 if (hdev->children[port1-1])
2443 usb_disconnect(&hdev->children[port1-1]);
2444 clear_bit(port1, hub->change_bits);
2446 #ifdef CONFIG_USB_OTG
2447 /* during HNP, don't repeat the debounce */
2448 if (hdev->bus->is_b_host)
2449 portchange &= ~USB_PORT_STAT_C_CONNECTION;
2452 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2453 status = hub_port_debounce(hub, port1);
2456 "connect-debounce failed, port %d disabled\n",
2460 portstatus = status;
2463 /* Return now if nothing is connected */
2464 if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
2466 /* maybe switch power back on (e.g. root hub was reset) */
2467 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
2468 && !(portstatus & (1 << USB_PORT_FEAT_POWER)))
2469 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
2471 if (portstatus & USB_PORT_STAT_ENABLE)
2476 #ifdef CONFIG_USB_SUSPEND
2477 /* If something is connected, but the port is suspended, wake it up. */
2478 if (portstatus & USB_PORT_STAT_SUSPEND) {
2479 status = hub_port_resume(hub, port1, NULL);
2482 "can't clear suspend on port %d; %d\n",
2489 for (i = 0; i < SET_CONFIG_TRIES; i++) {
2490 struct usb_device *udev;
2492 /* reallocate for each attempt, since references
2493 * to the previous one can escape in various ways
2495 udev = usb_alloc_dev(hdev, hdev->bus, port1);
2498 "couldn't allocate port %d usb_device\n",
2503 usb_set_device_state(udev, USB_STATE_POWERED);
2504 udev->speed = USB_SPEED_UNKNOWN;
2505 udev->bus_mA = hub->mA_per_port;
2506 udev->level = hdev->level + 1;
2508 /* set the address */
2509 choose_address(udev);
2510 if (udev->devnum <= 0) {
2511 status = -ENOTCONN; /* Don't retry */
2515 /* reset and get descriptor */
2516 status = hub_port_init(hub, udev, port1, i);
2520 /* consecutive bus-powered hubs aren't reliable; they can
2521 * violate the voltage drop budget. if the new child has
2522 * a "powered" LED, users should notice we didn't enable it
2523 * (without reading syslog), even without per-port LEDs
2526 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
2527 && udev->bus_mA <= 100) {
2530 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
2533 dev_dbg(&udev->dev, "get status %d ?\n", status);
2536 le16_to_cpus(&devstat);
2537 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
2539 "can't connect bus-powered hub "
2541 if (hub->has_indicators) {
2542 hub->indicator[port1-1] =
2543 INDICATOR_AMBER_BLINK;
2544 schedule_work (&hub->leds);
2546 status = -ENOTCONN; /* Don't retry */
2551 /* check for devices running slower than they could */
2552 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
2553 && udev->speed == USB_SPEED_FULL
2554 && highspeed_hubs != 0)
2555 check_highspeed (hub, udev, port1);
2557 /* Store the parent's children[] pointer. At this point
2558 * udev becomes globally accessible, although presumably
2559 * no one will look at it until hdev is unlocked.
2563 /* We mustn't add new devices if the parent hub has
2564 * been disconnected; we would race with the
2565 * recursively_mark_NOTATTACHED() routine.
2567 spin_lock_irq(&device_state_lock);
2568 if (hdev->state == USB_STATE_NOTATTACHED)
2571 hdev->children[port1-1] = udev;
2572 spin_unlock_irq(&device_state_lock);
2574 /* Run it through the hoops (find a driver, etc) */
2576 status = usb_new_device(udev);
2578 spin_lock_irq(&device_state_lock);
2579 hdev->children[port1-1] = NULL;
2580 spin_unlock_irq(&device_state_lock);
2587 status = hub_power_remaining(hub);
2589 dev_dbg(hub_dev, "%dmA power budget left\n", status);
2594 hub_port_disable(hub, port1, 1);
2597 release_address(udev);
2599 if (status == -ENOTCONN)
2604 hub_port_disable(hub, port1, 1);
2607 static void hub_events(void)
2609 struct list_head *tmp;
2610 struct usb_device *hdev;
2611 struct usb_interface *intf;
2612 struct usb_hub *hub;
2613 struct device *hub_dev;
2622 * We restart the list every time to avoid a deadlock with
2623 * deleting hubs downstream from this one. This should be
2624 * safe since we delete the hub from the event list.
2625 * Not the most efficient, but avoids deadlocks.
2629 /* Grab the first entry at the beginning of the list */
2630 spin_lock_irq(&hub_event_lock);
2631 if (list_empty(&hub_event_list)) {
2632 spin_unlock_irq(&hub_event_lock);
2636 tmp = hub_event_list.next;
2639 hub = list_entry(tmp, struct usb_hub, event_list);
2641 intf = to_usb_interface(hub->intfdev);
2642 hub_dev = &intf->dev;
2644 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\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]);
2653 spin_unlock_irq(&hub_event_lock);
2655 /* Lock the device, then check to see if we were
2656 * disconnected while waiting for the lock to succeed. */
2657 if (locktree(hdev) < 0) {
2661 if (hub != usb_get_intfdata(intf))
2664 /* If the hub has died, clean up after it */
2665 if (hdev->state == USB_STATE_NOTATTACHED) {
2666 hub->error = -ENODEV;
2667 hub_pre_reset(intf);
2672 ret = usb_autopm_get_interface(intf);
2674 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
2678 /* If this is an inactive hub, do nothing */
2683 dev_dbg (hub_dev, "resetting for error %d\n",
2686 ret = usb_reset_composite_device(hdev, intf);
2689 "error resetting hub: %d\n", ret);
2697 /* deal with port status changes */
2698 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
2699 if (test_bit(i, hub->busy_bits))
2701 connect_change = test_bit(i, hub->change_bits);
2702 if (!test_and_clear_bit(i, hub->event_bits) &&
2703 !connect_change && !hub->activating)
2706 ret = hub_port_status(hub, i,
2707 &portstatus, &portchange);
2711 if (hub->activating && !hdev->children[i-1] &&
2713 USB_PORT_STAT_CONNECTION))
2716 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2717 clear_port_feature(hdev, i,
2718 USB_PORT_FEAT_C_CONNECTION);
2722 if (portchange & USB_PORT_STAT_C_ENABLE) {
2723 if (!connect_change)
2725 "port %d enable change, "
2728 clear_port_feature(hdev, i,
2729 USB_PORT_FEAT_C_ENABLE);
2732 * EM interference sometimes causes badly
2733 * shielded USB devices to be shutdown by
2734 * the hub, this hack enables them again.
2735 * Works at least with mouse driver.
2737 if (!(portstatus & USB_PORT_STAT_ENABLE)
2739 && hdev->children[i-1]) {
2742 "disabled by hub (EMI?), "
2749 if (portchange & USB_PORT_STAT_C_SUSPEND) {
2750 clear_port_feature(hdev, i,
2751 USB_PORT_FEAT_C_SUSPEND);
2752 if (hdev->children[i-1]) {
2753 ret = remote_wakeup(hdev->
2759 hub_port_disable(hub, i, 1);
2762 "resume on port %d, status %d\n",
2766 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
2768 "over-current change on port %d\n",
2770 clear_port_feature(hdev, i,
2771 USB_PORT_FEAT_C_OVER_CURRENT);
2775 if (portchange & USB_PORT_STAT_C_RESET) {
2777 "reset change on port %d\n",
2779 clear_port_feature(hdev, i,
2780 USB_PORT_FEAT_C_RESET);
2784 hub_port_connect_change(hub, i,
2785 portstatus, portchange);
2788 /* deal with hub status changes */
2789 if (test_and_clear_bit(0, hub->event_bits) == 0)
2791 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
2792 dev_err (hub_dev, "get_hub_status failed\n");
2794 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
2795 dev_dbg (hub_dev, "power change\n");
2796 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
2797 if (hubstatus & HUB_STATUS_LOCAL_POWER)
2798 /* FIXME: Is this always true? */
2799 hub->limited_power = 0;
2801 hub->limited_power = 1;
2803 if (hubchange & HUB_CHANGE_OVERCURRENT) {
2804 dev_dbg (hub_dev, "overcurrent change\n");
2805 msleep(500); /* Cool down */
2806 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
2811 hub->activating = 0;
2813 /* If this is a root hub, tell the HCD it's okay to
2814 * re-enable port-change interrupts now. */
2815 if (!hdev->parent && !hub->busy_bits[0])
2816 usb_enable_root_hub_irq(hdev->bus);
2819 /* Allow autosuspend if we're not going to run again */
2820 if (list_empty(&hub->event_list))
2821 usb_autopm_enable(intf);
2823 usb_unlock_device(hdev);
2826 } /* end while (1) */
2829 static int hub_thread(void *__unused)
2833 wait_event_interruptible(khubd_wait,
2834 !list_empty(&hub_event_list) ||
2835 kthread_should_stop());
2837 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
2839 pr_debug("%s: khubd exiting\n", usbcore_name);
2843 static struct usb_device_id hub_id_table [] = {
2844 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
2845 .bDeviceClass = USB_CLASS_HUB},
2846 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
2847 .bInterfaceClass = USB_CLASS_HUB},
2848 { } /* Terminating entry */
2851 MODULE_DEVICE_TABLE (usb, hub_id_table);
2853 static struct usb_driver hub_driver = {
2856 .disconnect = hub_disconnect,
2857 .suspend = hub_suspend,
2858 .resume = hub_resume,
2859 .pre_reset = hub_pre_reset,
2860 .post_reset = hub_post_reset,
2862 .id_table = hub_id_table,
2863 .supports_autosuspend = 1,
2866 int usb_hub_init(void)
2868 if (usb_register(&hub_driver) < 0) {
2869 printk(KERN_ERR "%s: can't register hub driver\n",
2874 khubd_task = kthread_run(hub_thread, NULL, "khubd");
2875 if (!IS_ERR(khubd_task))
2878 /* Fall through if kernel_thread failed */
2879 usb_deregister(&hub_driver);
2880 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
2885 void usb_hub_cleanup(void)
2887 kthread_stop(khubd_task);
2890 * Hub resources are freed for us by usb_deregister. It calls
2891 * usb_driver_purge on every device which in turn calls that
2892 * devices disconnect function if it is using this driver.
2893 * The hub_disconnect function takes care of releasing the
2894 * individual hub resources. -greg
2896 usb_deregister(&hub_driver);
2897 } /* usb_hub_cleanup() */
2899 static int config_descriptors_changed(struct usb_device *udev)
2903 struct usb_config_descriptor *buf;
2905 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2906 if (len < le16_to_cpu(udev->config[index].desc.wTotalLength))
2907 len = le16_to_cpu(udev->config[index].desc.wTotalLength);
2909 buf = kmalloc (len, SLAB_KERNEL);
2911 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
2912 /* assume the worst */
2915 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2917 int old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
2919 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
2921 if (length < old_length) {
2922 dev_dbg(&udev->dev, "config index %d, error %d\n",
2926 if (memcmp (buf, udev->rawdescriptors[index], old_length)
2928 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
2929 index, buf->bConfigurationValue);
2934 return index != udev->descriptor.bNumConfigurations;
2938 * usb_reset_device - perform a USB port reset to reinitialize a device
2939 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
2941 * WARNING - don't use this routine to reset a composite device
2942 * (one with multiple interfaces owned by separate drivers)!
2943 * Use usb_reset_composite_device() instead.
2945 * Do a port reset, reassign the device's address, and establish its
2946 * former operating configuration. If the reset fails, or the device's
2947 * descriptors change from their values before the reset, or the original
2948 * configuration and altsettings cannot be restored, a flag will be set
2949 * telling khubd to pretend the device has been disconnected and then
2950 * re-connected. All drivers will be unbound, and the device will be
2951 * re-enumerated and probed all over again.
2953 * Returns 0 if the reset succeeded, -ENODEV if the device has been
2954 * flagged for logical disconnection, or some other negative error code
2955 * if the reset wasn't even attempted.
2957 * The caller must own the device lock. For example, it's safe to use
2958 * this from a driver probe() routine after downloading new firmware.
2959 * For calls that might not occur during probe(), drivers should lock
2960 * the device using usb_lock_device_for_reset().
2962 int usb_reset_device(struct usb_device *udev)
2964 struct usb_device *parent_hdev = udev->parent;
2965 struct usb_hub *parent_hub;
2966 struct usb_device_descriptor descriptor = udev->descriptor;
2968 int port1 = udev->portnum;
2970 if (udev->state == USB_STATE_NOTATTACHED ||
2971 udev->state == USB_STATE_SUSPENDED) {
2972 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
2978 /* this requires hcd-specific logic; see OHCI hc_restart() */
2979 dev_dbg(&udev->dev, "%s for root hub!\n", __FUNCTION__);
2982 parent_hub = hdev_to_hub(parent_hdev);
2984 set_bit(port1, parent_hub->busy_bits);
2985 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
2987 /* ep0 maxpacket size may change; let the HCD know about it.
2988 * Other endpoints will be handled by re-enumeration. */
2990 ret = hub_port_init(parent_hub, udev, port1, i);
2994 clear_bit(port1, parent_hub->busy_bits);
2995 if (!parent_hdev->parent && !parent_hub->busy_bits[0])
2996 usb_enable_root_hub_irq(parent_hdev->bus);
3001 /* Device might have changed firmware (DFU or similar) */
3002 if (memcmp(&udev->descriptor, &descriptor, sizeof descriptor)
3003 || config_descriptors_changed (udev)) {
3004 dev_info(&udev->dev, "device firmware changed\n");
3005 udev->descriptor = descriptor; /* for disconnect() calls */
3009 if (!udev->actconfig)
3012 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3013 USB_REQ_SET_CONFIGURATION, 0,
3014 udev->actconfig->desc.bConfigurationValue, 0,
3015 NULL, 0, USB_CTRL_SET_TIMEOUT);
3018 "can't restore configuration #%d (error=%d)\n",
3019 udev->actconfig->desc.bConfigurationValue, ret);
3022 usb_set_device_state(udev, USB_STATE_CONFIGURED);
3024 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
3025 struct usb_interface *intf = udev->actconfig->interface[i];
3026 struct usb_interface_descriptor *desc;
3028 /* set_interface resets host side toggle even
3029 * for altsetting zero. the interface may have no driver.
3031 desc = &intf->cur_altsetting->desc;
3032 ret = usb_set_interface(udev, desc->bInterfaceNumber,
3033 desc->bAlternateSetting);
3035 dev_err(&udev->dev, "failed to restore interface %d "
3036 "altsetting %d (error=%d)\n",
3037 desc->bInterfaceNumber,
3038 desc->bAlternateSetting,
3048 hub_port_logical_disconnect(parent_hub, port1);
3051 EXPORT_SYMBOL(usb_reset_device);
3054 * usb_reset_composite_device - warn interface drivers and perform a USB port reset
3055 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3056 * @iface: interface bound to the driver making the request (optional)
3058 * Warns all drivers bound to registered interfaces (using their pre_reset
3059 * method), performs the port reset, and then lets the drivers know that
3060 * the reset is over (using their post_reset method).
3062 * Return value is the same as for usb_reset_device().
3064 * The caller must own the device lock. For example, it's safe to use
3065 * this from a driver probe() routine after downloading new firmware.
3066 * For calls that might not occur during probe(), drivers should lock
3067 * the device using usb_lock_device_for_reset().
3069 * The interface locks are acquired during the pre_reset stage and released
3070 * during the post_reset stage. However if iface is not NULL and is
3071 * currently being probed, we assume that the caller already owns its
3074 int usb_reset_composite_device(struct usb_device *udev,
3075 struct usb_interface *iface)
3078 struct usb_host_config *config = udev->actconfig;
3080 if (udev->state == USB_STATE_NOTATTACHED ||
3081 udev->state == USB_STATE_SUSPENDED) {
3082 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3087 /* Prevent autosuspend during the reset */
3088 usb_autoresume_device(udev, 1);
3090 if (iface && iface->condition != USB_INTERFACE_BINDING)
3095 struct usb_interface *cintf;
3096 struct usb_driver *drv;
3098 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
3099 cintf = config->interface[i];
3101 down(&cintf->dev.sem);
3102 if (device_is_registered(&cintf->dev) &&
3103 cintf->dev.driver) {
3104 drv = to_usb_driver(cintf->dev.driver);
3106 (drv->pre_reset)(cintf);
3111 ret = usb_reset_device(udev);
3115 struct usb_interface *cintf;
3116 struct usb_driver *drv;
3118 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
3119 cintf = config->interface[i];
3120 if (device_is_registered(&cintf->dev) &&
3121 cintf->dev.driver) {
3122 drv = to_usb_driver(cintf->dev.driver);
3123 if (drv->post_reset)
3124 (drv->post_reset)(cintf);
3127 up(&cintf->dev.sem);
3131 usb_autosuspend_device(udev, 1);
3134 EXPORT_SYMBOL(usb_reset_composite_device);