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 /* Output endpoint? Curiouser and curiouser.. */
872 if (!(endpoint->bEndpointAddress & USB_DIR_IN))
873 goto descriptor_error;
875 /* If it's not an interrupt endpoint, we'd better punt! */
876 if ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
877 != USB_ENDPOINT_XFER_INT)
878 goto descriptor_error;
881 dev_info (&intf->dev, "USB hub found\n");
883 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
885 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
889 INIT_LIST_HEAD(&hub->event_list);
890 hub->intfdev = &intf->dev;
892 INIT_WORK(&hub->leds, led_work, hub);
894 usb_set_intfdata (intf, hub);
896 if (hdev->speed == USB_SPEED_HIGH)
899 if (hub_configure(hub, endpoint) >= 0)
902 hub_disconnect (intf);
907 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
909 struct usb_device *hdev = interface_to_usbdev (intf);
911 /* assert ifno == 0 (part of hub spec) */
913 case USBDEVFS_HUB_PORTINFO: {
914 struct usbdevfs_hub_portinfo *info = user_data;
917 spin_lock_irq(&device_state_lock);
918 if (hdev->devnum <= 0)
921 info->nports = hdev->maxchild;
922 for (i = 0; i < info->nports; i++) {
923 if (hdev->children[i] == NULL)
927 hdev->children[i]->devnum;
930 spin_unlock_irq(&device_state_lock);
932 return info->nports + 1;
941 /* grab device/port lock, returning index of that port (zero based).
942 * protects the upstream link used by this device from concurrent
943 * tree operations like suspend, resume, reset, and disconnect, which
944 * apply to everything downstream of a given port.
946 static int locktree(struct usb_device *udev)
949 struct usb_device *hdev;
954 /* root hub is always the first lock in the series */
957 usb_lock_device(udev);
961 /* on the path from root to us, lock everything from
962 * top down, dropping parent locks when not needed
968 /* everything is fail-fast once disconnect
971 if (udev->state == USB_STATE_NOTATTACHED) {
972 usb_unlock_device(hdev);
976 /* when everyone grabs locks top->bottom,
977 * non-overlapping work may be concurrent
979 usb_lock_device(udev);
980 usb_unlock_device(hdev);
981 return udev->portnum;
984 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
988 for (i = 0; i < udev->maxchild; ++i) {
989 if (udev->children[i])
990 recursively_mark_NOTATTACHED(udev->children[i]);
992 udev->state = USB_STATE_NOTATTACHED;
996 * usb_set_device_state - change a device's current state (usbcore, hcds)
997 * @udev: pointer to device whose state should be changed
998 * @new_state: new state value to be stored
1000 * udev->state is _not_ fully protected by the device lock. Although
1001 * most transitions are made only while holding the lock, the state can
1002 * can change to USB_STATE_NOTATTACHED at almost any time. This
1003 * is so that devices can be marked as disconnected as soon as possible,
1004 * without having to wait for any semaphores to be released. As a result,
1005 * all changes to any device's state must be protected by the
1006 * device_state_lock spinlock.
1008 * Once a device has been added to the device tree, all changes to its state
1009 * should be made using this routine. The state should _not_ be set directly.
1011 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1012 * Otherwise udev->state is set to new_state, and if new_state is
1013 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1014 * to USB_STATE_NOTATTACHED.
1016 void usb_set_device_state(struct usb_device *udev,
1017 enum usb_device_state new_state)
1019 unsigned long flags;
1021 spin_lock_irqsave(&device_state_lock, flags);
1022 if (udev->state == USB_STATE_NOTATTACHED)
1024 else if (new_state != USB_STATE_NOTATTACHED) {
1025 udev->state = new_state;
1027 /* root hub wakeup capabilities are managed out-of-band
1028 * and may involve silicon errata ... ignore them here.
1031 if (new_state == USB_STATE_CONFIGURED)
1032 device_init_wakeup(&udev->dev,
1033 (udev->actconfig->desc.bmAttributes
1034 & USB_CONFIG_ATT_WAKEUP));
1035 else if (new_state != USB_STATE_SUSPENDED)
1036 device_init_wakeup(&udev->dev, 0);
1039 recursively_mark_NOTATTACHED(udev);
1040 spin_unlock_irqrestore(&device_state_lock, flags);
1047 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
1048 * @rhdev: struct usb_device for the root hub
1050 * The USB host controller driver calls this function when its root hub
1051 * is resumed and Vbus power has been interrupted or the controller
1052 * has been reset. The routine marks all the children of the root hub
1053 * as NOTATTACHED and marks logical connect-change events on their ports.
1055 void usb_root_hub_lost_power(struct usb_device *rhdev)
1057 struct usb_hub *hub;
1059 unsigned long flags;
1061 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
1062 spin_lock_irqsave(&device_state_lock, flags);
1063 hub = hdev_to_hub(rhdev);
1064 for (port1 = 1; port1 <= rhdev->maxchild; ++port1) {
1065 if (rhdev->children[port1 - 1]) {
1066 recursively_mark_NOTATTACHED(
1067 rhdev->children[port1 - 1]);
1068 set_bit(port1, hub->change_bits);
1071 spin_unlock_irqrestore(&device_state_lock, flags);
1073 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
1077 static void choose_address(struct usb_device *udev)
1080 struct usb_bus *bus = udev->bus;
1082 /* If khubd ever becomes multithreaded, this will need a lock */
1084 /* Try to allocate the next devnum beginning at bus->devnum_next. */
1085 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1088 devnum = find_next_zero_bit(bus->devmap.devicemap, 128, 1);
1090 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1093 set_bit(devnum, bus->devmap.devicemap);
1094 udev->devnum = devnum;
1098 static void release_address(struct usb_device *udev)
1100 if (udev->devnum > 0) {
1101 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1107 * usb_disconnect - disconnect a device (usbcore-internal)
1108 * @pdev: pointer to device being disconnected
1109 * Context: !in_interrupt ()
1111 * Something got disconnected. Get rid of it and all of its children.
1113 * If *pdev is a normal device then the parent hub must already be locked.
1114 * If *pdev is a root hub then this routine will acquire the
1115 * usb_bus_list_lock on behalf of the caller.
1117 * Only hub drivers (including virtual root hub drivers for host
1118 * controllers) should ever call this.
1120 * This call is synchronous, and may not be used in an interrupt context.
1122 void usb_disconnect(struct usb_device **pdev)
1124 struct usb_device *udev = *pdev;
1128 pr_debug ("%s nodev\n", __FUNCTION__);
1132 /* mark the device as inactive, so any further urb submissions for
1133 * this device (and any of its children) will fail immediately.
1134 * this quiesces everyting except pending urbs.
1136 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1137 dev_info (&udev->dev, "USB disconnect, address %d\n", udev->devnum);
1139 usb_lock_device(udev);
1141 /* Free up all the children before we remove this device */
1142 for (i = 0; i < USB_MAXCHILDREN; i++) {
1143 if (udev->children[i])
1144 usb_disconnect(&udev->children[i]);
1147 /* deallocate hcd/hardware state ... nuking all pending urbs and
1148 * cleaning up all state associated with the current configuration
1149 * so that the hardware is now fully quiesced.
1151 dev_dbg (&udev->dev, "unregistering device\n");
1152 usb_disable_device(udev, 0);
1154 usb_unlock_device(udev);
1156 /* Unregister the device. The device driver is responsible
1157 * for removing the device files from usbfs and sysfs and for
1158 * de-configuring the device.
1160 device_del(&udev->dev);
1162 /* Free the device number and delete the parent's children[]
1163 * (or root_hub) pointer.
1165 release_address(udev);
1167 /* Avoid races with recursively_mark_NOTATTACHED() */
1168 spin_lock_irq(&device_state_lock);
1170 spin_unlock_irq(&device_state_lock);
1172 put_device(&udev->dev);
1176 static void show_string(struct usb_device *udev, char *id, char *string)
1180 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1184 static inline void show_string(struct usb_device *udev, char *id, char *string)
1189 #ifdef CONFIG_USB_OTG
1190 #include "otg_whitelist.h"
1194 * usb_new_device - perform initial device setup (usbcore-internal)
1195 * @udev: newly addressed device (in ADDRESS state)
1197 * This is called with devices which have been enumerated, but not yet
1198 * configured. The device descriptor is available, but not descriptors
1199 * for any device configuration. The caller must have locked either
1200 * the parent hub (if udev is a normal device) or else the
1201 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1202 * udev has already been installed, but udev is not yet visible through
1203 * sysfs or other filesystem code.
1205 * Returns 0 for success (device is configured and listed, with its
1206 * interfaces, in sysfs); else a negative errno value.
1208 * This call is synchronous, and may not be used in an interrupt context.
1210 * Only the hub driver or root-hub registrar should ever call this.
1212 int usb_new_device(struct usb_device *udev)
1216 err = usb_get_configuration(udev);
1218 dev_err(&udev->dev, "can't read configurations, error %d\n",
1223 /* read the standard strings and cache them if present */
1224 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1225 udev->manufacturer = usb_cache_string(udev,
1226 udev->descriptor.iManufacturer);
1227 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
1229 /* Tell the world! */
1230 dev_dbg(&udev->dev, "new device strings: Mfr=%d, Product=%d, "
1231 "SerialNumber=%d\n",
1232 udev->descriptor.iManufacturer,
1233 udev->descriptor.iProduct,
1234 udev->descriptor.iSerialNumber);
1235 show_string(udev, "Product", udev->product);
1236 show_string(udev, "Manufacturer", udev->manufacturer);
1237 show_string(udev, "SerialNumber", udev->serial);
1239 #ifdef CONFIG_USB_OTG
1241 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1242 * to wake us after we've powered off VBUS; and HNP, switching roles
1243 * "host" to "peripheral". The OTG descriptor helps figure this out.
1245 if (!udev->bus->is_b_host
1247 && udev->parent == udev->bus->root_hub) {
1248 struct usb_otg_descriptor *desc = 0;
1249 struct usb_bus *bus = udev->bus;
1251 /* descriptor may appear anywhere in config */
1252 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1253 le16_to_cpu(udev->config[0].desc.wTotalLength),
1254 USB_DT_OTG, (void **) &desc) == 0) {
1255 if (desc->bmAttributes & USB_OTG_HNP) {
1256 unsigned port1 = udev->portnum;
1257 struct usb_device *root = udev->parent;
1259 dev_info(&udev->dev,
1260 "Dual-Role OTG device on %sHNP port\n",
1261 (port1 == bus->otg_port)
1264 /* enable HNP before suspend, it's simpler */
1265 if (port1 == bus->otg_port)
1266 bus->b_hnp_enable = 1;
1267 err = usb_control_msg(udev,
1268 usb_sndctrlpipe(udev, 0),
1269 USB_REQ_SET_FEATURE, 0,
1271 ? USB_DEVICE_B_HNP_ENABLE
1272 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1273 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1275 /* OTG MESSAGE: report errors here,
1276 * customize to match your product.
1278 dev_info(&udev->dev,
1279 "can't set HNP mode; %d\n",
1281 bus->b_hnp_enable = 0;
1287 if (!is_targeted(udev)) {
1289 /* Maybe it can talk to us, though we can't talk to it.
1290 * (Includes HNP test device.)
1292 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
1293 static int __usb_port_suspend(struct usb_device *,
1295 err = __usb_port_suspend(udev, udev->bus->otg_port);
1297 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1304 /* Register the device. The device driver is responsible
1305 * for adding the device files to usbfs and sysfs and for
1306 * configuring the device.
1308 err = device_add (&udev->dev);
1310 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1317 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1322 static int hub_port_status(struct usb_hub *hub, int port1,
1323 u16 *status, u16 *change)
1327 ret = get_port_status(hub->hdev, port1, &hub->status->port);
1329 dev_err (hub->intfdev,
1330 "%s failed (err = %d)\n", __FUNCTION__, ret);
1332 *status = le16_to_cpu(hub->status->port.wPortStatus);
1333 *change = le16_to_cpu(hub->status->port.wPortChange);
1339 #define PORT_RESET_TRIES 5
1340 #define SET_ADDRESS_TRIES 2
1341 #define GET_DESCRIPTOR_TRIES 2
1342 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1343 #define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1345 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1346 #define HUB_SHORT_RESET_TIME 10
1347 #define HUB_LONG_RESET_TIME 200
1348 #define HUB_RESET_TIMEOUT 500
1350 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
1351 struct usb_device *udev, unsigned int delay)
1353 int delay_time, ret;
1357 for (delay_time = 0;
1358 delay_time < HUB_RESET_TIMEOUT;
1359 delay_time += delay) {
1360 /* wait to give the device a chance to reset */
1363 /* read and decode port status */
1364 ret = hub_port_status(hub, port1, &portstatus, &portchange);
1368 /* Device went away? */
1369 if (!(portstatus & USB_PORT_STAT_CONNECTION))
1372 /* bomb out completely if something weird happened */
1373 if ((portchange & USB_PORT_STAT_C_CONNECTION))
1376 /* if we`ve finished resetting, then break out of the loop */
1377 if (!(portstatus & USB_PORT_STAT_RESET) &&
1378 (portstatus & USB_PORT_STAT_ENABLE)) {
1379 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
1380 udev->speed = USB_SPEED_HIGH;
1381 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
1382 udev->speed = USB_SPEED_LOW;
1384 udev->speed = USB_SPEED_FULL;
1388 /* switch to the long delay after two short delay failures */
1389 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
1390 delay = HUB_LONG_RESET_TIME;
1392 dev_dbg (hub->intfdev,
1393 "port %d not reset yet, waiting %dms\n",
1400 static int hub_port_reset(struct usb_hub *hub, int port1,
1401 struct usb_device *udev, unsigned int delay)
1405 /* Reset the port */
1406 for (i = 0; i < PORT_RESET_TRIES; i++) {
1407 status = set_port_feature(hub->hdev,
1408 port1, USB_PORT_FEAT_RESET);
1410 dev_err(hub->intfdev,
1411 "cannot reset port %d (err = %d)\n",
1414 status = hub_port_wait_reset(hub, port1, udev, delay);
1415 if (status && status != -ENOTCONN)
1416 dev_dbg(hub->intfdev,
1417 "port_wait_reset: err = %d\n",
1421 /* return on disconnect or reset */
1424 /* TRSTRCY = 10 ms; plus some extra */
1429 clear_port_feature(hub->hdev,
1430 port1, USB_PORT_FEAT_C_RESET);
1431 /* FIXME need disconnect() for NOTATTACHED device */
1432 usb_set_device_state(udev, status
1433 ? USB_STATE_NOTATTACHED
1434 : USB_STATE_DEFAULT);
1438 dev_dbg (hub->intfdev,
1439 "port %d not enabled, trying reset again...\n",
1441 delay = HUB_LONG_RESET_TIME;
1444 dev_err (hub->intfdev,
1445 "Cannot enable port %i. Maybe the USB cable is bad?\n",
1452 * Disable a port and mark a logical connnect-change event, so that some
1453 * time later khubd will disconnect() any existing usb_device on the port
1454 * and will re-enumerate if there actually is a device attached.
1456 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
1458 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
1459 hub_port_disable(hub, port1, 1);
1461 /* FIXME let caller ask to power down the port:
1462 * - some devices won't enumerate without a VBUS power cycle
1463 * - SRP saves power that way
1464 * - ... new call, TBD ...
1465 * That's easy if this hub can switch power per-port, and
1466 * khubd reactivates the port later (timer, SRP, etc).
1467 * Powerdown must be optional, because of reset/DFU.
1470 set_bit(port1, hub->change_bits);
1475 #ifdef CONFIG_USB_SUSPEND
1478 * Selective port suspend reduces power; most suspended devices draw
1479 * less than 500 uA. It's also used in OTG, along with remote wakeup.
1480 * All devices below the suspended port are also suspended.
1482 * Devices leave suspend state when the host wakes them up. Some devices
1483 * also support "remote wakeup", where the device can activate the USB
1484 * tree above them to deliver data, such as a keypress or packet. In
1485 * some cases, this wakes the USB host.
1487 static int hub_port_suspend(struct usb_hub *hub, int port1,
1488 struct usb_device *udev)
1492 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
1494 /* enable remote wakeup when appropriate; this lets the device
1495 * wake up the upstream hub (including maybe the root hub).
1497 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
1498 * we don't explicitly enable it here.
1500 if (device_may_wakeup(&udev->dev)) {
1501 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1502 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
1503 USB_DEVICE_REMOTE_WAKEUP, 0,
1505 USB_CTRL_SET_TIMEOUT);
1508 "won't remote wakeup, status %d\n",
1513 status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
1515 dev_dbg(hub->intfdev,
1516 "can't suspend port %d, status %d\n",
1518 /* paranoia: "should not happen" */
1519 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1520 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
1521 USB_DEVICE_REMOTE_WAKEUP, 0,
1523 USB_CTRL_SET_TIMEOUT);
1525 /* device has up to 10 msec to fully suspend */
1526 dev_dbg(&udev->dev, "usb suspend\n");
1527 usb_set_device_state(udev, USB_STATE_SUSPENDED);
1534 * Devices on USB hub ports have only one "suspend" state, corresponding
1535 * to ACPI D2, "may cause the device to lose some context".
1536 * State transitions include:
1538 * - suspend, resume ... when the VBUS power link stays live
1539 * - suspend, disconnect ... VBUS lost
1541 * Once VBUS drop breaks the circuit, the port it's using has to go through
1542 * normal re-enumeration procedures, starting with enabling VBUS power.
1543 * Other than re-initializing the hub (plug/unplug, except for root hubs),
1544 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
1545 * timer, no SRP, no requests through sysfs.
1547 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
1548 * the root hub for their bus goes into global suspend ... so we don't
1549 * (falsely) update the device power state to say it suspended.
1551 static int __usb_port_suspend (struct usb_device *udev, int port1)
1555 /* caller owns the udev device lock */
1559 /* we change the device's upstream USB link,
1560 * but root hubs have no upstream USB link.
1563 status = hub_port_suspend(hdev_to_hub(udev->parent), port1,
1566 dev_dbg(&udev->dev, "usb suspend\n");
1567 usb_set_device_state(udev, USB_STATE_SUSPENDED);
1575 * usb_port_suspend - suspend a usb device's upstream port
1576 * @udev: device that's no longer in active use
1577 * Context: must be able to sleep; device not locked; pm locks held
1579 * Suspends a USB device that isn't in active use, conserving power.
1580 * Devices may wake out of a suspend, if anything important happens,
1581 * using the remote wakeup mechanism. They may also be taken out of
1582 * suspend by the host, using usb_port_resume(). It's also routine
1583 * to disconnect devices while they are suspended.
1585 * This only affects the USB hardware for a device; its interfaces
1586 * (and, for hubs, child devices) must already have been suspended.
1588 * Suspending OTG devices may trigger HNP, if that's been enabled
1589 * between a pair of dual-role devices. That will change roles, such
1590 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
1592 * Returns 0 on success, else negative errno.
1594 int usb_port_suspend(struct usb_device *udev)
1596 #ifdef CONFIG_USB_SUSPEND
1597 return __usb_port_suspend(udev, udev->portnum);
1604 * If the USB "suspend" state is in use (rather than "global suspend"),
1605 * many devices will be individually taken out of suspend state using
1606 * special" resume" signaling. These routines kick in shortly after
1607 * hardware resume signaling is finished, either because of selective
1608 * resume (by host) or remote wakeup (by device) ... now see what changed
1609 * in the tree that's rooted at this device.
1611 static int finish_port_resume(struct usb_device *udev)
1616 /* caller owns the udev device lock */
1617 dev_dbg(&udev->dev, "finish resume\n");
1619 /* usb ch9 identifies four variants of SUSPENDED, based on what
1620 * state the device resumes to. Linux currently won't see the
1621 * first two on the host side; they'd be inside hub_port_init()
1622 * during many timeouts, but khubd can't suspend until later.
1624 usb_set_device_state(udev, udev->actconfig
1625 ? USB_STATE_CONFIGURED
1626 : USB_STATE_ADDRESS);
1628 /* 10.5.4.5 says be sure devices in the tree are still there.
1629 * For now let's assume the device didn't go crazy on resume,
1630 * and device drivers will know about any resume quirks.
1632 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
1634 status = (status == 2 ? 0 : -ENODEV);
1638 "gone after usb resume? status %d\n",
1640 else if (udev->actconfig) {
1641 le16_to_cpus(&devstatus);
1642 if ((devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
1644 status = usb_control_msg(udev,
1645 usb_sndctrlpipe(udev, 0),
1646 USB_REQ_CLEAR_FEATURE,
1648 USB_DEVICE_REMOTE_WAKEUP, 0,
1650 USB_CTRL_SET_TIMEOUT);
1652 dev_dbg(&udev->dev, "disable remote "
1653 "wakeup, status %d\n", status);
1657 } else if (udev->devnum <= 0) {
1658 dev_dbg(&udev->dev, "bogus resume!\n");
1664 #ifdef CONFIG_USB_SUSPEND
1667 hub_port_resume(struct usb_hub *hub, int port1, struct usb_device *udev)
1671 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
1673 /* see 7.1.7.7; affects power usage, but not budgeting */
1674 status = clear_port_feature(hub->hdev,
1675 port1, USB_PORT_FEAT_SUSPEND);
1677 dev_dbg(hub->intfdev,
1678 "can't resume port %d, status %d\n",
1684 /* drive resume for at least 20 msec */
1686 dev_dbg(&udev->dev, "RESUME\n");
1689 #define LIVE_FLAGS ( USB_PORT_STAT_POWER \
1690 | USB_PORT_STAT_ENABLE \
1691 | USB_PORT_STAT_CONNECTION)
1693 /* Virtual root hubs can trigger on GET_PORT_STATUS to
1694 * stop resume signaling. Then finish the resume
1697 devstatus = portchange = 0;
1698 status = hub_port_status(hub, port1,
1699 &devstatus, &portchange);
1701 || (devstatus & LIVE_FLAGS) != LIVE_FLAGS
1702 || (devstatus & USB_PORT_STAT_SUSPEND) != 0
1704 dev_dbg(hub->intfdev,
1705 "port %d status %04x.%04x after resume, %d\n",
1706 port1, portchange, devstatus, status);
1710 if (portchange & USB_PORT_STAT_C_SUSPEND)
1711 clear_port_feature(hub->hdev, port1,
1712 USB_PORT_FEAT_C_SUSPEND);
1713 /* TRSMRCY = 10 msec */
1716 status = finish_port_resume(udev);
1720 hub_port_logical_disconnect(hub, port1);
1728 * usb_port_resume - re-activate a suspended usb device's upstream port
1729 * @udev: device to re-activate
1730 * Context: must be able to sleep; device not locked; pm locks held
1732 * This will re-activate the suspended device, increasing power usage
1733 * while letting drivers communicate again with its endpoints.
1734 * USB resume explicitly guarantees that the power session between
1735 * the host and the device is the same as it was when the device
1738 * Returns 0 on success, else negative errno.
1740 int usb_port_resume(struct usb_device *udev)
1744 /* we change the device's upstream USB link,
1745 * but root hubs have no upstream USB link.
1748 #ifdef CONFIG_USB_SUSPEND
1749 // NOTE this fails if parent is also suspended...
1750 status = hub_port_resume(hdev_to_hub(udev->parent),
1751 udev->portnum, udev);
1754 status = finish_port_resume(udev);
1756 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
1760 static int remote_wakeup(struct usb_device *udev)
1764 #ifdef CONFIG_USB_SUSPEND
1766 /* don't repeat RESUME sequence if this device
1767 * was already woken up by some other task
1769 usb_lock_device(udev);
1770 if (udev->state == USB_STATE_SUSPENDED) {
1771 dev_dbg(&udev->dev, "RESUME (wakeup)\n");
1772 /* TRSMRCY = 10 msec */
1774 status = finish_port_resume(udev);
1778 usb_resume_both(udev);
1779 usb_unlock_device(udev);
1784 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
1786 struct usb_hub *hub = usb_get_intfdata (intf);
1787 struct usb_device *hdev = hub->hdev;
1790 /* fail if children aren't already suspended */
1791 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
1792 struct usb_device *udev;
1794 udev = hdev->children [port1-1];
1795 if (udev && msg.event == PM_EVENT_SUSPEND &&
1796 #ifdef CONFIG_USB_SUSPEND
1797 udev->state != USB_STATE_SUSPENDED
1799 udev->dev.power.power_state.event
1803 dev_dbg(&intf->dev, "port %d nyet suspended\n", port1);
1808 /* "global suspend" of the downstream HC-to-USB interface */
1809 if (!hdev->parent) {
1810 struct usb_bus *bus = hdev->bus;
1812 int status = hcd_bus_suspend (bus);
1815 dev_dbg(&hdev->dev, "'global' suspend %d\n",
1823 /* stop khubd and related activity */
1828 static int hub_resume(struct usb_interface *intf)
1830 struct usb_device *hdev = interface_to_usbdev(intf);
1831 struct usb_hub *hub = usb_get_intfdata (intf);
1834 /* "global resume" of the downstream HC-to-USB interface */
1835 if (!hdev->parent) {
1836 struct usb_bus *bus = hdev->bus;
1838 status = hcd_bus_resume (bus);
1840 dev_dbg(&intf->dev, "'global' resume %d\n",
1847 /* TRSMRCY = 10 msec */
1852 /* tell khubd to look for changes on this hub */
1857 void usb_suspend_root_hub(struct usb_device *hdev)
1859 struct usb_hub *hub = hdev_to_hub(hdev);
1861 /* This also makes any led blinker stop retriggering. We're called
1862 * from irq, so the blinker might still be scheduled. Caller promises
1863 * that the root hub status URB will be canceled.
1866 mark_quiesced(to_usb_interface(hub->intfdev));
1869 void usb_resume_root_hub(struct usb_device *hdev)
1871 struct usb_hub *hub = hdev_to_hub(hdev);
1873 hub->resume_root_hub = 1;
1878 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
1880 * Between connect detection and reset signaling there must be a delay
1881 * of 100ms at least for debounce and power-settling. The corresponding
1882 * timer shall restart whenever the downstream port detects a disconnect.
1884 * Apparently there are some bluetooth and irda-dongles and a number of
1885 * low-speed devices for which this debounce period may last over a second.
1886 * Not covered by the spec - but easy to deal with.
1888 * This implementation uses a 1500ms total debounce timeout; if the
1889 * connection isn't stable by then it returns -ETIMEDOUT. It checks
1890 * every 25ms for transient disconnects. When the port status has been
1891 * unchanged for 100ms it returns the port status.
1894 #define HUB_DEBOUNCE_TIMEOUT 1500
1895 #define HUB_DEBOUNCE_STEP 25
1896 #define HUB_DEBOUNCE_STABLE 100
1898 static int hub_port_debounce(struct usb_hub *hub, int port1)
1901 int total_time, stable_time = 0;
1902 u16 portchange, portstatus;
1903 unsigned connection = 0xffff;
1905 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
1906 ret = hub_port_status(hub, port1, &portstatus, &portchange);
1910 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
1911 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
1912 stable_time += HUB_DEBOUNCE_STEP;
1913 if (stable_time >= HUB_DEBOUNCE_STABLE)
1917 connection = portstatus & USB_PORT_STAT_CONNECTION;
1920 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1921 clear_port_feature(hub->hdev, port1,
1922 USB_PORT_FEAT_C_CONNECTION);
1925 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
1927 msleep(HUB_DEBOUNCE_STEP);
1930 dev_dbg (hub->intfdev,
1931 "debounce: port %d: total %dms stable %dms status 0x%x\n",
1932 port1, total_time, stable_time, portstatus);
1934 if (stable_time < HUB_DEBOUNCE_STABLE)
1939 static void ep0_reinit(struct usb_device *udev)
1941 usb_disable_endpoint(udev, 0 + USB_DIR_IN);
1942 usb_disable_endpoint(udev, 0 + USB_DIR_OUT);
1943 udev->ep_in[0] = udev->ep_out[0] = &udev->ep0;
1946 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
1947 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
1949 static int hub_set_address(struct usb_device *udev)
1953 if (udev->devnum == 0)
1955 if (udev->state == USB_STATE_ADDRESS)
1957 if (udev->state != USB_STATE_DEFAULT)
1959 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
1960 USB_REQ_SET_ADDRESS, 0, udev->devnum, 0,
1961 NULL, 0, USB_CTRL_SET_TIMEOUT);
1963 usb_set_device_state(udev, USB_STATE_ADDRESS);
1969 /* Reset device, (re)assign address, get device descriptor.
1970 * Device connection must be stable, no more debouncing needed.
1971 * Returns device in USB_STATE_ADDRESS, except on error.
1973 * If this is called for an already-existing device (as part of
1974 * usb_reset_device), the caller must own the device lock. For a
1975 * newly detected device that is not accessible through any global
1976 * pointers, it's not necessary to lock the device.
1979 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
1982 static DEFINE_MUTEX(usb_address0_mutex);
1984 struct usb_device *hdev = hub->hdev;
1986 unsigned delay = HUB_SHORT_RESET_TIME;
1987 enum usb_device_speed oldspeed = udev->speed;
1989 /* root hub ports have a slightly longer reset period
1990 * (from USB 2.0 spec, section 7.1.7.5)
1992 if (!hdev->parent) {
1993 delay = HUB_ROOT_RESET_TIME;
1994 if (port1 == hdev->bus->otg_port)
1995 hdev->bus->b_hnp_enable = 0;
1998 /* Some low speed devices have problems with the quick delay, so */
1999 /* be a bit pessimistic with those devices. RHbug #23670 */
2000 if (oldspeed == USB_SPEED_LOW)
2001 delay = HUB_LONG_RESET_TIME;
2003 mutex_lock(&usb_address0_mutex);
2005 /* Reset the device; full speed may morph to high speed */
2006 retval = hub_port_reset(hub, port1, udev, delay);
2007 if (retval < 0) /* error or disconnect */
2009 /* success, speed is known */
2012 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2013 dev_dbg(&udev->dev, "device reset changed speed!\n");
2016 oldspeed = udev->speed;
2018 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2019 * it's fixed size except for full speed devices.
2021 switch (udev->speed) {
2022 case USB_SPEED_HIGH: /* fixed at 64 */
2023 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2025 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
2026 /* to determine the ep0 maxpacket size, try to read
2027 * the device descriptor to get bMaxPacketSize0 and
2028 * then correct our initial guess.
2030 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2032 case USB_SPEED_LOW: /* fixed at 8 */
2033 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(8);
2039 dev_info (&udev->dev,
2040 "%s %s speed USB device using %s and address %d\n",
2041 (udev->config) ? "reset" : "new",
2042 ({ char *speed; switch (udev->speed) {
2043 case USB_SPEED_LOW: speed = "low"; break;
2044 case USB_SPEED_FULL: speed = "full"; break;
2045 case USB_SPEED_HIGH: speed = "high"; break;
2046 default: speed = "?"; break;
2048 udev->bus->controller->driver->name,
2051 /* Set up TT records, if needed */
2053 udev->tt = hdev->tt;
2054 udev->ttport = hdev->ttport;
2055 } else if (udev->speed != USB_SPEED_HIGH
2056 && hdev->speed == USB_SPEED_HIGH) {
2057 udev->tt = &hub->tt;
2058 udev->ttport = port1;
2061 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2062 * Because device hardware and firmware is sometimes buggy in
2063 * this area, and this is how Linux has done it for ages.
2064 * Change it cautiously.
2066 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2067 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2068 * so it may help with some non-standards-compliant devices.
2069 * Otherwise we start with SET_ADDRESS and then try to read the
2070 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2073 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
2074 if (USE_NEW_SCHEME(retry_counter)) {
2075 struct usb_device_descriptor *buf;
2078 #define GET_DESCRIPTOR_BUFSIZE 64
2079 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2085 /* Use a short timeout the first time through,
2086 * so that recalcitrant full-speed devices with
2087 * 8- or 16-byte ep0-maxpackets won't slow things
2088 * down tremendously by NAKing the unexpectedly
2089 * early status stage. Also, retry on all errors;
2090 * some devices are flakey.
2092 for (j = 0; j < 3; ++j) {
2093 buf->bMaxPacketSize0 = 0;
2094 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2095 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2096 USB_DT_DEVICE << 8, 0,
2097 buf, GET_DESCRIPTOR_BUFSIZE,
2098 (i ? USB_CTRL_GET_TIMEOUT : 1000));
2099 switch (buf->bMaxPacketSize0) {
2100 case 8: case 16: case 32: case 64:
2101 if (buf->bDescriptorType ==
2115 udev->descriptor.bMaxPacketSize0 =
2116 buf->bMaxPacketSize0;
2119 retval = hub_port_reset(hub, port1, udev, delay);
2120 if (retval < 0) /* error or disconnect */
2122 if (oldspeed != udev->speed) {
2124 "device reset changed speed!\n");
2129 dev_err(&udev->dev, "device descriptor "
2130 "read/%s, error %d\n",
2135 #undef GET_DESCRIPTOR_BUFSIZE
2138 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
2139 retval = hub_set_address(udev);
2146 "device not accepting address %d, error %d\n",
2147 udev->devnum, retval);
2151 /* cope with hardware quirkiness:
2152 * - let SET_ADDRESS settle, some device hardware wants it
2153 * - read ep0 maxpacket even for high and low speed,
2156 if (USE_NEW_SCHEME(retry_counter))
2159 retval = usb_get_device_descriptor(udev, 8);
2161 dev_err(&udev->dev, "device descriptor "
2162 "read/%s, error %d\n",
2174 i = udev->descriptor.bMaxPacketSize0;
2175 if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
2176 if (udev->speed != USB_SPEED_FULL ||
2177 !(i == 8 || i == 16 || i == 32 || i == 64)) {
2178 dev_err(&udev->dev, "ep0 maxpacket = %d\n", i);
2182 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
2183 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
2187 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
2188 if (retval < (signed)sizeof(udev->descriptor)) {
2189 dev_err(&udev->dev, "device descriptor read/%s, error %d\n",
2200 hub_port_disable(hub, port1, 0);
2201 mutex_unlock(&usb_address0_mutex);
2206 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
2208 struct usb_qualifier_descriptor *qual;
2211 qual = kmalloc (sizeof *qual, SLAB_KERNEL);
2215 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
2216 qual, sizeof *qual);
2217 if (status == sizeof *qual) {
2218 dev_info(&udev->dev, "not running at top speed; "
2219 "connect to a high speed hub\n");
2220 /* hub LEDs are probably harder to miss than syslog */
2221 if (hub->has_indicators) {
2222 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
2223 schedule_work (&hub->leds);
2230 hub_power_remaining (struct usb_hub *hub)
2232 struct usb_device *hdev = hub->hdev;
2236 if (!hub->limited_power)
2239 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
2240 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
2241 struct usb_device *udev = hdev->children[port1 - 1];
2247 /* Unconfigured devices may not use more than 100mA,
2248 * or 8mA for OTG ports */
2249 if (udev->actconfig)
2250 delta = udev->actconfig->desc.bMaxPower * 2;
2251 else if (port1 != udev->bus->otg_port || hdev->parent)
2255 if (delta > hub->mA_per_port)
2256 dev_warn(&udev->dev, "%dmA is over %umA budget "
2258 delta, hub->mA_per_port, port1);
2261 if (remaining < 0) {
2262 dev_warn(hub->intfdev, "%dmA over power budget!\n",
2269 /* Handle physical or logical connection change events.
2270 * This routine is called when:
2271 * a port connection-change occurs;
2272 * a port enable-change occurs (often caused by EMI);
2273 * usb_reset_device() encounters changed descriptors (as from
2274 * a firmware download)
2275 * caller already locked the hub
2277 static void hub_port_connect_change(struct usb_hub *hub, int port1,
2278 u16 portstatus, u16 portchange)
2280 struct usb_device *hdev = hub->hdev;
2281 struct device *hub_dev = hub->intfdev;
2282 u16 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2286 "port %d, status %04x, change %04x, %s\n",
2287 port1, portstatus, portchange, portspeed (portstatus));
2289 if (hub->has_indicators) {
2290 set_port_led(hub, port1, HUB_LED_AUTO);
2291 hub->indicator[port1-1] = INDICATOR_AUTO;
2294 /* Disconnect any existing devices under this port */
2295 if (hdev->children[port1-1])
2296 usb_disconnect(&hdev->children[port1-1]);
2297 clear_bit(port1, hub->change_bits);
2299 #ifdef CONFIG_USB_OTG
2300 /* during HNP, don't repeat the debounce */
2301 if (hdev->bus->is_b_host)
2302 portchange &= ~USB_PORT_STAT_C_CONNECTION;
2305 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2306 status = hub_port_debounce(hub, port1);
2309 "connect-debounce failed, port %d disabled\n",
2313 portstatus = status;
2316 /* Return now if nothing is connected */
2317 if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
2319 /* maybe switch power back on (e.g. root hub was reset) */
2320 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
2321 && !(portstatus & (1 << USB_PORT_FEAT_POWER)))
2322 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
2324 if (portstatus & USB_PORT_STAT_ENABLE)
2329 #ifdef CONFIG_USB_SUSPEND
2330 /* If something is connected, but the port is suspended, wake it up. */
2331 if (portstatus & USB_PORT_STAT_SUSPEND) {
2332 status = hub_port_resume(hub, port1, NULL);
2335 "can't clear suspend on port %d; %d\n",
2342 for (i = 0; i < SET_CONFIG_TRIES; i++) {
2343 struct usb_device *udev;
2345 /* reallocate for each attempt, since references
2346 * to the previous one can escape in various ways
2348 udev = usb_alloc_dev(hdev, hdev->bus, port1);
2351 "couldn't allocate port %d usb_device\n",
2356 usb_set_device_state(udev, USB_STATE_POWERED);
2357 udev->speed = USB_SPEED_UNKNOWN;
2358 udev->bus_mA = hub->mA_per_port;
2360 /* set the address */
2361 choose_address(udev);
2362 if (udev->devnum <= 0) {
2363 status = -ENOTCONN; /* Don't retry */
2367 /* reset and get descriptor */
2368 status = hub_port_init(hub, udev, port1, i);
2372 /* consecutive bus-powered hubs aren't reliable; they can
2373 * violate the voltage drop budget. if the new child has
2374 * a "powered" LED, users should notice we didn't enable it
2375 * (without reading syslog), even without per-port LEDs
2378 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
2379 && udev->bus_mA <= 100) {
2382 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
2385 dev_dbg(&udev->dev, "get status %d ?\n", status);
2388 le16_to_cpus(&devstat);
2389 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
2391 "can't connect bus-powered hub "
2393 if (hub->has_indicators) {
2394 hub->indicator[port1-1] =
2395 INDICATOR_AMBER_BLINK;
2396 schedule_work (&hub->leds);
2398 status = -ENOTCONN; /* Don't retry */
2403 /* check for devices running slower than they could */
2404 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
2405 && udev->speed == USB_SPEED_FULL
2406 && highspeed_hubs != 0)
2407 check_highspeed (hub, udev, port1);
2409 /* Store the parent's children[] pointer. At this point
2410 * udev becomes globally accessible, although presumably
2411 * no one will look at it until hdev is unlocked.
2415 /* We mustn't add new devices if the parent hub has
2416 * been disconnected; we would race with the
2417 * recursively_mark_NOTATTACHED() routine.
2419 spin_lock_irq(&device_state_lock);
2420 if (hdev->state == USB_STATE_NOTATTACHED)
2423 hdev->children[port1-1] = udev;
2424 spin_unlock_irq(&device_state_lock);
2426 /* Run it through the hoops (find a driver, etc) */
2428 status = usb_new_device(udev);
2430 spin_lock_irq(&device_state_lock);
2431 hdev->children[port1-1] = NULL;
2432 spin_unlock_irq(&device_state_lock);
2439 status = hub_power_remaining(hub);
2441 dev_dbg(hub_dev, "%dmA power budget left\n", status);
2446 hub_port_disable(hub, port1, 1);
2449 release_address(udev);
2451 if (status == -ENOTCONN)
2456 hub_port_disable(hub, port1, 1);
2459 static void hub_events(void)
2461 struct list_head *tmp;
2462 struct usb_device *hdev;
2463 struct usb_interface *intf;
2464 struct usb_hub *hub;
2465 struct device *hub_dev;
2474 * We restart the list every time to avoid a deadlock with
2475 * deleting hubs downstream from this one. This should be
2476 * safe since we delete the hub from the event list.
2477 * Not the most efficient, but avoids deadlocks.
2481 /* Grab the first entry at the beginning of the list */
2482 spin_lock_irq(&hub_event_lock);
2483 if (list_empty(&hub_event_list)) {
2484 spin_unlock_irq(&hub_event_lock);
2488 tmp = hub_event_list.next;
2491 hub = list_entry(tmp, struct usb_hub, event_list);
2493 intf = to_usb_interface(hub->intfdev);
2494 hub_dev = &intf->dev;
2496 i = hub->resume_root_hub;
2498 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x%s\n",
2499 hdev->state, hub->descriptor
2500 ? hub->descriptor->bNbrPorts
2502 /* NOTE: expects max 15 ports... */
2503 (u16) hub->change_bits[0],
2504 (u16) hub->event_bits[0],
2505 i ? ", resume root" : "");
2508 spin_unlock_irq(&hub_event_lock);
2510 /* Lock the device, then check to see if we were
2511 * disconnected while waiting for the lock to succeed. */
2512 if (locktree(hdev) < 0) {
2516 if (hub != usb_get_intfdata(intf))
2519 /* If the hub has died, clean up after it */
2520 if (hdev->state == USB_STATE_NOTATTACHED) {
2521 hub->error = -ENODEV;
2522 hub_pre_reset(intf);
2526 /* Is this is a root hub wanting to reactivate the downstream
2527 * ports? If so, be sure the interface resumes even if its
2528 * stub "device" node was never suspended.
2531 usb_resume_both(hdev);
2533 /* If this is an inactive or suspended hub, do nothing */
2538 dev_dbg (hub_dev, "resetting for error %d\n",
2541 ret = usb_reset_composite_device(hdev, intf);
2544 "error resetting hub: %d\n", ret);
2552 /* deal with port status changes */
2553 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
2554 if (test_bit(i, hub->busy_bits))
2556 connect_change = test_bit(i, hub->change_bits);
2557 if (!test_and_clear_bit(i, hub->event_bits) &&
2558 !connect_change && !hub->activating)
2561 ret = hub_port_status(hub, i,
2562 &portstatus, &portchange);
2566 if (hub->activating && !hdev->children[i-1] &&
2568 USB_PORT_STAT_CONNECTION))
2571 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2572 clear_port_feature(hdev, i,
2573 USB_PORT_FEAT_C_CONNECTION);
2577 if (portchange & USB_PORT_STAT_C_ENABLE) {
2578 if (!connect_change)
2580 "port %d enable change, "
2583 clear_port_feature(hdev, i,
2584 USB_PORT_FEAT_C_ENABLE);
2587 * EM interference sometimes causes badly
2588 * shielded USB devices to be shutdown by
2589 * the hub, this hack enables them again.
2590 * Works at least with mouse driver.
2592 if (!(portstatus & USB_PORT_STAT_ENABLE)
2594 && hdev->children[i-1]) {
2597 "disabled by hub (EMI?), "
2604 if (portchange & USB_PORT_STAT_C_SUSPEND) {
2605 clear_port_feature(hdev, i,
2606 USB_PORT_FEAT_C_SUSPEND);
2607 if (hdev->children[i-1]) {
2608 ret = remote_wakeup(hdev->
2614 hub_port_disable(hub, i, 1);
2617 "resume on port %d, status %d\n",
2621 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
2623 "over-current change on port %d\n",
2625 clear_port_feature(hdev, i,
2626 USB_PORT_FEAT_C_OVER_CURRENT);
2630 if (portchange & USB_PORT_STAT_C_RESET) {
2632 "reset change on port %d\n",
2634 clear_port_feature(hdev, i,
2635 USB_PORT_FEAT_C_RESET);
2639 hub_port_connect_change(hub, i,
2640 portstatus, portchange);
2643 /* deal with hub status changes */
2644 if (test_and_clear_bit(0, hub->event_bits) == 0)
2646 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
2647 dev_err (hub_dev, "get_hub_status failed\n");
2649 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
2650 dev_dbg (hub_dev, "power change\n");
2651 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
2652 if (hubstatus & HUB_STATUS_LOCAL_POWER)
2653 /* FIXME: Is this always true? */
2654 hub->limited_power = 0;
2656 hub->limited_power = 1;
2658 if (hubchange & HUB_CHANGE_OVERCURRENT) {
2659 dev_dbg (hub_dev, "overcurrent change\n");
2660 msleep(500); /* Cool down */
2661 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
2666 hub->activating = 0;
2668 /* If this is a root hub, tell the HCD it's okay to
2669 * re-enable port-change interrupts now. */
2671 usb_enable_root_hub_irq(hdev->bus);
2674 usb_unlock_device(hdev);
2677 } /* end while (1) */
2680 static int hub_thread(void *__unused)
2684 wait_event_interruptible(khubd_wait,
2685 !list_empty(&hub_event_list) ||
2686 kthread_should_stop());
2688 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
2690 pr_debug("%s: khubd exiting\n", usbcore_name);
2694 static struct usb_device_id hub_id_table [] = {
2695 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
2696 .bDeviceClass = USB_CLASS_HUB},
2697 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
2698 .bInterfaceClass = USB_CLASS_HUB},
2699 { } /* Terminating entry */
2702 MODULE_DEVICE_TABLE (usb, hub_id_table);
2704 static struct usb_driver hub_driver = {
2707 .disconnect = hub_disconnect,
2708 .suspend = hub_suspend,
2709 .resume = hub_resume,
2710 .pre_reset = hub_pre_reset,
2711 .post_reset = hub_post_reset,
2713 .id_table = hub_id_table,
2716 int usb_hub_init(void)
2718 if (usb_register(&hub_driver) < 0) {
2719 printk(KERN_ERR "%s: can't register hub driver\n",
2724 khubd_task = kthread_run(hub_thread, NULL, "khubd");
2725 if (!IS_ERR(khubd_task))
2728 /* Fall through if kernel_thread failed */
2729 usb_deregister(&hub_driver);
2730 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
2735 void usb_hub_cleanup(void)
2737 kthread_stop(khubd_task);
2740 * Hub resources are freed for us by usb_deregister. It calls
2741 * usb_driver_purge on every device which in turn calls that
2742 * devices disconnect function if it is using this driver.
2743 * The hub_disconnect function takes care of releasing the
2744 * individual hub resources. -greg
2746 usb_deregister(&hub_driver);
2747 } /* usb_hub_cleanup() */
2749 static int config_descriptors_changed(struct usb_device *udev)
2753 struct usb_config_descriptor *buf;
2755 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2756 if (len < le16_to_cpu(udev->config[index].desc.wTotalLength))
2757 len = le16_to_cpu(udev->config[index].desc.wTotalLength);
2759 buf = kmalloc (len, SLAB_KERNEL);
2761 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
2762 /* assume the worst */
2765 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2767 int old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
2769 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
2771 if (length < old_length) {
2772 dev_dbg(&udev->dev, "config index %d, error %d\n",
2776 if (memcmp (buf, udev->rawdescriptors[index], old_length)
2778 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
2779 index, buf->bConfigurationValue);
2784 return index != udev->descriptor.bNumConfigurations;
2788 * usb_reset_device - perform a USB port reset to reinitialize a device
2789 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
2791 * WARNING - don't use this routine to reset a composite device
2792 * (one with multiple interfaces owned by separate drivers)!
2793 * Use usb_reset_composite_device() instead.
2795 * Do a port reset, reassign the device's address, and establish its
2796 * former operating configuration. If the reset fails, or the device's
2797 * descriptors change from their values before the reset, or the original
2798 * configuration and altsettings cannot be restored, a flag will be set
2799 * telling khubd to pretend the device has been disconnected and then
2800 * re-connected. All drivers will be unbound, and the device will be
2801 * re-enumerated and probed all over again.
2803 * Returns 0 if the reset succeeded, -ENODEV if the device has been
2804 * flagged for logical disconnection, or some other negative error code
2805 * if the reset wasn't even attempted.
2807 * The caller must own the device lock. For example, it's safe to use
2808 * this from a driver probe() routine after downloading new firmware.
2809 * For calls that might not occur during probe(), drivers should lock
2810 * the device using usb_lock_device_for_reset().
2812 int usb_reset_device(struct usb_device *udev)
2814 struct usb_device *parent_hdev = udev->parent;
2815 struct usb_hub *parent_hub;
2816 struct usb_device_descriptor descriptor = udev->descriptor;
2818 int port1 = udev->portnum;
2820 if (udev->state == USB_STATE_NOTATTACHED ||
2821 udev->state == USB_STATE_SUSPENDED) {
2822 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
2828 /* this requires hcd-specific logic; see OHCI hc_restart() */
2829 dev_dbg(&udev->dev, "%s for root hub!\n", __FUNCTION__);
2832 parent_hub = hdev_to_hub(parent_hdev);
2834 set_bit(port1, parent_hub->busy_bits);
2835 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
2837 /* ep0 maxpacket size may change; let the HCD know about it.
2838 * Other endpoints will be handled by re-enumeration. */
2840 ret = hub_port_init(parent_hub, udev, port1, i);
2844 clear_bit(port1, parent_hub->busy_bits);
2848 /* Device might have changed firmware (DFU or similar) */
2849 if (memcmp(&udev->descriptor, &descriptor, sizeof descriptor)
2850 || config_descriptors_changed (udev)) {
2851 dev_info(&udev->dev, "device firmware changed\n");
2852 udev->descriptor = descriptor; /* for disconnect() calls */
2856 if (!udev->actconfig)
2859 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2860 USB_REQ_SET_CONFIGURATION, 0,
2861 udev->actconfig->desc.bConfigurationValue, 0,
2862 NULL, 0, USB_CTRL_SET_TIMEOUT);
2865 "can't restore configuration #%d (error=%d)\n",
2866 udev->actconfig->desc.bConfigurationValue, ret);
2869 usb_set_device_state(udev, USB_STATE_CONFIGURED);
2871 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
2872 struct usb_interface *intf = udev->actconfig->interface[i];
2873 struct usb_interface_descriptor *desc;
2875 /* set_interface resets host side toggle even
2876 * for altsetting zero. the interface may have no driver.
2878 desc = &intf->cur_altsetting->desc;
2879 ret = usb_set_interface(udev, desc->bInterfaceNumber,
2880 desc->bAlternateSetting);
2882 dev_err(&udev->dev, "failed to restore interface %d "
2883 "altsetting %d (error=%d)\n",
2884 desc->bInterfaceNumber,
2885 desc->bAlternateSetting,
2895 hub_port_logical_disconnect(parent_hub, port1);
2898 EXPORT_SYMBOL(usb_reset_device);
2901 * usb_reset_composite_device - warn interface drivers and perform a USB port reset
2902 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
2903 * @iface: interface bound to the driver making the request (optional)
2905 * Warns all drivers bound to registered interfaces (using their pre_reset
2906 * method), performs the port reset, and then lets the drivers know that
2907 * the reset is over (using their post_reset method).
2909 * Return value is the same as for usb_reset_device().
2911 * The caller must own the device lock. For example, it's safe to use
2912 * this from a driver probe() routine after downloading new firmware.
2913 * For calls that might not occur during probe(), drivers should lock
2914 * the device using usb_lock_device_for_reset().
2916 * The interface locks are acquired during the pre_reset stage and released
2917 * during the post_reset stage. However if iface is not NULL and is
2918 * currently being probed, we assume that the caller already owns its
2921 int usb_reset_composite_device(struct usb_device *udev,
2922 struct usb_interface *iface)
2925 struct usb_host_config *config = udev->actconfig;
2927 if (udev->state == USB_STATE_NOTATTACHED ||
2928 udev->state == USB_STATE_SUSPENDED) {
2929 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
2934 if (iface && iface->condition != USB_INTERFACE_BINDING)
2939 struct usb_interface *cintf;
2940 struct usb_driver *drv;
2942 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
2943 cintf = config->interface[i];
2945 down(&cintf->dev.sem);
2946 if (device_is_registered(&cintf->dev) &&
2947 cintf->dev.driver) {
2948 drv = to_usb_driver(cintf->dev.driver);
2950 (drv->pre_reset)(cintf);
2955 ret = usb_reset_device(udev);
2959 struct usb_interface *cintf;
2960 struct usb_driver *drv;
2962 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
2963 cintf = config->interface[i];
2964 if (device_is_registered(&cintf->dev) &&
2965 cintf->dev.driver) {
2966 drv = to_usb_driver(cintf->dev.driver);
2967 if (drv->post_reset)
2968 (drv->post_reset)(cintf);
2971 up(&cintf->dev.sem);
2977 EXPORT_SYMBOL(usb_reset_composite_device);