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