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>
26 #include <asm/uaccess.h>
27 #include <asm/byteorder.h>
33 /* if we are in debug mode, always announce new devices */
35 #ifndef CONFIG_USB_ANNOUNCE_NEW_DEVICES
36 #define CONFIG_USB_ANNOUNCE_NEW_DEVICES
41 struct device
*intfdev
; /* the "interface" device */
42 struct usb_device
*hdev
;
44 struct urb
*urb
; /* for interrupt polling pipe */
46 /* buffer for urb ... with extra space in case of babble */
48 dma_addr_t buffer_dma
; /* DMA address for buffer */
50 struct usb_hub_status hub
;
51 struct usb_port_status port
;
52 } *status
; /* buffer for status reports */
53 struct mutex status_mutex
; /* for the status buffer */
55 int error
; /* last reported error */
56 int nerrors
; /* track consecutive errors */
58 struct list_head event_list
; /* hubs w/data or errs ready */
59 unsigned long event_bits
[1]; /* status change bitmask */
60 unsigned long change_bits
[1]; /* ports with logical connect
62 unsigned long busy_bits
[1]; /* ports being reset or
64 #if USB_MAXCHILDREN > 31 /* 8*sizeof(unsigned long) - 1 */
65 #error event_bits[] is too short!
68 struct usb_hub_descriptor
*descriptor
; /* class descriptor */
69 struct usb_tt tt
; /* Transaction Translator */
71 unsigned mA_per_port
; /* current for each child */
73 unsigned limited_power
:1;
75 unsigned disconnected
:1;
77 unsigned has_indicators
:1;
78 u8 indicator
[USB_MAXCHILDREN
];
79 struct delayed_work leds
;
83 /* Protect struct usb_device->state and ->children members
84 * Note: Both are also protected by ->dev.sem, except that ->state can
85 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
86 static DEFINE_SPINLOCK(device_state_lock
);
88 /* khubd's worklist and its lock */
89 static DEFINE_SPINLOCK(hub_event_lock
);
90 static LIST_HEAD(hub_event_list
); /* List of hubs needing servicing */
93 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait
);
95 static struct task_struct
*khubd_task
;
97 /* cycle leds on hubs that aren't blinking for attention */
98 static int blinkenlights
= 0;
99 module_param (blinkenlights
, bool, S_IRUGO
);
100 MODULE_PARM_DESC (blinkenlights
, "true to cycle leds on hubs");
103 * As of 2.6.10 we introduce a new USB device initialization scheme which
104 * closely resembles the way Windows works. Hopefully it will be compatible
105 * with a wider range of devices than the old scheme. However some previously
106 * working devices may start giving rise to "device not accepting address"
107 * errors; if that happens the user can try the old scheme by adjusting the
108 * following module parameters.
110 * For maximum flexibility there are two boolean parameters to control the
111 * hub driver's behavior. On the first initialization attempt, if the
112 * "old_scheme_first" parameter is set then the old scheme will be used,
113 * otherwise the new scheme is used. If that fails and "use_both_schemes"
114 * is set, then the driver will make another attempt, using the other scheme.
116 static int old_scheme_first
= 0;
117 module_param(old_scheme_first
, bool, S_IRUGO
| S_IWUSR
);
118 MODULE_PARM_DESC(old_scheme_first
,
119 "start with the old device initialization scheme");
121 static int use_both_schemes
= 1;
122 module_param(use_both_schemes
, bool, S_IRUGO
| S_IWUSR
);
123 MODULE_PARM_DESC(use_both_schemes
,
124 "try the other device initialization scheme if the "
127 /* Mutual exclusion for EHCI CF initialization. This interferes with
128 * port reset on some companion controllers.
130 DECLARE_RWSEM(ehci_cf_port_reset_rwsem
);
131 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem
);
133 #define HUB_DEBOUNCE_TIMEOUT 1500
134 #define HUB_DEBOUNCE_STEP 25
135 #define HUB_DEBOUNCE_STABLE 100
138 static int usb_reset_and_verify_device(struct usb_device
*udev
);
140 static inline char *portspeed(int portstatus
)
142 if (portstatus
& (1 << USB_PORT_FEAT_HIGHSPEED
))
144 else if (portstatus
& (1 << USB_PORT_FEAT_LOWSPEED
))
150 /* Note that hdev or one of its children must be locked! */
151 static inline struct usb_hub
*hdev_to_hub(struct usb_device
*hdev
)
153 return usb_get_intfdata(hdev
->actconfig
->interface
[0]);
156 /* USB 2.0 spec Section 11.24.4.5 */
157 static int get_hub_descriptor(struct usb_device
*hdev
, void *data
, int size
)
161 for (i
= 0; i
< 3; i
++) {
162 ret
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
163 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
| USB_RT_HUB
,
164 USB_DT_HUB
<< 8, 0, data
, size
,
165 USB_CTRL_GET_TIMEOUT
);
166 if (ret
>= (USB_DT_HUB_NONVAR_SIZE
+ 2))
173 * USB 2.0 spec Section 11.24.2.1
175 static int clear_hub_feature(struct usb_device
*hdev
, int feature
)
177 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
178 USB_REQ_CLEAR_FEATURE
, USB_RT_HUB
, feature
, 0, NULL
, 0, 1000);
182 * USB 2.0 spec Section 11.24.2.2
184 static int clear_port_feature(struct usb_device
*hdev
, int port1
, int feature
)
186 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
187 USB_REQ_CLEAR_FEATURE
, USB_RT_PORT
, feature
, port1
,
192 * USB 2.0 spec Section 11.24.2.13
194 static int set_port_feature(struct usb_device
*hdev
, int port1
, int feature
)
196 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
197 USB_REQ_SET_FEATURE
, USB_RT_PORT
, feature
, port1
,
202 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
203 * for info about using port indicators
205 static void set_port_led(
211 int status
= set_port_feature(hub
->hdev
, (selector
<< 8) | port1
,
212 USB_PORT_FEAT_INDICATOR
);
214 dev_dbg (hub
->intfdev
,
215 "port %d indicator %s status %d\n",
217 ({ char *s
; switch (selector
) {
218 case HUB_LED_AMBER
: s
= "amber"; break;
219 case HUB_LED_GREEN
: s
= "green"; break;
220 case HUB_LED_OFF
: s
= "off"; break;
221 case HUB_LED_AUTO
: s
= "auto"; break;
222 default: s
= "??"; break;
227 #define LED_CYCLE_PERIOD ((2*HZ)/3)
229 static void led_work (struct work_struct
*work
)
231 struct usb_hub
*hub
=
232 container_of(work
, struct usb_hub
, leds
.work
);
233 struct usb_device
*hdev
= hub
->hdev
;
235 unsigned changed
= 0;
238 if (hdev
->state
!= USB_STATE_CONFIGURED
|| hub
->quiescing
)
241 for (i
= 0; i
< hub
->descriptor
->bNbrPorts
; i
++) {
242 unsigned selector
, mode
;
244 /* 30%-50% duty cycle */
246 switch (hub
->indicator
[i
]) {
248 case INDICATOR_CYCLE
:
250 selector
= HUB_LED_AUTO
;
251 mode
= INDICATOR_AUTO
;
253 /* blinking green = sw attention */
254 case INDICATOR_GREEN_BLINK
:
255 selector
= HUB_LED_GREEN
;
256 mode
= INDICATOR_GREEN_BLINK_OFF
;
258 case INDICATOR_GREEN_BLINK_OFF
:
259 selector
= HUB_LED_OFF
;
260 mode
= INDICATOR_GREEN_BLINK
;
262 /* blinking amber = hw attention */
263 case INDICATOR_AMBER_BLINK
:
264 selector
= HUB_LED_AMBER
;
265 mode
= INDICATOR_AMBER_BLINK_OFF
;
267 case INDICATOR_AMBER_BLINK_OFF
:
268 selector
= HUB_LED_OFF
;
269 mode
= INDICATOR_AMBER_BLINK
;
271 /* blink green/amber = reserved */
272 case INDICATOR_ALT_BLINK
:
273 selector
= HUB_LED_GREEN
;
274 mode
= INDICATOR_ALT_BLINK_OFF
;
276 case INDICATOR_ALT_BLINK_OFF
:
277 selector
= HUB_LED_AMBER
;
278 mode
= INDICATOR_ALT_BLINK
;
283 if (selector
!= HUB_LED_AUTO
)
285 set_port_led(hub
, i
+ 1, selector
);
286 hub
->indicator
[i
] = mode
;
288 if (!changed
&& blinkenlights
) {
290 cursor
%= hub
->descriptor
->bNbrPorts
;
291 set_port_led(hub
, cursor
+ 1, HUB_LED_GREEN
);
292 hub
->indicator
[cursor
] = INDICATOR_CYCLE
;
296 schedule_delayed_work(&hub
->leds
, LED_CYCLE_PERIOD
);
299 /* use a short timeout for hub/port status fetches */
300 #define USB_STS_TIMEOUT 1000
301 #define USB_STS_RETRIES 5
304 * USB 2.0 spec Section 11.24.2.6
306 static int get_hub_status(struct usb_device
*hdev
,
307 struct usb_hub_status
*data
)
309 int i
, status
= -ETIMEDOUT
;
311 for (i
= 0; i
< USB_STS_RETRIES
&& status
== -ETIMEDOUT
; i
++) {
312 status
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
313 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_HUB
, 0, 0,
314 data
, sizeof(*data
), USB_STS_TIMEOUT
);
320 * USB 2.0 spec Section 11.24.2.7
322 static int get_port_status(struct usb_device
*hdev
, int port1
,
323 struct usb_port_status
*data
)
325 int i
, status
= -ETIMEDOUT
;
327 for (i
= 0; i
< USB_STS_RETRIES
&& status
== -ETIMEDOUT
; i
++) {
328 status
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
329 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_PORT
, 0, port1
,
330 data
, sizeof(*data
), USB_STS_TIMEOUT
);
335 static int hub_port_status(struct usb_hub
*hub
, int port1
,
336 u16
*status
, u16
*change
)
340 mutex_lock(&hub
->status_mutex
);
341 ret
= get_port_status(hub
->hdev
, port1
, &hub
->status
->port
);
343 dev_err(hub
->intfdev
,
344 "%s failed (err = %d)\n", __func__
, ret
);
348 *status
= le16_to_cpu(hub
->status
->port
.wPortStatus
);
349 *change
= le16_to_cpu(hub
->status
->port
.wPortChange
);
352 mutex_unlock(&hub
->status_mutex
);
356 static void kick_khubd(struct usb_hub
*hub
)
360 /* Suppress autosuspend until khubd runs */
361 to_usb_interface(hub
->intfdev
)->pm_usage_cnt
= 1;
363 spin_lock_irqsave(&hub_event_lock
, flags
);
364 if (!hub
->disconnected
&& list_empty(&hub
->event_list
)) {
365 list_add_tail(&hub
->event_list
, &hub_event_list
);
366 wake_up(&khubd_wait
);
368 spin_unlock_irqrestore(&hub_event_lock
, flags
);
371 void usb_kick_khubd(struct usb_device
*hdev
)
373 /* FIXME: What if hdev isn't bound to the hub driver? */
374 kick_khubd(hdev_to_hub(hdev
));
378 /* completion function, fires on port status changes and various faults */
379 static void hub_irq(struct urb
*urb
)
381 struct usb_hub
*hub
= urb
->context
;
382 int status
= urb
->status
;
387 case -ENOENT
: /* synchronous unlink */
388 case -ECONNRESET
: /* async unlink */
389 case -ESHUTDOWN
: /* hardware going away */
392 default: /* presumably an error */
393 /* Cause a hub reset after 10 consecutive errors */
394 dev_dbg (hub
->intfdev
, "transfer --> %d\n", status
);
395 if ((++hub
->nerrors
< 10) || hub
->error
)
400 /* let khubd handle things */
401 case 0: /* we got data: port status changed */
403 for (i
= 0; i
< urb
->actual_length
; ++i
)
404 bits
|= ((unsigned long) ((*hub
->buffer
)[i
]))
406 hub
->event_bits
[0] = bits
;
412 /* Something happened, let khubd figure it out */
419 if ((status
= usb_submit_urb (hub
->urb
, GFP_ATOMIC
)) != 0
420 && status
!= -ENODEV
&& status
!= -EPERM
)
421 dev_err (hub
->intfdev
, "resubmit --> %d\n", status
);
424 /* USB 2.0 spec Section 11.24.2.3 */
426 hub_clear_tt_buffer (struct usb_device
*hdev
, u16 devinfo
, u16 tt
)
428 return usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
429 HUB_CLEAR_TT_BUFFER
, USB_RT_PORT
, devinfo
,
434 * enumeration blocks khubd for a long time. we use keventd instead, since
435 * long blocking there is the exception, not the rule. accordingly, HCDs
436 * talking to TTs must queue control transfers (not just bulk and iso), so
437 * both can talk to the same hub concurrently.
439 static void hub_tt_kevent (struct work_struct
*work
)
441 struct usb_hub
*hub
=
442 container_of(work
, struct usb_hub
, tt
.kevent
);
446 spin_lock_irqsave (&hub
->tt
.lock
, flags
);
447 while (--limit
&& !list_empty (&hub
->tt
.clear_list
)) {
448 struct list_head
*temp
;
449 struct usb_tt_clear
*clear
;
450 struct usb_device
*hdev
= hub
->hdev
;
453 temp
= hub
->tt
.clear_list
.next
;
454 clear
= list_entry (temp
, struct usb_tt_clear
, clear_list
);
455 list_del (&clear
->clear_list
);
457 /* drop lock so HCD can concurrently report other TT errors */
458 spin_unlock_irqrestore (&hub
->tt
.lock
, flags
);
459 status
= hub_clear_tt_buffer (hdev
, clear
->devinfo
, clear
->tt
);
460 spin_lock_irqsave (&hub
->tt
.lock
, flags
);
464 "clear tt %d (%04x) error %d\n",
465 clear
->tt
, clear
->devinfo
, status
);
468 spin_unlock_irqrestore (&hub
->tt
.lock
, flags
);
472 * usb_hub_tt_clear_buffer - clear control/bulk TT state in high speed hub
473 * @udev: the device whose split transaction failed
474 * @pipe: identifies the endpoint of the failed transaction
476 * High speed HCDs use this to tell the hub driver that some split control or
477 * bulk transaction failed in a way that requires clearing internal state of
478 * a transaction translator. This is normally detected (and reported) from
481 * It may not be possible for that hub to handle additional full (or low)
482 * speed transactions until that state is fully cleared out.
484 void usb_hub_tt_clear_buffer (struct usb_device
*udev
, int pipe
)
486 struct usb_tt
*tt
= udev
->tt
;
488 struct usb_tt_clear
*clear
;
490 /* we've got to cope with an arbitrary number of pending TT clears,
491 * since each TT has "at least two" buffers that can need it (and
492 * there can be many TTs per hub). even if they're uncommon.
494 if ((clear
= kmalloc (sizeof *clear
, GFP_ATOMIC
)) == NULL
) {
495 dev_err (&udev
->dev
, "can't save CLEAR_TT_BUFFER state\n");
496 /* FIXME recover somehow ... RESET_TT? */
500 /* info that CLEAR_TT_BUFFER needs */
501 clear
->tt
= tt
->multi
? udev
->ttport
: 1;
502 clear
->devinfo
= usb_pipeendpoint (pipe
);
503 clear
->devinfo
|= udev
->devnum
<< 4;
504 clear
->devinfo
|= usb_pipecontrol (pipe
)
505 ? (USB_ENDPOINT_XFER_CONTROL
<< 11)
506 : (USB_ENDPOINT_XFER_BULK
<< 11);
507 if (usb_pipein (pipe
))
508 clear
->devinfo
|= 1 << 15;
510 /* tell keventd to clear state for this TT */
511 spin_lock_irqsave (&tt
->lock
, flags
);
512 list_add_tail (&clear
->clear_list
, &tt
->clear_list
);
513 schedule_work (&tt
->kevent
);
514 spin_unlock_irqrestore (&tt
->lock
, flags
);
516 EXPORT_SYMBOL_GPL(usb_hub_tt_clear_buffer
);
518 static void hub_power_on(struct usb_hub
*hub
)
521 unsigned pgood_delay
= hub
->descriptor
->bPwrOn2PwrGood
* 2;
522 u16 wHubCharacteristics
=
523 le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
525 /* Enable power on each port. Some hubs have reserved values
526 * of LPSM (> 2) in their descriptors, even though they are
527 * USB 2.0 hubs. Some hubs do not implement port-power switching
528 * but only emulate it. In all cases, the ports won't work
529 * unless we send these messages to the hub.
531 if ((wHubCharacteristics
& HUB_CHAR_LPSM
) < 2)
532 dev_dbg(hub
->intfdev
, "enabling power on all ports\n");
534 dev_dbg(hub
->intfdev
, "trying to enable port power on "
535 "non-switchable hub\n");
536 for (port1
= 1; port1
<= hub
->descriptor
->bNbrPorts
; port1
++)
537 set_port_feature(hub
->hdev
, port1
, USB_PORT_FEAT_POWER
);
539 /* Wait at least 100 msec for power to become stable */
540 msleep(max(pgood_delay
, (unsigned) 100));
543 static int hub_hub_status(struct usb_hub
*hub
,
544 u16
*status
, u16
*change
)
548 mutex_lock(&hub
->status_mutex
);
549 ret
= get_hub_status(hub
->hdev
, &hub
->status
->hub
);
551 dev_err (hub
->intfdev
,
552 "%s failed (err = %d)\n", __func__
, ret
);
554 *status
= le16_to_cpu(hub
->status
->hub
.wHubStatus
);
555 *change
= le16_to_cpu(hub
->status
->hub
.wHubChange
);
558 mutex_unlock(&hub
->status_mutex
);
562 static int hub_port_disable(struct usb_hub
*hub
, int port1
, int set_state
)
564 struct usb_device
*hdev
= hub
->hdev
;
567 if (hdev
->children
[port1
-1] && set_state
)
568 usb_set_device_state(hdev
->children
[port1
-1],
569 USB_STATE_NOTATTACHED
);
571 ret
= clear_port_feature(hdev
, port1
, USB_PORT_FEAT_ENABLE
);
573 dev_err(hub
->intfdev
, "cannot disable port %d (err = %d)\n",
579 * Disable a port and mark a logical connnect-change event, so that some
580 * time later khubd will disconnect() any existing usb_device on the port
581 * and will re-enumerate if there actually is a device attached.
583 static void hub_port_logical_disconnect(struct usb_hub
*hub
, int port1
)
585 dev_dbg(hub
->intfdev
, "logical disconnect on port %d\n", port1
);
586 hub_port_disable(hub
, port1
, 1);
588 /* FIXME let caller ask to power down the port:
589 * - some devices won't enumerate without a VBUS power cycle
590 * - SRP saves power that way
591 * - ... new call, TBD ...
592 * That's easy if this hub can switch power per-port, and
593 * khubd reactivates the port later (timer, SRP, etc).
594 * Powerdown must be optional, because of reset/DFU.
597 set_bit(port1
, hub
->change_bits
);
601 enum hub_activation_type
{
602 HUB_INIT
, HUB_POST_RESET
, HUB_RESUME
, HUB_RESET_RESUME
605 static void hub_activate(struct usb_hub
*hub
, enum hub_activation_type type
)
607 struct usb_device
*hdev
= hub
->hdev
;
610 bool need_debounce_delay
= false;
612 /* After a resume, port power should still be on.
613 * For any other type of activation, turn it on.
615 if (type
!= HUB_RESUME
)
618 /* Check each port and set hub->change_bits to let khubd know
619 * which ports need attention.
621 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
622 struct usb_device
*udev
= hdev
->children
[port1
-1];
623 u16 portstatus
, portchange
;
625 portstatus
= portchange
= 0;
626 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
627 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
))
628 dev_dbg(hub
->intfdev
,
629 "port %d: status %04x change %04x\n",
630 port1
, portstatus
, portchange
);
632 /* After anything other than HUB_RESUME (i.e., initialization
633 * or any sort of reset), every port should be disabled.
634 * Unconnected ports should likewise be disabled (paranoia),
635 * and so should ports for which we have no usb_device.
637 if ((portstatus
& USB_PORT_STAT_ENABLE
) && (
638 type
!= HUB_RESUME
||
639 !(portstatus
& USB_PORT_STAT_CONNECTION
) ||
641 udev
->state
== USB_STATE_NOTATTACHED
)) {
642 clear_port_feature(hdev
, port1
, USB_PORT_FEAT_ENABLE
);
643 portstatus
&= ~USB_PORT_STAT_ENABLE
;
646 /* Clear status-change flags; we'll debounce later */
647 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
648 need_debounce_delay
= true;
649 clear_port_feature(hub
->hdev
, port1
,
650 USB_PORT_FEAT_C_CONNECTION
);
652 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
653 need_debounce_delay
= true;
654 clear_port_feature(hub
->hdev
, port1
,
655 USB_PORT_FEAT_C_ENABLE
);
658 if (!udev
|| udev
->state
== USB_STATE_NOTATTACHED
) {
659 /* Tell khubd to disconnect the device or
660 * check for a new connection
662 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
))
663 set_bit(port1
, hub
->change_bits
);
665 } else if (portstatus
& USB_PORT_STAT_ENABLE
) {
666 /* The power session apparently survived the resume.
667 * If there was an overcurrent or suspend change
668 * (i.e., remote wakeup request), have khubd
672 set_bit(port1
, hub
->change_bits
);
674 } else if (udev
->persist_enabled
) {
676 udev
->reset_resume
= 1;
678 set_bit(port1
, hub
->change_bits
);
681 /* The power session is gone; tell khubd */
682 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
683 set_bit(port1
, hub
->change_bits
);
687 /* If no port-status-change flags were set, we don't need any
688 * debouncing. If flags were set we can try to debounce the
689 * ports all at once right now, instead of letting khubd do them
690 * one at a time later on.
692 * If any port-status changes do occur during this delay, khubd
693 * will see them later and handle them normally.
695 if (need_debounce_delay
)
696 msleep(HUB_DEBOUNCE_STABLE
);
700 status
= usb_submit_urb(hub
->urb
, GFP_NOIO
);
702 dev_err(hub
->intfdev
, "activate --> %d\n", status
);
703 if (hub
->has_indicators
&& blinkenlights
)
704 schedule_delayed_work(&hub
->leds
, LED_CYCLE_PERIOD
);
706 /* Scan all ports that need attention */
710 enum hub_quiescing_type
{
711 HUB_DISCONNECT
, HUB_PRE_RESET
, HUB_SUSPEND
714 static void hub_quiesce(struct usb_hub
*hub
, enum hub_quiescing_type type
)
716 struct usb_device
*hdev
= hub
->hdev
;
719 /* khubd and related activity won't re-trigger */
722 if (type
!= HUB_SUSPEND
) {
723 /* Disconnect all the children */
724 for (i
= 0; i
< hdev
->maxchild
; ++i
) {
725 if (hdev
->children
[i
])
726 usb_disconnect(&hdev
->children
[i
]);
730 /* Stop khubd and related activity */
731 usb_kill_urb(hub
->urb
);
732 if (hub
->has_indicators
)
733 cancel_delayed_work_sync(&hub
->leds
);
735 cancel_work_sync(&hub
->tt
.kevent
);
738 /* caller has locked the hub device */
739 static int hub_pre_reset(struct usb_interface
*intf
)
741 struct usb_hub
*hub
= usb_get_intfdata(intf
);
743 hub_quiesce(hub
, HUB_PRE_RESET
);
747 /* caller has locked the hub device */
748 static int hub_post_reset(struct usb_interface
*intf
)
750 struct usb_hub
*hub
= usb_get_intfdata(intf
);
752 hub_activate(hub
, HUB_POST_RESET
);
756 static int hub_configure(struct usb_hub
*hub
,
757 struct usb_endpoint_descriptor
*endpoint
)
759 struct usb_device
*hdev
= hub
->hdev
;
760 struct device
*hub_dev
= hub
->intfdev
;
761 u16 hubstatus
, hubchange
;
762 u16 wHubCharacteristics
;
767 hub
->buffer
= usb_buffer_alloc(hdev
, sizeof(*hub
->buffer
), GFP_KERNEL
,
770 message
= "can't allocate hub irq buffer";
775 hub
->status
= kmalloc(sizeof(*hub
->status
), GFP_KERNEL
);
777 message
= "can't kmalloc hub status buffer";
781 mutex_init(&hub
->status_mutex
);
783 hub
->descriptor
= kmalloc(sizeof(*hub
->descriptor
), GFP_KERNEL
);
784 if (!hub
->descriptor
) {
785 message
= "can't kmalloc hub descriptor";
790 /* Request the entire hub descriptor.
791 * hub->descriptor can handle USB_MAXCHILDREN ports,
792 * but the hub can/will return fewer bytes here.
794 ret
= get_hub_descriptor(hdev
, hub
->descriptor
,
795 sizeof(*hub
->descriptor
));
797 message
= "can't read hub descriptor";
799 } else if (hub
->descriptor
->bNbrPorts
> USB_MAXCHILDREN
) {
800 message
= "hub has too many ports!";
805 hdev
->maxchild
= hub
->descriptor
->bNbrPorts
;
806 dev_info (hub_dev
, "%d port%s detected\n", hdev
->maxchild
,
807 (hdev
->maxchild
== 1) ? "" : "s");
809 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
811 if (wHubCharacteristics
& HUB_CHAR_COMPOUND
) {
813 char portstr
[USB_MAXCHILDREN
+ 1];
815 for (i
= 0; i
< hdev
->maxchild
; i
++)
816 portstr
[i
] = hub
->descriptor
->DeviceRemovable
817 [((i
+ 1) / 8)] & (1 << ((i
+ 1) % 8))
819 portstr
[hdev
->maxchild
] = 0;
820 dev_dbg(hub_dev
, "compound device; port removable status: %s\n", portstr
);
822 dev_dbg(hub_dev
, "standalone hub\n");
824 switch (wHubCharacteristics
& HUB_CHAR_LPSM
) {
826 dev_dbg(hub_dev
, "ganged power switching\n");
829 dev_dbg(hub_dev
, "individual port power switching\n");
833 dev_dbg(hub_dev
, "no power switching (usb 1.0)\n");
837 switch (wHubCharacteristics
& HUB_CHAR_OCPM
) {
839 dev_dbg(hub_dev
, "global over-current protection\n");
842 dev_dbg(hub_dev
, "individual port over-current protection\n");
846 dev_dbg(hub_dev
, "no over-current protection\n");
850 spin_lock_init (&hub
->tt
.lock
);
851 INIT_LIST_HEAD (&hub
->tt
.clear_list
);
852 INIT_WORK (&hub
->tt
.kevent
, hub_tt_kevent
);
853 switch (hdev
->descriptor
.bDeviceProtocol
) {
857 dev_dbg(hub_dev
, "Single TT\n");
861 ret
= usb_set_interface(hdev
, 0, 1);
863 dev_dbg(hub_dev
, "TT per port\n");
866 dev_err(hub_dev
, "Using single TT (err %d)\n",
871 dev_dbg(hub_dev
, "Unrecognized hub protocol %d\n",
872 hdev
->descriptor
.bDeviceProtocol
);
876 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
877 switch (wHubCharacteristics
& HUB_CHAR_TTTT
) {
878 case HUB_TTTT_8_BITS
:
879 if (hdev
->descriptor
.bDeviceProtocol
!= 0) {
880 hub
->tt
.think_time
= 666;
881 dev_dbg(hub_dev
, "TT requires at most %d "
882 "FS bit times (%d ns)\n",
883 8, hub
->tt
.think_time
);
886 case HUB_TTTT_16_BITS
:
887 hub
->tt
.think_time
= 666 * 2;
888 dev_dbg(hub_dev
, "TT requires at most %d "
889 "FS bit times (%d ns)\n",
890 16, hub
->tt
.think_time
);
892 case HUB_TTTT_24_BITS
:
893 hub
->tt
.think_time
= 666 * 3;
894 dev_dbg(hub_dev
, "TT requires at most %d "
895 "FS bit times (%d ns)\n",
896 24, hub
->tt
.think_time
);
898 case HUB_TTTT_32_BITS
:
899 hub
->tt
.think_time
= 666 * 4;
900 dev_dbg(hub_dev
, "TT requires at most %d "
901 "FS bit times (%d ns)\n",
902 32, hub
->tt
.think_time
);
906 /* probe() zeroes hub->indicator[] */
907 if (wHubCharacteristics
& HUB_CHAR_PORTIND
) {
908 hub
->has_indicators
= 1;
909 dev_dbg(hub_dev
, "Port indicators are supported\n");
912 dev_dbg(hub_dev
, "power on to power good time: %dms\n",
913 hub
->descriptor
->bPwrOn2PwrGood
* 2);
915 /* power budgeting mostly matters with bus-powered hubs,
916 * and battery-powered root hubs (may provide just 8 mA).
918 ret
= usb_get_status(hdev
, USB_RECIP_DEVICE
, 0, &hubstatus
);
920 message
= "can't get hub status";
923 le16_to_cpus(&hubstatus
);
924 if (hdev
== hdev
->bus
->root_hub
) {
925 if (hdev
->bus_mA
== 0 || hdev
->bus_mA
>= 500)
926 hub
->mA_per_port
= 500;
928 hub
->mA_per_port
= hdev
->bus_mA
;
929 hub
->limited_power
= 1;
931 } else if ((hubstatus
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
932 dev_dbg(hub_dev
, "hub controller current requirement: %dmA\n",
933 hub
->descriptor
->bHubContrCurrent
);
934 hub
->limited_power
= 1;
935 if (hdev
->maxchild
> 0) {
936 int remaining
= hdev
->bus_mA
-
937 hub
->descriptor
->bHubContrCurrent
;
939 if (remaining
< hdev
->maxchild
* 100)
941 "insufficient power available "
942 "to use all downstream ports\n");
943 hub
->mA_per_port
= 100; /* 7.2.1.1 */
945 } else { /* Self-powered external hub */
946 /* FIXME: What about battery-powered external hubs that
947 * provide less current per port? */
948 hub
->mA_per_port
= 500;
950 if (hub
->mA_per_port
< 500)
951 dev_dbg(hub_dev
, "%umA bus power budget for each child\n",
954 ret
= hub_hub_status(hub
, &hubstatus
, &hubchange
);
956 message
= "can't get hub status";
960 /* local power status reports aren't always correct */
961 if (hdev
->actconfig
->desc
.bmAttributes
& USB_CONFIG_ATT_SELFPOWER
)
962 dev_dbg(hub_dev
, "local power source is %s\n",
963 (hubstatus
& HUB_STATUS_LOCAL_POWER
)
964 ? "lost (inactive)" : "good");
966 if ((wHubCharacteristics
& HUB_CHAR_OCPM
) == 0)
967 dev_dbg(hub_dev
, "%sover-current condition exists\n",
968 (hubstatus
& HUB_STATUS_OVERCURRENT
) ? "" : "no ");
970 /* set up the interrupt endpoint
971 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
972 * bytes as USB2.0[11.12.3] says because some hubs are known
973 * to send more data (and thus cause overflow). For root hubs,
974 * maxpktsize is defined in hcd.c's fake endpoint descriptors
975 * to be big enough for at least USB_MAXCHILDREN ports. */
976 pipe
= usb_rcvintpipe(hdev
, endpoint
->bEndpointAddress
);
977 maxp
= usb_maxpacket(hdev
, pipe
, usb_pipeout(pipe
));
979 if (maxp
> sizeof(*hub
->buffer
))
980 maxp
= sizeof(*hub
->buffer
);
982 hub
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
984 message
= "couldn't allocate interrupt urb";
989 usb_fill_int_urb(hub
->urb
, hdev
, pipe
, *hub
->buffer
, maxp
, hub_irq
,
990 hub
, endpoint
->bInterval
);
991 hub
->urb
->transfer_dma
= hub
->buffer_dma
;
992 hub
->urb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
994 /* maybe cycle the hub leds */
995 if (hub
->has_indicators
&& blinkenlights
)
996 hub
->indicator
[0] = INDICATOR_CYCLE
;
998 hub_activate(hub
, HUB_INIT
);
1002 dev_err (hub_dev
, "config failed, %s (err %d)\n",
1004 /* hub_disconnect() frees urb and descriptor */
1008 static void hub_release(struct kref
*kref
)
1010 struct usb_hub
*hub
= container_of(kref
, struct usb_hub
, kref
);
1012 usb_put_intf(to_usb_interface(hub
->intfdev
));
1016 static unsigned highspeed_hubs
;
1018 static void hub_disconnect(struct usb_interface
*intf
)
1020 struct usb_hub
*hub
= usb_get_intfdata (intf
);
1022 /* Take the hub off the event list and don't let it be added again */
1023 spin_lock_irq(&hub_event_lock
);
1024 list_del_init(&hub
->event_list
);
1025 hub
->disconnected
= 1;
1026 spin_unlock_irq(&hub_event_lock
);
1028 /* Disconnect all children and quiesce the hub */
1030 hub_quiesce(hub
, HUB_DISCONNECT
);
1032 usb_set_intfdata (intf
, NULL
);
1034 if (hub
->hdev
->speed
== USB_SPEED_HIGH
)
1037 usb_free_urb(hub
->urb
);
1038 kfree(hub
->descriptor
);
1040 usb_buffer_free(hub
->hdev
, sizeof(*hub
->buffer
), hub
->buffer
,
1043 kref_put(&hub
->kref
, hub_release
);
1046 static int hub_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
1048 struct usb_host_interface
*desc
;
1049 struct usb_endpoint_descriptor
*endpoint
;
1050 struct usb_device
*hdev
;
1051 struct usb_hub
*hub
;
1053 desc
= intf
->cur_altsetting
;
1054 hdev
= interface_to_usbdev(intf
);
1056 if (hdev
->level
== MAX_TOPO_LEVEL
) {
1057 dev_err(&intf
->dev
, "Unsupported bus topology: "
1058 "hub nested too deep\n");
1062 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1064 dev_warn(&intf
->dev
, "ignoring external hub\n");
1069 /* Some hubs have a subclass of 1, which AFAICT according to the */
1070 /* specs is not defined, but it works */
1071 if ((desc
->desc
.bInterfaceSubClass
!= 0) &&
1072 (desc
->desc
.bInterfaceSubClass
!= 1)) {
1074 dev_err (&intf
->dev
, "bad descriptor, ignoring hub\n");
1078 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1079 if (desc
->desc
.bNumEndpoints
!= 1)
1080 goto descriptor_error
;
1082 endpoint
= &desc
->endpoint
[0].desc
;
1084 /* If it's not an interrupt in endpoint, we'd better punt! */
1085 if (!usb_endpoint_is_int_in(endpoint
))
1086 goto descriptor_error
;
1088 /* We found a hub */
1089 dev_info (&intf
->dev
, "USB hub found\n");
1091 hub
= kzalloc(sizeof(*hub
), GFP_KERNEL
);
1093 dev_dbg (&intf
->dev
, "couldn't kmalloc hub struct\n");
1097 kref_init(&hub
->kref
);
1098 INIT_LIST_HEAD(&hub
->event_list
);
1099 hub
->intfdev
= &intf
->dev
;
1101 INIT_DELAYED_WORK(&hub
->leds
, led_work
);
1104 usb_set_intfdata (intf
, hub
);
1105 intf
->needs_remote_wakeup
= 1;
1107 if (hdev
->speed
== USB_SPEED_HIGH
)
1110 if (hub_configure(hub
, endpoint
) >= 0)
1113 hub_disconnect (intf
);
1118 hub_ioctl(struct usb_interface
*intf
, unsigned int code
, void *user_data
)
1120 struct usb_device
*hdev
= interface_to_usbdev (intf
);
1122 /* assert ifno == 0 (part of hub spec) */
1124 case USBDEVFS_HUB_PORTINFO
: {
1125 struct usbdevfs_hub_portinfo
*info
= user_data
;
1128 spin_lock_irq(&device_state_lock
);
1129 if (hdev
->devnum
<= 0)
1132 info
->nports
= hdev
->maxchild
;
1133 for (i
= 0; i
< info
->nports
; i
++) {
1134 if (hdev
->children
[i
] == NULL
)
1138 hdev
->children
[i
]->devnum
;
1141 spin_unlock_irq(&device_state_lock
);
1143 return info
->nports
+ 1;
1152 static void recursively_mark_NOTATTACHED(struct usb_device
*udev
)
1156 for (i
= 0; i
< udev
->maxchild
; ++i
) {
1157 if (udev
->children
[i
])
1158 recursively_mark_NOTATTACHED(udev
->children
[i
]);
1160 if (udev
->state
== USB_STATE_SUSPENDED
) {
1161 udev
->discon_suspended
= 1;
1162 udev
->active_duration
-= jiffies
;
1164 udev
->state
= USB_STATE_NOTATTACHED
;
1168 * usb_set_device_state - change a device's current state (usbcore, hcds)
1169 * @udev: pointer to device whose state should be changed
1170 * @new_state: new state value to be stored
1172 * udev->state is _not_ fully protected by the device lock. Although
1173 * most transitions are made only while holding the lock, the state can
1174 * can change to USB_STATE_NOTATTACHED at almost any time. This
1175 * is so that devices can be marked as disconnected as soon as possible,
1176 * without having to wait for any semaphores to be released. As a result,
1177 * all changes to any device's state must be protected by the
1178 * device_state_lock spinlock.
1180 * Once a device has been added to the device tree, all changes to its state
1181 * should be made using this routine. The state should _not_ be set directly.
1183 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1184 * Otherwise udev->state is set to new_state, and if new_state is
1185 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1186 * to USB_STATE_NOTATTACHED.
1188 void usb_set_device_state(struct usb_device
*udev
,
1189 enum usb_device_state new_state
)
1191 unsigned long flags
;
1193 spin_lock_irqsave(&device_state_lock
, flags
);
1194 if (udev
->state
== USB_STATE_NOTATTACHED
)
1196 else if (new_state
!= USB_STATE_NOTATTACHED
) {
1198 /* root hub wakeup capabilities are managed out-of-band
1199 * and may involve silicon errata ... ignore them here.
1202 if (udev
->state
== USB_STATE_SUSPENDED
1203 || new_state
== USB_STATE_SUSPENDED
)
1204 ; /* No change to wakeup settings */
1205 else if (new_state
== USB_STATE_CONFIGURED
)
1206 device_init_wakeup(&udev
->dev
,
1207 (udev
->actconfig
->desc
.bmAttributes
1208 & USB_CONFIG_ATT_WAKEUP
));
1210 device_init_wakeup(&udev
->dev
, 0);
1212 if (udev
->state
== USB_STATE_SUSPENDED
&&
1213 new_state
!= USB_STATE_SUSPENDED
)
1214 udev
->active_duration
-= jiffies
;
1215 else if (new_state
== USB_STATE_SUSPENDED
&&
1216 udev
->state
!= USB_STATE_SUSPENDED
)
1217 udev
->active_duration
+= jiffies
;
1218 udev
->state
= new_state
;
1220 recursively_mark_NOTATTACHED(udev
);
1221 spin_unlock_irqrestore(&device_state_lock
, flags
);
1225 * WUSB devices are simple: they have no hubs behind, so the mapping
1226 * device <-> virtual port number becomes 1:1. Why? to simplify the
1227 * life of the device connection logic in
1228 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1229 * handshake we need to assign a temporary address in the unauthorized
1230 * space. For simplicity we use the first virtual port number found to
1231 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1232 * and that becomes it's address [X < 128] or its unauthorized address
1235 * We add 1 as an offset to the one-based USB-stack port number
1236 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1237 * 0 is reserved by USB for default address; (b) Linux's USB stack
1238 * uses always #1 for the root hub of the controller. So USB stack's
1239 * port #1, which is wusb virtual-port #0 has address #2.
1241 static void choose_address(struct usb_device
*udev
)
1244 struct usb_bus
*bus
= udev
->bus
;
1246 /* If khubd ever becomes multithreaded, this will need a lock */
1248 devnum
= udev
->portnum
+ 1;
1249 BUG_ON(test_bit(devnum
, bus
->devmap
.devicemap
));
1251 /* Try to allocate the next devnum beginning at
1252 * bus->devnum_next. */
1253 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
, 128,
1256 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
,
1258 bus
->devnum_next
= ( devnum
>= 127 ? 1 : devnum
+ 1);
1261 set_bit(devnum
, bus
->devmap
.devicemap
);
1262 udev
->devnum
= devnum
;
1266 static void release_address(struct usb_device
*udev
)
1268 if (udev
->devnum
> 0) {
1269 clear_bit(udev
->devnum
, udev
->bus
->devmap
.devicemap
);
1274 static void update_address(struct usb_device
*udev
, int devnum
)
1276 /* The address for a WUSB device is managed by wusbcore. */
1278 udev
->devnum
= devnum
;
1281 #ifdef CONFIG_USB_SUSPEND
1283 static void usb_stop_pm(struct usb_device
*udev
)
1285 /* Synchronize with the ksuspend thread to prevent any more
1286 * autosuspend requests from being submitted, and decrement
1287 * the parent's count of unsuspended children.
1290 if (udev
->parent
&& !udev
->discon_suspended
)
1291 usb_autosuspend_device(udev
->parent
);
1292 usb_pm_unlock(udev
);
1294 /* Stop any autosuspend requests already submitted */
1295 cancel_rearming_delayed_work(&udev
->autosuspend
);
1300 static inline void usb_stop_pm(struct usb_device
*udev
)
1306 * usb_disconnect - disconnect a device (usbcore-internal)
1307 * @pdev: pointer to device being disconnected
1308 * Context: !in_interrupt ()
1310 * Something got disconnected. Get rid of it and all of its children.
1312 * If *pdev is a normal device then the parent hub must already be locked.
1313 * If *pdev is a root hub then this routine will acquire the
1314 * usb_bus_list_lock on behalf of the caller.
1316 * Only hub drivers (including virtual root hub drivers for host
1317 * controllers) should ever call this.
1319 * This call is synchronous, and may not be used in an interrupt context.
1321 void usb_disconnect(struct usb_device
**pdev
)
1323 struct usb_device
*udev
= *pdev
;
1327 pr_debug ("%s nodev\n", __func__
);
1331 /* mark the device as inactive, so any further urb submissions for
1332 * this device (and any of its children) will fail immediately.
1333 * this quiesces everyting except pending urbs.
1335 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
1336 dev_info (&udev
->dev
, "USB disconnect, address %d\n", udev
->devnum
);
1338 usb_lock_device(udev
);
1340 /* Free up all the children before we remove this device */
1341 for (i
= 0; i
< USB_MAXCHILDREN
; i
++) {
1342 if (udev
->children
[i
])
1343 usb_disconnect(&udev
->children
[i
]);
1346 /* deallocate hcd/hardware state ... nuking all pending urbs and
1347 * cleaning up all state associated with the current configuration
1348 * so that the hardware is now fully quiesced.
1350 dev_dbg (&udev
->dev
, "unregistering device\n");
1351 usb_disable_device(udev
, 0);
1353 usb_unlock_device(udev
);
1355 /* Remove the device-specific files from sysfs. This must be
1356 * done with udev unlocked, because some of the attribute
1357 * routines try to acquire the device lock.
1359 usb_remove_sysfs_dev_files(udev
);
1361 /* Unregister the device. The device driver is responsible
1362 * for removing the device files from usbfs and sysfs and for
1363 * de-configuring the device.
1365 device_del(&udev
->dev
);
1367 /* Free the device number and delete the parent's children[]
1368 * (or root_hub) pointer.
1370 release_address(udev
);
1372 /* Avoid races with recursively_mark_NOTATTACHED() */
1373 spin_lock_irq(&device_state_lock
);
1375 spin_unlock_irq(&device_state_lock
);
1379 put_device(&udev
->dev
);
1382 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
1383 static void show_string(struct usb_device
*udev
, char *id
, char *string
)
1387 dev_printk(KERN_INFO
, &udev
->dev
, "%s: %s\n", id
, string
);
1390 static void announce_device(struct usb_device
*udev
)
1392 dev_info(&udev
->dev
, "New USB device found, idVendor=%04x, idProduct=%04x\n",
1393 le16_to_cpu(udev
->descriptor
.idVendor
),
1394 le16_to_cpu(udev
->descriptor
.idProduct
));
1395 dev_info(&udev
->dev
, "New USB device strings: Mfr=%d, Product=%d, "
1396 "SerialNumber=%d\n",
1397 udev
->descriptor
.iManufacturer
,
1398 udev
->descriptor
.iProduct
,
1399 udev
->descriptor
.iSerialNumber
);
1400 show_string(udev
, "Product", udev
->product
);
1401 show_string(udev
, "Manufacturer", udev
->manufacturer
);
1402 show_string(udev
, "SerialNumber", udev
->serial
);
1405 static inline void announce_device(struct usb_device
*udev
) { }
1408 #ifdef CONFIG_USB_OTG
1409 #include "otg_whitelist.h"
1413 * usb_configure_device_otg - FIXME (usbcore-internal)
1414 * @udev: newly addressed device (in ADDRESS state)
1416 * Do configuration for On-The-Go devices
1418 static int usb_configure_device_otg(struct usb_device
*udev
)
1422 #ifdef CONFIG_USB_OTG
1424 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1425 * to wake us after we've powered off VBUS; and HNP, switching roles
1426 * "host" to "peripheral". The OTG descriptor helps figure this out.
1428 if (!udev
->bus
->is_b_host
1430 && udev
->parent
== udev
->bus
->root_hub
) {
1431 struct usb_otg_descriptor
*desc
= 0;
1432 struct usb_bus
*bus
= udev
->bus
;
1434 /* descriptor may appear anywhere in config */
1435 if (__usb_get_extra_descriptor (udev
->rawdescriptors
[0],
1436 le16_to_cpu(udev
->config
[0].desc
.wTotalLength
),
1437 USB_DT_OTG
, (void **) &desc
) == 0) {
1438 if (desc
->bmAttributes
& USB_OTG_HNP
) {
1439 unsigned port1
= udev
->portnum
;
1441 dev_info(&udev
->dev
,
1442 "Dual-Role OTG device on %sHNP port\n",
1443 (port1
== bus
->otg_port
)
1446 /* enable HNP before suspend, it's simpler */
1447 if (port1
== bus
->otg_port
)
1448 bus
->b_hnp_enable
= 1;
1449 err
= usb_control_msg(udev
,
1450 usb_sndctrlpipe(udev
, 0),
1451 USB_REQ_SET_FEATURE
, 0,
1453 ? USB_DEVICE_B_HNP_ENABLE
1454 : USB_DEVICE_A_ALT_HNP_SUPPORT
,
1455 0, NULL
, 0, USB_CTRL_SET_TIMEOUT
);
1457 /* OTG MESSAGE: report errors here,
1458 * customize to match your product.
1460 dev_info(&udev
->dev
,
1461 "can't set HNP mode; %d\n",
1463 bus
->b_hnp_enable
= 0;
1469 if (!is_targeted(udev
)) {
1471 /* Maybe it can talk to us, though we can't talk to it.
1472 * (Includes HNP test device.)
1474 if (udev
->bus
->b_hnp_enable
|| udev
->bus
->is_b_host
) {
1475 err
= usb_port_suspend(udev
);
1477 dev_dbg(&udev
->dev
, "HNP fail, %d\n", err
);
1489 * usb_configure_device - Detect and probe device intfs/otg (usbcore-internal)
1490 * @udev: newly addressed device (in ADDRESS state)
1492 * This is only called by usb_new_device() and usb_authorize_device()
1493 * and FIXME -- all comments that apply to them apply here wrt to
1496 * If the device is WUSB and not authorized, we don't attempt to read
1497 * the string descriptors, as they will be errored out by the device
1498 * until it has been authorized.
1500 static int usb_configure_device(struct usb_device
*udev
)
1504 if (udev
->config
== NULL
) {
1505 err
= usb_get_configuration(udev
);
1507 dev_err(&udev
->dev
, "can't read configurations, error %d\n",
1512 if (udev
->wusb
== 1 && udev
->authorized
== 0) {
1513 udev
->product
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1514 udev
->manufacturer
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1515 udev
->serial
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1518 /* read the standard strings and cache them if present */
1519 udev
->product
= usb_cache_string(udev
, udev
->descriptor
.iProduct
);
1520 udev
->manufacturer
= usb_cache_string(udev
,
1521 udev
->descriptor
.iManufacturer
);
1522 udev
->serial
= usb_cache_string(udev
, udev
->descriptor
.iSerialNumber
);
1524 err
= usb_configure_device_otg(udev
);
1531 * usb_new_device - perform initial device setup (usbcore-internal)
1532 * @udev: newly addressed device (in ADDRESS state)
1534 * This is called with devices which have been enumerated, but not yet
1535 * configured. The device descriptor is available, but not descriptors
1536 * for any device configuration. The caller must have locked either
1537 * the parent hub (if udev is a normal device) or else the
1538 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1539 * udev has already been installed, but udev is not yet visible through
1540 * sysfs or other filesystem code.
1542 * It will return if the device is configured properly or not. Zero if
1543 * the interface was registered with the driver core; else a negative
1546 * This call is synchronous, and may not be used in an interrupt context.
1548 * Only the hub driver or root-hub registrar should ever call this.
1550 int usb_new_device(struct usb_device
*udev
)
1554 usb_detect_quirks(udev
); /* Determine quirks */
1555 err
= usb_configure_device(udev
); /* detect & probe dev/intfs */
1558 /* export the usbdev device-node for libusb */
1559 udev
->dev
.devt
= MKDEV(USB_DEVICE_MAJOR
,
1560 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
1562 /* Increment the parent's count of unsuspended children */
1564 usb_autoresume_device(udev
->parent
);
1566 /* Register the device. The device driver is responsible
1567 * for adding the device files to sysfs and for configuring
1570 err
= device_add(&udev
->dev
);
1572 dev_err(&udev
->dev
, "can't device_add, error %d\n", err
);
1576 /* put device-specific files into sysfs */
1577 usb_create_sysfs_dev_files(udev
);
1579 /* Tell the world! */
1580 announce_device(udev
);
1584 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
1590 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
1591 * @usb_dev: USB device
1593 * Move the USB device to a very basic state where interfaces are disabled
1594 * and the device is in fact unconfigured and unusable.
1596 * We share a lock (that we have) with device_del(), so we need to
1599 int usb_deauthorize_device(struct usb_device
*usb_dev
)
1602 usb_lock_device(usb_dev
);
1603 if (usb_dev
->authorized
== 0)
1604 goto out_unauthorized
;
1605 usb_dev
->authorized
= 0;
1606 usb_set_configuration(usb_dev
, -1);
1607 usb_dev
->product
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1608 usb_dev
->manufacturer
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1609 usb_dev
->serial
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1610 kfree(usb_dev
->config
);
1611 usb_dev
->config
= NULL
;
1612 for (cnt
= 0; cnt
< usb_dev
->descriptor
.bNumConfigurations
; cnt
++)
1613 kfree(usb_dev
->rawdescriptors
[cnt
]);
1614 usb_dev
->descriptor
.bNumConfigurations
= 0;
1615 kfree(usb_dev
->rawdescriptors
);
1617 usb_unlock_device(usb_dev
);
1622 int usb_authorize_device(struct usb_device
*usb_dev
)
1625 usb_lock_device(usb_dev
);
1626 if (usb_dev
->authorized
== 1)
1627 goto out_authorized
;
1628 kfree(usb_dev
->product
);
1629 usb_dev
->product
= NULL
;
1630 kfree(usb_dev
->manufacturer
);
1631 usb_dev
->manufacturer
= NULL
;
1632 kfree(usb_dev
->serial
);
1633 usb_dev
->serial
= NULL
;
1634 result
= usb_autoresume_device(usb_dev
);
1636 dev_err(&usb_dev
->dev
,
1637 "can't autoresume for authorization: %d\n", result
);
1638 goto error_autoresume
;
1640 result
= usb_get_device_descriptor(usb_dev
, sizeof(usb_dev
->descriptor
));
1642 dev_err(&usb_dev
->dev
, "can't re-read device descriptor for "
1643 "authorization: %d\n", result
);
1644 goto error_device_descriptor
;
1646 usb_dev
->authorized
= 1;
1647 result
= usb_configure_device(usb_dev
);
1649 goto error_configure
;
1650 /* Choose and set the configuration. This registers the interfaces
1651 * with the driver core and lets interface drivers bind to them.
1653 c
= usb_choose_configuration(usb_dev
);
1655 result
= usb_set_configuration(usb_dev
, c
);
1657 dev_err(&usb_dev
->dev
,
1658 "can't set config #%d, error %d\n", c
, result
);
1659 /* This need not be fatal. The user can try to
1660 * set other configurations. */
1663 dev_info(&usb_dev
->dev
, "authorized to connect\n");
1665 error_device_descriptor
:
1668 usb_unlock_device(usb_dev
); // complements locktree
1673 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
1674 static unsigned hub_is_wusb(struct usb_hub
*hub
)
1676 struct usb_hcd
*hcd
;
1677 if (hub
->hdev
->parent
!= NULL
) /* not a root hub? */
1679 hcd
= container_of(hub
->hdev
->bus
, struct usb_hcd
, self
);
1680 return hcd
->wireless
;
1684 #define PORT_RESET_TRIES 5
1685 #define SET_ADDRESS_TRIES 2
1686 #define GET_DESCRIPTOR_TRIES 2
1687 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1688 #define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1690 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1691 #define HUB_SHORT_RESET_TIME 10
1692 #define HUB_LONG_RESET_TIME 200
1693 #define HUB_RESET_TIMEOUT 500
1695 static int hub_port_wait_reset(struct usb_hub
*hub
, int port1
,
1696 struct usb_device
*udev
, unsigned int delay
)
1698 int delay_time
, ret
;
1702 for (delay_time
= 0;
1703 delay_time
< HUB_RESET_TIMEOUT
;
1704 delay_time
+= delay
) {
1705 /* wait to give the device a chance to reset */
1708 /* read and decode port status */
1709 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
1713 /* Device went away? */
1714 if (!(portstatus
& USB_PORT_STAT_CONNECTION
))
1717 /* bomb out completely if the connection bounced */
1718 if ((portchange
& USB_PORT_STAT_C_CONNECTION
))
1721 /* if we`ve finished resetting, then break out of the loop */
1722 if (!(portstatus
& USB_PORT_STAT_RESET
) &&
1723 (portstatus
& USB_PORT_STAT_ENABLE
)) {
1724 if (hub_is_wusb(hub
))
1725 udev
->speed
= USB_SPEED_VARIABLE
;
1726 else if (portstatus
& USB_PORT_STAT_HIGH_SPEED
)
1727 udev
->speed
= USB_SPEED_HIGH
;
1728 else if (portstatus
& USB_PORT_STAT_LOW_SPEED
)
1729 udev
->speed
= USB_SPEED_LOW
;
1731 udev
->speed
= USB_SPEED_FULL
;
1735 /* switch to the long delay after two short delay failures */
1736 if (delay_time
>= 2 * HUB_SHORT_RESET_TIME
)
1737 delay
= HUB_LONG_RESET_TIME
;
1739 dev_dbg (hub
->intfdev
,
1740 "port %d not reset yet, waiting %dms\n",
1747 static int hub_port_reset(struct usb_hub
*hub
, int port1
,
1748 struct usb_device
*udev
, unsigned int delay
)
1752 /* Block EHCI CF initialization during the port reset.
1753 * Some companion controllers don't like it when they mix.
1755 down_read(&ehci_cf_port_reset_rwsem
);
1757 /* Reset the port */
1758 for (i
= 0; i
< PORT_RESET_TRIES
; i
++) {
1759 status
= set_port_feature(hub
->hdev
,
1760 port1
, USB_PORT_FEAT_RESET
);
1762 dev_err(hub
->intfdev
,
1763 "cannot reset port %d (err = %d)\n",
1766 status
= hub_port_wait_reset(hub
, port1
, udev
, delay
);
1767 if (status
&& status
!= -ENOTCONN
)
1768 dev_dbg(hub
->intfdev
,
1769 "port_wait_reset: err = %d\n",
1773 /* return on disconnect or reset */
1776 /* TRSTRCY = 10 ms; plus some extra */
1778 update_address(udev
, 0);
1782 clear_port_feature(hub
->hdev
,
1783 port1
, USB_PORT_FEAT_C_RESET
);
1784 /* FIXME need disconnect() for NOTATTACHED device */
1785 usb_set_device_state(udev
, status
1786 ? USB_STATE_NOTATTACHED
1787 : USB_STATE_DEFAULT
);
1791 dev_dbg (hub
->intfdev
,
1792 "port %d not enabled, trying reset again...\n",
1794 delay
= HUB_LONG_RESET_TIME
;
1797 dev_err (hub
->intfdev
,
1798 "Cannot enable port %i. Maybe the USB cable is bad?\n",
1802 up_read(&ehci_cf_port_reset_rwsem
);
1808 #define MASK_BITS (USB_PORT_STAT_POWER | USB_PORT_STAT_CONNECTION | \
1809 USB_PORT_STAT_SUSPEND)
1810 #define WANT_BITS (USB_PORT_STAT_POWER | USB_PORT_STAT_CONNECTION)
1812 /* Determine whether the device on a port is ready for a normal resume,
1813 * is ready for a reset-resume, or should be disconnected.
1815 static int check_port_resume_type(struct usb_device
*udev
,
1816 struct usb_hub
*hub
, int port1
,
1817 int status
, unsigned portchange
, unsigned portstatus
)
1819 /* Is the device still present? */
1820 if (status
|| (portstatus
& MASK_BITS
) != WANT_BITS
) {
1825 /* Can't do a normal resume if the port isn't enabled */
1826 else if (!(portstatus
& USB_PORT_STAT_ENABLE
) && !udev
->reset_resume
)
1830 dev_dbg(hub
->intfdev
,
1831 "port %d status %04x.%04x after resume, %d\n",
1832 port1
, portchange
, portstatus
, status
);
1833 } else if (udev
->reset_resume
) {
1835 /* Late port handoff can set status-change bits */
1836 if (portchange
& USB_PORT_STAT_C_CONNECTION
)
1837 clear_port_feature(hub
->hdev
, port1
,
1838 USB_PORT_FEAT_C_CONNECTION
);
1839 if (portchange
& USB_PORT_STAT_C_ENABLE
)
1840 clear_port_feature(hub
->hdev
, port1
,
1841 USB_PORT_FEAT_C_ENABLE
);
1847 #ifdef CONFIG_USB_SUSPEND
1850 * usb_port_suspend - suspend a usb device's upstream port
1851 * @udev: device that's no longer in active use, not a root hub
1852 * Context: must be able to sleep; device not locked; pm locks held
1854 * Suspends a USB device that isn't in active use, conserving power.
1855 * Devices may wake out of a suspend, if anything important happens,
1856 * using the remote wakeup mechanism. They may also be taken out of
1857 * suspend by the host, using usb_port_resume(). It's also routine
1858 * to disconnect devices while they are suspended.
1860 * This only affects the USB hardware for a device; its interfaces
1861 * (and, for hubs, child devices) must already have been suspended.
1863 * Selective port suspend reduces power; most suspended devices draw
1864 * less than 500 uA. It's also used in OTG, along with remote wakeup.
1865 * All devices below the suspended port are also suspended.
1867 * Devices leave suspend state when the host wakes them up. Some devices
1868 * also support "remote wakeup", where the device can activate the USB
1869 * tree above them to deliver data, such as a keypress or packet. In
1870 * some cases, this wakes the USB host.
1872 * Suspending OTG devices may trigger HNP, if that's been enabled
1873 * between a pair of dual-role devices. That will change roles, such
1874 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
1876 * Devices on USB hub ports have only one "suspend" state, corresponding
1877 * to ACPI D2, "may cause the device to lose some context".
1878 * State transitions include:
1880 * - suspend, resume ... when the VBUS power link stays live
1881 * - suspend, disconnect ... VBUS lost
1883 * Once VBUS drop breaks the circuit, the port it's using has to go through
1884 * normal re-enumeration procedures, starting with enabling VBUS power.
1885 * Other than re-initializing the hub (plug/unplug, except for root hubs),
1886 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
1887 * timer, no SRP, no requests through sysfs.
1889 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
1890 * the root hub for their bus goes into global suspend ... so we don't
1891 * (falsely) update the device power state to say it suspended.
1893 * Returns 0 on success, else negative errno.
1895 int usb_port_suspend(struct usb_device
*udev
)
1897 struct usb_hub
*hub
= hdev_to_hub(udev
->parent
);
1898 int port1
= udev
->portnum
;
1901 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
1903 /* enable remote wakeup when appropriate; this lets the device
1904 * wake up the upstream hub (including maybe the root hub).
1906 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
1907 * we don't explicitly enable it here.
1909 if (udev
->do_remote_wakeup
) {
1910 status
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
1911 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
1912 USB_DEVICE_REMOTE_WAKEUP
, 0,
1914 USB_CTRL_SET_TIMEOUT
);
1916 dev_dbg(&udev
->dev
, "won't remote wakeup, status %d\n",
1921 status
= set_port_feature(hub
->hdev
, port1
, USB_PORT_FEAT_SUSPEND
);
1923 dev_dbg(hub
->intfdev
, "can't suspend port %d, status %d\n",
1925 /* paranoia: "should not happen" */
1926 (void) usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
1927 USB_REQ_CLEAR_FEATURE
, USB_RECIP_DEVICE
,
1928 USB_DEVICE_REMOTE_WAKEUP
, 0,
1930 USB_CTRL_SET_TIMEOUT
);
1932 /* device has up to 10 msec to fully suspend */
1933 dev_dbg(&udev
->dev
, "usb %ssuspend\n",
1934 udev
->auto_pm
? "auto-" : "");
1935 usb_set_device_state(udev
, USB_STATE_SUSPENDED
);
1942 * If the USB "suspend" state is in use (rather than "global suspend"),
1943 * many devices will be individually taken out of suspend state using
1944 * special "resume" signaling. This routine kicks in shortly after
1945 * hardware resume signaling is finished, either because of selective
1946 * resume (by host) or remote wakeup (by device) ... now see what changed
1947 * in the tree that's rooted at this device.
1949 * If @udev->reset_resume is set then the device is reset before the
1950 * status check is done.
1952 static int finish_port_resume(struct usb_device
*udev
)
1957 /* caller owns the udev device lock */
1958 dev_dbg(&udev
->dev
, "finish %sresume\n",
1959 udev
->reset_resume
? "reset-" : "");
1961 /* usb ch9 identifies four variants of SUSPENDED, based on what
1962 * state the device resumes to. Linux currently won't see the
1963 * first two on the host side; they'd be inside hub_port_init()
1964 * during many timeouts, but khubd can't suspend until later.
1966 usb_set_device_state(udev
, udev
->actconfig
1967 ? USB_STATE_CONFIGURED
1968 : USB_STATE_ADDRESS
);
1970 /* 10.5.4.5 says not to reset a suspended port if the attached
1971 * device is enabled for remote wakeup. Hence the reset
1972 * operation is carried out here, after the port has been
1975 if (udev
->reset_resume
)
1976 status
= usb_reset_and_verify_device(udev
);
1978 /* 10.5.4.5 says be sure devices in the tree are still there.
1979 * For now let's assume the device didn't go crazy on resume,
1980 * and device drivers will know about any resume quirks.
1984 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0, &devstatus
);
1986 status
= (status
> 0 ? 0 : -ENODEV
);
1990 dev_dbg(&udev
->dev
, "gone after usb resume? status %d\n",
1992 } else if (udev
->actconfig
) {
1993 le16_to_cpus(&devstatus
);
1994 if (devstatus
& (1 << USB_DEVICE_REMOTE_WAKEUP
)) {
1995 status
= usb_control_msg(udev
,
1996 usb_sndctrlpipe(udev
, 0),
1997 USB_REQ_CLEAR_FEATURE
,
1999 USB_DEVICE_REMOTE_WAKEUP
, 0,
2001 USB_CTRL_SET_TIMEOUT
);
2003 dev_dbg(&udev
->dev
, "disable remote "
2004 "wakeup, status %d\n", status
);
2012 * usb_port_resume - re-activate a suspended usb device's upstream port
2013 * @udev: device to re-activate, not a root hub
2014 * Context: must be able to sleep; device not locked; pm locks held
2016 * This will re-activate the suspended device, increasing power usage
2017 * while letting drivers communicate again with its endpoints.
2018 * USB resume explicitly guarantees that the power session between
2019 * the host and the device is the same as it was when the device
2022 * If @udev->reset_resume is set then this routine won't check that the
2023 * port is still enabled. Furthermore, finish_port_resume() above will
2024 * reset @udev. The end result is that a broken power session can be
2025 * recovered and @udev will appear to persist across a loss of VBUS power.
2027 * For example, if a host controller doesn't maintain VBUS suspend current
2028 * during a system sleep or is reset when the system wakes up, all the USB
2029 * power sessions below it will be broken. This is especially troublesome
2030 * for mass-storage devices containing mounted filesystems, since the
2031 * device will appear to have disconnected and all the memory mappings
2032 * to it will be lost. Using the USB_PERSIST facility, the device can be
2033 * made to appear as if it had not disconnected.
2035 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
2036 * every effort to insure that the same device is present after the
2037 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
2038 * quite possible for a device to remain unaltered but its media to be
2039 * changed. If the user replaces a flash memory card while the system is
2040 * asleep, he will have only himself to blame when the filesystem on the
2041 * new card is corrupted and the system crashes.
2043 * Returns 0 on success, else negative errno.
2045 int usb_port_resume(struct usb_device
*udev
)
2047 struct usb_hub
*hub
= hdev_to_hub(udev
->parent
);
2048 int port1
= udev
->portnum
;
2050 u16 portchange
, portstatus
;
2052 /* Skip the initial Clear-Suspend step for a remote wakeup */
2053 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
2054 if (status
== 0 && !(portstatus
& USB_PORT_STAT_SUSPEND
))
2055 goto SuspendCleared
;
2057 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
2059 set_bit(port1
, hub
->busy_bits
);
2061 /* see 7.1.7.7; affects power usage, but not budgeting */
2062 status
= clear_port_feature(hub
->hdev
,
2063 port1
, USB_PORT_FEAT_SUSPEND
);
2065 dev_dbg(hub
->intfdev
, "can't resume port %d, status %d\n",
2068 /* drive resume for at least 20 msec */
2069 dev_dbg(&udev
->dev
, "usb %sresume\n",
2070 udev
->auto_pm
? "auto-" : "");
2073 /* Virtual root hubs can trigger on GET_PORT_STATUS to
2074 * stop resume signaling. Then finish the resume
2077 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
2079 /* TRSMRCY = 10 msec */
2085 if (portchange
& USB_PORT_STAT_C_SUSPEND
)
2086 clear_port_feature(hub
->hdev
, port1
,
2087 USB_PORT_FEAT_C_SUSPEND
);
2090 clear_bit(port1
, hub
->busy_bits
);
2091 if (!hub
->hdev
->parent
&& !hub
->busy_bits
[0])
2092 usb_enable_root_hub_irq(hub
->hdev
->bus
);
2094 status
= check_port_resume_type(udev
,
2095 hub
, port1
, status
, portchange
, portstatus
);
2097 status
= finish_port_resume(udev
);
2099 dev_dbg(&udev
->dev
, "can't resume, status %d\n", status
);
2100 hub_port_logical_disconnect(hub
, port1
);
2105 /* caller has locked udev */
2106 static int remote_wakeup(struct usb_device
*udev
)
2110 if (udev
->state
== USB_STATE_SUSPENDED
) {
2111 dev_dbg(&udev
->dev
, "usb %sresume\n", "wakeup-");
2112 usb_mark_last_busy(udev
);
2113 status
= usb_external_resume_device(udev
);
2118 #else /* CONFIG_USB_SUSPEND */
2120 /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
2122 int usb_port_suspend(struct usb_device
*udev
)
2127 /* However we may need to do a reset-resume */
2129 int usb_port_resume(struct usb_device
*udev
)
2131 struct usb_hub
*hub
= hdev_to_hub(udev
->parent
);
2132 int port1
= udev
->portnum
;
2134 u16 portchange
, portstatus
;
2136 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
2137 status
= check_port_resume_type(udev
,
2138 hub
, port1
, status
, portchange
, portstatus
);
2141 dev_dbg(&udev
->dev
, "can't resume, status %d\n", status
);
2142 hub_port_logical_disconnect(hub
, port1
);
2143 } else if (udev
->reset_resume
) {
2144 dev_dbg(&udev
->dev
, "reset-resume\n");
2145 status
= usb_reset_and_verify_device(udev
);
2150 static inline int remote_wakeup(struct usb_device
*udev
)
2157 static int hub_suspend(struct usb_interface
*intf
, pm_message_t msg
)
2159 struct usb_hub
*hub
= usb_get_intfdata (intf
);
2160 struct usb_device
*hdev
= hub
->hdev
;
2163 /* fail if children aren't already suspended */
2164 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
2165 struct usb_device
*udev
;
2167 udev
= hdev
->children
[port1
-1];
2168 if (udev
&& udev
->can_submit
) {
2170 dev_dbg(&intf
->dev
, "port %d nyet suspended\n",
2176 dev_dbg(&intf
->dev
, "%s\n", __func__
);
2178 /* stop khubd and related activity */
2179 hub_quiesce(hub
, HUB_SUSPEND
);
2183 static int hub_resume(struct usb_interface
*intf
)
2185 struct usb_hub
*hub
= usb_get_intfdata(intf
);
2187 dev_dbg(&intf
->dev
, "%s\n", __func__
);
2188 hub_activate(hub
, HUB_RESUME
);
2192 static int hub_reset_resume(struct usb_interface
*intf
)
2194 struct usb_hub
*hub
= usb_get_intfdata(intf
);
2196 dev_dbg(&intf
->dev
, "%s\n", __func__
);
2197 hub_activate(hub
, HUB_RESET_RESUME
);
2202 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
2203 * @rhdev: struct usb_device for the root hub
2205 * The USB host controller driver calls this function when its root hub
2206 * is resumed and Vbus power has been interrupted or the controller
2207 * has been reset. The routine marks @rhdev as having lost power.
2208 * When the hub driver is resumed it will take notice and carry out
2209 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
2210 * the others will be disconnected.
2212 void usb_root_hub_lost_power(struct usb_device
*rhdev
)
2214 dev_warn(&rhdev
->dev
, "root hub lost power or was reset\n");
2215 rhdev
->reset_resume
= 1;
2217 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power
);
2219 #else /* CONFIG_PM */
2221 static inline int remote_wakeup(struct usb_device
*udev
)
2226 #define hub_suspend NULL
2227 #define hub_resume NULL
2228 #define hub_reset_resume NULL
2232 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2234 * Between connect detection and reset signaling there must be a delay
2235 * of 100ms at least for debounce and power-settling. The corresponding
2236 * timer shall restart whenever the downstream port detects a disconnect.
2238 * Apparently there are some bluetooth and irda-dongles and a number of
2239 * low-speed devices for which this debounce period may last over a second.
2240 * Not covered by the spec - but easy to deal with.
2242 * This implementation uses a 1500ms total debounce timeout; if the
2243 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2244 * every 25ms for transient disconnects. When the port status has been
2245 * unchanged for 100ms it returns the port status.
2247 static int hub_port_debounce(struct usb_hub
*hub
, int port1
)
2250 int total_time
, stable_time
= 0;
2251 u16 portchange
, portstatus
;
2252 unsigned connection
= 0xffff;
2254 for (total_time
= 0; ; total_time
+= HUB_DEBOUNCE_STEP
) {
2255 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
2259 if (!(portchange
& USB_PORT_STAT_C_CONNECTION
) &&
2260 (portstatus
& USB_PORT_STAT_CONNECTION
) == connection
) {
2261 stable_time
+= HUB_DEBOUNCE_STEP
;
2262 if (stable_time
>= HUB_DEBOUNCE_STABLE
)
2266 connection
= portstatus
& USB_PORT_STAT_CONNECTION
;
2269 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
2270 clear_port_feature(hub
->hdev
, port1
,
2271 USB_PORT_FEAT_C_CONNECTION
);
2274 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
2276 msleep(HUB_DEBOUNCE_STEP
);
2279 dev_dbg (hub
->intfdev
,
2280 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2281 port1
, total_time
, stable_time
, portstatus
);
2283 if (stable_time
< HUB_DEBOUNCE_STABLE
)
2288 void usb_ep0_reinit(struct usb_device
*udev
)
2290 usb_disable_endpoint(udev
, 0 + USB_DIR_IN
);
2291 usb_disable_endpoint(udev
, 0 + USB_DIR_OUT
);
2292 usb_enable_endpoint(udev
, &udev
->ep0
);
2294 EXPORT_SYMBOL_GPL(usb_ep0_reinit
);
2296 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2297 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2299 static int hub_set_address(struct usb_device
*udev
, int devnum
)
2305 if (udev
->state
== USB_STATE_ADDRESS
)
2307 if (udev
->state
!= USB_STATE_DEFAULT
)
2309 retval
= usb_control_msg(udev
, usb_sndaddr0pipe(),
2310 USB_REQ_SET_ADDRESS
, 0, devnum
, 0,
2311 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
2313 /* Device now using proper address. */
2314 update_address(udev
, devnum
);
2315 usb_set_device_state(udev
, USB_STATE_ADDRESS
);
2316 usb_ep0_reinit(udev
);
2321 /* Reset device, (re)assign address, get device descriptor.
2322 * Device connection must be stable, no more debouncing needed.
2323 * Returns device in USB_STATE_ADDRESS, except on error.
2325 * If this is called for an already-existing device (as part of
2326 * usb_reset_and_verify_device), the caller must own the device lock. For a
2327 * newly detected device that is not accessible through any global
2328 * pointers, it's not necessary to lock the device.
2331 hub_port_init (struct usb_hub
*hub
, struct usb_device
*udev
, int port1
,
2334 static DEFINE_MUTEX(usb_address0_mutex
);
2336 struct usb_device
*hdev
= hub
->hdev
;
2338 unsigned delay
= HUB_SHORT_RESET_TIME
;
2339 enum usb_device_speed oldspeed
= udev
->speed
;
2341 int devnum
= udev
->devnum
;
2343 /* root hub ports have a slightly longer reset period
2344 * (from USB 2.0 spec, section 7.1.7.5)
2346 if (!hdev
->parent
) {
2347 delay
= HUB_ROOT_RESET_TIME
;
2348 if (port1
== hdev
->bus
->otg_port
)
2349 hdev
->bus
->b_hnp_enable
= 0;
2352 /* Some low speed devices have problems with the quick delay, so */
2353 /* be a bit pessimistic with those devices. RHbug #23670 */
2354 if (oldspeed
== USB_SPEED_LOW
)
2355 delay
= HUB_LONG_RESET_TIME
;
2357 mutex_lock(&usb_address0_mutex
);
2359 /* Reset the device; full speed may morph to high speed */
2360 retval
= hub_port_reset(hub
, port1
, udev
, delay
);
2361 if (retval
< 0) /* error or disconnect */
2363 /* success, speed is known */
2366 if (oldspeed
!= USB_SPEED_UNKNOWN
&& oldspeed
!= udev
->speed
) {
2367 dev_dbg(&udev
->dev
, "device reset changed speed!\n");
2370 oldspeed
= udev
->speed
;
2372 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2373 * it's fixed size except for full speed devices.
2374 * For Wireless USB devices, ep0 max packet is always 512 (tho
2375 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
2377 switch (udev
->speed
) {
2378 case USB_SPEED_VARIABLE
: /* fixed at 512 */
2379 udev
->ep0
.desc
.wMaxPacketSize
= __constant_cpu_to_le16(512);
2381 case USB_SPEED_HIGH
: /* fixed at 64 */
2382 udev
->ep0
.desc
.wMaxPacketSize
= __constant_cpu_to_le16(64);
2384 case USB_SPEED_FULL
: /* 8, 16, 32, or 64 */
2385 /* to determine the ep0 maxpacket size, try to read
2386 * the device descriptor to get bMaxPacketSize0 and
2387 * then correct our initial guess.
2389 udev
->ep0
.desc
.wMaxPacketSize
= __constant_cpu_to_le16(64);
2391 case USB_SPEED_LOW
: /* fixed at 8 */
2392 udev
->ep0
.desc
.wMaxPacketSize
= __constant_cpu_to_le16(8);
2399 switch (udev
->speed
) {
2400 case USB_SPEED_LOW
: speed
= "low"; break;
2401 case USB_SPEED_FULL
: speed
= "full"; break;
2402 case USB_SPEED_HIGH
: speed
= "high"; break;
2403 case USB_SPEED_VARIABLE
:
2407 default: speed
= "?"; break;
2409 dev_info (&udev
->dev
,
2410 "%s %s speed %sUSB device using %s and address %d\n",
2411 (udev
->config
) ? "reset" : "new", speed
, type
,
2412 udev
->bus
->controller
->driver
->name
, devnum
);
2414 /* Set up TT records, if needed */
2416 udev
->tt
= hdev
->tt
;
2417 udev
->ttport
= hdev
->ttport
;
2418 } else if (udev
->speed
!= USB_SPEED_HIGH
2419 && hdev
->speed
== USB_SPEED_HIGH
) {
2420 udev
->tt
= &hub
->tt
;
2421 udev
->ttport
= port1
;
2424 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2425 * Because device hardware and firmware is sometimes buggy in
2426 * this area, and this is how Linux has done it for ages.
2427 * Change it cautiously.
2429 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2430 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2431 * so it may help with some non-standards-compliant devices.
2432 * Otherwise we start with SET_ADDRESS and then try to read the
2433 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2436 for (i
= 0; i
< GET_DESCRIPTOR_TRIES
; (++i
, msleep(100))) {
2437 if (USE_NEW_SCHEME(retry_counter
)) {
2438 struct usb_device_descriptor
*buf
;
2441 #define GET_DESCRIPTOR_BUFSIZE 64
2442 buf
= kmalloc(GET_DESCRIPTOR_BUFSIZE
, GFP_NOIO
);
2448 /* Retry on all errors; some devices are flakey.
2449 * 255 is for WUSB devices, we actually need to use
2450 * 512 (WUSB1.0[4.8.1]).
2452 for (j
= 0; j
< 3; ++j
) {
2453 buf
->bMaxPacketSize0
= 0;
2454 r
= usb_control_msg(udev
, usb_rcvaddr0pipe(),
2455 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
,
2456 USB_DT_DEVICE
<< 8, 0,
2457 buf
, GET_DESCRIPTOR_BUFSIZE
,
2458 USB_CTRL_GET_TIMEOUT
);
2459 switch (buf
->bMaxPacketSize0
) {
2460 case 8: case 16: case 32: case 64: case 255:
2461 if (buf
->bDescriptorType
==
2475 udev
->descriptor
.bMaxPacketSize0
=
2476 buf
->bMaxPacketSize0
;
2479 retval
= hub_port_reset(hub
, port1
, udev
, delay
);
2480 if (retval
< 0) /* error or disconnect */
2482 if (oldspeed
!= udev
->speed
) {
2484 "device reset changed speed!\n");
2489 dev_err(&udev
->dev
, "device descriptor "
2490 "read/%s, error %d\n",
2495 #undef GET_DESCRIPTOR_BUFSIZE
2499 * If device is WUSB, we already assigned an
2500 * unauthorized address in the Connect Ack sequence;
2501 * authorization will assign the final address.
2503 if (udev
->wusb
== 0) {
2504 for (j
= 0; j
< SET_ADDRESS_TRIES
; ++j
) {
2505 retval
= hub_set_address(udev
, devnum
);
2512 "device not accepting address %d, error %d\n",
2517 /* cope with hardware quirkiness:
2518 * - let SET_ADDRESS settle, some device hardware wants it
2519 * - read ep0 maxpacket even for high and low speed,
2522 if (USE_NEW_SCHEME(retry_counter
))
2526 retval
= usb_get_device_descriptor(udev
, 8);
2528 dev_err(&udev
->dev
, "device descriptor "
2529 "read/%s, error %d\n",
2541 i
= udev
->descriptor
.bMaxPacketSize0
== 0xff? /* wusb device? */
2542 512 : udev
->descriptor
.bMaxPacketSize0
;
2543 if (le16_to_cpu(udev
->ep0
.desc
.wMaxPacketSize
) != i
) {
2544 if (udev
->speed
!= USB_SPEED_FULL
||
2545 !(i
== 8 || i
== 16 || i
== 32 || i
== 64)) {
2546 dev_err(&udev
->dev
, "ep0 maxpacket = %d\n", i
);
2550 dev_dbg(&udev
->dev
, "ep0 maxpacket = %d\n", i
);
2551 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(i
);
2552 usb_ep0_reinit(udev
);
2555 retval
= usb_get_device_descriptor(udev
, USB_DT_DEVICE_SIZE
);
2556 if (retval
< (signed)sizeof(udev
->descriptor
)) {
2557 dev_err(&udev
->dev
, "device descriptor read/%s, error %d\n",
2568 hub_port_disable(hub
, port1
, 0);
2569 update_address(udev
, devnum
); /* for disconnect processing */
2571 mutex_unlock(&usb_address0_mutex
);
2576 check_highspeed (struct usb_hub
*hub
, struct usb_device
*udev
, int port1
)
2578 struct usb_qualifier_descriptor
*qual
;
2581 qual
= kmalloc (sizeof *qual
, GFP_KERNEL
);
2585 status
= usb_get_descriptor (udev
, USB_DT_DEVICE_QUALIFIER
, 0,
2586 qual
, sizeof *qual
);
2587 if (status
== sizeof *qual
) {
2588 dev_info(&udev
->dev
, "not running at top speed; "
2589 "connect to a high speed hub\n");
2590 /* hub LEDs are probably harder to miss than syslog */
2591 if (hub
->has_indicators
) {
2592 hub
->indicator
[port1
-1] = INDICATOR_GREEN_BLINK
;
2593 schedule_delayed_work (&hub
->leds
, 0);
2600 hub_power_remaining (struct usb_hub
*hub
)
2602 struct usb_device
*hdev
= hub
->hdev
;
2606 if (!hub
->limited_power
)
2609 remaining
= hdev
->bus_mA
- hub
->descriptor
->bHubContrCurrent
;
2610 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
2611 struct usb_device
*udev
= hdev
->children
[port1
- 1];
2617 /* Unconfigured devices may not use more than 100mA,
2618 * or 8mA for OTG ports */
2619 if (udev
->actconfig
)
2620 delta
= udev
->actconfig
->desc
.bMaxPower
* 2;
2621 else if (port1
!= udev
->bus
->otg_port
|| hdev
->parent
)
2625 if (delta
> hub
->mA_per_port
)
2626 dev_warn(&udev
->dev
, "%dmA is over %umA budget "
2628 delta
, hub
->mA_per_port
, port1
);
2631 if (remaining
< 0) {
2632 dev_warn(hub
->intfdev
, "%dmA over power budget!\n",
2639 /* Handle physical or logical connection change events.
2640 * This routine is called when:
2641 * a port connection-change occurs;
2642 * a port enable-change occurs (often caused by EMI);
2643 * usb_reset_and_verify_device() encounters changed descriptors (as from
2644 * a firmware download)
2645 * caller already locked the hub
2647 static void hub_port_connect_change(struct usb_hub
*hub
, int port1
,
2648 u16 portstatus
, u16 portchange
)
2650 struct usb_device
*hdev
= hub
->hdev
;
2651 struct device
*hub_dev
= hub
->intfdev
;
2652 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
2653 unsigned wHubCharacteristics
=
2654 le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
2655 struct usb_device
*udev
;
2659 "port %d, status %04x, change %04x, %s\n",
2660 port1
, portstatus
, portchange
, portspeed (portstatus
));
2662 if (hub
->has_indicators
) {
2663 set_port_led(hub
, port1
, HUB_LED_AUTO
);
2664 hub
->indicator
[port1
-1] = INDICATOR_AUTO
;
2667 #ifdef CONFIG_USB_OTG
2668 /* during HNP, don't repeat the debounce */
2669 if (hdev
->bus
->is_b_host
)
2670 portchange
&= ~(USB_PORT_STAT_C_CONNECTION
|
2671 USB_PORT_STAT_C_ENABLE
);
2674 /* Try to use the debounce delay for protection against
2675 * port-enable changes caused, for example, by EMI.
2677 if (portchange
& (USB_PORT_STAT_C_CONNECTION
|
2678 USB_PORT_STAT_C_ENABLE
)) {
2679 status
= hub_port_debounce(hub
, port1
);
2681 if (printk_ratelimit())
2682 dev_err (hub_dev
, "connect-debounce failed, "
2683 "port %d disabled\n", port1
);
2684 portstatus
&= ~USB_PORT_STAT_CONNECTION
;
2686 portstatus
= status
;
2690 /* Try to resuscitate an existing device */
2691 udev
= hdev
->children
[port1
-1];
2692 if ((portstatus
& USB_PORT_STAT_CONNECTION
) && udev
&&
2693 udev
->state
!= USB_STATE_NOTATTACHED
) {
2695 usb_lock_device(udev
);
2696 if (portstatus
& USB_PORT_STAT_ENABLE
) {
2697 status
= 0; /* Nothing to do */
2698 } else if (!udev
->persist_enabled
) {
2699 status
= -ENODEV
; /* Mustn't resuscitate */
2701 #ifdef CONFIG_USB_SUSPEND
2702 } else if (udev
->state
== USB_STATE_SUSPENDED
) {
2703 /* For a suspended device, treat this as a
2704 * remote wakeup event.
2706 if (udev
->do_remote_wakeup
)
2707 status
= remote_wakeup(udev
);
2709 /* Otherwise leave it be; devices can't tell the
2710 * difference between suspended and disabled.
2717 status
= usb_reset_device(udev
);
2719 usb_unlock_device(udev
);
2722 clear_bit(port1
, hub
->change_bits
);
2727 /* Disconnect any existing devices under this port */
2729 usb_disconnect(&hdev
->children
[port1
-1]);
2730 clear_bit(port1
, hub
->change_bits
);
2732 /* Return now if debouncing failed or nothing is connected */
2733 if (!(portstatus
& USB_PORT_STAT_CONNECTION
)) {
2735 /* maybe switch power back on (e.g. root hub was reset) */
2736 if ((wHubCharacteristics
& HUB_CHAR_LPSM
) < 2
2737 && !(portstatus
& (1 << USB_PORT_FEAT_POWER
)))
2738 set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
2740 if (portstatus
& USB_PORT_STAT_ENABLE
)
2745 for (i
= 0; i
< SET_CONFIG_TRIES
; i
++) {
2747 /* reallocate for each attempt, since references
2748 * to the previous one can escape in various ways
2750 udev
= usb_alloc_dev(hdev
, hdev
->bus
, port1
);
2753 "couldn't allocate port %d usb_device\n",
2758 usb_set_device_state(udev
, USB_STATE_POWERED
);
2759 udev
->speed
= USB_SPEED_UNKNOWN
;
2760 udev
->bus_mA
= hub
->mA_per_port
;
2761 udev
->level
= hdev
->level
+ 1;
2762 udev
->wusb
= hub_is_wusb(hub
);
2764 /* set the address */
2765 choose_address(udev
);
2766 if (udev
->devnum
<= 0) {
2767 status
= -ENOTCONN
; /* Don't retry */
2771 /* reset and get descriptor */
2772 status
= hub_port_init(hub
, udev
, port1
, i
);
2776 /* consecutive bus-powered hubs aren't reliable; they can
2777 * violate the voltage drop budget. if the new child has
2778 * a "powered" LED, users should notice we didn't enable it
2779 * (without reading syslog), even without per-port LEDs
2782 if (udev
->descriptor
.bDeviceClass
== USB_CLASS_HUB
2783 && udev
->bus_mA
<= 100) {
2786 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0,
2789 dev_dbg(&udev
->dev
, "get status %d ?\n", status
);
2792 le16_to_cpus(&devstat
);
2793 if ((devstat
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
2795 "can't connect bus-powered hub "
2797 if (hub
->has_indicators
) {
2798 hub
->indicator
[port1
-1] =
2799 INDICATOR_AMBER_BLINK
;
2800 schedule_delayed_work (&hub
->leds
, 0);
2802 status
= -ENOTCONN
; /* Don't retry */
2807 /* check for devices running slower than they could */
2808 if (le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0200
2809 && udev
->speed
== USB_SPEED_FULL
2810 && highspeed_hubs
!= 0)
2811 check_highspeed (hub
, udev
, port1
);
2813 /* Store the parent's children[] pointer. At this point
2814 * udev becomes globally accessible, although presumably
2815 * no one will look at it until hdev is unlocked.
2819 /* We mustn't add new devices if the parent hub has
2820 * been disconnected; we would race with the
2821 * recursively_mark_NOTATTACHED() routine.
2823 spin_lock_irq(&device_state_lock
);
2824 if (hdev
->state
== USB_STATE_NOTATTACHED
)
2827 hdev
->children
[port1
-1] = udev
;
2828 spin_unlock_irq(&device_state_lock
);
2830 /* Run it through the hoops (find a driver, etc) */
2832 status
= usb_new_device(udev
);
2834 spin_lock_irq(&device_state_lock
);
2835 hdev
->children
[port1
-1] = NULL
;
2836 spin_unlock_irq(&device_state_lock
);
2843 status
= hub_power_remaining(hub
);
2845 dev_dbg(hub_dev
, "%dmA power budget left\n", status
);
2850 hub_port_disable(hub
, port1
, 1);
2852 usb_ep0_reinit(udev
);
2853 release_address(udev
);
2855 if ((status
== -ENOTCONN
) || (status
== -ENOTSUPP
))
2858 if (hub
->hdev
->parent
||
2859 !hcd
->driver
->port_handed_over
||
2860 !(hcd
->driver
->port_handed_over
)(hcd
, port1
))
2861 dev_err(hub_dev
, "unable to enumerate USB device on port %d\n",
2865 hub_port_disable(hub
, port1
, 1);
2866 if (hcd
->driver
->relinquish_port
&& !hub
->hdev
->parent
)
2867 hcd
->driver
->relinquish_port(hcd
, port1
);
2870 static void hub_events(void)
2872 struct list_head
*tmp
;
2873 struct usb_device
*hdev
;
2874 struct usb_interface
*intf
;
2875 struct usb_hub
*hub
;
2876 struct device
*hub_dev
;
2885 * We restart the list every time to avoid a deadlock with
2886 * deleting hubs downstream from this one. This should be
2887 * safe since we delete the hub from the event list.
2888 * Not the most efficient, but avoids deadlocks.
2892 /* Grab the first entry at the beginning of the list */
2893 spin_lock_irq(&hub_event_lock
);
2894 if (list_empty(&hub_event_list
)) {
2895 spin_unlock_irq(&hub_event_lock
);
2899 tmp
= hub_event_list
.next
;
2902 hub
= list_entry(tmp
, struct usb_hub
, event_list
);
2903 kref_get(&hub
->kref
);
2904 spin_unlock_irq(&hub_event_lock
);
2907 hub_dev
= hub
->intfdev
;
2908 intf
= to_usb_interface(hub_dev
);
2909 dev_dbg(hub_dev
, "state %d ports %d chg %04x evt %04x\n",
2910 hdev
->state
, hub
->descriptor
2911 ? hub
->descriptor
->bNbrPorts
2913 /* NOTE: expects max 15 ports... */
2914 (u16
) hub
->change_bits
[0],
2915 (u16
) hub
->event_bits
[0]);
2917 /* Lock the device, then check to see if we were
2918 * disconnected while waiting for the lock to succeed. */
2919 usb_lock_device(hdev
);
2920 if (unlikely(hub
->disconnected
))
2923 /* If the hub has died, clean up after it */
2924 if (hdev
->state
== USB_STATE_NOTATTACHED
) {
2925 hub
->error
= -ENODEV
;
2926 hub_quiesce(hub
, HUB_DISCONNECT
);
2931 ret
= usb_autopm_get_interface(intf
);
2933 dev_dbg(hub_dev
, "Can't autoresume: %d\n", ret
);
2937 /* If this is an inactive hub, do nothing */
2942 dev_dbg (hub_dev
, "resetting for error %d\n",
2945 ret
= usb_reset_device(hdev
);
2948 "error resetting hub: %d\n", ret
);
2956 /* deal with port status changes */
2957 for (i
= 1; i
<= hub
->descriptor
->bNbrPorts
; i
++) {
2958 if (test_bit(i
, hub
->busy_bits
))
2960 connect_change
= test_bit(i
, hub
->change_bits
);
2961 if (!test_and_clear_bit(i
, hub
->event_bits
) &&
2965 ret
= hub_port_status(hub
, i
,
2966 &portstatus
, &portchange
);
2970 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
2971 clear_port_feature(hdev
, i
,
2972 USB_PORT_FEAT_C_CONNECTION
);
2976 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
2977 if (!connect_change
)
2979 "port %d enable change, "
2982 clear_port_feature(hdev
, i
,
2983 USB_PORT_FEAT_C_ENABLE
);
2986 * EM interference sometimes causes badly
2987 * shielded USB devices to be shutdown by
2988 * the hub, this hack enables them again.
2989 * Works at least with mouse driver.
2991 if (!(portstatus
& USB_PORT_STAT_ENABLE
)
2993 && hdev
->children
[i
-1]) {
2996 "disabled by hub (EMI?), "
3003 if (portchange
& USB_PORT_STAT_C_SUSPEND
) {
3004 struct usb_device
*udev
;
3006 clear_port_feature(hdev
, i
,
3007 USB_PORT_FEAT_C_SUSPEND
);
3008 udev
= hdev
->children
[i
-1];
3010 usb_lock_device(udev
);
3011 ret
= remote_wakeup(hdev
->
3013 usb_unlock_device(udev
);
3018 hub_port_disable(hub
, i
, 1);
3021 "resume on port %d, status %d\n",
3025 if (portchange
& USB_PORT_STAT_C_OVERCURRENT
) {
3027 "over-current change on port %d\n",
3029 clear_port_feature(hdev
, i
,
3030 USB_PORT_FEAT_C_OVER_CURRENT
);
3034 if (portchange
& USB_PORT_STAT_C_RESET
) {
3036 "reset change on port %d\n",
3038 clear_port_feature(hdev
, i
,
3039 USB_PORT_FEAT_C_RESET
);
3043 hub_port_connect_change(hub
, i
,
3044 portstatus
, portchange
);
3047 /* deal with hub status changes */
3048 if (test_and_clear_bit(0, hub
->event_bits
) == 0)
3050 else if (hub_hub_status(hub
, &hubstatus
, &hubchange
) < 0)
3051 dev_err (hub_dev
, "get_hub_status failed\n");
3053 if (hubchange
& HUB_CHANGE_LOCAL_POWER
) {
3054 dev_dbg (hub_dev
, "power change\n");
3055 clear_hub_feature(hdev
, C_HUB_LOCAL_POWER
);
3056 if (hubstatus
& HUB_STATUS_LOCAL_POWER
)
3057 /* FIXME: Is this always true? */
3058 hub
->limited_power
= 1;
3060 hub
->limited_power
= 0;
3062 if (hubchange
& HUB_CHANGE_OVERCURRENT
) {
3063 dev_dbg (hub_dev
, "overcurrent change\n");
3064 msleep(500); /* Cool down */
3065 clear_hub_feature(hdev
, C_HUB_OVER_CURRENT
);
3070 /* If this is a root hub, tell the HCD it's okay to
3071 * re-enable port-change interrupts now. */
3072 if (!hdev
->parent
&& !hub
->busy_bits
[0])
3073 usb_enable_root_hub_irq(hdev
->bus
);
3076 /* Allow autosuspend if we're not going to run again */
3077 if (list_empty(&hub
->event_list
))
3078 usb_autopm_enable(intf
);
3080 usb_unlock_device(hdev
);
3081 kref_put(&hub
->kref
, hub_release
);
3083 } /* end while (1) */
3086 static int hub_thread(void *__unused
)
3088 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
3089 * port handover. Otherwise it might see that a full-speed device
3090 * was gone before the EHCI controller had handed its port over to
3091 * the companion full-speed controller.
3097 wait_event_freezable(khubd_wait
,
3098 !list_empty(&hub_event_list
) ||
3099 kthread_should_stop());
3100 } while (!kthread_should_stop() || !list_empty(&hub_event_list
));
3102 pr_debug("%s: khubd exiting\n", usbcore_name
);
3106 static struct usb_device_id hub_id_table
[] = {
3107 { .match_flags
= USB_DEVICE_ID_MATCH_DEV_CLASS
,
3108 .bDeviceClass
= USB_CLASS_HUB
},
3109 { .match_flags
= USB_DEVICE_ID_MATCH_INT_CLASS
,
3110 .bInterfaceClass
= USB_CLASS_HUB
},
3111 { } /* Terminating entry */
3114 MODULE_DEVICE_TABLE (usb
, hub_id_table
);
3116 static struct usb_driver hub_driver
= {
3119 .disconnect
= hub_disconnect
,
3120 .suspend
= hub_suspend
,
3121 .resume
= hub_resume
,
3122 .reset_resume
= hub_reset_resume
,
3123 .pre_reset
= hub_pre_reset
,
3124 .post_reset
= hub_post_reset
,
3126 .id_table
= hub_id_table
,
3127 .supports_autosuspend
= 1,
3130 int usb_hub_init(void)
3132 if (usb_register(&hub_driver
) < 0) {
3133 printk(KERN_ERR
"%s: can't register hub driver\n",
3138 khubd_task
= kthread_run(hub_thread
, NULL
, "khubd");
3139 if (!IS_ERR(khubd_task
))
3142 /* Fall through if kernel_thread failed */
3143 usb_deregister(&hub_driver
);
3144 printk(KERN_ERR
"%s: can't start khubd\n", usbcore_name
);
3149 void usb_hub_cleanup(void)
3151 kthread_stop(khubd_task
);
3154 * Hub resources are freed for us by usb_deregister. It calls
3155 * usb_driver_purge on every device which in turn calls that
3156 * devices disconnect function if it is using this driver.
3157 * The hub_disconnect function takes care of releasing the
3158 * individual hub resources. -greg
3160 usb_deregister(&hub_driver
);
3161 } /* usb_hub_cleanup() */
3163 static int descriptors_changed(struct usb_device
*udev
,
3164 struct usb_device_descriptor
*old_device_descriptor
)
3168 unsigned serial_len
= 0;
3170 unsigned old_length
;
3174 if (memcmp(&udev
->descriptor
, old_device_descriptor
,
3175 sizeof(*old_device_descriptor
)) != 0)
3178 /* Since the idVendor, idProduct, and bcdDevice values in the
3179 * device descriptor haven't changed, we will assume the
3180 * Manufacturer and Product strings haven't changed either.
3181 * But the SerialNumber string could be different (e.g., a
3182 * different flash card of the same brand).
3185 serial_len
= strlen(udev
->serial
) + 1;
3188 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
3189 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
3190 len
= max(len
, old_length
);
3193 buf
= kmalloc(len
, GFP_NOIO
);
3195 dev_err(&udev
->dev
, "no mem to re-read configs after reset\n");
3196 /* assume the worst */
3199 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
3200 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
3201 length
= usb_get_descriptor(udev
, USB_DT_CONFIG
, index
, buf
,
3203 if (length
!= old_length
) {
3204 dev_dbg(&udev
->dev
, "config index %d, error %d\n",
3209 if (memcmp (buf
, udev
->rawdescriptors
[index
], old_length
)
3211 dev_dbg(&udev
->dev
, "config index %d changed (#%d)\n",
3213 ((struct usb_config_descriptor
*) buf
)->
3214 bConfigurationValue
);
3220 if (!changed
&& serial_len
) {
3221 length
= usb_string(udev
, udev
->descriptor
.iSerialNumber
,
3223 if (length
+ 1 != serial_len
) {
3224 dev_dbg(&udev
->dev
, "serial string error %d\n",
3227 } else if (memcmp(buf
, udev
->serial
, length
) != 0) {
3228 dev_dbg(&udev
->dev
, "serial string changed\n");
3238 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
3239 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3241 * WARNING - don't use this routine to reset a composite device
3242 * (one with multiple interfaces owned by separate drivers)!
3243 * Use usb_reset_device() instead.
3245 * Do a port reset, reassign the device's address, and establish its
3246 * former operating configuration. If the reset fails, or the device's
3247 * descriptors change from their values before the reset, or the original
3248 * configuration and altsettings cannot be restored, a flag will be set
3249 * telling khubd to pretend the device has been disconnected and then
3250 * re-connected. All drivers will be unbound, and the device will be
3251 * re-enumerated and probed all over again.
3253 * Returns 0 if the reset succeeded, -ENODEV if the device has been
3254 * flagged for logical disconnection, or some other negative error code
3255 * if the reset wasn't even attempted.
3257 * The caller must own the device lock. For example, it's safe to use
3258 * this from a driver probe() routine after downloading new firmware.
3259 * For calls that might not occur during probe(), drivers should lock
3260 * the device using usb_lock_device_for_reset().
3262 * Locking exception: This routine may also be called from within an
3263 * autoresume handler. Such usage won't conflict with other tasks
3264 * holding the device lock because these tasks should always call
3265 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
3267 static int usb_reset_and_verify_device(struct usb_device
*udev
)
3269 struct usb_device
*parent_hdev
= udev
->parent
;
3270 struct usb_hub
*parent_hub
;
3271 struct usb_device_descriptor descriptor
= udev
->descriptor
;
3273 int port1
= udev
->portnum
;
3275 if (udev
->state
== USB_STATE_NOTATTACHED
||
3276 udev
->state
== USB_STATE_SUSPENDED
) {
3277 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
3283 /* this requires hcd-specific logic; see OHCI hc_restart() */
3284 dev_dbg(&udev
->dev
, "%s for root hub!\n", __func__
);
3287 parent_hub
= hdev_to_hub(parent_hdev
);
3289 set_bit(port1
, parent_hub
->busy_bits
);
3290 for (i
= 0; i
< SET_CONFIG_TRIES
; ++i
) {
3292 /* ep0 maxpacket size may change; let the HCD know about it.
3293 * Other endpoints will be handled by re-enumeration. */
3294 usb_ep0_reinit(udev
);
3295 ret
= hub_port_init(parent_hub
, udev
, port1
, i
);
3296 if (ret
>= 0 || ret
== -ENOTCONN
|| ret
== -ENODEV
)
3299 clear_bit(port1
, parent_hub
->busy_bits
);
3300 if (!parent_hdev
->parent
&& !parent_hub
->busy_bits
[0])
3301 usb_enable_root_hub_irq(parent_hdev
->bus
);
3306 /* Device might have changed firmware (DFU or similar) */
3307 if (descriptors_changed(udev
, &descriptor
)) {
3308 dev_info(&udev
->dev
, "device firmware changed\n");
3309 udev
->descriptor
= descriptor
; /* for disconnect() calls */
3313 if (!udev
->actconfig
)
3316 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3317 USB_REQ_SET_CONFIGURATION
, 0,
3318 udev
->actconfig
->desc
.bConfigurationValue
, 0,
3319 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
3322 "can't restore configuration #%d (error=%d)\n",
3323 udev
->actconfig
->desc
.bConfigurationValue
, ret
);
3326 usb_set_device_state(udev
, USB_STATE_CONFIGURED
);
3328 for (i
= 0; i
< udev
->actconfig
->desc
.bNumInterfaces
; i
++) {
3329 struct usb_interface
*intf
= udev
->actconfig
->interface
[i
];
3330 struct usb_interface_descriptor
*desc
;
3332 /* set_interface resets host side toggle even
3333 * for altsetting zero. the interface may have no driver.
3335 desc
= &intf
->cur_altsetting
->desc
;
3336 ret
= usb_set_interface(udev
, desc
->bInterfaceNumber
,
3337 desc
->bAlternateSetting
);
3339 dev_err(&udev
->dev
, "failed to restore interface %d "
3340 "altsetting %d (error=%d)\n",
3341 desc
->bInterfaceNumber
,
3342 desc
->bAlternateSetting
,
3352 hub_port_logical_disconnect(parent_hub
, port1
);
3357 * usb_reset_device - warn interface drivers and perform a USB port reset
3358 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3360 * Warns all drivers bound to registered interfaces (using their pre_reset
3361 * method), performs the port reset, and then lets the drivers know that
3362 * the reset is over (using their post_reset method).
3364 * Return value is the same as for usb_reset_and_verify_device().
3366 * The caller must own the device lock. For example, it's safe to use
3367 * this from a driver probe() routine after downloading new firmware.
3368 * For calls that might not occur during probe(), drivers should lock
3369 * the device using usb_lock_device_for_reset().
3371 * If an interface is currently being probed or disconnected, we assume
3372 * its driver knows how to handle resets. For all other interfaces,
3373 * if the driver doesn't have pre_reset and post_reset methods then
3374 * we attempt to unbind it and rebind afterward.
3376 int usb_reset_device(struct usb_device
*udev
)
3380 struct usb_host_config
*config
= udev
->actconfig
;
3382 if (udev
->state
== USB_STATE_NOTATTACHED
||
3383 udev
->state
== USB_STATE_SUSPENDED
) {
3384 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
3389 /* Prevent autosuspend during the reset */
3390 usb_autoresume_device(udev
);
3393 for (i
= 0; i
< config
->desc
.bNumInterfaces
; ++i
) {
3394 struct usb_interface
*cintf
= config
->interface
[i
];
3395 struct usb_driver
*drv
;
3398 if (cintf
->dev
.driver
) {
3399 drv
= to_usb_driver(cintf
->dev
.driver
);
3400 if (drv
->pre_reset
&& drv
->post_reset
)
3401 unbind
= (drv
->pre_reset
)(cintf
);
3402 else if (cintf
->condition
==
3403 USB_INTERFACE_BOUND
)
3406 usb_forced_unbind_intf(cintf
);
3411 ret
= usb_reset_and_verify_device(udev
);
3414 for (i
= config
->desc
.bNumInterfaces
- 1; i
>= 0; --i
) {
3415 struct usb_interface
*cintf
= config
->interface
[i
];
3416 struct usb_driver
*drv
;
3417 int rebind
= cintf
->needs_binding
;
3419 if (!rebind
&& cintf
->dev
.driver
) {
3420 drv
= to_usb_driver(cintf
->dev
.driver
);
3421 if (drv
->post_reset
)
3422 rebind
= (drv
->post_reset
)(cintf
);
3423 else if (cintf
->condition
==
3424 USB_INTERFACE_BOUND
)
3428 usb_rebind_intf(cintf
);
3432 usb_autosuspend_device(udev
);
3435 EXPORT_SYMBOL_GPL(usb_reset_device
);