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