4 * (C) Copyright 1999 Linus Torvalds
5 * (C) Copyright 1999 Johannes Erdfelt
6 * (C) Copyright 1999 Gregory P. Smith
7 * (C) Copyright 2001 Brad Hards (bhards@bigpond.net.au)
11 #include <linux/config.h>
12 #include <linux/kernel.h>
13 #include <linux/errno.h>
14 #include <linux/module.h>
15 #include <linux/moduleparam.h>
16 #include <linux/completion.h>
17 #include <linux/sched.h>
18 #include <linux/list.h>
19 #include <linux/slab.h>
20 #include <linux/smp_lock.h>
21 #include <linux/ioctl.h>
22 #include <linux/usb.h>
23 #include <linux/usbdevice_fs.h>
24 #include <linux/kthread.h>
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
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
436 /* if hub supports power switching, enable power on each port */
437 if ((wHubCharacteristics
& HUB_CHAR_LPSM
) < 2) {
438 dev_dbg(hub
->intfdev
, "enabling power on all ports\n");
439 for (port1
= 1; port1
<= hub
->descriptor
->bNbrPorts
; port1
++)
440 set_port_feature(hub
->hdev
, port1
,
441 USB_PORT_FEAT_POWER
);
444 /* Wait at least 100 msec for power to become stable */
445 msleep(max(pgood_delay
, (unsigned) 100));
448 static inline void __hub_quiesce(struct usb_hub
*hub
)
450 /* (nonblocking) khubd and related activity won't re-trigger */
453 hub
->resume_root_hub
= 0;
456 static void hub_quiesce(struct usb_hub
*hub
)
458 /* (blocking) stop khubd and related activity */
460 usb_kill_urb(hub
->urb
);
461 if (hub
->has_indicators
)
462 cancel_delayed_work(&hub
->leds
);
463 if (hub
->has_indicators
|| hub
->tt
.hub
)
464 flush_scheduled_work();
467 static void hub_activate(struct usb_hub
*hub
)
473 hub
->resume_root_hub
= 0;
474 status
= usb_submit_urb(hub
->urb
, GFP_NOIO
);
476 dev_err(hub
->intfdev
, "activate --> %d\n", status
);
477 if (hub
->has_indicators
&& blinkenlights
)
478 schedule_delayed_work(&hub
->leds
, LED_CYCLE_PERIOD
);
480 /* scan all ports ASAP */
484 static int hub_hub_status(struct usb_hub
*hub
,
485 u16
*status
, u16
*change
)
489 ret
= get_hub_status(hub
->hdev
, &hub
->status
->hub
);
491 dev_err (hub
->intfdev
,
492 "%s failed (err = %d)\n", __FUNCTION__
, ret
);
494 *status
= le16_to_cpu(hub
->status
->hub
.wHubStatus
);
495 *change
= le16_to_cpu(hub
->status
->hub
.wHubChange
);
501 static int hub_port_disable(struct usb_hub
*hub
, int port1
, int set_state
)
503 struct usb_device
*hdev
= hub
->hdev
;
506 if (hdev
->children
[port1
-1] && set_state
) {
507 usb_set_device_state(hdev
->children
[port1
-1],
508 USB_STATE_NOTATTACHED
);
510 ret
= clear_port_feature(hdev
, port1
, USB_PORT_FEAT_ENABLE
);
512 dev_err(hub
->intfdev
, "cannot disable port %d (err = %d)\n",
519 /* caller has locked the hub device */
520 static void hub_pre_reset(struct usb_hub
*hub
, int disable_ports
)
522 struct usb_device
*hdev
= hub
->hdev
;
525 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
526 if (hdev
->children
[port1
- 1]) {
527 usb_disconnect(&hdev
->children
[port1
- 1]);
529 hub_port_disable(hub
, port1
, 0);
535 /* caller has locked the hub device */
536 static void hub_post_reset(struct usb_hub
*hub
)
543 static int hub_configure(struct usb_hub
*hub
,
544 struct usb_endpoint_descriptor
*endpoint
)
546 struct usb_device
*hdev
= hub
->hdev
;
547 struct device
*hub_dev
= hub
->intfdev
;
548 u16 hubstatus
, hubchange
;
549 u16 wHubCharacteristics
;
554 hub
->buffer
= usb_buffer_alloc(hdev
, sizeof(*hub
->buffer
), GFP_KERNEL
,
557 message
= "can't allocate hub irq buffer";
562 hub
->status
= kmalloc(sizeof(*hub
->status
), GFP_KERNEL
);
564 message
= "can't kmalloc hub status buffer";
569 hub
->descriptor
= kmalloc(sizeof(*hub
->descriptor
), GFP_KERNEL
);
570 if (!hub
->descriptor
) {
571 message
= "can't kmalloc hub descriptor";
576 /* Request the entire hub descriptor.
577 * hub->descriptor can handle USB_MAXCHILDREN ports,
578 * but the hub can/will return fewer bytes here.
580 ret
= get_hub_descriptor(hdev
, hub
->descriptor
,
581 sizeof(*hub
->descriptor
));
583 message
= "can't read hub descriptor";
585 } else if (hub
->descriptor
->bNbrPorts
> USB_MAXCHILDREN
) {
586 message
= "hub has too many ports!";
591 hdev
->maxchild
= hub
->descriptor
->bNbrPorts
;
592 dev_info (hub_dev
, "%d port%s detected\n", hdev
->maxchild
,
593 (hdev
->maxchild
== 1) ? "" : "s");
595 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
597 if (wHubCharacteristics
& HUB_CHAR_COMPOUND
) {
599 char portstr
[USB_MAXCHILDREN
+ 1];
601 for (i
= 0; i
< hdev
->maxchild
; i
++)
602 portstr
[i
] = hub
->descriptor
->DeviceRemovable
603 [((i
+ 1) / 8)] & (1 << ((i
+ 1) % 8))
605 portstr
[hdev
->maxchild
] = 0;
606 dev_dbg(hub_dev
, "compound device; port removable status: %s\n", portstr
);
608 dev_dbg(hub_dev
, "standalone hub\n");
610 switch (wHubCharacteristics
& HUB_CHAR_LPSM
) {
612 dev_dbg(hub_dev
, "ganged power switching\n");
615 dev_dbg(hub_dev
, "individual port power switching\n");
619 dev_dbg(hub_dev
, "no power switching (usb 1.0)\n");
623 switch (wHubCharacteristics
& HUB_CHAR_OCPM
) {
625 dev_dbg(hub_dev
, "global over-current protection\n");
628 dev_dbg(hub_dev
, "individual port over-current protection\n");
632 dev_dbg(hub_dev
, "no over-current protection\n");
636 spin_lock_init (&hub
->tt
.lock
);
637 INIT_LIST_HEAD (&hub
->tt
.clear_list
);
638 INIT_WORK (&hub
->tt
.kevent
, hub_tt_kevent
, hub
);
639 switch (hdev
->descriptor
.bDeviceProtocol
) {
643 dev_dbg(hub_dev
, "Single TT\n");
647 ret
= usb_set_interface(hdev
, 0, 1);
649 dev_dbg(hub_dev
, "TT per port\n");
652 dev_err(hub_dev
, "Using single TT (err %d)\n",
657 dev_dbg(hub_dev
, "Unrecognized hub protocol %d\n",
658 hdev
->descriptor
.bDeviceProtocol
);
662 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
663 switch (wHubCharacteristics
& HUB_CHAR_TTTT
) {
664 case HUB_TTTT_8_BITS
:
665 if (hdev
->descriptor
.bDeviceProtocol
!= 0) {
666 hub
->tt
.think_time
= 666;
667 dev_dbg(hub_dev
, "TT requires at most %d "
668 "FS bit times (%d ns)\n",
669 8, hub
->tt
.think_time
);
672 case HUB_TTTT_16_BITS
:
673 hub
->tt
.think_time
= 666 * 2;
674 dev_dbg(hub_dev
, "TT requires at most %d "
675 "FS bit times (%d ns)\n",
676 16, hub
->tt
.think_time
);
678 case HUB_TTTT_24_BITS
:
679 hub
->tt
.think_time
= 666 * 3;
680 dev_dbg(hub_dev
, "TT requires at most %d "
681 "FS bit times (%d ns)\n",
682 24, hub
->tt
.think_time
);
684 case HUB_TTTT_32_BITS
:
685 hub
->tt
.think_time
= 666 * 4;
686 dev_dbg(hub_dev
, "TT requires at most %d "
687 "FS bit times (%d ns)\n",
688 32, hub
->tt
.think_time
);
692 /* probe() zeroes hub->indicator[] */
693 if (wHubCharacteristics
& HUB_CHAR_PORTIND
) {
694 hub
->has_indicators
= 1;
695 dev_dbg(hub_dev
, "Port indicators are supported\n");
698 dev_dbg(hub_dev
, "power on to power good time: %dms\n",
699 hub
->descriptor
->bPwrOn2PwrGood
* 2);
701 /* power budgeting mostly matters with bus-powered hubs,
702 * and battery-powered root hubs (may provide just 8 mA).
704 ret
= usb_get_status(hdev
, USB_RECIP_DEVICE
, 0, &hubstatus
);
706 message
= "can't get hub status";
709 le16_to_cpus(&hubstatus
);
710 if (hdev
== hdev
->bus
->root_hub
) {
711 if (hdev
->bus_mA
== 0 || hdev
->bus_mA
>= 500)
712 hub
->mA_per_port
= 500;
714 hub
->mA_per_port
= hdev
->bus_mA
;
715 hub
->limited_power
= 1;
717 } else if ((hubstatus
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
718 dev_dbg(hub_dev
, "hub controller current requirement: %dmA\n",
719 hub
->descriptor
->bHubContrCurrent
);
720 hub
->limited_power
= 1;
721 if (hdev
->maxchild
> 0) {
722 int remaining
= hdev
->bus_mA
-
723 hub
->descriptor
->bHubContrCurrent
;
725 if (remaining
< hdev
->maxchild
* 100)
727 "insufficient power available "
728 "to use all downstream ports\n");
729 hub
->mA_per_port
= 100; /* 7.2.1.1 */
731 } else { /* Self-powered external hub */
732 /* FIXME: What about battery-powered external hubs that
733 * provide less current per port? */
734 hub
->mA_per_port
= 500;
736 if (hub
->mA_per_port
< 500)
737 dev_dbg(hub_dev
, "%umA bus power budget for each child\n",
740 ret
= hub_hub_status(hub
, &hubstatus
, &hubchange
);
742 message
= "can't get hub status";
746 /* local power status reports aren't always correct */
747 if (hdev
->actconfig
->desc
.bmAttributes
& USB_CONFIG_ATT_SELFPOWER
)
748 dev_dbg(hub_dev
, "local power source is %s\n",
749 (hubstatus
& HUB_STATUS_LOCAL_POWER
)
750 ? "lost (inactive)" : "good");
752 if ((wHubCharacteristics
& HUB_CHAR_OCPM
) == 0)
753 dev_dbg(hub_dev
, "%sover-current condition exists\n",
754 (hubstatus
& HUB_STATUS_OVERCURRENT
) ? "" : "no ");
756 /* set up the interrupt endpoint */
757 pipe
= usb_rcvintpipe(hdev
, endpoint
->bEndpointAddress
);
758 maxp
= usb_maxpacket(hdev
, pipe
, usb_pipeout(pipe
));
760 if (maxp
> sizeof(*hub
->buffer
))
761 maxp
= sizeof(*hub
->buffer
);
763 hub
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
765 message
= "couldn't allocate interrupt urb";
770 usb_fill_int_urb(hub
->urb
, hdev
, pipe
, *hub
->buffer
, maxp
, hub_irq
,
771 hub
, endpoint
->bInterval
);
772 hub
->urb
->transfer_dma
= hub
->buffer_dma
;
773 hub
->urb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
775 /* maybe cycle the hub leds */
776 if (hub
->has_indicators
&& blinkenlights
)
777 hub
->indicator
[0] = INDICATOR_CYCLE
;
784 dev_err (hub_dev
, "config failed, %s (err %d)\n",
786 /* hub_disconnect() frees urb and descriptor */
790 static unsigned highspeed_hubs
;
792 static void hub_disconnect(struct usb_interface
*intf
)
794 struct usb_hub
*hub
= usb_get_intfdata (intf
);
795 struct usb_device
*hdev
;
797 usb_set_intfdata (intf
, NULL
);
800 if (hdev
->speed
== USB_SPEED_HIGH
)
803 /* Disconnect all children and quiesce the hub */
804 hub_pre_reset(hub
, 1);
806 usb_free_urb(hub
->urb
);
809 spin_lock_irq(&hub_event_lock
);
810 list_del_init(&hub
->event_list
);
811 spin_unlock_irq(&hub_event_lock
);
813 kfree(hub
->descriptor
);
814 hub
->descriptor
= NULL
;
820 usb_buffer_free(hdev
, sizeof(*hub
->buffer
), hub
->buffer
,
828 static int hub_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
830 struct usb_host_interface
*desc
;
831 struct usb_endpoint_descriptor
*endpoint
;
832 struct usb_device
*hdev
;
835 desc
= intf
->cur_altsetting
;
836 hdev
= interface_to_usbdev(intf
);
838 /* Some hubs have a subclass of 1, which AFAICT according to the */
839 /* specs is not defined, but it works */
840 if ((desc
->desc
.bInterfaceSubClass
!= 0) &&
841 (desc
->desc
.bInterfaceSubClass
!= 1)) {
843 dev_err (&intf
->dev
, "bad descriptor, ignoring hub\n");
847 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
848 if (desc
->desc
.bNumEndpoints
!= 1)
849 goto descriptor_error
;
851 endpoint
= &desc
->endpoint
[0].desc
;
853 /* Output endpoint? Curiouser and curiouser.. */
854 if (!(endpoint
->bEndpointAddress
& USB_DIR_IN
))
855 goto descriptor_error
;
857 /* If it's not an interrupt endpoint, we'd better punt! */
858 if ((endpoint
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
)
859 != USB_ENDPOINT_XFER_INT
)
860 goto descriptor_error
;
863 dev_info (&intf
->dev
, "USB hub found\n");
865 hub
= kzalloc(sizeof(*hub
), GFP_KERNEL
);
867 dev_dbg (&intf
->dev
, "couldn't kmalloc hub struct\n");
871 INIT_LIST_HEAD(&hub
->event_list
);
872 hub
->intfdev
= &intf
->dev
;
874 INIT_WORK(&hub
->leds
, led_work
, hub
);
876 usb_set_intfdata (intf
, hub
);
878 if (hdev
->speed
== USB_SPEED_HIGH
)
881 if (hub_configure(hub
, endpoint
) >= 0)
884 hub_disconnect (intf
);
889 hub_ioctl(struct usb_interface
*intf
, unsigned int code
, void *user_data
)
891 struct usb_device
*hdev
= interface_to_usbdev (intf
);
893 /* assert ifno == 0 (part of hub spec) */
895 case USBDEVFS_HUB_PORTINFO
: {
896 struct usbdevfs_hub_portinfo
*info
= user_data
;
899 spin_lock_irq(&device_state_lock
);
900 if (hdev
->devnum
<= 0)
903 info
->nports
= hdev
->maxchild
;
904 for (i
= 0; i
< info
->nports
; i
++) {
905 if (hdev
->children
[i
] == NULL
)
909 hdev
->children
[i
]->devnum
;
912 spin_unlock_irq(&device_state_lock
);
914 return info
->nports
+ 1;
923 /* grab device/port lock, returning index of that port (zero based).
924 * protects the upstream link used by this device from concurrent
925 * tree operations like suspend, resume, reset, and disconnect, which
926 * apply to everything downstream of a given port.
928 static int locktree(struct usb_device
*udev
)
931 struct usb_device
*hdev
;
936 /* root hub is always the first lock in the series */
939 usb_lock_device(udev
);
943 /* on the path from root to us, lock everything from
944 * top down, dropping parent locks when not needed
949 for (t
= 0; t
< hdev
->maxchild
; t
++) {
950 if (hdev
->children
[t
] == udev
) {
951 /* everything is fail-fast once disconnect
954 if (udev
->state
== USB_STATE_NOTATTACHED
)
957 /* when everyone grabs locks top->bottom,
958 * non-overlapping work may be concurrent
960 usb_lock_device(udev
);
961 usb_unlock_device(hdev
);
965 usb_unlock_device(hdev
);
969 static void recursively_mark_NOTATTACHED(struct usb_device
*udev
)
973 for (i
= 0; i
< udev
->maxchild
; ++i
) {
974 if (udev
->children
[i
])
975 recursively_mark_NOTATTACHED(udev
->children
[i
]);
977 udev
->state
= USB_STATE_NOTATTACHED
;
981 * usb_set_device_state - change a device's current state (usbcore, hcds)
982 * @udev: pointer to device whose state should be changed
983 * @new_state: new state value to be stored
985 * udev->state is _not_ fully protected by the device lock. Although
986 * most transitions are made only while holding the lock, the state can
987 * can change to USB_STATE_NOTATTACHED at almost any time. This
988 * is so that devices can be marked as disconnected as soon as possible,
989 * without having to wait for any semaphores to be released. As a result,
990 * all changes to any device's state must be protected by the
991 * device_state_lock spinlock.
993 * Once a device has been added to the device tree, all changes to its state
994 * should be made using this routine. The state should _not_ be set directly.
996 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
997 * Otherwise udev->state is set to new_state, and if new_state is
998 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
999 * to USB_STATE_NOTATTACHED.
1001 void usb_set_device_state(struct usb_device
*udev
,
1002 enum usb_device_state new_state
)
1004 unsigned long flags
;
1006 spin_lock_irqsave(&device_state_lock
, flags
);
1007 if (udev
->state
== USB_STATE_NOTATTACHED
)
1009 else if (new_state
!= USB_STATE_NOTATTACHED
) {
1010 udev
->state
= new_state
;
1011 if (new_state
== USB_STATE_CONFIGURED
)
1012 device_init_wakeup(&udev
->dev
,
1013 (udev
->actconfig
->desc
.bmAttributes
1014 & USB_CONFIG_ATT_WAKEUP
));
1015 else if (new_state
!= USB_STATE_SUSPENDED
)
1016 device_init_wakeup(&udev
->dev
, 0);
1018 recursively_mark_NOTATTACHED(udev
);
1019 spin_unlock_irqrestore(&device_state_lock
, flags
);
1021 EXPORT_SYMBOL(usb_set_device_state
);
1027 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
1028 * @rhdev: struct usb_device for the root hub
1030 * The USB host controller driver calls this function when its root hub
1031 * is resumed and Vbus power has been interrupted or the controller
1032 * has been reset. The routine marks all the children of the root hub
1033 * as NOTATTACHED and marks logical connect-change events on their ports.
1035 void usb_root_hub_lost_power(struct usb_device
*rhdev
)
1037 struct usb_hub
*hub
;
1039 unsigned long flags
;
1041 dev_warn(&rhdev
->dev
, "root hub lost power or was reset\n");
1042 spin_lock_irqsave(&device_state_lock
, flags
);
1043 hub
= hdev_to_hub(rhdev
);
1044 for (port1
= 1; port1
<= rhdev
->maxchild
; ++port1
) {
1045 if (rhdev
->children
[port1
- 1]) {
1046 recursively_mark_NOTATTACHED(
1047 rhdev
->children
[port1
- 1]);
1048 set_bit(port1
, hub
->change_bits
);
1051 spin_unlock_irqrestore(&device_state_lock
, flags
);
1053 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power
);
1057 static void choose_address(struct usb_device
*udev
)
1060 struct usb_bus
*bus
= udev
->bus
;
1062 /* If khubd ever becomes multithreaded, this will need a lock */
1064 /* Try to allocate the next devnum beginning at bus->devnum_next. */
1065 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
, 128,
1068 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
, 128, 1);
1070 bus
->devnum_next
= ( devnum
>= 127 ? 1 : devnum
+ 1);
1073 set_bit(devnum
, bus
->devmap
.devicemap
);
1074 udev
->devnum
= devnum
;
1078 static void release_address(struct usb_device
*udev
)
1080 if (udev
->devnum
> 0) {
1081 clear_bit(udev
->devnum
, udev
->bus
->devmap
.devicemap
);
1087 * usb_disconnect - disconnect a device (usbcore-internal)
1088 * @pdev: pointer to device being disconnected
1089 * Context: !in_interrupt ()
1091 * Something got disconnected. Get rid of it and all of its children.
1093 * If *pdev is a normal device then the parent hub must already be locked.
1094 * If *pdev is a root hub then this routine will acquire the
1095 * usb_bus_list_lock on behalf of the caller.
1097 * Only hub drivers (including virtual root hub drivers for host
1098 * controllers) should ever call this.
1100 * This call is synchronous, and may not be used in an interrupt context.
1102 void usb_disconnect(struct usb_device
**pdev
)
1104 struct usb_device
*udev
= *pdev
;
1108 pr_debug ("%s nodev\n", __FUNCTION__
);
1112 /* mark the device as inactive, so any further urb submissions for
1113 * this device (and any of its children) will fail immediately.
1114 * this quiesces everyting except pending urbs.
1116 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
1117 dev_info (&udev
->dev
, "USB disconnect, address %d\n", udev
->devnum
);
1119 usb_lock_device(udev
);
1121 /* Free up all the children before we remove this device */
1122 for (i
= 0; i
< USB_MAXCHILDREN
; i
++) {
1123 if (udev
->children
[i
])
1124 usb_disconnect(&udev
->children
[i
]);
1127 /* deallocate hcd/hardware state ... nuking all pending urbs and
1128 * cleaning up all state associated with the current configuration
1129 * so that the hardware is now fully quiesced.
1131 usb_disable_device(udev
, 0);
1133 usb_notify_remove_device(udev
);
1135 /* Free the device number, remove the /proc/bus/usb entry and
1136 * the sysfs attributes, and delete the parent's children[]
1137 * (or root_hub) pointer.
1139 dev_dbg (&udev
->dev
, "unregistering device\n");
1140 release_address(udev
);
1141 usb_remove_sysfs_dev_files(udev
);
1143 /* Avoid races with recursively_mark_NOTATTACHED() */
1144 spin_lock_irq(&device_state_lock
);
1146 spin_unlock_irq(&device_state_lock
);
1148 usb_unlock_device(udev
);
1150 device_unregister(&udev
->dev
);
1153 static inline const char *plural(int n
)
1155 return (n
== 1 ? "" : "s");
1158 static int choose_configuration(struct usb_device
*udev
)
1164 struct usb_host_config
*c
, *best
;
1166 /* If this fails, assume the device is bus-powered */
1168 usb_get_status(udev
, USB_RECIP_DEVICE
, 0, &devstatus
);
1169 le16_to_cpus(&devstatus
);
1170 bus_powered
= ((devstatus
& (1 << USB_DEVICE_SELF_POWERED
)) == 0);
1171 dev_dbg(&udev
->dev
, "device is %s-powered\n",
1172 bus_powered
? "bus" : "self");
1176 num_configs
= udev
->descriptor
.bNumConfigurations
;
1177 for (i
= 0; i
< num_configs
; (i
++, c
++)) {
1178 struct usb_interface_descriptor
*desc
=
1179 &c
->intf_cache
[0]->altsetting
->desc
;
1182 * HP's USB bus-powered keyboard has only one configuration
1183 * and it claims to be self-powered; other devices may have
1184 * similar errors in their descriptors. If the next test
1185 * were allowed to execute, such configurations would always
1186 * be rejected and the devices would not work as expected.
1189 /* Rule out self-powered configs for a bus-powered device */
1190 if (bus_powered
&& (c
->desc
.bmAttributes
&
1191 USB_CONFIG_ATT_SELFPOWER
))
1196 * The next test may not be as effective as it should be.
1197 * Some hubs have errors in their descriptor, claiming
1198 * to be self-powered when they are really bus-powered.
1199 * We will overestimate the amount of current such hubs
1200 * make available for each port.
1202 * This is a fairly benign sort of failure. It won't
1203 * cause us to reject configurations that we should have
1207 /* Rule out configs that draw too much bus current */
1208 if (c
->desc
.bMaxPower
* 2 > udev
->bus_mA
)
1211 /* If the first config's first interface is COMM/2/0xff
1212 * (MSFT RNDIS), rule it out unless Linux has host-side
1214 if (i
== 0 && desc
->bInterfaceClass
== USB_CLASS_COMM
1215 && desc
->bInterfaceSubClass
== 2
1216 && desc
->bInterfaceProtocol
== 0xff) {
1217 #ifndef CONFIG_USB_NET_RNDIS
1224 /* From the remaining configs, choose the first one whose
1225 * first interface is for a non-vendor-specific class.
1226 * Reason: Linux is more likely to have a class driver
1227 * than a vendor-specific driver. */
1228 else if (udev
->descriptor
.bDeviceClass
!=
1229 USB_CLASS_VENDOR_SPEC
&&
1230 desc
->bInterfaceClass
!=
1231 USB_CLASS_VENDOR_SPEC
) {
1236 /* If all the remaining configs are vendor-specific,
1237 * choose the first one. */
1243 i
= best
->desc
.bConfigurationValue
;
1244 dev_info(&udev
->dev
,
1245 "configuration #%d chosen from %d choice%s\n",
1246 i
, num_configs
, plural(num_configs
));
1249 dev_warn(&udev
->dev
,
1250 "no configuration chosen from %d choice%s\n",
1251 num_configs
, plural(num_configs
));
1257 static void show_string(struct usb_device
*udev
, char *id
, char *string
)
1261 dev_printk(KERN_INFO
, &udev
->dev
, "%s: %s\n", id
, string
);
1265 static inline void show_string(struct usb_device
*udev
, char *id
, char *string
)
1270 #ifdef CONFIG_USB_OTG
1271 #include "otg_whitelist.h"
1275 * usb_new_device - perform initial device setup (usbcore-internal)
1276 * @udev: newly addressed device (in ADDRESS state)
1278 * This is called with devices which have been enumerated, but not yet
1279 * configured. The device descriptor is available, but not descriptors
1280 * for any device configuration. The caller must have locked either
1281 * the parent hub (if udev is a normal device) or else the
1282 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1283 * udev has already been installed, but udev is not yet visible through
1284 * sysfs or other filesystem code.
1286 * Returns 0 for success (device is configured and listed, with its
1287 * interfaces, in sysfs); else a negative errno value.
1289 * This call is synchronous, and may not be used in an interrupt context.
1291 * Only the hub driver or root-hub registrar should ever call this.
1293 int usb_new_device(struct usb_device
*udev
)
1298 err
= usb_get_configuration(udev
);
1300 dev_err(&udev
->dev
, "can't read configurations, error %d\n",
1305 /* read the standard strings and cache them if present */
1306 udev
->product
= usb_cache_string(udev
, udev
->descriptor
.iProduct
);
1307 udev
->manufacturer
= usb_cache_string(udev
,
1308 udev
->descriptor
.iManufacturer
);
1309 udev
->serial
= usb_cache_string(udev
, udev
->descriptor
.iSerialNumber
);
1311 /* Tell the world! */
1312 dev_dbg(&udev
->dev
, "new device strings: Mfr=%d, Product=%d, "
1313 "SerialNumber=%d\n",
1314 udev
->descriptor
.iManufacturer
,
1315 udev
->descriptor
.iProduct
,
1316 udev
->descriptor
.iSerialNumber
);
1317 show_string(udev
, "Product", udev
->product
);
1318 show_string(udev
, "Manufacturer", udev
->manufacturer
);
1319 show_string(udev
, "SerialNumber", udev
->serial
);
1321 #ifdef CONFIG_USB_OTG
1323 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1324 * to wake us after we've powered off VBUS; and HNP, switching roles
1325 * "host" to "peripheral". The OTG descriptor helps figure this out.
1327 if (!udev
->bus
->is_b_host
1329 && udev
->parent
== udev
->bus
->root_hub
) {
1330 struct usb_otg_descriptor
*desc
= 0;
1331 struct usb_bus
*bus
= udev
->bus
;
1333 /* descriptor may appear anywhere in config */
1334 if (__usb_get_extra_descriptor (udev
->rawdescriptors
[0],
1335 le16_to_cpu(udev
->config
[0].desc
.wTotalLength
),
1336 USB_DT_OTG
, (void **) &desc
) == 0) {
1337 if (desc
->bmAttributes
& USB_OTG_HNP
) {
1339 struct usb_device
*root
= udev
->parent
;
1341 for (port1
= 1; port1
<= root
->maxchild
;
1343 if (root
->children
[port1
-1] == udev
)
1347 dev_info(&udev
->dev
,
1348 "Dual-Role OTG device on %sHNP port\n",
1349 (port1
== bus
->otg_port
)
1352 /* enable HNP before suspend, it's simpler */
1353 if (port1
== bus
->otg_port
)
1354 bus
->b_hnp_enable
= 1;
1355 err
= usb_control_msg(udev
,
1356 usb_sndctrlpipe(udev
, 0),
1357 USB_REQ_SET_FEATURE
, 0,
1359 ? USB_DEVICE_B_HNP_ENABLE
1360 : USB_DEVICE_A_ALT_HNP_SUPPORT
,
1361 0, NULL
, 0, USB_CTRL_SET_TIMEOUT
);
1363 /* OTG MESSAGE: report errors here,
1364 * customize to match your product.
1366 dev_info(&udev
->dev
,
1367 "can't set HNP mode; %d\n",
1369 bus
->b_hnp_enable
= 0;
1375 if (!is_targeted(udev
)) {
1377 /* Maybe it can talk to us, though we can't talk to it.
1378 * (Includes HNP test device.)
1380 if (udev
->bus
->b_hnp_enable
|| udev
->bus
->is_b_host
) {
1381 static int __usb_suspend_device(struct usb_device
*,
1383 err
= __usb_suspend_device(udev
, udev
->bus
->otg_port
);
1385 dev_dbg(&udev
->dev
, "HNP fail, %d\n", err
);
1392 /* put device-specific files into sysfs */
1393 err
= device_add (&udev
->dev
);
1395 dev_err(&udev
->dev
, "can't device_add, error %d\n", err
);
1398 usb_create_sysfs_dev_files (udev
);
1400 usb_lock_device(udev
);
1402 /* choose and set the configuration. that registers the interfaces
1403 * with the driver core, and lets usb device drivers bind to them.
1405 c
= choose_configuration(udev
);
1407 err
= usb_set_configuration(udev
, c
);
1409 dev_err(&udev
->dev
, "can't set config #%d, error %d\n",
1411 /* This need not be fatal. The user can try to
1412 * set other configurations. */
1416 /* USB device state == configured ... usable */
1417 usb_notify_add_device(udev
);
1419 usb_unlock_device(udev
);
1424 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
1429 static int hub_port_status(struct usb_hub
*hub
, int port1
,
1430 u16
*status
, u16
*change
)
1434 ret
= get_port_status(hub
->hdev
, port1
, &hub
->status
->port
);
1436 dev_err (hub
->intfdev
,
1437 "%s failed (err = %d)\n", __FUNCTION__
, ret
);
1439 *status
= le16_to_cpu(hub
->status
->port
.wPortStatus
);
1440 *change
= le16_to_cpu(hub
->status
->port
.wPortChange
);
1446 #define PORT_RESET_TRIES 5
1447 #define SET_ADDRESS_TRIES 2
1448 #define GET_DESCRIPTOR_TRIES 2
1449 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1450 #define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1452 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1453 #define HUB_SHORT_RESET_TIME 10
1454 #define HUB_LONG_RESET_TIME 200
1455 #define HUB_RESET_TIMEOUT 500
1457 static int hub_port_wait_reset(struct usb_hub
*hub
, int port1
,
1458 struct usb_device
*udev
, unsigned int delay
)
1460 int delay_time
, ret
;
1464 for (delay_time
= 0;
1465 delay_time
< HUB_RESET_TIMEOUT
;
1466 delay_time
+= delay
) {
1467 /* wait to give the device a chance to reset */
1470 /* read and decode port status */
1471 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
1475 /* Device went away? */
1476 if (!(portstatus
& USB_PORT_STAT_CONNECTION
))
1479 /* bomb out completely if something weird happened */
1480 if ((portchange
& USB_PORT_STAT_C_CONNECTION
))
1483 /* if we`ve finished resetting, then break out of the loop */
1484 if (!(portstatus
& USB_PORT_STAT_RESET
) &&
1485 (portstatus
& USB_PORT_STAT_ENABLE
)) {
1486 if (portstatus
& USB_PORT_STAT_HIGH_SPEED
)
1487 udev
->speed
= USB_SPEED_HIGH
;
1488 else if (portstatus
& USB_PORT_STAT_LOW_SPEED
)
1489 udev
->speed
= USB_SPEED_LOW
;
1491 udev
->speed
= USB_SPEED_FULL
;
1495 /* switch to the long delay after two short delay failures */
1496 if (delay_time
>= 2 * HUB_SHORT_RESET_TIME
)
1497 delay
= HUB_LONG_RESET_TIME
;
1499 dev_dbg (hub
->intfdev
,
1500 "port %d not reset yet, waiting %dms\n",
1507 static int hub_port_reset(struct usb_hub
*hub
, int port1
,
1508 struct usb_device
*udev
, unsigned int delay
)
1512 /* Reset the port */
1513 for (i
= 0; i
< PORT_RESET_TRIES
; i
++) {
1514 status
= set_port_feature(hub
->hdev
,
1515 port1
, USB_PORT_FEAT_RESET
);
1517 dev_err(hub
->intfdev
,
1518 "cannot reset port %d (err = %d)\n",
1521 status
= hub_port_wait_reset(hub
, port1
, udev
, delay
);
1522 if (status
&& status
!= -ENOTCONN
)
1523 dev_dbg(hub
->intfdev
,
1524 "port_wait_reset: err = %d\n",
1528 /* return on disconnect or reset */
1531 /* TRSTRCY = 10 ms; plus some extra */
1536 clear_port_feature(hub
->hdev
,
1537 port1
, USB_PORT_FEAT_C_RESET
);
1538 /* FIXME need disconnect() for NOTATTACHED device */
1539 usb_set_device_state(udev
, status
1540 ? USB_STATE_NOTATTACHED
1541 : USB_STATE_DEFAULT
);
1545 dev_dbg (hub
->intfdev
,
1546 "port %d not enabled, trying reset again...\n",
1548 delay
= HUB_LONG_RESET_TIME
;
1551 dev_err (hub
->intfdev
,
1552 "Cannot enable port %i. Maybe the USB cable is bad?\n",
1559 * Disable a port and mark a logical connnect-change event, so that some
1560 * time later khubd will disconnect() any existing usb_device on the port
1561 * and will re-enumerate if there actually is a device attached.
1563 static void hub_port_logical_disconnect(struct usb_hub
*hub
, int port1
)
1565 dev_dbg(hub
->intfdev
, "logical disconnect on port %d\n", port1
);
1566 hub_port_disable(hub
, port1
, 1);
1568 /* FIXME let caller ask to power down the port:
1569 * - some devices won't enumerate without a VBUS power cycle
1570 * - SRP saves power that way
1571 * - ... new call, TBD ...
1572 * That's easy if this hub can switch power per-port, and
1573 * khubd reactivates the port later (timer, SRP, etc).
1574 * Powerdown must be optional, because of reset/DFU.
1577 set_bit(port1
, hub
->change_bits
);
1582 #ifdef CONFIG_USB_SUSPEND
1585 * Selective port suspend reduces power; most suspended devices draw
1586 * less than 500 uA. It's also used in OTG, along with remote wakeup.
1587 * All devices below the suspended port are also suspended.
1589 * Devices leave suspend state when the host wakes them up. Some devices
1590 * also support "remote wakeup", where the device can activate the USB
1591 * tree above them to deliver data, such as a keypress or packet. In
1592 * some cases, this wakes the USB host.
1594 static int hub_port_suspend(struct usb_hub
*hub
, int port1
,
1595 struct usb_device
*udev
)
1599 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
1601 /* enable remote wakeup when appropriate; this lets the device
1602 * wake up the upstream hub (including maybe the root hub).
1604 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
1605 * we don't explicitly enable it here.
1607 if (device_may_wakeup(&udev
->dev
)) {
1608 status
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
1609 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
1610 USB_DEVICE_REMOTE_WAKEUP
, 0,
1612 USB_CTRL_SET_TIMEOUT
);
1615 "won't remote wakeup, status %d\n",
1620 status
= set_port_feature(hub
->hdev
, port1
, USB_PORT_FEAT_SUSPEND
);
1622 dev_dbg(hub
->intfdev
,
1623 "can't suspend port %d, status %d\n",
1625 /* paranoia: "should not happen" */
1626 (void) usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
1627 USB_REQ_CLEAR_FEATURE
, USB_RECIP_DEVICE
,
1628 USB_DEVICE_REMOTE_WAKEUP
, 0,
1630 USB_CTRL_SET_TIMEOUT
);
1632 /* device has up to 10 msec to fully suspend */
1633 dev_dbg(&udev
->dev
, "usb suspend\n");
1634 usb_set_device_state(udev
, USB_STATE_SUSPENDED
);
1641 * Devices on USB hub ports have only one "suspend" state, corresponding
1642 * to ACPI D2, "may cause the device to lose some context".
1643 * State transitions include:
1645 * - suspend, resume ... when the VBUS power link stays live
1646 * - suspend, disconnect ... VBUS lost
1648 * Once VBUS drop breaks the circuit, the port it's using has to go through
1649 * normal re-enumeration procedures, starting with enabling VBUS power.
1650 * Other than re-initializing the hub (plug/unplug, except for root hubs),
1651 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
1652 * timer, no SRP, no requests through sysfs.
1654 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
1655 * the root hub for their bus goes into global suspend ... so we don't
1656 * (falsely) update the device power state to say it suspended.
1658 static int __usb_suspend_device (struct usb_device
*udev
, int port1
)
1662 /* caller owns the udev device lock */
1666 if (udev
->state
== USB_STATE_SUSPENDED
1667 || udev
->state
== USB_STATE_NOTATTACHED
) {
1671 /* all interfaces must already be suspended */
1672 if (udev
->actconfig
) {
1675 for (i
= 0; i
< udev
->actconfig
->desc
.bNumInterfaces
; i
++) {
1676 struct usb_interface
*intf
;
1678 intf
= udev
->actconfig
->interface
[i
];
1679 if (is_active(intf
)) {
1680 dev_dbg(&intf
->dev
, "nyet suspended\n");
1686 /* we only change a device's upstream USB link.
1687 * root hubs have no upstream USB link.
1690 status
= hub_port_suspend(hdev_to_hub(udev
->parent
), port1
,
1694 udev
->dev
.power
.power_state
= PMSG_SUSPEND
;
1701 * usb_suspend_device - suspend a usb device
1702 * @udev: device that's no longer in active use
1703 * Context: must be able to sleep; device not locked; pm locks held
1705 * Suspends a USB device that isn't in active use, conserving power.
1706 * Devices may wake out of a suspend, if anything important happens,
1707 * using the remote wakeup mechanism. They may also be taken out of
1708 * suspend by the host, using usb_resume_device(). It's also routine
1709 * to disconnect devices while they are suspended.
1711 * This only affects the USB hardware for a device; its interfaces
1712 * (and, for hubs, child devices) must already have been suspended.
1714 * Suspending OTG devices may trigger HNP, if that's been enabled
1715 * between a pair of dual-role devices. That will change roles, such
1716 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
1718 * Returns 0 on success, else negative errno.
1720 int usb_suspend_device(struct usb_device
*udev
)
1722 #ifdef CONFIG_USB_SUSPEND
1725 if (udev
->state
== USB_STATE_NOTATTACHED
)
1730 for (port1
= udev
->parent
->maxchild
; port1
> 0; --port1
) {
1731 if (udev
->parent
->children
[port1
-1] == udev
)
1738 return __usb_suspend_device(udev
, port1
);
1740 /* NOTE: udev->state unchanged, it's not lying ... */
1741 udev
->dev
.power
.power_state
= PMSG_SUSPEND
;
1747 * If the USB "suspend" state is in use (rather than "global suspend"),
1748 * many devices will be individually taken out of suspend state using
1749 * special" resume" signaling. These routines kick in shortly after
1750 * hardware resume signaling is finished, either because of selective
1751 * resume (by host) or remote wakeup (by device) ... now see what changed
1752 * in the tree that's rooted at this device.
1754 static int finish_device_resume(struct usb_device
*udev
)
1759 /* caller owns the udev device lock */
1760 dev_dbg(&udev
->dev
, "finish resume\n");
1762 /* usb ch9 identifies four variants of SUSPENDED, based on what
1763 * state the device resumes to. Linux currently won't see the
1764 * first two on the host side; they'd be inside hub_port_init()
1765 * during many timeouts, but khubd can't suspend until later.
1767 usb_set_device_state(udev
, udev
->actconfig
1768 ? USB_STATE_CONFIGURED
1769 : USB_STATE_ADDRESS
);
1770 udev
->dev
.power
.power_state
= PMSG_ON
;
1772 /* 10.5.4.5 says be sure devices in the tree are still there.
1773 * For now let's assume the device didn't go crazy on resume,
1774 * and device drivers will know about any resume quirks.
1776 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0, &devstatus
);
1779 "gone after usb resume? status %d\n",
1781 else if (udev
->actconfig
) {
1783 int (*resume
)(struct device
*);
1785 le16_to_cpus(&devstatus
);
1786 if ((devstatus
& (1 << USB_DEVICE_REMOTE_WAKEUP
))
1788 status
= usb_control_msg(udev
,
1789 usb_sndctrlpipe(udev
, 0),
1790 USB_REQ_CLEAR_FEATURE
,
1792 USB_DEVICE_REMOTE_WAKEUP
, 0,
1794 USB_CTRL_SET_TIMEOUT
);
1796 dev_dbg(&udev
->dev
, "disable remote "
1797 "wakeup, status %d\n", status
);
1802 /* resume interface drivers; if this is a hub, it
1803 * may have a child resume event to deal with soon
1805 resume
= udev
->dev
.bus
->resume
;
1806 for (i
= 0; i
< udev
->actconfig
->desc
.bNumInterfaces
; i
++) {
1807 struct device
*dev
=
1808 &udev
->actconfig
->interface
[i
]->dev
;
1816 } else if (udev
->devnum
<= 0) {
1817 dev_dbg(&udev
->dev
, "bogus resume!\n");
1823 #ifdef CONFIG_USB_SUSPEND
1826 hub_port_resume(struct usb_hub
*hub
, int port1
, struct usb_device
*udev
)
1830 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
1832 /* see 7.1.7.7; affects power usage, but not budgeting */
1833 status
= clear_port_feature(hub
->hdev
,
1834 port1
, USB_PORT_FEAT_SUSPEND
);
1836 dev_dbg(hub
->intfdev
,
1837 "can't resume port %d, status %d\n",
1843 /* drive resume for at least 20 msec */
1845 dev_dbg(&udev
->dev
, "RESUME\n");
1848 #define LIVE_FLAGS ( USB_PORT_STAT_POWER \
1849 | USB_PORT_STAT_ENABLE \
1850 | USB_PORT_STAT_CONNECTION)
1852 /* Virtual root hubs can trigger on GET_PORT_STATUS to
1853 * stop resume signaling. Then finish the resume
1856 devstatus
= portchange
= 0;
1857 status
= hub_port_status(hub
, port1
,
1858 &devstatus
, &portchange
);
1860 || (devstatus
& LIVE_FLAGS
) != LIVE_FLAGS
1861 || (devstatus
& USB_PORT_STAT_SUSPEND
) != 0
1863 dev_dbg(hub
->intfdev
,
1864 "port %d status %04x.%04x after resume, %d\n",
1865 port1
, portchange
, devstatus
, status
);
1867 /* TRSMRCY = 10 msec */
1870 status
= finish_device_resume(udev
);
1874 hub_port_logical_disconnect(hub
, port1
);
1882 * usb_resume_device - re-activate a suspended usb device
1883 * @udev: device to re-activate
1884 * Context: must be able to sleep; device not locked; pm locks held
1886 * This will re-activate the suspended device, increasing power usage
1887 * while letting drivers communicate again with its endpoints.
1888 * USB resume explicitly guarantees that the power session between
1889 * the host and the device is the same as it was when the device
1892 * Returns 0 on success, else negative errno.
1894 int usb_resume_device(struct usb_device
*udev
)
1898 if (udev
->state
== USB_STATE_NOTATTACHED
)
1903 for (port1
= udev
->parent
->maxchild
; port1
> 0; --port1
) {
1904 if (udev
->parent
->children
[port1
-1] == udev
)
1911 #ifdef CONFIG_USB_SUSPEND
1912 /* selective resume of one downstream hub-to-device port */
1914 if (udev
->state
== USB_STATE_SUSPENDED
) {
1915 // NOTE swsusp may bork us, device state being wrong...
1916 // NOTE this fails if parent is also suspended...
1917 status
= hub_port_resume(hdev_to_hub(udev
->parent
),
1923 status
= finish_device_resume(udev
);
1925 dev_dbg(&udev
->dev
, "can't resume, status %d\n",
1928 /* rebind drivers that had no suspend() */
1930 usb_unlock_device(udev
);
1931 bus_rescan_devices(&usb_bus_type
);
1932 usb_lock_device(udev
);
1937 static int remote_wakeup(struct usb_device
*udev
)
1941 #ifdef CONFIG_USB_SUSPEND
1943 /* don't repeat RESUME sequence if this device
1944 * was already woken up by some other task
1946 usb_lock_device(udev
);
1947 if (udev
->state
== USB_STATE_SUSPENDED
) {
1948 dev_dbg(&udev
->dev
, "RESUME (wakeup)\n");
1949 /* TRSMRCY = 10 msec */
1951 status
= finish_device_resume(udev
);
1953 usb_unlock_device(udev
);
1958 static int hub_suspend(struct usb_interface
*intf
, pm_message_t msg
)
1960 struct usb_hub
*hub
= usb_get_intfdata (intf
);
1961 struct usb_device
*hdev
= hub
->hdev
;
1964 /* fail if children aren't already suspended */
1965 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
1966 struct usb_device
*udev
;
1968 udev
= hdev
->children
[port1
-1];
1969 if (udev
&& (udev
->dev
.power
.power_state
.event
1971 #ifdef CONFIG_USB_SUSPEND
1972 || udev
->state
!= USB_STATE_SUSPENDED
1975 dev_dbg(&intf
->dev
, "port %d nyet suspended\n", port1
);
1980 /* "global suspend" of the downstream HC-to-USB interface */
1981 if (!hdev
->parent
) {
1982 struct usb_bus
*bus
= hdev
->bus
;
1984 int status
= hcd_bus_suspend (bus
);
1987 dev_dbg(&hdev
->dev
, "'global' suspend %d\n",
1995 /* stop khubd and related activity */
2000 static int hub_resume(struct usb_interface
*intf
)
2002 struct usb_device
*hdev
= interface_to_usbdev(intf
);
2003 struct usb_hub
*hub
= usb_get_intfdata (intf
);
2006 /* "global resume" of the downstream HC-to-USB interface */
2007 if (!hdev
->parent
) {
2008 struct usb_bus
*bus
= hdev
->bus
;
2010 status
= hcd_bus_resume (bus
);
2012 dev_dbg(&intf
->dev
, "'global' resume %d\n",
2019 /* TRSMRCY = 10 msec */
2026 /* REVISIT: this recursion probably shouldn't exist. Remove
2027 * this code sometime, after retesting with different root and
2030 #ifdef CONFIG_USB_SUSPEND
2034 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
2035 struct usb_device
*udev
;
2036 u16 portstat
, portchange
;
2038 udev
= hdev
->children
[port1
-1];
2039 status
= hub_port_status(hub
, port1
, &portstat
, &portchange
);
2041 if (portchange
& USB_PORT_STAT_C_SUSPEND
) {
2042 clear_port_feature(hdev
, port1
,
2043 USB_PORT_FEAT_C_SUSPEND
);
2044 portchange
&= ~USB_PORT_STAT_C_SUSPEND
;
2047 /* let khubd handle disconnects etc */
2052 if (!udev
|| status
< 0)
2054 usb_lock_device(udev
);
2055 if (portstat
& USB_PORT_STAT_SUSPEND
)
2056 status
= hub_port_resume(hub
, port1
, udev
);
2058 status
= finish_device_resume(udev
);
2060 dev_dbg(&intf
->dev
, "resume port %d --> %d\n",
2062 hub_port_logical_disconnect(hub
, port1
);
2065 usb_unlock_device(udev
);
2072 void usb_suspend_root_hub(struct usb_device
*hdev
)
2074 struct usb_hub
*hub
= hdev_to_hub(hdev
);
2076 /* This also makes any led blinker stop retriggering. We're called
2077 * from irq, so the blinker might still be scheduled. Caller promises
2078 * that the root hub status URB will be canceled.
2081 mark_quiesced(to_usb_interface(hub
->intfdev
));
2084 void usb_resume_root_hub(struct usb_device
*hdev
)
2086 struct usb_hub
*hub
= hdev_to_hub(hdev
);
2088 hub
->resume_root_hub
= 1;
2093 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2095 * Between connect detection and reset signaling there must be a delay
2096 * of 100ms at least for debounce and power-settling. The corresponding
2097 * timer shall restart whenever the downstream port detects a disconnect.
2099 * Apparently there are some bluetooth and irda-dongles and a number of
2100 * low-speed devices for which this debounce period may last over a second.
2101 * Not covered by the spec - but easy to deal with.
2103 * This implementation uses a 1500ms total debounce timeout; if the
2104 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2105 * every 25ms for transient disconnects. When the port status has been
2106 * unchanged for 100ms it returns the port status.
2109 #define HUB_DEBOUNCE_TIMEOUT 1500
2110 #define HUB_DEBOUNCE_STEP 25
2111 #define HUB_DEBOUNCE_STABLE 100
2113 static int hub_port_debounce(struct usb_hub
*hub
, int port1
)
2116 int total_time
, stable_time
= 0;
2117 u16 portchange
, portstatus
;
2118 unsigned connection
= 0xffff;
2120 for (total_time
= 0; ; total_time
+= HUB_DEBOUNCE_STEP
) {
2121 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
2125 if (!(portchange
& USB_PORT_STAT_C_CONNECTION
) &&
2126 (portstatus
& USB_PORT_STAT_CONNECTION
) == connection
) {
2127 stable_time
+= HUB_DEBOUNCE_STEP
;
2128 if (stable_time
>= HUB_DEBOUNCE_STABLE
)
2132 connection
= portstatus
& USB_PORT_STAT_CONNECTION
;
2135 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
2136 clear_port_feature(hub
->hdev
, port1
,
2137 USB_PORT_FEAT_C_CONNECTION
);
2140 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
2142 msleep(HUB_DEBOUNCE_STEP
);
2145 dev_dbg (hub
->intfdev
,
2146 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2147 port1
, total_time
, stable_time
, portstatus
);
2149 if (stable_time
< HUB_DEBOUNCE_STABLE
)
2154 static void ep0_reinit(struct usb_device
*udev
)
2156 usb_disable_endpoint(udev
, 0 + USB_DIR_IN
);
2157 usb_disable_endpoint(udev
, 0 + USB_DIR_OUT
);
2158 udev
->ep_in
[0] = udev
->ep_out
[0] = &udev
->ep0
;
2161 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2162 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2164 static int hub_set_address(struct usb_device
*udev
)
2168 if (udev
->devnum
== 0)
2170 if (udev
->state
== USB_STATE_ADDRESS
)
2172 if (udev
->state
!= USB_STATE_DEFAULT
)
2174 retval
= usb_control_msg(udev
, usb_sndaddr0pipe(),
2175 USB_REQ_SET_ADDRESS
, 0, udev
->devnum
, 0,
2176 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
2178 usb_set_device_state(udev
, USB_STATE_ADDRESS
);
2184 /* Reset device, (re)assign address, get device descriptor.
2185 * Device connection must be stable, no more debouncing needed.
2186 * Returns device in USB_STATE_ADDRESS, except on error.
2188 * If this is called for an already-existing device (as part of
2189 * usb_reset_device), the caller must own the device lock. For a
2190 * newly detected device that is not accessible through any global
2191 * pointers, it's not necessary to lock the device.
2194 hub_port_init (struct usb_hub
*hub
, struct usb_device
*udev
, int port1
,
2197 static DECLARE_MUTEX(usb_address0_sem
);
2199 struct usb_device
*hdev
= hub
->hdev
;
2201 unsigned delay
= HUB_SHORT_RESET_TIME
;
2202 enum usb_device_speed oldspeed
= udev
->speed
;
2204 /* root hub ports have a slightly longer reset period
2205 * (from USB 2.0 spec, section 7.1.7.5)
2207 if (!hdev
->parent
) {
2208 delay
= HUB_ROOT_RESET_TIME
;
2209 if (port1
== hdev
->bus
->otg_port
)
2210 hdev
->bus
->b_hnp_enable
= 0;
2213 /* Some low speed devices have problems with the quick delay, so */
2214 /* be a bit pessimistic with those devices. RHbug #23670 */
2215 if (oldspeed
== USB_SPEED_LOW
)
2216 delay
= HUB_LONG_RESET_TIME
;
2218 down(&usb_address0_sem
);
2220 /* Reset the device; full speed may morph to high speed */
2221 retval
= hub_port_reset(hub
, port1
, udev
, delay
);
2222 if (retval
< 0) /* error or disconnect */
2224 /* success, speed is known */
2227 if (oldspeed
!= USB_SPEED_UNKNOWN
&& oldspeed
!= udev
->speed
) {
2228 dev_dbg(&udev
->dev
, "device reset changed speed!\n");
2231 oldspeed
= udev
->speed
;
2233 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2234 * it's fixed size except for full speed devices.
2236 switch (udev
->speed
) {
2237 case USB_SPEED_HIGH
: /* fixed at 64 */
2238 udev
->ep0
.desc
.wMaxPacketSize
= __constant_cpu_to_le16(64);
2240 case USB_SPEED_FULL
: /* 8, 16, 32, or 64 */
2241 /* to determine the ep0 maxpacket size, try to read
2242 * the device descriptor to get bMaxPacketSize0 and
2243 * then correct our initial guess.
2245 udev
->ep0
.desc
.wMaxPacketSize
= __constant_cpu_to_le16(64);
2247 case USB_SPEED_LOW
: /* fixed at 8 */
2248 udev
->ep0
.desc
.wMaxPacketSize
= __constant_cpu_to_le16(8);
2254 dev_info (&udev
->dev
,
2255 "%s %s speed USB device using %s and address %d\n",
2256 (udev
->config
) ? "reset" : "new",
2257 ({ char *speed
; switch (udev
->speed
) {
2258 case USB_SPEED_LOW
: speed
= "low"; break;
2259 case USB_SPEED_FULL
: speed
= "full"; break;
2260 case USB_SPEED_HIGH
: speed
= "high"; break;
2261 default: speed
= "?"; break;
2263 udev
->bus
->controller
->driver
->name
,
2266 /* Set up TT records, if needed */
2268 udev
->tt
= hdev
->tt
;
2269 udev
->ttport
= hdev
->ttport
;
2270 } else if (udev
->speed
!= USB_SPEED_HIGH
2271 && hdev
->speed
== USB_SPEED_HIGH
) {
2272 udev
->tt
= &hub
->tt
;
2273 udev
->ttport
= port1
;
2276 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2277 * Because device hardware and firmware is sometimes buggy in
2278 * this area, and this is how Linux has done it for ages.
2279 * Change it cautiously.
2281 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2282 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2283 * so it may help with some non-standards-compliant devices.
2284 * Otherwise we start with SET_ADDRESS and then try to read the
2285 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2288 for (i
= 0; i
< GET_DESCRIPTOR_TRIES
; (++i
, msleep(100))) {
2289 if (USE_NEW_SCHEME(retry_counter
)) {
2290 struct usb_device_descriptor
*buf
;
2293 #define GET_DESCRIPTOR_BUFSIZE 64
2294 buf
= kmalloc(GET_DESCRIPTOR_BUFSIZE
, GFP_NOIO
);
2300 /* Use a short timeout the first time through,
2301 * so that recalcitrant full-speed devices with
2302 * 8- or 16-byte ep0-maxpackets won't slow things
2303 * down tremendously by NAKing the unexpectedly
2304 * early status stage. Also, retry on all errors;
2305 * some devices are flakey.
2307 for (j
= 0; j
< 3; ++j
) {
2308 buf
->bMaxPacketSize0
= 0;
2309 r
= usb_control_msg(udev
, usb_rcvaddr0pipe(),
2310 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
,
2311 USB_DT_DEVICE
<< 8, 0,
2312 buf
, GET_DESCRIPTOR_BUFSIZE
,
2313 (i
? USB_CTRL_GET_TIMEOUT
: 1000));
2314 switch (buf
->bMaxPacketSize0
) {
2315 case 8: case 16: case 32: case 64:
2316 if (buf
->bDescriptorType
==
2330 udev
->descriptor
.bMaxPacketSize0
=
2331 buf
->bMaxPacketSize0
;
2334 retval
= hub_port_reset(hub
, port1
, udev
, delay
);
2335 if (retval
< 0) /* error or disconnect */
2337 if (oldspeed
!= udev
->speed
) {
2339 "device reset changed speed!\n");
2344 dev_err(&udev
->dev
, "device descriptor "
2345 "read/%s, error %d\n",
2350 #undef GET_DESCRIPTOR_BUFSIZE
2353 for (j
= 0; j
< SET_ADDRESS_TRIES
; ++j
) {
2354 retval
= hub_set_address(udev
);
2361 "device not accepting address %d, error %d\n",
2362 udev
->devnum
, retval
);
2366 /* cope with hardware quirkiness:
2367 * - let SET_ADDRESS settle, some device hardware wants it
2368 * - read ep0 maxpacket even for high and low speed,
2371 if (USE_NEW_SCHEME(retry_counter
))
2374 retval
= usb_get_device_descriptor(udev
, 8);
2376 dev_err(&udev
->dev
, "device descriptor "
2377 "read/%s, error %d\n",
2389 i
= udev
->descriptor
.bMaxPacketSize0
;
2390 if (le16_to_cpu(udev
->ep0
.desc
.wMaxPacketSize
) != i
) {
2391 if (udev
->speed
!= USB_SPEED_FULL
||
2392 !(i
== 8 || i
== 16 || i
== 32 || i
== 64)) {
2393 dev_err(&udev
->dev
, "ep0 maxpacket = %d\n", i
);
2397 dev_dbg(&udev
->dev
, "ep0 maxpacket = %d\n", i
);
2398 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(i
);
2402 retval
= usb_get_device_descriptor(udev
, USB_DT_DEVICE_SIZE
);
2403 if (retval
< (signed)sizeof(udev
->descriptor
)) {
2404 dev_err(&udev
->dev
, "device descriptor read/%s, error %d\n",
2415 hub_port_disable(hub
, port1
, 0);
2416 up(&usb_address0_sem
);
2421 check_highspeed (struct usb_hub
*hub
, struct usb_device
*udev
, int port1
)
2423 struct usb_qualifier_descriptor
*qual
;
2426 qual
= kmalloc (sizeof *qual
, SLAB_KERNEL
);
2430 status
= usb_get_descriptor (udev
, USB_DT_DEVICE_QUALIFIER
, 0,
2431 qual
, sizeof *qual
);
2432 if (status
== sizeof *qual
) {
2433 dev_info(&udev
->dev
, "not running at top speed; "
2434 "connect to a high speed hub\n");
2435 /* hub LEDs are probably harder to miss than syslog */
2436 if (hub
->has_indicators
) {
2437 hub
->indicator
[port1
-1] = INDICATOR_GREEN_BLINK
;
2438 schedule_work (&hub
->leds
);
2445 hub_power_remaining (struct usb_hub
*hub
)
2447 struct usb_device
*hdev
= hub
->hdev
;
2451 if (!hub
->limited_power
)
2454 remaining
= hdev
->bus_mA
- hub
->descriptor
->bHubContrCurrent
;
2455 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
2456 struct usb_device
*udev
= hdev
->children
[port1
- 1];
2462 /* Unconfigured devices may not use more than 100mA,
2463 * or 8mA for OTG ports */
2464 if (udev
->actconfig
)
2465 delta
= udev
->actconfig
->desc
.bMaxPower
* 2;
2466 else if (port1
!= udev
->bus
->otg_port
|| hdev
->parent
)
2470 if (delta
> hub
->mA_per_port
)
2471 dev_warn(&udev
->dev
, "%dmA is over %umA budget "
2473 delta
, hub
->mA_per_port
, port1
);
2476 if (remaining
< 0) {
2477 dev_warn(hub
->intfdev
, "%dmA over power budget!\n",
2484 /* Handle physical or logical connection change events.
2485 * This routine is called when:
2486 * a port connection-change occurs;
2487 * a port enable-change occurs (often caused by EMI);
2488 * usb_reset_device() encounters changed descriptors (as from
2489 * a firmware download)
2490 * caller already locked the hub
2492 static void hub_port_connect_change(struct usb_hub
*hub
, int port1
,
2493 u16 portstatus
, u16 portchange
)
2495 struct usb_device
*hdev
= hub
->hdev
;
2496 struct device
*hub_dev
= hub
->intfdev
;
2497 u16 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
2501 "port %d, status %04x, change %04x, %s\n",
2502 port1
, portstatus
, portchange
, portspeed (portstatus
));
2504 if (hub
->has_indicators
) {
2505 set_port_led(hub
, port1
, HUB_LED_AUTO
);
2506 hub
->indicator
[port1
-1] = INDICATOR_AUTO
;
2509 /* Disconnect any existing devices under this port */
2510 if (hdev
->children
[port1
-1])
2511 usb_disconnect(&hdev
->children
[port1
-1]);
2512 clear_bit(port1
, hub
->change_bits
);
2514 #ifdef CONFIG_USB_OTG
2515 /* during HNP, don't repeat the debounce */
2516 if (hdev
->bus
->is_b_host
)
2517 portchange
&= ~USB_PORT_STAT_C_CONNECTION
;
2520 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
2521 status
= hub_port_debounce(hub
, port1
);
2524 "connect-debounce failed, port %d disabled\n",
2528 portstatus
= status
;
2531 /* Return now if nothing is connected */
2532 if (!(portstatus
& USB_PORT_STAT_CONNECTION
)) {
2534 /* maybe switch power back on (e.g. root hub was reset) */
2535 if ((wHubCharacteristics
& HUB_CHAR_LPSM
) < 2
2536 && !(portstatus
& (1 << USB_PORT_FEAT_POWER
)))
2537 set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
2539 if (portstatus
& USB_PORT_STAT_ENABLE
)
2544 #ifdef CONFIG_USB_SUSPEND
2545 /* If something is connected, but the port is suspended, wake it up. */
2546 if (portstatus
& USB_PORT_STAT_SUSPEND
) {
2547 status
= hub_port_resume(hub
, port1
, NULL
);
2550 "can't clear suspend on port %d; %d\n",
2557 for (i
= 0; i
< SET_CONFIG_TRIES
; i
++) {
2558 struct usb_device
*udev
;
2560 /* reallocate for each attempt, since references
2561 * to the previous one can escape in various ways
2563 udev
= usb_alloc_dev(hdev
, hdev
->bus
, port1
);
2566 "couldn't allocate port %d usb_device\n",
2571 usb_set_device_state(udev
, USB_STATE_POWERED
);
2572 udev
->speed
= USB_SPEED_UNKNOWN
;
2573 udev
->bus_mA
= hub
->mA_per_port
;
2575 /* set the address */
2576 choose_address(udev
);
2577 if (udev
->devnum
<= 0) {
2578 status
= -ENOTCONN
; /* Don't retry */
2582 /* reset and get descriptor */
2583 status
= hub_port_init(hub
, udev
, port1
, i
);
2587 /* consecutive bus-powered hubs aren't reliable; they can
2588 * violate the voltage drop budget. if the new child has
2589 * a "powered" LED, users should notice we didn't enable it
2590 * (without reading syslog), even without per-port LEDs
2593 if (udev
->descriptor
.bDeviceClass
== USB_CLASS_HUB
2594 && udev
->bus_mA
<= 100) {
2597 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0,
2600 dev_dbg(&udev
->dev
, "get status %d ?\n", status
);
2603 le16_to_cpus(&devstat
);
2604 if ((devstat
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
2606 "can't connect bus-powered hub "
2608 if (hub
->has_indicators
) {
2609 hub
->indicator
[port1
-1] =
2610 INDICATOR_AMBER_BLINK
;
2611 schedule_work (&hub
->leds
);
2613 status
= -ENOTCONN
; /* Don't retry */
2618 /* check for devices running slower than they could */
2619 if (le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0200
2620 && udev
->speed
== USB_SPEED_FULL
2621 && highspeed_hubs
!= 0)
2622 check_highspeed (hub
, udev
, port1
);
2624 /* Store the parent's children[] pointer. At this point
2625 * udev becomes globally accessible, although presumably
2626 * no one will look at it until hdev is unlocked.
2630 /* We mustn't add new devices if the parent hub has
2631 * been disconnected; we would race with the
2632 * recursively_mark_NOTATTACHED() routine.
2634 spin_lock_irq(&device_state_lock
);
2635 if (hdev
->state
== USB_STATE_NOTATTACHED
)
2638 hdev
->children
[port1
-1] = udev
;
2639 spin_unlock_irq(&device_state_lock
);
2641 /* Run it through the hoops (find a driver, etc) */
2643 status
= usb_new_device(udev
);
2645 spin_lock_irq(&device_state_lock
);
2646 hdev
->children
[port1
-1] = NULL
;
2647 spin_unlock_irq(&device_state_lock
);
2654 status
= hub_power_remaining(hub
);
2656 dev_dbg(hub_dev
, "%dmA power budget left\n", status
);
2661 hub_port_disable(hub
, port1
, 1);
2664 release_address(udev
);
2666 if (status
== -ENOTCONN
)
2671 hub_port_disable(hub
, port1
, 1);
2674 static void hub_events(void)
2676 struct list_head
*tmp
;
2677 struct usb_device
*hdev
;
2678 struct usb_interface
*intf
;
2679 struct usb_hub
*hub
;
2680 struct device
*hub_dev
;
2689 * We restart the list every time to avoid a deadlock with
2690 * deleting hubs downstream from this one. This should be
2691 * safe since we delete the hub from the event list.
2692 * Not the most efficient, but avoids deadlocks.
2696 /* Grab the first entry at the beginning of the list */
2697 spin_lock_irq(&hub_event_lock
);
2698 if (list_empty(&hub_event_list
)) {
2699 spin_unlock_irq(&hub_event_lock
);
2703 tmp
= hub_event_list
.next
;
2706 hub
= list_entry(tmp
, struct usb_hub
, event_list
);
2708 intf
= to_usb_interface(hub
->intfdev
);
2709 hub_dev
= &intf
->dev
;
2711 i
= hub
->resume_root_hub
;
2713 dev_dbg(hub_dev
, "state %d ports %d chg %04x evt %04x%s\n",
2714 hdev
->state
, hub
->descriptor
2715 ? hub
->descriptor
->bNbrPorts
2717 /* NOTE: expects max 15 ports... */
2718 (u16
) hub
->change_bits
[0],
2719 (u16
) hub
->event_bits
[0],
2720 i
? ", resume root" : "");
2723 spin_unlock_irq(&hub_event_lock
);
2725 /* Is this is a root hub wanting to reactivate the downstream
2726 * ports? If so, be sure the interface resumes even if its
2727 * stub "device" node was never suspended.
2730 dpm_runtime_resume(&hdev
->dev
);
2731 dpm_runtime_resume(&intf
->dev
);
2734 /* Lock the device, then check to see if we were
2735 * disconnected while waiting for the lock to succeed. */
2736 if (locktree(hdev
) < 0) {
2740 if (hub
!= usb_get_intfdata(intf
))
2743 /* If the hub has died, clean up after it */
2744 if (hdev
->state
== USB_STATE_NOTATTACHED
) {
2745 hub_pre_reset(hub
, 0);
2749 /* If this is an inactive or suspended hub, do nothing */
2754 dev_dbg (hub_dev
, "resetting for error %d\n",
2757 ret
= usb_reset_device(hdev
);
2760 "error resetting hub: %d\n", ret
);
2768 /* deal with port status changes */
2769 for (i
= 1; i
<= hub
->descriptor
->bNbrPorts
; i
++) {
2770 if (test_bit(i
, hub
->busy_bits
))
2772 connect_change
= test_bit(i
, hub
->change_bits
);
2773 if (!test_and_clear_bit(i
, hub
->event_bits
) &&
2774 !connect_change
&& !hub
->activating
)
2777 ret
= hub_port_status(hub
, i
,
2778 &portstatus
, &portchange
);
2782 if (hub
->activating
&& !hdev
->children
[i
-1] &&
2784 USB_PORT_STAT_CONNECTION
))
2787 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
2788 clear_port_feature(hdev
, i
,
2789 USB_PORT_FEAT_C_CONNECTION
);
2793 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
2794 if (!connect_change
)
2796 "port %d enable change, "
2799 clear_port_feature(hdev
, i
,
2800 USB_PORT_FEAT_C_ENABLE
);
2803 * EM interference sometimes causes badly
2804 * shielded USB devices to be shutdown by
2805 * the hub, this hack enables them again.
2806 * Works at least with mouse driver.
2808 if (!(portstatus
& USB_PORT_STAT_ENABLE
)
2810 && hdev
->children
[i
-1]) {
2813 "disabled by hub (EMI?), "
2820 if (portchange
& USB_PORT_STAT_C_SUSPEND
) {
2821 clear_port_feature(hdev
, i
,
2822 USB_PORT_FEAT_C_SUSPEND
);
2823 if (hdev
->children
[i
-1]) {
2824 ret
= remote_wakeup(hdev
->
2830 hub_port_disable(hub
, i
, 1);
2833 "resume on port %d, status %d\n",
2837 if (portchange
& USB_PORT_STAT_C_OVERCURRENT
) {
2839 "over-current change on port %d\n",
2841 clear_port_feature(hdev
, i
,
2842 USB_PORT_FEAT_C_OVER_CURRENT
);
2846 if (portchange
& USB_PORT_STAT_C_RESET
) {
2848 "reset change on port %d\n",
2850 clear_port_feature(hdev
, i
,
2851 USB_PORT_FEAT_C_RESET
);
2855 hub_port_connect_change(hub
, i
,
2856 portstatus
, portchange
);
2859 /* deal with hub status changes */
2860 if (test_and_clear_bit(0, hub
->event_bits
) == 0)
2862 else if (hub_hub_status(hub
, &hubstatus
, &hubchange
) < 0)
2863 dev_err (hub_dev
, "get_hub_status failed\n");
2865 if (hubchange
& HUB_CHANGE_LOCAL_POWER
) {
2866 dev_dbg (hub_dev
, "power change\n");
2867 clear_hub_feature(hdev
, C_HUB_LOCAL_POWER
);
2868 if (hubstatus
& HUB_STATUS_LOCAL_POWER
)
2869 /* FIXME: Is this always true? */
2870 hub
->limited_power
= 0;
2872 hub
->limited_power
= 1;
2874 if (hubchange
& HUB_CHANGE_OVERCURRENT
) {
2875 dev_dbg (hub_dev
, "overcurrent change\n");
2876 msleep(500); /* Cool down */
2877 clear_hub_feature(hdev
, C_HUB_OVER_CURRENT
);
2882 hub
->activating
= 0;
2884 /* If this is a root hub, tell the HCD it's okay to
2885 * re-enable port-change interrupts now. */
2887 usb_enable_root_hub_irq(hdev
->bus
);
2890 usb_unlock_device(hdev
);
2893 } /* end while (1) */
2896 static int hub_thread(void *__unused
)
2900 wait_event_interruptible(khubd_wait
,
2901 !list_empty(&hub_event_list
) ||
2902 kthread_should_stop());
2904 } while (!kthread_should_stop() || !list_empty(&hub_event_list
));
2906 pr_debug("%s: khubd exiting\n", usbcore_name
);
2910 static struct usb_device_id hub_id_table
[] = {
2911 { .match_flags
= USB_DEVICE_ID_MATCH_DEV_CLASS
,
2912 .bDeviceClass
= USB_CLASS_HUB
},
2913 { .match_flags
= USB_DEVICE_ID_MATCH_INT_CLASS
,
2914 .bInterfaceClass
= USB_CLASS_HUB
},
2915 { } /* Terminating entry */
2918 MODULE_DEVICE_TABLE (usb
, hub_id_table
);
2920 static struct usb_driver hub_driver
= {
2923 .disconnect
= hub_disconnect
,
2924 .suspend
= hub_suspend
,
2925 .resume
= hub_resume
,
2927 .id_table
= hub_id_table
,
2930 int usb_hub_init(void)
2932 if (usb_register(&hub_driver
) < 0) {
2933 printk(KERN_ERR
"%s: can't register hub driver\n",
2938 khubd_task
= kthread_run(hub_thread
, NULL
, "khubd");
2939 if (!IS_ERR(khubd_task
))
2942 /* Fall through if kernel_thread failed */
2943 usb_deregister(&hub_driver
);
2944 printk(KERN_ERR
"%s: can't start khubd\n", usbcore_name
);
2949 void usb_hub_cleanup(void)
2951 kthread_stop(khubd_task
);
2954 * Hub resources are freed for us by usb_deregister. It calls
2955 * usb_driver_purge on every device which in turn calls that
2956 * devices disconnect function if it is using this driver.
2957 * The hub_disconnect function takes care of releasing the
2958 * individual hub resources. -greg
2960 usb_deregister(&hub_driver
);
2961 } /* usb_hub_cleanup() */
2963 static int config_descriptors_changed(struct usb_device
*udev
)
2967 struct usb_config_descriptor
*buf
;
2969 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
2970 if (len
< le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
))
2971 len
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
2973 buf
= kmalloc (len
, SLAB_KERNEL
);
2975 dev_err(&udev
->dev
, "no mem to re-read configs after reset\n");
2976 /* assume the worst */
2979 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
2981 int old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
2983 length
= usb_get_descriptor(udev
, USB_DT_CONFIG
, index
, buf
,
2985 if (length
< old_length
) {
2986 dev_dbg(&udev
->dev
, "config index %d, error %d\n",
2990 if (memcmp (buf
, udev
->rawdescriptors
[index
], old_length
)
2992 dev_dbg(&udev
->dev
, "config index %d changed (#%d)\n",
2993 index
, buf
->bConfigurationValue
);
2998 return index
!= udev
->descriptor
.bNumConfigurations
;
3002 * usb_reset_device - perform a USB port reset to reinitialize a device
3003 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3005 * WARNING - don't reset any device unless drivers for all of its
3006 * interfaces are expecting that reset! Maybe some driver->reset()
3007 * method should eventually help ensure sufficient cooperation.
3009 * Do a port reset, reassign the device's address, and establish its
3010 * former operating configuration. If the reset fails, or the device's
3011 * descriptors change from their values before the reset, or the original
3012 * configuration and altsettings cannot be restored, a flag will be set
3013 * telling khubd to pretend the device has been disconnected and then
3014 * re-connected. All drivers will be unbound, and the device will be
3015 * re-enumerated and probed all over again.
3017 * Returns 0 if the reset succeeded, -ENODEV if the device has been
3018 * flagged for logical disconnection, or some other negative error code
3019 * if the reset wasn't even attempted.
3021 * The caller must own the device lock. For example, it's safe to use
3022 * this from a driver probe() routine after downloading new firmware.
3023 * For calls that might not occur during probe(), drivers should lock
3024 * the device using usb_lock_device_for_reset().
3026 int usb_reset_device(struct usb_device
*udev
)
3028 struct usb_device
*parent_hdev
= udev
->parent
;
3029 struct usb_hub
*parent_hub
;
3030 struct usb_device_descriptor descriptor
= udev
->descriptor
;
3031 struct usb_hub
*hub
= NULL
;
3032 int i
, ret
= 0, port1
= -1;
3034 if (udev
->state
== USB_STATE_NOTATTACHED
||
3035 udev
->state
== USB_STATE_SUSPENDED
) {
3036 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
3042 /* this requires hcd-specific logic; see OHCI hc_restart() */
3043 dev_dbg(&udev
->dev
, "%s for root hub!\n", __FUNCTION__
);
3047 for (i
= 0; i
< parent_hdev
->maxchild
; i
++)
3048 if (parent_hdev
->children
[i
] == udev
) {
3054 /* If this ever happens, it's very bad */
3055 dev_err(&udev
->dev
, "Can't locate device's port!\n");
3058 parent_hub
= hdev_to_hub(parent_hdev
);
3060 /* If we're resetting an active hub, take some special actions */
3061 if (udev
->actconfig
&&
3062 udev
->actconfig
->interface
[0]->dev
.driver
==
3063 &hub_driver
.driver
&&
3064 (hub
= hdev_to_hub(udev
)) != NULL
) {
3065 hub_pre_reset(hub
, 0);
3068 set_bit(port1
, parent_hub
->busy_bits
);
3069 for (i
= 0; i
< SET_CONFIG_TRIES
; ++i
) {
3071 /* ep0 maxpacket size may change; let the HCD know about it.
3072 * Other endpoints will be handled by re-enumeration. */
3074 ret
= hub_port_init(parent_hub
, udev
, port1
, i
);
3078 clear_bit(port1
, parent_hub
->busy_bits
);
3082 /* Device might have changed firmware (DFU or similar) */
3083 if (memcmp(&udev
->descriptor
, &descriptor
, sizeof descriptor
)
3084 || config_descriptors_changed (udev
)) {
3085 dev_info(&udev
->dev
, "device firmware changed\n");
3086 udev
->descriptor
= descriptor
; /* for disconnect() calls */
3090 if (!udev
->actconfig
)
3093 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3094 USB_REQ_SET_CONFIGURATION
, 0,
3095 udev
->actconfig
->desc
.bConfigurationValue
, 0,
3096 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
3099 "can't restore configuration #%d (error=%d)\n",
3100 udev
->actconfig
->desc
.bConfigurationValue
, ret
);
3103 usb_set_device_state(udev
, USB_STATE_CONFIGURED
);
3105 for (i
= 0; i
< udev
->actconfig
->desc
.bNumInterfaces
; i
++) {
3106 struct usb_interface
*intf
= udev
->actconfig
->interface
[i
];
3107 struct usb_interface_descriptor
*desc
;
3109 /* set_interface resets host side toggle even
3110 * for altsetting zero. the interface may have no driver.
3112 desc
= &intf
->cur_altsetting
->desc
;
3113 ret
= usb_set_interface(udev
, desc
->bInterfaceNumber
,
3114 desc
->bAlternateSetting
);
3116 dev_err(&udev
->dev
, "failed to restore interface %d "
3117 "altsetting %d (error=%d)\n",
3118 desc
->bInterfaceNumber
,
3119 desc
->bAlternateSetting
,
3127 hub_post_reset(hub
);
3131 hub_port_logical_disconnect(parent_hub
, port1
);