xref: /openbmc/linux/drivers/usb/core/hub.c (revision 87c2ce3b)
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/config.h>
12 #include <linux/kernel.h>
13 #include <linux/errno.h>
14 #include <linux/module.h>
15 #include <linux/moduleparam.h>
16 #include <linux/completion.h>
17 #include <linux/sched.h>
18 #include <linux/list.h>
19 #include <linux/slab.h>
20 #include <linux/smp_lock.h>
21 #include <linux/ioctl.h>
22 #include <linux/usb.h>
23 #include <linux/usbdevice_fs.h>
24 #include <linux/kthread.h>
25 
26 #include <asm/semaphore.h>
27 #include <asm/uaccess.h>
28 #include <asm/byteorder.h>
29 
30 #include "usb.h"
31 #include "hcd.h"
32 #include "hub.h"
33 
34 /* Protect struct usb_device->state and ->children members
35  * Note: Both are also protected by ->dev.sem, except that ->state can
36  * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
37 static DEFINE_SPINLOCK(device_state_lock);
38 
39 /* khubd's worklist and its lock */
40 static DEFINE_SPINLOCK(hub_event_lock);
41 static LIST_HEAD(hub_event_list);	/* List of hubs needing servicing */
42 
43 /* Wakes up khubd */
44 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
45 
46 static struct task_struct *khubd_task;
47 
48 /* cycle leds on hubs that aren't blinking for attention */
49 static int blinkenlights = 0;
50 module_param (blinkenlights, bool, S_IRUGO);
51 MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
52 
53 /*
54  * As of 2.6.10 we introduce a new USB device initialization scheme which
55  * closely resembles the way Windows works.  Hopefully it will be compatible
56  * with a wider range of devices than the old scheme.  However some previously
57  * working devices may start giving rise to "device not accepting address"
58  * errors; if that happens the user can try the old scheme by adjusting the
59  * following module parameters.
60  *
61  * For maximum flexibility there are two boolean parameters to control the
62  * hub driver's behavior.  On the first initialization attempt, if the
63  * "old_scheme_first" parameter is set then the old scheme will be used,
64  * otherwise the new scheme is used.  If that fails and "use_both_schemes"
65  * is set, then the driver will make another attempt, using the other scheme.
66  */
67 static int old_scheme_first = 0;
68 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
69 MODULE_PARM_DESC(old_scheme_first,
70 		 "start with the old device initialization scheme");
71 
72 static int use_both_schemes = 1;
73 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
74 MODULE_PARM_DESC(use_both_schemes,
75 		"try the other device initialization scheme if the "
76 		"first one fails");
77 
78 
79 #ifdef	DEBUG
80 static inline char *portspeed (int portstatus)
81 {
82 	if (portstatus & (1 << USB_PORT_FEAT_HIGHSPEED))
83     		return "480 Mb/s";
84 	else if (portstatus & (1 << USB_PORT_FEAT_LOWSPEED))
85 		return "1.5 Mb/s";
86 	else
87 		return "12 Mb/s";
88 }
89 #endif
90 
91 /* Note that hdev or one of its children must be locked! */
92 static inline struct usb_hub *hdev_to_hub(struct usb_device *hdev)
93 {
94 	return usb_get_intfdata(hdev->actconfig->interface[0]);
95 }
96 
97 /* USB 2.0 spec Section 11.24.4.5 */
98 static int get_hub_descriptor(struct usb_device *hdev, void *data, int size)
99 {
100 	int i, ret;
101 
102 	for (i = 0; i < 3; i++) {
103 		ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
104 			USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
105 			USB_DT_HUB << 8, 0, data, size,
106 			USB_CTRL_GET_TIMEOUT);
107 		if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
108 			return ret;
109 	}
110 	return -EINVAL;
111 }
112 
113 /*
114  * USB 2.0 spec Section 11.24.2.1
115  */
116 static int clear_hub_feature(struct usb_device *hdev, int feature)
117 {
118 	return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
119 		USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
120 }
121 
122 /*
123  * USB 2.0 spec Section 11.24.2.2
124  */
125 static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
126 {
127 	return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
128 		USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
129 		NULL, 0, 1000);
130 }
131 
132 /*
133  * USB 2.0 spec Section 11.24.2.13
134  */
135 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
136 {
137 	return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
138 		USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
139 		NULL, 0, 1000);
140 }
141 
142 /*
143  * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
144  * for info about using port indicators
145  */
146 static void set_port_led(
147 	struct usb_hub *hub,
148 	int port1,
149 	int selector
150 )
151 {
152 	int status = set_port_feature(hub->hdev, (selector << 8) | port1,
153 			USB_PORT_FEAT_INDICATOR);
154 	if (status < 0)
155 		dev_dbg (hub->intfdev,
156 			"port %d indicator %s status %d\n",
157 			port1,
158 			({ char *s; switch (selector) {
159 			case HUB_LED_AMBER: s = "amber"; break;
160 			case HUB_LED_GREEN: s = "green"; break;
161 			case HUB_LED_OFF: s = "off"; break;
162 			case HUB_LED_AUTO: s = "auto"; break;
163 			default: s = "??"; break;
164 			}; s; }),
165 			status);
166 }
167 
168 #define	LED_CYCLE_PERIOD	((2*HZ)/3)
169 
170 static void led_work (void *__hub)
171 {
172 	struct usb_hub		*hub = __hub;
173 	struct usb_device	*hdev = hub->hdev;
174 	unsigned		i;
175 	unsigned		changed = 0;
176 	int			cursor = -1;
177 
178 	if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
179 		return;
180 
181 	for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
182 		unsigned	selector, mode;
183 
184 		/* 30%-50% duty cycle */
185 
186 		switch (hub->indicator[i]) {
187 		/* cycle marker */
188 		case INDICATOR_CYCLE:
189 			cursor = i;
190 			selector = HUB_LED_AUTO;
191 			mode = INDICATOR_AUTO;
192 			break;
193 		/* blinking green = sw attention */
194 		case INDICATOR_GREEN_BLINK:
195 			selector = HUB_LED_GREEN;
196 			mode = INDICATOR_GREEN_BLINK_OFF;
197 			break;
198 		case INDICATOR_GREEN_BLINK_OFF:
199 			selector = HUB_LED_OFF;
200 			mode = INDICATOR_GREEN_BLINK;
201 			break;
202 		/* blinking amber = hw attention */
203 		case INDICATOR_AMBER_BLINK:
204 			selector = HUB_LED_AMBER;
205 			mode = INDICATOR_AMBER_BLINK_OFF;
206 			break;
207 		case INDICATOR_AMBER_BLINK_OFF:
208 			selector = HUB_LED_OFF;
209 			mode = INDICATOR_AMBER_BLINK;
210 			break;
211 		/* blink green/amber = reserved */
212 		case INDICATOR_ALT_BLINK:
213 			selector = HUB_LED_GREEN;
214 			mode = INDICATOR_ALT_BLINK_OFF;
215 			break;
216 		case INDICATOR_ALT_BLINK_OFF:
217 			selector = HUB_LED_AMBER;
218 			mode = INDICATOR_ALT_BLINK;
219 			break;
220 		default:
221 			continue;
222 		}
223 		if (selector != HUB_LED_AUTO)
224 			changed = 1;
225 		set_port_led(hub, i + 1, selector);
226 		hub->indicator[i] = mode;
227 	}
228 	if (!changed && blinkenlights) {
229 		cursor++;
230 		cursor %= hub->descriptor->bNbrPorts;
231 		set_port_led(hub, cursor + 1, HUB_LED_GREEN);
232 		hub->indicator[cursor] = INDICATOR_CYCLE;
233 		changed++;
234 	}
235 	if (changed)
236 		schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
237 }
238 
239 /* use a short timeout for hub/port status fetches */
240 #define	USB_STS_TIMEOUT		1000
241 #define	USB_STS_RETRIES		5
242 
243 /*
244  * USB 2.0 spec Section 11.24.2.6
245  */
246 static int get_hub_status(struct usb_device *hdev,
247 		struct usb_hub_status *data)
248 {
249 	int i, status = -ETIMEDOUT;
250 
251 	for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
252 		status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
253 			USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
254 			data, sizeof(*data), USB_STS_TIMEOUT);
255 	}
256 	return status;
257 }
258 
259 /*
260  * USB 2.0 spec Section 11.24.2.7
261  */
262 static int get_port_status(struct usb_device *hdev, int port1,
263 		struct usb_port_status *data)
264 {
265 	int i, status = -ETIMEDOUT;
266 
267 	for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
268 		status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
269 			USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
270 			data, sizeof(*data), USB_STS_TIMEOUT);
271 	}
272 	return status;
273 }
274 
275 static void kick_khubd(struct usb_hub *hub)
276 {
277 	unsigned long	flags;
278 
279 	spin_lock_irqsave(&hub_event_lock, flags);
280 	if (list_empty(&hub->event_list)) {
281 		list_add_tail(&hub->event_list, &hub_event_list);
282 		wake_up(&khubd_wait);
283 	}
284 	spin_unlock_irqrestore(&hub_event_lock, flags);
285 }
286 
287 void usb_kick_khubd(struct usb_device *hdev)
288 {
289 	kick_khubd(hdev_to_hub(hdev));
290 }
291 
292 
293 /* completion function, fires on port status changes and various faults */
294 static void hub_irq(struct urb *urb, struct pt_regs *regs)
295 {
296 	struct usb_hub *hub = (struct usb_hub *)urb->context;
297 	int status;
298 	int i;
299 	unsigned long bits;
300 
301 	switch (urb->status) {
302 	case -ENOENT:		/* synchronous unlink */
303 	case -ECONNRESET:	/* async unlink */
304 	case -ESHUTDOWN:	/* hardware going away */
305 		return;
306 
307 	default:		/* presumably an error */
308 		/* Cause a hub reset after 10 consecutive errors */
309 		dev_dbg (hub->intfdev, "transfer --> %d\n", urb->status);
310 		if ((++hub->nerrors < 10) || hub->error)
311 			goto resubmit;
312 		hub->error = urb->status;
313 		/* FALL THROUGH */
314 
315 	/* let khubd handle things */
316 	case 0:			/* we got data:  port status changed */
317 		bits = 0;
318 		for (i = 0; i < urb->actual_length; ++i)
319 			bits |= ((unsigned long) ((*hub->buffer)[i]))
320 					<< (i*8);
321 		hub->event_bits[0] = bits;
322 		break;
323 	}
324 
325 	hub->nerrors = 0;
326 
327 	/* Something happened, let khubd figure it out */
328 	kick_khubd(hub);
329 
330 resubmit:
331 	if (hub->quiescing)
332 		return;
333 
334 	if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
335 			&& status != -ENODEV && status != -EPERM)
336 		dev_err (hub->intfdev, "resubmit --> %d\n", status);
337 }
338 
339 /* USB 2.0 spec Section 11.24.2.3 */
340 static inline int
341 hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
342 {
343 	return usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
344 			       HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
345 			       tt, NULL, 0, 1000);
346 }
347 
348 /*
349  * enumeration blocks khubd for a long time. we use keventd instead, since
350  * long blocking there is the exception, not the rule.  accordingly, HCDs
351  * talking to TTs must queue control transfers (not just bulk and iso), so
352  * both can talk to the same hub concurrently.
353  */
354 static void hub_tt_kevent (void *arg)
355 {
356 	struct usb_hub		*hub = arg;
357 	unsigned long		flags;
358 
359 	spin_lock_irqsave (&hub->tt.lock, flags);
360 	while (!list_empty (&hub->tt.clear_list)) {
361 		struct list_head	*temp;
362 		struct usb_tt_clear	*clear;
363 		struct usb_device	*hdev = hub->hdev;
364 		int			status;
365 
366 		temp = hub->tt.clear_list.next;
367 		clear = list_entry (temp, struct usb_tt_clear, clear_list);
368 		list_del (&clear->clear_list);
369 
370 		/* drop lock so HCD can concurrently report other TT errors */
371 		spin_unlock_irqrestore (&hub->tt.lock, flags);
372 		status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
373 		spin_lock_irqsave (&hub->tt.lock, flags);
374 
375 		if (status)
376 			dev_err (&hdev->dev,
377 				"clear tt %d (%04x) error %d\n",
378 				clear->tt, clear->devinfo, status);
379 		kfree(clear);
380 	}
381 	spin_unlock_irqrestore (&hub->tt.lock, flags);
382 }
383 
384 /**
385  * usb_hub_tt_clear_buffer - clear control/bulk TT state in high speed hub
386  * @udev: the device whose split transaction failed
387  * @pipe: identifies the endpoint of the failed transaction
388  *
389  * High speed HCDs use this to tell the hub driver that some split control or
390  * bulk transaction failed in a way that requires clearing internal state of
391  * a transaction translator.  This is normally detected (and reported) from
392  * interrupt context.
393  *
394  * It may not be possible for that hub to handle additional full (or low)
395  * speed transactions until that state is fully cleared out.
396  */
397 void usb_hub_tt_clear_buffer (struct usb_device *udev, int pipe)
398 {
399 	struct usb_tt		*tt = udev->tt;
400 	unsigned long		flags;
401 	struct usb_tt_clear	*clear;
402 
403 	/* we've got to cope with an arbitrary number of pending TT clears,
404 	 * since each TT has "at least two" buffers that can need it (and
405 	 * there can be many TTs per hub).  even if they're uncommon.
406 	 */
407 	if ((clear = kmalloc (sizeof *clear, SLAB_ATOMIC)) == NULL) {
408 		dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
409 		/* FIXME recover somehow ... RESET_TT? */
410 		return;
411 	}
412 
413 	/* info that CLEAR_TT_BUFFER needs */
414 	clear->tt = tt->multi ? udev->ttport : 1;
415 	clear->devinfo = usb_pipeendpoint (pipe);
416 	clear->devinfo |= udev->devnum << 4;
417 	clear->devinfo |= usb_pipecontrol (pipe)
418 			? (USB_ENDPOINT_XFER_CONTROL << 11)
419 			: (USB_ENDPOINT_XFER_BULK << 11);
420 	if (usb_pipein (pipe))
421 		clear->devinfo |= 1 << 15;
422 
423 	/* tell keventd to clear state for this TT */
424 	spin_lock_irqsave (&tt->lock, flags);
425 	list_add_tail (&clear->clear_list, &tt->clear_list);
426 	schedule_work (&tt->kevent);
427 	spin_unlock_irqrestore (&tt->lock, flags);
428 }
429 
430 static void hub_power_on(struct usb_hub *hub)
431 {
432 	int port1;
433 	unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
434 	u16 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
435 
436 	/* if hub supports power switching, enable power on each port */
437 	if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2) {
438 		dev_dbg(hub->intfdev, "enabling power on all ports\n");
439 		for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
440 			set_port_feature(hub->hdev, port1,
441 					USB_PORT_FEAT_POWER);
442 	}
443 
444 	/* Wait at least 100 msec for power to become stable */
445 	msleep(max(pgood_delay, (unsigned) 100));
446 }
447 
448 static inline void __hub_quiesce(struct usb_hub *hub)
449 {
450 	/* (nonblocking) khubd and related activity won't re-trigger */
451 	hub->quiescing = 1;
452 	hub->activating = 0;
453 	hub->resume_root_hub = 0;
454 }
455 
456 static void hub_quiesce(struct usb_hub *hub)
457 {
458 	/* (blocking) stop khubd and related activity */
459 	__hub_quiesce(hub);
460 	usb_kill_urb(hub->urb);
461 	if (hub->has_indicators)
462 		cancel_delayed_work(&hub->leds);
463 	if (hub->has_indicators || hub->tt.hub)
464 		flush_scheduled_work();
465 }
466 
467 static void hub_activate(struct usb_hub *hub)
468 {
469 	int	status;
470 
471 	hub->quiescing = 0;
472 	hub->activating = 1;
473 	hub->resume_root_hub = 0;
474 	status = usb_submit_urb(hub->urb, GFP_NOIO);
475 	if (status < 0)
476 		dev_err(hub->intfdev, "activate --> %d\n", status);
477 	if (hub->has_indicators && blinkenlights)
478 		schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
479 
480 	/* scan all ports ASAP */
481 	kick_khubd(hub);
482 }
483 
484 static int hub_hub_status(struct usb_hub *hub,
485 		u16 *status, u16 *change)
486 {
487 	int ret;
488 
489 	ret = get_hub_status(hub->hdev, &hub->status->hub);
490 	if (ret < 0)
491 		dev_err (hub->intfdev,
492 			"%s failed (err = %d)\n", __FUNCTION__, ret);
493 	else {
494 		*status = le16_to_cpu(hub->status->hub.wHubStatus);
495 		*change = le16_to_cpu(hub->status->hub.wHubChange);
496 		ret = 0;
497 	}
498 	return ret;
499 }
500 
501 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
502 {
503 	struct usb_device *hdev = hub->hdev;
504 	int ret;
505 
506 	if (hdev->children[port1-1] && set_state) {
507 		usb_set_device_state(hdev->children[port1-1],
508 				USB_STATE_NOTATTACHED);
509 	}
510 	ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
511 	if (ret)
512 		dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
513 			port1, ret);
514 
515 	return ret;
516 }
517 
518 
519 /* caller has locked the hub device */
520 static void hub_pre_reset(struct usb_hub *hub, int disable_ports)
521 {
522 	struct usb_device *hdev = hub->hdev;
523 	int port1;
524 
525 	for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
526 		if (hdev->children[port1 - 1]) {
527 			usb_disconnect(&hdev->children[port1 - 1]);
528 			if (disable_ports)
529 				hub_port_disable(hub, port1, 0);
530 		}
531 	}
532 	hub_quiesce(hub);
533 }
534 
535 /* caller has locked the hub device */
536 static void hub_post_reset(struct usb_hub *hub)
537 {
538 	hub_activate(hub);
539 	hub_power_on(hub);
540 }
541 
542 
543 static int hub_configure(struct usb_hub *hub,
544 	struct usb_endpoint_descriptor *endpoint)
545 {
546 	struct usb_device *hdev = hub->hdev;
547 	struct device *hub_dev = hub->intfdev;
548 	u16 hubstatus, hubchange;
549 	u16 wHubCharacteristics;
550 	unsigned int pipe;
551 	int maxp, ret;
552 	char *message;
553 
554 	hub->buffer = usb_buffer_alloc(hdev, sizeof(*hub->buffer), GFP_KERNEL,
555 			&hub->buffer_dma);
556 	if (!hub->buffer) {
557 		message = "can't allocate hub irq buffer";
558 		ret = -ENOMEM;
559 		goto fail;
560 	}
561 
562 	hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
563 	if (!hub->status) {
564 		message = "can't kmalloc hub status buffer";
565 		ret = -ENOMEM;
566 		goto fail;
567 	}
568 
569 	hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
570 	if (!hub->descriptor) {
571 		message = "can't kmalloc hub descriptor";
572 		ret = -ENOMEM;
573 		goto fail;
574 	}
575 
576 	/* Request the entire hub descriptor.
577 	 * hub->descriptor can handle USB_MAXCHILDREN ports,
578 	 * but the hub can/will return fewer bytes here.
579 	 */
580 	ret = get_hub_descriptor(hdev, hub->descriptor,
581 			sizeof(*hub->descriptor));
582 	if (ret < 0) {
583 		message = "can't read hub descriptor";
584 		goto fail;
585 	} else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
586 		message = "hub has too many ports!";
587 		ret = -ENODEV;
588 		goto fail;
589 	}
590 
591 	hdev->maxchild = hub->descriptor->bNbrPorts;
592 	dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
593 		(hdev->maxchild == 1) ? "" : "s");
594 
595 	wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
596 
597 	if (wHubCharacteristics & HUB_CHAR_COMPOUND) {
598 		int	i;
599 		char	portstr [USB_MAXCHILDREN + 1];
600 
601 		for (i = 0; i < hdev->maxchild; i++)
602 			portstr[i] = hub->descriptor->DeviceRemovable
603 				    [((i + 1) / 8)] & (1 << ((i + 1) % 8))
604 				? 'F' : 'R';
605 		portstr[hdev->maxchild] = 0;
606 		dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
607 	} else
608 		dev_dbg(hub_dev, "standalone hub\n");
609 
610 	switch (wHubCharacteristics & HUB_CHAR_LPSM) {
611 		case 0x00:
612 			dev_dbg(hub_dev, "ganged power switching\n");
613 			break;
614 		case 0x01:
615 			dev_dbg(hub_dev, "individual port power switching\n");
616 			break;
617 		case 0x02:
618 		case 0x03:
619 			dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
620 			break;
621 	}
622 
623 	switch (wHubCharacteristics & HUB_CHAR_OCPM) {
624 		case 0x00:
625 			dev_dbg(hub_dev, "global over-current protection\n");
626 			break;
627 		case 0x08:
628 			dev_dbg(hub_dev, "individual port over-current protection\n");
629 			break;
630 		case 0x10:
631 		case 0x18:
632 			dev_dbg(hub_dev, "no over-current protection\n");
633                         break;
634 	}
635 
636 	spin_lock_init (&hub->tt.lock);
637 	INIT_LIST_HEAD (&hub->tt.clear_list);
638 	INIT_WORK (&hub->tt.kevent, hub_tt_kevent, hub);
639 	switch (hdev->descriptor.bDeviceProtocol) {
640 		case 0:
641 			break;
642 		case 1:
643 			dev_dbg(hub_dev, "Single TT\n");
644 			hub->tt.hub = hdev;
645 			break;
646 		case 2:
647 			ret = usb_set_interface(hdev, 0, 1);
648 			if (ret == 0) {
649 				dev_dbg(hub_dev, "TT per port\n");
650 				hub->tt.multi = 1;
651 			} else
652 				dev_err(hub_dev, "Using single TT (err %d)\n",
653 					ret);
654 			hub->tt.hub = hdev;
655 			break;
656 		default:
657 			dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
658 				hdev->descriptor.bDeviceProtocol);
659 			break;
660 	}
661 
662 	/* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
663 	switch (wHubCharacteristics & HUB_CHAR_TTTT) {
664 		case HUB_TTTT_8_BITS:
665 			if (hdev->descriptor.bDeviceProtocol != 0) {
666 				hub->tt.think_time = 666;
667 				dev_dbg(hub_dev, "TT requires at most %d "
668 						"FS bit times (%d ns)\n",
669 					8, hub->tt.think_time);
670 			}
671 			break;
672 		case HUB_TTTT_16_BITS:
673 			hub->tt.think_time = 666 * 2;
674 			dev_dbg(hub_dev, "TT requires at most %d "
675 					"FS bit times (%d ns)\n",
676 				16, hub->tt.think_time);
677 			break;
678 		case HUB_TTTT_24_BITS:
679 			hub->tt.think_time = 666 * 3;
680 			dev_dbg(hub_dev, "TT requires at most %d "
681 					"FS bit times (%d ns)\n",
682 				24, hub->tt.think_time);
683 			break;
684 		case HUB_TTTT_32_BITS:
685 			hub->tt.think_time = 666 * 4;
686 			dev_dbg(hub_dev, "TT requires at most %d "
687 					"FS bit times (%d ns)\n",
688 				32, hub->tt.think_time);
689 			break;
690 	}
691 
692 	/* probe() zeroes hub->indicator[] */
693 	if (wHubCharacteristics & HUB_CHAR_PORTIND) {
694 		hub->has_indicators = 1;
695 		dev_dbg(hub_dev, "Port indicators are supported\n");
696 	}
697 
698 	dev_dbg(hub_dev, "power on to power good time: %dms\n",
699 		hub->descriptor->bPwrOn2PwrGood * 2);
700 
701 	/* power budgeting mostly matters with bus-powered hubs,
702 	 * and battery-powered root hubs (may provide just 8 mA).
703 	 */
704 	ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
705 	if (ret < 2) {
706 		message = "can't get hub status";
707 		goto fail;
708 	}
709 	le16_to_cpus(&hubstatus);
710 	if (hdev == hdev->bus->root_hub) {
711 		if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
712 			hub->mA_per_port = 500;
713 		else {
714 			hub->mA_per_port = hdev->bus_mA;
715 			hub->limited_power = 1;
716 		}
717 	} else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
718 		dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
719 			hub->descriptor->bHubContrCurrent);
720 		hub->limited_power = 1;
721 		if (hdev->maxchild > 0) {
722 			int remaining = hdev->bus_mA -
723 					hub->descriptor->bHubContrCurrent;
724 
725 			if (remaining < hdev->maxchild * 100)
726 				dev_warn(hub_dev,
727 					"insufficient power available "
728 					"to use all downstream ports\n");
729 			hub->mA_per_port = 100;		/* 7.2.1.1 */
730 		}
731 	} else {	/* Self-powered external hub */
732 		/* FIXME: What about battery-powered external hubs that
733 		 * provide less current per port? */
734 		hub->mA_per_port = 500;
735 	}
736 	if (hub->mA_per_port < 500)
737 		dev_dbg(hub_dev, "%umA bus power budget for each child\n",
738 				hub->mA_per_port);
739 
740 	ret = hub_hub_status(hub, &hubstatus, &hubchange);
741 	if (ret < 0) {
742 		message = "can't get hub status";
743 		goto fail;
744 	}
745 
746 	/* local power status reports aren't always correct */
747 	if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
748 		dev_dbg(hub_dev, "local power source is %s\n",
749 			(hubstatus & HUB_STATUS_LOCAL_POWER)
750 			? "lost (inactive)" : "good");
751 
752 	if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
753 		dev_dbg(hub_dev, "%sover-current condition exists\n",
754 			(hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
755 
756 	/* set up the interrupt endpoint */
757 	pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
758 	maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
759 
760 	if (maxp > sizeof(*hub->buffer))
761 		maxp = sizeof(*hub->buffer);
762 
763 	hub->urb = usb_alloc_urb(0, GFP_KERNEL);
764 	if (!hub->urb) {
765 		message = "couldn't allocate interrupt urb";
766 		ret = -ENOMEM;
767 		goto fail;
768 	}
769 
770 	usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
771 		hub, endpoint->bInterval);
772 	hub->urb->transfer_dma = hub->buffer_dma;
773 	hub->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
774 
775 	/* maybe cycle the hub leds */
776 	if (hub->has_indicators && blinkenlights)
777 		hub->indicator [0] = INDICATOR_CYCLE;
778 
779 	hub_power_on(hub);
780 	hub_activate(hub);
781 	return 0;
782 
783 fail:
784 	dev_err (hub_dev, "config failed, %s (err %d)\n",
785 			message, ret);
786 	/* hub_disconnect() frees urb and descriptor */
787 	return ret;
788 }
789 
790 static unsigned highspeed_hubs;
791 
792 static void hub_disconnect(struct usb_interface *intf)
793 {
794 	struct usb_hub *hub = usb_get_intfdata (intf);
795 	struct usb_device *hdev;
796 
797 	usb_set_intfdata (intf, NULL);
798 	hdev = hub->hdev;
799 
800 	if (hdev->speed == USB_SPEED_HIGH)
801 		highspeed_hubs--;
802 
803 	/* Disconnect all children and quiesce the hub */
804 	hub_pre_reset(hub, 1);
805 
806 	usb_free_urb(hub->urb);
807 	hub->urb = NULL;
808 
809 	spin_lock_irq(&hub_event_lock);
810 	list_del_init(&hub->event_list);
811 	spin_unlock_irq(&hub_event_lock);
812 
813 	kfree(hub->descriptor);
814 	hub->descriptor = NULL;
815 
816 	kfree(hub->status);
817 	hub->status = NULL;
818 
819 	if (hub->buffer) {
820 		usb_buffer_free(hdev, sizeof(*hub->buffer), hub->buffer,
821 				hub->buffer_dma);
822 		hub->buffer = NULL;
823 	}
824 
825 	kfree(hub);
826 }
827 
828 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
829 {
830 	struct usb_host_interface *desc;
831 	struct usb_endpoint_descriptor *endpoint;
832 	struct usb_device *hdev;
833 	struct usb_hub *hub;
834 
835 	desc = intf->cur_altsetting;
836 	hdev = interface_to_usbdev(intf);
837 
838 	/* Some hubs have a subclass of 1, which AFAICT according to the */
839 	/*  specs is not defined, but it works */
840 	if ((desc->desc.bInterfaceSubClass != 0) &&
841 	    (desc->desc.bInterfaceSubClass != 1)) {
842 descriptor_error:
843 		dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
844 		return -EIO;
845 	}
846 
847 	/* Multiple endpoints? What kind of mutant ninja-hub is this? */
848 	if (desc->desc.bNumEndpoints != 1)
849 		goto descriptor_error;
850 
851 	endpoint = &desc->endpoint[0].desc;
852 
853 	/* Output endpoint? Curiouser and curiouser.. */
854 	if (!(endpoint->bEndpointAddress & USB_DIR_IN))
855 		goto descriptor_error;
856 
857 	/* If it's not an interrupt endpoint, we'd better punt! */
858 	if ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
859 			!= USB_ENDPOINT_XFER_INT)
860 		goto descriptor_error;
861 
862 	/* We found a hub */
863 	dev_info (&intf->dev, "USB hub found\n");
864 
865 	hub = kzalloc(sizeof(*hub), GFP_KERNEL);
866 	if (!hub) {
867 		dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
868 		return -ENOMEM;
869 	}
870 
871 	INIT_LIST_HEAD(&hub->event_list);
872 	hub->intfdev = &intf->dev;
873 	hub->hdev = hdev;
874 	INIT_WORK(&hub->leds, led_work, hub);
875 
876 	usb_set_intfdata (intf, hub);
877 
878 	if (hdev->speed == USB_SPEED_HIGH)
879 		highspeed_hubs++;
880 
881 	if (hub_configure(hub, endpoint) >= 0)
882 		return 0;
883 
884 	hub_disconnect (intf);
885 	return -ENODEV;
886 }
887 
888 static int
889 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
890 {
891 	struct usb_device *hdev = interface_to_usbdev (intf);
892 
893 	/* assert ifno == 0 (part of hub spec) */
894 	switch (code) {
895 	case USBDEVFS_HUB_PORTINFO: {
896 		struct usbdevfs_hub_portinfo *info = user_data;
897 		int i;
898 
899 		spin_lock_irq(&device_state_lock);
900 		if (hdev->devnum <= 0)
901 			info->nports = 0;
902 		else {
903 			info->nports = hdev->maxchild;
904 			for (i = 0; i < info->nports; i++) {
905 				if (hdev->children[i] == NULL)
906 					info->port[i] = 0;
907 				else
908 					info->port[i] =
909 						hdev->children[i]->devnum;
910 			}
911 		}
912 		spin_unlock_irq(&device_state_lock);
913 
914 		return info->nports + 1;
915 		}
916 
917 	default:
918 		return -ENOSYS;
919 	}
920 }
921 
922 
923 /* grab device/port lock, returning index of that port (zero based).
924  * protects the upstream link used by this device from concurrent
925  * tree operations like suspend, resume, reset, and disconnect, which
926  * apply to everything downstream of a given port.
927  */
928 static int locktree(struct usb_device *udev)
929 {
930 	int			t;
931 	struct usb_device	*hdev;
932 
933 	if (!udev)
934 		return -ENODEV;
935 
936 	/* root hub is always the first lock in the series */
937 	hdev = udev->parent;
938 	if (!hdev) {
939 		usb_lock_device(udev);
940 		return 0;
941 	}
942 
943 	/* on the path from root to us, lock everything from
944 	 * top down, dropping parent locks when not needed
945 	 */
946 	t = locktree(hdev);
947 	if (t < 0)
948 		return t;
949 
950 	/* everything is fail-fast once disconnect
951 	 * processing starts
952 	 */
953 	if (udev->state == USB_STATE_NOTATTACHED) {
954 		usb_unlock_device(hdev);
955 		return -ENODEV;
956 	}
957 
958 	/* when everyone grabs locks top->bottom,
959 	 * non-overlapping work may be concurrent
960 	 */
961 	usb_lock_device(udev);
962 	usb_unlock_device(hdev);
963 	return udev->portnum;
964 }
965 
966 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
967 {
968 	int i;
969 
970 	for (i = 0; i < udev->maxchild; ++i) {
971 		if (udev->children[i])
972 			recursively_mark_NOTATTACHED(udev->children[i]);
973 	}
974 	udev->state = USB_STATE_NOTATTACHED;
975 }
976 
977 /**
978  * usb_set_device_state - change a device's current state (usbcore, hcds)
979  * @udev: pointer to device whose state should be changed
980  * @new_state: new state value to be stored
981  *
982  * udev->state is _not_ fully protected by the device lock.  Although
983  * most transitions are made only while holding the lock, the state can
984  * can change to USB_STATE_NOTATTACHED at almost any time.  This
985  * is so that devices can be marked as disconnected as soon as possible,
986  * without having to wait for any semaphores to be released.  As a result,
987  * all changes to any device's state must be protected by the
988  * device_state_lock spinlock.
989  *
990  * Once a device has been added to the device tree, all changes to its state
991  * should be made using this routine.  The state should _not_ be set directly.
992  *
993  * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
994  * Otherwise udev->state is set to new_state, and if new_state is
995  * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
996  * to USB_STATE_NOTATTACHED.
997  */
998 void usb_set_device_state(struct usb_device *udev,
999 		enum usb_device_state new_state)
1000 {
1001 	unsigned long flags;
1002 
1003 	spin_lock_irqsave(&device_state_lock, flags);
1004 	if (udev->state == USB_STATE_NOTATTACHED)
1005 		;	/* do nothing */
1006 	else if (new_state != USB_STATE_NOTATTACHED) {
1007 		udev->state = new_state;
1008 		if (new_state == USB_STATE_CONFIGURED)
1009 			device_init_wakeup(&udev->dev,
1010 				(udev->actconfig->desc.bmAttributes
1011 				 & USB_CONFIG_ATT_WAKEUP));
1012 		else if (new_state != USB_STATE_SUSPENDED)
1013 			device_init_wakeup(&udev->dev, 0);
1014 	} else
1015 		recursively_mark_NOTATTACHED(udev);
1016 	spin_unlock_irqrestore(&device_state_lock, flags);
1017 }
1018 EXPORT_SYMBOL(usb_set_device_state);
1019 
1020 
1021 #ifdef CONFIG_PM
1022 
1023 /**
1024  * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
1025  * @rhdev: struct usb_device for the root hub
1026  *
1027  * The USB host controller driver calls this function when its root hub
1028  * is resumed and Vbus power has been interrupted or the controller
1029  * has been reset.  The routine marks all the children of the root hub
1030  * as NOTATTACHED and marks logical connect-change events on their ports.
1031  */
1032 void usb_root_hub_lost_power(struct usb_device *rhdev)
1033 {
1034 	struct usb_hub *hub;
1035 	int port1;
1036 	unsigned long flags;
1037 
1038 	dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
1039 	spin_lock_irqsave(&device_state_lock, flags);
1040 	hub = hdev_to_hub(rhdev);
1041 	for (port1 = 1; port1 <= rhdev->maxchild; ++port1) {
1042 		if (rhdev->children[port1 - 1]) {
1043 			recursively_mark_NOTATTACHED(
1044 					rhdev->children[port1 - 1]);
1045 			set_bit(port1, hub->change_bits);
1046 		}
1047 	}
1048 	spin_unlock_irqrestore(&device_state_lock, flags);
1049 }
1050 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
1051 
1052 #endif
1053 
1054 static void choose_address(struct usb_device *udev)
1055 {
1056 	int		devnum;
1057 	struct usb_bus	*bus = udev->bus;
1058 
1059 	/* If khubd ever becomes multithreaded, this will need a lock */
1060 
1061 	/* Try to allocate the next devnum beginning at bus->devnum_next. */
1062 	devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1063 			bus->devnum_next);
1064 	if (devnum >= 128)
1065 		devnum = find_next_zero_bit(bus->devmap.devicemap, 128, 1);
1066 
1067 	bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1068 
1069 	if (devnum < 128) {
1070 		set_bit(devnum, bus->devmap.devicemap);
1071 		udev->devnum = devnum;
1072 	}
1073 }
1074 
1075 static void release_address(struct usb_device *udev)
1076 {
1077 	if (udev->devnum > 0) {
1078 		clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1079 		udev->devnum = -1;
1080 	}
1081 }
1082 
1083 /**
1084  * usb_disconnect - disconnect a device (usbcore-internal)
1085  * @pdev: pointer to device being disconnected
1086  * Context: !in_interrupt ()
1087  *
1088  * Something got disconnected. Get rid of it and all of its children.
1089  *
1090  * If *pdev is a normal device then the parent hub must already be locked.
1091  * If *pdev is a root hub then this routine will acquire the
1092  * usb_bus_list_lock on behalf of the caller.
1093  *
1094  * Only hub drivers (including virtual root hub drivers for host
1095  * controllers) should ever call this.
1096  *
1097  * This call is synchronous, and may not be used in an interrupt context.
1098  */
1099 void usb_disconnect(struct usb_device **pdev)
1100 {
1101 	struct usb_device	*udev = *pdev;
1102 	int			i;
1103 
1104 	if (!udev) {
1105 		pr_debug ("%s nodev\n", __FUNCTION__);
1106 		return;
1107 	}
1108 
1109 	/* mark the device as inactive, so any further urb submissions for
1110 	 * this device (and any of its children) will fail immediately.
1111 	 * this quiesces everyting except pending urbs.
1112 	 */
1113 	usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1114 	dev_info (&udev->dev, "USB disconnect, address %d\n", udev->devnum);
1115 
1116 	usb_lock_device(udev);
1117 
1118 	/* Free up all the children before we remove this device */
1119 	for (i = 0; i < USB_MAXCHILDREN; i++) {
1120 		if (udev->children[i])
1121 			usb_disconnect(&udev->children[i]);
1122 	}
1123 
1124 	/* deallocate hcd/hardware state ... nuking all pending urbs and
1125 	 * cleaning up all state associated with the current configuration
1126 	 * so that the hardware is now fully quiesced.
1127 	 */
1128 	usb_disable_device(udev, 0);
1129 
1130 	usb_notify_remove_device(udev);
1131 
1132 	/* Free the device number, remove the /proc/bus/usb entry and
1133 	 * the sysfs attributes, and delete the parent's children[]
1134 	 * (or root_hub) pointer.
1135 	 */
1136 	dev_dbg (&udev->dev, "unregistering device\n");
1137 	release_address(udev);
1138 	usb_remove_sysfs_dev_files(udev);
1139 
1140 	/* Avoid races with recursively_mark_NOTATTACHED() */
1141 	spin_lock_irq(&device_state_lock);
1142 	*pdev = NULL;
1143 	spin_unlock_irq(&device_state_lock);
1144 
1145 	usb_unlock_device(udev);
1146 
1147 	device_unregister(&udev->dev);
1148 }
1149 
1150 static inline const char *plural(int n)
1151 {
1152 	return (n == 1 ? "" : "s");
1153 }
1154 
1155 static int choose_configuration(struct usb_device *udev)
1156 {
1157 	int i;
1158 	u16 devstatus;
1159 	int bus_powered;
1160 	int num_configs;
1161 	struct usb_host_config *c, *best;
1162 
1163 	/* If this fails, assume the device is bus-powered */
1164 	devstatus = 0;
1165 	usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
1166 	le16_to_cpus(&devstatus);
1167 	bus_powered = ((devstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0);
1168 	dev_dbg(&udev->dev, "device is %s-powered\n",
1169 			bus_powered ? "bus" : "self");
1170 
1171 	best = NULL;
1172 	c = udev->config;
1173 	num_configs = udev->descriptor.bNumConfigurations;
1174 	for (i = 0; i < num_configs; (i++, c++)) {
1175 		struct usb_interface_descriptor	*desc =
1176 				&c->intf_cache[0]->altsetting->desc;
1177 
1178 		/*
1179 		 * HP's USB bus-powered keyboard has only one configuration
1180 		 * and it claims to be self-powered; other devices may have
1181 		 * similar errors in their descriptors.  If the next test
1182 		 * were allowed to execute, such configurations would always
1183 		 * be rejected and the devices would not work as expected.
1184 		 */
1185 #if 0
1186 		/* Rule out self-powered configs for a bus-powered device */
1187 		if (bus_powered && (c->desc.bmAttributes &
1188 					USB_CONFIG_ATT_SELFPOWER))
1189 			continue;
1190 #endif
1191 
1192 		/*
1193 		 * The next test may not be as effective as it should be.
1194 		 * Some hubs have errors in their descriptor, claiming
1195 		 * to be self-powered when they are really bus-powered.
1196 		 * We will overestimate the amount of current such hubs
1197 		 * make available for each port.
1198 		 *
1199 		 * This is a fairly benign sort of failure.  It won't
1200 		 * cause us to reject configurations that we should have
1201 		 * accepted.
1202 		 */
1203 
1204 		/* Rule out configs that draw too much bus current */
1205 		if (c->desc.bMaxPower * 2 > udev->bus_mA)
1206 			continue;
1207 
1208 		/* If the first config's first interface is COMM/2/0xff
1209 		 * (MSFT RNDIS), rule it out unless Linux has host-side
1210 		 * RNDIS support. */
1211 		if (i == 0 && desc->bInterfaceClass == USB_CLASS_COMM
1212 				&& desc->bInterfaceSubClass == 2
1213 				&& desc->bInterfaceProtocol == 0xff) {
1214 #ifndef CONFIG_USB_NET_RNDIS
1215 			continue;
1216 #else
1217 			best = c;
1218 #endif
1219 		}
1220 
1221 		/* From the remaining configs, choose the first one whose
1222 		 * first interface is for a non-vendor-specific class.
1223 		 * Reason: Linux is more likely to have a class driver
1224 		 * than a vendor-specific driver. */
1225 		else if (udev->descriptor.bDeviceClass !=
1226 						USB_CLASS_VENDOR_SPEC &&
1227 				desc->bInterfaceClass !=
1228 						USB_CLASS_VENDOR_SPEC) {
1229 			best = c;
1230 			break;
1231 		}
1232 
1233 		/* If all the remaining configs are vendor-specific,
1234 		 * choose the first one. */
1235 		else if (!best)
1236 			best = c;
1237 	}
1238 
1239 	if (best) {
1240 		i = best->desc.bConfigurationValue;
1241 		dev_info(&udev->dev,
1242 			"configuration #%d chosen from %d choice%s\n",
1243 			i, num_configs, plural(num_configs));
1244 	} else {
1245 		i = -1;
1246 		dev_warn(&udev->dev,
1247 			"no configuration chosen from %d choice%s\n",
1248 			num_configs, plural(num_configs));
1249 	}
1250 	return i;
1251 }
1252 
1253 #ifdef DEBUG
1254 static void show_string(struct usb_device *udev, char *id, char *string)
1255 {
1256 	if (!string)
1257 		return;
1258 	dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1259 }
1260 
1261 #else
1262 static inline void show_string(struct usb_device *udev, char *id, char *string)
1263 {}
1264 #endif
1265 
1266 
1267 #ifdef	CONFIG_USB_OTG
1268 #include "otg_whitelist.h"
1269 #endif
1270 
1271 /**
1272  * usb_new_device - perform initial device setup (usbcore-internal)
1273  * @udev: newly addressed device (in ADDRESS state)
1274  *
1275  * This is called with devices which have been enumerated, but not yet
1276  * configured.  The device descriptor is available, but not descriptors
1277  * for any device configuration.  The caller must have locked either
1278  * the parent hub (if udev is a normal device) or else the
1279  * usb_bus_list_lock (if udev is a root hub).  The parent's pointer to
1280  * udev has already been installed, but udev is not yet visible through
1281  * sysfs or other filesystem code.
1282  *
1283  * Returns 0 for success (device is configured and listed, with its
1284  * interfaces, in sysfs); else a negative errno value.
1285  *
1286  * This call is synchronous, and may not be used in an interrupt context.
1287  *
1288  * Only the hub driver or root-hub registrar should ever call this.
1289  */
1290 int usb_new_device(struct usb_device *udev)
1291 {
1292 	int err;
1293 	int c;
1294 
1295 	err = usb_get_configuration(udev);
1296 	if (err < 0) {
1297 		dev_err(&udev->dev, "can't read configurations, error %d\n",
1298 			err);
1299 		goto fail;
1300 	}
1301 
1302 	/* read the standard strings and cache them if present */
1303 	udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1304 	udev->manufacturer = usb_cache_string(udev,
1305 			udev->descriptor.iManufacturer);
1306 	udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
1307 
1308 	/* Tell the world! */
1309 	dev_dbg(&udev->dev, "new device strings: Mfr=%d, Product=%d, "
1310 			"SerialNumber=%d\n",
1311 			udev->descriptor.iManufacturer,
1312 			udev->descriptor.iProduct,
1313 			udev->descriptor.iSerialNumber);
1314 	show_string(udev, "Product", udev->product);
1315 	show_string(udev, "Manufacturer", udev->manufacturer);
1316 	show_string(udev, "SerialNumber", udev->serial);
1317 
1318 #ifdef	CONFIG_USB_OTG
1319 	/*
1320 	 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1321 	 * to wake us after we've powered off VBUS; and HNP, switching roles
1322 	 * "host" to "peripheral".  The OTG descriptor helps figure this out.
1323 	 */
1324 	if (!udev->bus->is_b_host
1325 			&& udev->config
1326 			&& udev->parent == udev->bus->root_hub) {
1327 		struct usb_otg_descriptor	*desc = 0;
1328 		struct usb_bus			*bus = udev->bus;
1329 
1330 		/* descriptor may appear anywhere in config */
1331 		if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1332 					le16_to_cpu(udev->config[0].desc.wTotalLength),
1333 					USB_DT_OTG, (void **) &desc) == 0) {
1334 			if (desc->bmAttributes & USB_OTG_HNP) {
1335 				unsigned		port1 = udev->portnum;
1336 				struct usb_device	*root = udev->parent;
1337 
1338 				dev_info(&udev->dev,
1339 					"Dual-Role OTG device on %sHNP port\n",
1340 					(port1 == bus->otg_port)
1341 						? "" : "non-");
1342 
1343 				/* enable HNP before suspend, it's simpler */
1344 				if (port1 == bus->otg_port)
1345 					bus->b_hnp_enable = 1;
1346 				err = usb_control_msg(udev,
1347 					usb_sndctrlpipe(udev, 0),
1348 					USB_REQ_SET_FEATURE, 0,
1349 					bus->b_hnp_enable
1350 						? USB_DEVICE_B_HNP_ENABLE
1351 						: USB_DEVICE_A_ALT_HNP_SUPPORT,
1352 					0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1353 				if (err < 0) {
1354 					/* OTG MESSAGE: report errors here,
1355 					 * customize to match your product.
1356 					 */
1357 					dev_info(&udev->dev,
1358 						"can't set HNP mode; %d\n",
1359 						err);
1360 					bus->b_hnp_enable = 0;
1361 				}
1362 			}
1363 		}
1364 	}
1365 
1366 	if (!is_targeted(udev)) {
1367 
1368 		/* Maybe it can talk to us, though we can't talk to it.
1369 		 * (Includes HNP test device.)
1370 		 */
1371 		if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
1372 			static int __usb_suspend_device(struct usb_device *,
1373 						int port1);
1374 			err = __usb_suspend_device(udev, udev->bus->otg_port);
1375 			if (err < 0)
1376 				dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1377 		}
1378 		err = -ENODEV;
1379 		goto fail;
1380 	}
1381 #endif
1382 
1383 	/* put device-specific files into sysfs */
1384 	err = device_add (&udev->dev);
1385 	if (err) {
1386 		dev_err(&udev->dev, "can't device_add, error %d\n", err);
1387 		goto fail;
1388 	}
1389 	usb_create_sysfs_dev_files (udev);
1390 
1391 	usb_lock_device(udev);
1392 
1393 	/* choose and set the configuration. that registers the interfaces
1394 	 * with the driver core, and lets usb device drivers bind to them.
1395 	 */
1396 	c = choose_configuration(udev);
1397 	if (c >= 0) {
1398 		err = usb_set_configuration(udev, c);
1399 		if (err) {
1400 			dev_err(&udev->dev, "can't set config #%d, error %d\n",
1401 					c, err);
1402 			/* This need not be fatal.  The user can try to
1403 			 * set other configurations. */
1404 		}
1405 	}
1406 
1407 	/* USB device state == configured ... usable */
1408 	usb_notify_add_device(udev);
1409 
1410 	usb_unlock_device(udev);
1411 
1412 	return 0;
1413 
1414 fail:
1415 	usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1416 	return err;
1417 }
1418 
1419 
1420 static int hub_port_status(struct usb_hub *hub, int port1,
1421 			       u16 *status, u16 *change)
1422 {
1423 	int ret;
1424 
1425 	ret = get_port_status(hub->hdev, port1, &hub->status->port);
1426 	if (ret < 0)
1427 		dev_err (hub->intfdev,
1428 			"%s failed (err = %d)\n", __FUNCTION__, ret);
1429 	else {
1430 		*status = le16_to_cpu(hub->status->port.wPortStatus);
1431 		*change = le16_to_cpu(hub->status->port.wPortChange);
1432 		ret = 0;
1433 	}
1434 	return ret;
1435 }
1436 
1437 #define PORT_RESET_TRIES	5
1438 #define SET_ADDRESS_TRIES	2
1439 #define GET_DESCRIPTOR_TRIES	2
1440 #define SET_CONFIG_TRIES	(2 * (use_both_schemes + 1))
1441 #define USE_NEW_SCHEME(i)	((i) / 2 == old_scheme_first)
1442 
1443 #define HUB_ROOT_RESET_TIME	50	/* times are in msec */
1444 #define HUB_SHORT_RESET_TIME	10
1445 #define HUB_LONG_RESET_TIME	200
1446 #define HUB_RESET_TIMEOUT	500
1447 
1448 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
1449 				struct usb_device *udev, unsigned int delay)
1450 {
1451 	int delay_time, ret;
1452 	u16 portstatus;
1453 	u16 portchange;
1454 
1455 	for (delay_time = 0;
1456 			delay_time < HUB_RESET_TIMEOUT;
1457 			delay_time += delay) {
1458 		/* wait to give the device a chance to reset */
1459 		msleep(delay);
1460 
1461 		/* read and decode port status */
1462 		ret = hub_port_status(hub, port1, &portstatus, &portchange);
1463 		if (ret < 0)
1464 			return ret;
1465 
1466 		/* Device went away? */
1467 		if (!(portstatus & USB_PORT_STAT_CONNECTION))
1468 			return -ENOTCONN;
1469 
1470 		/* bomb out completely if something weird happened */
1471 		if ((portchange & USB_PORT_STAT_C_CONNECTION))
1472 			return -EINVAL;
1473 
1474 		/* if we`ve finished resetting, then break out of the loop */
1475 		if (!(portstatus & USB_PORT_STAT_RESET) &&
1476 		    (portstatus & USB_PORT_STAT_ENABLE)) {
1477 			if (portstatus & USB_PORT_STAT_HIGH_SPEED)
1478 				udev->speed = USB_SPEED_HIGH;
1479 			else if (portstatus & USB_PORT_STAT_LOW_SPEED)
1480 				udev->speed = USB_SPEED_LOW;
1481 			else
1482 				udev->speed = USB_SPEED_FULL;
1483 			return 0;
1484 		}
1485 
1486 		/* switch to the long delay after two short delay failures */
1487 		if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
1488 			delay = HUB_LONG_RESET_TIME;
1489 
1490 		dev_dbg (hub->intfdev,
1491 			"port %d not reset yet, waiting %dms\n",
1492 			port1, delay);
1493 	}
1494 
1495 	return -EBUSY;
1496 }
1497 
1498 static int hub_port_reset(struct usb_hub *hub, int port1,
1499 				struct usb_device *udev, unsigned int delay)
1500 {
1501 	int i, status;
1502 
1503 	/* Reset the port */
1504 	for (i = 0; i < PORT_RESET_TRIES; i++) {
1505 		status = set_port_feature(hub->hdev,
1506 				port1, USB_PORT_FEAT_RESET);
1507 		if (status)
1508 			dev_err(hub->intfdev,
1509 					"cannot reset port %d (err = %d)\n",
1510 					port1, status);
1511 		else {
1512 			status = hub_port_wait_reset(hub, port1, udev, delay);
1513 			if (status && status != -ENOTCONN)
1514 				dev_dbg(hub->intfdev,
1515 						"port_wait_reset: err = %d\n",
1516 						status);
1517 		}
1518 
1519 		/* return on disconnect or reset */
1520 		switch (status) {
1521 		case 0:
1522 			/* TRSTRCY = 10 ms; plus some extra */
1523 			msleep(10 + 40);
1524 			/* FALL THROUGH */
1525 		case -ENOTCONN:
1526 		case -ENODEV:
1527 			clear_port_feature(hub->hdev,
1528 				port1, USB_PORT_FEAT_C_RESET);
1529 			/* FIXME need disconnect() for NOTATTACHED device */
1530 			usb_set_device_state(udev, status
1531 					? USB_STATE_NOTATTACHED
1532 					: USB_STATE_DEFAULT);
1533 			return status;
1534 		}
1535 
1536 		dev_dbg (hub->intfdev,
1537 			"port %d not enabled, trying reset again...\n",
1538 			port1);
1539 		delay = HUB_LONG_RESET_TIME;
1540 	}
1541 
1542 	dev_err (hub->intfdev,
1543 		"Cannot enable port %i.  Maybe the USB cable is bad?\n",
1544 		port1);
1545 
1546 	return status;
1547 }
1548 
1549 /*
1550  * Disable a port and mark a logical connnect-change event, so that some
1551  * time later khubd will disconnect() any existing usb_device on the port
1552  * and will re-enumerate if there actually is a device attached.
1553  */
1554 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
1555 {
1556 	dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
1557 	hub_port_disable(hub, port1, 1);
1558 
1559 	/* FIXME let caller ask to power down the port:
1560 	 *  - some devices won't enumerate without a VBUS power cycle
1561 	 *  - SRP saves power that way
1562 	 *  - ... new call, TBD ...
1563 	 * That's easy if this hub can switch power per-port, and
1564 	 * khubd reactivates the port later (timer, SRP, etc).
1565 	 * Powerdown must be optional, because of reset/DFU.
1566 	 */
1567 
1568 	set_bit(port1, hub->change_bits);
1569  	kick_khubd(hub);
1570 }
1571 
1572 
1573 #ifdef	CONFIG_USB_SUSPEND
1574 
1575 /*
1576  * Selective port suspend reduces power; most suspended devices draw
1577  * less than 500 uA.  It's also used in OTG, along with remote wakeup.
1578  * All devices below the suspended port are also suspended.
1579  *
1580  * Devices leave suspend state when the host wakes them up.  Some devices
1581  * also support "remote wakeup", where the device can activate the USB
1582  * tree above them to deliver data, such as a keypress or packet.  In
1583  * some cases, this wakes the USB host.
1584  */
1585 static int hub_port_suspend(struct usb_hub *hub, int port1,
1586 		struct usb_device *udev)
1587 {
1588 	int	status;
1589 
1590 	// dev_dbg(hub->intfdev, "suspend port %d\n", port1);
1591 
1592 	/* enable remote wakeup when appropriate; this lets the device
1593 	 * wake up the upstream hub (including maybe the root hub).
1594 	 *
1595 	 * NOTE:  OTG devices may issue remote wakeup (or SRP) even when
1596 	 * we don't explicitly enable it here.
1597 	 */
1598 	if (device_may_wakeup(&udev->dev)) {
1599 		status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1600 				USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
1601 				USB_DEVICE_REMOTE_WAKEUP, 0,
1602 				NULL, 0,
1603 				USB_CTRL_SET_TIMEOUT);
1604 		if (status)
1605 			dev_dbg(&udev->dev,
1606 				"won't remote wakeup, status %d\n",
1607 				status);
1608 	}
1609 
1610 	/* see 7.1.7.6 */
1611 	status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
1612 	if (status) {
1613 		dev_dbg(hub->intfdev,
1614 			"can't suspend port %d, status %d\n",
1615 			port1, status);
1616 		/* paranoia:  "should not happen" */
1617 		(void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1618 				USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
1619 				USB_DEVICE_REMOTE_WAKEUP, 0,
1620 				NULL, 0,
1621 				USB_CTRL_SET_TIMEOUT);
1622 	} else {
1623 		/* device has up to 10 msec to fully suspend */
1624 		dev_dbg(&udev->dev, "usb suspend\n");
1625 		usb_set_device_state(udev, USB_STATE_SUSPENDED);
1626 		msleep(10);
1627 	}
1628 	return status;
1629 }
1630 
1631 /*
1632  * Devices on USB hub ports have only one "suspend" state, corresponding
1633  * to ACPI D2, "may cause the device to lose some context".
1634  * State transitions include:
1635  *
1636  *   - suspend, resume ... when the VBUS power link stays live
1637  *   - suspend, disconnect ... VBUS lost
1638  *
1639  * Once VBUS drop breaks the circuit, the port it's using has to go through
1640  * normal re-enumeration procedures, starting with enabling VBUS power.
1641  * Other than re-initializing the hub (plug/unplug, except for root hubs),
1642  * Linux (2.6) currently has NO mechanisms to initiate that:  no khubd
1643  * timer, no SRP, no requests through sysfs.
1644  *
1645  * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
1646  * the root hub for their bus goes into global suspend ... so we don't
1647  * (falsely) update the device power state to say it suspended.
1648  */
1649 static int __usb_suspend_device (struct usb_device *udev, int port1)
1650 {
1651 	int	status = 0;
1652 
1653 	/* caller owns the udev device lock */
1654 	if (port1 < 0)
1655 		return port1;
1656 
1657 	if (udev->state == USB_STATE_SUSPENDED
1658 			|| udev->state == USB_STATE_NOTATTACHED) {
1659 		return 0;
1660 	}
1661 
1662 	/* all interfaces must already be suspended */
1663 	if (udev->actconfig) {
1664 		int	i;
1665 
1666 		for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
1667 			struct usb_interface	*intf;
1668 
1669 			intf = udev->actconfig->interface[i];
1670 			if (is_active(intf)) {
1671 				dev_dbg(&intf->dev, "nyet suspended\n");
1672 				return -EBUSY;
1673 			}
1674 		}
1675 	}
1676 
1677 	/* we only change a device's upstream USB link.
1678 	 * root hubs have no upstream USB link.
1679 	 */
1680 	if (udev->parent)
1681 		status = hub_port_suspend(hdev_to_hub(udev->parent), port1,
1682 				udev);
1683 
1684 	if (status == 0)
1685 		udev->dev.power.power_state = PMSG_SUSPEND;
1686 	return status;
1687 }
1688 
1689 #endif
1690 
1691 /*
1692  * usb_suspend_device - suspend a usb device
1693  * @udev: device that's no longer in active use
1694  * Context: must be able to sleep; device not locked; pm locks held
1695  *
1696  * Suspends a USB device that isn't in active use, conserving power.
1697  * Devices may wake out of a suspend, if anything important happens,
1698  * using the remote wakeup mechanism.  They may also be taken out of
1699  * suspend by the host, using usb_resume_device().  It's also routine
1700  * to disconnect devices while they are suspended.
1701  *
1702  * This only affects the USB hardware for a device; its interfaces
1703  * (and, for hubs, child devices) must already have been suspended.
1704  *
1705  * Suspending OTG devices may trigger HNP, if that's been enabled
1706  * between a pair of dual-role devices.  That will change roles, such
1707  * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
1708  *
1709  * Returns 0 on success, else negative errno.
1710  */
1711 int usb_suspend_device(struct usb_device *udev)
1712 {
1713 #ifdef	CONFIG_USB_SUSPEND
1714 	if (udev->state == USB_STATE_NOTATTACHED)
1715 		return -ENODEV;
1716 	return __usb_suspend_device(udev, udev->portnum);
1717 #else
1718 	/* NOTE:  udev->state unchanged, it's not lying ... */
1719 	udev->dev.power.power_state = PMSG_SUSPEND;
1720 	return 0;
1721 #endif
1722 }
1723 
1724 /*
1725  * If the USB "suspend" state is in use (rather than "global suspend"),
1726  * many devices will be individually taken out of suspend state using
1727  * special" resume" signaling.  These routines kick in shortly after
1728  * hardware resume signaling is finished, either because of selective
1729  * resume (by host) or remote wakeup (by device) ... now see what changed
1730  * in the tree that's rooted at this device.
1731  */
1732 static int finish_device_resume(struct usb_device *udev)
1733 {
1734 	int	status;
1735 	u16	devstatus;
1736 
1737 	/* caller owns the udev device lock */
1738 	dev_dbg(&udev->dev, "finish resume\n");
1739 
1740 	/* usb ch9 identifies four variants of SUSPENDED, based on what
1741 	 * state the device resumes to.  Linux currently won't see the
1742 	 * first two on the host side; they'd be inside hub_port_init()
1743 	 * during many timeouts, but khubd can't suspend until later.
1744 	 */
1745 	usb_set_device_state(udev, udev->actconfig
1746 			? USB_STATE_CONFIGURED
1747 			: USB_STATE_ADDRESS);
1748 	udev->dev.power.power_state = PMSG_ON;
1749 
1750  	/* 10.5.4.5 says be sure devices in the tree are still there.
1751  	 * For now let's assume the device didn't go crazy on resume,
1752 	 * and device drivers will know about any resume quirks.
1753 	 */
1754 	status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
1755 	if (status < 2)
1756 		dev_dbg(&udev->dev,
1757 			"gone after usb resume? status %d\n",
1758 			status);
1759 	else if (udev->actconfig) {
1760 		unsigned	i;
1761 		int		(*resume)(struct device *);
1762 
1763 		le16_to_cpus(&devstatus);
1764 		if ((devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
1765 				&& udev->parent) {
1766 			status = usb_control_msg(udev,
1767 					usb_sndctrlpipe(udev, 0),
1768 					USB_REQ_CLEAR_FEATURE,
1769 						USB_RECIP_DEVICE,
1770 					USB_DEVICE_REMOTE_WAKEUP, 0,
1771 					NULL, 0,
1772 					USB_CTRL_SET_TIMEOUT);
1773 			if (status) {
1774 				dev_dbg(&udev->dev, "disable remote "
1775 					"wakeup, status %d\n", status);
1776 				status = 0;
1777 			}
1778 		}
1779 
1780 		/* resume interface drivers; if this is a hub, it
1781 		 * may have a child resume event to deal with soon
1782 		 */
1783 		resume = udev->dev.bus->resume;
1784 		for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
1785 			struct device *dev =
1786 					&udev->actconfig->interface[i]->dev;
1787 
1788 			down(&dev->sem);
1789 			(void) resume(dev);
1790 			up(&dev->sem);
1791 		}
1792 		status = 0;
1793 
1794 	} else if (udev->devnum <= 0) {
1795 		dev_dbg(&udev->dev, "bogus resume!\n");
1796 		status = -EINVAL;
1797 	}
1798 	return status;
1799 }
1800 
1801 #ifdef	CONFIG_USB_SUSPEND
1802 
1803 static int
1804 hub_port_resume(struct usb_hub *hub, int port1, struct usb_device *udev)
1805 {
1806 	int	status;
1807 
1808 	// dev_dbg(hub->intfdev, "resume port %d\n", port1);
1809 
1810 	/* see 7.1.7.7; affects power usage, but not budgeting */
1811 	status = clear_port_feature(hub->hdev,
1812 			port1, USB_PORT_FEAT_SUSPEND);
1813 	if (status) {
1814 		dev_dbg(hub->intfdev,
1815 			"can't resume port %d, status %d\n",
1816 			port1, status);
1817 	} else {
1818 		u16		devstatus;
1819 		u16		portchange;
1820 
1821 		/* drive resume for at least 20 msec */
1822 		if (udev)
1823 			dev_dbg(&udev->dev, "RESUME\n");
1824 		msleep(25);
1825 
1826 #define LIVE_FLAGS	( USB_PORT_STAT_POWER \
1827 			| USB_PORT_STAT_ENABLE \
1828 			| USB_PORT_STAT_CONNECTION)
1829 
1830 		/* Virtual root hubs can trigger on GET_PORT_STATUS to
1831 		 * stop resume signaling.  Then finish the resume
1832 		 * sequence.
1833 		 */
1834 		devstatus = portchange = 0;
1835 		status = hub_port_status(hub, port1,
1836 				&devstatus, &portchange);
1837 		if (status < 0
1838 				|| (devstatus & LIVE_FLAGS) != LIVE_FLAGS
1839 				|| (devstatus & USB_PORT_STAT_SUSPEND) != 0
1840 				) {
1841 			dev_dbg(hub->intfdev,
1842 				"port %d status %04x.%04x after resume, %d\n",
1843 				port1, portchange, devstatus, status);
1844 		} else {
1845 			/* TRSMRCY = 10 msec */
1846 			msleep(10);
1847 			if (udev)
1848 				status = finish_device_resume(udev);
1849 		}
1850 	}
1851 	if (status < 0)
1852 		hub_port_logical_disconnect(hub, port1);
1853 
1854 	return status;
1855 }
1856 
1857 #endif
1858 
1859 /*
1860  * usb_resume_device - re-activate a suspended usb device
1861  * @udev: device to re-activate
1862  * Context: must be able to sleep; device not locked; pm locks held
1863  *
1864  * This will re-activate the suspended device, increasing power usage
1865  * while letting drivers communicate again with its endpoints.
1866  * USB resume explicitly guarantees that the power session between
1867  * the host and the device is the same as it was when the device
1868  * suspended.
1869  *
1870  * Returns 0 on success, else negative errno.
1871  */
1872 int usb_resume_device(struct usb_device *udev)
1873 {
1874 	int	status;
1875 
1876 	if (udev->state == USB_STATE_NOTATTACHED)
1877 		return -ENODEV;
1878 
1879 #ifdef	CONFIG_USB_SUSPEND
1880 	/* selective resume of one downstream hub-to-device port */
1881 	if (udev->parent) {
1882 		if (udev->state == USB_STATE_SUSPENDED) {
1883 			// NOTE swsusp may bork us, device state being wrong...
1884 			// NOTE this fails if parent is also suspended...
1885 			status = hub_port_resume(hdev_to_hub(udev->parent),
1886 					udev->portnum, udev);
1887 		} else
1888 			status = 0;
1889 	} else
1890 #endif
1891 		status = finish_device_resume(udev);
1892 	if (status < 0)
1893 		dev_dbg(&udev->dev, "can't resume, status %d\n",
1894 			status);
1895 
1896 	/* rebind drivers that had no suspend() */
1897 	if (status == 0) {
1898 		usb_unlock_device(udev);
1899 		bus_rescan_devices(&usb_bus_type);
1900 		usb_lock_device(udev);
1901 	}
1902 	return status;
1903 }
1904 
1905 static int remote_wakeup(struct usb_device *udev)
1906 {
1907 	int	status = 0;
1908 
1909 #ifdef	CONFIG_USB_SUSPEND
1910 
1911 	/* don't repeat RESUME sequence if this device
1912 	 * was already woken up by some other task
1913 	 */
1914 	usb_lock_device(udev);
1915 	if (udev->state == USB_STATE_SUSPENDED) {
1916 		dev_dbg(&udev->dev, "RESUME (wakeup)\n");
1917 		/* TRSMRCY = 10 msec */
1918 		msleep(10);
1919 		status = finish_device_resume(udev);
1920 	}
1921 	usb_unlock_device(udev);
1922 #endif
1923 	return status;
1924 }
1925 
1926 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
1927 {
1928 	struct usb_hub		*hub = usb_get_intfdata (intf);
1929 	struct usb_device	*hdev = hub->hdev;
1930 	unsigned		port1;
1931 
1932 	/* fail if children aren't already suspended */
1933 	for (port1 = 1; port1 <= hdev->maxchild; port1++) {
1934 		struct usb_device	*udev;
1935 
1936 		udev = hdev->children [port1-1];
1937 		if (udev && (udev->dev.power.power_state.event
1938 					== PM_EVENT_ON
1939 #ifdef	CONFIG_USB_SUSPEND
1940 				|| udev->state != USB_STATE_SUSPENDED
1941 #endif
1942 				)) {
1943 			dev_dbg(&intf->dev, "port %d nyet suspended\n", port1);
1944 			return -EBUSY;
1945 		}
1946 	}
1947 
1948 	/* "global suspend" of the downstream HC-to-USB interface */
1949 	if (!hdev->parent) {
1950 		struct usb_bus	*bus = hdev->bus;
1951 		if (bus) {
1952 			int	status = hcd_bus_suspend (bus);
1953 
1954 			if (status != 0) {
1955 				dev_dbg(&hdev->dev, "'global' suspend %d\n",
1956 					status);
1957 				return status;
1958 			}
1959 		} else
1960 			return -EOPNOTSUPP;
1961 	}
1962 
1963 	/* stop khubd and related activity */
1964 	hub_quiesce(hub);
1965 	return 0;
1966 }
1967 
1968 static int hub_resume(struct usb_interface *intf)
1969 {
1970 	struct usb_device	*hdev = interface_to_usbdev(intf);
1971 	struct usb_hub		*hub = usb_get_intfdata (intf);
1972 	int			status;
1973 
1974 	/* "global resume" of the downstream HC-to-USB interface */
1975 	if (!hdev->parent) {
1976 		struct usb_bus	*bus = hdev->bus;
1977 		if (bus) {
1978 			status = hcd_bus_resume (bus);
1979 			if (status) {
1980 				dev_dbg(&intf->dev, "'global' resume %d\n",
1981 					status);
1982 				return status;
1983 			}
1984 		} else
1985 			return -EOPNOTSUPP;
1986 		if (status == 0) {
1987 			/* TRSMRCY = 10 msec */
1988 			msleep(10);
1989 		}
1990 	}
1991 
1992 	hub_activate(hub);
1993 
1994 	/* REVISIT:  this recursion probably shouldn't exist.  Remove
1995 	 * this code sometime, after retesting with different root and
1996 	 * external hubs.
1997 	 */
1998 #ifdef	CONFIG_USB_SUSPEND
1999 	{
2000 	unsigned		port1;
2001 
2002 	for (port1 = 1; port1 <= hdev->maxchild; port1++) {
2003 		struct usb_device	*udev;
2004 		u16			portstat, portchange;
2005 
2006 		udev = hdev->children [port1-1];
2007 		status = hub_port_status(hub, port1, &portstat, &portchange);
2008 		if (status == 0) {
2009 			if (portchange & USB_PORT_STAT_C_SUSPEND) {
2010 				clear_port_feature(hdev, port1,
2011 					USB_PORT_FEAT_C_SUSPEND);
2012 				portchange &= ~USB_PORT_STAT_C_SUSPEND;
2013 			}
2014 
2015 			/* let khubd handle disconnects etc */
2016 			if (portchange)
2017 				continue;
2018 		}
2019 
2020 		if (!udev || status < 0)
2021 			continue;
2022 		usb_lock_device(udev);
2023 		if (portstat & USB_PORT_STAT_SUSPEND)
2024 			status = hub_port_resume(hub, port1, udev);
2025 		else {
2026 			status = finish_device_resume(udev);
2027 			if (status < 0) {
2028 				dev_dbg(&intf->dev, "resume port %d --> %d\n",
2029 					port1, status);
2030 				hub_port_logical_disconnect(hub, port1);
2031 			}
2032 		}
2033 		usb_unlock_device(udev);
2034 	}
2035 	}
2036 #endif
2037 	return 0;
2038 }
2039 
2040 void usb_suspend_root_hub(struct usb_device *hdev)
2041 {
2042 	struct usb_hub *hub = hdev_to_hub(hdev);
2043 
2044 	/* This also makes any led blinker stop retriggering.  We're called
2045 	 * from irq, so the blinker might still be scheduled.  Caller promises
2046 	 * that the root hub status URB will be canceled.
2047 	 */
2048 	__hub_quiesce(hub);
2049 	mark_quiesced(to_usb_interface(hub->intfdev));
2050 }
2051 
2052 void usb_resume_root_hub(struct usb_device *hdev)
2053 {
2054 	struct usb_hub *hub = hdev_to_hub(hdev);
2055 
2056 	hub->resume_root_hub = 1;
2057 	kick_khubd(hub);
2058 }
2059 
2060 
2061 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2062  *
2063  * Between connect detection and reset signaling there must be a delay
2064  * of 100ms at least for debounce and power-settling.  The corresponding
2065  * timer shall restart whenever the downstream port detects a disconnect.
2066  *
2067  * Apparently there are some bluetooth and irda-dongles and a number of
2068  * low-speed devices for which this debounce period may last over a second.
2069  * Not covered by the spec - but easy to deal with.
2070  *
2071  * This implementation uses a 1500ms total debounce timeout; if the
2072  * connection isn't stable by then it returns -ETIMEDOUT.  It checks
2073  * every 25ms for transient disconnects.  When the port status has been
2074  * unchanged for 100ms it returns the port status.
2075  */
2076 
2077 #define HUB_DEBOUNCE_TIMEOUT	1500
2078 #define HUB_DEBOUNCE_STEP	  25
2079 #define HUB_DEBOUNCE_STABLE	 100
2080 
2081 static int hub_port_debounce(struct usb_hub *hub, int port1)
2082 {
2083 	int ret;
2084 	int total_time, stable_time = 0;
2085 	u16 portchange, portstatus;
2086 	unsigned connection = 0xffff;
2087 
2088 	for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2089 		ret = hub_port_status(hub, port1, &portstatus, &portchange);
2090 		if (ret < 0)
2091 			return ret;
2092 
2093 		if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2094 		     (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2095 			stable_time += HUB_DEBOUNCE_STEP;
2096 			if (stable_time >= HUB_DEBOUNCE_STABLE)
2097 				break;
2098 		} else {
2099 			stable_time = 0;
2100 			connection = portstatus & USB_PORT_STAT_CONNECTION;
2101 		}
2102 
2103 		if (portchange & USB_PORT_STAT_C_CONNECTION) {
2104 			clear_port_feature(hub->hdev, port1,
2105 					USB_PORT_FEAT_C_CONNECTION);
2106 		}
2107 
2108 		if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2109 			break;
2110 		msleep(HUB_DEBOUNCE_STEP);
2111 	}
2112 
2113 	dev_dbg (hub->intfdev,
2114 		"debounce: port %d: total %dms stable %dms status 0x%x\n",
2115 		port1, total_time, stable_time, portstatus);
2116 
2117 	if (stable_time < HUB_DEBOUNCE_STABLE)
2118 		return -ETIMEDOUT;
2119 	return portstatus;
2120 }
2121 
2122 static void ep0_reinit(struct usb_device *udev)
2123 {
2124 	usb_disable_endpoint(udev, 0 + USB_DIR_IN);
2125 	usb_disable_endpoint(udev, 0 + USB_DIR_OUT);
2126 	udev->ep_in[0] = udev->ep_out[0] = &udev->ep0;
2127 }
2128 
2129 #define usb_sndaddr0pipe()	(PIPE_CONTROL << 30)
2130 #define usb_rcvaddr0pipe()	((PIPE_CONTROL << 30) | USB_DIR_IN)
2131 
2132 static int hub_set_address(struct usb_device *udev)
2133 {
2134 	int retval;
2135 
2136 	if (udev->devnum == 0)
2137 		return -EINVAL;
2138 	if (udev->state == USB_STATE_ADDRESS)
2139 		return 0;
2140 	if (udev->state != USB_STATE_DEFAULT)
2141 		return -EINVAL;
2142 	retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2143 		USB_REQ_SET_ADDRESS, 0, udev->devnum, 0,
2144 		NULL, 0, USB_CTRL_SET_TIMEOUT);
2145 	if (retval == 0) {
2146 		usb_set_device_state(udev, USB_STATE_ADDRESS);
2147 		ep0_reinit(udev);
2148 	}
2149 	return retval;
2150 }
2151 
2152 /* Reset device, (re)assign address, get device descriptor.
2153  * Device connection must be stable, no more debouncing needed.
2154  * Returns device in USB_STATE_ADDRESS, except on error.
2155  *
2156  * If this is called for an already-existing device (as part of
2157  * usb_reset_device), the caller must own the device lock.  For a
2158  * newly detected device that is not accessible through any global
2159  * pointers, it's not necessary to lock the device.
2160  */
2161 static int
2162 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2163 		int retry_counter)
2164 {
2165 	static DECLARE_MUTEX(usb_address0_sem);
2166 
2167 	struct usb_device	*hdev = hub->hdev;
2168 	int			i, j, retval;
2169 	unsigned		delay = HUB_SHORT_RESET_TIME;
2170 	enum usb_device_speed	oldspeed = udev->speed;
2171 
2172 	/* root hub ports have a slightly longer reset period
2173 	 * (from USB 2.0 spec, section 7.1.7.5)
2174 	 */
2175 	if (!hdev->parent) {
2176 		delay = HUB_ROOT_RESET_TIME;
2177 		if (port1 == hdev->bus->otg_port)
2178 			hdev->bus->b_hnp_enable = 0;
2179 	}
2180 
2181 	/* Some low speed devices have problems with the quick delay, so */
2182 	/*  be a bit pessimistic with those devices. RHbug #23670 */
2183 	if (oldspeed == USB_SPEED_LOW)
2184 		delay = HUB_LONG_RESET_TIME;
2185 
2186 	down(&usb_address0_sem);
2187 
2188 	/* Reset the device; full speed may morph to high speed */
2189 	retval = hub_port_reset(hub, port1, udev, delay);
2190 	if (retval < 0)		/* error or disconnect */
2191 		goto fail;
2192 				/* success, speed is known */
2193 	retval = -ENODEV;
2194 
2195 	if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2196 		dev_dbg(&udev->dev, "device reset changed speed!\n");
2197 		goto fail;
2198 	}
2199 	oldspeed = udev->speed;
2200 
2201 	/* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2202 	 * it's fixed size except for full speed devices.
2203 	 */
2204 	switch (udev->speed) {
2205 	case USB_SPEED_HIGH:		/* fixed at 64 */
2206 		udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2207 		break;
2208 	case USB_SPEED_FULL:		/* 8, 16, 32, or 64 */
2209 		/* to determine the ep0 maxpacket size, try to read
2210 		 * the device descriptor to get bMaxPacketSize0 and
2211 		 * then correct our initial guess.
2212 		 */
2213 		udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2214 		break;
2215 	case USB_SPEED_LOW:		/* fixed at 8 */
2216 		udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(8);
2217 		break;
2218 	default:
2219 		goto fail;
2220 	}
2221 
2222 	dev_info (&udev->dev,
2223 			"%s %s speed USB device using %s and address %d\n",
2224 			(udev->config) ? "reset" : "new",
2225 			({ char *speed; switch (udev->speed) {
2226 			case USB_SPEED_LOW:	speed = "low";	break;
2227 			case USB_SPEED_FULL:	speed = "full";	break;
2228 			case USB_SPEED_HIGH:	speed = "high";	break;
2229 			default: 		speed = "?";	break;
2230 			}; speed;}),
2231 			udev->bus->controller->driver->name,
2232 			udev->devnum);
2233 
2234 	/* Set up TT records, if needed  */
2235 	if (hdev->tt) {
2236 		udev->tt = hdev->tt;
2237 		udev->ttport = hdev->ttport;
2238 	} else if (udev->speed != USB_SPEED_HIGH
2239 			&& hdev->speed == USB_SPEED_HIGH) {
2240 		udev->tt = &hub->tt;
2241 		udev->ttport = port1;
2242 	}
2243 
2244 	/* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2245 	 * Because device hardware and firmware is sometimes buggy in
2246 	 * this area, and this is how Linux has done it for ages.
2247 	 * Change it cautiously.
2248 	 *
2249 	 * NOTE:  If USE_NEW_SCHEME() is true we will start by issuing
2250 	 * a 64-byte GET_DESCRIPTOR request.  This is what Windows does,
2251 	 * so it may help with some non-standards-compliant devices.
2252 	 * Otherwise we start with SET_ADDRESS and then try to read the
2253 	 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2254 	 * value.
2255 	 */
2256 	for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
2257 		if (USE_NEW_SCHEME(retry_counter)) {
2258 			struct usb_device_descriptor *buf;
2259 			int r = 0;
2260 
2261 #define GET_DESCRIPTOR_BUFSIZE	64
2262 			buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2263 			if (!buf) {
2264 				retval = -ENOMEM;
2265 				continue;
2266 			}
2267 
2268 			/* Use a short timeout the first time through,
2269 			 * so that recalcitrant full-speed devices with
2270 			 * 8- or 16-byte ep0-maxpackets won't slow things
2271 			 * down tremendously by NAKing the unexpectedly
2272 			 * early status stage.  Also, retry on all errors;
2273 			 * some devices are flakey.
2274 			 */
2275 			for (j = 0; j < 3; ++j) {
2276 				buf->bMaxPacketSize0 = 0;
2277 				r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2278 					USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2279 					USB_DT_DEVICE << 8, 0,
2280 					buf, GET_DESCRIPTOR_BUFSIZE,
2281 					(i ? USB_CTRL_GET_TIMEOUT : 1000));
2282 				switch (buf->bMaxPacketSize0) {
2283 				case 8: case 16: case 32: case 64:
2284 					if (buf->bDescriptorType ==
2285 							USB_DT_DEVICE) {
2286 						r = 0;
2287 						break;
2288 					}
2289 					/* FALL THROUGH */
2290 				default:
2291 					if (r == 0)
2292 						r = -EPROTO;
2293 					break;
2294 				}
2295 				if (r == 0)
2296 					break;
2297 			}
2298 			udev->descriptor.bMaxPacketSize0 =
2299 					buf->bMaxPacketSize0;
2300 			kfree(buf);
2301 
2302 			retval = hub_port_reset(hub, port1, udev, delay);
2303 			if (retval < 0)		/* error or disconnect */
2304 				goto fail;
2305 			if (oldspeed != udev->speed) {
2306 				dev_dbg(&udev->dev,
2307 					"device reset changed speed!\n");
2308 				retval = -ENODEV;
2309 				goto fail;
2310 			}
2311 			if (r) {
2312 				dev_err(&udev->dev, "device descriptor "
2313 						"read/%s, error %d\n",
2314 						"64", r);
2315 				retval = -EMSGSIZE;
2316 				continue;
2317 			}
2318 #undef GET_DESCRIPTOR_BUFSIZE
2319 		}
2320 
2321 		for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
2322 			retval = hub_set_address(udev);
2323 			if (retval >= 0)
2324 				break;
2325 			msleep(200);
2326 		}
2327 		if (retval < 0) {
2328 			dev_err(&udev->dev,
2329 				"device not accepting address %d, error %d\n",
2330 				udev->devnum, retval);
2331 			goto fail;
2332 		}
2333 
2334 		/* cope with hardware quirkiness:
2335 		 *  - let SET_ADDRESS settle, some device hardware wants it
2336 		 *  - read ep0 maxpacket even for high and low speed,
2337   		 */
2338 		msleep(10);
2339 		if (USE_NEW_SCHEME(retry_counter))
2340 			break;
2341 
2342 		retval = usb_get_device_descriptor(udev, 8);
2343 		if (retval < 8) {
2344 			dev_err(&udev->dev, "device descriptor "
2345 					"read/%s, error %d\n",
2346 					"8", retval);
2347 			if (retval >= 0)
2348 				retval = -EMSGSIZE;
2349 		} else {
2350 			retval = 0;
2351 			break;
2352 		}
2353 	}
2354 	if (retval)
2355 		goto fail;
2356 
2357 	i = udev->descriptor.bMaxPacketSize0;
2358 	if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
2359 		if (udev->speed != USB_SPEED_FULL ||
2360 				!(i == 8 || i == 16 || i == 32 || i == 64)) {
2361 			dev_err(&udev->dev, "ep0 maxpacket = %d\n", i);
2362 			retval = -EMSGSIZE;
2363 			goto fail;
2364 		}
2365 		dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
2366 		udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
2367 		ep0_reinit(udev);
2368 	}
2369 
2370 	retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
2371 	if (retval < (signed)sizeof(udev->descriptor)) {
2372 		dev_err(&udev->dev, "device descriptor read/%s, error %d\n",
2373 			"all", retval);
2374 		if (retval >= 0)
2375 			retval = -ENOMSG;
2376 		goto fail;
2377 	}
2378 
2379 	retval = 0;
2380 
2381 fail:
2382 	if (retval)
2383 		hub_port_disable(hub, port1, 0);
2384 	up(&usb_address0_sem);
2385 	return retval;
2386 }
2387 
2388 static void
2389 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
2390 {
2391 	struct usb_qualifier_descriptor	*qual;
2392 	int				status;
2393 
2394 	qual = kmalloc (sizeof *qual, SLAB_KERNEL);
2395 	if (qual == NULL)
2396 		return;
2397 
2398 	status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
2399 			qual, sizeof *qual);
2400 	if (status == sizeof *qual) {
2401 		dev_info(&udev->dev, "not running at top speed; "
2402 			"connect to a high speed hub\n");
2403 		/* hub LEDs are probably harder to miss than syslog */
2404 		if (hub->has_indicators) {
2405 			hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
2406 			schedule_work (&hub->leds);
2407 		}
2408 	}
2409 	kfree(qual);
2410 }
2411 
2412 static unsigned
2413 hub_power_remaining (struct usb_hub *hub)
2414 {
2415 	struct usb_device *hdev = hub->hdev;
2416 	int remaining;
2417 	int port1;
2418 
2419 	if (!hub->limited_power)
2420 		return 0;
2421 
2422 	remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
2423 	for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
2424 		struct usb_device	*udev = hdev->children[port1 - 1];
2425 		int			delta;
2426 
2427 		if (!udev)
2428 			continue;
2429 
2430 		/* Unconfigured devices may not use more than 100mA,
2431 		 * or 8mA for OTG ports */
2432 		if (udev->actconfig)
2433 			delta = udev->actconfig->desc.bMaxPower * 2;
2434 		else if (port1 != udev->bus->otg_port || hdev->parent)
2435 			delta = 100;
2436 		else
2437 			delta = 8;
2438 		if (delta > hub->mA_per_port)
2439 			dev_warn(&udev->dev, "%dmA is over %umA budget "
2440 					"for port %d!\n",
2441 					delta, hub->mA_per_port, port1);
2442 		remaining -= delta;
2443 	}
2444 	if (remaining < 0) {
2445 		dev_warn(hub->intfdev, "%dmA over power budget!\n",
2446 			- remaining);
2447 		remaining = 0;
2448 	}
2449 	return remaining;
2450 }
2451 
2452 /* Handle physical or logical connection change events.
2453  * This routine is called when:
2454  * 	a port connection-change occurs;
2455  *	a port enable-change occurs (often caused by EMI);
2456  *	usb_reset_device() encounters changed descriptors (as from
2457  *		a firmware download)
2458  * caller already locked the hub
2459  */
2460 static void hub_port_connect_change(struct usb_hub *hub, int port1,
2461 					u16 portstatus, u16 portchange)
2462 {
2463 	struct usb_device *hdev = hub->hdev;
2464 	struct device *hub_dev = hub->intfdev;
2465 	u16 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2466 	int status, i;
2467 
2468 	dev_dbg (hub_dev,
2469 		"port %d, status %04x, change %04x, %s\n",
2470 		port1, portstatus, portchange, portspeed (portstatus));
2471 
2472 	if (hub->has_indicators) {
2473 		set_port_led(hub, port1, HUB_LED_AUTO);
2474 		hub->indicator[port1-1] = INDICATOR_AUTO;
2475 	}
2476 
2477 	/* Disconnect any existing devices under this port */
2478 	if (hdev->children[port1-1])
2479 		usb_disconnect(&hdev->children[port1-1]);
2480 	clear_bit(port1, hub->change_bits);
2481 
2482 #ifdef	CONFIG_USB_OTG
2483 	/* during HNP, don't repeat the debounce */
2484 	if (hdev->bus->is_b_host)
2485 		portchange &= ~USB_PORT_STAT_C_CONNECTION;
2486 #endif
2487 
2488 	if (portchange & USB_PORT_STAT_C_CONNECTION) {
2489 		status = hub_port_debounce(hub, port1);
2490 		if (status < 0) {
2491 			dev_err (hub_dev,
2492 				"connect-debounce failed, port %d disabled\n",
2493 				port1);
2494 			goto done;
2495 		}
2496 		portstatus = status;
2497 	}
2498 
2499 	/* Return now if nothing is connected */
2500 	if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
2501 
2502 		/* maybe switch power back on (e.g. root hub was reset) */
2503 		if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
2504 				&& !(portstatus & (1 << USB_PORT_FEAT_POWER)))
2505 			set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
2506 
2507 		if (portstatus & USB_PORT_STAT_ENABLE)
2508   			goto done;
2509 		return;
2510 	}
2511 
2512 #ifdef  CONFIG_USB_SUSPEND
2513 	/* If something is connected, but the port is suspended, wake it up. */
2514 	if (portstatus & USB_PORT_STAT_SUSPEND) {
2515 		status = hub_port_resume(hub, port1, NULL);
2516 		if (status < 0) {
2517 			dev_dbg(hub_dev,
2518 				"can't clear suspend on port %d; %d\n",
2519 				port1, status);
2520 			goto done;
2521 		}
2522 	}
2523 #endif
2524 
2525 	for (i = 0; i < SET_CONFIG_TRIES; i++) {
2526 		struct usb_device *udev;
2527 
2528 		/* reallocate for each attempt, since references
2529 		 * to the previous one can escape in various ways
2530 		 */
2531 		udev = usb_alloc_dev(hdev, hdev->bus, port1);
2532 		if (!udev) {
2533 			dev_err (hub_dev,
2534 				"couldn't allocate port %d usb_device\n",
2535 				port1);
2536 			goto done;
2537 		}
2538 
2539 		usb_set_device_state(udev, USB_STATE_POWERED);
2540 		udev->speed = USB_SPEED_UNKNOWN;
2541  		udev->bus_mA = hub->mA_per_port;
2542 
2543 		/* set the address */
2544 		choose_address(udev);
2545 		if (udev->devnum <= 0) {
2546 			status = -ENOTCONN;	/* Don't retry */
2547 			goto loop;
2548 		}
2549 
2550 		/* reset and get descriptor */
2551 		status = hub_port_init(hub, udev, port1, i);
2552 		if (status < 0)
2553 			goto loop;
2554 
2555 		/* consecutive bus-powered hubs aren't reliable; they can
2556 		 * violate the voltage drop budget.  if the new child has
2557 		 * a "powered" LED, users should notice we didn't enable it
2558 		 * (without reading syslog), even without per-port LEDs
2559 		 * on the parent.
2560 		 */
2561 		if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
2562 				&& udev->bus_mA <= 100) {
2563 			u16	devstat;
2564 
2565 			status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
2566 					&devstat);
2567 			if (status < 2) {
2568 				dev_dbg(&udev->dev, "get status %d ?\n", status);
2569 				goto loop_disable;
2570 			}
2571 			le16_to_cpus(&devstat);
2572 			if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
2573 				dev_err(&udev->dev,
2574 					"can't connect bus-powered hub "
2575 					"to this port\n");
2576 				if (hub->has_indicators) {
2577 					hub->indicator[port1-1] =
2578 						INDICATOR_AMBER_BLINK;
2579 					schedule_work (&hub->leds);
2580 				}
2581 				status = -ENOTCONN;	/* Don't retry */
2582 				goto loop_disable;
2583 			}
2584 		}
2585 
2586 		/* check for devices running slower than they could */
2587 		if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
2588 				&& udev->speed == USB_SPEED_FULL
2589 				&& highspeed_hubs != 0)
2590 			check_highspeed (hub, udev, port1);
2591 
2592 		/* Store the parent's children[] pointer.  At this point
2593 		 * udev becomes globally accessible, although presumably
2594 		 * no one will look at it until hdev is unlocked.
2595 		 */
2596 		status = 0;
2597 
2598 		/* We mustn't add new devices if the parent hub has
2599 		 * been disconnected; we would race with the
2600 		 * recursively_mark_NOTATTACHED() routine.
2601 		 */
2602 		spin_lock_irq(&device_state_lock);
2603 		if (hdev->state == USB_STATE_NOTATTACHED)
2604 			status = -ENOTCONN;
2605 		else
2606 			hdev->children[port1-1] = udev;
2607 		spin_unlock_irq(&device_state_lock);
2608 
2609 		/* Run it through the hoops (find a driver, etc) */
2610 		if (!status) {
2611 			status = usb_new_device(udev);
2612 			if (status) {
2613 				spin_lock_irq(&device_state_lock);
2614 				hdev->children[port1-1] = NULL;
2615 				spin_unlock_irq(&device_state_lock);
2616 			}
2617 		}
2618 
2619 		if (status)
2620 			goto loop_disable;
2621 
2622 		status = hub_power_remaining(hub);
2623 		if (status)
2624 			dev_dbg(hub_dev, "%dmA power budget left\n", status);
2625 
2626 		return;
2627 
2628 loop_disable:
2629 		hub_port_disable(hub, port1, 1);
2630 loop:
2631 		ep0_reinit(udev);
2632 		release_address(udev);
2633 		usb_put_dev(udev);
2634 		if (status == -ENOTCONN)
2635 			break;
2636 	}
2637 
2638 done:
2639 	hub_port_disable(hub, port1, 1);
2640 }
2641 
2642 static void hub_events(void)
2643 {
2644 	struct list_head *tmp;
2645 	struct usb_device *hdev;
2646 	struct usb_interface *intf;
2647 	struct usb_hub *hub;
2648 	struct device *hub_dev;
2649 	u16 hubstatus;
2650 	u16 hubchange;
2651 	u16 portstatus;
2652 	u16 portchange;
2653 	int i, ret;
2654 	int connect_change;
2655 
2656 	/*
2657 	 *  We restart the list every time to avoid a deadlock with
2658 	 * deleting hubs downstream from this one. This should be
2659 	 * safe since we delete the hub from the event list.
2660 	 * Not the most efficient, but avoids deadlocks.
2661 	 */
2662 	while (1) {
2663 
2664 		/* Grab the first entry at the beginning of the list */
2665 		spin_lock_irq(&hub_event_lock);
2666 		if (list_empty(&hub_event_list)) {
2667 			spin_unlock_irq(&hub_event_lock);
2668 			break;
2669 		}
2670 
2671 		tmp = hub_event_list.next;
2672 		list_del_init(tmp);
2673 
2674 		hub = list_entry(tmp, struct usb_hub, event_list);
2675 		hdev = hub->hdev;
2676 		intf = to_usb_interface(hub->intfdev);
2677 		hub_dev = &intf->dev;
2678 
2679 		i = hub->resume_root_hub;
2680 
2681 		dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x%s\n",
2682 				hdev->state, hub->descriptor
2683 					? hub->descriptor->bNbrPorts
2684 					: 0,
2685 				/* NOTE: expects max 15 ports... */
2686 				(u16) hub->change_bits[0],
2687 				(u16) hub->event_bits[0],
2688 				i ? ", resume root" : "");
2689 
2690 		usb_get_intf(intf);
2691 		spin_unlock_irq(&hub_event_lock);
2692 
2693 		/* Is this is a root hub wanting to reactivate the downstream
2694 		 * ports?  If so, be sure the interface resumes even if its
2695 		 * stub "device" node was never suspended.
2696 		 */
2697 		if (i) {
2698 			dpm_runtime_resume(&hdev->dev);
2699 			dpm_runtime_resume(&intf->dev);
2700 			usb_put_intf(intf);
2701 			continue;
2702 		}
2703 
2704 		/* Lock the device, then check to see if we were
2705 		 * disconnected while waiting for the lock to succeed. */
2706 		if (locktree(hdev) < 0) {
2707 			usb_put_intf(intf);
2708 			continue;
2709 		}
2710 		if (hub != usb_get_intfdata(intf))
2711 			goto loop;
2712 
2713 		/* If the hub has died, clean up after it */
2714 		if (hdev->state == USB_STATE_NOTATTACHED) {
2715 			hub_pre_reset(hub, 0);
2716 			goto loop;
2717 		}
2718 
2719 		/* If this is an inactive or suspended hub, do nothing */
2720 		if (hub->quiescing)
2721 			goto loop;
2722 
2723 		if (hub->error) {
2724 			dev_dbg (hub_dev, "resetting for error %d\n",
2725 				hub->error);
2726 
2727 			ret = usb_reset_device(hdev);
2728 			if (ret) {
2729 				dev_dbg (hub_dev,
2730 					"error resetting hub: %d\n", ret);
2731 				goto loop;
2732 			}
2733 
2734 			hub->nerrors = 0;
2735 			hub->error = 0;
2736 		}
2737 
2738 		/* deal with port status changes */
2739 		for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
2740 			if (test_bit(i, hub->busy_bits))
2741 				continue;
2742 			connect_change = test_bit(i, hub->change_bits);
2743 			if (!test_and_clear_bit(i, hub->event_bits) &&
2744 					!connect_change && !hub->activating)
2745 				continue;
2746 
2747 			ret = hub_port_status(hub, i,
2748 					&portstatus, &portchange);
2749 			if (ret < 0)
2750 				continue;
2751 
2752 			if (hub->activating && !hdev->children[i-1] &&
2753 					(portstatus &
2754 						USB_PORT_STAT_CONNECTION))
2755 				connect_change = 1;
2756 
2757 			if (portchange & USB_PORT_STAT_C_CONNECTION) {
2758 				clear_port_feature(hdev, i,
2759 					USB_PORT_FEAT_C_CONNECTION);
2760 				connect_change = 1;
2761 			}
2762 
2763 			if (portchange & USB_PORT_STAT_C_ENABLE) {
2764 				if (!connect_change)
2765 					dev_dbg (hub_dev,
2766 						"port %d enable change, "
2767 						"status %08x\n",
2768 						i, portstatus);
2769 				clear_port_feature(hdev, i,
2770 					USB_PORT_FEAT_C_ENABLE);
2771 
2772 				/*
2773 				 * EM interference sometimes causes badly
2774 				 * shielded USB devices to be shutdown by
2775 				 * the hub, this hack enables them again.
2776 				 * Works at least with mouse driver.
2777 				 */
2778 				if (!(portstatus & USB_PORT_STAT_ENABLE)
2779 				    && !connect_change
2780 				    && hdev->children[i-1]) {
2781 					dev_err (hub_dev,
2782 					    "port %i "
2783 					    "disabled by hub (EMI?), "
2784 					    "re-enabling...\n",
2785 						i);
2786 					connect_change = 1;
2787 				}
2788 			}
2789 
2790 			if (portchange & USB_PORT_STAT_C_SUSPEND) {
2791 				clear_port_feature(hdev, i,
2792 					USB_PORT_FEAT_C_SUSPEND);
2793 				if (hdev->children[i-1]) {
2794 					ret = remote_wakeup(hdev->
2795 							children[i-1]);
2796 					if (ret < 0)
2797 						connect_change = 1;
2798 				} else {
2799 					ret = -ENODEV;
2800 					hub_port_disable(hub, i, 1);
2801 				}
2802 				dev_dbg (hub_dev,
2803 					"resume on port %d, status %d\n",
2804 					i, ret);
2805 			}
2806 
2807 			if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
2808 				dev_err (hub_dev,
2809 					"over-current change on port %d\n",
2810 					i);
2811 				clear_port_feature(hdev, i,
2812 					USB_PORT_FEAT_C_OVER_CURRENT);
2813 				hub_power_on(hub);
2814 			}
2815 
2816 			if (portchange & USB_PORT_STAT_C_RESET) {
2817 				dev_dbg (hub_dev,
2818 					"reset change on port %d\n",
2819 					i);
2820 				clear_port_feature(hdev, i,
2821 					USB_PORT_FEAT_C_RESET);
2822 			}
2823 
2824 			if (connect_change)
2825 				hub_port_connect_change(hub, i,
2826 						portstatus, portchange);
2827 		} /* end for i */
2828 
2829 		/* deal with hub status changes */
2830 		if (test_and_clear_bit(0, hub->event_bits) == 0)
2831 			;	/* do nothing */
2832 		else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
2833 			dev_err (hub_dev, "get_hub_status failed\n");
2834 		else {
2835 			if (hubchange & HUB_CHANGE_LOCAL_POWER) {
2836 				dev_dbg (hub_dev, "power change\n");
2837 				clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
2838 				if (hubstatus & HUB_STATUS_LOCAL_POWER)
2839 					/* FIXME: Is this always true? */
2840 					hub->limited_power = 0;
2841 				else
2842 					hub->limited_power = 1;
2843 			}
2844 			if (hubchange & HUB_CHANGE_OVERCURRENT) {
2845 				dev_dbg (hub_dev, "overcurrent change\n");
2846 				msleep(500);	/* Cool down */
2847 				clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
2848                         	hub_power_on(hub);
2849 			}
2850 		}
2851 
2852 		hub->activating = 0;
2853 
2854 		/* If this is a root hub, tell the HCD it's okay to
2855 		 * re-enable port-change interrupts now. */
2856 		if (!hdev->parent)
2857 			usb_enable_root_hub_irq(hdev->bus);
2858 
2859 loop:
2860 		usb_unlock_device(hdev);
2861 		usb_put_intf(intf);
2862 
2863         } /* end while (1) */
2864 }
2865 
2866 static int hub_thread(void *__unused)
2867 {
2868 	do {
2869 		hub_events();
2870 		wait_event_interruptible(khubd_wait,
2871 				!list_empty(&hub_event_list) ||
2872 				kthread_should_stop());
2873 		try_to_freeze();
2874 	} while (!kthread_should_stop() || !list_empty(&hub_event_list));
2875 
2876 	pr_debug("%s: khubd exiting\n", usbcore_name);
2877 	return 0;
2878 }
2879 
2880 static struct usb_device_id hub_id_table [] = {
2881     { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
2882       .bDeviceClass = USB_CLASS_HUB},
2883     { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
2884       .bInterfaceClass = USB_CLASS_HUB},
2885     { }						/* Terminating entry */
2886 };
2887 
2888 MODULE_DEVICE_TABLE (usb, hub_id_table);
2889 
2890 static struct usb_driver hub_driver = {
2891 	.name =		"hub",
2892 	.probe =	hub_probe,
2893 	.disconnect =	hub_disconnect,
2894 	.suspend =	hub_suspend,
2895 	.resume =	hub_resume,
2896 	.ioctl =	hub_ioctl,
2897 	.id_table =	hub_id_table,
2898 };
2899 
2900 int usb_hub_init(void)
2901 {
2902 	if (usb_register(&hub_driver) < 0) {
2903 		printk(KERN_ERR "%s: can't register hub driver\n",
2904 			usbcore_name);
2905 		return -1;
2906 	}
2907 
2908 	khubd_task = kthread_run(hub_thread, NULL, "khubd");
2909 	if (!IS_ERR(khubd_task))
2910 		return 0;
2911 
2912 	/* Fall through if kernel_thread failed */
2913 	usb_deregister(&hub_driver);
2914 	printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
2915 
2916 	return -1;
2917 }
2918 
2919 void usb_hub_cleanup(void)
2920 {
2921 	kthread_stop(khubd_task);
2922 
2923 	/*
2924 	 * Hub resources are freed for us by usb_deregister. It calls
2925 	 * usb_driver_purge on every device which in turn calls that
2926 	 * devices disconnect function if it is using this driver.
2927 	 * The hub_disconnect function takes care of releasing the
2928 	 * individual hub resources. -greg
2929 	 */
2930 	usb_deregister(&hub_driver);
2931 } /* usb_hub_cleanup() */
2932 
2933 static int config_descriptors_changed(struct usb_device *udev)
2934 {
2935 	unsigned			index;
2936 	unsigned			len = 0;
2937 	struct usb_config_descriptor	*buf;
2938 
2939 	for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2940 		if (len < le16_to_cpu(udev->config[index].desc.wTotalLength))
2941 			len = le16_to_cpu(udev->config[index].desc.wTotalLength);
2942 	}
2943 	buf = kmalloc (len, SLAB_KERNEL);
2944 	if (buf == NULL) {
2945 		dev_err(&udev->dev, "no mem to re-read configs after reset\n");
2946 		/* assume the worst */
2947 		return 1;
2948 	}
2949 	for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2950 		int length;
2951 		int old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
2952 
2953 		length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
2954 				old_length);
2955 		if (length < old_length) {
2956 			dev_dbg(&udev->dev, "config index %d, error %d\n",
2957 					index, length);
2958 			break;
2959 		}
2960 		if (memcmp (buf, udev->rawdescriptors[index], old_length)
2961 				!= 0) {
2962 			dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
2963 				index, buf->bConfigurationValue);
2964 			break;
2965 		}
2966 	}
2967 	kfree(buf);
2968 	return index != udev->descriptor.bNumConfigurations;
2969 }
2970 
2971 /**
2972  * usb_reset_device - perform a USB port reset to reinitialize a device
2973  * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
2974  *
2975  * WARNING - don't reset any device unless drivers for all of its
2976  * interfaces are expecting that reset!  Maybe some driver->reset()
2977  * method should eventually help ensure sufficient cooperation.
2978  *
2979  * Do a port reset, reassign the device's address, and establish its
2980  * former operating configuration.  If the reset fails, or the device's
2981  * descriptors change from their values before the reset, or the original
2982  * configuration and altsettings cannot be restored, a flag will be set
2983  * telling khubd to pretend the device has been disconnected and then
2984  * re-connected.  All drivers will be unbound, and the device will be
2985  * re-enumerated and probed all over again.
2986  *
2987  * Returns 0 if the reset succeeded, -ENODEV if the device has been
2988  * flagged for logical disconnection, or some other negative error code
2989  * if the reset wasn't even attempted.
2990  *
2991  * The caller must own the device lock.  For example, it's safe to use
2992  * this from a driver probe() routine after downloading new firmware.
2993  * For calls that might not occur during probe(), drivers should lock
2994  * the device using usb_lock_device_for_reset().
2995  */
2996 int usb_reset_device(struct usb_device *udev)
2997 {
2998 	struct usb_device		*parent_hdev = udev->parent;
2999 	struct usb_hub			*parent_hub;
3000 	struct usb_device_descriptor	descriptor = udev->descriptor;
3001 	struct usb_hub			*hub = NULL;
3002 	int 				i, ret = 0;
3003 	int				port1 = udev->portnum;
3004 
3005 	if (udev->state == USB_STATE_NOTATTACHED ||
3006 			udev->state == USB_STATE_SUSPENDED) {
3007 		dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3008 				udev->state);
3009 		return -EINVAL;
3010 	}
3011 
3012 	if (!parent_hdev) {
3013 		/* this requires hcd-specific logic; see OHCI hc_restart() */
3014 		dev_dbg(&udev->dev, "%s for root hub!\n", __FUNCTION__);
3015 		return -EISDIR;
3016 	}
3017 	parent_hub = hdev_to_hub(parent_hdev);
3018 
3019 	/* If we're resetting an active hub, take some special actions */
3020 	if (udev->actconfig &&
3021 			udev->actconfig->interface[0]->dev.driver ==
3022 				&hub_driver.driver &&
3023 			(hub = hdev_to_hub(udev)) != NULL) {
3024 		hub_pre_reset(hub, 0);
3025 	}
3026 
3027 	set_bit(port1, parent_hub->busy_bits);
3028 	for (i = 0; i < SET_CONFIG_TRIES; ++i) {
3029 
3030 		/* ep0 maxpacket size may change; let the HCD know about it.
3031 		 * Other endpoints will be handled by re-enumeration. */
3032 		ep0_reinit(udev);
3033 		ret = hub_port_init(parent_hub, udev, port1, i);
3034 		if (ret >= 0)
3035 			break;
3036 	}
3037 	clear_bit(port1, parent_hub->busy_bits);
3038 	if (ret < 0)
3039 		goto re_enumerate;
3040 
3041 	/* Device might have changed firmware (DFU or similar) */
3042 	if (memcmp(&udev->descriptor, &descriptor, sizeof descriptor)
3043 			|| config_descriptors_changed (udev)) {
3044 		dev_info(&udev->dev, "device firmware changed\n");
3045 		udev->descriptor = descriptor;	/* for disconnect() calls */
3046 		goto re_enumerate;
3047   	}
3048 
3049 	if (!udev->actconfig)
3050 		goto done;
3051 
3052 	ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3053 			USB_REQ_SET_CONFIGURATION, 0,
3054 			udev->actconfig->desc.bConfigurationValue, 0,
3055 			NULL, 0, USB_CTRL_SET_TIMEOUT);
3056 	if (ret < 0) {
3057 		dev_err(&udev->dev,
3058 			"can't restore configuration #%d (error=%d)\n",
3059 			udev->actconfig->desc.bConfigurationValue, ret);
3060 		goto re_enumerate;
3061   	}
3062 	usb_set_device_state(udev, USB_STATE_CONFIGURED);
3063 
3064 	for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
3065 		struct usb_interface *intf = udev->actconfig->interface[i];
3066 		struct usb_interface_descriptor *desc;
3067 
3068 		/* set_interface resets host side toggle even
3069 		 * for altsetting zero.  the interface may have no driver.
3070 		 */
3071 		desc = &intf->cur_altsetting->desc;
3072 		ret = usb_set_interface(udev, desc->bInterfaceNumber,
3073 			desc->bAlternateSetting);
3074 		if (ret < 0) {
3075 			dev_err(&udev->dev, "failed to restore interface %d "
3076 				"altsetting %d (error=%d)\n",
3077 				desc->bInterfaceNumber,
3078 				desc->bAlternateSetting,
3079 				ret);
3080 			goto re_enumerate;
3081 		}
3082 	}
3083 
3084 done:
3085 	if (hub)
3086 		hub_post_reset(hub);
3087 	return 0;
3088 
3089 re_enumerate:
3090 	hub_port_logical_disconnect(parent_hub, port1);
3091 	return -ENODEV;
3092 }
3093