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/usb/hcd.h>
23 #include <linux/usb/quirks.h>
24 #include <linux/kthread.h>
25 #include <linux/mutex.h>
26 #include <linux/freezer.h>
28 #include <asm/uaccess.h>
29 #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 */
49 struct usb_hub_status hub
;
50 struct usb_port_status port
;
51 } *status
; /* buffer for status reports */
52 struct mutex status_mutex
; /* for the status buffer */
54 int error
; /* last reported error */
55 int nerrors
; /* track consecutive errors */
57 struct list_head event_list
; /* hubs w/data or errs ready */
58 unsigned long event_bits
[1]; /* status change bitmask */
59 unsigned long change_bits
[1]; /* ports with logical connect
61 unsigned long busy_bits
[1]; /* ports being reset or
63 unsigned long removed_bits
[1]; /* ports with a "removed"
65 #if USB_MAXCHILDREN > 31 /* 8*sizeof(unsigned long) - 1 */
66 #error event_bits[] is too short!
69 struct usb_hub_descriptor
*descriptor
; /* class descriptor */
70 struct usb_tt tt
; /* Transaction Translator */
72 unsigned mA_per_port
; /* current for each child */
74 unsigned limited_power
:1;
76 unsigned disconnected
:1;
78 unsigned has_indicators
:1;
79 u8 indicator
[USB_MAXCHILDREN
];
80 struct delayed_work leds
;
81 struct delayed_work init_work
;
85 static inline int hub_is_superspeed(struct usb_device
*hdev
)
87 return (hdev
->descriptor
.bDeviceProtocol
== 3);
90 /* Protect struct usb_device->state and ->children members
91 * Note: Both are also protected by ->dev.sem, except that ->state can
92 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
93 static DEFINE_SPINLOCK(device_state_lock
);
95 /* khubd's worklist and its lock */
96 static DEFINE_SPINLOCK(hub_event_lock
);
97 static LIST_HEAD(hub_event_list
); /* List of hubs needing servicing */
100 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait
);
102 static struct task_struct
*khubd_task
;
104 /* cycle leds on hubs that aren't blinking for attention */
105 static int blinkenlights
= 0;
106 module_param (blinkenlights
, bool, S_IRUGO
);
107 MODULE_PARM_DESC (blinkenlights
, "true to cycle leds on hubs");
110 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
111 * 10 seconds to send reply for the initial 64-byte descriptor request.
113 /* define initial 64-byte descriptor request timeout in milliseconds */
114 static int initial_descriptor_timeout
= USB_CTRL_GET_TIMEOUT
;
115 module_param(initial_descriptor_timeout
, int, S_IRUGO
|S_IWUSR
);
116 MODULE_PARM_DESC(initial_descriptor_timeout
,
117 "initial 64-byte descriptor request timeout in milliseconds "
118 "(default 5000 - 5.0 seconds)");
121 * As of 2.6.10 we introduce a new USB device initialization scheme which
122 * closely resembles the way Windows works. Hopefully it will be compatible
123 * with a wider range of devices than the old scheme. However some previously
124 * working devices may start giving rise to "device not accepting address"
125 * errors; if that happens the user can try the old scheme by adjusting the
126 * following module parameters.
128 * For maximum flexibility there are two boolean parameters to control the
129 * hub driver's behavior. On the first initialization attempt, if the
130 * "old_scheme_first" parameter is set then the old scheme will be used,
131 * otherwise the new scheme is used. If that fails and "use_both_schemes"
132 * is set, then the driver will make another attempt, using the other scheme.
134 static int old_scheme_first
= 0;
135 module_param(old_scheme_first
, bool, S_IRUGO
| S_IWUSR
);
136 MODULE_PARM_DESC(old_scheme_first
,
137 "start with the old device initialization scheme");
139 static int use_both_schemes
= 1;
140 module_param(use_both_schemes
, bool, S_IRUGO
| S_IWUSR
);
141 MODULE_PARM_DESC(use_both_schemes
,
142 "try the other device initialization scheme if the "
145 /* Mutual exclusion for EHCI CF initialization. This interferes with
146 * port reset on some companion controllers.
148 DECLARE_RWSEM(ehci_cf_port_reset_rwsem
);
149 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem
);
151 #define HUB_DEBOUNCE_TIMEOUT 1500
152 #define HUB_DEBOUNCE_STEP 25
153 #define HUB_DEBOUNCE_STABLE 100
156 static int usb_reset_and_verify_device(struct usb_device
*udev
);
158 static inline char *portspeed(struct usb_hub
*hub
, int portstatus
)
160 if (hub_is_superspeed(hub
->hdev
))
162 if (portstatus
& USB_PORT_STAT_HIGH_SPEED
)
164 else if (portstatus
& USB_PORT_STAT_LOW_SPEED
)
170 /* Note that hdev or one of its children must be locked! */
171 static struct usb_hub
*hdev_to_hub(struct usb_device
*hdev
)
173 if (!hdev
|| !hdev
->actconfig
)
175 return usb_get_intfdata(hdev
->actconfig
->interface
[0]);
178 /* USB 2.0 spec Section 11.24.4.5 */
179 static int get_hub_descriptor(struct usb_device
*hdev
, void *data
)
184 if (hub_is_superspeed(hdev
)) {
185 dtype
= USB_DT_SS_HUB
;
186 size
= USB_DT_SS_HUB_SIZE
;
189 size
= sizeof(struct usb_hub_descriptor
);
192 for (i
= 0; i
< 3; i
++) {
193 ret
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
194 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
| USB_RT_HUB
,
195 dtype
<< 8, 0, data
, size
,
196 USB_CTRL_GET_TIMEOUT
);
197 if (ret
>= (USB_DT_HUB_NONVAR_SIZE
+ 2))
204 * USB 2.0 spec Section 11.24.2.1
206 static int clear_hub_feature(struct usb_device
*hdev
, int feature
)
208 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
209 USB_REQ_CLEAR_FEATURE
, USB_RT_HUB
, feature
, 0, NULL
, 0, 1000);
213 * USB 2.0 spec Section 11.24.2.2
215 static int clear_port_feature(struct usb_device
*hdev
, int port1
, int feature
)
217 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
218 USB_REQ_CLEAR_FEATURE
, USB_RT_PORT
, feature
, port1
,
223 * USB 2.0 spec Section 11.24.2.13
225 static int set_port_feature(struct usb_device
*hdev
, int port1
, int feature
)
227 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
228 USB_REQ_SET_FEATURE
, USB_RT_PORT
, feature
, port1
,
233 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
234 * for info about using port indicators
236 static void set_port_led(
242 int status
= set_port_feature(hub
->hdev
, (selector
<< 8) | port1
,
243 USB_PORT_FEAT_INDICATOR
);
245 dev_dbg (hub
->intfdev
,
246 "port %d indicator %s status %d\n",
248 ({ char *s
; switch (selector
) {
249 case HUB_LED_AMBER
: s
= "amber"; break;
250 case HUB_LED_GREEN
: s
= "green"; break;
251 case HUB_LED_OFF
: s
= "off"; break;
252 case HUB_LED_AUTO
: s
= "auto"; break;
253 default: s
= "??"; break;
258 #define LED_CYCLE_PERIOD ((2*HZ)/3)
260 static void led_work (struct work_struct
*work
)
262 struct usb_hub
*hub
=
263 container_of(work
, struct usb_hub
, leds
.work
);
264 struct usb_device
*hdev
= hub
->hdev
;
266 unsigned changed
= 0;
269 if (hdev
->state
!= USB_STATE_CONFIGURED
|| hub
->quiescing
)
272 for (i
= 0; i
< hub
->descriptor
->bNbrPorts
; i
++) {
273 unsigned selector
, mode
;
275 /* 30%-50% duty cycle */
277 switch (hub
->indicator
[i
]) {
279 case INDICATOR_CYCLE
:
281 selector
= HUB_LED_AUTO
;
282 mode
= INDICATOR_AUTO
;
284 /* blinking green = sw attention */
285 case INDICATOR_GREEN_BLINK
:
286 selector
= HUB_LED_GREEN
;
287 mode
= INDICATOR_GREEN_BLINK_OFF
;
289 case INDICATOR_GREEN_BLINK_OFF
:
290 selector
= HUB_LED_OFF
;
291 mode
= INDICATOR_GREEN_BLINK
;
293 /* blinking amber = hw attention */
294 case INDICATOR_AMBER_BLINK
:
295 selector
= HUB_LED_AMBER
;
296 mode
= INDICATOR_AMBER_BLINK_OFF
;
298 case INDICATOR_AMBER_BLINK_OFF
:
299 selector
= HUB_LED_OFF
;
300 mode
= INDICATOR_AMBER_BLINK
;
302 /* blink green/amber = reserved */
303 case INDICATOR_ALT_BLINK
:
304 selector
= HUB_LED_GREEN
;
305 mode
= INDICATOR_ALT_BLINK_OFF
;
307 case INDICATOR_ALT_BLINK_OFF
:
308 selector
= HUB_LED_AMBER
;
309 mode
= INDICATOR_ALT_BLINK
;
314 if (selector
!= HUB_LED_AUTO
)
316 set_port_led(hub
, i
+ 1, selector
);
317 hub
->indicator
[i
] = mode
;
319 if (!changed
&& blinkenlights
) {
321 cursor
%= hub
->descriptor
->bNbrPorts
;
322 set_port_led(hub
, cursor
+ 1, HUB_LED_GREEN
);
323 hub
->indicator
[cursor
] = INDICATOR_CYCLE
;
327 schedule_delayed_work(&hub
->leds
, LED_CYCLE_PERIOD
);
330 /* use a short timeout for hub/port status fetches */
331 #define USB_STS_TIMEOUT 1000
332 #define USB_STS_RETRIES 5
335 * USB 2.0 spec Section 11.24.2.6
337 static int get_hub_status(struct usb_device
*hdev
,
338 struct usb_hub_status
*data
)
340 int i
, status
= -ETIMEDOUT
;
342 for (i
= 0; i
< USB_STS_RETRIES
&&
343 (status
== -ETIMEDOUT
|| status
== -EPIPE
); i
++) {
344 status
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
345 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_HUB
, 0, 0,
346 data
, sizeof(*data
), USB_STS_TIMEOUT
);
352 * USB 2.0 spec Section 11.24.2.7
354 static int get_port_status(struct usb_device
*hdev
, int port1
,
355 struct usb_port_status
*data
)
357 int i
, status
= -ETIMEDOUT
;
359 for (i
= 0; i
< USB_STS_RETRIES
&&
360 (status
== -ETIMEDOUT
|| status
== -EPIPE
); i
++) {
361 status
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
362 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_PORT
, 0, port1
,
363 data
, sizeof(*data
), USB_STS_TIMEOUT
);
368 static int hub_port_status(struct usb_hub
*hub
, int port1
,
369 u16
*status
, u16
*change
)
373 mutex_lock(&hub
->status_mutex
);
374 ret
= get_port_status(hub
->hdev
, port1
, &hub
->status
->port
);
376 dev_err(hub
->intfdev
,
377 "%s failed (err = %d)\n", __func__
, ret
);
381 *status
= le16_to_cpu(hub
->status
->port
.wPortStatus
);
382 *change
= le16_to_cpu(hub
->status
->port
.wPortChange
);
384 if ((hub
->hdev
->parent
!= NULL
) &&
385 hub_is_superspeed(hub
->hdev
)) {
386 /* Translate the USB 3 port status */
387 u16 tmp
= *status
& USB_SS_PORT_STAT_MASK
;
388 if (*status
& USB_SS_PORT_STAT_POWER
)
389 tmp
|= USB_PORT_STAT_POWER
;
395 mutex_unlock(&hub
->status_mutex
);
399 static void kick_khubd(struct usb_hub
*hub
)
403 spin_lock_irqsave(&hub_event_lock
, flags
);
404 if (!hub
->disconnected
&& list_empty(&hub
->event_list
)) {
405 list_add_tail(&hub
->event_list
, &hub_event_list
);
407 /* Suppress autosuspend until khubd runs */
408 usb_autopm_get_interface_no_resume(
409 to_usb_interface(hub
->intfdev
));
410 wake_up(&khubd_wait
);
412 spin_unlock_irqrestore(&hub_event_lock
, flags
);
415 void usb_kick_khubd(struct usb_device
*hdev
)
417 struct usb_hub
*hub
= hdev_to_hub(hdev
);
424 /* completion function, fires on port status changes and various faults */
425 static void hub_irq(struct urb
*urb
)
427 struct usb_hub
*hub
= urb
->context
;
428 int status
= urb
->status
;
433 case -ENOENT
: /* synchronous unlink */
434 case -ECONNRESET
: /* async unlink */
435 case -ESHUTDOWN
: /* hardware going away */
438 default: /* presumably an error */
439 /* Cause a hub reset after 10 consecutive errors */
440 dev_dbg (hub
->intfdev
, "transfer --> %d\n", status
);
441 if ((++hub
->nerrors
< 10) || hub
->error
)
446 /* let khubd handle things */
447 case 0: /* we got data: port status changed */
449 for (i
= 0; i
< urb
->actual_length
; ++i
)
450 bits
|= ((unsigned long) ((*hub
->buffer
)[i
]))
452 hub
->event_bits
[0] = bits
;
458 /* Something happened, let khubd figure it out */
465 if ((status
= usb_submit_urb (hub
->urb
, GFP_ATOMIC
)) != 0
466 && status
!= -ENODEV
&& status
!= -EPERM
)
467 dev_err (hub
->intfdev
, "resubmit --> %d\n", status
);
470 /* USB 2.0 spec Section 11.24.2.3 */
472 hub_clear_tt_buffer (struct usb_device
*hdev
, u16 devinfo
, u16 tt
)
474 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
475 HUB_CLEAR_TT_BUFFER
, USB_RT_PORT
, devinfo
,
480 * enumeration blocks khubd for a long time. we use keventd instead, since
481 * long blocking there is the exception, not the rule. accordingly, HCDs
482 * talking to TTs must queue control transfers (not just bulk and iso), so
483 * both can talk to the same hub concurrently.
485 static void hub_tt_work(struct work_struct
*work
)
487 struct usb_hub
*hub
=
488 container_of(work
, struct usb_hub
, tt
.clear_work
);
492 spin_lock_irqsave (&hub
->tt
.lock
, flags
);
493 while (--limit
&& !list_empty (&hub
->tt
.clear_list
)) {
494 struct list_head
*next
;
495 struct usb_tt_clear
*clear
;
496 struct usb_device
*hdev
= hub
->hdev
;
497 const struct hc_driver
*drv
;
500 next
= hub
->tt
.clear_list
.next
;
501 clear
= list_entry (next
, struct usb_tt_clear
, clear_list
);
502 list_del (&clear
->clear_list
);
504 /* drop lock so HCD can concurrently report other TT errors */
505 spin_unlock_irqrestore (&hub
->tt
.lock
, flags
);
506 status
= hub_clear_tt_buffer (hdev
, clear
->devinfo
, clear
->tt
);
509 "clear tt %d (%04x) error %d\n",
510 clear
->tt
, clear
->devinfo
, status
);
512 /* Tell the HCD, even if the operation failed */
513 drv
= clear
->hcd
->driver
;
514 if (drv
->clear_tt_buffer_complete
)
515 (drv
->clear_tt_buffer_complete
)(clear
->hcd
, clear
->ep
);
518 spin_lock_irqsave(&hub
->tt
.lock
, flags
);
520 spin_unlock_irqrestore (&hub
->tt
.lock
, flags
);
524 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
525 * @urb: an URB associated with the failed or incomplete split transaction
527 * High speed HCDs use this to tell the hub driver that some split control or
528 * bulk transaction failed in a way that requires clearing internal state of
529 * a transaction translator. This is normally detected (and reported) from
532 * It may not be possible for that hub to handle additional full (or low)
533 * speed transactions until that state is fully cleared out.
535 int usb_hub_clear_tt_buffer(struct urb
*urb
)
537 struct usb_device
*udev
= urb
->dev
;
538 int pipe
= urb
->pipe
;
539 struct usb_tt
*tt
= udev
->tt
;
541 struct usb_tt_clear
*clear
;
543 /* we've got to cope with an arbitrary number of pending TT clears,
544 * since each TT has "at least two" buffers that can need it (and
545 * there can be many TTs per hub). even if they're uncommon.
547 if ((clear
= kmalloc (sizeof *clear
, GFP_ATOMIC
)) == NULL
) {
548 dev_err (&udev
->dev
, "can't save CLEAR_TT_BUFFER state\n");
549 /* FIXME recover somehow ... RESET_TT? */
553 /* info that CLEAR_TT_BUFFER needs */
554 clear
->tt
= tt
->multi
? udev
->ttport
: 1;
555 clear
->devinfo
= usb_pipeendpoint (pipe
);
556 clear
->devinfo
|= udev
->devnum
<< 4;
557 clear
->devinfo
|= usb_pipecontrol (pipe
)
558 ? (USB_ENDPOINT_XFER_CONTROL
<< 11)
559 : (USB_ENDPOINT_XFER_BULK
<< 11);
560 if (usb_pipein (pipe
))
561 clear
->devinfo
|= 1 << 15;
563 /* info for completion callback */
564 clear
->hcd
= bus_to_hcd(udev
->bus
);
567 /* tell keventd to clear state for this TT */
568 spin_lock_irqsave (&tt
->lock
, flags
);
569 list_add_tail (&clear
->clear_list
, &tt
->clear_list
);
570 schedule_work(&tt
->clear_work
);
571 spin_unlock_irqrestore (&tt
->lock
, flags
);
574 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer
);
576 /* If do_delay is false, return the number of milliseconds the caller
579 static unsigned hub_power_on(struct usb_hub
*hub
, bool do_delay
)
582 unsigned pgood_delay
= hub
->descriptor
->bPwrOn2PwrGood
* 2;
584 u16 wHubCharacteristics
=
585 le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
587 /* Enable power on each port. Some hubs have reserved values
588 * of LPSM (> 2) in their descriptors, even though they are
589 * USB 2.0 hubs. Some hubs do not implement port-power switching
590 * but only emulate it. In all cases, the ports won't work
591 * unless we send these messages to the hub.
593 if ((wHubCharacteristics
& HUB_CHAR_LPSM
) < 2)
594 dev_dbg(hub
->intfdev
, "enabling power on all ports\n");
596 dev_dbg(hub
->intfdev
, "trying to enable port power on "
597 "non-switchable hub\n");
598 for (port1
= 1; port1
<= hub
->descriptor
->bNbrPorts
; port1
++)
599 set_port_feature(hub
->hdev
, port1
, USB_PORT_FEAT_POWER
);
601 /* Wait at least 100 msec for power to become stable */
602 delay
= max(pgood_delay
, (unsigned) 100);
608 static int hub_hub_status(struct usb_hub
*hub
,
609 u16
*status
, u16
*change
)
613 mutex_lock(&hub
->status_mutex
);
614 ret
= get_hub_status(hub
->hdev
, &hub
->status
->hub
);
616 dev_err (hub
->intfdev
,
617 "%s failed (err = %d)\n", __func__
, ret
);
619 *status
= le16_to_cpu(hub
->status
->hub
.wHubStatus
);
620 *change
= le16_to_cpu(hub
->status
->hub
.wHubChange
);
623 mutex_unlock(&hub
->status_mutex
);
627 static int hub_port_disable(struct usb_hub
*hub
, int port1
, int set_state
)
629 struct usb_device
*hdev
= hub
->hdev
;
632 if (hdev
->children
[port1
-1] && set_state
)
633 usb_set_device_state(hdev
->children
[port1
-1],
634 USB_STATE_NOTATTACHED
);
635 if (!hub
->error
&& !hub_is_superspeed(hub
->hdev
))
636 ret
= clear_port_feature(hdev
, port1
, USB_PORT_FEAT_ENABLE
);
638 dev_err(hub
->intfdev
, "cannot disable port %d (err = %d)\n",
644 * Disable a port and mark a logical connect-change event, so that some
645 * time later khubd will disconnect() any existing usb_device on the port
646 * and will re-enumerate if there actually is a device attached.
648 static void hub_port_logical_disconnect(struct usb_hub
*hub
, int port1
)
650 dev_dbg(hub
->intfdev
, "logical disconnect on port %d\n", port1
);
651 hub_port_disable(hub
, port1
, 1);
653 /* FIXME let caller ask to power down the port:
654 * - some devices won't enumerate without a VBUS power cycle
655 * - SRP saves power that way
656 * - ... new call, TBD ...
657 * That's easy if this hub can switch power per-port, and
658 * khubd reactivates the port later (timer, SRP, etc).
659 * Powerdown must be optional, because of reset/DFU.
662 set_bit(port1
, hub
->change_bits
);
667 * usb_remove_device - disable a device's port on its parent hub
668 * @udev: device to be disabled and removed
669 * Context: @udev locked, must be able to sleep.
671 * After @udev's port has been disabled, khubd is notified and it will
672 * see that the device has been disconnected. When the device is
673 * physically unplugged and something is plugged in, the events will
674 * be received and processed normally.
676 int usb_remove_device(struct usb_device
*udev
)
679 struct usb_interface
*intf
;
681 if (!udev
->parent
) /* Can't remove a root hub */
683 hub
= hdev_to_hub(udev
->parent
);
684 intf
= to_usb_interface(hub
->intfdev
);
686 usb_autopm_get_interface(intf
);
687 set_bit(udev
->portnum
, hub
->removed_bits
);
688 hub_port_logical_disconnect(hub
, udev
->portnum
);
689 usb_autopm_put_interface(intf
);
693 enum hub_activation_type
{
694 HUB_INIT
, HUB_INIT2
, HUB_INIT3
, /* INITs must come first */
695 HUB_POST_RESET
, HUB_RESUME
, HUB_RESET_RESUME
,
698 static void hub_init_func2(struct work_struct
*ws
);
699 static void hub_init_func3(struct work_struct
*ws
);
701 static void hub_activate(struct usb_hub
*hub
, enum hub_activation_type type
)
703 struct usb_device
*hdev
= hub
->hdev
;
708 bool need_debounce_delay
= false;
711 /* Continue a partial initialization */
712 if (type
== HUB_INIT2
)
714 if (type
== HUB_INIT3
)
717 /* After a resume, port power should still be on.
718 * For any other type of activation, turn it on.
720 if (type
!= HUB_RESUME
) {
722 /* Speed up system boot by using a delayed_work for the
723 * hub's initial power-up delays. This is pretty awkward
724 * and the implementation looks like a home-brewed sort of
725 * setjmp/longjmp, but it saves at least 100 ms for each
726 * root hub (assuming usbcore is compiled into the kernel
727 * rather than as a module). It adds up.
729 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
730 * because for those activation types the ports have to be
731 * operational when we return. In theory this could be done
732 * for HUB_POST_RESET, but it's easier not to.
734 if (type
== HUB_INIT
) {
735 delay
= hub_power_on(hub
, false);
736 PREPARE_DELAYED_WORK(&hub
->init_work
, hub_init_func2
);
737 schedule_delayed_work(&hub
->init_work
,
738 msecs_to_jiffies(delay
));
740 /* Suppress autosuspend until init is done */
741 usb_autopm_get_interface_no_resume(
742 to_usb_interface(hub
->intfdev
));
743 return; /* Continues at init2: below */
744 } else if (type
== HUB_RESET_RESUME
) {
745 /* The internal host controller state for the hub device
746 * may be gone after a host power loss on system resume.
747 * Update the device's info so the HW knows it's a hub.
749 hcd
= bus_to_hcd(hdev
->bus
);
750 if (hcd
->driver
->update_hub_device
) {
751 ret
= hcd
->driver
->update_hub_device(hcd
, hdev
,
754 dev_err(hub
->intfdev
, "Host not "
755 "accepting hub info "
757 dev_err(hub
->intfdev
, "LS/FS devices "
758 "and hubs may not work "
759 "under this hub\n.");
762 hub_power_on(hub
, true);
764 hub_power_on(hub
, true);
769 /* Check each port and set hub->change_bits to let khubd know
770 * which ports need attention.
772 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
773 struct usb_device
*udev
= hdev
->children
[port1
-1];
774 u16 portstatus
, portchange
;
776 portstatus
= portchange
= 0;
777 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
778 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
))
779 dev_dbg(hub
->intfdev
,
780 "port %d: status %04x change %04x\n",
781 port1
, portstatus
, portchange
);
783 /* After anything other than HUB_RESUME (i.e., initialization
784 * or any sort of reset), every port should be disabled.
785 * Unconnected ports should likewise be disabled (paranoia),
786 * and so should ports for which we have no usb_device.
788 if ((portstatus
& USB_PORT_STAT_ENABLE
) && (
789 type
!= HUB_RESUME
||
790 !(portstatus
& USB_PORT_STAT_CONNECTION
) ||
792 udev
->state
== USB_STATE_NOTATTACHED
)) {
794 * USB3 protocol ports will automatically transition
795 * to Enabled state when detect an USB3.0 device attach.
796 * Do not disable USB3 protocol ports.
798 if (!hub_is_superspeed(hdev
)) {
799 clear_port_feature(hdev
, port1
,
800 USB_PORT_FEAT_ENABLE
);
801 portstatus
&= ~USB_PORT_STAT_ENABLE
;
803 /* Pretend that power was lost for USB3 devs */
804 portstatus
&= ~USB_PORT_STAT_ENABLE
;
808 /* Clear status-change flags; we'll debounce later */
809 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
810 need_debounce_delay
= true;
811 clear_port_feature(hub
->hdev
, port1
,
812 USB_PORT_FEAT_C_CONNECTION
);
814 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
815 need_debounce_delay
= true;
816 clear_port_feature(hub
->hdev
, port1
,
817 USB_PORT_FEAT_C_ENABLE
);
819 if (portchange
& USB_PORT_STAT_C_LINK_STATE
) {
820 need_debounce_delay
= true;
821 clear_port_feature(hub
->hdev
, port1
,
822 USB_PORT_FEAT_C_PORT_LINK_STATE
);
825 /* We can forget about a "removed" device when there's a
826 * physical disconnect or the connect status changes.
828 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
829 (portchange
& USB_PORT_STAT_C_CONNECTION
))
830 clear_bit(port1
, hub
->removed_bits
);
832 if (!udev
|| udev
->state
== USB_STATE_NOTATTACHED
) {
833 /* Tell khubd to disconnect the device or
834 * check for a new connection
836 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
))
837 set_bit(port1
, hub
->change_bits
);
839 } else if (portstatus
& USB_PORT_STAT_ENABLE
) {
840 /* The power session apparently survived the resume.
841 * If there was an overcurrent or suspend change
842 * (i.e., remote wakeup request), have khubd
846 set_bit(port1
, hub
->change_bits
);
848 } else if (udev
->persist_enabled
) {
850 udev
->reset_resume
= 1;
852 set_bit(port1
, hub
->change_bits
);
855 /* The power session is gone; tell khubd */
856 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
857 set_bit(port1
, hub
->change_bits
);
861 /* If no port-status-change flags were set, we don't need any
862 * debouncing. If flags were set we can try to debounce the
863 * ports all at once right now, instead of letting khubd do them
864 * one at a time later on.
866 * If any port-status changes do occur during this delay, khubd
867 * will see them later and handle them normally.
869 if (need_debounce_delay
) {
870 delay
= HUB_DEBOUNCE_STABLE
;
872 /* Don't do a long sleep inside a workqueue routine */
873 if (type
== HUB_INIT2
) {
874 PREPARE_DELAYED_WORK(&hub
->init_work
, hub_init_func3
);
875 schedule_delayed_work(&hub
->init_work
,
876 msecs_to_jiffies(delay
));
877 return; /* Continues at init3: below */
885 status
= usb_submit_urb(hub
->urb
, GFP_NOIO
);
887 dev_err(hub
->intfdev
, "activate --> %d\n", status
);
888 if (hub
->has_indicators
&& blinkenlights
)
889 schedule_delayed_work(&hub
->leds
, LED_CYCLE_PERIOD
);
891 /* Scan all ports that need attention */
894 /* Allow autosuspend if it was suppressed */
895 if (type
<= HUB_INIT3
)
896 usb_autopm_put_interface_async(to_usb_interface(hub
->intfdev
));
899 /* Implement the continuations for the delays above */
900 static void hub_init_func2(struct work_struct
*ws
)
902 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
904 hub_activate(hub
, HUB_INIT2
);
907 static void hub_init_func3(struct work_struct
*ws
)
909 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
911 hub_activate(hub
, HUB_INIT3
);
914 enum hub_quiescing_type
{
915 HUB_DISCONNECT
, HUB_PRE_RESET
, HUB_SUSPEND
918 static void hub_quiesce(struct usb_hub
*hub
, enum hub_quiescing_type type
)
920 struct usb_device
*hdev
= hub
->hdev
;
923 cancel_delayed_work_sync(&hub
->init_work
);
925 /* khubd and related activity won't re-trigger */
928 if (type
!= HUB_SUSPEND
) {
929 /* Disconnect all the children */
930 for (i
= 0; i
< hdev
->maxchild
; ++i
) {
931 if (hdev
->children
[i
])
932 usb_disconnect(&hdev
->children
[i
]);
936 /* Stop khubd and related activity */
937 usb_kill_urb(hub
->urb
);
938 if (hub
->has_indicators
)
939 cancel_delayed_work_sync(&hub
->leds
);
941 cancel_work_sync(&hub
->tt
.clear_work
);
944 /* caller has locked the hub device */
945 static int hub_pre_reset(struct usb_interface
*intf
)
947 struct usb_hub
*hub
= usb_get_intfdata(intf
);
949 hub_quiesce(hub
, HUB_PRE_RESET
);
953 /* caller has locked the hub device */
954 static int hub_post_reset(struct usb_interface
*intf
)
956 struct usb_hub
*hub
= usb_get_intfdata(intf
);
958 hub_activate(hub
, HUB_POST_RESET
);
962 static int hub_configure(struct usb_hub
*hub
,
963 struct usb_endpoint_descriptor
*endpoint
)
966 struct usb_device
*hdev
= hub
->hdev
;
967 struct device
*hub_dev
= hub
->intfdev
;
968 u16 hubstatus
, hubchange
;
969 u16 wHubCharacteristics
;
972 char *message
= "out of memory";
974 hub
->buffer
= kmalloc(sizeof(*hub
->buffer
), GFP_KERNEL
);
980 hub
->status
= kmalloc(sizeof(*hub
->status
), GFP_KERNEL
);
985 mutex_init(&hub
->status_mutex
);
987 hub
->descriptor
= kmalloc(sizeof(*hub
->descriptor
), GFP_KERNEL
);
988 if (!hub
->descriptor
) {
993 if (hub_is_superspeed(hdev
) && (hdev
->parent
!= NULL
)) {
994 ret
= usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
995 HUB_SET_DEPTH
, USB_RT_HUB
,
996 hdev
->level
- 1, 0, NULL
, 0,
997 USB_CTRL_SET_TIMEOUT
);
1000 message
= "can't set hub depth";
1005 /* Request the entire hub descriptor.
1006 * hub->descriptor can handle USB_MAXCHILDREN ports,
1007 * but the hub can/will return fewer bytes here.
1009 ret
= get_hub_descriptor(hdev
, hub
->descriptor
);
1011 message
= "can't read hub descriptor";
1013 } else if (hub
->descriptor
->bNbrPorts
> USB_MAXCHILDREN
) {
1014 message
= "hub has too many ports!";
1019 hdev
->maxchild
= hub
->descriptor
->bNbrPorts
;
1020 dev_info (hub_dev
, "%d port%s detected\n", hdev
->maxchild
,
1021 (hdev
->maxchild
== 1) ? "" : "s");
1023 hub
->port_owners
= kzalloc(hdev
->maxchild
* sizeof(void *), GFP_KERNEL
);
1024 if (!hub
->port_owners
) {
1029 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
1031 /* FIXME for USB 3.0, skip for now */
1032 if ((wHubCharacteristics
& HUB_CHAR_COMPOUND
) &&
1033 !(hub_is_superspeed(hdev
))) {
1035 char portstr
[USB_MAXCHILDREN
+ 1];
1037 for (i
= 0; i
< hdev
->maxchild
; i
++)
1038 portstr
[i
] = hub
->descriptor
->u
.hs
.DeviceRemovable
1039 [((i
+ 1) / 8)] & (1 << ((i
+ 1) % 8))
1041 portstr
[hdev
->maxchild
] = 0;
1042 dev_dbg(hub_dev
, "compound device; port removable status: %s\n", portstr
);
1044 dev_dbg(hub_dev
, "standalone hub\n");
1046 switch (wHubCharacteristics
& HUB_CHAR_LPSM
) {
1048 dev_dbg(hub_dev
, "ganged power switching\n");
1051 dev_dbg(hub_dev
, "individual port power switching\n");
1055 dev_dbg(hub_dev
, "no power switching (usb 1.0)\n");
1059 switch (wHubCharacteristics
& HUB_CHAR_OCPM
) {
1061 dev_dbg(hub_dev
, "global over-current protection\n");
1064 dev_dbg(hub_dev
, "individual port over-current protection\n");
1068 dev_dbg(hub_dev
, "no over-current protection\n");
1072 spin_lock_init (&hub
->tt
.lock
);
1073 INIT_LIST_HEAD (&hub
->tt
.clear_list
);
1074 INIT_WORK(&hub
->tt
.clear_work
, hub_tt_work
);
1075 switch (hdev
->descriptor
.bDeviceProtocol
) {
1079 dev_dbg(hub_dev
, "Single TT\n");
1083 ret
= usb_set_interface(hdev
, 0, 1);
1085 dev_dbg(hub_dev
, "TT per port\n");
1088 dev_err(hub_dev
, "Using single TT (err %d)\n",
1093 /* USB 3.0 hubs don't have a TT */
1096 dev_dbg(hub_dev
, "Unrecognized hub protocol %d\n",
1097 hdev
->descriptor
.bDeviceProtocol
);
1101 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1102 switch (wHubCharacteristics
& HUB_CHAR_TTTT
) {
1103 case HUB_TTTT_8_BITS
:
1104 if (hdev
->descriptor
.bDeviceProtocol
!= 0) {
1105 hub
->tt
.think_time
= 666;
1106 dev_dbg(hub_dev
, "TT requires at most %d "
1107 "FS bit times (%d ns)\n",
1108 8, hub
->tt
.think_time
);
1111 case HUB_TTTT_16_BITS
:
1112 hub
->tt
.think_time
= 666 * 2;
1113 dev_dbg(hub_dev
, "TT requires at most %d "
1114 "FS bit times (%d ns)\n",
1115 16, hub
->tt
.think_time
);
1117 case HUB_TTTT_24_BITS
:
1118 hub
->tt
.think_time
= 666 * 3;
1119 dev_dbg(hub_dev
, "TT requires at most %d "
1120 "FS bit times (%d ns)\n",
1121 24, hub
->tt
.think_time
);
1123 case HUB_TTTT_32_BITS
:
1124 hub
->tt
.think_time
= 666 * 4;
1125 dev_dbg(hub_dev
, "TT requires at most %d "
1126 "FS bit times (%d ns)\n",
1127 32, hub
->tt
.think_time
);
1131 /* probe() zeroes hub->indicator[] */
1132 if (wHubCharacteristics
& HUB_CHAR_PORTIND
) {
1133 hub
->has_indicators
= 1;
1134 dev_dbg(hub_dev
, "Port indicators are supported\n");
1137 dev_dbg(hub_dev
, "power on to power good time: %dms\n",
1138 hub
->descriptor
->bPwrOn2PwrGood
* 2);
1140 /* power budgeting mostly matters with bus-powered hubs,
1141 * and battery-powered root hubs (may provide just 8 mA).
1143 ret
= usb_get_status(hdev
, USB_RECIP_DEVICE
, 0, &hubstatus
);
1145 message
= "can't get hub status";
1148 le16_to_cpus(&hubstatus
);
1149 if (hdev
== hdev
->bus
->root_hub
) {
1150 if (hdev
->bus_mA
== 0 || hdev
->bus_mA
>= 500)
1151 hub
->mA_per_port
= 500;
1153 hub
->mA_per_port
= hdev
->bus_mA
;
1154 hub
->limited_power
= 1;
1156 } else if ((hubstatus
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
1157 dev_dbg(hub_dev
, "hub controller current requirement: %dmA\n",
1158 hub
->descriptor
->bHubContrCurrent
);
1159 hub
->limited_power
= 1;
1160 if (hdev
->maxchild
> 0) {
1161 int remaining
= hdev
->bus_mA
-
1162 hub
->descriptor
->bHubContrCurrent
;
1164 if (remaining
< hdev
->maxchild
* 100)
1166 "insufficient power available "
1167 "to use all downstream ports\n");
1168 hub
->mA_per_port
= 100; /* 7.2.1.1 */
1170 } else { /* Self-powered external hub */
1171 /* FIXME: What about battery-powered external hubs that
1172 * provide less current per port? */
1173 hub
->mA_per_port
= 500;
1175 if (hub
->mA_per_port
< 500)
1176 dev_dbg(hub_dev
, "%umA bus power budget for each child\n",
1179 /* Update the HCD's internal representation of this hub before khubd
1180 * starts getting port status changes for devices under the hub.
1182 hcd
= bus_to_hcd(hdev
->bus
);
1183 if (hcd
->driver
->update_hub_device
) {
1184 ret
= hcd
->driver
->update_hub_device(hcd
, hdev
,
1185 &hub
->tt
, GFP_KERNEL
);
1187 message
= "can't update HCD hub info";
1192 ret
= hub_hub_status(hub
, &hubstatus
, &hubchange
);
1194 message
= "can't get hub status";
1198 /* local power status reports aren't always correct */
1199 if (hdev
->actconfig
->desc
.bmAttributes
& USB_CONFIG_ATT_SELFPOWER
)
1200 dev_dbg(hub_dev
, "local power source is %s\n",
1201 (hubstatus
& HUB_STATUS_LOCAL_POWER
)
1202 ? "lost (inactive)" : "good");
1204 if ((wHubCharacteristics
& HUB_CHAR_OCPM
) == 0)
1205 dev_dbg(hub_dev
, "%sover-current condition exists\n",
1206 (hubstatus
& HUB_STATUS_OVERCURRENT
) ? "" : "no ");
1208 /* set up the interrupt endpoint
1209 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1210 * bytes as USB2.0[11.12.3] says because some hubs are known
1211 * to send more data (and thus cause overflow). For root hubs,
1212 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1213 * to be big enough for at least USB_MAXCHILDREN ports. */
1214 pipe
= usb_rcvintpipe(hdev
, endpoint
->bEndpointAddress
);
1215 maxp
= usb_maxpacket(hdev
, pipe
, usb_pipeout(pipe
));
1217 if (maxp
> sizeof(*hub
->buffer
))
1218 maxp
= sizeof(*hub
->buffer
);
1220 hub
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
1226 usb_fill_int_urb(hub
->urb
, hdev
, pipe
, *hub
->buffer
, maxp
, hub_irq
,
1227 hub
, endpoint
->bInterval
);
1229 /* maybe cycle the hub leds */
1230 if (hub
->has_indicators
&& blinkenlights
)
1231 hub
->indicator
[0] = INDICATOR_CYCLE
;
1233 hub_activate(hub
, HUB_INIT
);
1237 dev_err (hub_dev
, "config failed, %s (err %d)\n",
1239 /* hub_disconnect() frees urb and descriptor */
1243 static void hub_release(struct kref
*kref
)
1245 struct usb_hub
*hub
= container_of(kref
, struct usb_hub
, kref
);
1247 usb_put_intf(to_usb_interface(hub
->intfdev
));
1251 static unsigned highspeed_hubs
;
1253 static void hub_disconnect(struct usb_interface
*intf
)
1255 struct usb_hub
*hub
= usb_get_intfdata (intf
);
1257 /* Take the hub off the event list and don't let it be added again */
1258 spin_lock_irq(&hub_event_lock
);
1259 if (!list_empty(&hub
->event_list
)) {
1260 list_del_init(&hub
->event_list
);
1261 usb_autopm_put_interface_no_suspend(intf
);
1263 hub
->disconnected
= 1;
1264 spin_unlock_irq(&hub_event_lock
);
1266 /* Disconnect all children and quiesce the hub */
1268 hub_quiesce(hub
, HUB_DISCONNECT
);
1270 usb_set_intfdata (intf
, NULL
);
1271 hub
->hdev
->maxchild
= 0;
1273 if (hub
->hdev
->speed
== USB_SPEED_HIGH
)
1276 usb_free_urb(hub
->urb
);
1277 kfree(hub
->port_owners
);
1278 kfree(hub
->descriptor
);
1282 kref_put(&hub
->kref
, hub_release
);
1285 static int hub_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
1287 struct usb_host_interface
*desc
;
1288 struct usb_endpoint_descriptor
*endpoint
;
1289 struct usb_device
*hdev
;
1290 struct usb_hub
*hub
;
1292 desc
= intf
->cur_altsetting
;
1293 hdev
= interface_to_usbdev(intf
);
1295 /* Hubs have proper suspend/resume support. USB 3.0 device suspend is
1296 * different from USB 2.0/1.1 device suspend, and unfortunately we
1297 * don't support it yet. So leave autosuspend disabled for USB 3.0
1298 * external hubs for now. Enable autosuspend for USB 3.0 roothubs,
1299 * since that isn't a "real" hub.
1301 if (!hub_is_superspeed(hdev
) || !hdev
->parent
)
1302 usb_enable_autosuspend(hdev
);
1304 if (hdev
->level
== MAX_TOPO_LEVEL
) {
1306 "Unsupported bus topology: hub nested too deep\n");
1310 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1312 dev_warn(&intf
->dev
, "ignoring external hub\n");
1317 /* Some hubs have a subclass of 1, which AFAICT according to the */
1318 /* specs is not defined, but it works */
1319 if ((desc
->desc
.bInterfaceSubClass
!= 0) &&
1320 (desc
->desc
.bInterfaceSubClass
!= 1)) {
1322 dev_err (&intf
->dev
, "bad descriptor, ignoring hub\n");
1326 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1327 if (desc
->desc
.bNumEndpoints
!= 1)
1328 goto descriptor_error
;
1330 endpoint
= &desc
->endpoint
[0].desc
;
1332 /* If it's not an interrupt in endpoint, we'd better punt! */
1333 if (!usb_endpoint_is_int_in(endpoint
))
1334 goto descriptor_error
;
1336 /* We found a hub */
1337 dev_info (&intf
->dev
, "USB hub found\n");
1339 hub
= kzalloc(sizeof(*hub
), GFP_KERNEL
);
1341 dev_dbg (&intf
->dev
, "couldn't kmalloc hub struct\n");
1345 kref_init(&hub
->kref
);
1346 INIT_LIST_HEAD(&hub
->event_list
);
1347 hub
->intfdev
= &intf
->dev
;
1349 INIT_DELAYED_WORK(&hub
->leds
, led_work
);
1350 INIT_DELAYED_WORK(&hub
->init_work
, NULL
);
1353 usb_set_intfdata (intf
, hub
);
1354 intf
->needs_remote_wakeup
= 1;
1356 if (hdev
->speed
== USB_SPEED_HIGH
)
1359 if (hub_configure(hub
, endpoint
) >= 0)
1362 hub_disconnect (intf
);
1368 hub_ioctl(struct usb_interface
*intf
, unsigned int code
, void *user_data
)
1370 struct usb_device
*hdev
= interface_to_usbdev (intf
);
1372 /* assert ifno == 0 (part of hub spec) */
1374 case USBDEVFS_HUB_PORTINFO
: {
1375 struct usbdevfs_hub_portinfo
*info
= user_data
;
1378 spin_lock_irq(&device_state_lock
);
1379 if (hdev
->devnum
<= 0)
1382 info
->nports
= hdev
->maxchild
;
1383 for (i
= 0; i
< info
->nports
; i
++) {
1384 if (hdev
->children
[i
] == NULL
)
1388 hdev
->children
[i
]->devnum
;
1391 spin_unlock_irq(&device_state_lock
);
1393 return info
->nports
+ 1;
1402 * Allow user programs to claim ports on a hub. When a device is attached
1403 * to one of these "claimed" ports, the program will "own" the device.
1405 static int find_port_owner(struct usb_device
*hdev
, unsigned port1
,
1408 if (hdev
->state
== USB_STATE_NOTATTACHED
)
1410 if (port1
== 0 || port1
> hdev
->maxchild
)
1413 /* This assumes that devices not managed by the hub driver
1414 * will always have maxchild equal to 0.
1416 *ppowner
= &(hdev_to_hub(hdev
)->port_owners
[port1
- 1]);
1420 /* In the following three functions, the caller must hold hdev's lock */
1421 int usb_hub_claim_port(struct usb_device
*hdev
, unsigned port1
, void *owner
)
1426 rc
= find_port_owner(hdev
, port1
, &powner
);
1435 int usb_hub_release_port(struct usb_device
*hdev
, unsigned port1
, void *owner
)
1440 rc
= find_port_owner(hdev
, port1
, &powner
);
1443 if (*powner
!= owner
)
1449 void usb_hub_release_all_ports(struct usb_device
*hdev
, void *owner
)
1454 n
= find_port_owner(hdev
, 1, &powner
);
1456 for (; n
< hdev
->maxchild
; (++n
, ++powner
)) {
1457 if (*powner
== owner
)
1463 /* The caller must hold udev's lock */
1464 bool usb_device_is_owned(struct usb_device
*udev
)
1466 struct usb_hub
*hub
;
1468 if (udev
->state
== USB_STATE_NOTATTACHED
|| !udev
->parent
)
1470 hub
= hdev_to_hub(udev
->parent
);
1471 return !!hub
->port_owners
[udev
->portnum
- 1];
1475 static void recursively_mark_NOTATTACHED(struct usb_device
*udev
)
1479 for (i
= 0; i
< udev
->maxchild
; ++i
) {
1480 if (udev
->children
[i
])
1481 recursively_mark_NOTATTACHED(udev
->children
[i
]);
1483 if (udev
->state
== USB_STATE_SUSPENDED
)
1484 udev
->active_duration
-= jiffies
;
1485 udev
->state
= USB_STATE_NOTATTACHED
;
1489 * usb_set_device_state - change a device's current state (usbcore, hcds)
1490 * @udev: pointer to device whose state should be changed
1491 * @new_state: new state value to be stored
1493 * udev->state is _not_ fully protected by the device lock. Although
1494 * most transitions are made only while holding the lock, the state can
1495 * can change to USB_STATE_NOTATTACHED at almost any time. This
1496 * is so that devices can be marked as disconnected as soon as possible,
1497 * without having to wait for any semaphores to be released. As a result,
1498 * all changes to any device's state must be protected by the
1499 * device_state_lock spinlock.
1501 * Once a device has been added to the device tree, all changes to its state
1502 * should be made using this routine. The state should _not_ be set directly.
1504 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1505 * Otherwise udev->state is set to new_state, and if new_state is
1506 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1507 * to USB_STATE_NOTATTACHED.
1509 void usb_set_device_state(struct usb_device
*udev
,
1510 enum usb_device_state new_state
)
1512 unsigned long flags
;
1515 spin_lock_irqsave(&device_state_lock
, flags
);
1516 if (udev
->state
== USB_STATE_NOTATTACHED
)
1518 else if (new_state
!= USB_STATE_NOTATTACHED
) {
1520 /* root hub wakeup capabilities are managed out-of-band
1521 * and may involve silicon errata ... ignore them here.
1524 if (udev
->state
== USB_STATE_SUSPENDED
1525 || new_state
== USB_STATE_SUSPENDED
)
1526 ; /* No change to wakeup settings */
1527 else if (new_state
== USB_STATE_CONFIGURED
)
1528 wakeup
= udev
->actconfig
->desc
.bmAttributes
1529 & USB_CONFIG_ATT_WAKEUP
;
1533 if (udev
->state
== USB_STATE_SUSPENDED
&&
1534 new_state
!= USB_STATE_SUSPENDED
)
1535 udev
->active_duration
-= jiffies
;
1536 else if (new_state
== USB_STATE_SUSPENDED
&&
1537 udev
->state
!= USB_STATE_SUSPENDED
)
1538 udev
->active_duration
+= jiffies
;
1539 udev
->state
= new_state
;
1541 recursively_mark_NOTATTACHED(udev
);
1542 spin_unlock_irqrestore(&device_state_lock
, flags
);
1544 device_set_wakeup_capable(&udev
->dev
, wakeup
);
1546 EXPORT_SYMBOL_GPL(usb_set_device_state
);
1549 * Choose a device number.
1551 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1552 * USB-2.0 buses they are also used as device addresses, however on
1553 * USB-3.0 buses the address is assigned by the controller hardware
1554 * and it usually is not the same as the device number.
1556 * WUSB devices are simple: they have no hubs behind, so the mapping
1557 * device <-> virtual port number becomes 1:1. Why? to simplify the
1558 * life of the device connection logic in
1559 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1560 * handshake we need to assign a temporary address in the unauthorized
1561 * space. For simplicity we use the first virtual port number found to
1562 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1563 * and that becomes it's address [X < 128] or its unauthorized address
1566 * We add 1 as an offset to the one-based USB-stack port number
1567 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1568 * 0 is reserved by USB for default address; (b) Linux's USB stack
1569 * uses always #1 for the root hub of the controller. So USB stack's
1570 * port #1, which is wusb virtual-port #0 has address #2.
1572 * Devices connected under xHCI are not as simple. The host controller
1573 * supports virtualization, so the hardware assigns device addresses and
1574 * the HCD must setup data structures before issuing a set address
1575 * command to the hardware.
1577 static void choose_devnum(struct usb_device
*udev
)
1580 struct usb_bus
*bus
= udev
->bus
;
1582 /* If khubd ever becomes multithreaded, this will need a lock */
1584 devnum
= udev
->portnum
+ 1;
1585 BUG_ON(test_bit(devnum
, bus
->devmap
.devicemap
));
1587 /* Try to allocate the next devnum beginning at
1588 * bus->devnum_next. */
1589 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
, 128,
1592 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
,
1594 bus
->devnum_next
= ( devnum
>= 127 ? 1 : devnum
+ 1);
1597 set_bit(devnum
, bus
->devmap
.devicemap
);
1598 udev
->devnum
= devnum
;
1602 static void release_devnum(struct usb_device
*udev
)
1604 if (udev
->devnum
> 0) {
1605 clear_bit(udev
->devnum
, udev
->bus
->devmap
.devicemap
);
1610 static void update_devnum(struct usb_device
*udev
, int devnum
)
1612 /* The address for a WUSB device is managed by wusbcore. */
1614 udev
->devnum
= devnum
;
1617 static void hub_free_dev(struct usb_device
*udev
)
1619 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
1621 /* Root hubs aren't real devices, so don't free HCD resources */
1622 if (hcd
->driver
->free_dev
&& udev
->parent
)
1623 hcd
->driver
->free_dev(hcd
, udev
);
1627 * usb_disconnect - disconnect a device (usbcore-internal)
1628 * @pdev: pointer to device being disconnected
1629 * Context: !in_interrupt ()
1631 * Something got disconnected. Get rid of it and all of its children.
1633 * If *pdev is a normal device then the parent hub must already be locked.
1634 * If *pdev is a root hub then this routine will acquire the
1635 * usb_bus_list_lock on behalf of the caller.
1637 * Only hub drivers (including virtual root hub drivers for host
1638 * controllers) should ever call this.
1640 * This call is synchronous, and may not be used in an interrupt context.
1642 void usb_disconnect(struct usb_device
**pdev
)
1644 struct usb_device
*udev
= *pdev
;
1648 pr_debug ("%s nodev\n", __func__
);
1652 /* mark the device as inactive, so any further urb submissions for
1653 * this device (and any of its children) will fail immediately.
1654 * this quiesces everything except pending urbs.
1656 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
1657 dev_info(&udev
->dev
, "USB disconnect, device number %d\n",
1660 usb_lock_device(udev
);
1662 /* Free up all the children before we remove this device */
1663 for (i
= 0; i
< USB_MAXCHILDREN
; i
++) {
1664 if (udev
->children
[i
])
1665 usb_disconnect(&udev
->children
[i
]);
1668 /* deallocate hcd/hardware state ... nuking all pending urbs and
1669 * cleaning up all state associated with the current configuration
1670 * so that the hardware is now fully quiesced.
1672 dev_dbg (&udev
->dev
, "unregistering device\n");
1673 usb_disable_device(udev
, 0);
1674 usb_hcd_synchronize_unlinks(udev
);
1676 usb_remove_ep_devs(&udev
->ep0
);
1677 usb_unlock_device(udev
);
1679 /* Unregister the device. The device driver is responsible
1680 * for de-configuring the device and invoking the remove-device
1681 * notifier chain (used by usbfs and possibly others).
1683 device_del(&udev
->dev
);
1685 /* Free the device number and delete the parent's children[]
1686 * (or root_hub) pointer.
1688 release_devnum(udev
);
1690 /* Avoid races with recursively_mark_NOTATTACHED() */
1691 spin_lock_irq(&device_state_lock
);
1693 spin_unlock_irq(&device_state_lock
);
1697 put_device(&udev
->dev
);
1700 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
1701 static void show_string(struct usb_device
*udev
, char *id
, char *string
)
1705 dev_printk(KERN_INFO
, &udev
->dev
, "%s: %s\n", id
, string
);
1708 static void announce_device(struct usb_device
*udev
)
1710 dev_info(&udev
->dev
, "New USB device found, idVendor=%04x, idProduct=%04x\n",
1711 le16_to_cpu(udev
->descriptor
.idVendor
),
1712 le16_to_cpu(udev
->descriptor
.idProduct
));
1713 dev_info(&udev
->dev
,
1714 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
1715 udev
->descriptor
.iManufacturer
,
1716 udev
->descriptor
.iProduct
,
1717 udev
->descriptor
.iSerialNumber
);
1718 show_string(udev
, "Product", udev
->product
);
1719 show_string(udev
, "Manufacturer", udev
->manufacturer
);
1720 show_string(udev
, "SerialNumber", udev
->serial
);
1723 static inline void announce_device(struct usb_device
*udev
) { }
1726 #ifdef CONFIG_USB_OTG
1727 #include "otg_whitelist.h"
1731 * usb_enumerate_device_otg - FIXME (usbcore-internal)
1732 * @udev: newly addressed device (in ADDRESS state)
1734 * Finish enumeration for On-The-Go devices
1736 static int usb_enumerate_device_otg(struct usb_device
*udev
)
1740 #ifdef CONFIG_USB_OTG
1742 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1743 * to wake us after we've powered off VBUS; and HNP, switching roles
1744 * "host" to "peripheral". The OTG descriptor helps figure this out.
1746 if (!udev
->bus
->is_b_host
1748 && udev
->parent
== udev
->bus
->root_hub
) {
1749 struct usb_otg_descriptor
*desc
= NULL
;
1750 struct usb_bus
*bus
= udev
->bus
;
1752 /* descriptor may appear anywhere in config */
1753 if (__usb_get_extra_descriptor (udev
->rawdescriptors
[0],
1754 le16_to_cpu(udev
->config
[0].desc
.wTotalLength
),
1755 USB_DT_OTG
, (void **) &desc
) == 0) {
1756 if (desc
->bmAttributes
& USB_OTG_HNP
) {
1757 unsigned port1
= udev
->portnum
;
1759 dev_info(&udev
->dev
,
1760 "Dual-Role OTG device on %sHNP port\n",
1761 (port1
== bus
->otg_port
)
1764 /* enable HNP before suspend, it's simpler */
1765 if (port1
== bus
->otg_port
)
1766 bus
->b_hnp_enable
= 1;
1767 err
= usb_control_msg(udev
,
1768 usb_sndctrlpipe(udev
, 0),
1769 USB_REQ_SET_FEATURE
, 0,
1771 ? USB_DEVICE_B_HNP_ENABLE
1772 : USB_DEVICE_A_ALT_HNP_SUPPORT
,
1773 0, NULL
, 0, USB_CTRL_SET_TIMEOUT
);
1775 /* OTG MESSAGE: report errors here,
1776 * customize to match your product.
1778 dev_info(&udev
->dev
,
1779 "can't set HNP mode: %d\n",
1781 bus
->b_hnp_enable
= 0;
1787 if (!is_targeted(udev
)) {
1789 /* Maybe it can talk to us, though we can't talk to it.
1790 * (Includes HNP test device.)
1792 if (udev
->bus
->b_hnp_enable
|| udev
->bus
->is_b_host
) {
1793 err
= usb_port_suspend(udev
, PMSG_SUSPEND
);
1795 dev_dbg(&udev
->dev
, "HNP fail, %d\n", err
);
1807 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
1808 * @udev: newly addressed device (in ADDRESS state)
1810 * This is only called by usb_new_device() and usb_authorize_device()
1811 * and FIXME -- all comments that apply to them apply here wrt to
1814 * If the device is WUSB and not authorized, we don't attempt to read
1815 * the string descriptors, as they will be errored out by the device
1816 * until it has been authorized.
1818 static int usb_enumerate_device(struct usb_device
*udev
)
1822 if (udev
->config
== NULL
) {
1823 err
= usb_get_configuration(udev
);
1825 dev_err(&udev
->dev
, "can't read configurations, error %d\n",
1830 if (udev
->wusb
== 1 && udev
->authorized
== 0) {
1831 udev
->product
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1832 udev
->manufacturer
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1833 udev
->serial
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1836 /* read the standard strings and cache them if present */
1837 udev
->product
= usb_cache_string(udev
, udev
->descriptor
.iProduct
);
1838 udev
->manufacturer
= usb_cache_string(udev
,
1839 udev
->descriptor
.iManufacturer
);
1840 udev
->serial
= usb_cache_string(udev
, udev
->descriptor
.iSerialNumber
);
1842 err
= usb_enumerate_device_otg(udev
);
1849 * usb_new_device - perform initial device setup (usbcore-internal)
1850 * @udev: newly addressed device (in ADDRESS state)
1852 * This is called with devices which have been detected but not fully
1853 * enumerated. The device descriptor is available, but not descriptors
1854 * for any device configuration. The caller must have locked either
1855 * the parent hub (if udev is a normal device) or else the
1856 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1857 * udev has already been installed, but udev is not yet visible through
1858 * sysfs or other filesystem code.
1860 * It will return if the device is configured properly or not. Zero if
1861 * the interface was registered with the driver core; else a negative
1864 * This call is synchronous, and may not be used in an interrupt context.
1866 * Only the hub driver or root-hub registrar should ever call this.
1868 int usb_new_device(struct usb_device
*udev
)
1873 /* Initialize non-root-hub device wakeup to disabled;
1874 * device (un)configuration controls wakeup capable
1875 * sysfs power/wakeup controls wakeup enabled/disabled
1877 device_init_wakeup(&udev
->dev
, 0);
1880 /* Tell the runtime-PM framework the device is active */
1881 pm_runtime_set_active(&udev
->dev
);
1882 pm_runtime_get_noresume(&udev
->dev
);
1883 pm_runtime_use_autosuspend(&udev
->dev
);
1884 pm_runtime_enable(&udev
->dev
);
1886 /* By default, forbid autosuspend for all devices. It will be
1887 * allowed for hubs during binding.
1889 usb_disable_autosuspend(udev
);
1891 err
= usb_enumerate_device(udev
); /* Read descriptors */
1894 dev_dbg(&udev
->dev
, "udev %d, busnum %d, minor = %d\n",
1895 udev
->devnum
, udev
->bus
->busnum
,
1896 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
1897 /* export the usbdev device-node for libusb */
1898 udev
->dev
.devt
= MKDEV(USB_DEVICE_MAJOR
,
1899 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
1901 /* Tell the world! */
1902 announce_device(udev
);
1904 device_enable_async_suspend(&udev
->dev
);
1905 /* Register the device. The device driver is responsible
1906 * for configuring the device and invoking the add-device
1907 * notifier chain (used by usbfs and possibly others).
1909 err
= device_add(&udev
->dev
);
1911 dev_err(&udev
->dev
, "can't device_add, error %d\n", err
);
1915 (void) usb_create_ep_devs(&udev
->dev
, &udev
->ep0
, udev
);
1916 usb_mark_last_busy(udev
);
1917 pm_runtime_put_sync_autosuspend(&udev
->dev
);
1921 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
1922 pm_runtime_disable(&udev
->dev
);
1923 pm_runtime_set_suspended(&udev
->dev
);
1929 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
1930 * @usb_dev: USB device
1932 * Move the USB device to a very basic state where interfaces are disabled
1933 * and the device is in fact unconfigured and unusable.
1935 * We share a lock (that we have) with device_del(), so we need to
1938 int usb_deauthorize_device(struct usb_device
*usb_dev
)
1940 usb_lock_device(usb_dev
);
1941 if (usb_dev
->authorized
== 0)
1942 goto out_unauthorized
;
1944 usb_dev
->authorized
= 0;
1945 usb_set_configuration(usb_dev
, -1);
1947 kfree(usb_dev
->product
);
1948 usb_dev
->product
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1949 kfree(usb_dev
->manufacturer
);
1950 usb_dev
->manufacturer
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1951 kfree(usb_dev
->serial
);
1952 usb_dev
->serial
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1954 usb_destroy_configuration(usb_dev
);
1955 usb_dev
->descriptor
.bNumConfigurations
= 0;
1958 usb_unlock_device(usb_dev
);
1963 int usb_authorize_device(struct usb_device
*usb_dev
)
1967 usb_lock_device(usb_dev
);
1968 if (usb_dev
->authorized
== 1)
1969 goto out_authorized
;
1971 result
= usb_autoresume_device(usb_dev
);
1973 dev_err(&usb_dev
->dev
,
1974 "can't autoresume for authorization: %d\n", result
);
1975 goto error_autoresume
;
1977 result
= usb_get_device_descriptor(usb_dev
, sizeof(usb_dev
->descriptor
));
1979 dev_err(&usb_dev
->dev
, "can't re-read device descriptor for "
1980 "authorization: %d\n", result
);
1981 goto error_device_descriptor
;
1984 kfree(usb_dev
->product
);
1985 usb_dev
->product
= NULL
;
1986 kfree(usb_dev
->manufacturer
);
1987 usb_dev
->manufacturer
= NULL
;
1988 kfree(usb_dev
->serial
);
1989 usb_dev
->serial
= NULL
;
1991 usb_dev
->authorized
= 1;
1992 result
= usb_enumerate_device(usb_dev
);
1994 goto error_enumerate
;
1995 /* Choose and set the configuration. This registers the interfaces
1996 * with the driver core and lets interface drivers bind to them.
1998 c
= usb_choose_configuration(usb_dev
);
2000 result
= usb_set_configuration(usb_dev
, c
);
2002 dev_err(&usb_dev
->dev
,
2003 "can't set config #%d, error %d\n", c
, result
);
2004 /* This need not be fatal. The user can try to
2005 * set other configurations. */
2008 dev_info(&usb_dev
->dev
, "authorized to connect\n");
2011 error_device_descriptor
:
2012 usb_autosuspend_device(usb_dev
);
2015 usb_unlock_device(usb_dev
); // complements locktree
2020 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2021 static unsigned hub_is_wusb(struct usb_hub
*hub
)
2023 struct usb_hcd
*hcd
;
2024 if (hub
->hdev
->parent
!= NULL
) /* not a root hub? */
2026 hcd
= container_of(hub
->hdev
->bus
, struct usb_hcd
, self
);
2027 return hcd
->wireless
;
2031 #define PORT_RESET_TRIES 5
2032 #define SET_ADDRESS_TRIES 2
2033 #define GET_DESCRIPTOR_TRIES 2
2034 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2035 #define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
2037 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2038 #define HUB_SHORT_RESET_TIME 10
2039 #define HUB_LONG_RESET_TIME 200
2040 #define HUB_RESET_TIMEOUT 500
2042 static int hub_port_wait_reset(struct usb_hub
*hub
, int port1
,
2043 struct usb_device
*udev
, unsigned int delay
)
2045 int delay_time
, ret
;
2049 for (delay_time
= 0;
2050 delay_time
< HUB_RESET_TIMEOUT
;
2051 delay_time
+= delay
) {
2052 /* wait to give the device a chance to reset */
2055 /* read and decode port status */
2056 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
2060 /* Device went away? */
2061 if (!(portstatus
& USB_PORT_STAT_CONNECTION
))
2064 /* bomb out completely if the connection bounced */
2065 if ((portchange
& USB_PORT_STAT_C_CONNECTION
))
2068 /* if we`ve finished resetting, then break out of the loop */
2069 if (!(portstatus
& USB_PORT_STAT_RESET
) &&
2070 (portstatus
& USB_PORT_STAT_ENABLE
)) {
2071 if (hub_is_wusb(hub
))
2072 udev
->speed
= USB_SPEED_WIRELESS
;
2073 else if (hub_is_superspeed(hub
->hdev
))
2074 udev
->speed
= USB_SPEED_SUPER
;
2075 else if (portstatus
& USB_PORT_STAT_HIGH_SPEED
)
2076 udev
->speed
= USB_SPEED_HIGH
;
2077 else if (portstatus
& USB_PORT_STAT_LOW_SPEED
)
2078 udev
->speed
= USB_SPEED_LOW
;
2080 udev
->speed
= USB_SPEED_FULL
;
2084 /* switch to the long delay after two short delay failures */
2085 if (delay_time
>= 2 * HUB_SHORT_RESET_TIME
)
2086 delay
= HUB_LONG_RESET_TIME
;
2088 dev_dbg (hub
->intfdev
,
2089 "port %d not reset yet, waiting %dms\n",
2096 static int hub_port_reset(struct usb_hub
*hub
, int port1
,
2097 struct usb_device
*udev
, unsigned int delay
)
2100 struct usb_hcd
*hcd
;
2102 hcd
= bus_to_hcd(udev
->bus
);
2103 /* Block EHCI CF initialization during the port reset.
2104 * Some companion controllers don't like it when they mix.
2106 down_read(&ehci_cf_port_reset_rwsem
);
2108 /* Reset the port */
2109 for (i
= 0; i
< PORT_RESET_TRIES
; i
++) {
2110 status
= set_port_feature(hub
->hdev
,
2111 port1
, USB_PORT_FEAT_RESET
);
2113 dev_err(hub
->intfdev
,
2114 "cannot reset port %d (err = %d)\n",
2117 status
= hub_port_wait_reset(hub
, port1
, udev
, delay
);
2118 if (status
&& status
!= -ENOTCONN
)
2119 dev_dbg(hub
->intfdev
,
2120 "port_wait_reset: err = %d\n",
2124 /* return on disconnect or reset */
2127 /* TRSTRCY = 10 ms; plus some extra */
2129 update_devnum(udev
, 0);
2130 if (hcd
->driver
->reset_device
) {
2131 status
= hcd
->driver
->reset_device(hcd
, udev
);
2133 dev_err(&udev
->dev
, "Cannot reset "
2134 "HCD device state\n");
2141 clear_port_feature(hub
->hdev
,
2142 port1
, USB_PORT_FEAT_C_RESET
);
2143 /* FIXME need disconnect() for NOTATTACHED device */
2144 usb_set_device_state(udev
, status
2145 ? USB_STATE_NOTATTACHED
2146 : USB_STATE_DEFAULT
);
2150 dev_dbg (hub
->intfdev
,
2151 "port %d not enabled, trying reset again...\n",
2153 delay
= HUB_LONG_RESET_TIME
;
2156 dev_err (hub
->intfdev
,
2157 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2161 up_read(&ehci_cf_port_reset_rwsem
);
2167 #define MASK_BITS (USB_PORT_STAT_POWER | USB_PORT_STAT_CONNECTION | \
2168 USB_PORT_STAT_SUSPEND)
2169 #define WANT_BITS (USB_PORT_STAT_POWER | USB_PORT_STAT_CONNECTION)
2171 /* Determine whether the device on a port is ready for a normal resume,
2172 * is ready for a reset-resume, or should be disconnected.
2174 static int check_port_resume_type(struct usb_device
*udev
,
2175 struct usb_hub
*hub
, int port1
,
2176 int status
, unsigned portchange
, unsigned portstatus
)
2178 /* Is the device still present? */
2179 if (status
|| (portstatus
& MASK_BITS
) != WANT_BITS
) {
2184 /* Can't do a normal resume if the port isn't enabled,
2185 * so try a reset-resume instead.
2187 else if (!(portstatus
& USB_PORT_STAT_ENABLE
) && !udev
->reset_resume
) {
2188 if (udev
->persist_enabled
)
2189 udev
->reset_resume
= 1;
2195 dev_dbg(hub
->intfdev
,
2196 "port %d status %04x.%04x after resume, %d\n",
2197 port1
, portchange
, portstatus
, status
);
2198 } else if (udev
->reset_resume
) {
2200 /* Late port handoff can set status-change bits */
2201 if (portchange
& USB_PORT_STAT_C_CONNECTION
)
2202 clear_port_feature(hub
->hdev
, port1
,
2203 USB_PORT_FEAT_C_CONNECTION
);
2204 if (portchange
& USB_PORT_STAT_C_ENABLE
)
2205 clear_port_feature(hub
->hdev
, port1
,
2206 USB_PORT_FEAT_C_ENABLE
);
2212 #ifdef CONFIG_USB_SUSPEND
2215 * usb_port_suspend - suspend a usb device's upstream port
2216 * @udev: device that's no longer in active use, not a root hub
2217 * Context: must be able to sleep; device not locked; pm locks held
2219 * Suspends a USB device that isn't in active use, conserving power.
2220 * Devices may wake out of a suspend, if anything important happens,
2221 * using the remote wakeup mechanism. They may also be taken out of
2222 * suspend by the host, using usb_port_resume(). It's also routine
2223 * to disconnect devices while they are suspended.
2225 * This only affects the USB hardware for a device; its interfaces
2226 * (and, for hubs, child devices) must already have been suspended.
2228 * Selective port suspend reduces power; most suspended devices draw
2229 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2230 * All devices below the suspended port are also suspended.
2232 * Devices leave suspend state when the host wakes them up. Some devices
2233 * also support "remote wakeup", where the device can activate the USB
2234 * tree above them to deliver data, such as a keypress or packet. In
2235 * some cases, this wakes the USB host.
2237 * Suspending OTG devices may trigger HNP, if that's been enabled
2238 * between a pair of dual-role devices. That will change roles, such
2239 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2241 * Devices on USB hub ports have only one "suspend" state, corresponding
2242 * to ACPI D2, "may cause the device to lose some context".
2243 * State transitions include:
2245 * - suspend, resume ... when the VBUS power link stays live
2246 * - suspend, disconnect ... VBUS lost
2248 * Once VBUS drop breaks the circuit, the port it's using has to go through
2249 * normal re-enumeration procedures, starting with enabling VBUS power.
2250 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2251 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2252 * timer, no SRP, no requests through sysfs.
2254 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
2255 * the root hub for their bus goes into global suspend ... so we don't
2256 * (falsely) update the device power state to say it suspended.
2258 * Returns 0 on success, else negative errno.
2260 int usb_port_suspend(struct usb_device
*udev
, pm_message_t msg
)
2262 struct usb_hub
*hub
= hdev_to_hub(udev
->parent
);
2263 int port1
= udev
->portnum
;
2266 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
2268 /* enable remote wakeup when appropriate; this lets the device
2269 * wake up the upstream hub (including maybe the root hub).
2271 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2272 * we don't explicitly enable it here.
2274 if (udev
->do_remote_wakeup
) {
2275 status
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2276 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
2277 USB_DEVICE_REMOTE_WAKEUP
, 0,
2279 USB_CTRL_SET_TIMEOUT
);
2281 dev_dbg(&udev
->dev
, "won't remote wakeup, status %d\n",
2283 /* bail if autosuspend is requested */
2284 if (msg
.event
& PM_EVENT_AUTO
)
2290 /* Clear PORT_POWER if it's a USB3.0 device connected to USB 3.0
2292 * FIXME: this is a temporary workaround to make the system able
2293 * to suspend/resume.
2295 if ((hub
->hdev
->parent
!= NULL
) && hub_is_superspeed(hub
->hdev
))
2296 status
= clear_port_feature(hub
->hdev
, port1
,
2297 USB_PORT_FEAT_POWER
);
2299 status
= set_port_feature(hub
->hdev
, port1
,
2300 USB_PORT_FEAT_SUSPEND
);
2302 dev_dbg(hub
->intfdev
, "can't suspend port %d, status %d\n",
2304 /* paranoia: "should not happen" */
2305 if (udev
->do_remote_wakeup
)
2306 (void) usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2307 USB_REQ_CLEAR_FEATURE
, USB_RECIP_DEVICE
,
2308 USB_DEVICE_REMOTE_WAKEUP
, 0,
2310 USB_CTRL_SET_TIMEOUT
);
2312 /* device has up to 10 msec to fully suspend */
2313 dev_dbg(&udev
->dev
, "usb %ssuspend\n",
2314 (msg
.event
& PM_EVENT_AUTO
? "auto-" : ""));
2315 usb_set_device_state(udev
, USB_STATE_SUSPENDED
);
2318 usb_mark_last_busy(hub
->hdev
);
2323 * If the USB "suspend" state is in use (rather than "global suspend"),
2324 * many devices will be individually taken out of suspend state using
2325 * special "resume" signaling. This routine kicks in shortly after
2326 * hardware resume signaling is finished, either because of selective
2327 * resume (by host) or remote wakeup (by device) ... now see what changed
2328 * in the tree that's rooted at this device.
2330 * If @udev->reset_resume is set then the device is reset before the
2331 * status check is done.
2333 static int finish_port_resume(struct usb_device
*udev
)
2338 /* caller owns the udev device lock */
2339 dev_dbg(&udev
->dev
, "%s\n",
2340 udev
->reset_resume
? "finish reset-resume" : "finish resume");
2342 /* usb ch9 identifies four variants of SUSPENDED, based on what
2343 * state the device resumes to. Linux currently won't see the
2344 * first two on the host side; they'd be inside hub_port_init()
2345 * during many timeouts, but khubd can't suspend until later.
2347 usb_set_device_state(udev
, udev
->actconfig
2348 ? USB_STATE_CONFIGURED
2349 : USB_STATE_ADDRESS
);
2351 /* 10.5.4.5 says not to reset a suspended port if the attached
2352 * device is enabled for remote wakeup. Hence the reset
2353 * operation is carried out here, after the port has been
2356 if (udev
->reset_resume
)
2358 status
= usb_reset_and_verify_device(udev
);
2360 /* 10.5.4.5 says be sure devices in the tree are still there.
2361 * For now let's assume the device didn't go crazy on resume,
2362 * and device drivers will know about any resume quirks.
2366 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0, &devstatus
);
2368 status
= (status
> 0 ? 0 : -ENODEV
);
2370 /* If a normal resume failed, try doing a reset-resume */
2371 if (status
&& !udev
->reset_resume
&& udev
->persist_enabled
) {
2372 dev_dbg(&udev
->dev
, "retry with reset-resume\n");
2373 udev
->reset_resume
= 1;
2374 goto retry_reset_resume
;
2379 dev_dbg(&udev
->dev
, "gone after usb resume? status %d\n",
2381 } else if (udev
->actconfig
) {
2382 le16_to_cpus(&devstatus
);
2383 if (devstatus
& (1 << USB_DEVICE_REMOTE_WAKEUP
)) {
2384 status
= usb_control_msg(udev
,
2385 usb_sndctrlpipe(udev
, 0),
2386 USB_REQ_CLEAR_FEATURE
,
2388 USB_DEVICE_REMOTE_WAKEUP
, 0,
2390 USB_CTRL_SET_TIMEOUT
);
2393 "disable remote wakeup, status %d\n",
2402 * usb_port_resume - re-activate a suspended usb device's upstream port
2403 * @udev: device to re-activate, not a root hub
2404 * Context: must be able to sleep; device not locked; pm locks held
2406 * This will re-activate the suspended device, increasing power usage
2407 * while letting drivers communicate again with its endpoints.
2408 * USB resume explicitly guarantees that the power session between
2409 * the host and the device is the same as it was when the device
2412 * If @udev->reset_resume is set then this routine won't check that the
2413 * port is still enabled. Furthermore, finish_port_resume() above will
2414 * reset @udev. The end result is that a broken power session can be
2415 * recovered and @udev will appear to persist across a loss of VBUS power.
2417 * For example, if a host controller doesn't maintain VBUS suspend current
2418 * during a system sleep or is reset when the system wakes up, all the USB
2419 * power sessions below it will be broken. This is especially troublesome
2420 * for mass-storage devices containing mounted filesystems, since the
2421 * device will appear to have disconnected and all the memory mappings
2422 * to it will be lost. Using the USB_PERSIST facility, the device can be
2423 * made to appear as if it had not disconnected.
2425 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
2426 * every effort to insure that the same device is present after the
2427 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
2428 * quite possible for a device to remain unaltered but its media to be
2429 * changed. If the user replaces a flash memory card while the system is
2430 * asleep, he will have only himself to blame when the filesystem on the
2431 * new card is corrupted and the system crashes.
2433 * Returns 0 on success, else negative errno.
2435 int usb_port_resume(struct usb_device
*udev
, pm_message_t msg
)
2437 struct usb_hub
*hub
= hdev_to_hub(udev
->parent
);
2438 int port1
= udev
->portnum
;
2440 u16 portchange
, portstatus
;
2442 /* Skip the initial Clear-Suspend step for a remote wakeup */
2443 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
2444 if (status
== 0 && !(portstatus
& USB_PORT_STAT_SUSPEND
))
2445 goto SuspendCleared
;
2447 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
2449 set_bit(port1
, hub
->busy_bits
);
2451 /* see 7.1.7.7; affects power usage, but not budgeting */
2452 status
= clear_port_feature(hub
->hdev
,
2453 port1
, USB_PORT_FEAT_SUSPEND
);
2455 dev_dbg(hub
->intfdev
, "can't resume port %d, status %d\n",
2458 /* drive resume for at least 20 msec */
2459 dev_dbg(&udev
->dev
, "usb %sresume\n",
2460 (msg
.event
& PM_EVENT_AUTO
? "auto-" : ""));
2463 /* Virtual root hubs can trigger on GET_PORT_STATUS to
2464 * stop resume signaling. Then finish the resume
2467 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
2469 /* TRSMRCY = 10 msec */
2475 if (portchange
& USB_PORT_STAT_C_SUSPEND
)
2476 clear_port_feature(hub
->hdev
, port1
,
2477 USB_PORT_FEAT_C_SUSPEND
);
2480 clear_bit(port1
, hub
->busy_bits
);
2482 status
= check_port_resume_type(udev
,
2483 hub
, port1
, status
, portchange
, portstatus
);
2485 status
= finish_port_resume(udev
);
2487 dev_dbg(&udev
->dev
, "can't resume, status %d\n", status
);
2488 hub_port_logical_disconnect(hub
, port1
);
2493 /* caller has locked udev */
2494 int usb_remote_wakeup(struct usb_device
*udev
)
2498 if (udev
->state
== USB_STATE_SUSPENDED
) {
2499 dev_dbg(&udev
->dev
, "usb %sresume\n", "wakeup-");
2500 status
= usb_autoresume_device(udev
);
2502 /* Let the drivers do their thing, then... */
2503 usb_autosuspend_device(udev
);
2509 #else /* CONFIG_USB_SUSPEND */
2511 /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
2513 int usb_port_suspend(struct usb_device
*udev
, pm_message_t msg
)
2518 /* However we may need to do a reset-resume */
2520 int usb_port_resume(struct usb_device
*udev
, pm_message_t msg
)
2522 struct usb_hub
*hub
= hdev_to_hub(udev
->parent
);
2523 int port1
= udev
->portnum
;
2525 u16 portchange
, portstatus
;
2527 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
2528 status
= check_port_resume_type(udev
,
2529 hub
, port1
, status
, portchange
, portstatus
);
2532 dev_dbg(&udev
->dev
, "can't resume, status %d\n", status
);
2533 hub_port_logical_disconnect(hub
, port1
);
2534 } else if (udev
->reset_resume
) {
2535 dev_dbg(&udev
->dev
, "reset-resume\n");
2536 status
= usb_reset_and_verify_device(udev
);
2543 static int hub_suspend(struct usb_interface
*intf
, pm_message_t msg
)
2545 struct usb_hub
*hub
= usb_get_intfdata (intf
);
2546 struct usb_device
*hdev
= hub
->hdev
;
2549 /* fail if children aren't already suspended */
2550 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
2551 struct usb_device
*udev
;
2553 udev
= hdev
->children
[port1
-1];
2554 if (udev
&& udev
->can_submit
) {
2555 if (!(msg
.event
& PM_EVENT_AUTO
))
2556 dev_dbg(&intf
->dev
, "port %d nyet suspended\n",
2562 dev_dbg(&intf
->dev
, "%s\n", __func__
);
2564 /* stop khubd and related activity */
2565 hub_quiesce(hub
, HUB_SUSPEND
);
2569 static int hub_resume(struct usb_interface
*intf
)
2571 struct usb_hub
*hub
= usb_get_intfdata(intf
);
2573 dev_dbg(&intf
->dev
, "%s\n", __func__
);
2574 hub_activate(hub
, HUB_RESUME
);
2578 static int hub_reset_resume(struct usb_interface
*intf
)
2580 struct usb_hub
*hub
= usb_get_intfdata(intf
);
2582 dev_dbg(&intf
->dev
, "%s\n", __func__
);
2583 hub_activate(hub
, HUB_RESET_RESUME
);
2588 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
2589 * @rhdev: struct usb_device for the root hub
2591 * The USB host controller driver calls this function when its root hub
2592 * is resumed and Vbus power has been interrupted or the controller
2593 * has been reset. The routine marks @rhdev as having lost power.
2594 * When the hub driver is resumed it will take notice and carry out
2595 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
2596 * the others will be disconnected.
2598 void usb_root_hub_lost_power(struct usb_device
*rhdev
)
2600 dev_warn(&rhdev
->dev
, "root hub lost power or was reset\n");
2601 rhdev
->reset_resume
= 1;
2603 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power
);
2605 #else /* CONFIG_PM */
2607 #define hub_suspend NULL
2608 #define hub_resume NULL
2609 #define hub_reset_resume NULL
2613 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2615 * Between connect detection and reset signaling there must be a delay
2616 * of 100ms at least for debounce and power-settling. The corresponding
2617 * timer shall restart whenever the downstream port detects a disconnect.
2619 * Apparently there are some bluetooth and irda-dongles and a number of
2620 * low-speed devices for which this debounce period may last over a second.
2621 * Not covered by the spec - but easy to deal with.
2623 * This implementation uses a 1500ms total debounce timeout; if the
2624 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2625 * every 25ms for transient disconnects. When the port status has been
2626 * unchanged for 100ms it returns the port status.
2628 static int hub_port_debounce(struct usb_hub
*hub
, int port1
)
2631 int total_time
, stable_time
= 0;
2632 u16 portchange
, portstatus
;
2633 unsigned connection
= 0xffff;
2635 for (total_time
= 0; ; total_time
+= HUB_DEBOUNCE_STEP
) {
2636 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
2640 if (!(portchange
& USB_PORT_STAT_C_CONNECTION
) &&
2641 (portstatus
& USB_PORT_STAT_CONNECTION
) == connection
) {
2642 stable_time
+= HUB_DEBOUNCE_STEP
;
2643 if (stable_time
>= HUB_DEBOUNCE_STABLE
)
2647 connection
= portstatus
& USB_PORT_STAT_CONNECTION
;
2650 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
2651 clear_port_feature(hub
->hdev
, port1
,
2652 USB_PORT_FEAT_C_CONNECTION
);
2655 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
2657 msleep(HUB_DEBOUNCE_STEP
);
2660 dev_dbg (hub
->intfdev
,
2661 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2662 port1
, total_time
, stable_time
, portstatus
);
2664 if (stable_time
< HUB_DEBOUNCE_STABLE
)
2669 void usb_ep0_reinit(struct usb_device
*udev
)
2671 usb_disable_endpoint(udev
, 0 + USB_DIR_IN
, true);
2672 usb_disable_endpoint(udev
, 0 + USB_DIR_OUT
, true);
2673 usb_enable_endpoint(udev
, &udev
->ep0
, true);
2675 EXPORT_SYMBOL_GPL(usb_ep0_reinit
);
2677 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2678 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2680 static int hub_set_address(struct usb_device
*udev
, int devnum
)
2683 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2686 * The host controller will choose the device address,
2687 * instead of the core having chosen it earlier
2689 if (!hcd
->driver
->address_device
&& devnum
<= 1)
2691 if (udev
->state
== USB_STATE_ADDRESS
)
2693 if (udev
->state
!= USB_STATE_DEFAULT
)
2695 if (hcd
->driver
->address_device
)
2696 retval
= hcd
->driver
->address_device(hcd
, udev
);
2698 retval
= usb_control_msg(udev
, usb_sndaddr0pipe(),
2699 USB_REQ_SET_ADDRESS
, 0, devnum
, 0,
2700 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
2702 update_devnum(udev
, devnum
);
2703 /* Device now using proper address. */
2704 usb_set_device_state(udev
, USB_STATE_ADDRESS
);
2705 usb_ep0_reinit(udev
);
2710 /* Reset device, (re)assign address, get device descriptor.
2711 * Device connection must be stable, no more debouncing needed.
2712 * Returns device in USB_STATE_ADDRESS, except on error.
2714 * If this is called for an already-existing device (as part of
2715 * usb_reset_and_verify_device), the caller must own the device lock. For a
2716 * newly detected device that is not accessible through any global
2717 * pointers, it's not necessary to lock the device.
2720 hub_port_init (struct usb_hub
*hub
, struct usb_device
*udev
, int port1
,
2723 static DEFINE_MUTEX(usb_address0_mutex
);
2725 struct usb_device
*hdev
= hub
->hdev
;
2726 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
2728 unsigned delay
= HUB_SHORT_RESET_TIME
;
2729 enum usb_device_speed oldspeed
= udev
->speed
;
2731 int devnum
= udev
->devnum
;
2733 /* root hub ports have a slightly longer reset period
2734 * (from USB 2.0 spec, section 7.1.7.5)
2736 if (!hdev
->parent
) {
2737 delay
= HUB_ROOT_RESET_TIME
;
2738 if (port1
== hdev
->bus
->otg_port
)
2739 hdev
->bus
->b_hnp_enable
= 0;
2742 /* Some low speed devices have problems with the quick delay, so */
2743 /* be a bit pessimistic with those devices. RHbug #23670 */
2744 if (oldspeed
== USB_SPEED_LOW
)
2745 delay
= HUB_LONG_RESET_TIME
;
2747 mutex_lock(&usb_address0_mutex
);
2749 /* Reset the device; full speed may morph to high speed */
2750 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
2751 retval
= hub_port_reset(hub
, port1
, udev
, delay
);
2752 if (retval
< 0) /* error or disconnect */
2754 /* success, speed is known */
2758 if (oldspeed
!= USB_SPEED_UNKNOWN
&& oldspeed
!= udev
->speed
) {
2759 dev_dbg(&udev
->dev
, "device reset changed speed!\n");
2762 oldspeed
= udev
->speed
;
2764 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2765 * it's fixed size except for full speed devices.
2766 * For Wireless USB devices, ep0 max packet is always 512 (tho
2767 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
2769 switch (udev
->speed
) {
2770 case USB_SPEED_SUPER
:
2771 case USB_SPEED_WIRELESS
: /* fixed at 512 */
2772 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(512);
2774 case USB_SPEED_HIGH
: /* fixed at 64 */
2775 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(64);
2777 case USB_SPEED_FULL
: /* 8, 16, 32, or 64 */
2778 /* to determine the ep0 maxpacket size, try to read
2779 * the device descriptor to get bMaxPacketSize0 and
2780 * then correct our initial guess.
2782 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(64);
2784 case USB_SPEED_LOW
: /* fixed at 8 */
2785 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(8);
2792 switch (udev
->speed
) {
2793 case USB_SPEED_LOW
: speed
= "low"; break;
2794 case USB_SPEED_FULL
: speed
= "full"; break;
2795 case USB_SPEED_HIGH
: speed
= "high"; break;
2796 case USB_SPEED_SUPER
:
2799 case USB_SPEED_WIRELESS
:
2803 default: speed
= "?"; break;
2805 if (udev
->speed
!= USB_SPEED_SUPER
)
2806 dev_info(&udev
->dev
,
2807 "%s %s speed %sUSB device number %d using %s\n",
2808 (udev
->config
) ? "reset" : "new", speed
, type
,
2809 devnum
, udev
->bus
->controller
->driver
->name
);
2811 /* Set up TT records, if needed */
2813 udev
->tt
= hdev
->tt
;
2814 udev
->ttport
= hdev
->ttport
;
2815 } else if (udev
->speed
!= USB_SPEED_HIGH
2816 && hdev
->speed
== USB_SPEED_HIGH
) {
2818 dev_err(&udev
->dev
, "parent hub has no TT\n");
2822 udev
->tt
= &hub
->tt
;
2823 udev
->ttport
= port1
;
2826 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2827 * Because device hardware and firmware is sometimes buggy in
2828 * this area, and this is how Linux has done it for ages.
2829 * Change it cautiously.
2831 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2832 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2833 * so it may help with some non-standards-compliant devices.
2834 * Otherwise we start with SET_ADDRESS and then try to read the
2835 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2838 for (i
= 0; i
< GET_DESCRIPTOR_TRIES
; (++i
, msleep(100))) {
2839 if (USE_NEW_SCHEME(retry_counter
) && !(hcd
->driver
->flags
& HCD_USB3
)) {
2840 struct usb_device_descriptor
*buf
;
2843 #define GET_DESCRIPTOR_BUFSIZE 64
2844 buf
= kmalloc(GET_DESCRIPTOR_BUFSIZE
, GFP_NOIO
);
2850 /* Retry on all errors; some devices are flakey.
2851 * 255 is for WUSB devices, we actually need to use
2852 * 512 (WUSB1.0[4.8.1]).
2854 for (j
= 0; j
< 3; ++j
) {
2855 buf
->bMaxPacketSize0
= 0;
2856 r
= usb_control_msg(udev
, usb_rcvaddr0pipe(),
2857 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
,
2858 USB_DT_DEVICE
<< 8, 0,
2859 buf
, GET_DESCRIPTOR_BUFSIZE
,
2860 initial_descriptor_timeout
);
2861 switch (buf
->bMaxPacketSize0
) {
2862 case 8: case 16: case 32: case 64: case 255:
2863 if (buf
->bDescriptorType
==
2877 udev
->descriptor
.bMaxPacketSize0
=
2878 buf
->bMaxPacketSize0
;
2881 retval
= hub_port_reset(hub
, port1
, udev
, delay
);
2882 if (retval
< 0) /* error or disconnect */
2884 if (oldspeed
!= udev
->speed
) {
2886 "device reset changed speed!\n");
2892 "device descriptor read/64, error %d\n",
2897 #undef GET_DESCRIPTOR_BUFSIZE
2901 * If device is WUSB, we already assigned an
2902 * unauthorized address in the Connect Ack sequence;
2903 * authorization will assign the final address.
2905 if (udev
->wusb
== 0) {
2906 for (j
= 0; j
< SET_ADDRESS_TRIES
; ++j
) {
2907 retval
= hub_set_address(udev
, devnum
);
2914 "device not accepting address %d, error %d\n",
2918 if (udev
->speed
== USB_SPEED_SUPER
) {
2919 devnum
= udev
->devnum
;
2920 dev_info(&udev
->dev
,
2921 "%s SuperSpeed USB device number %d using %s\n",
2922 (udev
->config
) ? "reset" : "new",
2923 devnum
, udev
->bus
->controller
->driver
->name
);
2926 /* cope with hardware quirkiness:
2927 * - let SET_ADDRESS settle, some device hardware wants it
2928 * - read ep0 maxpacket even for high and low speed,
2931 if (USE_NEW_SCHEME(retry_counter
) && !(hcd
->driver
->flags
& HCD_USB3
))
2935 retval
= usb_get_device_descriptor(udev
, 8);
2938 "device descriptor read/8, error %d\n",
2950 if (udev
->descriptor
.bMaxPacketSize0
== 0xff ||
2951 udev
->speed
== USB_SPEED_SUPER
)
2954 i
= udev
->descriptor
.bMaxPacketSize0
;
2955 if (le16_to_cpu(udev
->ep0
.desc
.wMaxPacketSize
) != i
) {
2956 if (udev
->speed
== USB_SPEED_LOW
||
2957 !(i
== 8 || i
== 16 || i
== 32 || i
== 64)) {
2958 dev_err(&udev
->dev
, "Invalid ep0 maxpacket: %d\n", i
);
2962 if (udev
->speed
== USB_SPEED_FULL
)
2963 dev_dbg(&udev
->dev
, "ep0 maxpacket = %d\n", i
);
2965 dev_warn(&udev
->dev
, "Using ep0 maxpacket: %d\n", i
);
2966 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(i
);
2967 usb_ep0_reinit(udev
);
2970 retval
= usb_get_device_descriptor(udev
, USB_DT_DEVICE_SIZE
);
2971 if (retval
< (signed)sizeof(udev
->descriptor
)) {
2972 dev_err(&udev
->dev
, "device descriptor read/all, error %d\n",
2980 /* notify HCD that we have a device connected and addressed */
2981 if (hcd
->driver
->update_device
)
2982 hcd
->driver
->update_device(hcd
, udev
);
2985 hub_port_disable(hub
, port1
, 0);
2986 update_devnum(udev
, devnum
); /* for disconnect processing */
2988 mutex_unlock(&usb_address0_mutex
);
2993 check_highspeed (struct usb_hub
*hub
, struct usb_device
*udev
, int port1
)
2995 struct usb_qualifier_descriptor
*qual
;
2998 qual
= kmalloc (sizeof *qual
, GFP_KERNEL
);
3002 status
= usb_get_descriptor (udev
, USB_DT_DEVICE_QUALIFIER
, 0,
3003 qual
, sizeof *qual
);
3004 if (status
== sizeof *qual
) {
3005 dev_info(&udev
->dev
, "not running at top speed; "
3006 "connect to a high speed hub\n");
3007 /* hub LEDs are probably harder to miss than syslog */
3008 if (hub
->has_indicators
) {
3009 hub
->indicator
[port1
-1] = INDICATOR_GREEN_BLINK
;
3010 schedule_delayed_work (&hub
->leds
, 0);
3017 hub_power_remaining (struct usb_hub
*hub
)
3019 struct usb_device
*hdev
= hub
->hdev
;
3023 if (!hub
->limited_power
)
3026 remaining
= hdev
->bus_mA
- hub
->descriptor
->bHubContrCurrent
;
3027 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
3028 struct usb_device
*udev
= hdev
->children
[port1
- 1];
3034 /* Unconfigured devices may not use more than 100mA,
3035 * or 8mA for OTG ports */
3036 if (udev
->actconfig
)
3037 delta
= udev
->actconfig
->desc
.bMaxPower
* 2;
3038 else if (port1
!= udev
->bus
->otg_port
|| hdev
->parent
)
3042 if (delta
> hub
->mA_per_port
)
3043 dev_warn(&udev
->dev
,
3044 "%dmA is over %umA budget for port %d!\n",
3045 delta
, hub
->mA_per_port
, port1
);
3048 if (remaining
< 0) {
3049 dev_warn(hub
->intfdev
, "%dmA over power budget!\n",
3056 /* Handle physical or logical connection change events.
3057 * This routine is called when:
3058 * a port connection-change occurs;
3059 * a port enable-change occurs (often caused by EMI);
3060 * usb_reset_and_verify_device() encounters changed descriptors (as from
3061 * a firmware download)
3062 * caller already locked the hub
3064 static void hub_port_connect_change(struct usb_hub
*hub
, int port1
,
3065 u16 portstatus
, u16 portchange
)
3067 struct usb_device
*hdev
= hub
->hdev
;
3068 struct device
*hub_dev
= hub
->intfdev
;
3069 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
3070 unsigned wHubCharacteristics
=
3071 le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
3072 struct usb_device
*udev
;
3076 "port %d, status %04x, change %04x, %s\n",
3077 port1
, portstatus
, portchange
, portspeed(hub
, portstatus
));
3079 if (hub
->has_indicators
) {
3080 set_port_led(hub
, port1
, HUB_LED_AUTO
);
3081 hub
->indicator
[port1
-1] = INDICATOR_AUTO
;
3084 #ifdef CONFIG_USB_OTG
3085 /* during HNP, don't repeat the debounce */
3086 if (hdev
->bus
->is_b_host
)
3087 portchange
&= ~(USB_PORT_STAT_C_CONNECTION
|
3088 USB_PORT_STAT_C_ENABLE
);
3091 /* Try to resuscitate an existing device */
3092 udev
= hdev
->children
[port1
-1];
3093 if ((portstatus
& USB_PORT_STAT_CONNECTION
) && udev
&&
3094 udev
->state
!= USB_STATE_NOTATTACHED
) {
3095 usb_lock_device(udev
);
3096 if (portstatus
& USB_PORT_STAT_ENABLE
) {
3097 status
= 0; /* Nothing to do */
3099 #ifdef CONFIG_USB_SUSPEND
3100 } else if (udev
->state
== USB_STATE_SUSPENDED
&&
3101 udev
->persist_enabled
) {
3102 /* For a suspended device, treat this as a
3103 * remote wakeup event.
3105 status
= usb_remote_wakeup(udev
);
3109 status
= -ENODEV
; /* Don't resuscitate */
3111 usb_unlock_device(udev
);
3114 clear_bit(port1
, hub
->change_bits
);
3119 /* Disconnect any existing devices under this port */
3121 usb_disconnect(&hdev
->children
[port1
-1]);
3122 clear_bit(port1
, hub
->change_bits
);
3124 /* We can forget about a "removed" device when there's a physical
3125 * disconnect or the connect status changes.
3127 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
3128 (portchange
& USB_PORT_STAT_C_CONNECTION
))
3129 clear_bit(port1
, hub
->removed_bits
);
3131 if (portchange
& (USB_PORT_STAT_C_CONNECTION
|
3132 USB_PORT_STAT_C_ENABLE
)) {
3133 status
= hub_port_debounce(hub
, port1
);
3135 if (printk_ratelimit())
3136 dev_err(hub_dev
, "connect-debounce failed, "
3137 "port %d disabled\n", port1
);
3138 portstatus
&= ~USB_PORT_STAT_CONNECTION
;
3140 portstatus
= status
;
3144 /* Return now if debouncing failed or nothing is connected or
3145 * the device was "removed".
3147 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
3148 test_bit(port1
, hub
->removed_bits
)) {
3150 /* maybe switch power back on (e.g. root hub was reset) */
3151 if ((wHubCharacteristics
& HUB_CHAR_LPSM
) < 2
3152 && !(portstatus
& USB_PORT_STAT_POWER
))
3153 set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
3155 if (portstatus
& USB_PORT_STAT_ENABLE
)
3160 for (i
= 0; i
< SET_CONFIG_TRIES
; i
++) {
3162 /* reallocate for each attempt, since references
3163 * to the previous one can escape in various ways
3165 udev
= usb_alloc_dev(hdev
, hdev
->bus
, port1
);
3168 "couldn't allocate port %d usb_device\n",
3173 usb_set_device_state(udev
, USB_STATE_POWERED
);
3174 udev
->bus_mA
= hub
->mA_per_port
;
3175 udev
->level
= hdev
->level
+ 1;
3176 udev
->wusb
= hub_is_wusb(hub
);
3178 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
3179 if (hub_is_superspeed(hub
->hdev
))
3180 udev
->speed
= USB_SPEED_SUPER
;
3182 udev
->speed
= USB_SPEED_UNKNOWN
;
3184 choose_devnum(udev
);
3185 if (udev
->devnum
<= 0) {
3186 status
= -ENOTCONN
; /* Don't retry */
3190 /* reset (non-USB 3.0 devices) and get descriptor */
3191 status
= hub_port_init(hub
, udev
, port1
, i
);
3195 usb_detect_quirks(udev
);
3196 if (udev
->quirks
& USB_QUIRK_DELAY_INIT
)
3199 /* consecutive bus-powered hubs aren't reliable; they can
3200 * violate the voltage drop budget. if the new child has
3201 * a "powered" LED, users should notice we didn't enable it
3202 * (without reading syslog), even without per-port LEDs
3205 if (udev
->descriptor
.bDeviceClass
== USB_CLASS_HUB
3206 && udev
->bus_mA
<= 100) {
3209 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0,
3212 dev_dbg(&udev
->dev
, "get status %d ?\n", status
);
3215 le16_to_cpus(&devstat
);
3216 if ((devstat
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
3218 "can't connect bus-powered hub "
3220 if (hub
->has_indicators
) {
3221 hub
->indicator
[port1
-1] =
3222 INDICATOR_AMBER_BLINK
;
3223 schedule_delayed_work (&hub
->leds
, 0);
3225 status
= -ENOTCONN
; /* Don't retry */
3230 /* check for devices running slower than they could */
3231 if (le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0200
3232 && udev
->speed
== USB_SPEED_FULL
3233 && highspeed_hubs
!= 0)
3234 check_highspeed (hub
, udev
, port1
);
3236 /* Store the parent's children[] pointer. At this point
3237 * udev becomes globally accessible, although presumably
3238 * no one will look at it until hdev is unlocked.
3242 /* We mustn't add new devices if the parent hub has
3243 * been disconnected; we would race with the
3244 * recursively_mark_NOTATTACHED() routine.
3246 spin_lock_irq(&device_state_lock
);
3247 if (hdev
->state
== USB_STATE_NOTATTACHED
)
3250 hdev
->children
[port1
-1] = udev
;
3251 spin_unlock_irq(&device_state_lock
);
3253 /* Run it through the hoops (find a driver, etc) */
3255 status
= usb_new_device(udev
);
3257 spin_lock_irq(&device_state_lock
);
3258 hdev
->children
[port1
-1] = NULL
;
3259 spin_unlock_irq(&device_state_lock
);
3266 status
= hub_power_remaining(hub
);
3268 dev_dbg(hub_dev
, "%dmA power budget left\n", status
);
3273 hub_port_disable(hub
, port1
, 1);
3275 usb_ep0_reinit(udev
);
3276 release_devnum(udev
);
3279 if ((status
== -ENOTCONN
) || (status
== -ENOTSUPP
))
3282 if (hub
->hdev
->parent
||
3283 !hcd
->driver
->port_handed_over
||
3284 !(hcd
->driver
->port_handed_over
)(hcd
, port1
))
3285 dev_err(hub_dev
, "unable to enumerate USB device on port %d\n",
3289 hub_port_disable(hub
, port1
, 1);
3290 if (hcd
->driver
->relinquish_port
&& !hub
->hdev
->parent
)
3291 hcd
->driver
->relinquish_port(hcd
, port1
);
3294 static void hub_events(void)
3296 struct list_head
*tmp
;
3297 struct usb_device
*hdev
;
3298 struct usb_interface
*intf
;
3299 struct usb_hub
*hub
;
3300 struct device
*hub_dev
;
3309 * We restart the list every time to avoid a deadlock with
3310 * deleting hubs downstream from this one. This should be
3311 * safe since we delete the hub from the event list.
3312 * Not the most efficient, but avoids deadlocks.
3316 /* Grab the first entry at the beginning of the list */
3317 spin_lock_irq(&hub_event_lock
);
3318 if (list_empty(&hub_event_list
)) {
3319 spin_unlock_irq(&hub_event_lock
);
3323 tmp
= hub_event_list
.next
;
3326 hub
= list_entry(tmp
, struct usb_hub
, event_list
);
3327 kref_get(&hub
->kref
);
3328 spin_unlock_irq(&hub_event_lock
);
3331 hub_dev
= hub
->intfdev
;
3332 intf
= to_usb_interface(hub_dev
);
3333 dev_dbg(hub_dev
, "state %d ports %d chg %04x evt %04x\n",
3334 hdev
->state
, hub
->descriptor
3335 ? hub
->descriptor
->bNbrPorts
3337 /* NOTE: expects max 15 ports... */
3338 (u16
) hub
->change_bits
[0],
3339 (u16
) hub
->event_bits
[0]);
3341 /* Lock the device, then check to see if we were
3342 * disconnected while waiting for the lock to succeed. */
3343 usb_lock_device(hdev
);
3344 if (unlikely(hub
->disconnected
))
3345 goto loop_disconnected
;
3347 /* If the hub has died, clean up after it */
3348 if (hdev
->state
== USB_STATE_NOTATTACHED
) {
3349 hub
->error
= -ENODEV
;
3350 hub_quiesce(hub
, HUB_DISCONNECT
);
3355 ret
= usb_autopm_get_interface(intf
);
3357 dev_dbg(hub_dev
, "Can't autoresume: %d\n", ret
);
3361 /* If this is an inactive hub, do nothing */
3366 dev_dbg (hub_dev
, "resetting for error %d\n",
3369 ret
= usb_reset_device(hdev
);
3372 "error resetting hub: %d\n", ret
);
3380 /* deal with port status changes */
3381 for (i
= 1; i
<= hub
->descriptor
->bNbrPorts
; i
++) {
3382 if (test_bit(i
, hub
->busy_bits
))
3384 connect_change
= test_bit(i
, hub
->change_bits
);
3385 if (!test_and_clear_bit(i
, hub
->event_bits
) &&
3389 ret
= hub_port_status(hub
, i
,
3390 &portstatus
, &portchange
);
3394 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
3395 clear_port_feature(hdev
, i
,
3396 USB_PORT_FEAT_C_CONNECTION
);
3400 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
3401 if (!connect_change
)
3403 "port %d enable change, "
3406 clear_port_feature(hdev
, i
,
3407 USB_PORT_FEAT_C_ENABLE
);
3410 * EM interference sometimes causes badly
3411 * shielded USB devices to be shutdown by
3412 * the hub, this hack enables them again.
3413 * Works at least with mouse driver.
3415 if (!(portstatus
& USB_PORT_STAT_ENABLE
)
3417 && hdev
->children
[i
-1]) {
3420 "disabled by hub (EMI?), "
3427 if (portchange
& USB_PORT_STAT_C_SUSPEND
) {
3428 struct usb_device
*udev
;
3430 clear_port_feature(hdev
, i
,
3431 USB_PORT_FEAT_C_SUSPEND
);
3432 udev
= hdev
->children
[i
-1];
3434 /* TRSMRCY = 10 msec */
3437 usb_lock_device(udev
);
3438 ret
= usb_remote_wakeup(hdev
->
3440 usb_unlock_device(udev
);
3445 hub_port_disable(hub
, i
, 1);
3448 "resume on port %d, status %d\n",
3452 if (portchange
& USB_PORT_STAT_C_OVERCURRENT
) {
3456 dev_dbg(hub_dev
, "over-current change on port "
3458 clear_port_feature(hdev
, i
,
3459 USB_PORT_FEAT_C_OVER_CURRENT
);
3460 msleep(100); /* Cool down */
3461 hub_power_on(hub
, true);
3462 hub_port_status(hub
, i
, &status
, &unused
);
3463 if (status
& USB_PORT_STAT_OVERCURRENT
)
3464 dev_err(hub_dev
, "over-current "
3465 "condition on port %d\n", i
);
3468 if (portchange
& USB_PORT_STAT_C_RESET
) {
3470 "reset change on port %d\n",
3472 clear_port_feature(hdev
, i
,
3473 USB_PORT_FEAT_C_RESET
);
3475 if ((portchange
& USB_PORT_STAT_C_BH_RESET
) &&
3476 hub_is_superspeed(hub
->hdev
)) {
3478 "warm reset change on port %d\n",
3480 clear_port_feature(hdev
, i
,
3481 USB_PORT_FEAT_C_BH_PORT_RESET
);
3483 if (portchange
& USB_PORT_STAT_C_LINK_STATE
) {
3484 clear_port_feature(hub
->hdev
, i
,
3485 USB_PORT_FEAT_C_PORT_LINK_STATE
);
3487 if (portchange
& USB_PORT_STAT_C_CONFIG_ERROR
) {
3489 "config error on port %d\n",
3491 clear_port_feature(hub
->hdev
, i
,
3492 USB_PORT_FEAT_C_PORT_CONFIG_ERROR
);
3496 hub_port_connect_change(hub
, i
,
3497 portstatus
, portchange
);
3500 /* deal with hub status changes */
3501 if (test_and_clear_bit(0, hub
->event_bits
) == 0)
3503 else if (hub_hub_status(hub
, &hubstatus
, &hubchange
) < 0)
3504 dev_err (hub_dev
, "get_hub_status failed\n");
3506 if (hubchange
& HUB_CHANGE_LOCAL_POWER
) {
3507 dev_dbg (hub_dev
, "power change\n");
3508 clear_hub_feature(hdev
, C_HUB_LOCAL_POWER
);
3509 if (hubstatus
& HUB_STATUS_LOCAL_POWER
)
3510 /* FIXME: Is this always true? */
3511 hub
->limited_power
= 1;
3513 hub
->limited_power
= 0;
3515 if (hubchange
& HUB_CHANGE_OVERCURRENT
) {
3519 dev_dbg(hub_dev
, "over-current change\n");
3520 clear_hub_feature(hdev
, C_HUB_OVER_CURRENT
);
3521 msleep(500); /* Cool down */
3522 hub_power_on(hub
, true);
3523 hub_hub_status(hub
, &status
, &unused
);
3524 if (status
& HUB_STATUS_OVERCURRENT
)
3525 dev_err(hub_dev
, "over-current "
3531 /* Balance the usb_autopm_get_interface() above */
3532 usb_autopm_put_interface_no_suspend(intf
);
3534 /* Balance the usb_autopm_get_interface_no_resume() in
3535 * kick_khubd() and allow autosuspend.
3537 usb_autopm_put_interface(intf
);
3539 usb_unlock_device(hdev
);
3540 kref_put(&hub
->kref
, hub_release
);
3542 } /* end while (1) */
3545 static int hub_thread(void *__unused
)
3547 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
3548 * port handover. Otherwise it might see that a full-speed device
3549 * was gone before the EHCI controller had handed its port over to
3550 * the companion full-speed controller.
3556 wait_event_freezable(khubd_wait
,
3557 !list_empty(&hub_event_list
) ||
3558 kthread_should_stop());
3559 } while (!kthread_should_stop() || !list_empty(&hub_event_list
));
3561 pr_debug("%s: khubd exiting\n", usbcore_name
);
3565 static const struct usb_device_id hub_id_table
[] = {
3566 { .match_flags
= USB_DEVICE_ID_MATCH_DEV_CLASS
,
3567 .bDeviceClass
= USB_CLASS_HUB
},
3568 { .match_flags
= USB_DEVICE_ID_MATCH_INT_CLASS
,
3569 .bInterfaceClass
= USB_CLASS_HUB
},
3570 { } /* Terminating entry */
3573 MODULE_DEVICE_TABLE (usb
, hub_id_table
);
3575 static struct usb_driver hub_driver
= {
3578 .disconnect
= hub_disconnect
,
3579 .suspend
= hub_suspend
,
3580 .resume
= hub_resume
,
3581 .reset_resume
= hub_reset_resume
,
3582 .pre_reset
= hub_pre_reset
,
3583 .post_reset
= hub_post_reset
,
3584 .unlocked_ioctl
= hub_ioctl
,
3585 .id_table
= hub_id_table
,
3586 .supports_autosuspend
= 1,
3589 int usb_hub_init(void)
3591 if (usb_register(&hub_driver
) < 0) {
3592 printk(KERN_ERR
"%s: can't register hub driver\n",
3597 khubd_task
= kthread_run(hub_thread
, NULL
, "khubd");
3598 if (!IS_ERR(khubd_task
))
3601 /* Fall through if kernel_thread failed */
3602 usb_deregister(&hub_driver
);
3603 printk(KERN_ERR
"%s: can't start khubd\n", usbcore_name
);
3608 void usb_hub_cleanup(void)
3610 kthread_stop(khubd_task
);
3613 * Hub resources are freed for us by usb_deregister. It calls
3614 * usb_driver_purge on every device which in turn calls that
3615 * devices disconnect function if it is using this driver.
3616 * The hub_disconnect function takes care of releasing the
3617 * individual hub resources. -greg
3619 usb_deregister(&hub_driver
);
3620 } /* usb_hub_cleanup() */
3622 static int descriptors_changed(struct usb_device
*udev
,
3623 struct usb_device_descriptor
*old_device_descriptor
)
3627 unsigned serial_len
= 0;
3629 unsigned old_length
;
3633 if (memcmp(&udev
->descriptor
, old_device_descriptor
,
3634 sizeof(*old_device_descriptor
)) != 0)
3637 /* Since the idVendor, idProduct, and bcdDevice values in the
3638 * device descriptor haven't changed, we will assume the
3639 * Manufacturer and Product strings haven't changed either.
3640 * But the SerialNumber string could be different (e.g., a
3641 * different flash card of the same brand).
3644 serial_len
= strlen(udev
->serial
) + 1;
3647 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
3648 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
3649 len
= max(len
, old_length
);
3652 buf
= kmalloc(len
, GFP_NOIO
);
3654 dev_err(&udev
->dev
, "no mem to re-read configs after reset\n");
3655 /* assume the worst */
3658 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
3659 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
3660 length
= usb_get_descriptor(udev
, USB_DT_CONFIG
, index
, buf
,
3662 if (length
!= old_length
) {
3663 dev_dbg(&udev
->dev
, "config index %d, error %d\n",
3668 if (memcmp (buf
, udev
->rawdescriptors
[index
], old_length
)
3670 dev_dbg(&udev
->dev
, "config index %d changed (#%d)\n",
3672 ((struct usb_config_descriptor
*) buf
)->
3673 bConfigurationValue
);
3679 if (!changed
&& serial_len
) {
3680 length
= usb_string(udev
, udev
->descriptor
.iSerialNumber
,
3682 if (length
+ 1 != serial_len
) {
3683 dev_dbg(&udev
->dev
, "serial string error %d\n",
3686 } else if (memcmp(buf
, udev
->serial
, length
) != 0) {
3687 dev_dbg(&udev
->dev
, "serial string changed\n");
3697 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
3698 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3700 * WARNING - don't use this routine to reset a composite device
3701 * (one with multiple interfaces owned by separate drivers)!
3702 * Use usb_reset_device() instead.
3704 * Do a port reset, reassign the device's address, and establish its
3705 * former operating configuration. If the reset fails, or the device's
3706 * descriptors change from their values before the reset, or the original
3707 * configuration and altsettings cannot be restored, a flag will be set
3708 * telling khubd to pretend the device has been disconnected and then
3709 * re-connected. All drivers will be unbound, and the device will be
3710 * re-enumerated and probed all over again.
3712 * Returns 0 if the reset succeeded, -ENODEV if the device has been
3713 * flagged for logical disconnection, or some other negative error code
3714 * if the reset wasn't even attempted.
3716 * The caller must own the device lock. For example, it's safe to use
3717 * this from a driver probe() routine after downloading new firmware.
3718 * For calls that might not occur during probe(), drivers should lock
3719 * the device using usb_lock_device_for_reset().
3721 * Locking exception: This routine may also be called from within an
3722 * autoresume handler. Such usage won't conflict with other tasks
3723 * holding the device lock because these tasks should always call
3724 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
3726 static int usb_reset_and_verify_device(struct usb_device
*udev
)
3728 struct usb_device
*parent_hdev
= udev
->parent
;
3729 struct usb_hub
*parent_hub
;
3730 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3731 struct usb_device_descriptor descriptor
= udev
->descriptor
;
3733 int port1
= udev
->portnum
;
3735 if (udev
->state
== USB_STATE_NOTATTACHED
||
3736 udev
->state
== USB_STATE_SUSPENDED
) {
3737 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
3743 /* this requires hcd-specific logic; see ohci_restart() */
3744 dev_dbg(&udev
->dev
, "%s for root hub!\n", __func__
);
3747 parent_hub
= hdev_to_hub(parent_hdev
);
3749 set_bit(port1
, parent_hub
->busy_bits
);
3750 for (i
= 0; i
< SET_CONFIG_TRIES
; ++i
) {
3752 /* ep0 maxpacket size may change; let the HCD know about it.
3753 * Other endpoints will be handled by re-enumeration. */
3754 usb_ep0_reinit(udev
);
3755 ret
= hub_port_init(parent_hub
, udev
, port1
, i
);
3756 if (ret
>= 0 || ret
== -ENOTCONN
|| ret
== -ENODEV
)
3759 clear_bit(port1
, parent_hub
->busy_bits
);
3764 /* Device might have changed firmware (DFU or similar) */
3765 if (descriptors_changed(udev
, &descriptor
)) {
3766 dev_info(&udev
->dev
, "device firmware changed\n");
3767 udev
->descriptor
= descriptor
; /* for disconnect() calls */
3771 /* Restore the device's previous configuration */
3772 if (!udev
->actconfig
)
3775 mutex_lock(hcd
->bandwidth_mutex
);
3776 ret
= usb_hcd_alloc_bandwidth(udev
, udev
->actconfig
, NULL
, NULL
);
3778 dev_warn(&udev
->dev
,
3779 "Busted HC? Not enough HCD resources for "
3780 "old configuration.\n");
3781 mutex_unlock(hcd
->bandwidth_mutex
);
3784 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3785 USB_REQ_SET_CONFIGURATION
, 0,
3786 udev
->actconfig
->desc
.bConfigurationValue
, 0,
3787 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
3790 "can't restore configuration #%d (error=%d)\n",
3791 udev
->actconfig
->desc
.bConfigurationValue
, ret
);
3792 mutex_unlock(hcd
->bandwidth_mutex
);
3795 mutex_unlock(hcd
->bandwidth_mutex
);
3796 usb_set_device_state(udev
, USB_STATE_CONFIGURED
);
3798 /* Put interfaces back into the same altsettings as before.
3799 * Don't bother to send the Set-Interface request for interfaces
3800 * that were already in altsetting 0; besides being unnecessary,
3801 * many devices can't handle it. Instead just reset the host-side
3804 for (i
= 0; i
< udev
->actconfig
->desc
.bNumInterfaces
; i
++) {
3805 struct usb_host_config
*config
= udev
->actconfig
;
3806 struct usb_interface
*intf
= config
->interface
[i
];
3807 struct usb_interface_descriptor
*desc
;
3809 desc
= &intf
->cur_altsetting
->desc
;
3810 if (desc
->bAlternateSetting
== 0) {
3811 usb_disable_interface(udev
, intf
, true);
3812 usb_enable_interface(udev
, intf
, true);
3815 /* Let the bandwidth allocation function know that this
3816 * device has been reset, and it will have to use
3817 * alternate setting 0 as the current alternate setting.
3819 intf
->resetting_device
= 1;
3820 ret
= usb_set_interface(udev
, desc
->bInterfaceNumber
,
3821 desc
->bAlternateSetting
);
3822 intf
->resetting_device
= 0;
3825 dev_err(&udev
->dev
, "failed to restore interface %d "
3826 "altsetting %d (error=%d)\n",
3827 desc
->bInterfaceNumber
,
3828 desc
->bAlternateSetting
,
3838 hub_port_logical_disconnect(parent_hub
, port1
);
3843 * usb_reset_device - warn interface drivers and perform a USB port reset
3844 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3846 * Warns all drivers bound to registered interfaces (using their pre_reset
3847 * method), performs the port reset, and then lets the drivers know that
3848 * the reset is over (using their post_reset method).
3850 * Return value is the same as for usb_reset_and_verify_device().
3852 * The caller must own the device lock. For example, it's safe to use
3853 * this from a driver probe() routine after downloading new firmware.
3854 * For calls that might not occur during probe(), drivers should lock
3855 * the device using usb_lock_device_for_reset().
3857 * If an interface is currently being probed or disconnected, we assume
3858 * its driver knows how to handle resets. For all other interfaces,
3859 * if the driver doesn't have pre_reset and post_reset methods then
3860 * we attempt to unbind it and rebind afterward.
3862 int usb_reset_device(struct usb_device
*udev
)
3866 struct usb_host_config
*config
= udev
->actconfig
;
3868 if (udev
->state
== USB_STATE_NOTATTACHED
||
3869 udev
->state
== USB_STATE_SUSPENDED
) {
3870 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
3875 /* Prevent autosuspend during the reset */
3876 usb_autoresume_device(udev
);
3879 for (i
= 0; i
< config
->desc
.bNumInterfaces
; ++i
) {
3880 struct usb_interface
*cintf
= config
->interface
[i
];
3881 struct usb_driver
*drv
;
3884 if (cintf
->dev
.driver
) {
3885 drv
= to_usb_driver(cintf
->dev
.driver
);
3886 if (drv
->pre_reset
&& drv
->post_reset
)
3887 unbind
= (drv
->pre_reset
)(cintf
);
3888 else if (cintf
->condition
==
3889 USB_INTERFACE_BOUND
)
3892 usb_forced_unbind_intf(cintf
);
3897 ret
= usb_reset_and_verify_device(udev
);
3900 for (i
= config
->desc
.bNumInterfaces
- 1; i
>= 0; --i
) {
3901 struct usb_interface
*cintf
= config
->interface
[i
];
3902 struct usb_driver
*drv
;
3903 int rebind
= cintf
->needs_binding
;
3905 if (!rebind
&& cintf
->dev
.driver
) {
3906 drv
= to_usb_driver(cintf
->dev
.driver
);
3907 if (drv
->post_reset
)
3908 rebind
= (drv
->post_reset
)(cintf
);
3909 else if (cintf
->condition
==
3910 USB_INTERFACE_BOUND
)
3913 if (ret
== 0 && rebind
)
3914 usb_rebind_intf(cintf
);
3918 usb_autosuspend_device(udev
);
3921 EXPORT_SYMBOL_GPL(usb_reset_device
);
3925 * usb_queue_reset_device - Reset a USB device from an atomic context
3926 * @iface: USB interface belonging to the device to reset
3928 * This function can be used to reset a USB device from an atomic
3929 * context, where usb_reset_device() won't work (as it blocks).
3931 * Doing a reset via this method is functionally equivalent to calling
3932 * usb_reset_device(), except for the fact that it is delayed to a
3933 * workqueue. This means that any drivers bound to other interfaces
3934 * might be unbound, as well as users from usbfs in user space.
3938 * - Scheduling two resets at the same time from two different drivers
3939 * attached to two different interfaces of the same device is
3940 * possible; depending on how the driver attached to each interface
3941 * handles ->pre_reset(), the second reset might happen or not.
3943 * - If a driver is unbound and it had a pending reset, the reset will
3946 * - This function can be called during .probe() or .disconnect()
3947 * times. On return from .disconnect(), any pending resets will be
3950 * There is no no need to lock/unlock the @reset_ws as schedule_work()
3953 * NOTE: We don't do any reference count tracking because it is not
3954 * needed. The lifecycle of the work_struct is tied to the
3955 * usb_interface. Before destroying the interface we cancel the
3956 * work_struct, so the fact that work_struct is queued and or
3957 * running means the interface (and thus, the device) exist and
3960 void usb_queue_reset_device(struct usb_interface
*iface
)
3962 schedule_work(&iface
->reset_ws
);
3964 EXPORT_SYMBOL_GPL(usb_queue_reset_device
);