xref: /openbmc/linux/drivers/usb/core/hub.c (revision 1c50c317)
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/config.h>
121da177e4SLinus Torvalds #include <linux/kernel.h>
131da177e4SLinus Torvalds #include <linux/errno.h>
141da177e4SLinus Torvalds #include <linux/module.h>
151da177e4SLinus Torvalds #include <linux/moduleparam.h>
161da177e4SLinus Torvalds #include <linux/completion.h>
171da177e4SLinus Torvalds #include <linux/sched.h>
181da177e4SLinus Torvalds #include <linux/list.h>
191da177e4SLinus Torvalds #include <linux/slab.h>
201da177e4SLinus Torvalds #include <linux/smp_lock.h>
211da177e4SLinus Torvalds #include <linux/ioctl.h>
221da177e4SLinus Torvalds #include <linux/usb.h>
231da177e4SLinus Torvalds #include <linux/usbdevice_fs.h>
249c8d6178Sakpm@osdl.org #include <linux/kthread.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 
341da177e4SLinus Torvalds /* Protect struct usb_device->state and ->children members
351da177e4SLinus Torvalds  * Note: Both are also protected by ->serialize, except that ->state can
361da177e4SLinus Torvalds  * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
371da177e4SLinus Torvalds static DEFINE_SPINLOCK(device_state_lock);
381da177e4SLinus Torvalds 
391da177e4SLinus Torvalds /* khubd's worklist and its lock */
401da177e4SLinus Torvalds static DEFINE_SPINLOCK(hub_event_lock);
411da177e4SLinus Torvalds static LIST_HEAD(hub_event_list);	/* List of hubs needing servicing */
421da177e4SLinus Torvalds 
431da177e4SLinus Torvalds /* Wakes up khubd */
441da177e4SLinus Torvalds static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
451da177e4SLinus Torvalds 
469c8d6178Sakpm@osdl.org static struct task_struct *khubd_task;
471da177e4SLinus Torvalds 
481da177e4SLinus Torvalds /* cycle leds on hubs that aren't blinking for attention */
491da177e4SLinus Torvalds static int blinkenlights = 0;
501da177e4SLinus Torvalds module_param (blinkenlights, bool, S_IRUGO);
511da177e4SLinus Torvalds MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
521da177e4SLinus Torvalds 
531da177e4SLinus Torvalds /*
541da177e4SLinus Torvalds  * As of 2.6.10 we introduce a new USB device initialization scheme which
551da177e4SLinus Torvalds  * closely resembles the way Windows works.  Hopefully it will be compatible
561da177e4SLinus Torvalds  * with a wider range of devices than the old scheme.  However some previously
571da177e4SLinus Torvalds  * working devices may start giving rise to "device not accepting address"
581da177e4SLinus Torvalds  * errors; if that happens the user can try the old scheme by adjusting the
591da177e4SLinus Torvalds  * following module parameters.
601da177e4SLinus Torvalds  *
611da177e4SLinus Torvalds  * For maximum flexibility there are two boolean parameters to control the
621da177e4SLinus Torvalds  * hub driver's behavior.  On the first initialization attempt, if the
631da177e4SLinus Torvalds  * "old_scheme_first" parameter is set then the old scheme will be used,
641da177e4SLinus Torvalds  * otherwise the new scheme is used.  If that fails and "use_both_schemes"
651da177e4SLinus Torvalds  * is set, then the driver will make another attempt, using the other scheme.
661da177e4SLinus Torvalds  */
671da177e4SLinus Torvalds static int old_scheme_first = 0;
681da177e4SLinus Torvalds module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
691da177e4SLinus Torvalds MODULE_PARM_DESC(old_scheme_first,
701da177e4SLinus Torvalds 		 "start with the old device initialization scheme");
711da177e4SLinus Torvalds 
721da177e4SLinus Torvalds static int use_both_schemes = 1;
731da177e4SLinus Torvalds module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
741da177e4SLinus Torvalds MODULE_PARM_DESC(use_both_schemes,
751da177e4SLinus Torvalds 		"try the other device initialization scheme if the "
761da177e4SLinus Torvalds 		"first one fails");
771da177e4SLinus Torvalds 
781da177e4SLinus Torvalds 
791da177e4SLinus Torvalds #ifdef	DEBUG
801da177e4SLinus Torvalds static inline char *portspeed (int portstatus)
811da177e4SLinus Torvalds {
821da177e4SLinus Torvalds 	if (portstatus & (1 << USB_PORT_FEAT_HIGHSPEED))
831da177e4SLinus Torvalds     		return "480 Mb/s";
841da177e4SLinus Torvalds 	else if (portstatus & (1 << USB_PORT_FEAT_LOWSPEED))
851da177e4SLinus Torvalds 		return "1.5 Mb/s";
861da177e4SLinus Torvalds 	else
871da177e4SLinus Torvalds 		return "12 Mb/s";
881da177e4SLinus Torvalds }
891da177e4SLinus Torvalds #endif
901da177e4SLinus Torvalds 
911da177e4SLinus Torvalds /* Note that hdev or one of its children must be locked! */
921da177e4SLinus Torvalds static inline struct usb_hub *hdev_to_hub(struct usb_device *hdev)
931da177e4SLinus Torvalds {
941da177e4SLinus Torvalds 	return usb_get_intfdata(hdev->actconfig->interface[0]);
951da177e4SLinus Torvalds }
961da177e4SLinus Torvalds 
971da177e4SLinus Torvalds /* USB 2.0 spec Section 11.24.4.5 */
981da177e4SLinus Torvalds static int get_hub_descriptor(struct usb_device *hdev, void *data, int size)
991da177e4SLinus Torvalds {
1001da177e4SLinus Torvalds 	int i, ret;
1011da177e4SLinus Torvalds 
1021da177e4SLinus Torvalds 	for (i = 0; i < 3; i++) {
1031da177e4SLinus Torvalds 		ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
1041da177e4SLinus Torvalds 			USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
1051da177e4SLinus Torvalds 			USB_DT_HUB << 8, 0, data, size,
1061da177e4SLinus Torvalds 			USB_CTRL_GET_TIMEOUT);
1071da177e4SLinus Torvalds 		if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
1081da177e4SLinus Torvalds 			return ret;
1091da177e4SLinus Torvalds 	}
1101da177e4SLinus Torvalds 	return -EINVAL;
1111da177e4SLinus Torvalds }
1121da177e4SLinus Torvalds 
1131da177e4SLinus Torvalds /*
1141da177e4SLinus Torvalds  * USB 2.0 spec Section 11.24.2.1
1151da177e4SLinus Torvalds  */
1161da177e4SLinus Torvalds static int clear_hub_feature(struct usb_device *hdev, int feature)
1171da177e4SLinus Torvalds {
1181da177e4SLinus Torvalds 	return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
1191da177e4SLinus Torvalds 		USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
1201da177e4SLinus Torvalds }
1211da177e4SLinus Torvalds 
1221da177e4SLinus Torvalds /*
1231da177e4SLinus Torvalds  * USB 2.0 spec Section 11.24.2.2
1241da177e4SLinus Torvalds  */
1251da177e4SLinus Torvalds static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
1261da177e4SLinus Torvalds {
1271da177e4SLinus Torvalds 	return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
1281da177e4SLinus Torvalds 		USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
1291da177e4SLinus Torvalds 		NULL, 0, 1000);
1301da177e4SLinus Torvalds }
1311da177e4SLinus Torvalds 
1321da177e4SLinus Torvalds /*
1331da177e4SLinus Torvalds  * USB 2.0 spec Section 11.24.2.13
1341da177e4SLinus Torvalds  */
1351da177e4SLinus Torvalds static int set_port_feature(struct usb_device *hdev, int port1, int feature)
1361da177e4SLinus Torvalds {
1371da177e4SLinus Torvalds 	return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
1381da177e4SLinus Torvalds 		USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
1391da177e4SLinus Torvalds 		NULL, 0, 1000);
1401da177e4SLinus Torvalds }
1411da177e4SLinus Torvalds 
1421da177e4SLinus Torvalds /*
1431da177e4SLinus Torvalds  * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
1441da177e4SLinus Torvalds  * for info about using port indicators
1451da177e4SLinus Torvalds  */
1461da177e4SLinus Torvalds static void set_port_led(
1471da177e4SLinus Torvalds 	struct usb_hub *hub,
1481da177e4SLinus Torvalds 	int port1,
1491da177e4SLinus Torvalds 	int selector
1501da177e4SLinus Torvalds )
1511da177e4SLinus Torvalds {
1521da177e4SLinus Torvalds 	int status = set_port_feature(hub->hdev, (selector << 8) | port1,
1531da177e4SLinus Torvalds 			USB_PORT_FEAT_INDICATOR);
1541da177e4SLinus Torvalds 	if (status < 0)
1551da177e4SLinus Torvalds 		dev_dbg (hub->intfdev,
1561da177e4SLinus Torvalds 			"port %d indicator %s status %d\n",
1571da177e4SLinus Torvalds 			port1,
1581da177e4SLinus Torvalds 			({ char *s; switch (selector) {
1591da177e4SLinus Torvalds 			case HUB_LED_AMBER: s = "amber"; break;
1601da177e4SLinus Torvalds 			case HUB_LED_GREEN: s = "green"; break;
1611da177e4SLinus Torvalds 			case HUB_LED_OFF: s = "off"; break;
1621da177e4SLinus Torvalds 			case HUB_LED_AUTO: s = "auto"; break;
1631da177e4SLinus Torvalds 			default: s = "??"; break;
1641da177e4SLinus Torvalds 			}; s; }),
1651da177e4SLinus Torvalds 			status);
1661da177e4SLinus Torvalds }
1671da177e4SLinus Torvalds 
1681da177e4SLinus Torvalds #define	LED_CYCLE_PERIOD	((2*HZ)/3)
1691da177e4SLinus Torvalds 
1701da177e4SLinus Torvalds static void led_work (void *__hub)
1711da177e4SLinus Torvalds {
1721da177e4SLinus Torvalds 	struct usb_hub		*hub = __hub;
1731da177e4SLinus Torvalds 	struct usb_device	*hdev = hub->hdev;
1741da177e4SLinus Torvalds 	unsigned		i;
1751da177e4SLinus Torvalds 	unsigned		changed = 0;
1761da177e4SLinus Torvalds 	int			cursor = -1;
1771da177e4SLinus Torvalds 
1781da177e4SLinus Torvalds 	if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
1791da177e4SLinus Torvalds 		return;
1801da177e4SLinus Torvalds 
1811da177e4SLinus Torvalds 	for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
1821da177e4SLinus Torvalds 		unsigned	selector, mode;
1831da177e4SLinus Torvalds 
1841da177e4SLinus Torvalds 		/* 30%-50% duty cycle */
1851da177e4SLinus Torvalds 
1861da177e4SLinus Torvalds 		switch (hub->indicator[i]) {
1871da177e4SLinus Torvalds 		/* cycle marker */
1881da177e4SLinus Torvalds 		case INDICATOR_CYCLE:
1891da177e4SLinus Torvalds 			cursor = i;
1901da177e4SLinus Torvalds 			selector = HUB_LED_AUTO;
1911da177e4SLinus Torvalds 			mode = INDICATOR_AUTO;
1921da177e4SLinus Torvalds 			break;
1931da177e4SLinus Torvalds 		/* blinking green = sw attention */
1941da177e4SLinus Torvalds 		case INDICATOR_GREEN_BLINK:
1951da177e4SLinus Torvalds 			selector = HUB_LED_GREEN;
1961da177e4SLinus Torvalds 			mode = INDICATOR_GREEN_BLINK_OFF;
1971da177e4SLinus Torvalds 			break;
1981da177e4SLinus Torvalds 		case INDICATOR_GREEN_BLINK_OFF:
1991da177e4SLinus Torvalds 			selector = HUB_LED_OFF;
2001da177e4SLinus Torvalds 			mode = INDICATOR_GREEN_BLINK;
2011da177e4SLinus Torvalds 			break;
2021da177e4SLinus Torvalds 		/* blinking amber = hw attention */
2031da177e4SLinus Torvalds 		case INDICATOR_AMBER_BLINK:
2041da177e4SLinus Torvalds 			selector = HUB_LED_AMBER;
2051da177e4SLinus Torvalds 			mode = INDICATOR_AMBER_BLINK_OFF;
2061da177e4SLinus Torvalds 			break;
2071da177e4SLinus Torvalds 		case INDICATOR_AMBER_BLINK_OFF:
2081da177e4SLinus Torvalds 			selector = HUB_LED_OFF;
2091da177e4SLinus Torvalds 			mode = INDICATOR_AMBER_BLINK;
2101da177e4SLinus Torvalds 			break;
2111da177e4SLinus Torvalds 		/* blink green/amber = reserved */
2121da177e4SLinus Torvalds 		case INDICATOR_ALT_BLINK:
2131da177e4SLinus Torvalds 			selector = HUB_LED_GREEN;
2141da177e4SLinus Torvalds 			mode = INDICATOR_ALT_BLINK_OFF;
2151da177e4SLinus Torvalds 			break;
2161da177e4SLinus Torvalds 		case INDICATOR_ALT_BLINK_OFF:
2171da177e4SLinus Torvalds 			selector = HUB_LED_AMBER;
2181da177e4SLinus Torvalds 			mode = INDICATOR_ALT_BLINK;
2191da177e4SLinus Torvalds 			break;
2201da177e4SLinus Torvalds 		default:
2211da177e4SLinus Torvalds 			continue;
2221da177e4SLinus Torvalds 		}
2231da177e4SLinus Torvalds 		if (selector != HUB_LED_AUTO)
2241da177e4SLinus Torvalds 			changed = 1;
2251da177e4SLinus Torvalds 		set_port_led(hub, i + 1, selector);
2261da177e4SLinus Torvalds 		hub->indicator[i] = mode;
2271da177e4SLinus Torvalds 	}
2281da177e4SLinus Torvalds 	if (!changed && blinkenlights) {
2291da177e4SLinus Torvalds 		cursor++;
2301da177e4SLinus Torvalds 		cursor %= hub->descriptor->bNbrPorts;
2311da177e4SLinus Torvalds 		set_port_led(hub, cursor + 1, HUB_LED_GREEN);
2321da177e4SLinus Torvalds 		hub->indicator[cursor] = INDICATOR_CYCLE;
2331da177e4SLinus Torvalds 		changed++;
2341da177e4SLinus Torvalds 	}
2351da177e4SLinus Torvalds 	if (changed)
2361da177e4SLinus Torvalds 		schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
2371da177e4SLinus Torvalds }
2381da177e4SLinus Torvalds 
2391da177e4SLinus Torvalds /* use a short timeout for hub/port status fetches */
2401da177e4SLinus Torvalds #define	USB_STS_TIMEOUT		1000
2411da177e4SLinus Torvalds #define	USB_STS_RETRIES		5
2421da177e4SLinus Torvalds 
2431da177e4SLinus Torvalds /*
2441da177e4SLinus Torvalds  * USB 2.0 spec Section 11.24.2.6
2451da177e4SLinus Torvalds  */
2461da177e4SLinus Torvalds static int get_hub_status(struct usb_device *hdev,
2471da177e4SLinus Torvalds 		struct usb_hub_status *data)
2481da177e4SLinus Torvalds {
2491da177e4SLinus Torvalds 	int i, status = -ETIMEDOUT;
2501da177e4SLinus Torvalds 
2511da177e4SLinus Torvalds 	for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
2521da177e4SLinus Torvalds 		status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
2531da177e4SLinus Torvalds 			USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
2541da177e4SLinus Torvalds 			data, sizeof(*data), USB_STS_TIMEOUT);
2551da177e4SLinus Torvalds 	}
2561da177e4SLinus Torvalds 	return status;
2571da177e4SLinus Torvalds }
2581da177e4SLinus Torvalds 
2591da177e4SLinus Torvalds /*
2601da177e4SLinus Torvalds  * USB 2.0 spec Section 11.24.2.7
2611da177e4SLinus Torvalds  */
2621da177e4SLinus Torvalds static int get_port_status(struct usb_device *hdev, int port1,
2631da177e4SLinus Torvalds 		struct usb_port_status *data)
2641da177e4SLinus Torvalds {
2651da177e4SLinus Torvalds 	int i, status = -ETIMEDOUT;
2661da177e4SLinus Torvalds 
2671da177e4SLinus Torvalds 	for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
2681da177e4SLinus Torvalds 		status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
2691da177e4SLinus Torvalds 			USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
2701da177e4SLinus Torvalds 			data, sizeof(*data), USB_STS_TIMEOUT);
2711da177e4SLinus Torvalds 	}
2721da177e4SLinus Torvalds 	return status;
2731da177e4SLinus Torvalds }
2741da177e4SLinus Torvalds 
2751da177e4SLinus Torvalds static void kick_khubd(struct usb_hub *hub)
2761da177e4SLinus Torvalds {
2771da177e4SLinus Torvalds 	unsigned long	flags;
2781da177e4SLinus Torvalds 
2791da177e4SLinus Torvalds 	spin_lock_irqsave(&hub_event_lock, flags);
2801da177e4SLinus Torvalds 	if (list_empty(&hub->event_list)) {
2811da177e4SLinus Torvalds 		list_add_tail(&hub->event_list, &hub_event_list);
2821da177e4SLinus Torvalds 		wake_up(&khubd_wait);
2831da177e4SLinus Torvalds 	}
2841da177e4SLinus Torvalds 	spin_unlock_irqrestore(&hub_event_lock, flags);
2851da177e4SLinus Torvalds }
2861da177e4SLinus Torvalds 
2871da177e4SLinus Torvalds void usb_kick_khubd(struct usb_device *hdev)
2881da177e4SLinus Torvalds {
2891da177e4SLinus Torvalds 	kick_khubd(hdev_to_hub(hdev));
2901da177e4SLinus Torvalds }
2911da177e4SLinus Torvalds 
2921da177e4SLinus Torvalds 
2931da177e4SLinus Torvalds /* completion function, fires on port status changes and various faults */
2941da177e4SLinus Torvalds static void hub_irq(struct urb *urb, struct pt_regs *regs)
2951da177e4SLinus Torvalds {
2961da177e4SLinus Torvalds 	struct usb_hub *hub = (struct usb_hub *)urb->context;
2971da177e4SLinus Torvalds 	int status;
2981da177e4SLinus Torvalds 	int i;
2991da177e4SLinus Torvalds 	unsigned long bits;
3001da177e4SLinus Torvalds 
3011da177e4SLinus Torvalds 	switch (urb->status) {
3021da177e4SLinus Torvalds 	case -ENOENT:		/* synchronous unlink */
3031da177e4SLinus Torvalds 	case -ECONNRESET:	/* async unlink */
3041da177e4SLinus Torvalds 	case -ESHUTDOWN:	/* hardware going away */
3051da177e4SLinus Torvalds 		return;
3061da177e4SLinus Torvalds 
3071da177e4SLinus Torvalds 	default:		/* presumably an error */
3081da177e4SLinus Torvalds 		/* Cause a hub reset after 10 consecutive errors */
3091da177e4SLinus Torvalds 		dev_dbg (hub->intfdev, "transfer --> %d\n", urb->status);
3101da177e4SLinus Torvalds 		if ((++hub->nerrors < 10) || hub->error)
3111da177e4SLinus Torvalds 			goto resubmit;
3121da177e4SLinus Torvalds 		hub->error = urb->status;
3131da177e4SLinus Torvalds 		/* FALL THROUGH */
3141da177e4SLinus Torvalds 
3151da177e4SLinus Torvalds 	/* let khubd handle things */
3161da177e4SLinus Torvalds 	case 0:			/* we got data:  port status changed */
3171da177e4SLinus Torvalds 		bits = 0;
3181da177e4SLinus Torvalds 		for (i = 0; i < urb->actual_length; ++i)
3191da177e4SLinus Torvalds 			bits |= ((unsigned long) ((*hub->buffer)[i]))
3201da177e4SLinus Torvalds 					<< (i*8);
3211da177e4SLinus Torvalds 		hub->event_bits[0] = bits;
3221da177e4SLinus Torvalds 		break;
3231da177e4SLinus Torvalds 	}
3241da177e4SLinus Torvalds 
3251da177e4SLinus Torvalds 	hub->nerrors = 0;
3261da177e4SLinus Torvalds 
3271da177e4SLinus Torvalds 	/* Something happened, let khubd figure it out */
3281da177e4SLinus Torvalds 	kick_khubd(hub);
3291da177e4SLinus Torvalds 
3301da177e4SLinus Torvalds resubmit:
3311da177e4SLinus Torvalds 	if (hub->quiescing)
3321da177e4SLinus Torvalds 		return;
3331da177e4SLinus Torvalds 
3341da177e4SLinus Torvalds 	if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
3351da177e4SLinus Torvalds 			&& status != -ENODEV && status != -EPERM)
3361da177e4SLinus Torvalds 		dev_err (hub->intfdev, "resubmit --> %d\n", status);
3371da177e4SLinus Torvalds }
3381da177e4SLinus Torvalds 
3391da177e4SLinus Torvalds /* USB 2.0 spec Section 11.24.2.3 */
3401da177e4SLinus Torvalds static inline int
3411da177e4SLinus Torvalds hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
3421da177e4SLinus Torvalds {
3431da177e4SLinus Torvalds 	return usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
3441da177e4SLinus Torvalds 			       HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
3451da177e4SLinus Torvalds 			       tt, NULL, 0, 1000);
3461da177e4SLinus Torvalds }
3471da177e4SLinus Torvalds 
3481da177e4SLinus Torvalds /*
3491da177e4SLinus Torvalds  * enumeration blocks khubd for a long time. we use keventd instead, since
3501da177e4SLinus Torvalds  * long blocking there is the exception, not the rule.  accordingly, HCDs
3511da177e4SLinus Torvalds  * talking to TTs must queue control transfers (not just bulk and iso), so
3521da177e4SLinus Torvalds  * both can talk to the same hub concurrently.
3531da177e4SLinus Torvalds  */
3541da177e4SLinus Torvalds static void hub_tt_kevent (void *arg)
3551da177e4SLinus Torvalds {
3561da177e4SLinus Torvalds 	struct usb_hub		*hub = arg;
3571da177e4SLinus Torvalds 	unsigned long		flags;
3581da177e4SLinus Torvalds 
3591da177e4SLinus Torvalds 	spin_lock_irqsave (&hub->tt.lock, flags);
3601da177e4SLinus Torvalds 	while (!list_empty (&hub->tt.clear_list)) {
3611da177e4SLinus Torvalds 		struct list_head	*temp;
3621da177e4SLinus Torvalds 		struct usb_tt_clear	*clear;
3631da177e4SLinus Torvalds 		struct usb_device	*hdev = hub->hdev;
3641da177e4SLinus Torvalds 		int			status;
3651da177e4SLinus Torvalds 
3661da177e4SLinus Torvalds 		temp = hub->tt.clear_list.next;
3671da177e4SLinus Torvalds 		clear = list_entry (temp, struct usb_tt_clear, clear_list);
3681da177e4SLinus Torvalds 		list_del (&clear->clear_list);
3691da177e4SLinus Torvalds 
3701da177e4SLinus Torvalds 		/* drop lock so HCD can concurrently report other TT errors */
3711da177e4SLinus Torvalds 		spin_unlock_irqrestore (&hub->tt.lock, flags);
3721da177e4SLinus Torvalds 		status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
3731da177e4SLinus Torvalds 		spin_lock_irqsave (&hub->tt.lock, flags);
3741da177e4SLinus Torvalds 
3751da177e4SLinus Torvalds 		if (status)
3761da177e4SLinus Torvalds 			dev_err (&hdev->dev,
3771da177e4SLinus Torvalds 				"clear tt %d (%04x) error %d\n",
3781da177e4SLinus Torvalds 				clear->tt, clear->devinfo, status);
3791da177e4SLinus Torvalds 		kfree(clear);
3801da177e4SLinus Torvalds 	}
3811da177e4SLinus Torvalds 	spin_unlock_irqrestore (&hub->tt.lock, flags);
3821da177e4SLinus Torvalds }
3831da177e4SLinus Torvalds 
3841da177e4SLinus Torvalds /**
3851da177e4SLinus Torvalds  * usb_hub_tt_clear_buffer - clear control/bulk TT state in high speed hub
3861da177e4SLinus Torvalds  * @udev: the device whose split transaction failed
3871da177e4SLinus Torvalds  * @pipe: identifies the endpoint of the failed transaction
3881da177e4SLinus Torvalds  *
3891da177e4SLinus Torvalds  * High speed HCDs use this to tell the hub driver that some split control or
3901da177e4SLinus Torvalds  * bulk transaction failed in a way that requires clearing internal state of
3911da177e4SLinus Torvalds  * a transaction translator.  This is normally detected (and reported) from
3921da177e4SLinus Torvalds  * interrupt context.
3931da177e4SLinus Torvalds  *
3941da177e4SLinus Torvalds  * It may not be possible for that hub to handle additional full (or low)
3951da177e4SLinus Torvalds  * speed transactions until that state is fully cleared out.
3961da177e4SLinus Torvalds  */
3971da177e4SLinus Torvalds void usb_hub_tt_clear_buffer (struct usb_device *udev, int pipe)
3981da177e4SLinus Torvalds {
3991da177e4SLinus Torvalds 	struct usb_tt		*tt = udev->tt;
4001da177e4SLinus Torvalds 	unsigned long		flags;
4011da177e4SLinus Torvalds 	struct usb_tt_clear	*clear;
4021da177e4SLinus Torvalds 
4031da177e4SLinus Torvalds 	/* we've got to cope with an arbitrary number of pending TT clears,
4041da177e4SLinus Torvalds 	 * since each TT has "at least two" buffers that can need it (and
4051da177e4SLinus Torvalds 	 * there can be many TTs per hub).  even if they're uncommon.
4061da177e4SLinus Torvalds 	 */
4071da177e4SLinus Torvalds 	if ((clear = kmalloc (sizeof *clear, SLAB_ATOMIC)) == NULL) {
4081da177e4SLinus Torvalds 		dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
4091da177e4SLinus Torvalds 		/* FIXME recover somehow ... RESET_TT? */
4101da177e4SLinus Torvalds 		return;
4111da177e4SLinus Torvalds 	}
4121da177e4SLinus Torvalds 
4131da177e4SLinus Torvalds 	/* info that CLEAR_TT_BUFFER needs */
4141da177e4SLinus Torvalds 	clear->tt = tt->multi ? udev->ttport : 1;
4151da177e4SLinus Torvalds 	clear->devinfo = usb_pipeendpoint (pipe);
4161da177e4SLinus Torvalds 	clear->devinfo |= udev->devnum << 4;
4171da177e4SLinus Torvalds 	clear->devinfo |= usb_pipecontrol (pipe)
4181da177e4SLinus Torvalds 			? (USB_ENDPOINT_XFER_CONTROL << 11)
4191da177e4SLinus Torvalds 			: (USB_ENDPOINT_XFER_BULK << 11);
4201da177e4SLinus Torvalds 	if (usb_pipein (pipe))
4211da177e4SLinus Torvalds 		clear->devinfo |= 1 << 15;
4221da177e4SLinus Torvalds 
4231da177e4SLinus Torvalds 	/* tell keventd to clear state for this TT */
4241da177e4SLinus Torvalds 	spin_lock_irqsave (&tt->lock, flags);
4251da177e4SLinus Torvalds 	list_add_tail (&clear->clear_list, &tt->clear_list);
4261da177e4SLinus Torvalds 	schedule_work (&tt->kevent);
4271da177e4SLinus Torvalds 	spin_unlock_irqrestore (&tt->lock, flags);
4281da177e4SLinus Torvalds }
4291da177e4SLinus Torvalds 
4301da177e4SLinus Torvalds static void hub_power_on(struct usb_hub *hub)
4311da177e4SLinus Torvalds {
4321da177e4SLinus Torvalds 	int port1;
433b789696aSDavid Brownell 	unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
43474ad9bd2SGreg Kroah-Hartman 	u16 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
4351da177e4SLinus Torvalds 
4361da177e4SLinus Torvalds 	/* if hub supports power switching, enable power on each port */
43774ad9bd2SGreg Kroah-Hartman 	if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2) {
4381da177e4SLinus Torvalds 		dev_dbg(hub->intfdev, "enabling power on all ports\n");
4391da177e4SLinus Torvalds 		for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
4401da177e4SLinus Torvalds 			set_port_feature(hub->hdev, port1,
4411da177e4SLinus Torvalds 					USB_PORT_FEAT_POWER);
4421da177e4SLinus Torvalds 	}
4431da177e4SLinus Torvalds 
444b789696aSDavid Brownell 	/* Wait at least 100 msec for power to become stable */
445b789696aSDavid Brownell 	msleep(max(pgood_delay, (unsigned) 100));
4461da177e4SLinus Torvalds }
4471da177e4SLinus Torvalds 
448979d5199SDavid Brownell static inline void __hub_quiesce(struct usb_hub *hub)
4491da177e4SLinus Torvalds {
450979d5199SDavid Brownell 	/* (nonblocking) khubd and related activity won't re-trigger */
4511da177e4SLinus Torvalds 	hub->quiescing = 1;
452c9f89fa4SDavid Brownell 	hub->activating = 0;
453979d5199SDavid Brownell 	hub->resume_root_hub = 0;
454979d5199SDavid Brownell }
455979d5199SDavid Brownell 
456979d5199SDavid Brownell static void hub_quiesce(struct usb_hub *hub)
457979d5199SDavid Brownell {
458979d5199SDavid Brownell 	/* (blocking) stop khubd and related activity */
459979d5199SDavid Brownell 	__hub_quiesce(hub);
4601da177e4SLinus Torvalds 	usb_kill_urb(hub->urb);
4611da177e4SLinus Torvalds 	if (hub->has_indicators)
4621da177e4SLinus Torvalds 		cancel_delayed_work(&hub->leds);
4631da177e4SLinus Torvalds 	if (hub->has_indicators || hub->tt.hub)
4641da177e4SLinus Torvalds 		flush_scheduled_work();
4651da177e4SLinus Torvalds }
4661da177e4SLinus Torvalds 
4671da177e4SLinus Torvalds static void hub_activate(struct usb_hub *hub)
4681da177e4SLinus Torvalds {
4691da177e4SLinus Torvalds 	int	status;
4701da177e4SLinus Torvalds 
4711da177e4SLinus Torvalds 	hub->quiescing = 0;
4721da177e4SLinus Torvalds 	hub->activating = 1;
473979d5199SDavid Brownell 	hub->resume_root_hub = 0;
4741da177e4SLinus Torvalds 	status = usb_submit_urb(hub->urb, GFP_NOIO);
4751da177e4SLinus Torvalds 	if (status < 0)
4761da177e4SLinus Torvalds 		dev_err(hub->intfdev, "activate --> %d\n", status);
4771da177e4SLinus Torvalds 	if (hub->has_indicators && blinkenlights)
4781da177e4SLinus Torvalds 		schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
4791da177e4SLinus Torvalds 
4801da177e4SLinus Torvalds 	/* scan all ports ASAP */
4811da177e4SLinus Torvalds 	kick_khubd(hub);
4821da177e4SLinus Torvalds }
4831da177e4SLinus Torvalds 
4841da177e4SLinus Torvalds static int hub_hub_status(struct usb_hub *hub,
4851da177e4SLinus Torvalds 		u16 *status, u16 *change)
4861da177e4SLinus Torvalds {
4871da177e4SLinus Torvalds 	int ret;
4881da177e4SLinus Torvalds 
4891da177e4SLinus Torvalds 	ret = get_hub_status(hub->hdev, &hub->status->hub);
4901da177e4SLinus Torvalds 	if (ret < 0)
4911da177e4SLinus Torvalds 		dev_err (hub->intfdev,
4921da177e4SLinus Torvalds 			"%s failed (err = %d)\n", __FUNCTION__, ret);
4931da177e4SLinus Torvalds 	else {
4941da177e4SLinus Torvalds 		*status = le16_to_cpu(hub->status->hub.wHubStatus);
4951da177e4SLinus Torvalds 		*change = le16_to_cpu(hub->status->hub.wHubChange);
4961da177e4SLinus Torvalds 		ret = 0;
4971da177e4SLinus Torvalds 	}
4981da177e4SLinus Torvalds 	return ret;
4991da177e4SLinus Torvalds }
5001da177e4SLinus Torvalds 
5018b28c752SAlan Stern static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
5028b28c752SAlan Stern {
5038b28c752SAlan Stern 	struct usb_device *hdev = hub->hdev;
5048b28c752SAlan Stern 	int ret;
5058b28c752SAlan Stern 
5068b28c752SAlan Stern 	if (hdev->children[port1-1] && set_state) {
5078b28c752SAlan Stern 		usb_set_device_state(hdev->children[port1-1],
5088b28c752SAlan Stern 				USB_STATE_NOTATTACHED);
5098b28c752SAlan Stern 	}
5108b28c752SAlan Stern 	ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
5118b28c752SAlan Stern 	if (ret)
5128b28c752SAlan Stern 		dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
5138b28c752SAlan Stern 			port1, ret);
5148b28c752SAlan Stern 
5158b28c752SAlan Stern 	return ret;
5168b28c752SAlan Stern }
5178b28c752SAlan Stern 
5181da177e4SLinus Torvalds static int hub_configure(struct usb_hub *hub,
5191da177e4SLinus Torvalds 	struct usb_endpoint_descriptor *endpoint)
5201da177e4SLinus Torvalds {
5211da177e4SLinus Torvalds 	struct usb_device *hdev = hub->hdev;
5221da177e4SLinus Torvalds 	struct device *hub_dev = hub->intfdev;
5231da177e4SLinus Torvalds 	u16 hubstatus, hubchange;
52474ad9bd2SGreg Kroah-Hartman 	u16 wHubCharacteristics;
5251da177e4SLinus Torvalds 	unsigned int pipe;
5261da177e4SLinus Torvalds 	int maxp, ret;
5271da177e4SLinus Torvalds 	char *message;
5281da177e4SLinus Torvalds 
5291da177e4SLinus Torvalds 	hub->buffer = usb_buffer_alloc(hdev, sizeof(*hub->buffer), GFP_KERNEL,
5301da177e4SLinus Torvalds 			&hub->buffer_dma);
5311da177e4SLinus Torvalds 	if (!hub->buffer) {
5321da177e4SLinus Torvalds 		message = "can't allocate hub irq buffer";
5331da177e4SLinus Torvalds 		ret = -ENOMEM;
5341da177e4SLinus Torvalds 		goto fail;
5351da177e4SLinus Torvalds 	}
5361da177e4SLinus Torvalds 
5371da177e4SLinus Torvalds 	hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
5381da177e4SLinus Torvalds 	if (!hub->status) {
5391da177e4SLinus Torvalds 		message = "can't kmalloc hub status buffer";
5401da177e4SLinus Torvalds 		ret = -ENOMEM;
5411da177e4SLinus Torvalds 		goto fail;
5421da177e4SLinus Torvalds 	}
5431da177e4SLinus Torvalds 
5441da177e4SLinus Torvalds 	hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
5451da177e4SLinus Torvalds 	if (!hub->descriptor) {
5461da177e4SLinus Torvalds 		message = "can't kmalloc hub descriptor";
5471da177e4SLinus Torvalds 		ret = -ENOMEM;
5481da177e4SLinus Torvalds 		goto fail;
5491da177e4SLinus Torvalds 	}
5501da177e4SLinus Torvalds 
5511da177e4SLinus Torvalds 	/* Request the entire hub descriptor.
5521da177e4SLinus Torvalds 	 * hub->descriptor can handle USB_MAXCHILDREN ports,
5531da177e4SLinus Torvalds 	 * but the hub can/will return fewer bytes here.
5541da177e4SLinus Torvalds 	 */
5551da177e4SLinus Torvalds 	ret = get_hub_descriptor(hdev, hub->descriptor,
5561da177e4SLinus Torvalds 			sizeof(*hub->descriptor));
5571da177e4SLinus Torvalds 	if (ret < 0) {
5581da177e4SLinus Torvalds 		message = "can't read hub descriptor";
5591da177e4SLinus Torvalds 		goto fail;
5601da177e4SLinus Torvalds 	} else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
5611da177e4SLinus Torvalds 		message = "hub has too many ports!";
5621da177e4SLinus Torvalds 		ret = -ENODEV;
5631da177e4SLinus Torvalds 		goto fail;
5641da177e4SLinus Torvalds 	}
5651da177e4SLinus Torvalds 
5661da177e4SLinus Torvalds 	hdev->maxchild = hub->descriptor->bNbrPorts;
5671da177e4SLinus Torvalds 	dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
5681da177e4SLinus Torvalds 		(hdev->maxchild == 1) ? "" : "s");
5691da177e4SLinus Torvalds 
57074ad9bd2SGreg Kroah-Hartman 	wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
5711da177e4SLinus Torvalds 
57274ad9bd2SGreg Kroah-Hartman 	if (wHubCharacteristics & HUB_CHAR_COMPOUND) {
5731da177e4SLinus Torvalds 		int	i;
5741da177e4SLinus Torvalds 		char	portstr [USB_MAXCHILDREN + 1];
5751da177e4SLinus Torvalds 
5761da177e4SLinus Torvalds 		for (i = 0; i < hdev->maxchild; i++)
5771da177e4SLinus Torvalds 			portstr[i] = hub->descriptor->DeviceRemovable
5781da177e4SLinus Torvalds 				    [((i + 1) / 8)] & (1 << ((i + 1) % 8))
5791da177e4SLinus Torvalds 				? 'F' : 'R';
5801da177e4SLinus Torvalds 		portstr[hdev->maxchild] = 0;
5811da177e4SLinus Torvalds 		dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
5821da177e4SLinus Torvalds 	} else
5831da177e4SLinus Torvalds 		dev_dbg(hub_dev, "standalone hub\n");
5841da177e4SLinus Torvalds 
58574ad9bd2SGreg Kroah-Hartman 	switch (wHubCharacteristics & HUB_CHAR_LPSM) {
5861da177e4SLinus Torvalds 		case 0x00:
5871da177e4SLinus Torvalds 			dev_dbg(hub_dev, "ganged power switching\n");
5881da177e4SLinus Torvalds 			break;
5891da177e4SLinus Torvalds 		case 0x01:
5901da177e4SLinus Torvalds 			dev_dbg(hub_dev, "individual port power switching\n");
5911da177e4SLinus Torvalds 			break;
5921da177e4SLinus Torvalds 		case 0x02:
5931da177e4SLinus Torvalds 		case 0x03:
5941da177e4SLinus Torvalds 			dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
5951da177e4SLinus Torvalds 			break;
5961da177e4SLinus Torvalds 	}
5971da177e4SLinus Torvalds 
59874ad9bd2SGreg Kroah-Hartman 	switch (wHubCharacteristics & HUB_CHAR_OCPM) {
5991da177e4SLinus Torvalds 		case 0x00:
6001da177e4SLinus Torvalds 			dev_dbg(hub_dev, "global over-current protection\n");
6011da177e4SLinus Torvalds 			break;
6021da177e4SLinus Torvalds 		case 0x08:
6031da177e4SLinus Torvalds 			dev_dbg(hub_dev, "individual port over-current protection\n");
6041da177e4SLinus Torvalds 			break;
6051da177e4SLinus Torvalds 		case 0x10:
6061da177e4SLinus Torvalds 		case 0x18:
6071da177e4SLinus Torvalds 			dev_dbg(hub_dev, "no over-current protection\n");
6081da177e4SLinus Torvalds                         break;
6091da177e4SLinus Torvalds 	}
6101da177e4SLinus Torvalds 
6111da177e4SLinus Torvalds 	spin_lock_init (&hub->tt.lock);
6121da177e4SLinus Torvalds 	INIT_LIST_HEAD (&hub->tt.clear_list);
6131da177e4SLinus Torvalds 	INIT_WORK (&hub->tt.kevent, hub_tt_kevent, hub);
6141da177e4SLinus Torvalds 	switch (hdev->descriptor.bDeviceProtocol) {
6151da177e4SLinus Torvalds 		case 0:
6161da177e4SLinus Torvalds 			break;
6171da177e4SLinus Torvalds 		case 1:
6181da177e4SLinus Torvalds 			dev_dbg(hub_dev, "Single TT\n");
6191da177e4SLinus Torvalds 			hub->tt.hub = hdev;
6201da177e4SLinus Torvalds 			break;
6211da177e4SLinus Torvalds 		case 2:
6221da177e4SLinus Torvalds 			ret = usb_set_interface(hdev, 0, 1);
6231da177e4SLinus Torvalds 			if (ret == 0) {
6241da177e4SLinus Torvalds 				dev_dbg(hub_dev, "TT per port\n");
6251da177e4SLinus Torvalds 				hub->tt.multi = 1;
6261da177e4SLinus Torvalds 			} else
6271da177e4SLinus Torvalds 				dev_err(hub_dev, "Using single TT (err %d)\n",
6281da177e4SLinus Torvalds 					ret);
6291da177e4SLinus Torvalds 			hub->tt.hub = hdev;
6301da177e4SLinus Torvalds 			break;
6311da177e4SLinus Torvalds 		default:
6321da177e4SLinus Torvalds 			dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
6331da177e4SLinus Torvalds 				hdev->descriptor.bDeviceProtocol);
6341da177e4SLinus Torvalds 			break;
6351da177e4SLinus Torvalds 	}
6361da177e4SLinus Torvalds 
637e09711aeSdavid-b@pacbell.net 	/* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
63874ad9bd2SGreg Kroah-Hartman 	switch (wHubCharacteristics & HUB_CHAR_TTTT) {
639e09711aeSdavid-b@pacbell.net 		case HUB_TTTT_8_BITS:
640e09711aeSdavid-b@pacbell.net 			if (hdev->descriptor.bDeviceProtocol != 0) {
641e09711aeSdavid-b@pacbell.net 				hub->tt.think_time = 666;
642e09711aeSdavid-b@pacbell.net 				dev_dbg(hub_dev, "TT requires at most %d "
643e09711aeSdavid-b@pacbell.net 						"FS bit times (%d ns)\n",
644e09711aeSdavid-b@pacbell.net 					8, hub->tt.think_time);
645e09711aeSdavid-b@pacbell.net 			}
6461da177e4SLinus Torvalds 			break;
647e09711aeSdavid-b@pacbell.net 		case HUB_TTTT_16_BITS:
648e09711aeSdavid-b@pacbell.net 			hub->tt.think_time = 666 * 2;
649e09711aeSdavid-b@pacbell.net 			dev_dbg(hub_dev, "TT requires at most %d "
650e09711aeSdavid-b@pacbell.net 					"FS bit times (%d ns)\n",
651e09711aeSdavid-b@pacbell.net 				16, hub->tt.think_time);
6521da177e4SLinus Torvalds 			break;
653e09711aeSdavid-b@pacbell.net 		case HUB_TTTT_24_BITS:
654e09711aeSdavid-b@pacbell.net 			hub->tt.think_time = 666 * 3;
655e09711aeSdavid-b@pacbell.net 			dev_dbg(hub_dev, "TT requires at most %d "
656e09711aeSdavid-b@pacbell.net 					"FS bit times (%d ns)\n",
657e09711aeSdavid-b@pacbell.net 				24, hub->tt.think_time);
6581da177e4SLinus Torvalds 			break;
659e09711aeSdavid-b@pacbell.net 		case HUB_TTTT_32_BITS:
660e09711aeSdavid-b@pacbell.net 			hub->tt.think_time = 666 * 4;
661e09711aeSdavid-b@pacbell.net 			dev_dbg(hub_dev, "TT requires at most %d "
662e09711aeSdavid-b@pacbell.net 					"FS bit times (%d ns)\n",
663e09711aeSdavid-b@pacbell.net 				32, hub->tt.think_time);
6641da177e4SLinus Torvalds 			break;
6651da177e4SLinus Torvalds 	}
6661da177e4SLinus Torvalds 
6671da177e4SLinus Torvalds 	/* probe() zeroes hub->indicator[] */
66874ad9bd2SGreg Kroah-Hartman 	if (wHubCharacteristics & HUB_CHAR_PORTIND) {
6691da177e4SLinus Torvalds 		hub->has_indicators = 1;
6701da177e4SLinus Torvalds 		dev_dbg(hub_dev, "Port indicators are supported\n");
6711da177e4SLinus Torvalds 	}
6721da177e4SLinus Torvalds 
6731da177e4SLinus Torvalds 	dev_dbg(hub_dev, "power on to power good time: %dms\n",
6741da177e4SLinus Torvalds 		hub->descriptor->bPwrOn2PwrGood * 2);
6751da177e4SLinus Torvalds 
6761da177e4SLinus Torvalds 	/* power budgeting mostly matters with bus-powered hubs,
6771da177e4SLinus Torvalds 	 * and battery-powered root hubs (may provide just 8 mA).
6781da177e4SLinus Torvalds 	 */
6791da177e4SLinus Torvalds 	ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
6801da177e4SLinus Torvalds 	if (ret < 0) {
6811da177e4SLinus Torvalds 		message = "can't get hub status";
6821da177e4SLinus Torvalds 		goto fail;
6831da177e4SLinus Torvalds 	}
6847d35b929SAlan Stern 	le16_to_cpus(&hubstatus);
6857d35b929SAlan Stern 	if (hdev == hdev->bus->root_hub) {
6867d35b929SAlan Stern 		struct usb_hcd *hcd =
6877d35b929SAlan Stern 				container_of(hdev->bus, struct usb_hcd, self);
6887d35b929SAlan Stern 
6897d35b929SAlan Stern 		hub->power_budget = min(500u, hcd->power_budget) / 2;
6907d35b929SAlan Stern 	} else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
6911da177e4SLinus Torvalds 		dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
6921da177e4SLinus Torvalds 			hub->descriptor->bHubContrCurrent);
6931da177e4SLinus Torvalds 		hub->power_budget = (501 - hub->descriptor->bHubContrCurrent)
6941da177e4SLinus Torvalds 					/ 2;
6957d35b929SAlan Stern 	}
6967d35b929SAlan Stern 	if (hub->power_budget)
6971da177e4SLinus Torvalds 		dev_dbg(hub_dev, "%dmA bus power budget for children\n",
6981da177e4SLinus Torvalds 			hub->power_budget * 2);
6991da177e4SLinus Torvalds 
7001da177e4SLinus Torvalds 
7011da177e4SLinus Torvalds 	ret = hub_hub_status(hub, &hubstatus, &hubchange);
7021da177e4SLinus Torvalds 	if (ret < 0) {
7031da177e4SLinus Torvalds 		message = "can't get hub status";
7041da177e4SLinus Torvalds 		goto fail;
7051da177e4SLinus Torvalds 	}
7061da177e4SLinus Torvalds 
7071da177e4SLinus Torvalds 	/* local power status reports aren't always correct */
7081da177e4SLinus Torvalds 	if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
7091da177e4SLinus Torvalds 		dev_dbg(hub_dev, "local power source is %s\n",
7101da177e4SLinus Torvalds 			(hubstatus & HUB_STATUS_LOCAL_POWER)
7111da177e4SLinus Torvalds 			? "lost (inactive)" : "good");
7121da177e4SLinus Torvalds 
71374ad9bd2SGreg Kroah-Hartman 	if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
7141da177e4SLinus Torvalds 		dev_dbg(hub_dev, "%sover-current condition exists\n",
7151da177e4SLinus Torvalds 			(hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
7161da177e4SLinus Torvalds 
7171da177e4SLinus Torvalds 	/* set up the interrupt endpoint */
7181da177e4SLinus Torvalds 	pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
7191da177e4SLinus Torvalds 	maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
7201da177e4SLinus Torvalds 
7211da177e4SLinus Torvalds 	if (maxp > sizeof(*hub->buffer))
7221da177e4SLinus Torvalds 		maxp = sizeof(*hub->buffer);
7231da177e4SLinus Torvalds 
7241da177e4SLinus Torvalds 	hub->urb = usb_alloc_urb(0, GFP_KERNEL);
7251da177e4SLinus Torvalds 	if (!hub->urb) {
7261da177e4SLinus Torvalds 		message = "couldn't allocate interrupt urb";
7271da177e4SLinus Torvalds 		ret = -ENOMEM;
7281da177e4SLinus Torvalds 		goto fail;
7291da177e4SLinus Torvalds 	}
7301da177e4SLinus Torvalds 
7311da177e4SLinus Torvalds 	usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
7321da177e4SLinus Torvalds 		hub, endpoint->bInterval);
7331da177e4SLinus Torvalds 	hub->urb->transfer_dma = hub->buffer_dma;
7341da177e4SLinus Torvalds 	hub->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
7351da177e4SLinus Torvalds 
7361da177e4SLinus Torvalds 	/* maybe cycle the hub leds */
7371da177e4SLinus Torvalds 	if (hub->has_indicators && blinkenlights)
7381da177e4SLinus Torvalds 		hub->indicator [0] = INDICATOR_CYCLE;
7391da177e4SLinus Torvalds 
7401da177e4SLinus Torvalds 	hub_power_on(hub);
7411da177e4SLinus Torvalds 	hub_activate(hub);
7421da177e4SLinus Torvalds 	return 0;
7431da177e4SLinus Torvalds 
7441da177e4SLinus Torvalds fail:
7451da177e4SLinus Torvalds 	dev_err (hub_dev, "config failed, %s (err %d)\n",
7461da177e4SLinus Torvalds 			message, ret);
7471da177e4SLinus Torvalds 	/* hub_disconnect() frees urb and descriptor */
7481da177e4SLinus Torvalds 	return ret;
7491da177e4SLinus Torvalds }
7501da177e4SLinus Torvalds 
7511da177e4SLinus Torvalds static unsigned highspeed_hubs;
7521da177e4SLinus Torvalds 
753bf193d3cSAlan Stern /* Called after the hub driver is unbound from a hub with children */
754bf193d3cSAlan Stern static void hub_remove_children_work(void *__hub)
755bf193d3cSAlan Stern {
756bf193d3cSAlan Stern 	struct usb_hub		*hub = __hub;
757bf193d3cSAlan Stern 	struct usb_device	*hdev = hub->hdev;
758bf193d3cSAlan Stern 	int			i;
759bf193d3cSAlan Stern 
760bf193d3cSAlan Stern 	kfree(hub);
761bf193d3cSAlan Stern 
762bf193d3cSAlan Stern 	usb_lock_device(hdev);
763bf193d3cSAlan Stern 	for (i = 0; i < hdev->maxchild; ++i) {
764bf193d3cSAlan Stern 		if (hdev->children[i])
765bf193d3cSAlan Stern 			usb_disconnect(&hdev->children[i]);
766bf193d3cSAlan Stern 	}
767bf193d3cSAlan Stern 	usb_unlock_device(hdev);
768bf193d3cSAlan Stern 	usb_put_dev(hdev);
769bf193d3cSAlan Stern }
770bf193d3cSAlan Stern 
7711da177e4SLinus Torvalds static void hub_disconnect(struct usb_interface *intf)
7721da177e4SLinus Torvalds {
7731da177e4SLinus Torvalds 	struct usb_hub *hub = usb_get_intfdata (intf);
7741da177e4SLinus Torvalds 	struct usb_device *hdev;
775bf193d3cSAlan Stern 	int n, port1;
7761da177e4SLinus Torvalds 
7778b28c752SAlan Stern 	usb_set_intfdata (intf, NULL);
7781da177e4SLinus Torvalds 	hdev = hub->hdev;
7791da177e4SLinus Torvalds 
7801da177e4SLinus Torvalds 	if (hdev->speed == USB_SPEED_HIGH)
7811da177e4SLinus Torvalds 		highspeed_hubs--;
7821da177e4SLinus Torvalds 
7831da177e4SLinus Torvalds 	hub_quiesce(hub);
7841da177e4SLinus Torvalds 	usb_free_urb(hub->urb);
7851da177e4SLinus Torvalds 	hub->urb = NULL;
7861da177e4SLinus Torvalds 
7871da177e4SLinus Torvalds 	spin_lock_irq(&hub_event_lock);
7881da177e4SLinus Torvalds 	list_del_init(&hub->event_list);
7891da177e4SLinus Torvalds 	spin_unlock_irq(&hub_event_lock);
7901da177e4SLinus Torvalds 
7911da177e4SLinus Torvalds 	kfree(hub->descriptor);
7921da177e4SLinus Torvalds 	hub->descriptor = NULL;
7931da177e4SLinus Torvalds 
7941da177e4SLinus Torvalds 	kfree(hub->status);
7951da177e4SLinus Torvalds 	hub->status = NULL;
7961da177e4SLinus Torvalds 
7971da177e4SLinus Torvalds 	if (hub->buffer) {
7981da177e4SLinus Torvalds 		usb_buffer_free(hdev, sizeof(*hub->buffer), hub->buffer,
7991da177e4SLinus Torvalds 				hub->buffer_dma);
8001da177e4SLinus Torvalds 		hub->buffer = NULL;
8011da177e4SLinus Torvalds 	}
8021da177e4SLinus Torvalds 
803bf193d3cSAlan Stern 	/* If there are any children then this is an unbind only, not a
804bf193d3cSAlan Stern 	 * physical disconnection.  The active ports must be disabled
805bf193d3cSAlan Stern 	 * and later on we must call usb_disconnect().  We can't call
806bf193d3cSAlan Stern 	 * it now because we may not hold the hub's device lock.
807bf193d3cSAlan Stern 	 */
808bf193d3cSAlan Stern 	n = 0;
809bf193d3cSAlan Stern 	for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
810bf193d3cSAlan Stern 		if (hdev->children[port1 - 1]) {
811bf193d3cSAlan Stern 			++n;
812bf193d3cSAlan Stern 			hub_port_disable(hub, port1, 1);
813bf193d3cSAlan Stern 		}
814bf193d3cSAlan Stern 	}
815bf193d3cSAlan Stern 
816bf193d3cSAlan Stern 	if (n == 0)
8171da177e4SLinus Torvalds 		kfree(hub);
818bf193d3cSAlan Stern 	else {
819bf193d3cSAlan Stern 		/* Reuse the hub->leds work_struct for our own purposes */
820bf193d3cSAlan Stern 		INIT_WORK(&hub->leds, hub_remove_children_work, hub);
821bf193d3cSAlan Stern 		schedule_work(&hub->leds);
822bf193d3cSAlan Stern 		usb_get_dev(hdev);
823bf193d3cSAlan Stern 	}
8241da177e4SLinus Torvalds }
8251da177e4SLinus Torvalds 
8261da177e4SLinus Torvalds static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
8271da177e4SLinus Torvalds {
8281da177e4SLinus Torvalds 	struct usb_host_interface *desc;
8291da177e4SLinus Torvalds 	struct usb_endpoint_descriptor *endpoint;
8301da177e4SLinus Torvalds 	struct usb_device *hdev;
8311da177e4SLinus Torvalds 	struct usb_hub *hub;
8321da177e4SLinus Torvalds 
8331da177e4SLinus Torvalds 	desc = intf->cur_altsetting;
8341da177e4SLinus Torvalds 	hdev = interface_to_usbdev(intf);
8351da177e4SLinus Torvalds 
8361da177e4SLinus Torvalds 	/* Some hubs have a subclass of 1, which AFAICT according to the */
8371da177e4SLinus Torvalds 	/*  specs is not defined, but it works */
8381da177e4SLinus Torvalds 	if ((desc->desc.bInterfaceSubClass != 0) &&
8391da177e4SLinus Torvalds 	    (desc->desc.bInterfaceSubClass != 1)) {
8401da177e4SLinus Torvalds descriptor_error:
8411da177e4SLinus Torvalds 		dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
8421da177e4SLinus Torvalds 		return -EIO;
8431da177e4SLinus Torvalds 	}
8441da177e4SLinus Torvalds 
8451da177e4SLinus Torvalds 	/* Multiple endpoints? What kind of mutant ninja-hub is this? */
8461da177e4SLinus Torvalds 	if (desc->desc.bNumEndpoints != 1)
8471da177e4SLinus Torvalds 		goto descriptor_error;
8481da177e4SLinus Torvalds 
8491da177e4SLinus Torvalds 	endpoint = &desc->endpoint[0].desc;
8501da177e4SLinus Torvalds 
8511da177e4SLinus Torvalds 	/* Output endpoint? Curiouser and curiouser.. */
8521da177e4SLinus Torvalds 	if (!(endpoint->bEndpointAddress & USB_DIR_IN))
8531da177e4SLinus Torvalds 		goto descriptor_error;
8541da177e4SLinus Torvalds 
8551da177e4SLinus Torvalds 	/* If it's not an interrupt endpoint, we'd better punt! */
8561da177e4SLinus Torvalds 	if ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
8571da177e4SLinus Torvalds 			!= USB_ENDPOINT_XFER_INT)
8581da177e4SLinus Torvalds 		goto descriptor_error;
8591da177e4SLinus Torvalds 
8601da177e4SLinus Torvalds 	/* We found a hub */
8611da177e4SLinus Torvalds 	dev_info (&intf->dev, "USB hub found\n");
8621da177e4SLinus Torvalds 
8630a1ef3b5SAlan Stern 	hub = kzalloc(sizeof(*hub), GFP_KERNEL);
8641da177e4SLinus Torvalds 	if (!hub) {
8651da177e4SLinus Torvalds 		dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
8661da177e4SLinus Torvalds 		return -ENOMEM;
8671da177e4SLinus Torvalds 	}
8681da177e4SLinus Torvalds 
8691da177e4SLinus Torvalds 	INIT_LIST_HEAD(&hub->event_list);
8701da177e4SLinus Torvalds 	hub->intfdev = &intf->dev;
8711da177e4SLinus Torvalds 	hub->hdev = hdev;
8721da177e4SLinus Torvalds 	INIT_WORK(&hub->leds, led_work, hub);
8731da177e4SLinus Torvalds 
8741da177e4SLinus Torvalds 	usb_set_intfdata (intf, hub);
8751da177e4SLinus Torvalds 
8761da177e4SLinus Torvalds 	if (hdev->speed == USB_SPEED_HIGH)
8771da177e4SLinus Torvalds 		highspeed_hubs++;
8781da177e4SLinus Torvalds 
8791da177e4SLinus Torvalds 	if (hub_configure(hub, endpoint) >= 0)
8801da177e4SLinus Torvalds 		return 0;
8811da177e4SLinus Torvalds 
8821da177e4SLinus Torvalds 	hub_disconnect (intf);
8831da177e4SLinus Torvalds 	return -ENODEV;
8841da177e4SLinus Torvalds }
8851da177e4SLinus Torvalds 
8861da177e4SLinus Torvalds static int
8871da177e4SLinus Torvalds hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
8881da177e4SLinus Torvalds {
8891da177e4SLinus Torvalds 	struct usb_device *hdev = interface_to_usbdev (intf);
8901da177e4SLinus Torvalds 
8911da177e4SLinus Torvalds 	/* assert ifno == 0 (part of hub spec) */
8921da177e4SLinus Torvalds 	switch (code) {
8931da177e4SLinus Torvalds 	case USBDEVFS_HUB_PORTINFO: {
8941da177e4SLinus Torvalds 		struct usbdevfs_hub_portinfo *info = user_data;
8951da177e4SLinus Torvalds 		int i;
8961da177e4SLinus Torvalds 
8971da177e4SLinus Torvalds 		spin_lock_irq(&device_state_lock);
8981da177e4SLinus Torvalds 		if (hdev->devnum <= 0)
8991da177e4SLinus Torvalds 			info->nports = 0;
9001da177e4SLinus Torvalds 		else {
9011da177e4SLinus Torvalds 			info->nports = hdev->maxchild;
9021da177e4SLinus Torvalds 			for (i = 0; i < info->nports; i++) {
9031da177e4SLinus Torvalds 				if (hdev->children[i] == NULL)
9041da177e4SLinus Torvalds 					info->port[i] = 0;
9051da177e4SLinus Torvalds 				else
9061da177e4SLinus Torvalds 					info->port[i] =
9071da177e4SLinus Torvalds 						hdev->children[i]->devnum;
9081da177e4SLinus Torvalds 			}
9091da177e4SLinus Torvalds 		}
9101da177e4SLinus Torvalds 		spin_unlock_irq(&device_state_lock);
9111da177e4SLinus Torvalds 
9121da177e4SLinus Torvalds 		return info->nports + 1;
9131da177e4SLinus Torvalds 		}
9141da177e4SLinus Torvalds 
9151da177e4SLinus Torvalds 	default:
9161da177e4SLinus Torvalds 		return -ENOSYS;
9171da177e4SLinus Torvalds 	}
9181da177e4SLinus Torvalds }
9191da177e4SLinus Torvalds 
9201da177e4SLinus Torvalds /* caller has locked the hub device */
9211da177e4SLinus Torvalds static void hub_pre_reset(struct usb_hub *hub)
9221da177e4SLinus Torvalds {
9231da177e4SLinus Torvalds 	struct usb_device *hdev = hub->hdev;
9241da177e4SLinus Torvalds 	int i;
9251da177e4SLinus Torvalds 
9261da177e4SLinus Torvalds 	for (i = 0; i < hdev->maxchild; ++i) {
9271da177e4SLinus Torvalds 		if (hdev->children[i])
9281da177e4SLinus Torvalds 			usb_disconnect(&hdev->children[i]);
9291da177e4SLinus Torvalds 	}
9301da177e4SLinus Torvalds 	hub_quiesce(hub);
9311da177e4SLinus Torvalds }
9321da177e4SLinus Torvalds 
9331da177e4SLinus Torvalds /* caller has locked the hub device */
9341da177e4SLinus Torvalds static void hub_post_reset(struct usb_hub *hub)
9351da177e4SLinus Torvalds {
9361da177e4SLinus Torvalds 	hub_activate(hub);
9371da177e4SLinus Torvalds 	hub_power_on(hub);
9381da177e4SLinus Torvalds }
9391da177e4SLinus Torvalds 
9401da177e4SLinus Torvalds 
9411da177e4SLinus Torvalds /* grab device/port lock, returning index of that port (zero based).
9421da177e4SLinus Torvalds  * protects the upstream link used by this device from concurrent
9431da177e4SLinus Torvalds  * tree operations like suspend, resume, reset, and disconnect, which
9441da177e4SLinus Torvalds  * apply to everything downstream of a given port.
9451da177e4SLinus Torvalds  */
9461da177e4SLinus Torvalds static int locktree(struct usb_device *udev)
9471da177e4SLinus Torvalds {
9481da177e4SLinus Torvalds 	int			t;
9491da177e4SLinus Torvalds 	struct usb_device	*hdev;
9501da177e4SLinus Torvalds 
9511da177e4SLinus Torvalds 	if (!udev)
9521da177e4SLinus Torvalds 		return -ENODEV;
9531da177e4SLinus Torvalds 
9541da177e4SLinus Torvalds 	/* root hub is always the first lock in the series */
9551da177e4SLinus Torvalds 	hdev = udev->parent;
9561da177e4SLinus Torvalds 	if (!hdev) {
9571da177e4SLinus Torvalds 		usb_lock_device(udev);
9581da177e4SLinus Torvalds 		return 0;
9591da177e4SLinus Torvalds 	}
9601da177e4SLinus Torvalds 
9611da177e4SLinus Torvalds 	/* on the path from root to us, lock everything from
9621da177e4SLinus Torvalds 	 * top down, dropping parent locks when not needed
9631da177e4SLinus Torvalds 	 */
9641da177e4SLinus Torvalds 	t = locktree(hdev);
9651da177e4SLinus Torvalds 	if (t < 0)
9661da177e4SLinus Torvalds 		return t;
9671da177e4SLinus Torvalds 	for (t = 0; t < hdev->maxchild; t++) {
9681da177e4SLinus Torvalds 		if (hdev->children[t] == udev) {
9691da177e4SLinus Torvalds 			/* everything is fail-fast once disconnect
9701da177e4SLinus Torvalds 			 * processing starts
9711da177e4SLinus Torvalds 			 */
9721da177e4SLinus Torvalds 			if (udev->state == USB_STATE_NOTATTACHED)
9731da177e4SLinus Torvalds 				break;
9741da177e4SLinus Torvalds 
9751da177e4SLinus Torvalds 			/* when everyone grabs locks top->bottom,
9761da177e4SLinus Torvalds 			 * non-overlapping work may be concurrent
9771da177e4SLinus Torvalds 			 */
9781da177e4SLinus Torvalds 			down(&udev->serialize);
9791da177e4SLinus Torvalds 			up(&hdev->serialize);
9801da177e4SLinus Torvalds 			return t + 1;
9811da177e4SLinus Torvalds 		}
9821da177e4SLinus Torvalds 	}
9831da177e4SLinus Torvalds 	usb_unlock_device(hdev);
9841da177e4SLinus Torvalds 	return -ENODEV;
9851da177e4SLinus Torvalds }
9861da177e4SLinus Torvalds 
9871da177e4SLinus Torvalds static void recursively_mark_NOTATTACHED(struct usb_device *udev)
9881da177e4SLinus Torvalds {
9891da177e4SLinus Torvalds 	int i;
9901da177e4SLinus Torvalds 
9911da177e4SLinus Torvalds 	for (i = 0; i < udev->maxchild; ++i) {
9921da177e4SLinus Torvalds 		if (udev->children[i])
9931da177e4SLinus Torvalds 			recursively_mark_NOTATTACHED(udev->children[i]);
9941da177e4SLinus Torvalds 	}
9951da177e4SLinus Torvalds 	udev->state = USB_STATE_NOTATTACHED;
9961da177e4SLinus Torvalds }
9971da177e4SLinus Torvalds 
9981da177e4SLinus Torvalds /**
9991da177e4SLinus Torvalds  * usb_set_device_state - change a device's current state (usbcore, hcds)
10001da177e4SLinus Torvalds  * @udev: pointer to device whose state should be changed
10011da177e4SLinus Torvalds  * @new_state: new state value to be stored
10021da177e4SLinus Torvalds  *
10031da177e4SLinus Torvalds  * udev->state is _not_ fully protected by the device lock.  Although
10041da177e4SLinus Torvalds  * most transitions are made only while holding the lock, the state can
10051da177e4SLinus Torvalds  * can change to USB_STATE_NOTATTACHED at almost any time.  This
10061da177e4SLinus Torvalds  * is so that devices can be marked as disconnected as soon as possible,
10071da177e4SLinus Torvalds  * without having to wait for any semaphores to be released.  As a result,
10081da177e4SLinus Torvalds  * all changes to any device's state must be protected by the
10091da177e4SLinus Torvalds  * device_state_lock spinlock.
10101da177e4SLinus Torvalds  *
10111da177e4SLinus Torvalds  * Once a device has been added to the device tree, all changes to its state
10121da177e4SLinus Torvalds  * should be made using this routine.  The state should _not_ be set directly.
10131da177e4SLinus Torvalds  *
10141da177e4SLinus Torvalds  * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
10151da177e4SLinus Torvalds  * Otherwise udev->state is set to new_state, and if new_state is
10161da177e4SLinus Torvalds  * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
10171da177e4SLinus Torvalds  * to USB_STATE_NOTATTACHED.
10181da177e4SLinus Torvalds  */
10191da177e4SLinus Torvalds void usb_set_device_state(struct usb_device *udev,
10201da177e4SLinus Torvalds 		enum usb_device_state new_state)
10211da177e4SLinus Torvalds {
10221da177e4SLinus Torvalds 	unsigned long flags;
10231da177e4SLinus Torvalds 
10241da177e4SLinus Torvalds 	spin_lock_irqsave(&device_state_lock, flags);
10251da177e4SLinus Torvalds 	if (udev->state == USB_STATE_NOTATTACHED)
10261da177e4SLinus Torvalds 		;	/* do nothing */
1027b94dc6b5SDavid Brownell 	else if (new_state != USB_STATE_NOTATTACHED) {
10281da177e4SLinus Torvalds 		udev->state = new_state;
1029b94dc6b5SDavid Brownell 		if (new_state == USB_STATE_CONFIGURED)
1030b94dc6b5SDavid Brownell 			device_init_wakeup(&udev->dev,
1031b94dc6b5SDavid Brownell 				(udev->actconfig->desc.bmAttributes
1032b94dc6b5SDavid Brownell 				 & USB_CONFIG_ATT_WAKEUP));
1033b94dc6b5SDavid Brownell 		else if (new_state != USB_STATE_SUSPENDED)
1034b94dc6b5SDavid Brownell 			device_init_wakeup(&udev->dev, 0);
1035b94dc6b5SDavid Brownell 	} else
10361da177e4SLinus Torvalds 		recursively_mark_NOTATTACHED(udev);
10371da177e4SLinus Torvalds 	spin_unlock_irqrestore(&device_state_lock, flags);
10381da177e4SLinus Torvalds }
10391da177e4SLinus Torvalds EXPORT_SYMBOL(usb_set_device_state);
10401da177e4SLinus Torvalds 
10411da177e4SLinus Torvalds 
10421c50c317SAlan Stern #ifdef CONFIG_PM
10431c50c317SAlan Stern 
10441c50c317SAlan Stern /**
10451c50c317SAlan Stern  * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
10461c50c317SAlan Stern  * @rhdev: struct usb_device for the root hub
10471c50c317SAlan Stern  *
10481c50c317SAlan Stern  * The USB host controller driver calls this function when its root hub
10491c50c317SAlan Stern  * is resumed and Vbus power has been interrupted or the controller
10501c50c317SAlan Stern  * has been reset.  The routine marks all the children of the root hub
10511c50c317SAlan Stern  * as NOTATTACHED and marks logical connect-change events on their ports.
10521c50c317SAlan Stern  */
10531c50c317SAlan Stern void usb_root_hub_lost_power(struct usb_device *rhdev)
10541c50c317SAlan Stern {
10551c50c317SAlan Stern 	struct usb_hub *hub;
10561c50c317SAlan Stern 	int port1;
10571c50c317SAlan Stern 	unsigned long flags;
10581c50c317SAlan Stern 
10591c50c317SAlan Stern 	dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
10601c50c317SAlan Stern 	spin_lock_irqsave(&device_state_lock, flags);
10611c50c317SAlan Stern 	hub = hdev_to_hub(rhdev);
10621c50c317SAlan Stern 	for (port1 = 1; port1 <= rhdev->maxchild; ++port1) {
10631c50c317SAlan Stern 		if (rhdev->children[port1 - 1]) {
10641c50c317SAlan Stern 			recursively_mark_NOTATTACHED(
10651c50c317SAlan Stern 					rhdev->children[port1 - 1]);
10661c50c317SAlan Stern 			set_bit(port1, hub->change_bits);
10671c50c317SAlan Stern 		}
10681c50c317SAlan Stern 	}
10691c50c317SAlan Stern 	spin_unlock_irqrestore(&device_state_lock, flags);
10701c50c317SAlan Stern }
10711c50c317SAlan Stern EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
10721c50c317SAlan Stern 
10731c50c317SAlan Stern #endif
10741c50c317SAlan Stern 
10751da177e4SLinus Torvalds static void choose_address(struct usb_device *udev)
10761da177e4SLinus Torvalds {
10771da177e4SLinus Torvalds 	int		devnum;
10781da177e4SLinus Torvalds 	struct usb_bus	*bus = udev->bus;
10791da177e4SLinus Torvalds 
10801da177e4SLinus Torvalds 	/* If khubd ever becomes multithreaded, this will need a lock */
10811da177e4SLinus Torvalds 
10821da177e4SLinus Torvalds 	/* Try to allocate the next devnum beginning at bus->devnum_next. */
10831da177e4SLinus Torvalds 	devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
10841da177e4SLinus Torvalds 			bus->devnum_next);
10851da177e4SLinus Torvalds 	if (devnum >= 128)
10861da177e4SLinus Torvalds 		devnum = find_next_zero_bit(bus->devmap.devicemap, 128, 1);
10871da177e4SLinus Torvalds 
10881da177e4SLinus Torvalds 	bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
10891da177e4SLinus Torvalds 
10901da177e4SLinus Torvalds 	if (devnum < 128) {
10911da177e4SLinus Torvalds 		set_bit(devnum, bus->devmap.devicemap);
10921da177e4SLinus Torvalds 		udev->devnum = devnum;
10931da177e4SLinus Torvalds 	}
10941da177e4SLinus Torvalds }
10951da177e4SLinus Torvalds 
10961da177e4SLinus Torvalds static void release_address(struct usb_device *udev)
10971da177e4SLinus Torvalds {
10981da177e4SLinus Torvalds 	if (udev->devnum > 0) {
10991da177e4SLinus Torvalds 		clear_bit(udev->devnum, udev->bus->devmap.devicemap);
11001da177e4SLinus Torvalds 		udev->devnum = -1;
11011da177e4SLinus Torvalds 	}
11021da177e4SLinus Torvalds }
11031da177e4SLinus Torvalds 
11041da177e4SLinus Torvalds /**
11051da177e4SLinus Torvalds  * usb_disconnect - disconnect a device (usbcore-internal)
11061da177e4SLinus Torvalds  * @pdev: pointer to device being disconnected
11071da177e4SLinus Torvalds  * Context: !in_interrupt ()
11081da177e4SLinus Torvalds  *
11091da177e4SLinus Torvalds  * Something got disconnected. Get rid of it and all of its children.
11101da177e4SLinus Torvalds  *
11111da177e4SLinus Torvalds  * If *pdev is a normal device then the parent hub must already be locked.
11121da177e4SLinus Torvalds  * If *pdev is a root hub then this routine will acquire the
11131da177e4SLinus Torvalds  * usb_bus_list_lock on behalf of the caller.
11141da177e4SLinus Torvalds  *
11151da177e4SLinus Torvalds  * Only hub drivers (including virtual root hub drivers for host
11161da177e4SLinus Torvalds  * controllers) should ever call this.
11171da177e4SLinus Torvalds  *
11181da177e4SLinus Torvalds  * This call is synchronous, and may not be used in an interrupt context.
11191da177e4SLinus Torvalds  */
11201da177e4SLinus Torvalds void usb_disconnect(struct usb_device **pdev)
11211da177e4SLinus Torvalds {
11221da177e4SLinus Torvalds 	struct usb_device	*udev = *pdev;
11231da177e4SLinus Torvalds 	int			i;
11241da177e4SLinus Torvalds 
11251da177e4SLinus Torvalds 	if (!udev) {
11261da177e4SLinus Torvalds 		pr_debug ("%s nodev\n", __FUNCTION__);
11271da177e4SLinus Torvalds 		return;
11281da177e4SLinus Torvalds 	}
11291da177e4SLinus Torvalds 
11301da177e4SLinus Torvalds 	/* mark the device as inactive, so any further urb submissions for
11311da177e4SLinus Torvalds 	 * this device (and any of its children) will fail immediately.
11321da177e4SLinus Torvalds 	 * this quiesces everyting except pending urbs.
11331da177e4SLinus Torvalds 	 */
11341da177e4SLinus Torvalds 	usb_set_device_state(udev, USB_STATE_NOTATTACHED);
11351da177e4SLinus Torvalds 
11361da177e4SLinus Torvalds 	/* lock the bus list on behalf of HCDs unregistering their root hubs */
11371da177e4SLinus Torvalds 	if (!udev->parent) {
11381da177e4SLinus Torvalds 		down(&usb_bus_list_lock);
11391da177e4SLinus Torvalds 		usb_lock_device(udev);
11401da177e4SLinus Torvalds 	} else
11411da177e4SLinus Torvalds 		down(&udev->serialize);
11421da177e4SLinus Torvalds 
11431da177e4SLinus Torvalds 	dev_info (&udev->dev, "USB disconnect, address %d\n", udev->devnum);
11441da177e4SLinus Torvalds 
11451da177e4SLinus Torvalds 	/* Free up all the children before we remove this device */
11461da177e4SLinus Torvalds 	for (i = 0; i < USB_MAXCHILDREN; i++) {
11471da177e4SLinus Torvalds 		if (udev->children[i])
11481da177e4SLinus Torvalds 			usb_disconnect(&udev->children[i]);
11491da177e4SLinus Torvalds 	}
11501da177e4SLinus Torvalds 
11511da177e4SLinus Torvalds 	/* deallocate hcd/hardware state ... nuking all pending urbs and
11521da177e4SLinus Torvalds 	 * cleaning up all state associated with the current configuration
11531da177e4SLinus Torvalds 	 * so that the hardware is now fully quiesced.
11541da177e4SLinus Torvalds 	 */
11551da177e4SLinus Torvalds 	usb_disable_device(udev, 0);
11561da177e4SLinus Torvalds 
11573099e75aSGreg Kroah-Hartman 	usb_notify_remove_device(udev);
11583099e75aSGreg Kroah-Hartman 
11591da177e4SLinus Torvalds 	/* Free the device number, remove the /proc/bus/usb entry and
11601da177e4SLinus Torvalds 	 * the sysfs attributes, and delete the parent's children[]
11611da177e4SLinus Torvalds 	 * (or root_hub) pointer.
11621da177e4SLinus Torvalds 	 */
11631da177e4SLinus Torvalds 	dev_dbg (&udev->dev, "unregistering device\n");
11641da177e4SLinus Torvalds 	release_address(udev);
11651da177e4SLinus Torvalds 	usb_remove_sysfs_dev_files(udev);
11661da177e4SLinus Torvalds 
11671da177e4SLinus Torvalds 	/* Avoid races with recursively_mark_NOTATTACHED() */
11681da177e4SLinus Torvalds 	spin_lock_irq(&device_state_lock);
11691da177e4SLinus Torvalds 	*pdev = NULL;
11701da177e4SLinus Torvalds 	spin_unlock_irq(&device_state_lock);
11711da177e4SLinus Torvalds 
11721da177e4SLinus Torvalds 	if (!udev->parent) {
11731da177e4SLinus Torvalds 		usb_unlock_device(udev);
11741da177e4SLinus Torvalds 		up(&usb_bus_list_lock);
11751da177e4SLinus Torvalds 	} else
11761da177e4SLinus Torvalds 		up(&udev->serialize);
11771da177e4SLinus Torvalds 
11781da177e4SLinus Torvalds 	device_unregister(&udev->dev);
11791da177e4SLinus Torvalds }
11801da177e4SLinus Torvalds 
11811da177e4SLinus Torvalds static int choose_configuration(struct usb_device *udev)
11821da177e4SLinus Torvalds {
11831da177e4SLinus Torvalds 	int c, i;
11841da177e4SLinus Torvalds 
11851da177e4SLinus Torvalds 	/* NOTE: this should interact with hub power budgeting */
11861da177e4SLinus Torvalds 
11871da177e4SLinus Torvalds 	c = udev->config[0].desc.bConfigurationValue;
11881da177e4SLinus Torvalds 	if (udev->descriptor.bNumConfigurations != 1) {
11891da177e4SLinus Torvalds 		for (i = 0; i < udev->descriptor.bNumConfigurations; i++) {
11901da177e4SLinus Torvalds 			struct usb_interface_descriptor	*desc;
11911da177e4SLinus Torvalds 
11921da177e4SLinus Torvalds 			/* heuristic:  Linux is more likely to have class
11931da177e4SLinus Torvalds 			 * drivers, so avoid vendor-specific interfaces.
11941da177e4SLinus Torvalds 			 */
11951da177e4SLinus Torvalds 			desc = &udev->config[i].intf_cache[0]
11961da177e4SLinus Torvalds 					->altsetting->desc;
11971da177e4SLinus Torvalds 			if (desc->bInterfaceClass == USB_CLASS_VENDOR_SPEC)
11981da177e4SLinus Torvalds 				continue;
11991da177e4SLinus Torvalds 			/* COMM/2/all is CDC ACM, except 0xff is MSFT RNDIS.
12001da177e4SLinus Torvalds 			 * MSFT needs this to be the first config; never use
12011da177e4SLinus Torvalds 			 * it as the default unless Linux has host-side RNDIS.
12021da177e4SLinus Torvalds 			 * A second config would ideally be CDC-Ethernet, but
12031da177e4SLinus Torvalds 			 * may instead be the "vendor specific" CDC subset
12041da177e4SLinus Torvalds 			 * long used by ARM Linux for sa1100 or pxa255.
12051da177e4SLinus Torvalds 			 */
12061da177e4SLinus Torvalds 			if (desc->bInterfaceClass == USB_CLASS_COMM
12071da177e4SLinus Torvalds 					&& desc->bInterfaceSubClass == 2
12081da177e4SLinus Torvalds 					&& desc->bInterfaceProtocol == 0xff) {
12091da177e4SLinus Torvalds 				c = udev->config[1].desc.bConfigurationValue;
12101da177e4SLinus Torvalds 				continue;
12111da177e4SLinus Torvalds 			}
12121da177e4SLinus Torvalds 			c = udev->config[i].desc.bConfigurationValue;
12131da177e4SLinus Torvalds 			break;
12141da177e4SLinus Torvalds 		}
12151da177e4SLinus Torvalds 		dev_info(&udev->dev,
12161da177e4SLinus Torvalds 			"configuration #%d chosen from %d choices\n",
12171da177e4SLinus Torvalds 			c, udev->descriptor.bNumConfigurations);
12181da177e4SLinus Torvalds 	}
12191da177e4SLinus Torvalds 	return c;
12201da177e4SLinus Torvalds }
12211da177e4SLinus Torvalds 
12221da177e4SLinus Torvalds #ifdef DEBUG
12231da177e4SLinus Torvalds static void show_string(struct usb_device *udev, char *id, char *string)
12241da177e4SLinus Torvalds {
12251da177e4SLinus Torvalds 	if (!string)
12261da177e4SLinus Torvalds 		return;
12271da177e4SLinus Torvalds 	dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
12281da177e4SLinus Torvalds }
12291da177e4SLinus Torvalds 
12301da177e4SLinus Torvalds #else
12311da177e4SLinus Torvalds static inline void show_string(struct usb_device *udev, char *id, char *string)
12321da177e4SLinus Torvalds {}
12331da177e4SLinus Torvalds #endif
12341da177e4SLinus Torvalds 
12351da177e4SLinus Torvalds 
12361da177e4SLinus Torvalds #ifdef	CONFIG_USB_OTG
12371da177e4SLinus Torvalds #include "otg_whitelist.h"
12381da177e4SLinus Torvalds #endif
12391da177e4SLinus Torvalds 
12401da177e4SLinus Torvalds /**
12411da177e4SLinus Torvalds  * usb_new_device - perform initial device setup (usbcore-internal)
12421da177e4SLinus Torvalds  * @udev: newly addressed device (in ADDRESS state)
12431da177e4SLinus Torvalds  *
12441da177e4SLinus Torvalds  * This is called with devices which have been enumerated, but not yet
12451da177e4SLinus Torvalds  * configured.  The device descriptor is available, but not descriptors
12461da177e4SLinus Torvalds  * for any device configuration.  The caller must have locked udev and
12471da177e4SLinus Torvalds  * either the parent hub (if udev is a normal device) or else the
12481da177e4SLinus Torvalds  * usb_bus_list_lock (if udev is a root hub).  The parent's pointer to
12491da177e4SLinus Torvalds  * udev has already been installed, but udev is not yet visible through
12501da177e4SLinus Torvalds  * sysfs or other filesystem code.
12511da177e4SLinus Torvalds  *
12521da177e4SLinus Torvalds  * Returns 0 for success (device is configured and listed, with its
12531da177e4SLinus Torvalds  * interfaces, in sysfs); else a negative errno value.
12541da177e4SLinus Torvalds  *
12551da177e4SLinus Torvalds  * This call is synchronous, and may not be used in an interrupt context.
12561da177e4SLinus Torvalds  *
12571da177e4SLinus Torvalds  * Only the hub driver should ever call this; root hub registration
12581da177e4SLinus Torvalds  * uses it indirectly.
12591da177e4SLinus Torvalds  */
12601da177e4SLinus Torvalds int usb_new_device(struct usb_device *udev)
12611da177e4SLinus Torvalds {
12621da177e4SLinus Torvalds 	int err;
12631da177e4SLinus Torvalds 	int c;
12641da177e4SLinus Torvalds 
12651da177e4SLinus Torvalds 	err = usb_get_configuration(udev);
12661da177e4SLinus Torvalds 	if (err < 0) {
12671da177e4SLinus Torvalds 		dev_err(&udev->dev, "can't read configurations, error %d\n",
12681da177e4SLinus Torvalds 			err);
12691da177e4SLinus Torvalds 		goto fail;
12701da177e4SLinus Torvalds 	}
12711da177e4SLinus Torvalds 
12721da177e4SLinus Torvalds 	/* read the standard strings and cache them if present */
12734f62efe6SAlan Stern 	udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
12744f62efe6SAlan Stern 	udev->manufacturer = usb_cache_string(udev,
12754f62efe6SAlan Stern 			udev->descriptor.iManufacturer);
12764f62efe6SAlan Stern 	udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
12771da177e4SLinus Torvalds 
12781da177e4SLinus Torvalds 	/* Tell the world! */
12791da177e4SLinus Torvalds 	dev_dbg(&udev->dev, "new device strings: Mfr=%d, Product=%d, "
12801da177e4SLinus Torvalds 			"SerialNumber=%d\n",
12811da177e4SLinus Torvalds 			udev->descriptor.iManufacturer,
12821da177e4SLinus Torvalds 			udev->descriptor.iProduct,
12831da177e4SLinus Torvalds 			udev->descriptor.iSerialNumber);
12841da177e4SLinus Torvalds 	show_string(udev, "Product", udev->product);
12851da177e4SLinus Torvalds 	show_string(udev, "Manufacturer", udev->manufacturer);
12861da177e4SLinus Torvalds 	show_string(udev, "SerialNumber", udev->serial);
12871da177e4SLinus Torvalds 
12881da177e4SLinus Torvalds #ifdef	CONFIG_USB_OTG
12891da177e4SLinus Torvalds 	/*
12901da177e4SLinus Torvalds 	 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
12911da177e4SLinus Torvalds 	 * to wake us after we've powered off VBUS; and HNP, switching roles
12921da177e4SLinus Torvalds 	 * "host" to "peripheral".  The OTG descriptor helps figure this out.
12931da177e4SLinus Torvalds 	 */
12941da177e4SLinus Torvalds 	if (!udev->bus->is_b_host
12951da177e4SLinus Torvalds 			&& udev->config
12961da177e4SLinus Torvalds 			&& udev->parent == udev->bus->root_hub) {
12971da177e4SLinus Torvalds 		struct usb_otg_descriptor	*desc = 0;
12981da177e4SLinus Torvalds 		struct usb_bus			*bus = udev->bus;
12991da177e4SLinus Torvalds 
13001da177e4SLinus Torvalds 		/* descriptor may appear anywhere in config */
13011da177e4SLinus Torvalds 		if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
13021da177e4SLinus Torvalds 					le16_to_cpu(udev->config[0].desc.wTotalLength),
13031da177e4SLinus Torvalds 					USB_DT_OTG, (void **) &desc) == 0) {
13041da177e4SLinus Torvalds 			if (desc->bmAttributes & USB_OTG_HNP) {
13051da177e4SLinus Torvalds 				unsigned		port1;
13061da177e4SLinus Torvalds 				struct usb_device	*root = udev->parent;
13071da177e4SLinus Torvalds 
13081da177e4SLinus Torvalds 				for (port1 = 1; port1 <= root->maxchild;
13091da177e4SLinus Torvalds 						port1++) {
13101da177e4SLinus Torvalds 					if (root->children[port1-1] == udev)
13111da177e4SLinus Torvalds 						break;
13121da177e4SLinus Torvalds 				}
13131da177e4SLinus Torvalds 
13141da177e4SLinus Torvalds 				dev_info(&udev->dev,
13151da177e4SLinus Torvalds 					"Dual-Role OTG device on %sHNP port\n",
13161da177e4SLinus Torvalds 					(port1 == bus->otg_port)
13171da177e4SLinus Torvalds 						? "" : "non-");
13181da177e4SLinus Torvalds 
13191da177e4SLinus Torvalds 				/* enable HNP before suspend, it's simpler */
13201da177e4SLinus Torvalds 				if (port1 == bus->otg_port)
13211da177e4SLinus Torvalds 					bus->b_hnp_enable = 1;
13221da177e4SLinus Torvalds 				err = usb_control_msg(udev,
13231da177e4SLinus Torvalds 					usb_sndctrlpipe(udev, 0),
13241da177e4SLinus Torvalds 					USB_REQ_SET_FEATURE, 0,
13251da177e4SLinus Torvalds 					bus->b_hnp_enable
13261da177e4SLinus Torvalds 						? USB_DEVICE_B_HNP_ENABLE
13271da177e4SLinus Torvalds 						: USB_DEVICE_A_ALT_HNP_SUPPORT,
13281da177e4SLinus Torvalds 					0, NULL, 0, USB_CTRL_SET_TIMEOUT);
13291da177e4SLinus Torvalds 				if (err < 0) {
13301da177e4SLinus Torvalds 					/* OTG MESSAGE: report errors here,
13311da177e4SLinus Torvalds 					 * customize to match your product.
13321da177e4SLinus Torvalds 					 */
13331da177e4SLinus Torvalds 					dev_info(&udev->dev,
13341da177e4SLinus Torvalds 						"can't set HNP mode; %d\n",
13351da177e4SLinus Torvalds 						err);
13361da177e4SLinus Torvalds 					bus->b_hnp_enable = 0;
13371da177e4SLinus Torvalds 				}
13381da177e4SLinus Torvalds 			}
13391da177e4SLinus Torvalds 		}
13401da177e4SLinus Torvalds 	}
13411da177e4SLinus Torvalds 
13421da177e4SLinus Torvalds 	if (!is_targeted(udev)) {
13431da177e4SLinus Torvalds 
13441da177e4SLinus Torvalds 		/* Maybe it can talk to us, though we can't talk to it.
13451da177e4SLinus Torvalds 		 * (Includes HNP test device.)
13461da177e4SLinus Torvalds 		 */
13471da177e4SLinus Torvalds 		if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
13481da177e4SLinus Torvalds 			static int __usb_suspend_device(struct usb_device *,
1349390a8c34SDavid Brownell 						int port1);
1350390a8c34SDavid Brownell 			err = __usb_suspend_device(udev, udev->bus->otg_port);
13511da177e4SLinus Torvalds 			if (err < 0)
13521da177e4SLinus Torvalds 				dev_dbg(&udev->dev, "HNP fail, %d\n", err);
13531da177e4SLinus Torvalds 		}
13541da177e4SLinus Torvalds 		err = -ENODEV;
13551da177e4SLinus Torvalds 		goto fail;
13561da177e4SLinus Torvalds 	}
13571da177e4SLinus Torvalds #endif
13581da177e4SLinus Torvalds 
13591da177e4SLinus Torvalds 	/* put device-specific files into sysfs */
13601da177e4SLinus Torvalds 	err = device_add (&udev->dev);
13611da177e4SLinus Torvalds 	if (err) {
13621da177e4SLinus Torvalds 		dev_err(&udev->dev, "can't device_add, error %d\n", err);
13631da177e4SLinus Torvalds 		goto fail;
13641da177e4SLinus Torvalds 	}
13651da177e4SLinus Torvalds 	usb_create_sysfs_dev_files (udev);
13661da177e4SLinus Torvalds 
13671da177e4SLinus Torvalds 	/* choose and set the configuration. that registers the interfaces
13681da177e4SLinus Torvalds 	 * with the driver core, and lets usb device drivers bind to them.
13691da177e4SLinus Torvalds 	 */
13701da177e4SLinus Torvalds 	c = choose_configuration(udev);
13711da177e4SLinus Torvalds 	if (c < 0)
13721da177e4SLinus Torvalds 		dev_warn(&udev->dev,
13731da177e4SLinus Torvalds 				"can't choose an initial configuration\n");
13741da177e4SLinus Torvalds 	else {
13751da177e4SLinus Torvalds 		err = usb_set_configuration(udev, c);
13761da177e4SLinus Torvalds 		if (err) {
13771da177e4SLinus Torvalds 			dev_err(&udev->dev, "can't set config #%d, error %d\n",
13781da177e4SLinus Torvalds 					c, err);
13791da177e4SLinus Torvalds 			usb_remove_sysfs_dev_files(udev);
13801da177e4SLinus Torvalds 			device_del(&udev->dev);
13811da177e4SLinus Torvalds 			goto fail;
13821da177e4SLinus Torvalds 		}
13831da177e4SLinus Torvalds 	}
13841da177e4SLinus Torvalds 
13851da177e4SLinus Torvalds 	/* USB device state == configured ... usable */
13863099e75aSGreg Kroah-Hartman 	usb_notify_add_device(udev);
13871da177e4SLinus Torvalds 
13881da177e4SLinus Torvalds 	return 0;
13891da177e4SLinus Torvalds 
13901da177e4SLinus Torvalds fail:
13911da177e4SLinus Torvalds 	usb_set_device_state(udev, USB_STATE_NOTATTACHED);
13921da177e4SLinus Torvalds 	return err;
13931da177e4SLinus Torvalds }
13941da177e4SLinus Torvalds 
13951da177e4SLinus Torvalds 
13961da177e4SLinus Torvalds static int hub_port_status(struct usb_hub *hub, int port1,
13971da177e4SLinus Torvalds 			       u16 *status, u16 *change)
13981da177e4SLinus Torvalds {
13991da177e4SLinus Torvalds 	int ret;
14001da177e4SLinus Torvalds 
14011da177e4SLinus Torvalds 	ret = get_port_status(hub->hdev, port1, &hub->status->port);
14021da177e4SLinus Torvalds 	if (ret < 0)
14031da177e4SLinus Torvalds 		dev_err (hub->intfdev,
14041da177e4SLinus Torvalds 			"%s failed (err = %d)\n", __FUNCTION__, ret);
14051da177e4SLinus Torvalds 	else {
14061da177e4SLinus Torvalds 		*status = le16_to_cpu(hub->status->port.wPortStatus);
14071da177e4SLinus Torvalds 		*change = le16_to_cpu(hub->status->port.wPortChange);
14081da177e4SLinus Torvalds 		ret = 0;
14091da177e4SLinus Torvalds 	}
14101da177e4SLinus Torvalds 	return ret;
14111da177e4SLinus Torvalds }
14121da177e4SLinus Torvalds 
14131da177e4SLinus Torvalds #define PORT_RESET_TRIES	5
14141da177e4SLinus Torvalds #define SET_ADDRESS_TRIES	2
14151da177e4SLinus Torvalds #define GET_DESCRIPTOR_TRIES	2
14161da177e4SLinus Torvalds #define SET_CONFIG_TRIES	(2 * (use_both_schemes + 1))
14171da177e4SLinus Torvalds #define USE_NEW_SCHEME(i)	((i) / 2 == old_scheme_first)
14181da177e4SLinus Torvalds 
14191da177e4SLinus Torvalds #define HUB_ROOT_RESET_TIME	50	/* times are in msec */
14201da177e4SLinus Torvalds #define HUB_SHORT_RESET_TIME	10
14211da177e4SLinus Torvalds #define HUB_LONG_RESET_TIME	200
14221da177e4SLinus Torvalds #define HUB_RESET_TIMEOUT	500
14231da177e4SLinus Torvalds 
14241da177e4SLinus Torvalds static int hub_port_wait_reset(struct usb_hub *hub, int port1,
14251da177e4SLinus Torvalds 				struct usb_device *udev, unsigned int delay)
14261da177e4SLinus Torvalds {
14271da177e4SLinus Torvalds 	int delay_time, ret;
14281da177e4SLinus Torvalds 	u16 portstatus;
14291da177e4SLinus Torvalds 	u16 portchange;
14301da177e4SLinus Torvalds 
14311da177e4SLinus Torvalds 	for (delay_time = 0;
14321da177e4SLinus Torvalds 			delay_time < HUB_RESET_TIMEOUT;
14331da177e4SLinus Torvalds 			delay_time += delay) {
14341da177e4SLinus Torvalds 		/* wait to give the device a chance to reset */
14351da177e4SLinus Torvalds 		msleep(delay);
14361da177e4SLinus Torvalds 
14371da177e4SLinus Torvalds 		/* read and decode port status */
14381da177e4SLinus Torvalds 		ret = hub_port_status(hub, port1, &portstatus, &portchange);
14391da177e4SLinus Torvalds 		if (ret < 0)
14401da177e4SLinus Torvalds 			return ret;
14411da177e4SLinus Torvalds 
14421da177e4SLinus Torvalds 		/* Device went away? */
14431da177e4SLinus Torvalds 		if (!(portstatus & USB_PORT_STAT_CONNECTION))
14441da177e4SLinus Torvalds 			return -ENOTCONN;
14451da177e4SLinus Torvalds 
14461da177e4SLinus Torvalds 		/* bomb out completely if something weird happened */
14471da177e4SLinus Torvalds 		if ((portchange & USB_PORT_STAT_C_CONNECTION))
14481da177e4SLinus Torvalds 			return -EINVAL;
14491da177e4SLinus Torvalds 
14501da177e4SLinus Torvalds 		/* if we`ve finished resetting, then break out of the loop */
14511da177e4SLinus Torvalds 		if (!(portstatus & USB_PORT_STAT_RESET) &&
14521da177e4SLinus Torvalds 		    (portstatus & USB_PORT_STAT_ENABLE)) {
14531da177e4SLinus Torvalds 			if (portstatus & USB_PORT_STAT_HIGH_SPEED)
14541da177e4SLinus Torvalds 				udev->speed = USB_SPEED_HIGH;
14551da177e4SLinus Torvalds 			else if (portstatus & USB_PORT_STAT_LOW_SPEED)
14561da177e4SLinus Torvalds 				udev->speed = USB_SPEED_LOW;
14571da177e4SLinus Torvalds 			else
14581da177e4SLinus Torvalds 				udev->speed = USB_SPEED_FULL;
14591da177e4SLinus Torvalds 			return 0;
14601da177e4SLinus Torvalds 		}
14611da177e4SLinus Torvalds 
14621da177e4SLinus Torvalds 		/* switch to the long delay after two short delay failures */
14631da177e4SLinus Torvalds 		if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
14641da177e4SLinus Torvalds 			delay = HUB_LONG_RESET_TIME;
14651da177e4SLinus Torvalds 
14661da177e4SLinus Torvalds 		dev_dbg (hub->intfdev,
14671da177e4SLinus Torvalds 			"port %d not reset yet, waiting %dms\n",
14681da177e4SLinus Torvalds 			port1, delay);
14691da177e4SLinus Torvalds 	}
14701da177e4SLinus Torvalds 
14711da177e4SLinus Torvalds 	return -EBUSY;
14721da177e4SLinus Torvalds }
14731da177e4SLinus Torvalds 
14741da177e4SLinus Torvalds static int hub_port_reset(struct usb_hub *hub, int port1,
14751da177e4SLinus Torvalds 				struct usb_device *udev, unsigned int delay)
14761da177e4SLinus Torvalds {
14771da177e4SLinus Torvalds 	int i, status;
14781da177e4SLinus Torvalds 
14791da177e4SLinus Torvalds 	/* Reset the port */
14801da177e4SLinus Torvalds 	for (i = 0; i < PORT_RESET_TRIES; i++) {
14811da177e4SLinus Torvalds 		status = set_port_feature(hub->hdev,
14821da177e4SLinus Torvalds 				port1, USB_PORT_FEAT_RESET);
14831da177e4SLinus Torvalds 		if (status)
14841da177e4SLinus Torvalds 			dev_err(hub->intfdev,
14851da177e4SLinus Torvalds 					"cannot reset port %d (err = %d)\n",
14861da177e4SLinus Torvalds 					port1, status);
14871da177e4SLinus Torvalds 		else {
14881da177e4SLinus Torvalds 			status = hub_port_wait_reset(hub, port1, udev, delay);
1489dd16525bSDavid Brownell 			if (status && status != -ENOTCONN)
14901da177e4SLinus Torvalds 				dev_dbg(hub->intfdev,
14911da177e4SLinus Torvalds 						"port_wait_reset: err = %d\n",
14921da177e4SLinus Torvalds 						status);
14931da177e4SLinus Torvalds 		}
14941da177e4SLinus Torvalds 
14951da177e4SLinus Torvalds 		/* return on disconnect or reset */
14961da177e4SLinus Torvalds 		switch (status) {
14971da177e4SLinus Torvalds 		case 0:
1498b789696aSDavid Brownell 			/* TRSTRCY = 10 ms; plus some extra */
1499b789696aSDavid Brownell 			msleep(10 + 40);
15001da177e4SLinus Torvalds 			/* FALL THROUGH */
15011da177e4SLinus Torvalds 		case -ENOTCONN:
15021da177e4SLinus Torvalds 		case -ENODEV:
15031da177e4SLinus Torvalds 			clear_port_feature(hub->hdev,
15041da177e4SLinus Torvalds 				port1, USB_PORT_FEAT_C_RESET);
15051da177e4SLinus Torvalds 			/* FIXME need disconnect() for NOTATTACHED device */
15061da177e4SLinus Torvalds 			usb_set_device_state(udev, status
15071da177e4SLinus Torvalds 					? USB_STATE_NOTATTACHED
15081da177e4SLinus Torvalds 					: USB_STATE_DEFAULT);
15091da177e4SLinus Torvalds 			return status;
15101da177e4SLinus Torvalds 		}
15111da177e4SLinus Torvalds 
15121da177e4SLinus Torvalds 		dev_dbg (hub->intfdev,
15131da177e4SLinus Torvalds 			"port %d not enabled, trying reset again...\n",
15141da177e4SLinus Torvalds 			port1);
15151da177e4SLinus Torvalds 		delay = HUB_LONG_RESET_TIME;
15161da177e4SLinus Torvalds 	}
15171da177e4SLinus Torvalds 
15181da177e4SLinus Torvalds 	dev_err (hub->intfdev,
15191da177e4SLinus Torvalds 		"Cannot enable port %i.  Maybe the USB cable is bad?\n",
15201da177e4SLinus Torvalds 		port1);
15211da177e4SLinus Torvalds 
15221da177e4SLinus Torvalds 	return status;
15231da177e4SLinus Torvalds }
15241da177e4SLinus Torvalds 
15251da177e4SLinus Torvalds /*
15261da177e4SLinus Torvalds  * Disable a port and mark a logical connnect-change event, so that some
15271da177e4SLinus Torvalds  * time later khubd will disconnect() any existing usb_device on the port
15281da177e4SLinus Torvalds  * and will re-enumerate if there actually is a device attached.
15291da177e4SLinus Torvalds  */
15301da177e4SLinus Torvalds static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
15311da177e4SLinus Torvalds {
15321da177e4SLinus Torvalds 	dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
15331da177e4SLinus Torvalds 	hub_port_disable(hub, port1, 1);
15341da177e4SLinus Torvalds 
15351da177e4SLinus Torvalds 	/* FIXME let caller ask to power down the port:
15361da177e4SLinus Torvalds 	 *  - some devices won't enumerate without a VBUS power cycle
15371da177e4SLinus Torvalds 	 *  - SRP saves power that way
1538390a8c34SDavid Brownell 	 *  - ... new call, TBD ...
15391da177e4SLinus Torvalds 	 * That's easy if this hub can switch power per-port, and
15401da177e4SLinus Torvalds 	 * khubd reactivates the port later (timer, SRP, etc).
15411da177e4SLinus Torvalds 	 * Powerdown must be optional, because of reset/DFU.
15421da177e4SLinus Torvalds 	 */
15431da177e4SLinus Torvalds 
15441da177e4SLinus Torvalds 	set_bit(port1, hub->change_bits);
15451da177e4SLinus Torvalds  	kick_khubd(hub);
15461da177e4SLinus Torvalds }
15471da177e4SLinus Torvalds 
15481da177e4SLinus Torvalds 
15491da177e4SLinus Torvalds #ifdef	CONFIG_USB_SUSPEND
15501da177e4SLinus Torvalds 
15511da177e4SLinus Torvalds /*
15521da177e4SLinus Torvalds  * Selective port suspend reduces power; most suspended devices draw
15531da177e4SLinus Torvalds  * less than 500 uA.  It's also used in OTG, along with remote wakeup.
15541da177e4SLinus Torvalds  * All devices below the suspended port are also suspended.
15551da177e4SLinus Torvalds  *
15561da177e4SLinus Torvalds  * Devices leave suspend state when the host wakes them up.  Some devices
15571da177e4SLinus Torvalds  * also support "remote wakeup", where the device can activate the USB
15581da177e4SLinus Torvalds  * tree above them to deliver data, such as a keypress or packet.  In
15591da177e4SLinus Torvalds  * some cases, this wakes the USB host.
15601da177e4SLinus Torvalds  */
15611da177e4SLinus Torvalds static int hub_port_suspend(struct usb_hub *hub, int port1,
15621da177e4SLinus Torvalds 		struct usb_device *udev)
15631da177e4SLinus Torvalds {
15641da177e4SLinus Torvalds 	int	status;
15651da177e4SLinus Torvalds 
15661da177e4SLinus Torvalds 	// dev_dbg(hub->intfdev, "suspend port %d\n", port1);
15671da177e4SLinus Torvalds 
15681da177e4SLinus Torvalds 	/* enable remote wakeup when appropriate; this lets the device
15691da177e4SLinus Torvalds 	 * wake up the upstream hub (including maybe the root hub).
15701da177e4SLinus Torvalds 	 *
15711da177e4SLinus Torvalds 	 * NOTE:  OTG devices may issue remote wakeup (or SRP) even when
15721da177e4SLinus Torvalds 	 * we don't explicitly enable it here.
15731da177e4SLinus Torvalds 	 */
1574b94dc6b5SDavid Brownell 	if (device_may_wakeup(&udev->dev)) {
15751da177e4SLinus Torvalds 		status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
15761da177e4SLinus Torvalds 				USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
15771da177e4SLinus Torvalds 				USB_DEVICE_REMOTE_WAKEUP, 0,
15781da177e4SLinus Torvalds 				NULL, 0,
15791da177e4SLinus Torvalds 				USB_CTRL_SET_TIMEOUT);
15801da177e4SLinus Torvalds 		if (status)
15811da177e4SLinus Torvalds 			dev_dbg(&udev->dev,
15821da177e4SLinus Torvalds 				"won't remote wakeup, status %d\n",
15831da177e4SLinus Torvalds 				status);
15841da177e4SLinus Torvalds 	}
15851da177e4SLinus Torvalds 
15861da177e4SLinus Torvalds 	/* see 7.1.7.6 */
15871da177e4SLinus Torvalds 	status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
15881da177e4SLinus Torvalds 	if (status) {
15891da177e4SLinus Torvalds 		dev_dbg(hub->intfdev,
15901da177e4SLinus Torvalds 			"can't suspend port %d, status %d\n",
15911da177e4SLinus Torvalds 			port1, status);
15921da177e4SLinus Torvalds 		/* paranoia:  "should not happen" */
15931da177e4SLinus Torvalds 		(void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
15941da177e4SLinus Torvalds 				USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
15951da177e4SLinus Torvalds 				USB_DEVICE_REMOTE_WAKEUP, 0,
15961da177e4SLinus Torvalds 				NULL, 0,
15971da177e4SLinus Torvalds 				USB_CTRL_SET_TIMEOUT);
15981da177e4SLinus Torvalds 	} else {
15991da177e4SLinus Torvalds 		/* device has up to 10 msec to fully suspend */
16001da177e4SLinus Torvalds 		dev_dbg(&udev->dev, "usb suspend\n");
16011da177e4SLinus Torvalds 		usb_set_device_state(udev, USB_STATE_SUSPENDED);
16021da177e4SLinus Torvalds 		msleep(10);
16031da177e4SLinus Torvalds 	}
16041da177e4SLinus Torvalds 	return status;
16051da177e4SLinus Torvalds }
16061da177e4SLinus Torvalds 
16071da177e4SLinus Torvalds /*
16081da177e4SLinus Torvalds  * Devices on USB hub ports have only one "suspend" state, corresponding
1609ba9d35fbSPavel Machek  * to ACPI D2, "may cause the device to lose some context".
16101da177e4SLinus Torvalds  * State transitions include:
16111da177e4SLinus Torvalds  *
16121da177e4SLinus Torvalds  *   - suspend, resume ... when the VBUS power link stays live
16131da177e4SLinus Torvalds  *   - suspend, disconnect ... VBUS lost
16141da177e4SLinus Torvalds  *
16151da177e4SLinus Torvalds  * Once VBUS drop breaks the circuit, the port it's using has to go through
16161da177e4SLinus Torvalds  * normal re-enumeration procedures, starting with enabling VBUS power.
16171da177e4SLinus Torvalds  * Other than re-initializing the hub (plug/unplug, except for root hubs),
16181da177e4SLinus Torvalds  * Linux (2.6) currently has NO mechanisms to initiate that:  no khubd
16191da177e4SLinus Torvalds  * timer, no SRP, no requests through sysfs.
1620390a8c34SDavid Brownell  *
1621390a8c34SDavid Brownell  * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
1622390a8c34SDavid Brownell  * the root hub for their bus goes into global suspend ... so we don't
1623390a8c34SDavid Brownell  * (falsely) update the device power state to say it suspended.
16241da177e4SLinus Torvalds  */
1625390a8c34SDavid Brownell static int __usb_suspend_device (struct usb_device *udev, int port1)
16261da177e4SLinus Torvalds {
1627f3f3253dSDavid Brownell 	int	status = 0;
16281da177e4SLinus Torvalds 
16291da177e4SLinus Torvalds 	/* caller owns the udev device lock */
16301da177e4SLinus Torvalds 	if (port1 < 0)
16311da177e4SLinus Torvalds 		return port1;
16321da177e4SLinus Torvalds 
16331da177e4SLinus Torvalds 	if (udev->state == USB_STATE_SUSPENDED
16341da177e4SLinus Torvalds 			|| udev->state == USB_STATE_NOTATTACHED) {
16351da177e4SLinus Torvalds 		return 0;
16361da177e4SLinus Torvalds 	}
16371da177e4SLinus Torvalds 
1638c9f89fa4SDavid Brownell 	/* all interfaces must already be suspended */
16391da177e4SLinus Torvalds 	if (udev->actconfig) {
16401da177e4SLinus Torvalds 		int	i;
16411da177e4SLinus Torvalds 
16421da177e4SLinus Torvalds 		for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
16431da177e4SLinus Torvalds 			struct usb_interface	*intf;
16441da177e4SLinus Torvalds 
16451da177e4SLinus Torvalds 			intf = udev->actconfig->interface[i];
1646c9f89fa4SDavid Brownell 			if (is_active(intf)) {
1647c9f89fa4SDavid Brownell 				dev_dbg(&intf->dev, "nyet suspended\n");
1648c9f89fa4SDavid Brownell 				return -EBUSY;
16491da177e4SLinus Torvalds 			}
16501da177e4SLinus Torvalds 		}
16511da177e4SLinus Torvalds 	}
16521da177e4SLinus Torvalds 
1653f3f3253dSDavid Brownell 	/* we only change a device's upstream USB link.
1654f3f3253dSDavid Brownell 	 * root hubs have no upstream USB link.
16551da177e4SLinus Torvalds 	 */
1656f3f3253dSDavid Brownell 	if (udev->parent)
16571da177e4SLinus Torvalds 		status = hub_port_suspend(hdev_to_hub(udev->parent), port1,
16581da177e4SLinus Torvalds 				udev);
16591da177e4SLinus Torvalds 
16601da177e4SLinus Torvalds 	if (status == 0)
1661390a8c34SDavid Brownell 		udev->dev.power.power_state = PMSG_SUSPEND;
16621da177e4SLinus Torvalds 	return status;
16631da177e4SLinus Torvalds }
16641da177e4SLinus Torvalds 
1665f3f3253dSDavid Brownell #endif
1666f3f3253dSDavid Brownell 
16675edbfb7cSDavid Brownell /*
16681da177e4SLinus Torvalds  * usb_suspend_device - suspend a usb device
16691da177e4SLinus Torvalds  * @udev: device that's no longer in active use
16705edbfb7cSDavid Brownell  * Context: must be able to sleep; device not locked; pm locks held
16711da177e4SLinus Torvalds  *
16721da177e4SLinus Torvalds  * Suspends a USB device that isn't in active use, conserving power.
16731da177e4SLinus Torvalds  * Devices may wake out of a suspend, if anything important happens,
16741da177e4SLinus Torvalds  * using the remote wakeup mechanism.  They may also be taken out of
16751da177e4SLinus Torvalds  * suspend by the host, using usb_resume_device().  It's also routine
16761da177e4SLinus Torvalds  * to disconnect devices while they are suspended.
16771da177e4SLinus Torvalds  *
1678390a8c34SDavid Brownell  * This only affects the USB hardware for a device; its interfaces
1679390a8c34SDavid Brownell  * (and, for hubs, child devices) must already have been suspended.
1680390a8c34SDavid Brownell  *
16811da177e4SLinus Torvalds  * Suspending OTG devices may trigger HNP, if that's been enabled
16821da177e4SLinus Torvalds  * between a pair of dual-role devices.  That will change roles, such
16831da177e4SLinus Torvalds  * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
16841da177e4SLinus Torvalds  *
16851da177e4SLinus Torvalds  * Returns 0 on success, else negative errno.
16861da177e4SLinus Torvalds  */
1687390a8c34SDavid Brownell int usb_suspend_device(struct usb_device *udev)
16881da177e4SLinus Torvalds {
1689f3f3253dSDavid Brownell #ifdef	CONFIG_USB_SUSPEND
16901da177e4SLinus Torvalds 	int	port1, status;
16911da177e4SLinus Torvalds 
16921da177e4SLinus Torvalds 	port1 = locktree(udev);
16931da177e4SLinus Torvalds 	if (port1 < 0)
16941da177e4SLinus Torvalds 		return port1;
16951da177e4SLinus Torvalds 
1696390a8c34SDavid Brownell 	status = __usb_suspend_device(udev, port1);
16971da177e4SLinus Torvalds 	usb_unlock_device(udev);
16981da177e4SLinus Torvalds 	return status;
1699f3f3253dSDavid Brownell #else
1700f3f3253dSDavid Brownell 	/* NOTE:  udev->state unchanged, it's not lying ... */
1701f3f3253dSDavid Brownell 	udev->dev.power.power_state = PMSG_SUSPEND;
1702f3f3253dSDavid Brownell 	return 0;
1703f3f3253dSDavid Brownell #endif
17041da177e4SLinus Torvalds }
1705f3f3253dSDavid Brownell 
17061da177e4SLinus Torvalds /*
1707390a8c34SDavid Brownell  * If the USB "suspend" state is in use (rather than "global suspend"),
1708390a8c34SDavid Brownell  * many devices will be individually taken out of suspend state using
1709390a8c34SDavid Brownell  * special" resume" signaling.  These routines kick in shortly after
17101da177e4SLinus Torvalds  * hardware resume signaling is finished, either because of selective
17111da177e4SLinus Torvalds  * resume (by host) or remote wakeup (by device) ... now see what changed
17121da177e4SLinus Torvalds  * in the tree that's rooted at this device.
17131da177e4SLinus Torvalds  */
1714f3f3253dSDavid Brownell static int finish_device_resume(struct usb_device *udev)
17151da177e4SLinus Torvalds {
17161da177e4SLinus Torvalds 	int	status;
17171da177e4SLinus Torvalds 	u16	devstatus;
17181da177e4SLinus Torvalds 
17191da177e4SLinus Torvalds 	/* caller owns the udev device lock */
1720f3f3253dSDavid Brownell 	dev_dbg(&udev->dev, "finish resume\n");
17211da177e4SLinus Torvalds 
17221da177e4SLinus Torvalds 	/* usb ch9 identifies four variants of SUSPENDED, based on what
17231da177e4SLinus Torvalds 	 * state the device resumes to.  Linux currently won't see the
17241da177e4SLinus Torvalds 	 * first two on the host side; they'd be inside hub_port_init()
17251da177e4SLinus Torvalds 	 * during many timeouts, but khubd can't suspend until later.
17261da177e4SLinus Torvalds 	 */
17271da177e4SLinus Torvalds 	usb_set_device_state(udev, udev->actconfig
17281da177e4SLinus Torvalds 			? USB_STATE_CONFIGURED
17291da177e4SLinus Torvalds 			: USB_STATE_ADDRESS);
17301da177e4SLinus Torvalds 
17311da177e4SLinus Torvalds  	/* 10.5.4.5 says be sure devices in the tree are still there.
17321da177e4SLinus Torvalds  	 * For now let's assume the device didn't go crazy on resume,
17331da177e4SLinus Torvalds 	 * and device drivers will know about any resume quirks.
17341da177e4SLinus Torvalds 	 */
17351da177e4SLinus Torvalds 	status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
17361da177e4SLinus Torvalds 	if (status < 0)
17371da177e4SLinus Torvalds 		dev_dbg(&udev->dev,
17381da177e4SLinus Torvalds 			"gone after usb resume? status %d\n",
17391da177e4SLinus Torvalds 			status);
17401da177e4SLinus Torvalds 	else if (udev->actconfig) {
17411da177e4SLinus Torvalds 		unsigned	i;
1742dbc3887eSDavid Brownell 		int		(*resume)(struct device *);
17431da177e4SLinus Torvalds 
17441da177e4SLinus Torvalds 		le16_to_cpus(&devstatus);
1745f3f3253dSDavid Brownell 		if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)
1746f3f3253dSDavid Brownell 				&& udev->parent) {
17471da177e4SLinus Torvalds 			status = usb_control_msg(udev,
17481da177e4SLinus Torvalds 					usb_sndctrlpipe(udev, 0),
17491da177e4SLinus Torvalds 					USB_REQ_CLEAR_FEATURE,
17501da177e4SLinus Torvalds 						USB_RECIP_DEVICE,
17511da177e4SLinus Torvalds 					USB_DEVICE_REMOTE_WAKEUP, 0,
17521da177e4SLinus Torvalds 					NULL, 0,
17531da177e4SLinus Torvalds 					USB_CTRL_SET_TIMEOUT);
17541da177e4SLinus Torvalds 			if (status) {
17551da177e4SLinus Torvalds 				dev_dbg(&udev->dev, "disable remote "
17561da177e4SLinus Torvalds 					"wakeup, status %d\n", status);
17571da177e4SLinus Torvalds 				status = 0;
17581da177e4SLinus Torvalds 			}
17591da177e4SLinus Torvalds 		}
17601da177e4SLinus Torvalds 
17611da177e4SLinus Torvalds 		/* resume interface drivers; if this is a hub, it
1762dbc3887eSDavid Brownell 		 * may have a child resume event to deal with soon
17631da177e4SLinus Torvalds 		 */
1764dbc3887eSDavid Brownell 		resume = udev->dev.bus->resume;
1765dbc3887eSDavid Brownell 		for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++)
1766dbc3887eSDavid Brownell 			(void) resume(&udev->actconfig->interface[i]->dev);
17671da177e4SLinus Torvalds 		status = 0;
17681da177e4SLinus Torvalds 
17691da177e4SLinus Torvalds 	} else if (udev->devnum <= 0) {
17701da177e4SLinus Torvalds 		dev_dbg(&udev->dev, "bogus resume!\n");
17711da177e4SLinus Torvalds 		status = -EINVAL;
17721da177e4SLinus Torvalds 	}
17731da177e4SLinus Torvalds 	return status;
17741da177e4SLinus Torvalds }
17751da177e4SLinus Torvalds 
1776f3f3253dSDavid Brownell #ifdef	CONFIG_USB_SUSPEND
1777f3f3253dSDavid Brownell 
17781da177e4SLinus Torvalds static int
17791da177e4SLinus Torvalds hub_port_resume(struct usb_hub *hub, int port1, struct usb_device *udev)
17801da177e4SLinus Torvalds {
17811da177e4SLinus Torvalds 	int	status;
17821da177e4SLinus Torvalds 
17831da177e4SLinus Torvalds 	// dev_dbg(hub->intfdev, "resume port %d\n", port1);
17841da177e4SLinus Torvalds 
17851da177e4SLinus Torvalds 	/* see 7.1.7.7; affects power usage, but not budgeting */
17861da177e4SLinus Torvalds 	status = clear_port_feature(hub->hdev,
17871da177e4SLinus Torvalds 			port1, USB_PORT_FEAT_SUSPEND);
17881da177e4SLinus Torvalds 	if (status) {
17891da177e4SLinus Torvalds 		dev_dbg(hub->intfdev,
17901da177e4SLinus Torvalds 			"can't resume port %d, status %d\n",
17911da177e4SLinus Torvalds 			port1, status);
17921da177e4SLinus Torvalds 	} else {
17931da177e4SLinus Torvalds 		u16		devstatus;
17941da177e4SLinus Torvalds 		u16		portchange;
17951da177e4SLinus Torvalds 
17961da177e4SLinus Torvalds 		/* drive resume for at least 20 msec */
17971da177e4SLinus Torvalds 		if (udev)
17981da177e4SLinus Torvalds 			dev_dbg(&udev->dev, "RESUME\n");
17991da177e4SLinus Torvalds 		msleep(25);
18001da177e4SLinus Torvalds 
18011da177e4SLinus Torvalds #define LIVE_FLAGS	( USB_PORT_STAT_POWER \
18021da177e4SLinus Torvalds 			| USB_PORT_STAT_ENABLE \
18031da177e4SLinus Torvalds 			| USB_PORT_STAT_CONNECTION)
18041da177e4SLinus Torvalds 
18051da177e4SLinus Torvalds 		/* Virtual root hubs can trigger on GET_PORT_STATUS to
18061da177e4SLinus Torvalds 		 * stop resume signaling.  Then finish the resume
18071da177e4SLinus Torvalds 		 * sequence.
18081da177e4SLinus Torvalds 		 */
18091da177e4SLinus Torvalds 		devstatus = portchange = 0;
18101da177e4SLinus Torvalds 		status = hub_port_status(hub, port1,
18111da177e4SLinus Torvalds 				&devstatus, &portchange);
18121da177e4SLinus Torvalds 		if (status < 0
18131da177e4SLinus Torvalds 				|| (devstatus & LIVE_FLAGS) != LIVE_FLAGS
18141da177e4SLinus Torvalds 				|| (devstatus & USB_PORT_STAT_SUSPEND) != 0
18151da177e4SLinus Torvalds 				) {
18161da177e4SLinus Torvalds 			dev_dbg(hub->intfdev,
18171da177e4SLinus Torvalds 				"port %d status %04x.%04x after resume, %d\n",
18181da177e4SLinus Torvalds 				port1, portchange, devstatus, status);
18191da177e4SLinus Torvalds 		} else {
18201da177e4SLinus Torvalds 			/* TRSMRCY = 10 msec */
18211da177e4SLinus Torvalds 			msleep(10);
18221da177e4SLinus Torvalds 			if (udev)
1823f3f3253dSDavid Brownell 				status = finish_device_resume(udev);
18241da177e4SLinus Torvalds 		}
18251da177e4SLinus Torvalds 	}
18261da177e4SLinus Torvalds 	if (status < 0)
18271da177e4SLinus Torvalds 		hub_port_logical_disconnect(hub, port1);
18281da177e4SLinus Torvalds 
18291da177e4SLinus Torvalds 	return status;
18301da177e4SLinus Torvalds }
18311da177e4SLinus Torvalds 
1832f3f3253dSDavid Brownell #endif
18331da177e4SLinus Torvalds 
18345edbfb7cSDavid Brownell /*
18351da177e4SLinus Torvalds  * usb_resume_device - re-activate a suspended usb device
18361da177e4SLinus Torvalds  * @udev: device to re-activate
18375edbfb7cSDavid Brownell  * Context: must be able to sleep; device not locked; pm locks held
18381da177e4SLinus Torvalds  *
18391da177e4SLinus Torvalds  * This will re-activate the suspended device, increasing power usage
18401da177e4SLinus Torvalds  * while letting drivers communicate again with its endpoints.
18411da177e4SLinus Torvalds  * USB resume explicitly guarantees that the power session between
18421da177e4SLinus Torvalds  * the host and the device is the same as it was when the device
18431da177e4SLinus Torvalds  * suspended.
18441da177e4SLinus Torvalds  *
18451da177e4SLinus Torvalds  * Returns 0 on success, else negative errno.
18461da177e4SLinus Torvalds  */
18471da177e4SLinus Torvalds int usb_resume_device(struct usb_device *udev)
18481da177e4SLinus Torvalds {
18491da177e4SLinus Torvalds 	int	port1, status;
18501da177e4SLinus Torvalds 
18511da177e4SLinus Torvalds 	port1 = locktree(udev);
18521da177e4SLinus Torvalds 	if (port1 < 0)
18531da177e4SLinus Torvalds 		return port1;
18541da177e4SLinus Torvalds 
1855f3f3253dSDavid Brownell #ifdef	CONFIG_USB_SUSPEND
1856f3f3253dSDavid Brownell 	/* selective resume of one downstream hub-to-device port */
1857f3f3253dSDavid Brownell 	if (udev->parent) {
1858f3f3253dSDavid Brownell 		if (udev->state == USB_STATE_SUSPENDED) {
1859f3f3253dSDavid Brownell 			// NOTE swsusp may bork us, device state being wrong...
18601da177e4SLinus Torvalds 			// NOTE this fails if parent is also suspended...
18611da177e4SLinus Torvalds 			status = hub_port_resume(hdev_to_hub(udev->parent),
18621da177e4SLinus Torvalds 					port1, udev);
1863f3f3253dSDavid Brownell 		} else
18641da177e4SLinus Torvalds 			status = 0;
1865f3f3253dSDavid Brownell 	} else
1866f3f3253dSDavid Brownell #endif
1867f3f3253dSDavid Brownell 		status = finish_device_resume(udev);
1868f3f3253dSDavid Brownell 	if (status < 0)
18691da177e4SLinus Torvalds 		dev_dbg(&udev->dev, "can't resume, status %d\n",
18701da177e4SLinus Torvalds 			status);
18711da177e4SLinus Torvalds 
18721da177e4SLinus Torvalds 	usb_unlock_device(udev);
18731da177e4SLinus Torvalds 
18741da177e4SLinus Torvalds 	/* rebind drivers that had no suspend() */
18751da177e4SLinus Torvalds 	if (status == 0) {
18761da177e4SLinus Torvalds 		usb_lock_all_devices();
18771da177e4SLinus Torvalds 		bus_rescan_devices(&usb_bus_type);
18781da177e4SLinus Torvalds 		usb_unlock_all_devices();
18791da177e4SLinus Torvalds 	}
18801da177e4SLinus Torvalds 	return status;
18811da177e4SLinus Torvalds }
18821da177e4SLinus Torvalds 
18831da177e4SLinus Torvalds static int remote_wakeup(struct usb_device *udev)
18841da177e4SLinus Torvalds {
18851da177e4SLinus Torvalds 	int	status = 0;
18861da177e4SLinus Torvalds 
1887f3f3253dSDavid Brownell #ifdef	CONFIG_USB_SUSPEND
1888f3f3253dSDavid Brownell 
18891da177e4SLinus Torvalds 	/* don't repeat RESUME sequence if this device
18901da177e4SLinus Torvalds 	 * was already woken up by some other task
18911da177e4SLinus Torvalds 	 */
18921da177e4SLinus Torvalds 	down(&udev->serialize);
18931da177e4SLinus Torvalds 	if (udev->state == USB_STATE_SUSPENDED) {
18941da177e4SLinus Torvalds 		dev_dbg(&udev->dev, "RESUME (wakeup)\n");
18951da177e4SLinus Torvalds 		/* TRSMRCY = 10 msec */
18961da177e4SLinus Torvalds 		msleep(10);
1897f3f3253dSDavid Brownell 		status = finish_device_resume(udev);
18981da177e4SLinus Torvalds 	}
18991da177e4SLinus Torvalds 	up(&udev->serialize);
1900f3f3253dSDavid Brownell #endif
19011da177e4SLinus Torvalds 	return status;
19021da177e4SLinus Torvalds }
19031da177e4SLinus Torvalds 
1904db690874SDavid Brownell static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
19051da177e4SLinus Torvalds {
19061da177e4SLinus Torvalds 	struct usb_hub		*hub = usb_get_intfdata (intf);
19071da177e4SLinus Torvalds 	struct usb_device	*hdev = hub->hdev;
19081da177e4SLinus Torvalds 	unsigned		port1;
19091da177e4SLinus Torvalds 
1910c9f89fa4SDavid Brownell 	/* fail if children aren't already suspended */
19111da177e4SLinus Torvalds 	for (port1 = 1; port1 <= hdev->maxchild; port1++) {
19121da177e4SLinus Torvalds 		struct usb_device	*udev;
19131da177e4SLinus Torvalds 
19141da177e4SLinus Torvalds 		udev = hdev->children [port1-1];
1915f3f3253dSDavid Brownell 		if (udev && (udev->dev.power.power_state.event
1916f3f3253dSDavid Brownell 					== PM_EVENT_ON
1917f3f3253dSDavid Brownell #ifdef	CONFIG_USB_SUSPEND
1918f3f3253dSDavid Brownell 				|| udev->state != USB_STATE_SUSPENDED
1919f3f3253dSDavid Brownell #endif
1920f3f3253dSDavid Brownell 				)) {
1921c9f89fa4SDavid Brownell 			dev_dbg(&intf->dev, "port %d nyet suspended\n", port1);
1922c9f89fa4SDavid Brownell 			return -EBUSY;
1923c9f89fa4SDavid Brownell 		}
19241da177e4SLinus Torvalds 	}
19251da177e4SLinus Torvalds 
1926f3f3253dSDavid Brownell 	/* "global suspend" of the downstream HC-to-USB interface */
1927f3f3253dSDavid Brownell 	if (!hdev->parent) {
1928f3f3253dSDavid Brownell 		struct usb_bus	*bus = hdev->bus;
19290c0382e3SAlan Stern 		if (bus) {
19300c0382e3SAlan Stern 			int	status = hcd_bus_suspend (bus);
1931f3f3253dSDavid Brownell 
1932f3f3253dSDavid Brownell 			if (status != 0) {
1933f3f3253dSDavid Brownell 				dev_dbg(&hdev->dev, "'global' suspend %d\n",
1934f3f3253dSDavid Brownell 					status);
1935f3f3253dSDavid Brownell 				return status;
1936f3f3253dSDavid Brownell 			}
1937f3f3253dSDavid Brownell 		} else
1938f3f3253dSDavid Brownell 			return -EOPNOTSUPP;
1939f3f3253dSDavid Brownell 	}
1940f3f3253dSDavid Brownell 
1941c9f89fa4SDavid Brownell 	/* stop khubd and related activity */
1942c9f89fa4SDavid Brownell 	hub_quiesce(hub);
19431da177e4SLinus Torvalds 	return 0;
19441da177e4SLinus Torvalds }
19451da177e4SLinus Torvalds 
19461da177e4SLinus Torvalds static int hub_resume(struct usb_interface *intf)
19471da177e4SLinus Torvalds {
19481da177e4SLinus Torvalds 	struct usb_device	*hdev = interface_to_usbdev(intf);
19491da177e4SLinus Torvalds 	struct usb_hub		*hub = usb_get_intfdata (intf);
19501da177e4SLinus Torvalds 	int			status;
19511da177e4SLinus Torvalds 
1952f3f3253dSDavid Brownell 	/* "global resume" of the downstream HC-to-USB interface */
1953f3f3253dSDavid Brownell 	if (!hdev->parent) {
1954f3f3253dSDavid Brownell 		struct usb_bus	*bus = hdev->bus;
19550c0382e3SAlan Stern 		if (bus) {
19560c0382e3SAlan Stern 			status = hcd_bus_resume (bus);
1957f3f3253dSDavid Brownell 			if (status) {
1958f3f3253dSDavid Brownell 				dev_dbg(&intf->dev, "'global' resume %d\n",
1959f3f3253dSDavid Brownell 					status);
1960f3f3253dSDavid Brownell 				return status;
1961f3f3253dSDavid Brownell 			}
1962f3f3253dSDavid Brownell 		} else
1963f3f3253dSDavid Brownell 			return -EOPNOTSUPP;
1964f3f3253dSDavid Brownell 		if (status == 0) {
1965f3f3253dSDavid Brownell 			/* TRSMRCY = 10 msec */
1966f3f3253dSDavid Brownell 			msleep(10);
1967f3f3253dSDavid Brownell 		}
1968f3f3253dSDavid Brownell 	}
1969f3f3253dSDavid Brownell 
1970f3f3253dSDavid Brownell 	hub_activate(hub);
1971f3f3253dSDavid Brownell 
1972f3f3253dSDavid Brownell 	/* REVISIT:  this recursion probably shouldn't exist.  Remove
1973f3f3253dSDavid Brownell 	 * this code sometime, after retesting with different root and
1974f3f3253dSDavid Brownell 	 * external hubs.
1975f3f3253dSDavid Brownell 	 */
1976f3f3253dSDavid Brownell #ifdef	CONFIG_USB_SUSPEND
1977f3f3253dSDavid Brownell 	{
1978f3f3253dSDavid Brownell 	unsigned		port1;
1979f3f3253dSDavid Brownell 
19801da177e4SLinus Torvalds 	for (port1 = 1; port1 <= hdev->maxchild; port1++) {
19811da177e4SLinus Torvalds 		struct usb_device	*udev;
19821da177e4SLinus Torvalds 		u16			portstat, portchange;
19831da177e4SLinus Torvalds 
19841da177e4SLinus Torvalds 		udev = hdev->children [port1-1];
19851da177e4SLinus Torvalds 		status = hub_port_status(hub, port1, &portstat, &portchange);
19861da177e4SLinus Torvalds 		if (status == 0) {
19871da177e4SLinus Torvalds 			if (portchange & USB_PORT_STAT_C_SUSPEND) {
19881da177e4SLinus Torvalds 				clear_port_feature(hdev, port1,
19891da177e4SLinus Torvalds 					USB_PORT_FEAT_C_SUSPEND);
19901da177e4SLinus Torvalds 				portchange &= ~USB_PORT_STAT_C_SUSPEND;
19911da177e4SLinus Torvalds 			}
19921da177e4SLinus Torvalds 
19931da177e4SLinus Torvalds 			/* let khubd handle disconnects etc */
19941da177e4SLinus Torvalds 			if (portchange)
19951da177e4SLinus Torvalds 				continue;
19961da177e4SLinus Torvalds 		}
19971da177e4SLinus Torvalds 
19981da177e4SLinus Torvalds 		if (!udev || status < 0)
19991da177e4SLinus Torvalds 			continue;
20001da177e4SLinus Torvalds 		down (&udev->serialize);
20011da177e4SLinus Torvalds 		if (portstat & USB_PORT_STAT_SUSPEND)
20021da177e4SLinus Torvalds 			status = hub_port_resume(hub, port1, udev);
20031da177e4SLinus Torvalds 		else {
2004f3f3253dSDavid Brownell 			status = finish_device_resume(udev);
20051da177e4SLinus Torvalds 			if (status < 0) {
20061da177e4SLinus Torvalds 				dev_dbg(&intf->dev, "resume port %d --> %d\n",
20071da177e4SLinus Torvalds 					port1, status);
20081da177e4SLinus Torvalds 				hub_port_logical_disconnect(hub, port1);
20091da177e4SLinus Torvalds 			}
20101da177e4SLinus Torvalds 		}
20111da177e4SLinus Torvalds 		up(&udev->serialize);
20121da177e4SLinus Torvalds 	}
2013f3f3253dSDavid Brownell 	}
2014f3f3253dSDavid Brownell #endif
20151da177e4SLinus Torvalds 	return 0;
20161da177e4SLinus Torvalds }
20171da177e4SLinus Torvalds 
2018979d5199SDavid Brownell void usb_suspend_root_hub(struct usb_device *hdev)
2019979d5199SDavid Brownell {
2020979d5199SDavid Brownell 	struct usb_hub *hub = hdev_to_hub(hdev);
2021979d5199SDavid Brownell 
2022979d5199SDavid Brownell 	/* This also makes any led blinker stop retriggering.  We're called
2023979d5199SDavid Brownell 	 * from irq, so the blinker might still be scheduled.  Caller promises
2024979d5199SDavid Brownell 	 * that the root hub status URB will be canceled.
2025979d5199SDavid Brownell 	 */
2026979d5199SDavid Brownell 	__hub_quiesce(hub);
2027979d5199SDavid Brownell 	mark_quiesced(to_usb_interface(hub->intfdev));
2028979d5199SDavid Brownell }
2029979d5199SDavid Brownell 
20301da177e4SLinus Torvalds void usb_resume_root_hub(struct usb_device *hdev)
20311da177e4SLinus Torvalds {
20321da177e4SLinus Torvalds 	struct usb_hub *hub = hdev_to_hub(hdev);
20331da177e4SLinus Torvalds 
20341da177e4SLinus Torvalds 	hub->resume_root_hub = 1;
20351da177e4SLinus Torvalds 	kick_khubd(hub);
20361da177e4SLinus Torvalds }
20371da177e4SLinus Torvalds 
20381da177e4SLinus Torvalds 
20391da177e4SLinus Torvalds /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
20401da177e4SLinus Torvalds  *
20411da177e4SLinus Torvalds  * Between connect detection and reset signaling there must be a delay
20421da177e4SLinus Torvalds  * of 100ms at least for debounce and power-settling.  The corresponding
20431da177e4SLinus Torvalds  * timer shall restart whenever the downstream port detects a disconnect.
20441da177e4SLinus Torvalds  *
20451da177e4SLinus Torvalds  * Apparently there are some bluetooth and irda-dongles and a number of
20461da177e4SLinus Torvalds  * low-speed devices for which this debounce period may last over a second.
20471da177e4SLinus Torvalds  * Not covered by the spec - but easy to deal with.
20481da177e4SLinus Torvalds  *
20491da177e4SLinus Torvalds  * This implementation uses a 1500ms total debounce timeout; if the
20501da177e4SLinus Torvalds  * connection isn't stable by then it returns -ETIMEDOUT.  It checks
20511da177e4SLinus Torvalds  * every 25ms for transient disconnects.  When the port status has been
20521da177e4SLinus Torvalds  * unchanged for 100ms it returns the port status.
20531da177e4SLinus Torvalds  */
20541da177e4SLinus Torvalds 
20551da177e4SLinus Torvalds #define HUB_DEBOUNCE_TIMEOUT	1500
20561da177e4SLinus Torvalds #define HUB_DEBOUNCE_STEP	  25
20571da177e4SLinus Torvalds #define HUB_DEBOUNCE_STABLE	 100
20581da177e4SLinus Torvalds 
20591da177e4SLinus Torvalds static int hub_port_debounce(struct usb_hub *hub, int port1)
20601da177e4SLinus Torvalds {
20611da177e4SLinus Torvalds 	int ret;
20621da177e4SLinus Torvalds 	int total_time, stable_time = 0;
20631da177e4SLinus Torvalds 	u16 portchange, portstatus;
20641da177e4SLinus Torvalds 	unsigned connection = 0xffff;
20651da177e4SLinus Torvalds 
20661da177e4SLinus Torvalds 	for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
20671da177e4SLinus Torvalds 		ret = hub_port_status(hub, port1, &portstatus, &portchange);
20681da177e4SLinus Torvalds 		if (ret < 0)
20691da177e4SLinus Torvalds 			return ret;
20701da177e4SLinus Torvalds 
20711da177e4SLinus Torvalds 		if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
20721da177e4SLinus Torvalds 		     (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
20731da177e4SLinus Torvalds 			stable_time += HUB_DEBOUNCE_STEP;
20741da177e4SLinus Torvalds 			if (stable_time >= HUB_DEBOUNCE_STABLE)
20751da177e4SLinus Torvalds 				break;
20761da177e4SLinus Torvalds 		} else {
20771da177e4SLinus Torvalds 			stable_time = 0;
20781da177e4SLinus Torvalds 			connection = portstatus & USB_PORT_STAT_CONNECTION;
20791da177e4SLinus Torvalds 		}
20801da177e4SLinus Torvalds 
20811da177e4SLinus Torvalds 		if (portchange & USB_PORT_STAT_C_CONNECTION) {
20821da177e4SLinus Torvalds 			clear_port_feature(hub->hdev, port1,
20831da177e4SLinus Torvalds 					USB_PORT_FEAT_C_CONNECTION);
20841da177e4SLinus Torvalds 		}
20851da177e4SLinus Torvalds 
20861da177e4SLinus Torvalds 		if (total_time >= HUB_DEBOUNCE_TIMEOUT)
20871da177e4SLinus Torvalds 			break;
20881da177e4SLinus Torvalds 		msleep(HUB_DEBOUNCE_STEP);
20891da177e4SLinus Torvalds 	}
20901da177e4SLinus Torvalds 
20911da177e4SLinus Torvalds 	dev_dbg (hub->intfdev,
20921da177e4SLinus Torvalds 		"debounce: port %d: total %dms stable %dms status 0x%x\n",
20931da177e4SLinus Torvalds 		port1, total_time, stable_time, portstatus);
20941da177e4SLinus Torvalds 
20951da177e4SLinus Torvalds 	if (stable_time < HUB_DEBOUNCE_STABLE)
20961da177e4SLinus Torvalds 		return -ETIMEDOUT;
20971da177e4SLinus Torvalds 	return portstatus;
20981da177e4SLinus Torvalds }
20991da177e4SLinus Torvalds 
21001da177e4SLinus Torvalds static void ep0_reinit(struct usb_device *udev)
21011da177e4SLinus Torvalds {
21021da177e4SLinus Torvalds 	usb_disable_endpoint(udev, 0 + USB_DIR_IN);
21031da177e4SLinus Torvalds 	usb_disable_endpoint(udev, 0 + USB_DIR_OUT);
21041da177e4SLinus Torvalds 	udev->ep_in[0] = udev->ep_out[0] = &udev->ep0;
21051da177e4SLinus Torvalds }
21061da177e4SLinus Torvalds 
21071da177e4SLinus Torvalds #define usb_sndaddr0pipe()	(PIPE_CONTROL << 30)
21081da177e4SLinus Torvalds #define usb_rcvaddr0pipe()	((PIPE_CONTROL << 30) | USB_DIR_IN)
21091da177e4SLinus Torvalds 
21101da177e4SLinus Torvalds static int hub_set_address(struct usb_device *udev)
21111da177e4SLinus Torvalds {
21121da177e4SLinus Torvalds 	int retval;
21131da177e4SLinus Torvalds 
21141da177e4SLinus Torvalds 	if (udev->devnum == 0)
21151da177e4SLinus Torvalds 		return -EINVAL;
21161da177e4SLinus Torvalds 	if (udev->state == USB_STATE_ADDRESS)
21171da177e4SLinus Torvalds 		return 0;
21181da177e4SLinus Torvalds 	if (udev->state != USB_STATE_DEFAULT)
21191da177e4SLinus Torvalds 		return -EINVAL;
21201da177e4SLinus Torvalds 	retval = usb_control_msg(udev, usb_sndaddr0pipe(),
21211da177e4SLinus Torvalds 		USB_REQ_SET_ADDRESS, 0, udev->devnum, 0,
21221da177e4SLinus Torvalds 		NULL, 0, USB_CTRL_SET_TIMEOUT);
21231da177e4SLinus Torvalds 	if (retval == 0) {
21241da177e4SLinus Torvalds 		usb_set_device_state(udev, USB_STATE_ADDRESS);
21251da177e4SLinus Torvalds 		ep0_reinit(udev);
21261da177e4SLinus Torvalds 	}
21271da177e4SLinus Torvalds 	return retval;
21281da177e4SLinus Torvalds }
21291da177e4SLinus Torvalds 
21301da177e4SLinus Torvalds /* Reset device, (re)assign address, get device descriptor.
21311da177e4SLinus Torvalds  * Device connection must be stable, no more debouncing needed.
21321da177e4SLinus Torvalds  * Returns device in USB_STATE_ADDRESS, except on error.
21331da177e4SLinus Torvalds  *
21341da177e4SLinus Torvalds  * If this is called for an already-existing device (as part of
21351da177e4SLinus Torvalds  * usb_reset_device), the caller must own the device lock.  For a
21361da177e4SLinus Torvalds  * newly detected device that is not accessible through any global
21371da177e4SLinus Torvalds  * pointers, it's not necessary to lock the device.
21381da177e4SLinus Torvalds  */
21391da177e4SLinus Torvalds static int
21401da177e4SLinus Torvalds hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
21411da177e4SLinus Torvalds 		int retry_counter)
21421da177e4SLinus Torvalds {
21431da177e4SLinus Torvalds 	static DECLARE_MUTEX(usb_address0_sem);
21441da177e4SLinus Torvalds 
21451da177e4SLinus Torvalds 	struct usb_device	*hdev = hub->hdev;
21461da177e4SLinus Torvalds 	int			i, j, retval;
21471da177e4SLinus Torvalds 	unsigned		delay = HUB_SHORT_RESET_TIME;
21481da177e4SLinus Torvalds 	enum usb_device_speed	oldspeed = udev->speed;
21491da177e4SLinus Torvalds 
21501da177e4SLinus Torvalds 	/* root hub ports have a slightly longer reset period
21511da177e4SLinus Torvalds 	 * (from USB 2.0 spec, section 7.1.7.5)
21521da177e4SLinus Torvalds 	 */
21531da177e4SLinus Torvalds 	if (!hdev->parent) {
21541da177e4SLinus Torvalds 		delay = HUB_ROOT_RESET_TIME;
21551da177e4SLinus Torvalds 		if (port1 == hdev->bus->otg_port)
21561da177e4SLinus Torvalds 			hdev->bus->b_hnp_enable = 0;
21571da177e4SLinus Torvalds 	}
21581da177e4SLinus Torvalds 
21591da177e4SLinus Torvalds 	/* Some low speed devices have problems with the quick delay, so */
21601da177e4SLinus Torvalds 	/*  be a bit pessimistic with those devices. RHbug #23670 */
21611da177e4SLinus Torvalds 	if (oldspeed == USB_SPEED_LOW)
21621da177e4SLinus Torvalds 		delay = HUB_LONG_RESET_TIME;
21631da177e4SLinus Torvalds 
21641da177e4SLinus Torvalds 	down(&usb_address0_sem);
21651da177e4SLinus Torvalds 
21661da177e4SLinus Torvalds 	/* Reset the device; full speed may morph to high speed */
21671da177e4SLinus Torvalds 	retval = hub_port_reset(hub, port1, udev, delay);
21681da177e4SLinus Torvalds 	if (retval < 0)		/* error or disconnect */
21691da177e4SLinus Torvalds 		goto fail;
21701da177e4SLinus Torvalds 				/* success, speed is known */
21711da177e4SLinus Torvalds 	retval = -ENODEV;
21721da177e4SLinus Torvalds 
21731da177e4SLinus Torvalds 	if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
21741da177e4SLinus Torvalds 		dev_dbg(&udev->dev, "device reset changed speed!\n");
21751da177e4SLinus Torvalds 		goto fail;
21761da177e4SLinus Torvalds 	}
21771da177e4SLinus Torvalds 	oldspeed = udev->speed;
21781da177e4SLinus Torvalds 
21791da177e4SLinus Torvalds 	/* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
21801da177e4SLinus Torvalds 	 * it's fixed size except for full speed devices.
21811da177e4SLinus Torvalds 	 */
21821da177e4SLinus Torvalds 	switch (udev->speed) {
21831da177e4SLinus Torvalds 	case USB_SPEED_HIGH:		/* fixed at 64 */
21841da177e4SLinus Torvalds 		udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
21851da177e4SLinus Torvalds 		break;
21861da177e4SLinus Torvalds 	case USB_SPEED_FULL:		/* 8, 16, 32, or 64 */
21871da177e4SLinus Torvalds 		/* to determine the ep0 maxpacket size, try to read
21881da177e4SLinus Torvalds 		 * the device descriptor to get bMaxPacketSize0 and
21891da177e4SLinus Torvalds 		 * then correct our initial guess.
21901da177e4SLinus Torvalds 		 */
21911da177e4SLinus Torvalds 		udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
21921da177e4SLinus Torvalds 		break;
21931da177e4SLinus Torvalds 	case USB_SPEED_LOW:		/* fixed at 8 */
21941da177e4SLinus Torvalds 		udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(8);
21951da177e4SLinus Torvalds 		break;
21961da177e4SLinus Torvalds 	default:
21971da177e4SLinus Torvalds 		goto fail;
21981da177e4SLinus Torvalds 	}
21991da177e4SLinus Torvalds 
22001da177e4SLinus Torvalds 	dev_info (&udev->dev,
22011da177e4SLinus Torvalds 			"%s %s speed USB device using %s and address %d\n",
22021da177e4SLinus Torvalds 			(udev->config) ? "reset" : "new",
22031da177e4SLinus Torvalds 			({ char *speed; switch (udev->speed) {
22041da177e4SLinus Torvalds 			case USB_SPEED_LOW:	speed = "low";	break;
22051da177e4SLinus Torvalds 			case USB_SPEED_FULL:	speed = "full";	break;
22061da177e4SLinus Torvalds 			case USB_SPEED_HIGH:	speed = "high";	break;
22071da177e4SLinus Torvalds 			default: 		speed = "?";	break;
22081da177e4SLinus Torvalds 			}; speed;}),
22091da177e4SLinus Torvalds 			udev->bus->controller->driver->name,
22101da177e4SLinus Torvalds 			udev->devnum);
22111da177e4SLinus Torvalds 
22121da177e4SLinus Torvalds 	/* Set up TT records, if needed  */
22131da177e4SLinus Torvalds 	if (hdev->tt) {
22141da177e4SLinus Torvalds 		udev->tt = hdev->tt;
22151da177e4SLinus Torvalds 		udev->ttport = hdev->ttport;
22161da177e4SLinus Torvalds 	} else if (udev->speed != USB_SPEED_HIGH
22171da177e4SLinus Torvalds 			&& hdev->speed == USB_SPEED_HIGH) {
22181da177e4SLinus Torvalds 		udev->tt = &hub->tt;
22191da177e4SLinus Torvalds 		udev->ttport = port1;
22201da177e4SLinus Torvalds 	}
22211da177e4SLinus Torvalds 
22221da177e4SLinus Torvalds 	/* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
22231da177e4SLinus Torvalds 	 * Because device hardware and firmware is sometimes buggy in
22241da177e4SLinus Torvalds 	 * this area, and this is how Linux has done it for ages.
22251da177e4SLinus Torvalds 	 * Change it cautiously.
22261da177e4SLinus Torvalds 	 *
22271da177e4SLinus Torvalds 	 * NOTE:  If USE_NEW_SCHEME() is true we will start by issuing
22281da177e4SLinus Torvalds 	 * a 64-byte GET_DESCRIPTOR request.  This is what Windows does,
22291da177e4SLinus Torvalds 	 * so it may help with some non-standards-compliant devices.
22301da177e4SLinus Torvalds 	 * Otherwise we start with SET_ADDRESS and then try to read the
22311da177e4SLinus Torvalds 	 * first 8 bytes of the device descriptor to get the ep0 maxpacket
22321da177e4SLinus Torvalds 	 * value.
22331da177e4SLinus Torvalds 	 */
22341da177e4SLinus Torvalds 	for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
22351da177e4SLinus Torvalds 		if (USE_NEW_SCHEME(retry_counter)) {
22361da177e4SLinus Torvalds 			struct usb_device_descriptor *buf;
22371da177e4SLinus Torvalds 			int r = 0;
22381da177e4SLinus Torvalds 
22391da177e4SLinus Torvalds #define GET_DESCRIPTOR_BUFSIZE	64
22401da177e4SLinus Torvalds 			buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
22411da177e4SLinus Torvalds 			if (!buf) {
22421da177e4SLinus Torvalds 				retval = -ENOMEM;
22431da177e4SLinus Torvalds 				continue;
22441da177e4SLinus Torvalds 			}
22451da177e4SLinus Torvalds 
22461da177e4SLinus Torvalds 			/* Use a short timeout the first time through,
22471da177e4SLinus Torvalds 			 * so that recalcitrant full-speed devices with
22481da177e4SLinus Torvalds 			 * 8- or 16-byte ep0-maxpackets won't slow things
22491da177e4SLinus Torvalds 			 * down tremendously by NAKing the unexpectedly
22501da177e4SLinus Torvalds 			 * early status stage.  Also, retry on all errors;
22511da177e4SLinus Torvalds 			 * some devices are flakey.
22521da177e4SLinus Torvalds 			 */
22531da177e4SLinus Torvalds 			for (j = 0; j < 3; ++j) {
22541da177e4SLinus Torvalds 				buf->bMaxPacketSize0 = 0;
22551da177e4SLinus Torvalds 				r = usb_control_msg(udev, usb_rcvaddr0pipe(),
22561da177e4SLinus Torvalds 					USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
22571da177e4SLinus Torvalds 					USB_DT_DEVICE << 8, 0,
22581da177e4SLinus Torvalds 					buf, GET_DESCRIPTOR_BUFSIZE,
22591da177e4SLinus Torvalds 					(i ? USB_CTRL_GET_TIMEOUT : 1000));
22601da177e4SLinus Torvalds 				switch (buf->bMaxPacketSize0) {
22611da177e4SLinus Torvalds 				case 8: case 16: case 32: case 64:
22621da177e4SLinus Torvalds 					if (buf->bDescriptorType ==
22631da177e4SLinus Torvalds 							USB_DT_DEVICE) {
22641da177e4SLinus Torvalds 						r = 0;
22651da177e4SLinus Torvalds 						break;
22661da177e4SLinus Torvalds 					}
22671da177e4SLinus Torvalds 					/* FALL THROUGH */
22681da177e4SLinus Torvalds 				default:
22691da177e4SLinus Torvalds 					if (r == 0)
22701da177e4SLinus Torvalds 						r = -EPROTO;
22711da177e4SLinus Torvalds 					break;
22721da177e4SLinus Torvalds 				}
22731da177e4SLinus Torvalds 				if (r == 0)
22741da177e4SLinus Torvalds 					break;
22751da177e4SLinus Torvalds 			}
22761da177e4SLinus Torvalds 			udev->descriptor.bMaxPacketSize0 =
22771da177e4SLinus Torvalds 					buf->bMaxPacketSize0;
22781da177e4SLinus Torvalds 			kfree(buf);
22791da177e4SLinus Torvalds 
22801da177e4SLinus Torvalds 			retval = hub_port_reset(hub, port1, udev, delay);
22811da177e4SLinus Torvalds 			if (retval < 0)		/* error or disconnect */
22821da177e4SLinus Torvalds 				goto fail;
22831da177e4SLinus Torvalds 			if (oldspeed != udev->speed) {
22841da177e4SLinus Torvalds 				dev_dbg(&udev->dev,
22851da177e4SLinus Torvalds 					"device reset changed speed!\n");
22861da177e4SLinus Torvalds 				retval = -ENODEV;
22871da177e4SLinus Torvalds 				goto fail;
22881da177e4SLinus Torvalds 			}
22891da177e4SLinus Torvalds 			if (r) {
22901da177e4SLinus Torvalds 				dev_err(&udev->dev, "device descriptor "
22911da177e4SLinus Torvalds 						"read/%s, error %d\n",
22921da177e4SLinus Torvalds 						"64", r);
22931da177e4SLinus Torvalds 				retval = -EMSGSIZE;
22941da177e4SLinus Torvalds 				continue;
22951da177e4SLinus Torvalds 			}
22961da177e4SLinus Torvalds #undef GET_DESCRIPTOR_BUFSIZE
22971da177e4SLinus Torvalds 		}
22981da177e4SLinus Torvalds 
22991da177e4SLinus Torvalds 		for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
23001da177e4SLinus Torvalds 			retval = hub_set_address(udev);
23011da177e4SLinus Torvalds 			if (retval >= 0)
23021da177e4SLinus Torvalds 				break;
23031da177e4SLinus Torvalds 			msleep(200);
23041da177e4SLinus Torvalds 		}
23051da177e4SLinus Torvalds 		if (retval < 0) {
23061da177e4SLinus Torvalds 			dev_err(&udev->dev,
23071da177e4SLinus Torvalds 				"device not accepting address %d, error %d\n",
23081da177e4SLinus Torvalds 				udev->devnum, retval);
23091da177e4SLinus Torvalds 			goto fail;
23101da177e4SLinus Torvalds 		}
23111da177e4SLinus Torvalds 
23121da177e4SLinus Torvalds 		/* cope with hardware quirkiness:
23131da177e4SLinus Torvalds 		 *  - let SET_ADDRESS settle, some device hardware wants it
23141da177e4SLinus Torvalds 		 *  - read ep0 maxpacket even for high and low speed,
23151da177e4SLinus Torvalds   		 */
23161da177e4SLinus Torvalds 		msleep(10);
23171da177e4SLinus Torvalds 		if (USE_NEW_SCHEME(retry_counter))
23181da177e4SLinus Torvalds 			break;
23191da177e4SLinus Torvalds 
23201da177e4SLinus Torvalds 		retval = usb_get_device_descriptor(udev, 8);
23211da177e4SLinus Torvalds 		if (retval < 8) {
23221da177e4SLinus Torvalds 			dev_err(&udev->dev, "device descriptor "
23231da177e4SLinus Torvalds 					"read/%s, error %d\n",
23241da177e4SLinus Torvalds 					"8", retval);
23251da177e4SLinus Torvalds 			if (retval >= 0)
23261da177e4SLinus Torvalds 				retval = -EMSGSIZE;
23271da177e4SLinus Torvalds 		} else {
23281da177e4SLinus Torvalds 			retval = 0;
23291da177e4SLinus Torvalds 			break;
23301da177e4SLinus Torvalds 		}
23311da177e4SLinus Torvalds 	}
23321da177e4SLinus Torvalds 	if (retval)
23331da177e4SLinus Torvalds 		goto fail;
23341da177e4SLinus Torvalds 
23351da177e4SLinus Torvalds 	i = udev->descriptor.bMaxPacketSize0;
23361da177e4SLinus Torvalds 	if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
23371da177e4SLinus Torvalds 		if (udev->speed != USB_SPEED_FULL ||
23381da177e4SLinus Torvalds 				!(i == 8 || i == 16 || i == 32 || i == 64)) {
23391da177e4SLinus Torvalds 			dev_err(&udev->dev, "ep0 maxpacket = %d\n", i);
23401da177e4SLinus Torvalds 			retval = -EMSGSIZE;
23411da177e4SLinus Torvalds 			goto fail;
23421da177e4SLinus Torvalds 		}
23431da177e4SLinus Torvalds 		dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
23441da177e4SLinus Torvalds 		udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
23451da177e4SLinus Torvalds 		ep0_reinit(udev);
23461da177e4SLinus Torvalds 	}
23471da177e4SLinus Torvalds 
23481da177e4SLinus Torvalds 	retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
23491da177e4SLinus Torvalds 	if (retval < (signed)sizeof(udev->descriptor)) {
23501da177e4SLinus Torvalds 		dev_err(&udev->dev, "device descriptor read/%s, error %d\n",
23511da177e4SLinus Torvalds 			"all", retval);
23521da177e4SLinus Torvalds 		if (retval >= 0)
23531da177e4SLinus Torvalds 			retval = -ENOMSG;
23541da177e4SLinus Torvalds 		goto fail;
23551da177e4SLinus Torvalds 	}
23561da177e4SLinus Torvalds 
23571da177e4SLinus Torvalds 	retval = 0;
23581da177e4SLinus Torvalds 
23591da177e4SLinus Torvalds fail:
23601da177e4SLinus Torvalds 	if (retval)
23611da177e4SLinus Torvalds 		hub_port_disable(hub, port1, 0);
23621da177e4SLinus Torvalds 	up(&usb_address0_sem);
23631da177e4SLinus Torvalds 	return retval;
23641da177e4SLinus Torvalds }
23651da177e4SLinus Torvalds 
23661da177e4SLinus Torvalds static void
23671da177e4SLinus Torvalds check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
23681da177e4SLinus Torvalds {
23691da177e4SLinus Torvalds 	struct usb_qualifier_descriptor	*qual;
23701da177e4SLinus Torvalds 	int				status;
23711da177e4SLinus Torvalds 
23721da177e4SLinus Torvalds 	qual = kmalloc (sizeof *qual, SLAB_KERNEL);
23731da177e4SLinus Torvalds 	if (qual == NULL)
23741da177e4SLinus Torvalds 		return;
23751da177e4SLinus Torvalds 
23761da177e4SLinus Torvalds 	status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
23771da177e4SLinus Torvalds 			qual, sizeof *qual);
23781da177e4SLinus Torvalds 	if (status == sizeof *qual) {
23791da177e4SLinus Torvalds 		dev_info(&udev->dev, "not running at top speed; "
23801da177e4SLinus Torvalds 			"connect to a high speed hub\n");
23811da177e4SLinus Torvalds 		/* hub LEDs are probably harder to miss than syslog */
23821da177e4SLinus Torvalds 		if (hub->has_indicators) {
23831da177e4SLinus Torvalds 			hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
23841da177e4SLinus Torvalds 			schedule_work (&hub->leds);
23851da177e4SLinus Torvalds 		}
23861da177e4SLinus Torvalds 	}
23871da177e4SLinus Torvalds 	kfree(qual);
23881da177e4SLinus Torvalds }
23891da177e4SLinus Torvalds 
23901da177e4SLinus Torvalds static unsigned
23911da177e4SLinus Torvalds hub_power_remaining (struct usb_hub *hub)
23921da177e4SLinus Torvalds {
23931da177e4SLinus Torvalds 	struct usb_device *hdev = hub->hdev;
23941da177e4SLinus Torvalds 	int remaining;
23951da177e4SLinus Torvalds 	unsigned i;
23961da177e4SLinus Torvalds 
23971da177e4SLinus Torvalds 	remaining = hub->power_budget;
23981da177e4SLinus Torvalds 	if (!remaining)		/* self-powered */
23991da177e4SLinus Torvalds 		return 0;
24001da177e4SLinus Torvalds 
24011da177e4SLinus Torvalds 	for (i = 0; i < hdev->maxchild; i++) {
24021da177e4SLinus Torvalds 		struct usb_device	*udev = hdev->children[i];
24031da177e4SLinus Torvalds 		int			delta, ceiling;
24041da177e4SLinus Torvalds 
24051da177e4SLinus Torvalds 		if (!udev)
24061da177e4SLinus Torvalds 			continue;
24071da177e4SLinus Torvalds 
24081da177e4SLinus Torvalds 		/* 100mA per-port ceiling, or 8mA for OTG ports */
24091da177e4SLinus Torvalds 		if (i != (udev->bus->otg_port - 1) || hdev->parent)
24101da177e4SLinus Torvalds 			ceiling = 50;
24111da177e4SLinus Torvalds 		else
24121da177e4SLinus Torvalds 			ceiling = 4;
24131da177e4SLinus Torvalds 
24141da177e4SLinus Torvalds 		if (udev->actconfig)
24151da177e4SLinus Torvalds 			delta = udev->actconfig->desc.bMaxPower;
24161da177e4SLinus Torvalds 		else
24171da177e4SLinus Torvalds 			delta = ceiling;
24181da177e4SLinus Torvalds 		// dev_dbg(&udev->dev, "budgeted %dmA\n", 2 * delta);
24191da177e4SLinus Torvalds 		if (delta > ceiling)
24201da177e4SLinus Torvalds 			dev_warn(&udev->dev, "%dmA over %dmA budget!\n",
24211da177e4SLinus Torvalds 				2 * (delta - ceiling), 2 * ceiling);
24221da177e4SLinus Torvalds 		remaining -= delta;
24231da177e4SLinus Torvalds 	}
24241da177e4SLinus Torvalds 	if (remaining < 0) {
24251da177e4SLinus Torvalds 		dev_warn(hub->intfdev,
24261da177e4SLinus Torvalds 			"%dmA over power budget!\n",
24271da177e4SLinus Torvalds 			-2 * remaining);
24281da177e4SLinus Torvalds 		remaining = 0;
24291da177e4SLinus Torvalds 	}
24301da177e4SLinus Torvalds 	return remaining;
24311da177e4SLinus Torvalds }
24321da177e4SLinus Torvalds 
24331da177e4SLinus Torvalds /* Handle physical or logical connection change events.
24341da177e4SLinus Torvalds  * This routine is called when:
24351da177e4SLinus Torvalds  * 	a port connection-change occurs;
24361da177e4SLinus Torvalds  *	a port enable-change occurs (often caused by EMI);
24371da177e4SLinus Torvalds  *	usb_reset_device() encounters changed descriptors (as from
24381da177e4SLinus Torvalds  *		a firmware download)
24391da177e4SLinus Torvalds  * caller already locked the hub
24401da177e4SLinus Torvalds  */
24411da177e4SLinus Torvalds static void hub_port_connect_change(struct usb_hub *hub, int port1,
24421da177e4SLinus Torvalds 					u16 portstatus, u16 portchange)
24431da177e4SLinus Torvalds {
24441da177e4SLinus Torvalds 	struct usb_device *hdev = hub->hdev;
24451da177e4SLinus Torvalds 	struct device *hub_dev = hub->intfdev;
244674ad9bd2SGreg Kroah-Hartman 	u16 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
24471da177e4SLinus Torvalds 	int status, i;
24481da177e4SLinus Torvalds 
24491da177e4SLinus Torvalds 	dev_dbg (hub_dev,
24501da177e4SLinus Torvalds 		"port %d, status %04x, change %04x, %s\n",
24511da177e4SLinus Torvalds 		port1, portstatus, portchange, portspeed (portstatus));
24521da177e4SLinus Torvalds 
24531da177e4SLinus Torvalds 	if (hub->has_indicators) {
24541da177e4SLinus Torvalds 		set_port_led(hub, port1, HUB_LED_AUTO);
24551da177e4SLinus Torvalds 		hub->indicator[port1-1] = INDICATOR_AUTO;
24561da177e4SLinus Torvalds 	}
24571da177e4SLinus Torvalds 
24581da177e4SLinus Torvalds 	/* Disconnect any existing devices under this port */
24591da177e4SLinus Torvalds 	if (hdev->children[port1-1])
24601da177e4SLinus Torvalds 		usb_disconnect(&hdev->children[port1-1]);
24611da177e4SLinus Torvalds 	clear_bit(port1, hub->change_bits);
24621da177e4SLinus Torvalds 
24631da177e4SLinus Torvalds #ifdef	CONFIG_USB_OTG
24641da177e4SLinus Torvalds 	/* during HNP, don't repeat the debounce */
24651da177e4SLinus Torvalds 	if (hdev->bus->is_b_host)
24661da177e4SLinus Torvalds 		portchange &= ~USB_PORT_STAT_C_CONNECTION;
24671da177e4SLinus Torvalds #endif
24681da177e4SLinus Torvalds 
24691da177e4SLinus Torvalds 	if (portchange & USB_PORT_STAT_C_CONNECTION) {
24701da177e4SLinus Torvalds 		status = hub_port_debounce(hub, port1);
24711da177e4SLinus Torvalds 		if (status < 0) {
24721da177e4SLinus Torvalds 			dev_err (hub_dev,
24731da177e4SLinus Torvalds 				"connect-debounce failed, port %d disabled\n",
24741da177e4SLinus Torvalds 				port1);
24751da177e4SLinus Torvalds 			goto done;
24761da177e4SLinus Torvalds 		}
24771da177e4SLinus Torvalds 		portstatus = status;
24781da177e4SLinus Torvalds 	}
24791da177e4SLinus Torvalds 
24801da177e4SLinus Torvalds 	/* Return now if nothing is connected */
24811da177e4SLinus Torvalds 	if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
24821da177e4SLinus Torvalds 
24831da177e4SLinus Torvalds 		/* maybe switch power back on (e.g. root hub was reset) */
248474ad9bd2SGreg Kroah-Hartman 		if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
24851da177e4SLinus Torvalds 				&& !(portstatus & (1 << USB_PORT_FEAT_POWER)))
24861da177e4SLinus Torvalds 			set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
24871da177e4SLinus Torvalds 
24881da177e4SLinus Torvalds 		if (portstatus & USB_PORT_STAT_ENABLE)
24891da177e4SLinus Torvalds   			goto done;
24901da177e4SLinus Torvalds 		return;
24911da177e4SLinus Torvalds 	}
24921da177e4SLinus Torvalds 
24931da177e4SLinus Torvalds #ifdef  CONFIG_USB_SUSPEND
24941da177e4SLinus Torvalds 	/* If something is connected, but the port is suspended, wake it up. */
24951da177e4SLinus Torvalds 	if (portstatus & USB_PORT_STAT_SUSPEND) {
24961da177e4SLinus Torvalds 		status = hub_port_resume(hub, port1, NULL);
24971da177e4SLinus Torvalds 		if (status < 0) {
24981da177e4SLinus Torvalds 			dev_dbg(hub_dev,
24991da177e4SLinus Torvalds 				"can't clear suspend on port %d; %d\n",
25001da177e4SLinus Torvalds 				port1, status);
25011da177e4SLinus Torvalds 			goto done;
25021da177e4SLinus Torvalds 		}
25031da177e4SLinus Torvalds 	}
25041da177e4SLinus Torvalds #endif
25051da177e4SLinus Torvalds 
25061da177e4SLinus Torvalds 	for (i = 0; i < SET_CONFIG_TRIES; i++) {
25071da177e4SLinus Torvalds 		struct usb_device *udev;
25081da177e4SLinus Torvalds 
25091da177e4SLinus Torvalds 		/* reallocate for each attempt, since references
25101da177e4SLinus Torvalds 		 * to the previous one can escape in various ways
25111da177e4SLinus Torvalds 		 */
25121da177e4SLinus Torvalds 		udev = usb_alloc_dev(hdev, hdev->bus, port1);
25131da177e4SLinus Torvalds 		if (!udev) {
25141da177e4SLinus Torvalds 			dev_err (hub_dev,
25151da177e4SLinus Torvalds 				"couldn't allocate port %d usb_device\n",
25161da177e4SLinus Torvalds 				port1);
25171da177e4SLinus Torvalds 			goto done;
25181da177e4SLinus Torvalds 		}
25191da177e4SLinus Torvalds 
25201da177e4SLinus Torvalds 		usb_set_device_state(udev, USB_STATE_POWERED);
25211da177e4SLinus Torvalds 		udev->speed = USB_SPEED_UNKNOWN;
25221da177e4SLinus Torvalds 
25231da177e4SLinus Torvalds 		/* set the address */
25241da177e4SLinus Torvalds 		choose_address(udev);
25251da177e4SLinus Torvalds 		if (udev->devnum <= 0) {
25261da177e4SLinus Torvalds 			status = -ENOTCONN;	/* Don't retry */
25271da177e4SLinus Torvalds 			goto loop;
25281da177e4SLinus Torvalds 		}
25291da177e4SLinus Torvalds 
25301da177e4SLinus Torvalds 		/* reset and get descriptor */
25311da177e4SLinus Torvalds 		status = hub_port_init(hub, udev, port1, i);
25321da177e4SLinus Torvalds 		if (status < 0)
25331da177e4SLinus Torvalds 			goto loop;
25341da177e4SLinus Torvalds 
25351da177e4SLinus Torvalds 		/* consecutive bus-powered hubs aren't reliable; they can
25361da177e4SLinus Torvalds 		 * violate the voltage drop budget.  if the new child has
25371da177e4SLinus Torvalds 		 * a "powered" LED, users should notice we didn't enable it
25381da177e4SLinus Torvalds 		 * (without reading syslog), even without per-port LEDs
25391da177e4SLinus Torvalds 		 * on the parent.
25401da177e4SLinus Torvalds 		 */
25411da177e4SLinus Torvalds 		if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
25421da177e4SLinus Torvalds 				&& hub->power_budget) {
25431da177e4SLinus Torvalds 			u16	devstat;
25441da177e4SLinus Torvalds 
25451da177e4SLinus Torvalds 			status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
25461da177e4SLinus Torvalds 					&devstat);
25471da177e4SLinus Torvalds 			if (status < 0) {
25481da177e4SLinus Torvalds 				dev_dbg(&udev->dev, "get status %d ?\n", status);
25491da177e4SLinus Torvalds 				goto loop_disable;
25501da177e4SLinus Torvalds 			}
25511da177e4SLinus Torvalds 			cpu_to_le16s(&devstat);
25521da177e4SLinus Torvalds 			if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
25531da177e4SLinus Torvalds 				dev_err(&udev->dev,
25541da177e4SLinus Torvalds 					"can't connect bus-powered hub "
25551da177e4SLinus Torvalds 					"to this port\n");
25561da177e4SLinus Torvalds 				if (hub->has_indicators) {
25571da177e4SLinus Torvalds 					hub->indicator[port1-1] =
25581da177e4SLinus Torvalds 						INDICATOR_AMBER_BLINK;
25591da177e4SLinus Torvalds 					schedule_work (&hub->leds);
25601da177e4SLinus Torvalds 				}
25611da177e4SLinus Torvalds 				status = -ENOTCONN;	/* Don't retry */
25621da177e4SLinus Torvalds 				goto loop_disable;
25631da177e4SLinus Torvalds 			}
25641da177e4SLinus Torvalds 		}
25651da177e4SLinus Torvalds 
25661da177e4SLinus Torvalds 		/* check for devices running slower than they could */
25671da177e4SLinus Torvalds 		if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
25681da177e4SLinus Torvalds 				&& udev->speed == USB_SPEED_FULL
25691da177e4SLinus Torvalds 				&& highspeed_hubs != 0)
25701da177e4SLinus Torvalds 			check_highspeed (hub, udev, port1);
25711da177e4SLinus Torvalds 
25721da177e4SLinus Torvalds 		/* Store the parent's children[] pointer.  At this point
25731da177e4SLinus Torvalds 		 * udev becomes globally accessible, although presumably
25741da177e4SLinus Torvalds 		 * no one will look at it until hdev is unlocked.
25751da177e4SLinus Torvalds 		 */
25761da177e4SLinus Torvalds 		down (&udev->serialize);
25771da177e4SLinus Torvalds 		status = 0;
25781da177e4SLinus Torvalds 
25791da177e4SLinus Torvalds 		/* We mustn't add new devices if the parent hub has
25801da177e4SLinus Torvalds 		 * been disconnected; we would race with the
25811da177e4SLinus Torvalds 		 * recursively_mark_NOTATTACHED() routine.
25821da177e4SLinus Torvalds 		 */
25831da177e4SLinus Torvalds 		spin_lock_irq(&device_state_lock);
25841da177e4SLinus Torvalds 		if (hdev->state == USB_STATE_NOTATTACHED)
25851da177e4SLinus Torvalds 			status = -ENOTCONN;
25861da177e4SLinus Torvalds 		else
25871da177e4SLinus Torvalds 			hdev->children[port1-1] = udev;
25881da177e4SLinus Torvalds 		spin_unlock_irq(&device_state_lock);
25891da177e4SLinus Torvalds 
25901da177e4SLinus Torvalds 		/* Run it through the hoops (find a driver, etc) */
25911da177e4SLinus Torvalds 		if (!status) {
25921da177e4SLinus Torvalds 			status = usb_new_device(udev);
25931da177e4SLinus Torvalds 			if (status) {
25941da177e4SLinus Torvalds 				spin_lock_irq(&device_state_lock);
25951da177e4SLinus Torvalds 				hdev->children[port1-1] = NULL;
25961da177e4SLinus Torvalds 				spin_unlock_irq(&device_state_lock);
25971da177e4SLinus Torvalds 			}
25981da177e4SLinus Torvalds 		}
25991da177e4SLinus Torvalds 
26001da177e4SLinus Torvalds 		up (&udev->serialize);
26011da177e4SLinus Torvalds 		if (status)
26021da177e4SLinus Torvalds 			goto loop_disable;
26031da177e4SLinus Torvalds 
26041da177e4SLinus Torvalds 		status = hub_power_remaining(hub);
26051da177e4SLinus Torvalds 		if (status)
26061da177e4SLinus Torvalds 			dev_dbg(hub_dev,
26071da177e4SLinus Torvalds 				"%dmA power budget left\n",
26081da177e4SLinus Torvalds 				2 * status);
26091da177e4SLinus Torvalds 
26101da177e4SLinus Torvalds 		return;
26111da177e4SLinus Torvalds 
26121da177e4SLinus Torvalds loop_disable:
26131da177e4SLinus Torvalds 		hub_port_disable(hub, port1, 1);
26141da177e4SLinus Torvalds loop:
26151da177e4SLinus Torvalds 		ep0_reinit(udev);
26161da177e4SLinus Torvalds 		release_address(udev);
26171da177e4SLinus Torvalds 		usb_put_dev(udev);
26181da177e4SLinus Torvalds 		if (status == -ENOTCONN)
26191da177e4SLinus Torvalds 			break;
26201da177e4SLinus Torvalds 	}
26211da177e4SLinus Torvalds 
26221da177e4SLinus Torvalds done:
26231da177e4SLinus Torvalds 	hub_port_disable(hub, port1, 1);
26241da177e4SLinus Torvalds }
26251da177e4SLinus Torvalds 
26261da177e4SLinus Torvalds static void hub_events(void)
26271da177e4SLinus Torvalds {
26281da177e4SLinus Torvalds 	struct list_head *tmp;
26291da177e4SLinus Torvalds 	struct usb_device *hdev;
26301da177e4SLinus Torvalds 	struct usb_interface *intf;
26311da177e4SLinus Torvalds 	struct usb_hub *hub;
26321da177e4SLinus Torvalds 	struct device *hub_dev;
26331da177e4SLinus Torvalds 	u16 hubstatus;
26341da177e4SLinus Torvalds 	u16 hubchange;
26351da177e4SLinus Torvalds 	u16 portstatus;
26361da177e4SLinus Torvalds 	u16 portchange;
26371da177e4SLinus Torvalds 	int i, ret;
26381da177e4SLinus Torvalds 	int connect_change;
26391da177e4SLinus Torvalds 
26401da177e4SLinus Torvalds 	/*
26411da177e4SLinus Torvalds 	 *  We restart the list every time to avoid a deadlock with
26421da177e4SLinus Torvalds 	 * deleting hubs downstream from this one. This should be
26431da177e4SLinus Torvalds 	 * safe since we delete the hub from the event list.
26441da177e4SLinus Torvalds 	 * Not the most efficient, but avoids deadlocks.
26451da177e4SLinus Torvalds 	 */
26461da177e4SLinus Torvalds 	while (1) {
26471da177e4SLinus Torvalds 
26481da177e4SLinus Torvalds 		/* Grab the first entry at the beginning of the list */
26491da177e4SLinus Torvalds 		spin_lock_irq(&hub_event_lock);
26501da177e4SLinus Torvalds 		if (list_empty(&hub_event_list)) {
26511da177e4SLinus Torvalds 			spin_unlock_irq(&hub_event_lock);
26521da177e4SLinus Torvalds 			break;
26531da177e4SLinus Torvalds 		}
26541da177e4SLinus Torvalds 
26551da177e4SLinus Torvalds 		tmp = hub_event_list.next;
26561da177e4SLinus Torvalds 		list_del_init(tmp);
26571da177e4SLinus Torvalds 
26581da177e4SLinus Torvalds 		hub = list_entry(tmp, struct usb_hub, event_list);
26591da177e4SLinus Torvalds 		hdev = hub->hdev;
26601da177e4SLinus Torvalds 		intf = to_usb_interface(hub->intfdev);
26611da177e4SLinus Torvalds 		hub_dev = &intf->dev;
26621da177e4SLinus Torvalds 
2663979d5199SDavid Brownell 		i = hub->resume_root_hub;
2664979d5199SDavid Brownell 
2665979d5199SDavid Brownell 		dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x%s\n",
26661da177e4SLinus Torvalds 				hdev->state, hub->descriptor
26671da177e4SLinus Torvalds 					? hub->descriptor->bNbrPorts
26681da177e4SLinus Torvalds 					: 0,
26691da177e4SLinus Torvalds 				/* NOTE: expects max 15 ports... */
26701da177e4SLinus Torvalds 				(u16) hub->change_bits[0],
2671979d5199SDavid Brownell 				(u16) hub->event_bits[0],
2672979d5199SDavid Brownell 				i ? ", resume root" : "");
26731da177e4SLinus Torvalds 
26741da177e4SLinus Torvalds 		usb_get_intf(intf);
26751da177e4SLinus Torvalds 		spin_unlock_irq(&hub_event_lock);
26761da177e4SLinus Torvalds 
2677979d5199SDavid Brownell 		/* Is this is a root hub wanting to reactivate the downstream
2678979d5199SDavid Brownell 		 * ports?  If so, be sure the interface resumes even if its
2679979d5199SDavid Brownell 		 * stub "device" node was never suspended.
2680979d5199SDavid Brownell 		 */
2681979d5199SDavid Brownell 		if (i) {
2682979d5199SDavid Brownell 			dpm_runtime_resume(&hdev->dev);
2683979d5199SDavid Brownell 			dpm_runtime_resume(&intf->dev);
2684979d5199SDavid Brownell 		}
26851da177e4SLinus Torvalds 
26861da177e4SLinus Torvalds 		/* Lock the device, then check to see if we were
26871da177e4SLinus Torvalds 		 * disconnected while waiting for the lock to succeed. */
26881da177e4SLinus Torvalds 		if (locktree(hdev) < 0) {
26891da177e4SLinus Torvalds 			usb_put_intf(intf);
26901da177e4SLinus Torvalds 			continue;
26911da177e4SLinus Torvalds 		}
26921da177e4SLinus Torvalds 		if (hub != usb_get_intfdata(intf))
26931da177e4SLinus Torvalds 			goto loop;
26941da177e4SLinus Torvalds 
26951da177e4SLinus Torvalds 		/* If the hub has died, clean up after it */
26961da177e4SLinus Torvalds 		if (hdev->state == USB_STATE_NOTATTACHED) {
26971da177e4SLinus Torvalds 			hub_pre_reset(hub);
26981da177e4SLinus Torvalds 			goto loop;
26991da177e4SLinus Torvalds 		}
27001da177e4SLinus Torvalds 
27011da177e4SLinus Torvalds 		/* If this is an inactive or suspended hub, do nothing */
27021da177e4SLinus Torvalds 		if (hub->quiescing)
27031da177e4SLinus Torvalds 			goto loop;
27041da177e4SLinus Torvalds 
27051da177e4SLinus Torvalds 		if (hub->error) {
27061da177e4SLinus Torvalds 			dev_dbg (hub_dev, "resetting for error %d\n",
27071da177e4SLinus Torvalds 				hub->error);
27081da177e4SLinus Torvalds 
27091da177e4SLinus Torvalds 			ret = usb_reset_device(hdev);
27101da177e4SLinus Torvalds 			if (ret) {
27111da177e4SLinus Torvalds 				dev_dbg (hub_dev,
27121da177e4SLinus Torvalds 					"error resetting hub: %d\n", ret);
27131da177e4SLinus Torvalds 				goto loop;
27141da177e4SLinus Torvalds 			}
27151da177e4SLinus Torvalds 
27161da177e4SLinus Torvalds 			hub->nerrors = 0;
27171da177e4SLinus Torvalds 			hub->error = 0;
27181da177e4SLinus Torvalds 		}
27191da177e4SLinus Torvalds 
27201da177e4SLinus Torvalds 		/* deal with port status changes */
27211da177e4SLinus Torvalds 		for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
27221da177e4SLinus Torvalds 			if (test_bit(i, hub->busy_bits))
27231da177e4SLinus Torvalds 				continue;
27241da177e4SLinus Torvalds 			connect_change = test_bit(i, hub->change_bits);
27251da177e4SLinus Torvalds 			if (!test_and_clear_bit(i, hub->event_bits) &&
27261da177e4SLinus Torvalds 					!connect_change && !hub->activating)
27271da177e4SLinus Torvalds 				continue;
27281da177e4SLinus Torvalds 
27291da177e4SLinus Torvalds 			ret = hub_port_status(hub, i,
27301da177e4SLinus Torvalds 					&portstatus, &portchange);
27311da177e4SLinus Torvalds 			if (ret < 0)
27321da177e4SLinus Torvalds 				continue;
27331da177e4SLinus Torvalds 
27341da177e4SLinus Torvalds 			if (hub->activating && !hdev->children[i-1] &&
27351da177e4SLinus Torvalds 					(portstatus &
27361da177e4SLinus Torvalds 						USB_PORT_STAT_CONNECTION))
27371da177e4SLinus Torvalds 				connect_change = 1;
27381da177e4SLinus Torvalds 
27391da177e4SLinus Torvalds 			if (portchange & USB_PORT_STAT_C_CONNECTION) {
27401da177e4SLinus Torvalds 				clear_port_feature(hdev, i,
27411da177e4SLinus Torvalds 					USB_PORT_FEAT_C_CONNECTION);
27421da177e4SLinus Torvalds 				connect_change = 1;
27431da177e4SLinus Torvalds 			}
27441da177e4SLinus Torvalds 
27451da177e4SLinus Torvalds 			if (portchange & USB_PORT_STAT_C_ENABLE) {
27461da177e4SLinus Torvalds 				if (!connect_change)
27471da177e4SLinus Torvalds 					dev_dbg (hub_dev,
27481da177e4SLinus Torvalds 						"port %d enable change, "
27491da177e4SLinus Torvalds 						"status %08x\n",
27501da177e4SLinus Torvalds 						i, portstatus);
27511da177e4SLinus Torvalds 				clear_port_feature(hdev, i,
27521da177e4SLinus Torvalds 					USB_PORT_FEAT_C_ENABLE);
27531da177e4SLinus Torvalds 
27541da177e4SLinus Torvalds 				/*
27551da177e4SLinus Torvalds 				 * EM interference sometimes causes badly
27561da177e4SLinus Torvalds 				 * shielded USB devices to be shutdown by
27571da177e4SLinus Torvalds 				 * the hub, this hack enables them again.
27581da177e4SLinus Torvalds 				 * Works at least with mouse driver.
27591da177e4SLinus Torvalds 				 */
27601da177e4SLinus Torvalds 				if (!(portstatus & USB_PORT_STAT_ENABLE)
27611da177e4SLinus Torvalds 				    && !connect_change
27621da177e4SLinus Torvalds 				    && hdev->children[i-1]) {
27631da177e4SLinus Torvalds 					dev_err (hub_dev,
27641da177e4SLinus Torvalds 					    "port %i "
27651da177e4SLinus Torvalds 					    "disabled by hub (EMI?), "
27661da177e4SLinus Torvalds 					    "re-enabling...\n",
27671da177e4SLinus Torvalds 						i);
27681da177e4SLinus Torvalds 					connect_change = 1;
27691da177e4SLinus Torvalds 				}
27701da177e4SLinus Torvalds 			}
27711da177e4SLinus Torvalds 
27721da177e4SLinus Torvalds 			if (portchange & USB_PORT_STAT_C_SUSPEND) {
27731da177e4SLinus Torvalds 				clear_port_feature(hdev, i,
27741da177e4SLinus Torvalds 					USB_PORT_FEAT_C_SUSPEND);
27751da177e4SLinus Torvalds 				if (hdev->children[i-1]) {
27761da177e4SLinus Torvalds 					ret = remote_wakeup(hdev->
27771da177e4SLinus Torvalds 							children[i-1]);
27781da177e4SLinus Torvalds 					if (ret < 0)
27791da177e4SLinus Torvalds 						connect_change = 1;
27801da177e4SLinus Torvalds 				} else {
27811da177e4SLinus Torvalds 					ret = -ENODEV;
27821da177e4SLinus Torvalds 					hub_port_disable(hub, i, 1);
27831da177e4SLinus Torvalds 				}
27841da177e4SLinus Torvalds 				dev_dbg (hub_dev,
27851da177e4SLinus Torvalds 					"resume on port %d, status %d\n",
27861da177e4SLinus Torvalds 					i, ret);
27871da177e4SLinus Torvalds 			}
27881da177e4SLinus Torvalds 
27891da177e4SLinus Torvalds 			if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
27901da177e4SLinus Torvalds 				dev_err (hub_dev,
27911da177e4SLinus Torvalds 					"over-current change on port %d\n",
27921da177e4SLinus Torvalds 					i);
27931da177e4SLinus Torvalds 				clear_port_feature(hdev, i,
27941da177e4SLinus Torvalds 					USB_PORT_FEAT_C_OVER_CURRENT);
27951da177e4SLinus Torvalds 				hub_power_on(hub);
27961da177e4SLinus Torvalds 			}
27971da177e4SLinus Torvalds 
27981da177e4SLinus Torvalds 			if (portchange & USB_PORT_STAT_C_RESET) {
27991da177e4SLinus Torvalds 				dev_dbg (hub_dev,
28001da177e4SLinus Torvalds 					"reset change on port %d\n",
28011da177e4SLinus Torvalds 					i);
28021da177e4SLinus Torvalds 				clear_port_feature(hdev, i,
28031da177e4SLinus Torvalds 					USB_PORT_FEAT_C_RESET);
28041da177e4SLinus Torvalds 			}
28051da177e4SLinus Torvalds 
28061da177e4SLinus Torvalds 			if (connect_change)
28071da177e4SLinus Torvalds 				hub_port_connect_change(hub, i,
28081da177e4SLinus Torvalds 						portstatus, portchange);
28091da177e4SLinus Torvalds 		} /* end for i */
28101da177e4SLinus Torvalds 
28111da177e4SLinus Torvalds 		/* deal with hub status changes */
28121da177e4SLinus Torvalds 		if (test_and_clear_bit(0, hub->event_bits) == 0)
28131da177e4SLinus Torvalds 			;	/* do nothing */
28141da177e4SLinus Torvalds 		else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
28151da177e4SLinus Torvalds 			dev_err (hub_dev, "get_hub_status failed\n");
28161da177e4SLinus Torvalds 		else {
28171da177e4SLinus Torvalds 			if (hubchange & HUB_CHANGE_LOCAL_POWER) {
28181da177e4SLinus Torvalds 				dev_dbg (hub_dev, "power change\n");
28191da177e4SLinus Torvalds 				clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
28201da177e4SLinus Torvalds 			}
28211da177e4SLinus Torvalds 			if (hubchange & HUB_CHANGE_OVERCURRENT) {
28221da177e4SLinus Torvalds 				dev_dbg (hub_dev, "overcurrent change\n");
28231da177e4SLinus Torvalds 				msleep(500);	/* Cool down */
28241da177e4SLinus Torvalds 				clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
28251da177e4SLinus Torvalds                         	hub_power_on(hub);
28261da177e4SLinus Torvalds 			}
28271da177e4SLinus Torvalds 		}
28281da177e4SLinus Torvalds 
28291da177e4SLinus Torvalds 		hub->activating = 0;
28301da177e4SLinus Torvalds 
2831d5926ae7SAlan Stern 		/* If this is a root hub, tell the HCD it's okay to
2832d5926ae7SAlan Stern 		 * re-enable port-change interrupts now. */
2833d5926ae7SAlan Stern 		if (!hdev->parent)
2834d5926ae7SAlan Stern 			usb_enable_root_hub_irq(hdev->bus);
2835d5926ae7SAlan Stern 
28361da177e4SLinus Torvalds loop:
28371da177e4SLinus Torvalds 		usb_unlock_device(hdev);
28381da177e4SLinus Torvalds 		usb_put_intf(intf);
28391da177e4SLinus Torvalds 
28401da177e4SLinus Torvalds         } /* end while (1) */
28411da177e4SLinus Torvalds }
28421da177e4SLinus Torvalds 
28431da177e4SLinus Torvalds static int hub_thread(void *__unused)
28441da177e4SLinus Torvalds {
28451da177e4SLinus Torvalds 	do {
28461da177e4SLinus Torvalds 		hub_events();
28479c8d6178Sakpm@osdl.org 		wait_event_interruptible(khubd_wait,
28489c8d6178Sakpm@osdl.org 				!list_empty(&hub_event_list) ||
28499c8d6178Sakpm@osdl.org 				kthread_should_stop());
28503e1d1d28SChristoph Lameter 		try_to_freeze();
28519c8d6178Sakpm@osdl.org 	} while (!kthread_should_stop() || !list_empty(&hub_event_list));
28521da177e4SLinus Torvalds 
28531da177e4SLinus Torvalds 	pr_debug("%s: khubd exiting\n", usbcore_name);
28549c8d6178Sakpm@osdl.org 	return 0;
28551da177e4SLinus Torvalds }
28561da177e4SLinus Torvalds 
28571da177e4SLinus Torvalds static struct usb_device_id hub_id_table [] = {
28581da177e4SLinus Torvalds     { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
28591da177e4SLinus Torvalds       .bDeviceClass = USB_CLASS_HUB},
28601da177e4SLinus Torvalds     { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
28611da177e4SLinus Torvalds       .bInterfaceClass = USB_CLASS_HUB},
28621da177e4SLinus Torvalds     { }						/* Terminating entry */
28631da177e4SLinus Torvalds };
28641da177e4SLinus Torvalds 
28651da177e4SLinus Torvalds MODULE_DEVICE_TABLE (usb, hub_id_table);
28661da177e4SLinus Torvalds 
28671da177e4SLinus Torvalds static struct usb_driver hub_driver = {
28681da177e4SLinus Torvalds 	.owner =	THIS_MODULE,
28691da177e4SLinus Torvalds 	.name =		"hub",
28701da177e4SLinus Torvalds 	.probe =	hub_probe,
28711da177e4SLinus Torvalds 	.disconnect =	hub_disconnect,
28721da177e4SLinus Torvalds 	.suspend =	hub_suspend,
28731da177e4SLinus Torvalds 	.resume =	hub_resume,
28741da177e4SLinus Torvalds 	.ioctl =	hub_ioctl,
28751da177e4SLinus Torvalds 	.id_table =	hub_id_table,
28761da177e4SLinus Torvalds };
28771da177e4SLinus Torvalds 
28781da177e4SLinus Torvalds int usb_hub_init(void)
28791da177e4SLinus Torvalds {
28801da177e4SLinus Torvalds 	if (usb_register(&hub_driver) < 0) {
28811da177e4SLinus Torvalds 		printk(KERN_ERR "%s: can't register hub driver\n",
28821da177e4SLinus Torvalds 			usbcore_name);
28831da177e4SLinus Torvalds 		return -1;
28841da177e4SLinus Torvalds 	}
28851da177e4SLinus Torvalds 
28869c8d6178Sakpm@osdl.org 	khubd_task = kthread_run(hub_thread, NULL, "khubd");
28879c8d6178Sakpm@osdl.org 	if (!IS_ERR(khubd_task))
28881da177e4SLinus Torvalds 		return 0;
28891da177e4SLinus Torvalds 
28901da177e4SLinus Torvalds 	/* Fall through if kernel_thread failed */
28911da177e4SLinus Torvalds 	usb_deregister(&hub_driver);
28921da177e4SLinus Torvalds 	printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
28931da177e4SLinus Torvalds 
28941da177e4SLinus Torvalds 	return -1;
28951da177e4SLinus Torvalds }
28961da177e4SLinus Torvalds 
28971da177e4SLinus Torvalds void usb_hub_cleanup(void)
28981da177e4SLinus Torvalds {
28999c8d6178Sakpm@osdl.org 	kthread_stop(khubd_task);
29001da177e4SLinus Torvalds 
29011da177e4SLinus Torvalds 	/*
29021da177e4SLinus Torvalds 	 * Hub resources are freed for us by usb_deregister. It calls
29031da177e4SLinus Torvalds 	 * usb_driver_purge on every device which in turn calls that
29041da177e4SLinus Torvalds 	 * devices disconnect function if it is using this driver.
29051da177e4SLinus Torvalds 	 * The hub_disconnect function takes care of releasing the
29061da177e4SLinus Torvalds 	 * individual hub resources. -greg
29071da177e4SLinus Torvalds 	 */
29081da177e4SLinus Torvalds 	usb_deregister(&hub_driver);
29091da177e4SLinus Torvalds } /* usb_hub_cleanup() */
29101da177e4SLinus Torvalds 
29111da177e4SLinus Torvalds static int config_descriptors_changed(struct usb_device *udev)
29121da177e4SLinus Torvalds {
29131da177e4SLinus Torvalds 	unsigned			index;
29141da177e4SLinus Torvalds 	unsigned			len = 0;
29151da177e4SLinus Torvalds 	struct usb_config_descriptor	*buf;
29161da177e4SLinus Torvalds 
29171da177e4SLinus Torvalds 	for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
29181da177e4SLinus Torvalds 		if (len < le16_to_cpu(udev->config[index].desc.wTotalLength))
29191da177e4SLinus Torvalds 			len = le16_to_cpu(udev->config[index].desc.wTotalLength);
29201da177e4SLinus Torvalds 	}
29211da177e4SLinus Torvalds 	buf = kmalloc (len, SLAB_KERNEL);
29221da177e4SLinus Torvalds 	if (buf == NULL) {
29231da177e4SLinus Torvalds 		dev_err(&udev->dev, "no mem to re-read configs after reset\n");
29241da177e4SLinus Torvalds 		/* assume the worst */
29251da177e4SLinus Torvalds 		return 1;
29261da177e4SLinus Torvalds 	}
29271da177e4SLinus Torvalds 	for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
29281da177e4SLinus Torvalds 		int length;
29291da177e4SLinus Torvalds 		int old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
29301da177e4SLinus Torvalds 
29311da177e4SLinus Torvalds 		length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
29321da177e4SLinus Torvalds 				old_length);
29331da177e4SLinus Torvalds 		if (length < old_length) {
29341da177e4SLinus Torvalds 			dev_dbg(&udev->dev, "config index %d, error %d\n",
29351da177e4SLinus Torvalds 					index, length);
29361da177e4SLinus Torvalds 			break;
29371da177e4SLinus Torvalds 		}
29381da177e4SLinus Torvalds 		if (memcmp (buf, udev->rawdescriptors[index], old_length)
29391da177e4SLinus Torvalds 				!= 0) {
29401da177e4SLinus Torvalds 			dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
29411da177e4SLinus Torvalds 				index, buf->bConfigurationValue);
29421da177e4SLinus Torvalds 			break;
29431da177e4SLinus Torvalds 		}
29441da177e4SLinus Torvalds 	}
29451da177e4SLinus Torvalds 	kfree(buf);
29461da177e4SLinus Torvalds 	return index != udev->descriptor.bNumConfigurations;
29471da177e4SLinus Torvalds }
29481da177e4SLinus Torvalds 
29491da177e4SLinus Torvalds /**
29501da177e4SLinus Torvalds  * usb_reset_device - perform a USB port reset to reinitialize a device
29511da177e4SLinus Torvalds  * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
29521da177e4SLinus Torvalds  *
29531da177e4SLinus Torvalds  * WARNING - don't reset any device unless drivers for all of its
29541da177e4SLinus Torvalds  * interfaces are expecting that reset!  Maybe some driver->reset()
29551da177e4SLinus Torvalds  * method should eventually help ensure sufficient cooperation.
29561da177e4SLinus Torvalds  *
29571da177e4SLinus Torvalds  * Do a port reset, reassign the device's address, and establish its
29581da177e4SLinus Torvalds  * former operating configuration.  If the reset fails, or the device's
29591da177e4SLinus Torvalds  * descriptors change from their values before the reset, or the original
29601da177e4SLinus Torvalds  * configuration and altsettings cannot be restored, a flag will be set
29611da177e4SLinus Torvalds  * telling khubd to pretend the device has been disconnected and then
29621da177e4SLinus Torvalds  * re-connected.  All drivers will be unbound, and the device will be
29631da177e4SLinus Torvalds  * re-enumerated and probed all over again.
29641da177e4SLinus Torvalds  *
29651da177e4SLinus Torvalds  * Returns 0 if the reset succeeded, -ENODEV if the device has been
29661da177e4SLinus Torvalds  * flagged for logical disconnection, or some other negative error code
29671da177e4SLinus Torvalds  * if the reset wasn't even attempted.
29681da177e4SLinus Torvalds  *
29691da177e4SLinus Torvalds  * The caller must own the device lock.  For example, it's safe to use
29701da177e4SLinus Torvalds  * this from a driver probe() routine after downloading new firmware.
29711da177e4SLinus Torvalds  * For calls that might not occur during probe(), drivers should lock
29721da177e4SLinus Torvalds  * the device using usb_lock_device_for_reset().
29731da177e4SLinus Torvalds  */
29741da177e4SLinus Torvalds int usb_reset_device(struct usb_device *udev)
29751da177e4SLinus Torvalds {
29761da177e4SLinus Torvalds 	struct usb_device		*parent_hdev = udev->parent;
29771da177e4SLinus Torvalds 	struct usb_hub			*parent_hub;
29781da177e4SLinus Torvalds 	struct usb_device_descriptor	descriptor = udev->descriptor;
29791da177e4SLinus Torvalds 	struct usb_hub			*hub = NULL;
29801da177e4SLinus Torvalds 	int 				i, ret = 0, port1 = -1;
29811da177e4SLinus Torvalds 
29821da177e4SLinus Torvalds 	if (udev->state == USB_STATE_NOTATTACHED ||
29831da177e4SLinus Torvalds 			udev->state == USB_STATE_SUSPENDED) {
29841da177e4SLinus Torvalds 		dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
29851da177e4SLinus Torvalds 				udev->state);
29861da177e4SLinus Torvalds 		return -EINVAL;
29871da177e4SLinus Torvalds 	}
29881da177e4SLinus Torvalds 
29891da177e4SLinus Torvalds 	if (!parent_hdev) {
29901da177e4SLinus Torvalds 		/* this requires hcd-specific logic; see OHCI hc_restart() */
29911da177e4SLinus Torvalds 		dev_dbg(&udev->dev, "%s for root hub!\n", __FUNCTION__);
29921da177e4SLinus Torvalds 		return -EISDIR;
29931da177e4SLinus Torvalds 	}
29941da177e4SLinus Torvalds 
29951da177e4SLinus Torvalds 	for (i = 0; i < parent_hdev->maxchild; i++)
29961da177e4SLinus Torvalds 		if (parent_hdev->children[i] == udev) {
29971da177e4SLinus Torvalds 			port1 = i + 1;
29981da177e4SLinus Torvalds 			break;
29991da177e4SLinus Torvalds 		}
30001da177e4SLinus Torvalds 
30011da177e4SLinus Torvalds 	if (port1 < 0) {
30021da177e4SLinus Torvalds 		/* If this ever happens, it's very bad */
30031da177e4SLinus Torvalds 		dev_err(&udev->dev, "Can't locate device's port!\n");
30041da177e4SLinus Torvalds 		return -ENOENT;
30051da177e4SLinus Torvalds 	}
30061da177e4SLinus Torvalds 	parent_hub = hdev_to_hub(parent_hdev);
30071da177e4SLinus Torvalds 
30081da177e4SLinus Torvalds 	/* If we're resetting an active hub, take some special actions */
30091da177e4SLinus Torvalds 	if (udev->actconfig &&
30101da177e4SLinus Torvalds 			udev->actconfig->interface[0]->dev.driver ==
30111da177e4SLinus Torvalds 				&hub_driver.driver &&
30121da177e4SLinus Torvalds 			(hub = hdev_to_hub(udev)) != NULL) {
30131da177e4SLinus Torvalds 		hub_pre_reset(hub);
30141da177e4SLinus Torvalds 	}
30151da177e4SLinus Torvalds 
30161da177e4SLinus Torvalds 	set_bit(port1, parent_hub->busy_bits);
30171da177e4SLinus Torvalds 	for (i = 0; i < SET_CONFIG_TRIES; ++i) {
30181da177e4SLinus Torvalds 
30191da177e4SLinus Torvalds 		/* ep0 maxpacket size may change; let the HCD know about it.
30201da177e4SLinus Torvalds 		 * Other endpoints will be handled by re-enumeration. */
30211da177e4SLinus Torvalds 		ep0_reinit(udev);
30221da177e4SLinus Torvalds 		ret = hub_port_init(parent_hub, udev, port1, i);
30231da177e4SLinus Torvalds 		if (ret >= 0)
30241da177e4SLinus Torvalds 			break;
30251da177e4SLinus Torvalds 	}
30261da177e4SLinus Torvalds 	clear_bit(port1, parent_hub->busy_bits);
30271da177e4SLinus Torvalds 	if (ret < 0)
30281da177e4SLinus Torvalds 		goto re_enumerate;
30291da177e4SLinus Torvalds 
30301da177e4SLinus Torvalds 	/* Device might have changed firmware (DFU or similar) */
30311da177e4SLinus Torvalds 	if (memcmp(&udev->descriptor, &descriptor, sizeof descriptor)
30321da177e4SLinus Torvalds 			|| config_descriptors_changed (udev)) {
30331da177e4SLinus Torvalds 		dev_info(&udev->dev, "device firmware changed\n");
30341da177e4SLinus Torvalds 		udev->descriptor = descriptor;	/* for disconnect() calls */
30351da177e4SLinus Torvalds 		goto re_enumerate;
30361da177e4SLinus Torvalds   	}
30371da177e4SLinus Torvalds 
30381da177e4SLinus Torvalds 	if (!udev->actconfig)
30391da177e4SLinus Torvalds 		goto done;
30401da177e4SLinus Torvalds 
30411da177e4SLinus Torvalds 	ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
30421da177e4SLinus Torvalds 			USB_REQ_SET_CONFIGURATION, 0,
30431da177e4SLinus Torvalds 			udev->actconfig->desc.bConfigurationValue, 0,
30441da177e4SLinus Torvalds 			NULL, 0, USB_CTRL_SET_TIMEOUT);
30451da177e4SLinus Torvalds 	if (ret < 0) {
30461da177e4SLinus Torvalds 		dev_err(&udev->dev,
30471da177e4SLinus Torvalds 			"can't restore configuration #%d (error=%d)\n",
30481da177e4SLinus Torvalds 			udev->actconfig->desc.bConfigurationValue, ret);
30491da177e4SLinus Torvalds 		goto re_enumerate;
30501da177e4SLinus Torvalds   	}
30511da177e4SLinus Torvalds 	usb_set_device_state(udev, USB_STATE_CONFIGURED);
30521da177e4SLinus Torvalds 
30531da177e4SLinus Torvalds 	for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
30541da177e4SLinus Torvalds 		struct usb_interface *intf = udev->actconfig->interface[i];
30551da177e4SLinus Torvalds 		struct usb_interface_descriptor *desc;
30561da177e4SLinus Torvalds 
30571da177e4SLinus Torvalds 		/* set_interface resets host side toggle even
30581da177e4SLinus Torvalds 		 * for altsetting zero.  the interface may have no driver.
30591da177e4SLinus Torvalds 		 */
30601da177e4SLinus Torvalds 		desc = &intf->cur_altsetting->desc;
30611da177e4SLinus Torvalds 		ret = usb_set_interface(udev, desc->bInterfaceNumber,
30621da177e4SLinus Torvalds 			desc->bAlternateSetting);
30631da177e4SLinus Torvalds 		if (ret < 0) {
30641da177e4SLinus Torvalds 			dev_err(&udev->dev, "failed to restore interface %d "
30651da177e4SLinus Torvalds 				"altsetting %d (error=%d)\n",
30661da177e4SLinus Torvalds 				desc->bInterfaceNumber,
30671da177e4SLinus Torvalds 				desc->bAlternateSetting,
30681da177e4SLinus Torvalds 				ret);
30691da177e4SLinus Torvalds 			goto re_enumerate;
30701da177e4SLinus Torvalds 		}
30711da177e4SLinus Torvalds 	}
30721da177e4SLinus Torvalds 
30731da177e4SLinus Torvalds done:
30741da177e4SLinus Torvalds 	if (hub)
30751da177e4SLinus Torvalds 		hub_post_reset(hub);
30761da177e4SLinus Torvalds 	return 0;
30771da177e4SLinus Torvalds 
30781da177e4SLinus Torvalds re_enumerate:
30791da177e4SLinus Torvalds 	hub_port_logical_disconnect(parent_hub, port1);
30801da177e4SLinus Torvalds 	return -ENODEV;
30811da177e4SLinus Torvalds }
3082