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);
1433 usb_unlock_device(udev
);
1435 /* Remove the device-specific files from sysfs. This must be
1436 * done with udev unlocked, because some of the attribute
1437 * routines try to acquire the device lock.
1439 usb_remove_sysfs_dev_files(udev
);
1441 /* Unregister the device. The device driver is responsible
1442 * for removing the device files from usbfs and sysfs and for
1443 * de-configuring the device.
1445 device_del(&udev
->dev
);
1447 /* Free the device number and delete the parent's children[]
1448 * (or root_hub) pointer.
1450 release_address(udev
);
1452 /* Avoid races with recursively_mark_NOTATTACHED() */
1453 spin_lock_irq(&device_state_lock
);
1455 spin_unlock_irq(&device_state_lock
);
1459 put_device(&udev
->dev
);
1462 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
1463 static void show_string(struct usb_device
*udev
, char *id
, char *string
)
1467 dev_printk(KERN_INFO
, &udev
->dev
, "%s: %s\n", id
, string
);
1470 static void announce_device(struct usb_device
*udev
)
1472 dev_info(&udev
->dev
, "New USB device found, idVendor=%04x, idProduct=%04x\n",
1473 le16_to_cpu(udev
->descriptor
.idVendor
),
1474 le16_to_cpu(udev
->descriptor
.idProduct
));
1475 dev_info(&udev
->dev
, "New USB device strings: Mfr=%d, Product=%d, "
1476 "SerialNumber=%d\n",
1477 udev
->descriptor
.iManufacturer
,
1478 udev
->descriptor
.iProduct
,
1479 udev
->descriptor
.iSerialNumber
);
1480 show_string(udev
, "Product", udev
->product
);
1481 show_string(udev
, "Manufacturer", udev
->manufacturer
);
1482 show_string(udev
, "SerialNumber", udev
->serial
);
1485 static inline void announce_device(struct usb_device
*udev
) { }
1488 #ifdef CONFIG_USB_OTG
1489 #include "otg_whitelist.h"
1493 * usb_configure_device_otg - FIXME (usbcore-internal)
1494 * @udev: newly addressed device (in ADDRESS state)
1496 * Do configuration for On-The-Go devices
1498 static int usb_configure_device_otg(struct usb_device
*udev
)
1502 #ifdef CONFIG_USB_OTG
1504 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1505 * to wake us after we've powered off VBUS; and HNP, switching roles
1506 * "host" to "peripheral". The OTG descriptor helps figure this out.
1508 if (!udev
->bus
->is_b_host
1510 && udev
->parent
== udev
->bus
->root_hub
) {
1511 struct usb_otg_descriptor
*desc
= 0;
1512 struct usb_bus
*bus
= udev
->bus
;
1514 /* descriptor may appear anywhere in config */
1515 if (__usb_get_extra_descriptor (udev
->rawdescriptors
[0],
1516 le16_to_cpu(udev
->config
[0].desc
.wTotalLength
),
1517 USB_DT_OTG
, (void **) &desc
) == 0) {
1518 if (desc
->bmAttributes
& USB_OTG_HNP
) {
1519 unsigned port1
= udev
->portnum
;
1521 dev_info(&udev
->dev
,
1522 "Dual-Role OTG device on %sHNP port\n",
1523 (port1
== bus
->otg_port
)
1526 /* enable HNP before suspend, it's simpler */
1527 if (port1
== bus
->otg_port
)
1528 bus
->b_hnp_enable
= 1;
1529 err
= usb_control_msg(udev
,
1530 usb_sndctrlpipe(udev
, 0),
1531 USB_REQ_SET_FEATURE
, 0,
1533 ? USB_DEVICE_B_HNP_ENABLE
1534 : USB_DEVICE_A_ALT_HNP_SUPPORT
,
1535 0, NULL
, 0, USB_CTRL_SET_TIMEOUT
);
1537 /* OTG MESSAGE: report errors here,
1538 * customize to match your product.
1540 dev_info(&udev
->dev
,
1541 "can't set HNP mode; %d\n",
1543 bus
->b_hnp_enable
= 0;
1549 if (!is_targeted(udev
)) {
1551 /* Maybe it can talk to us, though we can't talk to it.
1552 * (Includes HNP test device.)
1554 if (udev
->bus
->b_hnp_enable
|| udev
->bus
->is_b_host
) {
1555 err
= usb_port_suspend(udev
);
1557 dev_dbg(&udev
->dev
, "HNP fail, %d\n", err
);
1569 * usb_configure_device - Detect and probe device intfs/otg (usbcore-internal)
1570 * @udev: newly addressed device (in ADDRESS state)
1572 * This is only called by usb_new_device() and usb_authorize_device()
1573 * and FIXME -- all comments that apply to them apply here wrt to
1576 * If the device is WUSB and not authorized, we don't attempt to read
1577 * the string descriptors, as they will be errored out by the device
1578 * until it has been authorized.
1580 static int usb_configure_device(struct usb_device
*udev
)
1584 if (udev
->config
== NULL
) {
1585 err
= usb_get_configuration(udev
);
1587 dev_err(&udev
->dev
, "can't read configurations, error %d\n",
1592 if (udev
->wusb
== 1 && udev
->authorized
== 0) {
1593 udev
->product
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1594 udev
->manufacturer
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1595 udev
->serial
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1598 /* read the standard strings and cache them if present */
1599 udev
->product
= usb_cache_string(udev
, udev
->descriptor
.iProduct
);
1600 udev
->manufacturer
= usb_cache_string(udev
,
1601 udev
->descriptor
.iManufacturer
);
1602 udev
->serial
= usb_cache_string(udev
, udev
->descriptor
.iSerialNumber
);
1604 err
= usb_configure_device_otg(udev
);
1611 * usb_new_device - perform initial device setup (usbcore-internal)
1612 * @udev: newly addressed device (in ADDRESS state)
1614 * This is called with devices which have been enumerated, but not yet
1615 * configured. The device descriptor is available, but not descriptors
1616 * for any device configuration. The caller must have locked either
1617 * the parent hub (if udev is a normal device) or else the
1618 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1619 * udev has already been installed, but udev is not yet visible through
1620 * sysfs or other filesystem code.
1622 * It will return if the device is configured properly or not. Zero if
1623 * the interface was registered with the driver core; else a negative
1626 * This call is synchronous, and may not be used in an interrupt context.
1628 * Only the hub driver or root-hub registrar should ever call this.
1630 int usb_new_device(struct usb_device
*udev
)
1634 usb_detect_quirks(udev
); /* Determine quirks */
1635 err
= usb_configure_device(udev
); /* detect & probe dev/intfs */
1638 /* export the usbdev device-node for libusb */
1639 udev
->dev
.devt
= MKDEV(USB_DEVICE_MAJOR
,
1640 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
1642 /* Increment the parent's count of unsuspended children */
1644 usb_autoresume_device(udev
->parent
);
1646 /* Register the device. The device driver is responsible
1647 * for adding the device files to sysfs and for configuring
1650 err
= device_add(&udev
->dev
);
1652 dev_err(&udev
->dev
, "can't device_add, error %d\n", err
);
1656 /* put device-specific files into sysfs */
1657 usb_create_sysfs_dev_files(udev
);
1659 /* Tell the world! */
1660 announce_device(udev
);
1664 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
1670 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
1671 * @usb_dev: USB device
1673 * Move the USB device to a very basic state where interfaces are disabled
1674 * and the device is in fact unconfigured and unusable.
1676 * We share a lock (that we have) with device_del(), so we need to
1679 int usb_deauthorize_device(struct usb_device
*usb_dev
)
1682 usb_lock_device(usb_dev
);
1683 if (usb_dev
->authorized
== 0)
1684 goto out_unauthorized
;
1685 usb_dev
->authorized
= 0;
1686 usb_set_configuration(usb_dev
, -1);
1687 usb_dev
->product
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1688 usb_dev
->manufacturer
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1689 usb_dev
->serial
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1690 kfree(usb_dev
->config
);
1691 usb_dev
->config
= NULL
;
1692 for (cnt
= 0; cnt
< usb_dev
->descriptor
.bNumConfigurations
; cnt
++)
1693 kfree(usb_dev
->rawdescriptors
[cnt
]);
1694 usb_dev
->descriptor
.bNumConfigurations
= 0;
1695 kfree(usb_dev
->rawdescriptors
);
1697 usb_unlock_device(usb_dev
);
1702 int usb_authorize_device(struct usb_device
*usb_dev
)
1705 usb_lock_device(usb_dev
);
1706 if (usb_dev
->authorized
== 1)
1707 goto out_authorized
;
1708 kfree(usb_dev
->product
);
1709 usb_dev
->product
= NULL
;
1710 kfree(usb_dev
->manufacturer
);
1711 usb_dev
->manufacturer
= NULL
;
1712 kfree(usb_dev
->serial
);
1713 usb_dev
->serial
= NULL
;
1714 result
= usb_autoresume_device(usb_dev
);
1716 dev_err(&usb_dev
->dev
,
1717 "can't autoresume for authorization: %d\n", result
);
1718 goto error_autoresume
;
1720 result
= usb_get_device_descriptor(usb_dev
, sizeof(usb_dev
->descriptor
));
1722 dev_err(&usb_dev
->dev
, "can't re-read device descriptor for "
1723 "authorization: %d\n", result
);
1724 goto error_device_descriptor
;
1726 usb_dev
->authorized
= 1;
1727 result
= usb_configure_device(usb_dev
);
1729 goto error_configure
;
1730 /* Choose and set the configuration. This registers the interfaces
1731 * with the driver core and lets interface drivers bind to them.
1733 c
= usb_choose_configuration(usb_dev
);
1735 result
= usb_set_configuration(usb_dev
, c
);
1737 dev_err(&usb_dev
->dev
,
1738 "can't set config #%d, error %d\n", c
, result
);
1739 /* This need not be fatal. The user can try to
1740 * set other configurations. */
1743 dev_info(&usb_dev
->dev
, "authorized to connect\n");
1745 error_device_descriptor
:
1748 usb_unlock_device(usb_dev
); // complements locktree
1753 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
1754 static unsigned hub_is_wusb(struct usb_hub
*hub
)
1756 struct usb_hcd
*hcd
;
1757 if (hub
->hdev
->parent
!= NULL
) /* not a root hub? */
1759 hcd
= container_of(hub
->hdev
->bus
, struct usb_hcd
, self
);
1760 return hcd
->wireless
;
1764 #define PORT_RESET_TRIES 5
1765 #define SET_ADDRESS_TRIES 2
1766 #define GET_DESCRIPTOR_TRIES 2
1767 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1768 #define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1770 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1771 #define HUB_SHORT_RESET_TIME 10
1772 #define HUB_LONG_RESET_TIME 200
1773 #define HUB_RESET_TIMEOUT 500
1775 static int hub_port_wait_reset(struct usb_hub
*hub
, int port1
,
1776 struct usb_device
*udev
, unsigned int delay
)
1778 int delay_time
, ret
;
1782 for (delay_time
= 0;
1783 delay_time
< HUB_RESET_TIMEOUT
;
1784 delay_time
+= delay
) {
1785 /* wait to give the device a chance to reset */
1788 /* read and decode port status */
1789 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
1793 /* Device went away? */
1794 if (!(portstatus
& USB_PORT_STAT_CONNECTION
))
1797 /* bomb out completely if the connection bounced */
1798 if ((portchange
& USB_PORT_STAT_C_CONNECTION
))
1801 /* if we`ve finished resetting, then break out of the loop */
1802 if (!(portstatus
& USB_PORT_STAT_RESET
) &&
1803 (portstatus
& USB_PORT_STAT_ENABLE
)) {
1804 if (hub_is_wusb(hub
))
1805 udev
->speed
= USB_SPEED_VARIABLE
;
1806 else if (portstatus
& USB_PORT_STAT_HIGH_SPEED
)
1807 udev
->speed
= USB_SPEED_HIGH
;
1808 else if (portstatus
& USB_PORT_STAT_LOW_SPEED
)
1809 udev
->speed
= USB_SPEED_LOW
;
1811 udev
->speed
= USB_SPEED_FULL
;
1815 /* switch to the long delay after two short delay failures */
1816 if (delay_time
>= 2 * HUB_SHORT_RESET_TIME
)
1817 delay
= HUB_LONG_RESET_TIME
;
1819 dev_dbg (hub
->intfdev
,
1820 "port %d not reset yet, waiting %dms\n",
1827 static int hub_port_reset(struct usb_hub
*hub
, int port1
,
1828 struct usb_device
*udev
, unsigned int delay
)
1832 /* Block EHCI CF initialization during the port reset.
1833 * Some companion controllers don't like it when they mix.
1835 down_read(&ehci_cf_port_reset_rwsem
);
1837 /* Reset the port */
1838 for (i
= 0; i
< PORT_RESET_TRIES
; i
++) {
1839 status
= set_port_feature(hub
->hdev
,
1840 port1
, USB_PORT_FEAT_RESET
);
1842 dev_err(hub
->intfdev
,
1843 "cannot reset port %d (err = %d)\n",
1846 status
= hub_port_wait_reset(hub
, port1
, udev
, delay
);
1847 if (status
&& status
!= -ENOTCONN
)
1848 dev_dbg(hub
->intfdev
,
1849 "port_wait_reset: err = %d\n",
1853 /* return on disconnect or reset */
1856 /* TRSTRCY = 10 ms; plus some extra */
1858 update_address(udev
, 0);
1862 clear_port_feature(hub
->hdev
,
1863 port1
, USB_PORT_FEAT_C_RESET
);
1864 /* FIXME need disconnect() for NOTATTACHED device */
1865 usb_set_device_state(udev
, status
1866 ? USB_STATE_NOTATTACHED
1867 : USB_STATE_DEFAULT
);
1871 dev_dbg (hub
->intfdev
,
1872 "port %d not enabled, trying reset again...\n",
1874 delay
= HUB_LONG_RESET_TIME
;
1877 dev_err (hub
->intfdev
,
1878 "Cannot enable port %i. Maybe the USB cable is bad?\n",
1882 up_read(&ehci_cf_port_reset_rwsem
);
1888 #define MASK_BITS (USB_PORT_STAT_POWER | USB_PORT_STAT_CONNECTION | \
1889 USB_PORT_STAT_SUSPEND)
1890 #define WANT_BITS (USB_PORT_STAT_POWER | USB_PORT_STAT_CONNECTION)
1892 /* Determine whether the device on a port is ready for a normal resume,
1893 * is ready for a reset-resume, or should be disconnected.
1895 static int check_port_resume_type(struct usb_device
*udev
,
1896 struct usb_hub
*hub
, int port1
,
1897 int status
, unsigned portchange
, unsigned portstatus
)
1899 /* Is the device still present? */
1900 if (status
|| (portstatus
& MASK_BITS
) != WANT_BITS
) {
1905 /* Can't do a normal resume if the port isn't enabled,
1906 * so try a reset-resume instead.
1908 else if (!(portstatus
& USB_PORT_STAT_ENABLE
) && !udev
->reset_resume
) {
1909 if (udev
->persist_enabled
)
1910 udev
->reset_resume
= 1;
1916 dev_dbg(hub
->intfdev
,
1917 "port %d status %04x.%04x after resume, %d\n",
1918 port1
, portchange
, portstatus
, status
);
1919 } else if (udev
->reset_resume
) {
1921 /* Late port handoff can set status-change bits */
1922 if (portchange
& USB_PORT_STAT_C_CONNECTION
)
1923 clear_port_feature(hub
->hdev
, port1
,
1924 USB_PORT_FEAT_C_CONNECTION
);
1925 if (portchange
& USB_PORT_STAT_C_ENABLE
)
1926 clear_port_feature(hub
->hdev
, port1
,
1927 USB_PORT_FEAT_C_ENABLE
);
1933 #ifdef CONFIG_USB_SUSPEND
1936 * usb_port_suspend - suspend a usb device's upstream port
1937 * @udev: device that's no longer in active use, not a root hub
1938 * Context: must be able to sleep; device not locked; pm locks held
1940 * Suspends a USB device that isn't in active use, conserving power.
1941 * Devices may wake out of a suspend, if anything important happens,
1942 * using the remote wakeup mechanism. They may also be taken out of
1943 * suspend by the host, using usb_port_resume(). It's also routine
1944 * to disconnect devices while they are suspended.
1946 * This only affects the USB hardware for a device; its interfaces
1947 * (and, for hubs, child devices) must already have been suspended.
1949 * Selective port suspend reduces power; most suspended devices draw
1950 * less than 500 uA. It's also used in OTG, along with remote wakeup.
1951 * All devices below the suspended port are also suspended.
1953 * Devices leave suspend state when the host wakes them up. Some devices
1954 * also support "remote wakeup", where the device can activate the USB
1955 * tree above them to deliver data, such as a keypress or packet. In
1956 * some cases, this wakes the USB host.
1958 * Suspending OTG devices may trigger HNP, if that's been enabled
1959 * between a pair of dual-role devices. That will change roles, such
1960 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
1962 * Devices on USB hub ports have only one "suspend" state, corresponding
1963 * to ACPI D2, "may cause the device to lose some context".
1964 * State transitions include:
1966 * - suspend, resume ... when the VBUS power link stays live
1967 * - suspend, disconnect ... VBUS lost
1969 * Once VBUS drop breaks the circuit, the port it's using has to go through
1970 * normal re-enumeration procedures, starting with enabling VBUS power.
1971 * Other than re-initializing the hub (plug/unplug, except for root hubs),
1972 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
1973 * timer, no SRP, no requests through sysfs.
1975 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
1976 * the root hub for their bus goes into global suspend ... so we don't
1977 * (falsely) update the device power state to say it suspended.
1979 * Returns 0 on success, else negative errno.
1981 int usb_port_suspend(struct usb_device
*udev
)
1983 struct usb_hub
*hub
= hdev_to_hub(udev
->parent
);
1984 int port1
= udev
->portnum
;
1987 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
1989 /* enable remote wakeup when appropriate; this lets the device
1990 * wake up the upstream hub (including maybe the root hub).
1992 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
1993 * we don't explicitly enable it here.
1995 if (udev
->do_remote_wakeup
) {
1996 status
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
1997 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
1998 USB_DEVICE_REMOTE_WAKEUP
, 0,
2000 USB_CTRL_SET_TIMEOUT
);
2002 dev_dbg(&udev
->dev
, "won't remote wakeup, status %d\n",
2007 status
= set_port_feature(hub
->hdev
, port1
, USB_PORT_FEAT_SUSPEND
);
2009 dev_dbg(hub
->intfdev
, "can't suspend port %d, status %d\n",
2011 /* paranoia: "should not happen" */
2012 (void) usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2013 USB_REQ_CLEAR_FEATURE
, USB_RECIP_DEVICE
,
2014 USB_DEVICE_REMOTE_WAKEUP
, 0,
2016 USB_CTRL_SET_TIMEOUT
);
2018 /* device has up to 10 msec to fully suspend */
2019 dev_dbg(&udev
->dev
, "usb %ssuspend\n",
2020 udev
->auto_pm
? "auto-" : "");
2021 usb_set_device_state(udev
, USB_STATE_SUSPENDED
);
2028 * If the USB "suspend" state is in use (rather than "global suspend"),
2029 * many devices will be individually taken out of suspend state using
2030 * special "resume" signaling. This routine kicks in shortly after
2031 * hardware resume signaling is finished, either because of selective
2032 * resume (by host) or remote wakeup (by device) ... now see what changed
2033 * in the tree that's rooted at this device.
2035 * If @udev->reset_resume is set then the device is reset before the
2036 * status check is done.
2038 static int finish_port_resume(struct usb_device
*udev
)
2043 /* caller owns the udev device lock */
2044 dev_dbg(&udev
->dev
, "finish %sresume\n",
2045 udev
->reset_resume
? "reset-" : "");
2047 /* usb ch9 identifies four variants of SUSPENDED, based on what
2048 * state the device resumes to. Linux currently won't see the
2049 * first two on the host side; they'd be inside hub_port_init()
2050 * during many timeouts, but khubd can't suspend until later.
2052 usb_set_device_state(udev
, udev
->actconfig
2053 ? USB_STATE_CONFIGURED
2054 : USB_STATE_ADDRESS
);
2056 /* 10.5.4.5 says not to reset a suspended port if the attached
2057 * device is enabled for remote wakeup. Hence the reset
2058 * operation is carried out here, after the port has been
2061 if (udev
->reset_resume
)
2063 status
= usb_reset_and_verify_device(udev
);
2065 /* 10.5.4.5 says be sure devices in the tree are still there.
2066 * For now let's assume the device didn't go crazy on resume,
2067 * and device drivers will know about any resume quirks.
2071 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0, &devstatus
);
2073 status
= (status
> 0 ? 0 : -ENODEV
);
2075 /* If a normal resume failed, try doing a reset-resume */
2076 if (status
&& !udev
->reset_resume
&& udev
->persist_enabled
) {
2077 dev_dbg(&udev
->dev
, "retry with reset-resume\n");
2078 udev
->reset_resume
= 1;
2079 goto retry_reset_resume
;
2084 dev_dbg(&udev
->dev
, "gone after usb resume? status %d\n",
2086 } else if (udev
->actconfig
) {
2087 le16_to_cpus(&devstatus
);
2088 if (devstatus
& (1 << USB_DEVICE_REMOTE_WAKEUP
)) {
2089 status
= usb_control_msg(udev
,
2090 usb_sndctrlpipe(udev
, 0),
2091 USB_REQ_CLEAR_FEATURE
,
2093 USB_DEVICE_REMOTE_WAKEUP
, 0,
2095 USB_CTRL_SET_TIMEOUT
);
2097 dev_dbg(&udev
->dev
, "disable remote "
2098 "wakeup, status %d\n", status
);
2106 * usb_port_resume - re-activate a suspended usb device's upstream port
2107 * @udev: device to re-activate, not a root hub
2108 * Context: must be able to sleep; device not locked; pm locks held
2110 * This will re-activate the suspended device, increasing power usage
2111 * while letting drivers communicate again with its endpoints.
2112 * USB resume explicitly guarantees that the power session between
2113 * the host and the device is the same as it was when the device
2116 * If @udev->reset_resume is set then this routine won't check that the
2117 * port is still enabled. Furthermore, finish_port_resume() above will
2118 * reset @udev. The end result is that a broken power session can be
2119 * recovered and @udev will appear to persist across a loss of VBUS power.
2121 * For example, if a host controller doesn't maintain VBUS suspend current
2122 * during a system sleep or is reset when the system wakes up, all the USB
2123 * power sessions below it will be broken. This is especially troublesome
2124 * for mass-storage devices containing mounted filesystems, since the
2125 * device will appear to have disconnected and all the memory mappings
2126 * to it will be lost. Using the USB_PERSIST facility, the device can be
2127 * made to appear as if it had not disconnected.
2129 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
2130 * every effort to insure that the same device is present after the
2131 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
2132 * quite possible for a device to remain unaltered but its media to be
2133 * changed. If the user replaces a flash memory card while the system is
2134 * asleep, he will have only himself to blame when the filesystem on the
2135 * new card is corrupted and the system crashes.
2137 * Returns 0 on success, else negative errno.
2139 int usb_port_resume(struct usb_device
*udev
)
2141 struct usb_hub
*hub
= hdev_to_hub(udev
->parent
);
2142 int port1
= udev
->portnum
;
2144 u16 portchange
, portstatus
;
2146 /* Skip the initial Clear-Suspend step for a remote wakeup */
2147 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
2148 if (status
== 0 && !(portstatus
& USB_PORT_STAT_SUSPEND
))
2149 goto SuspendCleared
;
2151 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
2153 set_bit(port1
, hub
->busy_bits
);
2155 /* see 7.1.7.7; affects power usage, but not budgeting */
2156 status
= clear_port_feature(hub
->hdev
,
2157 port1
, USB_PORT_FEAT_SUSPEND
);
2159 dev_dbg(hub
->intfdev
, "can't resume port %d, status %d\n",
2162 /* drive resume for at least 20 msec */
2163 dev_dbg(&udev
->dev
, "usb %sresume\n",
2164 udev
->auto_pm
? "auto-" : "");
2167 /* Virtual root hubs can trigger on GET_PORT_STATUS to
2168 * stop resume signaling. Then finish the resume
2171 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
2173 /* TRSMRCY = 10 msec */
2179 if (portchange
& USB_PORT_STAT_C_SUSPEND
)
2180 clear_port_feature(hub
->hdev
, port1
,
2181 USB_PORT_FEAT_C_SUSPEND
);
2184 clear_bit(port1
, hub
->busy_bits
);
2186 status
= check_port_resume_type(udev
,
2187 hub
, port1
, status
, portchange
, portstatus
);
2189 status
= finish_port_resume(udev
);
2191 dev_dbg(&udev
->dev
, "can't resume, status %d\n", status
);
2192 hub_port_logical_disconnect(hub
, port1
);
2197 /* caller has locked udev */
2198 static int remote_wakeup(struct usb_device
*udev
)
2202 if (udev
->state
== USB_STATE_SUSPENDED
) {
2203 dev_dbg(&udev
->dev
, "usb %sresume\n", "wakeup-");
2204 usb_mark_last_busy(udev
);
2205 status
= usb_external_resume_device(udev
);
2210 #else /* CONFIG_USB_SUSPEND */
2212 /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
2214 int usb_port_suspend(struct usb_device
*udev
)
2219 /* However we may need to do a reset-resume */
2221 int usb_port_resume(struct usb_device
*udev
)
2223 struct usb_hub
*hub
= hdev_to_hub(udev
->parent
);
2224 int port1
= udev
->portnum
;
2226 u16 portchange
, portstatus
;
2228 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
2229 status
= check_port_resume_type(udev
,
2230 hub
, port1
, status
, portchange
, portstatus
);
2233 dev_dbg(&udev
->dev
, "can't resume, status %d\n", status
);
2234 hub_port_logical_disconnect(hub
, port1
);
2235 } else if (udev
->reset_resume
) {
2236 dev_dbg(&udev
->dev
, "reset-resume\n");
2237 status
= usb_reset_and_verify_device(udev
);
2242 static inline int remote_wakeup(struct usb_device
*udev
)
2249 static int hub_suspend(struct usb_interface
*intf
, pm_message_t msg
)
2251 struct usb_hub
*hub
= usb_get_intfdata (intf
);
2252 struct usb_device
*hdev
= hub
->hdev
;
2255 /* fail if children aren't already suspended */
2256 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
2257 struct usb_device
*udev
;
2259 udev
= hdev
->children
[port1
-1];
2260 if (udev
&& udev
->can_submit
) {
2262 dev_dbg(&intf
->dev
, "port %d nyet suspended\n",
2268 dev_dbg(&intf
->dev
, "%s\n", __func__
);
2270 /* stop khubd and related activity */
2271 hub_quiesce(hub
, HUB_SUSPEND
);
2275 static int hub_resume(struct usb_interface
*intf
)
2277 struct usb_hub
*hub
= usb_get_intfdata(intf
);
2279 dev_dbg(&intf
->dev
, "%s\n", __func__
);
2280 hub_activate(hub
, HUB_RESUME
);
2284 static int hub_reset_resume(struct usb_interface
*intf
)
2286 struct usb_hub
*hub
= usb_get_intfdata(intf
);
2288 dev_dbg(&intf
->dev
, "%s\n", __func__
);
2289 hub_activate(hub
, HUB_RESET_RESUME
);
2294 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
2295 * @rhdev: struct usb_device for the root hub
2297 * The USB host controller driver calls this function when its root hub
2298 * is resumed and Vbus power has been interrupted or the controller
2299 * has been reset. The routine marks @rhdev as having lost power.
2300 * When the hub driver is resumed it will take notice and carry out
2301 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
2302 * the others will be disconnected.
2304 void usb_root_hub_lost_power(struct usb_device
*rhdev
)
2306 dev_warn(&rhdev
->dev
, "root hub lost power or was reset\n");
2307 rhdev
->reset_resume
= 1;
2309 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power
);
2311 #else /* CONFIG_PM */
2313 static inline int remote_wakeup(struct usb_device
*udev
)
2318 #define hub_suspend NULL
2319 #define hub_resume NULL
2320 #define hub_reset_resume NULL
2324 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2326 * Between connect detection and reset signaling there must be a delay
2327 * of 100ms at least for debounce and power-settling. The corresponding
2328 * timer shall restart whenever the downstream port detects a disconnect.
2330 * Apparently there are some bluetooth and irda-dongles and a number of
2331 * low-speed devices for which this debounce period may last over a second.
2332 * Not covered by the spec - but easy to deal with.
2334 * This implementation uses a 1500ms total debounce timeout; if the
2335 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2336 * every 25ms for transient disconnects. When the port status has been
2337 * unchanged for 100ms it returns the port status.
2339 static int hub_port_debounce(struct usb_hub
*hub
, int port1
)
2342 int total_time
, stable_time
= 0;
2343 u16 portchange
, portstatus
;
2344 unsigned connection
= 0xffff;
2346 for (total_time
= 0; ; total_time
+= HUB_DEBOUNCE_STEP
) {
2347 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
2351 if (!(portchange
& USB_PORT_STAT_C_CONNECTION
) &&
2352 (portstatus
& USB_PORT_STAT_CONNECTION
) == connection
) {
2353 stable_time
+= HUB_DEBOUNCE_STEP
;
2354 if (stable_time
>= HUB_DEBOUNCE_STABLE
)
2358 connection
= portstatus
& USB_PORT_STAT_CONNECTION
;
2361 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
2362 clear_port_feature(hub
->hdev
, port1
,
2363 USB_PORT_FEAT_C_CONNECTION
);
2366 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
2368 msleep(HUB_DEBOUNCE_STEP
);
2371 dev_dbg (hub
->intfdev
,
2372 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2373 port1
, total_time
, stable_time
, portstatus
);
2375 if (stable_time
< HUB_DEBOUNCE_STABLE
)
2380 void usb_ep0_reinit(struct usb_device
*udev
)
2382 usb_disable_endpoint(udev
, 0 + USB_DIR_IN
);
2383 usb_disable_endpoint(udev
, 0 + USB_DIR_OUT
);
2384 usb_enable_endpoint(udev
, &udev
->ep0
);
2386 EXPORT_SYMBOL_GPL(usb_ep0_reinit
);
2388 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2389 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2391 static int hub_set_address(struct usb_device
*udev
, int devnum
)
2397 if (udev
->state
== USB_STATE_ADDRESS
)
2399 if (udev
->state
!= USB_STATE_DEFAULT
)
2401 retval
= usb_control_msg(udev
, usb_sndaddr0pipe(),
2402 USB_REQ_SET_ADDRESS
, 0, devnum
, 0,
2403 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
2405 /* Device now using proper address. */
2406 update_address(udev
, devnum
);
2407 usb_set_device_state(udev
, USB_STATE_ADDRESS
);
2408 usb_ep0_reinit(udev
);
2413 /* Reset device, (re)assign address, get device descriptor.
2414 * Device connection must be stable, no more debouncing needed.
2415 * Returns device in USB_STATE_ADDRESS, except on error.
2417 * If this is called for an already-existing device (as part of
2418 * usb_reset_and_verify_device), the caller must own the device lock. For a
2419 * newly detected device that is not accessible through any global
2420 * pointers, it's not necessary to lock the device.
2423 hub_port_init (struct usb_hub
*hub
, struct usb_device
*udev
, int port1
,
2426 static DEFINE_MUTEX(usb_address0_mutex
);
2428 struct usb_device
*hdev
= hub
->hdev
;
2430 unsigned delay
= HUB_SHORT_RESET_TIME
;
2431 enum usb_device_speed oldspeed
= udev
->speed
;
2433 int devnum
= udev
->devnum
;
2435 /* root hub ports have a slightly longer reset period
2436 * (from USB 2.0 spec, section 7.1.7.5)
2438 if (!hdev
->parent
) {
2439 delay
= HUB_ROOT_RESET_TIME
;
2440 if (port1
== hdev
->bus
->otg_port
)
2441 hdev
->bus
->b_hnp_enable
= 0;
2444 /* Some low speed devices have problems with the quick delay, so */
2445 /* be a bit pessimistic with those devices. RHbug #23670 */
2446 if (oldspeed
== USB_SPEED_LOW
)
2447 delay
= HUB_LONG_RESET_TIME
;
2449 mutex_lock(&usb_address0_mutex
);
2451 /* Reset the device; full speed may morph to high speed */
2452 retval
= hub_port_reset(hub
, port1
, udev
, delay
);
2453 if (retval
< 0) /* error or disconnect */
2455 /* success, speed is known */
2458 if (oldspeed
!= USB_SPEED_UNKNOWN
&& oldspeed
!= udev
->speed
) {
2459 dev_dbg(&udev
->dev
, "device reset changed speed!\n");
2462 oldspeed
= udev
->speed
;
2464 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2465 * it's fixed size except for full speed devices.
2466 * For Wireless USB devices, ep0 max packet is always 512 (tho
2467 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
2469 switch (udev
->speed
) {
2470 case USB_SPEED_VARIABLE
: /* fixed at 512 */
2471 udev
->ep0
.desc
.wMaxPacketSize
= __constant_cpu_to_le16(512);
2473 case USB_SPEED_HIGH
: /* fixed at 64 */
2474 udev
->ep0
.desc
.wMaxPacketSize
= __constant_cpu_to_le16(64);
2476 case USB_SPEED_FULL
: /* 8, 16, 32, or 64 */
2477 /* to determine the ep0 maxpacket size, try to read
2478 * the device descriptor to get bMaxPacketSize0 and
2479 * then correct our initial guess.
2481 udev
->ep0
.desc
.wMaxPacketSize
= __constant_cpu_to_le16(64);
2483 case USB_SPEED_LOW
: /* fixed at 8 */
2484 udev
->ep0
.desc
.wMaxPacketSize
= __constant_cpu_to_le16(8);
2491 switch (udev
->speed
) {
2492 case USB_SPEED_LOW
: speed
= "low"; break;
2493 case USB_SPEED_FULL
: speed
= "full"; break;
2494 case USB_SPEED_HIGH
: speed
= "high"; break;
2495 case USB_SPEED_VARIABLE
:
2499 default: speed
= "?"; break;
2501 dev_info (&udev
->dev
,
2502 "%s %s speed %sUSB device using %s and address %d\n",
2503 (udev
->config
) ? "reset" : "new", speed
, type
,
2504 udev
->bus
->controller
->driver
->name
, devnum
);
2506 /* Set up TT records, if needed */
2508 udev
->tt
= hdev
->tt
;
2509 udev
->ttport
= hdev
->ttport
;
2510 } else if (udev
->speed
!= USB_SPEED_HIGH
2511 && hdev
->speed
== USB_SPEED_HIGH
) {
2512 udev
->tt
= &hub
->tt
;
2513 udev
->ttport
= port1
;
2516 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2517 * Because device hardware and firmware is sometimes buggy in
2518 * this area, and this is how Linux has done it for ages.
2519 * Change it cautiously.
2521 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2522 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2523 * so it may help with some non-standards-compliant devices.
2524 * Otherwise we start with SET_ADDRESS and then try to read the
2525 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2528 for (i
= 0; i
< GET_DESCRIPTOR_TRIES
; (++i
, msleep(100))) {
2529 if (USE_NEW_SCHEME(retry_counter
)) {
2530 struct usb_device_descriptor
*buf
;
2533 #define GET_DESCRIPTOR_BUFSIZE 64
2534 buf
= kmalloc(GET_DESCRIPTOR_BUFSIZE
, GFP_NOIO
);
2540 /* Retry on all errors; some devices are flakey.
2541 * 255 is for WUSB devices, we actually need to use
2542 * 512 (WUSB1.0[4.8.1]).
2544 for (j
= 0; j
< 3; ++j
) {
2545 buf
->bMaxPacketSize0
= 0;
2546 r
= usb_control_msg(udev
, usb_rcvaddr0pipe(),
2547 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
,
2548 USB_DT_DEVICE
<< 8, 0,
2549 buf
, GET_DESCRIPTOR_BUFSIZE
,
2550 initial_descriptor_timeout
);
2551 switch (buf
->bMaxPacketSize0
) {
2552 case 8: case 16: case 32: case 64: case 255:
2553 if (buf
->bDescriptorType
==
2567 udev
->descriptor
.bMaxPacketSize0
=
2568 buf
->bMaxPacketSize0
;
2571 retval
= hub_port_reset(hub
, port1
, udev
, delay
);
2572 if (retval
< 0) /* error or disconnect */
2574 if (oldspeed
!= udev
->speed
) {
2576 "device reset changed speed!\n");
2581 dev_err(&udev
->dev
, "device descriptor "
2582 "read/%s, error %d\n",
2587 #undef GET_DESCRIPTOR_BUFSIZE
2591 * If device is WUSB, we already assigned an
2592 * unauthorized address in the Connect Ack sequence;
2593 * authorization will assign the final address.
2595 if (udev
->wusb
== 0) {
2596 for (j
= 0; j
< SET_ADDRESS_TRIES
; ++j
) {
2597 retval
= hub_set_address(udev
, devnum
);
2604 "device not accepting address %d, error %d\n",
2609 /* cope with hardware quirkiness:
2610 * - let SET_ADDRESS settle, some device hardware wants it
2611 * - read ep0 maxpacket even for high and low speed,
2614 if (USE_NEW_SCHEME(retry_counter
))
2618 retval
= usb_get_device_descriptor(udev
, 8);
2620 dev_err(&udev
->dev
, "device descriptor "
2621 "read/%s, error %d\n",
2633 i
= udev
->descriptor
.bMaxPacketSize0
== 0xff? /* wusb device? */
2634 512 : udev
->descriptor
.bMaxPacketSize0
;
2635 if (le16_to_cpu(udev
->ep0
.desc
.wMaxPacketSize
) != i
) {
2636 if (udev
->speed
!= USB_SPEED_FULL
||
2637 !(i
== 8 || i
== 16 || i
== 32 || i
== 64)) {
2638 dev_err(&udev
->dev
, "ep0 maxpacket = %d\n", i
);
2642 dev_dbg(&udev
->dev
, "ep0 maxpacket = %d\n", i
);
2643 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(i
);
2644 usb_ep0_reinit(udev
);
2647 retval
= usb_get_device_descriptor(udev
, USB_DT_DEVICE_SIZE
);
2648 if (retval
< (signed)sizeof(udev
->descriptor
)) {
2649 dev_err(&udev
->dev
, "device descriptor read/%s, error %d\n",
2660 hub_port_disable(hub
, port1
, 0);
2661 update_address(udev
, devnum
); /* for disconnect processing */
2663 mutex_unlock(&usb_address0_mutex
);
2668 check_highspeed (struct usb_hub
*hub
, struct usb_device
*udev
, int port1
)
2670 struct usb_qualifier_descriptor
*qual
;
2673 qual
= kmalloc (sizeof *qual
, GFP_KERNEL
);
2677 status
= usb_get_descriptor (udev
, USB_DT_DEVICE_QUALIFIER
, 0,
2678 qual
, sizeof *qual
);
2679 if (status
== sizeof *qual
) {
2680 dev_info(&udev
->dev
, "not running at top speed; "
2681 "connect to a high speed hub\n");
2682 /* hub LEDs are probably harder to miss than syslog */
2683 if (hub
->has_indicators
) {
2684 hub
->indicator
[port1
-1] = INDICATOR_GREEN_BLINK
;
2685 schedule_delayed_work (&hub
->leds
, 0);
2692 hub_power_remaining (struct usb_hub
*hub
)
2694 struct usb_device
*hdev
= hub
->hdev
;
2698 if (!hub
->limited_power
)
2701 remaining
= hdev
->bus_mA
- hub
->descriptor
->bHubContrCurrent
;
2702 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
2703 struct usb_device
*udev
= hdev
->children
[port1
- 1];
2709 /* Unconfigured devices may not use more than 100mA,
2710 * or 8mA for OTG ports */
2711 if (udev
->actconfig
)
2712 delta
= udev
->actconfig
->desc
.bMaxPower
* 2;
2713 else if (port1
!= udev
->bus
->otg_port
|| hdev
->parent
)
2717 if (delta
> hub
->mA_per_port
)
2718 dev_warn(&udev
->dev
, "%dmA is over %umA budget "
2720 delta
, hub
->mA_per_port
, port1
);
2723 if (remaining
< 0) {
2724 dev_warn(hub
->intfdev
, "%dmA over power budget!\n",
2731 /* Handle physical or logical connection change events.
2732 * This routine is called when:
2733 * a port connection-change occurs;
2734 * a port enable-change occurs (often caused by EMI);
2735 * usb_reset_and_verify_device() encounters changed descriptors (as from
2736 * a firmware download)
2737 * caller already locked the hub
2739 static void hub_port_connect_change(struct usb_hub
*hub
, int port1
,
2740 u16 portstatus
, u16 portchange
)
2742 struct usb_device
*hdev
= hub
->hdev
;
2743 struct device
*hub_dev
= hub
->intfdev
;
2744 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
2745 unsigned wHubCharacteristics
=
2746 le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
2747 struct usb_device
*udev
;
2751 "port %d, status %04x, change %04x, %s\n",
2752 port1
, portstatus
, portchange
, portspeed (portstatus
));
2754 if (hub
->has_indicators
) {
2755 set_port_led(hub
, port1
, HUB_LED_AUTO
);
2756 hub
->indicator
[port1
-1] = INDICATOR_AUTO
;
2759 #ifdef CONFIG_USB_OTG
2760 /* during HNP, don't repeat the debounce */
2761 if (hdev
->bus
->is_b_host
)
2762 portchange
&= ~(USB_PORT_STAT_C_CONNECTION
|
2763 USB_PORT_STAT_C_ENABLE
);
2766 /* Try to resuscitate an existing device */
2767 udev
= hdev
->children
[port1
-1];
2768 if ((portstatus
& USB_PORT_STAT_CONNECTION
) && udev
&&
2769 udev
->state
!= USB_STATE_NOTATTACHED
) {
2770 usb_lock_device(udev
);
2771 if (portstatus
& USB_PORT_STAT_ENABLE
) {
2772 status
= 0; /* Nothing to do */
2774 #ifdef CONFIG_USB_SUSPEND
2775 } else if (udev
->state
== USB_STATE_SUSPENDED
&&
2776 udev
->persist_enabled
) {
2777 /* For a suspended device, treat this as a
2778 * remote wakeup event.
2780 if (udev
->do_remote_wakeup
)
2781 status
= remote_wakeup(udev
);
2783 /* Otherwise leave it be; devices can't tell the
2784 * difference between suspended and disabled.
2791 status
= -ENODEV
; /* Don't resuscitate */
2793 usb_unlock_device(udev
);
2796 clear_bit(port1
, hub
->change_bits
);
2801 /* Disconnect any existing devices under this port */
2803 usb_disconnect(&hdev
->children
[port1
-1]);
2804 clear_bit(port1
, hub
->change_bits
);
2806 if (portchange
& (USB_PORT_STAT_C_CONNECTION
|
2807 USB_PORT_STAT_C_ENABLE
)) {
2808 status
= hub_port_debounce(hub
, port1
);
2810 if (printk_ratelimit())
2811 dev_err(hub_dev
, "connect-debounce failed, "
2812 "port %d disabled\n", port1
);
2813 portstatus
&= ~USB_PORT_STAT_CONNECTION
;
2815 portstatus
= status
;
2819 /* Return now if debouncing failed or nothing is connected */
2820 if (!(portstatus
& USB_PORT_STAT_CONNECTION
)) {
2822 /* maybe switch power back on (e.g. root hub was reset) */
2823 if ((wHubCharacteristics
& HUB_CHAR_LPSM
) < 2
2824 && !(portstatus
& (1 << USB_PORT_FEAT_POWER
)))
2825 set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
2827 if (portstatus
& USB_PORT_STAT_ENABLE
)
2832 for (i
= 0; i
< SET_CONFIG_TRIES
; i
++) {
2834 /* reallocate for each attempt, since references
2835 * to the previous one can escape in various ways
2837 udev
= usb_alloc_dev(hdev
, hdev
->bus
, port1
);
2840 "couldn't allocate port %d usb_device\n",
2845 usb_set_device_state(udev
, USB_STATE_POWERED
);
2846 udev
->speed
= USB_SPEED_UNKNOWN
;
2847 udev
->bus_mA
= hub
->mA_per_port
;
2848 udev
->level
= hdev
->level
+ 1;
2849 udev
->wusb
= hub_is_wusb(hub
);
2851 /* set the address */
2852 choose_address(udev
);
2853 if (udev
->devnum
<= 0) {
2854 status
= -ENOTCONN
; /* Don't retry */
2858 /* reset and get descriptor */
2859 status
= hub_port_init(hub
, udev
, port1
, i
);
2863 /* consecutive bus-powered hubs aren't reliable; they can
2864 * violate the voltage drop budget. if the new child has
2865 * a "powered" LED, users should notice we didn't enable it
2866 * (without reading syslog), even without per-port LEDs
2869 if (udev
->descriptor
.bDeviceClass
== USB_CLASS_HUB
2870 && udev
->bus_mA
<= 100) {
2873 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0,
2876 dev_dbg(&udev
->dev
, "get status %d ?\n", status
);
2879 le16_to_cpus(&devstat
);
2880 if ((devstat
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
2882 "can't connect bus-powered hub "
2884 if (hub
->has_indicators
) {
2885 hub
->indicator
[port1
-1] =
2886 INDICATOR_AMBER_BLINK
;
2887 schedule_delayed_work (&hub
->leds
, 0);
2889 status
= -ENOTCONN
; /* Don't retry */
2894 /* check for devices running slower than they could */
2895 if (le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0200
2896 && udev
->speed
== USB_SPEED_FULL
2897 && highspeed_hubs
!= 0)
2898 check_highspeed (hub
, udev
, port1
);
2900 /* Store the parent's children[] pointer. At this point
2901 * udev becomes globally accessible, although presumably
2902 * no one will look at it until hdev is unlocked.
2906 /* We mustn't add new devices if the parent hub has
2907 * been disconnected; we would race with the
2908 * recursively_mark_NOTATTACHED() routine.
2910 spin_lock_irq(&device_state_lock
);
2911 if (hdev
->state
== USB_STATE_NOTATTACHED
)
2914 hdev
->children
[port1
-1] = udev
;
2915 spin_unlock_irq(&device_state_lock
);
2917 /* Run it through the hoops (find a driver, etc) */
2919 status
= usb_new_device(udev
);
2921 spin_lock_irq(&device_state_lock
);
2922 hdev
->children
[port1
-1] = NULL
;
2923 spin_unlock_irq(&device_state_lock
);
2930 status
= hub_power_remaining(hub
);
2932 dev_dbg(hub_dev
, "%dmA power budget left\n", status
);
2937 hub_port_disable(hub
, port1
, 1);
2939 usb_ep0_reinit(udev
);
2940 release_address(udev
);
2942 if ((status
== -ENOTCONN
) || (status
== -ENOTSUPP
))
2945 if (hub
->hdev
->parent
||
2946 !hcd
->driver
->port_handed_over
||
2947 !(hcd
->driver
->port_handed_over
)(hcd
, port1
))
2948 dev_err(hub_dev
, "unable to enumerate USB device on port %d\n",
2952 hub_port_disable(hub
, port1
, 1);
2953 if (hcd
->driver
->relinquish_port
&& !hub
->hdev
->parent
)
2954 hcd
->driver
->relinquish_port(hcd
, port1
);
2957 static void hub_events(void)
2959 struct list_head
*tmp
;
2960 struct usb_device
*hdev
;
2961 struct usb_interface
*intf
;
2962 struct usb_hub
*hub
;
2963 struct device
*hub_dev
;
2972 * We restart the list every time to avoid a deadlock with
2973 * deleting hubs downstream from this one. This should be
2974 * safe since we delete the hub from the event list.
2975 * Not the most efficient, but avoids deadlocks.
2979 /* Grab the first entry at the beginning of the list */
2980 spin_lock_irq(&hub_event_lock
);
2981 if (list_empty(&hub_event_list
)) {
2982 spin_unlock_irq(&hub_event_lock
);
2986 tmp
= hub_event_list
.next
;
2989 hub
= list_entry(tmp
, struct usb_hub
, event_list
);
2990 kref_get(&hub
->kref
);
2991 spin_unlock_irq(&hub_event_lock
);
2994 hub_dev
= hub
->intfdev
;
2995 intf
= to_usb_interface(hub_dev
);
2996 dev_dbg(hub_dev
, "state %d ports %d chg %04x evt %04x\n",
2997 hdev
->state
, hub
->descriptor
2998 ? hub
->descriptor
->bNbrPorts
3000 /* NOTE: expects max 15 ports... */
3001 (u16
) hub
->change_bits
[0],
3002 (u16
) hub
->event_bits
[0]);
3004 /* Lock the device, then check to see if we were
3005 * disconnected while waiting for the lock to succeed. */
3006 usb_lock_device(hdev
);
3007 if (unlikely(hub
->disconnected
))
3010 /* If the hub has died, clean up after it */
3011 if (hdev
->state
== USB_STATE_NOTATTACHED
) {
3012 hub
->error
= -ENODEV
;
3013 hub_quiesce(hub
, HUB_DISCONNECT
);
3018 ret
= usb_autopm_get_interface(intf
);
3020 dev_dbg(hub_dev
, "Can't autoresume: %d\n", ret
);
3024 /* If this is an inactive hub, do nothing */
3029 dev_dbg (hub_dev
, "resetting for error %d\n",
3032 ret
= usb_reset_device(hdev
);
3035 "error resetting hub: %d\n", ret
);
3043 /* deal with port status changes */
3044 for (i
= 1; i
<= hub
->descriptor
->bNbrPorts
; i
++) {
3045 if (test_bit(i
, hub
->busy_bits
))
3047 connect_change
= test_bit(i
, hub
->change_bits
);
3048 if (!test_and_clear_bit(i
, hub
->event_bits
) &&
3052 ret
= hub_port_status(hub
, i
,
3053 &portstatus
, &portchange
);
3057 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
3058 clear_port_feature(hdev
, i
,
3059 USB_PORT_FEAT_C_CONNECTION
);
3063 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
3064 if (!connect_change
)
3066 "port %d enable change, "
3069 clear_port_feature(hdev
, i
,
3070 USB_PORT_FEAT_C_ENABLE
);
3073 * EM interference sometimes causes badly
3074 * shielded USB devices to be shutdown by
3075 * the hub, this hack enables them again.
3076 * Works at least with mouse driver.
3078 if (!(portstatus
& USB_PORT_STAT_ENABLE
)
3080 && hdev
->children
[i
-1]) {
3083 "disabled by hub (EMI?), "
3090 if (portchange
& USB_PORT_STAT_C_SUSPEND
) {
3091 struct usb_device
*udev
;
3093 clear_port_feature(hdev
, i
,
3094 USB_PORT_FEAT_C_SUSPEND
);
3095 udev
= hdev
->children
[i
-1];
3097 usb_lock_device(udev
);
3098 ret
= remote_wakeup(hdev
->
3100 usb_unlock_device(udev
);
3105 hub_port_disable(hub
, i
, 1);
3108 "resume on port %d, status %d\n",
3112 if (portchange
& USB_PORT_STAT_C_OVERCURRENT
) {
3114 "over-current change on port %d\n",
3116 clear_port_feature(hdev
, i
,
3117 USB_PORT_FEAT_C_OVER_CURRENT
);
3118 hub_power_on(hub
, true);
3121 if (portchange
& USB_PORT_STAT_C_RESET
) {
3123 "reset change on port %d\n",
3125 clear_port_feature(hdev
, i
,
3126 USB_PORT_FEAT_C_RESET
);
3130 hub_port_connect_change(hub
, i
,
3131 portstatus
, portchange
);
3134 /* deal with hub status changes */
3135 if (test_and_clear_bit(0, hub
->event_bits
) == 0)
3137 else if (hub_hub_status(hub
, &hubstatus
, &hubchange
) < 0)
3138 dev_err (hub_dev
, "get_hub_status failed\n");
3140 if (hubchange
& HUB_CHANGE_LOCAL_POWER
) {
3141 dev_dbg (hub_dev
, "power change\n");
3142 clear_hub_feature(hdev
, C_HUB_LOCAL_POWER
);
3143 if (hubstatus
& HUB_STATUS_LOCAL_POWER
)
3144 /* FIXME: Is this always true? */
3145 hub
->limited_power
= 1;
3147 hub
->limited_power
= 0;
3149 if (hubchange
& HUB_CHANGE_OVERCURRENT
) {
3150 dev_dbg (hub_dev
, "overcurrent change\n");
3151 msleep(500); /* Cool down */
3152 clear_hub_feature(hdev
, C_HUB_OVER_CURRENT
);
3153 hub_power_on(hub
, true);
3158 /* Allow autosuspend if we're not going to run again */
3159 if (list_empty(&hub
->event_list
))
3160 usb_autopm_enable(intf
);
3162 usb_unlock_device(hdev
);
3163 kref_put(&hub
->kref
, hub_release
);
3165 } /* end while (1) */
3168 static int hub_thread(void *__unused
)
3170 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
3171 * port handover. Otherwise it might see that a full-speed device
3172 * was gone before the EHCI controller had handed its port over to
3173 * the companion full-speed controller.
3179 wait_event_freezable(khubd_wait
,
3180 !list_empty(&hub_event_list
) ||
3181 kthread_should_stop());
3182 } while (!kthread_should_stop() || !list_empty(&hub_event_list
));
3184 pr_debug("%s: khubd exiting\n", usbcore_name
);
3188 static struct usb_device_id hub_id_table
[] = {
3189 { .match_flags
= USB_DEVICE_ID_MATCH_DEV_CLASS
,
3190 .bDeviceClass
= USB_CLASS_HUB
},
3191 { .match_flags
= USB_DEVICE_ID_MATCH_INT_CLASS
,
3192 .bInterfaceClass
= USB_CLASS_HUB
},
3193 { } /* Terminating entry */
3196 MODULE_DEVICE_TABLE (usb
, hub_id_table
);
3198 static struct usb_driver hub_driver
= {
3201 .disconnect
= hub_disconnect
,
3202 .suspend
= hub_suspend
,
3203 .resume
= hub_resume
,
3204 .reset_resume
= hub_reset_resume
,
3205 .pre_reset
= hub_pre_reset
,
3206 .post_reset
= hub_post_reset
,
3208 .id_table
= hub_id_table
,
3209 .supports_autosuspend
= 1,
3212 int usb_hub_init(void)
3214 if (usb_register(&hub_driver
) < 0) {
3215 printk(KERN_ERR
"%s: can't register hub driver\n",
3220 khubd_task
= kthread_run(hub_thread
, NULL
, "khubd");
3221 if (!IS_ERR(khubd_task
))
3224 /* Fall through if kernel_thread failed */
3225 usb_deregister(&hub_driver
);
3226 printk(KERN_ERR
"%s: can't start khubd\n", usbcore_name
);
3231 void usb_hub_cleanup(void)
3233 kthread_stop(khubd_task
);
3236 * Hub resources are freed for us by usb_deregister. It calls
3237 * usb_driver_purge on every device which in turn calls that
3238 * devices disconnect function if it is using this driver.
3239 * The hub_disconnect function takes care of releasing the
3240 * individual hub resources. -greg
3242 usb_deregister(&hub_driver
);
3243 } /* usb_hub_cleanup() */
3245 static int descriptors_changed(struct usb_device
*udev
,
3246 struct usb_device_descriptor
*old_device_descriptor
)
3250 unsigned serial_len
= 0;
3252 unsigned old_length
;
3256 if (memcmp(&udev
->descriptor
, old_device_descriptor
,
3257 sizeof(*old_device_descriptor
)) != 0)
3260 /* Since the idVendor, idProduct, and bcdDevice values in the
3261 * device descriptor haven't changed, we will assume the
3262 * Manufacturer and Product strings haven't changed either.
3263 * But the SerialNumber string could be different (e.g., a
3264 * different flash card of the same brand).
3267 serial_len
= strlen(udev
->serial
) + 1;
3270 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
3271 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
3272 len
= max(len
, old_length
);
3275 buf
= kmalloc(len
, GFP_NOIO
);
3277 dev_err(&udev
->dev
, "no mem to re-read configs after reset\n");
3278 /* assume the worst */
3281 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
3282 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
3283 length
= usb_get_descriptor(udev
, USB_DT_CONFIG
, index
, buf
,
3285 if (length
!= old_length
) {
3286 dev_dbg(&udev
->dev
, "config index %d, error %d\n",
3291 if (memcmp (buf
, udev
->rawdescriptors
[index
], old_length
)
3293 dev_dbg(&udev
->dev
, "config index %d changed (#%d)\n",
3295 ((struct usb_config_descriptor
*) buf
)->
3296 bConfigurationValue
);
3302 if (!changed
&& serial_len
) {
3303 length
= usb_string(udev
, udev
->descriptor
.iSerialNumber
,
3305 if (length
+ 1 != serial_len
) {
3306 dev_dbg(&udev
->dev
, "serial string error %d\n",
3309 } else if (memcmp(buf
, udev
->serial
, length
) != 0) {
3310 dev_dbg(&udev
->dev
, "serial string changed\n");
3320 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
3321 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3323 * WARNING - don't use this routine to reset a composite device
3324 * (one with multiple interfaces owned by separate drivers)!
3325 * Use usb_reset_device() instead.
3327 * Do a port reset, reassign the device's address, and establish its
3328 * former operating configuration. If the reset fails, or the device's
3329 * descriptors change from their values before the reset, or the original
3330 * configuration and altsettings cannot be restored, a flag will be set
3331 * telling khubd to pretend the device has been disconnected and then
3332 * re-connected. All drivers will be unbound, and the device will be
3333 * re-enumerated and probed all over again.
3335 * Returns 0 if the reset succeeded, -ENODEV if the device has been
3336 * flagged for logical disconnection, or some other negative error code
3337 * if the reset wasn't even attempted.
3339 * The caller must own the device lock. For example, it's safe to use
3340 * this from a driver probe() routine after downloading new firmware.
3341 * For calls that might not occur during probe(), drivers should lock
3342 * the device using usb_lock_device_for_reset().
3344 * Locking exception: This routine may also be called from within an
3345 * autoresume handler. Such usage won't conflict with other tasks
3346 * holding the device lock because these tasks should always call
3347 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
3349 static int usb_reset_and_verify_device(struct usb_device
*udev
)
3351 struct usb_device
*parent_hdev
= udev
->parent
;
3352 struct usb_hub
*parent_hub
;
3353 struct usb_device_descriptor descriptor
= udev
->descriptor
;
3355 int port1
= udev
->portnum
;
3357 if (udev
->state
== USB_STATE_NOTATTACHED
||
3358 udev
->state
== USB_STATE_SUSPENDED
) {
3359 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
3365 /* this requires hcd-specific logic; see OHCI hc_restart() */
3366 dev_dbg(&udev
->dev
, "%s for root hub!\n", __func__
);
3369 parent_hub
= hdev_to_hub(parent_hdev
);
3371 set_bit(port1
, parent_hub
->busy_bits
);
3372 for (i
= 0; i
< SET_CONFIG_TRIES
; ++i
) {
3374 /* ep0 maxpacket size may change; let the HCD know about it.
3375 * Other endpoints will be handled by re-enumeration. */
3376 usb_ep0_reinit(udev
);
3377 ret
= hub_port_init(parent_hub
, udev
, port1
, i
);
3378 if (ret
>= 0 || ret
== -ENOTCONN
|| ret
== -ENODEV
)
3381 clear_bit(port1
, parent_hub
->busy_bits
);
3386 /* Device might have changed firmware (DFU or similar) */
3387 if (descriptors_changed(udev
, &descriptor
)) {
3388 dev_info(&udev
->dev
, "device firmware changed\n");
3389 udev
->descriptor
= descriptor
; /* for disconnect() calls */
3393 if (!udev
->actconfig
)
3396 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3397 USB_REQ_SET_CONFIGURATION
, 0,
3398 udev
->actconfig
->desc
.bConfigurationValue
, 0,
3399 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
3402 "can't restore configuration #%d (error=%d)\n",
3403 udev
->actconfig
->desc
.bConfigurationValue
, ret
);
3406 usb_set_device_state(udev
, USB_STATE_CONFIGURED
);
3408 for (i
= 0; i
< udev
->actconfig
->desc
.bNumInterfaces
; i
++) {
3409 struct usb_interface
*intf
= udev
->actconfig
->interface
[i
];
3410 struct usb_interface_descriptor
*desc
;
3412 /* set_interface resets host side toggle even
3413 * for altsetting zero. the interface may have no driver.
3415 desc
= &intf
->cur_altsetting
->desc
;
3416 ret
= usb_set_interface(udev
, desc
->bInterfaceNumber
,
3417 desc
->bAlternateSetting
);
3419 dev_err(&udev
->dev
, "failed to restore interface %d "
3420 "altsetting %d (error=%d)\n",
3421 desc
->bInterfaceNumber
,
3422 desc
->bAlternateSetting
,
3432 hub_port_logical_disconnect(parent_hub
, port1
);
3437 * usb_reset_device - warn interface drivers and perform a USB port reset
3438 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3440 * Warns all drivers bound to registered interfaces (using their pre_reset
3441 * method), performs the port reset, and then lets the drivers know that
3442 * the reset is over (using their post_reset method).
3444 * Return value is the same as for usb_reset_and_verify_device().
3446 * The caller must own the device lock. For example, it's safe to use
3447 * this from a driver probe() routine after downloading new firmware.
3448 * For calls that might not occur during probe(), drivers should lock
3449 * the device using usb_lock_device_for_reset().
3451 * If an interface is currently being probed or disconnected, we assume
3452 * its driver knows how to handle resets. For all other interfaces,
3453 * if the driver doesn't have pre_reset and post_reset methods then
3454 * we attempt to unbind it and rebind afterward.
3456 int usb_reset_device(struct usb_device
*udev
)
3460 struct usb_host_config
*config
= udev
->actconfig
;
3462 if (udev
->state
== USB_STATE_NOTATTACHED
||
3463 udev
->state
== USB_STATE_SUSPENDED
) {
3464 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
3469 /* Prevent autosuspend during the reset */
3470 usb_autoresume_device(udev
);
3473 for (i
= 0; i
< config
->desc
.bNumInterfaces
; ++i
) {
3474 struct usb_interface
*cintf
= config
->interface
[i
];
3475 struct usb_driver
*drv
;
3478 if (cintf
->dev
.driver
) {
3479 drv
= to_usb_driver(cintf
->dev
.driver
);
3480 if (drv
->pre_reset
&& drv
->post_reset
)
3481 unbind
= (drv
->pre_reset
)(cintf
);
3482 else if (cintf
->condition
==
3483 USB_INTERFACE_BOUND
)
3486 usb_forced_unbind_intf(cintf
);
3491 ret
= usb_reset_and_verify_device(udev
);
3494 for (i
= config
->desc
.bNumInterfaces
- 1; i
>= 0; --i
) {
3495 struct usb_interface
*cintf
= config
->interface
[i
];
3496 struct usb_driver
*drv
;
3497 int rebind
= cintf
->needs_binding
;
3499 if (!rebind
&& cintf
->dev
.driver
) {
3500 drv
= to_usb_driver(cintf
->dev
.driver
);
3501 if (drv
->post_reset
)
3502 rebind
= (drv
->post_reset
)(cintf
);
3503 else if (cintf
->condition
==
3504 USB_INTERFACE_BOUND
)
3507 if (ret
== 0 && rebind
)
3508 usb_rebind_intf(cintf
);
3512 usb_autosuspend_device(udev
);
3515 EXPORT_SYMBOL_GPL(usb_reset_device
);