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 /* Some hubs have a subclass of 1, which AFAICT according to the */
840 /* specs is not defined, but it works */
841 if ((desc->desc.bInterfaceSubClass != 0) &&
842 (desc->desc.bInterfaceSubClass != 1)) {
844 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
848 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
849 if (desc->desc.bNumEndpoints != 1)
850 goto descriptor_error;
852 endpoint = &desc->endpoint[0].desc;
854 /* Output endpoint? Curiouser and curiouser.. */
855 if (!(endpoint->bEndpointAddress & USB_DIR_IN))
856 goto descriptor_error;
858 /* If it's not an interrupt endpoint, we'd better punt! */
859 if ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
860 != USB_ENDPOINT_XFER_INT)
861 goto descriptor_error;
864 dev_info (&intf->dev, "USB hub found\n");
866 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
868 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
872 INIT_LIST_HEAD(&hub->event_list);
873 hub->intfdev = &intf->dev;
875 INIT_WORK(&hub->leds, led_work, hub);
877 usb_set_intfdata (intf, hub);
879 if (hdev->speed == USB_SPEED_HIGH)
882 if (hub_configure(hub, endpoint) >= 0)
885 hub_disconnect (intf);
890 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
892 struct usb_device *hdev = interface_to_usbdev (intf);
894 /* assert ifno == 0 (part of hub spec) */
896 case USBDEVFS_HUB_PORTINFO: {
897 struct usbdevfs_hub_portinfo *info = user_data;
900 spin_lock_irq(&device_state_lock);
901 if (hdev->devnum <= 0)
904 info->nports = hdev->maxchild;
905 for (i = 0; i < info->nports; i++) {
906 if (hdev->children[i] == NULL)
910 hdev->children[i]->devnum;
913 spin_unlock_irq(&device_state_lock);
915 return info->nports + 1;
924 /* grab device/port lock, returning index of that port (zero based).
925 * protects the upstream link used by this device from concurrent
926 * tree operations like suspend, resume, reset, and disconnect, which
927 * apply to everything downstream of a given port.
929 static int locktree(struct usb_device *udev)
932 struct usb_device *hdev;
937 /* root hub is always the first lock in the series */
940 usb_lock_device(udev);
944 /* on the path from root to us, lock everything from
945 * top down, dropping parent locks when not needed
951 /* everything is fail-fast once disconnect
954 if (udev->state == USB_STATE_NOTATTACHED) {
955 usb_unlock_device(hdev);
959 /* when everyone grabs locks top->bottom,
960 * non-overlapping work may be concurrent
962 usb_lock_device(udev);
963 usb_unlock_device(hdev);
964 return udev->portnum;
967 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
971 for (i = 0; i < udev->maxchild; ++i) {
972 if (udev->children[i])
973 recursively_mark_NOTATTACHED(udev->children[i]);
975 udev->state = USB_STATE_NOTATTACHED;
979 * usb_set_device_state - change a device's current state (usbcore, hcds)
980 * @udev: pointer to device whose state should be changed
981 * @new_state: new state value to be stored
983 * udev->state is _not_ fully protected by the device lock. Although
984 * most transitions are made only while holding the lock, the state can
985 * can change to USB_STATE_NOTATTACHED at almost any time. This
986 * is so that devices can be marked as disconnected as soon as possible,
987 * without having to wait for any semaphores to be released. As a result,
988 * all changes to any device's state must be protected by the
989 * device_state_lock spinlock.
991 * Once a device has been added to the device tree, all changes to its state
992 * should be made using this routine. The state should _not_ be set directly.
994 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
995 * Otherwise udev->state is set to new_state, and if new_state is
996 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
997 * to USB_STATE_NOTATTACHED.
999 void usb_set_device_state(struct usb_device *udev,
1000 enum usb_device_state new_state)
1002 unsigned long flags;
1004 spin_lock_irqsave(&device_state_lock, flags);
1005 if (udev->state == USB_STATE_NOTATTACHED)
1007 else if (new_state != USB_STATE_NOTATTACHED) {
1008 udev->state = new_state;
1010 /* root hub wakeup capabilities are managed out-of-band
1011 * and may involve silicon errata ... ignore them here.
1014 if (new_state == USB_STATE_CONFIGURED)
1015 device_init_wakeup(&udev->dev,
1016 (udev->actconfig->desc.bmAttributes
1017 & USB_CONFIG_ATT_WAKEUP));
1018 else if (new_state != USB_STATE_SUSPENDED)
1019 device_init_wakeup(&udev->dev, 0);
1022 recursively_mark_NOTATTACHED(udev);
1023 spin_unlock_irqrestore(&device_state_lock, flags);
1030 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
1031 * @rhdev: struct usb_device for the root hub
1033 * The USB host controller driver calls this function when its root hub
1034 * is resumed and Vbus power has been interrupted or the controller
1035 * has been reset. The routine marks all the children of the root hub
1036 * as NOTATTACHED and marks logical connect-change events on their ports.
1038 void usb_root_hub_lost_power(struct usb_device *rhdev)
1040 struct usb_hub *hub;
1042 unsigned long flags;
1044 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
1045 spin_lock_irqsave(&device_state_lock, flags);
1046 hub = hdev_to_hub(rhdev);
1047 for (port1 = 1; port1 <= rhdev->maxchild; ++port1) {
1048 if (rhdev->children[port1 - 1]) {
1049 recursively_mark_NOTATTACHED(
1050 rhdev->children[port1 - 1]);
1051 set_bit(port1, hub->change_bits);
1054 spin_unlock_irqrestore(&device_state_lock, flags);
1056 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
1060 static void choose_address(struct usb_device *udev)
1063 struct usb_bus *bus = udev->bus;
1065 /* If khubd ever becomes multithreaded, this will need a lock */
1067 /* Try to allocate the next devnum beginning at bus->devnum_next. */
1068 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1071 devnum = find_next_zero_bit(bus->devmap.devicemap, 128, 1);
1073 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1076 set_bit(devnum, bus->devmap.devicemap);
1077 udev->devnum = devnum;
1081 static void release_address(struct usb_device *udev)
1083 if (udev->devnum > 0) {
1084 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1090 * usb_disconnect - disconnect a device (usbcore-internal)
1091 * @pdev: pointer to device being disconnected
1092 * Context: !in_interrupt ()
1094 * Something got disconnected. Get rid of it and all of its children.
1096 * If *pdev is a normal device then the parent hub must already be locked.
1097 * If *pdev is a root hub then this routine will acquire the
1098 * usb_bus_list_lock on behalf of the caller.
1100 * Only hub drivers (including virtual root hub drivers for host
1101 * controllers) should ever call this.
1103 * This call is synchronous, and may not be used in an interrupt context.
1105 void usb_disconnect(struct usb_device **pdev)
1107 struct usb_device *udev = *pdev;
1111 pr_debug ("%s nodev\n", __FUNCTION__);
1115 /* mark the device as inactive, so any further urb submissions for
1116 * this device (and any of its children) will fail immediately.
1117 * this quiesces everyting except pending urbs.
1119 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1120 dev_info (&udev->dev, "USB disconnect, address %d\n", udev->devnum);
1122 usb_lock_device(udev);
1124 /* Free up all the children before we remove this device */
1125 for (i = 0; i < USB_MAXCHILDREN; i++) {
1126 if (udev->children[i])
1127 usb_disconnect(&udev->children[i]);
1130 /* deallocate hcd/hardware state ... nuking all pending urbs and
1131 * cleaning up all state associated with the current configuration
1132 * so that the hardware is now fully quiesced.
1134 usb_disable_device(udev, 0);
1136 usb_notify_remove_device(udev);
1138 /* Free the device number, remove the /proc/bus/usb entry and
1139 * the sysfs attributes, and delete the parent's children[]
1140 * (or root_hub) pointer.
1142 dev_dbg (&udev->dev, "unregistering device\n");
1143 release_address(udev);
1144 usb_remove_sysfs_dev_files(udev);
1146 /* Avoid races with recursively_mark_NOTATTACHED() */
1147 spin_lock_irq(&device_state_lock);
1149 spin_unlock_irq(&device_state_lock);
1151 usb_unlock_device(udev);
1153 device_unregister(&udev->dev);
1156 static inline const char *plural(int n)
1158 return (n == 1 ? "" : "s");
1161 static int choose_configuration(struct usb_device *udev)
1167 struct usb_host_config *c, *best;
1169 /* If this fails, assume the device is bus-powered */
1171 usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
1172 le16_to_cpus(&devstatus);
1173 bus_powered = ((devstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0);
1174 dev_dbg(&udev->dev, "device is %s-powered\n",
1175 bus_powered ? "bus" : "self");
1179 num_configs = udev->descriptor.bNumConfigurations;
1180 for (i = 0; i < num_configs; (i++, c++)) {
1181 struct usb_interface_descriptor *desc = NULL;
1183 /* It's possible that a config has no interfaces! */
1184 if (c->desc.bNumInterfaces > 0)
1185 desc = &c->intf_cache[0]->altsetting->desc;
1188 * HP's USB bus-powered keyboard has only one configuration
1189 * and it claims to be self-powered; other devices may have
1190 * similar errors in their descriptors. If the next test
1191 * were allowed to execute, such configurations would always
1192 * be rejected and the devices would not work as expected.
1195 /* Rule out self-powered configs for a bus-powered device */
1196 if (bus_powered && (c->desc.bmAttributes &
1197 USB_CONFIG_ATT_SELFPOWER))
1202 * The next test may not be as effective as it should be.
1203 * Some hubs have errors in their descriptor, claiming
1204 * to be self-powered when they are really bus-powered.
1205 * We will overestimate the amount of current such hubs
1206 * make available for each port.
1208 * This is a fairly benign sort of failure. It won't
1209 * cause us to reject configurations that we should have
1213 /* Rule out configs that draw too much bus current */
1214 if (c->desc.bMaxPower * 2 > udev->bus_mA)
1217 /* If the first config's first interface is COMM/2/0xff
1218 * (MSFT RNDIS), rule it out unless Linux has host-side
1221 && desc->bInterfaceClass == USB_CLASS_COMM
1222 && desc->bInterfaceSubClass == 2
1223 && desc->bInterfaceProtocol == 0xff) {
1224 #ifndef CONFIG_USB_NET_RNDIS
1231 /* From the remaining configs, choose the first one whose
1232 * first interface is for a non-vendor-specific class.
1233 * Reason: Linux is more likely to have a class driver
1234 * than a vendor-specific driver. */
1235 else if (udev->descriptor.bDeviceClass !=
1236 USB_CLASS_VENDOR_SPEC &&
1237 (!desc || desc->bInterfaceClass !=
1238 USB_CLASS_VENDOR_SPEC)) {
1243 /* If all the remaining configs are vendor-specific,
1244 * choose the first one. */
1250 i = best->desc.bConfigurationValue;
1251 dev_info(&udev->dev,
1252 "configuration #%d chosen from %d choice%s\n",
1253 i, num_configs, plural(num_configs));
1256 dev_warn(&udev->dev,
1257 "no configuration chosen from %d choice%s\n",
1258 num_configs, plural(num_configs));
1264 static void show_string(struct usb_device *udev, char *id, char *string)
1268 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1272 static inline void show_string(struct usb_device *udev, char *id, char *string)
1277 #ifdef CONFIG_USB_OTG
1278 #include "otg_whitelist.h"
1282 * usb_new_device - perform initial device setup (usbcore-internal)
1283 * @udev: newly addressed device (in ADDRESS state)
1285 * This is called with devices which have been enumerated, but not yet
1286 * configured. The device descriptor is available, but not descriptors
1287 * for any device configuration. The caller must have locked either
1288 * the parent hub (if udev is a normal device) or else the
1289 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1290 * udev has already been installed, but udev is not yet visible through
1291 * sysfs or other filesystem code.
1293 * Returns 0 for success (device is configured and listed, with its
1294 * interfaces, in sysfs); else a negative errno value.
1296 * This call is synchronous, and may not be used in an interrupt context.
1298 * Only the hub driver or root-hub registrar should ever call this.
1300 int usb_new_device(struct usb_device *udev)
1305 err = usb_get_configuration(udev);
1307 dev_err(&udev->dev, "can't read configurations, error %d\n",
1312 /* read the standard strings and cache them if present */
1313 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1314 udev->manufacturer = usb_cache_string(udev,
1315 udev->descriptor.iManufacturer);
1316 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
1318 /* Tell the world! */
1319 dev_dbg(&udev->dev, "new device strings: Mfr=%d, Product=%d, "
1320 "SerialNumber=%d\n",
1321 udev->descriptor.iManufacturer,
1322 udev->descriptor.iProduct,
1323 udev->descriptor.iSerialNumber);
1324 show_string(udev, "Product", udev->product);
1325 show_string(udev, "Manufacturer", udev->manufacturer);
1326 show_string(udev, "SerialNumber", udev->serial);
1328 #ifdef CONFIG_USB_OTG
1330 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1331 * to wake us after we've powered off VBUS; and HNP, switching roles
1332 * "host" to "peripheral". The OTG descriptor helps figure this out.
1334 if (!udev->bus->is_b_host
1336 && udev->parent == udev->bus->root_hub) {
1337 struct usb_otg_descriptor *desc = 0;
1338 struct usb_bus *bus = udev->bus;
1340 /* descriptor may appear anywhere in config */
1341 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1342 le16_to_cpu(udev->config[0].desc.wTotalLength),
1343 USB_DT_OTG, (void **) &desc) == 0) {
1344 if (desc->bmAttributes & USB_OTG_HNP) {
1345 unsigned port1 = udev->portnum;
1346 struct usb_device *root = udev->parent;
1348 dev_info(&udev->dev,
1349 "Dual-Role OTG device on %sHNP port\n",
1350 (port1 == bus->otg_port)
1353 /* enable HNP before suspend, it's simpler */
1354 if (port1 == bus->otg_port)
1355 bus->b_hnp_enable = 1;
1356 err = usb_control_msg(udev,
1357 usb_sndctrlpipe(udev, 0),
1358 USB_REQ_SET_FEATURE, 0,
1360 ? USB_DEVICE_B_HNP_ENABLE
1361 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1362 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1364 /* OTG MESSAGE: report errors here,
1365 * customize to match your product.
1367 dev_info(&udev->dev,
1368 "can't set HNP mode; %d\n",
1370 bus->b_hnp_enable = 0;
1376 if (!is_targeted(udev)) {
1378 /* Maybe it can talk to us, though we can't talk to it.
1379 * (Includes HNP test device.)
1381 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
1382 static int __usb_suspend_device(struct usb_device *,
1384 err = __usb_suspend_device(udev, udev->bus->otg_port);
1386 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1393 /* put device-specific files into sysfs */
1394 err = device_add (&udev->dev);
1396 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1399 usb_create_sysfs_dev_files (udev);
1401 usb_lock_device(udev);
1403 /* choose and set the configuration. that registers the interfaces
1404 * with the driver core, and lets usb device drivers bind to them.
1406 c = choose_configuration(udev);
1408 err = usb_set_configuration(udev, c);
1410 dev_err(&udev->dev, "can't set config #%d, error %d\n",
1412 /* This need not be fatal. The user can try to
1413 * set other configurations. */
1417 /* USB device state == configured ... usable */
1418 usb_notify_add_device(udev);
1420 usb_unlock_device(udev);
1425 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1430 static int hub_port_status(struct usb_hub *hub, int port1,
1431 u16 *status, u16 *change)
1435 ret = get_port_status(hub->hdev, port1, &hub->status->port);
1437 dev_err (hub->intfdev,
1438 "%s failed (err = %d)\n", __FUNCTION__, ret);
1440 *status = le16_to_cpu(hub->status->port.wPortStatus);
1441 *change = le16_to_cpu(hub->status->port.wPortChange);
1447 #define PORT_RESET_TRIES 5
1448 #define SET_ADDRESS_TRIES 2
1449 #define GET_DESCRIPTOR_TRIES 2
1450 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1451 #define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1453 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1454 #define HUB_SHORT_RESET_TIME 10
1455 #define HUB_LONG_RESET_TIME 200
1456 #define HUB_RESET_TIMEOUT 500
1458 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
1459 struct usb_device *udev, unsigned int delay)
1461 int delay_time, ret;
1465 for (delay_time = 0;
1466 delay_time < HUB_RESET_TIMEOUT;
1467 delay_time += delay) {
1468 /* wait to give the device a chance to reset */
1471 /* read and decode port status */
1472 ret = hub_port_status(hub, port1, &portstatus, &portchange);
1476 /* Device went away? */
1477 if (!(portstatus & USB_PORT_STAT_CONNECTION))
1480 /* bomb out completely if something weird happened */
1481 if ((portchange & USB_PORT_STAT_C_CONNECTION))
1484 /* if we`ve finished resetting, then break out of the loop */
1485 if (!(portstatus & USB_PORT_STAT_RESET) &&
1486 (portstatus & USB_PORT_STAT_ENABLE)) {
1487 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
1488 udev->speed = USB_SPEED_HIGH;
1489 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
1490 udev->speed = USB_SPEED_LOW;
1492 udev->speed = USB_SPEED_FULL;
1496 /* switch to the long delay after two short delay failures */
1497 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
1498 delay = HUB_LONG_RESET_TIME;
1500 dev_dbg (hub->intfdev,
1501 "port %d not reset yet, waiting %dms\n",
1508 static int hub_port_reset(struct usb_hub *hub, int port1,
1509 struct usb_device *udev, unsigned int delay)
1513 /* Reset the port */
1514 for (i = 0; i < PORT_RESET_TRIES; i++) {
1515 status = set_port_feature(hub->hdev,
1516 port1, USB_PORT_FEAT_RESET);
1518 dev_err(hub->intfdev,
1519 "cannot reset port %d (err = %d)\n",
1522 status = hub_port_wait_reset(hub, port1, udev, delay);
1523 if (status && status != -ENOTCONN)
1524 dev_dbg(hub->intfdev,
1525 "port_wait_reset: err = %d\n",
1529 /* return on disconnect or reset */
1532 /* TRSTRCY = 10 ms; plus some extra */
1537 clear_port_feature(hub->hdev,
1538 port1, USB_PORT_FEAT_C_RESET);
1539 /* FIXME need disconnect() for NOTATTACHED device */
1540 usb_set_device_state(udev, status
1541 ? USB_STATE_NOTATTACHED
1542 : USB_STATE_DEFAULT);
1546 dev_dbg (hub->intfdev,
1547 "port %d not enabled, trying reset again...\n",
1549 delay = HUB_LONG_RESET_TIME;
1552 dev_err (hub->intfdev,
1553 "Cannot enable port %i. Maybe the USB cable is bad?\n",
1560 * Disable a port and mark a logical connnect-change event, so that some
1561 * time later khubd will disconnect() any existing usb_device on the port
1562 * and will re-enumerate if there actually is a device attached.
1564 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
1566 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
1567 hub_port_disable(hub, port1, 1);
1569 /* FIXME let caller ask to power down the port:
1570 * - some devices won't enumerate without a VBUS power cycle
1571 * - SRP saves power that way
1572 * - ... new call, TBD ...
1573 * That's easy if this hub can switch power per-port, and
1574 * khubd reactivates the port later (timer, SRP, etc).
1575 * Powerdown must be optional, because of reset/DFU.
1578 set_bit(port1, hub->change_bits);
1583 #ifdef CONFIG_USB_SUSPEND
1586 * Selective port suspend reduces power; most suspended devices draw
1587 * less than 500 uA. It's also used in OTG, along with remote wakeup.
1588 * All devices below the suspended port are also suspended.
1590 * Devices leave suspend state when the host wakes them up. Some devices
1591 * also support "remote wakeup", where the device can activate the USB
1592 * tree above them to deliver data, such as a keypress or packet. In
1593 * some cases, this wakes the USB host.
1595 static int hub_port_suspend(struct usb_hub *hub, int port1,
1596 struct usb_device *udev)
1600 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
1602 /* enable remote wakeup when appropriate; this lets the device
1603 * wake up the upstream hub (including maybe the root hub).
1605 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
1606 * we don't explicitly enable it here.
1608 if (device_may_wakeup(&udev->dev)) {
1609 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1610 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
1611 USB_DEVICE_REMOTE_WAKEUP, 0,
1613 USB_CTRL_SET_TIMEOUT);
1616 "won't remote wakeup, status %d\n",
1621 status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
1623 dev_dbg(hub->intfdev,
1624 "can't suspend port %d, status %d\n",
1626 /* paranoia: "should not happen" */
1627 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1628 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
1629 USB_DEVICE_REMOTE_WAKEUP, 0,
1631 USB_CTRL_SET_TIMEOUT);
1633 /* device has up to 10 msec to fully suspend */
1634 dev_dbg(&udev->dev, "usb suspend\n");
1635 usb_set_device_state(udev, USB_STATE_SUSPENDED);
1642 * Devices on USB hub ports have only one "suspend" state, corresponding
1643 * to ACPI D2, "may cause the device to lose some context".
1644 * State transitions include:
1646 * - suspend, resume ... when the VBUS power link stays live
1647 * - suspend, disconnect ... VBUS lost
1649 * Once VBUS drop breaks the circuit, the port it's using has to go through
1650 * normal re-enumeration procedures, starting with enabling VBUS power.
1651 * Other than re-initializing the hub (plug/unplug, except for root hubs),
1652 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
1653 * timer, no SRP, no requests through sysfs.
1655 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
1656 * the root hub for their bus goes into global suspend ... so we don't
1657 * (falsely) update the device power state to say it suspended.
1659 static int __usb_suspend_device (struct usb_device *udev, int port1)
1663 /* caller owns the udev device lock */
1667 if (udev->state == USB_STATE_SUSPENDED
1668 || udev->state == USB_STATE_NOTATTACHED) {
1672 /* all interfaces must already be suspended */
1673 if (udev->actconfig) {
1676 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
1677 struct usb_interface *intf;
1679 intf = udev->actconfig->interface[i];
1680 if (is_active(intf)) {
1681 dev_dbg(&intf->dev, "nyet suspended\n");
1687 /* we only change a device's upstream USB link.
1688 * root hubs have no upstream USB link.
1691 status = hub_port_suspend(hdev_to_hub(udev->parent), port1,
1695 udev->dev.power.power_state = PMSG_SUSPEND;
1702 * usb_suspend_device - suspend a usb device
1703 * @udev: device that's no longer in active use
1704 * Context: must be able to sleep; device not locked; pm locks held
1706 * Suspends a USB device that isn't in active use, conserving power.
1707 * Devices may wake out of a suspend, if anything important happens,
1708 * using the remote wakeup mechanism. They may also be taken out of
1709 * suspend by the host, using usb_resume_device(). It's also routine
1710 * to disconnect devices while they are suspended.
1712 * This only affects the USB hardware for a device; its interfaces
1713 * (and, for hubs, child devices) must already have been suspended.
1715 * Suspending OTG devices may trigger HNP, if that's been enabled
1716 * between a pair of dual-role devices. That will change roles, such
1717 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
1719 * Returns 0 on success, else negative errno.
1721 int usb_suspend_device(struct usb_device *udev)
1723 #ifdef CONFIG_USB_SUSPEND
1724 if (udev->state == USB_STATE_NOTATTACHED)
1726 return __usb_suspend_device(udev, udev->portnum);
1728 /* NOTE: udev->state unchanged, it's not lying ... */
1729 udev->dev.power.power_state = PMSG_SUSPEND;
1735 * If the USB "suspend" state is in use (rather than "global suspend"),
1736 * many devices will be individually taken out of suspend state using
1737 * special" resume" signaling. These routines kick in shortly after
1738 * hardware resume signaling is finished, either because of selective
1739 * resume (by host) or remote wakeup (by device) ... now see what changed
1740 * in the tree that's rooted at this device.
1742 static int finish_device_resume(struct usb_device *udev)
1747 /* caller owns the udev device lock */
1748 dev_dbg(&udev->dev, "finish resume\n");
1750 /* usb ch9 identifies four variants of SUSPENDED, based on what
1751 * state the device resumes to. Linux currently won't see the
1752 * first two on the host side; they'd be inside hub_port_init()
1753 * during many timeouts, but khubd can't suspend until later.
1755 usb_set_device_state(udev, udev->actconfig
1756 ? USB_STATE_CONFIGURED
1757 : USB_STATE_ADDRESS);
1758 udev->dev.power.power_state = PMSG_ON;
1760 /* 10.5.4.5 says be sure devices in the tree are still there.
1761 * For now let's assume the device didn't go crazy on resume,
1762 * and device drivers will know about any resume quirks.
1764 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
1767 "gone after usb resume? status %d\n",
1769 else if (udev->actconfig) {
1771 int (*resume)(struct device *);
1773 le16_to_cpus(&devstatus);
1774 if ((devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
1776 status = usb_control_msg(udev,
1777 usb_sndctrlpipe(udev, 0),
1778 USB_REQ_CLEAR_FEATURE,
1780 USB_DEVICE_REMOTE_WAKEUP, 0,
1782 USB_CTRL_SET_TIMEOUT);
1784 dev_dbg(&udev->dev, "disable remote "
1785 "wakeup, status %d\n", status);
1790 /* resume interface drivers; if this is a hub, it
1791 * may have a child resume event to deal with soon
1793 resume = udev->dev.bus->resume;
1794 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
1795 struct device *dev =
1796 &udev->actconfig->interface[i]->dev;
1804 } else if (udev->devnum <= 0) {
1805 dev_dbg(&udev->dev, "bogus resume!\n");
1811 #ifdef CONFIG_USB_SUSPEND
1814 hub_port_resume(struct usb_hub *hub, int port1, struct usb_device *udev)
1818 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
1820 /* see 7.1.7.7; affects power usage, but not budgeting */
1821 status = clear_port_feature(hub->hdev,
1822 port1, USB_PORT_FEAT_SUSPEND);
1824 dev_dbg(hub->intfdev,
1825 "can't resume port %d, status %d\n",
1831 /* drive resume for at least 20 msec */
1833 dev_dbg(&udev->dev, "RESUME\n");
1836 #define LIVE_FLAGS ( USB_PORT_STAT_POWER \
1837 | USB_PORT_STAT_ENABLE \
1838 | USB_PORT_STAT_CONNECTION)
1840 /* Virtual root hubs can trigger on GET_PORT_STATUS to
1841 * stop resume signaling. Then finish the resume
1844 devstatus = portchange = 0;
1845 status = hub_port_status(hub, port1,
1846 &devstatus, &portchange);
1848 || (devstatus & LIVE_FLAGS) != LIVE_FLAGS
1849 || (devstatus & USB_PORT_STAT_SUSPEND) != 0
1851 dev_dbg(hub->intfdev,
1852 "port %d status %04x.%04x after resume, %d\n",
1853 port1, portchange, devstatus, status);
1855 /* TRSMRCY = 10 msec */
1858 status = finish_device_resume(udev);
1862 hub_port_logical_disconnect(hub, port1);
1870 * usb_resume_device - re-activate a suspended usb device
1871 * @udev: device to re-activate
1872 * Context: must be able to sleep; device not locked; pm locks held
1874 * This will re-activate the suspended device, increasing power usage
1875 * while letting drivers communicate again with its endpoints.
1876 * USB resume explicitly guarantees that the power session between
1877 * the host and the device is the same as it was when the device
1880 * Returns 0 on success, else negative errno.
1882 int usb_resume_device(struct usb_device *udev)
1886 if (udev->state == USB_STATE_NOTATTACHED)
1889 /* selective resume of one downstream hub-to-device port */
1891 #ifdef CONFIG_USB_SUSPEND
1892 if (udev->state == USB_STATE_SUSPENDED) {
1893 // NOTE swsusp may bork us, device state being wrong...
1894 // NOTE this fails if parent is also suspended...
1895 status = hub_port_resume(hdev_to_hub(udev->parent),
1896 udev->portnum, udev);
1901 status = finish_device_resume(udev);
1903 dev_dbg(&udev->dev, "can't resume, status %d\n",
1906 /* rebind drivers that had no suspend() */
1908 usb_unlock_device(udev);
1909 bus_rescan_devices(&usb_bus_type);
1910 usb_lock_device(udev);
1915 static int remote_wakeup(struct usb_device *udev)
1919 #ifdef CONFIG_USB_SUSPEND
1921 /* don't repeat RESUME sequence if this device
1922 * was already woken up by some other task
1924 usb_lock_device(udev);
1925 if (udev->state == USB_STATE_SUSPENDED) {
1926 dev_dbg(&udev->dev, "RESUME (wakeup)\n");
1927 /* TRSMRCY = 10 msec */
1929 status = finish_device_resume(udev);
1931 usb_unlock_device(udev);
1936 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
1938 struct usb_hub *hub = usb_get_intfdata (intf);
1939 struct usb_device *hdev = hub->hdev;
1942 /* fail if children aren't already suspended */
1943 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
1944 struct usb_device *udev;
1946 udev = hdev->children [port1-1];
1947 if (udev && (udev->dev.power.power_state.event
1949 #ifdef CONFIG_USB_SUSPEND
1950 || udev->state != USB_STATE_SUSPENDED
1953 dev_dbg(&intf->dev, "port %d nyet suspended\n", port1);
1958 /* "global suspend" of the downstream HC-to-USB interface */
1959 if (!hdev->parent) {
1960 struct usb_bus *bus = hdev->bus;
1962 int status = hcd_bus_suspend (bus);
1965 dev_dbg(&hdev->dev, "'global' suspend %d\n",
1973 /* stop khubd and related activity */
1978 static int hub_resume(struct usb_interface *intf)
1980 struct usb_device *hdev = interface_to_usbdev(intf);
1981 struct usb_hub *hub = usb_get_intfdata (intf);
1984 /* "global resume" of the downstream HC-to-USB interface */
1985 if (!hdev->parent) {
1986 struct usb_bus *bus = hdev->bus;
1988 status = hcd_bus_resume (bus);
1990 dev_dbg(&intf->dev, "'global' resume %d\n",
1997 /* TRSMRCY = 10 msec */
2004 /* REVISIT: this recursion probably shouldn't exist. Remove
2005 * this code sometime, after retesting with different root and
2008 #ifdef CONFIG_USB_SUSPEND
2012 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
2013 struct usb_device *udev;
2014 u16 portstat, portchange;
2016 udev = hdev->children [port1-1];
2017 status = hub_port_status(hub, port1, &portstat, &portchange);
2019 if (portchange & USB_PORT_STAT_C_SUSPEND) {
2020 clear_port_feature(hdev, port1,
2021 USB_PORT_FEAT_C_SUSPEND);
2022 portchange &= ~USB_PORT_STAT_C_SUSPEND;
2025 /* let khubd handle disconnects etc */
2030 if (!udev || status < 0)
2032 usb_lock_device(udev);
2033 if (portstat & USB_PORT_STAT_SUSPEND)
2034 status = hub_port_resume(hub, port1, udev);
2036 status = finish_device_resume(udev);
2038 dev_dbg(&intf->dev, "resume port %d --> %d\n",
2040 hub_port_logical_disconnect(hub, port1);
2043 usb_unlock_device(udev);
2050 void usb_suspend_root_hub(struct usb_device *hdev)
2052 struct usb_hub *hub = hdev_to_hub(hdev);
2054 /* This also makes any led blinker stop retriggering. We're called
2055 * from irq, so the blinker might still be scheduled. Caller promises
2056 * that the root hub status URB will be canceled.
2059 mark_quiesced(to_usb_interface(hub->intfdev));
2062 void usb_resume_root_hub(struct usb_device *hdev)
2064 struct usb_hub *hub = hdev_to_hub(hdev);
2066 hub->resume_root_hub = 1;
2071 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2073 * Between connect detection and reset signaling there must be a delay
2074 * of 100ms at least for debounce and power-settling. The corresponding
2075 * timer shall restart whenever the downstream port detects a disconnect.
2077 * Apparently there are some bluetooth and irda-dongles and a number of
2078 * low-speed devices for which this debounce period may last over a second.
2079 * Not covered by the spec - but easy to deal with.
2081 * This implementation uses a 1500ms total debounce timeout; if the
2082 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2083 * every 25ms for transient disconnects. When the port status has been
2084 * unchanged for 100ms it returns the port status.
2087 #define HUB_DEBOUNCE_TIMEOUT 1500
2088 #define HUB_DEBOUNCE_STEP 25
2089 #define HUB_DEBOUNCE_STABLE 100
2091 static int hub_port_debounce(struct usb_hub *hub, int port1)
2094 int total_time, stable_time = 0;
2095 u16 portchange, portstatus;
2096 unsigned connection = 0xffff;
2098 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2099 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2103 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2104 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2105 stable_time += HUB_DEBOUNCE_STEP;
2106 if (stable_time >= HUB_DEBOUNCE_STABLE)
2110 connection = portstatus & USB_PORT_STAT_CONNECTION;
2113 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2114 clear_port_feature(hub->hdev, port1,
2115 USB_PORT_FEAT_C_CONNECTION);
2118 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2120 msleep(HUB_DEBOUNCE_STEP);
2123 dev_dbg (hub->intfdev,
2124 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2125 port1, total_time, stable_time, portstatus);
2127 if (stable_time < HUB_DEBOUNCE_STABLE)
2132 static void ep0_reinit(struct usb_device *udev)
2134 usb_disable_endpoint(udev, 0 + USB_DIR_IN);
2135 usb_disable_endpoint(udev, 0 + USB_DIR_OUT);
2136 udev->ep_in[0] = udev->ep_out[0] = &udev->ep0;
2139 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2140 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2142 static int hub_set_address(struct usb_device *udev)
2146 if (udev->devnum == 0)
2148 if (udev->state == USB_STATE_ADDRESS)
2150 if (udev->state != USB_STATE_DEFAULT)
2152 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2153 USB_REQ_SET_ADDRESS, 0, udev->devnum, 0,
2154 NULL, 0, USB_CTRL_SET_TIMEOUT);
2156 usb_set_device_state(udev, USB_STATE_ADDRESS);
2162 /* Reset device, (re)assign address, get device descriptor.
2163 * Device connection must be stable, no more debouncing needed.
2164 * Returns device in USB_STATE_ADDRESS, except on error.
2166 * If this is called for an already-existing device (as part of
2167 * usb_reset_device), the caller must own the device lock. For a
2168 * newly detected device that is not accessible through any global
2169 * pointers, it's not necessary to lock the device.
2172 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2175 static DEFINE_MUTEX(usb_address0_mutex);
2177 struct usb_device *hdev = hub->hdev;
2179 unsigned delay = HUB_SHORT_RESET_TIME;
2180 enum usb_device_speed oldspeed = udev->speed;
2182 /* root hub ports have a slightly longer reset period
2183 * (from USB 2.0 spec, section 7.1.7.5)
2185 if (!hdev->parent) {
2186 delay = HUB_ROOT_RESET_TIME;
2187 if (port1 == hdev->bus->otg_port)
2188 hdev->bus->b_hnp_enable = 0;
2191 /* Some low speed devices have problems with the quick delay, so */
2192 /* be a bit pessimistic with those devices. RHbug #23670 */
2193 if (oldspeed == USB_SPEED_LOW)
2194 delay = HUB_LONG_RESET_TIME;
2196 mutex_lock(&usb_address0_mutex);
2198 /* Reset the device; full speed may morph to high speed */
2199 retval = hub_port_reset(hub, port1, udev, delay);
2200 if (retval < 0) /* error or disconnect */
2202 /* success, speed is known */
2205 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2206 dev_dbg(&udev->dev, "device reset changed speed!\n");
2209 oldspeed = udev->speed;
2211 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2212 * it's fixed size except for full speed devices.
2214 switch (udev->speed) {
2215 case USB_SPEED_HIGH: /* fixed at 64 */
2216 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2218 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
2219 /* to determine the ep0 maxpacket size, try to read
2220 * the device descriptor to get bMaxPacketSize0 and
2221 * then correct our initial guess.
2223 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2225 case USB_SPEED_LOW: /* fixed at 8 */
2226 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(8);
2232 dev_info (&udev->dev,
2233 "%s %s speed USB device using %s and address %d\n",
2234 (udev->config) ? "reset" : "new",
2235 ({ char *speed; switch (udev->speed) {
2236 case USB_SPEED_LOW: speed = "low"; break;
2237 case USB_SPEED_FULL: speed = "full"; break;
2238 case USB_SPEED_HIGH: speed = "high"; break;
2239 default: speed = "?"; break;
2241 udev->bus->controller->driver->name,
2244 /* Set up TT records, if needed */
2246 udev->tt = hdev->tt;
2247 udev->ttport = hdev->ttport;
2248 } else if (udev->speed != USB_SPEED_HIGH
2249 && hdev->speed == USB_SPEED_HIGH) {
2250 udev->tt = &hub->tt;
2251 udev->ttport = port1;
2254 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2255 * Because device hardware and firmware is sometimes buggy in
2256 * this area, and this is how Linux has done it for ages.
2257 * Change it cautiously.
2259 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2260 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2261 * so it may help with some non-standards-compliant devices.
2262 * Otherwise we start with SET_ADDRESS and then try to read the
2263 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2266 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
2267 if (USE_NEW_SCHEME(retry_counter)) {
2268 struct usb_device_descriptor *buf;
2271 #define GET_DESCRIPTOR_BUFSIZE 64
2272 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2278 /* Use a short timeout the first time through,
2279 * so that recalcitrant full-speed devices with
2280 * 8- or 16-byte ep0-maxpackets won't slow things
2281 * down tremendously by NAKing the unexpectedly
2282 * early status stage. Also, retry on all errors;
2283 * some devices are flakey.
2285 for (j = 0; j < 3; ++j) {
2286 buf->bMaxPacketSize0 = 0;
2287 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2288 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2289 USB_DT_DEVICE << 8, 0,
2290 buf, GET_DESCRIPTOR_BUFSIZE,
2291 (i ? USB_CTRL_GET_TIMEOUT : 1000));
2292 switch (buf->bMaxPacketSize0) {
2293 case 8: case 16: case 32: case 64:
2294 if (buf->bDescriptorType ==
2308 udev->descriptor.bMaxPacketSize0 =
2309 buf->bMaxPacketSize0;
2312 retval = hub_port_reset(hub, port1, udev, delay);
2313 if (retval < 0) /* error or disconnect */
2315 if (oldspeed != udev->speed) {
2317 "device reset changed speed!\n");
2322 dev_err(&udev->dev, "device descriptor "
2323 "read/%s, error %d\n",
2328 #undef GET_DESCRIPTOR_BUFSIZE
2331 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
2332 retval = hub_set_address(udev);
2339 "device not accepting address %d, error %d\n",
2340 udev->devnum, retval);
2344 /* cope with hardware quirkiness:
2345 * - let SET_ADDRESS settle, some device hardware wants it
2346 * - read ep0 maxpacket even for high and low speed,
2349 if (USE_NEW_SCHEME(retry_counter))
2352 retval = usb_get_device_descriptor(udev, 8);
2354 dev_err(&udev->dev, "device descriptor "
2355 "read/%s, error %d\n",
2367 i = udev->descriptor.bMaxPacketSize0;
2368 if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
2369 if (udev->speed != USB_SPEED_FULL ||
2370 !(i == 8 || i == 16 || i == 32 || i == 64)) {
2371 dev_err(&udev->dev, "ep0 maxpacket = %d\n", i);
2375 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
2376 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
2380 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
2381 if (retval < (signed)sizeof(udev->descriptor)) {
2382 dev_err(&udev->dev, "device descriptor read/%s, error %d\n",
2393 hub_port_disable(hub, port1, 0);
2394 mutex_unlock(&usb_address0_mutex);
2399 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
2401 struct usb_qualifier_descriptor *qual;
2404 qual = kmalloc (sizeof *qual, SLAB_KERNEL);
2408 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
2409 qual, sizeof *qual);
2410 if (status == sizeof *qual) {
2411 dev_info(&udev->dev, "not running at top speed; "
2412 "connect to a high speed hub\n");
2413 /* hub LEDs are probably harder to miss than syslog */
2414 if (hub->has_indicators) {
2415 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
2416 schedule_work (&hub->leds);
2423 hub_power_remaining (struct usb_hub *hub)
2425 struct usb_device *hdev = hub->hdev;
2429 if (!hub->limited_power)
2432 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
2433 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
2434 struct usb_device *udev = hdev->children[port1 - 1];
2440 /* Unconfigured devices may not use more than 100mA,
2441 * or 8mA for OTG ports */
2442 if (udev->actconfig)
2443 delta = udev->actconfig->desc.bMaxPower * 2;
2444 else if (port1 != udev->bus->otg_port || hdev->parent)
2448 if (delta > hub->mA_per_port)
2449 dev_warn(&udev->dev, "%dmA is over %umA budget "
2451 delta, hub->mA_per_port, port1);
2454 if (remaining < 0) {
2455 dev_warn(hub->intfdev, "%dmA over power budget!\n",
2462 /* Handle physical or logical connection change events.
2463 * This routine is called when:
2464 * a port connection-change occurs;
2465 * a port enable-change occurs (often caused by EMI);
2466 * usb_reset_device() encounters changed descriptors (as from
2467 * a firmware download)
2468 * caller already locked the hub
2470 static void hub_port_connect_change(struct usb_hub *hub, int port1,
2471 u16 portstatus, u16 portchange)
2473 struct usb_device *hdev = hub->hdev;
2474 struct device *hub_dev = hub->intfdev;
2475 u16 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2479 "port %d, status %04x, change %04x, %s\n",
2480 port1, portstatus, portchange, portspeed (portstatus));
2482 if (hub->has_indicators) {
2483 set_port_led(hub, port1, HUB_LED_AUTO);
2484 hub->indicator[port1-1] = INDICATOR_AUTO;
2487 /* Disconnect any existing devices under this port */
2488 if (hdev->children[port1-1])
2489 usb_disconnect(&hdev->children[port1-1]);
2490 clear_bit(port1, hub->change_bits);
2492 #ifdef CONFIG_USB_OTG
2493 /* during HNP, don't repeat the debounce */
2494 if (hdev->bus->is_b_host)
2495 portchange &= ~USB_PORT_STAT_C_CONNECTION;
2498 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2499 status = hub_port_debounce(hub, port1);
2502 "connect-debounce failed, port %d disabled\n",
2506 portstatus = status;
2509 /* Return now if nothing is connected */
2510 if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
2512 /* maybe switch power back on (e.g. root hub was reset) */
2513 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
2514 && !(portstatus & (1 << USB_PORT_FEAT_POWER)))
2515 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
2517 if (portstatus & USB_PORT_STAT_ENABLE)
2522 #ifdef CONFIG_USB_SUSPEND
2523 /* If something is connected, but the port is suspended, wake it up. */
2524 if (portstatus & USB_PORT_STAT_SUSPEND) {
2525 status = hub_port_resume(hub, port1, NULL);
2528 "can't clear suspend on port %d; %d\n",
2535 for (i = 0; i < SET_CONFIG_TRIES; i++) {
2536 struct usb_device *udev;
2538 /* reallocate for each attempt, since references
2539 * to the previous one can escape in various ways
2541 udev = usb_alloc_dev(hdev, hdev->bus, port1);
2544 "couldn't allocate port %d usb_device\n",
2549 usb_set_device_state(udev, USB_STATE_POWERED);
2550 udev->speed = USB_SPEED_UNKNOWN;
2551 udev->bus_mA = hub->mA_per_port;
2553 /* set the address */
2554 choose_address(udev);
2555 if (udev->devnum <= 0) {
2556 status = -ENOTCONN; /* Don't retry */
2560 /* reset and get descriptor */
2561 status = hub_port_init(hub, udev, port1, i);
2565 /* consecutive bus-powered hubs aren't reliable; they can
2566 * violate the voltage drop budget. if the new child has
2567 * a "powered" LED, users should notice we didn't enable it
2568 * (without reading syslog), even without per-port LEDs
2571 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
2572 && udev->bus_mA <= 100) {
2575 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
2578 dev_dbg(&udev->dev, "get status %d ?\n", status);
2581 le16_to_cpus(&devstat);
2582 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
2584 "can't connect bus-powered hub "
2586 if (hub->has_indicators) {
2587 hub->indicator[port1-1] =
2588 INDICATOR_AMBER_BLINK;
2589 schedule_work (&hub->leds);
2591 status = -ENOTCONN; /* Don't retry */
2596 /* check for devices running slower than they could */
2597 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
2598 && udev->speed == USB_SPEED_FULL
2599 && highspeed_hubs != 0)
2600 check_highspeed (hub, udev, port1);
2602 /* Store the parent's children[] pointer. At this point
2603 * udev becomes globally accessible, although presumably
2604 * no one will look at it until hdev is unlocked.
2608 /* We mustn't add new devices if the parent hub has
2609 * been disconnected; we would race with the
2610 * recursively_mark_NOTATTACHED() routine.
2612 spin_lock_irq(&device_state_lock);
2613 if (hdev->state == USB_STATE_NOTATTACHED)
2616 hdev->children[port1-1] = udev;
2617 spin_unlock_irq(&device_state_lock);
2619 /* Run it through the hoops (find a driver, etc) */
2621 status = usb_new_device(udev);
2623 spin_lock_irq(&device_state_lock);
2624 hdev->children[port1-1] = NULL;
2625 spin_unlock_irq(&device_state_lock);
2632 status = hub_power_remaining(hub);
2634 dev_dbg(hub_dev, "%dmA power budget left\n", status);
2639 hub_port_disable(hub, port1, 1);
2642 release_address(udev);
2644 if (status == -ENOTCONN)
2649 hub_port_disable(hub, port1, 1);
2652 static void hub_events(void)
2654 struct list_head *tmp;
2655 struct usb_device *hdev;
2656 struct usb_interface *intf;
2657 struct usb_hub *hub;
2658 struct device *hub_dev;
2667 * We restart the list every time to avoid a deadlock with
2668 * deleting hubs downstream from this one. This should be
2669 * safe since we delete the hub from the event list.
2670 * Not the most efficient, but avoids deadlocks.
2674 /* Grab the first entry at the beginning of the list */
2675 spin_lock_irq(&hub_event_lock);
2676 if (list_empty(&hub_event_list)) {
2677 spin_unlock_irq(&hub_event_lock);
2681 tmp = hub_event_list.next;
2684 hub = list_entry(tmp, struct usb_hub, event_list);
2686 intf = to_usb_interface(hub->intfdev);
2687 hub_dev = &intf->dev;
2689 i = hub->resume_root_hub;
2691 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x%s\n",
2692 hdev->state, hub->descriptor
2693 ? hub->descriptor->bNbrPorts
2695 /* NOTE: expects max 15 ports... */
2696 (u16) hub->change_bits[0],
2697 (u16) hub->event_bits[0],
2698 i ? ", resume root" : "");
2701 spin_unlock_irq(&hub_event_lock);
2703 /* Is this is a root hub wanting to reactivate the downstream
2704 * ports? If so, be sure the interface resumes even if its
2705 * stub "device" node was never suspended.
2708 dpm_runtime_resume(&hdev->dev);
2709 dpm_runtime_resume(&intf->dev);
2714 /* Lock the device, then check to see if we were
2715 * disconnected while waiting for the lock to succeed. */
2716 if (locktree(hdev) < 0) {
2720 if (hub != usb_get_intfdata(intf))
2723 /* If the hub has died, clean up after it */
2724 if (hdev->state == USB_STATE_NOTATTACHED) {
2725 hub_pre_reset(hub, 0);
2729 /* If this is an inactive or suspended hub, do nothing */
2734 dev_dbg (hub_dev, "resetting for error %d\n",
2737 ret = usb_reset_device(hdev);
2740 "error resetting hub: %d\n", ret);
2748 /* deal with port status changes */
2749 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
2750 if (test_bit(i, hub->busy_bits))
2752 connect_change = test_bit(i, hub->change_bits);
2753 if (!test_and_clear_bit(i, hub->event_bits) &&
2754 !connect_change && !hub->activating)
2757 ret = hub_port_status(hub, i,
2758 &portstatus, &portchange);
2762 if (hub->activating && !hdev->children[i-1] &&
2764 USB_PORT_STAT_CONNECTION))
2767 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2768 clear_port_feature(hdev, i,
2769 USB_PORT_FEAT_C_CONNECTION);
2773 if (portchange & USB_PORT_STAT_C_ENABLE) {
2774 if (!connect_change)
2776 "port %d enable change, "
2779 clear_port_feature(hdev, i,
2780 USB_PORT_FEAT_C_ENABLE);
2783 * EM interference sometimes causes badly
2784 * shielded USB devices to be shutdown by
2785 * the hub, this hack enables them again.
2786 * Works at least with mouse driver.
2788 if (!(portstatus & USB_PORT_STAT_ENABLE)
2790 && hdev->children[i-1]) {
2793 "disabled by hub (EMI?), "
2800 if (portchange & USB_PORT_STAT_C_SUSPEND) {
2801 clear_port_feature(hdev, i,
2802 USB_PORT_FEAT_C_SUSPEND);
2803 if (hdev->children[i-1]) {
2804 ret = remote_wakeup(hdev->
2810 hub_port_disable(hub, i, 1);
2813 "resume on port %d, status %d\n",
2817 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
2819 "over-current change on port %d\n",
2821 clear_port_feature(hdev, i,
2822 USB_PORT_FEAT_C_OVER_CURRENT);
2826 if (portchange & USB_PORT_STAT_C_RESET) {
2828 "reset change on port %d\n",
2830 clear_port_feature(hdev, i,
2831 USB_PORT_FEAT_C_RESET);
2835 hub_port_connect_change(hub, i,
2836 portstatus, portchange);
2839 /* deal with hub status changes */
2840 if (test_and_clear_bit(0, hub->event_bits) == 0)
2842 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
2843 dev_err (hub_dev, "get_hub_status failed\n");
2845 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
2846 dev_dbg (hub_dev, "power change\n");
2847 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
2848 if (hubstatus & HUB_STATUS_LOCAL_POWER)
2849 /* FIXME: Is this always true? */
2850 hub->limited_power = 0;
2852 hub->limited_power = 1;
2854 if (hubchange & HUB_CHANGE_OVERCURRENT) {
2855 dev_dbg (hub_dev, "overcurrent change\n");
2856 msleep(500); /* Cool down */
2857 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
2862 hub->activating = 0;
2864 /* If this is a root hub, tell the HCD it's okay to
2865 * re-enable port-change interrupts now. */
2867 usb_enable_root_hub_irq(hdev->bus);
2870 usb_unlock_device(hdev);
2873 } /* end while (1) */
2876 static int hub_thread(void *__unused)
2880 wait_event_interruptible(khubd_wait,
2881 !list_empty(&hub_event_list) ||
2882 kthread_should_stop());
2884 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
2886 pr_debug("%s: khubd exiting\n", usbcore_name);
2890 static struct usb_device_id hub_id_table [] = {
2891 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
2892 .bDeviceClass = USB_CLASS_HUB},
2893 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
2894 .bInterfaceClass = USB_CLASS_HUB},
2895 { } /* Terminating entry */
2898 MODULE_DEVICE_TABLE (usb, hub_id_table);
2900 static struct usb_driver hub_driver = {
2903 .disconnect = hub_disconnect,
2904 .suspend = hub_suspend,
2905 .resume = hub_resume,
2907 .id_table = hub_id_table,
2910 int usb_hub_init(void)
2912 if (usb_register(&hub_driver) < 0) {
2913 printk(KERN_ERR "%s: can't register hub driver\n",
2918 khubd_task = kthread_run(hub_thread, NULL, "khubd");
2919 if (!IS_ERR(khubd_task))
2922 /* Fall through if kernel_thread failed */
2923 usb_deregister(&hub_driver);
2924 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
2929 void usb_hub_cleanup(void)
2931 kthread_stop(khubd_task);
2934 * Hub resources are freed for us by usb_deregister. It calls
2935 * usb_driver_purge on every device which in turn calls that
2936 * devices disconnect function if it is using this driver.
2937 * The hub_disconnect function takes care of releasing the
2938 * individual hub resources. -greg
2940 usb_deregister(&hub_driver);
2941 } /* usb_hub_cleanup() */
2943 static int config_descriptors_changed(struct usb_device *udev)
2947 struct usb_config_descriptor *buf;
2949 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2950 if (len < le16_to_cpu(udev->config[index].desc.wTotalLength))
2951 len = le16_to_cpu(udev->config[index].desc.wTotalLength);
2953 buf = kmalloc (len, SLAB_KERNEL);
2955 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
2956 /* assume the worst */
2959 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2961 int old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
2963 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
2965 if (length < old_length) {
2966 dev_dbg(&udev->dev, "config index %d, error %d\n",
2970 if (memcmp (buf, udev->rawdescriptors[index], old_length)
2972 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
2973 index, buf->bConfigurationValue);
2978 return index != udev->descriptor.bNumConfigurations;
2982 * usb_reset_device - perform a USB port reset to reinitialize a device
2983 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
2985 * WARNING - don't reset any device unless drivers for all of its
2986 * interfaces are expecting that reset! Maybe some driver->reset()
2987 * method should eventually help ensure sufficient cooperation.
2989 * Do a port reset, reassign the device's address, and establish its
2990 * former operating configuration. If the reset fails, or the device's
2991 * descriptors change from their values before the reset, or the original
2992 * configuration and altsettings cannot be restored, a flag will be set
2993 * telling khubd to pretend the device has been disconnected and then
2994 * re-connected. All drivers will be unbound, and the device will be
2995 * re-enumerated and probed all over again.
2997 * Returns 0 if the reset succeeded, -ENODEV if the device has been
2998 * flagged for logical disconnection, or some other negative error code
2999 * if the reset wasn't even attempted.
3001 * The caller must own the device lock. For example, it's safe to use
3002 * this from a driver probe() routine after downloading new firmware.
3003 * For calls that might not occur during probe(), drivers should lock
3004 * the device using usb_lock_device_for_reset().
3006 int usb_reset_device(struct usb_device *udev)
3008 struct usb_device *parent_hdev = udev->parent;
3009 struct usb_hub *parent_hub;
3010 struct usb_device_descriptor descriptor = udev->descriptor;
3011 struct usb_hub *hub = NULL;
3013 int port1 = udev->portnum;
3015 if (udev->state == USB_STATE_NOTATTACHED ||
3016 udev->state == USB_STATE_SUSPENDED) {
3017 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3023 /* this requires hcd-specific logic; see OHCI hc_restart() */
3024 dev_dbg(&udev->dev, "%s for root hub!\n", __FUNCTION__);
3027 parent_hub = hdev_to_hub(parent_hdev);
3029 /* If we're resetting an active hub, take some special actions */
3030 if (udev->actconfig && udev->actconfig->desc.bNumInterfaces > 0 &&
3031 udev->actconfig->interface[0]->dev.driver ==
3032 &hub_driver.driver &&
3033 (hub = hdev_to_hub(udev)) != NULL) {
3034 hub_pre_reset(hub, 0);
3037 set_bit(port1, parent_hub->busy_bits);
3038 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
3040 /* ep0 maxpacket size may change; let the HCD know about it.
3041 * Other endpoints will be handled by re-enumeration. */
3043 ret = hub_port_init(parent_hub, udev, port1, i);
3047 clear_bit(port1, parent_hub->busy_bits);
3051 /* Device might have changed firmware (DFU or similar) */
3052 if (memcmp(&udev->descriptor, &descriptor, sizeof descriptor)
3053 || config_descriptors_changed (udev)) {
3054 dev_info(&udev->dev, "device firmware changed\n");
3055 udev->descriptor = descriptor; /* for disconnect() calls */
3059 if (!udev->actconfig)
3062 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3063 USB_REQ_SET_CONFIGURATION, 0,
3064 udev->actconfig->desc.bConfigurationValue, 0,
3065 NULL, 0, USB_CTRL_SET_TIMEOUT);
3068 "can't restore configuration #%d (error=%d)\n",
3069 udev->actconfig->desc.bConfigurationValue, ret);
3072 usb_set_device_state(udev, USB_STATE_CONFIGURED);
3074 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
3075 struct usb_interface *intf = udev->actconfig->interface[i];
3076 struct usb_interface_descriptor *desc;
3078 /* set_interface resets host side toggle even
3079 * for altsetting zero. the interface may have no driver.
3081 desc = &intf->cur_altsetting->desc;
3082 ret = usb_set_interface(udev, desc->bInterfaceNumber,
3083 desc->bAlternateSetting);
3085 dev_err(&udev->dev, "failed to restore interface %d "
3086 "altsetting %d (error=%d)\n",
3087 desc->bInterfaceNumber,
3088 desc->bAlternateSetting,
3096 hub_post_reset(hub);
3100 hub_port_logical_disconnect(parent_hub, port1);