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 /* Some devices have trouble with LPM */
266 if (udev
->quirks
& USB_QUIRK_NO_LPM
)
269 /* USB 2.1 (and greater) devices indicate LPM support through
270 * their USB 2.0 Extended Capabilities BOS descriptor.
272 if (udev
->speed
== USB_SPEED_HIGH
) {
273 if (udev
->bos
->ext_cap
&&
275 le32_to_cpu(udev
->bos
->ext_cap
->bmAttributes
)))
280 /* All USB 3.0 must support LPM, but we need their max exit latency
281 * information from the SuperSpeed Extended Capabilities BOS descriptor.
283 if (!udev
->bos
->ss_cap
) {
284 dev_warn(&udev
->dev
, "No LPM exit latency info found. "
285 "Power management will be impacted.\n");
288 if (udev
->parent
->lpm_capable
)
291 dev_warn(&udev
->dev
, "Parent hub missing LPM exit latency info. "
292 "Power management will be impacted.\n");
297 * Set the Maximum Exit Latency (MEL) for the host to initiate a transition from
300 static void usb_set_lpm_mel(struct usb_device
*udev
,
301 struct usb3_lpm_parameters
*udev_lpm_params
,
302 unsigned int udev_exit_latency
,
304 struct usb3_lpm_parameters
*hub_lpm_params
,
305 unsigned int hub_exit_latency
)
307 unsigned int total_mel
;
308 unsigned int device_mel
;
309 unsigned int hub_mel
;
312 * Calculate the time it takes to transition all links from the roothub
313 * to the parent hub into U0. The parent hub must then decode the
314 * packet (hub header decode latency) to figure out which port it was
317 * The Hub Header decode latency is expressed in 0.1us intervals (0x1
318 * means 0.1us). Multiply that by 100 to get nanoseconds.
320 total_mel
= hub_lpm_params
->mel
+
321 (hub
->descriptor
->u
.ss
.bHubHdrDecLat
* 100);
324 * How long will it take to transition the downstream hub's port into
325 * U0? The greater of either the hub exit latency or the device exit
328 * The BOS U1/U2 exit latencies are expressed in 1us intervals.
329 * Multiply that by 1000 to get nanoseconds.
331 device_mel
= udev_exit_latency
* 1000;
332 hub_mel
= hub_exit_latency
* 1000;
333 if (device_mel
> hub_mel
)
334 total_mel
+= device_mel
;
336 total_mel
+= hub_mel
;
338 udev_lpm_params
->mel
= total_mel
;
342 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
343 * a transition from either U1 or U2.
345 static void usb_set_lpm_pel(struct usb_device
*udev
,
346 struct usb3_lpm_parameters
*udev_lpm_params
,
347 unsigned int udev_exit_latency
,
349 struct usb3_lpm_parameters
*hub_lpm_params
,
350 unsigned int hub_exit_latency
,
351 unsigned int port_to_port_exit_latency
)
353 unsigned int first_link_pel
;
354 unsigned int hub_pel
;
357 * First, the device sends an LFPS to transition the link between the
358 * device and the parent hub into U0. The exit latency is the bigger of
359 * the device exit latency or the hub exit latency.
361 if (udev_exit_latency
> hub_exit_latency
)
362 first_link_pel
= udev_exit_latency
* 1000;
364 first_link_pel
= hub_exit_latency
* 1000;
367 * When the hub starts to receive the LFPS, there is a slight delay for
368 * it to figure out that one of the ports is sending an LFPS. Then it
369 * will forward the LFPS to its upstream link. The exit latency is the
370 * delay, plus the PEL that we calculated for this hub.
372 hub_pel
= port_to_port_exit_latency
* 1000 + hub_lpm_params
->pel
;
375 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
376 * is the greater of the two exit latencies.
378 if (first_link_pel
> hub_pel
)
379 udev_lpm_params
->pel
= first_link_pel
;
381 udev_lpm_params
->pel
= hub_pel
;
385 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
386 * when a device initiates a transition to U0, until when it will receive the
387 * first packet from the host controller.
389 * Section C.1.5.1 describes the four components to this:
391 * - t2: time for the ERDY to make it from the device to the host.
392 * - t3: a host-specific delay to process the ERDY.
393 * - t4: time for the packet to make it from the host to the device.
395 * t3 is specific to both the xHCI host and the platform the host is integrated
396 * into. The Intel HW folks have said it's negligible, FIXME if a different
397 * vendor says otherwise.
399 static void usb_set_lpm_sel(struct usb_device
*udev
,
400 struct usb3_lpm_parameters
*udev_lpm_params
)
402 struct usb_device
*parent
;
403 unsigned int num_hubs
;
404 unsigned int total_sel
;
406 /* t1 = device PEL */
407 total_sel
= udev_lpm_params
->pel
;
408 /* How many external hubs are in between the device & the root port. */
409 for (parent
= udev
->parent
, num_hubs
= 0; parent
->parent
;
410 parent
= parent
->parent
)
412 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
414 total_sel
+= 2100 + 250 * (num_hubs
- 1);
416 /* t4 = 250ns * num_hubs */
417 total_sel
+= 250 * num_hubs
;
419 udev_lpm_params
->sel
= total_sel
;
422 static void usb_set_lpm_parameters(struct usb_device
*udev
)
425 unsigned int port_to_port_delay
;
426 unsigned int udev_u1_del
;
427 unsigned int udev_u2_del
;
428 unsigned int hub_u1_del
;
429 unsigned int hub_u2_del
;
431 if (!udev
->lpm_capable
|| udev
->speed
!= USB_SPEED_SUPER
)
434 hub
= usb_hub_to_struct_hub(udev
->parent
);
435 /* It doesn't take time to transition the roothub into U0, since it
436 * doesn't have an upstream link.
441 udev_u1_del
= udev
->bos
->ss_cap
->bU1devExitLat
;
442 udev_u2_del
= udev
->bos
->ss_cap
->bU2DevExitLat
;
443 hub_u1_del
= udev
->parent
->bos
->ss_cap
->bU1devExitLat
;
444 hub_u2_del
= udev
->parent
->bos
->ss_cap
->bU2DevExitLat
;
446 usb_set_lpm_mel(udev
, &udev
->u1_params
, udev_u1_del
,
447 hub
, &udev
->parent
->u1_params
, hub_u1_del
);
449 usb_set_lpm_mel(udev
, &udev
->u2_params
, udev_u2_del
,
450 hub
, &udev
->parent
->u2_params
, hub_u2_del
);
453 * Appendix C, section C.2.2.2, says that there is a slight delay from
454 * when the parent hub notices the downstream port is trying to
455 * transition to U0 to when the hub initiates a U0 transition on its
456 * upstream port. The section says the delays are tPort2PortU1EL and
457 * tPort2PortU2EL, but it doesn't define what they are.
459 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
460 * about the same delays. Use the maximum delay calculations from those
461 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
462 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
463 * assume the device exit latencies they are talking about are the hub
466 * What do we do if the U2 exit latency is less than the U1 exit
467 * latency? It's possible, although not likely...
469 port_to_port_delay
= 1;
471 usb_set_lpm_pel(udev
, &udev
->u1_params
, udev_u1_del
,
472 hub
, &udev
->parent
->u1_params
, hub_u1_del
,
475 if (hub_u2_del
> hub_u1_del
)
476 port_to_port_delay
= 1 + hub_u2_del
- hub_u1_del
;
478 port_to_port_delay
= 1 + hub_u1_del
;
480 usb_set_lpm_pel(udev
, &udev
->u2_params
, udev_u2_del
,
481 hub
, &udev
->parent
->u2_params
, hub_u2_del
,
484 /* Now that we've got PEL, calculate SEL. */
485 usb_set_lpm_sel(udev
, &udev
->u1_params
);
486 usb_set_lpm_sel(udev
, &udev
->u2_params
);
489 /* USB 2.0 spec Section 11.24.4.5 */
490 static int get_hub_descriptor(struct usb_device
*hdev
, void *data
)
495 if (hub_is_superspeed(hdev
)) {
496 dtype
= USB_DT_SS_HUB
;
497 size
= USB_DT_SS_HUB_SIZE
;
500 size
= sizeof(struct usb_hub_descriptor
);
503 for (i
= 0; i
< 3; i
++) {
504 ret
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
505 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
| USB_RT_HUB
,
506 dtype
<< 8, 0, data
, size
,
507 USB_CTRL_GET_TIMEOUT
);
508 if (ret
>= (USB_DT_HUB_NONVAR_SIZE
+ 2))
515 * USB 2.0 spec Section 11.24.2.1
517 static int clear_hub_feature(struct usb_device
*hdev
, int feature
)
519 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
520 USB_REQ_CLEAR_FEATURE
, USB_RT_HUB
, feature
, 0, NULL
, 0, 1000);
524 * USB 2.0 spec Section 11.24.2.2
526 int usb_clear_port_feature(struct usb_device
*hdev
, int port1
, int feature
)
528 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
529 USB_REQ_CLEAR_FEATURE
, USB_RT_PORT
, feature
, port1
,
534 * USB 2.0 spec Section 11.24.2.13
536 static int set_port_feature(struct usb_device
*hdev
, int port1
, int feature
)
539 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
540 USB_REQ_SET_FEATURE
, USB_RT_PORT
, feature
, port1
,
545 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
546 * for info about using port indicators
548 static void set_port_led(
554 int status
= set_port_feature(hub
->hdev
, (selector
<< 8) | port1
,
555 USB_PORT_FEAT_INDICATOR
);
557 dev_dbg (hub
->intfdev
,
558 "port %d indicator %s status %d\n",
560 ({ char *s
; switch (selector
) {
561 case HUB_LED_AMBER
: s
= "amber"; break;
562 case HUB_LED_GREEN
: s
= "green"; break;
563 case HUB_LED_OFF
: s
= "off"; break;
564 case HUB_LED_AUTO
: s
= "auto"; break;
565 default: s
= "??"; break;
570 #define LED_CYCLE_PERIOD ((2*HZ)/3)
572 static void led_work (struct work_struct
*work
)
574 struct usb_hub
*hub
=
575 container_of(work
, struct usb_hub
, leds
.work
);
576 struct usb_device
*hdev
= hub
->hdev
;
578 unsigned changed
= 0;
581 if (hdev
->state
!= USB_STATE_CONFIGURED
|| hub
->quiescing
)
584 for (i
= 0; i
< hub
->descriptor
->bNbrPorts
; i
++) {
585 unsigned selector
, mode
;
587 /* 30%-50% duty cycle */
589 switch (hub
->indicator
[i
]) {
591 case INDICATOR_CYCLE
:
593 selector
= HUB_LED_AUTO
;
594 mode
= INDICATOR_AUTO
;
596 /* blinking green = sw attention */
597 case INDICATOR_GREEN_BLINK
:
598 selector
= HUB_LED_GREEN
;
599 mode
= INDICATOR_GREEN_BLINK_OFF
;
601 case INDICATOR_GREEN_BLINK_OFF
:
602 selector
= HUB_LED_OFF
;
603 mode
= INDICATOR_GREEN_BLINK
;
605 /* blinking amber = hw attention */
606 case INDICATOR_AMBER_BLINK
:
607 selector
= HUB_LED_AMBER
;
608 mode
= INDICATOR_AMBER_BLINK_OFF
;
610 case INDICATOR_AMBER_BLINK_OFF
:
611 selector
= HUB_LED_OFF
;
612 mode
= INDICATOR_AMBER_BLINK
;
614 /* blink green/amber = reserved */
615 case INDICATOR_ALT_BLINK
:
616 selector
= HUB_LED_GREEN
;
617 mode
= INDICATOR_ALT_BLINK_OFF
;
619 case INDICATOR_ALT_BLINK_OFF
:
620 selector
= HUB_LED_AMBER
;
621 mode
= INDICATOR_ALT_BLINK
;
626 if (selector
!= HUB_LED_AUTO
)
628 set_port_led(hub
, i
+ 1, selector
);
629 hub
->indicator
[i
] = mode
;
631 if (!changed
&& blinkenlights
) {
633 cursor
%= hub
->descriptor
->bNbrPorts
;
634 set_port_led(hub
, cursor
+ 1, HUB_LED_GREEN
);
635 hub
->indicator
[cursor
] = INDICATOR_CYCLE
;
639 schedule_delayed_work(&hub
->leds
, LED_CYCLE_PERIOD
);
642 /* use a short timeout for hub/port status fetches */
643 #define USB_STS_TIMEOUT 1000
644 #define USB_STS_RETRIES 5
647 * USB 2.0 spec Section 11.24.2.6
649 static int get_hub_status(struct usb_device
*hdev
,
650 struct usb_hub_status
*data
)
652 int i
, status
= -ETIMEDOUT
;
654 for (i
= 0; i
< USB_STS_RETRIES
&&
655 (status
== -ETIMEDOUT
|| status
== -EPIPE
); i
++) {
656 status
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
657 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_HUB
, 0, 0,
658 data
, sizeof(*data
), USB_STS_TIMEOUT
);
664 * USB 2.0 spec Section 11.24.2.7
666 static int get_port_status(struct usb_device
*hdev
, int port1
,
667 struct usb_port_status
*data
)
669 int i
, status
= -ETIMEDOUT
;
671 for (i
= 0; i
< USB_STS_RETRIES
&&
672 (status
== -ETIMEDOUT
|| status
== -EPIPE
); i
++) {
673 status
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
674 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_PORT
, 0, port1
,
675 data
, sizeof(*data
), USB_STS_TIMEOUT
);
680 static int hub_port_status(struct usb_hub
*hub
, int port1
,
681 u16
*status
, u16
*change
)
685 mutex_lock(&hub
->status_mutex
);
686 ret
= get_port_status(hub
->hdev
, port1
, &hub
->status
->port
);
689 dev_err(hub
->intfdev
,
690 "%s failed (err = %d)\n", __func__
, ret
);
694 *status
= le16_to_cpu(hub
->status
->port
.wPortStatus
);
695 *change
= le16_to_cpu(hub
->status
->port
.wPortChange
);
699 mutex_unlock(&hub
->status_mutex
);
703 static void kick_khubd(struct usb_hub
*hub
)
707 spin_lock_irqsave(&hub_event_lock
, flags
);
708 if (!hub
->disconnected
&& list_empty(&hub
->event_list
)) {
709 list_add_tail(&hub
->event_list
, &hub_event_list
);
711 /* Suppress autosuspend until khubd runs */
712 usb_autopm_get_interface_no_resume(
713 to_usb_interface(hub
->intfdev
));
714 wake_up(&khubd_wait
);
716 spin_unlock_irqrestore(&hub_event_lock
, flags
);
719 void usb_kick_khubd(struct usb_device
*hdev
)
721 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
728 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
729 * Notification, which indicates it had initiated remote wakeup.
731 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
732 * device initiates resume, so the USB core will not receive notice of the
733 * resume through the normal hub interrupt URB.
735 void usb_wakeup_notification(struct usb_device
*hdev
,
736 unsigned int portnum
)
743 hub
= usb_hub_to_struct_hub(hdev
);
745 set_bit(portnum
, hub
->wakeup_bits
);
749 EXPORT_SYMBOL_GPL(usb_wakeup_notification
);
751 /* completion function, fires on port status changes and various faults */
752 static void hub_irq(struct urb
*urb
)
754 struct usb_hub
*hub
= urb
->context
;
755 int status
= urb
->status
;
760 case -ENOENT
: /* synchronous unlink */
761 case -ECONNRESET
: /* async unlink */
762 case -ESHUTDOWN
: /* hardware going away */
765 default: /* presumably an error */
766 /* Cause a hub reset after 10 consecutive errors */
767 dev_dbg (hub
->intfdev
, "transfer --> %d\n", status
);
768 if ((++hub
->nerrors
< 10) || hub
->error
)
773 /* let khubd handle things */
774 case 0: /* we got data: port status changed */
776 for (i
= 0; i
< urb
->actual_length
; ++i
)
777 bits
|= ((unsigned long) ((*hub
->buffer
)[i
]))
779 hub
->event_bits
[0] = bits
;
785 /* Something happened, let khubd figure it out */
792 if ((status
= usb_submit_urb (hub
->urb
, GFP_ATOMIC
)) != 0
793 && status
!= -ENODEV
&& status
!= -EPERM
)
794 dev_err (hub
->intfdev
, "resubmit --> %d\n", status
);
797 /* USB 2.0 spec Section 11.24.2.3 */
799 hub_clear_tt_buffer (struct usb_device
*hdev
, u16 devinfo
, u16 tt
)
801 /* Need to clear both directions for control ep */
802 if (((devinfo
>> 11) & USB_ENDPOINT_XFERTYPE_MASK
) ==
803 USB_ENDPOINT_XFER_CONTROL
) {
804 int status
= usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
805 HUB_CLEAR_TT_BUFFER
, USB_RT_PORT
,
806 devinfo
^ 0x8000, tt
, NULL
, 0, 1000);
810 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
811 HUB_CLEAR_TT_BUFFER
, USB_RT_PORT
, devinfo
,
816 * enumeration blocks khubd for a long time. we use keventd instead, since
817 * long blocking there is the exception, not the rule. accordingly, HCDs
818 * talking to TTs must queue control transfers (not just bulk and iso), so
819 * both can talk to the same hub concurrently.
821 static void hub_tt_work(struct work_struct
*work
)
823 struct usb_hub
*hub
=
824 container_of(work
, struct usb_hub
, tt
.clear_work
);
827 spin_lock_irqsave (&hub
->tt
.lock
, flags
);
828 while (!list_empty(&hub
->tt
.clear_list
)) {
829 struct list_head
*next
;
830 struct usb_tt_clear
*clear
;
831 struct usb_device
*hdev
= hub
->hdev
;
832 const struct hc_driver
*drv
;
835 next
= hub
->tt
.clear_list
.next
;
836 clear
= list_entry (next
, struct usb_tt_clear
, clear_list
);
837 list_del (&clear
->clear_list
);
839 /* drop lock so HCD can concurrently report other TT errors */
840 spin_unlock_irqrestore (&hub
->tt
.lock
, flags
);
841 status
= hub_clear_tt_buffer (hdev
, clear
->devinfo
, clear
->tt
);
842 if (status
&& status
!= -ENODEV
)
844 "clear tt %d (%04x) error %d\n",
845 clear
->tt
, clear
->devinfo
, status
);
847 /* Tell the HCD, even if the operation failed */
848 drv
= clear
->hcd
->driver
;
849 if (drv
->clear_tt_buffer_complete
)
850 (drv
->clear_tt_buffer_complete
)(clear
->hcd
, clear
->ep
);
853 spin_lock_irqsave(&hub
->tt
.lock
, flags
);
855 spin_unlock_irqrestore (&hub
->tt
.lock
, flags
);
859 * usb_hub_set_port_power - control hub port's power state
862 * @set: expected status
864 * call this function to control port's power via setting or
865 * clearing the port's PORT_POWER feature.
867 int usb_hub_set_port_power(struct usb_device
*hdev
, int port1
,
871 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
872 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
875 ret
= set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
877 ret
= usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
880 port_dev
->power_is_on
= set
;
885 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
886 * @urb: an URB associated with the failed or incomplete split transaction
888 * High speed HCDs use this to tell the hub driver that some split control or
889 * bulk transaction failed in a way that requires clearing internal state of
890 * a transaction translator. This is normally detected (and reported) from
893 * It may not be possible for that hub to handle additional full (or low)
894 * speed transactions until that state is fully cleared out.
896 int usb_hub_clear_tt_buffer(struct urb
*urb
)
898 struct usb_device
*udev
= urb
->dev
;
899 int pipe
= urb
->pipe
;
900 struct usb_tt
*tt
= udev
->tt
;
902 struct usb_tt_clear
*clear
;
904 /* we've got to cope with an arbitrary number of pending TT clears,
905 * since each TT has "at least two" buffers that can need it (and
906 * there can be many TTs per hub). even if they're uncommon.
908 if ((clear
= kmalloc (sizeof *clear
, GFP_ATOMIC
)) == NULL
) {
909 dev_err (&udev
->dev
, "can't save CLEAR_TT_BUFFER state\n");
910 /* FIXME recover somehow ... RESET_TT? */
914 /* info that CLEAR_TT_BUFFER needs */
915 clear
->tt
= tt
->multi
? udev
->ttport
: 1;
916 clear
->devinfo
= usb_pipeendpoint (pipe
);
917 clear
->devinfo
|= udev
->devnum
<< 4;
918 clear
->devinfo
|= usb_pipecontrol (pipe
)
919 ? (USB_ENDPOINT_XFER_CONTROL
<< 11)
920 : (USB_ENDPOINT_XFER_BULK
<< 11);
921 if (usb_pipein (pipe
))
922 clear
->devinfo
|= 1 << 15;
924 /* info for completion callback */
925 clear
->hcd
= bus_to_hcd(udev
->bus
);
928 /* tell keventd to clear state for this TT */
929 spin_lock_irqsave (&tt
->lock
, flags
);
930 list_add_tail (&clear
->clear_list
, &tt
->clear_list
);
931 schedule_work(&tt
->clear_work
);
932 spin_unlock_irqrestore (&tt
->lock
, flags
);
935 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer
);
937 /* If do_delay is false, return the number of milliseconds the caller
940 static unsigned hub_power_on(struct usb_hub
*hub
, bool do_delay
)
943 unsigned pgood_delay
= hub
->descriptor
->bPwrOn2PwrGood
* 2;
945 u16 wHubCharacteristics
=
946 le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
948 /* Enable power on each port. Some hubs have reserved values
949 * of LPSM (> 2) in their descriptors, even though they are
950 * USB 2.0 hubs. Some hubs do not implement port-power switching
951 * but only emulate it. In all cases, the ports won't work
952 * unless we send these messages to the hub.
954 if ((wHubCharacteristics
& HUB_CHAR_LPSM
) < 2)
955 dev_dbg(hub
->intfdev
, "enabling power on all ports\n");
957 dev_dbg(hub
->intfdev
, "trying to enable port power on "
958 "non-switchable hub\n");
959 for (port1
= 1; port1
<= hub
->descriptor
->bNbrPorts
; port1
++)
960 if (hub
->ports
[port1
- 1]->power_is_on
)
961 set_port_feature(hub
->hdev
, port1
, USB_PORT_FEAT_POWER
);
963 usb_clear_port_feature(hub
->hdev
, port1
,
964 USB_PORT_FEAT_POWER
);
966 /* Wait at least 100 msec for power to become stable */
967 delay
= max(pgood_delay
, (unsigned) 100);
973 static int hub_hub_status(struct usb_hub
*hub
,
974 u16
*status
, u16
*change
)
978 mutex_lock(&hub
->status_mutex
);
979 ret
= get_hub_status(hub
->hdev
, &hub
->status
->hub
);
982 dev_err(hub
->intfdev
,
983 "%s failed (err = %d)\n", __func__
, ret
);
985 *status
= le16_to_cpu(hub
->status
->hub
.wHubStatus
);
986 *change
= le16_to_cpu(hub
->status
->hub
.wHubChange
);
989 mutex_unlock(&hub
->status_mutex
);
993 static int hub_set_port_link_state(struct usb_hub
*hub
, int port1
,
994 unsigned int link_status
)
996 return set_port_feature(hub
->hdev
,
997 port1
| (link_status
<< 3),
998 USB_PORT_FEAT_LINK_STATE
);
1002 * If USB 3.0 ports are placed into the Disabled state, they will no longer
1003 * detect any device connects or disconnects. This is generally not what the
1004 * USB core wants, since it expects a disabled port to produce a port status
1005 * change event when a new device connects.
1007 * Instead, set the link state to Disabled, wait for the link to settle into
1008 * that state, clear any change bits, and then put the port into the RxDetect
1011 static int hub_usb3_port_disable(struct usb_hub
*hub
, int port1
)
1015 u16 portchange
, portstatus
;
1017 if (!hub_is_superspeed(hub
->hdev
))
1020 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
1025 * USB controller Advanced Micro Devices, Inc. [AMD] FCH USB XHCI
1026 * Controller [1022:7814] will have spurious result making the following
1027 * usb 3.0 device hotplugging route to the 2.0 root hub and recognized
1028 * as high-speed device if we set the usb 3.0 port link state to
1029 * Disabled. Since it's already in USB_SS_PORT_LS_RX_DETECT state, we
1030 * check the state here to avoid the bug.
1032 if ((portstatus
& USB_PORT_STAT_LINK_STATE
) ==
1033 USB_SS_PORT_LS_RX_DETECT
) {
1034 dev_dbg(&hub
->ports
[port1
- 1]->dev
,
1035 "Not disabling port; link state is RxDetect\n");
1039 ret
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_SS_DISABLED
);
1043 /* Wait for the link to enter the disabled state. */
1044 for (total_time
= 0; ; total_time
+= HUB_DEBOUNCE_STEP
) {
1045 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
1049 if ((portstatus
& USB_PORT_STAT_LINK_STATE
) ==
1050 USB_SS_PORT_LS_SS_DISABLED
)
1052 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
1054 msleep(HUB_DEBOUNCE_STEP
);
1056 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
1057 dev_warn(hub
->intfdev
, "Could not disable port %d after %d ms\n",
1060 return hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_RX_DETECT
);
1063 static int hub_port_disable(struct usb_hub
*hub
, int port1
, int set_state
)
1065 struct usb_device
*hdev
= hub
->hdev
;
1068 if (hub
->ports
[port1
- 1]->child
&& set_state
)
1069 usb_set_device_state(hub
->ports
[port1
- 1]->child
,
1070 USB_STATE_NOTATTACHED
);
1072 if (hub_is_superspeed(hub
->hdev
))
1073 ret
= hub_usb3_port_disable(hub
, port1
);
1075 ret
= usb_clear_port_feature(hdev
, port1
,
1076 USB_PORT_FEAT_ENABLE
);
1078 if (ret
&& ret
!= -ENODEV
)
1079 dev_err(hub
->intfdev
, "cannot disable port %d (err = %d)\n",
1085 * Disable a port and mark a logical connect-change event, so that some
1086 * time later khubd will disconnect() any existing usb_device on the port
1087 * and will re-enumerate if there actually is a device attached.
1089 static void hub_port_logical_disconnect(struct usb_hub
*hub
, int port1
)
1091 dev_dbg(hub
->intfdev
, "logical disconnect on port %d\n", port1
);
1092 hub_port_disable(hub
, port1
, 1);
1094 /* FIXME let caller ask to power down the port:
1095 * - some devices won't enumerate without a VBUS power cycle
1096 * - SRP saves power that way
1097 * - ... new call, TBD ...
1098 * That's easy if this hub can switch power per-port, and
1099 * khubd reactivates the port later (timer, SRP, etc).
1100 * Powerdown must be optional, because of reset/DFU.
1103 set_bit(port1
, hub
->change_bits
);
1108 * usb_remove_device - disable a device's port on its parent hub
1109 * @udev: device to be disabled and removed
1110 * Context: @udev locked, must be able to sleep.
1112 * After @udev's port has been disabled, khubd is notified and it will
1113 * see that the device has been disconnected. When the device is
1114 * physically unplugged and something is plugged in, the events will
1115 * be received and processed normally.
1117 int usb_remove_device(struct usb_device
*udev
)
1119 struct usb_hub
*hub
;
1120 struct usb_interface
*intf
;
1122 if (!udev
->parent
) /* Can't remove a root hub */
1124 hub
= usb_hub_to_struct_hub(udev
->parent
);
1125 intf
= to_usb_interface(hub
->intfdev
);
1127 usb_autopm_get_interface(intf
);
1128 set_bit(udev
->portnum
, hub
->removed_bits
);
1129 hub_port_logical_disconnect(hub
, udev
->portnum
);
1130 usb_autopm_put_interface(intf
);
1134 enum hub_activation_type
{
1135 HUB_INIT
, HUB_INIT2
, HUB_INIT3
, /* INITs must come first */
1136 HUB_POST_RESET
, HUB_RESUME
, HUB_RESET_RESUME
,
1139 static void hub_init_func2(struct work_struct
*ws
);
1140 static void hub_init_func3(struct work_struct
*ws
);
1142 static void hub_activate(struct usb_hub
*hub
, enum hub_activation_type type
)
1144 struct usb_device
*hdev
= hub
->hdev
;
1145 struct usb_hcd
*hcd
;
1149 bool need_debounce_delay
= false;
1152 /* Continue a partial initialization */
1153 if (type
== HUB_INIT2
|| type
== HUB_INIT3
) {
1154 device_lock(hub
->intfdev
);
1156 /* Was the hub disconnected while we were waiting? */
1157 if (hub
->disconnected
) {
1158 device_unlock(hub
->intfdev
);
1159 kref_put(&hub
->kref
, hub_release
);
1162 if (type
== HUB_INIT2
)
1167 kref_get(&hub
->kref
);
1169 /* The superspeed hub except for root hub has to use Hub Depth
1170 * value as an offset into the route string to locate the bits
1171 * it uses to determine the downstream port number. So hub driver
1172 * should send a set hub depth request to superspeed hub after
1173 * the superspeed hub is set configuration in initialization or
1176 * After a resume, port power should still be on.
1177 * For any other type of activation, turn it on.
1179 if (type
!= HUB_RESUME
) {
1180 if (hdev
->parent
&& hub_is_superspeed(hdev
)) {
1181 ret
= usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
1182 HUB_SET_DEPTH
, USB_RT_HUB
,
1183 hdev
->level
- 1, 0, NULL
, 0,
1184 USB_CTRL_SET_TIMEOUT
);
1186 dev_err(hub
->intfdev
,
1187 "set hub depth failed\n");
1190 /* Speed up system boot by using a delayed_work for the
1191 * hub's initial power-up delays. This is pretty awkward
1192 * and the implementation looks like a home-brewed sort of
1193 * setjmp/longjmp, but it saves at least 100 ms for each
1194 * root hub (assuming usbcore is compiled into the kernel
1195 * rather than as a module). It adds up.
1197 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1198 * because for those activation types the ports have to be
1199 * operational when we return. In theory this could be done
1200 * for HUB_POST_RESET, but it's easier not to.
1202 if (type
== HUB_INIT
) {
1203 delay
= hub_power_on(hub
, false);
1204 PREPARE_DELAYED_WORK(&hub
->init_work
, hub_init_func2
);
1205 schedule_delayed_work(&hub
->init_work
,
1206 msecs_to_jiffies(delay
));
1208 /* Suppress autosuspend until init is done */
1209 usb_autopm_get_interface_no_resume(
1210 to_usb_interface(hub
->intfdev
));
1211 return; /* Continues at init2: below */
1212 } else if (type
== HUB_RESET_RESUME
) {
1213 /* The internal host controller state for the hub device
1214 * may be gone after a host power loss on system resume.
1215 * Update the device's info so the HW knows it's a hub.
1217 hcd
= bus_to_hcd(hdev
->bus
);
1218 if (hcd
->driver
->update_hub_device
) {
1219 ret
= hcd
->driver
->update_hub_device(hcd
, hdev
,
1220 &hub
->tt
, GFP_NOIO
);
1222 dev_err(hub
->intfdev
, "Host not "
1223 "accepting hub info "
1225 dev_err(hub
->intfdev
, "LS/FS devices "
1226 "and hubs may not work "
1227 "under this hub\n.");
1230 hub_power_on(hub
, true);
1232 hub_power_on(hub
, true);
1237 /* Check each port and set hub->change_bits to let khubd know
1238 * which ports need attention.
1240 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
1241 struct usb_device
*udev
= hub
->ports
[port1
- 1]->child
;
1242 u16 portstatus
, portchange
;
1244 portstatus
= portchange
= 0;
1245 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
1246 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
))
1247 dev_dbg(hub
->intfdev
,
1248 "port %d: status %04x change %04x\n",
1249 port1
, portstatus
, portchange
);
1251 /* After anything other than HUB_RESUME (i.e., initialization
1252 * or any sort of reset), every port should be disabled.
1253 * Unconnected ports should likewise be disabled (paranoia),
1254 * and so should ports for which we have no usb_device.
1256 if ((portstatus
& USB_PORT_STAT_ENABLE
) && (
1257 type
!= HUB_RESUME
||
1258 !(portstatus
& USB_PORT_STAT_CONNECTION
) ||
1260 udev
->state
== USB_STATE_NOTATTACHED
)) {
1262 * USB3 protocol ports will automatically transition
1263 * to Enabled state when detect an USB3.0 device attach.
1264 * Do not disable USB3 protocol ports.
1266 if (!hub_is_superspeed(hdev
)) {
1267 usb_clear_port_feature(hdev
, port1
,
1268 USB_PORT_FEAT_ENABLE
);
1269 portstatus
&= ~USB_PORT_STAT_ENABLE
;
1271 /* Pretend that power was lost for USB3 devs */
1272 portstatus
&= ~USB_PORT_STAT_ENABLE
;
1276 /* Clear status-change flags; we'll debounce later */
1277 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
1278 need_debounce_delay
= true;
1279 usb_clear_port_feature(hub
->hdev
, port1
,
1280 USB_PORT_FEAT_C_CONNECTION
);
1282 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
1283 need_debounce_delay
= true;
1284 usb_clear_port_feature(hub
->hdev
, port1
,
1285 USB_PORT_FEAT_C_ENABLE
);
1287 if (portchange
& USB_PORT_STAT_C_RESET
) {
1288 need_debounce_delay
= true;
1289 usb_clear_port_feature(hub
->hdev
, port1
,
1290 USB_PORT_FEAT_C_RESET
);
1292 if ((portchange
& USB_PORT_STAT_C_BH_RESET
) &&
1293 hub_is_superspeed(hub
->hdev
)) {
1294 need_debounce_delay
= true;
1295 usb_clear_port_feature(hub
->hdev
, port1
,
1296 USB_PORT_FEAT_C_BH_PORT_RESET
);
1298 /* We can forget about a "removed" device when there's a
1299 * physical disconnect or the connect status changes.
1301 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
1302 (portchange
& USB_PORT_STAT_C_CONNECTION
))
1303 clear_bit(port1
, hub
->removed_bits
);
1305 if (!udev
|| udev
->state
== USB_STATE_NOTATTACHED
) {
1306 /* Tell khubd to disconnect the device or
1307 * check for a new connection
1309 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
) ||
1310 (portstatus
& USB_PORT_STAT_OVERCURRENT
))
1311 set_bit(port1
, hub
->change_bits
);
1313 } else if (portstatus
& USB_PORT_STAT_ENABLE
) {
1314 bool port_resumed
= (portstatus
&
1315 USB_PORT_STAT_LINK_STATE
) ==
1317 /* The power session apparently survived the resume.
1318 * If there was an overcurrent or suspend change
1319 * (i.e., remote wakeup request), have khubd
1320 * take care of it. Look at the port link state
1321 * for USB 3.0 hubs, since they don't have a suspend
1322 * change bit, and they don't set the port link change
1323 * bit on device-initiated resume.
1325 if (portchange
|| (hub_is_superspeed(hub
->hdev
) &&
1327 set_bit(port1
, hub
->change_bits
);
1329 } else if (udev
->persist_enabled
) {
1330 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
1333 udev
->reset_resume
= 1;
1335 /* Don't set the change_bits when the device
1338 if (port_dev
->power_is_on
)
1339 set_bit(port1
, hub
->change_bits
);
1342 /* The power session is gone; tell khubd */
1343 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
1344 set_bit(port1
, hub
->change_bits
);
1348 /* If no port-status-change flags were set, we don't need any
1349 * debouncing. If flags were set we can try to debounce the
1350 * ports all at once right now, instead of letting khubd do them
1351 * one at a time later on.
1353 * If any port-status changes do occur during this delay, khubd
1354 * will see them later and handle them normally.
1356 if (need_debounce_delay
) {
1357 delay
= HUB_DEBOUNCE_STABLE
;
1359 /* Don't do a long sleep inside a workqueue routine */
1360 if (type
== HUB_INIT2
) {
1361 PREPARE_DELAYED_WORK(&hub
->init_work
, hub_init_func3
);
1362 schedule_delayed_work(&hub
->init_work
,
1363 msecs_to_jiffies(delay
));
1364 device_unlock(hub
->intfdev
);
1365 return; /* Continues at init3: below */
1373 status
= usb_submit_urb(hub
->urb
, GFP_NOIO
);
1375 dev_err(hub
->intfdev
, "activate --> %d\n", status
);
1376 if (hub
->has_indicators
&& blinkenlights
)
1377 schedule_delayed_work(&hub
->leds
, LED_CYCLE_PERIOD
);
1379 /* Scan all ports that need attention */
1382 /* Allow autosuspend if it was suppressed */
1383 if (type
<= HUB_INIT3
)
1384 usb_autopm_put_interface_async(to_usb_interface(hub
->intfdev
));
1386 if (type
== HUB_INIT2
|| type
== HUB_INIT3
)
1387 device_unlock(hub
->intfdev
);
1389 kref_put(&hub
->kref
, hub_release
);
1392 /* Implement the continuations for the delays above */
1393 static void hub_init_func2(struct work_struct
*ws
)
1395 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
1397 hub_activate(hub
, HUB_INIT2
);
1400 static void hub_init_func3(struct work_struct
*ws
)
1402 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
1404 hub_activate(hub
, HUB_INIT3
);
1407 enum hub_quiescing_type
{
1408 HUB_DISCONNECT
, HUB_PRE_RESET
, HUB_SUSPEND
1411 static void hub_quiesce(struct usb_hub
*hub
, enum hub_quiescing_type type
)
1413 struct usb_device
*hdev
= hub
->hdev
;
1416 cancel_delayed_work_sync(&hub
->init_work
);
1418 /* khubd and related activity won't re-trigger */
1421 if (type
!= HUB_SUSPEND
) {
1422 /* Disconnect all the children */
1423 for (i
= 0; i
< hdev
->maxchild
; ++i
) {
1424 if (hub
->ports
[i
]->child
)
1425 usb_disconnect(&hub
->ports
[i
]->child
);
1429 /* Stop khubd and related activity */
1430 usb_kill_urb(hub
->urb
);
1431 if (hub
->has_indicators
)
1432 cancel_delayed_work_sync(&hub
->leds
);
1434 flush_work(&hub
->tt
.clear_work
);
1437 /* caller has locked the hub device */
1438 static int hub_pre_reset(struct usb_interface
*intf
)
1440 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1442 hub_quiesce(hub
, HUB_PRE_RESET
);
1446 /* caller has locked the hub device */
1447 static int hub_post_reset(struct usb_interface
*intf
)
1449 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1451 hub_activate(hub
, HUB_POST_RESET
);
1455 static int hub_configure(struct usb_hub
*hub
,
1456 struct usb_endpoint_descriptor
*endpoint
)
1458 struct usb_hcd
*hcd
;
1459 struct usb_device
*hdev
= hub
->hdev
;
1460 struct device
*hub_dev
= hub
->intfdev
;
1461 u16 hubstatus
, hubchange
;
1462 u16 wHubCharacteristics
;
1465 char *message
= "out of memory";
1469 hub
->buffer
= kmalloc(sizeof(*hub
->buffer
), GFP_KERNEL
);
1475 hub
->status
= kmalloc(sizeof(*hub
->status
), GFP_KERNEL
);
1480 mutex_init(&hub
->status_mutex
);
1482 hub
->descriptor
= kmalloc(sizeof(*hub
->descriptor
), GFP_KERNEL
);
1483 if (!hub
->descriptor
) {
1488 /* Request the entire hub descriptor.
1489 * hub->descriptor can handle USB_MAXCHILDREN ports,
1490 * but the hub can/will return fewer bytes here.
1492 ret
= get_hub_descriptor(hdev
, hub
->descriptor
);
1494 message
= "can't read hub descriptor";
1496 } else if (hub
->descriptor
->bNbrPorts
> USB_MAXCHILDREN
) {
1497 message
= "hub has too many ports!";
1500 } else if (hub
->descriptor
->bNbrPorts
== 0) {
1501 message
= "hub doesn't have any ports!";
1506 hdev
->maxchild
= hub
->descriptor
->bNbrPorts
;
1507 dev_info (hub_dev
, "%d port%s detected\n", hdev
->maxchild
,
1508 (hdev
->maxchild
== 1) ? "" : "s");
1510 hub
->ports
= kzalloc(hdev
->maxchild
* sizeof(struct usb_port
*),
1517 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
1518 if (hub_is_superspeed(hdev
)) {
1526 /* FIXME for USB 3.0, skip for now */
1527 if ((wHubCharacteristics
& HUB_CHAR_COMPOUND
) &&
1528 !(hub_is_superspeed(hdev
))) {
1530 char portstr
[USB_MAXCHILDREN
+ 1];
1532 for (i
= 0; i
< hdev
->maxchild
; i
++)
1533 portstr
[i
] = hub
->descriptor
->u
.hs
.DeviceRemovable
1534 [((i
+ 1) / 8)] & (1 << ((i
+ 1) % 8))
1536 portstr
[hdev
->maxchild
] = 0;
1537 dev_dbg(hub_dev
, "compound device; port removable status: %s\n", portstr
);
1539 dev_dbg(hub_dev
, "standalone hub\n");
1541 switch (wHubCharacteristics
& HUB_CHAR_LPSM
) {
1542 case HUB_CHAR_COMMON_LPSM
:
1543 dev_dbg(hub_dev
, "ganged power switching\n");
1545 case HUB_CHAR_INDV_PORT_LPSM
:
1546 dev_dbg(hub_dev
, "individual port power switching\n");
1548 case HUB_CHAR_NO_LPSM
:
1550 dev_dbg(hub_dev
, "no power switching (usb 1.0)\n");
1554 switch (wHubCharacteristics
& HUB_CHAR_OCPM
) {
1555 case HUB_CHAR_COMMON_OCPM
:
1556 dev_dbg(hub_dev
, "global over-current protection\n");
1558 case HUB_CHAR_INDV_PORT_OCPM
:
1559 dev_dbg(hub_dev
, "individual port over-current protection\n");
1561 case HUB_CHAR_NO_OCPM
:
1563 dev_dbg(hub_dev
, "no over-current protection\n");
1567 spin_lock_init (&hub
->tt
.lock
);
1568 INIT_LIST_HEAD (&hub
->tt
.clear_list
);
1569 INIT_WORK(&hub
->tt
.clear_work
, hub_tt_work
);
1570 switch (hdev
->descriptor
.bDeviceProtocol
) {
1573 case USB_HUB_PR_HS_SINGLE_TT
:
1574 dev_dbg(hub_dev
, "Single TT\n");
1577 case USB_HUB_PR_HS_MULTI_TT
:
1578 ret
= usb_set_interface(hdev
, 0, 1);
1580 dev_dbg(hub_dev
, "TT per port\n");
1583 dev_err(hub_dev
, "Using single TT (err %d)\n",
1588 /* USB 3.0 hubs don't have a TT */
1591 dev_dbg(hub_dev
, "Unrecognized hub protocol %d\n",
1592 hdev
->descriptor
.bDeviceProtocol
);
1596 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1597 switch (wHubCharacteristics
& HUB_CHAR_TTTT
) {
1598 case HUB_TTTT_8_BITS
:
1599 if (hdev
->descriptor
.bDeviceProtocol
!= 0) {
1600 hub
->tt
.think_time
= 666;
1601 dev_dbg(hub_dev
, "TT requires at most %d "
1602 "FS bit times (%d ns)\n",
1603 8, hub
->tt
.think_time
);
1606 case HUB_TTTT_16_BITS
:
1607 hub
->tt
.think_time
= 666 * 2;
1608 dev_dbg(hub_dev
, "TT requires at most %d "
1609 "FS bit times (%d ns)\n",
1610 16, hub
->tt
.think_time
);
1612 case HUB_TTTT_24_BITS
:
1613 hub
->tt
.think_time
= 666 * 3;
1614 dev_dbg(hub_dev
, "TT requires at most %d "
1615 "FS bit times (%d ns)\n",
1616 24, hub
->tt
.think_time
);
1618 case HUB_TTTT_32_BITS
:
1619 hub
->tt
.think_time
= 666 * 4;
1620 dev_dbg(hub_dev
, "TT requires at most %d "
1621 "FS bit times (%d ns)\n",
1622 32, hub
->tt
.think_time
);
1626 /* probe() zeroes hub->indicator[] */
1627 if (wHubCharacteristics
& HUB_CHAR_PORTIND
) {
1628 hub
->has_indicators
= 1;
1629 dev_dbg(hub_dev
, "Port indicators are supported\n");
1632 dev_dbg(hub_dev
, "power on to power good time: %dms\n",
1633 hub
->descriptor
->bPwrOn2PwrGood
* 2);
1635 /* power budgeting mostly matters with bus-powered hubs,
1636 * and battery-powered root hubs (may provide just 8 mA).
1638 ret
= usb_get_status(hdev
, USB_RECIP_DEVICE
, 0, &hubstatus
);
1640 message
= "can't get hub status";
1643 le16_to_cpus(&hubstatus
);
1644 hcd
= bus_to_hcd(hdev
->bus
);
1645 if (hdev
== hdev
->bus
->root_hub
) {
1646 if (hcd
->power_budget
> 0)
1647 hdev
->bus_mA
= hcd
->power_budget
;
1649 hdev
->bus_mA
= full_load
* hdev
->maxchild
;
1650 if (hdev
->bus_mA
>= full_load
)
1651 hub
->mA_per_port
= full_load
;
1653 hub
->mA_per_port
= hdev
->bus_mA
;
1654 hub
->limited_power
= 1;
1656 } else if ((hubstatus
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) { // bus powered
1657 int remaining
= hdev
->bus_mA
-
1658 hub
->descriptor
->bHubContrCurrent
;
1660 dev_dbg(hub_dev
, "hub controller current requirement: %dmA\n",
1661 hub
->descriptor
->bHubContrCurrent
);
1662 hub
->limited_power
= 1;
1664 if (remaining
< hdev
->maxchild
* unit_load
){
1665 #if defined(CONFIG_USBIF_COMPLIANCE) && defined(CONFIG_USB_XHCI_HCD)
1666 usbif_u3h_send_event("DEV_OVER_CURRENT");
1669 "insufficient power available "
1670 "to use all downstream ports\n");
1672 hub
->mA_per_port
= unit_load
; /* 7.2.1 */
1674 } else { /* Self-powered external hub */
1675 /* FIXME: What about battery-powered external hubs that
1676 * provide less current per port? */
1677 hub
->mA_per_port
= full_load
;
1679 if (hub
->mA_per_port
< full_load
)
1680 dev_dbg(hub_dev
, "%umA bus power budget for each child\n",
1683 /* Update the HCD's internal representation of this hub before khubd
1684 * starts getting port status changes for devices under the hub.
1686 if (hcd
->driver
->update_hub_device
) {
1687 ret
= hcd
->driver
->update_hub_device(hcd
, hdev
,
1688 &hub
->tt
, GFP_KERNEL
);
1690 message
= "can't update HCD hub info";
1695 ret
= hub_hub_status(hub
, &hubstatus
, &hubchange
);
1697 message
= "can't get hub status";
1701 /* local power status reports aren't always correct */
1702 if (hdev
->actconfig
->desc
.bmAttributes
& USB_CONFIG_ATT_SELFPOWER
)
1703 dev_dbg(hub_dev
, "local power source is %s\n",
1704 (hubstatus
& HUB_STATUS_LOCAL_POWER
)
1705 ? "lost (inactive)" : "good");
1707 if ((wHubCharacteristics
& HUB_CHAR_OCPM
) == 0)
1708 dev_dbg(hub_dev
, "%sover-current condition exists\n",
1709 (hubstatus
& HUB_STATUS_OVERCURRENT
) ? "" : "no ");
1711 /* set up the interrupt endpoint
1712 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1713 * bytes as USB2.0[11.12.3] says because some hubs are known
1714 * to send more data (and thus cause overflow). For root hubs,
1715 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1716 * to be big enough for at least USB_MAXCHILDREN ports. */
1717 pipe
= usb_rcvintpipe(hdev
, endpoint
->bEndpointAddress
);
1718 maxp
= usb_maxpacket(hdev
, pipe
, usb_pipeout(pipe
));
1720 if (maxp
> sizeof(*hub
->buffer
))
1721 maxp
= sizeof(*hub
->buffer
);
1723 hub
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
1729 usb_fill_int_urb(hub
->urb
, hdev
, pipe
, *hub
->buffer
, maxp
, hub_irq
,
1730 hub
, endpoint
->bInterval
);
1732 /* maybe cycle the hub leds */
1733 if (hub
->has_indicators
&& blinkenlights
)
1734 hub
->indicator
[0] = INDICATOR_CYCLE
;
1736 for (i
= 0; i
< hdev
->maxchild
; i
++) {
1737 ret
= usb_hub_create_port_device(hub
, i
+ 1);
1739 dev_err(hub
->intfdev
,
1740 "couldn't create port%d device.\n", i
+ 1);
1742 goto fail_keep_maxchild
;
1746 usb_hub_adjust_deviceremovable(hdev
, hub
->descriptor
);
1748 hub_activate(hub
, HUB_INIT
);
1754 dev_err (hub_dev
, "config failed, %s (err %d)\n",
1756 /* hub_disconnect() frees urb and descriptor */
1760 static void hub_release(struct kref
*kref
)
1762 struct usb_hub
*hub
= container_of(kref
, struct usb_hub
, kref
);
1764 usb_put_intf(to_usb_interface(hub
->intfdev
));
1768 static unsigned highspeed_hubs
;
1770 static void hub_disconnect(struct usb_interface
*intf
)
1772 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1773 struct usb_device
*hdev
= interface_to_usbdev(intf
);
1776 /* Take the hub off the event list and don't let it be added again */
1777 spin_lock_irq(&hub_event_lock
);
1778 if (!list_empty(&hub
->event_list
)) {
1779 list_del_init(&hub
->event_list
);
1780 usb_autopm_put_interface_no_suspend(intf
);
1782 hub
->disconnected
= 1;
1783 spin_unlock_irq(&hub_event_lock
);
1785 /* Disconnect all children and quiesce the hub */
1787 hub_quiesce(hub
, HUB_DISCONNECT
);
1789 /* Avoid races with recursively_mark_NOTATTACHED() */
1790 spin_lock_irq(&device_state_lock
);
1791 port1
= hdev
->maxchild
;
1793 usb_set_intfdata(intf
, NULL
);
1794 spin_unlock_irq(&device_state_lock
);
1796 for (; port1
> 0; --port1
)
1797 usb_hub_remove_port_device(hub
, port1
);
1799 if (hub
->hdev
->speed
== USB_SPEED_HIGH
)
1802 usb_free_urb(hub
->urb
);
1804 kfree(hub
->descriptor
);
1808 pm_suspend_ignore_children(&intf
->dev
, false);
1809 kref_put(&hub
->kref
, hub_release
);
1812 static int hub_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
1814 struct usb_host_interface
*desc
;
1815 struct usb_endpoint_descriptor
*endpoint
;
1816 struct usb_device
*hdev
;
1817 struct usb_hub
*hub
;
1820 desc
= intf
->cur_altsetting
;
1821 hdev
= interface_to_usbdev(intf
);
1824 * Set default autosuspend delay as 0 to speedup bus suspend,
1825 * based on the below considerations:
1827 * - Unlike other drivers, the hub driver does not rely on the
1828 * autosuspend delay to provide enough time to handle a wakeup
1829 * event, and the submitted status URB is just to check future
1830 * change on hub downstream ports, so it is safe to do it.
1832 * - The patch might cause one or more auto supend/resume for
1833 * below very rare devices when they are plugged into hub
1836 * devices having trouble initializing, and disconnect
1837 * themselves from the bus and then reconnect a second
1840 * devices just for downloading firmware, and disconnects
1841 * themselves after completing it
1843 * For these quite rare devices, their drivers may change the
1844 * autosuspend delay of their parent hub in the probe() to one
1845 * appropriate value to avoid the subtle problem if someone
1848 * - The patch may cause one or more auto suspend/resume on
1849 * hub during running 'lsusb', but it is probably too
1850 * infrequent to worry about.
1852 * - Change autosuspend delay of hub can avoid unnecessary auto
1853 * suspend timer for hub, also may decrease power consumption
1856 * - If user has indicated to prevent autosuspend by passing
1857 * usbcore.autosuspend = -1 then keep autosuspend disabled.
1859 #ifdef CONFIG_PM_RUNTIME
1860 if (hdev
->dev
.power
.autosuspend_delay
>= 0)
1861 pm_runtime_set_autosuspend_delay(&hdev
->dev
, 0);
1865 * Hubs have proper suspend/resume support, except for root hubs
1866 * where the controller driver doesn't have bus_suspend and
1867 * bus_resume methods.
1869 if (hdev
->parent
) { /* normal device */
1870 usb_enable_autosuspend(hdev
);
1871 } else { /* root hub */
1872 const struct hc_driver
*drv
= bus_to_hcd(hdev
->bus
)->driver
;
1874 if (drv
->bus_suspend
&& drv
->bus_resume
)
1875 usb_enable_autosuspend(hdev
);
1878 if (hdev
->level
== MAX_TOPO_LEVEL
) {
1880 "Unsupported bus topology: hub nested too deep\n");
1881 #if defined(CONFIG_USBIF_COMPLIANCE) && defined(CONFIG_USB_XHCI_HCD)
1882 usbif_u3h_send_event("MAX_HUB_TIER_EXCEED");
1887 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1889 dev_warn(&intf
->dev
, "ignoring external hub\n");
1890 #if defined(CONFIG_USBIF_COMPLIANCE) && defined(CONFIG_USB_XHCI_HCD)
1891 usbif_u3h_send_event("HUB_NOT_SUPPORTED");
1897 /* Some hubs have a subclass of 1, which AFAICT according to the */
1898 /* specs is not defined, but it works */
1899 if ((desc
->desc
.bInterfaceSubClass
!= 0) &&
1900 (desc
->desc
.bInterfaceSubClass
!= 1)) {
1902 dev_err (&intf
->dev
, "bad descriptor, ignoring hub\n");
1906 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1907 if (desc
->desc
.bNumEndpoints
!= 1)
1908 goto descriptor_error
;
1910 endpoint
= &desc
->endpoint
[0].desc
;
1912 /* If it's not an interrupt in endpoint, we'd better punt! */
1913 if (!usb_endpoint_is_int_in(endpoint
))
1914 goto descriptor_error
;
1916 /* We found a hub */
1917 dev_info (&intf
->dev
, "USB hub found\n");
1919 hub
= kzalloc(sizeof(*hub
), GFP_KERNEL
);
1921 dev_dbg (&intf
->dev
, "couldn't kmalloc hub struct\n");
1925 kref_init(&hub
->kref
);
1926 INIT_LIST_HEAD(&hub
->event_list
);
1927 hub
->intfdev
= &intf
->dev
;
1929 INIT_DELAYED_WORK(&hub
->leds
, led_work
);
1930 INIT_DELAYED_WORK(&hub
->init_work
, NULL
);
1933 usb_set_intfdata (intf
, hub
);
1934 intf
->needs_remote_wakeup
= 1;
1935 pm_suspend_ignore_children(&intf
->dev
, true);
1937 if (hdev
->speed
== USB_SPEED_HIGH
)
1940 if (id
->driver_info
& HUB_QUIRK_CHECK_PORT_AUTOSUSPEND
)
1941 hub
->quirk_check_port_auto_suspend
= 1;
1943 if (hub_configure(hub
, endpoint
) >= 0)
1946 hub_disconnect (intf
);
1951 hub_ioctl(struct usb_interface
*intf
, unsigned int code
, void *user_data
)
1953 struct usb_device
*hdev
= interface_to_usbdev (intf
);
1954 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1956 /* assert ifno == 0 (part of hub spec) */
1958 case USBDEVFS_HUB_PORTINFO
: {
1959 struct usbdevfs_hub_portinfo
*info
= user_data
;
1962 spin_lock_irq(&device_state_lock
);
1963 if (hdev
->devnum
<= 0)
1966 info
->nports
= hdev
->maxchild
;
1967 for (i
= 0; i
< info
->nports
; i
++) {
1968 if (hub
->ports
[i
]->child
== NULL
)
1972 hub
->ports
[i
]->child
->devnum
;
1975 spin_unlock_irq(&device_state_lock
);
1977 return info
->nports
+ 1;
1986 * Allow user programs to claim ports on a hub. When a device is attached
1987 * to one of these "claimed" ports, the program will "own" the device.
1989 static int find_port_owner(struct usb_device
*hdev
, unsigned port1
,
1990 struct dev_state
***ppowner
)
1992 if (hdev
->state
== USB_STATE_NOTATTACHED
)
1994 if (port1
== 0 || port1
> hdev
->maxchild
)
1997 /* This assumes that devices not managed by the hub driver
1998 * will always have maxchild equal to 0.
2000 *ppowner
= &(usb_hub_to_struct_hub(hdev
)->ports
[port1
- 1]->port_owner
);
2004 /* In the following three functions, the caller must hold hdev's lock */
2005 int usb_hub_claim_port(struct usb_device
*hdev
, unsigned port1
,
2006 struct dev_state
*owner
)
2009 struct dev_state
**powner
;
2011 rc
= find_port_owner(hdev
, port1
, &powner
);
2020 int usb_hub_release_port(struct usb_device
*hdev
, unsigned port1
,
2021 struct dev_state
*owner
)
2024 struct dev_state
**powner
;
2026 rc
= find_port_owner(hdev
, port1
, &powner
);
2029 if (*powner
!= owner
)
2035 void usb_hub_release_all_ports(struct usb_device
*hdev
, struct dev_state
*owner
)
2037 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
2040 for (n
= 0; n
< hdev
->maxchild
; n
++) {
2041 if (hub
->ports
[n
]->port_owner
== owner
)
2042 hub
->ports
[n
]->port_owner
= NULL
;
2047 /* The caller must hold udev's lock */
2048 bool usb_device_is_owned(struct usb_device
*udev
)
2050 struct usb_hub
*hub
;
2052 if (udev
->state
== USB_STATE_NOTATTACHED
|| !udev
->parent
)
2054 hub
= usb_hub_to_struct_hub(udev
->parent
);
2055 return !!hub
->ports
[udev
->portnum
- 1]->port_owner
;
2058 static void recursively_mark_NOTATTACHED(struct usb_device
*udev
)
2060 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
2063 for (i
= 0; i
< udev
->maxchild
; ++i
) {
2064 if (hub
->ports
[i
]->child
)
2065 recursively_mark_NOTATTACHED(hub
->ports
[i
]->child
);
2067 if (udev
->state
== USB_STATE_SUSPENDED
)
2068 udev
->active_duration
-= jiffies
;
2069 udev
->state
= USB_STATE_NOTATTACHED
;
2073 * usb_set_device_state - change a device's current state (usbcore, hcds)
2074 * @udev: pointer to device whose state should be changed
2075 * @new_state: new state value to be stored
2077 * udev->state is _not_ fully protected by the device lock. Although
2078 * most transitions are made only while holding the lock, the state can
2079 * can change to USB_STATE_NOTATTACHED at almost any time. This
2080 * is so that devices can be marked as disconnected as soon as possible,
2081 * without having to wait for any semaphores to be released. As a result,
2082 * all changes to any device's state must be protected by the
2083 * device_state_lock spinlock.
2085 * Once a device has been added to the device tree, all changes to its state
2086 * should be made using this routine. The state should _not_ be set directly.
2088 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
2089 * Otherwise udev->state is set to new_state, and if new_state is
2090 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
2091 * to USB_STATE_NOTATTACHED.
2093 void usb_set_device_state(struct usb_device
*udev
,
2094 enum usb_device_state new_state
)
2096 unsigned long flags
;
2099 spin_lock_irqsave(&device_state_lock
, flags
);
2100 if (udev
->state
== USB_STATE_NOTATTACHED
)
2102 else if (new_state
!= USB_STATE_NOTATTACHED
) {
2104 /* root hub wakeup capabilities are managed out-of-band
2105 * and may involve silicon errata ... ignore them here.
2108 if (udev
->state
== USB_STATE_SUSPENDED
2109 || new_state
== USB_STATE_SUSPENDED
)
2110 ; /* No change to wakeup settings */
2111 else if (new_state
== USB_STATE_CONFIGURED
)
2112 wakeup
= (udev
->quirks
&
2113 USB_QUIRK_IGNORE_REMOTE_WAKEUP
) ? 0 :
2114 udev
->actconfig
->desc
.bmAttributes
&
2115 USB_CONFIG_ATT_WAKEUP
;
2119 if (udev
->state
== USB_STATE_SUSPENDED
&&
2120 new_state
!= USB_STATE_SUSPENDED
)
2121 udev
->active_duration
-= jiffies
;
2122 else if (new_state
== USB_STATE_SUSPENDED
&&
2123 udev
->state
!= USB_STATE_SUSPENDED
)
2124 udev
->active_duration
+= jiffies
;
2125 udev
->state
= new_state
;
2127 recursively_mark_NOTATTACHED(udev
);
2128 spin_unlock_irqrestore(&device_state_lock
, flags
);
2130 device_set_wakeup_capable(&udev
->dev
, wakeup
);
2132 EXPORT_SYMBOL_GPL(usb_set_device_state
);
2135 * Choose a device number.
2137 * Device numbers are used as filenames in usbfs. On USB-1.1 and
2138 * USB-2.0 buses they are also used as device addresses, however on
2139 * USB-3.0 buses the address is assigned by the controller hardware
2140 * and it usually is not the same as the device number.
2142 * WUSB devices are simple: they have no hubs behind, so the mapping
2143 * device <-> virtual port number becomes 1:1. Why? to simplify the
2144 * life of the device connection logic in
2145 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
2146 * handshake we need to assign a temporary address in the unauthorized
2147 * space. For simplicity we use the first virtual port number found to
2148 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
2149 * and that becomes it's address [X < 128] or its unauthorized address
2152 * We add 1 as an offset to the one-based USB-stack port number
2153 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
2154 * 0 is reserved by USB for default address; (b) Linux's USB stack
2155 * uses always #1 for the root hub of the controller. So USB stack's
2156 * port #1, which is wusb virtual-port #0 has address #2.
2158 * Devices connected under xHCI are not as simple. The host controller
2159 * supports virtualization, so the hardware assigns device addresses and
2160 * the HCD must setup data structures before issuing a set address
2161 * command to the hardware.
2163 static void choose_devnum(struct usb_device
*udev
)
2166 struct usb_bus
*bus
= udev
->bus
;
2168 /* If khubd ever becomes multithreaded, this will need a lock */
2170 devnum
= udev
->portnum
+ 1;
2171 BUG_ON(test_bit(devnum
, bus
->devmap
.devicemap
));
2173 /* Try to allocate the next devnum beginning at
2174 * bus->devnum_next. */
2175 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
, 128,
2178 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
,
2180 bus
->devnum_next
= ( devnum
>= 127 ? 1 : devnum
+ 1);
2183 set_bit(devnum
, bus
->devmap
.devicemap
);
2184 udev
->devnum
= devnum
;
2188 static void release_devnum(struct usb_device
*udev
)
2190 if (udev
->devnum
> 0) {
2191 clear_bit(udev
->devnum
, udev
->bus
->devmap
.devicemap
);
2196 static void update_devnum(struct usb_device
*udev
, int devnum
)
2198 /* The address for a WUSB device is managed by wusbcore. */
2200 udev
->devnum
= devnum
;
2203 static void hub_free_dev(struct usb_device
*udev
)
2205 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2207 /* Root hubs aren't real devices, so don't free HCD resources */
2208 if (hcd
->driver
->free_dev
&& udev
->parent
)
2209 hcd
->driver
->free_dev(hcd
, udev
);
2213 * usb_disconnect - disconnect a device (usbcore-internal)
2214 * @pdev: pointer to device being disconnected
2215 * Context: !in_interrupt ()
2217 * Something got disconnected. Get rid of it and all of its children.
2219 * If *pdev is a normal device then the parent hub must already be locked.
2220 * If *pdev is a root hub then this routine will acquire the
2221 * usb_bus_list_lock on behalf of the caller.
2223 * Only hub drivers (including virtual root hub drivers for host
2224 * controllers) should ever call this.
2226 * This call is synchronous, and may not be used in an interrupt context.
2228 void usb_disconnect(struct usb_device
**pdev
)
2230 struct usb_device
*udev
= *pdev
;
2231 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
2233 struct timeval tv_begin
, tv_end
;
2234 struct timeval tv_before
, tv_after
;
2235 do_gettimeofday(&tv_begin
);
2237 #ifdef CONFIG_MTK_ICUSB_SUPPORT
2241 #ifdef CONFIG_MTK_ICUSB_SUPPORT
2242 is_icusb_rh
= is_musbfsh_rh(udev
->parent
);
2246 /* mark the device as inactive, so any further urb submissions for
2247 * this device (and any of its children) will fail immediately.
2248 * this quiesces everything except pending urbs.
2250 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2251 dev_info(&udev
->dev
, "USB disconnect, device number %d\n",
2254 usb_lock_device(udev
);
2256 /* Free up all the children before we remove this device */
2257 for (i
= 0; i
< udev
->maxchild
; i
++) {
2258 if (hub
->ports
[i
]->child
)
2259 usb_disconnect(&hub
->ports
[i
]->child
);
2262 /* deallocate hcd/hardware state ... nuking all pending urbs and
2263 * cleaning up all state associated with the current configuration
2264 * so that the hardware is now fully quiesced.
2266 dev_dbg (&udev
->dev
, "unregistering device\n");
2268 do_gettimeofday(&tv_before
);
2269 usb_disable_device(udev
, 0);
2270 do_gettimeofday(&tv_after
);
2271 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
));
2273 usb_hcd_synchronize_unlinks(udev
);
2276 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
2277 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
2279 sysfs_remove_link(&udev
->dev
.kobj
, "port");
2280 sysfs_remove_link(&port_dev
->dev
.kobj
, "device");
2282 if (!port_dev
->did_runtime_put
)
2283 pm_runtime_put(&port_dev
->dev
);
2285 port_dev
->did_runtime_put
= false;
2288 do_gettimeofday(&tv_before
);
2289 usb_remove_ep_devs(&udev
->ep0
);
2290 do_gettimeofday(&tv_after
);
2291 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
));
2293 usb_unlock_device(udev
);
2295 /* Unregister the device. The device driver is responsible
2296 * for de-configuring the device and invoking the remove-device
2297 * notifier chain (used by usbfs and possibly others).
2299 do_gettimeofday(&tv_before
);
2300 device_del(&udev
->dev
);
2301 do_gettimeofday(&tv_after
);
2302 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
));
2304 /* Free the device number and delete the parent's children[]
2305 * (or root_hub) pointer.
2307 release_devnum(udev
);
2309 /* Avoid races with recursively_mark_NOTATTACHED() */
2310 spin_lock_irq(&device_state_lock
);
2312 spin_unlock_irq(&device_state_lock
);
2316 put_device(&udev
->dev
);
2318 #ifdef CONFIG_MTK_ICUSB_SUPPORT
2321 set_icusb_sts_disconnect_done();
2322 MYDBG("ICUSB Disconnect\n");
2325 do_gettimeofday(&tv_end
);
2326 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
));
2329 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2330 static void show_string(struct usb_device
*udev
, char *id
, char *string
)
2334 dev_info(&udev
->dev
, "%s: %s\n", id
, string
);
2337 static void announce_device(struct usb_device
*udev
)
2339 dev_info(&udev
->dev
, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2340 le16_to_cpu(udev
->descriptor
.idVendor
),
2341 le16_to_cpu(udev
->descriptor
.idProduct
));
2342 dev_info(&udev
->dev
,
2343 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2344 udev
->descriptor
.iManufacturer
,
2345 udev
->descriptor
.iProduct
,
2346 udev
->descriptor
.iSerialNumber
);
2347 show_string(udev
, "Product", udev
->product
);
2348 show_string(udev
, "Manufacturer", udev
->manufacturer
);
2349 show_string(udev
, "SerialNumber", udev
->serial
);
2352 static inline void announce_device(struct usb_device
*udev
) { }
2355 #ifdef CONFIG_USB_OTG
2356 #include "otg_whitelist.h"
2360 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2361 * @udev: newly addressed device (in ADDRESS state)
2363 * Finish enumeration for On-The-Go devices
2365 static int usb_enumerate_device_otg(struct usb_device
*udev
)
2369 #ifdef CONFIG_USB_OTG
2371 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2372 * to wake us after we've powered off VBUS; and HNP, switching roles
2373 * "host" to "peripheral". The OTG descriptor helps figure this out.
2375 if (!udev
->bus
->is_b_host
2377 && udev
->parent
== udev
->bus
->root_hub
) {
2378 struct usb_otg_descriptor
*desc
= NULL
;
2379 struct usb_bus
*bus
= udev
->bus
;
2381 /* descriptor may appear anywhere in config */
2382 if (__usb_get_extra_descriptor (udev
->rawdescriptors
[0],
2383 le16_to_cpu(udev
->config
[0].desc
.wTotalLength
),
2384 USB_DT_OTG
, (void **) &desc
) == 0) {
2385 if (desc
->bmAttributes
& USB_OTG_HNP
) {
2386 unsigned port1
= udev
->portnum
;
2388 dev_info(&udev
->dev
,
2389 "Dual-Role OTG device on %sHNP port\n",
2390 (port1
== bus
->otg_port
)
2393 /* enable HNP before suspend, it's simpler */
2394 if (port1
== bus
->otg_port
)
2395 bus
->b_hnp_enable
= 1;
2396 err
= usb_control_msg(udev
,
2397 usb_sndctrlpipe(udev
, 0),
2398 USB_REQ_SET_FEATURE
, 0,
2400 ? USB_DEVICE_B_HNP_ENABLE
2401 : USB_DEVICE_A_ALT_HNP_SUPPORT
,
2402 0, NULL
, 0, USB_CTRL_SET_TIMEOUT
);
2404 /* OTG MESSAGE: report errors here,
2405 * customize to match your product.
2407 dev_info(&udev
->dev
,
2408 "can't set HNP mode: %d\n",
2410 bus
->b_hnp_enable
= 0;
2416 if (!is_targeted(udev
)) {
2418 /* Maybe it can talk to us, though we can't talk to it.
2419 * (Includes HNP test device.)
2421 if (udev
->bus
->b_hnp_enable
|| udev
->bus
->is_b_host
) {
2422 err
= usb_port_suspend(udev
, PMSG_SUSPEND
);
2424 dev_dbg(&udev
->dev
, "HNP fail, %d\n", err
);
2436 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2437 * @udev: newly addressed device (in ADDRESS state)
2439 * This is only called by usb_new_device() and usb_authorize_device()
2440 * and FIXME -- all comments that apply to them apply here wrt to
2443 * If the device is WUSB and not authorized, we don't attempt to read
2444 * the string descriptors, as they will be errored out by the device
2445 * until it has been authorized.
2447 static int usb_enumerate_device(struct usb_device
*udev
)
2451 if (udev
->config
== NULL
) {
2452 err
= usb_get_configuration(udev
);
2455 dev_err(&udev
->dev
, "can't read configurations, error %d\n",
2461 /* read the standard strings and cache them if present */
2462 udev
->product
= usb_cache_string(udev
, udev
->descriptor
.iProduct
);
2463 udev
->manufacturer
= usb_cache_string(udev
,
2464 udev
->descriptor
.iManufacturer
);
2465 udev
->serial
= usb_cache_string(udev
, udev
->descriptor
.iSerialNumber
);
2467 err
= usb_enumerate_device_otg(udev
);
2469 #if defined(CONFIG_USBIF_COMPLIANCE) && defined(CONFIG_USB_XHCI_HCD)
2470 if (udev
->parent
){ // we don't have to check ourself (roothub)
2471 if (!is_targeted(udev
)) {
2472 usbif_u3h_send_event("DEV_NOT_SUPPORTED");
2481 usb_detect_interface_quirks(udev
);
2486 static void set_usb_port_removable(struct usb_device
*udev
)
2488 struct usb_device
*hdev
= udev
->parent
;
2489 struct usb_hub
*hub
;
2490 u8 port
= udev
->portnum
;
2491 u16 wHubCharacteristics
;
2492 bool removable
= true;
2497 hub
= usb_hub_to_struct_hub(udev
->parent
);
2499 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
2501 if (!(wHubCharacteristics
& HUB_CHAR_COMPOUND
))
2504 if (hub_is_superspeed(hdev
)) {
2505 if (le16_to_cpu(hub
->descriptor
->u
.ss
.DeviceRemovable
)
2509 if (hub
->descriptor
->u
.hs
.DeviceRemovable
[port
/ 8] & (1 << (port
% 8)))
2514 udev
->removable
= USB_DEVICE_REMOVABLE
;
2516 udev
->removable
= USB_DEVICE_FIXED
;
2520 * usb_new_device - perform initial device setup (usbcore-internal)
2521 * @udev: newly addressed device (in ADDRESS state)
2523 * This is called with devices which have been detected but not fully
2524 * enumerated. The device descriptor is available, but not descriptors
2525 * for any device configuration. The caller must have locked either
2526 * the parent hub (if udev is a normal device) or else the
2527 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
2528 * udev has already been installed, but udev is not yet visible through
2529 * sysfs or other filesystem code.
2531 * It will return if the device is configured properly or not. Zero if
2532 * the interface was registered with the driver core; else a negative
2535 * This call is synchronous, and may not be used in an interrupt context.
2537 * Only the hub driver or root-hub registrar should ever call this.
2539 int usb_new_device(struct usb_device
*udev
)
2544 /* Initialize non-root-hub device wakeup to disabled;
2545 * device (un)configuration controls wakeup capable
2546 * sysfs power/wakeup controls wakeup enabled/disabled
2548 device_init_wakeup(&udev
->dev
, 0);
2549 MYDBG("udev :%p\n", udev
);
2550 #ifdef CONFIG_MTK_DT_USB_SUPPORT
2551 #ifdef CONFIG_PM_RUNTIME
2552 if(is_musbfsh_rh(udev
->parent
)){
2554 /*find out struct *usb_hub and hook it */
2555 usb11_hub
= usb_hub_to_struct_hub(udev
->parent
);
2561 /* Tell the runtime-PM framework the device is active */
2562 pm_runtime_set_active(&udev
->dev
);
2563 pm_runtime_get_noresume(&udev
->dev
);
2564 pm_runtime_use_autosuspend(&udev
->dev
);
2565 pm_runtime_enable(&udev
->dev
);
2567 /* By default, forbid autosuspend for all devices. It will be
2568 * allowed for hubs during binding.
2570 usb_disable_autosuspend(udev
);
2572 err
= usb_enumerate_device(udev
); /* Read descriptors */
2575 dev_dbg(&udev
->dev
, "udev %d, busnum %d, minor = %d\n",
2576 udev
->devnum
, udev
->bus
->busnum
,
2577 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
2578 /* export the usbdev device-node for libusb */
2579 udev
->dev
.devt
= MKDEV(USB_DEVICE_MAJOR
,
2580 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
2582 /* Tell the world! */
2583 announce_device(udev
);
2586 add_device_randomness(udev
->serial
, strlen(udev
->serial
));
2588 add_device_randomness(udev
->product
, strlen(udev
->product
));
2589 if (udev
->manufacturer
)
2590 add_device_randomness(udev
->manufacturer
,
2591 strlen(udev
->manufacturer
));
2593 device_enable_async_suspend(&udev
->dev
);
2596 * check whether the hub marks this port as non-removable. Do it
2597 * now so that platform-specific data can override it in
2601 set_usb_port_removable(udev
);
2603 /* Register the device. The device driver is responsible
2604 * for configuring the device and invoking the add-device
2605 * notifier chain (used by usbfs and possibly others).
2607 err
= device_add(&udev
->dev
);
2609 dev_err(&udev
->dev
, "can't device_add, error %d\n", err
);
2613 /* Create link files between child device and usb port device. */
2615 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
2616 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
2618 err
= sysfs_create_link(&udev
->dev
.kobj
,
2619 &port_dev
->dev
.kobj
, "port");
2623 err
= sysfs_create_link(&port_dev
->dev
.kobj
,
2624 &udev
->dev
.kobj
, "device");
2626 sysfs_remove_link(&udev
->dev
.kobj
, "port");
2630 pm_runtime_get_sync(&port_dev
->dev
);
2633 (void) usb_create_ep_devs(&udev
->dev
, &udev
->ep0
, udev
);
2634 usb_mark_last_busy(udev
);
2635 pm_runtime_put_sync_autosuspend(&udev
->dev
);
2639 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2640 pm_runtime_disable(&udev
->dev
);
2641 pm_runtime_set_suspended(&udev
->dev
);
2647 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2648 * @usb_dev: USB device
2650 * Move the USB device to a very basic state where interfaces are disabled
2651 * and the device is in fact unconfigured and unusable.
2653 * We share a lock (that we have) with device_del(), so we need to
2656 int usb_deauthorize_device(struct usb_device
*usb_dev
)
2658 usb_lock_device(usb_dev
);
2659 if (usb_dev
->authorized
== 0)
2660 goto out_unauthorized
;
2662 usb_dev
->authorized
= 0;
2663 usb_set_configuration(usb_dev
, -1);
2666 usb_unlock_device(usb_dev
);
2671 int usb_authorize_device(struct usb_device
*usb_dev
)
2675 usb_lock_device(usb_dev
);
2676 if (usb_dev
->authorized
== 1)
2677 goto out_authorized
;
2679 result
= usb_autoresume_device(usb_dev
);
2681 dev_err(&usb_dev
->dev
,
2682 "can't autoresume for authorization: %d\n", result
);
2683 goto error_autoresume
;
2685 result
= usb_get_device_descriptor(usb_dev
, sizeof(usb_dev
->descriptor
));
2687 dev_err(&usb_dev
->dev
, "can't re-read device descriptor for "
2688 "authorization: %d\n", result
);
2689 goto error_device_descriptor
;
2692 usb_dev
->authorized
= 1;
2693 /* Choose and set the configuration. This registers the interfaces
2694 * with the driver core and lets interface drivers bind to them.
2696 c
= usb_choose_configuration(usb_dev
);
2698 result
= usb_set_configuration(usb_dev
, c
);
2700 dev_err(&usb_dev
->dev
,
2701 "can't set config #%d, error %d\n", c
, result
);
2702 /* This need not be fatal. The user can try to
2703 * set other configurations. */
2706 dev_info(&usb_dev
->dev
, "authorized to connect\n");
2708 error_device_descriptor
:
2709 usb_autosuspend_device(usb_dev
);
2712 usb_unlock_device(usb_dev
); // complements locktree
2717 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2718 static unsigned hub_is_wusb(struct usb_hub
*hub
)
2720 struct usb_hcd
*hcd
;
2721 if (hub
->hdev
->parent
!= NULL
) /* not a root hub? */
2723 hcd
= container_of(hub
->hdev
->bus
, struct usb_hcd
, self
);
2724 return hcd
->wireless
;
2728 #define PORT_RESET_TRIES 5
2729 #define SET_ADDRESS_TRIES 2
2730 #define GET_DESCRIPTOR_TRIES 2
2731 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2732 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2734 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2735 #define HUB_SHORT_RESET_TIME 10
2736 #define HUB_BH_RESET_TIME 50
2737 #define HUB_LONG_RESET_TIME 200
2738 #define HUB_RESET_TIMEOUT 800
2740 static int hub_port_reset(struct usb_hub
*hub
, int port1
,
2741 struct usb_device
*udev
, unsigned int delay
, bool warm
);
2743 /* Is a USB 3.0 port in the Inactive or Complinance Mode state?
2744 * Port worm reset is required to recover
2746 static bool hub_port_warm_reset_required(struct usb_hub
*hub
, u16 portstatus
)
2748 return hub_is_superspeed(hub
->hdev
) &&
2749 (((portstatus
& USB_PORT_STAT_LINK_STATE
) ==
2750 USB_SS_PORT_LS_SS_INACTIVE
) ||
2751 ((portstatus
& USB_PORT_STAT_LINK_STATE
) ==
2752 USB_SS_PORT_LS_COMP_MOD
)) ;
2755 static int hub_port_wait_reset(struct usb_hub
*hub
, int port1
,
2756 struct usb_device
*udev
, unsigned int delay
, bool warm
)
2758 int delay_time
, ret
;
2762 for (delay_time
= 0;
2763 delay_time
< HUB_RESET_TIMEOUT
;
2764 delay_time
+= delay
) {
2765 /* wait to give the device a chance to reset */
2768 /* read and decode port status */
2770 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
2775 /* The port state is unknown until the reset completes. */
2776 if (!(portstatus
& USB_PORT_STAT_RESET
))
2779 /* switch to the long delay after two short delay failures */
2780 if (delay_time
>= 2 * HUB_SHORT_RESET_TIME
)
2781 delay
= HUB_LONG_RESET_TIME
;
2783 dev_dbg (hub
->intfdev
,
2784 "port %d not %sreset yet, waiting %dms\n",
2785 port1
, warm
? "warm " : "", delay
);
2788 if ((portstatus
& USB_PORT_STAT_RESET
))
2791 if (hub_port_warm_reset_required(hub
, portstatus
))
2794 /* Device went away? */
2795 if (!(portstatus
& USB_PORT_STAT_CONNECTION
))
2798 /* bomb out completely if the connection bounced. A USB 3.0
2799 * connection may bounce if multiple warm resets were issued,
2800 * but the device may have successfully re-connected. Ignore it.
2802 if (!hub_is_superspeed(hub
->hdev
) &&
2803 (portchange
& USB_PORT_STAT_C_CONNECTION
))
2806 if (!(portstatus
& USB_PORT_STAT_ENABLE
))
2812 if (hub_is_wusb(hub
))
2813 udev
->speed
= USB_SPEED_WIRELESS
;
2814 else if (hub_is_superspeed(hub
->hdev
))
2815 udev
->speed
= USB_SPEED_SUPER
;
2816 else if (portstatus
& USB_PORT_STAT_HIGH_SPEED
)
2817 udev
->speed
= USB_SPEED_HIGH
;
2818 else if (portstatus
& USB_PORT_STAT_LOW_SPEED
)
2819 udev
->speed
= USB_SPEED_LOW
;
2821 udev
->speed
= USB_SPEED_FULL
;
2825 static void hub_port_finish_reset(struct usb_hub
*hub
, int port1
,
2826 struct usb_device
*udev
, int *status
)
2830 /* TRSTRCY = 10 ms; plus some extra */
2833 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2835 update_devnum(udev
, 0);
2836 /* The xHC may think the device is already reset,
2837 * so ignore the status.
2839 if (hcd
->driver
->reset_device
)
2840 hcd
->driver
->reset_device(hcd
, udev
);
2845 usb_clear_port_feature(hub
->hdev
,
2846 port1
, USB_PORT_FEAT_C_RESET
);
2847 if (hub_is_superspeed(hub
->hdev
)) {
2848 usb_clear_port_feature(hub
->hdev
, port1
,
2849 USB_PORT_FEAT_C_BH_PORT_RESET
);
2850 usb_clear_port_feature(hub
->hdev
, port1
,
2851 USB_PORT_FEAT_C_PORT_LINK_STATE
);
2852 usb_clear_port_feature(hub
->hdev
, port1
,
2853 USB_PORT_FEAT_C_CONNECTION
);
2856 usb_set_device_state(udev
, *status
2857 ? USB_STATE_NOTATTACHED
2858 : USB_STATE_DEFAULT
);
2863 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2864 static int hub_port_reset(struct usb_hub
*hub
, int port1
,
2865 struct usb_device
*udev
, unsigned int delay
, bool warm
)
2868 u16 portchange
, portstatus
;
2870 if (!hub_is_superspeed(hub
->hdev
)) {
2872 dev_err(hub
->intfdev
, "only USB3 hub support "
2876 /* Block EHCI CF initialization during the port reset.
2877 * Some companion controllers don't like it when they mix.
2879 down_read(&ehci_cf_port_reset_rwsem
);
2882 * If the caller hasn't explicitly requested a warm reset,
2883 * double check and see if one is needed.
2885 status
= hub_port_status(hub
, port1
,
2886 &portstatus
, &portchange
);
2890 if (hub_port_warm_reset_required(hub
, portstatus
))
2894 /* Reset the port */
2895 for (i
= 0; i
< PORT_RESET_TRIES
; i
++) {
2897 status
= set_port_feature(hub
->hdev
, port1
, (warm
?
2898 USB_PORT_FEAT_BH_PORT_RESET
:
2899 USB_PORT_FEAT_RESET
));
2901 if (status
== -ENODEV
) {
2903 ; /* The hub is gone */
2904 } else if (status
) {
2906 dev_err(hub
->intfdev
,
2907 "cannot %sreset port %d (err = %d)\n",
2908 warm
? "warm " : "", port1
, status
);
2911 status
= hub_port_wait_reset(hub
, port1
, udev
, delay
,
2913 if (status
&& status
!= -ENOTCONN
)
2916 dev_dbg(hub
->intfdev
,
2917 "port_wait_reset: err = %d\n",
2923 /* Check for disconnect or reset */
2924 if (status
== 0 || status
== -ENOTCONN
|| status
== -ENODEV
) {
2926 hub_port_finish_reset(hub
, port1
, udev
, &status
);
2929 if (!hub_is_superspeed(hub
->hdev
))
2933 * If a USB 3.0 device migrates from reset to an error
2934 * state, re-issue the warm reset.
2936 if (hub_port_status(hub
, port1
,
2937 &portstatus
, &portchange
) < 0)
2940 if (!hub_port_warm_reset_required(hub
, portstatus
))
2944 * If the port is in SS.Inactive or Compliance Mode, the
2945 * hot or warm reset failed. Try another warm reset.
2948 dev_dbg(hub
->intfdev
, "hot reset failed, warm reset port %d\n",
2955 dev_dbg (hub
->intfdev
,
2956 "port %d not enabled, trying %sreset again...\n",
2957 port1
, warm
? "warm " : "");
2958 delay
= HUB_LONG_RESET_TIME
;
2963 dev_err (hub
->intfdev
,
2964 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2968 if (!hub_is_superspeed(hub
->hdev
))
2971 up_read(&ehci_cf_port_reset_rwsem
);
2979 /* Check if a port is power on */
2980 static int port_is_power_on(struct usb_hub
*hub
, unsigned portstatus
)
2984 if (hub_is_superspeed(hub
->hdev
)) {
2985 if (portstatus
& USB_SS_PORT_STAT_POWER
)
2988 if (portstatus
& USB_PORT_STAT_POWER
)
2997 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2998 static int port_is_suspended(struct usb_hub
*hub
, unsigned portstatus
)
3002 if (hub_is_superspeed(hub
->hdev
)) {
3003 if ((portstatus
& USB_PORT_STAT_LINK_STATE
)
3004 == USB_SS_PORT_LS_U3
)
3007 if (portstatus
& USB_PORT_STAT_SUSPEND
)
3014 /* Determine whether the device on a port is ready for a normal resume,
3015 * is ready for a reset-resume, or should be disconnected.
3017 static int check_port_resume_type(struct usb_device
*udev
,
3018 struct usb_hub
*hub
, int port1
,
3019 int status
, unsigned portchange
, unsigned portstatus
)
3021 /* Is the device still present? */
3022 if (status
|| port_is_suspended(hub
, portstatus
) ||
3023 !port_is_power_on(hub
, portstatus
) ||
3024 !(portstatus
& USB_PORT_STAT_CONNECTION
)) {
3029 /* Can't do a normal resume if the port isn't enabled,
3030 * so try a reset-resume instead.
3032 else if (!(portstatus
& USB_PORT_STAT_ENABLE
) && !udev
->reset_resume
) {
3033 if (udev
->persist_enabled
)
3034 udev
->reset_resume
= 1;
3040 dev_dbg(hub
->intfdev
,
3041 "port %d status %04x.%04x after resume, %d\n",
3042 port1
, portchange
, portstatus
, status
);
3043 } else if (udev
->reset_resume
) {
3045 /* Late port handoff can set status-change bits */
3046 if (portchange
& USB_PORT_STAT_C_CONNECTION
)
3047 usb_clear_port_feature(hub
->hdev
, port1
,
3048 USB_PORT_FEAT_C_CONNECTION
);
3049 if (portchange
& USB_PORT_STAT_C_ENABLE
)
3050 usb_clear_port_feature(hub
->hdev
, port1
,
3051 USB_PORT_FEAT_C_ENABLE
);
3057 int usb_disable_ltm(struct usb_device
*udev
)
3059 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3061 /* Check if the roothub and device supports LTM. */
3062 if (!usb_device_supports_ltm(hcd
->self
.root_hub
) ||
3063 !usb_device_supports_ltm(udev
))
3066 /* Clear Feature LTM Enable can only be sent if the device is
3069 if (!udev
->actconfig
)
3072 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3073 USB_REQ_CLEAR_FEATURE
, USB_RECIP_DEVICE
,
3074 USB_DEVICE_LTM_ENABLE
, 0, NULL
, 0,
3075 USB_CTRL_SET_TIMEOUT
);
3077 EXPORT_SYMBOL_GPL(usb_disable_ltm
);
3079 void usb_enable_ltm(struct usb_device
*udev
)
3081 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3083 /* Check if the roothub and device supports LTM. */
3084 if (!usb_device_supports_ltm(hcd
->self
.root_hub
) ||
3085 !usb_device_supports_ltm(udev
))
3088 /* Set Feature LTM Enable can only be sent if the device is
3091 if (!udev
->actconfig
)
3094 usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3095 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
3096 USB_DEVICE_LTM_ENABLE
, 0, NULL
, 0,
3097 USB_CTRL_SET_TIMEOUT
);
3099 EXPORT_SYMBOL_GPL(usb_enable_ltm
);
3103 * usb_disable_function_remotewakeup - disable usb3.0
3104 * device's function remote wakeup
3105 * @udev: target device
3107 * Assume there's only one function on the USB 3.0
3108 * device and disable remote wake for the first
3109 * interface. FIXME if the interface association
3110 * descriptor shows there's more than one function.
3112 static int usb_disable_function_remotewakeup(struct usb_device
*udev
)
3114 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3115 USB_REQ_CLEAR_FEATURE
, USB_RECIP_INTERFACE
,
3116 USB_INTRF_FUNC_SUSPEND
, 0, NULL
, 0,
3117 USB_CTRL_SET_TIMEOUT
);
3120 /* Count of wakeup-enabled devices at or below udev */
3121 static unsigned wakeup_enabled_descendants(struct usb_device
*udev
)
3123 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
3125 return udev
->do_remote_wakeup
+
3126 (hub
? hub
->wakeup_enabled_descendants
: 0);
3130 * usb_port_suspend - suspend a usb device's upstream port
3131 * @udev: device that's no longer in active use, not a root hub
3132 * Context: must be able to sleep; device not locked; pm locks held
3134 * Suspends a USB device that isn't in active use, conserving power.
3135 * Devices may wake out of a suspend, if anything important happens,
3136 * using the remote wakeup mechanism. They may also be taken out of
3137 * suspend by the host, using usb_port_resume(). It's also routine
3138 * to disconnect devices while they are suspended.
3140 * This only affects the USB hardware for a device; its interfaces
3141 * (and, for hubs, child devices) must already have been suspended.
3143 * Selective port suspend reduces power; most suspended devices draw
3144 * less than 500 uA. It's also used in OTG, along with remote wakeup.
3145 * All devices below the suspended port are also suspended.
3147 * Devices leave suspend state when the host wakes them up. Some devices
3148 * also support "remote wakeup", where the device can activate the USB
3149 * tree above them to deliver data, such as a keypress or packet. In
3150 * some cases, this wakes the USB host.
3152 * Suspending OTG devices may trigger HNP, if that's been enabled
3153 * between a pair of dual-role devices. That will change roles, such
3154 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
3156 * Devices on USB hub ports have only one "suspend" state, corresponding
3157 * to ACPI D2, "may cause the device to lose some context".
3158 * State transitions include:
3160 * - suspend, resume ... when the VBUS power link stays live
3161 * - suspend, disconnect ... VBUS lost
3163 * Once VBUS drop breaks the circuit, the port it's using has to go through
3164 * normal re-enumeration procedures, starting with enabling VBUS power.
3165 * Other than re-initializing the hub (plug/unplug, except for root hubs),
3166 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
3167 * timer, no SRP, no requests through sysfs.
3169 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
3170 * suspended until their bus goes into global suspend (i.e., the root
3171 * hub is suspended). Nevertheless, we change @udev->state to
3172 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
3173 * upstream port setting is stored in @udev->port_is_suspended.
3175 * Returns 0 on success, else negative errno.
3177 int usb_port_suspend(struct usb_device
*udev
, pm_message_t msg
)
3179 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
3180 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
3181 int port1
= udev
->portnum
;
3183 bool really_suspend
= true;
3185 /* enable remote wakeup when appropriate; this lets the device
3186 * wake up the upstream hub (including maybe the root hub).
3188 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
3189 * we don't explicitly enable it here.
3191 if (udev
->do_remote_wakeup
) {
3192 if (!hub_is_superspeed(hub
->hdev
)) {
3193 status
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3194 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
3195 USB_DEVICE_REMOTE_WAKEUP
, 0,
3197 USB_CTRL_SET_TIMEOUT
);
3199 /* Assume there's only one function on the USB 3.0
3200 * device and enable remote wake for the first
3201 * interface. FIXME if the interface association
3202 * descriptor shows there's more than one function.
3204 status
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3205 USB_REQ_SET_FEATURE
,
3206 USB_RECIP_INTERFACE
,
3207 USB_INTRF_FUNC_SUSPEND
,
3208 USB_INTRF_FUNC_SUSPEND_RW
|
3209 USB_INTRF_FUNC_SUSPEND_LP
,
3211 USB_CTRL_SET_TIMEOUT
);
3214 dev_dbg(&udev
->dev
, "won't remote wakeup, status %d\n",
3216 /* bail if autosuspend is requested */
3217 if (PMSG_IS_AUTO(msg
))
3225 /* disable USB2 hardware LPM */
3226 if (udev
->usb2_hw_lpm_enabled
== 1)
3227 usb_set_usb2_hardware_lpm(udev
, 0);
3229 if (usb_disable_ltm(udev
)) {
3230 dev_err(&udev
->dev
, "Failed to disable LTM before suspend\n.");
3233 if (PMSG_IS_AUTO(msg
))
3236 if (usb_unlocked_disable_lpm(udev
)) {
3237 dev_err(&udev
->dev
, "Failed to disable LPM before suspend\n.");
3240 if (PMSG_IS_AUTO(msg
))
3245 if (hub_is_superspeed(hub
->hdev
))
3248 status
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_U3
);
3250 #if 0 /* behavior for kernel 3.10 */
3252 * For system suspend, we do not need to enable the suspend feature
3253 * on individual USB-2 ports. The devices will automatically go
3254 * into suspend a few ms after the root hub stops sending packets.
3255 * The USB 2.0 spec calls this "global suspend".
3257 * However, many USB hubs have a bug: They don't relay wakeup requests
3258 * from a downstream port if the port's suspend feature isn't on.
3259 * Therefore we will turn on the suspend feature if udev or any of its
3260 * descendants is enabled for remote wakeup.
3262 } else if (PMSG_IS_AUTO(msg
) || wakeup_enabled_descendants(udev
) > 0) {
3264 status
= set_port_feature(hub
->hdev
, port1
,
3265 USB_PORT_FEAT_SUSPEND
);
3267 really_suspend
= false;
3270 #else /*roll back behavior to kernel 3.4 */
3273 status
= set_port_feature(hub
->hdev
, port1
,
3274 USB_PORT_FEAT_SUSPEND
);
3279 dev_dbg(hub
->intfdev
, "can't suspend port %d, status %d\n",
3283 /* Try to enable USB3 LPM and LTM again */
3284 usb_unlocked_enable_lpm(udev
);
3286 usb_enable_ltm(udev
);
3288 /* Try to enable USB2 hardware LPM again */
3289 if (udev
->usb2_hw_lpm_capable
== 1)
3290 usb_set_usb2_hardware_lpm(udev
, 1);
3292 if (udev
->do_remote_wakeup
) {
3293 if (udev
->speed
< USB_SPEED_SUPER
)
3294 usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3295 USB_REQ_CLEAR_FEATURE
,
3297 USB_DEVICE_REMOTE_WAKEUP
, 0,
3298 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
3300 usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3301 USB_REQ_CLEAR_FEATURE
,
3302 USB_RECIP_INTERFACE
,
3303 USB_INTRF_FUNC_SUSPEND
, 0,
3304 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
3308 /* System sleep transitions should never fail */
3309 if (!PMSG_IS_AUTO(msg
))
3312 dev_dbg(&udev
->dev
, "usb %ssuspend, wakeup %d\n",
3313 (PMSG_IS_AUTO(msg
) ? "auto-" : ""),
3314 udev
->do_remote_wakeup
);
3315 if (really_suspend
) {
3316 udev
->port_is_suspended
= 1;
3318 /* device has up to 10 msec to fully suspend */
3321 usb_set_device_state(udev
, USB_STATE_SUSPENDED
);
3324 if (status
== 0 && !udev
->do_remote_wakeup
&& udev
->persist_enabled
) {
3325 pm_runtime_put_sync(&port_dev
->dev
);
3326 port_dev
->did_runtime_put
= true;
3329 usb_mark_last_busy(hub
->hdev
);
3334 * If the USB "suspend" state is in use (rather than "global suspend"),
3335 * many devices will be individually taken out of suspend state using
3336 * special "resume" signaling. This routine kicks in shortly after
3337 * hardware resume signaling is finished, either because of selective
3338 * resume (by host) or remote wakeup (by device) ... now see what changed
3339 * in the tree that's rooted at this device.
3341 * If @udev->reset_resume is set then the device is reset before the
3342 * status check is done.
3344 static int finish_port_resume(struct usb_device
*udev
)
3349 /* caller owns the udev device lock */
3350 dev_dbg(&udev
->dev
, "%s\n",
3351 udev
->reset_resume
? "finish reset-resume" : "finish resume");
3353 /* usb ch9 identifies four variants of SUSPENDED, based on what
3354 * state the device resumes to. Linux currently won't see the
3355 * first two on the host side; they'd be inside hub_port_init()
3356 * during many timeouts, but khubd can't suspend until later.
3358 usb_set_device_state(udev
, udev
->actconfig
3359 ? USB_STATE_CONFIGURED
3360 : USB_STATE_ADDRESS
);
3362 /* 10.5.4.5 says not to reset a suspended port if the attached
3363 * device is enabled for remote wakeup. Hence the reset
3364 * operation is carried out here, after the port has been
3367 if (udev
->reset_resume
)
3369 status
= usb_reset_and_verify_device(udev
);
3371 /* 10.5.4.5 says be sure devices in the tree are still there.
3372 * For now let's assume the device didn't go crazy on resume,
3373 * and device drivers will know about any resume quirks.
3378 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0, &devstatus
);
3379 MYDBG("%d\n", status
);
3381 status
= (status
> 0 ? 0 : -ENODEV
);
3383 /* If a normal resume failed, try doing a reset-resume */
3384 if (status
&& !udev
->reset_resume
&& udev
->persist_enabled
) {
3385 dev_dbg(&udev
->dev
, "retry with reset-resume\n");
3386 udev
->reset_resume
= 1;
3387 goto retry_reset_resume
;
3392 dev_dbg(&udev
->dev
, "gone after usb resume? status %d\n",
3395 * There are a few quirky devices which violate the standard
3396 * by claiming to have remote wakeup enabled after a reset,
3397 * which crash if the feature is cleared, hence check for
3398 * udev->reset_resume
3400 } else if (udev
->actconfig
&& !udev
->reset_resume
) {
3401 if (!hub_is_superspeed(udev
->parent
)) {
3402 le16_to_cpus(&devstatus
);
3403 if (devstatus
& (1 << USB_DEVICE_REMOTE_WAKEUP
))
3404 status
= usb_control_msg(udev
,
3405 usb_sndctrlpipe(udev
, 0),
3406 USB_REQ_CLEAR_FEATURE
,
3408 USB_DEVICE_REMOTE_WAKEUP
, 0,
3410 USB_CTRL_SET_TIMEOUT
);
3412 status
= usb_get_status(udev
, USB_RECIP_INTERFACE
, 0,
3414 le16_to_cpus(&devstatus
);
3415 if (!status
&& devstatus
& (USB_INTRF_STAT_FUNC_RW_CAP
3416 | USB_INTRF_STAT_FUNC_RW
))
3418 usb_disable_function_remotewakeup(udev
);
3423 "disable remote wakeup, status %d\n",
3431 * There are some SS USB devices which take longer time for link training.
3432 * XHCI specs 4.19.4 says that when Link training is successful, port
3433 * sets CSC bit to 1. So if SW reads port status before successful link
3434 * training, then it will not find device to be present.
3435 * USB Analyzer log with such buggy devices show that in some cases
3436 * device switch on the RX termination after long delay of host enabling
3437 * the VBUS. In few other cases it has been seen that device fails to
3438 * negotiate link training in first attempt. It has been
3439 * reported till now that few devices take as long as 2000 ms to train
3440 * the link after host enabling its VBUS and termination. Following
3441 * routine implements a 2000 ms timeout for link training. If in a case
3442 * link trains before timeout, loop will exit earlier.
3444 * FIXME: If a device was connected before suspend, but was removed
3445 * while system was asleep, then the loop in the following routine will
3446 * only exit at timeout.
3448 * This routine should only be called when persist is enabled for a SS
3451 static int wait_for_ss_port_enable(struct usb_device
*udev
,
3452 struct usb_hub
*hub
, int *port1
,
3453 u16
*portchange
, u16
*portstatus
)
3455 int status
= 0, delay_ms
= 0;
3457 while (delay_ms
< 2000) {
3458 if (status
|| *portstatus
& USB_PORT_STAT_CONNECTION
)
3462 status
= hub_port_status(hub
, *port1
, portstatus
, portchange
);
3468 * usb_port_resume - re-activate a suspended usb device's upstream port
3469 * @udev: device to re-activate, not a root hub
3470 * Context: must be able to sleep; device not locked; pm locks held
3472 * This will re-activate the suspended device, increasing power usage
3473 * while letting drivers communicate again with its endpoints.
3474 * USB resume explicitly guarantees that the power session between
3475 * the host and the device is the same as it was when the device
3478 * If @udev->reset_resume is set then this routine won't check that the
3479 * port is still enabled. Furthermore, finish_port_resume() above will
3480 * reset @udev. The end result is that a broken power session can be
3481 * recovered and @udev will appear to persist across a loss of VBUS power.
3483 * For example, if a host controller doesn't maintain VBUS suspend current
3484 * during a system sleep or is reset when the system wakes up, all the USB
3485 * power sessions below it will be broken. This is especially troublesome
3486 * for mass-storage devices containing mounted filesystems, since the
3487 * device will appear to have disconnected and all the memory mappings
3488 * to it will be lost. Using the USB_PERSIST facility, the device can be
3489 * made to appear as if it had not disconnected.
3491 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3492 * every effort to insure that the same device is present after the
3493 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3494 * quite possible for a device to remain unaltered but its media to be
3495 * changed. If the user replaces a flash memory card while the system is
3496 * asleep, he will have only himself to blame when the filesystem on the
3497 * new card is corrupted and the system crashes.
3499 * Returns 0 on success, else negative errno.
3501 int usb_port_resume(struct usb_device
*udev
, pm_message_t msg
)
3503 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
3504 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
3505 int port1
= udev
->portnum
;
3507 u16 portchange
, portstatus
;
3509 if (port_dev
->did_runtime_put
) {
3510 status
= pm_runtime_get_sync(&port_dev
->dev
);
3511 port_dev
->did_runtime_put
= false;
3513 dev_dbg(&udev
->dev
, "can't resume usb port, status %d\n",
3519 /* Skip the initial Clear-Suspend step for a remote wakeup */
3520 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3521 if (status
== 0 && !port_is_suspended(hub
, portstatus
))
3522 goto SuspendCleared
;
3524 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
3526 set_bit(port1
, hub
->busy_bits
);
3528 /* see 7.1.7.7; affects power usage, but not budgeting */
3529 if (hub_is_superspeed(hub
->hdev
))
3530 status
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_U0
);
3532 status
= usb_clear_port_feature(hub
->hdev
,
3533 port1
, USB_PORT_FEAT_SUSPEND
);
3535 dev_dbg(hub
->intfdev
, "can't resume port %d, status %d\n",
3538 /* drive resume for USB_RESUME_TIMEOUT msec */
3539 dev_dbg(&udev
->dev
, "usb %sresume\n",
3540 (PMSG_IS_AUTO(msg
) ? "auto-" : ""));
3541 msleep(USB_RESUME_TIMEOUT
);
3543 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3544 * stop resume signaling. Then finish the resume
3547 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3549 /* TRSMRCY = 10 msec */
3555 udev
->port_is_suspended
= 0;
3556 if (hub_is_superspeed(hub
->hdev
)) {
3557 if (portchange
& USB_PORT_STAT_C_LINK_STATE
)
3558 usb_clear_port_feature(hub
->hdev
, port1
,
3559 USB_PORT_FEAT_C_PORT_LINK_STATE
);
3561 if (portchange
& USB_PORT_STAT_C_SUSPEND
)
3562 usb_clear_port_feature(hub
->hdev
, port1
,
3563 USB_PORT_FEAT_C_SUSPEND
);
3567 clear_bit(port1
, hub
->busy_bits
);
3569 if (udev
->persist_enabled
&& hub_is_superspeed(hub
->hdev
))
3570 status
= wait_for_ss_port_enable(udev
, hub
, &port1
, &portchange
,
3573 status
= check_port_resume_type(udev
,
3574 hub
, port1
, status
, portchange
, portstatus
);
3576 status
= finish_port_resume(udev
);
3578 dev_dbg(&udev
->dev
, "can't resume, status %d\n", status
);
3579 hub_port_logical_disconnect(hub
, port1
);
3581 /* Try to enable USB2 hardware LPM */
3582 if (udev
->usb2_hw_lpm_capable
== 1)
3583 usb_set_usb2_hardware_lpm(udev
, 1);
3585 /* Try to enable USB3 LTM and LPM */
3586 usb_enable_ltm(udev
);
3587 usb_unlocked_enable_lpm(udev
);
3593 #endif /* CONFIG_PM */
3595 #ifdef CONFIG_PM_RUNTIME
3597 /* caller has locked udev */
3598 int usb_remote_wakeup(struct usb_device
*udev
)
3602 if (udev
->state
== USB_STATE_SUSPENDED
) {
3603 dev_dbg(&udev
->dev
, "usb %sresume\n", "wakeup-");
3604 status
= usb_autoresume_device(udev
);
3606 /* Let the drivers do their thing, then... */
3607 usb_autosuspend_device(udev
);
3615 static int check_ports_changed(struct usb_hub
*hub
)
3619 for (port1
= 1; port1
<= hub
->hdev
->maxchild
; ++port1
) {
3620 u16 portstatus
, portchange
;
3623 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3624 if (!status
&& portchange
)
3630 static int hub_suspend(struct usb_interface
*intf
, pm_message_t msg
)
3632 struct usb_hub
*hub
= usb_get_intfdata (intf
);
3633 struct usb_device
*hdev
= hub
->hdev
;
3638 * Warn if children aren't already suspended.
3639 * Also, add up the number of wakeup-enabled descendants.
3641 hub
->wakeup_enabled_descendants
= 0;
3642 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
3643 struct usb_device
*udev
;
3645 udev
= hub
->ports
[port1
- 1]->child
;
3646 if (udev
&& udev
->can_submit
) {
3647 dev_warn(&intf
->dev
, "port %d nyet suspended\n", port1
);
3648 if (PMSG_IS_AUTO(msg
))
3652 hub
->wakeup_enabled_descendants
+=
3653 wakeup_enabled_descendants(udev
);
3656 if (hdev
->do_remote_wakeup
&& hub
->quirk_check_port_auto_suspend
) {
3657 /* check if there are changes pending on hub ports */
3658 if (check_ports_changed(hub
)) {
3659 if (PMSG_IS_AUTO(msg
))
3661 pm_wakeup_event(&hdev
->dev
, 2000);
3665 if (hub_is_superspeed(hdev
) && hdev
->do_remote_wakeup
) {
3666 /* Enable hub to send remote wakeup for all ports. */
3667 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
3668 status
= set_port_feature(hdev
,
3670 USB_PORT_FEAT_REMOTE_WAKE_CONNECT
|
3671 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT
|
3672 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT
,
3673 USB_PORT_FEAT_REMOTE_WAKE_MASK
);
3677 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3679 /* stop khubd and related activity */
3680 hub_quiesce(hub
, HUB_SUSPEND
);
3684 static int hub_resume(struct usb_interface
*intf
)
3686 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3688 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3689 hub_activate(hub
, HUB_RESUME
);
3693 static int hub_reset_resume(struct usb_interface
*intf
)
3695 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3697 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3698 hub_activate(hub
, HUB_RESET_RESUME
);
3703 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3704 * @rhdev: struct usb_device for the root hub
3706 * The USB host controller driver calls this function when its root hub
3707 * is resumed and Vbus power has been interrupted or the controller
3708 * has been reset. The routine marks @rhdev as having lost power.
3709 * When the hub driver is resumed it will take notice and carry out
3710 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3711 * the others will be disconnected.
3713 void usb_root_hub_lost_power(struct usb_device
*rhdev
)
3715 dev_warn(&rhdev
->dev
, "root hub lost power or was reset\n");
3716 rhdev
->reset_resume
= 1;
3718 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power
);
3720 static const char * const usb3_lpm_names
[] = {
3728 * Send a Set SEL control transfer to the device, prior to enabling
3729 * device-initiated U1 or U2. This lets the device know the exit latencies from
3730 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3731 * packet from the host.
3733 * This function will fail if the SEL or PEL values for udev are greater than
3734 * the maximum allowed values for the link state to be enabled.
3736 static int usb_req_set_sel(struct usb_device
*udev
, enum usb3_link_state state
)
3738 struct usb_set_sel_req
*sel_values
;
3739 unsigned long long u1_sel
;
3740 unsigned long long u1_pel
;
3741 unsigned long long u2_sel
;
3742 unsigned long long u2_pel
;
3745 /* Convert SEL and PEL stored in ns to us */
3746 u1_sel
= DIV_ROUND_UP(udev
->u1_params
.sel
, 1000);
3747 u1_pel
= DIV_ROUND_UP(udev
->u1_params
.pel
, 1000);
3748 u2_sel
= DIV_ROUND_UP(udev
->u2_params
.sel
, 1000);
3749 u2_pel
= DIV_ROUND_UP(udev
->u2_params
.pel
, 1000);
3752 * Make sure that the calculated SEL and PEL values for the link
3753 * state we're enabling aren't bigger than the max SEL/PEL
3754 * value that will fit in the SET SEL control transfer.
3755 * Otherwise the device would get an incorrect idea of the exit
3756 * latency for the link state, and could start a device-initiated
3757 * U1/U2 when the exit latencies are too high.
3759 if ((state
== USB3_LPM_U1
&&
3760 (u1_sel
> USB3_LPM_MAX_U1_SEL_PEL
||
3761 u1_pel
> USB3_LPM_MAX_U1_SEL_PEL
)) ||
3762 (state
== USB3_LPM_U2
&&
3763 (u2_sel
> USB3_LPM_MAX_U2_SEL_PEL
||
3764 u2_pel
> USB3_LPM_MAX_U2_SEL_PEL
))) {
3765 dev_dbg(&udev
->dev
, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3766 usb3_lpm_names
[state
], u1_sel
, u1_pel
);
3771 * If we're enabling device-initiated LPM for one link state,
3772 * but the other link state has a too high SEL or PEL value,
3773 * just set those values to the max in the Set SEL request.
3775 if (u1_sel
> USB3_LPM_MAX_U1_SEL_PEL
)
3776 u1_sel
= USB3_LPM_MAX_U1_SEL_PEL
;
3778 if (u1_pel
> USB3_LPM_MAX_U1_SEL_PEL
)
3779 u1_pel
= USB3_LPM_MAX_U1_SEL_PEL
;
3781 if (u2_sel
> USB3_LPM_MAX_U2_SEL_PEL
)
3782 u2_sel
= USB3_LPM_MAX_U2_SEL_PEL
;
3784 if (u2_pel
> USB3_LPM_MAX_U2_SEL_PEL
)
3785 u2_pel
= USB3_LPM_MAX_U2_SEL_PEL
;
3788 * usb_enable_lpm() can be called as part of a failed device reset,
3789 * which may be initiated by an error path of a mass storage driver.
3790 * Therefore, use GFP_NOIO.
3792 sel_values
= kmalloc(sizeof *(sel_values
), GFP_NOIO
);
3796 sel_values
->u1_sel
= u1_sel
;
3797 sel_values
->u1_pel
= u1_pel
;
3798 sel_values
->u2_sel
= cpu_to_le16(u2_sel
);
3799 sel_values
->u2_pel
= cpu_to_le16(u2_pel
);
3801 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3805 sel_values
, sizeof *(sel_values
),
3806 USB_CTRL_SET_TIMEOUT
);
3812 * Enable or disable device-initiated U1 or U2 transitions.
3814 static int usb_set_device_initiated_lpm(struct usb_device
*udev
,
3815 enum usb3_link_state state
, bool enable
)
3822 feature
= USB_DEVICE_U1_ENABLE
;
3825 feature
= USB_DEVICE_U2_ENABLE
;
3828 dev_warn(&udev
->dev
, "%s: Can't %s non-U1 or U2 state.\n",
3829 __func__
, enable
? "enable" : "disable");
3833 if (udev
->state
!= USB_STATE_CONFIGURED
) {
3834 dev_dbg(&udev
->dev
, "%s: Can't %s %s state "
3835 "for unconfigured device.\n",
3836 __func__
, enable
? "enable" : "disable",
3837 usb3_lpm_names
[state
]);
3843 * Now send the control transfer to enable device-initiated LPM
3844 * for either U1 or U2.
3846 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3847 USB_REQ_SET_FEATURE
,
3851 USB_CTRL_SET_TIMEOUT
);
3853 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3854 USB_REQ_CLEAR_FEATURE
,
3858 USB_CTRL_SET_TIMEOUT
);
3861 dev_warn(&udev
->dev
, "%s of device-initiated %s failed.\n",
3862 enable
? "Enable" : "Disable",
3863 usb3_lpm_names
[state
]);
3869 static int usb_set_lpm_timeout(struct usb_device
*udev
,
3870 enum usb3_link_state state
, int timeout
)
3877 feature
= USB_PORT_FEAT_U1_TIMEOUT
;
3880 feature
= USB_PORT_FEAT_U2_TIMEOUT
;
3883 dev_warn(&udev
->dev
, "%s: Can't set timeout for non-U1 or U2 state.\n",
3888 if (state
== USB3_LPM_U1
&& timeout
> USB3_LPM_U1_MAX_TIMEOUT
&&
3889 timeout
!= USB3_LPM_DEVICE_INITIATED
) {
3890 dev_warn(&udev
->dev
, "Failed to set %s timeout to 0x%x, "
3891 "which is a reserved value.\n",
3892 usb3_lpm_names
[state
], timeout
);
3896 ret
= set_port_feature(udev
->parent
,
3897 USB_PORT_LPM_TIMEOUT(timeout
) | udev
->portnum
,
3900 dev_warn(&udev
->dev
, "Failed to set %s timeout to 0x%x,"
3901 "error code %i\n", usb3_lpm_names
[state
],
3905 if (state
== USB3_LPM_U1
)
3906 udev
->u1_params
.timeout
= timeout
;
3908 udev
->u2_params
.timeout
= timeout
;
3913 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3916 * We will attempt to enable U1 or U2, but there are no guarantees that the
3917 * control transfers to set the hub timeout or enable device-initiated U1/U2
3918 * will be successful.
3920 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3921 * driver know about it. If that call fails, it should be harmless, and just
3922 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3924 static void usb_enable_link_state(struct usb_hcd
*hcd
, struct usb_device
*udev
,
3925 enum usb3_link_state state
)
3928 __u8 u1_mel
= udev
->bos
->ss_cap
->bU1devExitLat
;
3929 __le16 u2_mel
= udev
->bos
->ss_cap
->bU2DevExitLat
;
3931 /* If the device says it doesn't have *any* exit latency to come out of
3932 * U1 or U2, it's probably lying. Assume it doesn't implement that link
3935 if ((state
== USB3_LPM_U1
&& u1_mel
== 0) ||
3936 (state
== USB3_LPM_U2
&& u2_mel
== 0))
3940 * First, let the device know about the exit latencies
3941 * associated with the link state we're about to enable.
3943 ret
= usb_req_set_sel(udev
, state
);
3945 dev_warn(&udev
->dev
, "Set SEL for device-initiated %s failed.\n",
3946 usb3_lpm_names
[state
]);
3950 /* We allow the host controller to set the U1/U2 timeout internally
3951 * first, so that it can change its schedule to account for the
3952 * additional latency to send data to a device in a lower power
3955 timeout
= hcd
->driver
->enable_usb3_lpm_timeout(hcd
, udev
, state
);
3957 /* xHCI host controller doesn't want to enable this LPM state. */
3962 dev_warn(&udev
->dev
, "Could not enable %s link state, "
3963 "xHCI error %i.\n", usb3_lpm_names
[state
],
3968 if (usb_set_lpm_timeout(udev
, state
, timeout
))
3969 /* If we can't set the parent hub U1/U2 timeout,
3970 * device-initiated LPM won't be allowed either, so let the xHCI
3971 * host know that this link state won't be enabled.
3973 hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
);
3975 /* Only a configured device will accept the Set Feature U1/U2_ENABLE */
3976 else if (udev
->actconfig
)
3977 usb_set_device_initiated_lpm(udev
, state
, true);
3982 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
3985 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
3986 * If zero is returned, the parent will not allow the link to go into U1/U2.
3988 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
3989 * it won't have an effect on the bus link state because the parent hub will
3990 * still disallow device-initiated U1/U2 entry.
3992 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
3993 * possible. The result will be slightly more bus bandwidth will be taken up
3994 * (to account for U1/U2 exit latency), but it should be harmless.
3996 static int usb_disable_link_state(struct usb_hcd
*hcd
, struct usb_device
*udev
,
3997 enum usb3_link_state state
)
4003 feature
= USB_PORT_FEAT_U1_TIMEOUT
;
4006 feature
= USB_PORT_FEAT_U2_TIMEOUT
;
4009 dev_warn(&udev
->dev
, "%s: Can't disable non-U1 or U2 state.\n",
4014 if (usb_set_lpm_timeout(udev
, state
, 0))
4017 usb_set_device_initiated_lpm(udev
, state
, false);
4019 if (hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
))
4020 dev_warn(&udev
->dev
, "Could not disable xHCI %s timeout, "
4021 "bus schedule bandwidth may be impacted.\n",
4022 usb3_lpm_names
[state
]);
4027 * Disable hub-initiated and device-initiated U1 and U2 entry.
4028 * Caller must own the bandwidth_mutex.
4030 * This will call usb_enable_lpm() on failure, which will decrement
4031 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
4033 int usb_disable_lpm(struct usb_device
*udev
)
4035 struct usb_hcd
*hcd
;
4037 if (!udev
|| !udev
->parent
||
4038 udev
->speed
!= USB_SPEED_SUPER
||
4042 hcd
= bus_to_hcd(udev
->bus
);
4043 if (!hcd
|| !hcd
->driver
->disable_usb3_lpm_timeout
)
4046 udev
->lpm_disable_count
++;
4047 if ((udev
->u1_params
.timeout
== 0 && udev
->u2_params
.timeout
== 0))
4050 /* If LPM is enabled, attempt to disable it. */
4051 if (usb_disable_link_state(hcd
, udev
, USB3_LPM_U1
))
4053 if (usb_disable_link_state(hcd
, udev
, USB3_LPM_U2
))
4059 usb_enable_lpm(udev
);
4062 EXPORT_SYMBOL_GPL(usb_disable_lpm
);
4064 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
4065 int usb_unlocked_disable_lpm(struct usb_device
*udev
)
4067 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4073 mutex_lock(hcd
->bandwidth_mutex
);
4074 ret
= usb_disable_lpm(udev
);
4075 mutex_unlock(hcd
->bandwidth_mutex
);
4079 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm
);
4082 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
4083 * xHCI host policy may prevent U1 or U2 from being enabled.
4085 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
4086 * until the lpm_disable_count drops to zero. Caller must own the
4089 void usb_enable_lpm(struct usb_device
*udev
)
4091 struct usb_hcd
*hcd
;
4093 if (!udev
|| !udev
->parent
||
4094 udev
->speed
!= USB_SPEED_SUPER
||
4098 udev
->lpm_disable_count
--;
4099 hcd
= bus_to_hcd(udev
->bus
);
4100 /* Double check that we can both enable and disable LPM.
4101 * Device must be configured to accept set feature U1/U2 timeout.
4103 if (!hcd
|| !hcd
->driver
->enable_usb3_lpm_timeout
||
4104 !hcd
->driver
->disable_usb3_lpm_timeout
)
4107 if (udev
->lpm_disable_count
> 0)
4110 usb_enable_link_state(hcd
, udev
, USB3_LPM_U1
);
4111 usb_enable_link_state(hcd
, udev
, USB3_LPM_U2
);
4113 EXPORT_SYMBOL_GPL(usb_enable_lpm
);
4115 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
4116 void usb_unlocked_enable_lpm(struct usb_device
*udev
)
4118 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4123 mutex_lock(hcd
->bandwidth_mutex
);
4124 usb_enable_lpm(udev
);
4125 mutex_unlock(hcd
->bandwidth_mutex
);
4127 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm
);
4130 #else /* CONFIG_PM */
4132 #define hub_suspend NULL
4133 #define hub_resume NULL
4134 #define hub_reset_resume NULL
4136 int usb_disable_lpm(struct usb_device
*udev
)
4140 EXPORT_SYMBOL_GPL(usb_disable_lpm
);
4142 void usb_enable_lpm(struct usb_device
*udev
) { }
4143 EXPORT_SYMBOL_GPL(usb_enable_lpm
);
4145 int usb_unlocked_disable_lpm(struct usb_device
*udev
)
4149 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm
);
4151 void usb_unlocked_enable_lpm(struct usb_device
*udev
) { }
4152 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm
);
4154 int usb_disable_ltm(struct usb_device
*udev
)
4158 EXPORT_SYMBOL_GPL(usb_disable_ltm
);
4160 void usb_enable_ltm(struct usb_device
*udev
) { }
4161 EXPORT_SYMBOL_GPL(usb_enable_ltm
);
4165 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
4167 * Between connect detection and reset signaling there must be a delay
4168 * of 100ms at least for debounce and power-settling. The corresponding
4169 * timer shall restart whenever the downstream port detects a disconnect.
4171 * Apparently there are some bluetooth and irda-dongles and a number of
4172 * low-speed devices for which this debounce period may last over a second.
4173 * Not covered by the spec - but easy to deal with.
4175 * This implementation uses a 1500ms total debounce timeout; if the
4176 * connection isn't stable by then it returns -ETIMEDOUT. It checks
4177 * every 25ms for transient disconnects. When the port status has been
4178 * unchanged for 100ms it returns the port status.
4180 int hub_port_debounce(struct usb_hub
*hub
, int port1
, bool must_be_connected
)
4183 int total_time
, stable_time
= 0;
4184 u16 portchange
, portstatus
;
4185 unsigned connection
= 0xffff;
4187 for (total_time
= 0; ; total_time
+= HUB_DEBOUNCE_STEP
) {
4188 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
4192 if (!(portchange
& USB_PORT_STAT_C_CONNECTION
) &&
4193 (portstatus
& USB_PORT_STAT_CONNECTION
) == connection
) {
4194 if (!must_be_connected
||
4195 (connection
== USB_PORT_STAT_CONNECTION
))
4196 stable_time
+= HUB_DEBOUNCE_STEP
;
4197 if (stable_time
>= HUB_DEBOUNCE_STABLE
)
4201 connection
= portstatus
& USB_PORT_STAT_CONNECTION
;
4204 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
4205 usb_clear_port_feature(hub
->hdev
, port1
,
4206 USB_PORT_FEAT_C_CONNECTION
);
4209 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
4211 msleep(HUB_DEBOUNCE_STEP
);
4214 dev_dbg (hub
->intfdev
,
4215 "debounce: port %d: total %dms stable %dms status 0x%x\n",
4216 port1
, total_time
, stable_time
, portstatus
);
4218 if (stable_time
< HUB_DEBOUNCE_STABLE
)
4223 void usb_ep0_reinit(struct usb_device
*udev
)
4225 usb_disable_endpoint(udev
, 0 + USB_DIR_IN
, true);
4226 usb_disable_endpoint(udev
, 0 + USB_DIR_OUT
, true);
4227 usb_enable_endpoint(udev
, &udev
->ep0
, true);
4229 EXPORT_SYMBOL_GPL(usb_ep0_reinit
);
4232 static int hub_set_address(struct usb_device
*udev
, int devnum
)
4235 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4238 * The host controller will choose the device address,
4239 * instead of the core having chosen it earlier
4241 if (!hcd
->driver
->address_device
&& devnum
<= 1)
4243 if (udev
->state
== USB_STATE_ADDRESS
)
4245 if (udev
->state
!= USB_STATE_DEFAULT
)
4247 if (hcd
->driver
->address_device
)
4248 retval
= hcd
->driver
->address_device(hcd
, udev
);
4250 retval
= usb_control_msg(udev
, usb_sndaddr0pipe(),
4251 USB_REQ_SET_ADDRESS
, 0, devnum
, 0,
4252 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
4254 update_devnum(udev
, devnum
);
4255 /* Device now using proper address. */
4256 usb_set_device_state(udev
, USB_STATE_ADDRESS
);
4257 usb_ep0_reinit(udev
);
4262 /* Reset device, (re)assign address, get device descriptor.
4263 * Device connection must be stable, no more debouncing needed.
4264 * Returns device in USB_STATE_ADDRESS, except on error.
4266 * If this is called for an already-existing device (as part of
4267 * usb_reset_and_verify_device), the caller must own the device lock. For a
4268 * newly detected device that is not accessible through any global
4269 * pointers, it's not necessary to lock the device.
4272 hub_port_init (struct usb_hub
*hub
, struct usb_device
*udev
, int port1
,
4275 static DEFINE_MUTEX(usb_address0_mutex
);
4277 struct usb_device
*hdev
= hub
->hdev
;
4278 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
4280 unsigned delay
= HUB_SHORT_RESET_TIME
;
4281 enum usb_device_speed oldspeed
= udev
->speed
;
4283 int devnum
= udev
->devnum
;
4286 /* root hub ports have a slightly longer reset period
4287 * (from USB 2.0 spec, section 7.1.7.5)
4289 if (!hdev
->parent
) {
4290 delay
= HUB_ROOT_RESET_TIME
;
4291 if (port1
== hdev
->bus
->otg_port
)
4292 hdev
->bus
->b_hnp_enable
= 0;
4295 /* Some low speed devices have problems with the quick delay, so */
4296 /* be a bit pessimistic with those devices. RHbug #23670 */
4297 if (oldspeed
== USB_SPEED_LOW
)
4298 delay
= HUB_LONG_RESET_TIME
;
4300 mutex_lock(&usb_address0_mutex
);
4302 /* Reset the device; full speed may morph to high speed */
4303 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
4305 retval
= hub_port_reset(hub
, port1
, udev
, delay
, false);
4307 if (retval
< 0) /* error or disconnect */
4309 /* success, speed is known */
4313 if (oldspeed
!= USB_SPEED_UNKNOWN
&& oldspeed
!= udev
->speed
) {
4314 dev_dbg(&udev
->dev
, "device reset changed speed!\n");
4317 oldspeed
= udev
->speed
;
4319 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4320 * it's fixed size except for full speed devices.
4321 * For Wireless USB devices, ep0 max packet is always 512 (tho
4322 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4324 switch (udev
->speed
) {
4325 case USB_SPEED_SUPER
:
4326 case USB_SPEED_WIRELESS
: /* fixed at 512 */
4327 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(512);
4329 case USB_SPEED_HIGH
: /* fixed at 64 */
4330 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(64);
4332 case USB_SPEED_FULL
: /* 8, 16, 32, or 64 */
4333 /* to determine the ep0 maxpacket size, try to read
4334 * the device descriptor to get bMaxPacketSize0 and
4335 * then correct our initial guess.
4337 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(64);
4339 case USB_SPEED_LOW
: /* fixed at 8 */
4340 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(8);
4347 if (udev
->speed
== USB_SPEED_WIRELESS
)
4348 speed
= "variable speed Wireless";
4350 speed
= usb_speed_string(udev
->speed
);
4352 if (udev
->speed
!= USB_SPEED_SUPER
)
4353 dev_info(&udev
->dev
,
4354 "%s %s USB device number %d using %s\n",
4355 (udev
->config
) ? "reset" : "new", speed
,
4356 devnum
, udev
->bus
->controller
->driver
->name
);
4358 /* Set up TT records, if needed */
4360 udev
->tt
= hdev
->tt
;
4361 udev
->ttport
= hdev
->ttport
;
4362 } else if (udev
->speed
!= USB_SPEED_HIGH
4363 && hdev
->speed
== USB_SPEED_HIGH
) {
4365 dev_err(&udev
->dev
, "parent hub has no TT\n");
4369 udev
->tt
= &hub
->tt
;
4370 udev
->ttport
= port1
;
4373 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4374 * Because device hardware and firmware is sometimes buggy in
4375 * this area, and this is how Linux has done it for ages.
4376 * Change it cautiously.
4378 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
4379 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4380 * so it may help with some non-standards-compliant devices.
4381 * Otherwise we start with SET_ADDRESS and then try to read the
4382 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4385 for (i
= 0; i
< GET_DESCRIPTOR_TRIES
; (++i
, msleep(100))) {
4387 if (USE_NEW_SCHEME(retry_counter
) && !(hcd
->driver
->flags
& HCD_USB3
)) {
4388 struct usb_device_descriptor
*buf
;
4391 #define GET_DESCRIPTOR_BUFSIZE 64
4392 buf
= kmalloc(GET_DESCRIPTOR_BUFSIZE
, GFP_NOIO
);
4398 /* Retry on all errors; some devices are flakey.
4399 * 255 is for WUSB devices, we actually need to use
4400 * 512 (WUSB1.0[4.8.1]).
4402 for (j
= 0; j
< 3; ++j
) {
4403 buf
->bMaxPacketSize0
= 0;
4404 r
= usb_control_msg(udev
, usb_rcvaddr0pipe(),
4405 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
,
4406 USB_DT_DEVICE
<< 8, 0,
4407 buf
, GET_DESCRIPTOR_BUFSIZE
,
4408 initial_descriptor_timeout
);
4409 switch (buf
->bMaxPacketSize0
) {
4410 case 8: case 16: case 32: case 64: case 255:
4411 if (buf
->bDescriptorType
==
4425 #if defined(CONFIG_USBIF_COMPLIANCE) && defined(CONFIG_USB_XHCI_HCD)
4426 if (buf
->bMaxPacketSize0
== 0) {
4427 usbif_u3h_send_event("DEV_CONN_TMOUT");
4432 udev
->descriptor
.bMaxPacketSize0
=
4433 buf
->bMaxPacketSize0
;
4436 retval
= hub_port_reset(hub
, port1
, udev
, delay
, false);
4437 if (retval
< 0) /* error or disconnect */
4439 if (oldspeed
!= udev
->speed
) {
4441 "device reset changed speed!\n");
4447 dev_err(&udev
->dev
, "device descriptor read/64, error %d\n",
4452 #undef GET_DESCRIPTOR_BUFSIZE
4456 * If device is WUSB, we already assigned an
4457 * unauthorized address in the Connect Ack sequence;
4458 * authorization will assign the final address.
4460 if (udev
->wusb
== 0) {
4461 for (j
= 0; j
< SET_ADDRESS_TRIES
; ++j
) {
4462 retval
= hub_set_address(udev
, devnum
);
4468 if (retval
!= -ENODEV
)
4469 dev_err(&udev
->dev
, "device not accepting address %d, error %d\n",
4473 if (udev
->speed
== USB_SPEED_SUPER
) {
4474 devnum
= udev
->devnum
;
4475 dev_info(&udev
->dev
,
4476 "%s SuperSpeed USB device number %d using %s\n",
4477 (udev
->config
) ? "reset" : "new",
4478 devnum
, udev
->bus
->controller
->driver
->name
);
4481 /* cope with hardware quirkiness:
4482 * - let SET_ADDRESS settle, some device hardware wants it
4483 * - read ep0 maxpacket even for high and low speed,
4486 if (USE_NEW_SCHEME(retry_counter
) && !(hcd
->driver
->flags
& HCD_USB3
))
4490 retval
= usb_get_device_descriptor(udev
, 8);
4492 if (retval
!= -ENODEV
)
4494 "device descriptor read/8, error %d\n",
4506 if (hcd
->phy
&& !hdev
->parent
)
4507 usb_phy_notify_connect(hcd
->phy
, udev
->speed
);
4510 * Some superspeed devices have finished the link training process
4511 * and attached to a superspeed hub port, but the device descriptor
4512 * got from those devices show they aren't superspeed devices. Warm
4513 * reset the port attached by the devices can fix them.
4515 if ((udev
->speed
== USB_SPEED_SUPER
) &&
4516 (le16_to_cpu(udev
->descriptor
.bcdUSB
) < 0x0300)) {
4517 dev_err(&udev
->dev
, "got a wrong device descriptor, "
4518 "warm reset device\n");
4519 hub_port_reset(hub
, port1
, udev
,
4520 HUB_BH_RESET_TIME
, true);
4525 if (udev
->descriptor
.bMaxPacketSize0
== 0xff ||
4526 udev
->speed
== USB_SPEED_SUPER
)
4529 i
= udev
->descriptor
.bMaxPacketSize0
;
4530 if (usb_endpoint_maxp(&udev
->ep0
.desc
) != i
) {
4531 if (udev
->speed
== USB_SPEED_LOW
||
4532 !(i
== 8 || i
== 16 || i
== 32 || i
== 64)) {
4533 dev_err(&udev
->dev
, "Invalid ep0 maxpacket: %d\n", i
);
4537 if (udev
->speed
== USB_SPEED_FULL
)
4538 dev_dbg(&udev
->dev
, "ep0 maxpacket = %d\n", i
);
4540 dev_warn(&udev
->dev
, "Using ep0 maxpacket: %d\n", i
);
4541 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(i
);
4542 usb_ep0_reinit(udev
);
4545 retval
= usb_get_device_descriptor(udev
, USB_DT_DEVICE_SIZE
);
4546 if (retval
< (signed)sizeof(udev
->descriptor
)) {
4547 if (retval
!= -ENODEV
)
4548 dev_err(&udev
->dev
, "device descriptor read/all, error %d\n",
4555 usb_detect_quirks(udev
);
4557 if (udev
->wusb
== 0 && le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0201) {
4558 retval
= usb_get_bos_descriptor(udev
);
4560 udev
->lpm_capable
= usb_device_supports_lpm(udev
);
4561 usb_set_lpm_parameters(udev
);
4566 /* notify HCD that we have a device connected and addressed */
4567 if (hcd
->driver
->update_device
)
4568 hcd
->driver
->update_device(hcd
, udev
);
4571 hub_port_disable(hub
, port1
, 0);
4572 update_devnum(udev
, devnum
); /* for disconnect processing */
4574 mutex_unlock(&usb_address0_mutex
);
4579 check_highspeed (struct usb_hub
*hub
, struct usb_device
*udev
, int port1
)
4581 struct usb_qualifier_descriptor
*qual
;
4584 qual
= kmalloc (sizeof *qual
, GFP_KERNEL
);
4588 status
= usb_get_descriptor (udev
, USB_DT_DEVICE_QUALIFIER
, 0,
4589 qual
, sizeof *qual
);
4590 if (status
== sizeof *qual
) {
4591 dev_info(&udev
->dev
, "not running at top speed; "
4592 "connect to a high speed hub\n");
4593 /* hub LEDs are probably harder to miss than syslog */
4594 if (hub
->has_indicators
) {
4595 hub
->indicator
[port1
-1] = INDICATOR_GREEN_BLINK
;
4596 schedule_delayed_work (&hub
->leds
, 0);
4603 hub_power_remaining (struct usb_hub
*hub
)
4605 struct usb_device
*hdev
= hub
->hdev
;
4609 if (!hub
->limited_power
)
4612 remaining
= hdev
->bus_mA
- hub
->descriptor
->bHubContrCurrent
;
4613 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
4614 struct usb_device
*udev
= hub
->ports
[port1
- 1]->child
;
4620 if (hub_is_superspeed(udev
))
4626 * Unconfigured devices may not use more than one unit load,
4627 * or 8mA for OTG ports
4629 if (udev
->actconfig
)
4630 delta
= usb_get_max_power(udev
, udev
->actconfig
);
4631 else if (port1
!= udev
->bus
->otg_port
|| hdev
->parent
)
4635 if (delta
> hub
->mA_per_port
)
4636 dev_warn(&udev
->dev
,
4637 "%dmA is over %umA budget for port %d!\n",
4638 delta
, hub
->mA_per_port
, port1
);
4641 if (remaining
< 0) {
4642 #if defined(CONFIG_USBIF_COMPLIANCE) && defined(CONFIG_USB_XHCI_HCD)
4643 usbif_u3h_send_event("DEV_OVER_CURRENT");
4645 dev_warn(hub
->intfdev
, "%dmA over power budget!\n",
4652 /* Handle physical or logical connection change events.
4653 * This routine is called when:
4654 * a port connection-change occurs;
4655 * a port enable-change occurs (often caused by EMI);
4656 * usb_reset_and_verify_device() encounters changed descriptors (as from
4657 * a firmware download)
4658 * caller already locked the hub
4660 static void hub_port_connect_change(struct usb_hub
*hub
, int port1
,
4661 u16 portstatus
, u16 portchange
)
4663 struct usb_device
*hdev
= hub
->hdev
;
4664 struct device
*hub_dev
= hub
->intfdev
;
4665 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
4666 unsigned wHubCharacteristics
=
4667 le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
4668 struct usb_device
*udev
;
4674 "port %d, status %04x, change %04x, %s\n",
4675 port1
, portstatus
, portchange
, portspeed(hub
, portstatus
));
4677 if (hub
->has_indicators
) {
4678 set_port_led(hub
, port1
, HUB_LED_AUTO
);
4679 hub
->indicator
[port1
-1] = INDICATOR_AUTO
;
4682 #ifdef CONFIG_USB_OTG
4683 /* during HNP, don't repeat the debounce */
4684 if (hdev
->bus
->is_b_host
)
4685 portchange
&= ~(USB_PORT_STAT_C_CONNECTION
|
4686 USB_PORT_STAT_C_ENABLE
);
4689 /* Try to resuscitate an existing device */
4690 udev
= hub
->ports
[port1
- 1]->child
;
4691 if ((portstatus
& USB_PORT_STAT_CONNECTION
) && udev
&&
4692 udev
->state
!= USB_STATE_NOTATTACHED
) {
4693 usb_lock_device(udev
);
4694 if (portstatus
& USB_PORT_STAT_ENABLE
) {
4695 status
= 0; /* Nothing to do */
4697 #ifdef CONFIG_PM_RUNTIME
4698 } else if (udev
->state
== USB_STATE_SUSPENDED
&&
4699 udev
->persist_enabled
) {
4700 /* For a suspended device, treat this as a
4701 * remote wakeup event.
4703 status
= usb_remote_wakeup(udev
);
4707 status
= -ENODEV
; /* Don't resuscitate */
4709 usb_unlock_device(udev
);
4712 clear_bit(port1
, hub
->change_bits
);
4717 /* Disconnect any existing devices under this port */
4719 if (hcd
->phy
&& !hdev
->parent
&&
4720 !(portstatus
& USB_PORT_STAT_CONNECTION
))
4721 usb_phy_notify_disconnect(hcd
->phy
, udev
->speed
);
4722 usb_disconnect(&hub
->ports
[port1
- 1]->child
);
4724 clear_bit(port1
, hub
->change_bits
);
4726 /* We can forget about a "removed" device when there's a physical
4727 * disconnect or the connect status changes.
4729 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
4730 (portchange
& USB_PORT_STAT_C_CONNECTION
))
4731 clear_bit(port1
, hub
->removed_bits
);
4733 if (portchange
& (USB_PORT_STAT_C_CONNECTION
|
4734 USB_PORT_STAT_C_ENABLE
)) {
4735 status
= hub_port_debounce_be_stable(hub
, port1
);
4737 if (status
!= -ENODEV
&& printk_ratelimit())
4738 dev_err(hub_dev
, "connect-debounce failed, "
4739 "port %d disabled\n", port1
);
4740 portstatus
&= ~USB_PORT_STAT_CONNECTION
;
4742 portstatus
= status
;
4746 /* Return now if debouncing failed or nothing is connected or
4747 * the device was "removed".
4749 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
4750 test_bit(port1
, hub
->removed_bits
)) {
4752 /* maybe switch power back on (e.g. root hub was reset) */
4753 if ((wHubCharacteristics
& HUB_CHAR_LPSM
) < 2
4754 && !port_is_power_on(hub
, portstatus
))
4755 set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
4757 if (portstatus
& USB_PORT_STAT_ENABLE
)
4761 if (hub_is_superspeed(hub
->hdev
))
4767 for (i
= 0; i
< SET_CONFIG_TRIES
; i
++) {
4769 /* reallocate for each attempt, since references
4770 * to the previous one can escape in various ways
4772 udev
= usb_alloc_dev(hdev
, hdev
->bus
, port1
);
4775 "couldn't allocate port %d usb_device\n",
4780 usb_set_device_state(udev
, USB_STATE_POWERED
);
4781 udev
->bus_mA
= hub
->mA_per_port
;
4782 udev
->level
= hdev
->level
+ 1;
4783 udev
->wusb
= hub_is_wusb(hub
);
4785 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
4786 if (hub_is_superspeed(hub
->hdev
))
4787 udev
->speed
= USB_SPEED_SUPER
;
4789 udev
->speed
= USB_SPEED_UNKNOWN
;
4791 choose_devnum(udev
);
4792 if (udev
->devnum
<= 0) {
4793 status
= -ENOTCONN
; /* Don't retry */
4797 /* reset (non-USB 3.0 devices) and get descriptor */
4799 status
= hub_port_init(hub
, udev
, port1
, i
);
4807 if (udev
->quirks
& USB_QUIRK_DELAY_INIT
)
4810 /* consecutive bus-powered hubs aren't reliable; they can
4811 * violate the voltage drop budget. if the new child has
4812 * a "powered" LED, users should notice we didn't enable it
4813 * (without reading syslog), even without per-port LEDs
4816 if (udev
->descriptor
.bDeviceClass
== USB_CLASS_HUB
4817 && udev
->bus_mA
<= unit_load
) {
4820 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0,
4823 dev_dbg(&udev
->dev
, "get status %d ?\n", status
);
4826 le16_to_cpus(&devstat
);
4827 if ((devstat
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
4829 "can't connect bus-powered hub "
4831 if (hub
->has_indicators
) {
4832 hub
->indicator
[port1
-1] =
4833 INDICATOR_AMBER_BLINK
;
4834 schedule_delayed_work (&hub
->leds
, 0);
4836 status
= -ENOTCONN
; /* Don't retry */
4841 /* check for devices running slower than they could */
4842 if (le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0200
4843 && udev
->speed
== USB_SPEED_FULL
4844 && highspeed_hubs
!= 0)
4845 check_highspeed (hub
, udev
, port1
);
4847 /* Store the parent's children[] pointer. At this point
4848 * udev becomes globally accessible, although presumably
4849 * no one will look at it until hdev is unlocked.
4853 /* We mustn't add new devices if the parent hub has
4854 * been disconnected; we would race with the
4855 * recursively_mark_NOTATTACHED() routine.
4857 spin_lock_irq(&device_state_lock
);
4858 if (hdev
->state
== USB_STATE_NOTATTACHED
)
4861 hub
->ports
[port1
- 1]->child
= udev
;
4862 spin_unlock_irq(&device_state_lock
);
4864 /* Run it through the hoops (find a driver, etc) */
4866 status
= usb_new_device(udev
);
4868 spin_lock_irq(&device_state_lock
);
4869 hub
->ports
[port1
- 1]->child
= NULL
;
4870 spin_unlock_irq(&device_state_lock
);
4872 #ifdef CONFIG_MTK_DT_USB_SUPPORT
4874 MYDBG("get new device !!!, BUILD TIME : %s, g_dsda_dev : %p\n", __TIME__
, g_dsda_dev
);
4881 status
= hub_power_remaining(hub
);
4883 dev_dbg(hub_dev
, "%dmA power budget left\n", status
);
4888 hub_port_disable(hub
, port1
, 1);
4890 usb_ep0_reinit(udev
);
4891 release_devnum(udev
);
4894 if ((status
== -ENOTCONN
) || (status
== -ENOTSUPP
))
4897 if (hub
->hdev
->parent
||
4898 !hcd
->driver
->port_handed_over
||
4899 !(hcd
->driver
->port_handed_over
)(hcd
, port1
)) {
4900 if (status
!= -ENOTCONN
&& status
!= -ENODEV
)
4901 dev_err(hub_dev
, "unable to enumerate USB device on port %d\n",
4906 hub_port_disable(hub
, port1
, 1);
4907 if (hcd
->driver
->relinquish_port
&& !hub
->hdev
->parent
)
4908 hcd
->driver
->relinquish_port(hcd
, port1
);
4911 /* Returns 1 if there was a remote wakeup and a connect status change. */
4912 static int hub_handle_remote_wakeup(struct usb_hub
*hub
, unsigned int port
,
4913 u16 portstatus
, u16 portchange
)
4915 struct usb_device
*hdev
;
4916 struct usb_device
*udev
;
4917 int connect_change
= 0;
4921 udev
= hub
->ports
[port
- 1]->child
;
4922 if (!hub_is_superspeed(hdev
)) {
4923 if (!(portchange
& USB_PORT_STAT_C_SUSPEND
))
4925 usb_clear_port_feature(hdev
, port
, USB_PORT_FEAT_C_SUSPEND
);
4927 if (!udev
|| udev
->state
!= USB_STATE_SUSPENDED
||
4928 (portstatus
& USB_PORT_STAT_LINK_STATE
) !=
4934 /* TRSMRCY = 10 msec */
4937 usb_lock_device(udev
);
4938 ret
= usb_remote_wakeup(udev
);
4939 usb_unlock_device(udev
);
4944 hub_port_disable(hub
, port
, 1);
4946 dev_dbg(hub
->intfdev
, "resume on port %d, status %d\n",
4948 return connect_change
;
4951 static void hub_events(void)
4953 struct list_head
*tmp
;
4954 struct usb_device
*hdev
;
4955 struct usb_interface
*intf
;
4956 struct usb_hub
*hub
;
4957 struct device
*hub_dev
;
4963 int connect_change
, wakeup_change
;
4966 * We restart the list every time to avoid a deadlock with
4967 * deleting hubs downstream from this one. This should be
4968 * safe since we delete the hub from the event list.
4969 * Not the most efficient, but avoids deadlocks.
4973 /* Grab the first entry at the beginning of the list */
4974 spin_lock_irq(&hub_event_lock
);
4975 if (list_empty(&hub_event_list
)) {
4976 spin_unlock_irq(&hub_event_lock
);
4980 tmp
= hub_event_list
.next
;
4983 hub
= list_entry(tmp
, struct usb_hub
, event_list
);
4984 kref_get(&hub
->kref
);
4987 spin_unlock_irq(&hub_event_lock
);
4989 hub_dev
= hub
->intfdev
;
4990 intf
= to_usb_interface(hub_dev
);
4991 dev_dbg(hub_dev
, "state %d ports %d chg %04x evt %04x\n",
4992 hdev
->state
, hub
->descriptor
4993 ? hub
->descriptor
->bNbrPorts
4995 /* NOTE: expects max 15 ports... */
4996 (u16
) hub
->change_bits
[0],
4997 (u16
) hub
->event_bits
[0]);
4999 /* Lock the device, then check to see if we were
5000 * disconnected while waiting for the lock to succeed. */
5001 usb_lock_device(hdev
);
5002 if (unlikely(hub
->disconnected
))
5003 goto loop_disconnected
;
5005 /* If the hub has died, clean up after it */
5006 if (hdev
->state
== USB_STATE_NOTATTACHED
) {
5007 hub
->error
= -ENODEV
;
5008 hub_quiesce(hub
, HUB_DISCONNECT
);
5013 ret
= usb_autopm_get_interface(intf
);
5015 dev_dbg(hub_dev
, "Can't autoresume: %d\n", ret
);
5019 /* If this is an inactive hub, do nothing */
5024 dev_dbg (hub_dev
, "resetting for error %d\n",
5028 ret
= usb_reset_device(hdev
);
5031 "error resetting hub: %d\n", ret
);
5039 /* deal with port status changes */
5040 for (i
= 1; i
<= hub
->descriptor
->bNbrPorts
; i
++) {
5041 if (test_bit(i
, hub
->busy_bits
))
5043 connect_change
= test_bit(i
, hub
->change_bits
);
5044 wakeup_change
= test_and_clear_bit(i
, hub
->wakeup_bits
);
5045 if (!test_and_clear_bit(i
, hub
->event_bits
) &&
5046 !connect_change
&& !wakeup_change
)
5049 ret
= hub_port_status(hub
, i
,
5050 &portstatus
, &portchange
);
5054 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
5055 usb_clear_port_feature(hdev
, i
,
5056 USB_PORT_FEAT_C_CONNECTION
);
5060 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
5061 if (!connect_change
)
5063 "port %d enable change, "
5066 usb_clear_port_feature(hdev
, i
,
5067 USB_PORT_FEAT_C_ENABLE
);
5070 * EM interference sometimes causes badly
5071 * shielded USB devices to be shutdown by
5072 * the hub, this hack enables them again.
5073 * Works at least with mouse driver.
5075 if (!(portstatus
& USB_PORT_STAT_ENABLE
)
5077 && hub
->ports
[i
- 1]->child
) {
5080 "disabled by hub (EMI?), "
5087 if (hub_handle_remote_wakeup(hub
, i
,
5088 portstatus
, portchange
))
5091 if (portchange
& USB_PORT_STAT_C_OVERCURRENT
) {
5095 dev_dbg(hub_dev
, "over-current change on port "
5097 usb_clear_port_feature(hdev
, i
,
5098 USB_PORT_FEAT_C_OVER_CURRENT
);
5099 msleep(100); /* Cool down */
5100 hub_power_on(hub
, true);
5101 hub_port_status(hub
, i
, &status
, &unused
);
5102 if (status
& USB_PORT_STAT_OVERCURRENT
)
5103 dev_err(hub_dev
, "over-current "
5104 "condition on port %d\n", i
);
5107 if (portchange
& USB_PORT_STAT_C_RESET
) {
5109 "reset change on port %d\n",
5111 usb_clear_port_feature(hdev
, i
,
5112 USB_PORT_FEAT_C_RESET
);
5114 if ((portchange
& USB_PORT_STAT_C_BH_RESET
) &&
5115 hub_is_superspeed(hub
->hdev
)) {
5117 "warm reset change on port %d\n",
5119 usb_clear_port_feature(hdev
, i
,
5120 USB_PORT_FEAT_C_BH_PORT_RESET
);
5122 if (portchange
& USB_PORT_STAT_C_LINK_STATE
) {
5123 usb_clear_port_feature(hub
->hdev
, i
,
5124 USB_PORT_FEAT_C_PORT_LINK_STATE
);
5126 if (portchange
& USB_PORT_STAT_C_CONFIG_ERROR
) {
5128 "config error on port %d\n",
5130 usb_clear_port_feature(hub
->hdev
, i
,
5131 USB_PORT_FEAT_C_PORT_CONFIG_ERROR
);
5134 /* Warm reset a USB3 protocol port if it's in
5135 * SS.Inactive state.
5137 if (hub_port_warm_reset_required(hub
, portstatus
)) {
5139 struct usb_device
*udev
=
5140 hub
->ports
[i
- 1]->child
;
5142 dev_dbg(hub_dev
, "warm reset port %d\n", i
);
5144 !(portstatus
& USB_PORT_STAT_CONNECTION
) ||
5145 udev
->state
== USB_STATE_NOTATTACHED
) {
5146 status
= hub_port_reset(hub
, i
,
5147 NULL
, HUB_BH_RESET_TIME
,
5150 hub_port_disable(hub
, i
, 1);
5152 usb_lock_device(udev
);
5153 status
= usb_reset_device(udev
);
5154 usb_unlock_device(udev
);
5160 hub_port_connect_change(hub
, i
,
5161 portstatus
, portchange
);
5164 /* deal with hub status changes */
5165 if (test_and_clear_bit(0, hub
->event_bits
) == 0)
5167 else if (hub_hub_status(hub
, &hubstatus
, &hubchange
) < 0)
5168 dev_err (hub_dev
, "get_hub_status failed\n");
5170 if (hubchange
& HUB_CHANGE_LOCAL_POWER
) {
5171 dev_dbg (hub_dev
, "power change\n");
5172 clear_hub_feature(hdev
, C_HUB_LOCAL_POWER
);
5173 if (hubstatus
& HUB_STATUS_LOCAL_POWER
)
5174 /* FIXME: Is this always true? */
5175 hub
->limited_power
= 1;
5177 hub
->limited_power
= 0;
5179 if (hubchange
& HUB_CHANGE_OVERCURRENT
) {
5183 dev_dbg(hub_dev
, "over-current change\n");
5184 clear_hub_feature(hdev
, C_HUB_OVER_CURRENT
);
5185 msleep(500); /* Cool down */
5186 hub_power_on(hub
, true);
5187 hub_hub_status(hub
, &status
, &unused
);
5188 if (status
& HUB_STATUS_OVERCURRENT
)
5189 dev_err(hub_dev
, "over-current "
5195 /* Balance the usb_autopm_get_interface() above */
5196 usb_autopm_put_interface_no_suspend(intf
);
5198 /* Balance the usb_autopm_get_interface_no_resume() in
5199 * kick_khubd() and allow autosuspend.
5201 usb_autopm_put_interface(intf
);
5203 usb_unlock_device(hdev
);
5205 kref_put(&hub
->kref
, hub_release
);
5207 } /* end while (1) */
5210 static int hub_thread(void *__unused
)
5212 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
5213 * port handover. Otherwise it might see that a full-speed device
5214 * was gone before the EHCI controller had handed its port over to
5215 * the companion full-speed controller.
5221 wait_event_freezable(khubd_wait
,
5222 !list_empty(&hub_event_list
) ||
5223 kthread_should_stop());
5224 } while (!kthread_should_stop() || !list_empty(&hub_event_list
));
5226 pr_debug("%s: khubd exiting\n", usbcore_name
);
5230 static const struct usb_device_id hub_id_table
[] = {
5231 { .match_flags
= USB_DEVICE_ID_MATCH_VENDOR
5232 | USB_DEVICE_ID_MATCH_INT_CLASS
,
5233 .idVendor
= USB_VENDOR_GENESYS_LOGIC
,
5234 .bInterfaceClass
= USB_CLASS_HUB
,
5235 .driver_info
= HUB_QUIRK_CHECK_PORT_AUTOSUSPEND
},
5236 { .match_flags
= USB_DEVICE_ID_MATCH_DEV_CLASS
,
5237 .bDeviceClass
= USB_CLASS_HUB
},
5238 { .match_flags
= USB_DEVICE_ID_MATCH_INT_CLASS
,
5239 .bInterfaceClass
= USB_CLASS_HUB
},
5240 { } /* Terminating entry */
5243 MODULE_DEVICE_TABLE (usb
, hub_id_table
);
5245 static struct usb_driver hub_driver
= {
5248 .disconnect
= hub_disconnect
,
5249 .suspend
= hub_suspend
,
5250 .resume
= hub_resume
,
5251 .reset_resume
= hub_reset_resume
,
5252 .pre_reset
= hub_pre_reset
,
5253 .post_reset
= hub_post_reset
,
5254 .unlocked_ioctl
= hub_ioctl
,
5255 .id_table
= hub_id_table
,
5256 .supports_autosuspend
= 1,
5259 #if defined(CONFIG_MTK_XHCI) && defined(CONFIG_USB_MTK_DUALMODE)
5260 extern void mtk_hub_event_steal(spinlock_t
*lock
, struct list_head
* list
);
5262 int usb_hub_init(void)
5264 if (usb_register(&hub_driver
) < 0) {
5265 printk(KERN_ERR
"%s: can't register hub driver\n",
5270 #if defined(CONFIG_MTK_XHCI) && defined(CONFIG_USB_MTK_DUALMODE)
5271 mtk_hub_event_steal(&hub_event_lock
, &hub_event_list
);
5274 khubd_task
= kthread_run(hub_thread
, NULL
, "khubd");
5275 if (!IS_ERR(khubd_task
))
5278 /* Fall through if kernel_thread failed */
5279 usb_deregister(&hub_driver
);
5280 printk(KERN_ERR
"%s: can't start khubd\n", usbcore_name
);
5285 void usb_hub_cleanup(void)
5287 kthread_stop(khubd_task
);
5290 * Hub resources are freed for us by usb_deregister. It calls
5291 * usb_driver_purge on every device which in turn calls that
5292 * devices disconnect function if it is using this driver.
5293 * The hub_disconnect function takes care of releasing the
5294 * individual hub resources. -greg
5296 usb_deregister(&hub_driver
);
5297 } /* usb_hub_cleanup() */
5299 static int descriptors_changed(struct usb_device
*udev
,
5300 struct usb_device_descriptor
*old_device_descriptor
)
5304 unsigned serial_len
= 0;
5306 unsigned old_length
;
5310 if (memcmp(&udev
->descriptor
, old_device_descriptor
,
5311 sizeof(*old_device_descriptor
)) != 0)
5314 /* Since the idVendor, idProduct, and bcdDevice values in the
5315 * device descriptor haven't changed, we will assume the
5316 * Manufacturer and Product strings haven't changed either.
5317 * But the SerialNumber string could be different (e.g., a
5318 * different flash card of the same brand).
5321 serial_len
= strlen(udev
->serial
) + 1;
5324 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
5325 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
5326 len
= max(len
, old_length
);
5329 buf
= kmalloc(len
, GFP_NOIO
);
5331 dev_err(&udev
->dev
, "no mem to re-read configs after reset\n");
5332 /* assume the worst */
5335 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
5336 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
5337 length
= usb_get_descriptor(udev
, USB_DT_CONFIG
, index
, buf
,
5339 if (length
!= old_length
) {
5340 dev_dbg(&udev
->dev
, "config index %d, error %d\n",
5345 if (memcmp (buf
, udev
->rawdescriptors
[index
], old_length
)
5347 dev_dbg(&udev
->dev
, "config index %d changed (#%d)\n",
5349 ((struct usb_config_descriptor
*) buf
)->
5350 bConfigurationValue
);
5356 if (!changed
&& serial_len
) {
5357 length
= usb_string(udev
, udev
->descriptor
.iSerialNumber
,
5359 if (length
+ 1 != serial_len
) {
5360 dev_dbg(&udev
->dev
, "serial string error %d\n",
5363 } else if (memcmp(buf
, udev
->serial
, length
) != 0) {
5364 dev_dbg(&udev
->dev
, "serial string changed\n");
5374 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5375 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5377 * WARNING - don't use this routine to reset a composite device
5378 * (one with multiple interfaces owned by separate drivers)!
5379 * Use usb_reset_device() instead.
5381 * Do a port reset, reassign the device's address, and establish its
5382 * former operating configuration. If the reset fails, or the device's
5383 * descriptors change from their values before the reset, or the original
5384 * configuration and altsettings cannot be restored, a flag will be set
5385 * telling khubd to pretend the device has been disconnected and then
5386 * re-connected. All drivers will be unbound, and the device will be
5387 * re-enumerated and probed all over again.
5389 * Returns 0 if the reset succeeded, -ENODEV if the device has been
5390 * flagged for logical disconnection, or some other negative error code
5391 * if the reset wasn't even attempted.
5393 * The caller must own the device lock. For example, it's safe to use
5394 * this from a driver probe() routine after downloading new firmware.
5395 * For calls that might not occur during probe(), drivers should lock
5396 * the device using usb_lock_device_for_reset().
5398 * Locking exception: This routine may also be called from within an
5399 * autoresume handler. Such usage won't conflict with other tasks
5400 * holding the device lock because these tasks should always call
5401 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
5403 static int usb_reset_and_verify_device(struct usb_device
*udev
)
5405 struct usb_device
*parent_hdev
= udev
->parent
;
5406 struct usb_hub
*parent_hub
;
5407 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
5408 struct usb_device_descriptor descriptor
= udev
->descriptor
;
5410 int port1
= udev
->portnum
;
5413 if (udev
->state
== USB_STATE_NOTATTACHED
||
5414 udev
->state
== USB_STATE_SUSPENDED
) {
5415 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
5421 /* this requires hcd-specific logic; see ohci_restart() */
5422 dev_dbg(&udev
->dev
, "%s for root hub!\n", __func__
);
5425 parent_hub
= usb_hub_to_struct_hub(parent_hdev
);
5427 /* Disable LPM and LTM while we reset the device and reinstall the alt
5428 * settings. Device-initiated LPM settings, and system exit latency
5429 * settings are cleared when the device is reset, so we have to set
5432 ret
= usb_unlocked_disable_lpm(udev
);
5434 dev_err(&udev
->dev
, "%s Failed to disable LPM\n.", __func__
);
5437 ret
= usb_disable_ltm(udev
);
5439 dev_err(&udev
->dev
, "%s Failed to disable LTM\n.",
5444 set_bit(port1
, parent_hub
->busy_bits
);
5445 for (i
= 0; i
< SET_CONFIG_TRIES
; ++i
) {
5447 /* ep0 maxpacket size may change; let the HCD know about it.
5448 * Other endpoints will be handled by re-enumeration. */
5449 usb_ep0_reinit(udev
);
5450 ret
= hub_port_init(parent_hub
, udev
, port1
, i
);
5451 if (ret
>= 0 || ret
== -ENOTCONN
|| ret
== -ENODEV
)
5454 clear_bit(port1
, parent_hub
->busy_bits
);
5459 /* Device might have changed firmware (DFU or similar) */
5460 if (descriptors_changed(udev
, &descriptor
)) {
5461 dev_info(&udev
->dev
, "device firmware changed\n");
5462 udev
->descriptor
= descriptor
; /* for disconnect() calls */
5466 /* Restore the device's previous configuration */
5467 if (!udev
->actconfig
)
5470 mutex_lock(hcd
->bandwidth_mutex
);
5471 ret
= usb_hcd_alloc_bandwidth(udev
, udev
->actconfig
, NULL
, NULL
);
5473 dev_warn(&udev
->dev
,
5474 "Busted HC? Not enough HCD resources for "
5475 "old configuration.\n");
5476 mutex_unlock(hcd
->bandwidth_mutex
);
5479 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
5480 USB_REQ_SET_CONFIGURATION
, 0,
5481 udev
->actconfig
->desc
.bConfigurationValue
, 0,
5482 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
5485 "can't restore configuration #%d (error=%d)\n",
5486 udev
->actconfig
->desc
.bConfigurationValue
, ret
);
5487 mutex_unlock(hcd
->bandwidth_mutex
);
5490 mutex_unlock(hcd
->bandwidth_mutex
);
5491 usb_set_device_state(udev
, USB_STATE_CONFIGURED
);
5493 /* Put interfaces back into the same altsettings as before.
5494 * Don't bother to send the Set-Interface request for interfaces
5495 * that were already in altsetting 0; besides being unnecessary,
5496 * many devices can't handle it. Instead just reset the host-side
5499 for (i
= 0; i
< udev
->actconfig
->desc
.bNumInterfaces
; i
++) {
5500 struct usb_host_config
*config
= udev
->actconfig
;
5501 struct usb_interface
*intf
= config
->interface
[i
];
5502 struct usb_interface_descriptor
*desc
;
5504 desc
= &intf
->cur_altsetting
->desc
;
5505 if (desc
->bAlternateSetting
== 0) {
5506 usb_disable_interface(udev
, intf
, true);
5507 usb_enable_interface(udev
, intf
, true);
5510 /* Let the bandwidth allocation function know that this
5511 * device has been reset, and it will have to use
5512 * alternate setting 0 as the current alternate setting.
5514 intf
->resetting_device
= 1;
5515 ret
= usb_set_interface(udev
, desc
->bInterfaceNumber
,
5516 desc
->bAlternateSetting
);
5517 intf
->resetting_device
= 0;
5520 dev_err(&udev
->dev
, "failed to restore interface %d "
5521 "altsetting %d (error=%d)\n",
5522 desc
->bInterfaceNumber
,
5523 desc
->bAlternateSetting
,
5530 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5531 usb_unlocked_enable_lpm(udev
);
5532 usb_enable_ltm(udev
);
5536 /* LPM state doesn't matter when we're about to destroy the device. */
5537 hub_port_logical_disconnect(parent_hub
, port1
);
5542 * usb_reset_device - warn interface drivers and perform a USB port reset
5543 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5545 * Warns all drivers bound to registered interfaces (using their pre_reset
5546 * method), performs the port reset, and then lets the drivers know that
5547 * the reset is over (using their post_reset method).
5549 * Return value is the same as for usb_reset_and_verify_device().
5551 * The caller must own the device lock. For example, it's safe to use
5552 * this from a driver probe() routine after downloading new firmware.
5553 * For calls that might not occur during probe(), drivers should lock
5554 * the device using usb_lock_device_for_reset().
5556 * If an interface is currently being probed or disconnected, we assume
5557 * its driver knows how to handle resets. For all other interfaces,
5558 * if the driver doesn't have pre_reset and post_reset methods then
5559 * we attempt to unbind it and rebind afterward.
5561 int usb_reset_device(struct usb_device
*udev
)
5565 unsigned int noio_flag
;
5566 struct usb_host_config
*config
= udev
->actconfig
;
5569 if (udev
->state
== USB_STATE_NOTATTACHED
||
5570 udev
->state
== USB_STATE_SUSPENDED
) {
5571 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
5577 * Don't allocate memory with GFP_KERNEL in current
5578 * context to avoid possible deadlock if usb mass
5579 * storage interface or usbnet interface(iSCSI case)
5580 * is included in current configuration. The easist
5581 * approach is to do it for every device reset,
5582 * because the device 'memalloc_noio' flag may have
5583 * not been set before reseting the usb device.
5585 noio_flag
= memalloc_noio_save();
5587 /* Prevent autosuspend during the reset */
5588 usb_autoresume_device(udev
);
5591 for (i
= 0; i
< config
->desc
.bNumInterfaces
; ++i
) {
5592 struct usb_interface
*cintf
= config
->interface
[i
];
5593 struct usb_driver
*drv
;
5596 if (cintf
->dev
.driver
) {
5597 drv
= to_usb_driver(cintf
->dev
.driver
);
5598 if (drv
->pre_reset
&& drv
->post_reset
)
5599 unbind
= (drv
->pre_reset
)(cintf
);
5600 else if (cintf
->condition
==
5601 USB_INTERFACE_BOUND
)
5604 usb_forced_unbind_intf(cintf
);
5609 ret
= usb_reset_and_verify_device(udev
);
5612 for (i
= config
->desc
.bNumInterfaces
- 1; i
>= 0; --i
) {
5613 struct usb_interface
*cintf
= config
->interface
[i
];
5614 struct usb_driver
*drv
;
5615 int rebind
= cintf
->needs_binding
;
5617 if (!rebind
&& cintf
->dev
.driver
) {
5618 drv
= to_usb_driver(cintf
->dev
.driver
);
5619 if (drv
->post_reset
)
5620 rebind
= (drv
->post_reset
)(cintf
);
5621 else if (cintf
->condition
==
5622 USB_INTERFACE_BOUND
)
5625 cintf
->needs_binding
= 1;
5628 usb_unbind_and_rebind_marked_interfaces(udev
);
5631 usb_autosuspend_device(udev
);
5632 memalloc_noio_restore(noio_flag
);
5635 EXPORT_SYMBOL_GPL(usb_reset_device
);
5639 * usb_queue_reset_device - Reset a USB device from an atomic context
5640 * @iface: USB interface belonging to the device to reset
5642 * This function can be used to reset a USB device from an atomic
5643 * context, where usb_reset_device() won't work (as it blocks).
5645 * Doing a reset via this method is functionally equivalent to calling
5646 * usb_reset_device(), except for the fact that it is delayed to a
5647 * workqueue. This means that any drivers bound to other interfaces
5648 * might be unbound, as well as users from usbfs in user space.
5652 * - Scheduling two resets at the same time from two different drivers
5653 * attached to two different interfaces of the same device is
5654 * possible; depending on how the driver attached to each interface
5655 * handles ->pre_reset(), the second reset might happen or not.
5657 * - If a driver is unbound and it had a pending reset, the reset will
5660 * - This function can be called during .probe() or .disconnect()
5661 * times. On return from .disconnect(), any pending resets will be
5664 * There is no no need to lock/unlock the @reset_ws as schedule_work()
5667 * NOTE: We don't do any reference count tracking because it is not
5668 * needed. The lifecycle of the work_struct is tied to the
5669 * usb_interface. Before destroying the interface we cancel the
5670 * work_struct, so the fact that work_struct is queued and or
5671 * running means the interface (and thus, the device) exist and
5674 void usb_queue_reset_device(struct usb_interface
*iface
)
5676 schedule_work(&iface
->reset_ws
);
5678 EXPORT_SYMBOL_GPL(usb_queue_reset_device
);
5681 * usb_hub_find_child - Get the pointer of child device
5682 * attached to the port which is specified by @port1.
5683 * @hdev: USB device belonging to the usb hub
5684 * @port1: port num to indicate which port the child device
5687 * USB drivers call this function to get hub's child device
5690 * Return NULL if input param is invalid and
5691 * child's usb_device pointer if non-NULL.
5693 struct usb_device
*usb_hub_find_child(struct usb_device
*hdev
,
5696 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5698 if (port1
< 1 || port1
> hdev
->maxchild
)
5700 return hub
->ports
[port1
- 1]->child
;
5702 EXPORT_SYMBOL_GPL(usb_hub_find_child
);
5705 * usb_set_hub_port_connect_type - set hub port connect type.
5706 * @hdev: USB device belonging to the usb hub
5707 * @port1: port num of the port
5708 * @type: connect type of the port
5710 void usb_set_hub_port_connect_type(struct usb_device
*hdev
, int port1
,
5711 enum usb_port_connect_type type
)
5713 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5715 hub
->ports
[port1
- 1]->connect_type
= type
;
5719 * usb_get_hub_port_connect_type - Get the port's connect type
5720 * @hdev: USB device belonging to the usb hub
5721 * @port1: port num of the port
5723 * Return connect type of the port and if input params are
5724 * invalid, return USB_PORT_CONNECT_TYPE_UNKNOWN.
5726 enum usb_port_connect_type
5727 usb_get_hub_port_connect_type(struct usb_device
*hdev
, int port1
)
5729 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5731 return hub
->ports
[port1
- 1]->connect_type
;
5734 void usb_hub_adjust_deviceremovable(struct usb_device
*hdev
,
5735 struct usb_hub_descriptor
*desc
)
5737 enum usb_port_connect_type connect_type
;
5740 if (!hub_is_superspeed(hdev
)) {
5741 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
5742 connect_type
= usb_get_hub_port_connect_type(hdev
, i
);
5744 if (connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
5745 u8 mask
= 1 << (i
%8);
5747 if (!(desc
->u
.hs
.DeviceRemovable
[i
/8] & mask
)) {
5748 dev_dbg(&hdev
->dev
, "usb port%d's DeviceRemovable is changed to 1 according to platform information.\n",
5750 desc
->u
.hs
.DeviceRemovable
[i
/8] |= mask
;
5755 u16 port_removable
= le16_to_cpu(desc
->u
.ss
.DeviceRemovable
);
5757 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
5758 connect_type
= usb_get_hub_port_connect_type(hdev
, i
);
5760 if (connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
5763 if (!(port_removable
& mask
)) {
5764 dev_dbg(&hdev
->dev
, "usb port%d's DeviceRemovable is changed to 1 according to platform information.\n",
5766 port_removable
|= mask
;
5771 desc
->u
.ss
.DeviceRemovable
= cpu_to_le16(port_removable
);
5777 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5778 * @hdev: USB device belonging to the usb hub
5779 * @port1: port num of the port
5781 * Return port's acpi handle if successful, NULL if params are
5784 acpi_handle
usb_get_hub_port_acpi_handle(struct usb_device
*hdev
,
5787 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5789 return DEVICE_ACPI_HANDLE(&hub
->ports
[port1
- 1]->dev
);