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