4 * (C) Copyright 1999 Linus Torvalds
5 * (C) Copyright 1999 Johannes Erdfelt
6 * (C) Copyright 1999 Gregory P. Smith
7 * (C) Copyright 2001 Brad Hards (bhards@bigpond.net.au)
11 #include <linux/kernel.h>
12 #include <linux/errno.h>
13 #include <linux/module.h>
14 #include <linux/moduleparam.h>
15 #include <linux/completion.h>
16 #include <linux/sched.h>
17 #include <linux/list.h>
18 #include <linux/slab.h>
19 #include <linux/ioctl.h>
20 #include <linux/usb.h>
21 #include <linux/usbdevice_fs.h>
22 #include <linux/kthread.h>
23 #include <linux/mutex.h>
24 #include <linux/freezer.h>
25 #include <linux/delay.h>
27 #include <asm/uaccess.h>
28 #include <asm/byteorder.h>
34 /* if we are in debug mode, always announce new devices */
36 #ifndef CONFIG_USB_ANNOUNCE_NEW_DEVICES
37 #define CONFIG_USB_ANNOUNCE_NEW_DEVICES
42 struct device
*intfdev
; /* the "interface" device */
43 struct usb_device
*hdev
;
45 struct urb
*urb
; /* for interrupt polling pipe */
47 /* buffer for urb ... with extra space in case of babble */
49 dma_addr_t buffer_dma
; /* DMA address for buffer */
51 struct usb_hub_status hub
;
52 struct usb_port_status port
;
53 } *status
; /* buffer for status reports */
54 struct mutex status_mutex
; /* for the status buffer */
56 int error
; /* last reported error */
57 int nerrors
; /* track consecutive errors */
59 struct list_head event_list
; /* hubs w/data or errs ready */
60 unsigned long event_bits
[1]; /* status change bitmask */
61 unsigned long change_bits
[1]; /* ports with logical connect
63 unsigned long busy_bits
[1]; /* ports being reset or
65 #if USB_MAXCHILDREN > 31 /* 8*sizeof(unsigned long) - 1 */
66 #error event_bits[] is too short!
69 struct usb_hub_descriptor
*descriptor
; /* class descriptor */
70 struct usb_tt tt
; /* Transaction Translator */
72 unsigned mA_per_port
; /* current for each child */
74 unsigned limited_power
:1;
76 unsigned disconnected
:1;
78 unsigned has_indicators
:1;
79 u8 indicator
[USB_MAXCHILDREN
];
80 struct delayed_work leds
;
81 struct delayed_work init_work
;
85 /* Protect struct usb_device->state and ->children members
86 * Note: Both are also protected by ->dev.sem, except that ->state can
87 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
88 static DEFINE_SPINLOCK(device_state_lock
);
90 /* khubd's worklist and its lock */
91 static DEFINE_SPINLOCK(hub_event_lock
);
92 static LIST_HEAD(hub_event_list
); /* List of hubs needing servicing */
95 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait
);
97 static struct task_struct
*khubd_task
;
99 /* cycle leds on hubs that aren't blinking for attention */
100 static int blinkenlights
= 0;
101 module_param (blinkenlights
, bool, S_IRUGO
);
102 MODULE_PARM_DESC (blinkenlights
, "true to cycle leds on hubs");
105 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
106 * 10 seconds to send reply for the initial 64-byte descriptor request.
108 /* define initial 64-byte descriptor request timeout in milliseconds */
109 static int initial_descriptor_timeout
= USB_CTRL_GET_TIMEOUT
;
110 module_param(initial_descriptor_timeout
, int, S_IRUGO
|S_IWUSR
);
111 MODULE_PARM_DESC(initial_descriptor_timeout
,
112 "initial 64-byte descriptor request timeout in milliseconds "
113 "(default 5000 - 5.0 seconds)");
116 * As of 2.6.10 we introduce a new USB device initialization scheme which
117 * closely resembles the way Windows works. Hopefully it will be compatible
118 * with a wider range of devices than the old scheme. However some previously
119 * working devices may start giving rise to "device not accepting address"
120 * errors; if that happens the user can try the old scheme by adjusting the
121 * following module parameters.
123 * For maximum flexibility there are two boolean parameters to control the
124 * hub driver's behavior. On the first initialization attempt, if the
125 * "old_scheme_first" parameter is set then the old scheme will be used,
126 * otherwise the new scheme is used. If that fails and "use_both_schemes"
127 * is set, then the driver will make another attempt, using the other scheme.
129 static int old_scheme_first
= 0;
130 module_param(old_scheme_first
, bool, S_IRUGO
| S_IWUSR
);
131 MODULE_PARM_DESC(old_scheme_first
,
132 "start with the old device initialization scheme");
134 static int use_both_schemes
= 1;
135 module_param(use_both_schemes
, bool, S_IRUGO
| S_IWUSR
);
136 MODULE_PARM_DESC(use_both_schemes
,
137 "try the other device initialization scheme if the "
140 /* Mutual exclusion for EHCI CF initialization. This interferes with
141 * port reset on some companion controllers.
143 DECLARE_RWSEM(ehci_cf_port_reset_rwsem
);
144 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem
);
146 #define HUB_DEBOUNCE_TIMEOUT 1500
147 #define HUB_DEBOUNCE_STEP 25
148 #define HUB_DEBOUNCE_STABLE 100
151 static int usb_reset_and_verify_device(struct usb_device
*udev
);
153 static inline char *portspeed(int portstatus
)
155 if (portstatus
& (1 << USB_PORT_FEAT_HIGHSPEED
))
157 else if (portstatus
& (1 << USB_PORT_FEAT_LOWSPEED
))
163 /* Note that hdev or one of its children must be locked! */
164 static inline struct usb_hub
*hdev_to_hub(struct usb_device
*hdev
)
166 return usb_get_intfdata(hdev
->actconfig
->interface
[0]);
169 /* USB 2.0 spec Section 11.24.4.5 */
170 static int get_hub_descriptor(struct usb_device
*hdev
, void *data
, int size
)
174 for (i
= 0; i
< 3; i
++) {
175 ret
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
176 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
| USB_RT_HUB
,
177 USB_DT_HUB
<< 8, 0, data
, size
,
178 USB_CTRL_GET_TIMEOUT
);
179 if (ret
>= (USB_DT_HUB_NONVAR_SIZE
+ 2))
186 * USB 2.0 spec Section 11.24.2.1
188 static int clear_hub_feature(struct usb_device
*hdev
, int feature
)
190 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
191 USB_REQ_CLEAR_FEATURE
, USB_RT_HUB
, feature
, 0, NULL
, 0, 1000);
195 * USB 2.0 spec Section 11.24.2.2
197 static int clear_port_feature(struct usb_device
*hdev
, int port1
, int feature
)
199 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
200 USB_REQ_CLEAR_FEATURE
, USB_RT_PORT
, feature
, port1
,
205 * USB 2.0 spec Section 11.24.2.13
207 static int set_port_feature(struct usb_device
*hdev
, int port1
, int feature
)
209 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
210 USB_REQ_SET_FEATURE
, USB_RT_PORT
, feature
, port1
,
215 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
216 * for info about using port indicators
218 static void set_port_led(
224 int status
= set_port_feature(hub
->hdev
, (selector
<< 8) | port1
,
225 USB_PORT_FEAT_INDICATOR
);
227 dev_dbg (hub
->intfdev
,
228 "port %d indicator %s status %d\n",
230 ({ char *s
; switch (selector
) {
231 case HUB_LED_AMBER
: s
= "amber"; break;
232 case HUB_LED_GREEN
: s
= "green"; break;
233 case HUB_LED_OFF
: s
= "off"; break;
234 case HUB_LED_AUTO
: s
= "auto"; break;
235 default: s
= "??"; break;
240 #define LED_CYCLE_PERIOD ((2*HZ)/3)
242 static void led_work (struct work_struct
*work
)
244 struct usb_hub
*hub
=
245 container_of(work
, struct usb_hub
, leds
.work
);
246 struct usb_device
*hdev
= hub
->hdev
;
248 unsigned changed
= 0;
251 if (hdev
->state
!= USB_STATE_CONFIGURED
|| hub
->quiescing
)
254 for (i
= 0; i
< hub
->descriptor
->bNbrPorts
; i
++) {
255 unsigned selector
, mode
;
257 /* 30%-50% duty cycle */
259 switch (hub
->indicator
[i
]) {
261 case INDICATOR_CYCLE
:
263 selector
= HUB_LED_AUTO
;
264 mode
= INDICATOR_AUTO
;
266 /* blinking green = sw attention */
267 case INDICATOR_GREEN_BLINK
:
268 selector
= HUB_LED_GREEN
;
269 mode
= INDICATOR_GREEN_BLINK_OFF
;
271 case INDICATOR_GREEN_BLINK_OFF
:
272 selector
= HUB_LED_OFF
;
273 mode
= INDICATOR_GREEN_BLINK
;
275 /* blinking amber = hw attention */
276 case INDICATOR_AMBER_BLINK
:
277 selector
= HUB_LED_AMBER
;
278 mode
= INDICATOR_AMBER_BLINK_OFF
;
280 case INDICATOR_AMBER_BLINK_OFF
:
281 selector
= HUB_LED_OFF
;
282 mode
= INDICATOR_AMBER_BLINK
;
284 /* blink green/amber = reserved */
285 case INDICATOR_ALT_BLINK
:
286 selector
= HUB_LED_GREEN
;
287 mode
= INDICATOR_ALT_BLINK_OFF
;
289 case INDICATOR_ALT_BLINK_OFF
:
290 selector
= HUB_LED_AMBER
;
291 mode
= INDICATOR_ALT_BLINK
;
296 if (selector
!= HUB_LED_AUTO
)
298 set_port_led(hub
, i
+ 1, selector
);
299 hub
->indicator
[i
] = mode
;
301 if (!changed
&& blinkenlights
) {
303 cursor
%= hub
->descriptor
->bNbrPorts
;
304 set_port_led(hub
, cursor
+ 1, HUB_LED_GREEN
);
305 hub
->indicator
[cursor
] = INDICATOR_CYCLE
;
309 schedule_delayed_work(&hub
->leds
, LED_CYCLE_PERIOD
);
312 /* use a short timeout for hub/port status fetches */
313 #define USB_STS_TIMEOUT 1000
314 #define USB_STS_RETRIES 5
317 * USB 2.0 spec Section 11.24.2.6
319 static int get_hub_status(struct usb_device
*hdev
,
320 struct usb_hub_status
*data
)
322 int i
, status
= -ETIMEDOUT
;
324 for (i
= 0; i
< USB_STS_RETRIES
&& status
== -ETIMEDOUT
; i
++) {
325 status
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
326 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_HUB
, 0, 0,
327 data
, sizeof(*data
), USB_STS_TIMEOUT
);
333 * USB 2.0 spec Section 11.24.2.7
335 static int get_port_status(struct usb_device
*hdev
, int port1
,
336 struct usb_port_status
*data
)
338 int i
, status
= -ETIMEDOUT
;
340 for (i
= 0; i
< USB_STS_RETRIES
&& status
== -ETIMEDOUT
; i
++) {
341 status
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
342 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_PORT
, 0, port1
,
343 data
, sizeof(*data
), USB_STS_TIMEOUT
);
348 static int hub_port_status(struct usb_hub
*hub
, int port1
,
349 u16
*status
, u16
*change
)
353 mutex_lock(&hub
->status_mutex
);
354 ret
= get_port_status(hub
->hdev
, port1
, &hub
->status
->port
);
356 dev_err(hub
->intfdev
,
357 "%s failed (err = %d)\n", __func__
, ret
);
361 *status
= le16_to_cpu(hub
->status
->port
.wPortStatus
);
362 *change
= le16_to_cpu(hub
->status
->port
.wPortChange
);
365 mutex_unlock(&hub
->status_mutex
);
369 static void kick_khubd(struct usb_hub
*hub
)
373 /* Suppress autosuspend until khubd runs */
374 to_usb_interface(hub
->intfdev
)->pm_usage_cnt
= 1;
376 spin_lock_irqsave(&hub_event_lock
, flags
);
377 if (!hub
->disconnected
&& list_empty(&hub
->event_list
)) {
378 list_add_tail(&hub
->event_list
, &hub_event_list
);
379 wake_up(&khubd_wait
);
381 spin_unlock_irqrestore(&hub_event_lock
, flags
);
384 void usb_kick_khubd(struct usb_device
*hdev
)
386 /* FIXME: What if hdev isn't bound to the hub driver? */
387 kick_khubd(hdev_to_hub(hdev
));
391 /* completion function, fires on port status changes and various faults */
392 static void hub_irq(struct urb
*urb
)
394 struct usb_hub
*hub
= urb
->context
;
395 int status
= urb
->status
;
400 case -ENOENT
: /* synchronous unlink */
401 case -ECONNRESET
: /* async unlink */
402 case -ESHUTDOWN
: /* hardware going away */
405 default: /* presumably an error */
406 /* Cause a hub reset after 10 consecutive errors */
407 dev_dbg (hub
->intfdev
, "transfer --> %d\n", status
);
408 if ((++hub
->nerrors
< 10) || hub
->error
)
413 /* let khubd handle things */
414 case 0: /* we got data: port status changed */
416 for (i
= 0; i
< urb
->actual_length
; ++i
)
417 bits
|= ((unsigned long) ((*hub
->buffer
)[i
]))
419 hub
->event_bits
[0] = bits
;
425 /* Something happened, let khubd figure it out */
432 if ((status
= usb_submit_urb (hub
->urb
, GFP_ATOMIC
)) != 0
433 && status
!= -ENODEV
&& status
!= -EPERM
)
434 dev_err (hub
->intfdev
, "resubmit --> %d\n", status
);
437 /* USB 2.0 spec Section 11.24.2.3 */
439 hub_clear_tt_buffer (struct usb_device
*hdev
, u16 devinfo
, u16 tt
)
441 return usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
442 HUB_CLEAR_TT_BUFFER
, USB_RT_PORT
, devinfo
,
447 * enumeration blocks khubd for a long time. we use keventd instead, since
448 * long blocking there is the exception, not the rule. accordingly, HCDs
449 * talking to TTs must queue control transfers (not just bulk and iso), so
450 * both can talk to the same hub concurrently.
452 static void hub_tt_kevent (struct work_struct
*work
)
454 struct usb_hub
*hub
=
455 container_of(work
, struct usb_hub
, tt
.kevent
);
459 spin_lock_irqsave (&hub
->tt
.lock
, flags
);
460 while (--limit
&& !list_empty (&hub
->tt
.clear_list
)) {
461 struct list_head
*temp
;
462 struct usb_tt_clear
*clear
;
463 struct usb_device
*hdev
= hub
->hdev
;
466 temp
= hub
->tt
.clear_list
.next
;
467 clear
= list_entry (temp
, struct usb_tt_clear
, clear_list
);
468 list_del (&clear
->clear_list
);
470 /* drop lock so HCD can concurrently report other TT errors */
471 spin_unlock_irqrestore (&hub
->tt
.lock
, flags
);
472 status
= hub_clear_tt_buffer (hdev
, clear
->devinfo
, clear
->tt
);
473 spin_lock_irqsave (&hub
->tt
.lock
, flags
);
477 "clear tt %d (%04x) error %d\n",
478 clear
->tt
, clear
->devinfo
, status
);
481 spin_unlock_irqrestore (&hub
->tt
.lock
, flags
);
485 * usb_hub_tt_clear_buffer - clear control/bulk TT state in high speed hub
486 * @udev: the device whose split transaction failed
487 * @pipe: identifies the endpoint of the failed transaction
489 * High speed HCDs use this to tell the hub driver that some split control or
490 * bulk transaction failed in a way that requires clearing internal state of
491 * a transaction translator. This is normally detected (and reported) from
494 * It may not be possible for that hub to handle additional full (or low)
495 * speed transactions until that state is fully cleared out.
497 void usb_hub_tt_clear_buffer (struct usb_device
*udev
, int pipe
)
499 struct usb_tt
*tt
= udev
->tt
;
501 struct usb_tt_clear
*clear
;
503 /* we've got to cope with an arbitrary number of pending TT clears,
504 * since each TT has "at least two" buffers that can need it (and
505 * there can be many TTs per hub). even if they're uncommon.
507 if ((clear
= kmalloc (sizeof *clear
, GFP_ATOMIC
)) == NULL
) {
508 dev_err (&udev
->dev
, "can't save CLEAR_TT_BUFFER state\n");
509 /* FIXME recover somehow ... RESET_TT? */
513 /* info that CLEAR_TT_BUFFER needs */
514 clear
->tt
= tt
->multi
? udev
->ttport
: 1;
515 clear
->devinfo
= usb_pipeendpoint (pipe
);
516 clear
->devinfo
|= udev
->devnum
<< 4;
517 clear
->devinfo
|= usb_pipecontrol (pipe
)
518 ? (USB_ENDPOINT_XFER_CONTROL
<< 11)
519 : (USB_ENDPOINT_XFER_BULK
<< 11);
520 if (usb_pipein (pipe
))
521 clear
->devinfo
|= 1 << 15;
523 /* tell keventd to clear state for this TT */
524 spin_lock_irqsave (&tt
->lock
, flags
);
525 list_add_tail (&clear
->clear_list
, &tt
->clear_list
);
526 schedule_work (&tt
->kevent
);
527 spin_unlock_irqrestore (&tt
->lock
, flags
);
529 EXPORT_SYMBOL_GPL(usb_hub_tt_clear_buffer
);
531 /* If do_delay is false, return the number of milliseconds the caller
534 static unsigned hub_power_on(struct usb_hub
*hub
, bool do_delay
)
537 unsigned pgood_delay
= hub
->descriptor
->bPwrOn2PwrGood
* 2;
539 u16 wHubCharacteristics
=
540 le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
542 /* Enable power on each port. Some hubs have reserved values
543 * of LPSM (> 2) in their descriptors, even though they are
544 * USB 2.0 hubs. Some hubs do not implement port-power switching
545 * but only emulate it. In all cases, the ports won't work
546 * unless we send these messages to the hub.
548 if ((wHubCharacteristics
& HUB_CHAR_LPSM
) < 2)
549 dev_dbg(hub
->intfdev
, "enabling power on all ports\n");
551 dev_dbg(hub
->intfdev
, "trying to enable port power on "
552 "non-switchable hub\n");
553 for (port1
= 1; port1
<= hub
->descriptor
->bNbrPorts
; port1
++)
554 set_port_feature(hub
->hdev
, port1
, USB_PORT_FEAT_POWER
);
556 /* Wait at least 100 msec for power to become stable */
557 delay
= max(pgood_delay
, (unsigned) 100);
563 static int hub_hub_status(struct usb_hub
*hub
,
564 u16
*status
, u16
*change
)
568 mutex_lock(&hub
->status_mutex
);
569 ret
= get_hub_status(hub
->hdev
, &hub
->status
->hub
);
571 dev_err (hub
->intfdev
,
572 "%s failed (err = %d)\n", __func__
, ret
);
574 *status
= le16_to_cpu(hub
->status
->hub
.wHubStatus
);
575 *change
= le16_to_cpu(hub
->status
->hub
.wHubChange
);
578 mutex_unlock(&hub
->status_mutex
);
582 static int hub_port_disable(struct usb_hub
*hub
, int port1
, int set_state
)
584 struct usb_device
*hdev
= hub
->hdev
;
587 if (hdev
->children
[port1
-1] && set_state
)
588 usb_set_device_state(hdev
->children
[port1
-1],
589 USB_STATE_NOTATTACHED
);
591 ret
= clear_port_feature(hdev
, port1
, USB_PORT_FEAT_ENABLE
);
593 dev_err(hub
->intfdev
, "cannot disable port %d (err = %d)\n",
599 * Disable a port and mark a logical connnect-change event, so that some
600 * time later khubd will disconnect() any existing usb_device on the port
601 * and will re-enumerate if there actually is a device attached.
603 static void hub_port_logical_disconnect(struct usb_hub
*hub
, int port1
)
605 dev_dbg(hub
->intfdev
, "logical disconnect on port %d\n", port1
);
606 hub_port_disable(hub
, port1
, 1);
608 /* FIXME let caller ask to power down the port:
609 * - some devices won't enumerate without a VBUS power cycle
610 * - SRP saves power that way
611 * - ... new call, TBD ...
612 * That's easy if this hub can switch power per-port, and
613 * khubd reactivates the port later (timer, SRP, etc).
614 * Powerdown must be optional, because of reset/DFU.
617 set_bit(port1
, hub
->change_bits
);
621 enum hub_activation_type
{
622 HUB_INIT
, HUB_INIT2
, HUB_INIT3
,
623 HUB_POST_RESET
, HUB_RESUME
, HUB_RESET_RESUME
,
626 static void hub_init_func2(struct work_struct
*ws
);
627 static void hub_init_func3(struct work_struct
*ws
);
629 static void hub_activate(struct usb_hub
*hub
, enum hub_activation_type type
)
631 struct usb_device
*hdev
= hub
->hdev
;
634 bool need_debounce_delay
= false;
637 /* Continue a partial initialization */
638 if (type
== HUB_INIT2
)
640 if (type
== HUB_INIT3
)
643 /* After a resume, port power should still be on.
644 * For any other type of activation, turn it on.
646 if (type
!= HUB_RESUME
) {
648 /* Speed up system boot by using a delayed_work for the
649 * hub's initial power-up delays. This is pretty awkward
650 * and the implementation looks like a home-brewed sort of
651 * setjmp/longjmp, but it saves at least 100 ms for each
652 * root hub (assuming usbcore is compiled into the kernel
653 * rather than as a module). It adds up.
655 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
656 * because for those activation types the ports have to be
657 * operational when we return. In theory this could be done
658 * for HUB_POST_RESET, but it's easier not to.
660 if (type
== HUB_INIT
) {
661 delay
= hub_power_on(hub
, false);
662 PREPARE_DELAYED_WORK(&hub
->init_work
, hub_init_func2
);
663 schedule_delayed_work(&hub
->init_work
,
664 msecs_to_jiffies(delay
));
666 /* Suppress autosuspend until init is done */
667 to_usb_interface(hub
->intfdev
)->pm_usage_cnt
= 1;
668 return; /* Continues at init2: below */
670 hub_power_on(hub
, true);
675 /* Check each port and set hub->change_bits to let khubd know
676 * which ports need attention.
678 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
679 struct usb_device
*udev
= hdev
->children
[port1
-1];
680 u16 portstatus
, portchange
;
682 portstatus
= portchange
= 0;
683 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
684 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
))
685 dev_dbg(hub
->intfdev
,
686 "port %d: status %04x change %04x\n",
687 port1
, portstatus
, portchange
);
689 /* After anything other than HUB_RESUME (i.e., initialization
690 * or any sort of reset), every port should be disabled.
691 * Unconnected ports should likewise be disabled (paranoia),
692 * and so should ports for which we have no usb_device.
694 if ((portstatus
& USB_PORT_STAT_ENABLE
) && (
695 type
!= HUB_RESUME
||
696 !(portstatus
& USB_PORT_STAT_CONNECTION
) ||
698 udev
->state
== USB_STATE_NOTATTACHED
)) {
699 clear_port_feature(hdev
, port1
, USB_PORT_FEAT_ENABLE
);
700 portstatus
&= ~USB_PORT_STAT_ENABLE
;
703 /* Clear status-change flags; we'll debounce later */
704 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
705 need_debounce_delay
= true;
706 clear_port_feature(hub
->hdev
, port1
,
707 USB_PORT_FEAT_C_CONNECTION
);
709 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
710 need_debounce_delay
= true;
711 clear_port_feature(hub
->hdev
, port1
,
712 USB_PORT_FEAT_C_ENABLE
);
715 if (!udev
|| udev
->state
== USB_STATE_NOTATTACHED
) {
716 /* Tell khubd to disconnect the device or
717 * check for a new connection
719 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
))
720 set_bit(port1
, hub
->change_bits
);
722 } else if (portstatus
& USB_PORT_STAT_ENABLE
) {
723 /* The power session apparently survived the resume.
724 * If there was an overcurrent or suspend change
725 * (i.e., remote wakeup request), have khubd
729 set_bit(port1
, hub
->change_bits
);
731 } else if (udev
->persist_enabled
) {
733 udev
->reset_resume
= 1;
735 set_bit(port1
, hub
->change_bits
);
738 /* The power session is gone; tell khubd */
739 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
740 set_bit(port1
, hub
->change_bits
);
744 /* If no port-status-change flags were set, we don't need any
745 * debouncing. If flags were set we can try to debounce the
746 * ports all at once right now, instead of letting khubd do them
747 * one at a time later on.
749 * If any port-status changes do occur during this delay, khubd
750 * will see them later and handle them normally.
752 if (need_debounce_delay
) {
753 delay
= HUB_DEBOUNCE_STABLE
;
755 /* Don't do a long sleep inside a workqueue routine */
756 if (type
== HUB_INIT2
) {
757 PREPARE_DELAYED_WORK(&hub
->init_work
, hub_init_func3
);
758 schedule_delayed_work(&hub
->init_work
,
759 msecs_to_jiffies(delay
));
760 return; /* Continues at init3: below */
768 status
= usb_submit_urb(hub
->urb
, GFP_NOIO
);
770 dev_err(hub
->intfdev
, "activate --> %d\n", status
);
771 if (hub
->has_indicators
&& blinkenlights
)
772 schedule_delayed_work(&hub
->leds
, LED_CYCLE_PERIOD
);
774 /* Scan all ports that need attention */
778 /* Implement the continuations for the delays above */
779 static void hub_init_func2(struct work_struct
*ws
)
781 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
783 hub_activate(hub
, HUB_INIT2
);
786 static void hub_init_func3(struct work_struct
*ws
)
788 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
790 hub_activate(hub
, HUB_INIT3
);
793 enum hub_quiescing_type
{
794 HUB_DISCONNECT
, HUB_PRE_RESET
, HUB_SUSPEND
797 static void hub_quiesce(struct usb_hub
*hub
, enum hub_quiescing_type type
)
799 struct usb_device
*hdev
= hub
->hdev
;
802 cancel_delayed_work_sync(&hub
->init_work
);
804 /* khubd and related activity won't re-trigger */
807 if (type
!= HUB_SUSPEND
) {
808 /* Disconnect all the children */
809 for (i
= 0; i
< hdev
->maxchild
; ++i
) {
810 if (hdev
->children
[i
])
811 usb_disconnect(&hdev
->children
[i
]);
815 /* Stop khubd and related activity */
816 usb_kill_urb(hub
->urb
);
817 if (hub
->has_indicators
)
818 cancel_delayed_work_sync(&hub
->leds
);
820 cancel_work_sync(&hub
->tt
.kevent
);
823 /* caller has locked the hub device */
824 static int hub_pre_reset(struct usb_interface
*intf
)
826 struct usb_hub
*hub
= usb_get_intfdata(intf
);
828 hub_quiesce(hub
, HUB_PRE_RESET
);
832 /* caller has locked the hub device */
833 static int hub_post_reset(struct usb_interface
*intf
)
835 struct usb_hub
*hub
= usb_get_intfdata(intf
);
837 hub_activate(hub
, HUB_POST_RESET
);
841 static int hub_configure(struct usb_hub
*hub
,
842 struct usb_endpoint_descriptor
*endpoint
)
844 struct usb_device
*hdev
= hub
->hdev
;
845 struct device
*hub_dev
= hub
->intfdev
;
846 u16 hubstatus
, hubchange
;
847 u16 wHubCharacteristics
;
852 hub
->buffer
= usb_buffer_alloc(hdev
, sizeof(*hub
->buffer
), GFP_KERNEL
,
855 message
= "can't allocate hub irq buffer";
860 hub
->status
= kmalloc(sizeof(*hub
->status
), GFP_KERNEL
);
862 message
= "can't kmalloc hub status buffer";
866 mutex_init(&hub
->status_mutex
);
868 hub
->descriptor
= kmalloc(sizeof(*hub
->descriptor
), GFP_KERNEL
);
869 if (!hub
->descriptor
) {
870 message
= "can't kmalloc hub descriptor";
875 /* Request the entire hub descriptor.
876 * hub->descriptor can handle USB_MAXCHILDREN ports,
877 * but the hub can/will return fewer bytes here.
879 ret
= get_hub_descriptor(hdev
, hub
->descriptor
,
880 sizeof(*hub
->descriptor
));
882 message
= "can't read hub descriptor";
884 } else if (hub
->descriptor
->bNbrPorts
> USB_MAXCHILDREN
) {
885 message
= "hub has too many ports!";
890 hdev
->maxchild
= hub
->descriptor
->bNbrPorts
;
891 dev_info (hub_dev
, "%d port%s detected\n", hdev
->maxchild
,
892 (hdev
->maxchild
== 1) ? "" : "s");
894 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
896 if (wHubCharacteristics
& HUB_CHAR_COMPOUND
) {
898 char portstr
[USB_MAXCHILDREN
+ 1];
900 for (i
= 0; i
< hdev
->maxchild
; i
++)
901 portstr
[i
] = hub
->descriptor
->DeviceRemovable
902 [((i
+ 1) / 8)] & (1 << ((i
+ 1) % 8))
904 portstr
[hdev
->maxchild
] = 0;
905 dev_dbg(hub_dev
, "compound device; port removable status: %s\n", portstr
);
907 dev_dbg(hub_dev
, "standalone hub\n");
909 switch (wHubCharacteristics
& HUB_CHAR_LPSM
) {
911 dev_dbg(hub_dev
, "ganged power switching\n");
914 dev_dbg(hub_dev
, "individual port power switching\n");
918 dev_dbg(hub_dev
, "no power switching (usb 1.0)\n");
922 switch (wHubCharacteristics
& HUB_CHAR_OCPM
) {
924 dev_dbg(hub_dev
, "global over-current protection\n");
927 dev_dbg(hub_dev
, "individual port over-current protection\n");
931 dev_dbg(hub_dev
, "no over-current protection\n");
935 spin_lock_init (&hub
->tt
.lock
);
936 INIT_LIST_HEAD (&hub
->tt
.clear_list
);
937 INIT_WORK (&hub
->tt
.kevent
, hub_tt_kevent
);
938 switch (hdev
->descriptor
.bDeviceProtocol
) {
942 dev_dbg(hub_dev
, "Single TT\n");
946 ret
= usb_set_interface(hdev
, 0, 1);
948 dev_dbg(hub_dev
, "TT per port\n");
951 dev_err(hub_dev
, "Using single TT (err %d)\n",
956 dev_dbg(hub_dev
, "Unrecognized hub protocol %d\n",
957 hdev
->descriptor
.bDeviceProtocol
);
961 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
962 switch (wHubCharacteristics
& HUB_CHAR_TTTT
) {
963 case HUB_TTTT_8_BITS
:
964 if (hdev
->descriptor
.bDeviceProtocol
!= 0) {
965 hub
->tt
.think_time
= 666;
966 dev_dbg(hub_dev
, "TT requires at most %d "
967 "FS bit times (%d ns)\n",
968 8, hub
->tt
.think_time
);
971 case HUB_TTTT_16_BITS
:
972 hub
->tt
.think_time
= 666 * 2;
973 dev_dbg(hub_dev
, "TT requires at most %d "
974 "FS bit times (%d ns)\n",
975 16, hub
->tt
.think_time
);
977 case HUB_TTTT_24_BITS
:
978 hub
->tt
.think_time
= 666 * 3;
979 dev_dbg(hub_dev
, "TT requires at most %d "
980 "FS bit times (%d ns)\n",
981 24, hub
->tt
.think_time
);
983 case HUB_TTTT_32_BITS
:
984 hub
->tt
.think_time
= 666 * 4;
985 dev_dbg(hub_dev
, "TT requires at most %d "
986 "FS bit times (%d ns)\n",
987 32, hub
->tt
.think_time
);
991 /* probe() zeroes hub->indicator[] */
992 if (wHubCharacteristics
& HUB_CHAR_PORTIND
) {
993 hub
->has_indicators
= 1;
994 dev_dbg(hub_dev
, "Port indicators are supported\n");
997 dev_dbg(hub_dev
, "power on to power good time: %dms\n",
998 hub
->descriptor
->bPwrOn2PwrGood
* 2);
1000 /* power budgeting mostly matters with bus-powered hubs,
1001 * and battery-powered root hubs (may provide just 8 mA).
1003 ret
= usb_get_status(hdev
, USB_RECIP_DEVICE
, 0, &hubstatus
);
1005 message
= "can't get hub status";
1008 le16_to_cpus(&hubstatus
);
1009 if (hdev
== hdev
->bus
->root_hub
) {
1010 if (hdev
->bus_mA
== 0 || hdev
->bus_mA
>= 500)
1011 hub
->mA_per_port
= 500;
1013 hub
->mA_per_port
= hdev
->bus_mA
;
1014 hub
->limited_power
= 1;
1016 } else if ((hubstatus
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
1017 dev_dbg(hub_dev
, "hub controller current requirement: %dmA\n",
1018 hub
->descriptor
->bHubContrCurrent
);
1019 hub
->limited_power
= 1;
1020 if (hdev
->maxchild
> 0) {
1021 int remaining
= hdev
->bus_mA
-
1022 hub
->descriptor
->bHubContrCurrent
;
1024 if (remaining
< hdev
->maxchild
* 100)
1026 "insufficient power available "
1027 "to use all downstream ports\n");
1028 hub
->mA_per_port
= 100; /* 7.2.1.1 */
1030 } else { /* Self-powered external hub */
1031 /* FIXME: What about battery-powered external hubs that
1032 * provide less current per port? */
1033 hub
->mA_per_port
= 500;
1035 if (hub
->mA_per_port
< 500)
1036 dev_dbg(hub_dev
, "%umA bus power budget for each child\n",
1039 ret
= hub_hub_status(hub
, &hubstatus
, &hubchange
);
1041 message
= "can't get hub status";
1045 /* local power status reports aren't always correct */
1046 if (hdev
->actconfig
->desc
.bmAttributes
& USB_CONFIG_ATT_SELFPOWER
)
1047 dev_dbg(hub_dev
, "local power source is %s\n",
1048 (hubstatus
& HUB_STATUS_LOCAL_POWER
)
1049 ? "lost (inactive)" : "good");
1051 if ((wHubCharacteristics
& HUB_CHAR_OCPM
) == 0)
1052 dev_dbg(hub_dev
, "%sover-current condition exists\n",
1053 (hubstatus
& HUB_STATUS_OVERCURRENT
) ? "" : "no ");
1055 /* set up the interrupt endpoint
1056 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1057 * bytes as USB2.0[11.12.3] says because some hubs are known
1058 * to send more data (and thus cause overflow). For root hubs,
1059 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1060 * to be big enough for at least USB_MAXCHILDREN ports. */
1061 pipe
= usb_rcvintpipe(hdev
, endpoint
->bEndpointAddress
);
1062 maxp
= usb_maxpacket(hdev
, pipe
, usb_pipeout(pipe
));
1064 if (maxp
> sizeof(*hub
->buffer
))
1065 maxp
= sizeof(*hub
->buffer
);
1067 hub
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
1069 message
= "couldn't allocate interrupt urb";
1074 usb_fill_int_urb(hub
->urb
, hdev
, pipe
, *hub
->buffer
, maxp
, hub_irq
,
1075 hub
, endpoint
->bInterval
);
1076 hub
->urb
->transfer_dma
= hub
->buffer_dma
;
1077 hub
->urb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
1079 /* maybe cycle the hub leds */
1080 if (hub
->has_indicators
&& blinkenlights
)
1081 hub
->indicator
[0] = INDICATOR_CYCLE
;
1083 hub_activate(hub
, HUB_INIT
);
1087 dev_err (hub_dev
, "config failed, %s (err %d)\n",
1089 /* hub_disconnect() frees urb and descriptor */
1093 static void hub_release(struct kref
*kref
)
1095 struct usb_hub
*hub
= container_of(kref
, struct usb_hub
, kref
);
1097 usb_put_intf(to_usb_interface(hub
->intfdev
));
1101 static unsigned highspeed_hubs
;
1103 static void hub_disconnect(struct usb_interface
*intf
)
1105 struct usb_hub
*hub
= usb_get_intfdata (intf
);
1107 /* Take the hub off the event list and don't let it be added again */
1108 spin_lock_irq(&hub_event_lock
);
1109 list_del_init(&hub
->event_list
);
1110 hub
->disconnected
= 1;
1111 spin_unlock_irq(&hub_event_lock
);
1113 /* Disconnect all children and quiesce the hub */
1115 hub_quiesce(hub
, HUB_DISCONNECT
);
1117 usb_set_intfdata (intf
, NULL
);
1119 if (hub
->hdev
->speed
== USB_SPEED_HIGH
)
1122 usb_free_urb(hub
->urb
);
1123 kfree(hub
->descriptor
);
1125 usb_buffer_free(hub
->hdev
, sizeof(*hub
->buffer
), hub
->buffer
,
1128 kref_put(&hub
->kref
, hub_release
);
1131 static int hub_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
1133 struct usb_host_interface
*desc
;
1134 struct usb_endpoint_descriptor
*endpoint
;
1135 struct usb_device
*hdev
;
1136 struct usb_hub
*hub
;
1138 desc
= intf
->cur_altsetting
;
1139 hdev
= interface_to_usbdev(intf
);
1141 if (hdev
->level
== MAX_TOPO_LEVEL
) {
1143 "Unsupported bus topology: hub nested too deep\n");
1147 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1149 dev_warn(&intf
->dev
, "ignoring external hub\n");
1154 /* Some hubs have a subclass of 1, which AFAICT according to the */
1155 /* specs is not defined, but it works */
1156 if ((desc
->desc
.bInterfaceSubClass
!= 0) &&
1157 (desc
->desc
.bInterfaceSubClass
!= 1)) {
1159 dev_err (&intf
->dev
, "bad descriptor, ignoring hub\n");
1163 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1164 if (desc
->desc
.bNumEndpoints
!= 1)
1165 goto descriptor_error
;
1167 endpoint
= &desc
->endpoint
[0].desc
;
1169 /* If it's not an interrupt in endpoint, we'd better punt! */
1170 if (!usb_endpoint_is_int_in(endpoint
))
1171 goto descriptor_error
;
1173 /* We found a hub */
1174 dev_info (&intf
->dev
, "USB hub found\n");
1176 hub
= kzalloc(sizeof(*hub
), GFP_KERNEL
);
1178 dev_dbg (&intf
->dev
, "couldn't kmalloc hub struct\n");
1182 kref_init(&hub
->kref
);
1183 INIT_LIST_HEAD(&hub
->event_list
);
1184 hub
->intfdev
= &intf
->dev
;
1186 INIT_DELAYED_WORK(&hub
->leds
, led_work
);
1187 INIT_DELAYED_WORK(&hub
->init_work
, NULL
);
1190 usb_set_intfdata (intf
, hub
);
1191 intf
->needs_remote_wakeup
= 1;
1193 if (hdev
->speed
== USB_SPEED_HIGH
)
1196 if (hub_configure(hub
, endpoint
) >= 0)
1199 hub_disconnect (intf
);
1204 hub_ioctl(struct usb_interface
*intf
, unsigned int code
, void *user_data
)
1206 struct usb_device
*hdev
= interface_to_usbdev (intf
);
1208 /* assert ifno == 0 (part of hub spec) */
1210 case USBDEVFS_HUB_PORTINFO
: {
1211 struct usbdevfs_hub_portinfo
*info
= user_data
;
1214 spin_lock_irq(&device_state_lock
);
1215 if (hdev
->devnum
<= 0)
1218 info
->nports
= hdev
->maxchild
;
1219 for (i
= 0; i
< info
->nports
; i
++) {
1220 if (hdev
->children
[i
] == NULL
)
1224 hdev
->children
[i
]->devnum
;
1227 spin_unlock_irq(&device_state_lock
);
1229 return info
->nports
+ 1;
1238 static void recursively_mark_NOTATTACHED(struct usb_device
*udev
)
1242 for (i
= 0; i
< udev
->maxchild
; ++i
) {
1243 if (udev
->children
[i
])
1244 recursively_mark_NOTATTACHED(udev
->children
[i
]);
1246 if (udev
->state
== USB_STATE_SUSPENDED
) {
1247 udev
->discon_suspended
= 1;
1248 udev
->active_duration
-= jiffies
;
1250 udev
->state
= USB_STATE_NOTATTACHED
;
1254 * usb_set_device_state - change a device's current state (usbcore, hcds)
1255 * @udev: pointer to device whose state should be changed
1256 * @new_state: new state value to be stored
1258 * udev->state is _not_ fully protected by the device lock. Although
1259 * most transitions are made only while holding the lock, the state can
1260 * can change to USB_STATE_NOTATTACHED at almost any time. This
1261 * is so that devices can be marked as disconnected as soon as possible,
1262 * without having to wait for any semaphores to be released. As a result,
1263 * all changes to any device's state must be protected by the
1264 * device_state_lock spinlock.
1266 * Once a device has been added to the device tree, all changes to its state
1267 * should be made using this routine. The state should _not_ be set directly.
1269 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1270 * Otherwise udev->state is set to new_state, and if new_state is
1271 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1272 * to USB_STATE_NOTATTACHED.
1274 void usb_set_device_state(struct usb_device
*udev
,
1275 enum usb_device_state new_state
)
1277 unsigned long flags
;
1279 spin_lock_irqsave(&device_state_lock
, flags
);
1280 if (udev
->state
== USB_STATE_NOTATTACHED
)
1282 else if (new_state
!= USB_STATE_NOTATTACHED
) {
1284 /* root hub wakeup capabilities are managed out-of-band
1285 * and may involve silicon errata ... ignore them here.
1288 if (udev
->state
== USB_STATE_SUSPENDED
1289 || new_state
== USB_STATE_SUSPENDED
)
1290 ; /* No change to wakeup settings */
1291 else if (new_state
== USB_STATE_CONFIGURED
)
1292 device_init_wakeup(&udev
->dev
,
1293 (udev
->actconfig
->desc
.bmAttributes
1294 & USB_CONFIG_ATT_WAKEUP
));
1296 device_init_wakeup(&udev
->dev
, 0);
1298 if (udev
->state
== USB_STATE_SUSPENDED
&&
1299 new_state
!= USB_STATE_SUSPENDED
)
1300 udev
->active_duration
-= jiffies
;
1301 else if (new_state
== USB_STATE_SUSPENDED
&&
1302 udev
->state
!= USB_STATE_SUSPENDED
)
1303 udev
->active_duration
+= jiffies
;
1304 udev
->state
= new_state
;
1306 recursively_mark_NOTATTACHED(udev
);
1307 spin_unlock_irqrestore(&device_state_lock
, flags
);
1311 * WUSB devices are simple: they have no hubs behind, so the mapping
1312 * device <-> virtual port number becomes 1:1. Why? to simplify the
1313 * life of the device connection logic in
1314 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1315 * handshake we need to assign a temporary address in the unauthorized
1316 * space. For simplicity we use the first virtual port number found to
1317 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1318 * and that becomes it's address [X < 128] or its unauthorized address
1321 * We add 1 as an offset to the one-based USB-stack port number
1322 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1323 * 0 is reserved by USB for default address; (b) Linux's USB stack
1324 * uses always #1 for the root hub of the controller. So USB stack's
1325 * port #1, which is wusb virtual-port #0 has address #2.
1327 static void choose_address(struct usb_device
*udev
)
1330 struct usb_bus
*bus
= udev
->bus
;
1332 /* If khubd ever becomes multithreaded, this will need a lock */
1334 devnum
= udev
->portnum
+ 1;
1335 BUG_ON(test_bit(devnum
, bus
->devmap
.devicemap
));
1337 /* Try to allocate the next devnum beginning at
1338 * bus->devnum_next. */
1339 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
, 128,
1342 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
,
1344 bus
->devnum_next
= ( devnum
>= 127 ? 1 : devnum
+ 1);
1347 set_bit(devnum
, bus
->devmap
.devicemap
);
1348 udev
->devnum
= devnum
;
1352 static void release_address(struct usb_device
*udev
)
1354 if (udev
->devnum
> 0) {
1355 clear_bit(udev
->devnum
, udev
->bus
->devmap
.devicemap
);
1360 static void update_address(struct usb_device
*udev
, int devnum
)
1362 /* The address for a WUSB device is managed by wusbcore. */
1364 udev
->devnum
= devnum
;
1367 #ifdef CONFIG_USB_SUSPEND
1369 static void usb_stop_pm(struct usb_device
*udev
)
1371 /* Synchronize with the ksuspend thread to prevent any more
1372 * autosuspend requests from being submitted, and decrement
1373 * the parent's count of unsuspended children.
1376 if (udev
->parent
&& !udev
->discon_suspended
)
1377 usb_autosuspend_device(udev
->parent
);
1378 usb_pm_unlock(udev
);
1380 /* Stop any autosuspend or autoresume requests already submitted */
1381 cancel_delayed_work_sync(&udev
->autosuspend
);
1382 cancel_work_sync(&udev
->autoresume
);
1387 static inline void usb_stop_pm(struct usb_device
*udev
)
1393 * usb_disconnect - disconnect a device (usbcore-internal)
1394 * @pdev: pointer to device being disconnected
1395 * Context: !in_interrupt ()
1397 * Something got disconnected. Get rid of it and all of its children.
1399 * If *pdev is a normal device then the parent hub must already be locked.
1400 * If *pdev is a root hub then this routine will acquire the
1401 * usb_bus_list_lock on behalf of the caller.
1403 * Only hub drivers (including virtual root hub drivers for host
1404 * controllers) should ever call this.
1406 * This call is synchronous, and may not be used in an interrupt context.
1408 void usb_disconnect(struct usb_device
**pdev
)
1410 struct usb_device
*udev
= *pdev
;
1414 pr_debug ("%s nodev\n", __func__
);
1418 /* mark the device as inactive, so any further urb submissions for
1419 * this device (and any of its children) will fail immediately.
1420 * this quiesces everyting except pending urbs.
1422 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
1423 dev_info (&udev
->dev
, "USB disconnect, address %d\n", udev
->devnum
);
1425 usb_lock_device(udev
);
1427 /* Free up all the children before we remove this device */
1428 for (i
= 0; i
< USB_MAXCHILDREN
; i
++) {
1429 if (udev
->children
[i
])
1430 usb_disconnect(&udev
->children
[i
]);
1433 /* deallocate hcd/hardware state ... nuking all pending urbs and
1434 * cleaning up all state associated with the current configuration
1435 * so that the hardware is now fully quiesced.
1437 dev_dbg (&udev
->dev
, "unregistering device\n");
1438 usb_disable_device(udev
, 0);
1439 usb_hcd_synchronize_unlinks(udev
);
1441 usb_remove_ep_devs(&udev
->ep0
);
1442 usb_unlock_device(udev
);
1444 /* Unregister the device. The device driver is responsible
1445 * for de-configuring the device and invoking the remove-device
1446 * notifier chain (used by usbfs and possibly others).
1448 device_del(&udev
->dev
);
1450 /* Free the device number and delete the parent's children[]
1451 * (or root_hub) pointer.
1453 release_address(udev
);
1455 /* Avoid races with recursively_mark_NOTATTACHED() */
1456 spin_lock_irq(&device_state_lock
);
1458 spin_unlock_irq(&device_state_lock
);
1462 put_device(&udev
->dev
);
1465 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
1466 static void show_string(struct usb_device
*udev
, char *id
, char *string
)
1470 dev_printk(KERN_INFO
, &udev
->dev
, "%s: %s\n", id
, string
);
1473 static void announce_device(struct usb_device
*udev
)
1475 dev_info(&udev
->dev
, "New USB device found, idVendor=%04x, idProduct=%04x\n",
1476 le16_to_cpu(udev
->descriptor
.idVendor
),
1477 le16_to_cpu(udev
->descriptor
.idProduct
));
1478 dev_info(&udev
->dev
,
1479 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
1480 udev
->descriptor
.iManufacturer
,
1481 udev
->descriptor
.iProduct
,
1482 udev
->descriptor
.iSerialNumber
);
1483 show_string(udev
, "Product", udev
->product
);
1484 show_string(udev
, "Manufacturer", udev
->manufacturer
);
1485 show_string(udev
, "SerialNumber", udev
->serial
);
1488 static inline void announce_device(struct usb_device
*udev
) { }
1491 #ifdef CONFIG_USB_OTG
1492 #include "otg_whitelist.h"
1496 * usb_configure_device_otg - FIXME (usbcore-internal)
1497 * @udev: newly addressed device (in ADDRESS state)
1499 * Do configuration for On-The-Go devices
1501 static int usb_configure_device_otg(struct usb_device
*udev
)
1505 #ifdef CONFIG_USB_OTG
1507 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1508 * to wake us after we've powered off VBUS; and HNP, switching roles
1509 * "host" to "peripheral". The OTG descriptor helps figure this out.
1511 if (!udev
->bus
->is_b_host
1513 && udev
->parent
== udev
->bus
->root_hub
) {
1514 struct usb_otg_descriptor
*desc
= 0;
1515 struct usb_bus
*bus
= udev
->bus
;
1517 /* descriptor may appear anywhere in config */
1518 if (__usb_get_extra_descriptor (udev
->rawdescriptors
[0],
1519 le16_to_cpu(udev
->config
[0].desc
.wTotalLength
),
1520 USB_DT_OTG
, (void **) &desc
) == 0) {
1521 if (desc
->bmAttributes
& USB_OTG_HNP
) {
1522 unsigned port1
= udev
->portnum
;
1524 dev_info(&udev
->dev
,
1525 "Dual-Role OTG device on %sHNP port\n",
1526 (port1
== bus
->otg_port
)
1529 /* enable HNP before suspend, it's simpler */
1530 if (port1
== bus
->otg_port
)
1531 bus
->b_hnp_enable
= 1;
1532 err
= usb_control_msg(udev
,
1533 usb_sndctrlpipe(udev
, 0),
1534 USB_REQ_SET_FEATURE
, 0,
1536 ? USB_DEVICE_B_HNP_ENABLE
1537 : USB_DEVICE_A_ALT_HNP_SUPPORT
,
1538 0, NULL
, 0, USB_CTRL_SET_TIMEOUT
);
1540 /* OTG MESSAGE: report errors here,
1541 * customize to match your product.
1543 dev_info(&udev
->dev
,
1544 "can't set HNP mode: %d\n",
1546 bus
->b_hnp_enable
= 0;
1552 if (!is_targeted(udev
)) {
1554 /* Maybe it can talk to us, though we can't talk to it.
1555 * (Includes HNP test device.)
1557 if (udev
->bus
->b_hnp_enable
|| udev
->bus
->is_b_host
) {
1558 err
= usb_port_suspend(udev
, PMSG_SUSPEND
);
1560 dev_dbg(&udev
->dev
, "HNP fail, %d\n", err
);
1572 * usb_configure_device - Detect and probe device intfs/otg (usbcore-internal)
1573 * @udev: newly addressed device (in ADDRESS state)
1575 * This is only called by usb_new_device() and usb_authorize_device()
1576 * and FIXME -- all comments that apply to them apply here wrt to
1579 * If the device is WUSB and not authorized, we don't attempt to read
1580 * the string descriptors, as they will be errored out by the device
1581 * until it has been authorized.
1583 static int usb_configure_device(struct usb_device
*udev
)
1587 if (udev
->config
== NULL
) {
1588 err
= usb_get_configuration(udev
);
1590 dev_err(&udev
->dev
, "can't read configurations, error %d\n",
1595 if (udev
->wusb
== 1 && udev
->authorized
== 0) {
1596 udev
->product
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1597 udev
->manufacturer
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1598 udev
->serial
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1601 /* read the standard strings and cache them if present */
1602 udev
->product
= usb_cache_string(udev
, udev
->descriptor
.iProduct
);
1603 udev
->manufacturer
= usb_cache_string(udev
,
1604 udev
->descriptor
.iManufacturer
);
1605 udev
->serial
= usb_cache_string(udev
, udev
->descriptor
.iSerialNumber
);
1607 err
= usb_configure_device_otg(udev
);
1614 * usb_new_device - perform initial device setup (usbcore-internal)
1615 * @udev: newly addressed device (in ADDRESS state)
1617 * This is called with devices which have been enumerated, but not yet
1618 * configured. The device descriptor is available, but not descriptors
1619 * for any device configuration. The caller must have locked either
1620 * the parent hub (if udev is a normal device) or else the
1621 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1622 * udev has already been installed, but udev is not yet visible through
1623 * sysfs or other filesystem code.
1625 * It will return if the device is configured properly or not. Zero if
1626 * the interface was registered with the driver core; else a negative
1629 * This call is synchronous, and may not be used in an interrupt context.
1631 * Only the hub driver or root-hub registrar should ever call this.
1633 int usb_new_device(struct usb_device
*udev
)
1637 /* Increment the parent's count of unsuspended children */
1639 usb_autoresume_device(udev
->parent
);
1641 usb_detect_quirks(udev
); /* Determine quirks */
1642 err
= usb_configure_device(udev
); /* detect & probe dev/intfs */
1645 /* export the usbdev device-node for libusb */
1646 udev
->dev
.devt
= MKDEV(USB_DEVICE_MAJOR
,
1647 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
1649 /* Tell the world! */
1650 announce_device(udev
);
1652 /* Register the device. The device driver is responsible
1653 * for configuring the device and invoking the add-device
1654 * notifier chain (used by usbfs and possibly others).
1656 err
= device_add(&udev
->dev
);
1658 dev_err(&udev
->dev
, "can't device_add, error %d\n", err
);
1662 (void) usb_create_ep_devs(&udev
->dev
, &udev
->ep0
, udev
);
1666 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
1673 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
1674 * @usb_dev: USB device
1676 * Move the USB device to a very basic state where interfaces are disabled
1677 * and the device is in fact unconfigured and unusable.
1679 * We share a lock (that we have) with device_del(), so we need to
1682 int usb_deauthorize_device(struct usb_device
*usb_dev
)
1685 usb_lock_device(usb_dev
);
1686 if (usb_dev
->authorized
== 0)
1687 goto out_unauthorized
;
1688 usb_dev
->authorized
= 0;
1689 usb_set_configuration(usb_dev
, -1);
1690 usb_dev
->product
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1691 usb_dev
->manufacturer
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1692 usb_dev
->serial
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1693 kfree(usb_dev
->config
);
1694 usb_dev
->config
= NULL
;
1695 for (cnt
= 0; cnt
< usb_dev
->descriptor
.bNumConfigurations
; cnt
++)
1696 kfree(usb_dev
->rawdescriptors
[cnt
]);
1697 usb_dev
->descriptor
.bNumConfigurations
= 0;
1698 kfree(usb_dev
->rawdescriptors
);
1700 usb_unlock_device(usb_dev
);
1705 int usb_authorize_device(struct usb_device
*usb_dev
)
1708 usb_lock_device(usb_dev
);
1709 if (usb_dev
->authorized
== 1)
1710 goto out_authorized
;
1711 kfree(usb_dev
->product
);
1712 usb_dev
->product
= NULL
;
1713 kfree(usb_dev
->manufacturer
);
1714 usb_dev
->manufacturer
= NULL
;
1715 kfree(usb_dev
->serial
);
1716 usb_dev
->serial
= NULL
;
1717 result
= usb_autoresume_device(usb_dev
);
1719 dev_err(&usb_dev
->dev
,
1720 "can't autoresume for authorization: %d\n", result
);
1721 goto error_autoresume
;
1723 result
= usb_get_device_descriptor(usb_dev
, sizeof(usb_dev
->descriptor
));
1725 dev_err(&usb_dev
->dev
, "can't re-read device descriptor for "
1726 "authorization: %d\n", result
);
1727 goto error_device_descriptor
;
1729 usb_dev
->authorized
= 1;
1730 result
= usb_configure_device(usb_dev
);
1732 goto error_configure
;
1733 /* Choose and set the configuration. This registers the interfaces
1734 * with the driver core and lets interface drivers bind to them.
1736 c
= usb_choose_configuration(usb_dev
);
1738 result
= usb_set_configuration(usb_dev
, c
);
1740 dev_err(&usb_dev
->dev
,
1741 "can't set config #%d, error %d\n", c
, result
);
1742 /* This need not be fatal. The user can try to
1743 * set other configurations. */
1746 dev_info(&usb_dev
->dev
, "authorized to connect\n");
1748 error_device_descriptor
:
1751 usb_unlock_device(usb_dev
); // complements locktree
1756 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
1757 static unsigned hub_is_wusb(struct usb_hub
*hub
)
1759 struct usb_hcd
*hcd
;
1760 if (hub
->hdev
->parent
!= NULL
) /* not a root hub? */
1762 hcd
= container_of(hub
->hdev
->bus
, struct usb_hcd
, self
);
1763 return hcd
->wireless
;
1767 #define PORT_RESET_TRIES 5
1768 #define SET_ADDRESS_TRIES 2
1769 #define GET_DESCRIPTOR_TRIES 2
1770 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1771 #define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1773 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1774 #define HUB_SHORT_RESET_TIME 10
1775 #define HUB_LONG_RESET_TIME 200
1776 #define HUB_RESET_TIMEOUT 500
1778 static int hub_port_wait_reset(struct usb_hub
*hub
, int port1
,
1779 struct usb_device
*udev
, unsigned int delay
)
1781 int delay_time
, ret
;
1785 for (delay_time
= 0;
1786 delay_time
< HUB_RESET_TIMEOUT
;
1787 delay_time
+= delay
) {
1788 /* wait to give the device a chance to reset */
1791 /* read and decode port status */
1792 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
1796 /* Device went away? */
1797 if (!(portstatus
& USB_PORT_STAT_CONNECTION
))
1800 /* bomb out completely if the connection bounced */
1801 if ((portchange
& USB_PORT_STAT_C_CONNECTION
))
1804 /* if we`ve finished resetting, then break out of the loop */
1805 if (!(portstatus
& USB_PORT_STAT_RESET
) &&
1806 (portstatus
& USB_PORT_STAT_ENABLE
)) {
1807 if (hub_is_wusb(hub
))
1808 udev
->speed
= USB_SPEED_VARIABLE
;
1809 else if (portstatus
& USB_PORT_STAT_HIGH_SPEED
)
1810 udev
->speed
= USB_SPEED_HIGH
;
1811 else if (portstatus
& USB_PORT_STAT_LOW_SPEED
)
1812 udev
->speed
= USB_SPEED_LOW
;
1814 udev
->speed
= USB_SPEED_FULL
;
1818 /* switch to the long delay after two short delay failures */
1819 if (delay_time
>= 2 * HUB_SHORT_RESET_TIME
)
1820 delay
= HUB_LONG_RESET_TIME
;
1822 dev_dbg (hub
->intfdev
,
1823 "port %d not reset yet, waiting %dms\n",
1830 static int hub_port_reset(struct usb_hub
*hub
, int port1
,
1831 struct usb_device
*udev
, unsigned int delay
)
1836 ** add a little delay which seems to reduce the famous root-hub crash
1837 ** on nao-geode board.
1838 ** 10ms should be enough
1843 /* Block EHCI CF initialization during the port reset.
1844 * Some companion controllers don't like it when they mix.
1846 down_read(&ehci_cf_port_reset_rwsem
);
1848 /* Reset the port */
1849 for (i
= 0; i
< PORT_RESET_TRIES
; i
++) {
1850 status
= set_port_feature(hub
->hdev
,
1851 port1
, USB_PORT_FEAT_RESET
);
1853 dev_err(hub
->intfdev
,
1854 "cannot reset port %d (err = %d)\n",
1857 status
= hub_port_wait_reset(hub
, port1
, udev
, delay
);
1858 if (status
&& status
!= -ENOTCONN
)
1859 dev_dbg(hub
->intfdev
,
1860 "port_wait_reset: err = %d\n",
1864 /* return on disconnect or reset */
1867 /* TRSTRCY = 10 ms; plus some extra */
1869 update_address(udev
, 0);
1873 clear_port_feature(hub
->hdev
,
1874 port1
, USB_PORT_FEAT_C_RESET
);
1875 /* FIXME need disconnect() for NOTATTACHED device */
1876 usb_set_device_state(udev
, status
1877 ? USB_STATE_NOTATTACHED
1878 : USB_STATE_DEFAULT
);
1882 dev_dbg (hub
->intfdev
,
1883 "port %d not enabled, trying reset again...\n",
1885 delay
= HUB_LONG_RESET_TIME
;
1888 panic("fatal error while resetting USB port.The system will die...\n");
1890 dev_err (hub
->intfdev
,
1891 "Cannot enable port %i. Maybe the USB cable is bad?\n",
1895 up_read(&ehci_cf_port_reset_rwsem
);
1901 #define MASK_BITS (USB_PORT_STAT_POWER | USB_PORT_STAT_CONNECTION | \
1902 USB_PORT_STAT_SUSPEND)
1903 #define WANT_BITS (USB_PORT_STAT_POWER | USB_PORT_STAT_CONNECTION)
1905 /* Determine whether the device on a port is ready for a normal resume,
1906 * is ready for a reset-resume, or should be disconnected.
1908 static int check_port_resume_type(struct usb_device
*udev
,
1909 struct usb_hub
*hub
, int port1
,
1910 int status
, unsigned portchange
, unsigned portstatus
)
1912 /* Is the device still present? */
1913 if (status
|| (portstatus
& MASK_BITS
) != WANT_BITS
) {
1918 /* Can't do a normal resume if the port isn't enabled,
1919 * so try a reset-resume instead.
1921 else if (!(portstatus
& USB_PORT_STAT_ENABLE
) && !udev
->reset_resume
) {
1922 if (udev
->persist_enabled
)
1923 udev
->reset_resume
= 1;
1929 dev_dbg(hub
->intfdev
,
1930 "port %d status %04x.%04x after resume, %d\n",
1931 port1
, portchange
, portstatus
, status
);
1932 } else if (udev
->reset_resume
) {
1934 /* Late port handoff can set status-change bits */
1935 if (portchange
& USB_PORT_STAT_C_CONNECTION
)
1936 clear_port_feature(hub
->hdev
, port1
,
1937 USB_PORT_FEAT_C_CONNECTION
);
1938 if (portchange
& USB_PORT_STAT_C_ENABLE
)
1939 clear_port_feature(hub
->hdev
, port1
,
1940 USB_PORT_FEAT_C_ENABLE
);
1946 #ifdef CONFIG_USB_SUSPEND
1949 * usb_port_suspend - suspend a usb device's upstream port
1950 * @udev: device that's no longer in active use, not a root hub
1951 * Context: must be able to sleep; device not locked; pm locks held
1953 * Suspends a USB device that isn't in active use, conserving power.
1954 * Devices may wake out of a suspend, if anything important happens,
1955 * using the remote wakeup mechanism. They may also be taken out of
1956 * suspend by the host, using usb_port_resume(). It's also routine
1957 * to disconnect devices while they are suspended.
1959 * This only affects the USB hardware for a device; its interfaces
1960 * (and, for hubs, child devices) must already have been suspended.
1962 * Selective port suspend reduces power; most suspended devices draw
1963 * less than 500 uA. It's also used in OTG, along with remote wakeup.
1964 * All devices below the suspended port are also suspended.
1966 * Devices leave suspend state when the host wakes them up. Some devices
1967 * also support "remote wakeup", where the device can activate the USB
1968 * tree above them to deliver data, such as a keypress or packet. In
1969 * some cases, this wakes the USB host.
1971 * Suspending OTG devices may trigger HNP, if that's been enabled
1972 * between a pair of dual-role devices. That will change roles, such
1973 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
1975 * Devices on USB hub ports have only one "suspend" state, corresponding
1976 * to ACPI D2, "may cause the device to lose some context".
1977 * State transitions include:
1979 * - suspend, resume ... when the VBUS power link stays live
1980 * - suspend, disconnect ... VBUS lost
1982 * Once VBUS drop breaks the circuit, the port it's using has to go through
1983 * normal re-enumeration procedures, starting with enabling VBUS power.
1984 * Other than re-initializing the hub (plug/unplug, except for root hubs),
1985 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
1986 * timer, no SRP, no requests through sysfs.
1988 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
1989 * the root hub for their bus goes into global suspend ... so we don't
1990 * (falsely) update the device power state to say it suspended.
1992 * Returns 0 on success, else negative errno.
1994 int usb_port_suspend(struct usb_device
*udev
, pm_message_t msg
)
1996 struct usb_hub
*hub
= hdev_to_hub(udev
->parent
);
1997 int port1
= udev
->portnum
;
2000 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
2002 /* enable remote wakeup when appropriate; this lets the device
2003 * wake up the upstream hub (including maybe the root hub).
2005 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2006 * we don't explicitly enable it here.
2008 if (udev
->do_remote_wakeup
) {
2009 status
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2010 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
2011 USB_DEVICE_REMOTE_WAKEUP
, 0,
2013 USB_CTRL_SET_TIMEOUT
);
2015 dev_dbg(&udev
->dev
, "won't remote wakeup, status %d\n",
2020 status
= set_port_feature(hub
->hdev
, port1
, USB_PORT_FEAT_SUSPEND
);
2022 dev_dbg(hub
->intfdev
, "can't suspend port %d, status %d\n",
2024 /* paranoia: "should not happen" */
2025 (void) usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2026 USB_REQ_CLEAR_FEATURE
, USB_RECIP_DEVICE
,
2027 USB_DEVICE_REMOTE_WAKEUP
, 0,
2029 USB_CTRL_SET_TIMEOUT
);
2031 /* device has up to 10 msec to fully suspend */
2032 dev_dbg(&udev
->dev
, "usb %ssuspend\n",
2033 (msg
.event
& PM_EVENT_AUTO
? "auto-" : ""));
2034 usb_set_device_state(udev
, USB_STATE_SUSPENDED
);
2041 * If the USB "suspend" state is in use (rather than "global suspend"),
2042 * many devices will be individually taken out of suspend state using
2043 * special "resume" signaling. This routine kicks in shortly after
2044 * hardware resume signaling is finished, either because of selective
2045 * resume (by host) or remote wakeup (by device) ... now see what changed
2046 * in the tree that's rooted at this device.
2048 * If @udev->reset_resume is set then the device is reset before the
2049 * status check is done.
2051 static int finish_port_resume(struct usb_device
*udev
)
2056 /* caller owns the udev device lock */
2057 dev_dbg(&udev
->dev
, "%s\n",
2058 udev
->reset_resume
? "finish reset-resume" : "finish resume");
2060 /* usb ch9 identifies four variants of SUSPENDED, based on what
2061 * state the device resumes to. Linux currently won't see the
2062 * first two on the host side; they'd be inside hub_port_init()
2063 * during many timeouts, but khubd can't suspend until later.
2065 usb_set_device_state(udev
, udev
->actconfig
2066 ? USB_STATE_CONFIGURED
2067 : USB_STATE_ADDRESS
);
2069 /* 10.5.4.5 says not to reset a suspended port if the attached
2070 * device is enabled for remote wakeup. Hence the reset
2071 * operation is carried out here, after the port has been
2074 if (udev
->reset_resume
)
2076 status
= usb_reset_and_verify_device(udev
);
2078 /* 10.5.4.5 says be sure devices in the tree are still there.
2079 * For now let's assume the device didn't go crazy on resume,
2080 * and device drivers will know about any resume quirks.
2084 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0, &devstatus
);
2086 status
= (status
> 0 ? 0 : -ENODEV
);
2088 /* If a normal resume failed, try doing a reset-resume */
2089 if (status
&& !udev
->reset_resume
&& udev
->persist_enabled
) {
2090 dev_dbg(&udev
->dev
, "retry with reset-resume\n");
2091 udev
->reset_resume
= 1;
2092 goto retry_reset_resume
;
2097 dev_dbg(&udev
->dev
, "gone after usb resume? status %d\n",
2099 } else if (udev
->actconfig
) {
2100 le16_to_cpus(&devstatus
);
2101 if (devstatus
& (1 << USB_DEVICE_REMOTE_WAKEUP
)) {
2102 status
= usb_control_msg(udev
,
2103 usb_sndctrlpipe(udev
, 0),
2104 USB_REQ_CLEAR_FEATURE
,
2106 USB_DEVICE_REMOTE_WAKEUP
, 0,
2108 USB_CTRL_SET_TIMEOUT
);
2111 "disable remote wakeup, status %d\n",
2120 * usb_port_resume - re-activate a suspended usb device's upstream port
2121 * @udev: device to re-activate, not a root hub
2122 * Context: must be able to sleep; device not locked; pm locks held
2124 * This will re-activate the suspended device, increasing power usage
2125 * while letting drivers communicate again with its endpoints.
2126 * USB resume explicitly guarantees that the power session between
2127 * the host and the device is the same as it was when the device
2130 * If @udev->reset_resume is set then this routine won't check that the
2131 * port is still enabled. Furthermore, finish_port_resume() above will
2132 * reset @udev. The end result is that a broken power session can be
2133 * recovered and @udev will appear to persist across a loss of VBUS power.
2135 * For example, if a host controller doesn't maintain VBUS suspend current
2136 * during a system sleep or is reset when the system wakes up, all the USB
2137 * power sessions below it will be broken. This is especially troublesome
2138 * for mass-storage devices containing mounted filesystems, since the
2139 * device will appear to have disconnected and all the memory mappings
2140 * to it will be lost. Using the USB_PERSIST facility, the device can be
2141 * made to appear as if it had not disconnected.
2143 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
2144 * every effort to insure that the same device is present after the
2145 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
2146 * quite possible for a device to remain unaltered but its media to be
2147 * changed. If the user replaces a flash memory card while the system is
2148 * asleep, he will have only himself to blame when the filesystem on the
2149 * new card is corrupted and the system crashes.
2151 * Returns 0 on success, else negative errno.
2153 int usb_port_resume(struct usb_device
*udev
, pm_message_t msg
)
2155 struct usb_hub
*hub
= hdev_to_hub(udev
->parent
);
2156 int port1
= udev
->portnum
;
2158 u16 portchange
, portstatus
;
2160 /* Skip the initial Clear-Suspend step for a remote wakeup */
2161 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
2162 if (status
== 0 && !(portstatus
& USB_PORT_STAT_SUSPEND
))
2163 goto SuspendCleared
;
2165 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
2167 set_bit(port1
, hub
->busy_bits
);
2169 /* see 7.1.7.7; affects power usage, but not budgeting */
2170 status
= clear_port_feature(hub
->hdev
,
2171 port1
, USB_PORT_FEAT_SUSPEND
);
2173 dev_dbg(hub
->intfdev
, "can't resume port %d, status %d\n",
2176 /* drive resume for at least 20 msec */
2177 dev_dbg(&udev
->dev
, "usb %sresume\n",
2178 (msg
.event
& PM_EVENT_AUTO
? "auto-" : ""));
2181 /* Virtual root hubs can trigger on GET_PORT_STATUS to
2182 * stop resume signaling. Then finish the resume
2185 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
2187 /* TRSMRCY = 10 msec */
2193 if (portchange
& USB_PORT_STAT_C_SUSPEND
)
2194 clear_port_feature(hub
->hdev
, port1
,
2195 USB_PORT_FEAT_C_SUSPEND
);
2198 clear_bit(port1
, hub
->busy_bits
);
2200 status
= check_port_resume_type(udev
,
2201 hub
, port1
, status
, portchange
, portstatus
);
2203 status
= finish_port_resume(udev
);
2205 dev_dbg(&udev
->dev
, "can't resume, status %d\n", status
);
2206 hub_port_logical_disconnect(hub
, port1
);
2211 /* caller has locked udev */
2212 static int remote_wakeup(struct usb_device
*udev
)
2216 if (udev
->state
== USB_STATE_SUSPENDED
) {
2217 dev_dbg(&udev
->dev
, "usb %sresume\n", "wakeup-");
2218 usb_mark_last_busy(udev
);
2219 status
= usb_external_resume_device(udev
, PMSG_REMOTE_RESUME
);
2224 #else /* CONFIG_USB_SUSPEND */
2226 /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
2228 int usb_port_suspend(struct usb_device
*udev
, pm_message_t msg
)
2233 /* However we may need to do a reset-resume */
2235 int usb_port_resume(struct usb_device
*udev
, pm_message_t msg
)
2237 struct usb_hub
*hub
= hdev_to_hub(udev
->parent
);
2238 int port1
= udev
->portnum
;
2240 u16 portchange
, portstatus
;
2242 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
2243 status
= check_port_resume_type(udev
,
2244 hub
, port1
, status
, portchange
, portstatus
);
2247 dev_dbg(&udev
->dev
, "can't resume, status %d\n", status
);
2248 hub_port_logical_disconnect(hub
, port1
);
2249 } else if (udev
->reset_resume
) {
2250 dev_dbg(&udev
->dev
, "reset-resume\n");
2251 status
= usb_reset_and_verify_device(udev
);
2256 static inline int remote_wakeup(struct usb_device
*udev
)
2263 static int hub_suspend(struct usb_interface
*intf
, pm_message_t msg
)
2265 struct usb_hub
*hub
= usb_get_intfdata (intf
);
2266 struct usb_device
*hdev
= hub
->hdev
;
2269 /* fail if children aren't already suspended */
2270 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
2271 struct usb_device
*udev
;
2273 udev
= hdev
->children
[port1
-1];
2274 if (udev
&& udev
->can_submit
) {
2275 if (!(msg
.event
& PM_EVENT_AUTO
))
2276 dev_dbg(&intf
->dev
, "port %d nyet suspended\n",
2282 dev_dbg(&intf
->dev
, "%s\n", __func__
);
2284 /* stop khubd and related activity */
2285 hub_quiesce(hub
, HUB_SUSPEND
);
2289 static int hub_resume(struct usb_interface
*intf
)
2291 struct usb_hub
*hub
= usb_get_intfdata(intf
);
2293 dev_dbg(&intf
->dev
, "%s\n", __func__
);
2294 hub_activate(hub
, HUB_RESUME
);
2298 static int hub_reset_resume(struct usb_interface
*intf
)
2300 struct usb_hub
*hub
= usb_get_intfdata(intf
);
2302 dev_dbg(&intf
->dev
, "%s\n", __func__
);
2303 hub_activate(hub
, HUB_RESET_RESUME
);
2308 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
2309 * @rhdev: struct usb_device for the root hub
2311 * The USB host controller driver calls this function when its root hub
2312 * is resumed and Vbus power has been interrupted or the controller
2313 * has been reset. The routine marks @rhdev as having lost power.
2314 * When the hub driver is resumed it will take notice and carry out
2315 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
2316 * the others will be disconnected.
2318 void usb_root_hub_lost_power(struct usb_device
*rhdev
)
2320 dev_warn(&rhdev
->dev
, "root hub lost power or was reset\n");
2321 rhdev
->reset_resume
= 1;
2323 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power
);
2325 #else /* CONFIG_PM */
2327 static inline int remote_wakeup(struct usb_device
*udev
)
2332 #define hub_suspend NULL
2333 #define hub_resume NULL
2334 #define hub_reset_resume NULL
2338 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2340 * Between connect detection and reset signaling there must be a delay
2341 * of 100ms at least for debounce and power-settling. The corresponding
2342 * timer shall restart whenever the downstream port detects a disconnect.
2344 * Apparently there are some bluetooth and irda-dongles and a number of
2345 * low-speed devices for which this debounce period may last over a second.
2346 * Not covered by the spec - but easy to deal with.
2348 * This implementation uses a 1500ms total debounce timeout; if the
2349 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2350 * every 25ms for transient disconnects. When the port status has been
2351 * unchanged for 100ms it returns the port status.
2353 static int hub_port_debounce(struct usb_hub
*hub
, int port1
)
2356 int total_time
, stable_time
= 0;
2357 u16 portchange
, portstatus
;
2358 unsigned connection
= 0xffff;
2360 for (total_time
= 0; ; total_time
+= HUB_DEBOUNCE_STEP
) {
2361 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
2365 if (!(portchange
& USB_PORT_STAT_C_CONNECTION
) &&
2366 (portstatus
& USB_PORT_STAT_CONNECTION
) == connection
) {
2367 stable_time
+= HUB_DEBOUNCE_STEP
;
2368 if (stable_time
>= HUB_DEBOUNCE_STABLE
)
2372 connection
= portstatus
& USB_PORT_STAT_CONNECTION
;
2375 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
2376 clear_port_feature(hub
->hdev
, port1
,
2377 USB_PORT_FEAT_C_CONNECTION
);
2380 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
2382 msleep(HUB_DEBOUNCE_STEP
);
2385 dev_dbg (hub
->intfdev
,
2386 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2387 port1
, total_time
, stable_time
, portstatus
);
2389 if (stable_time
< HUB_DEBOUNCE_STABLE
)
2394 void usb_ep0_reinit(struct usb_device
*udev
)
2396 usb_disable_endpoint(udev
, 0 + USB_DIR_IN
, true);
2397 usb_disable_endpoint(udev
, 0 + USB_DIR_OUT
, true);
2398 usb_enable_endpoint(udev
, &udev
->ep0
, true);
2400 EXPORT_SYMBOL_GPL(usb_ep0_reinit
);
2402 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2403 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2405 static int hub_set_address(struct usb_device
*udev
, int devnum
)
2411 if (udev
->state
== USB_STATE_ADDRESS
)
2413 if (udev
->state
!= USB_STATE_DEFAULT
)
2415 retval
= usb_control_msg(udev
, usb_sndaddr0pipe(),
2416 USB_REQ_SET_ADDRESS
, 0, devnum
, 0,
2417 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
2419 /* Device now using proper address. */
2420 update_address(udev
, devnum
);
2421 usb_set_device_state(udev
, USB_STATE_ADDRESS
);
2422 usb_ep0_reinit(udev
);
2427 /* Reset device, (re)assign address, get device descriptor.
2428 * Device connection must be stable, no more debouncing needed.
2429 * Returns device in USB_STATE_ADDRESS, except on error.
2431 * If this is called for an already-existing device (as part of
2432 * usb_reset_and_verify_device), the caller must own the device lock. For a
2433 * newly detected device that is not accessible through any global
2434 * pointers, it's not necessary to lock the device.
2437 hub_port_init (struct usb_hub
*hub
, struct usb_device
*udev
, int port1
,
2440 static DEFINE_MUTEX(usb_address0_mutex
);
2442 struct usb_device
*hdev
= hub
->hdev
;
2444 unsigned delay
= HUB_SHORT_RESET_TIME
;
2445 enum usb_device_speed oldspeed
= udev
->speed
;
2447 int devnum
= udev
->devnum
;
2449 /* root hub ports have a slightly longer reset period
2450 * (from USB 2.0 spec, section 7.1.7.5)
2452 if (!hdev
->parent
) {
2453 delay
= HUB_ROOT_RESET_TIME
;
2454 if (port1
== hdev
->bus
->otg_port
)
2455 hdev
->bus
->b_hnp_enable
= 0;
2458 /* Some low speed devices have problems with the quick delay, so */
2459 /* be a bit pessimistic with those devices. RHbug #23670 */
2460 if (oldspeed
== USB_SPEED_LOW
)
2461 delay
= HUB_LONG_RESET_TIME
;
2463 mutex_lock(&usb_address0_mutex
);
2465 /* Reset the device; full speed may morph to high speed */
2466 retval
= hub_port_reset(hub
, port1
, udev
, delay
);
2467 if (retval
< 0) /* error or disconnect */
2469 /* success, speed is known */
2472 if (oldspeed
!= USB_SPEED_UNKNOWN
&& oldspeed
!= udev
->speed
) {
2473 dev_dbg(&udev
->dev
, "device reset changed speed!\n");
2476 oldspeed
= udev
->speed
;
2478 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2479 * it's fixed size except for full speed devices.
2480 * For Wireless USB devices, ep0 max packet is always 512 (tho
2481 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
2483 switch (udev
->speed
) {
2484 case USB_SPEED_VARIABLE
: /* fixed at 512 */
2485 udev
->ep0
.desc
.wMaxPacketSize
= __constant_cpu_to_le16(512);
2487 case USB_SPEED_HIGH
: /* fixed at 64 */
2488 udev
->ep0
.desc
.wMaxPacketSize
= __constant_cpu_to_le16(64);
2490 case USB_SPEED_FULL
: /* 8, 16, 32, or 64 */
2491 /* to determine the ep0 maxpacket size, try to read
2492 * the device descriptor to get bMaxPacketSize0 and
2493 * then correct our initial guess.
2495 udev
->ep0
.desc
.wMaxPacketSize
= __constant_cpu_to_le16(64);
2497 case USB_SPEED_LOW
: /* fixed at 8 */
2498 udev
->ep0
.desc
.wMaxPacketSize
= __constant_cpu_to_le16(8);
2505 switch (udev
->speed
) {
2506 case USB_SPEED_LOW
: speed
= "low"; break;
2507 case USB_SPEED_FULL
: speed
= "full"; break;
2508 case USB_SPEED_HIGH
: speed
= "high"; break;
2509 case USB_SPEED_VARIABLE
:
2513 default: speed
= "?"; break;
2515 dev_info (&udev
->dev
,
2516 "%s %s speed %sUSB device using %s and address %d\n",
2517 (udev
->config
) ? "reset" : "new", speed
, type
,
2518 udev
->bus
->controller
->driver
->name
, devnum
);
2520 /* Set up TT records, if needed */
2522 udev
->tt
= hdev
->tt
;
2523 udev
->ttport
= hdev
->ttport
;
2524 } else if (udev
->speed
!= USB_SPEED_HIGH
2525 && hdev
->speed
== USB_SPEED_HIGH
) {
2526 udev
->tt
= &hub
->tt
;
2527 udev
->ttport
= port1
;
2530 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2531 * Because device hardware and firmware is sometimes buggy in
2532 * this area, and this is how Linux has done it for ages.
2533 * Change it cautiously.
2535 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2536 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2537 * so it may help with some non-standards-compliant devices.
2538 * Otherwise we start with SET_ADDRESS and then try to read the
2539 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2542 for (i
= 0; i
< GET_DESCRIPTOR_TRIES
; (++i
, msleep(100))) {
2543 if (USE_NEW_SCHEME(retry_counter
)) {
2544 struct usb_device_descriptor
*buf
;
2547 #define GET_DESCRIPTOR_BUFSIZE 64
2548 buf
= kmalloc(GET_DESCRIPTOR_BUFSIZE
, GFP_NOIO
);
2554 /* Retry on all errors; some devices are flakey.
2555 * 255 is for WUSB devices, we actually need to use
2556 * 512 (WUSB1.0[4.8.1]).
2558 for (j
= 0; j
< 3; ++j
) {
2559 buf
->bMaxPacketSize0
= 0;
2560 r
= usb_control_msg(udev
, usb_rcvaddr0pipe(),
2561 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
,
2562 USB_DT_DEVICE
<< 8, 0,
2563 buf
, GET_DESCRIPTOR_BUFSIZE
,
2564 initial_descriptor_timeout
);
2565 switch (buf
->bMaxPacketSize0
) {
2566 case 8: case 16: case 32: case 64: case 255:
2567 if (buf
->bDescriptorType
==
2581 udev
->descriptor
.bMaxPacketSize0
=
2582 buf
->bMaxPacketSize0
;
2585 retval
= hub_port_reset(hub
, port1
, udev
, delay
);
2586 if (retval
< 0) /* error or disconnect */
2588 if (oldspeed
!= udev
->speed
) {
2590 "device reset changed speed!\n");
2596 "device descriptor read/64, error %d\n",
2601 #undef GET_DESCRIPTOR_BUFSIZE
2605 * If device is WUSB, we already assigned an
2606 * unauthorized address in the Connect Ack sequence;
2607 * authorization will assign the final address.
2609 if (udev
->wusb
== 0) {
2610 for (j
= 0; j
< SET_ADDRESS_TRIES
; ++j
) {
2611 retval
= hub_set_address(udev
, devnum
);
2618 "device not accepting address %d, error %d\n",
2623 /* cope with hardware quirkiness:
2624 * - let SET_ADDRESS settle, some device hardware wants it
2625 * - read ep0 maxpacket even for high and low speed,
2628 if (USE_NEW_SCHEME(retry_counter
))
2632 retval
= usb_get_device_descriptor(udev
, 8);
2635 "device descriptor read/8, error %d\n",
2647 i
= udev
->descriptor
.bMaxPacketSize0
== 0xff? /* wusb device? */
2648 512 : udev
->descriptor
.bMaxPacketSize0
;
2649 if (le16_to_cpu(udev
->ep0
.desc
.wMaxPacketSize
) != i
) {
2650 if (udev
->speed
!= USB_SPEED_FULL
||
2651 !(i
== 8 || i
== 16 || i
== 32 || i
== 64)) {
2652 dev_err(&udev
->dev
, "ep0 maxpacket = %d\n", i
);
2656 dev_dbg(&udev
->dev
, "ep0 maxpacket = %d\n", i
);
2657 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(i
);
2658 usb_ep0_reinit(udev
);
2661 retval
= usb_get_device_descriptor(udev
, USB_DT_DEVICE_SIZE
);
2662 if (retval
< (signed)sizeof(udev
->descriptor
)) {
2663 dev_err(&udev
->dev
, "device descriptor read/all, error %d\n",
2674 hub_port_disable(hub
, port1
, 0);
2675 update_address(udev
, devnum
); /* for disconnect processing */
2677 mutex_unlock(&usb_address0_mutex
);
2682 check_highspeed (struct usb_hub
*hub
, struct usb_device
*udev
, int port1
)
2684 struct usb_qualifier_descriptor
*qual
;
2687 qual
= kmalloc (sizeof *qual
, GFP_KERNEL
);
2691 status
= usb_get_descriptor (udev
, USB_DT_DEVICE_QUALIFIER
, 0,
2692 qual
, sizeof *qual
);
2693 if (status
== sizeof *qual
) {
2694 dev_info(&udev
->dev
, "not running at top speed; "
2695 "connect to a high speed hub\n");
2696 /* hub LEDs are probably harder to miss than syslog */
2697 if (hub
->has_indicators
) {
2698 hub
->indicator
[port1
-1] = INDICATOR_GREEN_BLINK
;
2699 schedule_delayed_work (&hub
->leds
, 0);
2706 hub_power_remaining (struct usb_hub
*hub
)
2708 struct usb_device
*hdev
= hub
->hdev
;
2712 if (!hub
->limited_power
)
2715 remaining
= hdev
->bus_mA
- hub
->descriptor
->bHubContrCurrent
;
2716 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
2717 struct usb_device
*udev
= hdev
->children
[port1
- 1];
2723 /* Unconfigured devices may not use more than 100mA,
2724 * or 8mA for OTG ports */
2725 if (udev
->actconfig
)
2726 delta
= udev
->actconfig
->desc
.bMaxPower
* 2;
2727 else if (port1
!= udev
->bus
->otg_port
|| hdev
->parent
)
2731 if (delta
> hub
->mA_per_port
)
2732 dev_warn(&udev
->dev
,
2733 "%dmA is over %umA budget for port %d!\n",
2734 delta
, hub
->mA_per_port
, port1
);
2737 if (remaining
< 0) {
2738 dev_warn(hub
->intfdev
, "%dmA over power budget!\n",
2745 /* Handle physical or logical connection change events.
2746 * This routine is called when:
2747 * a port connection-change occurs;
2748 * a port enable-change occurs (often caused by EMI);
2749 * usb_reset_and_verify_device() encounters changed descriptors (as from
2750 * a firmware download)
2751 * caller already locked the hub
2753 static void hub_port_connect_change(struct usb_hub
*hub
, int port1
,
2754 u16 portstatus
, u16 portchange
)
2756 struct usb_device
*hdev
= hub
->hdev
;
2757 struct device
*hub_dev
= hub
->intfdev
;
2758 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
2759 unsigned wHubCharacteristics
=
2760 le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
2761 struct usb_device
*udev
;
2765 "port %d, status %04x, change %04x, %s\n",
2766 port1
, portstatus
, portchange
, portspeed (portstatus
));
2768 if (hub
->has_indicators
) {
2769 set_port_led(hub
, port1
, HUB_LED_AUTO
);
2770 hub
->indicator
[port1
-1] = INDICATOR_AUTO
;
2773 #ifdef CONFIG_USB_OTG
2774 /* during HNP, don't repeat the debounce */
2775 if (hdev
->bus
->is_b_host
)
2776 portchange
&= ~(USB_PORT_STAT_C_CONNECTION
|
2777 USB_PORT_STAT_C_ENABLE
);
2780 /* Try to resuscitate an existing device */
2781 udev
= hdev
->children
[port1
-1];
2782 if ((portstatus
& USB_PORT_STAT_CONNECTION
) && udev
&&
2783 udev
->state
!= USB_STATE_NOTATTACHED
) {
2784 usb_lock_device(udev
);
2785 if (portstatus
& USB_PORT_STAT_ENABLE
) {
2786 status
= 0; /* Nothing to do */
2788 #ifdef CONFIG_USB_SUSPEND
2789 } else if (udev
->state
== USB_STATE_SUSPENDED
&&
2790 udev
->persist_enabled
) {
2791 /* For a suspended device, treat this as a
2792 * remote wakeup event.
2794 if (udev
->do_remote_wakeup
)
2795 status
= remote_wakeup(udev
);
2797 /* Otherwise leave it be; devices can't tell the
2798 * difference between suspended and disabled.
2805 status
= -ENODEV
; /* Don't resuscitate */
2807 usb_unlock_device(udev
);
2810 clear_bit(port1
, hub
->change_bits
);
2815 /* Disconnect any existing devices under this port */
2817 usb_disconnect(&hdev
->children
[port1
-1]);
2818 clear_bit(port1
, hub
->change_bits
);
2820 if (portchange
& (USB_PORT_STAT_C_CONNECTION
|
2821 USB_PORT_STAT_C_ENABLE
)) {
2822 status
= hub_port_debounce(hub
, port1
);
2824 if (printk_ratelimit())
2825 dev_err(hub_dev
, "connect-debounce failed, "
2826 "port %d disabled\n", port1
);
2827 portstatus
&= ~USB_PORT_STAT_CONNECTION
;
2829 portstatus
= status
;
2833 /* Return now if debouncing failed or nothing is connected */
2834 if (!(portstatus
& USB_PORT_STAT_CONNECTION
)) {
2836 /* maybe switch power back on (e.g. root hub was reset) */
2837 if ((wHubCharacteristics
& HUB_CHAR_LPSM
) < 2
2838 && !(portstatus
& (1 << USB_PORT_FEAT_POWER
)))
2839 set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
2841 if (portstatus
& USB_PORT_STAT_ENABLE
)
2846 for (i
= 0; i
< SET_CONFIG_TRIES
; i
++) {
2848 /* reallocate for each attempt, since references
2849 * to the previous one can escape in various ways
2851 udev
= usb_alloc_dev(hdev
, hdev
->bus
, port1
);
2854 "couldn't allocate port %d usb_device\n",
2859 usb_set_device_state(udev
, USB_STATE_POWERED
);
2860 udev
->speed
= USB_SPEED_UNKNOWN
;
2861 udev
->bus_mA
= hub
->mA_per_port
;
2862 udev
->level
= hdev
->level
+ 1;
2863 udev
->wusb
= hub_is_wusb(hub
);
2865 /* set the address */
2866 choose_address(udev
);
2867 if (udev
->devnum
<= 0) {
2868 status
= -ENOTCONN
; /* Don't retry */
2872 /* reset and get descriptor */
2873 status
= hub_port_init(hub
, udev
, port1
, i
);
2877 /* consecutive bus-powered hubs aren't reliable; they can
2878 * violate the voltage drop budget. if the new child has
2879 * a "powered" LED, users should notice we didn't enable it
2880 * (without reading syslog), even without per-port LEDs
2883 if (udev
->descriptor
.bDeviceClass
== USB_CLASS_HUB
2884 && udev
->bus_mA
<= 100) {
2887 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0,
2890 dev_dbg(&udev
->dev
, "get status %d ?\n", status
);
2893 le16_to_cpus(&devstat
);
2894 if ((devstat
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
2896 "can't connect bus-powered hub "
2898 if (hub
->has_indicators
) {
2899 hub
->indicator
[port1
-1] =
2900 INDICATOR_AMBER_BLINK
;
2901 schedule_delayed_work (&hub
->leds
, 0);
2903 status
= -ENOTCONN
; /* Don't retry */
2908 /* check for devices running slower than they could */
2909 if (le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0200
2910 && udev
->speed
== USB_SPEED_FULL
2911 && highspeed_hubs
!= 0)
2912 check_highspeed (hub
, udev
, port1
);
2914 /* Store the parent's children[] pointer. At this point
2915 * udev becomes globally accessible, although presumably
2916 * no one will look at it until hdev is unlocked.
2920 /* We mustn't add new devices if the parent hub has
2921 * been disconnected; we would race with the
2922 * recursively_mark_NOTATTACHED() routine.
2924 spin_lock_irq(&device_state_lock
);
2925 if (hdev
->state
== USB_STATE_NOTATTACHED
)
2928 hdev
->children
[port1
-1] = udev
;
2929 spin_unlock_irq(&device_state_lock
);
2931 /* Run it through the hoops (find a driver, etc) */
2933 status
= usb_new_device(udev
);
2935 spin_lock_irq(&device_state_lock
);
2936 hdev
->children
[port1
-1] = NULL
;
2937 spin_unlock_irq(&device_state_lock
);
2944 status
= hub_power_remaining(hub
);
2946 dev_dbg(hub_dev
, "%dmA power budget left\n", status
);
2951 hub_port_disable(hub
, port1
, 1);
2953 usb_ep0_reinit(udev
);
2954 release_address(udev
);
2956 if ((status
== -ENOTCONN
) || (status
== -ENOTSUPP
))
2959 if (hub
->hdev
->parent
||
2960 !hcd
->driver
->port_handed_over
||
2961 !(hcd
->driver
->port_handed_over
)(hcd
, port1
))
2962 dev_err(hub_dev
, "unable to enumerate USB device on port %d\n",
2966 hub_port_disable(hub
, port1
, 1);
2967 if (hcd
->driver
->relinquish_port
&& !hub
->hdev
->parent
)
2968 hcd
->driver
->relinquish_port(hcd
, port1
);
2971 static void hub_events(void)
2973 struct list_head
*tmp
;
2974 struct usb_device
*hdev
;
2975 struct usb_interface
*intf
;
2976 struct usb_hub
*hub
;
2977 struct device
*hub_dev
;
2986 * We restart the list every time to avoid a deadlock with
2987 * deleting hubs downstream from this one. This should be
2988 * safe since we delete the hub from the event list.
2989 * Not the most efficient, but avoids deadlocks.
2993 /* Grab the first entry at the beginning of the list */
2994 spin_lock_irq(&hub_event_lock
);
2995 if (list_empty(&hub_event_list
)) {
2996 spin_unlock_irq(&hub_event_lock
);
3000 tmp
= hub_event_list
.next
;
3003 hub
= list_entry(tmp
, struct usb_hub
, event_list
);
3004 kref_get(&hub
->kref
);
3005 spin_unlock_irq(&hub_event_lock
);
3008 hub_dev
= hub
->intfdev
;
3009 intf
= to_usb_interface(hub_dev
);
3010 dev_dbg(hub_dev
, "state %d ports %d chg %04x evt %04x\n",
3011 hdev
->state
, hub
->descriptor
3012 ? hub
->descriptor
->bNbrPorts
3014 /* NOTE: expects max 15 ports... */
3015 (u16
) hub
->change_bits
[0],
3016 (u16
) hub
->event_bits
[0]);
3018 /* Lock the device, then check to see if we were
3019 * disconnected while waiting for the lock to succeed. */
3020 usb_lock_device(hdev
);
3021 if (unlikely(hub
->disconnected
))
3024 /* If the hub has died, clean up after it */
3025 if (hdev
->state
== USB_STATE_NOTATTACHED
) {
3026 hub
->error
= -ENODEV
;
3027 hub_quiesce(hub
, HUB_DISCONNECT
);
3032 ret
= usb_autopm_get_interface(intf
);
3034 dev_dbg(hub_dev
, "Can't autoresume: %d\n", ret
);
3038 /* If this is an inactive hub, do nothing */
3043 dev_dbg (hub_dev
, "resetting for error %d\n",
3046 ret
= usb_reset_device(hdev
);
3049 "error resetting hub: %d\n", ret
);
3057 /* deal with port status changes */
3058 for (i
= 1; i
<= hub
->descriptor
->bNbrPorts
; i
++) {
3059 if (test_bit(i
, hub
->busy_bits
))
3061 connect_change
= test_bit(i
, hub
->change_bits
);
3062 if (!test_and_clear_bit(i
, hub
->event_bits
) &&
3066 ret
= hub_port_status(hub
, i
,
3067 &portstatus
, &portchange
);
3071 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
3072 clear_port_feature(hdev
, i
,
3073 USB_PORT_FEAT_C_CONNECTION
);
3077 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
3078 if (!connect_change
)
3080 "port %d enable change, "
3083 clear_port_feature(hdev
, i
,
3084 USB_PORT_FEAT_C_ENABLE
);
3087 * EM interference sometimes causes badly
3088 * shielded USB devices to be shutdown by
3089 * the hub, this hack enables them again.
3090 * Works at least with mouse driver.
3092 if (!(portstatus
& USB_PORT_STAT_ENABLE
)
3094 && hdev
->children
[i
-1]) {
3097 "disabled by hub (EMI?), "
3104 if (portchange
& USB_PORT_STAT_C_SUSPEND
) {
3105 struct usb_device
*udev
;
3107 clear_port_feature(hdev
, i
,
3108 USB_PORT_FEAT_C_SUSPEND
);
3109 udev
= hdev
->children
[i
-1];
3111 usb_lock_device(udev
);
3112 ret
= remote_wakeup(hdev
->
3114 usb_unlock_device(udev
);
3119 hub_port_disable(hub
, i
, 1);
3122 "resume on port %d, status %d\n",
3126 if (portchange
& USB_PORT_STAT_C_OVERCURRENT
) {
3128 "over-current change on port %d\n",
3130 clear_port_feature(hdev
, i
,
3131 USB_PORT_FEAT_C_OVER_CURRENT
);
3132 hub_power_on(hub
, true);
3135 if (portchange
& USB_PORT_STAT_C_RESET
) {
3137 "reset change on port %d\n",
3139 clear_port_feature(hdev
, i
,
3140 USB_PORT_FEAT_C_RESET
);
3144 hub_port_connect_change(hub
, i
,
3145 portstatus
, portchange
);
3148 /* deal with hub status changes */
3149 if (test_and_clear_bit(0, hub
->event_bits
) == 0)
3151 else if (hub_hub_status(hub
, &hubstatus
, &hubchange
) < 0)
3152 dev_err (hub_dev
, "get_hub_status failed\n");
3154 if (hubchange
& HUB_CHANGE_LOCAL_POWER
) {
3155 dev_dbg (hub_dev
, "power change\n");
3156 clear_hub_feature(hdev
, C_HUB_LOCAL_POWER
);
3157 if (hubstatus
& HUB_STATUS_LOCAL_POWER
)
3158 /* FIXME: Is this always true? */
3159 hub
->limited_power
= 1;
3161 hub
->limited_power
= 0;
3163 if (hubchange
& HUB_CHANGE_OVERCURRENT
) {
3164 dev_dbg (hub_dev
, "overcurrent change\n");
3165 msleep(500); /* Cool down */
3166 clear_hub_feature(hdev
, C_HUB_OVER_CURRENT
);
3167 hub_power_on(hub
, true);
3172 /* Allow autosuspend if we're not going to run again */
3173 if (list_empty(&hub
->event_list
))
3174 usb_autopm_enable(intf
);
3176 usb_unlock_device(hdev
);
3177 kref_put(&hub
->kref
, hub_release
);
3179 } /* end while (1) */
3182 static int hub_thread(void *__unused
)
3184 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
3185 * port handover. Otherwise it might see that a full-speed device
3186 * was gone before the EHCI controller had handed its port over to
3187 * the companion full-speed controller.
3193 wait_event_freezable(khubd_wait
,
3194 !list_empty(&hub_event_list
) ||
3195 kthread_should_stop());
3196 } while (!kthread_should_stop() || !list_empty(&hub_event_list
));
3198 pr_debug("%s: khubd exiting\n", usbcore_name
);
3202 static struct usb_device_id hub_id_table
[] = {
3203 { .match_flags
= USB_DEVICE_ID_MATCH_DEV_CLASS
,
3204 .bDeviceClass
= USB_CLASS_HUB
},
3205 { .match_flags
= USB_DEVICE_ID_MATCH_INT_CLASS
,
3206 .bInterfaceClass
= USB_CLASS_HUB
},
3207 { } /* Terminating entry */
3210 MODULE_DEVICE_TABLE (usb
, hub_id_table
);
3212 static struct usb_driver hub_driver
= {
3215 .disconnect
= hub_disconnect
,
3216 .suspend
= hub_suspend
,
3217 .resume
= hub_resume
,
3218 .reset_resume
= hub_reset_resume
,
3219 .pre_reset
= hub_pre_reset
,
3220 .post_reset
= hub_post_reset
,
3222 .id_table
= hub_id_table
,
3223 .supports_autosuspend
= 1,
3226 int usb_hub_init(void)
3228 if (usb_register(&hub_driver
) < 0) {
3229 printk(KERN_ERR
"%s: can't register hub driver\n",
3234 khubd_task
= kthread_run(hub_thread
, NULL
, "khubd");
3235 if (!IS_ERR(khubd_task
))
3238 /* Fall through if kernel_thread failed */
3239 usb_deregister(&hub_driver
);
3240 printk(KERN_ERR
"%s: can't start khubd\n", usbcore_name
);
3245 void usb_hub_cleanup(void)
3247 kthread_stop(khubd_task
);
3250 * Hub resources are freed for us by usb_deregister. It calls
3251 * usb_driver_purge on every device which in turn calls that
3252 * devices disconnect function if it is using this driver.
3253 * The hub_disconnect function takes care of releasing the
3254 * individual hub resources. -greg
3256 usb_deregister(&hub_driver
);
3257 } /* usb_hub_cleanup() */
3259 static int descriptors_changed(struct usb_device
*udev
,
3260 struct usb_device_descriptor
*old_device_descriptor
)
3264 unsigned serial_len
= 0;
3266 unsigned old_length
;
3270 if (memcmp(&udev
->descriptor
, old_device_descriptor
,
3271 sizeof(*old_device_descriptor
)) != 0)
3274 /* Since the idVendor, idProduct, and bcdDevice values in the
3275 * device descriptor haven't changed, we will assume the
3276 * Manufacturer and Product strings haven't changed either.
3277 * But the SerialNumber string could be different (e.g., a
3278 * different flash card of the same brand).
3281 serial_len
= strlen(udev
->serial
) + 1;
3284 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
3285 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
3286 len
= max(len
, old_length
);
3289 buf
= kmalloc(len
, GFP_NOIO
);
3291 dev_err(&udev
->dev
, "no mem to re-read configs after reset\n");
3292 /* assume the worst */
3295 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
3296 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
3297 length
= usb_get_descriptor(udev
, USB_DT_CONFIG
, index
, buf
,
3299 if (length
!= old_length
) {
3300 dev_dbg(&udev
->dev
, "config index %d, error %d\n",
3305 if (memcmp (buf
, udev
->rawdescriptors
[index
], old_length
)
3307 dev_dbg(&udev
->dev
, "config index %d changed (#%d)\n",
3309 ((struct usb_config_descriptor
*) buf
)->
3310 bConfigurationValue
);
3316 if (!changed
&& serial_len
) {
3317 length
= usb_string(udev
, udev
->descriptor
.iSerialNumber
,
3319 if (length
+ 1 != serial_len
) {
3320 dev_dbg(&udev
->dev
, "serial string error %d\n",
3323 } else if (memcmp(buf
, udev
->serial
, length
) != 0) {
3324 dev_dbg(&udev
->dev
, "serial string changed\n");
3334 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
3335 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3337 * WARNING - don't use this routine to reset a composite device
3338 * (one with multiple interfaces owned by separate drivers)!
3339 * Use usb_reset_device() instead.
3341 * Do a port reset, reassign the device's address, and establish its
3342 * former operating configuration. If the reset fails, or the device's
3343 * descriptors change from their values before the reset, or the original
3344 * configuration and altsettings cannot be restored, a flag will be set
3345 * telling khubd to pretend the device has been disconnected and then
3346 * re-connected. All drivers will be unbound, and the device will be
3347 * re-enumerated and probed all over again.
3349 * Returns 0 if the reset succeeded, -ENODEV if the device has been
3350 * flagged for logical disconnection, or some other negative error code
3351 * if the reset wasn't even attempted.
3353 * The caller must own the device lock. For example, it's safe to use
3354 * this from a driver probe() routine after downloading new firmware.
3355 * For calls that might not occur during probe(), drivers should lock
3356 * the device using usb_lock_device_for_reset().
3358 * Locking exception: This routine may also be called from within an
3359 * autoresume handler. Such usage won't conflict with other tasks
3360 * holding the device lock because these tasks should always call
3361 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
3363 static int usb_reset_and_verify_device(struct usb_device
*udev
)
3365 struct usb_device
*parent_hdev
= udev
->parent
;
3366 struct usb_hub
*parent_hub
;
3367 struct usb_device_descriptor descriptor
= udev
->descriptor
;
3369 int port1
= udev
->portnum
;
3371 if (udev
->state
== USB_STATE_NOTATTACHED
||
3372 udev
->state
== USB_STATE_SUSPENDED
) {
3373 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
3379 /* this requires hcd-specific logic; see OHCI hc_restart() */
3380 dev_dbg(&udev
->dev
, "%s for root hub!\n", __func__
);
3383 parent_hub
= hdev_to_hub(parent_hdev
);
3385 set_bit(port1
, parent_hub
->busy_bits
);
3386 for (i
= 0; i
< SET_CONFIG_TRIES
; ++i
) {
3388 /* ep0 maxpacket size may change; let the HCD know about it.
3389 * Other endpoints will be handled by re-enumeration. */
3390 usb_ep0_reinit(udev
);
3391 ret
= hub_port_init(parent_hub
, udev
, port1
, i
);
3392 if (ret
>= 0 || ret
== -ENOTCONN
|| ret
== -ENODEV
)
3395 clear_bit(port1
, parent_hub
->busy_bits
);
3400 /* Device might have changed firmware (DFU or similar) */
3401 if (descriptors_changed(udev
, &descriptor
)) {
3402 dev_info(&udev
->dev
, "device firmware changed\n");
3403 udev
->descriptor
= descriptor
; /* for disconnect() calls */
3407 if (!udev
->actconfig
)
3410 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3411 USB_REQ_SET_CONFIGURATION
, 0,
3412 udev
->actconfig
->desc
.bConfigurationValue
, 0,
3413 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
3416 "can't restore configuration #%d (error=%d)\n",
3417 udev
->actconfig
->desc
.bConfigurationValue
, ret
);
3420 usb_set_device_state(udev
, USB_STATE_CONFIGURED
);
3422 for (i
= 0; i
< udev
->actconfig
->desc
.bNumInterfaces
; i
++) {
3423 struct usb_interface
*intf
= udev
->actconfig
->interface
[i
];
3424 struct usb_interface_descriptor
*desc
;
3426 /* set_interface resets host side toggle even
3427 * for altsetting zero. the interface may have no driver.
3429 desc
= &intf
->cur_altsetting
->desc
;
3430 ret
= usb_set_interface(udev
, desc
->bInterfaceNumber
,
3431 desc
->bAlternateSetting
);
3433 dev_err(&udev
->dev
, "failed to restore interface %d "
3434 "altsetting %d (error=%d)\n",
3435 desc
->bInterfaceNumber
,
3436 desc
->bAlternateSetting
,
3446 hub_port_logical_disconnect(parent_hub
, port1
);
3451 * usb_reset_device - warn interface drivers and perform a USB port reset
3452 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3454 * Warns all drivers bound to registered interfaces (using their pre_reset
3455 * method), performs the port reset, and then lets the drivers know that
3456 * the reset is over (using their post_reset method).
3458 * Return value is the same as for usb_reset_and_verify_device().
3460 * The caller must own the device lock. For example, it's safe to use
3461 * this from a driver probe() routine after downloading new firmware.
3462 * For calls that might not occur during probe(), drivers should lock
3463 * the device using usb_lock_device_for_reset().
3465 * If an interface is currently being probed or disconnected, we assume
3466 * its driver knows how to handle resets. For all other interfaces,
3467 * if the driver doesn't have pre_reset and post_reset methods then
3468 * we attempt to unbind it and rebind afterward.
3470 int usb_reset_device(struct usb_device
*udev
)
3474 struct usb_host_config
*config
= udev
->actconfig
;
3476 if (udev
->state
== USB_STATE_NOTATTACHED
||
3477 udev
->state
== USB_STATE_SUSPENDED
) {
3478 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
3483 /* Prevent autosuspend during the reset */
3484 usb_autoresume_device(udev
);
3487 for (i
= 0; i
< config
->desc
.bNumInterfaces
; ++i
) {
3488 struct usb_interface
*cintf
= config
->interface
[i
];
3489 struct usb_driver
*drv
;
3492 if (cintf
->dev
.driver
) {
3493 drv
= to_usb_driver(cintf
->dev
.driver
);
3494 if (drv
->pre_reset
&& drv
->post_reset
)
3495 unbind
= (drv
->pre_reset
)(cintf
);
3496 else if (cintf
->condition
==
3497 USB_INTERFACE_BOUND
)
3500 usb_forced_unbind_intf(cintf
);
3505 ret
= usb_reset_and_verify_device(udev
);
3508 for (i
= config
->desc
.bNumInterfaces
- 1; i
>= 0; --i
) {
3509 struct usb_interface
*cintf
= config
->interface
[i
];
3510 struct usb_driver
*drv
;
3511 int rebind
= cintf
->needs_binding
;
3513 if (!rebind
&& cintf
->dev
.driver
) {
3514 drv
= to_usb_driver(cintf
->dev
.driver
);
3515 if (drv
->post_reset
)
3516 rebind
= (drv
->post_reset
)(cintf
);
3517 else if (cintf
->condition
==
3518 USB_INTERFACE_BOUND
)
3521 if (ret
== 0 && rebind
)
3522 usb_rebind_intf(cintf
);
3526 usb_autosuspend_device(udev
);
3529 EXPORT_SYMBOL_GPL(usb_reset_device
);
3533 * usb_queue_reset_device - Reset a USB device from an atomic context
3534 * @iface: USB interface belonging to the device to reset
3536 * This function can be used to reset a USB device from an atomic
3537 * context, where usb_reset_device() won't work (as it blocks).
3539 * Doing a reset via this method is functionally equivalent to calling
3540 * usb_reset_device(), except for the fact that it is delayed to a
3541 * workqueue. This means that any drivers bound to other interfaces
3542 * might be unbound, as well as users from usbfs in user space.
3546 * - Scheduling two resets at the same time from two different drivers
3547 * attached to two different interfaces of the same device is
3548 * possible; depending on how the driver attached to each interface
3549 * handles ->pre_reset(), the second reset might happen or not.
3551 * - If a driver is unbound and it had a pending reset, the reset will
3554 * - This function can be called during .probe() or .disconnect()
3555 * times. On return from .disconnect(), any pending resets will be
3558 * There is no no need to lock/unlock the @reset_ws as schedule_work()
3561 * NOTE: We don't do any reference count tracking because it is not
3562 * needed. The lifecycle of the work_struct is tied to the
3563 * usb_interface. Before destroying the interface we cancel the
3564 * work_struct, so the fact that work_struct is queued and or
3565 * running means the interface (and thus, the device) exist and
3568 void usb_queue_reset_device(struct usb_interface
*iface
)
3570 schedule_work(&iface
->reset_ws
);
3572 EXPORT_SYMBOL_GPL(usb_queue_reset_device
);