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/otg.h>
24 #include <linux/usb/quirks.h>
25 #include <linux/kthread.h>
26 #include <linux/mutex.h>
27 #include <linux/freezer.h>
28 #include <linux/random.h>
29 #include <linux/pm_qos.h>
31 #include <asm/uaccess.h>
32 #include <asm/byteorder.h>
36 #ifdef CONFIG_MTK_ICUSB_SUPPORT
37 int is_musbfsh_rh(struct usb_device
*udev
);
38 void set_icusb_sts_disconnect_done(void);
41 #ifdef CONFIG_MTK_DT_USB_SUPPORT
42 #include <linux/proc_fs.h>
43 #include <linux/uaccess.h>
44 static struct usb_device
*g_dsda_dev
= NULL
;
46 #ifdef CONFIG_PM_RUNTIME
47 struct usb_hub
*usb11_hub
= NULL
;
48 int is_musbfsh_rh(struct usb_device
*udev
);
50 struct usb_device
*get_usb11_child_udev(void)
54 return usb11_hub
->ports
[0]->child
;
62 void dump_data(char *buf
, int len
)
65 for(i
=0 ; i
< len
; i
++)
67 MYDBG("data[%d]: %x\n", i
, buf
[i
]);
71 void test_dsda_device_ep0(void)
76 ret
= usb_control_msg(g_dsda_dev
, usb_rcvctrlpipe(g_dsda_dev
, 0),
77 USB_REQ_GET_DESCRIPTOR
,
83 USB_CTRL_GET_TIMEOUT
);
88 MYDBG("test ep fail, ret : %d\n", ret
);
92 MYDBG("test ep0 ok, ret : %d\n", ret
);
93 dump_data(data_buf
, ret
);
98 void release_usb11_wakelock(void);
99 static ssize_t
dsda_tmp_proc_entry(struct file
*file_ptr
, const char __user
*user_buffer
, size_t count
, loff_t
*position
)
103 int ret
= copy_from_user((char *) &cmd
, user_buffer
, count
);
110 /* apply action here */
114 test_dsda_device_ep0();
119 release_usb11_wakelock();
127 struct file_operations dsda_tmp_proc_fops
= {
128 .write
= dsda_tmp_proc_entry
132 void create_dsda_tmp_entry(void)
134 struct proc_dir_entry
*prEntry
;
138 prEntry
= proc_create("DSDA_TMP_ENTRY", 0660, 0, &dsda_tmp_proc_fops
);
141 MYDBG("add /proc/DSDA_TMP_ENTRY ok\n");
145 MYDBG("add /proc/DSDA_TMP_ENTRY fail\n");
150 /* if we are in debug mode, always announce new devices */
152 #ifndef CONFIG_USB_ANNOUNCE_NEW_DEVICES
153 #define CONFIG_USB_ANNOUNCE_NEW_DEVICES
157 #define USB_VENDOR_GENESYS_LOGIC 0x05e3
158 #define HUB_QUIRK_CHECK_PORT_AUTOSUSPEND 0x01
160 #if defined(CONFIG_USBIF_COMPLIANCE) && defined(CONFIG_USB_XHCI_HCD)
161 extern int usbif_u3h_send_event(char* event
) ;
162 #include "otg_whitelist.h"
166 static inline int hub_is_superspeed(struct usb_device
*hdev
)
168 return (hdev
->descriptor
.bDeviceProtocol
== USB_HUB_PR_SS
);
171 /* Protect struct usb_device->state and ->children members
172 * Note: Both are also protected by ->dev.sem, except that ->state can
173 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
174 static DEFINE_SPINLOCK(device_state_lock
);
176 /* khubd's worklist and its lock */
177 static DEFINE_SPINLOCK(hub_event_lock
);
178 static LIST_HEAD(hub_event_list
); /* List of hubs needing servicing */
181 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait
);
183 static struct task_struct
*khubd_task
;
185 /* cycle leds on hubs that aren't blinking for attention */
186 static bool blinkenlights
= 0;
187 module_param (blinkenlights
, bool, S_IRUGO
);
188 MODULE_PARM_DESC (blinkenlights
, "true to cycle leds on hubs");
191 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
192 * 10 seconds to send reply for the initial 64-byte descriptor request.
194 /* define initial 64-byte descriptor request timeout in milliseconds */
195 static int initial_descriptor_timeout
= USB_CTRL_GET_TIMEOUT
;
196 module_param(initial_descriptor_timeout
, int, S_IRUGO
|S_IWUSR
);
197 MODULE_PARM_DESC(initial_descriptor_timeout
,
198 "initial 64-byte descriptor request timeout in milliseconds "
199 "(default 5000 - 5.0 seconds)");
202 * As of 2.6.10 we introduce a new USB device initialization scheme which
203 * closely resembles the way Windows works. Hopefully it will be compatible
204 * with a wider range of devices than the old scheme. However some previously
205 * working devices may start giving rise to "device not accepting address"
206 * errors; if that happens the user can try the old scheme by adjusting the
207 * following module parameters.
209 * For maximum flexibility there are two boolean parameters to control the
210 * hub driver's behavior. On the first initialization attempt, if the
211 * "old_scheme_first" parameter is set then the old scheme will be used,
212 * otherwise the new scheme is used. If that fails and "use_both_schemes"
213 * is set, then the driver will make another attempt, using the other scheme.
215 static bool old_scheme_first
= 0;
216 module_param(old_scheme_first
, bool, S_IRUGO
| S_IWUSR
);
217 MODULE_PARM_DESC(old_scheme_first
,
218 "start with the old device initialization scheme");
220 static bool use_both_schemes
= 1;
221 module_param(use_both_schemes
, bool, S_IRUGO
| S_IWUSR
);
222 MODULE_PARM_DESC(use_both_schemes
,
223 "try the other device initialization scheme if the "
226 /* Mutual exclusion for EHCI CF initialization. This interferes with
227 * port reset on some companion controllers.
229 DECLARE_RWSEM(ehci_cf_port_reset_rwsem
);
230 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem
);
232 #define HUB_DEBOUNCE_TIMEOUT 2000
233 #define HUB_DEBOUNCE_STEP 25
234 #define HUB_DEBOUNCE_STABLE 100
236 static void hub_release(struct kref
*kref
);
237 static int usb_reset_and_verify_device(struct usb_device
*udev
);
239 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
240 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
243 static inline char *portspeed(struct usb_hub
*hub
, int portstatus
)
245 if (hub_is_superspeed(hub
->hdev
))
247 if (portstatus
& USB_PORT_STAT_HIGH_SPEED
)
249 else if (portstatus
& USB_PORT_STAT_LOW_SPEED
)
255 /* Note that hdev or one of its children must be locked! */
256 struct usb_hub
*usb_hub_to_struct_hub(struct usb_device
*hdev
)
258 if (!hdev
|| !hdev
->actconfig
|| !hdev
->maxchild
)
260 return usb_get_intfdata(hdev
->actconfig
->interface
[0]);
263 static int usb_device_supports_lpm(struct usb_device
*udev
)
265 /* USB 2.1 (and greater) devices indicate LPM support through
266 * their USB 2.0 Extended Capabilities BOS descriptor.
268 if (udev
->speed
== USB_SPEED_HIGH
) {
269 if (udev
->bos
->ext_cap
&&
271 le32_to_cpu(udev
->bos
->ext_cap
->bmAttributes
)))
276 /* All USB 3.0 must support LPM, but we need their max exit latency
277 * information from the SuperSpeed Extended Capabilities BOS descriptor.
279 if (!udev
->bos
->ss_cap
) {
280 dev_warn(&udev
->dev
, "No LPM exit latency info found. "
281 "Power management will be impacted.\n");
284 if (udev
->parent
->lpm_capable
)
287 dev_warn(&udev
->dev
, "Parent hub missing LPM exit latency info. "
288 "Power management will be impacted.\n");
293 * Set the Maximum Exit Latency (MEL) for the host to initiate a transition from
296 static void usb_set_lpm_mel(struct usb_device
*udev
,
297 struct usb3_lpm_parameters
*udev_lpm_params
,
298 unsigned int udev_exit_latency
,
300 struct usb3_lpm_parameters
*hub_lpm_params
,
301 unsigned int hub_exit_latency
)
303 unsigned int total_mel
;
304 unsigned int device_mel
;
305 unsigned int hub_mel
;
308 * Calculate the time it takes to transition all links from the roothub
309 * to the parent hub into U0. The parent hub must then decode the
310 * packet (hub header decode latency) to figure out which port it was
313 * The Hub Header decode latency is expressed in 0.1us intervals (0x1
314 * means 0.1us). Multiply that by 100 to get nanoseconds.
316 total_mel
= hub_lpm_params
->mel
+
317 (hub
->descriptor
->u
.ss
.bHubHdrDecLat
* 100);
320 * How long will it take to transition the downstream hub's port into
321 * U0? The greater of either the hub exit latency or the device exit
324 * The BOS U1/U2 exit latencies are expressed in 1us intervals.
325 * Multiply that by 1000 to get nanoseconds.
327 device_mel
= udev_exit_latency
* 1000;
328 hub_mel
= hub_exit_latency
* 1000;
329 if (device_mel
> hub_mel
)
330 total_mel
+= device_mel
;
332 total_mel
+= hub_mel
;
334 udev_lpm_params
->mel
= total_mel
;
338 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
339 * a transition from either U1 or U2.
341 static void usb_set_lpm_pel(struct usb_device
*udev
,
342 struct usb3_lpm_parameters
*udev_lpm_params
,
343 unsigned int udev_exit_latency
,
345 struct usb3_lpm_parameters
*hub_lpm_params
,
346 unsigned int hub_exit_latency
,
347 unsigned int port_to_port_exit_latency
)
349 unsigned int first_link_pel
;
350 unsigned int hub_pel
;
353 * First, the device sends an LFPS to transition the link between the
354 * device and the parent hub into U0. The exit latency is the bigger of
355 * the device exit latency or the hub exit latency.
357 if (udev_exit_latency
> hub_exit_latency
)
358 first_link_pel
= udev_exit_latency
* 1000;
360 first_link_pel
= hub_exit_latency
* 1000;
363 * When the hub starts to receive the LFPS, there is a slight delay for
364 * it to figure out that one of the ports is sending an LFPS. Then it
365 * will forward the LFPS to its upstream link. The exit latency is the
366 * delay, plus the PEL that we calculated for this hub.
368 hub_pel
= port_to_port_exit_latency
* 1000 + hub_lpm_params
->pel
;
371 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
372 * is the greater of the two exit latencies.
374 if (first_link_pel
> hub_pel
)
375 udev_lpm_params
->pel
= first_link_pel
;
377 udev_lpm_params
->pel
= hub_pel
;
381 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
382 * when a device initiates a transition to U0, until when it will receive the
383 * first packet from the host controller.
385 * Section C.1.5.1 describes the four components to this:
387 * - t2: time for the ERDY to make it from the device to the host.
388 * - t3: a host-specific delay to process the ERDY.
389 * - t4: time for the packet to make it from the host to the device.
391 * t3 is specific to both the xHCI host and the platform the host is integrated
392 * into. The Intel HW folks have said it's negligible, FIXME if a different
393 * vendor says otherwise.
395 static void usb_set_lpm_sel(struct usb_device
*udev
,
396 struct usb3_lpm_parameters
*udev_lpm_params
)
398 struct usb_device
*parent
;
399 unsigned int num_hubs
;
400 unsigned int total_sel
;
402 /* t1 = device PEL */
403 total_sel
= udev_lpm_params
->pel
;
404 /* How many external hubs are in between the device & the root port. */
405 for (parent
= udev
->parent
, num_hubs
= 0; parent
->parent
;
406 parent
= parent
->parent
)
408 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
410 total_sel
+= 2100 + 250 * (num_hubs
- 1);
412 /* t4 = 250ns * num_hubs */
413 total_sel
+= 250 * num_hubs
;
415 udev_lpm_params
->sel
= total_sel
;
418 static void usb_set_lpm_parameters(struct usb_device
*udev
)
421 unsigned int port_to_port_delay
;
422 unsigned int udev_u1_del
;
423 unsigned int udev_u2_del
;
424 unsigned int hub_u1_del
;
425 unsigned int hub_u2_del
;
427 if (!udev
->lpm_capable
|| udev
->speed
!= USB_SPEED_SUPER
)
430 hub
= usb_hub_to_struct_hub(udev
->parent
);
431 /* It doesn't take time to transition the roothub into U0, since it
432 * doesn't have an upstream link.
437 udev_u1_del
= udev
->bos
->ss_cap
->bU1devExitLat
;
438 udev_u2_del
= udev
->bos
->ss_cap
->bU2DevExitLat
;
439 hub_u1_del
= udev
->parent
->bos
->ss_cap
->bU1devExitLat
;
440 hub_u2_del
= udev
->parent
->bos
->ss_cap
->bU2DevExitLat
;
442 usb_set_lpm_mel(udev
, &udev
->u1_params
, udev_u1_del
,
443 hub
, &udev
->parent
->u1_params
, hub_u1_del
);
445 usb_set_lpm_mel(udev
, &udev
->u2_params
, udev_u2_del
,
446 hub
, &udev
->parent
->u2_params
, hub_u2_del
);
449 * Appendix C, section C.2.2.2, says that there is a slight delay from
450 * when the parent hub notices the downstream port is trying to
451 * transition to U0 to when the hub initiates a U0 transition on its
452 * upstream port. The section says the delays are tPort2PortU1EL and
453 * tPort2PortU2EL, but it doesn't define what they are.
455 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
456 * about the same delays. Use the maximum delay calculations from those
457 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
458 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
459 * assume the device exit latencies they are talking about are the hub
462 * What do we do if the U2 exit latency is less than the U1 exit
463 * latency? It's possible, although not likely...
465 port_to_port_delay
= 1;
467 usb_set_lpm_pel(udev
, &udev
->u1_params
, udev_u1_del
,
468 hub
, &udev
->parent
->u1_params
, hub_u1_del
,
471 if (hub_u2_del
> hub_u1_del
)
472 port_to_port_delay
= 1 + hub_u2_del
- hub_u1_del
;
474 port_to_port_delay
= 1 + hub_u1_del
;
476 usb_set_lpm_pel(udev
, &udev
->u2_params
, udev_u2_del
,
477 hub
, &udev
->parent
->u2_params
, hub_u2_del
,
480 /* Now that we've got PEL, calculate SEL. */
481 usb_set_lpm_sel(udev
, &udev
->u1_params
);
482 usb_set_lpm_sel(udev
, &udev
->u2_params
);
485 /* USB 2.0 spec Section 11.24.4.5 */
486 static int get_hub_descriptor(struct usb_device
*hdev
, void *data
)
491 if (hub_is_superspeed(hdev
)) {
492 dtype
= USB_DT_SS_HUB
;
493 size
= USB_DT_SS_HUB_SIZE
;
496 size
= sizeof(struct usb_hub_descriptor
);
499 for (i
= 0; i
< 3; i
++) {
500 ret
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
501 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
| USB_RT_HUB
,
502 dtype
<< 8, 0, data
, size
,
503 USB_CTRL_GET_TIMEOUT
);
504 if (ret
>= (USB_DT_HUB_NONVAR_SIZE
+ 2))
511 * USB 2.0 spec Section 11.24.2.1
513 static int clear_hub_feature(struct usb_device
*hdev
, int feature
)
515 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
516 USB_REQ_CLEAR_FEATURE
, USB_RT_HUB
, feature
, 0, NULL
, 0, 1000);
520 * USB 2.0 spec Section 11.24.2.2
522 int usb_clear_port_feature(struct usb_device
*hdev
, int port1
, int feature
)
524 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
525 USB_REQ_CLEAR_FEATURE
, USB_RT_PORT
, feature
, port1
,
530 * USB 2.0 spec Section 11.24.2.13
532 static int set_port_feature(struct usb_device
*hdev
, int port1
, int feature
)
535 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
536 USB_REQ_SET_FEATURE
, USB_RT_PORT
, feature
, port1
,
541 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
542 * for info about using port indicators
544 static void set_port_led(
550 int status
= set_port_feature(hub
->hdev
, (selector
<< 8) | port1
,
551 USB_PORT_FEAT_INDICATOR
);
553 dev_dbg (hub
->intfdev
,
554 "port %d indicator %s status %d\n",
556 ({ char *s
; switch (selector
) {
557 case HUB_LED_AMBER
: s
= "amber"; break;
558 case HUB_LED_GREEN
: s
= "green"; break;
559 case HUB_LED_OFF
: s
= "off"; break;
560 case HUB_LED_AUTO
: s
= "auto"; break;
561 default: s
= "??"; break;
566 #define LED_CYCLE_PERIOD ((2*HZ)/3)
568 static void led_work (struct work_struct
*work
)
570 struct usb_hub
*hub
=
571 container_of(work
, struct usb_hub
, leds
.work
);
572 struct usb_device
*hdev
= hub
->hdev
;
574 unsigned changed
= 0;
577 if (hdev
->state
!= USB_STATE_CONFIGURED
|| hub
->quiescing
)
580 for (i
= 0; i
< hub
->descriptor
->bNbrPorts
; i
++) {
581 unsigned selector
, mode
;
583 /* 30%-50% duty cycle */
585 switch (hub
->indicator
[i
]) {
587 case INDICATOR_CYCLE
:
589 selector
= HUB_LED_AUTO
;
590 mode
= INDICATOR_AUTO
;
592 /* blinking green = sw attention */
593 case INDICATOR_GREEN_BLINK
:
594 selector
= HUB_LED_GREEN
;
595 mode
= INDICATOR_GREEN_BLINK_OFF
;
597 case INDICATOR_GREEN_BLINK_OFF
:
598 selector
= HUB_LED_OFF
;
599 mode
= INDICATOR_GREEN_BLINK
;
601 /* blinking amber = hw attention */
602 case INDICATOR_AMBER_BLINK
:
603 selector
= HUB_LED_AMBER
;
604 mode
= INDICATOR_AMBER_BLINK_OFF
;
606 case INDICATOR_AMBER_BLINK_OFF
:
607 selector
= HUB_LED_OFF
;
608 mode
= INDICATOR_AMBER_BLINK
;
610 /* blink green/amber = reserved */
611 case INDICATOR_ALT_BLINK
:
612 selector
= HUB_LED_GREEN
;
613 mode
= INDICATOR_ALT_BLINK_OFF
;
615 case INDICATOR_ALT_BLINK_OFF
:
616 selector
= HUB_LED_AMBER
;
617 mode
= INDICATOR_ALT_BLINK
;
622 if (selector
!= HUB_LED_AUTO
)
624 set_port_led(hub
, i
+ 1, selector
);
625 hub
->indicator
[i
] = mode
;
627 if (!changed
&& blinkenlights
) {
629 cursor
%= hub
->descriptor
->bNbrPorts
;
630 set_port_led(hub
, cursor
+ 1, HUB_LED_GREEN
);
631 hub
->indicator
[cursor
] = INDICATOR_CYCLE
;
635 schedule_delayed_work(&hub
->leds
, LED_CYCLE_PERIOD
);
638 /* use a short timeout for hub/port status fetches */
639 #define USB_STS_TIMEOUT 1000
640 #define USB_STS_RETRIES 5
643 * USB 2.0 spec Section 11.24.2.6
645 static int get_hub_status(struct usb_device
*hdev
,
646 struct usb_hub_status
*data
)
648 int i
, status
= -ETIMEDOUT
;
650 for (i
= 0; i
< USB_STS_RETRIES
&&
651 (status
== -ETIMEDOUT
|| status
== -EPIPE
); i
++) {
652 status
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
653 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_HUB
, 0, 0,
654 data
, sizeof(*data
), USB_STS_TIMEOUT
);
660 * USB 2.0 spec Section 11.24.2.7
662 static int get_port_status(struct usb_device
*hdev
, int port1
,
663 struct usb_port_status
*data
)
665 int i
, status
= -ETIMEDOUT
;
667 for (i
= 0; i
< USB_STS_RETRIES
&&
668 (status
== -ETIMEDOUT
|| status
== -EPIPE
); i
++) {
669 status
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
670 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_PORT
, 0, port1
,
671 data
, sizeof(*data
), USB_STS_TIMEOUT
);
676 static int hub_port_status(struct usb_hub
*hub
, int port1
,
677 u16
*status
, u16
*change
)
681 mutex_lock(&hub
->status_mutex
);
682 ret
= get_port_status(hub
->hdev
, port1
, &hub
->status
->port
);
685 dev_err(hub
->intfdev
,
686 "%s failed (err = %d)\n", __func__
, ret
);
690 *status
= le16_to_cpu(hub
->status
->port
.wPortStatus
);
691 *change
= le16_to_cpu(hub
->status
->port
.wPortChange
);
695 mutex_unlock(&hub
->status_mutex
);
699 static void kick_khubd(struct usb_hub
*hub
)
703 spin_lock_irqsave(&hub_event_lock
, flags
);
704 if (!hub
->disconnected
&& list_empty(&hub
->event_list
)) {
705 list_add_tail(&hub
->event_list
, &hub_event_list
);
707 /* Suppress autosuspend until khubd runs */
708 usb_autopm_get_interface_no_resume(
709 to_usb_interface(hub
->intfdev
));
710 wake_up(&khubd_wait
);
712 spin_unlock_irqrestore(&hub_event_lock
, flags
);
715 void usb_kick_khubd(struct usb_device
*hdev
)
717 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
724 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
725 * Notification, which indicates it had initiated remote wakeup.
727 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
728 * device initiates resume, so the USB core will not receive notice of the
729 * resume through the normal hub interrupt URB.
731 void usb_wakeup_notification(struct usb_device
*hdev
,
732 unsigned int portnum
)
739 hub
= usb_hub_to_struct_hub(hdev
);
741 set_bit(portnum
, hub
->wakeup_bits
);
745 EXPORT_SYMBOL_GPL(usb_wakeup_notification
);
747 /* completion function, fires on port status changes and various faults */
748 static void hub_irq(struct urb
*urb
)
750 struct usb_hub
*hub
= urb
->context
;
751 int status
= urb
->status
;
756 case -ENOENT
: /* synchronous unlink */
757 case -ECONNRESET
: /* async unlink */
758 case -ESHUTDOWN
: /* hardware going away */
761 default: /* presumably an error */
762 /* Cause a hub reset after 10 consecutive errors */
763 dev_dbg (hub
->intfdev
, "transfer --> %d\n", status
);
764 if ((++hub
->nerrors
< 10) || hub
->error
)
769 /* let khubd handle things */
770 case 0: /* we got data: port status changed */
772 for (i
= 0; i
< urb
->actual_length
; ++i
)
773 bits
|= ((unsigned long) ((*hub
->buffer
)[i
]))
775 hub
->event_bits
[0] = bits
;
781 /* Something happened, let khubd figure it out */
788 if ((status
= usb_submit_urb (hub
->urb
, GFP_ATOMIC
)) != 0
789 && status
!= -ENODEV
&& status
!= -EPERM
)
790 dev_err (hub
->intfdev
, "resubmit --> %d\n", status
);
793 /* USB 2.0 spec Section 11.24.2.3 */
795 hub_clear_tt_buffer (struct usb_device
*hdev
, u16 devinfo
, u16 tt
)
797 /* Need to clear both directions for control ep */
798 if (((devinfo
>> 11) & USB_ENDPOINT_XFERTYPE_MASK
) ==
799 USB_ENDPOINT_XFER_CONTROL
) {
800 int status
= usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
801 HUB_CLEAR_TT_BUFFER
, USB_RT_PORT
,
802 devinfo
^ 0x8000, tt
, NULL
, 0, 1000);
806 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
807 HUB_CLEAR_TT_BUFFER
, USB_RT_PORT
, devinfo
,
812 * enumeration blocks khubd for a long time. we use keventd instead, since
813 * long blocking there is the exception, not the rule. accordingly, HCDs
814 * talking to TTs must queue control transfers (not just bulk and iso), so
815 * both can talk to the same hub concurrently.
817 static void hub_tt_work(struct work_struct
*work
)
819 struct usb_hub
*hub
=
820 container_of(work
, struct usb_hub
, tt
.clear_work
);
823 spin_lock_irqsave (&hub
->tt
.lock
, flags
);
824 while (!list_empty(&hub
->tt
.clear_list
)) {
825 struct list_head
*next
;
826 struct usb_tt_clear
*clear
;
827 struct usb_device
*hdev
= hub
->hdev
;
828 const struct hc_driver
*drv
;
831 next
= hub
->tt
.clear_list
.next
;
832 clear
= list_entry (next
, struct usb_tt_clear
, clear_list
);
833 list_del (&clear
->clear_list
);
835 /* drop lock so HCD can concurrently report other TT errors */
836 spin_unlock_irqrestore (&hub
->tt
.lock
, flags
);
837 status
= hub_clear_tt_buffer (hdev
, clear
->devinfo
, clear
->tt
);
838 if (status
&& status
!= -ENODEV
)
840 "clear tt %d (%04x) error %d\n",
841 clear
->tt
, clear
->devinfo
, status
);
843 /* Tell the HCD, even if the operation failed */
844 drv
= clear
->hcd
->driver
;
845 if (drv
->clear_tt_buffer_complete
)
846 (drv
->clear_tt_buffer_complete
)(clear
->hcd
, clear
->ep
);
849 spin_lock_irqsave(&hub
->tt
.lock
, flags
);
851 spin_unlock_irqrestore (&hub
->tt
.lock
, flags
);
855 * usb_hub_set_port_power - control hub port's power state
858 * @set: expected status
860 * call this function to control port's power via setting or
861 * clearing the port's PORT_POWER feature.
863 int usb_hub_set_port_power(struct usb_device
*hdev
, int port1
,
867 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
868 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
871 ret
= set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
873 ret
= usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
876 port_dev
->power_is_on
= set
;
881 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
882 * @urb: an URB associated with the failed or incomplete split transaction
884 * High speed HCDs use this to tell the hub driver that some split control or
885 * bulk transaction failed in a way that requires clearing internal state of
886 * a transaction translator. This is normally detected (and reported) from
889 * It may not be possible for that hub to handle additional full (or low)
890 * speed transactions until that state is fully cleared out.
892 int usb_hub_clear_tt_buffer(struct urb
*urb
)
894 struct usb_device
*udev
= urb
->dev
;
895 int pipe
= urb
->pipe
;
896 struct usb_tt
*tt
= udev
->tt
;
898 struct usb_tt_clear
*clear
;
900 /* we've got to cope with an arbitrary number of pending TT clears,
901 * since each TT has "at least two" buffers that can need it (and
902 * there can be many TTs per hub). even if they're uncommon.
904 if ((clear
= kmalloc (sizeof *clear
, GFP_ATOMIC
)) == NULL
) {
905 dev_err (&udev
->dev
, "can't save CLEAR_TT_BUFFER state\n");
906 /* FIXME recover somehow ... RESET_TT? */
910 /* info that CLEAR_TT_BUFFER needs */
911 clear
->tt
= tt
->multi
? udev
->ttport
: 1;
912 clear
->devinfo
= usb_pipeendpoint (pipe
);
913 clear
->devinfo
|= udev
->devnum
<< 4;
914 clear
->devinfo
|= usb_pipecontrol (pipe
)
915 ? (USB_ENDPOINT_XFER_CONTROL
<< 11)
916 : (USB_ENDPOINT_XFER_BULK
<< 11);
917 if (usb_pipein (pipe
))
918 clear
->devinfo
|= 1 << 15;
920 /* info for completion callback */
921 clear
->hcd
= bus_to_hcd(udev
->bus
);
924 /* tell keventd to clear state for this TT */
925 spin_lock_irqsave (&tt
->lock
, flags
);
926 list_add_tail (&clear
->clear_list
, &tt
->clear_list
);
927 schedule_work(&tt
->clear_work
);
928 spin_unlock_irqrestore (&tt
->lock
, flags
);
931 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer
);
933 /* If do_delay is false, return the number of milliseconds the caller
936 static unsigned hub_power_on(struct usb_hub
*hub
, bool do_delay
)
939 unsigned pgood_delay
= hub
->descriptor
->bPwrOn2PwrGood
* 2;
941 u16 wHubCharacteristics
=
942 le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
944 /* Enable power on each port. Some hubs have reserved values
945 * of LPSM (> 2) in their descriptors, even though they are
946 * USB 2.0 hubs. Some hubs do not implement port-power switching
947 * but only emulate it. In all cases, the ports won't work
948 * unless we send these messages to the hub.
950 if ((wHubCharacteristics
& HUB_CHAR_LPSM
) < 2)
951 dev_dbg(hub
->intfdev
, "enabling power on all ports\n");
953 dev_dbg(hub
->intfdev
, "trying to enable port power on "
954 "non-switchable hub\n");
955 for (port1
= 1; port1
<= hub
->descriptor
->bNbrPorts
; port1
++)
956 if (hub
->ports
[port1
- 1]->power_is_on
)
957 set_port_feature(hub
->hdev
, port1
, USB_PORT_FEAT_POWER
);
959 usb_clear_port_feature(hub
->hdev
, port1
,
960 USB_PORT_FEAT_POWER
);
962 /* Wait at least 100 msec for power to become stable */
963 delay
= max(pgood_delay
, (unsigned) 100);
969 static int hub_hub_status(struct usb_hub
*hub
,
970 u16
*status
, u16
*change
)
974 mutex_lock(&hub
->status_mutex
);
975 ret
= get_hub_status(hub
->hdev
, &hub
->status
->hub
);
978 dev_err(hub
->intfdev
,
979 "%s failed (err = %d)\n", __func__
, ret
);
981 *status
= le16_to_cpu(hub
->status
->hub
.wHubStatus
);
982 *change
= le16_to_cpu(hub
->status
->hub
.wHubChange
);
985 mutex_unlock(&hub
->status_mutex
);
989 static int hub_set_port_link_state(struct usb_hub
*hub
, int port1
,
990 unsigned int link_status
)
992 return set_port_feature(hub
->hdev
,
993 port1
| (link_status
<< 3),
994 USB_PORT_FEAT_LINK_STATE
);
998 * If USB 3.0 ports are placed into the Disabled state, they will no longer
999 * detect any device connects or disconnects. This is generally not what the
1000 * USB core wants, since it expects a disabled port to produce a port status
1001 * change event when a new device connects.
1003 * Instead, set the link state to Disabled, wait for the link to settle into
1004 * that state, clear any change bits, and then put the port into the RxDetect
1007 static int hub_usb3_port_disable(struct usb_hub
*hub
, int port1
)
1011 u16 portchange
, portstatus
;
1013 if (!hub_is_superspeed(hub
->hdev
))
1016 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
1021 * USB controller Advanced Micro Devices, Inc. [AMD] FCH USB XHCI
1022 * Controller [1022:7814] will have spurious result making the following
1023 * usb 3.0 device hotplugging route to the 2.0 root hub and recognized
1024 * as high-speed device if we set the usb 3.0 port link state to
1025 * Disabled. Since it's already in USB_SS_PORT_LS_RX_DETECT state, we
1026 * check the state here to avoid the bug.
1028 if ((portstatus
& USB_PORT_STAT_LINK_STATE
) ==
1029 USB_SS_PORT_LS_RX_DETECT
) {
1030 dev_dbg(&hub
->ports
[port1
- 1]->dev
,
1031 "Not disabling port; link state is RxDetect\n");
1035 ret
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_SS_DISABLED
);
1039 /* Wait for the link to enter the disabled state. */
1040 for (total_time
= 0; ; total_time
+= HUB_DEBOUNCE_STEP
) {
1041 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
1045 if ((portstatus
& USB_PORT_STAT_LINK_STATE
) ==
1046 USB_SS_PORT_LS_SS_DISABLED
)
1048 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
1050 msleep(HUB_DEBOUNCE_STEP
);
1052 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
1053 dev_warn(hub
->intfdev
, "Could not disable port %d after %d ms\n",
1056 return hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_RX_DETECT
);
1059 static int hub_port_disable(struct usb_hub
*hub
, int port1
, int set_state
)
1061 struct usb_device
*hdev
= hub
->hdev
;
1064 if (hub
->ports
[port1
- 1]->child
&& set_state
)
1065 usb_set_device_state(hub
->ports
[port1
- 1]->child
,
1066 USB_STATE_NOTATTACHED
);
1068 if (hub_is_superspeed(hub
->hdev
))
1069 ret
= hub_usb3_port_disable(hub
, port1
);
1071 ret
= usb_clear_port_feature(hdev
, port1
,
1072 USB_PORT_FEAT_ENABLE
);
1074 if (ret
&& ret
!= -ENODEV
)
1075 dev_err(hub
->intfdev
, "cannot disable port %d (err = %d)\n",
1081 * Disable a port and mark a logical connect-change event, so that some
1082 * time later khubd will disconnect() any existing usb_device on the port
1083 * and will re-enumerate if there actually is a device attached.
1085 static void hub_port_logical_disconnect(struct usb_hub
*hub
, int port1
)
1087 dev_dbg(hub
->intfdev
, "logical disconnect on port %d\n", port1
);
1088 hub_port_disable(hub
, port1
, 1);
1090 /* FIXME let caller ask to power down the port:
1091 * - some devices won't enumerate without a VBUS power cycle
1092 * - SRP saves power that way
1093 * - ... new call, TBD ...
1094 * That's easy if this hub can switch power per-port, and
1095 * khubd reactivates the port later (timer, SRP, etc).
1096 * Powerdown must be optional, because of reset/DFU.
1099 set_bit(port1
, hub
->change_bits
);
1104 * usb_remove_device - disable a device's port on its parent hub
1105 * @udev: device to be disabled and removed
1106 * Context: @udev locked, must be able to sleep.
1108 * After @udev's port has been disabled, khubd is notified and it will
1109 * see that the device has been disconnected. When the device is
1110 * physically unplugged and something is plugged in, the events will
1111 * be received and processed normally.
1113 int usb_remove_device(struct usb_device
*udev
)
1115 struct usb_hub
*hub
;
1116 struct usb_interface
*intf
;
1118 if (!udev
->parent
) /* Can't remove a root hub */
1120 hub
= usb_hub_to_struct_hub(udev
->parent
);
1121 intf
= to_usb_interface(hub
->intfdev
);
1123 usb_autopm_get_interface(intf
);
1124 set_bit(udev
->portnum
, hub
->removed_bits
);
1125 hub_port_logical_disconnect(hub
, udev
->portnum
);
1126 usb_autopm_put_interface(intf
);
1130 enum hub_activation_type
{
1131 HUB_INIT
, HUB_INIT2
, HUB_INIT3
, /* INITs must come first */
1132 HUB_POST_RESET
, HUB_RESUME
, HUB_RESET_RESUME
,
1135 static void hub_init_func2(struct work_struct
*ws
);
1136 static void hub_init_func3(struct work_struct
*ws
);
1138 static void hub_activate(struct usb_hub
*hub
, enum hub_activation_type type
)
1140 struct usb_device
*hdev
= hub
->hdev
;
1141 struct usb_hcd
*hcd
;
1145 bool need_debounce_delay
= false;
1148 /* Continue a partial initialization */
1149 if (type
== HUB_INIT2
|| type
== HUB_INIT3
) {
1150 device_lock(hub
->intfdev
);
1152 /* Was the hub disconnected while we were waiting? */
1153 if (hub
->disconnected
) {
1154 device_unlock(hub
->intfdev
);
1155 kref_put(&hub
->kref
, hub_release
);
1158 if (type
== HUB_INIT2
)
1163 kref_get(&hub
->kref
);
1165 /* The superspeed hub except for root hub has to use Hub Depth
1166 * value as an offset into the route string to locate the bits
1167 * it uses to determine the downstream port number. So hub driver
1168 * should send a set hub depth request to superspeed hub after
1169 * the superspeed hub is set configuration in initialization or
1172 * After a resume, port power should still be on.
1173 * For any other type of activation, turn it on.
1175 if (type
!= HUB_RESUME
) {
1176 if (hdev
->parent
&& hub_is_superspeed(hdev
)) {
1177 ret
= usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
1178 HUB_SET_DEPTH
, USB_RT_HUB
,
1179 hdev
->level
- 1, 0, NULL
, 0,
1180 USB_CTRL_SET_TIMEOUT
);
1182 dev_err(hub
->intfdev
,
1183 "set hub depth failed\n");
1186 /* Speed up system boot by using a delayed_work for the
1187 * hub's initial power-up delays. This is pretty awkward
1188 * and the implementation looks like a home-brewed sort of
1189 * setjmp/longjmp, but it saves at least 100 ms for each
1190 * root hub (assuming usbcore is compiled into the kernel
1191 * rather than as a module). It adds up.
1193 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1194 * because for those activation types the ports have to be
1195 * operational when we return. In theory this could be done
1196 * for HUB_POST_RESET, but it's easier not to.
1198 if (type
== HUB_INIT
) {
1199 delay
= hub_power_on(hub
, false);
1200 PREPARE_DELAYED_WORK(&hub
->init_work
, hub_init_func2
);
1201 schedule_delayed_work(&hub
->init_work
,
1202 msecs_to_jiffies(delay
));
1204 /* Suppress autosuspend until init is done */
1205 usb_autopm_get_interface_no_resume(
1206 to_usb_interface(hub
->intfdev
));
1207 return; /* Continues at init2: below */
1208 } else if (type
== HUB_RESET_RESUME
) {
1209 /* The internal host controller state for the hub device
1210 * may be gone after a host power loss on system resume.
1211 * Update the device's info so the HW knows it's a hub.
1213 hcd
= bus_to_hcd(hdev
->bus
);
1214 if (hcd
->driver
->update_hub_device
) {
1215 ret
= hcd
->driver
->update_hub_device(hcd
, hdev
,
1216 &hub
->tt
, GFP_NOIO
);
1218 dev_err(hub
->intfdev
, "Host not "
1219 "accepting hub info "
1221 dev_err(hub
->intfdev
, "LS/FS devices "
1222 "and hubs may not work "
1223 "under this hub\n.");
1226 hub_power_on(hub
, true);
1228 hub_power_on(hub
, true);
1233 /* Check each port and set hub->change_bits to let khubd know
1234 * which ports need attention.
1236 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
1237 struct usb_device
*udev
= hub
->ports
[port1
- 1]->child
;
1238 u16 portstatus
, portchange
;
1240 portstatus
= portchange
= 0;
1241 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
1242 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
))
1243 dev_dbg(hub
->intfdev
,
1244 "port %d: status %04x change %04x\n",
1245 port1
, portstatus
, portchange
);
1247 /* After anything other than HUB_RESUME (i.e., initialization
1248 * or any sort of reset), every port should be disabled.
1249 * Unconnected ports should likewise be disabled (paranoia),
1250 * and so should ports for which we have no usb_device.
1252 if ((portstatus
& USB_PORT_STAT_ENABLE
) && (
1253 type
!= HUB_RESUME
||
1254 !(portstatus
& USB_PORT_STAT_CONNECTION
) ||
1256 udev
->state
== USB_STATE_NOTATTACHED
)) {
1258 * USB3 protocol ports will automatically transition
1259 * to Enabled state when detect an USB3.0 device attach.
1260 * Do not disable USB3 protocol ports.
1262 if (!hub_is_superspeed(hdev
)) {
1263 usb_clear_port_feature(hdev
, port1
,
1264 USB_PORT_FEAT_ENABLE
);
1265 portstatus
&= ~USB_PORT_STAT_ENABLE
;
1267 /* Pretend that power was lost for USB3 devs */
1268 portstatus
&= ~USB_PORT_STAT_ENABLE
;
1272 /* Clear status-change flags; we'll debounce later */
1273 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
1274 need_debounce_delay
= true;
1275 usb_clear_port_feature(hub
->hdev
, port1
,
1276 USB_PORT_FEAT_C_CONNECTION
);
1278 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
1279 need_debounce_delay
= true;
1280 usb_clear_port_feature(hub
->hdev
, port1
,
1281 USB_PORT_FEAT_C_ENABLE
);
1283 if (portchange
& USB_PORT_STAT_C_RESET
) {
1284 need_debounce_delay
= true;
1285 usb_clear_port_feature(hub
->hdev
, port1
,
1286 USB_PORT_FEAT_C_RESET
);
1288 if ((portchange
& USB_PORT_STAT_C_BH_RESET
) &&
1289 hub_is_superspeed(hub
->hdev
)) {
1290 need_debounce_delay
= true;
1291 usb_clear_port_feature(hub
->hdev
, port1
,
1292 USB_PORT_FEAT_C_BH_PORT_RESET
);
1294 /* We can forget about a "removed" device when there's a
1295 * physical disconnect or the connect status changes.
1297 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
1298 (portchange
& USB_PORT_STAT_C_CONNECTION
))
1299 clear_bit(port1
, hub
->removed_bits
);
1301 if (!udev
|| udev
->state
== USB_STATE_NOTATTACHED
) {
1302 /* Tell khubd to disconnect the device or
1303 * check for a new connection
1305 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
))
1306 set_bit(port1
, hub
->change_bits
);
1308 } else if (portstatus
& USB_PORT_STAT_ENABLE
) {
1309 bool port_resumed
= (portstatus
&
1310 USB_PORT_STAT_LINK_STATE
) ==
1312 /* The power session apparently survived the resume.
1313 * If there was an overcurrent or suspend change
1314 * (i.e., remote wakeup request), have khubd
1315 * take care of it. Look at the port link state
1316 * for USB 3.0 hubs, since they don't have a suspend
1317 * change bit, and they don't set the port link change
1318 * bit on device-initiated resume.
1320 if (portchange
|| (hub_is_superspeed(hub
->hdev
) &&
1322 set_bit(port1
, hub
->change_bits
);
1324 } else if (udev
->persist_enabled
) {
1325 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
1328 udev
->reset_resume
= 1;
1330 /* Don't set the change_bits when the device
1333 if (port_dev
->power_is_on
)
1334 set_bit(port1
, hub
->change_bits
);
1337 /* The power session is gone; tell khubd */
1338 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
1339 set_bit(port1
, hub
->change_bits
);
1343 /* If no port-status-change flags were set, we don't need any
1344 * debouncing. If flags were set we can try to debounce the
1345 * ports all at once right now, instead of letting khubd do them
1346 * one at a time later on.
1348 * If any port-status changes do occur during this delay, khubd
1349 * will see them later and handle them normally.
1351 if (need_debounce_delay
) {
1352 delay
= HUB_DEBOUNCE_STABLE
;
1354 /* Don't do a long sleep inside a workqueue routine */
1355 if (type
== HUB_INIT2
) {
1356 PREPARE_DELAYED_WORK(&hub
->init_work
, hub_init_func3
);
1357 schedule_delayed_work(&hub
->init_work
,
1358 msecs_to_jiffies(delay
));
1359 device_unlock(hub
->intfdev
);
1360 return; /* Continues at init3: below */
1368 status
= usb_submit_urb(hub
->urb
, GFP_NOIO
);
1370 dev_err(hub
->intfdev
, "activate --> %d\n", status
);
1371 if (hub
->has_indicators
&& blinkenlights
)
1372 schedule_delayed_work(&hub
->leds
, LED_CYCLE_PERIOD
);
1374 /* Scan all ports that need attention */
1377 /* Allow autosuspend if it was suppressed */
1378 if (type
<= HUB_INIT3
)
1379 usb_autopm_put_interface_async(to_usb_interface(hub
->intfdev
));
1381 if (type
== HUB_INIT2
|| type
== HUB_INIT3
)
1382 device_unlock(hub
->intfdev
);
1384 kref_put(&hub
->kref
, hub_release
);
1387 /* Implement the continuations for the delays above */
1388 static void hub_init_func2(struct work_struct
*ws
)
1390 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
1392 hub_activate(hub
, HUB_INIT2
);
1395 static void hub_init_func3(struct work_struct
*ws
)
1397 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
1399 hub_activate(hub
, HUB_INIT3
);
1402 enum hub_quiescing_type
{
1403 HUB_DISCONNECT
, HUB_PRE_RESET
, HUB_SUSPEND
1406 static void hub_quiesce(struct usb_hub
*hub
, enum hub_quiescing_type type
)
1408 struct usb_device
*hdev
= hub
->hdev
;
1411 cancel_delayed_work_sync(&hub
->init_work
);
1413 /* khubd and related activity won't re-trigger */
1416 if (type
!= HUB_SUSPEND
) {
1417 /* Disconnect all the children */
1418 for (i
= 0; i
< hdev
->maxchild
; ++i
) {
1419 if (hub
->ports
[i
]->child
)
1420 usb_disconnect(&hub
->ports
[i
]->child
);
1424 /* Stop khubd and related activity */
1425 usb_kill_urb(hub
->urb
);
1426 if (hub
->has_indicators
)
1427 cancel_delayed_work_sync(&hub
->leds
);
1429 flush_work(&hub
->tt
.clear_work
);
1432 /* caller has locked the hub device */
1433 static int hub_pre_reset(struct usb_interface
*intf
)
1435 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1437 hub_quiesce(hub
, HUB_PRE_RESET
);
1441 /* caller has locked the hub device */
1442 static int hub_post_reset(struct usb_interface
*intf
)
1444 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1446 hub_activate(hub
, HUB_POST_RESET
);
1450 static int hub_configure(struct usb_hub
*hub
,
1451 struct usb_endpoint_descriptor
*endpoint
)
1453 struct usb_hcd
*hcd
;
1454 struct usb_device
*hdev
= hub
->hdev
;
1455 struct device
*hub_dev
= hub
->intfdev
;
1456 u16 hubstatus
, hubchange
;
1457 u16 wHubCharacteristics
;
1460 char *message
= "out of memory";
1464 hub
->buffer
= kmalloc(sizeof(*hub
->buffer
), GFP_KERNEL
);
1470 hub
->status
= kmalloc(sizeof(*hub
->status
), GFP_KERNEL
);
1475 mutex_init(&hub
->status_mutex
);
1477 hub
->descriptor
= kmalloc(sizeof(*hub
->descriptor
), GFP_KERNEL
);
1478 if (!hub
->descriptor
) {
1483 /* Request the entire hub descriptor.
1484 * hub->descriptor can handle USB_MAXCHILDREN ports,
1485 * but the hub can/will return fewer bytes here.
1487 ret
= get_hub_descriptor(hdev
, hub
->descriptor
);
1489 message
= "can't read hub descriptor";
1491 } else if (hub
->descriptor
->bNbrPorts
> USB_MAXCHILDREN
) {
1492 message
= "hub has too many ports!";
1495 } else if (hub
->descriptor
->bNbrPorts
== 0) {
1496 message
= "hub doesn't have any ports!";
1501 hdev
->maxchild
= hub
->descriptor
->bNbrPorts
;
1502 dev_info (hub_dev
, "%d port%s detected\n", hdev
->maxchild
,
1503 (hdev
->maxchild
== 1) ? "" : "s");
1505 hub
->ports
= kzalloc(hdev
->maxchild
* sizeof(struct usb_port
*),
1512 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
1513 if (hub_is_superspeed(hdev
)) {
1521 /* FIXME for USB 3.0, skip for now */
1522 if ((wHubCharacteristics
& HUB_CHAR_COMPOUND
) &&
1523 !(hub_is_superspeed(hdev
))) {
1525 char portstr
[USB_MAXCHILDREN
+ 1];
1527 for (i
= 0; i
< hdev
->maxchild
; i
++)
1528 portstr
[i
] = hub
->descriptor
->u
.hs
.DeviceRemovable
1529 [((i
+ 1) / 8)] & (1 << ((i
+ 1) % 8))
1531 portstr
[hdev
->maxchild
] = 0;
1532 dev_dbg(hub_dev
, "compound device; port removable status: %s\n", portstr
);
1534 dev_dbg(hub_dev
, "standalone hub\n");
1536 switch (wHubCharacteristics
& HUB_CHAR_LPSM
) {
1537 case HUB_CHAR_COMMON_LPSM
:
1538 dev_dbg(hub_dev
, "ganged power switching\n");
1540 case HUB_CHAR_INDV_PORT_LPSM
:
1541 dev_dbg(hub_dev
, "individual port power switching\n");
1543 case HUB_CHAR_NO_LPSM
:
1545 dev_dbg(hub_dev
, "no power switching (usb 1.0)\n");
1549 switch (wHubCharacteristics
& HUB_CHAR_OCPM
) {
1550 case HUB_CHAR_COMMON_OCPM
:
1551 dev_dbg(hub_dev
, "global over-current protection\n");
1553 case HUB_CHAR_INDV_PORT_OCPM
:
1554 dev_dbg(hub_dev
, "individual port over-current protection\n");
1556 case HUB_CHAR_NO_OCPM
:
1558 dev_dbg(hub_dev
, "no over-current protection\n");
1562 spin_lock_init (&hub
->tt
.lock
);
1563 INIT_LIST_HEAD (&hub
->tt
.clear_list
);
1564 INIT_WORK(&hub
->tt
.clear_work
, hub_tt_work
);
1565 switch (hdev
->descriptor
.bDeviceProtocol
) {
1568 case USB_HUB_PR_HS_SINGLE_TT
:
1569 dev_dbg(hub_dev
, "Single TT\n");
1572 case USB_HUB_PR_HS_MULTI_TT
:
1573 ret
= usb_set_interface(hdev
, 0, 1);
1575 dev_dbg(hub_dev
, "TT per port\n");
1578 dev_err(hub_dev
, "Using single TT (err %d)\n",
1583 /* USB 3.0 hubs don't have a TT */
1586 dev_dbg(hub_dev
, "Unrecognized hub protocol %d\n",
1587 hdev
->descriptor
.bDeviceProtocol
);
1591 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1592 switch (wHubCharacteristics
& HUB_CHAR_TTTT
) {
1593 case HUB_TTTT_8_BITS
:
1594 if (hdev
->descriptor
.bDeviceProtocol
!= 0) {
1595 hub
->tt
.think_time
= 666;
1596 dev_dbg(hub_dev
, "TT requires at most %d "
1597 "FS bit times (%d ns)\n",
1598 8, hub
->tt
.think_time
);
1601 case HUB_TTTT_16_BITS
:
1602 hub
->tt
.think_time
= 666 * 2;
1603 dev_dbg(hub_dev
, "TT requires at most %d "
1604 "FS bit times (%d ns)\n",
1605 16, hub
->tt
.think_time
);
1607 case HUB_TTTT_24_BITS
:
1608 hub
->tt
.think_time
= 666 * 3;
1609 dev_dbg(hub_dev
, "TT requires at most %d "
1610 "FS bit times (%d ns)\n",
1611 24, hub
->tt
.think_time
);
1613 case HUB_TTTT_32_BITS
:
1614 hub
->tt
.think_time
= 666 * 4;
1615 dev_dbg(hub_dev
, "TT requires at most %d "
1616 "FS bit times (%d ns)\n",
1617 32, hub
->tt
.think_time
);
1621 /* probe() zeroes hub->indicator[] */
1622 if (wHubCharacteristics
& HUB_CHAR_PORTIND
) {
1623 hub
->has_indicators
= 1;
1624 dev_dbg(hub_dev
, "Port indicators are supported\n");
1627 dev_dbg(hub_dev
, "power on to power good time: %dms\n",
1628 hub
->descriptor
->bPwrOn2PwrGood
* 2);
1630 /* power budgeting mostly matters with bus-powered hubs,
1631 * and battery-powered root hubs (may provide just 8 mA).
1633 ret
= usb_get_status(hdev
, USB_RECIP_DEVICE
, 0, &hubstatus
);
1635 message
= "can't get hub status";
1638 le16_to_cpus(&hubstatus
);
1639 hcd
= bus_to_hcd(hdev
->bus
);
1640 if (hdev
== hdev
->bus
->root_hub
) {
1641 if (hcd
->power_budget
> 0)
1642 hdev
->bus_mA
= hcd
->power_budget
;
1644 hdev
->bus_mA
= full_load
* hdev
->maxchild
;
1645 if (hdev
->bus_mA
>= full_load
)
1646 hub
->mA_per_port
= full_load
;
1648 hub
->mA_per_port
= hdev
->bus_mA
;
1649 hub
->limited_power
= 1;
1651 } else if ((hubstatus
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) { // bus powered
1652 int remaining
= hdev
->bus_mA
-
1653 hub
->descriptor
->bHubContrCurrent
;
1655 dev_dbg(hub_dev
, "hub controller current requirement: %dmA\n",
1656 hub
->descriptor
->bHubContrCurrent
);
1657 hub
->limited_power
= 1;
1659 if (remaining
< hdev
->maxchild
* unit_load
){
1660 #if defined(CONFIG_USBIF_COMPLIANCE) && defined(CONFIG_USB_XHCI_HCD)
1661 usbif_u3h_send_event("DEV_OVER_CURRENT");
1664 "insufficient power available "
1665 "to use all downstream ports\n");
1667 hub
->mA_per_port
= unit_load
; /* 7.2.1 */
1669 } else { /* Self-powered external hub */
1670 /* FIXME: What about battery-powered external hubs that
1671 * provide less current per port? */
1672 hub
->mA_per_port
= full_load
;
1674 if (hub
->mA_per_port
< full_load
)
1675 dev_dbg(hub_dev
, "%umA bus power budget for each child\n",
1678 /* Update the HCD's internal representation of this hub before khubd
1679 * starts getting port status changes for devices under the hub.
1681 if (hcd
->driver
->update_hub_device
) {
1682 ret
= hcd
->driver
->update_hub_device(hcd
, hdev
,
1683 &hub
->tt
, GFP_KERNEL
);
1685 message
= "can't update HCD hub info";
1690 ret
= hub_hub_status(hub
, &hubstatus
, &hubchange
);
1692 message
= "can't get hub status";
1696 /* local power status reports aren't always correct */
1697 if (hdev
->actconfig
->desc
.bmAttributes
& USB_CONFIG_ATT_SELFPOWER
)
1698 dev_dbg(hub_dev
, "local power source is %s\n",
1699 (hubstatus
& HUB_STATUS_LOCAL_POWER
)
1700 ? "lost (inactive)" : "good");
1702 if ((wHubCharacteristics
& HUB_CHAR_OCPM
) == 0)
1703 dev_dbg(hub_dev
, "%sover-current condition exists\n",
1704 (hubstatus
& HUB_STATUS_OVERCURRENT
) ? "" : "no ");
1706 /* set up the interrupt endpoint
1707 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1708 * bytes as USB2.0[11.12.3] says because some hubs are known
1709 * to send more data (and thus cause overflow). For root hubs,
1710 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1711 * to be big enough for at least USB_MAXCHILDREN ports. */
1712 pipe
= usb_rcvintpipe(hdev
, endpoint
->bEndpointAddress
);
1713 maxp
= usb_maxpacket(hdev
, pipe
, usb_pipeout(pipe
));
1715 if (maxp
> sizeof(*hub
->buffer
))
1716 maxp
= sizeof(*hub
->buffer
);
1718 hub
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
1724 usb_fill_int_urb(hub
->urb
, hdev
, pipe
, *hub
->buffer
, maxp
, hub_irq
,
1725 hub
, endpoint
->bInterval
);
1727 /* maybe cycle the hub leds */
1728 if (hub
->has_indicators
&& blinkenlights
)
1729 hub
->indicator
[0] = INDICATOR_CYCLE
;
1731 for (i
= 0; i
< hdev
->maxchild
; i
++) {
1732 ret
= usb_hub_create_port_device(hub
, i
+ 1);
1734 dev_err(hub
->intfdev
,
1735 "couldn't create port%d device.\n", i
+ 1);
1737 goto fail_keep_maxchild
;
1741 usb_hub_adjust_deviceremovable(hdev
, hub
->descriptor
);
1743 hub_activate(hub
, HUB_INIT
);
1749 dev_err (hub_dev
, "config failed, %s (err %d)\n",
1751 /* hub_disconnect() frees urb and descriptor */
1755 static void hub_release(struct kref
*kref
)
1757 struct usb_hub
*hub
= container_of(kref
, struct usb_hub
, kref
);
1759 usb_put_intf(to_usb_interface(hub
->intfdev
));
1763 static unsigned highspeed_hubs
;
1765 static void hub_disconnect(struct usb_interface
*intf
)
1767 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1768 struct usb_device
*hdev
= interface_to_usbdev(intf
);
1771 /* Take the hub off the event list and don't let it be added again */
1772 spin_lock_irq(&hub_event_lock
);
1773 if (!list_empty(&hub
->event_list
)) {
1774 list_del_init(&hub
->event_list
);
1775 usb_autopm_put_interface_no_suspend(intf
);
1777 hub
->disconnected
= 1;
1778 spin_unlock_irq(&hub_event_lock
);
1780 /* Disconnect all children and quiesce the hub */
1782 hub_quiesce(hub
, HUB_DISCONNECT
);
1784 /* Avoid races with recursively_mark_NOTATTACHED() */
1785 spin_lock_irq(&device_state_lock
);
1786 port1
= hdev
->maxchild
;
1788 usb_set_intfdata(intf
, NULL
);
1789 spin_unlock_irq(&device_state_lock
);
1791 for (; port1
> 0; --port1
)
1792 usb_hub_remove_port_device(hub
, port1
);
1794 if (hub
->hdev
->speed
== USB_SPEED_HIGH
)
1797 usb_free_urb(hub
->urb
);
1799 kfree(hub
->descriptor
);
1803 pm_suspend_ignore_children(&intf
->dev
, false);
1804 kref_put(&hub
->kref
, hub_release
);
1807 static int hub_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
1809 struct usb_host_interface
*desc
;
1810 struct usb_endpoint_descriptor
*endpoint
;
1811 struct usb_device
*hdev
;
1812 struct usb_hub
*hub
;
1815 desc
= intf
->cur_altsetting
;
1816 hdev
= interface_to_usbdev(intf
);
1819 * Set default autosuspend delay as 0 to speedup bus suspend,
1820 * based on the below considerations:
1822 * - Unlike other drivers, the hub driver does not rely on the
1823 * autosuspend delay to provide enough time to handle a wakeup
1824 * event, and the submitted status URB is just to check future
1825 * change on hub downstream ports, so it is safe to do it.
1827 * - The patch might cause one or more auto supend/resume for
1828 * below very rare devices when they are plugged into hub
1831 * devices having trouble initializing, and disconnect
1832 * themselves from the bus and then reconnect a second
1835 * devices just for downloading firmware, and disconnects
1836 * themselves after completing it
1838 * For these quite rare devices, their drivers may change the
1839 * autosuspend delay of their parent hub in the probe() to one
1840 * appropriate value to avoid the subtle problem if someone
1843 * - The patch may cause one or more auto suspend/resume on
1844 * hub during running 'lsusb', but it is probably too
1845 * infrequent to worry about.
1847 * - Change autosuspend delay of hub can avoid unnecessary auto
1848 * suspend timer for hub, also may decrease power consumption
1851 * - If user has indicated to prevent autosuspend by passing
1852 * usbcore.autosuspend = -1 then keep autosuspend disabled.
1854 #ifdef CONFIG_PM_RUNTIME
1855 if (hdev
->dev
.power
.autosuspend_delay
>= 0)
1856 pm_runtime_set_autosuspend_delay(&hdev
->dev
, 0);
1860 * Hubs have proper suspend/resume support, except for root hubs
1861 * where the controller driver doesn't have bus_suspend and
1862 * bus_resume methods.
1864 if (hdev
->parent
) { /* normal device */
1865 usb_enable_autosuspend(hdev
);
1866 } else { /* root hub */
1867 const struct hc_driver
*drv
= bus_to_hcd(hdev
->bus
)->driver
;
1869 if (drv
->bus_suspend
&& drv
->bus_resume
)
1870 usb_enable_autosuspend(hdev
);
1873 if (hdev
->level
== MAX_TOPO_LEVEL
) {
1875 "Unsupported bus topology: hub nested too deep\n");
1876 #if defined(CONFIG_USBIF_COMPLIANCE) && defined(CONFIG_USB_XHCI_HCD)
1877 usbif_u3h_send_event("MAX_HUB_TIER_EXCEED");
1882 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1884 dev_warn(&intf
->dev
, "ignoring external hub\n");
1885 #if defined(CONFIG_USBIF_COMPLIANCE) && defined(CONFIG_USB_XHCI_HCD)
1886 usbif_u3h_send_event("HUB_NOT_SUPPORTED");
1892 /* Some hubs have a subclass of 1, which AFAICT according to the */
1893 /* specs is not defined, but it works */
1894 if ((desc
->desc
.bInterfaceSubClass
!= 0) &&
1895 (desc
->desc
.bInterfaceSubClass
!= 1)) {
1897 dev_err (&intf
->dev
, "bad descriptor, ignoring hub\n");
1901 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1902 if (desc
->desc
.bNumEndpoints
!= 1)
1903 goto descriptor_error
;
1905 endpoint
= &desc
->endpoint
[0].desc
;
1907 /* If it's not an interrupt in endpoint, we'd better punt! */
1908 if (!usb_endpoint_is_int_in(endpoint
))
1909 goto descriptor_error
;
1911 /* We found a hub */
1912 dev_info (&intf
->dev
, "USB hub found\n");
1914 hub
= kzalloc(sizeof(*hub
), GFP_KERNEL
);
1916 dev_dbg (&intf
->dev
, "couldn't kmalloc hub struct\n");
1920 kref_init(&hub
->kref
);
1921 INIT_LIST_HEAD(&hub
->event_list
);
1922 hub
->intfdev
= &intf
->dev
;
1924 INIT_DELAYED_WORK(&hub
->leds
, led_work
);
1925 INIT_DELAYED_WORK(&hub
->init_work
, NULL
);
1928 usb_set_intfdata (intf
, hub
);
1929 intf
->needs_remote_wakeup
= 1;
1930 pm_suspend_ignore_children(&intf
->dev
, true);
1932 if (hdev
->speed
== USB_SPEED_HIGH
)
1935 if (id
->driver_info
& HUB_QUIRK_CHECK_PORT_AUTOSUSPEND
)
1936 hub
->quirk_check_port_auto_suspend
= 1;
1938 if (hub_configure(hub
, endpoint
) >= 0)
1941 hub_disconnect (intf
);
1946 hub_ioctl(struct usb_interface
*intf
, unsigned int code
, void *user_data
)
1948 struct usb_device
*hdev
= interface_to_usbdev (intf
);
1949 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1951 /* assert ifno == 0 (part of hub spec) */
1953 case USBDEVFS_HUB_PORTINFO
: {
1954 struct usbdevfs_hub_portinfo
*info
= user_data
;
1957 spin_lock_irq(&device_state_lock
);
1958 if (hdev
->devnum
<= 0)
1961 info
->nports
= hdev
->maxchild
;
1962 for (i
= 0; i
< info
->nports
; i
++) {
1963 if (hub
->ports
[i
]->child
== NULL
)
1967 hub
->ports
[i
]->child
->devnum
;
1970 spin_unlock_irq(&device_state_lock
);
1972 return info
->nports
+ 1;
1981 * Allow user programs to claim ports on a hub. When a device is attached
1982 * to one of these "claimed" ports, the program will "own" the device.
1984 static int find_port_owner(struct usb_device
*hdev
, unsigned port1
,
1985 struct dev_state
***ppowner
)
1987 if (hdev
->state
== USB_STATE_NOTATTACHED
)
1989 if (port1
== 0 || port1
> hdev
->maxchild
)
1992 /* This assumes that devices not managed by the hub driver
1993 * will always have maxchild equal to 0.
1995 *ppowner
= &(usb_hub_to_struct_hub(hdev
)->ports
[port1
- 1]->port_owner
);
1999 /* In the following three functions, the caller must hold hdev's lock */
2000 int usb_hub_claim_port(struct usb_device
*hdev
, unsigned port1
,
2001 struct dev_state
*owner
)
2004 struct dev_state
**powner
;
2006 rc
= find_port_owner(hdev
, port1
, &powner
);
2015 int usb_hub_release_port(struct usb_device
*hdev
, unsigned port1
,
2016 struct dev_state
*owner
)
2019 struct dev_state
**powner
;
2021 rc
= find_port_owner(hdev
, port1
, &powner
);
2024 if (*powner
!= owner
)
2030 void usb_hub_release_all_ports(struct usb_device
*hdev
, struct dev_state
*owner
)
2032 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
2035 for (n
= 0; n
< hdev
->maxchild
; n
++) {
2036 if (hub
->ports
[n
]->port_owner
== owner
)
2037 hub
->ports
[n
]->port_owner
= NULL
;
2042 /* The caller must hold udev's lock */
2043 bool usb_device_is_owned(struct usb_device
*udev
)
2045 struct usb_hub
*hub
;
2047 if (udev
->state
== USB_STATE_NOTATTACHED
|| !udev
->parent
)
2049 hub
= usb_hub_to_struct_hub(udev
->parent
);
2050 return !!hub
->ports
[udev
->portnum
- 1]->port_owner
;
2053 static void recursively_mark_NOTATTACHED(struct usb_device
*udev
)
2055 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
2058 for (i
= 0; i
< udev
->maxchild
; ++i
) {
2059 if (hub
->ports
[i
]->child
)
2060 recursively_mark_NOTATTACHED(hub
->ports
[i
]->child
);
2062 if (udev
->state
== USB_STATE_SUSPENDED
)
2063 udev
->active_duration
-= jiffies
;
2064 udev
->state
= USB_STATE_NOTATTACHED
;
2068 * usb_set_device_state - change a device's current state (usbcore, hcds)
2069 * @udev: pointer to device whose state should be changed
2070 * @new_state: new state value to be stored
2072 * udev->state is _not_ fully protected by the device lock. Although
2073 * most transitions are made only while holding the lock, the state can
2074 * can change to USB_STATE_NOTATTACHED at almost any time. This
2075 * is so that devices can be marked as disconnected as soon as possible,
2076 * without having to wait for any semaphores to be released. As a result,
2077 * all changes to any device's state must be protected by the
2078 * device_state_lock spinlock.
2080 * Once a device has been added to the device tree, all changes to its state
2081 * should be made using this routine. The state should _not_ be set directly.
2083 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
2084 * Otherwise udev->state is set to new_state, and if new_state is
2085 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
2086 * to USB_STATE_NOTATTACHED.
2088 void usb_set_device_state(struct usb_device
*udev
,
2089 enum usb_device_state new_state
)
2091 unsigned long flags
;
2094 spin_lock_irqsave(&device_state_lock
, flags
);
2095 if (udev
->state
== USB_STATE_NOTATTACHED
)
2097 else if (new_state
!= USB_STATE_NOTATTACHED
) {
2099 /* root hub wakeup capabilities are managed out-of-band
2100 * and may involve silicon errata ... ignore them here.
2103 if (udev
->state
== USB_STATE_SUSPENDED
2104 || new_state
== USB_STATE_SUSPENDED
)
2105 ; /* No change to wakeup settings */
2106 else if (new_state
== USB_STATE_CONFIGURED
)
2107 wakeup
= udev
->actconfig
->desc
.bmAttributes
2108 & USB_CONFIG_ATT_WAKEUP
;
2112 if (udev
->state
== USB_STATE_SUSPENDED
&&
2113 new_state
!= USB_STATE_SUSPENDED
)
2114 udev
->active_duration
-= jiffies
;
2115 else if (new_state
== USB_STATE_SUSPENDED
&&
2116 udev
->state
!= USB_STATE_SUSPENDED
)
2117 udev
->active_duration
+= jiffies
;
2118 udev
->state
= new_state
;
2120 recursively_mark_NOTATTACHED(udev
);
2121 spin_unlock_irqrestore(&device_state_lock
, flags
);
2123 device_set_wakeup_capable(&udev
->dev
, wakeup
);
2125 EXPORT_SYMBOL_GPL(usb_set_device_state
);
2128 * Choose a device number.
2130 * Device numbers are used as filenames in usbfs. On USB-1.1 and
2131 * USB-2.0 buses they are also used as device addresses, however on
2132 * USB-3.0 buses the address is assigned by the controller hardware
2133 * and it usually is not the same as the device number.
2135 * WUSB devices are simple: they have no hubs behind, so the mapping
2136 * device <-> virtual port number becomes 1:1. Why? to simplify the
2137 * life of the device connection logic in
2138 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
2139 * handshake we need to assign a temporary address in the unauthorized
2140 * space. For simplicity we use the first virtual port number found to
2141 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
2142 * and that becomes it's address [X < 128] or its unauthorized address
2145 * We add 1 as an offset to the one-based USB-stack port number
2146 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
2147 * 0 is reserved by USB for default address; (b) Linux's USB stack
2148 * uses always #1 for the root hub of the controller. So USB stack's
2149 * port #1, which is wusb virtual-port #0 has address #2.
2151 * Devices connected under xHCI are not as simple. The host controller
2152 * supports virtualization, so the hardware assigns device addresses and
2153 * the HCD must setup data structures before issuing a set address
2154 * command to the hardware.
2156 static void choose_devnum(struct usb_device
*udev
)
2159 struct usb_bus
*bus
= udev
->bus
;
2161 /* If khubd ever becomes multithreaded, this will need a lock */
2163 devnum
= udev
->portnum
+ 1;
2164 BUG_ON(test_bit(devnum
, bus
->devmap
.devicemap
));
2166 /* Try to allocate the next devnum beginning at
2167 * bus->devnum_next. */
2168 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
, 128,
2171 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
,
2173 bus
->devnum_next
= ( devnum
>= 127 ? 1 : devnum
+ 1);
2176 set_bit(devnum
, bus
->devmap
.devicemap
);
2177 udev
->devnum
= devnum
;
2181 static void release_devnum(struct usb_device
*udev
)
2183 if (udev
->devnum
> 0) {
2184 clear_bit(udev
->devnum
, udev
->bus
->devmap
.devicemap
);
2189 static void update_devnum(struct usb_device
*udev
, int devnum
)
2191 /* The address for a WUSB device is managed by wusbcore. */
2193 udev
->devnum
= devnum
;
2196 static void hub_free_dev(struct usb_device
*udev
)
2198 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2200 /* Root hubs aren't real devices, so don't free HCD resources */
2201 if (hcd
->driver
->free_dev
&& udev
->parent
)
2202 hcd
->driver
->free_dev(hcd
, udev
);
2206 * usb_disconnect - disconnect a device (usbcore-internal)
2207 * @pdev: pointer to device being disconnected
2208 * Context: !in_interrupt ()
2210 * Something got disconnected. Get rid of it and all of its children.
2212 * If *pdev is a normal device then the parent hub must already be locked.
2213 * If *pdev is a root hub then this routine will acquire the
2214 * usb_bus_list_lock on behalf of the caller.
2216 * Only hub drivers (including virtual root hub drivers for host
2217 * controllers) should ever call this.
2219 * This call is synchronous, and may not be used in an interrupt context.
2221 void usb_disconnect(struct usb_device
**pdev
)
2223 struct usb_device
*udev
= *pdev
;
2224 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
2226 struct timeval tv_begin
, tv_end
;
2227 struct timeval tv_before
, tv_after
;
2228 do_gettimeofday(&tv_begin
);
2230 #ifdef CONFIG_MTK_ICUSB_SUPPORT
2234 #ifdef CONFIG_MTK_ICUSB_SUPPORT
2235 is_icusb_rh
= is_musbfsh_rh(udev
->parent
);
2239 /* mark the device as inactive, so any further urb submissions for
2240 * this device (and any of its children) will fail immediately.
2241 * this quiesces everything except pending urbs.
2243 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2244 dev_info(&udev
->dev
, "USB disconnect, device number %d\n",
2247 usb_lock_device(udev
);
2249 /* Free up all the children before we remove this device */
2250 for (i
= 0; i
< udev
->maxchild
; i
++) {
2251 if (hub
->ports
[i
]->child
)
2252 usb_disconnect(&hub
->ports
[i
]->child
);
2255 /* deallocate hcd/hardware state ... nuking all pending urbs and
2256 * cleaning up all state associated with the current configuration
2257 * so that the hardware is now fully quiesced.
2259 dev_dbg (&udev
->dev
, "unregistering device\n");
2261 do_gettimeofday(&tv_before
);
2262 usb_disable_device(udev
, 0);
2263 do_gettimeofday(&tv_after
);
2264 MYDBG("usb_disable_device(), time spent, sec : %d, usec : %d\n", (unsigned int)(tv_after
.tv_sec
- tv_before
.tv_sec
), (unsigned int)(tv_after
.tv_usec
- tv_before
.tv_usec
));
2266 usb_hcd_synchronize_unlinks(udev
);
2269 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
2270 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
2272 sysfs_remove_link(&udev
->dev
.kobj
, "port");
2273 sysfs_remove_link(&port_dev
->dev
.kobj
, "device");
2275 if (!port_dev
->did_runtime_put
)
2276 pm_runtime_put(&port_dev
->dev
);
2278 port_dev
->did_runtime_put
= false;
2281 do_gettimeofday(&tv_before
);
2282 usb_remove_ep_devs(&udev
->ep0
);
2283 do_gettimeofday(&tv_after
);
2284 MYDBG("usb_remove_ep_devs(), time spent, sec : %d, usec : %d\n", (unsigned int)(tv_after
.tv_sec
- tv_before
.tv_sec
), (unsigned int)(tv_after
.tv_usec
- tv_before
.tv_usec
));
2286 usb_unlock_device(udev
);
2288 /* Unregister the device. The device driver is responsible
2289 * for de-configuring the device and invoking the remove-device
2290 * notifier chain (used by usbfs and possibly others).
2292 do_gettimeofday(&tv_before
);
2293 device_del(&udev
->dev
);
2294 do_gettimeofday(&tv_after
);
2295 MYDBG("device_del(), time spent, sec : %d, usec : %d\n", (unsigned int)(tv_after
.tv_sec
- tv_before
.tv_sec
), (unsigned int)(tv_after
.tv_usec
- tv_before
.tv_usec
));
2297 /* Free the device number and delete the parent's children[]
2298 * (or root_hub) pointer.
2300 release_devnum(udev
);
2302 /* Avoid races with recursively_mark_NOTATTACHED() */
2303 spin_lock_irq(&device_state_lock
);
2305 spin_unlock_irq(&device_state_lock
);
2309 put_device(&udev
->dev
);
2311 #ifdef CONFIG_MTK_ICUSB_SUPPORT
2314 set_icusb_sts_disconnect_done();
2315 MYDBG("ICUSB Disconnect\n");
2318 do_gettimeofday(&tv_end
);
2319 MYDBG("time spent, sec : %d, usec : %d\n", (unsigned int)(tv_end
.tv_sec
- tv_begin
.tv_sec
), (unsigned int)(tv_end
.tv_usec
- tv_begin
.tv_usec
));
2322 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2323 static void show_string(struct usb_device
*udev
, char *id
, char *string
)
2327 dev_info(&udev
->dev
, "%s: %s\n", id
, string
);
2330 static void announce_device(struct usb_device
*udev
)
2332 dev_info(&udev
->dev
, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2333 le16_to_cpu(udev
->descriptor
.idVendor
),
2334 le16_to_cpu(udev
->descriptor
.idProduct
));
2335 dev_info(&udev
->dev
,
2336 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2337 udev
->descriptor
.iManufacturer
,
2338 udev
->descriptor
.iProduct
,
2339 udev
->descriptor
.iSerialNumber
);
2340 show_string(udev
, "Product", udev
->product
);
2341 show_string(udev
, "Manufacturer", udev
->manufacturer
);
2342 show_string(udev
, "SerialNumber", udev
->serial
);
2345 static inline void announce_device(struct usb_device
*udev
) { }
2348 #ifdef CONFIG_USB_OTG
2349 #include "otg_whitelist.h"
2353 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2354 * @udev: newly addressed device (in ADDRESS state)
2356 * Finish enumeration for On-The-Go devices
2358 static int usb_enumerate_device_otg(struct usb_device
*udev
)
2362 #ifdef CONFIG_USB_OTG
2364 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2365 * to wake us after we've powered off VBUS; and HNP, switching roles
2366 * "host" to "peripheral". The OTG descriptor helps figure this out.
2368 if (!udev
->bus
->is_b_host
2370 && udev
->parent
== udev
->bus
->root_hub
) {
2371 struct usb_otg_descriptor
*desc
= NULL
;
2372 struct usb_bus
*bus
= udev
->bus
;
2374 /* descriptor may appear anywhere in config */
2375 if (__usb_get_extra_descriptor (udev
->rawdescriptors
[0],
2376 le16_to_cpu(udev
->config
[0].desc
.wTotalLength
),
2377 USB_DT_OTG
, (void **) &desc
) == 0) {
2378 if (desc
->bmAttributes
& USB_OTG_HNP
) {
2379 unsigned port1
= udev
->portnum
;
2381 dev_info(&udev
->dev
,
2382 "Dual-Role OTG device on %sHNP port\n",
2383 (port1
== bus
->otg_port
)
2386 /* enable HNP before suspend, it's simpler */
2387 if (port1
== bus
->otg_port
)
2388 bus
->b_hnp_enable
= 1;
2389 err
= usb_control_msg(udev
,
2390 usb_sndctrlpipe(udev
, 0),
2391 USB_REQ_SET_FEATURE
, 0,
2393 ? USB_DEVICE_B_HNP_ENABLE
2394 : USB_DEVICE_A_ALT_HNP_SUPPORT
,
2395 0, NULL
, 0, USB_CTRL_SET_TIMEOUT
);
2397 /* OTG MESSAGE: report errors here,
2398 * customize to match your product.
2400 dev_info(&udev
->dev
,
2401 "can't set HNP mode: %d\n",
2403 bus
->b_hnp_enable
= 0;
2409 if (!is_targeted(udev
)) {
2411 /* Maybe it can talk to us, though we can't talk to it.
2412 * (Includes HNP test device.)
2414 if (udev
->bus
->b_hnp_enable
|| udev
->bus
->is_b_host
) {
2415 err
= usb_port_suspend(udev
, PMSG_SUSPEND
);
2417 dev_dbg(&udev
->dev
, "HNP fail, %d\n", err
);
2429 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2430 * @udev: newly addressed device (in ADDRESS state)
2432 * This is only called by usb_new_device() and usb_authorize_device()
2433 * and FIXME -- all comments that apply to them apply here wrt to
2436 * If the device is WUSB and not authorized, we don't attempt to read
2437 * the string descriptors, as they will be errored out by the device
2438 * until it has been authorized.
2440 static int usb_enumerate_device(struct usb_device
*udev
)
2444 if (udev
->config
== NULL
) {
2445 err
= usb_get_configuration(udev
);
2448 dev_err(&udev
->dev
, "can't read configurations, error %d\n",
2454 /* read the standard strings and cache them if present */
2455 udev
->product
= usb_cache_string(udev
, udev
->descriptor
.iProduct
);
2456 udev
->manufacturer
= usb_cache_string(udev
,
2457 udev
->descriptor
.iManufacturer
);
2458 udev
->serial
= usb_cache_string(udev
, udev
->descriptor
.iSerialNumber
);
2460 err
= usb_enumerate_device_otg(udev
);
2462 #if defined(CONFIG_USBIF_COMPLIANCE) && defined(CONFIG_USB_XHCI_HCD)
2463 if (udev
->parent
){ // we don't have to check ourself (roothub)
2464 if (!is_targeted(udev
)) {
2465 usbif_u3h_send_event("DEV_NOT_SUPPORTED");
2474 usb_detect_interface_quirks(udev
);
2479 static void set_usb_port_removable(struct usb_device
*udev
)
2481 struct usb_device
*hdev
= udev
->parent
;
2482 struct usb_hub
*hub
;
2483 u8 port
= udev
->portnum
;
2484 u16 wHubCharacteristics
;
2485 bool removable
= true;
2490 hub
= usb_hub_to_struct_hub(udev
->parent
);
2492 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
2494 if (!(wHubCharacteristics
& HUB_CHAR_COMPOUND
))
2497 if (hub_is_superspeed(hdev
)) {
2498 if (le16_to_cpu(hub
->descriptor
->u
.ss
.DeviceRemovable
)
2502 if (hub
->descriptor
->u
.hs
.DeviceRemovable
[port
/ 8] & (1 << (port
% 8)))
2507 udev
->removable
= USB_DEVICE_REMOVABLE
;
2509 udev
->removable
= USB_DEVICE_FIXED
;
2513 * usb_new_device - perform initial device setup (usbcore-internal)
2514 * @udev: newly addressed device (in ADDRESS state)
2516 * This is called with devices which have been detected but not fully
2517 * enumerated. The device descriptor is available, but not descriptors
2518 * for any device configuration. The caller must have locked either
2519 * the parent hub (if udev is a normal device) or else the
2520 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
2521 * udev has already been installed, but udev is not yet visible through
2522 * sysfs or other filesystem code.
2524 * It will return if the device is configured properly or not. Zero if
2525 * the interface was registered with the driver core; else a negative
2528 * This call is synchronous, and may not be used in an interrupt context.
2530 * Only the hub driver or root-hub registrar should ever call this.
2532 int usb_new_device(struct usb_device
*udev
)
2537 /* Initialize non-root-hub device wakeup to disabled;
2538 * device (un)configuration controls wakeup capable
2539 * sysfs power/wakeup controls wakeup enabled/disabled
2541 device_init_wakeup(&udev
->dev
, 0);
2542 MYDBG("udev :%p\n", udev
);
2543 #ifdef CONFIG_MTK_DT_USB_SUPPORT
2544 #ifdef CONFIG_PM_RUNTIME
2545 if(is_musbfsh_rh(udev
->parent
)){
2547 /*find out struct *usb_hub and hook it */
2548 usb11_hub
= usb_hub_to_struct_hub(udev
->parent
);
2554 /* Tell the runtime-PM framework the device is active */
2555 pm_runtime_set_active(&udev
->dev
);
2556 pm_runtime_get_noresume(&udev
->dev
);
2557 pm_runtime_use_autosuspend(&udev
->dev
);
2558 pm_runtime_enable(&udev
->dev
);
2560 /* By default, forbid autosuspend for all devices. It will be
2561 * allowed for hubs during binding.
2563 usb_disable_autosuspend(udev
);
2565 err
= usb_enumerate_device(udev
); /* Read descriptors */
2568 dev_dbg(&udev
->dev
, "udev %d, busnum %d, minor = %d\n",
2569 udev
->devnum
, udev
->bus
->busnum
,
2570 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
2571 /* export the usbdev device-node for libusb */
2572 udev
->dev
.devt
= MKDEV(USB_DEVICE_MAJOR
,
2573 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
2575 /* Tell the world! */
2576 announce_device(udev
);
2579 add_device_randomness(udev
->serial
, strlen(udev
->serial
));
2581 add_device_randomness(udev
->product
, strlen(udev
->product
));
2582 if (udev
->manufacturer
)
2583 add_device_randomness(udev
->manufacturer
,
2584 strlen(udev
->manufacturer
));
2586 device_enable_async_suspend(&udev
->dev
);
2589 * check whether the hub marks this port as non-removable. Do it
2590 * now so that platform-specific data can override it in
2594 set_usb_port_removable(udev
);
2596 /* Register the device. The device driver is responsible
2597 * for configuring the device and invoking the add-device
2598 * notifier chain (used by usbfs and possibly others).
2600 err
= device_add(&udev
->dev
);
2602 dev_err(&udev
->dev
, "can't device_add, error %d\n", err
);
2606 /* Create link files between child device and usb port device. */
2608 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
2609 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
2611 err
= sysfs_create_link(&udev
->dev
.kobj
,
2612 &port_dev
->dev
.kobj
, "port");
2616 err
= sysfs_create_link(&port_dev
->dev
.kobj
,
2617 &udev
->dev
.kobj
, "device");
2619 sysfs_remove_link(&udev
->dev
.kobj
, "port");
2623 pm_runtime_get_sync(&port_dev
->dev
);
2626 (void) usb_create_ep_devs(&udev
->dev
, &udev
->ep0
, udev
);
2627 usb_mark_last_busy(udev
);
2628 pm_runtime_put_sync_autosuspend(&udev
->dev
);
2632 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2633 pm_runtime_disable(&udev
->dev
);
2634 pm_runtime_set_suspended(&udev
->dev
);
2640 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2641 * @usb_dev: USB device
2643 * Move the USB device to a very basic state where interfaces are disabled
2644 * and the device is in fact unconfigured and unusable.
2646 * We share a lock (that we have) with device_del(), so we need to
2649 int usb_deauthorize_device(struct usb_device
*usb_dev
)
2651 usb_lock_device(usb_dev
);
2652 if (usb_dev
->authorized
== 0)
2653 goto out_unauthorized
;
2655 usb_dev
->authorized
= 0;
2656 usb_set_configuration(usb_dev
, -1);
2659 usb_unlock_device(usb_dev
);
2664 int usb_authorize_device(struct usb_device
*usb_dev
)
2668 usb_lock_device(usb_dev
);
2669 if (usb_dev
->authorized
== 1)
2670 goto out_authorized
;
2672 result
= usb_autoresume_device(usb_dev
);
2674 dev_err(&usb_dev
->dev
,
2675 "can't autoresume for authorization: %d\n", result
);
2676 goto error_autoresume
;
2678 result
= usb_get_device_descriptor(usb_dev
, sizeof(usb_dev
->descriptor
));
2680 dev_err(&usb_dev
->dev
, "can't re-read device descriptor for "
2681 "authorization: %d\n", result
);
2682 goto error_device_descriptor
;
2685 usb_dev
->authorized
= 1;
2686 /* Choose and set the configuration. This registers the interfaces
2687 * with the driver core and lets interface drivers bind to them.
2689 c
= usb_choose_configuration(usb_dev
);
2691 result
= usb_set_configuration(usb_dev
, c
);
2693 dev_err(&usb_dev
->dev
,
2694 "can't set config #%d, error %d\n", c
, result
);
2695 /* This need not be fatal. The user can try to
2696 * set other configurations. */
2699 dev_info(&usb_dev
->dev
, "authorized to connect\n");
2701 error_device_descriptor
:
2702 usb_autosuspend_device(usb_dev
);
2705 usb_unlock_device(usb_dev
); // complements locktree
2710 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2711 static unsigned hub_is_wusb(struct usb_hub
*hub
)
2713 struct usb_hcd
*hcd
;
2714 if (hub
->hdev
->parent
!= NULL
) /* not a root hub? */
2716 hcd
= container_of(hub
->hdev
->bus
, struct usb_hcd
, self
);
2717 return hcd
->wireless
;
2721 #define PORT_RESET_TRIES 5
2722 #define SET_ADDRESS_TRIES 2
2723 #define GET_DESCRIPTOR_TRIES 2
2724 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2725 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2727 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2728 #define HUB_SHORT_RESET_TIME 10
2729 #define HUB_BH_RESET_TIME 50
2730 #define HUB_LONG_RESET_TIME 200
2731 #define HUB_RESET_TIMEOUT 800
2733 static int hub_port_reset(struct usb_hub
*hub
, int port1
,
2734 struct usb_device
*udev
, unsigned int delay
, bool warm
);
2736 /* Is a USB 3.0 port in the Inactive or Complinance Mode state?
2737 * Port worm reset is required to recover
2739 static bool hub_port_warm_reset_required(struct usb_hub
*hub
, u16 portstatus
)
2741 return hub_is_superspeed(hub
->hdev
) &&
2742 (((portstatus
& USB_PORT_STAT_LINK_STATE
) ==
2743 USB_SS_PORT_LS_SS_INACTIVE
) ||
2744 ((portstatus
& USB_PORT_STAT_LINK_STATE
) ==
2745 USB_SS_PORT_LS_COMP_MOD
)) ;
2748 static int hub_port_wait_reset(struct usb_hub
*hub
, int port1
,
2749 struct usb_device
*udev
, unsigned int delay
, bool warm
)
2751 int delay_time
, ret
;
2755 for (delay_time
= 0;
2756 delay_time
< HUB_RESET_TIMEOUT
;
2757 delay_time
+= delay
) {
2758 /* wait to give the device a chance to reset */
2761 /* read and decode port status */
2763 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
2768 /* The port state is unknown until the reset completes. */
2769 if (!(portstatus
& USB_PORT_STAT_RESET
))
2772 /* switch to the long delay after two short delay failures */
2773 if (delay_time
>= 2 * HUB_SHORT_RESET_TIME
)
2774 delay
= HUB_LONG_RESET_TIME
;
2776 dev_dbg (hub
->intfdev
,
2777 "port %d not %sreset yet, waiting %dms\n",
2778 port1
, warm
? "warm " : "", delay
);
2781 if ((portstatus
& USB_PORT_STAT_RESET
))
2784 if (hub_port_warm_reset_required(hub
, portstatus
))
2787 /* Device went away? */
2788 if (!(portstatus
& USB_PORT_STAT_CONNECTION
))
2791 /* bomb out completely if the connection bounced. A USB 3.0
2792 * connection may bounce if multiple warm resets were issued,
2793 * but the device may have successfully re-connected. Ignore it.
2795 if (!hub_is_superspeed(hub
->hdev
) &&
2796 (portchange
& USB_PORT_STAT_C_CONNECTION
))
2799 if (!(portstatus
& USB_PORT_STAT_ENABLE
))
2805 if (hub_is_wusb(hub
))
2806 udev
->speed
= USB_SPEED_WIRELESS
;
2807 else if (hub_is_superspeed(hub
->hdev
))
2808 udev
->speed
= USB_SPEED_SUPER
;
2809 else if (portstatus
& USB_PORT_STAT_HIGH_SPEED
)
2810 udev
->speed
= USB_SPEED_HIGH
;
2811 else if (portstatus
& USB_PORT_STAT_LOW_SPEED
)
2812 udev
->speed
= USB_SPEED_LOW
;
2814 udev
->speed
= USB_SPEED_FULL
;
2818 static void hub_port_finish_reset(struct usb_hub
*hub
, int port1
,
2819 struct usb_device
*udev
, int *status
)
2823 /* TRSTRCY = 10 ms; plus some extra */
2826 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2828 update_devnum(udev
, 0);
2829 /* The xHC may think the device is already reset,
2830 * so ignore the status.
2832 if (hcd
->driver
->reset_device
)
2833 hcd
->driver
->reset_device(hcd
, udev
);
2838 usb_clear_port_feature(hub
->hdev
,
2839 port1
, USB_PORT_FEAT_C_RESET
);
2840 if (hub_is_superspeed(hub
->hdev
)) {
2841 usb_clear_port_feature(hub
->hdev
, port1
,
2842 USB_PORT_FEAT_C_BH_PORT_RESET
);
2843 usb_clear_port_feature(hub
->hdev
, port1
,
2844 USB_PORT_FEAT_C_PORT_LINK_STATE
);
2845 usb_clear_port_feature(hub
->hdev
, port1
,
2846 USB_PORT_FEAT_C_CONNECTION
);
2849 usb_set_device_state(udev
, *status
2850 ? USB_STATE_NOTATTACHED
2851 : USB_STATE_DEFAULT
);
2856 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2857 static int hub_port_reset(struct usb_hub
*hub
, int port1
,
2858 struct usb_device
*udev
, unsigned int delay
, bool warm
)
2861 u16 portchange
, portstatus
;
2863 if (!hub_is_superspeed(hub
->hdev
)) {
2865 dev_err(hub
->intfdev
, "only USB3 hub support "
2869 /* Block EHCI CF initialization during the port reset.
2870 * Some companion controllers don't like it when they mix.
2872 down_read(&ehci_cf_port_reset_rwsem
);
2875 * If the caller hasn't explicitly requested a warm reset,
2876 * double check and see if one is needed.
2878 status
= hub_port_status(hub
, port1
,
2879 &portstatus
, &portchange
);
2883 if (hub_port_warm_reset_required(hub
, portstatus
))
2887 /* Reset the port */
2888 for (i
= 0; i
< PORT_RESET_TRIES
; i
++) {
2890 status
= set_port_feature(hub
->hdev
, port1
, (warm
?
2891 USB_PORT_FEAT_BH_PORT_RESET
:
2892 USB_PORT_FEAT_RESET
));
2894 if (status
== -ENODEV
) {
2896 ; /* The hub is gone */
2897 } else if (status
) {
2899 dev_err(hub
->intfdev
,
2900 "cannot %sreset port %d (err = %d)\n",
2901 warm
? "warm " : "", port1
, status
);
2904 status
= hub_port_wait_reset(hub
, port1
, udev
, delay
,
2906 if (status
&& status
!= -ENOTCONN
)
2909 dev_dbg(hub
->intfdev
,
2910 "port_wait_reset: err = %d\n",
2916 /* Check for disconnect or reset */
2917 if (status
== 0 || status
== -ENOTCONN
|| status
== -ENODEV
) {
2919 hub_port_finish_reset(hub
, port1
, udev
, &status
);
2922 if (!hub_is_superspeed(hub
->hdev
))
2926 * If a USB 3.0 device migrates from reset to an error
2927 * state, re-issue the warm reset.
2929 if (hub_port_status(hub
, port1
,
2930 &portstatus
, &portchange
) < 0)
2933 if (!hub_port_warm_reset_required(hub
, portstatus
))
2937 * If the port is in SS.Inactive or Compliance Mode, the
2938 * hot or warm reset failed. Try another warm reset.
2941 dev_dbg(hub
->intfdev
, "hot reset failed, warm reset port %d\n",
2948 dev_dbg (hub
->intfdev
,
2949 "port %d not enabled, trying %sreset again...\n",
2950 port1
, warm
? "warm " : "");
2951 delay
= HUB_LONG_RESET_TIME
;
2956 dev_err (hub
->intfdev
,
2957 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2961 if (!hub_is_superspeed(hub
->hdev
))
2964 up_read(&ehci_cf_port_reset_rwsem
);
2972 /* Check if a port is power on */
2973 static int port_is_power_on(struct usb_hub
*hub
, unsigned portstatus
)
2977 if (hub_is_superspeed(hub
->hdev
)) {
2978 if (portstatus
& USB_SS_PORT_STAT_POWER
)
2981 if (portstatus
& USB_PORT_STAT_POWER
)
2990 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2991 static int port_is_suspended(struct usb_hub
*hub
, unsigned portstatus
)
2995 if (hub_is_superspeed(hub
->hdev
)) {
2996 if ((portstatus
& USB_PORT_STAT_LINK_STATE
)
2997 == USB_SS_PORT_LS_U3
)
3000 if (portstatus
& USB_PORT_STAT_SUSPEND
)
3007 /* Determine whether the device on a port is ready for a normal resume,
3008 * is ready for a reset-resume, or should be disconnected.
3010 static int check_port_resume_type(struct usb_device
*udev
,
3011 struct usb_hub
*hub
, int port1
,
3012 int status
, unsigned portchange
, unsigned portstatus
)
3014 /* Is the device still present? */
3015 if (status
|| port_is_suspended(hub
, portstatus
) ||
3016 !port_is_power_on(hub
, portstatus
) ||
3017 !(portstatus
& USB_PORT_STAT_CONNECTION
)) {
3022 /* Can't do a normal resume if the port isn't enabled,
3023 * so try a reset-resume instead.
3025 else if (!(portstatus
& USB_PORT_STAT_ENABLE
) && !udev
->reset_resume
) {
3026 if (udev
->persist_enabled
)
3027 udev
->reset_resume
= 1;
3033 dev_dbg(hub
->intfdev
,
3034 "port %d status %04x.%04x after resume, %d\n",
3035 port1
, portchange
, portstatus
, status
);
3036 } else if (udev
->reset_resume
) {
3038 /* Late port handoff can set status-change bits */
3039 if (portchange
& USB_PORT_STAT_C_CONNECTION
)
3040 usb_clear_port_feature(hub
->hdev
, port1
,
3041 USB_PORT_FEAT_C_CONNECTION
);
3042 if (portchange
& USB_PORT_STAT_C_ENABLE
)
3043 usb_clear_port_feature(hub
->hdev
, port1
,
3044 USB_PORT_FEAT_C_ENABLE
);
3050 int usb_disable_ltm(struct usb_device
*udev
)
3052 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3054 /* Check if the roothub and device supports LTM. */
3055 if (!usb_device_supports_ltm(hcd
->self
.root_hub
) ||
3056 !usb_device_supports_ltm(udev
))
3059 /* Clear Feature LTM Enable can only be sent if the device is
3062 if (!udev
->actconfig
)
3065 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3066 USB_REQ_CLEAR_FEATURE
, USB_RECIP_DEVICE
,
3067 USB_DEVICE_LTM_ENABLE
, 0, NULL
, 0,
3068 USB_CTRL_SET_TIMEOUT
);
3070 EXPORT_SYMBOL_GPL(usb_disable_ltm
);
3072 void usb_enable_ltm(struct usb_device
*udev
)
3074 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3076 /* Check if the roothub and device supports LTM. */
3077 if (!usb_device_supports_ltm(hcd
->self
.root_hub
) ||
3078 !usb_device_supports_ltm(udev
))
3081 /* Set Feature LTM Enable can only be sent if the device is
3084 if (!udev
->actconfig
)
3087 usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3088 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
3089 USB_DEVICE_LTM_ENABLE
, 0, NULL
, 0,
3090 USB_CTRL_SET_TIMEOUT
);
3092 EXPORT_SYMBOL_GPL(usb_enable_ltm
);
3096 * usb_disable_function_remotewakeup - disable usb3.0
3097 * device's function remote wakeup
3098 * @udev: target device
3100 * Assume there's only one function on the USB 3.0
3101 * device and disable remote wake for the first
3102 * interface. FIXME if the interface association
3103 * descriptor shows there's more than one function.
3105 static int usb_disable_function_remotewakeup(struct usb_device
*udev
)
3107 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3108 USB_REQ_CLEAR_FEATURE
, USB_RECIP_INTERFACE
,
3109 USB_INTRF_FUNC_SUSPEND
, 0, NULL
, 0,
3110 USB_CTRL_SET_TIMEOUT
);
3113 /* Count of wakeup-enabled devices at or below udev */
3114 static unsigned wakeup_enabled_descendants(struct usb_device
*udev
)
3116 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
3118 return udev
->do_remote_wakeup
+
3119 (hub
? hub
->wakeup_enabled_descendants
: 0);
3123 * usb_port_suspend - suspend a usb device's upstream port
3124 * @udev: device that's no longer in active use, not a root hub
3125 * Context: must be able to sleep; device not locked; pm locks held
3127 * Suspends a USB device that isn't in active use, conserving power.
3128 * Devices may wake out of a suspend, if anything important happens,
3129 * using the remote wakeup mechanism. They may also be taken out of
3130 * suspend by the host, using usb_port_resume(). It's also routine
3131 * to disconnect devices while they are suspended.
3133 * This only affects the USB hardware for a device; its interfaces
3134 * (and, for hubs, child devices) must already have been suspended.
3136 * Selective port suspend reduces power; most suspended devices draw
3137 * less than 500 uA. It's also used in OTG, along with remote wakeup.
3138 * All devices below the suspended port are also suspended.
3140 * Devices leave suspend state when the host wakes them up. Some devices
3141 * also support "remote wakeup", where the device can activate the USB
3142 * tree above them to deliver data, such as a keypress or packet. In
3143 * some cases, this wakes the USB host.
3145 * Suspending OTG devices may trigger HNP, if that's been enabled
3146 * between a pair of dual-role devices. That will change roles, such
3147 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
3149 * Devices on USB hub ports have only one "suspend" state, corresponding
3150 * to ACPI D2, "may cause the device to lose some context".
3151 * State transitions include:
3153 * - suspend, resume ... when the VBUS power link stays live
3154 * - suspend, disconnect ... VBUS lost
3156 * Once VBUS drop breaks the circuit, the port it's using has to go through
3157 * normal re-enumeration procedures, starting with enabling VBUS power.
3158 * Other than re-initializing the hub (plug/unplug, except for root hubs),
3159 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
3160 * timer, no SRP, no requests through sysfs.
3162 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
3163 * suspended until their bus goes into global suspend (i.e., the root
3164 * hub is suspended). Nevertheless, we change @udev->state to
3165 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
3166 * upstream port setting is stored in @udev->port_is_suspended.
3168 * Returns 0 on success, else negative errno.
3170 int usb_port_suspend(struct usb_device
*udev
, pm_message_t msg
)
3172 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
3173 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
3174 int port1
= udev
->portnum
;
3176 bool really_suspend
= true;
3178 /* enable remote wakeup when appropriate; this lets the device
3179 * wake up the upstream hub (including maybe the root hub).
3181 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
3182 * we don't explicitly enable it here.
3184 if (udev
->do_remote_wakeup
) {
3185 if (!hub_is_superspeed(hub
->hdev
)) {
3186 status
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3187 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
3188 USB_DEVICE_REMOTE_WAKEUP
, 0,
3190 USB_CTRL_SET_TIMEOUT
);
3192 /* Assume there's only one function on the USB 3.0
3193 * device and enable remote wake for the first
3194 * interface. FIXME if the interface association
3195 * descriptor shows there's more than one function.
3197 status
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3198 USB_REQ_SET_FEATURE
,
3199 USB_RECIP_INTERFACE
,
3200 USB_INTRF_FUNC_SUSPEND
,
3201 USB_INTRF_FUNC_SUSPEND_RW
|
3202 USB_INTRF_FUNC_SUSPEND_LP
,
3204 USB_CTRL_SET_TIMEOUT
);
3207 dev_dbg(&udev
->dev
, "won't remote wakeup, status %d\n",
3209 /* bail if autosuspend is requested */
3210 if (PMSG_IS_AUTO(msg
))
3218 /* disable USB2 hardware LPM */
3219 if (udev
->usb2_hw_lpm_enabled
== 1)
3220 usb_set_usb2_hardware_lpm(udev
, 0);
3222 if (usb_disable_ltm(udev
)) {
3223 dev_err(&udev
->dev
, "Failed to disable LTM before suspend\n.");
3226 if (PMSG_IS_AUTO(msg
))
3229 if (usb_unlocked_disable_lpm(udev
)) {
3230 dev_err(&udev
->dev
, "Failed to disable LPM before suspend\n.");
3233 if (PMSG_IS_AUTO(msg
))
3238 if (hub_is_superspeed(hub
->hdev
))
3241 status
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_U3
);
3243 #if 0 /* behavior for kernel 3.10 */
3245 * For system suspend, we do not need to enable the suspend feature
3246 * on individual USB-2 ports. The devices will automatically go
3247 * into suspend a few ms after the root hub stops sending packets.
3248 * The USB 2.0 spec calls this "global suspend".
3250 * However, many USB hubs have a bug: They don't relay wakeup requests
3251 * from a downstream port if the port's suspend feature isn't on.
3252 * Therefore we will turn on the suspend feature if udev or any of its
3253 * descendants is enabled for remote wakeup.
3255 } else if (PMSG_IS_AUTO(msg
) || wakeup_enabled_descendants(udev
) > 0) {
3257 status
= set_port_feature(hub
->hdev
, port1
,
3258 USB_PORT_FEAT_SUSPEND
);
3260 really_suspend
= false;
3263 #else /*roll back behavior to kernel 3.4 */
3266 status
= set_port_feature(hub
->hdev
, port1
,
3267 USB_PORT_FEAT_SUSPEND
);
3272 dev_dbg(hub
->intfdev
, "can't suspend port %d, status %d\n",
3276 /* Try to enable USB3 LPM and LTM again */
3277 usb_unlocked_enable_lpm(udev
);
3279 usb_enable_ltm(udev
);
3281 /* Try to enable USB2 hardware LPM again */
3282 if (udev
->usb2_hw_lpm_capable
== 1)
3283 usb_set_usb2_hardware_lpm(udev
, 1);
3285 if (udev
->do_remote_wakeup
) {
3286 if (udev
->speed
< USB_SPEED_SUPER
)
3287 usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3288 USB_REQ_CLEAR_FEATURE
,
3290 USB_DEVICE_REMOTE_WAKEUP
, 0,
3291 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
3293 usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3294 USB_REQ_CLEAR_FEATURE
,
3295 USB_RECIP_INTERFACE
,
3296 USB_INTRF_FUNC_SUSPEND
, 0,
3297 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
3301 /* System sleep transitions should never fail */
3302 if (!PMSG_IS_AUTO(msg
))
3305 dev_dbg(&udev
->dev
, "usb %ssuspend, wakeup %d\n",
3306 (PMSG_IS_AUTO(msg
) ? "auto-" : ""),
3307 udev
->do_remote_wakeup
);
3308 if (really_suspend
) {
3309 udev
->port_is_suspended
= 1;
3311 /* device has up to 10 msec to fully suspend */
3314 usb_set_device_state(udev
, USB_STATE_SUSPENDED
);
3317 if (status
== 0 && !udev
->do_remote_wakeup
&& udev
->persist_enabled
) {
3318 pm_runtime_put_sync(&port_dev
->dev
);
3319 port_dev
->did_runtime_put
= true;
3322 usb_mark_last_busy(hub
->hdev
);
3327 * If the USB "suspend" state is in use (rather than "global suspend"),
3328 * many devices will be individually taken out of suspend state using
3329 * special "resume" signaling. This routine kicks in shortly after
3330 * hardware resume signaling is finished, either because of selective
3331 * resume (by host) or remote wakeup (by device) ... now see what changed
3332 * in the tree that's rooted at this device.
3334 * If @udev->reset_resume is set then the device is reset before the
3335 * status check is done.
3337 static int finish_port_resume(struct usb_device
*udev
)
3342 /* caller owns the udev device lock */
3343 dev_dbg(&udev
->dev
, "%s\n",
3344 udev
->reset_resume
? "finish reset-resume" : "finish resume");
3346 /* usb ch9 identifies four variants of SUSPENDED, based on what
3347 * state the device resumes to. Linux currently won't see the
3348 * first two on the host side; they'd be inside hub_port_init()
3349 * during many timeouts, but khubd can't suspend until later.
3351 usb_set_device_state(udev
, udev
->actconfig
3352 ? USB_STATE_CONFIGURED
3353 : USB_STATE_ADDRESS
);
3355 /* 10.5.4.5 says not to reset a suspended port if the attached
3356 * device is enabled for remote wakeup. Hence the reset
3357 * operation is carried out here, after the port has been
3360 if (udev
->reset_resume
)
3362 status
= usb_reset_and_verify_device(udev
);
3364 /* 10.5.4.5 says be sure devices in the tree are still there.
3365 * For now let's assume the device didn't go crazy on resume,
3366 * and device drivers will know about any resume quirks.
3371 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0, &devstatus
);
3372 MYDBG("%d\n", status
);
3374 status
= (status
> 0 ? 0 : -ENODEV
);
3376 /* If a normal resume failed, try doing a reset-resume */
3377 if (status
&& !udev
->reset_resume
&& udev
->persist_enabled
) {
3378 dev_dbg(&udev
->dev
, "retry with reset-resume\n");
3379 udev
->reset_resume
= 1;
3380 goto retry_reset_resume
;
3385 dev_dbg(&udev
->dev
, "gone after usb resume? status %d\n",
3388 * There are a few quirky devices which violate the standard
3389 * by claiming to have remote wakeup enabled after a reset,
3390 * which crash if the feature is cleared, hence check for
3391 * udev->reset_resume
3393 } else if (udev
->actconfig
&& !udev
->reset_resume
) {
3394 if (!hub_is_superspeed(udev
->parent
)) {
3395 le16_to_cpus(&devstatus
);
3396 if (devstatus
& (1 << USB_DEVICE_REMOTE_WAKEUP
))
3397 status
= usb_control_msg(udev
,
3398 usb_sndctrlpipe(udev
, 0),
3399 USB_REQ_CLEAR_FEATURE
,
3401 USB_DEVICE_REMOTE_WAKEUP
, 0,
3403 USB_CTRL_SET_TIMEOUT
);
3405 status
= usb_get_status(udev
, USB_RECIP_INTERFACE
, 0,
3407 le16_to_cpus(&devstatus
);
3408 if (!status
&& devstatus
& (USB_INTRF_STAT_FUNC_RW_CAP
3409 | USB_INTRF_STAT_FUNC_RW
))
3411 usb_disable_function_remotewakeup(udev
);
3416 "disable remote wakeup, status %d\n",
3424 * There are some SS USB devices which take longer time for link training.
3425 * XHCI specs 4.19.4 says that when Link training is successful, port
3426 * sets CSC bit to 1. So if SW reads port status before successful link
3427 * training, then it will not find device to be present.
3428 * USB Analyzer log with such buggy devices show that in some cases
3429 * device switch on the RX termination after long delay of host enabling
3430 * the VBUS. In few other cases it has been seen that device fails to
3431 * negotiate link training in first attempt. It has been
3432 * reported till now that few devices take as long as 2000 ms to train
3433 * the link after host enabling its VBUS and termination. Following
3434 * routine implements a 2000 ms timeout for link training. If in a case
3435 * link trains before timeout, loop will exit earlier.
3437 * FIXME: If a device was connected before suspend, but was removed
3438 * while system was asleep, then the loop in the following routine will
3439 * only exit at timeout.
3441 * This routine should only be called when persist is enabled for a SS
3444 static int wait_for_ss_port_enable(struct usb_device
*udev
,
3445 struct usb_hub
*hub
, int *port1
,
3446 u16
*portchange
, u16
*portstatus
)
3448 int status
= 0, delay_ms
= 0;
3450 while (delay_ms
< 2000) {
3451 if (status
|| *portstatus
& USB_PORT_STAT_CONNECTION
)
3455 status
= hub_port_status(hub
, *port1
, portstatus
, portchange
);
3461 * usb_port_resume - re-activate a suspended usb device's upstream port
3462 * @udev: device to re-activate, not a root hub
3463 * Context: must be able to sleep; device not locked; pm locks held
3465 * This will re-activate the suspended device, increasing power usage
3466 * while letting drivers communicate again with its endpoints.
3467 * USB resume explicitly guarantees that the power session between
3468 * the host and the device is the same as it was when the device
3471 * If @udev->reset_resume is set then this routine won't check that the
3472 * port is still enabled. Furthermore, finish_port_resume() above will
3473 * reset @udev. The end result is that a broken power session can be
3474 * recovered and @udev will appear to persist across a loss of VBUS power.
3476 * For example, if a host controller doesn't maintain VBUS suspend current
3477 * during a system sleep or is reset when the system wakes up, all the USB
3478 * power sessions below it will be broken. This is especially troublesome
3479 * for mass-storage devices containing mounted filesystems, since the
3480 * device will appear to have disconnected and all the memory mappings
3481 * to it will be lost. Using the USB_PERSIST facility, the device can be
3482 * made to appear as if it had not disconnected.
3484 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3485 * every effort to insure that the same device is present after the
3486 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3487 * quite possible for a device to remain unaltered but its media to be
3488 * changed. If the user replaces a flash memory card while the system is
3489 * asleep, he will have only himself to blame when the filesystem on the
3490 * new card is corrupted and the system crashes.
3492 * Returns 0 on success, else negative errno.
3494 int usb_port_resume(struct usb_device
*udev
, pm_message_t msg
)
3496 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
3497 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
3498 int port1
= udev
->portnum
;
3500 u16 portchange
, portstatus
;
3502 if (port_dev
->did_runtime_put
) {
3503 status
= pm_runtime_get_sync(&port_dev
->dev
);
3504 port_dev
->did_runtime_put
= false;
3506 dev_dbg(&udev
->dev
, "can't resume usb port, status %d\n",
3512 /* Skip the initial Clear-Suspend step for a remote wakeup */
3513 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3514 if (status
== 0 && !port_is_suspended(hub
, portstatus
))
3515 goto SuspendCleared
;
3517 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
3519 set_bit(port1
, hub
->busy_bits
);
3521 /* see 7.1.7.7; affects power usage, but not budgeting */
3522 if (hub_is_superspeed(hub
->hdev
))
3523 status
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_U0
);
3525 status
= usb_clear_port_feature(hub
->hdev
,
3526 port1
, USB_PORT_FEAT_SUSPEND
);
3528 dev_dbg(hub
->intfdev
, "can't resume port %d, status %d\n",
3531 /* drive resume for at least 20 msec */
3532 dev_dbg(&udev
->dev
, "usb %sresume\n",
3533 (PMSG_IS_AUTO(msg
) ? "auto-" : ""));
3536 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3537 * stop resume signaling. Then finish the resume
3540 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3542 /* TRSMRCY = 10 msec */
3548 udev
->port_is_suspended
= 0;
3549 if (hub_is_superspeed(hub
->hdev
)) {
3550 if (portchange
& USB_PORT_STAT_C_LINK_STATE
)
3551 usb_clear_port_feature(hub
->hdev
, port1
,
3552 USB_PORT_FEAT_C_PORT_LINK_STATE
);
3554 if (portchange
& USB_PORT_STAT_C_SUSPEND
)
3555 usb_clear_port_feature(hub
->hdev
, port1
,
3556 USB_PORT_FEAT_C_SUSPEND
);
3560 clear_bit(port1
, hub
->busy_bits
);
3562 if (udev
->persist_enabled
&& hub_is_superspeed(hub
->hdev
))
3563 status
= wait_for_ss_port_enable(udev
, hub
, &port1
, &portchange
,
3566 status
= check_port_resume_type(udev
,
3567 hub
, port1
, status
, portchange
, portstatus
);
3569 status
= finish_port_resume(udev
);
3571 dev_dbg(&udev
->dev
, "can't resume, status %d\n", status
);
3572 hub_port_logical_disconnect(hub
, port1
);
3574 /* Try to enable USB2 hardware LPM */
3575 if (udev
->usb2_hw_lpm_capable
== 1)
3576 usb_set_usb2_hardware_lpm(udev
, 1);
3578 /* Try to enable USB3 LTM and LPM */
3579 usb_enable_ltm(udev
);
3580 usb_unlocked_enable_lpm(udev
);
3586 #endif /* CONFIG_PM */
3588 #ifdef CONFIG_PM_RUNTIME
3590 /* caller has locked udev */
3591 int usb_remote_wakeup(struct usb_device
*udev
)
3595 if (udev
->state
== USB_STATE_SUSPENDED
) {
3596 dev_dbg(&udev
->dev
, "usb %sresume\n", "wakeup-");
3597 status
= usb_autoresume_device(udev
);
3599 /* Let the drivers do their thing, then... */
3600 usb_autosuspend_device(udev
);
3608 static int check_ports_changed(struct usb_hub
*hub
)
3612 for (port1
= 1; port1
<= hub
->hdev
->maxchild
; ++port1
) {
3613 u16 portstatus
, portchange
;
3616 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3617 if (!status
&& portchange
)
3623 static int hub_suspend(struct usb_interface
*intf
, pm_message_t msg
)
3625 struct usb_hub
*hub
= usb_get_intfdata (intf
);
3626 struct usb_device
*hdev
= hub
->hdev
;
3631 * Warn if children aren't already suspended.
3632 * Also, add up the number of wakeup-enabled descendants.
3634 hub
->wakeup_enabled_descendants
= 0;
3635 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
3636 struct usb_device
*udev
;
3638 udev
= hub
->ports
[port1
- 1]->child
;
3639 if (udev
&& udev
->can_submit
) {
3640 dev_warn(&intf
->dev
, "port %d nyet suspended\n", port1
);
3641 if (PMSG_IS_AUTO(msg
))
3645 hub
->wakeup_enabled_descendants
+=
3646 wakeup_enabled_descendants(udev
);
3649 if (hdev
->do_remote_wakeup
&& hub
->quirk_check_port_auto_suspend
) {
3650 /* check if there are changes pending on hub ports */
3651 if (check_ports_changed(hub
)) {
3652 if (PMSG_IS_AUTO(msg
))
3654 pm_wakeup_event(&hdev
->dev
, 2000);
3658 if (hub_is_superspeed(hdev
) && hdev
->do_remote_wakeup
) {
3659 /* Enable hub to send remote wakeup for all ports. */
3660 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
3661 status
= set_port_feature(hdev
,
3663 USB_PORT_FEAT_REMOTE_WAKE_CONNECT
|
3664 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT
|
3665 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT
,
3666 USB_PORT_FEAT_REMOTE_WAKE_MASK
);
3670 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3672 /* stop khubd and related activity */
3673 hub_quiesce(hub
, HUB_SUSPEND
);
3677 static int hub_resume(struct usb_interface
*intf
)
3679 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3681 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3682 hub_activate(hub
, HUB_RESUME
);
3686 static int hub_reset_resume(struct usb_interface
*intf
)
3688 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3690 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3691 hub_activate(hub
, HUB_RESET_RESUME
);
3696 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3697 * @rhdev: struct usb_device for the root hub
3699 * The USB host controller driver calls this function when its root hub
3700 * is resumed and Vbus power has been interrupted or the controller
3701 * has been reset. The routine marks @rhdev as having lost power.
3702 * When the hub driver is resumed it will take notice and carry out
3703 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3704 * the others will be disconnected.
3706 void usb_root_hub_lost_power(struct usb_device
*rhdev
)
3708 dev_warn(&rhdev
->dev
, "root hub lost power or was reset\n");
3709 rhdev
->reset_resume
= 1;
3711 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power
);
3713 static const char * const usb3_lpm_names
[] = {
3721 * Send a Set SEL control transfer to the device, prior to enabling
3722 * device-initiated U1 or U2. This lets the device know the exit latencies from
3723 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3724 * packet from the host.
3726 * This function will fail if the SEL or PEL values for udev are greater than
3727 * the maximum allowed values for the link state to be enabled.
3729 static int usb_req_set_sel(struct usb_device
*udev
, enum usb3_link_state state
)
3731 struct usb_set_sel_req
*sel_values
;
3732 unsigned long long u1_sel
;
3733 unsigned long long u1_pel
;
3734 unsigned long long u2_sel
;
3735 unsigned long long u2_pel
;
3738 /* Convert SEL and PEL stored in ns to us */
3739 u1_sel
= DIV_ROUND_UP(udev
->u1_params
.sel
, 1000);
3740 u1_pel
= DIV_ROUND_UP(udev
->u1_params
.pel
, 1000);
3741 u2_sel
= DIV_ROUND_UP(udev
->u2_params
.sel
, 1000);
3742 u2_pel
= DIV_ROUND_UP(udev
->u2_params
.pel
, 1000);
3745 * Make sure that the calculated SEL and PEL values for the link
3746 * state we're enabling aren't bigger than the max SEL/PEL
3747 * value that will fit in the SET SEL control transfer.
3748 * Otherwise the device would get an incorrect idea of the exit
3749 * latency for the link state, and could start a device-initiated
3750 * U1/U2 when the exit latencies are too high.
3752 if ((state
== USB3_LPM_U1
&&
3753 (u1_sel
> USB3_LPM_MAX_U1_SEL_PEL
||
3754 u1_pel
> USB3_LPM_MAX_U1_SEL_PEL
)) ||
3755 (state
== USB3_LPM_U2
&&
3756 (u2_sel
> USB3_LPM_MAX_U2_SEL_PEL
||
3757 u2_pel
> USB3_LPM_MAX_U2_SEL_PEL
))) {
3758 dev_dbg(&udev
->dev
, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3759 usb3_lpm_names
[state
], u1_sel
, u1_pel
);
3764 * If we're enabling device-initiated LPM for one link state,
3765 * but the other link state has a too high SEL or PEL value,
3766 * just set those values to the max in the Set SEL request.
3768 if (u1_sel
> USB3_LPM_MAX_U1_SEL_PEL
)
3769 u1_sel
= USB3_LPM_MAX_U1_SEL_PEL
;
3771 if (u1_pel
> USB3_LPM_MAX_U1_SEL_PEL
)
3772 u1_pel
= USB3_LPM_MAX_U1_SEL_PEL
;
3774 if (u2_sel
> USB3_LPM_MAX_U2_SEL_PEL
)
3775 u2_sel
= USB3_LPM_MAX_U2_SEL_PEL
;
3777 if (u2_pel
> USB3_LPM_MAX_U2_SEL_PEL
)
3778 u2_pel
= USB3_LPM_MAX_U2_SEL_PEL
;
3781 * usb_enable_lpm() can be called as part of a failed device reset,
3782 * which may be initiated by an error path of a mass storage driver.
3783 * Therefore, use GFP_NOIO.
3785 sel_values
= kmalloc(sizeof *(sel_values
), GFP_NOIO
);
3789 sel_values
->u1_sel
= u1_sel
;
3790 sel_values
->u1_pel
= u1_pel
;
3791 sel_values
->u2_sel
= cpu_to_le16(u2_sel
);
3792 sel_values
->u2_pel
= cpu_to_le16(u2_pel
);
3794 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3798 sel_values
, sizeof *(sel_values
),
3799 USB_CTRL_SET_TIMEOUT
);
3805 * Enable or disable device-initiated U1 or U2 transitions.
3807 static int usb_set_device_initiated_lpm(struct usb_device
*udev
,
3808 enum usb3_link_state state
, bool enable
)
3815 feature
= USB_DEVICE_U1_ENABLE
;
3818 feature
= USB_DEVICE_U2_ENABLE
;
3821 dev_warn(&udev
->dev
, "%s: Can't %s non-U1 or U2 state.\n",
3822 __func__
, enable
? "enable" : "disable");
3826 if (udev
->state
!= USB_STATE_CONFIGURED
) {
3827 dev_dbg(&udev
->dev
, "%s: Can't %s %s state "
3828 "for unconfigured device.\n",
3829 __func__
, enable
? "enable" : "disable",
3830 usb3_lpm_names
[state
]);
3836 * Now send the control transfer to enable device-initiated LPM
3837 * for either U1 or U2.
3839 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3840 USB_REQ_SET_FEATURE
,
3844 USB_CTRL_SET_TIMEOUT
);
3846 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3847 USB_REQ_CLEAR_FEATURE
,
3851 USB_CTRL_SET_TIMEOUT
);
3854 dev_warn(&udev
->dev
, "%s of device-initiated %s failed.\n",
3855 enable
? "Enable" : "Disable",
3856 usb3_lpm_names
[state
]);
3862 static int usb_set_lpm_timeout(struct usb_device
*udev
,
3863 enum usb3_link_state state
, int timeout
)
3870 feature
= USB_PORT_FEAT_U1_TIMEOUT
;
3873 feature
= USB_PORT_FEAT_U2_TIMEOUT
;
3876 dev_warn(&udev
->dev
, "%s: Can't set timeout for non-U1 or U2 state.\n",
3881 if (state
== USB3_LPM_U1
&& timeout
> USB3_LPM_U1_MAX_TIMEOUT
&&
3882 timeout
!= USB3_LPM_DEVICE_INITIATED
) {
3883 dev_warn(&udev
->dev
, "Failed to set %s timeout to 0x%x, "
3884 "which is a reserved value.\n",
3885 usb3_lpm_names
[state
], timeout
);
3889 ret
= set_port_feature(udev
->parent
,
3890 USB_PORT_LPM_TIMEOUT(timeout
) | udev
->portnum
,
3893 dev_warn(&udev
->dev
, "Failed to set %s timeout to 0x%x,"
3894 "error code %i\n", usb3_lpm_names
[state
],
3898 if (state
== USB3_LPM_U1
)
3899 udev
->u1_params
.timeout
= timeout
;
3901 udev
->u2_params
.timeout
= timeout
;
3906 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3909 * We will attempt to enable U1 or U2, but there are no guarantees that the
3910 * control transfers to set the hub timeout or enable device-initiated U1/U2
3911 * will be successful.
3913 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3914 * driver know about it. If that call fails, it should be harmless, and just
3915 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3917 static void usb_enable_link_state(struct usb_hcd
*hcd
, struct usb_device
*udev
,
3918 enum usb3_link_state state
)
3921 __u8 u1_mel
= udev
->bos
->ss_cap
->bU1devExitLat
;
3922 __le16 u2_mel
= udev
->bos
->ss_cap
->bU2DevExitLat
;
3924 /* If the device says it doesn't have *any* exit latency to come out of
3925 * U1 or U2, it's probably lying. Assume it doesn't implement that link
3928 if ((state
== USB3_LPM_U1
&& u1_mel
== 0) ||
3929 (state
== USB3_LPM_U2
&& u2_mel
== 0))
3933 * First, let the device know about the exit latencies
3934 * associated with the link state we're about to enable.
3936 ret
= usb_req_set_sel(udev
, state
);
3938 dev_warn(&udev
->dev
, "Set SEL for device-initiated %s failed.\n",
3939 usb3_lpm_names
[state
]);
3943 /* We allow the host controller to set the U1/U2 timeout internally
3944 * first, so that it can change its schedule to account for the
3945 * additional latency to send data to a device in a lower power
3948 timeout
= hcd
->driver
->enable_usb3_lpm_timeout(hcd
, udev
, state
);
3950 /* xHCI host controller doesn't want to enable this LPM state. */
3955 dev_warn(&udev
->dev
, "Could not enable %s link state, "
3956 "xHCI error %i.\n", usb3_lpm_names
[state
],
3961 if (usb_set_lpm_timeout(udev
, state
, timeout
))
3962 /* If we can't set the parent hub U1/U2 timeout,
3963 * device-initiated LPM won't be allowed either, so let the xHCI
3964 * host know that this link state won't be enabled.
3966 hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
);
3968 /* Only a configured device will accept the Set Feature U1/U2_ENABLE */
3969 else if (udev
->actconfig
)
3970 usb_set_device_initiated_lpm(udev
, state
, true);
3975 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
3978 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
3979 * If zero is returned, the parent will not allow the link to go into U1/U2.
3981 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
3982 * it won't have an effect on the bus link state because the parent hub will
3983 * still disallow device-initiated U1/U2 entry.
3985 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
3986 * possible. The result will be slightly more bus bandwidth will be taken up
3987 * (to account for U1/U2 exit latency), but it should be harmless.
3989 static int usb_disable_link_state(struct usb_hcd
*hcd
, struct usb_device
*udev
,
3990 enum usb3_link_state state
)
3996 feature
= USB_PORT_FEAT_U1_TIMEOUT
;
3999 feature
= USB_PORT_FEAT_U2_TIMEOUT
;
4002 dev_warn(&udev
->dev
, "%s: Can't disable non-U1 or U2 state.\n",
4007 if (usb_set_lpm_timeout(udev
, state
, 0))
4010 usb_set_device_initiated_lpm(udev
, state
, false);
4012 if (hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
))
4013 dev_warn(&udev
->dev
, "Could not disable xHCI %s timeout, "
4014 "bus schedule bandwidth may be impacted.\n",
4015 usb3_lpm_names
[state
]);
4020 * Disable hub-initiated and device-initiated U1 and U2 entry.
4021 * Caller must own the bandwidth_mutex.
4023 * This will call usb_enable_lpm() on failure, which will decrement
4024 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
4026 int usb_disable_lpm(struct usb_device
*udev
)
4028 struct usb_hcd
*hcd
;
4030 if (!udev
|| !udev
->parent
||
4031 udev
->speed
!= USB_SPEED_SUPER
||
4035 hcd
= bus_to_hcd(udev
->bus
);
4036 if (!hcd
|| !hcd
->driver
->disable_usb3_lpm_timeout
)
4039 udev
->lpm_disable_count
++;
4040 if ((udev
->u1_params
.timeout
== 0 && udev
->u2_params
.timeout
== 0))
4043 /* If LPM is enabled, attempt to disable it. */
4044 if (usb_disable_link_state(hcd
, udev
, USB3_LPM_U1
))
4046 if (usb_disable_link_state(hcd
, udev
, USB3_LPM_U2
))
4052 usb_enable_lpm(udev
);
4055 EXPORT_SYMBOL_GPL(usb_disable_lpm
);
4057 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
4058 int usb_unlocked_disable_lpm(struct usb_device
*udev
)
4060 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4066 mutex_lock(hcd
->bandwidth_mutex
);
4067 ret
= usb_disable_lpm(udev
);
4068 mutex_unlock(hcd
->bandwidth_mutex
);
4072 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm
);
4075 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
4076 * xHCI host policy may prevent U1 or U2 from being enabled.
4078 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
4079 * until the lpm_disable_count drops to zero. Caller must own the
4082 void usb_enable_lpm(struct usb_device
*udev
)
4084 struct usb_hcd
*hcd
;
4086 if (!udev
|| !udev
->parent
||
4087 udev
->speed
!= USB_SPEED_SUPER
||
4091 udev
->lpm_disable_count
--;
4092 hcd
= bus_to_hcd(udev
->bus
);
4093 /* Double check that we can both enable and disable LPM.
4094 * Device must be configured to accept set feature U1/U2 timeout.
4096 if (!hcd
|| !hcd
->driver
->enable_usb3_lpm_timeout
||
4097 !hcd
->driver
->disable_usb3_lpm_timeout
)
4100 if (udev
->lpm_disable_count
> 0)
4103 usb_enable_link_state(hcd
, udev
, USB3_LPM_U1
);
4104 usb_enable_link_state(hcd
, udev
, USB3_LPM_U2
);
4106 EXPORT_SYMBOL_GPL(usb_enable_lpm
);
4108 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
4109 void usb_unlocked_enable_lpm(struct usb_device
*udev
)
4111 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4116 mutex_lock(hcd
->bandwidth_mutex
);
4117 usb_enable_lpm(udev
);
4118 mutex_unlock(hcd
->bandwidth_mutex
);
4120 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm
);
4123 #else /* CONFIG_PM */
4125 #define hub_suspend NULL
4126 #define hub_resume NULL
4127 #define hub_reset_resume NULL
4129 int usb_disable_lpm(struct usb_device
*udev
)
4133 EXPORT_SYMBOL_GPL(usb_disable_lpm
);
4135 void usb_enable_lpm(struct usb_device
*udev
) { }
4136 EXPORT_SYMBOL_GPL(usb_enable_lpm
);
4138 int usb_unlocked_disable_lpm(struct usb_device
*udev
)
4142 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm
);
4144 void usb_unlocked_enable_lpm(struct usb_device
*udev
) { }
4145 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm
);
4147 int usb_disable_ltm(struct usb_device
*udev
)
4151 EXPORT_SYMBOL_GPL(usb_disable_ltm
);
4153 void usb_enable_ltm(struct usb_device
*udev
) { }
4154 EXPORT_SYMBOL_GPL(usb_enable_ltm
);
4158 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
4160 * Between connect detection and reset signaling there must be a delay
4161 * of 100ms at least for debounce and power-settling. The corresponding
4162 * timer shall restart whenever the downstream port detects a disconnect.
4164 * Apparently there are some bluetooth and irda-dongles and a number of
4165 * low-speed devices for which this debounce period may last over a second.
4166 * Not covered by the spec - but easy to deal with.
4168 * This implementation uses a 1500ms total debounce timeout; if the
4169 * connection isn't stable by then it returns -ETIMEDOUT. It checks
4170 * every 25ms for transient disconnects. When the port status has been
4171 * unchanged for 100ms it returns the port status.
4173 int hub_port_debounce(struct usb_hub
*hub
, int port1
, bool must_be_connected
)
4176 int total_time
, stable_time
= 0;
4177 u16 portchange
, portstatus
;
4178 unsigned connection
= 0xffff;
4180 for (total_time
= 0; ; total_time
+= HUB_DEBOUNCE_STEP
) {
4181 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
4185 if (!(portchange
& USB_PORT_STAT_C_CONNECTION
) &&
4186 (portstatus
& USB_PORT_STAT_CONNECTION
) == connection
) {
4187 if (!must_be_connected
||
4188 (connection
== USB_PORT_STAT_CONNECTION
))
4189 stable_time
+= HUB_DEBOUNCE_STEP
;
4190 if (stable_time
>= HUB_DEBOUNCE_STABLE
)
4194 connection
= portstatus
& USB_PORT_STAT_CONNECTION
;
4197 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
4198 usb_clear_port_feature(hub
->hdev
, port1
,
4199 USB_PORT_FEAT_C_CONNECTION
);
4202 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
4204 msleep(HUB_DEBOUNCE_STEP
);
4207 dev_dbg (hub
->intfdev
,
4208 "debounce: port %d: total %dms stable %dms status 0x%x\n",
4209 port1
, total_time
, stable_time
, portstatus
);
4211 if (stable_time
< HUB_DEBOUNCE_STABLE
)
4216 void usb_ep0_reinit(struct usb_device
*udev
)
4218 usb_disable_endpoint(udev
, 0 + USB_DIR_IN
, true);
4219 usb_disable_endpoint(udev
, 0 + USB_DIR_OUT
, true);
4220 usb_enable_endpoint(udev
, &udev
->ep0
, true);
4222 EXPORT_SYMBOL_GPL(usb_ep0_reinit
);
4225 static int hub_set_address(struct usb_device
*udev
, int devnum
)
4228 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4231 * The host controller will choose the device address,
4232 * instead of the core having chosen it earlier
4234 if (!hcd
->driver
->address_device
&& devnum
<= 1)
4236 if (udev
->state
== USB_STATE_ADDRESS
)
4238 if (udev
->state
!= USB_STATE_DEFAULT
)
4240 if (hcd
->driver
->address_device
)
4241 retval
= hcd
->driver
->address_device(hcd
, udev
);
4243 retval
= usb_control_msg(udev
, usb_sndaddr0pipe(),
4244 USB_REQ_SET_ADDRESS
, 0, devnum
, 0,
4245 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
4247 update_devnum(udev
, devnum
);
4248 /* Device now using proper address. */
4249 usb_set_device_state(udev
, USB_STATE_ADDRESS
);
4250 usb_ep0_reinit(udev
);
4255 /* Reset device, (re)assign address, get device descriptor.
4256 * Device connection must be stable, no more debouncing needed.
4257 * Returns device in USB_STATE_ADDRESS, except on error.
4259 * If this is called for an already-existing device (as part of
4260 * usb_reset_and_verify_device), the caller must own the device lock. For a
4261 * newly detected device that is not accessible through any global
4262 * pointers, it's not necessary to lock the device.
4265 hub_port_init (struct usb_hub
*hub
, struct usb_device
*udev
, int port1
,
4268 static DEFINE_MUTEX(usb_address0_mutex
);
4270 struct usb_device
*hdev
= hub
->hdev
;
4271 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
4273 unsigned delay
= HUB_SHORT_RESET_TIME
;
4274 enum usb_device_speed oldspeed
= udev
->speed
;
4276 int devnum
= udev
->devnum
;
4279 /* root hub ports have a slightly longer reset period
4280 * (from USB 2.0 spec, section 7.1.7.5)
4282 if (!hdev
->parent
) {
4283 delay
= HUB_ROOT_RESET_TIME
;
4284 if (port1
== hdev
->bus
->otg_port
)
4285 hdev
->bus
->b_hnp_enable
= 0;
4288 /* Some low speed devices have problems with the quick delay, so */
4289 /* be a bit pessimistic with those devices. RHbug #23670 */
4290 if (oldspeed
== USB_SPEED_LOW
)
4291 delay
= HUB_LONG_RESET_TIME
;
4293 mutex_lock(&usb_address0_mutex
);
4295 /* Reset the device; full speed may morph to high speed */
4296 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
4298 retval
= hub_port_reset(hub
, port1
, udev
, delay
, false);
4300 if (retval
< 0) /* error or disconnect */
4302 /* success, speed is known */
4306 if (oldspeed
!= USB_SPEED_UNKNOWN
&& oldspeed
!= udev
->speed
) {
4307 dev_dbg(&udev
->dev
, "device reset changed speed!\n");
4310 oldspeed
= udev
->speed
;
4312 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4313 * it's fixed size except for full speed devices.
4314 * For Wireless USB devices, ep0 max packet is always 512 (tho
4315 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4317 switch (udev
->speed
) {
4318 case USB_SPEED_SUPER
:
4319 case USB_SPEED_WIRELESS
: /* fixed at 512 */
4320 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(512);
4322 case USB_SPEED_HIGH
: /* fixed at 64 */
4323 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(64);
4325 case USB_SPEED_FULL
: /* 8, 16, 32, or 64 */
4326 /* to determine the ep0 maxpacket size, try to read
4327 * the device descriptor to get bMaxPacketSize0 and
4328 * then correct our initial guess.
4330 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(64);
4332 case USB_SPEED_LOW
: /* fixed at 8 */
4333 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(8);
4340 if (udev
->speed
== USB_SPEED_WIRELESS
)
4341 speed
= "variable speed Wireless";
4343 speed
= usb_speed_string(udev
->speed
);
4345 if (udev
->speed
!= USB_SPEED_SUPER
)
4346 dev_info(&udev
->dev
,
4347 "%s %s USB device number %d using %s\n",
4348 (udev
->config
) ? "reset" : "new", speed
,
4349 devnum
, udev
->bus
->controller
->driver
->name
);
4351 /* Set up TT records, if needed */
4353 udev
->tt
= hdev
->tt
;
4354 udev
->ttport
= hdev
->ttport
;
4355 } else if (udev
->speed
!= USB_SPEED_HIGH
4356 && hdev
->speed
== USB_SPEED_HIGH
) {
4358 dev_err(&udev
->dev
, "parent hub has no TT\n");
4362 udev
->tt
= &hub
->tt
;
4363 udev
->ttport
= port1
;
4366 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4367 * Because device hardware and firmware is sometimes buggy in
4368 * this area, and this is how Linux has done it for ages.
4369 * Change it cautiously.
4371 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
4372 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4373 * so it may help with some non-standards-compliant devices.
4374 * Otherwise we start with SET_ADDRESS and then try to read the
4375 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4378 for (i
= 0; i
< GET_DESCRIPTOR_TRIES
; (++i
, msleep(100))) {
4380 if (USE_NEW_SCHEME(retry_counter
) && !(hcd
->driver
->flags
& HCD_USB3
)) {
4381 struct usb_device_descriptor
*buf
;
4384 #define GET_DESCRIPTOR_BUFSIZE 64
4385 buf
= kmalloc(GET_DESCRIPTOR_BUFSIZE
, GFP_NOIO
);
4391 /* Retry on all errors; some devices are flakey.
4392 * 255 is for WUSB devices, we actually need to use
4393 * 512 (WUSB1.0[4.8.1]).
4395 for (j
= 0; j
< 3; ++j
) {
4396 buf
->bMaxPacketSize0
= 0;
4397 r
= usb_control_msg(udev
, usb_rcvaddr0pipe(),
4398 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
,
4399 USB_DT_DEVICE
<< 8, 0,
4400 buf
, GET_DESCRIPTOR_BUFSIZE
,
4401 initial_descriptor_timeout
);
4402 switch (buf
->bMaxPacketSize0
) {
4403 case 8: case 16: case 32: case 64: case 255:
4404 if (buf
->bDescriptorType
==
4418 #if defined(CONFIG_USBIF_COMPLIANCE) && defined(CONFIG_USB_XHCI_HCD)
4419 if (buf
->bMaxPacketSize0
== 0) {
4420 usbif_u3h_send_event("DEV_CONN_TMOUT");
4425 udev
->descriptor
.bMaxPacketSize0
=
4426 buf
->bMaxPacketSize0
;
4429 retval
= hub_port_reset(hub
, port1
, udev
, delay
, false);
4430 if (retval
< 0) /* error or disconnect */
4432 if (oldspeed
!= udev
->speed
) {
4434 "device reset changed speed!\n");
4440 dev_err(&udev
->dev
, "device descriptor read/64, error %d\n",
4445 #undef GET_DESCRIPTOR_BUFSIZE
4449 * If device is WUSB, we already assigned an
4450 * unauthorized address in the Connect Ack sequence;
4451 * authorization will assign the final address.
4453 if (udev
->wusb
== 0) {
4454 for (j
= 0; j
< SET_ADDRESS_TRIES
; ++j
) {
4455 retval
= hub_set_address(udev
, devnum
);
4461 if (retval
!= -ENODEV
)
4462 dev_err(&udev
->dev
, "device not accepting address %d, error %d\n",
4466 if (udev
->speed
== USB_SPEED_SUPER
) {
4467 devnum
= udev
->devnum
;
4468 dev_info(&udev
->dev
,
4469 "%s SuperSpeed USB device number %d using %s\n",
4470 (udev
->config
) ? "reset" : "new",
4471 devnum
, udev
->bus
->controller
->driver
->name
);
4474 /* cope with hardware quirkiness:
4475 * - let SET_ADDRESS settle, some device hardware wants it
4476 * - read ep0 maxpacket even for high and low speed,
4479 if (USE_NEW_SCHEME(retry_counter
) && !(hcd
->driver
->flags
& HCD_USB3
))
4483 retval
= usb_get_device_descriptor(udev
, 8);
4485 if (retval
!= -ENODEV
)
4487 "device descriptor read/8, error %d\n",
4499 if (hcd
->phy
&& !hdev
->parent
)
4500 usb_phy_notify_connect(hcd
->phy
, udev
->speed
);
4503 * Some superspeed devices have finished the link training process
4504 * and attached to a superspeed hub port, but the device descriptor
4505 * got from those devices show they aren't superspeed devices. Warm
4506 * reset the port attached by the devices can fix them.
4508 if ((udev
->speed
== USB_SPEED_SUPER
) &&
4509 (le16_to_cpu(udev
->descriptor
.bcdUSB
) < 0x0300)) {
4510 dev_err(&udev
->dev
, "got a wrong device descriptor, "
4511 "warm reset device\n");
4512 hub_port_reset(hub
, port1
, udev
,
4513 HUB_BH_RESET_TIME
, true);
4518 if (udev
->descriptor
.bMaxPacketSize0
== 0xff ||
4519 udev
->speed
== USB_SPEED_SUPER
)
4522 i
= udev
->descriptor
.bMaxPacketSize0
;
4523 if (usb_endpoint_maxp(&udev
->ep0
.desc
) != i
) {
4524 if (udev
->speed
== USB_SPEED_LOW
||
4525 !(i
== 8 || i
== 16 || i
== 32 || i
== 64)) {
4526 dev_err(&udev
->dev
, "Invalid ep0 maxpacket: %d\n", i
);
4530 if (udev
->speed
== USB_SPEED_FULL
)
4531 dev_dbg(&udev
->dev
, "ep0 maxpacket = %d\n", i
);
4533 dev_warn(&udev
->dev
, "Using ep0 maxpacket: %d\n", i
);
4534 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(i
);
4535 usb_ep0_reinit(udev
);
4538 retval
= usb_get_device_descriptor(udev
, USB_DT_DEVICE_SIZE
);
4539 if (retval
< (signed)sizeof(udev
->descriptor
)) {
4540 if (retval
!= -ENODEV
)
4541 dev_err(&udev
->dev
, "device descriptor read/all, error %d\n",
4548 if (udev
->wusb
== 0 && le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0201) {
4549 retval
= usb_get_bos_descriptor(udev
);
4551 udev
->lpm_capable
= usb_device_supports_lpm(udev
);
4552 usb_set_lpm_parameters(udev
);
4557 /* notify HCD that we have a device connected and addressed */
4558 if (hcd
->driver
->update_device
)
4559 hcd
->driver
->update_device(hcd
, udev
);
4562 hub_port_disable(hub
, port1
, 0);
4563 update_devnum(udev
, devnum
); /* for disconnect processing */
4565 mutex_unlock(&usb_address0_mutex
);
4570 check_highspeed (struct usb_hub
*hub
, struct usb_device
*udev
, int port1
)
4572 struct usb_qualifier_descriptor
*qual
;
4575 qual
= kmalloc (sizeof *qual
, GFP_KERNEL
);
4579 status
= usb_get_descriptor (udev
, USB_DT_DEVICE_QUALIFIER
, 0,
4580 qual
, sizeof *qual
);
4581 if (status
== sizeof *qual
) {
4582 dev_info(&udev
->dev
, "not running at top speed; "
4583 "connect to a high speed hub\n");
4584 /* hub LEDs are probably harder to miss than syslog */
4585 if (hub
->has_indicators
) {
4586 hub
->indicator
[port1
-1] = INDICATOR_GREEN_BLINK
;
4587 schedule_delayed_work (&hub
->leds
, 0);
4594 hub_power_remaining (struct usb_hub
*hub
)
4596 struct usb_device
*hdev
= hub
->hdev
;
4600 if (!hub
->limited_power
)
4603 remaining
= hdev
->bus_mA
- hub
->descriptor
->bHubContrCurrent
;
4604 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
4605 struct usb_device
*udev
= hub
->ports
[port1
- 1]->child
;
4611 if (hub_is_superspeed(udev
))
4617 * Unconfigured devices may not use more than one unit load,
4618 * or 8mA for OTG ports
4620 if (udev
->actconfig
)
4621 delta
= usb_get_max_power(udev
, udev
->actconfig
);
4622 else if (port1
!= udev
->bus
->otg_port
|| hdev
->parent
)
4626 if (delta
> hub
->mA_per_port
)
4627 dev_warn(&udev
->dev
,
4628 "%dmA is over %umA budget for port %d!\n",
4629 delta
, hub
->mA_per_port
, port1
);
4632 if (remaining
< 0) {
4633 #if defined(CONFIG_USBIF_COMPLIANCE) && defined(CONFIG_USB_XHCI_HCD)
4634 usbif_u3h_send_event("DEV_OVER_CURRENT");
4636 dev_warn(hub
->intfdev
, "%dmA over power budget!\n",
4643 /* Handle physical or logical connection change events.
4644 * This routine is called when:
4645 * a port connection-change occurs;
4646 * a port enable-change occurs (often caused by EMI);
4647 * usb_reset_and_verify_device() encounters changed descriptors (as from
4648 * a firmware download)
4649 * caller already locked the hub
4651 static void hub_port_connect_change(struct usb_hub
*hub
, int port1
,
4652 u16 portstatus
, u16 portchange
)
4654 struct usb_device
*hdev
= hub
->hdev
;
4655 struct device
*hub_dev
= hub
->intfdev
;
4656 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
4657 unsigned wHubCharacteristics
=
4658 le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
4659 struct usb_device
*udev
;
4665 "port %d, status %04x, change %04x, %s\n",
4666 port1
, portstatus
, portchange
, portspeed(hub
, portstatus
));
4668 if (hub
->has_indicators
) {
4669 set_port_led(hub
, port1
, HUB_LED_AUTO
);
4670 hub
->indicator
[port1
-1] = INDICATOR_AUTO
;
4673 #ifdef CONFIG_USB_OTG
4674 /* during HNP, don't repeat the debounce */
4675 if (hdev
->bus
->is_b_host
)
4676 portchange
&= ~(USB_PORT_STAT_C_CONNECTION
|
4677 USB_PORT_STAT_C_ENABLE
);
4680 /* Try to resuscitate an existing device */
4681 udev
= hub
->ports
[port1
- 1]->child
;
4682 if ((portstatus
& USB_PORT_STAT_CONNECTION
) && udev
&&
4683 udev
->state
!= USB_STATE_NOTATTACHED
) {
4684 usb_lock_device(udev
);
4685 if (portstatus
& USB_PORT_STAT_ENABLE
) {
4686 status
= 0; /* Nothing to do */
4688 #ifdef CONFIG_PM_RUNTIME
4689 } else if (udev
->state
== USB_STATE_SUSPENDED
&&
4690 udev
->persist_enabled
) {
4691 /* For a suspended device, treat this as a
4692 * remote wakeup event.
4694 status
= usb_remote_wakeup(udev
);
4698 status
= -ENODEV
; /* Don't resuscitate */
4700 usb_unlock_device(udev
);
4703 clear_bit(port1
, hub
->change_bits
);
4708 /* Disconnect any existing devices under this port */
4710 if (hcd
->phy
&& !hdev
->parent
&&
4711 !(portstatus
& USB_PORT_STAT_CONNECTION
))
4712 usb_phy_notify_disconnect(hcd
->phy
, udev
->speed
);
4713 usb_disconnect(&hub
->ports
[port1
- 1]->child
);
4715 clear_bit(port1
, hub
->change_bits
);
4717 /* We can forget about a "removed" device when there's a physical
4718 * disconnect or the connect status changes.
4720 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
4721 (portchange
& USB_PORT_STAT_C_CONNECTION
))
4722 clear_bit(port1
, hub
->removed_bits
);
4724 if (portchange
& (USB_PORT_STAT_C_CONNECTION
|
4725 USB_PORT_STAT_C_ENABLE
)) {
4726 status
= hub_port_debounce_be_stable(hub
, port1
);
4728 if (status
!= -ENODEV
&& printk_ratelimit())
4729 dev_err(hub_dev
, "connect-debounce failed, "
4730 "port %d disabled\n", port1
);
4731 portstatus
&= ~USB_PORT_STAT_CONNECTION
;
4733 portstatus
= status
;
4737 /* Return now if debouncing failed or nothing is connected or
4738 * the device was "removed".
4740 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
4741 test_bit(port1
, hub
->removed_bits
)) {
4743 /* maybe switch power back on (e.g. root hub was reset) */
4744 if ((wHubCharacteristics
& HUB_CHAR_LPSM
) < 2
4745 && !port_is_power_on(hub
, portstatus
))
4746 set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
4748 if (portstatus
& USB_PORT_STAT_ENABLE
)
4752 if (hub_is_superspeed(hub
->hdev
))
4758 for (i
= 0; i
< SET_CONFIG_TRIES
; i
++) {
4760 /* reallocate for each attempt, since references
4761 * to the previous one can escape in various ways
4763 udev
= usb_alloc_dev(hdev
, hdev
->bus
, port1
);
4766 "couldn't allocate port %d usb_device\n",
4771 usb_set_device_state(udev
, USB_STATE_POWERED
);
4772 udev
->bus_mA
= hub
->mA_per_port
;
4773 udev
->level
= hdev
->level
+ 1;
4774 udev
->wusb
= hub_is_wusb(hub
);
4776 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
4777 if (hub_is_superspeed(hub
->hdev
))
4778 udev
->speed
= USB_SPEED_SUPER
;
4780 udev
->speed
= USB_SPEED_UNKNOWN
;
4782 choose_devnum(udev
);
4783 if (udev
->devnum
<= 0) {
4784 status
= -ENOTCONN
; /* Don't retry */
4788 /* reset (non-USB 3.0 devices) and get descriptor */
4790 status
= hub_port_init(hub
, udev
, port1
, i
);
4798 usb_detect_quirks(udev
);
4799 if (udev
->quirks
& USB_QUIRK_DELAY_INIT
)
4802 /* consecutive bus-powered hubs aren't reliable; they can
4803 * violate the voltage drop budget. if the new child has
4804 * a "powered" LED, users should notice we didn't enable it
4805 * (without reading syslog), even without per-port LEDs
4808 if (udev
->descriptor
.bDeviceClass
== USB_CLASS_HUB
4809 && udev
->bus_mA
<= unit_load
) {
4812 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0,
4815 dev_dbg(&udev
->dev
, "get status %d ?\n", status
);
4818 le16_to_cpus(&devstat
);
4819 if ((devstat
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
4821 "can't connect bus-powered hub "
4823 if (hub
->has_indicators
) {
4824 hub
->indicator
[port1
-1] =
4825 INDICATOR_AMBER_BLINK
;
4826 schedule_delayed_work (&hub
->leds
, 0);
4828 status
= -ENOTCONN
; /* Don't retry */
4833 /* check for devices running slower than they could */
4834 if (le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0200
4835 && udev
->speed
== USB_SPEED_FULL
4836 && highspeed_hubs
!= 0)
4837 check_highspeed (hub
, udev
, port1
);
4839 /* Store the parent's children[] pointer. At this point
4840 * udev becomes globally accessible, although presumably
4841 * no one will look at it until hdev is unlocked.
4845 /* We mustn't add new devices if the parent hub has
4846 * been disconnected; we would race with the
4847 * recursively_mark_NOTATTACHED() routine.
4849 spin_lock_irq(&device_state_lock
);
4850 if (hdev
->state
== USB_STATE_NOTATTACHED
)
4853 hub
->ports
[port1
- 1]->child
= udev
;
4854 spin_unlock_irq(&device_state_lock
);
4856 /* Run it through the hoops (find a driver, etc) */
4858 status
= usb_new_device(udev
);
4860 spin_lock_irq(&device_state_lock
);
4861 hub
->ports
[port1
- 1]->child
= NULL
;
4862 spin_unlock_irq(&device_state_lock
);
4864 #ifdef CONFIG_MTK_DT_USB_SUPPORT
4866 MYDBG("get new device !!!, BUILD TIME : %s, g_dsda_dev : %p\n", __TIME__
, g_dsda_dev
);
4873 status
= hub_power_remaining(hub
);
4875 dev_dbg(hub_dev
, "%dmA power budget left\n", status
);
4880 hub_port_disable(hub
, port1
, 1);
4882 usb_ep0_reinit(udev
);
4883 release_devnum(udev
);
4886 if ((status
== -ENOTCONN
) || (status
== -ENOTSUPP
))
4889 if (hub
->hdev
->parent
||
4890 !hcd
->driver
->port_handed_over
||
4891 !(hcd
->driver
->port_handed_over
)(hcd
, port1
)) {
4892 if (status
!= -ENOTCONN
&& status
!= -ENODEV
)
4893 dev_err(hub_dev
, "unable to enumerate USB device on port %d\n",
4898 hub_port_disable(hub
, port1
, 1);
4899 if (hcd
->driver
->relinquish_port
&& !hub
->hdev
->parent
)
4900 hcd
->driver
->relinquish_port(hcd
, port1
);
4903 /* Returns 1 if there was a remote wakeup and a connect status change. */
4904 static int hub_handle_remote_wakeup(struct usb_hub
*hub
, unsigned int port
,
4905 u16 portstatus
, u16 portchange
)
4907 struct usb_device
*hdev
;
4908 struct usb_device
*udev
;
4909 int connect_change
= 0;
4913 udev
= hub
->ports
[port
- 1]->child
;
4914 if (!hub_is_superspeed(hdev
)) {
4915 if (!(portchange
& USB_PORT_STAT_C_SUSPEND
))
4917 usb_clear_port_feature(hdev
, port
, USB_PORT_FEAT_C_SUSPEND
);
4919 if (!udev
|| udev
->state
!= USB_STATE_SUSPENDED
||
4920 (portstatus
& USB_PORT_STAT_LINK_STATE
) !=
4926 /* TRSMRCY = 10 msec */
4929 usb_lock_device(udev
);
4930 ret
= usb_remote_wakeup(udev
);
4931 usb_unlock_device(udev
);
4936 hub_port_disable(hub
, port
, 1);
4938 dev_dbg(hub
->intfdev
, "resume on port %d, status %d\n",
4940 return connect_change
;
4943 static void hub_events(void)
4945 struct list_head
*tmp
;
4946 struct usb_device
*hdev
;
4947 struct usb_interface
*intf
;
4948 struct usb_hub
*hub
;
4949 struct device
*hub_dev
;
4955 int connect_change
, wakeup_change
;
4958 * We restart the list every time to avoid a deadlock with
4959 * deleting hubs downstream from this one. This should be
4960 * safe since we delete the hub from the event list.
4961 * Not the most efficient, but avoids deadlocks.
4965 /* Grab the first entry at the beginning of the list */
4966 spin_lock_irq(&hub_event_lock
);
4967 if (list_empty(&hub_event_list
)) {
4968 spin_unlock_irq(&hub_event_lock
);
4972 tmp
= hub_event_list
.next
;
4975 hub
= list_entry(tmp
, struct usb_hub
, event_list
);
4976 kref_get(&hub
->kref
);
4977 spin_unlock_irq(&hub_event_lock
);
4980 hub_dev
= hub
->intfdev
;
4981 intf
= to_usb_interface(hub_dev
);
4982 dev_dbg(hub_dev
, "state %d ports %d chg %04x evt %04x\n",
4983 hdev
->state
, hub
->descriptor
4984 ? hub
->descriptor
->bNbrPorts
4986 /* NOTE: expects max 15 ports... */
4987 (u16
) hub
->change_bits
[0],
4988 (u16
) hub
->event_bits
[0]);
4990 /* Lock the device, then check to see if we were
4991 * disconnected while waiting for the lock to succeed. */
4992 usb_lock_device(hdev
);
4993 if (unlikely(hub
->disconnected
))
4994 goto loop_disconnected
;
4996 /* If the hub has died, clean up after it */
4997 if (hdev
->state
== USB_STATE_NOTATTACHED
) {
4998 hub
->error
= -ENODEV
;
4999 hub_quiesce(hub
, HUB_DISCONNECT
);
5004 ret
= usb_autopm_get_interface(intf
);
5006 dev_dbg(hub_dev
, "Can't autoresume: %d\n", ret
);
5010 /* If this is an inactive hub, do nothing */
5015 dev_dbg (hub_dev
, "resetting for error %d\n",
5019 ret
= usb_reset_device(hdev
);
5022 "error resetting hub: %d\n", ret
);
5030 /* deal with port status changes */
5031 for (i
= 1; i
<= hub
->descriptor
->bNbrPorts
; i
++) {
5032 if (test_bit(i
, hub
->busy_bits
))
5034 connect_change
= test_bit(i
, hub
->change_bits
);
5035 wakeup_change
= test_and_clear_bit(i
, hub
->wakeup_bits
);
5036 if (!test_and_clear_bit(i
, hub
->event_bits
) &&
5037 !connect_change
&& !wakeup_change
)
5040 ret
= hub_port_status(hub
, i
,
5041 &portstatus
, &portchange
);
5045 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
5046 usb_clear_port_feature(hdev
, i
,
5047 USB_PORT_FEAT_C_CONNECTION
);
5051 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
5052 if (!connect_change
)
5054 "port %d enable change, "
5057 usb_clear_port_feature(hdev
, i
,
5058 USB_PORT_FEAT_C_ENABLE
);
5061 * EM interference sometimes causes badly
5062 * shielded USB devices to be shutdown by
5063 * the hub, this hack enables them again.
5064 * Works at least with mouse driver.
5066 if (!(portstatus
& USB_PORT_STAT_ENABLE
)
5068 && hub
->ports
[i
- 1]->child
) {
5071 "disabled by hub (EMI?), "
5078 if (hub_handle_remote_wakeup(hub
, i
,
5079 portstatus
, portchange
))
5082 if (portchange
& USB_PORT_STAT_C_OVERCURRENT
) {
5086 dev_dbg(hub_dev
, "over-current change on port "
5088 usb_clear_port_feature(hdev
, i
,
5089 USB_PORT_FEAT_C_OVER_CURRENT
);
5090 msleep(100); /* Cool down */
5091 hub_power_on(hub
, true);
5092 hub_port_status(hub
, i
, &status
, &unused
);
5093 if (status
& USB_PORT_STAT_OVERCURRENT
)
5094 dev_err(hub_dev
, "over-current "
5095 "condition on port %d\n", i
);
5098 if (portchange
& USB_PORT_STAT_C_RESET
) {
5100 "reset change on port %d\n",
5102 usb_clear_port_feature(hdev
, i
,
5103 USB_PORT_FEAT_C_RESET
);
5105 if ((portchange
& USB_PORT_STAT_C_BH_RESET
) &&
5106 hub_is_superspeed(hub
->hdev
)) {
5108 "warm reset change on port %d\n",
5110 usb_clear_port_feature(hdev
, i
,
5111 USB_PORT_FEAT_C_BH_PORT_RESET
);
5113 if (portchange
& USB_PORT_STAT_C_LINK_STATE
) {
5114 usb_clear_port_feature(hub
->hdev
, i
,
5115 USB_PORT_FEAT_C_PORT_LINK_STATE
);
5117 if (portchange
& USB_PORT_STAT_C_CONFIG_ERROR
) {
5119 "config error on port %d\n",
5121 usb_clear_port_feature(hub
->hdev
, i
,
5122 USB_PORT_FEAT_C_PORT_CONFIG_ERROR
);
5125 /* Warm reset a USB3 protocol port if it's in
5126 * SS.Inactive state.
5128 if (hub_port_warm_reset_required(hub
, portstatus
)) {
5130 struct usb_device
*udev
=
5131 hub
->ports
[i
- 1]->child
;
5133 dev_dbg(hub_dev
, "warm reset port %d\n", i
);
5135 !(portstatus
& USB_PORT_STAT_CONNECTION
) ||
5136 udev
->state
== USB_STATE_NOTATTACHED
) {
5137 status
= hub_port_reset(hub
, i
,
5138 NULL
, HUB_BH_RESET_TIME
,
5141 hub_port_disable(hub
, i
, 1);
5143 usb_lock_device(udev
);
5144 status
= usb_reset_device(udev
);
5145 usb_unlock_device(udev
);
5151 hub_port_connect_change(hub
, i
,
5152 portstatus
, portchange
);
5155 /* deal with hub status changes */
5156 if (test_and_clear_bit(0, hub
->event_bits
) == 0)
5158 else if (hub_hub_status(hub
, &hubstatus
, &hubchange
) < 0)
5159 dev_err (hub_dev
, "get_hub_status failed\n");
5161 if (hubchange
& HUB_CHANGE_LOCAL_POWER
) {
5162 dev_dbg (hub_dev
, "power change\n");
5163 clear_hub_feature(hdev
, C_HUB_LOCAL_POWER
);
5164 if (hubstatus
& HUB_STATUS_LOCAL_POWER
)
5165 /* FIXME: Is this always true? */
5166 hub
->limited_power
= 1;
5168 hub
->limited_power
= 0;
5170 if (hubchange
& HUB_CHANGE_OVERCURRENT
) {
5174 dev_dbg(hub_dev
, "over-current change\n");
5175 clear_hub_feature(hdev
, C_HUB_OVER_CURRENT
);
5176 msleep(500); /* Cool down */
5177 hub_power_on(hub
, true);
5178 hub_hub_status(hub
, &status
, &unused
);
5179 if (status
& HUB_STATUS_OVERCURRENT
)
5180 dev_err(hub_dev
, "over-current "
5186 /* Balance the usb_autopm_get_interface() above */
5187 usb_autopm_put_interface_no_suspend(intf
);
5189 /* Balance the usb_autopm_get_interface_no_resume() in
5190 * kick_khubd() and allow autosuspend.
5192 usb_autopm_put_interface(intf
);
5194 usb_unlock_device(hdev
);
5195 kref_put(&hub
->kref
, hub_release
);
5197 } /* end while (1) */
5200 static int hub_thread(void *__unused
)
5202 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
5203 * port handover. Otherwise it might see that a full-speed device
5204 * was gone before the EHCI controller had handed its port over to
5205 * the companion full-speed controller.
5211 wait_event_freezable(khubd_wait
,
5212 !list_empty(&hub_event_list
) ||
5213 kthread_should_stop());
5214 } while (!kthread_should_stop() || !list_empty(&hub_event_list
));
5216 pr_debug("%s: khubd exiting\n", usbcore_name
);
5220 static const struct usb_device_id hub_id_table
[] = {
5221 { .match_flags
= USB_DEVICE_ID_MATCH_VENDOR
5222 | USB_DEVICE_ID_MATCH_INT_CLASS
,
5223 .idVendor
= USB_VENDOR_GENESYS_LOGIC
,
5224 .bInterfaceClass
= USB_CLASS_HUB
,
5225 .driver_info
= HUB_QUIRK_CHECK_PORT_AUTOSUSPEND
},
5226 { .match_flags
= USB_DEVICE_ID_MATCH_DEV_CLASS
,
5227 .bDeviceClass
= USB_CLASS_HUB
},
5228 { .match_flags
= USB_DEVICE_ID_MATCH_INT_CLASS
,
5229 .bInterfaceClass
= USB_CLASS_HUB
},
5230 { } /* Terminating entry */
5233 MODULE_DEVICE_TABLE (usb
, hub_id_table
);
5235 static struct usb_driver hub_driver
= {
5238 .disconnect
= hub_disconnect
,
5239 .suspend
= hub_suspend
,
5240 .resume
= hub_resume
,
5241 .reset_resume
= hub_reset_resume
,
5242 .pre_reset
= hub_pre_reset
,
5243 .post_reset
= hub_post_reset
,
5244 .unlocked_ioctl
= hub_ioctl
,
5245 .id_table
= hub_id_table
,
5246 .supports_autosuspend
= 1,
5249 #if defined(CONFIG_MTK_XHCI) && defined(CONFIG_USB_MTK_DUALMODE)
5250 extern void mtk_hub_event_steal(spinlock_t
*lock
, struct list_head
* list
);
5252 int usb_hub_init(void)
5254 if (usb_register(&hub_driver
) < 0) {
5255 printk(KERN_ERR
"%s: can't register hub driver\n",
5260 #if defined(CONFIG_MTK_XHCI) && defined(CONFIG_USB_MTK_DUALMODE)
5261 mtk_hub_event_steal(&hub_event_lock
, &hub_event_list
);
5264 khubd_task
= kthread_run(hub_thread
, NULL
, "khubd");
5265 if (!IS_ERR(khubd_task
))
5268 /* Fall through if kernel_thread failed */
5269 usb_deregister(&hub_driver
);
5270 printk(KERN_ERR
"%s: can't start khubd\n", usbcore_name
);
5275 void usb_hub_cleanup(void)
5277 kthread_stop(khubd_task
);
5280 * Hub resources are freed for us by usb_deregister. It calls
5281 * usb_driver_purge on every device which in turn calls that
5282 * devices disconnect function if it is using this driver.
5283 * The hub_disconnect function takes care of releasing the
5284 * individual hub resources. -greg
5286 usb_deregister(&hub_driver
);
5287 } /* usb_hub_cleanup() */
5289 static int descriptors_changed(struct usb_device
*udev
,
5290 struct usb_device_descriptor
*old_device_descriptor
)
5294 unsigned serial_len
= 0;
5296 unsigned old_length
;
5300 if (memcmp(&udev
->descriptor
, old_device_descriptor
,
5301 sizeof(*old_device_descriptor
)) != 0)
5304 /* Since the idVendor, idProduct, and bcdDevice values in the
5305 * device descriptor haven't changed, we will assume the
5306 * Manufacturer and Product strings haven't changed either.
5307 * But the SerialNumber string could be different (e.g., a
5308 * different flash card of the same brand).
5311 serial_len
= strlen(udev
->serial
) + 1;
5314 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
5315 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
5316 len
= max(len
, old_length
);
5319 buf
= kmalloc(len
, GFP_NOIO
);
5321 dev_err(&udev
->dev
, "no mem to re-read configs after reset\n");
5322 /* assume the worst */
5325 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
5326 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
5327 length
= usb_get_descriptor(udev
, USB_DT_CONFIG
, index
, buf
,
5329 if (length
!= old_length
) {
5330 dev_dbg(&udev
->dev
, "config index %d, error %d\n",
5335 if (memcmp (buf
, udev
->rawdescriptors
[index
], old_length
)
5337 dev_dbg(&udev
->dev
, "config index %d changed (#%d)\n",
5339 ((struct usb_config_descriptor
*) buf
)->
5340 bConfigurationValue
);
5346 if (!changed
&& serial_len
) {
5347 length
= usb_string(udev
, udev
->descriptor
.iSerialNumber
,
5349 if (length
+ 1 != serial_len
) {
5350 dev_dbg(&udev
->dev
, "serial string error %d\n",
5353 } else if (memcmp(buf
, udev
->serial
, length
) != 0) {
5354 dev_dbg(&udev
->dev
, "serial string changed\n");
5364 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5365 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5367 * WARNING - don't use this routine to reset a composite device
5368 * (one with multiple interfaces owned by separate drivers)!
5369 * Use usb_reset_device() instead.
5371 * Do a port reset, reassign the device's address, and establish its
5372 * former operating configuration. If the reset fails, or the device's
5373 * descriptors change from their values before the reset, or the original
5374 * configuration and altsettings cannot be restored, a flag will be set
5375 * telling khubd to pretend the device has been disconnected and then
5376 * re-connected. All drivers will be unbound, and the device will be
5377 * re-enumerated and probed all over again.
5379 * Returns 0 if the reset succeeded, -ENODEV if the device has been
5380 * flagged for logical disconnection, or some other negative error code
5381 * if the reset wasn't even attempted.
5383 * The caller must own the device lock. For example, it's safe to use
5384 * this from a driver probe() routine after downloading new firmware.
5385 * For calls that might not occur during probe(), drivers should lock
5386 * the device using usb_lock_device_for_reset().
5388 * Locking exception: This routine may also be called from within an
5389 * autoresume handler. Such usage won't conflict with other tasks
5390 * holding the device lock because these tasks should always call
5391 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
5393 static int usb_reset_and_verify_device(struct usb_device
*udev
)
5395 struct usb_device
*parent_hdev
= udev
->parent
;
5396 struct usb_hub
*parent_hub
;
5397 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
5398 struct usb_device_descriptor descriptor
= udev
->descriptor
;
5400 int port1
= udev
->portnum
;
5403 if (udev
->state
== USB_STATE_NOTATTACHED
||
5404 udev
->state
== USB_STATE_SUSPENDED
) {
5405 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
5411 /* this requires hcd-specific logic; see ohci_restart() */
5412 dev_dbg(&udev
->dev
, "%s for root hub!\n", __func__
);
5415 parent_hub
= usb_hub_to_struct_hub(parent_hdev
);
5417 /* Disable LPM and LTM while we reset the device and reinstall the alt
5418 * settings. Device-initiated LPM settings, and system exit latency
5419 * settings are cleared when the device is reset, so we have to set
5422 ret
= usb_unlocked_disable_lpm(udev
);
5424 dev_err(&udev
->dev
, "%s Failed to disable LPM\n.", __func__
);
5427 ret
= usb_disable_ltm(udev
);
5429 dev_err(&udev
->dev
, "%s Failed to disable LTM\n.",
5434 set_bit(port1
, parent_hub
->busy_bits
);
5435 for (i
= 0; i
< SET_CONFIG_TRIES
; ++i
) {
5437 /* ep0 maxpacket size may change; let the HCD know about it.
5438 * Other endpoints will be handled by re-enumeration. */
5439 usb_ep0_reinit(udev
);
5440 ret
= hub_port_init(parent_hub
, udev
, port1
, i
);
5441 if (ret
>= 0 || ret
== -ENOTCONN
|| ret
== -ENODEV
)
5444 clear_bit(port1
, parent_hub
->busy_bits
);
5449 /* Device might have changed firmware (DFU or similar) */
5450 if (descriptors_changed(udev
, &descriptor
)) {
5451 dev_info(&udev
->dev
, "device firmware changed\n");
5452 udev
->descriptor
= descriptor
; /* for disconnect() calls */
5456 /* Restore the device's previous configuration */
5457 if (!udev
->actconfig
)
5460 mutex_lock(hcd
->bandwidth_mutex
);
5461 ret
= usb_hcd_alloc_bandwidth(udev
, udev
->actconfig
, NULL
, NULL
);
5463 dev_warn(&udev
->dev
,
5464 "Busted HC? Not enough HCD resources for "
5465 "old configuration.\n");
5466 mutex_unlock(hcd
->bandwidth_mutex
);
5469 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
5470 USB_REQ_SET_CONFIGURATION
, 0,
5471 udev
->actconfig
->desc
.bConfigurationValue
, 0,
5472 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
5475 "can't restore configuration #%d (error=%d)\n",
5476 udev
->actconfig
->desc
.bConfigurationValue
, ret
);
5477 mutex_unlock(hcd
->bandwidth_mutex
);
5480 mutex_unlock(hcd
->bandwidth_mutex
);
5481 usb_set_device_state(udev
, USB_STATE_CONFIGURED
);
5483 /* Put interfaces back into the same altsettings as before.
5484 * Don't bother to send the Set-Interface request for interfaces
5485 * that were already in altsetting 0; besides being unnecessary,
5486 * many devices can't handle it. Instead just reset the host-side
5489 for (i
= 0; i
< udev
->actconfig
->desc
.bNumInterfaces
; i
++) {
5490 struct usb_host_config
*config
= udev
->actconfig
;
5491 struct usb_interface
*intf
= config
->interface
[i
];
5492 struct usb_interface_descriptor
*desc
;
5494 desc
= &intf
->cur_altsetting
->desc
;
5495 if (desc
->bAlternateSetting
== 0) {
5496 usb_disable_interface(udev
, intf
, true);
5497 usb_enable_interface(udev
, intf
, true);
5500 /* Let the bandwidth allocation function know that this
5501 * device has been reset, and it will have to use
5502 * alternate setting 0 as the current alternate setting.
5504 intf
->resetting_device
= 1;
5505 ret
= usb_set_interface(udev
, desc
->bInterfaceNumber
,
5506 desc
->bAlternateSetting
);
5507 intf
->resetting_device
= 0;
5510 dev_err(&udev
->dev
, "failed to restore interface %d "
5511 "altsetting %d (error=%d)\n",
5512 desc
->bInterfaceNumber
,
5513 desc
->bAlternateSetting
,
5520 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5521 usb_unlocked_enable_lpm(udev
);
5522 usb_enable_ltm(udev
);
5526 /* LPM state doesn't matter when we're about to destroy the device. */
5527 hub_port_logical_disconnect(parent_hub
, port1
);
5532 * usb_reset_device - warn interface drivers and perform a USB port reset
5533 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5535 * Warns all drivers bound to registered interfaces (using their pre_reset
5536 * method), performs the port reset, and then lets the drivers know that
5537 * the reset is over (using their post_reset method).
5539 * Return value is the same as for usb_reset_and_verify_device().
5541 * The caller must own the device lock. For example, it's safe to use
5542 * this from a driver probe() routine after downloading new firmware.
5543 * For calls that might not occur during probe(), drivers should lock
5544 * the device using usb_lock_device_for_reset().
5546 * If an interface is currently being probed or disconnected, we assume
5547 * its driver knows how to handle resets. For all other interfaces,
5548 * if the driver doesn't have pre_reset and post_reset methods then
5549 * we attempt to unbind it and rebind afterward.
5551 int usb_reset_device(struct usb_device
*udev
)
5555 unsigned int noio_flag
;
5556 struct usb_host_config
*config
= udev
->actconfig
;
5559 if (udev
->state
== USB_STATE_NOTATTACHED
||
5560 udev
->state
== USB_STATE_SUSPENDED
) {
5561 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
5567 * Don't allocate memory with GFP_KERNEL in current
5568 * context to avoid possible deadlock if usb mass
5569 * storage interface or usbnet interface(iSCSI case)
5570 * is included in current configuration. The easist
5571 * approach is to do it for every device reset,
5572 * because the device 'memalloc_noio' flag may have
5573 * not been set before reseting the usb device.
5575 noio_flag
= memalloc_noio_save();
5577 /* Prevent autosuspend during the reset */
5578 usb_autoresume_device(udev
);
5581 for (i
= 0; i
< config
->desc
.bNumInterfaces
; ++i
) {
5582 struct usb_interface
*cintf
= config
->interface
[i
];
5583 struct usb_driver
*drv
;
5586 if (cintf
->dev
.driver
) {
5587 drv
= to_usb_driver(cintf
->dev
.driver
);
5588 if (drv
->pre_reset
&& drv
->post_reset
)
5589 unbind
= (drv
->pre_reset
)(cintf
);
5590 else if (cintf
->condition
==
5591 USB_INTERFACE_BOUND
)
5594 usb_forced_unbind_intf(cintf
);
5599 ret
= usb_reset_and_verify_device(udev
);
5602 for (i
= config
->desc
.bNumInterfaces
- 1; i
>= 0; --i
) {
5603 struct usb_interface
*cintf
= config
->interface
[i
];
5604 struct usb_driver
*drv
;
5605 int rebind
= cintf
->needs_binding
;
5607 if (!rebind
&& cintf
->dev
.driver
) {
5608 drv
= to_usb_driver(cintf
->dev
.driver
);
5609 if (drv
->post_reset
)
5610 rebind
= (drv
->post_reset
)(cintf
);
5611 else if (cintf
->condition
==
5612 USB_INTERFACE_BOUND
)
5615 cintf
->needs_binding
= 1;
5618 usb_unbind_and_rebind_marked_interfaces(udev
);
5621 usb_autosuspend_device(udev
);
5622 memalloc_noio_restore(noio_flag
);
5625 EXPORT_SYMBOL_GPL(usb_reset_device
);
5629 * usb_queue_reset_device - Reset a USB device from an atomic context
5630 * @iface: USB interface belonging to the device to reset
5632 * This function can be used to reset a USB device from an atomic
5633 * context, where usb_reset_device() won't work (as it blocks).
5635 * Doing a reset via this method is functionally equivalent to calling
5636 * usb_reset_device(), except for the fact that it is delayed to a
5637 * workqueue. This means that any drivers bound to other interfaces
5638 * might be unbound, as well as users from usbfs in user space.
5642 * - Scheduling two resets at the same time from two different drivers
5643 * attached to two different interfaces of the same device is
5644 * possible; depending on how the driver attached to each interface
5645 * handles ->pre_reset(), the second reset might happen or not.
5647 * - If a driver is unbound and it had a pending reset, the reset will
5650 * - This function can be called during .probe() or .disconnect()
5651 * times. On return from .disconnect(), any pending resets will be
5654 * There is no no need to lock/unlock the @reset_ws as schedule_work()
5657 * NOTE: We don't do any reference count tracking because it is not
5658 * needed. The lifecycle of the work_struct is tied to the
5659 * usb_interface. Before destroying the interface we cancel the
5660 * work_struct, so the fact that work_struct is queued and or
5661 * running means the interface (and thus, the device) exist and
5664 void usb_queue_reset_device(struct usb_interface
*iface
)
5666 schedule_work(&iface
->reset_ws
);
5668 EXPORT_SYMBOL_GPL(usb_queue_reset_device
);
5671 * usb_hub_find_child - Get the pointer of child device
5672 * attached to the port which is specified by @port1.
5673 * @hdev: USB device belonging to the usb hub
5674 * @port1: port num to indicate which port the child device
5677 * USB drivers call this function to get hub's child device
5680 * Return NULL if input param is invalid and
5681 * child's usb_device pointer if non-NULL.
5683 struct usb_device
*usb_hub_find_child(struct usb_device
*hdev
,
5686 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5688 if (port1
< 1 || port1
> hdev
->maxchild
)
5690 return hub
->ports
[port1
- 1]->child
;
5692 EXPORT_SYMBOL_GPL(usb_hub_find_child
);
5695 * usb_set_hub_port_connect_type - set hub port connect type.
5696 * @hdev: USB device belonging to the usb hub
5697 * @port1: port num of the port
5698 * @type: connect type of the port
5700 void usb_set_hub_port_connect_type(struct usb_device
*hdev
, int port1
,
5701 enum usb_port_connect_type type
)
5703 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5705 hub
->ports
[port1
- 1]->connect_type
= type
;
5709 * usb_get_hub_port_connect_type - Get the port's connect type
5710 * @hdev: USB device belonging to the usb hub
5711 * @port1: port num of the port
5713 * Return connect type of the port and if input params are
5714 * invalid, return USB_PORT_CONNECT_TYPE_UNKNOWN.
5716 enum usb_port_connect_type
5717 usb_get_hub_port_connect_type(struct usb_device
*hdev
, int port1
)
5719 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5721 return hub
->ports
[port1
- 1]->connect_type
;
5724 void usb_hub_adjust_deviceremovable(struct usb_device
*hdev
,
5725 struct usb_hub_descriptor
*desc
)
5727 enum usb_port_connect_type connect_type
;
5730 if (!hub_is_superspeed(hdev
)) {
5731 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
5732 connect_type
= usb_get_hub_port_connect_type(hdev
, i
);
5734 if (connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
5735 u8 mask
= 1 << (i
%8);
5737 if (!(desc
->u
.hs
.DeviceRemovable
[i
/8] & mask
)) {
5738 dev_dbg(&hdev
->dev
, "usb port%d's DeviceRemovable is changed to 1 according to platform information.\n",
5740 desc
->u
.hs
.DeviceRemovable
[i
/8] |= mask
;
5745 u16 port_removable
= le16_to_cpu(desc
->u
.ss
.DeviceRemovable
);
5747 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
5748 connect_type
= usb_get_hub_port_connect_type(hdev
, i
);
5750 if (connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
5753 if (!(port_removable
& mask
)) {
5754 dev_dbg(&hdev
->dev
, "usb port%d's DeviceRemovable is changed to 1 according to platform information.\n",
5756 port_removable
|= mask
;
5761 desc
->u
.ss
.DeviceRemovable
= cpu_to_le16(port_removable
);
5767 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5768 * @hdev: USB device belonging to the usb hub
5769 * @port1: port num of the port
5771 * Return port's acpi handle if successful, NULL if params are
5774 acpi_handle
usb_get_hub_port_acpi_handle(struct usb_device
*hdev
,
5777 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5779 return DEVICE_ACPI_HANDLE(&hub
->ports
[port1
- 1]->dev
);