xref: /openbmc/linux/drivers/usb/core/hub.c (revision 4956eccd)
11da177e4SLinus Torvalds /*
21da177e4SLinus Torvalds  * USB hub driver.
31da177e4SLinus Torvalds  *
41da177e4SLinus Torvalds  * (C) Copyright 1999 Linus Torvalds
51da177e4SLinus Torvalds  * (C) Copyright 1999 Johannes Erdfelt
61da177e4SLinus Torvalds  * (C) Copyright 1999 Gregory P. Smith
71da177e4SLinus Torvalds  * (C) Copyright 2001 Brad Hards (bhards@bigpond.net.au)
81da177e4SLinus Torvalds  *
91da177e4SLinus Torvalds  */
101da177e4SLinus Torvalds 
111da177e4SLinus Torvalds #include <linux/kernel.h>
121da177e4SLinus Torvalds #include <linux/errno.h>
131da177e4SLinus Torvalds #include <linux/module.h>
141da177e4SLinus Torvalds #include <linux/moduleparam.h>
151da177e4SLinus Torvalds #include <linux/completion.h>
161da177e4SLinus Torvalds #include <linux/sched.h>
171da177e4SLinus Torvalds #include <linux/list.h>
181da177e4SLinus Torvalds #include <linux/slab.h>
191da177e4SLinus Torvalds #include <linux/ioctl.h>
201da177e4SLinus Torvalds #include <linux/usb.h>
211da177e4SLinus Torvalds #include <linux/usbdevice_fs.h>
229c8d6178Sakpm@osdl.org #include <linux/kthread.h>
234186ecf8SArjan van de Ven #include <linux/mutex.h>
247dfb7103SNigel Cunningham #include <linux/freezer.h>
251da177e4SLinus Torvalds 
261da177e4SLinus Torvalds #include <asm/semaphore.h>
271da177e4SLinus Torvalds #include <asm/uaccess.h>
281da177e4SLinus Torvalds #include <asm/byteorder.h>
291da177e4SLinus Torvalds 
301da177e4SLinus Torvalds #include "usb.h"
311da177e4SLinus Torvalds #include "hcd.h"
321da177e4SLinus Torvalds #include "hub.h"
331da177e4SLinus Torvalds 
341bb5f66bSAlan Stern struct usb_hub {
351bb5f66bSAlan Stern 	struct device		*intfdev;	/* the "interface" device */
361bb5f66bSAlan Stern 	struct usb_device	*hdev;
37e8054854SAlan Stern 	struct kref		kref;
381bb5f66bSAlan Stern 	struct urb		*urb;		/* for interrupt polling pipe */
391bb5f66bSAlan Stern 
401bb5f66bSAlan Stern 	/* buffer for urb ... with extra space in case of babble */
411bb5f66bSAlan Stern 	char			(*buffer)[8];
421bb5f66bSAlan Stern 	dma_addr_t		buffer_dma;	/* DMA address for buffer */
431bb5f66bSAlan Stern 	union {
441bb5f66bSAlan Stern 		struct usb_hub_status	hub;
451bb5f66bSAlan Stern 		struct usb_port_status	port;
461bb5f66bSAlan Stern 	}			*status;	/* buffer for status reports */
47db90e7a1SAlan Stern 	struct mutex		status_mutex;	/* for the status buffer */
481bb5f66bSAlan Stern 
491bb5f66bSAlan Stern 	int			error;		/* last reported error */
501bb5f66bSAlan Stern 	int			nerrors;	/* track consecutive errors */
511bb5f66bSAlan Stern 
521bb5f66bSAlan Stern 	struct list_head	event_list;	/* hubs w/data or errs ready */
531bb5f66bSAlan Stern 	unsigned long		event_bits[1];	/* status change bitmask */
541bb5f66bSAlan Stern 	unsigned long		change_bits[1];	/* ports with logical connect
551bb5f66bSAlan Stern 							status change */
561bb5f66bSAlan Stern 	unsigned long		busy_bits[1];	/* ports being reset or
571bb5f66bSAlan Stern 							resumed */
581bb5f66bSAlan Stern #if USB_MAXCHILDREN > 31 /* 8*sizeof(unsigned long) - 1 */
591bb5f66bSAlan Stern #error event_bits[] is too short!
601bb5f66bSAlan Stern #endif
611bb5f66bSAlan Stern 
621bb5f66bSAlan Stern 	struct usb_hub_descriptor *descriptor;	/* class descriptor */
631bb5f66bSAlan Stern 	struct usb_tt		tt;		/* Transaction Translator */
641bb5f66bSAlan Stern 
651bb5f66bSAlan Stern 	unsigned		mA_per_port;	/* current for each child */
661bb5f66bSAlan Stern 
671bb5f66bSAlan Stern 	unsigned		limited_power:1;
681bb5f66bSAlan Stern 	unsigned		quiescing:1;
691bb5f66bSAlan Stern 	unsigned		activating:1;
70e8054854SAlan Stern 	unsigned		disconnected:1;
711bb5f66bSAlan Stern 
721bb5f66bSAlan Stern 	unsigned		has_indicators:1;
731bb5f66bSAlan Stern 	u8			indicator[USB_MAXCHILDREN];
746d5aefb8SDavid Howells 	struct delayed_work	leds;
751bb5f66bSAlan Stern };
761bb5f66bSAlan Stern 
771bb5f66bSAlan Stern 
781da177e4SLinus Torvalds /* Protect struct usb_device->state and ->children members
799ad3d6ccSAlan Stern  * Note: Both are also protected by ->dev.sem, except that ->state can
801da177e4SLinus Torvalds  * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
811da177e4SLinus Torvalds static DEFINE_SPINLOCK(device_state_lock);
821da177e4SLinus Torvalds 
831da177e4SLinus Torvalds /* khubd's worklist and its lock */
841da177e4SLinus Torvalds static DEFINE_SPINLOCK(hub_event_lock);
851da177e4SLinus Torvalds static LIST_HEAD(hub_event_list);	/* List of hubs needing servicing */
861da177e4SLinus Torvalds 
871da177e4SLinus Torvalds /* Wakes up khubd */
881da177e4SLinus Torvalds static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
891da177e4SLinus Torvalds 
909c8d6178Sakpm@osdl.org static struct task_struct *khubd_task;
911da177e4SLinus Torvalds 
921da177e4SLinus Torvalds /* cycle leds on hubs that aren't blinking for attention */
931da177e4SLinus Torvalds static int blinkenlights = 0;
941da177e4SLinus Torvalds module_param (blinkenlights, bool, S_IRUGO);
951da177e4SLinus Torvalds MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
961da177e4SLinus Torvalds 
971da177e4SLinus Torvalds /*
981da177e4SLinus Torvalds  * As of 2.6.10 we introduce a new USB device initialization scheme which
991da177e4SLinus Torvalds  * closely resembles the way Windows works.  Hopefully it will be compatible
1001da177e4SLinus Torvalds  * with a wider range of devices than the old scheme.  However some previously
1011da177e4SLinus Torvalds  * working devices may start giving rise to "device not accepting address"
1021da177e4SLinus Torvalds  * errors; if that happens the user can try the old scheme by adjusting the
1031da177e4SLinus Torvalds  * following module parameters.
1041da177e4SLinus Torvalds  *
1051da177e4SLinus Torvalds  * For maximum flexibility there are two boolean parameters to control the
1061da177e4SLinus Torvalds  * hub driver's behavior.  On the first initialization attempt, if the
1071da177e4SLinus Torvalds  * "old_scheme_first" parameter is set then the old scheme will be used,
1081da177e4SLinus Torvalds  * otherwise the new scheme is used.  If that fails and "use_both_schemes"
1091da177e4SLinus Torvalds  * is set, then the driver will make another attempt, using the other scheme.
1101da177e4SLinus Torvalds  */
1111da177e4SLinus Torvalds static int old_scheme_first = 0;
1121da177e4SLinus Torvalds module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
1131da177e4SLinus Torvalds MODULE_PARM_DESC(old_scheme_first,
1141da177e4SLinus Torvalds 		 "start with the old device initialization scheme");
1151da177e4SLinus Torvalds 
1161da177e4SLinus Torvalds static int use_both_schemes = 1;
1171da177e4SLinus Torvalds module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
1181da177e4SLinus Torvalds MODULE_PARM_DESC(use_both_schemes,
1191da177e4SLinus Torvalds 		"try the other device initialization scheme if the "
1201da177e4SLinus Torvalds 		"first one fails");
1211da177e4SLinus Torvalds 
1221da177e4SLinus Torvalds 
1231da177e4SLinus Torvalds static inline char *portspeed(int portstatus)
1241da177e4SLinus Torvalds {
1251da177e4SLinus Torvalds 	if (portstatus & (1 << USB_PORT_FEAT_HIGHSPEED))
1261da177e4SLinus Torvalds     		return "480 Mb/s";
1271da177e4SLinus Torvalds 	else if (portstatus & (1 << USB_PORT_FEAT_LOWSPEED))
1281da177e4SLinus Torvalds 		return "1.5 Mb/s";
1291da177e4SLinus Torvalds 	else
1301da177e4SLinus Torvalds 		return "12 Mb/s";
1311da177e4SLinus Torvalds }
1321da177e4SLinus Torvalds 
1331da177e4SLinus Torvalds /* Note that hdev or one of its children must be locked! */
1341da177e4SLinus Torvalds static inline struct usb_hub *hdev_to_hub(struct usb_device *hdev)
1351da177e4SLinus Torvalds {
1361da177e4SLinus Torvalds 	return usb_get_intfdata(hdev->actconfig->interface[0]);
1371da177e4SLinus Torvalds }
1381da177e4SLinus Torvalds 
1391da177e4SLinus Torvalds /* USB 2.0 spec Section 11.24.4.5 */
1401da177e4SLinus Torvalds static int get_hub_descriptor(struct usb_device *hdev, void *data, int size)
1411da177e4SLinus Torvalds {
1421da177e4SLinus Torvalds 	int i, ret;
1431da177e4SLinus Torvalds 
1441da177e4SLinus Torvalds 	for (i = 0; i < 3; i++) {
1451da177e4SLinus Torvalds 		ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
1461da177e4SLinus Torvalds 			USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
1471da177e4SLinus Torvalds 			USB_DT_HUB << 8, 0, data, size,
1481da177e4SLinus Torvalds 			USB_CTRL_GET_TIMEOUT);
1491da177e4SLinus Torvalds 		if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
1501da177e4SLinus Torvalds 			return ret;
1511da177e4SLinus Torvalds 	}
1521da177e4SLinus Torvalds 	return -EINVAL;
1531da177e4SLinus Torvalds }
1541da177e4SLinus Torvalds 
1551da177e4SLinus Torvalds /*
1561da177e4SLinus Torvalds  * USB 2.0 spec Section 11.24.2.1
1571da177e4SLinus Torvalds  */
1581da177e4SLinus Torvalds static int clear_hub_feature(struct usb_device *hdev, int feature)
1591da177e4SLinus Torvalds {
1601da177e4SLinus Torvalds 	return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
1611da177e4SLinus Torvalds 		USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
1621da177e4SLinus Torvalds }
1631da177e4SLinus Torvalds 
1641da177e4SLinus Torvalds /*
1651da177e4SLinus Torvalds  * USB 2.0 spec Section 11.24.2.2
1661da177e4SLinus Torvalds  */
1671da177e4SLinus Torvalds static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
1681da177e4SLinus Torvalds {
1691da177e4SLinus Torvalds 	return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
1701da177e4SLinus Torvalds 		USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
1711da177e4SLinus Torvalds 		NULL, 0, 1000);
1721da177e4SLinus Torvalds }
1731da177e4SLinus Torvalds 
1741da177e4SLinus Torvalds /*
1751da177e4SLinus Torvalds  * USB 2.0 spec Section 11.24.2.13
1761da177e4SLinus Torvalds  */
1771da177e4SLinus Torvalds static int set_port_feature(struct usb_device *hdev, int port1, int feature)
1781da177e4SLinus Torvalds {
1791da177e4SLinus Torvalds 	return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
1801da177e4SLinus Torvalds 		USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
1811da177e4SLinus Torvalds 		NULL, 0, 1000);
1821da177e4SLinus Torvalds }
1831da177e4SLinus Torvalds 
1841da177e4SLinus Torvalds /*
1851da177e4SLinus Torvalds  * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
1861da177e4SLinus Torvalds  * for info about using port indicators
1871da177e4SLinus Torvalds  */
1881da177e4SLinus Torvalds static void set_port_led(
1891da177e4SLinus Torvalds 	struct usb_hub *hub,
1901da177e4SLinus Torvalds 	int port1,
1911da177e4SLinus Torvalds 	int selector
1921da177e4SLinus Torvalds )
1931da177e4SLinus Torvalds {
1941da177e4SLinus Torvalds 	int status = set_port_feature(hub->hdev, (selector << 8) | port1,
1951da177e4SLinus Torvalds 			USB_PORT_FEAT_INDICATOR);
1961da177e4SLinus Torvalds 	if (status < 0)
1971da177e4SLinus Torvalds 		dev_dbg (hub->intfdev,
1981da177e4SLinus Torvalds 			"port %d indicator %s status %d\n",
1991da177e4SLinus Torvalds 			port1,
2001da177e4SLinus Torvalds 			({ char *s; switch (selector) {
2011da177e4SLinus Torvalds 			case HUB_LED_AMBER: s = "amber"; break;
2021da177e4SLinus Torvalds 			case HUB_LED_GREEN: s = "green"; break;
2031da177e4SLinus Torvalds 			case HUB_LED_OFF: s = "off"; break;
2041da177e4SLinus Torvalds 			case HUB_LED_AUTO: s = "auto"; break;
2051da177e4SLinus Torvalds 			default: s = "??"; break;
2061da177e4SLinus Torvalds 			}; s; }),
2071da177e4SLinus Torvalds 			status);
2081da177e4SLinus Torvalds }
2091da177e4SLinus Torvalds 
2101da177e4SLinus Torvalds #define	LED_CYCLE_PERIOD	((2*HZ)/3)
2111da177e4SLinus Torvalds 
212c4028958SDavid Howells static void led_work (struct work_struct *work)
2131da177e4SLinus Torvalds {
214c4028958SDavid Howells 	struct usb_hub		*hub =
215c4028958SDavid Howells 		container_of(work, struct usb_hub, leds.work);
2161da177e4SLinus Torvalds 	struct usb_device	*hdev = hub->hdev;
2171da177e4SLinus Torvalds 	unsigned		i;
2181da177e4SLinus Torvalds 	unsigned		changed = 0;
2191da177e4SLinus Torvalds 	int			cursor = -1;
2201da177e4SLinus Torvalds 
2211da177e4SLinus Torvalds 	if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
2221da177e4SLinus Torvalds 		return;
2231da177e4SLinus Torvalds 
2241da177e4SLinus Torvalds 	for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
2251da177e4SLinus Torvalds 		unsigned	selector, mode;
2261da177e4SLinus Torvalds 
2271da177e4SLinus Torvalds 		/* 30%-50% duty cycle */
2281da177e4SLinus Torvalds 
2291da177e4SLinus Torvalds 		switch (hub->indicator[i]) {
2301da177e4SLinus Torvalds 		/* cycle marker */
2311da177e4SLinus Torvalds 		case INDICATOR_CYCLE:
2321da177e4SLinus Torvalds 			cursor = i;
2331da177e4SLinus Torvalds 			selector = HUB_LED_AUTO;
2341da177e4SLinus Torvalds 			mode = INDICATOR_AUTO;
2351da177e4SLinus Torvalds 			break;
2361da177e4SLinus Torvalds 		/* blinking green = sw attention */
2371da177e4SLinus Torvalds 		case INDICATOR_GREEN_BLINK:
2381da177e4SLinus Torvalds 			selector = HUB_LED_GREEN;
2391da177e4SLinus Torvalds 			mode = INDICATOR_GREEN_BLINK_OFF;
2401da177e4SLinus Torvalds 			break;
2411da177e4SLinus Torvalds 		case INDICATOR_GREEN_BLINK_OFF:
2421da177e4SLinus Torvalds 			selector = HUB_LED_OFF;
2431da177e4SLinus Torvalds 			mode = INDICATOR_GREEN_BLINK;
2441da177e4SLinus Torvalds 			break;
2451da177e4SLinus Torvalds 		/* blinking amber = hw attention */
2461da177e4SLinus Torvalds 		case INDICATOR_AMBER_BLINK:
2471da177e4SLinus Torvalds 			selector = HUB_LED_AMBER;
2481da177e4SLinus Torvalds 			mode = INDICATOR_AMBER_BLINK_OFF;
2491da177e4SLinus Torvalds 			break;
2501da177e4SLinus Torvalds 		case INDICATOR_AMBER_BLINK_OFF:
2511da177e4SLinus Torvalds 			selector = HUB_LED_OFF;
2521da177e4SLinus Torvalds 			mode = INDICATOR_AMBER_BLINK;
2531da177e4SLinus Torvalds 			break;
2541da177e4SLinus Torvalds 		/* blink green/amber = reserved */
2551da177e4SLinus Torvalds 		case INDICATOR_ALT_BLINK:
2561da177e4SLinus Torvalds 			selector = HUB_LED_GREEN;
2571da177e4SLinus Torvalds 			mode = INDICATOR_ALT_BLINK_OFF;
2581da177e4SLinus Torvalds 			break;
2591da177e4SLinus Torvalds 		case INDICATOR_ALT_BLINK_OFF:
2601da177e4SLinus Torvalds 			selector = HUB_LED_AMBER;
2611da177e4SLinus Torvalds 			mode = INDICATOR_ALT_BLINK;
2621da177e4SLinus Torvalds 			break;
2631da177e4SLinus Torvalds 		default:
2641da177e4SLinus Torvalds 			continue;
2651da177e4SLinus Torvalds 		}
2661da177e4SLinus Torvalds 		if (selector != HUB_LED_AUTO)
2671da177e4SLinus Torvalds 			changed = 1;
2681da177e4SLinus Torvalds 		set_port_led(hub, i + 1, selector);
2691da177e4SLinus Torvalds 		hub->indicator[i] = mode;
2701da177e4SLinus Torvalds 	}
2711da177e4SLinus Torvalds 	if (!changed && blinkenlights) {
2721da177e4SLinus Torvalds 		cursor++;
2731da177e4SLinus Torvalds 		cursor %= hub->descriptor->bNbrPorts;
2741da177e4SLinus Torvalds 		set_port_led(hub, cursor + 1, HUB_LED_GREEN);
2751da177e4SLinus Torvalds 		hub->indicator[cursor] = INDICATOR_CYCLE;
2761da177e4SLinus Torvalds 		changed++;
2771da177e4SLinus Torvalds 	}
2781da177e4SLinus Torvalds 	if (changed)
2791da177e4SLinus Torvalds 		schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
2801da177e4SLinus Torvalds }
2811da177e4SLinus Torvalds 
2821da177e4SLinus Torvalds /* use a short timeout for hub/port status fetches */
2831da177e4SLinus Torvalds #define	USB_STS_TIMEOUT		1000
2841da177e4SLinus Torvalds #define	USB_STS_RETRIES		5
2851da177e4SLinus Torvalds 
2861da177e4SLinus Torvalds /*
2871da177e4SLinus Torvalds  * USB 2.0 spec Section 11.24.2.6
2881da177e4SLinus Torvalds  */
2891da177e4SLinus Torvalds static int get_hub_status(struct usb_device *hdev,
2901da177e4SLinus Torvalds 		struct usb_hub_status *data)
2911da177e4SLinus Torvalds {
2921da177e4SLinus Torvalds 	int i, status = -ETIMEDOUT;
2931da177e4SLinus Torvalds 
2941da177e4SLinus Torvalds 	for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
2951da177e4SLinus Torvalds 		status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
2961da177e4SLinus Torvalds 			USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
2971da177e4SLinus Torvalds 			data, sizeof(*data), USB_STS_TIMEOUT);
2981da177e4SLinus Torvalds 	}
2991da177e4SLinus Torvalds 	return status;
3001da177e4SLinus Torvalds }
3011da177e4SLinus Torvalds 
3021da177e4SLinus Torvalds /*
3031da177e4SLinus Torvalds  * USB 2.0 spec Section 11.24.2.7
3041da177e4SLinus Torvalds  */
3051da177e4SLinus Torvalds static int get_port_status(struct usb_device *hdev, int port1,
3061da177e4SLinus Torvalds 		struct usb_port_status *data)
3071da177e4SLinus Torvalds {
3081da177e4SLinus Torvalds 	int i, status = -ETIMEDOUT;
3091da177e4SLinus Torvalds 
3101da177e4SLinus Torvalds 	for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
3111da177e4SLinus Torvalds 		status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
3121da177e4SLinus Torvalds 			USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
3131da177e4SLinus Torvalds 			data, sizeof(*data), USB_STS_TIMEOUT);
3141da177e4SLinus Torvalds 	}
3151da177e4SLinus Torvalds 	return status;
3161da177e4SLinus Torvalds }
3171da177e4SLinus Torvalds 
3181da177e4SLinus Torvalds static void kick_khubd(struct usb_hub *hub)
3191da177e4SLinus Torvalds {
3201da177e4SLinus Torvalds 	unsigned long	flags;
3211da177e4SLinus Torvalds 
32240f122f3SAlan Stern 	/* Suppress autosuspend until khubd runs */
32340f122f3SAlan Stern 	to_usb_interface(hub->intfdev)->pm_usage_cnt = 1;
32440f122f3SAlan Stern 
3251da177e4SLinus Torvalds 	spin_lock_irqsave(&hub_event_lock, flags);
326e8054854SAlan Stern 	if (!hub->disconnected & list_empty(&hub->event_list)) {
3271da177e4SLinus Torvalds 		list_add_tail(&hub->event_list, &hub_event_list);
3281da177e4SLinus Torvalds 		wake_up(&khubd_wait);
3291da177e4SLinus Torvalds 	}
3301da177e4SLinus Torvalds 	spin_unlock_irqrestore(&hub_event_lock, flags);
3311da177e4SLinus Torvalds }
3321da177e4SLinus Torvalds 
3331da177e4SLinus Torvalds void usb_kick_khubd(struct usb_device *hdev)
3341da177e4SLinus Torvalds {
335e8054854SAlan Stern 	/* FIXME: What if hdev isn't bound to the hub driver? */
3361da177e4SLinus Torvalds 	kick_khubd(hdev_to_hub(hdev));
3371da177e4SLinus Torvalds }
3381da177e4SLinus Torvalds 
3391da177e4SLinus Torvalds 
3401da177e4SLinus Torvalds /* completion function, fires on port status changes and various faults */
3417d12e780SDavid Howells static void hub_irq(struct urb *urb)
3421da177e4SLinus Torvalds {
343ec17cf1cSTobias Klauser 	struct usb_hub *hub = urb->context;
3441da177e4SLinus Torvalds 	int status;
3451da177e4SLinus Torvalds 	int i;
3461da177e4SLinus Torvalds 	unsigned long bits;
3471da177e4SLinus Torvalds 
3481da177e4SLinus Torvalds 	switch (urb->status) {
3491da177e4SLinus Torvalds 	case -ENOENT:		/* synchronous unlink */
3501da177e4SLinus Torvalds 	case -ECONNRESET:	/* async unlink */
3511da177e4SLinus Torvalds 	case -ESHUTDOWN:	/* hardware going away */
3521da177e4SLinus Torvalds 		return;
3531da177e4SLinus Torvalds 
3541da177e4SLinus Torvalds 	default:		/* presumably an error */
3551da177e4SLinus Torvalds 		/* Cause a hub reset after 10 consecutive errors */
3561da177e4SLinus Torvalds 		dev_dbg (hub->intfdev, "transfer --> %d\n", urb->status);
3571da177e4SLinus Torvalds 		if ((++hub->nerrors < 10) || hub->error)
3581da177e4SLinus Torvalds 			goto resubmit;
3591da177e4SLinus Torvalds 		hub->error = urb->status;
3601da177e4SLinus Torvalds 		/* FALL THROUGH */
3611da177e4SLinus Torvalds 
3621da177e4SLinus Torvalds 	/* let khubd handle things */
3631da177e4SLinus Torvalds 	case 0:			/* we got data:  port status changed */
3641da177e4SLinus Torvalds 		bits = 0;
3651da177e4SLinus Torvalds 		for (i = 0; i < urb->actual_length; ++i)
3661da177e4SLinus Torvalds 			bits |= ((unsigned long) ((*hub->buffer)[i]))
3671da177e4SLinus Torvalds 					<< (i*8);
3681da177e4SLinus Torvalds 		hub->event_bits[0] = bits;
3691da177e4SLinus Torvalds 		break;
3701da177e4SLinus Torvalds 	}
3711da177e4SLinus Torvalds 
3721da177e4SLinus Torvalds 	hub->nerrors = 0;
3731da177e4SLinus Torvalds 
3741da177e4SLinus Torvalds 	/* Something happened, let khubd figure it out */
3751da177e4SLinus Torvalds 	kick_khubd(hub);
3761da177e4SLinus Torvalds 
3771da177e4SLinus Torvalds resubmit:
3781da177e4SLinus Torvalds 	if (hub->quiescing)
3791da177e4SLinus Torvalds 		return;
3801da177e4SLinus Torvalds 
3811da177e4SLinus Torvalds 	if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
3821da177e4SLinus Torvalds 			&& status != -ENODEV && status != -EPERM)
3831da177e4SLinus Torvalds 		dev_err (hub->intfdev, "resubmit --> %d\n", status);
3841da177e4SLinus Torvalds }
3851da177e4SLinus Torvalds 
3861da177e4SLinus Torvalds /* USB 2.0 spec Section 11.24.2.3 */
3871da177e4SLinus Torvalds static inline int
3881da177e4SLinus Torvalds hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
3891da177e4SLinus Torvalds {
3901da177e4SLinus Torvalds 	return usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
3911da177e4SLinus Torvalds 			       HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
3921da177e4SLinus Torvalds 			       tt, NULL, 0, 1000);
3931da177e4SLinus Torvalds }
3941da177e4SLinus Torvalds 
3951da177e4SLinus Torvalds /*
3961da177e4SLinus Torvalds  * enumeration blocks khubd for a long time. we use keventd instead, since
3971da177e4SLinus Torvalds  * long blocking there is the exception, not the rule.  accordingly, HCDs
3981da177e4SLinus Torvalds  * talking to TTs must queue control transfers (not just bulk and iso), so
3991da177e4SLinus Torvalds  * both can talk to the same hub concurrently.
4001da177e4SLinus Torvalds  */
401c4028958SDavid Howells static void hub_tt_kevent (struct work_struct *work)
4021da177e4SLinus Torvalds {
403c4028958SDavid Howells 	struct usb_hub		*hub =
404c4028958SDavid Howells 		container_of(work, struct usb_hub, tt.kevent);
4051da177e4SLinus Torvalds 	unsigned long		flags;
40655e5fdfaSMark Lord 	int			limit = 100;
4071da177e4SLinus Torvalds 
4081da177e4SLinus Torvalds 	spin_lock_irqsave (&hub->tt.lock, flags);
40955e5fdfaSMark Lord 	while (--limit && !list_empty (&hub->tt.clear_list)) {
4101da177e4SLinus Torvalds 		struct list_head	*temp;
4111da177e4SLinus Torvalds 		struct usb_tt_clear	*clear;
4121da177e4SLinus Torvalds 		struct usb_device	*hdev = hub->hdev;
4131da177e4SLinus Torvalds 		int			status;
4141da177e4SLinus Torvalds 
4151da177e4SLinus Torvalds 		temp = hub->tt.clear_list.next;
4161da177e4SLinus Torvalds 		clear = list_entry (temp, struct usb_tt_clear, clear_list);
4171da177e4SLinus Torvalds 		list_del (&clear->clear_list);
4181da177e4SLinus Torvalds 
4191da177e4SLinus Torvalds 		/* drop lock so HCD can concurrently report other TT errors */
4201da177e4SLinus Torvalds 		spin_unlock_irqrestore (&hub->tt.lock, flags);
4211da177e4SLinus Torvalds 		status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
4221da177e4SLinus Torvalds 		spin_lock_irqsave (&hub->tt.lock, flags);
4231da177e4SLinus Torvalds 
4241da177e4SLinus Torvalds 		if (status)
4251da177e4SLinus Torvalds 			dev_err (&hdev->dev,
4261da177e4SLinus Torvalds 				"clear tt %d (%04x) error %d\n",
4271da177e4SLinus Torvalds 				clear->tt, clear->devinfo, status);
4281da177e4SLinus Torvalds 		kfree(clear);
4291da177e4SLinus Torvalds 	}
4301da177e4SLinus Torvalds 	spin_unlock_irqrestore (&hub->tt.lock, flags);
4311da177e4SLinus Torvalds }
4321da177e4SLinus Torvalds 
4331da177e4SLinus Torvalds /**
4341da177e4SLinus Torvalds  * usb_hub_tt_clear_buffer - clear control/bulk TT state in high speed hub
4351da177e4SLinus Torvalds  * @udev: the device whose split transaction failed
4361da177e4SLinus Torvalds  * @pipe: identifies the endpoint of the failed transaction
4371da177e4SLinus Torvalds  *
4381da177e4SLinus Torvalds  * High speed HCDs use this to tell the hub driver that some split control or
4391da177e4SLinus Torvalds  * bulk transaction failed in a way that requires clearing internal state of
4401da177e4SLinus Torvalds  * a transaction translator.  This is normally detected (and reported) from
4411da177e4SLinus Torvalds  * interrupt context.
4421da177e4SLinus Torvalds  *
4431da177e4SLinus Torvalds  * It may not be possible for that hub to handle additional full (or low)
4441da177e4SLinus Torvalds  * speed transactions until that state is fully cleared out.
4451da177e4SLinus Torvalds  */
4461da177e4SLinus Torvalds void usb_hub_tt_clear_buffer (struct usb_device *udev, int pipe)
4471da177e4SLinus Torvalds {
4481da177e4SLinus Torvalds 	struct usb_tt		*tt = udev->tt;
4491da177e4SLinus Torvalds 	unsigned long		flags;
4501da177e4SLinus Torvalds 	struct usb_tt_clear	*clear;
4511da177e4SLinus Torvalds 
4521da177e4SLinus Torvalds 	/* we've got to cope with an arbitrary number of pending TT clears,
4531da177e4SLinus Torvalds 	 * since each TT has "at least two" buffers that can need it (and
4541da177e4SLinus Torvalds 	 * there can be many TTs per hub).  even if they're uncommon.
4551da177e4SLinus Torvalds 	 */
45654e6ecb2SChristoph Lameter 	if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
4571da177e4SLinus Torvalds 		dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
4581da177e4SLinus Torvalds 		/* FIXME recover somehow ... RESET_TT? */
4591da177e4SLinus Torvalds 		return;
4601da177e4SLinus Torvalds 	}
4611da177e4SLinus Torvalds 
4621da177e4SLinus Torvalds 	/* info that CLEAR_TT_BUFFER needs */
4631da177e4SLinus Torvalds 	clear->tt = tt->multi ? udev->ttport : 1;
4641da177e4SLinus Torvalds 	clear->devinfo = usb_pipeendpoint (pipe);
4651da177e4SLinus Torvalds 	clear->devinfo |= udev->devnum << 4;
4661da177e4SLinus Torvalds 	clear->devinfo |= usb_pipecontrol (pipe)
4671da177e4SLinus Torvalds 			? (USB_ENDPOINT_XFER_CONTROL << 11)
4681da177e4SLinus Torvalds 			: (USB_ENDPOINT_XFER_BULK << 11);
4691da177e4SLinus Torvalds 	if (usb_pipein (pipe))
4701da177e4SLinus Torvalds 		clear->devinfo |= 1 << 15;
4711da177e4SLinus Torvalds 
4721da177e4SLinus Torvalds 	/* tell keventd to clear state for this TT */
4731da177e4SLinus Torvalds 	spin_lock_irqsave (&tt->lock, flags);
4741da177e4SLinus Torvalds 	list_add_tail (&clear->clear_list, &tt->clear_list);
4751da177e4SLinus Torvalds 	schedule_work (&tt->kevent);
4761da177e4SLinus Torvalds 	spin_unlock_irqrestore (&tt->lock, flags);
4771da177e4SLinus Torvalds }
4781da177e4SLinus Torvalds 
4791da177e4SLinus Torvalds static void hub_power_on(struct usb_hub *hub)
4801da177e4SLinus Torvalds {
4811da177e4SLinus Torvalds 	int port1;
482b789696aSDavid Brownell 	unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
4834489a571SAlan Stern 	u16 wHubCharacteristics =
4844489a571SAlan Stern 			le16_to_cpu(hub->descriptor->wHubCharacteristics);
4851da177e4SLinus Torvalds 
4864489a571SAlan Stern 	/* Enable power on each port.  Some hubs have reserved values
4874489a571SAlan Stern 	 * of LPSM (> 2) in their descriptors, even though they are
4884489a571SAlan Stern 	 * USB 2.0 hubs.  Some hubs do not implement port-power switching
4894489a571SAlan Stern 	 * but only emulate it.  In all cases, the ports won't work
4904489a571SAlan Stern 	 * unless we send these messages to the hub.
4914489a571SAlan Stern 	 */
4924489a571SAlan Stern 	if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
4931da177e4SLinus Torvalds 		dev_dbg(hub->intfdev, "enabling power on all ports\n");
4944489a571SAlan Stern 	else
4954489a571SAlan Stern 		dev_dbg(hub->intfdev, "trying to enable port power on "
4964489a571SAlan Stern 				"non-switchable hub\n");
4971da177e4SLinus Torvalds 	for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
4984489a571SAlan Stern 		set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
4991da177e4SLinus Torvalds 
500b789696aSDavid Brownell 	/* Wait at least 100 msec for power to become stable */
501b789696aSDavid Brownell 	msleep(max(pgood_delay, (unsigned) 100));
5021da177e4SLinus Torvalds }
5031da177e4SLinus Torvalds 
50402c399eeSAlan Stern static void hub_quiesce(struct usb_hub *hub)
5051da177e4SLinus Torvalds {
506979d5199SDavid Brownell 	/* (nonblocking) khubd and related activity won't re-trigger */
5071da177e4SLinus Torvalds 	hub->quiescing = 1;
508c9f89fa4SDavid Brownell 	hub->activating = 0;
509979d5199SDavid Brownell 
510979d5199SDavid Brownell 	/* (blocking) stop khubd and related activity */
5111da177e4SLinus Torvalds 	usb_kill_urb(hub->urb);
5121da177e4SLinus Torvalds 	if (hub->has_indicators)
5131da177e4SLinus Torvalds 		cancel_delayed_work(&hub->leds);
5141da177e4SLinus Torvalds 	if (hub->has_indicators || hub->tt.hub)
5151da177e4SLinus Torvalds 		flush_scheduled_work();
5161da177e4SLinus Torvalds }
5171da177e4SLinus Torvalds 
5181da177e4SLinus Torvalds static void hub_activate(struct usb_hub *hub)
5191da177e4SLinus Torvalds {
5201da177e4SLinus Torvalds 	int	status;
5211da177e4SLinus Torvalds 
5221da177e4SLinus Torvalds 	hub->quiescing = 0;
5231da177e4SLinus Torvalds 	hub->activating = 1;
52440f122f3SAlan Stern 
5251da177e4SLinus Torvalds 	status = usb_submit_urb(hub->urb, GFP_NOIO);
5261da177e4SLinus Torvalds 	if (status < 0)
5271da177e4SLinus Torvalds 		dev_err(hub->intfdev, "activate --> %d\n", status);
5281da177e4SLinus Torvalds 	if (hub->has_indicators && blinkenlights)
5291da177e4SLinus Torvalds 		schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
5301da177e4SLinus Torvalds 
5311da177e4SLinus Torvalds 	/* scan all ports ASAP */
5321da177e4SLinus Torvalds 	kick_khubd(hub);
5331da177e4SLinus Torvalds }
5341da177e4SLinus Torvalds 
5351da177e4SLinus Torvalds static int hub_hub_status(struct usb_hub *hub,
5361da177e4SLinus Torvalds 		u16 *status, u16 *change)
5371da177e4SLinus Torvalds {
5381da177e4SLinus Torvalds 	int ret;
5391da177e4SLinus Torvalds 
540db90e7a1SAlan Stern 	mutex_lock(&hub->status_mutex);
5411da177e4SLinus Torvalds 	ret = get_hub_status(hub->hdev, &hub->status->hub);
5421da177e4SLinus Torvalds 	if (ret < 0)
5431da177e4SLinus Torvalds 		dev_err (hub->intfdev,
5441da177e4SLinus Torvalds 			"%s failed (err = %d)\n", __FUNCTION__, ret);
5451da177e4SLinus Torvalds 	else {
5461da177e4SLinus Torvalds 		*status = le16_to_cpu(hub->status->hub.wHubStatus);
5471da177e4SLinus Torvalds 		*change = le16_to_cpu(hub->status->hub.wHubChange);
5481da177e4SLinus Torvalds 		ret = 0;
5491da177e4SLinus Torvalds 	}
550db90e7a1SAlan Stern 	mutex_unlock(&hub->status_mutex);
5511da177e4SLinus Torvalds 	return ret;
5521da177e4SLinus Torvalds }
5531da177e4SLinus Torvalds 
5548b28c752SAlan Stern static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
5558b28c752SAlan Stern {
5568b28c752SAlan Stern 	struct usb_device *hdev = hub->hdev;
5570458d5b4SAlan Stern 	int ret = 0;
5588b28c752SAlan Stern 
5590458d5b4SAlan Stern 	if (hdev->children[port1-1] && set_state)
5608b28c752SAlan Stern 		usb_set_device_state(hdev->children[port1-1],
5618b28c752SAlan Stern 				USB_STATE_NOTATTACHED);
5620458d5b4SAlan Stern 	if (!hub->error)
5638b28c752SAlan Stern 		ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
5648b28c752SAlan Stern 	if (ret)
5658b28c752SAlan Stern 		dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
5668b28c752SAlan Stern 				port1, ret);
5678b28c752SAlan Stern 	return ret;
5688b28c752SAlan Stern }
5698b28c752SAlan Stern 
5700458d5b4SAlan Stern /*
5710458d5b4SAlan Stern  * Disable a port and mark a logical connnect-change event, so that some
5720458d5b4SAlan Stern  * time later khubd will disconnect() any existing usb_device on the port
5730458d5b4SAlan Stern  * and will re-enumerate if there actually is a device attached.
5740458d5b4SAlan Stern  */
5750458d5b4SAlan Stern static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
5767d069b7dSAlan Stern {
5770458d5b4SAlan Stern 	dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
5780458d5b4SAlan Stern 	hub_port_disable(hub, port1, 1);
5790458d5b4SAlan Stern 
5800458d5b4SAlan Stern 	/* FIXME let caller ask to power down the port:
5810458d5b4SAlan Stern 	 *  - some devices won't enumerate without a VBUS power cycle
5820458d5b4SAlan Stern 	 *  - SRP saves power that way
5830458d5b4SAlan Stern 	 *  - ... new call, TBD ...
5840458d5b4SAlan Stern 	 * That's easy if this hub can switch power per-port, and
5850458d5b4SAlan Stern 	 * khubd reactivates the port later (timer, SRP, etc).
5860458d5b4SAlan Stern 	 * Powerdown must be optional, because of reset/DFU.
5870458d5b4SAlan Stern 	 */
5880458d5b4SAlan Stern 
5890458d5b4SAlan Stern 	set_bit(port1, hub->change_bits);
5900458d5b4SAlan Stern  	kick_khubd(hub);
5910458d5b4SAlan Stern }
5920458d5b4SAlan Stern 
5930458d5b4SAlan Stern static void disconnect_all_children(struct usb_hub *hub, int logical)
5940458d5b4SAlan Stern {
5957d069b7dSAlan Stern 	struct usb_device *hdev = hub->hdev;
5967d069b7dSAlan Stern 	int port1;
5977d069b7dSAlan Stern 
5987d069b7dSAlan Stern 	for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
5997d069b7dSAlan Stern 		if (hdev->children[port1-1]) {
6000458d5b4SAlan Stern 			if (logical)
6010458d5b4SAlan Stern 				hub_port_logical_disconnect(hub, port1);
6020458d5b4SAlan Stern 			else
6037d069b7dSAlan Stern 				usb_disconnect(&hdev->children[port1-1]);
6047d069b7dSAlan Stern 		}
6057d069b7dSAlan Stern 	}
6060458d5b4SAlan Stern }
6070458d5b4SAlan Stern 
6080458d5b4SAlan Stern #ifdef	CONFIG_USB_PERSIST
6090458d5b4SAlan Stern 
6100458d5b4SAlan Stern #define USB_PERSIST	1
6110458d5b4SAlan Stern 
6120458d5b4SAlan Stern /* For "persistent-device" resets we must mark the child devices for reset
6130458d5b4SAlan Stern  * and turn off a possible connect-change status (so khubd won't disconnect
6140458d5b4SAlan Stern  * them later).
6150458d5b4SAlan Stern  */
6160458d5b4SAlan Stern static void mark_children_for_reset_resume(struct usb_hub *hub)
6170458d5b4SAlan Stern {
6180458d5b4SAlan Stern 	struct usb_device *hdev = hub->hdev;
6190458d5b4SAlan Stern 	int port1;
6200458d5b4SAlan Stern 
6210458d5b4SAlan Stern 	for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
6220458d5b4SAlan Stern 		struct usb_device *child = hdev->children[port1-1];
6230458d5b4SAlan Stern 
6240458d5b4SAlan Stern 		if (child) {
6250458d5b4SAlan Stern 			child->reset_resume = 1;
6260458d5b4SAlan Stern 			clear_port_feature(hdev, port1,
6270458d5b4SAlan Stern 					USB_PORT_FEAT_C_CONNECTION);
6280458d5b4SAlan Stern 		}
6290458d5b4SAlan Stern 	}
6300458d5b4SAlan Stern }
6310458d5b4SAlan Stern 
6320458d5b4SAlan Stern #else
6330458d5b4SAlan Stern 
6340458d5b4SAlan Stern #define USB_PERSIST	0
6350458d5b4SAlan Stern 
6360458d5b4SAlan Stern static inline void mark_children_for_reset_resume(struct usb_hub *hub)
6370458d5b4SAlan Stern { }
6380458d5b4SAlan Stern 
6390458d5b4SAlan Stern #endif	/* CONFIG_USB_PERSIST */
6400458d5b4SAlan Stern 
6410458d5b4SAlan Stern /* caller has locked the hub device */
6420458d5b4SAlan Stern static void hub_pre_reset(struct usb_interface *intf)
6430458d5b4SAlan Stern {
6440458d5b4SAlan Stern 	struct usb_hub *hub = usb_get_intfdata(intf);
6450458d5b4SAlan Stern 
6460458d5b4SAlan Stern 	/* This routine doesn't run as part of a reset-resume, so it's safe
6470458d5b4SAlan Stern 	 * to disconnect all the drivers below the hub.
6480458d5b4SAlan Stern 	 */
6490458d5b4SAlan Stern 	disconnect_all_children(hub, 0);
6507d069b7dSAlan Stern 	hub_quiesce(hub);
6517d069b7dSAlan Stern }
6527d069b7dSAlan Stern 
6537d069b7dSAlan Stern /* caller has locked the hub device */
6540458d5b4SAlan Stern static void hub_post_reset(struct usb_interface *intf, int reset_resume)
6557d069b7dSAlan Stern {
6567de18d8bSAlan Stern 	struct usb_hub *hub = usb_get_intfdata(intf);
6577de18d8bSAlan Stern 
6587d069b7dSAlan Stern 	hub_power_on(hub);
6590458d5b4SAlan Stern 	if (reset_resume) {
6600458d5b4SAlan Stern 		if (USB_PERSIST)
6610458d5b4SAlan Stern 			mark_children_for_reset_resume(hub);
6620458d5b4SAlan Stern 		else {
6630458d5b4SAlan Stern 			/* Reset-resume doesn't call pre_reset, so we have to
6640458d5b4SAlan Stern 			 * disconnect the children here.  But we may not lock
6650458d5b4SAlan Stern 			 * the child devices, so we have to do a "logical"
6660458d5b4SAlan Stern 			 * disconnect.
6670458d5b4SAlan Stern 			 */
6680458d5b4SAlan Stern 			disconnect_all_children(hub, 1);
6690458d5b4SAlan Stern 		}
6700458d5b4SAlan Stern 	}
6710458d5b4SAlan Stern 	hub_activate(hub);
6727d069b7dSAlan Stern }
6737d069b7dSAlan Stern 
6747d069b7dSAlan Stern 
6751da177e4SLinus Torvalds static int hub_configure(struct usb_hub *hub,
6761da177e4SLinus Torvalds 	struct usb_endpoint_descriptor *endpoint)
6771da177e4SLinus Torvalds {
6781da177e4SLinus Torvalds 	struct usb_device *hdev = hub->hdev;
6791da177e4SLinus Torvalds 	struct device *hub_dev = hub->intfdev;
6801da177e4SLinus Torvalds 	u16 hubstatus, hubchange;
68174ad9bd2SGreg Kroah-Hartman 	u16 wHubCharacteristics;
6821da177e4SLinus Torvalds 	unsigned int pipe;
6831da177e4SLinus Torvalds 	int maxp, ret;
6841da177e4SLinus Torvalds 	char *message;
6851da177e4SLinus Torvalds 
6861da177e4SLinus Torvalds 	hub->buffer = usb_buffer_alloc(hdev, sizeof(*hub->buffer), GFP_KERNEL,
6871da177e4SLinus Torvalds 			&hub->buffer_dma);
6881da177e4SLinus Torvalds 	if (!hub->buffer) {
6891da177e4SLinus Torvalds 		message = "can't allocate hub irq buffer";
6901da177e4SLinus Torvalds 		ret = -ENOMEM;
6911da177e4SLinus Torvalds 		goto fail;
6921da177e4SLinus Torvalds 	}
6931da177e4SLinus Torvalds 
6941da177e4SLinus Torvalds 	hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
6951da177e4SLinus Torvalds 	if (!hub->status) {
6961da177e4SLinus Torvalds 		message = "can't kmalloc hub status buffer";
6971da177e4SLinus Torvalds 		ret = -ENOMEM;
6981da177e4SLinus Torvalds 		goto fail;
6991da177e4SLinus Torvalds 	}
700db90e7a1SAlan Stern 	mutex_init(&hub->status_mutex);
7011da177e4SLinus Torvalds 
7021da177e4SLinus Torvalds 	hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
7031da177e4SLinus Torvalds 	if (!hub->descriptor) {
7041da177e4SLinus Torvalds 		message = "can't kmalloc hub descriptor";
7051da177e4SLinus Torvalds 		ret = -ENOMEM;
7061da177e4SLinus Torvalds 		goto fail;
7071da177e4SLinus Torvalds 	}
7081da177e4SLinus Torvalds 
7091da177e4SLinus Torvalds 	/* Request the entire hub descriptor.
7101da177e4SLinus Torvalds 	 * hub->descriptor can handle USB_MAXCHILDREN ports,
7111da177e4SLinus Torvalds 	 * but the hub can/will return fewer bytes here.
7121da177e4SLinus Torvalds 	 */
7131da177e4SLinus Torvalds 	ret = get_hub_descriptor(hdev, hub->descriptor,
7141da177e4SLinus Torvalds 			sizeof(*hub->descriptor));
7151da177e4SLinus Torvalds 	if (ret < 0) {
7161da177e4SLinus Torvalds 		message = "can't read hub descriptor";
7171da177e4SLinus Torvalds 		goto fail;
7181da177e4SLinus Torvalds 	} else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
7191da177e4SLinus Torvalds 		message = "hub has too many ports!";
7201da177e4SLinus Torvalds 		ret = -ENODEV;
7211da177e4SLinus Torvalds 		goto fail;
7221da177e4SLinus Torvalds 	}
7231da177e4SLinus Torvalds 
7241da177e4SLinus Torvalds 	hdev->maxchild = hub->descriptor->bNbrPorts;
7251da177e4SLinus Torvalds 	dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
7261da177e4SLinus Torvalds 		(hdev->maxchild == 1) ? "" : "s");
7271da177e4SLinus Torvalds 
72874ad9bd2SGreg Kroah-Hartman 	wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
7291da177e4SLinus Torvalds 
73074ad9bd2SGreg Kroah-Hartman 	if (wHubCharacteristics & HUB_CHAR_COMPOUND) {
7311da177e4SLinus Torvalds 		int	i;
7321da177e4SLinus Torvalds 		char	portstr [USB_MAXCHILDREN + 1];
7331da177e4SLinus Torvalds 
7341da177e4SLinus Torvalds 		for (i = 0; i < hdev->maxchild; i++)
7351da177e4SLinus Torvalds 			portstr[i] = hub->descriptor->DeviceRemovable
7361da177e4SLinus Torvalds 				    [((i + 1) / 8)] & (1 << ((i + 1) % 8))
7371da177e4SLinus Torvalds 				? 'F' : 'R';
7381da177e4SLinus Torvalds 		portstr[hdev->maxchild] = 0;
7391da177e4SLinus Torvalds 		dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
7401da177e4SLinus Torvalds 	} else
7411da177e4SLinus Torvalds 		dev_dbg(hub_dev, "standalone hub\n");
7421da177e4SLinus Torvalds 
74374ad9bd2SGreg Kroah-Hartman 	switch (wHubCharacteristics & HUB_CHAR_LPSM) {
7441da177e4SLinus Torvalds 		case 0x00:
7451da177e4SLinus Torvalds 			dev_dbg(hub_dev, "ganged power switching\n");
7461da177e4SLinus Torvalds 			break;
7471da177e4SLinus Torvalds 		case 0x01:
7481da177e4SLinus Torvalds 			dev_dbg(hub_dev, "individual port power switching\n");
7491da177e4SLinus Torvalds 			break;
7501da177e4SLinus Torvalds 		case 0x02:
7511da177e4SLinus Torvalds 		case 0x03:
7521da177e4SLinus Torvalds 			dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
7531da177e4SLinus Torvalds 			break;
7541da177e4SLinus Torvalds 	}
7551da177e4SLinus Torvalds 
75674ad9bd2SGreg Kroah-Hartman 	switch (wHubCharacteristics & HUB_CHAR_OCPM) {
7571da177e4SLinus Torvalds 		case 0x00:
7581da177e4SLinus Torvalds 			dev_dbg(hub_dev, "global over-current protection\n");
7591da177e4SLinus Torvalds 			break;
7601da177e4SLinus Torvalds 		case 0x08:
7611da177e4SLinus Torvalds 			dev_dbg(hub_dev, "individual port over-current protection\n");
7621da177e4SLinus Torvalds 			break;
7631da177e4SLinus Torvalds 		case 0x10:
7641da177e4SLinus Torvalds 		case 0x18:
7651da177e4SLinus Torvalds 			dev_dbg(hub_dev, "no over-current protection\n");
7661da177e4SLinus Torvalds                         break;
7671da177e4SLinus Torvalds 	}
7681da177e4SLinus Torvalds 
7691da177e4SLinus Torvalds 	spin_lock_init (&hub->tt.lock);
7701da177e4SLinus Torvalds 	INIT_LIST_HEAD (&hub->tt.clear_list);
771c4028958SDavid Howells 	INIT_WORK (&hub->tt.kevent, hub_tt_kevent);
7721da177e4SLinus Torvalds 	switch (hdev->descriptor.bDeviceProtocol) {
7731da177e4SLinus Torvalds 		case 0:
7741da177e4SLinus Torvalds 			break;
7751da177e4SLinus Torvalds 		case 1:
7761da177e4SLinus Torvalds 			dev_dbg(hub_dev, "Single TT\n");
7771da177e4SLinus Torvalds 			hub->tt.hub = hdev;
7781da177e4SLinus Torvalds 			break;
7791da177e4SLinus Torvalds 		case 2:
7801da177e4SLinus Torvalds 			ret = usb_set_interface(hdev, 0, 1);
7811da177e4SLinus Torvalds 			if (ret == 0) {
7821da177e4SLinus Torvalds 				dev_dbg(hub_dev, "TT per port\n");
7831da177e4SLinus Torvalds 				hub->tt.multi = 1;
7841da177e4SLinus Torvalds 			} else
7851da177e4SLinus Torvalds 				dev_err(hub_dev, "Using single TT (err %d)\n",
7861da177e4SLinus Torvalds 					ret);
7871da177e4SLinus Torvalds 			hub->tt.hub = hdev;
7881da177e4SLinus Torvalds 			break;
7891da177e4SLinus Torvalds 		default:
7901da177e4SLinus Torvalds 			dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
7911da177e4SLinus Torvalds 				hdev->descriptor.bDeviceProtocol);
7921da177e4SLinus Torvalds 			break;
7931da177e4SLinus Torvalds 	}
7941da177e4SLinus Torvalds 
795e09711aeSdavid-b@pacbell.net 	/* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
79674ad9bd2SGreg Kroah-Hartman 	switch (wHubCharacteristics & HUB_CHAR_TTTT) {
797e09711aeSdavid-b@pacbell.net 		case HUB_TTTT_8_BITS:
798e09711aeSdavid-b@pacbell.net 			if (hdev->descriptor.bDeviceProtocol != 0) {
799e09711aeSdavid-b@pacbell.net 				hub->tt.think_time = 666;
800e09711aeSdavid-b@pacbell.net 				dev_dbg(hub_dev, "TT requires at most %d "
801e09711aeSdavid-b@pacbell.net 						"FS bit times (%d ns)\n",
802e09711aeSdavid-b@pacbell.net 					8, hub->tt.think_time);
803e09711aeSdavid-b@pacbell.net 			}
8041da177e4SLinus Torvalds 			break;
805e09711aeSdavid-b@pacbell.net 		case HUB_TTTT_16_BITS:
806e09711aeSdavid-b@pacbell.net 			hub->tt.think_time = 666 * 2;
807e09711aeSdavid-b@pacbell.net 			dev_dbg(hub_dev, "TT requires at most %d "
808e09711aeSdavid-b@pacbell.net 					"FS bit times (%d ns)\n",
809e09711aeSdavid-b@pacbell.net 				16, hub->tt.think_time);
8101da177e4SLinus Torvalds 			break;
811e09711aeSdavid-b@pacbell.net 		case HUB_TTTT_24_BITS:
812e09711aeSdavid-b@pacbell.net 			hub->tt.think_time = 666 * 3;
813e09711aeSdavid-b@pacbell.net 			dev_dbg(hub_dev, "TT requires at most %d "
814e09711aeSdavid-b@pacbell.net 					"FS bit times (%d ns)\n",
815e09711aeSdavid-b@pacbell.net 				24, hub->tt.think_time);
8161da177e4SLinus Torvalds 			break;
817e09711aeSdavid-b@pacbell.net 		case HUB_TTTT_32_BITS:
818e09711aeSdavid-b@pacbell.net 			hub->tt.think_time = 666 * 4;
819e09711aeSdavid-b@pacbell.net 			dev_dbg(hub_dev, "TT requires at most %d "
820e09711aeSdavid-b@pacbell.net 					"FS bit times (%d ns)\n",
821e09711aeSdavid-b@pacbell.net 				32, hub->tt.think_time);
8221da177e4SLinus Torvalds 			break;
8231da177e4SLinus Torvalds 	}
8241da177e4SLinus Torvalds 
8251da177e4SLinus Torvalds 	/* probe() zeroes hub->indicator[] */
82674ad9bd2SGreg Kroah-Hartman 	if (wHubCharacteristics & HUB_CHAR_PORTIND) {
8271da177e4SLinus Torvalds 		hub->has_indicators = 1;
8281da177e4SLinus Torvalds 		dev_dbg(hub_dev, "Port indicators are supported\n");
8291da177e4SLinus Torvalds 	}
8301da177e4SLinus Torvalds 
8311da177e4SLinus Torvalds 	dev_dbg(hub_dev, "power on to power good time: %dms\n",
8321da177e4SLinus Torvalds 		hub->descriptor->bPwrOn2PwrGood * 2);
8331da177e4SLinus Torvalds 
8341da177e4SLinus Torvalds 	/* power budgeting mostly matters with bus-powered hubs,
8351da177e4SLinus Torvalds 	 * and battery-powered root hubs (may provide just 8 mA).
8361da177e4SLinus Torvalds 	 */
8371da177e4SLinus Torvalds 	ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
83855c52718SAlan Stern 	if (ret < 2) {
8391da177e4SLinus Torvalds 		message = "can't get hub status";
8401da177e4SLinus Torvalds 		goto fail;
8411da177e4SLinus Torvalds 	}
8427d35b929SAlan Stern 	le16_to_cpus(&hubstatus);
8437d35b929SAlan Stern 	if (hdev == hdev->bus->root_hub) {
84455c52718SAlan Stern 		if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
84555c52718SAlan Stern 			hub->mA_per_port = 500;
84655c52718SAlan Stern 		else {
84755c52718SAlan Stern 			hub->mA_per_port = hdev->bus_mA;
84855c52718SAlan Stern 			hub->limited_power = 1;
84955c52718SAlan Stern 		}
8507d35b929SAlan Stern 	} else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
8511da177e4SLinus Torvalds 		dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
8521da177e4SLinus Torvalds 			hub->descriptor->bHubContrCurrent);
85355c52718SAlan Stern 		hub->limited_power = 1;
85455c52718SAlan Stern 		if (hdev->maxchild > 0) {
85555c52718SAlan Stern 			int remaining = hdev->bus_mA -
85655c52718SAlan Stern 					hub->descriptor->bHubContrCurrent;
8571da177e4SLinus Torvalds 
85855c52718SAlan Stern 			if (remaining < hdev->maxchild * 100)
85955c52718SAlan Stern 				dev_warn(hub_dev,
86055c52718SAlan Stern 					"insufficient power available "
86155c52718SAlan Stern 					"to use all downstream ports\n");
86255c52718SAlan Stern 			hub->mA_per_port = 100;		/* 7.2.1.1 */
86355c52718SAlan Stern 		}
86455c52718SAlan Stern 	} else {	/* Self-powered external hub */
86555c52718SAlan Stern 		/* FIXME: What about battery-powered external hubs that
86655c52718SAlan Stern 		 * provide less current per port? */
86755c52718SAlan Stern 		hub->mA_per_port = 500;
86855c52718SAlan Stern 	}
86955c52718SAlan Stern 	if (hub->mA_per_port < 500)
87055c52718SAlan Stern 		dev_dbg(hub_dev, "%umA bus power budget for each child\n",
87155c52718SAlan Stern 				hub->mA_per_port);
8721da177e4SLinus Torvalds 
8731da177e4SLinus Torvalds 	ret = hub_hub_status(hub, &hubstatus, &hubchange);
8741da177e4SLinus Torvalds 	if (ret < 0) {
8751da177e4SLinus Torvalds 		message = "can't get hub status";
8761da177e4SLinus Torvalds 		goto fail;
8771da177e4SLinus Torvalds 	}
8781da177e4SLinus Torvalds 
8791da177e4SLinus Torvalds 	/* local power status reports aren't always correct */
8801da177e4SLinus Torvalds 	if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
8811da177e4SLinus Torvalds 		dev_dbg(hub_dev, "local power source is %s\n",
8821da177e4SLinus Torvalds 			(hubstatus & HUB_STATUS_LOCAL_POWER)
8831da177e4SLinus Torvalds 			? "lost (inactive)" : "good");
8841da177e4SLinus Torvalds 
88574ad9bd2SGreg Kroah-Hartman 	if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
8861da177e4SLinus Torvalds 		dev_dbg(hub_dev, "%sover-current condition exists\n",
8871da177e4SLinus Torvalds 			(hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
8881da177e4SLinus Torvalds 
88988fafff9Sinaky@linux.intel.com 	/* set up the interrupt endpoint
89088fafff9Sinaky@linux.intel.com 	 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
89188fafff9Sinaky@linux.intel.com 	 * bytes as USB2.0[11.12.3] says because some hubs are known
89288fafff9Sinaky@linux.intel.com 	 * to send more data (and thus cause overflow). For root hubs,
89388fafff9Sinaky@linux.intel.com 	 * maxpktsize is defined in hcd.c's fake endpoint descriptors
89488fafff9Sinaky@linux.intel.com 	 * to be big enough for at least USB_MAXCHILDREN ports. */
8951da177e4SLinus Torvalds 	pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
8961da177e4SLinus Torvalds 	maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
8971da177e4SLinus Torvalds 
8981da177e4SLinus Torvalds 	if (maxp > sizeof(*hub->buffer))
8991da177e4SLinus Torvalds 		maxp = sizeof(*hub->buffer);
9001da177e4SLinus Torvalds 
9011da177e4SLinus Torvalds 	hub->urb = usb_alloc_urb(0, GFP_KERNEL);
9021da177e4SLinus Torvalds 	if (!hub->urb) {
9031da177e4SLinus Torvalds 		message = "couldn't allocate interrupt urb";
9041da177e4SLinus Torvalds 		ret = -ENOMEM;
9051da177e4SLinus Torvalds 		goto fail;
9061da177e4SLinus Torvalds 	}
9071da177e4SLinus Torvalds 
9081da177e4SLinus Torvalds 	usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
9091da177e4SLinus Torvalds 		hub, endpoint->bInterval);
9101da177e4SLinus Torvalds 	hub->urb->transfer_dma = hub->buffer_dma;
9111da177e4SLinus Torvalds 	hub->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
9121da177e4SLinus Torvalds 
9131da177e4SLinus Torvalds 	/* maybe cycle the hub leds */
9141da177e4SLinus Torvalds 	if (hub->has_indicators && blinkenlights)
9151da177e4SLinus Torvalds 		hub->indicator [0] = INDICATOR_CYCLE;
9161da177e4SLinus Torvalds 
9171da177e4SLinus Torvalds 	hub_power_on(hub);
9181da177e4SLinus Torvalds 	hub_activate(hub);
9191da177e4SLinus Torvalds 	return 0;
9201da177e4SLinus Torvalds 
9211da177e4SLinus Torvalds fail:
9221da177e4SLinus Torvalds 	dev_err (hub_dev, "config failed, %s (err %d)\n",
9231da177e4SLinus Torvalds 			message, ret);
9241da177e4SLinus Torvalds 	/* hub_disconnect() frees urb and descriptor */
9251da177e4SLinus Torvalds 	return ret;
9261da177e4SLinus Torvalds }
9271da177e4SLinus Torvalds 
928e8054854SAlan Stern static void hub_release(struct kref *kref)
929e8054854SAlan Stern {
930e8054854SAlan Stern 	struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
931e8054854SAlan Stern 
932e8054854SAlan Stern 	usb_put_intf(to_usb_interface(hub->intfdev));
933e8054854SAlan Stern 	kfree(hub);
934e8054854SAlan Stern }
935e8054854SAlan Stern 
9361da177e4SLinus Torvalds static unsigned highspeed_hubs;
9371da177e4SLinus Torvalds 
9381da177e4SLinus Torvalds static void hub_disconnect(struct usb_interface *intf)
9391da177e4SLinus Torvalds {
9401da177e4SLinus Torvalds 	struct usb_hub *hub = usb_get_intfdata (intf);
941e8054854SAlan Stern 
942e8054854SAlan Stern 	/* Take the hub off the event list and don't let it be added again */
943e8054854SAlan Stern 	spin_lock_irq(&hub_event_lock);
944e8054854SAlan Stern 	list_del_init(&hub->event_list);
945e8054854SAlan Stern 	hub->disconnected = 1;
946e8054854SAlan Stern 	spin_unlock_irq(&hub_event_lock);
9471da177e4SLinus Torvalds 
9487de18d8bSAlan Stern 	/* Disconnect all children and quiesce the hub */
9497de18d8bSAlan Stern 	hub->error = 0;
9507de18d8bSAlan Stern 	hub_pre_reset(intf);
9517de18d8bSAlan Stern 
9528b28c752SAlan Stern 	usb_set_intfdata (intf, NULL);
9531da177e4SLinus Torvalds 
954e8054854SAlan Stern 	if (hub->hdev->speed == USB_SPEED_HIGH)
9551da177e4SLinus Torvalds 		highspeed_hubs--;
9561da177e4SLinus Torvalds 
9571da177e4SLinus Torvalds 	usb_free_urb(hub->urb);
9581da177e4SLinus Torvalds 	kfree(hub->descriptor);
9591da177e4SLinus Torvalds 	kfree(hub->status);
960e8054854SAlan Stern 	usb_buffer_free(hub->hdev, sizeof(*hub->buffer), hub->buffer,
9611da177e4SLinus Torvalds 			hub->buffer_dma);
9621da177e4SLinus Torvalds 
963e8054854SAlan Stern 	kref_put(&hub->kref, hub_release);
9641da177e4SLinus Torvalds }
9651da177e4SLinus Torvalds 
9661da177e4SLinus Torvalds static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
9671da177e4SLinus Torvalds {
9681da177e4SLinus Torvalds 	struct usb_host_interface *desc;
9691da177e4SLinus Torvalds 	struct usb_endpoint_descriptor *endpoint;
9701da177e4SLinus Torvalds 	struct usb_device *hdev;
9711da177e4SLinus Torvalds 	struct usb_hub *hub;
9721da177e4SLinus Torvalds 
9731da177e4SLinus Torvalds 	desc = intf->cur_altsetting;
9741da177e4SLinus Torvalds 	hdev = interface_to_usbdev(intf);
9751da177e4SLinus Torvalds 
97689ccbdc9SDavid Brownell #ifdef	CONFIG_USB_OTG_BLACKLIST_HUB
97789ccbdc9SDavid Brownell 	if (hdev->parent) {
97889ccbdc9SDavid Brownell 		dev_warn(&intf->dev, "ignoring external hub\n");
97989ccbdc9SDavid Brownell 		return -ENODEV;
98089ccbdc9SDavid Brownell 	}
98189ccbdc9SDavid Brownell #endif
98289ccbdc9SDavid Brownell 
9831da177e4SLinus Torvalds 	/* Some hubs have a subclass of 1, which AFAICT according to the */
9841da177e4SLinus Torvalds 	/*  specs is not defined, but it works */
9851da177e4SLinus Torvalds 	if ((desc->desc.bInterfaceSubClass != 0) &&
9861da177e4SLinus Torvalds 	    (desc->desc.bInterfaceSubClass != 1)) {
9871da177e4SLinus Torvalds descriptor_error:
9881da177e4SLinus Torvalds 		dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
9891da177e4SLinus Torvalds 		return -EIO;
9901da177e4SLinus Torvalds 	}
9911da177e4SLinus Torvalds 
9921da177e4SLinus Torvalds 	/* Multiple endpoints? What kind of mutant ninja-hub is this? */
9931da177e4SLinus Torvalds 	if (desc->desc.bNumEndpoints != 1)
9941da177e4SLinus Torvalds 		goto descriptor_error;
9951da177e4SLinus Torvalds 
9961da177e4SLinus Torvalds 	endpoint = &desc->endpoint[0].desc;
9971da177e4SLinus Torvalds 
998fbf81c29SLuiz Fernando N. Capitulino 	/* If it's not an interrupt in endpoint, we'd better punt! */
999fbf81c29SLuiz Fernando N. Capitulino 	if (!usb_endpoint_is_int_in(endpoint))
10001da177e4SLinus Torvalds 		goto descriptor_error;
10011da177e4SLinus Torvalds 
10021da177e4SLinus Torvalds 	/* We found a hub */
10031da177e4SLinus Torvalds 	dev_info (&intf->dev, "USB hub found\n");
10041da177e4SLinus Torvalds 
10050a1ef3b5SAlan Stern 	hub = kzalloc(sizeof(*hub), GFP_KERNEL);
10061da177e4SLinus Torvalds 	if (!hub) {
10071da177e4SLinus Torvalds 		dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
10081da177e4SLinus Torvalds 		return -ENOMEM;
10091da177e4SLinus Torvalds 	}
10101da177e4SLinus Torvalds 
1011e8054854SAlan Stern 	kref_init(&hub->kref);
10121da177e4SLinus Torvalds 	INIT_LIST_HEAD(&hub->event_list);
10131da177e4SLinus Torvalds 	hub->intfdev = &intf->dev;
10141da177e4SLinus Torvalds 	hub->hdev = hdev;
1015c4028958SDavid Howells 	INIT_DELAYED_WORK(&hub->leds, led_work);
1016e8054854SAlan Stern 	usb_get_intf(intf);
10171da177e4SLinus Torvalds 
10181da177e4SLinus Torvalds 	usb_set_intfdata (intf, hub);
101940f122f3SAlan Stern 	intf->needs_remote_wakeup = 1;
10201da177e4SLinus Torvalds 
10211da177e4SLinus Torvalds 	if (hdev->speed == USB_SPEED_HIGH)
10221da177e4SLinus Torvalds 		highspeed_hubs++;
10231da177e4SLinus Torvalds 
10241da177e4SLinus Torvalds 	if (hub_configure(hub, endpoint) >= 0)
10251da177e4SLinus Torvalds 		return 0;
10261da177e4SLinus Torvalds 
10271da177e4SLinus Torvalds 	hub_disconnect (intf);
10281da177e4SLinus Torvalds 	return -ENODEV;
10291da177e4SLinus Torvalds }
10301da177e4SLinus Torvalds 
10311da177e4SLinus Torvalds static int
10321da177e4SLinus Torvalds hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
10331da177e4SLinus Torvalds {
10341da177e4SLinus Torvalds 	struct usb_device *hdev = interface_to_usbdev (intf);
10351da177e4SLinus Torvalds 
10361da177e4SLinus Torvalds 	/* assert ifno == 0 (part of hub spec) */
10371da177e4SLinus Torvalds 	switch (code) {
10381da177e4SLinus Torvalds 	case USBDEVFS_HUB_PORTINFO: {
10391da177e4SLinus Torvalds 		struct usbdevfs_hub_portinfo *info = user_data;
10401da177e4SLinus Torvalds 		int i;
10411da177e4SLinus Torvalds 
10421da177e4SLinus Torvalds 		spin_lock_irq(&device_state_lock);
10431da177e4SLinus Torvalds 		if (hdev->devnum <= 0)
10441da177e4SLinus Torvalds 			info->nports = 0;
10451da177e4SLinus Torvalds 		else {
10461da177e4SLinus Torvalds 			info->nports = hdev->maxchild;
10471da177e4SLinus Torvalds 			for (i = 0; i < info->nports; i++) {
10481da177e4SLinus Torvalds 				if (hdev->children[i] == NULL)
10491da177e4SLinus Torvalds 					info->port[i] = 0;
10501da177e4SLinus Torvalds 				else
10511da177e4SLinus Torvalds 					info->port[i] =
10521da177e4SLinus Torvalds 						hdev->children[i]->devnum;
10531da177e4SLinus Torvalds 			}
10541da177e4SLinus Torvalds 		}
10551da177e4SLinus Torvalds 		spin_unlock_irq(&device_state_lock);
10561da177e4SLinus Torvalds 
10571da177e4SLinus Torvalds 		return info->nports + 1;
10581da177e4SLinus Torvalds 		}
10591da177e4SLinus Torvalds 
10601da177e4SLinus Torvalds 	default:
10611da177e4SLinus Torvalds 		return -ENOSYS;
10621da177e4SLinus Torvalds 	}
10631da177e4SLinus Torvalds }
10641da177e4SLinus Torvalds 
10651da177e4SLinus Torvalds 
10661da177e4SLinus Torvalds static void recursively_mark_NOTATTACHED(struct usb_device *udev)
10671da177e4SLinus Torvalds {
10681da177e4SLinus Torvalds 	int i;
10691da177e4SLinus Torvalds 
10701da177e4SLinus Torvalds 	for (i = 0; i < udev->maxchild; ++i) {
10711da177e4SLinus Torvalds 		if (udev->children[i])
10721da177e4SLinus Torvalds 			recursively_mark_NOTATTACHED(udev->children[i]);
10731da177e4SLinus Torvalds 	}
1074ee49fb5dSAlan Stern 	if (udev->state == USB_STATE_SUSPENDED)
1075ee49fb5dSAlan Stern 		udev->discon_suspended = 1;
10761da177e4SLinus Torvalds 	udev->state = USB_STATE_NOTATTACHED;
10771da177e4SLinus Torvalds }
10781da177e4SLinus Torvalds 
10791da177e4SLinus Torvalds /**
10801da177e4SLinus Torvalds  * usb_set_device_state - change a device's current state (usbcore, hcds)
10811da177e4SLinus Torvalds  * @udev: pointer to device whose state should be changed
10821da177e4SLinus Torvalds  * @new_state: new state value to be stored
10831da177e4SLinus Torvalds  *
10841da177e4SLinus Torvalds  * udev->state is _not_ fully protected by the device lock.  Although
10851da177e4SLinus Torvalds  * most transitions are made only while holding the lock, the state can
10861da177e4SLinus Torvalds  * can change to USB_STATE_NOTATTACHED at almost any time.  This
10871da177e4SLinus Torvalds  * is so that devices can be marked as disconnected as soon as possible,
10881da177e4SLinus Torvalds  * without having to wait for any semaphores to be released.  As a result,
10891da177e4SLinus Torvalds  * all changes to any device's state must be protected by the
10901da177e4SLinus Torvalds  * device_state_lock spinlock.
10911da177e4SLinus Torvalds  *
10921da177e4SLinus Torvalds  * Once a device has been added to the device tree, all changes to its state
10931da177e4SLinus Torvalds  * should be made using this routine.  The state should _not_ be set directly.
10941da177e4SLinus Torvalds  *
10951da177e4SLinus Torvalds  * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
10961da177e4SLinus Torvalds  * Otherwise udev->state is set to new_state, and if new_state is
10971da177e4SLinus Torvalds  * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
10981da177e4SLinus Torvalds  * to USB_STATE_NOTATTACHED.
10991da177e4SLinus Torvalds  */
11001da177e4SLinus Torvalds void usb_set_device_state(struct usb_device *udev,
11011da177e4SLinus Torvalds 		enum usb_device_state new_state)
11021da177e4SLinus Torvalds {
11031da177e4SLinus Torvalds 	unsigned long flags;
11041da177e4SLinus Torvalds 
11051da177e4SLinus Torvalds 	spin_lock_irqsave(&device_state_lock, flags);
11061da177e4SLinus Torvalds 	if (udev->state == USB_STATE_NOTATTACHED)
11071da177e4SLinus Torvalds 		;	/* do nothing */
1108b94dc6b5SDavid Brownell 	else if (new_state != USB_STATE_NOTATTACHED) {
1109fb669cc0SDavid Brownell 
1110fb669cc0SDavid Brownell 		/* root hub wakeup capabilities are managed out-of-band
1111fb669cc0SDavid Brownell 		 * and may involve silicon errata ... ignore them here.
1112fb669cc0SDavid Brownell 		 */
1113fb669cc0SDavid Brownell 		if (udev->parent) {
1114645daaabSAlan Stern 			if (udev->state == USB_STATE_SUSPENDED
1115645daaabSAlan Stern 					|| new_state == USB_STATE_SUSPENDED)
1116645daaabSAlan Stern 				;	/* No change to wakeup settings */
1117645daaabSAlan Stern 			else if (new_state == USB_STATE_CONFIGURED)
1118b94dc6b5SDavid Brownell 				device_init_wakeup(&udev->dev,
1119b94dc6b5SDavid Brownell 					(udev->actconfig->desc.bmAttributes
1120b94dc6b5SDavid Brownell 					 & USB_CONFIG_ATT_WAKEUP));
1121645daaabSAlan Stern 			else
1122b94dc6b5SDavid Brownell 				device_init_wakeup(&udev->dev, 0);
1123fb669cc0SDavid Brownell 		}
1124645daaabSAlan Stern 		udev->state = new_state;
1125b94dc6b5SDavid Brownell 	} else
11261da177e4SLinus Torvalds 		recursively_mark_NOTATTACHED(udev);
11271da177e4SLinus Torvalds 	spin_unlock_irqrestore(&device_state_lock, flags);
11281da177e4SLinus Torvalds }
11291da177e4SLinus Torvalds 
11301da177e4SLinus Torvalds 
11311c50c317SAlan Stern #ifdef	CONFIG_PM
11321c50c317SAlan Stern 
11331c50c317SAlan Stern /**
11340458d5b4SAlan Stern  * usb_reset_suspended_device - reset a suspended device instead of resuming it
11350458d5b4SAlan Stern  * @udev: device to be reset instead of resumed
11360458d5b4SAlan Stern  *
11370458d5b4SAlan Stern  * If a host controller doesn't maintain VBUS suspend current during a
11380458d5b4SAlan Stern  * system sleep or is reset when the system wakes up, all the USB
11390458d5b4SAlan Stern  * power sessions below it will be broken.  This is especially troublesome
11400458d5b4SAlan Stern  * for mass-storage devices containing mounted filesystems, since the
11410458d5b4SAlan Stern  * device will appear to have disconnected and all the memory mappings
11420458d5b4SAlan Stern  * to it will be lost.
11430458d5b4SAlan Stern  *
11440458d5b4SAlan Stern  * As an alternative, this routine attempts to recover power sessions for
11450458d5b4SAlan Stern  * devices that are still present by resetting them instead of resuming
11460458d5b4SAlan Stern  * them.  If all goes well, the devices will appear to persist across the
11470458d5b4SAlan Stern  * the interruption of the power sessions.
11480458d5b4SAlan Stern  *
11490458d5b4SAlan Stern  * This facility is inherently dangerous.  Although usb_reset_device()
11500458d5b4SAlan Stern  * makes every effort to insure that the same device is present after the
11510458d5b4SAlan Stern  * reset as before, it cannot provide a 100% guarantee.  Furthermore it's
11520458d5b4SAlan Stern  * quite possible for a device to remain unaltered but its media to be
11530458d5b4SAlan Stern  * changed.  If the user replaces a flash memory card while the system is
11540458d5b4SAlan Stern  * asleep, he will have only himself to blame when the filesystem on the
11550458d5b4SAlan Stern  * new card is corrupted and the system crashes.
11560458d5b4SAlan Stern  */
11570458d5b4SAlan Stern int usb_reset_suspended_device(struct usb_device *udev)
11580458d5b4SAlan Stern {
11590458d5b4SAlan Stern 	int rc = 0;
11600458d5b4SAlan Stern 
11610458d5b4SAlan Stern 	dev_dbg(&udev->dev, "usb %sresume\n", "reset-");
11620458d5b4SAlan Stern 
11630458d5b4SAlan Stern 	/* After we're done the device won't be suspended any more.
11640458d5b4SAlan Stern 	 * In addition, the reset won't work if udev->state is SUSPENDED.
11650458d5b4SAlan Stern 	 */
11660458d5b4SAlan Stern 	usb_set_device_state(udev, udev->actconfig
11670458d5b4SAlan Stern 			? USB_STATE_CONFIGURED
11680458d5b4SAlan Stern 			: USB_STATE_ADDRESS);
11690458d5b4SAlan Stern 
11700458d5b4SAlan Stern 	/* Root hubs don't need to be (and can't be) reset */
11710458d5b4SAlan Stern 	if (udev->parent)
11720458d5b4SAlan Stern 		rc = usb_reset_device(udev);
11730458d5b4SAlan Stern 	return rc;
11740458d5b4SAlan Stern }
11750458d5b4SAlan Stern 
11760458d5b4SAlan Stern /**
11771c50c317SAlan Stern  * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
11781c50c317SAlan Stern  * @rhdev: struct usb_device for the root hub
11791c50c317SAlan Stern  *
11801c50c317SAlan Stern  * The USB host controller driver calls this function when its root hub
11811c50c317SAlan Stern  * is resumed and Vbus power has been interrupted or the controller
11820458d5b4SAlan Stern  * has been reset.  The routine marks @rhdev as having lost power.  When
11830458d5b4SAlan Stern  * the hub driver is resumed it will take notice; if CONFIG_USB_PERSIST
11840458d5b4SAlan Stern  * is enabled then it will carry out power-session recovery, otherwise
11850458d5b4SAlan Stern  * it will disconnect all the child devices.
11861c50c317SAlan Stern  */
11871c50c317SAlan Stern void usb_root_hub_lost_power(struct usb_device *rhdev)
11881c50c317SAlan Stern {
11891c50c317SAlan Stern 	dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
11900458d5b4SAlan Stern 	rhdev->reset_resume = 1;
11911c50c317SAlan Stern }
11921c50c317SAlan Stern EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
11931c50c317SAlan Stern 
1194d388dab7SAlan Stern #endif	/* CONFIG_PM */
11951c50c317SAlan Stern 
11961da177e4SLinus Torvalds static void choose_address(struct usb_device *udev)
11971da177e4SLinus Torvalds {
11981da177e4SLinus Torvalds 	int		devnum;
11991da177e4SLinus Torvalds 	struct usb_bus	*bus = udev->bus;
12001da177e4SLinus Torvalds 
12011da177e4SLinus Torvalds 	/* If khubd ever becomes multithreaded, this will need a lock */
12021da177e4SLinus Torvalds 
12031da177e4SLinus Torvalds 	/* Try to allocate the next devnum beginning at bus->devnum_next. */
12041da177e4SLinus Torvalds 	devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
12051da177e4SLinus Torvalds 			bus->devnum_next);
12061da177e4SLinus Torvalds 	if (devnum >= 128)
12071da177e4SLinus Torvalds 		devnum = find_next_zero_bit(bus->devmap.devicemap, 128, 1);
12081da177e4SLinus Torvalds 
12091da177e4SLinus Torvalds 	bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
12101da177e4SLinus Torvalds 
12111da177e4SLinus Torvalds 	if (devnum < 128) {
12121da177e4SLinus Torvalds 		set_bit(devnum, bus->devmap.devicemap);
12131da177e4SLinus Torvalds 		udev->devnum = devnum;
12141da177e4SLinus Torvalds 	}
12151da177e4SLinus Torvalds }
12161da177e4SLinus Torvalds 
12171da177e4SLinus Torvalds static void release_address(struct usb_device *udev)
12181da177e4SLinus Torvalds {
12191da177e4SLinus Torvalds 	if (udev->devnum > 0) {
12201da177e4SLinus Torvalds 		clear_bit(udev->devnum, udev->bus->devmap.devicemap);
12211da177e4SLinus Torvalds 		udev->devnum = -1;
12221da177e4SLinus Torvalds 	}
12231da177e4SLinus Torvalds }
12241da177e4SLinus Torvalds 
1225d5d4db70SAlan Stern #ifdef	CONFIG_USB_SUSPEND
1226d5d4db70SAlan Stern 
1227d5d4db70SAlan Stern static void usb_stop_pm(struct usb_device *udev)
1228d5d4db70SAlan Stern {
1229d5d4db70SAlan Stern 	/* Synchronize with the ksuspend thread to prevent any more
1230d5d4db70SAlan Stern 	 * autosuspend requests from being submitted, and decrement
1231d5d4db70SAlan Stern 	 * the parent's count of unsuspended children.
1232d5d4db70SAlan Stern 	 */
1233d5d4db70SAlan Stern 	usb_pm_lock(udev);
1234d5d4db70SAlan Stern 	if (udev->parent && !udev->discon_suspended)
1235d5d4db70SAlan Stern 		usb_autosuspend_device(udev->parent);
1236d5d4db70SAlan Stern 	usb_pm_unlock(udev);
1237d5d4db70SAlan Stern 
1238d5d4db70SAlan Stern 	/* Stop any autosuspend requests already submitted */
1239d5d4db70SAlan Stern 	cancel_rearming_delayed_work(&udev->autosuspend);
1240d5d4db70SAlan Stern }
1241d5d4db70SAlan Stern 
1242d5d4db70SAlan Stern #else
1243d5d4db70SAlan Stern 
1244d5d4db70SAlan Stern static inline void usb_stop_pm(struct usb_device *udev)
1245d5d4db70SAlan Stern { }
1246d5d4db70SAlan Stern 
1247d5d4db70SAlan Stern #endif
1248d5d4db70SAlan Stern 
12491da177e4SLinus Torvalds /**
12501da177e4SLinus Torvalds  * usb_disconnect - disconnect a device (usbcore-internal)
12511da177e4SLinus Torvalds  * @pdev: pointer to device being disconnected
12521da177e4SLinus Torvalds  * Context: !in_interrupt ()
12531da177e4SLinus Torvalds  *
12541da177e4SLinus Torvalds  * Something got disconnected. Get rid of it and all of its children.
12551da177e4SLinus Torvalds  *
12561da177e4SLinus Torvalds  * If *pdev is a normal device then the parent hub must already be locked.
12571da177e4SLinus Torvalds  * If *pdev is a root hub then this routine will acquire the
12581da177e4SLinus Torvalds  * usb_bus_list_lock on behalf of the caller.
12591da177e4SLinus Torvalds  *
12601da177e4SLinus Torvalds  * Only hub drivers (including virtual root hub drivers for host
12611da177e4SLinus Torvalds  * controllers) should ever call this.
12621da177e4SLinus Torvalds  *
12631da177e4SLinus Torvalds  * This call is synchronous, and may not be used in an interrupt context.
12641da177e4SLinus Torvalds  */
12651da177e4SLinus Torvalds void usb_disconnect(struct usb_device **pdev)
12661da177e4SLinus Torvalds {
12671da177e4SLinus Torvalds 	struct usb_device	*udev = *pdev;
12681da177e4SLinus Torvalds 	int			i;
12691da177e4SLinus Torvalds 
12701da177e4SLinus Torvalds 	if (!udev) {
12711da177e4SLinus Torvalds 		pr_debug ("%s nodev\n", __FUNCTION__);
12721da177e4SLinus Torvalds 		return;
12731da177e4SLinus Torvalds 	}
12741da177e4SLinus Torvalds 
12751da177e4SLinus Torvalds 	/* mark the device as inactive, so any further urb submissions for
12761da177e4SLinus Torvalds 	 * this device (and any of its children) will fail immediately.
12771da177e4SLinus Torvalds 	 * this quiesces everyting except pending urbs.
12781da177e4SLinus Torvalds 	 */
12791da177e4SLinus Torvalds 	usb_set_device_state(udev, USB_STATE_NOTATTACHED);
12801da177e4SLinus Torvalds 	dev_info (&udev->dev, "USB disconnect, address %d\n", udev->devnum);
12811da177e4SLinus Torvalds 
12829ad3d6ccSAlan Stern 	usb_lock_device(udev);
12839ad3d6ccSAlan Stern 
12841da177e4SLinus Torvalds 	/* Free up all the children before we remove this device */
12851da177e4SLinus Torvalds 	for (i = 0; i < USB_MAXCHILDREN; i++) {
12861da177e4SLinus Torvalds 		if (udev->children[i])
12871da177e4SLinus Torvalds 			usb_disconnect(&udev->children[i]);
12881da177e4SLinus Torvalds 	}
12891da177e4SLinus Torvalds 
12901da177e4SLinus Torvalds 	/* deallocate hcd/hardware state ... nuking all pending urbs and
12911da177e4SLinus Torvalds 	 * cleaning up all state associated with the current configuration
12921da177e4SLinus Torvalds 	 * so that the hardware is now fully quiesced.
12931da177e4SLinus Torvalds 	 */
1294782da727SAlan Stern 	dev_dbg (&udev->dev, "unregistering device\n");
12951da177e4SLinus Torvalds 	usb_disable_device(udev, 0);
12961da177e4SLinus Torvalds 
1297782da727SAlan Stern 	usb_unlock_device(udev);
12983099e75aSGreg Kroah-Hartman 
1299782da727SAlan Stern 	/* Unregister the device.  The device driver is responsible
1300782da727SAlan Stern 	 * for removing the device files from usbfs and sysfs and for
1301782da727SAlan Stern 	 * de-configuring the device.
1302782da727SAlan Stern 	 */
1303782da727SAlan Stern 	device_del(&udev->dev);
1304782da727SAlan Stern 
1305782da727SAlan Stern 	/* Free the device number and delete the parent's children[]
13061da177e4SLinus Torvalds 	 * (or root_hub) pointer.
13071da177e4SLinus Torvalds 	 */
13081da177e4SLinus Torvalds 	release_address(udev);
13091da177e4SLinus Torvalds 
13101da177e4SLinus Torvalds 	/* Avoid races with recursively_mark_NOTATTACHED() */
13111da177e4SLinus Torvalds 	spin_lock_irq(&device_state_lock);
13121da177e4SLinus Torvalds 	*pdev = NULL;
13131da177e4SLinus Torvalds 	spin_unlock_irq(&device_state_lock);
13141da177e4SLinus Torvalds 
1315d5d4db70SAlan Stern 	usb_stop_pm(udev);
1316ee49fb5dSAlan Stern 
1317782da727SAlan Stern 	put_device(&udev->dev);
13181da177e4SLinus Torvalds }
13191da177e4SLinus Torvalds 
13201da177e4SLinus Torvalds #ifdef DEBUG
13211da177e4SLinus Torvalds static void show_string(struct usb_device *udev, char *id, char *string)
13221da177e4SLinus Torvalds {
13231da177e4SLinus Torvalds 	if (!string)
13241da177e4SLinus Torvalds 		return;
13251da177e4SLinus Torvalds 	dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
13261da177e4SLinus Torvalds }
13271da177e4SLinus Torvalds 
13281da177e4SLinus Torvalds #else
13291da177e4SLinus Torvalds static inline void show_string(struct usb_device *udev, char *id, char *string)
13301da177e4SLinus Torvalds {}
13311da177e4SLinus Torvalds #endif
13321da177e4SLinus Torvalds 
13331da177e4SLinus Torvalds 
13341da177e4SLinus Torvalds #ifdef	CONFIG_USB_OTG
13351da177e4SLinus Torvalds #include "otg_whitelist.h"
13361da177e4SLinus Torvalds #endif
13371da177e4SLinus Torvalds 
13383ede760fSOliver Neukum /**
13393ede760fSOliver Neukum  * usb_new_device - perform initial device setup (usbcore-internal)
13403ede760fSOliver Neukum  * @udev: newly addressed device (in ADDRESS state)
13413ede760fSOliver Neukum  *
13423ede760fSOliver Neukum  * This is called with devices which have been enumerated, but not yet
13433ede760fSOliver Neukum  * configured.  The device descriptor is available, but not descriptors
13443ede760fSOliver Neukum  * for any device configuration.  The caller must have locked either
13453ede760fSOliver Neukum  * the parent hub (if udev is a normal device) or else the
13463ede760fSOliver Neukum  * usb_bus_list_lock (if udev is a root hub).  The parent's pointer to
13473ede760fSOliver Neukum  * udev has already been installed, but udev is not yet visible through
13483ede760fSOliver Neukum  * sysfs or other filesystem code.
13493ede760fSOliver Neukum  *
13503ede760fSOliver Neukum  * It will return if the device is configured properly or not.  Zero if
13513ede760fSOliver Neukum  * the interface was registered with the driver core; else a negative
13523ede760fSOliver Neukum  * errno value.
13533ede760fSOliver Neukum  *
13543ede760fSOliver Neukum  * This call is synchronous, and may not be used in an interrupt context.
13553ede760fSOliver Neukum  *
13563ede760fSOliver Neukum  * Only the hub driver or root-hub registrar should ever call this.
13573ede760fSOliver Neukum  */
13583ede760fSOliver Neukum int usb_new_device(struct usb_device *udev)
13591da177e4SLinus Torvalds {
13601da177e4SLinus Torvalds 	int err;
13611da177e4SLinus Torvalds 
13627ceec1f1SOliver Neukum 	/* Determine quirks */
13637ceec1f1SOliver Neukum 	usb_detect_quirks(udev);
13647ceec1f1SOliver Neukum 
13651da177e4SLinus Torvalds 	err = usb_get_configuration(udev);
13661da177e4SLinus Torvalds 	if (err < 0) {
13671da177e4SLinus Torvalds 		dev_err(&udev->dev, "can't read configurations, error %d\n",
13681da177e4SLinus Torvalds 			err);
13691da177e4SLinus Torvalds 		goto fail;
13701da177e4SLinus Torvalds 	}
13711da177e4SLinus Torvalds 
13721da177e4SLinus Torvalds 	/* read the standard strings and cache them if present */
13734f62efe6SAlan Stern 	udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
13744f62efe6SAlan Stern 	udev->manufacturer = usb_cache_string(udev,
13754f62efe6SAlan Stern 			udev->descriptor.iManufacturer);
13764f62efe6SAlan Stern 	udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
13771da177e4SLinus Torvalds 
13781da177e4SLinus Torvalds 	/* Tell the world! */
13791da177e4SLinus Torvalds 	dev_dbg(&udev->dev, "new device strings: Mfr=%d, Product=%d, "
13801da177e4SLinus Torvalds 			"SerialNumber=%d\n",
13811da177e4SLinus Torvalds 			udev->descriptor.iManufacturer,
13821da177e4SLinus Torvalds 			udev->descriptor.iProduct,
13831da177e4SLinus Torvalds 			udev->descriptor.iSerialNumber);
13841da177e4SLinus Torvalds 	show_string(udev, "Product", udev->product);
13851da177e4SLinus Torvalds 	show_string(udev, "Manufacturer", udev->manufacturer);
13861da177e4SLinus Torvalds 	show_string(udev, "SerialNumber", udev->serial);
13871da177e4SLinus Torvalds 
13881da177e4SLinus Torvalds #ifdef	CONFIG_USB_OTG
13891da177e4SLinus Torvalds 	/*
13901da177e4SLinus Torvalds 	 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
13911da177e4SLinus Torvalds 	 * to wake us after we've powered off VBUS; and HNP, switching roles
13921da177e4SLinus Torvalds 	 * "host" to "peripheral".  The OTG descriptor helps figure this out.
13931da177e4SLinus Torvalds 	 */
13941da177e4SLinus Torvalds 	if (!udev->bus->is_b_host
13951da177e4SLinus Torvalds 			&& udev->config
13961da177e4SLinus Torvalds 			&& udev->parent == udev->bus->root_hub) {
13971da177e4SLinus Torvalds 		struct usb_otg_descriptor	*desc = 0;
13981da177e4SLinus Torvalds 		struct usb_bus			*bus = udev->bus;
13991da177e4SLinus Torvalds 
14001da177e4SLinus Torvalds 		/* descriptor may appear anywhere in config */
14011da177e4SLinus Torvalds 		if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
14021da177e4SLinus Torvalds 					le16_to_cpu(udev->config[0].desc.wTotalLength),
14031da177e4SLinus Torvalds 					USB_DT_OTG, (void **) &desc) == 0) {
14041da177e4SLinus Torvalds 			if (desc->bmAttributes & USB_OTG_HNP) {
140512c3da34SAlan Stern 				unsigned		port1 = udev->portnum;
14061da177e4SLinus Torvalds 
14071da177e4SLinus Torvalds 				dev_info(&udev->dev,
14081da177e4SLinus Torvalds 					"Dual-Role OTG device on %sHNP port\n",
14091da177e4SLinus Torvalds 					(port1 == bus->otg_port)
14101da177e4SLinus Torvalds 						? "" : "non-");
14111da177e4SLinus Torvalds 
14121da177e4SLinus Torvalds 				/* enable HNP before suspend, it's simpler */
14131da177e4SLinus Torvalds 				if (port1 == bus->otg_port)
14141da177e4SLinus Torvalds 					bus->b_hnp_enable = 1;
14151da177e4SLinus Torvalds 				err = usb_control_msg(udev,
14161da177e4SLinus Torvalds 					usb_sndctrlpipe(udev, 0),
14171da177e4SLinus Torvalds 					USB_REQ_SET_FEATURE, 0,
14181da177e4SLinus Torvalds 					bus->b_hnp_enable
14191da177e4SLinus Torvalds 						? USB_DEVICE_B_HNP_ENABLE
14201da177e4SLinus Torvalds 						: USB_DEVICE_A_ALT_HNP_SUPPORT,
14211da177e4SLinus Torvalds 					0, NULL, 0, USB_CTRL_SET_TIMEOUT);
14221da177e4SLinus Torvalds 				if (err < 0) {
14231da177e4SLinus Torvalds 					/* OTG MESSAGE: report errors here,
14241da177e4SLinus Torvalds 					 * customize to match your product.
14251da177e4SLinus Torvalds 					 */
14261da177e4SLinus Torvalds 					dev_info(&udev->dev,
14271da177e4SLinus Torvalds 						"can't set HNP mode; %d\n",
14281da177e4SLinus Torvalds 						err);
14291da177e4SLinus Torvalds 					bus->b_hnp_enable = 0;
14301da177e4SLinus Torvalds 				}
14311da177e4SLinus Torvalds 			}
14321da177e4SLinus Torvalds 		}
14331da177e4SLinus Torvalds 	}
14341da177e4SLinus Torvalds 
14351da177e4SLinus Torvalds 	if (!is_targeted(udev)) {
14361da177e4SLinus Torvalds 
14371da177e4SLinus Torvalds 		/* Maybe it can talk to us, though we can't talk to it.
14381da177e4SLinus Torvalds 		 * (Includes HNP test device.)
14391da177e4SLinus Torvalds 		 */
14401da177e4SLinus Torvalds 		if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
14414956eccdSAlan Stern 			err = usb_port_suspend(udev);
14421da177e4SLinus Torvalds 			if (err < 0)
14431da177e4SLinus Torvalds 				dev_dbg(&udev->dev, "HNP fail, %d\n", err);
14441da177e4SLinus Torvalds 		}
1445ffcdc18dSVikram Pandita 		err = -ENOTSUPP;
14461da177e4SLinus Torvalds 		goto fail;
14471da177e4SLinus Torvalds 	}
14481da177e4SLinus Torvalds #endif
14491da177e4SLinus Torvalds 
14509f8b17e6SKay Sievers 	/* export the usbdev device-node for libusb */
14519f8b17e6SKay Sievers 	udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
14529f8b17e6SKay Sievers 			(((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
14539f8b17e6SKay Sievers 
1454782da727SAlan Stern 	/* Register the device.  The device driver is responsible
14559f8b17e6SKay Sievers 	 * for adding the device files to sysfs and for configuring
14569f8b17e6SKay Sievers 	 * the device.
1457782da727SAlan Stern 	 */
14581da177e4SLinus Torvalds 	err = device_add(&udev->dev);
14591da177e4SLinus Torvalds 	if (err) {
14601da177e4SLinus Torvalds 		dev_err(&udev->dev, "can't device_add, error %d\n", err);
14611da177e4SLinus Torvalds 		goto fail;
14621da177e4SLinus Torvalds 	}
14639ad3d6ccSAlan Stern 
1464ee49fb5dSAlan Stern 	/* Increment the parent's count of unsuspended children */
1465ee49fb5dSAlan Stern 	if (udev->parent)
146694fcda1fSAlan Stern 		usb_autoresume_device(udev->parent);
1467ee49fb5dSAlan Stern 
1468c066475eSGreg Kroah-Hartman exit:
1469c066475eSGreg Kroah-Hartman 	return err;
14701da177e4SLinus Torvalds 
14711da177e4SLinus Torvalds fail:
14721da177e4SLinus Torvalds 	usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1473c066475eSGreg Kroah-Hartman 	goto exit;
14741da177e4SLinus Torvalds }
14751da177e4SLinus Torvalds 
14761da177e4SLinus Torvalds static int hub_port_status(struct usb_hub *hub, int port1,
14771da177e4SLinus Torvalds 			       u16 *status, u16 *change)
14781da177e4SLinus Torvalds {
14791da177e4SLinus Torvalds 	int ret;
14801da177e4SLinus Torvalds 
1481db90e7a1SAlan Stern 	mutex_lock(&hub->status_mutex);
14821da177e4SLinus Torvalds 	ret = get_port_status(hub->hdev, port1, &hub->status->port);
1483d25450c6SAlan Stern 	if (ret < 4) {
14841da177e4SLinus Torvalds 		dev_err (hub->intfdev,
14851da177e4SLinus Torvalds 			"%s failed (err = %d)\n", __FUNCTION__, ret);
1486d25450c6SAlan Stern 		if (ret >= 0)
1487d25450c6SAlan Stern 			ret = -EIO;
1488d25450c6SAlan Stern 	} else {
14891da177e4SLinus Torvalds 		*status = le16_to_cpu(hub->status->port.wPortStatus);
14901da177e4SLinus Torvalds 		*change = le16_to_cpu(hub->status->port.wPortChange);
14911da177e4SLinus Torvalds 		ret = 0;
14921da177e4SLinus Torvalds 	}
1493db90e7a1SAlan Stern 	mutex_unlock(&hub->status_mutex);
14941da177e4SLinus Torvalds 	return ret;
14951da177e4SLinus Torvalds }
14961da177e4SLinus Torvalds 
14970165de09SInaky Perez-Gonzalez 
14980165de09SInaky Perez-Gonzalez /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
14990165de09SInaky Perez-Gonzalez static unsigned hub_is_wusb(struct usb_hub *hub)
15000165de09SInaky Perez-Gonzalez {
15010165de09SInaky Perez-Gonzalez 	struct usb_hcd *hcd;
15020165de09SInaky Perez-Gonzalez 	if (hub->hdev->parent != NULL)  /* not a root hub? */
15030165de09SInaky Perez-Gonzalez 		return 0;
15040165de09SInaky Perez-Gonzalez 	hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
15050165de09SInaky Perez-Gonzalez 	return hcd->wireless;
15060165de09SInaky Perez-Gonzalez }
15070165de09SInaky Perez-Gonzalez 
15080165de09SInaky Perez-Gonzalez 
15091da177e4SLinus Torvalds #define PORT_RESET_TRIES	5
15101da177e4SLinus Torvalds #define SET_ADDRESS_TRIES	2
15111da177e4SLinus Torvalds #define GET_DESCRIPTOR_TRIES	2
15121da177e4SLinus Torvalds #define SET_CONFIG_TRIES	(2 * (use_both_schemes + 1))
15131da177e4SLinus Torvalds #define USE_NEW_SCHEME(i)	((i) / 2 == old_scheme_first)
15141da177e4SLinus Torvalds 
15151da177e4SLinus Torvalds #define HUB_ROOT_RESET_TIME	50	/* times are in msec */
15161da177e4SLinus Torvalds #define HUB_SHORT_RESET_TIME	10
15171da177e4SLinus Torvalds #define HUB_LONG_RESET_TIME	200
15181da177e4SLinus Torvalds #define HUB_RESET_TIMEOUT	500
15191da177e4SLinus Torvalds 
15201da177e4SLinus Torvalds static int hub_port_wait_reset(struct usb_hub *hub, int port1,
15211da177e4SLinus Torvalds 				struct usb_device *udev, unsigned int delay)
15221da177e4SLinus Torvalds {
15231da177e4SLinus Torvalds 	int delay_time, ret;
15241da177e4SLinus Torvalds 	u16 portstatus;
15251da177e4SLinus Torvalds 	u16 portchange;
15261da177e4SLinus Torvalds 
15271da177e4SLinus Torvalds 	for (delay_time = 0;
15281da177e4SLinus Torvalds 			delay_time < HUB_RESET_TIMEOUT;
15291da177e4SLinus Torvalds 			delay_time += delay) {
15301da177e4SLinus Torvalds 		/* wait to give the device a chance to reset */
15311da177e4SLinus Torvalds 		msleep(delay);
15321da177e4SLinus Torvalds 
15331da177e4SLinus Torvalds 		/* read and decode port status */
15341da177e4SLinus Torvalds 		ret = hub_port_status(hub, port1, &portstatus, &portchange);
15351da177e4SLinus Torvalds 		if (ret < 0)
15361da177e4SLinus Torvalds 			return ret;
15371da177e4SLinus Torvalds 
15381da177e4SLinus Torvalds 		/* Device went away? */
15391da177e4SLinus Torvalds 		if (!(portstatus & USB_PORT_STAT_CONNECTION))
15401da177e4SLinus Torvalds 			return -ENOTCONN;
15411da177e4SLinus Torvalds 
1542dd4dd19eSAlan Stern 		/* bomb out completely if the connection bounced */
15431da177e4SLinus Torvalds 		if ((portchange & USB_PORT_STAT_C_CONNECTION))
1544dd4dd19eSAlan Stern 			return -ENOTCONN;
15451da177e4SLinus Torvalds 
15461da177e4SLinus Torvalds 		/* if we`ve finished resetting, then break out of the loop */
15471da177e4SLinus Torvalds 		if (!(portstatus & USB_PORT_STAT_RESET) &&
15481da177e4SLinus Torvalds 		    (portstatus & USB_PORT_STAT_ENABLE)) {
15490165de09SInaky Perez-Gonzalez 			if (hub_is_wusb(hub))
15500165de09SInaky Perez-Gonzalez 				udev->speed = USB_SPEED_VARIABLE;
15510165de09SInaky Perez-Gonzalez 			else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
15521da177e4SLinus Torvalds 				udev->speed = USB_SPEED_HIGH;
15531da177e4SLinus Torvalds 			else if (portstatus & USB_PORT_STAT_LOW_SPEED)
15541da177e4SLinus Torvalds 				udev->speed = USB_SPEED_LOW;
15551da177e4SLinus Torvalds 			else
15561da177e4SLinus Torvalds 				udev->speed = USB_SPEED_FULL;
15571da177e4SLinus Torvalds 			return 0;
15581da177e4SLinus Torvalds 		}
15591da177e4SLinus Torvalds 
15601da177e4SLinus Torvalds 		/* switch to the long delay after two short delay failures */
15611da177e4SLinus Torvalds 		if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
15621da177e4SLinus Torvalds 			delay = HUB_LONG_RESET_TIME;
15631da177e4SLinus Torvalds 
15641da177e4SLinus Torvalds 		dev_dbg (hub->intfdev,
15651da177e4SLinus Torvalds 			"port %d not reset yet, waiting %dms\n",
15661da177e4SLinus Torvalds 			port1, delay);
15671da177e4SLinus Torvalds 	}
15681da177e4SLinus Torvalds 
15691da177e4SLinus Torvalds 	return -EBUSY;
15701da177e4SLinus Torvalds }
15711da177e4SLinus Torvalds 
15721da177e4SLinus Torvalds static int hub_port_reset(struct usb_hub *hub, int port1,
15731da177e4SLinus Torvalds 				struct usb_device *udev, unsigned int delay)
15741da177e4SLinus Torvalds {
15751da177e4SLinus Torvalds 	int i, status;
15761da177e4SLinus Torvalds 
15771da177e4SLinus Torvalds 	/* Reset the port */
15781da177e4SLinus Torvalds 	for (i = 0; i < PORT_RESET_TRIES; i++) {
15791da177e4SLinus Torvalds 		status = set_port_feature(hub->hdev,
15801da177e4SLinus Torvalds 				port1, USB_PORT_FEAT_RESET);
15811da177e4SLinus Torvalds 		if (status)
15821da177e4SLinus Torvalds 			dev_err(hub->intfdev,
15831da177e4SLinus Torvalds 					"cannot reset port %d (err = %d)\n",
15841da177e4SLinus Torvalds 					port1, status);
15851da177e4SLinus Torvalds 		else {
15861da177e4SLinus Torvalds 			status = hub_port_wait_reset(hub, port1, udev, delay);
1587dd16525bSDavid Brownell 			if (status && status != -ENOTCONN)
15881da177e4SLinus Torvalds 				dev_dbg(hub->intfdev,
15891da177e4SLinus Torvalds 						"port_wait_reset: err = %d\n",
15901da177e4SLinus Torvalds 						status);
15911da177e4SLinus Torvalds 		}
15921da177e4SLinus Torvalds 
15931da177e4SLinus Torvalds 		/* return on disconnect or reset */
15941da177e4SLinus Torvalds 		switch (status) {
15951da177e4SLinus Torvalds 		case 0:
1596b789696aSDavid Brownell 			/* TRSTRCY = 10 ms; plus some extra */
1597b789696aSDavid Brownell 			msleep(10 + 40);
15981da177e4SLinus Torvalds 			/* FALL THROUGH */
15991da177e4SLinus Torvalds 		case -ENOTCONN:
16001da177e4SLinus Torvalds 		case -ENODEV:
16011da177e4SLinus Torvalds 			clear_port_feature(hub->hdev,
16021da177e4SLinus Torvalds 				port1, USB_PORT_FEAT_C_RESET);
16031da177e4SLinus Torvalds 			/* FIXME need disconnect() for NOTATTACHED device */
16041da177e4SLinus Torvalds 			usb_set_device_state(udev, status
16051da177e4SLinus Torvalds 					? USB_STATE_NOTATTACHED
16061da177e4SLinus Torvalds 					: USB_STATE_DEFAULT);
16071da177e4SLinus Torvalds 			return status;
16081da177e4SLinus Torvalds 		}
16091da177e4SLinus Torvalds 
16101da177e4SLinus Torvalds 		dev_dbg (hub->intfdev,
16111da177e4SLinus Torvalds 			"port %d not enabled, trying reset again...\n",
16121da177e4SLinus Torvalds 			port1);
16131da177e4SLinus Torvalds 		delay = HUB_LONG_RESET_TIME;
16141da177e4SLinus Torvalds 	}
16151da177e4SLinus Torvalds 
16161da177e4SLinus Torvalds 	dev_err (hub->intfdev,
16171da177e4SLinus Torvalds 		"Cannot enable port %i.  Maybe the USB cable is bad?\n",
16181da177e4SLinus Torvalds 		port1);
16191da177e4SLinus Torvalds 
16201da177e4SLinus Torvalds 	return status;
16211da177e4SLinus Torvalds }
16221da177e4SLinus Torvalds 
1623d388dab7SAlan Stern #ifdef	CONFIG_PM
16241da177e4SLinus Torvalds 
16251da177e4SLinus Torvalds #ifdef	CONFIG_USB_SUSPEND
16261da177e4SLinus Torvalds 
16271da177e4SLinus Torvalds /*
16281da177e4SLinus Torvalds  * Selective port suspend reduces power; most suspended devices draw
16291da177e4SLinus Torvalds  * less than 500 uA.  It's also used in OTG, along with remote wakeup.
16301da177e4SLinus Torvalds  * All devices below the suspended port are also suspended.
16311da177e4SLinus Torvalds  *
16321da177e4SLinus Torvalds  * Devices leave suspend state when the host wakes them up.  Some devices
16331da177e4SLinus Torvalds  * also support "remote wakeup", where the device can activate the USB
16341da177e4SLinus Torvalds  * tree above them to deliver data, such as a keypress or packet.  In
16351da177e4SLinus Torvalds  * some cases, this wakes the USB host.
16361da177e4SLinus Torvalds  */
16371da177e4SLinus Torvalds static int hub_port_suspend(struct usb_hub *hub, int port1,
16381da177e4SLinus Torvalds 		struct usb_device *udev)
16391da177e4SLinus Torvalds {
16401da177e4SLinus Torvalds 	int	status;
16411da177e4SLinus Torvalds 
16421da177e4SLinus Torvalds 	// dev_dbg(hub->intfdev, "suspend port %d\n", port1);
16431da177e4SLinus Torvalds 
16441da177e4SLinus Torvalds 	/* enable remote wakeup when appropriate; this lets the device
16451da177e4SLinus Torvalds 	 * wake up the upstream hub (including maybe the root hub).
16461da177e4SLinus Torvalds 	 *
16471da177e4SLinus Torvalds 	 * NOTE:  OTG devices may issue remote wakeup (or SRP) even when
16481da177e4SLinus Torvalds 	 * we don't explicitly enable it here.
16491da177e4SLinus Torvalds 	 */
1650645daaabSAlan Stern 	if (udev->do_remote_wakeup) {
16511da177e4SLinus Torvalds 		status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
16521da177e4SLinus Torvalds 				USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
16531da177e4SLinus Torvalds 				USB_DEVICE_REMOTE_WAKEUP, 0,
16541da177e4SLinus Torvalds 				NULL, 0,
16551da177e4SLinus Torvalds 				USB_CTRL_SET_TIMEOUT);
16561da177e4SLinus Torvalds 		if (status)
16571da177e4SLinus Torvalds 			dev_dbg(&udev->dev,
16581da177e4SLinus Torvalds 				"won't remote wakeup, status %d\n",
16591da177e4SLinus Torvalds 				status);
16601da177e4SLinus Torvalds 	}
16611da177e4SLinus Torvalds 
16621da177e4SLinus Torvalds 	/* see 7.1.7.6 */
16631da177e4SLinus Torvalds 	status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
16641da177e4SLinus Torvalds 	if (status) {
16651da177e4SLinus Torvalds 		dev_dbg(hub->intfdev,
16661da177e4SLinus Torvalds 			"can't suspend port %d, status %d\n",
16671da177e4SLinus Torvalds 			port1, status);
16681da177e4SLinus Torvalds 		/* paranoia:  "should not happen" */
16691da177e4SLinus Torvalds 		(void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
16701da177e4SLinus Torvalds 				USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
16711da177e4SLinus Torvalds 				USB_DEVICE_REMOTE_WAKEUP, 0,
16721da177e4SLinus Torvalds 				NULL, 0,
16731da177e4SLinus Torvalds 				USB_CTRL_SET_TIMEOUT);
16741da177e4SLinus Torvalds 	} else {
16751da177e4SLinus Torvalds 		/* device has up to 10 msec to fully suspend */
1676645daaabSAlan Stern 		dev_dbg(&udev->dev, "usb %ssuspend\n",
1677645daaabSAlan Stern 				udev->auto_pm ? "auto-" : "");
16781da177e4SLinus Torvalds 		usb_set_device_state(udev, USB_STATE_SUSPENDED);
16791da177e4SLinus Torvalds 		msleep(10);
16801da177e4SLinus Torvalds 	}
16811da177e4SLinus Torvalds 	return status;
16821da177e4SLinus Torvalds }
16831da177e4SLinus Torvalds 
16841da177e4SLinus Torvalds /*
1685140d8f68SAlan Stern  * usb_port_suspend - suspend a usb device's upstream port
16861da177e4SLinus Torvalds  * @udev: device that's no longer in active use
16875edbfb7cSDavid Brownell  * Context: must be able to sleep; device not locked; pm locks held
16881da177e4SLinus Torvalds  *
16891da177e4SLinus Torvalds  * Suspends a USB device that isn't in active use, conserving power.
16901da177e4SLinus Torvalds  * Devices may wake out of a suspend, if anything important happens,
16911da177e4SLinus Torvalds  * using the remote wakeup mechanism.  They may also be taken out of
1692140d8f68SAlan Stern  * suspend by the host, using usb_port_resume().  It's also routine
16931da177e4SLinus Torvalds  * to disconnect devices while they are suspended.
16941da177e4SLinus Torvalds  *
1695390a8c34SDavid Brownell  * This only affects the USB hardware for a device; its interfaces
1696390a8c34SDavid Brownell  * (and, for hubs, child devices) must already have been suspended.
1697390a8c34SDavid Brownell  *
16981da177e4SLinus Torvalds  * Suspending OTG devices may trigger HNP, if that's been enabled
16991da177e4SLinus Torvalds  * between a pair of dual-role devices.  That will change roles, such
17001da177e4SLinus Torvalds  * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
17011da177e4SLinus Torvalds  *
17024956eccdSAlan Stern  * Devices on USB hub ports have only one "suspend" state, corresponding
17034956eccdSAlan Stern  * to ACPI D2, "may cause the device to lose some context".
17044956eccdSAlan Stern  * State transitions include:
17054956eccdSAlan Stern  *
17064956eccdSAlan Stern  *   - suspend, resume ... when the VBUS power link stays live
17074956eccdSAlan Stern  *   - suspend, disconnect ... VBUS lost
17084956eccdSAlan Stern  *
17094956eccdSAlan Stern  * Once VBUS drop breaks the circuit, the port it's using has to go through
17104956eccdSAlan Stern  * normal re-enumeration procedures, starting with enabling VBUS power.
17114956eccdSAlan Stern  * Other than re-initializing the hub (plug/unplug, except for root hubs),
17124956eccdSAlan Stern  * Linux (2.6) currently has NO mechanisms to initiate that:  no khubd
17134956eccdSAlan Stern  * timer, no SRP, no requests through sysfs.
17144956eccdSAlan Stern  *
17154956eccdSAlan Stern  * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
17164956eccdSAlan Stern  * the root hub for their bus goes into global suspend ... so we don't
17174956eccdSAlan Stern  * (falsely) update the device power state to say it suspended.
17184956eccdSAlan Stern  *
17191da177e4SLinus Torvalds  * Returns 0 on success, else negative errno.
17201da177e4SLinus Torvalds  */
1721140d8f68SAlan Stern int usb_port_suspend(struct usb_device *udev)
17221da177e4SLinus Torvalds {
17234956eccdSAlan Stern 	int	status = 0;
17244956eccdSAlan Stern 
17254956eccdSAlan Stern 	/* we change the device's upstream USB link,
17264956eccdSAlan Stern 	 * but root hubs have no upstream USB link.
17274956eccdSAlan Stern 	 */
17284956eccdSAlan Stern 	if (udev->parent)
17294956eccdSAlan Stern 		status = hub_port_suspend(hdev_to_hub(udev->parent),
17304956eccdSAlan Stern 				udev->portnum, udev);
17314956eccdSAlan Stern 	else {
17324956eccdSAlan Stern 		dev_dbg(&udev->dev, "usb %ssuspend\n",
17334956eccdSAlan Stern 				udev->auto_pm ? "auto-" : "");
17344956eccdSAlan Stern 		usb_set_device_state(udev, USB_STATE_SUSPENDED);
17354956eccdSAlan Stern 	}
17364956eccdSAlan Stern 	return status;
17371da177e4SLinus Torvalds }
1738f3f3253dSDavid Brownell 
17391da177e4SLinus Torvalds /*
1740390a8c34SDavid Brownell  * If the USB "suspend" state is in use (rather than "global suspend"),
1741390a8c34SDavid Brownell  * many devices will be individually taken out of suspend state using
1742390a8c34SDavid Brownell  * special" resume" signaling.  These routines kick in shortly after
17431da177e4SLinus Torvalds  * hardware resume signaling is finished, either because of selective
17441da177e4SLinus Torvalds  * resume (by host) or remote wakeup (by device) ... now see what changed
17451da177e4SLinus Torvalds  * in the tree that's rooted at this device.
17461da177e4SLinus Torvalds  */
1747140d8f68SAlan Stern static int finish_port_resume(struct usb_device *udev)
17481da177e4SLinus Torvalds {
17491da177e4SLinus Torvalds 	int	status;
17501da177e4SLinus Torvalds 	u16	devstatus;
17511da177e4SLinus Torvalds 
17521da177e4SLinus Torvalds 	/* caller owns the udev device lock */
1753f3f3253dSDavid Brownell 	dev_dbg(&udev->dev, "finish resume\n");
17541da177e4SLinus Torvalds 
17551da177e4SLinus Torvalds 	/* usb ch9 identifies four variants of SUSPENDED, based on what
17561da177e4SLinus Torvalds 	 * state the device resumes to.  Linux currently won't see the
17571da177e4SLinus Torvalds 	 * first two on the host side; they'd be inside hub_port_init()
17581da177e4SLinus Torvalds 	 * during many timeouts, but khubd can't suspend until later.
17591da177e4SLinus Torvalds 	 */
17601da177e4SLinus Torvalds 	usb_set_device_state(udev, udev->actconfig
17611da177e4SLinus Torvalds 			? USB_STATE_CONFIGURED
17621da177e4SLinus Torvalds 			: USB_STATE_ADDRESS);
17631da177e4SLinus Torvalds 
17641da177e4SLinus Torvalds  	/* 10.5.4.5 says be sure devices in the tree are still there.
17651da177e4SLinus Torvalds  	 * For now let's assume the device didn't go crazy on resume,
17661da177e4SLinus Torvalds 	 * and device drivers will know about any resume quirks.
17671da177e4SLinus Torvalds 	 */
17681da177e4SLinus Torvalds 	status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
1769b40b7a90SAlan Stern 	if (status >= 0)
1770b40b7a90SAlan Stern 		status = (status == 2 ? 0 : -ENODEV);
1771b40b7a90SAlan Stern 
1772b40b7a90SAlan Stern 	if (status)
17731da177e4SLinus Torvalds 		dev_dbg(&udev->dev,
17741da177e4SLinus Torvalds 			"gone after usb resume? status %d\n",
17751da177e4SLinus Torvalds 			status);
17761da177e4SLinus Torvalds 	else if (udev->actconfig) {
17771da177e4SLinus Torvalds 		le16_to_cpus(&devstatus);
177855c52718SAlan Stern 		if ((devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
1779f3f3253dSDavid Brownell 				&& udev->parent) {
17801da177e4SLinus Torvalds 			status = usb_control_msg(udev,
17811da177e4SLinus Torvalds 					usb_sndctrlpipe(udev, 0),
17821da177e4SLinus Torvalds 					USB_REQ_CLEAR_FEATURE,
17831da177e4SLinus Torvalds 						USB_RECIP_DEVICE,
17841da177e4SLinus Torvalds 					USB_DEVICE_REMOTE_WAKEUP, 0,
17851da177e4SLinus Torvalds 					NULL, 0,
17861da177e4SLinus Torvalds 					USB_CTRL_SET_TIMEOUT);
1787a8e7c565SAlan Stern 			if (status)
17881da177e4SLinus Torvalds 				dev_dbg(&udev->dev, "disable remote "
17891da177e4SLinus Torvalds 					"wakeup, status %d\n", status);
17904bf0ba86SAlan Stern 		}
17911da177e4SLinus Torvalds 		status = 0;
17921da177e4SLinus Torvalds 
17931da177e4SLinus Torvalds 	} else if (udev->devnum <= 0) {
17941da177e4SLinus Torvalds 		dev_dbg(&udev->dev, "bogus resume!\n");
17951da177e4SLinus Torvalds 		status = -EINVAL;
17961da177e4SLinus Torvalds 	}
17971da177e4SLinus Torvalds 	return status;
17981da177e4SLinus Torvalds }
17991da177e4SLinus Torvalds 
18001da177e4SLinus Torvalds static int
18011da177e4SLinus Torvalds hub_port_resume(struct usb_hub *hub, int port1, struct usb_device *udev)
18021da177e4SLinus Torvalds {
18031da177e4SLinus Torvalds 	int	status;
1804d25450c6SAlan Stern 	u16	portchange, portstatus;
1805d25450c6SAlan Stern 
1806d25450c6SAlan Stern 	/* Skip the initial Clear-Suspend step for a remote wakeup */
1807d25450c6SAlan Stern 	status = hub_port_status(hub, port1, &portstatus, &portchange);
1808d25450c6SAlan Stern 	if (status == 0 && !(portstatus & USB_PORT_STAT_SUSPEND))
1809d25450c6SAlan Stern 		goto SuspendCleared;
18101da177e4SLinus Torvalds 
18111da177e4SLinus Torvalds 	// dev_dbg(hub->intfdev, "resume port %d\n", port1);
18121da177e4SLinus Torvalds 
1813d5cbad4bSAlan Stern 	set_bit(port1, hub->busy_bits);
1814d5cbad4bSAlan Stern 
18151da177e4SLinus Torvalds 	/* see 7.1.7.7; affects power usage, but not budgeting */
18161da177e4SLinus Torvalds 	status = clear_port_feature(hub->hdev,
18171da177e4SLinus Torvalds 			port1, USB_PORT_FEAT_SUSPEND);
18181da177e4SLinus Torvalds 	if (status) {
18191da177e4SLinus Torvalds 		dev_dbg(hub->intfdev,
18201da177e4SLinus Torvalds 			"can't resume port %d, status %d\n",
18211da177e4SLinus Torvalds 			port1, status);
18221da177e4SLinus Torvalds 	} else {
18231da177e4SLinus Torvalds 		/* drive resume for at least 20 msec */
18241da177e4SLinus Torvalds 		if (udev)
1825645daaabSAlan Stern 			dev_dbg(&udev->dev, "usb %sresume\n",
1826645daaabSAlan Stern 					udev->auto_pm ? "auto-" : "");
18271da177e4SLinus Torvalds 		msleep(25);
18281da177e4SLinus Torvalds 
18291da177e4SLinus Torvalds #define LIVE_FLAGS	( USB_PORT_STAT_POWER \
18301da177e4SLinus Torvalds 			| USB_PORT_STAT_ENABLE \
18311da177e4SLinus Torvalds 			| USB_PORT_STAT_CONNECTION)
18321da177e4SLinus Torvalds 
18331da177e4SLinus Torvalds 		/* Virtual root hubs can trigger on GET_PORT_STATUS to
18341da177e4SLinus Torvalds 		 * stop resume signaling.  Then finish the resume
18351da177e4SLinus Torvalds 		 * sequence.
18361da177e4SLinus Torvalds 		 */
1837d25450c6SAlan Stern 		status = hub_port_status(hub, port1, &portstatus, &portchange);
1838d25450c6SAlan Stern SuspendCleared:
18391da177e4SLinus Torvalds 		if (status < 0
1840d25450c6SAlan Stern 				|| (portstatus & LIVE_FLAGS) != LIVE_FLAGS
1841d25450c6SAlan Stern 				|| (portstatus & USB_PORT_STAT_SUSPEND) != 0
18421da177e4SLinus Torvalds 				) {
18431da177e4SLinus Torvalds 			dev_dbg(hub->intfdev,
18441da177e4SLinus Torvalds 				"port %d status %04x.%04x after resume, %d\n",
1845d25450c6SAlan Stern 				port1, portchange, portstatus, status);
184620307949SAlan Stern 			if (status >= 0)
184720307949SAlan Stern 				status = -ENODEV;
18481da177e4SLinus Torvalds 		} else {
184920307949SAlan Stern 			if (portchange & USB_PORT_STAT_C_SUSPEND)
185020307949SAlan Stern 				clear_port_feature(hub->hdev, port1,
185120307949SAlan Stern 						USB_PORT_FEAT_C_SUSPEND);
18521da177e4SLinus Torvalds 			/* TRSMRCY = 10 msec */
18531da177e4SLinus Torvalds 			msleep(10);
18541da177e4SLinus Torvalds 			if (udev)
1855140d8f68SAlan Stern 				status = finish_port_resume(udev);
18561da177e4SLinus Torvalds 		}
18571da177e4SLinus Torvalds 	}
18581da177e4SLinus Torvalds 	if (status < 0)
18591da177e4SLinus Torvalds 		hub_port_logical_disconnect(hub, port1);
18601da177e4SLinus Torvalds 
1861d5cbad4bSAlan Stern 	clear_bit(port1, hub->busy_bits);
1862d5cbad4bSAlan Stern 	if (!hub->hdev->parent && !hub->busy_bits[0])
1863d5cbad4bSAlan Stern 		usb_enable_root_hub_irq(hub->hdev->bus);
1864d5cbad4bSAlan Stern 
18651da177e4SLinus Torvalds 	return status;
18661da177e4SLinus Torvalds }
18671da177e4SLinus Torvalds 
18685edbfb7cSDavid Brownell /*
1869140d8f68SAlan Stern  * usb_port_resume - re-activate a suspended usb device's upstream port
18701da177e4SLinus Torvalds  * @udev: device to re-activate
18715edbfb7cSDavid Brownell  * Context: must be able to sleep; device not locked; pm locks held
18721da177e4SLinus Torvalds  *
18731da177e4SLinus Torvalds  * This will re-activate the suspended device, increasing power usage
18741da177e4SLinus Torvalds  * while letting drivers communicate again with its endpoints.
18751da177e4SLinus Torvalds  * USB resume explicitly guarantees that the power session between
18761da177e4SLinus Torvalds  * the host and the device is the same as it was when the device
18771da177e4SLinus Torvalds  * suspended.
18781da177e4SLinus Torvalds  *
18791da177e4SLinus Torvalds  * Returns 0 on success, else negative errno.
18801da177e4SLinus Torvalds  */
1881140d8f68SAlan Stern int usb_port_resume(struct usb_device *udev)
18821da177e4SLinus Torvalds {
1883d388dab7SAlan Stern 	int	status;
18841da177e4SLinus Torvalds 
1885140d8f68SAlan Stern 	/* we change the device's upstream USB link,
1886140d8f68SAlan Stern 	 * but root hubs have no upstream USB link.
1887140d8f68SAlan Stern 	 */
1888f3f3253dSDavid Brownell 	if (udev->parent) {
18891da177e4SLinus Torvalds 		// NOTE this fails if parent is also suspended...
18901da177e4SLinus Torvalds 		status = hub_port_resume(hdev_to_hub(udev->parent),
189112c3da34SAlan Stern 				udev->portnum, udev);
1892645daaabSAlan Stern 	} else {
1893645daaabSAlan Stern 		dev_dbg(&udev->dev, "usb %sresume\n",
1894645daaabSAlan Stern 				udev->auto_pm ? "auto-" : "");
1895140d8f68SAlan Stern 		status = finish_port_resume(udev);
1896645daaabSAlan Stern 	}
1897f3f3253dSDavid Brownell 	if (status < 0)
1898a8e7c565SAlan Stern 		dev_dbg(&udev->dev, "can't resume, status %d\n", status);
18991da177e4SLinus Torvalds 	return status;
19001da177e4SLinus Torvalds }
19011da177e4SLinus Torvalds 
19021da177e4SLinus Torvalds static int remote_wakeup(struct usb_device *udev)
19031da177e4SLinus Torvalds {
19041da177e4SLinus Torvalds 	int	status = 0;
19051da177e4SLinus Torvalds 
19069ad3d6ccSAlan Stern 	usb_lock_device(udev);
19071da177e4SLinus Torvalds 	if (udev->state == USB_STATE_SUSPENDED) {
1908645daaabSAlan Stern 		dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
19091941044aSAlan Stern 		usb_mark_last_busy(udev);
19106b157c9bSAlan Stern 		status = usb_external_resume_device(udev);
1911d25450c6SAlan Stern 	}
19129ad3d6ccSAlan Stern 	usb_unlock_device(udev);
19131da177e4SLinus Torvalds 	return status;
19141da177e4SLinus Torvalds }
19151da177e4SLinus Torvalds 
1916d388dab7SAlan Stern #else	/* CONFIG_USB_SUSPEND */
1917d388dab7SAlan Stern 
1918d388dab7SAlan Stern /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
1919d388dab7SAlan Stern 
1920d388dab7SAlan Stern int usb_port_suspend(struct usb_device *udev)
1921d388dab7SAlan Stern {
1922d388dab7SAlan Stern 	return 0;
1923d388dab7SAlan Stern }
1924d388dab7SAlan Stern 
1925d388dab7SAlan Stern static inline int
1926d388dab7SAlan Stern finish_port_resume(struct usb_device *udev)
1927d388dab7SAlan Stern {
1928d388dab7SAlan Stern 	return 0;
1929d388dab7SAlan Stern }
1930d388dab7SAlan Stern 
1931d388dab7SAlan Stern static inline int
1932d388dab7SAlan Stern hub_port_resume(struct usb_hub *hub, int port1, struct usb_device *udev)
1933d388dab7SAlan Stern {
1934d388dab7SAlan Stern 	return 0;
1935d388dab7SAlan Stern }
1936d388dab7SAlan Stern 
1937d388dab7SAlan Stern int usb_port_resume(struct usb_device *udev)
1938d388dab7SAlan Stern {
1939d388dab7SAlan Stern 	return 0;
1940d388dab7SAlan Stern }
1941d388dab7SAlan Stern 
1942d388dab7SAlan Stern static inline int remote_wakeup(struct usb_device *udev)
1943d388dab7SAlan Stern {
1944d388dab7SAlan Stern 	return 0;
1945d388dab7SAlan Stern }
1946d388dab7SAlan Stern 
1947d388dab7SAlan Stern #endif
1948d388dab7SAlan Stern 
1949db690874SDavid Brownell static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
19501da177e4SLinus Torvalds {
19511da177e4SLinus Torvalds 	struct usb_hub		*hub = usb_get_intfdata (intf);
19521da177e4SLinus Torvalds 	struct usb_device	*hdev = hub->hdev;
19531da177e4SLinus Torvalds 	unsigned		port1;
19541da177e4SLinus Torvalds 
1955c9f89fa4SDavid Brownell 	/* fail if children aren't already suspended */
19561da177e4SLinus Torvalds 	for (port1 = 1; port1 <= hdev->maxchild; port1++) {
19571da177e4SLinus Torvalds 		struct usb_device	*udev;
19581da177e4SLinus Torvalds 
19591da177e4SLinus Torvalds 		udev = hdev->children [port1-1];
1960114b368cSAlan Stern 		if (udev && msg.event == PM_EVENT_SUSPEND &&
1961f3f3253dSDavid Brownell #ifdef	CONFIG_USB_SUSPEND
1962114b368cSAlan Stern 				udev->state != USB_STATE_SUSPENDED
1963114b368cSAlan Stern #else
1964114b368cSAlan Stern 				udev->dev.power.power_state.event
1965114b368cSAlan Stern 					== PM_EVENT_ON
1966f3f3253dSDavid Brownell #endif
1967114b368cSAlan Stern 				) {
1968645daaabSAlan Stern 			if (!hdev->auto_pm)
1969645daaabSAlan Stern 				dev_dbg(&intf->dev, "port %d nyet suspended\n",
1970645daaabSAlan Stern 						port1);
1971c9f89fa4SDavid Brownell 			return -EBUSY;
1972c9f89fa4SDavid Brownell 		}
19731da177e4SLinus Torvalds 	}
19741da177e4SLinus Torvalds 
197540f122f3SAlan Stern 	dev_dbg(&intf->dev, "%s\n", __FUNCTION__);
197640f122f3SAlan Stern 
1977c9f89fa4SDavid Brownell 	/* stop khubd and related activity */
1978c9f89fa4SDavid Brownell 	hub_quiesce(hub);
1979b6f6436dSAlan Stern 	return 0;
19801da177e4SLinus Torvalds }
19811da177e4SLinus Torvalds 
19821da177e4SLinus Torvalds static int hub_resume(struct usb_interface *intf)
19831da177e4SLinus Torvalds {
19841da177e4SLinus Torvalds 	struct usb_hub		*hub = usb_get_intfdata (intf);
19851da177e4SLinus Torvalds 
198640f122f3SAlan Stern 	dev_dbg(&intf->dev, "%s\n", __FUNCTION__);
198740f122f3SAlan Stern 
1988a8e7c565SAlan Stern 	/* tell khubd to look for changes on this hub */
1989f3f3253dSDavid Brownell 	hub_activate(hub);
19901da177e4SLinus Torvalds 	return 0;
19911da177e4SLinus Torvalds }
19921da177e4SLinus Torvalds 
1993d388dab7SAlan Stern #else	/* CONFIG_PM */
1994d388dab7SAlan Stern 
1995d388dab7SAlan Stern static inline int remote_wakeup(struct usb_device *udev)
1996d388dab7SAlan Stern {
1997d388dab7SAlan Stern 	return 0;
1998d388dab7SAlan Stern }
1999d388dab7SAlan Stern 
2000511366daSAndrew Morton #define hub_suspend NULL
2001511366daSAndrew Morton #define hub_resume NULL
2002d388dab7SAlan Stern #endif
2003d388dab7SAlan Stern 
20041da177e4SLinus Torvalds 
20051da177e4SLinus Torvalds /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
20061da177e4SLinus Torvalds  *
20071da177e4SLinus Torvalds  * Between connect detection and reset signaling there must be a delay
20081da177e4SLinus Torvalds  * of 100ms at least for debounce and power-settling.  The corresponding
20091da177e4SLinus Torvalds  * timer shall restart whenever the downstream port detects a disconnect.
20101da177e4SLinus Torvalds  *
20111da177e4SLinus Torvalds  * Apparently there are some bluetooth and irda-dongles and a number of
20121da177e4SLinus Torvalds  * low-speed devices for which this debounce period may last over a second.
20131da177e4SLinus Torvalds  * Not covered by the spec - but easy to deal with.
20141da177e4SLinus Torvalds  *
20151da177e4SLinus Torvalds  * This implementation uses a 1500ms total debounce timeout; if the
20161da177e4SLinus Torvalds  * connection isn't stable by then it returns -ETIMEDOUT.  It checks
20171da177e4SLinus Torvalds  * every 25ms for transient disconnects.  When the port status has been
20181da177e4SLinus Torvalds  * unchanged for 100ms it returns the port status.
20191da177e4SLinus Torvalds  */
20201da177e4SLinus Torvalds 
20211da177e4SLinus Torvalds #define HUB_DEBOUNCE_TIMEOUT	1500
20221da177e4SLinus Torvalds #define HUB_DEBOUNCE_STEP	  25
20231da177e4SLinus Torvalds #define HUB_DEBOUNCE_STABLE	 100
20241da177e4SLinus Torvalds 
20251da177e4SLinus Torvalds static int hub_port_debounce(struct usb_hub *hub, int port1)
20261da177e4SLinus Torvalds {
20271da177e4SLinus Torvalds 	int ret;
20281da177e4SLinus Torvalds 	int total_time, stable_time = 0;
20291da177e4SLinus Torvalds 	u16 portchange, portstatus;
20301da177e4SLinus Torvalds 	unsigned connection = 0xffff;
20311da177e4SLinus Torvalds 
20321da177e4SLinus Torvalds 	for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
20331da177e4SLinus Torvalds 		ret = hub_port_status(hub, port1, &portstatus, &portchange);
20341da177e4SLinus Torvalds 		if (ret < 0)
20351da177e4SLinus Torvalds 			return ret;
20361da177e4SLinus Torvalds 
20371da177e4SLinus Torvalds 		if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
20381da177e4SLinus Torvalds 		     (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
20391da177e4SLinus Torvalds 			stable_time += HUB_DEBOUNCE_STEP;
20401da177e4SLinus Torvalds 			if (stable_time >= HUB_DEBOUNCE_STABLE)
20411da177e4SLinus Torvalds 				break;
20421da177e4SLinus Torvalds 		} else {
20431da177e4SLinus Torvalds 			stable_time = 0;
20441da177e4SLinus Torvalds 			connection = portstatus & USB_PORT_STAT_CONNECTION;
20451da177e4SLinus Torvalds 		}
20461da177e4SLinus Torvalds 
20471da177e4SLinus Torvalds 		if (portchange & USB_PORT_STAT_C_CONNECTION) {
20481da177e4SLinus Torvalds 			clear_port_feature(hub->hdev, port1,
20491da177e4SLinus Torvalds 					USB_PORT_FEAT_C_CONNECTION);
20501da177e4SLinus Torvalds 		}
20511da177e4SLinus Torvalds 
20521da177e4SLinus Torvalds 		if (total_time >= HUB_DEBOUNCE_TIMEOUT)
20531da177e4SLinus Torvalds 			break;
20541da177e4SLinus Torvalds 		msleep(HUB_DEBOUNCE_STEP);
20551da177e4SLinus Torvalds 	}
20561da177e4SLinus Torvalds 
20571da177e4SLinus Torvalds 	dev_dbg (hub->intfdev,
20581da177e4SLinus Torvalds 		"debounce: port %d: total %dms stable %dms status 0x%x\n",
20591da177e4SLinus Torvalds 		port1, total_time, stable_time, portstatus);
20601da177e4SLinus Torvalds 
20611da177e4SLinus Torvalds 	if (stable_time < HUB_DEBOUNCE_STABLE)
20621da177e4SLinus Torvalds 		return -ETIMEDOUT;
20631da177e4SLinus Torvalds 	return portstatus;
20641da177e4SLinus Torvalds }
20651da177e4SLinus Torvalds 
20661da177e4SLinus Torvalds static void ep0_reinit(struct usb_device *udev)
20671da177e4SLinus Torvalds {
20681da177e4SLinus Torvalds 	usb_disable_endpoint(udev, 0 + USB_DIR_IN);
20691da177e4SLinus Torvalds 	usb_disable_endpoint(udev, 0 + USB_DIR_OUT);
20701da177e4SLinus Torvalds 	udev->ep_in[0] = udev->ep_out[0] = &udev->ep0;
20711da177e4SLinus Torvalds }
20721da177e4SLinus Torvalds 
20731da177e4SLinus Torvalds #define usb_sndaddr0pipe()	(PIPE_CONTROL << 30)
20741da177e4SLinus Torvalds #define usb_rcvaddr0pipe()	((PIPE_CONTROL << 30) | USB_DIR_IN)
20751da177e4SLinus Torvalds 
20761da177e4SLinus Torvalds static int hub_set_address(struct usb_device *udev)
20771da177e4SLinus Torvalds {
20781da177e4SLinus Torvalds 	int retval;
20791da177e4SLinus Torvalds 
20801da177e4SLinus Torvalds 	if (udev->devnum == 0)
20811da177e4SLinus Torvalds 		return -EINVAL;
20821da177e4SLinus Torvalds 	if (udev->state == USB_STATE_ADDRESS)
20831da177e4SLinus Torvalds 		return 0;
20841da177e4SLinus Torvalds 	if (udev->state != USB_STATE_DEFAULT)
20851da177e4SLinus Torvalds 		return -EINVAL;
20861da177e4SLinus Torvalds 	retval = usb_control_msg(udev, usb_sndaddr0pipe(),
20871da177e4SLinus Torvalds 		USB_REQ_SET_ADDRESS, 0, udev->devnum, 0,
20881da177e4SLinus Torvalds 		NULL, 0, USB_CTRL_SET_TIMEOUT);
20891da177e4SLinus Torvalds 	if (retval == 0) {
20901da177e4SLinus Torvalds 		usb_set_device_state(udev, USB_STATE_ADDRESS);
20911da177e4SLinus Torvalds 		ep0_reinit(udev);
20921da177e4SLinus Torvalds 	}
20931da177e4SLinus Torvalds 	return retval;
20941da177e4SLinus Torvalds }
20951da177e4SLinus Torvalds 
20961da177e4SLinus Torvalds /* Reset device, (re)assign address, get device descriptor.
20971da177e4SLinus Torvalds  * Device connection must be stable, no more debouncing needed.
20981da177e4SLinus Torvalds  * Returns device in USB_STATE_ADDRESS, except on error.
20991da177e4SLinus Torvalds  *
21001da177e4SLinus Torvalds  * If this is called for an already-existing device (as part of
21011da177e4SLinus Torvalds  * usb_reset_device), the caller must own the device lock.  For a
21021da177e4SLinus Torvalds  * newly detected device that is not accessible through any global
21031da177e4SLinus Torvalds  * pointers, it's not necessary to lock the device.
21041da177e4SLinus Torvalds  */
21051da177e4SLinus Torvalds static int
21061da177e4SLinus Torvalds hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
21071da177e4SLinus Torvalds 		int retry_counter)
21081da177e4SLinus Torvalds {
21094186ecf8SArjan van de Ven 	static DEFINE_MUTEX(usb_address0_mutex);
21101da177e4SLinus Torvalds 
21111da177e4SLinus Torvalds 	struct usb_device	*hdev = hub->hdev;
21121da177e4SLinus Torvalds 	int			i, j, retval;
21131da177e4SLinus Torvalds 	unsigned		delay = HUB_SHORT_RESET_TIME;
21141da177e4SLinus Torvalds 	enum usb_device_speed	oldspeed = udev->speed;
211583a07196SInaky Perez-Gonzalez 	char 			*speed, *type;
21161da177e4SLinus Torvalds 
21171da177e4SLinus Torvalds 	/* root hub ports have a slightly longer reset period
21181da177e4SLinus Torvalds 	 * (from USB 2.0 spec, section 7.1.7.5)
21191da177e4SLinus Torvalds 	 */
21201da177e4SLinus Torvalds 	if (!hdev->parent) {
21211da177e4SLinus Torvalds 		delay = HUB_ROOT_RESET_TIME;
21221da177e4SLinus Torvalds 		if (port1 == hdev->bus->otg_port)
21231da177e4SLinus Torvalds 			hdev->bus->b_hnp_enable = 0;
21241da177e4SLinus Torvalds 	}
21251da177e4SLinus Torvalds 
21261da177e4SLinus Torvalds 	/* Some low speed devices have problems with the quick delay, so */
21271da177e4SLinus Torvalds 	/*  be a bit pessimistic with those devices. RHbug #23670 */
21281da177e4SLinus Torvalds 	if (oldspeed == USB_SPEED_LOW)
21291da177e4SLinus Torvalds 		delay = HUB_LONG_RESET_TIME;
21301da177e4SLinus Torvalds 
21314186ecf8SArjan van de Ven 	mutex_lock(&usb_address0_mutex);
21321da177e4SLinus Torvalds 
21331da177e4SLinus Torvalds 	/* Reset the device; full speed may morph to high speed */
21341da177e4SLinus Torvalds 	retval = hub_port_reset(hub, port1, udev, delay);
21351da177e4SLinus Torvalds 	if (retval < 0)		/* error or disconnect */
21361da177e4SLinus Torvalds 		goto fail;
21371da177e4SLinus Torvalds 				/* success, speed is known */
21381da177e4SLinus Torvalds 	retval = -ENODEV;
21391da177e4SLinus Torvalds 
21401da177e4SLinus Torvalds 	if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
21411da177e4SLinus Torvalds 		dev_dbg(&udev->dev, "device reset changed speed!\n");
21421da177e4SLinus Torvalds 		goto fail;
21431da177e4SLinus Torvalds 	}
21441da177e4SLinus Torvalds 	oldspeed = udev->speed;
21451da177e4SLinus Torvalds 
21461da177e4SLinus Torvalds 	/* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
21471da177e4SLinus Torvalds 	 * it's fixed size except for full speed devices.
21485bb6e0aeSInaky Perez-Gonzalez 	 * For Wireless USB devices, ep0 max packet is always 512 (tho
21495bb6e0aeSInaky Perez-Gonzalez 	 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
21501da177e4SLinus Torvalds 	 */
21511da177e4SLinus Torvalds 	switch (udev->speed) {
21525bb6e0aeSInaky Perez-Gonzalez 	case USB_SPEED_VARIABLE:	/* fixed at 512 */
21535bb6e0aeSInaky Perez-Gonzalez 		udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(512);
21545bb6e0aeSInaky Perez-Gonzalez 		break;
21551da177e4SLinus Torvalds 	case USB_SPEED_HIGH:		/* fixed at 64 */
21561da177e4SLinus Torvalds 		udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
21571da177e4SLinus Torvalds 		break;
21581da177e4SLinus Torvalds 	case USB_SPEED_FULL:		/* 8, 16, 32, or 64 */
21591da177e4SLinus Torvalds 		/* to determine the ep0 maxpacket size, try to read
21601da177e4SLinus Torvalds 		 * the device descriptor to get bMaxPacketSize0 and
21611da177e4SLinus Torvalds 		 * then correct our initial guess.
21621da177e4SLinus Torvalds 		 */
21631da177e4SLinus Torvalds 		udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
21641da177e4SLinus Torvalds 		break;
21651da177e4SLinus Torvalds 	case USB_SPEED_LOW:		/* fixed at 8 */
21661da177e4SLinus Torvalds 		udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(8);
21671da177e4SLinus Torvalds 		break;
21681da177e4SLinus Torvalds 	default:
21691da177e4SLinus Torvalds 		goto fail;
21701da177e4SLinus Torvalds 	}
21711da177e4SLinus Torvalds 
217283a07196SInaky Perez-Gonzalez 	type = "";
217383a07196SInaky Perez-Gonzalez 	switch (udev->speed) {
21741da177e4SLinus Torvalds 	case USB_SPEED_LOW:	speed = "low";	break;
21751da177e4SLinus Torvalds 	case USB_SPEED_FULL:	speed = "full";	break;
21761da177e4SLinus Torvalds 	case USB_SPEED_HIGH:	speed = "high";	break;
217783a07196SInaky Perez-Gonzalez 	case USB_SPEED_VARIABLE:
217883a07196SInaky Perez-Gonzalez 				speed = "variable";
217983a07196SInaky Perez-Gonzalez 				type = "Wireless ";
218083a07196SInaky Perez-Gonzalez 				break;
21811da177e4SLinus Torvalds 	default: 		speed = "?";	break;
218283a07196SInaky Perez-Gonzalez 	}
218383a07196SInaky Perez-Gonzalez 	dev_info (&udev->dev,
218483a07196SInaky Perez-Gonzalez 		  "%s %s speed %sUSB device using %s and address %d\n",
218583a07196SInaky Perez-Gonzalez 		  (udev->config) ? "reset" : "new", speed, type,
218683a07196SInaky Perez-Gonzalez 		  udev->bus->controller->driver->name, udev->devnum);
21871da177e4SLinus Torvalds 
21881da177e4SLinus Torvalds 	/* Set up TT records, if needed  */
21891da177e4SLinus Torvalds 	if (hdev->tt) {
21901da177e4SLinus Torvalds 		udev->tt = hdev->tt;
21911da177e4SLinus Torvalds 		udev->ttport = hdev->ttport;
21921da177e4SLinus Torvalds 	} else if (udev->speed != USB_SPEED_HIGH
21931da177e4SLinus Torvalds 			&& hdev->speed == USB_SPEED_HIGH) {
21941da177e4SLinus Torvalds 		udev->tt = &hub->tt;
21951da177e4SLinus Torvalds 		udev->ttport = port1;
21961da177e4SLinus Torvalds 	}
21971da177e4SLinus Torvalds 
21981da177e4SLinus Torvalds 	/* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
21991da177e4SLinus Torvalds 	 * Because device hardware and firmware is sometimes buggy in
22001da177e4SLinus Torvalds 	 * this area, and this is how Linux has done it for ages.
22011da177e4SLinus Torvalds 	 * Change it cautiously.
22021da177e4SLinus Torvalds 	 *
22031da177e4SLinus Torvalds 	 * NOTE:  If USE_NEW_SCHEME() is true we will start by issuing
22041da177e4SLinus Torvalds 	 * a 64-byte GET_DESCRIPTOR request.  This is what Windows does,
22051da177e4SLinus Torvalds 	 * so it may help with some non-standards-compliant devices.
22061da177e4SLinus Torvalds 	 * Otherwise we start with SET_ADDRESS and then try to read the
22071da177e4SLinus Torvalds 	 * first 8 bytes of the device descriptor to get the ep0 maxpacket
22081da177e4SLinus Torvalds 	 * value.
22091da177e4SLinus Torvalds 	 */
22101da177e4SLinus Torvalds 	for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
22111da177e4SLinus Torvalds 		if (USE_NEW_SCHEME(retry_counter)) {
22121da177e4SLinus Torvalds 			struct usb_device_descriptor *buf;
22131da177e4SLinus Torvalds 			int r = 0;
22141da177e4SLinus Torvalds 
22151da177e4SLinus Torvalds #define GET_DESCRIPTOR_BUFSIZE	64
22161da177e4SLinus Torvalds 			buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
22171da177e4SLinus Torvalds 			if (!buf) {
22181da177e4SLinus Torvalds 				retval = -ENOMEM;
22191da177e4SLinus Torvalds 				continue;
22201da177e4SLinus Torvalds 			}
22211da177e4SLinus Torvalds 
2222b89ee19aSAlan Stern 			/* Retry on all errors; some devices are flakey.
2223b89ee19aSAlan Stern 			 * 255 is for WUSB devices, we actually need to use
2224b89ee19aSAlan Stern 			 * 512 (WUSB1.0[4.8.1]).
22251da177e4SLinus Torvalds 			 */
22261da177e4SLinus Torvalds 			for (j = 0; j < 3; ++j) {
22271da177e4SLinus Torvalds 				buf->bMaxPacketSize0 = 0;
22281da177e4SLinus Torvalds 				r = usb_control_msg(udev, usb_rcvaddr0pipe(),
22291da177e4SLinus Torvalds 					USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
22301da177e4SLinus Torvalds 					USB_DT_DEVICE << 8, 0,
22311da177e4SLinus Torvalds 					buf, GET_DESCRIPTOR_BUFSIZE,
2232b89ee19aSAlan Stern 					USB_CTRL_GET_TIMEOUT);
22331da177e4SLinus Torvalds 				switch (buf->bMaxPacketSize0) {
22345bb6e0aeSInaky Perez-Gonzalez 				case 8: case 16: case 32: case 64: case 255:
22351da177e4SLinus Torvalds 					if (buf->bDescriptorType ==
22361da177e4SLinus Torvalds 							USB_DT_DEVICE) {
22371da177e4SLinus Torvalds 						r = 0;
22381da177e4SLinus Torvalds 						break;
22391da177e4SLinus Torvalds 					}
22401da177e4SLinus Torvalds 					/* FALL THROUGH */
22411da177e4SLinus Torvalds 				default:
22421da177e4SLinus Torvalds 					if (r == 0)
22431da177e4SLinus Torvalds 						r = -EPROTO;
22441da177e4SLinus Torvalds 					break;
22451da177e4SLinus Torvalds 				}
22461da177e4SLinus Torvalds 				if (r == 0)
22471da177e4SLinus Torvalds 					break;
22481da177e4SLinus Torvalds 			}
22491da177e4SLinus Torvalds 			udev->descriptor.bMaxPacketSize0 =
22501da177e4SLinus Torvalds 					buf->bMaxPacketSize0;
22511da177e4SLinus Torvalds 			kfree(buf);
22521da177e4SLinus Torvalds 
22531da177e4SLinus Torvalds 			retval = hub_port_reset(hub, port1, udev, delay);
22541da177e4SLinus Torvalds 			if (retval < 0)		/* error or disconnect */
22551da177e4SLinus Torvalds 				goto fail;
22561da177e4SLinus Torvalds 			if (oldspeed != udev->speed) {
22571da177e4SLinus Torvalds 				dev_dbg(&udev->dev,
22581da177e4SLinus Torvalds 					"device reset changed speed!\n");
22591da177e4SLinus Torvalds 				retval = -ENODEV;
22601da177e4SLinus Torvalds 				goto fail;
22611da177e4SLinus Torvalds 			}
22621da177e4SLinus Torvalds 			if (r) {
22631da177e4SLinus Torvalds 				dev_err(&udev->dev, "device descriptor "
22641da177e4SLinus Torvalds 						"read/%s, error %d\n",
22651da177e4SLinus Torvalds 						"64", r);
22661da177e4SLinus Torvalds 				retval = -EMSGSIZE;
22671da177e4SLinus Torvalds 				continue;
22681da177e4SLinus Torvalds 			}
22691da177e4SLinus Torvalds #undef GET_DESCRIPTOR_BUFSIZE
22701da177e4SLinus Torvalds 		}
22711da177e4SLinus Torvalds 
22721da177e4SLinus Torvalds 		for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
22731da177e4SLinus Torvalds 			retval = hub_set_address(udev);
22741da177e4SLinus Torvalds 			if (retval >= 0)
22751da177e4SLinus Torvalds 				break;
22761da177e4SLinus Torvalds 			msleep(200);
22771da177e4SLinus Torvalds 		}
22781da177e4SLinus Torvalds 		if (retval < 0) {
22791da177e4SLinus Torvalds 			dev_err(&udev->dev,
22801da177e4SLinus Torvalds 				"device not accepting address %d, error %d\n",
22811da177e4SLinus Torvalds 				udev->devnum, retval);
22821da177e4SLinus Torvalds 			goto fail;
22831da177e4SLinus Torvalds 		}
22841da177e4SLinus Torvalds 
22851da177e4SLinus Torvalds 		/* cope with hardware quirkiness:
22861da177e4SLinus Torvalds 		 *  - let SET_ADDRESS settle, some device hardware wants it
22871da177e4SLinus Torvalds 		 *  - read ep0 maxpacket even for high and low speed,
22881da177e4SLinus Torvalds   		 */
22891da177e4SLinus Torvalds 		msleep(10);
22901da177e4SLinus Torvalds 		if (USE_NEW_SCHEME(retry_counter))
22911da177e4SLinus Torvalds 			break;
22921da177e4SLinus Torvalds 
22931da177e4SLinus Torvalds 		retval = usb_get_device_descriptor(udev, 8);
22941da177e4SLinus Torvalds 		if (retval < 8) {
22951da177e4SLinus Torvalds 			dev_err(&udev->dev, "device descriptor "
22961da177e4SLinus Torvalds 					"read/%s, error %d\n",
22971da177e4SLinus Torvalds 					"8", retval);
22981da177e4SLinus Torvalds 			if (retval >= 0)
22991da177e4SLinus Torvalds 				retval = -EMSGSIZE;
23001da177e4SLinus Torvalds 		} else {
23011da177e4SLinus Torvalds 			retval = 0;
23021da177e4SLinus Torvalds 			break;
23031da177e4SLinus Torvalds 		}
23041da177e4SLinus Torvalds 	}
23051da177e4SLinus Torvalds 	if (retval)
23061da177e4SLinus Torvalds 		goto fail;
23071da177e4SLinus Torvalds 
23085bb6e0aeSInaky Perez-Gonzalez 	i = udev->descriptor.bMaxPacketSize0 == 0xff?
23095bb6e0aeSInaky Perez-Gonzalez 	    512 : udev->descriptor.bMaxPacketSize0;
23101da177e4SLinus Torvalds 	if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
23111da177e4SLinus Torvalds 		if (udev->speed != USB_SPEED_FULL ||
23121da177e4SLinus Torvalds 				!(i == 8 || i == 16 || i == 32 || i == 64)) {
23131da177e4SLinus Torvalds 			dev_err(&udev->dev, "ep0 maxpacket = %d\n", i);
23141da177e4SLinus Torvalds 			retval = -EMSGSIZE;
23151da177e4SLinus Torvalds 			goto fail;
23161da177e4SLinus Torvalds 		}
23171da177e4SLinus Torvalds 		dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
23181da177e4SLinus Torvalds 		udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
23191da177e4SLinus Torvalds 		ep0_reinit(udev);
23201da177e4SLinus Torvalds 	}
23211da177e4SLinus Torvalds 
23221da177e4SLinus Torvalds 	retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
23231da177e4SLinus Torvalds 	if (retval < (signed)sizeof(udev->descriptor)) {
23241da177e4SLinus Torvalds 		dev_err(&udev->dev, "device descriptor read/%s, error %d\n",
23251da177e4SLinus Torvalds 			"all", retval);
23261da177e4SLinus Torvalds 		if (retval >= 0)
23271da177e4SLinus Torvalds 			retval = -ENOMSG;
23281da177e4SLinus Torvalds 		goto fail;
23291da177e4SLinus Torvalds 	}
23301da177e4SLinus Torvalds 
23311da177e4SLinus Torvalds 	retval = 0;
23321da177e4SLinus Torvalds 
23331da177e4SLinus Torvalds fail:
23341da177e4SLinus Torvalds 	if (retval)
23351da177e4SLinus Torvalds 		hub_port_disable(hub, port1, 0);
23364186ecf8SArjan van de Ven 	mutex_unlock(&usb_address0_mutex);
23371da177e4SLinus Torvalds 	return retval;
23381da177e4SLinus Torvalds }
23391da177e4SLinus Torvalds 
23401da177e4SLinus Torvalds static void
23411da177e4SLinus Torvalds check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
23421da177e4SLinus Torvalds {
23431da177e4SLinus Torvalds 	struct usb_qualifier_descriptor	*qual;
23441da177e4SLinus Torvalds 	int				status;
23451da177e4SLinus Torvalds 
2346e94b1766SChristoph Lameter 	qual = kmalloc (sizeof *qual, GFP_KERNEL);
23471da177e4SLinus Torvalds 	if (qual == NULL)
23481da177e4SLinus Torvalds 		return;
23491da177e4SLinus Torvalds 
23501da177e4SLinus Torvalds 	status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
23511da177e4SLinus Torvalds 			qual, sizeof *qual);
23521da177e4SLinus Torvalds 	if (status == sizeof *qual) {
23531da177e4SLinus Torvalds 		dev_info(&udev->dev, "not running at top speed; "
23541da177e4SLinus Torvalds 			"connect to a high speed hub\n");
23551da177e4SLinus Torvalds 		/* hub LEDs are probably harder to miss than syslog */
23561da177e4SLinus Torvalds 		if (hub->has_indicators) {
23571da177e4SLinus Torvalds 			hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
2358c4028958SDavid Howells 			schedule_delayed_work (&hub->leds, 0);
23591da177e4SLinus Torvalds 		}
23601da177e4SLinus Torvalds 	}
23611da177e4SLinus Torvalds 	kfree(qual);
23621da177e4SLinus Torvalds }
23631da177e4SLinus Torvalds 
23641da177e4SLinus Torvalds static unsigned
23651da177e4SLinus Torvalds hub_power_remaining (struct usb_hub *hub)
23661da177e4SLinus Torvalds {
23671da177e4SLinus Torvalds 	struct usb_device *hdev = hub->hdev;
23681da177e4SLinus Torvalds 	int remaining;
236955c52718SAlan Stern 	int port1;
23701da177e4SLinus Torvalds 
237155c52718SAlan Stern 	if (!hub->limited_power)
23721da177e4SLinus Torvalds 		return 0;
23731da177e4SLinus Torvalds 
237455c52718SAlan Stern 	remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
237555c52718SAlan Stern 	for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
237655c52718SAlan Stern 		struct usb_device	*udev = hdev->children[port1 - 1];
237755c52718SAlan Stern 		int			delta;
23781da177e4SLinus Torvalds 
23791da177e4SLinus Torvalds 		if (!udev)
23801da177e4SLinus Torvalds 			continue;
23811da177e4SLinus Torvalds 
238255c52718SAlan Stern 		/* Unconfigured devices may not use more than 100mA,
238355c52718SAlan Stern 		 * or 8mA for OTG ports */
23841da177e4SLinus Torvalds 		if (udev->actconfig)
238555c52718SAlan Stern 			delta = udev->actconfig->desc.bMaxPower * 2;
238655c52718SAlan Stern 		else if (port1 != udev->bus->otg_port || hdev->parent)
238755c52718SAlan Stern 			delta = 100;
23881da177e4SLinus Torvalds 		else
238955c52718SAlan Stern 			delta = 8;
239055c52718SAlan Stern 		if (delta > hub->mA_per_port)
239155c52718SAlan Stern 			dev_warn(&udev->dev, "%dmA is over %umA budget "
239255c52718SAlan Stern 					"for port %d!\n",
239355c52718SAlan Stern 					delta, hub->mA_per_port, port1);
23941da177e4SLinus Torvalds 		remaining -= delta;
23951da177e4SLinus Torvalds 	}
23961da177e4SLinus Torvalds 	if (remaining < 0) {
239755c52718SAlan Stern 		dev_warn(hub->intfdev, "%dmA over power budget!\n",
239855c52718SAlan Stern 			- remaining);
23991da177e4SLinus Torvalds 		remaining = 0;
24001da177e4SLinus Torvalds 	}
24011da177e4SLinus Torvalds 	return remaining;
24021da177e4SLinus Torvalds }
24031da177e4SLinus Torvalds 
24041da177e4SLinus Torvalds /* Handle physical or logical connection change events.
24051da177e4SLinus Torvalds  * This routine is called when:
24061da177e4SLinus Torvalds  * 	a port connection-change occurs;
24071da177e4SLinus Torvalds  *	a port enable-change occurs (often caused by EMI);
24081da177e4SLinus Torvalds  *	usb_reset_device() encounters changed descriptors (as from
24091da177e4SLinus Torvalds  *		a firmware download)
24101da177e4SLinus Torvalds  * caller already locked the hub
24111da177e4SLinus Torvalds  */
24121da177e4SLinus Torvalds static void hub_port_connect_change(struct usb_hub *hub, int port1,
24131da177e4SLinus Torvalds 					u16 portstatus, u16 portchange)
24141da177e4SLinus Torvalds {
24151da177e4SLinus Torvalds 	struct usb_device *hdev = hub->hdev;
24161da177e4SLinus Torvalds 	struct device *hub_dev = hub->intfdev;
241774ad9bd2SGreg Kroah-Hartman 	u16 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
24181da177e4SLinus Torvalds 	int status, i;
24191da177e4SLinus Torvalds 
24201da177e4SLinus Torvalds 	dev_dbg (hub_dev,
24211da177e4SLinus Torvalds 		"port %d, status %04x, change %04x, %s\n",
24221da177e4SLinus Torvalds 		port1, portstatus, portchange, portspeed (portstatus));
24231da177e4SLinus Torvalds 
24241da177e4SLinus Torvalds 	if (hub->has_indicators) {
24251da177e4SLinus Torvalds 		set_port_led(hub, port1, HUB_LED_AUTO);
24261da177e4SLinus Torvalds 		hub->indicator[port1-1] = INDICATOR_AUTO;
24271da177e4SLinus Torvalds 	}
24281da177e4SLinus Torvalds 
24291da177e4SLinus Torvalds 	/* Disconnect any existing devices under this port */
24301da177e4SLinus Torvalds 	if (hdev->children[port1-1])
24311da177e4SLinus Torvalds 		usb_disconnect(&hdev->children[port1-1]);
24321da177e4SLinus Torvalds 	clear_bit(port1, hub->change_bits);
24331da177e4SLinus Torvalds 
24341da177e4SLinus Torvalds #ifdef	CONFIG_USB_OTG
24351da177e4SLinus Torvalds 	/* during HNP, don't repeat the debounce */
24361da177e4SLinus Torvalds 	if (hdev->bus->is_b_host)
24371da177e4SLinus Torvalds 		portchange &= ~USB_PORT_STAT_C_CONNECTION;
24381da177e4SLinus Torvalds #endif
24391da177e4SLinus Torvalds 
24401da177e4SLinus Torvalds 	if (portchange & USB_PORT_STAT_C_CONNECTION) {
24411da177e4SLinus Torvalds 		status = hub_port_debounce(hub, port1);
2442d4b7d8e8SAlan Stern 		if (status < 0) {
2443d4b7d8e8SAlan Stern 			if (printk_ratelimit())
2444d4b7d8e8SAlan Stern 				dev_err (hub_dev, "connect-debounce failed, "
2445d4b7d8e8SAlan Stern 						"port %d disabled\n", port1);
24461da177e4SLinus Torvalds 			goto done;
24471da177e4SLinus Torvalds 		}
24481da177e4SLinus Torvalds 		portstatus = status;
24491da177e4SLinus Torvalds 	}
24501da177e4SLinus Torvalds 
24511da177e4SLinus Torvalds 	/* Return now if nothing is connected */
24521da177e4SLinus Torvalds 	if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
24531da177e4SLinus Torvalds 
24541da177e4SLinus Torvalds 		/* maybe switch power back on (e.g. root hub was reset) */
245574ad9bd2SGreg Kroah-Hartman 		if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
24561da177e4SLinus Torvalds 				&& !(portstatus & (1 << USB_PORT_FEAT_POWER)))
24571da177e4SLinus Torvalds 			set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
24581da177e4SLinus Torvalds 
24591da177e4SLinus Torvalds 		if (portstatus & USB_PORT_STAT_ENABLE)
24601da177e4SLinus Torvalds   			goto done;
24611da177e4SLinus Torvalds 		return;
24621da177e4SLinus Torvalds 	}
24631da177e4SLinus Torvalds 
24641da177e4SLinus Torvalds 	for (i = 0; i < SET_CONFIG_TRIES; i++) {
24651da177e4SLinus Torvalds 		struct usb_device *udev;
24661da177e4SLinus Torvalds 
24671da177e4SLinus Torvalds 		/* reallocate for each attempt, since references
24681da177e4SLinus Torvalds 		 * to the previous one can escape in various ways
24691da177e4SLinus Torvalds 		 */
24701da177e4SLinus Torvalds 		udev = usb_alloc_dev(hdev, hdev->bus, port1);
24711da177e4SLinus Torvalds 		if (!udev) {
24721da177e4SLinus Torvalds 			dev_err (hub_dev,
24731da177e4SLinus Torvalds 				"couldn't allocate port %d usb_device\n",
24741da177e4SLinus Torvalds 				port1);
24751da177e4SLinus Torvalds 			goto done;
24761da177e4SLinus Torvalds 		}
24771da177e4SLinus Torvalds 
24781da177e4SLinus Torvalds 		usb_set_device_state(udev, USB_STATE_POWERED);
24791da177e4SLinus Torvalds 		udev->speed = USB_SPEED_UNKNOWN;
248055c52718SAlan Stern  		udev->bus_mA = hub->mA_per_port;
2481b6956ffaSAlan Stern 		udev->level = hdev->level + 1;
24821da177e4SLinus Torvalds 
24831da177e4SLinus Torvalds 		/* set the address */
24841da177e4SLinus Torvalds 		choose_address(udev);
24851da177e4SLinus Torvalds 		if (udev->devnum <= 0) {
24861da177e4SLinus Torvalds 			status = -ENOTCONN;	/* Don't retry */
24871da177e4SLinus Torvalds 			goto loop;
24881da177e4SLinus Torvalds 		}
24891da177e4SLinus Torvalds 
24901da177e4SLinus Torvalds 		/* reset and get descriptor */
24911da177e4SLinus Torvalds 		status = hub_port_init(hub, udev, port1, i);
24921da177e4SLinus Torvalds 		if (status < 0)
24931da177e4SLinus Torvalds 			goto loop;
24941da177e4SLinus Torvalds 
24951da177e4SLinus Torvalds 		/* consecutive bus-powered hubs aren't reliable; they can
24961da177e4SLinus Torvalds 		 * violate the voltage drop budget.  if the new child has
24971da177e4SLinus Torvalds 		 * a "powered" LED, users should notice we didn't enable it
24981da177e4SLinus Torvalds 		 * (without reading syslog), even without per-port LEDs
24991da177e4SLinus Torvalds 		 * on the parent.
25001da177e4SLinus Torvalds 		 */
25011da177e4SLinus Torvalds 		if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
250255c52718SAlan Stern 				&& udev->bus_mA <= 100) {
25031da177e4SLinus Torvalds 			u16	devstat;
25041da177e4SLinus Torvalds 
25051da177e4SLinus Torvalds 			status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
25061da177e4SLinus Torvalds 					&devstat);
250755c52718SAlan Stern 			if (status < 2) {
25081da177e4SLinus Torvalds 				dev_dbg(&udev->dev, "get status %d ?\n", status);
25091da177e4SLinus Torvalds 				goto loop_disable;
25101da177e4SLinus Torvalds 			}
251155c52718SAlan Stern 			le16_to_cpus(&devstat);
25121da177e4SLinus Torvalds 			if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
25131da177e4SLinus Torvalds 				dev_err(&udev->dev,
25141da177e4SLinus Torvalds 					"can't connect bus-powered hub "
25151da177e4SLinus Torvalds 					"to this port\n");
25161da177e4SLinus Torvalds 				if (hub->has_indicators) {
25171da177e4SLinus Torvalds 					hub->indicator[port1-1] =
25181da177e4SLinus Torvalds 						INDICATOR_AMBER_BLINK;
2519c4028958SDavid Howells 					schedule_delayed_work (&hub->leds, 0);
25201da177e4SLinus Torvalds 				}
25211da177e4SLinus Torvalds 				status = -ENOTCONN;	/* Don't retry */
25221da177e4SLinus Torvalds 				goto loop_disable;
25231da177e4SLinus Torvalds 			}
25241da177e4SLinus Torvalds 		}
25251da177e4SLinus Torvalds 
25261da177e4SLinus Torvalds 		/* check for devices running slower than they could */
25271da177e4SLinus Torvalds 		if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
25281da177e4SLinus Torvalds 				&& udev->speed == USB_SPEED_FULL
25291da177e4SLinus Torvalds 				&& highspeed_hubs != 0)
25301da177e4SLinus Torvalds 			check_highspeed (hub, udev, port1);
25311da177e4SLinus Torvalds 
25321da177e4SLinus Torvalds 		/* Store the parent's children[] pointer.  At this point
25331da177e4SLinus Torvalds 		 * udev becomes globally accessible, although presumably
25341da177e4SLinus Torvalds 		 * no one will look at it until hdev is unlocked.
25351da177e4SLinus Torvalds 		 */
25361da177e4SLinus Torvalds 		status = 0;
25371da177e4SLinus Torvalds 
25381da177e4SLinus Torvalds 		/* We mustn't add new devices if the parent hub has
25391da177e4SLinus Torvalds 		 * been disconnected; we would race with the
25401da177e4SLinus Torvalds 		 * recursively_mark_NOTATTACHED() routine.
25411da177e4SLinus Torvalds 		 */
25421da177e4SLinus Torvalds 		spin_lock_irq(&device_state_lock);
25431da177e4SLinus Torvalds 		if (hdev->state == USB_STATE_NOTATTACHED)
25441da177e4SLinus Torvalds 			status = -ENOTCONN;
25451da177e4SLinus Torvalds 		else
25461da177e4SLinus Torvalds 			hdev->children[port1-1] = udev;
25471da177e4SLinus Torvalds 		spin_unlock_irq(&device_state_lock);
25481da177e4SLinus Torvalds 
25491da177e4SLinus Torvalds 		/* Run it through the hoops (find a driver, etc) */
25501da177e4SLinus Torvalds 		if (!status) {
25511da177e4SLinus Torvalds 			status = usb_new_device(udev);
25521da177e4SLinus Torvalds 			if (status) {
25531da177e4SLinus Torvalds 				spin_lock_irq(&device_state_lock);
25541da177e4SLinus Torvalds 				hdev->children[port1-1] = NULL;
25551da177e4SLinus Torvalds 				spin_unlock_irq(&device_state_lock);
25561da177e4SLinus Torvalds 			}
25571da177e4SLinus Torvalds 		}
25581da177e4SLinus Torvalds 
25591da177e4SLinus Torvalds 		if (status)
25601da177e4SLinus Torvalds 			goto loop_disable;
25611da177e4SLinus Torvalds 
25621da177e4SLinus Torvalds 		status = hub_power_remaining(hub);
25631da177e4SLinus Torvalds 		if (status)
256455c52718SAlan Stern 			dev_dbg(hub_dev, "%dmA power budget left\n", status);
25651da177e4SLinus Torvalds 
25661da177e4SLinus Torvalds 		return;
25671da177e4SLinus Torvalds 
25681da177e4SLinus Torvalds loop_disable:
25691da177e4SLinus Torvalds 		hub_port_disable(hub, port1, 1);
25701da177e4SLinus Torvalds loop:
25711da177e4SLinus Torvalds 		ep0_reinit(udev);
25721da177e4SLinus Torvalds 		release_address(udev);
25731da177e4SLinus Torvalds 		usb_put_dev(udev);
2574ffcdc18dSVikram Pandita 		if ((status == -ENOTCONN) || (status == -ENOTSUPP))
25751da177e4SLinus Torvalds 			break;
25761da177e4SLinus Torvalds 	}
25771da177e4SLinus Torvalds 
25781da177e4SLinus Torvalds done:
25791da177e4SLinus Torvalds 	hub_port_disable(hub, port1, 1);
25801da177e4SLinus Torvalds }
25811da177e4SLinus Torvalds 
25821da177e4SLinus Torvalds static void hub_events(void)
25831da177e4SLinus Torvalds {
25841da177e4SLinus Torvalds 	struct list_head *tmp;
25851da177e4SLinus Torvalds 	struct usb_device *hdev;
25861da177e4SLinus Torvalds 	struct usb_interface *intf;
25871da177e4SLinus Torvalds 	struct usb_hub *hub;
25881da177e4SLinus Torvalds 	struct device *hub_dev;
25891da177e4SLinus Torvalds 	u16 hubstatus;
25901da177e4SLinus Torvalds 	u16 hubchange;
25911da177e4SLinus Torvalds 	u16 portstatus;
25921da177e4SLinus Torvalds 	u16 portchange;
25931da177e4SLinus Torvalds 	int i, ret;
25941da177e4SLinus Torvalds 	int connect_change;
25951da177e4SLinus Torvalds 
25961da177e4SLinus Torvalds 	/*
25971da177e4SLinus Torvalds 	 *  We restart the list every time to avoid a deadlock with
25981da177e4SLinus Torvalds 	 * deleting hubs downstream from this one. This should be
25991da177e4SLinus Torvalds 	 * safe since we delete the hub from the event list.
26001da177e4SLinus Torvalds 	 * Not the most efficient, but avoids deadlocks.
26011da177e4SLinus Torvalds 	 */
26021da177e4SLinus Torvalds 	while (1) {
26031da177e4SLinus Torvalds 
26041da177e4SLinus Torvalds 		/* Grab the first entry at the beginning of the list */
26051da177e4SLinus Torvalds 		spin_lock_irq(&hub_event_lock);
26061da177e4SLinus Torvalds 		if (list_empty(&hub_event_list)) {
26071da177e4SLinus Torvalds 			spin_unlock_irq(&hub_event_lock);
26081da177e4SLinus Torvalds 			break;
26091da177e4SLinus Torvalds 		}
26101da177e4SLinus Torvalds 
26111da177e4SLinus Torvalds 		tmp = hub_event_list.next;
26121da177e4SLinus Torvalds 		list_del_init(tmp);
26131da177e4SLinus Torvalds 
26141da177e4SLinus Torvalds 		hub = list_entry(tmp, struct usb_hub, event_list);
2615e8054854SAlan Stern 		kref_get(&hub->kref);
2616e8054854SAlan Stern 		spin_unlock_irq(&hub_event_lock);
26171da177e4SLinus Torvalds 
2618e8054854SAlan Stern 		hdev = hub->hdev;
2619e8054854SAlan Stern 		hub_dev = hub->intfdev;
2620e8054854SAlan Stern 		intf = to_usb_interface(hub_dev);
262140f122f3SAlan Stern 		dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
26221da177e4SLinus Torvalds 				hdev->state, hub->descriptor
26231da177e4SLinus Torvalds 					? hub->descriptor->bNbrPorts
26241da177e4SLinus Torvalds 					: 0,
26251da177e4SLinus Torvalds 				/* NOTE: expects max 15 ports... */
26261da177e4SLinus Torvalds 				(u16) hub->change_bits[0],
262740f122f3SAlan Stern 				(u16) hub->event_bits[0]);
26281da177e4SLinus Torvalds 
26291da177e4SLinus Torvalds 		/* Lock the device, then check to see if we were
26301da177e4SLinus Torvalds 		 * disconnected while waiting for the lock to succeed. */
263106b84e8aSAlan Stern 		usb_lock_device(hdev);
2632e8054854SAlan Stern 		if (unlikely(hub->disconnected))
26331da177e4SLinus Torvalds 			goto loop;
26341da177e4SLinus Torvalds 
26351da177e4SLinus Torvalds 		/* If the hub has died, clean up after it */
26361da177e4SLinus Torvalds 		if (hdev->state == USB_STATE_NOTATTACHED) {
26377de18d8bSAlan Stern 			hub->error = -ENODEV;
26387de18d8bSAlan Stern 			hub_pre_reset(intf);
26391da177e4SLinus Torvalds 			goto loop;
26401da177e4SLinus Torvalds 		}
26411da177e4SLinus Torvalds 
264240f122f3SAlan Stern 		/* Autoresume */
264340f122f3SAlan Stern 		ret = usb_autopm_get_interface(intf);
264440f122f3SAlan Stern 		if (ret) {
264540f122f3SAlan Stern 			dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
26461da177e4SLinus Torvalds 			goto loop;
264740f122f3SAlan Stern 		}
264840f122f3SAlan Stern 
264940f122f3SAlan Stern 		/* If this is an inactive hub, do nothing */
265040f122f3SAlan Stern 		if (hub->quiescing)
265140f122f3SAlan Stern 			goto loop_autopm;
26521da177e4SLinus Torvalds 
26531da177e4SLinus Torvalds 		if (hub->error) {
26541da177e4SLinus Torvalds 			dev_dbg (hub_dev, "resetting for error %d\n",
26551da177e4SLinus Torvalds 				hub->error);
26561da177e4SLinus Torvalds 
26577de18d8bSAlan Stern 			ret = usb_reset_composite_device(hdev, intf);
26581da177e4SLinus Torvalds 			if (ret) {
26591da177e4SLinus Torvalds 				dev_dbg (hub_dev,
26601da177e4SLinus Torvalds 					"error resetting hub: %d\n", ret);
266140f122f3SAlan Stern 				goto loop_autopm;
26621da177e4SLinus Torvalds 			}
26631da177e4SLinus Torvalds 
26641da177e4SLinus Torvalds 			hub->nerrors = 0;
26651da177e4SLinus Torvalds 			hub->error = 0;
26661da177e4SLinus Torvalds 		}
26671da177e4SLinus Torvalds 
26681da177e4SLinus Torvalds 		/* deal with port status changes */
26691da177e4SLinus Torvalds 		for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
26701da177e4SLinus Torvalds 			if (test_bit(i, hub->busy_bits))
26711da177e4SLinus Torvalds 				continue;
26721da177e4SLinus Torvalds 			connect_change = test_bit(i, hub->change_bits);
26731da177e4SLinus Torvalds 			if (!test_and_clear_bit(i, hub->event_bits) &&
26741da177e4SLinus Torvalds 					!connect_change && !hub->activating)
26751da177e4SLinus Torvalds 				continue;
26761da177e4SLinus Torvalds 
26771da177e4SLinus Torvalds 			ret = hub_port_status(hub, i,
26781da177e4SLinus Torvalds 					&portstatus, &portchange);
26791da177e4SLinus Torvalds 			if (ret < 0)
26801da177e4SLinus Torvalds 				continue;
26811da177e4SLinus Torvalds 
26821da177e4SLinus Torvalds 			if (hub->activating && !hdev->children[i-1] &&
26831da177e4SLinus Torvalds 					(portstatus &
26841da177e4SLinus Torvalds 						USB_PORT_STAT_CONNECTION))
26851da177e4SLinus Torvalds 				connect_change = 1;
26861da177e4SLinus Torvalds 
26871da177e4SLinus Torvalds 			if (portchange & USB_PORT_STAT_C_CONNECTION) {
26881da177e4SLinus Torvalds 				clear_port_feature(hdev, i,
26891da177e4SLinus Torvalds 					USB_PORT_FEAT_C_CONNECTION);
26901da177e4SLinus Torvalds 				connect_change = 1;
26911da177e4SLinus Torvalds 			}
26921da177e4SLinus Torvalds 
26931da177e4SLinus Torvalds 			if (portchange & USB_PORT_STAT_C_ENABLE) {
26941da177e4SLinus Torvalds 				if (!connect_change)
26951da177e4SLinus Torvalds 					dev_dbg (hub_dev,
26961da177e4SLinus Torvalds 						"port %d enable change, "
26971da177e4SLinus Torvalds 						"status %08x\n",
26981da177e4SLinus Torvalds 						i, portstatus);
26991da177e4SLinus Torvalds 				clear_port_feature(hdev, i,
27001da177e4SLinus Torvalds 					USB_PORT_FEAT_C_ENABLE);
27011da177e4SLinus Torvalds 
27021da177e4SLinus Torvalds 				/*
27031da177e4SLinus Torvalds 				 * EM interference sometimes causes badly
27041da177e4SLinus Torvalds 				 * shielded USB devices to be shutdown by
27051da177e4SLinus Torvalds 				 * the hub, this hack enables them again.
27061da177e4SLinus Torvalds 				 * Works at least with mouse driver.
27071da177e4SLinus Torvalds 				 */
27081da177e4SLinus Torvalds 				if (!(portstatus & USB_PORT_STAT_ENABLE)
27091da177e4SLinus Torvalds 				    && !connect_change
27101da177e4SLinus Torvalds 				    && hdev->children[i-1]) {
27111da177e4SLinus Torvalds 					dev_err (hub_dev,
27121da177e4SLinus Torvalds 					    "port %i "
27131da177e4SLinus Torvalds 					    "disabled by hub (EMI?), "
27141da177e4SLinus Torvalds 					    "re-enabling...\n",
27151da177e4SLinus Torvalds 						i);
27161da177e4SLinus Torvalds 					connect_change = 1;
27171da177e4SLinus Torvalds 				}
27181da177e4SLinus Torvalds 			}
27191da177e4SLinus Torvalds 
27201da177e4SLinus Torvalds 			if (portchange & USB_PORT_STAT_C_SUSPEND) {
27211da177e4SLinus Torvalds 				clear_port_feature(hdev, i,
27221da177e4SLinus Torvalds 					USB_PORT_FEAT_C_SUSPEND);
27231da177e4SLinus Torvalds 				if (hdev->children[i-1]) {
27241da177e4SLinus Torvalds 					ret = remote_wakeup(hdev->
27251da177e4SLinus Torvalds 							children[i-1]);
27261da177e4SLinus Torvalds 					if (ret < 0)
27271da177e4SLinus Torvalds 						connect_change = 1;
27281da177e4SLinus Torvalds 				} else {
27291da177e4SLinus Torvalds 					ret = -ENODEV;
27301da177e4SLinus Torvalds 					hub_port_disable(hub, i, 1);
27311da177e4SLinus Torvalds 				}
27321da177e4SLinus Torvalds 				dev_dbg (hub_dev,
27331da177e4SLinus Torvalds 					"resume on port %d, status %d\n",
27341da177e4SLinus Torvalds 					i, ret);
27351da177e4SLinus Torvalds 			}
27361da177e4SLinus Torvalds 
27371da177e4SLinus Torvalds 			if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
27381da177e4SLinus Torvalds 				dev_err (hub_dev,
27391da177e4SLinus Torvalds 					"over-current change on port %d\n",
27401da177e4SLinus Torvalds 					i);
27411da177e4SLinus Torvalds 				clear_port_feature(hdev, i,
27421da177e4SLinus Torvalds 					USB_PORT_FEAT_C_OVER_CURRENT);
27431da177e4SLinus Torvalds 				hub_power_on(hub);
27441da177e4SLinus Torvalds 			}
27451da177e4SLinus Torvalds 
27461da177e4SLinus Torvalds 			if (portchange & USB_PORT_STAT_C_RESET) {
27471da177e4SLinus Torvalds 				dev_dbg (hub_dev,
27481da177e4SLinus Torvalds 					"reset change on port %d\n",
27491da177e4SLinus Torvalds 					i);
27501da177e4SLinus Torvalds 				clear_port_feature(hdev, i,
27511da177e4SLinus Torvalds 					USB_PORT_FEAT_C_RESET);
27521da177e4SLinus Torvalds 			}
27531da177e4SLinus Torvalds 
27541da177e4SLinus Torvalds 			if (connect_change)
27551da177e4SLinus Torvalds 				hub_port_connect_change(hub, i,
27561da177e4SLinus Torvalds 						portstatus, portchange);
27571da177e4SLinus Torvalds 		} /* end for i */
27581da177e4SLinus Torvalds 
27591da177e4SLinus Torvalds 		/* deal with hub status changes */
27601da177e4SLinus Torvalds 		if (test_and_clear_bit(0, hub->event_bits) == 0)
27611da177e4SLinus Torvalds 			;	/* do nothing */
27621da177e4SLinus Torvalds 		else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
27631da177e4SLinus Torvalds 			dev_err (hub_dev, "get_hub_status failed\n");
27641da177e4SLinus Torvalds 		else {
27651da177e4SLinus Torvalds 			if (hubchange & HUB_CHANGE_LOCAL_POWER) {
27661da177e4SLinus Torvalds 				dev_dbg (hub_dev, "power change\n");
27671da177e4SLinus Torvalds 				clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
276855c52718SAlan Stern 				if (hubstatus & HUB_STATUS_LOCAL_POWER)
276955c52718SAlan Stern 					/* FIXME: Is this always true? */
277055c52718SAlan Stern 					hub->limited_power = 0;
277155c52718SAlan Stern 				else
277255c52718SAlan Stern 					hub->limited_power = 1;
27731da177e4SLinus Torvalds 			}
27741da177e4SLinus Torvalds 			if (hubchange & HUB_CHANGE_OVERCURRENT) {
27751da177e4SLinus Torvalds 				dev_dbg (hub_dev, "overcurrent change\n");
27761da177e4SLinus Torvalds 				msleep(500);	/* Cool down */
27771da177e4SLinus Torvalds 				clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
27781da177e4SLinus Torvalds                         	hub_power_on(hub);
27791da177e4SLinus Torvalds 			}
27801da177e4SLinus Torvalds 		}
27811da177e4SLinus Torvalds 
27821da177e4SLinus Torvalds 		hub->activating = 0;
27831da177e4SLinus Torvalds 
2784d5926ae7SAlan Stern 		/* If this is a root hub, tell the HCD it's okay to
2785d5926ae7SAlan Stern 		 * re-enable port-change interrupts now. */
2786d5cbad4bSAlan Stern 		if (!hdev->parent && !hub->busy_bits[0])
2787d5926ae7SAlan Stern 			usb_enable_root_hub_irq(hdev->bus);
2788d5926ae7SAlan Stern 
278940f122f3SAlan Stern loop_autopm:
279040f122f3SAlan Stern 		/* Allow autosuspend if we're not going to run again */
279140f122f3SAlan Stern 		if (list_empty(&hub->event_list))
279240f122f3SAlan Stern 			usb_autopm_enable(intf);
27931da177e4SLinus Torvalds loop:
27941da177e4SLinus Torvalds 		usb_unlock_device(hdev);
2795e8054854SAlan Stern 		kref_put(&hub->kref, hub_release);
27961da177e4SLinus Torvalds 
27971da177e4SLinus Torvalds         } /* end while (1) */
27981da177e4SLinus Torvalds }
27991da177e4SLinus Torvalds 
28001da177e4SLinus Torvalds static int hub_thread(void *__unused)
28011da177e4SLinus Torvalds {
28021da177e4SLinus Torvalds 	do {
28031da177e4SLinus Torvalds 		hub_events();
28049c8d6178Sakpm@osdl.org 		wait_event_interruptible(khubd_wait,
28059c8d6178Sakpm@osdl.org 				!list_empty(&hub_event_list) ||
28069c8d6178Sakpm@osdl.org 				kthread_should_stop());
28073e1d1d28SChristoph Lameter 		try_to_freeze();
28089c8d6178Sakpm@osdl.org 	} while (!kthread_should_stop() || !list_empty(&hub_event_list));
28091da177e4SLinus Torvalds 
28101da177e4SLinus Torvalds 	pr_debug("%s: khubd exiting\n", usbcore_name);
28119c8d6178Sakpm@osdl.org 	return 0;
28121da177e4SLinus Torvalds }
28131da177e4SLinus Torvalds 
28141da177e4SLinus Torvalds static struct usb_device_id hub_id_table [] = {
28151da177e4SLinus Torvalds     { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
28161da177e4SLinus Torvalds       .bDeviceClass = USB_CLASS_HUB},
28171da177e4SLinus Torvalds     { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
28181da177e4SLinus Torvalds       .bInterfaceClass = USB_CLASS_HUB},
28191da177e4SLinus Torvalds     { }						/* Terminating entry */
28201da177e4SLinus Torvalds };
28211da177e4SLinus Torvalds 
28221da177e4SLinus Torvalds MODULE_DEVICE_TABLE (usb, hub_id_table);
28231da177e4SLinus Torvalds 
28241da177e4SLinus Torvalds static struct usb_driver hub_driver = {
28251da177e4SLinus Torvalds 	.name =		"hub",
28261da177e4SLinus Torvalds 	.probe =	hub_probe,
28271da177e4SLinus Torvalds 	.disconnect =	hub_disconnect,
28281da177e4SLinus Torvalds 	.suspend =	hub_suspend,
28291da177e4SLinus Torvalds 	.resume =	hub_resume,
28307de18d8bSAlan Stern 	.pre_reset =	hub_pre_reset,
28317de18d8bSAlan Stern 	.post_reset =	hub_post_reset,
28321da177e4SLinus Torvalds 	.ioctl =	hub_ioctl,
28331da177e4SLinus Torvalds 	.id_table =	hub_id_table,
283440f122f3SAlan Stern 	.supports_autosuspend =	1,
28351da177e4SLinus Torvalds };
28361da177e4SLinus Torvalds 
28371da177e4SLinus Torvalds int usb_hub_init(void)
28381da177e4SLinus Torvalds {
28391da177e4SLinus Torvalds 	if (usb_register(&hub_driver) < 0) {
28401da177e4SLinus Torvalds 		printk(KERN_ERR "%s: can't register hub driver\n",
28411da177e4SLinus Torvalds 			usbcore_name);
28421da177e4SLinus Torvalds 		return -1;
28431da177e4SLinus Torvalds 	}
28441da177e4SLinus Torvalds 
28459c8d6178Sakpm@osdl.org 	khubd_task = kthread_run(hub_thread, NULL, "khubd");
28469c8d6178Sakpm@osdl.org 	if (!IS_ERR(khubd_task))
28471da177e4SLinus Torvalds 		return 0;
28481da177e4SLinus Torvalds 
28491da177e4SLinus Torvalds 	/* Fall through if kernel_thread failed */
28501da177e4SLinus Torvalds 	usb_deregister(&hub_driver);
28511da177e4SLinus Torvalds 	printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
28521da177e4SLinus Torvalds 
28531da177e4SLinus Torvalds 	return -1;
28541da177e4SLinus Torvalds }
28551da177e4SLinus Torvalds 
28561da177e4SLinus Torvalds void usb_hub_cleanup(void)
28571da177e4SLinus Torvalds {
28589c8d6178Sakpm@osdl.org 	kthread_stop(khubd_task);
28591da177e4SLinus Torvalds 
28601da177e4SLinus Torvalds 	/*
28611da177e4SLinus Torvalds 	 * Hub resources are freed for us by usb_deregister. It calls
28621da177e4SLinus Torvalds 	 * usb_driver_purge on every device which in turn calls that
28631da177e4SLinus Torvalds 	 * devices disconnect function if it is using this driver.
28641da177e4SLinus Torvalds 	 * The hub_disconnect function takes care of releasing the
28651da177e4SLinus Torvalds 	 * individual hub resources. -greg
28661da177e4SLinus Torvalds 	 */
28671da177e4SLinus Torvalds 	usb_deregister(&hub_driver);
28681da177e4SLinus Torvalds } /* usb_hub_cleanup() */
28691da177e4SLinus Torvalds 
28701da177e4SLinus Torvalds static int config_descriptors_changed(struct usb_device *udev)
28711da177e4SLinus Torvalds {
28721da177e4SLinus Torvalds 	unsigned			index;
28731da177e4SLinus Torvalds 	unsigned			len = 0;
28741da177e4SLinus Torvalds 	struct usb_config_descriptor	*buf;
28751da177e4SLinus Torvalds 
28761da177e4SLinus Torvalds 	for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
28771da177e4SLinus Torvalds 		if (len < le16_to_cpu(udev->config[index].desc.wTotalLength))
28781da177e4SLinus Torvalds 			len = le16_to_cpu(udev->config[index].desc.wTotalLength);
28791da177e4SLinus Torvalds 	}
2880e94b1766SChristoph Lameter 	buf = kmalloc (len, GFP_KERNEL);
28811da177e4SLinus Torvalds 	if (buf == NULL) {
28821da177e4SLinus Torvalds 		dev_err(&udev->dev, "no mem to re-read configs after reset\n");
28831da177e4SLinus Torvalds 		/* assume the worst */
28841da177e4SLinus Torvalds 		return 1;
28851da177e4SLinus Torvalds 	}
28861da177e4SLinus Torvalds 	for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
28871da177e4SLinus Torvalds 		int length;
28881da177e4SLinus Torvalds 		int old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
28891da177e4SLinus Torvalds 
28901da177e4SLinus Torvalds 		length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
28911da177e4SLinus Torvalds 				old_length);
28921da177e4SLinus Torvalds 		if (length < old_length) {
28931da177e4SLinus Torvalds 			dev_dbg(&udev->dev, "config index %d, error %d\n",
28941da177e4SLinus Torvalds 					index, length);
28951da177e4SLinus Torvalds 			break;
28961da177e4SLinus Torvalds 		}
28971da177e4SLinus Torvalds 		if (memcmp (buf, udev->rawdescriptors[index], old_length)
28981da177e4SLinus Torvalds 				!= 0) {
28991da177e4SLinus Torvalds 			dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
29001da177e4SLinus Torvalds 				index, buf->bConfigurationValue);
29011da177e4SLinus Torvalds 			break;
29021da177e4SLinus Torvalds 		}
29031da177e4SLinus Torvalds 	}
29041da177e4SLinus Torvalds 	kfree(buf);
29051da177e4SLinus Torvalds 	return index != udev->descriptor.bNumConfigurations;
29061da177e4SLinus Torvalds }
29071da177e4SLinus Torvalds 
29081da177e4SLinus Torvalds /**
29091da177e4SLinus Torvalds  * usb_reset_device - perform a USB port reset to reinitialize a device
29101da177e4SLinus Torvalds  * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
29111da177e4SLinus Torvalds  *
291279efa097SAlan Stern  * WARNING - don't use this routine to reset a composite device
291379efa097SAlan Stern  * (one with multiple interfaces owned by separate drivers)!
291479efa097SAlan Stern  * Use usb_reset_composite_device() instead.
29151da177e4SLinus Torvalds  *
29161da177e4SLinus Torvalds  * Do a port reset, reassign the device's address, and establish its
29171da177e4SLinus Torvalds  * former operating configuration.  If the reset fails, or the device's
29181da177e4SLinus Torvalds  * descriptors change from their values before the reset, or the original
29191da177e4SLinus Torvalds  * configuration and altsettings cannot be restored, a flag will be set
29201da177e4SLinus Torvalds  * telling khubd to pretend the device has been disconnected and then
29211da177e4SLinus Torvalds  * re-connected.  All drivers will be unbound, and the device will be
29221da177e4SLinus Torvalds  * re-enumerated and probed all over again.
29231da177e4SLinus Torvalds  *
29241da177e4SLinus Torvalds  * Returns 0 if the reset succeeded, -ENODEV if the device has been
29251da177e4SLinus Torvalds  * flagged for logical disconnection, or some other negative error code
29261da177e4SLinus Torvalds  * if the reset wasn't even attempted.
29271da177e4SLinus Torvalds  *
29281da177e4SLinus Torvalds  * The caller must own the device lock.  For example, it's safe to use
29291da177e4SLinus Torvalds  * this from a driver probe() routine after downloading new firmware.
29301da177e4SLinus Torvalds  * For calls that might not occur during probe(), drivers should lock
29311da177e4SLinus Torvalds  * the device using usb_lock_device_for_reset().
29326bc6cff5SAlan Stern  *
29336bc6cff5SAlan Stern  * Locking exception: This routine may also be called from within an
29346bc6cff5SAlan Stern  * autoresume handler.  Such usage won't conflict with other tasks
29356bc6cff5SAlan Stern  * holding the device lock because these tasks should always call
29366bc6cff5SAlan Stern  * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
29371da177e4SLinus Torvalds  */
29381da177e4SLinus Torvalds int usb_reset_device(struct usb_device *udev)
29391da177e4SLinus Torvalds {
29401da177e4SLinus Torvalds 	struct usb_device		*parent_hdev = udev->parent;
29411da177e4SLinus Torvalds 	struct usb_hub			*parent_hub;
29421da177e4SLinus Torvalds 	struct usb_device_descriptor	descriptor = udev->descriptor;
294312c3da34SAlan Stern 	int 				i, ret = 0;
294412c3da34SAlan Stern 	int				port1 = udev->portnum;
29451da177e4SLinus Torvalds 
29461da177e4SLinus Torvalds 	if (udev->state == USB_STATE_NOTATTACHED ||
29471da177e4SLinus Torvalds 			udev->state == USB_STATE_SUSPENDED) {
29481da177e4SLinus Torvalds 		dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
29491da177e4SLinus Torvalds 				udev->state);
29501da177e4SLinus Torvalds 		return -EINVAL;
29511da177e4SLinus Torvalds 	}
29521da177e4SLinus Torvalds 
29531da177e4SLinus Torvalds 	if (!parent_hdev) {
29541da177e4SLinus Torvalds 		/* this requires hcd-specific logic; see OHCI hc_restart() */
29551da177e4SLinus Torvalds 		dev_dbg(&udev->dev, "%s for root hub!\n", __FUNCTION__);
29561da177e4SLinus Torvalds 		return -EISDIR;
29571da177e4SLinus Torvalds 	}
29581da177e4SLinus Torvalds 	parent_hub = hdev_to_hub(parent_hdev);
29591da177e4SLinus Torvalds 
29601da177e4SLinus Torvalds 	set_bit(port1, parent_hub->busy_bits);
29611da177e4SLinus Torvalds 	for (i = 0; i < SET_CONFIG_TRIES; ++i) {
29621da177e4SLinus Torvalds 
29631da177e4SLinus Torvalds 		/* ep0 maxpacket size may change; let the HCD know about it.
29641da177e4SLinus Torvalds 		 * Other endpoints will be handled by re-enumeration. */
29651da177e4SLinus Torvalds 		ep0_reinit(udev);
29661da177e4SLinus Torvalds 		ret = hub_port_init(parent_hub, udev, port1, i);
2967dd4dd19eSAlan Stern 		if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
29681da177e4SLinus Torvalds 			break;
29691da177e4SLinus Torvalds 	}
29701da177e4SLinus Torvalds 	clear_bit(port1, parent_hub->busy_bits);
2971d5cbad4bSAlan Stern 	if (!parent_hdev->parent && !parent_hub->busy_bits[0])
2972d5cbad4bSAlan Stern 		usb_enable_root_hub_irq(parent_hdev->bus);
2973d5cbad4bSAlan Stern 
29741da177e4SLinus Torvalds 	if (ret < 0)
29751da177e4SLinus Torvalds 		goto re_enumerate;
29761da177e4SLinus Torvalds 
29771da177e4SLinus Torvalds 	/* Device might have changed firmware (DFU or similar) */
29781da177e4SLinus Torvalds 	if (memcmp(&udev->descriptor, &descriptor, sizeof descriptor)
29791da177e4SLinus Torvalds 			|| config_descriptors_changed (udev)) {
29801da177e4SLinus Torvalds 		dev_info(&udev->dev, "device firmware changed\n");
29811da177e4SLinus Torvalds 		udev->descriptor = descriptor;	/* for disconnect() calls */
29821da177e4SLinus Torvalds 		goto re_enumerate;
29831da177e4SLinus Torvalds   	}
29841da177e4SLinus Torvalds 
29851da177e4SLinus Torvalds 	if (!udev->actconfig)
29861da177e4SLinus Torvalds 		goto done;
29871da177e4SLinus Torvalds 
29881da177e4SLinus Torvalds 	ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
29891da177e4SLinus Torvalds 			USB_REQ_SET_CONFIGURATION, 0,
29901da177e4SLinus Torvalds 			udev->actconfig->desc.bConfigurationValue, 0,
29911da177e4SLinus Torvalds 			NULL, 0, USB_CTRL_SET_TIMEOUT);
29921da177e4SLinus Torvalds 	if (ret < 0) {
29931da177e4SLinus Torvalds 		dev_err(&udev->dev,
29941da177e4SLinus Torvalds 			"can't restore configuration #%d (error=%d)\n",
29951da177e4SLinus Torvalds 			udev->actconfig->desc.bConfigurationValue, ret);
29961da177e4SLinus Torvalds 		goto re_enumerate;
29971da177e4SLinus Torvalds   	}
29981da177e4SLinus Torvalds 	usb_set_device_state(udev, USB_STATE_CONFIGURED);
29991da177e4SLinus Torvalds 
30001da177e4SLinus Torvalds 	for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
30011da177e4SLinus Torvalds 		struct usb_interface *intf = udev->actconfig->interface[i];
30021da177e4SLinus Torvalds 		struct usb_interface_descriptor *desc;
30031da177e4SLinus Torvalds 
30041da177e4SLinus Torvalds 		/* set_interface resets host side toggle even
30051da177e4SLinus Torvalds 		 * for altsetting zero.  the interface may have no driver.
30061da177e4SLinus Torvalds 		 */
30071da177e4SLinus Torvalds 		desc = &intf->cur_altsetting->desc;
30081da177e4SLinus Torvalds 		ret = usb_set_interface(udev, desc->bInterfaceNumber,
30091da177e4SLinus Torvalds 			desc->bAlternateSetting);
30101da177e4SLinus Torvalds 		if (ret < 0) {
30111da177e4SLinus Torvalds 			dev_err(&udev->dev, "failed to restore interface %d "
30121da177e4SLinus Torvalds 				"altsetting %d (error=%d)\n",
30131da177e4SLinus Torvalds 				desc->bInterfaceNumber,
30141da177e4SLinus Torvalds 				desc->bAlternateSetting,
30151da177e4SLinus Torvalds 				ret);
30161da177e4SLinus Torvalds 			goto re_enumerate;
30171da177e4SLinus Torvalds 		}
30181da177e4SLinus Torvalds 	}
30191da177e4SLinus Torvalds 
30201da177e4SLinus Torvalds done:
30211da177e4SLinus Torvalds 	return 0;
30221da177e4SLinus Torvalds 
30231da177e4SLinus Torvalds re_enumerate:
30241da177e4SLinus Torvalds 	hub_port_logical_disconnect(parent_hub, port1);
30251da177e4SLinus Torvalds 	return -ENODEV;
30261da177e4SLinus Torvalds }
3027140d8f68SAlan Stern EXPORT_SYMBOL(usb_reset_device);
302879efa097SAlan Stern 
302979efa097SAlan Stern /**
303079efa097SAlan Stern  * usb_reset_composite_device - warn interface drivers and perform a USB port reset
303179efa097SAlan Stern  * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
303279efa097SAlan Stern  * @iface: interface bound to the driver making the request (optional)
303379efa097SAlan Stern  *
303479efa097SAlan Stern  * Warns all drivers bound to registered interfaces (using their pre_reset
303579efa097SAlan Stern  * method), performs the port reset, and then lets the drivers know that
303679efa097SAlan Stern  * the reset is over (using their post_reset method).
303779efa097SAlan Stern  *
303879efa097SAlan Stern  * Return value is the same as for usb_reset_device().
303979efa097SAlan Stern  *
304079efa097SAlan Stern  * The caller must own the device lock.  For example, it's safe to use
304179efa097SAlan Stern  * this from a driver probe() routine after downloading new firmware.
304279efa097SAlan Stern  * For calls that might not occur during probe(), drivers should lock
304379efa097SAlan Stern  * the device using usb_lock_device_for_reset().
304479efa097SAlan Stern  *
304579efa097SAlan Stern  * The interface locks are acquired during the pre_reset stage and released
304679efa097SAlan Stern  * during the post_reset stage.  However if iface is not NULL and is
304779efa097SAlan Stern  * currently being probed, we assume that the caller already owns its
304879efa097SAlan Stern  * lock.
304979efa097SAlan Stern  */
305079efa097SAlan Stern int usb_reset_composite_device(struct usb_device *udev,
305179efa097SAlan Stern 		struct usb_interface *iface)
305279efa097SAlan Stern {
305379efa097SAlan Stern 	int ret;
305479efa097SAlan Stern 	struct usb_host_config *config = udev->actconfig;
305579efa097SAlan Stern 
305679efa097SAlan Stern 	if (udev->state == USB_STATE_NOTATTACHED ||
305779efa097SAlan Stern 			udev->state == USB_STATE_SUSPENDED) {
305879efa097SAlan Stern 		dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
305979efa097SAlan Stern 				udev->state);
306079efa097SAlan Stern 		return -EINVAL;
306179efa097SAlan Stern 	}
306279efa097SAlan Stern 
3063645daaabSAlan Stern 	/* Prevent autosuspend during the reset */
306494fcda1fSAlan Stern 	usb_autoresume_device(udev);
3065645daaabSAlan Stern 
306679efa097SAlan Stern 	if (iface && iface->condition != USB_INTERFACE_BINDING)
306779efa097SAlan Stern 		iface = NULL;
306879efa097SAlan Stern 
306979efa097SAlan Stern 	if (config) {
307079efa097SAlan Stern 		int i;
307179efa097SAlan Stern 		struct usb_interface *cintf;
307279efa097SAlan Stern 		struct usb_driver *drv;
307379efa097SAlan Stern 
307479efa097SAlan Stern 		for (i = 0; i < config->desc.bNumInterfaces; ++i) {
307579efa097SAlan Stern 			cintf = config->interface[i];
307679efa097SAlan Stern 			if (cintf != iface)
307779efa097SAlan Stern 				down(&cintf->dev.sem);
307879efa097SAlan Stern 			if (device_is_registered(&cintf->dev) &&
307979efa097SAlan Stern 					cintf->dev.driver) {
308079efa097SAlan Stern 				drv = to_usb_driver(cintf->dev.driver);
308179efa097SAlan Stern 				if (drv->pre_reset)
308279efa097SAlan Stern 					(drv->pre_reset)(cintf);
308379efa097SAlan Stern 			}
308479efa097SAlan Stern 		}
308579efa097SAlan Stern 	}
308679efa097SAlan Stern 
308779efa097SAlan Stern 	ret = usb_reset_device(udev);
308879efa097SAlan Stern 
308979efa097SAlan Stern 	if (config) {
309079efa097SAlan Stern 		int i;
309179efa097SAlan Stern 		struct usb_interface *cintf;
309279efa097SAlan Stern 		struct usb_driver *drv;
309379efa097SAlan Stern 
309479efa097SAlan Stern 		for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
309579efa097SAlan Stern 			cintf = config->interface[i];
309679efa097SAlan Stern 			if (device_is_registered(&cintf->dev) &&
309779efa097SAlan Stern 					cintf->dev.driver) {
309879efa097SAlan Stern 				drv = to_usb_driver(cintf->dev.driver);
309979efa097SAlan Stern 				if (drv->post_reset)
31000458d5b4SAlan Stern 					(drv->post_reset)(cintf, 0);
310179efa097SAlan Stern 			}
310279efa097SAlan Stern 			if (cintf != iface)
310379efa097SAlan Stern 				up(&cintf->dev.sem);
310479efa097SAlan Stern 		}
310579efa097SAlan Stern 	}
310679efa097SAlan Stern 
310794fcda1fSAlan Stern 	usb_autosuspend_device(udev);
310879efa097SAlan Stern 	return ret;
310979efa097SAlan Stern }
3110140d8f68SAlan Stern EXPORT_SYMBOL(usb_reset_composite_device);
3111