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/config.h>
12 #include <linux/kernel.h>
13 #include <linux/errno.h>
14 #include <linux/module.h>
15 #include <linux/moduleparam.h>
16 #include <linux/completion.h>
17 #include <linux/sched.h>
18 #include <linux/list.h>
19 #include <linux/slab.h>
20 #include <linux/smp_lock.h>
21 #include <linux/ioctl.h>
22 #include <linux/usb.h>
23 #include <linux/usbdevice_fs.h>
24 #include <linux/kthread.h>
25 #include <linux/mutex.h>
27 #include <asm/semaphore.h>
28 #include <asm/uaccess.h>
29 #include <asm/byteorder.h>
35 /* Protect struct usb_device->state and ->children members
36 * Note: Both are also protected by ->dev.sem, except that ->state can
37 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
38 static DEFINE_SPINLOCK(device_state_lock);
40 /* khubd's worklist and its lock */
41 static DEFINE_SPINLOCK(hub_event_lock);
42 static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
45 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
47 static struct task_struct *khubd_task;
49 /* cycle leds on hubs that aren't blinking for attention */
50 static int blinkenlights = 0;
51 module_param (blinkenlights, bool, S_IRUGO);
52 MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
55 * As of 2.6.10 we introduce a new USB device initialization scheme which
56 * closely resembles the way Windows works. Hopefully it will be compatible
57 * with a wider range of devices than the old scheme. However some previously
58 * working devices may start giving rise to "device not accepting address"
59 * errors; if that happens the user can try the old scheme by adjusting the
60 * following module parameters.
62 * For maximum flexibility there are two boolean parameters to control the
63 * hub driver's behavior. On the first initialization attempt, if the
64 * "old_scheme_first" parameter is set then the old scheme will be used,
65 * otherwise the new scheme is used. If that fails and "use_both_schemes"
66 * is set, then the driver will make another attempt, using the other scheme.
68 static int old_scheme_first = 0;
69 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
70 MODULE_PARM_DESC(old_scheme_first,
71 "start with the old device initialization scheme");
73 static int use_both_schemes = 1;
74 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
75 MODULE_PARM_DESC(use_both_schemes,
76 "try the other device initialization scheme if the "
81 static inline char *portspeed (int portstatus)
83 if (portstatus & (1 << USB_PORT_FEAT_HIGHSPEED))
85 else if (portstatus & (1 << USB_PORT_FEAT_LOWSPEED))
92 /* Note that hdev or one of its children must be locked! */
93 static inline struct usb_hub *hdev_to_hub(struct usb_device *hdev)
95 return usb_get_intfdata(hdev->actconfig->interface[0]);
98 /* USB 2.0 spec Section 11.24.4.5 */
99 static int get_hub_descriptor(struct usb_device *hdev, void *data, int size)
103 for (i = 0; i < 3; i++) {
104 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
105 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
106 USB_DT_HUB << 8, 0, data, size,
107 USB_CTRL_GET_TIMEOUT);
108 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
115 * USB 2.0 spec Section 11.24.2.1
117 static int clear_hub_feature(struct usb_device *hdev, int feature)
119 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
120 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
124 * USB 2.0 spec Section 11.24.2.2
126 static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
128 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
129 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
134 * USB 2.0 spec Section 11.24.2.13
136 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
138 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
139 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
144 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
145 * for info about using port indicators
147 static void set_port_led(
153 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
154 USB_PORT_FEAT_INDICATOR);
156 dev_dbg (hub->intfdev,
157 "port %d indicator %s status %d\n",
159 ({ char *s; switch (selector) {
160 case HUB_LED_AMBER: s = "amber"; break;
161 case HUB_LED_GREEN: s = "green"; break;
162 case HUB_LED_OFF: s = "off"; break;
163 case HUB_LED_AUTO: s = "auto"; break;
164 default: s = "??"; break;
169 #define LED_CYCLE_PERIOD ((2*HZ)/3)
171 static void led_work (void *__hub)
173 struct usb_hub *hub = __hub;
174 struct usb_device *hdev = hub->hdev;
176 unsigned changed = 0;
179 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
182 for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
183 unsigned selector, mode;
185 /* 30%-50% duty cycle */
187 switch (hub->indicator[i]) {
189 case INDICATOR_CYCLE:
191 selector = HUB_LED_AUTO;
192 mode = INDICATOR_AUTO;
194 /* blinking green = sw attention */
195 case INDICATOR_GREEN_BLINK:
196 selector = HUB_LED_GREEN;
197 mode = INDICATOR_GREEN_BLINK_OFF;
199 case INDICATOR_GREEN_BLINK_OFF:
200 selector = HUB_LED_OFF;
201 mode = INDICATOR_GREEN_BLINK;
203 /* blinking amber = hw attention */
204 case INDICATOR_AMBER_BLINK:
205 selector = HUB_LED_AMBER;
206 mode = INDICATOR_AMBER_BLINK_OFF;
208 case INDICATOR_AMBER_BLINK_OFF:
209 selector = HUB_LED_OFF;
210 mode = INDICATOR_AMBER_BLINK;
212 /* blink green/amber = reserved */
213 case INDICATOR_ALT_BLINK:
214 selector = HUB_LED_GREEN;
215 mode = INDICATOR_ALT_BLINK_OFF;
217 case INDICATOR_ALT_BLINK_OFF:
218 selector = HUB_LED_AMBER;
219 mode = INDICATOR_ALT_BLINK;
224 if (selector != HUB_LED_AUTO)
226 set_port_led(hub, i + 1, selector);
227 hub->indicator[i] = mode;
229 if (!changed && blinkenlights) {
231 cursor %= hub->descriptor->bNbrPorts;
232 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
233 hub->indicator[cursor] = INDICATOR_CYCLE;
237 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
240 /* use a short timeout for hub/port status fetches */
241 #define USB_STS_TIMEOUT 1000
242 #define USB_STS_RETRIES 5
245 * USB 2.0 spec Section 11.24.2.6
247 static int get_hub_status(struct usb_device *hdev,
248 struct usb_hub_status *data)
250 int i, status = -ETIMEDOUT;
252 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
253 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
254 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
255 data, sizeof(*data), USB_STS_TIMEOUT);
261 * USB 2.0 spec Section 11.24.2.7
263 static int get_port_status(struct usb_device *hdev, int port1,
264 struct usb_port_status *data)
266 int i, status = -ETIMEDOUT;
268 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
269 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
270 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
271 data, sizeof(*data), USB_STS_TIMEOUT);
276 static void kick_khubd(struct usb_hub *hub)
280 spin_lock_irqsave(&hub_event_lock, flags);
281 if (list_empty(&hub->event_list)) {
282 list_add_tail(&hub->event_list, &hub_event_list);
283 wake_up(&khubd_wait);
285 spin_unlock_irqrestore(&hub_event_lock, flags);
288 void usb_kick_khubd(struct usb_device *hdev)
290 kick_khubd(hdev_to_hub(hdev));
294 /* completion function, fires on port status changes and various faults */
295 static void hub_irq(struct urb *urb, struct pt_regs *regs)
297 struct usb_hub *hub = (struct usb_hub *)urb->context;
302 switch (urb->status) {
303 case -ENOENT: /* synchronous unlink */
304 case -ECONNRESET: /* async unlink */
305 case -ESHUTDOWN: /* hardware going away */
308 default: /* presumably an error */
309 /* Cause a hub reset after 10 consecutive errors */
310 dev_dbg (hub->intfdev, "transfer --> %d\n", urb->status);
311 if ((++hub->nerrors < 10) || hub->error)
313 hub->error = urb->status;
316 /* let khubd handle things */
317 case 0: /* we got data: port status changed */
319 for (i = 0; i < urb->actual_length; ++i)
320 bits |= ((unsigned long) ((*hub->buffer)[i]))
322 hub->event_bits[0] = bits;
328 /* Something happened, let khubd figure it out */
335 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
336 && status != -ENODEV && status != -EPERM)
337 dev_err (hub->intfdev, "resubmit --> %d\n", status);
340 /* USB 2.0 spec Section 11.24.2.3 */
342 hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
344 return usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
345 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
350 * enumeration blocks khubd for a long time. we use keventd instead, since
351 * long blocking there is the exception, not the rule. accordingly, HCDs
352 * talking to TTs must queue control transfers (not just bulk and iso), so
353 * both can talk to the same hub concurrently.
355 static void hub_tt_kevent (void *arg)
357 struct usb_hub *hub = arg;
360 spin_lock_irqsave (&hub->tt.lock, flags);
361 while (!list_empty (&hub->tt.clear_list)) {
362 struct list_head *temp;
363 struct usb_tt_clear *clear;
364 struct usb_device *hdev = hub->hdev;
367 temp = hub->tt.clear_list.next;
368 clear = list_entry (temp, struct usb_tt_clear, clear_list);
369 list_del (&clear->clear_list);
371 /* drop lock so HCD can concurrently report other TT errors */
372 spin_unlock_irqrestore (&hub->tt.lock, flags);
373 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
374 spin_lock_irqsave (&hub->tt.lock, flags);
378 "clear tt %d (%04x) error %d\n",
379 clear->tt, clear->devinfo, status);
382 spin_unlock_irqrestore (&hub->tt.lock, flags);
386 * usb_hub_tt_clear_buffer - clear control/bulk TT state in high speed hub
387 * @udev: the device whose split transaction failed
388 * @pipe: identifies the endpoint of the failed transaction
390 * High speed HCDs use this to tell the hub driver that some split control or
391 * bulk transaction failed in a way that requires clearing internal state of
392 * a transaction translator. This is normally detected (and reported) from
395 * It may not be possible for that hub to handle additional full (or low)
396 * speed transactions until that state is fully cleared out.
398 void usb_hub_tt_clear_buffer (struct usb_device *udev, int pipe)
400 struct usb_tt *tt = udev->tt;
402 struct usb_tt_clear *clear;
404 /* we've got to cope with an arbitrary number of pending TT clears,
405 * since each TT has "at least two" buffers that can need it (and
406 * there can be many TTs per hub). even if they're uncommon.
408 if ((clear = kmalloc (sizeof *clear, SLAB_ATOMIC)) == NULL) {
409 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
410 /* FIXME recover somehow ... RESET_TT? */
414 /* info that CLEAR_TT_BUFFER needs */
415 clear->tt = tt->multi ? udev->ttport : 1;
416 clear->devinfo = usb_pipeendpoint (pipe);
417 clear->devinfo |= udev->devnum << 4;
418 clear->devinfo |= usb_pipecontrol (pipe)
419 ? (USB_ENDPOINT_XFER_CONTROL << 11)
420 : (USB_ENDPOINT_XFER_BULK << 11);
421 if (usb_pipein (pipe))
422 clear->devinfo |= 1 << 15;
424 /* tell keventd to clear state for this TT */
425 spin_lock_irqsave (&tt->lock, flags);
426 list_add_tail (&clear->clear_list, &tt->clear_list);
427 schedule_work (&tt->kevent);
428 spin_unlock_irqrestore (&tt->lock, flags);
431 static void hub_power_on(struct usb_hub *hub)
434 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
435 u16 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
437 /* if hub supports power switching, enable power on each port */
438 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2) {
439 dev_dbg(hub->intfdev, "enabling power on all ports\n");
440 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
441 set_port_feature(hub->hdev, port1,
442 USB_PORT_FEAT_POWER);
445 /* Wait at least 100 msec for power to become stable */
446 msleep(max(pgood_delay, (unsigned) 100));
449 static inline void __hub_quiesce(struct usb_hub *hub)
451 /* (nonblocking) khubd and related activity won't re-trigger */
454 hub->resume_root_hub = 0;
457 static void hub_quiesce(struct usb_hub *hub)
459 /* (blocking) stop khubd and related activity */
461 usb_kill_urb(hub->urb);
462 if (hub->has_indicators)
463 cancel_delayed_work(&hub->leds);
464 if (hub->has_indicators || hub->tt.hub)
465 flush_scheduled_work();
468 static void hub_activate(struct usb_hub *hub)
474 hub->resume_root_hub = 0;
475 status = usb_submit_urb(hub->urb, GFP_NOIO);
477 dev_err(hub->intfdev, "activate --> %d\n", status);
478 if (hub->has_indicators && blinkenlights)
479 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
481 /* scan all ports ASAP */
485 static int hub_hub_status(struct usb_hub *hub,
486 u16 *status, u16 *change)
490 ret = get_hub_status(hub->hdev, &hub->status->hub);
492 dev_err (hub->intfdev,
493 "%s failed (err = %d)\n", __FUNCTION__, ret);
495 *status = le16_to_cpu(hub->status->hub.wHubStatus);
496 *change = le16_to_cpu(hub->status->hub.wHubChange);
502 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
504 struct usb_device *hdev = hub->hdev;
507 if (hdev->children[port1-1] && set_state) {
508 usb_set_device_state(hdev->children[port1-1],
509 USB_STATE_NOTATTACHED);
511 ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
513 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
520 /* caller has locked the hub device */
521 static void hub_pre_reset(struct usb_hub *hub, int disable_ports)
523 struct usb_device *hdev = hub->hdev;
526 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
527 if (hdev->children[port1 - 1]) {
528 usb_disconnect(&hdev->children[port1 - 1]);
530 hub_port_disable(hub, port1, 0);
536 /* caller has locked the hub device */
537 static void hub_post_reset(struct usb_hub *hub)
544 static int hub_configure(struct usb_hub *hub,
545 struct usb_endpoint_descriptor *endpoint)
547 struct usb_device *hdev = hub->hdev;
548 struct device *hub_dev = hub->intfdev;
549 u16 hubstatus, hubchange;
550 u16 wHubCharacteristics;
555 hub->buffer = usb_buffer_alloc(hdev, sizeof(*hub->buffer), GFP_KERNEL,
558 message = "can't allocate hub irq buffer";
563 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
565 message = "can't kmalloc hub status buffer";
570 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
571 if (!hub->descriptor) {
572 message = "can't kmalloc hub descriptor";
577 /* Request the entire hub descriptor.
578 * hub->descriptor can handle USB_MAXCHILDREN ports,
579 * but the hub can/will return fewer bytes here.
581 ret = get_hub_descriptor(hdev, hub->descriptor,
582 sizeof(*hub->descriptor));
584 message = "can't read hub descriptor";
586 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
587 message = "hub has too many ports!";
592 hdev->maxchild = hub->descriptor->bNbrPorts;
593 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
594 (hdev->maxchild == 1) ? "" : "s");
596 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
598 if (wHubCharacteristics & HUB_CHAR_COMPOUND) {
600 char portstr [USB_MAXCHILDREN + 1];
602 for (i = 0; i < hdev->maxchild; i++)
603 portstr[i] = hub->descriptor->DeviceRemovable
604 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
606 portstr[hdev->maxchild] = 0;
607 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
609 dev_dbg(hub_dev, "standalone hub\n");
611 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
613 dev_dbg(hub_dev, "ganged power switching\n");
616 dev_dbg(hub_dev, "individual port power switching\n");
620 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
624 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
626 dev_dbg(hub_dev, "global over-current protection\n");
629 dev_dbg(hub_dev, "individual port over-current protection\n");
633 dev_dbg(hub_dev, "no over-current protection\n");
637 spin_lock_init (&hub->tt.lock);
638 INIT_LIST_HEAD (&hub->tt.clear_list);
639 INIT_WORK (&hub->tt.kevent, hub_tt_kevent, hub);
640 switch (hdev->descriptor.bDeviceProtocol) {
644 dev_dbg(hub_dev, "Single TT\n");
648 ret = usb_set_interface(hdev, 0, 1);
650 dev_dbg(hub_dev, "TT per port\n");
653 dev_err(hub_dev, "Using single TT (err %d)\n",
658 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
659 hdev->descriptor.bDeviceProtocol);
663 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
664 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
665 case HUB_TTTT_8_BITS:
666 if (hdev->descriptor.bDeviceProtocol != 0) {
667 hub->tt.think_time = 666;
668 dev_dbg(hub_dev, "TT requires at most %d "
669 "FS bit times (%d ns)\n",
670 8, hub->tt.think_time);
673 case HUB_TTTT_16_BITS:
674 hub->tt.think_time = 666 * 2;
675 dev_dbg(hub_dev, "TT requires at most %d "
676 "FS bit times (%d ns)\n",
677 16, hub->tt.think_time);
679 case HUB_TTTT_24_BITS:
680 hub->tt.think_time = 666 * 3;
681 dev_dbg(hub_dev, "TT requires at most %d "
682 "FS bit times (%d ns)\n",
683 24, hub->tt.think_time);
685 case HUB_TTTT_32_BITS:
686 hub->tt.think_time = 666 * 4;
687 dev_dbg(hub_dev, "TT requires at most %d "
688 "FS bit times (%d ns)\n",
689 32, hub->tt.think_time);
693 /* probe() zeroes hub->indicator[] */
694 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
695 hub->has_indicators = 1;
696 dev_dbg(hub_dev, "Port indicators are supported\n");
699 dev_dbg(hub_dev, "power on to power good time: %dms\n",
700 hub->descriptor->bPwrOn2PwrGood * 2);
702 /* power budgeting mostly matters with bus-powered hubs,
703 * and battery-powered root hubs (may provide just 8 mA).
705 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
707 message = "can't get hub status";
710 le16_to_cpus(&hubstatus);
711 if (hdev == hdev->bus->root_hub) {
712 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
713 hub->mA_per_port = 500;
715 hub->mA_per_port = hdev->bus_mA;
716 hub->limited_power = 1;
718 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
719 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
720 hub->descriptor->bHubContrCurrent);
721 hub->limited_power = 1;
722 if (hdev->maxchild > 0) {
723 int remaining = hdev->bus_mA -
724 hub->descriptor->bHubContrCurrent;
726 if (remaining < hdev->maxchild * 100)
728 "insufficient power available "
729 "to use all downstream ports\n");
730 hub->mA_per_port = 100; /* 7.2.1.1 */
732 } else { /* Self-powered external hub */
733 /* FIXME: What about battery-powered external hubs that
734 * provide less current per port? */
735 hub->mA_per_port = 500;
737 if (hub->mA_per_port < 500)
738 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
741 ret = hub_hub_status(hub, &hubstatus, &hubchange);
743 message = "can't get hub status";
747 /* local power status reports aren't always correct */
748 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
749 dev_dbg(hub_dev, "local power source is %s\n",
750 (hubstatus & HUB_STATUS_LOCAL_POWER)
751 ? "lost (inactive)" : "good");
753 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
754 dev_dbg(hub_dev, "%sover-current condition exists\n",
755 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
757 /* set up the interrupt endpoint */
758 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
759 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
761 if (maxp > sizeof(*hub->buffer))
762 maxp = sizeof(*hub->buffer);
764 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
766 message = "couldn't allocate interrupt urb";
771 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
772 hub, endpoint->bInterval);
773 hub->urb->transfer_dma = hub->buffer_dma;
774 hub->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
776 /* maybe cycle the hub leds */
777 if (hub->has_indicators && blinkenlights)
778 hub->indicator [0] = INDICATOR_CYCLE;
785 dev_err (hub_dev, "config failed, %s (err %d)\n",
787 /* hub_disconnect() frees urb and descriptor */
791 static unsigned highspeed_hubs;
793 static void hub_disconnect(struct usb_interface *intf)
795 struct usb_hub *hub = usb_get_intfdata (intf);
796 struct usb_device *hdev;
798 usb_set_intfdata (intf, NULL);
801 if (hdev->speed == USB_SPEED_HIGH)
804 /* Disconnect all children and quiesce the hub */
805 hub_pre_reset(hub, 1);
807 usb_free_urb(hub->urb);
810 spin_lock_irq(&hub_event_lock);
811 list_del_init(&hub->event_list);
812 spin_unlock_irq(&hub_event_lock);
814 kfree(hub->descriptor);
815 hub->descriptor = NULL;
821 usb_buffer_free(hdev, sizeof(*hub->buffer), hub->buffer,
829 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
831 struct usb_host_interface *desc;
832 struct usb_endpoint_descriptor *endpoint;
833 struct usb_device *hdev;
836 desc = intf->cur_altsetting;
837 hdev = interface_to_usbdev(intf);
839 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
841 dev_warn(&intf->dev, "ignoring external hub\n");
846 /* Some hubs have a subclass of 1, which AFAICT according to the */
847 /* specs is not defined, but it works */
848 if ((desc->desc.bInterfaceSubClass != 0) &&
849 (desc->desc.bInterfaceSubClass != 1)) {
851 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
855 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
856 if (desc->desc.bNumEndpoints != 1)
857 goto descriptor_error;
859 endpoint = &desc->endpoint[0].desc;
861 /* Output endpoint? Curiouser and curiouser.. */
862 if (!(endpoint->bEndpointAddress & USB_DIR_IN))
863 goto descriptor_error;
865 /* If it's not an interrupt endpoint, we'd better punt! */
866 if ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
867 != USB_ENDPOINT_XFER_INT)
868 goto descriptor_error;
871 dev_info (&intf->dev, "USB hub found\n");
873 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
875 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
879 INIT_LIST_HEAD(&hub->event_list);
880 hub->intfdev = &intf->dev;
882 INIT_WORK(&hub->leds, led_work, hub);
884 usb_set_intfdata (intf, hub);
886 if (hdev->speed == USB_SPEED_HIGH)
889 if (hub_configure(hub, endpoint) >= 0)
892 hub_disconnect (intf);
897 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
899 struct usb_device *hdev = interface_to_usbdev (intf);
901 /* assert ifno == 0 (part of hub spec) */
903 case USBDEVFS_HUB_PORTINFO: {
904 struct usbdevfs_hub_portinfo *info = user_data;
907 spin_lock_irq(&device_state_lock);
908 if (hdev->devnum <= 0)
911 info->nports = hdev->maxchild;
912 for (i = 0; i < info->nports; i++) {
913 if (hdev->children[i] == NULL)
917 hdev->children[i]->devnum;
920 spin_unlock_irq(&device_state_lock);
922 return info->nports + 1;
931 /* grab device/port lock, returning index of that port (zero based).
932 * protects the upstream link used by this device from concurrent
933 * tree operations like suspend, resume, reset, and disconnect, which
934 * apply to everything downstream of a given port.
936 static int locktree(struct usb_device *udev)
939 struct usb_device *hdev;
944 /* root hub is always the first lock in the series */
947 usb_lock_device(udev);
951 /* on the path from root to us, lock everything from
952 * top down, dropping parent locks when not needed
958 /* everything is fail-fast once disconnect
961 if (udev->state == USB_STATE_NOTATTACHED) {
962 usb_unlock_device(hdev);
966 /* when everyone grabs locks top->bottom,
967 * non-overlapping work may be concurrent
969 usb_lock_device(udev);
970 usb_unlock_device(hdev);
971 return udev->portnum;
974 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
978 for (i = 0; i < udev->maxchild; ++i) {
979 if (udev->children[i])
980 recursively_mark_NOTATTACHED(udev->children[i]);
982 udev->state = USB_STATE_NOTATTACHED;
986 * usb_set_device_state - change a device's current state (usbcore, hcds)
987 * @udev: pointer to device whose state should be changed
988 * @new_state: new state value to be stored
990 * udev->state is _not_ fully protected by the device lock. Although
991 * most transitions are made only while holding the lock, the state can
992 * can change to USB_STATE_NOTATTACHED at almost any time. This
993 * is so that devices can be marked as disconnected as soon as possible,
994 * without having to wait for any semaphores to be released. As a result,
995 * all changes to any device's state must be protected by the
996 * device_state_lock spinlock.
998 * Once a device has been added to the device tree, all changes to its state
999 * should be made using this routine. The state should _not_ be set directly.
1001 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1002 * Otherwise udev->state is set to new_state, and if new_state is
1003 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1004 * to USB_STATE_NOTATTACHED.
1006 void usb_set_device_state(struct usb_device *udev,
1007 enum usb_device_state new_state)
1009 unsigned long flags;
1011 spin_lock_irqsave(&device_state_lock, flags);
1012 if (udev->state == USB_STATE_NOTATTACHED)
1014 else if (new_state != USB_STATE_NOTATTACHED) {
1015 udev->state = new_state;
1017 /* root hub wakeup capabilities are managed out-of-band
1018 * and may involve silicon errata ... ignore them here.
1021 if (new_state == USB_STATE_CONFIGURED)
1022 device_init_wakeup(&udev->dev,
1023 (udev->actconfig->desc.bmAttributes
1024 & USB_CONFIG_ATT_WAKEUP));
1025 else if (new_state != USB_STATE_SUSPENDED)
1026 device_init_wakeup(&udev->dev, 0);
1029 recursively_mark_NOTATTACHED(udev);
1030 spin_unlock_irqrestore(&device_state_lock, flags);
1037 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
1038 * @rhdev: struct usb_device for the root hub
1040 * The USB host controller driver calls this function when its root hub
1041 * is resumed and Vbus power has been interrupted or the controller
1042 * has been reset. The routine marks all the children of the root hub
1043 * as NOTATTACHED and marks logical connect-change events on their ports.
1045 void usb_root_hub_lost_power(struct usb_device *rhdev)
1047 struct usb_hub *hub;
1049 unsigned long flags;
1051 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
1052 spin_lock_irqsave(&device_state_lock, flags);
1053 hub = hdev_to_hub(rhdev);
1054 for (port1 = 1; port1 <= rhdev->maxchild; ++port1) {
1055 if (rhdev->children[port1 - 1]) {
1056 recursively_mark_NOTATTACHED(
1057 rhdev->children[port1 - 1]);
1058 set_bit(port1, hub->change_bits);
1061 spin_unlock_irqrestore(&device_state_lock, flags);
1063 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
1067 static void choose_address(struct usb_device *udev)
1070 struct usb_bus *bus = udev->bus;
1072 /* If khubd ever becomes multithreaded, this will need a lock */
1074 /* Try to allocate the next devnum beginning at bus->devnum_next. */
1075 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1078 devnum = find_next_zero_bit(bus->devmap.devicemap, 128, 1);
1080 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1083 set_bit(devnum, bus->devmap.devicemap);
1084 udev->devnum = devnum;
1088 static void release_address(struct usb_device *udev)
1090 if (udev->devnum > 0) {
1091 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1097 * usb_disconnect - disconnect a device (usbcore-internal)
1098 * @pdev: pointer to device being disconnected
1099 * Context: !in_interrupt ()
1101 * Something got disconnected. Get rid of it and all of its children.
1103 * If *pdev is a normal device then the parent hub must already be locked.
1104 * If *pdev is a root hub then this routine will acquire the
1105 * usb_bus_list_lock on behalf of the caller.
1107 * Only hub drivers (including virtual root hub drivers for host
1108 * controllers) should ever call this.
1110 * This call is synchronous, and may not be used in an interrupt context.
1112 void usb_disconnect(struct usb_device **pdev)
1114 struct usb_device *udev = *pdev;
1118 pr_debug ("%s nodev\n", __FUNCTION__);
1122 /* mark the device as inactive, so any further urb submissions for
1123 * this device (and any of its children) will fail immediately.
1124 * this quiesces everyting except pending urbs.
1126 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1127 dev_info (&udev->dev, "USB disconnect, address %d\n", udev->devnum);
1129 usb_lock_device(udev);
1131 /* Free up all the children before we remove this device */
1132 for (i = 0; i < USB_MAXCHILDREN; i++) {
1133 if (udev->children[i])
1134 usb_disconnect(&udev->children[i]);
1137 /* deallocate hcd/hardware state ... nuking all pending urbs and
1138 * cleaning up all state associated with the current configuration
1139 * so that the hardware is now fully quiesced.
1141 usb_disable_device(udev, 0);
1143 usb_notify_remove_device(udev);
1145 /* Free the device number, remove the /proc/bus/usb entry and
1146 * the sysfs attributes, and delete the parent's children[]
1147 * (or root_hub) pointer.
1149 dev_dbg (&udev->dev, "unregistering device\n");
1150 release_address(udev);
1151 usb_remove_sysfs_dev_files(udev);
1153 /* Avoid races with recursively_mark_NOTATTACHED() */
1154 spin_lock_irq(&device_state_lock);
1156 spin_unlock_irq(&device_state_lock);
1158 usb_unlock_device(udev);
1160 device_unregister(&udev->dev);
1163 static inline const char *plural(int n)
1165 return (n == 1 ? "" : "s");
1168 static int choose_configuration(struct usb_device *udev)
1172 struct usb_host_config *c, *best;
1176 num_configs = udev->descriptor.bNumConfigurations;
1177 for (i = 0; i < num_configs; (i++, c++)) {
1178 struct usb_interface_descriptor *desc = NULL;
1180 /* It's possible that a config has no interfaces! */
1181 if (c->desc.bNumInterfaces > 0)
1182 desc = &c->intf_cache[0]->altsetting->desc;
1185 * HP's USB bus-powered keyboard has only one configuration
1186 * and it claims to be self-powered; other devices may have
1187 * similar errors in their descriptors. If the next test
1188 * were allowed to execute, such configurations would always
1189 * be rejected and the devices would not work as expected.
1190 * In the meantime, we run the risk of selecting a config
1191 * that requires external power at a time when that power
1192 * isn't available. It seems to be the lesser of two evils.
1194 * Bugzilla #6448 reports a device that appears to crash
1195 * when it receives a GET_DEVICE_STATUS request! We don't
1196 * have any other way to tell whether a device is self-powered,
1197 * but since we don't use that information anywhere but here,
1198 * the call has been removed.
1200 * Maybe the GET_DEVICE_STATUS call and the test below can
1201 * be reinstated when device firmwares become more reliable.
1202 * Don't hold your breath.
1205 /* Rule out self-powered configs for a bus-powered device */
1206 if (bus_powered && (c->desc.bmAttributes &
1207 USB_CONFIG_ATT_SELFPOWER))
1212 * The next test may not be as effective as it should be.
1213 * Some hubs have errors in their descriptor, claiming
1214 * to be self-powered when they are really bus-powered.
1215 * We will overestimate the amount of current such hubs
1216 * make available for each port.
1218 * This is a fairly benign sort of failure. It won't
1219 * cause us to reject configurations that we should have
1223 /* Rule out configs that draw too much bus current */
1224 if (c->desc.bMaxPower * 2 > udev->bus_mA)
1227 /* If the first config's first interface is COMM/2/0xff
1228 * (MSFT RNDIS), rule it out unless Linux has host-side
1231 && desc->bInterfaceClass == USB_CLASS_COMM
1232 && desc->bInterfaceSubClass == 2
1233 && desc->bInterfaceProtocol == 0xff) {
1234 #ifndef CONFIG_USB_NET_RNDIS
1241 /* From the remaining configs, choose the first one whose
1242 * first interface is for a non-vendor-specific class.
1243 * Reason: Linux is more likely to have a class driver
1244 * than a vendor-specific driver. */
1245 else if (udev->descriptor.bDeviceClass !=
1246 USB_CLASS_VENDOR_SPEC &&
1247 (!desc || desc->bInterfaceClass !=
1248 USB_CLASS_VENDOR_SPEC)) {
1253 /* If all the remaining configs are vendor-specific,
1254 * choose the first one. */
1260 i = best->desc.bConfigurationValue;
1261 dev_info(&udev->dev,
1262 "configuration #%d chosen from %d choice%s\n",
1263 i, num_configs, plural(num_configs));
1266 dev_warn(&udev->dev,
1267 "no configuration chosen from %d choice%s\n",
1268 num_configs, plural(num_configs));
1274 static void show_string(struct usb_device *udev, char *id, char *string)
1278 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1282 static inline void show_string(struct usb_device *udev, char *id, char *string)
1287 #ifdef CONFIG_USB_OTG
1288 #include "otg_whitelist.h"
1292 * usb_new_device - perform initial device setup (usbcore-internal)
1293 * @udev: newly addressed device (in ADDRESS state)
1295 * This is called with devices which have been enumerated, but not yet
1296 * configured. The device descriptor is available, but not descriptors
1297 * for any device configuration. The caller must have locked either
1298 * the parent hub (if udev is a normal device) or else the
1299 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1300 * udev has already been installed, but udev is not yet visible through
1301 * sysfs or other filesystem code.
1303 * Returns 0 for success (device is configured and listed, with its
1304 * interfaces, in sysfs); else a negative errno value.
1306 * This call is synchronous, and may not be used in an interrupt context.
1308 * Only the hub driver or root-hub registrar should ever call this.
1310 int usb_new_device(struct usb_device *udev)
1315 err = usb_get_configuration(udev);
1317 dev_err(&udev->dev, "can't read configurations, error %d\n",
1322 /* read the standard strings and cache them if present */
1323 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1324 udev->manufacturer = usb_cache_string(udev,
1325 udev->descriptor.iManufacturer);
1326 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
1328 /* Tell the world! */
1329 dev_dbg(&udev->dev, "new device strings: Mfr=%d, Product=%d, "
1330 "SerialNumber=%d\n",
1331 udev->descriptor.iManufacturer,
1332 udev->descriptor.iProduct,
1333 udev->descriptor.iSerialNumber);
1334 show_string(udev, "Product", udev->product);
1335 show_string(udev, "Manufacturer", udev->manufacturer);
1336 show_string(udev, "SerialNumber", udev->serial);
1338 #ifdef CONFIG_USB_OTG
1340 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1341 * to wake us after we've powered off VBUS; and HNP, switching roles
1342 * "host" to "peripheral". The OTG descriptor helps figure this out.
1344 if (!udev->bus->is_b_host
1346 && udev->parent == udev->bus->root_hub) {
1347 struct usb_otg_descriptor *desc = 0;
1348 struct usb_bus *bus = udev->bus;
1350 /* descriptor may appear anywhere in config */
1351 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1352 le16_to_cpu(udev->config[0].desc.wTotalLength),
1353 USB_DT_OTG, (void **) &desc) == 0) {
1354 if (desc->bmAttributes & USB_OTG_HNP) {
1355 unsigned port1 = udev->portnum;
1356 struct usb_device *root = udev->parent;
1358 dev_info(&udev->dev,
1359 "Dual-Role OTG device on %sHNP port\n",
1360 (port1 == bus->otg_port)
1363 /* enable HNP before suspend, it's simpler */
1364 if (port1 == bus->otg_port)
1365 bus->b_hnp_enable = 1;
1366 err = usb_control_msg(udev,
1367 usb_sndctrlpipe(udev, 0),
1368 USB_REQ_SET_FEATURE, 0,
1370 ? USB_DEVICE_B_HNP_ENABLE
1371 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1372 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1374 /* OTG MESSAGE: report errors here,
1375 * customize to match your product.
1377 dev_info(&udev->dev,
1378 "can't set HNP mode; %d\n",
1380 bus->b_hnp_enable = 0;
1386 if (!is_targeted(udev)) {
1388 /* Maybe it can talk to us, though we can't talk to it.
1389 * (Includes HNP test device.)
1391 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
1392 static int __usb_suspend_device(struct usb_device *,
1394 err = __usb_suspend_device(udev, udev->bus->otg_port);
1396 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1403 /* put device-specific files into sysfs */
1404 err = device_add (&udev->dev);
1406 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1409 usb_create_sysfs_dev_files (udev);
1411 usb_lock_device(udev);
1413 /* choose and set the configuration. that registers the interfaces
1414 * with the driver core, and lets usb device drivers bind to them.
1416 c = choose_configuration(udev);
1418 err = usb_set_configuration(udev, c);
1420 dev_err(&udev->dev, "can't set config #%d, error %d\n",
1422 /* This need not be fatal. The user can try to
1423 * set other configurations. */
1427 /* USB device state == configured ... usable */
1428 usb_notify_add_device(udev);
1430 usb_unlock_device(udev);
1435 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1440 static int hub_port_status(struct usb_hub *hub, int port1,
1441 u16 *status, u16 *change)
1445 ret = get_port_status(hub->hdev, port1, &hub->status->port);
1447 dev_err (hub->intfdev,
1448 "%s failed (err = %d)\n", __FUNCTION__, ret);
1450 *status = le16_to_cpu(hub->status->port.wPortStatus);
1451 *change = le16_to_cpu(hub->status->port.wPortChange);
1457 #define PORT_RESET_TRIES 5
1458 #define SET_ADDRESS_TRIES 2
1459 #define GET_DESCRIPTOR_TRIES 2
1460 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1461 #define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1463 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1464 #define HUB_SHORT_RESET_TIME 10
1465 #define HUB_LONG_RESET_TIME 200
1466 #define HUB_RESET_TIMEOUT 500
1468 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
1469 struct usb_device *udev, unsigned int delay)
1471 int delay_time, ret;
1475 for (delay_time = 0;
1476 delay_time < HUB_RESET_TIMEOUT;
1477 delay_time += delay) {
1478 /* wait to give the device a chance to reset */
1481 /* read and decode port status */
1482 ret = hub_port_status(hub, port1, &portstatus, &portchange);
1486 /* Device went away? */
1487 if (!(portstatus & USB_PORT_STAT_CONNECTION))
1490 /* bomb out completely if something weird happened */
1491 if ((portchange & USB_PORT_STAT_C_CONNECTION))
1494 /* if we`ve finished resetting, then break out of the loop */
1495 if (!(portstatus & USB_PORT_STAT_RESET) &&
1496 (portstatus & USB_PORT_STAT_ENABLE)) {
1497 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
1498 udev->speed = USB_SPEED_HIGH;
1499 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
1500 udev->speed = USB_SPEED_LOW;
1502 udev->speed = USB_SPEED_FULL;
1506 /* switch to the long delay after two short delay failures */
1507 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
1508 delay = HUB_LONG_RESET_TIME;
1510 dev_dbg (hub->intfdev,
1511 "port %d not reset yet, waiting %dms\n",
1518 static int hub_port_reset(struct usb_hub *hub, int port1,
1519 struct usb_device *udev, unsigned int delay)
1523 /* Reset the port */
1524 for (i = 0; i < PORT_RESET_TRIES; i++) {
1525 status = set_port_feature(hub->hdev,
1526 port1, USB_PORT_FEAT_RESET);
1528 dev_err(hub->intfdev,
1529 "cannot reset port %d (err = %d)\n",
1532 status = hub_port_wait_reset(hub, port1, udev, delay);
1533 if (status && status != -ENOTCONN)
1534 dev_dbg(hub->intfdev,
1535 "port_wait_reset: err = %d\n",
1539 /* return on disconnect or reset */
1542 /* TRSTRCY = 10 ms; plus some extra */
1547 clear_port_feature(hub->hdev,
1548 port1, USB_PORT_FEAT_C_RESET);
1549 /* FIXME need disconnect() for NOTATTACHED device */
1550 usb_set_device_state(udev, status
1551 ? USB_STATE_NOTATTACHED
1552 : USB_STATE_DEFAULT);
1556 dev_dbg (hub->intfdev,
1557 "port %d not enabled, trying reset again...\n",
1559 delay = HUB_LONG_RESET_TIME;
1562 dev_err (hub->intfdev,
1563 "Cannot enable port %i. Maybe the USB cable is bad?\n",
1570 * Disable a port and mark a logical connnect-change event, so that some
1571 * time later khubd will disconnect() any existing usb_device on the port
1572 * and will re-enumerate if there actually is a device attached.
1574 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
1576 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
1577 hub_port_disable(hub, port1, 1);
1579 /* FIXME let caller ask to power down the port:
1580 * - some devices won't enumerate without a VBUS power cycle
1581 * - SRP saves power that way
1582 * - ... new call, TBD ...
1583 * That's easy if this hub can switch power per-port, and
1584 * khubd reactivates the port later (timer, SRP, etc).
1585 * Powerdown must be optional, because of reset/DFU.
1588 set_bit(port1, hub->change_bits);
1593 #ifdef CONFIG_USB_SUSPEND
1596 * Selective port suspend reduces power; most suspended devices draw
1597 * less than 500 uA. It's also used in OTG, along with remote wakeup.
1598 * All devices below the suspended port are also suspended.
1600 * Devices leave suspend state when the host wakes them up. Some devices
1601 * also support "remote wakeup", where the device can activate the USB
1602 * tree above them to deliver data, such as a keypress or packet. In
1603 * some cases, this wakes the USB host.
1605 static int hub_port_suspend(struct usb_hub *hub, int port1,
1606 struct usb_device *udev)
1610 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
1612 /* enable remote wakeup when appropriate; this lets the device
1613 * wake up the upstream hub (including maybe the root hub).
1615 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
1616 * we don't explicitly enable it here.
1618 if (device_may_wakeup(&udev->dev)) {
1619 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1620 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
1621 USB_DEVICE_REMOTE_WAKEUP, 0,
1623 USB_CTRL_SET_TIMEOUT);
1626 "won't remote wakeup, status %d\n",
1631 status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
1633 dev_dbg(hub->intfdev,
1634 "can't suspend port %d, status %d\n",
1636 /* paranoia: "should not happen" */
1637 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1638 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
1639 USB_DEVICE_REMOTE_WAKEUP, 0,
1641 USB_CTRL_SET_TIMEOUT);
1643 /* device has up to 10 msec to fully suspend */
1644 dev_dbg(&udev->dev, "usb suspend\n");
1645 usb_set_device_state(udev, USB_STATE_SUSPENDED);
1652 * Devices on USB hub ports have only one "suspend" state, corresponding
1653 * to ACPI D2, "may cause the device to lose some context".
1654 * State transitions include:
1656 * - suspend, resume ... when the VBUS power link stays live
1657 * - suspend, disconnect ... VBUS lost
1659 * Once VBUS drop breaks the circuit, the port it's using has to go through
1660 * normal re-enumeration procedures, starting with enabling VBUS power.
1661 * Other than re-initializing the hub (plug/unplug, except for root hubs),
1662 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
1663 * timer, no SRP, no requests through sysfs.
1665 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
1666 * the root hub for their bus goes into global suspend ... so we don't
1667 * (falsely) update the device power state to say it suspended.
1669 static int __usb_suspend_device (struct usb_device *udev, int port1)
1673 /* caller owns the udev device lock */
1677 if (udev->state == USB_STATE_SUSPENDED
1678 || udev->state == USB_STATE_NOTATTACHED) {
1682 /* all interfaces must already be suspended */
1683 if (udev->actconfig) {
1686 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
1687 struct usb_interface *intf;
1689 intf = udev->actconfig->interface[i];
1690 if (is_active(intf)) {
1691 dev_dbg(&intf->dev, "nyet suspended\n");
1697 /* we only change a device's upstream USB link.
1698 * root hubs have no upstream USB link.
1701 status = hub_port_suspend(hdev_to_hub(udev->parent), port1,
1705 udev->dev.power.power_state = PMSG_SUSPEND;
1712 * usb_suspend_device - suspend a usb device
1713 * @udev: device that's no longer in active use
1714 * Context: must be able to sleep; device not locked; pm locks held
1716 * Suspends a USB device that isn't in active use, conserving power.
1717 * Devices may wake out of a suspend, if anything important happens,
1718 * using the remote wakeup mechanism. They may also be taken out of
1719 * suspend by the host, using usb_resume_device(). It's also routine
1720 * to disconnect devices while they are suspended.
1722 * This only affects the USB hardware for a device; its interfaces
1723 * (and, for hubs, child devices) must already have been suspended.
1725 * Suspending OTG devices may trigger HNP, if that's been enabled
1726 * between a pair of dual-role devices. That will change roles, such
1727 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
1729 * Returns 0 on success, else negative errno.
1731 int usb_suspend_device(struct usb_device *udev)
1733 #ifdef CONFIG_USB_SUSPEND
1734 if (udev->state == USB_STATE_NOTATTACHED)
1736 return __usb_suspend_device(udev, udev->portnum);
1738 /* NOTE: udev->state unchanged, it's not lying ... */
1739 udev->dev.power.power_state = PMSG_SUSPEND;
1745 * If the USB "suspend" state is in use (rather than "global suspend"),
1746 * many devices will be individually taken out of suspend state using
1747 * special" resume" signaling. These routines kick in shortly after
1748 * hardware resume signaling is finished, either because of selective
1749 * resume (by host) or remote wakeup (by device) ... now see what changed
1750 * in the tree that's rooted at this device.
1752 static int finish_device_resume(struct usb_device *udev)
1757 /* caller owns the udev device lock */
1758 dev_dbg(&udev->dev, "finish resume\n");
1760 /* usb ch9 identifies four variants of SUSPENDED, based on what
1761 * state the device resumes to. Linux currently won't see the
1762 * first two on the host side; they'd be inside hub_port_init()
1763 * during many timeouts, but khubd can't suspend until later.
1765 usb_set_device_state(udev, udev->actconfig
1766 ? USB_STATE_CONFIGURED
1767 : USB_STATE_ADDRESS);
1768 udev->dev.power.power_state = PMSG_ON;
1770 /* 10.5.4.5 says be sure devices in the tree are still there.
1771 * For now let's assume the device didn't go crazy on resume,
1772 * and device drivers will know about any resume quirks.
1774 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
1777 "gone after usb resume? status %d\n",
1779 else if (udev->actconfig) {
1781 int (*resume)(struct device *);
1783 le16_to_cpus(&devstatus);
1784 if ((devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
1786 status = usb_control_msg(udev,
1787 usb_sndctrlpipe(udev, 0),
1788 USB_REQ_CLEAR_FEATURE,
1790 USB_DEVICE_REMOTE_WAKEUP, 0,
1792 USB_CTRL_SET_TIMEOUT);
1794 dev_dbg(&udev->dev, "disable remote "
1795 "wakeup, status %d\n", status);
1800 /* resume interface drivers; if this is a hub, it
1801 * may have a child resume event to deal with soon
1803 resume = udev->dev.bus->resume;
1804 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
1805 struct device *dev =
1806 &udev->actconfig->interface[i]->dev;
1814 } else if (udev->devnum <= 0) {
1815 dev_dbg(&udev->dev, "bogus resume!\n");
1821 #ifdef CONFIG_USB_SUSPEND
1824 hub_port_resume(struct usb_hub *hub, int port1, struct usb_device *udev)
1828 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
1830 /* see 7.1.7.7; affects power usage, but not budgeting */
1831 status = clear_port_feature(hub->hdev,
1832 port1, USB_PORT_FEAT_SUSPEND);
1834 dev_dbg(hub->intfdev,
1835 "can't resume port %d, status %d\n",
1841 /* drive resume for at least 20 msec */
1843 dev_dbg(&udev->dev, "RESUME\n");
1846 #define LIVE_FLAGS ( USB_PORT_STAT_POWER \
1847 | USB_PORT_STAT_ENABLE \
1848 | USB_PORT_STAT_CONNECTION)
1850 /* Virtual root hubs can trigger on GET_PORT_STATUS to
1851 * stop resume signaling. Then finish the resume
1854 devstatus = portchange = 0;
1855 status = hub_port_status(hub, port1,
1856 &devstatus, &portchange);
1858 || (devstatus & LIVE_FLAGS) != LIVE_FLAGS
1859 || (devstatus & USB_PORT_STAT_SUSPEND) != 0
1861 dev_dbg(hub->intfdev,
1862 "port %d status %04x.%04x after resume, %d\n",
1863 port1, portchange, devstatus, status);
1865 /* TRSMRCY = 10 msec */
1868 status = finish_device_resume(udev);
1872 hub_port_logical_disconnect(hub, port1);
1880 * usb_resume_device - re-activate a suspended usb device
1881 * @udev: device to re-activate
1882 * Context: must be able to sleep; device not locked; pm locks held
1884 * This will re-activate the suspended device, increasing power usage
1885 * while letting drivers communicate again with its endpoints.
1886 * USB resume explicitly guarantees that the power session between
1887 * the host and the device is the same as it was when the device
1890 * Returns 0 on success, else negative errno.
1892 int usb_resume_device(struct usb_device *udev)
1896 if (udev->state == USB_STATE_NOTATTACHED)
1899 /* selective resume of one downstream hub-to-device port */
1901 #ifdef CONFIG_USB_SUSPEND
1902 if (udev->state == USB_STATE_SUSPENDED) {
1903 // NOTE swsusp may bork us, device state being wrong...
1904 // NOTE this fails if parent is also suspended...
1905 status = hub_port_resume(hdev_to_hub(udev->parent),
1906 udev->portnum, udev);
1911 status = finish_device_resume(udev);
1913 dev_dbg(&udev->dev, "can't resume, status %d\n",
1916 /* rebind drivers that had no suspend() */
1918 usb_unlock_device(udev);
1919 bus_rescan_devices(&usb_bus_type);
1920 usb_lock_device(udev);
1925 static int remote_wakeup(struct usb_device *udev)
1929 #ifdef CONFIG_USB_SUSPEND
1931 /* don't repeat RESUME sequence if this device
1932 * was already woken up by some other task
1934 usb_lock_device(udev);
1935 if (udev->state == USB_STATE_SUSPENDED) {
1936 dev_dbg(&udev->dev, "RESUME (wakeup)\n");
1937 /* TRSMRCY = 10 msec */
1939 status = finish_device_resume(udev);
1941 usb_unlock_device(udev);
1946 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
1948 struct usb_hub *hub = usb_get_intfdata (intf);
1949 struct usb_device *hdev = hub->hdev;
1952 /* fail if children aren't already suspended */
1953 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
1954 struct usb_device *udev;
1956 udev = hdev->children [port1-1];
1957 if (udev && (udev->dev.power.power_state.event
1959 #ifdef CONFIG_USB_SUSPEND
1960 || udev->state != USB_STATE_SUSPENDED
1963 dev_dbg(&intf->dev, "port %d nyet suspended\n", port1);
1968 /* "global suspend" of the downstream HC-to-USB interface */
1969 if (!hdev->parent) {
1970 struct usb_bus *bus = hdev->bus;
1972 int status = hcd_bus_suspend (bus);
1975 dev_dbg(&hdev->dev, "'global' suspend %d\n",
1983 /* stop khubd and related activity */
1988 static int hub_resume(struct usb_interface *intf)
1990 struct usb_device *hdev = interface_to_usbdev(intf);
1991 struct usb_hub *hub = usb_get_intfdata (intf);
1994 /* "global resume" of the downstream HC-to-USB interface */
1995 if (!hdev->parent) {
1996 struct usb_bus *bus = hdev->bus;
1998 status = hcd_bus_resume (bus);
2000 dev_dbg(&intf->dev, "'global' resume %d\n",
2007 /* TRSMRCY = 10 msec */
2014 /* REVISIT: this recursion probably shouldn't exist. Remove
2015 * this code sometime, after retesting with different root and
2018 #ifdef CONFIG_USB_SUSPEND
2022 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
2023 struct usb_device *udev;
2024 u16 portstat, portchange;
2026 udev = hdev->children [port1-1];
2027 status = hub_port_status(hub, port1, &portstat, &portchange);
2029 if (portchange & USB_PORT_STAT_C_SUSPEND) {
2030 clear_port_feature(hdev, port1,
2031 USB_PORT_FEAT_C_SUSPEND);
2032 portchange &= ~USB_PORT_STAT_C_SUSPEND;
2035 /* let khubd handle disconnects etc */
2040 if (!udev || status < 0)
2042 usb_lock_device(udev);
2043 if (portstat & USB_PORT_STAT_SUSPEND)
2044 status = hub_port_resume(hub, port1, udev);
2046 status = finish_device_resume(udev);
2048 dev_dbg(&intf->dev, "resume port %d --> %d\n",
2050 hub_port_logical_disconnect(hub, port1);
2053 usb_unlock_device(udev);
2060 void usb_suspend_root_hub(struct usb_device *hdev)
2062 struct usb_hub *hub = hdev_to_hub(hdev);
2064 /* This also makes any led blinker stop retriggering. We're called
2065 * from irq, so the blinker might still be scheduled. Caller promises
2066 * that the root hub status URB will be canceled.
2069 mark_quiesced(to_usb_interface(hub->intfdev));
2072 void usb_resume_root_hub(struct usb_device *hdev)
2074 struct usb_hub *hub = hdev_to_hub(hdev);
2076 hub->resume_root_hub = 1;
2081 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2083 * Between connect detection and reset signaling there must be a delay
2084 * of 100ms at least for debounce and power-settling. The corresponding
2085 * timer shall restart whenever the downstream port detects a disconnect.
2087 * Apparently there are some bluetooth and irda-dongles and a number of
2088 * low-speed devices for which this debounce period may last over a second.
2089 * Not covered by the spec - but easy to deal with.
2091 * This implementation uses a 1500ms total debounce timeout; if the
2092 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2093 * every 25ms for transient disconnects. When the port status has been
2094 * unchanged for 100ms it returns the port status.
2097 #define HUB_DEBOUNCE_TIMEOUT 1500
2098 #define HUB_DEBOUNCE_STEP 25
2099 #define HUB_DEBOUNCE_STABLE 100
2101 static int hub_port_debounce(struct usb_hub *hub, int port1)
2104 int total_time, stable_time = 0;
2105 u16 portchange, portstatus;
2106 unsigned connection = 0xffff;
2108 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2109 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2113 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2114 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2115 stable_time += HUB_DEBOUNCE_STEP;
2116 if (stable_time >= HUB_DEBOUNCE_STABLE)
2120 connection = portstatus & USB_PORT_STAT_CONNECTION;
2123 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2124 clear_port_feature(hub->hdev, port1,
2125 USB_PORT_FEAT_C_CONNECTION);
2128 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2130 msleep(HUB_DEBOUNCE_STEP);
2133 dev_dbg (hub->intfdev,
2134 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2135 port1, total_time, stable_time, portstatus);
2137 if (stable_time < HUB_DEBOUNCE_STABLE)
2142 static void ep0_reinit(struct usb_device *udev)
2144 usb_disable_endpoint(udev, 0 + USB_DIR_IN);
2145 usb_disable_endpoint(udev, 0 + USB_DIR_OUT);
2146 udev->ep_in[0] = udev->ep_out[0] = &udev->ep0;
2149 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2150 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2152 static int hub_set_address(struct usb_device *udev)
2156 if (udev->devnum == 0)
2158 if (udev->state == USB_STATE_ADDRESS)
2160 if (udev->state != USB_STATE_DEFAULT)
2162 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2163 USB_REQ_SET_ADDRESS, 0, udev->devnum, 0,
2164 NULL, 0, USB_CTRL_SET_TIMEOUT);
2166 usb_set_device_state(udev, USB_STATE_ADDRESS);
2172 /* Reset device, (re)assign address, get device descriptor.
2173 * Device connection must be stable, no more debouncing needed.
2174 * Returns device in USB_STATE_ADDRESS, except on error.
2176 * If this is called for an already-existing device (as part of
2177 * usb_reset_device), the caller must own the device lock. For a
2178 * newly detected device that is not accessible through any global
2179 * pointers, it's not necessary to lock the device.
2182 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2185 static DEFINE_MUTEX(usb_address0_mutex);
2187 struct usb_device *hdev = hub->hdev;
2189 unsigned delay = HUB_SHORT_RESET_TIME;
2190 enum usb_device_speed oldspeed = udev->speed;
2192 /* root hub ports have a slightly longer reset period
2193 * (from USB 2.0 spec, section 7.1.7.5)
2195 if (!hdev->parent) {
2196 delay = HUB_ROOT_RESET_TIME;
2197 if (port1 == hdev->bus->otg_port)
2198 hdev->bus->b_hnp_enable = 0;
2201 /* Some low speed devices have problems with the quick delay, so */
2202 /* be a bit pessimistic with those devices. RHbug #23670 */
2203 if (oldspeed == USB_SPEED_LOW)
2204 delay = HUB_LONG_RESET_TIME;
2206 mutex_lock(&usb_address0_mutex);
2208 /* Reset the device; full speed may morph to high speed */
2209 retval = hub_port_reset(hub, port1, udev, delay);
2210 if (retval < 0) /* error or disconnect */
2212 /* success, speed is known */
2215 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2216 dev_dbg(&udev->dev, "device reset changed speed!\n");
2219 oldspeed = udev->speed;
2221 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2222 * it's fixed size except for full speed devices.
2224 switch (udev->speed) {
2225 case USB_SPEED_HIGH: /* fixed at 64 */
2226 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2228 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
2229 /* to determine the ep0 maxpacket size, try to read
2230 * the device descriptor to get bMaxPacketSize0 and
2231 * then correct our initial guess.
2233 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2235 case USB_SPEED_LOW: /* fixed at 8 */
2236 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(8);
2242 dev_info (&udev->dev,
2243 "%s %s speed USB device using %s and address %d\n",
2244 (udev->config) ? "reset" : "new",
2245 ({ char *speed; switch (udev->speed) {
2246 case USB_SPEED_LOW: speed = "low"; break;
2247 case USB_SPEED_FULL: speed = "full"; break;
2248 case USB_SPEED_HIGH: speed = "high"; break;
2249 default: speed = "?"; break;
2251 udev->bus->controller->driver->name,
2254 /* Set up TT records, if needed */
2256 udev->tt = hdev->tt;
2257 udev->ttport = hdev->ttport;
2258 } else if (udev->speed != USB_SPEED_HIGH
2259 && hdev->speed == USB_SPEED_HIGH) {
2260 udev->tt = &hub->tt;
2261 udev->ttport = port1;
2264 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2265 * Because device hardware and firmware is sometimes buggy in
2266 * this area, and this is how Linux has done it for ages.
2267 * Change it cautiously.
2269 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2270 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2271 * so it may help with some non-standards-compliant devices.
2272 * Otherwise we start with SET_ADDRESS and then try to read the
2273 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2276 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
2277 if (USE_NEW_SCHEME(retry_counter)) {
2278 struct usb_device_descriptor *buf;
2281 #define GET_DESCRIPTOR_BUFSIZE 64
2282 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2288 /* Use a short timeout the first time through,
2289 * so that recalcitrant full-speed devices with
2290 * 8- or 16-byte ep0-maxpackets won't slow things
2291 * down tremendously by NAKing the unexpectedly
2292 * early status stage. Also, retry on all errors;
2293 * some devices are flakey.
2295 for (j = 0; j < 3; ++j) {
2296 buf->bMaxPacketSize0 = 0;
2297 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2298 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2299 USB_DT_DEVICE << 8, 0,
2300 buf, GET_DESCRIPTOR_BUFSIZE,
2301 (i ? USB_CTRL_GET_TIMEOUT : 1000));
2302 switch (buf->bMaxPacketSize0) {
2303 case 8: case 16: case 32: case 64:
2304 if (buf->bDescriptorType ==
2318 udev->descriptor.bMaxPacketSize0 =
2319 buf->bMaxPacketSize0;
2322 retval = hub_port_reset(hub, port1, udev, delay);
2323 if (retval < 0) /* error or disconnect */
2325 if (oldspeed != udev->speed) {
2327 "device reset changed speed!\n");
2332 dev_err(&udev->dev, "device descriptor "
2333 "read/%s, error %d\n",
2338 #undef GET_DESCRIPTOR_BUFSIZE
2341 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
2342 retval = hub_set_address(udev);
2349 "device not accepting address %d, error %d\n",
2350 udev->devnum, retval);
2354 /* cope with hardware quirkiness:
2355 * - let SET_ADDRESS settle, some device hardware wants it
2356 * - read ep0 maxpacket even for high and low speed,
2359 if (USE_NEW_SCHEME(retry_counter))
2362 retval = usb_get_device_descriptor(udev, 8);
2364 dev_err(&udev->dev, "device descriptor "
2365 "read/%s, error %d\n",
2377 i = udev->descriptor.bMaxPacketSize0;
2378 if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
2379 if (udev->speed != USB_SPEED_FULL ||
2380 !(i == 8 || i == 16 || i == 32 || i == 64)) {
2381 dev_err(&udev->dev, "ep0 maxpacket = %d\n", i);
2385 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
2386 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
2390 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
2391 if (retval < (signed)sizeof(udev->descriptor)) {
2392 dev_err(&udev->dev, "device descriptor read/%s, error %d\n",
2403 hub_port_disable(hub, port1, 0);
2404 mutex_unlock(&usb_address0_mutex);
2409 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
2411 struct usb_qualifier_descriptor *qual;
2414 qual = kmalloc (sizeof *qual, SLAB_KERNEL);
2418 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
2419 qual, sizeof *qual);
2420 if (status == sizeof *qual) {
2421 dev_info(&udev->dev, "not running at top speed; "
2422 "connect to a high speed hub\n");
2423 /* hub LEDs are probably harder to miss than syslog */
2424 if (hub->has_indicators) {
2425 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
2426 schedule_work (&hub->leds);
2433 hub_power_remaining (struct usb_hub *hub)
2435 struct usb_device *hdev = hub->hdev;
2439 if (!hub->limited_power)
2442 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
2443 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
2444 struct usb_device *udev = hdev->children[port1 - 1];
2450 /* Unconfigured devices may not use more than 100mA,
2451 * or 8mA for OTG ports */
2452 if (udev->actconfig)
2453 delta = udev->actconfig->desc.bMaxPower * 2;
2454 else if (port1 != udev->bus->otg_port || hdev->parent)
2458 if (delta > hub->mA_per_port)
2459 dev_warn(&udev->dev, "%dmA is over %umA budget "
2461 delta, hub->mA_per_port, port1);
2464 if (remaining < 0) {
2465 dev_warn(hub->intfdev, "%dmA over power budget!\n",
2472 /* Handle physical or logical connection change events.
2473 * This routine is called when:
2474 * a port connection-change occurs;
2475 * a port enable-change occurs (often caused by EMI);
2476 * usb_reset_device() encounters changed descriptors (as from
2477 * a firmware download)
2478 * caller already locked the hub
2480 static void hub_port_connect_change(struct usb_hub *hub, int port1,
2481 u16 portstatus, u16 portchange)
2483 struct usb_device *hdev = hub->hdev;
2484 struct device *hub_dev = hub->intfdev;
2485 u16 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2489 "port %d, status %04x, change %04x, %s\n",
2490 port1, portstatus, portchange, portspeed (portstatus));
2492 if (hub->has_indicators) {
2493 set_port_led(hub, port1, HUB_LED_AUTO);
2494 hub->indicator[port1-1] = INDICATOR_AUTO;
2497 /* Disconnect any existing devices under this port */
2498 if (hdev->children[port1-1])
2499 usb_disconnect(&hdev->children[port1-1]);
2500 clear_bit(port1, hub->change_bits);
2502 #ifdef CONFIG_USB_OTG
2503 /* during HNP, don't repeat the debounce */
2504 if (hdev->bus->is_b_host)
2505 portchange &= ~USB_PORT_STAT_C_CONNECTION;
2508 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2509 status = hub_port_debounce(hub, port1);
2512 "connect-debounce failed, port %d disabled\n",
2516 portstatus = status;
2519 /* Return now if nothing is connected */
2520 if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
2522 /* maybe switch power back on (e.g. root hub was reset) */
2523 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
2524 && !(portstatus & (1 << USB_PORT_FEAT_POWER)))
2525 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
2527 if (portstatus & USB_PORT_STAT_ENABLE)
2532 #ifdef CONFIG_USB_SUSPEND
2533 /* If something is connected, but the port is suspended, wake it up. */
2534 if (portstatus & USB_PORT_STAT_SUSPEND) {
2535 status = hub_port_resume(hub, port1, NULL);
2538 "can't clear suspend on port %d; %d\n",
2545 for (i = 0; i < SET_CONFIG_TRIES; i++) {
2546 struct usb_device *udev;
2548 /* reallocate for each attempt, since references
2549 * to the previous one can escape in various ways
2551 udev = usb_alloc_dev(hdev, hdev->bus, port1);
2554 "couldn't allocate port %d usb_device\n",
2559 usb_set_device_state(udev, USB_STATE_POWERED);
2560 udev->speed = USB_SPEED_UNKNOWN;
2561 udev->bus_mA = hub->mA_per_port;
2563 /* set the address */
2564 choose_address(udev);
2565 if (udev->devnum <= 0) {
2566 status = -ENOTCONN; /* Don't retry */
2570 /* reset and get descriptor */
2571 status = hub_port_init(hub, udev, port1, i);
2575 /* consecutive bus-powered hubs aren't reliable; they can
2576 * violate the voltage drop budget. if the new child has
2577 * a "powered" LED, users should notice we didn't enable it
2578 * (without reading syslog), even without per-port LEDs
2581 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
2582 && udev->bus_mA <= 100) {
2585 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
2588 dev_dbg(&udev->dev, "get status %d ?\n", status);
2591 le16_to_cpus(&devstat);
2592 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
2594 "can't connect bus-powered hub "
2596 if (hub->has_indicators) {
2597 hub->indicator[port1-1] =
2598 INDICATOR_AMBER_BLINK;
2599 schedule_work (&hub->leds);
2601 status = -ENOTCONN; /* Don't retry */
2606 /* check for devices running slower than they could */
2607 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
2608 && udev->speed == USB_SPEED_FULL
2609 && highspeed_hubs != 0)
2610 check_highspeed (hub, udev, port1);
2612 /* Store the parent's children[] pointer. At this point
2613 * udev becomes globally accessible, although presumably
2614 * no one will look at it until hdev is unlocked.
2618 /* We mustn't add new devices if the parent hub has
2619 * been disconnected; we would race with the
2620 * recursively_mark_NOTATTACHED() routine.
2622 spin_lock_irq(&device_state_lock);
2623 if (hdev->state == USB_STATE_NOTATTACHED)
2626 hdev->children[port1-1] = udev;
2627 spin_unlock_irq(&device_state_lock);
2629 /* Run it through the hoops (find a driver, etc) */
2631 status = usb_new_device(udev);
2633 spin_lock_irq(&device_state_lock);
2634 hdev->children[port1-1] = NULL;
2635 spin_unlock_irq(&device_state_lock);
2642 status = hub_power_remaining(hub);
2644 dev_dbg(hub_dev, "%dmA power budget left\n", status);
2649 hub_port_disable(hub, port1, 1);
2652 release_address(udev);
2654 if (status == -ENOTCONN)
2659 hub_port_disable(hub, port1, 1);
2662 static void hub_events(void)
2664 struct list_head *tmp;
2665 struct usb_device *hdev;
2666 struct usb_interface *intf;
2667 struct usb_hub *hub;
2668 struct device *hub_dev;
2677 * We restart the list every time to avoid a deadlock with
2678 * deleting hubs downstream from this one. This should be
2679 * safe since we delete the hub from the event list.
2680 * Not the most efficient, but avoids deadlocks.
2684 /* Grab the first entry at the beginning of the list */
2685 spin_lock_irq(&hub_event_lock);
2686 if (list_empty(&hub_event_list)) {
2687 spin_unlock_irq(&hub_event_lock);
2691 tmp = hub_event_list.next;
2694 hub = list_entry(tmp, struct usb_hub, event_list);
2696 intf = to_usb_interface(hub->intfdev);
2697 hub_dev = &intf->dev;
2699 i = hub->resume_root_hub;
2701 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x%s\n",
2702 hdev->state, hub->descriptor
2703 ? hub->descriptor->bNbrPorts
2705 /* NOTE: expects max 15 ports... */
2706 (u16) hub->change_bits[0],
2707 (u16) hub->event_bits[0],
2708 i ? ", resume root" : "");
2711 spin_unlock_irq(&hub_event_lock);
2713 /* Is this is a root hub wanting to reactivate the downstream
2714 * ports? If so, be sure the interface resumes even if its
2715 * stub "device" node was never suspended.
2718 dpm_runtime_resume(&hdev->dev);
2719 dpm_runtime_resume(&intf->dev);
2724 /* Lock the device, then check to see if we were
2725 * disconnected while waiting for the lock to succeed. */
2726 if (locktree(hdev) < 0) {
2730 if (hub != usb_get_intfdata(intf))
2733 /* If the hub has died, clean up after it */
2734 if (hdev->state == USB_STATE_NOTATTACHED) {
2735 hub_pre_reset(hub, 0);
2739 /* If this is an inactive or suspended hub, do nothing */
2744 dev_dbg (hub_dev, "resetting for error %d\n",
2747 ret = usb_reset_device(hdev);
2750 "error resetting hub: %d\n", ret);
2758 /* deal with port status changes */
2759 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
2760 if (test_bit(i, hub->busy_bits))
2762 connect_change = test_bit(i, hub->change_bits);
2763 if (!test_and_clear_bit(i, hub->event_bits) &&
2764 !connect_change && !hub->activating)
2767 ret = hub_port_status(hub, i,
2768 &portstatus, &portchange);
2772 if (hub->activating && !hdev->children[i-1] &&
2774 USB_PORT_STAT_CONNECTION))
2777 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2778 clear_port_feature(hdev, i,
2779 USB_PORT_FEAT_C_CONNECTION);
2783 if (portchange & USB_PORT_STAT_C_ENABLE) {
2784 if (!connect_change)
2786 "port %d enable change, "
2789 clear_port_feature(hdev, i,
2790 USB_PORT_FEAT_C_ENABLE);
2793 * EM interference sometimes causes badly
2794 * shielded USB devices to be shutdown by
2795 * the hub, this hack enables them again.
2796 * Works at least with mouse driver.
2798 if (!(portstatus & USB_PORT_STAT_ENABLE)
2800 && hdev->children[i-1]) {
2803 "disabled by hub (EMI?), "
2810 if (portchange & USB_PORT_STAT_C_SUSPEND) {
2811 clear_port_feature(hdev, i,
2812 USB_PORT_FEAT_C_SUSPEND);
2813 if (hdev->children[i-1]) {
2814 ret = remote_wakeup(hdev->
2820 hub_port_disable(hub, i, 1);
2823 "resume on port %d, status %d\n",
2827 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
2829 "over-current change on port %d\n",
2831 clear_port_feature(hdev, i,
2832 USB_PORT_FEAT_C_OVER_CURRENT);
2836 if (portchange & USB_PORT_STAT_C_RESET) {
2838 "reset change on port %d\n",
2840 clear_port_feature(hdev, i,
2841 USB_PORT_FEAT_C_RESET);
2845 hub_port_connect_change(hub, i,
2846 portstatus, portchange);
2849 /* deal with hub status changes */
2850 if (test_and_clear_bit(0, hub->event_bits) == 0)
2852 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
2853 dev_err (hub_dev, "get_hub_status failed\n");
2855 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
2856 dev_dbg (hub_dev, "power change\n");
2857 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
2858 if (hubstatus & HUB_STATUS_LOCAL_POWER)
2859 /* FIXME: Is this always true? */
2860 hub->limited_power = 0;
2862 hub->limited_power = 1;
2864 if (hubchange & HUB_CHANGE_OVERCURRENT) {
2865 dev_dbg (hub_dev, "overcurrent change\n");
2866 msleep(500); /* Cool down */
2867 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
2872 hub->activating = 0;
2874 /* If this is a root hub, tell the HCD it's okay to
2875 * re-enable port-change interrupts now. */
2877 usb_enable_root_hub_irq(hdev->bus);
2880 usb_unlock_device(hdev);
2883 } /* end while (1) */
2886 static int hub_thread(void *__unused)
2890 wait_event_interruptible(khubd_wait,
2891 !list_empty(&hub_event_list) ||
2892 kthread_should_stop());
2894 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
2896 pr_debug("%s: khubd exiting\n", usbcore_name);
2900 static struct usb_device_id hub_id_table [] = {
2901 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
2902 .bDeviceClass = USB_CLASS_HUB},
2903 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
2904 .bInterfaceClass = USB_CLASS_HUB},
2905 { } /* Terminating entry */
2908 MODULE_DEVICE_TABLE (usb, hub_id_table);
2910 static struct usb_driver hub_driver = {
2913 .disconnect = hub_disconnect,
2914 .suspend = hub_suspend,
2915 .resume = hub_resume,
2917 .id_table = hub_id_table,
2920 int usb_hub_init(void)
2922 if (usb_register(&hub_driver) < 0) {
2923 printk(KERN_ERR "%s: can't register hub driver\n",
2928 khubd_task = kthread_run(hub_thread, NULL, "khubd");
2929 if (!IS_ERR(khubd_task))
2932 /* Fall through if kernel_thread failed */
2933 usb_deregister(&hub_driver);
2934 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
2939 void usb_hub_cleanup(void)
2941 kthread_stop(khubd_task);
2944 * Hub resources are freed for us by usb_deregister. It calls
2945 * usb_driver_purge on every device which in turn calls that
2946 * devices disconnect function if it is using this driver.
2947 * The hub_disconnect function takes care of releasing the
2948 * individual hub resources. -greg
2950 usb_deregister(&hub_driver);
2951 } /* usb_hub_cleanup() */
2953 static int config_descriptors_changed(struct usb_device *udev)
2957 struct usb_config_descriptor *buf;
2959 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2960 if (len < le16_to_cpu(udev->config[index].desc.wTotalLength))
2961 len = le16_to_cpu(udev->config[index].desc.wTotalLength);
2963 buf = kmalloc (len, SLAB_KERNEL);
2965 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
2966 /* assume the worst */
2969 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2971 int old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
2973 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
2975 if (length < old_length) {
2976 dev_dbg(&udev->dev, "config index %d, error %d\n",
2980 if (memcmp (buf, udev->rawdescriptors[index], old_length)
2982 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
2983 index, buf->bConfigurationValue);
2988 return index != udev->descriptor.bNumConfigurations;
2992 * usb_reset_device - perform a USB port reset to reinitialize a device
2993 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
2995 * WARNING - don't reset any device unless drivers for all of its
2996 * interfaces are expecting that reset! Maybe some driver->reset()
2997 * method should eventually help ensure sufficient cooperation.
2999 * Do a port reset, reassign the device's address, and establish its
3000 * former operating configuration. If the reset fails, or the device's
3001 * descriptors change from their values before the reset, or the original
3002 * configuration and altsettings cannot be restored, a flag will be set
3003 * telling khubd to pretend the device has been disconnected and then
3004 * re-connected. All drivers will be unbound, and the device will be
3005 * re-enumerated and probed all over again.
3007 * Returns 0 if the reset succeeded, -ENODEV if the device has been
3008 * flagged for logical disconnection, or some other negative error code
3009 * if the reset wasn't even attempted.
3011 * The caller must own the device lock. For example, it's safe to use
3012 * this from a driver probe() routine after downloading new firmware.
3013 * For calls that might not occur during probe(), drivers should lock
3014 * the device using usb_lock_device_for_reset().
3016 int usb_reset_device(struct usb_device *udev)
3018 struct usb_device *parent_hdev = udev->parent;
3019 struct usb_hub *parent_hub;
3020 struct usb_device_descriptor descriptor = udev->descriptor;
3021 struct usb_hub *hub = NULL;
3023 int port1 = udev->portnum;
3025 if (udev->state == USB_STATE_NOTATTACHED ||
3026 udev->state == USB_STATE_SUSPENDED) {
3027 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3033 /* this requires hcd-specific logic; see OHCI hc_restart() */
3034 dev_dbg(&udev->dev, "%s for root hub!\n", __FUNCTION__);
3037 parent_hub = hdev_to_hub(parent_hdev);
3039 /* If we're resetting an active hub, take some special actions */
3040 if (udev->actconfig && udev->actconfig->desc.bNumInterfaces > 0 &&
3041 udev->actconfig->interface[0]->dev.driver ==
3042 &hub_driver.driver &&
3043 (hub = hdev_to_hub(udev)) != NULL) {
3044 hub_pre_reset(hub, 0);
3047 set_bit(port1, parent_hub->busy_bits);
3048 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
3050 /* ep0 maxpacket size may change; let the HCD know about it.
3051 * Other endpoints will be handled by re-enumeration. */
3053 ret = hub_port_init(parent_hub, udev, port1, i);
3057 clear_bit(port1, parent_hub->busy_bits);
3061 /* Device might have changed firmware (DFU or similar) */
3062 if (memcmp(&udev->descriptor, &descriptor, sizeof descriptor)
3063 || config_descriptors_changed (udev)) {
3064 dev_info(&udev->dev, "device firmware changed\n");
3065 udev->descriptor = descriptor; /* for disconnect() calls */
3069 if (!udev->actconfig)
3072 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3073 USB_REQ_SET_CONFIGURATION, 0,
3074 udev->actconfig->desc.bConfigurationValue, 0,
3075 NULL, 0, USB_CTRL_SET_TIMEOUT);
3078 "can't restore configuration #%d (error=%d)\n",
3079 udev->actconfig->desc.bConfigurationValue, ret);
3082 usb_set_device_state(udev, USB_STATE_CONFIGURED);
3084 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
3085 struct usb_interface *intf = udev->actconfig->interface[i];
3086 struct usb_interface_descriptor *desc;
3088 /* set_interface resets host side toggle even
3089 * for altsetting zero. the interface may have no driver.
3091 desc = &intf->cur_altsetting->desc;
3092 ret = usb_set_interface(udev, desc->bInterfaceNumber,
3093 desc->bAlternateSetting);
3095 dev_err(&udev->dev, "failed to restore interface %d "
3096 "altsetting %d (error=%d)\n",
3097 desc->bInterfaceNumber,
3098 desc->bAlternateSetting,
3106 hub_post_reset(hub);
3110 hub_port_logical_disconnect(parent_hub, port1);