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
;
80 struct delayed_work init_work
;
84 /* Protect struct usb_device->state and ->children members
85 * Note: Both are also protected by ->dev.sem, except that ->state can
86 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
87 static DEFINE_SPINLOCK(device_state_lock
);
89 /* khubd's worklist and its lock */
90 static DEFINE_SPINLOCK(hub_event_lock
);
91 static LIST_HEAD(hub_event_list
); /* List of hubs needing servicing */
94 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait
);
96 static struct task_struct
*khubd_task
;
98 /* cycle leds on hubs that aren't blinking for attention */
99 static int blinkenlights
= 0;
100 module_param (blinkenlights
, bool, S_IRUGO
);
101 MODULE_PARM_DESC (blinkenlights
, "true to cycle leds on hubs");
104 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
105 * 10 seconds to send reply for the initial 64-byte descriptor request.
107 /* define initial 64-byte descriptor request timeout in milliseconds */
108 static int initial_descriptor_timeout
= USB_CTRL_GET_TIMEOUT
;
109 module_param(initial_descriptor_timeout
, int, S_IRUGO
|S_IWUSR
);
110 MODULE_PARM_DESC(initial_descriptor_timeout
, "initial 64-byte descriptor request timeout in milliseconds (default 5000 - 5.0 seconds)");
113 * As of 2.6.10 we introduce a new USB device initialization scheme which
114 * closely resembles the way Windows works. Hopefully it will be compatible
115 * with a wider range of devices than the old scheme. However some previously
116 * working devices may start giving rise to "device not accepting address"
117 * errors; if that happens the user can try the old scheme by adjusting the
118 * following module parameters.
120 * For maximum flexibility there are two boolean parameters to control the
121 * hub driver's behavior. On the first initialization attempt, if the
122 * "old_scheme_first" parameter is set then the old scheme will be used,
123 * otherwise the new scheme is used. If that fails and "use_both_schemes"
124 * is set, then the driver will make another attempt, using the other scheme.
126 static int old_scheme_first
= 0;
127 module_param(old_scheme_first
, bool, S_IRUGO
| S_IWUSR
);
128 MODULE_PARM_DESC(old_scheme_first
,
129 "start with the old device initialization scheme");
131 static int use_both_schemes
= 1;
132 module_param(use_both_schemes
, bool, S_IRUGO
| S_IWUSR
);
133 MODULE_PARM_DESC(use_both_schemes
,
134 "try the other device initialization scheme if the "
137 /* Mutual exclusion for EHCI CF initialization. This interferes with
138 * port reset on some companion controllers.
140 DECLARE_RWSEM(ehci_cf_port_reset_rwsem
);
141 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem
);
143 #define HUB_DEBOUNCE_TIMEOUT 1500
144 #define HUB_DEBOUNCE_STEP 25
145 #define HUB_DEBOUNCE_STABLE 100
148 static int usb_reset_and_verify_device(struct usb_device
*udev
);
150 static inline char *portspeed(int portstatus
)
152 if (portstatus
& (1 << USB_PORT_FEAT_HIGHSPEED
))
154 else if (portstatus
& (1 << USB_PORT_FEAT_LOWSPEED
))
160 /* Note that hdev or one of its children must be locked! */
161 static inline struct usb_hub
*hdev_to_hub(struct usb_device
*hdev
)
163 return usb_get_intfdata(hdev
->actconfig
->interface
[0]);
166 /* USB 2.0 spec Section 11.24.4.5 */
167 static int get_hub_descriptor(struct usb_device
*hdev
, void *data
, int size
)
171 for (i
= 0; i
< 3; i
++) {
172 ret
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
173 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
| USB_RT_HUB
,
174 USB_DT_HUB
<< 8, 0, data
, size
,
175 USB_CTRL_GET_TIMEOUT
);
176 if (ret
>= (USB_DT_HUB_NONVAR_SIZE
+ 2))
183 * USB 2.0 spec Section 11.24.2.1
185 static int clear_hub_feature(struct usb_device
*hdev
, int feature
)
187 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
188 USB_REQ_CLEAR_FEATURE
, USB_RT_HUB
, feature
, 0, NULL
, 0, 1000);
192 * USB 2.0 spec Section 11.24.2.2
194 static int clear_port_feature(struct usb_device
*hdev
, int port1
, int feature
)
196 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
197 USB_REQ_CLEAR_FEATURE
, USB_RT_PORT
, feature
, port1
,
202 * USB 2.0 spec Section 11.24.2.13
204 static int set_port_feature(struct usb_device
*hdev
, int port1
, int feature
)
206 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
207 USB_REQ_SET_FEATURE
, USB_RT_PORT
, feature
, port1
,
212 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
213 * for info about using port indicators
215 static void set_port_led(
221 int status
= set_port_feature(hub
->hdev
, (selector
<< 8) | port1
,
222 USB_PORT_FEAT_INDICATOR
);
224 dev_dbg (hub
->intfdev
,
225 "port %d indicator %s status %d\n",
227 ({ char *s
; switch (selector
) {
228 case HUB_LED_AMBER
: s
= "amber"; break;
229 case HUB_LED_GREEN
: s
= "green"; break;
230 case HUB_LED_OFF
: s
= "off"; break;
231 case HUB_LED_AUTO
: s
= "auto"; break;
232 default: s
= "??"; break;
237 #define LED_CYCLE_PERIOD ((2*HZ)/3)
239 static void led_work (struct work_struct
*work
)
241 struct usb_hub
*hub
=
242 container_of(work
, struct usb_hub
, leds
.work
);
243 struct usb_device
*hdev
= hub
->hdev
;
245 unsigned changed
= 0;
248 if (hdev
->state
!= USB_STATE_CONFIGURED
|| hub
->quiescing
)
251 for (i
= 0; i
< hub
->descriptor
->bNbrPorts
; i
++) {
252 unsigned selector
, mode
;
254 /* 30%-50% duty cycle */
256 switch (hub
->indicator
[i
]) {
258 case INDICATOR_CYCLE
:
260 selector
= HUB_LED_AUTO
;
261 mode
= INDICATOR_AUTO
;
263 /* blinking green = sw attention */
264 case INDICATOR_GREEN_BLINK
:
265 selector
= HUB_LED_GREEN
;
266 mode
= INDICATOR_GREEN_BLINK_OFF
;
268 case INDICATOR_GREEN_BLINK_OFF
:
269 selector
= HUB_LED_OFF
;
270 mode
= INDICATOR_GREEN_BLINK
;
272 /* blinking amber = hw attention */
273 case INDICATOR_AMBER_BLINK
:
274 selector
= HUB_LED_AMBER
;
275 mode
= INDICATOR_AMBER_BLINK_OFF
;
277 case INDICATOR_AMBER_BLINK_OFF
:
278 selector
= HUB_LED_OFF
;
279 mode
= INDICATOR_AMBER_BLINK
;
281 /* blink green/amber = reserved */
282 case INDICATOR_ALT_BLINK
:
283 selector
= HUB_LED_GREEN
;
284 mode
= INDICATOR_ALT_BLINK_OFF
;
286 case INDICATOR_ALT_BLINK_OFF
:
287 selector
= HUB_LED_AMBER
;
288 mode
= INDICATOR_ALT_BLINK
;
293 if (selector
!= HUB_LED_AUTO
)
295 set_port_led(hub
, i
+ 1, selector
);
296 hub
->indicator
[i
] = mode
;
298 if (!changed
&& blinkenlights
) {
300 cursor
%= hub
->descriptor
->bNbrPorts
;
301 set_port_led(hub
, cursor
+ 1, HUB_LED_GREEN
);
302 hub
->indicator
[cursor
] = INDICATOR_CYCLE
;
306 schedule_delayed_work(&hub
->leds
, LED_CYCLE_PERIOD
);
309 /* use a short timeout for hub/port status fetches */
310 #define USB_STS_TIMEOUT 1000
311 #define USB_STS_RETRIES 5
314 * USB 2.0 spec Section 11.24.2.6
316 static int get_hub_status(struct usb_device
*hdev
,
317 struct usb_hub_status
*data
)
319 int i
, status
= -ETIMEDOUT
;
321 for (i
= 0; i
< USB_STS_RETRIES
&& status
== -ETIMEDOUT
; i
++) {
322 status
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
323 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_HUB
, 0, 0,
324 data
, sizeof(*data
), USB_STS_TIMEOUT
);
330 * USB 2.0 spec Section 11.24.2.7
332 static int get_port_status(struct usb_device
*hdev
, int port1
,
333 struct usb_port_status
*data
)
335 int i
, status
= -ETIMEDOUT
;
337 for (i
= 0; i
< USB_STS_RETRIES
&& status
== -ETIMEDOUT
; i
++) {
338 status
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
339 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_PORT
, 0, port1
,
340 data
, sizeof(*data
), USB_STS_TIMEOUT
);
345 static int hub_port_status(struct usb_hub
*hub
, int port1
,
346 u16
*status
, u16
*change
)
350 mutex_lock(&hub
->status_mutex
);
351 ret
= get_port_status(hub
->hdev
, port1
, &hub
->status
->port
);
353 dev_err(hub
->intfdev
,
354 "%s failed (err = %d)\n", __func__
, ret
);
358 *status
= le16_to_cpu(hub
->status
->port
.wPortStatus
);
359 *change
= le16_to_cpu(hub
->status
->port
.wPortChange
);
362 mutex_unlock(&hub
->status_mutex
);
366 static void kick_khubd(struct usb_hub
*hub
)
370 /* Suppress autosuspend until khubd runs */
371 to_usb_interface(hub
->intfdev
)->pm_usage_cnt
= 1;
373 spin_lock_irqsave(&hub_event_lock
, flags
);
374 if (!hub
->disconnected
&& list_empty(&hub
->event_list
)) {
375 list_add_tail(&hub
->event_list
, &hub_event_list
);
376 wake_up(&khubd_wait
);
378 spin_unlock_irqrestore(&hub_event_lock
, flags
);
381 void usb_kick_khubd(struct usb_device
*hdev
)
383 /* FIXME: What if hdev isn't bound to the hub driver? */
384 kick_khubd(hdev_to_hub(hdev
));
388 /* completion function, fires on port status changes and various faults */
389 static void hub_irq(struct urb
*urb
)
391 struct usb_hub
*hub
= urb
->context
;
392 int status
= urb
->status
;
397 case -ENOENT
: /* synchronous unlink */
398 case -ECONNRESET
: /* async unlink */
399 case -ESHUTDOWN
: /* hardware going away */
402 default: /* presumably an error */
403 /* Cause a hub reset after 10 consecutive errors */
404 dev_dbg (hub
->intfdev
, "transfer --> %d\n", status
);
405 if ((++hub
->nerrors
< 10) || hub
->error
)
410 /* let khubd handle things */
411 case 0: /* we got data: port status changed */
413 for (i
= 0; i
< urb
->actual_length
; ++i
)
414 bits
|= ((unsigned long) ((*hub
->buffer
)[i
]))
416 hub
->event_bits
[0] = bits
;
422 /* Something happened, let khubd figure it out */
429 if ((status
= usb_submit_urb (hub
->urb
, GFP_ATOMIC
)) != 0
430 && status
!= -ENODEV
&& status
!= -EPERM
)
431 dev_err (hub
->intfdev
, "resubmit --> %d\n", status
);
434 /* USB 2.0 spec Section 11.24.2.3 */
436 hub_clear_tt_buffer (struct usb_device
*hdev
, u16 devinfo
, u16 tt
)
438 return usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
439 HUB_CLEAR_TT_BUFFER
, USB_RT_PORT
, devinfo
,
444 * enumeration blocks khubd for a long time. we use keventd instead, since
445 * long blocking there is the exception, not the rule. accordingly, HCDs
446 * talking to TTs must queue control transfers (not just bulk and iso), so
447 * both can talk to the same hub concurrently.
449 static void hub_tt_kevent (struct work_struct
*work
)
451 struct usb_hub
*hub
=
452 container_of(work
, struct usb_hub
, tt
.kevent
);
456 spin_lock_irqsave (&hub
->tt
.lock
, flags
);
457 while (--limit
&& !list_empty (&hub
->tt
.clear_list
)) {
458 struct list_head
*temp
;
459 struct usb_tt_clear
*clear
;
460 struct usb_device
*hdev
= hub
->hdev
;
463 temp
= hub
->tt
.clear_list
.next
;
464 clear
= list_entry (temp
, struct usb_tt_clear
, clear_list
);
465 list_del (&clear
->clear_list
);
467 /* drop lock so HCD can concurrently report other TT errors */
468 spin_unlock_irqrestore (&hub
->tt
.lock
, flags
);
469 status
= hub_clear_tt_buffer (hdev
, clear
->devinfo
, clear
->tt
);
470 spin_lock_irqsave (&hub
->tt
.lock
, flags
);
474 "clear tt %d (%04x) error %d\n",
475 clear
->tt
, clear
->devinfo
, status
);
478 spin_unlock_irqrestore (&hub
->tt
.lock
, flags
);
482 * usb_hub_tt_clear_buffer - clear control/bulk TT state in high speed hub
483 * @udev: the device whose split transaction failed
484 * @pipe: identifies the endpoint of the failed transaction
486 * High speed HCDs use this to tell the hub driver that some split control or
487 * bulk transaction failed in a way that requires clearing internal state of
488 * a transaction translator. This is normally detected (and reported) from
491 * It may not be possible for that hub to handle additional full (or low)
492 * speed transactions until that state is fully cleared out.
494 void usb_hub_tt_clear_buffer (struct usb_device
*udev
, int pipe
)
496 struct usb_tt
*tt
= udev
->tt
;
498 struct usb_tt_clear
*clear
;
500 /* we've got to cope with an arbitrary number of pending TT clears,
501 * since each TT has "at least two" buffers that can need it (and
502 * there can be many TTs per hub). even if they're uncommon.
504 if ((clear
= kmalloc (sizeof *clear
, GFP_ATOMIC
)) == NULL
) {
505 dev_err (&udev
->dev
, "can't save CLEAR_TT_BUFFER state\n");
506 /* FIXME recover somehow ... RESET_TT? */
510 /* info that CLEAR_TT_BUFFER needs */
511 clear
->tt
= tt
->multi
? udev
->ttport
: 1;
512 clear
->devinfo
= usb_pipeendpoint (pipe
);
513 clear
->devinfo
|= udev
->devnum
<< 4;
514 clear
->devinfo
|= usb_pipecontrol (pipe
)
515 ? (USB_ENDPOINT_XFER_CONTROL
<< 11)
516 : (USB_ENDPOINT_XFER_BULK
<< 11);
517 if (usb_pipein (pipe
))
518 clear
->devinfo
|= 1 << 15;
520 /* tell keventd to clear state for this TT */
521 spin_lock_irqsave (&tt
->lock
, flags
);
522 list_add_tail (&clear
->clear_list
, &tt
->clear_list
);
523 schedule_work (&tt
->kevent
);
524 spin_unlock_irqrestore (&tt
->lock
, flags
);
526 EXPORT_SYMBOL_GPL(usb_hub_tt_clear_buffer
);
528 /* If do_delay is false, return the number of milliseconds the caller
531 static unsigned hub_power_on(struct usb_hub
*hub
, bool do_delay
)
534 unsigned pgood_delay
= hub
->descriptor
->bPwrOn2PwrGood
* 2;
536 u16 wHubCharacteristics
=
537 le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
539 /* Enable power on each port. Some hubs have reserved values
540 * of LPSM (> 2) in their descriptors, even though they are
541 * USB 2.0 hubs. Some hubs do not implement port-power switching
542 * but only emulate it. In all cases, the ports won't work
543 * unless we send these messages to the hub.
545 if ((wHubCharacteristics
& HUB_CHAR_LPSM
) < 2)
546 dev_dbg(hub
->intfdev
, "enabling power on all ports\n");
548 dev_dbg(hub
->intfdev
, "trying to enable port power on "
549 "non-switchable hub\n");
550 for (port1
= 1; port1
<= hub
->descriptor
->bNbrPorts
; port1
++)
551 set_port_feature(hub
->hdev
, port1
, USB_PORT_FEAT_POWER
);
553 /* Wait at least 100 msec for power to become stable */
554 delay
= max(pgood_delay
, (unsigned) 100);
560 static int hub_hub_status(struct usb_hub
*hub
,
561 u16
*status
, u16
*change
)
565 mutex_lock(&hub
->status_mutex
);
566 ret
= get_hub_status(hub
->hdev
, &hub
->status
->hub
);
568 dev_err (hub
->intfdev
,
569 "%s failed (err = %d)\n", __func__
, ret
);
571 *status
= le16_to_cpu(hub
->status
->hub
.wHubStatus
);
572 *change
= le16_to_cpu(hub
->status
->hub
.wHubChange
);
575 mutex_unlock(&hub
->status_mutex
);
579 static int hub_port_disable(struct usb_hub
*hub
, int port1
, int set_state
)
581 struct usb_device
*hdev
= hub
->hdev
;
584 if (hdev
->children
[port1
-1] && set_state
)
585 usb_set_device_state(hdev
->children
[port1
-1],
586 USB_STATE_NOTATTACHED
);
588 ret
= clear_port_feature(hdev
, port1
, USB_PORT_FEAT_ENABLE
);
590 dev_err(hub
->intfdev
, "cannot disable port %d (err = %d)\n",
596 * Disable a port and mark a logical connnect-change event, so that some
597 * time later khubd will disconnect() any existing usb_device on the port
598 * and will re-enumerate if there actually is a device attached.
600 static void hub_port_logical_disconnect(struct usb_hub
*hub
, int port1
)
602 dev_dbg(hub
->intfdev
, "logical disconnect on port %d\n", port1
);
603 hub_port_disable(hub
, port1
, 1);
605 /* FIXME let caller ask to power down the port:
606 * - some devices won't enumerate without a VBUS power cycle
607 * - SRP saves power that way
608 * - ... new call, TBD ...
609 * That's easy if this hub can switch power per-port, and
610 * khubd reactivates the port later (timer, SRP, etc).
611 * Powerdown must be optional, because of reset/DFU.
614 set_bit(port1
, hub
->change_bits
);
618 enum hub_activation_type
{
619 HUB_INIT
, HUB_INIT2
, HUB_INIT3
,
620 HUB_POST_RESET
, HUB_RESUME
, HUB_RESET_RESUME
,
623 static void hub_init_func2(struct work_struct
*ws
);
624 static void hub_init_func3(struct work_struct
*ws
);
626 static void hub_activate(struct usb_hub
*hub
, enum hub_activation_type type
)
628 struct usb_device
*hdev
= hub
->hdev
;
631 bool need_debounce_delay
= false;
634 /* Continue a partial initialization */
635 if (type
== HUB_INIT2
)
637 if (type
== HUB_INIT3
)
640 /* After a resume, port power should still be on.
641 * For any other type of activation, turn it on.
643 if (type
!= HUB_RESUME
) {
645 /* Speed up system boot by using a delayed_work for the
646 * hub's initial power-up delays. This is pretty awkward
647 * and the implementation looks like a home-brewed sort of
648 * setjmp/longjmp, but it saves at least 100 ms for each
649 * root hub (assuming usbcore is compiled into the kernel
650 * rather than as a module). It adds up.
652 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
653 * because for those activation types the ports have to be
654 * operational when we return. In theory this could be done
655 * for HUB_POST_RESET, but it's easier not to.
657 if (type
== HUB_INIT
) {
658 delay
= hub_power_on(hub
, false);
659 PREPARE_DELAYED_WORK(&hub
->init_work
, hub_init_func2
);
660 schedule_delayed_work(&hub
->init_work
,
661 msecs_to_jiffies(delay
));
662 return; /* Continues at init2: below */
664 hub_power_on(hub
, true);
669 /* Check each port and set hub->change_bits to let khubd know
670 * which ports need attention.
672 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
673 struct usb_device
*udev
= hdev
->children
[port1
-1];
674 u16 portstatus
, portchange
;
676 portstatus
= portchange
= 0;
677 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
678 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
))
679 dev_dbg(hub
->intfdev
,
680 "port %d: status %04x change %04x\n",
681 port1
, portstatus
, portchange
);
683 /* After anything other than HUB_RESUME (i.e., initialization
684 * or any sort of reset), every port should be disabled.
685 * Unconnected ports should likewise be disabled (paranoia),
686 * and so should ports for which we have no usb_device.
688 if ((portstatus
& USB_PORT_STAT_ENABLE
) && (
689 type
!= HUB_RESUME
||
690 !(portstatus
& USB_PORT_STAT_CONNECTION
) ||
692 udev
->state
== USB_STATE_NOTATTACHED
)) {
693 clear_port_feature(hdev
, port1
, USB_PORT_FEAT_ENABLE
);
694 portstatus
&= ~USB_PORT_STAT_ENABLE
;
697 /* Clear status-change flags; we'll debounce later */
698 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
699 need_debounce_delay
= true;
700 clear_port_feature(hub
->hdev
, port1
,
701 USB_PORT_FEAT_C_CONNECTION
);
703 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
704 need_debounce_delay
= true;
705 clear_port_feature(hub
->hdev
, port1
,
706 USB_PORT_FEAT_C_ENABLE
);
709 if (!udev
|| udev
->state
== USB_STATE_NOTATTACHED
) {
710 /* Tell khubd to disconnect the device or
711 * check for a new connection
713 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
))
714 set_bit(port1
, hub
->change_bits
);
716 } else if (portstatus
& USB_PORT_STAT_ENABLE
) {
717 /* The power session apparently survived the resume.
718 * If there was an overcurrent or suspend change
719 * (i.e., remote wakeup request), have khubd
723 set_bit(port1
, hub
->change_bits
);
725 } else if (udev
->persist_enabled
) {
727 udev
->reset_resume
= 1;
729 set_bit(port1
, hub
->change_bits
);
732 /* The power session is gone; tell khubd */
733 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
734 set_bit(port1
, hub
->change_bits
);
738 /* If no port-status-change flags were set, we don't need any
739 * debouncing. If flags were set we can try to debounce the
740 * ports all at once right now, instead of letting khubd do them
741 * one at a time later on.
743 * If any port-status changes do occur during this delay, khubd
744 * will see them later and handle them normally.
746 if (need_debounce_delay
) {
747 delay
= HUB_DEBOUNCE_STABLE
;
749 /* Don't do a long sleep inside a workqueue routine */
750 if (type
== HUB_INIT2
) {
751 PREPARE_DELAYED_WORK(&hub
->init_work
, hub_init_func3
);
752 schedule_delayed_work(&hub
->init_work
,
753 msecs_to_jiffies(delay
));
754 return; /* Continues at init3: below */
762 status
= usb_submit_urb(hub
->urb
, GFP_NOIO
);
764 dev_err(hub
->intfdev
, "activate --> %d\n", status
);
765 if (hub
->has_indicators
&& blinkenlights
)
766 schedule_delayed_work(&hub
->leds
, LED_CYCLE_PERIOD
);
768 /* Scan all ports that need attention */
772 /* Implement the continuations for the delays above */
773 static void hub_init_func2(struct work_struct
*ws
)
775 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
777 hub_activate(hub
, HUB_INIT2
);
780 static void hub_init_func3(struct work_struct
*ws
)
782 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
784 hub_activate(hub
, HUB_INIT3
);
787 enum hub_quiescing_type
{
788 HUB_DISCONNECT
, HUB_PRE_RESET
, HUB_SUSPEND
791 static void hub_quiesce(struct usb_hub
*hub
, enum hub_quiescing_type type
)
793 struct usb_device
*hdev
= hub
->hdev
;
796 cancel_delayed_work_sync(&hub
->init_work
);
798 /* khubd and related activity won't re-trigger */
801 if (type
!= HUB_SUSPEND
) {
802 /* Disconnect all the children */
803 for (i
= 0; i
< hdev
->maxchild
; ++i
) {
804 if (hdev
->children
[i
])
805 usb_disconnect(&hdev
->children
[i
]);
809 /* Stop khubd and related activity */
810 usb_kill_urb(hub
->urb
);
811 if (hub
->has_indicators
)
812 cancel_delayed_work_sync(&hub
->leds
);
814 cancel_work_sync(&hub
->tt
.kevent
);
817 /* caller has locked the hub device */
818 static int hub_pre_reset(struct usb_interface
*intf
)
820 struct usb_hub
*hub
= usb_get_intfdata(intf
);
822 hub_quiesce(hub
, HUB_PRE_RESET
);
826 /* caller has locked the hub device */
827 static int hub_post_reset(struct usb_interface
*intf
)
829 struct usb_hub
*hub
= usb_get_intfdata(intf
);
831 hub_activate(hub
, HUB_POST_RESET
);
835 static int hub_configure(struct usb_hub
*hub
,
836 struct usb_endpoint_descriptor
*endpoint
)
838 struct usb_device
*hdev
= hub
->hdev
;
839 struct device
*hub_dev
= hub
->intfdev
;
840 u16 hubstatus
, hubchange
;
841 u16 wHubCharacteristics
;
846 hub
->buffer
= usb_buffer_alloc(hdev
, sizeof(*hub
->buffer
), GFP_KERNEL
,
849 message
= "can't allocate hub irq buffer";
854 hub
->status
= kmalloc(sizeof(*hub
->status
), GFP_KERNEL
);
856 message
= "can't kmalloc hub status buffer";
860 mutex_init(&hub
->status_mutex
);
862 hub
->descriptor
= kmalloc(sizeof(*hub
->descriptor
), GFP_KERNEL
);
863 if (!hub
->descriptor
) {
864 message
= "can't kmalloc hub descriptor";
869 /* Request the entire hub descriptor.
870 * hub->descriptor can handle USB_MAXCHILDREN ports,
871 * but the hub can/will return fewer bytes here.
873 ret
= get_hub_descriptor(hdev
, hub
->descriptor
,
874 sizeof(*hub
->descriptor
));
876 message
= "can't read hub descriptor";
878 } else if (hub
->descriptor
->bNbrPorts
> USB_MAXCHILDREN
) {
879 message
= "hub has too many ports!";
884 hdev
->maxchild
= hub
->descriptor
->bNbrPorts
;
885 dev_info (hub_dev
, "%d port%s detected\n", hdev
->maxchild
,
886 (hdev
->maxchild
== 1) ? "" : "s");
888 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
890 if (wHubCharacteristics
& HUB_CHAR_COMPOUND
) {
892 char portstr
[USB_MAXCHILDREN
+ 1];
894 for (i
= 0; i
< hdev
->maxchild
; i
++)
895 portstr
[i
] = hub
->descriptor
->DeviceRemovable
896 [((i
+ 1) / 8)] & (1 << ((i
+ 1) % 8))
898 portstr
[hdev
->maxchild
] = 0;
899 dev_dbg(hub_dev
, "compound device; port removable status: %s\n", portstr
);
901 dev_dbg(hub_dev
, "standalone hub\n");
903 switch (wHubCharacteristics
& HUB_CHAR_LPSM
) {
905 dev_dbg(hub_dev
, "ganged power switching\n");
908 dev_dbg(hub_dev
, "individual port power switching\n");
912 dev_dbg(hub_dev
, "no power switching (usb 1.0)\n");
916 switch (wHubCharacteristics
& HUB_CHAR_OCPM
) {
918 dev_dbg(hub_dev
, "global over-current protection\n");
921 dev_dbg(hub_dev
, "individual port over-current protection\n");
925 dev_dbg(hub_dev
, "no over-current protection\n");
929 spin_lock_init (&hub
->tt
.lock
);
930 INIT_LIST_HEAD (&hub
->tt
.clear_list
);
931 INIT_WORK (&hub
->tt
.kevent
, hub_tt_kevent
);
932 switch (hdev
->descriptor
.bDeviceProtocol
) {
936 dev_dbg(hub_dev
, "Single TT\n");
940 ret
= usb_set_interface(hdev
, 0, 1);
942 dev_dbg(hub_dev
, "TT per port\n");
945 dev_err(hub_dev
, "Using single TT (err %d)\n",
950 dev_dbg(hub_dev
, "Unrecognized hub protocol %d\n",
951 hdev
->descriptor
.bDeviceProtocol
);
955 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
956 switch (wHubCharacteristics
& HUB_CHAR_TTTT
) {
957 case HUB_TTTT_8_BITS
:
958 if (hdev
->descriptor
.bDeviceProtocol
!= 0) {
959 hub
->tt
.think_time
= 666;
960 dev_dbg(hub_dev
, "TT requires at most %d "
961 "FS bit times (%d ns)\n",
962 8, hub
->tt
.think_time
);
965 case HUB_TTTT_16_BITS
:
966 hub
->tt
.think_time
= 666 * 2;
967 dev_dbg(hub_dev
, "TT requires at most %d "
968 "FS bit times (%d ns)\n",
969 16, hub
->tt
.think_time
);
971 case HUB_TTTT_24_BITS
:
972 hub
->tt
.think_time
= 666 * 3;
973 dev_dbg(hub_dev
, "TT requires at most %d "
974 "FS bit times (%d ns)\n",
975 24, hub
->tt
.think_time
);
977 case HUB_TTTT_32_BITS
:
978 hub
->tt
.think_time
= 666 * 4;
979 dev_dbg(hub_dev
, "TT requires at most %d "
980 "FS bit times (%d ns)\n",
981 32, hub
->tt
.think_time
);
985 /* probe() zeroes hub->indicator[] */
986 if (wHubCharacteristics
& HUB_CHAR_PORTIND
) {
987 hub
->has_indicators
= 1;
988 dev_dbg(hub_dev
, "Port indicators are supported\n");
991 dev_dbg(hub_dev
, "power on to power good time: %dms\n",
992 hub
->descriptor
->bPwrOn2PwrGood
* 2);
994 /* power budgeting mostly matters with bus-powered hubs,
995 * and battery-powered root hubs (may provide just 8 mA).
997 ret
= usb_get_status(hdev
, USB_RECIP_DEVICE
, 0, &hubstatus
);
999 message
= "can't get hub status";
1002 le16_to_cpus(&hubstatus
);
1003 if (hdev
== hdev
->bus
->root_hub
) {
1004 if (hdev
->bus_mA
== 0 || hdev
->bus_mA
>= 500)
1005 hub
->mA_per_port
= 500;
1007 hub
->mA_per_port
= hdev
->bus_mA
;
1008 hub
->limited_power
= 1;
1010 } else if ((hubstatus
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
1011 dev_dbg(hub_dev
, "hub controller current requirement: %dmA\n",
1012 hub
->descriptor
->bHubContrCurrent
);
1013 hub
->limited_power
= 1;
1014 if (hdev
->maxchild
> 0) {
1015 int remaining
= hdev
->bus_mA
-
1016 hub
->descriptor
->bHubContrCurrent
;
1018 if (remaining
< hdev
->maxchild
* 100)
1020 "insufficient power available "
1021 "to use all downstream ports\n");
1022 hub
->mA_per_port
= 100; /* 7.2.1.1 */
1024 } else { /* Self-powered external hub */
1025 /* FIXME: What about battery-powered external hubs that
1026 * provide less current per port? */
1027 hub
->mA_per_port
= 500;
1029 if (hub
->mA_per_port
< 500)
1030 dev_dbg(hub_dev
, "%umA bus power budget for each child\n",
1033 ret
= hub_hub_status(hub
, &hubstatus
, &hubchange
);
1035 message
= "can't get hub status";
1039 /* local power status reports aren't always correct */
1040 if (hdev
->actconfig
->desc
.bmAttributes
& USB_CONFIG_ATT_SELFPOWER
)
1041 dev_dbg(hub_dev
, "local power source is %s\n",
1042 (hubstatus
& HUB_STATUS_LOCAL_POWER
)
1043 ? "lost (inactive)" : "good");
1045 if ((wHubCharacteristics
& HUB_CHAR_OCPM
) == 0)
1046 dev_dbg(hub_dev
, "%sover-current condition exists\n",
1047 (hubstatus
& HUB_STATUS_OVERCURRENT
) ? "" : "no ");
1049 /* set up the interrupt endpoint
1050 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1051 * bytes as USB2.0[11.12.3] says because some hubs are known
1052 * to send more data (and thus cause overflow). For root hubs,
1053 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1054 * to be big enough for at least USB_MAXCHILDREN ports. */
1055 pipe
= usb_rcvintpipe(hdev
, endpoint
->bEndpointAddress
);
1056 maxp
= usb_maxpacket(hdev
, pipe
, usb_pipeout(pipe
));
1058 if (maxp
> sizeof(*hub
->buffer
))
1059 maxp
= sizeof(*hub
->buffer
);
1061 hub
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
1063 message
= "couldn't allocate interrupt urb";
1068 usb_fill_int_urb(hub
->urb
, hdev
, pipe
, *hub
->buffer
, maxp
, hub_irq
,
1069 hub
, endpoint
->bInterval
);
1070 hub
->urb
->transfer_dma
= hub
->buffer_dma
;
1071 hub
->urb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
1073 /* maybe cycle the hub leds */
1074 if (hub
->has_indicators
&& blinkenlights
)
1075 hub
->indicator
[0] = INDICATOR_CYCLE
;
1077 hub_activate(hub
, HUB_INIT
);
1081 dev_err (hub_dev
, "config failed, %s (err %d)\n",
1083 /* hub_disconnect() frees urb and descriptor */
1087 static void hub_release(struct kref
*kref
)
1089 struct usb_hub
*hub
= container_of(kref
, struct usb_hub
, kref
);
1091 usb_put_intf(to_usb_interface(hub
->intfdev
));
1095 static unsigned highspeed_hubs
;
1097 static void hub_disconnect(struct usb_interface
*intf
)
1099 struct usb_hub
*hub
= usb_get_intfdata (intf
);
1101 /* Take the hub off the event list and don't let it be added again */
1102 spin_lock_irq(&hub_event_lock
);
1103 list_del_init(&hub
->event_list
);
1104 hub
->disconnected
= 1;
1105 spin_unlock_irq(&hub_event_lock
);
1107 /* Disconnect all children and quiesce the hub */
1109 hub_quiesce(hub
, HUB_DISCONNECT
);
1111 usb_set_intfdata (intf
, NULL
);
1113 if (hub
->hdev
->speed
== USB_SPEED_HIGH
)
1116 usb_free_urb(hub
->urb
);
1117 kfree(hub
->descriptor
);
1119 usb_buffer_free(hub
->hdev
, sizeof(*hub
->buffer
), hub
->buffer
,
1122 kref_put(&hub
->kref
, hub_release
);
1125 static int hub_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
1127 struct usb_host_interface
*desc
;
1128 struct usb_endpoint_descriptor
*endpoint
;
1129 struct usb_device
*hdev
;
1130 struct usb_hub
*hub
;
1132 desc
= intf
->cur_altsetting
;
1133 hdev
= interface_to_usbdev(intf
);
1135 if (hdev
->level
== MAX_TOPO_LEVEL
) {
1136 dev_err(&intf
->dev
, "Unsupported bus topology: "
1137 "hub nested too deep\n");
1141 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1143 dev_warn(&intf
->dev
, "ignoring external hub\n");
1148 /* Some hubs have a subclass of 1, which AFAICT according to the */
1149 /* specs is not defined, but it works */
1150 if ((desc
->desc
.bInterfaceSubClass
!= 0) &&
1151 (desc
->desc
.bInterfaceSubClass
!= 1)) {
1153 dev_err (&intf
->dev
, "bad descriptor, ignoring hub\n");
1157 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1158 if (desc
->desc
.bNumEndpoints
!= 1)
1159 goto descriptor_error
;
1161 endpoint
= &desc
->endpoint
[0].desc
;
1163 /* If it's not an interrupt in endpoint, we'd better punt! */
1164 if (!usb_endpoint_is_int_in(endpoint
))
1165 goto descriptor_error
;
1167 /* We found a hub */
1168 dev_info (&intf
->dev
, "USB hub found\n");
1170 hub
= kzalloc(sizeof(*hub
), GFP_KERNEL
);
1172 dev_dbg (&intf
->dev
, "couldn't kmalloc hub struct\n");
1176 kref_init(&hub
->kref
);
1177 INIT_LIST_HEAD(&hub
->event_list
);
1178 hub
->intfdev
= &intf
->dev
;
1180 INIT_DELAYED_WORK(&hub
->leds
, led_work
);
1181 INIT_DELAYED_WORK(&hub
->init_work
, NULL
);
1184 usb_set_intfdata (intf
, hub
);
1185 intf
->needs_remote_wakeup
= 1;
1187 if (hdev
->speed
== USB_SPEED_HIGH
)
1190 if (hub_configure(hub
, endpoint
) >= 0)
1193 hub_disconnect (intf
);
1198 hub_ioctl(struct usb_interface
*intf
, unsigned int code
, void *user_data
)
1200 struct usb_device
*hdev
= interface_to_usbdev (intf
);
1202 /* assert ifno == 0 (part of hub spec) */
1204 case USBDEVFS_HUB_PORTINFO
: {
1205 struct usbdevfs_hub_portinfo
*info
= user_data
;
1208 spin_lock_irq(&device_state_lock
);
1209 if (hdev
->devnum
<= 0)
1212 info
->nports
= hdev
->maxchild
;
1213 for (i
= 0; i
< info
->nports
; i
++) {
1214 if (hdev
->children
[i
] == NULL
)
1218 hdev
->children
[i
]->devnum
;
1221 spin_unlock_irq(&device_state_lock
);
1223 return info
->nports
+ 1;
1232 static void recursively_mark_NOTATTACHED(struct usb_device
*udev
)
1236 for (i
= 0; i
< udev
->maxchild
; ++i
) {
1237 if (udev
->children
[i
])
1238 recursively_mark_NOTATTACHED(udev
->children
[i
]);
1240 if (udev
->state
== USB_STATE_SUSPENDED
) {
1241 udev
->discon_suspended
= 1;
1242 udev
->active_duration
-= jiffies
;
1244 udev
->state
= USB_STATE_NOTATTACHED
;
1248 * usb_set_device_state - change a device's current state (usbcore, hcds)
1249 * @udev: pointer to device whose state should be changed
1250 * @new_state: new state value to be stored
1252 * udev->state is _not_ fully protected by the device lock. Although
1253 * most transitions are made only while holding the lock, the state can
1254 * can change to USB_STATE_NOTATTACHED at almost any time. This
1255 * is so that devices can be marked as disconnected as soon as possible,
1256 * without having to wait for any semaphores to be released. As a result,
1257 * all changes to any device's state must be protected by the
1258 * device_state_lock spinlock.
1260 * Once a device has been added to the device tree, all changes to its state
1261 * should be made using this routine. The state should _not_ be set directly.
1263 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1264 * Otherwise udev->state is set to new_state, and if new_state is
1265 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1266 * to USB_STATE_NOTATTACHED.
1268 void usb_set_device_state(struct usb_device
*udev
,
1269 enum usb_device_state new_state
)
1271 unsigned long flags
;
1273 spin_lock_irqsave(&device_state_lock
, flags
);
1274 if (udev
->state
== USB_STATE_NOTATTACHED
)
1276 else if (new_state
!= USB_STATE_NOTATTACHED
) {
1278 /* root hub wakeup capabilities are managed out-of-band
1279 * and may involve silicon errata ... ignore them here.
1282 if (udev
->state
== USB_STATE_SUSPENDED
1283 || new_state
== USB_STATE_SUSPENDED
)
1284 ; /* No change to wakeup settings */
1285 else if (new_state
== USB_STATE_CONFIGURED
)
1286 device_init_wakeup(&udev
->dev
,
1287 (udev
->actconfig
->desc
.bmAttributes
1288 & USB_CONFIG_ATT_WAKEUP
));
1290 device_init_wakeup(&udev
->dev
, 0);
1292 if (udev
->state
== USB_STATE_SUSPENDED
&&
1293 new_state
!= USB_STATE_SUSPENDED
)
1294 udev
->active_duration
-= jiffies
;
1295 else if (new_state
== USB_STATE_SUSPENDED
&&
1296 udev
->state
!= USB_STATE_SUSPENDED
)
1297 udev
->active_duration
+= jiffies
;
1298 udev
->state
= new_state
;
1300 recursively_mark_NOTATTACHED(udev
);
1301 spin_unlock_irqrestore(&device_state_lock
, flags
);
1305 * WUSB devices are simple: they have no hubs behind, so the mapping
1306 * device <-> virtual port number becomes 1:1. Why? to simplify the
1307 * life of the device connection logic in
1308 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1309 * handshake we need to assign a temporary address in the unauthorized
1310 * space. For simplicity we use the first virtual port number found to
1311 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1312 * and that becomes it's address [X < 128] or its unauthorized address
1315 * We add 1 as an offset to the one-based USB-stack port number
1316 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1317 * 0 is reserved by USB for default address; (b) Linux's USB stack
1318 * uses always #1 for the root hub of the controller. So USB stack's
1319 * port #1, which is wusb virtual-port #0 has address #2.
1321 static void choose_address(struct usb_device
*udev
)
1324 struct usb_bus
*bus
= udev
->bus
;
1326 /* If khubd ever becomes multithreaded, this will need a lock */
1328 devnum
= udev
->portnum
+ 1;
1329 BUG_ON(test_bit(devnum
, bus
->devmap
.devicemap
));
1331 /* Try to allocate the next devnum beginning at
1332 * bus->devnum_next. */
1333 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
, 128,
1336 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
,
1338 bus
->devnum_next
= ( devnum
>= 127 ? 1 : devnum
+ 1);
1341 set_bit(devnum
, bus
->devmap
.devicemap
);
1342 udev
->devnum
= devnum
;
1346 static void release_address(struct usb_device
*udev
)
1348 if (udev
->devnum
> 0) {
1349 clear_bit(udev
->devnum
, udev
->bus
->devmap
.devicemap
);
1354 static void update_address(struct usb_device
*udev
, int devnum
)
1356 /* The address for a WUSB device is managed by wusbcore. */
1358 udev
->devnum
= devnum
;
1361 #ifdef CONFIG_USB_SUSPEND
1363 static void usb_stop_pm(struct usb_device
*udev
)
1365 /* Synchronize with the ksuspend thread to prevent any more
1366 * autosuspend requests from being submitted, and decrement
1367 * the parent's count of unsuspended children.
1370 if (udev
->parent
&& !udev
->discon_suspended
)
1371 usb_autosuspend_device(udev
->parent
);
1372 usb_pm_unlock(udev
);
1374 /* Stop any autosuspend requests already submitted */
1375 cancel_rearming_delayed_work(&udev
->autosuspend
);
1380 static inline void usb_stop_pm(struct usb_device
*udev
)
1386 * usb_disconnect - disconnect a device (usbcore-internal)
1387 * @pdev: pointer to device being disconnected
1388 * Context: !in_interrupt ()
1390 * Something got disconnected. Get rid of it and all of its children.
1392 * If *pdev is a normal device then the parent hub must already be locked.
1393 * If *pdev is a root hub then this routine will acquire the
1394 * usb_bus_list_lock on behalf of the caller.
1396 * Only hub drivers (including virtual root hub drivers for host
1397 * controllers) should ever call this.
1399 * This call is synchronous, and may not be used in an interrupt context.
1401 void usb_disconnect(struct usb_device
**pdev
)
1403 struct usb_device
*udev
= *pdev
;
1407 pr_debug ("%s nodev\n", __func__
);
1411 /* mark the device as inactive, so any further urb submissions for
1412 * this device (and any of its children) will fail immediately.
1413 * this quiesces everyting except pending urbs.
1415 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
1416 dev_info (&udev
->dev
, "USB disconnect, address %d\n", udev
->devnum
);
1418 usb_lock_device(udev
);
1420 /* Free up all the children before we remove this device */
1421 for (i
= 0; i
< USB_MAXCHILDREN
; i
++) {
1422 if (udev
->children
[i
])
1423 usb_disconnect(&udev
->children
[i
]);
1426 /* deallocate hcd/hardware state ... nuking all pending urbs and
1427 * cleaning up all state associated with the current configuration
1428 * so that the hardware is now fully quiesced.
1430 dev_dbg (&udev
->dev
, "unregistering device\n");
1431 usb_disable_device(udev
, 0);
1432 usb_hcd_synchronize_unlinks(udev
);
1434 usb_unlock_device(udev
);
1436 /* Remove the device-specific files from sysfs. This must be
1437 * done with udev unlocked, because some of the attribute
1438 * routines try to acquire the device lock.
1440 usb_remove_sysfs_dev_files(udev
);
1442 /* Unregister the device. The device driver is responsible
1443 * for removing the device files from usbfs and sysfs and for
1444 * de-configuring the device.
1446 device_del(&udev
->dev
);
1448 /* Free the device number and delete the parent's children[]
1449 * (or root_hub) pointer.
1451 release_address(udev
);
1453 /* Avoid races with recursively_mark_NOTATTACHED() */
1454 spin_lock_irq(&device_state_lock
);
1456 spin_unlock_irq(&device_state_lock
);
1460 put_device(&udev
->dev
);
1463 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
1464 static void show_string(struct usb_device
*udev
, char *id
, char *string
)
1468 dev_printk(KERN_INFO
, &udev
->dev
, "%s: %s\n", id
, string
);
1471 static void announce_device(struct usb_device
*udev
)
1473 dev_info(&udev
->dev
, "New USB device found, idVendor=%04x, idProduct=%04x\n",
1474 le16_to_cpu(udev
->descriptor
.idVendor
),
1475 le16_to_cpu(udev
->descriptor
.idProduct
));
1476 dev_info(&udev
->dev
, "New USB device strings: Mfr=%d, Product=%d, "
1477 "SerialNumber=%d\n",
1478 udev
->descriptor
.iManufacturer
,
1479 udev
->descriptor
.iProduct
,
1480 udev
->descriptor
.iSerialNumber
);
1481 show_string(udev
, "Product", udev
->product
);
1482 show_string(udev
, "Manufacturer", udev
->manufacturer
);
1483 show_string(udev
, "SerialNumber", udev
->serial
);
1486 static inline void announce_device(struct usb_device
*udev
) { }
1489 #ifdef CONFIG_USB_OTG
1490 #include "otg_whitelist.h"
1494 * usb_configure_device_otg - FIXME (usbcore-internal)
1495 * @udev: newly addressed device (in ADDRESS state)
1497 * Do configuration for On-The-Go devices
1499 static int usb_configure_device_otg(struct usb_device
*udev
)
1503 #ifdef CONFIG_USB_OTG
1505 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1506 * to wake us after we've powered off VBUS; and HNP, switching roles
1507 * "host" to "peripheral". The OTG descriptor helps figure this out.
1509 if (!udev
->bus
->is_b_host
1511 && udev
->parent
== udev
->bus
->root_hub
) {
1512 struct usb_otg_descriptor
*desc
= 0;
1513 struct usb_bus
*bus
= udev
->bus
;
1515 /* descriptor may appear anywhere in config */
1516 if (__usb_get_extra_descriptor (udev
->rawdescriptors
[0],
1517 le16_to_cpu(udev
->config
[0].desc
.wTotalLength
),
1518 USB_DT_OTG
, (void **) &desc
) == 0) {
1519 if (desc
->bmAttributes
& USB_OTG_HNP
) {
1520 unsigned port1
= udev
->portnum
;
1522 dev_info(&udev
->dev
,
1523 "Dual-Role OTG device on %sHNP port\n",
1524 (port1
== bus
->otg_port
)
1527 /* enable HNP before suspend, it's simpler */
1528 if (port1
== bus
->otg_port
)
1529 bus
->b_hnp_enable
= 1;
1530 err
= usb_control_msg(udev
,
1531 usb_sndctrlpipe(udev
, 0),
1532 USB_REQ_SET_FEATURE
, 0,
1534 ? USB_DEVICE_B_HNP_ENABLE
1535 : USB_DEVICE_A_ALT_HNP_SUPPORT
,
1536 0, NULL
, 0, USB_CTRL_SET_TIMEOUT
);
1538 /* OTG MESSAGE: report errors here,
1539 * customize to match your product.
1541 dev_info(&udev
->dev
,
1542 "can't set HNP mode; %d\n",
1544 bus
->b_hnp_enable
= 0;
1550 if (!is_targeted(udev
)) {
1552 /* Maybe it can talk to us, though we can't talk to it.
1553 * (Includes HNP test device.)
1555 if (udev
->bus
->b_hnp_enable
|| udev
->bus
->is_b_host
) {
1556 err
= usb_port_suspend(udev
);
1558 dev_dbg(&udev
->dev
, "HNP fail, %d\n", err
);
1570 * usb_configure_device - Detect and probe device intfs/otg (usbcore-internal)
1571 * @udev: newly addressed device (in ADDRESS state)
1573 * This is only called by usb_new_device() and usb_authorize_device()
1574 * and FIXME -- all comments that apply to them apply here wrt to
1577 * If the device is WUSB and not authorized, we don't attempt to read
1578 * the string descriptors, as they will be errored out by the device
1579 * until it has been authorized.
1581 static int usb_configure_device(struct usb_device
*udev
)
1585 if (udev
->config
== NULL
) {
1586 err
= usb_get_configuration(udev
);
1588 dev_err(&udev
->dev
, "can't read configurations, error %d\n",
1593 if (udev
->wusb
== 1 && udev
->authorized
== 0) {
1594 udev
->product
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1595 udev
->manufacturer
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1596 udev
->serial
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1599 /* read the standard strings and cache them if present */
1600 udev
->product
= usb_cache_string(udev
, udev
->descriptor
.iProduct
);
1601 udev
->manufacturer
= usb_cache_string(udev
,
1602 udev
->descriptor
.iManufacturer
);
1603 udev
->serial
= usb_cache_string(udev
, udev
->descriptor
.iSerialNumber
);
1605 err
= usb_configure_device_otg(udev
);
1612 * usb_new_device - perform initial device setup (usbcore-internal)
1613 * @udev: newly addressed device (in ADDRESS state)
1615 * This is called with devices which have been enumerated, but not yet
1616 * configured. The device descriptor is available, but not descriptors
1617 * for any device configuration. The caller must have locked either
1618 * the parent hub (if udev is a normal device) or else the
1619 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1620 * udev has already been installed, but udev is not yet visible through
1621 * sysfs or other filesystem code.
1623 * It will return if the device is configured properly or not. Zero if
1624 * the interface was registered with the driver core; else a negative
1627 * This call is synchronous, and may not be used in an interrupt context.
1629 * Only the hub driver or root-hub registrar should ever call this.
1631 int usb_new_device(struct usb_device
*udev
)
1635 usb_detect_quirks(udev
); /* Determine quirks */
1636 err
= usb_configure_device(udev
); /* detect & probe dev/intfs */
1639 /* export the usbdev device-node for libusb */
1640 udev
->dev
.devt
= MKDEV(USB_DEVICE_MAJOR
,
1641 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
1643 /* Increment the parent's count of unsuspended children */
1645 usb_autoresume_device(udev
->parent
);
1647 /* Register the device. The device driver is responsible
1648 * for adding the device files to sysfs and for configuring
1651 err
= device_add(&udev
->dev
);
1653 dev_err(&udev
->dev
, "can't device_add, error %d\n", err
);
1657 /* put device-specific files into sysfs */
1658 usb_create_sysfs_dev_files(udev
);
1660 /* Tell the world! */
1661 announce_device(udev
);
1665 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
1671 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
1672 * @usb_dev: USB device
1674 * Move the USB device to a very basic state where interfaces are disabled
1675 * and the device is in fact unconfigured and unusable.
1677 * We share a lock (that we have) with device_del(), so we need to
1680 int usb_deauthorize_device(struct usb_device
*usb_dev
)
1683 usb_lock_device(usb_dev
);
1684 if (usb_dev
->authorized
== 0)
1685 goto out_unauthorized
;
1686 usb_dev
->authorized
= 0;
1687 usb_set_configuration(usb_dev
, -1);
1688 usb_dev
->product
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1689 usb_dev
->manufacturer
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1690 usb_dev
->serial
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1691 kfree(usb_dev
->config
);
1692 usb_dev
->config
= NULL
;
1693 for (cnt
= 0; cnt
< usb_dev
->descriptor
.bNumConfigurations
; cnt
++)
1694 kfree(usb_dev
->rawdescriptors
[cnt
]);
1695 usb_dev
->descriptor
.bNumConfigurations
= 0;
1696 kfree(usb_dev
->rawdescriptors
);
1698 usb_unlock_device(usb_dev
);
1703 int usb_authorize_device(struct usb_device
*usb_dev
)
1706 usb_lock_device(usb_dev
);
1707 if (usb_dev
->authorized
== 1)
1708 goto out_authorized
;
1709 kfree(usb_dev
->product
);
1710 usb_dev
->product
= NULL
;
1711 kfree(usb_dev
->manufacturer
);
1712 usb_dev
->manufacturer
= NULL
;
1713 kfree(usb_dev
->serial
);
1714 usb_dev
->serial
= NULL
;
1715 result
= usb_autoresume_device(usb_dev
);
1717 dev_err(&usb_dev
->dev
,
1718 "can't autoresume for authorization: %d\n", result
);
1719 goto error_autoresume
;
1721 result
= usb_get_device_descriptor(usb_dev
, sizeof(usb_dev
->descriptor
));
1723 dev_err(&usb_dev
->dev
, "can't re-read device descriptor for "
1724 "authorization: %d\n", result
);
1725 goto error_device_descriptor
;
1727 usb_dev
->authorized
= 1;
1728 result
= usb_configure_device(usb_dev
);
1730 goto error_configure
;
1731 /* Choose and set the configuration. This registers the interfaces
1732 * with the driver core and lets interface drivers bind to them.
1734 c
= usb_choose_configuration(usb_dev
);
1736 result
= usb_set_configuration(usb_dev
, c
);
1738 dev_err(&usb_dev
->dev
,
1739 "can't set config #%d, error %d\n", c
, result
);
1740 /* This need not be fatal. The user can try to
1741 * set other configurations. */
1744 dev_info(&usb_dev
->dev
, "authorized to connect\n");
1746 error_device_descriptor
:
1749 usb_unlock_device(usb_dev
); // complements locktree
1754 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
1755 static unsigned hub_is_wusb(struct usb_hub
*hub
)
1757 struct usb_hcd
*hcd
;
1758 if (hub
->hdev
->parent
!= NULL
) /* not a root hub? */
1760 hcd
= container_of(hub
->hdev
->bus
, struct usb_hcd
, self
);
1761 return hcd
->wireless
;
1765 #define PORT_RESET_TRIES 5
1766 #define SET_ADDRESS_TRIES 2
1767 #define GET_DESCRIPTOR_TRIES 2
1768 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1769 #define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1771 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1772 #define HUB_SHORT_RESET_TIME 10
1773 #define HUB_LONG_RESET_TIME 200
1774 #define HUB_RESET_TIMEOUT 500
1776 static int hub_port_wait_reset(struct usb_hub
*hub
, int port1
,
1777 struct usb_device
*udev
, unsigned int delay
)
1779 int delay_time
, ret
;
1783 for (delay_time
= 0;
1784 delay_time
< HUB_RESET_TIMEOUT
;
1785 delay_time
+= delay
) {
1786 /* wait to give the device a chance to reset */
1789 /* read and decode port status */
1790 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
1794 /* Device went away? */
1795 if (!(portstatus
& USB_PORT_STAT_CONNECTION
))
1798 /* bomb out completely if the connection bounced */
1799 if ((portchange
& USB_PORT_STAT_C_CONNECTION
))
1802 /* if we`ve finished resetting, then break out of the loop */
1803 if (!(portstatus
& USB_PORT_STAT_RESET
) &&
1804 (portstatus
& USB_PORT_STAT_ENABLE
)) {
1805 if (hub_is_wusb(hub
))
1806 udev
->speed
= USB_SPEED_VARIABLE
;
1807 else if (portstatus
& USB_PORT_STAT_HIGH_SPEED
)
1808 udev
->speed
= USB_SPEED_HIGH
;
1809 else if (portstatus
& USB_PORT_STAT_LOW_SPEED
)
1810 udev
->speed
= USB_SPEED_LOW
;
1812 udev
->speed
= USB_SPEED_FULL
;
1816 /* switch to the long delay after two short delay failures */
1817 if (delay_time
>= 2 * HUB_SHORT_RESET_TIME
)
1818 delay
= HUB_LONG_RESET_TIME
;
1820 dev_dbg (hub
->intfdev
,
1821 "port %d not reset yet, waiting %dms\n",
1828 static int hub_port_reset(struct usb_hub
*hub
, int port1
,
1829 struct usb_device
*udev
, unsigned int delay
)
1833 /* Block EHCI CF initialization during the port reset.
1834 * Some companion controllers don't like it when they mix.
1836 down_read(&ehci_cf_port_reset_rwsem
);
1838 /* Reset the port */
1839 for (i
= 0; i
< PORT_RESET_TRIES
; i
++) {
1840 status
= set_port_feature(hub
->hdev
,
1841 port1
, USB_PORT_FEAT_RESET
);
1843 dev_err(hub
->intfdev
,
1844 "cannot reset port %d (err = %d)\n",
1847 status
= hub_port_wait_reset(hub
, port1
, udev
, delay
);
1848 if (status
&& status
!= -ENOTCONN
)
1849 dev_dbg(hub
->intfdev
,
1850 "port_wait_reset: err = %d\n",
1854 /* return on disconnect or reset */
1857 /* TRSTRCY = 10 ms; plus some extra */
1859 update_address(udev
, 0);
1863 clear_port_feature(hub
->hdev
,
1864 port1
, USB_PORT_FEAT_C_RESET
);
1865 /* FIXME need disconnect() for NOTATTACHED device */
1866 usb_set_device_state(udev
, status
1867 ? USB_STATE_NOTATTACHED
1868 : USB_STATE_DEFAULT
);
1872 dev_dbg (hub
->intfdev
,
1873 "port %d not enabled, trying reset again...\n",
1875 delay
= HUB_LONG_RESET_TIME
;
1878 dev_err (hub
->intfdev
,
1879 "Cannot enable port %i. Maybe the USB cable is bad?\n",
1883 up_read(&ehci_cf_port_reset_rwsem
);
1889 #define MASK_BITS (USB_PORT_STAT_POWER | USB_PORT_STAT_CONNECTION | \
1890 USB_PORT_STAT_SUSPEND)
1891 #define WANT_BITS (USB_PORT_STAT_POWER | USB_PORT_STAT_CONNECTION)
1893 /* Determine whether the device on a port is ready for a normal resume,
1894 * is ready for a reset-resume, or should be disconnected.
1896 static int check_port_resume_type(struct usb_device
*udev
,
1897 struct usb_hub
*hub
, int port1
,
1898 int status
, unsigned portchange
, unsigned portstatus
)
1900 /* Is the device still present? */
1901 if (status
|| (portstatus
& MASK_BITS
) != WANT_BITS
) {
1906 /* Can't do a normal resume if the port isn't enabled,
1907 * so try a reset-resume instead.
1909 else if (!(portstatus
& USB_PORT_STAT_ENABLE
) && !udev
->reset_resume
) {
1910 if (udev
->persist_enabled
)
1911 udev
->reset_resume
= 1;
1917 dev_dbg(hub
->intfdev
,
1918 "port %d status %04x.%04x after resume, %d\n",
1919 port1
, portchange
, portstatus
, status
);
1920 } else if (udev
->reset_resume
) {
1922 /* Late port handoff can set status-change bits */
1923 if (portchange
& USB_PORT_STAT_C_CONNECTION
)
1924 clear_port_feature(hub
->hdev
, port1
,
1925 USB_PORT_FEAT_C_CONNECTION
);
1926 if (portchange
& USB_PORT_STAT_C_ENABLE
)
1927 clear_port_feature(hub
->hdev
, port1
,
1928 USB_PORT_FEAT_C_ENABLE
);
1934 #ifdef CONFIG_USB_SUSPEND
1937 * usb_port_suspend - suspend a usb device's upstream port
1938 * @udev: device that's no longer in active use, not a root hub
1939 * Context: must be able to sleep; device not locked; pm locks held
1941 * Suspends a USB device that isn't in active use, conserving power.
1942 * Devices may wake out of a suspend, if anything important happens,
1943 * using the remote wakeup mechanism. They may also be taken out of
1944 * suspend by the host, using usb_port_resume(). It's also routine
1945 * to disconnect devices while they are suspended.
1947 * This only affects the USB hardware for a device; its interfaces
1948 * (and, for hubs, child devices) must already have been suspended.
1950 * Selective port suspend reduces power; most suspended devices draw
1951 * less than 500 uA. It's also used in OTG, along with remote wakeup.
1952 * All devices below the suspended port are also suspended.
1954 * Devices leave suspend state when the host wakes them up. Some devices
1955 * also support "remote wakeup", where the device can activate the USB
1956 * tree above them to deliver data, such as a keypress or packet. In
1957 * some cases, this wakes the USB host.
1959 * Suspending OTG devices may trigger HNP, if that's been enabled
1960 * between a pair of dual-role devices. That will change roles, such
1961 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
1963 * Devices on USB hub ports have only one "suspend" state, corresponding
1964 * to ACPI D2, "may cause the device to lose some context".
1965 * State transitions include:
1967 * - suspend, resume ... when the VBUS power link stays live
1968 * - suspend, disconnect ... VBUS lost
1970 * Once VBUS drop breaks the circuit, the port it's using has to go through
1971 * normal re-enumeration procedures, starting with enabling VBUS power.
1972 * Other than re-initializing the hub (plug/unplug, except for root hubs),
1973 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
1974 * timer, no SRP, no requests through sysfs.
1976 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
1977 * the root hub for their bus goes into global suspend ... so we don't
1978 * (falsely) update the device power state to say it suspended.
1980 * Returns 0 on success, else negative errno.
1982 int usb_port_suspend(struct usb_device
*udev
)
1984 struct usb_hub
*hub
= hdev_to_hub(udev
->parent
);
1985 int port1
= udev
->portnum
;
1988 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
1990 /* enable remote wakeup when appropriate; this lets the device
1991 * wake up the upstream hub (including maybe the root hub).
1993 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
1994 * we don't explicitly enable it here.
1996 if (udev
->do_remote_wakeup
) {
1997 status
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
1998 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
1999 USB_DEVICE_REMOTE_WAKEUP
, 0,
2001 USB_CTRL_SET_TIMEOUT
);
2003 dev_dbg(&udev
->dev
, "won't remote wakeup, status %d\n",
2008 status
= set_port_feature(hub
->hdev
, port1
, USB_PORT_FEAT_SUSPEND
);
2010 dev_dbg(hub
->intfdev
, "can't suspend port %d, status %d\n",
2012 /* paranoia: "should not happen" */
2013 (void) usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2014 USB_REQ_CLEAR_FEATURE
, USB_RECIP_DEVICE
,
2015 USB_DEVICE_REMOTE_WAKEUP
, 0,
2017 USB_CTRL_SET_TIMEOUT
);
2019 /* device has up to 10 msec to fully suspend */
2020 dev_dbg(&udev
->dev
, "usb %ssuspend\n",
2021 udev
->auto_pm
? "auto-" : "");
2022 usb_set_device_state(udev
, USB_STATE_SUSPENDED
);
2029 * If the USB "suspend" state is in use (rather than "global suspend"),
2030 * many devices will be individually taken out of suspend state using
2031 * special "resume" signaling. This routine kicks in shortly after
2032 * hardware resume signaling is finished, either because of selective
2033 * resume (by host) or remote wakeup (by device) ... now see what changed
2034 * in the tree that's rooted at this device.
2036 * If @udev->reset_resume is set then the device is reset before the
2037 * status check is done.
2039 static int finish_port_resume(struct usb_device
*udev
)
2044 /* caller owns the udev device lock */
2045 dev_dbg(&udev
->dev
, "finish %sresume\n",
2046 udev
->reset_resume
? "reset-" : "");
2048 /* usb ch9 identifies four variants of SUSPENDED, based on what
2049 * state the device resumes to. Linux currently won't see the
2050 * first two on the host side; they'd be inside hub_port_init()
2051 * during many timeouts, but khubd can't suspend until later.
2053 usb_set_device_state(udev
, udev
->actconfig
2054 ? USB_STATE_CONFIGURED
2055 : USB_STATE_ADDRESS
);
2057 /* 10.5.4.5 says not to reset a suspended port if the attached
2058 * device is enabled for remote wakeup. Hence the reset
2059 * operation is carried out here, after the port has been
2062 if (udev
->reset_resume
)
2064 status
= usb_reset_and_verify_device(udev
);
2066 /* 10.5.4.5 says be sure devices in the tree are still there.
2067 * For now let's assume the device didn't go crazy on resume,
2068 * and device drivers will know about any resume quirks.
2072 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0, &devstatus
);
2074 status
= (status
> 0 ? 0 : -ENODEV
);
2076 /* If a normal resume failed, try doing a reset-resume */
2077 if (status
&& !udev
->reset_resume
&& udev
->persist_enabled
) {
2078 dev_dbg(&udev
->dev
, "retry with reset-resume\n");
2079 udev
->reset_resume
= 1;
2080 goto retry_reset_resume
;
2085 dev_dbg(&udev
->dev
, "gone after usb resume? status %d\n",
2087 } else if (udev
->actconfig
) {
2088 le16_to_cpus(&devstatus
);
2089 if (devstatus
& (1 << USB_DEVICE_REMOTE_WAKEUP
)) {
2090 status
= usb_control_msg(udev
,
2091 usb_sndctrlpipe(udev
, 0),
2092 USB_REQ_CLEAR_FEATURE
,
2094 USB_DEVICE_REMOTE_WAKEUP
, 0,
2096 USB_CTRL_SET_TIMEOUT
);
2098 dev_dbg(&udev
->dev
, "disable remote "
2099 "wakeup, status %d\n", status
);
2107 * usb_port_resume - re-activate a suspended usb device's upstream port
2108 * @udev: device to re-activate, not a root hub
2109 * Context: must be able to sleep; device not locked; pm locks held
2111 * This will re-activate the suspended device, increasing power usage
2112 * while letting drivers communicate again with its endpoints.
2113 * USB resume explicitly guarantees that the power session between
2114 * the host and the device is the same as it was when the device
2117 * If @udev->reset_resume is set then this routine won't check that the
2118 * port is still enabled. Furthermore, finish_port_resume() above will
2119 * reset @udev. The end result is that a broken power session can be
2120 * recovered and @udev will appear to persist across a loss of VBUS power.
2122 * For example, if a host controller doesn't maintain VBUS suspend current
2123 * during a system sleep or is reset when the system wakes up, all the USB
2124 * power sessions below it will be broken. This is especially troublesome
2125 * for mass-storage devices containing mounted filesystems, since the
2126 * device will appear to have disconnected and all the memory mappings
2127 * to it will be lost. Using the USB_PERSIST facility, the device can be
2128 * made to appear as if it had not disconnected.
2130 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
2131 * every effort to insure that the same device is present after the
2132 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
2133 * quite possible for a device to remain unaltered but its media to be
2134 * changed. If the user replaces a flash memory card while the system is
2135 * asleep, he will have only himself to blame when the filesystem on the
2136 * new card is corrupted and the system crashes.
2138 * Returns 0 on success, else negative errno.
2140 int usb_port_resume(struct usb_device
*udev
)
2142 struct usb_hub
*hub
= hdev_to_hub(udev
->parent
);
2143 int port1
= udev
->portnum
;
2145 u16 portchange
, portstatus
;
2147 /* Skip the initial Clear-Suspend step for a remote wakeup */
2148 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
2149 if (status
== 0 && !(portstatus
& USB_PORT_STAT_SUSPEND
))
2150 goto SuspendCleared
;
2152 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
2154 set_bit(port1
, hub
->busy_bits
);
2156 /* see 7.1.7.7; affects power usage, but not budgeting */
2157 status
= clear_port_feature(hub
->hdev
,
2158 port1
, USB_PORT_FEAT_SUSPEND
);
2160 dev_dbg(hub
->intfdev
, "can't resume port %d, status %d\n",
2163 /* drive resume for at least 20 msec */
2164 dev_dbg(&udev
->dev
, "usb %sresume\n",
2165 udev
->auto_pm
? "auto-" : "");
2168 /* Virtual root hubs can trigger on GET_PORT_STATUS to
2169 * stop resume signaling. Then finish the resume
2172 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
2174 /* TRSMRCY = 10 msec */
2180 if (portchange
& USB_PORT_STAT_C_SUSPEND
)
2181 clear_port_feature(hub
->hdev
, port1
,
2182 USB_PORT_FEAT_C_SUSPEND
);
2185 clear_bit(port1
, hub
->busy_bits
);
2187 status
= check_port_resume_type(udev
,
2188 hub
, port1
, status
, portchange
, portstatus
);
2190 status
= finish_port_resume(udev
);
2192 dev_dbg(&udev
->dev
, "can't resume, status %d\n", status
);
2193 hub_port_logical_disconnect(hub
, port1
);
2198 /* caller has locked udev */
2199 static int remote_wakeup(struct usb_device
*udev
)
2203 if (udev
->state
== USB_STATE_SUSPENDED
) {
2204 dev_dbg(&udev
->dev
, "usb %sresume\n", "wakeup-");
2205 usb_mark_last_busy(udev
);
2206 status
= usb_external_resume_device(udev
);
2211 #else /* CONFIG_USB_SUSPEND */
2213 /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
2215 int usb_port_suspend(struct usb_device
*udev
)
2220 /* However we may need to do a reset-resume */
2222 int usb_port_resume(struct usb_device
*udev
)
2224 struct usb_hub
*hub
= hdev_to_hub(udev
->parent
);
2225 int port1
= udev
->portnum
;
2227 u16 portchange
, portstatus
;
2229 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
2230 status
= check_port_resume_type(udev
,
2231 hub
, port1
, status
, portchange
, portstatus
);
2234 dev_dbg(&udev
->dev
, "can't resume, status %d\n", status
);
2235 hub_port_logical_disconnect(hub
, port1
);
2236 } else if (udev
->reset_resume
) {
2237 dev_dbg(&udev
->dev
, "reset-resume\n");
2238 status
= usb_reset_and_verify_device(udev
);
2243 static inline int remote_wakeup(struct usb_device
*udev
)
2250 static int hub_suspend(struct usb_interface
*intf
, pm_message_t msg
)
2252 struct usb_hub
*hub
= usb_get_intfdata (intf
);
2253 struct usb_device
*hdev
= hub
->hdev
;
2256 /* fail if children aren't already suspended */
2257 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
2258 struct usb_device
*udev
;
2260 udev
= hdev
->children
[port1
-1];
2261 if (udev
&& udev
->can_submit
) {
2263 dev_dbg(&intf
->dev
, "port %d nyet suspended\n",
2269 dev_dbg(&intf
->dev
, "%s\n", __func__
);
2271 /* stop khubd and related activity */
2272 hub_quiesce(hub
, HUB_SUSPEND
);
2276 static int hub_resume(struct usb_interface
*intf
)
2278 struct usb_hub
*hub
= usb_get_intfdata(intf
);
2280 dev_dbg(&intf
->dev
, "%s\n", __func__
);
2281 hub_activate(hub
, HUB_RESUME
);
2285 static int hub_reset_resume(struct usb_interface
*intf
)
2287 struct usb_hub
*hub
= usb_get_intfdata(intf
);
2289 dev_dbg(&intf
->dev
, "%s\n", __func__
);
2290 hub_activate(hub
, HUB_RESET_RESUME
);
2295 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
2296 * @rhdev: struct usb_device for the root hub
2298 * The USB host controller driver calls this function when its root hub
2299 * is resumed and Vbus power has been interrupted or the controller
2300 * has been reset. The routine marks @rhdev as having lost power.
2301 * When the hub driver is resumed it will take notice and carry out
2302 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
2303 * the others will be disconnected.
2305 void usb_root_hub_lost_power(struct usb_device
*rhdev
)
2307 dev_warn(&rhdev
->dev
, "root hub lost power or was reset\n");
2308 rhdev
->reset_resume
= 1;
2310 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power
);
2312 #else /* CONFIG_PM */
2314 static inline int remote_wakeup(struct usb_device
*udev
)
2319 #define hub_suspend NULL
2320 #define hub_resume NULL
2321 #define hub_reset_resume NULL
2325 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2327 * Between connect detection and reset signaling there must be a delay
2328 * of 100ms at least for debounce and power-settling. The corresponding
2329 * timer shall restart whenever the downstream port detects a disconnect.
2331 * Apparently there are some bluetooth and irda-dongles and a number of
2332 * low-speed devices for which this debounce period may last over a second.
2333 * Not covered by the spec - but easy to deal with.
2335 * This implementation uses a 1500ms total debounce timeout; if the
2336 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2337 * every 25ms for transient disconnects. When the port status has been
2338 * unchanged for 100ms it returns the port status.
2340 static int hub_port_debounce(struct usb_hub
*hub
, int port1
)
2343 int total_time
, stable_time
= 0;
2344 u16 portchange
, portstatus
;
2345 unsigned connection
= 0xffff;
2347 for (total_time
= 0; ; total_time
+= HUB_DEBOUNCE_STEP
) {
2348 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
2352 if (!(portchange
& USB_PORT_STAT_C_CONNECTION
) &&
2353 (portstatus
& USB_PORT_STAT_CONNECTION
) == connection
) {
2354 stable_time
+= HUB_DEBOUNCE_STEP
;
2355 if (stable_time
>= HUB_DEBOUNCE_STABLE
)
2359 connection
= portstatus
& USB_PORT_STAT_CONNECTION
;
2362 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
2363 clear_port_feature(hub
->hdev
, port1
,
2364 USB_PORT_FEAT_C_CONNECTION
);
2367 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
2369 msleep(HUB_DEBOUNCE_STEP
);
2372 dev_dbg (hub
->intfdev
,
2373 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2374 port1
, total_time
, stable_time
, portstatus
);
2376 if (stable_time
< HUB_DEBOUNCE_STABLE
)
2381 void usb_ep0_reinit(struct usb_device
*udev
)
2383 usb_disable_endpoint(udev
, 0 + USB_DIR_IN
);
2384 usb_disable_endpoint(udev
, 0 + USB_DIR_OUT
);
2385 usb_enable_endpoint(udev
, &udev
->ep0
);
2387 EXPORT_SYMBOL_GPL(usb_ep0_reinit
);
2389 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2390 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2392 static int hub_set_address(struct usb_device
*udev
, int devnum
)
2398 if (udev
->state
== USB_STATE_ADDRESS
)
2400 if (udev
->state
!= USB_STATE_DEFAULT
)
2402 retval
= usb_control_msg(udev
, usb_sndaddr0pipe(),
2403 USB_REQ_SET_ADDRESS
, 0, devnum
, 0,
2404 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
2406 /* Device now using proper address. */
2407 update_address(udev
, devnum
);
2408 usb_set_device_state(udev
, USB_STATE_ADDRESS
);
2409 usb_ep0_reinit(udev
);
2414 /* Reset device, (re)assign address, get device descriptor.
2415 * Device connection must be stable, no more debouncing needed.
2416 * Returns device in USB_STATE_ADDRESS, except on error.
2418 * If this is called for an already-existing device (as part of
2419 * usb_reset_and_verify_device), the caller must own the device lock. For a
2420 * newly detected device that is not accessible through any global
2421 * pointers, it's not necessary to lock the device.
2424 hub_port_init (struct usb_hub
*hub
, struct usb_device
*udev
, int port1
,
2427 static DEFINE_MUTEX(usb_address0_mutex
);
2429 struct usb_device
*hdev
= hub
->hdev
;
2431 unsigned delay
= HUB_SHORT_RESET_TIME
;
2432 enum usb_device_speed oldspeed
= udev
->speed
;
2434 int devnum
= udev
->devnum
;
2436 /* root hub ports have a slightly longer reset period
2437 * (from USB 2.0 spec, section 7.1.7.5)
2439 if (!hdev
->parent
) {
2440 delay
= HUB_ROOT_RESET_TIME
;
2441 if (port1
== hdev
->bus
->otg_port
)
2442 hdev
->bus
->b_hnp_enable
= 0;
2445 /* Some low speed devices have problems with the quick delay, so */
2446 /* be a bit pessimistic with those devices. RHbug #23670 */
2447 if (oldspeed
== USB_SPEED_LOW
)
2448 delay
= HUB_LONG_RESET_TIME
;
2450 mutex_lock(&usb_address0_mutex
);
2452 /* Reset the device; full speed may morph to high speed */
2453 retval
= hub_port_reset(hub
, port1
, udev
, delay
);
2454 if (retval
< 0) /* error or disconnect */
2456 /* success, speed is known */
2459 if (oldspeed
!= USB_SPEED_UNKNOWN
&& oldspeed
!= udev
->speed
) {
2460 dev_dbg(&udev
->dev
, "device reset changed speed!\n");
2463 oldspeed
= udev
->speed
;
2465 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2466 * it's fixed size except for full speed devices.
2467 * For Wireless USB devices, ep0 max packet is always 512 (tho
2468 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
2470 switch (udev
->speed
) {
2471 case USB_SPEED_VARIABLE
: /* fixed at 512 */
2472 udev
->ep0
.desc
.wMaxPacketSize
= __constant_cpu_to_le16(512);
2474 case USB_SPEED_HIGH
: /* fixed at 64 */
2475 udev
->ep0
.desc
.wMaxPacketSize
= __constant_cpu_to_le16(64);
2477 case USB_SPEED_FULL
: /* 8, 16, 32, or 64 */
2478 /* to determine the ep0 maxpacket size, try to read
2479 * the device descriptor to get bMaxPacketSize0 and
2480 * then correct our initial guess.
2482 udev
->ep0
.desc
.wMaxPacketSize
= __constant_cpu_to_le16(64);
2484 case USB_SPEED_LOW
: /* fixed at 8 */
2485 udev
->ep0
.desc
.wMaxPacketSize
= __constant_cpu_to_le16(8);
2492 switch (udev
->speed
) {
2493 case USB_SPEED_LOW
: speed
= "low"; break;
2494 case USB_SPEED_FULL
: speed
= "full"; break;
2495 case USB_SPEED_HIGH
: speed
= "high"; break;
2496 case USB_SPEED_VARIABLE
:
2500 default: speed
= "?"; break;
2502 dev_info (&udev
->dev
,
2503 "%s %s speed %sUSB device using %s and address %d\n",
2504 (udev
->config
) ? "reset" : "new", speed
, type
,
2505 udev
->bus
->controller
->driver
->name
, devnum
);
2507 /* Set up TT records, if needed */
2509 udev
->tt
= hdev
->tt
;
2510 udev
->ttport
= hdev
->ttport
;
2511 } else if (udev
->speed
!= USB_SPEED_HIGH
2512 && hdev
->speed
== USB_SPEED_HIGH
) {
2513 udev
->tt
= &hub
->tt
;
2514 udev
->ttport
= port1
;
2517 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2518 * Because device hardware and firmware is sometimes buggy in
2519 * this area, and this is how Linux has done it for ages.
2520 * Change it cautiously.
2522 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2523 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2524 * so it may help with some non-standards-compliant devices.
2525 * Otherwise we start with SET_ADDRESS and then try to read the
2526 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2529 for (i
= 0; i
< GET_DESCRIPTOR_TRIES
; (++i
, msleep(100))) {
2530 if (USE_NEW_SCHEME(retry_counter
)) {
2531 struct usb_device_descriptor
*buf
;
2534 #define GET_DESCRIPTOR_BUFSIZE 64
2535 buf
= kmalloc(GET_DESCRIPTOR_BUFSIZE
, GFP_NOIO
);
2541 /* Retry on all errors; some devices are flakey.
2542 * 255 is for WUSB devices, we actually need to use
2543 * 512 (WUSB1.0[4.8.1]).
2545 for (j
= 0; j
< 3; ++j
) {
2546 buf
->bMaxPacketSize0
= 0;
2547 r
= usb_control_msg(udev
, usb_rcvaddr0pipe(),
2548 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
,
2549 USB_DT_DEVICE
<< 8, 0,
2550 buf
, GET_DESCRIPTOR_BUFSIZE
,
2551 initial_descriptor_timeout
);
2552 switch (buf
->bMaxPacketSize0
) {
2553 case 8: case 16: case 32: case 64: case 255:
2554 if (buf
->bDescriptorType
==
2568 udev
->descriptor
.bMaxPacketSize0
=
2569 buf
->bMaxPacketSize0
;
2572 retval
= hub_port_reset(hub
, port1
, udev
, delay
);
2573 if (retval
< 0) /* error or disconnect */
2575 if (oldspeed
!= udev
->speed
) {
2577 "device reset changed speed!\n");
2582 dev_err(&udev
->dev
, "device descriptor "
2583 "read/%s, error %d\n",
2588 #undef GET_DESCRIPTOR_BUFSIZE
2592 * If device is WUSB, we already assigned an
2593 * unauthorized address in the Connect Ack sequence;
2594 * authorization will assign the final address.
2596 if (udev
->wusb
== 0) {
2597 for (j
= 0; j
< SET_ADDRESS_TRIES
; ++j
) {
2598 retval
= hub_set_address(udev
, devnum
);
2605 "device not accepting address %d, error %d\n",
2610 /* cope with hardware quirkiness:
2611 * - let SET_ADDRESS settle, some device hardware wants it
2612 * - read ep0 maxpacket even for high and low speed,
2615 if (USE_NEW_SCHEME(retry_counter
))
2619 retval
= usb_get_device_descriptor(udev
, 8);
2621 dev_err(&udev
->dev
, "device descriptor "
2622 "read/%s, error %d\n",
2634 i
= udev
->descriptor
.bMaxPacketSize0
== 0xff? /* wusb device? */
2635 512 : udev
->descriptor
.bMaxPacketSize0
;
2636 if (le16_to_cpu(udev
->ep0
.desc
.wMaxPacketSize
) != i
) {
2637 if (udev
->speed
!= USB_SPEED_FULL
||
2638 !(i
== 8 || i
== 16 || i
== 32 || i
== 64)) {
2639 dev_err(&udev
->dev
, "ep0 maxpacket = %d\n", i
);
2643 dev_dbg(&udev
->dev
, "ep0 maxpacket = %d\n", i
);
2644 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(i
);
2645 usb_ep0_reinit(udev
);
2648 retval
= usb_get_device_descriptor(udev
, USB_DT_DEVICE_SIZE
);
2649 if (retval
< (signed)sizeof(udev
->descriptor
)) {
2650 dev_err(&udev
->dev
, "device descriptor read/%s, error %d\n",
2661 hub_port_disable(hub
, port1
, 0);
2662 update_address(udev
, devnum
); /* for disconnect processing */
2664 mutex_unlock(&usb_address0_mutex
);
2669 check_highspeed (struct usb_hub
*hub
, struct usb_device
*udev
, int port1
)
2671 struct usb_qualifier_descriptor
*qual
;
2674 qual
= kmalloc (sizeof *qual
, GFP_KERNEL
);
2678 status
= usb_get_descriptor (udev
, USB_DT_DEVICE_QUALIFIER
, 0,
2679 qual
, sizeof *qual
);
2680 if (status
== sizeof *qual
) {
2681 dev_info(&udev
->dev
, "not running at top speed; "
2682 "connect to a high speed hub\n");
2683 /* hub LEDs are probably harder to miss than syslog */
2684 if (hub
->has_indicators
) {
2685 hub
->indicator
[port1
-1] = INDICATOR_GREEN_BLINK
;
2686 schedule_delayed_work (&hub
->leds
, 0);
2693 hub_power_remaining (struct usb_hub
*hub
)
2695 struct usb_device
*hdev
= hub
->hdev
;
2699 if (!hub
->limited_power
)
2702 remaining
= hdev
->bus_mA
- hub
->descriptor
->bHubContrCurrent
;
2703 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
2704 struct usb_device
*udev
= hdev
->children
[port1
- 1];
2710 /* Unconfigured devices may not use more than 100mA,
2711 * or 8mA for OTG ports */
2712 if (udev
->actconfig
)
2713 delta
= udev
->actconfig
->desc
.bMaxPower
* 2;
2714 else if (port1
!= udev
->bus
->otg_port
|| hdev
->parent
)
2718 if (delta
> hub
->mA_per_port
)
2719 dev_warn(&udev
->dev
, "%dmA is over %umA budget "
2721 delta
, hub
->mA_per_port
, port1
);
2724 if (remaining
< 0) {
2725 dev_warn(hub
->intfdev
, "%dmA over power budget!\n",
2732 /* Handle physical or logical connection change events.
2733 * This routine is called when:
2734 * a port connection-change occurs;
2735 * a port enable-change occurs (often caused by EMI);
2736 * usb_reset_and_verify_device() encounters changed descriptors (as from
2737 * a firmware download)
2738 * caller already locked the hub
2740 static void hub_port_connect_change(struct usb_hub
*hub
, int port1
,
2741 u16 portstatus
, u16 portchange
)
2743 struct usb_device
*hdev
= hub
->hdev
;
2744 struct device
*hub_dev
= hub
->intfdev
;
2745 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
2746 unsigned wHubCharacteristics
=
2747 le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
2748 struct usb_device
*udev
;
2752 "port %d, status %04x, change %04x, %s\n",
2753 port1
, portstatus
, portchange
, portspeed (portstatus
));
2755 if (hub
->has_indicators
) {
2756 set_port_led(hub
, port1
, HUB_LED_AUTO
);
2757 hub
->indicator
[port1
-1] = INDICATOR_AUTO
;
2760 #ifdef CONFIG_USB_OTG
2761 /* during HNP, don't repeat the debounce */
2762 if (hdev
->bus
->is_b_host
)
2763 portchange
&= ~(USB_PORT_STAT_C_CONNECTION
|
2764 USB_PORT_STAT_C_ENABLE
);
2767 /* Try to resuscitate an existing device */
2768 udev
= hdev
->children
[port1
-1];
2769 if ((portstatus
& USB_PORT_STAT_CONNECTION
) && udev
&&
2770 udev
->state
!= USB_STATE_NOTATTACHED
) {
2771 usb_lock_device(udev
);
2772 if (portstatus
& USB_PORT_STAT_ENABLE
) {
2773 status
= 0; /* Nothing to do */
2775 #ifdef CONFIG_USB_SUSPEND
2776 } else if (udev
->state
== USB_STATE_SUSPENDED
&&
2777 udev
->persist_enabled
) {
2778 /* For a suspended device, treat this as a
2779 * remote wakeup event.
2781 if (udev
->do_remote_wakeup
)
2782 status
= remote_wakeup(udev
);
2784 /* Otherwise leave it be; devices can't tell the
2785 * difference between suspended and disabled.
2792 status
= -ENODEV
; /* Don't resuscitate */
2794 usb_unlock_device(udev
);
2797 clear_bit(port1
, hub
->change_bits
);
2802 /* Disconnect any existing devices under this port */
2804 usb_disconnect(&hdev
->children
[port1
-1]);
2805 clear_bit(port1
, hub
->change_bits
);
2807 if (portchange
& (USB_PORT_STAT_C_CONNECTION
|
2808 USB_PORT_STAT_C_ENABLE
)) {
2809 status
= hub_port_debounce(hub
, port1
);
2811 if (printk_ratelimit())
2812 dev_err(hub_dev
, "connect-debounce failed, "
2813 "port %d disabled\n", port1
);
2814 portstatus
&= ~USB_PORT_STAT_CONNECTION
;
2816 portstatus
= status
;
2820 /* Return now if debouncing failed or nothing is connected */
2821 if (!(portstatus
& USB_PORT_STAT_CONNECTION
)) {
2823 /* maybe switch power back on (e.g. root hub was reset) */
2824 if ((wHubCharacteristics
& HUB_CHAR_LPSM
) < 2
2825 && !(portstatus
& (1 << USB_PORT_FEAT_POWER
)))
2826 set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
2828 if (portstatus
& USB_PORT_STAT_ENABLE
)
2833 for (i
= 0; i
< SET_CONFIG_TRIES
; i
++) {
2835 /* reallocate for each attempt, since references
2836 * to the previous one can escape in various ways
2838 udev
= usb_alloc_dev(hdev
, hdev
->bus
, port1
);
2841 "couldn't allocate port %d usb_device\n",
2846 usb_set_device_state(udev
, USB_STATE_POWERED
);
2847 udev
->speed
= USB_SPEED_UNKNOWN
;
2848 udev
->bus_mA
= hub
->mA_per_port
;
2849 udev
->level
= hdev
->level
+ 1;
2850 udev
->wusb
= hub_is_wusb(hub
);
2852 /* set the address */
2853 choose_address(udev
);
2854 if (udev
->devnum
<= 0) {
2855 status
= -ENOTCONN
; /* Don't retry */
2859 /* reset and get descriptor */
2860 status
= hub_port_init(hub
, udev
, port1
, i
);
2864 /* consecutive bus-powered hubs aren't reliable; they can
2865 * violate the voltage drop budget. if the new child has
2866 * a "powered" LED, users should notice we didn't enable it
2867 * (without reading syslog), even without per-port LEDs
2870 if (udev
->descriptor
.bDeviceClass
== USB_CLASS_HUB
2871 && udev
->bus_mA
<= 100) {
2874 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0,
2877 dev_dbg(&udev
->dev
, "get status %d ?\n", status
);
2880 le16_to_cpus(&devstat
);
2881 if ((devstat
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
2883 "can't connect bus-powered hub "
2885 if (hub
->has_indicators
) {
2886 hub
->indicator
[port1
-1] =
2887 INDICATOR_AMBER_BLINK
;
2888 schedule_delayed_work (&hub
->leds
, 0);
2890 status
= -ENOTCONN
; /* Don't retry */
2895 /* check for devices running slower than they could */
2896 if (le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0200
2897 && udev
->speed
== USB_SPEED_FULL
2898 && highspeed_hubs
!= 0)
2899 check_highspeed (hub
, udev
, port1
);
2901 /* Store the parent's children[] pointer. At this point
2902 * udev becomes globally accessible, although presumably
2903 * no one will look at it until hdev is unlocked.
2907 /* We mustn't add new devices if the parent hub has
2908 * been disconnected; we would race with the
2909 * recursively_mark_NOTATTACHED() routine.
2911 spin_lock_irq(&device_state_lock
);
2912 if (hdev
->state
== USB_STATE_NOTATTACHED
)
2915 hdev
->children
[port1
-1] = udev
;
2916 spin_unlock_irq(&device_state_lock
);
2918 /* Run it through the hoops (find a driver, etc) */
2920 status
= usb_new_device(udev
);
2922 spin_lock_irq(&device_state_lock
);
2923 hdev
->children
[port1
-1] = NULL
;
2924 spin_unlock_irq(&device_state_lock
);
2931 status
= hub_power_remaining(hub
);
2933 dev_dbg(hub_dev
, "%dmA power budget left\n", status
);
2938 hub_port_disable(hub
, port1
, 1);
2940 usb_ep0_reinit(udev
);
2941 release_address(udev
);
2943 if ((status
== -ENOTCONN
) || (status
== -ENOTSUPP
))
2946 if (hub
->hdev
->parent
||
2947 !hcd
->driver
->port_handed_over
||
2948 !(hcd
->driver
->port_handed_over
)(hcd
, port1
))
2949 dev_err(hub_dev
, "unable to enumerate USB device on port %d\n",
2953 hub_port_disable(hub
, port1
, 1);
2954 if (hcd
->driver
->relinquish_port
&& !hub
->hdev
->parent
)
2955 hcd
->driver
->relinquish_port(hcd
, port1
);
2958 static void hub_events(void)
2960 struct list_head
*tmp
;
2961 struct usb_device
*hdev
;
2962 struct usb_interface
*intf
;
2963 struct usb_hub
*hub
;
2964 struct device
*hub_dev
;
2973 * We restart the list every time to avoid a deadlock with
2974 * deleting hubs downstream from this one. This should be
2975 * safe since we delete the hub from the event list.
2976 * Not the most efficient, but avoids deadlocks.
2980 /* Grab the first entry at the beginning of the list */
2981 spin_lock_irq(&hub_event_lock
);
2982 if (list_empty(&hub_event_list
)) {
2983 spin_unlock_irq(&hub_event_lock
);
2987 tmp
= hub_event_list
.next
;
2990 hub
= list_entry(tmp
, struct usb_hub
, event_list
);
2991 kref_get(&hub
->kref
);
2992 spin_unlock_irq(&hub_event_lock
);
2995 hub_dev
= hub
->intfdev
;
2996 intf
= to_usb_interface(hub_dev
);
2997 dev_dbg(hub_dev
, "state %d ports %d chg %04x evt %04x\n",
2998 hdev
->state
, hub
->descriptor
2999 ? hub
->descriptor
->bNbrPorts
3001 /* NOTE: expects max 15 ports... */
3002 (u16
) hub
->change_bits
[0],
3003 (u16
) hub
->event_bits
[0]);
3005 /* Lock the device, then check to see if we were
3006 * disconnected while waiting for the lock to succeed. */
3007 usb_lock_device(hdev
);
3008 if (unlikely(hub
->disconnected
))
3011 /* If the hub has died, clean up after it */
3012 if (hdev
->state
== USB_STATE_NOTATTACHED
) {
3013 hub
->error
= -ENODEV
;
3014 hub_quiesce(hub
, HUB_DISCONNECT
);
3019 ret
= usb_autopm_get_interface(intf
);
3021 dev_dbg(hub_dev
, "Can't autoresume: %d\n", ret
);
3025 /* If this is an inactive hub, do nothing */
3030 dev_dbg (hub_dev
, "resetting for error %d\n",
3033 ret
= usb_reset_device(hdev
);
3036 "error resetting hub: %d\n", ret
);
3044 /* deal with port status changes */
3045 for (i
= 1; i
<= hub
->descriptor
->bNbrPorts
; i
++) {
3046 if (test_bit(i
, hub
->busy_bits
))
3048 connect_change
= test_bit(i
, hub
->change_bits
);
3049 if (!test_and_clear_bit(i
, hub
->event_bits
) &&
3053 ret
= hub_port_status(hub
, i
,
3054 &portstatus
, &portchange
);
3058 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
3059 clear_port_feature(hdev
, i
,
3060 USB_PORT_FEAT_C_CONNECTION
);
3064 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
3065 if (!connect_change
)
3067 "port %d enable change, "
3070 clear_port_feature(hdev
, i
,
3071 USB_PORT_FEAT_C_ENABLE
);
3074 * EM interference sometimes causes badly
3075 * shielded USB devices to be shutdown by
3076 * the hub, this hack enables them again.
3077 * Works at least with mouse driver.
3079 if (!(portstatus
& USB_PORT_STAT_ENABLE
)
3081 && hdev
->children
[i
-1]) {
3084 "disabled by hub (EMI?), "
3091 if (portchange
& USB_PORT_STAT_C_SUSPEND
) {
3092 struct usb_device
*udev
;
3094 clear_port_feature(hdev
, i
,
3095 USB_PORT_FEAT_C_SUSPEND
);
3096 udev
= hdev
->children
[i
-1];
3098 usb_lock_device(udev
);
3099 ret
= remote_wakeup(hdev
->
3101 usb_unlock_device(udev
);
3106 hub_port_disable(hub
, i
, 1);
3109 "resume on port %d, status %d\n",
3113 if (portchange
& USB_PORT_STAT_C_OVERCURRENT
) {
3115 "over-current change on port %d\n",
3117 clear_port_feature(hdev
, i
,
3118 USB_PORT_FEAT_C_OVER_CURRENT
);
3119 hub_power_on(hub
, true);
3122 if (portchange
& USB_PORT_STAT_C_RESET
) {
3124 "reset change on port %d\n",
3126 clear_port_feature(hdev
, i
,
3127 USB_PORT_FEAT_C_RESET
);
3131 hub_port_connect_change(hub
, i
,
3132 portstatus
, portchange
);
3135 /* deal with hub status changes */
3136 if (test_and_clear_bit(0, hub
->event_bits
) == 0)
3138 else if (hub_hub_status(hub
, &hubstatus
, &hubchange
) < 0)
3139 dev_err (hub_dev
, "get_hub_status failed\n");
3141 if (hubchange
& HUB_CHANGE_LOCAL_POWER
) {
3142 dev_dbg (hub_dev
, "power change\n");
3143 clear_hub_feature(hdev
, C_HUB_LOCAL_POWER
);
3144 if (hubstatus
& HUB_STATUS_LOCAL_POWER
)
3145 /* FIXME: Is this always true? */
3146 hub
->limited_power
= 1;
3148 hub
->limited_power
= 0;
3150 if (hubchange
& HUB_CHANGE_OVERCURRENT
) {
3151 dev_dbg (hub_dev
, "overcurrent change\n");
3152 msleep(500); /* Cool down */
3153 clear_hub_feature(hdev
, C_HUB_OVER_CURRENT
);
3154 hub_power_on(hub
, true);
3159 /* Allow autosuspend if we're not going to run again */
3160 if (list_empty(&hub
->event_list
))
3161 usb_autopm_enable(intf
);
3163 usb_unlock_device(hdev
);
3164 kref_put(&hub
->kref
, hub_release
);
3166 } /* end while (1) */
3169 static int hub_thread(void *__unused
)
3171 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
3172 * port handover. Otherwise it might see that a full-speed device
3173 * was gone before the EHCI controller had handed its port over to
3174 * the companion full-speed controller.
3180 wait_event_freezable(khubd_wait
,
3181 !list_empty(&hub_event_list
) ||
3182 kthread_should_stop());
3183 } while (!kthread_should_stop() || !list_empty(&hub_event_list
));
3185 pr_debug("%s: khubd exiting\n", usbcore_name
);
3189 static struct usb_device_id hub_id_table
[] = {
3190 { .match_flags
= USB_DEVICE_ID_MATCH_DEV_CLASS
,
3191 .bDeviceClass
= USB_CLASS_HUB
},
3192 { .match_flags
= USB_DEVICE_ID_MATCH_INT_CLASS
,
3193 .bInterfaceClass
= USB_CLASS_HUB
},
3194 { } /* Terminating entry */
3197 MODULE_DEVICE_TABLE (usb
, hub_id_table
);
3199 static struct usb_driver hub_driver
= {
3202 .disconnect
= hub_disconnect
,
3203 .suspend
= hub_suspend
,
3204 .resume
= hub_resume
,
3205 .reset_resume
= hub_reset_resume
,
3206 .pre_reset
= hub_pre_reset
,
3207 .post_reset
= hub_post_reset
,
3209 .id_table
= hub_id_table
,
3210 .supports_autosuspend
= 1,
3213 int usb_hub_init(void)
3215 if (usb_register(&hub_driver
) < 0) {
3216 printk(KERN_ERR
"%s: can't register hub driver\n",
3221 khubd_task
= kthread_run(hub_thread
, NULL
, "khubd");
3222 if (!IS_ERR(khubd_task
))
3225 /* Fall through if kernel_thread failed */
3226 usb_deregister(&hub_driver
);
3227 printk(KERN_ERR
"%s: can't start khubd\n", usbcore_name
);
3232 void usb_hub_cleanup(void)
3234 kthread_stop(khubd_task
);
3237 * Hub resources are freed for us by usb_deregister. It calls
3238 * usb_driver_purge on every device which in turn calls that
3239 * devices disconnect function if it is using this driver.
3240 * The hub_disconnect function takes care of releasing the
3241 * individual hub resources. -greg
3243 usb_deregister(&hub_driver
);
3244 } /* usb_hub_cleanup() */
3246 static int descriptors_changed(struct usb_device
*udev
,
3247 struct usb_device_descriptor
*old_device_descriptor
)
3251 unsigned serial_len
= 0;
3253 unsigned old_length
;
3257 if (memcmp(&udev
->descriptor
, old_device_descriptor
,
3258 sizeof(*old_device_descriptor
)) != 0)
3261 /* Since the idVendor, idProduct, and bcdDevice values in the
3262 * device descriptor haven't changed, we will assume the
3263 * Manufacturer and Product strings haven't changed either.
3264 * But the SerialNumber string could be different (e.g., a
3265 * different flash card of the same brand).
3268 serial_len
= strlen(udev
->serial
) + 1;
3271 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
3272 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
3273 len
= max(len
, old_length
);
3276 buf
= kmalloc(len
, GFP_NOIO
);
3278 dev_err(&udev
->dev
, "no mem to re-read configs after reset\n");
3279 /* assume the worst */
3282 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
3283 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
3284 length
= usb_get_descriptor(udev
, USB_DT_CONFIG
, index
, buf
,
3286 if (length
!= old_length
) {
3287 dev_dbg(&udev
->dev
, "config index %d, error %d\n",
3292 if (memcmp (buf
, udev
->rawdescriptors
[index
], old_length
)
3294 dev_dbg(&udev
->dev
, "config index %d changed (#%d)\n",
3296 ((struct usb_config_descriptor
*) buf
)->
3297 bConfigurationValue
);
3303 if (!changed
&& serial_len
) {
3304 length
= usb_string(udev
, udev
->descriptor
.iSerialNumber
,
3306 if (length
+ 1 != serial_len
) {
3307 dev_dbg(&udev
->dev
, "serial string error %d\n",
3310 } else if (memcmp(buf
, udev
->serial
, length
) != 0) {
3311 dev_dbg(&udev
->dev
, "serial string changed\n");
3321 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
3322 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3324 * WARNING - don't use this routine to reset a composite device
3325 * (one with multiple interfaces owned by separate drivers)!
3326 * Use usb_reset_device() instead.
3328 * Do a port reset, reassign the device's address, and establish its
3329 * former operating configuration. If the reset fails, or the device's
3330 * descriptors change from their values before the reset, or the original
3331 * configuration and altsettings cannot be restored, a flag will be set
3332 * telling khubd to pretend the device has been disconnected and then
3333 * re-connected. All drivers will be unbound, and the device will be
3334 * re-enumerated and probed all over again.
3336 * Returns 0 if the reset succeeded, -ENODEV if the device has been
3337 * flagged for logical disconnection, or some other negative error code
3338 * if the reset wasn't even attempted.
3340 * The caller must own the device lock. For example, it's safe to use
3341 * this from a driver probe() routine after downloading new firmware.
3342 * For calls that might not occur during probe(), drivers should lock
3343 * the device using usb_lock_device_for_reset().
3345 * Locking exception: This routine may also be called from within an
3346 * autoresume handler. Such usage won't conflict with other tasks
3347 * holding the device lock because these tasks should always call
3348 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
3350 static int usb_reset_and_verify_device(struct usb_device
*udev
)
3352 struct usb_device
*parent_hdev
= udev
->parent
;
3353 struct usb_hub
*parent_hub
;
3354 struct usb_device_descriptor descriptor
= udev
->descriptor
;
3356 int port1
= udev
->portnum
;
3358 if (udev
->state
== USB_STATE_NOTATTACHED
||
3359 udev
->state
== USB_STATE_SUSPENDED
) {
3360 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
3366 /* this requires hcd-specific logic; see OHCI hc_restart() */
3367 dev_dbg(&udev
->dev
, "%s for root hub!\n", __func__
);
3370 parent_hub
= hdev_to_hub(parent_hdev
);
3372 set_bit(port1
, parent_hub
->busy_bits
);
3373 for (i
= 0; i
< SET_CONFIG_TRIES
; ++i
) {
3375 /* ep0 maxpacket size may change; let the HCD know about it.
3376 * Other endpoints will be handled by re-enumeration. */
3377 usb_ep0_reinit(udev
);
3378 ret
= hub_port_init(parent_hub
, udev
, port1
, i
);
3379 if (ret
>= 0 || ret
== -ENOTCONN
|| ret
== -ENODEV
)
3382 clear_bit(port1
, parent_hub
->busy_bits
);
3387 /* Device might have changed firmware (DFU or similar) */
3388 if (descriptors_changed(udev
, &descriptor
)) {
3389 dev_info(&udev
->dev
, "device firmware changed\n");
3390 udev
->descriptor
= descriptor
; /* for disconnect() calls */
3394 if (!udev
->actconfig
)
3397 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3398 USB_REQ_SET_CONFIGURATION
, 0,
3399 udev
->actconfig
->desc
.bConfigurationValue
, 0,
3400 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
3403 "can't restore configuration #%d (error=%d)\n",
3404 udev
->actconfig
->desc
.bConfigurationValue
, ret
);
3407 usb_set_device_state(udev
, USB_STATE_CONFIGURED
);
3409 for (i
= 0; i
< udev
->actconfig
->desc
.bNumInterfaces
; i
++) {
3410 struct usb_interface
*intf
= udev
->actconfig
->interface
[i
];
3411 struct usb_interface_descriptor
*desc
;
3413 /* set_interface resets host side toggle even
3414 * for altsetting zero. the interface may have no driver.
3416 desc
= &intf
->cur_altsetting
->desc
;
3417 ret
= usb_set_interface(udev
, desc
->bInterfaceNumber
,
3418 desc
->bAlternateSetting
);
3420 dev_err(&udev
->dev
, "failed to restore interface %d "
3421 "altsetting %d (error=%d)\n",
3422 desc
->bInterfaceNumber
,
3423 desc
->bAlternateSetting
,
3433 hub_port_logical_disconnect(parent_hub
, port1
);
3438 * usb_reset_device - warn interface drivers and perform a USB port reset
3439 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3441 * Warns all drivers bound to registered interfaces (using their pre_reset
3442 * method), performs the port reset, and then lets the drivers know that
3443 * the reset is over (using their post_reset method).
3445 * Return value is the same as for usb_reset_and_verify_device().
3447 * The caller must own the device lock. For example, it's safe to use
3448 * this from a driver probe() routine after downloading new firmware.
3449 * For calls that might not occur during probe(), drivers should lock
3450 * the device using usb_lock_device_for_reset().
3452 * If an interface is currently being probed or disconnected, we assume
3453 * its driver knows how to handle resets. For all other interfaces,
3454 * if the driver doesn't have pre_reset and post_reset methods then
3455 * we attempt to unbind it and rebind afterward.
3457 int usb_reset_device(struct usb_device
*udev
)
3461 struct usb_host_config
*config
= udev
->actconfig
;
3463 if (udev
->state
== USB_STATE_NOTATTACHED
||
3464 udev
->state
== USB_STATE_SUSPENDED
) {
3465 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
3470 /* Prevent autosuspend during the reset */
3471 usb_autoresume_device(udev
);
3474 for (i
= 0; i
< config
->desc
.bNumInterfaces
; ++i
) {
3475 struct usb_interface
*cintf
= config
->interface
[i
];
3476 struct usb_driver
*drv
;
3479 if (cintf
->dev
.driver
) {
3480 drv
= to_usb_driver(cintf
->dev
.driver
);
3481 if (drv
->pre_reset
&& drv
->post_reset
)
3482 unbind
= (drv
->pre_reset
)(cintf
);
3483 else if (cintf
->condition
==
3484 USB_INTERFACE_BOUND
)
3487 usb_forced_unbind_intf(cintf
);
3492 ret
= usb_reset_and_verify_device(udev
);
3495 for (i
= config
->desc
.bNumInterfaces
- 1; i
>= 0; --i
) {
3496 struct usb_interface
*cintf
= config
->interface
[i
];
3497 struct usb_driver
*drv
;
3498 int rebind
= cintf
->needs_binding
;
3500 if (!rebind
&& cintf
->dev
.driver
) {
3501 drv
= to_usb_driver(cintf
->dev
.driver
);
3502 if (drv
->post_reset
)
3503 rebind
= (drv
->post_reset
)(cintf
);
3504 else if (cintf
->condition
==
3505 USB_INTERFACE_BOUND
)
3508 if (ret
== 0 && rebind
)
3509 usb_rebind_intf(cintf
);
3513 usb_autosuspend_device(udev
);
3516 EXPORT_SYMBOL_GPL(usb_reset_device
);