xref: /linux/drivers/usb/core/hub.c (revision f8324e20f8289dffc646d64366332e05eaacab25)
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/kthread.h>
24 #include <linux/mutex.h>
25 #include <linux/freezer.h>
26 #include <linux/pm_runtime.h>
27 
28 #include <asm/uaccess.h>
29 #include <asm/byteorder.h>
30 
31 #include "usb.h"
32 
33 /* if we are in debug mode, always announce new devices */
34 #ifdef DEBUG
35 #ifndef CONFIG_USB_ANNOUNCE_NEW_DEVICES
36 #define CONFIG_USB_ANNOUNCE_NEW_DEVICES
37 #endif
38 #endif
39 
40 struct usb_hub {
41 	struct device		*intfdev;	/* the "interface" device */
42 	struct usb_device	*hdev;
43 	struct kref		kref;
44 	struct urb		*urb;		/* for interrupt polling pipe */
45 
46 	/* buffer for urb ... with extra space in case of babble */
47 	char			(*buffer)[8];
48 	union {
49 		struct usb_hub_status	hub;
50 		struct usb_port_status	port;
51 	}			*status;	/* buffer for status reports */
52 	struct mutex		status_mutex;	/* for the status buffer */
53 
54 	int			error;		/* last reported error */
55 	int			nerrors;	/* track consecutive errors */
56 
57 	struct list_head	event_list;	/* hubs w/data or errs ready */
58 	unsigned long		event_bits[1];	/* status change bitmask */
59 	unsigned long		change_bits[1];	/* ports with logical connect
60 							status change */
61 	unsigned long		busy_bits[1];	/* ports being reset or
62 							resumed */
63 	unsigned long		removed_bits[1]; /* ports with a "removed"
64 							device present */
65 #if USB_MAXCHILDREN > 31 /* 8*sizeof(unsigned long) - 1 */
66 #error event_bits[] is too short!
67 #endif
68 
69 	struct usb_hub_descriptor *descriptor;	/* class descriptor */
70 	struct usb_tt		tt;		/* Transaction Translator */
71 
72 	unsigned		mA_per_port;	/* current for each child */
73 
74 	unsigned		limited_power:1;
75 	unsigned		quiescing:1;
76 	unsigned		disconnected:1;
77 
78 	unsigned		has_indicators:1;
79 	u8			indicator[USB_MAXCHILDREN];
80 	struct delayed_work	leds;
81 	struct delayed_work	init_work;
82 	void			**port_owners;
83 };
84 
85 
86 /* Protect struct usb_device->state and ->children members
87  * Note: Both are also protected by ->dev.sem, except that ->state can
88  * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
89 static DEFINE_SPINLOCK(device_state_lock);
90 
91 /* khubd's worklist and its lock */
92 static DEFINE_SPINLOCK(hub_event_lock);
93 static LIST_HEAD(hub_event_list);	/* List of hubs needing servicing */
94 
95 /* Wakes up khubd */
96 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
97 
98 static struct task_struct *khubd_task;
99 
100 /* cycle leds on hubs that aren't blinking for attention */
101 static int blinkenlights = 0;
102 module_param (blinkenlights, bool, S_IRUGO);
103 MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
104 
105 /*
106  * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
107  * 10 seconds to send reply for the initial 64-byte descriptor request.
108  */
109 /* define initial 64-byte descriptor request timeout in milliseconds */
110 static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
111 module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
112 MODULE_PARM_DESC(initial_descriptor_timeout,
113 		"initial 64-byte descriptor request timeout in milliseconds "
114 		"(default 5000 - 5.0 seconds)");
115 
116 /*
117  * As of 2.6.10 we introduce a new USB device initialization scheme which
118  * closely resembles the way Windows works.  Hopefully it will be compatible
119  * with a wider range of devices than the old scheme.  However some previously
120  * working devices may start giving rise to "device not accepting address"
121  * errors; if that happens the user can try the old scheme by adjusting the
122  * following module parameters.
123  *
124  * For maximum flexibility there are two boolean parameters to control the
125  * hub driver's behavior.  On the first initialization attempt, if the
126  * "old_scheme_first" parameter is set then the old scheme will be used,
127  * otherwise the new scheme is used.  If that fails and "use_both_schemes"
128  * is set, then the driver will make another attempt, using the other scheme.
129  */
130 static int old_scheme_first = 0;
131 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
132 MODULE_PARM_DESC(old_scheme_first,
133 		 "start with the old device initialization scheme");
134 
135 static int use_both_schemes = 1;
136 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
137 MODULE_PARM_DESC(use_both_schemes,
138 		"try the other device initialization scheme if the "
139 		"first one fails");
140 
141 /* Mutual exclusion for EHCI CF initialization.  This interferes with
142  * port reset on some companion controllers.
143  */
144 DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
145 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
146 
147 #define HUB_DEBOUNCE_TIMEOUT	1500
148 #define HUB_DEBOUNCE_STEP	  25
149 #define HUB_DEBOUNCE_STABLE	 100
150 
151 
152 static int usb_reset_and_verify_device(struct usb_device *udev);
153 
154 static inline char *portspeed(int portstatus)
155 {
156 	if (portstatus & USB_PORT_STAT_HIGH_SPEED)
157     		return "480 Mb/s";
158 	else if (portstatus & USB_PORT_STAT_LOW_SPEED)
159 		return "1.5 Mb/s";
160 	else if (portstatus & USB_PORT_STAT_SUPER_SPEED)
161 		return "5.0 Gb/s";
162 	else
163 		return "12 Mb/s";
164 }
165 
166 /* Note that hdev or one of its children must be locked! */
167 static struct usb_hub *hdev_to_hub(struct usb_device *hdev)
168 {
169 	if (!hdev || !hdev->actconfig)
170 		return NULL;
171 	return usb_get_intfdata(hdev->actconfig->interface[0]);
172 }
173 
174 /* USB 2.0 spec Section 11.24.4.5 */
175 static int get_hub_descriptor(struct usb_device *hdev, void *data, int size)
176 {
177 	int i, ret;
178 
179 	for (i = 0; i < 3; i++) {
180 		ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
181 			USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
182 			USB_DT_HUB << 8, 0, data, size,
183 			USB_CTRL_GET_TIMEOUT);
184 		if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
185 			return ret;
186 	}
187 	return -EINVAL;
188 }
189 
190 /*
191  * USB 2.0 spec Section 11.24.2.1
192  */
193 static int clear_hub_feature(struct usb_device *hdev, int feature)
194 {
195 	return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
196 		USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
197 }
198 
199 /*
200  * USB 2.0 spec Section 11.24.2.2
201  */
202 static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
203 {
204 	return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
205 		USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
206 		NULL, 0, 1000);
207 }
208 
209 /*
210  * USB 2.0 spec Section 11.24.2.13
211  */
212 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
213 {
214 	return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
215 		USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
216 		NULL, 0, 1000);
217 }
218 
219 /*
220  * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
221  * for info about using port indicators
222  */
223 static void set_port_led(
224 	struct usb_hub *hub,
225 	int port1,
226 	int selector
227 )
228 {
229 	int status = set_port_feature(hub->hdev, (selector << 8) | port1,
230 			USB_PORT_FEAT_INDICATOR);
231 	if (status < 0)
232 		dev_dbg (hub->intfdev,
233 			"port %d indicator %s status %d\n",
234 			port1,
235 			({ char *s; switch (selector) {
236 			case HUB_LED_AMBER: s = "amber"; break;
237 			case HUB_LED_GREEN: s = "green"; break;
238 			case HUB_LED_OFF: s = "off"; break;
239 			case HUB_LED_AUTO: s = "auto"; break;
240 			default: s = "??"; break;
241 			}; s; }),
242 			status);
243 }
244 
245 #define	LED_CYCLE_PERIOD	((2*HZ)/3)
246 
247 static void led_work (struct work_struct *work)
248 {
249 	struct usb_hub		*hub =
250 		container_of(work, struct usb_hub, leds.work);
251 	struct usb_device	*hdev = hub->hdev;
252 	unsigned		i;
253 	unsigned		changed = 0;
254 	int			cursor = -1;
255 
256 	if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
257 		return;
258 
259 	for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
260 		unsigned	selector, mode;
261 
262 		/* 30%-50% duty cycle */
263 
264 		switch (hub->indicator[i]) {
265 		/* cycle marker */
266 		case INDICATOR_CYCLE:
267 			cursor = i;
268 			selector = HUB_LED_AUTO;
269 			mode = INDICATOR_AUTO;
270 			break;
271 		/* blinking green = sw attention */
272 		case INDICATOR_GREEN_BLINK:
273 			selector = HUB_LED_GREEN;
274 			mode = INDICATOR_GREEN_BLINK_OFF;
275 			break;
276 		case INDICATOR_GREEN_BLINK_OFF:
277 			selector = HUB_LED_OFF;
278 			mode = INDICATOR_GREEN_BLINK;
279 			break;
280 		/* blinking amber = hw attention */
281 		case INDICATOR_AMBER_BLINK:
282 			selector = HUB_LED_AMBER;
283 			mode = INDICATOR_AMBER_BLINK_OFF;
284 			break;
285 		case INDICATOR_AMBER_BLINK_OFF:
286 			selector = HUB_LED_OFF;
287 			mode = INDICATOR_AMBER_BLINK;
288 			break;
289 		/* blink green/amber = reserved */
290 		case INDICATOR_ALT_BLINK:
291 			selector = HUB_LED_GREEN;
292 			mode = INDICATOR_ALT_BLINK_OFF;
293 			break;
294 		case INDICATOR_ALT_BLINK_OFF:
295 			selector = HUB_LED_AMBER;
296 			mode = INDICATOR_ALT_BLINK;
297 			break;
298 		default:
299 			continue;
300 		}
301 		if (selector != HUB_LED_AUTO)
302 			changed = 1;
303 		set_port_led(hub, i + 1, selector);
304 		hub->indicator[i] = mode;
305 	}
306 	if (!changed && blinkenlights) {
307 		cursor++;
308 		cursor %= hub->descriptor->bNbrPorts;
309 		set_port_led(hub, cursor + 1, HUB_LED_GREEN);
310 		hub->indicator[cursor] = INDICATOR_CYCLE;
311 		changed++;
312 	}
313 	if (changed)
314 		schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
315 }
316 
317 /* use a short timeout for hub/port status fetches */
318 #define	USB_STS_TIMEOUT		1000
319 #define	USB_STS_RETRIES		5
320 
321 /*
322  * USB 2.0 spec Section 11.24.2.6
323  */
324 static int get_hub_status(struct usb_device *hdev,
325 		struct usb_hub_status *data)
326 {
327 	int i, status = -ETIMEDOUT;
328 
329 	for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
330 		status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
331 			USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
332 			data, sizeof(*data), USB_STS_TIMEOUT);
333 	}
334 	return status;
335 }
336 
337 /*
338  * USB 2.0 spec Section 11.24.2.7
339  */
340 static int get_port_status(struct usb_device *hdev, int port1,
341 		struct usb_port_status *data)
342 {
343 	int i, status = -ETIMEDOUT;
344 
345 	for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
346 		status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
347 			USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
348 			data, sizeof(*data), USB_STS_TIMEOUT);
349 	}
350 	return status;
351 }
352 
353 static int hub_port_status(struct usb_hub *hub, int port1,
354 		u16 *status, u16 *change)
355 {
356 	int ret;
357 
358 	mutex_lock(&hub->status_mutex);
359 	ret = get_port_status(hub->hdev, port1, &hub->status->port);
360 	if (ret < 4) {
361 		dev_err(hub->intfdev,
362 			"%s failed (err = %d)\n", __func__, ret);
363 		if (ret >= 0)
364 			ret = -EIO;
365 	} else {
366 		*status = le16_to_cpu(hub->status->port.wPortStatus);
367 		*change = le16_to_cpu(hub->status->port.wPortChange);
368 		ret = 0;
369 	}
370 	mutex_unlock(&hub->status_mutex);
371 	return ret;
372 }
373 
374 static void kick_khubd(struct usb_hub *hub)
375 {
376 	unsigned long	flags;
377 
378 	spin_lock_irqsave(&hub_event_lock, flags);
379 	if (!hub->disconnected && list_empty(&hub->event_list)) {
380 		list_add_tail(&hub->event_list, &hub_event_list);
381 
382 		/* Suppress autosuspend until khubd runs */
383 		usb_autopm_get_interface_no_resume(
384 				to_usb_interface(hub->intfdev));
385 		wake_up(&khubd_wait);
386 	}
387 	spin_unlock_irqrestore(&hub_event_lock, flags);
388 }
389 
390 void usb_kick_khubd(struct usb_device *hdev)
391 {
392 	struct usb_hub *hub = hdev_to_hub(hdev);
393 
394 	if (hub)
395 		kick_khubd(hub);
396 }
397 
398 
399 /* completion function, fires on port status changes and various faults */
400 static void hub_irq(struct urb *urb)
401 {
402 	struct usb_hub *hub = urb->context;
403 	int status = urb->status;
404 	unsigned i;
405 	unsigned long bits;
406 
407 	switch (status) {
408 	case -ENOENT:		/* synchronous unlink */
409 	case -ECONNRESET:	/* async unlink */
410 	case -ESHUTDOWN:	/* hardware going away */
411 		return;
412 
413 	default:		/* presumably an error */
414 		/* Cause a hub reset after 10 consecutive errors */
415 		dev_dbg (hub->intfdev, "transfer --> %d\n", status);
416 		if ((++hub->nerrors < 10) || hub->error)
417 			goto resubmit;
418 		hub->error = status;
419 		/* FALL THROUGH */
420 
421 	/* let khubd handle things */
422 	case 0:			/* we got data:  port status changed */
423 		bits = 0;
424 		for (i = 0; i < urb->actual_length; ++i)
425 			bits |= ((unsigned long) ((*hub->buffer)[i]))
426 					<< (i*8);
427 		hub->event_bits[0] = bits;
428 		break;
429 	}
430 
431 	hub->nerrors = 0;
432 
433 	/* Something happened, let khubd figure it out */
434 	kick_khubd(hub);
435 
436 resubmit:
437 	if (hub->quiescing)
438 		return;
439 
440 	if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
441 			&& status != -ENODEV && status != -EPERM)
442 		dev_err (hub->intfdev, "resubmit --> %d\n", status);
443 }
444 
445 /* USB 2.0 spec Section 11.24.2.3 */
446 static inline int
447 hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
448 {
449 	return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
450 			       HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
451 			       tt, NULL, 0, 1000);
452 }
453 
454 /*
455  * enumeration blocks khubd for a long time. we use keventd instead, since
456  * long blocking there is the exception, not the rule.  accordingly, HCDs
457  * talking to TTs must queue control transfers (not just bulk and iso), so
458  * both can talk to the same hub concurrently.
459  */
460 static void hub_tt_work(struct work_struct *work)
461 {
462 	struct usb_hub		*hub =
463 		container_of(work, struct usb_hub, tt.clear_work);
464 	unsigned long		flags;
465 	int			limit = 100;
466 
467 	spin_lock_irqsave (&hub->tt.lock, flags);
468 	while (--limit && !list_empty (&hub->tt.clear_list)) {
469 		struct list_head	*next;
470 		struct usb_tt_clear	*clear;
471 		struct usb_device	*hdev = hub->hdev;
472 		const struct hc_driver	*drv;
473 		int			status;
474 
475 		next = hub->tt.clear_list.next;
476 		clear = list_entry (next, struct usb_tt_clear, clear_list);
477 		list_del (&clear->clear_list);
478 
479 		/* drop lock so HCD can concurrently report other TT errors */
480 		spin_unlock_irqrestore (&hub->tt.lock, flags);
481 		status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
482 		if (status)
483 			dev_err (&hdev->dev,
484 				"clear tt %d (%04x) error %d\n",
485 				clear->tt, clear->devinfo, status);
486 
487 		/* Tell the HCD, even if the operation failed */
488 		drv = clear->hcd->driver;
489 		if (drv->clear_tt_buffer_complete)
490 			(drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
491 
492 		kfree(clear);
493 		spin_lock_irqsave(&hub->tt.lock, flags);
494 	}
495 	spin_unlock_irqrestore (&hub->tt.lock, flags);
496 }
497 
498 /**
499  * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
500  * @urb: an URB associated with the failed or incomplete split transaction
501  *
502  * High speed HCDs use this to tell the hub driver that some split control or
503  * bulk transaction failed in a way that requires clearing internal state of
504  * a transaction translator.  This is normally detected (and reported) from
505  * interrupt context.
506  *
507  * It may not be possible for that hub to handle additional full (or low)
508  * speed transactions until that state is fully cleared out.
509  */
510 int usb_hub_clear_tt_buffer(struct urb *urb)
511 {
512 	struct usb_device	*udev = urb->dev;
513 	int			pipe = urb->pipe;
514 	struct usb_tt		*tt = udev->tt;
515 	unsigned long		flags;
516 	struct usb_tt_clear	*clear;
517 
518 	/* we've got to cope with an arbitrary number of pending TT clears,
519 	 * since each TT has "at least two" buffers that can need it (and
520 	 * there can be many TTs per hub).  even if they're uncommon.
521 	 */
522 	if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
523 		dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
524 		/* FIXME recover somehow ... RESET_TT? */
525 		return -ENOMEM;
526 	}
527 
528 	/* info that CLEAR_TT_BUFFER needs */
529 	clear->tt = tt->multi ? udev->ttport : 1;
530 	clear->devinfo = usb_pipeendpoint (pipe);
531 	clear->devinfo |= udev->devnum << 4;
532 	clear->devinfo |= usb_pipecontrol (pipe)
533 			? (USB_ENDPOINT_XFER_CONTROL << 11)
534 			: (USB_ENDPOINT_XFER_BULK << 11);
535 	if (usb_pipein (pipe))
536 		clear->devinfo |= 1 << 15;
537 
538 	/* info for completion callback */
539 	clear->hcd = bus_to_hcd(udev->bus);
540 	clear->ep = urb->ep;
541 
542 	/* tell keventd to clear state for this TT */
543 	spin_lock_irqsave (&tt->lock, flags);
544 	list_add_tail (&clear->clear_list, &tt->clear_list);
545 	schedule_work(&tt->clear_work);
546 	spin_unlock_irqrestore (&tt->lock, flags);
547 	return 0;
548 }
549 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
550 
551 /* If do_delay is false, return the number of milliseconds the caller
552  * needs to delay.
553  */
554 static unsigned hub_power_on(struct usb_hub *hub, bool do_delay)
555 {
556 	int port1;
557 	unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
558 	unsigned delay;
559 	u16 wHubCharacteristics =
560 			le16_to_cpu(hub->descriptor->wHubCharacteristics);
561 
562 	/* Enable power on each port.  Some hubs have reserved values
563 	 * of LPSM (> 2) in their descriptors, even though they are
564 	 * USB 2.0 hubs.  Some hubs do not implement port-power switching
565 	 * but only emulate it.  In all cases, the ports won't work
566 	 * unless we send these messages to the hub.
567 	 */
568 	if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
569 		dev_dbg(hub->intfdev, "enabling power on all ports\n");
570 	else
571 		dev_dbg(hub->intfdev, "trying to enable port power on "
572 				"non-switchable hub\n");
573 	for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
574 		set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
575 
576 	/* Wait at least 100 msec for power to become stable */
577 	delay = max(pgood_delay, (unsigned) 100);
578 	if (do_delay)
579 		msleep(delay);
580 	return delay;
581 }
582 
583 static int hub_hub_status(struct usb_hub *hub,
584 		u16 *status, u16 *change)
585 {
586 	int ret;
587 
588 	mutex_lock(&hub->status_mutex);
589 	ret = get_hub_status(hub->hdev, &hub->status->hub);
590 	if (ret < 0)
591 		dev_err (hub->intfdev,
592 			"%s failed (err = %d)\n", __func__, ret);
593 	else {
594 		*status = le16_to_cpu(hub->status->hub.wHubStatus);
595 		*change = le16_to_cpu(hub->status->hub.wHubChange);
596 		ret = 0;
597 	}
598 	mutex_unlock(&hub->status_mutex);
599 	return ret;
600 }
601 
602 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
603 {
604 	struct usb_device *hdev = hub->hdev;
605 	int ret = 0;
606 
607 	if (hdev->children[port1-1] && set_state)
608 		usb_set_device_state(hdev->children[port1-1],
609 				USB_STATE_NOTATTACHED);
610 	if (!hub->error)
611 		ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
612 	if (ret)
613 		dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
614 				port1, ret);
615 	return ret;
616 }
617 
618 /*
619  * Disable a port and mark a logical connnect-change event, so that some
620  * time later khubd will disconnect() any existing usb_device on the port
621  * and will re-enumerate if there actually is a device attached.
622  */
623 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
624 {
625 	dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
626 	hub_port_disable(hub, port1, 1);
627 
628 	/* FIXME let caller ask to power down the port:
629 	 *  - some devices won't enumerate without a VBUS power cycle
630 	 *  - SRP saves power that way
631 	 *  - ... new call, TBD ...
632 	 * That's easy if this hub can switch power per-port, and
633 	 * khubd reactivates the port later (timer, SRP, etc).
634 	 * Powerdown must be optional, because of reset/DFU.
635 	 */
636 
637 	set_bit(port1, hub->change_bits);
638  	kick_khubd(hub);
639 }
640 
641 /**
642  * usb_remove_device - disable a device's port on its parent hub
643  * @udev: device to be disabled and removed
644  * Context: @udev locked, must be able to sleep.
645  *
646  * After @udev's port has been disabled, khubd is notified and it will
647  * see that the device has been disconnected.  When the device is
648  * physically unplugged and something is plugged in, the events will
649  * be received and processed normally.
650  */
651 int usb_remove_device(struct usb_device *udev)
652 {
653 	struct usb_hub *hub;
654 	struct usb_interface *intf;
655 
656 	if (!udev->parent)	/* Can't remove a root hub */
657 		return -EINVAL;
658 	hub = hdev_to_hub(udev->parent);
659 	intf = to_usb_interface(hub->intfdev);
660 
661 	usb_autopm_get_interface(intf);
662 	set_bit(udev->portnum, hub->removed_bits);
663 	hub_port_logical_disconnect(hub, udev->portnum);
664 	usb_autopm_put_interface(intf);
665 	return 0;
666 }
667 
668 enum hub_activation_type {
669 	HUB_INIT, HUB_INIT2, HUB_INIT3,		/* INITs must come first */
670 	HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
671 };
672 
673 static void hub_init_func2(struct work_struct *ws);
674 static void hub_init_func3(struct work_struct *ws);
675 
676 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
677 {
678 	struct usb_device *hdev = hub->hdev;
679 	int port1;
680 	int status;
681 	bool need_debounce_delay = false;
682 	unsigned delay;
683 
684 	/* Continue a partial initialization */
685 	if (type == HUB_INIT2)
686 		goto init2;
687 	if (type == HUB_INIT3)
688 		goto init3;
689 
690 	/* After a resume, port power should still be on.
691 	 * For any other type of activation, turn it on.
692 	 */
693 	if (type != HUB_RESUME) {
694 
695 		/* Speed up system boot by using a delayed_work for the
696 		 * hub's initial power-up delays.  This is pretty awkward
697 		 * and the implementation looks like a home-brewed sort of
698 		 * setjmp/longjmp, but it saves at least 100 ms for each
699 		 * root hub (assuming usbcore is compiled into the kernel
700 		 * rather than as a module).  It adds up.
701 		 *
702 		 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
703 		 * because for those activation types the ports have to be
704 		 * operational when we return.  In theory this could be done
705 		 * for HUB_POST_RESET, but it's easier not to.
706 		 */
707 		if (type == HUB_INIT) {
708 			delay = hub_power_on(hub, false);
709 			PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func2);
710 			schedule_delayed_work(&hub->init_work,
711 					msecs_to_jiffies(delay));
712 
713 			/* Suppress autosuspend until init is done */
714 			usb_autopm_get_interface_no_resume(
715 					to_usb_interface(hub->intfdev));
716 			return;		/* Continues at init2: below */
717 		} else {
718 			hub_power_on(hub, true);
719 		}
720 	}
721  init2:
722 
723 	/* Check each port and set hub->change_bits to let khubd know
724 	 * which ports need attention.
725 	 */
726 	for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
727 		struct usb_device *udev = hdev->children[port1-1];
728 		u16 portstatus, portchange;
729 
730 		portstatus = portchange = 0;
731 		status = hub_port_status(hub, port1, &portstatus, &portchange);
732 		if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
733 			dev_dbg(hub->intfdev,
734 					"port %d: status %04x change %04x\n",
735 					port1, portstatus, portchange);
736 
737 		/* After anything other than HUB_RESUME (i.e., initialization
738 		 * or any sort of reset), every port should be disabled.
739 		 * Unconnected ports should likewise be disabled (paranoia),
740 		 * and so should ports for which we have no usb_device.
741 		 */
742 		if ((portstatus & USB_PORT_STAT_ENABLE) && (
743 				type != HUB_RESUME ||
744 				!(portstatus & USB_PORT_STAT_CONNECTION) ||
745 				!udev ||
746 				udev->state == USB_STATE_NOTATTACHED)) {
747 			/*
748 			 * USB3 protocol ports will automatically transition
749 			 * to Enabled state when detect an USB3.0 device attach.
750 			 * Do not disable USB3 protocol ports.
751 			 * FIXME: USB3 root hub and external hubs are treated
752 			 * differently here.
753 			 */
754 			if (hdev->descriptor.bDeviceProtocol != 3 ||
755 			    (!hdev->parent &&
756 			     !(portstatus & USB_PORT_STAT_SUPER_SPEED))) {
757 				clear_port_feature(hdev, port1,
758 						   USB_PORT_FEAT_ENABLE);
759 				portstatus &= ~USB_PORT_STAT_ENABLE;
760 			}
761 		}
762 
763 		/* Clear status-change flags; we'll debounce later */
764 		if (portchange & USB_PORT_STAT_C_CONNECTION) {
765 			need_debounce_delay = true;
766 			clear_port_feature(hub->hdev, port1,
767 					USB_PORT_FEAT_C_CONNECTION);
768 		}
769 		if (portchange & USB_PORT_STAT_C_ENABLE) {
770 			need_debounce_delay = true;
771 			clear_port_feature(hub->hdev, port1,
772 					USB_PORT_FEAT_C_ENABLE);
773 		}
774 
775 		/* We can forget about a "removed" device when there's a
776 		 * physical disconnect or the connect status changes.
777 		 */
778 		if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
779 				(portchange & USB_PORT_STAT_C_CONNECTION))
780 			clear_bit(port1, hub->removed_bits);
781 
782 		if (!udev || udev->state == USB_STATE_NOTATTACHED) {
783 			/* Tell khubd to disconnect the device or
784 			 * check for a new connection
785 			 */
786 			if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
787 				set_bit(port1, hub->change_bits);
788 
789 		} else if (portstatus & USB_PORT_STAT_ENABLE) {
790 			/* The power session apparently survived the resume.
791 			 * If there was an overcurrent or suspend change
792 			 * (i.e., remote wakeup request), have khubd
793 			 * take care of it.
794 			 */
795 			if (portchange)
796 				set_bit(port1, hub->change_bits);
797 
798 		} else if (udev->persist_enabled) {
799 #ifdef CONFIG_PM
800 			udev->reset_resume = 1;
801 #endif
802 			set_bit(port1, hub->change_bits);
803 
804 		} else {
805 			/* The power session is gone; tell khubd */
806 			usb_set_device_state(udev, USB_STATE_NOTATTACHED);
807 			set_bit(port1, hub->change_bits);
808 		}
809 	}
810 
811 	/* If no port-status-change flags were set, we don't need any
812 	 * debouncing.  If flags were set we can try to debounce the
813 	 * ports all at once right now, instead of letting khubd do them
814 	 * one at a time later on.
815 	 *
816 	 * If any port-status changes do occur during this delay, khubd
817 	 * will see them later and handle them normally.
818 	 */
819 	if (need_debounce_delay) {
820 		delay = HUB_DEBOUNCE_STABLE;
821 
822 		/* Don't do a long sleep inside a workqueue routine */
823 		if (type == HUB_INIT2) {
824 			PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func3);
825 			schedule_delayed_work(&hub->init_work,
826 					msecs_to_jiffies(delay));
827 			return;		/* Continues at init3: below */
828 		} else {
829 			msleep(delay);
830 		}
831 	}
832  init3:
833 	hub->quiescing = 0;
834 
835 	status = usb_submit_urb(hub->urb, GFP_NOIO);
836 	if (status < 0)
837 		dev_err(hub->intfdev, "activate --> %d\n", status);
838 	if (hub->has_indicators && blinkenlights)
839 		schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
840 
841 	/* Scan all ports that need attention */
842 	kick_khubd(hub);
843 
844 	/* Allow autosuspend if it was suppressed */
845 	if (type <= HUB_INIT3)
846 		usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
847 }
848 
849 /* Implement the continuations for the delays above */
850 static void hub_init_func2(struct work_struct *ws)
851 {
852 	struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
853 
854 	hub_activate(hub, HUB_INIT2);
855 }
856 
857 static void hub_init_func3(struct work_struct *ws)
858 {
859 	struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
860 
861 	hub_activate(hub, HUB_INIT3);
862 }
863 
864 enum hub_quiescing_type {
865 	HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
866 };
867 
868 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
869 {
870 	struct usb_device *hdev = hub->hdev;
871 	int i;
872 
873 	cancel_delayed_work_sync(&hub->init_work);
874 
875 	/* khubd and related activity won't re-trigger */
876 	hub->quiescing = 1;
877 
878 	if (type != HUB_SUSPEND) {
879 		/* Disconnect all the children */
880 		for (i = 0; i < hdev->maxchild; ++i) {
881 			if (hdev->children[i])
882 				usb_disconnect(&hdev->children[i]);
883 		}
884 	}
885 
886 	/* Stop khubd and related activity */
887 	usb_kill_urb(hub->urb);
888 	if (hub->has_indicators)
889 		cancel_delayed_work_sync(&hub->leds);
890 	if (hub->tt.hub)
891 		cancel_work_sync(&hub->tt.clear_work);
892 }
893 
894 /* caller has locked the hub device */
895 static int hub_pre_reset(struct usb_interface *intf)
896 {
897 	struct usb_hub *hub = usb_get_intfdata(intf);
898 
899 	hub_quiesce(hub, HUB_PRE_RESET);
900 	return 0;
901 }
902 
903 /* caller has locked the hub device */
904 static int hub_post_reset(struct usb_interface *intf)
905 {
906 	struct usb_hub *hub = usb_get_intfdata(intf);
907 
908 	hub_activate(hub, HUB_POST_RESET);
909 	return 0;
910 }
911 
912 static int hub_configure(struct usb_hub *hub,
913 	struct usb_endpoint_descriptor *endpoint)
914 {
915 	struct usb_hcd *hcd;
916 	struct usb_device *hdev = hub->hdev;
917 	struct device *hub_dev = hub->intfdev;
918 	u16 hubstatus, hubchange;
919 	u16 wHubCharacteristics;
920 	unsigned int pipe;
921 	int maxp, ret;
922 	char *message = "out of memory";
923 
924 	hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
925 	if (!hub->buffer) {
926 		ret = -ENOMEM;
927 		goto fail;
928 	}
929 
930 	hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
931 	if (!hub->status) {
932 		ret = -ENOMEM;
933 		goto fail;
934 	}
935 	mutex_init(&hub->status_mutex);
936 
937 	hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
938 	if (!hub->descriptor) {
939 		ret = -ENOMEM;
940 		goto fail;
941 	}
942 
943 	/* Request the entire hub descriptor.
944 	 * hub->descriptor can handle USB_MAXCHILDREN ports,
945 	 * but the hub can/will return fewer bytes here.
946 	 */
947 	ret = get_hub_descriptor(hdev, hub->descriptor,
948 			sizeof(*hub->descriptor));
949 	if (ret < 0) {
950 		message = "can't read hub descriptor";
951 		goto fail;
952 	} else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
953 		message = "hub has too many ports!";
954 		ret = -ENODEV;
955 		goto fail;
956 	}
957 
958 	hdev->maxchild = hub->descriptor->bNbrPorts;
959 	dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
960 		(hdev->maxchild == 1) ? "" : "s");
961 
962 	hub->port_owners = kzalloc(hdev->maxchild * sizeof(void *), GFP_KERNEL);
963 	if (!hub->port_owners) {
964 		ret = -ENOMEM;
965 		goto fail;
966 	}
967 
968 	wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
969 
970 	if (wHubCharacteristics & HUB_CHAR_COMPOUND) {
971 		int	i;
972 		char	portstr [USB_MAXCHILDREN + 1];
973 
974 		for (i = 0; i < hdev->maxchild; i++)
975 			portstr[i] = hub->descriptor->DeviceRemovable
976 				    [((i + 1) / 8)] & (1 << ((i + 1) % 8))
977 				? 'F' : 'R';
978 		portstr[hdev->maxchild] = 0;
979 		dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
980 	} else
981 		dev_dbg(hub_dev, "standalone hub\n");
982 
983 	switch (wHubCharacteristics & HUB_CHAR_LPSM) {
984 		case 0x00:
985 			dev_dbg(hub_dev, "ganged power switching\n");
986 			break;
987 		case 0x01:
988 			dev_dbg(hub_dev, "individual port power switching\n");
989 			break;
990 		case 0x02:
991 		case 0x03:
992 			dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
993 			break;
994 	}
995 
996 	switch (wHubCharacteristics & HUB_CHAR_OCPM) {
997 		case 0x00:
998 			dev_dbg(hub_dev, "global over-current protection\n");
999 			break;
1000 		case 0x08:
1001 			dev_dbg(hub_dev, "individual port over-current protection\n");
1002 			break;
1003 		case 0x10:
1004 		case 0x18:
1005 			dev_dbg(hub_dev, "no over-current protection\n");
1006                         break;
1007 	}
1008 
1009 	spin_lock_init (&hub->tt.lock);
1010 	INIT_LIST_HEAD (&hub->tt.clear_list);
1011 	INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1012 	switch (hdev->descriptor.bDeviceProtocol) {
1013 		case 0:
1014 			break;
1015 		case 1:
1016 			dev_dbg(hub_dev, "Single TT\n");
1017 			hub->tt.hub = hdev;
1018 			break;
1019 		case 2:
1020 			ret = usb_set_interface(hdev, 0, 1);
1021 			if (ret == 0) {
1022 				dev_dbg(hub_dev, "TT per port\n");
1023 				hub->tt.multi = 1;
1024 			} else
1025 				dev_err(hub_dev, "Using single TT (err %d)\n",
1026 					ret);
1027 			hub->tt.hub = hdev;
1028 			break;
1029 		case 3:
1030 			/* USB 3.0 hubs don't have a TT */
1031 			break;
1032 		default:
1033 			dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1034 				hdev->descriptor.bDeviceProtocol);
1035 			break;
1036 	}
1037 
1038 	/* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1039 	switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1040 		case HUB_TTTT_8_BITS:
1041 			if (hdev->descriptor.bDeviceProtocol != 0) {
1042 				hub->tt.think_time = 666;
1043 				dev_dbg(hub_dev, "TT requires at most %d "
1044 						"FS bit times (%d ns)\n",
1045 					8, hub->tt.think_time);
1046 			}
1047 			break;
1048 		case HUB_TTTT_16_BITS:
1049 			hub->tt.think_time = 666 * 2;
1050 			dev_dbg(hub_dev, "TT requires at most %d "
1051 					"FS bit times (%d ns)\n",
1052 				16, hub->tt.think_time);
1053 			break;
1054 		case HUB_TTTT_24_BITS:
1055 			hub->tt.think_time = 666 * 3;
1056 			dev_dbg(hub_dev, "TT requires at most %d "
1057 					"FS bit times (%d ns)\n",
1058 				24, hub->tt.think_time);
1059 			break;
1060 		case HUB_TTTT_32_BITS:
1061 			hub->tt.think_time = 666 * 4;
1062 			dev_dbg(hub_dev, "TT requires at most %d "
1063 					"FS bit times (%d ns)\n",
1064 				32, hub->tt.think_time);
1065 			break;
1066 	}
1067 
1068 	/* probe() zeroes hub->indicator[] */
1069 	if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1070 		hub->has_indicators = 1;
1071 		dev_dbg(hub_dev, "Port indicators are supported\n");
1072 	}
1073 
1074 	dev_dbg(hub_dev, "power on to power good time: %dms\n",
1075 		hub->descriptor->bPwrOn2PwrGood * 2);
1076 
1077 	/* power budgeting mostly matters with bus-powered hubs,
1078 	 * and battery-powered root hubs (may provide just 8 mA).
1079 	 */
1080 	ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1081 	if (ret < 2) {
1082 		message = "can't get hub status";
1083 		goto fail;
1084 	}
1085 	le16_to_cpus(&hubstatus);
1086 	if (hdev == hdev->bus->root_hub) {
1087 		if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
1088 			hub->mA_per_port = 500;
1089 		else {
1090 			hub->mA_per_port = hdev->bus_mA;
1091 			hub->limited_power = 1;
1092 		}
1093 	} else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1094 		dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1095 			hub->descriptor->bHubContrCurrent);
1096 		hub->limited_power = 1;
1097 		if (hdev->maxchild > 0) {
1098 			int remaining = hdev->bus_mA -
1099 					hub->descriptor->bHubContrCurrent;
1100 
1101 			if (remaining < hdev->maxchild * 100)
1102 				dev_warn(hub_dev,
1103 					"insufficient power available "
1104 					"to use all downstream ports\n");
1105 			hub->mA_per_port = 100;		/* 7.2.1.1 */
1106 		}
1107 	} else {	/* Self-powered external hub */
1108 		/* FIXME: What about battery-powered external hubs that
1109 		 * provide less current per port? */
1110 		hub->mA_per_port = 500;
1111 	}
1112 	if (hub->mA_per_port < 500)
1113 		dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1114 				hub->mA_per_port);
1115 
1116 	/* Update the HCD's internal representation of this hub before khubd
1117 	 * starts getting port status changes for devices under the hub.
1118 	 */
1119 	hcd = bus_to_hcd(hdev->bus);
1120 	if (hcd->driver->update_hub_device) {
1121 		ret = hcd->driver->update_hub_device(hcd, hdev,
1122 				&hub->tt, GFP_KERNEL);
1123 		if (ret < 0) {
1124 			message = "can't update HCD hub info";
1125 			goto fail;
1126 		}
1127 	}
1128 
1129 	ret = hub_hub_status(hub, &hubstatus, &hubchange);
1130 	if (ret < 0) {
1131 		message = "can't get hub status";
1132 		goto fail;
1133 	}
1134 
1135 	/* local power status reports aren't always correct */
1136 	if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1137 		dev_dbg(hub_dev, "local power source is %s\n",
1138 			(hubstatus & HUB_STATUS_LOCAL_POWER)
1139 			? "lost (inactive)" : "good");
1140 
1141 	if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1142 		dev_dbg(hub_dev, "%sover-current condition exists\n",
1143 			(hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1144 
1145 	/* set up the interrupt endpoint
1146 	 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1147 	 * bytes as USB2.0[11.12.3] says because some hubs are known
1148 	 * to send more data (and thus cause overflow). For root hubs,
1149 	 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1150 	 * to be big enough for at least USB_MAXCHILDREN ports. */
1151 	pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1152 	maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1153 
1154 	if (maxp > sizeof(*hub->buffer))
1155 		maxp = sizeof(*hub->buffer);
1156 
1157 	hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1158 	if (!hub->urb) {
1159 		ret = -ENOMEM;
1160 		goto fail;
1161 	}
1162 
1163 	usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1164 		hub, endpoint->bInterval);
1165 
1166 	/* maybe cycle the hub leds */
1167 	if (hub->has_indicators && blinkenlights)
1168 		hub->indicator [0] = INDICATOR_CYCLE;
1169 
1170 	hub_activate(hub, HUB_INIT);
1171 	return 0;
1172 
1173 fail:
1174 	dev_err (hub_dev, "config failed, %s (err %d)\n",
1175 			message, ret);
1176 	/* hub_disconnect() frees urb and descriptor */
1177 	return ret;
1178 }
1179 
1180 static void hub_release(struct kref *kref)
1181 {
1182 	struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1183 
1184 	usb_put_intf(to_usb_interface(hub->intfdev));
1185 	kfree(hub);
1186 }
1187 
1188 static unsigned highspeed_hubs;
1189 
1190 static void hub_disconnect(struct usb_interface *intf)
1191 {
1192 	struct usb_hub *hub = usb_get_intfdata (intf);
1193 
1194 	/* Take the hub off the event list and don't let it be added again */
1195 	spin_lock_irq(&hub_event_lock);
1196 	if (!list_empty(&hub->event_list)) {
1197 		list_del_init(&hub->event_list);
1198 		usb_autopm_put_interface_no_suspend(intf);
1199 	}
1200 	hub->disconnected = 1;
1201 	spin_unlock_irq(&hub_event_lock);
1202 
1203 	/* Disconnect all children and quiesce the hub */
1204 	hub->error = 0;
1205 	hub_quiesce(hub, HUB_DISCONNECT);
1206 
1207 	usb_set_intfdata (intf, NULL);
1208 	hub->hdev->maxchild = 0;
1209 
1210 	if (hub->hdev->speed == USB_SPEED_HIGH)
1211 		highspeed_hubs--;
1212 
1213 	usb_free_urb(hub->urb);
1214 	kfree(hub->port_owners);
1215 	kfree(hub->descriptor);
1216 	kfree(hub->status);
1217 	kfree(hub->buffer);
1218 
1219 	kref_put(&hub->kref, hub_release);
1220 }
1221 
1222 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1223 {
1224 	struct usb_host_interface *desc;
1225 	struct usb_endpoint_descriptor *endpoint;
1226 	struct usb_device *hdev;
1227 	struct usb_hub *hub;
1228 
1229 	desc = intf->cur_altsetting;
1230 	hdev = interface_to_usbdev(intf);
1231 
1232 	/* Hubs have proper suspend/resume support */
1233 	usb_enable_autosuspend(hdev);
1234 
1235 	if (hdev->level == MAX_TOPO_LEVEL) {
1236 		dev_err(&intf->dev,
1237 			"Unsupported bus topology: hub nested too deep\n");
1238 		return -E2BIG;
1239 	}
1240 
1241 #ifdef	CONFIG_USB_OTG_BLACKLIST_HUB
1242 	if (hdev->parent) {
1243 		dev_warn(&intf->dev, "ignoring external hub\n");
1244 		return -ENODEV;
1245 	}
1246 #endif
1247 
1248 	/* Some hubs have a subclass of 1, which AFAICT according to the */
1249 	/*  specs is not defined, but it works */
1250 	if ((desc->desc.bInterfaceSubClass != 0) &&
1251 	    (desc->desc.bInterfaceSubClass != 1)) {
1252 descriptor_error:
1253 		dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1254 		return -EIO;
1255 	}
1256 
1257 	/* Multiple endpoints? What kind of mutant ninja-hub is this? */
1258 	if (desc->desc.bNumEndpoints != 1)
1259 		goto descriptor_error;
1260 
1261 	endpoint = &desc->endpoint[0].desc;
1262 
1263 	/* If it's not an interrupt in endpoint, we'd better punt! */
1264 	if (!usb_endpoint_is_int_in(endpoint))
1265 		goto descriptor_error;
1266 
1267 	/* We found a hub */
1268 	dev_info (&intf->dev, "USB hub found\n");
1269 
1270 	hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1271 	if (!hub) {
1272 		dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1273 		return -ENOMEM;
1274 	}
1275 
1276 	kref_init(&hub->kref);
1277 	INIT_LIST_HEAD(&hub->event_list);
1278 	hub->intfdev = &intf->dev;
1279 	hub->hdev = hdev;
1280 	INIT_DELAYED_WORK(&hub->leds, led_work);
1281 	INIT_DELAYED_WORK(&hub->init_work, NULL);
1282 	usb_get_intf(intf);
1283 
1284 	usb_set_intfdata (intf, hub);
1285 	intf->needs_remote_wakeup = 1;
1286 
1287 	if (hdev->speed == USB_SPEED_HIGH)
1288 		highspeed_hubs++;
1289 
1290 	if (hub_configure(hub, endpoint) >= 0)
1291 		return 0;
1292 
1293 	hub_disconnect (intf);
1294 	return -ENODEV;
1295 }
1296 
1297 static int
1298 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1299 {
1300 	struct usb_device *hdev = interface_to_usbdev (intf);
1301 
1302 	/* assert ifno == 0 (part of hub spec) */
1303 	switch (code) {
1304 	case USBDEVFS_HUB_PORTINFO: {
1305 		struct usbdevfs_hub_portinfo *info = user_data;
1306 		int i;
1307 
1308 		spin_lock_irq(&device_state_lock);
1309 		if (hdev->devnum <= 0)
1310 			info->nports = 0;
1311 		else {
1312 			info->nports = hdev->maxchild;
1313 			for (i = 0; i < info->nports; i++) {
1314 				if (hdev->children[i] == NULL)
1315 					info->port[i] = 0;
1316 				else
1317 					info->port[i] =
1318 						hdev->children[i]->devnum;
1319 			}
1320 		}
1321 		spin_unlock_irq(&device_state_lock);
1322 
1323 		return info->nports + 1;
1324 		}
1325 
1326 	default:
1327 		return -ENOSYS;
1328 	}
1329 }
1330 
1331 /*
1332  * Allow user programs to claim ports on a hub.  When a device is attached
1333  * to one of these "claimed" ports, the program will "own" the device.
1334  */
1335 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1336 		void ***ppowner)
1337 {
1338 	if (hdev->state == USB_STATE_NOTATTACHED)
1339 		return -ENODEV;
1340 	if (port1 == 0 || port1 > hdev->maxchild)
1341 		return -EINVAL;
1342 
1343 	/* This assumes that devices not managed by the hub driver
1344 	 * will always have maxchild equal to 0.
1345 	 */
1346 	*ppowner = &(hdev_to_hub(hdev)->port_owners[port1 - 1]);
1347 	return 0;
1348 }
1349 
1350 /* In the following three functions, the caller must hold hdev's lock */
1351 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1, void *owner)
1352 {
1353 	int rc;
1354 	void **powner;
1355 
1356 	rc = find_port_owner(hdev, port1, &powner);
1357 	if (rc)
1358 		return rc;
1359 	if (*powner)
1360 		return -EBUSY;
1361 	*powner = owner;
1362 	return rc;
1363 }
1364 
1365 int usb_hub_release_port(struct usb_device *hdev, unsigned port1, void *owner)
1366 {
1367 	int rc;
1368 	void **powner;
1369 
1370 	rc = find_port_owner(hdev, port1, &powner);
1371 	if (rc)
1372 		return rc;
1373 	if (*powner != owner)
1374 		return -ENOENT;
1375 	*powner = NULL;
1376 	return rc;
1377 }
1378 
1379 void usb_hub_release_all_ports(struct usb_device *hdev, void *owner)
1380 {
1381 	int n;
1382 	void **powner;
1383 
1384 	n = find_port_owner(hdev, 1, &powner);
1385 	if (n == 0) {
1386 		for (; n < hdev->maxchild; (++n, ++powner)) {
1387 			if (*powner == owner)
1388 				*powner = NULL;
1389 		}
1390 	}
1391 }
1392 
1393 /* The caller must hold udev's lock */
1394 bool usb_device_is_owned(struct usb_device *udev)
1395 {
1396 	struct usb_hub *hub;
1397 
1398 	if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1399 		return false;
1400 	hub = hdev_to_hub(udev->parent);
1401 	return !!hub->port_owners[udev->portnum - 1];
1402 }
1403 
1404 
1405 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1406 {
1407 	int i;
1408 
1409 	for (i = 0; i < udev->maxchild; ++i) {
1410 		if (udev->children[i])
1411 			recursively_mark_NOTATTACHED(udev->children[i]);
1412 	}
1413 	if (udev->state == USB_STATE_SUSPENDED)
1414 		udev->active_duration -= jiffies;
1415 	udev->state = USB_STATE_NOTATTACHED;
1416 }
1417 
1418 /**
1419  * usb_set_device_state - change a device's current state (usbcore, hcds)
1420  * @udev: pointer to device whose state should be changed
1421  * @new_state: new state value to be stored
1422  *
1423  * udev->state is _not_ fully protected by the device lock.  Although
1424  * most transitions are made only while holding the lock, the state can
1425  * can change to USB_STATE_NOTATTACHED at almost any time.  This
1426  * is so that devices can be marked as disconnected as soon as possible,
1427  * without having to wait for any semaphores to be released.  As a result,
1428  * all changes to any device's state must be protected by the
1429  * device_state_lock spinlock.
1430  *
1431  * Once a device has been added to the device tree, all changes to its state
1432  * should be made using this routine.  The state should _not_ be set directly.
1433  *
1434  * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1435  * Otherwise udev->state is set to new_state, and if new_state is
1436  * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1437  * to USB_STATE_NOTATTACHED.
1438  */
1439 void usb_set_device_state(struct usb_device *udev,
1440 		enum usb_device_state new_state)
1441 {
1442 	unsigned long flags;
1443 
1444 	spin_lock_irqsave(&device_state_lock, flags);
1445 	if (udev->state == USB_STATE_NOTATTACHED)
1446 		;	/* do nothing */
1447 	else if (new_state != USB_STATE_NOTATTACHED) {
1448 
1449 		/* root hub wakeup capabilities are managed out-of-band
1450 		 * and may involve silicon errata ... ignore them here.
1451 		 */
1452 		if (udev->parent) {
1453 			if (udev->state == USB_STATE_SUSPENDED
1454 					|| new_state == USB_STATE_SUSPENDED)
1455 				;	/* No change to wakeup settings */
1456 			else if (new_state == USB_STATE_CONFIGURED)
1457 				device_set_wakeup_capable(&udev->dev,
1458 					(udev->actconfig->desc.bmAttributes
1459 					 & USB_CONFIG_ATT_WAKEUP));
1460 			else
1461 				device_set_wakeup_capable(&udev->dev, 0);
1462 		}
1463 		if (udev->state == USB_STATE_SUSPENDED &&
1464 			new_state != USB_STATE_SUSPENDED)
1465 			udev->active_duration -= jiffies;
1466 		else if (new_state == USB_STATE_SUSPENDED &&
1467 				udev->state != USB_STATE_SUSPENDED)
1468 			udev->active_duration += jiffies;
1469 		udev->state = new_state;
1470 	} else
1471 		recursively_mark_NOTATTACHED(udev);
1472 	spin_unlock_irqrestore(&device_state_lock, flags);
1473 }
1474 EXPORT_SYMBOL_GPL(usb_set_device_state);
1475 
1476 /*
1477  * WUSB devices are simple: they have no hubs behind, so the mapping
1478  * device <-> virtual port number becomes 1:1. Why? to simplify the
1479  * life of the device connection logic in
1480  * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1481  * handshake we need to assign a temporary address in the unauthorized
1482  * space. For simplicity we use the first virtual port number found to
1483  * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1484  * and that becomes it's address [X < 128] or its unauthorized address
1485  * [X | 0x80].
1486  *
1487  * We add 1 as an offset to the one-based USB-stack port number
1488  * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1489  * 0 is reserved by USB for default address; (b) Linux's USB stack
1490  * uses always #1 for the root hub of the controller. So USB stack's
1491  * port #1, which is wusb virtual-port #0 has address #2.
1492  *
1493  * Devices connected under xHCI are not as simple.  The host controller
1494  * supports virtualization, so the hardware assigns device addresses and
1495  * the HCD must setup data structures before issuing a set address
1496  * command to the hardware.
1497  */
1498 static void choose_address(struct usb_device *udev)
1499 {
1500 	int		devnum;
1501 	struct usb_bus	*bus = udev->bus;
1502 
1503 	/* If khubd ever becomes multithreaded, this will need a lock */
1504 	if (udev->wusb) {
1505 		devnum = udev->portnum + 1;
1506 		BUG_ON(test_bit(devnum, bus->devmap.devicemap));
1507 	} else {
1508 		/* Try to allocate the next devnum beginning at
1509 		 * bus->devnum_next. */
1510 		devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1511 					    bus->devnum_next);
1512 		if (devnum >= 128)
1513 			devnum = find_next_zero_bit(bus->devmap.devicemap,
1514 						    128, 1);
1515 		bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1516 	}
1517 	if (devnum < 128) {
1518 		set_bit(devnum, bus->devmap.devicemap);
1519 		udev->devnum = devnum;
1520 	}
1521 }
1522 
1523 static void release_address(struct usb_device *udev)
1524 {
1525 	if (udev->devnum > 0) {
1526 		clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1527 		udev->devnum = -1;
1528 	}
1529 }
1530 
1531 static void update_address(struct usb_device *udev, int devnum)
1532 {
1533 	/* The address for a WUSB device is managed by wusbcore. */
1534 	if (!udev->wusb)
1535 		udev->devnum = devnum;
1536 }
1537 
1538 static void hub_free_dev(struct usb_device *udev)
1539 {
1540 	struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1541 
1542 	/* Root hubs aren't real devices, so don't free HCD resources */
1543 	if (hcd->driver->free_dev && udev->parent)
1544 		hcd->driver->free_dev(hcd, udev);
1545 }
1546 
1547 /**
1548  * usb_disconnect - disconnect a device (usbcore-internal)
1549  * @pdev: pointer to device being disconnected
1550  * Context: !in_interrupt ()
1551  *
1552  * Something got disconnected. Get rid of it and all of its children.
1553  *
1554  * If *pdev is a normal device then the parent hub must already be locked.
1555  * If *pdev is a root hub then this routine will acquire the
1556  * usb_bus_list_lock on behalf of the caller.
1557  *
1558  * Only hub drivers (including virtual root hub drivers for host
1559  * controllers) should ever call this.
1560  *
1561  * This call is synchronous, and may not be used in an interrupt context.
1562  */
1563 void usb_disconnect(struct usb_device **pdev)
1564 {
1565 	struct usb_device	*udev = *pdev;
1566 	int			i;
1567 
1568 	if (!udev) {
1569 		pr_debug ("%s nodev\n", __func__);
1570 		return;
1571 	}
1572 
1573 	/* mark the device as inactive, so any further urb submissions for
1574 	 * this device (and any of its children) will fail immediately.
1575 	 * this quiesces everyting except pending urbs.
1576 	 */
1577 	usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1578 	dev_info (&udev->dev, "USB disconnect, address %d\n", udev->devnum);
1579 
1580 	usb_lock_device(udev);
1581 
1582 	/* Free up all the children before we remove this device */
1583 	for (i = 0; i < USB_MAXCHILDREN; i++) {
1584 		if (udev->children[i])
1585 			usb_disconnect(&udev->children[i]);
1586 	}
1587 
1588 	/* deallocate hcd/hardware state ... nuking all pending urbs and
1589 	 * cleaning up all state associated with the current configuration
1590 	 * so that the hardware is now fully quiesced.
1591 	 */
1592 	dev_dbg (&udev->dev, "unregistering device\n");
1593 	usb_disable_device(udev, 0);
1594 	usb_hcd_synchronize_unlinks(udev);
1595 
1596 	usb_remove_ep_devs(&udev->ep0);
1597 	usb_unlock_device(udev);
1598 
1599 	/* Unregister the device.  The device driver is responsible
1600 	 * for de-configuring the device and invoking the remove-device
1601 	 * notifier chain (used by usbfs and possibly others).
1602 	 */
1603 	device_del(&udev->dev);
1604 
1605 	/* Free the device number and delete the parent's children[]
1606 	 * (or root_hub) pointer.
1607 	 */
1608 	release_address(udev);
1609 
1610 	/* Avoid races with recursively_mark_NOTATTACHED() */
1611 	spin_lock_irq(&device_state_lock);
1612 	*pdev = NULL;
1613 	spin_unlock_irq(&device_state_lock);
1614 
1615 	hub_free_dev(udev);
1616 
1617 	put_device(&udev->dev);
1618 }
1619 
1620 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
1621 static void show_string(struct usb_device *udev, char *id, char *string)
1622 {
1623 	if (!string)
1624 		return;
1625 	dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1626 }
1627 
1628 static void announce_device(struct usb_device *udev)
1629 {
1630 	dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
1631 		le16_to_cpu(udev->descriptor.idVendor),
1632 		le16_to_cpu(udev->descriptor.idProduct));
1633 	dev_info(&udev->dev,
1634 		"New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
1635 		udev->descriptor.iManufacturer,
1636 		udev->descriptor.iProduct,
1637 		udev->descriptor.iSerialNumber);
1638 	show_string(udev, "Product", udev->product);
1639 	show_string(udev, "Manufacturer", udev->manufacturer);
1640 	show_string(udev, "SerialNumber", udev->serial);
1641 }
1642 #else
1643 static inline void announce_device(struct usb_device *udev) { }
1644 #endif
1645 
1646 #ifdef	CONFIG_USB_OTG
1647 #include "otg_whitelist.h"
1648 #endif
1649 
1650 /**
1651  * usb_enumerate_device_otg - FIXME (usbcore-internal)
1652  * @udev: newly addressed device (in ADDRESS state)
1653  *
1654  * Finish enumeration for On-The-Go devices
1655  */
1656 static int usb_enumerate_device_otg(struct usb_device *udev)
1657 {
1658 	int err = 0;
1659 
1660 #ifdef	CONFIG_USB_OTG
1661 	/*
1662 	 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1663 	 * to wake us after we've powered off VBUS; and HNP, switching roles
1664 	 * "host" to "peripheral".  The OTG descriptor helps figure this out.
1665 	 */
1666 	if (!udev->bus->is_b_host
1667 			&& udev->config
1668 			&& udev->parent == udev->bus->root_hub) {
1669 		struct usb_otg_descriptor	*desc = NULL;
1670 		struct usb_bus			*bus = udev->bus;
1671 
1672 		/* descriptor may appear anywhere in config */
1673 		if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1674 					le16_to_cpu(udev->config[0].desc.wTotalLength),
1675 					USB_DT_OTG, (void **) &desc) == 0) {
1676 			if (desc->bmAttributes & USB_OTG_HNP) {
1677 				unsigned		port1 = udev->portnum;
1678 
1679 				dev_info(&udev->dev,
1680 					"Dual-Role OTG device on %sHNP port\n",
1681 					(port1 == bus->otg_port)
1682 						? "" : "non-");
1683 
1684 				/* enable HNP before suspend, it's simpler */
1685 				if (port1 == bus->otg_port)
1686 					bus->b_hnp_enable = 1;
1687 				err = usb_control_msg(udev,
1688 					usb_sndctrlpipe(udev, 0),
1689 					USB_REQ_SET_FEATURE, 0,
1690 					bus->b_hnp_enable
1691 						? USB_DEVICE_B_HNP_ENABLE
1692 						: USB_DEVICE_A_ALT_HNP_SUPPORT,
1693 					0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1694 				if (err < 0) {
1695 					/* OTG MESSAGE: report errors here,
1696 					 * customize to match your product.
1697 					 */
1698 					dev_info(&udev->dev,
1699 						"can't set HNP mode: %d\n",
1700 						err);
1701 					bus->b_hnp_enable = 0;
1702 				}
1703 			}
1704 		}
1705 	}
1706 
1707 	if (!is_targeted(udev)) {
1708 
1709 		/* Maybe it can talk to us, though we can't talk to it.
1710 		 * (Includes HNP test device.)
1711 		 */
1712 		if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
1713 			err = usb_port_suspend(udev, PMSG_SUSPEND);
1714 			if (err < 0)
1715 				dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1716 		}
1717 		err = -ENOTSUPP;
1718 		goto fail;
1719 	}
1720 fail:
1721 #endif
1722 	return err;
1723 }
1724 
1725 
1726 /**
1727  * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
1728  * @udev: newly addressed device (in ADDRESS state)
1729  *
1730  * This is only called by usb_new_device() and usb_authorize_device()
1731  * and FIXME -- all comments that apply to them apply here wrt to
1732  * environment.
1733  *
1734  * If the device is WUSB and not authorized, we don't attempt to read
1735  * the string descriptors, as they will be errored out by the device
1736  * until it has been authorized.
1737  */
1738 static int usb_enumerate_device(struct usb_device *udev)
1739 {
1740 	int err;
1741 
1742 	if (udev->config == NULL) {
1743 		err = usb_get_configuration(udev);
1744 		if (err < 0) {
1745 			dev_err(&udev->dev, "can't read configurations, error %d\n",
1746 				err);
1747 			goto fail;
1748 		}
1749 	}
1750 	if (udev->wusb == 1 && udev->authorized == 0) {
1751 		udev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1752 		udev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1753 		udev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1754 	}
1755 	else {
1756 		/* read the standard strings and cache them if present */
1757 		udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1758 		udev->manufacturer = usb_cache_string(udev,
1759 						      udev->descriptor.iManufacturer);
1760 		udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
1761 	}
1762 	err = usb_enumerate_device_otg(udev);
1763 fail:
1764 	return err;
1765 }
1766 
1767 
1768 /**
1769  * usb_new_device - perform initial device setup (usbcore-internal)
1770  * @udev: newly addressed device (in ADDRESS state)
1771  *
1772  * This is called with devices which have been detected but not fully
1773  * enumerated.  The device descriptor is available, but not descriptors
1774  * for any device configuration.  The caller must have locked either
1775  * the parent hub (if udev is a normal device) or else the
1776  * usb_bus_list_lock (if udev is a root hub).  The parent's pointer to
1777  * udev has already been installed, but udev is not yet visible through
1778  * sysfs or other filesystem code.
1779  *
1780  * It will return if the device is configured properly or not.  Zero if
1781  * the interface was registered with the driver core; else a negative
1782  * errno value.
1783  *
1784  * This call is synchronous, and may not be used in an interrupt context.
1785  *
1786  * Only the hub driver or root-hub registrar should ever call this.
1787  */
1788 int usb_new_device(struct usb_device *udev)
1789 {
1790 	int err;
1791 
1792 	if (udev->parent) {
1793 		/* Initialize non-root-hub device wakeup to disabled;
1794 		 * device (un)configuration controls wakeup capable
1795 		 * sysfs power/wakeup controls wakeup enabled/disabled
1796 		 */
1797 		device_init_wakeup(&udev->dev, 0);
1798 	}
1799 
1800 	/* Tell the runtime-PM framework the device is active */
1801 	pm_runtime_set_active(&udev->dev);
1802 	pm_runtime_enable(&udev->dev);
1803 
1804 	usb_detect_quirks(udev);
1805 	err = usb_enumerate_device(udev);	/* Read descriptors */
1806 	if (err < 0)
1807 		goto fail;
1808 	dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
1809 			udev->devnum, udev->bus->busnum,
1810 			(((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1811 	/* export the usbdev device-node for libusb */
1812 	udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
1813 			(((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1814 
1815 	/* Tell the world! */
1816 	announce_device(udev);
1817 
1818 	device_enable_async_suspend(&udev->dev);
1819 	/* Register the device.  The device driver is responsible
1820 	 * for configuring the device and invoking the add-device
1821 	 * notifier chain (used by usbfs and possibly others).
1822 	 */
1823 	err = device_add(&udev->dev);
1824 	if (err) {
1825 		dev_err(&udev->dev, "can't device_add, error %d\n", err);
1826 		goto fail;
1827 	}
1828 
1829 	(void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
1830 	return err;
1831 
1832 fail:
1833 	usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1834 	pm_runtime_disable(&udev->dev);
1835 	pm_runtime_set_suspended(&udev->dev);
1836 	return err;
1837 }
1838 
1839 
1840 /**
1841  * usb_deauthorize_device - deauthorize a device (usbcore-internal)
1842  * @usb_dev: USB device
1843  *
1844  * Move the USB device to a very basic state where interfaces are disabled
1845  * and the device is in fact unconfigured and unusable.
1846  *
1847  * We share a lock (that we have) with device_del(), so we need to
1848  * defer its call.
1849  */
1850 int usb_deauthorize_device(struct usb_device *usb_dev)
1851 {
1852 	usb_lock_device(usb_dev);
1853 	if (usb_dev->authorized == 0)
1854 		goto out_unauthorized;
1855 
1856 	usb_dev->authorized = 0;
1857 	usb_set_configuration(usb_dev, -1);
1858 
1859 	kfree(usb_dev->product);
1860 	usb_dev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1861 	kfree(usb_dev->manufacturer);
1862 	usb_dev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1863 	kfree(usb_dev->serial);
1864 	usb_dev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1865 
1866 	usb_destroy_configuration(usb_dev);
1867 	usb_dev->descriptor.bNumConfigurations = 0;
1868 
1869 out_unauthorized:
1870 	usb_unlock_device(usb_dev);
1871 	return 0;
1872 }
1873 
1874 
1875 int usb_authorize_device(struct usb_device *usb_dev)
1876 {
1877 	int result = 0, c;
1878 
1879 	usb_lock_device(usb_dev);
1880 	if (usb_dev->authorized == 1)
1881 		goto out_authorized;
1882 
1883 	result = usb_autoresume_device(usb_dev);
1884 	if (result < 0) {
1885 		dev_err(&usb_dev->dev,
1886 			"can't autoresume for authorization: %d\n", result);
1887 		goto error_autoresume;
1888 	}
1889 	result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
1890 	if (result < 0) {
1891 		dev_err(&usb_dev->dev, "can't re-read device descriptor for "
1892 			"authorization: %d\n", result);
1893 		goto error_device_descriptor;
1894 	}
1895 
1896 	kfree(usb_dev->product);
1897 	usb_dev->product = NULL;
1898 	kfree(usb_dev->manufacturer);
1899 	usb_dev->manufacturer = NULL;
1900 	kfree(usb_dev->serial);
1901 	usb_dev->serial = NULL;
1902 
1903 	usb_dev->authorized = 1;
1904 	result = usb_enumerate_device(usb_dev);
1905 	if (result < 0)
1906 		goto error_enumerate;
1907 	/* Choose and set the configuration.  This registers the interfaces
1908 	 * with the driver core and lets interface drivers bind to them.
1909 	 */
1910 	c = usb_choose_configuration(usb_dev);
1911 	if (c >= 0) {
1912 		result = usb_set_configuration(usb_dev, c);
1913 		if (result) {
1914 			dev_err(&usb_dev->dev,
1915 				"can't set config #%d, error %d\n", c, result);
1916 			/* This need not be fatal.  The user can try to
1917 			 * set other configurations. */
1918 		}
1919 	}
1920 	dev_info(&usb_dev->dev, "authorized to connect\n");
1921 
1922 error_enumerate:
1923 error_device_descriptor:
1924 	usb_autosuspend_device(usb_dev);
1925 error_autoresume:
1926 out_authorized:
1927 	usb_unlock_device(usb_dev);	// complements locktree
1928 	return result;
1929 }
1930 
1931 
1932 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
1933 static unsigned hub_is_wusb(struct usb_hub *hub)
1934 {
1935 	struct usb_hcd *hcd;
1936 	if (hub->hdev->parent != NULL)  /* not a root hub? */
1937 		return 0;
1938 	hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
1939 	return hcd->wireless;
1940 }
1941 
1942 
1943 #define PORT_RESET_TRIES	5
1944 #define SET_ADDRESS_TRIES	2
1945 #define GET_DESCRIPTOR_TRIES	2
1946 #define SET_CONFIG_TRIES	(2 * (use_both_schemes + 1))
1947 #define USE_NEW_SCHEME(i)	((i) / 2 == old_scheme_first)
1948 
1949 #define HUB_ROOT_RESET_TIME	50	/* times are in msec */
1950 #define HUB_SHORT_RESET_TIME	10
1951 #define HUB_LONG_RESET_TIME	200
1952 #define HUB_RESET_TIMEOUT	500
1953 
1954 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
1955 				struct usb_device *udev, unsigned int delay)
1956 {
1957 	int delay_time, ret;
1958 	u16 portstatus;
1959 	u16 portchange;
1960 
1961 	for (delay_time = 0;
1962 			delay_time < HUB_RESET_TIMEOUT;
1963 			delay_time += delay) {
1964 		/* wait to give the device a chance to reset */
1965 		msleep(delay);
1966 
1967 		/* read and decode port status */
1968 		ret = hub_port_status(hub, port1, &portstatus, &portchange);
1969 		if (ret < 0)
1970 			return ret;
1971 
1972 		/* Device went away? */
1973 		if (!(portstatus & USB_PORT_STAT_CONNECTION))
1974 			return -ENOTCONN;
1975 
1976 		/* bomb out completely if the connection bounced */
1977 		if ((portchange & USB_PORT_STAT_C_CONNECTION))
1978 			return -ENOTCONN;
1979 
1980 		/* if we`ve finished resetting, then break out of the loop */
1981 		if (!(portstatus & USB_PORT_STAT_RESET) &&
1982 		    (portstatus & USB_PORT_STAT_ENABLE)) {
1983 			if (hub_is_wusb(hub))
1984 				udev->speed = USB_SPEED_WIRELESS;
1985 			else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
1986 				udev->speed = USB_SPEED_HIGH;
1987 			else if (portstatus & USB_PORT_STAT_LOW_SPEED)
1988 				udev->speed = USB_SPEED_LOW;
1989 			else
1990 				udev->speed = USB_SPEED_FULL;
1991 			return 0;
1992 		}
1993 
1994 		/* switch to the long delay after two short delay failures */
1995 		if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
1996 			delay = HUB_LONG_RESET_TIME;
1997 
1998 		dev_dbg (hub->intfdev,
1999 			"port %d not reset yet, waiting %dms\n",
2000 			port1, delay);
2001 	}
2002 
2003 	return -EBUSY;
2004 }
2005 
2006 static int hub_port_reset(struct usb_hub *hub, int port1,
2007 				struct usb_device *udev, unsigned int delay)
2008 {
2009 	int i, status;
2010 	struct usb_hcd *hcd;
2011 
2012 	hcd = bus_to_hcd(udev->bus);
2013 	/* Block EHCI CF initialization during the port reset.
2014 	 * Some companion controllers don't like it when they mix.
2015 	 */
2016 	down_read(&ehci_cf_port_reset_rwsem);
2017 
2018 	/* Reset the port */
2019 	for (i = 0; i < PORT_RESET_TRIES; i++) {
2020 		status = set_port_feature(hub->hdev,
2021 				port1, USB_PORT_FEAT_RESET);
2022 		if (status)
2023 			dev_err(hub->intfdev,
2024 					"cannot reset port %d (err = %d)\n",
2025 					port1, status);
2026 		else {
2027 			status = hub_port_wait_reset(hub, port1, udev, delay);
2028 			if (status && status != -ENOTCONN)
2029 				dev_dbg(hub->intfdev,
2030 						"port_wait_reset: err = %d\n",
2031 						status);
2032 		}
2033 
2034 		/* return on disconnect or reset */
2035 		switch (status) {
2036 		case 0:
2037 			/* TRSTRCY = 10 ms; plus some extra */
2038 			msleep(10 + 40);
2039 			update_address(udev, 0);
2040 			if (hcd->driver->reset_device) {
2041 				status = hcd->driver->reset_device(hcd, udev);
2042 				if (status < 0) {
2043 					dev_err(&udev->dev, "Cannot reset "
2044 							"HCD device state\n");
2045 					break;
2046 				}
2047 			}
2048 			/* FALL THROUGH */
2049 		case -ENOTCONN:
2050 		case -ENODEV:
2051 			clear_port_feature(hub->hdev,
2052 				port1, USB_PORT_FEAT_C_RESET);
2053 			/* FIXME need disconnect() for NOTATTACHED device */
2054 			usb_set_device_state(udev, status
2055 					? USB_STATE_NOTATTACHED
2056 					: USB_STATE_DEFAULT);
2057 			goto done;
2058 		}
2059 
2060 		dev_dbg (hub->intfdev,
2061 			"port %d not enabled, trying reset again...\n",
2062 			port1);
2063 		delay = HUB_LONG_RESET_TIME;
2064 	}
2065 
2066 	dev_err (hub->intfdev,
2067 		"Cannot enable port %i.  Maybe the USB cable is bad?\n",
2068 		port1);
2069 
2070  done:
2071 	up_read(&ehci_cf_port_reset_rwsem);
2072 	return status;
2073 }
2074 
2075 #ifdef	CONFIG_PM
2076 
2077 #define MASK_BITS	(USB_PORT_STAT_POWER | USB_PORT_STAT_CONNECTION | \
2078 				USB_PORT_STAT_SUSPEND)
2079 #define WANT_BITS	(USB_PORT_STAT_POWER | USB_PORT_STAT_CONNECTION)
2080 
2081 /* Determine whether the device on a port is ready for a normal resume,
2082  * is ready for a reset-resume, or should be disconnected.
2083  */
2084 static int check_port_resume_type(struct usb_device *udev,
2085 		struct usb_hub *hub, int port1,
2086 		int status, unsigned portchange, unsigned portstatus)
2087 {
2088 	/* Is the device still present? */
2089 	if (status || (portstatus & MASK_BITS) != WANT_BITS) {
2090 		if (status >= 0)
2091 			status = -ENODEV;
2092 	}
2093 
2094 	/* Can't do a normal resume if the port isn't enabled,
2095 	 * so try a reset-resume instead.
2096 	 */
2097 	else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2098 		if (udev->persist_enabled)
2099 			udev->reset_resume = 1;
2100 		else
2101 			status = -ENODEV;
2102 	}
2103 
2104 	if (status) {
2105 		dev_dbg(hub->intfdev,
2106 				"port %d status %04x.%04x after resume, %d\n",
2107 				port1, portchange, portstatus, status);
2108 	} else if (udev->reset_resume) {
2109 
2110 		/* Late port handoff can set status-change bits */
2111 		if (portchange & USB_PORT_STAT_C_CONNECTION)
2112 			clear_port_feature(hub->hdev, port1,
2113 					USB_PORT_FEAT_C_CONNECTION);
2114 		if (portchange & USB_PORT_STAT_C_ENABLE)
2115 			clear_port_feature(hub->hdev, port1,
2116 					USB_PORT_FEAT_C_ENABLE);
2117 	}
2118 
2119 	return status;
2120 }
2121 
2122 #ifdef	CONFIG_USB_SUSPEND
2123 
2124 /*
2125  * usb_port_suspend - suspend a usb device's upstream port
2126  * @udev: device that's no longer in active use, not a root hub
2127  * Context: must be able to sleep; device not locked; pm locks held
2128  *
2129  * Suspends a USB device that isn't in active use, conserving power.
2130  * Devices may wake out of a suspend, if anything important happens,
2131  * using the remote wakeup mechanism.  They may also be taken out of
2132  * suspend by the host, using usb_port_resume().  It's also routine
2133  * to disconnect devices while they are suspended.
2134  *
2135  * This only affects the USB hardware for a device; its interfaces
2136  * (and, for hubs, child devices) must already have been suspended.
2137  *
2138  * Selective port suspend reduces power; most suspended devices draw
2139  * less than 500 uA.  It's also used in OTG, along with remote wakeup.
2140  * All devices below the suspended port are also suspended.
2141  *
2142  * Devices leave suspend state when the host wakes them up.  Some devices
2143  * also support "remote wakeup", where the device can activate the USB
2144  * tree above them to deliver data, such as a keypress or packet.  In
2145  * some cases, this wakes the USB host.
2146  *
2147  * Suspending OTG devices may trigger HNP, if that's been enabled
2148  * between a pair of dual-role devices.  That will change roles, such
2149  * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2150  *
2151  * Devices on USB hub ports have only one "suspend" state, corresponding
2152  * to ACPI D2, "may cause the device to lose some context".
2153  * State transitions include:
2154  *
2155  *   - suspend, resume ... when the VBUS power link stays live
2156  *   - suspend, disconnect ... VBUS lost
2157  *
2158  * Once VBUS drop breaks the circuit, the port it's using has to go through
2159  * normal re-enumeration procedures, starting with enabling VBUS power.
2160  * Other than re-initializing the hub (plug/unplug, except for root hubs),
2161  * Linux (2.6) currently has NO mechanisms to initiate that:  no khubd
2162  * timer, no SRP, no requests through sysfs.
2163  *
2164  * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
2165  * the root hub for their bus goes into global suspend ... so we don't
2166  * (falsely) update the device power state to say it suspended.
2167  *
2168  * Returns 0 on success, else negative errno.
2169  */
2170 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2171 {
2172 	struct usb_hub	*hub = hdev_to_hub(udev->parent);
2173 	int		port1 = udev->portnum;
2174 	int		status;
2175 
2176 	// dev_dbg(hub->intfdev, "suspend port %d\n", port1);
2177 
2178 	/* enable remote wakeup when appropriate; this lets the device
2179 	 * wake up the upstream hub (including maybe the root hub).
2180 	 *
2181 	 * NOTE:  OTG devices may issue remote wakeup (or SRP) even when
2182 	 * we don't explicitly enable it here.
2183 	 */
2184 	if (udev->do_remote_wakeup) {
2185 		status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2186 				USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2187 				USB_DEVICE_REMOTE_WAKEUP, 0,
2188 				NULL, 0,
2189 				USB_CTRL_SET_TIMEOUT);
2190 		if (status) {
2191 			dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
2192 					status);
2193 			/* bail if autosuspend is requested */
2194 			if (msg.event & PM_EVENT_AUTO)
2195 				return status;
2196 		}
2197 	}
2198 
2199 	/* see 7.1.7.6 */
2200 	status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
2201 	if (status) {
2202 		dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
2203 				port1, status);
2204 		/* paranoia:  "should not happen" */
2205 		if (udev->do_remote_wakeup)
2206 			(void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2207 				USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2208 				USB_DEVICE_REMOTE_WAKEUP, 0,
2209 				NULL, 0,
2210 				USB_CTRL_SET_TIMEOUT);
2211 	} else {
2212 		/* device has up to 10 msec to fully suspend */
2213 		dev_dbg(&udev->dev, "usb %ssuspend\n",
2214 				(msg.event & PM_EVENT_AUTO ? "auto-" : ""));
2215 		usb_set_device_state(udev, USB_STATE_SUSPENDED);
2216 		msleep(10);
2217 	}
2218 	return status;
2219 }
2220 
2221 /*
2222  * If the USB "suspend" state is in use (rather than "global suspend"),
2223  * many devices will be individually taken out of suspend state using
2224  * special "resume" signaling.  This routine kicks in shortly after
2225  * hardware resume signaling is finished, either because of selective
2226  * resume (by host) or remote wakeup (by device) ... now see what changed
2227  * in the tree that's rooted at this device.
2228  *
2229  * If @udev->reset_resume is set then the device is reset before the
2230  * status check is done.
2231  */
2232 static int finish_port_resume(struct usb_device *udev)
2233 {
2234 	int	status = 0;
2235 	u16	devstatus;
2236 
2237 	/* caller owns the udev device lock */
2238 	dev_dbg(&udev->dev, "%s\n",
2239 		udev->reset_resume ? "finish reset-resume" : "finish resume");
2240 
2241 	/* usb ch9 identifies four variants of SUSPENDED, based on what
2242 	 * state the device resumes to.  Linux currently won't see the
2243 	 * first two on the host side; they'd be inside hub_port_init()
2244 	 * during many timeouts, but khubd can't suspend until later.
2245 	 */
2246 	usb_set_device_state(udev, udev->actconfig
2247 			? USB_STATE_CONFIGURED
2248 			: USB_STATE_ADDRESS);
2249 
2250 	/* 10.5.4.5 says not to reset a suspended port if the attached
2251 	 * device is enabled for remote wakeup.  Hence the reset
2252 	 * operation is carried out here, after the port has been
2253 	 * resumed.
2254 	 */
2255 	if (udev->reset_resume)
2256  retry_reset_resume:
2257 		status = usb_reset_and_verify_device(udev);
2258 
2259  	/* 10.5.4.5 says be sure devices in the tree are still there.
2260  	 * For now let's assume the device didn't go crazy on resume,
2261 	 * and device drivers will know about any resume quirks.
2262 	 */
2263 	if (status == 0) {
2264 		devstatus = 0;
2265 		status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
2266 		if (status >= 0)
2267 			status = (status > 0 ? 0 : -ENODEV);
2268 
2269 		/* If a normal resume failed, try doing a reset-resume */
2270 		if (status && !udev->reset_resume && udev->persist_enabled) {
2271 			dev_dbg(&udev->dev, "retry with reset-resume\n");
2272 			udev->reset_resume = 1;
2273 			goto retry_reset_resume;
2274 		}
2275 	}
2276 
2277 	if (status) {
2278 		dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
2279 				status);
2280 	} else if (udev->actconfig) {
2281 		le16_to_cpus(&devstatus);
2282 		if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) {
2283 			status = usb_control_msg(udev,
2284 					usb_sndctrlpipe(udev, 0),
2285 					USB_REQ_CLEAR_FEATURE,
2286 						USB_RECIP_DEVICE,
2287 					USB_DEVICE_REMOTE_WAKEUP, 0,
2288 					NULL, 0,
2289 					USB_CTRL_SET_TIMEOUT);
2290 			if (status)
2291 				dev_dbg(&udev->dev,
2292 					"disable remote wakeup, status %d\n",
2293 					status);
2294 		}
2295 		status = 0;
2296 	}
2297 	return status;
2298 }
2299 
2300 /*
2301  * usb_port_resume - re-activate a suspended usb device's upstream port
2302  * @udev: device to re-activate, not a root hub
2303  * Context: must be able to sleep; device not locked; pm locks held
2304  *
2305  * This will re-activate the suspended device, increasing power usage
2306  * while letting drivers communicate again with its endpoints.
2307  * USB resume explicitly guarantees that the power session between
2308  * the host and the device is the same as it was when the device
2309  * suspended.
2310  *
2311  * If @udev->reset_resume is set then this routine won't check that the
2312  * port is still enabled.  Furthermore, finish_port_resume() above will
2313  * reset @udev.  The end result is that a broken power session can be
2314  * recovered and @udev will appear to persist across a loss of VBUS power.
2315  *
2316  * For example, if a host controller doesn't maintain VBUS suspend current
2317  * during a system sleep or is reset when the system wakes up, all the USB
2318  * power sessions below it will be broken.  This is especially troublesome
2319  * for mass-storage devices containing mounted filesystems, since the
2320  * device will appear to have disconnected and all the memory mappings
2321  * to it will be lost.  Using the USB_PERSIST facility, the device can be
2322  * made to appear as if it had not disconnected.
2323  *
2324  * This facility can be dangerous.  Although usb_reset_and_verify_device() makes
2325  * every effort to insure that the same device is present after the
2326  * reset as before, it cannot provide a 100% guarantee.  Furthermore it's
2327  * quite possible for a device to remain unaltered but its media to be
2328  * changed.  If the user replaces a flash memory card while the system is
2329  * asleep, he will have only himself to blame when the filesystem on the
2330  * new card is corrupted and the system crashes.
2331  *
2332  * Returns 0 on success, else negative errno.
2333  */
2334 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
2335 {
2336 	struct usb_hub	*hub = hdev_to_hub(udev->parent);
2337 	int		port1 = udev->portnum;
2338 	int		status;
2339 	u16		portchange, portstatus;
2340 
2341 	/* Skip the initial Clear-Suspend step for a remote wakeup */
2342 	status = hub_port_status(hub, port1, &portstatus, &portchange);
2343 	if (status == 0 && !(portstatus & USB_PORT_STAT_SUSPEND))
2344 		goto SuspendCleared;
2345 
2346 	// dev_dbg(hub->intfdev, "resume port %d\n", port1);
2347 
2348 	set_bit(port1, hub->busy_bits);
2349 
2350 	/* see 7.1.7.7; affects power usage, but not budgeting */
2351 	status = clear_port_feature(hub->hdev,
2352 			port1, USB_PORT_FEAT_SUSPEND);
2353 	if (status) {
2354 		dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
2355 				port1, status);
2356 	} else {
2357 		/* drive resume for at least 20 msec */
2358 		dev_dbg(&udev->dev, "usb %sresume\n",
2359 				(msg.event & PM_EVENT_AUTO ? "auto-" : ""));
2360 		msleep(25);
2361 
2362 		/* Virtual root hubs can trigger on GET_PORT_STATUS to
2363 		 * stop resume signaling.  Then finish the resume
2364 		 * sequence.
2365 		 */
2366 		status = hub_port_status(hub, port1, &portstatus, &portchange);
2367 
2368 		/* TRSMRCY = 10 msec */
2369 		msleep(10);
2370 	}
2371 
2372  SuspendCleared:
2373 	if (status == 0) {
2374 		if (portchange & USB_PORT_STAT_C_SUSPEND)
2375 			clear_port_feature(hub->hdev, port1,
2376 					USB_PORT_FEAT_C_SUSPEND);
2377 	}
2378 
2379 	clear_bit(port1, hub->busy_bits);
2380 
2381 	status = check_port_resume_type(udev,
2382 			hub, port1, status, portchange, portstatus);
2383 	if (status == 0)
2384 		status = finish_port_resume(udev);
2385 	if (status < 0) {
2386 		dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2387 		hub_port_logical_disconnect(hub, port1);
2388 	}
2389 	return status;
2390 }
2391 
2392 /* caller has locked udev */
2393 int usb_remote_wakeup(struct usb_device *udev)
2394 {
2395 	int	status = 0;
2396 
2397 	if (udev->state == USB_STATE_SUSPENDED) {
2398 		dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
2399 		status = usb_autoresume_device(udev);
2400 		if (status == 0) {
2401 			/* Let the drivers do their thing, then... */
2402 			usb_autosuspend_device(udev);
2403 		}
2404 	}
2405 	return status;
2406 }
2407 
2408 #else	/* CONFIG_USB_SUSPEND */
2409 
2410 /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
2411 
2412 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2413 {
2414 	return 0;
2415 }
2416 
2417 /* However we may need to do a reset-resume */
2418 
2419 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
2420 {
2421 	struct usb_hub	*hub = hdev_to_hub(udev->parent);
2422 	int		port1 = udev->portnum;
2423 	int		status;
2424 	u16		portchange, portstatus;
2425 
2426 	status = hub_port_status(hub, port1, &portstatus, &portchange);
2427 	status = check_port_resume_type(udev,
2428 			hub, port1, status, portchange, portstatus);
2429 
2430 	if (status) {
2431 		dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2432 		hub_port_logical_disconnect(hub, port1);
2433 	} else if (udev->reset_resume) {
2434 		dev_dbg(&udev->dev, "reset-resume\n");
2435 		status = usb_reset_and_verify_device(udev);
2436 	}
2437 	return status;
2438 }
2439 
2440 #endif
2441 
2442 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
2443 {
2444 	struct usb_hub		*hub = usb_get_intfdata (intf);
2445 	struct usb_device	*hdev = hub->hdev;
2446 	unsigned		port1;
2447 
2448 	/* fail if children aren't already suspended */
2449 	for (port1 = 1; port1 <= hdev->maxchild; port1++) {
2450 		struct usb_device	*udev;
2451 
2452 		udev = hdev->children [port1-1];
2453 		if (udev && udev->can_submit) {
2454 			if (!(msg.event & PM_EVENT_AUTO))
2455 				dev_dbg(&intf->dev, "port %d nyet suspended\n",
2456 						port1);
2457 			return -EBUSY;
2458 		}
2459 	}
2460 
2461 	dev_dbg(&intf->dev, "%s\n", __func__);
2462 
2463 	/* stop khubd and related activity */
2464 	hub_quiesce(hub, HUB_SUSPEND);
2465 	return 0;
2466 }
2467 
2468 static int hub_resume(struct usb_interface *intf)
2469 {
2470 	struct usb_hub *hub = usb_get_intfdata(intf);
2471 
2472 	dev_dbg(&intf->dev, "%s\n", __func__);
2473 	hub_activate(hub, HUB_RESUME);
2474 	return 0;
2475 }
2476 
2477 static int hub_reset_resume(struct usb_interface *intf)
2478 {
2479 	struct usb_hub *hub = usb_get_intfdata(intf);
2480 
2481 	dev_dbg(&intf->dev, "%s\n", __func__);
2482 	hub_activate(hub, HUB_RESET_RESUME);
2483 	return 0;
2484 }
2485 
2486 /**
2487  * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
2488  * @rhdev: struct usb_device for the root hub
2489  *
2490  * The USB host controller driver calls this function when its root hub
2491  * is resumed and Vbus power has been interrupted or the controller
2492  * has been reset.  The routine marks @rhdev as having lost power.
2493  * When the hub driver is resumed it will take notice and carry out
2494  * power-session recovery for all the "USB-PERSIST"-enabled child devices;
2495  * the others will be disconnected.
2496  */
2497 void usb_root_hub_lost_power(struct usb_device *rhdev)
2498 {
2499 	dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
2500 	rhdev->reset_resume = 1;
2501 }
2502 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
2503 
2504 #else	/* CONFIG_PM */
2505 
2506 #define hub_suspend		NULL
2507 #define hub_resume		NULL
2508 #define hub_reset_resume	NULL
2509 #endif
2510 
2511 
2512 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2513  *
2514  * Between connect detection and reset signaling there must be a delay
2515  * of 100ms at least for debounce and power-settling.  The corresponding
2516  * timer shall restart whenever the downstream port detects a disconnect.
2517  *
2518  * Apparently there are some bluetooth and irda-dongles and a number of
2519  * low-speed devices for which this debounce period may last over a second.
2520  * Not covered by the spec - but easy to deal with.
2521  *
2522  * This implementation uses a 1500ms total debounce timeout; if the
2523  * connection isn't stable by then it returns -ETIMEDOUT.  It checks
2524  * every 25ms for transient disconnects.  When the port status has been
2525  * unchanged for 100ms it returns the port status.
2526  */
2527 static int hub_port_debounce(struct usb_hub *hub, int port1)
2528 {
2529 	int ret;
2530 	int total_time, stable_time = 0;
2531 	u16 portchange, portstatus;
2532 	unsigned connection = 0xffff;
2533 
2534 	for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2535 		ret = hub_port_status(hub, port1, &portstatus, &portchange);
2536 		if (ret < 0)
2537 			return ret;
2538 
2539 		if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2540 		     (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2541 			stable_time += HUB_DEBOUNCE_STEP;
2542 			if (stable_time >= HUB_DEBOUNCE_STABLE)
2543 				break;
2544 		} else {
2545 			stable_time = 0;
2546 			connection = portstatus & USB_PORT_STAT_CONNECTION;
2547 		}
2548 
2549 		if (portchange & USB_PORT_STAT_C_CONNECTION) {
2550 			clear_port_feature(hub->hdev, port1,
2551 					USB_PORT_FEAT_C_CONNECTION);
2552 		}
2553 
2554 		if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2555 			break;
2556 		msleep(HUB_DEBOUNCE_STEP);
2557 	}
2558 
2559 	dev_dbg (hub->intfdev,
2560 		"debounce: port %d: total %dms stable %dms status 0x%x\n",
2561 		port1, total_time, stable_time, portstatus);
2562 
2563 	if (stable_time < HUB_DEBOUNCE_STABLE)
2564 		return -ETIMEDOUT;
2565 	return portstatus;
2566 }
2567 
2568 void usb_ep0_reinit(struct usb_device *udev)
2569 {
2570 	usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
2571 	usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
2572 	usb_enable_endpoint(udev, &udev->ep0, true);
2573 }
2574 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
2575 
2576 #define usb_sndaddr0pipe()	(PIPE_CONTROL << 30)
2577 #define usb_rcvaddr0pipe()	((PIPE_CONTROL << 30) | USB_DIR_IN)
2578 
2579 static int hub_set_address(struct usb_device *udev, int devnum)
2580 {
2581 	int retval;
2582 	struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2583 
2584 	/*
2585 	 * The host controller will choose the device address,
2586 	 * instead of the core having chosen it earlier
2587 	 */
2588 	if (!hcd->driver->address_device && devnum <= 1)
2589 		return -EINVAL;
2590 	if (udev->state == USB_STATE_ADDRESS)
2591 		return 0;
2592 	if (udev->state != USB_STATE_DEFAULT)
2593 		return -EINVAL;
2594 	if (hcd->driver->address_device) {
2595 		retval = hcd->driver->address_device(hcd, udev);
2596 	} else {
2597 		retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2598 				USB_REQ_SET_ADDRESS, 0, devnum, 0,
2599 				NULL, 0, USB_CTRL_SET_TIMEOUT);
2600 		if (retval == 0)
2601 			update_address(udev, devnum);
2602 	}
2603 	if (retval == 0) {
2604 		/* Device now using proper address. */
2605 		usb_set_device_state(udev, USB_STATE_ADDRESS);
2606 		usb_ep0_reinit(udev);
2607 	}
2608 	return retval;
2609 }
2610 
2611 /* Reset device, (re)assign address, get device descriptor.
2612  * Device connection must be stable, no more debouncing needed.
2613  * Returns device in USB_STATE_ADDRESS, except on error.
2614  *
2615  * If this is called for an already-existing device (as part of
2616  * usb_reset_and_verify_device), the caller must own the device lock.  For a
2617  * newly detected device that is not accessible through any global
2618  * pointers, it's not necessary to lock the device.
2619  */
2620 static int
2621 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2622 		int retry_counter)
2623 {
2624 	static DEFINE_MUTEX(usb_address0_mutex);
2625 
2626 	struct usb_device	*hdev = hub->hdev;
2627 	struct usb_hcd		*hcd = bus_to_hcd(hdev->bus);
2628 	int			i, j, retval;
2629 	unsigned		delay = HUB_SHORT_RESET_TIME;
2630 	enum usb_device_speed	oldspeed = udev->speed;
2631 	char 			*speed, *type;
2632 	int			devnum = udev->devnum;
2633 
2634 	/* root hub ports have a slightly longer reset period
2635 	 * (from USB 2.0 spec, section 7.1.7.5)
2636 	 */
2637 	if (!hdev->parent) {
2638 		delay = HUB_ROOT_RESET_TIME;
2639 		if (port1 == hdev->bus->otg_port)
2640 			hdev->bus->b_hnp_enable = 0;
2641 	}
2642 
2643 	/* Some low speed devices have problems with the quick delay, so */
2644 	/*  be a bit pessimistic with those devices. RHbug #23670 */
2645 	if (oldspeed == USB_SPEED_LOW)
2646 		delay = HUB_LONG_RESET_TIME;
2647 
2648 	mutex_lock(&usb_address0_mutex);
2649 
2650 	if (!udev->config && oldspeed == USB_SPEED_SUPER) {
2651 		/* Don't reset USB 3.0 devices during an initial setup */
2652 		usb_set_device_state(udev, USB_STATE_DEFAULT);
2653 	} else {
2654 		/* Reset the device; full speed may morph to high speed */
2655 		/* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
2656 		retval = hub_port_reset(hub, port1, udev, delay);
2657 		if (retval < 0)		/* error or disconnect */
2658 			goto fail;
2659 		/* success, speed is known */
2660 	}
2661 	retval = -ENODEV;
2662 
2663 	if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2664 		dev_dbg(&udev->dev, "device reset changed speed!\n");
2665 		goto fail;
2666 	}
2667 	oldspeed = udev->speed;
2668 
2669 	/* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2670 	 * it's fixed size except for full speed devices.
2671 	 * For Wireless USB devices, ep0 max packet is always 512 (tho
2672 	 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
2673 	 */
2674 	switch (udev->speed) {
2675 	case USB_SPEED_SUPER:
2676 	case USB_SPEED_WIRELESS:	/* fixed at 512 */
2677 		udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
2678 		break;
2679 	case USB_SPEED_HIGH:		/* fixed at 64 */
2680 		udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
2681 		break;
2682 	case USB_SPEED_FULL:		/* 8, 16, 32, or 64 */
2683 		/* to determine the ep0 maxpacket size, try to read
2684 		 * the device descriptor to get bMaxPacketSize0 and
2685 		 * then correct our initial guess.
2686 		 */
2687 		udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
2688 		break;
2689 	case USB_SPEED_LOW:		/* fixed at 8 */
2690 		udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
2691 		break;
2692 	default:
2693 		goto fail;
2694 	}
2695 
2696 	type = "";
2697 	switch (udev->speed) {
2698 	case USB_SPEED_LOW:	speed = "low";	break;
2699 	case USB_SPEED_FULL:	speed = "full";	break;
2700 	case USB_SPEED_HIGH:	speed = "high";	break;
2701 	case USB_SPEED_SUPER:
2702 				speed = "super";
2703 				break;
2704 	case USB_SPEED_WIRELESS:
2705 				speed = "variable";
2706 				type = "Wireless ";
2707 				break;
2708 	default: 		speed = "?";	break;
2709 	}
2710 	if (udev->speed != USB_SPEED_SUPER)
2711 		dev_info(&udev->dev,
2712 				"%s %s speed %sUSB device using %s and address %d\n",
2713 				(udev->config) ? "reset" : "new", speed, type,
2714 				udev->bus->controller->driver->name, devnum);
2715 
2716 	/* Set up TT records, if needed  */
2717 	if (hdev->tt) {
2718 		udev->tt = hdev->tt;
2719 		udev->ttport = hdev->ttport;
2720 	} else if (udev->speed != USB_SPEED_HIGH
2721 			&& hdev->speed == USB_SPEED_HIGH) {
2722 		udev->tt = &hub->tt;
2723 		udev->ttport = port1;
2724 	}
2725 
2726 	/* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2727 	 * Because device hardware and firmware is sometimes buggy in
2728 	 * this area, and this is how Linux has done it for ages.
2729 	 * Change it cautiously.
2730 	 *
2731 	 * NOTE:  If USE_NEW_SCHEME() is true we will start by issuing
2732 	 * a 64-byte GET_DESCRIPTOR request.  This is what Windows does,
2733 	 * so it may help with some non-standards-compliant devices.
2734 	 * Otherwise we start with SET_ADDRESS and then try to read the
2735 	 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2736 	 * value.
2737 	 */
2738 	for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
2739 		/*
2740 		 * An xHCI controller cannot send any packets to a device until
2741 		 * a set address command successfully completes.
2742 		 */
2743 		if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3)) {
2744 			struct usb_device_descriptor *buf;
2745 			int r = 0;
2746 
2747 #define GET_DESCRIPTOR_BUFSIZE	64
2748 			buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2749 			if (!buf) {
2750 				retval = -ENOMEM;
2751 				continue;
2752 			}
2753 
2754 			/* Retry on all errors; some devices are flakey.
2755 			 * 255 is for WUSB devices, we actually need to use
2756 			 * 512 (WUSB1.0[4.8.1]).
2757 			 */
2758 			for (j = 0; j < 3; ++j) {
2759 				buf->bMaxPacketSize0 = 0;
2760 				r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2761 					USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2762 					USB_DT_DEVICE << 8, 0,
2763 					buf, GET_DESCRIPTOR_BUFSIZE,
2764 					initial_descriptor_timeout);
2765 				switch (buf->bMaxPacketSize0) {
2766 				case 8: case 16: case 32: case 64: case 255:
2767 					if (buf->bDescriptorType ==
2768 							USB_DT_DEVICE) {
2769 						r = 0;
2770 						break;
2771 					}
2772 					/* FALL THROUGH */
2773 				default:
2774 					if (r == 0)
2775 						r = -EPROTO;
2776 					break;
2777 				}
2778 				if (r == 0)
2779 					break;
2780 			}
2781 			udev->descriptor.bMaxPacketSize0 =
2782 					buf->bMaxPacketSize0;
2783 			kfree(buf);
2784 
2785 			retval = hub_port_reset(hub, port1, udev, delay);
2786 			if (retval < 0)		/* error or disconnect */
2787 				goto fail;
2788 			if (oldspeed != udev->speed) {
2789 				dev_dbg(&udev->dev,
2790 					"device reset changed speed!\n");
2791 				retval = -ENODEV;
2792 				goto fail;
2793 			}
2794 			if (r) {
2795 				dev_err(&udev->dev,
2796 					"device descriptor read/64, error %d\n",
2797 					r);
2798 				retval = -EMSGSIZE;
2799 				continue;
2800 			}
2801 #undef GET_DESCRIPTOR_BUFSIZE
2802 		}
2803 
2804  		/*
2805  		 * If device is WUSB, we already assigned an
2806  		 * unauthorized address in the Connect Ack sequence;
2807  		 * authorization will assign the final address.
2808  		 */
2809 		if (udev->wusb == 0) {
2810 			for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
2811 				retval = hub_set_address(udev, devnum);
2812 				if (retval >= 0)
2813 					break;
2814 				msleep(200);
2815 			}
2816 			if (retval < 0) {
2817 				dev_err(&udev->dev,
2818 					"device not accepting address %d, error %d\n",
2819 					devnum, retval);
2820 				goto fail;
2821 			}
2822 			if (udev->speed == USB_SPEED_SUPER) {
2823 				devnum = udev->devnum;
2824 				dev_info(&udev->dev,
2825 						"%s SuperSpeed USB device using %s and address %d\n",
2826 						(udev->config) ? "reset" : "new",
2827 						udev->bus->controller->driver->name, devnum);
2828 			}
2829 
2830 			/* cope with hardware quirkiness:
2831 			 *  - let SET_ADDRESS settle, some device hardware wants it
2832 			 *  - read ep0 maxpacket even for high and low speed,
2833 			 */
2834 			msleep(10);
2835 			if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3))
2836 				break;
2837   		}
2838 
2839 		retval = usb_get_device_descriptor(udev, 8);
2840 		if (retval < 8) {
2841 			dev_err(&udev->dev,
2842 					"device descriptor read/8, error %d\n",
2843 					retval);
2844 			if (retval >= 0)
2845 				retval = -EMSGSIZE;
2846 		} else {
2847 			retval = 0;
2848 			break;
2849 		}
2850 	}
2851 	if (retval)
2852 		goto fail;
2853 
2854 	if (udev->descriptor.bMaxPacketSize0 == 0xff ||
2855 			udev->speed == USB_SPEED_SUPER)
2856 		i = 512;
2857 	else
2858 		i = udev->descriptor.bMaxPacketSize0;
2859 	if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
2860 		if (udev->speed != USB_SPEED_FULL ||
2861 				!(i == 8 || i == 16 || i == 32 || i == 64)) {
2862 			dev_err(&udev->dev, "ep0 maxpacket = %d\n", i);
2863 			retval = -EMSGSIZE;
2864 			goto fail;
2865 		}
2866 		dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
2867 		udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
2868 		usb_ep0_reinit(udev);
2869 	}
2870 
2871 	retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
2872 	if (retval < (signed)sizeof(udev->descriptor)) {
2873 		dev_err(&udev->dev, "device descriptor read/all, error %d\n",
2874 			retval);
2875 		if (retval >= 0)
2876 			retval = -ENOMSG;
2877 		goto fail;
2878 	}
2879 
2880 	retval = 0;
2881 
2882 fail:
2883 	if (retval) {
2884 		hub_port_disable(hub, port1, 0);
2885 		update_address(udev, devnum);	/* for disconnect processing */
2886 	}
2887 	mutex_unlock(&usb_address0_mutex);
2888 	return retval;
2889 }
2890 
2891 static void
2892 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
2893 {
2894 	struct usb_qualifier_descriptor	*qual;
2895 	int				status;
2896 
2897 	qual = kmalloc (sizeof *qual, GFP_KERNEL);
2898 	if (qual == NULL)
2899 		return;
2900 
2901 	status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
2902 			qual, sizeof *qual);
2903 	if (status == sizeof *qual) {
2904 		dev_info(&udev->dev, "not running at top speed; "
2905 			"connect to a high speed hub\n");
2906 		/* hub LEDs are probably harder to miss than syslog */
2907 		if (hub->has_indicators) {
2908 			hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
2909 			schedule_delayed_work (&hub->leds, 0);
2910 		}
2911 	}
2912 	kfree(qual);
2913 }
2914 
2915 static unsigned
2916 hub_power_remaining (struct usb_hub *hub)
2917 {
2918 	struct usb_device *hdev = hub->hdev;
2919 	int remaining;
2920 	int port1;
2921 
2922 	if (!hub->limited_power)
2923 		return 0;
2924 
2925 	remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
2926 	for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
2927 		struct usb_device	*udev = hdev->children[port1 - 1];
2928 		int			delta;
2929 
2930 		if (!udev)
2931 			continue;
2932 
2933 		/* Unconfigured devices may not use more than 100mA,
2934 		 * or 8mA for OTG ports */
2935 		if (udev->actconfig)
2936 			delta = udev->actconfig->desc.bMaxPower * 2;
2937 		else if (port1 != udev->bus->otg_port || hdev->parent)
2938 			delta = 100;
2939 		else
2940 			delta = 8;
2941 		if (delta > hub->mA_per_port)
2942 			dev_warn(&udev->dev,
2943 				 "%dmA is over %umA budget for port %d!\n",
2944 				 delta, hub->mA_per_port, port1);
2945 		remaining -= delta;
2946 	}
2947 	if (remaining < 0) {
2948 		dev_warn(hub->intfdev, "%dmA over power budget!\n",
2949 			- remaining);
2950 		remaining = 0;
2951 	}
2952 	return remaining;
2953 }
2954 
2955 /* Handle physical or logical connection change events.
2956  * This routine is called when:
2957  * 	a port connection-change occurs;
2958  *	a port enable-change occurs (often caused by EMI);
2959  *	usb_reset_and_verify_device() encounters changed descriptors (as from
2960  *		a firmware download)
2961  * caller already locked the hub
2962  */
2963 static void hub_port_connect_change(struct usb_hub *hub, int port1,
2964 					u16 portstatus, u16 portchange)
2965 {
2966 	struct usb_device *hdev = hub->hdev;
2967 	struct device *hub_dev = hub->intfdev;
2968 	struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
2969 	unsigned wHubCharacteristics =
2970 			le16_to_cpu(hub->descriptor->wHubCharacteristics);
2971 	struct usb_device *udev;
2972 	int status, i;
2973 
2974 	dev_dbg (hub_dev,
2975 		"port %d, status %04x, change %04x, %s\n",
2976 		port1, portstatus, portchange, portspeed (portstatus));
2977 
2978 	if (hub->has_indicators) {
2979 		set_port_led(hub, port1, HUB_LED_AUTO);
2980 		hub->indicator[port1-1] = INDICATOR_AUTO;
2981 	}
2982 
2983 #ifdef	CONFIG_USB_OTG
2984 	/* during HNP, don't repeat the debounce */
2985 	if (hdev->bus->is_b_host)
2986 		portchange &= ~(USB_PORT_STAT_C_CONNECTION |
2987 				USB_PORT_STAT_C_ENABLE);
2988 #endif
2989 
2990 	/* Try to resuscitate an existing device */
2991 	udev = hdev->children[port1-1];
2992 	if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
2993 			udev->state != USB_STATE_NOTATTACHED) {
2994 		usb_lock_device(udev);
2995 		if (portstatus & USB_PORT_STAT_ENABLE) {
2996 			status = 0;		/* Nothing to do */
2997 
2998 #ifdef CONFIG_USB_SUSPEND
2999 		} else if (udev->state == USB_STATE_SUSPENDED &&
3000 				udev->persist_enabled) {
3001 			/* For a suspended device, treat this as a
3002 			 * remote wakeup event.
3003 			 */
3004 			status = usb_remote_wakeup(udev);
3005 #endif
3006 
3007 		} else {
3008 			status = -ENODEV;	/* Don't resuscitate */
3009 		}
3010 		usb_unlock_device(udev);
3011 
3012 		if (status == 0) {
3013 			clear_bit(port1, hub->change_bits);
3014 			return;
3015 		}
3016 	}
3017 
3018 	/* Disconnect any existing devices under this port */
3019 	if (udev)
3020 		usb_disconnect(&hdev->children[port1-1]);
3021 	clear_bit(port1, hub->change_bits);
3022 
3023 	/* We can forget about a "removed" device when there's a physical
3024 	 * disconnect or the connect status changes.
3025 	 */
3026 	if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
3027 			(portchange & USB_PORT_STAT_C_CONNECTION))
3028 		clear_bit(port1, hub->removed_bits);
3029 
3030 	if (portchange & (USB_PORT_STAT_C_CONNECTION |
3031 				USB_PORT_STAT_C_ENABLE)) {
3032 		status = hub_port_debounce(hub, port1);
3033 		if (status < 0) {
3034 			if (printk_ratelimit())
3035 				dev_err(hub_dev, "connect-debounce failed, "
3036 						"port %d disabled\n", port1);
3037 			portstatus &= ~USB_PORT_STAT_CONNECTION;
3038 		} else {
3039 			portstatus = status;
3040 		}
3041 	}
3042 
3043 	/* Return now if debouncing failed or nothing is connected or
3044 	 * the device was "removed".
3045 	 */
3046 	if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
3047 			test_bit(port1, hub->removed_bits)) {
3048 
3049 		/* maybe switch power back on (e.g. root hub was reset) */
3050 		if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
3051 				&& !(portstatus & USB_PORT_STAT_POWER))
3052 			set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
3053 
3054 		if (portstatus & USB_PORT_STAT_ENABLE)
3055   			goto done;
3056 		return;
3057 	}
3058 
3059 	for (i = 0; i < SET_CONFIG_TRIES; i++) {
3060 
3061 		/* reallocate for each attempt, since references
3062 		 * to the previous one can escape in various ways
3063 		 */
3064 		udev = usb_alloc_dev(hdev, hdev->bus, port1);
3065 		if (!udev) {
3066 			dev_err (hub_dev,
3067 				"couldn't allocate port %d usb_device\n",
3068 				port1);
3069 			goto done;
3070 		}
3071 
3072 		usb_set_device_state(udev, USB_STATE_POWERED);
3073  		udev->bus_mA = hub->mA_per_port;
3074 		udev->level = hdev->level + 1;
3075 		udev->wusb = hub_is_wusb(hub);
3076 
3077 		/*
3078 		 * USB 3.0 devices are reset automatically before the connect
3079 		 * port status change appears, and the root hub port status
3080 		 * shows the correct speed.  We also get port change
3081 		 * notifications for USB 3.0 devices from the USB 3.0 portion of
3082 		 * an external USB 3.0 hub, but this isn't handled correctly yet
3083 		 * FIXME.
3084 		 */
3085 
3086 		if (!(hcd->driver->flags & HCD_USB3))
3087 			udev->speed = USB_SPEED_UNKNOWN;
3088 		else if ((hdev->parent == NULL) &&
3089 				(portstatus & USB_PORT_STAT_SUPER_SPEED))
3090 			udev->speed = USB_SPEED_SUPER;
3091 		else
3092 			udev->speed = USB_SPEED_UNKNOWN;
3093 
3094 		/*
3095 		 * xHCI needs to issue an address device command later
3096 		 * in the hub_port_init sequence for SS/HS/FS/LS devices.
3097 		 */
3098 		if (!(hcd->driver->flags & HCD_USB3)) {
3099 			/* set the address */
3100 			choose_address(udev);
3101 			if (udev->devnum <= 0) {
3102 				status = -ENOTCONN;	/* Don't retry */
3103 				goto loop;
3104 			}
3105 		}
3106 
3107 		/* reset (non-USB 3.0 devices) and get descriptor */
3108 		status = hub_port_init(hub, udev, port1, i);
3109 		if (status < 0)
3110 			goto loop;
3111 
3112 		/* consecutive bus-powered hubs aren't reliable; they can
3113 		 * violate the voltage drop budget.  if the new child has
3114 		 * a "powered" LED, users should notice we didn't enable it
3115 		 * (without reading syslog), even without per-port LEDs
3116 		 * on the parent.
3117 		 */
3118 		if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
3119 				&& udev->bus_mA <= 100) {
3120 			u16	devstat;
3121 
3122 			status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
3123 					&devstat);
3124 			if (status < 2) {
3125 				dev_dbg(&udev->dev, "get status %d ?\n", status);
3126 				goto loop_disable;
3127 			}
3128 			le16_to_cpus(&devstat);
3129 			if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
3130 				dev_err(&udev->dev,
3131 					"can't connect bus-powered hub "
3132 					"to this port\n");
3133 				if (hub->has_indicators) {
3134 					hub->indicator[port1-1] =
3135 						INDICATOR_AMBER_BLINK;
3136 					schedule_delayed_work (&hub->leds, 0);
3137 				}
3138 				status = -ENOTCONN;	/* Don't retry */
3139 				goto loop_disable;
3140 			}
3141 		}
3142 
3143 		/* check for devices running slower than they could */
3144 		if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
3145 				&& udev->speed == USB_SPEED_FULL
3146 				&& highspeed_hubs != 0)
3147 			check_highspeed (hub, udev, port1);
3148 
3149 		/* Store the parent's children[] pointer.  At this point
3150 		 * udev becomes globally accessible, although presumably
3151 		 * no one will look at it until hdev is unlocked.
3152 		 */
3153 		status = 0;
3154 
3155 		/* We mustn't add new devices if the parent hub has
3156 		 * been disconnected; we would race with the
3157 		 * recursively_mark_NOTATTACHED() routine.
3158 		 */
3159 		spin_lock_irq(&device_state_lock);
3160 		if (hdev->state == USB_STATE_NOTATTACHED)
3161 			status = -ENOTCONN;
3162 		else
3163 			hdev->children[port1-1] = udev;
3164 		spin_unlock_irq(&device_state_lock);
3165 
3166 		/* Run it through the hoops (find a driver, etc) */
3167 		if (!status) {
3168 			status = usb_new_device(udev);
3169 			if (status) {
3170 				spin_lock_irq(&device_state_lock);
3171 				hdev->children[port1-1] = NULL;
3172 				spin_unlock_irq(&device_state_lock);
3173 			}
3174 		}
3175 
3176 		if (status)
3177 			goto loop_disable;
3178 
3179 		status = hub_power_remaining(hub);
3180 		if (status)
3181 			dev_dbg(hub_dev, "%dmA power budget left\n", status);
3182 
3183 		return;
3184 
3185 loop_disable:
3186 		hub_port_disable(hub, port1, 1);
3187 loop:
3188 		usb_ep0_reinit(udev);
3189 		release_address(udev);
3190 		hub_free_dev(udev);
3191 		usb_put_dev(udev);
3192 		if ((status == -ENOTCONN) || (status == -ENOTSUPP))
3193 			break;
3194 	}
3195 	if (hub->hdev->parent ||
3196 			!hcd->driver->port_handed_over ||
3197 			!(hcd->driver->port_handed_over)(hcd, port1))
3198 		dev_err(hub_dev, "unable to enumerate USB device on port %d\n",
3199 				port1);
3200 
3201 done:
3202 	hub_port_disable(hub, port1, 1);
3203 	if (hcd->driver->relinquish_port && !hub->hdev->parent)
3204 		hcd->driver->relinquish_port(hcd, port1);
3205 }
3206 
3207 static void hub_events(void)
3208 {
3209 	struct list_head *tmp;
3210 	struct usb_device *hdev;
3211 	struct usb_interface *intf;
3212 	struct usb_hub *hub;
3213 	struct device *hub_dev;
3214 	u16 hubstatus;
3215 	u16 hubchange;
3216 	u16 portstatus;
3217 	u16 portchange;
3218 	int i, ret;
3219 	int connect_change;
3220 
3221 	/*
3222 	 *  We restart the list every time to avoid a deadlock with
3223 	 * deleting hubs downstream from this one. This should be
3224 	 * safe since we delete the hub from the event list.
3225 	 * Not the most efficient, but avoids deadlocks.
3226 	 */
3227 	while (1) {
3228 
3229 		/* Grab the first entry at the beginning of the list */
3230 		spin_lock_irq(&hub_event_lock);
3231 		if (list_empty(&hub_event_list)) {
3232 			spin_unlock_irq(&hub_event_lock);
3233 			break;
3234 		}
3235 
3236 		tmp = hub_event_list.next;
3237 		list_del_init(tmp);
3238 
3239 		hub = list_entry(tmp, struct usb_hub, event_list);
3240 		kref_get(&hub->kref);
3241 		spin_unlock_irq(&hub_event_lock);
3242 
3243 		hdev = hub->hdev;
3244 		hub_dev = hub->intfdev;
3245 		intf = to_usb_interface(hub_dev);
3246 		dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
3247 				hdev->state, hub->descriptor
3248 					? hub->descriptor->bNbrPorts
3249 					: 0,
3250 				/* NOTE: expects max 15 ports... */
3251 				(u16) hub->change_bits[0],
3252 				(u16) hub->event_bits[0]);
3253 
3254 		/* Lock the device, then check to see if we were
3255 		 * disconnected while waiting for the lock to succeed. */
3256 		usb_lock_device(hdev);
3257 		if (unlikely(hub->disconnected))
3258 			goto loop_disconnected;
3259 
3260 		/* If the hub has died, clean up after it */
3261 		if (hdev->state == USB_STATE_NOTATTACHED) {
3262 			hub->error = -ENODEV;
3263 			hub_quiesce(hub, HUB_DISCONNECT);
3264 			goto loop;
3265 		}
3266 
3267 		/* Autoresume */
3268 		ret = usb_autopm_get_interface(intf);
3269 		if (ret) {
3270 			dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
3271 			goto loop;
3272 		}
3273 
3274 		/* If this is an inactive hub, do nothing */
3275 		if (hub->quiescing)
3276 			goto loop_autopm;
3277 
3278 		if (hub->error) {
3279 			dev_dbg (hub_dev, "resetting for error %d\n",
3280 				hub->error);
3281 
3282 			ret = usb_reset_device(hdev);
3283 			if (ret) {
3284 				dev_dbg (hub_dev,
3285 					"error resetting hub: %d\n", ret);
3286 				goto loop_autopm;
3287 			}
3288 
3289 			hub->nerrors = 0;
3290 			hub->error = 0;
3291 		}
3292 
3293 		/* deal with port status changes */
3294 		for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
3295 			if (test_bit(i, hub->busy_bits))
3296 				continue;
3297 			connect_change = test_bit(i, hub->change_bits);
3298 			if (!test_and_clear_bit(i, hub->event_bits) &&
3299 					!connect_change)
3300 				continue;
3301 
3302 			ret = hub_port_status(hub, i,
3303 					&portstatus, &portchange);
3304 			if (ret < 0)
3305 				continue;
3306 
3307 			if (portchange & USB_PORT_STAT_C_CONNECTION) {
3308 				clear_port_feature(hdev, i,
3309 					USB_PORT_FEAT_C_CONNECTION);
3310 				connect_change = 1;
3311 			}
3312 
3313 			if (portchange & USB_PORT_STAT_C_ENABLE) {
3314 				if (!connect_change)
3315 					dev_dbg (hub_dev,
3316 						"port %d enable change, "
3317 						"status %08x\n",
3318 						i, portstatus);
3319 				clear_port_feature(hdev, i,
3320 					USB_PORT_FEAT_C_ENABLE);
3321 
3322 				/*
3323 				 * EM interference sometimes causes badly
3324 				 * shielded USB devices to be shutdown by
3325 				 * the hub, this hack enables them again.
3326 				 * Works at least with mouse driver.
3327 				 */
3328 				if (!(portstatus & USB_PORT_STAT_ENABLE)
3329 				    && !connect_change
3330 				    && hdev->children[i-1]) {
3331 					dev_err (hub_dev,
3332 					    "port %i "
3333 					    "disabled by hub (EMI?), "
3334 					    "re-enabling...\n",
3335 						i);
3336 					connect_change = 1;
3337 				}
3338 			}
3339 
3340 			if (portchange & USB_PORT_STAT_C_SUSPEND) {
3341 				struct usb_device *udev;
3342 
3343 				clear_port_feature(hdev, i,
3344 					USB_PORT_FEAT_C_SUSPEND);
3345 				udev = hdev->children[i-1];
3346 				if (udev) {
3347 					/* TRSMRCY = 10 msec */
3348 					msleep(10);
3349 
3350 					usb_lock_device(udev);
3351 					ret = usb_remote_wakeup(hdev->
3352 							children[i-1]);
3353 					usb_unlock_device(udev);
3354 					if (ret < 0)
3355 						connect_change = 1;
3356 				} else {
3357 					ret = -ENODEV;
3358 					hub_port_disable(hub, i, 1);
3359 				}
3360 				dev_dbg (hub_dev,
3361 					"resume on port %d, status %d\n",
3362 					i, ret);
3363 			}
3364 
3365 			if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
3366 				dev_err (hub_dev,
3367 					"over-current change on port %d\n",
3368 					i);
3369 				clear_port_feature(hdev, i,
3370 					USB_PORT_FEAT_C_OVER_CURRENT);
3371 				hub_power_on(hub, true);
3372 			}
3373 
3374 			if (portchange & USB_PORT_STAT_C_RESET) {
3375 				dev_dbg (hub_dev,
3376 					"reset change on port %d\n",
3377 					i);
3378 				clear_port_feature(hdev, i,
3379 					USB_PORT_FEAT_C_RESET);
3380 			}
3381 
3382 			if (connect_change)
3383 				hub_port_connect_change(hub, i,
3384 						portstatus, portchange);
3385 		} /* end for i */
3386 
3387 		/* deal with hub status changes */
3388 		if (test_and_clear_bit(0, hub->event_bits) == 0)
3389 			;	/* do nothing */
3390 		else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
3391 			dev_err (hub_dev, "get_hub_status failed\n");
3392 		else {
3393 			if (hubchange & HUB_CHANGE_LOCAL_POWER) {
3394 				dev_dbg (hub_dev, "power change\n");
3395 				clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
3396 				if (hubstatus & HUB_STATUS_LOCAL_POWER)
3397 					/* FIXME: Is this always true? */
3398 					hub->limited_power = 1;
3399 				else
3400 					hub->limited_power = 0;
3401 			}
3402 			if (hubchange & HUB_CHANGE_OVERCURRENT) {
3403 				dev_dbg (hub_dev, "overcurrent change\n");
3404 				msleep(500);	/* Cool down */
3405 				clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
3406                         	hub_power_on(hub, true);
3407 			}
3408 		}
3409 
3410  loop_autopm:
3411 		/* Balance the usb_autopm_get_interface() above */
3412 		usb_autopm_put_interface_no_suspend(intf);
3413  loop:
3414 		/* Balance the usb_autopm_get_interface_no_resume() in
3415 		 * kick_khubd() and allow autosuspend.
3416 		 */
3417 		usb_autopm_put_interface(intf);
3418  loop_disconnected:
3419 		usb_unlock_device(hdev);
3420 		kref_put(&hub->kref, hub_release);
3421 
3422         } /* end while (1) */
3423 }
3424 
3425 static int hub_thread(void *__unused)
3426 {
3427 	/* khubd needs to be freezable to avoid intefering with USB-PERSIST
3428 	 * port handover.  Otherwise it might see that a full-speed device
3429 	 * was gone before the EHCI controller had handed its port over to
3430 	 * the companion full-speed controller.
3431 	 */
3432 	set_freezable();
3433 
3434 	do {
3435 		hub_events();
3436 		wait_event_freezable(khubd_wait,
3437 				!list_empty(&hub_event_list) ||
3438 				kthread_should_stop());
3439 	} while (!kthread_should_stop() || !list_empty(&hub_event_list));
3440 
3441 	pr_debug("%s: khubd exiting\n", usbcore_name);
3442 	return 0;
3443 }
3444 
3445 static const struct usb_device_id hub_id_table[] = {
3446     { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
3447       .bDeviceClass = USB_CLASS_HUB},
3448     { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
3449       .bInterfaceClass = USB_CLASS_HUB},
3450     { }						/* Terminating entry */
3451 };
3452 
3453 MODULE_DEVICE_TABLE (usb, hub_id_table);
3454 
3455 static struct usb_driver hub_driver = {
3456 	.name =		"hub",
3457 	.probe =	hub_probe,
3458 	.disconnect =	hub_disconnect,
3459 	.suspend =	hub_suspend,
3460 	.resume =	hub_resume,
3461 	.reset_resume =	hub_reset_resume,
3462 	.pre_reset =	hub_pre_reset,
3463 	.post_reset =	hub_post_reset,
3464 	.ioctl =	hub_ioctl,
3465 	.id_table =	hub_id_table,
3466 	.supports_autosuspend =	1,
3467 };
3468 
3469 int usb_hub_init(void)
3470 {
3471 	if (usb_register(&hub_driver) < 0) {
3472 		printk(KERN_ERR "%s: can't register hub driver\n",
3473 			usbcore_name);
3474 		return -1;
3475 	}
3476 
3477 	khubd_task = kthread_run(hub_thread, NULL, "khubd");
3478 	if (!IS_ERR(khubd_task))
3479 		return 0;
3480 
3481 	/* Fall through if kernel_thread failed */
3482 	usb_deregister(&hub_driver);
3483 	printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
3484 
3485 	return -1;
3486 }
3487 
3488 void usb_hub_cleanup(void)
3489 {
3490 	kthread_stop(khubd_task);
3491 
3492 	/*
3493 	 * Hub resources are freed for us by usb_deregister. It calls
3494 	 * usb_driver_purge on every device which in turn calls that
3495 	 * devices disconnect function if it is using this driver.
3496 	 * The hub_disconnect function takes care of releasing the
3497 	 * individual hub resources. -greg
3498 	 */
3499 	usb_deregister(&hub_driver);
3500 } /* usb_hub_cleanup() */
3501 
3502 static int descriptors_changed(struct usb_device *udev,
3503 		struct usb_device_descriptor *old_device_descriptor)
3504 {
3505 	int		changed = 0;
3506 	unsigned	index;
3507 	unsigned	serial_len = 0;
3508 	unsigned	len;
3509 	unsigned	old_length;
3510 	int		length;
3511 	char		*buf;
3512 
3513 	if (memcmp(&udev->descriptor, old_device_descriptor,
3514 			sizeof(*old_device_descriptor)) != 0)
3515 		return 1;
3516 
3517 	/* Since the idVendor, idProduct, and bcdDevice values in the
3518 	 * device descriptor haven't changed, we will assume the
3519 	 * Manufacturer and Product strings haven't changed either.
3520 	 * But the SerialNumber string could be different (e.g., a
3521 	 * different flash card of the same brand).
3522 	 */
3523 	if (udev->serial)
3524 		serial_len = strlen(udev->serial) + 1;
3525 
3526 	len = serial_len;
3527 	for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3528 		old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3529 		len = max(len, old_length);
3530 	}
3531 
3532 	buf = kmalloc(len, GFP_NOIO);
3533 	if (buf == NULL) {
3534 		dev_err(&udev->dev, "no mem to re-read configs after reset\n");
3535 		/* assume the worst */
3536 		return 1;
3537 	}
3538 	for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3539 		old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3540 		length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
3541 				old_length);
3542 		if (length != old_length) {
3543 			dev_dbg(&udev->dev, "config index %d, error %d\n",
3544 					index, length);
3545 			changed = 1;
3546 			break;
3547 		}
3548 		if (memcmp (buf, udev->rawdescriptors[index], old_length)
3549 				!= 0) {
3550 			dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
3551 				index,
3552 				((struct usb_config_descriptor *) buf)->
3553 					bConfigurationValue);
3554 			changed = 1;
3555 			break;
3556 		}
3557 	}
3558 
3559 	if (!changed && serial_len) {
3560 		length = usb_string(udev, udev->descriptor.iSerialNumber,
3561 				buf, serial_len);
3562 		if (length + 1 != serial_len) {
3563 			dev_dbg(&udev->dev, "serial string error %d\n",
3564 					length);
3565 			changed = 1;
3566 		} else if (memcmp(buf, udev->serial, length) != 0) {
3567 			dev_dbg(&udev->dev, "serial string changed\n");
3568 			changed = 1;
3569 		}
3570 	}
3571 
3572 	kfree(buf);
3573 	return changed;
3574 }
3575 
3576 /**
3577  * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
3578  * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3579  *
3580  * WARNING - don't use this routine to reset a composite device
3581  * (one with multiple interfaces owned by separate drivers)!
3582  * Use usb_reset_device() instead.
3583  *
3584  * Do a port reset, reassign the device's address, and establish its
3585  * former operating configuration.  If the reset fails, or the device's
3586  * descriptors change from their values before the reset, or the original
3587  * configuration and altsettings cannot be restored, a flag will be set
3588  * telling khubd to pretend the device has been disconnected and then
3589  * re-connected.  All drivers will be unbound, and the device will be
3590  * re-enumerated and probed all over again.
3591  *
3592  * Returns 0 if the reset succeeded, -ENODEV if the device has been
3593  * flagged for logical disconnection, or some other negative error code
3594  * if the reset wasn't even attempted.
3595  *
3596  * The caller must own the device lock.  For example, it's safe to use
3597  * this from a driver probe() routine after downloading new firmware.
3598  * For calls that might not occur during probe(), drivers should lock
3599  * the device using usb_lock_device_for_reset().
3600  *
3601  * Locking exception: This routine may also be called from within an
3602  * autoresume handler.  Such usage won't conflict with other tasks
3603  * holding the device lock because these tasks should always call
3604  * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
3605  */
3606 static int usb_reset_and_verify_device(struct usb_device *udev)
3607 {
3608 	struct usb_device		*parent_hdev = udev->parent;
3609 	struct usb_hub			*parent_hub;
3610 	struct usb_hcd			*hcd = bus_to_hcd(udev->bus);
3611 	struct usb_device_descriptor	descriptor = udev->descriptor;
3612 	int 				i, ret = 0;
3613 	int				port1 = udev->portnum;
3614 
3615 	if (udev->state == USB_STATE_NOTATTACHED ||
3616 			udev->state == USB_STATE_SUSPENDED) {
3617 		dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3618 				udev->state);
3619 		return -EINVAL;
3620 	}
3621 
3622 	if (!parent_hdev) {
3623 		/* this requires hcd-specific logic; see OHCI hc_restart() */
3624 		dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
3625 		return -EISDIR;
3626 	}
3627 	parent_hub = hdev_to_hub(parent_hdev);
3628 
3629 	set_bit(port1, parent_hub->busy_bits);
3630 	for (i = 0; i < SET_CONFIG_TRIES; ++i) {
3631 
3632 		/* ep0 maxpacket size may change; let the HCD know about it.
3633 		 * Other endpoints will be handled by re-enumeration. */
3634 		usb_ep0_reinit(udev);
3635 		ret = hub_port_init(parent_hub, udev, port1, i);
3636 		if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
3637 			break;
3638 	}
3639 	clear_bit(port1, parent_hub->busy_bits);
3640 
3641 	if (ret < 0)
3642 		goto re_enumerate;
3643 
3644 	/* Device might have changed firmware (DFU or similar) */
3645 	if (descriptors_changed(udev, &descriptor)) {
3646 		dev_info(&udev->dev, "device firmware changed\n");
3647 		udev->descriptor = descriptor;	/* for disconnect() calls */
3648 		goto re_enumerate;
3649   	}
3650 
3651 	/* Restore the device's previous configuration */
3652 	if (!udev->actconfig)
3653 		goto done;
3654 
3655 	mutex_lock(&hcd->bandwidth_mutex);
3656 	ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
3657 	if (ret < 0) {
3658 		dev_warn(&udev->dev,
3659 				"Busted HC?  Not enough HCD resources for "
3660 				"old configuration.\n");
3661 		mutex_unlock(&hcd->bandwidth_mutex);
3662 		goto re_enumerate;
3663 	}
3664 	ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3665 			USB_REQ_SET_CONFIGURATION, 0,
3666 			udev->actconfig->desc.bConfigurationValue, 0,
3667 			NULL, 0, USB_CTRL_SET_TIMEOUT);
3668 	if (ret < 0) {
3669 		dev_err(&udev->dev,
3670 			"can't restore configuration #%d (error=%d)\n",
3671 			udev->actconfig->desc.bConfigurationValue, ret);
3672 		mutex_unlock(&hcd->bandwidth_mutex);
3673 		goto re_enumerate;
3674   	}
3675 	mutex_unlock(&hcd->bandwidth_mutex);
3676 	usb_set_device_state(udev, USB_STATE_CONFIGURED);
3677 
3678 	/* Put interfaces back into the same altsettings as before.
3679 	 * Don't bother to send the Set-Interface request for interfaces
3680 	 * that were already in altsetting 0; besides being unnecessary,
3681 	 * many devices can't handle it.  Instead just reset the host-side
3682 	 * endpoint state.
3683 	 */
3684 	for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
3685 		struct usb_host_config *config = udev->actconfig;
3686 		struct usb_interface *intf = config->interface[i];
3687 		struct usb_interface_descriptor *desc;
3688 
3689 		desc = &intf->cur_altsetting->desc;
3690 		if (desc->bAlternateSetting == 0) {
3691 			usb_disable_interface(udev, intf, true);
3692 			usb_enable_interface(udev, intf, true);
3693 			ret = 0;
3694 		} else {
3695 			/* Let the bandwidth allocation function know that this
3696 			 * device has been reset, and it will have to use
3697 			 * alternate setting 0 as the current alternate setting.
3698 			 */
3699 			intf->resetting_device = 1;
3700 			ret = usb_set_interface(udev, desc->bInterfaceNumber,
3701 					desc->bAlternateSetting);
3702 			intf->resetting_device = 0;
3703 		}
3704 		if (ret < 0) {
3705 			dev_err(&udev->dev, "failed to restore interface %d "
3706 				"altsetting %d (error=%d)\n",
3707 				desc->bInterfaceNumber,
3708 				desc->bAlternateSetting,
3709 				ret);
3710 			goto re_enumerate;
3711 		}
3712 	}
3713 
3714 done:
3715 	return 0;
3716 
3717 re_enumerate:
3718 	hub_port_logical_disconnect(parent_hub, port1);
3719 	return -ENODEV;
3720 }
3721 
3722 /**
3723  * usb_reset_device - warn interface drivers and perform a USB port reset
3724  * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3725  *
3726  * Warns all drivers bound to registered interfaces (using their pre_reset
3727  * method), performs the port reset, and then lets the drivers know that
3728  * the reset is over (using their post_reset method).
3729  *
3730  * Return value is the same as for usb_reset_and_verify_device().
3731  *
3732  * The caller must own the device lock.  For example, it's safe to use
3733  * this from a driver probe() routine after downloading new firmware.
3734  * For calls that might not occur during probe(), drivers should lock
3735  * the device using usb_lock_device_for_reset().
3736  *
3737  * If an interface is currently being probed or disconnected, we assume
3738  * its driver knows how to handle resets.  For all other interfaces,
3739  * if the driver doesn't have pre_reset and post_reset methods then
3740  * we attempt to unbind it and rebind afterward.
3741  */
3742 int usb_reset_device(struct usb_device *udev)
3743 {
3744 	int ret;
3745 	int i;
3746 	struct usb_host_config *config = udev->actconfig;
3747 
3748 	if (udev->state == USB_STATE_NOTATTACHED ||
3749 			udev->state == USB_STATE_SUSPENDED) {
3750 		dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3751 				udev->state);
3752 		return -EINVAL;
3753 	}
3754 
3755 	/* Prevent autosuspend during the reset */
3756 	usb_autoresume_device(udev);
3757 
3758 	if (config) {
3759 		for (i = 0; i < config->desc.bNumInterfaces; ++i) {
3760 			struct usb_interface *cintf = config->interface[i];
3761 			struct usb_driver *drv;
3762 			int unbind = 0;
3763 
3764 			if (cintf->dev.driver) {
3765 				drv = to_usb_driver(cintf->dev.driver);
3766 				if (drv->pre_reset && drv->post_reset)
3767 					unbind = (drv->pre_reset)(cintf);
3768 				else if (cintf->condition ==
3769 						USB_INTERFACE_BOUND)
3770 					unbind = 1;
3771 				if (unbind)
3772 					usb_forced_unbind_intf(cintf);
3773 			}
3774 		}
3775 	}
3776 
3777 	ret = usb_reset_and_verify_device(udev);
3778 
3779 	if (config) {
3780 		for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
3781 			struct usb_interface *cintf = config->interface[i];
3782 			struct usb_driver *drv;
3783 			int rebind = cintf->needs_binding;
3784 
3785 			if (!rebind && cintf->dev.driver) {
3786 				drv = to_usb_driver(cintf->dev.driver);
3787 				if (drv->post_reset)
3788 					rebind = (drv->post_reset)(cintf);
3789 				else if (cintf->condition ==
3790 						USB_INTERFACE_BOUND)
3791 					rebind = 1;
3792 			}
3793 			if (ret == 0 && rebind)
3794 				usb_rebind_intf(cintf);
3795 		}
3796 	}
3797 
3798 	usb_autosuspend_device(udev);
3799 	return ret;
3800 }
3801 EXPORT_SYMBOL_GPL(usb_reset_device);
3802 
3803 
3804 /**
3805  * usb_queue_reset_device - Reset a USB device from an atomic context
3806  * @iface: USB interface belonging to the device to reset
3807  *
3808  * This function can be used to reset a USB device from an atomic
3809  * context, where usb_reset_device() won't work (as it blocks).
3810  *
3811  * Doing a reset via this method is functionally equivalent to calling
3812  * usb_reset_device(), except for the fact that it is delayed to a
3813  * workqueue. This means that any drivers bound to other interfaces
3814  * might be unbound, as well as users from usbfs in user space.
3815  *
3816  * Corner cases:
3817  *
3818  * - Scheduling two resets at the same time from two different drivers
3819  *   attached to two different interfaces of the same device is
3820  *   possible; depending on how the driver attached to each interface
3821  *   handles ->pre_reset(), the second reset might happen or not.
3822  *
3823  * - If a driver is unbound and it had a pending reset, the reset will
3824  *   be cancelled.
3825  *
3826  * - This function can be called during .probe() or .disconnect()
3827  *   times. On return from .disconnect(), any pending resets will be
3828  *   cancelled.
3829  *
3830  * There is no no need to lock/unlock the @reset_ws as schedule_work()
3831  * does its own.
3832  *
3833  * NOTE: We don't do any reference count tracking because it is not
3834  *     needed. The lifecycle of the work_struct is tied to the
3835  *     usb_interface. Before destroying the interface we cancel the
3836  *     work_struct, so the fact that work_struct is queued and or
3837  *     running means the interface (and thus, the device) exist and
3838  *     are referenced.
3839  */
3840 void usb_queue_reset_device(struct usb_interface *iface)
3841 {
3842 	schedule_work(&iface->reset_ws);
3843 }
3844 EXPORT_SYMBOL_GPL(usb_queue_reset_device);
3845