xref: /openbmc/linux/drivers/usb/core/hub.c (revision b2a542bb)
11da177e4SLinus Torvalds /*
21da177e4SLinus Torvalds  * USB hub driver.
31da177e4SLinus Torvalds  *
41da177e4SLinus Torvalds  * (C) Copyright 1999 Linus Torvalds
51da177e4SLinus Torvalds  * (C) Copyright 1999 Johannes Erdfelt
61da177e4SLinus Torvalds  * (C) Copyright 1999 Gregory P. Smith
71da177e4SLinus Torvalds  * (C) Copyright 2001 Brad Hards (bhards@bigpond.net.au)
81da177e4SLinus Torvalds  *
9b65fba3dSGreg Kroah-Hartman  * Released under the GPLv2 only.
10b65fba3dSGreg Kroah-Hartman  * SPDX-License-Identifier: GPL-2.0
111da177e4SLinus Torvalds  */
121da177e4SLinus Torvalds 
131da177e4SLinus Torvalds #include <linux/kernel.h>
141da177e4SLinus Torvalds #include <linux/errno.h>
151da177e4SLinus Torvalds #include <linux/module.h>
161da177e4SLinus Torvalds #include <linux/moduleparam.h>
171da177e4SLinus Torvalds #include <linux/completion.h>
185b3cc15aSIngo Molnar #include <linux/sched/mm.h>
191da177e4SLinus Torvalds #include <linux/list.h>
201da177e4SLinus Torvalds #include <linux/slab.h>
211da177e4SLinus Torvalds #include <linux/ioctl.h>
221da177e4SLinus Torvalds #include <linux/usb.h>
231da177e4SLinus Torvalds #include <linux/usbdevice_fs.h>
2427729aadSEric Lescouet #include <linux/usb/hcd.h>
25925aa46bSRichard Zhao #include <linux/usb/otg.h>
2693362a87SPhil Dibowitz #include <linux/usb/quirks.h>
2732a69589SPetr Mladek #include <linux/workqueue.h>
284186ecf8SArjan van de Ven #include <linux/mutex.h>
29b04b3156STheodore Ts'o #include <linux/random.h>
30ad493e5eSLan Tianyu #include <linux/pm_qos.h>
311da177e4SLinus Torvalds 
327c0f6ba6SLinus Torvalds #include <linux/uaccess.h>
331da177e4SLinus Torvalds #include <asm/byteorder.h>
341da177e4SLinus Torvalds 
356e30d7cbSLan Tianyu #include "hub.h"
36026f3fcbSPeter Chen #include "otg_whitelist.h"
371da177e4SLinus Torvalds 
38e6f30deaSMing Lei #define USB_VENDOR_GENESYS_LOGIC		0x05e3
39e6f30deaSMing Lei #define HUB_QUIRK_CHECK_PORT_AUTOSUSPEND	0x01
40e6f30deaSMing Lei 
41fa286188SGreg Kroah-Hartman /* Protect struct usb_device->state and ->children members
429ad3d6ccSAlan Stern  * Note: Both are also protected by ->dev.sem, except that ->state can
431da177e4SLinus Torvalds  * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
441da177e4SLinus Torvalds static DEFINE_SPINLOCK(device_state_lock);
451da177e4SLinus Torvalds 
4632a69589SPetr Mladek /* workqueue to process hub events */
4732a69589SPetr Mladek static struct workqueue_struct *hub_wq;
4832a69589SPetr Mladek static void hub_event(struct work_struct *work);
491da177e4SLinus Torvalds 
50d8521afeSDan Williams /* synchronize hub-port add/remove and peering operations */
51d8521afeSDan Williams DEFINE_MUTEX(usb_port_peer_mutex);
52d8521afeSDan Williams 
531da177e4SLinus Torvalds /* cycle leds on hubs that aren't blinking for attention */
54a44007a4SSaurabh Sengar static bool blinkenlights;
551da177e4SLinus Torvalds module_param(blinkenlights, bool, S_IRUGO);
561da177e4SLinus Torvalds MODULE_PARM_DESC(blinkenlights, "true to cycle leds on hubs");
571da177e4SLinus Torvalds 
581da177e4SLinus Torvalds /*
59fd7c519dSJaroslav Kysela  * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
60fd7c519dSJaroslav Kysela  * 10 seconds to send reply for the initial 64-byte descriptor request.
61fd7c519dSJaroslav Kysela  */
62fd7c519dSJaroslav Kysela /* define initial 64-byte descriptor request timeout in milliseconds */
63fd7c519dSJaroslav Kysela static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
64fd7c519dSJaroslav Kysela module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
65b9cef6c3SWu Fengguang MODULE_PARM_DESC(initial_descriptor_timeout,
66b9cef6c3SWu Fengguang 		"initial 64-byte descriptor request timeout in milliseconds "
67b9cef6c3SWu Fengguang 		"(default 5000 - 5.0 seconds)");
68fd7c519dSJaroslav Kysela 
69fd7c519dSJaroslav Kysela /*
701da177e4SLinus Torvalds  * As of 2.6.10 we introduce a new USB device initialization scheme which
711da177e4SLinus Torvalds  * closely resembles the way Windows works.  Hopefully it will be compatible
721da177e4SLinus Torvalds  * with a wider range of devices than the old scheme.  However some previously
731da177e4SLinus Torvalds  * working devices may start giving rise to "device not accepting address"
741da177e4SLinus Torvalds  * errors; if that happens the user can try the old scheme by adjusting the
751da177e4SLinus Torvalds  * following module parameters.
761da177e4SLinus Torvalds  *
771da177e4SLinus Torvalds  * For maximum flexibility there are two boolean parameters to control the
781da177e4SLinus Torvalds  * hub driver's behavior.  On the first initialization attempt, if the
791da177e4SLinus Torvalds  * "old_scheme_first" parameter is set then the old scheme will be used,
801da177e4SLinus Torvalds  * otherwise the new scheme is used.  If that fails and "use_both_schemes"
811da177e4SLinus Torvalds  * is set, then the driver will make another attempt, using the other scheme.
821da177e4SLinus Torvalds  */
83a44007a4SSaurabh Sengar static bool old_scheme_first;
841da177e4SLinus Torvalds module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
851da177e4SLinus Torvalds MODULE_PARM_DESC(old_scheme_first,
861da177e4SLinus Torvalds 		 "start with the old device initialization scheme");
871da177e4SLinus Torvalds 
8890ab5ee9SRusty Russell static bool use_both_schemes = 1;
891da177e4SLinus Torvalds module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
901da177e4SLinus Torvalds MODULE_PARM_DESC(use_both_schemes,
911da177e4SLinus Torvalds 		"try the other device initialization scheme if the "
921da177e4SLinus Torvalds 		"first one fails");
931da177e4SLinus Torvalds 
9432fe0198SAlan Stern /* Mutual exclusion for EHCI CF initialization.  This interferes with
9532fe0198SAlan Stern  * port reset on some companion controllers.
9632fe0198SAlan Stern  */
9732fe0198SAlan Stern DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
9832fe0198SAlan Stern EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
9932fe0198SAlan Stern 
100ad493e5eSLan Tianyu #define HUB_DEBOUNCE_TIMEOUT	2000
101948fea37SAlan Stern #define HUB_DEBOUNCE_STEP	  25
102948fea37SAlan Stern #define HUB_DEBOUNCE_STABLE	 100
103948fea37SAlan Stern 
10432a69589SPetr Mladek static void hub_release(struct kref *kref);
105742120c6SMing Lei static int usb_reset_and_verify_device(struct usb_device *udev);
1063bc02bceSGeert Uytterhoeven static int hub_port_disable(struct usb_hub *hub, int port1, int set_state);
107742120c6SMing Lei 
108131dec34SSarah Sharp static inline char *portspeed(struct usb_hub *hub, int portstatus)
1091da177e4SLinus Torvalds {
110d64aab0cSOliver Neukum 	if (hub_is_superspeedplus(hub->hdev))
111d64aab0cSOliver Neukum 		return "10.0 Gb/s";
112131dec34SSarah Sharp 	if (hub_is_superspeed(hub->hdev))
113131dec34SSarah Sharp 		return "5.0 Gb/s";
114288ead45SAlan Stern 	if (portstatus & USB_PORT_STAT_HIGH_SPEED)
1151da177e4SLinus Torvalds 		return "480 Mb/s";
116288ead45SAlan Stern 	else if (portstatus & USB_PORT_STAT_LOW_SPEED)
1171da177e4SLinus Torvalds 		return "1.5 Mb/s";
1181da177e4SLinus Torvalds 	else
1191da177e4SLinus Torvalds 		return "12 Mb/s";
1201da177e4SLinus Torvalds }
1211da177e4SLinus Torvalds 
1221da177e4SLinus Torvalds /* Note that hdev or one of its children must be locked! */
123ad493e5eSLan Tianyu struct usb_hub *usb_hub_to_struct_hub(struct usb_device *hdev)
1241da177e4SLinus Torvalds {
125ff823c79SLan Tianyu 	if (!hdev || !hdev->actconfig || !hdev->maxchild)
12625118084SAlan Stern 		return NULL;
1271da177e4SLinus Torvalds 	return usb_get_intfdata(hdev->actconfig->interface[0]);
1281da177e4SLinus Torvalds }
1291da177e4SLinus Torvalds 
1302d2a3167SLu Baolu int usb_device_supports_lpm(struct usb_device *udev)
131d9b2099cSSarah Sharp {
132ad87e032SAlan Stern 	/* Some devices have trouble with LPM */
133ad87e032SAlan Stern 	if (udev->quirks & USB_QUIRK_NO_LPM)
134ad87e032SAlan Stern 		return 0;
135ad87e032SAlan Stern 
136d9b2099cSSarah Sharp 	/* USB 2.1 (and greater) devices indicate LPM support through
137d9b2099cSSarah Sharp 	 * their USB 2.0 Extended Capabilities BOS descriptor.
138d9b2099cSSarah Sharp 	 */
139a8425292SRupesh Tatiya 	if (udev->speed == USB_SPEED_HIGH || udev->speed == USB_SPEED_FULL) {
140d9b2099cSSarah Sharp 		if (udev->bos->ext_cap &&
141d9b2099cSSarah Sharp 			(USB_LPM_SUPPORT &
142d9b2099cSSarah Sharp 			 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
143d9b2099cSSarah Sharp 			return 1;
144d9b2099cSSarah Sharp 		return 0;
145d9b2099cSSarah Sharp 	}
14651e0a012SSarah Sharp 
14725cd2882SSarah Sharp 	/*
14825cd2882SSarah Sharp 	 * According to the USB 3.0 spec, all USB 3.0 devices must support LPM.
14925cd2882SSarah Sharp 	 * However, there are some that don't, and they set the U1/U2 exit
15025cd2882SSarah Sharp 	 * latencies to zero.
15151e0a012SSarah Sharp 	 */
15251e0a012SSarah Sharp 	if (!udev->bos->ss_cap) {
15325cd2882SSarah Sharp 		dev_info(&udev->dev, "No LPM exit latency info found, disabling LPM.\n");
154d9b2099cSSarah Sharp 		return 0;
155d9b2099cSSarah Sharp 	}
15651e0a012SSarah Sharp 
15725cd2882SSarah Sharp 	if (udev->bos->ss_cap->bU1devExitLat == 0 &&
15825cd2882SSarah Sharp 			udev->bos->ss_cap->bU2DevExitLat == 0) {
15925cd2882SSarah Sharp 		if (udev->parent)
16025cd2882SSarah Sharp 			dev_info(&udev->dev, "LPM exit latency is zeroed, disabling LPM.\n");
16125cd2882SSarah Sharp 		else
16225cd2882SSarah Sharp 			dev_info(&udev->dev, "We don't know the algorithms for LPM for this host, disabling LPM.\n");
16325cd2882SSarah Sharp 		return 0;
16425cd2882SSarah Sharp 	}
16525cd2882SSarah Sharp 
16625cd2882SSarah Sharp 	if (!udev->parent || udev->parent->lpm_capable)
16725cd2882SSarah Sharp 		return 1;
16851e0a012SSarah Sharp 	return 0;
16951e0a012SSarah Sharp }
17051e0a012SSarah Sharp 
17151e0a012SSarah Sharp /*
17251e0a012SSarah Sharp  * Set the Maximum Exit Latency (MEL) for the host to initiate a transition from
17351e0a012SSarah Sharp  * either U1 or U2.
17451e0a012SSarah Sharp  */
17551e0a012SSarah Sharp static void usb_set_lpm_mel(struct usb_device *udev,
17651e0a012SSarah Sharp 		struct usb3_lpm_parameters *udev_lpm_params,
17751e0a012SSarah Sharp 		unsigned int udev_exit_latency,
17851e0a012SSarah Sharp 		struct usb_hub *hub,
17951e0a012SSarah Sharp 		struct usb3_lpm_parameters *hub_lpm_params,
18051e0a012SSarah Sharp 		unsigned int hub_exit_latency)
18151e0a012SSarah Sharp {
18251e0a012SSarah Sharp 	unsigned int total_mel;
18351e0a012SSarah Sharp 	unsigned int device_mel;
18451e0a012SSarah Sharp 	unsigned int hub_mel;
18551e0a012SSarah Sharp 
18651e0a012SSarah Sharp 	/*
18751e0a012SSarah Sharp 	 * Calculate the time it takes to transition all links from the roothub
18851e0a012SSarah Sharp 	 * to the parent hub into U0.  The parent hub must then decode the
18951e0a012SSarah Sharp 	 * packet (hub header decode latency) to figure out which port it was
19051e0a012SSarah Sharp 	 * bound for.
19151e0a012SSarah Sharp 	 *
19251e0a012SSarah Sharp 	 * The Hub Header decode latency is expressed in 0.1us intervals (0x1
19351e0a012SSarah Sharp 	 * means 0.1us).  Multiply that by 100 to get nanoseconds.
19451e0a012SSarah Sharp 	 */
19551e0a012SSarah Sharp 	total_mel = hub_lpm_params->mel +
19651e0a012SSarah Sharp 		(hub->descriptor->u.ss.bHubHdrDecLat * 100);
19751e0a012SSarah Sharp 
19851e0a012SSarah Sharp 	/*
19951e0a012SSarah Sharp 	 * How long will it take to transition the downstream hub's port into
20051e0a012SSarah Sharp 	 * U0?  The greater of either the hub exit latency or the device exit
20151e0a012SSarah Sharp 	 * latency.
20251e0a012SSarah Sharp 	 *
20351e0a012SSarah Sharp 	 * The BOS U1/U2 exit latencies are expressed in 1us intervals.
20451e0a012SSarah Sharp 	 * Multiply that by 1000 to get nanoseconds.
20551e0a012SSarah Sharp 	 */
20651e0a012SSarah Sharp 	device_mel = udev_exit_latency * 1000;
20751e0a012SSarah Sharp 	hub_mel = hub_exit_latency * 1000;
20851e0a012SSarah Sharp 	if (device_mel > hub_mel)
20951e0a012SSarah Sharp 		total_mel += device_mel;
21051e0a012SSarah Sharp 	else
21151e0a012SSarah Sharp 		total_mel += hub_mel;
21251e0a012SSarah Sharp 
21351e0a012SSarah Sharp 	udev_lpm_params->mel = total_mel;
21451e0a012SSarah Sharp }
21551e0a012SSarah Sharp 
21651e0a012SSarah Sharp /*
21751e0a012SSarah Sharp  * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
21851e0a012SSarah Sharp  * a transition from either U1 or U2.
21951e0a012SSarah Sharp  */
22051e0a012SSarah Sharp static void usb_set_lpm_pel(struct usb_device *udev,
22151e0a012SSarah Sharp 		struct usb3_lpm_parameters *udev_lpm_params,
22251e0a012SSarah Sharp 		unsigned int udev_exit_latency,
22351e0a012SSarah Sharp 		struct usb_hub *hub,
22451e0a012SSarah Sharp 		struct usb3_lpm_parameters *hub_lpm_params,
22551e0a012SSarah Sharp 		unsigned int hub_exit_latency,
22651e0a012SSarah Sharp 		unsigned int port_to_port_exit_latency)
22751e0a012SSarah Sharp {
22851e0a012SSarah Sharp 	unsigned int first_link_pel;
22951e0a012SSarah Sharp 	unsigned int hub_pel;
23051e0a012SSarah Sharp 
23151e0a012SSarah Sharp 	/*
23251e0a012SSarah Sharp 	 * First, the device sends an LFPS to transition the link between the
23351e0a012SSarah Sharp 	 * device and the parent hub into U0.  The exit latency is the bigger of
23451e0a012SSarah Sharp 	 * the device exit latency or the hub exit latency.
23551e0a012SSarah Sharp 	 */
23651e0a012SSarah Sharp 	if (udev_exit_latency > hub_exit_latency)
23751e0a012SSarah Sharp 		first_link_pel = udev_exit_latency * 1000;
23851e0a012SSarah Sharp 	else
23951e0a012SSarah Sharp 		first_link_pel = hub_exit_latency * 1000;
24051e0a012SSarah Sharp 
24151e0a012SSarah Sharp 	/*
24251e0a012SSarah Sharp 	 * When the hub starts to receive the LFPS, there is a slight delay for
24351e0a012SSarah Sharp 	 * it to figure out that one of the ports is sending an LFPS.  Then it
24451e0a012SSarah Sharp 	 * will forward the LFPS to its upstream link.  The exit latency is the
24551e0a012SSarah Sharp 	 * delay, plus the PEL that we calculated for this hub.
24651e0a012SSarah Sharp 	 */
24751e0a012SSarah Sharp 	hub_pel = port_to_port_exit_latency * 1000 + hub_lpm_params->pel;
24851e0a012SSarah Sharp 
24951e0a012SSarah Sharp 	/*
25051e0a012SSarah Sharp 	 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
25151e0a012SSarah Sharp 	 * is the greater of the two exit latencies.
25251e0a012SSarah Sharp 	 */
25351e0a012SSarah Sharp 	if (first_link_pel > hub_pel)
25451e0a012SSarah Sharp 		udev_lpm_params->pel = first_link_pel;
25551e0a012SSarah Sharp 	else
25651e0a012SSarah Sharp 		udev_lpm_params->pel = hub_pel;
25751e0a012SSarah Sharp }
25851e0a012SSarah Sharp 
25951e0a012SSarah Sharp /*
26051e0a012SSarah Sharp  * Set the System Exit Latency (SEL) to indicate the total worst-case time from
26151e0a012SSarah Sharp  * when a device initiates a transition to U0, until when it will receive the
26251e0a012SSarah Sharp  * first packet from the host controller.
26351e0a012SSarah Sharp  *
26451e0a012SSarah Sharp  * Section C.1.5.1 describes the four components to this:
26551e0a012SSarah Sharp  *  - t1: device PEL
26651e0a012SSarah Sharp  *  - t2: time for the ERDY to make it from the device to the host.
26751e0a012SSarah Sharp  *  - t3: a host-specific delay to process the ERDY.
26851e0a012SSarah Sharp  *  - t4: time for the packet to make it from the host to the device.
26951e0a012SSarah Sharp  *
27051e0a012SSarah Sharp  * t3 is specific to both the xHCI host and the platform the host is integrated
27151e0a012SSarah Sharp  * into.  The Intel HW folks have said it's negligible, FIXME if a different
27251e0a012SSarah Sharp  * vendor says otherwise.
27351e0a012SSarah Sharp  */
27451e0a012SSarah Sharp static void usb_set_lpm_sel(struct usb_device *udev,
27551e0a012SSarah Sharp 		struct usb3_lpm_parameters *udev_lpm_params)
27651e0a012SSarah Sharp {
27751e0a012SSarah Sharp 	struct usb_device *parent;
27851e0a012SSarah Sharp 	unsigned int num_hubs;
27951e0a012SSarah Sharp 	unsigned int total_sel;
28051e0a012SSarah Sharp 
28151e0a012SSarah Sharp 	/* t1 = device PEL */
28251e0a012SSarah Sharp 	total_sel = udev_lpm_params->pel;
28351e0a012SSarah Sharp 	/* How many external hubs are in between the device & the root port. */
28451e0a012SSarah Sharp 	for (parent = udev->parent, num_hubs = 0; parent->parent;
28551e0a012SSarah Sharp 			parent = parent->parent)
28651e0a012SSarah Sharp 		num_hubs++;
28751e0a012SSarah Sharp 	/* t2 = 2.1us + 250ns * (num_hubs - 1) */
28851e0a012SSarah Sharp 	if (num_hubs > 0)
28951e0a012SSarah Sharp 		total_sel += 2100 + 250 * (num_hubs - 1);
29051e0a012SSarah Sharp 
29151e0a012SSarah Sharp 	/* t4 = 250ns * num_hubs */
29251e0a012SSarah Sharp 	total_sel += 250 * num_hubs;
29351e0a012SSarah Sharp 
29451e0a012SSarah Sharp 	udev_lpm_params->sel = total_sel;
29551e0a012SSarah Sharp }
29651e0a012SSarah Sharp 
29751e0a012SSarah Sharp static void usb_set_lpm_parameters(struct usb_device *udev)
29851e0a012SSarah Sharp {
29951e0a012SSarah Sharp 	struct usb_hub *hub;
30051e0a012SSarah Sharp 	unsigned int port_to_port_delay;
30151e0a012SSarah Sharp 	unsigned int udev_u1_del;
30251e0a012SSarah Sharp 	unsigned int udev_u2_del;
30351e0a012SSarah Sharp 	unsigned int hub_u1_del;
30451e0a012SSarah Sharp 	unsigned int hub_u2_del;
30551e0a012SSarah Sharp 
3068a1b2725SMathias Nyman 	if (!udev->lpm_capable || udev->speed < USB_SPEED_SUPER)
30751e0a012SSarah Sharp 		return;
30851e0a012SSarah Sharp 
309ad493e5eSLan Tianyu 	hub = usb_hub_to_struct_hub(udev->parent);
31051e0a012SSarah Sharp 	/* It doesn't take time to transition the roothub into U0, since it
31151e0a012SSarah Sharp 	 * doesn't have an upstream link.
31251e0a012SSarah Sharp 	 */
31351e0a012SSarah Sharp 	if (!hub)
31451e0a012SSarah Sharp 		return;
31551e0a012SSarah Sharp 
31651e0a012SSarah Sharp 	udev_u1_del = udev->bos->ss_cap->bU1devExitLat;
3174d967995SXenia Ragiadakou 	udev_u2_del = le16_to_cpu(udev->bos->ss_cap->bU2DevExitLat);
31851e0a012SSarah Sharp 	hub_u1_del = udev->parent->bos->ss_cap->bU1devExitLat;
3194d967995SXenia Ragiadakou 	hub_u2_del = le16_to_cpu(udev->parent->bos->ss_cap->bU2DevExitLat);
32051e0a012SSarah Sharp 
32151e0a012SSarah Sharp 	usb_set_lpm_mel(udev, &udev->u1_params, udev_u1_del,
32251e0a012SSarah Sharp 			hub, &udev->parent->u1_params, hub_u1_del);
32351e0a012SSarah Sharp 
32451e0a012SSarah Sharp 	usb_set_lpm_mel(udev, &udev->u2_params, udev_u2_del,
32551e0a012SSarah Sharp 			hub, &udev->parent->u2_params, hub_u2_del);
32651e0a012SSarah Sharp 
32751e0a012SSarah Sharp 	/*
32851e0a012SSarah Sharp 	 * Appendix C, section C.2.2.2, says that there is a slight delay from
32951e0a012SSarah Sharp 	 * when the parent hub notices the downstream port is trying to
33051e0a012SSarah Sharp 	 * transition to U0 to when the hub initiates a U0 transition on its
33151e0a012SSarah Sharp 	 * upstream port.  The section says the delays are tPort2PortU1EL and
33251e0a012SSarah Sharp 	 * tPort2PortU2EL, but it doesn't define what they are.
33351e0a012SSarah Sharp 	 *
33451e0a012SSarah Sharp 	 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
33551e0a012SSarah Sharp 	 * about the same delays.  Use the maximum delay calculations from those
33651e0a012SSarah Sharp 	 * sections.  For U1, it's tHubPort2PortExitLat, which is 1us max.  For
33751e0a012SSarah Sharp 	 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat.  I
33851e0a012SSarah Sharp 	 * assume the device exit latencies they are talking about are the hub
33951e0a012SSarah Sharp 	 * exit latencies.
34051e0a012SSarah Sharp 	 *
34151e0a012SSarah Sharp 	 * What do we do if the U2 exit latency is less than the U1 exit
34251e0a012SSarah Sharp 	 * latency?  It's possible, although not likely...
34351e0a012SSarah Sharp 	 */
34451e0a012SSarah Sharp 	port_to_port_delay = 1;
34551e0a012SSarah Sharp 
34651e0a012SSarah Sharp 	usb_set_lpm_pel(udev, &udev->u1_params, udev_u1_del,
34751e0a012SSarah Sharp 			hub, &udev->parent->u1_params, hub_u1_del,
34851e0a012SSarah Sharp 			port_to_port_delay);
34951e0a012SSarah Sharp 
35051e0a012SSarah Sharp 	if (hub_u2_del > hub_u1_del)
35151e0a012SSarah Sharp 		port_to_port_delay = 1 + hub_u2_del - hub_u1_del;
35251e0a012SSarah Sharp 	else
35351e0a012SSarah Sharp 		port_to_port_delay = 1 + hub_u1_del;
35451e0a012SSarah Sharp 
35551e0a012SSarah Sharp 	usb_set_lpm_pel(udev, &udev->u2_params, udev_u2_del,
35651e0a012SSarah Sharp 			hub, &udev->parent->u2_params, hub_u2_del,
35751e0a012SSarah Sharp 			port_to_port_delay);
35851e0a012SSarah Sharp 
35951e0a012SSarah Sharp 	/* Now that we've got PEL, calculate SEL. */
36051e0a012SSarah Sharp 	usb_set_lpm_sel(udev, &udev->u1_params);
36151e0a012SSarah Sharp 	usb_set_lpm_sel(udev, &udev->u2_params);
36251e0a012SSarah Sharp }
363d9b2099cSSarah Sharp 
3641da177e4SLinus Torvalds /* USB 2.0 spec Section 11.24.4.5 */
365bec444cdSJohan Hovold static int get_hub_descriptor(struct usb_device *hdev,
366bec444cdSJohan Hovold 		struct usb_hub_descriptor *desc)
3671da177e4SLinus Torvalds {
368dbe79bbeSJohn Youn 	int i, ret, size;
369dbe79bbeSJohn Youn 	unsigned dtype;
370dbe79bbeSJohn Youn 
371dbe79bbeSJohn Youn 	if (hub_is_superspeed(hdev)) {
372dbe79bbeSJohn Youn 		dtype = USB_DT_SS_HUB;
373dbe79bbeSJohn Youn 		size = USB_DT_SS_HUB_SIZE;
374dbe79bbeSJohn Youn 	} else {
375dbe79bbeSJohn Youn 		dtype = USB_DT_HUB;
376dbe79bbeSJohn Youn 		size = sizeof(struct usb_hub_descriptor);
377dbe79bbeSJohn Youn 	}
3781da177e4SLinus Torvalds 
3791da177e4SLinus Torvalds 	for (i = 0; i < 3; i++) {
3801da177e4SLinus Torvalds 		ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
3811da177e4SLinus Torvalds 			USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
382bec444cdSJohan Hovold 			dtype << 8, 0, desc, size,
3831da177e4SLinus Torvalds 			USB_CTRL_GET_TIMEOUT);
3842c25a2c8SJohan Hovold 		if (hub_is_superspeed(hdev)) {
3852c25a2c8SJohan Hovold 			if (ret == size)
3861da177e4SLinus Torvalds 				return ret;
387bec444cdSJohan Hovold 		} else if (ret >= USB_DT_HUB_NONVAR_SIZE + 2) {
388bec444cdSJohan Hovold 			/* Make sure we have the DeviceRemovable field. */
389bec444cdSJohan Hovold 			size = USB_DT_HUB_NONVAR_SIZE + desc->bNbrPorts / 8 + 1;
390bec444cdSJohan Hovold 			if (ret < size)
391bec444cdSJohan Hovold 				return -EMSGSIZE;
3922c25a2c8SJohan Hovold 			return ret;
3932c25a2c8SJohan Hovold 		}
3941da177e4SLinus Torvalds 	}
3951da177e4SLinus Torvalds 	return -EINVAL;
3961da177e4SLinus Torvalds }
3971da177e4SLinus Torvalds 
3981da177e4SLinus Torvalds /*
3991da177e4SLinus Torvalds  * USB 2.0 spec Section 11.24.2.1
4001da177e4SLinus Torvalds  */
4011da177e4SLinus Torvalds static int clear_hub_feature(struct usb_device *hdev, int feature)
4021da177e4SLinus Torvalds {
4031da177e4SLinus Torvalds 	return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
4041da177e4SLinus Torvalds 		USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
4051da177e4SLinus Torvalds }
4061da177e4SLinus Torvalds 
4071da177e4SLinus Torvalds /*
4081da177e4SLinus Torvalds  * USB 2.0 spec Section 11.24.2.2
4091da177e4SLinus Torvalds  */
410ad493e5eSLan Tianyu int usb_clear_port_feature(struct usb_device *hdev, int port1, int feature)
4111da177e4SLinus Torvalds {
4121da177e4SLinus Torvalds 	return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
4131da177e4SLinus Torvalds 		USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
4141da177e4SLinus Torvalds 		NULL, 0, 1000);
4151da177e4SLinus Torvalds }
4161da177e4SLinus Torvalds 
4171da177e4SLinus Torvalds /*
4181da177e4SLinus Torvalds  * USB 2.0 spec Section 11.24.2.13
4191da177e4SLinus Torvalds  */
4201da177e4SLinus Torvalds static int set_port_feature(struct usb_device *hdev, int port1, int feature)
4211da177e4SLinus Torvalds {
4221da177e4SLinus Torvalds 	return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
4231da177e4SLinus Torvalds 		USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
4241da177e4SLinus Torvalds 		NULL, 0, 1000);
4251da177e4SLinus Torvalds }
4261da177e4SLinus Torvalds 
427d99f6b41SDan Williams static char *to_led_name(int selector)
428d99f6b41SDan Williams {
429d99f6b41SDan Williams 	switch (selector) {
430d99f6b41SDan Williams 	case HUB_LED_AMBER:
431d99f6b41SDan Williams 		return "amber";
432d99f6b41SDan Williams 	case HUB_LED_GREEN:
433d99f6b41SDan Williams 		return "green";
434d99f6b41SDan Williams 	case HUB_LED_OFF:
435d99f6b41SDan Williams 		return "off";
436d99f6b41SDan Williams 	case HUB_LED_AUTO:
437d99f6b41SDan Williams 		return "auto";
438d99f6b41SDan Williams 	default:
439d99f6b41SDan Williams 		return "??";
440d99f6b41SDan Williams 	}
441d99f6b41SDan Williams }
442d99f6b41SDan Williams 
4431da177e4SLinus Torvalds /*
4441da177e4SLinus Torvalds  * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
4451da177e4SLinus Torvalds  * for info about using port indicators
4461da177e4SLinus Torvalds  */
447d99f6b41SDan Williams static void set_port_led(struct usb_hub *hub, int port1, int selector)
4481da177e4SLinus Torvalds {
449d99f6b41SDan Williams 	struct usb_port *port_dev = hub->ports[port1 - 1];
450d99f6b41SDan Williams 	int status;
451d99f6b41SDan Williams 
452d99f6b41SDan Williams 	status = set_port_feature(hub->hdev, (selector << 8) | port1,
4531da177e4SLinus Torvalds 			USB_PORT_FEAT_INDICATOR);
454d99f6b41SDan Williams 	dev_dbg(&port_dev->dev, "indicator %s status %d\n",
455d99f6b41SDan Williams 		to_led_name(selector), status);
4561da177e4SLinus Torvalds }
4571da177e4SLinus Torvalds 
4581da177e4SLinus Torvalds #define	LED_CYCLE_PERIOD	((2*HZ)/3)
4591da177e4SLinus Torvalds 
460c4028958SDavid Howells static void led_work(struct work_struct *work)
4611da177e4SLinus Torvalds {
462c4028958SDavid Howells 	struct usb_hub		*hub =
463c4028958SDavid Howells 		container_of(work, struct usb_hub, leds.work);
4641da177e4SLinus Torvalds 	struct usb_device	*hdev = hub->hdev;
4651da177e4SLinus Torvalds 	unsigned		i;
4661da177e4SLinus Torvalds 	unsigned		changed = 0;
4671da177e4SLinus Torvalds 	int			cursor = -1;
4681da177e4SLinus Torvalds 
4691da177e4SLinus Torvalds 	if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
4701da177e4SLinus Torvalds 		return;
4711da177e4SLinus Torvalds 
4723bbc47d8SKrzysztof Mazur 	for (i = 0; i < hdev->maxchild; i++) {
4731da177e4SLinus Torvalds 		unsigned	selector, mode;
4741da177e4SLinus Torvalds 
4751da177e4SLinus Torvalds 		/* 30%-50% duty cycle */
4761da177e4SLinus Torvalds 
4771da177e4SLinus Torvalds 		switch (hub->indicator[i]) {
4781da177e4SLinus Torvalds 		/* cycle marker */
4791da177e4SLinus Torvalds 		case INDICATOR_CYCLE:
4801da177e4SLinus Torvalds 			cursor = i;
4811da177e4SLinus Torvalds 			selector = HUB_LED_AUTO;
4821da177e4SLinus Torvalds 			mode = INDICATOR_AUTO;
4831da177e4SLinus Torvalds 			break;
4841da177e4SLinus Torvalds 		/* blinking green = sw attention */
4851da177e4SLinus Torvalds 		case INDICATOR_GREEN_BLINK:
4861da177e4SLinus Torvalds 			selector = HUB_LED_GREEN;
4871da177e4SLinus Torvalds 			mode = INDICATOR_GREEN_BLINK_OFF;
4881da177e4SLinus Torvalds 			break;
4891da177e4SLinus Torvalds 		case INDICATOR_GREEN_BLINK_OFF:
4901da177e4SLinus Torvalds 			selector = HUB_LED_OFF;
4911da177e4SLinus Torvalds 			mode = INDICATOR_GREEN_BLINK;
4921da177e4SLinus Torvalds 			break;
4931da177e4SLinus Torvalds 		/* blinking amber = hw attention */
4941da177e4SLinus Torvalds 		case INDICATOR_AMBER_BLINK:
4951da177e4SLinus Torvalds 			selector = HUB_LED_AMBER;
4961da177e4SLinus Torvalds 			mode = INDICATOR_AMBER_BLINK_OFF;
4971da177e4SLinus Torvalds 			break;
4981da177e4SLinus Torvalds 		case INDICATOR_AMBER_BLINK_OFF:
4991da177e4SLinus Torvalds 			selector = HUB_LED_OFF;
5001da177e4SLinus Torvalds 			mode = INDICATOR_AMBER_BLINK;
5011da177e4SLinus Torvalds 			break;
5021da177e4SLinus Torvalds 		/* blink green/amber = reserved */
5031da177e4SLinus Torvalds 		case INDICATOR_ALT_BLINK:
5041da177e4SLinus Torvalds 			selector = HUB_LED_GREEN;
5051da177e4SLinus Torvalds 			mode = INDICATOR_ALT_BLINK_OFF;
5061da177e4SLinus Torvalds 			break;
5071da177e4SLinus Torvalds 		case INDICATOR_ALT_BLINK_OFF:
5081da177e4SLinus Torvalds 			selector = HUB_LED_AMBER;
5091da177e4SLinus Torvalds 			mode = INDICATOR_ALT_BLINK;
5101da177e4SLinus Torvalds 			break;
5111da177e4SLinus Torvalds 		default:
5121da177e4SLinus Torvalds 			continue;
5131da177e4SLinus Torvalds 		}
5141da177e4SLinus Torvalds 		if (selector != HUB_LED_AUTO)
5151da177e4SLinus Torvalds 			changed = 1;
5161da177e4SLinus Torvalds 		set_port_led(hub, i + 1, selector);
5171da177e4SLinus Torvalds 		hub->indicator[i] = mode;
5181da177e4SLinus Torvalds 	}
5191da177e4SLinus Torvalds 	if (!changed && blinkenlights) {
5201da177e4SLinus Torvalds 		cursor++;
5213bbc47d8SKrzysztof Mazur 		cursor %= hdev->maxchild;
5221da177e4SLinus Torvalds 		set_port_led(hub, cursor + 1, HUB_LED_GREEN);
5231da177e4SLinus Torvalds 		hub->indicator[cursor] = INDICATOR_CYCLE;
5241da177e4SLinus Torvalds 		changed++;
5251da177e4SLinus Torvalds 	}
5261da177e4SLinus Torvalds 	if (changed)
52722f6a0f0SShaibal Dutta 		queue_delayed_work(system_power_efficient_wq,
52822f6a0f0SShaibal Dutta 				&hub->leds, LED_CYCLE_PERIOD);
5291da177e4SLinus Torvalds }
5301da177e4SLinus Torvalds 
5311da177e4SLinus Torvalds /* use a short timeout for hub/port status fetches */
5321da177e4SLinus Torvalds #define	USB_STS_TIMEOUT		1000
5331da177e4SLinus Torvalds #define	USB_STS_RETRIES		5
5341da177e4SLinus Torvalds 
5351da177e4SLinus Torvalds /*
5361da177e4SLinus Torvalds  * USB 2.0 spec Section 11.24.2.6
5371da177e4SLinus Torvalds  */
5381da177e4SLinus Torvalds static int get_hub_status(struct usb_device *hdev,
5391da177e4SLinus Torvalds 		struct usb_hub_status *data)
5401da177e4SLinus Torvalds {
5411da177e4SLinus Torvalds 	int i, status = -ETIMEDOUT;
5421da177e4SLinus Torvalds 
5433824c1ddSLibor Pechacek 	for (i = 0; i < USB_STS_RETRIES &&
5443824c1ddSLibor Pechacek 			(status == -ETIMEDOUT || status == -EPIPE); i++) {
5451da177e4SLinus Torvalds 		status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
5461da177e4SLinus Torvalds 			USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
5471da177e4SLinus Torvalds 			data, sizeof(*data), USB_STS_TIMEOUT);
5481da177e4SLinus Torvalds 	}
5491da177e4SLinus Torvalds 	return status;
5501da177e4SLinus Torvalds }
5511da177e4SLinus Torvalds 
5521da177e4SLinus Torvalds /*
5531da177e4SLinus Torvalds  * USB 2.0 spec Section 11.24.2.7
5540cdd49a1SMathias Nyman  * USB 3.1 takes into use the wValue and wLength fields, spec Section 10.16.2.6
5551da177e4SLinus Torvalds  */
5561da177e4SLinus Torvalds static int get_port_status(struct usb_device *hdev, int port1,
5570cdd49a1SMathias Nyman 			   void *data, u16 value, u16 length)
5581da177e4SLinus Torvalds {
5591da177e4SLinus Torvalds 	int i, status = -ETIMEDOUT;
5601da177e4SLinus Torvalds 
5613824c1ddSLibor Pechacek 	for (i = 0; i < USB_STS_RETRIES &&
5623824c1ddSLibor Pechacek 			(status == -ETIMEDOUT || status == -EPIPE); i++) {
5631da177e4SLinus Torvalds 		status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
5640cdd49a1SMathias Nyman 			USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, value,
5650cdd49a1SMathias Nyman 			port1, data, length, USB_STS_TIMEOUT);
5661da177e4SLinus Torvalds 	}
5671da177e4SLinus Torvalds 	return status;
5681da177e4SLinus Torvalds }
5691da177e4SLinus Torvalds 
5700cdd49a1SMathias Nyman static int hub_ext_port_status(struct usb_hub *hub, int port1, int type,
5710cdd49a1SMathias Nyman 			       u16 *status, u16 *change, u32 *ext_status)
5723eb14915SAlan Stern {
5733eb14915SAlan Stern 	int ret;
5740cdd49a1SMathias Nyman 	int len = 4;
5750cdd49a1SMathias Nyman 
5760cdd49a1SMathias Nyman 	if (type != HUB_PORT_STATUS)
5770cdd49a1SMathias Nyman 		len = 8;
5783eb14915SAlan Stern 
5793eb14915SAlan Stern 	mutex_lock(&hub->status_mutex);
5800cdd49a1SMathias Nyman 	ret = get_port_status(hub->hdev, port1, &hub->status->port, type, len);
5810cdd49a1SMathias Nyman 	if (ret < len) {
582e9e88fb7SAlan Stern 		if (ret != -ENODEV)
5833eb14915SAlan Stern 			dev_err(hub->intfdev,
5843eb14915SAlan Stern 				"%s failed (err = %d)\n", __func__, ret);
5853eb14915SAlan Stern 		if (ret >= 0)
5863eb14915SAlan Stern 			ret = -EIO;
5873eb14915SAlan Stern 	} else {
5883eb14915SAlan Stern 		*status = le16_to_cpu(hub->status->port.wPortStatus);
5893eb14915SAlan Stern 		*change = le16_to_cpu(hub->status->port.wPortChange);
5900cdd49a1SMathias Nyman 		if (type != HUB_PORT_STATUS && ext_status)
5910cdd49a1SMathias Nyman 			*ext_status = le32_to_cpu(
5920cdd49a1SMathias Nyman 				hub->status->port.dwExtPortStatus);
5933eb14915SAlan Stern 		ret = 0;
5943eb14915SAlan Stern 	}
5953eb14915SAlan Stern 	mutex_unlock(&hub->status_mutex);
5963eb14915SAlan Stern 	return ret;
5973eb14915SAlan Stern }
5983eb14915SAlan Stern 
5990cdd49a1SMathias Nyman static int hub_port_status(struct usb_hub *hub, int port1,
6000cdd49a1SMathias Nyman 		u16 *status, u16 *change)
6010cdd49a1SMathias Nyman {
6020cdd49a1SMathias Nyman 	return hub_ext_port_status(hub, port1, HUB_PORT_STATUS,
6030cdd49a1SMathias Nyman 				   status, change, NULL);
6040cdd49a1SMathias Nyman }
6050cdd49a1SMathias Nyman 
60632a69589SPetr Mladek static void kick_hub_wq(struct usb_hub *hub)
6071da177e4SLinus Torvalds {
60832a69589SPetr Mladek 	struct usb_interface *intf;
6091da177e4SLinus Torvalds 
61032a69589SPetr Mladek 	if (hub->disconnected || work_pending(&hub->events))
61132a69589SPetr Mladek 		return;
6128e4ceb38SAlan Stern 
61332a69589SPetr Mladek 	/*
61432a69589SPetr Mladek 	 * Suppress autosuspend until the event is proceed.
61532a69589SPetr Mladek 	 *
61632a69589SPetr Mladek 	 * Be careful and make sure that the symmetric operation is
61732a69589SPetr Mladek 	 * always called. We are here only when there is no pending
61832a69589SPetr Mladek 	 * work for this hub. Therefore put the interface either when
61932a69589SPetr Mladek 	 * the new work is called or when it is canceled.
62032a69589SPetr Mladek 	 */
62132a69589SPetr Mladek 	intf = to_usb_interface(hub->intfdev);
62232a69589SPetr Mladek 	usb_autopm_get_interface_no_resume(intf);
62332a69589SPetr Mladek 	kref_get(&hub->kref);
62432a69589SPetr Mladek 
62532a69589SPetr Mladek 	if (queue_work(hub_wq, &hub->events))
62632a69589SPetr Mladek 		return;
62732a69589SPetr Mladek 
62832a69589SPetr Mladek 	/* the work has already been scheduled */
62932a69589SPetr Mladek 	usb_autopm_put_interface_async(intf);
63032a69589SPetr Mladek 	kref_put(&hub->kref, hub_release);
6311da177e4SLinus Torvalds }
6321da177e4SLinus Torvalds 
63359d48b3fSPetr Mladek void usb_kick_hub_wq(struct usb_device *hdev)
6341da177e4SLinus Torvalds {
635ad493e5eSLan Tianyu 	struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
63625118084SAlan Stern 
63725118084SAlan Stern 	if (hub)
63832a69589SPetr Mladek 		kick_hub_wq(hub);
6391da177e4SLinus Torvalds }
6401da177e4SLinus Torvalds 
6414ee823b8SSarah Sharp /*
6424ee823b8SSarah Sharp  * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
6434ee823b8SSarah Sharp  * Notification, which indicates it had initiated remote wakeup.
6444ee823b8SSarah Sharp  *
6454ee823b8SSarah Sharp  * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
6464ee823b8SSarah Sharp  * device initiates resume, so the USB core will not receive notice of the
6474ee823b8SSarah Sharp  * resume through the normal hub interrupt URB.
6484ee823b8SSarah Sharp  */
6494ee823b8SSarah Sharp void usb_wakeup_notification(struct usb_device *hdev,
6504ee823b8SSarah Sharp 		unsigned int portnum)
6514ee823b8SSarah Sharp {
6524ee823b8SSarah Sharp 	struct usb_hub *hub;
6534ee823b8SSarah Sharp 
6544ee823b8SSarah Sharp 	if (!hdev)
6554ee823b8SSarah Sharp 		return;
6564ee823b8SSarah Sharp 
657ad493e5eSLan Tianyu 	hub = usb_hub_to_struct_hub(hdev);
6584ee823b8SSarah Sharp 	if (hub) {
6594ee823b8SSarah Sharp 		set_bit(portnum, hub->wakeup_bits);
66032a69589SPetr Mladek 		kick_hub_wq(hub);
6614ee823b8SSarah Sharp 	}
6624ee823b8SSarah Sharp }
6634ee823b8SSarah Sharp EXPORT_SYMBOL_GPL(usb_wakeup_notification);
6641da177e4SLinus Torvalds 
6651da177e4SLinus Torvalds /* completion function, fires on port status changes and various faults */
6667d12e780SDavid Howells static void hub_irq(struct urb *urb)
6671da177e4SLinus Torvalds {
668ec17cf1cSTobias Klauser 	struct usb_hub *hub = urb->context;
669e015268dSAlan Stern 	int status = urb->status;
67071d2718fSRoel Kluin 	unsigned i;
6711da177e4SLinus Torvalds 	unsigned long bits;
6721da177e4SLinus Torvalds 
673e015268dSAlan Stern 	switch (status) {
6741da177e4SLinus Torvalds 	case -ENOENT:		/* synchronous unlink */
6751da177e4SLinus Torvalds 	case -ECONNRESET:	/* async unlink */
6761da177e4SLinus Torvalds 	case -ESHUTDOWN:	/* hardware going away */
6771da177e4SLinus Torvalds 		return;
6781da177e4SLinus Torvalds 
6791da177e4SLinus Torvalds 	default:		/* presumably an error */
6801da177e4SLinus Torvalds 		/* Cause a hub reset after 10 consecutive errors */
681e015268dSAlan Stern 		dev_dbg(hub->intfdev, "transfer --> %d\n", status);
6821da177e4SLinus Torvalds 		if ((++hub->nerrors < 10) || hub->error)
6831da177e4SLinus Torvalds 			goto resubmit;
684e015268dSAlan Stern 		hub->error = status;
6851da177e4SLinus Torvalds 		/* FALL THROUGH */
6861da177e4SLinus Torvalds 
68737ebb549SPetr Mladek 	/* let hub_wq handle things */
6881da177e4SLinus Torvalds 	case 0:			/* we got data:  port status changed */
6891da177e4SLinus Torvalds 		bits = 0;
6901da177e4SLinus Torvalds 		for (i = 0; i < urb->actual_length; ++i)
6911da177e4SLinus Torvalds 			bits |= ((unsigned long) ((*hub->buffer)[i]))
6921da177e4SLinus Torvalds 					<< (i*8);
6931da177e4SLinus Torvalds 		hub->event_bits[0] = bits;
6941da177e4SLinus Torvalds 		break;
6951da177e4SLinus Torvalds 	}
6961da177e4SLinus Torvalds 
6971da177e4SLinus Torvalds 	hub->nerrors = 0;
6981da177e4SLinus Torvalds 
69937ebb549SPetr Mladek 	/* Something happened, let hub_wq figure it out */
70032a69589SPetr Mladek 	kick_hub_wq(hub);
7011da177e4SLinus Torvalds 
7021da177e4SLinus Torvalds resubmit:
7031da177e4SLinus Torvalds 	if (hub->quiescing)
7041da177e4SLinus Torvalds 		return;
7051da177e4SLinus Torvalds 
706088a3daeSKris Borer 	status = usb_submit_urb(hub->urb, GFP_ATOMIC);
707088a3daeSKris Borer 	if (status != 0 && status != -ENODEV && status != -EPERM)
7081da177e4SLinus Torvalds 		dev_err(hub->intfdev, "resubmit --> %d\n", status);
7091da177e4SLinus Torvalds }
7101da177e4SLinus Torvalds 
7111da177e4SLinus Torvalds /* USB 2.0 spec Section 11.24.2.3 */
7121da177e4SLinus Torvalds static inline int
7131da177e4SLinus Torvalds hub_clear_tt_buffer(struct usb_device *hdev, u16 devinfo, u16 tt)
7141da177e4SLinus Torvalds {
7152c7b871bSWilliam Gulland 	/* Need to clear both directions for control ep */
7162c7b871bSWilliam Gulland 	if (((devinfo >> 11) & USB_ENDPOINT_XFERTYPE_MASK) ==
7172c7b871bSWilliam Gulland 			USB_ENDPOINT_XFER_CONTROL) {
7182c7b871bSWilliam Gulland 		int status = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
7192c7b871bSWilliam Gulland 				HUB_CLEAR_TT_BUFFER, USB_RT_PORT,
7202c7b871bSWilliam Gulland 				devinfo ^ 0x8000, tt, NULL, 0, 1000);
7212c7b871bSWilliam Gulland 		if (status)
7222c7b871bSWilliam Gulland 			return status;
7232c7b871bSWilliam Gulland 	}
724c2f6595fSAlan Stern 	return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
7251da177e4SLinus Torvalds 			       HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
7261da177e4SLinus Torvalds 			       tt, NULL, 0, 1000);
7271da177e4SLinus Torvalds }
7281da177e4SLinus Torvalds 
7291da177e4SLinus Torvalds /*
73037ebb549SPetr Mladek  * enumeration blocks hub_wq for a long time. we use keventd instead, since
7311da177e4SLinus Torvalds  * long blocking there is the exception, not the rule.  accordingly, HCDs
7321da177e4SLinus Torvalds  * talking to TTs must queue control transfers (not just bulk and iso), so
7331da177e4SLinus Torvalds  * both can talk to the same hub concurrently.
7341da177e4SLinus Torvalds  */
735cb88a1b8SAlan Stern static void hub_tt_work(struct work_struct *work)
7361da177e4SLinus Torvalds {
737c4028958SDavid Howells 	struct usb_hub		*hub =
738cb88a1b8SAlan Stern 		container_of(work, struct usb_hub, tt.clear_work);
7391da177e4SLinus Torvalds 	unsigned long		flags;
7401da177e4SLinus Torvalds 
7411da177e4SLinus Torvalds 	spin_lock_irqsave(&hub->tt.lock, flags);
7423b6054daSOctavian Purdila 	while (!list_empty(&hub->tt.clear_list)) {
743d0f830d3SH Hartley Sweeten 		struct list_head	*next;
7441da177e4SLinus Torvalds 		struct usb_tt_clear	*clear;
7451da177e4SLinus Torvalds 		struct usb_device	*hdev = hub->hdev;
746cb88a1b8SAlan Stern 		const struct hc_driver	*drv;
7471da177e4SLinus Torvalds 		int			status;
7481da177e4SLinus Torvalds 
749d0f830d3SH Hartley Sweeten 		next = hub->tt.clear_list.next;
750d0f830d3SH Hartley Sweeten 		clear = list_entry(next, struct usb_tt_clear, clear_list);
7511da177e4SLinus Torvalds 		list_del(&clear->clear_list);
7521da177e4SLinus Torvalds 
7531da177e4SLinus Torvalds 		/* drop lock so HCD can concurrently report other TT errors */
7541da177e4SLinus Torvalds 		spin_unlock_irqrestore(&hub->tt.lock, flags);
7551da177e4SLinus Torvalds 		status = hub_clear_tt_buffer(hdev, clear->devinfo, clear->tt);
756e9e88fb7SAlan Stern 		if (status && status != -ENODEV)
7571da177e4SLinus Torvalds 			dev_err(&hdev->dev,
7581da177e4SLinus Torvalds 				"clear tt %d (%04x) error %d\n",
7591da177e4SLinus Torvalds 				clear->tt, clear->devinfo, status);
760cb88a1b8SAlan Stern 
761cb88a1b8SAlan Stern 		/* Tell the HCD, even if the operation failed */
762cb88a1b8SAlan Stern 		drv = clear->hcd->driver;
763cb88a1b8SAlan Stern 		if (drv->clear_tt_buffer_complete)
764cb88a1b8SAlan Stern 			(drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
765cb88a1b8SAlan Stern 
7661da177e4SLinus Torvalds 		kfree(clear);
767cb88a1b8SAlan Stern 		spin_lock_irqsave(&hub->tt.lock, flags);
7681da177e4SLinus Torvalds 	}
7691da177e4SLinus Torvalds 	spin_unlock_irqrestore(&hub->tt.lock, flags);
7701da177e4SLinus Torvalds }
7711da177e4SLinus Torvalds 
7721da177e4SLinus Torvalds /**
773971fcd49SLan Tianyu  * usb_hub_set_port_power - control hub port's power state
77441341261SMathias Nyman  * @hdev: USB device belonging to the usb hub
77541341261SMathias Nyman  * @hub: target hub
776971fcd49SLan Tianyu  * @port1: port index
777971fcd49SLan Tianyu  * @set: expected status
778971fcd49SLan Tianyu  *
779971fcd49SLan Tianyu  * call this function to control port's power via setting or
780971fcd49SLan Tianyu  * clearing the port's PORT_POWER feature.
781626f090cSYacine Belkadi  *
782626f090cSYacine Belkadi  * Return: 0 if successful. A negative error code otherwise.
783971fcd49SLan Tianyu  */
78441341261SMathias Nyman int usb_hub_set_port_power(struct usb_device *hdev, struct usb_hub *hub,
78541341261SMathias Nyman 			   int port1, bool set)
786971fcd49SLan Tianyu {
787971fcd49SLan Tianyu 	int ret;
788971fcd49SLan Tianyu 
789971fcd49SLan Tianyu 	if (set)
790971fcd49SLan Tianyu 		ret = set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
791971fcd49SLan Tianyu 	else
792ad493e5eSLan Tianyu 		ret = usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
793ad493e5eSLan Tianyu 
794d5c3834eSDan Williams 	if (ret)
795971fcd49SLan Tianyu 		return ret;
796d5c3834eSDan Williams 
797d5c3834eSDan Williams 	if (set)
798d5c3834eSDan Williams 		set_bit(port1, hub->power_bits);
799d5c3834eSDan Williams 	else
800d5c3834eSDan Williams 		clear_bit(port1, hub->power_bits);
801d5c3834eSDan Williams 	return 0;
802971fcd49SLan Tianyu }
803971fcd49SLan Tianyu 
804971fcd49SLan Tianyu /**
805cb88a1b8SAlan Stern  * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
806cb88a1b8SAlan Stern  * @urb: an URB associated with the failed or incomplete split transaction
8071da177e4SLinus Torvalds  *
8081da177e4SLinus Torvalds  * High speed HCDs use this to tell the hub driver that some split control or
8091da177e4SLinus Torvalds  * bulk transaction failed in a way that requires clearing internal state of
8101da177e4SLinus Torvalds  * a transaction translator.  This is normally detected (and reported) from
8111da177e4SLinus Torvalds  * interrupt context.
8121da177e4SLinus Torvalds  *
8131da177e4SLinus Torvalds  * It may not be possible for that hub to handle additional full (or low)
8141da177e4SLinus Torvalds  * speed transactions until that state is fully cleared out.
815626f090cSYacine Belkadi  *
816626f090cSYacine Belkadi  * Return: 0 if successful. A negative error code otherwise.
8171da177e4SLinus Torvalds  */
818cb88a1b8SAlan Stern int usb_hub_clear_tt_buffer(struct urb *urb)
8191da177e4SLinus Torvalds {
820cb88a1b8SAlan Stern 	struct usb_device	*udev = urb->dev;
821cb88a1b8SAlan Stern 	int			pipe = urb->pipe;
8221da177e4SLinus Torvalds 	struct usb_tt		*tt = udev->tt;
8231da177e4SLinus Torvalds 	unsigned long		flags;
8241da177e4SLinus Torvalds 	struct usb_tt_clear	*clear;
8251da177e4SLinus Torvalds 
8261da177e4SLinus Torvalds 	/* we've got to cope with an arbitrary number of pending TT clears,
8271da177e4SLinus Torvalds 	 * since each TT has "at least two" buffers that can need it (and
8281da177e4SLinus Torvalds 	 * there can be many TTs per hub).  even if they're uncommon.
8291da177e4SLinus Torvalds 	 */
830d544d273SGreg Kroah-Hartman 	clear = kmalloc(sizeof *clear, GFP_ATOMIC);
831d544d273SGreg Kroah-Hartman 	if (clear == NULL) {
8321da177e4SLinus Torvalds 		dev_err(&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
8331da177e4SLinus Torvalds 		/* FIXME recover somehow ... RESET_TT? */
834cb88a1b8SAlan Stern 		return -ENOMEM;
8351da177e4SLinus Torvalds 	}
8361da177e4SLinus Torvalds 
8371da177e4SLinus Torvalds 	/* info that CLEAR_TT_BUFFER needs */
8381da177e4SLinus Torvalds 	clear->tt = tt->multi ? udev->ttport : 1;
8391da177e4SLinus Torvalds 	clear->devinfo = usb_pipeendpoint (pipe);
8401da177e4SLinus Torvalds 	clear->devinfo |= udev->devnum << 4;
8411da177e4SLinus Torvalds 	clear->devinfo |= usb_pipecontrol(pipe)
8421da177e4SLinus Torvalds 			? (USB_ENDPOINT_XFER_CONTROL << 11)
8431da177e4SLinus Torvalds 			: (USB_ENDPOINT_XFER_BULK << 11);
8441da177e4SLinus Torvalds 	if (usb_pipein(pipe))
8451da177e4SLinus Torvalds 		clear->devinfo |= 1 << 15;
8461da177e4SLinus Torvalds 
847cb88a1b8SAlan Stern 	/* info for completion callback */
848cb88a1b8SAlan Stern 	clear->hcd = bus_to_hcd(udev->bus);
849cb88a1b8SAlan Stern 	clear->ep = urb->ep;
850cb88a1b8SAlan Stern 
8511da177e4SLinus Torvalds 	/* tell keventd to clear state for this TT */
8521da177e4SLinus Torvalds 	spin_lock_irqsave(&tt->lock, flags);
8531da177e4SLinus Torvalds 	list_add_tail(&clear->clear_list, &tt->clear_list);
854cb88a1b8SAlan Stern 	schedule_work(&tt->clear_work);
8551da177e4SLinus Torvalds 	spin_unlock_irqrestore(&tt->lock, flags);
856cb88a1b8SAlan Stern 	return 0;
8571da177e4SLinus Torvalds }
858cb88a1b8SAlan Stern EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
8591da177e4SLinus Torvalds 
8607ad3c470SDan Williams static void hub_power_on(struct usb_hub *hub, bool do_delay)
8611da177e4SLinus Torvalds {
8621da177e4SLinus Torvalds 	int port1;
8631da177e4SLinus Torvalds 
8644489a571SAlan Stern 	/* Enable power on each port.  Some hubs have reserved values
8654489a571SAlan Stern 	 * of LPSM (> 2) in their descriptors, even though they are
8664489a571SAlan Stern 	 * USB 2.0 hubs.  Some hubs do not implement port-power switching
8674489a571SAlan Stern 	 * but only emulate it.  In all cases, the ports won't work
8684489a571SAlan Stern 	 * unless we send these messages to the hub.
8694489a571SAlan Stern 	 */
8709262c19dSDan Williams 	if (hub_is_port_power_switchable(hub))
8711da177e4SLinus Torvalds 		dev_dbg(hub->intfdev, "enabling power on all ports\n");
8724489a571SAlan Stern 	else
8734489a571SAlan Stern 		dev_dbg(hub->intfdev, "trying to enable port power on "
8744489a571SAlan Stern 				"non-switchable hub\n");
8753bbc47d8SKrzysztof Mazur 	for (port1 = 1; port1 <= hub->hdev->maxchild; port1++)
876d5c3834eSDan Williams 		if (test_bit(port1, hub->power_bits))
8774489a571SAlan Stern 			set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
878ad493e5eSLan Tianyu 		else
879ad493e5eSLan Tianyu 			usb_clear_port_feature(hub->hdev, port1,
880ad493e5eSLan Tianyu 						USB_PORT_FEAT_POWER);
8818520f380SAlan Stern 	if (do_delay)
8827ad3c470SDan Williams 		msleep(hub_power_on_good_delay(hub));
8831da177e4SLinus Torvalds }
8841da177e4SLinus Torvalds 
8851da177e4SLinus Torvalds static int hub_hub_status(struct usb_hub *hub,
8861da177e4SLinus Torvalds 		u16 *status, u16 *change)
8871da177e4SLinus Torvalds {
8881da177e4SLinus Torvalds 	int ret;
8891da177e4SLinus Torvalds 
890db90e7a1SAlan Stern 	mutex_lock(&hub->status_mutex);
8911da177e4SLinus Torvalds 	ret = get_hub_status(hub->hdev, &hub->status->hub);
892e9e88fb7SAlan Stern 	if (ret < 0) {
893e9e88fb7SAlan Stern 		if (ret != -ENODEV)
8941da177e4SLinus Torvalds 			dev_err(hub->intfdev,
895441b62c1SHarvey Harrison 				"%s failed (err = %d)\n", __func__, ret);
896e9e88fb7SAlan Stern 	} else {
8971da177e4SLinus Torvalds 		*status = le16_to_cpu(hub->status->hub.wHubStatus);
8981da177e4SLinus Torvalds 		*change = le16_to_cpu(hub->status->hub.wHubChange);
8991da177e4SLinus Torvalds 		ret = 0;
9001da177e4SLinus Torvalds 	}
901db90e7a1SAlan Stern 	mutex_unlock(&hub->status_mutex);
9021da177e4SLinus Torvalds 	return ret;
9031da177e4SLinus Torvalds }
9041da177e4SLinus Torvalds 
90541e7e056SSarah Sharp static int hub_set_port_link_state(struct usb_hub *hub, int port1,
90641e7e056SSarah Sharp 			unsigned int link_status)
90741e7e056SSarah Sharp {
90841e7e056SSarah Sharp 	return set_port_feature(hub->hdev,
90941e7e056SSarah Sharp 			port1 | (link_status << 3),
91041e7e056SSarah Sharp 			USB_PORT_FEAT_LINK_STATE);
91141e7e056SSarah Sharp }
91241e7e056SSarah Sharp 
91341e7e056SSarah Sharp /*
9146d42fcdbSJustin P. Mattock  * Disable a port and mark a logical connect-change event, so that some
91537ebb549SPetr Mladek  * time later hub_wq will disconnect() any existing usb_device on the port
9160458d5b4SAlan Stern  * and will re-enumerate if there actually is a device attached.
9170458d5b4SAlan Stern  */
9180458d5b4SAlan Stern static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
9197d069b7dSAlan Stern {
920d99f6b41SDan Williams 	dev_dbg(&hub->ports[port1 - 1]->dev, "logical disconnect\n");
9210458d5b4SAlan Stern 	hub_port_disable(hub, port1, 1);
9220458d5b4SAlan Stern 
9230458d5b4SAlan Stern 	/* FIXME let caller ask to power down the port:
9240458d5b4SAlan Stern 	 *  - some devices won't enumerate without a VBUS power cycle
9250458d5b4SAlan Stern 	 *  - SRP saves power that way
9260458d5b4SAlan Stern 	 *  - ... new call, TBD ...
9270458d5b4SAlan Stern 	 * That's easy if this hub can switch power per-port, and
92837ebb549SPetr Mladek 	 * hub_wq reactivates the port later (timer, SRP, etc).
9290458d5b4SAlan Stern 	 * Powerdown must be optional, because of reset/DFU.
9300458d5b4SAlan Stern 	 */
9310458d5b4SAlan Stern 
9320458d5b4SAlan Stern 	set_bit(port1, hub->change_bits);
93332a69589SPetr Mladek 	kick_hub_wq(hub);
9340458d5b4SAlan Stern }
9350458d5b4SAlan Stern 
936253e0572SAlan Stern /**
937253e0572SAlan Stern  * usb_remove_device - disable a device's port on its parent hub
938253e0572SAlan Stern  * @udev: device to be disabled and removed
939253e0572SAlan Stern  * Context: @udev locked, must be able to sleep.
940253e0572SAlan Stern  *
94137ebb549SPetr Mladek  * After @udev's port has been disabled, hub_wq is notified and it will
942253e0572SAlan Stern  * see that the device has been disconnected.  When the device is
943253e0572SAlan Stern  * physically unplugged and something is plugged in, the events will
944253e0572SAlan Stern  * be received and processed normally.
945626f090cSYacine Belkadi  *
946626f090cSYacine Belkadi  * Return: 0 if successful. A negative error code otherwise.
947253e0572SAlan Stern  */
948253e0572SAlan Stern int usb_remove_device(struct usb_device *udev)
949253e0572SAlan Stern {
950253e0572SAlan Stern 	struct usb_hub *hub;
951253e0572SAlan Stern 	struct usb_interface *intf;
952253e0572SAlan Stern 
953253e0572SAlan Stern 	if (!udev->parent)	/* Can't remove a root hub */
954253e0572SAlan Stern 		return -EINVAL;
955ad493e5eSLan Tianyu 	hub = usb_hub_to_struct_hub(udev->parent);
956253e0572SAlan Stern 	intf = to_usb_interface(hub->intfdev);
957253e0572SAlan Stern 
958253e0572SAlan Stern 	usb_autopm_get_interface(intf);
959253e0572SAlan Stern 	set_bit(udev->portnum, hub->removed_bits);
960253e0572SAlan Stern 	hub_port_logical_disconnect(hub, udev->portnum);
961253e0572SAlan Stern 	usb_autopm_put_interface(intf);
962253e0572SAlan Stern 	return 0;
963253e0572SAlan Stern }
964253e0572SAlan Stern 
9656ee0b270SAlan Stern enum hub_activation_type {
9668e4ceb38SAlan Stern 	HUB_INIT, HUB_INIT2, HUB_INIT3,		/* INITs must come first */
9678520f380SAlan Stern 	HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
9686ee0b270SAlan Stern };
9695e6effaeSAlan Stern 
9708520f380SAlan Stern static void hub_init_func2(struct work_struct *ws);
9718520f380SAlan Stern static void hub_init_func3(struct work_struct *ws);
9728520f380SAlan Stern 
973f2835219SAlan Stern static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
9745e6effaeSAlan Stern {
9755e6effaeSAlan Stern 	struct usb_device *hdev = hub->hdev;
976653a39d1SSarah Sharp 	struct usb_hcd *hcd;
977653a39d1SSarah Sharp 	int ret;
9785e6effaeSAlan Stern 	int port1;
979f2835219SAlan Stern 	int status;
980948fea37SAlan Stern 	bool need_debounce_delay = false;
9818520f380SAlan Stern 	unsigned delay;
9828520f380SAlan Stern 
9838520f380SAlan Stern 	/* Continue a partial initialization */
984e50293efSAlan Stern 	if (type == HUB_INIT2 || type == HUB_INIT3) {
98507d316a2SAlan Stern 		device_lock(&hdev->dev);
986e50293efSAlan Stern 
987e50293efSAlan Stern 		/* Was the hub disconnected while we were waiting? */
988ca5cbc8bSAlan Stern 		if (hub->disconnected)
989ca5cbc8bSAlan Stern 			goto disconnected;
9908520f380SAlan Stern 		if (type == HUB_INIT2)
9918520f380SAlan Stern 			goto init2;
9928520f380SAlan Stern 		goto init3;
993e50293efSAlan Stern 	}
994e50293efSAlan Stern 	kref_get(&hub->kref);
9955e6effaeSAlan Stern 
996a45aa3b3SElric Fu 	/* The superspeed hub except for root hub has to use Hub Depth
997a45aa3b3SElric Fu 	 * value as an offset into the route string to locate the bits
998a45aa3b3SElric Fu 	 * it uses to determine the downstream port number. So hub driver
999a45aa3b3SElric Fu 	 * should send a set hub depth request to superspeed hub after
1000a45aa3b3SElric Fu 	 * the superspeed hub is set configuration in initialization or
1001a45aa3b3SElric Fu 	 * reset procedure.
1002a45aa3b3SElric Fu 	 *
1003a45aa3b3SElric Fu 	 * After a resume, port power should still be on.
1004f2835219SAlan Stern 	 * For any other type of activation, turn it on.
1005f2835219SAlan Stern 	 */
10068520f380SAlan Stern 	if (type != HUB_RESUME) {
1007a45aa3b3SElric Fu 		if (hdev->parent && hub_is_superspeed(hdev)) {
1008a45aa3b3SElric Fu 			ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
1009a45aa3b3SElric Fu 					HUB_SET_DEPTH, USB_RT_HUB,
1010a45aa3b3SElric Fu 					hdev->level - 1, 0, NULL, 0,
1011a45aa3b3SElric Fu 					USB_CTRL_SET_TIMEOUT);
1012a45aa3b3SElric Fu 			if (ret < 0)
1013a45aa3b3SElric Fu 				dev_err(hub->intfdev,
1014a45aa3b3SElric Fu 						"set hub depth failed\n");
1015a45aa3b3SElric Fu 		}
10168520f380SAlan Stern 
10178520f380SAlan Stern 		/* Speed up system boot by using a delayed_work for the
10188520f380SAlan Stern 		 * hub's initial power-up delays.  This is pretty awkward
10198520f380SAlan Stern 		 * and the implementation looks like a home-brewed sort of
10208520f380SAlan Stern 		 * setjmp/longjmp, but it saves at least 100 ms for each
10218520f380SAlan Stern 		 * root hub (assuming usbcore is compiled into the kernel
10228520f380SAlan Stern 		 * rather than as a module).  It adds up.
10238520f380SAlan Stern 		 *
10248520f380SAlan Stern 		 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
10258520f380SAlan Stern 		 * because for those activation types the ports have to be
10268520f380SAlan Stern 		 * operational when we return.  In theory this could be done
10278520f380SAlan Stern 		 * for HUB_POST_RESET, but it's easier not to.
10288520f380SAlan Stern 		 */
10298520f380SAlan Stern 		if (type == HUB_INIT) {
103017a364e2SKris Borer 			delay = hub_power_on_good_delay(hub);
10317ad3c470SDan Williams 
10327ad3c470SDan Williams 			hub_power_on(hub, false);
103377fa83cfSTejun Heo 			INIT_DELAYED_WORK(&hub->init_work, hub_init_func2);
103422f6a0f0SShaibal Dutta 			queue_delayed_work(system_power_efficient_wq,
103522f6a0f0SShaibal Dutta 					&hub->init_work,
10368520f380SAlan Stern 					msecs_to_jiffies(delay));
103761fbeba1SAlan Stern 
103861fbeba1SAlan Stern 			/* Suppress autosuspend until init is done */
10398e4ceb38SAlan Stern 			usb_autopm_get_interface_no_resume(
10408e4ceb38SAlan Stern 					to_usb_interface(hub->intfdev));
10418520f380SAlan Stern 			return;		/* Continues at init2: below */
1042653a39d1SSarah Sharp 		} else if (type == HUB_RESET_RESUME) {
1043653a39d1SSarah Sharp 			/* The internal host controller state for the hub device
1044653a39d1SSarah Sharp 			 * may be gone after a host power loss on system resume.
1045653a39d1SSarah Sharp 			 * Update the device's info so the HW knows it's a hub.
1046653a39d1SSarah Sharp 			 */
1047653a39d1SSarah Sharp 			hcd = bus_to_hcd(hdev->bus);
1048653a39d1SSarah Sharp 			if (hcd->driver->update_hub_device) {
1049653a39d1SSarah Sharp 				ret = hcd->driver->update_hub_device(hcd, hdev,
1050653a39d1SSarah Sharp 						&hub->tt, GFP_NOIO);
1051653a39d1SSarah Sharp 				if (ret < 0) {
1052653a39d1SSarah Sharp 					dev_err(hub->intfdev, "Host not "
1053653a39d1SSarah Sharp 							"accepting hub info "
1054653a39d1SSarah Sharp 							"update.\n");
1055653a39d1SSarah Sharp 					dev_err(hub->intfdev, "LS/FS devices "
1056653a39d1SSarah Sharp 							"and hubs may not work "
1057653a39d1SSarah Sharp 							"under this hub\n.");
1058653a39d1SSarah Sharp 				}
1059653a39d1SSarah Sharp 			}
1060653a39d1SSarah Sharp 			hub_power_on(hub, true);
10618520f380SAlan Stern 		} else {
10628520f380SAlan Stern 			hub_power_on(hub, true);
10638520f380SAlan Stern 		}
10648520f380SAlan Stern 	}
10658520f380SAlan Stern  init2:
1066f2835219SAlan Stern 
1067d99f6b41SDan Williams 	/*
106837ebb549SPetr Mladek 	 * Check each port and set hub->change_bits to let hub_wq know
10696ee0b270SAlan Stern 	 * which ports need attention.
10705e6effaeSAlan Stern 	 */
10715e6effaeSAlan Stern 	for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
1072d99f6b41SDan Williams 		struct usb_port *port_dev = hub->ports[port1 - 1];
1073d99f6b41SDan Williams 		struct usb_device *udev = port_dev->child;
10745e6effaeSAlan Stern 		u16 portstatus, portchange;
10755e6effaeSAlan Stern 
10766ee0b270SAlan Stern 		portstatus = portchange = 0;
10776ee0b270SAlan Stern 		status = hub_port_status(hub, port1, &portstatus, &portchange);
1078245b2eecSGuenter Roeck 		if (status)
1079245b2eecSGuenter Roeck 			goto abort;
1080245b2eecSGuenter Roeck 
10816ee0b270SAlan Stern 		if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1082d99f6b41SDan Williams 			dev_dbg(&port_dev->dev, "status %04x change %04x\n",
1083d99f6b41SDan Williams 					portstatus, portchange);
10845e6effaeSAlan Stern 
1085d99f6b41SDan Williams 		/*
1086d99f6b41SDan Williams 		 * After anything other than HUB_RESUME (i.e., initialization
10876ee0b270SAlan Stern 		 * or any sort of reset), every port should be disabled.
10886ee0b270SAlan Stern 		 * Unconnected ports should likewise be disabled (paranoia),
10896ee0b270SAlan Stern 		 * and so should ports for which we have no usb_device.
10905e6effaeSAlan Stern 		 */
10916ee0b270SAlan Stern 		if ((portstatus & USB_PORT_STAT_ENABLE) && (
10926ee0b270SAlan Stern 				type != HUB_RESUME ||
10936ee0b270SAlan Stern 				!(portstatus & USB_PORT_STAT_CONNECTION) ||
10946ee0b270SAlan Stern 				!udev ||
10956ee0b270SAlan Stern 				udev->state == USB_STATE_NOTATTACHED)) {
10969f0a6cd3SAndiry Xu 			/*
10979f0a6cd3SAndiry Xu 			 * USB3 protocol ports will automatically transition
10989f0a6cd3SAndiry Xu 			 * to Enabled state when detect an USB3.0 device attach.
1099fd1ac4cfSDan Williams 			 * Do not disable USB3 protocol ports, just pretend
1100fd1ac4cfSDan Williams 			 * power was lost
11019f0a6cd3SAndiry Xu 			 */
1102fd1ac4cfSDan Williams 			portstatus &= ~USB_PORT_STAT_ENABLE;
1103fd1ac4cfSDan Williams 			if (!hub_is_superspeed(hdev))
1104ad493e5eSLan Tianyu 				usb_clear_port_feature(hdev, port1,
11059f0a6cd3SAndiry Xu 						   USB_PORT_FEAT_ENABLE);
11069f0a6cd3SAndiry Xu 		}
11076ee0b270SAlan Stern 
1108948fea37SAlan Stern 		/* Clear status-change flags; we'll debounce later */
1109948fea37SAlan Stern 		if (portchange & USB_PORT_STAT_C_CONNECTION) {
1110948fea37SAlan Stern 			need_debounce_delay = true;
1111ad493e5eSLan Tianyu 			usb_clear_port_feature(hub->hdev, port1,
1112948fea37SAlan Stern 					USB_PORT_FEAT_C_CONNECTION);
1113948fea37SAlan Stern 		}
1114948fea37SAlan Stern 		if (portchange & USB_PORT_STAT_C_ENABLE) {
1115948fea37SAlan Stern 			need_debounce_delay = true;
1116ad493e5eSLan Tianyu 			usb_clear_port_feature(hub->hdev, port1,
1117948fea37SAlan Stern 					USB_PORT_FEAT_C_ENABLE);
1118948fea37SAlan Stern 		}
1119e92aee33SJulius Werner 		if (portchange & USB_PORT_STAT_C_RESET) {
1120e92aee33SJulius Werner 			need_debounce_delay = true;
1121e92aee33SJulius Werner 			usb_clear_port_feature(hub->hdev, port1,
1122e92aee33SJulius Werner 					USB_PORT_FEAT_C_RESET);
1123e92aee33SJulius Werner 		}
112479c3dd81SDon Zickus 		if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
112579c3dd81SDon Zickus 				hub_is_superspeed(hub->hdev)) {
112679c3dd81SDon Zickus 			need_debounce_delay = true;
1127ad493e5eSLan Tianyu 			usb_clear_port_feature(hub->hdev, port1,
112879c3dd81SDon Zickus 					USB_PORT_FEAT_C_BH_PORT_RESET);
112979c3dd81SDon Zickus 		}
1130253e0572SAlan Stern 		/* We can forget about a "removed" device when there's a
1131253e0572SAlan Stern 		 * physical disconnect or the connect status changes.
1132253e0572SAlan Stern 		 */
1133253e0572SAlan Stern 		if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
1134253e0572SAlan Stern 				(portchange & USB_PORT_STAT_C_CONNECTION))
1135253e0572SAlan Stern 			clear_bit(port1, hub->removed_bits);
1136253e0572SAlan Stern 
11376ee0b270SAlan Stern 		if (!udev || udev->state == USB_STATE_NOTATTACHED) {
113837ebb549SPetr Mladek 			/* Tell hub_wq to disconnect the device or
11396ee0b270SAlan Stern 			 * check for a new connection
11406ee0b270SAlan Stern 			 */
114108d1dec6SShen Guang 			if (udev || (portstatus & USB_PORT_STAT_CONNECTION) ||
114208d1dec6SShen Guang 			    (portstatus & USB_PORT_STAT_OVERCURRENT))
11436ee0b270SAlan Stern 				set_bit(port1, hub->change_bits);
11446ee0b270SAlan Stern 
11456ee0b270SAlan Stern 		} else if (portstatus & USB_PORT_STAT_ENABLE) {
114672937e1eSSarah Sharp 			bool port_resumed = (portstatus &
114772937e1eSSarah Sharp 					USB_PORT_STAT_LINK_STATE) ==
114872937e1eSSarah Sharp 				USB_SS_PORT_LS_U0;
11496ee0b270SAlan Stern 			/* The power session apparently survived the resume.
11506ee0b270SAlan Stern 			 * If there was an overcurrent or suspend change
115137ebb549SPetr Mladek 			 * (i.e., remote wakeup request), have hub_wq
115272937e1eSSarah Sharp 			 * take care of it.  Look at the port link state
115372937e1eSSarah Sharp 			 * for USB 3.0 hubs, since they don't have a suspend
115472937e1eSSarah Sharp 			 * change bit, and they don't set the port link change
115572937e1eSSarah Sharp 			 * bit on device-initiated resume.
11566ee0b270SAlan Stern 			 */
115772937e1eSSarah Sharp 			if (portchange || (hub_is_superspeed(hub->hdev) &&
115872937e1eSSarah Sharp 						port_resumed))
11596ee0b270SAlan Stern 				set_bit(port1, hub->change_bits);
11606ee0b270SAlan Stern 
11616ee0b270SAlan Stern 		} else if (udev->persist_enabled) {
11626ee0b270SAlan Stern #ifdef CONFIG_PM
11635e6effaeSAlan Stern 			udev->reset_resume = 1;
11646ee0b270SAlan Stern #endif
1165ad493e5eSLan Tianyu 			/* Don't set the change_bits when the device
1166ad493e5eSLan Tianyu 			 * was powered off.
1167ad493e5eSLan Tianyu 			 */
1168d5c3834eSDan Williams 			if (test_bit(port1, hub->power_bits))
11698808f00cSAlan Stern 				set_bit(port1, hub->change_bits);
11708808f00cSAlan Stern 
11716ee0b270SAlan Stern 		} else {
117237ebb549SPetr Mladek 			/* The power session is gone; tell hub_wq */
11736ee0b270SAlan Stern 			usb_set_device_state(udev, USB_STATE_NOTATTACHED);
11746ee0b270SAlan Stern 			set_bit(port1, hub->change_bits);
11755e6effaeSAlan Stern 		}
11765e6effaeSAlan Stern 	}
11775e6effaeSAlan Stern 
1178948fea37SAlan Stern 	/* If no port-status-change flags were set, we don't need any
1179948fea37SAlan Stern 	 * debouncing.  If flags were set we can try to debounce the
118037ebb549SPetr Mladek 	 * ports all at once right now, instead of letting hub_wq do them
1181948fea37SAlan Stern 	 * one at a time later on.
1182948fea37SAlan Stern 	 *
118337ebb549SPetr Mladek 	 * If any port-status changes do occur during this delay, hub_wq
1184948fea37SAlan Stern 	 * will see them later and handle them normally.
1185948fea37SAlan Stern 	 */
11868520f380SAlan Stern 	if (need_debounce_delay) {
11878520f380SAlan Stern 		delay = HUB_DEBOUNCE_STABLE;
1188f2835219SAlan Stern 
11898520f380SAlan Stern 		/* Don't do a long sleep inside a workqueue routine */
11908520f380SAlan Stern 		if (type == HUB_INIT2) {
119177fa83cfSTejun Heo 			INIT_DELAYED_WORK(&hub->init_work, hub_init_func3);
119222f6a0f0SShaibal Dutta 			queue_delayed_work(system_power_efficient_wq,
119322f6a0f0SShaibal Dutta 					&hub->init_work,
11948520f380SAlan Stern 					msecs_to_jiffies(delay));
119507d316a2SAlan Stern 			device_unlock(&hdev->dev);
11968520f380SAlan Stern 			return;		/* Continues at init3: below */
11978520f380SAlan Stern 		} else {
11988520f380SAlan Stern 			msleep(delay);
11998520f380SAlan Stern 		}
12008520f380SAlan Stern 	}
12018520f380SAlan Stern  init3:
1202f2835219SAlan Stern 	hub->quiescing = 0;
1203f2835219SAlan Stern 
1204f2835219SAlan Stern 	status = usb_submit_urb(hub->urb, GFP_NOIO);
1205f2835219SAlan Stern 	if (status < 0)
1206f2835219SAlan Stern 		dev_err(hub->intfdev, "activate --> %d\n", status);
1207f2835219SAlan Stern 	if (hub->has_indicators && blinkenlights)
120822f6a0f0SShaibal Dutta 		queue_delayed_work(system_power_efficient_wq,
120922f6a0f0SShaibal Dutta 				&hub->leds, LED_CYCLE_PERIOD);
1210f2835219SAlan Stern 
1211f2835219SAlan Stern 	/* Scan all ports that need attention */
121232a69589SPetr Mladek 	kick_hub_wq(hub);
1213245b2eecSGuenter Roeck  abort:
1214ca5cbc8bSAlan Stern 	if (type == HUB_INIT2 || type == HUB_INIT3) {
12158e4ceb38SAlan Stern 		/* Allow autosuspend if it was suppressed */
1216ca5cbc8bSAlan Stern  disconnected:
12178e4ceb38SAlan Stern 		usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
121807d316a2SAlan Stern 		device_unlock(&hdev->dev);
1219ca5cbc8bSAlan Stern 	}
1220e50293efSAlan Stern 
1221e50293efSAlan Stern 	kref_put(&hub->kref, hub_release);
12225e6effaeSAlan Stern }
12235e6effaeSAlan Stern 
12248520f380SAlan Stern /* Implement the continuations for the delays above */
12258520f380SAlan Stern static void hub_init_func2(struct work_struct *ws)
12268520f380SAlan Stern {
12278520f380SAlan Stern 	struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
12288520f380SAlan Stern 
12298520f380SAlan Stern 	hub_activate(hub, HUB_INIT2);
12308520f380SAlan Stern }
12318520f380SAlan Stern 
12328520f380SAlan Stern static void hub_init_func3(struct work_struct *ws)
12338520f380SAlan Stern {
12348520f380SAlan Stern 	struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
12358520f380SAlan Stern 
12368520f380SAlan Stern 	hub_activate(hub, HUB_INIT3);
12378520f380SAlan Stern }
12388520f380SAlan Stern 
12394330354fSAlan Stern enum hub_quiescing_type {
12404330354fSAlan Stern 	HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
12414330354fSAlan Stern };
12424330354fSAlan Stern 
12434330354fSAlan Stern static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
12444330354fSAlan Stern {
12454330354fSAlan Stern 	struct usb_device *hdev = hub->hdev;
12464330354fSAlan Stern 	int i;
12474330354fSAlan Stern 
124837ebb549SPetr Mladek 	/* hub_wq and related activity won't re-trigger */
12494330354fSAlan Stern 	hub->quiescing = 1;
12504330354fSAlan Stern 
12514330354fSAlan Stern 	if (type != HUB_SUSPEND) {
12524330354fSAlan Stern 		/* Disconnect all the children */
12534330354fSAlan Stern 		for (i = 0; i < hdev->maxchild; ++i) {
1254ff823c79SLan Tianyu 			if (hub->ports[i]->child)
1255ff823c79SLan Tianyu 				usb_disconnect(&hub->ports[i]->child);
12564330354fSAlan Stern 		}
12574330354fSAlan Stern 	}
12584330354fSAlan Stern 
125937ebb549SPetr Mladek 	/* Stop hub_wq and related activity */
12604330354fSAlan Stern 	usb_kill_urb(hub->urb);
12614330354fSAlan Stern 	if (hub->has_indicators)
12624330354fSAlan Stern 		cancel_delayed_work_sync(&hub->leds);
12634330354fSAlan Stern 	if (hub->tt.hub)
1264036546bfSOctavian Purdila 		flush_work(&hub->tt.clear_work);
12654330354fSAlan Stern }
12664330354fSAlan Stern 
1267600856c2SAlan Stern static void hub_pm_barrier_for_all_ports(struct usb_hub *hub)
1268600856c2SAlan Stern {
1269600856c2SAlan Stern 	int i;
1270600856c2SAlan Stern 
1271600856c2SAlan Stern 	for (i = 0; i < hub->hdev->maxchild; ++i)
1272600856c2SAlan Stern 		pm_runtime_barrier(&hub->ports[i]->dev);
1273600856c2SAlan Stern }
1274600856c2SAlan Stern 
12753eb14915SAlan Stern /* caller has locked the hub device */
12763eb14915SAlan Stern static int hub_pre_reset(struct usb_interface *intf)
12773eb14915SAlan Stern {
12783eb14915SAlan Stern 	struct usb_hub *hub = usb_get_intfdata(intf);
12793eb14915SAlan Stern 
12804330354fSAlan Stern 	hub_quiesce(hub, HUB_PRE_RESET);
1281600856c2SAlan Stern 	hub->in_reset = 1;
1282600856c2SAlan Stern 	hub_pm_barrier_for_all_ports(hub);
1283f07600cfSAlan Stern 	return 0;
12847d069b7dSAlan Stern }
12857d069b7dSAlan Stern 
12867d069b7dSAlan Stern /* caller has locked the hub device */
1287f07600cfSAlan Stern static int hub_post_reset(struct usb_interface *intf)
12887d069b7dSAlan Stern {
12897de18d8bSAlan Stern 	struct usb_hub *hub = usb_get_intfdata(intf);
12907de18d8bSAlan Stern 
1291600856c2SAlan Stern 	hub->in_reset = 0;
1292600856c2SAlan Stern 	hub_pm_barrier_for_all_ports(hub);
1293f2835219SAlan Stern 	hub_activate(hub, HUB_POST_RESET);
1294f07600cfSAlan Stern 	return 0;
12957d069b7dSAlan Stern }
12967d069b7dSAlan Stern 
12971da177e4SLinus Torvalds static int hub_configure(struct usb_hub *hub,
12981da177e4SLinus Torvalds 	struct usb_endpoint_descriptor *endpoint)
12991da177e4SLinus Torvalds {
1300b356b7c7SSarah Sharp 	struct usb_hcd *hcd;
13011da177e4SLinus Torvalds 	struct usb_device *hdev = hub->hdev;
13021da177e4SLinus Torvalds 	struct device *hub_dev = hub->intfdev;
13031da177e4SLinus Torvalds 	u16 hubstatus, hubchange;
130474ad9bd2SGreg Kroah-Hartman 	u16 wHubCharacteristics;
13051da177e4SLinus Torvalds 	unsigned int pipe;
1306fa2a9566SLan Tianyu 	int maxp, ret, i;
13077cbe5dcaSAlan Stern 	char *message = "out of memory";
1308430ee58eSSebastian Andrzej Siewior 	unsigned unit_load;
1309430ee58eSSebastian Andrzej Siewior 	unsigned full_load;
1310d8521afeSDan Williams 	unsigned maxchild;
13111da177e4SLinus Torvalds 
1312d697cddaSAlan Stern 	hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
13131da177e4SLinus Torvalds 	if (!hub->buffer) {
13141da177e4SLinus Torvalds 		ret = -ENOMEM;
13151da177e4SLinus Torvalds 		goto fail;
13161da177e4SLinus Torvalds 	}
13171da177e4SLinus Torvalds 
13181da177e4SLinus Torvalds 	hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
13191da177e4SLinus Torvalds 	if (!hub->status) {
13201da177e4SLinus Torvalds 		ret = -ENOMEM;
13211da177e4SLinus Torvalds 		goto fail;
13221da177e4SLinus Torvalds 	}
1323db90e7a1SAlan Stern 	mutex_init(&hub->status_mutex);
13241da177e4SLinus Torvalds 
1325bec444cdSJohan Hovold 	hub->descriptor = kzalloc(sizeof(*hub->descriptor), GFP_KERNEL);
13261da177e4SLinus Torvalds 	if (!hub->descriptor) {
13271da177e4SLinus Torvalds 		ret = -ENOMEM;
13281da177e4SLinus Torvalds 		goto fail;
13291da177e4SLinus Torvalds 	}
13301da177e4SLinus Torvalds 
13311da177e4SLinus Torvalds 	/* Request the entire hub descriptor.
13321da177e4SLinus Torvalds 	 * hub->descriptor can handle USB_MAXCHILDREN ports,
13332c25a2c8SJohan Hovold 	 * but a (non-SS) hub can/will return fewer bytes here.
13341da177e4SLinus Torvalds 	 */
1335dbe79bbeSJohn Youn 	ret = get_hub_descriptor(hdev, hub->descriptor);
13361da177e4SLinus Torvalds 	if (ret < 0) {
13371da177e4SLinus Torvalds 		message = "can't read hub descriptor";
13381da177e4SLinus Torvalds 		goto fail;
133993491cedSJohan Hovold 	}
134093491cedSJohan Hovold 
134193491cedSJohan Hovold 	maxchild = USB_MAXCHILDREN;
134293491cedSJohan Hovold 	if (hub_is_superspeed(hdev))
134393491cedSJohan Hovold 		maxchild = min_t(unsigned, maxchild, USB_SS_MAXPORTS);
134493491cedSJohan Hovold 
134593491cedSJohan Hovold 	if (hub->descriptor->bNbrPorts > maxchild) {
13461da177e4SLinus Torvalds 		message = "hub has too many ports!";
13471da177e4SLinus Torvalds 		ret = -ENODEV;
13481da177e4SLinus Torvalds 		goto fail;
1349769d7368SDavid Linares 	} else if (hub->descriptor->bNbrPorts == 0) {
1350769d7368SDavid Linares 		message = "hub doesn't have any ports!";
1351769d7368SDavid Linares 		ret = -ENODEV;
1352769d7368SDavid Linares 		goto fail;
13531da177e4SLinus Torvalds 	}
13541da177e4SLinus Torvalds 
1355d8521afeSDan Williams 	maxchild = hub->descriptor->bNbrPorts;
1356d8521afeSDan Williams 	dev_info(hub_dev, "%d port%s detected\n", maxchild,
1357d8521afeSDan Williams 			(maxchild == 1) ? "" : "s");
13581da177e4SLinus Torvalds 
1359d8521afeSDan Williams 	hub->ports = kzalloc(maxchild * sizeof(struct usb_port *), GFP_KERNEL);
1360ff823c79SLan Tianyu 	if (!hub->ports) {
13617cbe5dcaSAlan Stern 		ret = -ENOMEM;
13627cbe5dcaSAlan Stern 		goto fail;
13637cbe5dcaSAlan Stern 	}
13647cbe5dcaSAlan Stern 
136574ad9bd2SGreg Kroah-Hartman 	wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1366430ee58eSSebastian Andrzej Siewior 	if (hub_is_superspeed(hdev)) {
1367430ee58eSSebastian Andrzej Siewior 		unit_load = 150;
1368430ee58eSSebastian Andrzej Siewior 		full_load = 900;
1369430ee58eSSebastian Andrzej Siewior 	} else {
1370430ee58eSSebastian Andrzej Siewior 		unit_load = 100;
1371430ee58eSSebastian Andrzej Siewior 		full_load = 500;
1372430ee58eSSebastian Andrzej Siewior 	}
13731da177e4SLinus Torvalds 
1374dbe79bbeSJohn Youn 	/* FIXME for USB 3.0, skip for now */
1375dbe79bbeSJohn Youn 	if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1376dbe79bbeSJohn Youn 			!(hub_is_superspeed(hdev))) {
13771da177e4SLinus Torvalds 		char	portstr[USB_MAXCHILDREN + 1];
13781da177e4SLinus Torvalds 
1379d8521afeSDan Williams 		for (i = 0; i < maxchild; i++)
1380dbe79bbeSJohn Youn 			portstr[i] = hub->descriptor->u.hs.DeviceRemovable
13811da177e4SLinus Torvalds 				    [((i + 1) / 8)] & (1 << ((i + 1) % 8))
13821da177e4SLinus Torvalds 				? 'F' : 'R';
1383d8521afeSDan Williams 		portstr[maxchild] = 0;
13841da177e4SLinus Torvalds 		dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
13851da177e4SLinus Torvalds 	} else
13861da177e4SLinus Torvalds 		dev_dbg(hub_dev, "standalone hub\n");
13871da177e4SLinus Torvalds 
138874ad9bd2SGreg Kroah-Hartman 	switch (wHubCharacteristics & HUB_CHAR_LPSM) {
13897bf01185SAman Deep 	case HUB_CHAR_COMMON_LPSM:
13901da177e4SLinus Torvalds 		dev_dbg(hub_dev, "ganged power switching\n");
13911da177e4SLinus Torvalds 		break;
13927bf01185SAman Deep 	case HUB_CHAR_INDV_PORT_LPSM:
13931da177e4SLinus Torvalds 		dev_dbg(hub_dev, "individual port power switching\n");
13941da177e4SLinus Torvalds 		break;
13957bf01185SAman Deep 	case HUB_CHAR_NO_LPSM:
13967bf01185SAman Deep 	case HUB_CHAR_LPSM:
13971da177e4SLinus Torvalds 		dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
13981da177e4SLinus Torvalds 		break;
13991da177e4SLinus Torvalds 	}
14001da177e4SLinus Torvalds 
140174ad9bd2SGreg Kroah-Hartman 	switch (wHubCharacteristics & HUB_CHAR_OCPM) {
14027bf01185SAman Deep 	case HUB_CHAR_COMMON_OCPM:
14031da177e4SLinus Torvalds 		dev_dbg(hub_dev, "global over-current protection\n");
14041da177e4SLinus Torvalds 		break;
14057bf01185SAman Deep 	case HUB_CHAR_INDV_PORT_OCPM:
14061da177e4SLinus Torvalds 		dev_dbg(hub_dev, "individual port over-current protection\n");
14071da177e4SLinus Torvalds 		break;
14087bf01185SAman Deep 	case HUB_CHAR_NO_OCPM:
14097bf01185SAman Deep 	case HUB_CHAR_OCPM:
14101da177e4SLinus Torvalds 		dev_dbg(hub_dev, "no over-current protection\n");
14111da177e4SLinus Torvalds 		break;
14121da177e4SLinus Torvalds 	}
14131da177e4SLinus Torvalds 
14141da177e4SLinus Torvalds 	spin_lock_init(&hub->tt.lock);
14151da177e4SLinus Torvalds 	INIT_LIST_HEAD(&hub->tt.clear_list);
1416cb88a1b8SAlan Stern 	INIT_WORK(&hub->tt.clear_work, hub_tt_work);
14171da177e4SLinus Torvalds 	switch (hdev->descriptor.bDeviceProtocol) {
14187bf01185SAman Deep 	case USB_HUB_PR_FS:
14191da177e4SLinus Torvalds 		break;
14207bf01185SAman Deep 	case USB_HUB_PR_HS_SINGLE_TT:
14211da177e4SLinus Torvalds 		dev_dbg(hub_dev, "Single TT\n");
14221da177e4SLinus Torvalds 		hub->tt.hub = hdev;
14231da177e4SLinus Torvalds 		break;
14247bf01185SAman Deep 	case USB_HUB_PR_HS_MULTI_TT:
14251da177e4SLinus Torvalds 		ret = usb_set_interface(hdev, 0, 1);
14261da177e4SLinus Torvalds 		if (ret == 0) {
14271da177e4SLinus Torvalds 			dev_dbg(hub_dev, "TT per port\n");
14281da177e4SLinus Torvalds 			hub->tt.multi = 1;
14291da177e4SLinus Torvalds 		} else
14301da177e4SLinus Torvalds 			dev_err(hub_dev, "Using single TT (err %d)\n",
14311da177e4SLinus Torvalds 				ret);
14321da177e4SLinus Torvalds 		hub->tt.hub = hdev;
14331da177e4SLinus Torvalds 		break;
14347bf01185SAman Deep 	case USB_HUB_PR_SS:
1435d2e9b4d6SSarah Sharp 		/* USB 3.0 hubs don't have a TT */
1436d2e9b4d6SSarah Sharp 		break;
14371da177e4SLinus Torvalds 	default:
14381da177e4SLinus Torvalds 		dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
14391da177e4SLinus Torvalds 			hdev->descriptor.bDeviceProtocol);
14401da177e4SLinus Torvalds 		break;
14411da177e4SLinus Torvalds 	}
14421da177e4SLinus Torvalds 
1443e09711aeSdavid-b@pacbell.net 	/* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
144474ad9bd2SGreg Kroah-Hartman 	switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1445e09711aeSdavid-b@pacbell.net 	case HUB_TTTT_8_BITS:
1446e09711aeSdavid-b@pacbell.net 		if (hdev->descriptor.bDeviceProtocol != 0) {
1447e09711aeSdavid-b@pacbell.net 			hub->tt.think_time = 666;
1448e09711aeSdavid-b@pacbell.net 			dev_dbg(hub_dev, "TT requires at most %d "
1449e09711aeSdavid-b@pacbell.net 					"FS bit times (%d ns)\n",
1450e09711aeSdavid-b@pacbell.net 				8, hub->tt.think_time);
1451e09711aeSdavid-b@pacbell.net 		}
14521da177e4SLinus Torvalds 		break;
1453e09711aeSdavid-b@pacbell.net 	case HUB_TTTT_16_BITS:
1454e09711aeSdavid-b@pacbell.net 		hub->tt.think_time = 666 * 2;
1455e09711aeSdavid-b@pacbell.net 		dev_dbg(hub_dev, "TT requires at most %d "
1456e09711aeSdavid-b@pacbell.net 				"FS bit times (%d ns)\n",
1457e09711aeSdavid-b@pacbell.net 			16, hub->tt.think_time);
14581da177e4SLinus Torvalds 		break;
1459e09711aeSdavid-b@pacbell.net 	case HUB_TTTT_24_BITS:
1460e09711aeSdavid-b@pacbell.net 		hub->tt.think_time = 666 * 3;
1461e09711aeSdavid-b@pacbell.net 		dev_dbg(hub_dev, "TT requires at most %d "
1462e09711aeSdavid-b@pacbell.net 				"FS bit times (%d ns)\n",
1463e09711aeSdavid-b@pacbell.net 			24, hub->tt.think_time);
14641da177e4SLinus Torvalds 		break;
1465e09711aeSdavid-b@pacbell.net 	case HUB_TTTT_32_BITS:
1466e09711aeSdavid-b@pacbell.net 		hub->tt.think_time = 666 * 4;
1467e09711aeSdavid-b@pacbell.net 		dev_dbg(hub_dev, "TT requires at most %d "
1468e09711aeSdavid-b@pacbell.net 				"FS bit times (%d ns)\n",
1469e09711aeSdavid-b@pacbell.net 			32, hub->tt.think_time);
14701da177e4SLinus Torvalds 		break;
14711da177e4SLinus Torvalds 	}
14721da177e4SLinus Torvalds 
14731da177e4SLinus Torvalds 	/* probe() zeroes hub->indicator[] */
147474ad9bd2SGreg Kroah-Hartman 	if (wHubCharacteristics & HUB_CHAR_PORTIND) {
14751da177e4SLinus Torvalds 		hub->has_indicators = 1;
14761da177e4SLinus Torvalds 		dev_dbg(hub_dev, "Port indicators are supported\n");
14771da177e4SLinus Torvalds 	}
14781da177e4SLinus Torvalds 
14791da177e4SLinus Torvalds 	dev_dbg(hub_dev, "power on to power good time: %dms\n",
14801da177e4SLinus Torvalds 		hub->descriptor->bPwrOn2PwrGood * 2);
14811da177e4SLinus Torvalds 
14821da177e4SLinus Torvalds 	/* power budgeting mostly matters with bus-powered hubs,
14831da177e4SLinus Torvalds 	 * and battery-powered root hubs (may provide just 8 mA).
14841da177e4SLinus Torvalds 	 */
14851da177e4SLinus Torvalds 	ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
148615b7336eSAlan Stern 	if (ret) {
14871da177e4SLinus Torvalds 		message = "can't get hub status";
14881da177e4SLinus Torvalds 		goto fail;
14891da177e4SLinus Torvalds 	}
1490430ee58eSSebastian Andrzej Siewior 	hcd = bus_to_hcd(hdev->bus);
14917d35b929SAlan Stern 	if (hdev == hdev->bus->root_hub) {
1492430ee58eSSebastian Andrzej Siewior 		if (hcd->power_budget > 0)
1493430ee58eSSebastian Andrzej Siewior 			hdev->bus_mA = hcd->power_budget;
1494430ee58eSSebastian Andrzej Siewior 		else
1495d8521afeSDan Williams 			hdev->bus_mA = full_load * maxchild;
1496430ee58eSSebastian Andrzej Siewior 		if (hdev->bus_mA >= full_load)
1497430ee58eSSebastian Andrzej Siewior 			hub->mA_per_port = full_load;
149855c52718SAlan Stern 		else {
149955c52718SAlan Stern 			hub->mA_per_port = hdev->bus_mA;
150055c52718SAlan Stern 			hub->limited_power = 1;
150155c52718SAlan Stern 		}
15027d35b929SAlan Stern 	} else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
150355c52718SAlan Stern 		int remaining = hdev->bus_mA -
150455c52718SAlan Stern 			hub->descriptor->bHubContrCurrent;
15051da177e4SLinus Torvalds 
1506430ee58eSSebastian Andrzej Siewior 		dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1507430ee58eSSebastian Andrzej Siewior 			hub->descriptor->bHubContrCurrent);
1508430ee58eSSebastian Andrzej Siewior 		hub->limited_power = 1;
1509430ee58eSSebastian Andrzej Siewior 
1510d8521afeSDan Williams 		if (remaining < maxchild * unit_load)
151155c52718SAlan Stern 			dev_warn(hub_dev,
151255c52718SAlan Stern 					"insufficient power available "
151355c52718SAlan Stern 					"to use all downstream ports\n");
1514430ee58eSSebastian Andrzej Siewior 		hub->mA_per_port = unit_load;	/* 7.2.1 */
1515430ee58eSSebastian Andrzej Siewior 
151655c52718SAlan Stern 	} else {	/* Self-powered external hub */
151755c52718SAlan Stern 		/* FIXME: What about battery-powered external hubs that
151855c52718SAlan Stern 		 * provide less current per port? */
1519430ee58eSSebastian Andrzej Siewior 		hub->mA_per_port = full_load;
152055c52718SAlan Stern 	}
1521430ee58eSSebastian Andrzej Siewior 	if (hub->mA_per_port < full_load)
152255c52718SAlan Stern 		dev_dbg(hub_dev, "%umA bus power budget for each child\n",
152355c52718SAlan Stern 				hub->mA_per_port);
15241da177e4SLinus Torvalds 
15251da177e4SLinus Torvalds 	ret = hub_hub_status(hub, &hubstatus, &hubchange);
15261da177e4SLinus Torvalds 	if (ret < 0) {
15271da177e4SLinus Torvalds 		message = "can't get hub status";
15281da177e4SLinus Torvalds 		goto fail;
15291da177e4SLinus Torvalds 	}
15301da177e4SLinus Torvalds 
15311da177e4SLinus Torvalds 	/* local power status reports aren't always correct */
15321da177e4SLinus Torvalds 	if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
15331da177e4SLinus Torvalds 		dev_dbg(hub_dev, "local power source is %s\n",
15341da177e4SLinus Torvalds 			(hubstatus & HUB_STATUS_LOCAL_POWER)
15351da177e4SLinus Torvalds 			? "lost (inactive)" : "good");
15361da177e4SLinus Torvalds 
153774ad9bd2SGreg Kroah-Hartman 	if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
15381da177e4SLinus Torvalds 		dev_dbg(hub_dev, "%sover-current condition exists\n",
15391da177e4SLinus Torvalds 			(hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
15401da177e4SLinus Torvalds 
154188fafff9Sinaky@linux.intel.com 	/* set up the interrupt endpoint
154288fafff9Sinaky@linux.intel.com 	 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
154388fafff9Sinaky@linux.intel.com 	 * bytes as USB2.0[11.12.3] says because some hubs are known
154488fafff9Sinaky@linux.intel.com 	 * to send more data (and thus cause overflow). For root hubs,
154588fafff9Sinaky@linux.intel.com 	 * maxpktsize is defined in hcd.c's fake endpoint descriptors
154688fafff9Sinaky@linux.intel.com 	 * to be big enough for at least USB_MAXCHILDREN ports. */
15471da177e4SLinus Torvalds 	pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
15481da177e4SLinus Torvalds 	maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
15491da177e4SLinus Torvalds 
15501da177e4SLinus Torvalds 	if (maxp > sizeof(*hub->buffer))
15511da177e4SLinus Torvalds 		maxp = sizeof(*hub->buffer);
15521da177e4SLinus Torvalds 
15531da177e4SLinus Torvalds 	hub->urb = usb_alloc_urb(0, GFP_KERNEL);
15541da177e4SLinus Torvalds 	if (!hub->urb) {
15551da177e4SLinus Torvalds 		ret = -ENOMEM;
15561da177e4SLinus Torvalds 		goto fail;
15571da177e4SLinus Torvalds 	}
15581da177e4SLinus Torvalds 
15591da177e4SLinus Torvalds 	usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
15601da177e4SLinus Torvalds 		hub, endpoint->bInterval);
15611da177e4SLinus Torvalds 
15621da177e4SLinus Torvalds 	/* maybe cycle the hub leds */
15631da177e4SLinus Torvalds 	if (hub->has_indicators && blinkenlights)
15641da177e4SLinus Torvalds 		hub->indicator[0] = INDICATOR_CYCLE;
15651da177e4SLinus Torvalds 
1566d8521afeSDan Williams 	mutex_lock(&usb_port_peer_mutex);
1567d8521afeSDan Williams 	for (i = 0; i < maxchild; i++) {
1568e58547ebSKrzysztof Mazur 		ret = usb_hub_create_port_device(hub, i + 1);
1569e58547ebSKrzysztof Mazur 		if (ret < 0) {
1570fa2a9566SLan Tianyu 			dev_err(hub->intfdev,
1571fa2a9566SLan Tianyu 				"couldn't create port%d device.\n", i + 1);
1572d8521afeSDan Williams 			break;
1573d8521afeSDan Williams 		}
1574d8521afeSDan Williams 	}
1575e58547ebSKrzysztof Mazur 	hdev->maxchild = i;
1576e3d10505SDan Williams 	for (i = 0; i < hdev->maxchild; i++) {
1577e3d10505SDan Williams 		struct usb_port *port_dev = hub->ports[i];
1578e3d10505SDan Williams 
1579e3d10505SDan Williams 		pm_runtime_put(&port_dev->dev);
1580e3d10505SDan Williams 	}
1581e3d10505SDan Williams 
1582d8521afeSDan Williams 	mutex_unlock(&usb_port_peer_mutex);
1583d8521afeSDan Williams 	if (ret < 0)
1584d8521afeSDan Williams 		goto fail;
1585fa2a9566SLan Tianyu 
158637ebb549SPetr Mladek 	/* Update the HCD's internal representation of this hub before hub_wq
1587e3d95580SDan Williams 	 * starts getting port status changes for devices under the hub.
1588e3d95580SDan Williams 	 */
1589e3d95580SDan Williams 	if (hcd->driver->update_hub_device) {
1590e3d95580SDan Williams 		ret = hcd->driver->update_hub_device(hcd, hdev,
1591e3d95580SDan Williams 				&hub->tt, GFP_KERNEL);
1592e3d95580SDan Williams 		if (ret < 0) {
1593e3d95580SDan Williams 			message = "can't update HCD hub info";
1594e3d95580SDan Williams 			goto fail;
1595e3d95580SDan Williams 		}
1596e3d95580SDan Williams 	}
1597e3d95580SDan Williams 
1598d2123fd9SLan Tianyu 	usb_hub_adjust_deviceremovable(hdev, hub->descriptor);
1599d2123fd9SLan Tianyu 
1600f2835219SAlan Stern 	hub_activate(hub, HUB_INIT);
16011da177e4SLinus Torvalds 	return 0;
16021da177e4SLinus Torvalds 
16031da177e4SLinus Torvalds fail:
16041da177e4SLinus Torvalds 	dev_err(hub_dev, "config failed, %s (err %d)\n",
16051da177e4SLinus Torvalds 			message, ret);
16061da177e4SLinus Torvalds 	/* hub_disconnect() frees urb and descriptor */
16071da177e4SLinus Torvalds 	return ret;
16081da177e4SLinus Torvalds }
16091da177e4SLinus Torvalds 
1610e8054854SAlan Stern static void hub_release(struct kref *kref)
1611e8054854SAlan Stern {
1612e8054854SAlan Stern 	struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1613e8054854SAlan Stern 
16145d14f323SPetr Mladek 	usb_put_dev(hub->hdev);
1615e8054854SAlan Stern 	usb_put_intf(to_usb_interface(hub->intfdev));
1616e8054854SAlan Stern 	kfree(hub);
1617e8054854SAlan Stern }
1618e8054854SAlan Stern 
16191da177e4SLinus Torvalds static unsigned highspeed_hubs;
16201da177e4SLinus Torvalds 
16211da177e4SLinus Torvalds static void hub_disconnect(struct usb_interface *intf)
16221da177e4SLinus Torvalds {
16231da177e4SLinus Torvalds 	struct usb_hub *hub = usb_get_intfdata(intf);
1624fa286188SGreg Kroah-Hartman 	struct usb_device *hdev = interface_to_usbdev(intf);
1625543d7784SAlan Stern 	int port1;
1626fa2a9566SLan Tianyu 
162732a69589SPetr Mladek 	/*
162832a69589SPetr Mladek 	 * Stop adding new hub events. We do not want to block here and thus
162932a69589SPetr Mladek 	 * will not try to remove any pending work item.
163032a69589SPetr Mladek 	 */
1631e8054854SAlan Stern 	hub->disconnected = 1;
16321da177e4SLinus Torvalds 
16337de18d8bSAlan Stern 	/* Disconnect all children and quiesce the hub */
16347de18d8bSAlan Stern 	hub->error = 0;
16354330354fSAlan Stern 	hub_quiesce(hub, HUB_DISCONNECT);
16367de18d8bSAlan Stern 
1637d8521afeSDan Williams 	mutex_lock(&usb_port_peer_mutex);
1638d8521afeSDan Williams 
1639543d7784SAlan Stern 	/* Avoid races with recursively_mark_NOTATTACHED() */
1640543d7784SAlan Stern 	spin_lock_irq(&device_state_lock);
1641543d7784SAlan Stern 	port1 = hdev->maxchild;
1642543d7784SAlan Stern 	hdev->maxchild = 0;
16438b28c752SAlan Stern 	usb_set_intfdata(intf, NULL);
1644543d7784SAlan Stern 	spin_unlock_irq(&device_state_lock);
16451f2235b8SAlexander Shishkin 
1646543d7784SAlan Stern 	for (; port1 > 0; --port1)
1647543d7784SAlan Stern 		usb_hub_remove_port_device(hub, port1);
16481da177e4SLinus Torvalds 
1649d8521afeSDan Williams 	mutex_unlock(&usb_port_peer_mutex);
1650d8521afeSDan Williams 
1651e8054854SAlan Stern 	if (hub->hdev->speed == USB_SPEED_HIGH)
16521da177e4SLinus Torvalds 		highspeed_hubs--;
16531da177e4SLinus Torvalds 
16541da177e4SLinus Torvalds 	usb_free_urb(hub->urb);
1655fa2a9566SLan Tianyu 	kfree(hub->ports);
16561da177e4SLinus Torvalds 	kfree(hub->descriptor);
16571da177e4SLinus Torvalds 	kfree(hub->status);
1658d697cddaSAlan Stern 	kfree(hub->buffer);
16591da177e4SLinus Torvalds 
1660971fcd49SLan Tianyu 	pm_suspend_ignore_children(&intf->dev, false);
1661e8054854SAlan Stern 	kref_put(&hub->kref, hub_release);
16621da177e4SLinus Torvalds }
16631da177e4SLinus Torvalds 
1664c94dc34fSEugene Korenevsky static bool hub_descriptor_is_sane(struct usb_host_interface *desc)
1665c94dc34fSEugene Korenevsky {
1666c94dc34fSEugene Korenevsky 	/* Some hubs have a subclass of 1, which AFAICT according to the */
1667c94dc34fSEugene Korenevsky 	/*  specs is not defined, but it works */
1668c94dc34fSEugene Korenevsky 	if (desc->desc.bInterfaceSubClass != 0 &&
1669c94dc34fSEugene Korenevsky 	    desc->desc.bInterfaceSubClass != 1)
1670c94dc34fSEugene Korenevsky 		return false;
1671c94dc34fSEugene Korenevsky 
1672c94dc34fSEugene Korenevsky 	/* Multiple endpoints? What kind of mutant ninja-hub is this? */
1673c94dc34fSEugene Korenevsky 	if (desc->desc.bNumEndpoints != 1)
1674c94dc34fSEugene Korenevsky 		return false;
1675c94dc34fSEugene Korenevsky 
1676c94dc34fSEugene Korenevsky 	/* If the first endpoint is not interrupt IN, we'd better punt! */
1677c94dc34fSEugene Korenevsky 	if (!usb_endpoint_is_int_in(&desc->endpoint[0].desc))
1678c94dc34fSEugene Korenevsky 		return false;
1679c94dc34fSEugene Korenevsky 
1680c94dc34fSEugene Korenevsky         return true;
1681c94dc34fSEugene Korenevsky }
1682c94dc34fSEugene Korenevsky 
16831da177e4SLinus Torvalds static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
16841da177e4SLinus Torvalds {
16851da177e4SLinus Torvalds 	struct usb_host_interface *desc;
16861da177e4SLinus Torvalds 	struct usb_device *hdev;
16871da177e4SLinus Torvalds 	struct usb_hub *hub;
16881da177e4SLinus Torvalds 
16891da177e4SLinus Torvalds 	desc = intf->cur_altsetting;
16901da177e4SLinus Torvalds 	hdev = interface_to_usbdev(intf);
16911da177e4SLinus Torvalds 
1692596d789aSMing Lei 	/*
1693596d789aSMing Lei 	 * Set default autosuspend delay as 0 to speedup bus suspend,
1694596d789aSMing Lei 	 * based on the below considerations:
1695596d789aSMing Lei 	 *
1696596d789aSMing Lei 	 * - Unlike other drivers, the hub driver does not rely on the
1697596d789aSMing Lei 	 *   autosuspend delay to provide enough time to handle a wakeup
1698596d789aSMing Lei 	 *   event, and the submitted status URB is just to check future
1699596d789aSMing Lei 	 *   change on hub downstream ports, so it is safe to do it.
1700596d789aSMing Lei 	 *
1701596d789aSMing Lei 	 * - The patch might cause one or more auto supend/resume for
1702596d789aSMing Lei 	 *   below very rare devices when they are plugged into hub
1703596d789aSMing Lei 	 *   first time:
1704596d789aSMing Lei 	 *
1705596d789aSMing Lei 	 *   	devices having trouble initializing, and disconnect
1706596d789aSMing Lei 	 *   	themselves from the bus and then reconnect a second
1707596d789aSMing Lei 	 *   	or so later
1708596d789aSMing Lei 	 *
1709596d789aSMing Lei 	 *   	devices just for downloading firmware, and disconnects
1710596d789aSMing Lei 	 *   	themselves after completing it
1711596d789aSMing Lei 	 *
1712596d789aSMing Lei 	 *   For these quite rare devices, their drivers may change the
1713596d789aSMing Lei 	 *   autosuspend delay of their parent hub in the probe() to one
1714596d789aSMing Lei 	 *   appropriate value to avoid the subtle problem if someone
1715596d789aSMing Lei 	 *   does care it.
1716596d789aSMing Lei 	 *
1717596d789aSMing Lei 	 * - The patch may cause one or more auto suspend/resume on
1718596d789aSMing Lei 	 *   hub during running 'lsusb', but it is probably too
1719596d789aSMing Lei 	 *   infrequent to worry about.
1720596d789aSMing Lei 	 *
1721596d789aSMing Lei 	 * - Change autosuspend delay of hub can avoid unnecessary auto
1722596d789aSMing Lei 	 *   suspend timer for hub, also may decrease power consumption
1723596d789aSMing Lei 	 *   of USB bus.
1724bdd405d2SRoger Quadros 	 *
1725bdd405d2SRoger Quadros 	 * - If user has indicated to prevent autosuspend by passing
1726bdd405d2SRoger Quadros 	 *   usbcore.autosuspend = -1 then keep autosuspend disabled.
1727596d789aSMing Lei 	 */
1728ceb6c9c8SRafael J. Wysocki #ifdef CONFIG_PM
1729bdd405d2SRoger Quadros 	if (hdev->dev.power.autosuspend_delay >= 0)
1730596d789aSMing Lei 		pm_runtime_set_autosuspend_delay(&hdev->dev, 0);
1731a9ef803dSGreg Kroah-Hartman #endif
1732596d789aSMing Lei 
17338ef42dddSAlan Stern 	/*
17348ef42dddSAlan Stern 	 * Hubs have proper suspend/resume support, except for root hubs
17358ef42dddSAlan Stern 	 * where the controller driver doesn't have bus_suspend and
17368ef42dddSAlan Stern 	 * bus_resume methods.
17378ef42dddSAlan Stern 	 */
17388ef42dddSAlan Stern 	if (hdev->parent) {		/* normal device */
1739088f7fecSAlan Stern 		usb_enable_autosuspend(hdev);
17408ef42dddSAlan Stern 	} else {			/* root hub */
17418ef42dddSAlan Stern 		const struct hc_driver *drv = bus_to_hcd(hdev->bus)->driver;
17428ef42dddSAlan Stern 
17438ef42dddSAlan Stern 		if (drv->bus_suspend && drv->bus_resume)
17448ef42dddSAlan Stern 			usb_enable_autosuspend(hdev);
17458ef42dddSAlan Stern 	}
1746088f7fecSAlan Stern 
174738f3ad5eSFelipe Balbi 	if (hdev->level == MAX_TOPO_LEVEL) {
1748b9cef6c3SWu Fengguang 		dev_err(&intf->dev,
1749b9cef6c3SWu Fengguang 			"Unsupported bus topology: hub nested too deep\n");
175038f3ad5eSFelipe Balbi 		return -E2BIG;
175138f3ad5eSFelipe Balbi 	}
175238f3ad5eSFelipe Balbi 
175389ccbdc9SDavid Brownell #ifdef	CONFIG_USB_OTG_BLACKLIST_HUB
175489ccbdc9SDavid Brownell 	if (hdev->parent) {
175589ccbdc9SDavid Brownell 		dev_warn(&intf->dev, "ignoring external hub\n");
175689ccbdc9SDavid Brownell 		return -ENODEV;
175789ccbdc9SDavid Brownell 	}
175889ccbdc9SDavid Brownell #endif
175989ccbdc9SDavid Brownell 
1760c94dc34fSEugene Korenevsky 	if (!hub_descriptor_is_sane(desc)) {
17611da177e4SLinus Torvalds 		dev_err(&intf->dev, "bad descriptor, ignoring hub\n");
17621da177e4SLinus Torvalds 		return -EIO;
17631da177e4SLinus Torvalds 	}
17641da177e4SLinus Torvalds 
17651da177e4SLinus Torvalds 	/* We found a hub */
17661da177e4SLinus Torvalds 	dev_info(&intf->dev, "USB hub found\n");
17671da177e4SLinus Torvalds 
17680a1ef3b5SAlan Stern 	hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1769b74e7062SWolfram Sang 	if (!hub)
17701da177e4SLinus Torvalds 		return -ENOMEM;
17711da177e4SLinus Torvalds 
1772e8054854SAlan Stern 	kref_init(&hub->kref);
17731da177e4SLinus Torvalds 	hub->intfdev = &intf->dev;
17741da177e4SLinus Torvalds 	hub->hdev = hdev;
1775c4028958SDavid Howells 	INIT_DELAYED_WORK(&hub->leds, led_work);
17768520f380SAlan Stern 	INIT_DELAYED_WORK(&hub->init_work, NULL);
177732a69589SPetr Mladek 	INIT_WORK(&hub->events, hub_event);
1778e8054854SAlan Stern 	usb_get_intf(intf);
17795d14f323SPetr Mladek 	usb_get_dev(hdev);
17801da177e4SLinus Torvalds 
17811da177e4SLinus Torvalds 	usb_set_intfdata(intf, hub);
178240f122f3SAlan Stern 	intf->needs_remote_wakeup = 1;
1783971fcd49SLan Tianyu 	pm_suspend_ignore_children(&intf->dev, true);
17841da177e4SLinus Torvalds 
17851da177e4SLinus Torvalds 	if (hdev->speed == USB_SPEED_HIGH)
17861da177e4SLinus Torvalds 		highspeed_hubs++;
17871da177e4SLinus Torvalds 
1788e6f30deaSMing Lei 	if (id->driver_info & HUB_QUIRK_CHECK_PORT_AUTOSUSPEND)
1789e6f30deaSMing Lei 		hub->quirk_check_port_auto_suspend = 1;
1790e6f30deaSMing Lei 
1791c94dc34fSEugene Korenevsky 	if (hub_configure(hub, &desc->endpoint[0].desc) >= 0)
17921da177e4SLinus Torvalds 		return 0;
17931da177e4SLinus Torvalds 
17941da177e4SLinus Torvalds 	hub_disconnect(intf);
17951da177e4SLinus Torvalds 	return -ENODEV;
17961da177e4SLinus Torvalds }
17971da177e4SLinus Torvalds 
17981da177e4SLinus Torvalds static int
17991da177e4SLinus Torvalds hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
18001da177e4SLinus Torvalds {
18011da177e4SLinus Torvalds 	struct usb_device *hdev = interface_to_usbdev(intf);
1802ad493e5eSLan Tianyu 	struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
18031da177e4SLinus Torvalds 
18041da177e4SLinus Torvalds 	/* assert ifno == 0 (part of hub spec) */
18051da177e4SLinus Torvalds 	switch (code) {
18061da177e4SLinus Torvalds 	case USBDEVFS_HUB_PORTINFO: {
18071da177e4SLinus Torvalds 		struct usbdevfs_hub_portinfo *info = user_data;
18081da177e4SLinus Torvalds 		int i;
18091da177e4SLinus Torvalds 
18101da177e4SLinus Torvalds 		spin_lock_irq(&device_state_lock);
18111da177e4SLinus Torvalds 		if (hdev->devnum <= 0)
18121da177e4SLinus Torvalds 			info->nports = 0;
18131da177e4SLinus Torvalds 		else {
18141da177e4SLinus Torvalds 			info->nports = hdev->maxchild;
18151da177e4SLinus Torvalds 			for (i = 0; i < info->nports; i++) {
1816ff823c79SLan Tianyu 				if (hub->ports[i]->child == NULL)
18171da177e4SLinus Torvalds 					info->port[i] = 0;
18181da177e4SLinus Torvalds 				else
18191da177e4SLinus Torvalds 					info->port[i] =
1820ff823c79SLan Tianyu 						hub->ports[i]->child->devnum;
18211da177e4SLinus Torvalds 			}
18221da177e4SLinus Torvalds 		}
18231da177e4SLinus Torvalds 		spin_unlock_irq(&device_state_lock);
18241da177e4SLinus Torvalds 
18251da177e4SLinus Torvalds 		return info->nports + 1;
18261da177e4SLinus Torvalds 		}
18271da177e4SLinus Torvalds 
18281da177e4SLinus Torvalds 	default:
18291da177e4SLinus Torvalds 		return -ENOSYS;
18301da177e4SLinus Torvalds 	}
18311da177e4SLinus Torvalds }
18321da177e4SLinus Torvalds 
18337cbe5dcaSAlan Stern /*
18347cbe5dcaSAlan Stern  * Allow user programs to claim ports on a hub.  When a device is attached
18357cbe5dcaSAlan Stern  * to one of these "claimed" ports, the program will "own" the device.
18367cbe5dcaSAlan Stern  */
18377cbe5dcaSAlan Stern static int find_port_owner(struct usb_device *hdev, unsigned port1,
18389b6f0c4bSValentina Manea 		struct usb_dev_state ***ppowner)
18397cbe5dcaSAlan Stern {
184041341261SMathias Nyman 	struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
184141341261SMathias Nyman 
18427cbe5dcaSAlan Stern 	if (hdev->state == USB_STATE_NOTATTACHED)
18437cbe5dcaSAlan Stern 		return -ENODEV;
18447cbe5dcaSAlan Stern 	if (port1 == 0 || port1 > hdev->maxchild)
18457cbe5dcaSAlan Stern 		return -EINVAL;
18467cbe5dcaSAlan Stern 
184741341261SMathias Nyman 	/* Devices not managed by the hub driver
18487cbe5dcaSAlan Stern 	 * will always have maxchild equal to 0.
18497cbe5dcaSAlan Stern 	 */
185041341261SMathias Nyman 	*ppowner = &(hub->ports[port1 - 1]->port_owner);
18517cbe5dcaSAlan Stern 	return 0;
18527cbe5dcaSAlan Stern }
18537cbe5dcaSAlan Stern 
18547cbe5dcaSAlan Stern /* In the following three functions, the caller must hold hdev's lock */
1855336c5c31SLan Tianyu int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
18569b6f0c4bSValentina Manea 		       struct usb_dev_state *owner)
18577cbe5dcaSAlan Stern {
18587cbe5dcaSAlan Stern 	int rc;
18599b6f0c4bSValentina Manea 	struct usb_dev_state **powner;
18607cbe5dcaSAlan Stern 
18617cbe5dcaSAlan Stern 	rc = find_port_owner(hdev, port1, &powner);
18627cbe5dcaSAlan Stern 	if (rc)
18637cbe5dcaSAlan Stern 		return rc;
18647cbe5dcaSAlan Stern 	if (*powner)
18657cbe5dcaSAlan Stern 		return -EBUSY;
18667cbe5dcaSAlan Stern 	*powner = owner;
18677cbe5dcaSAlan Stern 	return rc;
18687cbe5dcaSAlan Stern }
18696080cd0eSValentina Manea EXPORT_SYMBOL_GPL(usb_hub_claim_port);
18707cbe5dcaSAlan Stern 
1871336c5c31SLan Tianyu int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
18729b6f0c4bSValentina Manea 			 struct usb_dev_state *owner)
18737cbe5dcaSAlan Stern {
18747cbe5dcaSAlan Stern 	int rc;
18759b6f0c4bSValentina Manea 	struct usb_dev_state **powner;
18767cbe5dcaSAlan Stern 
18777cbe5dcaSAlan Stern 	rc = find_port_owner(hdev, port1, &powner);
18787cbe5dcaSAlan Stern 	if (rc)
18797cbe5dcaSAlan Stern 		return rc;
18807cbe5dcaSAlan Stern 	if (*powner != owner)
18817cbe5dcaSAlan Stern 		return -ENOENT;
18827cbe5dcaSAlan Stern 	*powner = NULL;
18837cbe5dcaSAlan Stern 	return rc;
18847cbe5dcaSAlan Stern }
18856080cd0eSValentina Manea EXPORT_SYMBOL_GPL(usb_hub_release_port);
18867cbe5dcaSAlan Stern 
18879b6f0c4bSValentina Manea void usb_hub_release_all_ports(struct usb_device *hdev, struct usb_dev_state *owner)
18887cbe5dcaSAlan Stern {
1889ad493e5eSLan Tianyu 	struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
18907cbe5dcaSAlan Stern 	int n;
18917cbe5dcaSAlan Stern 
1892fa2a9566SLan Tianyu 	for (n = 0; n < hdev->maxchild; n++) {
1893fa2a9566SLan Tianyu 		if (hub->ports[n]->port_owner == owner)
1894fa2a9566SLan Tianyu 			hub->ports[n]->port_owner = NULL;
18957cbe5dcaSAlan Stern 	}
1896fa2a9566SLan Tianyu 
18977cbe5dcaSAlan Stern }
18987cbe5dcaSAlan Stern 
18997cbe5dcaSAlan Stern /* The caller must hold udev's lock */
19007cbe5dcaSAlan Stern bool usb_device_is_owned(struct usb_device *udev)
19017cbe5dcaSAlan Stern {
19027cbe5dcaSAlan Stern 	struct usb_hub *hub;
19037cbe5dcaSAlan Stern 
19047cbe5dcaSAlan Stern 	if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
19057cbe5dcaSAlan Stern 		return false;
1906ad493e5eSLan Tianyu 	hub = usb_hub_to_struct_hub(udev->parent);
1907fa2a9566SLan Tianyu 	return !!hub->ports[udev->portnum - 1]->port_owner;
19087cbe5dcaSAlan Stern }
19097cbe5dcaSAlan Stern 
19101da177e4SLinus Torvalds static void recursively_mark_NOTATTACHED(struct usb_device *udev)
19111da177e4SLinus Torvalds {
1912ad493e5eSLan Tianyu 	struct usb_hub *hub = usb_hub_to_struct_hub(udev);
19131da177e4SLinus Torvalds 	int i;
19141da177e4SLinus Torvalds 
19151da177e4SLinus Torvalds 	for (i = 0; i < udev->maxchild; ++i) {
1916ff823c79SLan Tianyu 		if (hub->ports[i]->child)
1917ff823c79SLan Tianyu 			recursively_mark_NOTATTACHED(hub->ports[i]->child);
19181da177e4SLinus Torvalds 	}
19199bbdf1e0SAlan Stern 	if (udev->state == USB_STATE_SUSPENDED)
192015123006SSarah Sharp 		udev->active_duration -= jiffies;
19211da177e4SLinus Torvalds 	udev->state = USB_STATE_NOTATTACHED;
19221da177e4SLinus Torvalds }
19231da177e4SLinus Torvalds 
19241da177e4SLinus Torvalds /**
19251da177e4SLinus Torvalds  * usb_set_device_state - change a device's current state (usbcore, hcds)
19261da177e4SLinus Torvalds  * @udev: pointer to device whose state should be changed
19271da177e4SLinus Torvalds  * @new_state: new state value to be stored
19281da177e4SLinus Torvalds  *
19291da177e4SLinus Torvalds  * udev->state is _not_ fully protected by the device lock.  Although
19301da177e4SLinus Torvalds  * most transitions are made only while holding the lock, the state can
19311da177e4SLinus Torvalds  * can change to USB_STATE_NOTATTACHED at almost any time.  This
19321da177e4SLinus Torvalds  * is so that devices can be marked as disconnected as soon as possible,
19331da177e4SLinus Torvalds  * without having to wait for any semaphores to be released.  As a result,
19341da177e4SLinus Torvalds  * all changes to any device's state must be protected by the
19351da177e4SLinus Torvalds  * device_state_lock spinlock.
19361da177e4SLinus Torvalds  *
19371da177e4SLinus Torvalds  * Once a device has been added to the device tree, all changes to its state
19381da177e4SLinus Torvalds  * should be made using this routine.  The state should _not_ be set directly.
19391da177e4SLinus Torvalds  *
19401da177e4SLinus Torvalds  * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
19411da177e4SLinus Torvalds  * Otherwise udev->state is set to new_state, and if new_state is
19421da177e4SLinus Torvalds  * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
19431da177e4SLinus Torvalds  * to USB_STATE_NOTATTACHED.
19441da177e4SLinus Torvalds  */
19451da177e4SLinus Torvalds void usb_set_device_state(struct usb_device *udev,
19461da177e4SLinus Torvalds 		enum usb_device_state new_state)
19471da177e4SLinus Torvalds {
19481da177e4SLinus Torvalds 	unsigned long flags;
19494681b171SRafael J. Wysocki 	int wakeup = -1;
19501da177e4SLinus Torvalds 
19511da177e4SLinus Torvalds 	spin_lock_irqsave(&device_state_lock, flags);
19521da177e4SLinus Torvalds 	if (udev->state == USB_STATE_NOTATTACHED)
19531da177e4SLinus Torvalds 		;	/* do nothing */
1954b94dc6b5SDavid Brownell 	else if (new_state != USB_STATE_NOTATTACHED) {
1955fb669cc0SDavid Brownell 
1956fb669cc0SDavid Brownell 		/* root hub wakeup capabilities are managed out-of-band
1957fb669cc0SDavid Brownell 		 * and may involve silicon errata ... ignore them here.
1958fb669cc0SDavid Brownell 		 */
1959fb669cc0SDavid Brownell 		if (udev->parent) {
1960645daaabSAlan Stern 			if (udev->state == USB_STATE_SUSPENDED
1961645daaabSAlan Stern 					|| new_state == USB_STATE_SUSPENDED)
1962645daaabSAlan Stern 				;	/* No change to wakeup settings */
1963645daaabSAlan Stern 			else if (new_state == USB_STATE_CONFIGURED)
1964ddbe1fcaSLu Baolu 				wakeup = (udev->quirks &
1965ddbe1fcaSLu Baolu 					USB_QUIRK_IGNORE_REMOTE_WAKEUP) ? 0 :
1966ddbe1fcaSLu Baolu 					udev->actconfig->desc.bmAttributes &
1967ddbe1fcaSLu Baolu 					USB_CONFIG_ATT_WAKEUP;
1968645daaabSAlan Stern 			else
19694681b171SRafael J. Wysocki 				wakeup = 0;
1970fb669cc0SDavid Brownell 		}
197115123006SSarah Sharp 		if (udev->state == USB_STATE_SUSPENDED &&
197215123006SSarah Sharp 			new_state != USB_STATE_SUSPENDED)
197315123006SSarah Sharp 			udev->active_duration -= jiffies;
197415123006SSarah Sharp 		else if (new_state == USB_STATE_SUSPENDED &&
197515123006SSarah Sharp 				udev->state != USB_STATE_SUSPENDED)
197615123006SSarah Sharp 			udev->active_duration += jiffies;
1977645daaabSAlan Stern 		udev->state = new_state;
1978b94dc6b5SDavid Brownell 	} else
19791da177e4SLinus Torvalds 		recursively_mark_NOTATTACHED(udev);
19801da177e4SLinus Torvalds 	spin_unlock_irqrestore(&device_state_lock, flags);
19814681b171SRafael J. Wysocki 	if (wakeup >= 0)
19824681b171SRafael J. Wysocki 		device_set_wakeup_capable(&udev->dev, wakeup);
19831da177e4SLinus Torvalds }
19846da9c990SDavid Vrabel EXPORT_SYMBOL_GPL(usb_set_device_state);
19851da177e4SLinus Torvalds 
19868af548dcSInaky Perez-Gonzalez /*
19873b29b68bSAlan Stern  * Choose a device number.
19883b29b68bSAlan Stern  *
19893b29b68bSAlan Stern  * Device numbers are used as filenames in usbfs.  On USB-1.1 and
19903b29b68bSAlan Stern  * USB-2.0 buses they are also used as device addresses, however on
19913b29b68bSAlan Stern  * USB-3.0 buses the address is assigned by the controller hardware
19923b29b68bSAlan Stern  * and it usually is not the same as the device number.
19933b29b68bSAlan Stern  *
19948af548dcSInaky Perez-Gonzalez  * WUSB devices are simple: they have no hubs behind, so the mapping
19958af548dcSInaky Perez-Gonzalez  * device <-> virtual port number becomes 1:1. Why? to simplify the
19968af548dcSInaky Perez-Gonzalez  * life of the device connection logic in
19978af548dcSInaky Perez-Gonzalez  * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
19988af548dcSInaky Perez-Gonzalez  * handshake we need to assign a temporary address in the unauthorized
19998af548dcSInaky Perez-Gonzalez  * space. For simplicity we use the first virtual port number found to
20008af548dcSInaky Perez-Gonzalez  * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
20018af548dcSInaky Perez-Gonzalez  * and that becomes it's address [X < 128] or its unauthorized address
20028af548dcSInaky Perez-Gonzalez  * [X | 0x80].
20038af548dcSInaky Perez-Gonzalez  *
20048af548dcSInaky Perez-Gonzalez  * We add 1 as an offset to the one-based USB-stack port number
20058af548dcSInaky Perez-Gonzalez  * (zero-based wusb virtual port index) for two reasons: (a) dev addr
20068af548dcSInaky Perez-Gonzalez  * 0 is reserved by USB for default address; (b) Linux's USB stack
20078af548dcSInaky Perez-Gonzalez  * uses always #1 for the root hub of the controller. So USB stack's
20088af548dcSInaky Perez-Gonzalez  * port #1, which is wusb virtual-port #0 has address #2.
2009c6515272SSarah Sharp  *
2010c6515272SSarah Sharp  * Devices connected under xHCI are not as simple.  The host controller
2011c6515272SSarah Sharp  * supports virtualization, so the hardware assigns device addresses and
2012c6515272SSarah Sharp  * the HCD must setup data structures before issuing a set address
2013c6515272SSarah Sharp  * command to the hardware.
20148af548dcSInaky Perez-Gonzalez  */
20153b29b68bSAlan Stern static void choose_devnum(struct usb_device *udev)
20161da177e4SLinus Torvalds {
20171da177e4SLinus Torvalds 	int		devnum;
20181da177e4SLinus Torvalds 	struct usb_bus	*bus = udev->bus;
20191da177e4SLinus Torvalds 
2020638139ebSPetr Mladek 	/* be safe when more hub events are proceed in parallel */
2021feb26ac3SChris Bainbridge 	mutex_lock(&bus->devnum_next_mutex);
20228af548dcSInaky Perez-Gonzalez 	if (udev->wusb) {
20238af548dcSInaky Perez-Gonzalez 		devnum = udev->portnum + 1;
20248af548dcSInaky Perez-Gonzalez 		BUG_ON(test_bit(devnum, bus->devmap.devicemap));
20258af548dcSInaky Perez-Gonzalez 	} else {
20268af548dcSInaky Perez-Gonzalez 		/* Try to allocate the next devnum beginning at
20278af548dcSInaky Perez-Gonzalez 		 * bus->devnum_next. */
20281da177e4SLinus Torvalds 		devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
20291da177e4SLinus Torvalds 					    bus->devnum_next);
20301da177e4SLinus Torvalds 		if (devnum >= 128)
20318af548dcSInaky Perez-Gonzalez 			devnum = find_next_zero_bit(bus->devmap.devicemap,
20328af548dcSInaky Perez-Gonzalez 						    128, 1);
20331da177e4SLinus Torvalds 		bus->devnum_next = (devnum >= 127 ? 1 : devnum + 1);
20348af548dcSInaky Perez-Gonzalez 	}
20351da177e4SLinus Torvalds 	if (devnum < 128) {
20361da177e4SLinus Torvalds 		set_bit(devnum, bus->devmap.devicemap);
20371da177e4SLinus Torvalds 		udev->devnum = devnum;
20381da177e4SLinus Torvalds 	}
2039feb26ac3SChris Bainbridge 	mutex_unlock(&bus->devnum_next_mutex);
20401da177e4SLinus Torvalds }
20411da177e4SLinus Torvalds 
20423b29b68bSAlan Stern static void release_devnum(struct usb_device *udev)
20431da177e4SLinus Torvalds {
20441da177e4SLinus Torvalds 	if (udev->devnum > 0) {
20451da177e4SLinus Torvalds 		clear_bit(udev->devnum, udev->bus->devmap.devicemap);
20461da177e4SLinus Torvalds 		udev->devnum = -1;
20471da177e4SLinus Torvalds 	}
20481da177e4SLinus Torvalds }
20491da177e4SLinus Torvalds 
20503b29b68bSAlan Stern static void update_devnum(struct usb_device *udev, int devnum)
20514953d141SDavid Vrabel {
20524953d141SDavid Vrabel 	/* The address for a WUSB device is managed by wusbcore. */
20534953d141SDavid Vrabel 	if (!udev->wusb)
20544953d141SDavid Vrabel 		udev->devnum = devnum;
20554953d141SDavid Vrabel }
20564953d141SDavid Vrabel 
2057f7410cedSHerbert Xu static void hub_free_dev(struct usb_device *udev)
2058f7410cedSHerbert Xu {
2059f7410cedSHerbert Xu 	struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2060f7410cedSHerbert Xu 
2061f7410cedSHerbert Xu 	/* Root hubs aren't real devices, so don't free HCD resources */
2062f7410cedSHerbert Xu 	if (hcd->driver->free_dev && udev->parent)
2063f7410cedSHerbert Xu 		hcd->driver->free_dev(hcd, udev);
2064f7410cedSHerbert Xu }
2065f7410cedSHerbert Xu 
20667027df36SDan Williams static void hub_disconnect_children(struct usb_device *udev)
20677027df36SDan Williams {
20687027df36SDan Williams 	struct usb_hub *hub = usb_hub_to_struct_hub(udev);
20697027df36SDan Williams 	int i;
20707027df36SDan Williams 
20717027df36SDan Williams 	/* Free up all the children before we remove this device */
20727027df36SDan Williams 	for (i = 0; i < udev->maxchild; i++) {
20737027df36SDan Williams 		if (hub->ports[i]->child)
20747027df36SDan Williams 			usb_disconnect(&hub->ports[i]->child);
20757027df36SDan Williams 	}
20767027df36SDan Williams }
20777027df36SDan Williams 
20781da177e4SLinus Torvalds /**
20791da177e4SLinus Torvalds  * usb_disconnect - disconnect a device (usbcore-internal)
20801da177e4SLinus Torvalds  * @pdev: pointer to device being disconnected
20811da177e4SLinus Torvalds  * Context: !in_interrupt ()
20821da177e4SLinus Torvalds  *
20831da177e4SLinus Torvalds  * Something got disconnected. Get rid of it and all of its children.
20841da177e4SLinus Torvalds  *
20851da177e4SLinus Torvalds  * If *pdev is a normal device then the parent hub must already be locked.
2086a4b5d606SHeiner Kallweit  * If *pdev is a root hub then the caller must hold the usb_bus_idr_lock,
2087db8f2aa3SBjorn Helgaas  * which protects the set of root hubs as well as the list of buses.
20881da177e4SLinus Torvalds  *
20891da177e4SLinus Torvalds  * Only hub drivers (including virtual root hub drivers for host
20901da177e4SLinus Torvalds  * controllers) should ever call this.
20911da177e4SLinus Torvalds  *
20921da177e4SLinus Torvalds  * This call is synchronous, and may not be used in an interrupt context.
20931da177e4SLinus Torvalds  */
20941da177e4SLinus Torvalds void usb_disconnect(struct usb_device **pdev)
20951da177e4SLinus Torvalds {
20967027df36SDan Williams 	struct usb_port *port_dev = NULL;
20971da177e4SLinus Torvalds 	struct usb_device *udev = *pdev;
20985b1dc209SPeter Chen 	struct usb_hub *hub = NULL;
20995b1dc209SPeter Chen 	int port1 = 1;
21001da177e4SLinus Torvalds 
21011da177e4SLinus Torvalds 	/* mark the device as inactive, so any further urb submissions for
21021da177e4SLinus Torvalds 	 * this device (and any of its children) will fail immediately.
210325985edcSLucas De Marchi 	 * this quiesces everything except pending urbs.
21041da177e4SLinus Torvalds 	 */
21051da177e4SLinus Torvalds 	usb_set_device_state(udev, USB_STATE_NOTATTACHED);
21063b29b68bSAlan Stern 	dev_info(&udev->dev, "USB disconnect, device number %d\n",
21073b29b68bSAlan Stern 			udev->devnum);
21081da177e4SLinus Torvalds 
2109f5cccf49SGuenter Roeck 	/*
2110f5cccf49SGuenter Roeck 	 * Ensure that the pm runtime code knows that the USB device
2111f5cccf49SGuenter Roeck 	 * is in the process of being disconnected.
2112f5cccf49SGuenter Roeck 	 */
2113f5cccf49SGuenter Roeck 	pm_runtime_barrier(&udev->dev);
2114f5cccf49SGuenter Roeck 
21159ad3d6ccSAlan Stern 	usb_lock_device(udev);
21169ad3d6ccSAlan Stern 
21177027df36SDan Williams 	hub_disconnect_children(udev);
21181da177e4SLinus Torvalds 
21191da177e4SLinus Torvalds 	/* deallocate hcd/hardware state ... nuking all pending urbs and
21201da177e4SLinus Torvalds 	 * cleaning up all state associated with the current configuration
21211da177e4SLinus Torvalds 	 * so that the hardware is now fully quiesced.
21221da177e4SLinus Torvalds 	 */
2123782da727SAlan Stern 	dev_dbg(&udev->dev, "unregistering device\n");
21241da177e4SLinus Torvalds 	usb_disable_device(udev, 0);
2125cde217a5SAlan Stern 	usb_hcd_synchronize_unlinks(udev);
21261da177e4SLinus Torvalds 
2127fde26380SLan Tianyu 	if (udev->parent) {
21287027df36SDan Williams 		port1 = udev->portnum;
21297027df36SDan Williams 		hub = usb_hub_to_struct_hub(udev->parent);
21307027df36SDan Williams 		port_dev = hub->ports[port1 - 1];
2131fde26380SLan Tianyu 
2132fde26380SLan Tianyu 		sysfs_remove_link(&udev->dev.kobj, "port");
2133fde26380SLan Tianyu 		sysfs_remove_link(&port_dev->dev.kobj, "device");
2134971fcd49SLan Tianyu 
21357027df36SDan Williams 		/*
21367027df36SDan Williams 		 * As usb_port_runtime_resume() de-references udev, make
21377027df36SDan Williams 		 * sure no resumes occur during removal
21387027df36SDan Williams 		 */
21397027df36SDan Williams 		if (!test_and_set_bit(port1, hub->child_usage_bits))
21407027df36SDan Williams 			pm_runtime_get_sync(&port_dev->dev);
2141fde26380SLan Tianyu 	}
2142fde26380SLan Tianyu 
21433b23dd6fSAlan Stern 	usb_remove_ep_devs(&udev->ep0);
2144782da727SAlan Stern 	usb_unlock_device(udev);
21453099e75aSGreg Kroah-Hartman 
2146782da727SAlan Stern 	/* Unregister the device.  The device driver is responsible
21473b23dd6fSAlan Stern 	 * for de-configuring the device and invoking the remove-device
21483b23dd6fSAlan Stern 	 * notifier chain (used by usbfs and possibly others).
2149782da727SAlan Stern 	 */
2150782da727SAlan Stern 	device_del(&udev->dev);
2151782da727SAlan Stern 
2152782da727SAlan Stern 	/* Free the device number and delete the parent's children[]
21531da177e4SLinus Torvalds 	 * (or root_hub) pointer.
21541da177e4SLinus Torvalds 	 */
21553b29b68bSAlan Stern 	release_devnum(udev);
21561da177e4SLinus Torvalds 
21571da177e4SLinus Torvalds 	/* Avoid races with recursively_mark_NOTATTACHED() */
21581da177e4SLinus Torvalds 	spin_lock_irq(&device_state_lock);
21591da177e4SLinus Torvalds 	*pdev = NULL;
21601da177e4SLinus Torvalds 	spin_unlock_irq(&device_state_lock);
21611da177e4SLinus Torvalds 
21627027df36SDan Williams 	if (port_dev && test_and_clear_bit(port1, hub->child_usage_bits))
21637027df36SDan Williams 		pm_runtime_put(&port_dev->dev);
21647027df36SDan Williams 
2165f7410cedSHerbert Xu 	hub_free_dev(udev);
2166f7410cedSHerbert Xu 
2167782da727SAlan Stern 	put_device(&udev->dev);
21681da177e4SLinus Torvalds }
21691da177e4SLinus Torvalds 
2170f2a383e4SGreg Kroah-Hartman #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
21711da177e4SLinus Torvalds static void show_string(struct usb_device *udev, char *id, char *string)
21721da177e4SLinus Torvalds {
21731da177e4SLinus Torvalds 	if (!string)
21741da177e4SLinus Torvalds 		return;
2175f2ec522eSJoe Perches 	dev_info(&udev->dev, "%s: %s\n", id, string);
21761da177e4SLinus Torvalds }
21771da177e4SLinus Torvalds 
2178f2a383e4SGreg Kroah-Hartman static void announce_device(struct usb_device *udev)
2179f2a383e4SGreg Kroah-Hartman {
2180f2a383e4SGreg Kroah-Hartman 	dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2181f2a383e4SGreg Kroah-Hartman 		le16_to_cpu(udev->descriptor.idVendor),
2182f2a383e4SGreg Kroah-Hartman 		le16_to_cpu(udev->descriptor.idProduct));
2183b9cef6c3SWu Fengguang 	dev_info(&udev->dev,
2184b9cef6c3SWu Fengguang 		"New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2185f2a383e4SGreg Kroah-Hartman 		udev->descriptor.iManufacturer,
2186f2a383e4SGreg Kroah-Hartman 		udev->descriptor.iProduct,
2187f2a383e4SGreg Kroah-Hartman 		udev->descriptor.iSerialNumber);
2188f2a383e4SGreg Kroah-Hartman 	show_string(udev, "Product", udev->product);
2189f2a383e4SGreg Kroah-Hartman 	show_string(udev, "Manufacturer", udev->manufacturer);
2190f2a383e4SGreg Kroah-Hartman 	show_string(udev, "SerialNumber", udev->serial);
2191f2a383e4SGreg Kroah-Hartman }
21921da177e4SLinus Torvalds #else
2193f2a383e4SGreg Kroah-Hartman static inline void announce_device(struct usb_device *udev) { }
21941da177e4SLinus Torvalds #endif
21951da177e4SLinus Torvalds 
21961da177e4SLinus Torvalds 
21973ede760fSOliver Neukum /**
21988d8558d1SAlan Stern  * usb_enumerate_device_otg - FIXME (usbcore-internal)
21993ede760fSOliver Neukum  * @udev: newly addressed device (in ADDRESS state)
22003ede760fSOliver Neukum  *
22018d8558d1SAlan Stern  * Finish enumeration for On-The-Go devices
2202626f090cSYacine Belkadi  *
2203626f090cSYacine Belkadi  * Return: 0 if successful. A negative error code otherwise.
22043ede760fSOliver Neukum  */
22058d8558d1SAlan Stern static int usb_enumerate_device_otg(struct usb_device *udev)
22061da177e4SLinus Torvalds {
2207d9d16e8aSInaky Perez-Gonzalez 	int err = 0;
22081da177e4SLinus Torvalds 
22091da177e4SLinus Torvalds #ifdef	CONFIG_USB_OTG
22101da177e4SLinus Torvalds 	/*
22111da177e4SLinus Torvalds 	 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
22121da177e4SLinus Torvalds 	 * to wake us after we've powered off VBUS; and HNP, switching roles
22131da177e4SLinus Torvalds 	 * "host" to "peripheral".  The OTG descriptor helps figure this out.
22141da177e4SLinus Torvalds 	 */
22151da177e4SLinus Torvalds 	if (!udev->bus->is_b_host
22161da177e4SLinus Torvalds 			&& udev->config
22171da177e4SLinus Torvalds 			&& udev->parent == udev->bus->root_hub) {
22182eb5052eSFelipe Balbi 		struct usb_otg_descriptor	*desc = NULL;
22191da177e4SLinus Torvalds 		struct usb_bus			*bus = udev->bus;
222012c3da34SAlan Stern 		unsigned			port1 = udev->portnum;
22211da177e4SLinus Torvalds 
22227d2d641cSLi Jun 		/* descriptor may appear anywhere in config */
22237d2d641cSLi Jun 		err = __usb_get_extra_descriptor(udev->rawdescriptors[0],
22247d2d641cSLi Jun 				le16_to_cpu(udev->config[0].desc.wTotalLength),
22257d2d641cSLi Jun 				USB_DT_OTG, (void **) &desc);
22267d2d641cSLi Jun 		if (err || !(desc->bmAttributes & USB_OTG_HNP))
22277d2d641cSLi Jun 			return 0;
22287d2d641cSLi Jun 
22297d2d641cSLi Jun 		dev_info(&udev->dev, "Dual-Role OTG device on %sHNP port\n",
22307d2d641cSLi Jun 					(port1 == bus->otg_port) ? "" : "non-");
22311da177e4SLinus Torvalds 
22321da177e4SLinus Torvalds 		/* enable HNP before suspend, it's simpler */
22337d2d641cSLi Jun 		if (port1 == bus->otg_port) {
22341da177e4SLinus Torvalds 			bus->b_hnp_enable = 1;
22351da177e4SLinus Torvalds 			err = usb_control_msg(udev,
22361da177e4SLinus Torvalds 				usb_sndctrlpipe(udev, 0),
22371da177e4SLinus Torvalds 				USB_REQ_SET_FEATURE, 0,
22387d2d641cSLi Jun 				USB_DEVICE_B_HNP_ENABLE,
22397d2d641cSLi Jun 				0, NULL, 0,
22407d2d641cSLi Jun 				USB_CTRL_SET_TIMEOUT);
22411da177e4SLinus Torvalds 			if (err < 0) {
22427d2d641cSLi Jun 				/*
22437d2d641cSLi Jun 				 * OTG MESSAGE: report errors here,
22441da177e4SLinus Torvalds 				 * customize to match your product.
22451da177e4SLinus Torvalds 				 */
22467d2d641cSLi Jun 				dev_err(&udev->dev, "can't set HNP mode: %d\n",
22471da177e4SLinus Torvalds 									err);
22481da177e4SLinus Torvalds 				bus->b_hnp_enable = 0;
22491da177e4SLinus Torvalds 			}
22507d2d641cSLi Jun 		} else if (desc->bLength == sizeof
22517d2d641cSLi Jun 				(struct usb_otg_descriptor)) {
22527d2d641cSLi Jun 			/* Set a_alt_hnp_support for legacy otg device */
22537d2d641cSLi Jun 			err = usb_control_msg(udev,
22547d2d641cSLi Jun 				usb_sndctrlpipe(udev, 0),
22557d2d641cSLi Jun 				USB_REQ_SET_FEATURE, 0,
22567d2d641cSLi Jun 				USB_DEVICE_A_ALT_HNP_SUPPORT,
22577d2d641cSLi Jun 				0, NULL, 0,
22587d2d641cSLi Jun 				USB_CTRL_SET_TIMEOUT);
22597d2d641cSLi Jun 			if (err < 0)
22607d2d641cSLi Jun 				dev_err(&udev->dev,
22617d2d641cSLi Jun 					"set a_alt_hnp_support failed: %d\n",
22627d2d641cSLi Jun 					err);
22631da177e4SLinus Torvalds 		}
22641da177e4SLinus Torvalds 	}
22651da177e4SLinus Torvalds #endif
2266d9d16e8aSInaky Perez-Gonzalez 	return err;
2267d9d16e8aSInaky Perez-Gonzalez }
22681da177e4SLinus Torvalds 
2269d9d16e8aSInaky Perez-Gonzalez 
2270d9d16e8aSInaky Perez-Gonzalez /**
22718d8558d1SAlan Stern  * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2272d9d16e8aSInaky Perez-Gonzalez  * @udev: newly addressed device (in ADDRESS state)
2273d9d16e8aSInaky Perez-Gonzalez  *
2274d9d16e8aSInaky Perez-Gonzalez  * This is only called by usb_new_device() and usb_authorize_device()
2275d9d16e8aSInaky Perez-Gonzalez  * and FIXME -- all comments that apply to them apply here wrt to
2276d9d16e8aSInaky Perez-Gonzalez  * environment.
2277d9d16e8aSInaky Perez-Gonzalez  *
2278d9d16e8aSInaky Perez-Gonzalez  * If the device is WUSB and not authorized, we don't attempt to read
2279d9d16e8aSInaky Perez-Gonzalez  * the string descriptors, as they will be errored out by the device
2280d9d16e8aSInaky Perez-Gonzalez  * until it has been authorized.
2281626f090cSYacine Belkadi  *
2282626f090cSYacine Belkadi  * Return: 0 if successful. A negative error code otherwise.
2283d9d16e8aSInaky Perez-Gonzalez  */
22848d8558d1SAlan Stern static int usb_enumerate_device(struct usb_device *udev)
2285d9d16e8aSInaky Perez-Gonzalez {
2286d9d16e8aSInaky Perez-Gonzalez 	int err;
2287026f3fcbSPeter Chen 	struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2288d9d16e8aSInaky Perez-Gonzalez 
2289d9d16e8aSInaky Perez-Gonzalez 	if (udev->config == NULL) {
2290d9d16e8aSInaky Perez-Gonzalez 		err = usb_get_configuration(udev);
2291d9d16e8aSInaky Perez-Gonzalez 		if (err < 0) {
2292e9e88fb7SAlan Stern 			if (err != -ENODEV)
2293d9d16e8aSInaky Perez-Gonzalez 				dev_err(&udev->dev, "can't read configurations, error %d\n",
2294d9d16e8aSInaky Perez-Gonzalez 						err);
229580da2e0dSLaurent Pinchart 			return err;
2296d9d16e8aSInaky Perez-Gonzalez 		}
2297d9d16e8aSInaky Perez-Gonzalez 	}
229883e83ecbSThomas Pugliese 
2299d9d16e8aSInaky Perez-Gonzalez 	/* read the standard strings and cache them if present */
2300d9d16e8aSInaky Perez-Gonzalez 	udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
2301d9d16e8aSInaky Perez-Gonzalez 	udev->manufacturer = usb_cache_string(udev,
2302d9d16e8aSInaky Perez-Gonzalez 					      udev->descriptor.iManufacturer);
2303d9d16e8aSInaky Perez-Gonzalez 	udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
230483e83ecbSThomas Pugliese 
23058d8558d1SAlan Stern 	err = usb_enumerate_device_otg(udev);
230680da2e0dSLaurent Pinchart 	if (err < 0)
2307d9d16e8aSInaky Perez-Gonzalez 		return err;
230880da2e0dSLaurent Pinchart 
2309026f3fcbSPeter Chen 	if (IS_ENABLED(CONFIG_USB_OTG_WHITELIST) && hcd->tpl_support &&
2310e5a9d621SPeter Chen 		!is_targeted(udev)) {
2311026f3fcbSPeter Chen 		/* Maybe it can talk to us, though we can't talk to it.
2312026f3fcbSPeter Chen 		 * (Includes HNP test device.)
2313026f3fcbSPeter Chen 		 */
2314e5a9d621SPeter Chen 		if (IS_ENABLED(CONFIG_USB_OTG) && (udev->bus->b_hnp_enable
2315e5a9d621SPeter Chen 			|| udev->bus->is_b_host)) {
2316026f3fcbSPeter Chen 			err = usb_port_suspend(udev, PMSG_AUTO_SUSPEND);
2317026f3fcbSPeter Chen 			if (err < 0)
2318026f3fcbSPeter Chen 				dev_dbg(&udev->dev, "HNP fail, %d\n", err);
2319026f3fcbSPeter Chen 		}
2320026f3fcbSPeter Chen 		return -ENOTSUPP;
2321026f3fcbSPeter Chen 	}
2322026f3fcbSPeter Chen 
232380da2e0dSLaurent Pinchart 	usb_detect_interface_quirks(udev);
232480da2e0dSLaurent Pinchart 
232580da2e0dSLaurent Pinchart 	return 0;
2326d9d16e8aSInaky Perez-Gonzalez }
2327d9d16e8aSInaky Perez-Gonzalez 
2328d35e70d5SMatthew Garrett static void set_usb_port_removable(struct usb_device *udev)
2329d35e70d5SMatthew Garrett {
2330d35e70d5SMatthew Garrett 	struct usb_device *hdev = udev->parent;
2331d35e70d5SMatthew Garrett 	struct usb_hub *hub;
2332d35e70d5SMatthew Garrett 	u8 port = udev->portnum;
2333d35e70d5SMatthew Garrett 	u16 wHubCharacteristics;
2334d35e70d5SMatthew Garrett 	bool removable = true;
2335d35e70d5SMatthew Garrett 
2336d35e70d5SMatthew Garrett 	if (!hdev)
2337d35e70d5SMatthew Garrett 		return;
2338d35e70d5SMatthew Garrett 
2339ad493e5eSLan Tianyu 	hub = usb_hub_to_struct_hub(udev->parent);
2340d35e70d5SMatthew Garrett 
234192bfbf71SMatthew Garrett 	/*
234292bfbf71SMatthew Garrett 	 * If the platform firmware has provided information about a port,
234392bfbf71SMatthew Garrett 	 * use that to determine whether it's removable.
234492bfbf71SMatthew Garrett 	 */
234592bfbf71SMatthew Garrett 	switch (hub->ports[udev->portnum - 1]->connect_type) {
234692bfbf71SMatthew Garrett 	case USB_PORT_CONNECT_TYPE_HOT_PLUG:
234792bfbf71SMatthew Garrett 		udev->removable = USB_DEVICE_REMOVABLE;
234892bfbf71SMatthew Garrett 		return;
234992bfbf71SMatthew Garrett 	case USB_PORT_CONNECT_TYPE_HARD_WIRED:
235058339c2eSMatthew Garrett 	case USB_PORT_NOT_USED:
235192bfbf71SMatthew Garrett 		udev->removable = USB_DEVICE_FIXED;
235292bfbf71SMatthew Garrett 		return;
235358339c2eSMatthew Garrett 	default:
235458339c2eSMatthew Garrett 		break;
235592bfbf71SMatthew Garrett 	}
235692bfbf71SMatthew Garrett 
235792bfbf71SMatthew Garrett 	/*
235892bfbf71SMatthew Garrett 	 * Otherwise, check whether the hub knows whether a port is removable
235992bfbf71SMatthew Garrett 	 * or not
236092bfbf71SMatthew Garrett 	 */
2361d35e70d5SMatthew Garrett 	wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2362d35e70d5SMatthew Garrett 
2363d35e70d5SMatthew Garrett 	if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
2364d35e70d5SMatthew Garrett 		return;
2365d35e70d5SMatthew Garrett 
2366d35e70d5SMatthew Garrett 	if (hub_is_superspeed(hdev)) {
2367ca3c1539SLan Tianyu 		if (le16_to_cpu(hub->descriptor->u.ss.DeviceRemovable)
2368ca3c1539SLan Tianyu 				& (1 << port))
2369d35e70d5SMatthew Garrett 			removable = false;
2370d35e70d5SMatthew Garrett 	} else {
2371d35e70d5SMatthew Garrett 		if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
2372d35e70d5SMatthew Garrett 			removable = false;
2373d35e70d5SMatthew Garrett 	}
2374d35e70d5SMatthew Garrett 
2375d35e70d5SMatthew Garrett 	if (removable)
2376d35e70d5SMatthew Garrett 		udev->removable = USB_DEVICE_REMOVABLE;
2377d35e70d5SMatthew Garrett 	else
2378d35e70d5SMatthew Garrett 		udev->removable = USB_DEVICE_FIXED;
2379a4204ff0SDan Williams 
2380d35e70d5SMatthew Garrett }
2381d9d16e8aSInaky Perez-Gonzalez 
2382d9d16e8aSInaky Perez-Gonzalez /**
2383d9d16e8aSInaky Perez-Gonzalez  * usb_new_device - perform initial device setup (usbcore-internal)
2384d9d16e8aSInaky Perez-Gonzalez  * @udev: newly addressed device (in ADDRESS state)
2385d9d16e8aSInaky Perez-Gonzalez  *
23868d8558d1SAlan Stern  * This is called with devices which have been detected but not fully
23878d8558d1SAlan Stern  * enumerated.  The device descriptor is available, but not descriptors
2388d9d16e8aSInaky Perez-Gonzalez  * for any device configuration.  The caller must have locked either
2389d9d16e8aSInaky Perez-Gonzalez  * the parent hub (if udev is a normal device) or else the
2390a4b5d606SHeiner Kallweit  * usb_bus_idr_lock (if udev is a root hub).  The parent's pointer to
2391d9d16e8aSInaky Perez-Gonzalez  * udev has already been installed, but udev is not yet visible through
2392d9d16e8aSInaky Perez-Gonzalez  * sysfs or other filesystem code.
2393d9d16e8aSInaky Perez-Gonzalez  *
2394d9d16e8aSInaky Perez-Gonzalez  * This call is synchronous, and may not be used in an interrupt context.
2395d9d16e8aSInaky Perez-Gonzalez  *
2396d9d16e8aSInaky Perez-Gonzalez  * Only the hub driver or root-hub registrar should ever call this.
2397626f090cSYacine Belkadi  *
2398626f090cSYacine Belkadi  * Return: Whether the device is configured properly or not. Zero if the
2399626f090cSYacine Belkadi  * interface was registered with the driver core; else a negative errno
2400626f090cSYacine Belkadi  * value.
2401626f090cSYacine Belkadi  *
2402d9d16e8aSInaky Perez-Gonzalez  */
2403d9d16e8aSInaky Perez-Gonzalez int usb_new_device(struct usb_device *udev)
2404d9d16e8aSInaky Perez-Gonzalez {
2405d9d16e8aSInaky Perez-Gonzalez 	int err;
2406d9d16e8aSInaky Perez-Gonzalez 
240716985408SDan Streetman 	if (udev->parent) {
240816985408SDan Streetman 		/* Initialize non-root-hub device wakeup to disabled;
240916985408SDan Streetman 		 * device (un)configuration controls wakeup capable
241016985408SDan Streetman 		 * sysfs power/wakeup controls wakeup enabled/disabled
241116985408SDan Streetman 		 */
241216985408SDan Streetman 		device_init_wakeup(&udev->dev, 0);
241316985408SDan Streetman 	}
241416985408SDan Streetman 
24159bbdf1e0SAlan Stern 	/* Tell the runtime-PM framework the device is active */
24169bbdf1e0SAlan Stern 	pm_runtime_set_active(&udev->dev);
2417c08512c7SAlan Stern 	pm_runtime_get_noresume(&udev->dev);
2418fcc4a01eSAlan Stern 	pm_runtime_use_autosuspend(&udev->dev);
24199bbdf1e0SAlan Stern 	pm_runtime_enable(&udev->dev);
24209bbdf1e0SAlan Stern 
2421c08512c7SAlan Stern 	/* By default, forbid autosuspend for all devices.  It will be
2422c08512c7SAlan Stern 	 * allowed for hubs during binding.
2423c08512c7SAlan Stern 	 */
2424c08512c7SAlan Stern 	usb_disable_autosuspend(udev);
2425c08512c7SAlan Stern 
24268d8558d1SAlan Stern 	err = usb_enumerate_device(udev);	/* Read descriptors */
2427d9d16e8aSInaky Perez-Gonzalez 	if (err < 0)
2428d9d16e8aSInaky Perez-Gonzalez 		goto fail;
2429c6515272SSarah Sharp 	dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
2430c6515272SSarah Sharp 			udev->devnum, udev->bus->busnum,
2431c6515272SSarah Sharp 			(((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
24329f8b17e6SKay Sievers 	/* export the usbdev device-node for libusb */
24339f8b17e6SKay Sievers 	udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
24349f8b17e6SKay Sievers 			(((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
24359f8b17e6SKay Sievers 
24366cd13201SAlan Stern 	/* Tell the world! */
24376cd13201SAlan Stern 	announce_device(udev);
2438195af2ccSAlan Stern 
2439b04b3156STheodore Ts'o 	if (udev->serial)
2440b04b3156STheodore Ts'o 		add_device_randomness(udev->serial, strlen(udev->serial));
2441b04b3156STheodore Ts'o 	if (udev->product)
2442b04b3156STheodore Ts'o 		add_device_randomness(udev->product, strlen(udev->product));
2443b04b3156STheodore Ts'o 	if (udev->manufacturer)
2444b04b3156STheodore Ts'o 		add_device_randomness(udev->manufacturer,
2445b04b3156STheodore Ts'o 				      strlen(udev->manufacturer));
2446b04b3156STheodore Ts'o 
2447927bc916SRafael J. Wysocki 	device_enable_async_suspend(&udev->dev);
2448d35e70d5SMatthew Garrett 
2449a4204ff0SDan Williams 	/* check whether the hub or firmware marks this port as non-removable */
2450d35e70d5SMatthew Garrett 	if (udev->parent)
2451d35e70d5SMatthew Garrett 		set_usb_port_removable(udev);
2452d35e70d5SMatthew Garrett 
2453782da727SAlan Stern 	/* Register the device.  The device driver is responsible
24543b23dd6fSAlan Stern 	 * for configuring the device and invoking the add-device
24553b23dd6fSAlan Stern 	 * notifier chain (used by usbfs and possibly others).
2456782da727SAlan Stern 	 */
24571da177e4SLinus Torvalds 	err = device_add(&udev->dev);
24581da177e4SLinus Torvalds 	if (err) {
24591da177e4SLinus Torvalds 		dev_err(&udev->dev, "can't device_add, error %d\n", err);
24601da177e4SLinus Torvalds 		goto fail;
24611da177e4SLinus Torvalds 	}
24629ad3d6ccSAlan Stern 
2463fde26380SLan Tianyu 	/* Create link files between child device and usb port device. */
2464fde26380SLan Tianyu 	if (udev->parent) {
2465ad493e5eSLan Tianyu 		struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2466d5c3834eSDan Williams 		int port1 = udev->portnum;
2467d5c3834eSDan Williams 		struct usb_port	*port_dev = hub->ports[port1 - 1];
2468fde26380SLan Tianyu 
2469fde26380SLan Tianyu 		err = sysfs_create_link(&udev->dev.kobj,
2470fde26380SLan Tianyu 				&port_dev->dev.kobj, "port");
2471fde26380SLan Tianyu 		if (err)
2472fde26380SLan Tianyu 			goto fail;
2473fde26380SLan Tianyu 
2474fde26380SLan Tianyu 		err = sysfs_create_link(&port_dev->dev.kobj,
2475fde26380SLan Tianyu 				&udev->dev.kobj, "device");
2476fde26380SLan Tianyu 		if (err) {
2477fde26380SLan Tianyu 			sysfs_remove_link(&udev->dev.kobj, "port");
2478fde26380SLan Tianyu 			goto fail;
2479fde26380SLan Tianyu 		}
2480971fcd49SLan Tianyu 
2481d5c3834eSDan Williams 		if (!test_and_set_bit(port1, hub->child_usage_bits))
2482971fcd49SLan Tianyu 			pm_runtime_get_sync(&port_dev->dev);
2483fde26380SLan Tianyu 	}
2484fde26380SLan Tianyu 
24853b23dd6fSAlan Stern 	(void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
2486c08512c7SAlan Stern 	usb_mark_last_busy(udev);
2487c08512c7SAlan Stern 	pm_runtime_put_sync_autosuspend(&udev->dev);
2488c066475eSGreg Kroah-Hartman 	return err;
24891da177e4SLinus Torvalds 
24901da177e4SLinus Torvalds fail:
24911da177e4SLinus Torvalds 	usb_set_device_state(udev, USB_STATE_NOTATTACHED);
24929bbdf1e0SAlan Stern 	pm_runtime_disable(&udev->dev);
24939bbdf1e0SAlan Stern 	pm_runtime_set_suspended(&udev->dev);
2494d9d16e8aSInaky Perez-Gonzalez 	return err;
24951da177e4SLinus Torvalds }
24961da177e4SLinus Torvalds 
249793993a0aSInaky Perez-Gonzalez 
249893993a0aSInaky Perez-Gonzalez /**
2499fd39c86bSRandy Dunlap  * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2500fd39c86bSRandy Dunlap  * @usb_dev: USB device
2501fd39c86bSRandy Dunlap  *
2502fd39c86bSRandy Dunlap  * Move the USB device to a very basic state where interfaces are disabled
2503fd39c86bSRandy Dunlap  * and the device is in fact unconfigured and unusable.
250493993a0aSInaky Perez-Gonzalez  *
250593993a0aSInaky Perez-Gonzalez  * We share a lock (that we have) with device_del(), so we need to
250693993a0aSInaky Perez-Gonzalez  * defer its call.
2507626f090cSYacine Belkadi  *
2508626f090cSYacine Belkadi  * Return: 0.
250993993a0aSInaky Perez-Gonzalez  */
251093993a0aSInaky Perez-Gonzalez int usb_deauthorize_device(struct usb_device *usb_dev)
251193993a0aSInaky Perez-Gonzalez {
251293993a0aSInaky Perez-Gonzalez 	usb_lock_device(usb_dev);
251393993a0aSInaky Perez-Gonzalez 	if (usb_dev->authorized == 0)
251493993a0aSInaky Perez-Gonzalez 		goto out_unauthorized;
2515da307123SAlan Stern 
251693993a0aSInaky Perez-Gonzalez 	usb_dev->authorized = 0;
251793993a0aSInaky Perez-Gonzalez 	usb_set_configuration(usb_dev, -1);
2518da307123SAlan Stern 
251993993a0aSInaky Perez-Gonzalez out_unauthorized:
252093993a0aSInaky Perez-Gonzalez 	usb_unlock_device(usb_dev);
252193993a0aSInaky Perez-Gonzalez 	return 0;
252293993a0aSInaky Perez-Gonzalez }
252393993a0aSInaky Perez-Gonzalez 
252493993a0aSInaky Perez-Gonzalez 
252593993a0aSInaky Perez-Gonzalez int usb_authorize_device(struct usb_device *usb_dev)
252693993a0aSInaky Perez-Gonzalez {
252793993a0aSInaky Perez-Gonzalez 	int result = 0, c;
2528da307123SAlan Stern 
252993993a0aSInaky Perez-Gonzalez 	usb_lock_device(usb_dev);
253093993a0aSInaky Perez-Gonzalez 	if (usb_dev->authorized == 1)
253193993a0aSInaky Perez-Gonzalez 		goto out_authorized;
2532da307123SAlan Stern 
253393993a0aSInaky Perez-Gonzalez 	result = usb_autoresume_device(usb_dev);
253493993a0aSInaky Perez-Gonzalez 	if (result < 0) {
253593993a0aSInaky Perez-Gonzalez 		dev_err(&usb_dev->dev,
253693993a0aSInaky Perez-Gonzalez 			"can't autoresume for authorization: %d\n", result);
253793993a0aSInaky Perez-Gonzalez 		goto error_autoresume;
253893993a0aSInaky Perez-Gonzalez 	}
2539e50a322eSJosef Gajdusek 
2540e50a322eSJosef Gajdusek 	if (usb_dev->wusb) {
254193993a0aSInaky Perez-Gonzalez 		result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
254293993a0aSInaky Perez-Gonzalez 		if (result < 0) {
254393993a0aSInaky Perez-Gonzalez 			dev_err(&usb_dev->dev, "can't re-read device descriptor for "
254493993a0aSInaky Perez-Gonzalez 				"authorization: %d\n", result);
254593993a0aSInaky Perez-Gonzalez 			goto error_device_descriptor;
254693993a0aSInaky Perez-Gonzalez 		}
2547e50a322eSJosef Gajdusek 	}
2548da307123SAlan Stern 
254993993a0aSInaky Perez-Gonzalez 	usb_dev->authorized = 1;
255093993a0aSInaky Perez-Gonzalez 	/* Choose and set the configuration.  This registers the interfaces
255193993a0aSInaky Perez-Gonzalez 	 * with the driver core and lets interface drivers bind to them.
255293993a0aSInaky Perez-Gonzalez 	 */
2553b5ea060fSGreg Kroah-Hartman 	c = usb_choose_configuration(usb_dev);
255493993a0aSInaky Perez-Gonzalez 	if (c >= 0) {
255593993a0aSInaky Perez-Gonzalez 		result = usb_set_configuration(usb_dev, c);
255693993a0aSInaky Perez-Gonzalez 		if (result) {
255793993a0aSInaky Perez-Gonzalez 			dev_err(&usb_dev->dev,
255893993a0aSInaky Perez-Gonzalez 				"can't set config #%d, error %d\n", c, result);
255993993a0aSInaky Perez-Gonzalez 			/* This need not be fatal.  The user can try to
256093993a0aSInaky Perez-Gonzalez 			 * set other configurations. */
256193993a0aSInaky Perez-Gonzalez 		}
256293993a0aSInaky Perez-Gonzalez 	}
256393993a0aSInaky Perez-Gonzalez 	dev_info(&usb_dev->dev, "authorized to connect\n");
2564da307123SAlan Stern 
256593993a0aSInaky Perez-Gonzalez error_device_descriptor:
2566da307123SAlan Stern 	usb_autosuspend_device(usb_dev);
256793993a0aSInaky Perez-Gonzalez error_autoresume:
256893993a0aSInaky Perez-Gonzalez out_authorized:
2569781b2137SMatthias Beyer 	usb_unlock_device(usb_dev);	/* complements locktree */
257093993a0aSInaky Perez-Gonzalez 	return result;
257193993a0aSInaky Perez-Gonzalez }
257293993a0aSInaky Perez-Gonzalez 
25730cdd49a1SMathias Nyman /*
25740cdd49a1SMathias Nyman  * Return 1 if port speed is SuperSpeedPlus, 0 otherwise
25750cdd49a1SMathias Nyman  * check it from the link protocol field of the current speed ID attribute.
25760cdd49a1SMathias Nyman  * current speed ID is got from ext port status request. Sublink speed attribute
25770cdd49a1SMathias Nyman  * table is returned with the hub BOS SSP device capability descriptor
25780cdd49a1SMathias Nyman  */
25790cdd49a1SMathias Nyman static int port_speed_is_ssp(struct usb_device *hdev, int speed_id)
25800cdd49a1SMathias Nyman {
25810cdd49a1SMathias Nyman 	int ssa_count;
25820cdd49a1SMathias Nyman 	u32 ss_attr;
25830cdd49a1SMathias Nyman 	int i;
25840cdd49a1SMathias Nyman 	struct usb_ssp_cap_descriptor *ssp_cap = hdev->bos->ssp_cap;
25850cdd49a1SMathias Nyman 
25860cdd49a1SMathias Nyman 	if (!ssp_cap)
25870cdd49a1SMathias Nyman 		return 0;
25880cdd49a1SMathias Nyman 
25890cdd49a1SMathias Nyman 	ssa_count = le32_to_cpu(ssp_cap->bmAttributes) &
25900cdd49a1SMathias Nyman 		USB_SSP_SUBLINK_SPEED_ATTRIBS;
25910cdd49a1SMathias Nyman 
25920cdd49a1SMathias Nyman 	for (i = 0; i <= ssa_count; i++) {
25930cdd49a1SMathias Nyman 		ss_attr = le32_to_cpu(ssp_cap->bmSublinkSpeedAttr[i]);
25940cdd49a1SMathias Nyman 		if (speed_id == (ss_attr & USB_SSP_SUBLINK_SPEED_SSID))
25950cdd49a1SMathias Nyman 			return !!(ss_attr & USB_SSP_SUBLINK_SPEED_LP);
25960cdd49a1SMathias Nyman 	}
25970cdd49a1SMathias Nyman 	return 0;
25980cdd49a1SMathias Nyman }
259993993a0aSInaky Perez-Gonzalez 
26000165de09SInaky Perez-Gonzalez /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
26010165de09SInaky Perez-Gonzalez static unsigned hub_is_wusb(struct usb_hub *hub)
26020165de09SInaky Perez-Gonzalez {
26030165de09SInaky Perez-Gonzalez 	struct usb_hcd *hcd;
26040165de09SInaky Perez-Gonzalez 	if (hub->hdev->parent != NULL)  /* not a root hub? */
26050165de09SInaky Perez-Gonzalez 		return 0;
26066ae706aeSGeliang Tang 	hcd = bus_to_hcd(hub->hdev->bus);
26070165de09SInaky Perez-Gonzalez 	return hcd->wireless;
26080165de09SInaky Perez-Gonzalez }
26090165de09SInaky Perez-Gonzalez 
26100165de09SInaky Perez-Gonzalez 
26111da177e4SLinus Torvalds #define PORT_RESET_TRIES	5
26121da177e4SLinus Torvalds #define SET_ADDRESS_TRIES	2
26131da177e4SLinus Torvalds #define GET_DESCRIPTOR_TRIES	2
26141da177e4SLinus Torvalds #define SET_CONFIG_TRIES	(2 * (use_both_schemes + 1))
261590ab5ee9SRusty Russell #define USE_NEW_SCHEME(i)	((i) / 2 == (int)old_scheme_first)
26161da177e4SLinus Torvalds 
261774072baeSMathias Nyman #define HUB_ROOT_RESET_TIME	60	/* times are in msec */
26181da177e4SLinus Torvalds #define HUB_SHORT_RESET_TIME	10
261975d7cf72SAndiry Xu #define HUB_BH_RESET_TIME	50
26201da177e4SLinus Torvalds #define HUB_LONG_RESET_TIME	200
262177c7f072SSarah Sharp #define HUB_RESET_TIMEOUT	800
26221da177e4SLinus Torvalds 
262348fc7dbdSDan Williams /*
262448fc7dbdSDan Williams  * "New scheme" enumeration causes an extra state transition to be
262548fc7dbdSDan Williams  * exposed to an xhci host and causes USB3 devices to receive control
262648fc7dbdSDan Williams  * commands in the default state.  This has been seen to cause
262748fc7dbdSDan Williams  * enumeration failures, so disable this enumeration scheme for USB3
262848fc7dbdSDan Williams  * devices.
262948fc7dbdSDan Williams  */
263048fc7dbdSDan Williams static bool use_new_scheme(struct usb_device *udev, int retry)
263148fc7dbdSDan Williams {
26328a1b2725SMathias Nyman 	if (udev->speed >= USB_SPEED_SUPER)
263348fc7dbdSDan Williams 		return false;
263448fc7dbdSDan Williams 
263548fc7dbdSDan Williams 	return USE_NEW_SCHEME(retry);
263648fc7dbdSDan Williams }
263748fc7dbdSDan Williams 
2638025d4430SRahul Bedarkar /* Is a USB 3.0 port in the Inactive or Compliance Mode state?
26398bea2bd3SStanislaw Ledwon  * Port worm reset is required to recover
26408bea2bd3SStanislaw Ledwon  */
26413cd12f91SDan Williams static bool hub_port_warm_reset_required(struct usb_hub *hub, int port1,
26423cd12f91SDan Williams 		u16 portstatus)
264310d674a8SSarah Sharp {
26443cd12f91SDan Williams 	u16 link_state;
26453cd12f91SDan Williams 
26463cd12f91SDan Williams 	if (!hub_is_superspeed(hub->hdev))
26473cd12f91SDan Williams 		return false;
26483cd12f91SDan Williams 
26493cd12f91SDan Williams 	if (test_bit(port1, hub->warm_reset_bits))
26503cd12f91SDan Williams 		return true;
26513cd12f91SDan Williams 
26523cd12f91SDan Williams 	link_state = portstatus & USB_PORT_STAT_LINK_STATE;
26533cd12f91SDan Williams 	return link_state == USB_SS_PORT_LS_SS_INACTIVE
26543cd12f91SDan Williams 		|| link_state == USB_SS_PORT_LS_COMP_MOD;
265510d674a8SSarah Sharp }
265610d674a8SSarah Sharp 
26571da177e4SLinus Torvalds static int hub_port_wait_reset(struct usb_hub *hub, int port1,
265875d7cf72SAndiry Xu 			struct usb_device *udev, unsigned int delay, bool warm)
26591da177e4SLinus Torvalds {
26601da177e4SLinus Torvalds 	int delay_time, ret;
26611da177e4SLinus Torvalds 	u16 portstatus;
26621da177e4SLinus Torvalds 	u16 portchange;
26630cdd49a1SMathias Nyman 	u32 ext_portstatus = 0;
26641da177e4SLinus Torvalds 
26651da177e4SLinus Torvalds 	for (delay_time = 0;
26661da177e4SLinus Torvalds 			delay_time < HUB_RESET_TIMEOUT;
26671da177e4SLinus Torvalds 			delay_time += delay) {
26681da177e4SLinus Torvalds 		/* wait to give the device a chance to reset */
26691da177e4SLinus Torvalds 		msleep(delay);
26701da177e4SLinus Torvalds 
26711da177e4SLinus Torvalds 		/* read and decode port status */
26720cdd49a1SMathias Nyman 		if (hub_is_superspeedplus(hub->hdev))
26730cdd49a1SMathias Nyman 			ret = hub_ext_port_status(hub, port1,
26740cdd49a1SMathias Nyman 						  HUB_EXT_PORT_STATUS,
26750cdd49a1SMathias Nyman 						  &portstatus, &portchange,
26760cdd49a1SMathias Nyman 						  &ext_portstatus);
26770cdd49a1SMathias Nyman 		else
26780cdd49a1SMathias Nyman 			ret = hub_port_status(hub, port1, &portstatus,
26790cdd49a1SMathias Nyman 					      &portchange);
26801da177e4SLinus Torvalds 		if (ret < 0)
26811da177e4SLinus Torvalds 			return ret;
26821da177e4SLinus Torvalds 
268322547c4cSGuenter Roeck 		/*
268422547c4cSGuenter Roeck 		 * The port state is unknown until the reset completes.
268522547c4cSGuenter Roeck 		 *
268622547c4cSGuenter Roeck 		 * On top of that, some chips may require additional time
268722547c4cSGuenter Roeck 		 * to re-establish a connection after the reset is complete,
268822547c4cSGuenter Roeck 		 * so also wait for the connection to be re-established.
268922547c4cSGuenter Roeck 		 */
269022547c4cSGuenter Roeck 		if (!(portstatus & USB_PORT_STAT_RESET) &&
269122547c4cSGuenter Roeck 		    (portstatus & USB_PORT_STAT_CONNECTION))
2692470f0be8SSarah Sharp 			break;
2693470f0be8SSarah Sharp 
2694470f0be8SSarah Sharp 		/* switch to the long delay after two short delay failures */
2695470f0be8SSarah Sharp 		if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2696470f0be8SSarah Sharp 			delay = HUB_LONG_RESET_TIME;
2697470f0be8SSarah Sharp 
2698d99f6b41SDan Williams 		dev_dbg(&hub->ports[port1 - 1]->dev,
2699d99f6b41SDan Williams 				"not %sreset yet, waiting %dms\n",
2700d99f6b41SDan Williams 				warm ? "warm " : "", delay);
2701470f0be8SSarah Sharp 	}
2702470f0be8SSarah Sharp 
27034f43447eSSarah Sharp 	if ((portstatus & USB_PORT_STAT_RESET))
2704470f0be8SSarah Sharp 		return -EBUSY;
27054f43447eSSarah Sharp 
27063cd12f91SDan Williams 	if (hub_port_warm_reset_required(hub, port1, portstatus))
2707a24a6078SSarah Sharp 		return -ENOTCONN;
270810d674a8SSarah Sharp 
27091da177e4SLinus Torvalds 	/* Device went away? */
27101da177e4SLinus Torvalds 	if (!(portstatus & USB_PORT_STAT_CONNECTION))
27111da177e4SLinus Torvalds 		return -ENOTCONN;
27121da177e4SLinus Torvalds 
2713a24a6078SSarah Sharp 	/* bomb out completely if the connection bounced.  A USB 3.0
2714a24a6078SSarah Sharp 	 * connection may bounce if multiple warm resets were issued,
2715a24a6078SSarah Sharp 	 * but the device may have successfully re-connected. Ignore it.
2716a24a6078SSarah Sharp 	 */
2717a24a6078SSarah Sharp 	if (!hub_is_superspeed(hub->hdev) &&
2718a24a6078SSarah Sharp 			(portchange & USB_PORT_STAT_C_CONNECTION))
2719dd4dd19eSAlan Stern 		return -ENOTCONN;
27201da177e4SLinus Torvalds 
2721470f0be8SSarah Sharp 	if (!(portstatus & USB_PORT_STAT_ENABLE))
2722470f0be8SSarah Sharp 		return -EBUSY;
2723470f0be8SSarah Sharp 
27242d4fa940SSarah Sharp 	if (!udev)
27252d4fa940SSarah Sharp 		return 0;
27262d4fa940SSarah Sharp 
27270165de09SInaky Perez-Gonzalez 	if (hub_is_wusb(hub))
2728551cdbbeSGreg Kroah-Hartman 		udev->speed = USB_SPEED_WIRELESS;
27290cdd49a1SMathias Nyman 	else if (hub_is_superspeedplus(hub->hdev) &&
27300cdd49a1SMathias Nyman 		 port_speed_is_ssp(hub->hdev, ext_portstatus &
27310cdd49a1SMathias Nyman 				   USB_EXT_PORT_STAT_RX_SPEED_ID))
27320cdd49a1SMathias Nyman 		udev->speed = USB_SPEED_SUPER_PLUS;
2733131dec34SSarah Sharp 	else if (hub_is_superspeed(hub->hdev))
2734809cd1cbSSarah Sharp 		udev->speed = USB_SPEED_SUPER;
27350165de09SInaky Perez-Gonzalez 	else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
27361da177e4SLinus Torvalds 		udev->speed = USB_SPEED_HIGH;
27371da177e4SLinus Torvalds 	else if (portstatus & USB_PORT_STAT_LOW_SPEED)
27381da177e4SLinus Torvalds 		udev->speed = USB_SPEED_LOW;
27391da177e4SLinus Torvalds 	else
27401da177e4SLinus Torvalds 		udev->speed = USB_SPEED_FULL;
27411da177e4SLinus Torvalds 	return 0;
27421da177e4SLinus Torvalds }
27431da177e4SLinus Torvalds 
274475d7cf72SAndiry Xu /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
274575d7cf72SAndiry Xu static int hub_port_reset(struct usb_hub *hub, int port1,
274675d7cf72SAndiry Xu 			struct usb_device *udev, unsigned int delay, bool warm)
274775d7cf72SAndiry Xu {
274875d7cf72SAndiry Xu 	int i, status;
2749a24a6078SSarah Sharp 	u16 portchange, portstatus;
2750d99f6b41SDan Williams 	struct usb_port *port_dev = hub->ports[port1 - 1];
275175d7cf72SAndiry Xu 
275275d7cf72SAndiry Xu 	if (!hub_is_superspeed(hub->hdev)) {
27530fe51aa5SSarah Sharp 		if (warm) {
275475d7cf72SAndiry Xu 			dev_err(hub->intfdev, "only USB3 hub support "
275575d7cf72SAndiry Xu 						"warm reset\n");
275675d7cf72SAndiry Xu 			return -EINVAL;
275775d7cf72SAndiry Xu 		}
27580fe51aa5SSarah Sharp 		/* Block EHCI CF initialization during the port reset.
27590fe51aa5SSarah Sharp 		 * Some companion controllers don't like it when they mix.
27600fe51aa5SSarah Sharp 		 */
27610fe51aa5SSarah Sharp 		down_read(&ehci_cf_port_reset_rwsem);
2762d3b9d7a9SSarah Sharp 	} else if (!warm) {
2763d3b9d7a9SSarah Sharp 		/*
2764d3b9d7a9SSarah Sharp 		 * If the caller hasn't explicitly requested a warm reset,
2765d3b9d7a9SSarah Sharp 		 * double check and see if one is needed.
2766d3b9d7a9SSarah Sharp 		 */
2767fb6d1f7dSRobert Schlabbach 		if (hub_port_status(hub, port1, &portstatus, &portchange) == 0)
2768fb6d1f7dSRobert Schlabbach 			if (hub_port_warm_reset_required(hub, port1,
2769fb6d1f7dSRobert Schlabbach 							portstatus))
2770d3b9d7a9SSarah Sharp 				warm = true;
277175d7cf72SAndiry Xu 	}
27723cd12f91SDan Williams 	clear_bit(port1, hub->warm_reset_bits);
277375d7cf72SAndiry Xu 
277475d7cf72SAndiry Xu 	/* Reset the port */
277575d7cf72SAndiry Xu 	for (i = 0; i < PORT_RESET_TRIES; i++) {
277675d7cf72SAndiry Xu 		status = set_port_feature(hub->hdev, port1, (warm ?
277775d7cf72SAndiry Xu 					USB_PORT_FEAT_BH_PORT_RESET :
277875d7cf72SAndiry Xu 					USB_PORT_FEAT_RESET));
2779e9e88fb7SAlan Stern 		if (status == -ENODEV) {
2780e9e88fb7SAlan Stern 			;	/* The hub is gone */
2781e9e88fb7SAlan Stern 		} else if (status) {
2782d99f6b41SDan Williams 			dev_err(&port_dev->dev,
2783d99f6b41SDan Williams 					"cannot %sreset (err = %d)\n",
2784d99f6b41SDan Williams 					warm ? "warm " : "", status);
278575d7cf72SAndiry Xu 		} else {
278675d7cf72SAndiry Xu 			status = hub_port_wait_reset(hub, port1, udev, delay,
278775d7cf72SAndiry Xu 								warm);
2788e9e88fb7SAlan Stern 			if (status && status != -ENOTCONN && status != -ENODEV)
278975d7cf72SAndiry Xu 				dev_dbg(hub->intfdev,
279075d7cf72SAndiry Xu 						"port_wait_reset: err = %d\n",
279175d7cf72SAndiry Xu 						status);
279275d7cf72SAndiry Xu 		}
279375d7cf72SAndiry Xu 
2794a24a6078SSarah Sharp 		/* Check for disconnect or reset */
279575d7cf72SAndiry Xu 		if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2796fb6d1f7dSRobert Schlabbach 			usb_clear_port_feature(hub->hdev, port1,
2797fb6d1f7dSRobert Schlabbach 					USB_PORT_FEAT_C_RESET);
2798a24a6078SSarah Sharp 
2799a24a6078SSarah Sharp 			if (!hub_is_superspeed(hub->hdev))
280032fe0198SAlan Stern 				goto done;
2801a24a6078SSarah Sharp 
2802fb6d1f7dSRobert Schlabbach 			usb_clear_port_feature(hub->hdev, port1,
2803fb6d1f7dSRobert Schlabbach 					USB_PORT_FEAT_C_BH_PORT_RESET);
2804fb6d1f7dSRobert Schlabbach 			usb_clear_port_feature(hub->hdev, port1,
2805fb6d1f7dSRobert Schlabbach 					USB_PORT_FEAT_C_PORT_LINK_STATE);
2806fb6d1f7dSRobert Schlabbach 			usb_clear_port_feature(hub->hdev, port1,
2807fb6d1f7dSRobert Schlabbach 					USB_PORT_FEAT_C_CONNECTION);
2808fb6d1f7dSRobert Schlabbach 
2809a24a6078SSarah Sharp 			/*
2810a24a6078SSarah Sharp 			 * If a USB 3.0 device migrates from reset to an error
2811a24a6078SSarah Sharp 			 * state, re-issue the warm reset.
2812a24a6078SSarah Sharp 			 */
2813a24a6078SSarah Sharp 			if (hub_port_status(hub, port1,
2814a24a6078SSarah Sharp 					&portstatus, &portchange) < 0)
2815a24a6078SSarah Sharp 				goto done;
2816a24a6078SSarah Sharp 
28173cd12f91SDan Williams 			if (!hub_port_warm_reset_required(hub, port1,
28183cd12f91SDan Williams 					portstatus))
2819a24a6078SSarah Sharp 				goto done;
2820a24a6078SSarah Sharp 
2821a24a6078SSarah Sharp 			/*
2822a24a6078SSarah Sharp 			 * If the port is in SS.Inactive or Compliance Mode, the
2823a24a6078SSarah Sharp 			 * hot or warm reset failed.  Try another warm reset.
2824a24a6078SSarah Sharp 			 */
2825a24a6078SSarah Sharp 			if (!warm) {
2826d99f6b41SDan Williams 				dev_dbg(&port_dev->dev,
2827d99f6b41SDan Williams 						"hot reset failed, warm reset\n");
2828a24a6078SSarah Sharp 				warm = true;
2829a24a6078SSarah Sharp 			}
28301da177e4SLinus Torvalds 		}
28311da177e4SLinus Torvalds 
2832d99f6b41SDan Williams 		dev_dbg(&port_dev->dev,
2833d99f6b41SDan Williams 				"not enabled, trying %sreset again...\n",
2834d99f6b41SDan Williams 				warm ? "warm " : "");
28351da177e4SLinus Torvalds 		delay = HUB_LONG_RESET_TIME;
28361da177e4SLinus Torvalds 	}
28371da177e4SLinus Torvalds 
2838d99f6b41SDan Williams 	dev_err(&port_dev->dev, "Cannot enable. Maybe the USB cable is bad?\n");
28391da177e4SLinus Torvalds 
284032fe0198SAlan Stern done:
2841fb6d1f7dSRobert Schlabbach 	if (status == 0) {
2842fb6d1f7dSRobert Schlabbach 		/* TRSTRCY = 10 ms; plus some extra */
2843fb6d1f7dSRobert Schlabbach 		msleep(10 + 40);
2844fb6d1f7dSRobert Schlabbach 		if (udev) {
2845fb6d1f7dSRobert Schlabbach 			struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2846fb6d1f7dSRobert Schlabbach 
2847fb6d1f7dSRobert Schlabbach 			update_devnum(udev, 0);
2848fb6d1f7dSRobert Schlabbach 			/* The xHC may think the device is already reset,
2849fb6d1f7dSRobert Schlabbach 			 * so ignore the status.
2850fb6d1f7dSRobert Schlabbach 			 */
2851fb6d1f7dSRobert Schlabbach 			if (hcd->driver->reset_device)
2852fb6d1f7dSRobert Schlabbach 				hcd->driver->reset_device(hcd, udev);
2853fb6d1f7dSRobert Schlabbach 
2854fb6d1f7dSRobert Schlabbach 			usb_set_device_state(udev, USB_STATE_DEFAULT);
2855fb6d1f7dSRobert Schlabbach 		}
2856fb6d1f7dSRobert Schlabbach 	} else {
2857fb6d1f7dSRobert Schlabbach 		if (udev)
2858fb6d1f7dSRobert Schlabbach 			usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2859fb6d1f7dSRobert Schlabbach 	}
2860fb6d1f7dSRobert Schlabbach 
28610fe51aa5SSarah Sharp 	if (!hub_is_superspeed(hub->hdev))
286232fe0198SAlan Stern 		up_read(&ehci_cf_port_reset_rwsem);
286375d7cf72SAndiry Xu 
28641da177e4SLinus Torvalds 	return status;
28651da177e4SLinus Torvalds }
28661da177e4SLinus Torvalds 
28670ed9a57eSAndiry Xu /* Check if a port is power on */
28680ed9a57eSAndiry Xu static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
28690ed9a57eSAndiry Xu {
28700ed9a57eSAndiry Xu 	int ret = 0;
28710ed9a57eSAndiry Xu 
28720ed9a57eSAndiry Xu 	if (hub_is_superspeed(hub->hdev)) {
28730ed9a57eSAndiry Xu 		if (portstatus & USB_SS_PORT_STAT_POWER)
28740ed9a57eSAndiry Xu 			ret = 1;
28750ed9a57eSAndiry Xu 	} else {
28760ed9a57eSAndiry Xu 		if (portstatus & USB_PORT_STAT_POWER)
28770ed9a57eSAndiry Xu 			ret = 1;
28780ed9a57eSAndiry Xu 	}
28790ed9a57eSAndiry Xu 
28800ed9a57eSAndiry Xu 	return ret;
28810ed9a57eSAndiry Xu }
28820ed9a57eSAndiry Xu 
28835c79a1e3SDan Williams static void usb_lock_port(struct usb_port *port_dev)
28845c79a1e3SDan Williams 		__acquires(&port_dev->status_lock)
28855c79a1e3SDan Williams {
28865c79a1e3SDan Williams 	mutex_lock(&port_dev->status_lock);
28875c79a1e3SDan Williams 	__acquire(&port_dev->status_lock);
28885c79a1e3SDan Williams }
28895c79a1e3SDan Williams 
28905c79a1e3SDan Williams static void usb_unlock_port(struct usb_port *port_dev)
28915c79a1e3SDan Williams 		__releases(&port_dev->status_lock)
28925c79a1e3SDan Williams {
28935c79a1e3SDan Williams 	mutex_unlock(&port_dev->status_lock);
28945c79a1e3SDan Williams 	__release(&port_dev->status_lock);
28955c79a1e3SDan Williams }
28965c79a1e3SDan Williams 
2897d388dab7SAlan Stern #ifdef	CONFIG_PM
28981da177e4SLinus Torvalds 
28990ed9a57eSAndiry Xu /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
29000ed9a57eSAndiry Xu static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
29010ed9a57eSAndiry Xu {
29020ed9a57eSAndiry Xu 	int ret = 0;
29030ed9a57eSAndiry Xu 
29040ed9a57eSAndiry Xu 	if (hub_is_superspeed(hub->hdev)) {
29050ed9a57eSAndiry Xu 		if ((portstatus & USB_PORT_STAT_LINK_STATE)
29060ed9a57eSAndiry Xu 				== USB_SS_PORT_LS_U3)
29070ed9a57eSAndiry Xu 			ret = 1;
29080ed9a57eSAndiry Xu 	} else {
29090ed9a57eSAndiry Xu 		if (portstatus & USB_PORT_STAT_SUSPEND)
29100ed9a57eSAndiry Xu 			ret = 1;
29110ed9a57eSAndiry Xu 	}
29120ed9a57eSAndiry Xu 
29130ed9a57eSAndiry Xu 	return ret;
29140ed9a57eSAndiry Xu }
2915b01b03f3SAlan Stern 
2916b01b03f3SAlan Stern /* Determine whether the device on a port is ready for a normal resume,
2917b01b03f3SAlan Stern  * is ready for a reset-resume, or should be disconnected.
2918b01b03f3SAlan Stern  */
2919b01b03f3SAlan Stern static int check_port_resume_type(struct usb_device *udev,
2920b01b03f3SAlan Stern 		struct usb_hub *hub, int port1,
29217fa40910SJulius Werner 		int status, u16 portchange, u16 portstatus)
2922b01b03f3SAlan Stern {
2923d99f6b41SDan Williams 	struct usb_port *port_dev = hub->ports[port1 - 1];
29247fa40910SJulius Werner 	int retries = 3;
2925d99f6b41SDan Williams 
29267fa40910SJulius Werner  retry:
29273cd12f91SDan Williams 	/* Is a warm reset needed to recover the connection? */
29283cd12f91SDan Williams 	if (status == 0 && udev->reset_resume
29293cd12f91SDan Williams 		&& hub_port_warm_reset_required(hub, port1, portstatus)) {
29303cd12f91SDan Williams 		/* pass */;
29313cd12f91SDan Williams 	}
2932b01b03f3SAlan Stern 	/* Is the device still present? */
29333cd12f91SDan Williams 	else if (status || port_is_suspended(hub, portstatus) ||
29347fa40910SJulius Werner 			!port_is_power_on(hub, portstatus)) {
2935b01b03f3SAlan Stern 		if (status >= 0)
2936b01b03f3SAlan Stern 			status = -ENODEV;
29377fa40910SJulius Werner 	} else if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
29387fa40910SJulius Werner 		if (retries--) {
29397fa40910SJulius Werner 			usleep_range(200, 300);
29407fa40910SJulius Werner 			status = hub_port_status(hub, port1, &portstatus,
29417fa40910SJulius Werner 							     &portchange);
29427fa40910SJulius Werner 			goto retry;
29437fa40910SJulius Werner 		}
29447fa40910SJulius Werner 		status = -ENODEV;
2945b01b03f3SAlan Stern 	}
2946b01b03f3SAlan Stern 
294786c57edfSAlan Stern 	/* Can't do a normal resume if the port isn't enabled,
294886c57edfSAlan Stern 	 * so try a reset-resume instead.
294986c57edfSAlan Stern 	 */
295086c57edfSAlan Stern 	else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
295186c57edfSAlan Stern 		if (udev->persist_enabled)
295286c57edfSAlan Stern 			udev->reset_resume = 1;
295386c57edfSAlan Stern 		else
2954b01b03f3SAlan Stern 			status = -ENODEV;
295586c57edfSAlan Stern 	}
2956b01b03f3SAlan Stern 
2957b01b03f3SAlan Stern 	if (status) {
2958d99f6b41SDan Williams 		dev_dbg(&port_dev->dev, "status %04x.%04x after resume, %d\n",
2959d99f6b41SDan Williams 				portchange, portstatus, status);
2960b01b03f3SAlan Stern 	} else if (udev->reset_resume) {
2961b01b03f3SAlan Stern 
2962b01b03f3SAlan Stern 		/* Late port handoff can set status-change bits */
2963b01b03f3SAlan Stern 		if (portchange & USB_PORT_STAT_C_CONNECTION)
2964ad493e5eSLan Tianyu 			usb_clear_port_feature(hub->hdev, port1,
2965b01b03f3SAlan Stern 					USB_PORT_FEAT_C_CONNECTION);
2966b01b03f3SAlan Stern 		if (portchange & USB_PORT_STAT_C_ENABLE)
2967ad493e5eSLan Tianyu 			usb_clear_port_feature(hub->hdev, port1,
2968b01b03f3SAlan Stern 					USB_PORT_FEAT_C_ENABLE);
2969b01b03f3SAlan Stern 	}
2970b01b03f3SAlan Stern 
2971b01b03f3SAlan Stern 	return status;
2972b01b03f3SAlan Stern }
2973b01b03f3SAlan Stern 
2974f74631e3SSarah Sharp int usb_disable_ltm(struct usb_device *udev)
2975f74631e3SSarah Sharp {
2976f74631e3SSarah Sharp 	struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2977f74631e3SSarah Sharp 
2978f74631e3SSarah Sharp 	/* Check if the roothub and device supports LTM. */
2979f74631e3SSarah Sharp 	if (!usb_device_supports_ltm(hcd->self.root_hub) ||
2980f74631e3SSarah Sharp 			!usb_device_supports_ltm(udev))
2981f74631e3SSarah Sharp 		return 0;
2982f74631e3SSarah Sharp 
2983f74631e3SSarah Sharp 	/* Clear Feature LTM Enable can only be sent if the device is
2984f74631e3SSarah Sharp 	 * configured.
2985f74631e3SSarah Sharp 	 */
2986f74631e3SSarah Sharp 	if (!udev->actconfig)
2987f74631e3SSarah Sharp 		return 0;
2988f74631e3SSarah Sharp 
2989f74631e3SSarah Sharp 	return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2990f74631e3SSarah Sharp 			USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2991f74631e3SSarah Sharp 			USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
2992f74631e3SSarah Sharp 			USB_CTRL_SET_TIMEOUT);
2993f74631e3SSarah Sharp }
2994f74631e3SSarah Sharp EXPORT_SYMBOL_GPL(usb_disable_ltm);
2995f74631e3SSarah Sharp 
2996f74631e3SSarah Sharp void usb_enable_ltm(struct usb_device *udev)
2997f74631e3SSarah Sharp {
2998f74631e3SSarah Sharp 	struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2999f74631e3SSarah Sharp 
3000f74631e3SSarah Sharp 	/* Check if the roothub and device supports LTM. */
3001f74631e3SSarah Sharp 	if (!usb_device_supports_ltm(hcd->self.root_hub) ||
3002f74631e3SSarah Sharp 			!usb_device_supports_ltm(udev))
3003f74631e3SSarah Sharp 		return;
3004f74631e3SSarah Sharp 
3005f74631e3SSarah Sharp 	/* Set Feature LTM Enable can only be sent if the device is
3006f74631e3SSarah Sharp 	 * configured.
3007f74631e3SSarah Sharp 	 */
3008f74631e3SSarah Sharp 	if (!udev->actconfig)
3009f74631e3SSarah Sharp 		return;
3010f74631e3SSarah Sharp 
3011f74631e3SSarah Sharp 	usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3012f74631e3SSarah Sharp 			USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
3013f74631e3SSarah Sharp 			USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
3014f74631e3SSarah Sharp 			USB_CTRL_SET_TIMEOUT);
3015f74631e3SSarah Sharp }
3016f74631e3SSarah Sharp EXPORT_SYMBOL_GPL(usb_enable_ltm);
3017f74631e3SSarah Sharp 
301854a3ac0cSLan Tianyu /*
301928e86165SAlan Stern  * usb_enable_remote_wakeup - enable remote wakeup for a device
302054a3ac0cSLan Tianyu  * @udev: target device
302154a3ac0cSLan Tianyu  *
302228e86165SAlan Stern  * For USB-2 devices: Set the device's remote wakeup feature.
302328e86165SAlan Stern  *
302428e86165SAlan Stern  * For USB-3 devices: Assume there's only one function on the device and
302528e86165SAlan Stern  * enable remote wake for the first interface.  FIXME if the interface
302628e86165SAlan Stern  * association descriptor shows there's more than one function.
302754a3ac0cSLan Tianyu  */
302828e86165SAlan Stern static int usb_enable_remote_wakeup(struct usb_device *udev)
302954a3ac0cSLan Tianyu {
303028e86165SAlan Stern 	if (udev->speed < USB_SPEED_SUPER)
303128e86165SAlan Stern 		return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
303228e86165SAlan Stern 				USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
303328e86165SAlan Stern 				USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
303428e86165SAlan Stern 				USB_CTRL_SET_TIMEOUT);
303528e86165SAlan Stern 	else
303628e86165SAlan Stern 		return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
303728e86165SAlan Stern 				USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
303828e86165SAlan Stern 				USB_INTRF_FUNC_SUSPEND,
303928e86165SAlan Stern 				USB_INTRF_FUNC_SUSPEND_RW |
304028e86165SAlan Stern 					USB_INTRF_FUNC_SUSPEND_LP,
304128e86165SAlan Stern 				NULL, 0, USB_CTRL_SET_TIMEOUT);
304228e86165SAlan Stern }
304328e86165SAlan Stern 
304428e86165SAlan Stern /*
304528e86165SAlan Stern  * usb_disable_remote_wakeup - disable remote wakeup for a device
304628e86165SAlan Stern  * @udev: target device
304728e86165SAlan Stern  *
304828e86165SAlan Stern  * For USB-2 devices: Clear the device's remote wakeup feature.
304928e86165SAlan Stern  *
305028e86165SAlan Stern  * For USB-3 devices: Assume there's only one function on the device and
305128e86165SAlan Stern  * disable remote wake for the first interface.  FIXME if the interface
305228e86165SAlan Stern  * association descriptor shows there's more than one function.
305328e86165SAlan Stern  */
305428e86165SAlan Stern static int usb_disable_remote_wakeup(struct usb_device *udev)
305528e86165SAlan Stern {
305628e86165SAlan Stern 	if (udev->speed < USB_SPEED_SUPER)
305728e86165SAlan Stern 		return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
305828e86165SAlan Stern 				USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
305928e86165SAlan Stern 				USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
306028e86165SAlan Stern 				USB_CTRL_SET_TIMEOUT);
306128e86165SAlan Stern 	else
306254a3ac0cSLan Tianyu 		return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
30634e248000SYonglong Wu 				USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
306454a3ac0cSLan Tianyu 				USB_INTRF_FUNC_SUSPEND,	0, NULL, 0,
306554a3ac0cSLan Tianyu 				USB_CTRL_SET_TIMEOUT);
306654a3ac0cSLan Tianyu }
30671da177e4SLinus Torvalds 
3068e583d9dbSAlan Stern /* Count of wakeup-enabled devices at or below udev */
3069e583d9dbSAlan Stern static unsigned wakeup_enabled_descendants(struct usb_device *udev)
3070e583d9dbSAlan Stern {
3071e583d9dbSAlan Stern 	struct usb_hub *hub = usb_hub_to_struct_hub(udev);
3072e583d9dbSAlan Stern 
3073e583d9dbSAlan Stern 	return udev->do_remote_wakeup +
3074e583d9dbSAlan Stern 			(hub ? hub->wakeup_enabled_descendants : 0);
3075e583d9dbSAlan Stern }
3076e583d9dbSAlan Stern 
30771da177e4SLinus Torvalds /*
3078140d8f68SAlan Stern  * usb_port_suspend - suspend a usb device's upstream port
3079624d6c07SAlan Stern  * @udev: device that's no longer in active use, not a root hub
30805edbfb7cSDavid Brownell  * Context: must be able to sleep; device not locked; pm locks held
30811da177e4SLinus Torvalds  *
30821da177e4SLinus Torvalds  * Suspends a USB device that isn't in active use, conserving power.
30831da177e4SLinus Torvalds  * Devices may wake out of a suspend, if anything important happens,
30841da177e4SLinus Torvalds  * using the remote wakeup mechanism.  They may also be taken out of
3085140d8f68SAlan Stern  * suspend by the host, using usb_port_resume().  It's also routine
30861da177e4SLinus Torvalds  * to disconnect devices while they are suspended.
30871da177e4SLinus Torvalds  *
3088390a8c34SDavid Brownell  * This only affects the USB hardware for a device; its interfaces
3089390a8c34SDavid Brownell  * (and, for hubs, child devices) must already have been suspended.
3090390a8c34SDavid Brownell  *
3091624d6c07SAlan Stern  * Selective port suspend reduces power; most suspended devices draw
3092624d6c07SAlan Stern  * less than 500 uA.  It's also used in OTG, along with remote wakeup.
3093624d6c07SAlan Stern  * All devices below the suspended port are also suspended.
3094624d6c07SAlan Stern  *
3095624d6c07SAlan Stern  * Devices leave suspend state when the host wakes them up.  Some devices
3096624d6c07SAlan Stern  * also support "remote wakeup", where the device can activate the USB
3097624d6c07SAlan Stern  * tree above them to deliver data, such as a keypress or packet.  In
3098624d6c07SAlan Stern  * some cases, this wakes the USB host.
3099624d6c07SAlan Stern  *
31001da177e4SLinus Torvalds  * Suspending OTG devices may trigger HNP, if that's been enabled
31011da177e4SLinus Torvalds  * between a pair of dual-role devices.  That will change roles, such
31021da177e4SLinus Torvalds  * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
31031da177e4SLinus Torvalds  *
31044956eccdSAlan Stern  * Devices on USB hub ports have only one "suspend" state, corresponding
31054956eccdSAlan Stern  * to ACPI D2, "may cause the device to lose some context".
31064956eccdSAlan Stern  * State transitions include:
31074956eccdSAlan Stern  *
31084956eccdSAlan Stern  *   - suspend, resume ... when the VBUS power link stays live
31094956eccdSAlan Stern  *   - suspend, disconnect ... VBUS lost
31104956eccdSAlan Stern  *
31114956eccdSAlan Stern  * Once VBUS drop breaks the circuit, the port it's using has to go through
31124956eccdSAlan Stern  * normal re-enumeration procedures, starting with enabling VBUS power.
31134956eccdSAlan Stern  * Other than re-initializing the hub (plug/unplug, except for root hubs),
311437ebb549SPetr Mladek  * Linux (2.6) currently has NO mechanisms to initiate that:  no hub_wq
31154956eccdSAlan Stern  * timer, no SRP, no requests through sysfs.
31164956eccdSAlan Stern  *
3117e583d9dbSAlan Stern  * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
3118e583d9dbSAlan Stern  * suspended until their bus goes into global suspend (i.e., the root
31190aa2832dSAlan Stern  * hub is suspended).  Nevertheless, we change @udev->state to
31200aa2832dSAlan Stern  * USB_STATE_SUSPENDED as this is the device's "logical" state.  The actual
31210aa2832dSAlan Stern  * upstream port setting is stored in @udev->port_is_suspended.
31224956eccdSAlan Stern  *
31231da177e4SLinus Torvalds  * Returns 0 on success, else negative errno.
31241da177e4SLinus Torvalds  */
312565bfd296SAlan Stern int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
31261da177e4SLinus Torvalds {
3127ad493e5eSLan Tianyu 	struct usb_hub	*hub = usb_hub_to_struct_hub(udev->parent);
3128ad493e5eSLan Tianyu 	struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3129624d6c07SAlan Stern 	int		port1 = udev->portnum;
3130624d6c07SAlan Stern 	int		status;
31310aa2832dSAlan Stern 	bool		really_suspend = true;
31324956eccdSAlan Stern 
31335c79a1e3SDan Williams 	usb_lock_port(port_dev);
31345c79a1e3SDan Williams 
3135624d6c07SAlan Stern 	/* enable remote wakeup when appropriate; this lets the device
3136624d6c07SAlan Stern 	 * wake up the upstream hub (including maybe the root hub).
3137624d6c07SAlan Stern 	 *
3138624d6c07SAlan Stern 	 * NOTE:  OTG devices may issue remote wakeup (or SRP) even when
3139624d6c07SAlan Stern 	 * we don't explicitly enable it here.
3140624d6c07SAlan Stern 	 */
3141624d6c07SAlan Stern 	if (udev->do_remote_wakeup) {
314228e86165SAlan Stern 		status = usb_enable_remote_wakeup(udev);
31430c487206SOliver Neukum 		if (status) {
3144624d6c07SAlan Stern 			dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
3145624d6c07SAlan Stern 					status);
31460c487206SOliver Neukum 			/* bail if autosuspend is requested */
31475b1b0b81SAlan Stern 			if (PMSG_IS_AUTO(msg))
31484fae6f0fSAlan Stern 				goto err_wakeup;
31490c487206SOliver Neukum 		}
3150624d6c07SAlan Stern 	}
3151624d6c07SAlan Stern 
315265580b43SAndiry Xu 	/* disable USB2 hardware LPM */
315365580b43SAndiry Xu 	if (udev->usb2_hw_lpm_enabled == 1)
315465580b43SAndiry Xu 		usb_set_usb2_hardware_lpm(udev, 0);
315565580b43SAndiry Xu 
3156f74631e3SSarah Sharp 	if (usb_disable_ltm(udev)) {
31574fae6f0fSAlan Stern 		dev_err(&udev->dev, "Failed to disable LTM before suspend\n.");
31584fae6f0fSAlan Stern 		status = -ENOMEM;
31594fae6f0fSAlan Stern 		if (PMSG_IS_AUTO(msg))
31604fae6f0fSAlan Stern 			goto err_ltm;
3161f74631e3SSarah Sharp 	}
31628306095fSSarah Sharp 
3163624d6c07SAlan Stern 	/* see 7.1.7.6 */
3164a7114230SAndiry Xu 	if (hub_is_superspeed(hub->hdev))
3165c2f60db7SSarah Sharp 		status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U3);
3166e583d9dbSAlan Stern 
31670aa2832dSAlan Stern 	/*
31680aa2832dSAlan Stern 	 * For system suspend, we do not need to enable the suspend feature
31690aa2832dSAlan Stern 	 * on individual USB-2 ports.  The devices will automatically go
31700aa2832dSAlan Stern 	 * into suspend a few ms after the root hub stops sending packets.
31710aa2832dSAlan Stern 	 * The USB 2.0 spec calls this "global suspend".
3172e583d9dbSAlan Stern 	 *
3173e583d9dbSAlan Stern 	 * However, many USB hubs have a bug: They don't relay wakeup requests
3174e583d9dbSAlan Stern 	 * from a downstream port if the port's suspend feature isn't on.
3175e583d9dbSAlan Stern 	 * Therefore we will turn on the suspend feature if udev or any of its
3176e583d9dbSAlan Stern 	 * descendants is enabled for remote wakeup.
31770aa2832dSAlan Stern 	 */
3178e583d9dbSAlan Stern 	else if (PMSG_IS_AUTO(msg) || wakeup_enabled_descendants(udev) > 0)
3179e583d9dbSAlan Stern 		status = set_port_feature(hub->hdev, port1,
3180e583d9dbSAlan Stern 				USB_PORT_FEAT_SUSPEND);
31810aa2832dSAlan Stern 	else {
31820aa2832dSAlan Stern 		really_suspend = false;
31830aa2832dSAlan Stern 		status = 0;
31840aa2832dSAlan Stern 	}
3185624d6c07SAlan Stern 	if (status) {
3186d99f6b41SDan Williams 		dev_dbg(&port_dev->dev, "can't suspend, status %d\n", status);
3187cbb33004SAlan Stern 
3188d590c231SMathias Nyman 		/* Try to enable USB3 LTM again */
31894fae6f0fSAlan Stern 		usb_enable_ltm(udev);
31904fae6f0fSAlan Stern  err_ltm:
3191c3e751e4SAndiry Xu 		/* Try to enable USB2 hardware LPM again */
3192c3e751e4SAndiry Xu 		if (udev->usb2_hw_lpm_capable == 1)
3193c3e751e4SAndiry Xu 			usb_set_usb2_hardware_lpm(udev, 1);
3194c3e751e4SAndiry Xu 
31954fae6f0fSAlan Stern 		if (udev->do_remote_wakeup)
31964fae6f0fSAlan Stern 			(void) usb_disable_remote_wakeup(udev);
31974fae6f0fSAlan Stern  err_wakeup:
31988306095fSSarah Sharp 
3199cbb33004SAlan Stern 		/* System sleep transitions should never fail */
32005b1b0b81SAlan Stern 		if (!PMSG_IS_AUTO(msg))
3201cbb33004SAlan Stern 			status = 0;
3202624d6c07SAlan Stern 	} else {
320330b1a7a3SAlan Stern 		dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
320430b1a7a3SAlan Stern 				(PMSG_IS_AUTO(msg) ? "auto-" : ""),
320530b1a7a3SAlan Stern 				udev->do_remote_wakeup);
32060aa2832dSAlan Stern 		if (really_suspend) {
3207bfd1e910SAlan Stern 			udev->port_is_suspended = 1;
3208e583d9dbSAlan Stern 
3209e583d9dbSAlan Stern 			/* device has up to 10 msec to fully suspend */
3210624d6c07SAlan Stern 			msleep(10);
3211624d6c07SAlan Stern 		}
3212e583d9dbSAlan Stern 		usb_set_device_state(udev, USB_STATE_SUSPENDED);
32130aa2832dSAlan Stern 	}
3214ad493e5eSLan Tianyu 
3215d5c3834eSDan Williams 	if (status == 0 && !udev->do_remote_wakeup && udev->persist_enabled
3216d5c3834eSDan Williams 			&& test_and_clear_bit(port1, hub->child_usage_bits))
3217ad493e5eSLan Tianyu 		pm_runtime_put_sync(&port_dev->dev);
3218ad493e5eSLan Tianyu 
3219c08512c7SAlan Stern 	usb_mark_last_busy(hub->hdev);
32205c79a1e3SDan Williams 
32215c79a1e3SDan Williams 	usb_unlock_port(port_dev);
32224956eccdSAlan Stern 	return status;
32231da177e4SLinus Torvalds }
3224f3f3253dSDavid Brownell 
32251da177e4SLinus Torvalds /*
3226390a8c34SDavid Brownell  * If the USB "suspend" state is in use (rather than "global suspend"),
3227390a8c34SDavid Brownell  * many devices will be individually taken out of suspend state using
322854515fe5SAlan Stern  * special "resume" signaling.  This routine kicks in shortly after
32291da177e4SLinus Torvalds  * hardware resume signaling is finished, either because of selective
32301da177e4SLinus Torvalds  * resume (by host) or remote wakeup (by device) ... now see what changed
32311da177e4SLinus Torvalds  * in the tree that's rooted at this device.
323254515fe5SAlan Stern  *
323354515fe5SAlan Stern  * If @udev->reset_resume is set then the device is reset before the
323454515fe5SAlan Stern  * status check is done.
32351da177e4SLinus Torvalds  */
3236140d8f68SAlan Stern static int finish_port_resume(struct usb_device *udev)
32371da177e4SLinus Torvalds {
323854515fe5SAlan Stern 	int	status = 0;
323907e72b95SOliver Neukum 	u16	devstatus = 0;
32401da177e4SLinus Torvalds 
32411da177e4SLinus Torvalds 	/* caller owns the udev device lock */
3242b9cef6c3SWu Fengguang 	dev_dbg(&udev->dev, "%s\n",
3243b9cef6c3SWu Fengguang 		udev->reset_resume ? "finish reset-resume" : "finish resume");
32441da177e4SLinus Torvalds 
32451da177e4SLinus Torvalds 	/* usb ch9 identifies four variants of SUSPENDED, based on what
32461da177e4SLinus Torvalds 	 * state the device resumes to.  Linux currently won't see the
32471da177e4SLinus Torvalds 	 * first two on the host side; they'd be inside hub_port_init()
324837ebb549SPetr Mladek 	 * during many timeouts, but hub_wq can't suspend until later.
32491da177e4SLinus Torvalds 	 */
32501da177e4SLinus Torvalds 	usb_set_device_state(udev, udev->actconfig
32511da177e4SLinus Torvalds 			? USB_STATE_CONFIGURED
32521da177e4SLinus Torvalds 			: USB_STATE_ADDRESS);
32531da177e4SLinus Torvalds 
325454515fe5SAlan Stern 	/* 10.5.4.5 says not to reset a suspended port if the attached
325554515fe5SAlan Stern 	 * device is enabled for remote wakeup.  Hence the reset
325654515fe5SAlan Stern 	 * operation is carried out here, after the port has been
325754515fe5SAlan Stern 	 * resumed.
325854515fe5SAlan Stern 	 */
32591d10255cSAlan Stern 	if (udev->reset_resume) {
32601d10255cSAlan Stern 		/*
32611d10255cSAlan Stern 		 * If the device morphs or switches modes when it is reset,
32621d10255cSAlan Stern 		 * we don't want to perform a reset-resume.  We'll fail the
32631d10255cSAlan Stern 		 * resume, which will cause a logical disconnect, and then
32641d10255cSAlan Stern 		 * the device will be rediscovered.
32651d10255cSAlan Stern 		 */
326686c57edfSAlan Stern  retry_reset_resume:
32671d10255cSAlan Stern 		if (udev->quirks & USB_QUIRK_RESET)
32681d10255cSAlan Stern 			status = -ENODEV;
32691d10255cSAlan Stern 		else
3270742120c6SMing Lei 			status = usb_reset_and_verify_device(udev);
32711d10255cSAlan Stern 	}
327254515fe5SAlan Stern 
32731da177e4SLinus Torvalds 	/* 10.5.4.5 says be sure devices in the tree are still there.
32741da177e4SLinus Torvalds 	 * For now let's assume the device didn't go crazy on resume,
32751da177e4SLinus Torvalds 	 * and device drivers will know about any resume quirks.
32761da177e4SLinus Torvalds 	 */
327754515fe5SAlan Stern 	if (status == 0) {
327846dede46SAlan Stern 		devstatus = 0;
32791da177e4SLinus Torvalds 		status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
328086c57edfSAlan Stern 
328186c57edfSAlan Stern 		/* If a normal resume failed, try doing a reset-resume */
328286c57edfSAlan Stern 		if (status && !udev->reset_resume && udev->persist_enabled) {
328386c57edfSAlan Stern 			dev_dbg(&udev->dev, "retry with reset-resume\n");
328486c57edfSAlan Stern 			udev->reset_resume = 1;
328586c57edfSAlan Stern 			goto retry_reset_resume;
328686c57edfSAlan Stern 		}
328754515fe5SAlan Stern 	}
3288b40b7a90SAlan Stern 
3289624d6c07SAlan Stern 	if (status) {
3290624d6c07SAlan Stern 		dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
32911da177e4SLinus Torvalds 				status);
329207e72b95SOliver Neukum 	/*
329307e72b95SOliver Neukum 	 * There are a few quirky devices which violate the standard
329407e72b95SOliver Neukum 	 * by claiming to have remote wakeup enabled after a reset,
329507e72b95SOliver Neukum 	 * which crash if the feature is cleared, hence check for
329607e72b95SOliver Neukum 	 * udev->reset_resume
329707e72b95SOliver Neukum 	 */
329807e72b95SOliver Neukum 	} else if (udev->actconfig && !udev->reset_resume) {
329928e86165SAlan Stern 		if (udev->speed < USB_SPEED_SUPER) {
330054a3ac0cSLan Tianyu 			if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
330128e86165SAlan Stern 				status = usb_disable_remote_wakeup(udev);
330254a3ac0cSLan Tianyu 		} else {
330354a3ac0cSLan Tianyu 			status = usb_get_status(udev, USB_RECIP_INTERFACE, 0,
330454a3ac0cSLan Tianyu 					&devstatus);
330554a3ac0cSLan Tianyu 			if (!status && devstatus & (USB_INTRF_STAT_FUNC_RW_CAP
330654a3ac0cSLan Tianyu 					| USB_INTRF_STAT_FUNC_RW))
330728e86165SAlan Stern 				status = usb_disable_remote_wakeup(udev);
330854a3ac0cSLan Tianyu 		}
330954a3ac0cSLan Tianyu 
3310a8e7c565SAlan Stern 		if (status)
3311b9cef6c3SWu Fengguang 			dev_dbg(&udev->dev,
3312b9cef6c3SWu Fengguang 				"disable remote wakeup, status %d\n",
3313b9cef6c3SWu Fengguang 				status);
33141da177e4SLinus Torvalds 		status = 0;
33151da177e4SLinus Torvalds 	}
33161da177e4SLinus Torvalds 	return status;
33171da177e4SLinus Torvalds }
33181da177e4SLinus Torvalds 
3319624d6c07SAlan Stern /*
3320a40178b2SPratyush Anand  * There are some SS USB devices which take longer time for link training.
3321a40178b2SPratyush Anand  * XHCI specs 4.19.4 says that when Link training is successful, port
33226b82b122SAl Cooper  * sets CCS bit to 1. So if SW reads port status before successful link
3323a40178b2SPratyush Anand  * training, then it will not find device to be present.
3324a40178b2SPratyush Anand  * USB Analyzer log with such buggy devices show that in some cases
3325a40178b2SPratyush Anand  * device switch on the RX termination after long delay of host enabling
3326a40178b2SPratyush Anand  * the VBUS. In few other cases it has been seen that device fails to
3327a40178b2SPratyush Anand  * negotiate link training in first attempt. It has been
3328a40178b2SPratyush Anand  * reported till now that few devices take as long as 2000 ms to train
3329a40178b2SPratyush Anand  * the link after host enabling its VBUS and termination. Following
3330a40178b2SPratyush Anand  * routine implements a 2000 ms timeout for link training. If in a case
3331a40178b2SPratyush Anand  * link trains before timeout, loop will exit earlier.
3332a40178b2SPratyush Anand  *
33336b82b122SAl Cooper  * There are also some 2.0 hard drive based devices and 3.0 thumb
33346b82b122SAl Cooper  * drives that, when plugged into a 2.0 only port, take a long
33356b82b122SAl Cooper  * time to set CCS after VBUS enable.
33366b82b122SAl Cooper  *
3337a40178b2SPratyush Anand  * FIXME: If a device was connected before suspend, but was removed
3338a40178b2SPratyush Anand  * while system was asleep, then the loop in the following routine will
3339a40178b2SPratyush Anand  * only exit at timeout.
3340a40178b2SPratyush Anand  *
33416b82b122SAl Cooper  * This routine should only be called when persist is enabled.
3342a40178b2SPratyush Anand  */
33436b82b122SAl Cooper static int wait_for_connected(struct usb_device *udev,
3344a40178b2SPratyush Anand 		struct usb_hub *hub, int *port1,
3345a40178b2SPratyush Anand 		u16 *portchange, u16 *portstatus)
3346a40178b2SPratyush Anand {
3347a40178b2SPratyush Anand 	int status = 0, delay_ms = 0;
3348a40178b2SPratyush Anand 
3349a40178b2SPratyush Anand 	while (delay_ms < 2000) {
3350a40178b2SPratyush Anand 		if (status || *portstatus & USB_PORT_STAT_CONNECTION)
3351a40178b2SPratyush Anand 			break;
3352a40178b2SPratyush Anand 		msleep(20);
3353a40178b2SPratyush Anand 		delay_ms += 20;
3354a40178b2SPratyush Anand 		status = hub_port_status(hub, *port1, portstatus, portchange);
3355a40178b2SPratyush Anand 	}
33566b82b122SAl Cooper 	dev_dbg(&udev->dev, "Waited %dms for CONNECT\n", delay_ms);
3357a40178b2SPratyush Anand 	return status;
3358a40178b2SPratyush Anand }
3359a40178b2SPratyush Anand 
3360a40178b2SPratyush Anand /*
3361624d6c07SAlan Stern  * usb_port_resume - re-activate a suspended usb device's upstream port
3362624d6c07SAlan Stern  * @udev: device to re-activate, not a root hub
3363624d6c07SAlan Stern  * Context: must be able to sleep; device not locked; pm locks held
3364624d6c07SAlan Stern  *
3365624d6c07SAlan Stern  * This will re-activate the suspended device, increasing power usage
3366624d6c07SAlan Stern  * while letting drivers communicate again with its endpoints.
3367624d6c07SAlan Stern  * USB resume explicitly guarantees that the power session between
3368624d6c07SAlan Stern  * the host and the device is the same as it was when the device
3369624d6c07SAlan Stern  * suspended.
3370624d6c07SAlan Stern  *
3371feccc30dSAlan Stern  * If @udev->reset_resume is set then this routine won't check that the
3372feccc30dSAlan Stern  * port is still enabled.  Furthermore, finish_port_resume() above will
337354515fe5SAlan Stern  * reset @udev.  The end result is that a broken power session can be
337454515fe5SAlan Stern  * recovered and @udev will appear to persist across a loss of VBUS power.
337554515fe5SAlan Stern  *
337654515fe5SAlan Stern  * For example, if a host controller doesn't maintain VBUS suspend current
337754515fe5SAlan Stern  * during a system sleep or is reset when the system wakes up, all the USB
337854515fe5SAlan Stern  * power sessions below it will be broken.  This is especially troublesome
337954515fe5SAlan Stern  * for mass-storage devices containing mounted filesystems, since the
338054515fe5SAlan Stern  * device will appear to have disconnected and all the memory mappings
338154515fe5SAlan Stern  * to it will be lost.  Using the USB_PERSIST facility, the device can be
338254515fe5SAlan Stern  * made to appear as if it had not disconnected.
338354515fe5SAlan Stern  *
3384742120c6SMing Lei  * This facility can be dangerous.  Although usb_reset_and_verify_device() makes
3385feccc30dSAlan Stern  * every effort to insure that the same device is present after the
338654515fe5SAlan Stern  * reset as before, it cannot provide a 100% guarantee.  Furthermore it's
338754515fe5SAlan Stern  * quite possible for a device to remain unaltered but its media to be
338854515fe5SAlan Stern  * changed.  If the user replaces a flash memory card while the system is
338954515fe5SAlan Stern  * asleep, he will have only himself to blame when the filesystem on the
339054515fe5SAlan Stern  * new card is corrupted and the system crashes.
339154515fe5SAlan Stern  *
3392624d6c07SAlan Stern  * Returns 0 on success, else negative errno.
3393624d6c07SAlan Stern  */
339465bfd296SAlan Stern int usb_port_resume(struct usb_device *udev, pm_message_t msg)
33951da177e4SLinus Torvalds {
3396ad493e5eSLan Tianyu 	struct usb_hub	*hub = usb_hub_to_struct_hub(udev->parent);
3397ad493e5eSLan Tianyu 	struct usb_port *port_dev = hub->ports[udev->portnum  - 1];
3398624d6c07SAlan Stern 	int		port1 = udev->portnum;
33991da177e4SLinus Torvalds 	int		status;
3400d25450c6SAlan Stern 	u16		portchange, portstatus;
3401d25450c6SAlan Stern 
3402d5c3834eSDan Williams 	if (!test_and_set_bit(port1, hub->child_usage_bits)) {
3403ad493e5eSLan Tianyu 		status = pm_runtime_get_sync(&port_dev->dev);
3404ad493e5eSLan Tianyu 		if (status < 0) {
3405ad493e5eSLan Tianyu 			dev_dbg(&udev->dev, "can't resume usb port, status %d\n",
3406ad493e5eSLan Tianyu 					status);
3407ad493e5eSLan Tianyu 			return status;
3408ad493e5eSLan Tianyu 		}
3409ad493e5eSLan Tianyu 	}
3410ad493e5eSLan Tianyu 
34115c79a1e3SDan Williams 	usb_lock_port(port_dev);
34125c79a1e3SDan Williams 
3413d25450c6SAlan Stern 	/* Skip the initial Clear-Suspend step for a remote wakeup */
3414d25450c6SAlan Stern 	status = hub_port_status(hub, port1, &portstatus, &portchange);
34150ed9a57eSAndiry Xu 	if (status == 0 && !port_is_suspended(hub, portstatus))
3416d25450c6SAlan Stern 		goto SuspendCleared;
34171da177e4SLinus Torvalds 
34181da177e4SLinus Torvalds 	/* see 7.1.7.7; affects power usage, but not budgeting */
3419a7114230SAndiry Xu 	if (hub_is_superspeed(hub->hdev))
3420c2f60db7SSarah Sharp 		status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U0);
3421a7114230SAndiry Xu 	else
3422ad493e5eSLan Tianyu 		status = usb_clear_port_feature(hub->hdev,
34231da177e4SLinus Torvalds 				port1, USB_PORT_FEAT_SUSPEND);
34241da177e4SLinus Torvalds 	if (status) {
3425d99f6b41SDan Williams 		dev_dbg(&port_dev->dev, "can't resume, status %d\n", status);
34261da177e4SLinus Torvalds 	} else {
3427bbc78c07SFelipe Balbi 		/* drive resume for USB_RESUME_TIMEOUT msec */
3428645daaabSAlan Stern 		dev_dbg(&udev->dev, "usb %sresume\n",
34295b1b0b81SAlan Stern 				(PMSG_IS_AUTO(msg) ? "auto-" : ""));
3430bbc78c07SFelipe Balbi 		msleep(USB_RESUME_TIMEOUT);
34311da177e4SLinus Torvalds 
34321da177e4SLinus Torvalds 		/* Virtual root hubs can trigger on GET_PORT_STATUS to
34331da177e4SLinus Torvalds 		 * stop resume signaling.  Then finish the resume
34341da177e4SLinus Torvalds 		 * sequence.
34351da177e4SLinus Torvalds 		 */
3436d25450c6SAlan Stern 		status = hub_port_status(hub, port1, &portstatus, &portchange);
343754515fe5SAlan Stern 
34381da177e4SLinus Torvalds 		/* TRSMRCY = 10 msec */
34391da177e4SLinus Torvalds 		msleep(10);
34401da177e4SLinus Torvalds 	}
3441b01b03f3SAlan Stern 
3442b01b03f3SAlan Stern  SuspendCleared:
3443b01b03f3SAlan Stern 	if (status == 0) {
3444bfd1e910SAlan Stern 		udev->port_is_suspended = 0;
3445a7114230SAndiry Xu 		if (hub_is_superspeed(hub->hdev)) {
3446a7114230SAndiry Xu 			if (portchange & USB_PORT_STAT_C_LINK_STATE)
3447ad493e5eSLan Tianyu 				usb_clear_port_feature(hub->hdev, port1,
3448a7114230SAndiry Xu 					USB_PORT_FEAT_C_PORT_LINK_STATE);
3449a7114230SAndiry Xu 		} else {
3450b01b03f3SAlan Stern 			if (portchange & USB_PORT_STAT_C_SUSPEND)
3451ad493e5eSLan Tianyu 				usb_clear_port_feature(hub->hdev, port1,
3452b01b03f3SAlan Stern 						USB_PORT_FEAT_C_SUSPEND);
34531da177e4SLinus Torvalds 		}
3454a7114230SAndiry Xu 	}
34551da177e4SLinus Torvalds 
34566b82b122SAl Cooper 	if (udev->persist_enabled)
34576b82b122SAl Cooper 		status = wait_for_connected(udev, hub, &port1, &portchange,
3458a40178b2SPratyush Anand 				&portstatus);
3459a40178b2SPratyush Anand 
3460b01b03f3SAlan Stern 	status = check_port_resume_type(udev,
3461b01b03f3SAlan Stern 			hub, port1, status, portchange, portstatus);
346254515fe5SAlan Stern 	if (status == 0)
346354515fe5SAlan Stern 		status = finish_port_resume(udev);
346454515fe5SAlan Stern 	if (status < 0) {
346554515fe5SAlan Stern 		dev_dbg(&udev->dev, "can't resume, status %d\n", status);
346654515fe5SAlan Stern 		hub_port_logical_disconnect(hub, port1);
346765580b43SAndiry Xu 	} else  {
346865580b43SAndiry Xu 		/* Try to enable USB2 hardware LPM */
346965580b43SAndiry Xu 		if (udev->usb2_hw_lpm_capable == 1)
347065580b43SAndiry Xu 			usb_set_usb2_hardware_lpm(udev, 1);
34718306095fSSarah Sharp 
3472d590c231SMathias Nyman 		/* Try to enable USB3 LTM */
3473f74631e3SSarah Sharp 		usb_enable_ltm(udev);
347454515fe5SAlan Stern 	}
347565580b43SAndiry Xu 
34765c79a1e3SDan Williams 	usb_unlock_port(port_dev);
34775c79a1e3SDan Williams 
34781da177e4SLinus Torvalds 	return status;
34791da177e4SLinus Torvalds }
34801da177e4SLinus Torvalds 
34810534d468SAlan Stern int usb_remote_wakeup(struct usb_device *udev)
34821da177e4SLinus Torvalds {
34831da177e4SLinus Torvalds 	int	status = 0;
34841da177e4SLinus Torvalds 
34855c79a1e3SDan Williams 	usb_lock_device(udev);
34861da177e4SLinus Torvalds 	if (udev->state == USB_STATE_SUSPENDED) {
3487645daaabSAlan Stern 		dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
34889bbdf1e0SAlan Stern 		status = usb_autoresume_device(udev);
34899bbdf1e0SAlan Stern 		if (status == 0) {
34909bbdf1e0SAlan Stern 			/* Let the drivers do their thing, then... */
34919bbdf1e0SAlan Stern 			usb_autosuspend_device(udev);
34929bbdf1e0SAlan Stern 		}
3493d25450c6SAlan Stern 	}
34945c79a1e3SDan Williams 	usb_unlock_device(udev);
34951da177e4SLinus Torvalds 	return status;
34961da177e4SLinus Torvalds }
34971da177e4SLinus Torvalds 
34987e73be22SDan Williams /* Returns 1 if there was a remote wakeup and a connect status change. */
34997e73be22SDan Williams static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
35007e73be22SDan Williams 		u16 portstatus, u16 portchange)
35017e73be22SDan Williams 		__must_hold(&port_dev->status_lock)
35027e73be22SDan Williams {
35037e73be22SDan Williams 	struct usb_port *port_dev = hub->ports[port - 1];
35047e73be22SDan Williams 	struct usb_device *hdev;
35057e73be22SDan Williams 	struct usb_device *udev;
35067e73be22SDan Williams 	int connect_change = 0;
35077e73be22SDan Williams 	int ret;
35087e73be22SDan Williams 
35097e73be22SDan Williams 	hdev = hub->hdev;
35107e73be22SDan Williams 	udev = port_dev->child;
35117e73be22SDan Williams 	if (!hub_is_superspeed(hdev)) {
35127e73be22SDan Williams 		if (!(portchange & USB_PORT_STAT_C_SUSPEND))
35137e73be22SDan Williams 			return 0;
35147e73be22SDan Williams 		usb_clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
35157e73be22SDan Williams 	} else {
35167e73be22SDan Williams 		if (!udev || udev->state != USB_STATE_SUSPENDED ||
35177e73be22SDan Williams 				 (portstatus & USB_PORT_STAT_LINK_STATE) !=
35187e73be22SDan Williams 				 USB_SS_PORT_LS_U0)
35197e73be22SDan Williams 			return 0;
35207e73be22SDan Williams 	}
35217e73be22SDan Williams 
35227e73be22SDan Williams 	if (udev) {
35237e73be22SDan Williams 		/* TRSMRCY = 10 msec */
35247e73be22SDan Williams 		msleep(10);
35257e73be22SDan Williams 
35267e73be22SDan Williams 		usb_unlock_port(port_dev);
35277e73be22SDan Williams 		ret = usb_remote_wakeup(udev);
35287e73be22SDan Williams 		usb_lock_port(port_dev);
35297e73be22SDan Williams 		if (ret < 0)
35307e73be22SDan Williams 			connect_change = 1;
35317e73be22SDan Williams 	} else {
35327e73be22SDan Williams 		ret = -ENODEV;
35337e73be22SDan Williams 		hub_port_disable(hub, port, 1);
35347e73be22SDan Williams 	}
35357e73be22SDan Williams 	dev_dbg(&port_dev->dev, "resume, status %d\n", ret);
35367e73be22SDan Williams 	return connect_change;
35377e73be22SDan Williams }
35387e73be22SDan Williams 
3539e6f30deaSMing Lei static int check_ports_changed(struct usb_hub *hub)
3540e6f30deaSMing Lei {
3541e6f30deaSMing Lei 	int port1;
3542e6f30deaSMing Lei 
3543e6f30deaSMing Lei 	for (port1 = 1; port1 <= hub->hdev->maxchild; ++port1) {
3544e6f30deaSMing Lei 		u16 portstatus, portchange;
3545e6f30deaSMing Lei 		int status;
3546e6f30deaSMing Lei 
3547e6f30deaSMing Lei 		status = hub_port_status(hub, port1, &portstatus, &portchange);
3548e6f30deaSMing Lei 		if (!status && portchange)
3549e6f30deaSMing Lei 			return 1;
3550e6f30deaSMing Lei 	}
3551e6f30deaSMing Lei 	return 0;
3552e6f30deaSMing Lei }
3553e6f30deaSMing Lei 
3554db690874SDavid Brownell static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
35551da177e4SLinus Torvalds {
35561da177e4SLinus Torvalds 	struct usb_hub		*hub = usb_get_intfdata(intf);
35571da177e4SLinus Torvalds 	struct usb_device	*hdev = hub->hdev;
35581da177e4SLinus Torvalds 	unsigned		port1;
35594296c70aSSarah Sharp 	int			status;
35601da177e4SLinus Torvalds 
3561e583d9dbSAlan Stern 	/*
3562e583d9dbSAlan Stern 	 * Warn if children aren't already suspended.
3563e583d9dbSAlan Stern 	 * Also, add up the number of wakeup-enabled descendants.
3564e583d9dbSAlan Stern 	 */
3565e583d9dbSAlan Stern 	hub->wakeup_enabled_descendants = 0;
35661da177e4SLinus Torvalds 	for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3567d99f6b41SDan Williams 		struct usb_port *port_dev = hub->ports[port1 - 1];
3568d99f6b41SDan Williams 		struct usb_device *udev = port_dev->child;
35691da177e4SLinus Torvalds 
35706840d255SAlan Stern 		if (udev && udev->can_submit) {
3571b658b8f5SDan Williams 			dev_warn(&port_dev->dev, "device %s not suspended yet\n",
3572b658b8f5SDan Williams 					dev_name(&udev->dev));
35735b1b0b81SAlan Stern 			if (PMSG_IS_AUTO(msg))
3574c9f89fa4SDavid Brownell 				return -EBUSY;
3575c9f89fa4SDavid Brownell 		}
3576e583d9dbSAlan Stern 		if (udev)
3577e583d9dbSAlan Stern 			hub->wakeup_enabled_descendants +=
3578e583d9dbSAlan Stern 					wakeup_enabled_descendants(udev);
35791da177e4SLinus Torvalds 	}
3580e6f30deaSMing Lei 
3581e6f30deaSMing Lei 	if (hdev->do_remote_wakeup && hub->quirk_check_port_auto_suspend) {
3582e6f30deaSMing Lei 		/* check if there are changes pending on hub ports */
3583e6f30deaSMing Lei 		if (check_ports_changed(hub)) {
3584e6f30deaSMing Lei 			if (PMSG_IS_AUTO(msg))
3585e6f30deaSMing Lei 				return -EBUSY;
3586e6f30deaSMing Lei 			pm_wakeup_event(&hdev->dev, 2000);
3587e6f30deaSMing Lei 		}
3588e6f30deaSMing Lei 	}
3589e6f30deaSMing Lei 
35904296c70aSSarah Sharp 	if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
35914296c70aSSarah Sharp 		/* Enable hub to send remote wakeup for all ports. */
35924296c70aSSarah Sharp 		for (port1 = 1; port1 <= hdev->maxchild; port1++) {
35934296c70aSSarah Sharp 			status = set_port_feature(hdev,
35944296c70aSSarah Sharp 					port1 |
35954296c70aSSarah Sharp 					USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
35964296c70aSSarah Sharp 					USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
35974296c70aSSarah Sharp 					USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
35984296c70aSSarah Sharp 					USB_PORT_FEAT_REMOTE_WAKE_MASK);
35994296c70aSSarah Sharp 		}
36004296c70aSSarah Sharp 	}
36011da177e4SLinus Torvalds 
3602441b62c1SHarvey Harrison 	dev_dbg(&intf->dev, "%s\n", __func__);
360340f122f3SAlan Stern 
360437ebb549SPetr Mladek 	/* stop hub_wq and related activity */
36054330354fSAlan Stern 	hub_quiesce(hub, HUB_SUSPEND);
3606b6f6436dSAlan Stern 	return 0;
36071da177e4SLinus Torvalds }
36081da177e4SLinus Torvalds 
36091da177e4SLinus Torvalds static int hub_resume(struct usb_interface *intf)
36101da177e4SLinus Torvalds {
36111da177e4SLinus Torvalds 	struct usb_hub *hub = usb_get_intfdata(intf);
36121da177e4SLinus Torvalds 
36135e6effaeSAlan Stern 	dev_dbg(&intf->dev, "%s\n", __func__);
3614f2835219SAlan Stern 	hub_activate(hub, HUB_RESUME);
36151da177e4SLinus Torvalds 	return 0;
36161da177e4SLinus Torvalds }
36171da177e4SLinus Torvalds 
3618b41a60ecSAlan Stern static int hub_reset_resume(struct usb_interface *intf)
3619f07600cfSAlan Stern {
3620b41a60ecSAlan Stern 	struct usb_hub *hub = usb_get_intfdata(intf);
3621f07600cfSAlan Stern 
36225e6effaeSAlan Stern 	dev_dbg(&intf->dev, "%s\n", __func__);
3623f2835219SAlan Stern 	hub_activate(hub, HUB_RESET_RESUME);
3624f07600cfSAlan Stern 	return 0;
3625f07600cfSAlan Stern }
3626f07600cfSAlan Stern 
362754515fe5SAlan Stern /**
362854515fe5SAlan Stern  * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
362954515fe5SAlan Stern  * @rhdev: struct usb_device for the root hub
363054515fe5SAlan Stern  *
363154515fe5SAlan Stern  * The USB host controller driver calls this function when its root hub
363254515fe5SAlan Stern  * is resumed and Vbus power has been interrupted or the controller
3633feccc30dSAlan Stern  * has been reset.  The routine marks @rhdev as having lost power.
3634feccc30dSAlan Stern  * When the hub driver is resumed it will take notice and carry out
3635feccc30dSAlan Stern  * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3636feccc30dSAlan Stern  * the others will be disconnected.
363754515fe5SAlan Stern  */
363854515fe5SAlan Stern void usb_root_hub_lost_power(struct usb_device *rhdev)
363954515fe5SAlan Stern {
364054515fe5SAlan Stern 	dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
364154515fe5SAlan Stern 	rhdev->reset_resume = 1;
364254515fe5SAlan Stern }
364354515fe5SAlan Stern EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
364454515fe5SAlan Stern 
36451ea7e0e8SSarah Sharp static const char * const usb3_lpm_names[]  = {
36461ea7e0e8SSarah Sharp 	"U0",
36471ea7e0e8SSarah Sharp 	"U1",
36481ea7e0e8SSarah Sharp 	"U2",
36491ea7e0e8SSarah Sharp 	"U3",
36501ea7e0e8SSarah Sharp };
36511ea7e0e8SSarah Sharp 
36521ea7e0e8SSarah Sharp /*
36531ea7e0e8SSarah Sharp  * Send a Set SEL control transfer to the device, prior to enabling
36541ea7e0e8SSarah Sharp  * device-initiated U1 or U2.  This lets the device know the exit latencies from
36551ea7e0e8SSarah Sharp  * the time the device initiates a U1 or U2 exit, to the time it will receive a
36561ea7e0e8SSarah Sharp  * packet from the host.
36571ea7e0e8SSarah Sharp  *
36581ea7e0e8SSarah Sharp  * This function will fail if the SEL or PEL values for udev are greater than
36591ea7e0e8SSarah Sharp  * the maximum allowed values for the link state to be enabled.
36601ea7e0e8SSarah Sharp  */
36611ea7e0e8SSarah Sharp static int usb_req_set_sel(struct usb_device *udev, enum usb3_link_state state)
36621ea7e0e8SSarah Sharp {
36631ea7e0e8SSarah Sharp 	struct usb_set_sel_req *sel_values;
36641ea7e0e8SSarah Sharp 	unsigned long long u1_sel;
36651ea7e0e8SSarah Sharp 	unsigned long long u1_pel;
36661ea7e0e8SSarah Sharp 	unsigned long long u2_sel;
36671ea7e0e8SSarah Sharp 	unsigned long long u2_pel;
36681ea7e0e8SSarah Sharp 	int ret;
36691ea7e0e8SSarah Sharp 
367038d7f688SXenia Ragiadakou 	if (udev->state != USB_STATE_CONFIGURED)
367138d7f688SXenia Ragiadakou 		return 0;
367238d7f688SXenia Ragiadakou 
36731ea7e0e8SSarah Sharp 	/* Convert SEL and PEL stored in ns to us */
36741ea7e0e8SSarah Sharp 	u1_sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
36751ea7e0e8SSarah Sharp 	u1_pel = DIV_ROUND_UP(udev->u1_params.pel, 1000);
36761ea7e0e8SSarah Sharp 	u2_sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
36771ea7e0e8SSarah Sharp 	u2_pel = DIV_ROUND_UP(udev->u2_params.pel, 1000);
36781ea7e0e8SSarah Sharp 
36791ea7e0e8SSarah Sharp 	/*
36801ea7e0e8SSarah Sharp 	 * Make sure that the calculated SEL and PEL values for the link
36811ea7e0e8SSarah Sharp 	 * state we're enabling aren't bigger than the max SEL/PEL
36821ea7e0e8SSarah Sharp 	 * value that will fit in the SET SEL control transfer.
36831ea7e0e8SSarah Sharp 	 * Otherwise the device would get an incorrect idea of the exit
36841ea7e0e8SSarah Sharp 	 * latency for the link state, and could start a device-initiated
36851ea7e0e8SSarah Sharp 	 * U1/U2 when the exit latencies are too high.
36861ea7e0e8SSarah Sharp 	 */
36871ea7e0e8SSarah Sharp 	if ((state == USB3_LPM_U1 &&
36881ea7e0e8SSarah Sharp 				(u1_sel > USB3_LPM_MAX_U1_SEL_PEL ||
36891ea7e0e8SSarah Sharp 				 u1_pel > USB3_LPM_MAX_U1_SEL_PEL)) ||
36901ea7e0e8SSarah Sharp 			(state == USB3_LPM_U2 &&
36911ea7e0e8SSarah Sharp 			 (u2_sel > USB3_LPM_MAX_U2_SEL_PEL ||
36921ea7e0e8SSarah Sharp 			  u2_pel > USB3_LPM_MAX_U2_SEL_PEL))) {
36931510a1a2SSarah Sharp 		dev_dbg(&udev->dev, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
36941ea7e0e8SSarah Sharp 				usb3_lpm_names[state], u1_sel, u1_pel);
36951ea7e0e8SSarah Sharp 		return -EINVAL;
36961ea7e0e8SSarah Sharp 	}
36971ea7e0e8SSarah Sharp 
36981ea7e0e8SSarah Sharp 	/*
36991ea7e0e8SSarah Sharp 	 * If we're enabling device-initiated LPM for one link state,
37001ea7e0e8SSarah Sharp 	 * but the other link state has a too high SEL or PEL value,
37011ea7e0e8SSarah Sharp 	 * just set those values to the max in the Set SEL request.
37021ea7e0e8SSarah Sharp 	 */
37031ea7e0e8SSarah Sharp 	if (u1_sel > USB3_LPM_MAX_U1_SEL_PEL)
37041ea7e0e8SSarah Sharp 		u1_sel = USB3_LPM_MAX_U1_SEL_PEL;
37051ea7e0e8SSarah Sharp 
37061ea7e0e8SSarah Sharp 	if (u1_pel > USB3_LPM_MAX_U1_SEL_PEL)
37071ea7e0e8SSarah Sharp 		u1_pel = USB3_LPM_MAX_U1_SEL_PEL;
37081ea7e0e8SSarah Sharp 
37091ea7e0e8SSarah Sharp 	if (u2_sel > USB3_LPM_MAX_U2_SEL_PEL)
37101ea7e0e8SSarah Sharp 		u2_sel = USB3_LPM_MAX_U2_SEL_PEL;
37111ea7e0e8SSarah Sharp 
37121ea7e0e8SSarah Sharp 	if (u2_pel > USB3_LPM_MAX_U2_SEL_PEL)
37131ea7e0e8SSarah Sharp 		u2_pel = USB3_LPM_MAX_U2_SEL_PEL;
37141ea7e0e8SSarah Sharp 
37151ea7e0e8SSarah Sharp 	/*
37161ea7e0e8SSarah Sharp 	 * usb_enable_lpm() can be called as part of a failed device reset,
37171ea7e0e8SSarah Sharp 	 * which may be initiated by an error path of a mass storage driver.
37181ea7e0e8SSarah Sharp 	 * Therefore, use GFP_NOIO.
37191ea7e0e8SSarah Sharp 	 */
37201ea7e0e8SSarah Sharp 	sel_values = kmalloc(sizeof *(sel_values), GFP_NOIO);
37211ea7e0e8SSarah Sharp 	if (!sel_values)
37221ea7e0e8SSarah Sharp 		return -ENOMEM;
37231ea7e0e8SSarah Sharp 
37241ea7e0e8SSarah Sharp 	sel_values->u1_sel = u1_sel;
37251ea7e0e8SSarah Sharp 	sel_values->u1_pel = u1_pel;
37261ea7e0e8SSarah Sharp 	sel_values->u2_sel = cpu_to_le16(u2_sel);
37271ea7e0e8SSarah Sharp 	sel_values->u2_pel = cpu_to_le16(u2_pel);
37281ea7e0e8SSarah Sharp 
37291ea7e0e8SSarah Sharp 	ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
37301ea7e0e8SSarah Sharp 			USB_REQ_SET_SEL,
37311ea7e0e8SSarah Sharp 			USB_RECIP_DEVICE,
37321ea7e0e8SSarah Sharp 			0, 0,
37331ea7e0e8SSarah Sharp 			sel_values, sizeof *(sel_values),
37341ea7e0e8SSarah Sharp 			USB_CTRL_SET_TIMEOUT);
37351ea7e0e8SSarah Sharp 	kfree(sel_values);
37361ea7e0e8SSarah Sharp 	return ret;
37371ea7e0e8SSarah Sharp }
37381ea7e0e8SSarah Sharp 
37391ea7e0e8SSarah Sharp /*
37401ea7e0e8SSarah Sharp  * Enable or disable device-initiated U1 or U2 transitions.
37411ea7e0e8SSarah Sharp  */
37421ea7e0e8SSarah Sharp static int usb_set_device_initiated_lpm(struct usb_device *udev,
37431ea7e0e8SSarah Sharp 		enum usb3_link_state state, bool enable)
37441ea7e0e8SSarah Sharp {
37451ea7e0e8SSarah Sharp 	int ret;
37461ea7e0e8SSarah Sharp 	int feature;
37471ea7e0e8SSarah Sharp 
37481ea7e0e8SSarah Sharp 	switch (state) {
37491ea7e0e8SSarah Sharp 	case USB3_LPM_U1:
37501ea7e0e8SSarah Sharp 		feature = USB_DEVICE_U1_ENABLE;
37511ea7e0e8SSarah Sharp 		break;
37521ea7e0e8SSarah Sharp 	case USB3_LPM_U2:
37531ea7e0e8SSarah Sharp 		feature = USB_DEVICE_U2_ENABLE;
37541ea7e0e8SSarah Sharp 		break;
37551ea7e0e8SSarah Sharp 	default:
37561ea7e0e8SSarah Sharp 		dev_warn(&udev->dev, "%s: Can't %s non-U1 or U2 state.\n",
37571ea7e0e8SSarah Sharp 				__func__, enable ? "enable" : "disable");
37581ea7e0e8SSarah Sharp 		return -EINVAL;
37591ea7e0e8SSarah Sharp 	}
37601ea7e0e8SSarah Sharp 
37611ea7e0e8SSarah Sharp 	if (udev->state != USB_STATE_CONFIGURED) {
37621ea7e0e8SSarah Sharp 		dev_dbg(&udev->dev, "%s: Can't %s %s state "
37631ea7e0e8SSarah Sharp 				"for unconfigured device.\n",
37641ea7e0e8SSarah Sharp 				__func__, enable ? "enable" : "disable",
37651ea7e0e8SSarah Sharp 				usb3_lpm_names[state]);
37661ea7e0e8SSarah Sharp 		return 0;
37671ea7e0e8SSarah Sharp 	}
37681ea7e0e8SSarah Sharp 
37691ea7e0e8SSarah Sharp 	if (enable) {
37701ea7e0e8SSarah Sharp 		/*
37711ea7e0e8SSarah Sharp 		 * Now send the control transfer to enable device-initiated LPM
37721ea7e0e8SSarah Sharp 		 * for either U1 or U2.
37731ea7e0e8SSarah Sharp 		 */
37741ea7e0e8SSarah Sharp 		ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
37751ea7e0e8SSarah Sharp 				USB_REQ_SET_FEATURE,
37761ea7e0e8SSarah Sharp 				USB_RECIP_DEVICE,
37771ea7e0e8SSarah Sharp 				feature,
37781ea7e0e8SSarah Sharp 				0, NULL, 0,
37791ea7e0e8SSarah Sharp 				USB_CTRL_SET_TIMEOUT);
37801ea7e0e8SSarah Sharp 	} else {
37811ea7e0e8SSarah Sharp 		ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
37821ea7e0e8SSarah Sharp 				USB_REQ_CLEAR_FEATURE,
37831ea7e0e8SSarah Sharp 				USB_RECIP_DEVICE,
37841ea7e0e8SSarah Sharp 				feature,
37851ea7e0e8SSarah Sharp 				0, NULL, 0,
37861ea7e0e8SSarah Sharp 				USB_CTRL_SET_TIMEOUT);
37871ea7e0e8SSarah Sharp 	}
37881ea7e0e8SSarah Sharp 	if (ret < 0) {
37891ea7e0e8SSarah Sharp 		dev_warn(&udev->dev, "%s of device-initiated %s failed.\n",
37901ea7e0e8SSarah Sharp 				enable ? "Enable" : "Disable",
37911ea7e0e8SSarah Sharp 				usb3_lpm_names[state]);
37921ea7e0e8SSarah Sharp 		return -EBUSY;
37931ea7e0e8SSarah Sharp 	}
37941ea7e0e8SSarah Sharp 	return 0;
37951ea7e0e8SSarah Sharp }
37961ea7e0e8SSarah Sharp 
37971ea7e0e8SSarah Sharp static int usb_set_lpm_timeout(struct usb_device *udev,
37981ea7e0e8SSarah Sharp 		enum usb3_link_state state, int timeout)
37991ea7e0e8SSarah Sharp {
38001ea7e0e8SSarah Sharp 	int ret;
38011ea7e0e8SSarah Sharp 	int feature;
38021ea7e0e8SSarah Sharp 
38031ea7e0e8SSarah Sharp 	switch (state) {
38041ea7e0e8SSarah Sharp 	case USB3_LPM_U1:
38051ea7e0e8SSarah Sharp 		feature = USB_PORT_FEAT_U1_TIMEOUT;
38061ea7e0e8SSarah Sharp 		break;
38071ea7e0e8SSarah Sharp 	case USB3_LPM_U2:
38081ea7e0e8SSarah Sharp 		feature = USB_PORT_FEAT_U2_TIMEOUT;
38091ea7e0e8SSarah Sharp 		break;
38101ea7e0e8SSarah Sharp 	default:
38111ea7e0e8SSarah Sharp 		dev_warn(&udev->dev, "%s: Can't set timeout for non-U1 or U2 state.\n",
38121ea7e0e8SSarah Sharp 				__func__);
38131ea7e0e8SSarah Sharp 		return -EINVAL;
38141ea7e0e8SSarah Sharp 	}
38151ea7e0e8SSarah Sharp 
38161ea7e0e8SSarah Sharp 	if (state == USB3_LPM_U1 && timeout > USB3_LPM_U1_MAX_TIMEOUT &&
38171ea7e0e8SSarah Sharp 			timeout != USB3_LPM_DEVICE_INITIATED) {
38181ea7e0e8SSarah Sharp 		dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x, "
38191ea7e0e8SSarah Sharp 				"which is a reserved value.\n",
38201ea7e0e8SSarah Sharp 				usb3_lpm_names[state], timeout);
38211ea7e0e8SSarah Sharp 		return -EINVAL;
38221ea7e0e8SSarah Sharp 	}
38231ea7e0e8SSarah Sharp 
38241ea7e0e8SSarah Sharp 	ret = set_port_feature(udev->parent,
38251ea7e0e8SSarah Sharp 			USB_PORT_LPM_TIMEOUT(timeout) | udev->portnum,
38261ea7e0e8SSarah Sharp 			feature);
38271ea7e0e8SSarah Sharp 	if (ret < 0) {
38281ea7e0e8SSarah Sharp 		dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x,"
38291ea7e0e8SSarah Sharp 				"error code %i\n", usb3_lpm_names[state],
38301ea7e0e8SSarah Sharp 				timeout, ret);
38311ea7e0e8SSarah Sharp 		return -EBUSY;
38321ea7e0e8SSarah Sharp 	}
38331ea7e0e8SSarah Sharp 	if (state == USB3_LPM_U1)
38341ea7e0e8SSarah Sharp 		udev->u1_params.timeout = timeout;
38351ea7e0e8SSarah Sharp 	else
38361ea7e0e8SSarah Sharp 		udev->u2_params.timeout = timeout;
38371ea7e0e8SSarah Sharp 	return 0;
38381ea7e0e8SSarah Sharp }
38391ea7e0e8SSarah Sharp 
38401ea7e0e8SSarah Sharp /*
38411ea7e0e8SSarah Sharp  * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
38421ea7e0e8SSarah Sharp  * U1/U2 entry.
38431ea7e0e8SSarah Sharp  *
38441ea7e0e8SSarah Sharp  * We will attempt to enable U1 or U2, but there are no guarantees that the
38451ea7e0e8SSarah Sharp  * control transfers to set the hub timeout or enable device-initiated U1/U2
38461ea7e0e8SSarah Sharp  * will be successful.
38471ea7e0e8SSarah Sharp  *
38481ea7e0e8SSarah Sharp  * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
38491ea7e0e8SSarah Sharp  * driver know about it.  If that call fails, it should be harmless, and just
38501ea7e0e8SSarah Sharp  * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
38511ea7e0e8SSarah Sharp  */
38521ea7e0e8SSarah Sharp static void usb_enable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
38531ea7e0e8SSarah Sharp 		enum usb3_link_state state)
38541ea7e0e8SSarah Sharp {
385565a95b75SSarah Sharp 	int timeout, ret;
3856ae8963adSSarah Sharp 	__u8 u1_mel = udev->bos->ss_cap->bU1devExitLat;
3857ae8963adSSarah Sharp 	__le16 u2_mel = udev->bos->ss_cap->bU2DevExitLat;
3858ae8963adSSarah Sharp 
3859ae8963adSSarah Sharp 	/* If the device says it doesn't have *any* exit latency to come out of
3860ae8963adSSarah Sharp 	 * U1 or U2, it's probably lying.  Assume it doesn't implement that link
3861ae8963adSSarah Sharp 	 * state.
3862ae8963adSSarah Sharp 	 */
3863ae8963adSSarah Sharp 	if ((state == USB3_LPM_U1 && u1_mel == 0) ||
3864ae8963adSSarah Sharp 			(state == USB3_LPM_U2 && u2_mel == 0))
3865ae8963adSSarah Sharp 		return;
38661ea7e0e8SSarah Sharp 
386765a95b75SSarah Sharp 	/*
386865a95b75SSarah Sharp 	 * First, let the device know about the exit latencies
386965a95b75SSarah Sharp 	 * associated with the link state we're about to enable.
387065a95b75SSarah Sharp 	 */
387165a95b75SSarah Sharp 	ret = usb_req_set_sel(udev, state);
387265a95b75SSarah Sharp 	if (ret < 0) {
387365a95b75SSarah Sharp 		dev_warn(&udev->dev, "Set SEL for device-initiated %s failed.\n",
387465a95b75SSarah Sharp 				usb3_lpm_names[state]);
387565a95b75SSarah Sharp 		return;
387665a95b75SSarah Sharp 	}
387765a95b75SSarah Sharp 
38781ea7e0e8SSarah Sharp 	/* We allow the host controller to set the U1/U2 timeout internally
38791ea7e0e8SSarah Sharp 	 * first, so that it can change its schedule to account for the
38801ea7e0e8SSarah Sharp 	 * additional latency to send data to a device in a lower power
38811ea7e0e8SSarah Sharp 	 * link state.
38821ea7e0e8SSarah Sharp 	 */
38831ea7e0e8SSarah Sharp 	timeout = hcd->driver->enable_usb3_lpm_timeout(hcd, udev, state);
38841ea7e0e8SSarah Sharp 
38851ea7e0e8SSarah Sharp 	/* xHCI host controller doesn't want to enable this LPM state. */
38861ea7e0e8SSarah Sharp 	if (timeout == 0)
38871ea7e0e8SSarah Sharp 		return;
38881ea7e0e8SSarah Sharp 
38891ea7e0e8SSarah Sharp 	if (timeout < 0) {
38901ea7e0e8SSarah Sharp 		dev_warn(&udev->dev, "Could not enable %s link state, "
38911ea7e0e8SSarah Sharp 				"xHCI error %i.\n", usb3_lpm_names[state],
38921ea7e0e8SSarah Sharp 				timeout);
38931ea7e0e8SSarah Sharp 		return;
38941ea7e0e8SSarah Sharp 	}
38951ea7e0e8SSarah Sharp 
3896bf5ce5bfSLu Baolu 	if (usb_set_lpm_timeout(udev, state, timeout)) {
38971ea7e0e8SSarah Sharp 		/* If we can't set the parent hub U1/U2 timeout,
38981ea7e0e8SSarah Sharp 		 * device-initiated LPM won't be allowed either, so let the xHCI
38991ea7e0e8SSarah Sharp 		 * host know that this link state won't be enabled.
39001ea7e0e8SSarah Sharp 		 */
39011ea7e0e8SSarah Sharp 		hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
3902bf5ce5bfSLu Baolu 	} else {
3903bf5ce5bfSLu Baolu 		/* Only a configured device will accept the Set Feature
3904bf5ce5bfSLu Baolu 		 * U1/U2_ENABLE
3905bf5ce5bfSLu Baolu 		 */
3906bf5ce5bfSLu Baolu 		if (udev->actconfig)
39071ea7e0e8SSarah Sharp 			usb_set_device_initiated_lpm(udev, state, true);
39081ea7e0e8SSarah Sharp 
3909bf5ce5bfSLu Baolu 		/* As soon as usb_set_lpm_timeout(timeout) returns 0, the
3910bf5ce5bfSLu Baolu 		 * hub-initiated LPM is enabled. Thus, LPM is enabled no
3911bf5ce5bfSLu Baolu 		 * matter the result of usb_set_device_initiated_lpm().
3912bf5ce5bfSLu Baolu 		 * The only difference is whether device is able to initiate
3913bf5ce5bfSLu Baolu 		 * LPM.
3914bf5ce5bfSLu Baolu 		 */
3915bf5ce5bfSLu Baolu 		if (state == USB3_LPM_U1)
3916bf5ce5bfSLu Baolu 			udev->usb3_lpm_u1_enabled = 1;
3917bf5ce5bfSLu Baolu 		else if (state == USB3_LPM_U2)
3918bf5ce5bfSLu Baolu 			udev->usb3_lpm_u2_enabled = 1;
3919bf5ce5bfSLu Baolu 	}
39201ea7e0e8SSarah Sharp }
39211ea7e0e8SSarah Sharp 
39221ea7e0e8SSarah Sharp /*
39231ea7e0e8SSarah Sharp  * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
39241ea7e0e8SSarah Sharp  * U1/U2 entry.
39251ea7e0e8SSarah Sharp  *
39261ea7e0e8SSarah Sharp  * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
39271ea7e0e8SSarah Sharp  * If zero is returned, the parent will not allow the link to go into U1/U2.
39281ea7e0e8SSarah Sharp  *
39291ea7e0e8SSarah Sharp  * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
39301ea7e0e8SSarah Sharp  * it won't have an effect on the bus link state because the parent hub will
39311ea7e0e8SSarah Sharp  * still disallow device-initiated U1/U2 entry.
39321ea7e0e8SSarah Sharp  *
39331ea7e0e8SSarah Sharp  * If zero is returned, the xHCI host controller may still think U1/U2 entry is
39341ea7e0e8SSarah Sharp  * possible.  The result will be slightly more bus bandwidth will be taken up
39351ea7e0e8SSarah Sharp  * (to account for U1/U2 exit latency), but it should be harmless.
39361ea7e0e8SSarah Sharp  */
39371ea7e0e8SSarah Sharp static int usb_disable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
39381ea7e0e8SSarah Sharp 		enum usb3_link_state state)
39391ea7e0e8SSarah Sharp {
39401ea7e0e8SSarah Sharp 	switch (state) {
39411ea7e0e8SSarah Sharp 	case USB3_LPM_U1:
39421ea7e0e8SSarah Sharp 	case USB3_LPM_U2:
39431ea7e0e8SSarah Sharp 		break;
39441ea7e0e8SSarah Sharp 	default:
39451ea7e0e8SSarah Sharp 		dev_warn(&udev->dev, "%s: Can't disable non-U1 or U2 state.\n",
39461ea7e0e8SSarah Sharp 				__func__);
39471ea7e0e8SSarah Sharp 		return -EINVAL;
39481ea7e0e8SSarah Sharp 	}
39491ea7e0e8SSarah Sharp 
39501ea7e0e8SSarah Sharp 	if (usb_set_lpm_timeout(udev, state, 0))
39511ea7e0e8SSarah Sharp 		return -EBUSY;
39521ea7e0e8SSarah Sharp 
39531ea7e0e8SSarah Sharp 	usb_set_device_initiated_lpm(udev, state, false);
39541ea7e0e8SSarah Sharp 
39551ea7e0e8SSarah Sharp 	if (hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state))
39561ea7e0e8SSarah Sharp 		dev_warn(&udev->dev, "Could not disable xHCI %s timeout, "
39571ea7e0e8SSarah Sharp 				"bus schedule bandwidth may be impacted.\n",
39581ea7e0e8SSarah Sharp 				usb3_lpm_names[state]);
3959bf5ce5bfSLu Baolu 
3960bf5ce5bfSLu Baolu 	/* As soon as usb_set_lpm_timeout(0) return 0, hub initiated LPM
3961bf5ce5bfSLu Baolu 	 * is disabled. Hub will disallows link to enter U1/U2 as well,
3962bf5ce5bfSLu Baolu 	 * even device is initiating LPM. Hence LPM is disabled if hub LPM
3963bf5ce5bfSLu Baolu 	 * timeout set to 0, no matter device-initiated LPM is disabled or
3964bf5ce5bfSLu Baolu 	 * not.
3965bf5ce5bfSLu Baolu 	 */
3966bf5ce5bfSLu Baolu 	if (state == USB3_LPM_U1)
3967bf5ce5bfSLu Baolu 		udev->usb3_lpm_u1_enabled = 0;
3968bf5ce5bfSLu Baolu 	else if (state == USB3_LPM_U2)
3969bf5ce5bfSLu Baolu 		udev->usb3_lpm_u2_enabled = 0;
3970bf5ce5bfSLu Baolu 
39711ea7e0e8SSarah Sharp 	return 0;
39721ea7e0e8SSarah Sharp }
39731ea7e0e8SSarah Sharp 
39741ea7e0e8SSarah Sharp /*
39751ea7e0e8SSarah Sharp  * Disable hub-initiated and device-initiated U1 and U2 entry.
39761ea7e0e8SSarah Sharp  * Caller must own the bandwidth_mutex.
39771ea7e0e8SSarah Sharp  *
39781ea7e0e8SSarah Sharp  * This will call usb_enable_lpm() on failure, which will decrement
39791ea7e0e8SSarah Sharp  * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
39801ea7e0e8SSarah Sharp  */
39811ea7e0e8SSarah Sharp int usb_disable_lpm(struct usb_device *udev)
39821ea7e0e8SSarah Sharp {
39831ea7e0e8SSarah Sharp 	struct usb_hcd *hcd;
39841ea7e0e8SSarah Sharp 
39851ea7e0e8SSarah Sharp 	if (!udev || !udev->parent ||
39868a1b2725SMathias Nyman 			udev->speed < USB_SPEED_SUPER ||
398751df62ffSPratyush Anand 			!udev->lpm_capable ||
398851df62ffSPratyush Anand 			udev->state < USB_STATE_DEFAULT)
39891ea7e0e8SSarah Sharp 		return 0;
39901ea7e0e8SSarah Sharp 
39911ea7e0e8SSarah Sharp 	hcd = bus_to_hcd(udev->bus);
39921ea7e0e8SSarah Sharp 	if (!hcd || !hcd->driver->disable_usb3_lpm_timeout)
39931ea7e0e8SSarah Sharp 		return 0;
39941ea7e0e8SSarah Sharp 
39951ea7e0e8SSarah Sharp 	udev->lpm_disable_count++;
399655558c33SDan Carpenter 	if ((udev->u1_params.timeout == 0 && udev->u2_params.timeout == 0))
39971ea7e0e8SSarah Sharp 		return 0;
39981ea7e0e8SSarah Sharp 
39991ea7e0e8SSarah Sharp 	/* If LPM is enabled, attempt to disable it. */
40001ea7e0e8SSarah Sharp 	if (usb_disable_link_state(hcd, udev, USB3_LPM_U1))
40011ea7e0e8SSarah Sharp 		goto enable_lpm;
40021ea7e0e8SSarah Sharp 	if (usb_disable_link_state(hcd, udev, USB3_LPM_U2))
40031ea7e0e8SSarah Sharp 		goto enable_lpm;
40041ea7e0e8SSarah Sharp 
40051ea7e0e8SSarah Sharp 	return 0;
40061ea7e0e8SSarah Sharp 
40071ea7e0e8SSarah Sharp enable_lpm:
40081ea7e0e8SSarah Sharp 	usb_enable_lpm(udev);
40091ea7e0e8SSarah Sharp 	return -EBUSY;
40101ea7e0e8SSarah Sharp }
40111ea7e0e8SSarah Sharp EXPORT_SYMBOL_GPL(usb_disable_lpm);
40121ea7e0e8SSarah Sharp 
40131ea7e0e8SSarah Sharp /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
40141ea7e0e8SSarah Sharp int usb_unlocked_disable_lpm(struct usb_device *udev)
40151ea7e0e8SSarah Sharp {
40161ea7e0e8SSarah Sharp 	struct usb_hcd *hcd = bus_to_hcd(udev->bus);
40171ea7e0e8SSarah Sharp 	int ret;
40181ea7e0e8SSarah Sharp 
40191ea7e0e8SSarah Sharp 	if (!hcd)
40201ea7e0e8SSarah Sharp 		return -EINVAL;
40211ea7e0e8SSarah Sharp 
40221ea7e0e8SSarah Sharp 	mutex_lock(hcd->bandwidth_mutex);
40231ea7e0e8SSarah Sharp 	ret = usb_disable_lpm(udev);
40241ea7e0e8SSarah Sharp 	mutex_unlock(hcd->bandwidth_mutex);
40251ea7e0e8SSarah Sharp 
40261ea7e0e8SSarah Sharp 	return ret;
40271ea7e0e8SSarah Sharp }
40281ea7e0e8SSarah Sharp EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
40291ea7e0e8SSarah Sharp 
40301ea7e0e8SSarah Sharp /*
40311ea7e0e8SSarah Sharp  * Attempt to enable device-initiated and hub-initiated U1 and U2 entry.  The
40321ea7e0e8SSarah Sharp  * xHCI host policy may prevent U1 or U2 from being enabled.
40331ea7e0e8SSarah Sharp  *
40341ea7e0e8SSarah Sharp  * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
40351ea7e0e8SSarah Sharp  * until the lpm_disable_count drops to zero.  Caller must own the
40361ea7e0e8SSarah Sharp  * bandwidth_mutex.
40371ea7e0e8SSarah Sharp  */
40381ea7e0e8SSarah Sharp void usb_enable_lpm(struct usb_device *udev)
40391ea7e0e8SSarah Sharp {
40401ea7e0e8SSarah Sharp 	struct usb_hcd *hcd;
4041513072d9SLu Baolu 	struct usb_hub *hub;
4042513072d9SLu Baolu 	struct usb_port *port_dev;
40431ea7e0e8SSarah Sharp 
40441ea7e0e8SSarah Sharp 	if (!udev || !udev->parent ||
40458a1b2725SMathias Nyman 			udev->speed < USB_SPEED_SUPER ||
404651df62ffSPratyush Anand 			!udev->lpm_capable ||
404751df62ffSPratyush Anand 			udev->state < USB_STATE_DEFAULT)
40481ea7e0e8SSarah Sharp 		return;
40491ea7e0e8SSarah Sharp 
40501ea7e0e8SSarah Sharp 	udev->lpm_disable_count--;
40511ea7e0e8SSarah Sharp 	hcd = bus_to_hcd(udev->bus);
40521ea7e0e8SSarah Sharp 	/* Double check that we can both enable and disable LPM.
40531ea7e0e8SSarah Sharp 	 * Device must be configured to accept set feature U1/U2 timeout.
40541ea7e0e8SSarah Sharp 	 */
40551ea7e0e8SSarah Sharp 	if (!hcd || !hcd->driver->enable_usb3_lpm_timeout ||
40561ea7e0e8SSarah Sharp 			!hcd->driver->disable_usb3_lpm_timeout)
40571ea7e0e8SSarah Sharp 		return;
40581ea7e0e8SSarah Sharp 
40591ea7e0e8SSarah Sharp 	if (udev->lpm_disable_count > 0)
40601ea7e0e8SSarah Sharp 		return;
40611ea7e0e8SSarah Sharp 
4062513072d9SLu Baolu 	hub = usb_hub_to_struct_hub(udev->parent);
4063513072d9SLu Baolu 	if (!hub)
4064513072d9SLu Baolu 		return;
4065513072d9SLu Baolu 
4066513072d9SLu Baolu 	port_dev = hub->ports[udev->portnum - 1];
4067513072d9SLu Baolu 
4068513072d9SLu Baolu 	if (port_dev->usb3_lpm_u1_permit)
40691ea7e0e8SSarah Sharp 		usb_enable_link_state(hcd, udev, USB3_LPM_U1);
4070513072d9SLu Baolu 
4071513072d9SLu Baolu 	if (port_dev->usb3_lpm_u2_permit)
40721ea7e0e8SSarah Sharp 		usb_enable_link_state(hcd, udev, USB3_LPM_U2);
40731ea7e0e8SSarah Sharp }
40741ea7e0e8SSarah Sharp EXPORT_SYMBOL_GPL(usb_enable_lpm);
40751ea7e0e8SSarah Sharp 
40761ea7e0e8SSarah Sharp /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
40771ea7e0e8SSarah Sharp void usb_unlocked_enable_lpm(struct usb_device *udev)
40781ea7e0e8SSarah Sharp {
40791ea7e0e8SSarah Sharp 	struct usb_hcd *hcd = bus_to_hcd(udev->bus);
40801ea7e0e8SSarah Sharp 
40811ea7e0e8SSarah Sharp 	if (!hcd)
40821ea7e0e8SSarah Sharp 		return;
40831ea7e0e8SSarah Sharp 
40841ea7e0e8SSarah Sharp 	mutex_lock(hcd->bandwidth_mutex);
40851ea7e0e8SSarah Sharp 	usb_enable_lpm(udev);
40861ea7e0e8SSarah Sharp 	mutex_unlock(hcd->bandwidth_mutex);
40871ea7e0e8SSarah Sharp }
40881ea7e0e8SSarah Sharp EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
40891ea7e0e8SSarah Sharp 
409037be6676SMathias Nyman /* usb3 devices use U3 for disabled, make sure remote wakeup is disabled */
409137be6676SMathias Nyman static void hub_usb3_port_prepare_disable(struct usb_hub *hub,
409237be6676SMathias Nyman 					  struct usb_port *port_dev)
409337be6676SMathias Nyman {
409437be6676SMathias Nyman 	struct usb_device *udev = port_dev->child;
409537be6676SMathias Nyman 	int ret;
409637be6676SMathias Nyman 
409737be6676SMathias Nyman 	if (udev && udev->port_is_suspended && udev->do_remote_wakeup) {
409837be6676SMathias Nyman 		ret = hub_set_port_link_state(hub, port_dev->portnum,
409937be6676SMathias Nyman 					      USB_SS_PORT_LS_U0);
410037be6676SMathias Nyman 		if (!ret) {
410137be6676SMathias Nyman 			msleep(USB_RESUME_TIMEOUT);
410237be6676SMathias Nyman 			ret = usb_disable_remote_wakeup(udev);
410337be6676SMathias Nyman 		}
410437be6676SMathias Nyman 		if (ret)
410537be6676SMathias Nyman 			dev_warn(&udev->dev,
410637be6676SMathias Nyman 				 "Port disable: can't disable remote wake\n");
410737be6676SMathias Nyman 		udev->do_remote_wakeup = 0;
410837be6676SMathias Nyman 	}
410937be6676SMathias Nyman }
41101ea7e0e8SSarah Sharp 
4111d388dab7SAlan Stern #else	/* CONFIG_PM */
4112d388dab7SAlan Stern 
4113511366daSAndrew Morton #define hub_suspend		NULL
4114511366daSAndrew Morton #define hub_resume		NULL
4115f07600cfSAlan Stern #define hub_reset_resume	NULL
41161ea7e0e8SSarah Sharp 
411737be6676SMathias Nyman static inline void hub_usb3_port_prepare_disable(struct usb_hub *hub,
411837be6676SMathias Nyman 						 struct usb_port *port_dev) { }
411937be6676SMathias Nyman 
41201ea7e0e8SSarah Sharp int usb_disable_lpm(struct usb_device *udev)
41211ea7e0e8SSarah Sharp {
41221ea7e0e8SSarah Sharp 	return 0;
41231ea7e0e8SSarah Sharp }
4124e9261fb6SSarah Sharp EXPORT_SYMBOL_GPL(usb_disable_lpm);
41251ea7e0e8SSarah Sharp 
41261ea7e0e8SSarah Sharp void usb_enable_lpm(struct usb_device *udev) { }
4127e9261fb6SSarah Sharp EXPORT_SYMBOL_GPL(usb_enable_lpm);
41281ea7e0e8SSarah Sharp 
41291ea7e0e8SSarah Sharp int usb_unlocked_disable_lpm(struct usb_device *udev)
41301ea7e0e8SSarah Sharp {
41311ea7e0e8SSarah Sharp 	return 0;
41321ea7e0e8SSarah Sharp }
4133e9261fb6SSarah Sharp EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
41341ea7e0e8SSarah Sharp 
41351ea7e0e8SSarah Sharp void usb_unlocked_enable_lpm(struct usb_device *udev) { }
4136e9261fb6SSarah Sharp EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
4137f74631e3SSarah Sharp 
4138f74631e3SSarah Sharp int usb_disable_ltm(struct usb_device *udev)
4139f74631e3SSarah Sharp {
4140f74631e3SSarah Sharp 	return 0;
4141f74631e3SSarah Sharp }
4142f74631e3SSarah Sharp EXPORT_SYMBOL_GPL(usb_disable_ltm);
4143f74631e3SSarah Sharp 
4144f74631e3SSarah Sharp void usb_enable_ltm(struct usb_device *udev) { }
4145f74631e3SSarah Sharp EXPORT_SYMBOL_GPL(usb_enable_ltm);
4146c4b51a43SAlan Stern 
41474a95b1fcSStephen Rothwell static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
41484a95b1fcSStephen Rothwell 		u16 portstatus, u16 portchange)
41494a95b1fcSStephen Rothwell {
41504a95b1fcSStephen Rothwell 	return 0;
41514a95b1fcSStephen Rothwell }
41524a95b1fcSStephen Rothwell 
4153c4b51a43SAlan Stern #endif	/* CONFIG_PM */
4154d388dab7SAlan Stern 
41553bc02bceSGeert Uytterhoeven /*
41563bc02bceSGeert Uytterhoeven  * USB-3 does not have a similar link state as USB-2 that will avoid negotiating
41573bc02bceSGeert Uytterhoeven  * a connection with a plugged-in cable but will signal the host when the cable
41583bc02bceSGeert Uytterhoeven  * is unplugged. Disable remote wake and set link state to U3 for USB-3 devices
41593bc02bceSGeert Uytterhoeven  */
41603bc02bceSGeert Uytterhoeven static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
41613bc02bceSGeert Uytterhoeven {
41623bc02bceSGeert Uytterhoeven 	struct usb_port *port_dev = hub->ports[port1 - 1];
41633bc02bceSGeert Uytterhoeven 	struct usb_device *hdev = hub->hdev;
41643bc02bceSGeert Uytterhoeven 	int ret = 0;
41653bc02bceSGeert Uytterhoeven 
41663bc02bceSGeert Uytterhoeven 	if (!hub->error) {
41673bc02bceSGeert Uytterhoeven 		if (hub_is_superspeed(hub->hdev)) {
41683bc02bceSGeert Uytterhoeven 			hub_usb3_port_prepare_disable(hub, port_dev);
41693bc02bceSGeert Uytterhoeven 			ret = hub_set_port_link_state(hub, port_dev->portnum,
41703bc02bceSGeert Uytterhoeven 						      USB_SS_PORT_LS_U3);
41713bc02bceSGeert Uytterhoeven 		} else {
41723bc02bceSGeert Uytterhoeven 			ret = usb_clear_port_feature(hdev, port1,
41733bc02bceSGeert Uytterhoeven 					USB_PORT_FEAT_ENABLE);
41743bc02bceSGeert Uytterhoeven 		}
41753bc02bceSGeert Uytterhoeven 	}
41763bc02bceSGeert Uytterhoeven 	if (port_dev->child && set_state)
41773bc02bceSGeert Uytterhoeven 		usb_set_device_state(port_dev->child, USB_STATE_NOTATTACHED);
41783bc02bceSGeert Uytterhoeven 	if (ret && ret != -ENODEV)
41793bc02bceSGeert Uytterhoeven 		dev_err(&port_dev->dev, "cannot disable (err = %d)\n", ret);
41803bc02bceSGeert Uytterhoeven 	return ret;
41813bc02bceSGeert Uytterhoeven }
41823bc02bceSGeert Uytterhoeven 
41831da177e4SLinus Torvalds 
41841da177e4SLinus Torvalds /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
41851da177e4SLinus Torvalds  *
41861da177e4SLinus Torvalds  * Between connect detection and reset signaling there must be a delay
41871da177e4SLinus Torvalds  * of 100ms at least for debounce and power-settling.  The corresponding
41881da177e4SLinus Torvalds  * timer shall restart whenever the downstream port detects a disconnect.
41891da177e4SLinus Torvalds  *
41901da177e4SLinus Torvalds  * Apparently there are some bluetooth and irda-dongles and a number of
41911da177e4SLinus Torvalds  * low-speed devices for which this debounce period may last over a second.
41921da177e4SLinus Torvalds  * Not covered by the spec - but easy to deal with.
41931da177e4SLinus Torvalds  *
41941da177e4SLinus Torvalds  * This implementation uses a 1500ms total debounce timeout; if the
41951da177e4SLinus Torvalds  * connection isn't stable by then it returns -ETIMEDOUT.  It checks
41961da177e4SLinus Torvalds  * every 25ms for transient disconnects.  When the port status has been
41971da177e4SLinus Torvalds  * unchanged for 100ms it returns the port status.
41981da177e4SLinus Torvalds  */
4199ad493e5eSLan Tianyu int hub_port_debounce(struct usb_hub *hub, int port1, bool must_be_connected)
42001da177e4SLinus Torvalds {
42011da177e4SLinus Torvalds 	int ret;
42021da177e4SLinus Torvalds 	u16 portchange, portstatus;
42031da177e4SLinus Torvalds 	unsigned connection = 0xffff;
4204d99f6b41SDan Williams 	int total_time, stable_time = 0;
4205d99f6b41SDan Williams 	struct usb_port *port_dev = hub->ports[port1 - 1];
42061da177e4SLinus Torvalds 
42071da177e4SLinus Torvalds 	for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
42081da177e4SLinus Torvalds 		ret = hub_port_status(hub, port1, &portstatus, &portchange);
42091da177e4SLinus Torvalds 		if (ret < 0)
42101da177e4SLinus Torvalds 			return ret;
42111da177e4SLinus Torvalds 
42121da177e4SLinus Torvalds 		if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
42131da177e4SLinus Torvalds 		     (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
4214ad493e5eSLan Tianyu 			if (!must_be_connected ||
4215ad493e5eSLan Tianyu 			     (connection == USB_PORT_STAT_CONNECTION))
42161da177e4SLinus Torvalds 				stable_time += HUB_DEBOUNCE_STEP;
42171da177e4SLinus Torvalds 			if (stable_time >= HUB_DEBOUNCE_STABLE)
42181da177e4SLinus Torvalds 				break;
42191da177e4SLinus Torvalds 		} else {
42201da177e4SLinus Torvalds 			stable_time = 0;
42211da177e4SLinus Torvalds 			connection = portstatus & USB_PORT_STAT_CONNECTION;
42221da177e4SLinus Torvalds 		}
42231da177e4SLinus Torvalds 
42241da177e4SLinus Torvalds 		if (portchange & USB_PORT_STAT_C_CONNECTION) {
4225ad493e5eSLan Tianyu 			usb_clear_port_feature(hub->hdev, port1,
42261da177e4SLinus Torvalds 					USB_PORT_FEAT_C_CONNECTION);
42271da177e4SLinus Torvalds 		}
42281da177e4SLinus Torvalds 
42291da177e4SLinus Torvalds 		if (total_time >= HUB_DEBOUNCE_TIMEOUT)
42301da177e4SLinus Torvalds 			break;
42311da177e4SLinus Torvalds 		msleep(HUB_DEBOUNCE_STEP);
42321da177e4SLinus Torvalds 	}
42331da177e4SLinus Torvalds 
4234d99f6b41SDan Williams 	dev_dbg(&port_dev->dev, "debounce total %dms stable %dms status 0x%x\n",
4235d99f6b41SDan Williams 			total_time, stable_time, portstatus);
42361da177e4SLinus Torvalds 
42371da177e4SLinus Torvalds 	if (stable_time < HUB_DEBOUNCE_STABLE)
42381da177e4SLinus Torvalds 		return -ETIMEDOUT;
42391da177e4SLinus Torvalds 	return portstatus;
42401da177e4SLinus Torvalds }
42411da177e4SLinus Torvalds 
4242fc721f51SInaky Perez-Gonzalez void usb_ep0_reinit(struct usb_device *udev)
42431da177e4SLinus Torvalds {
4244ddeac4e7SAlan Stern 	usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
4245ddeac4e7SAlan Stern 	usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
42462caf7fcdSAlan Stern 	usb_enable_endpoint(udev, &udev->ep0, true);
42471da177e4SLinus Torvalds }
4248fc721f51SInaky Perez-Gonzalez EXPORT_SYMBOL_GPL(usb_ep0_reinit);
42491da177e4SLinus Torvalds 
42501da177e4SLinus Torvalds #define usb_sndaddr0pipe()	(PIPE_CONTROL << 30)
42511da177e4SLinus Torvalds #define usb_rcvaddr0pipe()	((PIPE_CONTROL << 30) | USB_DIR_IN)
42521da177e4SLinus Torvalds 
42534326ed0bSAlan Stern static int hub_set_address(struct usb_device *udev, int devnum)
42541da177e4SLinus Torvalds {
42551da177e4SLinus Torvalds 	int retval;
4256c6515272SSarah Sharp 	struct usb_hcd *hcd = bus_to_hcd(udev->bus);
42571da177e4SLinus Torvalds 
4258c6515272SSarah Sharp 	/*
4259c6515272SSarah Sharp 	 * The host controller will choose the device address,
4260c6515272SSarah Sharp 	 * instead of the core having chosen it earlier
4261c6515272SSarah Sharp 	 */
4262c6515272SSarah Sharp 	if (!hcd->driver->address_device && devnum <= 1)
42631da177e4SLinus Torvalds 		return -EINVAL;
42641da177e4SLinus Torvalds 	if (udev->state == USB_STATE_ADDRESS)
42651da177e4SLinus Torvalds 		return 0;
42661da177e4SLinus Torvalds 	if (udev->state != USB_STATE_DEFAULT)
42671da177e4SLinus Torvalds 		return -EINVAL;
4268c8d4af8eSAndiry Xu 	if (hcd->driver->address_device)
4269c6515272SSarah Sharp 		retval = hcd->driver->address_device(hcd, udev);
4270c8d4af8eSAndiry Xu 	else
42711da177e4SLinus Torvalds 		retval = usb_control_msg(udev, usb_sndaddr0pipe(),
42724326ed0bSAlan Stern 				USB_REQ_SET_ADDRESS, 0, devnum, 0,
42731da177e4SLinus Torvalds 				NULL, 0, USB_CTRL_SET_TIMEOUT);
42741da177e4SLinus Torvalds 	if (retval == 0) {
42753b29b68bSAlan Stern 		update_devnum(udev, devnum);
42764953d141SDavid Vrabel 		/* Device now using proper address. */
42771da177e4SLinus Torvalds 		usb_set_device_state(udev, USB_STATE_ADDRESS);
4278fc721f51SInaky Perez-Gonzalez 		usb_ep0_reinit(udev);
42791da177e4SLinus Torvalds 	}
42801da177e4SLinus Torvalds 	return retval;
42811da177e4SLinus Torvalds }
42821da177e4SLinus Torvalds 
4283890dae88SMathias Nyman /*
4284890dae88SMathias Nyman  * There are reports of USB 3.0 devices that say they support USB 2.0 Link PM
4285890dae88SMathias Nyman  * when they're plugged into a USB 2.0 port, but they don't work when LPM is
4286890dae88SMathias Nyman  * enabled.
4287890dae88SMathias Nyman  *
4288890dae88SMathias Nyman  * Only enable USB 2.0 Link PM if the port is internal (hardwired), or the
4289890dae88SMathias Nyman  * device says it supports the new USB 2.0 Link PM errata by setting the BESL
4290890dae88SMathias Nyman  * support bit in the BOS descriptor.
4291890dae88SMathias Nyman  */
4292890dae88SMathias Nyman static void hub_set_initial_usb2_lpm_policy(struct usb_device *udev)
4293890dae88SMathias Nyman {
4294d99f6b41SDan Williams 	struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
4295d99f6b41SDan Williams 	int connect_type = USB_PORT_CONNECT_TYPE_UNKNOWN;
4296890dae88SMathias Nyman 
42977b2db29fSGuenter Roeck 	if (!udev->usb2_hw_lpm_capable || !udev->bos)
4298890dae88SMathias Nyman 		return;
4299890dae88SMathias Nyman 
4300d99f6b41SDan Williams 	if (hub)
4301d99f6b41SDan Williams 		connect_type = hub->ports[udev->portnum - 1]->connect_type;
4302890dae88SMathias Nyman 
430323c05820SBjørn Mork 	if ((udev->bos->ext_cap->bmAttributes & cpu_to_le32(USB_BESL_SUPPORT)) ||
4304890dae88SMathias Nyman 			connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
4305890dae88SMathias Nyman 		udev->usb2_hw_lpm_allowed = 1;
4306890dae88SMathias Nyman 		usb_set_usb2_hardware_lpm(udev, 1);
4307890dae88SMathias Nyman 	}
4308890dae88SMathias Nyman }
4309890dae88SMathias Nyman 
431048fc7dbdSDan Williams static int hub_enable_device(struct usb_device *udev)
431148fc7dbdSDan Williams {
431248fc7dbdSDan Williams 	struct usb_hcd *hcd = bus_to_hcd(udev->bus);
431348fc7dbdSDan Williams 
431448fc7dbdSDan Williams 	if (!hcd->driver->enable_device)
431548fc7dbdSDan Williams 		return 0;
431648fc7dbdSDan Williams 	if (udev->state == USB_STATE_ADDRESS)
431748fc7dbdSDan Williams 		return 0;
431848fc7dbdSDan Williams 	if (udev->state != USB_STATE_DEFAULT)
431948fc7dbdSDan Williams 		return -EINVAL;
432048fc7dbdSDan Williams 
432148fc7dbdSDan Williams 	return hcd->driver->enable_device(hcd, udev);
432248fc7dbdSDan Williams }
432348fc7dbdSDan Williams 
43241da177e4SLinus Torvalds /* Reset device, (re)assign address, get device descriptor.
43251da177e4SLinus Torvalds  * Device connection must be stable, no more debouncing needed.
43261da177e4SLinus Torvalds  * Returns device in USB_STATE_ADDRESS, except on error.
43271da177e4SLinus Torvalds  *
43281da177e4SLinus Torvalds  * If this is called for an already-existing device (as part of
43295c79a1e3SDan Williams  * usb_reset_and_verify_device), the caller must own the device lock and
43305c79a1e3SDan Williams  * the port lock.  For a newly detected device that is not accessible
43315c79a1e3SDan Williams  * through any global pointers, it's not necessary to lock the device,
43325c79a1e3SDan Williams  * but it is still necessary to lock the port.
43331da177e4SLinus Torvalds  */
43341da177e4SLinus Torvalds static int
43351da177e4SLinus Torvalds hub_port_init(struct usb_hub *hub, struct usb_device *udev, int port1,
43361da177e4SLinus Torvalds 		int retry_counter)
43371da177e4SLinus Torvalds {
43381da177e4SLinus Torvalds 	struct usb_device	*hdev = hub->hdev;
4339e7b77172SSarah Sharp 	struct usb_hcd		*hcd = bus_to_hcd(hdev->bus);
43400d5ce778SOliver Neukum 	int			retries, operations, retval, i;
43411da177e4SLinus Torvalds 	unsigned		delay = HUB_SHORT_RESET_TIME;
43421da177e4SLinus Torvalds 	enum usb_device_speed	oldspeed = udev->speed;
4343e538dfdaSMichal Nazarewicz 	const char		*speed;
43444326ed0bSAlan Stern 	int			devnum = udev->devnum;
43451bb90cf0SPeter Chen 	const char		*driver_name;
43461da177e4SLinus Torvalds 
43471da177e4SLinus Torvalds 	/* root hub ports have a slightly longer reset period
43481da177e4SLinus Torvalds 	 * (from USB 2.0 spec, section 7.1.7.5)
43491da177e4SLinus Torvalds 	 */
43501da177e4SLinus Torvalds 	if (!hdev->parent) {
43511da177e4SLinus Torvalds 		delay = HUB_ROOT_RESET_TIME;
43521da177e4SLinus Torvalds 		if (port1 == hdev->bus->otg_port)
43531da177e4SLinus Torvalds 			hdev->bus->b_hnp_enable = 0;
43541da177e4SLinus Torvalds 	}
43551da177e4SLinus Torvalds 
43561da177e4SLinus Torvalds 	/* Some low speed devices have problems with the quick delay, so */
43571da177e4SLinus Torvalds 	/*  be a bit pessimistic with those devices. RHbug #23670 */
43581da177e4SLinus Torvalds 	if (oldspeed == USB_SPEED_LOW)
43591da177e4SLinus Torvalds 		delay = HUB_LONG_RESET_TIME;
43601da177e4SLinus Torvalds 
4361feb26ac3SChris Bainbridge 	mutex_lock(hcd->address0_mutex);
43621da177e4SLinus Torvalds 
43631da177e4SLinus Torvalds 	/* Reset the device; full speed may morph to high speed */
4364e7b77172SSarah Sharp 	/* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
436575d7cf72SAndiry Xu 	retval = hub_port_reset(hub, port1, udev, delay, false);
43661da177e4SLinus Torvalds 	if (retval < 0)		/* error or disconnect */
43671da177e4SLinus Torvalds 		goto fail;
43681da177e4SLinus Torvalds 	/* success, speed is known */
436907194ab7SLuben Tuikov 
43701da177e4SLinus Torvalds 	retval = -ENODEV;
43711da177e4SLinus Torvalds 
43728a1b2725SMathias Nyman 	/* Don't allow speed changes at reset, except usb 3.0 to faster */
43738a1b2725SMathias Nyman 	if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed &&
43748a1b2725SMathias Nyman 	    !(oldspeed == USB_SPEED_SUPER && udev->speed > oldspeed)) {
43751da177e4SLinus Torvalds 		dev_dbg(&udev->dev, "device reset changed speed!\n");
43761da177e4SLinus Torvalds 		goto fail;
43771da177e4SLinus Torvalds 	}
43781da177e4SLinus Torvalds 	oldspeed = udev->speed;
43791da177e4SLinus Torvalds 
43801da177e4SLinus Torvalds 	/* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
43811da177e4SLinus Torvalds 	 * it's fixed size except for full speed devices.
43825bb6e0aeSInaky Perez-Gonzalez 	 * For Wireless USB devices, ep0 max packet is always 512 (tho
43835bb6e0aeSInaky Perez-Gonzalez 	 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
43841da177e4SLinus Torvalds 	 */
43851da177e4SLinus Torvalds 	switch (udev->speed) {
43868a1b2725SMathias Nyman 	case USB_SPEED_SUPER_PLUS:
43876b403b02SSarah Sharp 	case USB_SPEED_SUPER:
4388551cdbbeSGreg Kroah-Hartman 	case USB_SPEED_WIRELESS:	/* fixed at 512 */
4389551509d2SHarvey Harrison 		udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
43905bb6e0aeSInaky Perez-Gonzalez 		break;
43911da177e4SLinus Torvalds 	case USB_SPEED_HIGH:		/* fixed at 64 */
4392551509d2SHarvey Harrison 		udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
43931da177e4SLinus Torvalds 		break;
43941da177e4SLinus Torvalds 	case USB_SPEED_FULL:		/* 8, 16, 32, or 64 */
43951da177e4SLinus Torvalds 		/* to determine the ep0 maxpacket size, try to read
43961da177e4SLinus Torvalds 		 * the device descriptor to get bMaxPacketSize0 and
43971da177e4SLinus Torvalds 		 * then correct our initial guess.
43981da177e4SLinus Torvalds 		 */
4399551509d2SHarvey Harrison 		udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
44001da177e4SLinus Torvalds 		break;
44011da177e4SLinus Torvalds 	case USB_SPEED_LOW:		/* fixed at 8 */
4402551509d2SHarvey Harrison 		udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
44031da177e4SLinus Torvalds 		break;
44041da177e4SLinus Torvalds 	default:
44051da177e4SLinus Torvalds 		goto fail;
44061da177e4SLinus Torvalds 	}
44071da177e4SLinus Torvalds 
4408e538dfdaSMichal Nazarewicz 	if (udev->speed == USB_SPEED_WIRELESS)
4409e538dfdaSMichal Nazarewicz 		speed = "variable speed Wireless";
4410e538dfdaSMichal Nazarewicz 	else
4411e538dfdaSMichal Nazarewicz 		speed = usb_speed_string(udev->speed);
4412e538dfdaSMichal Nazarewicz 
44131bb90cf0SPeter Chen 	/*
44141bb90cf0SPeter Chen 	 * The controller driver may be NULL if the controller device
44151bb90cf0SPeter Chen 	 * is the middle device between platform device and roothub.
44161bb90cf0SPeter Chen 	 * This middle device may not need a device driver due to
44171bb90cf0SPeter Chen 	 * all hardware control can be at platform device driver, this
44181bb90cf0SPeter Chen 	 * platform device is usually a dual-role USB controller device.
44191bb90cf0SPeter Chen 	 */
44201bb90cf0SPeter Chen 	if (udev->bus->controller->driver)
44211bb90cf0SPeter Chen 		driver_name = udev->bus->controller->driver->name;
44221bb90cf0SPeter Chen 	else
44231bb90cf0SPeter Chen 		driver_name = udev->bus->sysdev->driver->name;
44241bb90cf0SPeter Chen 
44258a1b2725SMathias Nyman 	if (udev->speed < USB_SPEED_SUPER)
442683a07196SInaky Perez-Gonzalez 		dev_info(&udev->dev,
4427e538dfdaSMichal Nazarewicz 				"%s %s USB device number %d using %s\n",
4428e538dfdaSMichal Nazarewicz 				(udev->config) ? "reset" : "new", speed,
44291bb90cf0SPeter Chen 				devnum, driver_name);
44301da177e4SLinus Torvalds 
44311da177e4SLinus Torvalds 	/* Set up TT records, if needed  */
44321da177e4SLinus Torvalds 	if (hdev->tt) {
44331da177e4SLinus Torvalds 		udev->tt = hdev->tt;
44341da177e4SLinus Torvalds 		udev->ttport = hdev->ttport;
44351da177e4SLinus Torvalds 	} else if (udev->speed != USB_SPEED_HIGH
44361da177e4SLinus Torvalds 			&& hdev->speed == USB_SPEED_HIGH) {
4437d199c96dSAlan Stern 		if (!hub->tt.hub) {
4438d199c96dSAlan Stern 			dev_err(&udev->dev, "parent hub has no TT\n");
4439d199c96dSAlan Stern 			retval = -EINVAL;
4440d199c96dSAlan Stern 			goto fail;
4441d199c96dSAlan Stern 		}
44421da177e4SLinus Torvalds 		udev->tt = &hub->tt;
44431da177e4SLinus Torvalds 		udev->ttport = port1;
44441da177e4SLinus Torvalds 	}
44451da177e4SLinus Torvalds 
44461da177e4SLinus Torvalds 	/* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
44471da177e4SLinus Torvalds 	 * Because device hardware and firmware is sometimes buggy in
44481da177e4SLinus Torvalds 	 * this area, and this is how Linux has done it for ages.
44491da177e4SLinus Torvalds 	 * Change it cautiously.
44501da177e4SLinus Torvalds 	 *
445148fc7dbdSDan Williams 	 * NOTE:  If use_new_scheme() is true we will start by issuing
44521da177e4SLinus Torvalds 	 * a 64-byte GET_DESCRIPTOR request.  This is what Windows does,
44531da177e4SLinus Torvalds 	 * so it may help with some non-standards-compliant devices.
44541da177e4SLinus Torvalds 	 * Otherwise we start with SET_ADDRESS and then try to read the
44551da177e4SLinus Torvalds 	 * first 8 bytes of the device descriptor to get the ep0 maxpacket
44561da177e4SLinus Torvalds 	 * value.
44571da177e4SLinus Torvalds 	 */
44580d5ce778SOliver Neukum 	for (retries = 0; retries < GET_DESCRIPTOR_TRIES; (++retries, msleep(100))) {
445948fc7dbdSDan Williams 		bool did_new_scheme = false;
446048fc7dbdSDan Williams 
446148fc7dbdSDan Williams 		if (use_new_scheme(udev, retry_counter)) {
44621da177e4SLinus Torvalds 			struct usb_device_descriptor *buf;
44631da177e4SLinus Torvalds 			int r = 0;
44641da177e4SLinus Torvalds 
446548fc7dbdSDan Williams 			did_new_scheme = true;
446648fc7dbdSDan Williams 			retval = hub_enable_device(udev);
4467938569ebSOliver Neukum 			if (retval < 0) {
4468938569ebSOliver Neukum 				dev_err(&udev->dev,
4469938569ebSOliver Neukum 					"hub failed to enable device, error %d\n",
4470938569ebSOliver Neukum 					retval);
447148fc7dbdSDan Williams 				goto fail;
4472938569ebSOliver Neukum 			}
447348fc7dbdSDan Williams 
44741da177e4SLinus Torvalds #define GET_DESCRIPTOR_BUFSIZE	64
44751da177e4SLinus Torvalds 			buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
44761da177e4SLinus Torvalds 			if (!buf) {
44771da177e4SLinus Torvalds 				retval = -ENOMEM;
44781da177e4SLinus Torvalds 				continue;
44791da177e4SLinus Torvalds 			}
44801da177e4SLinus Torvalds 
4481b89ee19aSAlan Stern 			/* Retry on all errors; some devices are flakey.
4482b89ee19aSAlan Stern 			 * 255 is for WUSB devices, we actually need to use
4483b89ee19aSAlan Stern 			 * 512 (WUSB1.0[4.8.1]).
44841da177e4SLinus Torvalds 			 */
44850d5ce778SOliver Neukum 			for (operations = 0; operations < 3; ++operations) {
44861da177e4SLinus Torvalds 				buf->bMaxPacketSize0 = 0;
44871da177e4SLinus Torvalds 				r = usb_control_msg(udev, usb_rcvaddr0pipe(),
44881da177e4SLinus Torvalds 					USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
44891da177e4SLinus Torvalds 					USB_DT_DEVICE << 8, 0,
44901da177e4SLinus Torvalds 					buf, GET_DESCRIPTOR_BUFSIZE,
4491fd7c519dSJaroslav Kysela 					initial_descriptor_timeout);
44921da177e4SLinus Torvalds 				switch (buf->bMaxPacketSize0) {
44935bb6e0aeSInaky Perez-Gonzalez 				case 8: case 16: case 32: case 64: case 255:
44941da177e4SLinus Torvalds 					if (buf->bDescriptorType ==
44951da177e4SLinus Torvalds 							USB_DT_DEVICE) {
44961da177e4SLinus Torvalds 						r = 0;
44971da177e4SLinus Torvalds 						break;
44981da177e4SLinus Torvalds 					}
44991da177e4SLinus Torvalds 					/* FALL THROUGH */
45001da177e4SLinus Torvalds 				default:
45011da177e4SLinus Torvalds 					if (r == 0)
45021da177e4SLinus Torvalds 						r = -EPROTO;
45031da177e4SLinus Torvalds 					break;
45041da177e4SLinus Torvalds 				}
4505264904ccSOliver Neukum 				/*
4506264904ccSOliver Neukum 				 * Some devices time out if they are powered on
4507264904ccSOliver Neukum 				 * when already connected. They need a second
4508264904ccSOliver Neukum 				 * reset. But only on the first attempt,
4509264904ccSOliver Neukum 				 * lest we get into a time out/reset loop
4510264904ccSOliver Neukum 				 */
45110d5ce778SOliver Neukum 				if (r == 0  || (r == -ETIMEDOUT && retries == 0))
45121da177e4SLinus Torvalds 					break;
45131da177e4SLinus Torvalds 			}
45141da177e4SLinus Torvalds 			udev->descriptor.bMaxPacketSize0 =
45151da177e4SLinus Torvalds 					buf->bMaxPacketSize0;
45161da177e4SLinus Torvalds 			kfree(buf);
45171da177e4SLinus Torvalds 
451875d7cf72SAndiry Xu 			retval = hub_port_reset(hub, port1, udev, delay, false);
45191da177e4SLinus Torvalds 			if (retval < 0)		/* error or disconnect */
45201da177e4SLinus Torvalds 				goto fail;
45211da177e4SLinus Torvalds 			if (oldspeed != udev->speed) {
45221da177e4SLinus Torvalds 				dev_dbg(&udev->dev,
45231da177e4SLinus Torvalds 					"device reset changed speed!\n");
45241da177e4SLinus Torvalds 				retval = -ENODEV;
45251da177e4SLinus Torvalds 				goto fail;
45261da177e4SLinus Torvalds 			}
45271da177e4SLinus Torvalds 			if (r) {
4528e9e88fb7SAlan Stern 				if (r != -ENODEV)
4529e9e88fb7SAlan Stern 					dev_err(&udev->dev, "device descriptor read/64, error %d\n",
4530b9cef6c3SWu Fengguang 							r);
45311da177e4SLinus Torvalds 				retval = -EMSGSIZE;
45321da177e4SLinus Torvalds 				continue;
45331da177e4SLinus Torvalds 			}
45341da177e4SLinus Torvalds #undef GET_DESCRIPTOR_BUFSIZE
45351da177e4SLinus Torvalds 		}
45361da177e4SLinus Torvalds 
45376c529cdcSInaky Perez-Gonzalez 		/*
45386c529cdcSInaky Perez-Gonzalez 		 * If device is WUSB, we already assigned an
45396c529cdcSInaky Perez-Gonzalez 		 * unauthorized address in the Connect Ack sequence;
45406c529cdcSInaky Perez-Gonzalez 		 * authorization will assign the final address.
45416c529cdcSInaky Perez-Gonzalez 		 */
45426c529cdcSInaky Perez-Gonzalez 		if (udev->wusb == 0) {
45430d5ce778SOliver Neukum 			for (operations = 0; operations < SET_ADDRESS_TRIES; ++operations) {
45444326ed0bSAlan Stern 				retval = hub_set_address(udev, devnum);
45451da177e4SLinus Torvalds 				if (retval >= 0)
45461da177e4SLinus Torvalds 					break;
45471da177e4SLinus Torvalds 				msleep(200);
45481da177e4SLinus Torvalds 			}
45491da177e4SLinus Torvalds 			if (retval < 0) {
4550e9e88fb7SAlan Stern 				if (retval != -ENODEV)
4551e9e88fb7SAlan Stern 					dev_err(&udev->dev, "device not accepting address %d, error %d\n",
45524326ed0bSAlan Stern 							devnum, retval);
45531da177e4SLinus Torvalds 				goto fail;
45541da177e4SLinus Torvalds 			}
45558a1b2725SMathias Nyman 			if (udev->speed >= USB_SPEED_SUPER) {
4556c6515272SSarah Sharp 				devnum = udev->devnum;
4557c6515272SSarah Sharp 				dev_info(&udev->dev,
45588a1b2725SMathias Nyman 						"%s SuperSpeed%s USB device number %d using %s\n",
4559c6515272SSarah Sharp 						(udev->config) ? "reset" : "new",
45608a1b2725SMathias Nyman 					 (udev->speed == USB_SPEED_SUPER_PLUS) ? "Plus" : "",
45611bb90cf0SPeter Chen 					 devnum, driver_name);
4562c6515272SSarah Sharp 			}
45631da177e4SLinus Torvalds 
45641da177e4SLinus Torvalds 			/* cope with hardware quirkiness:
45651da177e4SLinus Torvalds 			 *  - let SET_ADDRESS settle, some device hardware wants it
45661da177e4SLinus Torvalds 			 *  - read ep0 maxpacket even for high and low speed,
45671da177e4SLinus Torvalds 			 */
45681da177e4SLinus Torvalds 			msleep(10);
456948fc7dbdSDan Williams 			/* use_new_scheme() checks the speed which may have
457048fc7dbdSDan Williams 			 * changed since the initial look so we cache the result
457148fc7dbdSDan Williams 			 * in did_new_scheme
457248fc7dbdSDan Williams 			 */
457348fc7dbdSDan Williams 			if (did_new_scheme)
45741da177e4SLinus Torvalds 				break;
45756c529cdcSInaky Perez-Gonzalez 		}
45761da177e4SLinus Torvalds 
45771da177e4SLinus Torvalds 		retval = usb_get_device_descriptor(udev, 8);
45781da177e4SLinus Torvalds 		if (retval < 8) {
4579e9e88fb7SAlan Stern 			if (retval != -ENODEV)
4580b9cef6c3SWu Fengguang 				dev_err(&udev->dev,
4581b9cef6c3SWu Fengguang 					"device descriptor read/8, error %d\n",
4582b9cef6c3SWu Fengguang 					retval);
45831da177e4SLinus Torvalds 			if (retval >= 0)
45841da177e4SLinus Torvalds 				retval = -EMSGSIZE;
45851da177e4SLinus Torvalds 		} else {
45861da177e4SLinus Torvalds 			retval = 0;
45871da177e4SLinus Torvalds 			break;
45881da177e4SLinus Torvalds 		}
45891da177e4SLinus Torvalds 	}
45901da177e4SLinus Torvalds 	if (retval)
45911da177e4SLinus Torvalds 		goto fail;
45921da177e4SLinus Torvalds 
4593d8aec3dbSElric Fu 	/*
4594d8aec3dbSElric Fu 	 * Some superspeed devices have finished the link training process
4595d8aec3dbSElric Fu 	 * and attached to a superspeed hub port, but the device descriptor
4596d8aec3dbSElric Fu 	 * got from those devices show they aren't superspeed devices. Warm
4597d8aec3dbSElric Fu 	 * reset the port attached by the devices can fix them.
4598d8aec3dbSElric Fu 	 */
45998a1b2725SMathias Nyman 	if ((udev->speed >= USB_SPEED_SUPER) &&
4600d8aec3dbSElric Fu 			(le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
4601d8aec3dbSElric Fu 		dev_err(&udev->dev, "got a wrong device descriptor, "
4602d8aec3dbSElric Fu 				"warm reset device\n");
4603d8aec3dbSElric Fu 		hub_port_reset(hub, port1, udev,
4604d8aec3dbSElric Fu 				HUB_BH_RESET_TIME, true);
4605d8aec3dbSElric Fu 		retval = -EINVAL;
4606d8aec3dbSElric Fu 		goto fail;
4607d8aec3dbSElric Fu 	}
4608d8aec3dbSElric Fu 
46096b403b02SSarah Sharp 	if (udev->descriptor.bMaxPacketSize0 == 0xff ||
46108a1b2725SMathias Nyman 			udev->speed >= USB_SPEED_SUPER)
46116b403b02SSarah Sharp 		i = 512;
46126b403b02SSarah Sharp 	else
46136b403b02SSarah Sharp 		i = udev->descriptor.bMaxPacketSize0;
461429cc8897SKuninori Morimoto 	if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
461556626a72SAlan Stern 		if (udev->speed == USB_SPEED_LOW ||
46161da177e4SLinus Torvalds 				!(i == 8 || i == 16 || i == 32 || i == 64)) {
461756626a72SAlan Stern 			dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
46181da177e4SLinus Torvalds 			retval = -EMSGSIZE;
46191da177e4SLinus Torvalds 			goto fail;
46201da177e4SLinus Torvalds 		}
462156626a72SAlan Stern 		if (udev->speed == USB_SPEED_FULL)
46221da177e4SLinus Torvalds 			dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
462356626a72SAlan Stern 		else
462456626a72SAlan Stern 			dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
46251da177e4SLinus Torvalds 		udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
4626fc721f51SInaky Perez-Gonzalez 		usb_ep0_reinit(udev);
46271da177e4SLinus Torvalds 	}
46281da177e4SLinus Torvalds 
46291da177e4SLinus Torvalds 	retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
46301da177e4SLinus Torvalds 	if (retval < (signed)sizeof(udev->descriptor)) {
4631e9e88fb7SAlan Stern 		if (retval != -ENODEV)
4632b9cef6c3SWu Fengguang 			dev_err(&udev->dev, "device descriptor read/all, error %d\n",
4633b9cef6c3SWu Fengguang 					retval);
46341da177e4SLinus Torvalds 		if (retval >= 0)
46351da177e4SLinus Torvalds 			retval = -ENOMSG;
46361da177e4SLinus Torvalds 		goto fail;
46371da177e4SLinus Torvalds 	}
46381da177e4SLinus Torvalds 
4639ad87e032SAlan Stern 	usb_detect_quirks(udev);
4640ad87e032SAlan Stern 
46411ff4df56SAndiry Xu 	if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
46421ff4df56SAndiry Xu 		retval = usb_get_bos_descriptor(udev);
464351e0a012SSarah Sharp 		if (!retval) {
4644d9b2099cSSarah Sharp 			udev->lpm_capable = usb_device_supports_lpm(udev);
464551e0a012SSarah Sharp 			usb_set_lpm_parameters(udev);
464651e0a012SSarah Sharp 		}
46471ff4df56SAndiry Xu 	}
46483148bf04SAndiry Xu 
46491da177e4SLinus Torvalds 	retval = 0;
465048f24970SAlek Du 	/* notify HCD that we have a device connected and addressed */
465148f24970SAlek Du 	if (hcd->driver->update_device)
465248f24970SAlek Du 		hcd->driver->update_device(hcd, udev);
4653890dae88SMathias Nyman 	hub_set_initial_usb2_lpm_policy(udev);
46541da177e4SLinus Torvalds fail:
46554326ed0bSAlan Stern 	if (retval) {
46561da177e4SLinus Torvalds 		hub_port_disable(hub, port1, 0);
46573b29b68bSAlan Stern 		update_devnum(udev, devnum);	/* for disconnect processing */
46584326ed0bSAlan Stern 	}
4659feb26ac3SChris Bainbridge 	mutex_unlock(hcd->address0_mutex);
46601da177e4SLinus Torvalds 	return retval;
46611da177e4SLinus Torvalds }
46621da177e4SLinus Torvalds 
46631da177e4SLinus Torvalds static void
46641da177e4SLinus Torvalds check_highspeed(struct usb_hub *hub, struct usb_device *udev, int port1)
46651da177e4SLinus Torvalds {
46661da177e4SLinus Torvalds 	struct usb_qualifier_descriptor	*qual;
46671da177e4SLinus Torvalds 	int				status;
46681da177e4SLinus Torvalds 
46692a159389SJohan Hovold 	if (udev->quirks & USB_QUIRK_DEVICE_QUALIFIER)
46702a159389SJohan Hovold 		return;
46712a159389SJohan Hovold 
4672e94b1766SChristoph Lameter 	qual = kmalloc(sizeof *qual, GFP_KERNEL);
46731da177e4SLinus Torvalds 	if (qual == NULL)
46741da177e4SLinus Torvalds 		return;
46751da177e4SLinus Torvalds 
46761da177e4SLinus Torvalds 	status = usb_get_descriptor(udev, USB_DT_DEVICE_QUALIFIER, 0,
46771da177e4SLinus Torvalds 			qual, sizeof *qual);
46781da177e4SLinus Torvalds 	if (status == sizeof *qual) {
46791da177e4SLinus Torvalds 		dev_info(&udev->dev, "not running at top speed; "
46801da177e4SLinus Torvalds 			"connect to a high speed hub\n");
46811da177e4SLinus Torvalds 		/* hub LEDs are probably harder to miss than syslog */
46821da177e4SLinus Torvalds 		if (hub->has_indicators) {
46831da177e4SLinus Torvalds 			hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
468422f6a0f0SShaibal Dutta 			queue_delayed_work(system_power_efficient_wq,
468522f6a0f0SShaibal Dutta 					&hub->leds, 0);
46861da177e4SLinus Torvalds 		}
46871da177e4SLinus Torvalds 	}
46881da177e4SLinus Torvalds 	kfree(qual);
46891da177e4SLinus Torvalds }
46901da177e4SLinus Torvalds 
46911da177e4SLinus Torvalds static unsigned
46921da177e4SLinus Torvalds hub_power_remaining(struct usb_hub *hub)
46931da177e4SLinus Torvalds {
46941da177e4SLinus Torvalds 	struct usb_device *hdev = hub->hdev;
46951da177e4SLinus Torvalds 	int remaining;
469655c52718SAlan Stern 	int port1;
46971da177e4SLinus Torvalds 
469855c52718SAlan Stern 	if (!hub->limited_power)
46991da177e4SLinus Torvalds 		return 0;
47001da177e4SLinus Torvalds 
470155c52718SAlan Stern 	remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
470255c52718SAlan Stern 	for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
4703d99f6b41SDan Williams 		struct usb_port *port_dev = hub->ports[port1 - 1];
4704d99f6b41SDan Williams 		struct usb_device *udev = port_dev->child;
4705430ee58eSSebastian Andrzej Siewior 		unsigned unit_load;
4706d99f6b41SDan Williams 		int delta;
47071da177e4SLinus Torvalds 
47081da177e4SLinus Torvalds 		if (!udev)
47091da177e4SLinus Torvalds 			continue;
4710430ee58eSSebastian Andrzej Siewior 		if (hub_is_superspeed(udev))
4711430ee58eSSebastian Andrzej Siewior 			unit_load = 150;
4712430ee58eSSebastian Andrzej Siewior 		else
4713430ee58eSSebastian Andrzej Siewior 			unit_load = 100;
47141da177e4SLinus Torvalds 
4715430ee58eSSebastian Andrzej Siewior 		/*
4716430ee58eSSebastian Andrzej Siewior 		 * Unconfigured devices may not use more than one unit load,
4717430ee58eSSebastian Andrzej Siewior 		 * or 8mA for OTG ports
4718430ee58eSSebastian Andrzej Siewior 		 */
47191da177e4SLinus Torvalds 		if (udev->actconfig)
47208d8479dbSSebastian Andrzej Siewior 			delta = usb_get_max_power(udev, udev->actconfig);
472155c52718SAlan Stern 		else if (port1 != udev->bus->otg_port || hdev->parent)
4722430ee58eSSebastian Andrzej Siewior 			delta = unit_load;
47231da177e4SLinus Torvalds 		else
472455c52718SAlan Stern 			delta = 8;
472555c52718SAlan Stern 		if (delta > hub->mA_per_port)
4726d99f6b41SDan Williams 			dev_warn(&port_dev->dev, "%dmA is over %umA budget!\n",
4727d99f6b41SDan Williams 					delta, hub->mA_per_port);
47281da177e4SLinus Torvalds 		remaining -= delta;
47291da177e4SLinus Torvalds 	}
47301da177e4SLinus Torvalds 	if (remaining < 0) {
473155c52718SAlan Stern 		dev_warn(hub->intfdev, "%dmA over power budget!\n",
473255c52718SAlan Stern 			-remaining);
47331da177e4SLinus Torvalds 		remaining = 0;
47341da177e4SLinus Torvalds 	}
47351da177e4SLinus Torvalds 	return remaining;
47361da177e4SLinus Torvalds }
47371da177e4SLinus Torvalds 
4738af376a46SDan Williams static void hub_port_connect(struct usb_hub *hub, int port1, u16 portstatus,
4739af376a46SDan Williams 		u16 portchange)
47401da177e4SLinus Torvalds {
474194c43b98SAlan Stern 	int status = -ENODEV;
474294c43b98SAlan Stern 	int i;
4743430ee58eSSebastian Andrzej Siewior 	unsigned unit_load;
47441da177e4SLinus Torvalds 	struct usb_device *hdev = hub->hdev;
47451da177e4SLinus Torvalds 	struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4746d99f6b41SDan Williams 	struct usb_port *port_dev = hub->ports[port1 - 1];
4747af376a46SDan Williams 	struct usb_device *udev = port_dev->child;
47485ee0f803SOliver Neukum 	static int unreliable_port = -1;
47498808f00cSAlan Stern 
475024618b0cSAlan Stern 	/* Disconnect any existing devices under this port */
4751b76baa81SPeter Chen 	if (udev) {
4752b2108f1eSPeter Chen 		if (hcd->usb_phy && !hdev->parent)
47533d46e73dSAntoine Tenart 			usb_phy_notify_disconnect(hcd->usb_phy, udev->speed);
4754d99f6b41SDan Williams 		usb_disconnect(&port_dev->child);
4755b76baa81SPeter Chen 	}
475624618b0cSAlan Stern 
4757253e0572SAlan Stern 	/* We can forget about a "removed" device when there's a physical
4758253e0572SAlan Stern 	 * disconnect or the connect status changes.
4759253e0572SAlan Stern 	 */
4760253e0572SAlan Stern 	if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4761253e0572SAlan Stern 			(portchange & USB_PORT_STAT_C_CONNECTION))
4762253e0572SAlan Stern 		clear_bit(port1, hub->removed_bits);
4763253e0572SAlan Stern 
47645257d97aSAlan Stern 	if (portchange & (USB_PORT_STAT_C_CONNECTION |
47655257d97aSAlan Stern 				USB_PORT_STAT_C_ENABLE)) {
4766ad493e5eSLan Tianyu 		status = hub_port_debounce_be_stable(hub, port1);
47675257d97aSAlan Stern 		if (status < 0) {
47685ee0f803SOliver Neukum 			if (status != -ENODEV &&
47695ee0f803SOliver Neukum 				port1 != unreliable_port &&
47705ee0f803SOliver Neukum 				printk_ratelimit())
4771dd5f5006STakashi Iwai 				dev_err(&port_dev->dev, "connect-debounce failed\n");
47725257d97aSAlan Stern 			portstatus &= ~USB_PORT_STAT_CONNECTION;
47735ee0f803SOliver Neukum 			unreliable_port = port1;
47745257d97aSAlan Stern 		} else {
47755257d97aSAlan Stern 			portstatus = status;
47765257d97aSAlan Stern 		}
47775257d97aSAlan Stern 	}
47785257d97aSAlan Stern 
4779253e0572SAlan Stern 	/* Return now if debouncing failed or nothing is connected or
4780253e0572SAlan Stern 	 * the device was "removed".
4781253e0572SAlan Stern 	 */
4782253e0572SAlan Stern 	if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4783253e0572SAlan Stern 			test_bit(port1, hub->removed_bits)) {
47841da177e4SLinus Torvalds 
4785fbaecff0SDeepak Das 		/*
4786fbaecff0SDeepak Das 		 * maybe switch power back on (e.g. root hub was reset)
4787fbaecff0SDeepak Das 		 * but only if the port isn't owned by someone else.
4788fbaecff0SDeepak Das 		 */
47899262c19dSDan Williams 		if (hub_is_port_power_switchable(hub)
4790fbaecff0SDeepak Das 				&& !port_is_power_on(hub, portstatus)
4791fbaecff0SDeepak Das 				&& !port_dev->port_owner)
47921da177e4SLinus Torvalds 			set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
47931da177e4SLinus Torvalds 
47941da177e4SLinus Torvalds 		if (portstatus & USB_PORT_STAT_ENABLE)
47951da177e4SLinus Torvalds 			goto done;
47961da177e4SLinus Torvalds 		return;
47971da177e4SLinus Torvalds 	}
4798430ee58eSSebastian Andrzej Siewior 	if (hub_is_superspeed(hub->hdev))
4799430ee58eSSebastian Andrzej Siewior 		unit_load = 150;
4800430ee58eSSebastian Andrzej Siewior 	else
4801430ee58eSSebastian Andrzej Siewior 		unit_load = 100;
48021da177e4SLinus Torvalds 
4803e9e88fb7SAlan Stern 	status = 0;
48041da177e4SLinus Torvalds 	for (i = 0; i < SET_CONFIG_TRIES; i++) {
48051da177e4SLinus Torvalds 
48061da177e4SLinus Torvalds 		/* reallocate for each attempt, since references
48071da177e4SLinus Torvalds 		 * to the previous one can escape in various ways
48081da177e4SLinus Torvalds 		 */
48091da177e4SLinus Torvalds 		udev = usb_alloc_dev(hdev, hdev->bus, port1);
48101da177e4SLinus Torvalds 		if (!udev) {
4811d99f6b41SDan Williams 			dev_err(&port_dev->dev,
4812d99f6b41SDan Williams 					"couldn't allocate usb_device\n");
48131da177e4SLinus Torvalds 			goto done;
48141da177e4SLinus Torvalds 		}
48151da177e4SLinus Torvalds 
48161da177e4SLinus Torvalds 		usb_set_device_state(udev, USB_STATE_POWERED);
481755c52718SAlan Stern 		udev->bus_mA = hub->mA_per_port;
4818b6956ffaSAlan Stern 		udev->level = hdev->level + 1;
48198af548dcSInaky Perez-Gonzalez 		udev->wusb = hub_is_wusb(hub);
48201da177e4SLinus Torvalds 
48218a1b2725SMathias Nyman 		/* Devices connected to SuperSpeed hubs are USB 3.0 or later */
4822131dec34SSarah Sharp 		if (hub_is_superspeed(hub->hdev))
4823e7b77172SSarah Sharp 			udev->speed = USB_SPEED_SUPER;
4824e7b77172SSarah Sharp 		else
4825e7b77172SSarah Sharp 			udev->speed = USB_SPEED_UNKNOWN;
4826e7b77172SSarah Sharp 
48273b29b68bSAlan Stern 		choose_devnum(udev);
4828c6515272SSarah Sharp 		if (udev->devnum <= 0) {
4829c6515272SSarah Sharp 			status = -ENOTCONN;	/* Don't retry */
4830c6515272SSarah Sharp 			goto loop;
4831c6515272SSarah Sharp 		}
4832c6515272SSarah Sharp 
4833e7b77172SSarah Sharp 		/* reset (non-USB 3.0 devices) and get descriptor */
48345c79a1e3SDan Williams 		usb_lock_port(port_dev);
48351da177e4SLinus Torvalds 		status = hub_port_init(hub, udev, port1, i);
48365c79a1e3SDan Williams 		usb_unlock_port(port_dev);
48371da177e4SLinus Torvalds 		if (status < 0)
48381da177e4SLinus Torvalds 			goto loop;
48391da177e4SLinus Torvalds 
484093362a87SPhil Dibowitz 		if (udev->quirks & USB_QUIRK_DELAY_INIT)
4841b2a542bbSDmitry Fleytman 			msleep(2000);
484293362a87SPhil Dibowitz 
48431da177e4SLinus Torvalds 		/* consecutive bus-powered hubs aren't reliable; they can
48441da177e4SLinus Torvalds 		 * violate the voltage drop budget.  if the new child has
48451da177e4SLinus Torvalds 		 * a "powered" LED, users should notice we didn't enable it
48461da177e4SLinus Torvalds 		 * (without reading syslog), even without per-port LEDs
48471da177e4SLinus Torvalds 		 * on the parent.
48481da177e4SLinus Torvalds 		 */
48491da177e4SLinus Torvalds 		if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
4850430ee58eSSebastian Andrzej Siewior 				&& udev->bus_mA <= unit_load) {
48511da177e4SLinus Torvalds 			u16	devstat;
48521da177e4SLinus Torvalds 
48531da177e4SLinus Torvalds 			status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
48541da177e4SLinus Torvalds 					&devstat);
485515b7336eSAlan Stern 			if (status) {
48561da177e4SLinus Torvalds 				dev_dbg(&udev->dev, "get status %d ?\n", status);
48571da177e4SLinus Torvalds 				goto loop_disable;
48581da177e4SLinus Torvalds 			}
48591da177e4SLinus Torvalds 			if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
48601da177e4SLinus Torvalds 				dev_err(&udev->dev,
48611da177e4SLinus Torvalds 					"can't connect bus-powered hub "
48621da177e4SLinus Torvalds 					"to this port\n");
48631da177e4SLinus Torvalds 				if (hub->has_indicators) {
48641da177e4SLinus Torvalds 					hub->indicator[port1-1] =
48651da177e4SLinus Torvalds 						INDICATOR_AMBER_BLINK;
486622f6a0f0SShaibal Dutta 					queue_delayed_work(
486722f6a0f0SShaibal Dutta 						system_power_efficient_wq,
486822f6a0f0SShaibal Dutta 						&hub->leds, 0);
48691da177e4SLinus Torvalds 				}
48701da177e4SLinus Torvalds 				status = -ENOTCONN;	/* Don't retry */
48711da177e4SLinus Torvalds 				goto loop_disable;
48721da177e4SLinus Torvalds 			}
48731da177e4SLinus Torvalds 		}
48741da177e4SLinus Torvalds 
48751da177e4SLinus Torvalds 		/* check for devices running slower than they could */
48761da177e4SLinus Torvalds 		if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
48771da177e4SLinus Torvalds 				&& udev->speed == USB_SPEED_FULL
48781da177e4SLinus Torvalds 				&& highspeed_hubs != 0)
48791da177e4SLinus Torvalds 			check_highspeed(hub, udev, port1);
48801da177e4SLinus Torvalds 
4881fa286188SGreg Kroah-Hartman 		/* Store the parent's children[] pointer.  At this point
48821da177e4SLinus Torvalds 		 * udev becomes globally accessible, although presumably
48831da177e4SLinus Torvalds 		 * no one will look at it until hdev is unlocked.
48841da177e4SLinus Torvalds 		 */
48851da177e4SLinus Torvalds 		status = 0;
48861da177e4SLinus Torvalds 
4887d8521afeSDan Williams 		mutex_lock(&usb_port_peer_mutex);
4888d8521afeSDan Williams 
48891da177e4SLinus Torvalds 		/* We mustn't add new devices if the parent hub has
48901da177e4SLinus Torvalds 		 * been disconnected; we would race with the
48911da177e4SLinus Torvalds 		 * recursively_mark_NOTATTACHED() routine.
48921da177e4SLinus Torvalds 		 */
48931da177e4SLinus Torvalds 		spin_lock_irq(&device_state_lock);
48941da177e4SLinus Torvalds 		if (hdev->state == USB_STATE_NOTATTACHED)
48951da177e4SLinus Torvalds 			status = -ENOTCONN;
48961da177e4SLinus Torvalds 		else
4897d99f6b41SDan Williams 			port_dev->child = udev;
48981da177e4SLinus Torvalds 		spin_unlock_irq(&device_state_lock);
4899d8521afeSDan Williams 		mutex_unlock(&usb_port_peer_mutex);
49001da177e4SLinus Torvalds 
49011da177e4SLinus Torvalds 		/* Run it through the hoops (find a driver, etc) */
49021da177e4SLinus Torvalds 		if (!status) {
49031da177e4SLinus Torvalds 			status = usb_new_device(udev);
49041da177e4SLinus Torvalds 			if (status) {
4905d8521afeSDan Williams 				mutex_lock(&usb_port_peer_mutex);
49061da177e4SLinus Torvalds 				spin_lock_irq(&device_state_lock);
4907d99f6b41SDan Williams 				port_dev->child = NULL;
49081da177e4SLinus Torvalds 				spin_unlock_irq(&device_state_lock);
4909d8521afeSDan Williams 				mutex_unlock(&usb_port_peer_mutex);
491001ed67dcSTony Zheng 			} else {
491101ed67dcSTony Zheng 				if (hcd->usb_phy && !hdev->parent)
491201ed67dcSTony Zheng 					usb_phy_notify_connect(hcd->usb_phy,
491301ed67dcSTony Zheng 							udev->speed);
49141da177e4SLinus Torvalds 			}
49151da177e4SLinus Torvalds 		}
49161da177e4SLinus Torvalds 
49171da177e4SLinus Torvalds 		if (status)
49181da177e4SLinus Torvalds 			goto loop_disable;
49191da177e4SLinus Torvalds 
49201da177e4SLinus Torvalds 		status = hub_power_remaining(hub);
49211da177e4SLinus Torvalds 		if (status)
4922d99f6b41SDan Williams 			dev_dbg(hub->intfdev, "%dmA power budget left\n", status);
49231da177e4SLinus Torvalds 
49241da177e4SLinus Torvalds 		return;
49251da177e4SLinus Torvalds 
49261da177e4SLinus Torvalds loop_disable:
49271da177e4SLinus Torvalds 		hub_port_disable(hub, port1, 1);
49281da177e4SLinus Torvalds loop:
4929fc721f51SInaky Perez-Gonzalez 		usb_ep0_reinit(udev);
49303b29b68bSAlan Stern 		release_devnum(udev);
4931f7410cedSHerbert Xu 		hub_free_dev(udev);
49321da177e4SLinus Torvalds 		usb_put_dev(udev);
4933ffcdc18dSVikram Pandita 		if ((status == -ENOTCONN) || (status == -ENOTSUPP))
49341da177e4SLinus Torvalds 			break;
49351da177e4SLinus Torvalds 	}
49363a31155cSAlan Stern 	if (hub->hdev->parent ||
49373a31155cSAlan Stern 			!hcd->driver->port_handed_over ||
4938e9e88fb7SAlan Stern 			!(hcd->driver->port_handed_over)(hcd, port1)) {
4939e9e88fb7SAlan Stern 		if (status != -ENOTCONN && status != -ENODEV)
4940d99f6b41SDan Williams 			dev_err(&port_dev->dev,
4941d99f6b41SDan Williams 					"unable to enumerate USB device\n");
4942e9e88fb7SAlan Stern 	}
49431da177e4SLinus Torvalds 
49441da177e4SLinus Torvalds done:
49451da177e4SLinus Torvalds 	hub_port_disable(hub, port1, 1);
494694c43b98SAlan Stern 	if (hcd->driver->relinquish_port && !hub->hdev->parent) {
494794c43b98SAlan Stern 		if (status != -ENOTCONN && status != -ENODEV)
494890da096eSBalaji Rao 			hcd->driver->relinquish_port(hcd, port1);
494994c43b98SAlan Stern 	}
49501da177e4SLinus Torvalds }
49511da177e4SLinus Torvalds 
4952af376a46SDan Williams /* Handle physical or logical connection change events.
4953af376a46SDan Williams  * This routine is called when:
4954af376a46SDan Williams  *	a port connection-change occurs;
4955af376a46SDan Williams  *	a port enable-change occurs (often caused by EMI);
4956af376a46SDan Williams  *	usb_reset_and_verify_device() encounters changed descriptors (as from
4957af376a46SDan Williams  *		a firmware download)
4958af376a46SDan Williams  * caller already locked the hub
4959af376a46SDan Williams  */
4960af376a46SDan Williams static void hub_port_connect_change(struct usb_hub *hub, int port1,
496172937e1eSSarah Sharp 					u16 portstatus, u16 portchange)
49625c79a1e3SDan Williams 		__must_hold(&port_dev->status_lock)
4963714b07beSSarah Sharp {
4964af376a46SDan Williams 	struct usb_port *port_dev = hub->ports[port1 - 1];
4965af376a46SDan Williams 	struct usb_device *udev = port_dev->child;
4966af376a46SDan Williams 	int status = -ENODEV;
4967714b07beSSarah Sharp 
4968af376a46SDan Williams 	dev_dbg(&port_dev->dev, "status %04x, change %04x, %s\n", portstatus,
4969af376a46SDan Williams 			portchange, portspeed(hub, portstatus));
4970af376a46SDan Williams 
4971af376a46SDan Williams 	if (hub->has_indicators) {
4972af376a46SDan Williams 		set_port_led(hub, port1, HUB_LED_AUTO);
4973af376a46SDan Williams 		hub->indicator[port1-1] = INDICATOR_AUTO;
49744ee823b8SSarah Sharp 	}
4975714b07beSSarah Sharp 
4976af376a46SDan Williams #ifdef	CONFIG_USB_OTG
4977af376a46SDan Williams 	/* during HNP, don't repeat the debounce */
4978af376a46SDan Williams 	if (hub->hdev->bus->is_b_host)
4979af376a46SDan Williams 		portchange &= ~(USB_PORT_STAT_C_CONNECTION |
4980af376a46SDan Williams 				USB_PORT_STAT_C_ENABLE);
4981af376a46SDan Williams #endif
4982714b07beSSarah Sharp 
4983af376a46SDan Williams 	/* Try to resuscitate an existing device */
4984af376a46SDan Williams 	if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
4985af376a46SDan Williams 			udev->state != USB_STATE_NOTATTACHED) {
4986af376a46SDan Williams 		if (portstatus & USB_PORT_STAT_ENABLE) {
4987af376a46SDan Williams 			status = 0;		/* Nothing to do */
4988ceb6c9c8SRafael J. Wysocki #ifdef CONFIG_PM
4989af376a46SDan Williams 		} else if (udev->state == USB_STATE_SUSPENDED &&
4990af376a46SDan Williams 				udev->persist_enabled) {
4991af376a46SDan Williams 			/* For a suspended device, treat this as a
4992af376a46SDan Williams 			 * remote wakeup event.
4993af376a46SDan Williams 			 */
49945c79a1e3SDan Williams 			usb_unlock_port(port_dev);
4995af376a46SDan Williams 			status = usb_remote_wakeup(udev);
49965c79a1e3SDan Williams 			usb_lock_port(port_dev);
4997af376a46SDan Williams #endif
4998af376a46SDan Williams 		} else {
4999af376a46SDan Williams 			/* Don't resuscitate */;
5000af376a46SDan Williams 		}
5001af376a46SDan Williams 	}
5002af376a46SDan Williams 	clear_bit(port1, hub->change_bits);
5003af376a46SDan Williams 
50045c79a1e3SDan Williams 	/* successfully revalidated the connection */
5005af376a46SDan Williams 	if (status == 0)
5006af376a46SDan Williams 		return;
5007af376a46SDan Williams 
50085c79a1e3SDan Williams 	usb_unlock_port(port_dev);
5009af376a46SDan Williams 	hub_port_connect(hub, port1, portstatus, portchange);
50105c79a1e3SDan Williams 	usb_lock_port(port_dev);
50111da177e4SLinus Torvalds }
50121da177e4SLinus Torvalds 
5013af376a46SDan Williams static void port_event(struct usb_hub *hub, int port1)
50145c79a1e3SDan Williams 		__must_hold(&port_dev->status_lock)
5015af376a46SDan Williams {
50167671bd1eSZhuang Jin Can 	int connect_change;
5017af376a46SDan Williams 	struct usb_port *port_dev = hub->ports[port1 - 1];
5018af376a46SDan Williams 	struct usb_device *udev = port_dev->child;
5019af376a46SDan Williams 	struct usb_device *hdev = hub->hdev;
5020af376a46SDan Williams 	u16 portstatus, portchange;
5021af376a46SDan Williams 
5022af376a46SDan Williams 	connect_change = test_bit(port1, hub->change_bits);
5023af376a46SDan Williams 	clear_bit(port1, hub->event_bits);
5024af376a46SDan Williams 	clear_bit(port1, hub->wakeup_bits);
5025af376a46SDan Williams 
5026af376a46SDan Williams 	if (hub_port_status(hub, port1, &portstatus, &portchange) < 0)
5027af376a46SDan Williams 		return;
5028af376a46SDan Williams 
5029af376a46SDan Williams 	if (portchange & USB_PORT_STAT_C_CONNECTION) {
5030af376a46SDan Williams 		usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_CONNECTION);
5031714b07beSSarah Sharp 		connect_change = 1;
5032714b07beSSarah Sharp 	}
5033af376a46SDan Williams 
5034af376a46SDan Williams 	if (portchange & USB_PORT_STAT_C_ENABLE) {
5035af376a46SDan Williams 		if (!connect_change)
5036af376a46SDan Williams 			dev_dbg(&port_dev->dev, "enable change, status %08x\n",
5037af376a46SDan Williams 					portstatus);
5038af376a46SDan Williams 		usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_ENABLE);
5039af376a46SDan Williams 
5040af376a46SDan Williams 		/*
5041af376a46SDan Williams 		 * EM interference sometimes causes badly shielded USB devices
5042af376a46SDan Williams 		 * to be shutdown by the hub, this hack enables them again.
5043af376a46SDan Williams 		 * Works at least with mouse driver.
5044af376a46SDan Williams 		 */
5045af376a46SDan Williams 		if (!(portstatus & USB_PORT_STAT_ENABLE)
5046af376a46SDan Williams 		    && !connect_change && udev) {
5047af376a46SDan Williams 			dev_err(&port_dev->dev, "disabled by hub (EMI?), re-enabling...\n");
5048af376a46SDan Williams 			connect_change = 1;
5049714b07beSSarah Sharp 		}
5050af376a46SDan Williams 	}
5051af376a46SDan Williams 
5052af376a46SDan Williams 	if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
5053af376a46SDan Williams 		u16 status = 0, unused;
5054af376a46SDan Williams 
5055af376a46SDan Williams 		dev_dbg(&port_dev->dev, "over-current change\n");
5056af376a46SDan Williams 		usb_clear_port_feature(hdev, port1,
5057af376a46SDan Williams 				USB_PORT_FEAT_C_OVER_CURRENT);
5058af376a46SDan Williams 		msleep(100);	/* Cool down */
5059af376a46SDan Williams 		hub_power_on(hub, true);
5060af376a46SDan Williams 		hub_port_status(hub, port1, &status, &unused);
5061af376a46SDan Williams 		if (status & USB_PORT_STAT_OVERCURRENT)
5062af376a46SDan Williams 			dev_err(&port_dev->dev, "over-current condition\n");
5063af376a46SDan Williams 	}
5064af376a46SDan Williams 
5065af376a46SDan Williams 	if (portchange & USB_PORT_STAT_C_RESET) {
5066af376a46SDan Williams 		dev_dbg(&port_dev->dev, "reset change\n");
5067af376a46SDan Williams 		usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_RESET);
5068af376a46SDan Williams 	}
5069af376a46SDan Williams 	if ((portchange & USB_PORT_STAT_C_BH_RESET)
5070af376a46SDan Williams 	    && hub_is_superspeed(hdev)) {
5071af376a46SDan Williams 		dev_dbg(&port_dev->dev, "warm reset change\n");
5072af376a46SDan Williams 		usb_clear_port_feature(hdev, port1,
5073af376a46SDan Williams 				USB_PORT_FEAT_C_BH_PORT_RESET);
5074af376a46SDan Williams 	}
5075af376a46SDan Williams 	if (portchange & USB_PORT_STAT_C_LINK_STATE) {
5076af376a46SDan Williams 		dev_dbg(&port_dev->dev, "link state change\n");
5077af376a46SDan Williams 		usb_clear_port_feature(hdev, port1,
5078af376a46SDan Williams 				USB_PORT_FEAT_C_PORT_LINK_STATE);
5079af376a46SDan Williams 	}
5080af376a46SDan Williams 	if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
5081af376a46SDan Williams 		dev_warn(&port_dev->dev, "config error\n");
5082af376a46SDan Williams 		usb_clear_port_feature(hdev, port1,
5083af376a46SDan Williams 				USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
5084af376a46SDan Williams 	}
5085af376a46SDan Williams 
5086097a155fSDan Williams 	/* skip port actions that require the port to be powered on */
5087097a155fSDan Williams 	if (!pm_runtime_active(&port_dev->dev))
5088097a155fSDan Williams 		return;
5089097a155fSDan Williams 
5090af376a46SDan Williams 	if (hub_handle_remote_wakeup(hub, port1, portstatus, portchange))
5091af376a46SDan Williams 		connect_change = 1;
5092af376a46SDan Williams 
5093af376a46SDan Williams 	/*
5094af376a46SDan Williams 	 * Warm reset a USB3 protocol port if it's in
5095af376a46SDan Williams 	 * SS.Inactive state.
5096af376a46SDan Williams 	 */
50973cd12f91SDan Williams 	if (hub_port_warm_reset_required(hub, port1, portstatus)) {
5098af376a46SDan Williams 		dev_dbg(&port_dev->dev, "do warm reset\n");
5099af376a46SDan Williams 		if (!udev || !(portstatus & USB_PORT_STAT_CONNECTION)
5100af376a46SDan Williams 				|| udev->state == USB_STATE_NOTATTACHED) {
5101af376a46SDan Williams 			if (hub_port_reset(hub, port1, NULL,
5102af376a46SDan Williams 					HUB_BH_RESET_TIME, true) < 0)
5103af376a46SDan Williams 				hub_port_disable(hub, port1, 1);
51047671bd1eSZhuang Jin Can 		} else {
51055c79a1e3SDan Williams 			usb_unlock_port(port_dev);
5106af376a46SDan Williams 			usb_lock_device(udev);
5107af376a46SDan Williams 			usb_reset_device(udev);
5108af376a46SDan Williams 			usb_unlock_device(udev);
51095c79a1e3SDan Williams 			usb_lock_port(port_dev);
5110af376a46SDan Williams 			connect_change = 0;
5111af376a46SDan Williams 		}
51127671bd1eSZhuang Jin Can 	}
5113af376a46SDan Williams 
5114af376a46SDan Williams 	if (connect_change)
5115af376a46SDan Williams 		hub_port_connect_change(hub, port1, portstatus, portchange);
5116af376a46SDan Williams }
5117af376a46SDan Williams 
511832a69589SPetr Mladek static void hub_event(struct work_struct *work)
51191da177e4SLinus Torvalds {
51201da177e4SLinus Torvalds 	struct usb_device *hdev;
51211da177e4SLinus Torvalds 	struct usb_interface *intf;
51221da177e4SLinus Torvalds 	struct usb_hub *hub;
51231da177e4SLinus Torvalds 	struct device *hub_dev;
51241da177e4SLinus Torvalds 	u16 hubstatus;
51251da177e4SLinus Torvalds 	u16 hubchange;
51261da177e4SLinus Torvalds 	int i, ret;
51271da177e4SLinus Torvalds 
512832a69589SPetr Mladek 	hub = container_of(work, struct usb_hub, events);
51295d14f323SPetr Mladek 	hdev = hub->hdev;
5130e8054854SAlan Stern 	hub_dev = hub->intfdev;
5131e8054854SAlan Stern 	intf = to_usb_interface(hub_dev);
513232a69589SPetr Mladek 
513340f122f3SAlan Stern 	dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
51343bbc47d8SKrzysztof Mazur 			hdev->state, hdev->maxchild,
51351da177e4SLinus Torvalds 			/* NOTE: expects max 15 ports... */
51361da177e4SLinus Torvalds 			(u16) hub->change_bits[0],
513740f122f3SAlan Stern 			(u16) hub->event_bits[0]);
51381da177e4SLinus Torvalds 
51391da177e4SLinus Torvalds 	/* Lock the device, then check to see if we were
51401da177e4SLinus Torvalds 	 * disconnected while waiting for the lock to succeed. */
514106b84e8aSAlan Stern 	usb_lock_device(hdev);
5142e8054854SAlan Stern 	if (unlikely(hub->disconnected))
514332a69589SPetr Mladek 		goto out_hdev_lock;
51441da177e4SLinus Torvalds 
51451da177e4SLinus Torvalds 	/* If the hub has died, clean up after it */
51461da177e4SLinus Torvalds 	if (hdev->state == USB_STATE_NOTATTACHED) {
51477de18d8bSAlan Stern 		hub->error = -ENODEV;
51484330354fSAlan Stern 		hub_quiesce(hub, HUB_DISCONNECT);
514932a69589SPetr Mladek 		goto out_hdev_lock;
51501da177e4SLinus Torvalds 	}
51511da177e4SLinus Torvalds 
515240f122f3SAlan Stern 	/* Autoresume */
515340f122f3SAlan Stern 	ret = usb_autopm_get_interface(intf);
515440f122f3SAlan Stern 	if (ret) {
515540f122f3SAlan Stern 		dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
515632a69589SPetr Mladek 		goto out_hdev_lock;
515740f122f3SAlan Stern 	}
515840f122f3SAlan Stern 
515940f122f3SAlan Stern 	/* If this is an inactive hub, do nothing */
516040f122f3SAlan Stern 	if (hub->quiescing)
5161eb6e2924SPetr Mladek 		goto out_autopm;
51621da177e4SLinus Torvalds 
51631da177e4SLinus Torvalds 	if (hub->error) {
5164eb6e2924SPetr Mladek 		dev_dbg(hub_dev, "resetting for error %d\n", hub->error);
51651da177e4SLinus Torvalds 
5166742120c6SMing Lei 		ret = usb_reset_device(hdev);
51671da177e4SLinus Torvalds 		if (ret) {
5168eb6e2924SPetr Mladek 			dev_dbg(hub_dev, "error resetting hub: %d\n", ret);
5169eb6e2924SPetr Mladek 			goto out_autopm;
51701da177e4SLinus Torvalds 		}
51711da177e4SLinus Torvalds 
51721da177e4SLinus Torvalds 		hub->nerrors = 0;
51731da177e4SLinus Torvalds 		hub->error = 0;
51741da177e4SLinus Torvalds 	}
51751da177e4SLinus Torvalds 
51761da177e4SLinus Torvalds 	/* deal with port status changes */
51773bbc47d8SKrzysztof Mazur 	for (i = 1; i <= hdev->maxchild; i++) {
5178097a155fSDan Williams 		struct usb_port *port_dev = hub->ports[i - 1];
5179a82b76f7SHans de Goede 
51805c79a1e3SDan Williams 		if (test_bit(i, hub->event_bits)
5181af376a46SDan Williams 				|| test_bit(i, hub->change_bits)
51825c79a1e3SDan Williams 				|| test_bit(i, hub->wakeup_bits)) {
51831da177e4SLinus Torvalds 			/*
5184097a155fSDan Williams 			 * The get_noresume and barrier ensure that if
5185097a155fSDan Williams 			 * the port was in the process of resuming, we
5186097a155fSDan Williams 			 * flush that work and keep the port active for
5187097a155fSDan Williams 			 * the duration of the port_event().  However,
5188097a155fSDan Williams 			 * if the port is runtime pm suspended
5189097a155fSDan Williams 			 * (powered-off), we leave it in that state, run
5190097a155fSDan Williams 			 * an abbreviated port_event(), and move on.
51911da177e4SLinus Torvalds 			 */
5192097a155fSDan Williams 			pm_runtime_get_noresume(&port_dev->dev);
5193097a155fSDan Williams 			pm_runtime_barrier(&port_dev->dev);
51945c79a1e3SDan Williams 			usb_lock_port(port_dev);
5195af376a46SDan Williams 			port_event(hub, i);
51965c79a1e3SDan Williams 			usb_unlock_port(port_dev);
5197097a155fSDan Williams 			pm_runtime_put_sync(&port_dev->dev);
51981da177e4SLinus Torvalds 		}
51991da177e4SLinus Torvalds 	}
52001da177e4SLinus Torvalds 
52011da177e4SLinus Torvalds 	/* deal with hub status changes */
52021da177e4SLinus Torvalds 	if (test_and_clear_bit(0, hub->event_bits) == 0)
52031da177e4SLinus Torvalds 		;	/* do nothing */
52041da177e4SLinus Torvalds 	else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
52051da177e4SLinus Torvalds 		dev_err(hub_dev, "get_hub_status failed\n");
52061da177e4SLinus Torvalds 	else {
52071da177e4SLinus Torvalds 		if (hubchange & HUB_CHANGE_LOCAL_POWER) {
52081da177e4SLinus Torvalds 			dev_dbg(hub_dev, "power change\n");
52091da177e4SLinus Torvalds 			clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
521055c52718SAlan Stern 			if (hubstatus & HUB_STATUS_LOCAL_POWER)
521155c52718SAlan Stern 				/* FIXME: Is this always true? */
521255c52718SAlan Stern 				hub->limited_power = 1;
5213403fae78Sjidong xiao 			else
5214403fae78Sjidong xiao 				hub->limited_power = 0;
52151da177e4SLinus Torvalds 		}
52161da177e4SLinus Torvalds 		if (hubchange & HUB_CHANGE_OVERCURRENT) {
5217752d57a8SPaul Bolle 			u16 status = 0;
5218752d57a8SPaul Bolle 			u16 unused;
5219752d57a8SPaul Bolle 
5220752d57a8SPaul Bolle 			dev_dbg(hub_dev, "over-current change\n");
52211da177e4SLinus Torvalds 			clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
5222752d57a8SPaul Bolle 			msleep(500);	/* Cool down */
52238520f380SAlan Stern 			hub_power_on(hub, true);
5224752d57a8SPaul Bolle 			hub_hub_status(hub, &status, &unused);
5225752d57a8SPaul Bolle 			if (status & HUB_STATUS_OVERCURRENT)
5226eb6e2924SPetr Mladek 				dev_err(hub_dev, "over-current condition\n");
52271da177e4SLinus Torvalds 		}
52281da177e4SLinus Torvalds 	}
52291da177e4SLinus Torvalds 
5230eb6e2924SPetr Mladek out_autopm:
52318e4ceb38SAlan Stern 	/* Balance the usb_autopm_get_interface() above */
52328e4ceb38SAlan Stern 	usb_autopm_put_interface_no_suspend(intf);
523332a69589SPetr Mladek out_hdev_lock:
52341da177e4SLinus Torvalds 	usb_unlock_device(hdev);
523532a69589SPetr Mladek 
523632a69589SPetr Mladek 	/* Balance the stuff in kick_hub_wq() and allow autosuspend */
523732a69589SPetr Mladek 	usb_autopm_put_interface(intf);
5238e8054854SAlan Stern 	kref_put(&hub->kref, hub_release);
52391da177e4SLinus Torvalds }
52401da177e4SLinus Torvalds 
52411e927d96SNémeth Márton static const struct usb_device_id hub_id_table[] = {
5242e6f30deaSMing Lei     { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5243e6f30deaSMing Lei 			| USB_DEVICE_ID_MATCH_INT_CLASS,
5244e6f30deaSMing Lei       .idVendor = USB_VENDOR_GENESYS_LOGIC,
5245e6f30deaSMing Lei       .bInterfaceClass = USB_CLASS_HUB,
5246e6f30deaSMing Lei       .driver_info = HUB_QUIRK_CHECK_PORT_AUTOSUSPEND},
52471da177e4SLinus Torvalds     { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
52481da177e4SLinus Torvalds       .bDeviceClass = USB_CLASS_HUB},
52491da177e4SLinus Torvalds     { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
52501da177e4SLinus Torvalds       .bInterfaceClass = USB_CLASS_HUB},
52511da177e4SLinus Torvalds     { }						/* Terminating entry */
52521da177e4SLinus Torvalds };
52531da177e4SLinus Torvalds 
52541da177e4SLinus Torvalds MODULE_DEVICE_TABLE(usb, hub_id_table);
52551da177e4SLinus Torvalds 
52561da177e4SLinus Torvalds static struct usb_driver hub_driver = {
52571da177e4SLinus Torvalds 	.name =		"hub",
52581da177e4SLinus Torvalds 	.probe =	hub_probe,
52591da177e4SLinus Torvalds 	.disconnect =	hub_disconnect,
52601da177e4SLinus Torvalds 	.suspend =	hub_suspend,
52611da177e4SLinus Torvalds 	.resume =	hub_resume,
5262f07600cfSAlan Stern 	.reset_resume =	hub_reset_resume,
52637de18d8bSAlan Stern 	.pre_reset =	hub_pre_reset,
52647de18d8bSAlan Stern 	.post_reset =	hub_post_reset,
5265c532b29aSAndi Kleen 	.unlocked_ioctl = hub_ioctl,
52661da177e4SLinus Torvalds 	.id_table =	hub_id_table,
526740f122f3SAlan Stern 	.supports_autosuspend =	1,
52681da177e4SLinus Torvalds };
52691da177e4SLinus Torvalds 
52701da177e4SLinus Torvalds int usb_hub_init(void)
52711da177e4SLinus Torvalds {
52721da177e4SLinus Torvalds 	if (usb_register(&hub_driver) < 0) {
52731da177e4SLinus Torvalds 		printk(KERN_ERR "%s: can't register hub driver\n",
52741da177e4SLinus Torvalds 			usbcore_name);
52751da177e4SLinus Torvalds 		return -1;
52761da177e4SLinus Torvalds 	}
52771da177e4SLinus Torvalds 
527832a69589SPetr Mladek 	/*
527932a69589SPetr Mladek 	 * The workqueue needs to be freezable to avoid interfering with
528032a69589SPetr Mladek 	 * USB-PERSIST port handover. Otherwise it might see that a full-speed
528132a69589SPetr Mladek 	 * device was gone before the EHCI controller had handed its port
528232a69589SPetr Mladek 	 * over to the companion full-speed controller.
528332a69589SPetr Mladek 	 */
5284638139ebSPetr Mladek 	hub_wq = alloc_workqueue("usb_hub_wq", WQ_FREEZABLE, 0);
528532a69589SPetr Mladek 	if (hub_wq)
52861da177e4SLinus Torvalds 		return 0;
52871da177e4SLinus Torvalds 
52881da177e4SLinus Torvalds 	/* Fall through if kernel_thread failed */
52891da177e4SLinus Torvalds 	usb_deregister(&hub_driver);
529032a69589SPetr Mladek 	pr_err("%s: can't allocate workqueue for usb hub\n", usbcore_name);
52911da177e4SLinus Torvalds 
52921da177e4SLinus Torvalds 	return -1;
52931da177e4SLinus Torvalds }
52941da177e4SLinus Torvalds 
52951da177e4SLinus Torvalds void usb_hub_cleanup(void)
52961da177e4SLinus Torvalds {
529732a69589SPetr Mladek 	destroy_workqueue(hub_wq);
52981da177e4SLinus Torvalds 
52991da177e4SLinus Torvalds 	/*
53001da177e4SLinus Torvalds 	 * Hub resources are freed for us by usb_deregister. It calls
53011da177e4SLinus Torvalds 	 * usb_driver_purge on every device which in turn calls that
53021da177e4SLinus Torvalds 	 * devices disconnect function if it is using this driver.
53031da177e4SLinus Torvalds 	 * The hub_disconnect function takes care of releasing the
53041da177e4SLinus Torvalds 	 * individual hub resources. -greg
53051da177e4SLinus Torvalds 	 */
53061da177e4SLinus Torvalds 	usb_deregister(&hub_driver);
53071da177e4SLinus Torvalds } /* usb_hub_cleanup() */
53081da177e4SLinus Torvalds 
5309eb764c4bSAlan Stern static int descriptors_changed(struct usb_device *udev,
5310e3376d6cSXenia Ragiadakou 		struct usb_device_descriptor *old_device_descriptor,
5311e3376d6cSXenia Ragiadakou 		struct usb_host_bos *old_bos)
53121da177e4SLinus Torvalds {
5313eb764c4bSAlan Stern 	int		changed = 0;
53141da177e4SLinus Torvalds 	unsigned	index;
5315eb764c4bSAlan Stern 	unsigned	serial_len = 0;
5316eb764c4bSAlan Stern 	unsigned	len;
5317eb764c4bSAlan Stern 	unsigned	old_length;
5318eb764c4bSAlan Stern 	int		length;
5319eb764c4bSAlan Stern 	char		*buf;
53201da177e4SLinus Torvalds 
5321eb764c4bSAlan Stern 	if (memcmp(&udev->descriptor, old_device_descriptor,
5322eb764c4bSAlan Stern 			sizeof(*old_device_descriptor)) != 0)
5323eb764c4bSAlan Stern 		return 1;
5324eb764c4bSAlan Stern 
5325e3376d6cSXenia Ragiadakou 	if ((old_bos && !udev->bos) || (!old_bos && udev->bos))
5326e3376d6cSXenia Ragiadakou 		return 1;
5327e3376d6cSXenia Ragiadakou 	if (udev->bos) {
5328b9a10481SXenia Ragiadakou 		len = le16_to_cpu(udev->bos->desc->wTotalLength);
5329b9a10481SXenia Ragiadakou 		if (len != le16_to_cpu(old_bos->desc->wTotalLength))
5330e3376d6cSXenia Ragiadakou 			return 1;
5331b9a10481SXenia Ragiadakou 		if (memcmp(udev->bos->desc, old_bos->desc, len))
5332e3376d6cSXenia Ragiadakou 			return 1;
5333e3376d6cSXenia Ragiadakou 	}
5334e3376d6cSXenia Ragiadakou 
5335eb764c4bSAlan Stern 	/* Since the idVendor, idProduct, and bcdDevice values in the
5336eb764c4bSAlan Stern 	 * device descriptor haven't changed, we will assume the
5337eb764c4bSAlan Stern 	 * Manufacturer and Product strings haven't changed either.
5338eb764c4bSAlan Stern 	 * But the SerialNumber string could be different (e.g., a
5339eb764c4bSAlan Stern 	 * different flash card of the same brand).
5340eb764c4bSAlan Stern 	 */
5341eb764c4bSAlan Stern 	if (udev->serial)
5342eb764c4bSAlan Stern 		serial_len = strlen(udev->serial) + 1;
5343eb764c4bSAlan Stern 
5344eb764c4bSAlan Stern 	len = serial_len;
53451da177e4SLinus Torvalds 	for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5346eb764c4bSAlan Stern 		old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5347eb764c4bSAlan Stern 		len = max(len, old_length);
53481da177e4SLinus Torvalds 	}
5349eb764c4bSAlan Stern 
53500cc1a51fSOliver Neukum 	buf = kmalloc(len, GFP_NOIO);
5351b74e7062SWolfram Sang 	if (!buf)
53521da177e4SLinus Torvalds 		/* assume the worst */
53531da177e4SLinus Torvalds 		return 1;
5354b74e7062SWolfram Sang 
53551da177e4SLinus Torvalds 	for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5356eb764c4bSAlan Stern 		old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
53571da177e4SLinus Torvalds 		length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
53581da177e4SLinus Torvalds 				old_length);
5359eb764c4bSAlan Stern 		if (length != old_length) {
53601da177e4SLinus Torvalds 			dev_dbg(&udev->dev, "config index %d, error %d\n",
53611da177e4SLinus Torvalds 					index, length);
5362eb764c4bSAlan Stern 			changed = 1;
53631da177e4SLinus Torvalds 			break;
53641da177e4SLinus Torvalds 		}
53651da177e4SLinus Torvalds 		if (memcmp(buf, udev->rawdescriptors[index], old_length)
53661da177e4SLinus Torvalds 				!= 0) {
53671da177e4SLinus Torvalds 			dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
5368eb764c4bSAlan Stern 				index,
5369eb764c4bSAlan Stern 				((struct usb_config_descriptor *) buf)->
5370eb764c4bSAlan Stern 					bConfigurationValue);
5371eb764c4bSAlan Stern 			changed = 1;
53721da177e4SLinus Torvalds 			break;
53731da177e4SLinus Torvalds 		}
53741da177e4SLinus Torvalds 	}
5375eb764c4bSAlan Stern 
5376eb764c4bSAlan Stern 	if (!changed && serial_len) {
5377eb764c4bSAlan Stern 		length = usb_string(udev, udev->descriptor.iSerialNumber,
5378eb764c4bSAlan Stern 				buf, serial_len);
5379eb764c4bSAlan Stern 		if (length + 1 != serial_len) {
5380eb764c4bSAlan Stern 			dev_dbg(&udev->dev, "serial string error %d\n",
5381eb764c4bSAlan Stern 					length);
5382eb764c4bSAlan Stern 			changed = 1;
5383eb764c4bSAlan Stern 		} else if (memcmp(buf, udev->serial, length) != 0) {
5384eb764c4bSAlan Stern 			dev_dbg(&udev->dev, "serial string changed\n");
5385eb764c4bSAlan Stern 			changed = 1;
5386eb764c4bSAlan Stern 		}
5387eb764c4bSAlan Stern 	}
5388eb764c4bSAlan Stern 
53891da177e4SLinus Torvalds 	kfree(buf);
5390eb764c4bSAlan Stern 	return changed;
53911da177e4SLinus Torvalds }
53921da177e4SLinus Torvalds 
53931da177e4SLinus Torvalds /**
5394742120c6SMing Lei  * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
53951da177e4SLinus Torvalds  * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
53961da177e4SLinus Torvalds  *
539779efa097SAlan Stern  * WARNING - don't use this routine to reset a composite device
539879efa097SAlan Stern  * (one with multiple interfaces owned by separate drivers)!
5399742120c6SMing Lei  * Use usb_reset_device() instead.
54001da177e4SLinus Torvalds  *
54011da177e4SLinus Torvalds  * Do a port reset, reassign the device's address, and establish its
54021da177e4SLinus Torvalds  * former operating configuration.  If the reset fails, or the device's
54031da177e4SLinus Torvalds  * descriptors change from their values before the reset, or the original
54041da177e4SLinus Torvalds  * configuration and altsettings cannot be restored, a flag will be set
540537ebb549SPetr Mladek  * telling hub_wq to pretend the device has been disconnected and then
54061da177e4SLinus Torvalds  * re-connected.  All drivers will be unbound, and the device will be
54071da177e4SLinus Torvalds  * re-enumerated and probed all over again.
54081da177e4SLinus Torvalds  *
5409626f090cSYacine Belkadi  * Return: 0 if the reset succeeded, -ENODEV if the device has been
54101da177e4SLinus Torvalds  * flagged for logical disconnection, or some other negative error code
54111da177e4SLinus Torvalds  * if the reset wasn't even attempted.
54121da177e4SLinus Torvalds  *
5413626f090cSYacine Belkadi  * Note:
54145c79a1e3SDan Williams  * The caller must own the device lock and the port lock, the latter is
54155c79a1e3SDan Williams  * taken by usb_reset_device().  For example, it's safe to use
54165c79a1e3SDan Williams  * usb_reset_device() from a driver probe() routine after downloading
54175c79a1e3SDan Williams  * new firmware.  For calls that might not occur during probe(), drivers
54185c79a1e3SDan Williams  * should lock the device using usb_lock_device_for_reset().
54196bc6cff5SAlan Stern  *
54206bc6cff5SAlan Stern  * Locking exception: This routine may also be called from within an
54216bc6cff5SAlan Stern  * autoresume handler.  Such usage won't conflict with other tasks
54226bc6cff5SAlan Stern  * holding the device lock because these tasks should always call
54235c79a1e3SDan Williams  * usb_autopm_resume_device(), thereby preventing any unwanted
54245c79a1e3SDan Williams  * autoresume.  The autoresume handler is expected to have already
54255c79a1e3SDan Williams  * acquired the port lock before calling this routine.
54261da177e4SLinus Torvalds  */
5427742120c6SMing Lei static int usb_reset_and_verify_device(struct usb_device *udev)
54281da177e4SLinus Torvalds {
54291da177e4SLinus Torvalds 	struct usb_device		*parent_hdev = udev->parent;
54301da177e4SLinus Torvalds 	struct usb_hub			*parent_hub;
54313f0479e0SSarah Sharp 	struct usb_hcd			*hcd = bus_to_hcd(udev->bus);
54321da177e4SLinus Torvalds 	struct usb_device_descriptor	descriptor = udev->descriptor;
5433e3376d6cSXenia Ragiadakou 	struct usb_host_bos		*bos;
54347a7b562dSHans de Goede 	int				i, j, ret = 0;
543512c3da34SAlan Stern 	int				port1 = udev->portnum;
54361da177e4SLinus Torvalds 
54371da177e4SLinus Torvalds 	if (udev->state == USB_STATE_NOTATTACHED ||
54381da177e4SLinus Torvalds 			udev->state == USB_STATE_SUSPENDED) {
54391da177e4SLinus Torvalds 		dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
54401da177e4SLinus Torvalds 				udev->state);
54411da177e4SLinus Torvalds 		return -EINVAL;
54421da177e4SLinus Torvalds 	}
54431da177e4SLinus Torvalds 
54445c79a1e3SDan Williams 	if (!parent_hdev)
54451da177e4SLinus Torvalds 		return -EISDIR;
54465c79a1e3SDan Williams 
5447ad493e5eSLan Tianyu 	parent_hub = usb_hub_to_struct_hub(parent_hdev);
54481da177e4SLinus Torvalds 
5449dcc01c08SSarah Sharp 	/* Disable USB2 hardware LPM.
5450dcc01c08SSarah Sharp 	 * It will be re-enabled by the enumeration process.
5451dcc01c08SSarah Sharp 	 */
5452dcc01c08SSarah Sharp 	if (udev->usb2_hw_lpm_enabled == 1)
5453dcc01c08SSarah Sharp 		usb_set_usb2_hardware_lpm(udev, 0);
5454dcc01c08SSarah Sharp 
5455f74631e3SSarah Sharp 	/* Disable LPM and LTM while we reset the device and reinstall the alt
5456f74631e3SSarah Sharp 	 * settings.  Device-initiated LPM settings, and system exit latency
5457f74631e3SSarah Sharp 	 * settings are cleared when the device is reset, so we have to set
5458f74631e3SSarah Sharp 	 * them up again.
54596d1d0513SSarah Sharp 	 */
54606d1d0513SSarah Sharp 	ret = usb_unlocked_disable_lpm(udev);
54616d1d0513SSarah Sharp 	if (ret) {
54626d1d0513SSarah Sharp 		dev_err(&udev->dev, "%s Failed to disable LPM\n.", __func__);
5463464ad8c4SHans Yang 		goto re_enumerate_no_bos;
54646d1d0513SSarah Sharp 	}
5465f74631e3SSarah Sharp 	ret = usb_disable_ltm(udev);
5466f74631e3SSarah Sharp 	if (ret) {
5467f74631e3SSarah Sharp 		dev_err(&udev->dev, "%s Failed to disable LTM\n.",
5468f74631e3SSarah Sharp 				__func__);
5469464ad8c4SHans Yang 		goto re_enumerate_no_bos;
5470f74631e3SSarah Sharp 	}
54716d1d0513SSarah Sharp 
5472464ad8c4SHans Yang 	bos = udev->bos;
5473e5bdfd50SGreg Kroah-Hartman 	udev->bos = NULL;
5474464ad8c4SHans Yang 
54751da177e4SLinus Torvalds 	for (i = 0; i < SET_CONFIG_TRIES; ++i) {
54761da177e4SLinus Torvalds 
54771da177e4SLinus Torvalds 		/* ep0 maxpacket size may change; let the HCD know about it.
54781da177e4SLinus Torvalds 		 * Other endpoints will be handled by re-enumeration. */
5479fc721f51SInaky Perez-Gonzalez 		usb_ep0_reinit(udev);
54801da177e4SLinus Torvalds 		ret = hub_port_init(parent_hub, udev, port1, i);
5481dd4dd19eSAlan Stern 		if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
54821da177e4SLinus Torvalds 			break;
54831da177e4SLinus Torvalds 	}
5484d5cbad4bSAlan Stern 
54851da177e4SLinus Torvalds 	if (ret < 0)
54861da177e4SLinus Torvalds 		goto re_enumerate;
54871da177e4SLinus Torvalds 
54881da177e4SLinus Torvalds 	/* Device might have changed firmware (DFU or similar) */
5489e3376d6cSXenia Ragiadakou 	if (descriptors_changed(udev, &descriptor, bos)) {
54901da177e4SLinus Torvalds 		dev_info(&udev->dev, "device firmware changed\n");
54911da177e4SLinus Torvalds 		udev->descriptor = descriptor;	/* for disconnect() calls */
54921da177e4SLinus Torvalds 		goto re_enumerate;
54931da177e4SLinus Torvalds 	}
54941da177e4SLinus Torvalds 
54954fe0387aSAlan Stern 	/* Restore the device's previous configuration */
54961da177e4SLinus Torvalds 	if (!udev->actconfig)
54971da177e4SLinus Torvalds 		goto done;
54983f0479e0SSarah Sharp 
5499d673bfcbSSarah Sharp 	mutex_lock(hcd->bandwidth_mutex);
55003f0479e0SSarah Sharp 	ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
55013f0479e0SSarah Sharp 	if (ret < 0) {
55023f0479e0SSarah Sharp 		dev_warn(&udev->dev,
55033f0479e0SSarah Sharp 				"Busted HC?  Not enough HCD resources for "
55043f0479e0SSarah Sharp 				"old configuration.\n");
5505d673bfcbSSarah Sharp 		mutex_unlock(hcd->bandwidth_mutex);
55063f0479e0SSarah Sharp 		goto re_enumerate;
55073f0479e0SSarah Sharp 	}
55081da177e4SLinus Torvalds 	ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
55091da177e4SLinus Torvalds 			USB_REQ_SET_CONFIGURATION, 0,
55101da177e4SLinus Torvalds 			udev->actconfig->desc.bConfigurationValue, 0,
55111da177e4SLinus Torvalds 			NULL, 0, USB_CTRL_SET_TIMEOUT);
55121da177e4SLinus Torvalds 	if (ret < 0) {
55131da177e4SLinus Torvalds 		dev_err(&udev->dev,
55141da177e4SLinus Torvalds 			"can't restore configuration #%d (error=%d)\n",
55151da177e4SLinus Torvalds 			udev->actconfig->desc.bConfigurationValue, ret);
5516d673bfcbSSarah Sharp 		mutex_unlock(hcd->bandwidth_mutex);
55171da177e4SLinus Torvalds 		goto re_enumerate;
55181da177e4SLinus Torvalds 	}
5519d673bfcbSSarah Sharp 	mutex_unlock(hcd->bandwidth_mutex);
55201da177e4SLinus Torvalds 	usb_set_device_state(udev, USB_STATE_CONFIGURED);
55211da177e4SLinus Torvalds 
55224fe0387aSAlan Stern 	/* Put interfaces back into the same altsettings as before.
55234fe0387aSAlan Stern 	 * Don't bother to send the Set-Interface request for interfaces
55244fe0387aSAlan Stern 	 * that were already in altsetting 0; besides being unnecessary,
55254fe0387aSAlan Stern 	 * many devices can't handle it.  Instead just reset the host-side
55264fe0387aSAlan Stern 	 * endpoint state.
55274fe0387aSAlan Stern 	 */
55281da177e4SLinus Torvalds 	for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
55293f0479e0SSarah Sharp 		struct usb_host_config *config = udev->actconfig;
55303f0479e0SSarah Sharp 		struct usb_interface *intf = config->interface[i];
55311da177e4SLinus Torvalds 		struct usb_interface_descriptor *desc;
55321da177e4SLinus Torvalds 
55331da177e4SLinus Torvalds 		desc = &intf->cur_altsetting->desc;
55344fe0387aSAlan Stern 		if (desc->bAlternateSetting == 0) {
55354fe0387aSAlan Stern 			usb_disable_interface(udev, intf, true);
55364fe0387aSAlan Stern 			usb_enable_interface(udev, intf, true);
55374fe0387aSAlan Stern 			ret = 0;
55384fe0387aSAlan Stern 		} else {
553904a723eaSSarah Sharp 			/* Let the bandwidth allocation function know that this
554004a723eaSSarah Sharp 			 * device has been reset, and it will have to use
554104a723eaSSarah Sharp 			 * alternate setting 0 as the current alternate setting.
55423f0479e0SSarah Sharp 			 */
554304a723eaSSarah Sharp 			intf->resetting_device = 1;
55441da177e4SLinus Torvalds 			ret = usb_set_interface(udev, desc->bInterfaceNumber,
55451da177e4SLinus Torvalds 					desc->bAlternateSetting);
554604a723eaSSarah Sharp 			intf->resetting_device = 0;
55474fe0387aSAlan Stern 		}
55481da177e4SLinus Torvalds 		if (ret < 0) {
55491da177e4SLinus Torvalds 			dev_err(&udev->dev, "failed to restore interface %d "
55501da177e4SLinus Torvalds 				"altsetting %d (error=%d)\n",
55511da177e4SLinus Torvalds 				desc->bInterfaceNumber,
55521da177e4SLinus Torvalds 				desc->bAlternateSetting,
55531da177e4SLinus Torvalds 				ret);
55541da177e4SLinus Torvalds 			goto re_enumerate;
55551da177e4SLinus Torvalds 		}
55567a7b562dSHans de Goede 		/* Resetting also frees any allocated streams */
55577a7b562dSHans de Goede 		for (j = 0; j < intf->cur_altsetting->desc.bNumEndpoints; j++)
55587a7b562dSHans de Goede 			intf->cur_altsetting->endpoint[j].streams = 0;
55591da177e4SLinus Torvalds 	}
55601da177e4SLinus Torvalds 
55611da177e4SLinus Torvalds done:
5562f74631e3SSarah Sharp 	/* Now that the alt settings are re-installed, enable LTM and LPM. */
5563de68bab4SSarah Sharp 	usb_set_usb2_hardware_lpm(udev, 1);
556478d9a487SAlan Stern 	usb_unlocked_enable_lpm(udev);
5565f74631e3SSarah Sharp 	usb_enable_ltm(udev);
5566e3376d6cSXenia Ragiadakou 	usb_release_bos_descriptor(udev);
5567e3376d6cSXenia Ragiadakou 	udev->bos = bos;
55681da177e4SLinus Torvalds 	return 0;
55691da177e4SLinus Torvalds 
55701da177e4SLinus Torvalds re_enumerate:
5571e3376d6cSXenia Ragiadakou 	usb_release_bos_descriptor(udev);
5572e3376d6cSXenia Ragiadakou 	udev->bos = bos;
5573464ad8c4SHans Yang re_enumerate_no_bos:
5574464ad8c4SHans Yang 	/* LPM state doesn't matter when we're about to destroy the device. */
5575464ad8c4SHans Yang 	hub_port_logical_disconnect(parent_hub, port1);
55761da177e4SLinus Torvalds 	return -ENODEV;
55771da177e4SLinus Torvalds }
55781da177e4SLinus Torvalds 
55791da177e4SLinus Torvalds /**
55801da177e4SLinus Torvalds  * usb_reset_device - warn interface drivers and perform a USB port reset
55811da177e4SLinus Torvalds  * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
55821da177e4SLinus Torvalds  *
558379efa097SAlan Stern  * Warns all drivers bound to registered interfaces (using their pre_reset
558479efa097SAlan Stern  * method), performs the port reset, and then lets the drivers know that
5585742120c6SMing Lei  * the reset is over (using their post_reset method).
558679efa097SAlan Stern  *
5587626f090cSYacine Belkadi  * Return: The same as for usb_reset_and_verify_device().
558879efa097SAlan Stern  *
5589626f090cSYacine Belkadi  * Note:
559079efa097SAlan Stern  * The caller must own the device lock.  For example, it's safe to use
559179efa097SAlan Stern  * this from a driver probe() routine after downloading new firmware.
559279efa097SAlan Stern  * For calls that might not occur during probe(), drivers should lock
5593742120c6SMing Lei  * the device using usb_lock_device_for_reset().
559479efa097SAlan Stern  *
559579efa097SAlan Stern  * If an interface is currently being probed or disconnected, we assume
559679efa097SAlan Stern  * its driver knows how to handle resets.  For all other interfaces,
559779efa097SAlan Stern  * if the driver doesn't have pre_reset and post_reset methods then
559879efa097SAlan Stern  * we attempt to unbind it and rebind afterward.
559979efa097SAlan Stern  */
5600742120c6SMing Lei int usb_reset_device(struct usb_device *udev)
560179efa097SAlan Stern {
560279efa097SAlan Stern 	int ret;
5603852c4b43SAlan Stern 	int i;
56044d769defSMing Lei 	unsigned int noio_flag;
56055c79a1e3SDan Williams 	struct usb_port *port_dev;
560679efa097SAlan Stern 	struct usb_host_config *config = udev->actconfig;
56075c79a1e3SDan Williams 	struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
560879efa097SAlan Stern 
560979efa097SAlan Stern 	if (udev->state == USB_STATE_NOTATTACHED ||
561079efa097SAlan Stern 			udev->state == USB_STATE_SUSPENDED) {
561179efa097SAlan Stern 		dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
561279efa097SAlan Stern 				udev->state);
561379efa097SAlan Stern 		return -EINVAL;
561479efa097SAlan Stern 	}
561579efa097SAlan Stern 
56165c79a1e3SDan Williams 	if (!udev->parent) {
56175c79a1e3SDan Williams 		/* this requires hcd-specific logic; see ohci_restart() */
56185c79a1e3SDan Williams 		dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
56195c79a1e3SDan Williams 		return -EISDIR;
56205c79a1e3SDan Williams 	}
56215c79a1e3SDan Williams 
56225c79a1e3SDan Williams 	port_dev = hub->ports[udev->portnum - 1];
56235c79a1e3SDan Williams 
56244d769defSMing Lei 	/*
56254d769defSMing Lei 	 * Don't allocate memory with GFP_KERNEL in current
56264d769defSMing Lei 	 * context to avoid possible deadlock if usb mass
56274d769defSMing Lei 	 * storage interface or usbnet interface(iSCSI case)
56284d769defSMing Lei 	 * is included in current configuration. The easist
56294d769defSMing Lei 	 * approach is to do it for every device reset,
56304d769defSMing Lei 	 * because the device 'memalloc_noio' flag may have
56314d769defSMing Lei 	 * not been set before reseting the usb device.
56324d769defSMing Lei 	 */
56334d769defSMing Lei 	noio_flag = memalloc_noio_save();
56344d769defSMing Lei 
5635645daaabSAlan Stern 	/* Prevent autosuspend during the reset */
563694fcda1fSAlan Stern 	usb_autoresume_device(udev);
5637645daaabSAlan Stern 
563879efa097SAlan Stern 	if (config) {
5639852c4b43SAlan Stern 		for (i = 0; i < config->desc.bNumInterfaces; ++i) {
5640852c4b43SAlan Stern 			struct usb_interface *cintf = config->interface[i];
564179efa097SAlan Stern 			struct usb_driver *drv;
564278d9a487SAlan Stern 			int unbind = 0;
564379efa097SAlan Stern 
5644852c4b43SAlan Stern 			if (cintf->dev.driver) {
564579efa097SAlan Stern 				drv = to_usb_driver(cintf->dev.driver);
564678d9a487SAlan Stern 				if (drv->pre_reset && drv->post_reset)
564778d9a487SAlan Stern 					unbind = (drv->pre_reset)(cintf);
564878d9a487SAlan Stern 				else if (cintf->condition ==
564978d9a487SAlan Stern 						USB_INTERFACE_BOUND)
565078d9a487SAlan Stern 					unbind = 1;
565178d9a487SAlan Stern 				if (unbind)
565278d9a487SAlan Stern 					usb_forced_unbind_intf(cintf);
565379efa097SAlan Stern 			}
565479efa097SAlan Stern 		}
565579efa097SAlan Stern 	}
565679efa097SAlan Stern 
56575c79a1e3SDan Williams 	usb_lock_port(port_dev);
5658742120c6SMing Lei 	ret = usb_reset_and_verify_device(udev);
56595c79a1e3SDan Williams 	usb_unlock_port(port_dev);
566079efa097SAlan Stern 
566179efa097SAlan Stern 	if (config) {
5662852c4b43SAlan Stern 		for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
5663852c4b43SAlan Stern 			struct usb_interface *cintf = config->interface[i];
566479efa097SAlan Stern 			struct usb_driver *drv;
566578d9a487SAlan Stern 			int rebind = cintf->needs_binding;
566679efa097SAlan Stern 
566778d9a487SAlan Stern 			if (!rebind && cintf->dev.driver) {
566879efa097SAlan Stern 				drv = to_usb_driver(cintf->dev.driver);
566979efa097SAlan Stern 				if (drv->post_reset)
567078d9a487SAlan Stern 					rebind = (drv->post_reset)(cintf);
567178d9a487SAlan Stern 				else if (cintf->condition ==
567278d9a487SAlan Stern 						USB_INTERFACE_BOUND)
567378d9a487SAlan Stern 					rebind = 1;
56746aec044cSAlan Stern 				if (rebind)
56756aec044cSAlan Stern 					cintf->needs_binding = 1;
567679efa097SAlan Stern 			}
567779efa097SAlan Stern 		}
56786aec044cSAlan Stern 		usb_unbind_and_rebind_marked_interfaces(udev);
567979efa097SAlan Stern 	}
568079efa097SAlan Stern 
568194fcda1fSAlan Stern 	usb_autosuspend_device(udev);
56824d769defSMing Lei 	memalloc_noio_restore(noio_flag);
568379efa097SAlan Stern 	return ret;
568479efa097SAlan Stern }
5685742120c6SMing Lei EXPORT_SYMBOL_GPL(usb_reset_device);
5686dc023dceSInaky Perez-Gonzalez 
5687dc023dceSInaky Perez-Gonzalez 
5688dc023dceSInaky Perez-Gonzalez /**
5689dc023dceSInaky Perez-Gonzalez  * usb_queue_reset_device - Reset a USB device from an atomic context
5690dc023dceSInaky Perez-Gonzalez  * @iface: USB interface belonging to the device to reset
5691dc023dceSInaky Perez-Gonzalez  *
5692dc023dceSInaky Perez-Gonzalez  * This function can be used to reset a USB device from an atomic
5693dc023dceSInaky Perez-Gonzalez  * context, where usb_reset_device() won't work (as it blocks).
5694dc023dceSInaky Perez-Gonzalez  *
5695dc023dceSInaky Perez-Gonzalez  * Doing a reset via this method is functionally equivalent to calling
5696dc023dceSInaky Perez-Gonzalez  * usb_reset_device(), except for the fact that it is delayed to a
5697dc023dceSInaky Perez-Gonzalez  * workqueue. This means that any drivers bound to other interfaces
5698dc023dceSInaky Perez-Gonzalez  * might be unbound, as well as users from usbfs in user space.
5699dc023dceSInaky Perez-Gonzalez  *
5700dc023dceSInaky Perez-Gonzalez  * Corner cases:
5701dc023dceSInaky Perez-Gonzalez  *
5702dc023dceSInaky Perez-Gonzalez  * - Scheduling two resets at the same time from two different drivers
5703dc023dceSInaky Perez-Gonzalez  *   attached to two different interfaces of the same device is
5704dc023dceSInaky Perez-Gonzalez  *   possible; depending on how the driver attached to each interface
5705dc023dceSInaky Perez-Gonzalez  *   handles ->pre_reset(), the second reset might happen or not.
5706dc023dceSInaky Perez-Gonzalez  *
5707524134d4SAlan Stern  * - If the reset is delayed so long that the interface is unbound from
5708524134d4SAlan Stern  *   its driver, the reset will be skipped.
5709dc023dceSInaky Perez-Gonzalez  *
5710524134d4SAlan Stern  * - This function can be called during .probe().  It can also be called
5711524134d4SAlan Stern  *   during .disconnect(), but doing so is pointless because the reset
5712524134d4SAlan Stern  *   will not occur.  If you really want to reset the device during
5713524134d4SAlan Stern  *   .disconnect(), call usb_reset_device() directly -- but watch out
5714524134d4SAlan Stern  *   for nested unbinding issues!
5715dc023dceSInaky Perez-Gonzalez  */
5716dc023dceSInaky Perez-Gonzalez void usb_queue_reset_device(struct usb_interface *iface)
5717dc023dceSInaky Perez-Gonzalez {
5718524134d4SAlan Stern 	if (schedule_work(&iface->reset_ws))
5719524134d4SAlan Stern 		usb_get_intf(iface);
5720dc023dceSInaky Perez-Gonzalez }
5721dc023dceSInaky Perez-Gonzalez EXPORT_SYMBOL_GPL(usb_queue_reset_device);
5722ff823c79SLan Tianyu 
5723ff823c79SLan Tianyu /**
5724ff823c79SLan Tianyu  * usb_hub_find_child - Get the pointer of child device
5725ff823c79SLan Tianyu  * attached to the port which is specified by @port1.
5726ff823c79SLan Tianyu  * @hdev: USB device belonging to the usb hub
5727ff823c79SLan Tianyu  * @port1: port num to indicate which port the child device
5728ff823c79SLan Tianyu  *	is attached to.
5729ff823c79SLan Tianyu  *
5730ff823c79SLan Tianyu  * USB drivers call this function to get hub's child device
5731ff823c79SLan Tianyu  * pointer.
5732ff823c79SLan Tianyu  *
5733626f090cSYacine Belkadi  * Return: %NULL if input param is invalid and
5734ff823c79SLan Tianyu  * child's usb_device pointer if non-NULL.
5735ff823c79SLan Tianyu  */
5736ff823c79SLan Tianyu struct usb_device *usb_hub_find_child(struct usb_device *hdev,
5737ff823c79SLan Tianyu 		int port1)
5738ff823c79SLan Tianyu {
5739ad493e5eSLan Tianyu 	struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5740ff823c79SLan Tianyu 
5741ff823c79SLan Tianyu 	if (port1 < 1 || port1 > hdev->maxchild)
5742ff823c79SLan Tianyu 		return NULL;
5743ff823c79SLan Tianyu 	return hub->ports[port1 - 1]->child;
5744ff823c79SLan Tianyu }
5745ff823c79SLan Tianyu EXPORT_SYMBOL_GPL(usb_hub_find_child);
5746d5575424SLan Tianyu 
5747d2123fd9SLan Tianyu void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
5748d2123fd9SLan Tianyu 		struct usb_hub_descriptor *desc)
5749d2123fd9SLan Tianyu {
5750d99f6b41SDan Williams 	struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5751d2123fd9SLan Tianyu 	enum usb_port_connect_type connect_type;
5752d2123fd9SLan Tianyu 	int i;
5753d2123fd9SLan Tianyu 
5754d99f6b41SDan Williams 	if (!hub)
5755d99f6b41SDan Williams 		return;
5756d99f6b41SDan Williams 
5757d2123fd9SLan Tianyu 	if (!hub_is_superspeed(hdev)) {
5758d2123fd9SLan Tianyu 		for (i = 1; i <= hdev->maxchild; i++) {
5759d99f6b41SDan Williams 			struct usb_port *port_dev = hub->ports[i - 1];
5760d2123fd9SLan Tianyu 
5761d99f6b41SDan Williams 			connect_type = port_dev->connect_type;
5762d2123fd9SLan Tianyu 			if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5763d2123fd9SLan Tianyu 				u8 mask = 1 << (i%8);
5764d2123fd9SLan Tianyu 
5765d2123fd9SLan Tianyu 				if (!(desc->u.hs.DeviceRemovable[i/8] & mask)) {
5766d99f6b41SDan Williams 					dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
5767d2123fd9SLan Tianyu 					desc->u.hs.DeviceRemovable[i/8]	|= mask;
5768d2123fd9SLan Tianyu 				}
5769d2123fd9SLan Tianyu 			}
5770d2123fd9SLan Tianyu 		}
5771d2123fd9SLan Tianyu 	} else {
5772d2123fd9SLan Tianyu 		u16 port_removable = le16_to_cpu(desc->u.ss.DeviceRemovable);
5773d2123fd9SLan Tianyu 
5774d2123fd9SLan Tianyu 		for (i = 1; i <= hdev->maxchild; i++) {
5775d99f6b41SDan Williams 			struct usb_port *port_dev = hub->ports[i - 1];
5776d2123fd9SLan Tianyu 
5777d99f6b41SDan Williams 			connect_type = port_dev->connect_type;
5778d2123fd9SLan Tianyu 			if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5779d2123fd9SLan Tianyu 				u16 mask = 1 << i;
5780d2123fd9SLan Tianyu 
5781d2123fd9SLan Tianyu 				if (!(port_removable & mask)) {
5782d99f6b41SDan Williams 					dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
5783d2123fd9SLan Tianyu 					port_removable |= mask;
5784d2123fd9SLan Tianyu 				}
5785d2123fd9SLan Tianyu 			}
5786d2123fd9SLan Tianyu 		}
5787d2123fd9SLan Tianyu 
5788d2123fd9SLan Tianyu 		desc->u.ss.DeviceRemovable = cpu_to_le16(port_removable);
5789d2123fd9SLan Tianyu 	}
5790d2123fd9SLan Tianyu }
5791d2123fd9SLan Tianyu 
5792d5575424SLan Tianyu #ifdef CONFIG_ACPI
5793d5575424SLan Tianyu /**
5794d5575424SLan Tianyu  * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5795d5575424SLan Tianyu  * @hdev: USB device belonging to the usb hub
5796d5575424SLan Tianyu  * @port1: port num of the port
5797d5575424SLan Tianyu  *
5798626f090cSYacine Belkadi  * Return: Port's acpi handle if successful, %NULL if params are
5799626f090cSYacine Belkadi  * invalid.
5800d5575424SLan Tianyu  */
5801d5575424SLan Tianyu acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
5802d5575424SLan Tianyu 	int port1)
5803d5575424SLan Tianyu {
5804ad493e5eSLan Tianyu 	struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5805d5575424SLan Tianyu 
580641341261SMathias Nyman 	if (!hub)
580741341261SMathias Nyman 		return NULL;
580841341261SMathias Nyman 
58093a83f992SRafael J. Wysocki 	return ACPI_HANDLE(&hub->ports[port1 - 1]->dev);
5810d5575424SLan Tianyu }
5811d5575424SLan Tianyu #endif
5812