4 * (C) Copyright 1999 Linus Torvalds
5 * (C) Copyright 1999 Johannes Erdfelt
6 * (C) Copyright 1999 Gregory P. Smith
7 * (C) Copyright 2001 Brad Hards (bhards@bigpond.net.au)
11 #include <linux/kernel.h>
12 #include <linux/errno.h>
13 #include <linux/module.h>
14 #include <linux/moduleparam.h>
15 #include <linux/completion.h>
16 #include <linux/sched.h>
17 #include <linux/list.h>
18 #include <linux/slab.h>
19 #include <linux/smp_lock.h>
20 #include <linux/ioctl.h>
21 #include <linux/usb.h>
22 #include <linux/usbdevice_fs.h>
23 #include <linux/kthread.h>
24 #include <linux/mutex.h>
26 #include <asm/semaphore.h>
27 #include <asm/uaccess.h>
28 #include <asm/byteorder.h>
34 /* Protect struct usb_device->state and ->children members
35 * Note: Both are also protected by ->dev.sem, except that ->state can
36 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
37 static DEFINE_SPINLOCK(device_state_lock);
39 /* khubd's worklist and its lock */
40 static DEFINE_SPINLOCK(hub_event_lock);
41 static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
44 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
46 static struct task_struct *khubd_task;
48 /* cycle leds on hubs that aren't blinking for attention */
49 static int blinkenlights = 0;
50 module_param (blinkenlights, bool, S_IRUGO);
51 MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
54 * As of 2.6.10 we introduce a new USB device initialization scheme which
55 * closely resembles the way Windows works. Hopefully it will be compatible
56 * with a wider range of devices than the old scheme. However some previously
57 * working devices may start giving rise to "device not accepting address"
58 * errors; if that happens the user can try the old scheme by adjusting the
59 * following module parameters.
61 * For maximum flexibility there are two boolean parameters to control the
62 * hub driver's behavior. On the first initialization attempt, if the
63 * "old_scheme_first" parameter is set then the old scheme will be used,
64 * otherwise the new scheme is used. If that fails and "use_both_schemes"
65 * is set, then the driver will make another attempt, using the other scheme.
67 static int old_scheme_first = 0;
68 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
69 MODULE_PARM_DESC(old_scheme_first,
70 "start with the old device initialization scheme");
72 static int use_both_schemes = 1;
73 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
74 MODULE_PARM_DESC(use_both_schemes,
75 "try the other device initialization scheme if the "
80 static inline char *portspeed (int portstatus)
82 if (portstatus & (1 << USB_PORT_FEAT_HIGHSPEED))
84 else if (portstatus & (1 << USB_PORT_FEAT_LOWSPEED))
91 /* Note that hdev or one of its children must be locked! */
92 static inline struct usb_hub *hdev_to_hub(struct usb_device *hdev)
94 return usb_get_intfdata(hdev->actconfig->interface[0]);
97 /* USB 2.0 spec Section 11.24.4.5 */
98 static int get_hub_descriptor(struct usb_device *hdev, void *data, int size)
102 for (i = 0; i < 3; i++) {
103 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
104 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
105 USB_DT_HUB << 8, 0, data, size,
106 USB_CTRL_GET_TIMEOUT);
107 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
114 * USB 2.0 spec Section 11.24.2.1
116 static int clear_hub_feature(struct usb_device *hdev, int feature)
118 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
119 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
123 * USB 2.0 spec Section 11.24.2.2
125 static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
127 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
128 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
133 * USB 2.0 spec Section 11.24.2.13
135 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
137 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
138 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
143 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
144 * for info about using port indicators
146 static void set_port_led(
152 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
153 USB_PORT_FEAT_INDICATOR);
155 dev_dbg (hub->intfdev,
156 "port %d indicator %s status %d\n",
158 ({ char *s; switch (selector) {
159 case HUB_LED_AMBER: s = "amber"; break;
160 case HUB_LED_GREEN: s = "green"; break;
161 case HUB_LED_OFF: s = "off"; break;
162 case HUB_LED_AUTO: s = "auto"; break;
163 default: s = "??"; break;
168 #define LED_CYCLE_PERIOD ((2*HZ)/3)
170 static void led_work (void *__hub)
172 struct usb_hub *hub = __hub;
173 struct usb_device *hdev = hub->hdev;
175 unsigned changed = 0;
178 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
181 for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
182 unsigned selector, mode;
184 /* 30%-50% duty cycle */
186 switch (hub->indicator[i]) {
188 case INDICATOR_CYCLE:
190 selector = HUB_LED_AUTO;
191 mode = INDICATOR_AUTO;
193 /* blinking green = sw attention */
194 case INDICATOR_GREEN_BLINK:
195 selector = HUB_LED_GREEN;
196 mode = INDICATOR_GREEN_BLINK_OFF;
198 case INDICATOR_GREEN_BLINK_OFF:
199 selector = HUB_LED_OFF;
200 mode = INDICATOR_GREEN_BLINK;
202 /* blinking amber = hw attention */
203 case INDICATOR_AMBER_BLINK:
204 selector = HUB_LED_AMBER;
205 mode = INDICATOR_AMBER_BLINK_OFF;
207 case INDICATOR_AMBER_BLINK_OFF:
208 selector = HUB_LED_OFF;
209 mode = INDICATOR_AMBER_BLINK;
211 /* blink green/amber = reserved */
212 case INDICATOR_ALT_BLINK:
213 selector = HUB_LED_GREEN;
214 mode = INDICATOR_ALT_BLINK_OFF;
216 case INDICATOR_ALT_BLINK_OFF:
217 selector = HUB_LED_AMBER;
218 mode = INDICATOR_ALT_BLINK;
223 if (selector != HUB_LED_AUTO)
225 set_port_led(hub, i + 1, selector);
226 hub->indicator[i] = mode;
228 if (!changed && blinkenlights) {
230 cursor %= hub->descriptor->bNbrPorts;
231 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
232 hub->indicator[cursor] = INDICATOR_CYCLE;
236 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
239 /* use a short timeout for hub/port status fetches */
240 #define USB_STS_TIMEOUT 1000
241 #define USB_STS_RETRIES 5
244 * USB 2.0 spec Section 11.24.2.6
246 static int get_hub_status(struct usb_device *hdev,
247 struct usb_hub_status *data)
249 int i, status = -ETIMEDOUT;
251 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
252 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
253 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
254 data, sizeof(*data), USB_STS_TIMEOUT);
260 * USB 2.0 spec Section 11.24.2.7
262 static int get_port_status(struct usb_device *hdev, int port1,
263 struct usb_port_status *data)
265 int i, status = -ETIMEDOUT;
267 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
268 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
269 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
270 data, sizeof(*data), USB_STS_TIMEOUT);
275 static void kick_khubd(struct usb_hub *hub)
279 spin_lock_irqsave(&hub_event_lock, flags);
280 if (list_empty(&hub->event_list)) {
281 list_add_tail(&hub->event_list, &hub_event_list);
282 wake_up(&khubd_wait);
284 spin_unlock_irqrestore(&hub_event_lock, flags);
287 void usb_kick_khubd(struct usb_device *hdev)
289 kick_khubd(hdev_to_hub(hdev));
293 /* completion function, fires on port status changes and various faults */
294 static void hub_irq(struct urb *urb, struct pt_regs *regs)
296 struct usb_hub *hub = (struct usb_hub *)urb->context;
301 switch (urb->status) {
302 case -ENOENT: /* synchronous unlink */
303 case -ECONNRESET: /* async unlink */
304 case -ESHUTDOWN: /* hardware going away */
307 default: /* presumably an error */
308 /* Cause a hub reset after 10 consecutive errors */
309 dev_dbg (hub->intfdev, "transfer --> %d\n", urb->status);
310 if ((++hub->nerrors < 10) || hub->error)
312 hub->error = urb->status;
315 /* let khubd handle things */
316 case 0: /* we got data: port status changed */
318 for (i = 0; i < urb->actual_length; ++i)
319 bits |= ((unsigned long) ((*hub->buffer)[i]))
321 hub->event_bits[0] = bits;
327 /* Something happened, let khubd figure it out */
334 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
335 && status != -ENODEV && status != -EPERM)
336 dev_err (hub->intfdev, "resubmit --> %d\n", status);
339 /* USB 2.0 spec Section 11.24.2.3 */
341 hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
343 return usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
344 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
349 * enumeration blocks khubd for a long time. we use keventd instead, since
350 * long blocking there is the exception, not the rule. accordingly, HCDs
351 * talking to TTs must queue control transfers (not just bulk and iso), so
352 * both can talk to the same hub concurrently.
354 static void hub_tt_kevent (void *arg)
356 struct usb_hub *hub = arg;
359 spin_lock_irqsave (&hub->tt.lock, flags);
360 while (!list_empty (&hub->tt.clear_list)) {
361 struct list_head *temp;
362 struct usb_tt_clear *clear;
363 struct usb_device *hdev = hub->hdev;
366 temp = hub->tt.clear_list.next;
367 clear = list_entry (temp, struct usb_tt_clear, clear_list);
368 list_del (&clear->clear_list);
370 /* drop lock so HCD can concurrently report other TT errors */
371 spin_unlock_irqrestore (&hub->tt.lock, flags);
372 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
373 spin_lock_irqsave (&hub->tt.lock, flags);
377 "clear tt %d (%04x) error %d\n",
378 clear->tt, clear->devinfo, status);
381 spin_unlock_irqrestore (&hub->tt.lock, flags);
385 * usb_hub_tt_clear_buffer - clear control/bulk TT state in high speed hub
386 * @udev: the device whose split transaction failed
387 * @pipe: identifies the endpoint of the failed transaction
389 * High speed HCDs use this to tell the hub driver that some split control or
390 * bulk transaction failed in a way that requires clearing internal state of
391 * a transaction translator. This is normally detected (and reported) from
394 * It may not be possible for that hub to handle additional full (or low)
395 * speed transactions until that state is fully cleared out.
397 void usb_hub_tt_clear_buffer (struct usb_device *udev, int pipe)
399 struct usb_tt *tt = udev->tt;
401 struct usb_tt_clear *clear;
403 /* we've got to cope with an arbitrary number of pending TT clears,
404 * since each TT has "at least two" buffers that can need it (and
405 * there can be many TTs per hub). even if they're uncommon.
407 if ((clear = kmalloc (sizeof *clear, SLAB_ATOMIC)) == NULL) {
408 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
409 /* FIXME recover somehow ... RESET_TT? */
413 /* info that CLEAR_TT_BUFFER needs */
414 clear->tt = tt->multi ? udev->ttport : 1;
415 clear->devinfo = usb_pipeendpoint (pipe);
416 clear->devinfo |= udev->devnum << 4;
417 clear->devinfo |= usb_pipecontrol (pipe)
418 ? (USB_ENDPOINT_XFER_CONTROL << 11)
419 : (USB_ENDPOINT_XFER_BULK << 11);
420 if (usb_pipein (pipe))
421 clear->devinfo |= 1 << 15;
423 /* tell keventd to clear state for this TT */
424 spin_lock_irqsave (&tt->lock, flags);
425 list_add_tail (&clear->clear_list, &tt->clear_list);
426 schedule_work (&tt->kevent);
427 spin_unlock_irqrestore (&tt->lock, flags);
430 static void hub_power_on(struct usb_hub *hub)
433 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
434 u16 wHubCharacteristics =
435 le16_to_cpu(hub->descriptor->wHubCharacteristics);
437 /* Enable power on each port. Some hubs have reserved values
438 * of LPSM (> 2) in their descriptors, even though they are
439 * USB 2.0 hubs. Some hubs do not implement port-power switching
440 * but only emulate it. In all cases, the ports won't work
441 * unless we send these messages to the hub.
443 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
444 dev_dbg(hub->intfdev, "enabling power on all ports\n");
446 dev_dbg(hub->intfdev, "trying to enable port power on "
447 "non-switchable hub\n");
448 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
449 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
451 /* Wait at least 100 msec for power to become stable */
452 msleep(max(pgood_delay, (unsigned) 100));
455 static inline void __hub_quiesce(struct usb_hub *hub)
457 /* (nonblocking) khubd and related activity won't re-trigger */
460 hub->resume_root_hub = 0;
463 static void hub_quiesce(struct usb_hub *hub)
465 /* (blocking) stop khubd and related activity */
467 usb_kill_urb(hub->urb);
468 if (hub->has_indicators)
469 cancel_delayed_work(&hub->leds);
470 if (hub->has_indicators || hub->tt.hub)
471 flush_scheduled_work();
474 static void hub_activate(struct usb_hub *hub)
480 hub->resume_root_hub = 0;
481 status = usb_submit_urb(hub->urb, GFP_NOIO);
483 dev_err(hub->intfdev, "activate --> %d\n", status);
484 if (hub->has_indicators && blinkenlights)
485 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
487 /* scan all ports ASAP */
491 static int hub_hub_status(struct usb_hub *hub,
492 u16 *status, u16 *change)
496 ret = get_hub_status(hub->hdev, &hub->status->hub);
498 dev_err (hub->intfdev,
499 "%s failed (err = %d)\n", __FUNCTION__, ret);
501 *status = le16_to_cpu(hub->status->hub.wHubStatus);
502 *change = le16_to_cpu(hub->status->hub.wHubChange);
508 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
510 struct usb_device *hdev = hub->hdev;
513 if (hdev->children[port1-1] && set_state) {
514 usb_set_device_state(hdev->children[port1-1],
515 USB_STATE_NOTATTACHED);
517 ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
519 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
526 /* caller has locked the hub device */
527 static void hub_pre_reset(struct usb_interface *intf)
529 struct usb_hub *hub = usb_get_intfdata(intf);
530 struct usb_device *hdev = hub->hdev;
533 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
534 if (hdev->children[port1 - 1]) {
535 usb_disconnect(&hdev->children[port1 - 1]);
537 hub_port_disable(hub, port1, 0);
543 /* caller has locked the hub device */
544 static void hub_post_reset(struct usb_interface *intf)
546 struct usb_hub *hub = usb_get_intfdata(intf);
553 static int hub_configure(struct usb_hub *hub,
554 struct usb_endpoint_descriptor *endpoint)
556 struct usb_device *hdev = hub->hdev;
557 struct device *hub_dev = hub->intfdev;
558 u16 hubstatus, hubchange;
559 u16 wHubCharacteristics;
564 hub->buffer = usb_buffer_alloc(hdev, sizeof(*hub->buffer), GFP_KERNEL,
567 message = "can't allocate hub irq buffer";
572 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
574 message = "can't kmalloc hub status buffer";
579 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
580 if (!hub->descriptor) {
581 message = "can't kmalloc hub descriptor";
586 /* Request the entire hub descriptor.
587 * hub->descriptor can handle USB_MAXCHILDREN ports,
588 * but the hub can/will return fewer bytes here.
590 ret = get_hub_descriptor(hdev, hub->descriptor,
591 sizeof(*hub->descriptor));
593 message = "can't read hub descriptor";
595 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
596 message = "hub has too many ports!";
601 hdev->maxchild = hub->descriptor->bNbrPorts;
602 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
603 (hdev->maxchild == 1) ? "" : "s");
605 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
607 if (wHubCharacteristics & HUB_CHAR_COMPOUND) {
609 char portstr [USB_MAXCHILDREN + 1];
611 for (i = 0; i < hdev->maxchild; i++)
612 portstr[i] = hub->descriptor->DeviceRemovable
613 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
615 portstr[hdev->maxchild] = 0;
616 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
618 dev_dbg(hub_dev, "standalone hub\n");
620 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
622 dev_dbg(hub_dev, "ganged power switching\n");
625 dev_dbg(hub_dev, "individual port power switching\n");
629 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
633 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
635 dev_dbg(hub_dev, "global over-current protection\n");
638 dev_dbg(hub_dev, "individual port over-current protection\n");
642 dev_dbg(hub_dev, "no over-current protection\n");
646 spin_lock_init (&hub->tt.lock);
647 INIT_LIST_HEAD (&hub->tt.clear_list);
648 INIT_WORK (&hub->tt.kevent, hub_tt_kevent, hub);
649 switch (hdev->descriptor.bDeviceProtocol) {
653 dev_dbg(hub_dev, "Single TT\n");
657 ret = usb_set_interface(hdev, 0, 1);
659 dev_dbg(hub_dev, "TT per port\n");
662 dev_err(hub_dev, "Using single TT (err %d)\n",
667 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
668 hdev->descriptor.bDeviceProtocol);
672 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
673 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
674 case HUB_TTTT_8_BITS:
675 if (hdev->descriptor.bDeviceProtocol != 0) {
676 hub->tt.think_time = 666;
677 dev_dbg(hub_dev, "TT requires at most %d "
678 "FS bit times (%d ns)\n",
679 8, hub->tt.think_time);
682 case HUB_TTTT_16_BITS:
683 hub->tt.think_time = 666 * 2;
684 dev_dbg(hub_dev, "TT requires at most %d "
685 "FS bit times (%d ns)\n",
686 16, hub->tt.think_time);
688 case HUB_TTTT_24_BITS:
689 hub->tt.think_time = 666 * 3;
690 dev_dbg(hub_dev, "TT requires at most %d "
691 "FS bit times (%d ns)\n",
692 24, hub->tt.think_time);
694 case HUB_TTTT_32_BITS:
695 hub->tt.think_time = 666 * 4;
696 dev_dbg(hub_dev, "TT requires at most %d "
697 "FS bit times (%d ns)\n",
698 32, hub->tt.think_time);
702 /* probe() zeroes hub->indicator[] */
703 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
704 hub->has_indicators = 1;
705 dev_dbg(hub_dev, "Port indicators are supported\n");
708 dev_dbg(hub_dev, "power on to power good time: %dms\n",
709 hub->descriptor->bPwrOn2PwrGood * 2);
711 /* power budgeting mostly matters with bus-powered hubs,
712 * and battery-powered root hubs (may provide just 8 mA).
714 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
716 message = "can't get hub status";
719 le16_to_cpus(&hubstatus);
720 if (hdev == hdev->bus->root_hub) {
721 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
722 hub->mA_per_port = 500;
724 hub->mA_per_port = hdev->bus_mA;
725 hub->limited_power = 1;
727 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
728 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
729 hub->descriptor->bHubContrCurrent);
730 hub->limited_power = 1;
731 if (hdev->maxchild > 0) {
732 int remaining = hdev->bus_mA -
733 hub->descriptor->bHubContrCurrent;
735 if (remaining < hdev->maxchild * 100)
737 "insufficient power available "
738 "to use all downstream ports\n");
739 hub->mA_per_port = 100; /* 7.2.1.1 */
741 } else { /* Self-powered external hub */
742 /* FIXME: What about battery-powered external hubs that
743 * provide less current per port? */
744 hub->mA_per_port = 500;
746 if (hub->mA_per_port < 500)
747 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
750 ret = hub_hub_status(hub, &hubstatus, &hubchange);
752 message = "can't get hub status";
756 /* local power status reports aren't always correct */
757 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
758 dev_dbg(hub_dev, "local power source is %s\n",
759 (hubstatus & HUB_STATUS_LOCAL_POWER)
760 ? "lost (inactive)" : "good");
762 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
763 dev_dbg(hub_dev, "%sover-current condition exists\n",
764 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
766 /* set up the interrupt endpoint */
767 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
768 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
770 if (maxp > sizeof(*hub->buffer))
771 maxp = sizeof(*hub->buffer);
773 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
775 message = "couldn't allocate interrupt urb";
780 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
781 hub, endpoint->bInterval);
782 hub->urb->transfer_dma = hub->buffer_dma;
783 hub->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
785 /* maybe cycle the hub leds */
786 if (hub->has_indicators && blinkenlights)
787 hub->indicator [0] = INDICATOR_CYCLE;
794 dev_err (hub_dev, "config failed, %s (err %d)\n",
796 /* hub_disconnect() frees urb and descriptor */
800 static unsigned highspeed_hubs;
802 static void hub_disconnect(struct usb_interface *intf)
804 struct usb_hub *hub = usb_get_intfdata (intf);
805 struct usb_device *hdev;
807 /* Disconnect all children and quiesce the hub */
811 usb_set_intfdata (intf, NULL);
814 if (hdev->speed == USB_SPEED_HIGH)
817 usb_free_urb(hub->urb);
820 spin_lock_irq(&hub_event_lock);
821 list_del_init(&hub->event_list);
822 spin_unlock_irq(&hub_event_lock);
824 kfree(hub->descriptor);
825 hub->descriptor = NULL;
831 usb_buffer_free(hdev, sizeof(*hub->buffer), hub->buffer,
839 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
841 struct usb_host_interface *desc;
842 struct usb_endpoint_descriptor *endpoint;
843 struct usb_device *hdev;
846 desc = intf->cur_altsetting;
847 hdev = interface_to_usbdev(intf);
849 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
851 dev_warn(&intf->dev, "ignoring external hub\n");
856 /* Some hubs have a subclass of 1, which AFAICT according to the */
857 /* specs is not defined, but it works */
858 if ((desc->desc.bInterfaceSubClass != 0) &&
859 (desc->desc.bInterfaceSubClass != 1)) {
861 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
865 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
866 if (desc->desc.bNumEndpoints != 1)
867 goto descriptor_error;
869 endpoint = &desc->endpoint[0].desc;
871 /* If it's not an interrupt in endpoint, we'd better punt! */
872 if (!usb_endpoint_is_int_in(endpoint))
873 goto descriptor_error;
876 dev_info (&intf->dev, "USB hub found\n");
878 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
880 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
884 INIT_LIST_HEAD(&hub->event_list);
885 hub->intfdev = &intf->dev;
887 INIT_WORK(&hub->leds, led_work, hub);
889 usb_set_intfdata (intf, hub);
891 if (hdev->speed == USB_SPEED_HIGH)
894 if (hub_configure(hub, endpoint) >= 0)
897 hub_disconnect (intf);
902 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
904 struct usb_device *hdev = interface_to_usbdev (intf);
906 /* assert ifno == 0 (part of hub spec) */
908 case USBDEVFS_HUB_PORTINFO: {
909 struct usbdevfs_hub_portinfo *info = user_data;
912 spin_lock_irq(&device_state_lock);
913 if (hdev->devnum <= 0)
916 info->nports = hdev->maxchild;
917 for (i = 0; i < info->nports; i++) {
918 if (hdev->children[i] == NULL)
922 hdev->children[i]->devnum;
925 spin_unlock_irq(&device_state_lock);
927 return info->nports + 1;
936 /* grab device/port lock, returning index of that port (zero based).
937 * protects the upstream link used by this device from concurrent
938 * tree operations like suspend, resume, reset, and disconnect, which
939 * apply to everything downstream of a given port.
941 static int locktree(struct usb_device *udev)
944 struct usb_device *hdev;
949 /* root hub is always the first lock in the series */
952 usb_lock_device(udev);
956 /* on the path from root to us, lock everything from
957 * top down, dropping parent locks when not needed
963 /* everything is fail-fast once disconnect
966 if (udev->state == USB_STATE_NOTATTACHED) {
967 usb_unlock_device(hdev);
971 /* when everyone grabs locks top->bottom,
972 * non-overlapping work may be concurrent
974 usb_lock_device(udev);
975 usb_unlock_device(hdev);
976 return udev->portnum;
979 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
983 for (i = 0; i < udev->maxchild; ++i) {
984 if (udev->children[i])
985 recursively_mark_NOTATTACHED(udev->children[i]);
987 udev->state = USB_STATE_NOTATTACHED;
991 * usb_set_device_state - change a device's current state (usbcore, hcds)
992 * @udev: pointer to device whose state should be changed
993 * @new_state: new state value to be stored
995 * udev->state is _not_ fully protected by the device lock. Although
996 * most transitions are made only while holding the lock, the state can
997 * can change to USB_STATE_NOTATTACHED at almost any time. This
998 * is so that devices can be marked as disconnected as soon as possible,
999 * without having to wait for any semaphores to be released. As a result,
1000 * all changes to any device's state must be protected by the
1001 * device_state_lock spinlock.
1003 * Once a device has been added to the device tree, all changes to its state
1004 * should be made using this routine. The state should _not_ be set directly.
1006 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1007 * Otherwise udev->state is set to new_state, and if new_state is
1008 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1009 * to USB_STATE_NOTATTACHED.
1011 void usb_set_device_state(struct usb_device *udev,
1012 enum usb_device_state new_state)
1014 unsigned long flags;
1016 spin_lock_irqsave(&device_state_lock, flags);
1017 if (udev->state == USB_STATE_NOTATTACHED)
1019 else if (new_state != USB_STATE_NOTATTACHED) {
1020 udev->state = new_state;
1022 /* root hub wakeup capabilities are managed out-of-band
1023 * and may involve silicon errata ... ignore them here.
1026 if (new_state == USB_STATE_CONFIGURED)
1027 device_init_wakeup(&udev->dev,
1028 (udev->actconfig->desc.bmAttributes
1029 & USB_CONFIG_ATT_WAKEUP));
1030 else if (new_state != USB_STATE_SUSPENDED)
1031 device_init_wakeup(&udev->dev, 0);
1034 recursively_mark_NOTATTACHED(udev);
1035 spin_unlock_irqrestore(&device_state_lock, flags);
1042 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
1043 * @rhdev: struct usb_device for the root hub
1045 * The USB host controller driver calls this function when its root hub
1046 * is resumed and Vbus power has been interrupted or the controller
1047 * has been reset. The routine marks all the children of the root hub
1048 * as NOTATTACHED and marks logical connect-change events on their ports.
1050 void usb_root_hub_lost_power(struct usb_device *rhdev)
1052 struct usb_hub *hub;
1054 unsigned long flags;
1056 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
1057 spin_lock_irqsave(&device_state_lock, flags);
1058 hub = hdev_to_hub(rhdev);
1059 for (port1 = 1; port1 <= rhdev->maxchild; ++port1) {
1060 if (rhdev->children[port1 - 1]) {
1061 recursively_mark_NOTATTACHED(
1062 rhdev->children[port1 - 1]);
1063 set_bit(port1, hub->change_bits);
1066 spin_unlock_irqrestore(&device_state_lock, flags);
1068 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
1070 #endif /* CONFIG_PM */
1072 static void choose_address(struct usb_device *udev)
1075 struct usb_bus *bus = udev->bus;
1077 /* If khubd ever becomes multithreaded, this will need a lock */
1079 /* Try to allocate the next devnum beginning at bus->devnum_next. */
1080 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1083 devnum = find_next_zero_bit(bus->devmap.devicemap, 128, 1);
1085 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1088 set_bit(devnum, bus->devmap.devicemap);
1089 udev->devnum = devnum;
1093 static void release_address(struct usb_device *udev)
1095 if (udev->devnum > 0) {
1096 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1102 * usb_disconnect - disconnect a device (usbcore-internal)
1103 * @pdev: pointer to device being disconnected
1104 * Context: !in_interrupt ()
1106 * Something got disconnected. Get rid of it and all of its children.
1108 * If *pdev is a normal device then the parent hub must already be locked.
1109 * If *pdev is a root hub then this routine will acquire the
1110 * usb_bus_list_lock on behalf of the caller.
1112 * Only hub drivers (including virtual root hub drivers for host
1113 * controllers) should ever call this.
1115 * This call is synchronous, and may not be used in an interrupt context.
1117 void usb_disconnect(struct usb_device **pdev)
1119 struct usb_device *udev = *pdev;
1123 pr_debug ("%s nodev\n", __FUNCTION__);
1127 /* mark the device as inactive, so any further urb submissions for
1128 * this device (and any of its children) will fail immediately.
1129 * this quiesces everyting except pending urbs.
1131 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1132 dev_info (&udev->dev, "USB disconnect, address %d\n", udev->devnum);
1134 usb_lock_device(udev);
1136 /* Free up all the children before we remove this device */
1137 for (i = 0; i < USB_MAXCHILDREN; i++) {
1138 if (udev->children[i])
1139 usb_disconnect(&udev->children[i]);
1142 /* deallocate hcd/hardware state ... nuking all pending urbs and
1143 * cleaning up all state associated with the current configuration
1144 * so that the hardware is now fully quiesced.
1146 dev_dbg (&udev->dev, "unregistering device\n");
1147 usb_disable_device(udev, 0);
1149 usb_unlock_device(udev);
1151 /* Unregister the device. The device driver is responsible
1152 * for removing the device files from usbfs and sysfs and for
1153 * de-configuring the device.
1155 device_del(&udev->dev);
1157 /* Free the device number and delete the parent's children[]
1158 * (or root_hub) pointer.
1160 release_address(udev);
1162 /* Avoid races with recursively_mark_NOTATTACHED() */
1163 spin_lock_irq(&device_state_lock);
1165 spin_unlock_irq(&device_state_lock);
1167 put_device(&udev->dev);
1171 static void show_string(struct usb_device *udev, char *id, char *string)
1175 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1179 static inline void show_string(struct usb_device *udev, char *id, char *string)
1184 #ifdef CONFIG_USB_OTG
1185 #include "otg_whitelist.h"
1189 * usb_new_device - perform initial device setup (usbcore-internal)
1190 * @udev: newly addressed device (in ADDRESS state)
1192 * This is called with devices which have been enumerated, but not yet
1193 * configured. The device descriptor is available, but not descriptors
1194 * for any device configuration. The caller must have locked either
1195 * the parent hub (if udev is a normal device) or else the
1196 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1197 * udev has already been installed, but udev is not yet visible through
1198 * sysfs or other filesystem code.
1200 * Returns 0 for success (device is configured and listed, with its
1201 * interfaces, in sysfs); else a negative errno value.
1203 * This call is synchronous, and may not be used in an interrupt context.
1205 * Only the hub driver or root-hub registrar should ever call this.
1207 int usb_new_device(struct usb_device *udev)
1211 err = usb_get_configuration(udev);
1213 dev_err(&udev->dev, "can't read configurations, error %d\n",
1218 /* read the standard strings and cache them if present */
1219 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1220 udev->manufacturer = usb_cache_string(udev,
1221 udev->descriptor.iManufacturer);
1222 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
1224 /* Tell the world! */
1225 dev_dbg(&udev->dev, "new device strings: Mfr=%d, Product=%d, "
1226 "SerialNumber=%d\n",
1227 udev->descriptor.iManufacturer,
1228 udev->descriptor.iProduct,
1229 udev->descriptor.iSerialNumber);
1230 show_string(udev, "Product", udev->product);
1231 show_string(udev, "Manufacturer", udev->manufacturer);
1232 show_string(udev, "SerialNumber", udev->serial);
1234 #ifdef CONFIG_USB_OTG
1236 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1237 * to wake us after we've powered off VBUS; and HNP, switching roles
1238 * "host" to "peripheral". The OTG descriptor helps figure this out.
1240 if (!udev->bus->is_b_host
1242 && udev->parent == udev->bus->root_hub) {
1243 struct usb_otg_descriptor *desc = 0;
1244 struct usb_bus *bus = udev->bus;
1246 /* descriptor may appear anywhere in config */
1247 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1248 le16_to_cpu(udev->config[0].desc.wTotalLength),
1249 USB_DT_OTG, (void **) &desc) == 0) {
1250 if (desc->bmAttributes & USB_OTG_HNP) {
1251 unsigned port1 = udev->portnum;
1252 struct usb_device *root = udev->parent;
1254 dev_info(&udev->dev,
1255 "Dual-Role OTG device on %sHNP port\n",
1256 (port1 == bus->otg_port)
1259 /* enable HNP before suspend, it's simpler */
1260 if (port1 == bus->otg_port)
1261 bus->b_hnp_enable = 1;
1262 err = usb_control_msg(udev,
1263 usb_sndctrlpipe(udev, 0),
1264 USB_REQ_SET_FEATURE, 0,
1266 ? USB_DEVICE_B_HNP_ENABLE
1267 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1268 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1270 /* OTG MESSAGE: report errors here,
1271 * customize to match your product.
1273 dev_info(&udev->dev,
1274 "can't set HNP mode; %d\n",
1276 bus->b_hnp_enable = 0;
1282 if (!is_targeted(udev)) {
1284 /* Maybe it can talk to us, though we can't talk to it.
1285 * (Includes HNP test device.)
1287 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
1288 static int __usb_port_suspend(struct usb_device *,
1290 err = __usb_port_suspend(udev, udev->bus->otg_port);
1292 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1299 /* Register the device. The device driver is responsible
1300 * for adding the device files to usbfs and sysfs and for
1301 * configuring the device.
1303 err = device_add (&udev->dev);
1305 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1312 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1317 static int hub_port_status(struct usb_hub *hub, int port1,
1318 u16 *status, u16 *change)
1322 ret = get_port_status(hub->hdev, port1, &hub->status->port);
1324 dev_err (hub->intfdev,
1325 "%s failed (err = %d)\n", __FUNCTION__, ret);
1327 *status = le16_to_cpu(hub->status->port.wPortStatus);
1328 *change = le16_to_cpu(hub->status->port.wPortChange);
1335 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
1336 static unsigned hub_is_wusb(struct usb_hub *hub)
1338 struct usb_hcd *hcd;
1339 if (hub->hdev->parent != NULL) /* not a root hub? */
1341 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
1342 return hcd->wireless;
1346 #define PORT_RESET_TRIES 5
1347 #define SET_ADDRESS_TRIES 2
1348 #define GET_DESCRIPTOR_TRIES 2
1349 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1350 #define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1352 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1353 #define HUB_SHORT_RESET_TIME 10
1354 #define HUB_LONG_RESET_TIME 200
1355 #define HUB_RESET_TIMEOUT 500
1357 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
1358 struct usb_device *udev, unsigned int delay)
1360 int delay_time, ret;
1364 for (delay_time = 0;
1365 delay_time < HUB_RESET_TIMEOUT;
1366 delay_time += delay) {
1367 /* wait to give the device a chance to reset */
1370 /* read and decode port status */
1371 ret = hub_port_status(hub, port1, &portstatus, &portchange);
1375 /* Device went away? */
1376 if (!(portstatus & USB_PORT_STAT_CONNECTION))
1379 /* bomb out completely if something weird happened */
1380 if ((portchange & USB_PORT_STAT_C_CONNECTION))
1383 /* if we`ve finished resetting, then break out of the loop */
1384 if (!(portstatus & USB_PORT_STAT_RESET) &&
1385 (portstatus & USB_PORT_STAT_ENABLE)) {
1386 if (hub_is_wusb(hub))
1387 udev->speed = USB_SPEED_VARIABLE;
1388 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
1389 udev->speed = USB_SPEED_HIGH;
1390 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
1391 udev->speed = USB_SPEED_LOW;
1393 udev->speed = USB_SPEED_FULL;
1397 /* switch to the long delay after two short delay failures */
1398 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
1399 delay = HUB_LONG_RESET_TIME;
1401 dev_dbg (hub->intfdev,
1402 "port %d not reset yet, waiting %dms\n",
1409 static int hub_port_reset(struct usb_hub *hub, int port1,
1410 struct usb_device *udev, unsigned int delay)
1414 /* Reset the port */
1415 for (i = 0; i < PORT_RESET_TRIES; i++) {
1416 status = set_port_feature(hub->hdev,
1417 port1, USB_PORT_FEAT_RESET);
1419 dev_err(hub->intfdev,
1420 "cannot reset port %d (err = %d)\n",
1423 status = hub_port_wait_reset(hub, port1, udev, delay);
1424 if (status && status != -ENOTCONN)
1425 dev_dbg(hub->intfdev,
1426 "port_wait_reset: err = %d\n",
1430 /* return on disconnect or reset */
1433 /* TRSTRCY = 10 ms; plus some extra */
1438 clear_port_feature(hub->hdev,
1439 port1, USB_PORT_FEAT_C_RESET);
1440 /* FIXME need disconnect() for NOTATTACHED device */
1441 usb_set_device_state(udev, status
1442 ? USB_STATE_NOTATTACHED
1443 : USB_STATE_DEFAULT);
1447 dev_dbg (hub->intfdev,
1448 "port %d not enabled, trying reset again...\n",
1450 delay = HUB_LONG_RESET_TIME;
1453 dev_err (hub->intfdev,
1454 "Cannot enable port %i. Maybe the USB cable is bad?\n",
1461 * Disable a port and mark a logical connnect-change event, so that some
1462 * time later khubd will disconnect() any existing usb_device on the port
1463 * and will re-enumerate if there actually is a device attached.
1465 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
1467 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
1468 hub_port_disable(hub, port1, 1);
1470 /* FIXME let caller ask to power down the port:
1471 * - some devices won't enumerate without a VBUS power cycle
1472 * - SRP saves power that way
1473 * - ... new call, TBD ...
1474 * That's easy if this hub can switch power per-port, and
1475 * khubd reactivates the port later (timer, SRP, etc).
1476 * Powerdown must be optional, because of reset/DFU.
1479 set_bit(port1, hub->change_bits);
1485 #ifdef CONFIG_USB_SUSPEND
1488 * Selective port suspend reduces power; most suspended devices draw
1489 * less than 500 uA. It's also used in OTG, along with remote wakeup.
1490 * All devices below the suspended port are also suspended.
1492 * Devices leave suspend state when the host wakes them up. Some devices
1493 * also support "remote wakeup", where the device can activate the USB
1494 * tree above them to deliver data, such as a keypress or packet. In
1495 * some cases, this wakes the USB host.
1497 static int hub_port_suspend(struct usb_hub *hub, int port1,
1498 struct usb_device *udev)
1502 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
1504 /* enable remote wakeup when appropriate; this lets the device
1505 * wake up the upstream hub (including maybe the root hub).
1507 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
1508 * we don't explicitly enable it here.
1510 if (device_may_wakeup(&udev->dev)) {
1511 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1512 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
1513 USB_DEVICE_REMOTE_WAKEUP, 0,
1515 USB_CTRL_SET_TIMEOUT);
1518 "won't remote wakeup, status %d\n",
1523 status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
1525 dev_dbg(hub->intfdev,
1526 "can't suspend port %d, status %d\n",
1528 /* paranoia: "should not happen" */
1529 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1530 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
1531 USB_DEVICE_REMOTE_WAKEUP, 0,
1533 USB_CTRL_SET_TIMEOUT);
1535 /* device has up to 10 msec to fully suspend */
1536 dev_dbg(&udev->dev, "usb suspend\n");
1537 usb_set_device_state(udev, USB_STATE_SUSPENDED);
1544 * Devices on USB hub ports have only one "suspend" state, corresponding
1545 * to ACPI D2, "may cause the device to lose some context".
1546 * State transitions include:
1548 * - suspend, resume ... when the VBUS power link stays live
1549 * - suspend, disconnect ... VBUS lost
1551 * Once VBUS drop breaks the circuit, the port it's using has to go through
1552 * normal re-enumeration procedures, starting with enabling VBUS power.
1553 * Other than re-initializing the hub (plug/unplug, except for root hubs),
1554 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
1555 * timer, no SRP, no requests through sysfs.
1557 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
1558 * the root hub for their bus goes into global suspend ... so we don't
1559 * (falsely) update the device power state to say it suspended.
1561 static int __usb_port_suspend (struct usb_device *udev, int port1)
1565 /* caller owns the udev device lock */
1569 /* we change the device's upstream USB link,
1570 * but root hubs have no upstream USB link.
1573 status = hub_port_suspend(hdev_to_hub(udev->parent), port1,
1576 dev_dbg(&udev->dev, "usb suspend\n");
1577 usb_set_device_state(udev, USB_STATE_SUSPENDED);
1583 * usb_port_suspend - suspend a usb device's upstream port
1584 * @udev: device that's no longer in active use
1585 * Context: must be able to sleep; device not locked; pm locks held
1587 * Suspends a USB device that isn't in active use, conserving power.
1588 * Devices may wake out of a suspend, if anything important happens,
1589 * using the remote wakeup mechanism. They may also be taken out of
1590 * suspend by the host, using usb_port_resume(). It's also routine
1591 * to disconnect devices while they are suspended.
1593 * This only affects the USB hardware for a device; its interfaces
1594 * (and, for hubs, child devices) must already have been suspended.
1596 * Suspending OTG devices may trigger HNP, if that's been enabled
1597 * between a pair of dual-role devices. That will change roles, such
1598 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
1600 * Returns 0 on success, else negative errno.
1602 int usb_port_suspend(struct usb_device *udev)
1604 return __usb_port_suspend(udev, udev->portnum);
1608 * If the USB "suspend" state is in use (rather than "global suspend"),
1609 * many devices will be individually taken out of suspend state using
1610 * special" resume" signaling. These routines kick in shortly after
1611 * hardware resume signaling is finished, either because of selective
1612 * resume (by host) or remote wakeup (by device) ... now see what changed
1613 * in the tree that's rooted at this device.
1615 static int finish_port_resume(struct usb_device *udev)
1620 /* caller owns the udev device lock */
1621 dev_dbg(&udev->dev, "finish resume\n");
1623 /* usb ch9 identifies four variants of SUSPENDED, based on what
1624 * state the device resumes to. Linux currently won't see the
1625 * first two on the host side; they'd be inside hub_port_init()
1626 * during many timeouts, but khubd can't suspend until later.
1628 usb_set_device_state(udev, udev->actconfig
1629 ? USB_STATE_CONFIGURED
1630 : USB_STATE_ADDRESS);
1632 /* 10.5.4.5 says be sure devices in the tree are still there.
1633 * For now let's assume the device didn't go crazy on resume,
1634 * and device drivers will know about any resume quirks.
1636 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
1638 status = (status == 2 ? 0 : -ENODEV);
1642 "gone after usb resume? status %d\n",
1644 else if (udev->actconfig) {
1645 le16_to_cpus(&devstatus);
1646 if ((devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
1648 status = usb_control_msg(udev,
1649 usb_sndctrlpipe(udev, 0),
1650 USB_REQ_CLEAR_FEATURE,
1652 USB_DEVICE_REMOTE_WAKEUP, 0,
1654 USB_CTRL_SET_TIMEOUT);
1656 dev_dbg(&udev->dev, "disable remote "
1657 "wakeup, status %d\n", status);
1661 } else if (udev->devnum <= 0) {
1662 dev_dbg(&udev->dev, "bogus resume!\n");
1669 hub_port_resume(struct usb_hub *hub, int port1, struct usb_device *udev)
1673 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
1675 set_bit(port1, hub->busy_bits);
1677 /* see 7.1.7.7; affects power usage, but not budgeting */
1678 status = clear_port_feature(hub->hdev,
1679 port1, USB_PORT_FEAT_SUSPEND);
1681 dev_dbg(hub->intfdev,
1682 "can't resume port %d, status %d\n",
1688 /* drive resume for at least 20 msec */
1690 dev_dbg(&udev->dev, "RESUME\n");
1693 #define LIVE_FLAGS ( USB_PORT_STAT_POWER \
1694 | USB_PORT_STAT_ENABLE \
1695 | USB_PORT_STAT_CONNECTION)
1697 /* Virtual root hubs can trigger on GET_PORT_STATUS to
1698 * stop resume signaling. Then finish the resume
1701 devstatus = portchange = 0;
1702 status = hub_port_status(hub, port1,
1703 &devstatus, &portchange);
1705 || (devstatus & LIVE_FLAGS) != LIVE_FLAGS
1706 || (devstatus & USB_PORT_STAT_SUSPEND) != 0
1708 dev_dbg(hub->intfdev,
1709 "port %d status %04x.%04x after resume, %d\n",
1710 port1, portchange, devstatus, status);
1714 if (portchange & USB_PORT_STAT_C_SUSPEND)
1715 clear_port_feature(hub->hdev, port1,
1716 USB_PORT_FEAT_C_SUSPEND);
1717 /* TRSMRCY = 10 msec */
1720 status = finish_port_resume(udev);
1724 hub_port_logical_disconnect(hub, port1);
1726 clear_bit(port1, hub->busy_bits);
1727 if (!hub->hdev->parent && !hub->busy_bits[0])
1728 usb_enable_root_hub_irq(hub->hdev->bus);
1734 * usb_port_resume - re-activate a suspended usb device's upstream port
1735 * @udev: device to re-activate
1736 * Context: must be able to sleep; device not locked; pm locks held
1738 * This will re-activate the suspended device, increasing power usage
1739 * while letting drivers communicate again with its endpoints.
1740 * USB resume explicitly guarantees that the power session between
1741 * the host and the device is the same as it was when the device
1744 * Returns 0 on success, else negative errno.
1746 int usb_port_resume(struct usb_device *udev)
1750 /* we change the device's upstream USB link,
1751 * but root hubs have no upstream USB link.
1754 // NOTE this fails if parent is also suspended...
1755 status = hub_port_resume(hdev_to_hub(udev->parent),
1756 udev->portnum, udev);
1758 status = finish_port_resume(udev);
1760 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
1764 static int remote_wakeup(struct usb_device *udev)
1768 /* don't repeat RESUME sequence if this device
1769 * was already woken up by some other task
1771 usb_lock_device(udev);
1772 if (udev->state == USB_STATE_SUSPENDED) {
1773 dev_dbg(&udev->dev, "RESUME (wakeup)\n");
1774 /* TRSMRCY = 10 msec */
1776 status = finish_port_resume(udev);
1780 usb_resume_both(udev);
1781 usb_unlock_device(udev);
1785 #else /* CONFIG_USB_SUSPEND */
1787 /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
1789 int usb_port_suspend(struct usb_device *udev)
1795 finish_port_resume(struct usb_device *udev)
1801 hub_port_resume(struct usb_hub *hub, int port1, struct usb_device *udev)
1806 int usb_port_resume(struct usb_device *udev)
1811 static inline int remote_wakeup(struct usb_device *udev)
1818 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
1820 struct usb_hub *hub = usb_get_intfdata (intf);
1821 struct usb_device *hdev = hub->hdev;
1824 /* fail if children aren't already suspended */
1825 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
1826 struct usb_device *udev;
1828 udev = hdev->children [port1-1];
1829 if (udev && msg.event == PM_EVENT_SUSPEND &&
1830 #ifdef CONFIG_USB_SUSPEND
1831 udev->state != USB_STATE_SUSPENDED
1833 udev->dev.power.power_state.event
1837 dev_dbg(&intf->dev, "port %d nyet suspended\n", port1);
1842 /* "global suspend" of the downstream HC-to-USB interface */
1843 if (!hdev->parent) {
1844 struct usb_bus *bus = hdev->bus;
1846 int status = hcd_bus_suspend (bus);
1849 dev_dbg(&hdev->dev, "'global' suspend %d\n",
1857 /* stop khubd and related activity */
1862 static int hub_resume(struct usb_interface *intf)
1864 struct usb_device *hdev = interface_to_usbdev(intf);
1865 struct usb_hub *hub = usb_get_intfdata (intf);
1868 /* "global resume" of the downstream HC-to-USB interface */
1869 if (!hdev->parent) {
1870 struct usb_bus *bus = hdev->bus;
1872 status = hcd_bus_resume (bus);
1874 dev_dbg(&intf->dev, "'global' resume %d\n",
1881 /* TRSMRCY = 10 msec */
1886 /* tell khubd to look for changes on this hub */
1891 #else /* CONFIG_PM */
1893 static inline int remote_wakeup(struct usb_device *udev)
1900 void usb_suspend_root_hub(struct usb_device *hdev)
1902 struct usb_hub *hub = hdev_to_hub(hdev);
1904 /* This also makes any led blinker stop retriggering. We're called
1905 * from irq, so the blinker might still be scheduled. Caller promises
1906 * that the root hub status URB will be canceled.
1909 mark_quiesced(to_usb_interface(hub->intfdev));
1912 void usb_resume_root_hub(struct usb_device *hdev)
1914 struct usb_hub *hub = hdev_to_hub(hdev);
1916 hub->resume_root_hub = 1;
1921 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
1923 * Between connect detection and reset signaling there must be a delay
1924 * of 100ms at least for debounce and power-settling. The corresponding
1925 * timer shall restart whenever the downstream port detects a disconnect.
1927 * Apparently there are some bluetooth and irda-dongles and a number of
1928 * low-speed devices for which this debounce period may last over a second.
1929 * Not covered by the spec - but easy to deal with.
1931 * This implementation uses a 1500ms total debounce timeout; if the
1932 * connection isn't stable by then it returns -ETIMEDOUT. It checks
1933 * every 25ms for transient disconnects. When the port status has been
1934 * unchanged for 100ms it returns the port status.
1937 #define HUB_DEBOUNCE_TIMEOUT 1500
1938 #define HUB_DEBOUNCE_STEP 25
1939 #define HUB_DEBOUNCE_STABLE 100
1941 static int hub_port_debounce(struct usb_hub *hub, int port1)
1944 int total_time, stable_time = 0;
1945 u16 portchange, portstatus;
1946 unsigned connection = 0xffff;
1948 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
1949 ret = hub_port_status(hub, port1, &portstatus, &portchange);
1953 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
1954 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
1955 stable_time += HUB_DEBOUNCE_STEP;
1956 if (stable_time >= HUB_DEBOUNCE_STABLE)
1960 connection = portstatus & USB_PORT_STAT_CONNECTION;
1963 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1964 clear_port_feature(hub->hdev, port1,
1965 USB_PORT_FEAT_C_CONNECTION);
1968 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
1970 msleep(HUB_DEBOUNCE_STEP);
1973 dev_dbg (hub->intfdev,
1974 "debounce: port %d: total %dms stable %dms status 0x%x\n",
1975 port1, total_time, stable_time, portstatus);
1977 if (stable_time < HUB_DEBOUNCE_STABLE)
1982 static void ep0_reinit(struct usb_device *udev)
1984 usb_disable_endpoint(udev, 0 + USB_DIR_IN);
1985 usb_disable_endpoint(udev, 0 + USB_DIR_OUT);
1986 udev->ep_in[0] = udev->ep_out[0] = &udev->ep0;
1989 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
1990 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
1992 static int hub_set_address(struct usb_device *udev)
1996 if (udev->devnum == 0)
1998 if (udev->state == USB_STATE_ADDRESS)
2000 if (udev->state != USB_STATE_DEFAULT)
2002 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2003 USB_REQ_SET_ADDRESS, 0, udev->devnum, 0,
2004 NULL, 0, USB_CTRL_SET_TIMEOUT);
2006 usb_set_device_state(udev, USB_STATE_ADDRESS);
2012 /* Reset device, (re)assign address, get device descriptor.
2013 * Device connection must be stable, no more debouncing needed.
2014 * Returns device in USB_STATE_ADDRESS, except on error.
2016 * If this is called for an already-existing device (as part of
2017 * usb_reset_device), the caller must own the device lock. For a
2018 * newly detected device that is not accessible through any global
2019 * pointers, it's not necessary to lock the device.
2022 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2025 static DEFINE_MUTEX(usb_address0_mutex);
2027 struct usb_device *hdev = hub->hdev;
2029 unsigned delay = HUB_SHORT_RESET_TIME;
2030 enum usb_device_speed oldspeed = udev->speed;
2033 /* root hub ports have a slightly longer reset period
2034 * (from USB 2.0 spec, section 7.1.7.5)
2036 if (!hdev->parent) {
2037 delay = HUB_ROOT_RESET_TIME;
2038 if (port1 == hdev->bus->otg_port)
2039 hdev->bus->b_hnp_enable = 0;
2042 /* Some low speed devices have problems with the quick delay, so */
2043 /* be a bit pessimistic with those devices. RHbug #23670 */
2044 if (oldspeed == USB_SPEED_LOW)
2045 delay = HUB_LONG_RESET_TIME;
2047 mutex_lock(&usb_address0_mutex);
2049 /* Reset the device; full speed may morph to high speed */
2050 retval = hub_port_reset(hub, port1, udev, delay);
2051 if (retval < 0) /* error or disconnect */
2053 /* success, speed is known */
2056 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2057 dev_dbg(&udev->dev, "device reset changed speed!\n");
2060 oldspeed = udev->speed;
2062 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2063 * it's fixed size except for full speed devices.
2064 * For Wireless USB devices, ep0 max packet is always 512 (tho
2065 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
2067 switch (udev->speed) {
2068 case USB_SPEED_VARIABLE: /* fixed at 512 */
2069 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(512);
2071 case USB_SPEED_HIGH: /* fixed at 64 */
2072 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2074 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
2075 /* to determine the ep0 maxpacket size, try to read
2076 * the device descriptor to get bMaxPacketSize0 and
2077 * then correct our initial guess.
2079 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2081 case USB_SPEED_LOW: /* fixed at 8 */
2082 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(8);
2089 switch (udev->speed) {
2090 case USB_SPEED_LOW: speed = "low"; break;
2091 case USB_SPEED_FULL: speed = "full"; break;
2092 case USB_SPEED_HIGH: speed = "high"; break;
2093 case USB_SPEED_VARIABLE:
2097 default: speed = "?"; break;
2099 dev_info (&udev->dev,
2100 "%s %s speed %sUSB device using %s and address %d\n",
2101 (udev->config) ? "reset" : "new", speed, type,
2102 udev->bus->controller->driver->name, udev->devnum);
2104 /* Set up TT records, if needed */
2106 udev->tt = hdev->tt;
2107 udev->ttport = hdev->ttport;
2108 } else if (udev->speed != USB_SPEED_HIGH
2109 && hdev->speed == USB_SPEED_HIGH) {
2110 udev->tt = &hub->tt;
2111 udev->ttport = port1;
2114 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2115 * Because device hardware and firmware is sometimes buggy in
2116 * this area, and this is how Linux has done it for ages.
2117 * Change it cautiously.
2119 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2120 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2121 * so it may help with some non-standards-compliant devices.
2122 * Otherwise we start with SET_ADDRESS and then try to read the
2123 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2126 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
2127 if (USE_NEW_SCHEME(retry_counter)) {
2128 struct usb_device_descriptor *buf;
2131 #define GET_DESCRIPTOR_BUFSIZE 64
2132 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2138 /* Use a short timeout the first time through,
2139 * so that recalcitrant full-speed devices with
2140 * 8- or 16-byte ep0-maxpackets won't slow things
2141 * down tremendously by NAKing the unexpectedly
2142 * early status stage. Also, retry on all errors;
2143 * some devices are flakey.
2144 * 255 is for WUSB devices, we actually need to use 512.
2147 for (j = 0; j < 3; ++j) {
2148 buf->bMaxPacketSize0 = 0;
2149 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2150 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2151 USB_DT_DEVICE << 8, 0,
2152 buf, GET_DESCRIPTOR_BUFSIZE,
2153 (i ? USB_CTRL_GET_TIMEOUT : 1000));
2154 switch (buf->bMaxPacketSize0) {
2155 case 8: case 16: case 32: case 64: case 255:
2156 if (buf->bDescriptorType ==
2170 udev->descriptor.bMaxPacketSize0 =
2171 buf->bMaxPacketSize0;
2174 retval = hub_port_reset(hub, port1, udev, delay);
2175 if (retval < 0) /* error or disconnect */
2177 if (oldspeed != udev->speed) {
2179 "device reset changed speed!\n");
2184 dev_err(&udev->dev, "device descriptor "
2185 "read/%s, error %d\n",
2190 #undef GET_DESCRIPTOR_BUFSIZE
2193 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
2194 retval = hub_set_address(udev);
2201 "device not accepting address %d, error %d\n",
2202 udev->devnum, retval);
2206 /* cope with hardware quirkiness:
2207 * - let SET_ADDRESS settle, some device hardware wants it
2208 * - read ep0 maxpacket even for high and low speed,
2211 if (USE_NEW_SCHEME(retry_counter))
2214 retval = usb_get_device_descriptor(udev, 8);
2216 dev_err(&udev->dev, "device descriptor "
2217 "read/%s, error %d\n",
2229 i = udev->descriptor.bMaxPacketSize0 == 0xff?
2230 512 : udev->descriptor.bMaxPacketSize0;
2231 if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
2232 if (udev->speed != USB_SPEED_FULL ||
2233 !(i == 8 || i == 16 || i == 32 || i == 64)) {
2234 dev_err(&udev->dev, "ep0 maxpacket = %d\n", i);
2238 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
2239 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
2243 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
2244 if (retval < (signed)sizeof(udev->descriptor)) {
2245 dev_err(&udev->dev, "device descriptor read/%s, error %d\n",
2256 hub_port_disable(hub, port1, 0);
2257 mutex_unlock(&usb_address0_mutex);
2262 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
2264 struct usb_qualifier_descriptor *qual;
2267 qual = kmalloc (sizeof *qual, SLAB_KERNEL);
2271 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
2272 qual, sizeof *qual);
2273 if (status == sizeof *qual) {
2274 dev_info(&udev->dev, "not running at top speed; "
2275 "connect to a high speed hub\n");
2276 /* hub LEDs are probably harder to miss than syslog */
2277 if (hub->has_indicators) {
2278 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
2279 schedule_work (&hub->leds);
2286 hub_power_remaining (struct usb_hub *hub)
2288 struct usb_device *hdev = hub->hdev;
2292 if (!hub->limited_power)
2295 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
2296 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
2297 struct usb_device *udev = hdev->children[port1 - 1];
2303 /* Unconfigured devices may not use more than 100mA,
2304 * or 8mA for OTG ports */
2305 if (udev->actconfig)
2306 delta = udev->actconfig->desc.bMaxPower * 2;
2307 else if (port1 != udev->bus->otg_port || hdev->parent)
2311 if (delta > hub->mA_per_port)
2312 dev_warn(&udev->dev, "%dmA is over %umA budget "
2314 delta, hub->mA_per_port, port1);
2317 if (remaining < 0) {
2318 dev_warn(hub->intfdev, "%dmA over power budget!\n",
2325 /* Handle physical or logical connection change events.
2326 * This routine is called when:
2327 * a port connection-change occurs;
2328 * a port enable-change occurs (often caused by EMI);
2329 * usb_reset_device() encounters changed descriptors (as from
2330 * a firmware download)
2331 * caller already locked the hub
2333 static void hub_port_connect_change(struct usb_hub *hub, int port1,
2334 u16 portstatus, u16 portchange)
2336 struct usb_device *hdev = hub->hdev;
2337 struct device *hub_dev = hub->intfdev;
2338 u16 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2342 "port %d, status %04x, change %04x, %s\n",
2343 port1, portstatus, portchange, portspeed (portstatus));
2345 if (hub->has_indicators) {
2346 set_port_led(hub, port1, HUB_LED_AUTO);
2347 hub->indicator[port1-1] = INDICATOR_AUTO;
2350 /* Disconnect any existing devices under this port */
2351 if (hdev->children[port1-1])
2352 usb_disconnect(&hdev->children[port1-1]);
2353 clear_bit(port1, hub->change_bits);
2355 #ifdef CONFIG_USB_OTG
2356 /* during HNP, don't repeat the debounce */
2357 if (hdev->bus->is_b_host)
2358 portchange &= ~USB_PORT_STAT_C_CONNECTION;
2361 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2362 status = hub_port_debounce(hub, port1);
2365 "connect-debounce failed, port %d disabled\n",
2369 portstatus = status;
2372 /* Return now if nothing is connected */
2373 if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
2375 /* maybe switch power back on (e.g. root hub was reset) */
2376 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
2377 && !(portstatus & (1 << USB_PORT_FEAT_POWER)))
2378 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
2380 if (portstatus & USB_PORT_STAT_ENABLE)
2385 #ifdef CONFIG_USB_SUSPEND
2386 /* If something is connected, but the port is suspended, wake it up. */
2387 if (portstatus & USB_PORT_STAT_SUSPEND) {
2388 status = hub_port_resume(hub, port1, NULL);
2391 "can't clear suspend on port %d; %d\n",
2398 for (i = 0; i < SET_CONFIG_TRIES; i++) {
2399 struct usb_device *udev;
2401 /* reallocate for each attempt, since references
2402 * to the previous one can escape in various ways
2404 udev = usb_alloc_dev(hdev, hdev->bus, port1);
2407 "couldn't allocate port %d usb_device\n",
2412 usb_set_device_state(udev, USB_STATE_POWERED);
2413 udev->speed = USB_SPEED_UNKNOWN;
2414 udev->bus_mA = hub->mA_per_port;
2416 /* set the address */
2417 choose_address(udev);
2418 if (udev->devnum <= 0) {
2419 status = -ENOTCONN; /* Don't retry */
2423 /* reset and get descriptor */
2424 status = hub_port_init(hub, udev, port1, i);
2428 /* consecutive bus-powered hubs aren't reliable; they can
2429 * violate the voltage drop budget. if the new child has
2430 * a "powered" LED, users should notice we didn't enable it
2431 * (without reading syslog), even without per-port LEDs
2434 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
2435 && udev->bus_mA <= 100) {
2438 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
2441 dev_dbg(&udev->dev, "get status %d ?\n", status);
2444 le16_to_cpus(&devstat);
2445 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
2447 "can't connect bus-powered hub "
2449 if (hub->has_indicators) {
2450 hub->indicator[port1-1] =
2451 INDICATOR_AMBER_BLINK;
2452 schedule_work (&hub->leds);
2454 status = -ENOTCONN; /* Don't retry */
2459 /* check for devices running slower than they could */
2460 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
2461 && udev->speed == USB_SPEED_FULL
2462 && highspeed_hubs != 0)
2463 check_highspeed (hub, udev, port1);
2465 /* Store the parent's children[] pointer. At this point
2466 * udev becomes globally accessible, although presumably
2467 * no one will look at it until hdev is unlocked.
2471 /* We mustn't add new devices if the parent hub has
2472 * been disconnected; we would race with the
2473 * recursively_mark_NOTATTACHED() routine.
2475 spin_lock_irq(&device_state_lock);
2476 if (hdev->state == USB_STATE_NOTATTACHED)
2479 hdev->children[port1-1] = udev;
2480 spin_unlock_irq(&device_state_lock);
2482 /* Run it through the hoops (find a driver, etc) */
2484 status = usb_new_device(udev);
2486 spin_lock_irq(&device_state_lock);
2487 hdev->children[port1-1] = NULL;
2488 spin_unlock_irq(&device_state_lock);
2495 status = hub_power_remaining(hub);
2497 dev_dbg(hub_dev, "%dmA power budget left\n", status);
2502 hub_port_disable(hub, port1, 1);
2505 release_address(udev);
2507 if (status == -ENOTCONN)
2512 hub_port_disable(hub, port1, 1);
2515 static void hub_events(void)
2517 struct list_head *tmp;
2518 struct usb_device *hdev;
2519 struct usb_interface *intf;
2520 struct usb_hub *hub;
2521 struct device *hub_dev;
2530 * We restart the list every time to avoid a deadlock with
2531 * deleting hubs downstream from this one. This should be
2532 * safe since we delete the hub from the event list.
2533 * Not the most efficient, but avoids deadlocks.
2537 /* Grab the first entry at the beginning of the list */
2538 spin_lock_irq(&hub_event_lock);
2539 if (list_empty(&hub_event_list)) {
2540 spin_unlock_irq(&hub_event_lock);
2544 tmp = hub_event_list.next;
2547 hub = list_entry(tmp, struct usb_hub, event_list);
2549 intf = to_usb_interface(hub->intfdev);
2550 hub_dev = &intf->dev;
2552 i = hub->resume_root_hub;
2554 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x%s\n",
2555 hdev->state, hub->descriptor
2556 ? hub->descriptor->bNbrPorts
2558 /* NOTE: expects max 15 ports... */
2559 (u16) hub->change_bits[0],
2560 (u16) hub->event_bits[0],
2561 i ? ", resume root" : "");
2564 spin_unlock_irq(&hub_event_lock);
2566 /* Lock the device, then check to see if we were
2567 * disconnected while waiting for the lock to succeed. */
2568 if (locktree(hdev) < 0) {
2572 if (hub != usb_get_intfdata(intf))
2575 /* If the hub has died, clean up after it */
2576 if (hdev->state == USB_STATE_NOTATTACHED) {
2577 hub->error = -ENODEV;
2578 hub_pre_reset(intf);
2582 /* Is this is a root hub wanting to reactivate the downstream
2583 * ports? If so, be sure the interface resumes even if its
2584 * stub "device" node was never suspended.
2587 usb_resume_both(hdev);
2589 /* If this is an inactive or suspended hub, do nothing */
2594 dev_dbg (hub_dev, "resetting for error %d\n",
2597 ret = usb_reset_composite_device(hdev, intf);
2600 "error resetting hub: %d\n", ret);
2608 /* deal with port status changes */
2609 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
2610 if (test_bit(i, hub->busy_bits))
2612 connect_change = test_bit(i, hub->change_bits);
2613 if (!test_and_clear_bit(i, hub->event_bits) &&
2614 !connect_change && !hub->activating)
2617 ret = hub_port_status(hub, i,
2618 &portstatus, &portchange);
2622 if (hub->activating && !hdev->children[i-1] &&
2624 USB_PORT_STAT_CONNECTION))
2627 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2628 clear_port_feature(hdev, i,
2629 USB_PORT_FEAT_C_CONNECTION);
2633 if (portchange & USB_PORT_STAT_C_ENABLE) {
2634 if (!connect_change)
2636 "port %d enable change, "
2639 clear_port_feature(hdev, i,
2640 USB_PORT_FEAT_C_ENABLE);
2643 * EM interference sometimes causes badly
2644 * shielded USB devices to be shutdown by
2645 * the hub, this hack enables them again.
2646 * Works at least with mouse driver.
2648 if (!(portstatus & USB_PORT_STAT_ENABLE)
2650 && hdev->children[i-1]) {
2653 "disabled by hub (EMI?), "
2660 if (portchange & USB_PORT_STAT_C_SUSPEND) {
2661 clear_port_feature(hdev, i,
2662 USB_PORT_FEAT_C_SUSPEND);
2663 if (hdev->children[i-1]) {
2664 ret = remote_wakeup(hdev->
2670 hub_port_disable(hub, i, 1);
2673 "resume on port %d, status %d\n",
2677 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
2679 "over-current change on port %d\n",
2681 clear_port_feature(hdev, i,
2682 USB_PORT_FEAT_C_OVER_CURRENT);
2686 if (portchange & USB_PORT_STAT_C_RESET) {
2688 "reset change on port %d\n",
2690 clear_port_feature(hdev, i,
2691 USB_PORT_FEAT_C_RESET);
2695 hub_port_connect_change(hub, i,
2696 portstatus, portchange);
2699 /* deal with hub status changes */
2700 if (test_and_clear_bit(0, hub->event_bits) == 0)
2702 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
2703 dev_err (hub_dev, "get_hub_status failed\n");
2705 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
2706 dev_dbg (hub_dev, "power change\n");
2707 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
2708 if (hubstatus & HUB_STATUS_LOCAL_POWER)
2709 /* FIXME: Is this always true? */
2710 hub->limited_power = 0;
2712 hub->limited_power = 1;
2714 if (hubchange & HUB_CHANGE_OVERCURRENT) {
2715 dev_dbg (hub_dev, "overcurrent change\n");
2716 msleep(500); /* Cool down */
2717 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
2722 hub->activating = 0;
2724 /* If this is a root hub, tell the HCD it's okay to
2725 * re-enable port-change interrupts now. */
2726 if (!hdev->parent && !hub->busy_bits[0])
2727 usb_enable_root_hub_irq(hdev->bus);
2730 usb_unlock_device(hdev);
2733 } /* end while (1) */
2736 static int hub_thread(void *__unused)
2740 wait_event_interruptible(khubd_wait,
2741 !list_empty(&hub_event_list) ||
2742 kthread_should_stop());
2744 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
2746 pr_debug("%s: khubd exiting\n", usbcore_name);
2750 static struct usb_device_id hub_id_table [] = {
2751 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
2752 .bDeviceClass = USB_CLASS_HUB},
2753 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
2754 .bInterfaceClass = USB_CLASS_HUB},
2755 { } /* Terminating entry */
2758 MODULE_DEVICE_TABLE (usb, hub_id_table);
2760 static struct usb_driver hub_driver = {
2763 .disconnect = hub_disconnect,
2764 .suspend = hub_suspend,
2765 .resume = hub_resume,
2766 .pre_reset = hub_pre_reset,
2767 .post_reset = hub_post_reset,
2769 .id_table = hub_id_table,
2772 int usb_hub_init(void)
2774 if (usb_register(&hub_driver) < 0) {
2775 printk(KERN_ERR "%s: can't register hub driver\n",
2780 khubd_task = kthread_run(hub_thread, NULL, "khubd");
2781 if (!IS_ERR(khubd_task))
2784 /* Fall through if kernel_thread failed */
2785 usb_deregister(&hub_driver);
2786 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
2791 void usb_hub_cleanup(void)
2793 kthread_stop(khubd_task);
2796 * Hub resources are freed for us by usb_deregister. It calls
2797 * usb_driver_purge on every device which in turn calls that
2798 * devices disconnect function if it is using this driver.
2799 * The hub_disconnect function takes care of releasing the
2800 * individual hub resources. -greg
2802 usb_deregister(&hub_driver);
2803 } /* usb_hub_cleanup() */
2805 static int config_descriptors_changed(struct usb_device *udev)
2809 struct usb_config_descriptor *buf;
2811 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2812 if (len < le16_to_cpu(udev->config[index].desc.wTotalLength))
2813 len = le16_to_cpu(udev->config[index].desc.wTotalLength);
2815 buf = kmalloc (len, SLAB_KERNEL);
2817 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
2818 /* assume the worst */
2821 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2823 int old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
2825 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
2827 if (length < old_length) {
2828 dev_dbg(&udev->dev, "config index %d, error %d\n",
2832 if (memcmp (buf, udev->rawdescriptors[index], old_length)
2834 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
2835 index, buf->bConfigurationValue);
2840 return index != udev->descriptor.bNumConfigurations;
2844 * usb_reset_device - perform a USB port reset to reinitialize a device
2845 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
2847 * WARNING - don't use this routine to reset a composite device
2848 * (one with multiple interfaces owned by separate drivers)!
2849 * Use usb_reset_composite_device() instead.
2851 * Do a port reset, reassign the device's address, and establish its
2852 * former operating configuration. If the reset fails, or the device's
2853 * descriptors change from their values before the reset, or the original
2854 * configuration and altsettings cannot be restored, a flag will be set
2855 * telling khubd to pretend the device has been disconnected and then
2856 * re-connected. All drivers will be unbound, and the device will be
2857 * re-enumerated and probed all over again.
2859 * Returns 0 if the reset succeeded, -ENODEV if the device has been
2860 * flagged for logical disconnection, or some other negative error code
2861 * if the reset wasn't even attempted.
2863 * The caller must own the device lock. For example, it's safe to use
2864 * this from a driver probe() routine after downloading new firmware.
2865 * For calls that might not occur during probe(), drivers should lock
2866 * the device using usb_lock_device_for_reset().
2868 int usb_reset_device(struct usb_device *udev)
2870 struct usb_device *parent_hdev = udev->parent;
2871 struct usb_hub *parent_hub;
2872 struct usb_device_descriptor descriptor = udev->descriptor;
2874 int port1 = udev->portnum;
2876 if (udev->state == USB_STATE_NOTATTACHED ||
2877 udev->state == USB_STATE_SUSPENDED) {
2878 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
2884 /* this requires hcd-specific logic; see OHCI hc_restart() */
2885 dev_dbg(&udev->dev, "%s for root hub!\n", __FUNCTION__);
2888 parent_hub = hdev_to_hub(parent_hdev);
2890 set_bit(port1, parent_hub->busy_bits);
2891 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
2893 /* ep0 maxpacket size may change; let the HCD know about it.
2894 * Other endpoints will be handled by re-enumeration. */
2896 ret = hub_port_init(parent_hub, udev, port1, i);
2900 clear_bit(port1, parent_hub->busy_bits);
2901 if (!parent_hdev->parent && !parent_hub->busy_bits[0])
2902 usb_enable_root_hub_irq(parent_hdev->bus);
2907 /* Device might have changed firmware (DFU or similar) */
2908 if (memcmp(&udev->descriptor, &descriptor, sizeof descriptor)
2909 || config_descriptors_changed (udev)) {
2910 dev_info(&udev->dev, "device firmware changed\n");
2911 udev->descriptor = descriptor; /* for disconnect() calls */
2915 if (!udev->actconfig)
2918 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2919 USB_REQ_SET_CONFIGURATION, 0,
2920 udev->actconfig->desc.bConfigurationValue, 0,
2921 NULL, 0, USB_CTRL_SET_TIMEOUT);
2924 "can't restore configuration #%d (error=%d)\n",
2925 udev->actconfig->desc.bConfigurationValue, ret);
2928 usb_set_device_state(udev, USB_STATE_CONFIGURED);
2930 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
2931 struct usb_interface *intf = udev->actconfig->interface[i];
2932 struct usb_interface_descriptor *desc;
2934 /* set_interface resets host side toggle even
2935 * for altsetting zero. the interface may have no driver.
2937 desc = &intf->cur_altsetting->desc;
2938 ret = usb_set_interface(udev, desc->bInterfaceNumber,
2939 desc->bAlternateSetting);
2941 dev_err(&udev->dev, "failed to restore interface %d "
2942 "altsetting %d (error=%d)\n",
2943 desc->bInterfaceNumber,
2944 desc->bAlternateSetting,
2954 hub_port_logical_disconnect(parent_hub, port1);
2957 EXPORT_SYMBOL(usb_reset_device);
2960 * usb_reset_composite_device - warn interface drivers and perform a USB port reset
2961 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
2962 * @iface: interface bound to the driver making the request (optional)
2964 * Warns all drivers bound to registered interfaces (using their pre_reset
2965 * method), performs the port reset, and then lets the drivers know that
2966 * the reset is over (using their post_reset method).
2968 * Return value is the same as for usb_reset_device().
2970 * The caller must own the device lock. For example, it's safe to use
2971 * this from a driver probe() routine after downloading new firmware.
2972 * For calls that might not occur during probe(), drivers should lock
2973 * the device using usb_lock_device_for_reset().
2975 * The interface locks are acquired during the pre_reset stage and released
2976 * during the post_reset stage. However if iface is not NULL and is
2977 * currently being probed, we assume that the caller already owns its
2980 int usb_reset_composite_device(struct usb_device *udev,
2981 struct usb_interface *iface)
2984 struct usb_host_config *config = udev->actconfig;
2986 if (udev->state == USB_STATE_NOTATTACHED ||
2987 udev->state == USB_STATE_SUSPENDED) {
2988 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
2993 if (iface && iface->condition != USB_INTERFACE_BINDING)
2998 struct usb_interface *cintf;
2999 struct usb_driver *drv;
3001 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
3002 cintf = config->interface[i];
3004 down(&cintf->dev.sem);
3005 if (device_is_registered(&cintf->dev) &&
3006 cintf->dev.driver) {
3007 drv = to_usb_driver(cintf->dev.driver);
3009 (drv->pre_reset)(cintf);
3014 ret = usb_reset_device(udev);
3018 struct usb_interface *cintf;
3019 struct usb_driver *drv;
3021 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
3022 cintf = config->interface[i];
3023 if (device_is_registered(&cintf->dev) &&
3024 cintf->dev.driver) {
3025 drv = to_usb_driver(cintf->dev.driver);
3026 if (drv->post_reset)
3027 (drv->post_reset)(cintf);
3030 up(&cintf->dev.sem);
3036 EXPORT_SYMBOL(usb_reset_composite_device);