4 * (C) Copyright 1999 Linus Torvalds
5 * (C) Copyright 1999 Johannes Erdfelt
6 * (C) Copyright 1999 Gregory P. Smith
7 * (C) Copyright 2001 Brad Hards (bhards@bigpond.net.au)
11 #include <linux/config.h>
12 #ifdef CONFIG_USB_DEBUG
17 #include <linux/kernel.h>
18 #include <linux/errno.h>
19 #include <linux/module.h>
20 #include <linux/moduleparam.h>
21 #include <linux/completion.h>
22 #include <linux/sched.h>
23 #include <linux/list.h>
24 #include <linux/slab.h>
25 #include <linux/smp_lock.h>
26 #include <linux/ioctl.h>
27 #include <linux/usb.h>
28 #include <linux/usbdevice_fs.h>
30 #include <asm/semaphore.h>
31 #include <asm/uaccess.h>
32 #include <asm/byteorder.h>
38 /* Protect struct usb_device->state and ->children members
39 * Note: Both are also protected by ->serialize, except that ->state can
40 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
41 static DEFINE_SPINLOCK(device_state_lock);
43 /* khubd's worklist and its lock */
44 static DEFINE_SPINLOCK(hub_event_lock);
45 static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
48 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
50 static pid_t khubd_pid = 0; /* PID of khubd */
51 static DECLARE_COMPLETION(khubd_exited);
53 /* cycle leds on hubs that aren't blinking for attention */
54 static int blinkenlights = 0;
55 module_param (blinkenlights, bool, S_IRUGO);
56 MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
59 * As of 2.6.10 we introduce a new USB device initialization scheme which
60 * closely resembles the way Windows works. Hopefully it will be compatible
61 * with a wider range of devices than the old scheme. However some previously
62 * working devices may start giving rise to "device not accepting address"
63 * errors; if that happens the user can try the old scheme by adjusting the
64 * following module parameters.
66 * For maximum flexibility there are two boolean parameters to control the
67 * hub driver's behavior. On the first initialization attempt, if the
68 * "old_scheme_first" parameter is set then the old scheme will be used,
69 * otherwise the new scheme is used. If that fails and "use_both_schemes"
70 * is set, then the driver will make another attempt, using the other scheme.
72 static int old_scheme_first = 0;
73 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
74 MODULE_PARM_DESC(old_scheme_first,
75 "start with the old device initialization scheme");
77 static int use_both_schemes = 0;
78 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
79 MODULE_PARM_DESC(use_both_schemes,
80 "try the other device initialization scheme if the "
85 static inline char *portspeed (int portstatus)
87 if (portstatus & (1 << USB_PORT_FEAT_HIGHSPEED))
89 else if (portstatus & (1 << USB_PORT_FEAT_LOWSPEED))
96 /* Note that hdev or one of its children must be locked! */
97 static inline struct usb_hub *hdev_to_hub(struct usb_device *hdev)
99 return usb_get_intfdata(hdev->actconfig->interface[0]);
102 /* USB 2.0 spec Section 11.24.4.5 */
103 static int get_hub_descriptor(struct usb_device *hdev, void *data, int size)
107 for (i = 0; i < 3; i++) {
108 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
109 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
110 USB_DT_HUB << 8, 0, data, size,
111 HZ * USB_CTRL_GET_TIMEOUT);
112 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
119 * USB 2.0 spec Section 11.24.2.1
121 static int clear_hub_feature(struct usb_device *hdev, int feature)
123 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
124 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, HZ);
128 * USB 2.0 spec Section 11.24.2.2
130 static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
132 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
133 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
138 * USB 2.0 spec Section 11.24.2.13
140 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
142 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
143 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
148 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
149 * for info about using port indicators
151 static void set_port_led(
157 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
158 USB_PORT_FEAT_INDICATOR);
160 dev_dbg (hub->intfdev,
161 "port %d indicator %s status %d\n",
163 ({ char *s; switch (selector) {
164 case HUB_LED_AMBER: s = "amber"; break;
165 case HUB_LED_GREEN: s = "green"; break;
166 case HUB_LED_OFF: s = "off"; break;
167 case HUB_LED_AUTO: s = "auto"; break;
168 default: s = "??"; break;
173 #define LED_CYCLE_PERIOD ((2*HZ)/3)
175 static void led_work (void *__hub)
177 struct usb_hub *hub = __hub;
178 struct usb_device *hdev = hub->hdev;
180 unsigned changed = 0;
183 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
186 for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
187 unsigned selector, mode;
189 /* 30%-50% duty cycle */
191 switch (hub->indicator[i]) {
193 case INDICATOR_CYCLE:
195 selector = HUB_LED_AUTO;
196 mode = INDICATOR_AUTO;
198 /* blinking green = sw attention */
199 case INDICATOR_GREEN_BLINK:
200 selector = HUB_LED_GREEN;
201 mode = INDICATOR_GREEN_BLINK_OFF;
203 case INDICATOR_GREEN_BLINK_OFF:
204 selector = HUB_LED_OFF;
205 mode = INDICATOR_GREEN_BLINK;
207 /* blinking amber = hw attention */
208 case INDICATOR_AMBER_BLINK:
209 selector = HUB_LED_AMBER;
210 mode = INDICATOR_AMBER_BLINK_OFF;
212 case INDICATOR_AMBER_BLINK_OFF:
213 selector = HUB_LED_OFF;
214 mode = INDICATOR_AMBER_BLINK;
216 /* blink green/amber = reserved */
217 case INDICATOR_ALT_BLINK:
218 selector = HUB_LED_GREEN;
219 mode = INDICATOR_ALT_BLINK_OFF;
221 case INDICATOR_ALT_BLINK_OFF:
222 selector = HUB_LED_AMBER;
223 mode = INDICATOR_ALT_BLINK;
228 if (selector != HUB_LED_AUTO)
230 set_port_led(hub, i + 1, selector);
231 hub->indicator[i] = mode;
233 if (!changed && blinkenlights) {
235 cursor %= hub->descriptor->bNbrPorts;
236 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
237 hub->indicator[cursor] = INDICATOR_CYCLE;
241 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
244 /* use a short timeout for hub/port status fetches */
245 #define USB_STS_TIMEOUT 1
246 #define USB_STS_RETRIES 5
249 * USB 2.0 spec Section 11.24.2.6
251 static int get_hub_status(struct usb_device *hdev,
252 struct usb_hub_status *data)
254 int i, status = -ETIMEDOUT;
256 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
257 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
258 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
259 data, sizeof(*data), HZ * USB_STS_TIMEOUT);
265 * USB 2.0 spec Section 11.24.2.7
267 static int get_port_status(struct usb_device *hdev, int port1,
268 struct usb_port_status *data)
270 int i, status = -ETIMEDOUT;
272 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
273 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
274 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
275 data, sizeof(*data), HZ * USB_STS_TIMEOUT);
280 static void kick_khubd(struct usb_hub *hub)
284 spin_lock_irqsave(&hub_event_lock, flags);
285 if (list_empty(&hub->event_list)) {
286 list_add_tail(&hub->event_list, &hub_event_list);
287 wake_up(&khubd_wait);
289 spin_unlock_irqrestore(&hub_event_lock, flags);
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 * @dev: 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)
434 /* if hub supports power switching, enable power on each port */
435 if ((hub->descriptor->wHubCharacteristics & HUB_CHAR_LPSM) < 2) {
436 dev_dbg(hub->intfdev, "enabling power on all ports\n");
437 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
438 set_port_feature(hub->hdev, port1,
439 USB_PORT_FEAT_POWER);
442 /* Wait for power to be enabled */
443 msleep(hub->descriptor->bPwrOn2PwrGood * 2);
446 static void hub_quiesce(struct usb_hub *hub)
448 /* stop khubd and related activity */
450 usb_kill_urb(hub->urb);
451 if (hub->has_indicators)
452 cancel_delayed_work(&hub->leds);
453 if (hub->has_indicators || hub->tt.hub)
454 flush_scheduled_work();
457 static void hub_activate(struct usb_hub *hub)
462 status = usb_submit_urb(hub->urb, GFP_NOIO);
464 dev_err(hub->intfdev, "activate --> %d\n", status);
465 if (hub->has_indicators && blinkenlights)
466 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
468 /* scan all ports ASAP */
469 hub->event_bits[0] = (1UL << (hub->descriptor->bNbrPorts + 1)) - 1;
473 static int hub_hub_status(struct usb_hub *hub,
474 u16 *status, u16 *change)
478 ret = get_hub_status(hub->hdev, &hub->status->hub);
480 dev_err (hub->intfdev,
481 "%s failed (err = %d)\n", __FUNCTION__, ret);
483 *status = le16_to_cpu(hub->status->hub.wHubStatus);
484 *change = le16_to_cpu(hub->status->hub.wHubChange);
490 static int hub_configure(struct usb_hub *hub,
491 struct usb_endpoint_descriptor *endpoint)
493 struct usb_device *hdev = hub->hdev;
494 struct device *hub_dev = hub->intfdev;
495 u16 hubstatus, hubchange;
500 hub->buffer = usb_buffer_alloc(hdev, sizeof(*hub->buffer), GFP_KERNEL,
503 message = "can't allocate hub irq buffer";
508 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
510 message = "can't kmalloc hub status buffer";
515 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
516 if (!hub->descriptor) {
517 message = "can't kmalloc hub descriptor";
522 /* Request the entire hub descriptor.
523 * hub->descriptor can handle USB_MAXCHILDREN ports,
524 * but the hub can/will return fewer bytes here.
526 ret = get_hub_descriptor(hdev, hub->descriptor,
527 sizeof(*hub->descriptor));
529 message = "can't read hub descriptor";
531 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
532 message = "hub has too many ports!";
537 hdev->maxchild = hub->descriptor->bNbrPorts;
538 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
539 (hdev->maxchild == 1) ? "" : "s");
541 le16_to_cpus(&hub->descriptor->wHubCharacteristics);
543 if (hub->descriptor->wHubCharacteristics & HUB_CHAR_COMPOUND) {
545 char portstr [USB_MAXCHILDREN + 1];
547 for (i = 0; i < hdev->maxchild; i++)
548 portstr[i] = hub->descriptor->DeviceRemovable
549 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
551 portstr[hdev->maxchild] = 0;
552 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
554 dev_dbg(hub_dev, "standalone hub\n");
556 switch (hub->descriptor->wHubCharacteristics & HUB_CHAR_LPSM) {
558 dev_dbg(hub_dev, "ganged power switching\n");
561 dev_dbg(hub_dev, "individual port power switching\n");
565 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
569 switch (hub->descriptor->wHubCharacteristics & HUB_CHAR_OCPM) {
571 dev_dbg(hub_dev, "global over-current protection\n");
574 dev_dbg(hub_dev, "individual port over-current protection\n");
578 dev_dbg(hub_dev, "no over-current protection\n");
582 spin_lock_init (&hub->tt.lock);
583 INIT_LIST_HEAD (&hub->tt.clear_list);
584 INIT_WORK (&hub->tt.kevent, hub_tt_kevent, hub);
585 switch (hdev->descriptor.bDeviceProtocol) {
589 dev_dbg(hub_dev, "Single TT\n");
593 ret = usb_set_interface(hdev, 0, 1);
595 dev_dbg(hub_dev, "TT per port\n");
598 dev_err(hub_dev, "Using single TT (err %d)\n",
603 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
604 hdev->descriptor.bDeviceProtocol);
608 switch (hub->descriptor->wHubCharacteristics & HUB_CHAR_TTTT) {
610 if (hdev->descriptor.bDeviceProtocol != 0)
611 dev_dbg(hub_dev, "TT requires at most 8 FS bit times\n");
614 dev_dbg(hub_dev, "TT requires at most 16 FS bit times\n");
617 dev_dbg(hub_dev, "TT requires at most 24 FS bit times\n");
620 dev_dbg(hub_dev, "TT requires at most 32 FS bit times\n");
624 /* probe() zeroes hub->indicator[] */
625 if (hub->descriptor->wHubCharacteristics & HUB_CHAR_PORTIND) {
626 hub->has_indicators = 1;
627 dev_dbg(hub_dev, "Port indicators are supported\n");
630 dev_dbg(hub_dev, "power on to power good time: %dms\n",
631 hub->descriptor->bPwrOn2PwrGood * 2);
633 /* power budgeting mostly matters with bus-powered hubs,
634 * and battery-powered root hubs (may provide just 8 mA).
636 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
638 message = "can't get hub status";
641 cpu_to_le16s(&hubstatus);
642 if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
643 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
644 hub->descriptor->bHubContrCurrent);
645 hub->power_budget = (501 - hub->descriptor->bHubContrCurrent)
647 dev_dbg(hub_dev, "%dmA bus power budget for children\n",
648 hub->power_budget * 2);
652 ret = hub_hub_status(hub, &hubstatus, &hubchange);
654 message = "can't get hub status";
658 /* local power status reports aren't always correct */
659 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
660 dev_dbg(hub_dev, "local power source is %s\n",
661 (hubstatus & HUB_STATUS_LOCAL_POWER)
662 ? "lost (inactive)" : "good");
664 if ((hub->descriptor->wHubCharacteristics & HUB_CHAR_OCPM) == 0)
665 dev_dbg(hub_dev, "%sover-current condition exists\n",
666 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
668 /* set up the interrupt endpoint */
669 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
670 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
672 if (maxp > sizeof(*hub->buffer))
673 maxp = sizeof(*hub->buffer);
675 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
677 message = "couldn't allocate interrupt urb";
682 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
683 hub, endpoint->bInterval);
684 hub->urb->transfer_dma = hub->buffer_dma;
685 hub->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
687 /* maybe cycle the hub leds */
688 if (hub->has_indicators && blinkenlights)
689 hub->indicator [0] = INDICATOR_CYCLE;
692 hub->change_bits[0] = (1UL << (hub->descriptor->bNbrPorts + 1)) - 2;
697 dev_err (hub_dev, "config failed, %s (err %d)\n",
699 /* hub_disconnect() frees urb and descriptor */
703 static unsigned highspeed_hubs;
705 static void hub_disconnect(struct usb_interface *intf)
707 struct usb_hub *hub = usb_get_intfdata (intf);
708 struct usb_device *hdev;
714 if (hdev->speed == USB_SPEED_HIGH)
717 usb_set_intfdata (intf, NULL);
720 usb_free_urb(hub->urb);
723 spin_lock_irq(&hub_event_lock);
724 list_del_init(&hub->event_list);
725 spin_unlock_irq(&hub_event_lock);
727 if (hub->descriptor) {
728 kfree(hub->descriptor);
729 hub->descriptor = NULL;
738 usb_buffer_free(hdev, sizeof(*hub->buffer), hub->buffer,
743 /* Free the memory */
747 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
749 struct usb_host_interface *desc;
750 struct usb_endpoint_descriptor *endpoint;
751 struct usb_device *hdev;
754 desc = intf->cur_altsetting;
755 hdev = interface_to_usbdev(intf);
757 /* Some hubs have a subclass of 1, which AFAICT according to the */
758 /* specs is not defined, but it works */
759 if ((desc->desc.bInterfaceSubClass != 0) &&
760 (desc->desc.bInterfaceSubClass != 1)) {
762 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
766 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
767 if (desc->desc.bNumEndpoints != 1)
768 goto descriptor_error;
770 endpoint = &desc->endpoint[0].desc;
772 /* Output endpoint? Curiouser and curiouser.. */
773 if (!(endpoint->bEndpointAddress & USB_DIR_IN))
774 goto descriptor_error;
776 /* If it's not an interrupt endpoint, we'd better punt! */
777 if ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
778 != USB_ENDPOINT_XFER_INT)
779 goto descriptor_error;
782 dev_info (&intf->dev, "USB hub found\n");
784 hub = kmalloc(sizeof(*hub), GFP_KERNEL);
786 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
790 memset(hub, 0, sizeof(*hub));
792 INIT_LIST_HEAD(&hub->event_list);
793 hub->intfdev = &intf->dev;
795 INIT_WORK(&hub->leds, led_work, hub);
797 usb_set_intfdata (intf, hub);
799 if (hdev->speed == USB_SPEED_HIGH)
802 if (hub_configure(hub, endpoint) >= 0)
805 hub_disconnect (intf);
810 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
812 struct usb_device *hdev = interface_to_usbdev (intf);
814 /* assert ifno == 0 (part of hub spec) */
816 case USBDEVFS_HUB_PORTINFO: {
817 struct usbdevfs_hub_portinfo *info = user_data;
820 spin_lock_irq(&device_state_lock);
821 if (hdev->devnum <= 0)
824 info->nports = hdev->maxchild;
825 for (i = 0; i < info->nports; i++) {
826 if (hdev->children[i] == NULL)
830 hdev->children[i]->devnum;
833 spin_unlock_irq(&device_state_lock);
835 return info->nports + 1;
843 /* caller has locked the hub device */
844 static void hub_pre_reset(struct usb_hub *hub)
846 struct usb_device *hdev = hub->hdev;
849 for (i = 0; i < hdev->maxchild; ++i) {
850 if (hdev->children[i])
851 usb_disconnect(&hdev->children[i]);
856 /* caller has locked the hub device */
857 static void hub_post_reset(struct usb_hub *hub)
864 /* grab device/port lock, returning index of that port (zero based).
865 * protects the upstream link used by this device from concurrent
866 * tree operations like suspend, resume, reset, and disconnect, which
867 * apply to everything downstream of a given port.
869 static int locktree(struct usb_device *udev)
872 struct usb_device *hdev;
877 /* root hub is always the first lock in the series */
880 usb_lock_device(udev);
884 /* on the path from root to us, lock everything from
885 * top down, dropping parent locks when not needed
890 for (t = 0; t < hdev->maxchild; t++) {
891 if (hdev->children[t] == udev) {
892 /* everything is fail-fast once disconnect
895 if (udev->state == USB_STATE_NOTATTACHED)
898 /* when everyone grabs locks top->bottom,
899 * non-overlapping work may be concurrent
901 down(&udev->serialize);
902 up(&hdev->serialize);
906 usb_unlock_device(hdev);
910 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
914 for (i = 0; i < udev->maxchild; ++i) {
915 if (udev->children[i])
916 recursively_mark_NOTATTACHED(udev->children[i]);
918 udev->state = USB_STATE_NOTATTACHED;
922 * usb_set_device_state - change a device's current state (usbcore, hcds)
923 * @udev: pointer to device whose state should be changed
924 * @new_state: new state value to be stored
926 * udev->state is _not_ fully protected by the device lock. Although
927 * most transitions are made only while holding the lock, the state can
928 * can change to USB_STATE_NOTATTACHED at almost any time. This
929 * is so that devices can be marked as disconnected as soon as possible,
930 * without having to wait for any semaphores to be released. As a result,
931 * all changes to any device's state must be protected by the
932 * device_state_lock spinlock.
934 * Once a device has been added to the device tree, all changes to its state
935 * should be made using this routine. The state should _not_ be set directly.
937 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
938 * Otherwise udev->state is set to new_state, and if new_state is
939 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
940 * to USB_STATE_NOTATTACHED.
942 void usb_set_device_state(struct usb_device *udev,
943 enum usb_device_state new_state)
947 spin_lock_irqsave(&device_state_lock, flags);
948 if (udev->state == USB_STATE_NOTATTACHED)
950 else if (new_state != USB_STATE_NOTATTACHED)
951 udev->state = new_state;
953 recursively_mark_NOTATTACHED(udev);
954 spin_unlock_irqrestore(&device_state_lock, flags);
956 EXPORT_SYMBOL(usb_set_device_state);
959 static void choose_address(struct usb_device *udev)
962 struct usb_bus *bus = udev->bus;
964 /* If khubd ever becomes multithreaded, this will need a lock */
966 /* Try to allocate the next devnum beginning at bus->devnum_next. */
967 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
970 devnum = find_next_zero_bit(bus->devmap.devicemap, 128, 1);
972 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
975 set_bit(devnum, bus->devmap.devicemap);
976 udev->devnum = devnum;
980 static void release_address(struct usb_device *udev)
982 if (udev->devnum > 0) {
983 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
989 * usb_disconnect - disconnect a device (usbcore-internal)
990 * @pdev: pointer to device being disconnected
991 * Context: !in_interrupt ()
993 * Something got disconnected. Get rid of it and all of its children.
995 * If *pdev is a normal device then the parent hub must already be locked.
996 * If *pdev is a root hub then this routine will acquire the
997 * usb_bus_list_lock on behalf of the caller.
999 * Only hub drivers (including virtual root hub drivers for host
1000 * controllers) should ever call this.
1002 * This call is synchronous, and may not be used in an interrupt context.
1004 void usb_disconnect(struct usb_device **pdev)
1006 struct usb_device *udev = *pdev;
1010 pr_debug ("%s nodev\n", __FUNCTION__);
1014 /* mark the device as inactive, so any further urb submissions for
1015 * this device (and any of its children) will fail immediately.
1016 * this quiesces everyting except pending urbs.
1018 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1020 /* lock the bus list on behalf of HCDs unregistering their root hubs */
1021 if (!udev->parent) {
1022 down(&usb_bus_list_lock);
1023 usb_lock_device(udev);
1025 down(&udev->serialize);
1027 dev_info (&udev->dev, "USB disconnect, address %d\n", udev->devnum);
1029 /* Free up all the children before we remove this device */
1030 for (i = 0; i < USB_MAXCHILDREN; i++) {
1031 if (udev->children[i])
1032 usb_disconnect(&udev->children[i]);
1035 /* deallocate hcd/hardware state ... nuking all pending urbs and
1036 * cleaning up all state associated with the current configuration
1037 * so that the hardware is now fully quiesced.
1039 usb_disable_device(udev, 0);
1041 /* Free the device number, remove the /proc/bus/usb entry and
1042 * the sysfs attributes, and delete the parent's children[]
1043 * (or root_hub) pointer.
1045 dev_dbg (&udev->dev, "unregistering device\n");
1046 release_address(udev);
1047 usbfs_remove_device(udev);
1048 usb_remove_sysfs_dev_files(udev);
1050 /* Avoid races with recursively_mark_NOTATTACHED() */
1051 spin_lock_irq(&device_state_lock);
1053 spin_unlock_irq(&device_state_lock);
1055 if (!udev->parent) {
1056 usb_unlock_device(udev);
1057 up(&usb_bus_list_lock);
1059 up(&udev->serialize);
1061 device_unregister(&udev->dev);
1064 static int choose_configuration(struct usb_device *udev)
1068 /* NOTE: this should interact with hub power budgeting */
1070 c = udev->config[0].desc.bConfigurationValue;
1071 if (udev->descriptor.bNumConfigurations != 1) {
1072 for (i = 0; i < udev->descriptor.bNumConfigurations; i++) {
1073 struct usb_interface_descriptor *desc;
1075 /* heuristic: Linux is more likely to have class
1076 * drivers, so avoid vendor-specific interfaces.
1078 desc = &udev->config[i].intf_cache[0]
1080 if (desc->bInterfaceClass == USB_CLASS_VENDOR_SPEC)
1082 /* COMM/2/all is CDC ACM, except 0xff is MSFT RNDIS.
1083 * MSFT needs this to be the first config; never use
1084 * it as the default unless Linux has host-side RNDIS.
1085 * A second config would ideally be CDC-Ethernet, but
1086 * may instead be the "vendor specific" CDC subset
1087 * long used by ARM Linux for sa1100 or pxa255.
1089 if (desc->bInterfaceClass == USB_CLASS_COMM
1090 && desc->bInterfaceSubClass == 2
1091 && desc->bInterfaceProtocol == 0xff) {
1092 c = udev->config[1].desc.bConfigurationValue;
1095 c = udev->config[i].desc.bConfigurationValue;
1098 dev_info(&udev->dev,
1099 "configuration #%d chosen from %d choices\n",
1100 c, udev->descriptor.bNumConfigurations);
1106 static void show_string(struct usb_device *udev, char *id, int index)
1112 if (!(buf = kmalloc(256, GFP_KERNEL)))
1114 if (usb_string(udev, index, buf, 256) > 0)
1115 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, buf);
1120 static inline void show_string(struct usb_device *udev, char *id, int index)
1124 #ifdef CONFIG_USB_OTG
1125 #include "otg_whitelist.h"
1129 * usb_new_device - perform initial device setup (usbcore-internal)
1130 * @udev: newly addressed device (in ADDRESS state)
1132 * This is called with devices which have been enumerated, but not yet
1133 * configured. The device descriptor is available, but not descriptors
1134 * for any device configuration. The caller must have locked udev and
1135 * either the parent hub (if udev is a normal device) or else the
1136 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1137 * udev has already been installed, but udev is not yet visible through
1138 * sysfs or other filesystem code.
1140 * Returns 0 for success (device is configured and listed, with its
1141 * interfaces, in sysfs); else a negative errno value.
1143 * This call is synchronous, and may not be used in an interrupt context.
1145 * Only the hub driver should ever call this; root hub registration
1146 * uses it indirectly.
1148 int usb_new_device(struct usb_device *udev)
1153 err = usb_get_configuration(udev);
1155 dev_err(&udev->dev, "can't read configurations, error %d\n",
1160 /* Tell the world! */
1161 dev_dbg(&udev->dev, "new device strings: Mfr=%d, Product=%d, "
1162 "SerialNumber=%d\n",
1163 udev->descriptor.iManufacturer,
1164 udev->descriptor.iProduct,
1165 udev->descriptor.iSerialNumber);
1167 if (udev->descriptor.iProduct)
1168 show_string(udev, "Product",
1169 udev->descriptor.iProduct);
1170 if (udev->descriptor.iManufacturer)
1171 show_string(udev, "Manufacturer",
1172 udev->descriptor.iManufacturer);
1173 if (udev->descriptor.iSerialNumber)
1174 show_string(udev, "SerialNumber",
1175 udev->descriptor.iSerialNumber);
1177 #ifdef CONFIG_USB_OTG
1179 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1180 * to wake us after we've powered off VBUS; and HNP, switching roles
1181 * "host" to "peripheral". The OTG descriptor helps figure this out.
1183 if (!udev->bus->is_b_host
1185 && udev->parent == udev->bus->root_hub) {
1186 struct usb_otg_descriptor *desc = 0;
1187 struct usb_bus *bus = udev->bus;
1189 /* descriptor may appear anywhere in config */
1190 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1191 le16_to_cpu(udev->config[0].desc.wTotalLength),
1192 USB_DT_OTG, (void **) &desc) == 0) {
1193 if (desc->bmAttributes & USB_OTG_HNP) {
1195 struct usb_device *root = udev->parent;
1197 for (port1 = 1; port1 <= root->maxchild;
1199 if (root->children[port1-1] == udev)
1203 dev_info(&udev->dev,
1204 "Dual-Role OTG device on %sHNP port\n",
1205 (port1 == bus->otg_port)
1208 /* enable HNP before suspend, it's simpler */
1209 if (port1 == bus->otg_port)
1210 bus->b_hnp_enable = 1;
1211 err = usb_control_msg(udev,
1212 usb_sndctrlpipe(udev, 0),
1213 USB_REQ_SET_FEATURE, 0,
1215 ? USB_DEVICE_B_HNP_ENABLE
1216 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1217 0, NULL, 0, HZ * USB_CTRL_SET_TIMEOUT);
1219 /* OTG MESSAGE: report errors here,
1220 * customize to match your product.
1222 dev_info(&udev->dev,
1223 "can't set HNP mode; %d\n",
1225 bus->b_hnp_enable = 0;
1231 if (!is_targeted(udev)) {
1233 /* Maybe it can talk to us, though we can't talk to it.
1234 * (Includes HNP test device.)
1236 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
1237 static int __usb_suspend_device (struct usb_device *,
1238 int port1, u32 state);
1239 err = __usb_suspend_device(udev,
1240 udev->bus->otg_port,
1243 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1250 /* put device-specific files into sysfs */
1251 err = device_add (&udev->dev);
1253 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1256 usb_create_sysfs_dev_files (udev);
1258 /* choose and set the configuration. that registers the interfaces
1259 * with the driver core, and lets usb device drivers bind to them.
1261 c = choose_configuration(udev);
1263 dev_warn(&udev->dev,
1264 "can't choose an initial configuration\n");
1266 err = usb_set_configuration(udev, c);
1268 dev_err(&udev->dev, "can't set config #%d, error %d\n",
1270 usb_remove_sysfs_dev_files(udev);
1271 device_del(&udev->dev);
1276 /* USB device state == configured ... usable */
1278 /* add a /proc/bus/usb entry */
1279 usbfs_add_device(udev);
1283 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1288 static int hub_port_status(struct usb_hub *hub, int port1,
1289 u16 *status, u16 *change)
1293 ret = get_port_status(hub->hdev, port1, &hub->status->port);
1295 dev_err (hub->intfdev,
1296 "%s failed (err = %d)\n", __FUNCTION__, ret);
1298 *status = le16_to_cpu(hub->status->port.wPortStatus);
1299 *change = le16_to_cpu(hub->status->port.wPortChange);
1305 #define PORT_RESET_TRIES 5
1306 #define SET_ADDRESS_TRIES 2
1307 #define GET_DESCRIPTOR_TRIES 2
1308 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1309 #define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1311 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1312 #define HUB_SHORT_RESET_TIME 10
1313 #define HUB_LONG_RESET_TIME 200
1314 #define HUB_RESET_TIMEOUT 500
1316 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
1317 struct usb_device *udev, unsigned int delay)
1319 int delay_time, ret;
1323 for (delay_time = 0;
1324 delay_time < HUB_RESET_TIMEOUT;
1325 delay_time += delay) {
1326 /* wait to give the device a chance to reset */
1329 /* read and decode port status */
1330 ret = hub_port_status(hub, port1, &portstatus, &portchange);
1334 /* Device went away? */
1335 if (!(portstatus & USB_PORT_STAT_CONNECTION))
1338 /* bomb out completely if something weird happened */
1339 if ((portchange & USB_PORT_STAT_C_CONNECTION))
1342 /* if we`ve finished resetting, then break out of the loop */
1343 if (!(portstatus & USB_PORT_STAT_RESET) &&
1344 (portstatus & USB_PORT_STAT_ENABLE)) {
1345 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
1346 udev->speed = USB_SPEED_HIGH;
1347 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
1348 udev->speed = USB_SPEED_LOW;
1350 udev->speed = USB_SPEED_FULL;
1354 /* switch to the long delay after two short delay failures */
1355 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
1356 delay = HUB_LONG_RESET_TIME;
1358 dev_dbg (hub->intfdev,
1359 "port %d not reset yet, waiting %dms\n",
1366 static int hub_port_reset(struct usb_hub *hub, int port1,
1367 struct usb_device *udev, unsigned int delay)
1371 /* Reset the port */
1372 for (i = 0; i < PORT_RESET_TRIES; i++) {
1373 status = set_port_feature(hub->hdev,
1374 port1, USB_PORT_FEAT_RESET);
1376 dev_err(hub->intfdev,
1377 "cannot reset port %d (err = %d)\n",
1380 status = hub_port_wait_reset(hub, port1, udev, delay);
1382 /* return on disconnect or reset */
1385 /* TRSTRCY = 10 ms */
1390 clear_port_feature(hub->hdev,
1391 port1, USB_PORT_FEAT_C_RESET);
1392 /* FIXME need disconnect() for NOTATTACHED device */
1393 usb_set_device_state(udev, status
1394 ? USB_STATE_NOTATTACHED
1395 : USB_STATE_DEFAULT);
1399 dev_dbg (hub->intfdev,
1400 "port %d not enabled, trying reset again...\n",
1402 delay = HUB_LONG_RESET_TIME;
1405 dev_err (hub->intfdev,
1406 "Cannot enable port %i. Maybe the USB cable is bad?\n",
1412 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
1414 struct usb_device *hdev = hub->hdev;
1417 if (hdev->children[port1-1] && set_state) {
1418 usb_set_device_state(hdev->children[port1-1],
1419 USB_STATE_NOTATTACHED);
1421 ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
1423 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
1430 * Disable a port and mark a logical connnect-change event, so that some
1431 * time later khubd will disconnect() any existing usb_device on the port
1432 * and will re-enumerate if there actually is a device attached.
1434 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
1436 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
1437 hub_port_disable(hub, port1, 1);
1439 /* FIXME let caller ask to power down the port:
1440 * - some devices won't enumerate without a VBUS power cycle
1441 * - SRP saves power that way
1442 * - usb_suspend_device(dev,PM_SUSPEND_DISK)
1443 * That's easy if this hub can switch power per-port, and
1444 * khubd reactivates the port later (timer, SRP, etc).
1445 * Powerdown must be optional, because of reset/DFU.
1448 set_bit(port1, hub->change_bits);
1453 #ifdef CONFIG_USB_SUSPEND
1456 * Selective port suspend reduces power; most suspended devices draw
1457 * less than 500 uA. It's also used in OTG, along with remote wakeup.
1458 * All devices below the suspended port are also suspended.
1460 * Devices leave suspend state when the host wakes them up. Some devices
1461 * also support "remote wakeup", where the device can activate the USB
1462 * tree above them to deliver data, such as a keypress or packet. In
1463 * some cases, this wakes the USB host.
1465 static int hub_port_suspend(struct usb_hub *hub, int port1,
1466 struct usb_device *udev)
1470 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
1472 /* enable remote wakeup when appropriate; this lets the device
1473 * wake up the upstream hub (including maybe the root hub).
1475 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
1476 * we don't explicitly enable it here.
1479 // && FIXME (remote wakeup enabled on this bus)
1480 // ... currently assuming it's always appropriate
1481 && (udev->actconfig->desc.bmAttributes
1482 & USB_CONFIG_ATT_WAKEUP) != 0) {
1483 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1484 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
1485 USB_DEVICE_REMOTE_WAKEUP, 0,
1487 USB_CTRL_SET_TIMEOUT);
1490 "won't remote wakeup, status %d\n",
1495 status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
1497 dev_dbg(hub->intfdev,
1498 "can't suspend port %d, status %d\n",
1500 /* paranoia: "should not happen" */
1501 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1502 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
1503 USB_DEVICE_REMOTE_WAKEUP, 0,
1505 USB_CTRL_SET_TIMEOUT);
1507 /* device has up to 10 msec to fully suspend */
1508 dev_dbg(&udev->dev, "usb suspend\n");
1509 usb_set_device_state(udev, USB_STATE_SUSPENDED);
1516 * Devices on USB hub ports have only one "suspend" state, corresponding
1517 * to ACPI D2 (PM_SUSPEND_MEM), "may cause the device to lose some context".
1518 * State transitions include:
1520 * - suspend, resume ... when the VBUS power link stays live
1521 * - suspend, disconnect ... VBUS lost
1523 * Once VBUS drop breaks the circuit, the port it's using has to go through
1524 * normal re-enumeration procedures, starting with enabling VBUS power.
1525 * Other than re-initializing the hub (plug/unplug, except for root hubs),
1526 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
1527 * timer, no SRP, no requests through sysfs.
1529 int __usb_suspend_device (struct usb_device *udev, int port1, u32 state)
1533 /* caller owns the udev device lock */
1537 if (udev->state == USB_STATE_SUSPENDED
1538 || udev->state == USB_STATE_NOTATTACHED) {
1542 /* suspend interface drivers; if this is a hub, it
1543 * suspends the child devices
1545 if (udev->actconfig) {
1548 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
1549 struct usb_interface *intf;
1550 struct usb_driver *driver;
1552 intf = udev->actconfig->interface[i];
1553 if (state <= intf->dev.power.power_state)
1555 if (!intf->dev.driver)
1557 driver = to_usb_driver(intf->dev.driver);
1559 if (driver->suspend) {
1560 status = driver->suspend(intf, state);
1561 if (intf->dev.power.power_state != state
1564 "suspend %d fail, code %d\n",
1568 /* only drivers with suspend() can ever resume();
1569 * and after power loss, even they won't.
1570 * bus_rescan_devices() can rebind drivers later.
1572 * FIXME the PM core self-deadlocks when unbinding
1573 * drivers during suspend/resume ... everything grabs
1574 * dpm_sem (not a spinlock, ugh). we want to unbind,
1575 * since we know every driver's probe/disconnect works
1576 * even for drivers that can't suspend.
1578 if (!driver->suspend || state > PM_SUSPEND_MEM) {
1580 dev_warn(&intf->dev, "resume is unsafe!\n");
1582 down_write(&usb_bus_type.rwsem);
1583 device_release_driver(&intf->dev);
1584 up_write(&usb_bus_type.rwsem);
1591 * FIXME this needs port power off call paths too, to help force
1592 * USB into the "generic" PM model. At least for devices on
1593 * ports that aren't using ganged switching (usually root hubs).
1595 * NOTE: SRP-capable links should adopt more aggressive poweroff
1596 * policies (when HNP doesn't apply) once we have mechanisms to
1597 * turn power back on! (Likely not before 2.7...)
1599 if (state > PM_SUSPEND_MEM) {
1600 dev_warn(&udev->dev, "no poweroff yet, suspending instead\n");
1603 /* "global suspend" of the HC-to-USB interface (root hub), or
1604 * "selective suspend" of just one hub-device link.
1606 if (!udev->parent) {
1607 struct usb_bus *bus = udev->bus;
1608 if (bus && bus->op->hub_suspend) {
1609 status = bus->op->hub_suspend (bus);
1611 usb_set_device_state(udev,
1612 USB_STATE_SUSPENDED);
1614 status = -EOPNOTSUPP;
1616 status = hub_port_suspend(hdev_to_hub(udev->parent), port1,
1620 udev->dev.power.power_state = state;
1625 * usb_suspend_device - suspend a usb device
1626 * @udev: device that's no longer in active use
1627 * @state: PM_SUSPEND_MEM to suspend
1628 * Context: must be able to sleep; device not locked
1630 * Suspends a USB device that isn't in active use, conserving power.
1631 * Devices may wake out of a suspend, if anything important happens,
1632 * using the remote wakeup mechanism. They may also be taken out of
1633 * suspend by the host, using usb_resume_device(). It's also routine
1634 * to disconnect devices while they are suspended.
1636 * Suspending OTG devices may trigger HNP, if that's been enabled
1637 * between a pair of dual-role devices. That will change roles, such
1638 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
1640 * Returns 0 on success, else negative errno.
1642 int usb_suspend_device(struct usb_device *udev, u32 state)
1646 port1 = locktree(udev);
1650 status = __usb_suspend_device(udev, port1, state);
1651 usb_unlock_device(udev);
1656 * hardware resume signaling is finished, either because of selective
1657 * resume (by host) or remote wakeup (by device) ... now see what changed
1658 * in the tree that's rooted at this device.
1660 static int finish_port_resume(struct usb_device *udev)
1665 /* caller owns the udev device lock */
1666 dev_dbg(&udev->dev, "usb resume\n");
1668 /* usb ch9 identifies four variants of SUSPENDED, based on what
1669 * state the device resumes to. Linux currently won't see the
1670 * first two on the host side; they'd be inside hub_port_init()
1671 * during many timeouts, but khubd can't suspend until later.
1673 usb_set_device_state(udev, udev->actconfig
1674 ? USB_STATE_CONFIGURED
1675 : USB_STATE_ADDRESS);
1676 udev->dev.power.power_state = PM_SUSPEND_ON;
1678 /* 10.5.4.5 says be sure devices in the tree are still there.
1679 * For now let's assume the device didn't go crazy on resume,
1680 * and device drivers will know about any resume quirks.
1682 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
1685 "gone after usb resume? status %d\n",
1687 else if (udev->actconfig) {
1690 le16_to_cpus(&devstatus);
1691 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) {
1692 status = usb_control_msg(udev,
1693 usb_sndctrlpipe(udev, 0),
1694 USB_REQ_CLEAR_FEATURE,
1696 USB_DEVICE_REMOTE_WAKEUP, 0,
1698 USB_CTRL_SET_TIMEOUT);
1700 dev_dbg(&udev->dev, "disable remote "
1701 "wakeup, status %d\n", status);
1706 /* resume interface drivers; if this is a hub, it
1707 * resumes the child devices
1709 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
1710 struct usb_interface *intf;
1711 struct usb_driver *driver;
1713 intf = udev->actconfig->interface[i];
1714 if (intf->dev.power.power_state == PM_SUSPEND_ON)
1716 if (!intf->dev.driver) {
1717 /* FIXME maybe force to alt 0 */
1720 driver = to_usb_driver(intf->dev.driver);
1722 /* bus_rescan_devices() may rebind drivers */
1723 if (!driver->resume)
1726 /* can we do better than just logging errors? */
1727 status = driver->resume(intf);
1728 if (intf->dev.power.power_state != PM_SUSPEND_ON
1731 "resume fail, state %d code %d\n",
1732 intf->dev.power.power_state, status);
1736 } else if (udev->devnum <= 0) {
1737 dev_dbg(&udev->dev, "bogus resume!\n");
1744 hub_port_resume(struct usb_hub *hub, int port1, struct usb_device *udev)
1748 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
1750 /* see 7.1.7.7; affects power usage, but not budgeting */
1751 status = clear_port_feature(hub->hdev,
1752 port1, USB_PORT_FEAT_SUSPEND);
1754 dev_dbg(hub->intfdev,
1755 "can't resume port %d, status %d\n",
1761 /* drive resume for at least 20 msec */
1763 dev_dbg(&udev->dev, "RESUME\n");
1766 #define LIVE_FLAGS ( USB_PORT_STAT_POWER \
1767 | USB_PORT_STAT_ENABLE \
1768 | USB_PORT_STAT_CONNECTION)
1770 /* Virtual root hubs can trigger on GET_PORT_STATUS to
1771 * stop resume signaling. Then finish the resume
1774 devstatus = portchange = 0;
1775 status = hub_port_status(hub, port1,
1776 &devstatus, &portchange);
1778 || (devstatus & LIVE_FLAGS) != LIVE_FLAGS
1779 || (devstatus & USB_PORT_STAT_SUSPEND) != 0
1781 dev_dbg(hub->intfdev,
1782 "port %d status %04x.%04x after resume, %d\n",
1783 port1, portchange, devstatus, status);
1785 /* TRSMRCY = 10 msec */
1788 status = finish_port_resume(udev);
1792 hub_port_logical_disconnect(hub, port1);
1797 static int hub_resume (struct usb_interface *intf);
1800 * usb_resume_device - re-activate a suspended usb device
1801 * @udev: device to re-activate
1802 * Context: must be able to sleep; device not locked
1804 * This will re-activate the suspended device, increasing power usage
1805 * while letting drivers communicate again with its endpoints.
1806 * USB resume explicitly guarantees that the power session between
1807 * the host and the device is the same as it was when the device
1810 * Returns 0 on success, else negative errno.
1812 int usb_resume_device(struct usb_device *udev)
1816 port1 = locktree(udev);
1820 /* "global resume" of the HC-to-USB interface (root hub), or
1821 * selective resume of one hub-to-device port
1823 if (!udev->parent) {
1824 struct usb_bus *bus = udev->bus;
1825 if (bus && bus->op->hub_resume) {
1826 status = bus->op->hub_resume (bus);
1828 status = -EOPNOTSUPP;
1830 /* TRSMRCY = 10 msec */
1832 usb_set_device_state (udev, USB_STATE_CONFIGURED);
1833 status = hub_resume (udev
1834 ->actconfig->interface[0]);
1836 } else if (udev->state == USB_STATE_SUSPENDED) {
1837 // NOTE this fails if parent is also suspended...
1838 status = hub_port_resume(hdev_to_hub(udev->parent),
1844 dev_dbg(&udev->dev, "can't resume, status %d\n",
1848 usb_unlock_device(udev);
1850 /* rebind drivers that had no suspend() */
1852 usb_lock_all_devices();
1853 bus_rescan_devices(&usb_bus_type);
1854 usb_unlock_all_devices();
1859 static int remote_wakeup(struct usb_device *udev)
1863 /* don't repeat RESUME sequence if this device
1864 * was already woken up by some other task
1866 down(&udev->serialize);
1867 if (udev->state == USB_STATE_SUSPENDED) {
1868 dev_dbg(&udev->dev, "RESUME (wakeup)\n");
1869 /* TRSMRCY = 10 msec */
1871 status = finish_port_resume(udev);
1873 up(&udev->serialize);
1877 static int hub_suspend(struct usb_interface *intf, u32 state)
1879 struct usb_hub *hub = usb_get_intfdata (intf);
1880 struct usb_device *hdev = hub->hdev;
1884 /* stop khubd and related activity */
1887 /* then suspend every port */
1888 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
1889 struct usb_device *udev;
1891 udev = hdev->children [port1-1];
1894 down(&udev->serialize);
1895 status = __usb_suspend_device(udev, port1, state);
1896 up(&udev->serialize);
1898 dev_dbg(&intf->dev, "suspend port %d --> %d\n",
1902 intf->dev.power.power_state = state;
1906 static int hub_resume(struct usb_interface *intf)
1908 struct usb_device *hdev = interface_to_usbdev(intf);
1909 struct usb_hub *hub = usb_get_intfdata (intf);
1913 if (intf->dev.power.power_state == PM_SUSPEND_ON)
1916 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
1917 struct usb_device *udev;
1918 u16 portstat, portchange;
1920 udev = hdev->children [port1-1];
1921 status = hub_port_status(hub, port1, &portstat, &portchange);
1923 if (portchange & USB_PORT_STAT_C_SUSPEND) {
1924 clear_port_feature(hdev, port1,
1925 USB_PORT_FEAT_C_SUSPEND);
1926 portchange &= ~USB_PORT_STAT_C_SUSPEND;
1929 /* let khubd handle disconnects etc */
1934 if (!udev || status < 0)
1936 down (&udev->serialize);
1937 if (portstat & USB_PORT_STAT_SUSPEND)
1938 status = hub_port_resume(hub, port1, udev);
1940 status = finish_port_resume(udev);
1942 dev_dbg(&intf->dev, "resume port %d --> %d\n",
1944 hub_port_logical_disconnect(hub, port1);
1947 up(&udev->serialize);
1949 intf->dev.power.power_state = PM_SUSPEND_ON;
1955 #else /* !CONFIG_USB_SUSPEND */
1957 int usb_suspend_device(struct usb_device *udev, u32 state)
1962 int usb_resume_device(struct usb_device *udev)
1967 #define hub_suspend NULL
1968 #define hub_resume NULL
1969 #define remote_wakeup(x) 0
1971 #endif /* CONFIG_USB_SUSPEND */
1973 EXPORT_SYMBOL(usb_suspend_device);
1974 EXPORT_SYMBOL(usb_resume_device);
1978 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
1980 * Between connect detection and reset signaling there must be a delay
1981 * of 100ms at least for debounce and power-settling. The corresponding
1982 * timer shall restart whenever the downstream port detects a disconnect.
1984 * Apparently there are some bluetooth and irda-dongles and a number of
1985 * low-speed devices for which this debounce period may last over a second.
1986 * Not covered by the spec - but easy to deal with.
1988 * This implementation uses a 1500ms total debounce timeout; if the
1989 * connection isn't stable by then it returns -ETIMEDOUT. It checks
1990 * every 25ms for transient disconnects. When the port status has been
1991 * unchanged for 100ms it returns the port status.
1994 #define HUB_DEBOUNCE_TIMEOUT 1500
1995 #define HUB_DEBOUNCE_STEP 25
1996 #define HUB_DEBOUNCE_STABLE 100
1998 static int hub_port_debounce(struct usb_hub *hub, int port1)
2001 int total_time, stable_time = 0;
2002 u16 portchange, portstatus;
2003 unsigned connection = 0xffff;
2005 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2006 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2010 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2011 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2012 stable_time += HUB_DEBOUNCE_STEP;
2013 if (stable_time >= HUB_DEBOUNCE_STABLE)
2017 connection = portstatus & USB_PORT_STAT_CONNECTION;
2020 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2021 clear_port_feature(hub->hdev, port1,
2022 USB_PORT_FEAT_C_CONNECTION);
2025 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2027 msleep(HUB_DEBOUNCE_STEP);
2030 dev_dbg (hub->intfdev,
2031 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2032 port1, total_time, stable_time, portstatus);
2034 if (stable_time < HUB_DEBOUNCE_STABLE)
2039 static void ep0_reinit(struct usb_device *udev)
2041 usb_disable_endpoint(udev, 0 + USB_DIR_IN);
2042 usb_disable_endpoint(udev, 0 + USB_DIR_OUT);
2043 udev->ep_in[0] = udev->ep_out[0] = &udev->ep0;
2046 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2047 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2049 static int hub_set_address(struct usb_device *udev)
2053 if (udev->devnum == 0)
2055 if (udev->state == USB_STATE_ADDRESS)
2057 if (udev->state != USB_STATE_DEFAULT)
2059 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2060 USB_REQ_SET_ADDRESS, 0, udev->devnum, 0,
2061 NULL, 0, HZ * USB_CTRL_SET_TIMEOUT);
2063 usb_set_device_state(udev, USB_STATE_ADDRESS);
2069 /* Reset device, (re)assign address, get device descriptor.
2070 * Device connection must be stable, no more debouncing needed.
2071 * Returns device in USB_STATE_ADDRESS, except on error.
2073 * If this is called for an already-existing device (as part of
2074 * usb_reset_device), the caller must own the device lock. For a
2075 * newly detected device that is not accessible through any global
2076 * pointers, it's not necessary to lock the device.
2079 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2082 static DECLARE_MUTEX(usb_address0_sem);
2084 struct usb_device *hdev = hub->hdev;
2086 unsigned delay = HUB_SHORT_RESET_TIME;
2087 enum usb_device_speed oldspeed = udev->speed;
2089 /* root hub ports have a slightly longer reset period
2090 * (from USB 2.0 spec, section 7.1.7.5)
2092 if (!hdev->parent) {
2093 delay = HUB_ROOT_RESET_TIME;
2094 if (port1 == hdev->bus->otg_port)
2095 hdev->bus->b_hnp_enable = 0;
2098 /* Some low speed devices have problems with the quick delay, so */
2099 /* be a bit pessimistic with those devices. RHbug #23670 */
2100 if (oldspeed == USB_SPEED_LOW)
2101 delay = HUB_LONG_RESET_TIME;
2103 down(&usb_address0_sem);
2105 /* Reset the device; full speed may morph to high speed */
2106 retval = hub_port_reset(hub, port1, udev, delay);
2107 if (retval < 0) /* error or disconnect */
2109 /* success, speed is known */
2112 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2113 dev_dbg(&udev->dev, "device reset changed speed!\n");
2116 oldspeed = udev->speed;
2118 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2119 * it's fixed size except for full speed devices.
2121 switch (udev->speed) {
2122 case USB_SPEED_HIGH: /* fixed at 64 */
2123 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2125 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
2126 /* to determine the ep0 maxpacket size, try to read
2127 * the device descriptor to get bMaxPacketSize0 and
2128 * then correct our initial guess.
2130 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2132 case USB_SPEED_LOW: /* fixed at 8 */
2133 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(8);
2139 dev_info (&udev->dev,
2140 "%s %s speed USB device using %s and address %d\n",
2141 (udev->config) ? "reset" : "new",
2142 ({ char *speed; switch (udev->speed) {
2143 case USB_SPEED_LOW: speed = "low"; break;
2144 case USB_SPEED_FULL: speed = "full"; break;
2145 case USB_SPEED_HIGH: speed = "high"; break;
2146 default: speed = "?"; break;
2148 udev->bus->controller->driver->name,
2151 /* Set up TT records, if needed */
2153 udev->tt = hdev->tt;
2154 udev->ttport = hdev->ttport;
2155 } else if (udev->speed != USB_SPEED_HIGH
2156 && hdev->speed == USB_SPEED_HIGH) {
2157 udev->tt = &hub->tt;
2158 udev->ttport = port1;
2161 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2162 * Because device hardware and firmware is sometimes buggy in
2163 * this area, and this is how Linux has done it for ages.
2164 * Change it cautiously.
2166 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2167 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2168 * so it may help with some non-standards-compliant devices.
2169 * Otherwise we start with SET_ADDRESS and then try to read the
2170 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2173 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
2174 if (USE_NEW_SCHEME(retry_counter)) {
2175 struct usb_device_descriptor *buf;
2178 #define GET_DESCRIPTOR_BUFSIZE 64
2179 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2184 buf->bMaxPacketSize0 = 0;
2186 /* Use a short timeout the first time through,
2187 * so that recalcitrant full-speed devices with
2188 * 8- or 16-byte ep0-maxpackets won't slow things
2189 * down tremendously by NAKing the unexpectedly
2190 * early status stage. Also, retry on length 0
2191 * or stall; some devices are flakey.
2193 for (j = 0; j < 3; ++j) {
2194 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2195 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2196 USB_DT_DEVICE << 8, 0,
2197 buf, GET_DESCRIPTOR_BUFSIZE,
2198 (i ? HZ * USB_CTRL_GET_TIMEOUT : HZ));
2199 if (r == 0 || r == -EPIPE)
2204 udev->descriptor.bMaxPacketSize0 =
2205 buf->bMaxPacketSize0;
2208 retval = hub_port_reset(hub, port1, udev, delay);
2209 if (retval < 0) /* error or disconnect */
2211 if (oldspeed != udev->speed) {
2213 "device reset changed speed!\n");
2217 switch (udev->descriptor.bMaxPacketSize0) {
2218 case 64: case 32: case 16: case 8:
2221 dev_err(&udev->dev, "device descriptor "
2222 "read/%s, error %d\n",
2227 #undef GET_DESCRIPTOR_BUFSIZE
2230 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
2231 retval = hub_set_address(udev);
2238 "device not accepting address %d, error %d\n",
2239 udev->devnum, retval);
2243 /* cope with hardware quirkiness:
2244 * - let SET_ADDRESS settle, some device hardware wants it
2245 * - read ep0 maxpacket even for high and low speed,
2248 if (USE_NEW_SCHEME(retry_counter))
2251 retval = usb_get_device_descriptor(udev, 8);
2253 dev_err(&udev->dev, "device descriptor "
2254 "read/%s, error %d\n",
2266 i = udev->descriptor.bMaxPacketSize0;
2267 if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
2268 if (udev->speed != USB_SPEED_FULL ||
2269 !(i == 8 || i == 16 || i == 32 || i == 64)) {
2270 dev_err(&udev->dev, "ep0 maxpacket = %d\n", i);
2274 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
2275 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
2279 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
2280 if (retval < (signed)sizeof(udev->descriptor)) {
2281 dev_err(&udev->dev, "device descriptor read/%s, error %d\n",
2292 hub_port_disable(hub, port1, 0);
2293 up(&usb_address0_sem);
2298 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
2300 struct usb_qualifier_descriptor *qual;
2303 qual = kmalloc (sizeof *qual, SLAB_KERNEL);
2307 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
2308 qual, sizeof *qual);
2309 if (status == sizeof *qual) {
2310 dev_info(&udev->dev, "not running at top speed; "
2311 "connect to a high speed hub\n");
2312 /* hub LEDs are probably harder to miss than syslog */
2313 if (hub->has_indicators) {
2314 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
2315 schedule_work (&hub->leds);
2322 hub_power_remaining (struct usb_hub *hub)
2324 struct usb_device *hdev = hub->hdev;
2328 remaining = hub->power_budget;
2329 if (!remaining) /* self-powered */
2332 for (i = 0; i < hdev->maxchild; i++) {
2333 struct usb_device *udev = hdev->children[i];
2339 /* 100mA per-port ceiling, or 8mA for OTG ports */
2340 if (i != (udev->bus->otg_port - 1) || hdev->parent)
2345 if (udev->actconfig)
2346 delta = udev->actconfig->desc.bMaxPower;
2349 // dev_dbg(&udev->dev, "budgeted %dmA\n", 2 * delta);
2350 if (delta > ceiling)
2351 dev_warn(&udev->dev, "%dmA over %dmA budget!\n",
2352 2 * (delta - ceiling), 2 * ceiling);
2355 if (remaining < 0) {
2356 dev_warn(hub->intfdev,
2357 "%dmA over power budget!\n",
2364 /* Handle physical or logical connection change events.
2365 * This routine is called when:
2366 * a port connection-change occurs;
2367 * a port enable-change occurs (often caused by EMI);
2368 * usb_reset_device() encounters changed descriptors (as from
2369 * a firmware download)
2370 * caller already locked the hub
2372 static void hub_port_connect_change(struct usb_hub *hub, int port1,
2373 u16 portstatus, u16 portchange)
2375 struct usb_device *hdev = hub->hdev;
2376 struct device *hub_dev = hub->intfdev;
2380 "port %d, status %04x, change %04x, %s\n",
2381 port1, portstatus, portchange, portspeed (portstatus));
2383 if (hub->has_indicators) {
2384 set_port_led(hub, port1, HUB_LED_AUTO);
2385 hub->indicator[port1-1] = INDICATOR_AUTO;
2388 /* Disconnect any existing devices under this port */
2389 if (hdev->children[port1-1])
2390 usb_disconnect(&hdev->children[port1-1]);
2391 clear_bit(port1, hub->change_bits);
2393 #ifdef CONFIG_USB_OTG
2394 /* during HNP, don't repeat the debounce */
2395 if (hdev->bus->is_b_host)
2396 portchange &= ~USB_PORT_STAT_C_CONNECTION;
2399 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2400 status = hub_port_debounce(hub, port1);
2403 "connect-debounce failed, port %d disabled\n",
2407 portstatus = status;
2410 /* Return now if nothing is connected */
2411 if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
2413 /* maybe switch power back on (e.g. root hub was reset) */
2414 if ((hub->descriptor->wHubCharacteristics
2415 & HUB_CHAR_LPSM) < 2
2416 && !(portstatus & (1 << USB_PORT_FEAT_POWER)))
2417 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
2419 if (portstatus & USB_PORT_STAT_ENABLE)
2424 #ifdef CONFIG_USB_SUSPEND
2425 /* If something is connected, but the port is suspended, wake it up. */
2426 if (portstatus & USB_PORT_STAT_SUSPEND) {
2427 status = hub_port_resume(hub, port1, NULL);
2430 "can't clear suspend on port %d; %d\n",
2437 for (i = 0; i < SET_CONFIG_TRIES; i++) {
2438 struct usb_device *udev;
2440 /* reallocate for each attempt, since references
2441 * to the previous one can escape in various ways
2443 udev = usb_alloc_dev(hdev, hdev->bus, port1);
2446 "couldn't allocate port %d usb_device\n",
2451 usb_set_device_state(udev, USB_STATE_POWERED);
2452 udev->speed = USB_SPEED_UNKNOWN;
2454 /* set the address */
2455 choose_address(udev);
2456 if (udev->devnum <= 0) {
2457 status = -ENOTCONN; /* Don't retry */
2461 /* reset and get descriptor */
2462 status = hub_port_init(hub, udev, port1, i);
2466 /* consecutive bus-powered hubs aren't reliable; they can
2467 * violate the voltage drop budget. if the new child has
2468 * a "powered" LED, users should notice we didn't enable it
2469 * (without reading syslog), even without per-port LEDs
2472 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
2473 && hub->power_budget) {
2476 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
2479 dev_dbg(&udev->dev, "get status %d ?\n", status);
2482 cpu_to_le16s(&devstat);
2483 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
2485 "can't connect bus-powered hub "
2487 if (hub->has_indicators) {
2488 hub->indicator[port1-1] =
2489 INDICATOR_AMBER_BLINK;
2490 schedule_work (&hub->leds);
2492 status = -ENOTCONN; /* Don't retry */
2497 /* check for devices running slower than they could */
2498 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
2499 && udev->speed == USB_SPEED_FULL
2500 && highspeed_hubs != 0)
2501 check_highspeed (hub, udev, port1);
2503 /* Store the parent's children[] pointer. At this point
2504 * udev becomes globally accessible, although presumably
2505 * no one will look at it until hdev is unlocked.
2507 down (&udev->serialize);
2510 /* We mustn't add new devices if the parent hub has
2511 * been disconnected; we would race with the
2512 * recursively_mark_NOTATTACHED() routine.
2514 spin_lock_irq(&device_state_lock);
2515 if (hdev->state == USB_STATE_NOTATTACHED)
2518 hdev->children[port1-1] = udev;
2519 spin_unlock_irq(&device_state_lock);
2521 /* Run it through the hoops (find a driver, etc) */
2523 status = usb_new_device(udev);
2525 spin_lock_irq(&device_state_lock);
2526 hdev->children[port1-1] = NULL;
2527 spin_unlock_irq(&device_state_lock);
2531 up (&udev->serialize);
2535 status = hub_power_remaining(hub);
2538 "%dmA power budget left\n",
2544 hub_port_disable(hub, port1, 1);
2547 release_address(udev);
2549 if (status == -ENOTCONN)
2554 hub_port_disable(hub, port1, 1);
2557 static void hub_events(void)
2559 struct list_head *tmp;
2560 struct usb_device *hdev;
2561 struct usb_interface *intf;
2562 struct usb_hub *hub;
2563 struct device *hub_dev;
2572 * We restart the list every time to avoid a deadlock with
2573 * deleting hubs downstream from this one. This should be
2574 * safe since we delete the hub from the event list.
2575 * Not the most efficient, but avoids deadlocks.
2579 /* Grab the first entry at the beginning of the list */
2580 spin_lock_irq(&hub_event_lock);
2581 if (list_empty(&hub_event_list)) {
2582 spin_unlock_irq(&hub_event_lock);
2586 tmp = hub_event_list.next;
2589 hub = list_entry(tmp, struct usb_hub, event_list);
2591 intf = to_usb_interface(hub->intfdev);
2592 hub_dev = &intf->dev;
2594 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
2595 hdev->state, hub->descriptor
2596 ? hub->descriptor->bNbrPorts
2598 /* NOTE: expects max 15 ports... */
2599 (u16) hub->change_bits[0],
2600 (u16) hub->event_bits[0]);
2603 spin_unlock_irq(&hub_event_lock);
2605 /* Lock the device, then check to see if we were
2606 * disconnected while waiting for the lock to succeed. */
2607 if (locktree(hdev) < 0) {
2611 if (hub != usb_get_intfdata(intf) || hub->quiescing)
2615 dev_dbg (hub_dev, "resetting for error %d\n",
2618 ret = usb_reset_device(hdev);
2621 "error resetting hub: %d\n", ret);
2629 /* deal with port status changes */
2630 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
2631 connect_change = test_bit(i, hub->change_bits);
2632 if (!test_and_clear_bit(i, hub->event_bits) &&
2636 ret = hub_port_status(hub, i,
2637 &portstatus, &portchange);
2641 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2642 clear_port_feature(hdev, i,
2643 USB_PORT_FEAT_C_CONNECTION);
2647 if (portchange & USB_PORT_STAT_C_ENABLE) {
2648 if (!connect_change)
2650 "port %d enable change, "
2653 clear_port_feature(hdev, i,
2654 USB_PORT_FEAT_C_ENABLE);
2657 * EM interference sometimes causes badly
2658 * shielded USB devices to be shutdown by
2659 * the hub, this hack enables them again.
2660 * Works at least with mouse driver.
2662 if (!(portstatus & USB_PORT_STAT_ENABLE)
2664 && hdev->children[i-1]) {
2667 "disabled by hub (EMI?), "
2674 if (portchange & USB_PORT_STAT_C_SUSPEND) {
2675 clear_port_feature(hdev, i,
2676 USB_PORT_FEAT_C_SUSPEND);
2677 if (hdev->children[i-1]) {
2678 ret = remote_wakeup(hdev->
2684 hub_port_disable(hub, i, 1);
2687 "resume on port %d, status %d\n",
2691 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
2693 "over-current change on port %d\n",
2695 clear_port_feature(hdev, i,
2696 USB_PORT_FEAT_C_OVER_CURRENT);
2700 if (portchange & USB_PORT_STAT_C_RESET) {
2702 "reset change on port %d\n",
2704 clear_port_feature(hdev, i,
2705 USB_PORT_FEAT_C_RESET);
2709 hub_port_connect_change(hub, i,
2710 portstatus, portchange);
2713 /* deal with hub status changes */
2714 if (test_and_clear_bit(0, hub->event_bits) == 0)
2716 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
2717 dev_err (hub_dev, "get_hub_status failed\n");
2719 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
2720 dev_dbg (hub_dev, "power change\n");
2721 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
2723 if (hubchange & HUB_CHANGE_OVERCURRENT) {
2724 dev_dbg (hub_dev, "overcurrent change\n");
2725 msleep(500); /* Cool down */
2726 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
2732 usb_unlock_device(hdev);
2735 } /* end while (1) */
2738 static int hub_thread(void *__unused)
2741 * This thread doesn't need any user-level access,
2742 * so get rid of all our resources
2746 allow_signal(SIGKILL);
2748 /* Send me a signal to get me die (for debugging) */
2751 wait_event_interruptible(khubd_wait, !list_empty(&hub_event_list));
2752 try_to_freeze(PF_FREEZE);
2753 } while (!signal_pending(current));
2755 pr_debug ("%s: khubd exiting\n", usbcore_name);
2756 complete_and_exit(&khubd_exited, 0);
2759 static struct usb_device_id hub_id_table [] = {
2760 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
2761 .bDeviceClass = USB_CLASS_HUB},
2762 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
2763 .bInterfaceClass = USB_CLASS_HUB},
2764 { } /* Terminating entry */
2767 MODULE_DEVICE_TABLE (usb, hub_id_table);
2769 static struct usb_driver hub_driver = {
2770 .owner = THIS_MODULE,
2773 .disconnect = hub_disconnect,
2774 .suspend = hub_suspend,
2775 .resume = hub_resume,
2777 .id_table = hub_id_table,
2780 int usb_hub_init(void)
2784 if (usb_register(&hub_driver) < 0) {
2785 printk(KERN_ERR "%s: can't register hub driver\n",
2790 pid = kernel_thread(hub_thread, NULL, CLONE_KERNEL);
2797 /* Fall through if kernel_thread failed */
2798 usb_deregister(&hub_driver);
2799 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
2804 void usb_hub_cleanup(void)
2808 /* Kill the thread */
2809 ret = kill_proc(khubd_pid, SIGKILL, 1);
2811 wait_for_completion(&khubd_exited);
2814 * Hub resources are freed for us by usb_deregister. It calls
2815 * usb_driver_purge on every device which in turn calls that
2816 * devices disconnect function if it is using this driver.
2817 * The hub_disconnect function takes care of releasing the
2818 * individual hub resources. -greg
2820 usb_deregister(&hub_driver);
2821 } /* usb_hub_cleanup() */
2824 static int config_descriptors_changed(struct usb_device *udev)
2828 struct usb_config_descriptor *buf;
2830 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2831 if (len < le16_to_cpu(udev->config[index].desc.wTotalLength))
2832 len = le16_to_cpu(udev->config[index].desc.wTotalLength);
2834 buf = kmalloc (len, SLAB_KERNEL);
2836 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
2837 /* assume the worst */
2840 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2842 int old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
2844 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
2846 if (length < old_length) {
2847 dev_dbg(&udev->dev, "config index %d, error %d\n",
2851 if (memcmp (buf, udev->rawdescriptors[index], old_length)
2853 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
2854 index, buf->bConfigurationValue);
2859 return index != udev->descriptor.bNumConfigurations;
2863 * usb_reset_device - perform a USB port reset to reinitialize a device
2864 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
2866 * WARNING - don't reset any device unless drivers for all of its
2867 * interfaces are expecting that reset! Maybe some driver->reset()
2868 * method should eventually help ensure sufficient cooperation.
2870 * Do a port reset, reassign the device's address, and establish its
2871 * former operating configuration. If the reset fails, or the device's
2872 * descriptors change from their values before the reset, or the original
2873 * configuration and altsettings cannot be restored, a flag will be set
2874 * telling khubd to pretend the device has been disconnected and then
2875 * re-connected. All drivers will be unbound, and the device will be
2876 * re-enumerated and probed all over again.
2878 * Returns 0 if the reset succeeded, -ENODEV if the device has been
2879 * flagged for logical disconnection, or some other negative error code
2880 * if the reset wasn't even attempted.
2882 * The caller must own the device lock. For example, it's safe to use
2883 * this from a driver probe() routine after downloading new firmware.
2884 * For calls that might not occur during probe(), drivers should lock
2885 * the device using usb_lock_device_for_reset().
2887 int usb_reset_device(struct usb_device *udev)
2889 struct usb_device *parent_hdev = udev->parent;
2890 struct usb_hub *parent_hub;
2891 struct usb_device_descriptor descriptor = udev->descriptor;
2892 struct usb_hub *hub = NULL;
2893 int i, ret = 0, port1 = -1;
2895 if (udev->state == USB_STATE_NOTATTACHED ||
2896 udev->state == USB_STATE_SUSPENDED) {
2897 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
2903 /* this requires hcd-specific logic; see OHCI hc_restart() */
2904 dev_dbg(&udev->dev, "%s for root hub!\n", __FUNCTION__);
2908 for (i = 0; i < parent_hdev->maxchild; i++)
2909 if (parent_hdev->children[i] == udev) {
2915 /* If this ever happens, it's very bad */
2916 dev_err(&udev->dev, "Can't locate device's port!\n");
2919 parent_hub = hdev_to_hub(parent_hdev);
2921 /* If we're resetting an active hub, take some special actions */
2922 if (udev->actconfig &&
2923 udev->actconfig->interface[0]->dev.driver ==
2924 &hub_driver.driver &&
2925 (hub = hdev_to_hub(udev)) != NULL) {
2929 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
2931 /* ep0 maxpacket size may change; let the HCD know about it.
2932 * Other endpoints will be handled by re-enumeration. */
2934 ret = hub_port_init(parent_hub, udev, port1, i);
2941 /* Device might have changed firmware (DFU or similar) */
2942 if (memcmp(&udev->descriptor, &descriptor, sizeof descriptor)
2943 || config_descriptors_changed (udev)) {
2944 dev_info(&udev->dev, "device firmware changed\n");
2945 udev->descriptor = descriptor; /* for disconnect() calls */
2949 if (!udev->actconfig)
2952 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2953 USB_REQ_SET_CONFIGURATION, 0,
2954 udev->actconfig->desc.bConfigurationValue, 0,
2955 NULL, 0, HZ * USB_CTRL_SET_TIMEOUT);
2958 "can't restore configuration #%d (error=%d)\n",
2959 udev->actconfig->desc.bConfigurationValue, ret);
2962 usb_set_device_state(udev, USB_STATE_CONFIGURED);
2964 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
2965 struct usb_interface *intf = udev->actconfig->interface[i];
2966 struct usb_interface_descriptor *desc;
2968 /* set_interface resets host side toggle even
2969 * for altsetting zero. the interface may have no driver.
2971 desc = &intf->cur_altsetting->desc;
2972 ret = usb_set_interface(udev, desc->bInterfaceNumber,
2973 desc->bAlternateSetting);
2975 dev_err(&udev->dev, "failed to restore interface %d "
2976 "altsetting %d (error=%d)\n",
2977 desc->bInterfaceNumber,
2978 desc->bAlternateSetting,
2986 hub_post_reset(hub);
2990 hub_port_logical_disconnect(parent_hub, port1);