1	// SPDX-License-Identifier: GPL-2.0
2	/*
3	* USB hub driver.
4	*
5	* (C) Copyright 1999 Linus Torvalds
6	* (C) Copyright 1999 Johannes Erdfelt
7	* (C) Copyright 1999 Gregory P. Smith
8	* (C) Copyright 2001 Brad Hards (bhards@bigpond.net.au)
9	*
10	* Released under the GPLv2 only.
11	*/
12
13	#include <linux/kernel.h>
14	#include <linux/errno.h>
15	#include <linux/module.h>
16	#include <linux/moduleparam.h>
17	#include <linux/completion.h>
18	#include <linux/sched/mm.h>
19	#include <linux/list.h>
20	#include <linux/slab.h>
21	#include <linux/kcov.h>
22	#include <linux/ioctl.h>
23	#include <linux/usb.h>
24	#include <linux/usbdevice_fs.h>
25	#include <linux/usb/hcd.h>
26	#include <linux/usb/onboard_hub.h>
27	#include <linux/usb/otg.h>
28	#include <linux/usb/quirks.h>
29	#include <linux/workqueue.h>
30	#include <linux/mutex.h>
31	#include <linux/random.h>
32	#include <linux/pm_qos.h>
33	#include <linux/kobject.h>
34
35	#include <linux/bitfield.h>
36	#include <linux/uaccess.h>
37	#include <asm/byteorder.h>
38
39	#include "hub.h"
40	#include "otg_productlist.h"
41
42	#define USB_VENDOR_GENESYS_LOGIC 0x05e3
43	#define USB_VENDOR_SMSC 0x0424
44	#define USB_PRODUCT_USB5534B 0x5534
45	#define USB_VENDOR_CYPRESS 0x04b4
46	#define USB_PRODUCT_CY7C65632 0x6570
47	#define USB_VENDOR_TEXAS_INSTRUMENTS 0x0451
48	#define USB_PRODUCT_TUSB8041_USB3 0x8140
49	#define USB_PRODUCT_TUSB8041_USB2 0x8142
50	#define HUB_QUIRK_CHECK_PORT_AUTOSUSPEND 0x01
51	#define HUB_QUIRK_DISABLE_AUTOSUSPEND 0x02
52
53	#define USB_TP_TRANSMISSION_DELAY 40 /* ns */
54	#define USB_TP_TRANSMISSION_DELAY_MAX 65535 /* ns */
55	#define USB_PING_RESPONSE_TIME 400 /* ns */
56
57	/* Protect struct usb_device->state and ->children members
58	* Note: Both are also protected by ->dev.sem, except that ->state can
59	* change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
60	static DEFINE_SPINLOCK(device_state_lock);
61
62	/* workqueue to process hub events */
63	static struct workqueue_struct *hub_wq;
64	static void hub_event(struct work_struct *work);
65
66	/* synchronize hub-port add/remove and peering operations */
67	DEFINE_MUTEX(usb_port_peer_mutex);
68
69	/* cycle leds on hubs that aren't blinking for attention */
70	static bool blinkenlights;
71	module_param(blinkenlights, bool, S_IRUGO);
72	MODULE_PARM_DESC(blinkenlights, "true to cycle leds on hubs");
73
74	/*
75	* Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
76	* 10 seconds to send reply for the initial 64-byte descriptor request.
77	*/
78	/* define initial 64-byte descriptor request timeout in milliseconds */
79	static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
80	module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
81	MODULE_PARM_DESC(initial_descriptor_timeout,
82	"initial 64-byte descriptor request timeout in milliseconds "
83	"(default 5000 - 5.0 seconds)");
84
85	/*
86	* As of 2.6.10 we introduce a new USB device initialization scheme which
87	* closely resembles the way Windows works. Hopefully it will be compatible
88	* with a wider range of devices than the old scheme. However some previously
89	* working devices may start giving rise to "device not accepting address"
90	* errors; if that happens the user can try the old scheme by adjusting the
91	* following module parameters.
92	*
93	* For maximum flexibility there are two boolean parameters to control the
94	* hub driver's behavior. On the first initialization attempt, if the
95	* "old_scheme_first" parameter is set then the old scheme will be used,
96	* otherwise the new scheme is used. If that fails and "use_both_schemes"
97	* is set, then the driver will make another attempt, using the other scheme.
98	*/
99	static bool old_scheme_first;
100	module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
101	MODULE_PARM_DESC(old_scheme_first,
102	"start with the old device initialization scheme");
103
104	static bool use_both_schemes = true;
105	module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
106	MODULE_PARM_DESC(use_both_schemes,
107	"try the other device initialization scheme if the "
108	"first one fails");
109
110	/* Mutual exclusion for EHCI CF initialization. This interferes with
111	* port reset on some companion controllers.
112	*/
113	DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
114	EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
115
116	#define HUB_DEBOUNCE_TIMEOUT 2000
117	#define HUB_DEBOUNCE_STEP 25
118	#define HUB_DEBOUNCE_STABLE 100
119
120	static void hub_release(struct kref *kref);
121	static int usb_reset_and_verify_device(struct usb_device *udev);
122	static int hub_port_disable(struct usb_hub *hub, int port1, int set_state);
123	static bool hub_port_warm_reset_required(struct usb_hub *hub, int port1,
124	u16 portstatus);
125
126	static inline char *portspeed(struct usb_hub *hub, int portstatus)
127	{
128	if (hub_is_superspeedplus(hdev: hub->hdev))
129	return "10.0 Gb/s";
130	if (hub_is_superspeed(hdev: hub->hdev))
131	return "5.0 Gb/s";
132	if (portstatus & USB_PORT_STAT_HIGH_SPEED)
133	return "480 Mb/s";
134	else if (portstatus & USB_PORT_STAT_LOW_SPEED)
135	return "1.5 Mb/s";
136	else
137	return "12 Mb/s";
138	}
139
140	/* Note that hdev or one of its children must be locked! */
141	struct usb_hub *usb_hub_to_struct_hub(struct usb_device *hdev)
142	{
143	if (!hdev || !hdev->actconfig || !hdev->maxchild)
144	return NULL;
145	return usb_get_intfdata(intf: hdev->actconfig->interface[0]);
146	}
147
148	int usb_device_supports_lpm(struct usb_device *udev)
149	{
150	/* Some devices have trouble with LPM */
151	if (udev->quirks & USB_QUIRK_NO_LPM)
152	return 0;
153
154	/* Skip if the device BOS descriptor couldn't be read */
155	if (!udev->bos)
156	return 0;
157
158	/* USB 2.1 (and greater) devices indicate LPM support through
159	* their USB 2.0 Extended Capabilities BOS descriptor.
160	*/
161	if (udev->speed == USB_SPEED_HIGH || udev->speed == USB_SPEED_FULL) {
162	if (udev->bos->ext_cap &&
163	(USB_LPM_SUPPORT &
164	le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
165	return 1;
166	return 0;
167	}
168
169	/*
170	* According to the USB 3.0 spec, all USB 3.0 devices must support LPM.
171	* However, there are some that don't, and they set the U1/U2 exit
172	* latencies to zero.
173	*/
174	if (!udev->bos->ss_cap) {
175	dev_info(&udev->dev, "No LPM exit latency info found, disabling LPM.\n");
176	return 0;
177	}
178
179	if (udev->bos->ss_cap->bU1devExitLat == 0 &&
180	udev->bos->ss_cap->bU2DevExitLat == 0) {
181	if (udev->parent)
182	dev_info(&udev->dev, "LPM exit latency is zeroed, disabling LPM.\n");
183	else
184	dev_info(&udev->dev, "We don't know the algorithms for LPM for this host, disabling LPM.\n");
185	return 0;
186	}
187
188	if (!udev->parent || udev->parent->lpm_capable)
189	return 1;
190	return 0;
191	}
192
193	/*
194	* Set the Maximum Exit Latency (MEL) for the host to wakup up the path from
195	* U1/U2, send a PING to the device and receive a PING_RESPONSE.
196	* See USB 3.1 section C.1.5.2
197	*/
198	static void usb_set_lpm_mel(struct usb_device *udev,
199	struct usb3_lpm_parameters *udev_lpm_params,
200	unsigned int udev_exit_latency,
201	struct usb_hub *hub,
202	struct usb3_lpm_parameters *hub_lpm_params,
203	unsigned int hub_exit_latency)
204	{
205	unsigned int total_mel;
206
207	/*
208	* tMEL1. time to transition path from host to device into U0.
209	* MEL for parent already contains the delay up to parent, so only add
210	* the exit latency for the last link (pick the slower exit latency),
211	* and the hub header decode latency. See USB 3.1 section C 2.2.1
212	* Store MEL in nanoseconds
213	*/
214	total_mel = hub_lpm_params->mel +
215	max(udev_exit_latency, hub_exit_latency) * 1000 +
216	hub->descriptor->u.ss.bHubHdrDecLat * 100;
217
218	/*
219	* tMEL2. Time to submit PING packet. Sum of tTPTransmissionDelay for
220	* each link + wHubDelay for each hub. Add only for last link.
221	* tMEL4, the time for PING_RESPONSE to traverse upstream is similar.
222	* Multiply by 2 to include it as well.
223	*/
224	total_mel += (__le16_to_cpu(hub->descriptor->u.ss.wHubDelay) +
225	USB_TP_TRANSMISSION_DELAY) * 2;
226
227	/*
228	* tMEL3, tPingResponse. Time taken by device to generate PING_RESPONSE
229	* after receiving PING. Also add 2100ns as stated in USB 3.1 C 1.5.2.4
230	* to cover the delay if the PING_RESPONSE is queued behind a Max Packet
231	* Size DP.
232	* Note these delays should be added only once for the entire path, so
233	* add them to the MEL of the device connected to the roothub.
234	*/
235	if (!hub->hdev->parent)
236	total_mel += USB_PING_RESPONSE_TIME + 2100;
237
238	udev_lpm_params->mel = total_mel;
239	}
240
241	/*
242	* Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
243	* a transition from either U1 or U2.
244	*/
245	static void usb_set_lpm_pel(struct usb_device *udev,
246	struct usb3_lpm_parameters *udev_lpm_params,
247	unsigned int udev_exit_latency,
248	struct usb_hub *hub,
249	struct usb3_lpm_parameters *hub_lpm_params,
250	unsigned int hub_exit_latency,
251	unsigned int port_to_port_exit_latency)
252	{
253	unsigned int first_link_pel;
254	unsigned int hub_pel;
255
256	/*
257	* First, the device sends an LFPS to transition the link between the
258	* device and the parent hub into U0. The exit latency is the bigger of
259	* the device exit latency or the hub exit latency.
260	*/
261	if (udev_exit_latency > hub_exit_latency)
262	first_link_pel = udev_exit_latency * 1000;
263	else
264	first_link_pel = hub_exit_latency * 1000;
265
266	/*
267	* When the hub starts to receive the LFPS, there is a slight delay for
268	* it to figure out that one of the ports is sending an LFPS. Then it
269	* will forward the LFPS to its upstream link. The exit latency is the
270	* delay, plus the PEL that we calculated for this hub.
271	*/
272	hub_pel = port_to_port_exit_latency * 1000 + hub_lpm_params->pel;
273
274	/*
275	* According to figure C-7 in the USB 3.0 spec, the PEL for this device
276	* is the greater of the two exit latencies.
277	*/
278	if (first_link_pel > hub_pel)
279	udev_lpm_params->pel = first_link_pel;
280	else
281	udev_lpm_params->pel = hub_pel;
282	}
283
284	/*
285	* Set the System Exit Latency (SEL) to indicate the total worst-case time from
286	* when a device initiates a transition to U0, until when it will receive the
287	* first packet from the host controller.
288	*
289	* Section C.1.5.1 describes the four components to this:
290	* - t1: device PEL
291	* - t2: time for the ERDY to make it from the device to the host.
292	* - t3: a host-specific delay to process the ERDY.
293	* - t4: time for the packet to make it from the host to the device.
294	*
295	* t3 is specific to both the xHCI host and the platform the host is integrated
296	* into. The Intel HW folks have said it's negligible, FIXME if a different
297	* vendor says otherwise.
298	*/
299	static void usb_set_lpm_sel(struct usb_device *udev,
300	struct usb3_lpm_parameters *udev_lpm_params)
301	{
302	struct usb_device *parent;
303	unsigned int num_hubs;
304	unsigned int total_sel;
305
306	/* t1 = device PEL */
307	total_sel = udev_lpm_params->pel;
308	/* How many external hubs are in between the device & the root port. */
309	for (parent = udev->parent, num_hubs = 0; parent->parent;
310	parent = parent->parent)
311	num_hubs++;
312	/* t2 = 2.1us + 250ns * (num_hubs - 1) */
313	if (num_hubs > 0)
314	total_sel += 2100 + 250 * (num_hubs - 1);
315
316	/* t4 = 250ns * num_hubs */
317	total_sel += 250 * num_hubs;
318
319	udev_lpm_params->sel = total_sel;
320	}
321
322	static void usb_set_lpm_parameters(struct usb_device *udev)
323	{
324	struct usb_hub *hub;
325	unsigned int port_to_port_delay;
326	unsigned int udev_u1_del;
327	unsigned int udev_u2_del;
328	unsigned int hub_u1_del;
329	unsigned int hub_u2_del;
330
331	if (!udev->lpm_capable || udev->speed < USB_SPEED_SUPER)
332	return;
333
334	/* Skip if the device BOS descriptor couldn't be read */
335	if (!udev->bos)
336	return;
337
338	hub = usb_hub_to_struct_hub(hdev: udev->parent);
339	/* It doesn't take time to transition the roothub into U0, since it
340	* doesn't have an upstream link.
341	*/
342	if (!hub)
343	return;
344
345	udev_u1_del = udev->bos->ss_cap->bU1devExitLat;
346	udev_u2_del = le16_to_cpu(udev->bos->ss_cap->bU2DevExitLat);
347	hub_u1_del = udev->parent->bos->ss_cap->bU1devExitLat;
348	hub_u2_del = le16_to_cpu(udev->parent->bos->ss_cap->bU2DevExitLat);
349
350	usb_set_lpm_mel(udev, udev_lpm_params: &udev->u1_params, udev_exit_latency: udev_u1_del,
351	hub, hub_lpm_params: &udev->parent->u1_params, hub_exit_latency: hub_u1_del);
352
353	usb_set_lpm_mel(udev, udev_lpm_params: &udev->u2_params, udev_exit_latency: udev_u2_del,
354	hub, hub_lpm_params: &udev->parent->u2_params, hub_exit_latency: hub_u2_del);
355
356	/*
357	* Appendix C, section C.2.2.2, says that there is a slight delay from
358	* when the parent hub notices the downstream port is trying to
359	* transition to U0 to when the hub initiates a U0 transition on its
360	* upstream port. The section says the delays are tPort2PortU1EL and
361	* tPort2PortU2EL, but it doesn't define what they are.
362	*
363	* The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
364	* about the same delays. Use the maximum delay calculations from those
365	* sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
366	* U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
367	* assume the device exit latencies they are talking about are the hub
368	* exit latencies.
369	*
370	* What do we do if the U2 exit latency is less than the U1 exit
371	* latency? It's possible, although not likely...
372	*/
373	port_to_port_delay = 1;
374
375	usb_set_lpm_pel(udev, udev_lpm_params: &udev->u1_params, udev_exit_latency: udev_u1_del,
376	hub, hub_lpm_params: &udev->parent->u1_params, hub_exit_latency: hub_u1_del,
377	port_to_port_exit_latency: port_to_port_delay);
378
379	if (hub_u2_del > hub_u1_del)
380	port_to_port_delay = 1 + hub_u2_del - hub_u1_del;
381	else
382	port_to_port_delay = 1 + hub_u1_del;
383
384	usb_set_lpm_pel(udev, udev_lpm_params: &udev->u2_params, udev_exit_latency: udev_u2_del,
385	hub, hub_lpm_params: &udev->parent->u2_params, hub_exit_latency: hub_u2_del,
386	port_to_port_exit_latency: port_to_port_delay);
387
388	/* Now that we've got PEL, calculate SEL. */
389	usb_set_lpm_sel(udev, udev_lpm_params: &udev->u1_params);
390	usb_set_lpm_sel(udev, udev_lpm_params: &udev->u2_params);
391	}
392
393	/* USB 2.0 spec Section 11.24.4.5 */
394	static int get_hub_descriptor(struct usb_device *hdev,
395	struct usb_hub_descriptor *desc)
396	{
397	int i, ret, size;
398	unsigned dtype;
399
400	if (hub_is_superspeed(hdev)) {
401	dtype = USB_DT_SS_HUB;
402	size = USB_DT_SS_HUB_SIZE;
403	} else {
404	dtype = USB_DT_HUB;
405	size = sizeof(struct usb_hub_descriptor);
406	}
407
408	for (i = 0; i < 3; i++) {
409	ret = usb_control_msg(dev: hdev, usb_rcvctrlpipe(hdev, 0),
410	USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
411	value: dtype << 8, index: 0, data: desc, size,
412	USB_CTRL_GET_TIMEOUT);
413	if (hub_is_superspeed(hdev)) {
414	if (ret == size)
415	return ret;
416	} else if (ret >= USB_DT_HUB_NONVAR_SIZE + 2) {
417	/* Make sure we have the DeviceRemovable field. */
418	size = USB_DT_HUB_NONVAR_SIZE + desc->bNbrPorts / 8 + 1;
419	if (ret < size)
420	return -EMSGSIZE;
421	return ret;
422	}
423	}
424	return -EINVAL;
425	}
426
427	/*
428	* USB 2.0 spec Section 11.24.2.1
429	*/
430	static int clear_hub_feature(struct usb_device *hdev, int feature)
431	{
432	return usb_control_msg(dev: hdev, usb_sndctrlpipe(hdev, 0),
433	USB_REQ_CLEAR_FEATURE, USB_RT_HUB, value: feature, index: 0, NULL, size: 0, timeout: 1000);
434	}
435
436	/*
437	* USB 2.0 spec Section 11.24.2.2
438	*/
439	int usb_clear_port_feature(struct usb_device *hdev, int port1, int feature)
440	{
441	return usb_control_msg(dev: hdev, usb_sndctrlpipe(hdev, 0),
442	USB_REQ_CLEAR_FEATURE, USB_RT_PORT, value: feature, index: port1,
443	NULL, size: 0, timeout: 1000);
444	}
445
446	/*
447	* USB 2.0 spec Section 11.24.2.13
448	*/
449	static int set_port_feature(struct usb_device *hdev, int port1, int feature)
450	{
451	return usb_control_msg(dev: hdev, usb_sndctrlpipe(hdev, 0),
452	USB_REQ_SET_FEATURE, USB_RT_PORT, value: feature, index: port1,
453	NULL, size: 0, timeout: 1000);
454	}
455
456	static char *to_led_name(int selector)
457	{
458	switch (selector) {
459	case HUB_LED_AMBER:
460	return "amber";
461	case HUB_LED_GREEN:
462	return "green";
463	case HUB_LED_OFF:
464	return "off";
465	case HUB_LED_AUTO:
466	return "auto";
467	default:
468	return "??";
469	}
470	}
471
472	/*
473	* USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
474	* for info about using port indicators
475	*/
476	static void set_port_led(struct usb_hub *hub, int port1, int selector)
477	{
478	struct usb_port *port_dev = hub->ports[port1 - 1];
479	int status;
480
481	status = set_port_feature(hdev: hub->hdev, port1: (selector << 8) | port1,
482	USB_PORT_FEAT_INDICATOR);
483	dev_dbg(&port_dev->dev, "indicator %s status %d\n",
484	to_led_name(selector), status);
485	}
486
487	#define LED_CYCLE_PERIOD ((2*HZ)/3)
488
489	static void led_work(struct work_struct *work)
490	{
491	struct usb_hub *hub =
492	container_of(work, struct usb_hub, leds.work);
493	struct usb_device *hdev = hub->hdev;
494	unsigned i;
495	unsigned changed = 0;
496	int cursor = -1;
497
498	if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
499	return;
500
501	for (i = 0; i < hdev->maxchild; i++) {
502	unsigned selector, mode;
503
504	/* 30%-50% duty cycle */
505
506	switch (hub->indicator[i]) {
507	/* cycle marker */
508	case INDICATOR_CYCLE:
509	cursor = i;
510	selector = HUB_LED_AUTO;
511	mode = INDICATOR_AUTO;
512	break;
513	/* blinking green = sw attention */
514	case INDICATOR_GREEN_BLINK:
515	selector = HUB_LED_GREEN;
516	mode = INDICATOR_GREEN_BLINK_OFF;
517	break;
518	case INDICATOR_GREEN_BLINK_OFF:
519	selector = HUB_LED_OFF;
520	mode = INDICATOR_GREEN_BLINK;
521	break;
522	/* blinking amber = hw attention */
523	case INDICATOR_AMBER_BLINK:
524	selector = HUB_LED_AMBER;
525	mode = INDICATOR_AMBER_BLINK_OFF;
526	break;
527	case INDICATOR_AMBER_BLINK_OFF:
528	selector = HUB_LED_OFF;
529	mode = INDICATOR_AMBER_BLINK;
530	break;
531	/* blink green/amber = reserved */
532	case INDICATOR_ALT_BLINK:
533	selector = HUB_LED_GREEN;
534	mode = INDICATOR_ALT_BLINK_OFF;
535	break;
536	case INDICATOR_ALT_BLINK_OFF:
537	selector = HUB_LED_AMBER;
538	mode = INDICATOR_ALT_BLINK;
539	break;
540	default:
541	continue;
542	}
543	if (selector != HUB_LED_AUTO)
544	changed = 1;
545	set_port_led(hub, port1: i + 1, selector);
546	hub->indicator[i] = mode;
547	}
548	if (!changed && blinkenlights) {
549	cursor++;
550	cursor %= hdev->maxchild;
551	set_port_led(hub, port1: cursor + 1, HUB_LED_GREEN);
552	hub->indicator[cursor] = INDICATOR_CYCLE;
553	changed++;
554	}
555	if (changed)
556	queue_delayed_work(wq: system_power_efficient_wq,
557	dwork: &hub->leds, LED_CYCLE_PERIOD);
558	}
559
560	/* use a short timeout for hub/port status fetches */
561	#define USB_STS_TIMEOUT 1000
562	#define USB_STS_RETRIES 5
563
564	/*
565	* USB 2.0 spec Section 11.24.2.6
566	*/
567	static int get_hub_status(struct usb_device *hdev,
568	struct usb_hub_status *data)
569	{
570	int i, status = -ETIMEDOUT;
571
572	for (i = 0; i < USB_STS_RETRIES &&
573	(status == -ETIMEDOUT || status == -EPIPE); i++) {
574	status = usb_control_msg(dev: hdev, usb_rcvctrlpipe(hdev, 0),
575	USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, value: 0, index: 0,
576	data, size: sizeof(*data), USB_STS_TIMEOUT);
577	}
578	return status;
579	}
580
581	/*
582	* USB 2.0 spec Section 11.24.2.7
583	* USB 3.1 takes into use the wValue and wLength fields, spec Section 10.16.2.6
584	*/
585	static int get_port_status(struct usb_device *hdev, int port1,
586	void *data, u16 value, u16 length)
587	{
588	int i, status = -ETIMEDOUT;
589
590	for (i = 0; i < USB_STS_RETRIES &&
591	(status == -ETIMEDOUT || status == -EPIPE); i++) {
592	status = usb_control_msg(dev: hdev, usb_rcvctrlpipe(hdev, 0),
593	USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, value,
594	index: port1, data, size: length, USB_STS_TIMEOUT);
595	}
596	return status;
597	}
598
599	static int hub_ext_port_status(struct usb_hub *hub, int port1, int type,
600	u16 *status, u16 *change, u32 *ext_status)
601	{
602	int ret;
603	int len = 4;
604
605	if (type != HUB_PORT_STATUS)
606	len = 8;
607
608	mutex_lock(&hub->status_mutex);
609	ret = get_port_status(hdev: hub->hdev, port1, data: &hub->status->port, value: type, length: len);
610	if (ret < len) {
611	if (ret != -ENODEV)
612	dev_err(hub->intfdev,
613	"%s failed (err = %d)\n", __func__, ret);
614	if (ret >= 0)
615	ret = -EIO;
616	} else {
617	*status = le16_to_cpu(hub->status->port.wPortStatus);
618	*change = le16_to_cpu(hub->status->port.wPortChange);
619	if (type != HUB_PORT_STATUS && ext_status)
620	*ext_status = le32_to_cpu(
621	hub->status->port.dwExtPortStatus);
622	ret = 0;
623	}
624	mutex_unlock(lock: &hub->status_mutex);
625
626	/*
627	* There is no need to lock status_mutex here, because status_mutex
628	* protects hub->status, and the phy driver only checks the port
629	* status without changing the status.
630	*/
631	if (!ret) {
632	struct usb_device *hdev = hub->hdev;
633
634	/*
635	* Only roothub will be notified of port state changes,
636	* since the USB PHY only cares about changes at the next
637	* level.
638	*/
639	if (is_root_hub(udev: hdev)) {
640	struct usb_hcd *hcd = bus_to_hcd(bus: hdev->bus);
641
642	if (hcd->usb_phy)
643	usb_phy_notify_port_status(x: hcd->usb_phy,
644	port: port1 - 1, portstatus: *status, portchange: *change);
645	}
646	}
647
648	return ret;
649	}
650
651	int usb_hub_port_status(struct usb_hub *hub, int port1,
652	u16 *status, u16 *change)
653	{
654	return hub_ext_port_status(hub, port1, HUB_PORT_STATUS,
655	status, change, NULL);
656	}
657
658	static void hub_resubmit_irq_urb(struct usb_hub *hub)
659	{
660	unsigned long flags;
661	int status;
662
663	spin_lock_irqsave(&hub->irq_urb_lock, flags);
664
665	if (hub->quiescing) {
666	spin_unlock_irqrestore(lock: &hub->irq_urb_lock, flags);
667	return;
668	}
669
670	status = usb_submit_urb(urb: hub->urb, GFP_ATOMIC);
671	if (status && status != -ENODEV && status != -EPERM &&
672	status != -ESHUTDOWN) {
673	dev_err(hub->intfdev, "resubmit --> %d\n", status);
674	mod_timer(timer: &hub->irq_urb_retry, expires: jiffies + HZ);
675	}
676
677	spin_unlock_irqrestore(lock: &hub->irq_urb_lock, flags);
678	}
679
680	static void hub_retry_irq_urb(struct timer_list *t)
681	{
682	struct usb_hub *hub = from_timer(hub, t, irq_urb_retry);
683
684	hub_resubmit_irq_urb(hub);
685	}
686
687
688	static void kick_hub_wq(struct usb_hub *hub)
689	{
690	struct usb_interface *intf;
691
692	if (hub->disconnected || work_pending(&hub->events))
693	return;
694
695	/*
696	* Suppress autosuspend until the event is proceed.
697	*
698	* Be careful and make sure that the symmetric operation is
699	* always called. We are here only when there is no pending
700	* work for this hub. Therefore put the interface either when
701	* the new work is called or when it is canceled.
702	*/
703	intf = to_usb_interface(hub->intfdev);
704	usb_autopm_get_interface_no_resume(intf);
705	kref_get(kref: &hub->kref);
706
707	if (queue_work(wq: hub_wq, work: &hub->events))
708	return;
709
710	/* the work has already been scheduled */
711	usb_autopm_put_interface_async(intf);
712	kref_put(kref: &hub->kref, release: hub_release);
713	}
714
715	void usb_kick_hub_wq(struct usb_device *hdev)
716	{
717	struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
718
719	if (hub)
720	kick_hub_wq(hub);
721	}
722
723	/*
724	* Let the USB core know that a USB 3.0 device has sent a Function Wake Device
725	* Notification, which indicates it had initiated remote wakeup.
726	*
727	* USB 3.0 hubs do not report the port link state change from U3 to U0 when the
728	* device initiates resume, so the USB core will not receive notice of the
729	* resume through the normal hub interrupt URB.
730	*/
731	void usb_wakeup_notification(struct usb_device *hdev,
732	unsigned int portnum)
733	{
734	struct usb_hub *hub;
735	struct usb_port *port_dev;
736
737	if (!hdev)
738	return;
739
740	hub = usb_hub_to_struct_hub(hdev);
741	if (hub) {
742	port_dev = hub->ports[portnum - 1];
743	if (port_dev && port_dev->child)
744	pm_wakeup_event(dev: &port_dev->child->dev, msec: 0);
745
746	set_bit(nr: portnum, addr: hub->wakeup_bits);
747	kick_hub_wq(hub);
748	}
749	}
750	EXPORT_SYMBOL_GPL(usb_wakeup_notification);
751
752	/* completion function, fires on port status changes and various faults */
753	static void hub_irq(struct urb *urb)
754	{
755	struct usb_hub *hub = urb->context;
756	int status = urb->status;
757	unsigned i;
758	unsigned long bits;
759
760	switch (status) {
761	case -ENOENT: /* synchronous unlink */
762	case -ECONNRESET: /* async unlink */
763	case -ESHUTDOWN: /* hardware going away */
764	return;
765
766	default: /* presumably an error */
767	/* Cause a hub reset after 10 consecutive errors */
768	dev_dbg(hub->intfdev, "transfer --> %d\n", status);
769	if ((++hub->nerrors < 10) || hub->error)
770	goto resubmit;
771	hub->error = status;
772	fallthrough;
773
774	/* let hub_wq handle things */
775	case 0: /* we got data: port status changed */
776	bits = 0;
777	for (i = 0; i < urb->actual_length; ++i)
778	bits |= ((unsigned long) ((*hub->buffer)[i]))
779	<< (i*8);
780	hub->event_bits[0] = bits;
781	break;
782	}
783
784	hub->nerrors = 0;
785
786	/* Something happened, let hub_wq figure it out */
787	kick_hub_wq(hub);
788
789	resubmit:
790	hub_resubmit_irq_urb(hub);
791	}
792
793	/* USB 2.0 spec Section 11.24.2.3 */
794	static inline int
795	hub_clear_tt_buffer(struct usb_device *hdev, u16 devinfo, u16 tt)
796	{
797	/* Need to clear both directions for control ep */
798	if (((devinfo >> 11) & USB_ENDPOINT_XFERTYPE_MASK) ==
799	USB_ENDPOINT_XFER_CONTROL) {
800	int status = usb_control_msg(dev: hdev, usb_sndctrlpipe(hdev, 0),
801	HUB_CLEAR_TT_BUFFER, USB_RT_PORT,
802	value: devinfo ^ 0x8000, index: tt, NULL, size: 0, timeout: 1000);
803	if (status)
804	return status;
805	}
806	return usb_control_msg(dev: hdev, usb_sndctrlpipe(hdev, 0),
807	HUB_CLEAR_TT_BUFFER, USB_RT_PORT, value: devinfo,
808	index: tt, NULL, size: 0, timeout: 1000);
809	}
810
811	/*
812	* enumeration blocks hub_wq for a long time. we use keventd instead, since
813	* long blocking there is the exception, not the rule. accordingly, HCDs
814	* talking to TTs must queue control transfers (not just bulk and iso), so
815	* both can talk to the same hub concurrently.
816	*/
817	static void hub_tt_work(struct work_struct *work)
818	{
819	struct usb_hub *hub =
820	container_of(work, struct usb_hub, tt.clear_work);
821	unsigned long flags;
822
823	spin_lock_irqsave(&hub->tt.lock, flags);
824	while (!list_empty(head: &hub->tt.clear_list)) {
825	struct list_head *next;
826	struct usb_tt_clear *clear;
827	struct usb_device *hdev = hub->hdev;
828	const struct hc_driver *drv;
829	int status;
830
831	next = hub->tt.clear_list.next;
832	clear = list_entry(next, struct usb_tt_clear, clear_list);
833	list_del(entry: &clear->clear_list);
834
835	/* drop lock so HCD can concurrently report other TT errors */
836	spin_unlock_irqrestore(lock: &hub->tt.lock, flags);
837	status = hub_clear_tt_buffer(hdev, devinfo: clear->devinfo, tt: clear->tt);
838	if (status && status != -ENODEV)
839	dev_err(&hdev->dev,
840	"clear tt %d (%04x) error %d\n",
841	clear->tt, clear->devinfo, status);
842
843	/* Tell the HCD, even if the operation failed */
844	drv = clear->hcd->driver;
845	if (drv->clear_tt_buffer_complete)
846	(drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
847
848	kfree(objp: clear);
849	spin_lock_irqsave(&hub->tt.lock, flags);
850	}
851	spin_unlock_irqrestore(lock: &hub->tt.lock, flags);
852	}
853
854	/**
855	* usb_hub_set_port_power - control hub port's power state
856	* @hdev: USB device belonging to the usb hub
857	* @hub: target hub
858	* @port1: port index
859	* @set: expected status
860	*
861	* call this function to control port's power via setting or
862	* clearing the port's PORT_POWER feature.
863	*
864	* Return: 0 if successful. A negative error code otherwise.
865	*/
866	int usb_hub_set_port_power(struct usb_device *hdev, struct usb_hub *hub,
867	int port1, bool set)
868	{
869	int ret;
870
871	if (set)
872	ret = set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
873	else
874	ret = usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
875
876	if (ret)
877	return ret;
878
879	if (set)
880	set_bit(nr: port1, addr: hub->power_bits);
881	else
882	clear_bit(nr: port1, addr: hub->power_bits);
883	return 0;
884	}
885
886	/**
887	* usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
888	* @urb: an URB associated with the failed or incomplete split transaction
889	*
890	* High speed HCDs use this to tell the hub driver that some split control or
891	* bulk transaction failed in a way that requires clearing internal state of
892	* a transaction translator. This is normally detected (and reported) from
893	* interrupt context.
894	*
895	* It may not be possible for that hub to handle additional full (or low)
896	* speed transactions until that state is fully cleared out.
897	*
898	* Return: 0 if successful. A negative error code otherwise.
899	*/
900	int usb_hub_clear_tt_buffer(struct urb *urb)
901	{
902	struct usb_device *udev = urb->dev;
903	int pipe = urb->pipe;
904	struct usb_tt *tt = udev->tt;
905	unsigned long flags;
906	struct usb_tt_clear *clear;
907
908	/* we've got to cope with an arbitrary number of pending TT clears,
909	* since each TT has "at least two" buffers that can need it (and
910	* there can be many TTs per hub). even if they're uncommon.
911	*/
912	clear = kmalloc(size: sizeof *clear, GFP_ATOMIC);
913	if (clear == NULL) {
914	dev_err(&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
915	/* FIXME recover somehow ... RESET_TT? */
916	return -ENOMEM;
917	}
918
919	/* info that CLEAR_TT_BUFFER needs */
920	clear->tt = tt->multi ? udev->ttport : 1;
921	clear->devinfo = usb_pipeendpoint (pipe);
922	clear->devinfo |= ((u16)udev->devaddr) << 4;
923	clear->devinfo |= usb_pipecontrol(pipe)
924	? (USB_ENDPOINT_XFER_CONTROL << 11)
925	: (USB_ENDPOINT_XFER_BULK << 11);
926	if (usb_pipein(pipe))
927	clear->devinfo |= 1 << 15;
928
929	/* info for completion callback */
930	clear->hcd = bus_to_hcd(bus: udev->bus);
931	clear->ep = urb->ep;
932
933	/* tell keventd to clear state for this TT */
934	spin_lock_irqsave(&tt->lock, flags);
935	list_add_tail(new: &clear->clear_list, head: &tt->clear_list);
936	schedule_work(work: &tt->clear_work);
937	spin_unlock_irqrestore(lock: &tt->lock, flags);
938	return 0;
939	}
940	EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
941
942	static void hub_power_on(struct usb_hub *hub, bool do_delay)
943	{
944	int port1;
945
946	/* Enable power on each port. Some hubs have reserved values
947	* of LPSM (> 2) in their descriptors, even though they are
948	* USB 2.0 hubs. Some hubs do not implement port-power switching
949	* but only emulate it. In all cases, the ports won't work
950	* unless we send these messages to the hub.
951	*/
952	if (hub_is_port_power_switchable(hub))
953	dev_dbg(hub->intfdev, "enabling power on all ports\n");
954	else
955	dev_dbg(hub->intfdev, "trying to enable port power on "
956	"non-switchable hub\n");
957	for (port1 = 1; port1 <= hub->hdev->maxchild; port1++)
958	if (test_bit(port1, hub->power_bits))
959	set_port_feature(hdev: hub->hdev, port1, USB_PORT_FEAT_POWER);
960	else
961	usb_clear_port_feature(hdev: hub->hdev, port1,
962	USB_PORT_FEAT_POWER);
963	if (do_delay)
964	msleep(msecs: hub_power_on_good_delay(hub));
965	}
966
967	static int hub_hub_status(struct usb_hub *hub,
968	u16 *status, u16 *change)
969	{
970	int ret;
971
972	mutex_lock(&hub->status_mutex);
973	ret = get_hub_status(hdev: hub->hdev, data: &hub->status->hub);
974	if (ret < 0) {
975	if (ret != -ENODEV)
976	dev_err(hub->intfdev,
977	"%s failed (err = %d)\n", __func__, ret);
978	} else {
979	*status = le16_to_cpu(hub->status->hub.wHubStatus);
980	*change = le16_to_cpu(hub->status->hub.wHubChange);
981	ret = 0;
982	}
983	mutex_unlock(lock: &hub->status_mutex);
984	return ret;
985	}
986
987	static int hub_set_port_link_state(struct usb_hub *hub, int port1,
988	unsigned int link_status)
989	{
990	return set_port_feature(hdev: hub->hdev,
991	port1: port1 | (link_status << 3),
992	USB_PORT_FEAT_LINK_STATE);
993	}
994
995	/*
996	* Disable a port and mark a logical connect-change event, so that some
997	* time later hub_wq will disconnect() any existing usb_device on the port
998	* and will re-enumerate if there actually is a device attached.
999	*/
1000	static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
1001	{
1002	dev_dbg(&hub->ports[port1 - 1]->dev, "logical disconnect\n");
1003	hub_port_disable(hub, port1, set_state: 1);
1004
1005	/* FIXME let caller ask to power down the port:
1006	* - some devices won't enumerate without a VBUS power cycle
1007	* - SRP saves power that way
1008	* - ... new call, TBD ...
1009	* That's easy if this hub can switch power per-port, and
1010	* hub_wq reactivates the port later (timer, SRP, etc).
1011	* Powerdown must be optional, because of reset/DFU.
1012	*/
1013
1014	set_bit(nr: port1, addr: hub->change_bits);
1015	kick_hub_wq(hub);
1016	}
1017
1018	/**
1019	* usb_remove_device - disable a device's port on its parent hub
1020	* @udev: device to be disabled and removed
1021	* Context: @udev locked, must be able to sleep.
1022	*
1023	* After @udev's port has been disabled, hub_wq is notified and it will
1024	* see that the device has been disconnected. When the device is
1025	* physically unplugged and something is plugged in, the events will
1026	* be received and processed normally.
1027	*
1028	* Return: 0 if successful. A negative error code otherwise.
1029	*/
1030	int usb_remove_device(struct usb_device *udev)
1031	{
1032	struct usb_hub *hub;
1033	struct usb_interface *intf;
1034	int ret;
1035
1036	if (!udev->parent) /* Can't remove a root hub */
1037	return -EINVAL;
1038	hub = usb_hub_to_struct_hub(hdev: udev->parent);
1039	intf = to_usb_interface(hub->intfdev);
1040
1041	ret = usb_autopm_get_interface(intf);
1042	if (ret < 0)
1043	return ret;
1044
1045	set_bit(nr: udev->portnum, addr: hub->removed_bits);
1046	hub_port_logical_disconnect(hub, port1: udev->portnum);
1047	usb_autopm_put_interface(intf);
1048	return 0;
1049	}
1050
1051	enum hub_activation_type {
1052	HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
1053	HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
1054	};
1055
1056	static void hub_init_func2(struct work_struct *ws);
1057	static void hub_init_func3(struct work_struct *ws);
1058
1059	static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
1060	{
1061	struct usb_device *hdev = hub->hdev;
1062	struct usb_hcd *hcd;
1063	int ret;
1064	int port1;
1065	int status;
1066	bool need_debounce_delay = false;
1067	unsigned delay;
1068
1069	/* Continue a partial initialization */
1070	if (type == HUB_INIT2 || type == HUB_INIT3) {
1071	device_lock(dev: &hdev->dev);
1072
1073	/* Was the hub disconnected while we were waiting? */
1074	if (hub->disconnected)
1075	goto disconnected;
1076	if (type == HUB_INIT2)
1077	goto init2;
1078	goto init3;
1079	}
1080	kref_get(kref: &hub->kref);
1081
1082	/* The superspeed hub except for root hub has to use Hub Depth
1083	* value as an offset into the route string to locate the bits
1084	* it uses to determine the downstream port number. So hub driver
1085	* should send a set hub depth request to superspeed hub after
1086	* the superspeed hub is set configuration in initialization or
1087	* reset procedure.
1088	*
1089	* After a resume, port power should still be on.
1090	* For any other type of activation, turn it on.
1091	*/
1092	if (type != HUB_RESUME) {
1093	if (hdev->parent && hub_is_superspeed(hdev)) {
1094	ret = usb_control_msg(dev: hdev, usb_sndctrlpipe(hdev, 0),
1095	HUB_SET_DEPTH, USB_RT_HUB,
1096	value: hdev->level - 1, index: 0, NULL, size: 0,
1097	USB_CTRL_SET_TIMEOUT);
1098	if (ret < 0)
1099	dev_err(hub->intfdev,
1100	"set hub depth failed\n");
1101	}
1102
1103	/* Speed up system boot by using a delayed_work for the
1104	* hub's initial power-up delays. This is pretty awkward
1105	* and the implementation looks like a home-brewed sort of
1106	* setjmp/longjmp, but it saves at least 100 ms for each
1107	* root hub (assuming usbcore is compiled into the kernel
1108	* rather than as a module). It adds up.
1109	*
1110	* This can't be done for HUB_RESUME or HUB_RESET_RESUME
1111	* because for those activation types the ports have to be
1112	* operational when we return. In theory this could be done
1113	* for HUB_POST_RESET, but it's easier not to.
1114	*/
1115	if (type == HUB_INIT) {
1116	delay = hub_power_on_good_delay(hub);
1117
1118	hub_power_on(hub, do_delay: false);
1119	INIT_DELAYED_WORK(&hub->init_work, hub_init_func2);
1120	queue_delayed_work(wq: system_power_efficient_wq,
1121	dwork: &hub->init_work,
1122	delay: msecs_to_jiffies(m: delay));
1123
1124	/* Suppress autosuspend until init is done */
1125	usb_autopm_get_interface_no_resume(
1126	to_usb_interface(hub->intfdev));
1127	return; /* Continues at init2: below */
1128	} else if (type == HUB_RESET_RESUME) {
1129	/* The internal host controller state for the hub device
1130	* may be gone after a host power loss on system resume.
1131	* Update the device's info so the HW knows it's a hub.
1132	*/
1133	hcd = bus_to_hcd(bus: hdev->bus);
1134	if (hcd->driver->update_hub_device) {
1135	ret = hcd->driver->update_hub_device(hcd, hdev,
1136	&hub->tt, GFP_NOIO);
1137	if (ret < 0) {
1138	dev_err(hub->intfdev,
1139	"Host not accepting hub info update\n");
1140	dev_err(hub->intfdev,
1141	"LS/FS devices and hubs may not work under this hub\n");
1142	}
1143	}
1144	hub_power_on(hub, do_delay: true);
1145	} else {
1146	hub_power_on(hub, do_delay: true);
1147	}
1148	/* Give some time on remote wakeup to let links to transit to U0 */
1149	} else if (hub_is_superspeed(hdev: hub->hdev))
1150	msleep(msecs: 20);
1151
1152	init2:
1153
1154	/*
1155	* Check each port and set hub->change_bits to let hub_wq know
1156	* which ports need attention.
1157	*/
1158	for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
1159	struct usb_port *port_dev = hub->ports[port1 - 1];
1160	struct usb_device *udev = port_dev->child;
1161	u16 portstatus, portchange;
1162
1163	portstatus = portchange = 0;
1164	status = usb_hub_port_status(hub, port1, status: &portstatus, change: &portchange);
1165	if (status)
1166	goto abort;
1167
1168	if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1169	dev_dbg(&port_dev->dev, "status %04x change %04x\n",
1170	portstatus, portchange);
1171
1172	/*
1173	* After anything other than HUB_RESUME (i.e., initialization
1174	* or any sort of reset), every port should be disabled.
1175	* Unconnected ports should likewise be disabled (paranoia),
1176	* and so should ports for which we have no usb_device.
1177	*/
1178	if ((portstatus & USB_PORT_STAT_ENABLE) && (
1179	type != HUB_RESUME ||
1180	!(portstatus & USB_PORT_STAT_CONNECTION) ||
1181	!udev ||
1182	udev->state == USB_STATE_NOTATTACHED)) {
1183	/*
1184	* USB3 protocol ports will automatically transition
1185	* to Enabled state when detect an USB3.0 device attach.
1186	* Do not disable USB3 protocol ports, just pretend
1187	* power was lost
1188	*/
1189	portstatus &= ~USB_PORT_STAT_ENABLE;
1190	if (!hub_is_superspeed(hdev))
1191	usb_clear_port_feature(hdev, port1,
1192	USB_PORT_FEAT_ENABLE);
1193	}
1194
1195	/* Make sure a warm-reset request is handled by port_event */
1196	if (type == HUB_RESUME &&
1197	hub_port_warm_reset_required(hub, port1, portstatus))
1198	set_bit(nr: port1, addr: hub->event_bits);
1199
1200	/*
1201	* Add debounce if USB3 link is in polling/link training state.
1202	* Link will automatically transition to Enabled state after
1203	* link training completes.
1204	*/
1205	if (hub_is_superspeed(hdev) &&
1206	((portstatus & USB_PORT_STAT_LINK_STATE) ==
1207	USB_SS_PORT_LS_POLLING))
1208	need_debounce_delay = true;
1209
1210	/* Clear status-change flags; we'll debounce later */
1211	if (portchange & USB_PORT_STAT_C_CONNECTION) {
1212	need_debounce_delay = true;
1213	usb_clear_port_feature(hdev: hub->hdev, port1,
1214	USB_PORT_FEAT_C_CONNECTION);
1215	}
1216	if (portchange & USB_PORT_STAT_C_ENABLE) {
1217	need_debounce_delay = true;
1218	usb_clear_port_feature(hdev: hub->hdev, port1,
1219	USB_PORT_FEAT_C_ENABLE);
1220	}
1221	if (portchange & USB_PORT_STAT_C_RESET) {
1222	need_debounce_delay = true;
1223	usb_clear_port_feature(hdev: hub->hdev, port1,
1224	USB_PORT_FEAT_C_RESET);
1225	}
1226	if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
1227	hub_is_superspeed(hdev: hub->hdev)) {
1228	need_debounce_delay = true;
1229	usb_clear_port_feature(hdev: hub->hdev, port1,
1230	USB_PORT_FEAT_C_BH_PORT_RESET);
1231	}
1232	/* We can forget about a "removed" device when there's a
1233	* physical disconnect or the connect status changes.
1234	*/
1235	if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
1236	(portchange & USB_PORT_STAT_C_CONNECTION))
1237	clear_bit(nr: port1, addr: hub->removed_bits);
1238
1239	if (!udev || udev->state == USB_STATE_NOTATTACHED) {
1240	/* Tell hub_wq to disconnect the device or
1241	* check for a new connection or over current condition.
1242	* Based on USB2.0 Spec Section 11.12.5,
1243	* C_PORT_OVER_CURRENT could be set while
1244	* PORT_OVER_CURRENT is not. So check for any of them.
1245	*/
1246	if (udev || (portstatus & USB_PORT_STAT_CONNECTION) ||
1247	(portchange & USB_PORT_STAT_C_CONNECTION) ||
1248	(portstatus & USB_PORT_STAT_OVERCURRENT) ||
1249	(portchange & USB_PORT_STAT_C_OVERCURRENT))
1250	set_bit(nr: port1, addr: hub->change_bits);
1251
1252	} else if (portstatus & USB_PORT_STAT_ENABLE) {
1253	bool port_resumed = (portstatus &
1254	USB_PORT_STAT_LINK_STATE) ==
1255	USB_SS_PORT_LS_U0;
1256	/* The power session apparently survived the resume.
1257	* If there was an overcurrent or suspend change
1258	* (i.e., remote wakeup request), have hub_wq
1259	* take care of it. Look at the port link state
1260	* for USB 3.0 hubs, since they don't have a suspend
1261	* change bit, and they don't set the port link change
1262	* bit on device-initiated resume.
1263	*/
1264	if (portchange || (hub_is_superspeed(hdev: hub->hdev) &&
1265	port_resumed))
1266	set_bit(nr: port1, addr: hub->event_bits);
1267
1268	} else if (udev->persist_enabled) {
1269	#ifdef CONFIG_PM
1270	udev->reset_resume = 1;
1271	#endif
1272	/* Don't set the change_bits when the device
1273	* was powered off.
1274	*/
1275	if (test_bit(port1, hub->power_bits))
1276	set_bit(nr: port1, addr: hub->change_bits);
1277
1278	} else {
1279	/* The power session is gone; tell hub_wq */
1280	usb_set_device_state(udev, new_state: USB_STATE_NOTATTACHED);
1281	set_bit(nr: port1, addr: hub->change_bits);
1282	}
1283	}
1284
1285	/* If no port-status-change flags were set, we don't need any
1286	* debouncing. If flags were set we can try to debounce the
1287	* ports all at once right now, instead of letting hub_wq do them
1288	* one at a time later on.
1289	*
1290	* If any port-status changes do occur during this delay, hub_wq
1291	* will see them later and handle them normally.
1292	*/
1293	if (need_debounce_delay) {
1294	delay = HUB_DEBOUNCE_STABLE;
1295
1296	/* Don't do a long sleep inside a workqueue routine */
1297	if (type == HUB_INIT2) {
1298	INIT_DELAYED_WORK(&hub->init_work, hub_init_func3);
1299	queue_delayed_work(wq: system_power_efficient_wq,
1300	dwork: &hub->init_work,
1301	delay: msecs_to_jiffies(m: delay));
1302	device_unlock(dev: &hdev->dev);
1303	return; /* Continues at init3: below */
1304	} else {
1305	msleep(msecs: delay);
1306	}
1307	}
1308	init3:
1309	hub->quiescing = 0;
1310
1311	status = usb_submit_urb(urb: hub->urb, GFP_NOIO);
1312	if (status < 0)
1313	dev_err(hub->intfdev, "activate --> %d\n", status);
1314	if (hub->has_indicators && blinkenlights)
1315	queue_delayed_work(wq: system_power_efficient_wq,
1316	dwork: &hub->leds, LED_CYCLE_PERIOD);
1317
1318	/* Scan all ports that need attention */
1319	kick_hub_wq(hub);
1320	abort:
1321	if (type == HUB_INIT2 || type == HUB_INIT3) {
1322	/* Allow autosuspend if it was suppressed */
1323	disconnected:
1324	usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
1325	device_unlock(dev: &hdev->dev);
1326	}
1327
1328	kref_put(kref: &hub->kref, release: hub_release);
1329	}
1330
1331	/* Implement the continuations for the delays above */
1332	static void hub_init_func2(struct work_struct *ws)
1333	{
1334	struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1335
1336	hub_activate(hub, type: HUB_INIT2);
1337	}
1338
1339	static void hub_init_func3(struct work_struct *ws)
1340	{
1341	struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1342
1343	hub_activate(hub, type: HUB_INIT3);
1344	}
1345
1346	enum hub_quiescing_type {
1347	HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
1348	};
1349
1350	static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
1351	{
1352	struct usb_device *hdev = hub->hdev;
1353	unsigned long flags;
1354	int i;
1355
1356	/* hub_wq and related activity won't re-trigger */
1357	spin_lock_irqsave(&hub->irq_urb_lock, flags);
1358	hub->quiescing = 1;
1359	spin_unlock_irqrestore(lock: &hub->irq_urb_lock, flags);
1360
1361	if (type != HUB_SUSPEND) {
1362	/* Disconnect all the children */
1363	for (i = 0; i < hdev->maxchild; ++i) {
1364	if (hub->ports[i]->child)
1365	usb_disconnect(&hub->ports[i]->child);
1366	}
1367	}
1368
1369	/* Stop hub_wq and related activity */
1370	del_timer_sync(timer: &hub->irq_urb_retry);
1371	usb_kill_urb(urb: hub->urb);
1372	if (hub->has_indicators)
1373	cancel_delayed_work_sync(dwork: &hub->leds);
1374	if (hub->tt.hub)
1375	flush_work(work: &hub->tt.clear_work);
1376	}
1377
1378	static void hub_pm_barrier_for_all_ports(struct usb_hub *hub)
1379	{
1380	int i;
1381
1382	for (i = 0; i < hub->hdev->maxchild; ++i)
1383	pm_runtime_barrier(dev: &hub->ports[i]->dev);
1384	}
1385
1386	/* caller has locked the hub device */
1387	static int hub_pre_reset(struct usb_interface *intf)
1388	{
1389	struct usb_hub *hub = usb_get_intfdata(intf);
1390
1391	hub_quiesce(hub, type: HUB_PRE_RESET);
1392	hub->in_reset = 1;
1393	hub_pm_barrier_for_all_ports(hub);
1394	return 0;
1395	}
1396
1397	/* caller has locked the hub device */
1398	static int hub_post_reset(struct usb_interface *intf)
1399	{
1400	struct usb_hub *hub = usb_get_intfdata(intf);
1401
1402	hub->in_reset = 0;
1403	hub_pm_barrier_for_all_ports(hub);
1404	hub_activate(hub, type: HUB_POST_RESET);
1405	return 0;
1406	}
1407
1408	static int hub_configure(struct usb_hub *hub,
1409	struct usb_endpoint_descriptor *endpoint)
1410	{
1411	struct usb_hcd *hcd;
1412	struct usb_device *hdev = hub->hdev;
1413	struct device *hub_dev = hub->intfdev;
1414	u16 hubstatus, hubchange;
1415	u16 wHubCharacteristics;
1416	unsigned int pipe;
1417	int maxp, ret, i;
1418	char *message = "out of memory";
1419	unsigned unit_load;
1420	unsigned full_load;
1421	unsigned maxchild;
1422
1423	hub->buffer = kmalloc(size: sizeof(*hub->buffer), GFP_KERNEL);
1424	if (!hub->buffer) {
1425	ret = -ENOMEM;
1426	goto fail;
1427	}
1428
1429	hub->status = kmalloc(size: sizeof(*hub->status), GFP_KERNEL);
1430	if (!hub->status) {
1431	ret = -ENOMEM;
1432	goto fail;
1433	}
1434	mutex_init(&hub->status_mutex);
1435
1436	hub->descriptor = kzalloc(size: sizeof(*hub->descriptor), GFP_KERNEL);
1437	if (!hub->descriptor) {
1438	ret = -ENOMEM;
1439	goto fail;
1440	}
1441
1442	/* Request the entire hub descriptor.
1443	* hub->descriptor can handle USB_MAXCHILDREN ports,
1444	* but a (non-SS) hub can/will return fewer bytes here.
1445	*/
1446	ret = get_hub_descriptor(hdev, desc: hub->descriptor);
1447	if (ret < 0) {
1448	message = "can't read hub descriptor";
1449	goto fail;
1450	}
1451
1452	maxchild = USB_MAXCHILDREN;
1453	if (hub_is_superspeed(hdev))
1454	maxchild = min_t(unsigned, maxchild, USB_SS_MAXPORTS);
1455
1456	if (hub->descriptor->bNbrPorts > maxchild) {
1457	message = "hub has too many ports!";
1458	ret = -ENODEV;
1459	goto fail;
1460	} else if (hub->descriptor->bNbrPorts == 0) {
1461	message = "hub doesn't have any ports!";
1462	ret = -ENODEV;
1463	goto fail;
1464	}
1465
1466	/*
1467	* Accumulate wHubDelay + 40ns for every hub in the tree of devices.
1468	* The resulting value will be used for SetIsochDelay() request.
1469	*/
1470	if (hub_is_superspeed(hdev) || hub_is_superspeedplus(hdev)) {
1471	u32 delay = __le16_to_cpu(hub->descriptor->u.ss.wHubDelay);
1472
1473	if (hdev->parent)
1474	delay += hdev->parent->hub_delay;
1475
1476	delay += USB_TP_TRANSMISSION_DELAY;
1477	hdev->hub_delay = min_t(u32, delay, USB_TP_TRANSMISSION_DELAY_MAX);
1478	}
1479
1480	maxchild = hub->descriptor->bNbrPorts;
1481	dev_info(hub_dev, "%d port%s detected\n", maxchild,
1482	(maxchild == 1) ? "" : "s");
1483
1484	hub->ports = kcalloc(n: maxchild, size: sizeof(struct usb_port *), GFP_KERNEL);
1485	if (!hub->ports) {
1486	ret = -ENOMEM;
1487	goto fail;
1488	}
1489
1490	wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1491	if (hub_is_superspeed(hdev)) {
1492	unit_load = 150;
1493	full_load = 900;
1494	} else {
1495	unit_load = 100;
1496	full_load = 500;
1497	}
1498
1499	/* FIXME for USB 3.0, skip for now */
1500	if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1501	!(hub_is_superspeed(hdev))) {
1502	char portstr[USB_MAXCHILDREN + 1];
1503
1504	for (i = 0; i < maxchild; i++)
1505	portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1506	[((i + 1) / 8)] & (1 << ((i + 1) % 8))
1507	? 'F' : 'R';
1508	portstr[maxchild] = 0;
1509	dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1510	} else
1511	dev_dbg(hub_dev, "standalone hub\n");
1512
1513	switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1514	case HUB_CHAR_COMMON_LPSM:
1515	dev_dbg(hub_dev, "ganged power switching\n");
1516	break;
1517	case HUB_CHAR_INDV_PORT_LPSM:
1518	dev_dbg(hub_dev, "individual port power switching\n");
1519	break;
1520	case HUB_CHAR_NO_LPSM:
1521	case HUB_CHAR_LPSM:
1522	dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1523	break;
1524	}
1525
1526	switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1527	case HUB_CHAR_COMMON_OCPM:
1528	dev_dbg(hub_dev, "global over-current protection\n");
1529	break;
1530	case HUB_CHAR_INDV_PORT_OCPM:
1531	dev_dbg(hub_dev, "individual port over-current protection\n");
1532	break;
1533	case HUB_CHAR_NO_OCPM:
1534	case HUB_CHAR_OCPM:
1535	dev_dbg(hub_dev, "no over-current protection\n");
1536	break;
1537	}
1538
1539	spin_lock_init(&hub->tt.lock);
1540	INIT_LIST_HEAD(list: &hub->tt.clear_list);
1541	INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1542	switch (hdev->descriptor.bDeviceProtocol) {
1543	case USB_HUB_PR_FS:
1544	break;
1545	case USB_HUB_PR_HS_SINGLE_TT:
1546	dev_dbg(hub_dev, "Single TT\n");
1547	hub->tt.hub = hdev;
1548	break;
1549	case USB_HUB_PR_HS_MULTI_TT:
1550	ret = usb_set_interface(dev: hdev, ifnum: 0, alternate: 1);
1551	if (ret == 0) {
1552	dev_dbg(hub_dev, "TT per port\n");
1553	hub->tt.multi = 1;
1554	} else
1555	dev_err(hub_dev, "Using single TT (err %d)\n",
1556	ret);
1557	hub->tt.hub = hdev;
1558	break;
1559	case USB_HUB_PR_SS:
1560	/* USB 3.0 hubs don't have a TT */
1561	break;
1562	default:
1563	dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1564	hdev->descriptor.bDeviceProtocol);
1565	break;
1566	}
1567
1568	/* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1569	switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1570	case HUB_TTTT_8_BITS:
1571	if (hdev->descriptor.bDeviceProtocol != 0) {
1572	hub->tt.think_time = 666;
1573	dev_dbg(hub_dev, "TT requires at most %d "
1574	"FS bit times (%d ns)\n",
1575	8, hub->tt.think_time);
1576	}
1577	break;
1578	case HUB_TTTT_16_BITS:
1579	hub->tt.think_time = 666 * 2;
1580	dev_dbg(hub_dev, "TT requires at most %d "
1581	"FS bit times (%d ns)\n",
1582	16, hub->tt.think_time);
1583	break;
1584	case HUB_TTTT_24_BITS:
1585	hub->tt.think_time = 666 * 3;
1586	dev_dbg(hub_dev, "TT requires at most %d "
1587	"FS bit times (%d ns)\n",
1588	24, hub->tt.think_time);
1589	break;
1590	case HUB_TTTT_32_BITS:
1591	hub->tt.think_time = 666 * 4;
1592	dev_dbg(hub_dev, "TT requires at most %d "
1593	"FS bit times (%d ns)\n",
1594	32, hub->tt.think_time);
1595	break;
1596	}
1597
1598	/* probe() zeroes hub->indicator[] */
1599	if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1600	hub->has_indicators = 1;
1601	dev_dbg(hub_dev, "Port indicators are supported\n");
1602	}
1603
1604	dev_dbg(hub_dev, "power on to power good time: %dms\n",
1605	hub->descriptor->bPwrOn2PwrGood * 2);
1606
1607	/* power budgeting mostly matters with bus-powered hubs,
1608	* and battery-powered root hubs (may provide just 8 mA).
1609	*/
1610	ret = usb_get_std_status(dev: hdev, USB_RECIP_DEVICE, target: 0, data: &hubstatus);
1611	if (ret) {
1612	message = "can't get hub status";
1613	goto fail;
1614	}
1615	hcd = bus_to_hcd(bus: hdev->bus);
1616	if (hdev == hdev->bus->root_hub) {
1617	if (hcd->power_budget > 0)
1618	hdev->bus_mA = hcd->power_budget;
1619	else
1620	hdev->bus_mA = full_load * maxchild;
1621	if (hdev->bus_mA >= full_load)
1622	hub->mA_per_port = full_load;
1623	else {
1624	hub->mA_per_port = hdev->bus_mA;
1625	hub->limited_power = 1;
1626	}
1627	} else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1628	int remaining = hdev->bus_mA -
1629	hub->descriptor->bHubContrCurrent;
1630
1631	dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1632	hub->descriptor->bHubContrCurrent);
1633	hub->limited_power = 1;
1634
1635	if (remaining < maxchild * unit_load)
1636	dev_warn(hub_dev,
1637	"insufficient power available "
1638	"to use all downstream ports\n");
1639	hub->mA_per_port = unit_load; /* 7.2.1 */
1640
1641	} else { /* Self-powered external hub */
1642	/* FIXME: What about battery-powered external hubs that
1643	* provide less current per port? */
1644	hub->mA_per_port = full_load;
1645	}
1646	if (hub->mA_per_port < full_load)
1647	dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1648	hub->mA_per_port);
1649
1650	ret = hub_hub_status(hub, status: &hubstatus, change: &hubchange);
1651	if (ret < 0) {
1652	message = "can't get hub status";
1653	goto fail;
1654	}
1655
1656	/* local power status reports aren't always correct */
1657	if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1658	dev_dbg(hub_dev, "local power source is %s\n",
1659	(hubstatus & HUB_STATUS_LOCAL_POWER)
1660	? "lost (inactive)" : "good");
1661
1662	if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1663	dev_dbg(hub_dev, "%sover-current condition exists\n",
1664	(hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1665
1666	/* set up the interrupt endpoint
1667	* We use the EP's maxpacket size instead of (PORTS+1+7)/8
1668	* bytes as USB2.0[11.12.3] says because some hubs are known
1669	* to send more data (and thus cause overflow). For root hubs,
1670	* maxpktsize is defined in hcd.c's fake endpoint descriptors
1671	* to be big enough for at least USB_MAXCHILDREN ports. */
1672	pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1673	maxp = usb_maxpacket(udev: hdev, pipe);
1674
1675	if (maxp > sizeof(*hub->buffer))
1676	maxp = sizeof(*hub->buffer);
1677
1678	hub->urb = usb_alloc_urb(iso_packets: 0, GFP_KERNEL);
1679	if (!hub->urb) {
1680	ret = -ENOMEM;
1681	goto fail;
1682	}
1683
1684	usb_fill_int_urb(urb: hub->urb, dev: hdev, pipe, transfer_buffer: *hub->buffer, buffer_length: maxp, complete_fn: hub_irq,
1685	context: hub, interval: endpoint->bInterval);
1686
1687	/* maybe cycle the hub leds */
1688	if (hub->has_indicators && blinkenlights)
1689	hub->indicator[0] = INDICATOR_CYCLE;
1690
1691	mutex_lock(&usb_port_peer_mutex);
1692	for (i = 0; i < maxchild; i++) {
1693	ret = usb_hub_create_port_device(hub, port1: i + 1);
1694	if (ret < 0) {
1695	dev_err(hub->intfdev,
1696	"couldn't create port%d device.\n", i + 1);
1697	break;
1698	}
1699	}
1700	hdev->maxchild = i;
1701	for (i = 0; i < hdev->maxchild; i++) {
1702	struct usb_port *port_dev = hub->ports[i];
1703
1704	pm_runtime_put(dev: &port_dev->dev);
1705	}
1706
1707	mutex_unlock(lock: &usb_port_peer_mutex);
1708	if (ret < 0)
1709	goto fail;
1710
1711	/* Update the HCD's internal representation of this hub before hub_wq
1712	* starts getting port status changes for devices under the hub.
1713	*/
1714	if (hcd->driver->update_hub_device) {
1715	ret = hcd->driver->update_hub_device(hcd, hdev,
1716	&hub->tt, GFP_KERNEL);
1717	if (ret < 0) {
1718	message = "can't update HCD hub info";
1719	goto fail;
1720	}
1721	}
1722
1723	usb_hub_adjust_deviceremovable(hdev, desc: hub->descriptor);
1724
1725	hub_activate(hub, type: HUB_INIT);
1726	return 0;
1727
1728	fail:
1729	dev_err(hub_dev, "config failed, %s (err %d)\n",
1730	message, ret);
1731	/* hub_disconnect() frees urb and descriptor */
1732	return ret;
1733	}
1734
1735	static void hub_release(struct kref *kref)
1736	{
1737	struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1738
1739	usb_put_dev(dev: hub->hdev);
1740	usb_put_intf(to_usb_interface(hub->intfdev));
1741	kfree(objp: hub);
1742	}
1743
1744	static unsigned highspeed_hubs;
1745
1746	static void hub_disconnect(struct usb_interface *intf)
1747	{
1748	struct usb_hub *hub = usb_get_intfdata(intf);
1749	struct usb_device *hdev = interface_to_usbdev(intf);
1750	int port1;
1751
1752	/*
1753	* Stop adding new hub events. We do not want to block here and thus
1754	* will not try to remove any pending work item.
1755	*/
1756	hub->disconnected = 1;
1757
1758	/* Disconnect all children and quiesce the hub */
1759	hub->error = 0;
1760	hub_quiesce(hub, type: HUB_DISCONNECT);
1761
1762	mutex_lock(&usb_port_peer_mutex);
1763
1764	/* Avoid races with recursively_mark_NOTATTACHED() */
1765	spin_lock_irq(lock: &device_state_lock);
1766	port1 = hdev->maxchild;
1767	hdev->maxchild = 0;
1768	usb_set_intfdata(intf, NULL);
1769	spin_unlock_irq(lock: &device_state_lock);
1770
1771	for (; port1 > 0; --port1)
1772	usb_hub_remove_port_device(hub, port1);
1773
1774	mutex_unlock(lock: &usb_port_peer_mutex);
1775
1776	if (hub->hdev->speed == USB_SPEED_HIGH)
1777	highspeed_hubs--;
1778
1779	usb_free_urb(urb: hub->urb);
1780	kfree(objp: hub->ports);
1781	kfree(objp: hub->descriptor);
1782	kfree(objp: hub->status);
1783	kfree(objp: hub->buffer);
1784
1785	pm_suspend_ignore_children(dev: &intf->dev, enable: false);
1786
1787	if (hub->quirk_disable_autosuspend)
1788	usb_autopm_put_interface(intf);
1789
1790	onboard_hub_destroy_pdevs(pdev_list: &hub->onboard_hub_devs);
1791
1792	kref_put(kref: &hub->kref, release: hub_release);
1793	}
1794
1795	static bool hub_descriptor_is_sane(struct usb_host_interface *desc)
1796	{
1797	/* Some hubs have a subclass of 1, which AFAICT according to the */
1798	/* specs is not defined, but it works */
1799	if (desc->desc.bInterfaceSubClass != 0 &&
1800	desc->desc.bInterfaceSubClass != 1)
1801	return false;
1802
1803	/* Multiple endpoints? What kind of mutant ninja-hub is this? */
1804	if (desc->desc.bNumEndpoints != 1)
1805	return false;
1806
1807	/* If the first endpoint is not interrupt IN, we'd better punt! */
1808	if (!usb_endpoint_is_int_in(epd: &desc->endpoint[0].desc))
1809	return false;
1810
1811	return true;
1812	}
1813
1814	static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1815	{
1816	struct usb_host_interface *desc;
1817	struct usb_device *hdev;
1818	struct usb_hub *hub;
1819
1820	desc = intf->cur_altsetting;
1821	hdev = interface_to_usbdev(intf);
1822
1823	/*
1824	* Set default autosuspend delay as 0 to speedup bus suspend,
1825	* based on the below considerations:
1826	*
1827	* - Unlike other drivers, the hub driver does not rely on the
1828	* autosuspend delay to provide enough time to handle a wakeup
1829	* event, and the submitted status URB is just to check future
1830	* change on hub downstream ports, so it is safe to do it.
1831	*
1832	* - The patch might cause one or more auto supend/resume for
1833	* below very rare devices when they are plugged into hub
1834	* first time:
1835	*
1836	* devices having trouble initializing, and disconnect
1837	* themselves from the bus and then reconnect a second
1838	* or so later
1839	*
1840	* devices just for downloading firmware, and disconnects
1841	* themselves after completing it
1842	*
1843	* For these quite rare devices, their drivers may change the
1844	* autosuspend delay of their parent hub in the probe() to one
1845	* appropriate value to avoid the subtle problem if someone
1846	* does care it.
1847	*
1848	* - The patch may cause one or more auto suspend/resume on
1849	* hub during running 'lsusb', but it is probably too
1850	* infrequent to worry about.
1851	*
1852	* - Change autosuspend delay of hub can avoid unnecessary auto
1853	* suspend timer for hub, also may decrease power consumption
1854	* of USB bus.
1855	*
1856	* - If user has indicated to prevent autosuspend by passing
1857	* usbcore.autosuspend = -1 then keep autosuspend disabled.
1858	*/
1859	#ifdef CONFIG_PM
1860	if (hdev->dev.power.autosuspend_delay >= 0)
1861	pm_runtime_set_autosuspend_delay(dev: &hdev->dev, delay: 0);
1862	#endif
1863
1864	/*
1865	* Hubs have proper suspend/resume support, except for root hubs
1866	* where the controller driver doesn't have bus_suspend and
1867	* bus_resume methods.
1868	*/
1869	if (hdev->parent) { /* normal device */
1870	usb_enable_autosuspend(udev: hdev);
1871	} else { /* root hub */
1872	const struct hc_driver *drv = bus_to_hcd(bus: hdev->bus)->driver;
1873
1874	if (drv->bus_suspend && drv->bus_resume)
1875	usb_enable_autosuspend(udev: hdev);
1876	}
1877
1878	if (hdev->level == MAX_TOPO_LEVEL) {
1879	dev_err(&intf->dev,
1880	"Unsupported bus topology: hub nested too deep\n");
1881	return -E2BIG;
1882	}
1883
1884	#ifdef CONFIG_USB_OTG_DISABLE_EXTERNAL_HUB
1885	if (hdev->parent) {
1886	dev_warn(&intf->dev, "ignoring external hub\n");
1887	return -ENODEV;
1888	}
1889	#endif
1890
1891	if (!hub_descriptor_is_sane(desc)) {
1892	dev_err(&intf->dev, "bad descriptor, ignoring hub\n");
1893	return -EIO;
1894	}
1895
1896	/* We found a hub */
1897	dev_info(&intf->dev, "USB hub found\n");
1898
1899	hub = kzalloc(size: sizeof(*hub), GFP_KERNEL);
1900	if (!hub)
1901	return -ENOMEM;
1902
1903	kref_init(kref: &hub->kref);
1904	hub->intfdev = &intf->dev;
1905	hub->hdev = hdev;
1906	INIT_DELAYED_WORK(&hub->leds, led_work);
1907	INIT_DELAYED_WORK(&hub->init_work, NULL);
1908	INIT_WORK(&hub->events, hub_event);
1909	INIT_LIST_HEAD(list: &hub->onboard_hub_devs);
1910	spin_lock_init(&hub->irq_urb_lock);
1911	timer_setup(&hub->irq_urb_retry, hub_retry_irq_urb, 0);
1912	usb_get_intf(intf);
1913	usb_get_dev(dev: hdev);
1914
1915	usb_set_intfdata(intf, data: hub);
1916	intf->needs_remote_wakeup = 1;
1917	pm_suspend_ignore_children(dev: &intf->dev, enable: true);
1918
1919	if (hdev->speed == USB_SPEED_HIGH)
1920	highspeed_hubs++;
1921
1922	if (id->driver_info & HUB_QUIRK_CHECK_PORT_AUTOSUSPEND)
1923	hub->quirk_check_port_auto_suspend = 1;
1924
1925	if (id->driver_info & HUB_QUIRK_DISABLE_AUTOSUSPEND) {
1926	hub->quirk_disable_autosuspend = 1;
1927	usb_autopm_get_interface_no_resume(intf);
1928	}
1929
1930	if (hub_configure(hub, endpoint: &desc->endpoint[0].desc) >= 0) {
1931	onboard_hub_create_pdevs(parent_hub: hdev, pdev_list: &hub->onboard_hub_devs);
1932
1933	return 0;
1934	}
1935
1936	hub_disconnect(intf);
1937	return -ENODEV;
1938	}
1939
1940	static int
1941	hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1942	{
1943	struct usb_device *hdev = interface_to_usbdev(intf);
1944	struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1945
1946	/* assert ifno == 0 (part of hub spec) */
1947	switch (code) {
1948	case USBDEVFS_HUB_PORTINFO: {
1949	struct usbdevfs_hub_portinfo *info = user_data;
1950	int i;
1951
1952	spin_lock_irq(lock: &device_state_lock);
1953	if (hdev->devnum <= 0)
1954	info->nports = 0;
1955	else {
1956	info->nports = hdev->maxchild;
1957	for (i = 0; i < info->nports; i++) {
1958	if (hub->ports[i]->child == NULL)
1959	info->port[i] = 0;
1960	else
1961	info->port[i] =
1962	hub->ports[i]->child->devnum;
1963	}
1964	}
1965	spin_unlock_irq(lock: &device_state_lock);
1966
1967	return info->nports + 1;
1968	}
1969
1970	default:
1971	return -ENOSYS;
1972	}
1973	}
1974
1975	/*
1976	* Allow user programs to claim ports on a hub. When a device is attached
1977	* to one of these "claimed" ports, the program will "own" the device.
1978	*/
1979	static int find_port_owner(struct usb_device *hdev, unsigned port1,
1980	struct usb_dev_state ***ppowner)
1981	{
1982	struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1983
1984	if (hdev->state == USB_STATE_NOTATTACHED)
1985	return -ENODEV;
1986	if (port1 == 0 || port1 > hdev->maxchild)
1987	return -EINVAL;
1988
1989	/* Devices not managed by the hub driver
1990	* will always have maxchild equal to 0.
1991	*/
1992	*ppowner = &(hub->ports[port1 - 1]->port_owner);
1993	return 0;
1994	}
1995
1996	/* In the following three functions, the caller must hold hdev's lock */
1997	int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
1998	struct usb_dev_state *owner)
1999	{
2000	int rc;
2001	struct usb_dev_state **powner;
2002
2003	rc = find_port_owner(hdev, port1, ppowner: &powner);
2004	if (rc)
2005	return rc;
2006	if (*powner)
2007	return -EBUSY;
2008	*powner = owner;
2009	return rc;
2010	}
2011	EXPORT_SYMBOL_GPL(usb_hub_claim_port);
2012
2013	int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
2014	struct usb_dev_state *owner)
2015	{
2016	int rc;
2017	struct usb_dev_state **powner;
2018
2019	rc = find_port_owner(hdev, port1, ppowner: &powner);
2020	if (rc)
2021	return rc;
2022	if (*powner != owner)
2023	return -ENOENT;
2024	*powner = NULL;
2025	return rc;
2026	}
2027	EXPORT_SYMBOL_GPL(usb_hub_release_port);
2028
2029	void usb_hub_release_all_ports(struct usb_device *hdev, struct usb_dev_state *owner)
2030	{
2031	struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
2032	int n;
2033
2034	for (n = 0; n < hdev->maxchild; n++) {
2035	if (hub->ports[n]->port_owner == owner)
2036	hub->ports[n]->port_owner = NULL;
2037	}
2038
2039	}
2040
2041	/* The caller must hold udev's lock */
2042	bool usb_device_is_owned(struct usb_device *udev)
2043	{
2044	struct usb_hub *hub;
2045
2046	if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
2047	return false;
2048	hub = usb_hub_to_struct_hub(hdev: udev->parent);
2049	return !!hub->ports[udev->portnum - 1]->port_owner;
2050	}
2051
2052	static void update_port_device_state(struct usb_device *udev)
2053	{
2054	struct usb_hub *hub;
2055	struct usb_port *port_dev;
2056
2057	if (udev->parent) {
2058	hub = usb_hub_to_struct_hub(hdev: udev->parent);
2059	port_dev = hub->ports[udev->portnum - 1];
2060	WRITE_ONCE(port_dev->state, udev->state);
2061	sysfs_notify_dirent(kn: port_dev->state_kn);
2062	}
2063	}
2064
2065	static void recursively_mark_NOTATTACHED(struct usb_device *udev)
2066	{
2067	struct usb_hub *hub = usb_hub_to_struct_hub(hdev: udev);
2068	int i;
2069
2070	for (i = 0; i < udev->maxchild; ++i) {
2071	if (hub->ports[i]->child)
2072	recursively_mark_NOTATTACHED(udev: hub->ports[i]->child);
2073	}
2074	if (udev->state == USB_STATE_SUSPENDED)
2075	udev->active_duration -= jiffies;
2076	udev->state = USB_STATE_NOTATTACHED;
2077	update_port_device_state(udev);
2078	}
2079
2080	/**
2081	* usb_set_device_state - change a device's current state (usbcore, hcds)
2082	* @udev: pointer to device whose state should be changed
2083	* @new_state: new state value to be stored
2084	*
2085	* udev->state is _not_ fully protected by the device lock. Although
2086	* most transitions are made only while holding the lock, the state can
2087	* can change to USB_STATE_NOTATTACHED at almost any time. This
2088	* is so that devices can be marked as disconnected as soon as possible,
2089	* without having to wait for any semaphores to be released. As a result,
2090	* all changes to any device's state must be protected by the
2091	* device_state_lock spinlock.
2092	*
2093	* Once a device has been added to the device tree, all changes to its state
2094	* should be made using this routine. The state should _not_ be set directly.
2095	*
2096	* If udev->state is already USB_STATE_NOTATTACHED then no change is made.
2097	* Otherwise udev->state is set to new_state, and if new_state is
2098	* USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
2099	* to USB_STATE_NOTATTACHED.
2100	*/
2101	void usb_set_device_state(struct usb_device *udev,
2102	enum usb_device_state new_state)
2103	{
2104	unsigned long flags;
2105	int wakeup = -1;
2106
2107	spin_lock_irqsave(&device_state_lock, flags);
2108	if (udev->state == USB_STATE_NOTATTACHED)
2109	; /* do nothing */
2110	else if (new_state != USB_STATE_NOTATTACHED) {
2111
2112	/* root hub wakeup capabilities are managed out-of-band
2113	* and may involve silicon errata ... ignore them here.
2114	*/
2115	if (udev->parent) {
2116	if (udev->state == USB_STATE_SUSPENDED
2117	|| new_state == USB_STATE_SUSPENDED)
2118	; /* No change to wakeup settings */
2119	else if (new_state == USB_STATE_CONFIGURED)
2120	wakeup = (udev->quirks &
2121	USB_QUIRK_IGNORE_REMOTE_WAKEUP) ? 0 :
2122	udev->actconfig->desc.bmAttributes &
2123	USB_CONFIG_ATT_WAKEUP;
2124	else
2125	wakeup = 0;
2126	}
2127	if (udev->state == USB_STATE_SUSPENDED &&
2128	new_state != USB_STATE_SUSPENDED)
2129	udev->active_duration -= jiffies;
2130	else if (new_state == USB_STATE_SUSPENDED &&
2131	udev->state != USB_STATE_SUSPENDED)
2132	udev->active_duration += jiffies;
2133	udev->state = new_state;
2134	update_port_device_state(udev);
2135	} else
2136	recursively_mark_NOTATTACHED(udev);
2137	spin_unlock_irqrestore(lock: &device_state_lock, flags);
2138	if (wakeup >= 0)
2139	device_set_wakeup_capable(dev: &udev->dev, capable: wakeup);
2140	}
2141	EXPORT_SYMBOL_GPL(usb_set_device_state);
2142
2143	/*
2144	* Choose a device number.
2145	*
2146	* Device numbers are used as filenames in usbfs. On USB-1.1 and
2147	* USB-2.0 buses they are also used as device addresses, however on
2148	* USB-3.0 buses the address is assigned by the controller hardware
2149	* and it usually is not the same as the device number.
2150	*
2151	* Devices connected under xHCI are not as simple. The host controller
2152	* supports virtualization, so the hardware assigns device addresses and
2153	* the HCD must setup data structures before issuing a set address
2154	* command to the hardware.
2155	*/
2156	static void choose_devnum(struct usb_device *udev)
2157	{
2158	int devnum;
2159	struct usb_bus *bus = udev->bus;
2160
2161	/* be safe when more hub events are proceed in parallel */
2162	mutex_lock(&bus->devnum_next_mutex);
2163
2164	/* Try to allocate the next devnum beginning at bus->devnum_next. */
2165	devnum = find_next_zero_bit(addr: bus->devmap.devicemap, size: 128,
2166	offset: bus->devnum_next);
2167	if (devnum >= 128)
2168	devnum = find_next_zero_bit(addr: bus->devmap.devicemap, size: 128, offset: 1);
2169	bus->devnum_next = (devnum >= 127 ? 1 : devnum + 1);
2170	if (devnum < 128) {
2171	set_bit(nr: devnum, addr: bus->devmap.devicemap);
2172	udev->devnum = devnum;
2173	}
2174	mutex_unlock(lock: &bus->devnum_next_mutex);
2175	}
2176
2177	static void release_devnum(struct usb_device *udev)
2178	{
2179	if (udev->devnum > 0) {
2180	clear_bit(nr: udev->devnum, addr: udev->bus->devmap.devicemap);
2181	udev->devnum = -1;
2182	}
2183	}
2184
2185	static void update_devnum(struct usb_device *udev, int devnum)
2186	{
2187	udev->devnum = devnum;
2188	if (!udev->devaddr)
2189	udev->devaddr = (u8)devnum;
2190	}
2191
2192	static void hub_free_dev(struct usb_device *udev)
2193	{
2194	struct usb_hcd *hcd = bus_to_hcd(bus: udev->bus);
2195
2196	/* Root hubs aren't real devices, so don't free HCD resources */
2197	if (hcd->driver->free_dev && udev->parent)
2198	hcd->driver->free_dev(hcd, udev);
2199	}
2200
2201	static void hub_disconnect_children(struct usb_device *udev)
2202	{
2203	struct usb_hub *hub = usb_hub_to_struct_hub(hdev: udev);
2204	int i;
2205
2206	/* Free up all the children before we remove this device */
2207	for (i = 0; i < udev->maxchild; i++) {
2208	if (hub->ports[i]->child)
2209	usb_disconnect(&hub->ports[i]->child);
2210	}
2211	}
2212
2213	/**
2214	* usb_disconnect - disconnect a device (usbcore-internal)
2215	* @pdev: pointer to device being disconnected
2216	*
2217	* Context: task context, might sleep
2218	*
2219	* Something got disconnected. Get rid of it and all of its children.
2220	*
2221	* If *pdev is a normal device then the parent hub must already be locked.
2222	* If *pdev is a root hub then the caller must hold the usb_bus_idr_lock,
2223	* which protects the set of root hubs as well as the list of buses.
2224	*
2225	* Only hub drivers (including virtual root hub drivers for host
2226	* controllers) should ever call this.
2227	*
2228	* This call is synchronous, and may not be used in an interrupt context.
2229	*/
2230	void usb_disconnect(struct usb_device **pdev)
2231	{
2232	struct usb_port *port_dev = NULL;
2233	struct usb_device *udev = *pdev;
2234	struct usb_hub *hub = NULL;
2235	int port1 = 1;
2236
2237	/* mark the device as inactive, so any further urb submissions for
2238	* this device (and any of its children) will fail immediately.
2239	* this quiesces everything except pending urbs.
2240	*/
2241	usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2242	dev_info(&udev->dev, "USB disconnect, device number %d\n",
2243	udev->devnum);
2244
2245	/*
2246	* Ensure that the pm runtime code knows that the USB device
2247	* is in the process of being disconnected.
2248	*/
2249	pm_runtime_barrier(dev: &udev->dev);
2250
2251	usb_lock_device(udev);
2252
2253	hub_disconnect_children(udev);
2254
2255	/* deallocate hcd/hardware state ... nuking all pending urbs and
2256	* cleaning up all state associated with the current configuration
2257	* so that the hardware is now fully quiesced.
2258	*/
2259	dev_dbg(&udev->dev, "unregistering device\n");
2260	usb_disable_device(dev: udev, skip_ep0: 0);
2261	usb_hcd_synchronize_unlinks(udev);
2262
2263	if (udev->parent) {
2264	port1 = udev->portnum;
2265	hub = usb_hub_to_struct_hub(hdev: udev->parent);
2266	port_dev = hub->ports[port1 - 1];
2267
2268	sysfs_remove_link(kobj: &udev->dev.kobj, name: "port");
2269	sysfs_remove_link(kobj: &port_dev->dev.kobj, name: "device");
2270
2271	/*
2272	* As usb_port_runtime_resume() de-references udev, make
2273	* sure no resumes occur during removal
2274	*/
2275	if (!test_and_set_bit(nr: port1, addr: hub->child_usage_bits))
2276	pm_runtime_get_sync(dev: &port_dev->dev);
2277
2278	typec_deattach(con: port_dev->connector, dev: &udev->dev);
2279	}
2280
2281	usb_remove_ep_devs(endpoint: &udev->ep0);
2282	usb_unlock_device(udev);
2283
2284	/* Unregister the device. The device driver is responsible
2285	* for de-configuring the device and invoking the remove-device
2286	* notifier chain (used by usbfs and possibly others).
2287	*/
2288	device_del(dev: &udev->dev);
2289
2290	/* Free the device number and delete the parent's children[]
2291	* (or root_hub) pointer.
2292	*/
2293	release_devnum(udev);
2294
2295	/* Avoid races with recursively_mark_NOTATTACHED() */
2296	spin_lock_irq(lock: &device_state_lock);
2297	*pdev = NULL;
2298	spin_unlock_irq(lock: &device_state_lock);
2299
2300	if (port_dev && test_and_clear_bit(nr: port1, addr: hub->child_usage_bits))
2301	pm_runtime_put(dev: &port_dev->dev);
2302
2303	hub_free_dev(udev);
2304
2305	put_device(dev: &udev->dev);
2306	}
2307
2308	#ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2309	static void show_string(struct usb_device *udev, char *id, char *string)
2310	{
2311	if (!string)
2312	return;
2313	dev_info(&udev->dev, "%s: %s\n", id, string);
2314	}
2315
2316	static void announce_device(struct usb_device *udev)
2317	{
2318	u16 bcdDevice = le16_to_cpu(udev->descriptor.bcdDevice);
2319
2320	dev_info(&udev->dev,
2321	"New USB device found, idVendor=%04x, idProduct=%04x, bcdDevice=%2x.%02x\n",
2322	le16_to_cpu(udev->descriptor.idVendor),
2323	le16_to_cpu(udev->descriptor.idProduct),
2324	bcdDevice >> 8, bcdDevice & 0xff);
2325	dev_info(&udev->dev,
2326	"New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2327	udev->descriptor.iManufacturer,
2328	udev->descriptor.iProduct,
2329	udev->descriptor.iSerialNumber);
2330	show_string(udev, id: "Product", string: udev->product);
2331	show_string(udev, id: "Manufacturer", string: udev->manufacturer);
2332	show_string(udev, id: "SerialNumber", string: udev->serial);
2333	}
2334	#else
2335	static inline void announce_device(struct usb_device *udev) { }
2336	#endif
2337
2338
2339	/**
2340	* usb_enumerate_device_otg - FIXME (usbcore-internal)
2341	* @udev: newly addressed device (in ADDRESS state)
2342	*
2343	* Finish enumeration for On-The-Go devices
2344	*
2345	* Return: 0 if successful. A negative error code otherwise.
2346	*/
2347	static int usb_enumerate_device_otg(struct usb_device *udev)
2348	{
2349	int err = 0;
2350
2351	#ifdef CONFIG_USB_OTG
2352	/*
2353	* OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2354	* to wake us after we've powered off VBUS; and HNP, switching roles
2355	* "host" to "peripheral". The OTG descriptor helps figure this out.
2356	*/
2357	if (!udev->bus->is_b_host
2358	&& udev->config
2359	&& udev->parent == udev->bus->root_hub) {
2360	struct usb_otg_descriptor *desc = NULL;
2361	struct usb_bus *bus = udev->bus;
2362	unsigned port1 = udev->portnum;
2363
2364	/* descriptor may appear anywhere in config */
2365	err = __usb_get_extra_descriptor(buffer: udev->rawdescriptors[0],
2366	le16_to_cpu(udev->config[0].desc.wTotalLength),
2367	USB_DT_OTG, ptr: (void **) &desc, min: sizeof(*desc));
2368	if (err || !(desc->bmAttributes & USB_OTG_HNP))
2369	return 0;
2370
2371	dev_info(&udev->dev, "Dual-Role OTG device on %sHNP port\n",
2372	(port1 == bus->otg_port) ? "" : "non-");
2373
2374	/* enable HNP before suspend, it's simpler */
2375	if (port1 == bus->otg_port) {
2376	bus->b_hnp_enable = 1;
2377	err = usb_control_msg(dev: udev,
2378	usb_sndctrlpipe(udev, 0),
2379	USB_REQ_SET_FEATURE, requesttype: 0,
2380	USB_DEVICE_B_HNP_ENABLE,
2381	index: 0, NULL, size: 0,
2382	USB_CTRL_SET_TIMEOUT);
2383	if (err < 0) {
2384	/*
2385	* OTG MESSAGE: report errors here,
2386	* customize to match your product.
2387	*/
2388	dev_err(&udev->dev, "can't set HNP mode: %d\n",
2389	err);
2390	bus->b_hnp_enable = 0;
2391	}
2392	} else if (desc->bLength == sizeof
2393	(struct usb_otg_descriptor)) {
2394	/* Set a_alt_hnp_support for legacy otg device */
2395	err = usb_control_msg(dev: udev,
2396	usb_sndctrlpipe(udev, 0),
2397	USB_REQ_SET_FEATURE, requesttype: 0,
2398	USB_DEVICE_A_ALT_HNP_SUPPORT,
2399	index: 0, NULL, size: 0,
2400	USB_CTRL_SET_TIMEOUT);
2401	if (err < 0)
2402	dev_err(&udev->dev,
2403	"set a_alt_hnp_support failed: %d\n",
2404	err);
2405	}
2406	}
2407	#endif
2408	return err;
2409	}
2410
2411
2412	/**
2413	* usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2414	* @udev: newly addressed device (in ADDRESS state)
2415	*
2416	* This is only called by usb_new_device() -- all comments that apply there
2417	* apply here wrt to environment.
2418	*
2419	* If the device is WUSB and not authorized, we don't attempt to read
2420	* the string descriptors, as they will be errored out by the device
2421	* until it has been authorized.
2422	*
2423	* Return: 0 if successful. A negative error code otherwise.
2424	*/
2425	static int usb_enumerate_device(struct usb_device *udev)
2426	{
2427	int err;
2428	struct usb_hcd *hcd = bus_to_hcd(bus: udev->bus);
2429
2430	if (udev->config == NULL) {
2431	err = usb_get_configuration(dev: udev);
2432	if (err < 0) {
2433	if (err != -ENODEV)
2434	dev_err(&udev->dev, "can't read configurations, error %d\n",
2435	err);
2436	return err;
2437	}
2438	}
2439
2440	/* read the standard strings and cache them if present */
2441	udev->product = usb_cache_string(udev, index: udev->descriptor.iProduct);
2442	udev->manufacturer = usb_cache_string(udev,
2443	index: udev->descriptor.iManufacturer);
2444	udev->serial = usb_cache_string(udev, index: udev->descriptor.iSerialNumber);
2445
2446	err = usb_enumerate_device_otg(udev);
2447	if (err < 0)
2448	return err;
2449
2450	if (IS_ENABLED(CONFIG_USB_OTG_PRODUCTLIST) && hcd->tpl_support &&
2451	!is_targeted(dev: udev)) {
2452	/* Maybe it can talk to us, though we can't talk to it.
2453	* (Includes HNP test device.)
2454	*/
2455	if (IS_ENABLED(CONFIG_USB_OTG) && (udev->bus->b_hnp_enable
2456	|| udev->bus->is_b_host)) {
2457	err = usb_port_suspend(dev: udev, PMSG_AUTO_SUSPEND);
2458	if (err < 0)
2459	dev_dbg(&udev->dev, "HNP fail, %d\n", err);
2460	}
2461	return -ENOTSUPP;
2462	}
2463
2464	usb_detect_interface_quirks(udev);
2465
2466	return 0;
2467	}
2468
2469	static void set_usb_port_removable(struct usb_device *udev)
2470	{
2471	struct usb_device *hdev = udev->parent;
2472	struct usb_hub *hub;
2473	u8 port = udev->portnum;
2474	u16 wHubCharacteristics;
2475	bool removable = true;
2476
2477	dev_set_removable(dev: &udev->dev, removable: DEVICE_REMOVABLE_UNKNOWN);
2478
2479	if (!hdev)
2480	return;
2481
2482	hub = usb_hub_to_struct_hub(hdev: udev->parent);
2483
2484	/*
2485	* If the platform firmware has provided information about a port,
2486	* use that to determine whether it's removable.
2487	*/
2488	switch (hub->ports[udev->portnum - 1]->connect_type) {
2489	case USB_PORT_CONNECT_TYPE_HOT_PLUG:
2490	dev_set_removable(dev: &udev->dev, removable: DEVICE_REMOVABLE);
2491	return;
2492	case USB_PORT_CONNECT_TYPE_HARD_WIRED:
2493	case USB_PORT_NOT_USED:
2494	dev_set_removable(dev: &udev->dev, removable: DEVICE_FIXED);
2495	return;
2496	default:
2497	break;
2498	}
2499
2500	/*
2501	* Otherwise, check whether the hub knows whether a port is removable
2502	* or not
2503	*/
2504	wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2505
2506	if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
2507	return;
2508
2509	if (hub_is_superspeed(hdev)) {
2510	if (le16_to_cpu(hub->descriptor->u.ss.DeviceRemovable)
2511	& (1 << port))
2512	removable = false;
2513	} else {
2514	if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
2515	removable = false;
2516	}
2517
2518	if (removable)
2519	dev_set_removable(dev: &udev->dev, removable: DEVICE_REMOVABLE);
2520	else
2521	dev_set_removable(dev: &udev->dev, removable: DEVICE_FIXED);
2522
2523	}
2524
2525	/**
2526	* usb_new_device - perform initial device setup (usbcore-internal)
2527	* @udev: newly addressed device (in ADDRESS state)
2528	*
2529	* This is called with devices which have been detected but not fully
2530	* enumerated. The device descriptor is available, but not descriptors
2531	* for any device configuration. The caller must have locked either
2532	* the parent hub (if udev is a normal device) or else the
2533	* usb_bus_idr_lock (if udev is a root hub). The parent's pointer to
2534	* udev has already been installed, but udev is not yet visible through
2535	* sysfs or other filesystem code.
2536	*
2537	* This call is synchronous, and may not be used in an interrupt context.
2538	*
2539	* Only the hub driver or root-hub registrar should ever call this.
2540	*
2541	* Return: Whether the device is configured properly or not. Zero if the
2542	* interface was registered with the driver core; else a negative errno
2543	* value.
2544	*
2545	*/
2546	int usb_new_device(struct usb_device *udev)
2547	{
2548	int err;
2549
2550	if (udev->parent) {
2551	/* Initialize non-root-hub device wakeup to disabled;
2552	* device (un)configuration controls wakeup capable
2553	* sysfs power/wakeup controls wakeup enabled/disabled
2554	*/
2555	device_init_wakeup(dev: &udev->dev, enable: 0);
2556	}
2557
2558	/* Tell the runtime-PM framework the device is active */
2559	pm_runtime_set_active(dev: &udev->dev);
2560	pm_runtime_get_noresume(dev: &udev->dev);
2561	pm_runtime_use_autosuspend(dev: &udev->dev);
2562	pm_runtime_enable(dev: &udev->dev);
2563
2564	/* By default, forbid autosuspend for all devices. It will be
2565	* allowed for hubs during binding.
2566	*/
2567	usb_disable_autosuspend(udev);
2568
2569	err = usb_enumerate_device(udev); /* Read descriptors */
2570	if (err < 0)
2571	goto fail;
2572	dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
2573	udev->devnum, udev->bus->busnum,
2574	(((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2575	/* export the usbdev device-node for libusb */
2576	udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
2577	(((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2578
2579	/* Tell the world! */
2580	announce_device(udev);
2581
2582	if (udev->serial)
2583	add_device_randomness(buf: udev->serial, strlen(udev->serial));
2584	if (udev->product)
2585	add_device_randomness(buf: udev->product, strlen(udev->product));
2586	if (udev->manufacturer)
2587	add_device_randomness(buf: udev->manufacturer,
2588	strlen(udev->manufacturer));
2589
2590	device_enable_async_suspend(dev: &udev->dev);
2591
2592	/* check whether the hub or firmware marks this port as non-removable */
2593	set_usb_port_removable(udev);
2594
2595	/* Register the device. The device driver is responsible
2596	* for configuring the device and invoking the add-device
2597	* notifier chain (used by usbfs and possibly others).
2598	*/
2599	err = device_add(dev: &udev->dev);
2600	if (err) {
2601	dev_err(&udev->dev, "can't device_add, error %d\n", err);
2602	goto fail;
2603	}
2604
2605	/* Create link files between child device and usb port device. */
2606	if (udev->parent) {
2607	struct usb_hub *hub = usb_hub_to_struct_hub(hdev: udev->parent);
2608	int port1 = udev->portnum;
2609	struct usb_port *port_dev = hub->ports[port1 - 1];
2610
2611	err = sysfs_create_link(kobj: &udev->dev.kobj,
2612	target: &port_dev->dev.kobj, name: "port");
2613	if (err)
2614	goto fail;
2615
2616	err = sysfs_create_link(kobj: &port_dev->dev.kobj,
2617	target: &udev->dev.kobj, name: "device");
2618	if (err) {
2619	sysfs_remove_link(kobj: &udev->dev.kobj, name: "port");
2620	goto fail;
2621	}
2622
2623	if (!test_and_set_bit(nr: port1, addr: hub->child_usage_bits))
2624	pm_runtime_get_sync(dev: &port_dev->dev);
2625
2626	typec_attach(con: port_dev->connector, dev: &udev->dev);
2627	}
2628
2629	(void) usb_create_ep_devs(parent: &udev->dev, endpoint: &udev->ep0, udev);
2630	usb_mark_last_busy(udev);
2631	pm_runtime_put_sync_autosuspend(dev: &udev->dev);
2632	return err;
2633
2634	fail:
2635	usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2636	pm_runtime_disable(dev: &udev->dev);
2637	pm_runtime_set_suspended(dev: &udev->dev);
2638	return err;
2639	}
2640
2641
2642	/**
2643	* usb_deauthorize_device - deauthorize a device (usbcore-internal)
2644	* @usb_dev: USB device
2645	*
2646	* Move the USB device to a very basic state where interfaces are disabled
2647	* and the device is in fact unconfigured and unusable.
2648	*
2649	* We share a lock (that we have) with device_del(), so we need to
2650	* defer its call.
2651	*
2652	* Return: 0.
2653	*/
2654	int usb_deauthorize_device(struct usb_device *usb_dev)
2655	{
2656	usb_lock_device(usb_dev);
2657	if (usb_dev->authorized == 0)
2658	goto out_unauthorized;
2659
2660	usb_dev->authorized = 0;
2661	usb_set_configuration(dev: usb_dev, configuration: -1);
2662
2663	out_unauthorized:
2664	usb_unlock_device(usb_dev);
2665	return 0;
2666	}
2667
2668
2669	int usb_authorize_device(struct usb_device *usb_dev)
2670	{
2671	int result = 0, c;
2672
2673	usb_lock_device(usb_dev);
2674	if (usb_dev->authorized == 1)
2675	goto out_authorized;
2676
2677	result = usb_autoresume_device(udev: usb_dev);
2678	if (result < 0) {
2679	dev_err(&usb_dev->dev,
2680	"can't autoresume for authorization: %d\n", result);
2681	goto error_autoresume;
2682	}
2683
2684	usb_dev->authorized = 1;
2685	/* Choose and set the configuration. This registers the interfaces
2686	* with the driver core and lets interface drivers bind to them.
2687	*/
2688	c = usb_choose_configuration(udev: usb_dev);
2689	if (c >= 0) {
2690	result = usb_set_configuration(dev: usb_dev, configuration: c);
2691	if (result) {
2692	dev_err(&usb_dev->dev,
2693	"can't set config #%d, error %d\n", c, result);
2694	/* This need not be fatal. The user can try to
2695	* set other configurations. */
2696	}
2697	}
2698	dev_info(&usb_dev->dev, "authorized to connect\n");
2699
2700	usb_autosuspend_device(udev: usb_dev);
2701	error_autoresume:
2702	out_authorized:
2703	usb_unlock_device(usb_dev); /* complements locktree */
2704	return result;
2705	}
2706
2707	/**
2708	* get_port_ssp_rate - Match the extended port status to SSP rate
2709	* @hdev: The hub device
2710	* @ext_portstatus: extended port status
2711	*
2712	* Match the extended port status speed id to the SuperSpeed Plus sublink speed
2713	* capability attributes. Base on the number of connected lanes and speed,
2714	* return the corresponding enum usb_ssp_rate.
2715	*/
2716	static enum usb_ssp_rate get_port_ssp_rate(struct usb_device *hdev,
2717	u32 ext_portstatus)
2718	{
2719	struct usb_ssp_cap_descriptor *ssp_cap;
2720	u32 attr;
2721	u8 speed_id;
2722	u8 ssac;
2723	u8 lanes;
2724	int i;
2725
2726	if (!hdev->bos)
2727	goto out;
2728
2729	ssp_cap = hdev->bos->ssp_cap;
2730	if (!ssp_cap)
2731	goto out;
2732
2733	speed_id = ext_portstatus & USB_EXT_PORT_STAT_RX_SPEED_ID;
2734	lanes = USB_EXT_PORT_RX_LANES(ext_portstatus) + 1;
2735
2736	ssac = le32_to_cpu(ssp_cap->bmAttributes) &
2737	USB_SSP_SUBLINK_SPEED_ATTRIBS;
2738
2739	for (i = 0; i <= ssac; i++) {
2740	u8 ssid;
2741
2742	attr = le32_to_cpu(ssp_cap->bmSublinkSpeedAttr[i]);
2743	ssid = FIELD_GET(USB_SSP_SUBLINK_SPEED_SSID, attr);
2744	if (speed_id == ssid) {
2745	u16 mantissa;
2746	u8 lse;
2747	u8 type;
2748
2749	/*
2750	* Note: currently asymmetric lane types are only
2751	* applicable for SSIC operate in SuperSpeed protocol
2752	*/
2753	type = FIELD_GET(USB_SSP_SUBLINK_SPEED_ST, attr);
2754	if (type == USB_SSP_SUBLINK_SPEED_ST_ASYM_RX ||
2755	type == USB_SSP_SUBLINK_SPEED_ST_ASYM_TX)
2756	goto out;
2757
2758	if (FIELD_GET(USB_SSP_SUBLINK_SPEED_LP, attr) !=
2759	USB_SSP_SUBLINK_SPEED_LP_SSP)
2760	goto out;
2761
2762	lse = FIELD_GET(USB_SSP_SUBLINK_SPEED_LSE, attr);
2763	mantissa = FIELD_GET(USB_SSP_SUBLINK_SPEED_LSM, attr);
2764
2765	/* Convert to Gbps */
2766	for (; lse < USB_SSP_SUBLINK_SPEED_LSE_GBPS; lse++)
2767	mantissa /= 1000;
2768
2769	if (mantissa >= 10 && lanes == 1)
2770	return USB_SSP_GEN_2x1;
2771
2772	if (mantissa >= 10 && lanes == 2)
2773	return USB_SSP_GEN_2x2;
2774
2775	if (mantissa >= 5 && lanes == 2)
2776	return USB_SSP_GEN_1x2;
2777
2778	goto out;
2779	}
2780	}
2781
2782	out:
2783	return USB_SSP_GEN_UNKNOWN;
2784	}
2785
2786	#ifdef CONFIG_USB_FEW_INIT_RETRIES
2787	#define PORT_RESET_TRIES 2
2788	#define SET_ADDRESS_TRIES 1
2789	#define GET_DESCRIPTOR_TRIES 1
2790	#define GET_MAXPACKET0_TRIES 1
2791	#define PORT_INIT_TRIES 4
2792
2793	#else
2794	#define PORT_RESET_TRIES 5
2795	#define SET_ADDRESS_TRIES 2
2796	#define GET_DESCRIPTOR_TRIES 2
2797	#define GET_MAXPACKET0_TRIES 3
2798	#define PORT_INIT_TRIES 4
2799	#endif /* CONFIG_USB_FEW_INIT_RETRIES */
2800
2801	#define DETECT_DISCONNECT_TRIES 5
2802
2803	#define HUB_ROOT_RESET_TIME 60 /* times are in msec */
2804	#define HUB_SHORT_RESET_TIME 10
2805	#define HUB_BH_RESET_TIME 50
2806	#define HUB_LONG_RESET_TIME 200
2807	#define HUB_RESET_TIMEOUT 800
2808
2809	static bool use_new_scheme(struct usb_device *udev, int retry,
2810	struct usb_port *port_dev)
2811	{
2812	int old_scheme_first_port =
2813	(port_dev->quirks & USB_PORT_QUIRK_OLD_SCHEME) ||
2814	old_scheme_first;
2815
2816	/*
2817	* "New scheme" enumeration causes an extra state transition to be
2818	* exposed to an xhci host and causes USB3 devices to receive control
2819	* commands in the default state. This has been seen to cause
2820	* enumeration failures, so disable this enumeration scheme for USB3
2821	* devices.
2822	*/
2823	if (udev->speed >= USB_SPEED_SUPER)
2824	return false;
2825
2826	/*
2827	* If use_both_schemes is set, use the first scheme (whichever
2828	* it is) for the larger half of the retries, then use the other
2829	* scheme. Otherwise, use the first scheme for all the retries.
2830	*/
2831	if (use_both_schemes && retry >= (PORT_INIT_TRIES + 1) / 2)
2832	return old_scheme_first_port; /* Second half */
2833	return !old_scheme_first_port; /* First half or all */
2834	}
2835
2836	/* Is a USB 3.0 port in the Inactive or Compliance Mode state?
2837	* Port warm reset is required to recover
2838	*/
2839	static bool hub_port_warm_reset_required(struct usb_hub *hub, int port1,
2840	u16 portstatus)
2841	{
2842	u16 link_state;
2843
2844	if (!hub_is_superspeed(hdev: hub->hdev))
2845	return false;
2846
2847	if (test_bit(port1, hub->warm_reset_bits))
2848	return true;
2849
2850	link_state = portstatus & USB_PORT_STAT_LINK_STATE;
2851	return link_state == USB_SS_PORT_LS_SS_INACTIVE
2852	|| link_state == USB_SS_PORT_LS_COMP_MOD;
2853	}
2854
2855	static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2856	struct usb_device *udev, unsigned int delay, bool warm)
2857	{
2858	int delay_time, ret;
2859	u16 portstatus;
2860	u16 portchange;
2861	u32 ext_portstatus = 0;
2862
2863	for (delay_time = 0;
2864	delay_time < HUB_RESET_TIMEOUT;
2865	delay_time += delay) {
2866	/* wait to give the device a chance to reset */
2867	msleep(msecs: delay);
2868
2869	/* read and decode port status */
2870	if (hub_is_superspeedplus(hdev: hub->hdev))
2871	ret = hub_ext_port_status(hub, port1,
2872	HUB_EXT_PORT_STATUS,
2873	status: &portstatus, change: &portchange,
2874	ext_status: &ext_portstatus);
2875	else
2876	ret = usb_hub_port_status(hub, port1, status: &portstatus,
2877	change: &portchange);
2878	if (ret < 0)
2879	return ret;
2880
2881	/*
2882	* The port state is unknown until the reset completes.
2883	*
2884	* On top of that, some chips may require additional time
2885	* to re-establish a connection after the reset is complete,
2886	* so also wait for the connection to be re-established.
2887	*/
2888	if (!(portstatus & USB_PORT_STAT_RESET) &&
2889	(portstatus & USB_PORT_STAT_CONNECTION))
2890	break;
2891
2892	/* switch to the long delay after two short delay failures */
2893	if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2894	delay = HUB_LONG_RESET_TIME;
2895
2896	dev_dbg(&hub->ports[port1 - 1]->dev,
2897	"not %sreset yet, waiting %dms\n",
2898	warm ? "warm " : "", delay);
2899	}
2900
2901	if ((portstatus & USB_PORT_STAT_RESET))
2902	return -EBUSY;
2903
2904	if (hub_port_warm_reset_required(hub, port1, portstatus))
2905	return -ENOTCONN;
2906
2907	/* Device went away? */
2908	if (!(portstatus & USB_PORT_STAT_CONNECTION))
2909	return -ENOTCONN;
2910
2911	/* Retry if connect change is set but status is still connected.
2912	* A USB 3.0 connection may bounce if multiple warm resets were issued,
2913	* but the device may have successfully re-connected. Ignore it.
2914	*/
2915	if (!hub_is_superspeed(hdev: hub->hdev) &&
2916	(portchange & USB_PORT_STAT_C_CONNECTION)) {
2917	usb_clear_port_feature(hdev: hub->hdev, port1,
2918	USB_PORT_FEAT_C_CONNECTION);
2919	return -EAGAIN;
2920	}
2921
2922	if (!(portstatus & USB_PORT_STAT_ENABLE))
2923	return -EBUSY;
2924
2925	if (!udev)
2926	return 0;
2927
2928	if (hub_is_superspeedplus(hdev: hub->hdev)) {
2929	/* extended portstatus Rx and Tx lane count are zero based */
2930	udev->rx_lanes = USB_EXT_PORT_RX_LANES(ext_portstatus) + 1;
2931	udev->tx_lanes = USB_EXT_PORT_TX_LANES(ext_portstatus) + 1;
2932	udev->ssp_rate = get_port_ssp_rate(hdev: hub->hdev, ext_portstatus);
2933	} else {
2934	udev->rx_lanes = 1;
2935	udev->tx_lanes = 1;
2936	udev->ssp_rate = USB_SSP_GEN_UNKNOWN;
2937	}
2938	if (udev->ssp_rate != USB_SSP_GEN_UNKNOWN)
2939	udev->speed = USB_SPEED_SUPER_PLUS;
2940	else if (hub_is_superspeed(hdev: hub->hdev))
2941	udev->speed = USB_SPEED_SUPER;
2942	else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2943	udev->speed = USB_SPEED_HIGH;
2944	else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2945	udev->speed = USB_SPEED_LOW;
2946	else
2947	udev->speed = USB_SPEED_FULL;
2948	return 0;
2949	}
2950
2951	/* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2952	static int hub_port_reset(struct usb_hub *hub, int port1,
2953	struct usb_device *udev, unsigned int delay, bool warm)
2954	{
2955	int i, status;
2956	u16 portchange, portstatus;
2957	struct usb_port *port_dev = hub->ports[port1 - 1];
2958	int reset_recovery_time;
2959
2960	if (!hub_is_superspeed(hdev: hub->hdev)) {
2961	if (warm) {
2962	dev_err(hub->intfdev, "only USB3 hub support "
2963	"warm reset\n");
2964	return -EINVAL;
2965	}
2966	/* Block EHCI CF initialization during the port reset.
2967	* Some companion controllers don't like it when they mix.
2968	*/
2969	down_read(sem: &ehci_cf_port_reset_rwsem);
2970	} else if (!warm) {
2971	/*
2972	* If the caller hasn't explicitly requested a warm reset,
2973	* double check and see if one is needed.
2974	*/
2975	if (usb_hub_port_status(hub, port1, status: &portstatus,
2976	change: &portchange) == 0)
2977	if (hub_port_warm_reset_required(hub, port1,
2978	portstatus))
2979	warm = true;
2980	}
2981	clear_bit(nr: port1, addr: hub->warm_reset_bits);
2982
2983	/* Reset the port */
2984	for (i = 0; i < PORT_RESET_TRIES; i++) {
2985	status = set_port_feature(hdev: hub->hdev, port1, feature: (warm ?
2986	USB_PORT_FEAT_BH_PORT_RESET :
2987	USB_PORT_FEAT_RESET));
2988	if (status == -ENODEV) {
2989	; /* The hub is gone */
2990	} else if (status) {
2991	dev_err(&port_dev->dev,
2992	"cannot %sreset (err = %d)\n",
2993	warm ? "warm " : "", status);
2994	} else {
2995	status = hub_port_wait_reset(hub, port1, udev, delay,
2996	warm);
2997	if (status && status != -ENOTCONN && status != -ENODEV)
2998	dev_dbg(hub->intfdev,
2999	"port_wait_reset: err = %d\n",
3000	status);
3001	}
3002
3003	/*
3004	* Check for disconnect or reset, and bail out after several
3005	* reset attempts to avoid warm reset loop.
3006	*/
3007	if (status == 0 || status == -ENOTCONN || status == -ENODEV ||
3008	(status == -EBUSY && i == PORT_RESET_TRIES - 1)) {
3009	usb_clear_port_feature(hdev: hub->hdev, port1,
3010	USB_PORT_FEAT_C_RESET);
3011
3012	if (!hub_is_superspeed(hdev: hub->hdev))
3013	goto done;
3014
3015	usb_clear_port_feature(hdev: hub->hdev, port1,
3016	USB_PORT_FEAT_C_BH_PORT_RESET);
3017	usb_clear_port_feature(hdev: hub->hdev, port1,
3018	USB_PORT_FEAT_C_PORT_LINK_STATE);
3019
3020	if (udev)
3021	usb_clear_port_feature(hdev: hub->hdev, port1,
3022	USB_PORT_FEAT_C_CONNECTION);
3023
3024	/*
3025	* If a USB 3.0 device migrates from reset to an error
3026	* state, re-issue the warm reset.
3027	*/
3028	if (usb_hub_port_status(hub, port1,
3029	status: &portstatus, change: &portchange) < 0)
3030	goto done;
3031
3032	if (!hub_port_warm_reset_required(hub, port1,
3033	portstatus))
3034	goto done;
3035
3036	/*
3037	* If the port is in SS.Inactive or Compliance Mode, the
3038	* hot or warm reset failed. Try another warm reset.
3039	*/
3040	if (!warm) {
3041	dev_dbg(&port_dev->dev,
3042	"hot reset failed, warm reset\n");
3043	warm = true;
3044	}
3045	}
3046
3047	dev_dbg(&port_dev->dev,
3048	"not enabled, trying %sreset again...\n",
3049	warm ? "warm " : "");
3050	delay = HUB_LONG_RESET_TIME;
3051	}
3052
3053	dev_err(&port_dev->dev, "Cannot enable. Maybe the USB cable is bad?\n");
3054
3055	done:
3056	if (status == 0) {
3057	if (port_dev->quirks & USB_PORT_QUIRK_FAST_ENUM)
3058	usleep_range(min: 10000, max: 12000);
3059	else {
3060	/* TRSTRCY = 10 ms; plus some extra */
3061	reset_recovery_time = 10 + 40;
3062
3063	/* Hub needs extra delay after resetting its port. */
3064	if (hub->hdev->quirks & USB_QUIRK_HUB_SLOW_RESET)
3065	reset_recovery_time += 100;
3066
3067	msleep(msecs: reset_recovery_time);
3068	}
3069
3070	if (udev) {
3071	struct usb_hcd *hcd = bus_to_hcd(bus: udev->bus);
3072
3073	update_devnum(udev, devnum: 0);
3074	/* The xHC may think the device is already reset,
3075	* so ignore the status.
3076	*/
3077	if (hcd->driver->reset_device)
3078	hcd->driver->reset_device(hcd, udev);
3079
3080	usb_set_device_state(udev, USB_STATE_DEFAULT);
3081	}
3082	} else {
3083	if (udev)
3084	usb_set_device_state(udev, USB_STATE_NOTATTACHED);
3085	}
3086
3087	if (!hub_is_superspeed(hdev: hub->hdev))
3088	up_read(sem: &ehci_cf_port_reset_rwsem);
3089
3090	return status;
3091	}
3092
3093	/*
3094	* hub_port_stop_enumerate - stop USB enumeration or ignore port events
3095	* @hub: target hub
3096	* @port1: port num of the port
3097	* @retries: port retries number of hub_port_init()
3098	*
3099	* Return:
3100	* true: ignore port actions/events or give up connection attempts.
3101	* false: keep original behavior.
3102	*
3103	* This function will be based on retries to check whether the port which is
3104	* marked with early_stop attribute would stop enumeration or ignore events.
3105	*
3106	* Note:
3107	* This function didn't change anything if early_stop is not set, and it will
3108	* prevent all connection attempts when early_stop is set and the attempts of
3109	* the port are more than 1.
3110	*/
3111	static bool hub_port_stop_enumerate(struct usb_hub *hub, int port1, int retries)
3112	{
3113	struct usb_port *port_dev = hub->ports[port1 - 1];
3114
3115	if (port_dev->early_stop) {
3116	if (port_dev->ignore_event)
3117	return true;
3118
3119	/*
3120	* We want unsuccessful attempts to fail quickly.
3121	* Since some devices may need one failure during
3122	* port initialization, we allow two tries but no
3123	* more.
3124	*/
3125	if (retries < 2)
3126	return false;
3127
3128	port_dev->ignore_event = 1;
3129	} else
3130	port_dev->ignore_event = 0;
3131
3132	return port_dev->ignore_event;
3133	}
3134
3135	/* Check if a port is power on */
3136	int usb_port_is_power_on(struct usb_hub *hub, unsigned int portstatus)
3137	{
3138	int ret = 0;
3139
3140	if (hub_is_superspeed(hdev: hub->hdev)) {
3141	if (portstatus & USB_SS_PORT_STAT_POWER)
3142	ret = 1;
3143	} else {
3144	if (portstatus & USB_PORT_STAT_POWER)
3145	ret = 1;
3146	}
3147
3148	return ret;
3149	}
3150
3151	static void usb_lock_port(struct usb_port *port_dev)
3152	__acquires(&port_dev->status_lock)
3153	{
3154	mutex_lock(&port_dev->status_lock);
3155	__acquire(&port_dev->status_lock);
3156	}
3157
3158	static void usb_unlock_port(struct usb_port *port_dev)
3159	__releases(&port_dev->status_lock)
3160	{
3161	mutex_unlock(lock: &port_dev->status_lock);
3162	__release(&port_dev->status_lock);
3163	}
3164
3165	#ifdef CONFIG_PM
3166
3167	/* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
3168	static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
3169	{
3170	int ret = 0;
3171
3172	if (hub_is_superspeed(hdev: hub->hdev)) {
3173	if ((portstatus & USB_PORT_STAT_LINK_STATE)
3174	== USB_SS_PORT_LS_U3)
3175	ret = 1;
3176	} else {
3177	if (portstatus & USB_PORT_STAT_SUSPEND)
3178	ret = 1;
3179	}
3180
3181	return ret;
3182	}
3183
3184	/* Determine whether the device on a port is ready for a normal resume,
3185	* is ready for a reset-resume, or should be disconnected.
3186	*/
3187	static int check_port_resume_type(struct usb_device *udev,
3188	struct usb_hub *hub, int port1,
3189	int status, u16 portchange, u16 portstatus)
3190	{
3191	struct usb_port *port_dev = hub->ports[port1 - 1];
3192	int retries = 3;
3193
3194	retry:
3195	/* Is a warm reset needed to recover the connection? */
3196	if (status == 0 && udev->reset_resume
3197	&& hub_port_warm_reset_required(hub, port1, portstatus)) {
3198	/* pass */;
3199	}
3200	/* Is the device still present? */
3201	else if (status || port_is_suspended(hub, portstatus) ||
3202	!usb_port_is_power_on(hub, portstatus)) {
3203	if (status >= 0)
3204	status = -ENODEV;
3205	} else if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
3206	if (retries--) {
3207	usleep_range(min: 200, max: 300);
3208	status = usb_hub_port_status(hub, port1, status: &portstatus,
3209	change: &portchange);
3210	goto retry;
3211	}
3212	status = -ENODEV;
3213	}
3214
3215	/* Can't do a normal resume if the port isn't enabled,
3216	* so try a reset-resume instead.
3217	*/
3218	else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
3219	if (udev->persist_enabled)
3220	udev->reset_resume = 1;
3221	else
3222	status = -ENODEV;
3223	}
3224
3225	if (status) {
3226	dev_dbg(&port_dev->dev, "status %04x.%04x after resume, %d\n",
3227	portchange, portstatus, status);
3228	} else if (udev->reset_resume) {
3229
3230	/* Late port handoff can set status-change bits */
3231	if (portchange & USB_PORT_STAT_C_CONNECTION)
3232	usb_clear_port_feature(hdev: hub->hdev, port1,
3233	USB_PORT_FEAT_C_CONNECTION);
3234	if (portchange & USB_PORT_STAT_C_ENABLE)
3235	usb_clear_port_feature(hdev: hub->hdev, port1,
3236	USB_PORT_FEAT_C_ENABLE);
3237
3238	/*
3239	* Whatever made this reset-resume necessary may have
3240	* turned on the port1 bit in hub->change_bits. But after
3241	* a successful reset-resume we want the bit to be clear;
3242	* if it was on it would indicate that something happened
3243	* following the reset-resume.
3244	*/
3245	clear_bit(nr: port1, addr: hub->change_bits);
3246	}
3247
3248	return status;
3249	}
3250
3251	int usb_disable_ltm(struct usb_device *udev)
3252	{
3253	struct usb_hcd *hcd = bus_to_hcd(bus: udev->bus);
3254
3255	/* Check if the roothub and device supports LTM. */
3256	if (!usb_device_supports_ltm(udev: hcd->self.root_hub) ||
3257	!usb_device_supports_ltm(udev))
3258	return 0;
3259
3260	/* Clear Feature LTM Enable can only be sent if the device is
3261	* configured.
3262	*/
3263	if (!udev->actconfig)
3264	return 0;
3265
3266	return usb_control_msg(dev: udev, usb_sndctrlpipe(udev, 0),
3267	USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
3268	USB_DEVICE_LTM_ENABLE, index: 0, NULL, size: 0,
3269	USB_CTRL_SET_TIMEOUT);
3270	}
3271	EXPORT_SYMBOL_GPL(usb_disable_ltm);
3272
3273	void usb_enable_ltm(struct usb_device *udev)
3274	{
3275	struct usb_hcd *hcd = bus_to_hcd(bus: udev->bus);
3276
3277	/* Check if the roothub and device supports LTM. */
3278	if (!usb_device_supports_ltm(udev: hcd->self.root_hub) ||
3279	!usb_device_supports_ltm(udev))
3280	return;
3281
3282	/* Set Feature LTM Enable can only be sent if the device is
3283	* configured.
3284	*/
3285	if (!udev->actconfig)
3286	return;
3287
3288	usb_control_msg(dev: udev, usb_sndctrlpipe(udev, 0),
3289	USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
3290	USB_DEVICE_LTM_ENABLE, index: 0, NULL, size: 0,
3291	USB_CTRL_SET_TIMEOUT);
3292	}
3293	EXPORT_SYMBOL_GPL(usb_enable_ltm);
3294
3295	/*
3296	* usb_enable_remote_wakeup - enable remote wakeup for a device
3297	* @udev: target device
3298	*
3299	* For USB-2 devices: Set the device's remote wakeup feature.
3300	*
3301	* For USB-3 devices: Assume there's only one function on the device and
3302	* enable remote wake for the first interface. FIXME if the interface
3303	* association descriptor shows there's more than one function.
3304	*/
3305	static int usb_enable_remote_wakeup(struct usb_device *udev)
3306	{
3307	if (udev->speed < USB_SPEED_SUPER)
3308	return usb_control_msg(dev: udev, usb_sndctrlpipe(udev, 0),
3309	USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
3310	USB_DEVICE_REMOTE_WAKEUP, index: 0, NULL, size: 0,
3311	USB_CTRL_SET_TIMEOUT);
3312	else
3313	return usb_control_msg(dev: udev, usb_sndctrlpipe(udev, 0),
3314	USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
3315	USB_INTRF_FUNC_SUSPEND,
3316	USB_INTRF_FUNC_SUSPEND_RW |
3317	USB_INTRF_FUNC_SUSPEND_LP,
3318	NULL, size: 0, USB_CTRL_SET_TIMEOUT);
3319	}
3320
3321	/*
3322	* usb_disable_remote_wakeup - disable remote wakeup for a device
3323	* @udev: target device
3324	*
3325	* For USB-2 devices: Clear the device's remote wakeup feature.
3326	*
3327	* For USB-3 devices: Assume there's only one function on the device and
3328	* disable remote wake for the first interface. FIXME if the interface
3329	* association descriptor shows there's more than one function.
3330	*/
3331	static int usb_disable_remote_wakeup(struct usb_device *udev)
3332	{
3333	if (udev->speed < USB_SPEED_SUPER)
3334	return usb_control_msg(dev: udev, usb_sndctrlpipe(udev, 0),
3335	USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
3336	USB_DEVICE_REMOTE_WAKEUP, index: 0, NULL, size: 0,
3337	USB_CTRL_SET_TIMEOUT);
3338	else
3339	return usb_control_msg(dev: udev, usb_sndctrlpipe(udev, 0),
3340	USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
3341	USB_INTRF_FUNC_SUSPEND, index: 0, NULL, size: 0,
3342	USB_CTRL_SET_TIMEOUT);
3343	}
3344
3345	/* Count of wakeup-enabled devices at or below udev */
3346	unsigned usb_wakeup_enabled_descendants(struct usb_device *udev)
3347	{
3348	struct usb_hub *hub = usb_hub_to_struct_hub(hdev: udev);
3349
3350	return udev->do_remote_wakeup +
3351	(hub ? hub->wakeup_enabled_descendants : 0);
3352	}
3353	EXPORT_SYMBOL_GPL(usb_wakeup_enabled_descendants);
3354
3355	/*
3356	* usb_port_suspend - suspend a usb device's upstream port
3357	* @udev: device that's no longer in active use, not a root hub
3358	* Context: must be able to sleep; device not locked; pm locks held
3359	*
3360	* Suspends a USB device that isn't in active use, conserving power.
3361	* Devices may wake out of a suspend, if anything important happens,
3362	* using the remote wakeup mechanism. They may also be taken out of
3363	* suspend by the host, using usb_port_resume(). It's also routine
3364	* to disconnect devices while they are suspended.
3365	*
3366	* This only affects the USB hardware for a device; its interfaces
3367	* (and, for hubs, child devices) must already have been suspended.
3368	*
3369	* Selective port suspend reduces power; most suspended devices draw
3370	* less than 500 uA. It's also used in OTG, along with remote wakeup.
3371	* All devices below the suspended port are also suspended.
3372	*
3373	* Devices leave suspend state when the host wakes them up. Some devices
3374	* also support "remote wakeup", where the device can activate the USB
3375	* tree above them to deliver data, such as a keypress or packet. In
3376	* some cases, this wakes the USB host.
3377	*
3378	* Suspending OTG devices may trigger HNP, if that's been enabled
3379	* between a pair of dual-role devices. That will change roles, such
3380	* as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
3381	*
3382	* Devices on USB hub ports have only one "suspend" state, corresponding
3383	* to ACPI D2, "may cause the device to lose some context".
3384	* State transitions include:
3385	*
3386	* - suspend, resume ... when the VBUS power link stays live
3387	* - suspend, disconnect ... VBUS lost
3388	*
3389	* Once VBUS drop breaks the circuit, the port it's using has to go through
3390	* normal re-enumeration procedures, starting with enabling VBUS power.
3391	* Other than re-initializing the hub (plug/unplug, except for root hubs),
3392	* Linux (2.6) currently has NO mechanisms to initiate that: no hub_wq
3393	* timer, no SRP, no requests through sysfs.
3394	*
3395	* If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
3396	* suspended until their bus goes into global suspend (i.e., the root
3397	* hub is suspended). Nevertheless, we change @udev->state to
3398	* USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
3399	* upstream port setting is stored in @udev->port_is_suspended.
3400	*
3401	* Returns 0 on success, else negative errno.
3402	*/
3403	int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
3404	{
3405	struct usb_hub *hub = usb_hub_to_struct_hub(hdev: udev->parent);
3406	struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3407	int port1 = udev->portnum;
3408	int status;
3409	bool really_suspend = true;
3410
3411	usb_lock_port(port_dev);
3412
3413	/* enable remote wakeup when appropriate; this lets the device
3414	* wake up the upstream hub (including maybe the root hub).
3415	*
3416	* NOTE: OTG devices may issue remote wakeup (or SRP) even when
3417	* we don't explicitly enable it here.
3418	*/
3419	if (udev->do_remote_wakeup) {
3420	status = usb_enable_remote_wakeup(udev);
3421	if (status) {
3422	dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
3423	status);
3424	/* bail if autosuspend is requested */
3425	if (PMSG_IS_AUTO(msg))
3426	goto err_wakeup;
3427	}
3428	}
3429
3430	/* disable USB2 hardware LPM */
3431	usb_disable_usb2_hardware_lpm(udev);
3432
3433	if (usb_disable_ltm(udev)) {
3434	dev_err(&udev->dev, "Failed to disable LTM before suspend\n");
3435	status = -ENOMEM;
3436	if (PMSG_IS_AUTO(msg))
3437	goto err_ltm;
3438	}
3439
3440	/* see 7.1.7.6 */
3441	if (hub_is_superspeed(hdev: hub->hdev))
3442	status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U3);
3443
3444	/*
3445	* For system suspend, we do not need to enable the suspend feature
3446	* on individual USB-2 ports. The devices will automatically go
3447	* into suspend a few ms after the root hub stops sending packets.
3448	* The USB 2.0 spec calls this "global suspend".
3449	*
3450	* However, many USB hubs have a bug: They don't relay wakeup requests
3451	* from a downstream port if the port's suspend feature isn't on.
3452	* Therefore we will turn on the suspend feature if udev or any of its
3453	* descendants is enabled for remote wakeup.
3454	*/
3455	else if (PMSG_IS_AUTO(msg) || usb_wakeup_enabled_descendants(udev) > 0)
3456	status = set_port_feature(hdev: hub->hdev, port1,
3457	USB_PORT_FEAT_SUSPEND);
3458	else {
3459	really_suspend = false;
3460	status = 0;
3461	}
3462	if (status) {
3463	/* Check if the port has been suspended for the timeout case
3464	* to prevent the suspended port from incorrect handling.
3465	*/
3466	if (status == -ETIMEDOUT) {
3467	int ret;
3468	u16 portstatus, portchange;
3469
3470	portstatus = portchange = 0;
3471	ret = usb_hub_port_status(hub, port1, status: &portstatus,
3472	change: &portchange);
3473
3474	dev_dbg(&port_dev->dev,
3475	"suspend timeout, status %04x\n", portstatus);
3476
3477	if (ret == 0 && port_is_suspended(hub, portstatus)) {
3478	status = 0;
3479	goto suspend_done;
3480	}
3481	}
3482
3483	dev_dbg(&port_dev->dev, "can't suspend, status %d\n", status);
3484
3485	/* Try to enable USB3 LTM again */
3486	usb_enable_ltm(udev);
3487	err_ltm:
3488	/* Try to enable USB2 hardware LPM again */
3489	usb_enable_usb2_hardware_lpm(udev);
3490
3491	if (udev->do_remote_wakeup)
3492	(void) usb_disable_remote_wakeup(udev);
3493	err_wakeup:
3494
3495	/* System sleep transitions should never fail */
3496	if (!PMSG_IS_AUTO(msg))
3497	status = 0;
3498	} else {
3499	suspend_done:
3500	dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
3501	(PMSG_IS_AUTO(msg) ? "auto-" : ""),
3502	udev->do_remote_wakeup);
3503	if (really_suspend) {
3504	udev->port_is_suspended = 1;
3505
3506	/* device has up to 10 msec to fully suspend */
3507	msleep(msecs: 10);
3508	}
3509	usb_set_device_state(udev, USB_STATE_SUSPENDED);
3510	}
3511
3512	if (status == 0 && !udev->do_remote_wakeup && udev->persist_enabled
3513	&& test_and_clear_bit(nr: port1, addr: hub->child_usage_bits))
3514	pm_runtime_put_sync(dev: &port_dev->dev);
3515
3516	usb_mark_last_busy(udev: hub->hdev);
3517
3518	usb_unlock_port(port_dev);
3519	return status;
3520	}
3521
3522	/*
3523	* If the USB "suspend" state is in use (rather than "global suspend"),
3524	* many devices will be individually taken out of suspend state using
3525	* special "resume" signaling. This routine kicks in shortly after
3526	* hardware resume signaling is finished, either because of selective
3527	* resume (by host) or remote wakeup (by device) ... now see what changed
3528	* in the tree that's rooted at this device.
3529	*
3530	* If @udev->reset_resume is set then the device is reset before the
3531	* status check is done.
3532	*/
3533	static int finish_port_resume(struct usb_device *udev)
3534	{
3535	int status = 0;
3536	u16 devstatus = 0;
3537
3538	/* caller owns the udev device lock */
3539	dev_dbg(&udev->dev, "%s\n",
3540	udev->reset_resume ? "finish reset-resume" : "finish resume");
3541
3542	/* usb ch9 identifies four variants of SUSPENDED, based on what
3543	* state the device resumes to. Linux currently won't see the
3544	* first two on the host side; they'd be inside hub_port_init()
3545	* during many timeouts, but hub_wq can't suspend until later.
3546	*/
3547	usb_set_device_state(udev, udev->actconfig
3548	? USB_STATE_CONFIGURED
3549	: USB_STATE_ADDRESS);
3550
3551	/* 10.5.4.5 says not to reset a suspended port if the attached
3552	* device is enabled for remote wakeup. Hence the reset
3553	* operation is carried out here, after the port has been
3554	* resumed.
3555	*/
3556	if (udev->reset_resume) {
3557	/*
3558	* If the device morphs or switches modes when it is reset,
3559	* we don't want to perform a reset-resume. We'll fail the
3560	* resume, which will cause a logical disconnect, and then
3561	* the device will be rediscovered.
3562	*/
3563	retry_reset_resume:
3564	if (udev->quirks & USB_QUIRK_RESET)
3565	status = -ENODEV;
3566	else
3567	status = usb_reset_and_verify_device(udev);
3568	}
3569
3570	/* 10.5.4.5 says be sure devices in the tree are still there.
3571	* For now let's assume the device didn't go crazy on resume,
3572	* and device drivers will know about any resume quirks.
3573	*/
3574	if (status == 0) {
3575	devstatus = 0;
3576	status = usb_get_std_status(dev: udev, USB_RECIP_DEVICE, target: 0, data: &devstatus);
3577
3578	/* If a normal resume failed, try doing a reset-resume */
3579	if (status && !udev->reset_resume && udev->persist_enabled) {
3580	dev_dbg(&udev->dev, "retry with reset-resume\n");
3581	udev->reset_resume = 1;
3582	goto retry_reset_resume;
3583	}
3584	}
3585
3586	if (status) {
3587	dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
3588	status);
3589	/*
3590	* There are a few quirky devices which violate the standard
3591	* by claiming to have remote wakeup enabled after a reset,
3592	* which crash if the feature is cleared, hence check for
3593	* udev->reset_resume
3594	*/
3595	} else if (udev->actconfig && !udev->reset_resume) {
3596	if (udev->speed < USB_SPEED_SUPER) {
3597	if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
3598	status = usb_disable_remote_wakeup(udev);
3599	} else {
3600	status = usb_get_std_status(dev: udev, USB_RECIP_INTERFACE, target: 0,
3601	data: &devstatus);
3602	if (!status && devstatus & (USB_INTRF_STAT_FUNC_RW_CAP
3603	| USB_INTRF_STAT_FUNC_RW))
3604	status = usb_disable_remote_wakeup(udev);
3605	}
3606
3607	if (status)
3608	dev_dbg(&udev->dev,
3609	"disable remote wakeup, status %d\n",
3610	status);
3611	status = 0;
3612	}
3613	return status;
3614	}
3615
3616	/*
3617	* There are some SS USB devices which take longer time for link training.
3618	* XHCI specs 4.19.4 says that when Link training is successful, port
3619	* sets CCS bit to 1. So if SW reads port status before successful link
3620	* training, then it will not find device to be present.
3621	* USB Analyzer log with such buggy devices show that in some cases
3622	* device switch on the RX termination after long delay of host enabling
3623	* the VBUS. In few other cases it has been seen that device fails to
3624	* negotiate link training in first attempt. It has been
3625	* reported till now that few devices take as long as 2000 ms to train
3626	* the link after host enabling its VBUS and termination. Following
3627	* routine implements a 2000 ms timeout for link training. If in a case
3628	* link trains before timeout, loop will exit earlier.
3629	*
3630	* There are also some 2.0 hard drive based devices and 3.0 thumb
3631	* drives that, when plugged into a 2.0 only port, take a long
3632	* time to set CCS after VBUS enable.
3633	*
3634	* FIXME: If a device was connected before suspend, but was removed
3635	* while system was asleep, then the loop in the following routine will
3636	* only exit at timeout.
3637	*
3638	* This routine should only be called when persist is enabled.
3639	*/
3640	static int wait_for_connected(struct usb_device *udev,
3641	struct usb_hub *hub, int port1,
3642	u16 *portchange, u16 *portstatus)
3643	{
3644	int status = 0, delay_ms = 0;
3645
3646	while (delay_ms < 2000) {
3647	if (status || *portstatus & USB_PORT_STAT_CONNECTION)
3648	break;
3649	if (!usb_port_is_power_on(hub, portstatus: *portstatus)) {
3650	status = -ENODEV;
3651	break;
3652	}
3653	msleep(msecs: 20);
3654	delay_ms += 20;
3655	status = usb_hub_port_status(hub, port1, status: portstatus, change: portchange);
3656	}
3657	dev_dbg(&udev->dev, "Waited %dms for CONNECT\n", delay_ms);
3658	return status;
3659	}
3660
3661	/*
3662	* usb_port_resume - re-activate a suspended usb device's upstream port
3663	* @udev: device to re-activate, not a root hub
3664	* Context: must be able to sleep; device not locked; pm locks held
3665	*
3666	* This will re-activate the suspended device, increasing power usage
3667	* while letting drivers communicate again with its endpoints.
3668	* USB resume explicitly guarantees that the power session between
3669	* the host and the device is the same as it was when the device
3670	* suspended.
3671	*
3672	* If @udev->reset_resume is set then this routine won't check that the
3673	* port is still enabled. Furthermore, finish_port_resume() above will
3674	* reset @udev. The end result is that a broken power session can be
3675	* recovered and @udev will appear to persist across a loss of VBUS power.
3676	*
3677	* For example, if a host controller doesn't maintain VBUS suspend current
3678	* during a system sleep or is reset when the system wakes up, all the USB
3679	* power sessions below it will be broken. This is especially troublesome
3680	* for mass-storage devices containing mounted filesystems, since the
3681	* device will appear to have disconnected and all the memory mappings
3682	* to it will be lost. Using the USB_PERSIST facility, the device can be
3683	* made to appear as if it had not disconnected.
3684	*
3685	* This facility can be dangerous. Although usb_reset_and_verify_device() makes
3686	* every effort to insure that the same device is present after the
3687	* reset as before, it cannot provide a 100% guarantee. Furthermore it's
3688	* quite possible for a device to remain unaltered but its media to be
3689	* changed. If the user replaces a flash memory card while the system is
3690	* asleep, he will have only himself to blame when the filesystem on the
3691	* new card is corrupted and the system crashes.
3692	*
3693	* Returns 0 on success, else negative errno.
3694	*/
3695	int usb_port_resume(struct usb_device *udev, pm_message_t msg)
3696	{
3697	struct usb_hub *hub = usb_hub_to_struct_hub(hdev: udev->parent);
3698	struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3699	int port1 = udev->portnum;
3700	int status;
3701	u16 portchange, portstatus;
3702
3703	if (!test_and_set_bit(nr: port1, addr: hub->child_usage_bits)) {
3704	status = pm_runtime_resume_and_get(dev: &port_dev->dev);
3705	if (status < 0) {
3706	dev_dbg(&udev->dev, "can't resume usb port, status %d\n",
3707	status);
3708	return status;
3709	}
3710	}
3711
3712	usb_lock_port(port_dev);
3713
3714	/* Skip the initial Clear-Suspend step for a remote wakeup */
3715	status = usb_hub_port_status(hub, port1, status: &portstatus, change: &portchange);
3716	if (status == 0 && !port_is_suspended(hub, portstatus)) {
3717	if (portchange & USB_PORT_STAT_C_SUSPEND)
3718	pm_wakeup_event(dev: &udev->dev, msec: 0);
3719	goto SuspendCleared;
3720	}
3721
3722	/* see 7.1.7.7; affects power usage, but not budgeting */
3723	if (hub_is_superspeed(hdev: hub->hdev))
3724	status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U0);
3725	else
3726	status = usb_clear_port_feature(hdev: hub->hdev,
3727	port1, USB_PORT_FEAT_SUSPEND);
3728	if (status) {
3729	dev_dbg(&port_dev->dev, "can't resume, status %d\n", status);
3730	} else {
3731	/* drive resume for USB_RESUME_TIMEOUT msec */
3732	dev_dbg(&udev->dev, "usb %sresume\n",
3733	(PMSG_IS_AUTO(msg) ? "auto-" : ""));
3734	msleep(USB_RESUME_TIMEOUT);
3735
3736	/* Virtual root hubs can trigger on GET_PORT_STATUS to
3737	* stop resume signaling. Then finish the resume
3738	* sequence.
3739	*/
3740	status = usb_hub_port_status(hub, port1, status: &portstatus, change: &portchange);
3741	}
3742
3743	SuspendCleared:
3744	if (status == 0) {
3745	udev->port_is_suspended = 0;
3746	if (hub_is_superspeed(hdev: hub->hdev)) {
3747	if (portchange & USB_PORT_STAT_C_LINK_STATE)
3748	usb_clear_port_feature(hdev: hub->hdev, port1,
3749	USB_PORT_FEAT_C_PORT_LINK_STATE);
3750	} else {
3751	if (portchange & USB_PORT_STAT_C_SUSPEND)
3752	usb_clear_port_feature(hdev: hub->hdev, port1,
3753	USB_PORT_FEAT_C_SUSPEND);
3754	}
3755
3756	/* TRSMRCY = 10 msec */
3757	msleep(msecs: 10);
3758	}
3759
3760	if (udev->persist_enabled)
3761	status = wait_for_connected(udev, hub, port1, portchange: &portchange,
3762	portstatus: &portstatus);
3763
3764	status = check_port_resume_type(udev,
3765	hub, port1, status, portchange, portstatus);
3766	if (status == 0)
3767	status = finish_port_resume(udev);
3768	if (status < 0) {
3769	dev_dbg(&udev->dev, "can't resume, status %d\n", status);
3770	hub_port_logical_disconnect(hub, port1);
3771	} else {
3772	/* Try to enable USB2 hardware LPM */
3773	usb_enable_usb2_hardware_lpm(udev);
3774
3775	/* Try to enable USB3 LTM */
3776	usb_enable_ltm(udev);
3777	}
3778
3779	usb_unlock_port(port_dev);
3780
3781	return status;
3782	}
3783
3784	int usb_remote_wakeup(struct usb_device *udev)
3785	{
3786	int status = 0;
3787
3788	usb_lock_device(udev);
3789	if (udev->state == USB_STATE_SUSPENDED) {
3790	dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
3791	status = usb_autoresume_device(udev);
3792	if (status == 0) {
3793	/* Let the drivers do their thing, then... */
3794	usb_autosuspend_device(udev);
3795	}
3796	}
3797	usb_unlock_device(udev);
3798	return status;
3799	}
3800
3801	/* Returns 1 if there was a remote wakeup and a connect status change. */
3802	static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
3803	u16 portstatus, u16 portchange)
3804	__must_hold(&port_dev->status_lock)
3805	{
3806	struct usb_port *port_dev = hub->ports[port - 1];
3807	struct usb_device *hdev;
3808	struct usb_device *udev;
3809	int connect_change = 0;
3810	u16 link_state;
3811	int ret;
3812
3813	hdev = hub->hdev;
3814	udev = port_dev->child;
3815	if (!hub_is_superspeed(hdev)) {
3816	if (!(portchange & USB_PORT_STAT_C_SUSPEND))
3817	return 0;
3818	usb_clear_port_feature(hdev, port1: port, USB_PORT_FEAT_C_SUSPEND);
3819	} else {
3820	link_state = portstatus & USB_PORT_STAT_LINK_STATE;
3821	if (!udev || udev->state != USB_STATE_SUSPENDED ||
3822	(link_state != USB_SS_PORT_LS_U0 &&
3823	link_state != USB_SS_PORT_LS_U1 &&
3824	link_state != USB_SS_PORT_LS_U2))
3825	return 0;
3826	}
3827
3828	if (udev) {
3829	/* TRSMRCY = 10 msec */
3830	msleep(msecs: 10);
3831
3832	usb_unlock_port(port_dev);
3833	ret = usb_remote_wakeup(udev);
3834	usb_lock_port(port_dev);
3835	if (ret < 0)
3836	connect_change = 1;
3837	} else {
3838	ret = -ENODEV;
3839	hub_port_disable(hub, port1: port, set_state: 1);
3840	}
3841	dev_dbg(&port_dev->dev, "resume, status %d\n", ret);
3842	return connect_change;
3843	}
3844
3845	static int check_ports_changed(struct usb_hub *hub)
3846	{
3847	int port1;
3848
3849	for (port1 = 1; port1 <= hub->hdev->maxchild; ++port1) {
3850	u16 portstatus, portchange;
3851	int status;
3852
3853	status = usb_hub_port_status(hub, port1, status: &portstatus, change: &portchange);
3854	if (!status && portchange)
3855	return 1;
3856	}
3857	return 0;
3858	}
3859
3860	static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
3861	{
3862	struct usb_hub *hub = usb_get_intfdata(intf);
3863	struct usb_device *hdev = hub->hdev;
3864	unsigned port1;
3865
3866	/*
3867	* Warn if children aren't already suspended.
3868	* Also, add up the number of wakeup-enabled descendants.
3869	*/
3870	hub->wakeup_enabled_descendants = 0;
3871	for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3872	struct usb_port *port_dev = hub->ports[port1 - 1];
3873	struct usb_device *udev = port_dev->child;
3874
3875	if (udev && udev->can_submit) {
3876	dev_warn(&port_dev->dev, "device %s not suspended yet\n",
3877	dev_name(&udev->dev));
3878	if (PMSG_IS_AUTO(msg))
3879	return -EBUSY;
3880	}
3881	if (udev)
3882	hub->wakeup_enabled_descendants +=
3883	usb_wakeup_enabled_descendants(udev);
3884	}
3885
3886	if (hdev->do_remote_wakeup && hub->quirk_check_port_auto_suspend) {
3887	/* check if there are changes pending on hub ports */
3888	if (check_ports_changed(hub)) {
3889	if (PMSG_IS_AUTO(msg))
3890	return -EBUSY;
3891	pm_wakeup_event(dev: &hdev->dev, msec: 2000);
3892	}
3893	}
3894
3895	if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
3896	/* Enable hub to send remote wakeup for all ports. */
3897	for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3898	set_port_feature(hdev,
3899	port1: port1 |
3900	USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
3901	USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
3902	USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
3903	USB_PORT_FEAT_REMOTE_WAKE_MASK);
3904	}
3905	}
3906
3907	dev_dbg(&intf->dev, "%s\n", __func__);
3908
3909	/* stop hub_wq and related activity */
3910	hub_quiesce(hub, type: HUB_SUSPEND);
3911	return 0;
3912	}
3913
3914	/* Report wakeup requests from the ports of a resuming root hub */
3915	static void report_wakeup_requests(struct usb_hub *hub)
3916	{
3917	struct usb_device *hdev = hub->hdev;
3918	struct usb_device *udev;
3919	struct usb_hcd *hcd;
3920	unsigned long resuming_ports;
3921	int i;
3922
3923	if (hdev->parent)
3924	return; /* Not a root hub */
3925
3926	hcd = bus_to_hcd(bus: hdev->bus);
3927	if (hcd->driver->get_resuming_ports) {
3928
3929	/*
3930	* The get_resuming_ports() method returns a bitmap (origin 0)
3931	* of ports which have started wakeup signaling but have not
3932	* yet finished resuming. During system resume we will
3933	* resume all the enabled ports, regardless of any wakeup
3934	* signals, which means the wakeup requests would be lost.
3935	* To prevent this, report them to the PM core here.
3936	*/
3937	resuming_ports = hcd->driver->get_resuming_ports(hcd);
3938	for (i = 0; i < hdev->maxchild; ++i) {
3939	if (test_bit(i, &resuming_ports)) {
3940	udev = hub->ports[i]->child;
3941	if (udev)
3942	pm_wakeup_event(dev: &udev->dev, msec: 0);
3943	}
3944	}
3945	}
3946	}
3947
3948	static int hub_resume(struct usb_interface *intf)
3949	{
3950	struct usb_hub *hub = usb_get_intfdata(intf);
3951
3952	dev_dbg(&intf->dev, "%s\n", __func__);
3953	hub_activate(hub, type: HUB_RESUME);
3954
3955	/*
3956	* This should be called only for system resume, not runtime resume.
3957	* We can't tell the difference here, so some wakeup requests will be
3958	* reported at the wrong time or more than once. This shouldn't
3959	* matter much, so long as they do get reported.
3960	*/
3961	report_wakeup_requests(hub);
3962	return 0;
3963	}
3964
3965	static int hub_reset_resume(struct usb_interface *intf)
3966	{
3967	struct usb_hub *hub = usb_get_intfdata(intf);
3968
3969	dev_dbg(&intf->dev, "%s\n", __func__);
3970	hub_activate(hub, type: HUB_RESET_RESUME);
3971	return 0;
3972	}
3973
3974	/**
3975	* usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3976	* @rhdev: struct usb_device for the root hub
3977	*
3978	* The USB host controller driver calls this function when its root hub
3979	* is resumed and Vbus power has been interrupted or the controller
3980	* has been reset. The routine marks @rhdev as having lost power.
3981	* When the hub driver is resumed it will take notice and carry out
3982	* power-session recovery for all the "USB-PERSIST"-enabled child devices;
3983	* the others will be disconnected.
3984	*/
3985	void usb_root_hub_lost_power(struct usb_device *rhdev)
3986	{
3987	dev_notice(&rhdev->dev, "root hub lost power or was reset\n");
3988	rhdev->reset_resume = 1;
3989	}
3990	EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
3991
3992	static const char * const usb3_lpm_names[] = {
3993	"U0",
3994	"U1",
3995	"U2",
3996	"U3",
3997	};
3998
3999	/*
4000	* Send a Set SEL control transfer to the device, prior to enabling
4001	* device-initiated U1 or U2. This lets the device know the exit latencies from
4002	* the time the device initiates a U1 or U2 exit, to the time it will receive a
4003	* packet from the host.
4004	*
4005	* This function will fail if the SEL or PEL values for udev are greater than
4006	* the maximum allowed values for the link state to be enabled.
4007	*/
4008	static int usb_req_set_sel(struct usb_device *udev)
4009	{
4010	struct usb_set_sel_req *sel_values;
4011	unsigned long long u1_sel;
4012	unsigned long long u1_pel;
4013	unsigned long long u2_sel;
4014	unsigned long long u2_pel;
4015	int ret;
4016
4017	if (!udev->parent || udev->speed < USB_SPEED_SUPER || !udev->lpm_capable)
4018	return 0;
4019
4020	/* Convert SEL and PEL stored in ns to us */
4021	u1_sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
4022	u1_pel = DIV_ROUND_UP(udev->u1_params.pel, 1000);
4023	u2_sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
4024	u2_pel = DIV_ROUND_UP(udev->u2_params.pel, 1000);
4025
4026	/*
4027	* Make sure that the calculated SEL and PEL values for the link
4028	* state we're enabling aren't bigger than the max SEL/PEL
4029	* value that will fit in the SET SEL control transfer.
4030	* Otherwise the device would get an incorrect idea of the exit
4031	* latency for the link state, and could start a device-initiated
4032	* U1/U2 when the exit latencies are too high.
4033	*/
4034	if (u1_sel > USB3_LPM_MAX_U1_SEL_PEL ||
4035	u1_pel > USB3_LPM_MAX_U1_SEL_PEL ||
4036	u2_sel > USB3_LPM_MAX_U2_SEL_PEL ||
4037	u2_pel > USB3_LPM_MAX_U2_SEL_PEL) {
4038	dev_dbg(&udev->dev, "Device-initiated U1/U2 disabled due to long SEL or PEL\n");
4039	return -EINVAL;
4040	}
4041
4042	/*
4043	* usb_enable_lpm() can be called as part of a failed device reset,
4044	* which may be initiated by an error path of a mass storage driver.
4045	* Therefore, use GFP_NOIO.
4046	*/
4047	sel_values = kmalloc(size: sizeof *(sel_values), GFP_NOIO);
4048	if (!sel_values)
4049	return -ENOMEM;
4050
4051	sel_values->u1_sel = u1_sel;
4052	sel_values->u1_pel = u1_pel;
4053	sel_values->u2_sel = cpu_to_le16(u2_sel);
4054	sel_values->u2_pel = cpu_to_le16(u2_pel);
4055
4056	ret = usb_control_msg(dev: udev, usb_sndctrlpipe(udev, 0),
4057	USB_REQ_SET_SEL,
4058	USB_RECIP_DEVICE,
4059	value: 0, index: 0,
4060	data: sel_values, size: sizeof *(sel_values),
4061	USB_CTRL_SET_TIMEOUT);
4062	kfree(objp: sel_values);
4063
4064	if (ret > 0)
4065	udev->lpm_devinit_allow = 1;
4066
4067	return ret;
4068	}
4069
4070	/*
4071	* Enable or disable device-initiated U1 or U2 transitions.
4072	*/
4073	static int usb_set_device_initiated_lpm(struct usb_device *udev,
4074	enum usb3_link_state state, bool enable)
4075	{
4076	int ret;
4077	int feature;
4078
4079	switch (state) {
4080	case USB3_LPM_U1:
4081	feature = USB_DEVICE_U1_ENABLE;
4082	break;
4083	case USB3_LPM_U2:
4084	feature = USB_DEVICE_U2_ENABLE;
4085	break;
4086	default:
4087	dev_warn(&udev->dev, "%s: Can't %s non-U1 or U2 state.\n",
4088	__func__, enable ? "enable" : "disable");
4089	return -EINVAL;
4090	}
4091
4092	if (udev->state != USB_STATE_CONFIGURED) {
4093	dev_dbg(&udev->dev, "%s: Can't %s %s state "
4094	"for unconfigured device.\n",
4095	__func__, enable ? "enable" : "disable",
4096	usb3_lpm_names[state]);
4097	return 0;
4098	}
4099
4100	if (enable) {
4101	/*
4102	* Now send the control transfer to enable device-initiated LPM
4103	* for either U1 or U2.
4104	*/
4105	ret = usb_control_msg(dev: udev, usb_sndctrlpipe(udev, 0),
4106	USB_REQ_SET_FEATURE,
4107	USB_RECIP_DEVICE,
4108	value: feature,
4109	index: 0, NULL, size: 0,
4110	USB_CTRL_SET_TIMEOUT);
4111	} else {
4112	ret = usb_control_msg(dev: udev, usb_sndctrlpipe(udev, 0),
4113	USB_REQ_CLEAR_FEATURE,
4114	USB_RECIP_DEVICE,
4115	value: feature,
4116	index: 0, NULL, size: 0,
4117	USB_CTRL_SET_TIMEOUT);
4118	}
4119	if (ret < 0) {
4120	dev_warn(&udev->dev, "%s of device-initiated %s failed.\n",
4121	enable ? "Enable" : "Disable",
4122	usb3_lpm_names[state]);
4123	return -EBUSY;
4124	}
4125	return 0;
4126	}
4127
4128	static int usb_set_lpm_timeout(struct usb_device *udev,
4129	enum usb3_link_state state, int timeout)
4130	{
4131	int ret;
4132	int feature;
4133
4134	switch (state) {
4135	case USB3_LPM_U1:
4136	feature = USB_PORT_FEAT_U1_TIMEOUT;
4137	break;
4138	case USB3_LPM_U2:
4139	feature = USB_PORT_FEAT_U2_TIMEOUT;
4140	break;
4141	default:
4142	dev_warn(&udev->dev, "%s: Can't set timeout for non-U1 or U2 state.\n",
4143	__func__);
4144	return -EINVAL;
4145	}
4146
4147	if (state == USB3_LPM_U1 && timeout > USB3_LPM_U1_MAX_TIMEOUT &&
4148	timeout != USB3_LPM_DEVICE_INITIATED) {
4149	dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x, "
4150	"which is a reserved value.\n",
4151	usb3_lpm_names[state], timeout);
4152	return -EINVAL;
4153	}
4154
4155	ret = set_port_feature(hdev: udev->parent,
4156	USB_PORT_LPM_TIMEOUT(timeout) | udev->portnum,
4157	feature);
4158	if (ret < 0) {
4159	dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x,"
4160	"error code %i\n", usb3_lpm_names[state],
4161	timeout, ret);
4162	return -EBUSY;
4163	}
4164	if (state == USB3_LPM_U1)
4165	udev->u1_params.timeout = timeout;
4166	else
4167	udev->u2_params.timeout = timeout;
4168	return 0;
4169	}
4170
4171	/*
4172	* Don't allow device intiated U1/U2 if the system exit latency + one bus
4173	* interval is greater than the minimum service interval of any active
4174	* periodic endpoint. See USB 3.2 section 9.4.9
4175	*/
4176	static bool usb_device_may_initiate_lpm(struct usb_device *udev,
4177	enum usb3_link_state state)
4178	{
4179	unsigned int sel; /* us */
4180	int i, j;
4181
4182	if (!udev->lpm_devinit_allow)
4183	return false;
4184
4185	if (state == USB3_LPM_U1)
4186	sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
4187	else if (state == USB3_LPM_U2)
4188	sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
4189	else
4190	return false;
4191
4192	for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
4193	struct usb_interface *intf;
4194	struct usb_endpoint_descriptor *desc;
4195	unsigned int interval;
4196
4197	intf = udev->actconfig->interface[i];
4198	if (!intf)
4199	continue;
4200
4201	for (j = 0; j < intf->cur_altsetting->desc.bNumEndpoints; j++) {
4202	desc = &intf->cur_altsetting->endpoint[j].desc;
4203
4204	if (usb_endpoint_xfer_int(epd: desc) ||
4205	usb_endpoint_xfer_isoc(epd: desc)) {
4206	interval = (1 << (desc->bInterval - 1)) * 125;
4207	if (sel + 125 > interval)
4208	return false;
4209	}
4210	}
4211	}
4212	return true;
4213	}
4214
4215	/*
4216	* Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
4217	* U1/U2 entry.
4218	*
4219	* We will attempt to enable U1 or U2, but there are no guarantees that the
4220	* control transfers to set the hub timeout or enable device-initiated U1/U2
4221	* will be successful.
4222	*
4223	* If the control transfer to enable device-initiated U1/U2 entry fails, then
4224	* hub-initiated U1/U2 will be disabled.
4225	*
4226	* If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
4227	* driver know about it. If that call fails, it should be harmless, and just
4228	* take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
4229	*/
4230	static void usb_enable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
4231	enum usb3_link_state state)
4232	{
4233	int timeout;
4234	__u8 u1_mel;
4235	__le16 u2_mel;
4236
4237	/* Skip if the device BOS descriptor couldn't be read */
4238	if (!udev->bos)
4239	return;
4240
4241	u1_mel = udev->bos->ss_cap->bU1devExitLat;
4242	u2_mel = udev->bos->ss_cap->bU2DevExitLat;
4243
4244	/* If the device says it doesn't have *any* exit latency to come out of
4245	* U1 or U2, it's probably lying. Assume it doesn't implement that link
4246	* state.
4247	*/
4248	if ((state == USB3_LPM_U1 && u1_mel == 0) ||
4249	(state == USB3_LPM_U2 && u2_mel == 0))
4250	return;
4251
4252	/* We allow the host controller to set the U1/U2 timeout internally
4253	* first, so that it can change its schedule to account for the
4254	* additional latency to send data to a device in a lower power
4255	* link state.
4256	*/
4257	timeout = hcd->driver->enable_usb3_lpm_timeout(hcd, udev, state);
4258
4259	/* xHCI host controller doesn't want to enable this LPM state. */
4260	if (timeout == 0)
4261	return;
4262
4263	if (timeout < 0) {
4264	dev_warn(&udev->dev, "Could not enable %s link state, "
4265	"xHCI error %i.\n", usb3_lpm_names[state],
4266	timeout);
4267	return;
4268	}
4269
4270	if (usb_set_lpm_timeout(udev, state, timeout)) {
4271	/* If we can't set the parent hub U1/U2 timeout,
4272	* device-initiated LPM won't be allowed either, so let the xHCI
4273	* host know that this link state won't be enabled.
4274	*/
4275	hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
4276	return;
4277	}
4278
4279	/* Only a configured device will accept the Set Feature
4280	* U1/U2_ENABLE
4281	*/
4282	if (udev->actconfig &&
4283	usb_device_may_initiate_lpm(udev, state)) {
4284	if (usb_set_device_initiated_lpm(udev, state, enable: true)) {
4285	/*
4286	* Request to enable device initiated U1/U2 failed,
4287	* better to turn off lpm in this case.
4288	*/
4289	usb_set_lpm_timeout(udev, state, timeout: 0);
4290	hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
4291	return;
4292	}
4293	}
4294
4295	if (state == USB3_LPM_U1)
4296	udev->usb3_lpm_u1_enabled = 1;
4297	else if (state == USB3_LPM_U2)
4298	udev->usb3_lpm_u2_enabled = 1;
4299	}
4300	/*
4301	* Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
4302	* U1/U2 entry.
4303	*
4304	* If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
4305	* If zero is returned, the parent will not allow the link to go into U1/U2.
4306	*
4307	* If zero is returned, device-initiated U1/U2 entry may still be enabled, but
4308	* it won't have an effect on the bus link state because the parent hub will
4309	* still disallow device-initiated U1/U2 entry.
4310	*
4311	* If zero is returned, the xHCI host controller may still think U1/U2 entry is
4312	* possible. The result will be slightly more bus bandwidth will be taken up
4313	* (to account for U1/U2 exit latency), but it should be harmless.
4314	*/
4315	static int usb_disable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
4316	enum usb3_link_state state)
4317	{
4318	switch (state) {
4319	case USB3_LPM_U1:
4320	case USB3_LPM_U2:
4321	break;
4322	default:
4323	dev_warn(&udev->dev, "%s: Can't disable non-U1 or U2 state.\n",
4324	__func__);
4325	return -EINVAL;
4326	}
4327
4328	if (usb_set_lpm_timeout(udev, state, timeout: 0))
4329	return -EBUSY;
4330
4331	usb_set_device_initiated_lpm(udev, state, enable: false);
4332
4333	if (hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state))
4334	dev_warn(&udev->dev, "Could not disable xHCI %s timeout, "
4335	"bus schedule bandwidth may be impacted.\n",
4336	usb3_lpm_names[state]);
4337
4338	/* As soon as usb_set_lpm_timeout(0) return 0, hub initiated LPM
4339	* is disabled. Hub will disallows link to enter U1/U2 as well,
4340	* even device is initiating LPM. Hence LPM is disabled if hub LPM
4341	* timeout set to 0, no matter device-initiated LPM is disabled or
4342	* not.
4343	*/
4344	if (state == USB3_LPM_U1)
4345	udev->usb3_lpm_u1_enabled = 0;
4346	else if (state == USB3_LPM_U2)
4347	udev->usb3_lpm_u2_enabled = 0;
4348
4349	return 0;
4350	}
4351
4352	/*
4353	* Disable hub-initiated and device-initiated U1 and U2 entry.
4354	* Caller must own the bandwidth_mutex.
4355	*
4356	* This will call usb_enable_lpm() on failure, which will decrement
4357	* lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
4358	*/
4359	int usb_disable_lpm(struct usb_device *udev)
4360	{
4361	struct usb_hcd *hcd;
4362
4363	if (!udev || !udev->parent ||
4364	udev->speed < USB_SPEED_SUPER ||
4365	!udev->lpm_capable ||
4366	udev->state < USB_STATE_CONFIGURED)
4367	return 0;
4368
4369	hcd = bus_to_hcd(bus: udev->bus);
4370	if (!hcd || !hcd->driver->disable_usb3_lpm_timeout)
4371	return 0;
4372
4373	udev->lpm_disable_count++;
4374	if ((udev->u1_params.timeout == 0 && udev->u2_params.timeout == 0))
4375	return 0;
4376
4377	/* If LPM is enabled, attempt to disable it. */
4378	if (usb_disable_link_state(hcd, udev, state: USB3_LPM_U1))
4379	goto enable_lpm;
4380	if (usb_disable_link_state(hcd, udev, state: USB3_LPM_U2))
4381	goto enable_lpm;
4382
4383	return 0;
4384
4385	enable_lpm:
4386	usb_enable_lpm(udev);
4387	return -EBUSY;
4388	}
4389	EXPORT_SYMBOL_GPL(usb_disable_lpm);
4390
4391	/* Grab the bandwidth_mutex before calling usb_disable_lpm() */
4392	int usb_unlocked_disable_lpm(struct usb_device *udev)
4393	{
4394	struct usb_hcd *hcd = bus_to_hcd(bus: udev->bus);
4395	int ret;
4396
4397	if (!hcd)
4398	return -EINVAL;
4399
4400	mutex_lock(hcd->bandwidth_mutex);
4401	ret = usb_disable_lpm(udev);
4402	mutex_unlock(lock: hcd->bandwidth_mutex);
4403
4404	return ret;
4405	}
4406	EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
4407
4408	/*
4409	* Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
4410	* xHCI host policy may prevent U1 or U2 from being enabled.
4411	*
4412	* Other callers may have disabled link PM, so U1 and U2 entry will be disabled
4413	* until the lpm_disable_count drops to zero. Caller must own the
4414	* bandwidth_mutex.
4415	*/
4416	void usb_enable_lpm(struct usb_device *udev)
4417	{
4418	struct usb_hcd *hcd;
4419	struct usb_hub *hub;
4420	struct usb_port *port_dev;
4421
4422	if (!udev || !udev->parent ||
4423	udev->speed < USB_SPEED_SUPER ||
4424	!udev->lpm_capable ||
4425	udev->state < USB_STATE_CONFIGURED)
4426	return;
4427
4428	udev->lpm_disable_count--;
4429	hcd = bus_to_hcd(bus: udev->bus);
4430	/* Double check that we can both enable and disable LPM.
4431	* Device must be configured to accept set feature U1/U2 timeout.
4432	*/
4433	if (!hcd || !hcd->driver->enable_usb3_lpm_timeout ||
4434	!hcd->driver->disable_usb3_lpm_timeout)
4435	return;
4436
4437	if (udev->lpm_disable_count > 0)
4438	return;
4439
4440	hub = usb_hub_to_struct_hub(hdev: udev->parent);
4441	if (!hub)
4442	return;
4443
4444	port_dev = hub->ports[udev->portnum - 1];
4445
4446	if (port_dev->usb3_lpm_u1_permit)
4447	usb_enable_link_state(hcd, udev, state: USB3_LPM_U1);
4448
4449	if (port_dev->usb3_lpm_u2_permit)
4450	usb_enable_link_state(hcd, udev, state: USB3_LPM_U2);
4451	}
4452	EXPORT_SYMBOL_GPL(usb_enable_lpm);
4453
4454	/* Grab the bandwidth_mutex before calling usb_enable_lpm() */
4455	void usb_unlocked_enable_lpm(struct usb_device *udev)
4456	{
4457	struct usb_hcd *hcd = bus_to_hcd(bus: udev->bus);
4458
4459	if (!hcd)
4460	return;
4461
4462	mutex_lock(hcd->bandwidth_mutex);
4463	usb_enable_lpm(udev);
4464	mutex_unlock(lock: hcd->bandwidth_mutex);
4465	}
4466	EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
4467
4468	/* usb3 devices use U3 for disabled, make sure remote wakeup is disabled */
4469	static void hub_usb3_port_prepare_disable(struct usb_hub *hub,
4470	struct usb_port *port_dev)
4471	{
4472	struct usb_device *udev = port_dev->child;
4473	int ret;
4474
4475	if (udev && udev->port_is_suspended && udev->do_remote_wakeup) {
4476	ret = hub_set_port_link_state(hub, port1: port_dev->portnum,
4477	USB_SS_PORT_LS_U0);
4478	if (!ret) {
4479	msleep(USB_RESUME_TIMEOUT);
4480	ret = usb_disable_remote_wakeup(udev);
4481	}
4482	if (ret)
4483	dev_warn(&udev->dev,
4484	"Port disable: can't disable remote wake\n");
4485	udev->do_remote_wakeup = 0;
4486	}
4487	}
4488
4489	#else /* CONFIG_PM */
4490
4491	#define hub_suspend NULL
4492	#define hub_resume NULL
4493	#define hub_reset_resume NULL
4494
4495	static inline void hub_usb3_port_prepare_disable(struct usb_hub *hub,
4496	struct usb_port *port_dev) { }
4497
4498	int usb_disable_lpm(struct usb_device *udev)
4499	{
4500	return 0;
4501	}
4502	EXPORT_SYMBOL_GPL(usb_disable_lpm);
4503
4504	void usb_enable_lpm(struct usb_device *udev) { }
4505	EXPORT_SYMBOL_GPL(usb_enable_lpm);
4506
4507	int usb_unlocked_disable_lpm(struct usb_device *udev)
4508	{
4509	return 0;
4510	}
4511	EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
4512
4513	void usb_unlocked_enable_lpm(struct usb_device *udev) { }
4514	EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
4515
4516	int usb_disable_ltm(struct usb_device *udev)
4517	{
4518	return 0;
4519	}
4520	EXPORT_SYMBOL_GPL(usb_disable_ltm);
4521
4522	void usb_enable_ltm(struct usb_device *udev) { }
4523	EXPORT_SYMBOL_GPL(usb_enable_ltm);
4524
4525	static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
4526	u16 portstatus, u16 portchange)
4527	{
4528	return 0;
4529	}
4530
4531	static int usb_req_set_sel(struct usb_device *udev)
4532	{
4533	return 0;
4534	}
4535
4536	#endif /* CONFIG_PM */
4537
4538	/*
4539	* USB-3 does not have a similar link state as USB-2 that will avoid negotiating
4540	* a connection with a plugged-in cable but will signal the host when the cable
4541	* is unplugged. Disable remote wake and set link state to U3 for USB-3 devices
4542	*/
4543	static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
4544	{
4545	struct usb_port *port_dev = hub->ports[port1 - 1];
4546	struct usb_device *hdev = hub->hdev;
4547	int ret = 0;
4548
4549	if (!hub->error) {
4550	if (hub_is_superspeed(hdev: hub->hdev)) {
4551	hub_usb3_port_prepare_disable(hub, port_dev);
4552	ret = hub_set_port_link_state(hub, port1: port_dev->portnum,
4553	USB_SS_PORT_LS_U3);
4554	} else {
4555	ret = usb_clear_port_feature(hdev, port1,
4556	USB_PORT_FEAT_ENABLE);
4557	}
4558	}
4559	if (port_dev->child && set_state)
4560	usb_set_device_state(port_dev->child, USB_STATE_NOTATTACHED);
4561	if (ret && ret != -ENODEV)
4562	dev_err(&port_dev->dev, "cannot disable (err = %d)\n", ret);
4563	return ret;
4564	}
4565
4566	/*
4567	* usb_port_disable - disable a usb device's upstream port
4568	* @udev: device to disable
4569	* Context: @udev locked, must be able to sleep.
4570	*
4571	* Disables a USB device that isn't in active use.
4572	*/
4573	int usb_port_disable(struct usb_device *udev)
4574	{
4575	struct usb_hub *hub = usb_hub_to_struct_hub(hdev: udev->parent);
4576
4577	return hub_port_disable(hub, port1: udev->portnum, set_state: 0);
4578	}
4579
4580	/* USB 2.0 spec, 7.1.7.3 / fig 7-29:
4581	*
4582	* Between connect detection and reset signaling there must be a delay
4583	* of 100ms at least for debounce and power-settling. The corresponding
4584	* timer shall restart whenever the downstream port detects a disconnect.
4585	*
4586	* Apparently there are some bluetooth and irda-dongles and a number of
4587	* low-speed devices for which this debounce period may last over a second.
4588	* Not covered by the spec - but easy to deal with.
4589	*
4590	* This implementation uses a 1500ms total debounce timeout; if the
4591	* connection isn't stable by then it returns -ETIMEDOUT. It checks
4592	* every 25ms for transient disconnects. When the port status has been
4593	* unchanged for 100ms it returns the port status.
4594	*/
4595	int hub_port_debounce(struct usb_hub *hub, int port1, bool must_be_connected)
4596	{
4597	int ret;
4598	u16 portchange, portstatus;
4599	unsigned connection = 0xffff;
4600	int total_time, stable_time = 0;
4601	struct usb_port *port_dev = hub->ports[port1 - 1];
4602
4603	for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
4604	ret = usb_hub_port_status(hub, port1, status: &portstatus, change: &portchange);
4605	if (ret < 0)
4606	return ret;
4607
4608	if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
4609	(portstatus & USB_PORT_STAT_CONNECTION) == connection) {
4610	if (!must_be_connected ||
4611	(connection == USB_PORT_STAT_CONNECTION))
4612	stable_time += HUB_DEBOUNCE_STEP;
4613	if (stable_time >= HUB_DEBOUNCE_STABLE)
4614	break;
4615	} else {
4616	stable_time = 0;
4617	connection = portstatus & USB_PORT_STAT_CONNECTION;
4618	}
4619
4620	if (portchange & USB_PORT_STAT_C_CONNECTION) {
4621	usb_clear_port_feature(hdev: hub->hdev, port1,
4622	USB_PORT_FEAT_C_CONNECTION);
4623	}
4624
4625	if (total_time >= HUB_DEBOUNCE_TIMEOUT)
4626	break;
4627	msleep(HUB_DEBOUNCE_STEP);
4628	}
4629
4630	dev_dbg(&port_dev->dev, "debounce total %dms stable %dms status 0x%x\n",
4631	total_time, stable_time, portstatus);
4632
4633	if (stable_time < HUB_DEBOUNCE_STABLE)
4634	return -ETIMEDOUT;
4635	return portstatus;
4636	}
4637
4638	void usb_ep0_reinit(struct usb_device *udev)
4639	{
4640	usb_disable_endpoint(dev: udev, epaddr: 0 + USB_DIR_IN, reset_hardware: true);
4641	usb_disable_endpoint(dev: udev, epaddr: 0 + USB_DIR_OUT, reset_hardware: true);
4642	usb_enable_endpoint(dev: udev, ep: &udev->ep0, reset_toggle: true);
4643	}
4644	EXPORT_SYMBOL_GPL(usb_ep0_reinit);
4645
4646	#define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
4647	#define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
4648
4649	static int hub_set_address(struct usb_device *udev, int devnum)
4650	{
4651	int retval;
4652	struct usb_hcd *hcd = bus_to_hcd(bus: udev->bus);
4653
4654	/*
4655	* The host controller will choose the device address,
4656	* instead of the core having chosen it earlier
4657	*/
4658	if (!hcd->driver->address_device && devnum <= 1)
4659	return -EINVAL;
4660	if (udev->state == USB_STATE_ADDRESS)
4661	return 0;
4662	if (udev->state != USB_STATE_DEFAULT)
4663	return -EINVAL;
4664	if (hcd->driver->address_device)
4665	retval = hcd->driver->address_device(hcd, udev);
4666	else
4667	retval = usb_control_msg(dev: udev, usb_sndaddr0pipe(),
4668	USB_REQ_SET_ADDRESS, requesttype: 0, value: devnum, index: 0,
4669	NULL, size: 0, USB_CTRL_SET_TIMEOUT);
4670	if (retval == 0) {
4671	update_devnum(udev, devnum);
4672	/* Device now using proper address. */
4673	usb_set_device_state(udev, USB_STATE_ADDRESS);
4674	usb_ep0_reinit(udev);
4675	}
4676	return retval;
4677	}
4678
4679	/*
4680	* There are reports of USB 3.0 devices that say they support USB 2.0 Link PM
4681	* when they're plugged into a USB 2.0 port, but they don't work when LPM is
4682	* enabled.
4683	*
4684	* Only enable USB 2.0 Link PM if the port is internal (hardwired), or the
4685	* device says it supports the new USB 2.0 Link PM errata by setting the BESL
4686	* support bit in the BOS descriptor.
4687	*/
4688	static void hub_set_initial_usb2_lpm_policy(struct usb_device *udev)
4689	{
4690	struct usb_hub *hub = usb_hub_to_struct_hub(hdev: udev->parent);
4691	int connect_type = USB_PORT_CONNECT_TYPE_UNKNOWN;
4692
4693	if (!udev->usb2_hw_lpm_capable || !udev->bos)
4694	return;
4695
4696	if (hub)
4697	connect_type = hub->ports[udev->portnum - 1]->connect_type;
4698
4699	if ((udev->bos->ext_cap->bmAttributes & cpu_to_le32(USB_BESL_SUPPORT)) ||
4700	connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
4701	udev->usb2_hw_lpm_allowed = 1;
4702	usb_enable_usb2_hardware_lpm(udev);
4703	}
4704	}
4705
4706	static int hub_enable_device(struct usb_device *udev)
4707	{
4708	struct usb_hcd *hcd = bus_to_hcd(bus: udev->bus);
4709
4710	if (!hcd->driver->enable_device)
4711	return 0;
4712	if (udev->state == USB_STATE_ADDRESS)
4713	return 0;
4714	if (udev->state != USB_STATE_DEFAULT)
4715	return -EINVAL;
4716
4717	return hcd->driver->enable_device(hcd, udev);
4718	}
4719
4720	/*
4721	* Get the bMaxPacketSize0 value during initialization by reading the
4722	* device's device descriptor. Since we don't already know this value,
4723	* the transfer is unsafe and it ignores I/O errors, only testing for
4724	* reasonable received values.
4725	*
4726	* For "old scheme" initialization, size will be 8 so we read just the
4727	* start of the device descriptor, which should work okay regardless of
4728	* the actual bMaxPacketSize0 value. For "new scheme" initialization,
4729	* size will be 64 (and buf will point to a sufficiently large buffer),
4730	* which might not be kosher according to the USB spec but it's what
4731	* Windows does and what many devices expect.
4732	*
4733	* Returns: bMaxPacketSize0 or a negative error code.
4734	*/
4735	static int get_bMaxPacketSize0(struct usb_device *udev,
4736	struct usb_device_descriptor *buf, int size, bool first_time)
4737	{
4738	int i, rc;
4739
4740	/*
4741	* Retry on all errors; some devices are flakey.
4742	* 255 is for WUSB devices, we actually need to use
4743	* 512 (WUSB1.0[4.8.1]).
4744	*/
4745	for (i = 0; i < GET_MAXPACKET0_TRIES; ++i) {
4746	/* Start with invalid values in case the transfer fails */
4747	buf->bDescriptorType = buf->bMaxPacketSize0 = 0;
4748	rc = usb_control_msg(dev: udev, usb_rcvaddr0pipe(),
4749	USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
4750	USB_DT_DEVICE << 8, index: 0,
4751	data: buf, size,
4752	timeout: initial_descriptor_timeout);
4753	switch (buf->bMaxPacketSize0) {
4754	case 8: case 16: case 32: case 64: case 9:
4755	if (buf->bDescriptorType == USB_DT_DEVICE) {
4756	rc = buf->bMaxPacketSize0;
4757	break;
4758	}
4759	fallthrough;
4760	default:
4761	if (rc >= 0)
4762	rc = -EPROTO;
4763	break;
4764	}
4765
4766	/*
4767	* Some devices time out if they are powered on
4768	* when already connected. They need a second
4769	* reset, so return early. But only on the first
4770	* attempt, lest we get into a time-out/reset loop.
4771	*/
4772	if (rc > 0 || (rc == -ETIMEDOUT && first_time &&
4773	udev->speed > USB_SPEED_FULL))
4774	break;
4775	}
4776	return rc;
4777	}
4778
4779	#define GET_DESCRIPTOR_BUFSIZE 64
4780
4781	/* Reset device, (re)assign address, get device descriptor.
4782	* Device connection must be stable, no more debouncing needed.
4783	* Returns device in USB_STATE_ADDRESS, except on error.
4784	*
4785	* If this is called for an already-existing device (as part of
4786	* usb_reset_and_verify_device), the caller must own the device lock and
4787	* the port lock. For a newly detected device that is not accessible
4788	* through any global pointers, it's not necessary to lock the device,
4789	* but it is still necessary to lock the port.
4790	*
4791	* For a newly detected device, @dev_descr must be NULL. The device
4792	* descriptor retrieved from the device will then be stored in
4793	* @udev->descriptor. For an already existing device, @dev_descr
4794	* must be non-NULL. The device descriptor will be stored there,
4795	* not in @udev->descriptor, because descriptors for registered
4796	* devices are meant to be immutable.
4797	*/
4798	static int
4799	hub_port_init(struct usb_hub *hub, struct usb_device *udev, int port1,
4800	int retry_counter, struct usb_device_descriptor *dev_descr)
4801	{
4802	struct usb_device *hdev = hub->hdev;
4803	struct usb_hcd *hcd = bus_to_hcd(bus: hdev->bus);
4804	struct usb_port *port_dev = hub->ports[port1 - 1];
4805	int retries, operations, retval, i;
4806	unsigned delay = HUB_SHORT_RESET_TIME;
4807	enum usb_device_speed oldspeed = udev->speed;
4808	const char *speed;
4809	int devnum = udev->devnum;
4810	const char *driver_name;
4811	bool do_new_scheme;
4812	const bool initial = !dev_descr;
4813	int maxp0;
4814	struct usb_device_descriptor *buf, *descr;
4815
4816	buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
4817	if (!buf)
4818	return -ENOMEM;
4819
4820	/* root hub ports have a slightly longer reset period
4821	* (from USB 2.0 spec, section 7.1.7.5)
4822	*/
4823	if (!hdev->parent) {
4824	delay = HUB_ROOT_RESET_TIME;
4825	if (port1 == hdev->bus->otg_port)
4826	hdev->bus->b_hnp_enable = 0;
4827	}
4828
4829	/* Some low speed devices have problems with the quick delay, so */
4830	/* be a bit pessimistic with those devices. RHbug #23670 */
4831	if (oldspeed == USB_SPEED_LOW)
4832	delay = HUB_LONG_RESET_TIME;
4833
4834	/* Reset the device; full speed may morph to high speed */
4835	/* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
4836	retval = hub_port_reset(hub, port1, udev, delay, warm: false);
4837	if (retval < 0) /* error or disconnect */
4838	goto fail;
4839	/* success, speed is known */
4840
4841	retval = -ENODEV;
4842
4843	/* Don't allow speed changes at reset, except usb 3.0 to faster */
4844	if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed &&
4845	!(oldspeed == USB_SPEED_SUPER && udev->speed > oldspeed)) {
4846	dev_dbg(&udev->dev, "device reset changed speed!\n");
4847	goto fail;
4848	}
4849	oldspeed = udev->speed;
4850
4851	if (initial) {
4852	/* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4853	* it's fixed size except for full speed devices.
4854	*/
4855	switch (udev->speed) {
4856	case USB_SPEED_SUPER_PLUS:
4857	case USB_SPEED_SUPER:
4858	udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
4859	break;
4860	case USB_SPEED_HIGH: /* fixed at 64 */
4861	udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4862	break;
4863	case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
4864	/* to determine the ep0 maxpacket size, try to read
4865	* the device descriptor to get bMaxPacketSize0 and
4866	* then correct our initial guess.
4867	*/
4868	udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4869	break;
4870	case USB_SPEED_LOW: /* fixed at 8 */
4871	udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
4872	break;
4873	default:
4874	goto fail;
4875	}
4876	}
4877
4878	speed = usb_speed_string(speed: udev->speed);
4879
4880	/*
4881	* The controller driver may be NULL if the controller device
4882	* is the middle device between platform device and roothub.
4883	* This middle device may not need a device driver due to
4884	* all hardware control can be at platform device driver, this
4885	* platform device is usually a dual-role USB controller device.
4886	*/
4887	if (udev->bus->controller->driver)
4888	driver_name = udev->bus->controller->driver->name;
4889	else
4890	driver_name = udev->bus->sysdev->driver->name;
4891
4892	if (udev->speed < USB_SPEED_SUPER)
4893	dev_info(&udev->dev,
4894	"%s %s USB device number %d using %s\n",
4895	(initial ? "new" : "reset"), speed,
4896	devnum, driver_name);
4897
4898	if (initial) {
4899	/* Set up TT records, if needed */
4900	if (hdev->tt) {
4901	udev->tt = hdev->tt;
4902	udev->ttport = hdev->ttport;
4903	} else if (udev->speed != USB_SPEED_HIGH
4904	&& hdev->speed == USB_SPEED_HIGH) {
4905	if (!hub->tt.hub) {
4906	dev_err(&udev->dev, "parent hub has no TT\n");
4907	retval = -EINVAL;
4908	goto fail;
4909	}
4910	udev->tt = &hub->tt;
4911	udev->ttport = port1;
4912	}
4913	}
4914
4915	/* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4916	* Because device hardware and firmware is sometimes buggy in
4917	* this area, and this is how Linux has done it for ages.
4918	* Change it cautiously.
4919	*
4920	* NOTE: If use_new_scheme() is true we will start by issuing
4921	* a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4922	* so it may help with some non-standards-compliant devices.
4923	* Otherwise we start with SET_ADDRESS and then try to read the
4924	* first 8 bytes of the device descriptor to get the ep0 maxpacket
4925	* value.
4926	*/
4927	do_new_scheme = use_new_scheme(udev, retry: retry_counter, port_dev);
4928
4929	for (retries = 0; retries < GET_DESCRIPTOR_TRIES; (++retries, msleep(msecs: 100))) {
4930	if (hub_port_stop_enumerate(hub, port1, retries)) {
4931	retval = -ENODEV;
4932	break;
4933	}
4934
4935	if (do_new_scheme) {
4936	retval = hub_enable_device(udev);
4937	if (retval < 0) {
4938	dev_err(&udev->dev,
4939	"hub failed to enable device, error %d\n",
4940	retval);
4941	goto fail;
4942	}
4943
4944	maxp0 = get_bMaxPacketSize0(udev, buf,
4945	GET_DESCRIPTOR_BUFSIZE, first_time: retries == 0);
4946	if (maxp0 > 0 && !initial &&
4947	maxp0 != udev->descriptor.bMaxPacketSize0) {
4948	dev_err(&udev->dev, "device reset changed ep0 maxpacket size!\n");
4949	retval = -ENODEV;
4950	goto fail;
4951	}
4952
4953	retval = hub_port_reset(hub, port1, udev, delay, warm: false);
4954	if (retval < 0) /* error or disconnect */
4955	goto fail;
4956	if (oldspeed != udev->speed) {
4957	dev_dbg(&udev->dev,
4958	"device reset changed speed!\n");
4959	retval = -ENODEV;
4960	goto fail;
4961	}
4962	if (maxp0 < 0) {
4963	if (maxp0 != -ENODEV)
4964	dev_err(&udev->dev, "device descriptor read/64, error %d\n",
4965	maxp0);
4966	retval = maxp0;
4967	continue;
4968	}
4969	}
4970
4971	for (operations = 0; operations < SET_ADDRESS_TRIES; ++operations) {
4972	retval = hub_set_address(udev, devnum);
4973	if (retval >= 0)
4974	break;
4975	msleep(msecs: 200);
4976	}
4977	if (retval < 0) {
4978	if (retval != -ENODEV)
4979	dev_err(&udev->dev, "device not accepting address %d, error %d\n",
4980	devnum, retval);
4981	goto fail;
4982	}
4983	if (udev->speed >= USB_SPEED_SUPER) {
4984	devnum = udev->devnum;
4985	dev_info(&udev->dev,
4986	"%s SuperSpeed%s%s USB device number %d using %s\n",
4987	(udev->config) ? "reset" : "new",
4988	(udev->speed == USB_SPEED_SUPER_PLUS) ?
4989	" Plus" : "",
4990	(udev->ssp_rate == USB_SSP_GEN_2x2) ?
4991	" Gen 2x2" :
4992	(udev->ssp_rate == USB_SSP_GEN_2x1) ?
4993	" Gen 2x1" :
4994	(udev->ssp_rate == USB_SSP_GEN_1x2) ?
4995	" Gen 1x2" : "",
4996	devnum, driver_name);
4997	}
4998
4999	/*
5000	* cope with hardware quirkiness:
5001	* - let SET_ADDRESS settle, some device hardware wants it
5002	* - read ep0 maxpacket even for high and low speed,
5003	*/
5004	msleep(msecs: 10);
5005
5006	if (do_new_scheme)
5007	break;
5008
5009	maxp0 = get_bMaxPacketSize0(udev, buf, size: 8, first_time: retries == 0);
5010	if (maxp0 < 0) {
5011	retval = maxp0;
5012	if (retval != -ENODEV)
5013	dev_err(&udev->dev,
5014	"device descriptor read/8, error %d\n",
5015	retval);
5016	} else {
5017	u32 delay;
5018
5019	if (!initial && maxp0 != udev->descriptor.bMaxPacketSize0) {
5020	dev_err(&udev->dev, "device reset changed ep0 maxpacket size!\n");
5021	retval = -ENODEV;
5022	goto fail;
5023	}
5024
5025	delay = udev->parent->hub_delay;
5026	udev->hub_delay = min_t(u32, delay,
5027	USB_TP_TRANSMISSION_DELAY_MAX);
5028	retval = usb_set_isoch_delay(dev: udev);
5029	if (retval) {
5030	dev_dbg(&udev->dev,
5031	"Failed set isoch delay, error %d\n",
5032	retval);
5033	retval = 0;
5034	}
5035	break;
5036	}
5037	}
5038	if (retval)
5039	goto fail;
5040
5041	/*
5042	* Check the ep0 maxpacket guess and correct it if necessary.
5043	* maxp0 is the value stored in the device descriptor;
5044	* i is the value it encodes (logarithmic for SuperSpeed or greater).
5045	*/
5046	i = maxp0;
5047	if (udev->speed >= USB_SPEED_SUPER) {
5048	if (maxp0 <= 16)
5049	i = 1 << maxp0;
5050	else
5051	i = 0; /* Invalid */
5052	}
5053	if (usb_endpoint_maxp(epd: &udev->ep0.desc) == i) {
5054	; /* Initial ep0 maxpacket guess is right */
5055	} else if ((udev->speed == USB_SPEED_FULL ||
5056	udev->speed == USB_SPEED_HIGH) &&
5057	(i == 8 || i == 16 || i == 32 || i == 64)) {
5058	/* Initial guess is wrong; use the descriptor's value */
5059	if (udev->speed == USB_SPEED_FULL)
5060	dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
5061	else
5062	dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
5063	udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
5064	usb_ep0_reinit(udev);
5065	} else {
5066	/* Initial guess is wrong and descriptor's value is invalid */
5067	dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", maxp0);
5068	retval = -EMSGSIZE;
5069	goto fail;
5070	}
5071
5072	descr = usb_get_device_descriptor(udev);
5073	if (IS_ERR(ptr: descr)) {
5074	retval = PTR_ERR(ptr: descr);
5075	if (retval != -ENODEV)
5076	dev_err(&udev->dev, "device descriptor read/all, error %d\n",
5077	retval);
5078	goto fail;
5079	}
5080	if (initial)
5081	udev->descriptor = *descr;
5082	else
5083	*dev_descr = *descr;
5084	kfree(objp: descr);
5085
5086	/*
5087	* Some superspeed devices have finished the link training process
5088	* and attached to a superspeed hub port, but the device descriptor
5089	* got from those devices show they aren't superspeed devices. Warm
5090	* reset the port attached by the devices can fix them.
5091	*/
5092	if ((udev->speed >= USB_SPEED_SUPER) &&
5093	(le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
5094	dev_err(&udev->dev, "got a wrong device descriptor, warm reset device\n");
5095	hub_port_reset(hub, port1, udev, HUB_BH_RESET_TIME, warm: true);
5096	retval = -EINVAL;
5097	goto fail;
5098	}
5099
5100	usb_detect_quirks(udev);
5101
5102	if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
5103	retval = usb_get_bos_descriptor(dev: udev);
5104	if (!retval) {
5105	udev->lpm_capable = usb_device_supports_lpm(udev);
5106	udev->lpm_disable_count = 1;
5107	usb_set_lpm_parameters(udev);
5108	usb_req_set_sel(udev);
5109	}
5110	}
5111
5112	retval = 0;
5113	/* notify HCD that we have a device connected and addressed */
5114	if (hcd->driver->update_device)
5115	hcd->driver->update_device(hcd, udev);
5116	hub_set_initial_usb2_lpm_policy(udev);
5117	fail:
5118	if (retval) {
5119	hub_port_disable(hub, port1, set_state: 0);
5120	update_devnum(udev, devnum); /* for disconnect processing */
5121	}
5122	kfree(objp: buf);
5123	return retval;
5124	}
5125
5126	static void
5127	check_highspeed(struct usb_hub *hub, struct usb_device *udev, int port1)
5128	{
5129	struct usb_qualifier_descriptor *qual;
5130	int status;
5131
5132	if (udev->quirks & USB_QUIRK_DEVICE_QUALIFIER)
5133	return;
5134
5135	qual = kmalloc(size: sizeof *qual, GFP_KERNEL);
5136	if (qual == NULL)
5137	return;
5138
5139	status = usb_get_descriptor(dev: udev, USB_DT_DEVICE_QUALIFIER, descindex: 0,
5140	buf: qual, size: sizeof *qual);
5141	if (status == sizeof *qual) {
5142	dev_info(&udev->dev, "not running at top speed; "
5143	"connect to a high speed hub\n");
5144	/* hub LEDs are probably harder to miss than syslog */
5145	if (hub->has_indicators) {
5146	hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
5147	queue_delayed_work(wq: system_power_efficient_wq,
5148	dwork: &hub->leds, delay: 0);
5149	}
5150	}
5151	kfree(objp: qual);
5152	}
5153
5154	static unsigned
5155	hub_power_remaining(struct usb_hub *hub)
5156	{
5157	struct usb_device *hdev = hub->hdev;
5158	int remaining;
5159	int port1;
5160
5161	if (!hub->limited_power)
5162	return 0;
5163
5164	remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
5165	for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
5166	struct usb_port *port_dev = hub->ports[port1 - 1];
5167	struct usb_device *udev = port_dev->child;
5168	unsigned unit_load;
5169	int delta;
5170
5171	if (!udev)
5172	continue;
5173	if (hub_is_superspeed(hdev: udev))
5174	unit_load = 150;
5175	else
5176	unit_load = 100;
5177
5178	/*
5179	* Unconfigured devices may not use more than one unit load,
5180	* or 8mA for OTG ports
5181	*/
5182	if (udev->actconfig)
5183	delta = usb_get_max_power(udev, c: udev->actconfig);
5184	else if (port1 != udev->bus->otg_port || hdev->parent)
5185	delta = unit_load;
5186	else
5187	delta = 8;
5188	if (delta > hub->mA_per_port)
5189	dev_warn(&port_dev->dev, "%dmA is over %umA budget!\n",
5190	delta, hub->mA_per_port);
5191	remaining -= delta;
5192	}
5193	if (remaining < 0) {
5194	dev_warn(hub->intfdev, "%dmA over power budget!\n",
5195	-remaining);
5196	remaining = 0;
5197	}
5198	return remaining;
5199	}
5200
5201
5202	static int descriptors_changed(struct usb_device *udev,
5203	struct usb_device_descriptor *new_device_descriptor,
5204	struct usb_host_bos *old_bos)
5205	{
5206	int changed = 0;
5207	unsigned index;
5208	unsigned serial_len = 0;
5209	unsigned len;
5210	unsigned old_length;
5211	int length;
5212	char *buf;
5213
5214	if (memcmp(p: &udev->descriptor, q: new_device_descriptor,
5215	size: sizeof(*new_device_descriptor)) != 0)
5216	return 1;
5217
5218	if ((old_bos && !udev->bos) || (!old_bos && udev->bos))
5219	return 1;
5220	if (udev->bos) {
5221	len = le16_to_cpu(udev->bos->desc->wTotalLength);
5222	if (len != le16_to_cpu(old_bos->desc->wTotalLength))
5223	return 1;
5224	if (memcmp(p: udev->bos->desc, q: old_bos->desc, size: len))
5225	return 1;
5226	}
5227
5228	/* Since the idVendor, idProduct, and bcdDevice values in the
5229	* device descriptor haven't changed, we will assume the
5230	* Manufacturer and Product strings haven't changed either.
5231	* But the SerialNumber string could be different (e.g., a
5232	* different flash card of the same brand).
5233	*/
5234	if (udev->serial)
5235	serial_len = strlen(udev->serial) + 1;
5236
5237	len = serial_len;
5238	for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5239	old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5240	len = max(len, old_length);
5241	}
5242
5243	buf = kmalloc(size: len, GFP_NOIO);
5244	if (!buf)
5245	/* assume the worst */
5246	return 1;
5247
5248	for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5249	old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5250	length = usb_get_descriptor(dev: udev, USB_DT_CONFIG, descindex: index, buf,
5251	size: old_length);
5252	if (length != old_length) {
5253	dev_dbg(&udev->dev, "config index %d, error %d\n",
5254	index, length);
5255	changed = 1;
5256	break;
5257	}
5258	if (memcmp(p: buf, q: udev->rawdescriptors[index], size: old_length)
5259	!= 0) {
5260	dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
5261	index,
5262	((struct usb_config_descriptor *) buf)->
5263	bConfigurationValue);
5264	changed = 1;
5265	break;
5266	}
5267	}
5268
5269	if (!changed && serial_len) {
5270	length = usb_string(dev: udev, index: udev->descriptor.iSerialNumber,
5271	buf, size: serial_len);
5272	if (length + 1 != serial_len) {
5273	dev_dbg(&udev->dev, "serial string error %d\n",
5274	length);
5275	changed = 1;
5276	} else if (memcmp(p: buf, q: udev->serial, size: length) != 0) {
5277	dev_dbg(&udev->dev, "serial string changed\n");
5278	changed = 1;
5279	}
5280	}
5281
5282	kfree(objp: buf);
5283	return changed;
5284	}
5285
5286	static void hub_port_connect(struct usb_hub *hub, int port1, u16 portstatus,
5287	u16 portchange)
5288	{
5289	int status = -ENODEV;
5290	int i;
5291	unsigned unit_load;
5292	struct usb_device *hdev = hub->hdev;
5293	struct usb_hcd *hcd = bus_to_hcd(bus: hdev->bus);
5294	struct usb_port *port_dev = hub->ports[port1 - 1];
5295	struct usb_device *udev = port_dev->child;
5296	static int unreliable_port = -1;
5297	bool retry_locked;
5298
5299	/* Disconnect any existing devices under this port */
5300	if (udev) {
5301	if (hcd->usb_phy && !hdev->parent)
5302	usb_phy_notify_disconnect(x: hcd->usb_phy, speed: udev->speed);
5303	usb_disconnect(pdev: &port_dev->child);
5304	}
5305
5306	/* We can forget about a "removed" device when there's a physical
5307	* disconnect or the connect status changes.
5308	*/
5309	if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
5310	(portchange & USB_PORT_STAT_C_CONNECTION))
5311	clear_bit(nr: port1, addr: hub->removed_bits);
5312
5313	if (portchange & (USB_PORT_STAT_C_CONNECTION |
5314	USB_PORT_STAT_C_ENABLE)) {
5315	status = hub_port_debounce_be_stable(hub, port1);
5316	if (status < 0) {
5317	if (status != -ENODEV &&
5318	port1 != unreliable_port &&
5319	printk_ratelimit())
5320	dev_err(&port_dev->dev, "connect-debounce failed\n");
5321	portstatus &= ~USB_PORT_STAT_CONNECTION;
5322	unreliable_port = port1;
5323	} else {
5324	portstatus = status;
5325	}
5326	}
5327
5328	/* Return now if debouncing failed or nothing is connected or
5329	* the device was "removed".
5330	*/
5331	if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
5332	test_bit(port1, hub->removed_bits)) {
5333
5334	/*
5335	* maybe switch power back on (e.g. root hub was reset)
5336	* but only if the port isn't owned by someone else.
5337	*/
5338	if (hub_is_port_power_switchable(hub)
5339	&& !usb_port_is_power_on(hub, portstatus)
5340	&& !port_dev->port_owner)
5341	set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
5342
5343	if (portstatus & USB_PORT_STAT_ENABLE)
5344	goto done;
5345	return;
5346	}
5347	if (hub_is_superspeed(hdev: hub->hdev))
5348	unit_load = 150;
5349	else
5350	unit_load = 100;
5351
5352	status = 0;
5353
5354	for (i = 0; i < PORT_INIT_TRIES; i++) {
5355	if (hub_port_stop_enumerate(hub, port1, retries: i)) {
5356	status = -ENODEV;
5357	break;
5358	}
5359
5360	usb_lock_port(port_dev);
5361	mutex_lock(hcd->address0_mutex);
5362	retry_locked = true;
5363	/* reallocate for each attempt, since references
5364	* to the previous one can escape in various ways
5365	*/
5366	udev = usb_alloc_dev(parent: hdev, hdev->bus, port: port1);
5367	if (!udev) {
5368	dev_err(&port_dev->dev,
5369	"couldn't allocate usb_device\n");
5370	mutex_unlock(lock: hcd->address0_mutex);
5371	usb_unlock_port(port_dev);
5372	goto done;
5373	}
5374
5375	usb_set_device_state(udev, USB_STATE_POWERED);
5376	udev->bus_mA = hub->mA_per_port;
5377	udev->level = hdev->level + 1;
5378
5379	/* Devices connected to SuperSpeed hubs are USB 3.0 or later */
5380	if (hub_is_superspeed(hdev: hub->hdev))
5381	udev->speed = USB_SPEED_SUPER;
5382	else
5383	udev->speed = USB_SPEED_UNKNOWN;
5384
5385	choose_devnum(udev);
5386	if (udev->devnum <= 0) {
5387	status = -ENOTCONN; /* Don't retry */
5388	goto loop;
5389	}
5390
5391	/* reset (non-USB 3.0 devices) and get descriptor */
5392	status = hub_port_init(hub, udev, port1, retry_counter: i, NULL);
5393	if (status < 0)
5394	goto loop;
5395
5396	mutex_unlock(lock: hcd->address0_mutex);
5397	usb_unlock_port(port_dev);
5398	retry_locked = false;
5399
5400	if (udev->quirks & USB_QUIRK_DELAY_INIT)
5401	msleep(msecs: 2000);
5402
5403	/* consecutive bus-powered hubs aren't reliable; they can
5404	* violate the voltage drop budget. if the new child has
5405	* a "powered" LED, users should notice we didn't enable it
5406	* (without reading syslog), even without per-port LEDs
5407	* on the parent.
5408	*/
5409	if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
5410	&& udev->bus_mA <= unit_load) {
5411	u16 devstat;
5412
5413	status = usb_get_std_status(dev: udev, USB_RECIP_DEVICE, target: 0,
5414	data: &devstat);
5415	if (status) {
5416	dev_dbg(&udev->dev, "get status %d ?\n", status);
5417	goto loop_disable;
5418	}
5419	if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
5420	dev_err(&udev->dev,
5421	"can't connect bus-powered hub "
5422	"to this port\n");
5423	if (hub->has_indicators) {
5424	hub->indicator[port1-1] =
5425	INDICATOR_AMBER_BLINK;
5426	queue_delayed_work(
5427	wq: system_power_efficient_wq,
5428	dwork: &hub->leds, delay: 0);
5429	}
5430	status = -ENOTCONN; /* Don't retry */
5431	goto loop_disable;
5432	}
5433	}
5434
5435	/* check for devices running slower than they could */
5436	if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
5437	&& udev->speed == USB_SPEED_FULL
5438	&& highspeed_hubs != 0)
5439	check_highspeed(hub, udev, port1);
5440
5441	/* Store the parent's children[] pointer. At this point
5442	* udev becomes globally accessible, although presumably
5443	* no one will look at it until hdev is unlocked.
5444	*/
5445	status = 0;
5446
5447	mutex_lock(&usb_port_peer_mutex);
5448
5449	/* We mustn't add new devices if the parent hub has
5450	* been disconnected; we would race with the
5451	* recursively_mark_NOTATTACHED() routine.
5452	*/
5453	spin_lock_irq(lock: &device_state_lock);
5454	if (hdev->state == USB_STATE_NOTATTACHED)
5455	status = -ENOTCONN;
5456	else
5457	port_dev->child = udev;
5458	spin_unlock_irq(lock: &device_state_lock);
5459	mutex_unlock(lock: &usb_port_peer_mutex);
5460
5461	/* Run it through the hoops (find a driver, etc) */
5462	if (!status) {
5463	status = usb_new_device(udev);
5464	if (status) {
5465	mutex_lock(&usb_port_peer_mutex);
5466	spin_lock_irq(lock: &device_state_lock);
5467	port_dev->child = NULL;
5468	spin_unlock_irq(lock: &device_state_lock);
5469	mutex_unlock(lock: &usb_port_peer_mutex);
5470	} else {
5471	if (hcd->usb_phy && !hdev->parent)
5472	usb_phy_notify_connect(x: hcd->usb_phy,
5473	speed: udev->speed);
5474	}
5475	}
5476
5477	if (status)
5478	goto loop_disable;
5479
5480	status = hub_power_remaining(hub);
5481	if (status)
5482	dev_dbg(hub->intfdev, "%dmA power budget left\n", status);
5483
5484	return;
5485
5486	loop_disable:
5487	hub_port_disable(hub, port1, set_state: 1);
5488	loop:
5489	usb_ep0_reinit(udev);
5490	release_devnum(udev);
5491	hub_free_dev(udev);
5492	if (retry_locked) {
5493	mutex_unlock(lock: hcd->address0_mutex);
5494	usb_unlock_port(port_dev);
5495	}
5496	usb_put_dev(dev: udev);
5497	if ((status == -ENOTCONN) || (status == -ENOTSUPP))
5498	break;
5499
5500	/* When halfway through our retry count, power-cycle the port */
5501	if (i == (PORT_INIT_TRIES - 1) / 2) {
5502	dev_info(&port_dev->dev, "attempt power cycle\n");
5503	usb_hub_set_port_power(hdev, hub, port1, set: false);
5504	msleep(msecs: 2 * hub_power_on_good_delay(hub));
5505	usb_hub_set_port_power(hdev, hub, port1, set: true);
5506	msleep(msecs: hub_power_on_good_delay(hub));
5507	}
5508	}
5509	if (hub->hdev->parent ||
5510	!hcd->driver->port_handed_over ||
5511	!(hcd->driver->port_handed_over)(hcd, port1)) {
5512	if (status != -ENOTCONN && status != -ENODEV)
5513	dev_err(&port_dev->dev,
5514	"unable to enumerate USB device\n");
5515	}
5516
5517	done:
5518	hub_port_disable(hub, port1, set_state: 1);
5519	if (hcd->driver->relinquish_port && !hub->hdev->parent) {
5520	if (status != -ENOTCONN && status != -ENODEV)
5521	hcd->driver->relinquish_port(hcd, port1);
5522	}
5523	}
5524
5525	/* Handle physical or logical connection change events.
5526	* This routine is called when:
5527	* a port connection-change occurs;
5528	* a port enable-change occurs (often caused by EMI);
5529	* usb_reset_and_verify_device() encounters changed descriptors (as from
5530	* a firmware download)
5531	* caller already locked the hub
5532	*/
5533	static void hub_port_connect_change(struct usb_hub *hub, int port1,
5534	u16 portstatus, u16 portchange)
5535	__must_hold(&port_dev->status_lock)
5536	{
5537	struct usb_port *port_dev = hub->ports[port1 - 1];
5538	struct usb_device *udev = port_dev->child;
5539	struct usb_device_descriptor *descr;
5540	int status = -ENODEV;
5541
5542	dev_dbg(&port_dev->dev, "status %04x, change %04x, %s\n", portstatus,
5543	portchange, portspeed(hub, portstatus));
5544
5545	if (hub->has_indicators) {
5546	set_port_led(hub, port1, HUB_LED_AUTO);
5547	hub->indicator[port1-1] = INDICATOR_AUTO;
5548	}
5549
5550	#ifdef CONFIG_USB_OTG
5551	/* during HNP, don't repeat the debounce */
5552	if (hub->hdev->bus->is_b_host)
5553	portchange &= ~(USB_PORT_STAT_C_CONNECTION |
5554	USB_PORT_STAT_C_ENABLE);
5555	#endif
5556
5557	/* Try to resuscitate an existing device */
5558	if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
5559	udev->state != USB_STATE_NOTATTACHED) {
5560	if (portstatus & USB_PORT_STAT_ENABLE) {
5561	/*
5562	* USB-3 connections are initialized automatically by
5563	* the hostcontroller hardware. Therefore check for
5564	* changed device descriptors before resuscitating the
5565	* device.
5566	*/
5567	descr = usb_get_device_descriptor(udev);
5568	if (IS_ERR(ptr: descr)) {
5569	dev_dbg(&udev->dev,
5570	"can't read device descriptor %ld\n",
5571	PTR_ERR(descr));
5572	} else {
5573	if (descriptors_changed(udev, new_device_descriptor: descr,
5574	old_bos: udev->bos)) {
5575	dev_dbg(&udev->dev,
5576	"device descriptor has changed\n");
5577	} else {
5578	status = 0; /* Nothing to do */
5579	}
5580	kfree(objp: descr);
5581	}
5582	#ifdef CONFIG_PM
5583	} else if (udev->state == USB_STATE_SUSPENDED &&
5584	udev->persist_enabled) {
5585	/* For a suspended device, treat this as a
5586	* remote wakeup event.
5587	*/
5588	usb_unlock_port(port_dev);
5589	status = usb_remote_wakeup(udev);
5590	usb_lock_port(port_dev);
5591	#endif
5592	} else {
5593	/* Don't resuscitate */;
5594	}
5595	}
5596	clear_bit(nr: port1, addr: hub->change_bits);
5597
5598	/* successfully revalidated the connection */
5599	if (status == 0)
5600	return;
5601
5602	usb_unlock_port(port_dev);
5603	hub_port_connect(hub, port1, portstatus, portchange);
5604	usb_lock_port(port_dev);
5605	}
5606
5607	/* Handle notifying userspace about hub over-current events */
5608	static void port_over_current_notify(struct usb_port *port_dev)
5609	{
5610	char *envp[3] = { NULL, NULL, NULL };
5611	struct device *hub_dev;
5612	char *port_dev_path;
5613
5614	sysfs_notify(kobj: &port_dev->dev.kobj, NULL, attr: "over_current_count");
5615
5616	hub_dev = port_dev->dev.parent;
5617
5618	if (!hub_dev)
5619	return;
5620
5621	port_dev_path = kobject_get_path(kobj: &port_dev->dev.kobj, GFP_KERNEL);
5622	if (!port_dev_path)
5623	return;
5624
5625	envp[0] = kasprintf(GFP_KERNEL, fmt: "OVER_CURRENT_PORT=%s", port_dev_path);
5626	if (!envp[0])
5627	goto exit;
5628
5629	envp[1] = kasprintf(GFP_KERNEL, fmt: "OVER_CURRENT_COUNT=%u",
5630	port_dev->over_current_count);
5631	if (!envp[1])
5632	goto exit;
5633
5634	kobject_uevent_env(kobj: &hub_dev->kobj, action: KOBJ_CHANGE, envp);
5635
5636	exit:
5637	kfree(objp: envp[1]);
5638	kfree(objp: envp[0]);
5639	kfree(objp: port_dev_path);
5640	}
5641
5642	static void port_event(struct usb_hub *hub, int port1)
5643	__must_hold(&port_dev->status_lock)
5644	{
5645	int connect_change;
5646	struct usb_port *port_dev = hub->ports[port1 - 1];
5647	struct usb_device *udev = port_dev->child;
5648	struct usb_device *hdev = hub->hdev;
5649	u16 portstatus, portchange;
5650	int i = 0;
5651
5652	connect_change = test_bit(port1, hub->change_bits);
5653	clear_bit(nr: port1, addr: hub->event_bits);
5654	clear_bit(nr: port1, addr: hub->wakeup_bits);
5655
5656	if (usb_hub_port_status(hub, port1, status: &portstatus, change: &portchange) < 0)
5657	return;
5658
5659	if (portchange & USB_PORT_STAT_C_CONNECTION) {
5660	usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_CONNECTION);
5661	connect_change = 1;
5662	}
5663
5664	if (portchange & USB_PORT_STAT_C_ENABLE) {
5665	if (!connect_change)
5666	dev_dbg(&port_dev->dev, "enable change, status %08x\n",
5667	portstatus);
5668	usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_ENABLE);
5669
5670	/*
5671	* EM interference sometimes causes badly shielded USB devices
5672	* to be shutdown by the hub, this hack enables them again.
5673	* Works at least with mouse driver.
5674	*/
5675	if (!(portstatus & USB_PORT_STAT_ENABLE)
5676	&& !connect_change && udev) {
5677	dev_err(&port_dev->dev, "disabled by hub (EMI?), re-enabling...\n");
5678	connect_change = 1;
5679	}
5680	}
5681
5682	if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
5683	u16 status = 0, unused;
5684	port_dev->over_current_count++;
5685	port_over_current_notify(port_dev);
5686
5687	dev_dbg(&port_dev->dev, "over-current change #%u\n",
5688	port_dev->over_current_count);
5689	usb_clear_port_feature(hdev, port1,
5690	USB_PORT_FEAT_C_OVER_CURRENT);
5691	msleep(msecs: 100); /* Cool down */
5692	hub_power_on(hub, do_delay: true);
5693	usb_hub_port_status(hub, port1, status: &status, change: &unused);
5694	if (status & USB_PORT_STAT_OVERCURRENT)
5695	dev_err(&port_dev->dev, "over-current condition\n");
5696	}
5697
5698	if (portchange & USB_PORT_STAT_C_RESET) {
5699	dev_dbg(&port_dev->dev, "reset change\n");
5700	usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_RESET);
5701	}
5702	if ((portchange & USB_PORT_STAT_C_BH_RESET)
5703	&& hub_is_superspeed(hdev)) {
5704	dev_dbg(&port_dev->dev, "warm reset change\n");
5705	usb_clear_port_feature(hdev, port1,
5706	USB_PORT_FEAT_C_BH_PORT_RESET);
5707	}
5708	if (portchange & USB_PORT_STAT_C_LINK_STATE) {
5709	dev_dbg(&port_dev->dev, "link state change\n");
5710	usb_clear_port_feature(hdev, port1,
5711	USB_PORT_FEAT_C_PORT_LINK_STATE);
5712	}
5713	if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
5714	dev_warn(&port_dev->dev, "config error\n");
5715	usb_clear_port_feature(hdev, port1,
5716	USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
5717	}
5718
5719	/* skip port actions that require the port to be powered on */
5720	if (!pm_runtime_active(dev: &port_dev->dev))
5721	return;
5722
5723	/* skip port actions if ignore_event and early_stop are true */
5724	if (port_dev->ignore_event && port_dev->early_stop)
5725	return;
5726
5727	if (hub_handle_remote_wakeup(hub, port: port1, portstatus, portchange))
5728	connect_change = 1;
5729
5730	/*
5731	* Avoid trying to recover a USB3 SS.Inactive port with a warm reset if
5732	* the device was disconnected. A 12ms disconnect detect timer in
5733	* SS.Inactive state transitions the port to RxDetect automatically.
5734	* SS.Inactive link error state is common during device disconnect.
5735	*/
5736	while (hub_port_warm_reset_required(hub, port1, portstatus)) {
5737	if ((i++ < DETECT_DISCONNECT_TRIES) && udev) {
5738	u16 unused;
5739
5740	msleep(msecs: 20);
5741	usb_hub_port_status(hub, port1, status: &portstatus, change: &unused);
5742	dev_dbg(&port_dev->dev, "Wait for inactive link disconnect detect\n");
5743	continue;
5744	} else if (!udev || !(portstatus & USB_PORT_STAT_CONNECTION)
5745	|| udev->state == USB_STATE_NOTATTACHED) {
5746	dev_dbg(&port_dev->dev, "do warm reset, port only\n");
5747	if (hub_port_reset(hub, port1, NULL,
5748	HUB_BH_RESET_TIME, warm: true) < 0)
5749	hub_port_disable(hub, port1, set_state: 1);
5750	} else {
5751	dev_dbg(&port_dev->dev, "do warm reset, full device\n");
5752	usb_unlock_port(port_dev);
5753	usb_lock_device(udev);
5754	usb_reset_device(dev: udev);
5755	usb_unlock_device(udev);
5756	usb_lock_port(port_dev);
5757	connect_change = 0;
5758	}
5759	break;
5760	}
5761
5762	if (connect_change)
5763	hub_port_connect_change(hub, port1, portstatus, portchange);
5764	}
5765
5766	static void hub_event(struct work_struct *work)
5767	{
5768	struct usb_device *hdev;
5769	struct usb_interface *intf;
5770	struct usb_hub *hub;
5771	struct device *hub_dev;
5772	u16 hubstatus;
5773	u16 hubchange;
5774	int i, ret;
5775
5776	hub = container_of(work, struct usb_hub, events);
5777	hdev = hub->hdev;
5778	hub_dev = hub->intfdev;
5779	intf = to_usb_interface(hub_dev);
5780
5781	kcov_remote_start_usb(id: (u64)hdev->bus->busnum);
5782
5783	dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
5784	hdev->state, hdev->maxchild,
5785	/* NOTE: expects max 15 ports... */
5786	(u16) hub->change_bits[0],
5787	(u16) hub->event_bits[0]);
5788
5789	/* Lock the device, then check to see if we were
5790	* disconnected while waiting for the lock to succeed. */
5791	usb_lock_device(hdev);
5792	if (unlikely(hub->disconnected))
5793	goto out_hdev_lock;
5794
5795	/* If the hub has died, clean up after it */
5796	if (hdev->state == USB_STATE_NOTATTACHED) {
5797	hub->error = -ENODEV;
5798	hub_quiesce(hub, type: HUB_DISCONNECT);
5799	goto out_hdev_lock;
5800	}
5801
5802	/* Autoresume */
5803	ret = usb_autopm_get_interface(intf);
5804	if (ret) {
5805	dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
5806	goto out_hdev_lock;
5807	}
5808
5809	/* If this is an inactive hub, do nothing */
5810	if (hub->quiescing)
5811	goto out_autopm;
5812
5813	if (hub->error) {
5814	dev_dbg(hub_dev, "resetting for error %d\n", hub->error);
5815
5816	ret = usb_reset_device(dev: hdev);
5817	if (ret) {
5818	dev_dbg(hub_dev, "error resetting hub: %d\n", ret);
5819	goto out_autopm;
5820	}
5821
5822	hub->nerrors = 0;
5823	hub->error = 0;
5824	}
5825
5826	/* deal with port status changes */
5827	for (i = 1; i <= hdev->maxchild; i++) {
5828	struct usb_port *port_dev = hub->ports[i - 1];
5829
5830	if (test_bit(i, hub->event_bits)
5831	|| test_bit(i, hub->change_bits)
5832	|| test_bit(i, hub->wakeup_bits)) {
5833	/*
5834	* The get_noresume and barrier ensure that if
5835	* the port was in the process of resuming, we
5836	* flush that work and keep the port active for
5837	* the duration of the port_event(). However,
5838	* if the port is runtime pm suspended
5839	* (powered-off), we leave it in that state, run
5840	* an abbreviated port_event(), and move on.
5841	*/
5842	pm_runtime_get_noresume(dev: &port_dev->dev);
5843	pm_runtime_barrier(dev: &port_dev->dev);
5844	usb_lock_port(port_dev);
5845	port_event(hub, port1: i);
5846	usb_unlock_port(port_dev);
5847	pm_runtime_put_sync(dev: &port_dev->dev);
5848	}
5849	}
5850
5851	/* deal with hub status changes */
5852	if (test_and_clear_bit(nr: 0, addr: hub->event_bits) == 0)
5853	; /* do nothing */
5854	else if (hub_hub_status(hub, status: &hubstatus, change: &hubchange) < 0)
5855	dev_err(hub_dev, "get_hub_status failed\n");
5856	else {
5857	if (hubchange & HUB_CHANGE_LOCAL_POWER) {
5858	dev_dbg(hub_dev, "power change\n");
5859	clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
5860	if (hubstatus & HUB_STATUS_LOCAL_POWER)
5861	/* FIXME: Is this always true? */
5862	hub->limited_power = 1;
5863	else
5864	hub->limited_power = 0;
5865	}
5866	if (hubchange & HUB_CHANGE_OVERCURRENT) {
5867	u16 status = 0;
5868	u16 unused;
5869
5870	dev_dbg(hub_dev, "over-current change\n");
5871	clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
5872	msleep(msecs: 500); /* Cool down */
5873	hub_power_on(hub, do_delay: true);
5874	hub_hub_status(hub, status: &status, change: &unused);
5875	if (status & HUB_STATUS_OVERCURRENT)
5876	dev_err(hub_dev, "over-current condition\n");
5877	}
5878	}
5879
5880	out_autopm:
5881	/* Balance the usb_autopm_get_interface() above */
5882	usb_autopm_put_interface_no_suspend(intf);
5883	out_hdev_lock:
5884	usb_unlock_device(hdev);
5885
5886	/* Balance the stuff in kick_hub_wq() and allow autosuspend */
5887	usb_autopm_put_interface(intf);
5888	kref_put(kref: &hub->kref, release: hub_release);
5889
5890	kcov_remote_stop();
5891	}
5892
5893	static const struct usb_device_id hub_id_table[] = {
5894	{ .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5895	| USB_DEVICE_ID_MATCH_PRODUCT
5896	| USB_DEVICE_ID_MATCH_INT_CLASS,
5897	.idVendor = USB_VENDOR_SMSC,
5898	.idProduct = USB_PRODUCT_USB5534B,
5899	.bInterfaceClass = USB_CLASS_HUB,
5900	.driver_info = HUB_QUIRK_DISABLE_AUTOSUSPEND},
5901	{ .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5902	| USB_DEVICE_ID_MATCH_PRODUCT,
5903	.idVendor = USB_VENDOR_CYPRESS,
5904	.idProduct = USB_PRODUCT_CY7C65632,
5905	.driver_info = HUB_QUIRK_DISABLE_AUTOSUSPEND},
5906	{ .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5907	| USB_DEVICE_ID_MATCH_INT_CLASS,
5908	.idVendor = USB_VENDOR_GENESYS_LOGIC,
5909	.bInterfaceClass = USB_CLASS_HUB,
5910	.driver_info = HUB_QUIRK_CHECK_PORT_AUTOSUSPEND},
5911	{ .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5912	| USB_DEVICE_ID_MATCH_PRODUCT,
5913	.idVendor = USB_VENDOR_TEXAS_INSTRUMENTS,
5914	.idProduct = USB_PRODUCT_TUSB8041_USB2,
5915	.driver_info = HUB_QUIRK_DISABLE_AUTOSUSPEND},
5916	{ .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5917	| USB_DEVICE_ID_MATCH_PRODUCT,
5918	.idVendor = USB_VENDOR_TEXAS_INSTRUMENTS,
5919	.idProduct = USB_PRODUCT_TUSB8041_USB3,
5920	.driver_info = HUB_QUIRK_DISABLE_AUTOSUSPEND},
5921	{ .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
5922	.bDeviceClass = USB_CLASS_HUB},
5923	{ .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
5924	.bInterfaceClass = USB_CLASS_HUB},
5925	{ } /* Terminating entry */
5926	};
5927
5928	MODULE_DEVICE_TABLE(usb, hub_id_table);
5929
5930	static struct usb_driver hub_driver = {
5931	.name = "hub",
5932	.probe = hub_probe,
5933	.disconnect = hub_disconnect,
5934	.suspend = hub_suspend,
5935	.resume = hub_resume,
5936	.reset_resume = hub_reset_resume,
5937	.pre_reset = hub_pre_reset,
5938	.post_reset = hub_post_reset,
5939	.unlocked_ioctl = hub_ioctl,
5940	.id_table = hub_id_table,
5941	.supports_autosuspend = 1,
5942	};
5943
5944	int usb_hub_init(void)
5945	{
5946	if (usb_register(&hub_driver) < 0) {
5947	printk(KERN_ERR "%s: can't register hub driver\n",
5948	usbcore_name);
5949	return -1;
5950	}
5951
5952	/*
5953	* The workqueue needs to be freezable to avoid interfering with
5954	* USB-PERSIST port handover. Otherwise it might see that a full-speed
5955	* device was gone before the EHCI controller had handed its port
5956	* over to the companion full-speed controller.
5957	*/
5958	hub_wq = alloc_workqueue(fmt: "usb_hub_wq", flags: WQ_FREEZABLE, max_active: 0);
5959	if (hub_wq)
5960	return 0;
5961
5962	/* Fall through if kernel_thread failed */
5963	usb_deregister(&hub_driver);
5964	pr_err("%s: can't allocate workqueue for usb hub\n", usbcore_name);
5965
5966	return -1;
5967	}
5968
5969	void usb_hub_cleanup(void)
5970	{
5971	destroy_workqueue(wq: hub_wq);
5972
5973	/*
5974	* Hub resources are freed for us by usb_deregister. It calls
5975	* usb_driver_purge on every device which in turn calls that
5976	* devices disconnect function if it is using this driver.
5977	* The hub_disconnect function takes care of releasing the
5978	* individual hub resources. -greg
5979	*/
5980	usb_deregister(&hub_driver);
5981	} /* usb_hub_cleanup() */
5982
5983	/**
5984	* usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5985	* @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5986	*
5987	* WARNING - don't use this routine to reset a composite device
5988	* (one with multiple interfaces owned by separate drivers)!
5989	* Use usb_reset_device() instead.
5990	*
5991	* Do a port reset, reassign the device's address, and establish its
5992	* former operating configuration. If the reset fails, or the device's
5993	* descriptors change from their values before the reset, or the original
5994	* configuration and altsettings cannot be restored, a flag will be set
5995	* telling hub_wq to pretend the device has been disconnected and then
5996	* re-connected. All drivers will be unbound, and the device will be
5997	* re-enumerated and probed all over again.
5998	*
5999	* Return: 0 if the reset succeeded, -ENODEV if the device has been
6000	* flagged for logical disconnection, or some other negative error code
6001	* if the reset wasn't even attempted.
6002	*
6003	* Note:
6004	* The caller must own the device lock and the port lock, the latter is
6005	* taken by usb_reset_device(). For example, it's safe to use
6006	* usb_reset_device() from a driver probe() routine after downloading
6007	* new firmware. For calls that might not occur during probe(), drivers
6008	* should lock the device using usb_lock_device_for_reset().
6009	*
6010	* Locking exception: This routine may also be called from within an
6011	* autoresume handler. Such usage won't conflict with other tasks
6012	* holding the device lock because these tasks should always call
6013	* usb_autopm_resume_device(), thereby preventing any unwanted
6014	* autoresume. The autoresume handler is expected to have already
6015	* acquired the port lock before calling this routine.
6016	*/
6017	static int usb_reset_and_verify_device(struct usb_device *udev)
6018	{
6019	struct usb_device *parent_hdev = udev->parent;
6020	struct usb_hub *parent_hub;
6021	struct usb_hcd *hcd = bus_to_hcd(bus: udev->bus);
6022	struct usb_device_descriptor descriptor;
6023	struct usb_host_bos *bos;
6024	int i, j, ret = 0;
6025	int port1 = udev->portnum;
6026
6027	if (udev->state == USB_STATE_NOTATTACHED ||
6028	udev->state == USB_STATE_SUSPENDED) {
6029	dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
6030	udev->state);
6031	return -EINVAL;
6032	}
6033
6034	if (!parent_hdev)
6035	return -EISDIR;
6036
6037	parent_hub = usb_hub_to_struct_hub(hdev: parent_hdev);
6038
6039	/* Disable USB2 hardware LPM.
6040	* It will be re-enabled by the enumeration process.
6041	*/
6042	usb_disable_usb2_hardware_lpm(udev);
6043
6044	bos = udev->bos;
6045	udev->bos = NULL;
6046
6047	mutex_lock(hcd->address0_mutex);
6048
6049	for (i = 0; i < PORT_INIT_TRIES; ++i) {
6050	if (hub_port_stop_enumerate(hub: parent_hub, port1, retries: i)) {
6051	ret = -ENODEV;
6052	break;
6053	}
6054
6055	/* ep0 maxpacket size may change; let the HCD know about it.
6056	* Other endpoints will be handled by re-enumeration. */
6057	usb_ep0_reinit(udev);
6058	ret = hub_port_init(hub: parent_hub, udev, port1, retry_counter: i, dev_descr: &descriptor);
6059	if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
6060	break;
6061	}
6062	mutex_unlock(lock: hcd->address0_mutex);
6063
6064	if (ret < 0)
6065	goto re_enumerate;
6066
6067	/* Device might have changed firmware (DFU or similar) */
6068	if (descriptors_changed(udev, new_device_descriptor: &descriptor, old_bos: bos)) {
6069	dev_info(&udev->dev, "device firmware changed\n");
6070	goto re_enumerate;
6071	}
6072
6073	/* Restore the device's previous configuration */
6074	if (!udev->actconfig)
6075	goto done;
6076
6077	mutex_lock(hcd->bandwidth_mutex);
6078	ret = usb_hcd_alloc_bandwidth(udev, new_config: udev->actconfig, NULL, NULL);
6079	if (ret < 0) {
6080	dev_warn(&udev->dev,
6081	"Busted HC? Not enough HCD resources for "
6082	"old configuration.\n");
6083	mutex_unlock(lock: hcd->bandwidth_mutex);
6084	goto re_enumerate;
6085	}
6086	ret = usb_control_msg(dev: udev, usb_sndctrlpipe(udev, 0),
6087	USB_REQ_SET_CONFIGURATION, requesttype: 0,
6088	value: udev->actconfig->desc.bConfigurationValue, index: 0,
6089	NULL, size: 0, USB_CTRL_SET_TIMEOUT);
6090	if (ret < 0) {
6091	dev_err(&udev->dev,
6092	"can't restore configuration #%d (error=%d)\n",
6093	udev->actconfig->desc.bConfigurationValue, ret);
6094	mutex_unlock(lock: hcd->bandwidth_mutex);
6095	goto re_enumerate;
6096	}
6097	mutex_unlock(lock: hcd->bandwidth_mutex);
6098	usb_set_device_state(udev, USB_STATE_CONFIGURED);
6099
6100	/* Put interfaces back into the same altsettings as before.
6101	* Don't bother to send the Set-Interface request for interfaces
6102	* that were already in altsetting 0; besides being unnecessary,
6103	* many devices can't handle it. Instead just reset the host-side
6104	* endpoint state.
6105	*/
6106	for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
6107	struct usb_host_config *config = udev->actconfig;
6108	struct usb_interface *intf = config->interface[i];
6109	struct usb_interface_descriptor *desc;
6110
6111	desc = &intf->cur_altsetting->desc;
6112	if (desc->bAlternateSetting == 0) {
6113	usb_disable_interface(dev: udev, intf, reset_hardware: true);
6114	usb_enable_interface(dev: udev, intf, reset_toggles: true);
6115	ret = 0;
6116	} else {
6117	/* Let the bandwidth allocation function know that this
6118	* device has been reset, and it will have to use
6119	* alternate setting 0 as the current alternate setting.
6120	*/
6121	intf->resetting_device = 1;
6122	ret = usb_set_interface(dev: udev, ifnum: desc->bInterfaceNumber,
6123	alternate: desc->bAlternateSetting);
6124	intf->resetting_device = 0;
6125	}
6126	if (ret < 0) {
6127	dev_err(&udev->dev, "failed to restore interface %d "
6128	"altsetting %d (error=%d)\n",
6129	desc->bInterfaceNumber,
6130	desc->bAlternateSetting,
6131	ret);
6132	goto re_enumerate;
6133	}
6134	/* Resetting also frees any allocated streams */
6135	for (j = 0; j < intf->cur_altsetting->desc.bNumEndpoints; j++)
6136	intf->cur_altsetting->endpoint[j].streams = 0;
6137	}
6138
6139	done:
6140	/* Now that the alt settings are re-installed, enable LTM and LPM. */
6141	usb_enable_usb2_hardware_lpm(udev);
6142	usb_unlocked_enable_lpm(udev);
6143	usb_enable_ltm(udev);
6144	usb_release_bos_descriptor(dev: udev);
6145	udev->bos = bos;
6146	return 0;
6147
6148	re_enumerate:
6149	usb_release_bos_descriptor(dev: udev);
6150	udev->bos = bos;
6151	hub_port_logical_disconnect(hub: parent_hub, port1);
6152	return -ENODEV;
6153	}
6154
6155	/**
6156	* usb_reset_device - warn interface drivers and perform a USB port reset
6157	* @udev: device to reset (not in NOTATTACHED state)
6158	*
6159	* Warns all drivers bound to registered interfaces (using their pre_reset
6160	* method), performs the port reset, and then lets the drivers know that
6161	* the reset is over (using their post_reset method).
6162	*
6163	* Return: The same as for usb_reset_and_verify_device().
6164	* However, if a reset is already in progress (for instance, if a
6165	* driver doesn't have pre_reset() or post_reset() callbacks, and while
6166	* being unbound or re-bound during the ongoing reset its disconnect()
6167	* or probe() routine tries to perform a second, nested reset), the
6168	* routine returns -EINPROGRESS.
6169	*
6170	* Note:
6171	* The caller must own the device lock. For example, it's safe to use
6172	* this from a driver probe() routine after downloading new firmware.
6173	* For calls that might not occur during probe(), drivers should lock
6174	* the device using usb_lock_device_for_reset().
6175	*
6176	* If an interface is currently being probed or disconnected, we assume
6177	* its driver knows how to handle resets. For all other interfaces,
6178	* if the driver doesn't have pre_reset and post_reset methods then
6179	* we attempt to unbind it and rebind afterward.
6180	*/
6181	int usb_reset_device(struct usb_device *udev)
6182	{
6183	int ret;
6184	int i;
6185	unsigned int noio_flag;
6186	struct usb_port *port_dev;
6187	struct usb_host_config *config = udev->actconfig;
6188	struct usb_hub *hub = usb_hub_to_struct_hub(hdev: udev->parent);
6189
6190	if (udev->state == USB_STATE_NOTATTACHED) {
6191	dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
6192	udev->state);
6193	return -EINVAL;
6194	}
6195
6196	if (!udev->parent) {
6197	/* this requires hcd-specific logic; see ohci_restart() */
6198	dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
6199	return -EISDIR;
6200	}
6201
6202	if (udev->reset_in_progress)
6203	return -EINPROGRESS;
6204	udev->reset_in_progress = 1;
6205
6206	port_dev = hub->ports[udev->portnum - 1];
6207
6208	/*
6209	* Don't allocate memory with GFP_KERNEL in current
6210	* context to avoid possible deadlock if usb mass
6211	* storage interface or usbnet interface(iSCSI case)
6212	* is included in current configuration. The easist
6213	* approach is to do it for every device reset,
6214	* because the device 'memalloc_noio' flag may have
6215	* not been set before reseting the usb device.
6216	*/
6217	noio_flag = memalloc_noio_save();
6218
6219	/* Prevent autosuspend during the reset */
6220	usb_autoresume_device(udev);
6221
6222	if (config) {
6223	for (i = 0; i < config->desc.bNumInterfaces; ++i) {
6224	struct usb_interface *cintf = config->interface[i];
6225	struct usb_driver *drv;
6226	int unbind = 0;
6227
6228	if (cintf->dev.driver) {
6229	drv = to_usb_driver(cintf->dev.driver);
6230	if (drv->pre_reset && drv->post_reset)
6231	unbind = (drv->pre_reset)(cintf);
6232	else if (cintf->condition ==
6233	USB_INTERFACE_BOUND)
6234	unbind = 1;
6235	if (unbind)
6236	usb_forced_unbind_intf(intf: cintf);
6237	}
6238	}
6239	}
6240
6241	usb_lock_port(port_dev);
6242	ret = usb_reset_and_verify_device(udev);
6243	usb_unlock_port(port_dev);
6244
6245	if (config) {
6246	for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
6247	struct usb_interface *cintf = config->interface[i];
6248	struct usb_driver *drv;
6249	int rebind = cintf->needs_binding;
6250
6251	if (!rebind && cintf->dev.driver) {
6252	drv = to_usb_driver(cintf->dev.driver);
6253	if (drv->post_reset)
6254	rebind = (drv->post_reset)(cintf);
6255	else if (cintf->condition ==
6256	USB_INTERFACE_BOUND)
6257	rebind = 1;
6258	if (rebind)
6259	cintf->needs_binding = 1;
6260	}
6261	}
6262
6263	/* If the reset failed, hub_wq will unbind drivers later */
6264	if (ret == 0)
6265	usb_unbind_and_rebind_marked_interfaces(udev);
6266	}
6267
6268	usb_autosuspend_device(udev);
6269	memalloc_noio_restore(flags: noio_flag);
6270	udev->reset_in_progress = 0;
6271	return ret;
6272	}
6273	EXPORT_SYMBOL_GPL(usb_reset_device);
6274
6275
6276	/**
6277	* usb_queue_reset_device - Reset a USB device from an atomic context
6278	* @iface: USB interface belonging to the device to reset
6279	*
6280	* This function can be used to reset a USB device from an atomic
6281	* context, where usb_reset_device() won't work (as it blocks).
6282	*
6283	* Doing a reset via this method is functionally equivalent to calling
6284	* usb_reset_device(), except for the fact that it is delayed to a
6285	* workqueue. This means that any drivers bound to other interfaces
6286	* might be unbound, as well as users from usbfs in user space.
6287	*
6288	* Corner cases:
6289	*
6290	* - Scheduling two resets at the same time from two different drivers
6291	* attached to two different interfaces of the same device is
6292	* possible; depending on how the driver attached to each interface
6293	* handles ->pre_reset(), the second reset might happen or not.
6294	*
6295	* - If the reset is delayed so long that the interface is unbound from
6296	* its driver, the reset will be skipped.
6297	*
6298	* - This function can be called during .probe(). It can also be called
6299	* during .disconnect(), but doing so is pointless because the reset
6300	* will not occur. If you really want to reset the device during
6301	* .disconnect(), call usb_reset_device() directly -- but watch out
6302	* for nested unbinding issues!
6303	*/
6304	void usb_queue_reset_device(struct usb_interface *iface)
6305	{
6306	if (schedule_work(work: &iface->reset_ws))
6307	usb_get_intf(intf: iface);
6308	}
6309	EXPORT_SYMBOL_GPL(usb_queue_reset_device);
6310
6311	/**
6312	* usb_hub_find_child - Get the pointer of child device
6313	* attached to the port which is specified by @port1.
6314	* @hdev: USB device belonging to the usb hub
6315	* @port1: port num to indicate which port the child device
6316	* is attached to.
6317	*
6318	* USB drivers call this function to get hub's child device
6319	* pointer.
6320	*
6321	* Return: %NULL if input param is invalid and
6322	* child's usb_device pointer if non-NULL.
6323	*/
6324	struct usb_device *usb_hub_find_child(struct usb_device *hdev,
6325	int port1)
6326	{
6327	struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
6328
6329	if (port1 < 1 || port1 > hdev->maxchild)
6330	return NULL;
6331	return hub->ports[port1 - 1]->child;
6332	}
6333	EXPORT_SYMBOL_GPL(usb_hub_find_child);
6334
6335	void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
6336	struct usb_hub_descriptor *desc)
6337	{
6338	struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
6339	enum usb_port_connect_type connect_type;
6340	int i;
6341
6342	if (!hub)
6343	return;
6344
6345	if (!hub_is_superspeed(hdev)) {
6346	for (i = 1; i <= hdev->maxchild; i++) {
6347	struct usb_port *port_dev = hub->ports[i - 1];
6348
6349	connect_type = port_dev->connect_type;
6350	if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
6351	u8 mask = 1 << (i%8);
6352
6353	if (!(desc->u.hs.DeviceRemovable[i/8] & mask)) {
6354	dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
6355	desc->u.hs.DeviceRemovable[i/8] |= mask;
6356	}
6357	}
6358	}
6359	} else {
6360	u16 port_removable = le16_to_cpu(desc->u.ss.DeviceRemovable);
6361
6362	for (i = 1; i <= hdev->maxchild; i++) {
6363	struct usb_port *port_dev = hub->ports[i - 1];
6364
6365	connect_type = port_dev->connect_type;
6366	if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
6367	u16 mask = 1 << i;
6368
6369	if (!(port_removable & mask)) {
6370	dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
6371	port_removable |= mask;
6372	}
6373	}
6374	}
6375
6376	desc->u.ss.DeviceRemovable = cpu_to_le16(port_removable);
6377	}
6378	}
6379
6380	#ifdef CONFIG_ACPI
6381	/**
6382	* usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
6383	* @hdev: USB device belonging to the usb hub
6384	* @port1: port num of the port
6385	*
6386	* Return: Port's acpi handle if successful, %NULL if params are
6387	* invalid.
6388	*/
6389	acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
6390	int port1)
6391	{
6392	struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
6393
6394	if (!hub)
6395	return NULL;
6396
6397	return ACPI_HANDLE(&hub->ports[port1 - 1]->dev);
6398	}
6399	#endif
6400