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